mongodb-redact 1.1.7 → 1.2.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
-export declare function redact<T>(message: T): T;
+import type { Secret } from './secrets';
+export declare function redact<T>(message: T, secrets?: Secret[] | undefined): T;
 export default redact;
+export type { Secret } from './secrets';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,wBAAgB,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAsBvC;AAED,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,wBAAgB,MAAM,CAAC,CAAC,EACtB,OAAO,EAAE,CAAC,EACV,OAAO,GAAE,MAAM,EAAE,GAAG,SAAqB,GACxC,CAAC,CAsCH;AAED,eAAe,MAAM,CAAC;AACtB,YAAY,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -2,34 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redact = redact;
 const regexes_1 = require("./regexes");
-const plainObjectTag = Object.prototype.toString.call({});
-function isPlainObject(val) {
-    if (typeof val !== 'object' ||
-        !val ||
-        Object.prototype.toString.call(val) !== plainObjectTag) {
-        return false;
-    }
-    const proto = Object.getPrototypeOf(val);
-    if (proto === null)
-        return true;
-    if (!Object.prototype.hasOwnProperty.call(proto, 'constructor'))
-        return false;
-    const ctor = proto.constructor;
-    if (typeof ctor !== 'function')
-        return ctor;
-    const ctorPrototype = Object.getPrototypeOf(ctor);
-    return Object.getPrototypeOf(ctorPrototype) === ctor.prototype;
-}
-function redact(message) {
-    if (isPlainObject(message)) {
-        return Object.fromEntries(Object.entries(message).map(([key, value]) => [key, redact(value)]));
+const utils_1 = require("./utils");
+const secrets_1 = require("./secrets");
+function redact(message, secrets = undefined) {
+    if ((0, utils_1.isPlainObject)(message)) {
+        const newMessage = Object.fromEntries(Object.entries(message).map(([key, value]) => [
+            key,
+            redact(value, secrets),
+        ]));
+        return Object.setPrototypeOf(newMessage, Object.getPrototypeOf(message));
     }
     if (Array.isArray(message)) {
-        return message.map(redact);
+        return message.map((msg) => redact(msg, secrets));
     }
     if (typeof message !== 'string') {
         return message;
     }
+    if (secrets) {
+        message = (0, secrets_1.redactSecretsOnString)(message, secrets);
+    }
     for (const [regex, replacement] of regexes_1.regexes) {
         message = message.replace(regex, replacement);
     }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAsBA,wBAsBC;AA5CD,uCAAoC;AAEpC,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1D,SAAS,aAAa,CAAC,GAAY;IACjC,IACE,OAAO,GAAG,KAAK,QAAQ;QACvB,CAAC,GAAG;QACJ,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,cAAc,EACtD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9E,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC;IAC/B,IAAI,OAAO,IAAI,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC;IAG5C,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC;AACjE,CAAC;AAED,SAAgB,MAAM,CAAI,OAAU;IAClC,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAE3B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAC/D,CAAC;IACT,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAE3B,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAM,CAAC;IAClC,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAEhC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,iBAAO,EAAE,CAAC;QAG3C,OAAO,GAAI,OAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAe,CAAC;IAC9E,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAKA,wBAyCC;AA9CD,uCAAoC;AACpC,mCAAwC;AACxC,uCAAkD;AAGlD,SAAgB,MAAM,CACpB,OAAU,EACV,UAAgC,SAAS;IAEzC,IAAI,IAAA,qBAAa,EAAC,OAAO,CAAC,EAAE,CAAC;QAE3B,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CACnC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YAC5C,GAAG;YACH,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC;SACvB,CAAC,CACE,CAAC;QAIP,OAAO,MAAM,CAAC,cAAc,CAC1B,UAAU,EACV,MAAM,CAAC,cAAc,CAAC,OAAO,CAAkB,CAChD,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAE3B,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAM,CAAC;IACzD,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAEhC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,GAAG,IAAA,+BAAqB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAGD,KAAK,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,iBAAO,EAAE,CAAC;QAG3C,OAAO,GAAI,OAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAe,CAAC;IAC9E,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kBAAe,MAAM,CAAC"}

package/dist/secrets.d.ts

@@ -0,0 +1,8 @@
+export declare const SECRET_KIND: readonly ["base64", "private key", "user", "password", "email", "ip", "url", "mongodb uri"];
+export type SecretKind = (typeof SECRET_KIND)[number];
+export type Secret = {
+    readonly value: string;
+    readonly kind: SecretKind;
+};
+export declare function redactSecretsOnString<T extends string>(content: T, secrets: Secret[]): T;
+//# sourceMappingURL=secrets.d.ts.map

package/dist/secrets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets.d.ts","sourceRoot":"","sources":["../src/secrets.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,WAAW,6FASd,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,MAAM,EACpD,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,MAAM,EAAE,GAChB,CAAC,CAcH"}

package/dist/secrets.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SECRET_KIND = void 0;
+exports.redactSecretsOnString = redactSecretsOnString;
+const regexp_escape_1 = __importDefault(require("regexp.escape"));
+exports.SECRET_KIND = [
+    'base64',
+    'private key',
+    'user',
+    'password',
+    'email',
+    'ip',
+    'url',
+    'mongodb uri',
+];
+function redactSecretsOnString(content, secrets) {
+    let result = content;
+    for (const { value, kind } of secrets) {
+        if (!exports.SECRET_KIND.includes(kind)) {
+            throw new Error(`Unknown secret kind ${kind}. Valid types: ${exports.SECRET_KIND.join(', ')}`);
+        }
+        const regex = new RegExp(`\\b${(0, regexp_escape_1.default)(value)}\\b`, 'g');
+        result = result.replace(regex, `<${kind}>`);
+    }
+    return result;
+}
+//# sourceMappingURL=secrets.js.map

package/dist/secrets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets.js","sourceRoot":"","sources":["../src/secrets.ts"],"names":[],"mappings":";;;;;;AAsBA,sDAiBC;AArCD,kEAAmC;AAEtB,QAAA,WAAW,GAAG;IACzB,QAAQ;IACR,aAAa;IACb,MAAM;IACN,UAAU;IACV,OAAO;IACP,IAAI;IACJ,KAAK;IACL,aAAa;CACL,CAAC;AASX,SAAgB,qBAAqB,CACnC,OAAU,EACV,OAAiB;IAEjB,IAAI,MAAM,GAAG,OAAO,CAAC;IACrB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,mBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,kBAAkB,mBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,IAAA,uBAAM,EAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACxD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,GAAG,CAAM,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isPlainObject(val: unknown): val is object;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAiBzD"}

package/dist/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = isPlainObject;
+const plainObjectTag = Object.prototype.toString.call({});
+function isPlainObject(val) {
+    if (typeof val !== 'object' ||
+        !val ||
+        Object.prototype.toString.call(val) !== plainObjectTag) {
+        return false;
+    }
+    const proto = Object.getPrototypeOf(val);
+    if (proto === null)
+        return true;
+    if (!Object.prototype.hasOwnProperty.call(proto, 'constructor'))
+        return false;
+    const ctor = proto.constructor;
+    if (typeof ctor !== 'function')
+        return false;
+    const ctorPrototype = Object.getPrototypeOf(ctor);
+    return Object.getPrototypeOf(ctorPrototype) === ctor.prototype;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;AAEA,sCAiBC;AAnBD,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAE1D,SAAgB,aAAa,CAAC,GAAY;IACxC,IACE,OAAO,GAAG,KAAK,QAAQ;QACvB,CAAC,GAAG;QACJ,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,cAAc,EACtD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9E,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC;IAC/B,IAAI,OAAO,IAAI,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAG7C,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC;AACjE,CAAC"}

package/package.json

@@ -13,7 +13,7 @@
     "email": "compass@mongodb.com"
   },
   "homepage": "https://github.com/mongodb-js/devtools-shared",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mongodb-js/devtools-shared.git"
@@ -23,12 +23,17 @@
   ],
   "license": "Apache-2.0",
   "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "require": "./dist/index.js",
-    "import": "./dist/.esm-wrapper.mjs",
-    "types": "./dist/index.d.ts"
+    "require": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "import": {
+      "default": "./dist/.esm-wrapper.mjs",
+      "types": "./dist/index.d.ts"
+    }
   },
-  "types": "./dist/index.d.ts",
   "scripts": {
     "bootstrap": "npm run compile",
     "prepublishOnly": "npm run compile",
@@ -53,6 +58,7 @@
     "@mongodb-js/tsconfig-devtools": "^1.0.3",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.1.1",
+    "@types/regexp.escape": "^2.0.0",
     "@types/sinon-chai": "^3.2.5",
     "chai": "^4.5.0",
     "depcheck": "^1.4.7",
@@ -64,5 +70,8 @@
     "sinon": "^9.2.3",
     "typescript": "^5.0.4"
   },
-  "gitHead": "e77027a119bcfb154849997219402ee795161744"
+  "dependencies": {
+    "regexp.escape": "^2.0.1"
+  },
+  "gitHead": "2bbe0a7e81791ef069c7e136ff6a8873852ea247"
 }