@meebon/meebon-crypto 1.2.14 → 1.2.16

package/dist/ExpressEncryptionMiddleware.d.ts

@@ -3,9 +3,9 @@ import { MeebonCryptoKeyPair } from '../types/global';
 /**
  * Middleware for encrypting incoming request data and decrypting outgoing response data.
  *
- * @param {MeebonCryptoKeyPair} keys - An object containing the privateKey and publicKey in PEM format.
+ * @param {MeebonCryptoKeyPair} keys - An object containing the privateKey, publicKey, and forRequest flag.
  * @returns {RequestHandler} The Express middleware function.
  */
-declare function EncryptionMiddleware({ privateKey, publicKey }: MeebonCryptoKeyPair): RequestHandler;
+declare function EncryptionMiddleware({ privateKey, publicKey, forRequest }: MeebonCryptoKeyPair): RequestHandler;
 export { EncryptionMiddleware };
 //# sourceMappingURL=ExpressEncryptionMiddleware.d.ts.map

package/dist/ExpressEncryptionMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpressEncryptionMiddleware.d.ts","sourceRoot":"","sources":["../lib/ExpressEncryptionMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,cAAc,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;;;;GAKG;AACH,iBAAS,oBAAoB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,mBAAmB,GAAG,cAAc,CAkC5F;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"ExpressEncryptionMiddleware.d.ts","sourceRoot":"","sources":["../lib/ExpressEncryptionMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,cAAc,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;;;;GAKG;AACH,iBAAS,oBAAoB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,mBAAmB,GAAG,cAAc,CAsCxG;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/index.js

@@ -79,34 +79,37 @@ var MeebonCrypto = class _MeebonCrypto {
 };
 
 // lib/ExpressEncryptionMiddleware.ts
-function EncryptionMiddleware({ privateKey, publicKey }) {
+function EncryptionMiddleware({ privateKey, publicKey, forRequest }) {
   return (req, res, next) => {
-    if (req.body && req.body.data) {
-      try {
-        const plainText = JSON.stringify(req.body.data);
-        const encrypted = MeebonCrypto.encryptData(plainText, publicKey);
-        req.body.data = encrypted;
-      } catch (error) {
-        return next(new Error(error?.message || "Encryption failed."));
+    if (forRequest) {
+      if (req.body && req.body.data) {
+        try {
+          const plainText = JSON.stringify(req.body.data);
+          const encrypted = MeebonCrypto.encryptData(plainText, publicKey);
+          req.body.data = encrypted;
+        } catch (error) {
+          next(new Error(error?.message || "Encryption failed."));
+        }
       }
-    }
-    const originalSend = res.send.bind(res);
-    res.send = (body) => {
-      try {
-        if (typeof body === "string") {
-          const decrypted = MeebonCrypto.decryptData(body, privateKey);
-          try {
-            body = JSON.parse(decrypted);
-          } catch {
-            body = decrypted;
+    } else {
+      const originalSend = res.send.bind(res);
+      res.send = (body) => {
+        try {
+          if (typeof body === "string" && body) {
+            const decrypted = MeebonCrypto.decryptData(body, privateKey);
+            try {
+              body = JSON.parse(decrypted);
+            } catch {
+              body = decrypted;
+            }
           }
+        } catch (error) {
+          next(new Error(error?.message || "Decryption failed."));
         }
-      } catch (error) {
-        throw new Error(error?.message ?? "Decryption failed");
-      }
-      return originalSend(body);
-    };
-    return next();
+        return originalSend(body);
+      };
+    }
+    next();
   };
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meebon/meebon-crypto",
-  "version": "1.2.14",
+  "version": "1.2.16",
   "description": "",
   "author": "kajalanS <103587022+kajalanS@users.noreply.github.com>",
   "homepage": "https://github.com/KsoftmHub/meebon-crypto?tab=readme-ov-file#getting-started",
@@ -8,6 +8,15 @@
   "main": "dist/index.js",
   "type": "module",
   "types": "types",
+  "directories": {
+    "lib": "lib",
+    "tests": "tests",
+    "types": "types"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
   "release": {
     "branches": [
       "master",

package/types/global.d.ts

@@ -1,12 +1,13 @@
 import { pki } from "node-forge";
 
 export interface MeebonCryptoProps {
-    privateKeyPem: string;
-    publicKeyPem: string;
-    schema?: pki.rsa.EncryptionScheme;
+  privateKeyPem: string;
+  publicKeyPem: string;
+  schema?: pki.rsa.EncryptionScheme;
 }
 
 export interface MeebonCryptoKeyPair {
-    privateKey: string;
-    publicKey: string;
-}
+  privateKey: string;
+  publicKey: string;
+  forRequest?: boolean;
+}

package/.github/workflows/release.yml

@@ -1,42 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - master
-      - beta
-
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "lts/*"
-
-      - name: Install pnpm
-        run: npm install -g pnpm
-
-      - name: Install dependencies with pnpm
-        run: pnpm install
-
-      - name: Build the project
-        run: pnpm run build
-
-      - name: Audit dependencies
-        run: pnpm audit --prod
-
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v4
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "scripts"]
-	path = scripts
-	url = https://github.com/KsoftmHub/ksoftm-node-build.git

package/.releaserc

@@ -1,28 +0,0 @@
-{
-  "branches": [
-    "master",
-    {
-      "name": "beta",
-      "prerelease": true
-    }
-  ],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    [
-      "@semantic-release/changelog",
-      {
-        "changelogFile": "CHANGELOG.md"
-      }
-    ],
-    [
-      "@semantic-release/git",
-      {
-        "assets": [
-          "CHANGELOG.md"
-        ]
-      }
-    ],
-    "@semantic-release/github"
-  ]
-}

package/.vscode/settings.json

@@ -1,15 +0,0 @@
-{
-    "files.exclude": {
-        "**/.git": false,
-        "**/.svn": false,
-        "**/.hg": false,
-        "**/CVS": false,
-        "**/.DS_Store": false,
-        "**/Thumbs.db": false,
-        "**/.classpath": false,
-        "**/.project": false,
-        "**/.settings": false,
-        "**/.factorypath": false
-    },
-    "explorerExclude.backup": {}
-}

package/jest.config.js

@@ -1,33 +0,0 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-/** @type {import('jest').Config} */
-const config = {
-  collectCoverage: true,
-  coverageDirectory: "coverage",
-  transformIgnorePatterns: [
-    "\\\\node_modules\\\\",
-    "\\.pnp\\.[^\\\\]+$",
-    '\\.d\\.ts$',
-  ],
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.tsx?$': 'ts-jest',
-  },
-  moduleNameMapper: {
-    '\\.(css|less|scss|sass)$': 'identity-obj-proxy',
-  },
-  coverageThreshold: {
-    global: {
-      branches: 80,
-      functions: 80,
-      lines: 80,
-      statements: 80,
-    },
-  },
-};
-
-export default config;

package/lib/ExpressEncryptionMiddleware.ts

@@ -1,47 +0,0 @@
-import { MeebonCrypto } from './MeebonCrypto';
-import { Request, Response, NextFunction, RequestHandler } from 'express';
-import { MeebonCryptoKeyPair } from '../types/global';
-
-/**
- * Middleware for encrypting incoming request data and decrypting outgoing response data.
- *
- * @param {MeebonCryptoKeyPair} keys - An object containing the privateKey and publicKey in PEM format.
- * @returns {RequestHandler} The Express middleware function.
- */
-function EncryptionMiddleware({ privateKey, publicKey }: MeebonCryptoKeyPair): RequestHandler {
-  return (req: Request, res: Response, next: NextFunction) => {
-    // Encrypt incoming request body data if it exists.
-    if (req.body && req.body.data) {
-      try {
-        // Encrypt the JSON-stringified data using the provided public key.
-        const plainText = JSON.stringify(req.body.data);
-        const encrypted = MeebonCrypto.encryptData(plainText, publicKey);
-        req.body.data = encrypted;
-      } catch (error: any) {
-        return next(new Error(error?.message || 'Encryption failed.'));
-      }
-    }
-    // Override res.send to decrypt the response body before sending it.
-    const originalSend = res.send.bind(res);
-    res.send = (body: any): Response => {
-      try {
-        // Only decrypt if body is a string.
-        if (typeof body === 'string') {
-          const decrypted = MeebonCrypto.decryptData(body, privateKey);
-          // Attempt to parse decrypted text as JSON. If parsing fails, send the plain decrypted text.
-          try {
-            body = JSON.parse(decrypted);
-          } catch {
-            body = decrypted;
-          }
-        }
-      } catch (error: any) {
-        throw new Error(error?.message ?? "Decryption failed");
-      }
-      return originalSend(body);
-    };
-    return next();
-  };
-}
-
-export { EncryptionMiddleware };

package/lib/MeebonCrypto.ts

@@ -1,98 +0,0 @@
-import forge from 'node-forge';
-import { MeebonCryptoKeyPair, MeebonCryptoProps } from '../types/global';
-
-export class MeebonCrypto {
-  protected privateKeyPem: string;
-  protected publicKeyPem: string;
-
-  public privateKey: forge.pki.rsa.PrivateKey;
-  public publicKey: forge.pki.rsa.PublicKey;
-
-  protected schema: forge.pki.rsa.EncryptionScheme;
-
-  private constructor({ privateKeyPem, publicKeyPem, schema }: MeebonCryptoProps) {
-    this.privateKeyPem = privateKeyPem;
-    this.publicKeyPem = publicKeyPem;
-
-    this.privateKey = forge.pki.privateKeyFromPem(privateKeyPem);
-    this.publicKey = forge.pki.publicKeyFromPem(publicKeyPem);
-    this.schema = schema ?? 'RSAES-PKCS1-V1_5';
-  }
-
-  /**
-   * Initializes a new instance of MeebonCrypto.
-   * @param props - The crypto properties including keys and optional encryption scheme.
-   * @returns {MeebonCrypto} The initialized MeebonCrypto instance.
-   */
-  public static init(props: MeebonCryptoProps): MeebonCrypto {
-    return new MeebonCrypto(props);
-  }
-
-  /**
-   * Encrypts data using the instance's public key.
-   * @param {string} plainText - The data to encrypt.
-   * @returns {string} The Base64-encoded encrypted data.
-   */
-  public encrypt(plainText: string): string {
-    const encryptedBytes = this.publicKey.encrypt(plainText, this.schema);
-    return forge.util.encode64(encryptedBytes);
-  }
-
-  /**
-   * Decrypts data using the instance's private key.
-   * @param {string} encryptedData - The Base64-encoded encrypted data.
-   * @returns {string} The decrypted data.
-   */
-  public decrypt(encryptedData: string): string {
-    const encryptedBytes = forge.util.decode64(encryptedData);
-    return this.privateKey.decrypt(encryptedBytes, this.schema);
-  }
-
-  /**
-   * Generates an RSA key pair with the specified key size.
-   *
-   * @param {number} [length=3072] - The length of the RSA key in bits (defaults to 3072).
-   * @returns {MeebonCryptoKeyPair} An object containing the generated public and private keys in PEM format.
-   */
-  public static generateKeyPair(length: number = 3072): MeebonCryptoKeyPair {
-    const keyPair = forge.pki.rsa.generateKeyPair({ bits: length, e: 0x10001 });
-    return {
-      publicKey: forge.pki.publicKeyToPem(keyPair.publicKey),
-      privateKey: forge.pki.privateKeyToPem(keyPair.privateKey),
-    };
-  }
-
-  /**
-   * Encrypts data with a provided public key.
-   * @param {string} data - The data to encrypt.
-   * @param {string} publicKey - The public key in PEM format.
-   * @param {string} [scheme='RSA-OAEP'] - The encryption scheme to use (defaults to 'RSA-OAEP').
-   * @returns {string} The Base64-encoded encrypted data.
-   */
-  public static encryptData(
-    data: string,
-    publicKey: string,
-    scheme: forge.pki.rsa.EncryptionScheme = 'RSA-OAEP'
-  ): string {
-    const publicKeyObj = forge.pki.publicKeyFromPem(publicKey);
-    const encryptedBytes = publicKeyObj.encrypt(data, scheme);
-    return forge.util.encode64(encryptedBytes);
-  }
-
-  /**
-   * Decrypts data with a provided private key.
-   * @param {string} encryptedData - The Base64-encoded encrypted data.
-   * @param {string} privateKey - The private key in PEM format.
-   * @param {string} [scheme='RSA-OAEP'] - The decryption scheme to use (defaults to 'RSA-OAEP').
-   * @returns {string} The decrypted data.
-   */
-  public static decryptData(
-    encryptedData: string,
-    privateKey: string,
-    scheme: forge.pki.rsa.EncryptionScheme = 'RSA-OAEP'
-  ): string {
-    const privateKeyObj = forge.pki.privateKeyFromPem(privateKey);
-    const decodedBytes = forge.util.decode64(encryptedData);
-    return privateKeyObj.decrypt(decodedBytes, scheme);
-  }
-}

package/lib/index.ts

@@ -1,4 +0,0 @@
-
-import { MeebonCrypto } from "./MeebonCrypto";
-import { EncryptionMiddleware } from "./ExpressEncryptionMiddleware";
-export { EncryptionMiddleware, MeebonCrypto };

package/script/build.ts

@@ -1,30 +0,0 @@
-import { cpSync, readFileSync, rmSync } from "node:fs";
-import { buildSync } from "esbuild";
-import pkg from "../package.json";
-import { execSync } from "node:child_process";
-
-// Find the build directory from tsconfig.json
-const tsc = JSON.parse(readFileSync("tsconfig.json", "utf-8"));
-const buildDir = tsc?.compilerOptions?.outDir ?? "dist";
-
-// Remove the existing build directory
-rmSync(buildDir, { force: true, recursive: true });
-
-// Build TypeScript declaration files (*.d.ts)
-execSync("tsc --project tsconfig.declaration.json", { stdio: "inherit" });
-
-// Build files using esbuild
-buildSync({
-  entryPoints: ["lib/index.ts"],
-  outfile: `${buildDir}/index.js`,
-  bundle: true,
-  platform: "node",
-  format: "esm",
-  inject: ["types/global.d.ts"],
-  tsconfig: "tsconfig.json",
-  external: Object.keys(pkg.dependencies),
-  resolveExtensions: [".ts", ".js", ".json", ".d.ts"],
-});
-
-// Optionally copy type files to the build directory
-// cpSync("types", "dist/types", { force: true, recursive: true });

package/script/clean.ts

@@ -1,27 +0,0 @@
-import { existsSync, readFileSync, rmSync } from "node:fs";
-import { execSync } from 'child_process'
-import picocolors from 'picocolors';
-import path from 'path'
-// find the build directory
-const tsc = JSON.parse(readFileSync("tsconfig.json").toString())
-const buildDir = tsc?.compilerOptions?.outDir ?? "dist";
-
-const foldersToClean = [
-  buildDir,
-  'coverage',
-
-
-  // package-manager lock files
-  'pnpm-lock.yaml',
-  'package-lock.json',
-  'yarn.lock',
-]
-
-foldersToClean.forEach(folder => {
-  if (existsSync(folder)) {
-    rmSync(folder, { force: true, recursive: true });
-    console.log(picocolors.redBright(`Folder: ${picocolors.italic(path.normalize(folder))} is deleted!`));
-  }
-})
-
-execSync("pnpm run refresh", { stdio: "inherit" })

package/script/tsup.config.ts

@@ -1,39 +0,0 @@
-import { defineConfig } from 'tsup'
-import pkg from '../package.json'
-
-export default defineConfig({
-  // Specify the entry file(s) for your build.
-  // Change or add more entries if needed.
-  entry: ['lib/**/*.ts'],
-
-  // Output directory for the build artifacts.
-  outDir: 'dist',
-
-  // Remove the output directory before building.
-  clean: true,
-
-  // Bundle your files into a single file per entry.
-  bundle: true,
-
-  // Target the Node.js environment (adjust version as needed)
-  target: 'node20',
-
-  // Generate sourcemaps for easier debugging.
-  sourcemap: true,
-
-  // Output format(s); here we're using ES modules.
-  format: ['esm'],
-
-  // Automatically generate .d.ts declaration files.
-  dts: {
-    // If you prefer to generate declarations for all entries, set dts: true.
-    // Alternatively, you can customize options here.
-    entry: 'lib/index.ts',
-  },
-
-  // Mark dependencies as external so they’re not bundled.
-  external: [
-    ...Object.keys(pkg?.dependencies || {}),
-    ...Object.keys(pkg?.peerDependencies || {})
-  ],
-})

package/tests/index.test.ts

@@ -1,4 +0,0 @@
-
-test('should expect true all time', () => {
-    expect({ data: "done" }).toStrictEqual({ data: "done" })
-})

package/tsconfig.declaration.json

@@ -1,20 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declarationMap": true,
-    "declaration": true,
-    "sourceMap": true,
-    "declarationDir": "./dist",
-    "emitDeclarationOnly": true,
-    "outDir": "./dist"
-  },
-  "include": [
-    "lib",
-    "types"
-  ],
-  "exclude": [
-    "node_modules",
-    "tests",
-    "coverage"
-  ]
-}

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "ES2022",
-    "declarationMap": false,
-    "outDir": "./dist",
-    "rootDir": "./lib",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "moduleResolution": "bundler",
-    "skipLibCheck": true
-  },
-  "exclude": [
-    "node_modules",
-    "dist",
-    "coverage",
-    "tests"
-  ],
-  "include": [
-    "lib",
-    "types"
-  ]
-}