@ironcode/vas-lib 0.0.18 → 0.0.20

package/fesm2015/ironcode-vas-lib.mjs

@@ -199,8 +199,9 @@ class VasControlModel extends VasBaseModel {
      * @param {string} description
      * @param {string} defaultValue
      * @param {object} config
+     * @param {string} descriptionImage
      */
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, controlType, group, validators, name, title, linkable, sequence, description, defaultValue, _config) {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, controlType, group, validators, name, title, linkable, sequence, description, defaultValue, _config, descriptionImage) {
         super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
         this.id = id;
         this.created = created;
@@ -221,6 +222,7 @@ class VasControlModel extends VasBaseModel {
         this.description = description;
         this.defaultValue = defaultValue;
         this._config = _config;
+        this.descriptionImage = descriptionImage;
         this.controlTypeModel = undefined;
         this.configCache = undefined;
     }
@@ -255,6 +257,11 @@ class VasControlModel extends VasBaseModel {
                 case 'contact': {
                     return {};
                 }
+                case 'toggle': {
+                    return {
+                        checked: false, comment: ''
+                    };
+                }
             }
         }
         return this.parseMaybeJson(this.defaultValue);
@@ -289,7 +296,7 @@ class VasControlModel extends VasBaseModel {
     static fromDto(dto) {
         return new VasControlModel(
         // eslint-disable-next-line new-cap
-        dto.id || UUID.UUID(), dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.account || '', dto.accessGroup || '', dto.controlType || '', dto.group || '', dto.validators || [], dto.name || '', dto.title || '', dto.linkable || false, dto.sequence || 0, dto.description || '', dto.defaultValue || '', dto.config || '{}');
+        dto.id || UUID.UUID(), dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.account || '', dto.accessGroup || '', dto.controlType || '', dto.group || '', dto.validators || [], dto.name || '', dto.title || '', dto.linkable || false, dto.sequence || 0, dto.description || '', dto.defaultValue || '', dto.config || '{}', dto.descriptionImage || '');
     }
     /**
      * @param {string} value
@@ -329,7 +336,8 @@ class VasControlModel extends VasBaseModel {
             sequence: this.sequence,
             description: this.description,
             defaultValue: this.defaultValue,
-            config: this.config
+            config: this.config,
+            descriptionImage: this.descriptionImage,
         };
     }
 }
@@ -439,7 +447,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {VasFieldModel}
      */
     static fromDto(fieldDto) {
-        return new VasFieldModel(fieldDto.id || UUID.UUID(), fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], this.fromApiValue(fieldDto.value) || '', fieldDto.version || 0);
+        return new VasFieldModel(fieldDto.id || UUID.UUID(), fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], fieldDto.value || '', fieldDto.version || 0);
     }
     /**
      * @return {VasFieldDto}
@@ -465,7 +473,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {object}
      */
     toApiDto() {
-        return Object.assign(Object.assign({}, super.toApiDto()), { control: this.control, value: this.toApiValue(this.value) });
+        return Object.assign(Object.assign({}, super.toApiDto()), { control: this.control, value: this.prepareApiValue(this.value) });
     }
     /**
      * Prepares the value to be sent to the API. The api will only accept strings,
@@ -475,7 +483,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {string | number | boolean}
      * @protected
      */
-    toApiValue(value) {
+    prepareApiValue(value) {
         switch (typeof value) {
             case 'object': {
                 return JSON.stringify(value);
@@ -494,14 +502,6 @@ class VasFieldModel extends VasJobDataModel {
             }
         }
     }
-    static fromApiValue(value) {
-        try {
-            return JSON.parse(value);
-        }
-        catch (e) {
-            return value;
-        }
-    }
 }
 
 /**
@@ -1102,67 +1102,15 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     /**
      * This method will hydrate the `fields` property of the model. The reason for
      * this is that we have different ways to store the field data. One way, is
-     * we store them as dynamic properties of the job e.g. job.foo.bar, the other
-     * is in an array of Field. The former is nice to work with in clients,
-     * whereas the latter more suited to relational database.
-     *
-     * A) job with dynamic properties, e.g.
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   foo: {
-     *     bar: "value"
-     *   }
-     * }
-     *
-     * B) job with array of Field
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   <will not have dynamic properties>...
-     *   fields: [
-     *     {
-     *       id: <guid>,
-     *       <other field properties>,
-     *       value: "value"
-     *     }
-     *   ]
-     * }
-     *
-     * What this method does is given a VasJobModel that has been populated with
-     * a VasJobDto in form B (i.e. `.fields` are populated - usually from a VASAPI
-     * response), hydrate the dynamic properties of the model. NOTE: knowledge of
-     * the Form that was used to crate the Job is required because it will contain
-     * the Groups, which names are used in the hydrating
-     *
-     * @param {VasFormModel} formModel the VasFormModel that was used to create
-     * the job
-     * @return {void}
-     */
-    hydrateDynamicProps(formModel) {
-        formModel.groups
-            .forEach(group => {
-            const p0 = group.name;
-            group.controls
-                .forEach(control => {
-                const p1 = control.name;
-                const f = this.fields.find(field => field.control === control.id);
-                if (!f) {
-                    return;
-                }
-                this.setValueByPath(f.value, [p0, p1]);
-            });
-        });
-    }
-    /**
-     * This method will hydrate the `fields` property of the model. The reason for
-     * this is that we have different ways to store the field data. One way, is
-     * we store them as dynamic properties of the job e.g. job.foo.bar, the other
-     * is in an array of Field. The former is nice to work with in clients,
-     * whereas the latter more suited to relational database.
-     *
+     * we store them as dynamic properties of the job. For example job.foo.bar,
+     * where `foo` is the name of a Group, and `bar` is the name of a control.
+     * Thus, when we create a job using a form in the client, the job object will
+     * have its static properties (id, account, reference etc), and also a number
+     * of dynamic properties determined by the Groups and Controls. This kind of
+     * object is nice to work with in certain circumstances. However, the api
+     * works differently. In the API a Job is a record, and references a number of
+     * Field records. Each Field stores the value. Comparing these two models we
+     * have:
      * A) job with dynamic properties, e.g.
      * {
      *   id: <guid>,
@@ -1229,7 +1177,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
      * be generated, or to reuse an existing one from the map.
      * @param {Array<string>} controlNames if a value is provided, it will be used
      * to filter the fields that are returned.
-     * @return {void}
+     * @return {Array<VasFieldDto>}
      */
     hydrateFields(formModel, controlFieldIdMap = new Map(), controlNames) {
         const fields = [];
@@ -1294,20 +1242,11 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
                 return;
             }
             case 2: {
-                if (!this.$this[path[0]]) {
-                    this.$this[path[0]] = {};
-                }
                 // eslint-disable-next-line max-len
                 this.$this[path[0]][path[1]] = value;
                 return;
             }
             case 3: {
-                if (!this.$this[path[0]]) {
-                    this.$this[path[0]] = {};
-                }
-                if (!this.$this[path[0]][path[1]]) {
-                    this.$this[path[0]][path[1]] = {};
-                }
                 // eslint-disable-next-line max-len
                 this.$this[path[0]][path[1]][path[2]] = value;
                 return;