@contrast/common 1.30.0 → 1.32.0

package/lib/index.d.ts

@@ -5,6 +5,14 @@ export * from './primordials';
 interface TraverseCallback {
     (path: any[], type: 'Key' | 'Value', value: any, obj: any): unknown;
 }
+export declare const empties: {
+    OBJECT: Readonly<{}>;
+    ARRAY: readonly never[];
+    UNTRACKED_VALUE_OBJ: Readonly<{
+        value: null;
+        tracked: false;
+    }>;
+};
 /**
  * Returns true if the value passed is either a primitive string or a
  * String object.
@@ -25,4 +33,8 @@ export declare function groupResultsMap(resultsMap: Partial<ResultMap>): {
 };
 export declare function get(obj: any, name: string): any;
 export declare function set(obj: Record<string, any>, name: string, value: any): void;
+/** Suppresses output to stderr when installed by the universal agent */
+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;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -28,13 +28,19 @@ 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.set = exports.get = exports.groupResultsMap = exports.callChildComponentMethods = exports.callChildComponentMethodsSync = exports.traverseKeys = exports.traverseValues = exports.traverseKeysAndValues = exports.encodeString = exports.isNonEmptyObject = exports.isString = void 0;
+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;
+exports.empties = {
+    OBJECT: Object.freeze({}),
+    ARRAY: Object.freeze([]),
+    UNTRACKED_VALUE_OBJ: Object.freeze({ value: null, tracked: false })
+};
 /**
  * Returns true if the value passed is either a primitive string or a
  * String object.
@@ -205,4 +211,18 @@ function set(obj, name, value) {
     obj[lastProp] = value;
 }
 exports.set = set;
+/** Suppresses output to stderr when installed by the universal agent */
+function safeConsoleError(...args) {
+    if (CONTRAST_INSTALLATION_TOOL === 'NONE') {
+        console.error(...args);
+    }
+}
+exports.safeConsoleError = safeConsoleError;
+/** Suppresses output to stderr when installed by the universal agent */
+function safeConsoleWarn(...args) {
+    if (CONTRAST_INSTALLATION_TOOL === 'NONE') {
+        console.warn(...args);
+    }
+}
+exports.safeConsoleWarn = safeConsoleWarn;
 //# sourceMappingURL=index.js.map

package/lib/primordials.d.ts

@@ -1,6 +1,9 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import { inspect } from 'util';
+import fs from 'fs';
 export declare const primordials: {
     ArrayPrototypeJoin: (separator?: string | undefined) => string;
     ArrayPrototypeSlice: (start?: number | undefined, end?: number | undefined) => any[];
@@ -52,5 +55,11 @@ export declare const primordials: {
     };
     UtilInspect: typeof inspect;
     PathBasename: (path: string, ext?: string | undefined) => string;
+    FsOpen: typeof fs.open;
+    FsOpenSync: typeof fs.openSync;
+    FsReadFile: typeof fs.readFile;
+    FsReadFileSync: typeof fs.readFileSync;
+    FsPromisesOpen: typeof fs.promises.open;
+    FsPromiseReadFile: typeof fs.promises.readFile;
 };
 //# sourceMappingURL=primordials.d.ts.map

package/lib/primordials.js

@@ -13,10 +13,15 @@
  * engineered, modified, repackaged, sold, redistributed or otherwise used in a
  * way not consistent with the End User License Agreement.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.primordials = void 0;
 const util_1 = require("util");
 const path_1 = require("path");
+const fs_1 = __importDefault(require("fs"));
+const promises_1 = __importDefault(require("fs/promises"));
 exports.primordials = {
     // arrays
     ArrayPrototypeJoin: Array.prototype.join,
@@ -48,6 +53,14 @@ exports.primordials = {
     JSONParse: JSON.parse,
     JSONStringify: JSON.stringify,
     UtilInspect: util_1.inspect,
-    PathBasename: path_1.basename
+    PathBasename: path_1.basename,
+    // fs
+    FsOpen: fs_1.default.open,
+    FsOpenSync: fs_1.default.openSync,
+    FsReadFile: fs_1.default.readFile,
+    FsReadFileSync: fs_1.default.readFileSync,
+    // fs/promises
+    FsPromisesOpen: promises_1.default.open,
+    FsPromiseReadFile: promises_1.default.readFile,
 };
 //# sourceMappingURL=primordials.js.map

package/package.json

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