axe-api 1.5.0-rc-1 → 1.5.0-rc-2

package/build/index.d.ts

@@ -4,8 +4,8 @@ import ApiError from "./src/Exceptions/ApiError";
 import RedisAdaptor from "./src/Middlewares/RateLimit/RedisAdaptor";
 import { DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG } from "./src/constants";
 import { IoCService, allow, deny, App, AxeRequest, AxeResponse } from "./src/Services";
-import { rateLimit, createRateLimitMiddleware } from "./src/Middlewares/RateLimit";
+import { rateLimit, createRateLimitter } from "./src/Middlewares/RateLimit";
 export * from "./src/Enums";
 export * from "./src/Interfaces";
 export * from "./src/Types";
-export { App, AxeRequest, AxeResponse, Server, Model, ApiError, RedisAdaptor, DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG, IoCService, allow, deny, rateLimit, createRateLimitMiddleware, };
+export { App, AxeRequest, AxeResponse, Server, Model, ApiError, RedisAdaptor, DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG, IoCService, allow, deny, rateLimit, createRateLimitter, };

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRateLimitMiddleware = exports.rateLimit = exports.deny = exports.allow = exports.IoCService = exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_HANDLERS = exports.RedisAdaptor = exports.ApiError = exports.Model = exports.Server = exports.AxeResponse = exports.AxeRequest = exports.App = void 0;
+exports.createRateLimitter = exports.rateLimit = exports.deny = exports.allow = exports.IoCService = exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_HANDLERS = exports.RedisAdaptor = exports.ApiError = exports.Model = exports.Server = exports.AxeResponse = exports.AxeRequest = exports.App = void 0;
 const Server_1 = __importDefault(require("./src/Server"));
 exports.Server = Server_1.default;
 const Model_1 = __importDefault(require("./src/Model"));
@@ -38,7 +38,7 @@ Object.defineProperty(exports, "AxeRequest", { enumerable: true, get: function (
 Object.defineProperty(exports, "AxeResponse", { enumerable: true, get: function () { return Services_1.AxeResponse; } });
 const RateLimit_1 = require("./src/Middlewares/RateLimit");
 Object.defineProperty(exports, "rateLimit", { enumerable: true, get: function () { return RateLimit_1.rateLimit; } });
-Object.defineProperty(exports, "createRateLimitMiddleware", { enumerable: true, get: function () { return RateLimit_1.createRateLimitMiddleware; } });
+Object.defineProperty(exports, "createRateLimitter", { enumerable: true, get: function () { return RateLimit_1.createRateLimitter; } });
 __exportStar(require("./src/Enums"), exports);
 __exportStar(require("./src/Interfaces"), exports);
 __exportStar(require("./src/Types"), exports);

package/build/src/Handlers/RequestHandler.js

@@ -53,11 +53,9 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
     }
     const validator = yield Services_1.IoCService.use("Validator");
     const context = Object.assign(Object.assign({}, match.data), { params: match.params, api, req: axeRequest, res: axeResponse, isTransactionOpen: match.hasTransaction, database: match.hasTransaction && trx ? trx : database, validator });
-    if (!response.isResponded) {
-        response.setHeader("Content-Type", "application/json");
-        if (api.config.disableXPoweredByHeader === false) {
-            response.setHeader("x-powered-by", "Axe API");
-        }
+    response.setHeader("Content-Type", "application/json");
+    if (api.config.disableXPoweredByHeader === false) {
+        response.setHeader("x-powered-by", "Axe API");
     }
     for (const phase of match.phases) {
         // If there is an non-async phase, it should be an Event function

package/build/src/Interfaces.d.ts

@@ -44,6 +44,11 @@ export interface IQueryConfig {
     limits: Array<IQueryLimitConfig[]>;
     defaults?: IQueryDefaultConfig;
 }
+export interface IRateLimitMiddleware {
+    name: string;
+    clientKey: string;
+    setResponseHeaders?: boolean;
+}
 export interface IRateLimitOptions {
     maxRequests: number;
     windowInSeconds: number;

package/build/src/Middlewares/RateLimit/index.d.ts

@@ -1,7 +1,6 @@
 import { IncomingMessage, ServerResponse } from "http";
-import { AxeConfig, IRateLimitOptions, IContext } from "../../Interfaces";
+import { AxeConfig, IRateLimitOptions, IContext, IRateLimitMiddleware } from "../../Interfaces";
 export declare const setupRateLimitAdaptors: (config: AxeConfig) => Promise<void>;
-export declare const createRateLimitMiddleware: (req: IncomingMessage, res: ServerResponse, next: () => void, key: string, options: IRateLimitOptions) => Promise<void>;
 /**
  * Add a rate limit with the `IRateLimitOptions`
  *
@@ -20,5 +19,17 @@ export declare const createRateLimitMiddleware: (req: IncomingMessage, res: Serv
  *  }
  */
 export declare const rateLimit: (options?: IRateLimitOptions) => (context: IContext) => Promise<void>;
+/**
+ * Create a rate-limitter middleware (a connect middleware) with a middleware
+ * configurations
+ *
+ * @param middleware IRateLimitMiddleware
+ * @param options IRateLimitOptions
+ * @param req IncomingMessage
+ * @param res ServerResponse
+ * @param next NextFunction
+ * @returns
+ */
+export declare const createRateLimitter: (middleware: IRateLimitMiddleware, options: IRateLimitOptions, req: IncomingMessage, res: ServerResponse, next: any) => Promise<any>;
 declare const _default: (req: IncomingMessage, res: ServerResponse, next: any) => Promise<any>;
 export default _default;

package/build/src/Middlewares/RateLimit/index.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rateLimit = exports.createRateLimitMiddleware = exports.setupRateLimitAdaptors = void 0;
+exports.createRateLimitter = exports.rateLimit = exports.setupRateLimitAdaptors = void 0;
 const AdaptorFactory_1 = __importDefault(require("./AdaptorFactory"));
 const Services_1 = require("../../Services");
 const nanoid_1 = require("nanoid");
@@ -70,25 +70,6 @@ const setupRateLimitAdaptors = (config) => __awaiter(void 0, void 0, void 0, fun
     adaptor = yield (0, AdaptorFactory_1.default)(((_a = config.rateLimit) === null || _a === void 0 ? void 0 : _a.adaptor) || "memory");
 });
 exports.setupRateLimitAdaptors = setupRateLimitAdaptors;
-const createRateLimitMiddleware = (req, res, next, key, options) => __awaiter(void 0, void 0, void 0, function* () {
-    // Checking the rate limit
-    const isAllowed = yield checkRateLimit(key, options);
-    // Setting the headers
-    res.setHeader("X-RateLimit-Limit", isAllowed.limit);
-    res.setHeader("X-RateLimit-Remaining", isAllowed.remaining);
-    // Sending an error message if there is an error
-    if (isAllowed.success === false) {
-        Services_1.LogService.warn(`Rate limit exceeded: ${req.url}`);
-        res.statusCode = Enums_1.StatusCodes.TOO_MANY_REQUESTS;
-        res.write(JSON.stringify({
-            error: "Rate limit exceeded.",
-        }));
-        res.isResponded = true;
-        res.end();
-    }
-    next();
-});
-exports.createRateLimitMiddleware = createRateLimitMiddleware;
 /**
  * Add a rate limit with the `IRateLimitOptions`
  *
@@ -109,21 +90,60 @@ exports.createRateLimitMiddleware = createRateLimitMiddleware;
 const rateLimit = (options) => {
     // For each model middleware, we should use a different ID for the cache key
     const id = (0, nanoid_1.nanoid)();
-    // API configuration fetching
-    const api = Services_1.APIService.getInstance();
-    // Developers are able to set different rate limit options
-    // in model files. That's why we should create a new option object.
-    const selectedOptions = Object.assign(Object.assign({}, api.config.rateLimit), options);
     return (context) => __awaiter(void 0, void 0, void 0, function* () {
+        // API configuration fetching
+        const api = Services_1.APIService.getInstance();
         // Creating a clientkey by the client key configurations
         const clientKey = getClientKeyByConfigurations(context.req.original, api.config.rateLimit);
-        const key = `${clientKey}:${id}`;
-        return new Promise((resolve) => {
-            (0, exports.createRateLimitMiddleware)(context.req.original, context.res.original, resolve, key, selectedOptions);
-        });
+        // Developers are able to set different rate limit options
+        // in model files. That's why we should create a new option object.
+        const selectedOptions = Object.assign(Object.assign({}, api.config.rateLimit), options);
+        // Checking the rate limit
+        const isAllowed = yield checkRateLimit(`${clientKey}:${id}`, selectedOptions);
+        // Setting the headers
+        context.res.original.setHeader("X-RateLimit-Limit", isAllowed.limit);
+        context.res.original.setHeader("X-RateLimit-Remaining", isAllowed.remaining);
+        // Sending an error message if there is an error
+        if (isAllowed.success === false) {
+            Services_1.LogService.warn(`Rate limit exceeded: ${context.req.url}`);
+            context.res
+                .status(Enums_1.StatusCodes.TOO_MANY_REQUESTS)
+                .json({ error: "Rate limit exceeded." });
+        }
     });
 };
 exports.rateLimit = rateLimit;
+/**
+ * Create a rate-limitter middleware (a connect middleware) with a middleware
+ * configurations
+ *
+ * @param middleware IRateLimitMiddleware
+ * @param options IRateLimitOptions
+ * @param req IncomingMessage
+ * @param res ServerResponse
+ * @param next NextFunction
+ * @returns
+ */
+const createRateLimitter = (middleware, options, req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    // Checking the rate limits.
+    const isAllowed = yield checkRateLimit(middleware.clientKey, options);
+    // Setting the HTTP Response headers.
+    if (middleware.setResponseHeaders) {
+        res.setHeader(`X-${middleware.name}-Limit`, isAllowed.limit);
+        res.setHeader(`X-${middleware.name}-Remaining`, isAllowed.remaining);
+    }
+    // If it is allowed, the next function would be called.
+    if (isAllowed.success) {
+        return next();
+    }
+    // Sending an error message.
+    Services_1.LogService.warn(`Rate limit exceeded: ${req.url}`);
+    res.writeHead(429, { "Content-Type": "application/json" });
+    res.end(JSON.stringify({
+        error: "Rate limit exceeded.",
+    }));
+});
+exports.createRateLimitter = createRateLimitter;
 exports.default = (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
     const api = Services_1.APIService.getInstance();
     // Generating the client key

package/build/src/Services/AxeResponse.js

@@ -62,7 +62,7 @@ class AxeResponse {
         return this.response.statusCode;
     }
     header(key, value) {
-        this.original.setHeader(key, value);
+        this.response.setHeader(key, value);
     }
 }
 exports.default = AxeResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.5.0-rc-1",
+  "version": "1.5.0-rc-2",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",