axe-api 1.4.8 → 1.5.0-rc-2

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, 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, };
+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.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,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, "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

@@ -54,7 +54,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 });
     response.setHeader("Content-Type", "application/json");
-    response.setHeader("x-powered-by", "Axe API");
+    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

@@ -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;
@@ -85,6 +90,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,5 +1,5 @@
 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>;
 /**
  * Add a rate limit with the `IRateLimitOptions`
@@ -19,5 +19,17 @@ export declare const setupRateLimitAdaptors: (config: AxeConfig) => Promise<void
  *  }
  */
 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.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");
@@ -113,6 +113,37 @@ const rateLimit = (options) => {
     });
 };
 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.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,16 +53,16 @@ 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;
     }
     header(key, value) {
-        this.original.setHeader(key, value);
+        this.response.setHeader(key, value);
     }
 }
 exports.default = AxeResponse;

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.8",
+  "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",