feat(model): add victim & next of kin locales

Author: lykmapipo

src/schema/common.schema.js

@@ -6,6 +6,7 @@ import {
 } from '@codetanzania/ewea-internals';
 import { DEFAULT_SEEDS } from '@codetanzania/ewea-common';
 import { compact } from '@lykmapipo/common';
+import { getString, getStrings } from '@lykmapipo/env';
 import { Point } from 'mongoose-geojson-schemas';
 import { ObjectId, Mixed, createSubSchema } from '@lykmapipo/mongoose-common';
 import { Predefine } from '@lykmapipo/predefine';
@@ -19,6 +20,9 @@ import { follower } from './parties.schema';
 import { followedAt } from './dates.schema';
 import { outcome, remarks } from './base.schema';
 
+const DEFAULT_LOCALE = getString('DEFAULT_LOCALE', 'en');
+const LOCALES = getStrings('LOCALES', DEFAULT_LOCALE);
+
 /**
  * @name properties
  * @description A map of key value pairs to allow to associate
@@ -45,6 +49,40 @@ export const properties = {
   fake: (f) => f.helpers.createTransaction(),
 };
 
+/**
+ * @name locale
+ * @description Defines the party's language, region and any
+ * special variant preferences.
+ *
+ * @see {@link https://en.wikipedia.org/wiki/Locale_(computer_software)}
+ *
+ * @type {object}
+ * @property {object} type - schema(data) type
+ * @property {boolean} trim - force trimming
+ * @property {boolean} enum - list of acceptable values
+ * @property {boolean} index - ensure database index
+ * @property {boolean} searchable - allow for searching
+ * @property {boolean} taggable - allow field use for tagging
+ * @property {boolean} default - default value set when none provided
+ * @property {object} fake - fake data generator options
+ *
+ * @since 0.1.0
+ * @version 0.1.0
+ * @instance
+ * @example
+ * en
+ */
+export const locale = {
+  type: String,
+  trim: true,
+  enum: LOCALES,
+  index: true,
+  searchable: true,
+  taggable: true,
+  default: DEFAULT_LOCALE,
+  fake: true,
+};
+
 /**
  * @name name
  * @description Full name name of the party(i.e individual).
@@ -539,7 +577,8 @@ export const nationality = {
  * @type {object}
  * @property {string} name - Full name of the next of kin
  * @property {string} mobile - Mobile phone number of the next of kin
- * @property {string} email - Email address of the victim
+ * @property {string} email - Email address of the next of kin
+ * @property {string} locale - Locale of the next of kin
  *
  * @author lally elias <lallyelias87@gmail.com>
  * @since 0.1.0
@@ -550,12 +589,15 @@ export const nationality = {
  *   name: "Jane Doe",
  *   mobile: "+255715463739"
  *   email: "jane.doe@example.com"
+ *   locale: "en"
  * }
  */
 export const nextOfKin = createSubSchema({
   name,
   mobile,
   email,
+  locale,
+  // csids,
 });
 
 /**
@@ -574,6 +616,7 @@ export const nextOfKin = createSubSchema({
  * @property {object} occupation - Occupation of the victim
  * @property {object} nationality - Nationality of the victim
  * @property {string} address - Address of the victim
+ * @property {string} locale - Locale of the victim
  *
  * @author lally elias <lallyelias87@gmail.com>
  * @since 0.1.0
@@ -593,6 +636,7 @@ export const nextOfKin = createSubSchema({
  *   nationality: { name: { en: "Tanzanian"} },
  *   address: "Tandale",
  *   area: { name: { en: "Dar es Salaam"} },
+ *   locale: "en",
  *   nextOfKin: { name: "Halima Mdoe", mobile: "+255715463740" }
  * }
  */
@@ -610,7 +654,9 @@ export const victim = createSubSchema({
   nationality,
   address,
   area,
+  locale,
   nextOfKin,
+  // csids.
 });
 
 /**

test/unit/case.schema.spec.js

@@ -73,9 +73,11 @@ describe('Case Schema', () => {
     const gender = Case.path('victim.gender');
     const occupation = Case.path('victim.occupation');
     const nationality = Case.path('victim.nationality');
+    const locale = Case.path('victim.locale');
     const nextOfKinName = Case.path('victim.nextOfKin.name');
     const nextOfKinMobile = Case.path('victim.nextOfKin.mobile');
     const nextOfKinEmail = Case.path('victim.nextOfKin.email');
+    const nextOfKinLocale = Case.path('victim.nextOfKin.locale');
 
     expect(victim).to.exist;
     expect(victim).to.be.an.instanceof(SchemaTypes.Embedded);
@@ -189,6 +191,17 @@ describe('Case Schema', () => {
     expect(nationality.options.aggregatable).to.exist;
     expect(nationality.options.default).to.exist;
 
+    expect(locale).to.exist;
+    expect(locale).to.be.an.instanceof(SchemaTypes.String);
+    expect(locale.options).to.exist;
+    expect(locale.options).to.be.an('object');
+    expect(locale.options.type).to.exist;
+    expect(locale.options.trim).to.be.true;
+    expect(locale.options.enum).to.be.exist;
+    expect(locale.options.index).to.be.true;
+    expect(locale.options.searchable).to.be.true;
+    expect(locale.options.fake).to.exist;
+
     expect(nextOfKinName).to.exist;
     expect(nextOfKinName).to.be.instanceof(SchemaTypes.String);
     expect(nextOfKinName.options).to.exist;
@@ -225,6 +238,17 @@ describe('Case Schema', () => {
     expect(nextOfKinEmail.options.taggable).to.be.true;
     expect(nextOfKinEmail.options.exportable).to.be.true;
     expect(nextOfKinEmail.options.fake).to.exist;
+
+    expect(nextOfKinLocale).to.exist;
+    expect(nextOfKinLocale).to.be.an.instanceof(SchemaTypes.String);
+    expect(nextOfKinLocale.options).to.exist;
+    expect(nextOfKinLocale.options).to.be.an('object');
+    expect(nextOfKinLocale.options.type).to.exist;
+    expect(nextOfKinLocale.options.trim).to.be.true;
+    expect(nextOfKinLocale.options.enum).to.be.exist;
+    expect(nextOfKinLocale.options.index).to.be.true;
+    expect(nextOfKinLocale.options.searchable).to.be.true;
+    expect(nextOfKinLocale.options.fake).to.exist;
   });
 
   it('should have description field', () => {