axe-api 1.0.0-rc21 → 1.0.0-rc23

package/build/src/Builders/ModelTreeBuilder.js

@@ -59,7 +59,8 @@ class ModelTreeBuilder {
         this.version.modelList.get().forEach((model) => {
             const recursiveRelations = model.relations.filter((relation) => relation.model === model.name);
             if (recursiveRelations.length === 2) {
-                tree.push(Object.assign(Object.assign({}, model), { isRecursive: true, children: [] }));
+                model.setAsRecursive();
+                tree.push(model);
             }
         });
     }

package/build/src/Enums.d.ts

@@ -171,3 +171,7 @@ export declare enum StatusCodes {
     USE_PROXY = 305,
     MISDIRECTED_REQUEST = 421
 }
+export declare enum CacheStrategies {
+    TimeBased = "time-based",
+    TagBased = "tag-based"
+}

package/build/src/Enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatusCodes = exports.QueryFeature = exports.QueryFeatureType = exports.AxeErrorCode = exports.TimestampColumns = exports.SortTypes = exports.Relationships = exports.HttpMethods = exports.Extensions = exports.HookFunctionTypes = exports.HandlerTypes = exports.DependencyTypes = exports.ConditionTypes = void 0;
+exports.CacheStrategies = exports.StatusCodes = exports.QueryFeature = exports.QueryFeatureType = exports.AxeErrorCode = exports.TimestampColumns = exports.SortTypes = exports.Relationships = exports.HttpMethods = exports.Extensions = exports.HookFunctionTypes = exports.HandlerTypes = exports.DependencyTypes = exports.ConditionTypes = void 0;
 var ConditionTypes;
 (function (ConditionTypes) {
     ConditionTypes["NotNull"] = "NotNull";
@@ -187,3 +187,8 @@ var StatusCodes;
     StatusCodes[StatusCodes["USE_PROXY"] = 305] = "USE_PROXY";
     StatusCodes[StatusCodes["MISDIRECTED_REQUEST"] = 421] = "MISDIRECTED_REQUEST";
 })(StatusCodes || (exports.StatusCodes = StatusCodes = {}));
+var CacheStrategies;
+(function (CacheStrategies) {
+    CacheStrategies["TimeBased"] = "time-based";
+    CacheStrategies["TagBased"] = "tag-based";
+})(CacheStrategies || (exports.CacheStrategies = CacheStrategies = {}));

package/build/src/Handlers/Helpers.d.ts

@@ -1,9 +1,9 @@
-import { IModelService, IRelation, IQuery, IVersion, IWith, IContext } from "../Interfaces";
+import { IModelService, IRelation, IQuery, IVersion, IWith, IContext, ICacheConfiguration } from "../Interfaces";
 import { Knex } from "knex";
 import { HandlerTypes, HookFunctionTypes, TimestampColumns } from "../Enums";
 import { ModelListService } from "../Services";
 import { SerializationFunction } from "../Types";
-import AxeRequest from "src/Services/AxeRequest";
+import AxeRequest from "../Services/AxeRequest";
 export declare const bindTimestampValues: (formData: Record<string, any>, model: IModelService, columnTypes?: TimestampColumns[]) => void;
 export declare const getMergedFormData: (req: AxeRequest, fillables: string[]) => Record<string, any>;
 export declare const callHooks: (model: IModelService, type: HookFunctionTypes, params: IContext) => Promise<void>;
@@ -15,3 +15,9 @@ export declare const filterHiddenFields: (itemArray: any[], hiddens: string[] |
 export declare const addSoftDeleteQuery: (model: IModelService, conditions: IQuery | null, query: Knex.QueryBuilder) => void;
 export declare const getRelatedData: (version: IVersion, data: any[], withArray: IWith[], model: IModelService, modelList: ModelListService, database: Knex | Knex.Transaction, handler: HandlerTypes, request: AxeRequest) => Promise<void>;
 export declare const isBoolean: (value: any) => boolean;
+export declare const getModelCacheConfiguration: (model: IModelService, apiConfig: ICacheConfiguration, versionConfig: ICacheConfiguration | null, handler: string) => ICacheConfiguration;
+export declare const defaultCacheKeyFunction: (req: AxeRequest) => string;
+export declare const toCacheKey: (context: IContext) => string;
+export declare const putCache: (context: IContext, data: any) => Promise<void>;
+export declare const clearCacheTags: (tag: string) => Promise<void>;
+export declare const toCachePrefix: (value: string | undefined | null) => string;

package/build/src/Handlers/Helpers.js

@@ -12,7 +12,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBoolean = exports.getRelatedData = exports.addSoftDeleteQuery = exports.filterHiddenFields = exports.serializeData = exports.addForeignKeyQuery = exports.checkPrimaryKeyValueType = exports.getParentColumn = exports.callHooks = exports.getMergedFormData = exports.bindTimestampValues = void 0;
+exports.toCachePrefix = exports.clearCacheTags = exports.putCache = exports.toCacheKey = exports.defaultCacheKeyFunction = exports.getModelCacheConfiguration = exports.isBoolean = exports.getRelatedData = exports.addSoftDeleteQuery = exports.filterHiddenFields = exports.serializeData = exports.addForeignKeyQuery = exports.checkPrimaryKeyValueType = exports.getParentColumn = exports.callHooks = exports.getMergedFormData = exports.bindTimestampValues = void 0;
+const crypto_1 = __importDefault(require("crypto"));
 const change_case_1 = require("change-case");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
@@ -221,6 +222,13 @@ const getRelatedData = (version, data, withArray, model, modelList, database, ha
         }
         // Fetching related records by foreignKey and primary key values.
         let relatedRecords = yield foreignModelQuery.whereIn(searchFieldKey, parentPrimaryKeyValues);
+        // Adding related data source to the request tags to set cache tag values
+        const { primaryKey } = foreignModel.instance;
+        const cacheConfig = foreignModel.getCacheConfiguration(handler);
+        const tagPrefix = (cacheConfig === null || cacheConfig === void 0 ? void 0 : cacheConfig.tagPrefix)
+            ? `${cacheConfig === null || cacheConfig === void 0 ? void 0 : cacheConfig.tagPrefix}:`
+            : "";
+        request.original.tags.push(...relatedRecords.map((i) => `${tagPrefix}${foreignModel.name}:${i[primaryKey]}`));
         // We should serialize related data if there is any serialization function
         relatedRecords = yield (0, exports.serializeData)(version, relatedRecords, foreignModel.serialize, handler, request);
         // We should hide hidden fields if there is any
@@ -251,3 +259,85 @@ const isBoolean = (value) => {
     return false;
 };
 exports.isBoolean = isBoolean;
+const getModelCacheConfiguration = (model, apiConfig, versionConfig, handler) => {
+    let base = Object.assign(Object.assign({}, constants_1.DEFAULT_CACHE_CONFIGURATION), apiConfig);
+    if (model.instance.cache) {
+        const data = model.instance.cache;
+        if (Array.isArray(data)) {
+            const handlerBasedConfigs = data;
+            for (const item of handlerBasedConfigs) {
+                const isFound = item.handlers.map((i) => i).includes(handler);
+                if (isFound) {
+                    base = Object.assign(Object.assign({}, base), item.cache);
+                    return base;
+                }
+            }
+        }
+        else {
+            base = Object.assign(Object.assign({}, base), data);
+            return base;
+        }
+    }
+    if (versionConfig) {
+        base = Object.assign(Object.assign({}, base), versionConfig);
+    }
+    return base;
+};
+exports.getModelCacheConfiguration = getModelCacheConfiguration;
+const defaultCacheKeyFunction = (req) => {
+    return JSON.stringify({
+        url: req.url,
+        method: req.method,
+        headers: req.original.headers,
+    });
+};
+exports.defaultCacheKeyFunction = defaultCacheKeyFunction;
+const toCacheKey = (context) => {
+    const { model, handlerType } = context;
+    const config = model.getCacheConfiguration(handlerType);
+    const keyData = (config === null || config === void 0 ? void 0 : config.cacheKey)
+        ? config.cacheKey(context.req)
+        : (0, exports.defaultCacheKeyFunction)(context.req);
+    const key = crypto_1.default.createHash("sha256").update(keyData).digest("hex");
+    return (0, exports.toCachePrefix)(config === null || config === void 0 ? void 0 : config.cachePrefix) + key;
+};
+exports.toCacheKey = toCacheKey;
+const putCache = (context, data) => __awaiter(void 0, void 0, void 0, function* () {
+    // Getting the correct configuration
+    const { model, handlerType } = context;
+    const config = model.getCacheConfiguration(handlerType);
+    // Check if the cache enable for this handler
+    if (config === null || config === void 0 ? void 0 : config.enable) {
+        // Getting the redis service
+        const redis = yield Services_1.IoCService.use("Redis");
+        // Generating the cache key
+        const key = (0, exports.toCacheKey)(context);
+        console.log("HERE", key);
+        // Setting the tags if the cache configuration of the model has been set as
+        // tag-based cache invalidation strategy. Which means, the key cached value
+        // can be deleted if the tagged items updated/delete
+        if (config.invalidation === Enums_1.CacheStrategies.TagBased) {
+            redis.tags(context.req.original.tags, key);
+        }
+        // Putting the cache data
+        redis.set(key, JSON.stringify(data), config.ttl || 1000);
+        if (config.responseHeader) {
+            context.res.header(config.responseHeader, "Missed");
+        }
+        // Logging
+        Services_1.LogService.debug(`\t🔄 redis.cache(${key},${config.ttl})`);
+    }
+});
+exports.putCache = putCache;
+const clearCacheTags = (tag) => __awaiter(void 0, void 0, void 0, function* () {
+    const redis = yield Services_1.IoCService.use("Redis");
+    const members = yield redis.getTagMemebers(tag);
+    if (members.length > 0) {
+        yield redis.delete(members);
+    }
+});
+exports.clearCacheTags = clearCacheTags;
+const toCachePrefix = (value) => {
+    return value ? `${value}:` : "";
+};
+exports.toCachePrefix = toCachePrefix;

package/build/src/Handlers/RequestHandler.js

@@ -15,13 +15,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Services_1 = require("../Services");
 const URLService_1 = __importDefault(require("../Services/URLService"));
 const ConverterService_1 = require("../Services/ConverterService");
-const api = Services_1.APIService.getInstance();
 const return404 = (response) => {
     response.statusCode = 404;
     response.write(JSON.stringify({ error: "Resource not found" }));
     response.end();
 };
 exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0, function* () {
+    const api = Services_1.APIService.getInstance();
     Services_1.LogService.debug(`📥 ${request.method} ${request.url}`);
     const { axeRequest, axeResponse } = (0, ConverterService_1.toAxeRequestResponsePair)(request, response);
     const match = URLService_1.default.match(axeRequest);
@@ -35,7 +35,7 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
     // Prepare the database by the transaction option
     let trx = null;
     if (match.hasTransaction) {
-        Services_1.LogService.warn("\tDB transaction created");
+        Services_1.LogService.warn("\t🛢 DBTransaction:created()");
         trx = yield database.transaction();
     }
     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 });
@@ -57,7 +57,7 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
             Services_1.LogService.error(error);
             // Rollback transaction
             if (match.hasTransaction && trx) {
-                Services_1.LogService.warn("\tDB transaction rollback");
+                Services_1.LogService.warn("\t🛢 DBTransaction:rollback()");
                 trx.rollback();
             }
             if (error.type === "ApiError") {
@@ -77,12 +77,17 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
         // we should rollback it before the HTTP request end.
         if (context.res.statusCode() >= 400 && context.res.statusCode() < 599) {
             if (match.hasTransaction && trx) {
-                Services_1.LogService.warn("\tDB transaction rollback");
+                Services_1.LogService.warn("\t🛢 DBTransaction:rollback()");
                 trx.rollback();
             }
             Services_1.LogService.debug(`\tResponse ${context.res.statusCode()}`);
             break;
         }
+        // We should commit the transaction if there is any
+        if (match.hasTransaction && trx) {
+            Services_1.LogService.warn("\t🛢 DBTransaction:commit()");
+            trx.commit();
+        }
         Services_1.LogService.debug(`\t🟢 Response ${context.res.statusCode()}`);
         // We should brake the for-loop
         break;

package/build/src/Interfaces.d.ts

@@ -3,7 +3,7 @@
 import { Knex } from "knex";
 import { Options as FormOptions } from "formidable";
 import { Column } from "knex-schema-inspector/lib/types/column";
-import { HandlerTypes, HttpMethods, HookFunctionTypes, Extensions, Relationships, SortTypes, ConditionTypes, DependencyTypes, QueryFeature, QueryFeatureType } from "./Enums";
+import { HandlerTypes, HttpMethods, HookFunctionTypes, Extensions, Relationships, SortTypes, ConditionTypes, DependencyTypes, QueryFeature, QueryFeatureType, CacheStrategies } from "./Enums";
 import Model from "./Model";
 import { AdaptorType, AxeFunction, GeneralFunction, HandlerFunction, ModelHooks, PhaseFunction, SerializationFunction } from "./Types";
 import { ModelListService, QueryService } from "./Services";
@@ -13,6 +13,7 @@ import App from "./Services/App";
 import { LoggerOptions } from "pino";
 import { IncomingMessage } from "http";
 import { ErrorHandleFunction } from "connect";
+import { RedisClientOptions } from "redis";
 export interface IColumn extends Column {
     table_name: string;
 }
@@ -22,6 +23,10 @@ export interface IHandlerBasedTransactionConfig {
     handlers: HandlerTypes[];
     transaction: boolean;
 }
+export interface IHandlerBasedCacheConfig {
+    handlers: HandlerTypes[];
+    cache: ICacheConfiguration;
+}
 interface IHandlerBasedSerializer {
     handler: HandlerTypes[];
     serializer: ((data: any, request: AxeRequest) => void)[];
@@ -40,23 +45,13 @@ export interface IQueryConfig {
     limits: Array<IQueryLimitConfig[]>;
     defaults?: IQueryDefaultConfig;
 }
-export interface IRedisOptions {
-    host?: string;
-    port?: number;
-    password?: string;
-    db?: number;
-}
-export interface IRateLimitAdaptorConfig {
-    type: AdaptorType;
-    redis?: IRedisOptions;
-}
 export interface IRateLimitOptions {
     maxRequests: number;
     windowInSeconds: number;
 }
 export interface IRateLimitConfig extends IRateLimitOptions {
     enabled: boolean;
-    adaptor: IRateLimitAdaptorConfig;
+    adaptor: AdaptorType;
     trustProxyIP: boolean;
     keyGenerator?: (req: IncomingMessage) => string;
 }
@@ -67,8 +62,18 @@ export interface AxeVersionConfig {
     defaultLanguage: string;
     query: IQueryConfig;
     formidable: FormOptions;
+    cache: ICacheConfiguration | null;
 }
 export type IVersionConfig = Partial<AxeVersionConfig>;
+export interface ICacheConfiguration {
+    enable?: boolean;
+    ttl?: number;
+    invalidation?: CacheStrategies;
+    cachePrefix?: string;
+    tagPrefix?: string;
+    responseHeader?: string | null;
+    cacheKey?: (req: AxeRequest) => string;
+}
 export interface AxeConfig extends IConfig {
     env: string;
     port: number;
@@ -78,6 +83,8 @@ export interface AxeConfig extends IConfig {
     rateLimit: IRateLimitConfig;
     errorHandler: ErrorHandleFunction;
     docs: boolean;
+    redis: RedisClientOptions | undefined;
+    cache: ICacheConfiguration;
 }
 export type IApplicationConfig = Partial<AxeConfig>;
 export interface ILanguage {
@@ -140,6 +147,9 @@ export interface IModelService {
     setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: PhaseFunction): void;
     setQueryLimits(limits: IQueryLimitConfig[]): void;
     setSerialization(callback: SerializationFunction): void;
+    setCacheConfiguration(handler: string, cache: ICacheConfiguration): void;
+    getCacheConfiguration(handler: HandlerTypes): ICacheConfiguration | null;
+    setAsRecursive(): void;
 }
 export interface IRelation {
     type: Relationships;

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

@@ -1,6 +1,6 @@
 import { AdaptorType } from "../../Types";
 import RedisAdaptor from "./RedisAdaptor";
 import MemoryAdaptor from "./MemoryAdaptor";
-import { IRedisOptions } from "src/Interfaces";
-declare const _default: (adaptor: AdaptorType, redisOptions: IRedisOptions | undefined, prefix: string) => RedisAdaptor | MemoryAdaptor;
+import { RedisClientOptions } from "redis";
+declare const _default: (adaptor: AdaptorType, redisOptions: RedisClientOptions | undefined, prefix: string) => RedisAdaptor | MemoryAdaptor;
 export default _default;

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

@@ -1,10 +1,15 @@
-import { ICacheAdaptor, IRedisOptions } from "../../Interfaces";
+import { createClient } from "redis";
+import { ICacheAdaptor } from "../../Interfaces";
+type RedisClientOptions = Parameters<typeof createClient>[0];
 declare class RedisAdaptor implements ICacheAdaptor {
     private client;
     private prefix;
-    constructor(options: IRedisOptions | undefined, prefix: string);
+    constructor(options: RedisClientOptions | undefined, prefix: string);
     get(key: string): Promise<string | null>;
     set(key: string, value: string, ttl: number): Promise<void>;
+    tags(keys: string[], value: string): Promise<void>;
+    getTagMemebers(tag: string): Promise<string[]>;
+    delete(keys: string[]): Promise<number>;
     decr(key: string): Promise<void>;
 }
 export default RedisAdaptor;

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

@@ -26,6 +26,23 @@ class RedisAdaptor {
             yield this.client.setEx(`${this.prefix}${key}`, ttl, value);
         });
     }
+    tags(keys, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            keys.forEach((key) => {
+                this.client.sAdd(key, [value]);
+            });
+        });
+    }
+    getTagMemebers(tag) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.sMembers(tag);
+        });
+    }
+    delete(keys) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.del(keys);
+        });
+    }
     decr(key) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.client.decr(`${this.prefix}${key}`);

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

@@ -65,9 +65,9 @@ const getClientKeyByConfigurations = (req, config) => {
     return `axe-api-rate-limit:${req.socket.remoteAddress || ""}`;
 };
 const setupRateLimitAdaptors = (config) => {
-    var _a, _b;
+    var _a;
     // Creating the correct adaptor by the configuration
-    adaptor = (0, AdaptorFactory_1.default)(((_a = config.rateLimit) === null || _a === void 0 ? void 0 : _a.adaptor.type) || "memory", (_b = config.rateLimit) === null || _b === void 0 ? void 0 : _b.adaptor.redis, "");
+    adaptor = (0, AdaptorFactory_1.default)(((_a = config.rateLimit) === null || _a === void 0 ? void 0 : _a.adaptor) || "memory", config.redis, "");
 };
 exports.setupRateLimitAdaptors = setupRateLimitAdaptors;
 /**

package/build/src/Model.d.ts

@@ -1,4 +1,4 @@
-import { IRelation, IMethodBaseConfig, IQueryLimitConfig, IHandlerBasedTransactionConfig } from "./Interfaces";
+import { IRelation, IMethodBaseConfig, IQueryLimitConfig, IHandlerBasedTransactionConfig, ICacheConfiguration, IHandlerBasedCacheConfig } from "./Interfaces";
 import { HandlerTypes, HttpMethods } from "./Enums";
 import { ModelMiddleware, AxeFunction, ModelValidation } from "./Types";
 declare class Model {
@@ -187,6 +187,7 @@ declare class Model {
      * @tutorial https://axe-api.com/reference/model-limits.html
      */
     get limits(): Array<IQueryLimitConfig[]>;
+    get cache(): ICacheConfiguration | IHandlerBasedCacheConfig[] | null;
     /**
      * Model relationship definition. Axe API creates `hasMany` routes automatically.
      *

package/build/src/Model.js

@@ -219,6 +219,9 @@ class Model {
     get limits() {
         return [];
     }
+    get cache() {
+        return null;
+    }
     /**
      * Model relationship definition. Axe API creates `hasMany` routes automatically.
      *

package/build/src/Phases/CacheTagCleanPhase.d.ts

@@ -0,0 +1,3 @@
+import { IContext } from "../Interfaces";
+declare const _default: (context: IContext) => Promise<void>;
+export default _default;

package/build/src/Phases/CacheTagCleanPhase.js

@@ -0,0 +1,19 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Helpers_1 = require("../Handlers/Helpers");
+exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
+    const { item, model, handlerType } = context;
+    const { primaryKey } = model.instance;
+    const config = model.getCacheConfiguration(handlerType);
+    const prefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
+    (0, Helpers_1.clearCacheTags)(`${prefix}${model.name}:${item[primaryKey]}`);
+});

package/build/src/Phases/Delete/ResponsePhase.js

@@ -9,13 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Services_1 = require("../../Services");
 exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
-    const { database, isTransactionOpen, res } = context;
-    // If there is a valid transaction, we should commit it
-    if (isTransactionOpen) {
-        Services_1.LogService.warn("\tDB transaction commit");
-        database.commit();
-    }
+    const { res } = context;
     res.noContent();
 });

package/build/src/Phases/GetCachePhase.d.ts

@@ -0,0 +1,3 @@
+import { IContext } from "../Interfaces";
+declare const _default: (context: IContext) => Promise<void>;
+export default _default;

package/build/src/Phases/GetCachePhase.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Services_1 = require("../Services");
+const Helpers_1 = require("../Handlers/Helpers");
+exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
+    // Getting the correct configuration
+    const { model, handlerType } = context;
+    const config = model.getCacheConfiguration(handlerType);
+    // Check if the cache enable for this handler
+    if (config === null || config === void 0 ? void 0 : config.enable) {
+        // Getting the redis service
+        const redis = yield Services_1.IoCService.use("Redis");
+        // Generating the cache key
+        const key = (0, Helpers_1.toCacheKey)(context);
+        // Try to fetch the value via Redis
+        const value = yield redis.get(key);
+        // Check if there is a value
+        if (value) {
+            // Parse and respond the value
+            const result = JSON.parse(value);
+            const { res } = context;
+            if (config.responseHeader) {
+                res.header(config.responseHeader, "Hit");
+            }
+            res.json(result);
+            // Logging
+            Services_1.LogService.debug(`\t🔄 redis.get(${key})`);
+        }
+    }
+});

package/build/src/Phases/List/ResultPhase.js

@@ -9,13 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Services_1 = require("../../Services");
+const Helpers_1 = require("../../Handlers/Helpers");
 exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
-    const { database, isTransactionOpen, result, res } = context;
-    // If there is a valid transaction, we should commit it
-    if (isTransactionOpen) {
-        Services_1.LogService.warn("\tDB transaction commit");
-        database.commit();
-    }
+    const { result, res, model, handlerType } = context;
+    // Adding cache tags
+    const { primaryKey } = model.instance;
+    const config = model.getCacheConfiguration(handlerType);
+    const tagPrefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
+    context.req.original.tags.push(...result.data.map((i) => `${tagPrefix}${model.name}:${i[primaryKey]}`));
+    // Caching the results
+    yield (0, Helpers_1.putCache)(context, result);
     res.json(result);
 });

package/build/src/Phases/Single/ResultPhase.js

@@ -9,13 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Services_1 = require("../../Services");
+const Helpers_1 = require("../../Handlers/Helpers");
 exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
-    const { database, isTransactionOpen, item, res } = context;
-    // If there is a valid transaction, we should commit it
-    if (isTransactionOpen) {
-        Services_1.LogService.warn("\tDB transaction commit");
-        database.commit();
-    }
+    const { item, res, model, handlerType } = context;
+    // Adding cache tags
+    const { primaryKey } = model.instance;
+    const config = model.getCacheConfiguration(handlerType);
+    const tagPrefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
+    context.req.original.tags.push(`${tagPrefix}${model.name}:${item[primaryKey]}`);
+    // Caching the results
+    yield (0, Helpers_1.putCache)(context, item);
     res.json(item);
 });

package/build/src/Resolvers/ModelResolver.d.ts

@@ -3,6 +3,7 @@ declare class ModelResolver {
     private version;
     constructor(version: IVersion);
     resolve(): Promise<void>;
+    private setCacheOptions;
     private setModelRelations;
     private getModelList;
     private setDatabaseColumns;

package/build/src/Resolvers/ModelResolver.js

@@ -20,6 +20,7 @@ const Enums_1 = require("../Enums");
 const Services_1 = require("../Services");
 const constants_1 = require("../constants");
 const AxeError_1 = __importDefault(require("../Exceptions/AxeError"));
+const Helpers_1 = require("../Handlers/Helpers");
 class ModelResolver {
     constructor(version) {
         this.version = version;
@@ -41,9 +42,27 @@ class ModelResolver {
             yield this.setModelQueryLimits(modelList);
             Services_1.LogService.debug(`[${this.version.name}] Model query limits have been loaded`);
             this.version.modelList = modelList;
+            yield this.setCacheOptions(modelList);
             Services_1.LogService.debug(`[${this.version.name}] All models have been resolved.`);
         });
     }
+    setCacheOptions(modelList) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const api = Services_1.APIService.getInstance();
+            // For each model should be analyzed
+            for (const model of modelList.get()) {
+                // For each cachable handler, developers are able to set a different
+                // configuration. That's why we should check for each of them.
+                for (const handler of constants_1.ALL_HANDLERS) {
+                    // API configuration, version configuration and the handler type are in
+                    // order. The following function gets the correct configuration
+                    const configuration = (0, Helpers_1.getModelCacheConfiguration)(model, api.config.cache, this.version.config.cache, handler);
+                    // We need to set this to use late in action
+                    model.setCacheConfiguration(handler, configuration);
+                }
+            }
+        });
+    }
     setModelRelations(modelList) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const model of modelList.get()) {

package/build/src/Server.js

@@ -50,6 +50,7 @@ const http_1 = __importDefault(require("http"));
 const RequestHandler_1 = __importDefault(require("./Handlers/RequestHandler"));
 const App_1 = __importDefault(require("./Services/App"));
 const constants_1 = require("./constants");
+const RedisAdaptor_1 = __importDefault(require("./Middlewares/RateLimit/RedisAdaptor"));
 class Server {
     /**
      * Start the application with the rootFolder.
@@ -83,11 +84,16 @@ class Server {
             Services_1.IoCService.singleton("App", () => new App_1.default());
             Services_1.IoCService.singleton("Database", () => __awaiter(this, void 0, void 0, function* () {
                 const database = (0, knex_1.default)(api.config.database);
-                Services_1.LogService.debug("Created a knex connection instance");
+                const { client } = api.config.database;
+                const { database: db, filename } = api.config.database.connection;
+                Services_1.LogService.debug(`Created a knex connection instance: [${client}:${db || filename}]`);
                 (0, knex_paginate_1.attachPaginate)();
                 Services_1.LogService.debug("Added pagination support to the knex");
                 return database;
             }));
+            Services_1.IoCService.singleton("Redis", () => {
+                return new RedisAdaptor_1.default(api.config.redis, "");
+            });
         });
     }
     analyzeVersions() {

package/build/src/Services/APIService.js

@@ -52,6 +52,7 @@ class APIService {
                     limits: [],
                 },
                 formidable: {},
+                cache: null,
             },
             folders: {
                 root,

package/build/src/Services/AxeRequest.js

@@ -20,6 +20,7 @@ class AxeRequest {
     constructor(request) {
         this.privateParams = {};
         this.request = request;
+        this.request.tags = [];
         this.urlObject = new URL(request.url || "", "http://127.0.0.1");
         // Application configuration is need for the default setting.
         this.version = (0, Helpers_1.getVersionByRequest)(this.urlObject);

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

@@ -1,5 +1,5 @@
-import { HookFunctionTypes, Extensions } from "../Enums";
-import { IColumn, IModelService, IQueryLimitConfig, IRelation } from "../Interfaces";
+import { HookFunctionTypes, Extensions, HandlerTypes } from "../Enums";
+import { ICacheConfiguration, IColumn, IModelService, IQueryLimitConfig, IRelation } from "../Interfaces";
 import Model from "./../Model";
 import { ModelHooks, PhaseFunction, SerializationFunction } from "../Types";
 declare class ModelService implements IModelService {
@@ -14,11 +14,15 @@ declare class ModelService implements IModelService {
     isRecursive: boolean;
     queryLimits: IQueryLimitConfig[];
     serialize: SerializationFunction | null;
+    cacheConfiguration: Record<string, ICacheConfiguration>;
     constructor(name: string, instance: Model);
     setColumns(columns: IColumn[]): void;
+    setCacheConfiguration(handler: string, cache: ICacheConfiguration): void;
+    getCacheConfiguration(handler: HandlerTypes): ICacheConfiguration;
     setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: PhaseFunction): void;
     setQueryLimits(limits: IQueryLimitConfig[]): void;
     setSerialization(callback: SerializationFunction): void;
+    setAsRecursive(): void;
     private setHooks;
     private setEvents;
 }

package/build/src/Services/ModelService.js

@@ -14,11 +14,18 @@ class ModelService {
         this.isRecursive = false;
         this.queryLimits = [];
         this.serialize = null;
+        this.cacheConfiguration = {};
     }
     setColumns(columns) {
         this.columns = columns;
         this.columnNames = this.columns.map((i) => i.name);
     }
+    setCacheConfiguration(handler, cache) {
+        this.cacheConfiguration[handler] = cache;
+    }
+    getCacheConfiguration(handler) {
+        return this.cacheConfiguration[handler];
+    }
     setExtensions(type, hookFunctionType, data) {
         if (type == Enums_1.Extensions.Hooks) {
             this.setHooks(hookFunctionType, data);
@@ -36,6 +43,10 @@ class ModelService {
     setSerialization(callback) {
         this.serialize = callback;
     }
+    setAsRecursive() {
+        this.isRecursive = true;
+        this.children = [];
+    }
     setHooks(hookFunctionType, data) {
         this.hooks[hookFunctionType] = data;
     }

package/build/src/constants.d.ts

@@ -1,5 +1,5 @@
 import { ConditionTypes, HandlerTypes, HttpMethods, QueryFeature, Relationships } from "./Enums";
-import { AxeConfig, AxeVersionConfig, IStepDefinition } from "./Interfaces";
+import { AxeConfig, AxeVersionConfig, ICacheConfiguration, IStepDefinition } from "./Interfaces";
 export declare const RESERVED_KEYWORDS: string[];
 export declare const DEFAULT_HANDLERS: HandlerTypes[];
 export declare const DEFAULT_METHODS_OF_MODELS: string[];
@@ -19,5 +19,7 @@ export declare const NUMERIC_PRIMARY_KEY_TYPES: string[];
 export declare const STRING_COLUMN_TYPES: string[];
 export declare const HANDLER_METHOD_MAP: Record<HandlerTypes, HttpMethods>;
 export declare const HANDLER_CYLES: Record<HandlerTypes, IStepDefinition[]>;
+export declare const DEFAULT_CACHE_CONFIGURATION: ICacheConfiguration;
 export declare const DEFAULT_APP_CONFIG: AxeConfig;
 export declare const DEFAULT_VERSION_CONFIG: AxeVersionConfig;
+export declare const ALL_HANDLERS: HandlerTypes[];

package/build/src/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_APP_CONFIG = exports.HANDLER_CYLES = exports.HANDLER_METHOD_MAP = exports.STRING_COLUMN_TYPES = exports.NUMERIC_PRIMARY_KEY_TYPES = exports.RelationQueryFeatureMap = exports.ConditionQueryFeatureMap = exports.API_ROUTE_TEMPLATES = exports.DEFAULT_METHODS_OF_MODELS = exports.DEFAULT_HANDLERS = exports.RESERVED_KEYWORDS = void 0;
+exports.ALL_HANDLERS = exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_APP_CONFIG = exports.DEFAULT_CACHE_CONFIGURATION = exports.HANDLER_CYLES = exports.HANDLER_METHOD_MAP = exports.STRING_COLUMN_TYPES = exports.NUMERIC_PRIMARY_KEY_TYPES = exports.RelationQueryFeatureMap = exports.ConditionQueryFeatureMap = exports.API_ROUTE_TEMPLATES = exports.DEFAULT_METHODS_OF_MODELS = exports.DEFAULT_HANDLERS = exports.RESERVED_KEYWORDS = void 0;
 const Enums_1 = require("./Enums");
 const LimitService_1 = require("./Services/LimitService");
 const Single_1 = __importDefault(require("./Phases/Single"));
@@ -20,6 +20,9 @@ const Phase_1 = __importDefault(require("./Steps/Phase"));
 const Hook_1 = __importDefault(require("./Steps/Hook"));
 const Event_1 = __importDefault(require("./Steps/Event"));
 const ErrorHandler_1 = __importDefault(require("./Handlers/ErrorHandler"));
+const GetCachePhase_1 = __importDefault(require("./Phases/GetCachePhase"));
+const CacheTagCleanPhase_1 = __importDefault(require("./Phases/CacheTagCleanPhase"));
+const Helpers_1 = require("./Handlers/Helpers");
 exports.RESERVED_KEYWORDS = [
     "force",
     "model",
@@ -71,6 +74,7 @@ exports.DEFAULT_METHODS_OF_MODELS = [
     "limits",
     "getFillableFields",
     "getValidationRules",
+    "cache",
 ];
 exports.API_ROUTE_TEMPLATES = {
     [Enums_1.HandlerTypes.INSERT]: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
@@ -135,6 +139,7 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("insert.response", Single_1.default.ResultPhase),
     ],
     [Enums_1.HandlerTypes.PAGINATE]: [
+        new Phase_1.default("paginate.cache", GetCachePhase_1.default),
         new Phase_1.default("paginate.prepareQuery", Paginate_1.default.PreparePhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onBeforePaginate),
         new Event_1.default(Enums_1.HookFunctionTypes.onBeforePaginate),
@@ -146,6 +151,7 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("paginate.response", List_1.default.ResultPhase),
     ],
     [Enums_1.HandlerTypes.SHOW]: [
+        new Phase_1.default("paginate.cache", GetCachePhase_1.default),
         new Phase_1.default("show.prepareQuery", Show_1.default.PreparePhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onBeforeShow),
         new Event_1.default(Enums_1.HookFunctionTypes.onBeforeShow),
@@ -169,6 +175,7 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("update.action", Update_1.default.ActionPhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onAfterUpdate),
         new Event_1.default(Enums_1.HookFunctionTypes.onAfterUpdate),
+        new Phase_1.default("cache.cleanTags", CacheTagCleanPhase_1.default),
         new Phase_1.default("update.serialize", Single_1.default.SerializePhase),
         new Phase_1.default("update.response", Single_1.default.ResultPhase),
     ],
@@ -184,6 +191,7 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("delete.action", Delete_1.default.ActionPhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onAfterDelete),
         new Event_1.default(Enums_1.HookFunctionTypes.onAfterDelete),
+        new Phase_1.default("cache.cleanTags", CacheTagCleanPhase_1.default),
         new Phase_1.default("delete.response", Delete_1.default.ResponsePhase),
     ],
     [Enums_1.HandlerTypes.FORCE_DELETE]: [
@@ -198,6 +206,7 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("force-delete.action", ForceDelete_1.default.ActionPhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onAfterForceDelete),
         new Event_1.default(Enums_1.HookFunctionTypes.onAfterForceDelete),
+        new Phase_1.default("cache.cleanTags", CacheTagCleanPhase_1.default),
         new Phase_1.default("force-delete.response", Delete_1.default.ResponsePhase),
     ],
     [Enums_1.HandlerTypes.PATCH]: [
@@ -213,10 +222,12 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("patch.action", Update_1.default.ActionPhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onAfterUpdate),
         new Event_1.default(Enums_1.HookFunctionTypes.onAfterUpdate),
+        new Phase_1.default("cache.cleanTags", CacheTagCleanPhase_1.default),
         new Phase_1.default("patch.serialize", Single_1.default.SerializePhase),
         new Phase_1.default("patch.response", Single_1.default.ResultPhase),
     ],
     [Enums_1.HandlerTypes.ALL]: [
+        new Phase_1.default("paginate.cache", GetCachePhase_1.default),
         new Phase_1.default("all.prepareQuery", Paginate_1.default.PreparePhase),
         new Hook_1.default(Enums_1.HookFunctionTypes.onBeforePaginate),
         new Event_1.default(Enums_1.HookFunctionTypes.onBeforePaginate),
@@ -228,6 +239,15 @@ exports.HANDLER_CYLES = {
         new Phase_1.default("all.response", List_1.default.ResultPhase),
     ],
 };
+exports.DEFAULT_CACHE_CONFIGURATION = {
+    enable: false,
+    ttl: 100,
+    invalidation: Enums_1.CacheStrategies.TimeBased,
+    tagPrefix: "tag",
+    cachePrefix: "axe-cache",
+    responseHeader: "X-Axe-API-Cache",
+    cacheKey: Helpers_1.defaultCacheKeyFunction,
+};
 exports.DEFAULT_APP_CONFIG = {
     prefix: "api",
     env: "production",
@@ -241,9 +261,7 @@ exports.DEFAULT_APP_CONFIG = {
     },
     rateLimit: {
         enabled: false,
-        adaptor: {
-            type: "memory",
-        },
+        adaptor: "memory",
         maxRequests: 200,
         windowInSeconds: 5,
         trustProxyIP: false,
@@ -255,6 +273,8 @@ exports.DEFAULT_APP_CONFIG = {
         },
     },
     errorHandler: ErrorHandler_1.default,
+    redis: {},
+    cache: Object.assign({}, exports.DEFAULT_CACHE_CONFIGURATION),
 };
 exports.DEFAULT_VERSION_CONFIG = {
     transaction: false,
@@ -276,4 +296,15 @@ exports.DEFAULT_VERSION_CONFIG = {
         },
     },
     formidable: {},
+    cache: null,
 };
+exports.ALL_HANDLERS = [
+    Enums_1.HandlerTypes.ALL,
+    Enums_1.HandlerTypes.DELETE,
+    Enums_1.HandlerTypes.FORCE_DELETE,
+    Enums_1.HandlerTypes.INSERT,
+    Enums_1.HandlerTypes.PAGINATE,
+    Enums_1.HandlerTypes.PATCH,
+    Enums_1.HandlerTypes.SHOW,
+    Enums_1.HandlerTypes.UPDATE,
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.0.0-rc21",
+  "version": "1.0.0-rc23",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -64,8 +64,8 @@
     "knex-paginate": "^3.1.1",
     "knex-schema-inspector": "^3.0.1",
     "nanoid": "^3.3.6",
-    "pino": "^8.15.0",
-    "pino-pretty": "^10.2.0",
+    "pino": "^8.16.1",
+    "pino-pretty": "^10.2.3",
     "pluralize": "^8.0.0",
     "validatorjs": "^3.22.1"
   },
@@ -107,6 +107,7 @@
     "set-value": ">=4.1.0",
     "sqlite3": "^5.1.6",
     "ts-node": "^10.9.1",
+    "ts-node-dev": "^2.0.0",
     "typescript": "^5.2.2"
   },
   "lint-staged": {