@ampsec/platform-client 33.0.1 → 34.0.0

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

@@ -0,0 +1,5 @@
+export declare enum NotificationType {
+    LLM = "LLM",
+    RAW = "RAW",
+    TEMPLATE = "TEMPLATE"
+}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification.type.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.type.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,6 +1,18 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { NotificationStatus } from './enums';
+import { NotificationType } from './enums/notification.type';
 import { NotificationStepData, TrainingNotificationStepData } from './workflow.dto';
+export type NotificationSchema = {
+    type: NotificationType;
+};
+export type TemplateNotificationSchema = NotificationSchema & {
+    /** ID of the template to be used for the notification */
+    templateId: string;
+};
+export type RawNotificationSchema = NotificationSchema & {
+    /** Optional user provided notification message */
+    rawContent: string;
+};
 export type NotificationAddress = {
     /** Connector ID for the notification channel */
     cid: string;
@@ -18,8 +30,6 @@ export type NotificationUpsertDto = BaseUpsertDto & {
     fid?: string;
     /** Recipient address to which the notification is being sent */
     to: NotificationAddress;
-    /** ID of the template to use for the notification */
-    templateId: 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 */
@@ -28,7 +38,7 @@ export type NotificationUpsertDto = BaseUpsertDto & {
     status: NotificationStatus;
     /** Data to be used for the notification */
     data: NotificationStepData | TrainingNotificationStepData;
-    /** Optional user provided notification message */
-    rawContent?: string;
+    /** Schema for the notification */
+    schema: NotificationSchema | RawNotificationSchema | TemplateNotificationSchema;
 };
 export type NotificationDto = NotificationUpsertDto & BaseDto;

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

@@ -1,6 +1,7 @@
 import { BaseDto } from './base.dto';
 import { WorkflowStepType } from './enums/workflowStep.type';
 import { WorkflowTriggerType } from './enums/workflowTrigger.type';
+import { NotificationSchema, TemplateNotificationSchema, RawNotificationSchema } from './notification.dto';
 export type NotificationStepData = {
     /** Name of the device to which the notification of finding applies */
     deviceName: string | null;
@@ -24,8 +25,8 @@ export type PauseStepData = {
 export type WorkflowStep = {
     /** Type of the notification step, either NOTIFICATION or PAUSE */
     type: WorkflowStepType;
-    /** ID of the template to be used for the notification */
-    templateId?: string;
+    /** Schema for the notification step */
+    schema?: NotificationSchema | 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": "33.0.1",
+  "version": "34.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

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

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export enum NotificationType {
+  LLM = 'LLM',
+  RAW = 'RAW',
+  TEMPLATE = 'TEMPLATE',
+}

package/src/dto/notification.dto.ts

@@ -1,7 +1,22 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {NotificationStatus} from './enums';
+import {NotificationType} from './enums/notification.type';
 import {NotificationStepData, TrainingNotificationStepData} from './workflow.dto';
 
+export type NotificationSchema = {
+  type: NotificationType;
+};
+
+export type TemplateNotificationSchema = NotificationSchema & {
+  /** ID of the template to be used for the notification */
+  templateId: string;
+};
+
+export type RawNotificationSchema = NotificationSchema & {
+  /** Optional user provided notification message */
+  rawContent: string;
+};
+
 export type NotificationAddress = {
   /** Connector ID for the notification channel */
   cid: string;
@@ -20,8 +35,6 @@ export type NotificationUpsertDto = BaseUpsertDto & {
   fid?: string;
   /** Recipient address to which the notification is being sent */
   to: NotificationAddress;
-  /** ID of the template to use for the notification */
-  templateId: 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 */
@@ -30,8 +43,8 @@ export type NotificationUpsertDto = BaseUpsertDto & {
   status: NotificationStatus;
   /** Data to be used for the notification */
   data: NotificationStepData | TrainingNotificationStepData;
-  /** Optional user provided notification message */
-  rawContent?: string;
+  /** Schema for the notification */
+  schema: NotificationSchema | RawNotificationSchema | TemplateNotificationSchema;
 };
 
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/src/dto/workflow.dto.ts

@@ -1,6 +1,7 @@
 import {BaseDto} from './base.dto';
 import {WorkflowStepType} from './enums/workflowStep.type';
 import {WorkflowTriggerType} from './enums/workflowTrigger.type';
+import {NotificationSchema, TemplateNotificationSchema, RawNotificationSchema} from './notification.dto';
 
 export type NotificationStepData = {
   /** Name of the device to which the notification of finding applies */
@@ -28,8 +29,8 @@ export type PauseStepData = {
 export type WorkflowStep = {
   /** Type of the notification step, either NOTIFICATION or PAUSE */
   type: WorkflowStepType;
-  /** ID of the template to be used for the notification */
-  templateId?: string;
+  /** Schema for the notification step */
+  schema?: NotificationSchema | TemplateNotificationSchema | RawNotificationSchema;
   /** Data associated with the notification step */
   data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
   /** Step number to transition the workflow to on success */