@inlang/paraglide-js
Version:
[](https://www.npmjs.com/package/@inlang/paraglide-js) [![GitHub Issues](https://img.shields.io/github/issues-closed/opral/paraglide-js?lo
95 lines • 3.93 kB
JavaScript
import { toLocale } from "./check-locale.js";
import { extractLocaleFromHeader } from "./extract-locale-from-header.js";
import { extractLocaleFromUrl } from "./extract-locale-from-url.js";
import { isCustomStrategy } from "./strategy.js";
import { baseLocale, cookieName, getStrategyForUrl, 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