@contrast/common 1.34.0 → 1.34.2

package/lib/constants.d.ts

@@ -1,5 +1,6 @@
 export declare enum Event {
     RESPONSE_FINISH = "response-finish",
+    SERVER_LISTENING = "server-listening",
     ROUTE_COVERAGE_DISCOVERY_FINISHED = "route-coverage-discovery-finished",
     ARCHITECTURE_COMPONENT = "architecture-component",
     ASSESS_DATAFLOW_FINDING = "assess-dataflow-findings",
@@ -188,6 +189,11 @@ export declare enum DataflowTag {
     COOKIE = "COOKIE",
     WEAK_URL_ENCODED = "WEAK_URL_ENCODED"
 }
+export declare enum ServerEnvironment {
+    QA = "QA",
+    PRODUCTION = "PRODUCTION",
+    DEVELOPMENT = "DEVELOPMENT"
+}
 export declare const BLOCKING_MODES: readonly ["block", "block_at_perimeter"];
 export declare const FS_METHODS: readonly [{
     readonly name: "access";
@@ -382,4 +388,14 @@ export declare enum agentLibIDListTypes {
 export declare const symbols: {
     readonly kMetrics: symbol;
 };
+export declare const URI_REGEXES: readonly [{
+    readonly rx: RegExp;
+    readonly rp: "{uuid}";
+}, {
+    readonly rx: RegExp;
+    readonly rp: "{hash}";
+}, {
+    readonly rx: RegExp;
+    readonly rp: "{n}";
+}];
 //# sourceMappingURL=constants.d.ts.map

package/lib/constants.js

@@ -14,11 +14,12 @@
  * way not consistent with the End User License Agreement.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.symbols = exports.agentLibIDListTypes = exports.FS_METHODS = exports.BLOCKING_MODES = exports.DataflowTag = exports.ExclusionType = exports.InputType = exports.SessionConfigurationRule = exports.ResponseScanningRule = exports.Rule = exports.ProtectRuleMode = exports.Event = void 0;
+exports.URI_REGEXES = exports.symbols = exports.agentLibIDListTypes = exports.FS_METHODS = exports.BLOCKING_MODES = exports.ServerEnvironment = exports.DataflowTag = exports.ExclusionType = exports.InputType = exports.SessionConfigurationRule = exports.ResponseScanningRule = exports.Rule = exports.ProtectRuleMode = exports.Event = void 0;
 var Event;
 (function (Event) {
     // lifecycle
     Event["RESPONSE_FINISH"] = "response-finish";
+    Event["SERVER_LISTENING"] = "server-listening";
     Event["ROUTE_COVERAGE_DISCOVERY_FINISHED"] = "route-coverage-discovery-finished";
     // reports
     Event["ARCHITECTURE_COMPONENT"] = "architecture-component";
@@ -219,6 +220,12 @@ var DataflowTag;
     DataflowTag["COOKIE"] = "COOKIE";
     DataflowTag["WEAK_URL_ENCODED"] = "WEAK_URL_ENCODED";
 })(DataflowTag || (exports.DataflowTag = DataflowTag = {}));
+var ServerEnvironment;
+(function (ServerEnvironment) {
+    ServerEnvironment["QA"] = "QA";
+    ServerEnvironment["PRODUCTION"] = "PRODUCTION";
+    ServerEnvironment["DEVELOPMENT"] = "DEVELOPMENT";
+})(ServerEnvironment || (exports.ServerEnvironment = ServerEnvironment = {}));
 exports.BLOCKING_MODES = ['block', 'block_at_perimeter'];
 exports.FS_METHODS = [
     { name: 'access', promises: true, sync: true, indices: [0] },
@@ -267,4 +274,18 @@ var agentLibIDListTypes;
 exports.symbols = {
     kMetrics: Symbol('contrast.metrics'),
 };
+exports.URI_REGEXES = [
+    {
+        rx: /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/g,
+        rp: '{uuid}'
+    },
+    {
+        rx: /([a-fA-F0-9]{2}){16,}/g,
+        rp: '{hash}'
+    },
+    {
+        rx: /(\d+)/g,
+        rp: '{n}'
+    },
+];
 //# sourceMappingURL=constants.js.map

package/lib/index.d.ts

@@ -37,4 +37,5 @@ export declare function set(obj: Record<string, any>, name: string, value: any):
 export declare function safeConsoleError(...args: Parameters<typeof console.error>): void;
 /** Suppresses output to stderr when installed by the universal agent */
 export declare function safeConsoleWarn(...args: Parameters<typeof console.warn>): void;
+export declare function normalizeURI(uri: string): string;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -28,14 +28,14 @@ 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 });
-exports.safeConsoleWarn = exports.safeConsoleError = exports.set = exports.get = exports.groupResultsMap = exports.callChildComponentMethods = exports.callChildComponentMethodsSync = exports.traverseKeys = exports.traverseValues = exports.traverseKeysAndValues = exports.encodeString = exports.isNonEmptyObject = exports.isString = exports.empties = void 0;
+exports.normalizeURI = exports.safeConsoleWarn = exports.safeConsoleError = exports.set = exports.get = exports.groupResultsMap = exports.callChildComponentMethods = exports.callChildComponentMethodsSync = exports.traverseKeys = exports.traverseValues = exports.traverseKeysAndValues = exports.encodeString = exports.isNonEmptyObject = exports.isString = exports.empties = void 0;
 const constants_1 = require("./constants");
 const primordials_1 = require("./primordials");
 __exportStar(require("./constants"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./primordials"), exports);
 const { CONTRAST_INSTALLATION_TOOL = 'NONE' } = process.env;
-const { StringPrototypeSplit, BufferFrom, BufferPrototypeToString } = primordials_1.primordials;
+const { StringPrototypeReplaceAll, StringPrototypeSplit, BufferFrom, BufferPrototypeToString } = primordials_1.primordials;
 exports.empties = {
     OBJECT: Object.freeze({}),
     ARRAY: Object.freeze([]),
@@ -225,4 +225,14 @@ function safeConsoleWarn(...args) {
     }
 }
 exports.safeConsoleWarn = safeConsoleWarn;
+function normalizeURI(uri) {
+    let normalizedUri = uri;
+    constants_1.URI_REGEXES.forEach(({ rx, rp }) => {
+        //@ts-ignore
+        normalizedUri = StringPrototypeReplaceAll.call(normalizedUri, rx, rp);
+    });
+    return normalizedUri;
+}
+exports.normalizeURI = normalizeURI;
+;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/common",
-  "version": "1.34.0",
+  "version": "1.34.2",
   "description": "Shared constants and utilities for all Contrast Agent modules",
   "license": "UNLICENSED",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",