@prosopo/locale 3.4.3 → 3.6.0

package/dist/tests/useTranslation.unit.test.js

@@ -1,81 +0,0 @@
-import { afterEach, describe, expect, test, vi } from "vitest";
-const asI18n = (value) => value;
-const load = async () => {
-    vi.resetModules();
-    const instance = asI18n({ name: "package instance" });
-    const calls = [];
-    let initCalls = 0;
-    vi.doMock("../i18nFrontend.js", () => ({
-        default: () => {
-            initCalls += 1;
-            return instance;
-        },
-    }));
-    vi.doMock("react-i18next", () => ({
-        useTranslation: (namespace, options) => {
-            calls.push([namespace, options]);
-            return { t: (key) => key, i18n: options.i18n };
-        },
-    }));
-    const imported = await import("../useTranslation.js");
-    return {
-        useTranslation: imported.default,
-        instance,
-        calls,
-        initCount: () => initCalls,
-    };
-};
-afterEach(() => {
-    vi.resetModules();
-    vi.doUnmock("../i18nFrontend.js");
-    vi.doUnmock("react-i18next");
-});
-describe("useTranslation", () => {
-    test("always asks for the translation namespace", async () => {
-        const { useTranslation, calls } = await load();
-        useTranslation();
-        expect(calls[0]?.[0]).toBe("translation");
-    });
-    test("injects the package's own i18next instance", async () => {
-        const { useTranslation, calls, instance } = await load();
-        useTranslation();
-        expect(calls[0]?.[1].i18n).toBe(instance);
-    });
-    test("initialises the frontend instance on use", async () => {
-        const { useTranslation, initCount } = await load();
-        useTranslation();
-        expect(initCount()).toBe(1);
-    });
-    test("works with no options at all", async () => {
-        const { useTranslation, calls } = await load();
-        useTranslation();
-        expect(calls[0]?.[1]).toEqual({ i18n: expect.anything() });
-    });
-    test("passes caller options through", async () => {
-        const { useTranslation, calls } = await load();
-        useTranslation({ nsMode: "fallback", useSuspense: false });
-        expect(calls[0]?.[1]).toMatchObject({
-            nsMode: "fallback",
-            useSuspense: false,
-        });
-    });
-    test("lets the caller override the instance, since options spread last", async () => {
-        const { useTranslation, calls, instance } = await load();
-        const other = asI18n({ name: "caller instance" });
-        useTranslation({ i18n: other });
-        expect(calls[0]?.[1].i18n).toBe(other);
-        expect(calls[0]?.[1].i18n).not.toBe(instance);
-    });
-    test("returns whatever react-i18next returns", async () => {
-        const { useTranslation } = await load();
-        const result = useTranslation();
-        expect(result.t("WIDGET.SUBMIT")).toBe("WIDGET.SUBMIT");
-    });
-    test("re-initialises on every call, matching hook semantics", async () => {
-        const { useTranslation, initCount } = await load();
-        useTranslation();
-        useTranslation();
-        expect(initCount()).toBe(2);
-    });
-});
-//# sourceMappingURL=useTranslation.unit.test.js.map

package/dist/tests/useTranslation.unit.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTranslation.unit.test.js","sourceRoot":"","sources":["../../src/tests/useTranslation.unit.test.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAS/D,MAAM,MAAM,GAAG,CAAC,KAAa,EAAQ,EAAE,CAAC,KAAwB,CAAC;AAEjE,MAAM,IAAI,GAAG,KAAK,IAKf,EAAE;IACJ,EAAE,CAAC,YAAY,EAAE,CAAC;IAElB,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACtD,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,EAAE,CAAC,MAAM,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAC;QACtC,OAAO,EAAE,GAAS,EAAE;YACnB,SAAS,IAAI,CAAC,CAAC;YACf,OAAO,QAAQ,CAAC;QACjB,CAAC;KACD,CAAC,CAAC,CAAC;IACJ,EAAE,CAAC,MAAM,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC;QACjC,cAAc,EAAE,CACf,SAAiB,EACjB,OAAiD,EACvC,EAAE;YACZ,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACjC,OAAO,EAAE,CAAC,EAAE,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAChE,CAAC;KACD,CAAC,CAAC,CAAC;IAEJ,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;IACtD,OAAO;QACN,cAAc,EAAE,QAAQ,CAAC,OAAO;QAChC,QAAQ;QACR,KAAK;QACL,SAAS,EAAE,GAAW,EAAE,CAAC,SAAS;KAClC,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,CAAC,GAAG,EAAE;IACd,EAAE,CAAC,YAAY,EAAE,CAAC;IAClB,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;IAClC,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC/B,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC/C,cAAc,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAG7D,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzD,cAAc,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,cAAc,EAAE,CAAC;QACjB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC/C,cAAc,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC/C,cAAc,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACnC,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,KAAK;SAClB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAInF,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAElD,cAAc,CAAC,EAAE,IAAI,EAAE,KAAK,EAA0C,CAAC,CAAC;QAExE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,cAAc,EAAoC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QAGxE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,cAAc,EAAE,CAAC;QACjB,cAAc,EAAE,CAAC;QACjB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/useTranslation.d.ts

@@ -1,7 +0,0 @@
-import { type UseTranslationOptions, type UseTranslationResponse } from "react-i18next";
-import initializeI18n from "./i18nFrontend.js";
-declare function useTranslation(options?: UseTranslationOptions<"translation">): UseTranslationResponse<"translation", "translation"> & {
-    t: ReturnType<typeof initializeI18n>["t"];
-};
-export default useTranslation;
-//# sourceMappingURL=useTranslation.d.ts.map

package/dist/useTranslation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTranslation.d.ts","sourceRoot":"","sources":["../src/useTranslation.ts"],"names":[],"mappings":"AAcA,OAAO,EACN,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAE3B,MAAM,eAAe,CAAC;AACvB,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAE/C,iBAAS,cAAc,CACtB,OAAO,CAAC,EAAE,qBAAqB,CAAC,aAAa,CAAC,GAC5C,sBAAsB,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG;IACzD,CAAC,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC;CAC1C,CAGA;AAED,eAAe,cAAc,CAAC"}

package/dist/useTranslation.js

@@ -1,11 +0,0 @@
-import initializeI18n from "./i18nFrontend.js";
-import { useTranslation } from "react-i18next";
-//#region src/useTranslation.ts
-function useTranslation$1(options) {
-	return useTranslation("translation", {
-		i18n: initializeI18n(),
-		...options
-	});
-}
-//#endregion
-export { useTranslation$1 as default };

package/dist/useTranslation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTranslation.js","sourceRoot":"","sources":["../src/useTranslation.ts"],"names":[],"mappings":"AAcA,OAAO,EAGN,cAAc,IAAI,qBAAqB,GACvC,MAAM,eAAe,CAAC;AACvB,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAE/C,SAAS,cAAc,CACtB,OAA8C;IAI9C,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;IAC9B,OAAO,qBAAqB,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AACnE,CAAC;AAED,eAAe,cAAc,CAAC"}

package/src/tests/useTranslation.unit.test.ts

@@ -1,134 +0,0 @@
-// Copyright 2021-2026 Prosopo (UK) Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { i18n } from "i18next";
-import type { UseTranslationOptions } from "react-i18next";
-import { afterEach, describe, expect, test, vi } from "vitest";
-
-// The hook is a thin wrapper: it forces the package's own i18next instance in
-// rather than letting react-i18next pick up whichever instance a host app's
-// provider happens to expose. React itself is never rendered here, so both
-// react-i18next and the frontend initialiser are mocked.
-
-type DefaultCall = [string, { i18n: i18n } & Record<string, unknown>];
-
-const asI18n = (value: object): i18n => value as unknown as i18n;
-
-const load = async (): Promise<{
-	useTranslation: (options?: UseTranslationOptions<"translation">) => unknown;
-	instance: i18n;
-	calls: DefaultCall[];
-	initCount: () => number;
-}> => {
-	vi.resetModules();
-
-	const instance = asI18n({ name: "package instance" });
-	const calls: DefaultCall[] = [];
-	let initCalls = 0;
-
-	vi.doMock("../i18nFrontend.js", () => ({
-		default: (): i18n => {
-			initCalls += 1;
-			return instance;
-		},
-	}));
-	vi.doMock("react-i18next", () => ({
-		useTranslation: (
-			namespace: string,
-			options: { i18n: i18n } & Record<string, unknown>,
-		): unknown => {
-			calls.push([namespace, options]);
-			return { t: (key: string): string => key, i18n: options.i18n };
-		},
-	}));
-
-	const imported = await import("../useTranslation.js");
-	return {
-		useTranslation: imported.default,
-		instance,
-		calls,
-		initCount: (): number => initCalls,
-	};
-};
-
-afterEach(() => {
-	vi.resetModules();
-	vi.doUnmock("../i18nFrontend.js");
-	vi.doUnmock("react-i18next");
-});
-
-describe("useTranslation", () => {
-	test("always asks for the translation namespace", async () => {
-		const { useTranslation, calls } = await load();
-		useTranslation();
-		expect(calls[0]?.[0]).toBe("translation");
-	});
-
-	test("injects the package's own i18next instance", async () => {
-		// Without this, a host application that mounts its own I18nextProvider
-		// would capture the widget's translations and render its keys instead.
-		const { useTranslation, calls, instance } = await load();
-		useTranslation();
-		expect(calls[0]?.[1].i18n).toBe(instance);
-	});
-
-	test("initialises the frontend instance on use", async () => {
-		const { useTranslation, initCount } = await load();
-		useTranslation();
-		expect(initCount()).toBe(1);
-	});
-
-	test("works with no options at all", async () => {
-		const { useTranslation, calls } = await load();
-		useTranslation();
-		expect(calls[0]?.[1]).toEqual({ i18n: expect.anything() });
-	});
-
-	test("passes caller options through", async () => {
-		const { useTranslation, calls } = await load();
-		useTranslation({ nsMode: "fallback", useSuspense: false });
-		expect(calls[0]?.[1]).toMatchObject({
-			nsMode: "fallback",
-			useSuspense: false,
-		});
-	});
-
-	test("lets the caller override the instance, since options spread last", async () => {
-		// Worth pinning: the spread order means a caller-supplied i18n wins.
-		// That is useful for tests and storybooks, and dangerous by accident,
-		// so it should not change silently.
-		const { useTranslation, calls, instance } = await load();
-		const other = asI18n({ name: "caller instance" });
-
-		useTranslation({ i18n: other } as UseTranslationOptions<"translation">);
-
-		expect(calls[0]?.[1].i18n).toBe(other);
-		expect(calls[0]?.[1].i18n).not.toBe(instance);
-	});
-
-	test("returns whatever react-i18next returns", async () => {
-		const { useTranslation } = await load();
-		const result = useTranslation() as { t: (key: string) => string };
-		expect(result.t("WIDGET.SUBMIT")).toBe("WIDGET.SUBMIT");
-	});
-
-	test("re-initialises on every call, matching hook semantics", async () => {
-		// initializeI18n is idempotent, so calling it per render is safe; the
-		// test exists so that stops being true loudly rather than quietly.
-		const { useTranslation, initCount } = await load();
-		useTranslation();
-		useTranslation();
-		expect(initCount()).toBe(2);
-	});
-});

package/src/useTranslation.ts

@@ -1,31 +0,0 @@
-// Copyright 2021-2026 Prosopo (UK) Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import {
-	type UseTranslationOptions,
-	type UseTranslationResponse,
-	useTranslation as useTranslationDefault,
-} from "react-i18next";
-import initializeI18n from "./i18nFrontend.js";
-
-function useTranslation(
-	options?: UseTranslationOptions<"translation">,
-): UseTranslationResponse<"translation", "translation"> & {
-	t: ReturnType<typeof initializeI18n>["t"];
-} {
-	const i18n = initializeI18n();
-	return useTranslationDefault("translation", { i18n, ...options });
-}
-
-export default useTranslation;