@ampsec/platform-client 43.0.0 → 44.0.0

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

@@ -0,0 +1,10 @@
+export type EmailDto = {
+    /** Email address of the recipient */
+    to: string;
+    /** Email subject */
+    subject: string;
+    /** Email body */
+    text: string;
+    /** Optional HTML body */
+    html?: string;
+};

package/build/src/dto/email.dto.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=email.dto.js.map

package/build/src/dto/email.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.dto.js","sourceRoot":"","sources":["../../../src/dto/email.dto.ts"],"names":[],"mappings":""}

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

@@ -4,6 +4,7 @@ export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
 export * from './constants';
+export * from './email.dto';
 export * from './enum.dto';
 export * from './enums';
 export * from './extKeyMap.dto';

package/build/src/dto/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./assetKeys"), exports);
 __exportStar(require("./base.dto"), exports);
 __exportStar(require("./connectors.dto"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./email.dto"), exports);
 __exportStar(require("./enum.dto"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./extKeyMap.dto"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAiC;AACjC,8CAA4B;AAC5B,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,wCAAsB;AACtB,gDAA8B;AAC9B,qDAAmC;AACnC,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B;AAC5B,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B;AAC5B,6CAA2B;AAC3B,mDAAiC;AACjC,8CAA4B;AAC5B,8CAA4B;AAC5B,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,wCAAsB;AACtB,gDAA8B;AAC9B,qDAAmC;AACnC,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B;AAC9B,8CAA4B;AAC5B,iDAA+B"}

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

@@ -22,6 +22,15 @@ export type FindingNotificationContext = {
     category: Category;
     /** Kind of the finding */
     kind: FindingKind;
+    action: 'remediate' | 'awareness' | 'educate';
+};
+export type VulnerabilityNotificationContext = {
+    /** Summary of the vulnerability. */
+    description: string;
+    /** Summary of the remediation action. */
+    solution?: string;
+    /** CVSS score of the vulnerability. */
+    cvss?: number;
 };
 export type TrainingNotificationContext = {
     /** Title of the training */
@@ -53,14 +62,11 @@ export type NotificationContext = {
     provider?: ProviderNotificationContext;
     training?: TrainingNotificationContext;
     user?: UserNotificationContext;
+    vulnerability?: VulnerabilityNotificationContext;
 };
 export type ContentStrategySpecification = {
     /** Kind of the content strategy */
     kind: ContentStrategyKind;
-    /** Data to be used for the notification */
-    data?: {
-        [propName: string]: string | number | boolean;
-    };
 };
 export type TemplateContentStrategySpec = ContentStrategySpecification & {
     /** ID of the template to be used for the notification */
@@ -75,6 +81,10 @@ export type RawContentStrategySpec = ContentStrategySpecification & {
 export type LlmContentStrategySpec = ContentStrategySpecification & {
     /** Context for the notification */
     context: NotificationContext;
+    history?: {
+        role: 'user' | 'system' | 'assistant';
+        content: string;
+    }[];
 };
 export type DeliveryStrategySpec = {
     /** Channel type that should be used for sending the notificaiton */
@@ -82,6 +92,9 @@ export type DeliveryStrategySpec = {
     /** Recipient address to which the notification is being sent */
     to: NotificationAddress;
 };
+export type EmailDeliveryStrategySpec = DeliveryStrategySpec & {
+    subject: string;
+};
 export type NotificationUpsertDto = BaseUpsertDto & {
     /** Workflow ID for which the notification is being created */
     wfid: string;

package/package.json

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

package/src/dto/email.dto.ts

@@ -0,0 +1,10 @@
+export type EmailDto = {
+  /** Email address of the recipient */
+  to: string;
+  /** Email subject */
+  subject: string;
+  /** Email body */
+  text: string;
+  /** Optional HTML body */
+  html?: string;
+};

package/src/dto/index.ts

@@ -4,6 +4,7 @@ export * from './assetKeys';
 export * from './base.dto';
 export * from './connectors.dto';
 export * from './constants';
+export * from './email.dto';
 export * from './enum.dto';
 export * from './enums';
 export * from './extKeyMap.dto';

package/src/dto/notification.dto.ts

@@ -25,6 +25,16 @@ export type FindingNotificationContext = {
   category: Category;
   /** Kind of the finding */
   kind: FindingKind;
+  action: 'remediate' | 'awareness' | 'educate';
+};
+
+export type VulnerabilityNotificationContext = {
+  /** Summary of the vulnerability. */
+  description: string;
+  /** Summary of the remediation action. */
+  solution?: string;
+  /** CVSS score of the vulnerability. */
+  cvss?: number;
 };
 
 export type TrainingNotificationContext = {
@@ -53,8 +63,6 @@ export type ProviderNotificationContext = {
 };
 
 export type NotificationContext = {
-  // TODO: determine what this should be
-  // component?: ComponentNotificationContext;
   /** Estimated completion time for the remediation described by the notification */
   estimatedCompletionTime: number;
   asset?: AssetNotificationContext;
@@ -62,15 +70,12 @@ export type NotificationContext = {
   provider?: ProviderNotificationContext;
   training?: TrainingNotificationContext;
   user?: UserNotificationContext;
+  vulnerability?: VulnerabilityNotificationContext;
 };
 
 export type ContentStrategySpecification = {
   /** Kind of the content strategy */
   kind: ContentStrategyKind;
-  /** Data to be used for the notification */
-  data?: {
-    [propName: string]: string | number | boolean;
-  };
 };
 
 export type TemplateContentStrategySpec = ContentStrategySpecification & {
@@ -88,6 +93,7 @@ export type RawContentStrategySpec = ContentStrategySpecification & {
 export type LlmContentStrategySpec = ContentStrategySpecification & {
   /** Context for the notification */
   context: NotificationContext;
+  history?: {role: 'user' | 'system' | 'assistant'; content: string}[];
 };
 
 export type DeliveryStrategySpec = {
@@ -97,6 +103,10 @@ export type DeliveryStrategySpec = {
   to: NotificationAddress;
 };
 
+export type EmailDeliveryStrategySpec = DeliveryStrategySpec & {
+  subject: string;
+};
+
 export type NotificationUpsertDto = BaseUpsertDto & {
   /** Workflow ID for which the notification is being created */
   wfid: string;