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

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

@@ -1,7 +1,11 @@
-export interface VasCameraControlValueModel {
+import { VasFileDto } from '../entity';
+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-base.model.d.ts

@@ -18,7 +18,7 @@ export declare class VasBaseModel implements VasBaseDto {
     modifiedByName: string;
     constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string);
     static fromDto(dto: Partial<VasBaseDto>): VasBaseModel;
-    static create<T extends VasBaseDto>(this: VasModelStatic<T>, user: {
+    static create<T extends VasBaseModel>(this: VasModelStatic<T>, user: {
         id: string;
         name: string;
     }, values?: Partial<T>): T;

package/lib/entity/vas-control.model.d.ts

@@ -1,7 +1,7 @@
 import { VasControlTypeModel } from './vas-control-type.model';
 import { VasControlDto } from './vas-control.dto';
 import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { FieldValueType } from './vas-field.dto';
 export declare type VasControlModelDefaultValueType = string | number | object;
 /**
  * ControlModel
@@ -39,7 +39,7 @@ export declare class VasControlModel extends VasRestrictedAccountObjectModel {
      * in the case of string, it maybe a json. This getter will return an
      * object if the value is a json string
      */
-    get defaultValueDecoded(): VasFieldDtoValue;
+    get defaultValueDecoded(): FieldValueType;
     /**
      * Returns the name of this control to be used in the report templates
      * i.e. fields.foo -> foo
@@ -61,9 +61,9 @@ export declare class VasControlModel extends VasRestrictedAccountObjectModel {
     static fromDto(dto: Partial<VasControlDto>): VasControlModel;
     /**
      * @param {any} value the value to be parsed
-     * @return {VasFieldDtoValue} the parsed value
+     * @return {FieldValueType} the parsed value
      */
-    protected parseMaybeJson(value: any): VasFieldDtoValue;
+    protected parseMaybeJson(value: any): FieldValueType;
     /**
      * @return {VasControlDto}
      */

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

@@ -1,17 +1,14 @@
 import { VasJobDataDto } from './vas-job-data.dto';
 import { VasFileDto } from './vas-file.dto';
-import { GeoLocation } from '../model/geo-location';
-import { VasFunctionControlValueDto } from '../control-value';
-import { VasCameraControlValueModel } from '../control-value';
-declare type FieldValueType = string | number | boolean | null | GeoLocation | Array<object | string | number | boolean | VasFileDto> | Record<string, any> | VasCameraControlValueModel | VasFunctionControlValueDto;
-export declare type VasFieldDtoValue = FieldValueType | Record<string, FieldValueType>;
+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>;
-    value: VasFieldDtoValue;
+    value: FieldValueType;
     version: number;
     controlName: string;
     controlTitle: string;
     controlTypeName: string;
 }
-export {};

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

@@ -1,4 +1,4 @@
-import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { VasFieldDto, FieldValueType } from './vas-field.dto';
 import { VasJobDataModel } from './vas-job-data.model';
 /**
  * Prepares the value to be sent to the API. The api will only accept strings,
@@ -8,7 +8,7 @@ import { VasJobDataModel } from './vas-job-data.model';
  * @return {string | number | boolean}
  * @protected
  */
-export declare const prepareFieldApiValue: (value: VasFieldDtoValue) => string | number | boolean;
+export declare const prepareFieldApiValue: (value: FieldValueType) => string | number | boolean;
 /**
  * VasFieldModel
  */
@@ -26,12 +26,12 @@ export declare class VasFieldModel extends VasJobDataModel {
     job: string;
     control: string;
     fieldJobPointers: Array<string>;
-    value: VasFieldDtoValue;
+    value: FieldValueType;
     version: number;
     controlName: string;
     controlTitle: string;
     controlTypeName: string;
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: string, control: string, fieldJobPointers: Array<string>, value: VasFieldDtoValue, version: number, controlName: string, controlTitle: string, controlTypeName: string);
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: string, control: string, fieldJobPointers: Array<string>, value: FieldValueType, version: number, controlName: string, controlTitle: string, controlTypeName: string);
     /**
      * @param {VasFieldDto} fieldDto
      * @return {VasFieldModel}

package/lib/entity/vas-form.model.d.ts

@@ -1,11 +1,11 @@
 import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
 import { VasControlTypeDto } from './vas-control-type.dto';
 import { VasControlModel } from './vas-control.model';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { FieldValueType } from './vas-field.dto';
 import { VasFormDto } from './vas-form.dto';
 import { VasGroupModel } from './vas-group.model';
-import { VasJobModel } from './vas-job.model';
 import { VasFormConfigModel } from './vas-form-config.model';
+import { VasJobModel } from './vas-job.model';
 /**
  * VasFormModel
  */
@@ -78,11 +78,11 @@ export declare class VasFormModel extends VasRestrictedAccountObjectModel {
     getControls(): Array<VasControlModel>;
     /**
      * @param {VasJobModel} jobModel
-     * @return {Array<{id: string, value: VasFieldDtoValue}>}
+     * @return {Array<{id: string, value: FieldValueType}>}
      */
     getValuesByControlId(jobModel: VasJobModel): Array<{
         id: string;
-        value: VasFieldDtoValue | undefined;
+        value: FieldValueType | undefined;
     }>;
     /**
      * @return {VasFormDto}

package/lib/entity/vas-group.model.d.ts

@@ -1,6 +1,6 @@
 import { VasControlModel } from './vas-control.model';
 import { VasGroupDto } from './vas-group.dto';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { FieldValueType } from './vas-field.dto';
 import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
 /**
  * GroupModel
@@ -39,7 +39,7 @@ export declare class VasGroupModel extends VasRestrictedAccountObjectModel {
      */
     isVisible(valuesByControlId: Array<{
         id: string;
-        value: VasFieldDtoValue | undefined;
+        value: FieldValueType | undefined;
     }>): boolean;
     /**
      * @return {VasGroupDto}

package/lib/entity/vas-job-copy.d.ts

@@ -1,24 +1,24 @@
-import { VasJobDto } from './vas-job.dto';
+import { VasJobBaseDto } from './vas-job.dto';
 export interface VasJobCopyDto {
-    accessGroup: VasJobDto['accessGroup'];
-    jobType: VasJobDto['jobType'];
-    jobStatus: VasJobDto['jobStatus'];
-    jobDate: VasJobDto['jobDate'];
-    assigneeId: VasJobDto['assigneeId'];
+    accessGroup: VasJobBaseDto['accessGroup'];
+    jobType: VasJobBaseDto['jobType'];
+    jobStatus: VasJobBaseDto['jobStatus'];
+    jobDate: VasJobBaseDto['jobDate'];
+    assigneeId: VasJobBaseDto['assigneeId'];
     fields: Array<string>;
     files: Array<string>;
     reports: Array<string>;
 }
 export declare class VasJobCopyModel {
-    accessGroup: VasJobDto['accessGroup'];
-    jobType: VasJobDto['jobType'];
-    jobStatus: VasJobDto['jobStatus'];
-    jobDate: VasJobDto['jobDate'];
-    assigneeId: VasJobDto['assigneeId'];
+    accessGroup: VasJobBaseDto['accessGroup'];
+    jobType: VasJobBaseDto['jobType'];
+    jobStatus: VasJobBaseDto['jobStatus'];
+    jobDate: VasJobBaseDto['jobDate'];
+    assigneeId: VasJobBaseDto['assigneeId'];
     fields: Array<string>;
     files: Array<string>;
     reports: Array<string>;
-    constructor(accessGroup: VasJobDto['accessGroup'], jobType: VasJobDto['jobType'], jobStatus: VasJobDto['jobStatus'], jobDate: VasJobDto['jobDate'], assigneeId: VasJobDto['assigneeId'], fields: Array<string>, files: Array<string>, reports: Array<string>);
+    constructor(accessGroup: VasJobBaseDto['accessGroup'], jobType: VasJobBaseDto['jobType'], jobStatus: VasJobBaseDto['jobStatus'], jobDate: VasJobBaseDto['jobDate'], assigneeId: VasJobBaseDto['assigneeId'], fields: Array<string>, files: Array<string>, reports: Array<string>);
     static fromDto(dto: Partial<VasJobCopyDto>): VasJobCopyModel;
     toDto(): VasJobCopyDto;
     toApiDto(): Record<string, unknown>;

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

@@ -1,16 +1,17 @@
 import { VasFileDto } from './vas-file.dto';
 import { VasRestrictedAccountObjectDto } from './vas-restricted-account-object.dto';
-import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { FieldValueType, VasFieldDto } from './vas-field.dto';
 import { GeoLocation } from '../model';
 import { VasReportDto } from './vas-report.dto';
 import { VasTaskDto } from './vas-task.dto';
 import { VasNoteDto } from './vas-note.dto';
 import { VasJobEmailDto } from './vas-job-email.dto';
 import { VasInstructionDto } from './vas-instruction.dto';
-export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
+export interface VasJobBaseDto extends VasRestrictedAccountObjectDto {
     reference: string;
     jobDate: string;
     jobStatus: string;
+    jobStatusLastUpdate: string;
     jobType: string;
     assigneeId: string;
     formId: string;
@@ -18,15 +19,20 @@ export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
     pendingFields: number;
     childModified: string;
     version: number;
-    createdByDisplayName: string;
-    modifiedByDisplayName: string;
+    followUpDate: string;
+    followUpStatus: string;
+    followUpNote: string;
     geoLocation: GeoLocation;
     files: Array<VasFileDto>;
-    fields: Array<VasFieldDto>;
     jobEmails: Array<VasJobEmailDto>;
     notes: Array<VasNoteDto>;
     reports: Array<VasReportDto>;
     tasks: Array<VasTaskDto>;
     instruction: null | VasInstructionDto;
 }
-export declare type VasJobDto = VasJobStaticDto & Record<string, VasFieldDtoValue>;
+export interface VasJobRelationalDto extends VasJobBaseDto {
+    fields: Array<VasFieldDto>;
+}
+export interface VasJobDocumentDto extends VasJobBaseDto {
+    fields: Record<string, FieldValueType>;
+}

package/lib/entity/vas-job.model.d.ts

@@ -1,27 +1,24 @@
 import { VasFileDto } from './vas-file.dto';
 import { VasBaseDto } from './vas-base.dto';
-import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { FieldValueType } from './vas-field.dto';
 import { VasFormModel } from './vas-form.model';
-import { VasJobDto } from './vas-job.dto';
+import { VasJobBaseDto, VasJobDocumentDto, VasJobRelationalDto } from './vas-job.dto';
 import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
 import { GeoLocation } from '../model';
-import { VasFormDto } from './vas-form.dto';
 import { VasReportDto } from './vas-report.dto';
 import { VasTaskDto } from './vas-task.dto';
 import { VasNoteDto } from './vas-note.dto';
 import { VasJobEmailDto } from './vas-job-email.dto';
 import { VasInstructionDto } from './vas-instruction.dto';
-export declare interface VasJobModelDynamicInterface {
-    [s: string]: string | number | Record<string, VasFieldDtoValue>;
-}
+import { VasFieldModel } from './vas-field.model';
 export interface ParseSyntaxOptions {
     timeZoneOffset: number;
-    objects?: Record<string, Partial<VasBaseDto> | Record<string, VasFieldDtoValue>>;
+    objects?: Record<string, Partial<VasBaseDto> | Record<string, FieldValueType>>;
 }
 /**
- * JobModel
+ * VasJobBaseModel
  */
-export declare class VasJobModel extends VasRestrictedAccountObjectModel {
+export declare abstract class VasJobBaseModel<FType extends Record<string, FieldValueType> | Array<VasFieldModel>> extends VasRestrictedAccountObjectModel {
     id: string;
     created: string;
     serverCreated: string;
@@ -36,6 +33,7 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     reference: string;
     jobDate: string;
     jobStatus: string;
+    jobStatusLastUpdate: string;
     jobType: string;
     assigneeId: string;
     formId: string;
@@ -43,58 +41,24 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     pendingFields: number;
     childModified: string;
     version: number;
-    createdByDisplayName: string;
-    modifiedByDisplayName: string;
+    followUpDate: string;
+    followUpStatus: string;
+    followUpNote: string;
     geoLocation: GeoLocation;
     files: Array<VasFileDto>;
-    fields: Array<VasFieldDto>;
+    fields: FType;
     jobEmails: Array<VasJobEmailDto>;
     notes: Array<VasNoteDto>;
     reports: Array<VasReportDto>;
     tasks: Array<VasTaskDto>;
     instruction: VasInstructionDto | null;
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobType: string, assigneeId: string, formId: string, timeZoneOffset: number, pendingFields: number, childModified: string, version: number, createdByDisplayName: string, modifiedByDisplayName: string, geoLocation: GeoLocation, files: Array<VasFileDto>, fields: Array<VasFieldDto>, jobEmails: Array<VasJobEmailDto>, notes: Array<VasNoteDto>, reports: Array<VasReportDto>, tasks: Array<VasTaskDto>, instruction: VasInstructionDto | null);
-    /**
-     * Returns this with the dynamic interface
-     * @return {VasJobModelDynamicInterface}
-     */
-    get $this(): VasJobModelDynamicInterface;
-    /**
-     * Returns a list of Job dynamic properties i.e. those that are added by the
-     * dynamic forms
-     */
-    get dynamicProperties(): Array<string>;
-    /**
-     * Returns the list of properties of the Job type
-     */
-    get staticProperties(): Array<string>;
-    /**
-     * @return {VasJobModel}
-     */
-    static empty(): VasJobModel;
-    static fromDto(dto: Partial<VasJobDto>): VasJobModel;
-    /**
-     * This method will instantiate a new JobModel. The difference with this
-     * method of instantiation is that we are coming from a relation frame i.e.
-     * the job has a list of {@link VasFieldDto} instead of a Job document.
-     *
-     */
-    static fromRelational(dto: Partial<VasJobDto>, form: VasFormDto): VasJobModel;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobStatusLastUpdate: string, jobType: string, assigneeId: string, formId: string, timeZoneOffset: number, pendingFields: number, childModified: string, version: number, followUpDate: string, followUpStatus: string, followUpNote: string, geoLocation: GeoLocation, files: Array<VasFileDto>, fields: FType, jobEmails: Array<VasJobEmailDto>, notes: Array<VasNoteDto>, reports: Array<VasReportDto>, tasks: Array<VasTaskDto>, instruction: VasInstructionDto | null);
+    get createdByDisplayName(): string;
+    get modifiedByDisplayName(): string;
     /**
-     * @param {VasFormModel} formModel
-     * @return {Record<string, VasFieldDtoValue>}
+     * Return the list of Job properties
      */
-    getFields(formModel: VasFormModel): Record<string, VasFieldDtoValue>;
-    /**
-     * Will return an object whose keys are the names of all fields in the job.
-     * This method is similar to `getFields` except that this method will only
-     * return values where a value was set, as opposed to `getFields` which will
-     * return a value for every control even if no value was set, because it uses
-     * the form to drive the logic. Note also this method will return values for
-     * any Fields in the fields array.
-     * @return {Record<string, VasFieldDtoValue>}
-     */
-    getFields2(): Record<string, VasFieldDtoValue>;
+    get staticProperties(): Set<string>;
     /**
      * Returns an object describing how many attachments were added to this job
      * (camera controls and files), and how many have not been uploaded yet.
@@ -107,97 +71,9 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
         total: number;
     };
     /**
-     * This method will return the dynamic property from the JobModel that
-     * represent a group (from a form).
-     *
-     * @param name the name of the group
-     * @param init if true (default) and group is not found, initialise an empty
-     * group, otherwise throw an error
-     */
-    getGroup(name: string, init?: boolean): Record<string, VasFieldDtoValue>;
-    /**
-     * @param path path segments
-     */
-    getValueByPath<T extends VasFieldDtoValue>(path?: string[]): T | undefined;
-    /**
-     * In order to understand why we need this method it is important to
-     * understand that within the system, Jobs can be represented in one of two
-     * ways, document and relational.
-     *
-     * The important distinction is how values submitted by a form are stored.
-     *
-     * Jobs stored as documents (JSON objects) will store user values, as dynamic
-     * properties of the document.
-     *
-     * Whereas, Jobs stored as relational, will store user values in an array of
-     * {@link VasFieldDto} objects.
-     *
-     * Depending on where we are in the system, either one of these approaches can
-     * be more useful than the other.
-     *
-     * This method, assumes that the JobModel has been instantiated from a
-     * document representation, and serves to hydrate the fields array. In order
-     * to achieve this, knowledge of the {@link VasFormDto} that created the job
-     * is required.
-     *
-     *
-     * Job in document representation
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   foo: {
-     *     bar: "value"
-     *   }
-     * }
-     *
-     * Job in relational representation
-     * {
-     *   id: <guid>,
-     *   reference: "something"
-     *   <other static job properties>...
-     *   <will not have dynamic properties>...
-     *   fields: [
-     *     {
-     *       id: <guid>,
-     *       <other field properties>,
-     *       value: "value"
-     *     }
-     *   ]
-     * }
-     *
-     *
-     * @param formModel the VasFormModel that was used to create the job
-     * @param controlFieldIdMap This is used to determine the id each field.
-     * Either one will be found in the map, or a new one is generated.
-     * @param controlNames if a value is provided, it will be used
-     * to filter the fields that are returned.
-     * @return {Array<VasFieldDto>}
-     */
-    hydrateFields(formModel: VasFormModel, controlFieldIdMap?: Map<string, string>, controlNames?: Array<string>): void;
-    /**
-     * A very non sophisticated way to set values in the job via paths
-     *
-     * For example:
-     *
-     * setValueByPath('value', ['foo', 'bar']);
-     *
-     * will make results in job
-     * {
-     *   foo: {
-     *     bar: 'value'
-     *   }
-     * }
-     *
-     * @param value the value to set
      * @param path path segments
      */
-    setValueByPath(value: VasFieldDtoValue, path?: string[]): void;
-    /**
-     * @param staticOnly if true, will only output values for the static
-     * properties in the dto
-     */
-    toDto(staticOnly?: boolean): VasJobDto;
+    getValueByPath<T>(path?: string | string[]): T | null | undefined;
     /**
      * 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:
@@ -229,5 +105,21 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
      * @return {object}
      */
     toApiDto(): Record<string, string | number | boolean>;
-    static toApiPatchDto(item: Partial<VasJobDto>): Partial<VasJobDto>;
+    static toApiPatchDto(item: Partial<VasJobBaseDto>): Partial<VasJobBaseDto>;
+}
+export declare class VasJobRelationalModel extends VasJobBaseModel<Array<VasFieldModel>> {
+    getValueByPath<T>(path?: string | string[]): T | null | undefined;
+    getFieldsMap(): Record<string, FieldValueType>;
+    getFieldValueByPath<T extends FieldValueType>(controlName: string, path: string[]): T | null | undefined;
+    static fromDto(dto: Partial<VasJobRelationalDto>): VasJobRelationalModel;
+    static empty(): VasJobRelationalModel;
+    toDto(): VasJobRelationalDto;
+}
+export declare class VasJobDocumentModel extends VasJobBaseModel<Record<string, FieldValueType>> {
+    static fromRelationalDto(dto: Partial<VasJobRelationalDto>): VasJobDocumentModel;
+    static fromDto(dto: Partial<VasJobDocumentDto>): VasJobDocumentModel;
+    static empty(): VasJobDocumentModel;
+    toDto(): VasJobDocumentDto;
 }
+/** @deprecated use either VasJobDocumentModel or VasJobRelationalModel **/
+export type VasJobModel = VasJobDocumentModel | VasJobRelationalModel;

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 = 'fixed' | 'percentage' | 'percentage-with-max';
+export declare type EstimateSource = 'audatex' | 'glassmatix' | 'gtmotive' | 'ibody' | 'manual';
+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;
+    get timeBasisSafe(): string;
+    static create(source?: EstimateSource): EstimateModel;
+    static fromDto<T extends EstimateModel>(this: new () => T, dto: Partial<EstimateDto>): T;
+    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/firebase-document-meta.interface.d.ts

@@ -0,0 +1,5 @@
+export interface FirebaseDocumentMetaInterface {
+    _meta: {
+        source: 'client' | 'server';
+    };
+}

package/lib/model/index.d.ts

@@ -1,2 +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';