@ironcode/vas-lib 1.8.0-alpha.11 → 1.8.0-alpha.14

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-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-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/package.json

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