@ampsec/platform-client 79.4.1 → 79.5.0

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

@@ -1,4 +1,5 @@
 export declare enum EngagementChannelKind {
     SLACK = "SLACK",
-    CHROME_EXTENSION = "CHROME_EXTENSION"
+    CHROME_EXTENSION = "CHROME_EXTENSION",
+    TEAMS = "TEAMS"
 }

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

@@ -5,5 +5,6 @@ var EngagementChannelKind;
 (function (EngagementChannelKind) {
     EngagementChannelKind["SLACK"] = "SLACK";
     EngagementChannelKind["CHROME_EXTENSION"] = "CHROME_EXTENSION";
+    EngagementChannelKind["TEAMS"] = "TEAMS";
 })(EngagementChannelKind || (exports.EngagementChannelKind = EngagementChannelKind = {}));
 //# sourceMappingURL=engagementChannelKind.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"engagementChannelKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/engagementChannelKind.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,wCAAe,CAAA;IACf,8DAAqC,CAAA;AACvC,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC"}
+{"version":3,"file":"engagementChannelKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/engagementChannelKind.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,wCAAe,CAAA;IACf,8DAAqC,CAAA;IACrC,wCAAe,CAAA;AACjB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC"}

package/build/src/services/ContentTemplateService.d.ts

@@ -1 +1,8 @@
 export declare const fillJsonPathTemplate: (raw: string, meta: unknown) => string;
+/**
+ * @param rawTemplateString Template string with placeholders in the format of {{path.to.value}}
+ * @param meta object containing the values to replace the placeholders
+ * @returns string with placeholders replaced with values from the meta object
+ * @note Ensure that meta object does not contain any information that should not be exposed to end users
+ */
+export declare const fillDynamicPropertyTemplate: (rawTemplateString: string, meta: unknown) => string;

package/build/src/services/ContentTemplateService.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fillJsonPathTemplate = void 0;
+exports.fillDynamicPropertyTemplate = exports.fillJsonPathTemplate = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const JSON_PATH_PATTERN = /(\$\.(?:(?:[a-zA-Z0-9_]+)(?:\.[a-zA-Z0-9_]+)*)?)/g;
+const DYNAMIC_PROPERTY_PATTERN = /\{\{([^}]+)\}\}/g;
+// @deprecated : consider using fillDynamicPropertyTemplate
 const fillJsonPathTemplate = (raw, meta) => {
     const jsonPathMatches = raw.match(JSON_PATH_PATTERN);
     let result = raw;
@@ -22,4 +24,34 @@ const fillJsonPathTemplate = (raw, meta) => {
     return result;
 };
 exports.fillJsonPathTemplate = fillJsonPathTemplate;
+/**
+ * @param rawTemplateString Template string with placeholders in the format of {{path.to.value}}
+ * @param meta object containing the values to replace the placeholders
+ * @returns string with placeholders replaced with values from the meta object
+ * @note Ensure that meta object does not contain any information that should not be exposed to end users
+ */
+const fillDynamicPropertyTemplate = (rawTemplateString, meta) => {
+    let result = rawTemplateString;
+    const matches = rawTemplateString.match(DYNAMIC_PROPERTY_PATTERN);
+    if (matches) {
+        matches.forEach(placeholder => {
+            const path = placeholder.slice(2, -2).trim();
+            const value = lodash_1.default.get(meta, path, undefined);
+            if (lodash_1.default.isString(value) || lodash_1.default.isNumber(value) || lodash_1.default.isBoolean(value)) {
+                // primitive value type is replaced as is
+                result = result.replace(placeholder, value);
+            }
+            else if (lodash_1.default.isObject(value) || lodash_1.default.isArray(value)) {
+                // object and array values are stringified
+                result = result.replace(placeholder, JSON.stringify(value, null, 2));
+            }
+            else {
+                // unknown value type is replaced with a placeholder
+                result = result.replace(placeholder, 'UNKNOWN_TEMPLATE_VALUE');
+            }
+        });
+    }
+    return result;
+};
+exports.fillDynamicPropertyTemplate = fillDynamicPropertyTemplate;
 //# sourceMappingURL=ContentTemplateService.js.map

package/build/src/services/ContentTemplateService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentTemplateService.js","sourceRoot":"","sources":["../../../src/services/ContentTemplateService.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,MAAM,iBAAiB,GAAG,mDAAmD,CAAC;AAEvE,MAAM,oBAAoB,GAAG,CAAC,GAAW,EAAE,IAAa,EAAE,EAAE;IACjE,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,IAAI,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;YACD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B"}
+{"version":3,"file":"ContentTemplateService.js","sourceRoot":"","sources":["../../../src/services/ContentTemplateService.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,MAAM,iBAAiB,GAAG,mDAAmD,CAAC;AAC9E,MAAM,wBAAwB,GAAG,kBAAkB,CAAC;AAEpD,2DAA2D;AACpD,MAAM,oBAAoB,GAAG,CAAC,GAAW,EAAE,IAAa,EAAE,EAAE;IACjE,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrD,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxC,IAAI,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;YACD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B;AAEF;;;;;GAKG;AACI,MAAM,2BAA2B,GAAG,CAAC,iBAAyB,EAAE,IAAa,EAAE,EAAE;IACtF,IAAI,MAAM,GAAG,iBAAiB,CAAC;IAC/B,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAClE,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC3C,IAAI,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjE,yCAAyC;gBACzC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,0CAA0C;gBAC1C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvE,CAAC;iBAAM,CAAC;gBACN,oDAAoD;gBACpD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AApBW,QAAA,2BAA2B,+BAoBtC"}

package/package.json

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

package/src/dto/enums/engagementChannelKind.ts

@@ -1,4 +1,5 @@
 export enum EngagementChannelKind {
   SLACK = 'SLACK',
   CHROME_EXTENSION = 'CHROME_EXTENSION',
+  TEAMS = 'TEAMS',
 }

package/src/services/ContentTemplateService.ts

@@ -1,6 +1,8 @@
 import _ from 'lodash';
 const JSON_PATH_PATTERN = /(\$\.(?:(?:[a-zA-Z0-9_]+)(?:\.[a-zA-Z0-9_]+)*)?)/g;
+const DYNAMIC_PROPERTY_PATTERN = /\{\{([^}]+)\}\}/g;
 
+// @deprecated : consider using fillDynamicPropertyTemplate
 export const fillJsonPathTemplate = (raw: string, meta: unknown) => {
   const jsonPathMatches = raw.match(JSON_PATH_PATTERN);
   let result = raw;
@@ -16,3 +18,31 @@ export const fillJsonPathTemplate = (raw: string, meta: unknown) => {
   }
   return result;
 };
+
+/**
+ * @param rawTemplateString Template string with placeholders in the format of {{path.to.value}}
+ * @param meta object containing the values to replace the placeholders
+ * @returns string with placeholders replaced with values from the meta object
+ * @note Ensure that meta object does not contain any information that should not be exposed to end users
+ */
+export const fillDynamicPropertyTemplate = (rawTemplateString: string, meta: unknown) => {
+  let result = rawTemplateString;
+  const matches = rawTemplateString.match(DYNAMIC_PROPERTY_PATTERN);
+  if (matches) {
+    matches.forEach(placeholder => {
+      const path = placeholder.slice(2, -2).trim();
+      const value = _.get(meta, path, undefined);
+      if (_.isString(value) || _.isNumber(value) || _.isBoolean(value)) {
+        // primitive value type is replaced as is
+        result = result.replace(placeholder, value);
+      } else if (_.isObject(value) || _.isArray(value)) {
+        // object and array values are stringified
+        result = result.replace(placeholder, JSON.stringify(value, null, 2));
+      } else {
+        // unknown value type is replaced with a placeholder
+        result = result.replace(placeholder, 'UNKNOWN_TEMPLATE_VALUE');
+      }
+    });
+  }
+  return result;
+};