@coast/service-common 2.0.65 → 2.0.67

package/dist/crypto/HmacUtils.d.ts

@@ -4,4 +4,5 @@ export declare class HmacUtils {
     private static algorithm;
     private static encoding;
     static sign(data: string, secret: HmacSecretKey): HmacSignature;
+    static generateSecret(): HmacSecretKey;
 }

package/dist/crypto/HmacUtils.js

@@ -5,12 +5,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HmacUtils = void 0;
 const node_crypto_1 = __importDefault(require("node:crypto"));
+const HmacSecretKey_1 = require("./HmacSecretKey");
 const HmacSignature_1 = require("./HmacSignature");
 class HmacUtils {
     static sign(data, secret) {
         const hmac = node_crypto_1.default.createHmac(HmacUtils.algorithm, secret);
         return (0, HmacSignature_1.HmacSignature)(hmac.update(data).digest().toString(HmacUtils.encoding));
     }
+    static generateSecret() {
+        return (0, HmacSecretKey_1.HmacSecretKey)(node_crypto_1.default.randomBytes(32).toString('hex'));
+    }
 }
 exports.HmacUtils = HmacUtils;
 HmacUtils.algorithm = 'sha256';

package/dist/crypto/HmacUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"HmacUtils.js","sourceRoot":"","sources":["../../lib/crypto/HmacUtils.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAGjC,mDAAgD;AAEhD,MAAa,SAAS;IAIX,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,MAAqB;QAClD,MAAM,IAAI,GAAG,qBAAM,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE5D,OAAO,IAAA,6BAAa,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,CAAC;;AARL,8BASC;AARkB,mBAAS,GAAG,QAAQ,CAAC;AACrB,kBAAQ,GAAmB,QAAQ,CAAC"}
+{"version":3,"file":"HmacUtils.js","sourceRoot":"","sources":["../../lib/crypto/HmacUtils.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAEjC,mDAAgD;AAChD,mDAAgD;AAEhD,MAAa,SAAS;IAIX,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,MAAqB;QAClD,MAAM,IAAI,GAAG,qBAAM,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE5D,OAAO,IAAA,6BAAa,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,CAAC;IAEM,MAAM,CAAC,cAAc;QACxB,OAAO,IAAA,6BAAa,EAAC,qBAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;;AAZL,8BAaC;AAZkB,mBAAS,GAAG,QAAQ,CAAC;AACrB,kBAAQ,GAAmB,QAAQ,CAAC"}

package/dist/logger/redaction/PathRedaction.d.ts

@@ -0,0 +1,4 @@
+export interface PathRedaction<T = object> {
+    keys?: Array<keyof T>;
+    fieldNames?: string[];
+}

package/dist/logger/redaction/PathRedaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PathRedaction.js.map

package/dist/logger/redaction/PathRedaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathRedaction.js","sourceRoot":"","sources":["../../../lib/logger/redaction/PathRedaction.ts"],"names":[],"mappings":""}

package/dist/logger/redaction/Redactable.d.ts

@@ -0,0 +1 @@
+export type Redactable = Record<string, any>;

package/dist/logger/redaction/Redactable.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Redactable.js.map

package/dist/logger/redaction/Redactable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Redactable.js","sourceRoot":"","sources":["../../../lib/logger/redaction/Redactable.ts"],"names":[],"mappings":""}

package/dist/logger/redaction/RedactionUtils.d.ts

@@ -0,0 +1,7 @@
+import type { PathRedaction } from './PathRedaction';
+import type { Redactable } from './Redactable';
+export declare class RedactionUtils {
+    static redactKey(_k: unknown): string;
+    static redact<T extends Redactable = Redactable>(k: T | null | undefined, options?: PathRedaction<T>): T | null | undefined;
+    private static shouldRedact;
+}

package/dist/logger/redaction/RedactionUtils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedactionUtils = void 0;
+class RedactionUtils {
+    static redactKey(_k) {
+        return '<redacted>';
+    }
+    static redact(k, options = { fieldNames: [] }) {
+        if (k === undefined || k === null) {
+            return k;
+        }
+        if (typeof k === 'object') {
+            return Object.keys(k).reduce((acc, key) => {
+                if (RedactionUtils.shouldRedact(key, options)) {
+                    acc[key] = RedactionUtils.redactKey(k[key]);
+                }
+                else {
+                    acc[key] = RedactionUtils.redact(k[key], { fieldNames: options.fieldNames });
+                }
+                return acc;
+            }, {});
+        }
+        return k;
+    }
+    static shouldRedact(key, redaction) {
+        const allRedactionFieldNames = new Set([...(redaction.keys ?? []), ...(redaction.fieldNames ?? [])].map((i) => i.toString().toLowerCase().replace('_', '')));
+        return allRedactionFieldNames.has(key.toLowerCase().replace('_', ''));
+    }
+}
+exports.RedactionUtils = RedactionUtils;
+//# sourceMappingURL=RedactionUtils.js.map

package/dist/logger/redaction/RedactionUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedactionUtils.js","sourceRoot":"","sources":["../../../lib/logger/redaction/RedactionUtils.ts"],"names":[],"mappings":";;;AAGA,MAAa,cAAc;IACvB,MAAM,CAAC,SAAS,CAAC,EAAW;QACxB,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,MAAM,CACT,CAAuB,EACvB,UAA4B,EAAE,UAAU,EAAE,EAAE,EAAE;QAE9C,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChC,OAAO,CAAC,CAAC;QACb,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACT,IAAI,cAAc,CAAC,YAAY,CAAI,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC/C,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChD,CAAC;qBAAM,CAAC;oBACJ,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;gBACjF,CAAC;gBAED,OAAO,GAAG,CAAC;YACf,CAAC,EACD,EAA6B,CAChB,CAAC;QACtB,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IAEO,MAAM,CAAC,YAAY,CAAoC,GAAW,EAAE,SAA2B;QACnG,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAClC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CACvH,CAAC;QAEF,OAAO,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC;CACJ;AAtCD,wCAsCC"}

package/dist/logger/redaction/Sensitive.d.ts

@@ -0,0 +1,3 @@
+import 'reflect-metadata';
+import type { PathRedaction } from './PathRedaction';
+export declare function Sensitive<T extends object = object>(redaction?: PathRedaction<T>): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;

package/dist/logger/redaction/Sensitive.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sensitive = Sensitive;
+require("reflect-metadata");
+const SensitiveSymbol_1 = require("./SensitiveSymbol");
+function Sensitive(redaction) {
+    return (target, propertyKey, parameterIndex) => {
+        const existingRequiredParameters = Reflect.getOwnMetadata(SensitiveSymbol_1.SENSITIVE, target, propertyKey) || {
+            keys: [],
+        };
+        existingRequiredParameters.keys.push({ index: parameterIndex, redaction: redaction ?? true });
+        Reflect.defineMetadata(SensitiveSymbol_1.SENSITIVE, existingRequiredParameters, target, propertyKey);
+    };
+}
+//# sourceMappingURL=Sensitive.js.map

package/dist/logger/redaction/Sensitive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sensitive.js","sourceRoot":"","sources":["../../../lib/logger/redaction/Sensitive.ts"],"names":[],"mappings":";;AAaA,8BAUC;AAvBD,4BAA0B;AAK1B,uDAA8C;AAQ9C,SAAgB,SAAS,CAA4B,SAA4B;IAC7E,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAE,cAAsB,EAAE,EAAE;QAC5E,MAAM,0BAA0B,GAAyB,OAAO,CAAC,cAAc,CAAC,2BAAS,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI;YAC/G,IAAI,EAAE,EAAE;SACX,CAAC;QAEF,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC;QAE9F,OAAO,CAAC,cAAc,CAAC,2BAAS,EAAE,0BAA0B,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACvF,CAAC,CAAC;AACN,CAAC"}

package/dist/logger/redaction/SensitiveMetadata.d.ts

@@ -0,0 +1,7 @@
+import type { PathRedaction } from './PathRedaction';
+export interface SensitiveMetadata<T extends object = object> {
+    keys: Array<{
+        index: number;
+        redaction: boolean | PathRedaction<T> | undefined;
+    }>;
+}

package/dist/logger/redaction/SensitiveMetadata.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SensitiveMetadata.js.map

package/dist/logger/redaction/SensitiveMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SensitiveMetadata.js","sourceRoot":"","sources":["../../../lib/logger/redaction/SensitiveMetadata.ts"],"names":[],"mappings":""}

package/dist/logger/redaction/SensitiveSymbol.d.ts

@@ -0,0 +1 @@
+export declare const SENSITIVE: unique symbol;

package/dist/logger/redaction/SensitiveSymbol.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SENSITIVE = void 0;
+exports.SENSITIVE = Symbol('Sensitive');
+//# sourceMappingURL=SensitiveSymbol.js.map

package/dist/logger/redaction/SensitiveSymbol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SensitiveSymbol.js","sourceRoot":"","sources":["../../../lib/logger/redaction/SensitiveSymbol.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coast/service-common",
-  "version": "2.0.65",
+  "version": "2.0.67",
   "description": "Common service package",
   "engines": {
     "node": ">=20.0.0"
@@ -38,6 +38,7 @@
   },
   "dependencies": {
     "pino": "^9.6.0",
+    "reflect-metadata": "^0.2.2",
     "uuid": "^11.0.5"
   },
   "devDependencies": {
@@ -46,6 +47,7 @@
     "@types/jest": "^29.5.14",
     "@types/node": "^22.13.4",
     "@types/pino": "^7.0.5",
+    "fast-check": "^4.5.3",
     "jest": "^29.7.0",
     "pino-test": "^1.1.0",
     "ts-jest": "^29.2.5",