@ampsec/platform-client 44.0.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,7 +23,8 @@ export type FindingNotificationContext = {
     category: Category;
     /** Kind of the finding */
     kind: FindingKind;
-    action: 'remediate' | 'awareness' | 'educate';
+    /** Desired outcome of surfacing the finding */
+    outcome: FindingOutcome;
 };
 export type VulnerabilityNotificationContext = {
     /** Summary of the vulnerability. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "44.0.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,7 +26,8 @@ export type FindingNotificationContext = {
   category: Category;
   /** Kind of the finding */
   kind: FindingKind;
-  action: 'remediate' | 'awareness' | 'educate';
+  /** Desired outcome of surfacing the finding */
+  outcome: FindingOutcome;
 };
 
 export type VulnerabilityNotificationContext = {