@pyreon/i18n 0.3.0 → 0.7.0

package/src/index.ts

@@ -1,18 +1,16 @@
+export type { I18nProviderProps } from './context'
+export { I18nContext, I18nProvider, useI18n } from './context'
 export { createI18n } from './create-i18n'
 export { interpolate } from './interpolation'
 export { resolvePluralCategory } from './pluralization'
-export { I18nProvider, useI18n, I18nContext } from './context'
-export { Trans, parseRichText } from './trans'
-
+export type { TransProps } from './trans'
+export { parseRichText, Trans } from './trans'
 export type {
   I18nInstance,
   I18nOptions,
-  TranslationDictionary,
-  TranslationMessages,
-  NamespaceLoader,
   InterpolationValues,
+  NamespaceLoader,
   PluralRules,
+  TranslationDictionary,
+  TranslationMessages,
 } from './types'
-
-export type { I18nProviderProps } from './context'
-export type { TransProps } from './trans'

package/src/tests/devtools.test.ts

@@ -1,12 +1,12 @@
 import { createI18n } from '../create-i18n'
 import {
-  registerI18n,
-  unregisterI18n,
+  _resetDevtools,
   getActiveI18nInstances,
   getI18nInstance,
   getI18nSnapshot,
   onI18nChange,
-  _resetDevtools,
+  registerI18n,
+  unregisterI18n,
 } from '../devtools'
 
 afterEach(() => _resetDevtools())

package/src/tests/{i18n.test.ts → i18n.test.tsx}

@@ -1,8 +1,7 @@
-import { h } from '@pyreon/core'
-import { mount } from '@pyreon/runtime-dom'
 import { effect } from '@pyreon/reactivity'
-import { createI18n } from '../create-i18n'
+import { mount } from '@pyreon/runtime-dom'
 import { I18nProvider, useI18n } from '../context'
+import { createI18n } from '../create-i18n'
 import { interpolate } from '../interpolation'
 import { resolvePluralCategory } from '../pluralization'
 import { parseRichText, Trans } from '../trans'
@@ -593,15 +592,14 @@ describe('I18nProvider / useI18n', () => {
     let received: ReturnType<typeof useI18n> | undefined
     const el = document.createElement('div')
     document.body.appendChild(el)
+    const Child = () => {
+      received = useI18n()
+      return null
+    }
     const unmount = mount(
-      h(
-        I18nProvider,
-        { instance: i18n },
-        h(() => {
-          received = useI18n()
-          return null
-        }, null),
-      ),
+      <I18nProvider instance={i18n}>
+        <Child />
+      </I18nProvider>,
       el,
     )
 
@@ -620,13 +618,12 @@ describe('I18nProvider / useI18n', () => {
     let received: ReturnType<typeof useI18n> | undefined
     const el = document.createElement('div')
     document.body.appendChild(el)
+    const Child = () => {
+      received = useI18n()
+      return null
+    }
     const unmount = mount(
-      h(I18nProvider, { instance: i18n }, () => {
-        return h(() => {
-          received = useI18n()
-          return null
-        }, null)
-      }),
+      <I18nProvider instance={i18n}>{() => <Child />}</I18nProvider>,
       el,
     )
 
@@ -641,17 +638,15 @@ describe('I18nProvider / useI18n', () => {
     const el = document.createElement('div')
     document.body.appendChild(el)
 
-    const unmount = mount(
-      h(() => {
-        try {
-          useI18n()
-        } catch (e) {
-          error = e as Error
-        }
-        return null
-      }, null),
-      el,
-    )
+    const Child = () => {
+      try {
+        useI18n()
+      } catch (e) {
+        error = e as Error
+      }
+      return null
+    }
+    const unmount = mount(<Child />, el)
 
     expect(error).toBeDefined()
     expect(error!.message).toContain(
@@ -670,15 +665,14 @@ describe('I18nProvider / useI18n', () => {
     let received: ReturnType<typeof useI18n> | undefined
     const el = document.createElement('div')
     document.body.appendChild(el)
+    const Child = () => {
+      received = useI18n()
+      return null
+    }
     const unmount = mount(
-      h(
-        I18nProvider,
-        { instance: i18n },
-        h(() => {
-          received = useI18n()
-          return null
-        }, null),
-      ),
+      <I18nProvider instance={i18n}>
+        <Child />
+      </I18nProvider>,
       el,
     )
 

package/src/{trans.ts → trans.tsx}

@@ -1,5 +1,4 @@
-import { h, Fragment } from '@pyreon/core'
-import type { VNode, Props } from '@pyreon/core'
+import type { Props, VNode } from '@pyreon/core'
 import type { InterpolationValues } from './types'
 
 const TAG_RE = /<(\w+)>([^<]*)<\/\1>/g
@@ -107,5 +106,5 @@ export function Trans(props: TransProps): VNode | string {
     return component(part.children)
   })
 
-  return h(Fragment, null, ...children)
+  return <>{children}</>
 }

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { Signal, Computed } from '@pyreon/reactivity'
+import type { Computed, Signal } from '@pyreon/reactivity'
 
 /** A nested dictionary of translation strings. */
 export type TranslationDictionary = {

package/lib/types/devtools2.d.ts

@@ -1,30 +0,0 @@
-//#region src/devtools.d.ts
-/**
- * @pyreon/i18n devtools introspection API.
- * Import: `import { ... } from "@pyreon/i18n/devtools"`
- */
-/**
- * Register an i18n instance for devtools inspection.
- *
- * @example
- * const i18n = createI18n({ ... })
- * registerI18n("app", i18n)
- */
-declare function registerI18n(name: string, instance: object): void;
-/** Unregister an i18n instance. */
-declare function unregisterI18n(name: string): void;
-/** Get all registered i18n instance names. Cleans up garbage-collected instances. */
-declare function getActiveI18nInstances(): string[];
-/** Get an i18n instance by name (or undefined if GC'd or not registered). */
-declare function getI18nInstance(name: string): object | undefined;
-/**
- * Get a snapshot of an i18n instance's state.
- */
-declare function getI18nSnapshot(name: string): Record<string, unknown> | undefined;
-/** Subscribe to i18n registry changes. Returns unsubscribe function. */
-declare function onI18nChange(listener: () => void): () => void;
-/** @internal — reset devtools registry (for tests). */
-declare function _resetDevtools(): void;
-//#endregion
-export { _resetDevtools, getActiveI18nInstances, getI18nInstance, getI18nSnapshot, onI18nChange, registerI18n, unregisterI18n };
-//# sourceMappingURL=devtools2.d.ts.map

package/lib/types/devtools2.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools2.d.ts","names":[],"sources":["../../src/devtools.ts"],"mappings":";;AAmBA;;;;;AAMA;;;;;iBANgB,YAAA,CAAa,IAAA,UAAc,QAAA;;iBAM3B,cAAA,CAAe,IAAA;;iBAMf,sBAAA,CAAA;AAQhB;AAAA,iBAAgB,eAAA,CAAgB,IAAA;;;;iBA4BhB,eAAA,CACd,IAAA,WACC,MAAA;;iBAaa,YAAA,CAAa,QAAA;;iBAQb,cAAA,CAAA"}

package/lib/types/index2.d.ts

@@ -1,244 +0,0 @@
-import { Computed, Signal } from "@pyreon/reactivity";
-import * as _pyreon_core0 from "@pyreon/core";
-import { Props, VNode, VNodeChild } from "@pyreon/core";
-
-//#region src/types.d.ts
-/** A nested dictionary of translation strings. */
-type TranslationDictionary = {
-  [key: string]: string | TranslationDictionary;
-};
-/** Map of locale → dictionary (or namespace → dictionary). */
-type TranslationMessages = Record<string, TranslationDictionary>;
-/**
- * Async function that loads translations for a locale and namespace.
- * Return the dictionary for that namespace, or undefined if not found.
- */
-type NamespaceLoader = (locale: string, namespace: string) => Promise<TranslationDictionary | undefined>;
-/** Interpolation values for translation strings. */
-type InterpolationValues = Record<string, string | number>;
-/** Pluralization rules map — locale → function that picks the plural form. */
-type PluralRules = Record<string, (count: number) => string>;
-/** Options for creating an i18n instance. */
-interface I18nOptions {
-  /** The initial locale (e.g. "en"). */
-  locale: string;
-  /** Fallback locale used when a key is missing in the active locale. */
-  fallbackLocale?: string;
-  /** Static messages keyed by locale. */
-  messages?: Record<string, TranslationDictionary>;
-  /**
-   * Async loader for namespace-based translation loading.
-   * Called with (locale, namespace) when `loadNamespace()` is invoked.
-   */
-  loader?: NamespaceLoader;
-  /**
-   * Default namespace used when `t()` is called without a namespace prefix.
-   * Defaults to "common".
-   */
-  defaultNamespace?: string;
-  /**
-   * Custom plural rules per locale.
-   * If not provided, uses `Intl.PluralRules` where available.
-   */
-  pluralRules?: PluralRules;
-  /**
-   * Missing key handler — called when a translation key is not found.
-   * Useful for logging, reporting, or returning a custom fallback.
-   */
-  onMissingKey?: (locale: string, key: string, namespace?: string) => string | undefined;
-}
-/** The public i18n instance returned by `createI18n()`. */
-interface I18nInstance {
-  /**
-   * Translate a key with optional interpolation.
-   * Reads the current locale reactively — re-evaluates in effects/computeds.
-   *
-   * Key format: "key" (uses default namespace) or "namespace:key".
-   * Nested keys use dots: "user.greeting" or "auth:errors.invalid".
-   *
-   * Interpolation: "Hello {{name}}" + { name: "Alice" } → "Hello Alice"
-   * Pluralization: key with "_one", "_other" etc. suffixes + { count: N }
-   */
-  t: (key: string, values?: InterpolationValues) => string;
-  /** Current locale (reactive signal). */
-  locale: Signal<string>;
-  /**
-   * Load a namespace's translations for the given locale (or current locale).
-   * Returns a promise that resolves when loading is complete.
-   */
-  loadNamespace: (namespace: string, locale?: string) => Promise<void>;
-  /**
-   * Whether any namespace is currently being loaded.
-   */
-  isLoading: Computed<boolean>;
-  /**
-   * Set of namespaces that have been loaded for the current locale.
-   */
-  loadedNamespaces: Computed<Set<string>>;
-  /**
-   * Check if a translation key exists in the current locale.
-   */
-  exists: (key: string) => boolean;
-  /**
-   * Add translations for a locale (merged with existing).
-   * Useful for adding translations at runtime without async loading.
-   */
-  addMessages: (locale: string, messages: TranslationDictionary, namespace?: string) => void;
-  /**
-   * Get all available locales (those with any registered messages).
-   */
-  availableLocales: Computed<string[]>;
-}
-//#endregion
-//#region src/create-i18n.d.ts
-/**
- * Create a reactive i18n instance.
- *
- * @example
- * const i18n = createI18n({
- *   locale: 'en',
- *   fallbackLocale: 'en',
- *   messages: {
- *     en: { greeting: 'Hello {{name}}!' },
- *     de: { greeting: 'Hallo {{name}}!' },
- *   },
- * })
- *
- * // Reactive translation — re-evaluates on locale change
- * i18n.t('greeting', { name: 'Alice' }) // "Hello Alice!"
- * i18n.locale.set('de')
- * i18n.t('greeting', { name: 'Alice' }) // "Hallo Alice!"
- *
- * @example
- * // Async namespace loading
- * const i18n = createI18n({
- *   locale: 'en',
- *   loader: async (locale, namespace) => {
- *     const mod = await import(`./locales/${locale}/${namespace}.json`)
- *     return mod.default
- *   },
- * })
- * await i18n.loadNamespace('auth')
- * i18n.t('auth:errors.invalid') // looks up "errors.invalid" in "auth" namespace
- */
-declare function createI18n(options: I18nOptions): I18nInstance;
-//#endregion
-//#region src/interpolation.d.ts
-/**
- * Replace `{{key}}` placeholders in a string with values from the given record.
- * Supports optional whitespace inside braces: `{{ name }}` works too.
- * Unmatched placeholders are left as-is.
- */
-declare function interpolate(template: string, values?: InterpolationValues): string;
-//#endregion
-//#region src/pluralization.d.ts
-/**
- * Resolve the plural category for a given count and locale.
- *
- * Uses custom rules if provided, otherwise falls back to `Intl.PluralRules`.
- * Returns CLDR plural categories: "zero", "one", "two", "few", "many", "other".
- */
-declare function resolvePluralCategory(locale: string, count: number, customRules?: PluralRules): string;
-//#endregion
-//#region src/context.d.ts
-declare const I18nContext: _pyreon_core0.Context<I18nInstance | null>;
-interface I18nProviderProps extends Props {
-  instance: I18nInstance;
-  children?: VNodeChild;
-}
-/**
- * Provide an i18n instance to the component tree.
- *
- * @example
- * const i18n = createI18n({ locale: 'en', messages: { en: { hello: 'Hello' } } })
- *
- * // In JSX:
- * <I18nProvider instance={i18n}>
- *   <App />
- * </I18nProvider>
- */
-declare function I18nProvider(props: I18nProviderProps): VNode;
-/**
- * Access the i18n instance from the nearest I18nProvider.
- * Must be called within a component tree wrapped by I18nProvider.
- *
- * @example
- * function Greeting() {
- *   const { t, locale } = useI18n()
- *   return <h1>{t('greeting', { name: 'World' })}</h1>
- * }
- */
-declare function useI18n(): I18nInstance;
-//#endregion
-//#region src/trans.d.ts
-interface RichPart {
-  tag: string;
-  children: string;
-}
-/**
- * Parse a translated string into an array of plain text and rich tag segments.
- *
- * @example
- * parseRichText("Hello <bold>world</bold>, click <link>here</link>")
- * // → ["Hello ", { tag: "bold", children: "world" }, ", click ", { tag: "link", children: "here" }]
- */
-declare function parseRichText(text: string): (string | RichPart)[];
-interface TransProps extends Props {
-  /** Translation key (supports namespace:key syntax). */
-  i18nKey: string;
-  /** Interpolation values for {{placeholder}} syntax. */
-  values?: InterpolationValues;
-  /**
-   * Component map for rich interpolation.
-   * Keys match tag names in the translation string.
-   * Values are component functions: `(children: any) => VNode`
-   *
-   * @example
-   * // Translation: "Read the <terms>terms</terms> and <privacy>policy</privacy>"
-   * components={{
-   *   terms: (children) => <a href="/terms">{children}</a>,
-   *   privacy: (children) => <a href="/privacy">{children}</a>,
-   * }}
-   */
-  components?: Record<string, (children: any) => any>;
-  /**
-   * The i18n instance's `t` function.
-   * Can be obtained from `useI18n()` or passed directly.
-   */
-  t: (key: string, values?: InterpolationValues) => string;
-}
-/**
- * Rich JSX interpolation component for translations.
- *
- * Allows embedding JSX components within translated strings using XML-like tags.
- * The `t` function resolves the translation and interpolates `{{values}}` first,
- * then `<tag>content</tag>` patterns are mapped to the provided components.
- *
- * @example
- * // Translation: "You have <bold>{{count}}</bold> unread messages"
- * const { t } = useI18n()
- * <Trans
- *   t={t}
- *   i18nKey="messages.unread"
- *   values={{ count: 5 }}
- *   components={{
- *     bold: (children) => <strong>{children}</strong>,
- *   }}
- * />
- * // Renders: You have <strong>5</strong> unread messages
- *
- * @example
- * // Translation: "Read our <terms>terms of service</terms> and <privacy>privacy policy</privacy>"
- * <Trans
- *   t={t}
- *   i18nKey="legal"
- *   components={{
- *     terms: (children) => <a href="/terms">{children}</a>,
- *     privacy: (children) => <a href="/privacy">{children}</a>,
- *   }}
- * />
- */
-declare function Trans(props: TransProps): VNode | string;
-//#endregion
-export { I18nContext, type I18nInstance, type I18nOptions, I18nProvider, type I18nProviderProps, type InterpolationValues, type NamespaceLoader, type PluralRules, Trans, type TransProps, type TranslationDictionary, type TranslationMessages, createI18n, interpolate, parseRichText, resolvePluralCategory, useI18n };
-//# sourceMappingURL=index2.d.ts.map

package/lib/types/index2.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index2.d.ts","names":[],"sources":["../../src/types.ts","../../src/create-i18n.ts","../../src/interpolation.ts","../../src/pluralization.ts","../../src/context.ts","../../src/trans.ts"],"mappings":";;;;;;KAGY,qBAAA;EAAA,CACT,GAAA,oBAAuB,qBAAA;AAAA;AAD1B;AAAA,KAKY,mBAAA,GAAsB,MAAA,SAAe,qBAAA;;;;AAAjD;KAMY,eAAA,IACV,MAAA,UACA,SAAA,aACG,OAAA,CAAQ,qBAAA;;KAGD,mBAAA,GAAsB,MAAA;;KAGtB,WAAA,GAAc,MAAA,UAAgB,KAAA;;UAGzB,WAAA;EATL;EAWV,MAAA;EAZA;EAcA,cAAA;EAbW;EAeX,QAAA,GAAW,MAAA,SAAe,qBAAA;EAfM;AAGlC;;;EAiBE,MAAA,GAAS,eAAA;EAjB6B;AAGxC;;;EAmBE,gBAAA;EAnBqD;AAGvD;;;EAqBE,WAAA,GAAc,WAAA;EAfH;;;;EAoBX,YAAA,IACE,MAAA,UACA,GAAA,UACA,SAAA;AAAA;;UAKa,YAAA;EA5BJ;;;;;;;;;;EAuCX,CAAA,GAAI,GAAA,UAAa,MAAA,GAAS,mBAAA;EAhBN;EAmBpB,MAAA,EAAQ,MAAA;EAdO;;;;EAoBf,aAAA,GAAgB,SAAA,UAAmB,MAAA,cAAoB,OAAA;EAAA;;;EAKvD,SAAA,EAAW,QAAA;EAkBC;;;EAbZ,gBAAA,EAAkB,QAAA,CAAS,GAAA;EAnB3B;;;EAwBA,MAAA,GAAS,GAAA;EArBT;;;;EA2BA,WAAA,GACE,MAAA,UACA,QAAA,EAAU,qBAAA,EACV,SAAA;EAxBqD;;;EA8BvD,gBAAA,EAAkB,QAAA;AAAA;;;;;;;AA3GpB;;;;;AAKA;;;;;AAMA;;;;;;;;;;AAMA;;;;;AAGA;iBCgEgB,UAAA,CAAW,OAAA,EAAS,WAAA,GAAc,YAAA;;;;;;;ADpFlD;iBEMgB,WAAA,CACd,QAAA,UACA,MAAA,GAAS,mBAAA;;;;;;;AFRX;;iBGKgB,qBAAA,CACd,MAAA,UACA,KAAA,UACA,WAAA,GAAc,WAAA;;;cCDH,WAAA,EAAW,aAAA,CAAA,OAAA,CAAA,YAAA;AAAA,UAEP,iBAAA,SAA0B,KAAA;EACzC,QAAA,EAAU,YAAA;EACV,QAAA,GAAW,UAAA;AAAA;;;;AJNb;;;;;AAMA;;;iBIcgB,YAAA,CAAa,KAAA,EAAO,iBAAA,GAAoB,KAAA;;;;;;;AJRxD;;;;iBI4BgB,OAAA,CAAA,GAAW,YAAA;;;UC1CjB,QAAA;EACR,GAAA;EACA,QAAA;AAAA;;;;;ALAF;;;iBKUgB,aAAA,CAAc,IAAA,qBAAyB,QAAA;AAAA,UAiBtC,UAAA,SAAmB,KAAA;ELrBxB;EKuBV,OAAA;;EAEA,MAAA,GAAS,mBAAA;ELxBT;;;;;;AAKF;;;;;AAGA;EK6BE,UAAA,GAAa,MAAA,UAAgB,QAAA;;;;AL1B/B;EK+BE,CAAA,GAAI,GAAA,UAAa,MAAA,GAAS,mBAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;ALG5B;;;;;;;;;iBK+BgB,KAAA,CAAM,KAAA,EAAO,UAAA,GAAa,KAAA"}