axe-api 1.5.1 → 1.6.0

package/build/src/Builders/SwaggerBuilder.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {
@@ -42,6 +52,7 @@ const change_case_1 = require("change-case");
 const Enums_1 = require("../Enums");
 const node_cache_1 = __importDefault(require("node-cache"));
 const Services_1 = require("../Services");
+const LimitService_1 = require("../Services/LimitService");
 const cache = new node_cache_1.default();
 const DATA_TYPE_MAP = [
     {
@@ -74,10 +85,15 @@ const DATA_TYPE_MAP = [
             "smallint",
             "mediumint",
             "int",
+            "int unsigned",
+            "integer unsigned",
             "integer",
             "bigint",
+            "bigint unsigned",
             "float",
+            "float unsigned",
             "double",
+            "double unsigned",
             "decimal",
             "numeric",
         ],
@@ -324,7 +340,7 @@ const toRequestBody = (endpoint) => {
         required: true,
     };
 };
-const toRequestParameters = (endpoint) => {
+const toRequestParameters = (endpoint, modelService) => {
     const parameters = [
         {
             in: "header",
@@ -454,16 +470,6 @@ const toRequestParameters = (endpoint) => {
                     type: "string",
                 },
             },
-            {
-                name: "trashed",
-                in: "query",
-                description: "List of deleted data with soft-delete",
-                required: false,
-                schema: {
-                    type: "integer",
-                    default: 0,
-                },
-            },
             {
                 name: "q",
                 in: "query",
@@ -474,6 +480,19 @@ const toRequestParameters = (endpoint) => {
                 },
             },
         ]);
+        if (modelService.instance.deletedAtColumn &&
+            (0, LimitService_1.isQueryFeatureEnabled)(modelService, Enums_1.QueryFeature.Trashed)) {
+            parameters.push({
+                name: "trashed",
+                in: "query",
+                description: "List of deleted data with soft-delete",
+                required: false,
+                schema: {
+                    type: "integer",
+                    default: 0,
+                },
+            });
+        }
     }
     return parameters;
 };
@@ -560,18 +579,20 @@ const generateDocumentation = () => __awaiter(void 0, void 0, void 0, function*
             };
         }
     }
+    const modelPatterns = {};
     const paths = {};
     for (const endpoint of docs.get()) {
         if (paths[endpoint.url] === undefined) {
             paths[endpoint.url] = {};
         }
+        modelPatterns[endpoint.url] = endpoint.model;
         const path = {
             tags: [endpoint.model],
             summary: toEndpointSummary(endpoint),
             description: toEndpointDescription(endpoint),
             operationId: `${endpoint.handler}${endpoint.model}`,
             responses: toEndpointResponse(endpoint),
-            parameters: toRequestParameters(endpoint),
+            parameters: toRequestParameters(endpoint, endpoint.modelService),
         };
         const requestBody = toRequestBody(endpoint);
         if (requestBody) {
@@ -579,12 +600,19 @@ const generateDocumentation = () => __awaiter(void 0, void 0, void 0, function*
         }
         paths[endpoint.url][endpoint.method.toLowerCase()] = path;
     }
+    const modelPatternsKeys = Object.keys(modelPatterns);
     // Added custom endpoint
     for (const custom of docs.getCustoms()) {
         if (paths[custom.url] === undefined) {
             paths[custom.url] = {};
         }
+        const samePattern = modelPatternsKeys.find((key) => custom.url.startsWith(key));
+        const tags = [];
+        if (samePattern) {
+            tags.push(modelPatterns[samePattern]);
+        }
         paths[custom.url][custom.method.toLowerCase()] = {
+            tags,
             description: "Custom endpoint",
         };
     }

package/build/src/Interfaces.d.ts

@@ -296,6 +296,58 @@ export interface IAfterShowContext extends IContext {
     conditions: IQuery;
     item: any;
 }
+export interface IBeforeInsertEventContext extends Omit<IBeforeInsertContext, "res"> {
+}
+export interface IBeforeUpdateQueryEventContext extends Omit<IBeforeUpdateQueryContext, "res"> {
+}
+export interface IBeforePatchQueryEventContext extends Omit<IBeforePatchQueryContext, "res"> {
+}
+export interface IBeforeUpdateEventContext extends Omit<IBeforeUpdateContext, "res"> {
+}
+export interface IBeforePatchEventContext extends Omit<IBeforePatchContext, "res"> {
+}
+export interface IBeforeDeleteQueryEventContext extends Omit<IBeforeDeleteQueryContext, "res"> {
+}
+export interface IBeforeDeleteEventContext extends Omit<IBeforeDeleteContext, "res"> {
+}
+export interface IBeforeForceDeleteQueryEventContext extends Omit<IBeforeForceDeleteQueryContext, "res"> {
+}
+export interface IBeforeForceDeleteEventContext extends Omit<IBeforeForceDeleteContext, "res"> {
+}
+export interface IBeforePaginateEventContext extends Omit<IBeforePaginateContext, "res"> {
+}
+export interface IBeforeSearchEventContext extends Omit<IBeforeSearchContext, "res"> {
+}
+export interface IBeforeAllEventContext extends Omit<IBeforeAllContext, "res"> {
+}
+export interface IBeforeShowEventContext extends Omit<IBeforeShowContext, "res"> {
+}
+export interface IAfterInsertEventContext extends Omit<IAfterInsertContext, "res"> {
+}
+export interface IAfterUpdateQueryEventContext extends Omit<IAfterUpdateQueryContext, "res"> {
+}
+export interface IAfterUpdateEventContext extends Omit<IAfterUpdateContext, "res"> {
+}
+export interface IAfterPatchQueryEventContext extends Omit<IAfterPatchQueryContext, "res"> {
+}
+export interface IAfterPatchEventContext extends Omit<IAfterPatchContext, "res"> {
+}
+export interface IAfterDeleteQueryEventContext extends Omit<IAfterDeleteQueryContext, "res"> {
+}
+export interface IAfterDeleteEventContext extends Omit<IAfterDeleteContext, "res"> {
+}
+export interface IAfterForceDeleteQueryEventContext extends Omit<IAfterForceDeleteQueryContext, "res"> {
+}
+export interface IAfterForceDeleteEventContext extends Omit<IAfterForceDeleteContext, "res"> {
+}
+export interface IAfterPaginateEventContext extends Omit<IAfterPaginateContext, "res"> {
+}
+export interface IAfterAllEventContext extends Omit<IAfterAllContext, "res"> {
+}
+export interface IAfterSearchEventContext extends Omit<IAfterSearchContext, "res"> {
+}
+export interface IAfterShowEventContext extends Omit<IAfterShowContext, "res"> {
+}
 export interface IRouteDocumentation {
     version: string;
     handler: string;

package/build/src/Resolvers/FileResolver.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {

package/build/src/Resolvers/ModelResolver.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {

package/build/src/Resolvers/VersionConfigResolver.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {

package/build/src/Server.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {

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

@@ -20,4 +20,5 @@ export declare const allow: (feature: QueryFeature, keys?: string[]) => IQueryLi
  *  deny(QueryFeature.WhereLike)
  */
 export declare const deny: (feature: QueryFeature, keys?: string[]) => IQueryLimitConfig[];
+export declare const isQueryFeatureEnabled: (model: IModelService, feature: QueryFeature, key?: string | null) => boolean;
 export declare const valideteQueryFeature: (model: IModelService, feature: QueryFeature, key?: string | null, errorDescription?: string) => void;

package/build/src/Services/LimitService.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.valideteQueryFeature = exports.deny = exports.allow = void 0;
+exports.valideteQueryFeature = exports.isQueryFeatureEnabled = exports.deny = exports.allow = void 0;
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
 const QueryFeatureMap = {
@@ -116,25 +116,32 @@ const deny = (feature, keys = []) => {
     return generatePermission(Enums_1.QueryFeatureType.Deny, feature, keys);
 };
 exports.deny = deny;
-const valideteQueryFeature = (model, feature, key = null, errorDescription) => {
-    const errorDetail = errorDescription ? ` (${errorDescription})` : "";
+const isQueryFeatureEnabled = (model, feature, key = null) => {
     const rules = model.queryLimits.filter((limit) => limit.feature === feature && limit.key === null);
     if (key) {
         const keyRules = model.queryLimits.filter((limit) => limit.feature === feature && limit.key === key);
         if (keyRules.length > 0) {
             const lastKeyRule = keyRules[keyRules.length - 1];
             if ((lastKeyRule === null || lastKeyRule === void 0 ? void 0 : lastKeyRule.type) === Enums_1.QueryFeatureType.Deny) {
-                throw new ApiError_1.default(`[ERR-1] Unsupported query feature${errorDetail}: ${feature.toString()} [${key}]`);
+                return false;
             }
-            return;
+            return true;
         }
     }
     if (rules.length === 0) {
-        throw new ApiError_1.default(`[ERR-2] Unsupported query feature${errorDetail}: ${feature.toString()}`);
+        return false;
     }
     const lastRule = rules[rules.length - 1];
     if ((lastRule === null || lastRule === void 0 ? void 0 : lastRule.type) === Enums_1.QueryFeatureType.Deny) {
-        throw new ApiError_1.default(`[ERR-3] Unsupported query feature${errorDetail}: ${feature.toString()}`);
+        return false;
+    }
+    return true;
+};
+exports.isQueryFeatureEnabled = isQueryFeatureEnabled;
+const valideteQueryFeature = (model, feature, key = null, errorDescription) => {
+    const errorDetail = errorDescription ? ` (${errorDescription})` : "";
+    if ((0, exports.isQueryFeatureEnabled)(model, feature, key) === false) {
+        throw new ApiError_1.default(`[ERR-1] Unsupported query feature${errorDetail}: ${feature.toString()} [${key}]`);
     }
 };
 exports.valideteQueryFeature = valideteQueryFeature;

package/build/src/Validators/RobustValidator.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {

package/package.json

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

package/readme.md

@@ -1,7 +1,7 @@
 <h1 align="center">
   <br>
   <a href="https://axe-api.com/">
-    <img src="https://axe-api.com/axe.png" alt="Markdownify" width="200">
+    <img src="https://axe-api.com/viking.png" alt="Markdownify" width="200">
   </a>
   <br>
   Axe API