@bleedingdev/modern-js-i18n-runtime-extensions 3.8.3-ultramodern.2

package/src/language-sync/react.ts

@@ -0,0 +1,227 @@
+import { getGlobalBasename } from '@modern-js/runtime/context';
+import LanguageDetector, {
+  type DetectorOptions,
+} from 'i18next-browser-languagedetector';
+import type React from 'react';
+import { useCallback, useEffect, useRef } from 'react';
+import {
+  createLatestLanguageSyncBinding,
+  type LanguageSyncFailure,
+  type LanguageSyncPolicy,
+} from './controller';
+
+export interface LatestLanguageSyncOptions<TTarget extends object> {
+  changeLanguage: (
+    target: TTarget,
+    language: string,
+  ) => PromiseLike<unknown> | unknown;
+  commitLanguage: (target: TTarget, language: string) => void;
+  desiredLanguage?: string;
+  enabled?: boolean;
+  policy?: LanguageSyncPolicy;
+  readLanguage?: (target: TTarget) => string | undefined;
+  reportFailure?: (failure: LanguageSyncFailure) => void;
+  target?: TTarget;
+}
+
+export const useLatestLanguageSync = <TTarget extends object>({
+  changeLanguage,
+  commitLanguage,
+  desiredLanguage,
+  enabled = true,
+  policy,
+  readLanguage,
+  reportFailure,
+  target,
+}: LatestLanguageSyncOptions<TTarget>) => {
+  const bindingRef = useRef<ReturnType<
+    typeof createLatestLanguageSyncBinding<TTarget>
+  > | null>(null);
+  if (bindingRef.current === null) {
+    // Binding construction is deliberately inert. Shared coordinator state is
+    // touched only by the commit-phase activation effect below.
+    bindingRef.current = createLatestLanguageSyncBinding<TTarget>(policy);
+  }
+  const binding = bindingRef.current;
+
+  useEffect(() => {
+    binding.updateCallbacks({
+      changeLanguage,
+      commitLanguage,
+      readLanguage,
+      reportFailure,
+    });
+  });
+
+  useEffect(() => {
+    if (!enabled || !target) {
+      return;
+    }
+    binding.activate(target);
+    return () => binding.deactivate();
+  }, [binding, enabled, target]);
+
+  useEffect(() => {
+    if (!enabled || !target || !desiredLanguage) {
+      binding.clearRequest();
+      return;
+    }
+    binding.request(desiredLanguage);
+  }, [binding, desiredLanguage, enabled, target]);
+
+  useEffect(() => {
+    if (
+      !enabled ||
+      !target ||
+      !desiredLanguage ||
+      typeof window === 'undefined'
+    ) {
+      return;
+    }
+    const retryCurrentIntent = () => binding.request(desiredLanguage);
+    const retryVisibleIntent = () => {
+      if (document.visibilityState === 'visible') {
+        retryCurrentIntent();
+      }
+    };
+    window.addEventListener('online', retryCurrentIntent);
+    document.addEventListener('visibilitychange', retryVisibleIntent);
+    return () => {
+      window.removeEventListener('online', retryCurrentIntent);
+      document.removeEventListener('visibilitychange', retryVisibleIntent);
+    };
+  }, [binding, desiredLanguage, enabled, target]);
+
+  return useCallback(
+    (language: string) => binding.request(language),
+    [binding],
+  );
+};
+
+interface LanguageDetectorLike {
+  cacheUserLanguage?: (language: string) => void;
+}
+
+export interface I18nLanguageSyncInstance {
+  changeLanguage?: (language?: string) => PromiseLike<unknown> | unknown;
+  i18nInstance?: { instance?: I18nLanguageSyncInstance };
+  isInitialized?: boolean;
+  language: string;
+  options?: { detection?: unknown };
+  services?: {
+    languageDetector?: LanguageDetectorLike;
+  };
+  setLang?: (language: string) => PromiseLike<unknown> | unknown;
+}
+
+const actualInstance = (instance: I18nLanguageSyncInstance) =>
+  instance.i18nInstance?.instance ?? instance;
+
+const cacheLanguage = (
+  instance: I18nLanguageSyncInstance,
+  language: string,
+) => {
+  if (typeof window === 'undefined') {
+    return;
+  }
+  const actual = actualInstance(instance);
+  const detector =
+    actual.services?.languageDetector ?? instance.services?.languageDetector;
+  try {
+    if (detector?.cacheUserLanguage) {
+      detector.cacheUserLanguage(language);
+      return;
+    }
+    if (instance.isInitialized || actual.isInitialized) {
+      const services = actual.services ?? instance.services;
+      const options = actual.options ?? instance.options;
+      if (services && options) {
+        const manualDetector = new LanguageDetector();
+        manualDetector.init(
+          services,
+          (instance.options?.detection ?? options.detection) as
+            | DetectorOptions
+            | undefined,
+        );
+        manualDetector.cacheUserLanguage?.(language);
+      }
+    }
+  } catch {
+    // Caching is a best-effort side effect; synchronization already committed.
+  }
+};
+
+const detectPathLanguage = (
+  pathname: string | undefined,
+  languages: string[],
+) => {
+  if (!pathname) {
+    return undefined;
+  }
+  const basename = getGlobalBasename();
+  const entryPath = basename && basename !== '/' ? basename : '';
+  const relativePath = pathname.startsWith(entryPath)
+    ? pathname.slice(entryPath.length)
+    : pathname;
+  const segments = relativePath.split('/').filter(Boolean);
+  const segmentsToCheck =
+    !entryPath &&
+    segments.length > 1 &&
+    segments[0] &&
+    !languages.includes(segments[0])
+      ? segments.slice(1)
+      : segments;
+  const language = segmentsToCheck[0];
+  return language && languages.includes(language) ? language : undefined;
+};
+
+/**
+ * Compatibility-shaped adapter for the Modern.js i18n provider. The shared
+ * coordinator is fork-owned; the upstream hook remains available to direct
+ * internal consumers until the equivalent shrink can be upstreamed.
+ */
+export function useLanguageSync<TInstance extends I18nLanguageSyncInstance>(
+  i18nInstance: TInstance | undefined,
+  localePathRedirect: boolean,
+  languages: string[],
+  pathname: string | undefined,
+  prevLangRef: React.MutableRefObject<string>,
+  setLang: (language: string) => void,
+) {
+  const desiredLanguage = localePathRedirect
+    ? detectPathLanguage(pathname, languages)
+    : undefined;
+  const synchronizeLanguage = useLatestLanguageSync({
+    target: i18nInstance,
+    desiredLanguage,
+    enabled: Boolean(i18nInstance && localePathRedirect),
+    readLanguage: instance => instance.language,
+    changeLanguage: (instance, language) =>
+      instance.setLang
+        ? instance.setLang(language)
+        : instance.changeLanguage?.(language),
+    commitLanguage: (instance, language) => {
+      prevLangRef.current = language;
+      setLang(language);
+      cacheLanguage(instance, language);
+    },
+    reportFailure: ({ error, language }) => {
+      console.error(
+        `Failed to synchronize i18n language "${language}".`,
+        error,
+      );
+    },
+  });
+
+  useEffect(() => {
+    if (!localePathRedirect && i18nInstance?.language) {
+      const instanceLanguage = i18nInstance.language;
+      if (instanceLanguage !== prevLangRef.current) {
+        prevLangRef.current = instanceLanguage;
+        setLang(instanceLanguage);
+      }
+    }
+  }, [i18nInstance, localePathRedirect, prevLangRef, setLang]);
+
+  return synchronizeLanguage;
+}

package/src/localisedUrls/config.ts

@@ -0,0 +1,18 @@
+import type { LocalisedUrlsOption, ResolvedLocalisedUrlsConfig } from './types';
+
+/**
+ * Localised URLs are strictly opt-in: only an explicit, non-empty map enables
+ * route expansion and validation. `true`, `false`, an empty map and absence
+ * all resolve to disabled, so upstream-style configs (`localePathRedirect` +
+ * `languages` without a map) keep plain locale-prefix behavior instead of
+ * failing the build for every route missing from a map they never wrote.
+ */
+export const resolveLocalisedUrlsConfig = (
+  option: LocalisedUrlsOption | undefined,
+): ResolvedLocalisedUrlsConfig => {
+  if (option && typeof option === 'object' && Object.keys(option).length > 0) {
+    return { enabled: true, map: option };
+  }
+
+  return { enabled: false, map: {} };
+};

package/src/localisedUrls/index.ts

@@ -0,0 +1,24 @@
+export { resolveLocalisedUrlsConfig } from './config';
+export { normalisePathname, normalisePathPattern } from './normalise';
+export {
+  canonicalTargetPathname,
+  localiseTargetPathname,
+  stripLanguagePrefix,
+} from './pathname';
+export { buildPathFromPattern, matchPathPattern } from './patterns';
+export type { LocaleRedirectSkipRule } from './redirect';
+export {
+  DEFAULT_LOCALE_REDIRECT_SKIP_RULES,
+  isDefaultLocaleRedirectSkipPath,
+  matchesPathPrefix,
+  shouldSkipLocaleRedirect,
+} from './redirect';
+export { resolveCanonicalLocalisedPath, resolveLocalisedPath } from './resolve';
+export { applyLocalisedUrlsToRoutes, validateLocalisedUrls } from './routes';
+export type {
+  LocalisedRoute,
+  LocalisedUrlPathMap,
+  LocalisedUrlsMap,
+  LocalisedUrlsOption,
+  ResolvedLocalisedUrlsConfig,
+} from './types';

package/src/localisedUrls/normalise.ts

@@ -0,0 +1,62 @@
+const LOCALE_PARAM_NAMES = new Set(['lang', 'locale', 'language']);
+
+const normaliseSlashes = (path: string): string => {
+  const withoutDuplicateSlashes = path.replace(/\/+/g, '/');
+  const withLeadingSlash = withoutDuplicateSlashes.startsWith('/')
+    ? withoutDuplicateSlashes
+    : `/${withoutDuplicateSlashes}`;
+
+  return withLeadingSlash.length > 1
+    ? withLeadingSlash.replace(/\/+$/, '')
+    : withLeadingSlash;
+};
+
+export const normalisePathPattern = (path: string): string =>
+  normaliseSlashes(path).replace(/\[(.+?)\]/g, ':$1');
+
+/**
+ * Normalise a concrete request pathname: slash cleanup only. Unlike
+ * {@link normalisePathPattern} it must not rewrite literal `[x]` segments to
+ * `:x` params — pathnames are values, not patterns.
+ */
+export const normalisePathname = (pathname: string): string =>
+  normaliseSlashes(pathname);
+
+export const normaliseRoutePath = (path: string): string => {
+  const normalized = normalisePathPattern(path);
+  return normalized === '/' ? '' : normalized.slice(1);
+};
+
+const getLocaleParamSegment = (segment: string): string | null => {
+  if (!segment.startsWith(':')) {
+    return null;
+  }
+
+  const paramName = segment.slice(1).replace(/\?$/, '');
+  return LOCALE_PARAM_NAMES.has(paramName) ? segment : null;
+};
+
+const splitPathSegments = (path?: string): string[] => {
+  if (!path) {
+    return [];
+  }
+
+  return normalisePathPattern(path).split('/').filter(Boolean);
+};
+
+export const stripLeadingLocaleParam = (path?: string): string | undefined => {
+  const segments = splitPathSegments(path);
+  const leadingLocaleParam = getLocaleParamSegment(segments[0] || '');
+
+  if (!leadingLocaleParam) {
+    return path;
+  }
+
+  const remainingPath = segments.slice(1).join('/');
+  return remainingPath ? `/${remainingPath}` : undefined;
+};
+
+export const getLeadingLocaleParam = (path?: string): string | null => {
+  const segments = splitPathSegments(path);
+  return getLocaleParamSegment(segments[0] || '');
+};

package/src/localisedUrls/pathname.ts

@@ -0,0 +1,60 @@
+import { resolveLocalisedUrlsConfig } from './config';
+
+import { resolveCanonicalLocalisedPath, resolveLocalisedPath } from './resolve';
+
+import type { LocalisedUrlsOption } from './types';
+
+export const stripLanguagePrefix = (
+  pathname: string,
+  languages: string[],
+): string => {
+  const segments = pathname.split('/').filter(Boolean);
+  const firstSegment = segments[0]?.toLowerCase();
+
+  if (
+    firstSegment &&
+    languages.some(language => language.toLowerCase() === firstSegment)
+  ) {
+    return `/${segments.slice(1).join('/')}`;
+  }
+
+  return pathname || '/';
+};
+
+export const localiseTargetPathname = (
+  pathname: string,
+  language: string,
+  languages: string[],
+  localisedUrls?: LocalisedUrlsOption,
+): string => {
+  const pathWithoutLanguage = stripLanguagePrefix(pathname, languages);
+  const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
+  const resolvedPath = localisedUrlsConfig.enabled
+    ? resolveLocalisedPath(
+        pathWithoutLanguage,
+        language,
+        languages,
+        localisedUrlsConfig.map,
+      )
+    : pathWithoutLanguage;
+  const resolvedSegments = resolvedPath.split('/').filter(Boolean);
+
+  return `/${[language, ...resolvedSegments].join('/')}`;
+};
+
+export const canonicalTargetPathname = (
+  pathname: string,
+  languages: string[],
+  localisedUrls?: LocalisedUrlsOption,
+): string => {
+  const pathWithoutLanguage = stripLanguagePrefix(pathname, languages);
+  const localisedUrlsConfig = resolveLocalisedUrlsConfig(localisedUrls);
+
+  return localisedUrlsConfig.enabled
+    ? resolveCanonicalLocalisedPath(
+        pathWithoutLanguage,
+        languages,
+        localisedUrlsConfig.map,
+      )
+    : pathWithoutLanguage;
+};

package/src/localisedUrls/patterns.ts

@@ -0,0 +1,283 @@
+import { normalisePathname, normalisePathPattern } from './normalise';
+
+const escapeRegExp = (value: string): string =>
+  value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
+const getParamName = (segment: string): string =>
+  segment.slice(1).replace(/\?$/, '');
+
+export const getOrderedPathParamSignature = (pattern: string): string[] =>
+  normalisePathPattern(pattern)
+    .split('/')
+    .filter(Boolean)
+    .flatMap(segment => {
+      if (segment === '*') {
+        return ['*'];
+      }
+      if (!segment.startsWith(':')) {
+        return [];
+      }
+
+      return [`:${getParamName(segment)}${segment.endsWith('?') ? '?' : ''}`];
+    });
+
+export const getPathParamSignature = (pattern: string): string[] =>
+  getOrderedPathParamSignature(pattern).sort((left, right) =>
+    left < right ? -1 : left > right ? 1 : 0,
+  );
+
+export const getPathPatternValidationIssue = (
+  pattern: string,
+): string | undefined => {
+  const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+  const seenParams = new Set<string>();
+
+  for (const [index, segment] of segments.entries()) {
+    if (segment === '*') {
+      if (index !== segments.length - 1) {
+        return 'splat parameter "*" must be the final segment';
+      }
+      if (seenParams.has('*')) {
+        return 'duplicate splat parameter "*"';
+      }
+      seenParams.add('*');
+      continue;
+    }
+    if (!segment.startsWith(':')) {
+      continue;
+    }
+
+    const paramName = getParamName(segment);
+    if (seenParams.has(paramName)) {
+      return `duplicate path parameter ":${paramName}"`;
+    }
+    seenParams.add(paramName);
+  }
+
+  return undefined;
+};
+
+export const getPhysicalPathPattern = (pattern: string): string => {
+  const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+  const physicalSegments = segments.map(segment => {
+    if (segment === '*') {
+      return '*';
+    }
+    if (segment.startsWith(':')) {
+      return segment.endsWith('?') ? ':param?' : ':param';
+    }
+    return segment;
+  });
+
+  return `/${physicalSegments.join('/')}`;
+};
+
+interface CompiledPathPattern {
+  names: string[];
+  regexp: RegExp;
+}
+
+const compiledPathPatternCache = new Map<string, CompiledPathPattern>();
+
+const compilePathPattern = (pattern: string): CompiledPathPattern => {
+  const normalizedPattern = normalisePathPattern(pattern);
+  const cached = compiledPathPatternCache.get(normalizedPattern);
+  if (cached) {
+    return cached;
+  }
+
+  const names: string[] = [];
+  const segments = normalizedPattern.split('/').filter(Boolean);
+  const source = segments
+    .map(segment => {
+      if (segment.startsWith(':')) {
+        names.push(getParamName(segment));
+        const paramPattern = '([^/]+)';
+        return segment.endsWith('?')
+          ? `(?:/${paramPattern})?`
+          : `/${paramPattern}`;
+      }
+      if (segment === '*') {
+        names.push('*');
+        return '(?:/(.*))?';
+      }
+      return `/${escapeRegExp(segment)}`;
+    })
+    .join('');
+
+  const compiled = {
+    names,
+    regexp: new RegExp(`^${source || '/'}$`),
+  };
+  compiledPathPatternCache.set(normalizedPattern, compiled);
+
+  return compiled;
+};
+
+const getPatternSpecificity = (pattern: string) => {
+  const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+  let staticSegments = 0;
+  let dynamicSegments = 0;
+  let optionalSegments = 0;
+  let splatSegments = 0;
+
+  for (const segment of segments) {
+    if (segment === '*') {
+      splatSegments++;
+    } else if (segment.startsWith(':')) {
+      dynamicSegments++;
+      if (segment.endsWith('?')) {
+        optionalSegments++;
+      }
+    } else {
+      staticSegments++;
+    }
+  }
+
+  return {
+    staticSegments,
+    dynamicSegments,
+    optionalSegments,
+    splatSegments,
+    totalSegments: segments.length,
+  };
+};
+
+const comparePatternSpecificity = (left: string, right: string): number => {
+  const a = getPatternSpecificity(left);
+  const b = getPatternSpecificity(right);
+
+  return (
+    b.staticSegments - a.staticSegments ||
+    a.splatSegments - b.splatSegments ||
+    a.optionalSegments - b.optionalSegments ||
+    b.totalSegments - a.totalSegments ||
+    a.dynamicSegments - b.dynamicSegments
+  );
+};
+
+export const haveEqualPatternSpecificity = (
+  left: string,
+  right: string,
+): boolean => comparePatternSpecificity(left, right) === 0;
+
+export const doPathPatternsOverlap = (left: string, right: string): boolean => {
+  const leftSegments = normalisePathPattern(left).split('/').filter(Boolean);
+  const rightSegments = normalisePathPattern(right).split('/').filter(Boolean);
+  if (leftSegments.length !== rightSegments.length) {
+    return false;
+  }
+
+  return leftSegments.every((leftSegment, index) => {
+    const rightSegment = rightSegments[index];
+    const leftIsDynamic = leftSegment === '*' || leftSegment.startsWith(':');
+    const rightIsDynamic = rightSegment === '*' || rightSegment.startsWith(':');
+    return leftIsDynamic || rightIsDynamic || leftSegment === rightSegment;
+  });
+};
+
+const comparePatternNames = (left: string, right: string): number => {
+  const normalizedLeft = normalisePathPattern(left);
+  const normalizedRight = normalisePathPattern(right);
+
+  return normalizedLeft < normalizedRight
+    ? -1
+    : normalizedLeft > normalizedRight
+      ? 1
+      : 0;
+};
+
+export const sortPatternsBySpecificity = <T extends { pattern: string }>(
+  patterns: T[],
+): T[] =>
+  patterns
+    .map((pattern, index) => ({ pattern, index }))
+    .sort(
+      (left, right) =>
+        comparePatternSpecificity(
+          left.pattern.pattern,
+          right.pattern.pattern,
+        ) ||
+        comparePatternNames(left.pattern.pattern, right.pattern.pattern) ||
+        left.index - right.index,
+    )
+    .map(({ pattern }) => pattern);
+
+/**
+ * `decodeURIComponent` throws `URIError` on malformed percent-encoding
+ * (e.g. `%E0%A4%A`), which attacker-controlled request URLs can carry.
+ * Treat such segments as undecodable instead of throwing.
+ */
+const decodePathParam = (value: string): string | null => {
+  try {
+    return decodeURIComponent(value);
+  } catch {
+    return null;
+  }
+};
+
+const encodeSplatParam = (value: string): string =>
+  value.split('/').map(encodeURIComponent).join('/');
+
+export const matchPathPattern = (
+  pathname: string,
+  pattern: string,
+): Record<string, string> | null => {
+  const { names, regexp } = compilePathPattern(pattern);
+  const match = regexp.exec(normalisePathname(pathname));
+  if (!match) {
+    return null;
+  }
+
+  const params: Record<string, string> = {};
+  for (let index = 0; index < names.length; index++) {
+    const decoded = decodePathParam(match[index + 1] || '');
+    if (decoded === null) {
+      // Malformed encoding cannot identify a localised route: no match.
+      return null;
+    }
+    Object.defineProperty(params, names[index], {
+      configurable: true,
+      enumerable: true,
+      value: decoded,
+      writable: true,
+    });
+  }
+
+  return params;
+};
+
+export const buildPathFromPattern = (
+  pattern: string,
+  params: Record<string, string>,
+): string => {
+  const segments = normalisePathPattern(pattern).split('/').filter(Boolean);
+  const path = segments
+    .map(segment => {
+      if (segment.startsWith(':')) {
+        const paramName = getParamName(segment);
+        const param = Object.hasOwn(params, paramName)
+          ? params[paramName]
+          : undefined;
+        if (param === undefined || param === '') {
+          if (segment.endsWith('?')) {
+            return '';
+          }
+          throw new Error(
+            `Missing required path parameter "${paramName}" for pattern "${normalisePathPattern(
+              pattern,
+            )}".`,
+          );
+        }
+        return encodeURIComponent(param);
+      }
+      if (segment === '*') {
+        return encodeSplatParam(params['*'] || '');
+      }
+      return segment;
+    })
+    .filter(Boolean)
+    .join('/');
+
+  return `/${path}`;
+};