@intlayer/core 9.4.4 → 9.5.1

package/dist/esm/localization/getPrefix.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getPrefix.mjs","names":[],"sources":["../../../src/localization/getPrefix.ts"],"sourcesContent":["import { internationalization, routing } from '@intlayer/config/built';\nimport {\n  DEFAULT_LOCALE,\n  LOCALES,\n  ROUTING_MODE,\n} from '@intlayer/config/defaultValues';\nimport type { RewriteRules, RoutingConfig } from '@intlayer/types/config';\nimport type {\n  DeclaredLocales,\n  DomainRuleMap,\n  IsDomainExclusive,\n  LocalesValues,\n  ResolvedDefaultLocale,\n  ResolvedDomains,\n  ResolvedRoutingMode,\n} from '@intlayer/types/module_augmentation';\nimport { isLocaleExclusiveOnDomain } from './domainUtils';\n\n/**\n * Shared routing options used across all URL localization functions.\n */\nexport type RoutingOptions = {\n  locales?: LocalesValues[];\n  defaultLocale?: LocalesValues;\n  mode?: RoutingConfig['mode'];\n  rewrite?: RoutingConfig['rewrite'] | RewriteRules;\n  domains?: RoutingConfig['domains'];\n  /**\n   * The hostname of the page currently being rendered (e.g. `'intlayer.org'`).\n   * When provided, `getLocalizedUrl` returns a relative URL for locales whose\n   * configured domain matches `currentDomain`, and an absolute URL only when\n   * the target locale lives on a different domain.\n   *\n   * When omitted the function tries to infer it from:\n   *   1. The domain of an absolute input URL.\n   *   2. `window.location.hostname` in browser environments.\n   * Falls back to always generating absolute URLs when neither is available.\n   */\n  currentDomain?: string;\n};\n\n/**\n * Resolves routing configuration by merging provided options with configuration defaults.\n * Single source of truth for default routing config resolution across all localization functions.\n */\nexport const resolveRoutingConfig = (\n  options: RoutingOptions = {}\n): Omit<RoutingOptions, 'defaultLocale' | 'mode' | 'locales'> & {\n  defaultLocale: DeclaredLocales;\n  mode: RoutingConfig['mode'];\n  locales: DeclaredLocales[];\n} => ({\n  defaultLocale: internationalization?.defaultLocale ?? DEFAULT_LOCALE,\n  mode: routing?.mode ?? ROUTING_MODE,\n  locales: internationalization?.locales ?? LOCALES,\n  rewrite: routing?.rewrite,\n  domains: routing?.domains,\n  ...options,\n});\n\n/**\n * Narrows an arbitrary string to a declared locale by membership test.\n *\n * `locales` is typed as `DeclaredLocales[]`, so a plain `includes` rejects the\n * `string` values that actually need testing (a URL segment, a query param, a\n * stored value). This keeps the check honest and hands back a narrowed type\n * instead of forcing a cast at every call site.\n *\n * @param value - The candidate locale, from a URL segment / storage / header.\n * @param locales - The locales declared by the configuration.\n * @returns Whether `value` is one of the declared locales.\n */\nexport const isDeclaredLocale = (\n  value: LocalesValues | undefined | null,\n  locales?: readonly LocalesValues[]\n): value is DeclaredLocales =>\n  !!value && (locales ?? internationalization.locales).includes(value);\n\nexport type GetPrefixOptions = {\n  defaultLocale?: ResolvedDefaultLocale;\n  mode?: RoutingConfig['mode'];\n};\n\nexport type GetPrefixResult = {\n  /**\n   * The locale path segment appended to `/`, with a trailing slash (e.g. `'fr/'`).\n   * Empty string when no prefix is needed.\n   */\n  prefix: string;\n  /**\n   * The bare locale identifier (e.g. `'fr'`), or `undefined` when no prefix is applied.\n   */\n  localePrefix: DeclaredLocales | undefined;\n};\n\n/**\n * Narrowed return type for {@link getPrefix} that carries the locale literal through.\n *\n * Distributes over union locales — calling `getPrefix('fr')` in `prefix-no-default`\n * mode with `defaultLocale = 'en'` resolves to `{ prefix: 'fr/'; localePrefix: 'fr' }`.\n * A locale served from its own exclusive domain resolves to an empty prefix, as\n * the hostname already identifies it.\n *\n * Note: the \"locale not in locales\" edge case returns an empty result at runtime\n * regardless of what this type reports.\n */\nexport type GetPrefixResultNarrowed<\n  L extends LocalesValues | undefined,\n  Mode extends string = ResolvedRoutingMode,\n  Default extends LocalesValues = ResolvedDefaultLocale,\n  Domains extends DomainRuleMap = ResolvedDomains,\n> = L extends string\n  ? [string] extends [L] // L is wide (string / LocalesValues) → distribute over declared locales\n    ? GetPrefixResultNarrowed<DeclaredLocales, Mode, Default, Domains>\n    : IsDomainExclusive<L, Domains> extends true\n      ? { prefix: ''; localePrefix: undefined } // the domain identifies the locale\n      : [string] extends [Mode]\n        ? GetPrefixResult // mode is wide → fall back to generic result\n        : Mode extends 'prefix-all'\n          ? { prefix: `${L}/`; localePrefix: L }\n          : Mode extends 'prefix-no-default'\n            ? L extends Default\n              ? { prefix: ''; localePrefix: undefined }\n              : { prefix: `${L}/`; localePrefix: L }\n            : { prefix: ''; localePrefix: undefined } // no-prefix / search-params\n  : { prefix: ''; localePrefix: undefined }; // locale is undefined\n\n/**\n * Determines the URL prefix for a given locale based on the routing mode configuration.\n *\n * Example:\n *\n * ```ts\n *  // prefix-no-default mode with default locale\n *  getPrefix('en', { defaultLocale: 'en', mode: 'prefix-no-default' })\n *     // Returns { prefix: '', localePrefix: undefined }\n *\n *  // prefix-no-default mode with non-default locale\n *  getPrefix('fr', { defaultLocale: 'en', mode: 'prefix-no-default' })\n *     // Returns { prefix: '/fr', localePrefix: 'fr' }\n *\n *  // prefix-all mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'prefix-all' })\n *     // Returns { prefix: '/en', localePrefix: locale }\n *\n *  // search-params mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'search-params' })\n *     // Returns { prefix: '', localePrefix: undefined }\n *\n *  // no-prefix mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'no-prefix' })\n *     // Returns { prefix: '', localePrefix: undefined }\n * ```\n *\n * @param locale - The locale to check for prefix. If not provided, uses configured default locale.\n * @param options - Configuration options\n * @param options.defaultLocale - The default locale. Defaults to configured default locale.\n * @param options.mode - URL routing mode for locale handling. Defaults to configured mode.\n * @returns An object containing pathPrefix, prefix, and localePrefix for the given locale.\n */\nexport const getPrefix = <const L extends LocalesValues | undefined>(\n  locale: L,\n  options: RoutingOptions = {}\n): GetPrefixResultNarrowed<L> => {\n  const { defaultLocale, mode, locales, domains } =\n    resolveRoutingConfig(options);\n\n  if (\n    (process.env.INTLAYER_ROUTING_MODE &&\n      process.env.INTLAYER_ROUTING_MODE !== 'prefix-all' &&\n      process.env.INTLAYER_ROUTING_MODE !== 'prefix-no-default') ||\n    !locale ||\n    !isDeclaredLocale(locale, locales)\n  ) {\n    return {\n      prefix: '',\n      localePrefix: undefined,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  // If this locale is the only one assigned to its domain, no URL prefix is needed\n  // (the domain itself identifies the locale). Shared domains use normal prefix logic.\n  if (\n    process.env.INTLAYER_ROUTING_DOMAINS !== 'false' &&\n    isLocaleExclusiveOnDomain(locale as LocalesValues, domains)\n  ) {\n    return {\n      prefix: '',\n      localePrefix: undefined,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  // Handle prefix-based modes (prefix-all or prefix-no-default)\n  const shouldPrefix =\n    mode === 'prefix-all' ||\n    (mode === 'prefix-no-default' && defaultLocale !== locale);\n\n  if (shouldPrefix) {\n    return {\n      prefix: `${locale}/`,\n      localePrefix: locale as DeclaredLocales,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  return {\n    prefix: '',\n    localePrefix: undefined,\n  } as GetPrefixResultNarrowed<L>;\n};\n"],"mappings":";;;;;;;;;AA6CA,MAAa,wBACX,UAA0B,CAAC,OAKvB;CACJ,eAAe,sBAAsB,iBAAiB;CACtD,MAAM,SAAS,QAAQ;CACvB,SAAS,sBAAsB,WAAW;CAC1C,SAAS,SAAS;CAClB,SAAS,SAAS;CAClB,GAAG;AACL;;;;;;;;;;;;;AAcA,MAAa,oBACX,OACA,YAEA,CAAC,CAAC,UAAU,WAAW,qBAAqB,QAAO,CAAE,SAAS,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFrE,MAAa,aACX,QACA,UAA0B,CAAC,MACI;CAC/B,MAAM,EAAE,eAAe,MAAM,SAAS,YACpC,qBAAqB,OAAO;CAE9B,IACG,QAAQ,IAAI,yBACX,QAAQ,IAAI,0BAA0B,gBACtC,QAAQ,IAAI,0BAA0B,uBACxC,CAAC,UACD,CAAC,iBAAiB,QAAQ,OAAO,GAEjC,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;CAKF,IACE,QAAQ,IAAI,6BAA6B,WACzC,0BAA0B,QAAyB,OAAO,GAE1D,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;CAQF,IAHE,SAAS,gBACR,SAAS,uBAAuB,kBAAkB,QAGnD,OAAO;EACL,QAAQ,GAAG,OAAO;EAClB,cAAc;CAChB;CAGF,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;AACF"}
+{"version":3,"file":"getPrefix.mjs","names":[],"sources":["../../../src/localization/getPrefix.ts"],"sourcesContent":["import { internationalization, routing } from '@intlayer/config/built';\nimport {\n  DEFAULT_LOCALE,\n  LOCALES,\n  ROUTING_MODE,\n} from '@intlayer/config/defaultValues';\nimport type { RewriteRules, RoutingConfig } from '@intlayer/types/config';\nimport type {\n  DeclaredLocales,\n  DomainRuleMap,\n  IsDomainExclusive,\n  LocalesValues,\n  ResolvedDefaultLocale,\n  ResolvedDomains,\n  ResolvedRoutingMode,\n} from '@intlayer/types/module_augmentation';\nimport { isLocaleExclusiveOnDomain } from './domainUtils';\n\n/**\n * Shared routing options used across all URL localization functions.\n */\nexport type RoutingOptions = {\n  locales?: LocalesValues[];\n  defaultLocale?: LocalesValues;\n  mode?: RoutingConfig['mode'];\n  rewrite?: RoutingConfig['rewrite'] | RewriteRules;\n  domains?: RoutingConfig['domains'];\n  /**\n   * The hostname of the page currently being rendered (e.g. `'intlayer.org'`).\n   * When provided, `getLocalizedUrl` returns a relative URL for locales whose\n   * configured domain matches `currentDomain`, and an absolute URL only when\n   * the target locale lives on a different domain.\n   *\n   * When omitted the function tries to infer it from:\n   *   1. The domain of an absolute input URL.\n   *   2. `window.location.hostname` in browser environments.\n   * Falls back to always generating absolute URLs when neither is available.\n   */\n  currentDomain?: string;\n};\n\n/**\n * Resolves routing configuration by merging provided options with configuration defaults.\n * Single source of truth for default routing config resolution across all localization functions.\n */\nexport const resolveRoutingConfig = (\n  options: RoutingOptions = {}\n): Omit<RoutingOptions, 'defaultLocale' | 'mode' | 'locales'> & {\n  defaultLocale: DeclaredLocales;\n  mode: RoutingConfig['mode'];\n  locales: DeclaredLocales[];\n} => ({\n  ...options,\n  defaultLocale: (options.defaultLocale ??\n    internationalization?.defaultLocale ??\n    DEFAULT_LOCALE) as DeclaredLocales,\n  mode: options.mode ?? routing?.mode ?? ROUTING_MODE,\n  locales: (options.locales ??\n    internationalization?.locales ??\n    LOCALES) as DeclaredLocales[],\n  rewrite: options.rewrite ?? routing?.rewrite,\n  domains: options.domains ?? routing?.domains,\n});\n\n/**\n * Narrows an arbitrary string to a declared locale by membership test.\n *\n * `locales` is typed as `DeclaredLocales[]`, so a plain `includes` rejects the\n * `string` values that actually need testing (a URL segment, a query param, a\n * stored value). This keeps the check honest and hands back a narrowed type\n * instead of forcing a cast at every call site.\n *\n * @param value - The candidate locale, from a URL segment / storage / header.\n * @param locales - The locales declared by the configuration.\n * @returns Whether `value` is one of the declared locales.\n */\nexport const isDeclaredLocale = (\n  value: LocalesValues | undefined | null,\n  locales?: readonly LocalesValues[]\n): value is DeclaredLocales =>\n  !!value && (locales ?? internationalization.locales).includes(value);\n\nexport type GetPrefixOptions = {\n  defaultLocale?: ResolvedDefaultLocale;\n  mode?: RoutingConfig['mode'];\n};\n\nexport type GetPrefixResult = {\n  /**\n   * The locale path segment appended to `/`, with a trailing slash (e.g. `'fr/'`).\n   * Empty string when no prefix is needed.\n   */\n  prefix: string;\n  /**\n   * The bare locale identifier (e.g. `'fr'`), or `undefined` when no prefix is applied.\n   */\n  localePrefix: DeclaredLocales | undefined;\n};\n\n/**\n * Narrowed return type for {@link getPrefix} that carries the locale literal through.\n *\n * Distributes over union locales — calling `getPrefix('fr')` in `prefix-no-default`\n * mode with `defaultLocale = 'en'` resolves to `{ prefix: 'fr/'; localePrefix: 'fr' }`.\n * A locale served from its own exclusive domain resolves to an empty prefix, as\n * the hostname already identifies it.\n *\n * Note: the \"locale not in locales\" edge case returns an empty result at runtime\n * regardless of what this type reports.\n */\nexport type GetPrefixResultNarrowed<\n  L extends LocalesValues | undefined,\n  Mode extends string = ResolvedRoutingMode,\n  Default extends LocalesValues = ResolvedDefaultLocale,\n  Domains extends DomainRuleMap = ResolvedDomains,\n> = L extends string\n  ? [string] extends [L] // L is wide (string / LocalesValues) → distribute over declared locales\n    ? GetPrefixResultNarrowed<DeclaredLocales, Mode, Default, Domains>\n    : IsDomainExclusive<L, Domains> extends true\n      ? { prefix: ''; localePrefix: undefined } // the domain identifies the locale\n      : [string] extends [Mode]\n        ? GetPrefixResult // mode is wide → fall back to generic result\n        : Mode extends 'prefix-all'\n          ? { prefix: `${L}/`; localePrefix: L }\n          : Mode extends 'prefix-no-default'\n            ? L extends Default\n              ? { prefix: ''; localePrefix: undefined }\n              : { prefix: `${L}/`; localePrefix: L }\n            : { prefix: ''; localePrefix: undefined } // no-prefix / search-params\n  : { prefix: ''; localePrefix: undefined }; // locale is undefined\n\n/**\n * Determines the URL prefix for a given locale based on the routing mode configuration.\n *\n * Example:\n *\n * ```ts\n *  // prefix-no-default mode with default locale\n *  getPrefix('en', { defaultLocale: 'en', mode: 'prefix-no-default' })\n *     // Returns { prefix: '', localePrefix: undefined }\n *\n *  // prefix-no-default mode with non-default locale\n *  getPrefix('fr', { defaultLocale: 'en', mode: 'prefix-no-default' })\n *     // Returns { prefix: '/fr', localePrefix: 'fr' }\n *\n *  // prefix-all mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'prefix-all' })\n *     // Returns { prefix: '/en', localePrefix: locale }\n *\n *  // search-params mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'search-params' })\n *     // Returns { prefix: '', localePrefix: undefined }\n *\n *  // no-prefix mode\n *  getPrefix('en', { defaultLocale: 'en', mode: 'no-prefix' })\n *     // Returns { prefix: '', localePrefix: undefined }\n * ```\n *\n * @param locale - The locale to check for prefix. If not provided, uses configured default locale.\n * @param options - Configuration options\n * @param options.defaultLocale - The default locale. Defaults to configured default locale.\n * @param options.mode - URL routing mode for locale handling. Defaults to configured mode.\n * @returns An object containing pathPrefix, prefix, and localePrefix for the given locale.\n */\nexport const getPrefix = <const L extends LocalesValues | undefined>(\n  locale: L,\n  options: RoutingOptions = {}\n): GetPrefixResultNarrowed<L> => {\n  const { defaultLocale, mode, locales, domains } =\n    resolveRoutingConfig(options);\n\n  if (\n    (process.env.INTLAYER_ROUTING_MODE &&\n      process.env.INTLAYER_ROUTING_MODE !== 'prefix-all' &&\n      process.env.INTLAYER_ROUTING_MODE !== 'prefix-no-default') ||\n    !locale ||\n    !isDeclaredLocale(locale, locales)\n  ) {\n    return {\n      prefix: '',\n      localePrefix: undefined,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  // If this locale is the only one assigned to its domain, no URL prefix is needed\n  // (the domain itself identifies the locale). Shared domains use normal prefix logic.\n  if (\n    process.env.INTLAYER_ROUTING_DOMAINS !== 'false' &&\n    isLocaleExclusiveOnDomain(locale as LocalesValues, domains)\n  ) {\n    return {\n      prefix: '',\n      localePrefix: undefined,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  // Handle prefix-based modes (prefix-all or prefix-no-default)\n  const shouldPrefix =\n    mode === 'prefix-all' ||\n    (mode === 'prefix-no-default' && defaultLocale !== locale);\n\n  if (shouldPrefix) {\n    return {\n      prefix: `${locale}/`,\n      localePrefix: locale as DeclaredLocales,\n    } as GetPrefixResultNarrowed<L>;\n  }\n\n  return {\n    prefix: '',\n    localePrefix: undefined,\n  } as GetPrefixResultNarrowed<L>;\n};\n"],"mappings":";;;;;;;;;AA6CA,MAAa,wBACX,UAA0B,CAAC,OAKvB;CACJ,GAAG;CACH,eAAgB,QAAQ,iBACtB,sBAAsB,iBACtB;CACF,MAAM,QAAQ,QAAQ,SAAS,QAAQ;CACvC,SAAU,QAAQ,WAChB,sBAAsB,WACtB;CACF,SAAS,QAAQ,WAAW,SAAS;CACrC,SAAS,QAAQ,WAAW,SAAS;AACvC;;;;;;;;;;;;;AAcA,MAAa,oBACX,OACA,YAEA,CAAC,CAAC,UAAU,WAAW,qBAAqB,QAAO,CAAE,SAAS,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFrE,MAAa,aACX,QACA,UAA0B,CAAC,MACI;CAC/B,MAAM,EAAE,eAAe,MAAM,SAAS,YACpC,qBAAqB,OAAO;CAE9B,IACG,QAAQ,IAAI,yBACX,QAAQ,IAAI,0BAA0B,gBACtC,QAAQ,IAAI,0BAA0B,uBACxC,CAAC,UACD,CAAC,iBAAiB,QAAQ,OAAO,GAEjC,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;CAKF,IACE,QAAQ,IAAI,6BAA6B,WACzC,0BAA0B,QAAyB,OAAO,GAE1D,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;CAQF,IAHE,SAAS,gBACR,SAAS,uBAAuB,kBAAkB,QAGnD,OAAO;EACL,QAAQ,GAAG,OAAO;EAClB,cAAc;CAChB;CAGF,OAAO;EACL,QAAQ;EACR,cAAc;CAChB;AACF"}