@ampsec/platform-client 79.4.1 → 79.6.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,10 @@
+import { FindingDto } from '../dto';
 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;
+export declare const buildDynamicVariablesContext: (finding: FindingDto) => Map<string, unknown>;

package/build/src/services/ContentTemplateService.js

@@ -3,9 +3,12 @@ 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.buildDynamicVariablesContext = exports.fillDynamicPropertyTemplate = exports.fillJsonPathTemplate = void 0;
 const lodash_1 = __importDefault(require("lodash"));
+const constants_1 = require("./constants");
 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 +25,63 @@ 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;
+const populateDynamicVariablesEntityData = (entityProperties, baseObject, fallbackObject = undefined) => {
+    const entityData = {};
+    for (const key in entityProperties) {
+        const findingKeyPath = entityProperties[key];
+        entityData[key] = lodash_1.default.get(baseObject, findingKeyPath) || (fallbackObject ? lodash_1.default.get(fallbackObject, findingKeyPath) : undefined);
+    }
+    return entityData;
+};
+const buildDynamicVariablesContext = (finding) => {
+    var _a;
+    const entityMap = new Map();
+    for (const entityName in constants_1.DYNAMIC_VARIABLES.ALLOWED_ENTITIES) {
+        const entityKey = constants_1.DYNAMIC_VARIABLES.ALLOWED_ENTITIES[entityName];
+        const entityProperties = constants_1.DYNAMIC_VARIABLES.ALLOWED_ENTITY_KEYS[entityKey];
+        let entityData = {};
+        if (entityName === 'finding') {
+            entityData = populateDynamicVariablesEntityData(entityProperties, finding);
+        }
+        else if (entityName === 'user' && ((_a = finding.meta) === null || _a === void 0 ? void 0 : _a._user)) {
+            entityData = populateDynamicVariablesEntityData(entityProperties, finding);
+        }
+        else if (entityName === 'asset' && finding.asset) {
+            entityData = populateDynamicVariablesEntityData(entityProperties, finding.asset, finding);
+        }
+        entityMap.set(entityName, entityData);
+    }
+    return entityMap;
+};
+exports.buildDynamicVariablesContext = buildDynamicVariablesContext;
 //# 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,2CAA8C;AAE9C,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;AAEF,MAAM,kCAAkC,GAAG,CACzC,gBAAwC,EACxC,UAA+C,EAC/C,iBAAsD,SAAS,EACtC,EAAE;IAC3B,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC7C,UAAU,CAAC,GAAG,CAAC,GAAG,gBAAC,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAC,CAAC,GAAG,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9H,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEK,MAAM,4BAA4B,GAAG,CAAC,OAAmB,EAAwB,EAAE;;IACxF,MAAM,SAAS,GAAyB,IAAI,GAAG,EAAE,CAAC;IAElD,KAAK,MAAM,UAAU,IAAI,6BAAiB,CAAC,gBAAgB,EAAE,CAAC;QAC5D,MAAM,SAAS,GAAG,6BAAiB,CAAC,gBAAgB,CAAC,UAA6D,CAAC,CAAC;QACpH,MAAM,gBAAgB,GAAG,6BAAiB,CAAC,mBAAmB,CAAC,SAA+D,CAAC,CAAC;QAEhI,IAAI,UAAU,GAA4B,EAAE,CAAC;QAE7C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,UAAU,GAAG,kCAAkC,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,UAAU,KAAK,MAAM,KAAI,MAAA,OAAO,CAAC,IAAI,0CAAE,KAAK,CAAA,EAAE,CAAC;YACxD,UAAU,GAAG,kCAAkC,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,UAAU,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YACnD,UAAU,GAAG,kCAAkC,CAAC,gBAAgB,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC5F,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AArBW,QAAA,4BAA4B,gCAqBvC"}

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

@@ -58,3 +58,33 @@ export declare const REPORTS: {
     SELF_HEALED: string;
     HEALTH_SCORE_TREND: string;
 };
+export declare class DYNAMIC_VARIABLES {
+    static readonly ALLOWED_ENTITIES: {
+        finding: string;
+        user: string;
+        asset: string;
+    };
+    static readonly ALLOWED_ENTITY_KEYS: {
+        finding: {
+            displayValue: string;
+            description: string;
+            discoveredAt: string;
+            category: string;
+            severity: string;
+            kind: string;
+        };
+        user: {
+            firstName: string;
+            lastName: string;
+            organization: string;
+            department: string;
+            title: string;
+            email: string;
+        };
+        asset: {
+            displayValue: string;
+            serialNumber: string;
+            macAddress: string;
+        };
+    };
+}

package/build/src/services/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REPORTS = exports.KIND = exports.TARGET_API_ENGAGE = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = exports.DEFAULT_TREND_WINDOW_MONTHS = void 0;
+exports.DYNAMIC_VARIABLES = exports.REPORTS = exports.KIND = exports.TARGET_API_ENGAGE = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = exports.DEFAULT_TREND_WINDOW_MONTHS = void 0;
 exports.DEFAULT_TREND_WINDOW_MONTHS = 6;
 exports.TARGET_API_PLATFORM = 'platform';
 exports.TARGET_API_AGENT = 'api';
@@ -58,4 +58,39 @@ exports.REPORTS = {
     // trending reports
     HEALTH_SCORE_TREND: 'monthly-health-trend',
 };
+class DYNAMIC_VARIABLES {
+}
+exports.DYNAMIC_VARIABLES = DYNAMIC_VARIABLES;
+DYNAMIC_VARIABLES.ALLOWED_ENTITIES = {
+    // Public Keys : Private Keys
+    finding: 'finding',
+    user: 'user',
+    asset: 'asset',
+};
+DYNAMIC_VARIABLES.ALLOWED_ENTITY_KEYS = {
+    finding: {
+        // Public Keys : Private Keys
+        displayValue: 'displayValue',
+        description: 'description',
+        discoveredAt: 'discoveredAt',
+        category: 'category',
+        severity: 'severity',
+        kind: 'kind',
+    },
+    user: {
+        // Public Keys : Private Keys
+        firstName: 'meta._user.firstName',
+        lastName: 'meta._user.lastName',
+        organization: 'meta._user.organization',
+        department: 'meta._user.department',
+        title: 'meta._user.title',
+        email: 'meta._user.primaryEmail',
+    },
+    asset: {
+        // Public Keys : Private Keys
+        displayValue: 'displayValue',
+        serialNumber: 'meta._asset.sn',
+        macAddress: 'meta._asset.macs',
+    },
+};
 //# sourceMappingURL=constants.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AACpC,QAAA,iBAAiB,GAAc,KAAK,CAAC;AAErC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,oBAAoB,EAAE,sBAAsB;IAC5C,mBAAmB,EAAE,qBAAqB;IAC1C,wBAAwB,EAAE,0BAA0B;IACpD,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,mBAAmB;IACtC,aAAa,EAAE,gBAAgB;IAC/B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,sBAAsB,EAAE,wBAAwB;IAChD,iBAAiB,EAAE,mBAAmB;IACtC,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,UAAU;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,mBAAmB;CACtC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AACpC,QAAA,iBAAiB,GAAc,KAAK,CAAC;AAErC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,oBAAoB,EAAE,sBAAsB;IAC5C,mBAAmB,EAAE,qBAAqB;IAC1C,wBAAwB,EAAE,0BAA0B;IACpD,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,mBAAmB;IACtC,aAAa,EAAE,gBAAgB;IAC/B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,sBAAsB,EAAE,wBAAwB;IAChD,iBAAiB,EAAE,mBAAmB;IACtC,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,UAAU;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,mBAAmB;CACtC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC;AAEF,MAAa,iBAAiB;;AAA9B,8CAkCC;AAjCiB,kCAAgB,GAAG;IACjC,6BAA6B;IAC7B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACf,CAAC;AAEc,qCAAmB,GAAG;IACpC,OAAO,EAAE;QACP,6BAA6B;QAC7B,YAAY,EAAE,cAAc;QAC5B,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,cAAc;QAC5B,QAAQ,EAAE,UAAU;QACpB,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,MAAM;KACb;IACD,IAAI,EAAE;QACJ,6BAA6B;QAC7B,SAAS,EAAE,sBAAsB;QACjC,QAAQ,EAAE,qBAAqB;QAC/B,YAAY,EAAE,yBAAyB;QACvC,UAAU,EAAE,uBAAuB;QACnC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,yBAAyB;KACjC;IACD,KAAK,EAAE;QACL,6BAA6B;QAC7B,YAAY,EAAE,cAAc;QAC5B,YAAY,EAAE,gBAAgB;QAC9B,UAAU,EAAE,kBAAkB;KAC/B;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "79.4.1",
+  "version": "79.6.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,10 @@
 import _ from 'lodash';
+import {DYNAMIC_VARIABLES} from './constants';
+import {FindingDto} from '../dto';
 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 +20,68 @@ 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;
+};
+
+const populateDynamicVariablesEntityData = (
+  entityProperties: Record<string, string>,
+  baseObject: Record<string, unknown> | undefined,
+  fallbackObject: Record<string, unknown> | undefined = undefined
+): Record<string, unknown> => {
+  const entityData: Record<string, unknown> = {};
+  for (const key in entityProperties) {
+    const findingKeyPath = entityProperties[key];
+    entityData[key] = _.get(baseObject, findingKeyPath) || (fallbackObject ? _.get(fallbackObject, findingKeyPath) : undefined);
+  }
+
+  return entityData;
+};
+
+export const buildDynamicVariablesContext = (finding: FindingDto): Map<string, unknown> => {
+  const entityMap: Map<string, unknown> = new Map();
+
+  for (const entityName in DYNAMIC_VARIABLES.ALLOWED_ENTITIES) {
+    const entityKey = DYNAMIC_VARIABLES.ALLOWED_ENTITIES[entityName as keyof typeof DYNAMIC_VARIABLES.ALLOWED_ENTITIES];
+    const entityProperties = DYNAMIC_VARIABLES.ALLOWED_ENTITY_KEYS[entityKey as keyof typeof DYNAMIC_VARIABLES.ALLOWED_ENTITY_KEYS];
+
+    let entityData: Record<string, unknown> = {};
+
+    if (entityName === 'finding') {
+      entityData = populateDynamicVariablesEntityData(entityProperties, finding);
+    } else if (entityName === 'user' && finding.meta?._user) {
+      entityData = populateDynamicVariablesEntityData(entityProperties, finding);
+    } else if (entityName === 'asset' && finding.asset) {
+      entityData = populateDynamicVariablesEntityData(entityProperties, finding.asset, finding);
+    }
+
+    entityMap.set(entityName, entityData);
+  }
+
+  return entityMap;
+};

package/src/services/constants.ts

@@ -63,3 +63,39 @@ export const REPORTS = {
   // trending reports
   HEALTH_SCORE_TREND: 'monthly-health-trend',
 };
+
+export class DYNAMIC_VARIABLES {
+  static readonly ALLOWED_ENTITIES = {
+    // Public Keys : Private Keys
+    finding: 'finding',
+    user: 'user',
+    asset: 'asset',
+  };
+
+  static readonly ALLOWED_ENTITY_KEYS = {
+    finding: {
+      // Public Keys : Private Keys
+      displayValue: 'displayValue',
+      description: 'description',
+      discoveredAt: 'discoveredAt',
+      category: 'category',
+      severity: 'severity',
+      kind: 'kind',
+    },
+    user: {
+      // Public Keys : Private Keys
+      firstName: 'meta._user.firstName',
+      lastName: 'meta._user.lastName',
+      organization: 'meta._user.organization',
+      department: 'meta._user.department',
+      title: 'meta._user.title',
+      email: 'meta._user.primaryEmail',
+    },
+    asset: {
+      // Public Keys : Private Keys
+      displayValue: 'displayValue',
+      serialNumber: 'meta._asset.sn',
+      macAddress: 'meta._asset.macs',
+    },
+  };
+}