@ironcode/vas-lib 2.3.0 → 3.0.0-alpha.1

package/cjs/lib/entity/vas-job.model.js

@@ -3,20 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VasJobModel = void 0;
 const tslib_1 = require("tslib");
 const vas_file_dto_1 = require("./vas-file.dto");
-const angular2_uuid_1 = require("angular2-uuid");
 const moment_1 = tslib_1.__importDefault(require("moment"));
 const get_value_by_path_1 = require("../utils/get-value-by-path");
-const vas_field_model_1 = require("./vas-field.model");
 const vas_restricted_account_object_model_1 = require("./vas-restricted-account-object.model");
 const model_1 = require("../model");
 const control_value_1 = require("../control-value");
-const is_array_string_1 = require("../utils/is-array-string");
 const only_1 = require("../utils/only");
+const try_json_1 = require("../utils/try-json");
+const is_plain_object_1 = require("../utils/is-plain-object");
+let jobStaticProps;
+function getJobStaticProperties() {
+    if (jobStaticProps) {
+        return jobStaticProps;
+    }
+    return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
+}
 /**
  * JobModel
  */
 class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAccountObjectModel {
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup, reference, jobDate, jobStatus, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, createdByDisplayName, modifiedByDisplayName, geoLocation, files, fields, jobEmails, notes, 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) {
         super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup);
         this.id = id;
         this.created = created;
@@ -39,8 +45,6 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
         this.pendingFields = pendingFields;
         this.childModified = childModified;
         this.version = version;
-        this.createdByDisplayName = createdByDisplayName;
-        this.modifiedByDisplayName = modifiedByDisplayName;
         this.geoLocation = geoLocation;
         this.files = files;
         this.fields = fields;
@@ -50,103 +54,62 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
         this.tasks = tasks;
         this.instruction = instruction;
     }
-    /**
-     * Returns this with the dynamic interface
-     * @return {VasJobModelDynamicInterface}
-     */
-    get $this() {
-        return this;
+    get createdByDisplayName() {
+        return this.createdByName;
     }
-    /**
-     * Returns a list of Job dynamic properties i.e. those that are added by the
-     * dynamic forms
-     */
-    get dynamicProperties() {
-        const nativeProps = this.staticProperties;
-        return Object
-            .getOwnPropertyNames(this)
-            .filter(prop => !nativeProps.includes(prop));
+    get modifiedByDisplayName() {
+        return this.modifiedByName;
     }
     /**
-     * Returns the list of properties of the Job type
+     * Return the list of Job properties
      */
     get staticProperties() {
-        return Object.getOwnPropertyNames(VasJobModel.empty());
+        if (jobStaticProps) {
+            return jobStaticProps;
+        }
+        return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
     }
     /**
      * @return {VasJobModel}
      */
     static empty() {
-        return new VasJobModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', (0, moment_1.default)().utcOffset(), 0, '', 0, '', '', (0, model_1.getEmptyGeoLocation)(), [], [], [], [], [], [], null);
+        return new VasJobModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', (0, moment_1.default)().utcOffset(), 0, '', 0, (0, model_1.getEmptyGeoLocation)(), [], {}, [], [], [], [], null);
     }
     static fromDto(dto) {
-        const model = 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 || (0, moment_1.default)().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.createdByDisplayName || '', dto.modifiedByDisplayName || '', dto.geoLocation || (0, model_1.getEmptyGeoLocation)(), dto.files || [], dto.fields || [], dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
-        const emptyKeys = model.staticProperties;
-        Object
-            .keys(dto)
-            .filter(key => emptyKeys.indexOf(key) === -1)
-            .forEach((key) => model.$this[key] = dto[key]);
-        return model;
-    }
-    /**
-     * This method will instantiate a new JobModel. The difference with this
-     * method of instantiation is that we are coming from a relation frame i.e.
-     * the job has a list of {@link VasFieldDto} instead of a Job document.
-     *
-     */
-    static fromRelational(dto, form) {
-        const model = 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.timeZoneOffset || (0, moment_1.default)().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.createdByDisplayName || '', dto.modifiedByDisplayName || '', dto.geoLocation || (0, model_1.getEmptyGeoLocation)(), dto.files || [], dto.fields || [], dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
-        form.groups
-            .forEach(group => {
-            group.controls
-                .forEach(control => {
-                var _a;
-                const field = (_a = dto.fields) === null || _a === void 0 ? void 0 : _a.find(f => f.control === control.id);
-                if (!field) {
-                    return;
-                }
-                model.getGroup(group.name)[control.name] = field.value;
-            });
-        });
-        return model;
-    }
-    /**
-     * @param {VasFormModel} formModel
-     * @return {Record<string, VasFieldDtoValue>}
-     */
-    getFields(formModel) {
-        const fields = {};
-        formModel.groups
-            .forEach(group => {
-            group.controls.forEach(control => {
-                (fields)[control.reportTemplateName] =
-                    this.getValueByPath([group.name, control.name]) || null;
-            });
+        // 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 = (0, is_plain_object_1.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.', '')] = (0, try_json_1.tryJson)(field.value);
         });
-        return fields;
-    }
-    /**
-     * Will return an object whose keys are the names of all fields in the job.
-     * This method is similar to `getFields` except that this method will only
-     * return values where a value was set, as opposed to `getFields` which will
-     * return a value for every control even if no value was set, because it uses
-     * the form to drive the logic. Note also this method will return values for
-     * any Fields in the fields array.
-     * @return {Record<string, VasFieldDtoValue>}
-     */
-    getFields2() {
-        let fields = {};
-        this.dynamicProperties
-            .forEach((groupName) => {
+        // 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(this.$this[groupName])
-                .forEach(controlName => {
-                fields[controlName] =
-                    this.getValueByPath([groupName, controlName]) || null;
+                .keys(dto)
+                .filter(key => !getJobStaticProperties().has(key))
+                .forEach(groupName => {
+                Object
+                    .keys(dto[groupName])
+                    .forEach(controlName => {
+                    const cn = controlName.replace('fields.', '');
+                    fields[cn] = dto[groupName][cn];
+                });
             });
-        }, {});
-        this.fields.forEach(field => fields[field.controlName] = field.value);
-        return fields;
+        }
+        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 || (0, moment_1.default)().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || (0, model_1.getEmptyGeoLocation)(), dto.files || [], fields, dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
     }
     /**
      * Returns an object describing how many attachments were added to this job
@@ -156,22 +119,12 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
      * job was created
      */
     getFilesUploadStatus(formModel) {
-        const pathsWithValue = formModel
-            .getCameraControlPaths()
-            .map(path => {
-            const value = this.getValueByPath(path);
-            if (value && !!value.id) {
-                return path;
-            }
-            return null;
-        })
-            .filter(path => path !== null ? path : null)
-            .filter(is_array_string_1.isArrayString);
-        let total = pathsWithValue.length;
-        total += this.files.length;
+        const cameraFieldValues = Object
+            .values(this.fields)
+            .filter(value => (0, control_value_1.isCameraControlValueV2)(value) || (0, control_value_1.isCameraControlValueV1)(value));
+        let total = cameraFieldValues.length + this.files.length;
         // calculate the number of camera images still to upload
-        let pending = pathsWithValue
-            .map(path => this.getValueByPath(path))
+        let pending = cameraFieldValues
             .map((value) => {
             if ((0, vas_file_dto_1.isFileDto)(value)) {
                 return value.id && value.status !== 'COMPLETE';
@@ -184,218 +137,51 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
         })
             .filter(hasUploaded => hasUploaded)
             .length;
-        // add total from files that are pending
-        pending += this.files
-            .filter(value => value.status !== 'COMPLETE')
-            .length;
+        // add count of job.files that are complete
+        pending += this.files.filter(value => value.status !== 'COMPLETE').length;
         return {
             pending,
             total
         };
     }
-    /**
-     * This method will return the dynamic property from the JobModel that
-     * represent a group (from a form).
-     *
-     * @param name the name of the group
-     * @param init if true (default) and group is not found, initialise an empty
-     * group, otherwise throw an error
-     */
-    getGroup(name, init = true) {
-        let prop;
-        if (this.staticProperties.includes(name)) {
-            throw Error(`invalid group name ${name}, not a dynamic property`);
-        }
-        else if (this.$this[name] === undefined) {
-            if (init) {
-                prop = this.$this[name] = {};
-            }
-            else {
-                throw Error(`invalid group name ${name}, not found`);
-            }
-        }
-        else {
-            prop = this.$this[name];
-            if (typeof prop !== 'object') {
-                throw Error(`invalid group name ${name}, not an object`);
-            }
-        }
-        return prop;
-    }
     /**
      * @param path path segments
      */
     getValueByPath(path = []) {
-        return (0, get_value_by_path_1.getValueByPath)(path, this.$this);
-    }
-    /**
-     * In order to understand why we need this method it is important to
-     * understand that within the system, Jobs can be represented in one of two
-     * ways, document and relational.
-     *
-     * The important distinction is how values submitted by a form are stored.
-     *
-     * Jobs stored as documents (JSON objects) will store user values, as dynamic
-     * properties of the document.
-     *
-     * Whereas, Jobs stored as relational, will store user values in an array of
-     * {@link VasFieldDto} objects.
-     *
-     * Depending on where we are in the system, either one of these approaches can
-     * be more useful than the other.
-     *
-     * This method, assumes that the JobModel has been instantiated from a
-     * document representation, and serves to hydrate the fields array. In order
-     * to achieve this, knowledge of the {@link VasFormDto} that created the job
-     * is required.
-     *
-     *
-     * Job in document representation
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   foo: {
-     *     bar: "value"
-     *   }
-     * }
-     *
-     * Job in relational representation
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   <will not have dynamic properties>...
-     *   fields: [
-     *     {
-     *       id: <guid>,
-     *       <other field properties>,
-     *       value: "value"
-     *     }
-     *   ]
-     * }
-     *
-     *
-     * @param formModel the VasFormModel that was used to create the job
-     * @param controlFieldIdMap This is used to determine the id each field.
-     * Either one will be found in the map, or a new one is generated.
-     * @param 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(vas_field_model_1.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) || angular2_uuid_1.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;
-    }
-    /**
-     * A very non sophisticated way to set values in the job via paths
-     *
-     * For example:
-     *
-     * setValueByPath('value', ['foo', 'bar']);
-     *
-     * will make results in job
-     * {
-     *   foo: {
-     *     bar: 'value'
-     *   }
-     * }
-     *
-     * @param value the value to set
-     * @param path path segments
-     */
-    setValueByPath(value, path = []) {
-        switch (path.length) {
-            case 0: {
-                return;
-            }
-            case 1: {
-                this[path[0]] = value;
-                return;
-            }
-            case 2: {
-                // eslint-disable-next-line max-len
-                this.$this[path[0]][path[1]] = value;
-                return;
-            }
-            case 3: {
-                // eslint-disable-next-line max-len
-                this.$this[path[0]][path[1]][path[2]] = value;
-                return;
-            }
-            default: {
-                throw Error('path has too many segments');
-            }
-        }
+        return (0, get_value_by_path_1.getValueByPath)(Array.isArray(path) ? path : path.split('.'), this);
     }
-    /**
-     * @param staticOnly if true, will only output values for the static
-     * properties in the dto
-     */
-    toDto(staticOnly = false) {
-        if (staticOnly) {
-            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,
-                createdByDisplayName: this.createdByDisplayName,
-                modifiedByDisplayName: this.modifiedByDisplayName,
-                geoLocation: this.geoLocation,
-                files: this.files,
-                fields: this.fields,
-                jobEmails: this.jobEmails,
-                notes: this.notes,
-                reports: this.reports,
-                tasks: this.tasks,
-                instruction: this.instruction
-            };
-        }
-        const dto = {};
-        [...this.staticProperties, ...this.dynamicProperties]
-            .forEach(prop => dto[prop] = this.$this[prop]);
-        return dto;
+    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
@@ -429,7 +215,7 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
         if (!value || typeof value !== 'string') {
             return '';
         }
-        const fields = this.getFields2();
+        const fields = this.fields;
         return value.replace(/({[^}]*})/g, (match, token) => {
             const syntax = token.substring(1, token.length - 1);
             let [key, filter] = syntax.split('|');
@@ -455,24 +241,11 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
             if (objectKey === 'job') {
                 result = (this.getValueByPath(path) || '').toString();
             }
-            else if (objectKey === 'fields') {
-                result = ((0, get_value_by_path_1.getValueByPath)(['fields.' + path.shift(), ...path], fields) || '').toString();
+            else if (objectKey === 'fields' || this.fields[path[0]] !== undefined) {
+                result = ((0, get_value_by_path_1.getValueByPath)(path, fields) || '').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 = ((0, get_value_by_path_1.getValueByPath)(path, options.objects[objectKey]) || '')
-                            .toString();
-                    }
-                }
-                else {
-                    console.debug(`objectKey ${objectKey} was used but options.object is not set`);
-                    return '';
-                }
+            else if (objectKey.length && options.objects && options.objects[objectKey] !== undefined) {
+                result = ((0, get_value_by_path_1.getValueByPath)(path, options.objects[objectKey]) || '').toString();
             }
             else {
                 return '';
@@ -516,7 +289,7 @@ class VasJobModel extends vas_restricted_account_object_model_1.VasRestrictedAcc
             'assigneeId',
             'timeZoneOffset',
             'pendingFields',
-            'lastForm'
+            'formId'
         ]);
     }
 }