@midwayjs/i18n 3.0.0-beta.7 → 3.0.1

package/README.md

@@ -1,9 +1,175 @@
-# midwayjs i18n Component
+# midway i18n Component
 
-Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
+## Install
+
+```bash
+$ npm i @midwayjs/i18n --save
+```
 
 ## Usage
 
+add component in your configuration.
+
+```ts
+import * as koa from '@midwayjs/koa';
+import * as i18n from '@midwayjs/i18n';
+
+@Configuratino({
+  imports: [
+    koa,
+    i18n
+  ]
+})
+```
+
+You can use `translate` method to translate your message.
+
+```ts
+@Controller('/')
+export class UserController {
+
+  @Inject()
+  i18nService: MidwayI18nService;
+
+  @Get('/')
+  async index(@Query('username') username: string) {
+    return this.i18nService.translate('HELLO_MESSAGE', {
+      args: {
+        username
+      },
+    });
+  }
+}
+
+```
+
+## Default Config
+
+```ts
+// config/config.default.js
+export const i18n = {
+  // default locale  "en_US"
+  defaultLocale: 'en_US',
+
+  // your can put your translate message here
+  localeTable: {
+    en_US: {
+      // group name
+      default: {
+        // hello: 'hello'
+      }
+    },
+    zh_CN: {
+      // group name
+      default: {
+        // hello: '你好'
+      }
+    },
+    fallbacks: {
+      //   'en_*': 'en_US',
+      //   pt: 'pt-BR',
+    },
+    writeCookie: true,
+    resolver: {
+      // URL parameter，default is "locale"
+      queryField: 'locale',
+      // Header key, default is "locale"
+      headerField: 'locale',
+      cookieField: {
+        fieldName: 'locale',
+        // Cookie domain，default is empty，valid in current domain
+        cookieDomain: '',
+        // Default validity period, one year.
+        cookieMaxAge: FORMAT.MS.ONE_YEAR,
+      },
+    },
+  },
+};
+```
+
+## Message Format
+
+Support Object and Array.
+
+**Object**
+
+```ts
+this.i18nService.translate('HELLO_MESSAGE {username}', {
+  args: {
+    username
+  },
+});
+```
+
+**Array**
+
+```ts
+this.i18nService.translate('HELLO_MESSAGE {0} {1}', {
+  args: ['harry', 'chen'],
+});
+```
+
+## Web locale Setting
+
+In the egg/koa/express/faas, current locale will be obtained based on query, header, and cookie.
+
+
+## Locale Text
+
+| locale             | locale Text |
+| :--------------- | :------- |
+| 阿拉伯           | ar_EG    |
+| 亞美尼亞         | hy_AM    |
+| 保加利亚语       | bg_BG    |
+| 加泰罗尼亚语     | ca_ES    |
+| 捷克语           | cs_CZ    |
+| 丹麦语           | da_DK    |
+| 德语             | de_DE    |
+| 希腊语           | el_GR    |
+| 英语             | en_GB    |
+| 英语（美式）     | en_US    |
+| 西班牙语         | es_ES    |
+| 爱沙尼亚语       | et_EE    |
+| 波斯语           | fa_IR    |
+| 芬兰语           | fi_FI    |
+| 法语（比利时）   | fr_BE    |
+| 法语             | fr_FR    |
+| 希伯来语         | he_IL    |
+| 印地语           | hi_IN    |
+| 克罗地亚语       | hr_HR    |
+| 匈牙利           | hu_HU    |
+| 冰岛语           | is_IS    |
+| 印度尼西亚语     | id_ID    |
+| 意大利语         | it_IT    |
+| 日语             | ja_JP    |
+| 格鲁吉亚语       | ka_GE    |
+| 卡纳达语         | kn_IN    |
+| 韩语/朝鲜语      | ko_KR    |
+| 库尔德语         | ku_IQ    |
+| 拉脱维亚语       | lv_LV    |
+| 马来语           | ms_MY    |
+| 蒙古语           | mn_MN    |
+| 挪威             | nb_NO    |
+| 尼泊尔语         | ne_NP    |
+| 荷兰语（比利时） | nl_BE    |
+| 荷兰语           | nl_NL    |
+| 波兰语           | pl_PL    |
+| 葡萄牙语(巴西)   | pt_BR    |
+| 葡萄牙语         | pt_PT    |
+| 斯洛伐克语       | sk_SK    |
+| 塞尔维亚         | sr_RS    |
+| 斯洛文尼亚       | sl_SI    |
+| 瑞典语           | sv_SE    |
+| 泰米尔语         | ta_IN    |
+| 泰语             | th_TH    |
+| 土耳其语         | tr_TR    |
+| 罗马尼亚语       | ro_RO    |
+| 俄罗斯语         | ru_RU    |
+| 乌克兰语         | uk_UA    |
+| 越南语           | vi_VN    |
+| 简体中文         | zh_CN    |
+| 繁体中文         | zh_TW    |
+
 ## License
 
 [MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/config/config.default.d.ts

@@ -0,0 +1,3 @@
+import { I18nOptions } from '../interface';
+export declare const i18n: I18nOptions;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.i18n = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+exports.i18n = {
+    defaultLocale: 'en_US',
+    localeTable: {
+        en_US: {},
+    },
+    fallbacks: {
+    //   'en_*': 'en_US',
+    //   pt: 'pt-BR',
+    },
+    writeCookie: true,
+    resolver: {
+        queryField: 'locale',
+        cookieField: {
+            fieldName: 'locale',
+            cookieDomain: '',
+            cookieMaxAge: decorator_1.FORMAT.MS.ONE_YEAR,
+        },
+    },
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,3 +1,6 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
 export declare class I18nConfiguration {
+    applicationManager: MidwayApplicationManager;
+    onReady(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -5,12 +5,28 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18nConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const DefaultConfig = require("./config.default");
+const DefaultConfig = require("./config/config.default");
+const core_1 = require("@midwayjs/core");
+const middleware_1 = require("./middleware");
 let I18nConfiguration = class I18nConfiguration {
+    async onReady() {
+        this.applicationManager
+            .getApplications(['koa', 'egg', 'faas', 'express'])
+            .forEach(app => {
+            app.useMiddleware(middleware_1.I18nMiddleware);
+        });
+    }
 };
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], I18nConfiguration.prototype, "applicationManager", void 0);
 I18nConfiguration = __decorate([
     (0, decorator_1.Configuration)({
         namespace: 'i18n',

package/dist/i18nService.d.ts

@@ -1,10 +1,81 @@
 import { TranslateOptions } from './interface';
+import { IMidwayContext } from '@midwayjs/core';
+export declare class MidwayI18nServiceSingleton {
+    private i18nConfig;
+    private localeTextMap;
+    private defaultLocale;
+    private fallbackMatch;
+    private localeMatchCache;
+    protected init(): Promise<void>;
+    /**
+     * add a language text mapping
+     * @param locale
+     * @param localeTextMapping
+     */
+    addLocale(locale: string, localeTextMapping: Record<string, any>): void;
+    /**
+     * translate a message
+     * @param message
+     * @param options
+     */
+    translate(message: string, options?: TranslateOptions): any;
+    /**
+     * get locale string by find fallback and default, ignore match message
+     * @param locale
+     * @param group
+     */
+    getAvailableLocale(locale: string, group?: string): any;
+    /**
+     * get available local in locale text map, include fallbacks
+     * @param locale
+     */
+    hasAvailableLocale(locale: string): boolean;
+    /**
+     * get mapping by locale
+     * @param locale
+     * @param group
+     */
+    getLocaleMapping(locale: string, group?: string): any;
+    /**
+     * get current default language
+     */
+    getDefaultLocale(): string;
+    private getLocaleMappingText;
+}
 export declare class MidwayI18nService {
-    i18nConfig: any;
-    private languageTextMap;
-    private defaultLanguage;
-    init(): Promise<void>;
-    addLanguage(lang: string, langTextMapping: Record<string, string>): void;
+    protected i18nServiceSingleton: MidwayI18nServiceSingleton;
+    ctx: IMidwayContext;
     translate(message: string, options?: TranslateOptions): any;
+    /**
+     * add a language text mapping
+     * @param locale
+     * @param localeTextMapping
+     */
+    addLocale(locale: string, localeTextMapping: Record<string, any>): void;
+    /**
+     * get mapping by lang
+     * @param locale
+     * @param group
+     */
+    getLocaleMapping(locale: any, group?: string): any;
+    /**
+     * get current default language
+     */
+    getDefaultLocale(): string;
+    /**
+     * save current context lang to flag, middleware will be set it to cookie
+     */
+    saveRequestLocale(locale?: string): void;
+    /**
+     * get locale string by find fallback and default, ignore match message
+     * @param locale
+     * @param group
+     */
+    getAvailableLocale(locale: string, group?: string): any;
+    /**
+     * get available local in locale text map, include fallbacks
+     * @param locale
+     */
+    hasAvailableLocale(locale: string): boolean;
 }
 //# sourceMappingURL=i18nService.d.ts.map

package/dist/i18nService.js

@@ -9,67 +9,242 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MidwayI18nService = void 0;
+exports.MidwayI18nService = exports.MidwayI18nServiceSingleton = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const core_1 = require("@midwayjs/core");
+const interface_1 = require("./interface");
+const pm = require("picomatch");
 const utils_1 = require("./utils");
-let MidwayI18nService = class MidwayI18nService {
+let MidwayI18nServiceSingleton = class MidwayI18nServiceSingleton {
     constructor() {
-        this.languageTextMap = new Map();
+        this.localeTextMap = new Map();
+        this.fallbackMatch = [];
+        this.localeMatchCache = {};
     }
     async init() {
-        this.defaultLanguage = this.i18nConfig.defaultLanguage;
-        for (const lang in this.i18nConfig.languageTable) {
-            this.addLanguage(lang, getES6Object(this.i18nConfig.languageTable[lang]));
+        this.defaultLocale = (0, utils_1.formatLocale)(this.i18nConfig.defaultLocale);
+        for (const lang in this.i18nConfig.localeTable) {
+            this.addLocale(lang, getES6Object(this.i18nConfig.localeTable[lang]));
         }
-    }
-    addLanguage(lang, langTextMapping) {
-        if (!this.languageTextMap.has(lang)) {
-            this.languageTextMap.set(lang, {});
+        // fallbacks
+        for (const rule in this.i18nConfig.fallbacks) {
+            this.fallbackMatch.push({
+                pattern: pm((0, utils_1.formatLocale)(rule)),
+                locale: (0, utils_1.formatLocale)(this.i18nConfig.fallbacks[rule]),
+            });
         }
-        const currentMap = this.languageTextMap.get(lang);
-        for (const key in langTextMapping) {
-            currentMap[key] = langTextMapping[key];
+    }
+    /**
+     * add a language text mapping
+     * @param locale
+     * @param localeTextMapping
+     */
+    addLocale(locale, localeTextMapping) {
+        const currentLangMap = getMap(this.localeTextMap, locale);
+        for (const key in localeTextMapping) {
+            if (typeof localeTextMapping[key] === 'string') {
+                // set to default
+                getMap(currentLangMap, 'default').set(key, localeTextMapping[key]);
+            }
+            else {
+                // set to group
+                for (const newKey in localeTextMapping[key]) {
+                    getMap(currentLangMap, key).set(newKey, localeTextMapping[key][newKey]);
+                }
+            }
         }
     }
+    /**
+     * translate a message
+     * @param message
+     * @param options
+     */
     translate(message, options = {}) {
-        var _a, _b;
-        const useLang = (_a = options.lang) !== null && _a !== void 0 ? _a : this.defaultLanguage;
+        var _a, _b, _c;
+        const useLocale = (0, utils_1.formatLocale)((_a = options.locale) !== null && _a !== void 0 ? _a : this.defaultLocale);
         const args = (_b = options.args) !== null && _b !== void 0 ? _b : [];
-        const langMap = this.languageTextMap.get(useLang);
-        if (langMap) {
-            const msg = (0, core_1.safelyGet)(message, langMap);
-            if (msg) {
-                return formatText(msg, args);
+        const group = (_c = options.group) !== null && _c !== void 0 ? _c : 'default';
+        let msg = this.getLocaleMappingText(useLocale, message, group, args);
+        if (!msg && useLocale !== this.defaultLocale) {
+            if (this.fallbackMatch.length) {
+                const findRule = this.fallbackMatch.find(rule => {
+                    if (rule.pattern(useLocale)) {
+                        return true;
+                    }
+                });
+                if (findRule) {
+                    msg = this.getLocaleMappingText(findRule.locale, message, group, args);
+                }
             }
-            else {
-                // fallback
-                const fallbackLanguage = this.i18nConfig.fallbackLanguage;
-                const fallbackMap = this.languageTextMap.get(fallbackLanguage);
-                const msg = (0, core_1.safelyGet)(message, fallbackMap);
+            if (!msg) {
+                msg = this.getLocaleMappingText(this.defaultLocale, message, group, args);
+            }
+        }
+        return msg;
+    }
+    /**
+     * get locale string by find fallback and default, ignore match message
+     * @param locale
+     * @param group
+     */
+    getAvailableLocale(locale, group = 'default') {
+        locale = (0, utils_1.formatLocale)(locale);
+        if (this.localeMatchCache[locale + '_' + group]) {
+            return this.localeMatchCache[locale + '_' + group];
+        }
+        if (this.localeTextMap.has(locale) &&
+            this.localeTextMap.get(locale).has(group)) {
+            this.localeMatchCache[locale + '_' + group] = locale;
+            return locale;
+        }
+        if (this.fallbackMatch.length) {
+            const findRule = this.fallbackMatch.find(rule => {
+                if (rule.pattern(locale)) {
+                    if (this.localeTextMap.has(rule.locale) &&
+                        this.localeTextMap.get(rule.locale).has(group)) {
+                        this.localeMatchCache[locale + '_' + group] = rule.locale;
+                        return true;
+                    }
+                }
+            });
+            if (findRule) {
+                return findRule.locale;
+            }
+        }
+        this.localeMatchCache[locale + '_' + group] = this.defaultLocale;
+        return this.defaultLocale;
+    }
+    /**
+     * get available local in locale text map, include fallbacks
+     * @param locale
+     */
+    hasAvailableLocale(locale) {
+        locale = (0, utils_1.formatLocale)(locale);
+        if (this.localeTextMap.has(locale)) {
+            return true;
+        }
+        if (this.fallbackMatch.length) {
+            const findRule = this.fallbackMatch.find(rule => {
+                if (rule.pattern(locale)) {
+                    if (this.localeTextMap.has(rule.locale)) {
+                        return true;
+                    }
+                }
+            });
+            if (findRule) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * get mapping by locale
+     * @param locale
+     * @param group
+     */
+    getLocaleMapping(locale, group = 'default') {
+        locale = (0, utils_1.formatLocale)(locale);
+        const langMap = this.localeTextMap.get(locale);
+        if (langMap) {
+            return langMap.get(group);
+        }
+    }
+    /**
+     * get current default language
+     */
+    getDefaultLocale() {
+        return this.defaultLocale;
+    }
+    getLocaleMappingText(locale, message, group, args) {
+        const langMap = this.localeTextMap.get(locale);
+        if (langMap) {
+            const textMapping = langMap.get(group);
+            if (textMapping) {
+                const msg = textMapping.get(message);
                 if (msg) {
                     return formatText(msg, args);
                 }
             }
         }
-        else {
-            throw new core_1.MidwayCommonError(`Language ${useLang} mapping not found`);
-        }
     }
 };
 __decorate([
     (0, decorator_1.Config)('i18n'),
     __metadata("design:type", Object)
-], MidwayI18nService.prototype, "i18nConfig", void 0);
+], MidwayI18nServiceSingleton.prototype, "i18nConfig", void 0);
 __decorate([
     (0, decorator_1.Init)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
-], MidwayI18nService.prototype, "init", null);
-MidwayI18nService = __decorate([
+], MidwayI18nServiceSingleton.prototype, "init", null);
+MidwayI18nServiceSingleton = __decorate([
     (0, decorator_1.Provide)(),
     (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
+], MidwayI18nServiceSingleton);
+exports.MidwayI18nServiceSingleton = MidwayI18nServiceSingleton;
+let MidwayI18nService = class MidwayI18nService {
+    translate(message, options = {}) {
+        if (!options.locale) {
+            options.locale = this.ctx.getAttr && this.ctx.getAttr(interface_1.I18N_ATTR_KEY);
+        }
+        return this.i18nServiceSingleton.translate(message, options);
+    }
+    /**
+     * add a language text mapping
+     * @param locale
+     * @param localeTextMapping
+     */
+    addLocale(locale, localeTextMapping) {
+        this.i18nServiceSingleton.addLocale(locale, localeTextMapping);
+    }
+    /**
+     * get mapping by lang
+     * @param locale
+     * @param group
+     */
+    getLocaleMapping(locale, group = 'default') {
+        return this.i18nServiceSingleton.getLocaleMapping(locale, group);
+    }
+    /**
+     * get current default language
+     */
+    getDefaultLocale() {
+        return this.i18nServiceSingleton.getDefaultLocale();
+    }
+    /**
+     * save current context lang to flag, middleware will be set it to cookie
+     */
+    saveRequestLocale(locale) {
+        var _a, _b;
+        const currentLocale = (_a = locale !== null && locale !== void 0 ? locale : this.ctx.getAttr(interface_1.I18N_ATTR_KEY)) !== null && _a !== void 0 ? _a : this.getDefaultLocale();
+        (_b = this.ctx) === null || _b === void 0 ? void 0 : _b.setAttr(interface_1.I18N_SAVE_KEY, (0, utils_1.formatLocale)(currentLocale));
+    }
+    /**
+     * get locale string by find fallback and default, ignore match message
+     * @param locale
+     * @param group
+     */
+    getAvailableLocale(locale, group = 'default') {
+        return this.i18nServiceSingleton.getAvailableLocale(locale, group);
+    }
+    /**
+     * get available local in locale text map, include fallbacks
+     * @param locale
+     */
+    hasAvailableLocale(locale) {
+        return this.i18nServiceSingleton.hasAvailableLocale(locale);
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", MidwayI18nServiceSingleton)
+], MidwayI18nService.prototype, "i18nServiceSingleton", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", Object)
+], MidwayI18nService.prototype, "ctx", void 0);
+MidwayI18nService = __decorate([
+    (0, decorator_1.Provide)()
 ], MidwayI18nService);
 exports.MidwayI18nService = MidwayI18nService;
 function formatText(message, args) {
@@ -88,4 +263,11 @@ function getES6Object(o) {
     }
     return o;
 }
+function getMap(o, key) {
+    key = (0, utils_1.formatLocale)(key);
+    if (!o.has(key)) {
+        o.set(key, new Map());
+    }
+    return o.get(key);
+}
 //# sourceMappingURL=i18nService.js.map

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { I18nConfiguration as Configuration } from './configuration';
 export * from './i18nService';
+export * from './middleware';
 export * from './interface';
+export { formatLocale } from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -10,9 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
+exports.formatLocale = exports.Configuration = void 0;
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.I18nConfiguration; } });
 __exportStar(require("./i18nService"), exports);
+__exportStar(require("./middleware"), exports);
 __exportStar(require("./interface"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "formatLocale", { enumerable: true, get: function () { return utils_1.formatLocale; } });
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -1,11 +1,22 @@
-import { i18n } from './config.default';
 export interface TranslateOptions {
-    lang?: string;
+    locale?: string;
+    group?: string;
     args?: any;
 }
-declare module '@midwayjs/core/dist/interface' {
-    interface MidwayConfig {
-        i18n?: typeof i18n;
-    }
+export interface I18nOptions {
+    defaultLocale: string;
+    localeTable: Record<string, Record<string, any>>;
+    fallbacks: Record<string, any>;
+    writeCookie: boolean;
+    resolver: {
+        queryField: string;
+        cookieField: {
+            fieldName: string;
+            cookieDomain: string;
+            cookieMaxAge: number;
+        };
+    };
 }
+export declare const I18N_ATTR_KEY = "i18n:locale";
+export declare const I18N_SAVE_KEY = "i18n:need_save_locale";
 //# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,3 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.I18N_SAVE_KEY = exports.I18N_ATTR_KEY = void 0;
+exports.I18N_ATTR_KEY = 'i18n:locale';
+exports.I18N_SAVE_KEY = 'i18n:need_save_locale';
 //# sourceMappingURL=interface.js.map

package/dist/middleware.d.ts

@@ -0,0 +1,13 @@
+import { IMiddleware, IMidwayApplication } from '@midwayjs/core';
+import { I18nOptions } from './interface';
+export declare class I18nFilter {
+    resolverConfig: I18nOptions['resolver'];
+    match(value: any, req: any, res: any): any;
+}
+export declare class I18nMiddleware implements IMiddleware<any, any> {
+    resolverConfig: I18nOptions['resolver'];
+    i18nConfig: I18nOptions;
+    resolve(app: IMidwayApplication): (req: any, res: any, next: any) => Promise<any>;
+    static getName(): string;
+}
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.js

@@ -0,0 +1,156 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.I18nMiddleware = exports.I18nFilter = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const interface_1 = require("./interface");
+const i18nService_1 = require("./i18nService");
+const utils_1 = require("./utils");
+let I18nFilter = class I18nFilter {
+    match(value, req, res) {
+        const saveLocale = req.getAttr(interface_1.I18N_SAVE_KEY);
+        if (saveLocale) {
+            const cookieOptions = {
+                // make sure browser javascript can read the cookie
+                httpOnly: false,
+                maxAge: this.resolverConfig.cookieField.cookieMaxAge,
+                signed: false,
+                domain: this.resolverConfig.cookieField.cookieDomain,
+            };
+            res.cookie(this.resolverConfig.cookieField.fieldName, saveLocale, cookieOptions);
+        }
+        return value;
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('i18n.resolver'),
+    __metadata("design:type", Object)
+], I18nFilter.prototype, "resolverConfig", void 0);
+I18nFilter = __decorate([
+    (0, decorator_1.Match)()
+], I18nFilter);
+exports.I18nFilter = I18nFilter;
+let I18nMiddleware = class I18nMiddleware {
+    resolve(app) {
+        if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
+            // add a filter for i18n cookie
+            app.useFilter(I18nFilter);
+            return async (req, res, next) => {
+                // get request locale from query/header/cookie
+                let requestLocale = req.query[this.resolverConfig.queryField] ||
+                    req.cookies[this.resolverConfig.cookieField.fieldName];
+                const i18nService = await req.requestContext.getAsync(i18nService_1.MidwayI18nService);
+                if (!requestLocale) {
+                    // Accept-Language: zh-CN,zh;q=0.5
+                    // Accept-Language: zh-CN
+                    let languages = req.acceptsLanguages();
+                    if (languages) {
+                        if (Array.isArray(languages)) {
+                            if (languages[0] === '*') {
+                                languages = languages.slice(1);
+                            }
+                            if (languages.length > 0) {
+                                for (let i = 0; i < languages.length; i++) {
+                                    const lang = (0, utils_1.formatLocale)(languages[i]);
+                                    if (i18nService.hasAvailableLocale(lang)) {
+                                        requestLocale = lang;
+                                        break;
+                                    }
+                                }
+                            }
+                        }
+                        else {
+                            requestLocale = languages;
+                        }
+                    }
+                }
+                // set to current locale
+                req.setAttr(interface_1.I18N_ATTR_KEY, requestLocale);
+                // auto write locale to cookie
+                if (this.i18nConfig.writeCookie) {
+                    i18nService.saveRequestLocale(requestLocale);
+                }
+                return next();
+            };
+        }
+        else {
+            return async (ctx, next) => {
+                // get request locale from query/header/cookie
+                let requestLocale = ctx.query[this.resolverConfig.queryField] ||
+                    ctx.cookies.get(this.resolverConfig.cookieField.fieldName, {
+                        signed: false,
+                    });
+                const i18nService = await ctx.requestContext.getAsync(i18nService_1.MidwayI18nService);
+                if (!requestLocale) {
+                    // Accept-Language: zh-CN,zh;q=0.5
+                    // Accept-Language: zh-CN
+                    let languages = ctx.acceptsLanguages();
+                    if (languages) {
+                        if (Array.isArray(languages)) {
+                            if (languages[0] === '*') {
+                                languages = languages.slice(1);
+                            }
+                            if (languages.length > 0) {
+                                for (let i = 0; i < languages.length; i++) {
+                                    const lang = (0, utils_1.formatLocale)(languages[i]);
+                                    if (i18nService.hasAvailableLocale(lang)) {
+                                        requestLocale = lang;
+                                        break;
+                                    }
+                                }
+                            }
+                        }
+                        else {
+                            requestLocale = languages;
+                        }
+                    }
+                }
+                // set to current locale
+                ctx.setAttr(interface_1.I18N_ATTR_KEY, requestLocale);
+                // auto write locale to cookie
+                if (this.i18nConfig.writeCookie) {
+                    i18nService.saveRequestLocale(requestLocale);
+                }
+                // run next middleware and controller
+                await next();
+                // get need save locale
+                const saveLocale = ctx.getAttr(interface_1.I18N_SAVE_KEY);
+                if (saveLocale) {
+                    const cookieOptions = {
+                        // make sure browser javascript can read the cookie
+                        httpOnly: false,
+                        maxAge: this.resolverConfig.cookieField.cookieMaxAge,
+                        signed: false,
+                        domain: this.resolverConfig.cookieField.cookieDomain,
+                        overwrite: true,
+                    };
+                    ctx.cookies.set(this.resolverConfig.cookieField.fieldName, saveLocale, cookieOptions);
+                }
+            };
+        }
+    }
+    static getName() {
+        return 'i18n';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('i18n.resolver'),
+    __metadata("design:type", Object)
+], I18nMiddleware.prototype, "resolverConfig", void 0);
+__decorate([
+    (0, decorator_1.Config)('i18n'),
+    __metadata("design:type", Object)
+], I18nMiddleware.prototype, "i18nConfig", void 0);
+I18nMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], I18nMiddleware);
+exports.I18nMiddleware = I18nMiddleware;
+//# sourceMappingURL=middleware.js.map

package/dist/utils.d.ts

@@ -1,3 +1,4 @@
 export declare function formatWithArray(text: any, values: any): any;
 export declare function formatWithObject(text: any, values: any): any;
+export declare function formatLocale(locale: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -1,28 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatWithObject = exports.formatWithArray = void 0;
+exports.formatLocale = exports.formatWithObject = exports.formatWithArray = void 0;
 const ARRAY_INDEX_RE = /\{(\d+)\}/g;
 function formatWithArray(text, values) {
-    return text.replace(ARRAY_INDEX_RE, (orignal, matched) => {
+    return text.replace(ARRAY_INDEX_RE, (original, matched) => {
         const index = parseInt(matched);
         if (index < values.length) {
             return values[index];
         }
         // not match index, return original text
-        return orignal;
+        return original;
     });
 }
 exports.formatWithArray = formatWithArray;
 const Object_INDEX_RE = /\{(.+?)\}/g;
 function formatWithObject(text, values) {
-    return text.replace(Object_INDEX_RE, (orignal, matched) => {
+    return text.replace(Object_INDEX_RE, (original, matched) => {
         const value = values[matched];
         if (value) {
             return value;
         }
         // not match index, return original text
-        return orignal;
+        return original;
     });
 }
 exports.formatWithObject = formatWithObject;
+function formatLocale(locale) {
+    // support zh_CN, en_US => zh-CN, en-US
+    return locale.replace('_', '-').toLowerCase();
+}
+exports.formatLocale = formatLocale;
 //# sourceMappingURL=utils.js.map

package/index.d.ts

@@ -0,0 +1,9 @@
+import { I18nOptions } from './dist/';
+
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    i18n?: PowerPartial<I18nOptions>;
+  }
+}

package/package.json

@@ -1,17 +1,23 @@
 {
   "name": "@midwayjs/i18n",
-  "description": "midway i18n compoennet",
-  "version": "3.0.0-beta.7",
+  "description": "midway i18n component",
+  "version": "3.0.1",
   "main": "dist/index",
-  "typings": "dist/index.d.ts",
+  "typings": "index.d.ts",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "index.d.ts"
   ],
+  "dependencies": {
+    "picomatch": "2.3.1"
+  },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.7",
-    "@midwayjs/decorator": "^3.0.0-beta.7",
-    "@midwayjs/mock": "^3.0.0-beta.7"
+    "@midwayjs/core": "^3.0.1",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/express": "^3.0.1",
+    "@midwayjs/koa": "^3.0.1",
+    "@midwayjs/mock": "^3.0.1"
   },
   "keywords": [
     "midway",
@@ -21,8 +27,8 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
     "ci": "npm run test",
     "lint": "mwts check"
   },
@@ -33,5 +39,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "24590729121d9110e2d960db5b5e587cf55a1efc"
+  "gitHead": "f345b4ed0392e5c3b9e815438ef0a377ad6da076"
 }

package/CHANGELOG.md

@@ -1,62 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [3.0.0-beta.7](https://github.com/midwayjs/midway/compare/v3.0.0-beta.6...v3.0.0-beta.7) (2021-12-03)
-
-**Note:** Version bump only for package @midwayjs/i18n
-
-
-
-
-
-# [3.0.0-beta.6](https://github.com/midwayjs/midway/compare/v3.0.0-beta.5...v3.0.0-beta.6) (2021-11-26)
-
-**Note:** Version bump only for package @midwayjs/i18n
-
-
-
-
-
-# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
-
-**Note:** Version bump only for package @midwayjs/i18n
-
-
-
-
-
-# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
-
-
-### Features
-
-* add i18n ([#1375](https://github.com/midwayjs/midway/issues/1375)) ([bffefe0](https://github.com/midwayjs/midway/commit/bffefe07afe45777d49b5a76b9ab17fc2b9d9a55))
-
-
-
-
-
-# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
-
-
-### Features
-
-* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
-
-
-
-
-
-# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
-
-**Note:** Version bump only for package @midwayjs/info
-
-
-
-
-
-# [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
-
-**Note:** Version bump only for package @midwayjs/info

package/dist/config.default.d.ts

@@ -1,9 +0,0 @@
-export declare const i18n: {
-    defaultLanguage: string;
-    languageTable: {
-        en: {};
-    };
-    fallbackLanguage: string;
-    fallbacks: {};
-};
-//# sourceMappingURL=config.default.d.ts.map

package/dist/config.default.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = void 0;
-exports.i18n = {
-    defaultLanguage: 'en',
-    languageTable: {
-        en: {},
-    },
-    fallbackLanguage: 'en',
-    fallbacks: {
-    //   'en-CA': 'fr',
-    //   'en-*': 'en',
-    //   'fr-*': 'fr',
-    //   pt: 'pt-BR',
-    },
-};
-//# sourceMappingURL=config.default.js.map