axe-api 0.31.1 → 0.31.3

package/build/src/Builders/RouterBuilder.js

@@ -32,11 +32,11 @@ class RouterBuilder {
         this.getRootPrefix = () => __awaiter(this, void 0, void 0, function* () {
             const api = Services_1.APIService.getInstance();
             let prefix = api.config.prefix || "api";
-            if (prefix.substr(0, 1) === "/") {
-                prefix = prefix.substr(1);
+            if (prefix.startsWith("/")) {
+                prefix = prefix.substring(1);
             }
-            if (prefix.substr(prefix.length - 1) === "/") {
-                prefix = prefix.substr(0, prefix.length - 1);
+            if (prefix.endsWith("/")) {
+                prefix = prefix.substring(0, prefix.length - 1);
             }
             return prefix;
         });
@@ -210,19 +210,17 @@ class RouterBuilder {
     }
     sendErrorAsResponse(res, error) {
         const type = error.type;
-        switch (type) {
-            case "ApiError":
-                // eslint-disable-next-line no-case-declarations
-                const apiError = error;
-                res.status(apiError.status).json({
-                    error: apiError.message,
-                });
-                break;
-            default:
-                // We should log error and send general error response
-                Services_1.LogService.getInstance().error(`SERVER ERROR: ${JSON.stringify(Object.assign(Object.assign({}, error), { message: error.message }), null, "  ")}`);
-                throw error;
+        if (type === "ApiError") {
+            // eslint-disable-next-line no-case-declarations
+            const apiError = error;
+            res.status(apiError.status).json({
+                error: apiError.message,
+            });
+            return;
         }
+        // We should log error and send general error response
+        Services_1.LogService.getInstance().error(`SERVER ERROR: ${JSON.stringify(Object.assign(Object.assign({}, error), { message: error.message }), null, "  ")}`);
+        throw error;
     }
     getResourcePath(model, relation) {
         return relation

package/build/src/Handlers/DestroyHandler.js

@@ -15,7 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Helpers_1 = require("./Helpers");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
-const Enums_2 = require("../Enums");
 exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const { model, req, res, database, relation, parentModel } = pack;
     // We should check the parameter type
@@ -32,7 +31,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeDeleteQuery, Object.assign(Object.assign({}, pack), { query }));
     const item = yield query.first();
     if (!item) {
-        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_1.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterDeleteQuery, Object.assign(Object.assign({}, pack), { query,
         item }));

package/build/src/Handlers/ForceDestroyHandler.js

@@ -15,7 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Helpers_1 = require("./Helpers");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
-const Enums_2 = require("../Enums");
 exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const { model, req, res, database, relation, parentModel } = pack;
     // We should check the parameter type
@@ -27,7 +26,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
         .where(model.instance.primaryKey, value);
     // If there is a deletedAtColumn, it means that this table support soft-delete
     if (model.instance.deletedAtColumn === null) {
-        throw new ApiError_1.default("You can use force delete only soft-delete supported models.", Enums_2.StatusCodes.NOT_FOUND);
+        throw new ApiError_1.default("You can use force delete only soft-delete supported models.", Enums_1.StatusCodes.NOT_FOUND);
     }
     // If there is a relation, we should bind it
     (0, Helpers_1.addForeignKeyQuery)(req, query, relation, parentModel);

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

@@ -1,6 +1,6 @@
-import { IRequestPack } from "../Interfaces";
 import { HandlerTypes } from "../Enums";
+import { HandlerFunction } from "../Types";
 declare class HandlerFactory {
-    static get(handleType: HandlerTypes): (pack: IRequestPack) => void;
+    static get(handleType: HandlerTypes): HandlerFunction;
 }
 export default HandlerFactory;

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

@@ -1,17 +1,16 @@
 import { Request } from "express";
-import { IModelService, IRelation, IHookParameter, IQuery, IVersion } from "../Interfaces";
+import { IModelService, IRelation, IHookParameter, IQuery, IVersion, IWith } from "../Interfaces";
 import { Knex } from "knex";
-import { IWith } from "../Interfaces";
 import { HandlerTypes, HookFunctionTypes, TimestampColumns } from "../Enums";
 import { ModelListService } from "../Services";
 import { SerializationFunction } from "../Types";
-export declare const bindTimestampValues: (formData: Record<string, any>, columnTypes: TimestampColumns[] | undefined, model: IModelService) => void;
+export declare const bindTimestampValues: (formData: Record<string, any>, model: IModelService, columnTypes?: TimestampColumns[]) => void;
 export declare const getMergedFormData: (req: Request, fillables: string[]) => Record<string, any>;
 export declare const callHooks: (model: IModelService, type: HookFunctionTypes, params: IHookParameter) => Promise<void>;
 export declare const getParentColumn: (relation: IRelation | null) => string | null;
 export declare const checkPrimaryKeyValueType: (model: IModelService, value: any) => void;
 export declare const addForeignKeyQuery: (request: Request, query: Knex.QueryBuilder, relation: IRelation | null, parentModel: IModelService | null) => void;
-export declare const serializeData: (version: IVersion, itemArray: any[] | any, modelSerializer: SerializationFunction | null, handler: HandlerTypes, request: Request) => Promise<any[]>;
+export declare const serializeData: (version: IVersion, itemArray: any, modelSerializer: SerializationFunction | null, handler: HandlerTypes, request: Request) => Promise<any[]>;
 export declare const filterHiddenFields: (itemArray: any[], hiddens: string[] | null) => void;
 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: Request) => Promise<void>;

package/build/src/Handlers/Helpers.js

@@ -19,7 +19,7 @@ const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
 const Services_1 = require("../Services");
 const LimitService_1 = require("../Services/LimitService");
 const constants_1 = require("../constants");
-const bindTimestampValues = (formData, columnTypes = [], model) => {
+const bindTimestampValues = (formData, model, columnTypes = []) => {
     if (columnTypes.includes(Enums_1.TimestampColumns.CREATED_AT) &&
         model.instance.createdAtColumn) {
         formData[model.instance.createdAtColumn] = new Date();
@@ -42,7 +42,8 @@ const getMergedFormData = (req, fillables) => {
 exports.getMergedFormData = getMergedFormData;
 const callHooks = (model, type, params) => __awaiter(void 0, void 0, void 0, function* () {
     if (model.hooks[type]) {
-        yield model.hooks[type](params);
+        const hookFunction = model.hooks[type];
+        yield hookFunction(params);
     }
     if (model.events[type]) {
         // Developers shouldn't be able to access transaction in events. Because
@@ -117,7 +118,6 @@ const globalSerializer = (version, itemArray, handler, request) => __awaiter(voi
         // Serialize data with specific handler like "PAGINATE" or "SHOW".
         if (configSerializer.handler.includes(handler)) {
             callbacks.push(...configSerializer.serializer);
-            return;
         }
     });
     callbacks.forEach((callback) => {

package/build/src/Handlers/PatchHandler.js

@@ -16,7 +16,6 @@ const validatorjs_1 = __importDefault(require("validatorjs"));
 const Helpers_1 = require("./Helpers");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
-const Enums_2 = require("../Enums");
 exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const { version, model, req, res, database, relation, parentModel } = pack;
     const query = database.from(model.instance.table);
@@ -31,7 +30,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     // Adding the main query
     let item = yield query.where(model.instance.primaryKey, value).first();
     if (!item) {
-        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_1.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterUpdateQuery, Object.assign(Object.assign({}, pack), { item,
         query }));
@@ -49,7 +48,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
         }
     }
     // We should bind the timestamp values
-    (0, Helpers_1.bindTimestampValues)(formData, [Enums_1.TimestampColumns.UPDATED_AT], model);
+    (0, Helpers_1.bindTimestampValues)(formData, model, [Enums_1.TimestampColumns.UPDATED_AT]);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeUpdate, Object.assign(Object.assign({}, pack), { item,
         formData,
         query }));

package/build/src/Handlers/ShowHandler.js

@@ -16,7 +16,6 @@ const Helpers_1 = require("./Helpers");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
 const Services_1 = require("../Services");
-const Enums_2 = require("../Enums");
 exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const { version, model, req, res, database, relation, parentModel } = pack;
     const queryParser = new Services_1.QueryService(model, version.modelList.get(), version.config);
@@ -41,7 +40,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     queryParser.applyWheres(query, conditions.q);
     let item = yield query.first();
     if (!item) {
-        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_1.StatusCodes.NOT_FOUND);
     }
     // We should try to get related data if there is any
     yield (0, Helpers_1.getRelatedData)(version, [item], conditions.with, model, version.modelList, database, Enums_1.HandlerTypes.ALL, req);

package/build/src/Handlers/StoreHandler.js

@@ -37,7 +37,10 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
         }
     }
     // We should bind the timestamp values
-    (0, Helpers_1.bindTimestampValues)(formData, [Enums_1.TimestampColumns.CREATED_AT, Enums_1.TimestampColumns.UPDATED_AT], model);
+    (0, Helpers_1.bindTimestampValues)(formData, model, [
+        Enums_1.TimestampColumns.CREATED_AT,
+        Enums_1.TimestampColumns.UPDATED_AT,
+    ]);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeInsert, Object.assign(Object.assign({}, pack), { formData }));
     const [returningResult] = yield database(model.instance.table)
         .insert(formData)

package/build/src/Handlers/UpdateHandler.js

@@ -16,7 +16,6 @@ const validatorjs_1 = __importDefault(require("validatorjs"));
 const Helpers_1 = require("./Helpers");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
-const Enums_2 = require("../Enums");
 exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const { version, model, req, res, database, relation, parentModel } = pack;
     const query = database.from(model.instance.table);
@@ -31,7 +30,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     // Adding the main query
     let item = yield query.where(model.instance.primaryKey, value).first();
     if (!item) {
-        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_1.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterUpdateQuery, Object.assign(Object.assign({}, pack), { item,
         query }));
@@ -49,7 +48,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
         }
     }
     // We should bind the timestamp values
-    (0, Helpers_1.bindTimestampValues)(formData, [Enums_1.TimestampColumns.UPDATED_AT], model);
+    (0, Helpers_1.bindTimestampValues)(formData, model, [Enums_1.TimestampColumns.UPDATED_AT]);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeUpdate, Object.assign(Object.assign({}, pack), { item,
         formData,
         query }));

package/build/src/Interfaces.d.ts

@@ -3,7 +3,7 @@ import { Express, Request, Response, NextFunction } from "express";
 import { Column } from "knex-schema-inspector/lib/types/column";
 import { HandlerTypes, LogLevels, HttpMethods, HookFunctionTypes, Extensions, Relationships, SortTypes, ConditionTypes, DependencyTypes, QueryFeature, QueryFeatureType } from "./Enums";
 import Model from "./Model";
-import { SerializationFunction } from "./Types";
+import { HookFunction, SerializationFunction } from "./Types";
 import { ModelListService } from "./Services";
 export interface IColumn extends Column {
     table_name: string;
@@ -96,9 +96,9 @@ export interface IHookParameter {
     database: Knex | Knex.Transaction;
     conditions: IQuery | null;
     query: Knex.QueryBuilder | null;
-    result: any | null;
-    item: any | null;
-    formData: any | null;
+    result: any;
+    item: any;
+    formData: any;
 }
 export interface IMethodBaseConfig {
     [HttpMethods.POST]?: string[];
@@ -115,14 +115,14 @@ export interface IModelService {
     relations: IRelation[];
     columns: IColumn[];
     columnNames: string[];
-    hooks: Record<HookFunctionTypes, (params: IHookParameter) => void>;
-    events: Record<HookFunctionTypes, (params: IHookParameter) => void>;
+    hooks: Record<HookFunctionTypes, HookFunction>;
+    events: Record<HookFunctionTypes, HookFunction>;
     isRecursive: boolean;
     children: IModelService[];
     queryLimits: IQueryLimitConfig[];
     serialize: SerializationFunction | null;
     setColumns(columns: IColumn[]): void;
-    setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: (params: IHookParameter) => void): void;
+    setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: HookFunction): void;
     setQueryLimits(limits: IQueryLimitConfig[]): void;
     setSerialization(callback: SerializationFunction): void;
 }

package/build/src/Model.d.ts

@@ -1,14 +1,14 @@
-import { Request, Response, NextFunction } from "express";
 import { IRelation, IMethodBaseConfig, IMethodBaseValidations, IHandlerBaseMiddleware, IHandlerBasedTransactionConfig, IQueryLimitConfig } from "./Interfaces";
 import { HandlerTypes, HttpMethods } from "./Enums";
+import { FieldList, MiddlewareFunction, ModelValidation } from "./Types";
 declare class Model {
     get primaryKey(): string;
     get table(): string;
-    get fillable(): string[] | IMethodBaseConfig;
-    get validations(): IMethodBaseValidations | Record<string, string>;
+    get fillable(): FieldList | IMethodBaseConfig;
+    get validations(): IMethodBaseValidations | ModelValidation;
     get handlers(): HandlerTypes[];
-    get middlewares(): ((req: Request, res: Response, next: NextFunction) => void)[] | IHandlerBaseMiddleware[] | IHandlerBaseMiddleware;
-    get hiddens(): string[];
+    get middlewares(): MiddlewareFunction[] | IHandlerBaseMiddleware[] | IHandlerBaseMiddleware;
+    get hiddens(): FieldList;
     get createdAtColumn(): string | null;
     get updatedAtColumn(): string | null;
     get deletedAtColumn(): string | null;
@@ -16,8 +16,8 @@ declare class Model {
     get ignore(): boolean;
     get limits(): Array<IQueryLimitConfig[]>;
     getFillableFields(methodType: HttpMethods): string[];
-    getValidationRules(methodType: HttpMethods): Record<string, string> | null;
-    getMiddlewares(handlerType: HandlerTypes): ((req: Request, res: Response, next: NextFunction) => void)[];
+    getValidationRules(methodType: HttpMethods): ModelValidation | null;
+    getMiddlewares(handlerType: HandlerTypes): MiddlewareFunction[];
     hasMany(relatedModel: string, primaryKey?: string, foreignKey?: string): IRelation;
     hasOne(relatedModel: string, primaryKey?: string, foreignKey?: string): IRelation;
     belongsTo(relatedModel: string, primaryKey: string, foreignKey: string): IRelation;

package/build/src/Model.js

@@ -48,6 +48,7 @@ class Model {
         return [];
     }
     getFillableFields(methodType) {
+        var _a, _b, _c;
         if (this.fillable === null) {
             return [];
         }
@@ -57,26 +58,27 @@ class Model {
         const values = this.fillable;
         switch (methodType) {
             case Enums_1.HttpMethods.PATCH:
-                return values.PATCH || [];
+                return (_a = values.PATCH) !== null && _a !== void 0 ? _a : [];
             case Enums_1.HttpMethods.POST:
-                return values.POST || [];
+                return (_b = values.POST) !== null && _b !== void 0 ? _b : [];
             case Enums_1.HttpMethods.PUT:
-                return values.PUT || [];
+                return (_c = values.PUT) !== null && _c !== void 0 ? _c : [];
             default:
                 return [];
         }
     }
     getValidationRules(methodType) {
+        var _a, _b;
         if (this.hasStringValue()) {
             return this.validations;
         }
         const values = this.validations;
         switch (methodType) {
             case Enums_1.HttpMethods.POST:
-                return values.POST || null;
+                return (_a = values.POST) !== null && _a !== void 0 ? _a : null;
             case Enums_1.HttpMethods.PATCH:
             case Enums_1.HttpMethods.PUT:
-                return values.PUT || null;
+                return (_b = values.PUT) !== null && _b !== void 0 ? _b : null;
             default:
                 return null;
         }

package/build/src/Resolvers/GeneralHookResolver.js

@@ -18,7 +18,7 @@ class GeneralHookResolver {
         return __awaiter(this, void 0, void 0, function* () {
             const fileResolver = new _1.FileResolver();
             const content = yield fileResolver.resolveContent(this.version.folders.root);
-            if (content && content.init) {
+            if (content === null || content === void 0 ? void 0 : content.init) {
                 const { onBeforeInit = null, onAfterInit = null } = content.init;
                 return { onBeforeInit, onAfterInit };
             }

package/build/src/Services/DocumentationService.js

@@ -11,7 +11,7 @@ class DocumentationService {
         return DocumentationService.instance;
     }
     push(version, handler, method, url, model) {
-        var _a, _b;
+        var _a, _b, _c;
         this.routes.push({
             version: version.name,
             handler,
@@ -25,7 +25,7 @@ class DocumentationService {
             fillables: model.instance.getFillableFields(method),
             validations: model.instance.getValidationRules(method),
             queryLimits: model.queryLimits,
-            queryDefaults: ((_b = (_a = version.config) === null || _a === void 0 ? void 0 : _a.query) === null || _b === void 0 ? void 0 : _b.defaults) || {},
+            queryDefaults: (_c = (_b = (_a = version.config) === null || _a === void 0 ? void 0 : _a.query) === null || _b === void 0 ? void 0 : _b.defaults) !== null && _c !== void 0 ? _c : {},
         });
     }
     get() {

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

@@ -9,7 +9,7 @@ declare class LogService {
     warn(message: string): void;
     info(message: string): void;
     success(message: string): void;
-    log(message: string): void;
     debug(message: string): void;
+    log(message: string): void;
 }
 export default LogService;

package/build/src/Services/LogService.js

@@ -33,12 +33,10 @@ class LogService {
             console.info(fgGreen, "[axe]", message, fgReset);
         }
     }
-    log(message) {
-        if (this.level === Enums_1.LogLevels.ALL) {
-            console.log(message);
-        }
-    }
     debug(message) {
+        this.log(message);
+    }
+    log(message) {
         if (this.level === Enums_1.LogLevels.ALL) {
             console.log(message);
         }

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

@@ -1,22 +1,22 @@
 import { HookFunctionTypes, Extensions } from "../Enums";
-import { IColumn, IHookParameter, IModelService, IQueryLimitConfig, IRelation } from "../Interfaces";
+import { IColumn, IModelService, IQueryLimitConfig, IRelation } from "../Interfaces";
 import Model from "./../Model";
-import { SerializationFunction } from "../Types";
+import { HookFunction, SerializationFunction } from "../Types";
 declare class ModelService implements IModelService {
     name: string;
     instance: Model;
     relations: IRelation[];
     columns: IColumn[];
     columnNames: string[];
-    hooks: Record<HookFunctionTypes, (params: IHookParameter) => void>;
-    events: Record<HookFunctionTypes, (params: IHookParameter) => void>;
+    hooks: Record<HookFunctionTypes, HookFunction>;
+    events: Record<HookFunctionTypes, HookFunction>;
     children: IModelService[];
     isRecursive: boolean;
     queryLimits: IQueryLimitConfig[];
     serialize: SerializationFunction | null;
     constructor(name: string, instance: Model);
     setColumns(columns: IColumn[]): void;
-    setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: (params: IHookParameter) => void): void;
+    setExtensions(type: Extensions, hookFunctionType: HookFunctionTypes, data: HookFunction): void;
     setQueryLimits(limits: IQueryLimitConfig[]): void;
     setSerialization(callback: SerializationFunction): void;
     private setHooks;

package/build/src/Services/QueryService.js

@@ -247,10 +247,10 @@ class QueryService {
             let type = Enums_1.SortTypes.ASC;
             if (field.indexOf("-") === 0) {
                 type = Enums_1.SortTypes.DESC;
-                field = field.substr(1);
+                field = field.substring(1);
             }
             if (field.indexOf("+") === 0) {
-                field = field.substr(1);
+                field = field.substring(1);
             }
             this.shouldBeAcceptableColumn(field);
             result.push({

package/build/src/Types.d.ts

@@ -1,2 +1,8 @@
-import { Request } from "express";
+import { NextFunction, Request, Response } from "express";
+import { IRequestPack, IHookParameter } from "./Interfaces";
 export type SerializationFunction = (item: any, request: Request) => any;
+export type HandlerFunction = (pack: IRequestPack) => void;
+export type MiddlewareFunction = (req: Request, res: Response, next: NextFunction) => void;
+export type ModelValidation = Record<string, string>;
+export type FieldList = string[];
+export type HookFunction = (pack: IHookParameter) => Promise<void>;

package/build/src/constants.js

@@ -24,6 +24,7 @@ exports.RESERVED_KEYWORDS = [
     "hooks",
     "event",
     "events",
+    "all",
 ];
 exports.DEFAULT_HANDLERS = [
     Enums_1.HandlerTypes.INSERT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.31.1",
+  "version": "0.31.3",
   "description": "AXE API is a simple tool which has been created based on Express and Knex.js to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -35,19 +35,21 @@
     "dev-kit:remove": "node ./scripts/dev-kit-remove.js",
     "test": "jest --runInBand",
     "test:dev": "jest --watch",
-    "lint": "eslint src/**",
+    "lint": "eslint --max-warnings=0 .",
     "lint:watch": "esw --watch --color",
     "prepare:integration": "nodemon --ignore \"./tests/**\" ./scripts/run-integration-test.js",
     "test:postgres": "sh ./scripts/test-postgres.sh",
     "test:mysql57": "sh ./scripts/test-mysql57.sh",
-    "test:mysql8": "sh ./scripts/test-mysql8.sh"
+    "test:mysql8": "sh ./scripts/test-mysql8.sh",
+    "prettier:check": "prettier --check .",
+    "prepare": "husky install"
   },
   "dependencies": {
     "chalk": "^4.1.2",
     "change-case": "^4.1.2",
-    "dotenv": "^16.0.3",
+    "dotenv": "^16.3.1",
     "knex": "^2.4.2",
-    "knex-paginate": "^3.1.0",
+    "knex-paginate": "^3.1.1",
     "knex-schema-inspector": "^3.0.1",
     "pluralize": "^8.0.0",
     "validatorjs": "^3.22.1"
@@ -61,8 +63,8 @@
     "@types/multer": "^1.4.7",
     "@types/pluralize": "^0.0.29",
     "@types/validatorjs": "^3.15.0",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
+    "@typescript-eslint/eslint-plugin": "^5.61.0",
+    "@typescript-eslint/parser": "^5.61.0",
     "babel-jest": "^29.5.0",
     "eslint": "^7.32.0",
     "eslint-config-standard": "^16.0.3",
@@ -73,7 +75,9 @@
     "eslint-watch": "^7.0.0",
     "express": "^4.18.2",
     "glob": "^9.3.2",
+    "husky": "^8.0.3",
     "jest": "^29.5.0",
+    "lint-staged": "^13.2.3",
     "multer": "^1.4.5-lts.1",
     "mysql": "^2.18.1",
     "node-color-log": "^10.0.2",
@@ -84,5 +88,8 @@
     "sqlite3": "^5.1.6",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.2"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
   }
 }

package/readme.md

@@ -9,8 +9,8 @@
   <a href="https://badge.fury.io/js/axe-api">
     <img src="https://badge.fury.io/js/axe-api.svg" alt="npm version" height="18">
   </a>
-  <a href="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml" target="_blank">
-    <img src="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml/badge.svg?branch=master">
+  <a href="https://github.com/axe-api/axe-api/actions/workflows/npm-release-publish.yml" target="_blank">
+    <img src="https://github.com/axe-api/axe-api/actions/workflows/npm-release-publish.yml/badge.svg?branch=master">
   </a>
   <a href="https://sonarcloud.io/dashboard?id=axe-api_axe-api" target="_blank">
     <img src="https://sonarcloud.io/api/project_badges/measure?project=axe-api_axe-api&metric=alert_status">
@@ -23,123 +23,19 @@
   </a>
 </h1>
 
-Next Generation Rest API Framework
+**Axe API** is a **TypeScript-based** **Node.js** framework designed to eliminate the need for repetitive tasks associated with common elements while allowing developers to focus on custom logic.
 
-> Axe API has great documentation. Please [check it out in here](https://axe-api.com/).
+It offers a comprehensive structure for your API, including numerous features and best practices that will save you time.
 
-## What Is Axe API?
+## Video Introduction
 
-Axe API is a [Node.js](https://nodejs.org/) framework that helps you create a **Rest API** in a declarative way quickly. :axe:
+<div style="display: flex; justify-content: center;">
 
-It has been written with [TypeScript](https://www.typescriptlang.org/) and built on [Express](https://expressjs.com/) and [Knex.js](https://knexjs.org/).
+<a href="https://www.youtube.com/watch?v=3p4jggsNrJA" target="_blank">
+  <img src="./youtube.png" />
+</a>
 
-## Motivation
-
-You would understand easily what you are going to code when you look at a bunch of database tables and their relations with each other, more or less. Because, as a developer, you already know that _Rest API_ best practices.
-
-Therefore I asked a simple question more than two years ago;
-
-**_"Can we create a Rest API in a declarative way, and handle all endpoints automatically?"_**
-
-As a result of our work, we have a framework called Axe API that provides a solution to analyze your API definitions and handle all of the endpoints.
-
-Basically, you define your models which are your API definitions, and Axe API analyzes them and processes all of your endpoints instead of you.
-
-## Showcase
-
-Let's look at an example!
-
-You have two database tables; `users` and `posts`. These tables are related to each other and we aim that create a **Rest API** for basic **CRUD** endpoints.
-
-The only thing to do is creating models like the following example;
-
-```ts
-class User extends Model {
-  get fillable(): string[] {
-    return ["email", "name", "surname"];
-  }
-
-  posts(): IRelation {
-    return this.hasMany("Post", "id", "user_id");
-  }
-}
-```
-
-```ts
-class Post extends Model {
-  get fillable(): string[] {
-    return ["title", "description"];
-  }
-
-  user(): IRelation {
-    return this.belongsTo("User", "user_id", "id");
-  }
-}
-```
-
-Tada! :tada:
-
-Your API is ready to process all of the following endpoints after those model definitions are done.
-
-- [GET] `api/users`
-- [POST] `api/users`
-- [GET] `api/users/:id`
-- [PUT] `api/users/:id`
-- [DELETE] `api/users/:id`
-- [GET] `api/users/:userId/posts`
-- [POST] `api/users/:userId/posts`
-- [GET] `api/users/:userId/posts/:id`
-- [PUT] `api/users/:userId/posts/:id`
-- [DELETE] `api/users/:userId/posts/:id`
-
-This is the main power of Axe API. Nevertheless, it is not limited only to this power. There are many more features are waiting to discover. :bulb:
-
-## Installation
-
-Using **Axe API** in an application is very easy. We've created a CLI tool for you; [axe-magic](https://github.com/axe-api/axe-magic).
-
-You can create a new Axe API project by using [axe-magic](https://github.com/axe-api/axe-magic). But first, you can install it in your development environment. When you installed it, you can be able to access **axe-magic** command via CLI. You can use the following command to install **axe-magic** to your machine;
-
-```bash
-$ npm i -g axe-magic
-$ axe-magic --version
-1.0.0
-```
-
-After that, creating a new project is very easy. Just you can execute the following command;
-
-```bash
-$ axe-magic new my-api
-```
-
-This command will pull [axe-api-template](https://github.com/axe-api/axe-api-template) project to your current directory with a new name, **my-api**.
-
-To install your project's depencies, you can execute the following commands in the root directory;
-
-```bash
-$ cd my-api
-$ npm install
-```
-
-To serve this application, you can execute the following command;
-
-```bash
-$ npm run start:dev
-```
-
-After that, your first **Axe API** application will be running in `localhost:3000`.
-
-You will see the following API response if you visit [localhost:3000](http://localhost:3000).
-
-```json
-{
-  "name": "AXE API",
-  "description": "The best API creation tool in the world.",
-  "aim": "To kill them all!"
-}
-```
-
-If you can see that response, it means that your project is running properly.
+</div>
 
 ## Documentation
 

package/CHANGELOG.md

@@ -1,257 +0,0 @@
-# Release Notes
-
-## [0.31.1 (2023-05-08)](https://github.com/axe-api/axe-api/compare/0.31.1...0.31.0)
-
-### Fixed
-
-- The app crashes on database errors [#155](https://github.com/axe-api/axe-api/issues/155)
-- We should return 404 if the record is not found [#169](https://github.com/axe-api/axe-api/issues/169)
-- An error should be thrown if the per_page value is not acceptable [#172](https://github.com/axe-api/axe-api/issues/172)
-
-## [0.31.0 (2023-05-05)](https://github.com/axe-api/axe-api/compare/0.31.0...0.30.3)
-
-### Features
-
-- Added new auto-created documentation values [#179](https://github.com/axe-api/axe-api/issues/179)
-
-### Fixed
-
-- Fixed PostgreSQL-related issues [#204](https://github.com/axe-api/axe-api/issues/204)
-
-## [0.30.3 (2023-05-05)](https://github.com/axe-api/axe-api/compare/0.30.3...0.30.2)
-
-### Fixed
-
-- Fixed security issues on dependencies.
-
-## [0.30.2 (2023-04-18)](https://github.com/axe-api/axe-api/compare/0.30.2...0.30.1)
-
-### Features
-
-- Event/Hook type warning added [#163](https://github.com/axe-api/axe-api/issues/163)
-
-## [0.30.1 (2023-04-15)](https://github.com/axe-api/axe-api/compare/0.30.1...0.30.0)
-
-### Fixed
-
-- Fixed URL slash character difference between windows and \*nix [#164](https://github.com/axe-api/axe-api/issues/164)
-
-## [0.30.0 (2023-04-05)](https://github.com/axe-api/axe-api/compare/0.30.0...0.22.0)
-
-### Breaking Changes
-
-- Added new Serizaliation folder [#125](https://github.com/axe-api/axe-api/issues/125)
-- New hook/event folder structure [#146](https://github.com/axe-api/axe-api/issues/146)
-- Limiting query features by configurations [#38](https://github.com/axe-api/axe-api/issues/38)
-- Removing external dependencies from axe-core [#151](https://github.com/axe-api/axe-api/issues/151)
-
-## [0.22.0 (2023-01-29)](https://github.com/axe-api/axe-api/compare/0.22.0...0.21.0)
-
-### Features
-
-- Added Soft-Deleting feature [#41](https://github.com/axe-api/axe-api/issues/41)
-
-### Fixed
-
-- Fixed model relation route URLs [#141](https://github.com/axe-api/axe-api/issues/141)
-
-## [0.21.0 (2022-12-28)](https://github.com/axe-api/axe-api/compare/0.21.0...0.20.4)
-
-### Features
-
-- Added `i18n` support. [#44](https://github.com/axe-api/axe-api/issues/44)
-
-## [0.20.4 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.4...0.20.3)
-
-### Fixed
-
-- Fixed [#124](https://github.com/axe-api/axe-api/issues/124)
-- Throwing errors in the `development` environment has been fixed.
-- Unbuilt integration test issue has been fixed.
-
-## [0.20.3 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.3...0.20.0)
-
-### Fixed
-
-- NPM publish bugs
-
-## [0.20.0 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.0...0.19.2)
-
-In the whole application, TypeScript becomes the new language except for migration files and it's structure. You can read the documentation about how to migrate from `0.19.2` to `0.20.0`.
-
-### Breaking Changes
-
-#### Naming Changes
-
-- File extensions: `User.js` to `User.ts`
-- `LOG_LEVELS` constant variable has been changed with `LogLevels` enum.
-- `HANDLERS` constant variable has been changed with `HandlerTypes` enum.
-- `IoC` service has been renamed as `IoCService`.
-- Hooks and Event files' names should be singular;
-  - `UserHooks.js` => `UserHook.ts`
-  - `UserEvents.js` => `UserEvent.ts`
-
-#### Interface Changes
-
-- `validations()` getter should return `IMethodBaseValidations` interface.
-- In hook functions, `IHookParameter` interface should be used as the parameter type.
-- Init functions (`onBeforeInit`, `onAfterInit`) should be use the `Express` type;
-  - `const onBeforeInit = async ({ app }) => {` => `const onBeforeInit = async (app: Express) => {`
-  - `const onAfterInit = async ({ app }) => {` => `const onAfterInit = async (app: Express) => {`
-- Application config should be implemented `IApplicationConfig` interface.
-
-#### Implementation Changes
-
-- Starting server part has been changed;
-  - `const server = new Server(appFolder)` => `const server = new Server()`
-  - `server.listen()` => `server.start(__dirname);`
-- `knexfile.js` should not use the `app/Application/Config.js` anymore.
-
-## [0.19.2 (2022-01-22)](https://github.com/axe-api/axe-api/compare/0.19.2...0.19.1)
-
-### Fixed
-
-- Fixed the calling `onBeforePaginate` and `onBeforeShow` hooks bug.
-
-## [0.19.1 (2022-01-22)](https://github.com/axe-api/axe-api/compare/0.19.1...0.19.0)
-
-### Fixed
-
-- knex.js version update.
-
-## [0.19.0 (2021-12-05)](https://github.com/axe-api/axe-api/compare/0.19.0...0.18.1)
-
-### Fixed
-
-- [#110](https://github.com/axe-api/axe-api/issues/110)
-
-### Enhancements
-
-- [#106](https://github.com/axe-api/axe-api/issues/106)
-
-## [0.18.1 (2021-12-02)](https://github.com/axe-api/axe-api/compare/0.18.1...0.18.0)
-
-### Fixed
-
-- [#117](https://github.com/axe-api/axe-api/issues/117)
-
-## [0.18.0 (2021-11-30)](https://github.com/axe-api/axe-api/compare/0.18.0...0.17.5)
-
-### Fixed
-
-- [#115](https://github.com/axe-api/axe-api/issues/115)
-- [#114](https://github.com/axe-api/axe-api/issues/114)
-
-### Enhancements
-
-- [#113](https://github.com/axe-api/axe-api/issues/113)
-- [#107](https://github.com/axe-api/axe-api/issues/107)
-- [#108](https://github.com/axe-api/axe-api/issues/108)
-
-## [0.17.5 (2021-11-27)](https://github.com/axe-api/axe-api/compare/0.17.5...0.17.4)
-
-### Fixed
-
-- [#111](https://github.com/axe-api/axe-api/issues/111)
-
-## [0.17.4 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.4...0.17.3)
-
-### Fixed
-
-- [#97](https://github.com/axe-api/axe-api/issues/97)
-- [#104](https://github.com/axe-api/axe-api/issues/104)
-
-## [0.17.3 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.3...0.17.2)
-
-### Fixed
-
-- [#98](https://github.com/axe-api/axe-api/issues/98)
-
-## [0.17.2 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.2...0.17.1)
-
-### Fixed
-
-- Fixed table join on the related table filter.
-
-## [0.17.1 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.1...0.17.0)
-
-### Fixed
-
-- Query bug on child models [#93](https://github.com/axe-api/axe-api/issues/93)
-
-## [0.17.0 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.0...0.16.0)
-
-### Fixed
-
-- Related query column name check bug has been fixed.
-
-### Features
-
-- Global serializer for HTTP results [#37](https://github.com/axe-api/axe-api/issues/37)
-
-## [0.16.0 (2021-10-06)](https://github.com/axe-api/axe-api/compare/0.16.0...0.15.0)
-
-### Features
-
-- Fixes [#89](https://github.com/axe-api/axe-api/issues/89)
-
-## [0.15.0 (2021-10-03)](https://github.com/axe-api/axe-api/compare/0.15.0...0.14.1)
-
-### Features
-
-- Fixes [#87](https://github.com/axe-api/axe-api/issues/87)
-
-## [0.14.1 (2021-09-20)](https://github.com/axe-api/axe-api/compare/0.14.1...0.14.0)
-
-### Fixed
-
-- Fixes [#83](https://github.com/axe-api/axe-api/issues/83)
-
-## [0.14.0 (2021-09-15)](https://github.com/axe-api/axe-api/compare/0.14.0...0.13.3)
-
-### Features
-
-- General hooks definition feature has been added. ([#81](https://github.com/axe-api/axe-api/issues/81))
-
-## [0.13.3 (2021-09-15)](https://github.com/axe-api/axe-api/compare/0.13.2...0.13.3)
-
-### Fixed
-
-- Fixed CORS bugs.
-
-## [0.13.2 (2021-08-20)](https://github.com/axe-api/axe-api/compare/0.13.1...0.13.2)
-
-### Fixed
-
-- Fixes [#27](https://github.com/axe-api/axe-api/issues/27)
-- Fixes [#29](https://github.com/axe-api/axe-api/issues/29)
-- Fixes [#75](https://github.com/axe-api/axe-api/issues/75)
-- Fixes [#78](https://github.com/axe-api/axe-api/issues/78)
-
-## [0.13.1 (2021-08-09)](https://github.com/axe-api/axe-api/compare/0.13.0...0.13.1)
-
-### Fixed
-
-- Fixes [#69](https://github.com/axe-api/axe-api/issues/69)
-- Fixes [#70](https://github.com/axe-api/axe-api/issues/70)
-- Fixes [#71](https://github.com/axe-api/axe-api/issues/71)
-- Fixes [#72](https://github.com/axe-api/axe-api/issues/72)
-
-## [0.13.0 (2021-07-25)](https://github.com/axe-api/axe-api/compare/0.12.2...0.13.0)
-
-### Features
-
-- PostgreSQL database analyzer and integration tests have been added.
-
-## [0.12.2 (2021-07-24)](https://github.com/axe-api/axe-api/compare/0.12.1...0.12.2)
-
-### Fixed
-
-- Throwing an error if the primary key column isn't in the database table bug has been fixed. (#61)[https://github.com/axe-api/axe-api/issues/61]
-- Using numeric column name bug has been fixed. (#24)[https://github.com/axe-api/axe-api/issues/24]
-
-## [0.12.1 (2021-07-24)](https://github.com/axe-api/axe-api/compare/0.12.0...0.12.1)
-
-### Fixed
-
-- Fixed security issues.