@sebbro/paraglide-lite 0.1.0

package/dist/compiler/runtime/extract-locale-from-request-async.test.js

@@ -0,0 +1,119 @@
+import { expect, test } from "vitest";
+import { createParaglide } from "../create-paraglide.js";
+test("returns locale from custom strategy which is async", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["custom-header", "baseLocale"],
+    });
+    class FakeDB {
+        db = new Map();
+        constructor() {
+            this.db.set("1", "fr");
+        }
+        async getUserLocaleById(id) {
+            return this.db.get(id);
+        }
+    }
+    const db = new FakeDB();
+    async function getLocaleFromUserRequest(request) {
+        const userId = request?.headers.get("X-Custom-User-ID") ?? undefined;
+        if (!userId)
+            throw Error("No User ID");
+        const locale = await db.getUserLocaleById(userId);
+        return locale;
+    }
+    runtime.defineCustomServerStrategy("custom-header", {
+        getLocale: async (request) => (await getLocaleFromUserRequest(request)) ?? undefined,
+    });
+    const request = new Request("http://example.com", {
+        headers: {
+            "X-Custom-User-ID": "1",
+        },
+    });
+    const locale = await runtime.extractLocaleFromRequestAsync(request);
+    expect(locale).toBe("fr");
+});
+test("falls back to next strategy when custom strategy returns undefined", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["custom-fallback", "baseLocale"],
+    });
+    runtime.defineCustomServerStrategy("custom-fallback", {
+        getLocale: () => undefined,
+    });
+    const request = new Request("http://example.com");
+    const locale = await runtime.extractLocaleFromRequestAsync(request);
+    expect(locale).toBe("en"); // Should fall back to baseLocale
+});
+test("uses the provided public url for url strategy matching", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)?",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)?"],
+                    ["fr", "https://example.com/fr/:path(.*)?"],
+                ],
+            },
+        ],
+    });
+    const request = new Request("http://internal.example.com/en/home");
+    const locale = await runtime.extractLocaleFromRequestAsync(request, {
+        effectiveRequestUrl: "https://example.com/fr/home",
+    });
+    expect(locale).toBe("fr");
+});
+test("resolves relative effectiveRequestUrl strings against request.url", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)?",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)?"],
+                    ["fr", "https://example.com/fr/:path(.*)?"],
+                ],
+            },
+        ],
+    });
+    const request = new Request("https://example.com/en/home");
+    const locale = await runtime.extractLocaleFromRequestAsync(request, {
+        effectiveRequestUrl: "/fr/home",
+    });
+    expect(locale).toBe("fr");
+});
+test("uses normalized effectiveRequestUrl for route strategy selection", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)?",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)?"],
+                    ["fr", "https://example.com/fr/:path(.*)?"],
+                ],
+            },
+        ],
+        routeStrategies: [
+            {
+                match: "https://example.com/:path(.*)?",
+                strategy: ["url", "baseLocale"],
+            },
+        ],
+    });
+    const request = new Request("https://example.com/en/home");
+    const locale = await runtime.extractLocaleFromRequestAsync(request, {
+        effectiveRequestUrl: "/fr/home",
+    });
+    expect(locale).toBe("fr");
+});
+//# sourceMappingURL=extract-locale-from-request-async.test.js.map

package/dist/compiler/runtime/extract-locale-from-request-async.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-locale-from-request-async.test.js","sourceRoot":"","sources":["../../../src/compiler/runtime/extract-locale-from-request-async.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;IACrE,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QAC3B,QAAQ,EAAE,CAAC,eAAe,EAAE,YAAY,CAAC;KACzC,CAAC,CAAC;IACH,MAAM,MAAM;QACX,EAAE,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC/B;YACC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC;QAED,KAAK,CAAC,iBAAiB,CAAC,EAAU;YACjC,OAAO,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxB,CAAC;KACD;IAED,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CAAC;IACxB,KAAK,UAAU,wBAAwB,CAAC,OAAiB;QACxD,MAAM,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,SAAS,CAAC;QACrE,IAAI,CAAC,MAAM;YAAE,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,MAAM,CAAC;IACf,CAAC;IACD,OAAO,CAAC,0BAA0B,CAAC,eAAe,EAAE;QACnD,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC5B,CAAC,MAAM,wBAAwB,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS;KACvD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE;QACjD,OAAO,EAAE;YACR,kBAAkB,EAAE,GAAG;SACvB;KACD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;IACrF,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;QACrB,QAAQ,EAAE,CAAC,iBAAiB,EAAE,YAAY,CAAC;KAC3C,CAAC,CAAC;IAEH,OAAO,CAAC,0BAA0B,CAAC,iBAAiB,EAAE;QACrD,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS;KAC1B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,iCAAiC;AAC7D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;IACzE,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;QACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;QAC/B,WAAW,EAAE;YACZ;gBACC,OAAO,EAAE,gCAAgC;gBACzC,SAAS,EAAE;oBACV,CAAC,IAAI,EAAE,mCAAmC,CAAC;oBAC3C,CAAC,IAAI,EAAE,mCAAmC,CAAC;iBAC3C;aACD;SACD;KACD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qCAAqC,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,OAAO,EAAE;QACnE,mBAAmB,EAAE,6BAA6B;KAClD,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;IACpF,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;QACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;QAC/B,WAAW,EAAE;YACZ;gBACC,OAAO,EAAE,gCAAgC;gBACzC,SAAS,EAAE;oBACV,CAAC,IAAI,EAAE,mCAAmC,CAAC;oBAC3C,CAAC,IAAI,EAAE,mCAAmC,CAAC;iBAC3C;aACD;SACD;KACD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,OAAO,EAAE;QACnE,mBAAmB,EAAE,UAAU;KAC/B,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;IACnF,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC;QACrC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;QACrB,QAAQ,EAAE,CAAC,YAAY,CAAC;QACxB,WAAW,EAAE;YACZ;gBACC,OAAO,EAAE,gCAAgC;gBACzC,SAAS,EAAE;oBACV,CAAC,IAAI,EAAE,mCAAmC,CAAC;oBAC3C,CAAC,IAAI,EAAE,mCAAmC,CAAC;iBAC3C;aACD;SACD;QACD,eAAe,EAAE;YAChB;gBACC,KAAK,EAAE,gCAAgC;gBACvC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;aAC/B;SACD;KACD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,6BAA6B,CAAC,OAAO,EAAE;QACnE,mBAAmB,EAAE,UAAU;KAC/B,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC","sourcesContent":["import { expect, test } from \"vitest\";\nimport { createParaglide } from \"../create-paraglide.js\";\n\ntest(\"returns locale from custom strategy which is async\", async () => {\n\tconst runtime = await createParaglide({\n\t\tbaseLocale: \"en\",\n\t\tlocales: [\"en\", \"fr\", \"de\"],\n\t\tstrategy: [\"custom-header\", \"baseLocale\"],\n\t});\n\tclass FakeDB {\n\t\tdb = new Map<string, string>();\n\t\tconstructor() {\n\t\t\tthis.db.set(\"1\", \"fr\");\n\t\t}\n\n\t\tasync getUserLocaleById(id: string) {\n\t\t\treturn this.db.get(id);\n\t\t}\n\t}\n\n\tconst db = new FakeDB();\n\tasync function getLocaleFromUserRequest(request?: Request) {\n\t\tconst userId = request?.headers.get(\"X-Custom-User-ID\") ?? undefined;\n\t\tif (!userId) throw Error(\"No User ID\");\n\t\tconst locale = await db.getUserLocaleById(userId);\n\t\treturn locale;\n\t}\n\truntime.defineCustomServerStrategy(\"custom-header\", {\n\t\tgetLocale: async (request) =>\n\t\t\t(await getLocaleFromUserRequest(request)) ?? undefined,\n\t});\n\n\tconst request = new Request(\"http://example.com\", {\n\t\theaders: {\n\t\t\t\"X-Custom-User-ID\": \"1\",\n\t\t},\n\t});\n\n\tconst locale = await runtime.extractLocaleFromRequestAsync(request);\n\texpect(locale).toBe(\"fr\");\n});\n\ntest(\"falls back to next strategy when custom strategy returns undefined\", async () => {\n\tconst runtime = await createParaglide({\n\t\tbaseLocale: \"en\",\n\t\tlocales: [\"en\", \"fr\"],\n\t\tstrategy: [\"custom-fallback\", \"baseLocale\"],\n\t});\n\n\truntime.defineCustomServerStrategy(\"custom-fallback\", {\n\t\tgetLocale: () => undefined,\n\t});\n\n\tconst request = new Request(\"http://example.com\");\n\tconst locale = await runtime.extractLocaleFromRequestAsync(request);\n\texpect(locale).toBe(\"en\"); // Should fall back to baseLocale\n});\n\ntest(\"uses the provided public url for url strategy matching\", async () => {\n\tconst runtime = await createParaglide({\n\t\tbaseLocale: \"en\",\n\t\tlocales: [\"en\", \"fr\"],\n\t\tstrategy: [\"url\", \"baseLocale\"],\n\t\turlPatterns: [\n\t\t\t{\n\t\t\t\tpattern: \"https://example.com/:path(.*)?\",\n\t\t\t\tlocalized: [\n\t\t\t\t\t[\"en\", \"https://example.com/en/:path(.*)?\"],\n\t\t\t\t\t[\"fr\", \"https://example.com/fr/:path(.*)?\"],\n\t\t\t\t],\n\t\t\t},\n\t\t],\n\t});\n\n\tconst request = new Request(\"http://internal.example.com/en/home\");\n\tconst locale = await runtime.extractLocaleFromRequestAsync(request, {\n\t\teffectiveRequestUrl: \"https://example.com/fr/home\",\n\t});\n\n\texpect(locale).toBe(\"fr\");\n});\n\ntest(\"resolves relative effectiveRequestUrl strings against request.url\", async () => {\n\tconst runtime = await createParaglide({\n\t\tbaseLocale: \"en\",\n\t\tlocales: [\"en\", \"fr\"],\n\t\tstrategy: [\"url\", \"baseLocale\"],\n\t\turlPatterns: [\n\t\t\t{\n\t\t\t\tpattern: \"https://example.com/:path(.*)?\",\n\t\t\t\tlocalized: [\n\t\t\t\t\t[\"en\", \"https://example.com/en/:path(.*)?\"],\n\t\t\t\t\t[\"fr\", \"https://example.com/fr/:path(.*)?\"],\n\t\t\t\t],\n\t\t\t},\n\t\t],\n\t});\n\n\tconst request = new Request(\"https://example.com/en/home\");\n\tconst locale = await runtime.extractLocaleFromRequestAsync(request, {\n\t\teffectiveRequestUrl: \"/fr/home\",\n\t});\n\n\texpect(locale).toBe(\"fr\");\n});\n\ntest(\"uses normalized effectiveRequestUrl for route strategy selection\", async () => {\n\tconst runtime = await createParaglide({\n\t\tbaseLocale: \"en\",\n\t\tlocales: [\"en\", \"fr\"],\n\t\tstrategy: [\"baseLocale\"],\n\t\turlPatterns: [\n\t\t\t{\n\t\t\t\tpattern: \"https://example.com/:path(.*)?\",\n\t\t\t\tlocalized: [\n\t\t\t\t\t[\"en\", \"https://example.com/en/:path(.*)?\"],\n\t\t\t\t\t[\"fr\", \"https://example.com/fr/:path(.*)?\"],\n\t\t\t\t],\n\t\t\t},\n\t\t],\n\t\trouteStrategies: [\n\t\t\t{\n\t\t\t\tmatch: \"https://example.com/:path(.*)?\",\n\t\t\t\tstrategy: [\"url\", \"baseLocale\"],\n\t\t\t},\n\t\t],\n\t});\n\n\tconst request = new Request(\"https://example.com/en/home\");\n\tconst locale = await runtime.extractLocaleFromRequestAsync(request, {\n\t\teffectiveRequestUrl: \"/fr/home\",\n\t});\n\n\texpect(locale).toBe(\"fr\");\n});\n"]}

package/dist/compiler/runtime/extract-locale-from-request.d.ts

@@ -0,0 +1,41 @@
+import { strategy } from "./variables.js";
+export type ExtractLocaleFromRequestOptions = {
+    /**
+     * - Effective request URL to use for route matching and locale detection with the URL strategy.
+     */
+    effectiveRequestUrl?: string | URL;
+};
+/**
+ * @typedef {object} ExtractLocaleFromRequestOptions
+ * @property {string | URL} [effectiveRequestUrl] - Effective request URL to use for route matching and locale detection with the URL strategy.
+ */
+/**
+ * Extracts a locale from a request.
+ *
+ * Use the function on the server to extract the locale
+ * from a request.
+ *
+ * The function goes through the strategies in the order
+ * they are defined. If a strategy returns an invalid locale,
+ * it will fall back to the next strategy.
+ *
+ * Note: Custom server strategies are not supported in this synchronous version.
+ * Use `extractLocaleFromRequestAsync` if you need custom server strategies with async getLocale methods.
+ *
+ * @example
+ *   const locale = extractLocaleFromRequest(request);
+ *
+ * @param {Request} request
+ * @param {ExtractLocaleFromRequestOptions} [options]
+ * @returns {Locale}
+ */
+export declare const extractLocaleFromRequest: (request: Request, options?: ExtractLocaleFromRequestOptions) => Locale;
+/**
+ * Extracts a locale from a request using the provided strategy order.
+ *
+ * @param {Request} request
+ * @param {typeof strategy} strategies
+ * @param {string | URL} [url]
+ * @returns {Locale}
+ */
+export declare const extractLocaleFromRequestWithStrategies: (request: Request, strategies: typeof strategy, url?: string | URL) => Locale;

package/dist/compiler/runtime/extract-locale-from-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-locale-from-request.d.ts","sourceRoot":"","sources":["../../../src/compiler/runtime/extract-locale-from-request.js"],"names":[],"mappings":"AAKA,OAAO,EAGN,QAAQ,EAIR,MAAM,gBAAgB,CAAC;AAGrB,YAAkB,+BAA+B,GACjD;;;;IAA0B,mBAAmB,AAA7C,CACF,EADa,MAAM,GAAG,GAAG,CACzB;CAAA,CAAA;AAHD;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,wBAAwB,YAJ1B,OAAO,YACP,+BAA+B,KAC7B,MAYZ,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sCAAsC,YALxC,OAAO,cACP,OAAO,QAAQ,QACf,MAAM,GAAG,GAAG,KACV,MA+CZ,CAAC"}

package/dist/compiler/runtime/extract-locale-from-request.js

@@ -0,0 +1,96 @@
+import { toLocale } from "./check-locale.js";
+import { extractLocaleFromHeader } from "./extract-locale-from-header.js";
+import { extractLocaleFromUrl } from "./extract-locale-from-url.js";
+import { getStrategyForUrl } from "./route-strategy.js";
+import { isCustomStrategy } from "./strategy.js";
+import { baseLocale, cookieName, strategy, TREE_SHAKE_COOKIE_STRATEGY_USED, TREE_SHAKE_PREFERRED_LANGUAGE_STRATEGY_USED, TREE_SHAKE_URL_STRATEGY_USED, } from "./variables.js";
+/**
+ * @typedef {object} ExtractLocaleFromRequestOptions
+ * @property {string | URL} [effectiveRequestUrl] - Effective request URL to use for route matching and locale detection with the URL strategy.
+ */
+/**
+ * Extracts a locale from a request.
+ *
+ * Use the function on the server to extract the locale
+ * from a request.
+ *
+ * The function goes through the strategies in the order
+ * they are defined. If a strategy returns an invalid locale,
+ * it will fall back to the next strategy.
+ *
+ * Note: Custom server strategies are not supported in this synchronous version.
+ * Use `extractLocaleFromRequestAsync` if you need custom server strategies with async getLocale methods.
+ *
+ * @example
+ *   const locale = extractLocaleFromRequest(request);
+ *
+ * @param {Request} request
+ * @param {ExtractLocaleFromRequestOptions} [options]
+ * @returns {Locale}
+ */
+export const extractLocaleFromRequest = (request, options = {}) => {
+    const effectiveRequestUrl = resolveEffectiveRequestUrl(request, options.effectiveRequestUrl);
+    return extractLocaleFromRequestWithStrategies(request, getStrategyForUrl(effectiveRequestUrl), effectiveRequestUrl);
+};
+/**
+ * Extracts a locale from a request using the provided strategy order.
+ *
+ * @param {Request} request
+ * @param {typeof strategy} strategies
+ * @param {string | URL} [url]
+ * @returns {Locale}
+ */
+export const extractLocaleFromRequestWithStrategies = (request, strategies, url = request.url) => {
+    const effectiveRequestUrl = resolveEffectiveRequestUrl(request, url);
+    /** @type {string|undefined} */
+    let locale;
+    for (const strat of strategies) {
+        if (TREE_SHAKE_COOKIE_STRATEGY_USED && strat === "cookie") {
+            const cookiePrefix = cookieName + "=";
+            locale = request.headers
+                .get("cookie")
+                ?.split(";")
+                .map((c) => c.trim())
+                .find((c) => c.startsWith(cookiePrefix))
+                ?.slice(cookiePrefix.length);
+        }
+        else if (TREE_SHAKE_URL_STRATEGY_USED && strat === "url") {
+            locale = extractLocaleFromUrl(effectiveRequestUrl);
+        }
+        else if (TREE_SHAKE_PREFERRED_LANGUAGE_STRATEGY_USED &&
+            strat === "preferredLanguage") {
+            locale = extractLocaleFromHeader(request);
+        }
+        else if (strat === "globalVariable") {
+            locale = _locale;
+        }
+        else if (strat === "baseLocale") {
+            return baseLocale;
+        }
+        else if (strat === "localStorage") {
+            continue;
+        }
+        else if (isCustomStrategy(strat)) {
+            // Custom strategies are not supported in sync version
+            // Use extractLocaleFromRequestAsync for custom server strategies
+            continue;
+        }
+        const matchedLocale = toLocale(locale);
+        if (matchedLocale) {
+            return matchedLocale;
+        }
+    }
+    throw new Error("No locale found. There is an error in your strategy. Try adding 'baseLocale' as the very last strategy. Read more here https://paraglidejs.com/errors#no-locale-found");
+};
+/**
+ * @param {Request} request
+ * @param {string | URL | undefined} effectiveRequestUrl
+ * @returns {URL}
+ */
+function resolveEffectiveRequestUrl(request, effectiveRequestUrl = request.url) {
+    if (effectiveRequestUrl instanceof URL) {
+        return new URL(effectiveRequestUrl.href);
+    }
+    return new URL(effectiveRequestUrl, request.url);
+}
+//# sourceMappingURL=extract-locale-from-request.js.map

package/dist/compiler/runtime/extract-locale-from-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-locale-from-request.js","sourceRoot":"","sources":["../../../src/compiler/runtime/extract-locale-from-request.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EACN,UAAU,EACV,UAAU,EACV,QAAQ,EACR,+BAA+B,EAC/B,2CAA2C,EAC3C,4BAA4B,GAC5B,MAAM,gBAAgB,CAAC;AAExB;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;IACjE,MAAM,mBAAmB,GAAG,0BAA0B,CACrD,OAAO,EACP,OAAO,CAAC,mBAAmB,CAC3B,CAAC;IACF,OAAO,sCAAsC,CAC5C,OAAO,EACP,iBAAiB,CAAC,mBAAmB,CAAC,EACtC,mBAAmB,CACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACrD,OAAO,EACP,UAAU,EACV,GAAG,GAAG,OAAO,CAAC,GAAG,EAChB,EAAE;IACH,MAAM,mBAAmB,GAAG,0BAA0B,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACrE,+BAA+B;IAC/B,IAAI,MAAM,CAAC;IAEX,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAChC,IAAI,+BAA+B,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC3D,MAAM,YAAY,GAAG,UAAU,GAAG,GAAG,CAAC;YAEtC,MAAM,GAAG,OAAO,CAAC,OAAO;iBACtB,GAAG,CAAC,QAAQ,CAAC;gBACd,EAAE,KAAK,CAAC,GAAG,CAAC;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;iBACpB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;gBACxC,EAAE,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;aAAM,IAAI,4BAA4B,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YAC5D,MAAM,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QACpD,CAAC;aAAM,IACN,2CAA2C;YAC3C,KAAK,KAAK,mBAAmB,EAC5B,CAAC;YACF,MAAM,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,KAAK,KAAK,gBAAgB,EAAE,CAAC;YACvC,MAAM,GAAG,OAAO,CAAC;QAClB,CAAC;aAAM,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;YACnC,OAAO,UAAU,CAAC;QACnB,CAAC;aAAM,IAAI,KAAK,KAAK,cAAc,EAAE,CAAC;YACrC,SAAS;QACV,CAAC;aAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACpC,sDAAsD;YACtD,iEAAiE;YACjE,SAAS;QACV,CAAC;QACD,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,aAAa,EAAE,CAAC;YACnB,OAAO,aAAa,CAAC;QACtB,CAAC;IACF,CAAC;IACD,MAAM,IAAI,KAAK,CACd,uKAAuK,CACvK,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,SAAS,0BAA0B,CAClC,OAAO,EACP,mBAAmB,GAAG,OAAO,CAAC,GAAG;IAEjC,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACxC,OAAO,IAAI,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC","sourcesContent":["import { toLocale } from \"./check-locale.js\";\nimport { extractLocaleFromHeader } from \"./extract-locale-from-header.js\";\nimport { extractLocaleFromUrl } from \"./extract-locale-from-url.js\";\nimport { getStrategyForUrl } from \"./route-strategy.js\";\nimport { isCustomStrategy } from \"./strategy.js\";\nimport {\n\tbaseLocale,\n\tcookieName,\n\tstrategy,\n\tTREE_SHAKE_COOKIE_STRATEGY_USED,\n\tTREE_SHAKE_PREFERRED_LANGUAGE_STRATEGY_USED,\n\tTREE_SHAKE_URL_STRATEGY_USED,\n} from \"./variables.js\";\n\n/**\n * @typedef {object} ExtractLocaleFromRequestOptions\n * @property {string | URL} [effectiveRequestUrl] - Effective request URL to use for route matching and locale detection with the URL strategy.\n */\n\n/**\n * Extracts a locale from a request.\n *\n * Use the function on the server to extract the locale\n * from a request.\n *\n * The function goes through the strategies in the order\n * they are defined. If a strategy returns an invalid locale,\n * it will fall back to the next strategy.\n *\n * Note: Custom server strategies are not supported in this synchronous version.\n * Use `extractLocaleFromRequestAsync` if you need custom server strategies with async getLocale methods.\n *\n * @example\n *   const locale = extractLocaleFromRequest(request);\n *\n * @param {Request} request\n * @param {ExtractLocaleFromRequestOptions} [options]\n * @returns {Locale}\n */\nexport const extractLocaleFromRequest = (request, options = {}) => {\n\tconst effectiveRequestUrl = resolveEffectiveRequestUrl(\n\t\trequest,\n\t\toptions.effectiveRequestUrl\n\t);\n\treturn extractLocaleFromRequestWithStrategies(\n\t\trequest,\n\t\tgetStrategyForUrl(effectiveRequestUrl),\n\t\teffectiveRequestUrl\n\t);\n};\n\n/**\n * Extracts a locale from a request using the provided strategy order.\n *\n * @param {Request} request\n * @param {typeof strategy} strategies\n * @param {string | URL} [url]\n * @returns {Locale}\n */\nexport const extractLocaleFromRequestWithStrategies = (\n\trequest,\n\tstrategies,\n\turl = request.url\n) => {\n\tconst effectiveRequestUrl = resolveEffectiveRequestUrl(request, url);\n\t/** @type {string|undefined} */\n\tlet locale;\n\n\tfor (const strat of strategies) {\n\t\tif (TREE_SHAKE_COOKIE_STRATEGY_USED && strat === \"cookie\") {\n\t\t\tconst cookiePrefix = cookieName + \"=\";\n\n\t\t\tlocale = request.headers\n\t\t\t\t.get(\"cookie\")\n\t\t\t\t?.split(\";\")\n\t\t\t\t.map((c) => c.trim())\n\t\t\t\t.find((c) => c.startsWith(cookiePrefix))\n\t\t\t\t?.slice(cookiePrefix.length);\n\t\t} else if (TREE_SHAKE_URL_STRATEGY_USED && strat === \"url\") {\n\t\t\tlocale = extractLocaleFromUrl(effectiveRequestUrl);\n\t\t} else if (\n\t\t\tTREE_SHAKE_PREFERRED_LANGUAGE_STRATEGY_USED &&\n\t\t\tstrat === \"preferredLanguage\"\n\t\t) {\n\t\t\tlocale = extractLocaleFromHeader(request);\n\t\t} else if (strat === \"globalVariable\") {\n\t\t\tlocale = _locale;\n\t\t} else if (strat === \"baseLocale\") {\n\t\t\treturn baseLocale;\n\t\t} else if (strat === \"localStorage\") {\n\t\t\tcontinue;\n\t\t} else if (isCustomStrategy(strat)) {\n\t\t\t// Custom strategies are not supported in sync version\n\t\t\t// Use extractLocaleFromRequestAsync for custom server strategies\n\t\t\tcontinue;\n\t\t}\n\t\tconst matchedLocale = toLocale(locale);\n\t\tif (matchedLocale) {\n\t\t\treturn matchedLocale;\n\t\t}\n\t}\n\tthrow new Error(\n\t\t\"No locale found. There is an error in your strategy. Try adding 'baseLocale' as the very last strategy. Read more here https://paraglidejs.com/errors#no-locale-found\"\n\t);\n};\n\n/**\n * @param {Request} request\n * @param {string | URL | undefined} effectiveRequestUrl\n * @returns {URL}\n */\nfunction resolveEffectiveRequestUrl(\n\trequest,\n\teffectiveRequestUrl = request.url\n) {\n\tif (effectiveRequestUrl instanceof URL) {\n\t\treturn new URL(effectiveRequestUrl.href);\n\t}\n\n\treturn new URL(effectiveRequestUrl, request.url);\n}\n"]}

package/dist/compiler/runtime/extract-locale-from-request.test.d.ts

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

package/dist/compiler/runtime/extract-locale-from-request.test.d.ts.map

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

package/dist/compiler/runtime/extract-locale-from-request.test.js

@@ -0,0 +1,351 @@
+import { expect, test } from "vitest";
+import { createParaglide } from "../create-paraglide.js";
+test("returns the locale from the cookie", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["cookie"],
+        cookieName: "PARAGLIDE_LOCALE",
+    });
+    const request = new Request("http://example.com", {
+        headers: {
+            cookie: `PARAGLIDE_LOCALE=fr`,
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("fr");
+});
+test("returns the locale from a cookie header without whitespace after semicolons", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["cookie"],
+        cookieName: "PARAGLIDE_LOCALE",
+    });
+    const request = new Request("http://example.com", {
+        headers: {
+            cookie: `PARAGLIDE_LOCALE=fr;session=abc`,
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("fr");
+});
+test("returns the locale from the pathname for document requests", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)",
+                localized: [["en", "https://example.com/en/:path(.*)"]],
+            },
+        ],
+    });
+    const request = new Request("https://example.com/en/home", {
+        headers: {
+            "Sec-Fetch-Dest": "document",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("en");
+});
+test("uses the provided public url for url strategy matching", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)?",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)?"],
+                    ["fr", "https://example.com/fr/:path(.*)?"],
+                ],
+            },
+        ],
+    });
+    const request = new Request("http://internal.example.com/en/home", {
+        headers: {
+            "Sec-Fetch-Dest": "document",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request, {
+        effectiveRequestUrl: "https://example.com/fr/home",
+    });
+    expect(locale).toBe("fr");
+});
+test("resolves relative effectiveRequestUrl strings against request.url", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)?",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)?"],
+                    ["fr", "https://example.com/fr/:path(.*)?"],
+                ],
+            },
+        ],
+    });
+    const request = new Request("https://example.com/en/home", {
+        headers: {
+            "Sec-Fetch-Dest": "document",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request, {
+        effectiveRequestUrl: "/fr/home",
+    });
+    expect(locale).toBe("fr");
+});
+test("returns the baseLocale if no other strategy matches", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en"],
+        strategy: ["baseLocale"],
+    });
+    const request = new Request("http://example.com");
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("en");
+});
+test("throws an error if no locale is found", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en"],
+        strategy: ["cookie"],
+    });
+    const request = new Request("http://example.com");
+    expect(() => runtime.extractLocaleFromRequest(request)).toThrow("No locale found. There is an error in your strategy. Try adding 'baseLocale' as the very last strategy.");
+});
+test("returns the preferred locale from Accept-Language header", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["preferredLanguage", "baseLocale"],
+    });
+    // simple direct match
+    const request = new Request("http://example.com", {
+        headers: {
+            "Accept-Language": "en-US;q=0.8,fr;q=0.9,de;q=0.6",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("fr");
+    // language tag match
+    const request2 = new Request("http://example.com", {
+        headers: {
+            "Accept-Language": "en-US;q=0.8,nl;q=0.9,de;q=0.7",
+        },
+    });
+    const locale2 = runtime.extractLocaleFromRequest(request2);
+    // Since "nl" isn't in our locales, and "de" has the highest q-value after "nl"
+    expect(locale2).toBe("en");
+    // no match
+    const request3 = new Request("http://example.com", {
+        headers: {
+            "Accept-Language": "nl;q=0.9,es;q=0.6",
+        },
+    });
+    const locale3 = runtime.extractLocaleFromRequest(request3);
+    expect(locale3).toBe("en");
+});
+test("should fall back to next strategy when cookie contains invalid locale", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["cookie", "baseLocale"],
+        cookieName: "PARAGLIDE_LOCALE",
+    });
+    // Request with an invalid locale in cookie
+    const request = new Request("http://example.com", {
+        headers: {
+            cookie: `PARAGLIDE_LOCALE=invalid_locale`,
+        },
+    });
+    // Should fall back to baseLocale
+    expect(runtime.extractLocaleFromRequest(request)).toBe("en");
+});
+test("skips over localStorage strategy as it is not supported on the server", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["localStorage", "baseLocale"],
+    });
+    const request = new Request("http://example.com");
+    // expecting baseLocale
+    expect(runtime.extractLocaleFromRequest(request)).toBe("en");
+});
+test("resolves the locale from the url for all request types", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["url", "baseLocale"],
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)",
+                localized: [
+                    ["en", "https://example.com/en/:path(.*)"],
+                    ["fr", "https://example.com/fr/:path(.*)"],
+                ],
+            },
+        ],
+    });
+    // Non-document request should still use URL strategy
+    const request = new Request("https://example.com/fr/home", {
+        headers: {
+            "Sec-Fetch-Dest": "something",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("fr");
+});
+test("cookie strategy precedes URL strategy for API requests with wildcards", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["cookie", "url", "baseLocale"],
+        cookieName: "PARAGLIDE_LOCALE",
+        urlPatterns: [
+            {
+                pattern: "https://example.com/:path(.*)",
+                localized: [
+                    ["fr", "https://example.com/fr/:path(.*)"],
+                    ["de", "https://example.com/de/:path(.*)"],
+                    ["en", "https://example.com/:path(.*)"],
+                ],
+            },
+        ],
+    });
+    // API request with cookie should use cookie locale
+    const apiRequestWithCookie = new Request("https://example.com/api/data", {
+        headers: {
+            "Sec-Fetch-Dest": "empty",
+            cookie: "PARAGLIDE_LOCALE=de",
+        },
+    });
+    const apiLocale = runtime.extractLocaleFromRequest(apiRequestWithCookie);
+    expect(apiLocale).toBe("de");
+    // API request without cookie should fall back to URL strategy
+    const apiRequestNoMatch = new Request("https://example.com/api/data", {
+        headers: {
+            "Sec-Fetch-Dest": "empty",
+        },
+    });
+    const fallbackLocale = runtime.extractLocaleFromRequest(apiRequestNoMatch);
+    expect(fallbackLocale).toBe("en");
+});
+test("routeStrategies can override strategy order for matching routes", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "de"],
+        strategy: ["url", "cookie", "baseLocale"],
+        cookieName: "PARAGLIDE_LOCALE",
+        routeStrategies: [
+            {
+                match: "/dashboard/:path(.*)?",
+                strategy: ["cookie", "baseLocale"],
+            },
+        ],
+    });
+    const request = new Request("https://example.com/dashboard", {
+        headers: {
+            cookie: "PARAGLIDE_LOCALE=de",
+        },
+    });
+    expect(runtime.extractLocaleFromRequest(request)).toBe("de");
+});
+// https://github.com/opral/inlang-paraglide-js/issues/436
+test("preferredLanguage precedence over url", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "de"],
+        strategy: ["url", "preferredLanguage"],
+        urlPatterns: [
+            {
+                pattern: ":protocol://:domain(.*)::port??/:path(.*)?",
+                localized: [
+                    ["de", ":protocol://:domain(.*)::port?/de/:path(.*)?"],
+                    ["en", ":protocol://:domain(.*)::port?/en/:path(.*)?"],
+                ],
+            },
+        ],
+    });
+    // no locale in url, should use preferredLanguage
+    const request = new Request("https://example.com/home", {
+        headers: {
+            "Sec-Fetch-Dest": "document",
+            "Accept-Language": "de;q=0.9,en;q=0.8",
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("de");
+});
+test("sync version no longer supports custom strategies", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["custom-header", "baseLocale"],
+    });
+    // Define a custom strategy that extracts locale from a custom header
+    runtime.defineCustomServerStrategy("custom-header", {
+        getLocale: (request) => request?.headers.get("X-Custom-Locale") ?? undefined,
+    });
+    const request = new Request("http://example.com", {
+        headers: {
+            "X-Custom-Locale": "fr",
+        },
+    });
+    // Sync version skips custom strategies and falls back to baseLocale
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("en"); // baseLocale fallback
+});
+test("sync version skips custom strategy and falls back to next built-in strategy", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr"],
+        strategy: ["custom-fallback", "baseLocale"],
+    });
+    runtime.defineCustomServerStrategy("custom-fallback", {
+        getLocale: () => undefined,
+    });
+    const request = new Request("http://example.com");
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("en"); // Should fall back to baseLocale (skipping custom strategy)
+});
+test("sync version uses built-in strategies instead of custom strategies", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["custom-priority", "cookie", "baseLocale"],
+        cookieName: "PARAGLIDE_LOCALE",
+    });
+    runtime.defineCustomServerStrategy("custom-priority", {
+        getLocale: () => "de",
+    });
+    const request = new Request("http://example.com", {
+        headers: {
+            cookie: "PARAGLIDE_LOCALE=fr", // Cookie has different locale
+        },
+    });
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("fr"); // Should use cookie since custom strategy is skipped in sync version
+});
+test("sync version skips all custom strategies and uses baseLocale", async () => {
+    const runtime = await createParaglide({
+        baseLocale: "en",
+        locales: ["en", "fr", "de"],
+        strategy: ["custom-first", "custom-second", "baseLocale"],
+    });
+    runtime.defineCustomServerStrategy("custom-first", {
+        getLocale: () => undefined,
+    });
+    runtime.defineCustomServerStrategy("custom-second", {
+        getLocale: () => "fr",
+    });
+    const request = new Request("http://example.com");
+    const locale = runtime.extractLocaleFromRequest(request);
+    expect(locale).toBe("en"); // Should skip all custom strategies and use baseLocale
+});
+//# sourceMappingURL=extract-locale-from-request.test.js.map