axe-api 1.1.0 → 1.3.0

package/build/src/Builders/RouterBuilder.js

@@ -55,8 +55,8 @@ class RouterBuilder {
             }
         });
     }
-    createRouteByModel(model, parentPairs = [], urlPrefix = "", parentModel = null, relation = null, allowRecursive = true) {
-        return __awaiter(this, void 0, void 0, function* () {
+    createRouteByModel(model_1) {
+        return __awaiter(this, arguments, void 0, function* (model, parentPairs = [], urlPrefix = "", parentModel = null, relation = null, allowRecursive = true) {
             if (model.instance.ignore) {
                 return;
             }

package/build/src/Interfaces.d.ts

@@ -181,13 +181,105 @@ export interface IContext extends IRouteData {
     isTransactionOpen: boolean;
     validator: IValidator;
     queryParser?: QueryService;
+    params?: any;
+    /**
+     * @deprecated Use special hook type instead of IContext like IBeforeInsertContext
+     */
     conditions?: IQuery;
+    /**
+     * @deprecated Use special hook type instead of IContext like IBeforeInsertContext
+     */
     query?: Knex.QueryBuilder;
-    params?: any;
+    /**
+     * @deprecated Use special hook type instead of IContext like IBeforeInsertContext
+     */
     result?: any;
+    /**
+     * @deprecated Use special hook type instead of IContext like IBeforeInsertContext
+     */
     item?: any;
+    /**
+     * @deprecated Use special hook type instead of IContext like IBeforeInsertContext
+     */
     formData?: any;
 }
+export interface IBeforeInsertContext extends IContext {
+    formData: any;
+}
+export interface IBeforeUpdateQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+}
+export interface IBeforeUpdateContext extends IContext {
+    query: Knex.QueryBuilder;
+    item: any;
+    formData: any;
+}
+export interface IBeforeDeleteQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+}
+export interface IBeforeDeleteContext extends IContext {
+    query: Knex.QueryBuilder;
+}
+export interface IBeforeForceDeleteQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+}
+export interface IBeforeForceDeleteContext extends IContext {
+    query: Knex.QueryBuilder;
+}
+export interface IBeforePaginateContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+}
+export interface IBeforeAllContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+}
+export interface IBeforeShowContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+}
+export interface IAfterInsertContext extends IContext {
+    item: any;
+    formData: any;
+}
+export interface IAfterUpdateQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+    item: any;
+}
+export interface IAfterUpdateContext extends IContext {
+    query: Knex.QueryBuilder;
+    item: any;
+    formData: any;
+}
+export interface IAfterDeleteQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+    item: any;
+}
+export interface IAfterDeleteContext extends IContext {
+    item: any;
+}
+export interface IAfterForceDeleteQueryContext extends IContext {
+    query: Knex.QueryBuilder;
+    item: any;
+}
+export interface IAfterForceDeleteContext extends IContext {
+    item: any;
+}
+export interface IAfterPaginateContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+    result: any;
+}
+export interface IAfterAllContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+    result: any;
+}
+export interface IAfterShowContext extends IContext {
+    query: Knex.QueryBuilder;
+    conditions: IQuery;
+    item: any;
+}
 export interface IRouteDocumentation {
     version: string;
     handler: string;

package/build/src/Resolvers/ModelResolver.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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 __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) {
@@ -143,9 +166,29 @@ class ModelResolver {
                 if (!currentModel) {
                     throw new AxeError_1.default(Enums_1.AxeErrorCode.UNDEFINED_HOOK_MODEL_RELATION, `Undefined model relation: ${subfolderPath}`);
                 }
+                // Loading hooks via index.ts if there is any
+                const indexFilePath = path_1.default.join(subfolderPath, "index.ts");
+                if (fs_1.default.existsSync(indexFilePath)) {
+                    // Importing the file
+                    const content = yield Promise.resolve(`${indexFilePath}`).then(s => __importStar(require(s)));
+                    const keys = Object.keys(content);
+                    for (const key of keys) {
+                        // The exported function should be a hook function
+                        if (hookList.includes(key)) {
+                            currentModel.setExtensions(hookType, key, content[key]);
+                        }
+                        else {
+                            Services_1.LogService.warn(`Invalid ${hookType} function: "${key}()" in the index.ts: "${indexFilePath}"`);
+                        }
+                    }
+                }
                 // Loading all hooks files in the subfolder
                 const hooks = yield fileResolver.resolveContent(subfolderPath);
                 for (const hookName in hooks) {
+                    // We can ignore the index.ts
+                    if (hookName === "index") {
+                        continue;
+                    }
                     // If we have an acceptable hook
                     if (hookList.includes(hookName)) {
                         // We bind the hook with the model
@@ -191,9 +234,22 @@ class ModelResolver {
             const fileResolver = new FileResolver_1.default();
             const serializations = yield fileResolver.resolveContent(this.version.folders.serialization);
             for (const model of modelList.get()) {
-                const fileName = `${model.name}Serialization`;
-                if (serializations[fileName]) {
-                    const file = serializations[fileName];
+                // Old serialization
+                const oldName = `${model.name}Serialization`;
+                let isOldNamingUsed = false;
+                if (serializations[oldName]) {
+                    isOldNamingUsed = true;
+                    const file = serializations[oldName];
+                    model.setSerialization(file.default);
+                    Services_1.LogService.warn(`'${oldName}.ts' naming is deprecated. You can use '${oldName.replace("Serialization", "")}.ts' instead.`);
+                }
+                // New
+                const newName = `${model.name}`;
+                if (serializations[newName]) {
+                    if (isOldNamingUsed) {
+                        throw new Error(`You cannot use '${oldName}.ts' and '${newName}.ts' at the same time.`);
+                    }
+                    const file = serializations[newName];
                     model.setSerialization(file.default);
                 }
             }

package/build/src/Server.js

@@ -138,8 +138,8 @@ class Server {
         });
     }
     listen() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const app = yield Services_1.IoCService.use("App");
             const api = Services_1.APIService.getInstance();
             // Adding the default handler for auto-created routes

package/build/src/Services/AxeRequest.js

@@ -109,8 +109,8 @@ class AxeRequest {
      * @returns
      */
     files(options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             if (!((_a = this.header("content-type")) === null || _a === void 0 ? void 0 : _a.includes("multipart/form-data"))) {
                 LogService_1.default.warn(`Content-type must be 'multipart/form-data'.`);
                 throw new Error(`Content-type must be 'multipart/form-data'.`);

package/build/src/Services/ModelService.js

@@ -48,9 +48,15 @@ class ModelService {
         this.children = [];
     }
     setHooks(hookFunctionType, data) {
+        if (this.hooks[hookFunctionType]) {
+            throw new Error(`You can define only one hook function: ${this.name}.${hookFunctionType}`);
+        }
         this.hooks[hookFunctionType] = data;
     }
     setEvents(hookFunctionType, data) {
+        if (this.events[hookFunctionType]) {
+            throw new Error(`You can define only one event function: ${this.name}.${hookFunctionType}`);
+        }
         this.events[hookFunctionType] = data;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -29,8 +29,7 @@
   "scripts": {
     "build": "rm -rf build && tsc && rm -rf build/dev-kit",
     "build:watch": "tsc -w",
-    "dev": "ts-node-dev --files --respawn --clear index.ts",
-    "dev-kit": "ts-node-dev --respawn --clear dev-kit.ts",
+    "dev-kit": "tsx watch dev-kit.ts",
     "dev-kit:install": "node ./scripts/dev-kit-install.js",
     "dev-kit:remove": "node ./scripts/dev-kit-remove.js",
     "test": "jest --runInBand",
@@ -68,7 +67,7 @@
     "knex-schema-inspector": "^3.1.0",
     "nanoid": "^3.3.7",
     "pino": "^8.18.0",
-    "pino-pretty": "^10.3.1",
+    "pino-pretty": "^11.0.0",
     "pluralize": "^8.0.0",
     "validatorjs": "^3.22.1"
   },
@@ -102,18 +101,17 @@
     "multer": "^1.4.5-lts.1",
     "mysql": "^2.18.1",
     "node-cache": "^5.1.2",
-    "node-color-log": "^11.0.2",
     "nodemon": "^3.0.3",
     "pg": "^8.11.3",
     "prettier": "^3.2.5",
     "redis": "^4.6.13",
+    "robust-validator": "^1.1.0",
     "serve-static": "^1.15.0",
     "set-value": ">=4.1.0",
     "sqlite3": "^5.1.7",
     "ts-node": "^10.9.2",
-    "ts-node-dev": "^2.0.0",
-    "typescript": "^5.3.3",
-    "robust-validator": "^1.1.0"
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"