axe-api 0.30.3 → 0.31.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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

package/build/src/Builders/RouterBuilder.js

@@ -125,41 +125,47 @@ class RouterBuilder {
         return __awaiter(this, void 0, void 0, function* () {
             const docs = Services_1.DocumentationService.getInstance();
             const app = yield Services_1.IoCService.useByType("App");
-            const handler = (req, res) => {
-                this.requestHandler(handlerType, req, res, model, parentModel, relation);
-            };
+            const handler = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    yield this.requestHandler(handlerType, req, res, model, parentModel, relation);
+                }
+                catch (error) {
+                    // Catch error then pass it to the express error handler
+                    next(error);
+                }
+            });
             switch (handlerType) {
                 case Enums_1.HandlerTypes.ALL:
                     app.get(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.GET, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.ALL, Enums_1.HttpMethods.GET, url, model);
                     break;
                 case Enums_1.HandlerTypes.DELETE:
                     app.delete(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.DELETE, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.DELETE, Enums_1.HttpMethods.DELETE, url, model);
                     break;
                 case Enums_1.HandlerTypes.FORCE_DELETE:
                     app.delete(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.DELETE, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.FORCE_DELETE, Enums_1.HttpMethods.DELETE, url, model);
                     break;
                 case Enums_1.HandlerTypes.INSERT:
                     app.post(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.POST, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.INSERT, Enums_1.HttpMethods.POST, url, model);
                     break;
                 case Enums_1.HandlerTypes.PAGINATE:
                     app.get(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.GET, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.PAGINATE, Enums_1.HttpMethods.GET, url, model);
                     break;
                 case Enums_1.HandlerTypes.PATCH:
                     app.patch(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.PATCH, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.PATCH, Enums_1.HttpMethods.PATCH, url, model);
                     break;
                 case Enums_1.HandlerTypes.SHOW:
                     app.get(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.GET, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.SHOW, Enums_1.HttpMethods.GET, url, model);
                     break;
                 case Enums_1.HandlerTypes.UPDATE:
                     app.put(url, middlewares, handler);
-                    docs.push(Enums_1.HttpMethods.PUT, url, model);
+                    docs.push(this.version, Enums_1.HandlerTypes.UPDATE, Enums_1.HttpMethods.PUT, url, model);
                     break;
                 default:
                     throw new Error("Undefined handler type");
@@ -213,12 +219,8 @@ class RouterBuilder {
                 });
                 break;
             default:
-                // We should not show the real errors on production
-                if (process.env.NODE_ENV === "production") {
-                    res.status(Enums_1.StatusCodes.INTERNAL_SERVER_ERROR).json({
-                        error: "An error occurredxx.",
-                    });
-                }
+                // 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;
         }
     }

package/build/src/Exceptions/ApiError.d.ts

@@ -3,6 +3,6 @@ declare class ApiError extends Error {
     type: string;
     status: StatusCodes;
     message: string;
-    constructor(message: string);
+    constructor(message: string, status?: StatusCodes);
 }
 export default ApiError;

package/build/src/Exceptions/ApiError.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const Enums_1 = require("../Enums");
 class ApiError extends Error {
-    constructor(message) {
+    constructor(message, status = Enums_1.StatusCodes.BAD_REQUEST) {
         super(message);
         this.type = "ApiError";
-        this.status = Enums_1.StatusCodes.BAD_REQUEST;
+        this.status = status;
         this.message = message;
     }
 }

package/build/src/Handlers/DestroyHandler.js

@@ -15,11 +15,16 @@ 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
+    const value = req.params[model.instance.primaryKey];
+    (0, Helpers_1.checkPrimaryKeyValueType)(model, value);
+    // Adding the main query
     const query = database
         .from(model.instance.table)
-        .where(model.instance.primaryKey, req.params[model.instance.primaryKey]);
+        .where(model.instance.primaryKey, value);
     // If there is a deletedAtColumn, it means that this table support soft-delete
     (0, Helpers_1.addSoftDeleteQuery)(model, null, query);
     // If there is a relation, we should bind it
@@ -27,7 +32,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}.`);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterDeleteQuery, Object.assign(Object.assign({}, pack), { query,
         item }));

package/build/src/Handlers/DocsHTMLHandler.js

@@ -0,0 +1,24 @@
+"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 CLOUD_FRONT_DOMAIN = "https://dw7lgbuj348m4.cloudfront.net/v1";
+exports.default = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const result = yield fetch(`${CLOUD_FRONT_DOMAIN}/index.html`);
+        const content = (yield result.text())
+            .replaceAll(`src="`, `src="${CLOUD_FRONT_DOMAIN}`)
+            .replaceAll(`href="`, `href="${CLOUD_FRONT_DOMAIN}`);
+        res.send(content);
+    }
+    catch (error) {
+        res.send("404");
+    }
+});

package/build/src/Handlers/ForceDestroyHandler.js

@@ -15,14 +15,19 @@ 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
+    const value = req.params[model.instance.primaryKey];
+    (0, Helpers_1.checkPrimaryKeyValueType)(model, value);
+    // Adding the main query
     const query = database
         .from(model.instance.table)
-        .where(model.instance.primaryKey, req.params[model.instance.primaryKey]);
+        .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.");
+        throw new ApiError_1.default("You can use force delete only soft-delete supported models.", Enums_2.StatusCodes.NOT_FOUND);
     }
     // If there is a relation, we should bind it
     (0, Helpers_1.addForeignKeyQuery)(req, query, relation, parentModel);

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

@@ -9,6 +9,7 @@ export declare const bindTimestampValues: (formData: Record<string, any>, column
 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 filterHiddenFields: (itemArray: any[], hiddens: string[] | null) => void;

package/build/src/Handlers/Helpers.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBoolean = exports.getRelatedData = exports.addSoftDeleteQuery = exports.filterHiddenFields = exports.serializeData = exports.addForeignKeyQuery = exports.getParentColumn = exports.callHooks = exports.getMergedFormData = exports.bindTimestampValues = void 0;
+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 change_case_1 = require("change-case");
 const Enums_1 = require("../Enums");
 const ApiError_1 = __importDefault(require("../Exceptions/ApiError"));
@@ -63,6 +63,14 @@ const getParentColumn = (relation) => {
     return (0, change_case_1.camelCase)(relation.foreignKey);
 };
 exports.getParentColumn = getParentColumn;
+const checkPrimaryKeyValueType = (model, value) => {
+    // We should check the parameter type
+    const primaryColumn = model.columns.find((column) => column.name === model.instance.primaryKey);
+    if ((primaryColumn === null || primaryColumn === void 0 ? void 0 : primaryColumn.data_type) === "integer" && isNaN(parseInt(value))) {
+        throw new ApiError_1.default(`Unacceptable parameter: ${value}`);
+    }
+};
+exports.checkPrimaryKeyValueType = checkPrimaryKeyValueType;
 const addForeignKeyQuery = (request, query, relation, parentModel) => {
     if (relation && parentModel) {
         const parentColumn = (0, exports.getParentColumn)(relation);

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

@@ -0,0 +1,3 @@
+import { Request, Response } from "express";
+declare const _default: (req: Request, res: Response) => Promise<void>;
+export default _default;

package/build/src/Handlers/PatchHandler.js

@@ -16,6 +16,7 @@ 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);
@@ -24,11 +25,13 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     // If there is a deletedAtColumn, it means that this table support soft-delete
     (0, Helpers_1.addSoftDeleteQuery)(model, null, query);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeUpdateQuery, Object.assign(Object.assign({}, pack), { query }));
-    let item = yield query
-        .where(model.instance.primaryKey, req.params[model.instance.primaryKey])
-        .first();
+    // We should check the parameter type
+    const value = req.params[model.instance.primaryKey];
+    (0, Helpers_1.checkPrimaryKeyValueType)(model, value);
+    // 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}.`);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterUpdateQuery, Object.assign(Object.assign({}, pack), { item,
         query }));

package/build/src/Handlers/ShowHandler.js

@@ -16,6 +16,7 @@ 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);
@@ -29,15 +30,18 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     queryParser.applyFields(query, conditions.fields);
     // If there is a relation, we should bind it
     (0, Helpers_1.addForeignKeyQuery)(req, query, relation, parentModel);
-    // We should add this condition in here because of performance.
-    query.where(model.instance.primaryKey, req.params[model.instance.primaryKey]);
+    // We should check the parameter type
+    const value = req.params[model.instance.primaryKey];
+    (0, Helpers_1.checkPrimaryKeyValueType)(model, value);
+    // Adding the main query
+    query.where(model.instance.primaryKey, value);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeShow, Object.assign(Object.assign({}, pack), { query,
         conditions }));
     // Users should be able to filter records
     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}.`);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.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/UpdateHandler.js

@@ -16,6 +16,7 @@ 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);
@@ -24,11 +25,13 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     // If there is a deletedAtColumn, it means that this table support soft-delete
     (0, Helpers_1.addSoftDeleteQuery)(model, null, query);
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onBeforeUpdateQuery, Object.assign(Object.assign({}, pack), { query }));
-    let item = yield query
-        .where(model.instance.primaryKey, req.params[model.instance.primaryKey])
-        .first();
+    // We should check the parameter type
+    const value = req.params[model.instance.primaryKey];
+    (0, Helpers_1.checkPrimaryKeyValueType)(model, value);
+    // 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}.`);
+        throw new ApiError_1.default(`The item is not found on ${model.name}.`, Enums_2.StatusCodes.NOT_FOUND);
     }
     yield (0, Helpers_1.callHooks)(model, Enums_1.HookFunctionTypes.onAfterUpdateQuery, Object.assign(Object.assign({}, pack), { item,
         query }));

package/build/src/Interfaces.d.ts

@@ -145,13 +145,19 @@ export interface IRequestPack {
     database: Knex | Knex.Transaction;
 }
 export interface IRouteDocumentation {
+    version: string;
+    handler: string;
     model: string;
     table: string;
     columns: IColumn[];
+    hiddens: string[];
+    relations: IRelation[];
     method: HttpMethods;
     url: string;
     fillables: string[];
     validations: Record<string, string> | null;
+    queryLimits: IQueryLimitConfig[];
+    queryDefaults: IQueryDefaultConfig;
 }
 export interface IRawQuery {
     q: string | null;

package/build/src/Server.js

@@ -44,7 +44,8 @@ const knex_schema_inspector_1 = __importDefault(require("knex-schema-inspector")
 const knex_paginate_1 = require("knex-paginate");
 const Builders_1 = require("./Builders");
 const Services_1 = require("./Services");
-const DocsHandler_1 = __importDefault(require("./Handlers/DocsHandler"));
+const MetadataHandler_1 = __importDefault(require("./Handlers/MetadataHandler"));
+const DocsHTMLHandler_1 = __importDefault(require("./Handlers/DocsHTMLHandler"));
 const RoutesHandler_1 = __importDefault(require("./Handlers/RoutesHandler"));
 const Helpers_1 = require("./Helpers");
 class Server {
@@ -118,7 +119,8 @@ class Server {
             const logger = Services_1.LogService.getInstance();
             const api = Services_1.APIService.getInstance();
             if (api.config.env === "development") {
-                app.get("/docs", DocsHandler_1.default);
+                app.get("/metadata", MetadataHandler_1.default);
+                app.get("/docs", DocsHTMLHandler_1.default);
                 app.get("/routes", RoutesHandler_1.default);
             }
             app.listen(api.config.port, () => {

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

@@ -1,11 +1,11 @@
-import { IModelService, IRouteDocumentation } from "../Interfaces";
-import { HttpMethods } from "../Enums";
+import { IModelService, IRouteDocumentation, IVersion } from "../Interfaces";
+import { HandlerTypes, HttpMethods } from "../Enums";
 declare class DocumentationService {
     private static instance;
     private routes;
     constructor();
     static getInstance(): DocumentationService;
-    push(method: HttpMethods, url: string, model: IModelService): void;
+    push(version: IVersion, handler: HandlerTypes, method: HttpMethods, url: string, model: IModelService): void;
     get(): IRouteDocumentation[];
 }
 export default DocumentationService;

package/build/src/Services/DocumentationService.js

@@ -10,15 +10,22 @@ class DocumentationService {
         }
         return DocumentationService.instance;
     }
-    push(method, url, model) {
+    push(version, handler, method, url, model) {
+        var _a, _b;
         this.routes.push({
+            version: version.name,
+            handler,
             model: model.name,
             table: model.instance.table,
             columns: model.columns,
+            hiddens: model.instance.hiddens,
+            relations: model.relations,
             method,
             url,
             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) || {},
         });
     }
     get() {

package/build/src/Services/QueryService.js

@@ -205,7 +205,7 @@ class QueryService {
         return value;
     }
     parsePerPage(content) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const value = parseInt(content ||
             ((_b = (_a = this.config.query) === null || _a === void 0 ? void 0 : _a.defaults) === null || _b === void 0 ? void 0 : _b.perPage) ||
             ((_c = constants_1.DEFAULT_VERSION_CONFIG.query.defaults) === null || _c === void 0 ? void 0 : _c.perPage) ||
@@ -216,10 +216,8 @@ class QueryService {
         const maxPerPage = ((_h = (_g = this.config.query) === null || _g === void 0 ? void 0 : _g.defaults) === null || _h === void 0 ? void 0 : _h.maxPerPage) ||
             ((_j = constants_1.DEFAULT_VERSION_CONFIG.query.defaults) === null || _j === void 0 ? void 0 : _j.maxPerPage) ||
             100;
-        if (isNaN(value) || value <= minPerPage || value > maxPerPage) {
-            return (((_l = (_k = this.config.query) === null || _k === void 0 ? void 0 : _k.defaults) === null || _l === void 0 ? void 0 : _l.perPage) ||
-                ((_m = constants_1.DEFAULT_VERSION_CONFIG.query.defaults) === null || _m === void 0 ? void 0 : _m.perPage) ||
-                10);
+        if (isNaN(value) || value < minPerPage || value > maxPerPage) {
+            throw new ApiError_1.default(`Unacceptable 'per_page' value! Current value is '${value}'. It should be between ${minPerPage}-${maxPerPage}`);
         }
         return value;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.30.3",
+  "version": "0.31.1",
   "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",