@ampsec/platform-client 28.1.0 → 29.0.0

package/build/src/dto/enums/workflowTrigger.type.d.ts

@@ -1,4 +1,5 @@
 export declare enum WorkflowTriggerType {
     FINDING = "FINDING",
-    USER = "USER"
+    USER = "USER",
+    SAAS_COMPONENT = "SAAS_COMPONENT"
 }

package/build/src/dto/enums/workflowTrigger.type.js

@@ -6,5 +6,6 @@ var WorkflowTriggerType;
 (function (WorkflowTriggerType) {
     WorkflowTriggerType["FINDING"] = "FINDING";
     WorkflowTriggerType["USER"] = "USER";
+    WorkflowTriggerType["SAAS_COMPONENT"] = "SAAS_COMPONENT";
 })(WorkflowTriggerType || (exports.WorkflowTriggerType = WorkflowTriggerType = {}));
 //# sourceMappingURL=workflowTrigger.type.js.map

package/build/src/dto/enums/workflowTrigger.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflowTrigger.type.js","sourceRoot":"","sources":["../../../../src/dto/enums/workflowTrigger.type.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,oCAAa,CAAA;AACf,CAAC,EAHW,mBAAmB,mCAAnB,mBAAmB,QAG9B"}
+{"version":3,"file":"workflowTrigger.type.js","sourceRoot":"","sources":["../../../../src/dto/enums/workflowTrigger.type.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,oCAAa,CAAA;IACb,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B"}

package/build/src/dto/notification.dto.d.ts

@@ -1,5 +1,6 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { NotificationStatus } from './enums';
+import { NotificationStepData } from './workflow.dto';
 export type NotificationAddress = {
     /** Connector ID for the notification channel */
     cid: string;
@@ -19,11 +20,13 @@ export type NotificationUpsertDto = BaseUpsertDto & {
     to: NotificationAddress;
     /** ID of the template to use for the notification */
     templateId: string;
-    /** ID o fthe user to which the notification is being sent */
-    uid: string;
+    /** ID of the user to which the notification is being sent */
+    uid?: string;
     /** Step number in the workflow for which the notification is being created */
     stepNumber: number;
     /** Status of the notification */
     status: NotificationStatus;
+    /** Data to be used for the notification */
+    data: NotificationStepData;
 };
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/build/src/dto/saasComponents.dto.d.ts

@@ -48,5 +48,11 @@ export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
     extKey: string;
     /** Component display value */
     displayValue: string;
+    /**
+     * Used as the naive implementation of notification schedules inside Flows.
+     * "Resets" notifications schedule after pause or failed verification.
+     * Defaults to "NOW".
+     */
+    nextNotificationAfter?: string;
 };
 export type SaasComponentDto = ChangeAwareDto & SaasComponentUpsertDto;

package/build/src/dto/users.dto.d.ts

@@ -37,5 +37,11 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
     riskContributors: RiskContributorUpsertDto[];
     /** Health score associated with the user */
     score?: number;
+    /**
+     * Used as the naive implementation of notification schedules inside Flows.
+     * "Resets" notifications schedule after pause or failed verification.
+     * Defaults to "NOW".
+     */
+    nextNotificationAfter?: string;
 };
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/build/src/dto/workflow.dto.d.ts

@@ -3,27 +3,31 @@ import { WorkflowStepType } from './enums/workflowStep.type';
 import { WorkflowTriggerType } from './enums/workflowTrigger.type';
 export type NotificationStepData = {
     /** Name of the device to which the notification of finding applies */
-    deviceName?: string;
-    /** Description of the notification of finding */
-    description?: string;
-    /** Due date associated with the finding */
-    dueDate?: string;
+    deviceName: string;
+    /** Estimated time to remediate the finding, in minutes */
+    duration: number;
     /** Name of the software to which the finding applies */
     softwareName: string;
 };
+export type TrainingNotificationStepData = NotificationStepData & {
+    /** Name of the training module */
+    title: string;
+    /** Description of the training module */
+    description: string;
+    /** Due date associated with the training module */
+    dueDate: string;
+};
 export type PauseStepData = {
     /** Estimated duration, in minutes, to resolve the finding */
     duration: number;
 };
 export type WorkflowStep = {
-    /** Number of the step in the workflow */
-    stepNumber: number;
     /** Type of the notification step, either NOTIFICATION or PAUSE */
     type: WorkflowStepType;
     /** ID of the template to be used for the notification */
     templateId?: string;
     /** Data associated with the notification step */
-    data: NotificationStepData | PauseStepData;
+    data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
     /** Step number to transition the workflow to on success */
     successStepNumber: number | null;
     /** Step number to transition the workflow to on failure */
@@ -31,6 +35,9 @@ export type WorkflowStep = {
     /** Duration, in days, to wait before executing the next step in the workflow */
     pauseDuration?: number | null;
 };
+export type WorkflowSteps = {
+    [propName: number]: WorkflowStep;
+};
 export type WorkflowTriggerRule = {
     [propName: string]: string | number | boolean | null | {
         [propName: string]: string | number | boolean | WorkflowTriggerRule;
@@ -50,7 +57,7 @@ export type WorkflowUpsertDto = {
     /** Trigger that begins execution of the workflow */
     trigger: WorkflowTrigger;
     /** Steps in the workflow */
-    steps?: WorkflowStep[];
+    steps: WorkflowSteps;
 };
 export type WorkflowDto = BaseDto & WorkflowUpsertDto;
 export type WorkflowProgressUpsertDto = {
@@ -59,7 +66,7 @@ export type WorkflowProgressUpsertDto = {
     /** ID of the finding for which the workflow is being executed */
     fid?: string | null;
     /** Step number to transition the workflow to next */
-    nextStep: number;
+    nextStep: number | null;
     /** ID of the user for which the workflow is being executed */
     uid: string;
     /** whether or not this instance of the workflow has been completed */

package/build/src/services/constants.js

@@ -24,7 +24,7 @@ exports.KIND = {
     SAAS_USERS: 'saas_users',
     TENANTS: 'tenants',
     USERS: 'users',
-    WORKFLOW_PROGRESS: 'workflows_progress',
+    WORKFLOW_PROGRESS: 'workflow_progress',
 };
 exports.REPORTS = {
     HEALTH_SCORE: 'health-score',

package/build/src/services/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AACpC,QAAA,iBAAiB,GAAc,KAAK,CAAC;AAErC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,oBAAoB;CACxC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AACpC,QAAA,iBAAiB,GAAc,KAAK,CAAC;AAErC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "28.1.0",
+  "version": "29.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/enums/workflowTrigger.type.ts

@@ -2,4 +2,5 @@
 export enum WorkflowTriggerType {
   FINDING = 'FINDING',
   USER = 'USER',
+  SAAS_COMPONENT = 'SAAS_COMPONENT',
 }

package/src/dto/notification.dto.ts

@@ -1,5 +1,6 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {NotificationStatus} from './enums';
+import {NotificationStepData} from './workflow.dto';
 
 export type NotificationAddress = {
   /** Connector ID for the notification channel */
@@ -21,12 +22,14 @@ export type NotificationUpsertDto = BaseUpsertDto & {
   to: NotificationAddress;
   /** ID of the template to use for the notification */
   templateId: string;
-  /** ID o fthe user to which the notification is being sent */
-  uid: string;
+  /** ID of the user to which the notification is being sent */
+  uid?: string;
   /** Step number in the workflow for which the notification is being created */
   stepNumber: number;
   /** Status of the notification */
   status: NotificationStatus;
+  /** Data to be used for the notification */
+  data: NotificationStepData;
 };
 
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/src/dto/saasComponents.dto.ts

@@ -50,6 +50,12 @@ export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
   extKey: string;
   /** Component display value */
   displayValue: string;
+  /**
+   * Used as the naive implementation of notification schedules inside Flows.
+   * "Resets" notifications schedule after pause or failed verification.
+   * Defaults to "NOW".
+   */
+  nextNotificationAfter?: string;
 };
 
 export type SaasComponentDto = ChangeAwareDto & SaasComponentUpsertDto;

package/src/dto/users.dto.ts

@@ -39,6 +39,12 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
   riskContributors: RiskContributorUpsertDto[];
   /** Health score associated with the user */
   score?: number;
+  /**
+   * Used as the naive implementation of notification schedules inside Flows.
+   * "Resets" notifications schedule after pause or failed verification.
+   * Defaults to "NOW".
+   */
+  nextNotificationAfter?: string;
 };
 
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/src/dto/workflow.dto.ts

@@ -4,29 +4,34 @@ import {WorkflowTriggerType} from './enums/workflowTrigger.type';
 
 export type NotificationStepData = {
   /** Name of the device to which the notification of finding applies */
-  deviceName?: string;
-  /** Description of the notification of finding */
-  description?: string;
-  /** Due date associated with the finding */
-  dueDate?: string;
+  deviceName: string;
+  /** Estimated time to remediate the finding, in minutes */
+  duration: number;
   /** Name of the software to which the finding applies */
   softwareName: string;
 };
 
+export type TrainingNotificationStepData = NotificationStepData & {
+  /** Name of the training module */
+  title: string;
+  /** Description of the training module */
+  description: string;
+  /** Due date associated with the training module */
+  dueDate: string;
+};
+
 export type PauseStepData = {
   /** Estimated duration, in minutes, to resolve the finding */
   duration: number;
 };
 
 export type WorkflowStep = {
-  /** Number of the step in the workflow */
-  stepNumber: number;
   /** Type of the notification step, either NOTIFICATION or PAUSE */
   type: WorkflowStepType;
   /** ID of the template to be used for the notification */
   templateId?: string;
   /** Data associated with the notification step */
-  data: NotificationStepData | PauseStepData;
+  data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
   /** Step number to transition the workflow to on success */
   successStepNumber: number | null;
   /** Step number to transition the workflow to on failure */
@@ -35,6 +40,10 @@ export type WorkflowStep = {
   pauseDuration?: number | null;
 };
 
+export type WorkflowSteps = {
+  [propName: number]: WorkflowStep;
+};
+
 export type WorkflowTriggerRule = {
   [propName: string]:
     | string
@@ -62,7 +71,7 @@ export type WorkflowUpsertDto = {
   /** Trigger that begins execution of the workflow */
   trigger: WorkflowTrigger;
   /** Steps in the workflow */
-  steps?: WorkflowStep[];
+  steps: WorkflowSteps;
 };
 
 export type WorkflowDto = BaseDto & WorkflowUpsertDto;
@@ -73,7 +82,7 @@ export type WorkflowProgressUpsertDto = {
   /** ID of the finding for which the workflow is being executed */
   fid?: string | null;
   /** Step number to transition the workflow to next */
-  nextStep: number;
+  nextStep: number | null;
   /** ID of the user for which the workflow is being executed */
   uid: string;
   /** whether or not this instance of the workflow has been completed */

package/src/services/constants.ts

@@ -28,7 +28,7 @@ export const KIND = {
   SAAS_USERS: 'saas_users',
   TENANTS: 'tenants',
   USERS: 'users',
-  WORKFLOW_PROGRESS: 'workflows_progress',
+  WORKFLOW_PROGRESS: 'workflow_progress',
 };
 
 export const REPORTS = {