xypriss 9.3.68 → 9.3.69

package/.xypriss-compression-dev/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nehonix Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/.xypriss-compression-dev/README.md

@@ -0,0 +1,229 @@
+# XyPriss Compression
+
+Custom compression middleware for Express/Connect with strict algorithm enforcement.
+
+## Key Feature
+
+Unlike the standard `compression` package, `xypriss-compression` enforces which compression algorithms can be used. If you configure `algorithms: ['br', 'deflate']`, it will never use gzip, even if the client requests it.
+
+## Problem Solved
+
+The original `compression` package has no way to restrict which algorithms are used. It automatically chooses based on the client's `Accept-Encoding` header, ignoring your configuration.
+
+**Example of the problem:**
+
+```javascript
+// Using standard 'compression' package
+const compression = require("compression");
+app.use(
+  compression({
+    // This option doesn't exist!
+    // algorithms: ['br', 'deflate']
+  })
+);
+
+// Client requests gzip → Server uses gzip (no control!)
+```
+
+**With xypriss-compression:**
+
+```typescript
+import compression from "xypriss-compression-pluging";
+
+app.use(
+  compression({
+    algorithms: ["br", "deflate"], // STRICTLY ENFORCED
+  })
+);
+
+// Client requests gzip → Server responds with identity (uncompressed)
+// Client requests br → Server uses brotli
+// Client requests deflate → Server uses deflate
+```
+
+## Installation
+
+```bash
+npm install xypriss-compression
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import express from "express";
+import compression from "xypriss-compression-pluging";
+
+const app = express();
+
+// Use with default settings (gzip, deflate)
+app.use(compression());
+
+app.listen(3000);
+```
+
+### With Algorithm Enforcement
+
+```typescript
+import compression from "xypriss-compression-pluging";
+
+app.use(
+  compression({
+    // Only allow Brotli and Deflate
+    algorithms: ["br", "deflate"],
+
+    // Compression level (1-9 for gzip/deflate, 0-11 for brotli)
+    level: 6,
+
+    // Minimum size to compress (1KB)
+    threshold: "1kb",
+  })
+);
+```
+
+### Advanced Configuration
+
+```typescript
+app.use(
+  compression({
+    algorithms: ["br", "gzip"],
+    level: 9,
+    threshold: 2048,
+
+    // Custom filter
+    filter: (req, res) => {
+      // Don't compress images
+      const type = res.getHeader("Content-Type");
+      if (type && type.toString().startsWith("image/")) {
+        return false;
+      }
+      return true;
+    },
+
+    // Brotli-specific options
+    brotli: {
+      params: {
+        [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,
+      },
+    },
+
+    // Gzip-specific options
+    gzip: {
+      memLevel: 8,
+    },
+  })
+);
+```
+
+## API
+
+### `compression(options?)`
+
+Creates a compression middleware.
+
+#### Options
+
+| Option       | Type                                 | Default               | Description                                               |
+| ------------ | ------------------------------------ | --------------------- | --------------------------------------------------------- |
+| `algorithms` | `Array<'gzip' \| 'deflate' \| 'br'>` | `['gzip', 'deflate']` | Strictly enforced list of allowed algorithms              |
+| `level`      | `number`                             | `6`                   | Compression level (1-9 for gzip/deflate, 0-11 for brotli) |
+| `threshold`  | `number \| string`                   | `1024`                | Minimum response size to compress                         |
+| `filter`     | `Function`                           | `shouldCompress`      | Custom filter function                                    |
+| `brotli`     | `BrotliOptions`                      | `{}`                  | Brotli-specific options                                   |
+| `gzip`       | `ZlibOptions`                        | `{}`                  | Gzip-specific options                                     |
+| `deflate`    | `ZlibOptions`                        | `{}`                  | Deflate-specific options                                  |
+
+## How It Works
+
+1. Client sends request with `Accept-Encoding: gzip, deflate, br`
+2. Middleware checks which algorithms are in the `algorithms` config
+3. Selects best match from allowed algorithms (priority: br > gzip > deflate)
+4. If no match, responds with uncompressed data (identity)
+
+### Algorithm Selection Priority
+
+When multiple algorithms are allowed and accepted by the client:
+
+1. **Brotli (br)** - Best compression ratio
+2. **Gzip (gzip)** - Good compression, widely supported
+3. **Deflate (deflate)** - Faster but less efficient
+
+## Comparison with `compression`
+
+| Feature               | `compression` | `xypriss-compression` |
+| --------------------- | ------------- | --------------------- |
+| Algorithm enforcement | No            | Yes                   |
+| TypeScript            | No            | Yes                   |
+| Custom filters        | Yes           | Yes                   |
+| Threshold             | Yes           | Yes                   |
+| Brotli support        | Yes           | Yes                   |
+
+## Use Cases
+
+### Security Compliance
+
+```typescript
+// Only use approved algorithms
+app.use(
+  compression({
+    algorithms: ["br"], // Company policy: Brotli only
+  })
+);
+```
+
+### Performance Optimization
+
+```typescript
+// Prefer speed over compression ratio
+app.use(
+  compression({
+    algorithms: ["deflate"], // Fastest
+    level: 1,
+  })
+);
+```
+
+### Modern Browsers Only
+
+```typescript
+// Serve Brotli to modern browsers, nothing to old ones
+app.use(
+  compression({
+    algorithms: ["br"],
+    filter: (req, res) => {
+      // Fallback to uncompressed for old browsers
+      return req.headers["user-agent"]?.includes("Chrome") || false;
+    },
+  })
+);
+```
+
+## Debugging
+
+Enable debug logs:
+
+```bash
+DEBUG=xypriss:compression node app.js
+```
+
+## License
+
+MIT
+
+## Author
+
+**Nehonix Team**
+
+- Website: [nehonix.com](https://nehonix.com)
+- GitHub: [@Nehonix-Team](https://github.com/Nehonix-Team)
+
+## Credits
+
+Based on [expressjs/compression](https://github.com/expressjs/compression) but with strict algorithm enforcement.
+
+## Links
+
+- [GitHub Repository](https://github.com/Nehonix-Team/xypriss-compression-plugin)
+- [Issue Tracker](https://github.com/Nehonix-Team/xypriss-compression-plugin/issues)
+- [XyPriss Framework](https://github.com/Nehonix-Team/XyPriss)

package/.xypriss-compression-dev/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "xypriss-compression-pluging",
+  "version": "1.0.3",
+  "description": "Custom compression middleware for XyPriss with strict algorithm enforcement",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "compression",
+    "gzip",
+    "deflate",
+    "brotli",
+    "br",
+    "middleware",
+    "express",
+    "xypriss",
+    "http",
+    "stream",
+    "algorithm-enforcement",
+    "typescript"
+  ],
+  "author": {
+    "name": "Nehonix Team",
+    "url": "https://nehonix.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Nehonix-Team/xypriss-compression-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Nehonix-Team/xypriss-compression-plugin/issues"
+  },
+  "homepage": "https://github.com/Nehonix-Team/xypriss-compression-plugin#readme",
+  "dependencies": {
+    "bytes": "^3.1.2",
+    "compressible": "^2.0.18",
+    "debug": "^2.6.9",
+    "on-headers": "^1.1.0",
+    "vary": "^1.1.2"
+  },
+  "devDependencies": {
+    "@types/bytes": "^3.1.4",
+    "@types/compressible": "^2.0.2",
+    "@types/debug": "^4.1.12",
+    "@types/negotiator": "^0.6.4",
+    "@types/node": "^20.0.0",
+    "@types/on-headers": "^1.0.4",
+    "@types/vary": "^1.1.3",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  }
+}

package/dist/index.d.ts

@@ -335,6 +335,38 @@ interface PaginationInfo {
     /** Total number of pages */
     pages: number;
 }
+/**
+ * Configuration for internal response manipulation.
+ *
+/**
+ * Rules for masking or replacing fields in responses.
+ *
+ * @interface ResponseManipulationRule
+ */
+interface ResponseManipulationRule {
+    /** Field name (dot notation) or RegExp pattern for matching keys */
+    field: string | RegExp;
+    /** Mask string (e.g., "****") or replacement value */
+    replacement?: any;
+    /** Number of characters to preserve (at the beginning) for string masking */
+    preserve?: number;
+}
+/**
+ * Configuration for internal response manipulation.
+ *
+ * Allows masking or replacing specific fields in JSON responses
+ * before they are sent to the client.
+ *
+ * @interface ResponseManipulationConfig
+ */
+interface ResponseManipulationConfig {
+    /** Enable response manipulation */
+    enabled?: boolean;
+    /** Rules for masking or replacing fields */
+    rules?: ResponseManipulationRule[];
+    /** Maximum recursion depth for nested objects (default: 10) */
+    maxDepth?: number;
+}
 /**
  * Enhanced Express request interface with additional utilities.
  *
@@ -1083,7 +1115,9 @@ interface CSRFConfig {
  * ```
  */
 interface RequestSignatureConfig {
-    /** The secret value that must match the XP-Request-Sig header */
+    /** Custom header name for the signature (default: "XP-Request-Sig") */
+    headerName?: string;
+    /** The secret value that must match the header */
     secret: string;
     /** Custom error message for blocked requests */
     errorMessage?: string;
@@ -6387,6 +6421,8 @@ interface MultiServerConfig extends Omit<Partial<ServerOptions$1>, "server"> {
  */
 interface ServerOptions$1 {
     notFound?: NotFoundConfig;
+    /** Response manipulation configuration */
+    responseManipulation?: ResponseManipulationConfig;
     /** Plugin configuration */
     plugins?: PluginConfig;
     /**

package/package.json

@@ -1,144 +1,124 @@
 {
-    "name": "xypriss",
-    "version": "9.3.68",
-    "description": "XyPriss is a lightweight, TypeScript-first, open-source Node.js web framework crafted for developers seeking a familiar Express-like API without Express dependencies.",
-    "type": "module",
-    "author": {
-        "name": "Nehonix",
-        "url": "https://nehonix.com",
-        "whatsapp": "https://s.nehonix.com/QBo0KpCl"
-    },
-    "main": "./dist/cjs/src/index.js",
-    "module": "./dist/esm/src/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-        ".": {
-            "import": "./dist/esm/src/index.js",
-            "require": "./dist/cjs/src/index.js",
-            "types": "./dist/index.d.ts"
-        }
-    },
-    "files": [
-        "dist/",
-        "shared/",
-        "scripts/",
-        "README.md",
-        "LICENSE",
-        "CONTRIBUTING.md"
-    ],
-    "scripts": {
-        "benchmark": "node benchmarks/index.js",
-        "build": "NODE_OPTIONS='--max-old-space-size=4096' npx rollup -c rollup.config.js",
-        "build:memory": "NODE_OPTIONS='--max-old-space-size=6144' npx rollup -c rollup.config.js",
-        "install-memory-cli": "node scripts/install-memory-cli.js",
-        "install-xsys": "node scripts/postinstall-xsys.js",
-        "postinstall": "node scripts/postinstall.js",
-        "prepublishOnly": "npm run build",
-        "test": "jest",
-        "test:coverage": "jest --coverage",
-        "test:watch": "jest --watch"
-    },
-    "dependencies": {
-        "@noble/ciphers": "^1.3.0",
-        "@noble/curves": "^1.9.7",
-        "@noble/hashes": "^1.8.0",
-        "@noble/secp256k1": "^2.3.0",
-        "@types/cookie-parser": "^1.4.10",
-        "@types/fast-json-stable-stringify": "^2.1.2",
-        "@types/ioredis": "^4.28.10",
-        "@types/msgpack-lite": "^0.1.12",
-        "@types/node-os-utils": "^1.3.4",
-        "@types/pako": "^2.0.4",
-        "@types/pidusage": "^2.0.5",
-        "@types/redis": "^4.0.11",
-        "@types/systeminformation": "^3.54.1",
-        "aes-js": "^3.1.2",
-        "argon2": "^0.43.1",
-        "argon2-browser": "^1.18.0",
-        "bcrypt": "^6.0.0",
-        "bcryptjs": "^2.4.3",
-        "bun": "^1.3.10",
-        "check-disk-space": "^3.4.0",
-        "compression": "^1.8.1",
-        "concurrently": "^8.2.2",
-        "cookie-parser": "^1.4.7",
-        "cors": "^2.8.6",
-        "crypto-js": "^4.2.0",
-        "crystals-kyber": "^5.1.0",
-        "csrf-csrf": "^4.0.3",
-        "elliptic": "^6.6.1",
-        "entropy-string": "^4.2.0",
-        "express-brute": "^1.0.1",
-        "express-mongo-sanitize": "^2.2.0",
-        "express-slow-down": "^3.0.1",
-        "fast-json-stable-stringify": "^2.1.0",
-        "fast-json-stringify": "^6.3.0",
-        "helmet": "^8.1.0",
-        "hpp": "^0.2.3",
-        "http-proxy-middleware": "^3.0.5",
-        "ioredis": "^5.10.0",
-        "kyber-crystals": "^1.0.7",
-        "libsodium-wrappers": "^0.7.16",
-        "mime-types": "^2.1.35",
-        "morgan": "^1.10.1",
-        "msgpack-lite": "^0.1.26",
-        "multer": "^2.1.0",
-        "nehoid": "^2.1.4",
-        "noble": "^1.9.1",
-        "node-fetch": "^3.3.2",
-        "node-forge": "^1.3.3",
-        "node-os-utils": "^1.3.7",
-        "pako": "^2.1.0",
-        "pbkdf2": "^3.1.5",
-        "pidusage": "^4.0.1",
-        "pqc-kyber": "^0.7.0",
-        "randombytes": "^2.1.0",
-        "redis": "^5.11.0",
-        "reliant-type": "^2.1.5",
-        "scrypt-js": "^3.0.1",
-        "secure-random": "^1.1.2",
-        "strulink": "^1.1.0",
-        "systeminformation": "^5.31.1",
-        "tweetnacl": "^1.0.3",
-        "ws": "^8.19.0",
-        "xss": "^1.0.15",
-        "xypriss-compression-pluging": "^1.0.3",
-        "xypriss-security": "^2.1.1"
-    },
-    "devDependencies": {
-        "@rollup/plugin-commonjs": "^25.0.8",
-        "@rollup/plugin-json": "^6.1.0",
-        "@rollup/plugin-node-resolve": "^15.3.1",
-        "@rollup/plugin-terser": "^0.4.4",
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@types/bcrypt": "^5.0.2",
-        "@types/compression": "^1.8.1",
-        "@types/cors": "^2.8.19",
-        "@types/helmet": "^0.0.48",
-        "@types/hpp": "^0.2.7",
-        "@types/jest": "^29.5.14",
-        "@types/libsodium-wrappers": "^0.7.14",
-        "@types/morgan": "^1.9.10",
-        "@types/multer": "^2.0.0",
-        "@types/noble": "^0.0.44",
-        "@types/node": "^25.3.3",
-        "@types/react": "^18.3.28",
-        "@types/ws": "^8.18.1",
-        "@typescript-eslint/eslint-plugin": "^5.62.0",
-        "@typescript-eslint/parser": "^5.62.0",
-        "axios": "^1.13.6",
-        "eslint": "^8.57.1",
-        "jest": "^29.7.0",
-        "rimraf": "^4.4.1",
-        "rollup": "^4.59.0",
-        "rollup-plugin-dts": "^6.3.0",
-        "rollup-plugin-typescript2": "^0.34.1",
-        "ts-jest": "^29.4.6",
-        "ts-node": "^10.9.2",
-        "typedoc": "^0.25.13"
-    },
-    "peerDependencies": {
-        "react": ">=16.8.0"
-    }
-}
-
+  "name": "xypriss",
+  "version": "9.3.69",
+  "description": "XyPriss is a lightweight, TypeScript-first, open-source Node.js web framework crafted for developers seeking a familiar Express-like API without Express dependencies.",
+  "author": {
+    "name": "Nehonix",
+    "url": "https://nehonix.com",
+    "whatsapp": "https://s.nehonix.com/QBo0KpCl"
+  },
+  "scripts": {
+    "benchmark": "node benchmarks/index.js",
+    "build": "NODE_OPTIONS='--max-old-space-size=4096' npx rollup -c rollup.config.js",
+    "build:memory": "NODE_OPTIONS='--max-old-space-size=6144' npx rollup -c rollup.config.js",
+    "install-memory-cli": "node scripts/install-memory-cli.js",
+    "install-xsys": "node scripts/postinstall-xsys.js",
+    "postinstall": "node scripts/postinstall.js",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@noble/ciphers": "^1.3.0",
+    "@noble/curves": "^1.9.7",
+    "@noble/hashes": "^1.8.0",
+    "@noble/secp256k1": "^2.3.0",
+    "@types/cookie-parser": "^1.4.10",
+    "@types/fast-json-stable-stringify": "^2.1.2",
+    "@types/ioredis": "^4.28.10",
+    "@types/msgpack-lite": "^0.1.12",
+    "@types/node-os-utils": "^1.3.4",
+    "@types/pako": "^2.0.4",
+    "@types/pidusage": "^2.0.5",
+    "@types/redis": "^4.0.11",
+    "@types/systeminformation": "^3.54.1",
+    "aes-js": "^3.1.2",
+    "argon2": "^0.43.1",
+    "argon2-browser": "^1.18.0",
+    "bcrypt": "^6.0.0",
+    "bcryptjs": "^2.4.3",
+    "bun": "^1.3.10",
+    "check-disk-space": "^3.4.0",
+    "compression": "^1.8.1",
+    "concurrently": "^8.2.2",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.6",
+    "crypto-js": "^4.2.0",
+    "crystals-kyber": "^5.1.0",
+    "csrf-csrf": "^4.0.3",
+    "elliptic": "^6.6.1",
+    "entropy-string": "^4.2.0",
+    "express-brute": "^1.0.1",
+    "express-mongo-sanitize": "^2.2.0",
+    "express-slow-down": "^3.0.1",
+    "fast-json-stable-stringify": "^2.1.0",
+    "fast-json-stringify": "^6.3.0",
+    "helmet": "^8.1.0",
+    "hpp": "^0.2.3",
+    "http-proxy-middleware": "^3.0.5",
+    "ioredis": "^5.10.0",
+    "kyber-crystals": "^1.0.7",
+    "libsodium-wrappers": "^0.7.16",
+    "mime-types": "^2.1.35",
+    "morgan": "^1.10.1",
+    "msgpack-lite": "^0.1.26",
+    "multer": "^2.1.0",
+    "nehoid": "^2.1.4",
+    "noble": "^1.9.1",
+    "node-fetch": "^3.3.2",
+    "node-forge": "^1.3.3",
+    "node-os-utils": "^1.3.7",
+    "pako": "^2.1.0",
+    "pbkdf2": "^3.1.5",
+    "pidusage": "^4.0.1",
+    "pqc-kyber": "^0.7.0",
+    "randombytes": "^2.1.0",
+    "redis": "^5.11.0",
+    "reliant-type": "^2.1.5",
+    "scrypt-js": "^3.0.1",
+    "secure-random": "^1.1.2",
+    "strulink": "^1.1.0",
+    "systeminformation": "^5.31.1",
+    "tweetnacl": "^1.0.3",
+    "ws": "^8.19.0",
+    "xss": "^1.0.15",
+    "xypriss-compression-pluging": "^1.0.3",
+    "xypriss-security": "^2.1.10"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/bcrypt": "^5.0.2",
+    "@types/compression": "^1.8.1",
+    "@types/cors": "^2.8.19",
+    "@types/helmet": "^0.0.48",
+    "@types/hpp": "^0.2.7",
+    "@types/jest": "^29.5.14",
+    "@types/libsodium-wrappers": "^0.7.14",
+    "@types/morgan": "^1.9.10",
+    "@types/multer": "^2.0.0",
+    "@types/noble": "^0.0.44",
+    "@types/node": "^25.3.3",
+    "@types/react": "^18.3.28",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "axios": "^1.13.6",
+    "eslint": "^8.57.1",
+    "jest": "^29.7.0",
+    "rimraf": "^4.4.1",
+    "rollup": "^4.59.0",
+    "rollup-plugin-dts": "^6.3.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13"
+  },
+  "peerDependencies": {
+    "react": "\u003e=16.8.0"
+  }
+}