xypriss 9.3.62 → 9.3.63

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"
+  }
+}