remix-i18next
Version:
The easiest way to translate your Full Stack React Router apps
146 lines • 4.94 kB
JavaScript
import { getClientLocales } from "./get-client-locales.js";
import { pick } from "./parser.js";
/**
* The LanguageDetector contains the logic to detect the user preferred language
* fully server-side by using a SessionStorage, Cookie, URLSearchParams, or
* Headers.
*/
export class LanguageDetector {
options;
/**
* Create a language detector with the provided detection options.
*/
constructor(options) {
this.options = options;
this.isSessionOnly(options);
this.isCookieOnly(options);
}
/**
* Ensure session-only mode has a session storage configured.
*/
isSessionOnly(options) {
if (options.order?.length === 1 && options.order[0] === "session" && !options.sessionStorage) {
throw new Error("You need a sessionStorage if you want to only get the locale from the session");
}
}
/**
* Ensure cookie-only mode has a cookie configured.
*/
isCookieOnly(options) {
if (options.order?.length === 1 && options.order[0] === "cookie" && !options.cookie) {
throw new Error("You need a cookie if you want to only get the locale from the cookie");
}
}
/**
* Detect the best language for the current request.
*/
async detect(args) {
let order = this.options.order ?? this.defaultOrder;
for (let method of order) {
let locale = null;
if (method === "searchParams") {
locale = this.fromSearchParams(args.request);
}
if (method === "cookie") {
locale = await this.fromCookie(args.request);
}
if (method === "session") {
locale = await this.fromSessionStorage(args.request);
}
if (method === "header") {
locale = this.fromHeader(args.request);
}
if (method === "custom") {
locale = await this.fromCustom(args);
}
if (locale)
return locale;
}
return this.options.fallbackLanguage;
}
/**
* Build the default detection order.
*/
get defaultOrder() {
let order = [
"searchParams",
"cookie",
"session",
"header",
];
if (this.options.findLocale)
order.unshift("custom");
return order;
}
/**
* Read the locale from the URL search params.
*/
fromSearchParams(request) {
let url = new URL(request.url);
if (!url.searchParams.has(this.options.searchParamKey ?? "lng")) {
return null;
}
return this.fromSupported(url.searchParams.get(this.options.searchParamKey ?? "lng"));
}
/**
* Read the locale from a cookie.
*/
async fromCookie(request) {
if (!this.options.cookie)
return null;
let cookie = this.options.cookie;
let lng = await cookie.parse(request.headers.get("Cookie"));
if (typeof lng !== "string" || !lng)
return null;
return this.fromSupported(lng);
}
/**
* Read the locale from session storage.
*/
async fromSessionStorage(request) {
if (!this.options.sessionStorage)
return null;
let session = await this.options.sessionStorage.getSession(request.headers.get("Cookie"));
let lng = session.get(this.options.sessionKey ?? "lng");
if (!lng)
return null;
return this.fromSupported(lng);
}
/**
* Read the locale from the `Accept-Language` header.
*/
fromHeader(request) {
let locales = getClientLocales(request);
if (!locales)
return null;
if (Array.isArray(locales))
return this.fromSupported(locales.join(","));
return this.fromSupported(locales);
}
/**
* Read the locale from the custom locale finder.
*/
async fromCustom(args) {
if (!this.options.findLocale) {
throw new ReferenceError("You tried to find a locale using `findLocale` but it is not defined. Change your order to not include `custom` or provide a findLocale functions.");
}
let locales = await this.options.findLocale(args);
if (!locales)
return null;
if (Array.isArray(locales))
return this.fromSupported(locales.join(","));
return this.fromSupported(locales);
}
/**
* Match a locale against the configured supported languages.
*/
fromSupported(language) {
return (pick(this.options.supportedLanguages, language ?? this.options.fallbackLanguage, {
loose: false,
}) ||
pick(this.options.supportedLanguages, language ?? this.options.fallbackLanguage, {
loose: true,
}));
}
}
//# sourceMappingURL=language-detector.js.map