openchs-models 1.18.2 → 1.19.0

package/dist/Documentation.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _BaseEntity = _interopRequireDefault(require("./BaseEntity"));
+
+var _DocumentationItem = _interopRequireDefault(require("./DocumentationItem"));
+
+var _General = _interopRequireDefault(require("./utility/General"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+class Documentation extends _BaseEntity.default {
+  constructor(...args) {
+    super(...args);
+
+    _defineProperty(this, "uuid", void 0);
+
+    _defineProperty(this, "name", void 0);
+
+    _defineProperty(this, "documentationItems", void 0);
+
+    _defineProperty(this, "voided", void 0);
+  }
+
+  static associateChild(child, childEntityClass, childResource, entityService) {
+    let documentation = _BaseEntity.default.getParentEntity(entityService, childEntityClass, childResource, "documentationUUID", Documentation.schema.name);
+
+    documentation = _General.default.pick(documentation, ["uuid"], ["documentationItems"]);
+
+    if (childEntityClass === _DocumentationItem.default) {
+      _BaseEntity.default.addNewChild(child, documentation.documentationItems);
+    } else throw `${childEntityClass.name} not support by ${Documentation.name}`;
+
+    return documentation;
+  }
+
+  static fromResource(resource) {
+    const documentation = new Documentation();
+    documentation.uuid = resource.uuid;
+    documentation.name = resource.name;
+    documentation.voided = resource.voided;
+    return documentation;
+  }
+
+}
+
+_defineProperty(Documentation, "schema", {
+  name: 'Documentation',
+  primaryKey: 'uuid',
+  properties: {
+    uuid: 'string',
+    name: 'string',
+    documentationItems: {
+      type: "list",
+      objectType: "DocumentationItem"
+    },
+    voided: {
+      type: "bool",
+      default: false
+    }
+  }
+});
+
+_defineProperty(Documentation, "merge", () => _BaseEntity.default.mergeOn("documentationItems"));
+
+var _default = Documentation;
+exports.default = _default;

package/dist/DocumentationItem.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _BaseEntity = _interopRequireDefault(require("./BaseEntity"));
+
+var _ResourceUtil = _interopRequireDefault(require("./utility/ResourceUtil"));
+
+var _Documentation = _interopRequireDefault(require("./Documentation"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+class DocumentationItem extends _BaseEntity.default {
+  constructor(...args) {
+    super(...args);
+
+    _defineProperty(this, "uuid", void 0);
+
+    _defineProperty(this, "content", void 0);
+
+    _defineProperty(this, "contentHtml", void 0);
+
+    _defineProperty(this, "language", void 0);
+
+    _defineProperty(this, "documentation", void 0);
+
+    _defineProperty(this, "voided", void 0);
+  }
+
+  static fromResource(resource, entityService) {
+    const documentationItem = new DocumentationItem();
+    documentationItem.uuid = resource.uuid;
+    documentationItem.content = resource.content;
+    documentationItem.contentHtml = resource.contentHtml;
+    documentationItem.language = resource.language;
+    documentationItem.voided = resource.voided;
+    documentationItem.documentation = entityService.findByKey("uuid", _ResourceUtil.default.getUUIDFor(resource, "documentationUUID"), _Documentation.default.schema.name);
+    return documentationItem;
+  }
+
+}
+
+_defineProperty(DocumentationItem, "schema", {
+  name: 'DocumentationItem',
+  primaryKey: 'uuid',
+  properties: {
+    uuid: 'string',
+    content: {
+      type: "string",
+      optional: true
+    },
+    language: {
+      type: "string",
+      optional: true
+    },
+    contentHtml: {
+      type: "string",
+      optional: true
+    },
+    documentation: {
+      type: 'Documentation'
+    },
+    voided: {
+      type: "bool",
+      default: false
+    }
+  }
+});
+
+var _default = DocumentationItem;
+exports.default = _default;

package/dist/EntityMetaData.js

@@ -127,6 +127,10 @@ var _SubjectMigration = _interopRequireDefault(require("./SubjectMigration"));
 
 var _ResetSync = _interopRequireDefault(require("./ResetSync"));
 
+var _Documentation = _interopRequireDefault(require("./Documentation"));
+
+var _DocumentationItem = _interopRequireDefault(require("./DocumentationItem"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
@@ -432,6 +436,15 @@ const entityApprovalStatus = txData(_EntityApprovalStatus.default, {
 const news = txData(_News.default, {
   syncWeight: 0
 });
+const documentation = refData(_Documentation.default, {
+  res: 'documentations',
+  syncWeight: 0
+});
+const documentationItem = refData(_DocumentationItem.default, {
+  res: 'documentationItems',
+  parent: documentation,
+  syncWeight: 0
+});
 const comment = txData(_Comment.default, {
   parent: individual,
   syncWeight: 1,
@@ -449,7 +462,7 @@ const commentThread = txData(_CommentThread.default, {
 class EntityMetaData {
   //order is important. last entity in each (tx and ref) with be executed first. parent should be synced before the child.
   static model() {
-    return [groupDashboard, approvalStatus, dashboardSectionCardMapping, dashboardSection, dashboard, reportCard, standardReportCardType, locationHierarchy, video, checklistItemDetail, checklistDetail, rule, ruleDependency, individualRelationshipType, individualRelationGenderMapping, individualRelation, programConfig, formMapping, formElement, formElementGroup, form, identifierSource, organisationConfig, platformTranslation, translation, locationMapping, addressLevel, encounterType, program, programOutcome, gender, groupRole, subjectType, conceptAnswer, concept, myGroups, groupPrivileges, groups, privilege, resetSync, subjectMigration, news, videoTelemetric, groupSubject, comment, commentThread, entityApprovalStatus, individualRelationship, checklistItem, checklist, encounter, identifierAssignment, programEncounter, programEnrolment, individual, extension, userInfo, syncTelemetry, ruleFailureTelemetry];
+    return [groupDashboard, approvalStatus, dashboardSectionCardMapping, dashboardSection, dashboard, reportCard, standardReportCardType, locationHierarchy, video, checklistItemDetail, checklistDetail, rule, ruleDependency, individualRelationshipType, individualRelationGenderMapping, individualRelation, programConfig, formMapping, formElement, formElementGroup, form, documentationItem, documentation, identifierSource, organisationConfig, platformTranslation, translation, locationMapping, addressLevel, encounterType, program, programOutcome, gender, groupRole, subjectType, conceptAnswer, concept, myGroups, groupPrivileges, groups, privilege, resetSync, subjectMigration, news, videoTelemetric, groupSubject, comment, commentThread, entityApprovalStatus, individualRelationship, checklistItem, checklist, encounter, identifierAssignment, programEncounter, programEnrolment, individual, extension, userInfo, syncTelemetry, ruleFailureTelemetry];
   }
 
   static entitiesLoadedFromServer() {

package/dist/Schema.js

@@ -161,6 +161,10 @@ var _SubjectMigration = _interopRequireDefault(require("./SubjectMigration"));
 
 var _ResetSync = _interopRequireDefault(require("./ResetSync"));
 
+var _Documentation = _interopRequireDefault(require("./Documentation"));
+
+var _DocumentationItem = _interopRequireDefault(require("./DocumentationItem"));
+
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -169,8 +173,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 var _default = {
   //order is important, should be arranged according to the dependency
-  schema: [_LocaleMapping.default, _Settings.default, _Concept.ConceptAnswer, _Concept.default, _EncounterType.default, _Gender.default, _UserDefinedIndividualProperty.default, _AddressLevel.LocationMapping, _AddressLevel.default, _KeyValue.default, _Form.default, _FormMapping.default, _FormElementGroup.default, _FormElement.default, _SubjectType.default, _Individual.default, _ProgramOutcome.default, _Program.default, _ProgramEnrolment.default, _Observation.default, _ProgramEncounter.default, _Encounter.default, _EntitySyncStatus.default, _EntityQueue.default, _ConfigFile.default, _Checklist.default, _ChecklistItem.default, _Format.default, _UserInfo.default, _StringKeyNumericValue.default, _VisitScheduleInterval.default, _VisitScheduleConfig.default, _ProgramConfig.default, _Family.default, _IndividualRelation.default, _IndividualRelationGenderMapping.default, _IndividualRelationshipType.default, _IndividualRelationship.default, _RuleDependency.default, _Rule.default, _ChecklistItemStatus.default, _ChecklistDetail.default, _ChecklistItemDetail.default, _VideoTelemetric.default, _Video.default, _MediaQueue.default, _Point.default, _SyncTelemetry.default, _IdentifierSource.default, _IdentifierAssignment.default, _RuleFailureTelemetry.default, _BeneficiaryModePin.default, _OrganisationConfig.default, _PlatformTranslation.default, _Translation.default, _Groups.default, _MyGroups.default, _GroupPrivileges.default, _Privilege.default, _GroupRole.default, _GroupSubject.default, _DashboardCache.default, _LocationHierarchy.default, _ReportCard.default, _Dashboard.default, _DashboardSectionCardMapping.default, _DraftSubject.default, _StandardReportCardType.default, _ApprovalStatus.default, _EntityApprovalStatus.default, _GroupDashboard.default, _DashboardSection.default, _News.default, _Comment.default, _CommentThread.default, _Extension.default, _SubjectMigration.default, _ResetSync.default],
-  schemaVersion: 154,
+  schema: [_LocaleMapping.default, _Settings.default, _Concept.ConceptAnswer, _Concept.default, _EncounterType.default, _Gender.default, _UserDefinedIndividualProperty.default, _AddressLevel.LocationMapping, _AddressLevel.default, _KeyValue.default, _Form.default, _FormMapping.default, _FormElementGroup.default, _FormElement.default, _SubjectType.default, _Individual.default, _ProgramOutcome.default, _Program.default, _ProgramEnrolment.default, _Observation.default, _ProgramEncounter.default, _Encounter.default, _EntitySyncStatus.default, _EntityQueue.default, _ConfigFile.default, _Checklist.default, _ChecklistItem.default, _Format.default, _UserInfo.default, _StringKeyNumericValue.default, _VisitScheduleInterval.default, _VisitScheduleConfig.default, _ProgramConfig.default, _Family.default, _IndividualRelation.default, _IndividualRelationGenderMapping.default, _IndividualRelationshipType.default, _IndividualRelationship.default, _RuleDependency.default, _Rule.default, _ChecklistItemStatus.default, _ChecklistDetail.default, _ChecklistItemDetail.default, _VideoTelemetric.default, _Video.default, _MediaQueue.default, _Point.default, _SyncTelemetry.default, _IdentifierSource.default, _IdentifierAssignment.default, _RuleFailureTelemetry.default, _BeneficiaryModePin.default, _OrganisationConfig.default, _PlatformTranslation.default, _Translation.default, _Groups.default, _MyGroups.default, _GroupPrivileges.default, _Privilege.default, _GroupRole.default, _GroupSubject.default, _DashboardCache.default, _LocationHierarchy.default, _ReportCard.default, _Dashboard.default, _DashboardSectionCardMapping.default, _DraftSubject.default, _StandardReportCardType.default, _ApprovalStatus.default, _EntityApprovalStatus.default, _GroupDashboard.default, _DashboardSection.default, _News.default, _Comment.default, _CommentThread.default, _Extension.default, _SubjectMigration.default, _ResetSync.default, _Documentation.default, _DocumentationItem.default],
+  schemaVersion: 155,
   migration: function (oldDB, newDB) {
     if (oldDB.schemaVersion < 10) {
       var oldObjects = oldDB.objects("DecisionConfig");

package/dist/application/FormElement.js

@@ -25,6 +25,8 @@ var _Filter = _interopRequireDefault(require("./Filter"));
 
 var _moment = _interopRequireDefault(require("moment"));
 
+var _Documentation = _interopRequireDefault(require("../Documentation"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -38,6 +40,7 @@ class FormElement {
 
     formElement.formElementGroup = formElementGroup;
     formElement.groupUuid = _ResourceUtil.default.getUUIDFor(resource, "groupQuestionUUID");
+    formElement.documentation = entityService.findByKey("uuid", _ResourceUtil.default.getUUIDFor(resource, "documentationUUID"), _Documentation.default.schema.name);
     formElement.concept = concept; //remove orphan keyValues (because KeyValue doesn't have primary key
 
     entityService.deleteObjects(resource["uuid"], FormElement.schema.name, "keyValues");
@@ -215,7 +218,8 @@ class FormElement {
       keyValues: this.keyValues,
       concept: this.concept,
       formElementGroupUUID: this.formElementGroup.uuid,
-      groupUuid: this.groupUuid
+      groupUuid: this.groupUuid,
+      documentation: this.documentation
     };
   }
 
@@ -276,6 +280,7 @@ class FormElement {
     formElement.voided = this.voided;
     formElement.rule = this.rule;
     formElement.groupUuid = this.groupUuid;
+    formElement.documentation = this.documentation;
     return formElement;
   }
 
@@ -314,6 +319,10 @@ _defineProperty(FormElement, "schema", {
     groupUuid: {
       type: "string",
       optional: true
+    },
+    documentation: {
+      type: "Documentation",
+      optional: true
     }
   }
 });

package/dist/index.js

@@ -663,6 +663,18 @@ Object.defineProperty(exports, "ResetSync", {
     return _ResetSync.default;
   }
 });
+Object.defineProperty(exports, "Documentation", {
+  enumerable: true,
+  get: function () {
+    return _Documentation.default;
+  }
+});
+Object.defineProperty(exports, "DocumentationItem", {
+  enumerable: true,
+  get: function () {
+    return _DocumentationItem.default;
+  }
+});
 
 var _AbstractEncounter = _interopRequireDefault(require("./AbstractEncounter"));
 
@@ -882,6 +894,10 @@ var _RepeatableQuestionGroup = _interopRequireDefault(require("./observation/Rep
 
 var _ResetSync = _interopRequireDefault(require("./ResetSync"));
 
+var _Documentation = _interopRequireDefault(require("./Documentation"));
+
+var _DocumentationItem = _interopRequireDefault(require("./DocumentationItem"));
+
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "openchs-models",
     "description": "OpenCHS data model to be used by front end clients",
-    "version": "1.18.2",
+    "version": "1.19.0",
     "private": false,
     "repository": {
         "type": "git",