@ampsec/platform-client 45.3.0 → 45.5.0

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

@@ -1,3 +1,4 @@
+import { FindingOutcome } from './finding.outcome';
 export declare enum FindingKind {
     NO_ACCOUNT = "NO_ACCOUNT",
     MFA_NOT_ENABLED = "MFA_NOT_ENABLED",
@@ -10,3 +11,4 @@ export declare enum FindingKind {
     VULNERABILITY_OUT_OF_SLA = "VULNERABILITY_OUT_OF_SLA",
     WEB_GATEWAY_NOT_ACTIVE = "WEB_GATEWAY_NOT_ACTIVE"
 }
+export declare const lookupFindingOutcomeByKind: (kind: FindingKind) => FindingOutcome;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FindingKind = void 0;
+exports.lookupFindingOutcomeByKind = exports.FindingKind = void 0;
+const finding_outcome_1 = require("./finding.outcome");
 /* eslint-disable no-unused-vars */
 var FindingKind;
 (function (FindingKind) {
@@ -20,4 +21,28 @@ var FindingKind;
     // WEB_GATEWAY
     FindingKind["WEB_GATEWAY_NOT_ACTIVE"] = "WEB_GATEWAY_NOT_ACTIVE";
 })(FindingKind || (exports.FindingKind = FindingKind = {}));
+const lookupFindingOutcomeByKind = (kind) => {
+    switch (kind) {
+        case FindingKind.NO_ACCOUNT:
+        case FindingKind.MFA_NOT_ENABLED:
+        case FindingKind.TRAINING_OVERDUE:
+        case FindingKind.DEVICE_NOT_MANAGED:
+        case FindingKind.VULNERABILITY_OUT_OF_SLA:
+        case FindingKind.WEB_GATEWAY_NOT_ACTIVE: {
+            return finding_outcome_1.FindingOutcome.REMEDIATION;
+        }
+        case FindingKind.IS_EXECUTIVE:
+        case FindingKind.HAS_PRODUCTION_ACCESS:
+        case FindingKind.HAS_PRIVILEGED_ACCESS: {
+            return finding_outcome_1.FindingOutcome.AWARENESS;
+        }
+        case FindingKind.FAILED_PHISHING: {
+            return finding_outcome_1.FindingOutcome.EDUCATION;
+        }
+        default: {
+            throw new Error(`Unable to lookup desired outcome for finding kind: ${kind}`);
+        }
+    }
+};
+exports.lookupFindingOutcomeByKind = lookupFindingOutcomeByKind;
 //# sourceMappingURL=findingKind.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"findingKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/findingKind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,WAoBX;AApBD,WAAY,WAAW;IACrB,MAAM;IACN,wCAAyB,CAAA;IAEzB,WAAW;IACX,kDAAmC,CAAA;IACnC,4CAA6B,CAAA;IAC7B,8DAA+C,CAAA;IAC/C,8DAA+C,CAAA;IAE/C,WAAW;IACX,kDAAmC,CAAA;IACnC,oDAAqC,CAAA;IAErC,MAAM;IACN,wDAAyC,CAAA;IACzC,oEAAqD,CAAA;IAErD,cAAc;IACd,gEAAiD,CAAA;AACnD,CAAC,EApBW,WAAW,2BAAX,WAAW,QAoBtB"}
+{"version":3,"file":"findingKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/findingKind.ts"],"names":[],"mappings":";;;AAAA,uDAAiD;AAEjD,mCAAmC;AACnC,IAAY,WAoBX;AApBD,WAAY,WAAW;IACrB,MAAM;IACN,wCAAyB,CAAA;IAEzB,WAAW;IACX,kDAAmC,CAAA;IACnC,4CAA6B,CAAA;IAC7B,8DAA+C,CAAA;IAC/C,8DAA+C,CAAA;IAE/C,WAAW;IACX,kDAAmC,CAAA;IACnC,oDAAqC,CAAA;IAErC,MAAM;IACN,wDAAyC,CAAA;IACzC,oEAAqD,CAAA;IAErD,cAAc;IACd,gEAAiD,CAAA;AACnD,CAAC,EApBW,WAAW,2BAAX,WAAW,QAoBtB;AAEM,MAAM,0BAA0B,GAAG,CAAC,IAAiB,EAAkB,EAAE;IAC9E,QAAQ,IAAI,EAAE;QACZ,KAAK,WAAW,CAAC,UAAU,CAAC;QAC5B,KAAK,WAAW,CAAC,eAAe,CAAC;QACjC,KAAK,WAAW,CAAC,gBAAgB,CAAC;QAClC,KAAK,WAAW,CAAC,kBAAkB,CAAC;QACpC,KAAK,WAAW,CAAC,wBAAwB,CAAC;QAC1C,KAAK,WAAW,CAAC,sBAAsB,CAAC,CAAC;YACvC,OAAO,gCAAc,CAAC,WAAW,CAAC;SACnC;QACD,KAAK,WAAW,CAAC,YAAY,CAAC;QAC9B,KAAK,WAAW,CAAC,qBAAqB,CAAC;QACvC,KAAK,WAAW,CAAC,qBAAqB,CAAC,CAAC;YACtC,OAAO,gCAAc,CAAC,SAAS,CAAC;SACjC;QACD,KAAK,WAAW,CAAC,eAAe,CAAC,CAAC;YAChC,OAAO,gCAAc,CAAC,SAAS,CAAC;SACjC;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,sDAAsD,IAAI,EAAE,CAAC,CAAC;SAC/E;KACF;AACH,CAAC,CAAC;AAtBW,QAAA,0BAA0B,8BAsBrC"}

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

@@ -3,14 +3,17 @@ export * from './agent.status';
 export * from './ampSettingKeys.enum';
 export * from './category';
 export * from './connector.status';
+export * from './contentStrategy.kind';
+export * from './deliveryStrategy.kind';
 export * from './findingKind';
 export * from './finding.severity';
 export * from './finding.status';
+export * from './finding.outcome';
 export * from './globalUser.type';
 export * from './jobExecution.status';
 export * from './notification.status';
+export * from './requiredDataProperty.enum';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './contentStrategy.kind';
-export * from './deliveryStrategy.kind';
+export * from './workflowTrigger.kind';

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

@@ -19,15 +19,18 @@ __exportStar(require("./agent.status"), exports);
 __exportStar(require("./ampSettingKeys.enum"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./connector.status"), exports);
+__exportStar(require("./contentStrategy.kind"), exports);
+__exportStar(require("./deliveryStrategy.kind"), exports);
 __exportStar(require("./findingKind"), exports);
 __exportStar(require("./finding.severity"), exports);
 __exportStar(require("./finding.status"), exports);
+__exportStar(require("./finding.outcome"), exports);
 __exportStar(require("./globalUser.type"), exports);
 __exportStar(require("./jobExecution.status"), exports);
 __exportStar(require("./notification.status"), exports);
+__exportStar(require("./requiredDataProperty.enum"), exports);
 __exportStar(require("./riskContributor.type"), exports);
 __exportStar(require("./saasComponentKind"), exports);
 __exportStar(require("./workflowStep.kind"), exports);
-__exportStar(require("./contentStrategy.kind"), exports);
-__exportStar(require("./deliveryStrategy.kind"), exports);
+__exportStar(require("./workflowTrigger.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,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,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,yDAAuC;AACvC,0DAAwC;AACxC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,8DAA4C;AAC5C,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC"}

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

@@ -1,8 +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 { FindingOutcome, FindingSeverity, FindingStatus } from './enums';
 import { SimpleProviderDto } from './providers.dto';
 import { SimpleUserDto } from './users.dto';
 export type FindingsStatusPathDto = {

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

@@ -26,6 +26,15 @@ export type RawVulnerabilityContext = {
     description?: string;
     solution?: string;
 };
+export type RawGroupSummary = {
+    id: string;
+    name: string;
+};
+export type RawGroupsContext = {
+    exec: RawGroupSummary[];
+    priv: RawGroupSummary[];
+    prod: RawGroupSummary[];
+};
 export type RawFindingsContext = {
     /**
      * Uses styling to display the finding in the UI
@@ -50,6 +59,7 @@ export type SaasComponentMeta = {
     _user?: RawUserIds;
     _training?: RawTrainingContext;
     _vulnerability?: RawVulnerabilityContext;
+    _groups?: RawGroupsContext;
     [propName: string]: unknown;
 };
 export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "45.3.0",
+  "version": "45.5.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",
   "scripts": {
-    "dev": "tsc --watch",
+    "start:dev": "tsc --watch",
     "prebuild": "rimraf build",
     "build": "tsc",
     "predocs": "rimraf public",

package/src/dto/enums/findingKind.ts

@@ -1,3 +1,5 @@
+import {FindingOutcome} from './finding.outcome';
+
 /* eslint-disable no-unused-vars */
 export enum FindingKind {
   // ALL
@@ -20,3 +22,27 @@ export enum FindingKind {
   // WEB_GATEWAY
   WEB_GATEWAY_NOT_ACTIVE = 'WEB_GATEWAY_NOT_ACTIVE',
 }
+
+export const lookupFindingOutcomeByKind = (kind: FindingKind): FindingOutcome => {
+  switch (kind) {
+    case FindingKind.NO_ACCOUNT:
+    case FindingKind.MFA_NOT_ENABLED:
+    case FindingKind.TRAINING_OVERDUE:
+    case FindingKind.DEVICE_NOT_MANAGED:
+    case FindingKind.VULNERABILITY_OUT_OF_SLA:
+    case FindingKind.WEB_GATEWAY_NOT_ACTIVE: {
+      return FindingOutcome.REMEDIATION;
+    }
+    case FindingKind.IS_EXECUTIVE:
+    case FindingKind.HAS_PRODUCTION_ACCESS:
+    case FindingKind.HAS_PRIVILEGED_ACCESS: {
+      return FindingOutcome.AWARENESS;
+    }
+    case FindingKind.FAILED_PHISHING: {
+      return FindingOutcome.EDUCATION;
+    }
+    default: {
+      throw new Error(`Unable to lookup desired outcome for finding kind: ${kind}`);
+    }
+  }
+};

package/src/dto/enums/index.ts

@@ -3,14 +3,17 @@ export * from './agent.status';
 export * from './ampSettingKeys.enum';
 export * from './category';
 export * from './connector.status';
+export * from './contentStrategy.kind';
+export * from './deliveryStrategy.kind';
 export * from './findingKind';
 export * from './finding.severity';
 export * from './finding.status';
+export * from './finding.outcome';
 export * from './globalUser.type';
 export * from './jobExecution.status';
 export * from './notification.status';
+export * from './requiredDataProperty.enum';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './contentStrategy.kind';
-export * from './deliveryStrategy.kind';
+export * from './workflowTrigger.kind';

package/src/dto/findings.dto.ts

@@ -1,8 +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 {FindingOutcome, FindingSeverity, FindingStatus} from './enums';
 import {SimpleProviderDto} from './providers.dto';
 import {SimpleUserDto} from './users.dto';
 

package/src/dto/saasComponents.dto.ts

@@ -31,6 +31,17 @@ export type RawVulnerabilityContext = {
   solution?: string;
 };
 
+export type RawGroupSummary = {
+  id: string;
+  name: string;
+};
+
+export type RawGroupsContext = {
+  exec: RawGroupSummary[];
+  priv: RawGroupSummary[];
+  prod: RawGroupSummary[];
+};
+
 export type RawFindingsContext = {
   /**
    * Uses styling to display the finding in the UI
@@ -56,6 +67,7 @@ export type SaasComponentMeta = {
   _user?: RawUserIds;
   _training?: RawTrainingContext;
   _vulnerability?: RawVulnerabilityContext;
+  _groups?: RawGroupsContext;
   [propName: string]: unknown;
 };