@ironcode/vas-lib 1.5.1 → 1.6.2

package/lib/entity/index.d.ts

@@ -21,6 +21,8 @@ export * from './vas-file.dto';
 export * from './vas-file.model';
 export * from './vas-form.dto';
 export * from './vas-form.model';
+export * from './vas-form-config.dto';
+export * from './vas-form-config.model';
 export * from './vas-invitation';
 export * from './vas-group.dto';
 export * from './vas-group.model';
@@ -57,7 +59,6 @@ export * from './vas-restricted-account-object.model';
 export * from './vas-task-type.dto';
 export * from './vas-user.dto';
 export * from './vas-user.model';
-export * from './vas-form-config.dto';
 export * from './vas-account-config.dto';
 export * from './vas-vehicle.dto';
 export * from './vas-vehicle.model';

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

@@ -1,8 +1,26 @@
+/**
+ * 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';
+        }>;
+    };
+}
 export interface VasFormConfigDto {
-    emailRecipients: {
+    emailRecipients?: {
         job: Array<{
             segments: Array<string>;
         }>;
         static: Array<string>;
     };
+    actions?: Array<VasFormActionDto>;
 }

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

@@ -0,0 +1,21 @@
+import { VasFormConfigDto } from './vas-form-config.dto';
+export declare class VasFormConfigModel {
+    emailRecipients?: {
+        job: {
+            segments: string[];
+        }[];
+        static: string[];
+    } | undefined;
+    actions?: import("./vas-form-config.dto").VasFormActionDto[] | undefined;
+    constructor(emailRecipients?: {
+        job: {
+            segments: string[];
+        }[];
+        static: string[];
+    } | undefined, actions?: import("./vas-form-config.dto").VasFormActionDto[] | undefined);
+    toDto(): VasFormConfigDto;
+    toJsonString(): string;
+    static create(): VasFormConfigModel;
+    static fromDto(dto: Partial<VasFormConfigDto>): VasFormConfigModel;
+    static fromJsonString(value?: string): VasFormConfigModel;
+}

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

@@ -5,6 +5,7 @@ import { VasFieldDtoValue } 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';
 /**
  * VasFormModel
  */
@@ -27,10 +28,10 @@ export declare class VasFormModel extends VasRestrictedAccountObjectModel {
     dynamicDescriptor: string;
     indexName: string;
     pipelineName: string;
-    config: string;
+    config: VasFormConfigModel;
     geoLocationEnabled: boolean;
     filesEnabled: boolean;
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, jobType: string, title: string, description: string, groups: VasGroupModel[], dynamicDescriptor: string, indexName: string, pipelineName: string, config: string, geoLocationEnabled: boolean, filesEnabled: boolean);
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, jobType: string, title: string, description: string, groups: VasGroupModel[], dynamicDescriptor: string, indexName: string, pipelineName: string, config: VasFormConfigModel, geoLocationEnabled: boolean, filesEnabled: boolean);
     /**
      * Returns the name of this form in a "safe" way, i.e. no spaces, special
      * characters

package/lib/entity/vas-instruction-provider.dto.d.ts

@@ -5,4 +5,5 @@ export interface VasInstructionProviderDto extends VasAccountObjectDto {
     title: string;
     secret: string;
     portalEnabled: boolean;
+    portalVisible: boolean;
 }

package/lib/entity/vas-instruction-provider.model.d.ts

@@ -19,7 +19,8 @@ export declare class VasInstructionProviderModel extends VasAccountObjectModel {
     title: string;
     secret: string;
     portalEnabled: boolean;
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, form: VasFormModel, title: string, secret: string, portalEnabled: boolean);
+    portalVisible: boolean;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, form: VasFormModel, title: string, secret: string, portalEnabled: boolean, portalVisible: boolean);
     /**
      * @param dto VasInstructionDto
      * @return VasInstructionModel

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

@@ -78,11 +78,12 @@ export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     /**
      * 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
-     * return a property regardless (because it uses the form to drive the logic)
+     * return values where a value was set, as opposed to `getFields` which will
+     * return a value for every control even if not value was set, because it uses
+     * the form to drive the logic
      * @return {Record<string, VasFieldDtoValue>}
      */
-    protected getFields2(): 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ironcode/vas-lib",
-  "version": "1.5.1",
+  "version": "1.6.2",
   "peerDependencies": {
     "angular2-uuid": "^1.1.1",
     "moment": "^2.0.0"