@ampsec/platform-client 43.1.0 → 45.0.0

package/build/src/dto/enums/finding.outcome.d.ts

@@ -0,0 +1,5 @@
+export declare enum FindingOutcome {
+    REMEDIATION = "remediation",
+    AWARENESS = "awareness",
+    EDUCATION = "education"
+}

package/build/src/dto/enums/finding.outcome.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FindingOutcome = void 0;
+/* eslint-disable no-unused-vars */
+var FindingOutcome;
+(function (FindingOutcome) {
+    FindingOutcome["REMEDIATION"] = "remediation";
+    FindingOutcome["AWARENESS"] = "awareness";
+    FindingOutcome["EDUCATION"] = "education";
+})(FindingOutcome || (exports.FindingOutcome = FindingOutcome = {}));
+//# sourceMappingURL=finding.outcome.js.map

package/build/src/dto/enums/finding.outcome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finding.outcome.js","sourceRoot":"","sources":["../../../../src/dto/enums/finding.outcome.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;AACzB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}

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

@@ -1,5 +1,6 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { Category, FindingKind } from './enums';
+import { FindingOutcome } from './enums/finding.outcome';
 import { FindingSeverity } from './enums/finding.severity';
 import { FindingStatus } from './enums/finding.status';
 import { SimpleProviderDto } from './providers.dto';
@@ -21,6 +22,8 @@ export type FindingUpsertDto = BaseUpsertDto & {
     status: FindingStatus;
     /** Severity of the finding, e.g. CRITICAL, HIGH, etc... */
     severity: FindingSeverity;
+    /** Desired outcome by surfacing the finding. */
+    outcome?: FindingOutcome;
     /** Number of times the user has been engaged to resolve the finding */
     numberOfEngagements: number;
     /** Human readable name of the finding */

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

@@ -1,6 +1,7 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { Category, DeliveryStrategyKind, FindingKind, FindingSeverity, NotificationStatus } from './enums';
 import { ContentStrategyKind } from './enums/contentStrategy.kind';
+import { FindingOutcome } from './enums/finding.outcome';
 export type NotificationAddress = {
     /** Connector ID for the notification channel */
     cid?: string;
@@ -22,6 +23,16 @@ export type FindingNotificationContext = {
     category: Category;
     /** Kind of the finding */
     kind: FindingKind;
+    /** Desired outcome of surfacing the finding */
+    outcome: FindingOutcome;
+};
+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 +64,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 +83,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 +94,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.1.0",
+  "version": "45.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/enums/finding.outcome.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export enum FindingOutcome {
+  REMEDIATION = 'remediation',
+  AWARENESS = 'awareness',
+  EDUCATION = 'education',
+}

package/src/dto/findings.dto.ts

@@ -1,5 +1,6 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {Category, FindingKind} from './enums';
+import {FindingOutcome} from './enums/finding.outcome';
 import {FindingSeverity} from './enums/finding.severity';
 import {FindingStatus} from './enums/finding.status';
 import {SimpleProviderDto} from './providers.dto';
@@ -23,6 +24,8 @@ export type FindingUpsertDto = BaseUpsertDto & {
   status: FindingStatus;
   /** Severity of the finding, e.g. CRITICAL, HIGH, etc... */
   severity: FindingSeverity;
+  /** Desired outcome by surfacing the finding. */
+  outcome?: FindingOutcome;
   /** Number of times the user has been engaged to resolve the finding */
   numberOfEngagements: number;
   /** Human readable name of the finding */

package/src/dto/notification.dto.ts

@@ -1,6 +1,7 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {Category, DeliveryStrategyKind, FindingKind, FindingSeverity, NotificationStatus} from './enums';
 import {ContentStrategyKind} from './enums/contentStrategy.kind';
+import {FindingOutcome} from './enums/finding.outcome';
 
 export type NotificationAddress = {
   /** Connector ID for the notification channel */
@@ -25,6 +26,17 @@ export type FindingNotificationContext = {
   category: Category;
   /** Kind of the finding */
   kind: FindingKind;
+  /** Desired outcome of surfacing the finding */
+  outcome: FindingOutcome;
+};
+
+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 +65,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 +72,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 +95,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 +105,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;