@ampsec/platform-client 50.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/services/rest/ConnectorInstallService.d.ts

@@ -6,7 +6,11 @@ export declare class ConnectorInstallService {
     credentials: (cid: string, credentials: {
         [key: string]: unknown;
     }) => Promise<boolean>;
+    getOauthInstallUrl: (cid: string, provider: string, clientRedirectUrl: string) => Promise<string>;
+    /** @deprecated */
     getInstallToken: (cid: string) => Promise<string>;
+    /** @deprecated */
     getRedirectUrl: (token: string) => Promise<string>;
+    /** @deprecated */
     buildInstallOAuthUrl: (token: string, redirectUrl: string) => string;
 }

package/build/src/services/rest/ConnectorInstallService.js

@@ -12,6 +12,16 @@ class ConnectorInstallService {
             const success = res.data.success;
             return success;
         };
+        this.getOauthInstallUrl = async (cid, provider, clientRedirectUrl) => {
+            const res = await this.rest.call({
+                url: `/${this.targetApi}/v1/install/oauth/token`,
+                method: 'POST',
+                data: { cid },
+            });
+            const token = res.data.token;
+            return `${this.rest.baseUrl}/${this.targetApi}/v1/install/oauth/${provider}/login?token=${token}&redirectUrl=${encodeURIComponent(clientRedirectUrl)}`;
+        };
+        /** @deprecated */
         this.getInstallToken = async (cid) => {
             const res = await this.rest.call({
                 url: `/${this.targetApi}/v1/install/oauth/token`,
@@ -21,6 +31,7 @@ class ConnectorInstallService {
             const token = res.data.token;
             return token;
         };
+        /** @deprecated */
         this.getRedirectUrl = async (token) => {
             const res = await this.rest.call({
                 url: `/${this.targetApi}/v1/install/oauth/login`,
@@ -30,6 +41,7 @@ class ConnectorInstallService {
             const redirectUrl = res.data.redirect;
             return redirectUrl;
         };
+        /** @deprecated */
         this.buildInstallOAuthUrl = (token, redirectUrl) => {
             return `/${this.targetApi}/v1/install/oauth?token=${token}&redirect=${encodeURIComponent(redirectUrl)}`;
         };

package/build/src/services/rest/ConnectorInstallService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConnectorInstallService.js","sourceRoot":"","sources":["../../../../src/services/rest/ConnectorInstallService.ts"],"names":[],"mappings":";;;AAEA,MAAa,uBAAuB;IAIlC,YAAY,IAAgB,EAAE,SAAiB;QAK/C,gBAAW,GAAG,KAAK,EAAE,GAAW,EAAE,WAAqC,EAAoB,EAAE;YAC3F,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAC,GAAG,EAAE,WAAW,EAAC;aACzB,CAAC,CAAC;YACH,MAAM,OAAO,GAAI,GAAG,CAAC,IAA2B,CAAC,OAAO,CAAC;YAEzD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;QAEF,oBAAe,GAAG,KAAK,EAAE,GAAW,EAAmB,EAAE;YACvD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAC,GAAG,EAAC;aACZ,CAAC,CAAC;YACH,MAAM,KAAK,GAAI,GAAG,CAAC,IAAwB,CAAC,KAAK,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,mBAAc,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;YACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,EAAC,KAAK,EAAC;aAChB,CAAC,CAAC;YACH,MAAM,WAAW,GAAI,GAAG,CAAC,IAA2B,CAAC,QAAQ,CAAC;YAC9D,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC;QAEF,yBAAoB,GAAG,CAAC,KAAa,EAAE,WAAmB,EAAU,EAAE;YACpE,OAAO,IAAI,IAAI,CAAC,SAAS,2BAA2B,KAAK,aAAa,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC1G,CAAC,CAAC;QArCA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CAoCF;AA3CD,0DA2CC"}
+{"version":3,"file":"ConnectorInstallService.js","sourceRoot":"","sources":["../../../../src/services/rest/ConnectorInstallService.ts"],"names":[],"mappings":";;;AAEA,MAAa,uBAAuB;IAIlC,YAAY,IAAgB,EAAE,SAAiB;QAK/C,gBAAW,GAAG,KAAK,EAAE,GAAW,EAAE,WAAqC,EAAoB,EAAE;YAC3F,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAC,GAAG,EAAE,WAAW,EAAC;aACzB,CAAC,CAAC;YACH,MAAM,OAAO,GAAI,GAAG,CAAC,IAA2B,CAAC,OAAO,CAAC;YAEzD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;QAEF,uBAAkB,GAAG,KAAK,EAAE,GAAW,EAAE,QAAgB,EAAE,iBAAyB,EAAmB,EAAE;YACvG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAC,GAAG,EAAC;aACZ,CAAC,CAAC;YACH,MAAM,KAAK,GAAI,GAAG,CAAC,IAAwB,CAAC,KAAK,CAAC;YAClD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,qBAAqB,QAAQ,gBAAgB,KAAK,gBAAgB,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACzJ,CAAC,CAAC;QAEF,kBAAkB;QAClB,oBAAe,GAAG,KAAK,EAAE,GAAW,EAAmB,EAAE;YACvD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAC,GAAG,EAAC;aACZ,CAAC,CAAC;YACH,MAAM,KAAK,GAAI,GAAG,CAAC,IAAwB,CAAC,KAAK,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,kBAAkB;QAClB,mBAAc,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;YACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,yBAAyB;gBAChD,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,EAAC,KAAK,EAAC;aAChB,CAAC,CAAC;YACH,MAAM,WAAW,GAAI,GAAG,CAAC,IAA2B,CAAC,QAAQ,CAAC;YAC9D,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC;QAEF,kBAAkB;QAClB,yBAAoB,GAAG,CAAC,KAAa,EAAE,WAAmB,EAAU,EAAE;YACpE,OAAO,IAAI,IAAI,CAAC,SAAS,2BAA2B,KAAK,aAAa,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC1G,CAAC,CAAC;QAlDA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CAiDF;AAxDD,0DAwDC"}

package/build/src/services/rest/RestClient.d.ts

@@ -31,6 +31,7 @@ export type RestClientOptions = {
  * RestClient is a generic interface for making REST calls.
  */
 export interface RestClient {
+    baseUrl?: string;
     strict: boolean;
     call(_request: RestRequest): Promise<RestResponse>;
 }
@@ -41,11 +42,12 @@ export interface RestClient {
  *
  * These strategies can be useful when scraping 3rd party APIs.
  */
-export declare class DefaultRestClient {
+export declare class DefaultRestClient implements RestClient {
     protected readonly ampAxios: Axios;
     protected readonly retryStrategy: RestClientRetryStrategy;
     protected readonly rateLimitStrategy: RestClientRateLimitStrategy;
     protected readonly logger: AmpLogger;
+    readonly baseUrl?: string;
     readonly strict: boolean;
     constructor(options?: RestClientOptions);
     call: (request: RestRequest) => Promise<RestResponse>;

package/build/src/services/rest/RestClient.js

@@ -81,7 +81,6 @@ class DefaultRestClient {
                 throw err;
             }
         };
-        // TODO: rest client
         const client = (_a = options.client) !== null && _a !== void 0 ? _a : axios_1.default;
         this.ampAxios = client.create({
             baseURL: options.baseUrl,
@@ -100,6 +99,7 @@ class DefaultRestClient {
         this.ampAxios.defaults.headers.put['Content-Type'] = 'application/json';
         this.retryStrategy = (_d = options.retryStrategy) !== null && _d !== void 0 ? _d : retry_rest_1.noopRestRetryStrategy;
         this.rateLimitStrategy = (_e = options.rateLimitStrategy) !== null && _e !== void 0 ? _e : rateLimit_rest_1.noopRestClientRateLimitStrategy;
+        this.baseUrl = options.baseUrl;
         this.strict = (_f = options.strict) !== null && _f !== void 0 ? _f : false;
     }
 }

package/build/src/services/rest/RestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../../../../src/services/rest/RestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,4CAAoB;AACpB,+CAA4D;AAG5D,6CAA4E;AAC5E,mCAAmD;AACnD,qDAAiI;AACjI,2CAAoD;AAkCpD;;;;;;GAMG;AACH,MAAa,iBAAiB;IAO5B,YAAY,UAA6B,EAAE;;QAqB3C,SAAI,GAAG,KAAK,EAAE,OAAoB,EAAyB,EAAE;;YAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,IAAI;gBACF,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC,yBAAyB;gBACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE;oBACpC,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,UAAU,iBAAiB,CAAC,CAAC;iBACrE;gBACD,OAAO;oBACL,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,OAAO,EAAE,IAAA,sBAAc,EAAC,GAAG,CAAC;oBAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,KAAK,EAAE,IAAI;iBACZ,CAAC;aACH;YAAC,OAAO,GAAY,EAAE;gBACrB,IAAI,GAAG,YAAY,kBAAU,EAAE;oBAC7B,MAAM,UAAU,GAAG,GAAiB,CAAC;oBACrC,MAAM,MAAM,GAAG,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG,CAAC;oBAClD,iGAAiG;oBACjG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBACvD,iGAAiG;oBACjG,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,IAAI,GAAG,EAAE;wBAChC,MAAM,IAAI,KAAK,CAAC,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;qBACrE;oBACD,OAAO;wBACL,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;wBACvE,IAAI,EAAE,IAAI;wBACV,KAAK,EAAE,GAAG;qBACX,CAAC;iBACH;gBACD,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAC;QAtDA,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,eAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,gBAAgB,EAAE,MAAM,CAAC,EAAE;gBACzB,OAAO,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC,CAAC;YACvD,CAAC;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;;YAC/C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAA,OAAO,CAAC,OAAO,0CAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,oBAAU,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACzE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,kCAAqB,CAAC;QACpE,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,gDAA+B,CAAC;QACtF,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,KAAK,CAAC;IACxC,CAAC;CAoCF;AA/DD,8CA+DC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAc,EAAE;IAC5E,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;SACzC;QACD,iBAAiB,EAAE,IAAI,kDAAiC,CAAC,EAAE,CAAC;QAC5D,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAZW,QAAA,gBAAgB,oBAY3B"}
+{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../../../../src/services/rest/RestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,4CAAoB;AACpB,+CAA4D;AAG5D,6CAA4E;AAC5E,mCAAmD;AACnD,qDAAiI;AACjI,2CAAoD;AAmCpD;;;;;;GAMG;AACH,MAAa,iBAAiB;IAQ5B,YAAY,UAA6B,EAAE;;QAqB3C,SAAI,GAAG,KAAK,EAAE,OAAoB,EAAyB,EAAE;;YAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,IAAI;gBACF,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC,yBAAyB;gBACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE;oBACpC,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,UAAU,iBAAiB,CAAC,CAAC;iBACrE;gBACD,OAAO;oBACL,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,OAAO,EAAE,IAAA,sBAAc,EAAC,GAAG,CAAC;oBAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,KAAK,EAAE,IAAI;iBACZ,CAAC;aACH;YAAC,OAAO,GAAY,EAAE;gBACrB,IAAI,GAAG,YAAY,kBAAU,EAAE;oBAC7B,MAAM,UAAU,GAAG,GAAiB,CAAC;oBACrC,MAAM,MAAM,GAAG,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG,CAAC;oBAClD,iGAAiG;oBACjG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBACvD,iGAAiG;oBACjG,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,IAAI,GAAG,EAAE;wBAChC,MAAM,IAAI,KAAK,CAAC,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;qBACrE;oBACD,OAAO;wBACL,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;wBACvE,IAAI,EAAE,IAAI;wBACV,KAAK,EAAE,GAAG;qBACX,CAAC;iBACH;gBACD,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAC;QAtDA,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,eAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,gBAAgB,EAAE,MAAM,CAAC,EAAE;gBACzB,OAAO,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC,CAAC;YACvD,CAAC;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;;YAC/C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAA,OAAO,CAAC,OAAO,0CAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,oBAAU,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACzE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,kCAAqB,CAAC;QACpE,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,gDAA+B,CAAC;QACtF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,KAAK,CAAC;IACxC,CAAC;CAoCF;AAhED,8CAgEC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAc,EAAE;IAC5E,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;SACzC;QACD,iBAAiB,EAAE,IAAI,kDAAiC,CAAC,EAAE,CAAC;QAC5D,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAZW,QAAA,gBAAgB,oBAY3B"}

package/build/src/settings.d.ts

@@ -1,8 +1,9 @@
+import { Contact } from './dto';
 /**
  * Collection of hard coded settings to be use centrally across services and user interfaces.
  *
  * # Naming convention:
- * Keys should be name spaced following dot notation, e.g. notifications.ghost_mode.enabled`.
+ * Keys should be name spaced following dot notation and camel case, e.g. notifications.ghostMode.enabled`.
  *
  * ## Use Cases
  * 1. Boolean "enabled" toggles should end in `*.enabled`. You should never use the inverse `*.disabled`
@@ -21,10 +22,14 @@ export declare const AMP_SETTINGS: {
      * These are tenant level settings that are not meant to be overridden at the connector level
      */
     tenant: {
+        /** Specifies the default connector for the `messages` delivery strategy. */
+        DEFAULT_NOTIFICATION_CONNECTOR_ID: import("./services").TypedAmpSettingsKey<string | undefined>;
         /** Disables all automated messages from being sent to end users. */
         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
@@ -34,14 +39,12 @@ export declare const AMP_SETTINGS: {
          *   - `ingen`: mocked data for ~250 users
          */
         MOCK_TENANT_ID: import("./services").TypedAmpSettingsKey<string>;
-        /** Specifies the default connector for the `messages` delivery strategy. */
-        DEFAULT_NOTIFICATION_CONNECTOR_ID: import("./services").TypedAmpSettingsKey<string | undefined>;
     };
     /**
      * GLOBAL
      * Note: these can be overridden by connector level settings
      */
-    inherited: {
+    connectorDefaults: {
         /** Not currently implemented/respected */
         NOTIFICATIONS_ENABLED: import("./services").TypedAmpSettingsKey<boolean>;
     };

package/build/src/settings.js

@@ -2,12 +2,68 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AMP_SETTINGS = void 0;
 const services_1 = require("./services");
-// TODO document this object
+/**************************
+ *     GLOBAL SETTINGS    *
+ *************************/
+/**
+ * GLOBAL ONLY
+ * ===========
+ * These are tenant level settings that are not meant to be overridden at the connector level
+ */
+const TENANT_SETTINGS = {
+    /** Disables all automated messages from being sent to end users. */
+    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
+     *   - `ampsec`: founding team of amplifier security with mock data
+     *   - `stryper`: branded small test tenant
+     *   - `acme`: mocked data for ~25 users
+     *   - `ingen`: mocked data for ~250 users
+     */
+    MOCK_TENANT_ID: services_1.AmpSettingsMap.asKey('mocks.tenant.id', 'stryper'),
+};
+/**
+ * GLOBAL CONNECTOR DEFAULTS
+ * Note: these can be overridden by connector level settings
+ */
+const GLOBAL_CONNECTOR_DEFAULT_SETTINGS = {
+    /** Not currently implemented/respected */
+    NOTIFICATIONS_ENABLED: services_1.AmpSettingsMap.asKey('notifications.enabled', false),
+};
+/********************
+ *     PROVIDERS    *
+ ********************/
+const GOOGLE_SETTINGS = {
+    GOOGLE_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.exec.extIds', []),
+    GOOGLE_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.prod.extIds', []),
+    GOOGLE_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.priv.extIds', []),
+    GOOGLE_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.servAcct.extIds', []),
+};
+const OKTA_SETTINGS = {
+    OKTA_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.exec.extIds', []),
+    OKTA_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.prod.extIds', []),
+    OKTA_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.priv.extIds', []),
+    OKTA_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.servAcct.extIds', []),
+};
+const SLACK_SETTINGS = {
+    SLACK_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.exec.extIds', []),
+    SLACK_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.prod.extIds', []),
+    SLACK_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.priv.extIds', []),
+    SLACK_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.servAcct.extIds', []),
+    SLACK_CONTACT_SECURITY_CHANNEL: services_1.AmpSettingsMap.asKey('slack.channels.security.extId'),
+    // TODO localization... does this get moved to contentful? Does the setting "point" to content in contentful?
+    SLACK_CONTACT_SECURITY_TEMPLATE: services_1.AmpSettingsMap.asKey('slack.templates.contactSecurity', 'Thanks for getting in touch! We forwarded your message to our security team and they will get back to you shortly.'),
+};
 /**
  * Collection of hard coded settings to be use centrally across services and user interfaces.
  *
  * # Naming convention:
- * Keys should be name spaced following dot notation, e.g. notifications.ghost_mode.enabled`.
+ * Keys should be name spaced following dot notation and camel case, e.g. notifications.ghostMode.enabled`.
  *
  * ## Use Cases
  * 1. Boolean "enabled" toggles should end in `*.enabled`. You should never use the inverse `*.disabled`
@@ -26,19 +82,7 @@ exports.AMP_SETTINGS = {
      * These are tenant level settings that are not meant to be overridden at the connector level
      */
     tenant: {
-        /** Disables all automated messages from being sent to end users. */
-        GHOST_MODE: services_1.AmpSettingsMap.asKey('notifications.ghost_mode.enabled', false),
-        /** Enables mock providers on the tenant. */
-        ENABLE_MOCKS: services_1.AmpSettingsMap.asKey('mocks.enabled', false),
-        /**
-         * Specifies which mock tenant to use.
-         *   - `david`: single insecure user
-         *   - `ampsec`: founding team of amplifier security with mock data
-         *   - `stryper`: branded small test tenant
-         *   - `acme`: mocked data for ~25 users
-         *   - `ingen`: mocked data for ~250 users
-         */
-        MOCK_TENANT_ID: services_1.AmpSettingsMap.asKey('mocks.tenant.id', 'stryper'),
+        ...TENANT_SETTINGS,
         /** Specifies the default connector for the `messages` delivery strategy. */
         DEFAULT_NOTIFICATION_CONNECTOR_ID: services_1.AmpSettingsMap.asKey('notifications.connectors.default.cid'),
     },
@@ -46,33 +90,14 @@ exports.AMP_SETTINGS = {
      * GLOBAL
      * Note: these can be overridden by connector level settings
      */
-    inherited: {
-        /** Not currently implemented/respected */
-        NOTIFICATIONS_ENABLED: services_1.AmpSettingsMap.asKey('notifications.enabled', false),
+    connectorDefaults: {
+        ...GLOBAL_CONNECTOR_DEFAULT_SETTINGS,
     },
     /********************
      *     PROVIDERS    *
      ********************/
-    google: {
-        GOOGLE_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.exec.extIds', []),
-        GOOGLE_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.prod.extIds', []),
-        GOOGLE_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.priv.extIds', []),
-        GOOGLE_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('google.groups.serv_acct.extIds', []),
-    },
-    okta: {
-        OKTA_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.exec.extIds', []),
-        OKTA_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.prod.extIds', []),
-        OKTA_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.priv.extIds', []),
-        OKTA_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('okta.groups.serv_acct.extIds', []),
-    },
-    slack: {
-        SLACK_EXECUTIVE_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.exec.extIds', []),
-        SLACK_PROD_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.prod.extIds', []),
-        SLACK_PRIV_ACCESS_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.priv.extIds', []),
-        SLACK_SERV_ACCT_GROUPS: services_1.AmpSettingsMap.asKey('slack.groups.serv_acct.extIds', []),
-        SLACK_CONTACT_SECURITY_CHANNEL: services_1.AmpSettingsMap.asKey('slack.channels.contact_security.extId'),
-        // TODO localization... does this get moved to contentful? Does the setting "point" to content in contentful?
-        SLACK_CONTACT_SECURITY_TEMPLATE: services_1.AmpSettingsMap.asKey('slack.templates.contact_security', 'Thanks for getting in touch! We forwarded your message to our security team and they will get back to you shortly.'),
-    },
+    google: { ...GOOGLE_SETTINGS },
+    okta: { ...OKTA_SETTINGS },
+    slack: { ...SLACK_SETTINGS },
 };
 //# sourceMappingURL=settings.js.map

package/build/src/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/settings.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAE1C,4BAA4B;AAC5B;;;;;;;;;;;;;;;GAeG;AACU,QAAA,YAAY,GAAG;IAC1B;;;;OAIG;IACH,MAAM,EAAE;QACN,oEAAoE;QACpE,UAAU,EAAE,yBAAc,CAAC,KAAK,CAAU,kCAAkC,EAAE,KAAK,CAAC;QACpF,4CAA4C;QAC5C,YAAY,EAAE,yBAAc,CAAC,KAAK,CAAU,eAAe,EAAE,KAAK,CAAC;QACnE;;;;;;;WAOG;QACH,cAAc,EAAE,yBAAc,CAAC,KAAK,CAAS,iBAAiB,EAAE,SAAS,CAAC;QAC1E,4EAA4E;QAC5E,iCAAiC,EAAE,yBAAc,CAAC,KAAK,CAAqB,sCAAsC,CAAC;KACpH;IACD;;;OAGG;IACH,SAAS,EAAE;QACT,0CAA0C;QAC1C,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAU,uBAAuB,EAAE,KAAK,CAAC;KACrF;IACD;;0BAEsB;IACtB,MAAM,EAAE;QACN,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;QACxF,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;QAC1F,yBAAyB,EAAE,yBAAc,CAAC,KAAK,CAAW,2BAA2B,EAAE,EAAE,CAAC;QAC1F,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,gCAAgC,EAAE,EAAE,CAAC;KAC9F;IACD,IAAI,EAAE;QACJ,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;QACpF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;QACtF,uBAAuB,EAAE,yBAAc,CAAC,KAAK,CAAW,yBAAyB,EAAE,EAAE,CAAC;QACtF,qBAAqB,EAAE,yBAAc,CAAC,KAAK,CAAW,8BAA8B,EAAE,EAAE,CAAC;KAC1F;IACD,KAAK,EAAE;QACL,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;QACtF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;QACxF,wBAAwB,EAAE,yBAAc,CAAC,KAAK,CAAW,0BAA0B,EAAE,EAAE,CAAC;QACxF,sBAAsB,EAAE,yBAAc,CAAC,KAAK,CAAW,+BAA+B,EAAE,EAAE,CAAC;QAC3F,8BAA8B,EAAE,yBAAc,CAAC,KAAK,CAAqB,uCAAuC,CAAC;QACjH,6GAA6G;QAC7G,+BAA+B,EAAE,yBAAc,CAAC,KAAK,CACnD,kCAAkC,EAClC,oHAAoH,CACrH;KACF;CACF,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": "50.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/services/rest/ConnectorInstallService.ts

@@ -20,6 +20,17 @@ export class ConnectorInstallService {
     return success;
   };
 
+  getOauthInstallUrl = async (cid: string, provider: string, clientRedirectUrl: string): Promise<string> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/install/oauth/token`,
+      method: 'POST',
+      data: {cid},
+    });
+    const token = (res.data as {token: string}).token;
+    return `${this.rest.baseUrl}/${this.targetApi}/v1/install/oauth/${provider}/login?token=${token}&redirectUrl=${encodeURIComponent(clientRedirectUrl)}`;
+  };
+
+  /** @deprecated */
   getInstallToken = async (cid: string): Promise<string> => {
     const res = await this.rest.call({
       url: `/${this.targetApi}/v1/install/oauth/token`,
@@ -30,6 +41,7 @@ export class ConnectorInstallService {
     return token;
   };
 
+  /** @deprecated */
   getRedirectUrl = async (token: string): Promise<string> => {
     const res = await this.rest.call({
       url: `/${this.targetApi}/v1/install/oauth/login`,
@@ -40,6 +52,7 @@ export class ConnectorInstallService {
     return redirectUrl;
   };
 
+  /** @deprecated */
   buildInstallOAuthUrl = (token: string, redirectUrl: string): string => {
     return `/${this.targetApi}/v1/install/oauth?token=${token}&redirect=${encodeURIComponent(redirectUrl)}`;
   };

package/src/services/rest/RestClient.ts

@@ -36,6 +36,7 @@ export type RestClientOptions = {
  * RestClient is a generic interface for making REST calls.
  */
 export interface RestClient {
+  baseUrl?: string;
   strict: boolean;
   call(_request: RestRequest): Promise<RestResponse>;
 }
@@ -47,15 +48,15 @@ export interface RestClient {
  *
  * These strategies can be useful when scraping 3rd party APIs.
  */
-export class DefaultRestClient {
+export class DefaultRestClient implements RestClient {
   protected readonly ampAxios: Axios;
   protected readonly retryStrategy: RestClientRetryStrategy;
   protected readonly rateLimitStrategy: RestClientRateLimitStrategy;
   protected readonly logger: AmpLogger;
+  readonly baseUrl?: string;
   readonly strict: boolean;
 
   constructor(options: RestClientOptions = {}) {
-    // TODO: rest client
     const client = options.client ?? axios;
     this.ampAxios = client.create({
       baseURL: options.baseUrl,
@@ -73,6 +74,7 @@ export class DefaultRestClient {
     this.ampAxios.defaults.headers.put['Content-Type'] = 'application/json';
     this.retryStrategy = options.retryStrategy ?? noopRestRetryStrategy;
     this.rateLimitStrategy = options.rateLimitStrategy ?? noopRestClientRateLimitStrategy;
+    this.baseUrl = options.baseUrl;
     this.strict = options.strict ?? false;
   }
   call = async (request: RestRequest): Promise<RestResponse> => {

package/src/settings.ts

@@ -1,11 +1,76 @@
+import {Contact} from './dto';
 import {AmpSettingsMap} from './services';
 
-// TODO document this object
+/**************************
+ *     GLOBAL SETTINGS    *
+ *************************/
+/**
+ * GLOBAL ONLY
+ * ===========
+ * These are tenant level settings that are not meant to be overridden at the connector level
+ */
+const TENANT_SETTINGS = {
+  /** Disables all automated messages from being sent to end users. */
+  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
+   *   - `ampsec`: founding team of amplifier security with mock data
+   *   - `stryper`: branded small test tenant
+   *   - `acme`: mocked data for ~25 users
+   *   - `ingen`: mocked data for ~250 users
+   */
+  MOCK_TENANT_ID: AmpSettingsMap.asKey<string>('mocks.tenant.id', 'stryper'),
+};
+
+/**
+ * GLOBAL CONNECTOR DEFAULTS
+ * Note: these can be overridden by connector level settings
+ */
+const GLOBAL_CONNECTOR_DEFAULT_SETTINGS = {
+  /** Not currently implemented/respected */
+  NOTIFICATIONS_ENABLED: AmpSettingsMap.asKey<boolean>('notifications.enabled', false),
+};
+
+/********************
+ *     PROVIDERS    *
+ ********************/
+const GOOGLE_SETTINGS = {
+  GOOGLE_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.exec.extIds', []),
+  GOOGLE_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.prod.extIds', []),
+  GOOGLE_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.priv.extIds', []),
+  GOOGLE_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.servAcct.extIds', []),
+};
+
+const OKTA_SETTINGS = {
+  OKTA_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.exec.extIds', []),
+  OKTA_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.prod.extIds', []),
+  OKTA_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.priv.extIds', []),
+  OKTA_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.servAcct.extIds', []),
+};
+
+const SLACK_SETTINGS = {
+  SLACK_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.exec.extIds', []),
+  SLACK_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.prod.extIds', []),
+  SLACK_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.priv.extIds', []),
+  SLACK_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.servAcct.extIds', []),
+  SLACK_CONTACT_SECURITY_CHANNEL: AmpSettingsMap.asKey<string | undefined>('slack.channels.security.extId'),
+  // TODO localization... does this get moved to contentful? Does the setting "point" to content in contentful?
+  SLACK_CONTACT_SECURITY_TEMPLATE: AmpSettingsMap.asKey<string>(
+    'slack.templates.contactSecurity',
+    'Thanks for getting in touch! We forwarded your message to our security team and they will get back to you shortly.'
+  ),
+};
+
 /**
  * Collection of hard coded settings to be use centrally across services and user interfaces.
  *
  * # Naming convention:
- * Keys should be name spaced following dot notation, e.g. notifications.ghost_mode.enabled`.
+ * Keys should be name spaced following dot notation and camel case, e.g. notifications.ghostMode.enabled`.
  *
  * ## Use Cases
  * 1. Boolean "enabled" toggles should end in `*.enabled`. You should never use the inverse `*.disabled`
@@ -24,19 +89,7 @@ export const AMP_SETTINGS = {
    * These are tenant level settings that are not meant to be overridden at the connector level
    */
   tenant: {
-    /** Disables all automated messages from being sent to end users. */
-    GHOST_MODE: AmpSettingsMap.asKey<boolean>('notifications.ghost_mode.enabled', false), // TODO enble by default
-    /** Enables mock providers on the tenant. */
-    ENABLE_MOCKS: AmpSettingsMap.asKey<boolean>('mocks.enabled', false),
-    /**
-     * Specifies which mock tenant to use.
-     *   - `david`: single insecure user
-     *   - `ampsec`: founding team of amplifier security with mock data
-     *   - `stryper`: branded small test tenant
-     *   - `acme`: mocked data for ~25 users
-     *   - `ingen`: mocked data for ~250 users
-     */
-    MOCK_TENANT_ID: AmpSettingsMap.asKey<string>('mocks.tenant.id', 'stryper'),
+    ...TENANT_SETTINGS,
     /** Specifies the default connector for the `messages` delivery strategy. */
     DEFAULT_NOTIFICATION_CONNECTOR_ID: AmpSettingsMap.asKey<string | undefined>('notifications.connectors.default.cid'),
   },
@@ -44,35 +97,13 @@ export const AMP_SETTINGS = {
    * GLOBAL
    * Note: these can be overridden by connector level settings
    */
-  inherited: {
-    /** Not currently implemented/respected */
-    NOTIFICATIONS_ENABLED: AmpSettingsMap.asKey<boolean>('notifications.enabled', false),
+  connectorDefaults: {
+    ...GLOBAL_CONNECTOR_DEFAULT_SETTINGS,
   },
   /********************
    *     PROVIDERS    *
    ********************/
-  google: {
-    GOOGLE_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.exec.extIds', []),
-    GOOGLE_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.prod.extIds', []),
-    GOOGLE_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.priv.extIds', []),
-    GOOGLE_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('google.groups.serv_acct.extIds', []),
-  },
-  okta: {
-    OKTA_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.exec.extIds', []),
-    OKTA_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.prod.extIds', []),
-    OKTA_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.priv.extIds', []),
-    OKTA_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('okta.groups.serv_acct.extIds', []),
-  },
-  slack: {
-    SLACK_EXECUTIVE_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.exec.extIds', []),
-    SLACK_PROD_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.prod.extIds', []),
-    SLACK_PRIV_ACCESS_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.priv.extIds', []),
-    SLACK_SERV_ACCT_GROUPS: AmpSettingsMap.asKey<string[]>('slack.groups.serv_acct.extIds', []),
-    SLACK_CONTACT_SECURITY_CHANNEL: AmpSettingsMap.asKey<string | undefined>('slack.channels.contact_security.extId'),
-    // TODO localization... does this get moved to contentful? Does the setting "point" to content in contentful?
-    SLACK_CONTACT_SECURITY_TEMPLATE: AmpSettingsMap.asKey<string>(
-      'slack.templates.contact_security',
-      'Thanks for getting in touch! We forwarded your message to our security team and they will get back to you shortly.'
-    ),
-  },
+  google: {...GOOGLE_SETTINGS},
+  okta: {...OKTA_SETTINGS},
+  slack: {...SLACK_SETTINGS},
 };

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;
-};