@ampsec/platform-client 51.1.0 → 52.0.0

package/build/src/dto/enums/callToAction.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum CallToAction {
+    CONTACT_SECURITY = "CONTACT_SECURITY",
+    HELP = "HELP",
+    MARK_COMPLETE = "MARK_COMPLETE"
+}

package/build/src/dto/enums/callToAction.enum.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallToAction = void 0;
+/* eslint-disable no-unused-vars */
+var CallToAction;
+(function (CallToAction) {
+    CallToAction["CONTACT_SECURITY"] = "CONTACT_SECURITY";
+    CallToAction["HELP"] = "HELP";
+    CallToAction["MARK_COMPLETE"] = "MARK_COMPLETE";
+})(CallToAction || (exports.CallToAction = CallToAction = {}));
+//# sourceMappingURL=callToAction.enum.js.map

package/build/src/dto/enums/callToAction.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"callToAction.enum.js","sourceRoot":"","sources":["../../../../src/dto/enums/callToAction.enum.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qDAAqC,CAAA;IACrC,6BAAa,CAAA;IACb,+CAA+B,CAAA;AACjC,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}

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

@@ -0,0 +1,3 @@
+export type Contact = {
+    email: string;
+};

package/build/src/dto/{messagingChannels/slackMessage.dto.js → enums/contact.type.js}

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

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

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

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

@@ -1,8 +1,10 @@
 export * from './auth.role';
 export * from './agent.status';
 export * from './ampSettingKeys.enum';
+export * from './callToAction.enum';
 export * from './category';
 export * from './connector.status';
+export * from './contact.type';
 export * from './contentStrategy.kind';
 export * from './deliveryStrategy.kind';
 export * from './findingKind';

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

@@ -17,8 +17,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth.role"), exports);
 __exportStar(require("./agent.status"), exports);
 __exportStar(require("./ampSettingKeys.enum"), exports);
+__exportStar(require("./callToAction.enum"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./connector.status"), exports);
+__exportStar(require("./contact.type"), exports);
 __exportStar(require("./contentStrategy.kind"), exports);
 __exportStar(require("./deliveryStrategy.kind"), exports);
 __exportStar(require("./findingKind"), exports);

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,yDAAuC;AACvC,0DAAwC;AACxC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,8DAA4C;AAC5C,yDAAuC;AACvC,sDAAoC;AACpC,qEAAmD;AACnD,sDAAoC;AACpC,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,wDAAsC;AACtC,sDAAoC;AACpC,6CAA2B;AAC3B,qDAAmC;AACnC,iDAA+B;AAC/B,yDAAuC;AACvC,0DAAwC;AACxC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,8DAA4C;AAC5C,yDAAuC;AACvC,sDAAoC;AACpC,qEAAmD;AACnD,sDAAoC;AACpC,yDAAuC"}

package/build/src/dto/messagingChannels/channelMessage.dto.d.ts

@@ -0,0 +1,24 @@
+import { CallToAction } from '../enums';
+import { Notifiable } from './notifiable.dto';
+export type MessageContent = {
+    /** Header of the message */
+    header?: string;
+    /** Body of the message */
+    body: string;
+    /** Additional information to be included in the message */
+    additionalInfo?: string[];
+};
+export type ChannelMessageDto = Notifiable & {
+    /** Slack user IDs to which the notification is being sent */
+    users: string[] | number[];
+    /** Message content to be sent in the Slack message */
+    content: MessageContent;
+    /** ID of the tenant to which the notification belongs: required if the notificaiton should allow for the user to contact the security or IT team */
+    tid: string;
+    /** ID of the finding to which the notification is in regards to: required if the notification should allow for the user marking a finding as complete */
+    fid?: string;
+    /** Metadata for the message */
+    meta?: unknown;
+    /** Calls to action to be included in the message */
+    actions: CallToAction[];
+};

package/build/src/dto/messagingChannels/channelMessage.dto.js

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

package/build/src/dto/messagingChannels/channelMessage.dto.js.map

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

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

@@ -1,3 +1,3 @@
-export * from './slackMessage.dto';
+export * from './channelMessage.dto';
 export * from './email.dto';
 export * from './notifiable.dto';

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

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./slackMessage.dto"), exports);
+__exportStar(require("./channelMessage.dto"), exports);
 __exportStar(require("./email.dto"), exports);
 __exportStar(require("./notifiable.dto"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/messagingChannels/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,8CAA4B;AAC5B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/messagingChannels/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,8CAA4B;AAC5B,mDAAiC"}

package/build/src/settings.d.ts

@@ -1,3 +1,4 @@
+import { Contact } from './dto';
 /**
  * Collection of hard coded settings to be use centrally across services and user interfaces.
  *
@@ -27,6 +28,8 @@ export declare const AMP_SETTINGS: {
         GHOST_MODE: import("./services").TypedAmpSettingsKey<boolean>;
         /** Enables mock providers on the tenant. */
         ENABLE_MOCKS: import("./services").TypedAmpSettingsKey<boolean>;
+        /** Email address for the tenant's IT/Security team */
+        IT_SECURITY_CONTACT: import("./services").TypedAmpSettingsKey<Contact | undefined>;
         /**
          * Specifies which mock tenant to use.
          *   - `david`: single insecure user

package/build/src/settings.js

@@ -12,9 +12,11 @@ const services_1 = require("./services");
  */
 const TENANT_SETTINGS = {
     /** Disables all automated messages from being sent to end users. */
-    GHOST_MODE: services_1.AmpSettingsMap.asKey('notifications.ghostMode.enabled', false),
+    GHOST_MODE: services_1.AmpSettingsMap.asKey('notifications.ghostMode.enabled', true),
     /** Enables mock providers on the tenant. */
     ENABLE_MOCKS: services_1.AmpSettingsMap.asKey('mocks.enabled', false),
+    /** Email address for the tenant's IT/Security team */
+    IT_SECURITY_CONTACT: services_1.AmpSettingsMap.asKey('tenant.itSecurityContact'),
     /**
      * Specifies which mock tenant to use.
      *   - `david`: single insecure user

package/build/src/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/settings.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAE1C;;2BAE2B;AAC3B;;;;GAIG;AACH,MAAM,eAAe,GAAG;IACtB,oEAAoE;IACpE,UAAU,EAAE,yBAAc,CAAC,KAAK,CAAU,iCAAiC,EAAE,KAAK,CAAC;IACnF,4CAA4C;IAC5C,YAAY,EAAE,yBAAc,CAAC,KAAK,CAAU,eAAe,EAAE,KAAK,CAAC;IACnE;;;;;;;OAOG;IACH,cAAc,EAAE,yBAAc,CAAC,KAAK,CAAS,iBAAiB,EAAE,SAAS,CAAC;CAC3E,CAAC;AAEF;;;GAGG;AACH,MAAM,iCAAiC,GAAG;IACxC,0CAA0C;IAC1C,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAU,uBAAuB,EAAE,KAAK,CAAC;CACrF,CAAC;AAEF;;sBAEsB;AACtB,MAAM,eAAe,GAAG;IACtB,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IACxF,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IAC1F,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IAC1F,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,+BAA+B,EAAE,EAAE,CAAC;CAC7F,CAAC;AAEF,MAAM,aAAa,GAAG;IACpB,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACpF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACtF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACtF,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,6BAA6B,EAAE,EAAE,CAAC;CACzF,CAAC;AAEF,MAAM,cAAc,GAAG;IACrB,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACtF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACxF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACxF,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,8BAA8B,EAAE,EAAE,CAAC;IAC1F,8BAA8B,EAAE,yBAAc,CAAC,KAAK,CAAqB,+BAA+B,CAAC;IACzG,6GAA6G;IAC7G,+BAA+B,EAAE,yBAAc,CAAC,KAAK,CACnD,iCAAiC,EACjC,oHAAoH,CACrH;CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACU,QAAA,YAAY,GAAG;IAC1B;;;;OAIG;IACH,MAAM,EAAE;QACN,GAAG,eAAe;QAClB,4EAA4E;QAC5E,iCAAiC,EAAE,yBAAc,CAAC,KAAK,CAAqB,sCAAsC,CAAC;KACpH;IACD;;;OAGG;IACH,iBAAiB,EAAE;QACjB,GAAG,iCAAiC;KACrC;IACD;;0BAEsB;IACtB,MAAM,EAAE,EAAC,GAAG,eAAe,EAAC;IAC5B,IAAI,EAAE,EAAC,GAAG,aAAa,EAAC;IACxB,KAAK,EAAE,EAAC,GAAG,cAAc,EAAC;CAC3B,CAAC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/settings.ts"],"names":[],"mappings":";;;AACA,yCAA0C;AAE1C;;2BAE2B;AAC3B;;;;GAIG;AACH,MAAM,eAAe,GAAG;IACtB,oEAAoE;IACpE,UAAU,EAAE,yBAAc,CAAC,KAAK,CAAU,iCAAiC,EAAE,IAAI,CAAC;IAClF,4CAA4C;IAC5C,YAAY,EAAE,yBAAc,CAAC,KAAK,CAAU,eAAe,EAAE,KAAK,CAAC;IACnE,sDAAsD;IACtD,mBAAmB,EAAE,yBAAc,CAAC,KAAK,CAAsB,0BAA0B,CAAC;IAC1F;;;;;;;OAOG;IACH,cAAc,EAAE,yBAAc,CAAC,KAAK,CAAS,iBAAiB,EAAE,SAAS,CAAC;CAC3E,CAAC;AAEF;;;GAGG;AACH,MAAM,iCAAiC,GAAG;IACxC,0CAA0C;IAC1C,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAU,uBAAuB,EAAE,KAAK,CAAC;CACrF,CAAC;AAEF;;sBAEsB;AACtB,MAAM,eAAe,GAAG;IACtB,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IACxF,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IAC1F,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;IAC1F,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,+BAA+B,EAAE,EAAE,CAAC;CAC7F,CAAC;AAEF,MAAM,aAAa,GAAG;IACpB,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACpF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACtF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;IACtF,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,6BAA6B,EAAE,EAAE,CAAC;CACzF,CAAC;AAEF,MAAM,cAAc,GAAG;IACrB,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACtF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACxF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;IACxF,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,8BAA8B,EAAE,EAAE,CAAC;IAC1F,8BAA8B,EAAE,yBAAc,CAAC,KAAK,CAAqB,+BAA+B,CAAC;IACzG,6GAA6G;IAC7G,+BAA+B,EAAE,yBAAc,CAAC,KAAK,CACnD,iCAAiC,EACjC,oHAAoH,CACrH;CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACU,QAAA,YAAY,GAAG;IAC1B;;;;OAIG;IACH,MAAM,EAAE;QACN,GAAG,eAAe;QAClB,4EAA4E;QAC5E,iCAAiC,EAAE,yBAAc,CAAC,KAAK,CAAqB,sCAAsC,CAAC;KACpH;IACD;;;OAGG;IACH,iBAAiB,EAAE;QACjB,GAAG,iCAAiC;KACrC;IACD;;0BAEsB;IACtB,MAAM,EAAE,EAAC,GAAG,eAAe,EAAC;IAC5B,IAAI,EAAE,EAAC,GAAG,aAAa,EAAC;IACxB,KAAK,EAAE,EAAC,GAAG,cAAc,EAAC;CAC3B,CAAC"}

package/package.json

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

package/src/dto/enums/callToAction.enum.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export enum CallToAction {
+  CONTACT_SECURITY = 'CONTACT_SECURITY',
+  HELP = 'HELP',
+  MARK_COMPLETE = 'MARK_COMPLETE',
+}

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

@@ -0,0 +1,4 @@
+/* eslint-disable no-unused-vars */
+export type Contact = {
+  email: string;
+};

package/src/dto/enums/index.ts

@@ -1,8 +1,10 @@
 export * from './auth.role';
 export * from './agent.status';
 export * from './ampSettingKeys.enum';
+export * from './callToAction.enum';
 export * from './category';
 export * from './connector.status';
+export * from './contact.type';
 export * from './contentStrategy.kind';
 export * from './deliveryStrategy.kind';
 export * from './findingKind';

package/src/dto/messagingChannels/channelMessage.dto.ts

@@ -0,0 +1,26 @@
+import {CallToAction} from '../enums';
+import {Notifiable} from './notifiable.dto';
+
+export type MessageContent = {
+  /** Header of the message */
+  header?: string;
+  /** Body of the message */
+  body: string;
+  /** Additional information to be included in the message */
+  additionalInfo?: string[];
+};
+
+export type ChannelMessageDto = Notifiable & {
+  /** Slack user IDs to which the notification is being sent */
+  users: string[] | number[];
+  /** Message content to be sent in the Slack message */
+  content: MessageContent;
+  /** ID of the tenant to which the notification belongs: required if the notificaiton should allow for the user to contact the security or IT team */
+  tid: string;
+  /** ID of the finding to which the notification is in regards to: required if the notification should allow for the user marking a finding as complete */
+  fid?: string;
+  /** Metadata for the message */
+  meta?: unknown;
+  /** Calls to action to be included in the message */
+  actions: CallToAction[];
+};

package/src/dto/messagingChannels/index.ts

@@ -1,3 +1,3 @@
-export * from './slackMessage.dto';
+export * from './channelMessage.dto';
 export * from './email.dto';
 export * from './notifiable.dto';

package/src/settings.ts

@@ -1,3 +1,4 @@
+import {Contact} from './dto';
 import {AmpSettingsMap} from './services';
 
 /**************************
@@ -10,9 +11,11 @@ import {AmpSettingsMap} from './services';
  */
 const TENANT_SETTINGS = {
   /** Disables all automated messages from being sent to end users. */
-  GHOST_MODE: AmpSettingsMap.asKey<boolean>('notifications.ghostMode.enabled', false), // TODO enble by default
+  GHOST_MODE: AmpSettingsMap.asKey<boolean>('notifications.ghostMode.enabled', true),
   /** Enables mock providers on the tenant. */
   ENABLE_MOCKS: AmpSettingsMap.asKey<boolean>('mocks.enabled', false),
+  /** Email address for the tenant's IT/Security team */
+  IT_SECURITY_CONTACT: AmpSettingsMap.asKey<Contact | undefined>('tenant.itSecurityContact'),
   /**
    * Specifies which mock tenant to use.
    *   - `david`: single insecure user

package/build/src/dto/messagingChannels/slackMessage.dto.d.ts

@@ -1,9 +0,0 @@
-import { Notifiable } from './notifiable.dto';
-export type SlackMessageDto = Notifiable & {
-    /** ID of the Slack team to which the user(s) belong */
-    teamId: string;
-    /** Slack user IDs to which the notification is being sent */
-    users: string[];
-    /** Message to be sent to the users */
-    message: string;
-};

package/build/src/dto/messagingChannels/slackMessage.dto.js.map

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

package/src/dto/messagingChannels/slackMessage.dto.ts

@@ -1,10 +0,0 @@
-import {Notifiable} from './notifiable.dto';
-
-export type SlackMessageDto = Notifiable & {
-  /** ID of the Slack team to which the user(s) belong */
-  teamId: string;
-  /** Slack user IDs to which the notification is being sent */
-  users: string[];
-  /** Message to be sent to the users */
-  message: string;
-};