rpc-express-toolkit 2.3.3 → 3.0.0

package/src/middleware.js

@@ -1,224 +1,229 @@
-"use strict";
-
-/**
- * Middleware manager for JSON-RPC operations
- */
-class MiddlewareManager {
-  constructor() {
-    this.middlewares = {
-      beforeCall: [],
-      afterCall: [],
-      onError: [],
-      beforeValidation: [],
-      afterValidation: []
-    };
-  }
-
-  /**
-   * Add middleware for a specific hook
-   * @param {string} hook - The hook name (beforeCall, afterCall, onError, etc.)
-   * @param {Function} middleware - The middleware function
-   */
-  use(hook, middleware) {
-    if (!this.middlewares[hook]) {
-      throw new Error(`Unknown middleware hook: ${hook}`);
-    }
-    
-    if (typeof middleware !== 'function') {
-      throw new Error('Middleware must be a function');
-    }
-    
-    this.middlewares[hook].push(middleware);
-  }
-
-  /**
-   * Execute middlewares for a specific hook
-   * @param {string} hook 
-   * @param {Object} context 
-   * @returns {Promise<Object>}
-   */
-  async execute(hook, context) {
-    const middlewares = this.middlewares[hook] || [];
-    let result = context;
-    
-    for (const middleware of middlewares) {
-      try {
-        const middlewareResult = await middleware(result);
-        
-        // If middleware returns an object, merge it with context
-        if (middlewareResult && typeof middlewareResult === 'object') {
-          result = { ...result, ...middlewareResult };
-        }
-        
-        // If middleware explicitly returns false, stop execution
-        if (middlewareResult === false) {
-          throw new Error('Middleware execution stopped');
-        }
-      } catch (error) {
-        // For error hooks, continue even if middleware fails
-        if (hook === 'onError') {
-          console.error('Error middleware failed:', error);
-          continue;
-        }
-        throw error;
-      }
-    }
-    
-    return result;
-  }
-
-  /**
-   * Get all middlewares for a hook
-   * @param {string} hook 
-   * @returns {Function[]}
-   */
-  getMiddlewares(hook) {
-    return this.middlewares[hook] || [];
-  }
-
-  /**
-   * Remove all middlewares for a hook
-   * @param {string} hook 
-   */
-  clear(hook) {
-    if (hook) {
-      this.middlewares[hook] = [];
-    } else {
-      // Clear all hooks
-      Object.keys(this.middlewares).forEach(h => {
-        this.middlewares[h] = [];
-      });
-    }
-  }
-
-  /**
-   * Remove a specific middleware from a hook
-   * @param {string} hook 
-   * @param {Function} middleware 
-   */
-  remove(hook, middleware) {
-    if (!this.middlewares[hook]) return;
-    
-    const index = this.middlewares[hook].indexOf(middleware);
-    if (index > -1) {
-      this.middlewares[hook].splice(index, 1);
-    }
-  }
-}
-
-/**
- * Built-in middleware functions
- */
-const builtInMiddlewares = {
-  /**
-   * Rate limiting middleware
-   * @param {Object} options 
-   * @returns {Function}
-   */
-  rateLimit(options = {}) {
-    const windowMs = options.windowMs || 60000; // 1 minute
-    const max = options.max || 100; // 100 requests per window
-    const message = options.message || 'Too many requests';
-    
-    const requests = new Map();
-    
-    return async (context) => {
-      const { req } = context;
-      const key = req.ip || req.connection?.remoteAddress || 'unknown';
-      const now = Date.now();
-      
-      // Clean old entries
-      if (requests.has(key)) {
-        const userRequests = requests.get(key);
-        const validRequests = userRequests.filter(time => now - time < windowMs);
-        requests.set(key, validRequests);
-      }
-      
-      const userRequests = requests.get(key) || [];
-      
-      if (userRequests.length >= max) {
-        const error = new Error(message);
-        error.code = -32000; // Custom JSON-RPC error code
-        throw error;
-      }
-      
-      userRequests.push(now);
-      requests.set(key, userRequests);
-      
-      return context;
-    };
-  },
-
-  /**
-   * Authentication middleware
-   * @param {Function} authFunction 
-   * @returns {Function}
-   */
-  auth(authFunction) {
-    return async (context) => {
-      const { req } = context;
-      const isAuthenticated = await authFunction(req);
-      
-      if (!isAuthenticated) {
-        const error = new Error('Authentication required');
-        error.code = -32001;
-        throw error;
-      }
-      
-      return context;
-    };
-  },
-
-  /**
-   * CORS middleware
-   * @param {Object} options 
-   * @returns {Function}
-   */
-  cors(options = {}) {
-    const origin = options.origin || '*';
-    const methods = options.methods || ['POST'];
-    const headers = options.headers || ['Content-Type'];
-    
-    return async (context) => {
-      const { res } = context;
-      
-      res.header('Access-Control-Allow-Origin', origin);
-      res.header('Access-Control-Allow-Methods', methods.join(', '));
-      res.header('Access-Control-Allow-Headers', headers.join(', '));
-      
-      return context;
-    };
-  },
-
-  /**
-   * Request timing middleware
-   * @returns {Function}
-   */
-  timing() {
-    return async (context) => {
-      context.startTime = Date.now();
-      return context;
-    };
-  },
-
-  /**
-   * Method whitelist middleware
-   * @param {string[]} allowedMethods 
-   * @returns {Function}
-   */
-  methodWhitelist(allowedMethods) {
-    return async (context) => {
-      const { method } = context;
-      
-      if (!allowedMethods.includes(method)) {
-        const error = new Error(`Method '${method}' is not allowed`);
-        error.code = -32601;
-        throw error;
-      }
-      
-      return context;
-    };
-  }
-};
-
-module.exports = { MiddlewareManager, builtInMiddlewares };
+/**
+ * @file Middleware Manager
+ * @description Handles middleware execution for JSON-RPC requests including built-in middleware
+ */
+
+/**
+ * Middleware manager for handling RPC middleware
+ */
+class MiddlewareManager {
+  constructor() {
+    this.middlewares = {
+      beforeCall: [],
+      afterCall: [],
+      onError: [],
+      beforeValidation: [],
+      afterValidation: [],
+    };
+  }
+
+  /**
+   * Add middleware for a specific hook
+   * @param {string} hook - The hook name (beforeCall, afterCall, onError, etc.)
+   * @param {Function} middleware - The middleware function
+   */
+  use(hook, middleware) {
+    if (!this.middlewares[hook]) {
+      throw new Error(`Unknown middleware hook: ${hook}`);
+    }
+
+    if (typeof middleware !== 'function') {
+      throw new Error('Middleware must be a function');
+    }
+
+    this.middlewares[hook].push(middleware);
+  }
+
+  /**
+   * Execute middlewares for a specific hook
+   * @param {string} hook
+   * @param {Object} context
+   * @returns {Promise<Object>}
+   */
+  async execute(hook, context) {
+    const middlewares = this.middlewares[hook] || [];
+    let result = context;
+
+    for (const middleware of middlewares) {
+      try {
+        const middlewareResult = await middleware(result);
+
+        // If middleware returns an object, merge it with context
+        if (middlewareResult && typeof middlewareResult === 'object') {
+          result = { ...result, ...middlewareResult };
+        }
+
+        // If middleware explicitly returns false, stop execution
+        if (middlewareResult === false) {
+          throw new Error('Middleware execution stopped');
+        }
+      } catch (error) {
+        // For error hooks, continue even if middleware fails
+        if (hook === 'onError') {
+          console.error('Error middleware failed:', error);
+          continue;
+        }
+        throw error;
+      }
+    }
+
+    return result;
+  }
+
+  /**
+   * Get all middlewares for a hook
+   * @param {string} hook
+   * @returns {Function[]}
+   */
+  getMiddlewares(hook) {
+    return this.middlewares[hook] || [];
+  }
+
+  /**
+   * Remove all middlewares for a hook
+   * @param {string} hook
+   */
+  clear(hook) {
+    if (hook) {
+      this.middlewares[hook] = [];
+    } else {
+      // Clear all hooks
+      Object.keys(this.middlewares).forEach((h) => {
+        this.middlewares[h] = [];
+      });
+    }
+  }
+
+  /**
+   * Remove a specific middleware from a hook
+   * @param {string} hook
+   * @param {Function} middleware
+   */
+  remove(hook, middleware) {
+    if (!this.middlewares[hook]) return;
+
+    const index = this.middlewares[hook].indexOf(middleware);
+    if (index > -1) {
+      this.middlewares[hook].splice(index, 1);
+    }
+  }
+}
+
+/**
+ * Built-in middleware functions
+ */
+const builtInMiddlewares = {
+  /**
+   * Rate limiting middleware
+   * @param {Object} options
+   * @returns {Function}
+   */
+  rateLimit(options = {}) {
+    const windowMs = options.windowMs || 60000; // 1 minute
+    const max = options.max || 100; // 100 requests per window
+    const message = options.message || 'Too many requests';
+
+    const requests = new Map();
+
+    return async (context) => {
+      const { req } = context;
+      const key = req.ip || req.connection?.remoteAddress || 'unknown';
+      const now = Date.now();
+
+      // Clean old entries
+      if (requests.has(key)) {
+        const userRequests = requests.get(key);
+        const validRequests = userRequests.filter(
+          (time) => now - time < windowMs
+        );
+        requests.set(key, validRequests);
+      }
+
+      const userRequests = requests.get(key) || [];
+
+      if (userRequests.length >= max) {
+        const error = new Error(message);
+        error.code = -32000; // Custom JSON-RPC error code
+        throw error;
+      }
+
+      userRequests.push(now);
+      requests.set(key, userRequests);
+
+      return context;
+    };
+  },
+
+  /**
+   * Authentication middleware
+   * @param {Function} authFunction
+   * @returns {Function}
+   */
+  auth(authFunction) {
+    return async (context) => {
+      const { req } = context;
+      const isAuthenticated = await authFunction(req);
+
+      if (!isAuthenticated) {
+        const error = new Error('Authentication required');
+        error.code = -32001;
+        throw error;
+      }
+
+      return context;
+    };
+  },
+
+  /**
+   * CORS middleware
+   * @param {Object} options
+   * @returns {Function}
+   */
+  cors(options = {}) {
+    const origin = options.origin || '*';
+    const methods = options.methods || ['POST'];
+    const headers = options.headers || ['Content-Type'];
+
+    return async (context) => {
+      const { res } = context;
+
+      res.header('Access-Control-Allow-Origin', origin);
+      res.header('Access-Control-Allow-Methods', methods.join(', '));
+      res.header('Access-Control-Allow-Headers', headers.join(', '));
+
+      return context;
+    };
+  },
+
+  /**
+   * Request timing middleware
+   * @returns {Function}
+   */
+  timing() {
+    return async (context) => {
+      context.startTime = Date.now();
+      return context;
+    };
+  },
+
+  /**
+   * Method whitelist middleware
+   * @param {string[]} allowedMethods
+   * @returns {Function}
+   */
+  methodWhitelist(allowedMethods) {
+    return async (context) => {
+      const { method } = context;
+
+      if (!allowedMethods.includes(method)) {
+        const error = new Error(`Method '${method}' is not allowed`);
+        error.code = -32601;
+        throw error;
+      }
+
+      return context;
+    };
+  },
+};
+
+module.exports = { MiddlewareManager, builtInMiddlewares };