@to-kn/koa-locales 2.1.0 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@to-kn/koa-locales",
-	"version": "2.1.0",
+	"version": "2.1.2",
 	"description": "koa locales, i18n solution for koa",
 	"keywords": [
 		"koa-locales",
@@ -22,13 +22,13 @@
 	"author": "to-kn <t.knipping@tks.eu> (https://tks.eu)",
 	"type": "module",
 	"exports": {
-		"import": "./dist/esm/index.js",
-		"require": "./dist/cjs/index.cjs",
-		"types": "./dist/types/index.d.ts"
+		"import": "./dist/index.js",
+		"require": "./dist/cjs/index.js",
+		"types": "./dist/index.d.ts"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.js",
-	"types": "./dist/types/index.d.ts",
+	"main": "./dist/cjs/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
 	"files": [
 		"dist/"
 	],

package/dist/esm/index.js

@@ -1,271 +0,0 @@
-import fs from "node:fs";
-import { createRequire } from "node:module";
-import path from "node:path";
-import util from "node:util";
-import Debug from "debug";
-import { ms } from "humanize-ms";
-import ini from "ini";
-import yaml from "js-yaml";
-const DEFAULT_OPTIONS = {
-    defaultLocale: "en-US",
-    queryField: "locale",
-    cookieField: "locale",
-    localeAlias: {},
-    writeCookie: true,
-    cookieMaxAge: "1y",
-    dir: undefined,
-    dirs: [path.join(process.cwd(), "locales")],
-    functionName: "__",
-};
-function locales(app, options = {}) {
-    options = Object.assign({}, DEFAULT_OPTIONS, options);
-    const defaultLocale = formatLocale(options.defaultLocale || "en-US");
-    const queryField = options.queryField || "locale";
-    const cookieField = options.cookieField || "locale";
-    const cookieDomain = options.cookieDomain;
-    const localeAlias = options.localeAlias || {};
-    const writeCookie = options.writeCookie !== false;
-    const cookieMaxAge = ms(options.cookieMaxAge || "1y");
-    const localeDir = options.dir;
-    const localeDirs = options.dirs || [path.join(process.cwd(), "locales")];
-    const functionName = options.functionName || "__";
-    const resources = {};
-    /**
-     * @Deprecated Use options.dirs instead.
-     */
-    if (localeDir && !localeDirs.includes(localeDir)) {
-        localeDirs.push(localeDir);
-    }
-    appendDebugLog("Starting resource loading");
-    // Loop through all directories, merging resources for the same locale
-    // Later directories override earlier ones
-    for (let i = 0; i < localeDirs.length; i++) {
-        const dir = localeDirs[i];
-        if (!fs.existsSync(dir)) {
-            continue;
-        }
-        const names = fs.readdirSync(dir);
-        for (let j = 0; j < names.length; j++) {
-            const name = names[j];
-            const filepath = path.join(dir, name);
-            // support en_US.js => en-US.js
-            const locale = formatLocale(name.split(".")[0]);
-            let resource = {};
-            if (name.endsWith(".js")) {
-                const require = createRequire(import.meta.url);
-                const mod = require(filepath);
-                resource = flattening((mod.default || mod));
-                appendDebugLog(`Loaded JS resource for locale '${locale}' from: ${filepath}`, resource);
-            }
-            else if (name.endsWith(".json")) {
-                // @ts-ignore
-                resource = flattening(require(filepath));
-                appendDebugLog(`Loaded JSON resource for locale '${locale}' from: ${filepath}`, resource);
-            }
-            else if (name.endsWith(".properties")) {
-                resource = ini.parse(fs.readFileSync(filepath, "utf8"));
-                appendDebugLog(`Loaded PROPERTIES resource for locale '${locale}' from: ${filepath}`, resource);
-            }
-            else if (name.endsWith(".yml") || name.endsWith(".yaml")) {
-                resource = flattening(yaml.load(fs.readFileSync(filepath, "utf8")));
-                appendDebugLog(`Loaded YAML resource for locale '${locale}' from: ${filepath}`, resource);
-            }
-            // Always merge, but let later dirs override earlier ones
-            resources[locale] = { ...resources[locale], ...resource };
-            appendDebugLog(`Merged resource for locale '${locale}'`, resources[locale]);
-        }
-    }
-    appendDebugLog("Finished resource loading");
-    const debug = Debug("koa-locales");
-    const debugSilly = Debug("koa-locales:silly");
-    debug("Init locales with %j, got %j resources", options, Object.keys(resources));
-    if (typeof app[functionName] !==
-        "undefined") {
-        console.warn('[koa-locales] will override exists "%s" function on app', functionName);
-    }
-    function gettext(locale, key, ...args) {
-        if (!key || key === "")
-            return "";
-        const resource = resources[locale] || {};
-        let text = resource[key];
-        if (typeof text !== "string") {
-            text = key;
-        }
-        debugSilly("%s: %j => %j", locale, key, text);
-        if (args.length === 0) {
-            // __(locale, key)
-            return text;
-        }
-        if (args.length === 1) {
-            const value = args[0];
-            if (isObject(value)) {
-                return formatWithObject(text, value);
-            }
-            if (Array.isArray(value)) {
-                return formatWithArray(text, value);
-            }
-            return util.format(text, value);
-        }
-        // __(locale, key, value1, ...)
-        return util.format(text, ...args);
-    }
-    // Attach to app and context using proper Koa extension
-    app[functionName] = gettext;
-    app.context[functionName] =
-        function (key, ...args) {
-            const ctx = this;
-            const locale = ctx.__getLocale ? ctx.__getLocale() : "";
-            return gettext(locale, key, ...args);
-        };
-    app.context.__getLocale =
-        function () {
-            const ctx = this;
-            if (typeof ctx.__locale === "string" && ctx.__locale) {
-                return ctx.__locale;
-            }
-            const cookieLocale = ctx.cookies.get(cookieField, { signed: false });
-            let locale = ctx.query[queryField];
-            let localeOrigin = "query";
-            if (!locale) {
-                locale = cookieLocale;
-                localeOrigin = "cookie";
-            }
-            if (!locale) {
-                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 = formatLocale(String(languages[i]));
-                                if (resources[lang] || localeAlias[lang]) {
-                                    locale = lang;
-                                    localeOrigin = "header";
-                                    break;
-                                }
-                            }
-                        }
-                    }
-                    else if (typeof languages === "string") {
-                        locale = languages;
-                        localeOrigin = "header";
-                    }
-                }
-                if (!locale) {
-                    locale = defaultLocale;
-                    localeOrigin = "default";
-                }
-            }
-            if (locale && typeof locale !== "string") {
-                locale = String(locale);
-            }
-            if (locale && locale in localeAlias) {
-                const originalLocale = locale;
-                locale = localeAlias[locale];
-                debugSilly("Used alias, received %s but using %s", originalLocale, locale);
-            }
-            locale = formatLocale(locale || defaultLocale);
-            if (!resources[locale]) {
-                debugSilly("Locale %s is not supported. Using default (%s)", locale, defaultLocale);
-                locale = defaultLocale;
-            }
-            if (writeCookie && cookieLocale !== locale && !ctx.headerSent) {
-                updateCookie(ctx, locale);
-            }
-            debug("Locale: %s from %s", locale, localeOrigin);
-            debugSilly("Locale: %s from %s", locale, localeOrigin);
-            ctx.__locale = locale;
-            ctx.__localeOrigin = localeOrigin;
-            return String(locale);
-        };
-    app.context.__getLocaleOrigin =
-        function () {
-            const ctx = this;
-            if (typeof ctx.__localeOrigin === "string" && ctx.__localeOrigin)
-                return ctx.__localeOrigin;
-            ctx.__getLocale?.();
-            return String(ctx.__localeOrigin ?? "");
-        };
-    app.context.__setLocale =
-        function (locale) {
-            const ctx = this;
-            ctx.__locale = locale;
-            ctx.__localeOrigin = "set";
-            updateCookie(ctx, locale);
-        };
-    function updateCookie(ctx, locale) {
-        const cookieOptions = {
-            httpOnly: false,
-            maxAge: cookieMaxAge,
-            signed: false,
-            domain: cookieDomain,
-            overwrite: true,
-        };
-        ctx.cookies.set(cookieField, locale, cookieOptions);
-        debugSilly("Saved cookie with locale %s", locale);
-    }
-}
-function isObject(obj) {
-    return Object.prototype.toString.call(obj) === "[object Object]";
-}
-const ARRAY_INDEX_RE = /\{(\d+)\}/g;
-function formatWithArray(text, values) {
-    return text.replace(ARRAY_INDEX_RE, (orignal, matched) => {
-        const index = parseInt(matched);
-        if (index < values.length) {
-            return String(values[index]);
-        }
-        // not match index, return orignal text
-        return orignal;
-    });
-}
-const Object_INDEX_RE = /\{(.+?)\}/g;
-function formatWithObject(text, values) {
-    return text.replace(Object_INDEX_RE, (orignal, matched) => {
-        const value = values[matched];
-        if (value !== undefined && value !== null) {
-            return String(value);
-        }
-        // not match index, return orignal text
-        return orignal;
-    });
-}
-function formatLocale(locale) {
-    if (!locale)
-        return "";
-    return locale.replace(/_/g, "-").toLowerCase();
-}
-function flattening(data) {
-    const result = {};
-    function deepFlat(data, keys) {
-        Object.keys(data).forEach((key) => {
-            const value = data[key];
-            const k = keys ? `${keys}.${key}` : key;
-            if (isObject(value)) {
-                deepFlat(value, k);
-            }
-            else {
-                result[k] = String(value);
-            }
-        });
-    }
-    deepFlat(data, "");
-    return result;
-}
-function appendDebugLog(message, obj) {
-    const logPath = path.resolve(process.cwd(), "resource-debug.log");
-    let line = `[DEBUG] ${message}`;
-    if (obj !== undefined) {
-        try {
-            line += ` ${JSON.stringify(obj)}`;
-        }
-        catch {
-            line += ` ${String(obj)}`;
-        }
-    }
-    fs.appendFileSync(logPath, `${line}
-`);
-}
-export default locales;

package/dist/esm/src/index.js

@@ -1,320 +0,0 @@
-import Debug from "debug";
-import fs from "fs";
-import { ms } from "humanize-ms";
-import ini from "ini";
-import yaml from "js-yaml";
-import { createRequire } from "module";
-import assign from "object-assign";
-import path from "path";
-import util from "util";
-
-const DEFAULT_OPTIONS = {
-	defaultLocale: "en-US",
-	queryField: "locale",
-	cookieField: "locale",
-	localeAlias: {},
-	writeCookie: true,
-	cookieMaxAge: "1y",
-	dir: undefined,
-	dirs: [path.join(process.cwd(), "locales")],
-	functionName: "__",
-};
-function locales(app, options = {}) {
-	options = assign({}, DEFAULT_OPTIONS, options);
-	const defaultLocale = formatLocale(options.defaultLocale || "en-US");
-	const queryField = options.queryField || "locale";
-	const cookieField = options.cookieField || "locale";
-	const cookieDomain = options.cookieDomain;
-	const localeAlias = options.localeAlias || {};
-	const writeCookie = options.writeCookie !== false;
-	const cookieMaxAge = ms(options.cookieMaxAge || "1y");
-	const localeDir = options.dir;
-	const localeDirs = options.dirs || [path.join(process.cwd(), "locales")];
-	const functionName = options.functionName || "__";
-	const resources = {};
-	/**
-	 * @Deprecated Use options.dirs instead.
-	 */
-	if (localeDir && !localeDirs.includes(localeDir)) {
-		localeDirs.push(localeDir);
-	}
-	appendDebugLog("Starting resource loading");
-	throw new Error("Resource loader invoked");
-	// Loop through all directories, merging resources for the same locale
-	// Later directories override earlier ones
-	for (let i = 0; i < localeDirs.length; i++) {
-		const dir = localeDirs[i];
-		if (!fs.existsSync(dir)) {
-			continue;
-		}
-		const names = fs.readdirSync(dir);
-		for (let j = 0; j < names.length; j++) {
-			const name = names[j];
-			const filepath = path.join(dir, name);
-			// support en_US.js => en-US.js
-			const locale = formatLocale(name.split(".")[0]);
-			let resource = {};
-			if (name.endsWith(".js")) {
-				const require = createRequire(import.meta.url);
-				const mod = require(filepath);
-				resource = flattening(mod.default || mod);
-				appendDebugLog(
-					`Loaded JS resource for locale '${locale}' from: ${filepath}`,
-					resource,
-				);
-			} else if (name.endsWith(".json")) {
-				// @ts-ignore
-				resource = flattening(require(filepath));
-				appendDebugLog(
-					`Loaded JSON resource for locale '${locale}' from: ${filepath}`,
-					resource,
-				);
-			} else if (name.endsWith(".properties")) {
-				resource = ini.parse(fs.readFileSync(filepath, "utf8"));
-				appendDebugLog(
-					`Loaded PROPERTIES resource for locale '${locale}' from: ${filepath}`,
-					resource,
-				);
-			} else if (name.endsWith(".yml") || name.endsWith(".yaml")) {
-				resource = flattening(yaml.load(fs.readFileSync(filepath, "utf8")));
-				appendDebugLog(
-					`Loaded YAML resource for locale '${locale}' from: ${filepath}`,
-					resource,
-				);
-			}
-			// Always merge, but let later dirs override earlier ones
-			resources[locale] = { ...resources[locale], ...resource };
-			appendDebugLog(
-				`Merged resource for locale '${locale}'`,
-				resources[locale],
-			);
-		}
-	}
-	appendDebugLog("Finished resource loading");
-	const debug = Debug("koa-locales");
-	const debugSilly = Debug("koa-locales:silly");
-	debug(
-		"Init locales with %j, got %j resources",
-		options,
-		Object.keys(resources),
-	);
-	if (typeof app[functionName] !== "undefined") {
-		console.warn(
-			'[koa-locales] will override exists "%s" function on app',
-			functionName,
-		);
-	}
-	function gettext(locale, key, value) {
-		if (arguments.length === 0 || arguments.length === 1) {
-			// __()
-			// --('en')
-			return "";
-		}
-		const resource = resources[locale] || {};
-		let text = resource[key];
-		if (text === undefined) {
-			text = key;
-		}
-		debugSilly("%s: %j => %j", locale, key, text);
-		if (!text) {
-			return "";
-		}
-		if (arguments.length === 2) {
-			// __(locale, key)
-			return text;
-		}
-		if (arguments.length === 3) {
-			if (isObject(value)) {
-				// __(locale, key, object)
-				// __('zh', '{a} {b} {b} {a}', {a: 'foo', b: 'bar'})
-				// =>
-				// foo bar bar foo
-				return formatWithObject(text, value);
-			}
-			if (Array.isArray(value)) {
-				// __(locale, key, array)
-				// __('zh', '{0} {1} {1} {0}', ['foo', 'bar'])
-				// =>
-				// foo bar bar foo
-				return formatWithArray(text, value);
-			}
-			// __(locale, key, value)
-			return util.format(text, value);
-		}
-		// __(locale, key, value1, ...)
-		const args = new Array(arguments.length - 1);
-		args[0] = text;
-		for (let i = 2; i < arguments.length; i++) {
-			args[i - 1] = arguments[i];
-		}
-		return util.format.apply(util, args);
-	}
-	app[functionName] = gettext;
-	app.context[functionName] = function (key, value) {
-		if (arguments.length === 0) {
-			// __()
-			return "";
-		}
-		const locale = this.__getLocale();
-		if (arguments.length === 1) {
-			return gettext(locale, key);
-		}
-		if (arguments.length === 2) {
-			return gettext(locale, key, value);
-		}
-		const args = new Array(arguments.length + 1);
-		args[0] = locale;
-		for (let i = 0; i < arguments.length; i++) {
-			args[i + 1] = arguments[i];
-		}
-		// @ts-expect-error: dynamic argument forwarding
-		return gettext(...args);
-	};
-	app.context.__getLocale = function () {
-		if (this.__locale) {
-			return this.__locale;
-		}
-		const cookieLocale = this.cookies.get(cookieField, { signed: false });
-		// 1. Query
-		let locale = this.query[queryField];
-		let localeOrigin = "query";
-		// 2. Cookie
-		if (!locale) {
-			locale = cookieLocale;
-			localeOrigin = "cookie";
-		}
-		// 3. Header
-		if (!locale) {
-			let languages = this.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 = formatLocale(languages[i]);
-							if (resources[lang] || localeAlias[lang]) {
-								locale = lang;
-								localeOrigin = "header";
-								break;
-							}
-						}
-					}
-				} else {
-					locale = languages;
-					localeOrigin = "header";
-				}
-			}
-			if (!locale) {
-				locale = defaultLocale;
-				localeOrigin = "default";
-			}
-		}
-		if (locale && locale in localeAlias) {
-			const originalLocale = locale;
-			locale = localeAlias[locale];
-			debugSilly(
-				"Used alias, received %s but using %s",
-				originalLocale,
-				locale,
-			);
-		}
-		locale = formatLocale(locale || defaultLocale);
-		if (!resources[locale]) {
-			debugSilly(
-				"Locale %s is not supported. Using default (%s)",
-				locale,
-				defaultLocale,
-			);
-			locale = defaultLocale;
-		}
-		if (writeCookie && cookieLocale !== locale && !this.headerSent) {
-			updateCookie(this, locale);
-		}
-		debug("Locale: %s from %s", locale, localeOrigin);
-		debugSilly("Locale: %s from %s", locale, localeOrigin);
-		this.__locale = locale;
-		this.__localeOrigin = localeOrigin;
-		return locale;
-	};
-	app.context.__getLocaleOrigin = function () {
-		if (this.__localeOrigin) return this.__localeOrigin;
-		this.__getLocale();
-		return this.__localeOrigin;
-	};
-	app.context.__setLocale = function (locale) {
-		this.__locale = locale;
-		this.__localeOrigin = "set";
-		updateCookie(this, locale);
-	};
-	function updateCookie(ctx, locale) {
-		const cookieOptions = {
-			httpOnly: false,
-			maxAge: cookieMaxAge,
-			signed: false,
-			domain: cookieDomain,
-			overwrite: true,
-		};
-		ctx.cookies.set(cookieField, locale, cookieOptions);
-		debugSilly("Saved cookie with locale %s", locale);
-	}
-}
-function isObject(obj) {
-	return Object.prototype.toString.call(obj) === "[object Object]";
-}
-const ARRAY_INDEX_RE = /\{(\d+)\}/g;
-function formatWithArray(text, values) {
-	return text.replace(ARRAY_INDEX_RE, (orignal, matched) => {
-		const index = parseInt(matched);
-		if (index < values.length) {
-			return values[index];
-		}
-		// not match index, return orignal text
-		return orignal;
-	});
-}
-const Object_INDEX_RE = /\{(.+?)\}/g;
-function formatWithObject(text, values) {
-	return text.replace(Object_INDEX_RE, (orignal, matched) => {
-		const value = values[matched];
-		if (value) {
-			return value;
-		}
-		// not match index, return orignal text
-		return orignal;
-	});
-}
-function formatLocale(locale) {
-	if (!locale) return "";
-	return locale.replace(/_/g, "-").toLowerCase();
-}
-function flattening(data) {
-	const result = {};
-	function deepFlat(data, keys) {
-		Object.keys(data).forEach((key) => {
-			const value = data[key];
-			const k = keys ? keys + "." + key : key;
-			if (isObject(value)) {
-				deepFlat(value, k);
-			} else {
-				result[k] = String(value);
-			}
-		});
-	}
-	deepFlat(data, "");
-	return result;
-}
-function appendDebugLog(message, obj) {
-	const logPath = path.resolve(process.cwd(), "resource-debug.log");
-	let line = `[DEBUG] ${message}`;
-	if (obj !== undefined) {
-		try {
-			line += " " + JSON.stringify(obj);
-		} catch {
-			line += " " + String(obj);
-		}
-	}
-	fs.appendFileSync(logPath, line + "\n");
-}
-export default locales;

package/dist/esm/test/index.test.js

@@ -1,580 +0,0 @@
-import assert from "assert";
-import Koa from "koa";
-import mm from "mm";
-import request from "supertest";
-import { afterEach, describe, expect, it } from "vitest";
-// @ts-expect-error: legacy test expects any type for locales import
-import locales from "..";
-
-describe("koa-locales.test.js", () => {
-	afterEach(mm.restore);
-	describe("default options", () => {
-		const app = createApp();
-		it("should use default locale: en-US", async () => {
-			await request(app.callback())
-				.get("/")
-				.expect({
-					email: "Email",
-					hello: "Hello fengmk2, how are you today?",
-					message: "Hello fengmk2, how are you today? How was your 18.",
-					empty: "",
-					notexists_key: "key not exists",
-					empty_string: "",
-					empty_value: "emptyValue",
-					novalue: "key %s ok",
-					arguments3: "1 2 3",
-					arguments4: "1 2 3 4",
-					arguments5: "1 2 3 4 5",
-					arguments6: "1 2 3 4 5. 6",
-					values: "foo bar foo bar {2} {100}",
-					object: "foo bar foo bar {z}",
-					gender: "model.user.fields.gender",
-					name: "model.user.fields.name",
-				})
-				.expect("Set-Cookie", /^locale=en-us; path=\/+; expires=[^;]+ GMT$/)
-				.expect(200);
-		});
-		it("should not set locale cookie after header sent", async () => {
-			await request(app.callback())
-				.get("/headerSent")
-				.expect("foo")
-				.expect(200);
-		});
-	});
-	describe("options.cookieDomain", () => {
-		const app = createApp({
-			cookieDomain: ".foo.com",
-		});
-		it("should use default locale: en-US", async () => {
-			await request(app.callback())
-				.get("/")
-				.expect({
-					email: "Email",
-					hello: "Hello fengmk2, how are you today?",
-					message: "Hello fengmk2, how are you today? How was your 18.",
-					empty: "",
-					notexists_key: "key not exists",
-					empty_string: "",
-					empty_value: "emptyValue",
-					novalue: "key %s ok",
-					arguments3: "1 2 3",
-					arguments4: "1 2 3 4",
-					arguments5: "1 2 3 4 5",
-					arguments6: "1 2 3 4 5. 6",
-					values: "foo bar foo bar {2} {100}",
-					object: "foo bar foo bar {z}",
-					gender: "model.user.fields.gender",
-					name: "model.user.fields.name",
-				})
-				.expect(
-					"Set-Cookie",
-					/^locale=en-us; path=\/; expires=[^;]+; domain=.foo.com$/,
-				)
-				.expect(200);
-		});
-	});
-	describe("custom options", () => {
-		const app = createApp({
-			dirs: [__dirname + "/locales", __dirname + "/other-locales"],
-		});
-		const cookieFieldMapApp = createApp({
-			dirs: [__dirname + "/locales", __dirname + "/other-locales"],
-			localeAlias: {
-				en: "en-US",
-				"de-de": "de",
-			},
-		});
-		const appNotWriteCookie = createApp({
-			dirs: [__dirname + "/locales", __dirname + "/other-locales"],
-			writeCookie: false,
-		});
-		it("should use default locale: en-US", async () => {
-			await request(app.callback())
-				.get("/")
-				.expect({
-					email: "Email",
-					hello: "Hello fengmk2, how are you today?",
-					message: "Hello fengmk2, how are you today? How was your 18.",
-					empty: "",
-					notexists_key: "key not exists",
-					empty_string: "",
-					empty_value: "emptyValue",
-					novalue: "key %s ok",
-					arguments3: "1 2 3",
-					arguments4: "1 2 3 4",
-					arguments5: "1 2 3 4 5",
-					arguments6: "1 2 3 4 5. 6",
-					values: "foo bar foo bar {2} {100}",
-					object: "foo bar foo bar {z}",
-					gender: "model.user.fields.gender",
-					name: "model.user.fields.name",
-				})
-				.expect("Set-Cookie", /^locale=en-us; path=\/; expires=\w+/)
-				.expect(200);
-		});
-		it("should gettext work on app.__(locale, key, value)", async () => {
-			await request(app.callback())
-				.get("/app_locale_zh")
-				.expect({
-					email: "邮箱1",
-				})
-				.expect(200);
-		});
-		describe("query.locale", () => {
-			it("should use query locale: zh-CN", async () => {
-				await request(app.callback())
-					.get("/?locale=zh-CN")
-					.expect({
-						email: "邮箱1",
-						hello: "fengmk2，今天过得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性别",
-						name: "姓名",
-					})
-					.expect("Set-Cookie", /^locale=zh-cn; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should use query locale: de on *.properties format", async () => {
-				await request(app.callback())
-					.get("/?locale=de")
-					.expect({
-						email: "Emailde",
-						hello: "Hallo fengmk2, wie geht es dir heute?",
-						message: "Hallo fengmk2, wie geht es dir heute? Wie war dein 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=de; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should use query locale and change cookie locale", async () => {
-				await request(app.callback())
-					.get("/?locale=zh-CN")
-					.set("cookie", "locale=zh-TW")
-					.expect({
-						email: "邮箱1",
-						hello: "fengmk2，今天过得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性别",
-						name: "姓名",
-					})
-					.expect("Set-Cookie", /^locale=zh-cn; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should ignore invalid locale value", async () => {
-				await request(app.callback())
-					.get("/?locale=xss")
-					.expect({
-						email: "Email",
-						hello: "Hello fengmk2, how are you today?",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=en-us; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should use localeAlias", async () => {
-				await request(cookieFieldMapApp.callback())
-					.get("/?locale=de-de")
-					.expect({
-						email: "Emailde",
-						hello: "Hallo fengmk2, wie geht es dir heute?",
-						message: "Hallo fengmk2, wie geht es dir heute? Wie war dein 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=de; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should use query locale and response without set-cookie", async () => {
-				await request(appNotWriteCookie.callback())
-					.get("/?locale=zh-CN")
-					.expect({
-						email: "邮箱1",
-						hello: "fengmk2，今天过得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性别",
-						name: "姓名",
-					})
-					.expect((res) => {
-						if (res.headers["set-cookie"] || res.headers["Set-Cookie"]) {
-							throw new Error("should not write cookie");
-						}
-					})
-					.expect(200);
-			});
-		});
-		describe("cookie.locale", () => {
-			it("should use cookie locale: zh-CN", async () => {
-				await request(app.callback())
-					.get("/?locale=")
-					.set("cookie", "locale=zh-cn")
-					.expect({
-						email: "邮箱1",
-						hello: "fengmk2，今天过得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性别",
-						name: "姓名",
-					})
-					.expect((res) => {
-						assert(!res.headers["set-cookie"]);
-					})
-					.expect(200);
-			});
-		});
-		describe("Accept-Language", () => {
-			it("should use Accept-Language: zh-CN", async () => {
-				await request(app.callback())
-					.get("/?locale=")
-					.set("Accept-Language", "zh-CN")
-					.expect({
-						email: "邮箱1",
-						hello: "fengmk2，今天过得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性别",
-						name: "姓名",
-					})
-					.expect("Set-Cookie", /^locale=zh-cn; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it('should work with "Accept-Language: " header', async () => {
-				await request(app.callback())
-					.get("/?locale=")
-					.set("Accept-Language", "")
-					.expect({
-						email: "Email",
-						hello: "Hello fengmk2, how are you today?",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=en-us; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it('should work with "Accept-Language: en"', async () => {
-				await request(app.callback())
-					.get("/")
-					.set("Accept-Language", "en")
-					.expect({
-						email: "Email",
-						hello: "Hello fengmk2, how are you today?",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=en-us; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it('should work with "Accept-Language: de-de" by localeAlias', async () => {
-				await request(cookieFieldMapApp.callback())
-					.get("/")
-					.set("Accept-Language", "ja,de-de;q=0.8")
-					.expect({
-						email: "Emailde",
-						hello: "Hallo fengmk2, wie geht es dir heute?",
-						message: "Hallo fengmk2, wie geht es dir heute? Wie war dein 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=de; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should mock acceptsLanguages return string", async () => {
-				mm(app.request, "acceptsLanguages", () => "zh-TW");
-				await request(app.callback())
-					.get("/?locale=")
-					.expect({
-						email: "郵箱",
-						hello: "fengmk2，今天過得如何？",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "性別",
-						name: "姓名",
-					})
-					.expect("Set-Cookie", /^locale=zh-tw; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should mock acceptsLanguages return string", async () => {
-				mm(app.request, "acceptsLanguages", () => "fr");
-				await request(app.callback())
-					.get("/?locale=fr")
-					.set("Accept-Language", "fr;q=0.8, fr, fr")
-					.expect({
-						email: "le email",
-						hello: "fengmk2, Comment allez-vous",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "le sexe",
-						name: "prénom",
-					})
-					.expect("Set-Cookie", /^locale=fr; path=\/; expires=\w+/)
-					.expect(200);
-			});
-			it("should mock acceptsLanguages return null", async () => {
-				mm(app.request, "acceptsLanguages", () => null);
-				await request(app.callback())
-					.get("/?locale=")
-					.expect({
-						email: "Email",
-						hello: "Hello fengmk2, how are you today?",
-						message: "Hello fengmk2, how are you today? How was your 18.",
-						empty: "",
-						notexists_key: "key not exists",
-						empty_string: "",
-						empty_value: "emptyValue",
-						novalue: "key %s ok",
-						arguments3: "1 2 3",
-						arguments4: "1 2 3 4",
-						arguments5: "1 2 3 4 5",
-						arguments6: "1 2 3 4 5. 6",
-						values: "foo bar foo bar {2} {100}",
-						object: "foo bar foo bar {z}",
-						gender: "model.user.fields.gender",
-						name: "model.user.fields.name",
-					})
-					.expect("Set-Cookie", /^locale=en-us; path=\/; expires=\w+/)
-					.expect(200);
-			});
-		});
-		describe("__getLocale and __getLocaleOrigin", () => {
-			it("should __getLocale and __getLocaleOrigin from cookie", async () => {
-				const res = await request(app.callback())
-					.get("/origin")
-					.set("cookie", "locale=de");
-				expect(res.body).toEqual({ locale: "de", localeOrigin: "cookie" });
-			});
-			it("should __getLocale and __getLocaleOrigin from query", async () => {
-				const res = await request(app.callback()).get("/origin?locale=de");
-				expect(res.body).toEqual({ locale: "de", localeOrigin: "query" });
-			});
-			it("should __getLocale and __getLocaleOrigin from header", async () => {
-				const res = await request(app.callback())
-					.get("/origin")
-					.set("Accept-Language", "zh-cn");
-				expect(res.body).toEqual({ locale: "zh-cn", localeOrigin: "header" });
-			});
-			it("should __getLocale and __getLocaleOrigin from default", async () => {
-				const res = await request(app.callback()).get("/origin");
-				expect(res.body).toEqual({ locale: "en-us", localeOrigin: "default" });
-			});
-		});
-		describe("__setLocale", () => {
-			it("should set locale and cookie", async () => {
-				const res = await request(app.callback())
-					.get("/set")
-					.set("cookie", "locale=de");
-				expect(res.body).toEqual({ locale: "zh-hk", localeOrigin: "set" });
-				expect(res.headers["set-cookie"]).toBeTruthy();
-			});
-		});
-	});
-});
-// @ts-ignore: legacy test expects any type for options
-function createApp(options) {
-	const app = new Koa();
-	locales(app, options);
-	const fname = (options && options.functionName) || "__";
-	app.use(async (ctx, next) => {
-		if (ctx.url === "/app_locale_zh") {
-			ctx.body = {
-				// @ts-ignore: legacy test expects any type for Application index
-				email: ctx.app[fname]("zh-cn", "Email"),
-			};
-			return;
-		}
-		if (ctx.path === "/origin") {
-			ctx.body = {
-				locale: ctx.__getLocale(),
-				localeOrigin: ctx.__getLocaleOrigin(),
-			};
-			return;
-		}
-		if (ctx.path === "/set") {
-			ctx.__getLocale();
-			ctx.__setLocale("zh-tw");
-			ctx.__setLocale("zh-hk");
-			ctx.body = {
-				locale: ctx.__getLocale(),
-				localeOrigin: ctx.__getLocaleOrigin(),
-			};
-			return;
-		}
-		if (ctx.url === "/headerSent") {
-			ctx.body = "foo";
-			// @ts-ignore: legacy test expects any type for Application index
-			setTimeout(() => {
-				ctx.app[fname]("Email");
-			}, 50);
-			return;
-		}
-		ctx.body = {
-			email: ctx[fname]("Email"),
-			name: ctx[fname]("model.user.fields.name"),
-			gender: ctx[fname]("model.user.fields.gender"),
-			hello: ctx[fname]("Hello %s, how are you today?", "fengmk2"),
-			message: ctx[fname](
-				"Hello %s, how are you today? How was your %s.",
-				"fengmk2",
-				18,
-			),
-			empty: ctx[fname](),
-			notexists_key: ctx[fname]("key not exists"),
-			empty_string: ctx[fname](""),
-			empty_value: ctx[fname]("emptyValue"),
-			novalue: ctx[fname]("key %s ok"),
-			arguments3: ctx[fname]("%s %s %s", 1, 2, 3),
-			arguments4: ctx[fname]("%s %s %s %s", 1, 2, 3, 4),
-			arguments5: ctx[fname]("%s %s %s %s %s", 1, 2, 3, 4, 5),
-			arguments6: ctx[fname]("%s %s %s %s %s.", 1, 2, 3, 4, 5, 6),
-			values: ctx[fname]("{0} {1} {0} {1} {2} {100}", ["foo", "bar"]),
-			object: ctx[fname]("{foo} {bar} {foo} {bar} {z}", {
-				foo: "foo",
-				bar: "bar",
-			}),
-		};
-		if (next) await next();
-	});
-	return app;
-}

package/dist/types/index.d.ts

@@ -1,28 +0,0 @@
-import type Koa from "koa";
-interface LocalesOptions {
-    defaultLocale?: string;
-    queryField?: string;
-    cookieField?: string;
-    cookieDomain?: string;
-    localeAlias?: Record<string, string>;
-    writeCookie?: boolean;
-    cookieMaxAge?: string | number;
-    dir?: string;
-    dirs?: string[];
-    functionName?: string;
-}
-type GettextFunction = (locale: string, key: string, ...args: unknown[]) => string;
-declare module "koa" {
-    interface Context {
-        __: GettextFunction;
-        __getLocale(): string;
-        __setLocale(locale: string): void;
-        __getLocaleOrigin(): string;
-    }
-    interface Application {
-        __: GettextFunction;
-    }
-}
-declare function locales(app: Koa, options?: LocalesOptions): void;
-export default locales;
-export type { LocalesOptions };

package/dist/types/src/index.d.ts

@@ -1,27 +0,0 @@
-import type Koa from "koa";
-interface LocalesOptions {
-	defaultLocale?: string;
-	queryField?: string;
-	cookieField?: string;
-	cookieDomain?: string;
-	localeAlias?: Record<string, string>;
-	writeCookie?: boolean;
-	cookieMaxAge?: string | number;
-	dir?: string;
-	dirs?: string[];
-	functionName?: string;
-}
-type GettextFunction = (locale: string, key: string, ...args: any[]) => string;
-declare module "koa" {
-	interface Context {
-		__: GettextFunction;
-		__getLocale(): string;
-		__setLocale(locale: string): void;
-		__getLocaleOrigin(): string;
-	}
-	interface Application {
-		__: GettextFunction;
-	}
-}
-declare function locales(app: Koa, options?: LocalesOptions): void;
-export default locales;

package/dist/types/test/index.test.d.ts

@@ -1 +0,0 @@
-export {};