@ironcode/vas-lib 0.0.9 → 0.0.10

package/fesm2020/ironcode-vas-lib.mjs

@@ -243,7 +243,7 @@ class VasControlModel extends VasBaseModel {
     }
     /**
      * Returns the name of this control to be used in the report templates
-     * i.e. field.foo -> foo
+     * i.e. fields.foo -> foo
      * @return {string}
      */
     get reportTemplateName() {
@@ -487,8 +487,9 @@ class VasFormModel extends VasBaseModel {
      * @param {string} title
      * @param {string} description
      * @param {VasGroupModel[]} groups
+     * @param {string} dynamicDescriptor
      */
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, jobType, title, description, groups) {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, jobType, title, description, groups, dynamicDescriptor) {
         super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
         this.id = id;
         this.created = created;
@@ -503,6 +504,7 @@ class VasFormModel extends VasBaseModel {
         this.title = title;
         this.description = description;
         this.groups = groups;
+        this.dynamicDescriptor = dynamicDescriptor;
     }
     /**
      * Returns the name of this form in a "safe" way, i.e. no spaces, special
@@ -545,7 +547,7 @@ class VasFormModel extends VasBaseModel {
     static fromDto(dto) {
         return new VasFormModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.account || '', dto.accessGroup || '', dto.jobType || '', dto.title || '', dto.description || '', (dto.groups || [])
             .sort((a, b) => a.sequence - b.sequence)
-            .map(g => VasGroupModel.fromDto(g)));
+            .map(g => VasGroupModel.fromDto(g)), dto.dynamicDescriptor || '');
     }
     addControlTypesToControl(controlTypes) {
         const controlTypeModels = controlTypes
@@ -646,10 +648,75 @@ class VasFormModel extends VasBaseModel {
             title: this.title,
             description: this.description,
             groups: this.groups.map(group => group.toDto()),
+            dynamicDescriptor: this.dynamicDescriptor
         };
     }
 }
 
+/**
+ * A non sophisticated way to get values from the job via paths. For example:
+ *
+ * getValueByPath(
+ *  ['foo', 'bar'],
+ *  {
+ *   foo: {
+ *     bar: 'value'
+ *   }
+ *  }
+ * );
+ *
+ * will return "value"
+ * @param {string[]} path
+ * @param {Record<string, VasFieldDtoValue>} object
+ * @return {T | undefined}
+ */
+const getValueByPath = (path, object) => {
+    switch (path.length) {
+        case 0: {
+            return;
+        }
+        case 1: {
+            return (object)[path[0]];
+        }
+        case 2: {
+            const val0 = object[path[0]];
+            if (!val0) {
+                return undefined;
+            }
+            return val0[path[1]];
+        }
+        case 3: {
+            const val0 = object[path[0]];
+            if (!val0) {
+                return undefined;
+            }
+            const val1 = val0[path[1]];
+            if (!val1) {
+                return undefined;
+            }
+            return val1[path[2]];
+        }
+        case 4: {
+            const val0 = object[path[0]];
+            if (!val0) {
+                return undefined;
+            }
+            const val1 = val0[path[1]];
+            if (!val1) {
+                return undefined;
+            }
+            const val2 = val1[path[2]];
+            if (!val2) {
+                return undefined;
+            }
+            return val2[path[3]];
+        }
+        default: {
+            throw Error('path has too many segments');
+        }
+    }
+};
+
 /**
  * JobModel
  */
@@ -696,8 +763,6 @@ class VasJobModel extends VasBaseModel {
      * @return {VasJobModelDynamicInterface}
      */
     get $this() {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const $this = this;
         return this;
     }
     /**
@@ -756,69 +821,33 @@ class VasJobModel extends VasBaseModel {
         return fields;
     }
     /**
-     * A very non sophisticated way to get values from the job via paths
-     *
-     * For example:
-     *
-     * getValueByPath(['foo', 'bar']);
-     *
-     * if job is
-     * {
-     *   foo: {
-     *     bar: 'value'
-     *   }
-     * }
-     *
-     * will return "value"
-     *
+     * Will return an object whose keys are the names of all fields in the job but
+     * with the "fields." part removed. This method is similar to `getFields`
+     * except that this method will only return values that are set whereas
+     * `getFields` will return a property regardless (because it uses the form to
+     * drive the logic)
+     * @return {Record<string, VasFieldDtoValue>}
+     */
+    getFields2() {
+        let fields = {};
+        this.dynamicProperties
+            .forEach((groupName) => {
+            Object
+                .keys(this.$this[groupName])
+                .forEach(controlName => {
+                const controlNameShort = controlName.replace(/fields\./, '');
+                fields[controlNameShort] = this.getValueByPath([groupName, controlName]);
+            });
+        }, {});
+        return fields;
+    }
+    /**
+  
      * @param {string[]} path path segments
      * @return {void}
      */
     getValueByPath(path = []) {
-        switch (path.length) {
-            case 0: {
-                return;
-            }
-            case 1: {
-                return (this.$this)[path[0]];
-            }
-            case 2: {
-                const val0 = this.$this[path[0]];
-                if (!val0) {
-                    return undefined;
-                }
-                return val0[path[1]];
-            }
-            case 3: {
-                const val0 = this.$this[path[0]];
-                if (!val0) {
-                    return undefined;
-                }
-                const val1 = val0[path[1]];
-                if (!val1) {
-                    return undefined;
-                }
-                return val1[path[2]];
-            }
-            case 4: {
-                const val0 = this.$this[path[0]];
-                if (!val0) {
-                    return undefined;
-                }
-                const val1 = val0[path[1]];
-                if (!val1) {
-                    return undefined;
-                }
-                const val2 = val1[path[2]];
-                if (!val2) {
-                    return undefined;
-                }
-                return val2[path[3]];
-            }
-            default: {
-                throw Error('path has too many segments');
-            }
-        }
+        return getValueByPath(path, this.$this);
     }
     /**
      * A very non sophisticated way to set values in the job via paths
@@ -843,7 +872,7 @@ class VasJobModel extends VasBaseModel {
                 return;
             }
             case 1: {
-                (this.$this)[path[0]] = value;
+                this[path[0]] = value;
                 return;
             }
             case 2: {
@@ -867,14 +896,29 @@ class VasJobModel extends VasBaseModel {
      * @return {VasJobDto}
      */
     toDto(staticOnly = false) {
-        const dto = {};
-        this.staticProperties
-            .forEach(prop => (dto)[prop] = this.$this[prop]);
         if (staticOnly) {
-            return dto;
+            return {
+                id: this.id,
+                created: this.created,
+                createdBy: this.createdBy,
+                modified: this.modified,
+                modifiedBy: this.modifiedBy,
+                serverCreated: this.serverCreated,
+                serverModified: this.serverModified,
+                account: this.account,
+                accessGroup: this.accessGroup,
+                reference: this.reference,
+                jobDate: this.jobDate,
+                jobStatus: this.jobStatus,
+                jobType: this.jobType,
+                assignee: this.assignee,
+                formId: this.formId,
+                timeZoneOffset: this.timeZoneOffset,
+            };
         }
-        this.dynamicProperties
-            .forEach(prop => dto[prop] = this.$this[prop]);
+        const dto = {};
+        [...this.staticProperties, ...this.dynamicProperties]
+            .forEach(prop => (dto)[prop] = this.$this[prop]);
         return dto;
     }
     /**
@@ -929,7 +973,33 @@ class VasJobModel extends VasBaseModel {
                 filterArg = (filterArg || '').trim();
             }
             const path = key.split('.');
-            let result = (this.getValueByPath(path) || '').toString();
+            const objectKey = path.shift() || '';
+            let result = '';
+            if (objectKey === 'job') {
+                result = (this.getValueByPath(path) || '').toString();
+            }
+            else if (objectKey === 'fields') {
+                result = (getValueByPath(path, this.getFields2()) || '').toString();
+            }
+            else if (objectKey.length) {
+                if (options.objects) {
+                    if (options.objects[objectKey] === undefined) {
+                        console.debug(`objectKey ${objectKey} is not present in options.object`);
+                        result = '';
+                    }
+                    else {
+                        result = (getValueByPath(path, options.objects[objectKey]) || '')
+                            .toString();
+                    }
+                }
+                else {
+                    console.debug(`objectKey ${objectKey} was used but options.object is not set`);
+                    return '';
+                }
+            }
+            else {
+                return '';
+            }
             if (filterName && result) {
                 switch (filterName) {
                     case 'date': {
@@ -943,7 +1013,7 @@ class VasJobModel extends VasBaseModel {
                 }
             }
             return result;
-        });
+        }).trim();
     }
     ;
 }