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

package/fesm2022/ironcode-vas-lib.mjs

@@ -1,5 +1,7 @@
 import { UUID } from 'angular2-uuid';
 import moment from 'moment';
+import { Big } from 'big.js';
+import { v4 } from 'uuid';
 
 function isCameraControlValueV1(object) {
     return object instanceof Object
@@ -3258,69 +3260,527 @@ class VasJobTypeModel extends VasAccountObjectModel {
     }
 }
 
+function isNumeric(value) {
+    if (typeof value === 'number') {
+        return !isNaN(value);
+    }
+    return /^-?\d+$/.test(value.trim());
+}
+
+function coalescePath(pathOrPaths) {
+    let keys = [];
+    if (typeof pathOrPaths === 'string') {
+        keys = pathOrPaths.split('.');
+    }
+    else if (typeof pathOrPaths === 'number') {
+        keys = [pathOrPaths];
+    }
+    else if (Array.isArray(pathOrPaths)) {
+        keys = pathOrPaths;
+    }
+    else {
+        throw Error('Expected string, number or array of strings or numbers');
+    }
+    const result = [];
+    keys.forEach(key => {
+        if (typeof key === 'number') {
+            result.push(key);
+            return;
+        }
+        if (key.endsWith(']')) {
+            const match = /^([\w_#$-]+)\[([\w_#$-]+)]$/.exec(key.toString());
+            if (match !== null) {
+                result.push(match[1]);
+                result.push(isNumeric(match[2]) ? parseInt(match[2], 10) : match[2]);
+                return;
+            }
+        }
+        result.push(key);
+    });
+    return result;
+}
 /**
- * A non sophisticated way to get values from the job via paths. For example:
- *
- * getValueByPath(
- *  ['foo', 'bar'],
- *  {
- *   foo: {
- *     bar: 'value'
- *   }
- *  }
- * );
+ * Get a value from an object by path.
  *
- * will return "value"
- * @param {string[]} path
- * @param {Record<string, FieldValueType>} object
- * @return {T | undefined}
+ * Path can be an array of strings or numbers.
+ * Path can be a string using dot notation, which can include square brackets to
+ * access array positions e.g. foo.bar[0].baz
  */
-const getValueByPath = (path, object) => {
-    switch (path.length) {
-        case 0: {
-            return;
-        }
-        case 1: {
-            return (object)[path[0]];
+function getValueByPath(path, object) {
+    const p = coalescePath(path);
+    let scope = object === undefined ? null : object;
+    let index = 0;
+    const length = p.length;
+    while (!(scope === undefined || scope === null) && index < length) {
+        scope = scope[p[index++]];
+    }
+    if (!(index && index == length) || scope === null) {
+        return undefined;
+    }
+    return scope;
+}
+
+const b$2 = (value = '0') => {
+    try {
+        if (typeof value === 'string') {
+            return new Big(value.replace(/[^\d^.]/g, ''));
         }
-        case 2: {
-            const val0 = object[path[0]];
-            if (!val0) {
-                return undefined;
-            }
-            return val0[path[1]];
+        return new Big(value);
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (e) {
+        console.error(`failed to construct Big from value '${value}'`);
+        return new Big('0');
+    }
+};
+class EstimateItemModel {
+    id;
+    description;
+    type;
+    quantity;
+    quantityAdjusted;
+    units;
+    unitsAdjusted;
+    price;
+    priceAdjusted;
+    workCategory;
+    costCategory;
+    comment;
+    constructor(id, description, type, quantity, quantityAdjusted, units, unitsAdjusted, price, priceAdjusted, workCategory, costCategory, comment) {
+        this.id = id;
+        this.description = description;
+        this.type = type;
+        this.quantity = quantity;
+        this.quantityAdjusted = quantityAdjusted;
+        this.units = units;
+        this.unitsAdjusted = unitsAdjusted;
+        this.price = price;
+        this.priceAdjusted = priceAdjusted;
+        this.workCategory = workCategory;
+        this.costCategory = costCategory;
+        this.comment = comment;
+    }
+    getTotalUnits(adjusted = false) {
+        return adjusted ?
+            b$2(this.quantityAdjusted || '0').mul(this.unitsAdjusted || '0').toFixed(2) :
+            b$2(this.quantity || '0').mul(this.units || '0').toFixed(2);
+    }
+    getLineValue(labourRate = '1', timeBasis = '1', adjusted = false) {
+        const cat = this.costCategory || 'none';
+        if (this.workCategory === 'removed') {
+            return '0';
         }
-        case 3: {
-            const val0 = object[path[0]];
-            if (!val0) {
-                return undefined;
-            }
-            const val1 = val0[path[1]];
-            if (!val1) {
-                return undefined;
+        const units = (adjusted ? this.unitsAdjusted : this.units) || 0;
+        const quantity = (adjusted ? this.quantityAdjusted : this.quantity) || 0;
+        const price = (adjusted ? this.priceAdjusted : this.price) || '';
+        try {
+            switch (cat) {
+                case 'labour': {
+                    return price != '' ?
+                        price :
+                        b$2(quantity || '0')
+                            .mul(units || '0')
+                            .mul(labourRate || '0')
+                            .div(timeBasis || '1')
+                            .toFixed(2);
+                }
+                case 'pm': {
+                    return b$2(price || '0')
+                        .mul(quantity || '0')
+                        .toFixed(2);
+                }
+                case 'parts': {
+                    return b$2(price || '0')
+                        .mul(quantity || '0')
+                        .toFixed(2);
+                }
+                case 'specialist': {
+                    return b$2(price || '0')
+                        .mul(quantity || '0')
+                        .toFixed(2);
+                }
+                default: {
+                    return '0';
+                }
             }
-            return val1[path[2]];
         }
-        case 4: {
-            const val0 = object[path[0]];
-            if (!val0) {
-                return undefined;
-            }
-            const val1 = val0[path[1]];
-            if (!val1) {
-                return undefined;
-            }
-            const val2 = val1[path[2]];
-            if (!val2) {
-                return undefined;
-            }
-            return val2[path[3]];
+        catch (e) {
+            console.warn(e);
         }
-        default: {
-            throw Error('path has too many segments');
+        return '0';
+    }
+    toDto() {
+        return {
+            id: this.id,
+            description: this.description,
+            type: this.type,
+            quantity: this.quantity,
+            quantityAdjusted: this.quantityAdjusted,
+            units: this.units,
+            unitsAdjusted: this.unitsAdjusted,
+            price: this.price,
+            priceAdjusted: this.priceAdjusted,
+            workCategory: this.workCategory,
+            costCategory: this.costCategory,
+            comment: this.comment
+        };
+    }
+    static create() {
+        return new EstimateItemModel(v4(), '', '', 1, 1, 0, 0, '', '', 'none', 'none', '');
+    }
+    static fromDto(dto) {
+        return new EstimateItemModel(dto.id || v4(), dto.description || '', dto.type || '', dto.quantity || 0, dto.quantityAdjusted || 0, dto.units || 0, dto.unitsAdjusted || 0, dto.price || '', dto.priceAdjusted || '', dto.workCategory || 'none', dto.costCategory || 'none', dto.comment || '');
+    }
+    static equal(a, b) {
+        return (a?.id === b?.id &&
+            a?.description === b?.description &&
+            a?.type === b?.type &&
+            a?.quantity === b?.quantity &&
+            a?.quantityAdjusted === b?.quantityAdjusted &&
+            a?.units === b?.units &&
+            a?.unitsAdjusted === b?.unitsAdjusted &&
+            a?.price === b?.price &&
+            a?.priceAdjusted === b?.priceAdjusted &&
+            a?.workCategory === b?.workCategory &&
+            a?.costCategory === b?.costCategory &&
+            a?.comment === b?.comment);
+    }
+}
+
+const b$1 = (value = '0') => {
+    try {
+        if (typeof value === 'string') {
+            return new Big(value.replace(/[^\d^.]/g, ''));
         }
+        return new Big(value);
+    }
+    catch (e) {
+        console.error(`failed to construct Big from value '${value}'`);
+        return new Big('0');
     }
 };
+class EstimateModel {
+    id = v4();
+    source = 'manual';
+    label = '';
+    comment = '';
+    timestamp = moment().toISOString();
+    version = 1;
+    net = '0.00';
+    vat = '0.00';
+    gross = '0.00';
+    labourRate = '1';
+    vatRate = '0.00';
+    sundryRate = '0.00';
+    sundryMax = '0.00';
+    sundryFixed = '0.00';
+    sundryMethod = 'fixed';
+    partsDiscount = '0.00';
+    paintDiscount = '0.00';
+    timeBasis = '1';
+    adjusted = false;
+    items = [];
+    summaryNet = {
+        labour: '0.00',
+        none: '0.00',
+        parts: '0.00',
+        pm: '0.00',
+        pl: '0.00',
+        specialist: '0.00',
+        other: '0.00',
+        gross: '0.00',
+        net: '0.00',
+        hours: '0.00',
+        vat: '0.00',
+        labourRate: '0.00',
+    };
+    summary = {
+        labour: '0.00',
+        none: '0.00',
+        parts: '0.00',
+        pm: '0.00',
+        pl: '0.00',
+        specialist: '0.00',
+        other: '0.00',
+        gross: '0.00',
+        net: '0.00',
+        hours: '0.00',
+        vat: '0.00',
+        labourRate: '0.00',
+    };
+    summaryAdjusted = {
+        labour: '0.00',
+        none: '0.00',
+        parts: '0.00',
+        pm: '0.00',
+        pl: '0.00',
+        specialist: '0.00',
+        other: '0.00',
+        gross: '0.00',
+        net: '0.00',
+        hours: '0.00',
+        vat: '0.00',
+        labourRate: '0.00',
+    };
+    static create(source = 'manual') {
+        const model = new EstimateModel();
+        model.source = source;
+        return model;
+    }
+    static fromDto(dto) {
+        const model = new EstimateModel();
+        Object.assign(model, {
+            ...dto,
+            items: dto.items?.map(item => EstimateItemModel.fromDto(item)),
+        });
+        model.calculate();
+        return model;
+    }
+    addItem(modelOrDto, opts) {
+        this.items.push(modelOrDto instanceof EstimateItemModel ?
+            modelOrDto :
+            EstimateItemModel.fromDto(modelOrDto));
+        if (!opts || (opts && opts.calculate)) {
+            this.calculate();
+        }
+    }
+    addItems(items, opts) {
+        this.items = this.items.concat(items);
+        if (!opts || (opts && opts.calculate)) {
+            this.calculate();
+        }
+    }
+    calculate() {
+        this.summaryNet = this.getSummaryNet(false);
+        if (this.adjusted) {
+            this.summaryAdjusted = this.getSummary(this.summaryNet, this.sundryRate, this.sundryMax, this.sundryFixed, this.sundryMethod, this.partsDiscount, this.paintDiscount, this.adjusted);
+        }
+        this.summary = this.getSummary(this.summaryNet, this.sundryRate, this.sundryMax, this.sundryFixed, this.sundryMethod, this.partsDiscount, this.paintDiscount, this.adjusted);
+        this.net = b$1(0)
+            .add(this.summary.labour)
+            .add(this.summary.none)
+            .add(this.summary.parts)
+            .add(this.summary.pm)
+            .add(this.summary.specialist)
+            .toFixed(2);
+        this.vat = b$1(this.net || '0').mul(this.vatRate || '0').toFixed(2);
+        this.gross = b$1(this.net || '0').add(this.vat || '0').toFixed(2);
+    }
+    /**
+     * Returns the net summary (before sundries and discounts) of the estimate.
+     * By summary, we mean grouping the costs by cost category.
+     *
+     * @param adjusted if the values should be calculated using the original or
+     * adjusted values
+     */
+    getSummaryNet(adjusted = false) {
+        const summary = this.items.reduce((map, item) => {
+            map[item.costCategory] = b$1(map[item.costCategory] || '0')
+                .add(item.getLineValue(this.labourRate, this.timeBasis, adjusted))
+                .toFixed(2);
+            return map;
+        }, {
+            labour: '0.00',
+            none: '0.00',
+            parts: '0.00',
+            pm: '0.00',
+            pl: '0.00',
+            specialist: '0.00',
+            other: '0.00',
+            net: '0.00',
+            vat: '0.00',
+            gross: '0.00',
+            hours: '0.00',
+            labourRate: '0',
+        });
+        if (this.source === 'audatex') {
+            const mechHours = this.items
+                .filter(item => item.workCategory !== 'paint')
+                .reduce((h, item) => h.add(b$1(item.getTotalUnits(adjusted))), b$1())
+                .div(this.timeBasis || '1')
+                .round(2);
+            const paintHours = this.items
+                .filter(item => item.workCategory === 'paint')
+                .reduce((h, item) => h.add(b$1(item.getTotalUnits(adjusted))), b$1())
+                .div(this.timeBasis || '1')
+                .round(1);
+            const mechCost = mechHours.mul(this.labourRate || '0');
+            const paintCost = paintHours.mul(this.labourRate || '0');
+            summary.labour = mechCost.add(paintCost).toFixed(2);
+        }
+        return summary;
+    }
+    /**
+     * Applies the sundry and discount values to the net summary.
+  
+     */
+    getSummary(summaryNet, sundryRate, sundryMax, sundryFixed, sundryMethod, partsDiscount, paintDiscount, adjusted) {
+        const partsDisc = b$1('1').minus(partsDiscount || '0');
+        const paintDisc = b$1('1').minus(paintDiscount || '0');
+        let partsSundry = '0.00';
+        if (sundryMethod === 'percentage') {
+            partsSundry = b$1(summaryNet.parts).mul(sundryRate || '1').toFixed(2);
+        }
+        else if (sundryMethod === 'percentage-with-max') {
+            partsSundry = b$1(summaryNet.parts).mul(sundryRate || '1').toFixed(2);
+            partsSundry = Math.min(parseFloat(sundryMax || '0'), parseFloat(partsSundry)).toFixed();
+        }
+        else if (sundryMethod === 'fixed') {
+            partsSundry = b$1(sundryFixed).toFixed(2);
+        }
+        const parts = b$1(summaryNet.parts).add(partsSundry);
+        const net = b$1(0)
+            .add(summaryNet.labour)
+            .add(summaryNet.none)
+            .add(parts)
+            .add(summaryNet.pm)
+            .add(summaryNet.specialist)
+            .toFixed(2);
+        const vat = b$1(net || '0')
+            .mul(this.vatRate || '0')
+            .toFixed(2);
+        const gross = b$1(net || '0').add(vat || '0').toFixed(2);
+        return {
+            labour: summaryNet.labour,
+            none: summaryNet.none,
+            parts: b$1(parts).mul(partsDisc).toFixed(2),
+            pm: b$1(summaryNet.pm).mul(paintDisc).toFixed(2),
+            pl: summaryNet.pl,
+            specialist: summaryNet.specialist,
+            other: summaryNet.other,
+            net: net,
+            vat: vat,
+            gross: gross,
+            labourRate: this.labourRate,
+            hours: this.getTotalHours(adjusted)
+        };
+    }
+    toDto() {
+        return {
+            id: this.id,
+            source: this.source,
+            label: this.label,
+            comment: this.comment,
+            timestamp: this.timestamp,
+            version: this.version,
+            net: this.net,
+            vat: this.vat,
+            gross: this.gross,
+            labourRate: this.labourRate,
+            vatRate: this.vatRate,
+            sundryRate: this.sundryRate,
+            sundryMax: this.sundryMax,
+            sundryFixed: this.sundryFixed,
+            sundryMethod: this.sundryMethod,
+            partsDiscount: this.partsDiscount,
+            paintDiscount: this.paintDiscount,
+            timeBasis: this.timeBasis,
+            items: this.items.map(i => i.toDto()),
+            adjusted: this.adjusted,
+            summary: this.summary,
+            summaryAdjusted: this.summaryAdjusted
+        };
+    }
+    getTotalHours(adjusted = false) {
+        if (this.source === 'audatex') {
+            const mechUnitsHours = this.items
+                .filter(item => item.workCategory !== 'paint')
+                .reduce((h, item) => h.add(b$1(item.getTotalUnits(adjusted))), b$1())
+                .round(2)
+                .div(this.timeBasis || '1');
+            const paintHours = this.items
+                .filter(item => item.workCategory === 'paint')
+                .reduce((h, item) => h.add(b$1(item.getTotalUnits(adjusted))), b$1())
+                .round(1)
+                .div(this.timeBasis || '1');
+            return mechUnitsHours.add(paintHours).toFixed(2);
+        }
+        const units = this.items
+            .filter(i => i.costCategory === 'labour')
+            .reduce((p, c) => p.add(b$1(c.getTotalUnits(adjusted))), b$1('0'))
+            .toFixed(2);
+        return b$1(units).div(this.timeBasis || '1').toFixed(2);
+    }
+}
+
+const b = (value = '0') => new Big(value);
+/**
+ * Utility class for computing the summary value for an estimate control given
+ * the first and last estimates
+ */
+class EstimateControlValueModel {
+    static calculateSummary(original, latest) {
+        const o = original.summary;
+        const l = latest.adjusted ?
+            latest.summaryAdjusted :
+            latest.summary;
+        const s = {
+            labour: b(o.labour).minus(l.labour).toFixed(2),
+            none: b(o.none).minus(l.none).toFixed(2),
+            parts: b(o.parts).minus(l.parts).toFixed(2),
+            pm: b(o.pm).minus(l.pm).toFixed(2),
+            pl: b(o.pm).minus(l.pl).toFixed(2),
+            specialist: b(o.specialist).minus(l.specialist).toFixed(2),
+            other: b(o.other).minus(l.other).toFixed(2),
+            net: b(o.net).minus(l.net).toFixed(2),
+            vat: b(o.vat).minus(l.vat).toFixed(2),
+            gross: b(o.gross).minus(l.gross).toFixed(2),
+            hours: b(o.hours).minus(l.hours).toFixed(0),
+            labourRate: b(o.labourRate).minus(l.labourRate).toFixed(0)
+        };
+        return {
+            original: o,
+            latest: l,
+            savings: s
+        };
+    }
+    static getEmptySummary() {
+        return {
+            original: {
+                labour: '0.00',
+                none: '0.00',
+                parts: '0.00',
+                pm: '0.00',
+                pl: '0.00',
+                specialist: '0.00',
+                other: '0.00',
+                net: '0.00',
+                vat: '0.00',
+                gross: '0.00',
+                hours: '0',
+                labourRate: '0.00'
+            },
+            latest: {
+                labour: '0.00',
+                none: '0.00',
+                parts: '0.00',
+                pm: '0.00',
+                pl: '0.00',
+                specialist: '0.00',
+                other: '0.00',
+                net: '0.00',
+                vat: '0.00',
+                gross: '0.00',
+                hours: '0',
+                labourRate: '0.00'
+            },
+            savings: {
+                labour: '0.00',
+                none: '0.00',
+                parts: '0.00',
+                pm: '0.00',
+                pl: '0.00',
+                specialist: '0.00',
+                other: '0.00',
+                net: '0.00',
+                vat: '0.00',
+                gross: '0.00',
+                hours: '0',
+                labourRate: '0.00'
+            }
+        };
+    }
+}
 
 const getEmptyGeoLocation = () => ({
     accuracy: 0,
@@ -3335,8 +3795,8 @@ const getEmptyGeoLocation = () => ({
 });
 
 /**
- * Try to parse the value as JSON if it looks like a JSON encoded string
- * @param value
+ * 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))) {
@@ -3350,6 +3810,9 @@ const tryJson = (value) => {
     return value;
 };
 
+/**
+ * Return true if the argument is a plain object {}, i.e. not an array, null.
+ */
 function isPlainObject(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
@@ -3477,7 +3940,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
                     .keys(dto[groupName])
                     .forEach(controlName => {
                     const cn = controlName.replace('fields.', '');
-                    fields[cn] = dto[groupName][cn];
+                    fields[cn] = dto[groupName][controlName];
                 });
             });
         }
@@ -4280,9 +4743,38 @@ class VasVehicleModel extends VasAccountObjectModel {
     }
 }
 
+/**
+ * Return true IFF the array contains only strings
+ */
+const isArrayString = (value) => {
+    return Array.isArray(value) && value.every(i => typeof i === 'string');
+};
+
+/**
+ * Return an object omitting properties specified by key(s)
+ *
+ * @param obj object to be processed
+ * @param omitKey key or array of keys to be omitted
+ */
+const omit = (obj, omitKey) => {
+    return Object.keys(obj).reduce((result, key) => {
+        if (Array.isArray(omitKey)) {
+            if (!omitKey.includes(key)) {
+                result[key] = obj[key];
+            }
+        }
+        else {
+            if (omitKey !== key) {
+                result[key] = obj[key];
+            }
+        }
+        return result;
+    }, {});
+};
+
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { 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, isCameraControlValueV1, isCameraControlValueV2, isFileDto, isJobAutomationStep, isJobControlsStep, isJobEmailFormStep, isJobInstructionStep, isJobNotePromptStep, isJobSetDatetimeStep, isJobSetJobStatusStep, isJobSetValueStep, isJobWebhookStep, prepareFieldApiValue, stepModelFactory };
+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 };
 //# sourceMappingURL=ironcode-vas-lib.mjs.map