@ampsec/platform-client 36.0.0 → 37.0.0

package/build/src/dto/enums/index.d.ts

@@ -11,4 +11,4 @@ export * from './notification.status';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './notification.strategy';
+export * from './notification.kind';

package/build/src/dto/enums/index.js

@@ -27,5 +27,5 @@ __exportStar(require("./notification.status"), exports);
 __exportStar(require("./riskContributor.type"), exports);
 __exportStar(require("./saasComponentKind"), exports);
 __exportStar(require("./workflowStep.kind"), exports);
-__exportStar(require("./notification.strategy"), exports);
+__exportStar(require("./notification.kind"), exports);
 //# sourceMappingURL=index.js.map

package/build/src/dto/enums/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC"}

package/build/src/dto/enums/{notification.strategy.d.ts → notification.kind.d.ts}

@@ -1,4 +1,4 @@
-export declare enum NotificationStrategy {
+export declare enum NotificationKind {
     LLM = "LLM",
     RAW = "RAW",
     TEMPLATE = "TEMPLATE"

package/build/src/dto/enums/notification.kind.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationKind = void 0;
+/* eslint-disable no-unused-vars */
+var NotificationKind;
+(function (NotificationKind) {
+    NotificationKind["LLM"] = "LLM";
+    NotificationKind["RAW"] = "RAW";
+    NotificationKind["TEMPLATE"] = "TEMPLATE";
+})(NotificationKind || (exports.NotificationKind = NotificationKind = {}));
+//# sourceMappingURL=notification.kind.js.map

package/build/src/dto/enums/notification.kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.kind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,+BAAW,CAAA;IACX,yCAAqB,CAAA;AACvB,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B"}

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

@@ -1,15 +1,12 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { NotificationStatus } from './enums';
-import { NotificationStrategy } from './enums/notification.strategy';
+import { NotificationKind } from './enums/notification.kind';
 import { NotificationStepData, TrainingNotificationStepData } from './workflow.dto';
-export type NotificationSchema = {
-    strategy: NotificationStrategy;
-};
-export type TemplateNotificationSchema = NotificationSchema & {
+export type TemplateNotificationSchema = {
     /** ID of the template to be used for the notification */
     templateId: string;
 };
-export type RawNotificationSchema = NotificationSchema & {
+export type RawNotificationSchema = {
     /** Optional user provided notification message */
     rawContent: string;
 };
@@ -24,6 +21,8 @@ export type NotificationAddress = {
     webhooks?: string[];
 };
 export type NotificationUpsertDto = BaseUpsertDto & {
+    /** Kind of the notification */
+    kind: NotificationKind;
     /** Workflow ID for which the notification is being created */
     wfid: string;
     /** Finding ID for which the notification is being created */
@@ -39,6 +38,6 @@ export type NotificationUpsertDto = BaseUpsertDto & {
     /** Data to be used for the notification */
     data: NotificationStepData | TrainingNotificationStepData;
     /** Schema for the notification */
-    schema: NotificationSchema | RawNotificationSchema | TemplateNotificationSchema;
+    schema?: RawNotificationSchema | TemplateNotificationSchema;
 };
 export type NotificationDto = NotificationUpsertDto & BaseDto;

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

@@ -1,7 +1,8 @@
 import { BaseDto } from './base.dto';
+import { NotificationKind } from './enums';
 import { WorkflowStepKind } from './enums/workflowStep.kind';
 import { WorkflowTriggerKind } from './enums/workflowTrigger.kind';
-import { NotificationSchema, TemplateNotificationSchema, RawNotificationSchema } from './notification.dto';
+import { TemplateNotificationSchema, RawNotificationSchema } from './notification.dto';
 export type NotificationStepData = {
     /** Name of the device to which the notification of finding applies */
     deviceName: string | null;
@@ -25,8 +26,10 @@ export type PauseStepData = {
 export type WorkflowStep = {
     /** Type of the notification step, either NOTIFICATION or PAUSE */
     kind: WorkflowStepKind;
+    /** Kind of the notification */
+    notificationKind?: NotificationKind;
     /** Schema for the notification step */
-    schema?: NotificationSchema | TemplateNotificationSchema | RawNotificationSchema;
+    schema?: TemplateNotificationSchema | RawNotificationSchema;
     /** Data associated with the notification step */
     data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
     /** Step number to transition the workflow to on success */

package/package.json

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

package/src/dto/enums/index.ts

@@ -11,4 +11,4 @@ export * from './notification.status';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './notification.strategy';
+export * from './notification.kind';

package/src/dto/enums/{notification.strategy.ts → notification.kind.ts}

@@ -1,5 +1,5 @@
 /* eslint-disable no-unused-vars */
-export enum NotificationStrategy {
+export enum NotificationKind {
   LLM = 'LLM',
   RAW = 'RAW',
   TEMPLATE = 'TEMPLATE',

package/src/dto/notification.dto.ts

@@ -1,18 +1,14 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {NotificationStatus} from './enums';
-import {NotificationStrategy} from './enums/notification.strategy';
+import {NotificationKind} from './enums/notification.kind';
 import {NotificationStepData, TrainingNotificationStepData} from './workflow.dto';
 
-export type NotificationSchema = {
-  strategy: NotificationStrategy;
-};
-
-export type TemplateNotificationSchema = NotificationSchema & {
+export type TemplateNotificationSchema = {
   /** ID of the template to be used for the notification */
   templateId: string;
 };
 
-export type RawNotificationSchema = NotificationSchema & {
+export type RawNotificationSchema = {
   /** Optional user provided notification message */
   rawContent: string;
 };
@@ -29,6 +25,8 @@ export type NotificationAddress = {
 };
 
 export type NotificationUpsertDto = BaseUpsertDto & {
+  /** Kind of the notification */
+  kind: NotificationKind;
   /** Workflow ID for which the notification is being created */
   wfid: string;
   /** Finding ID for which the notification is being created */
@@ -44,7 +42,7 @@ export type NotificationUpsertDto = BaseUpsertDto & {
   /** Data to be used for the notification */
   data: NotificationStepData | TrainingNotificationStepData;
   /** Schema for the notification */
-  schema: NotificationSchema | RawNotificationSchema | TemplateNotificationSchema;
+  schema?: RawNotificationSchema | TemplateNotificationSchema;
 };
 
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/src/dto/workflow.dto.ts

@@ -1,7 +1,8 @@
 import {BaseDto} from './base.dto';
+import {NotificationKind} from './enums';
 import {WorkflowStepKind} from './enums/workflowStep.kind';
 import {WorkflowTriggerKind} from './enums/workflowTrigger.kind';
-import {NotificationSchema, TemplateNotificationSchema, RawNotificationSchema} from './notification.dto';
+import {TemplateNotificationSchema, RawNotificationSchema} from './notification.dto';
 
 export type NotificationStepData = {
   /** Name of the device to which the notification of finding applies */
@@ -29,8 +30,10 @@ export type PauseStepData = {
 export type WorkflowStep = {
   /** Type of the notification step, either NOTIFICATION or PAUSE */
   kind: WorkflowStepKind;
+  /** Kind of the notification */
+  notificationKind?: NotificationKind;
   /** Schema for the notification step */
-  schema?: NotificationSchema | TemplateNotificationSchema | RawNotificationSchema;
+  schema?: TemplateNotificationSchema | RawNotificationSchema;
   /** Data associated with the notification step */
   data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
   /** Step number to transition the workflow to on success */

package/build/src/dto/enums/notification.strategy.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationStrategy = void 0;
-/* eslint-disable no-unused-vars */
-var NotificationStrategy;
-(function (NotificationStrategy) {
-    NotificationStrategy["LLM"] = "LLM";
-    NotificationStrategy["RAW"] = "RAW";
-    NotificationStrategy["TEMPLATE"] = "TEMPLATE";
-})(NotificationStrategy || (exports.NotificationStrategy = NotificationStrategy = {}));
-//# sourceMappingURL=notification.strategy.js.map

package/build/src/dto/enums/notification.strategy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"notification.strategy.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.strategy.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;IACX,6CAAqB,CAAA;AACvB,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B"}