@contentstack/cli-utilities 1.8.3 → 1.9.0

package/lib/helpers.d.ts

@@ -18,3 +18,10 @@ export declare const validateUids: (uid: any) => boolean;
 export declare const validateFileName: (fileName: any) => boolean;
 export declare const validateRegex: (str: unknown) => import("recheck").Diagnostics;
 export declare const formatError: (error: any) => any;
+/**
+ * The function redactObject takes an object as input and replaces any sensitive keys with the string
+ * '[REDACTED]'.
+ * @param {any} obj - The `obj` parameter is an object that you want to redact sensitive information
+ * from.
+ */
+export declare const redactObject: (obj: any) => any;

package/lib/helpers.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
+exports.redactObject = exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
 const tslib_1 = require("tslib");
 const recheck_1 = require("recheck");
+const traverse_1 = tslib_1.__importDefault(require("traverse"));
 const auth_handler_1 = tslib_1.__importDefault(require("./auth-handler"));
 const _1 = require(".");
 const isAuthenticated = () => auth_handler_1.default.isAuthenticated();
@@ -62,7 +63,12 @@ exports.validatePath = validatePath;
 const escapeRegExp = (str) => str === null || str === void 0 ? void 0 : str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 exports.escapeRegExp = escapeRegExp;
 // To remove the relative path
-const sanitizePath = (str) => str === null || str === void 0 ? void 0 : str.replace(/^(\.\.(\/|\\|$))+/, '');
+const sanitizePath = (str) => {
+    if (typeof str !== 'string')
+        return;
+    const decodedStr = decodeURIComponent(str);
+    return decodedStr === null || decodedStr === void 0 ? void 0 : decodedStr.replace(/^([\/\\]){2,}/, "./").replace(/[\/\\]+/g, "/").replace(/(\.\.(\/|\\|$))+/g, ""); // Remove directory traversal (../ or ..\)
+};
 exports.sanitizePath = sanitizePath;
 // To validate the UIDs of assets
 const validateUids = (uid) => /^[a-zA-Z0-9]+$/.test(uid);
@@ -137,3 +143,45 @@ const formatError = function (error) {
     return message;
 };
 exports.formatError = formatError;
+/**
+ * The function checks if a given key string matches any of the sensitive keys defined in an array.
+ * @param {string} keyStr - The parameter `keyStr` is a string that represents a key.
+ * @returns a boolean value. It returns true if the keyStr matches any of the regular expressions in
+ * the sensitiveKeys array, and false otherwise.
+ */
+const isSensitiveKey = function (keyStr) {
+    if (keyStr && typeof keyStr === 'string') {
+        return sensitiveKeys.some((regex) => regex.test(keyStr));
+    }
+};
+/**
+ * The function redactObject takes an object as input and replaces any sensitive keys with the string
+ * '[REDACTED]'.
+ * @param {any} obj - The `obj` parameter is an object that you want to redact sensitive information
+ * from.
+ */
+const redactObject = function (obj) {
+    (0, traverse_1.default)(obj).forEach(function redactor() {
+        // Check if the current key is sensitive
+        if (isSensitiveKey(this.key)) {
+            // Update the current value with '[REDACTED]'
+            this.update('[REDACTED]');
+        }
+    });
+    return obj;
+};
+exports.redactObject = redactObject;
+/* The `sensitiveKeys` array is used to store regular expressions that match sensitive keys. These
+  keys are used to redact sensitive information from log messages. When logging an object, any keys
+  that match the regular expressions in the `sensitiveKeys` array will be replaced with the string
+  '[REDACTED]'. This helps to prevent sensitive information from being logged or displayed. */
+const sensitiveKeys = [
+    /authtoken/i,
+    /^email$/,
+    /^password$/i,
+    /secret/i,
+    /token/i,
+    /api[-._]?key/i,
+    /management[-._]?token/i,
+    /delivery[-._]?token/i,
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,7 +35,7 @@
     "@contentstack/management": "~1.18.4",
     "@contentstack/marketplace-sdk": "^1.2.5",
     "@oclif/core": "^3.27.0",
-    "axios": "^1.7.9",
+    "axios": "^1.8.2",
     "chalk": "^4.1.2",
     "cli-cursor": "^3.1.0",
     "cli-table": "^0.3.11",