@byline/i18n 4.11.1 → 4.12.0

package/README.md

@@ -17,7 +17,7 @@ The package bundles every official Byline admin translation as a JSON file under
 ## Three entry points
 
 ```ts
-import { mergeTranslations, createFormatter, resolveInterfaceLocale } from '@byline/i18n'
+import { mergeTranslations, createFormatter, resolveAdminLocale } from '@byline/i18n'
 import { I18nProvider, useTranslation, LanguageMenu } from '@byline/i18n/react'
 import { adminTranslations, en } from '@byline/i18n/admin'
 ```
@@ -30,19 +30,19 @@ import { adminTranslations, en } from '@byline/i18n/admin'
 
 ```ts
 // apps/your-app/byline/admin.config.ts
-import { defineClientConfig } from '@byline/core'
+import { defineAdminConfig } from '@byline/core'
 import { adminTranslations } from '@byline/i18n/admin'
 
-defineClientConfig({
+defineAdminConfig({
   i18n: {
-    interface: {
+    admin: {
       defaultLocale: 'en',
       locales: ['en'],
     },
     // … content locales as before
     translations: adminTranslations({ locales: ['en'] }),
   },
-  // … the rest of your client config
+  // … the rest of your admin config
 })
 ```
 
@@ -52,7 +52,7 @@ defineClientConfig({
 import { adminTranslations } from '@byline/i18n/admin'
 
 i18n: {
-  interface: { defaultLocale: 'en', locales: ['en', 'fr'] },
+  admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
   translations: adminTranslations({ locales: ['en', 'fr'] }),
 }
 ```
@@ -63,7 +63,7 @@ The set of bundled locales is exported as `bundledLocales` for hosts that want t
 import { adminTranslations, bundledLocales } from '@byline/i18n/admin'
 
 i18n: {
-  interface: { defaultLocale: 'en', locales: [...bundledLocales] },
+  admin: { defaultLocale: 'en', locales: [...bundledLocales] },
   translations: adminTranslations({ locales: bundledLocales }),
 }
 ```
@@ -72,7 +72,7 @@ i18n: {
 
 ## Plugin contributions
 
-A plugin (richtext extension, custom field, AI tool, …) ships its own JSON files inside its own package and exposes a factory matching `adminTranslations`'s shape — takes `{ locales }`, returns a `TranslationBundle` for the plugin's own namespace. The host merges them in `defineClientConfig`:
+A plugin (richtext extension, custom field, AI tool, …) ships its own JSON files inside its own package and exposes a factory matching `adminTranslations`'s shape — takes `{ locales }`, returns a `TranslationBundle` for the plugin's own namespace. The host merges them in `defineAdminConfig`:
 
 ```ts
 import { mergeTranslations } from '@byline/i18n'
@@ -80,7 +80,7 @@ import { adminTranslations } from '@byline/i18n/admin'
 import { aiTranslations } from '@byline/ai/i18n'
 
 i18n: {
-  interface: { defaultLocale: 'en', locales: ['en', 'fr'] },
+  admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
   translations: mergeTranslations(
     adminTranslations({ locales: ['en', 'fr'] }),
     aiTranslations({ locales: ['en', 'fr'] }),
@@ -88,7 +88,7 @@ i18n: {
 }
 ```
 
-A plugin that ships a locale the host hasn't enabled is harmless — the plugin's factory simply returns nothing for that code, the merge produces an empty entry for it, and the boot validator gates against `i18n.interface.locales` anyway.
+A plugin that ships a locale the host hasn't enabled is harmless — the plugin's factory simply returns nothing for that code, the merge produces an empty entry for it, and the boot validator gates against `i18n.admin.locales` anyway.
 
 `mergeTranslations` is associative + deterministic; later sources override earlier ones at the `(locale, namespace, key)` grain, and a `MergeOptions.onCollision` callback is available for surfacing conflicts during development.
 
@@ -138,12 +138,12 @@ In a TanStack Start host, `resolveServerTranslator(namespace)` (provided by `@by
 
 ## Locale resolution cascade
 
-`resolveInterfaceLocale` is the same pure cascade run on client and server, so SSR and hydration produce the same answer:
+`resolveAdminLocale` is the same pure cascade run on client and server, so SSR and hydration produce the same answer:
 
 ```ts
-import { resolveInterfaceLocale } from '@byline/i18n'
+import { resolveAdminLocale } from '@byline/i18n'
 
-const activeLocale = resolveInterfaceLocale({
+const activeLocale = resolveAdminLocale({
   locales: ['en', 'fr'],
   defaultLocale: 'en',
   preferred: actor?.admin_user?.preferred_locale,

package/dist/admin/index.d.ts

@@ -36,9 +36,9 @@ export interface AdminTranslationsOptions {
  * ```ts
  * import { adminTranslations } from '@byline/i18n/admin'
  *
- * defineClientConfig({
+ * defineAdminConfig({
  *   i18n: {
- *     interface: { defaultLocale: 'en', locales: ['en', 'fr'] },
+ *     admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
  *     translations: adminTranslations({ locales: ['en', 'fr'] }),
  *   },
  * })

package/dist/index.d.ts

@@ -26,8 +26,8 @@
  */
 export { createFormatter } from './formatter.js';
 export { mergeTranslations } from './merge.js';
-export { resolveInterfaceLocale } from './resolve.js';
+export { resolveAdminLocale } from './resolve.js';
 export type { Formatter, FormatterOptions, MissingTranslationEvent, } from './formatter.js';
 export type { MergeOptions, TranslationCollision } from './merge.js';
-export type { ResolveInterfaceLocaleOptions } from './resolve.js';
+export type { ResolveAdminLocaleOptions } from './resolve.js';
 export type { LocaleCode, LocaleDefinition, MessageKey, Namespace, NamespaceTranslations, TranslationBundle, TranslationValues, } from './types.js';

package/dist/index.js

@@ -1,3 +1,3 @@
 export { createFormatter } from "./formatter.js";
 export { mergeTranslations } from "./merge.js";
-export { resolveInterfaceLocale } from "./resolve.js";
+export { resolveAdminLocale } from "./resolve.js";

package/dist/resolve.d.ts

@@ -6,10 +6,10 @@
  * Copyright (c) Infonomic Company Limited
  */
 import type { LocaleCode } from './types.js';
-export interface ResolveInterfaceLocaleOptions {
-    /** Permitted locale set — from `i18n.interface.locales`. */
+export interface ResolveAdminLocaleOptions {
+    /** Permitted locale set — from `i18n.admin.locales`. */
     locales: readonly LocaleCode[];
-    /** Last-resort fallback — from `i18n.interface.defaultLocale`. */
+    /** Last-resort fallback — from `i18n.admin.defaultLocale`. */
     defaultLocale: LocaleCode;
     /** `admin_users.preferred_locale` for the authenticated request, if any. */
     preferred?: LocaleCode | null;
@@ -18,4 +18,4 @@ export interface ResolveInterfaceLocaleOptions {
     /** Raw `Accept-Language` request header. */
     acceptLanguage?: string | null;
 }
-export declare function resolveInterfaceLocale(options: ResolveInterfaceLocaleOptions): LocaleCode;
+export declare function resolveAdminLocale(options: ResolveAdminLocaleOptions): LocaleCode;

package/dist/resolve.js

@@ -1,6 +1,6 @@
 import { match } from "@formatjs/intl-localematcher";
 import negotiator_0 from "negotiator";
-function resolveInterfaceLocale(options) {
+function resolveAdminLocale(options) {
     const { locales, defaultLocale, preferred, cookie, acceptLanguage } = options;
     if (null != preferred && locales.includes(preferred)) return preferred;
     if (null != cookie && locales.includes(cookie)) return cookie;
@@ -25,4 +25,4 @@ function negotiateAcceptLanguage(header, locales, defaultLocale) {
         return null;
     }
 }
-export { resolveInterfaceLocale };
+export { resolveAdminLocale };

package/dist/types.d.ts

@@ -8,13 +8,13 @@
 /**
  * Locale code — kept as a plain `string` so the package stays open to
  * any BCP 47 tag (`en`, `pt-BR`, `zh-Hans-CN`). The host's
- * `i18n.interface.locales` config is the canonical allow-list at
+ * `i18n.admin.locales` config is the canonical allow-list at
  * runtime; the resolver / validator narrow against it.
  */
 export type LocaleCode = string;
 /**
  * Lightweight locale definition used by `<LanguageMenu>` to render the
- * dropdown. The `code` matches a string in `i18n.interface.locales`;
+ * dropdown. The `code` matches a string in `i18n.admin.locales`;
  * the `nativeName` is what the user sees ("English", "Español",
  * "Français", "Deutsch", "日本語").
  */

package/package.json

@@ -3,7 +3,7 @@
   "private": false,
   "type": "module",
   "license": "MPL-2.0",
-  "version": "4.11.1",
+  "version": "4.12.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -53,29 +53,29 @@
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.8.13",
     "clsx": "^2.1.1",
-    "intl-messageformat": "^11.2.12",
+    "intl-messageformat": "^11.2.13",
     "negotiator": "^1.0.0",
-    "@byline/ui": "4.11.1"
+    "@byline/ui": "4.12.0"
   },
   "peerDependencies": {
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.4",
+    "@biomejs/biome": "2.5.6",
     "@rsbuild/plugin-react": "^2.1.0",
     "@rslib/core": "^0.23.2",
     "@types/negotiator": "^0.6.4",
-    "@types/node": "^26.1.1",
-    "@types/react": "19.2.17",
-    "@types/react-dom": "19.2.3",
-    "@vitejs/plugin-react": "^6.0.3",
+    "@types/node": "^26.1.2",
+    "@types/react": "19.2.18",
+    "@types/react-dom": "19.2.4",
+    "@vitejs/plugin-react": "^6.0.5",
     "npm-run-all": "^4.1.5",
-    "react": "^19.2.7",
-    "react-dom": "^19.2.7",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
     "rimraf": "^6.1.3",
     "typescript": "^7.0.2",
-    "vite": "^8.1.5",
+    "vite": "^8.2.0",
     "vitest": "^4.1.10"
   },
   "publishConfig": {

package/src/admin/index.ts

@@ -86,9 +86,9 @@ export interface AdminTranslationsOptions {
  * ```ts
  * import { adminTranslations } from '@byline/i18n/admin'
  *
- * defineClientConfig({
+ * defineAdminConfig({
  *   i18n: {
- *     interface: { defaultLocale: 'en', locales: ['en', 'fr'] },
+ *     admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
  *     translations: adminTranslations({ locales: ['en', 'fr'] }),
  *   },
  * })

package/src/index.ts

@@ -28,14 +28,14 @@
 
 export { createFormatter } from './formatter.js'
 export { mergeTranslations } from './merge.js'
-export { resolveInterfaceLocale } from './resolve.js'
+export { resolveAdminLocale } from './resolve.js'
 export type {
   Formatter,
   FormatterOptions,
   MissingTranslationEvent,
 } from './formatter.js'
 export type { MergeOptions, TranslationCollision } from './merge.js'
-export type { ResolveInterfaceLocaleOptions } from './resolve.js'
+export type { ResolveAdminLocaleOptions } from './resolve.js'
 export type {
   LocaleCode,
   LocaleDefinition,

package/src/resolve.test.node.ts

@@ -8,14 +8,14 @@
 
 import { describe, expect, it } from 'vitest'
 
-import { resolveInterfaceLocale } from './resolve.js'
+import { resolveAdminLocale } from './resolve.js'
 
 const locales = ['en', 'fr', 'es']
 const defaultLocale = 'en'
 
-describe('resolveInterfaceLocale — tier 1 (preferred)', () => {
+describe('resolveAdminLocale — tier 1 (preferred)', () => {
   it('wins over every other signal when set and valid', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       preferred: 'fr',
@@ -26,7 +26,7 @@ describe('resolveInterfaceLocale — tier 1 (preferred)', () => {
   })
 
   it('falls through when preferred is not in the permitted set', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       preferred: 'de',
@@ -36,7 +36,7 @@ describe('resolveInterfaceLocale — tier 1 (preferred)', () => {
   })
 
   it('falls through when preferred is null', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       preferred: null,
@@ -46,9 +46,9 @@ describe('resolveInterfaceLocale — tier 1 (preferred)', () => {
   })
 })
 
-describe('resolveInterfaceLocale — tier 2 (cookie)', () => {
+describe('resolveAdminLocale — tier 2 (cookie)', () => {
   it('wins over Accept-Language', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       cookie: 'es',
@@ -58,7 +58,7 @@ describe('resolveInterfaceLocale — tier 2 (cookie)', () => {
   })
 
   it('falls through when cookie points at a removed locale', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       cookie: 'de',
@@ -68,7 +68,7 @@ describe('resolveInterfaceLocale — tier 2 (cookie)', () => {
   })
 
   it('falls through when cookie is null', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       cookie: null,
@@ -78,9 +78,9 @@ describe('resolveInterfaceLocale — tier 2 (cookie)', () => {
   })
 })
 
-describe('resolveInterfaceLocale — tier 3 (Accept-Language)', () => {
+describe('resolveAdminLocale — tier 3 (Accept-Language)', () => {
   it('picks the best match from the header', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       acceptLanguage: 'fr-CA;q=0.9, fr;q=0.8, en;q=0.5',
@@ -89,7 +89,7 @@ describe('resolveInterfaceLocale — tier 3 (Accept-Language)', () => {
   })
 
   it('falls back to default when no header language is in the permitted set', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       acceptLanguage: 'de;q=0.9, ja;q=0.5',
@@ -98,7 +98,7 @@ describe('resolveInterfaceLocale — tier 3 (Accept-Language)', () => {
   })
 
   it('handles malformed headers gracefully', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       acceptLanguage: 'this-is-not-a-valid-header',
@@ -109,14 +109,14 @@ describe('resolveInterfaceLocale — tier 3 (Accept-Language)', () => {
   })
 })
 
-describe('resolveInterfaceLocale — tier 4 (default)', () => {
+describe('resolveAdminLocale — tier 4 (default)', () => {
   it('returns defaultLocale when every other tier produces nothing', () => {
-    const out = resolveInterfaceLocale({ locales, defaultLocale })
+    const out = resolveAdminLocale({ locales, defaultLocale })
     expect(out).toBe('en')
   })
 
   it('returns defaultLocale when every signal is empty', () => {
-    const out = resolveInterfaceLocale({
+    const out = resolveAdminLocale({
       locales,
       defaultLocale,
       preferred: null,

package/src/resolve.ts

@@ -29,10 +29,10 @@ import Negotiator from 'negotiator'
 
 import type { LocaleCode } from './types.js'
 
-export interface ResolveInterfaceLocaleOptions {
-  /** Permitted locale set — from `i18n.interface.locales`. */
+export interface ResolveAdminLocaleOptions {
+  /** Permitted locale set — from `i18n.admin.locales`. */
   locales: readonly LocaleCode[]
-  /** Last-resort fallback — from `i18n.interface.defaultLocale`. */
+  /** Last-resort fallback — from `i18n.admin.defaultLocale`. */
   defaultLocale: LocaleCode
   /** `admin_users.preferred_locale` for the authenticated request, if any. */
   preferred?: LocaleCode | null
@@ -42,7 +42,7 @@ export interface ResolveInterfaceLocaleOptions {
   acceptLanguage?: string | null
 }
 
-export function resolveInterfaceLocale(options: ResolveInterfaceLocaleOptions): LocaleCode {
+export function resolveAdminLocale(options: ResolveAdminLocaleOptions): LocaleCode {
   const { locales, defaultLocale, preferred, cookie, acceptLanguage } = options
 
   // Tier 1 — admin user preference.

package/src/types.ts

@@ -9,14 +9,14 @@
 /**
  * Locale code — kept as a plain `string` so the package stays open to
  * any BCP 47 tag (`en`, `pt-BR`, `zh-Hans-CN`). The host's
- * `i18n.interface.locales` config is the canonical allow-list at
+ * `i18n.admin.locales` config is the canonical allow-list at
  * runtime; the resolver / validator narrow against it.
  */
 export type LocaleCode = string
 
 /**
  * Lightweight locale definition used by `<LanguageMenu>` to render the
- * dropdown. The `code` matches a string in `i18n.interface.locales`;
+ * dropdown. The `code` matches a string in `i18n.admin.locales`;
  * the `nativeName` is what the user sees ("English", "Español",
  * "Français", "Deutsch", "日本語").
  */