@ironcode/vas-lib 1.8.0-alpha.7 → 1.8.0

package/lib/entity/index.d.ts

@@ -40,6 +40,7 @@ export * from './vas-job-email.dto';
 export * from './vas-job-email.model';
 export * from './vas-job.dto';
 export * from './vas-job.model';
+export * from './vas-job-action.dto';
 export * from './vas-job-status.dto';
 export * from './vas-job-type.dto';
 export * from './vas-lookup.dto';

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

@@ -1,5 +1,5 @@
 import { VasBaseDto } from './vas-base.dto';
-interface VasModelStatic<T extends VasBaseModel> {
+export interface VasModelStatic<T extends VasBaseModel> {
     new (...args: any[]): T;
     fromDto(dto: Partial<VasBaseDto>): T;
 }
@@ -23,4 +23,3 @@ export declare class VasBaseModel implements VasBaseDto {
         name: string;
     }, values?: Partial<T>): T;
 }
-export {};

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 { VasFieldDtoValue } from './vas-field.dto';
 export declare type VasControlModelDefaultValueType = string | number | object;
 /**
  * ControlModel
@@ -68,4 +68,5 @@ export declare class VasControlModel extends VasRestrictedAccountObjectModel {
      */
     toDto(): VasControlDto;
     toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasControlDto>): Partial<VasControlDto>;
 }

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

@@ -1,5 +1,14 @@
 import { VasFieldDto, VasFieldDtoValue } 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,
+ * numbers and booleans, thus if we have an array or object, we need to JSON
+ * encode it
+ * @param {VasFieldDto} value
+ * @return {string | number | boolean}
+ * @protected
+ */
+export declare const prepareFieldApiValue: (value: VasFieldDtoValue) => string | number | boolean;
 /**
  * VasFieldModel
  */
@@ -36,13 +45,5 @@ export declare class VasFieldModel extends VasJobDataModel {
      * @return {object}
      */
     toApiDto(): Record<string, string | number | boolean>;
-    /**
-     * Prepares the value to be sent to the API. The api will only accept strings,
-     * numbers and booleans, thus if we have an array or object, we need to JSON
-     * encode it
-     * @param {VasFieldDto} value
-     * @return {string | number | boolean}
-     * @protected
-     */
-    protected prepareApiValue(value: VasFieldDtoValue): string | number | boolean;
+    static toApiPatchDto(item: Partial<VasFieldDto>): Partial<VasFieldDto>;
 }

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

@@ -39,4 +39,5 @@ export declare class VasFileModel extends VasJobDataModel {
     stringifyConfig(config: VasFileDtoConfigDto): string;
     toApiDto(options?: VasFileModelToApiDtoOptions): Record<string, string | number | boolean>;
     protected safeNumber(value: number): number;
+    static toApiPatchDto(item: Partial<VasFileDto>): Partial<VasFileDto>;
 }

package/lib/entity/vas-form-config.dto.d.ts

@@ -1,25 +1,4 @@
-/**
- * Describes an action that can be performed on jobs created by this form
- */
-export interface VasFormActionDto {
-    title: string;
-    instruction?: {
-        instructionProviderId: string;
-        linkControl: string;
-    };
-    updates?: {
-        promptNote: boolean;
-        changes: Array<{
-            controlName: string;
-            value: string | '$now';
-        }>;
-    };
-    automation?: {
-        promptNote: boolean;
-        url: string;
-        key: string;
-    };
-}
+import { VasJobActionDto } from './vas-job-action.dto';
 export interface VasFormConfigDto {
     emailRecipients?: {
         job: Array<{
@@ -27,5 +6,5 @@ export interface VasFormConfigDto {
         }>;
         static: Array<string>;
     };
-    actions?: Array<VasFormActionDto>;
+    actions?: Array<VasJobActionDto>;
 }

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

@@ -89,4 +89,5 @@ export declare class VasFormModel extends VasRestrictedAccountObjectModel {
      */
     toDto(): VasFormDto;
     toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasFormDto>): Partial<VasFormDto>;
 }

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

@@ -46,4 +46,5 @@ export declare class VasGroupModel extends VasRestrictedAccountObjectModel {
      */
     toDto(): VasGroupDto;
     toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasGroupDto>): Partial<VasGroupDto>;
 }

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

@@ -0,0 +1,66 @@
+export declare type VasJobActionStepStage = 'initializing' | 'running' | 'succeeded' | 'failed';
+export interface VasJobActionStepDto {
+    id: string;
+    type: 'automation' | 'controls' | 'email-form' | 'instruction' | 'set-job-status';
+    stage: VasJobActionStepStage;
+}
+/**
+ * Describes an action that can be performed on a job
+ */
+export interface VasJobActionDto {
+    id: string;
+    title: string;
+    steps: Array<VasJobActionStepDto>;
+    succeededControl?: string;
+    jobStatuses?: Array<string>;
+    context: 'portal-instruction' | 'job-form';
+}
+/**
+ * Automation steps allow us to send the job along with some configuration
+ * parameters to some backend automation
+ */
+export interface VasJobActionAutomationStepDto extends VasJobActionStepDto {
+    type: 'automation';
+    url: string;
+    params?: Record<string, any>;
+}
+export declare const isJobAutomationStep: (step: VasJobActionStepDto) => step is VasJobActionAutomationStepDto;
+/**
+ * Controls step allow us to specify a number of controls to present to the user
+ */
+export interface VasJobActionControlsStepDto extends VasJobActionStepDto {
+    type: 'controls';
+    controlNames: Array<string>;
+}
+export declare const isJobControlsStep: (step: VasJobActionStepDto) => step is VasJobActionControlsStepDto;
+/**
+ * Email form step allow us to present the email form with some values already
+ * set
+ */
+export interface VasJobActionEmailFormStepDto extends VasJobActionStepDto {
+    type: 'email-form';
+    params: {
+        $recipients: Array<string>;
+        $subject: string;
+        $body: Array<string>;
+    };
+}
+export declare const isJobEmailFormStep: (step: VasJobActionStepDto) => step is VasJobActionEmailFormStepDto;
+/**
+ * This step is designed to allow us to add an action button that will be
+ * displayed on the instruction. If the user invokes the action, a form will be
+ * displayed. The form id is discovered by looking up the instruction provider.
+ */
+export interface VasJobActionInstructionStepDto extends VasJobActionStepDto {
+    type: 'instruction';
+    instructionProviderId: string;
+    linkControl: string;
+}
+/**
+ * SetJobStatus step allow us set the job status to some value
+ */
+export interface VasJobActionSetJobStatusStepDto extends VasJobActionStepDto {
+    type: 'set-job-status';
+    value: string;
+}
+export declare const isJobSetJobStatusStep: (step: VasJobActionStepDto) => step is VasJobActionSetJobStatusStepDto;

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

@@ -1,5 +1,6 @@
 import { VasJobDataModel } from './vas-job-data.model';
 import { VasJobEmailDto } from './vas-job-email.dto';
+import { VasNoteDto } from './vas-note.dto';
 export declare class VasJobEmailModel extends VasJobDataModel {
     id: string;
     created: string;
@@ -27,4 +28,5 @@ export declare class VasJobEmailModel extends VasJobDataModel {
     static fromDto(dto: Partial<VasJobEmailDto>): VasJobEmailModel;
     toDto(): VasJobEmailDto;
     toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasNoteDto>): Partial<VasNoteDto>;
 }

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

@@ -2,6 +2,10 @@ import { VasFileDto } from './vas-file.dto';
 import { VasRestrictedAccountObjectDto } from './vas-restricted-account-object.dto';
 import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
 import { GeoLocation } from '../model/geo-location';
+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';
 export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
     reference: string;
     jobDate: string;
@@ -13,10 +17,14 @@ export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
     pendingFields: number;
     childModified: string;
     version: number;
-    files: Array<VasFileDto>;
-    fields: Array<VasFieldDto>;
     createdByDisplayName: string;
     modifiedByDisplayName: string;
     geoLocation: GeoLocation;
+    files: Array<VasFileDto>;
+    fields: Array<VasFieldDto>;
+    jobEmails: Array<VasJobEmailDto>;
+    notes: Array<VasNoteDto>;
+    reports: Array<VasReportDto>;
+    tasks: Array<VasTaskDto>;
 }
 export declare type VasJobDto = VasJobStaticDto & Record<string, VasFieldDtoValue>;

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

@@ -4,8 +4,12 @@ import { VasFieldDto, VasFieldDtoValue } 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/geo-location';
+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';
 export declare interface VasJobModelDynamicInterface {
     [s: string]: string | number | Record<string, VasFieldDtoValue>;
 }
@@ -38,12 +42,16 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     pendingFields: number;
     childModified: string;
     version: number;
-    fields: Array<VasFieldDto>;
-    files: Array<VasFileDto>;
     createdByDisplayName: string;
     modifiedByDisplayName: string;
     geoLocation: GeoLocation;
-    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, fields: Array<VasFieldDto>, files: Array<VasFileDto>, createdByDisplayName: string, modifiedByDisplayName: string, geoLocation: GeoLocation);
+    files: Array<VasFileDto>;
+    fields: Array<VasFieldDto>;
+    jobEmails: Array<VasJobEmailDto>;
+    notes: Array<VasNoteDto>;
+    reports: Array<VasReportDto>;
+    tasks: Array<VasTaskDto>;
+    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>);
     /**
      * Returns this with the dynamic interface
      * @return {VasJobModelDynamicInterface}
@@ -219,4 +227,5 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
      * @return {object}
      */
     toApiDto(): Record<string, string | number | boolean>;
+    static toApiPatchDto(item: Partial<VasJobDto>): Partial<VasJobDto>;
 }

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

@@ -30,4 +30,5 @@ export declare class VasLookupModel extends VasRestrictedAccountObjectModel impl
      */
     toDto(): VasLookupDto;
     toApiDto(options?: any): Record<string, string | number | boolean>;
+    static toApiPatchDto(item: Partial<VasLookupDto>): Partial<VasLookupDto>;
 }

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

@@ -28,4 +28,5 @@ export declare class VasNoteModel extends VasJobDataModel implements VasNoteDto
      */
     toDto(): VasNoteDto;
     toApiDto(options?: any): Record<string, string | number | boolean>;
+    static toApiPatchDto(item: Partial<VasNoteDto>): Partial<VasNoteDto>;
 }

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

@@ -1,6 +1,6 @@
 import { VasJobDataDto } from './vas-job-data.dto';
 export interface VasReportDto extends VasJobDataDto {
-    reportLayoutId: string;
+    reportLayout: string;
     title: string;
     sendEmail: string;
     message: string;

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

@@ -1,5 +1,6 @@
 import { VasJobDataModel } from './vas-job-data.model';
 import { VasReportDto } from './vas-report.dto';
+import { VasTaskDto } from './vas-task.dto';
 export declare class VasReportModel extends VasJobDataModel implements VasReportDto {
     id: string;
     created: string;
@@ -12,7 +13,7 @@ export declare class VasReportModel extends VasJobDataModel implements VasReport
     modifiedByName: string;
     account: string;
     job: string;
-    reportLayoutId: string;
+    reportLayout: string;
     title: string;
     sendEmail: string;
     message: string;
@@ -21,8 +22,10 @@ export declare class VasReportModel extends VasJobDataModel implements VasReport
     succeeded: string;
     attempts: number;
     notificationId: string;
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: string, reportLayoutId: string, title: string, sendEmail: string, message: string, attempted: string, completed: string, succeeded: string, attempts: number, notificationId: string);
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: string, reportLayout: string, title: string, sendEmail: string, message: string, attempted: string, completed: string, succeeded: string, attempts: number, notificationId: string);
     static empty(): VasReportModel;
     static fromDto(dto: Partial<VasReportModel>): VasReportModel;
     toDto(): VasReportDto;
+    toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasTaskDto>): Partial<VasTaskDto>;
 }

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

@@ -32,4 +32,5 @@ export declare class VasTaskModel extends VasJobDataModel {
      */
     toDto(): VasTaskDto;
     toApiDto(options?: any): Record<string, any>;
+    static toApiPatchDto(item: Partial<VasTaskDto>): Partial<VasTaskDto>;
 }

package/package.json

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