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

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-form.model.d.ts

@@ -4,8 +4,8 @@ import { VasControlModel } from './vas-control.model';
 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
  */

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 { FieldValueType } 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 VasJobDto extends VasRestrictedAccountObjectDto {
+export interface VasJobBaseDto extends VasRestrictedAccountObjectDto {
     reference: string;
     jobDate: string;
     jobStatus: string;
+    jobStatusLastUpdate: string;
     jobType: string;
     assigneeId: string;
     formId: string;
@@ -20,10 +21,15 @@ export interface VasJobDto extends VasRestrictedAccountObjectDto {
     version: number;
     geoLocation: GeoLocation;
     files: Array<VasFileDto>;
-    fields: Record<string, FieldValueType>;
     jobEmails: Array<VasJobEmailDto>;
     notes: Array<VasNoteDto>;
     reports: Array<VasReportDto>;
     tasks: Array<VasTaskDto>;
     instruction: null | VasInstructionDto;
 }
+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

@@ -2,7 +2,7 @@ import { VasFileDto } from './vas-file.dto';
 import { VasBaseDto } from './vas-base.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 { VasReportDto } from './vas-report.dto';
@@ -10,14 +10,15 @@ 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';
+import { VasFieldModel } from './vas-field.model';
 export interface ParseSyntaxOptions {
     timeZoneOffset: number;
     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;
@@ -32,6 +33,7 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     reference: string;
     jobDate: string;
     jobStatus: string;
+    jobStatusLastUpdate: string;
     jobType: string;
     assigneeId: string;
     formId: string;
@@ -41,24 +43,19 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     version: number;
     geoLocation: GeoLocation;
     files: Array<VasFileDto>;
-    fields: Record<string, FieldValueType>;
+    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, geoLocation: GeoLocation, files: Array<VasFileDto>, 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, jobStatusLastUpdate: string, jobType: string, assigneeId: string, formId: string, timeZoneOffset: number, pendingFields: number, childModified: string, version: number, 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;
     /**
      * Return the list of Job properties
      */
     get staticProperties(): Set<string>;
-    /**
-     * @return {VasJobModel}
-     */
-    static empty(): VasJobModel;
-    static fromDto(dto: Partial<VasJobDto>): VasJobModel;
     /**
      * Returns an object describing how many attachments were added to this job
      * (camera controls and files), and how many have not been uploaded yet.
@@ -73,8 +70,7 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     /**
      * @param path path segments
      */
-    getValueByPath<T>(path?: string | string[]): T | undefined;
-    toDto(): 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:
@@ -106,5 +102,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/utils/get-value-by-path.d.ts

@@ -5,4 +5,4 @@
  * 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 function getValueByPath<T>(path: string | number | Array<string | number>, object: null | Record<string, any>): T | undefined;
+export declare function getValueByPath<T>(path: string | number | Array<string | number>, object: null | Record<string, any>): T | null | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ironcode/vas-lib",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.5",
   "peerDependencies": {
     "angular2-uuid": "^1.1.1",
     "moment": "^2.0.0",