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

package/lib/control-value/vas-camera-control-value.model.d.ts

@@ -1,9 +1,11 @@
 import { VasFileDto } from '../entity';
-export interface VasCameraControlValueModel {
+export interface VasCameraControlValueValue {
     webPath: string;
     path: string;
     url?: string;
     id?: string;
 }
-export declare function isCameraControlValueV1(object: any): object is VasCameraControlValueModel;
+/** @deprecated */
+export type VasCameraControlValueModel = VasCameraControlValueValue;
+export declare function isCameraControlValueV1(object: any): object is VasCameraControlValueValue;
 export declare function isCameraControlValueV2(object: any): object is VasFileDto;

package/lib/entity/vas-field.dto.d.ts

@@ -1,9 +1,8 @@
 import { VasJobDataDto } from './vas-job-data.dto';
 import { VasFileDto } from './vas-file.dto';
-import { GeoLocation } from '../model';
-import { VasFunctionControlValueDto } from '../control-value';
-import { VasCameraControlValueModel } from '../control-value';
-export declare type FieldValueType = string | number | boolean | null | GeoLocation | Array<object | string | number | boolean | VasFileDto> | Record<string, any> | VasCameraControlValueModel | VasFunctionControlValueDto;
+import { EstimateControlValueDto, GeoLocation } from '../model';
+import { VasCameraControlValueValue, VasFunctionControlValueDto } from '../control-value';
+export declare type FieldValueType = string | number | boolean | null | GeoLocation | Array<object | string | number | boolean | VasFileDto> | Record<string, any> | VasCameraControlValueValue | EstimateControlValueDto | VasFunctionControlValueDto;
 export interface VasFieldDto extends VasJobDataDto {
     control: string;
     fieldJobPointers: Array<string>;

package/lib/model/estimate-control/estimate-control-value.dto.d.ts

@@ -0,0 +1,13 @@
+import { EstimateDto, EstimateSummaryDto } from './estimate.dto';
+export interface EstimateControlValueSummaryDto {
+    original: EstimateSummaryDto;
+    latest: EstimateSummaryDto;
+    savings: EstimateSummaryDto;
+}
+/**
+ * Describes the value of the estimate control
+ */
+export interface EstimateControlValueDto {
+    estimates: Array<EstimateDto>;
+    summary: EstimateControlValueSummaryDto;
+}

package/lib/model/estimate-control/estimate-control-value.model.d.ts

@@ -0,0 +1,10 @@
+import { EstimateControlValueSummaryDto } from './estimate-control-value.dto';
+import { EstimateModel } from './estimate.model';
+/**
+ * Utility class for computing the summary value for an estimate control given
+ * the first and last estimates
+ */
+export declare class EstimateControlValueModel {
+    static calculateSummary(original: EstimateModel, latest: EstimateModel): EstimateControlValueSummaryDto;
+    static getEmptySummary(): EstimateControlValueSummaryDto;
+}

package/lib/model/estimate-control/estimate-item.dto.d.ts

@@ -0,0 +1,15 @@
+import { EstimateCostCategory, EstimateWorkCategory } from './estimate.types';
+export interface EstimateItemDto {
+    id: string;
+    description: string;
+    type: string;
+    quantity: number;
+    units: number;
+    price: string;
+    workCategory: EstimateWorkCategory;
+    costCategory: EstimateCostCategory;
+    comment: string;
+    quantityAdjusted: number;
+    unitsAdjusted: number;
+    priceAdjusted: string;
+}

package/lib/model/estimate-control/estimate-item.model.d.ts

@@ -0,0 +1,23 @@
+import { EstimateItemDto } from './estimate-item.dto';
+import { EstimateCostCategory, EstimateWorkCategory } from './estimate.types';
+export declare class EstimateItemModel {
+    id: string;
+    description: string;
+    type: string;
+    quantity: number;
+    quantityAdjusted: number;
+    units: number;
+    unitsAdjusted: number;
+    price: string;
+    priceAdjusted: string;
+    workCategory: EstimateWorkCategory;
+    costCategory: EstimateCostCategory;
+    comment: string;
+    constructor(id: string, description: string, type: string, quantity: number, quantityAdjusted: number, units: number, unitsAdjusted: number, price: string, priceAdjusted: string, workCategory: EstimateWorkCategory, costCategory: EstimateCostCategory, comment: string);
+    getTotalUnits(adjusted?: boolean): string;
+    getLineValue(labourRate?: string, timeBasis?: string, adjusted?: boolean): string;
+    toDto(): EstimateItemDto;
+    static create(): EstimateItemModel;
+    static fromDto(dto: Partial<EstimateItemDto>): EstimateItemModel;
+    static equal(a: EstimateItemDto | undefined, b: EstimateItemDto | undefined): boolean;
+}

package/lib/model/estimate-control/estimate.dto.d.ts

@@ -0,0 +1,36 @@
+import { EstimateItemDto } from './estimate-item.dto';
+import { EstimateSource, EstimateSundryMethod } from './estimate.model';
+import { EstimateCostCategory } from './estimate.types';
+export type CostCategorySummary = Record<EstimateCostCategory, string>;
+export interface CostCategorySummaryTotals {
+    net: string;
+    vat: string;
+    gross: string;
+    hours: string;
+    labourRate: string;
+}
+export type EstimateSummaryDto = CostCategorySummary & CostCategorySummaryTotals;
+export interface EstimateDto {
+    id: string;
+    source: EstimateSource;
+    label: string;
+    comment: string;
+    timestamp: string;
+    version: number;
+    net: string;
+    vat: string;
+    gross: string;
+    labourRate: string;
+    vatRate: string;
+    sundryRate: string;
+    sundryMax: string;
+    sundryFixed: string;
+    sundryMethod: EstimateSundryMethod;
+    partsDiscount: string;
+    paintDiscount: string;
+    timeBasis: string;
+    adjusted: boolean;
+    items: Array<EstimateItemDto>;
+    summary: EstimateSummaryDto;
+    summaryAdjusted: EstimateSummaryDto | null;
+}

package/lib/model/estimate-control/estimate.model.d.ts

@@ -0,0 +1,54 @@
+import { EstimateItemModel } from './estimate-item.model';
+import { EstimateDto, EstimateSummaryDto } from './estimate.dto';
+import { EstimateItemDto } from './estimate-item.dto';
+export declare type EstimateSundryMethod = 'percentage' | 'percentage-with-max' | 'fixed';
+export declare type EstimateSource = 'audatex' | 'glassmatix' | 'manual' | 'ibody';
+export declare class EstimateModel {
+    id: string;
+    source: EstimateSource;
+    label: string;
+    comment: string;
+    timestamp: string;
+    version: number;
+    net: string;
+    vat: string;
+    gross: string;
+    labourRate: string;
+    vatRate: string;
+    sundryRate: string;
+    sundryMax: string;
+    sundryFixed: string;
+    sundryMethod: EstimateSundryMethod;
+    partsDiscount: string;
+    paintDiscount: string;
+    timeBasis: string;
+    adjusted: boolean;
+    items: Array<EstimateItemModel>;
+    summaryNet: EstimateSummaryDto;
+    summary: EstimateSummaryDto;
+    summaryAdjusted: EstimateSummaryDto;
+    static create(source?: EstimateSource): EstimateModel;
+    static fromDto(dto: Partial<EstimateDto>): EstimateModel;
+    addItem(modelOrDto: EstimateItemModel | Partial<EstimateItemDto>, opts?: {
+        calculate?: boolean;
+    }): void;
+    addItems(items: Array<EstimateItemModel>, opts?: {
+        calculate?: boolean;
+    }): void;
+    calculate(): void;
+    /**
+     * 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?: boolean): EstimateSummaryDto;
+    /**
+     * Applies the sundry and discount values to the net summary.
+  
+     */
+    getSummary(summaryNet: EstimateDto['summary'], sundryRate: string, sundryMax: string, sundryFixed: string, sundryMethod: EstimateSundryMethod, partsDiscount: string, paintDiscount: string, adjusted: boolean): EstimateDto['summary'];
+    toDto(): EstimateDto;
+    getTotalHours(adjusted?: boolean): string;
+}

package/lib/model/estimate-control/estimate.types.d.ts

@@ -0,0 +1,2 @@
+export declare type EstimateWorkCategory = 'none' | 'blend' | 'check' | 'new' | 'paint' | 'rr' | 'removed' | 'repair' | 'specialist';
+export declare type EstimateCostCategory = 'labour' | 'none' | 'pm' | 'pl' | 'parts' | 'other' | 'specialist';

package/lib/model/estimate-control/index.d.ts

@@ -0,0 +1,7 @@
+export * from './estimate.dto';
+export * from './estimate.model';
+export * from './estimate.types';
+export * from './estimate-control-value.dto';
+export * from './estimate-control-value.model';
+export * from './estimate-item.dto';
+export * from './estimate-item.model';

package/lib/model/index.d.ts

@@ -1,3 +1,5 @@
+export * from './estimate-control';
 export * from './firebase-document-meta.interface';
 export * from './geo-location';
+export * from './report-invocation';
 export * from './vas-time-range.model';

package/lib/model/report-invocation.d.ts

@@ -0,0 +1,39 @@
+import { FieldValueType } from '../entity';
+export interface ReportInvocationFile {
+    id: string;
+    name: string;
+    sequence: number;
+    fileSize: number;
+    mimeType: string;
+    url: string;
+    embedLink: boolean;
+    rotation: number;
+    description: string;
+    displayAs: string;
+    displayedName: string;
+    group: string;
+    index: number;
+}
+export interface ReportInvocation {
+    id: string;
+    reportLayout: string;
+    data: {
+        id: string;
+        account: string;
+        reference: string;
+        jobDate: string;
+        assigneeId: string;
+        assigneeName: string;
+        jobStatus: string;
+        jobType: string;
+        /** @deprecated */
+        timeZoneOffset?: number;
+        files: {
+            photo: Array<ReportInvocationFile>;
+            documents: Array<ReportInvocationFile>;
+            other: Array<ReportInvocationFile>;
+            pdf: Array<ReportInvocationFile>;
+        };
+        fields: Record<string, FieldValueType>;
+    };
+}

package/lib/utils/get-value-by-path.d.ts

@@ -1,18 +1,8 @@
 /**
- * A non sophisticated way to get values from the job via paths. For example:
+ * Get a value from an object by path.
  *
- * getValueByPath(
- *  ['foo', 'bar'],
- *  {
- *   foo: {
- *     bar: 'value'
- *   }
- *  }
- * );
- *
- * 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
  */
-export declare const getValueByPath: <T>(path: string[], object: Record<string, any>) => T | undefined;
+export declare function getValueByPath<T>(path: string | number | Array<string | number>, object: null | Record<string, any>): T | undefined;

package/lib/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from './get-value-by-path';
+export * from './is-array-string';
+export * from './is-numeric';
+export * from './is-plain-object';
+export * from './omit';
+export * from './only';
+export * from './try-json';

package/lib/utils/is-array-string.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Return true IFF the array contains only strings
+ */
+export declare const isArrayString: (value: any) => value is Array<string>;

package/lib/utils/is-numeric.d.ts

@@ -0,0 +1 @@
+export declare function isNumeric(value: string | number): value is number;

package/lib/utils/is-plain-object.d.ts

@@ -1 +1,4 @@
+/**
+ * Return true if the argument is a plain object {}, i.e. not an array, null.
+ */
 export declare function isPlainObject<T>(value: any): value is T;

package/lib/utils/omit.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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
+ */
+export declare const omit: <T extends Record<string, any>>(obj: T, omitKey: string | Array<string>) => Partial<T>;

package/lib/utils/try-json.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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.
  */
 export declare const tryJson: <T>(value: T) => Record<string, any> | T;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@ironcode/vas-lib",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.3",
   "peerDependencies": {
     "angular2-uuid": "^1.1.1",
-    "moment": "^2.0.0"
+    "moment": "^2.0.0",
+    "uuid": "^9.0.1"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -3,3 +3,4 @@ export * from './lib/controls-config/index';
 export * from './lib/elastic/index';
 export * from './lib/entity/index';
 export * from './lib/model/index';
+export * from './lib/utils';