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

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

@@ -1,22 +1,18 @@
 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 { 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>;
-}
 export interface ParseSyntaxOptions {
     timeZoneOffset: number;
-    objects?: Record<string, Partial<VasBaseDto> | Record<string, VasFieldDtoValue>>;
+    objects?: Record<string, Partial<VasBaseDto> | Record<string, FieldValueType>>;
 }
 /**
  * JobModel
@@ -43,58 +39,26 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     pendingFields: number;
     childModified: string;
     version: number;
-    createdByDisplayName: string;
-    modifiedByDisplayName: string;
     geoLocation: GeoLocation;
     files: Array<VasFileDto>;
-    fields: Array<VasFieldDto>;
+    fields: Record<string, FieldValueType>;
     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;
+    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, geoLocation: GeoLocation, files: Array<VasFileDto>, fields: Record<string, FieldValueType>, jobEmails: Array<VasJobEmailDto>, notes: Array<VasNoteDto>, reports: Array<VasReportDto>, tasks: Array<VasTaskDto>, instruction: VasInstructionDto | null);
+    get createdByDisplayName(): string;
+    get modifiedByDisplayName(): string;
     /**
-     * Returns a list of Job dynamic properties i.e. those that are added by the
-     * dynamic forms
+     * Return the list of Job properties
      */
-    get dynamicProperties(): Array<string>;
-    /**
-     * Returns the list of properties of the Job type
-     */
-    get staticProperties(): Array<string>;
+    get staticProperties(): Set<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;
-    /**
-     * @param {VasFormModel} formModel
-     * @return {Record<string, VasFieldDtoValue>}
-     */
-    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>;
     /**
      * 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,10 @@ 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 | undefined;
+    toDto(): VasJobDto;
     /**
      * 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:

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

@@ -1 +1 @@
-{"version":3,"file":"vas-job.model.d.ts","sourceRoot":"","sources":["../../../../../projects/vas-lib/src/lib/entity/vas-job.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAIvD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,WAAW,EAAuB,MAAM,UAAU,CAAC;AAG5D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,MAAM,CAAC,OAAO,WAAW,2BAA2B;IAClD,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,kBAAkB;IAKjC,cAAc,EAAE,MAAM,CAAC;IAMvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,+BAA+B;IAG5C,EAAE,EAAE,MAAM;IACV,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,MAAM;IACrB,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,cAAc,EAAE,MAAM;IACtB,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,MAAM;IACrB,cAAc,EAAE,MAAM;IACtB,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,MAAM;IAC5B,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,MAAM;IAClB,MAAM,EAAE,MAAM;IACd,cAAc,EAAE,MAAM;IACtB,aAAa,EAAE,MAAM;IACrB,aAAa,EAAE,MAAM;IACrB,OAAO,EAAE,MAAM;IACf,oBAAoB,EAAE,MAAM;IAC5B,qBAAqB,EAAE,MAAM;IAC7B,WAAW,EAAE,WAAW;IACxB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC;IAC1B,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,WAAW,EAAE,iBAAiB,GAAG,IAAI;gBA9B5B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAC5B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,oBAAoB,EAAE,MAAM,EAC5B,qBAAqB,EAAE,MAAM,EAC7B,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,EAC1B,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,EAChC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,EAC5B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,WAAW,EAAE,iBAAiB,GAAG,IAAI;IAiB9C;;;OAGG;IACH,IAAI,KAAK,IAAI,2BAA2B,CAEvC;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,KAAK,CAAC,MAAM,CAAC,CAKrC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,KAAK,CAAC,MAAM,CAAC,CAEpC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,WAAW;WAoCX,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,WAAW;IA4C7D;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CACnB,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,EACvB,IAAI,EAAE,UAAU,GACf,WAAW;IAiDd;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAYpE;;;;;;;;OAQG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAe9C;;;;;;OAMG;IACH,oBAAoB,CAClB,SAAS,EAAE,YAAY,GACtB;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE;IA6CrC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,UAAO,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAmBrE;;OAEG;IACH,cAAc,CAAC,CAAC,SAAS,gBAAgB,EACvC,IAAI,GAAE,MAAM,EAAO,GAClB,CAAC,GAAG,SAAS;IAIhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,aAAa,CACX,SAAS,EAAE,YAAY,EACvB,iBAAiB,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAA6B,EAClE,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAC3B,IAAI;IAkCP;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,GAAE,MAAM,EAAO,GAAG,IAAI;IAyBlE;;;OAGG;IACI,KAAK,CAAC,UAAU,UAAQ,GAAG,SAAS;IA6C3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,kBAER,GACA,MAAM;IA4ET;;OAEG;IACM,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;WAehD,aAAa,CACzB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GACvB,OAAO,CAAC,SAAS,CAAC;CAkBtB"}
+{"version":3,"file":"vas-job.model.d.ts","sourceRoot":"","sources":["../../../../../projects/vas-lib/src/lib/entity/vas-job.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAGvD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAe,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,WAAW,EAAuB,MAAM,UAAU,CAAC;AAG5D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAI1D,MAAM,WAAW,kBAAkB;IAKjC,cAAc,EAAE,MAAM,CAAC;IAMvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;CAChF;AAWD;;GAEG;AACH,qBAAa,WAAY,SAAQ,+BAA+B;IAG5C,EAAE,EAAE,MAAM;IACV,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,MAAM;IACrB,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,cAAc,EAAE,MAAM;IACtB,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,MAAM;IACrB,cAAc,EAAE,MAAM;IACtB,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,MAAM;IAC5B,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,MAAM;IAClB,MAAM,EAAE,MAAM;IACd,cAAc,EAAE,MAAM;IACtB,aAAa,EAAE,MAAM;IACrB,aAAa,EAAE,MAAM;IACrB,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,WAAW;IACxB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC;IACtC,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IACxB,WAAW,EAAE,iBAAiB,GAAG,IAAI;gBA5B5B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAC5B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,EACtC,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,EAChC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,EAC5B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,WAAW,EAAE,iBAAiB,GAAG,IAAI;IAiB9C,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED,IAAI,qBAAqB,IAAI,MAAM,CAElC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,GAAG,CAAC,MAAM,CAAC,CAKlC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,WAAW;WAkCX,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,WAAW;IAwE7D;;;;;;OAMG;IACH,oBAAoB,CAClB,SAAS,EAAE,YAAY,GACtB;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE;IAgCrC;;OAEG;IACH,cAAc,CAAC,CAAC,EACd,IAAI,GAAE,MAAM,GAAG,MAAM,EAAO,GAC3B,CAAC,GAAG,SAAS;IAOT,KAAK,IAAI,SAAS;IAkCzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,kBAER,GACA,MAAM;IA4DT;;OAEG;IACM,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;WAehD,aAAa,CACzB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GACvB,OAAO,CAAC,SAAS,CAAC;CAkBtB"}