core-mb 1.0.1 → 1.0.2

package/coverage/security.helper.ts.html

@@ -23,16 +23,16 @@
         <div class='clearfix'>
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">96.42% </span>
+                <span class="strong">100% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>27/28</span>
+                <span class='fraction'>24/24</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">75% </span>
+                <span class="strong">100% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>3/4</span>
+                <span class='fraction'>0/0</span>
             </div>
         
             
@@ -44,9 +44,9 @@
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">96.42% </span>
+                <span class="strong">100% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>27/28</span>
+                <span class='fraction'>24/24</span>
             </div>
         
             
@@ -142,18 +142,11 @@
 <a name='L77'></a><a href='#L77'>77</a>
 <a name='L78'></a><a href='#L78'>78</a>
 <a name='L79'></a><a href='#L79'>79</a>
-<a name='L80'></a><a href='#L80'>80</a>
-<a name='L81'></a><a href='#L81'>81</a>
-<a name='L82'></a><a href='#L82'>82</a>
-<a name='L83'></a><a href='#L83'>83</a>
-<a name='L84'></a><a href='#L84'>84</a>
-<a name='L85'></a><a href='#L85'>85</a>
-<a name='L86'></a><a href='#L86'>86</a>
-<a name='L87'></a><a href='#L87'>87</a>
-<a name='L88'></a><a href='#L88'>88</a>
-<a name='L89'></a><a href='#L89'>89</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
+<a name='L80'></a><a href='#L80'>80</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -162,17 +155,6 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-no">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">1x</span>
-<span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -240,8 +222,11 @@
 <span class="cline-any cline-yes">4x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import * as crypto from "crypto";
+import { CoreMBConfig } from "./config";
 import { normalize } from "./phone.number.helper";
 &nbsp;
+const config = CoreMBConfig.getInstance();
+&nbsp;
 export type PhoneCipherRecord = {
   // Base64 strings suitable for storage in text columns
   ciphertext: string; // Encrypted phone number
@@ -250,24 +235,12 @@ export type PhoneCipherRecord = {
   hmacIndex: string; // HMAC-SHA256(phoneNormalized) for search/dedup
 };
 &nbsp;
-const aesKeyB64 = process.env.PHONE_AES_KEY;
-const hmacKeyB64 = process.env.PHONE_HMAC_KEY;
-&nbsp;
-<span class="missing-if-branch" title="if path not taken" >I</span>if (!aesKeyB64 || !hmacKeyB64) {
-<span class="cstat-no" title="statement not covered" >  throw new Error(</span>
-    "PHONE_AES_KEY and PHONE_HMAC_KEY must be set (base64-encoded)."
-  );
-}
-&nbsp;
-const aesKey = Buffer.from(aesKeyB64, "base64");
-const hmacKey = Buffer.from(hmacKeyB64, "base64");
-&nbsp;
 /** Create an HMAC index for lookups without revealing the number.
  * Store this alongside the encrypted data and index it in the DB.
  */
 export function hmacIndex(phoneRaw: string): string {
   const normalized = normalize(phoneRaw);
-  const h = crypto.createHmac("sha256", hmacKey);
+  const h = crypto.createHmac("sha256", config.hmacKey);
   h.update(normalized, "utf8");
   return h.digest("base64");
 }
@@ -283,7 +256,7 @@ export function phoneEncrypt(
   // 12-byte IV is recommended for GCM
   const iv = crypto.randomBytes(12);
 &nbsp;
-  const cipher = crypto.createCipheriv("aes-256-gcm", aesKey, iv);
+  const cipher = crypto.createCipheriv("aes-256-gcm", config.aesKey, iv);
 &nbsp;
   // Optional: bind additional data (AAD), e.g., tenant ID to prevent cross-tenant swaps
   // cipher.setAAD(Buffer.from(tenantId, 'utf8'));
@@ -313,7 +286,7 @@ export function phoneDecrypt(
   const authTag = Buffer.from(record.authTag, "base64");
   const ciphertext = Buffer.from(record.ciphertext, "base64");
 &nbsp;
-  const decipher = crypto.createDecipheriv("aes-256-gcm", aesKey, iv);
+  const decipher = crypto.createDecipheriv("aes-256-gcm", config.aesKey, iv);
 &nbsp;
   // If you used setAAD on encrypt, you MUST set the same AAD here
   // decipher.setAAD(Buffer.from(tenantId, 'utf8'));
@@ -334,7 +307,7 @@ export function phoneDecrypt(
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-08-23T06:47:14.841Z
+                at 2025-08-23T08:06:17.198Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/dist/config.d.ts

@@ -0,0 +1,12 @@
+export interface ConfigProperties {
+    aesKey: string;
+    hmacKey: string;
+}
+export declare class CoreMBConfig {
+    private static instance;
+    readonly aesKey: Buffer;
+    readonly hmacKey: Buffer;
+    private constructor();
+    static initialize(props: ConfigProperties): CoreMBConfig;
+    static getInstance(): CoreMBConfig;
+}

package/dist/config.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreMBConfig = void 0;
+class CoreMBConfig {
+    constructor(props) {
+        this.aesKey = Buffer.from(props.aesKey, "base64");
+        this.hmacKey = Buffer.from(props.hmacKey, "base64");
+    }
+    static initialize(props) {
+        if (CoreMBConfig.instance) {
+            throw new Error("CoreMBConfig has already been initialized");
+        }
+        CoreMBConfig.instance = new CoreMBConfig(props);
+        return CoreMBConfig.instance;
+    }
+    // Access the singleton instance
+    static getInstance() {
+        if (!CoreMBConfig.instance) {
+            throw new Error("CoreMBConfig has not been initialized yet");
+        }
+        return CoreMBConfig.instance;
+    }
+}
+exports.CoreMBConfig = CoreMBConfig;

package/dist/security.helper.js

@@ -37,20 +37,15 @@ exports.hmacIndex = hmacIndex;
 exports.phoneEncrypt = phoneEncrypt;
 exports.phoneDecrypt = phoneDecrypt;
 const crypto = __importStar(require("crypto"));
+const config_1 = require("./config");
 const phone_number_helper_1 = require("./phone.number.helper");
-const aesKeyB64 = process.env.PHONE_AES_KEY;
-const hmacKeyB64 = process.env.PHONE_HMAC_KEY;
-if (!aesKeyB64 || !hmacKeyB64) {
-    throw new Error("PHONE_AES_KEY and PHONE_HMAC_KEY must be set (base64-encoded).");
-}
-const aesKey = Buffer.from(aesKeyB64, "base64");
-const hmacKey = Buffer.from(hmacKeyB64, "base64");
+const config = config_1.CoreMBConfig.getInstance();
 /** Create an HMAC index for lookups without revealing the number.
  * Store this alongside the encrypted data and index it in the DB.
  */
 function hmacIndex(phoneRaw) {
     const normalized = (0, phone_number_helper_1.normalize)(phoneRaw);
-    const h = crypto.createHmac("sha256", hmacKey);
+    const h = crypto.createHmac("sha256", config.hmacKey);
     h.update(normalized, "utf8");
     return h.digest("base64");
 }
@@ -61,7 +56,7 @@ function phoneEncrypt(phoneRaw) {
     const normalized = (0, phone_number_helper_1.normalize)(phoneRaw);
     // 12-byte IV is recommended for GCM
     const iv = crypto.randomBytes(12);
-    const cipher = crypto.createCipheriv("aes-256-gcm", aesKey, iv);
+    const cipher = crypto.createCipheriv("aes-256-gcm", config.aesKey, iv);
     // Optional: bind additional data (AAD), e.g., tenant ID to prevent cross-tenant swaps
     // cipher.setAAD(Buffer.from(tenantId, 'utf8'));
     const ciphertextBuf = Buffer.concat([
@@ -83,7 +78,7 @@ function phoneDecrypt(record) {
     const iv = Buffer.from(record.iv, "base64");
     const authTag = Buffer.from(record.authTag, "base64");
     const ciphertext = Buffer.from(record.ciphertext, "base64");
-    const decipher = crypto.createDecipheriv("aes-256-gcm", aesKey, iv);
+    const decipher = crypto.createDecipheriv("aes-256-gcm", config.aesKey, iv);
     // If you used setAAD on encrypt, you MUST set the same AAD here
     // decipher.setAAD(Buffer.from(tenantId, 'utf8'));
     decipher.setAuthTag(authTag);

package/jest.config.js

@@ -4,8 +4,9 @@ module.exports = {
   setupFiles: ["<rootDir>/jest.setup.ts"],
   collectCoverage: true, // enable coverage
   coverageDirectory: "coverage", // output folder
-  coverageReporters: ["text", "lcov", "html"], // text in terminal + HTML report
+  coverageReporters: ["text-summary", "lcov", "html"], // text in terminal + HTML report
   testMatch: ["**/*.spec.ts"], // only run *.spec.ts files
+  coveragePathIgnorePatterns: ["/node_modules/"],
   reporters: [
     "default",
     ["jest-html-reporter", {

package/jest.setup.ts

@@ -1,2 +1,10 @@
 import * as dotenv from "dotenv";
+import { CoreMBConfig } from "./src/config";
+
 dotenv.config();
+CoreMBConfig.initialize({
+  aesKey: process.env.PHONE_AES_KEY || "N/A",
+  hmacKey: process.env.PHONE_HMAC_KEY || "N/A",
+});
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-mb",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Core utility functions for the MB ecosystem in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "coverage": "jest --coverage --ci"
+    "coverage": "nyc jest"
   },
   "keywords": [
     "core",
@@ -26,6 +26,7 @@
     "dotenv": "^17.2.1",
     "jest": "^30.0.5",
     "jest-html-reporter": "^4.3.0",
+    "nyc": "^17.1.0",
     "ts-jest": "^29.4.1",
     "typescript": "^5.9.2"
   },

package/src/config.ts

@@ -0,0 +1,31 @@
+export interface ConfigProperties {
+  aesKey: string;
+  hmacKey: string;
+}
+
+export class CoreMBConfig {
+  private static instance: CoreMBConfig;
+  public readonly aesKey: Buffer;
+  public readonly hmacKey: Buffer;
+
+  private constructor(props: ConfigProperties) {
+    this.aesKey = Buffer.from(props.aesKey, "base64");
+    this.hmacKey = Buffer.from(props.hmacKey, "base64");
+  }
+
+  public static initialize(props: ConfigProperties): CoreMBConfig {
+    if (CoreMBConfig.instance) {
+      throw new Error("CoreMBConfig has already been initialized");
+    }
+    CoreMBConfig.instance = new CoreMBConfig(props);
+    return CoreMBConfig.instance;
+  }
+
+  // Access the singleton instance
+  public static getInstance(): CoreMBConfig {
+    if (!CoreMBConfig.instance) {
+      throw new Error("CoreMBConfig has not been initialized yet");
+    }
+    return CoreMBConfig.instance;
+  }
+}

package/src/security.helper.ts

@@ -1,6 +1,9 @@
 import * as crypto from "crypto";
+import { CoreMBConfig } from "./config";
 import { normalize } from "./phone.number.helper";
 
+const config = CoreMBConfig.getInstance();
+
 export type PhoneCipherRecord = {
   // Base64 strings suitable for storage in text columns
   ciphertext: string; // Encrypted phone number
@@ -9,24 +12,12 @@ export type PhoneCipherRecord = {
   hmacIndex: string; // HMAC-SHA256(phoneNormalized) for search/dedup
 };
 
-const aesKeyB64 = process.env.PHONE_AES_KEY;
-const hmacKeyB64 = process.env.PHONE_HMAC_KEY;
-
-if (!aesKeyB64 || !hmacKeyB64) {
-  throw new Error(
-    "PHONE_AES_KEY and PHONE_HMAC_KEY must be set (base64-encoded)."
-  );
-}
-
-const aesKey = Buffer.from(aesKeyB64, "base64");
-const hmacKey = Buffer.from(hmacKeyB64, "base64");
-
 /** Create an HMAC index for lookups without revealing the number.
  * Store this alongside the encrypted data and index it in the DB.
  */
 export function hmacIndex(phoneRaw: string): string {
   const normalized = normalize(phoneRaw);
-  const h = crypto.createHmac("sha256", hmacKey);
+  const h = crypto.createHmac("sha256", config.hmacKey);
   h.update(normalized, "utf8");
   return h.digest("base64");
 }
@@ -42,7 +33,7 @@ export function phoneEncrypt(
   // 12-byte IV is recommended for GCM
   const iv = crypto.randomBytes(12);
 
-  const cipher = crypto.createCipheriv("aes-256-gcm", aesKey, iv);
+  const cipher = crypto.createCipheriv("aes-256-gcm", config.aesKey, iv);
 
   // Optional: bind additional data (AAD), e.g., tenant ID to prevent cross-tenant swaps
   // cipher.setAAD(Buffer.from(tenantId, 'utf8'));
@@ -72,7 +63,7 @@ export function phoneDecrypt(
   const authTag = Buffer.from(record.authTag, "base64");
   const ciphertext = Buffer.from(record.ciphertext, "base64");
 
-  const decipher = crypto.createDecipheriv("aes-256-gcm", aesKey, iv);
+  const decipher = crypto.createDecipheriv("aes-256-gcm", config.aesKey, iv);
 
   // If you used setAAD on encrypt, you MUST set the same AAD here
   // decipher.setAAD(Buffer.from(tenantId, 'utf8'));

package/test-report.html

@@ -274,4 +274,4 @@ header {
   font-size: 1rem;
   padding: 0 0.5rem;
 }
-</style></head><body><main class="jesthtml-content"><header><h1 id="title">Test Report</h1></header><section id="metadata-container"><div id="timestamp">Started: 2025-08-23 13:47:11</div><div id="summary"><div id="suite-summary"><div class="summary-total">Suites (2)</div><div class="summary-passed ">2 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div><div id="test-summary"><div class="summary-total">Tests (9)</div><div class="summary-passed ">9 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div></div></section><details id="suite-1" class="suite-container" open=""><summary class="suite-info"><div class="suite-path">/Volumes/Projects/RND/microservices/vieltalk-chat/core-mb/__unitest__/phone.number.helper.spec.ts</div><div class="suite-time">1.364s</div></summary><div class="suite-tests"><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should return empty string for null/undefined/empty input</div><div class="test-status">passed</div><div class="test-duration">0.004s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should keep leading + and strip non-digit characters</div><div class="test-status">passed</div><div class="test-duration"> </div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should remove all non-digits if no leading +</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should handle already clean input</div><div class="test-status">passed</div><div class="test-duration"> </div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should not duplicate + signs</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div></div></details><details id="suite-2" class="suite-container" open=""><summary class="suite-info"><div class="suite-path">/Volumes/Projects/RND/microservices/vieltalk-chat/core-mb/__unitest__/phone.number.crypto.spec.ts</div><div class="suite-time">1.87s</div></summary><div class="suite-tests"><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should encrypt and decrypt correctly</div><div class="test-status">passed</div><div class="test-duration">0.008s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should produce different ciphertexts for same phone (unique IV)</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should throw when tampering with ciphertext</div><div class="test-status">passed</div><div class="test-duration">0.004s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should throw when tampering with authTag</div><div class="test-status">passed</div><div class="test-duration">0.002s</div></div></div></div></details></main></body></html>
+</style></head><body><main class="jesthtml-content"><header><h1 id="title">Test Report</h1></header><section id="metadata-container"><div id="timestamp">Started: 2025-08-23 15:06:13</div><div id="summary"><div id="suite-summary"><div class="summary-total">Suites (2)</div><div class="summary-passed ">2 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div><div id="test-summary"><div class="summary-total">Tests (9)</div><div class="summary-passed ">9 passed</div><div class="summary-failed  summary-empty">0 failed</div><div class="summary-pending  summary-empty">0 pending</div></div></div></section><details id="suite-1" class="suite-container" open=""><summary class="suite-info"><div class="suite-path">/Volumes/Projects/RND/microservices/vieltalk-chat/core-mb/__unitest__/phone.number.helper.spec.ts</div><div class="suite-time">2.333s</div></summary><div class="suite-tests"><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should return empty string for null/undefined/empty input</div><div class="test-status">passed</div><div class="test-duration">0.006s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should keep leading + and strip non-digit characters</div><div class="test-status">passed</div><div class="test-duration"> </div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should remove all non-digits if no leading +</div><div class="test-status">passed</div><div class="test-duration"> </div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should handle already clean input</div><div class="test-status">passed</div><div class="test-duration"> </div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.helper &gt; normalize</div><div class="test-title">should not duplicate + signs</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div></div></details><details id="suite-2" class="suite-container" open=""><summary class="suite-info"><div class="suite-path">/Volumes/Projects/RND/microservices/vieltalk-chat/core-mb/__unitest__/phone.number.crypto.spec.ts</div><div class="suite-time">2.611s</div></summary><div class="suite-tests"><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should encrypt and decrypt correctly</div><div class="test-status">passed</div><div class="test-duration">0.009s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should produce different ciphertexts for same phone (unique IV)</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should throw when tampering with ciphertext</div><div class="test-status">passed</div><div class="test-duration">0.009s</div></div></div><div class="test-result passed"><div class="test-info"><div class="test-suitename">phone.number.crypto</div><div class="test-title">should throw when tampering with authTag</div><div class="test-status">passed</div><div class="test-duration">0.001s</div></div></div></div></details></main></body></html>