axe-api 0.20.4 → 0.21.0

package/CHANGELOG.md

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

package/build/src/Handlers/PatchHandler.js

@@ -36,7 +36,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
         // The validation language should be set
-        validatorjs_1.default.useLang(req.language);
+        validatorjs_1.default.useLang(req.currentLanguage.language);
         // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {

package/build/src/Handlers/StoreHandler.js

@@ -23,7 +23,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
         // The validation language should be set
-        validatorjs_1.default.useLang(req.language);
+        validatorjs_1.default.useLang(req.currentLanguage.language);
         // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {

package/build/src/Handlers/UpdateHandler.js

@@ -36,7 +36,7 @@ exports.default = (pack) => __awaiter(void 0, void 0, void 0, function* () {
     const validationRules = model.instance.getValidationRules(requestMethod);
     if (validationRules) {
         // The validation language should be set
-        validatorjs_1.default.useLang(req.language);
+        validatorjs_1.default.useLang(req.currentLanguage.language);
         // Validate the data
         const validation = new validatorjs_1.default(formData, validationRules);
         if (validation.fails()) {

package/build/src/Interfaces.d.ts

@@ -23,8 +23,18 @@ 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 {
     App: string;

package/build/src/Middlewares/acceptLanguageMiddleware.js

@@ -8,26 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const accept_language_parser_1 = __importDefault(require("accept-language-parser"));
 const Services_1 = require("../Services");
+const Resolvers_1 = require("../Resolvers");
 exports.default = (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
     // Application configuration is need for the default setting.
     const configs = yield Services_1.IoCService.use("Config");
     const application = configs.Application;
-    const { defaultLanguage } = application;
-    // Parsing the `accept-language` value
-    req.acceptedLanguages = accept_language_parser_1.default.parse(req.headers["accept-language"] || defaultLanguage);
-    // Getting the current language by the accept-langauge and the default language
-    // value. This values can be used anywhere in the API because the values would
-    // be carried by Express.Request
-    req.language =
-        req.acceptedLanguages.length > 0
-            ? ((_a = req.acceptedLanguages.at(0)) === null || _a === void 0 ? void 0 : _a.code) || defaultLanguage
-            : defaultLanguage;
+    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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.20.4",
+  "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",
@@ -30,7 +30,6 @@
   },
   "dependencies": {
     "@types/express": "^4.17.15",
-    "accept-language-parser": "^1.5.0",
     "change-case": "^4.1.2",
     "dotenv": "^14.2.0",
     "express": "^4.18.2",