rpc-express-toolkit 4.3.5 → 4.4.0

package/README.md

@@ -6,21 +6,34 @@
 [![npm version](https://img.shields.io/npm/v/rpc-express-toolkit.svg)](https://www.npmjs.com/package/rpc-express-toolkit)
 [![npm downloads](https://img.shields.io/npm/dm/rpc-express-toolkit.svg)](https://www.npmjs.com/package/rpc-express-toolkit)
 [![node](https://img.shields.io/node/v/rpc-express-toolkit.svg)](https://www.npmjs.com/package/rpc-express-toolkit)
+[![Status](https://img.shields.io/badge/status-stable-green.svg)](https://github.com/n-car/rpc-express-toolkit/releases)
 
 JSON-RPC 2.0 toolkit for Express.js with simplified APIs, middleware, schema validation, batch support, and optional Safe Mode type preservation.
 
+## Which Package Should I Use?
+
+- Use `rpc-express-toolkit` if you are building a JSON-RPC endpoint on Express.
+- Use [`rpc-node-toolkit`](https://github.com/n-car/rpc-node-toolkit) if you want framework-agnostic Node.js or plain `node:http`.
+- Use [`rpc-toolkit-js-client`](https://github.com/n-car/rpc-toolkit-js-client) if you only need a browser or Node.js client.
+- Use [`rpc-toolkit`](https://github.com/n-car/rpc-toolkit) as the ecosystem hub and compatibility reference.
+
 ## Quick Start
 
 ### Installation
 
 ```bash
-npm install rpc-express-toolkit
+npm install express rpc-express-toolkit
 # or
-yarn add rpc-express-toolkit
+yarn add express rpc-express-toolkit
 ```
 
 Requirements:
 - Node.js 18+ (uses `globalThis.fetch`)
+- Express 4.21+ or Express 5.x
+
+### Compatibility
+
+`rpc-express-toolkit` is tested with Node.js 18, 20, 22, and 24 across Express 4 and Express 5. See [Compatibility](docs/COMPATIBILITY.md) for the current runtime matrix.
 
 ### Server
 
@@ -142,7 +155,7 @@ Calls to methods outside the whitelist are rejected. This is a basic method rest
 [![npm (proxy)](https://img.shields.io/npm/v/rpc-express-toolkit-safe.svg)](https://www.npmjs.com/package/rpc-express-toolkit-safe)
 [![safe preset](https://img.shields.io/badge/safe%20preset-available-blue)](#safe-import-opt-in)
 
-When you control both client and server and want safer type round-trips, import the safe preset. It enables safe serialization by default (and strict mode on the server):
+When you control both client and server and want safer type round-trips, import the built-in safe preset from `rpc-express-toolkit/safe`. It enables safe serialization by default and strict mode on the server:
 
 ```js
 // Server (safe preset)
@@ -161,9 +174,9 @@ const client = new RpcSafeClient('http://localhost:3000/api');
 
 This keeps JSON-RPC 2.0 compliance as default for the main entrypoint, while offering a convenient safe-mode import for projects that prefer explicit type disambiguation.
 
-Alternative: npm proxy package
+#### Alternative Compatibility Package
 
-If you prefer a dedicated package name, you can install the thin proxy `rpc-express-toolkit-safe` which simply re-exports the safe preset:
+`rpc-express-toolkit-safe` is a thin compatibility package that re-exports the same safe preset. Use it only when a separate package name is useful for dependency policy or migration; new projects can import `rpc-express-toolkit/safe` directly.
 
 ```bash
 npm install rpc-express-toolkit-safe
@@ -227,7 +240,7 @@ In `__rpc.capabilities`, `auth` is a boolean indicating whether authentication m
 
 For advanced configuration, middleware, structured logging, safe serialization, error handling, and more, see `README_ADVANCED.md`.
 
-## 🔗 Related Projects
+## Related Projects
 
 - [rpc-php-toolkit](https://github.com/n-car/rpc-php-toolkit) - PHP implementation
 - [rpc-dotnet-toolkit](https://github.com/n-car/rpc-dotnet-toolkit) - .NET implementation

package/docs/COMPATIBILITY.md

@@ -0,0 +1,37 @@
+# Compatibility
+
+`rpc-express-toolkit` is tested as an Express integration library, not as an application framework replacement.
+
+## Runtime Matrix
+
+| Runtime | Status |
+| --- | --- |
+| Node.js 18.x | CI tested |
+| Node.js 20.x | CI tested |
+| Node.js 22.x | CI tested |
+| Node.js 24.x | CI tested |
+| Express 4.x | CI tested |
+| Express 5.x | CI tested |
+
+The GitHub Actions matrix runs the test suite across Node.js 18, 20, 22, and 24 with both Express 4 and Express 5.
+
+## Express Dependency
+
+Express is declared as a peer dependency:
+
+```json
+"express": "^4.21.2 || ^5.0.0"
+```
+
+Applications should install Express directly alongside `rpc-express-toolkit`.
+
+## Compatibility Coverage
+
+The Express compatibility tests cover:
+
+- standard JSON-RPC endpoint calls;
+- batch requests;
+- Safe Mode endpoints;
+- introspection reporting of the active Express runtime.
+
+Broader RPC behavior is covered by the main test suite and is expected to run identically on Express 4 and Express 5.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name":  "rpc-express-toolkit",
-    "version":  "4.3.5",
+    "version":  "4.4.0",
     "description":  "JSON-RPC 2.0 toolkit for Express.js with simplified APIs, structured logging, middleware, schema validation, batch support, and optional Safe Mode.",
     "main":  "src/index.js",
     "types":  "src/index.d.ts",
@@ -19,6 +19,7 @@
     "files":  [
                   "src/",
                   "examples/",
+                  "docs/COMPATIBILITY.md",
                   "README.md",
                   "LICENSE"
               ],
@@ -66,7 +67,7 @@
                      "rate-limit",
                      "authentication"
                  ],
-    "author":  "Nicola Carpanese \u003cnicola.carpanese@gmail.com\u003e",
+    "author":  "Nicola Carpanese (https://github.com/n-car)",
     "license":  "MIT",
     "bugs":  {
                  "url":  "https://github.com/n-car/rpc-express-toolkit/issues"
@@ -81,6 +82,7 @@
                             "eslint-config-prettier":  "^9.1.2",
                             "eslint-plugin-import":  "^2.31.0",
                             "eslint-plugin-prettier":  "^5.5.3",
+                            "express":  "^4.21.2 || ^5.0.0",
                             "husky":  "^8.0.0",
                             "jest":  "^29.7.0",
                             "lint-staged":  "^13.0.0",
@@ -88,10 +90,12 @@
                             "supertest":  "^6.3.3",
                             "terser":  "^5.43.1"
                         },
+    "peerDependencies":  {
+                             "express":  "^4.21.2 || ^5.0.0"
+                         },
     "dependencies":  {
                          "ajv":  "^8.12.0",
                          "ajv-formats":  "^2.1.1",
-                         "express":  "^4.21.2",
                          "nested-error-stacks":  "^2.1.1",
                          "rpc-toolkit-js-client":  "^1.1.2"
                      },
@@ -101,7 +105,6 @@
     "contributors":  [
                          {
                              "name":  "Nicola Carpanese",
-                             "email":  "nicola.carpanese@gmail.com",
                              "url":  "https://github.com/n-car"
                          }
                      ],

package/src/index.js

@@ -288,21 +288,23 @@ class RpcEndpoint {
     this.addMethod(
       `${this.#introspectionPrefix}.describeAll`,
       async (_req, _context, _params) => {
-        const publicMethods = [];
+        const publicMethods = Object.entries(this.#methods)
+          .filter(([name]) => !name.startsWith(this.#introspectionPrefix))
+          .map(([name, methodConfig]) => {
+            const config =
+              typeof methodConfig === 'function' ? {} : methodConfig;
 
-        for (const [name, methodConfig] of Object.entries(this.#methods)) {
-          // Skip introspection methods
-          if (name.startsWith(this.#introspectionPrefix)) continue;
+            if (!config.exposeSchema) {
+              return null;
+            }
 
-          const config = typeof methodConfig === 'function' ? {} : methodConfig;
-          if (config.exposeSchema) {
-            publicMethods.push({
+            return {
               name,
               schema: config.schema || null,
               description: config.description || '',
-            });
-          }
-        }
+            };
+          })
+          .filter(Boolean);
 
         return publicMethods;
       },