@ampsec/platform-client 52.0.0 → 54.0.0

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

@@ -0,0 +1,6 @@
+export type DefaultConnectorDto = {
+    /** ID of the connector for the default messaging integration */
+    cid: string;
+    /** Display value of the connector for the default messaging integration */
+    displayValue: string;
+};

package/build/src/dto/defaultConnector.dto.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"defaultConnector.dto.js","sourceRoot":"","sources":["../../../src/dto/defaultConnector.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 './defaultConnector.dto';
 export * from './entityIdSummaries.dto';
 export * from './enum.dto';
 export * from './enums';

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("./defaultConnector.dto"), exports);
 __exportStar(require("./entityIdSummaries.dto"), exports);
 __exportStar(require("./enum.dto"), exports);
 __exportStar(require("./enums"), 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,0DAAwC;AACxC,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;AAC/B,sDAAoC"}
+{"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,yDAAuC;AACvC,0DAAwC;AACxC,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;AAC/B,sDAAoC"}

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

@@ -8,6 +8,10 @@ export type MessageContent = {
     /** Additional information to be included in the message */
     additionalInfo?: string[];
 };
+/** We'll need to add additional meta types as other messaging application are supported */
+export type SlackMeta = {
+    teamId: string;
+};
 export type ChannelMessageDto = Notifiable & {
     /** Slack user IDs to which the notification is being sent */
     users: string[] | number[];
@@ -18,7 +22,7 @@ export type ChannelMessageDto = Notifiable & {
     /** 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;
+    meta?: SlackMeta;
     /** Calls to action to be included in the message */
     actions: CallToAction[];
 };

package/build/src/settings.d.ts

@@ -1,4 +1,4 @@
-import { Contact } from './dto';
+import { Contact, DefaultConnectorDto } from './dto';
 /**
  * Collection of hard coded settings to be use centrally across services and user interfaces.
  *
@@ -23,7 +23,7 @@ export declare const AMP_SETTINGS: {
      */
     tenant: {
         /** Specifies the default connector for the `messages` delivery strategy. */
-        DEFAULT_NOTIFICATION_CONNECTOR_ID: import("./services").TypedAmpSettingsKey<string | undefined>;
+        DEFAULT_NOTIFICATION_CONNECTOR_ID: import("./services").TypedAmpSettingsKey<DefaultConnectorDto | undefined>;
         /** Disables all automated messages from being sent to end users. */
         GHOST_MODE: import("./services").TypedAmpSettingsKey<boolean>;
         /** Enables mock providers on the tenant. */

package/build/src/settings.js

@@ -84,7 +84,7 @@ exports.AMP_SETTINGS = {
     tenant: {
         ...TENANT_SETTINGS,
         /** Specifies the default connector for the `messages` delivery strategy. */
-        DEFAULT_NOTIFICATION_CONNECTOR_ID: services_1.AmpSettingsMap.asKey('notifications.connectors.default.cid'),
+        DEFAULT_NOTIFICATION_CONNECTOR_ID: services_1.AmpSettingsMap.asKey('notifications.connectors.default'),
     },
     /**
      * GLOBAL

package/build/src/settings.js.map

@@ -1 +1 @@
-{"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"}
+{"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,CAAkC,kCAAkC,CAAC;KAC7H;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": "52.0.0",
+  "version": "54.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/defaultConnector.dto.ts

@@ -0,0 +1,6 @@
+export type DefaultConnectorDto = {
+  /** ID of the connector for the default messaging integration */
+  cid: string;
+  /** Display value of the connector for the default messaging integration */
+  displayValue: 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 './defaultConnector.dto';
 export * from './entityIdSummaries.dto';
 export * from './enum.dto';
 export * from './enums';

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

@@ -10,6 +10,11 @@ export type MessageContent = {
   additionalInfo?: string[];
 };
 
+/** We'll need to add additional meta types as other messaging application are supported */
+export type SlackMeta = {
+  teamId: string;
+};
+
 export type ChannelMessageDto = Notifiable & {
   /** Slack user IDs to which the notification is being sent */
   users: string[] | number[];
@@ -20,7 +25,7 @@ export type ChannelMessageDto = Notifiable & {
   /** 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;
+  meta?: SlackMeta;
   /** Calls to action to be included in the message */
   actions: CallToAction[];
 };

package/src/settings.ts

@@ -1,4 +1,4 @@
-import {Contact} from './dto';
+import {Contact, DefaultConnectorDto} from './dto';
 import {AmpSettingsMap} from './services';
 
 /**************************
@@ -91,7 +91,7 @@ export const AMP_SETTINGS = {
   tenant: {
     ...TENANT_SETTINGS,
     /** Specifies the default connector for the `messages` delivery strategy. */
-    DEFAULT_NOTIFICATION_CONNECTOR_ID: AmpSettingsMap.asKey<string | undefined>('notifications.connectors.default.cid'),
+    DEFAULT_NOTIFICATION_CONNECTOR_ID: AmpSettingsMap.asKey<DefaultConnectorDto | undefined>('notifications.connectors.default'),
   },
   /**
    * GLOBAL