@ironcode/vas-lib 3.0.0-alpha.3 → 3.0.0-alpha.5

package/fesm2022/ironcode-vas-lib.mjs

@@ -1539,7 +1539,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {VasFieldModel}
      */
     static fromDto(fieldDto) {
-        return new VasFieldModel(fieldDto.id || '', fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.createdByName || '', fieldDto.modifiedByName || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], fieldDto.value || '', fieldDto.version || 0, fieldDto.controlName || '', fieldDto.controlTitle || '', fieldDto.controlTypeName || '');
+        return new VasFieldModel(fieldDto.id || '', fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.createdByName || '', fieldDto.modifiedByName || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], fieldDto.value !== undefined ? fieldDto.value : null, fieldDto.version || 0, fieldDto.controlName || '', fieldDto.controlTitle || '', fieldDto.controlTypeName || '');
     }
     /**
      * @return {VasFieldDto}
@@ -3311,12 +3311,12 @@ function getValueByPath(path, object) {
     let scope = object === undefined ? null : object;
     let index = 0;
     const length = p.length;
-    while (!(scope === undefined || scope === null) && index < length) {
+    while (index < length) {
+        if (scope === undefined || scope === null) {
+            return undefined;
+        }
         scope = scope[p[index++]];
     }
-    if (!(index && index == length) || scope === null) {
-        return undefined;
-    }
     return scope;
 }
 
@@ -3794,22 +3794,6 @@ const getEmptyGeoLocation = () => ({
     timestamp: ''
 });
 
-/**
- * Try to parse the value as JSON if it looks like a JSON encoded string, return
- * the original value if it's not a JSON string or parsing fails.
- */
-const tryJson = (value) => {
-    if (typeof value === 'string' && ['{', '['].includes(value.substring(0, 1))) {
-        try {
-            return JSON.parse(value);
-        }
-        catch (e) {
-            return value;
-        }
-    }
-    return value;
-};
-
 /**
  * Return true if the argument is a plain object {}, i.e. not an array, null.
  */
@@ -3818,16 +3802,10 @@ function isPlainObject(value) {
 }
 
 let jobStaticProps;
-function getJobStaticProperties() {
-    if (jobStaticProps) {
-        return jobStaticProps;
-    }
-    return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
-}
 /**
- * JobModel
+ * VasJobBaseModel
  */
-class VasJobModel extends VasRestrictedAccountObjectModel {
+class VasJobBaseModel extends VasRestrictedAccountObjectModel {
     id;
     created;
     serverCreated;
@@ -3842,6 +3820,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     reference;
     jobDate;
     jobStatus;
+    jobStatusLastUpdate;
     jobType;
     assigneeId;
     formId;
@@ -3857,7 +3836,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     reports;
     tasks;
     instruction;
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup, reference, jobDate, jobStatus, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, geoLocation, files, fields, jobEmails, notes, reports, tasks, instruction) {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup, reference, jobDate, jobStatus, jobStatusLastUpdate, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, geoLocation, files, fields, jobEmails, notes, reports, tasks, instruction) {
         super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup);
         this.id = id;
         this.created = created;
@@ -3873,6 +3852,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         this.reference = reference;
         this.jobDate = jobDate;
         this.jobStatus = jobStatus;
+        this.jobStatusLastUpdate = jobStatusLastUpdate;
         this.jobType = jobType;
         this.assigneeId = assigneeId;
         this.formId = formId;
@@ -3902,49 +3882,8 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         if (jobStaticProps) {
             return jobStaticProps;
         }
-        return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
-    }
-    /**
-     * @return {VasJobModel}
-     */
-    static empty() {
-        return new VasJobModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset(), 0, '', 0, getEmptyGeoLocation(), [], {}, [], [], [], [], null);
-    }
-    static fromDto(dto) {
-        // we have changed the job model and stopped using the dynamic properties
-        // from form group names to hold fields. Instead, we store a simple object
-        // where the control name (minus the "fields." prefix) is the key, and the
-        // field value is the value. However, we have to cater for data that may
-        // be persisted in the old structure, or an API response where fields is an
-        // array of VasFieldDto.
-        // 1: if dto.fields is already an object, we use the existing value
-        const fields = isPlainObject(dto.fields) ?
-            dto.fields :
-            {};
-        // 2: if dto.fields is an array, we're handling a vas-rest response, we
-        //    iterate over the fields and update the fields object.
-        Array.isArray(dto.fields) && dto.fields.forEach((field) => {
-            fields[field.controlName.replace('fields.', '')] = tryJson(field.value);
-        });
-        // 3: if `fields` still has no keys, we're restoring a VasJobDto object that
-        //    was saved in the old "form-group" style, where dynamic keys are
-        //    derived from the form-group names. We'll iterate over those keys, and
-        //    update the `fields` object. Once this model is serialized back to a
-        //    dto, it will have the new shape.
-        if (Object.keys(fields).length === 0) {
-            Object
-                .keys(dto)
-                .filter(key => !getJobStaticProperties().has(key))
-                .forEach(groupName => {
-                Object
-                    .keys(dto[groupName])
-                    .forEach(controlName => {
-                    const cn = controlName.replace('fields.', '');
-                    fields[cn] = dto[groupName][controlName];
-                });
-            });
-        }
-        return new VasJobModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || getEmptyGeoLocation(), dto.files || [], fields, dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+        return jobStaticProps =
+            new Set(Object.getOwnPropertyNames(VasJobDocumentModel.empty()));
     }
     /**
      * Returns an object describing how many attachments were added to this job
@@ -3985,39 +3924,6 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     getValueByPath(path = []) {
         return getValueByPath(Array.isArray(path) ? path : path.split('.'), this);
     }
-    toDto() {
-        return {
-            id: this.id,
-            created: this.created,
-            createdBy: this.createdBy,
-            modified: this.modified,
-            modifiedBy: this.modifiedBy,
-            serverCreated: this.serverCreated,
-            serverModified: this.serverModified,
-            createdByName: this.createdByName,
-            modifiedByName: this.modifiedByName,
-            account: this.account,
-            accessGroup: this.accessGroup,
-            reference: this.reference,
-            jobDate: this.jobDate,
-            jobStatus: this.jobStatus,
-            jobType: this.jobType,
-            assigneeId: this.assigneeId,
-            formId: this.formId,
-            timeZoneOffset: this.timeZoneOffset,
-            pendingFields: this.pendingFields,
-            childModified: this.childModified,
-            version: this.version,
-            geoLocation: this.geoLocation,
-            files: this.files,
-            fields: this.fields,
-            jobEmails: this.jobEmails,
-            notes: this.notes,
-            reports: this.reports,
-            tasks: this.tasks,
-            instruction: this.instruction
-        };
-    }
     /**
      * This method will parse a syntax that allows us to build strings from the
      * values of from the job model. For example if the job model was:
@@ -4076,8 +3982,8 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
             if (objectKey === 'job') {
                 result = (this.getValueByPath(path) || '').toString();
             }
-            else if (objectKey === 'fields' || this.fields[path[0]] !== undefined) {
-                result = (getValueByPath(path, fields) || '').toString();
+            else if (objectKey === 'fields') {
+                result = (this.getValueByPath(['fields', ...path]) || '').toString();
             }
             else if (objectKey.length && options.objects && options.objects[objectKey] !== undefined) {
                 result = (getValueByPath(path, options.objects[objectKey]) || '').toString();
@@ -4139,6 +4045,132 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         ]);
     }
 }
+class VasJobRelationalModel extends VasJobBaseModel {
+    getValueByPath(path = []) {
+        const parts = Array.isArray(path) ? path : path.split('.');
+        if (parts[0] === 'fields') {
+            return this.getFieldValueByPath(parts[1], parts.slice(2));
+        }
+        return getValueByPath(parts, this);
+    }
+    getFieldsMap() {
+        return this.fields.reduce((p, c) => {
+            p[c.controlName] = c.value;
+            return p;
+        }, {});
+    }
+    getFieldValueByPath(controlName, path) {
+        for (const field of this.fields) {
+            if (field.controlName === controlName) {
+                if (path.length === 0) {
+                    return field.value;
+                }
+                if (field.value === null) {
+                    return path.length >= 1 ? undefined : null;
+                }
+                if (isPlainObject(field.value)) {
+                    return getValueByPath(path, field.value);
+                }
+                return undefined;
+            }
+        }
+        return undefined;
+    }
+    static fromDto(dto) {
+        if (dto.fields !== undefined && !Array.isArray(dto.fields)) {
+            throw Error('fields must be an array');
+        }
+        return new VasJobRelationalModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || getEmptyGeoLocation(), dto.files || [], (dto.fields || []).map(f => VasFieldModel.fromDto(f)), dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static empty() {
+        return new VasJobRelationalModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset(), 0, '', 0, getEmptyGeoLocation(), [], [], [], [], [], [], null);
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            modifiedBy: this.modifiedBy,
+            serverCreated: this.serverCreated,
+            serverModified: this.serverModified,
+            createdByName: this.createdByName,
+            modifiedByName: this.modifiedByName,
+            account: this.account,
+            accessGroup: this.accessGroup,
+            reference: this.reference,
+            jobDate: this.jobDate,
+            jobStatus: this.jobStatus,
+            jobStatusLastUpdate: this.jobStatusLastUpdate,
+            jobType: this.jobType,
+            assigneeId: this.assigneeId,
+            formId: this.formId,
+            timeZoneOffset: this.timeZoneOffset,
+            pendingFields: this.pendingFields,
+            childModified: this.childModified,
+            version: this.version,
+            geoLocation: this.geoLocation,
+            files: this.files,
+            fields: this.fields.map(f => f.toDto()),
+            jobEmails: this.jobEmails,
+            notes: this.notes,
+            reports: this.reports,
+            tasks: this.tasks,
+            instruction: this.instruction
+        };
+    }
+}
+class VasJobDocumentModel extends VasJobBaseModel {
+    static fromRelationalDto(dto) {
+        return new VasJobDocumentModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || getEmptyGeoLocation(), dto.files || [], (dto.fields || []).reduce((p, c) => {
+            p[c.controlName.replace('fields.', '')] = c.value;
+            return p;
+        }, {}), dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static fromDto(dto) {
+        if (dto.fields !== undefined && !isPlainObject(dto.fields)) {
+            throw Error('fields must be an object');
+        }
+        return new VasJobDocumentModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || getEmptyGeoLocation(), dto.files || [], dto.fields || {}, dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static empty() {
+        return new VasJobDocumentModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset(), 0, '', 0, getEmptyGeoLocation(), [], {}, [], [], [], [], null);
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            modifiedBy: this.modifiedBy,
+            serverCreated: this.serverCreated,
+            serverModified: this.serverModified,
+            createdByName: this.createdByName,
+            modifiedByName: this.modifiedByName,
+            account: this.account,
+            accessGroup: this.accessGroup,
+            reference: this.reference,
+            jobDate: this.jobDate,
+            jobStatus: this.jobStatus,
+            jobStatusLastUpdate: this.jobStatusLastUpdate,
+            jobType: this.jobType,
+            assigneeId: this.assigneeId,
+            formId: this.formId,
+            timeZoneOffset: this.timeZoneOffset,
+            pendingFields: this.pendingFields,
+            childModified: this.childModified,
+            version: this.version,
+            geoLocation: this.geoLocation,
+            files: this.files,
+            fields: this.fields,
+            jobEmails: this.jobEmails,
+            notes: this.notes,
+            reports: this.reports,
+            tasks: this.tasks,
+            instruction: this.instruction
+        };
+    }
+}
 
 class VasLookupTypeModel extends VasAccountObjectModel {
     id;
@@ -4772,9 +4804,25 @@ const omit = (obj, omitKey) => {
     }, {});
 };
 
+/**
+ * Try to parse the value as JSON if it looks like a JSON encoded string, return
+ * the original value if it's not a JSON string or parsing fails.
+ */
+const tryJson = (value) => {
+    if (typeof value === 'string' && ['{', '['].includes(value.substring(0, 1))) {
+        try {
+            return JSON.parse(value);
+        }
+        catch (e) {
+            return value;
+        }
+    }
+    return value;
+};
+
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { EstimateControlValueModel, EstimateItemModel, EstimateModel, VasAccessGroupModel, VasAccountIndexingMode, VasAccountObjectModel, VasBaseModel, VasBranchModel, VasContactModel, VasContactTypeModel, VasControlConfigDirection, VasControlModel, VasControlTypeModel, VasFieldModel, VasFileModel, VasFireUserModel, VasFormConfigModel, VasFormModel, VasGroupModel, VasInstructionJobFieldModel, VasInstructionJobModel, VasInstructionModel, VasInstructionProviderModel, VasInvitationModel, VasInvitationTypeEnum, VasJobActionControlsStepModel, VasJobActionEmailFormStepModel, VasJobActionInstructionStepModel, VasJobActionModel, VasJobActionNotePromptStepModel, VasJobActionSetDatetimeStepModel, VasJobActionSetJobStatusStepModel, VasJobActionSetValueStepModel, VasJobActionWebhookStepModel, VasJobCopyModel, VasJobDataModel, VasJobEmailModel, VasJobModel, VasJobStatusModel, VasJobTypeModel, VasLookupModel, VasLookupTypeModel, VasMembershipModel, VasNoteModel, VasReportLayoutModel, VasReportModel, VasReportRequestModel, VasRestrictedAccountObjectModel, VasTaskModel, VasTaskTypeModel, VasUserModel, VasVehicleModel, getEmptyGeoLocation, getValueByPath, isArrayString, isCameraControlValueV1, isCameraControlValueV2, isFileDto, isJobAutomationStep, isJobControlsStep, isJobEmailFormStep, isJobInstructionStep, isJobNotePromptStep, isJobSetDatetimeStep, isJobSetJobStatusStep, isJobSetValueStep, isJobWebhookStep, isNumeric, isPlainObject, omit, only, prepareFieldApiValue, stepModelFactory, tryJson };
+export { EstimateControlValueModel, EstimateItemModel, EstimateModel, VasAccessGroupModel, VasAccountIndexingMode, VasAccountObjectModel, VasBaseModel, VasBranchModel, VasContactModel, VasContactTypeModel, VasControlConfigDirection, VasControlModel, VasControlTypeModel, VasFieldModel, VasFileModel, VasFireUserModel, VasFormConfigModel, VasFormModel, VasGroupModel, VasInstructionJobFieldModel, VasInstructionJobModel, VasInstructionModel, VasInstructionProviderModel, VasInvitationModel, VasInvitationTypeEnum, VasJobActionControlsStepModel, VasJobActionEmailFormStepModel, VasJobActionInstructionStepModel, VasJobActionModel, VasJobActionNotePromptStepModel, VasJobActionSetDatetimeStepModel, VasJobActionSetJobStatusStepModel, VasJobActionSetValueStepModel, VasJobActionWebhookStepModel, VasJobBaseModel, VasJobCopyModel, VasJobDataModel, VasJobDocumentModel, VasJobEmailModel, VasJobRelationalModel, VasJobStatusModel, VasJobTypeModel, VasLookupModel, VasLookupTypeModel, VasMembershipModel, VasNoteModel, VasReportLayoutModel, VasReportModel, VasReportRequestModel, VasRestrictedAccountObjectModel, VasTaskModel, VasTaskTypeModel, VasUserModel, VasVehicleModel, getEmptyGeoLocation, getValueByPath, isArrayString, isCameraControlValueV1, isCameraControlValueV2, isFileDto, isJobAutomationStep, isJobControlsStep, isJobEmailFormStep, isJobInstructionStep, isJobNotePromptStep, isJobSetDatetimeStep, isJobSetJobStatusStep, isJobSetValueStep, isJobWebhookStep, isNumeric, isPlainObject, omit, only, prepareFieldApiValue, stepModelFactory, tryJson };
 //# sourceMappingURL=ironcode-vas-lib.mjs.map