@ironcode/vas-lib 0.0.12 → 0.0.14

package/fesm2020/ironcode-vas-lib.mjs

@@ -45,6 +45,13 @@ class VasAccountObjectModel extends VasBaseModel {
         this.modifiedBy = modifiedBy;
         this.account = account;
     }
+    toApiDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            modified: this.modified
+        };
+    }
 }
 
 class VasRestrictedAccountObjectModel extends VasAccountObjectModel {
@@ -367,6 +374,223 @@ class VasControlTypeModel extends VasBaseModel {
     }
 }
 
+/**
+ * VasJobDataModel
+ */
+class VasJobDataModel extends VasAccountObjectModel {
+    /**
+     * @param {string} id
+     * @param {string} created
+     * @param {string} serverCreated
+     * @param {string} createdBy
+     * @param {string} modified
+     * @param {string} serverModified
+     * @param {string} modifiedBy
+     * @param {string} account
+     * @param {string} job
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, job) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.account = account;
+        this.job = job;
+    }
+}
+
+/**
+ * VasFieldModel
+ */
+class VasFieldModel extends VasJobDataModel {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, job, control, fieldJobPointers, value, version) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, job);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.account = account;
+        this.job = job;
+        this.control = control;
+        this.fieldJobPointers = fieldJobPointers;
+        this.value = value;
+        this.version = version;
+    }
+    /**
+     * @param {VasFieldDto} fieldDto
+     * @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 {VasFieldDto}
+     */
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            serverCreated: this.serverCreated,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            serverModified: this.serverModified,
+            modifiedBy: this.modifiedBy,
+            account: this.account,
+            job: this.job,
+            control: this.control,
+            fieldJobPointers: this.fieldJobPointers,
+            value: this.value,
+            version: this.version,
+        };
+    }
+    /**
+     * @return {object}
+     */
+    toApiDto() {
+        return {
+            ...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,
+     * numbers and booleans, thus if we have an array or object, we need to JSON
+     * encode it
+     * @param {VasFieldDto} value
+     * @return {string | number | boolean}
+     * @protected
+     */
+    prepareApiValue(value) {
+        switch (typeof value) {
+            case 'object': {
+                return JSON.stringify(value);
+            }
+            case 'boolean': {
+                return value;
+            }
+            case 'string': {
+                return value;
+            }
+            case 'number': {
+                return value;
+            }
+            default: {
+                return '';
+            }
+        }
+    }
+}
+
+/**
+ * VasFileDto
+ */
+class VasFileModel extends VasJobDataModel {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, job, name, fileSize, mimeType, sequence, config, url) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, job);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.account = account;
+        this.job = job;
+        this.name = name;
+        this.fileSize = fileSize;
+        this.mimeType = mimeType;
+        this.sequence = sequence;
+        this.config = config;
+        this.url = url;
+    }
+    /**
+     * @param {VasFieldDto} fileDto
+     * @return {VasFieldModel}
+     */
+    static fromDto(fileDto) {
+        return new VasFileModel(fileDto.id || UUID.UUID(), fileDto.created || '', fileDto.serverCreated || '', fileDto.createdBy || '', fileDto.modified || '', fileDto.serverModified || '', fileDto.modifiedBy || '', fileDto.account || '', fileDto.job || '', fileDto.name || '', fileDto.fileSize || 0, fileDto.mimeType || '', fileDto.sequence || 0, VasFileModel.parseConfig(fileDto.config), fileDto.url || '');
+    }
+    static parseConfig(config = '') {
+        try {
+            return JSON.parse(config);
+        }
+        catch (e) {
+            return {
+                displayAs: '',
+                embedLink: false,
+                group: 'photo',
+                description: '',
+                displayedName: '',
+                rotation: 0
+            };
+        }
+    }
+    /**
+     * @return {VasFileDto}
+     */
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            serverCreated: this.serverCreated,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            serverModified: this.serverModified,
+            modifiedBy: this.modifiedBy,
+            account: this.account,
+            job: this.job,
+            name: this.name,
+            fileSize: this.fileSize,
+            mimeType: this.mimeType,
+            sequence: this.sequence,
+            config: this.stringifyConfig(this.config),
+            url: this.url,
+        };
+    }
+    stringifyConfig(config) {
+        if (!config) {
+            return JSON.stringify({
+                displayAs: '',
+                embedLink: false,
+                group: 'photo',
+                description: '',
+                displayedName: '',
+                rotation: 0
+            });
+        }
+        try {
+            return JSON.stringify(config);
+        }
+        catch (e) {
+            console.warn(e);
+            return '';
+        }
+    }
+    toApiDto() {
+        return {
+            ...super.toApiDto(),
+            name: this.name || '~',
+            mimeType: this.mimeType || '~',
+            sequence: this.safeNumber(this.sequence),
+            config: JSON.stringify(this.config)
+        };
+    }
+    safeNumber(value) {
+        if (!Number.isFinite(value)) {
+            return 0;
+        }
+        return value;
+    }
+}
+
 /**
  * GroupModel
  */
@@ -422,6 +646,7 @@ class VasGroupModel extends VasBaseModel {
         return new VasGroupModel(
         // 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.name || '', dto.title || '', dto.description || '', dto.sequence || 0, dto.includeInSummary || false, dto.forms || [], dto.visibilityControl || '', dto.visibleIfEquals || '', (dto.controls || [])
+            .filter(control => control.name.startsWith('fields.'))
             .sort((a, b) => a.sequence - b.sequence)
             .map(c => VasControlModel.fromDto(c)), dto.scoreWeight || 1);
     }
@@ -472,7 +697,7 @@ class VasGroupModel extends VasBaseModel {
 /**
  * VasFormModel
  */
-class VasFormModel extends VasBaseModel {
+class VasFormModel extends VasRestrictedAccountObjectModel {
     /**
      * @param {string} id
      * @param {string} created
@@ -493,7 +718,7 @@ class VasFormModel extends VasBaseModel {
      * @param {string} config
      */
     constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, jobType, title, description, groups, dynamicDescriptor, indexName, pipelineName, config) {
-        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup);
         this.id = id;
         this.created = created;
         this.serverCreated = serverCreated;
@@ -729,7 +954,7 @@ const getValueByPath = (path, object) => {
 /**
  * JobModel
  */
-class VasJobModel extends VasBaseModel {
+class VasJobModel extends VasRestrictedAccountObjectModel {
     /**
      * @param {string} id
      * @param {string} created
@@ -744,12 +969,17 @@ class VasJobModel extends VasBaseModel {
      * @param {string} jobDate
      * @param {string} jobStatus
      * @param {string} jobType
-     * @param {string} assignee
+     * @param {string} assigneeId
      * @param {string} formId
      * @param {number} timeZoneOffset
+     * @param {number} pendingFields
+     * @param {string} childModified
+     * @param {number} version
+     * @param {Array<VasFieldDto>} fields
+     * @param {Array<VasFileDto>} files
      */
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, reference, jobDate, jobStatus, jobType, assignee, formId, timeZoneOffset) {
-        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, reference, jobDate, jobStatus, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, fields, files) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup);
         this.id = id;
         this.created = created;
         this.serverCreated = serverCreated;
@@ -763,9 +993,14 @@ class VasJobModel extends VasBaseModel {
         this.jobDate = jobDate;
         this.jobStatus = jobStatus;
         this.jobType = jobType;
-        this.assignee = assignee;
+        this.assigneeId = assigneeId;
         this.formId = formId;
         this.timeZoneOffset = timeZoneOffset;
+        this.pendingFields = pendingFields;
+        this.childModified = childModified;
+        this.version = version;
+        this.fields = fields;
+        this.files = files;
     }
     /**
      * Returns this with the dynamic interface
@@ -797,7 +1032,7 @@ class VasJobModel extends VasBaseModel {
     static empty() {
         return new VasJobModel(
         // eslint-disable-next-line new-cap
-        UUID.UUID(), '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset());
+        UUID.UUID(), '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset(), 0, '', 0, [], []);
     }
     /**
      * @param {VasJobDto} jobDto
@@ -806,7 +1041,7 @@ class VasJobModel extends VasBaseModel {
     static fromDto(jobDto) {
         const model = new VasJobModel(
         // eslint-disable-next-line new-cap
-        jobDto.id || UUID.UUID(), jobDto.created || '', jobDto.serverCreated || '', jobDto.createdBy || '', jobDto.modified || '', jobDto.serverModified || '', jobDto.modifiedBy || '', jobDto.account || '', jobDto.accessGroup || '', jobDto.reference || '', jobDto.jobDate || '', jobDto.jobStatus || '', jobDto.jobType || '', jobDto.assignee || '', jobDto.formId || '', jobDto.timeZoneOffset || moment().utcOffset());
+        jobDto.id || UUID.UUID(), jobDto.created || '', jobDto.serverCreated || '', jobDto.createdBy || '', jobDto.modified || '', jobDto.serverModified || '', jobDto.modifiedBy || '', jobDto.account || '', jobDto.accessGroup || '', jobDto.reference || '', jobDto.jobDate || '', jobDto.jobStatus || '', jobDto.jobType || '', jobDto.assigneeId || '', jobDto.formId || '', jobDto.timeZoneOffset || moment().utcOffset(), jobDto.pendingFields || 0, jobDto.childModified || '', jobDto.version || 0, jobDto.fields || [], jobDto.files || []);
         const emptyKeys = model.staticProperties;
         Object
             .keys(jobDto)
@@ -850,6 +1085,114 @@ class VasJobModel extends VasBaseModel {
         }, {});
         return fields;
     }
+    /**
+     * 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:
+     * A) job with dynamic properties, e.g.
+     * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
+     *   foo: {
+     *     bar: "value"
+     *   }
+     * }
+     *
+     * B) job with fields
+     * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
+     *   <will not have dynamic properties>...
+     *   fields: [
+     *     {
+     *       id: <guid>,
+     *       <other field properties>,
+     *       value: "value"
+     *     }
+     *   ]
+     * }
+     *
+     * So, what this method does is given a JobModel in the form of A, read all
+     * of those dynamic properties and set them into `fields`. Doing this requires
+     * knowledge of the Form that was used to create the job. Moreover, since the
+     * dynamic properties do not contain the ids of the fields, we also allow to
+     * pass in a `controlFieldIdMap`. This map stores the mapping between Control
+     * and the Field that was created in the Job to store the value for that
+     * Control. This is useful, if for example you want to compare a Job in form A
+     * with a Job in form B, for example if you want to update the Job on the API
+     * with a Job that was saved by a client in form A.
+     *
+     * E.g.
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 404
+     * Function -> Function: The function calls `hydrateFields(...)`
+     * Function -> API: The function POST the Job to /jobs
+     * Function -> API: The function POST each field to /fields
+     *
+     * Similarly, if the user updates the job
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits an update
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 200
+     * Function -> Function: The function calls `hydrateFields(...)` passing in
+     *                       the map is made by iterating over the fields it
+     *                       received from the API and storing the mappings
+     *                       between controlId and fieldId for each field
+     * Function -> API: The function PATCH the Job to /jobs
+     * Function -> API: The function POST/PATCH each field to /fields
+     * treated as new
+     *
+     * @param {VasFormModel} formModel the VasFormModel that was used to create
+     * the job
+     * @param {Map<string, string>} controlFieldIdMap a mapping of control to
+     * field ids. This is used to determine whether a new id for the field should
+     * 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>}
+     */
+    hydrateFields(formModel, controlFieldIdMap = new Map(), controlNames) {
+        const fields = [];
+        formModel.groups
+            .forEach(group => {
+            group.controls.forEach(control => {
+                if (!control.name.startsWith('fields.')) {
+                    return;
+                }
+                if (controlNames && !controlNames.includes(control.name)) {
+                    return;
+                }
+                fields.push(VasFieldModel.fromDto({
+                    // if the controlId exists in the map, use the associated fieldId,
+                    // otherwise generate a new id for the field.
+                    id: controlFieldIdMap.get(control.id) || UUID.UUID(),
+                    account: this.account,
+                    job: this.id,
+                    createdBy: this.createdBy,
+                    created: this.created,
+                    modifiedBy: this.modifiedBy,
+                    modified: this.modified,
+                    control: control.id,
+                    value: this.getValueByPath([group.name, control.name])
+                }));
+            });
+        });
+        this.fields = fields;
+    }
     /**
   
      * @param {string[]} path path segments
@@ -920,9 +1263,14 @@ class VasJobModel extends VasBaseModel {
                 jobDate: this.jobDate,
                 jobStatus: this.jobStatus,
                 jobType: this.jobType,
-                assignee: this.assignee,
+                assigneeId: this.assigneeId,
                 formId: this.formId,
                 timeZoneOffset: this.timeZoneOffset,
+                pendingFields: this.pendingFields,
+                childModified: this.childModified,
+                version: this.version,
+                fields: this.fields,
+                files: this.files
             };
         }
         const dto = {};
@@ -1025,6 +1373,41 @@ class VasJobModel extends VasBaseModel {
         }).trim();
     }
     ;
+    /**
+     * @return {object}
+     */
+    toApiDto() {
+        return {
+            ...super.toApiDto(),
+            reference: this.reference || '~',
+            jobDate: this.jobDate || '~',
+            jobType: this.jobType || '~',
+            accessGroup: this.accessGroup || '~',
+            jobStatus: this.jobStatus || '~',
+            assigneeId: this.assigneeId || '~',
+            timeZoneOffset: this.timeZoneOffset || 0,
+            pendingFields: this.pendingFields || 0,
+        };
+    }
+}
+
+class VasReportLayoutModel extends VasRestrictedAccountObjectModel {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, jobType, title, description, entryPoint) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.account = account;
+        this.accessGroup = accessGroup;
+        this.jobType = jobType;
+        this.title = title;
+        this.description = description;
+        this.entryPoint = entryPoint;
+    }
 }
 
 class VasReportRequestModel extends VasBaseModel {
@@ -1112,5 +1495,5 @@ class VasUserModel extends VasBaseModel {
  * Generated bundle index. Do not edit.
  */
 
-export { VasAccountObjectModel, VasBaseModel, VasBranchModel, VasContactModel, VasControlConfigDirection, VasControlModel, VasControlTypeModel, VasFormModel, VasGroupModel, VasJobModel, VasReportRequestModel, VasRestrictedAccountObjectModel, VasUserModel };
+export { VasAccountObjectModel, VasBaseModel, VasBranchModel, VasContactModel, VasControlConfigDirection, VasControlModel, VasControlTypeModel, VasFieldModel, VasFileModel, VasFormModel, VasGroupModel, VasJobDataModel, VasJobModel, VasReportLayoutModel, VasReportRequestModel, VasRestrictedAccountObjectModel, VasUserModel };
 //# sourceMappingURL=ironcode-vas-lib.mjs.map