@ironcode/vas-lib 0.0.1

package/fesm2020/ironcode-vas-lib.mjs

@@ -0,0 +1,755 @@
+import { UUID } from 'angular2-uuid';
+import * as moment_ from 'moment';
+
+var VasControlConfigDirection;
+(function (VasControlConfigDirection) {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    VasControlConfigDirection[VasControlConfigDirection["ROW"] = 0] = "ROW";
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    VasControlConfigDirection[VasControlConfigDirection["COLUMN"] = 1] = "COLUMN";
+})(VasControlConfigDirection || (VasControlConfigDirection = {}));
+
+/**
+ * BaseEntityModel
+ */
+class VasBaseModel {
+    /**
+     * @param {string} id
+     * @param {string} created
+     * @param {string} serverCreated
+     * @param {string} createdBy
+     * @param {string} modified
+     * @param {string} serverModified
+     * @param {string} modifiedBy
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy) {
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+    }
+}
+
+/**
+ * ControlModel
+ */
+class VasControlModel extends VasBaseModel {
+    /**
+     * @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} accessGroup
+     * @param {string} controlType
+     * @param {string} group
+     * @param {string[]} validators
+     * @param {string} name
+     * @param {string} title
+     * @param {boolean} linkable
+     * @param {number} sequence
+     * @param {string} description
+     * @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) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        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.controlType = controlType;
+        this.group = group;
+        this.validators = validators;
+        this.name = name;
+        this.title = title;
+        this.linkable = linkable;
+        this.sequence = sequence;
+        this.description = description;
+        this.defaultValue = defaultValue;
+        this.config = config;
+        this.controlTypeModel = undefined;
+    }
+    /**
+     * The config property is returned from the api as a json string, this getter
+     * will deserialize it
+     * @return {T}
+     */
+    getConfigModel() {
+        return JSON.parse(this.config);
+    }
+    /**
+     * The defaultValue property is returned from the api as a string or number,
+     * in the case of string, it maybe a json. This getter will return an
+     * object if the value is a json string
+     */
+    get defaultValueDecoded() {
+        return this.parseMaybeJson(this.defaultValue);
+    }
+    /**
+     * Returns the name of this control to be used in the report templates
+     * i.e. field.foo -> foo
+     * @return {string}
+     */
+    get reportTemplateName() {
+        return this.name.replace(/^fields\./, '');
+    }
+    /**
+     * @return {string}
+     */
+    get safeName() {
+        return this.name;
+    }
+    /**
+     * @return {VasControlModel}
+     */
+    static empty() {
+        return VasControlModel.fromDto({
+            // eslint-disable-next-line new-cap
+            id: UUID.UUID()
+        });
+    }
+    /**
+     * @param {VasControlDto} dto
+     * @return {VasControlModel}
+     */
+    static fromDto(dto) {
+        return new VasControlModel(
+        // 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.controlType || '', dto.group || '', dto.validators || [], dto.name || '', dto.title || '', dto.linkable || false, dto.sequence || 0, dto.description || '', dto.defaultValue || '', dto.config || '{}');
+    }
+    /**
+     * @param {string} value
+     * @return {VasControlModelDefaultValueType}
+     */
+    parseMaybeJson(value) {
+        if (typeof value !== 'string') {
+            return value;
+        }
+        try {
+            return JSON.parse(value);
+        }
+        catch (e) {
+            return value;
+        }
+    }
+    /**
+     * @return {VasControlDto}
+     */
+    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,
+            accessGroup: this.accessGroup,
+            controlType: this.controlType,
+            group: this.group,
+            validators: this.validators,
+            name: this.name,
+            title: this.title,
+            linkable: this.linkable,
+            sequence: this.sequence,
+            description: this.description,
+            defaultValue: this.defaultValue,
+            config: this.config
+        };
+    }
+}
+
+/**
+ * VasControlTypeModel
+ */
+class VasControlTypeModel extends VasBaseModel {
+    /**
+     * @param {string} id
+     * @param {string} created
+     * @param {string} serverCreated
+     * @param {string} createdBy
+     * @param {string} modified
+     * @param {string} serverModified
+     * @param {string} modifiedBy
+     * @param {string} name
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, name) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.name = name;
+    }
+    /**
+     * @param {VasControlTypeDto} dto
+     * @return {VasControlTypeModel}
+     */
+    static fromDto(dto) {
+        return new VasControlTypeModel(
+        // eslint-disable-next-line new-cap
+        dto.id || UUID.UUID(), dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.name || '');
+    }
+    /**
+     * @return {VasControlTypeDto}
+     */
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            serverCreated: this.serverCreated,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            serverModified: this.serverModified,
+            modifiedBy: this.modifiedBy,
+            name: this.name
+        };
+    }
+}
+
+/**
+ * GroupModel
+ */
+class VasGroupModel extends VasBaseModel {
+    /**
+     * @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} accessGroup
+     * @param {string} name
+     * @param {string} title
+     * @param {string} description
+     * @param {number} sequence
+     * @param {boolean} includeInSummary
+     * @param {string[]} forms
+     * @param {string} visibilityControl
+     * @param {string} visibleIfEquals
+     * @param {VasControlModel[]} controls
+     * @param {number} scoreWeight
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, name, title, description, sequence, includeInSummary, forms, visibilityControl, visibleIfEquals, controls, scoreWeight) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        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.name = name;
+        this.title = title;
+        this.description = description;
+        this.sequence = sequence;
+        this.includeInSummary = includeInSummary;
+        this.forms = forms;
+        this.visibilityControl = visibilityControl;
+        this.visibleIfEquals = visibleIfEquals;
+        this.controls = controls;
+        this.scoreWeight = scoreWeight;
+    }
+    /**
+     * @param {VasGroupDto} dto
+     * @return {VasGroupModel}
+     */
+    static fromDto(dto) {
+        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 || [])
+            .sort((a, b) => a.sequence - b.sequence)
+            .map(c => VasControlModel.fromDto(c)), dto.scoreWeight || 1);
+    }
+    /**
+     * @param {Array<VasControlModel>} valuesByControlId
+     * @return {boolean}
+     */
+    isVisible(valuesByControlId) {
+        if (!this.visibilityControl || !this.visibleIfEquals) {
+            return true;
+        }
+        const control = valuesByControlId
+            .find(c => c.id === this.visibilityControl);
+        if (!control) {
+            console.warn(`control with id ${this.visibilityControl} not found`);
+            return true;
+        }
+        return (control.value || '').toString() === this.visibleIfEquals;
+    }
+    /**
+     * @return {VasGroupDto}
+     */
+    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,
+            accessGroup: this.accessGroup,
+            name: this.name,
+            title: this.title,
+            description: this.description,
+            sequence: this.sequence,
+            includeInSummary: this.includeInSummary,
+            forms: this.forms,
+            visibilityControl: this.visibilityControl,
+            visibleIfEquals: this.visibleIfEquals,
+            controls: this.controls.map(control => control.toDto()),
+            scoreWeight: this.scoreWeight
+        };
+    }
+}
+
+/**
+ * VasFormModel
+ */
+class VasFormModel extends VasBaseModel {
+    /**
+     * @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} accessGroup
+     * @param {string} jobType
+     * @param {string} title
+     * @param {string} description
+     * @param {VasGroupModel[]} groups
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, jobType, title, description, groups) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        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.groups = groups;
+    }
+    /**
+     * The VAS API response for Form will inline Group and Control but not
+     * ControlType. This method is a help which will allows us to construct an
+     * instance of VasFormModel with the ControlType model set appropriately into
+     * each VasControlModel
+     * @param {VasFormDto} formDto
+     * @param {Array<VasControlTypeDto>} controlTypeDtos
+     * @return {VasFormModel}
+     */
+    static fromApiResponse(formDto, controlTypeDtos) {
+        const controlTypeModels = controlTypeDtos
+            .map(ctDto => VasControlTypeModel.fromDto(ctDto));
+        const formModel = VasFormModel.fromDto(formDto);
+        formModel.groups
+            .forEach(group => {
+            group.controls
+                .forEach(control => {
+                control.controlTypeModel = controlTypeModels
+                    .find(ct => ct.id === control.controlType);
+            });
+        });
+        return formModel;
+    }
+    /**
+     * @param {VasFormDto} dto
+     * @return {VasFormModel}
+     */
+    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)));
+    }
+    /**
+     * @param {string} id
+     * @return {VasControlModel | undefined}
+     */
+    findControlModelById(id) {
+        let result;
+        this.groups
+            .find(group => group.controls
+            .find(control => {
+            if (control.id !== id) {
+                return;
+            }
+            result = control;
+            return true;
+        }));
+        return result;
+    }
+    /**
+     *
+     * @return {Array<Array<string>>}
+     */
+    getCameraControlPaths() {
+        const paths = [];
+        this.groups.forEach(group => {
+            group.controls.forEach(control => {
+                if (control.controlTypeModel?.name !== 'camera') {
+                    return;
+                }
+                paths.push([group.name, control.safeName]);
+            });
+        });
+        return paths;
+    }
+    /**
+     * @param {VasJobModel} jobModel
+     * @return {Array<{id: string, value: VasFieldDtoValue}>}
+     */
+    getValuesByControlId(jobModel) {
+        const items = [];
+        this.groups
+            .forEach(group => {
+            group.controls
+                .forEach(control => {
+                items.push({
+                    id: control.id,
+                    value: jobModel.getValueByPath([group.name, control.safeName])
+                });
+            });
+        });
+        return items;
+    }
+    /**
+     * @return {VasFormDto}
+     */
+    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,
+            accessGroup: this.accessGroup,
+            jobType: this.jobType,
+            title: this.title,
+            description: this.description,
+            groups: this.groups.map(group => group.toDto()),
+        };
+    }
+}
+
+/**
+ * JobModel
+ */
+class VasJobModel extends VasBaseModel {
+    /**
+     * @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} accessGroup
+     * @param {string} reference
+     * @param {string} jobDate
+     * @param {string} jobStatus
+     * @param {string} jobType
+     * @param {string} assignee
+     * @param {string} formId
+     */
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, account, accessGroup, reference, jobDate, jobStatus, jobType, assignee, formId) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        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.reference = reference;
+        this.jobDate = jobDate;
+        this.jobStatus = jobStatus;
+        this.jobType = jobType;
+        this.assignee = assignee;
+        this.formId = formId;
+    }
+    /**
+     * Returns this with the dynamic interface
+     * @return {VasJobModelDynamicInterface}
+     */
+    get $this() {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const $this = this;
+        return this;
+    }
+    /**
+     * 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));
+    }
+    /**
+     * Returns a list of Job static properties i.e. those that are declared by
+     * the type
+     */
+    get staticProperties() {
+        return Object.getOwnPropertyNames(VasJobModel.empty());
+    }
+    /**
+     * @return {VasJobModel}
+     */
+    static empty() {
+        return new VasJobModel(
+        // eslint-disable-next-line new-cap
+        UUID.UUID(), '', '', '', '', '', '', '', '', '', '', '', '', '', '');
+    }
+    /**
+     * @param {VasJobDto} jobDto
+     * @return {VasJobModel}
+     */
+    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 || '');
+        const emptyKeys = model.staticProperties;
+        Object
+            .keys(jobDto)
+            .filter(key => emptyKeys.indexOf(key) === -1)
+            .forEach((key) => model.$this[key] = jobDto[key]);
+        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]);
+            });
+        });
+        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"
+     *
+     * @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]];
+                return val0[path[1]];
+            }
+            case 3: {
+                const val0 = this.$this[path[0]];
+                const val1 = val0[path[1]];
+                return val1[path[2]];
+            }
+            default: {
+                throw Error('path has too many segments');
+            }
+        }
+    }
+    /**
+     * 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 {any} value the value to set
+     * @param {string[]} path path segments
+     */
+    setValueByPath(value, path = []) {
+        switch (path.length) {
+            case 0: {
+                return;
+            }
+            case 1: {
+                (this.$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');
+            }
+        }
+    }
+    /**
+     * @param {boolean} staticOnly if true, will only output values for the static
+     * properties in the dto
+     * @return {VasJobDto}
+     */
+    toDto(staticOnly = false) {
+        const dto = {};
+        this.staticProperties
+            .forEach(prop => (dto)[prop] = this.$this[prop]);
+        if (staticOnly) {
+            return dto;
+        }
+        this.dynamicProperties
+            .forEach(prop => dto[prop] = this.$this[prop]);
+        return dto;
+    }
+}
+
+class VasReportRequestModel extends VasBaseModel {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, error, jobId, title, url) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.error = error;
+        this.jobId = jobId;
+        this.title = title;
+        this.url = url;
+    }
+    static fromDto(dto) {
+        return new VasReportRequestModel(dto.id || UUID.UUID(), dto.created || moment_().toISOString(), dto.serverCreated || '', dto.createdBy || '', dto.modified || moment_().toISOString(), dto.serverModified || '', dto.modifiedBy || '', dto.error || '', dto.jobId || '', dto.title || '', dto.url || '');
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            serverCreated: this.serverCreated,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            serverModified: this.serverModified,
+            modifiedBy: this.modifiedBy,
+            error: this.error,
+            jobId: this.jobId,
+            title: this.title,
+            url: this.url
+        };
+    }
+}
+
+class VasUserModel extends VasBaseModel {
+    constructor(id, created = '', serverCreated = '', createdBy = '', modified = '', serverModified = '', modifiedBy = '', email, username) {
+        super(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy);
+        this.id = id;
+        this.created = created;
+        this.serverCreated = serverCreated;
+        this.createdBy = createdBy;
+        this.modified = modified;
+        this.serverModified = serverModified;
+        this.modifiedBy = modifiedBy;
+        this.email = email;
+        this.username = username;
+    }
+    static fromDto(dto) {
+        return new VasUserModel(dto.id, dto.created, dto.serverCreated, dto.createdBy, dto.modified, dto.serverModified, dto.modifiedBy, dto.email, dto.username);
+    }
+    static newUser(uid, displayName, email) {
+        return {
+            id: uid,
+            created: moment_().toISOString(),
+            createdBy: uid,
+            modified: moment_().toISOString(),
+            modifiedBy: uid,
+            serverCreated: moment_().toISOString(),
+            serverModified: moment_().toISOString(),
+            email: email,
+            username: displayName,
+        };
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            serverCreated: this.serverCreated,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            serverModified: this.serverModified,
+            modifiedBy: this.modifiedBy,
+            email: this.email,
+            username: this.username
+        };
+    }
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { VasBaseModel, VasControlConfigDirection, VasControlModel, VasControlTypeModel, VasFormModel, VasGroupModel, VasJobModel, VasReportRequestModel, VasUserModel };
+//# sourceMappingURL=ironcode-vas-lib.mjs.map