@ironcode/vas-lib 0.0.16 → 0.0.18

package/fesm2015/ironcode-vas-lib.mjs

@@ -200,7 +200,7 @@ class VasControlModel extends VasBaseModel {
      * @param {string} defaultValue
      * @param {object} config
      */
-    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) {
         super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
         this.id = id;
         this.created = created;
@@ -220,8 +220,9 @@ class VasControlModel extends VasBaseModel {
         this.sequence = sequence;
         this.description = description;
         this.defaultValue = defaultValue;
-        this.config = config;
+        this._config = _config;
         this.controlTypeModel = undefined;
+        this.configCache = undefined;
     }
     /**
      * The config property is returned from the api as a json string, this getter
@@ -229,7 +230,17 @@ class VasControlModel extends VasBaseModel {
      * @return {T}
      */
     getConfigModel() {
-        return JSON.parse(this.config);
+        if (this.configCache !== undefined) {
+            return this.configCache;
+        }
+        return this.configCache = JSON.parse(this._config);
+    }
+    get config() {
+        return this._config;
+    }
+    set config(config) {
+        this._config = config;
+        this.configCache = undefined;
     }
     /**
      * The defaultValue property is returned from the api as a string or number,
@@ -428,7 +439,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 || [], 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 || [], this.fromApiValue(fieldDto.value) || '', fieldDto.version || 0);
     }
     /**
      * @return {VasFieldDto}
@@ -454,7 +465,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {object}
      */
     toApiDto() {
-        return Object.assign(Object.assign({}, super.toApiDto()), { control: this.control, value: this.prepareApiValue(this.value) });
+        return Object.assign(Object.assign({}, super.toApiDto()), { control: this.control, value: this.toApiValue(this.value) });
     }
     /**
      * Prepares the value to be sent to the API. The api will only accept strings,
@@ -464,7 +475,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {string | number | boolean}
      * @protected
      */
-    prepareApiValue(value) {
+    toApiValue(value) {
         switch (typeof value) {
             case 'object': {
                 return JSON.stringify(value);
@@ -483,6 +494,14 @@ class VasFieldModel extends VasJobDataModel {
             }
         }
     }
+    static fromApiValue(value) {
+        try {
+            return JSON.parse(value);
+        }
+        catch (e) {
+            return value;
+        }
+    }
 }
 
 /**
@@ -1083,15 +1102,67 @@ 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. 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:
+     * 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.
+     *
      * A) job with dynamic properties, e.g.
      * {
      *   id: <guid>,
@@ -1158,7 +1229,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 {Array<VasFieldDto>}
+     * @return {void}
      */
     hydrateFields(formModel, controlFieldIdMap = new Map(), controlNames) {
         const fields = [];
@@ -1223,11 +1294,20 @@ 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;