axe-api 1.4.7 → 1.5.0-rc-1

package/build/dev-kit.d.ts

@@ -0,0 +1 @@
+export {};

package/build/dev-kit.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv_1 = __importDefault(require("dotenv"));
+const path_1 = __importDefault(require("path"));
+const index_1 = require("./index");
+console.log("Axe API dev-kit (1.0.1)");
+dotenv_1.default.config();
+const server = new index_1.Server();
+server.start(path_1.default.join(__dirname, "dev-kit"));

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 } from "./src/Middlewares/RateLimit";
+import { rateLimit, createRateLimitMiddleware } 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, };
+export { App, AxeRequest, AxeResponse, Server, Model, ApiError, RedisAdaptor, DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG, IoCService, allow, deny, rateLimit, createRateLimitMiddleware, };

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.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.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;
 const Server_1 = __importDefault(require("./src/Server"));
 exports.Server = Server_1.default;
 const Model_1 = __importDefault(require("./src/Model"));
@@ -38,6 +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; } });
 __exportStar(require("./src/Enums"), exports);
 __exportStar(require("./src/Interfaces"), exports);
 __exportStar(require("./src/Types"), exports);

package/build/src/Handlers/RequestHandler.js

@@ -53,8 +53,12 @@ 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 });
-    response.setHeader("Content-Type", "application/json");
-    response.setHeader("x-powered-by", "Axe API");
+    if (!response.isResponded) {
+        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
         if (phase.isAsync === false) {

package/build/src/Interfaces.d.ts

@@ -85,6 +85,7 @@ export interface AxeConfig extends IConfig {
     rateLimit: IRateLimitConfig;
     errorHandler: ErrorHandleFunction;
     docs: boolean;
+    disableXPoweredByHeader: boolean;
     redis: RedisClientOptions | undefined;
     cache: ICacheConfiguration;
     elasticSearch: ClientOptions;

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

@@ -1,6 +1,7 @@
 import { IncomingMessage, ServerResponse } from "http";
 import { AxeConfig, IRateLimitOptions, IContext } 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`
  *

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.setupRateLimitAdaptors = void 0;
+exports.rateLimit = exports.createRateLimitMiddleware = exports.setupRateLimitAdaptors = void 0;
 const AdaptorFactory_1 = __importDefault(require("./AdaptorFactory"));
 const Services_1 = require("../../Services");
 const nanoid_1 = require("nanoid");
@@ -70,6 +70,25 @@ 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`
  *
@@ -90,26 +109,18 @@ exports.setupRateLimitAdaptors = setupRateLimitAdaptors;
 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);
-        // 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." });
-        }
+        const key = `${clientKey}:${id}`;
+        return new Promise((resolve) => {
+            (0, exports.createRateLimitMiddleware)(context.req.original, context.res.original, resolve, key, selectedOptions);
+        });
     });
 };
 exports.rateLimit = rateLimit;

package/build/src/Server.js

@@ -142,6 +142,11 @@ class Server {
             var _a;
             const app = yield Services_1.IoCService.use("App");
             const api = Services_1.APIService.getInstance();
+            // Rate limitting should be added before init() functions
+            if ((_a = api.config.rateLimit) === null || _a === void 0 ? void 0 : _a.enabled) {
+                Services_1.LogService.debug("New middleware: rateLimit()");
+                app.use(RateLimit_1.default);
+            }
             // Adding the default handler for auto-created routes
             app.use(RequestHandler_1.default);
             // Setting the error handler
@@ -155,11 +160,6 @@ class Server {
                 app.get("/docs", DocsHandler_1.default);
                 app.get("/routes", RoutesHandler_1.default);
             }
-            // Rate limitting should be added after init() functions.
-            if ((_a = api.config.rateLimit) === null || _a === void 0 ? void 0 : _a.enabled) {
-                Services_1.LogService.debug("New middleware: rateLimit()");
-                app.use(RateLimit_1.default);
-            }
             server.listen(api.config.port);
             Services_1.LogService.axe(`Axe API listens requests on http://localhost:${api.config.port}`);
         });

package/build/src/Services/AxeResponse.d.ts

@@ -3,7 +3,6 @@ import { StatusCodes } from "src/Enums";
 import { ILanguage } from "src/Interfaces";
 declare class AxeResponse {
     private response;
-    private responseStatus;
     private language;
     constructor(response: ServerResponse, language: ILanguage);
     /**

package/build/src/Services/AxeResponse.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class AxeResponse {
     constructor(response, language) {
-        this.responseStatus = false;
         this.response = response;
         this.response.statusCode = 200;
         this.language = language;
@@ -36,7 +35,7 @@ class AxeResponse {
         this.response.setHeader("Content-Language", this.language.language);
         this.response.write(JSON.stringify(data));
         this.response.end();
-        this.responseStatus = true;
+        this.response.isResponded = true;
     }
     /**
      * Set the HTTP Response Data as string
@@ -46,7 +45,7 @@ class AxeResponse {
     send(content) {
         this.response.write(content);
         this.response.end();
-        this.responseStatus = true;
+        this.response.isResponded = true;
     }
     /**
      * Set the no-content to the HTTP Response with 204 status code.
@@ -54,10 +53,10 @@ class AxeResponse {
     noContent() {
         this.response.statusCode = 204;
         this.response.end();
-        this.responseStatus = true;
+        this.response.isResponded = true;
     }
     isResponded() {
-        return this.responseStatus;
+        return !!this.response.isResponded;
     }
     statusCode() {
         return this.response.statusCode;

package/build/src/constants.js

@@ -284,6 +284,7 @@ exports.DEFAULT_APP_CONFIG = {
     env: "production",
     port: 3000,
     docs: true,
+    disableXPoweredByHeader: false,
     pino: {
         level: "error",
         transport: {

package/package.json

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