@inlang/paraglide-js 2.0.0-beta.14 → 2.0.0-beta.15

package/dist/compiler/runtime/jsdoc-runtime.js

@@ -1,131 +0,0 @@
-import fs from "node:fs";
-/**
- * Load a file from the current directory.
- *
- * @param {string} path
- * @returns {string}
- */
-const injectCode = (path) => fs.readFileSync(new URL(path, import.meta.url), "utf-8");
-// to modify the runtime, outcomment the export const jsdocRuntime line
-export const jsdocRuntime = `
-
-/**
- * The project's base locale.
- *
- * @example
- *   if (locale === baseLocale) {
- *     // do something
- *   }
- */
-export const baseLocale = "<replace>";
-
-/**
- * The project's locales that have been specified in the settings.
- *
- * @example
- *   if (locales.includes(userSelectedLocale) === false) {
- *     throw new Error('Locale is not available');
- *   }
- */
-export const locales = /** @type {const} */ (["<replace>"]);
-
-/**
- * This is a default implementation that is almost always
- * overwritten by \`defineGetLocale()\` and \`defineSetLocale()\`.
- *
- * @type {Locale}
- */
-let _locale = baseLocale;
-
-/**
- * Define the \`getLocale()\` function.
- *
- * Use this function to define how the locale is resolved. For example,
- * you can resolve the locale from the browser's preferred language,
- * a cookie, env variable, or a user's preference.
- *
- * @example
- *   defineGetLocale(() => {
- *     // resolve the locale from a cookie. fallback to the base locale.
- *     return Cookies.get('locale') ?? baseLocale
- *   }
- *
- * @param {() => Locale} fn
- * @type {(fn: () => Locale) => void}
- */
-export const defineGetLocale = (fn) => {
-	getLocale = fn;
-};
-
-/**
- * Define the \`setLocale()\` function.
- *
- * Use this function to define how the locale is set. For example,
- * modify a cookie, env variable, or a user's preference.
- *
- * @example
- *   defineSetLocale((newLocale) => {
- *     // set the locale in a cookie
- *     return Cookies.set('locale', newLocale)
- *   });
- *
- * @param {(newLocale: Locale) => void} fn
- */
-export const defineSetLocale = (fn) => {
-	setLocale = fn;
-};
-
-/**
- * Get the current locale.
- *
- * @example
- *   if (getLocale() === 'de') {
- *     console.log('Germany 🇩🇪');
- *   } else if (getLocale() === 'nl') {
- *     console.log('Netherlands 🇳🇱');
- *   }
- *
- * @type {() => Locale}
- */
-export let getLocale =
-	/** default implementation likely overwritten by \`defineGetLocale()\` */ () =>
-		_locale;
-
-/**
- * Set the locale.
- *
- * @example
- *   setLocale('en');
- *
- * @param {Locale} newLocale
- * @type {(newLocale: Locale) => void}
- */
-export let setLocale =
-	/** default implementation likely overwritten by \`defineSetLocale()\` */ (
-		newLocale
-	) => {
-		_locale = newLocale;
-	};
-
-${injectCode("./is-locale.js")}
-
-${injectCode("./assert-is-locale.js")}
-
-${injectCode("./locale-in-path.js")}
-
-${injectCode("./localize-path.js")}
-
-${injectCode("./de-localize-path.js")}
-
-// ------ TYPES ------
-
-/**
- * A locale that is available in the project.
- *
- * @example
- *   setLocale(request.locale as Locale)
- *
- * @typedef {(typeof locales)[number]} Locale
- */
-
-`;

package/dist/compiler/runtime/locale-in-path.d.ts

@@ -1,13 +0,0 @@
-/**
- * Extracts the locale from a given path.
- *
- * @example
- *   const path = '/en/home';
- *   const locale = localeInPath(path);
- *   console.log(locale); // 'en'
- *
- * @param {string} path - The path from which to extract the locale.
- * @returns {Locale|undefined} The extracted locale, or undefined if no locale is found.
- */
-export function localeInPath(path: string): Locale | undefined;
-//# sourceMappingURL=locale-in-path.d.ts.map

package/dist/compiler/runtime/locale-in-path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"locale-in-path.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/locale-in-path.js"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,mCAHW,MAAM,GACJ,MAAM,GAAC,SAAS,CAO5B"}

package/dist/compiler/runtime/locale-in-path.js

@@ -1,17 +0,0 @@
-/**
- * Extracts the locale from a given path.
- *
- * @example
- *   const path = '/en/home';
- *   const locale = localeInPath(path);
- *   console.log(locale); // 'en'
- *
- * @param {string} path - The path from which to extract the locale.
- * @returns {Locale|undefined} The extracted locale, or undefined if no locale is found.
- */
-export function localeInPath(path) {
-    const [, maybeLocale] = path.split("/");
-    if (isLocale(maybeLocale)) {
-        return maybeLocale;
-    }
-}

package/dist/compiler/runtime/locale-in-path.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=locale-in-path.test.d.ts.map

package/dist/compiler/runtime/locale-in-path.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"locale-in-path.test.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/locale-in-path.test.ts"],"names":[],"mappings":""}

package/dist/compiler/runtime/locale-in-path.test.js

@@ -1,22 +0,0 @@
-import { test, expect, vi, describe, afterEach } from "vitest";
-import { localeInPath } from "./locale-in-path.js";
-// sequential to avoid global variable conflicts
-describe.sequential("", () => {
-    afterEach(() => {
-        vi.resetAllMocks();
-    });
-    test("returns the locale from the path", () => {
-        // @ts-expect-error - global variable definition
-        globalThis.isLocale = vi.fn().mockReturnValue(true);
-        const path = "/en-US/about";
-        const locale = localeInPath(path);
-        expect(locale).toBe("en-US");
-    });
-    test("returns undefined if isLocale is false", () => {
-        // @ts-expect-error - global variable definition
-        globalThis.isLocale = vi.fn().mockReturnValue(false);
-        const path = "/en-US/about";
-        const locale = localeInPath(path);
-        expect(locale).toBe(undefined);
-    });
-});

package/dist/compiler/runtime/localized-path.d.ts

@@ -1,32 +0,0 @@
-/**
- * Localizes the given path.
- *
- * This function is useful if you use localized (i18n) routing
- * in your application.
- *
- * Defaults to `getLocale()` if no locale is provided.
- *
- * @tip
- *   Use `deLocalizedPath()` for the inverse operation.
- *
- * @example
- *  // getLocale() = 'en'
- *  localizedPath('/home'));
- *  // '/de/home'
- *
- *  // enforcing a specific locale
- *  localizedPath('/home', { locale: 'fr' });
- *  // '/fr/home'
- *
- * @example
- *   <a href={localizedPath('/home')}>Home</a>
- *
- * @param {string} path
- * @param {Object} [options] - Optional parameters.
- * @param {Locale} [options.locale] - The locale to use for the path.
- * @returns {string}
- */
-export function localizedPath(path: string, options?: {
-    locale?: Locale;
-}): string;
-//# sourceMappingURL=localized-path.d.ts.map

package/dist/compiler/runtime/localized-path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"localized-path.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/localized-path.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,oCALW,MAAM,YAEd;IAAyB,MAAM,GAAvB,MAAM;CACd,GAAU,MAAM,CAgBlB"}

package/dist/compiler/runtime/localized-path.js

@@ -1,44 +0,0 @@
-/**
- * Localizes the given path.
- *
- * This function is useful if you use localized (i18n) routing
- * in your application.
- *
- * Defaults to `getLocale()` if no locale is provided.
- *
- * @tip
- *   Use `deLocalizedPath()` for the inverse operation.
- *
- * @example
- *  // getLocale() = 'en'
- *  localizedPath('/home'));
- *  // '/de/home'
- *
- *  // enforcing a specific locale
- *  localizedPath('/home', { locale: 'fr' });
- *  // '/fr/home'
- *
- * @example
- *   <a href={localizedPath('/home')}>Home</a>
- *
- * @param {string} path
- * @param {Object} [options] - Optional parameters.
- * @param {Locale} [options.locale] - The locale to use for the path.
- * @returns {string}
- */
-export function localizedPath(path, options) {
-    const locale = options?.locale ?? getLocale();
-    const hasLocale = getLocaleFromPath(path);
-    const pathWithoutLocale = hasLocale
-        ? "/" + path.split("/").slice(2).join("/")
-        : path;
-    if (locale === baseLocale) {
-        return pathWithoutLocale;
-    }
-    else if (path === "/" || pathWithoutLocale === "/") {
-        return `/${locale}`;
-    }
-    else {
-        return `/${locale}${pathWithoutLocale}`;
-    }
-}

package/dist/compiler/runtime/localized-path.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=localized-path.test.d.ts.map

package/dist/compiler/runtime/localized-path.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"localized-path.test.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/localized-path.test.ts"],"names":[],"mappings":""}

package/dist/compiler/runtime/localized-path.test.js

@@ -1,42 +0,0 @@
-import { test, vi, beforeEach, expect, describe } from "vitest";
-import { localizedPath } from "./localized-path.js";
-import { mockRuntime } from "./mock-runtime.js";
-// sequential to avoid global variable conflicts
-describe.sequential("", () => {
-    beforeEach(() => {
-        vi.resetAllMocks();
-    });
-    mockRuntime({
-        baseLocale: "en",
-        locales: ["en", "de"],
-    });
-    test("localizes the path based on the getLocale definition", () => {
-        // @ts-expect-error - global variable definition
-        globalThis.getLocale = vi.fn().mockReturnValue("de");
-        const path = "/about";
-        const l10nPath = localizedPath(path);
-        expect(l10nPath).toBe("/de/about");
-    });
-    test("keeps trailing slashes if provided", () => {
-        const path = "/about/";
-        const l10nPath = localizedPath(path, { locale: "de" });
-        expect(l10nPath).toBe("/de/about/");
-    });
-    test("adds no trailing slash for the root path", () => {
-        const path = "/";
-        const l10nPath = localizedPath(path, { locale: "de" });
-        expect(l10nPath).toBe("/de");
-    });
-    test("removes the base locale from the path", () => {
-        // @ts-expect-error - global variable definition
-        globalThis.baseLocale = "en";
-        const path = "/de/about";
-        const l10nPath = localizedPath(path, { locale: "en" });
-        expect(l10nPath).toBe("/about");
-    });
-    test("does not add a slash suffix if it's the root path that is already localized", () => {
-        const path = "/de";
-        const l10nPath = localizedPath(path, { locale: "de" });
-        expect(l10nPath).toBe("/de");
-    });
-});

package/dist/compiler/runtime/mock-runtime.d.ts

@@ -1,6 +0,0 @@
-import type { Runtime } from "./type.js";
-export declare function mockRuntime({ baseLocale, locales }: {
-    baseLocale?: string | undefined;
-    locales?: string[] | undefined;
-}): Runtime;
-//# sourceMappingURL=mock-runtime.d.ts.map

package/dist/compiler/runtime/mock-runtime.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mock-runtime.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/mock-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAOzC,wBAAgB,WAAW,CAAC,EAAE,UAAiB,EAAE,OAAsB,EAAE;;;CAAA,WAqBxE"}

package/dist/compiler/runtime/mock-runtime.js

@@ -1,26 +0,0 @@
-import { localeInPath } from "./locale-in-path.js";
-import { localizePath } from "./localize-path.js";
-import { isLocale } from "./is-locale.js";
-import { deLocalizePath } from "./de-localize-path.js";
-import { assertIsLocale } from "./assert-is-locale.js";
-export function mockRuntime({ baseLocale = "en", locales = ["en", "de"] }) {
-    let locale = baseLocale;
-    const runtime = {
-        baseLocale,
-        locales,
-        isLocale,
-        assertIsLocale,
-        localeInPath,
-        localizePath: localizePath,
-        deLocalizePath: deLocalizePath,
-        defineGetLocale: (fn) => (runtime.getLocale = fn),
-        defineSetLocale: (fn) => (runtime.setLocale = fn),
-        setLocale: (newLocale) => (locale = newLocale),
-        getLocale: () => locale,
-    };
-    for (const [key, value] of Object.entries(runtime)) {
-        // @ts-expect-error - global variable definition
-        globalThis[key] = value;
-    }
-    return runtime;
-}

package/dist/compiler/runtime/ts-runtime.d.ts

@@ -1,2 +0,0 @@
-export declare const tsRuntime = "\n// @eslint-disable\n\n/**\n * The project's base locale.\n *\n * @example\n *   if (locale === baseLocale) {\n *     // do something\n *   }\n */\nexport const baseLocale = \"<replace>\";\n\n/**\n * The project's locales that have been specified in the settings.\n *\n * @example\n *   if (locales.includes(userSelectedLocale) === false) {\n *     throw new Error('Locale is not available');\n *   }\n */\nexport const locales = [\"<replace>\"] as const;\n\n/**\n * This is a default implementation that is almost always\n * overwritten by `defineGetLocale()` and `defineSetLocale()`.\n *\n */\nlet _locale: Locale = baseLocale;\n\n/**\n * Define the `getLocale()` function.\n *\n * Use this function to define how the locale is resolved. For example,\n * you can resolve the locale from the browser's preferred language,\n * a cookie, env variable, or a user's preference.\n *\n * @example\n *   defineGetLocale(() => {\n *     // resolve the locale from a cookie. fallback to the base locale.\n *     return Cookies.get('locale') ?? baseLocale\n *   }\n *\n */\nexport const defineGetLocale: (fn: () => Locale) => void = (fn) => {\n\tgetLocale = fn;\n};\n\n/**\n * Define the `setLocale()` function.\n *\n * Use this function to define how the locale is set. For example,\n * modify a cookie, env variable, or a user's preference.\n *\n * @example\n *   defineSetLocale((newLocale) => {\n *     // set the locale in a cookie\n *     return Cookies.set('locale', newLocale)\n *   });\n *\n */\nexport const defineSetLocale: (fn: (newLocale: Locale) => void) => void = (\n\tfn\n) => {\n\tsetLocale = fn;\n};\n\n/**\n * Get the current locale.\n *\n * @example\n *   if (getLocale() === 'de') {\n *     console.log('Germany \uD83C\uDDE9\uD83C\uDDEA');\n *   } else if (getLocale() === 'nl') {\n *     console.log('Netherlands \uD83C\uDDF3\uD83C\uDDF1');\n *   }\n *\n */\nexport let getLocale: () => Locale =\n\t/** default implementation likely overwritten by `defineGetLocale()` */ () =>\n\t\t_locale;\n\n/**\n * Set the locale.\n *\n * @example\n *   setLocale('en');\n */\nexport let setLocale: (newLocale: Locale) => void = (newLocale) => {\n\t/** default implementation likely overwritten by `defineSetLocale()` */\n\t_locale = newLocale;\n};\n\n/**\n * Check if something is an available locale.\n *\n * @example\n *   if (isLocale(params.locale)) {\n *     setLocale(params.locale);\n *   } else {\n *     setLocale('en');\n *   }\n */\nexport function isLocale(locale: any): locale is Locale {\n\treturn locales.includes(locale);\n}\n\n// ------ TYPES ------\n\n/**\n * A locale that is available in the project.\n *\n * @example\n *   setLocale(request.locale as Locale)\n *\n */\nexport type Locale = (typeof locales)[number];\n";
-//# sourceMappingURL=ts-runtime.d.ts.map

package/dist/compiler/runtime/ts-runtime.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ts-runtime.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/ts-runtime.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,yrFAqHrB,CAAC"}

package/dist/compiler/runtime/ts-runtime.js

@@ -1,119 +0,0 @@
-// to modify the runtime, outcomment the export const jsdocRuntime line
-export const tsRuntime = `
-// @eslint-disable
-
-/**
- * The project's base locale.
- *
- * @example
- *   if (locale === baseLocale) {
- *     // do something
- *   }
- */
-export const baseLocale = "<replace>";
-
-/**
- * The project's locales that have been specified in the settings.
- *
- * @example
- *   if (locales.includes(userSelectedLocale) === false) {
- *     throw new Error('Locale is not available');
- *   }
- */
-export const locales = ["<replace>"] as const;
-
-/**
- * This is a default implementation that is almost always
- * overwritten by \`defineGetLocale()\` and \`defineSetLocale()\`.
- *
- */
-let _locale: Locale = baseLocale;
-
-/**
- * Define the \`getLocale()\` function.
- *
- * Use this function to define how the locale is resolved. For example,
- * you can resolve the locale from the browser's preferred language,
- * a cookie, env variable, or a user's preference.
- *
- * @example
- *   defineGetLocale(() => {
- *     // resolve the locale from a cookie. fallback to the base locale.
- *     return Cookies.get('locale') ?? baseLocale
- *   }
- *
- */
-export const defineGetLocale: (fn: () => Locale) => void = (fn) => {
-	getLocale = fn;
-};
-
-/**
- * Define the \`setLocale()\` function.
- *
- * Use this function to define how the locale is set. For example,
- * modify a cookie, env variable, or a user's preference.
- *
- * @example
- *   defineSetLocale((newLocale) => {
- *     // set the locale in a cookie
- *     return Cookies.set('locale', newLocale)
- *   });
- *
- */
-export const defineSetLocale: (fn: (newLocale: Locale) => void) => void = (
-	fn
-) => {
-	setLocale = fn;
-};
-
-/**
- * Get the current locale.
- *
- * @example
- *   if (getLocale() === 'de') {
- *     console.log('Germany 🇩🇪');
- *   } else if (getLocale() === 'nl') {
- *     console.log('Netherlands 🇳🇱');
- *   }
- *
- */
-export let getLocale: () => Locale =
-	/** default implementation likely overwritten by \`defineGetLocale()\` */ () =>
-		_locale;
-
-/**
- * Set the locale.
- *
- * @example
- *   setLocale('en');
- */
-export let setLocale: (newLocale: Locale) => void = (newLocale) => {
-	/** default implementation likely overwritten by \`defineSetLocale()\` */
-	_locale = newLocale;
-};
-
-/**
- * Check if something is an available locale.
- *
- * @example
- *   if (isLocale(params.locale)) {
- *     setLocale(params.locale);
- *   } else {
- *     setLocale('en');
- *   }
- */
-export function isLocale(locale: any): locale is Locale {
-	return locales.includes(locale);
-}
-
-// ------ TYPES ------
-
-/**
- * A locale that is available in the project.
- *
- * @example
- *   setLocale(request.locale as Locale)
- *
- */
-export type Locale = (typeof locales)[number];
-`;