@ironcode/vas-lib 3.0.0-alpha.2 → 3.0.0-alpha.24

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
@@ -1537,7 +1539,7 @@ class VasFieldModel extends VasJobDataModel {
      * @return {VasFieldModel}
      */
     static fromDto(fieldDto) {
-        return new VasFieldModel(fieldDto.id || '', fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.createdByName || '', fieldDto.modifiedByName || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], fieldDto.value || '', fieldDto.version || 0, fieldDto.controlName || '', fieldDto.controlTitle || '', fieldDto.controlTypeName || '');
+        return new VasFieldModel(fieldDto.id || '', fieldDto.created || '', fieldDto.serverCreated || '', fieldDto.createdBy || '', fieldDto.modified || '', fieldDto.serverModified || '', fieldDto.modifiedBy || '', fieldDto.createdByName || '', fieldDto.modifiedByName || '', fieldDto.account || '', fieldDto.job || '', fieldDto.control || '', fieldDto.fieldJobPointers || [], fieldDto.value !== undefined ? fieldDto.value : null, fieldDto.version || 0, fieldDto.controlName || '', fieldDto.controlTitle || '', fieldDto.controlTypeName || '');
     }
     /**
      * @return {VasFieldDto}
@@ -2243,7 +2245,7 @@ class VasFormModel extends VasRestrictedAccountObjectModel {
                 if (control.controlTypeName !== 'camera') {
                     return;
                 }
-                paths.push([group.name, control.safeName]);
+                paths.push(control.name.split('.'));
             });
         });
         return paths;
@@ -3258,69 +3260,547 @@ 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;
+function getValueByPath(path, object) {
+    const p = coalescePath(path);
+    let scope = object === undefined ? null : object;
+    let index = 0;
+    const length = p.length;
+    while (index < length) {
+        if (scope === undefined || scope === null) {
+            return undefined;
         }
-        case 1: {
-            return (object)[path[0]];
+        scope = scope[p[index++]];
+    }
+    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;
+    vatExcluded;
+    constructor(id, description, type, quantity, quantityAdjusted, units, unitsAdjusted, price, priceAdjusted, workCategory, costCategory, comment, vatExcluded) {
+        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;
+        this.vatExcluded = vatExcluded;
+    }
+    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, vatExcluded) {
+        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;
-            }
-            return val1[path[2]];
+        if (vatExcluded !== undefined && this.vatExcluded !== vatExcluded) {
+            return '0';
         }
-        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;
+        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)
+                            .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 val2[path[3]];
         }
-        default: {
-            throw Error('path has too many segments');
+        catch (e) {
+            console.warn(e);
         }
+        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,
+            vatExcluded: this.vatExcluded
+        };
+    }
+    static create() {
+        return new EstimateItemModel(v4(), '', '', 1, 1, 0, 0, '', '', 'none', 'none', '', false);
+    }
+    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 || '', dto.vatExcluded || false);
+    }
+    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');
     }
 };
+function isLabourWorkCategory(value) {
+    return ['check', 'rr', 'repair', 'removed'].includes(value);
+}
+function isPaintWorkCategory(value) {
+    return ['blend', 'paint'].includes(value);
+}
+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',
+    };
+    get timeBasisSafe() {
+        return (this.timeBasis || '1') === '0' ? '1' : this.timeBasis;
+    }
+    static create(source = 'manual') {
+        const model = new EstimateModel();
+        model.source = source;
+        return model;
+    }
+    static fromDto(dto) {
+        const model = new this();
+        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) {
+            const summaryNetAdjusted = this.getSummaryNet(true);
+            this.summaryAdjusted = this.getSummary(summaryNetAdjusted, this.sundryRate, this.sundryMax, this.sundryFixed, this.sundryMethod, this.partsDiscount, this.paintDiscount, true);
+        }
+        this.summary = this.getSummary(this.summaryNet, this.sundryRate, this.sundryMax, this.sundryFixed, this.sundryMethod, this.partsDiscount, this.paintDiscount, false);
+        this.net = this.summary.net;
+        this.vat = this.summary.vat;
+        this.gross = this.summary.gross;
+    }
+    /**
+     * 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.timeBasisSafe, adjusted, this.source === 'gtmotive' ? false : undefined))
+                .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
+                .reduce((h, item) => {
+                return isLabourWorkCategory(item.workCategory) ?
+                    h.add(b$1(item.getTotalUnits(adjusted))) :
+                    h;
+            }, b$1())
+                .div(this.timeBasisSafe || '1')
+                .round(2);
+            const paintHours = this.items
+                .reduce((h, item) => {
+                return isPaintWorkCategory(item.workCategory) ?
+                    h.add(b$1(item.getTotalUnits(adjusted))) :
+                    h;
+            }, b$1())
+                .div(this.timeBasisSafe || '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(2);
+        }
+        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);
+        let gross = b$1(net || '0').add(vat || '0').toFixed(2);
+        // calculate the total value of lines that are VAT excluded
+        const vatExcludeTotal = this.items.reduce((p, c) => c.vatExcluded ?
+            p.add(c.getLineValue(this.labourRate, this.timeBasisSafe, adjusted, true)) :
+            p, b$1());
+        gross = b$1(gross).add(vatExcludeTotal).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.timeBasisSafe,
+            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.timeBasisSafe);
+            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.timeBasisSafe);
+            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.timeBasisSafe).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 +3815,44 @@ const getEmptyGeoLocation = () => ({
 });
 
 /**
- * Try to parse the value as JSON if it looks like a JSON encoded string
- * @param value
+ * Return true IFF the array contains only strings
+ */
+const isArrayString = (value) => {
+    return Array.isArray(value) && value.every(i => typeof i === 'string');
+};
+
+/**
+ * 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);
+}
+
+/**
+ * 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;
+    }, {});
+};
+
+/**
+ * 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,21 +3866,35 @@ const tryJson = (value) => {
     return value;
 };
 
-function isPlainObject(value) {
-    return typeof value === 'object' && value !== null && !Array.isArray(value);
-}
-
+const nullables = new Set([
+    'created',
+    'modified',
+    'reference',
+    'jobDate',
+    'followUpDate',
+    'followUpStatus',
+    'followUpNote',
+]);
 let jobStaticProps;
-function getJobStaticProperties() {
+function getStaticProps() {
     if (jobStaticProps) {
         return jobStaticProps;
     }
-    return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
+    return jobStaticProps = new Set([
+        ...Object.getOwnPropertyNames(VasJobDocumentModel.empty()),
+        'assignee'
+    ]);
+}
+function isArrayOfFields(value) {
+    return !!value && Array.isArray(value);
+}
+function isDictionaryOfFields(value) {
+    return !!value && isPlainObject(value);
 }
 /**
- * JobModel
+ * VasJobBaseModel
  */
-class VasJobModel extends VasRestrictedAccountObjectModel {
+class VasJobBaseModel extends VasRestrictedAccountObjectModel {
     id;
     created;
     serverCreated;
@@ -3379,6 +3909,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     reference;
     jobDate;
     jobStatus;
+    jobStatusLastUpdate;
     jobType;
     assigneeId;
     formId;
@@ -3386,6 +3917,9 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     pendingFields;
     childModified;
     version;
+    followUpDate;
+    followUpStatus;
+    followUpNote;
     geoLocation;
     files;
     fields;
@@ -3394,7 +3928,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     reports;
     tasks;
     instruction;
-    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup, reference, jobDate, jobStatus, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, geoLocation, files, fields, jobEmails, notes, reports, tasks, instruction) {
+    constructor(id, created, serverCreated, createdBy, modified, serverModified, modifiedBy, createdByName, modifiedByName, account, accessGroup, reference, jobDate, jobStatus, jobStatusLastUpdate, jobType, assigneeId, formId, timeZoneOffset, pendingFields, childModified, version, followUpDate, followUpStatus, followUpNote, 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;
@@ -3410,6 +3944,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         this.reference = reference;
         this.jobDate = jobDate;
         this.jobStatus = jobStatus;
+        this.jobStatusLastUpdate = jobStatusLastUpdate;
         this.jobType = jobType;
         this.assigneeId = assigneeId;
         this.formId = formId;
@@ -3417,6 +3952,9 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         this.pendingFields = pendingFields;
         this.childModified = childModified;
         this.version = version;
+        this.followUpDate = followUpDate;
+        this.followUpStatus = followUpStatus;
+        this.followUpNote = followUpNote;
         this.geoLocation = geoLocation;
         this.files = files;
         this.fields = fields;
@@ -3436,52 +3974,7 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
      * Return the list of Job properties
      */
     get staticProperties() {
-        if (jobStaticProps) {
-            return jobStaticProps;
-        }
-        return jobStaticProps = new Set(Object.getOwnPropertyNames(VasJobModel.empty()));
-    }
-    /**
-     * @return {VasJobModel}
-     */
-    static empty() {
-        return new VasJobModel('', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', moment().utcOffset(), 0, '', 0, getEmptyGeoLocation(), [], {}, [], [], [], [], null);
-    }
-    static fromDto(dto) {
-        // we have changed the job model and stopped using the dynamic properties
-        // from form group names to hold fields. Instead, we store a simple object
-        // where the control name (minus the "fields." prefix) is the key, and the
-        // field value is the value. However, we have to cater for data that may
-        // be persisted in the old structure, or an API response where fields is an
-        // array of VasFieldDto.
-        // 1: if dto.fields is already an object, we use the existing value
-        const fields = isPlainObject(dto.fields) ?
-            dto.fields :
-            {};
-        // 2: if dto.fields is an array, we're handling a vas-rest response, we
-        //    iterate over the fields and update the fields object.
-        Array.isArray(dto.fields) && dto.fields.forEach((field) => {
-            fields[field.controlName.replace('fields.', '')] = tryJson(field.value);
-        });
-        // 3: if `fields` still has no keys, we're restoring a VasJobDto object that
-        //    was saved in the old "form-group" style, where dynamic keys are
-        //    derived from the form-group names. We'll iterate over those keys, and
-        //    update the `fields` object. Once this model is serialized back to a
-        //    dto, it will have the new shape.
-        if (Object.keys(fields).length === 0) {
-            Object
-                .keys(dto)
-                .filter(key => !getJobStaticProperties().has(key))
-                .forEach(groupName => {
-                Object
-                    .keys(dto[groupName])
-                    .forEach(controlName => {
-                    const cn = controlName.replace('fields.', '');
-                    fields[cn] = dto[groupName][controlName];
-                });
-            });
-        }
-        return new VasJobModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.geoLocation || getEmptyGeoLocation(), dto.files || [], fields, dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+        return getStaticProps();
     }
     /**
      * Returns an object describing how many attachments were added to this job
@@ -3522,39 +4015,6 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
     getValueByPath(path = []) {
         return getValueByPath(Array.isArray(path) ? path : path.split('.'), this);
     }
-    toDto() {
-        return {
-            id: this.id,
-            created: this.created,
-            createdBy: this.createdBy,
-            modified: this.modified,
-            modifiedBy: this.modifiedBy,
-            serverCreated: this.serverCreated,
-            serverModified: this.serverModified,
-            createdByName: this.createdByName,
-            modifiedByName: this.modifiedByName,
-            account: this.account,
-            accessGroup: this.accessGroup,
-            reference: this.reference,
-            jobDate: this.jobDate,
-            jobStatus: this.jobStatus,
-            jobType: this.jobType,
-            assigneeId: this.assigneeId,
-            formId: this.formId,
-            timeZoneOffset: this.timeZoneOffset,
-            pendingFields: this.pendingFields,
-            childModified: this.childModified,
-            version: this.version,
-            geoLocation: this.geoLocation,
-            files: this.files,
-            fields: this.fields,
-            jobEmails: this.jobEmails,
-            notes: this.notes,
-            reports: this.reports,
-            tasks: this.tasks,
-            instruction: this.instruction
-        };
-    }
     /**
      * This method will parse a syntax that allows us to build strings from the
      * values of from the job model. For example if the job model was:
@@ -3587,7 +4047,6 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
         if (!value || typeof value !== 'string') {
             return '';
         }
-        const fields = this.fields;
         return value.replace(/({[^}]*})/g, (match, token) => {
             const syntax = token.substring(1, token.length - 1);
             let [key, filter] = syntax.split('|');
@@ -3613,8 +4072,8 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
             if (objectKey === 'job') {
                 result = (this.getValueByPath(path) || '').toString();
             }
-            else if (objectKey === 'fields' || this.fields[path[0]] !== undefined) {
-                result = (getValueByPath(path, fields) || '').toString();
+            else if (objectKey === 'fields') {
+                result = (this.getValueByPath(['fields', ...path]) || '').toString();
             }
             else if (objectKey.length && options.objects && options.objects[objectKey] !== undefined) {
                 result = (getValueByPath(path, options.objects[objectKey]) || '').toString();
@@ -3672,8 +4131,242 @@ class VasJobModel extends VasRestrictedAccountObjectModel {
             'assigneeId',
             'timeZoneOffset',
             'pendingFields',
-            'formId'
-        ]);
+            'formId',
+            'followUpDate',
+            'followUpStatus',
+            'followUpNote',
+        ], (value, key) => value[key] === null && nullables.has(key) ? '~' : value[key]);
+    }
+}
+class VasJobRelationalModel extends VasJobBaseModel {
+    getValueByPath(path = []) {
+        const parts = Array.isArray(path) ? path : path.split('.');
+        if (parts[0] === 'fields') {
+            return this.getFieldValueByPath(parts[1], parts.slice(2));
+        }
+        return getValueByPath(parts, this);
+    }
+    getFieldsMap() {
+        return this.fields.reduce((p, c) => {
+            p[c.controlName] = c.value;
+            return p;
+        }, {});
+    }
+    getFieldValueByPath(controlName, path) {
+        for (const field of this.fields) {
+            if (field.controlName === controlName) {
+                if (path.length === 0) {
+                    return field.value;
+                }
+                if (field.value === null) {
+                    return path.length >= 1 ? undefined : null;
+                }
+                if (isPlainObject(field.value)) {
+                    return getValueByPath(path, field.value);
+                }
+                return undefined;
+            }
+        }
+        return undefined;
+    }
+    static fromDto(dto) {
+        if (dto.fields !== undefined && !Array.isArray(dto.fields)) {
+            throw Error('fields must be an array');
+        }
+        return new VasJobRelationalModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.followUpDate || '', dto.followUpStatus || '', dto.followUpNote || '', dto.geoLocation || getEmptyGeoLocation(), dto.files || [], (dto.fields || []).map(f => VasFieldModel.fromDto(f)), dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static empty() {
+        return new VasJobRelationalModel('', // id
+        '', // created
+        '', // serverCreated
+        '', // createdBy
+        '', // modified
+        '', // serverModified
+        '', // modifiedBy
+        '', // createdByName
+        '', // modifiedByName
+        '', // account
+        '', // accessGroup
+        '', // reference
+        '', // jobDate
+        '', // jobStatus
+        '', // jobStatusLastUpdate
+        '', // jobType
+        '', // assigneeId
+        '', // formId
+        moment().utcOffset(), // timeZoneOffset
+        0, // pendingFields: number,
+        '', // childModified: string,
+        0, // version: number,
+        '', // followUpDate: string,
+        '', // followUpStatus: string,
+        '', // followUpNote: string,
+        getEmptyGeoLocation(), // geoLocation: GeoLocation,
+        [], // files: Array<VasFileDto>,
+        [], // fields: FType,
+        [], // jobEmails: Array<VasJobEmailDto>,
+        [], // notes: Array<VasNoteDto>,
+        [], // reports: Array<VasReportDto>,
+        [], // tasks: Array<VasTaskDto>,
+        null // instruction: VasInstructionDto | null
+        );
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            modifiedBy: this.modifiedBy,
+            serverCreated: this.serverCreated,
+            serverModified: this.serverModified,
+            createdByName: this.createdByName,
+            modifiedByName: this.modifiedByName,
+            account: this.account,
+            accessGroup: this.accessGroup,
+            reference: this.reference,
+            jobDate: this.jobDate,
+            jobStatus: this.jobStatus,
+            jobStatusLastUpdate: this.jobStatusLastUpdate,
+            jobType: this.jobType,
+            assigneeId: this.assigneeId,
+            formId: this.formId,
+            timeZoneOffset: this.timeZoneOffset,
+            pendingFields: this.pendingFields,
+            childModified: this.childModified,
+            version: this.version,
+            followUpDate: this.followUpDate,
+            followUpStatus: this.followUpStatus,
+            followUpNote: this.followUpNote,
+            geoLocation: this.geoLocation,
+            files: this.files,
+            fields: this.fields.map(f => f.toDto()),
+            jobEmails: this.jobEmails,
+            notes: this.notes,
+            reports: this.reports,
+            tasks: this.tasks,
+            instruction: this.instruction
+        };
+    }
+}
+class VasJobDocumentModel extends VasJobBaseModel {
+    static fromRelationalDto(dto) {
+        return new VasJobDocumentModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.followUpDate || '', dto.followUpStatus || '', dto.followUpNote || '', dto.geoLocation || getEmptyGeoLocation(), dto.files || [], (dto.fields || []).reduce((p, c) => {
+            p[c.controlName.replace('fields.', '')] = c.value;
+            return p;
+        }, {}), dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static fromDto(dto, options = { disableMigrateCheck: false }) {
+        let fields = {};
+        if (dto.fields !== undefined) {
+            if (isArrayOfFields(dto.fields)) {
+                for (const field of dto.fields) {
+                    fields[field.controlName.replace('fields.', '')] =
+                        tryJson(field.value);
+                }
+            }
+            else if (isDictionaryOfFields(dto.fields)) {
+                fields = dto.fields;
+            }
+        }
+        // this code is checking if a have a document in the old dynamic job style,
+        // i.e. where there are keys in the job object that come from the form-group
+        // names. I did consider comparing the number of keys in the dto vs the
+        // number of expected keys, but this will fail if we try to read old objects
+        // that don't have new properties added. So we always check by default. We
+        // can skip this check by setting disableMigrateCheck in the options.
+        if (!options || !options.disableMigrateCheck) {
+            const ddto = dto;
+            const actualKeys = Object.keys(ddto);
+            actualKeys.reduce((f, groupName) => {
+                if (getStaticProps().has(groupName)) {
+                    return f;
+                }
+                Object
+                    .keys(ddto[groupName])
+                    .forEach(controlName => {
+                    if (!controlName.startsWith('fields.')) {
+                        return;
+                    }
+                    f[controlName.slice(7)] = ddto[groupName][controlName];
+                });
+                return f;
+            }, fields);
+        }
+        return new VasJobDocumentModel(dto.id || '', dto.created || '', dto.serverCreated || '', dto.createdBy || '', dto.modified || '', dto.serverModified || '', dto.modifiedBy || '', dto.createdByName || '', dto.modifiedByName || '', dto.account || '', dto.accessGroup || '', dto.reference || '', dto.jobDate || '', dto.jobStatus || '', dto.jobStatusLastUpdate || '', dto.jobType || '', dto.assigneeId || '', dto.formId || dto.lastForm || '', dto.timeZoneOffset || moment().utcOffset(), dto.pendingFields || 0, dto.childModified || '', dto.version || 0, dto.followUpDate || '', dto.followUpStatus || '', dto.followUpNote || '', dto.geoLocation || getEmptyGeoLocation(), dto.files || [], fields, dto.jobEmails || [], dto.notes || [], dto.reports || [], dto.tasks || [], dto.instruction || null);
+    }
+    static empty() {
+        return new VasJobDocumentModel('', // id
+        '', // created
+        '', // serverCreated
+        '', // createdBy
+        '', // modified
+        '', // serverModified
+        '', // modifiedBy
+        '', // createdByName
+        '', // modifiedByName
+        '', // account
+        '', // accessGroup
+        '', // reference
+        '', // jobDate
+        '', // jobStatus
+        '', // jobStatusLastUpdate
+        '', // jobType
+        '', // assigneeId
+        '', // formId
+        moment().utcOffset(), // timeZoneOffset
+        0, // pendingFields: number,
+        '', // childModified: string,
+        0, // version: number,
+        '', // followUpDate: string,
+        '', // followUpStatus: string,
+        '', // followUpNote: string,
+        getEmptyGeoLocation(), // geoLocation: GeoLocation,
+        [], // files: Array<VasFileDto>,
+        {}, // fields: FType,
+        [], // jobEmails: Array<VasJobEmailDto>,
+        [], // notes: Array<VasNoteDto>,
+        [], // reports: Array<VasReportDto>,
+        [], // tasks: Array<VasTaskDto>,
+        null // instruction: VasInstructionDto | null
+        );
+    }
+    toDto() {
+        return {
+            id: this.id,
+            created: this.created,
+            createdBy: this.createdBy,
+            modified: this.modified,
+            modifiedBy: this.modifiedBy,
+            serverCreated: this.serverCreated,
+            serverModified: this.serverModified,
+            createdByName: this.createdByName,
+            modifiedByName: this.modifiedByName,
+            account: this.account,
+            accessGroup: this.accessGroup,
+            reference: this.reference,
+            jobDate: this.jobDate,
+            jobStatus: this.jobStatus,
+            jobStatusLastUpdate: this.jobStatusLastUpdate,
+            jobType: this.jobType,
+            assigneeId: this.assigneeId,
+            formId: this.formId,
+            timeZoneOffset: this.timeZoneOffset,
+            pendingFields: this.pendingFields,
+            childModified: this.childModified,
+            version: this.version,
+            followUpDate: this.followUpDate,
+            followUpStatus: this.followUpStatus,
+            followUpNote: this.followUpNote,
+            geoLocation: this.geoLocation,
+            files: this.files,
+            fields: this.fields,
+            jobEmails: this.jobEmails,
+            notes: this.notes,
+            reports: this.reports,
+            tasks: this.tasks,
+            instruction: this.instruction
+        };
     }
 }
 
@@ -4284,5 +4977,5 @@ class VasVehicleModel extends VasAccountObjectModel {
  * 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, VasJobBaseModel, VasJobCopyModel, VasJobDataModel, VasJobDocumentModel, VasJobEmailModel, VasJobRelationalModel, VasJobStatusModel, VasJobTypeModel, VasLookupModel, VasLookupTypeModel, VasMembershipModel, VasNoteModel, VasReportLayoutModel, VasReportModel, VasReportRequestModel, VasRestrictedAccountObjectModel, VasTaskModel, VasTaskTypeModel, VasUserModel, VasVehicleModel, getEmptyGeoLocation, getValueByPath, isArrayString, isCameraControlValueV1, isCameraControlValueV2, isFileDto, isJobAutomationStep, isJobControlsStep, isJobEmailFormStep, isJobInstructionStep, isJobNotePromptStep, isJobSetDatetimeStep, isJobSetJobStatusStep, isJobSetValueStep, isJobWebhookStep, isNumeric, isPlainObject, omit, only, prepareFieldApiValue, stepModelFactory, tryJson };
 //# sourceMappingURL=ironcode-vas-lib.mjs.map