@midwayjs/i18n 4.0.0-alpha.1 → 4.0.0-beta.10

package/README.md

@@ -172,4 +172,4 @@ In the egg/koa/express/faas, current locale will be obtained based on query, hea
 
 ## License
 
-[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT](https://github.com/midwayjs/midway/blob/master/LICENSE)

package/dist/config/config.default.js

@@ -21,5 +21,6 @@ exports.i18n = {
         },
     },
     localsField: 'i18n',
+    missingKeyHandler: message => message,
 };
 //# sourceMappingURL=config.default.js.map

package/dist/configuration.js

@@ -14,6 +14,7 @@ const core_1 = require("@midwayjs/core");
 const DefaultConfig = require("./config/config.default");
 const middleware_1 = require("./middleware");
 let I18nConfiguration = class I18nConfiguration {
+    applicationManager;
     async onReady() {
         this.applicationManager
             .getApplications(['koa', 'egg', 'faas', 'express'])

package/dist/i18nService.d.ts

@@ -3,6 +3,7 @@ import { TranslateOptions } from './interface';
 export declare class MidwayI18nServiceSingleton {
     private i18nConfig;
     private localeTextMap;
+    private localeJSONMap;
     private defaultLocale;
     private fallbackMatch;
     private localeMatchCache;
@@ -35,7 +36,17 @@ export declare class MidwayI18nServiceSingleton {
      * @param locale
      * @param group
      */
-    getLocaleMapping(locale: string, group?: string): any;
+    getLocaleMapping(locale: string, group?: string): Map<string, any> | undefined;
+    /**
+     * get locale list by group
+     * @since 4.0.0
+     */
+    getLocaleList(group?: string): any[];
+    /**
+     * get origin locale json
+     * @since 4.0.0
+     */
+    getOriginLocaleJSON(locale: string, group?: string): any;
     /**
      * get current default language
      */
@@ -57,7 +68,7 @@ export declare class MidwayI18nService {
      * @param locale
      * @param group
      */
-    getLocaleMapping(locale: any, group?: string): any;
+    getLocaleMapping(locale: any, group?: string): Map<string, any>;
     /**
      * get current default language
      */

package/dist/i18nService.js

@@ -15,11 +15,12 @@ const interface_1 = require("./interface");
 const pm = require("picomatch");
 const utils_1 = require("./utils");
 let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
-    constructor() {
-        this.localeTextMap = new Map();
-        this.fallbackMatch = [];
-        this.localeMatchCache = {};
-    }
+    i18nConfig;
+    localeTextMap = new Map();
+    localeJSONMap = new Map();
+    defaultLocale;
+    fallbackMatch = [];
+    localeMatchCache = {};
     async init() {
         this.defaultLocale = (0, utils_1.formatLocale)(this.i18nConfig.defaultLocale);
         for (const lang in this.i18nConfig.localeTable) {
@@ -39,7 +40,9 @@ let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
      * @param localeTextMapping
      */
     addLocale(locale, localeTextMapping) {
-        const currentLangMap = getMap(this.localeTextMap, locale, true);
+        locale = (0, utils_1.formatLocale)(locale);
+        const currentLangMap = getMap(this.localeTextMap, locale);
+        // set to text map
         for (const key in localeTextMapping) {
             if (typeof localeTextMapping[key] === 'string') {
                 // set to default
@@ -52,6 +55,8 @@ let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
                 }
             }
         }
+        // set to origin json map
+        this.localeJSONMap.set(locale, localeTextMapping);
     }
     /**
      * translate a message
@@ -78,6 +83,10 @@ let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
                 msg = this.getLocaleMappingText(this.defaultLocale, message, group, args);
             }
         }
+        // If still no message found, use missingKeyHandler
+        if (!msg && this.i18nConfig.missingKeyHandler) {
+            msg = this.i18nConfig.missingKeyHandler(message, options);
+        }
         return msg;
     }
     /**
@@ -143,10 +152,31 @@ let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
     getLocaleMapping(locale, group = 'default') {
         locale = (0, utils_1.formatLocale)(locale);
         const langMap = this.localeTextMap.get(locale);
-        if (langMap) {
+        if (langMap && langMap.size > 0) {
             return langMap.get(group);
         }
     }
+    /**
+     * get locale list by group
+     * @since 4.0.0
+     */
+    getLocaleList(group = 'default') {
+        const list = [];
+        for (const key of this.localeTextMap.keys()) {
+            if (this.localeTextMap.get(key).has(group)) {
+                list.push(key);
+            }
+        }
+        return list;
+    }
+    /**
+     * get origin locale json
+     * @since 4.0.0
+     */
+    getOriginLocaleJSON(locale, group = 'default') {
+        locale = (0, utils_1.formatLocale)(locale);
+        return this.localeJSONMap.get(locale)?.[group];
+    }
     /**
      * get current default language
      */
@@ -182,6 +212,8 @@ exports.MidwayI18nServiceSingleton = MidwayI18nServiceSingleton = __decorate([
     (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
 ], MidwayI18nServiceSingleton);
 let MidwayI18nService = class MidwayI18nService {
+    i18nServiceSingleton;
+    ctx;
     translate(message, options = {}) {
         if (!options.locale) {
             options.locale = this.ctx.getAttr && this.ctx.getAttr(interface_1.I18N_ATTR_KEY);
@@ -265,8 +297,7 @@ function getES6Object(o) {
     }
     return o;
 }
-function getMap(o, key, formatKey = false) {
-    key = formatKey ? (0, utils_1.formatLocale)(key) : key;
+function getMap(o, key) {
     if (!o.has(key)) {
         o.set(key, new Map());
     }

package/dist/interface.d.ts

@@ -18,6 +18,7 @@ export interface I18nOptions {
     writeCookie: boolean;
     resolver: RequestResolver | false;
     localsField: string;
+    missingKeyHandler?: (message: string, options?: TranslateOptions) => string;
 }
 export declare const I18N_ATTR_KEY = "i18n:locale";
 //# sourceMappingURL=interface.d.ts.map

package/dist/middleware.js

@@ -15,6 +15,8 @@ const interface_1 = require("./interface");
 const i18nService_1 = require("./i18nService");
 const utils_1 = require("./utils");
 let I18nFilter = class I18nFilter {
+    resolverConfig;
+    i18nConfig;
     match(value, req, res) {
         const saveLocale = req.getAttr(interface_1.I18N_ATTR_KEY);
         if (this.resolverConfig) {
@@ -47,6 +49,8 @@ exports.I18nFilter = I18nFilter = __decorate([
     (0, core_1.Match)()
 ], I18nFilter);
 let I18nMiddleware = class I18nMiddleware {
+    resolverConfig;
+    i18nConfig;
     resolve(app) {
         if ('express' === app.getNamespace()) {
             // add a filter for i18n cookie

package/dist/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatLocale = exports.formatWithObject = exports.formatWithArray = void 0;
+exports.formatWithArray = formatWithArray;
+exports.formatWithObject = formatWithObject;
+exports.formatLocale = formatLocale;
 const ARRAY_INDEX_RE = /\{(\d+)\}/g;
 function formatWithArray(text, values) {
     return text.replace(ARRAY_INDEX_RE, (original, matched) => {
@@ -12,7 +14,6 @@ function formatWithArray(text, values) {
         return original;
     });
 }
-exports.formatWithArray = formatWithArray;
 const Object_INDEX_RE = /\{(.+?)\}/g;
 function formatWithObject(text, values) {
     return text.replace(Object_INDEX_RE, (original, matched) => {
@@ -24,10 +25,10 @@ function formatWithObject(text, values) {
         return original;
     });
 }
-exports.formatWithObject = formatWithObject;
 function formatLocale(locale) {
-    // support zh_CN, en_US => zh-CN, en-US
+    if (!locale)
+        return locale;
+    // support zh_CN, en_US => zh-cn, en-us
     return locale.replace('_', '-').toLowerCase();
 }
-exports.formatLocale = formatLocale;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/i18n",
   "description": "midway i18n component",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.10",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -13,10 +13,10 @@
     "picomatch": "2.3.1"
   },
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/express": "^4.0.0-alpha.1",
-    "@midwayjs/koa": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1"
+    "@midwayjs/core": "^4.0.0-beta.10",
+    "@midwayjs/express": "^4.0.0-beta.10",
+    "@midwayjs/koa": "^4.0.0-beta.10",
+    "@midwayjs/mock": "^4.0.0-beta.10"
   },
   "keywords": [
     "midway",
@@ -32,11 +32,11 @@
     "lint": "mwts check"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "1b1856629913703f67304155aaf611ec936a81ac"
 }