axe-api 0.20.3 → 0.21.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release Notes
 
+## [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

package/build/src/Builders/RouterBuilder.js

@@ -19,6 +19,7 @@ const Resolvers_1 = require("../Resolvers");
 const constants_1 = require("../constants");
 const Enums_1 = require("../Enums");
 const Services_1 = require("../Services");
+const Middlewares_1 = require("../Middlewares");
 class RouterBuilder {
     constructor() {
         this.getPrimaryKeyName = (model) => {
@@ -52,10 +53,10 @@ class RouterBuilder {
                 generalHooks.onBeforeInit(app);
             }
             yield this.createRoutesByModelTree(modelTree, modelList);
+            logger.info("Express routes have been created.");
             if (generalHooks.onAfterInit) {
                 generalHooks.onAfterInit(app);
             }
-            logger.info("Express routes have been created.");
         });
     }
     createRoutesByModelTree(modelTree, modelList) {
@@ -79,8 +80,13 @@ class RouterBuilder {
                 }
                 const urlCreator = constants_1.API_ROUTE_TEMPLATES[handlerType];
                 const url = urlCreator(yield this.getRootPrefix(), urlPrefix, resource, model.instance.primaryKey);
-                // Detecting filters
-                const middlewares = model.instance.getMiddlewares(handlerType);
+                // Creating the middleware list for the route. As default, we support some
+                // internal middlewares such as `Accept Language Middleware` which parse
+                // the "accept-language" header to use in the application general.
+                const middlewares = [
+                    Middlewares_1.acceptLanguageMiddleware,
+                    ...model.instance.getMiddlewares(handlerType),
+                ];
                 // Adding the route to the express
                 yield this.addExpressRoute(handlerType, url, middlewares, model, parentModel, relation);
             }
@@ -204,10 +210,13 @@ class RouterBuilder {
                 });
                 break;
             default:
-                res.status(http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR).json({
-                    error: "An error occurred.",
-                });
-                break;
+                // We should not show the real errors on production
+                if (process.env.NODE_ENV === "production") {
+                    res.status(http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR).json({
+                        error: "An error occurredxx.",
+                    });
+                }
+                throw error;
         }
     }
     getResourcePath(model, relation) {

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

package/build/src/Handlers/PatchHandler.js

@@ -35,6 +35,9 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const formData = Object.assign(Object.assign({}, item), (0, Helpers_1.getMergedFormData)(req, fillables));
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
+        // The validation language should be set
+        validatorjs_1.default.useLang(req.currentLanguage.language);
+        // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {
             return res.status(400).json(validation.errors);

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

package/build/src/Handlers/StoreHandler.js

@@ -22,6 +22,9 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const formData = (0, Helpers_1.getMergedFormData)(req, fillables);
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
+        // The validation language should be set
+        validatorjs_1.default.useLang(req.currentLanguage.language);
+        // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {
             return res.status(400).json(validation.errors);

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

@@ -1,4 +1,3 @@
-/// <reference types="express" />
 import { IRequestPack } from "../Interfaces";
 declare const _default: (pack: IRequestPack) => Promise<import("express").Response<any, Record<string, any>>>;
 export default _default;

package/build/src/Handlers/UpdateHandler.js

@@ -35,6 +35,9 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const formData = (0, Helpers_1.getMergedFormData)(req, fillables);
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
+        // The validation language should be set
+        validatorjs_1.default.useLang(req.currentLanguage.language);
+        // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {
             return res.status(400).json(validation.errors);

package/build/src/Interfaces.d.ts

@@ -23,6 +23,17 @@ export interface IApplicationConfig extends IConfig {
     prefix: string;
     transaction: boolean | IHandlerBasedTransactionConfig | IHandlerBasedTransactionConfig[];
     serializers: ((data: any, request: Request) => void)[] | IHandlerBasedSerializer[];
+    supportedLanguages: string[];
+    defaultLanguage: string;
+}
+export interface ILanguage {
+    title: string;
+    language: string;
+    region?: string | null;
+}
+export interface IAcceptedLanguage {
+    language: ILanguage;
+    quality: number;
 }
 export declare type IDatabaseConfig = Knex.Config;
 export interface IFolders {

package/build/src/Middlewares/acceptLanguageMiddleware.d.ts

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

package/build/src/Middlewares/acceptLanguageMiddleware.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 Services_1 = require("../Services");
+const Resolvers_1 = require("../Resolvers");
+exports.default = (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    // Application configuration is need for the default setting.
+    const configs = yield Services_1.IoCService.use("Config");
+    const application = configs.Application;
+    const { supportedLanguages, defaultLanguage } = application;
+    // Setting the current language by the supported, default and the client prefences
+    req.currentLanguage = Resolvers_1.AcceptLanguageResolver.resolve(req.get("accept-language") || "", supportedLanguages || ["en"], defaultLanguage || "en");
+    // Adding the `Content-Language` header to the response object
+    res.setHeader("Content-Language", req.currentLanguage.title);
+    next();
+});

package/build/src/Middlewares/index.d.ts

@@ -0,0 +1,2 @@
+import acceptLanguageMiddleware from "./acceptLanguageMiddleware";
+export { acceptLanguageMiddleware };

package/build/src/Middlewares/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acceptLanguageMiddleware = void 0;
+const acceptLanguageMiddleware_1 = __importDefault(require("./acceptLanguageMiddleware"));
+exports.acceptLanguageMiddleware = acceptLanguageMiddleware_1.default;

package/build/src/Resolvers/AcceptLanguageResolver.d.ts

@@ -0,0 +1,7 @@
+import { ILanguage } from "../Interfaces";
+declare class AcceptLanguageResolver {
+    static resolve(value: string, supportedLanguages: string[], defaultLanguage: string): ILanguage;
+    static toLanguageObject(key?: string): ILanguage;
+    private static toSortedPreferences;
+}
+export default AcceptLanguageResolver;

package/build/src/Resolvers/AcceptLanguageResolver.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AcceptLanguageResolver {
+    static resolve(value, supportedLanguages, defaultLanguage) {
+        value = value.trim();
+        if (value === "*") {
+            return this.toLanguageObject(defaultLanguage);
+        }
+        const languages = this.toSortedPreferences(value);
+        const perfectMatch = languages.find((item) => supportedLanguages.includes(item.language.title));
+        const anyMatch = languages.find((item) => supportedLanguages.includes(item.language.language));
+        if (perfectMatch && !anyMatch) {
+            return perfectMatch.language;
+        }
+        if (!perfectMatch && anyMatch) {
+            return anyMatch.language;
+        }
+        if (perfectMatch && anyMatch) {
+            if (perfectMatch.quality >= anyMatch.quality) {
+                return perfectMatch.language;
+            }
+            else {
+                return this.toLanguageObject(anyMatch.language.language);
+            }
+        }
+        return this.toLanguageObject(defaultLanguage);
+    }
+    static toLanguageObject(key = "") {
+        const [language, region] = key.split("-");
+        return {
+            title: key,
+            language,
+            region: region || null,
+        };
+    }
+    static toSortedPreferences(value) {
+        // Splitting by language definitons
+        const keys = value.split(",").map((key) => key.trim());
+        const languages = [];
+        for (const key of keys) {
+            // Splitting by the quality values
+            const [code, quality] = key.split(";");
+            // Parsing the language code and the quality value
+            const item = {
+                language: this.toLanguageObject(code),
+                quality: quality ? parseFloat(quality.replace("q=", "")) : 1,
+            };
+            languages.push(item);
+        }
+        // Sorting ASC
+        languages.sort((a, b) => {
+            if (a.quality === b.quality) {
+                return 0;
+            }
+            if (a.quality === null) {
+                return 1;
+            }
+            if (b.quality === null) {
+                return -1;
+            }
+            return a.quality < b.quality ? 1 : -1;
+        });
+        return languages;
+    }
+}
+exports.default = AcceptLanguageResolver;

package/build/src/Resolvers/index.d.ts

@@ -1,7 +1,8 @@
+import AcceptLanguageResolver from "./AcceptLanguageResolver";
 import FileResolver from "./FileResolver";
 import FolderResolver from "./FolderResolver";
 import GeneralHookResolver from "./GeneralHookResolver";
 import ModelResolver from "./ModelResolver";
 import TransactionResolver from "./TransactionResolver";
 import WithQueryResolver from "./WithQueryResolver";
-export { FileResolver, FolderResolver, GeneralHookResolver, ModelResolver, TransactionResolver, WithQueryResolver, };
+export { AcceptLanguageResolver, FileResolver, FolderResolver, GeneralHookResolver, ModelResolver, TransactionResolver, WithQueryResolver, };

package/build/src/Resolvers/index.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WithQueryResolver = exports.TransactionResolver = exports.ModelResolver = exports.GeneralHookResolver = exports.FolderResolver = exports.FileResolver = void 0;
+exports.WithQueryResolver = exports.TransactionResolver = exports.ModelResolver = exports.GeneralHookResolver = exports.FolderResolver = exports.FileResolver = exports.AcceptLanguageResolver = void 0;
+const AcceptLanguageResolver_1 = __importDefault(require("./AcceptLanguageResolver"));
+exports.AcceptLanguageResolver = AcceptLanguageResolver_1.default;
 const FileResolver_1 = __importDefault(require("./FileResolver"));
 exports.FileResolver = FileResolver_1.default;
 const FolderResolver_1 = __importDefault(require("./FolderResolver"));

package/build/src/Services/QueryService.js

@@ -346,7 +346,17 @@ class QueryService {
             if (!relation) {
                 throw new ApiError_1.default(`Undefined relation: ${item.relationship}`);
             }
-            this.relationColumns.push(`${this.model.instance.table}.${relation.foreignKey}`);
+            // We should add the field by the relation type. Otherwise it can cause
+            // an error something like this; `users.user_id`. Foreign and primary keys
+            // are relative.
+            let columnName = "";
+            if (relation.type === Enums_1.Relationships.HAS_MANY) {
+                columnName = relation.primaryKey;
+            }
+            else {
+                columnName = relation.foreignKey;
+            }
+            this.relationColumns.push(`${this.model.instance.table}.${columnName}`);
         });
     }
     getConditionMethodName(ruleSet) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.20.3",
+  "version": "0.21.0",
   "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",
@@ -15,15 +15,18 @@
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc -w",
-    "dev": "ts-node-dev --respawn --clear index.ts",
+    "dev": "ts-node-dev --files --respawn --clear index.ts",
+    "dev-kit": "ts-node-dev --respawn --clear dev-kit.ts",
+    "dev-kit:install": "sh ./scripts/dev-kit-install.sh",
+    "dev-kit:remove": "sh ./scripts/dev-kit-remove.sh",
     "test": "jest --runInBand",
     "test:dev": "jest --watch",
     "lint": "eslint src/**",
     "lint:watch": "esw --watch --color",
     "prepare:integration": "nodemon --ignore \"./tests/**\" ./scripts/run-integration-test.js",
-    "test:integration:mysql8": "cd ./tests/integrations && node index.js mysql8",
-    "test:integration:mysql57": "cd ./tests/integrations && node index.js mysql57",
-    "test:integration:postgres": "cd ./tests/integrations && node index.js postgres"
+    "test:postgres": "sh ./scripts/test-postgres.sh",
+    "test:mysql57": "sh ./scripts/test-mysql57.sh",
+    "test:mysql8": "sh ./scripts/test-mysql8.sh"
   },
   "dependencies": {
     "@types/express": "^4.17.15",
@@ -41,6 +44,7 @@
     "@babel/core": "^7.19.1",
     "@babel/preset-env": "^7.19.1",
     "@babel/preset-typescript": "^7.18.6",
+    "@types/accept-language-parser": "^1.5.3",
     "@types/pluralize": "^0.0.29",
     "@types/validatorjs": "^3.15.0",
     "@typescript-eslint/eslint-plugin": "^5.37.0",
@@ -56,6 +60,7 @@
     "glob": "^8.0.3",
     "jest": "^29.0.3",
     "mysql": "^2.18.1",
+    "node-color-log": "^10.0.2",
     "nodemon": "^2.0.15",
     "pg": "^8.7.1",
     "set-value": ">=4.1.0",

package/readme.md

@@ -1,7 +1,7 @@
 <h1 align="center">
   <br>
-  <a href="https://axe-api.github.io/">
-    <img src="https://axe-api.github.io/axe.png" alt="Markdownify" width="200">
+  <a href="https://axe-api.com/">
+    <img src="https://axe-api.com/axe.png" alt="Markdownify" width="200">
   </a>
   <br>
   Axe API
@@ -25,7 +25,7 @@
 
 Next Generation Rest API Framework
 
-> Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
+> Axe API has great documentation. Please [check it out in here](https://axe-api.com/).
 
 ## What Is Axe API?
 
@@ -143,7 +143,7 @@ If you can see that response, it means that your project is running properly.
 
 ## Documentation
 
-Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
+Axe API has great documentation. Please [check it out in here](https://axe-api.com/).
 
 ## How To Run Integration Tests