axe-api 0.31.0 → 0.31.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release Notes
 
+## [0.31.2 (2023-07-04)](https://github.com/axe-api/axe-api/compare/0.31.2...0.31.1)
+
+### Fixed
+
+- Fixed many internal issues. [#219](https://github.com/axe-api/axe-api/issues/219), [#174](https://github.com/axe-api/axe-api/issues/174), [#183](https://github.com/axe-api/axe-api/issues/183), [#149](https://github.com/axe-api/axe-api/issues/149), [#186](https://github.com/axe-api/axe-api/issues/186)
+
+## [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

package/build/src/Builders/RouterBuilder.js

@@ -125,11 +125,15 @@ 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).catch((error) => {
-                    this.sendErrorAsResponse(res, error);
-                });
-            };
+            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);
@@ -215,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,6 +15,7 @@ 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
@@ -31,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/ForceDestroyHandler.js

@@ -15,6 +15,7 @@ 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
@@ -26,7 +27,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.");
+        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/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);
@@ -30,7 +31,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}.`);
+        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);
@@ -40,7 +41,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}.`);
+        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);
@@ -30,7 +31,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}.`);
+        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/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/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.0",
+  "version": "0.31.2",
   "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

@@ -134,8 +134,7 @@ You will see the following API response if you visit [localhost:3000](http://loc
 ```json
 {
   "name": "AXE API",
-  "description": "The best API creation tool in the world.",
-  "aim": "To kill them all!"
+  "description": "The best API creation tool in the world."
 }
 ```
 
@@ -145,6 +144,17 @@ If you can see that response, it means that your project is running properly.
 
 Axe API has great documentation. Please [check it out in here](https://axe-api.com/).
 
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
 ## License
 
 [MIT License](LICENSE)