feat(model): add stage & severity field

Author: lykmapipo

src/case.model.js

@@ -15,13 +15,20 @@ import {
   CASE_OPTION_AUTOPOPULATE,
 } from './internals';
 
-import { number, description, remarks } from './schema/base.schema';
+import {
+  number,
+  stage,
+  severity,
+  description,
+  remarks,
+} from './schema/base.schema';
 import { victim, followup } from './schema/common.schema';
 import { reporter, resolver } from './schema/parties.schema';
 import { reportedAt, resolvedAt } from './schema/dates.schema';
 
 const SCHEMA = mergeObjects(
   { number },
+  { stage, severity },
   { victim },
   { description },
   { reportedAt, reporter },

src/schema/base.schema.js

@@ -2,6 +2,7 @@ import { get } from 'lodash';
 import moment from 'moment';
 import { ObjectId } from '@lykmapipo/mongoose-common';
 import { Predefine } from '@lykmapipo/predefine';
+import { DEFAULT_SEEDS } from '@codetanzania/ewea-common';
 import { Event } from '@codetanzania/ewea-event';
 
 import { AUTOPOPULATE_OPTION_PREDEFINE, COUNTRY_CODE } from '../internals';
@@ -138,6 +139,94 @@ export const event = {
   default: undefined,
 };
 
+/**
+ * @name stage
+ * @description Currently assigned stage of a case.
+ *
+ * @memberof Case
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} required - mark required
+ * @property {boolean} index - ensure database index
+ * @property {boolean} exists - ensure ref exists before save
+ * @property {object} autopopulate - auto populate(eager loading) options
+ * @property {boolean} taggable - allow field use for tagging
+ * @property {boolean} exportable - allow field use for exporting
+ * @property {boolean} aggregatable - allow field use for aggregation
+ * @property {boolean} default - default value set when none provided
+ * @property {object} fake - fake data generator options
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.4.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * {
+ *   _id: '5dde6ca23631a92c2d616250',
+ *   strings: { name: { en: 'Confirmed' } },
+ * }
+ */
+export const stage = {
+  type: ObjectId,
+  ref: Predefine.MODEL_NAME,
+  // required: true,
+  index: true,
+  exists: true,
+  aggregatable: { unwind: true },
+  autopopulate: AUTOPOPULATE_OPTION_PREDEFINE,
+  taggable: true,
+  exportable: {
+    format: (v) => get(v, 'strings.name.en'),
+    default: 'NA',
+  },
+  default: DEFAULT_SEEDS.CaseStage,
+};
+
+/**
+ * @name severity
+ * @description Currently assigned severity of a case.
+ *
+ * @memberof Case
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} required - mark required
+ * @property {boolean} index - ensure database index
+ * @property {boolean} exists - ensure ref exists before save
+ * @property {object} autopopulate - auto populate(eager loading) options
+ * @property {boolean} taggable - allow field use for tagging
+ * @property {boolean} exportable - allow field use for exporting
+ * @property {boolean} aggregatable - allow field use for aggregation
+ * @property {boolean} default - default value set when none provided
+ * @property {object} fake - fake data generator options
+ *
+ * @author lally elias <lallyelias87@gmail.com>
+ * @since 0.4.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * {
+ *   _id: '5dde6ca23631a92c2d616250',
+ *   strings: { name: { en: 'Extreme' } },
+ * }
+ */
+export const severity = {
+  type: ObjectId,
+  ref: Predefine.MODEL_NAME,
+  // required: true,
+  index: true,
+  exists: true,
+  aggregatable: { unwind: true },
+  autopopulate: AUTOPOPULATE_OPTION_PREDEFINE,
+  taggable: true,
+  exportable: {
+    format: (v) => get(v, 'strings.name.en'),
+    default: 'NA',
+  },
+  default: DEFAULT_SEEDS.CaseSeverity,
+};
+
 /**
  * @name number
  * @description Human readable, unique identifier of a case.

test/unit/case.schema.spec.js

@@ -23,6 +23,46 @@ describe('Case Schema', () => {
     expect(number.options.fake).to.exist;
   });
 
+  it('should have stage field', () => {
+    const stage = Case.path('stage');
+
+    expect(stage).to.exist;
+    expect(stage).to.be.instanceof(SchemaTypes.ObjectId);
+    expect(stage.options).to.exist;
+    expect(stage.options).to.be.an('object');
+    expect(stage.options.type).to.exist;
+    expect(stage.options.ref).to.exist;
+    expect(stage.options.ref).to.be.equal(Predefine.MODEL_NAME);
+    expect(stage.options.index).to.be.true;
+    // expect(stage.options.required).to.be.true;
+    expect(stage.options.exists).to.be.true;
+    expect(stage.options.autopopulate).to.exist;
+    expect(stage.options.taggable).to.exist;
+    expect(stage.options.exportable).to.exist;
+    expect(stage.options.aggregatable).to.exist;
+    expect(stage.options.default).to.exist;
+  });
+
+  it('should have severity field', () => {
+    const severity = Case.path('severity');
+
+    expect(severity).to.exist;
+    expect(severity).to.be.instanceof(SchemaTypes.ObjectId);
+    expect(severity.options).to.exist;
+    expect(severity.options).to.be.an('object');
+    expect(severity.options.type).to.exist;
+    expect(severity.options.ref).to.exist;
+    expect(severity.options.ref).to.be.equal(Predefine.MODEL_NAME);
+    expect(severity.options.index).to.be.true;
+    // expect(severity.options.required).to.be.true;
+    expect(severity.options.exists).to.be.true;
+    expect(severity.options.autopopulate).to.exist;
+    expect(severity.options.taggable).to.exist;
+    expect(severity.options.exportable).to.exist;
+    expect(severity.options.aggregatable).to.exist;
+    expect(severity.options.default).to.exist;
+  });
+
   it('should have victim field', () => {
     const victim = Case.path('victim');
     const referral = Case.path('victim.referral');