@embedpdf/plugin-i18n 3.0.0-next.14 → 3.0.0-next.15

package/dist/contract-D2EGxESh.d.cts

@@ -0,0 +1,140 @@
+import { DeepPartial, EventHook, OperationOptions, PluginErrorInfo, SettingsApi, Unsubscribe } from "@embedpdf/core";
+//#region src/token.d.ts
+declare const I18nToken: import("@embedpdf/core").CapabilityToken<I18nCapability>;
+//#endregion
+//#region src/contract.d.ts
+/**
+ * A tree of strings. A leaf may hold `{name}` slots. A dotted key is the same as a nested one:
+ * `{ 'review.reject': 'Reject' }` is `{ review: { reject: 'Reject' } }`.
+ */
+interface TranslationDictionary {
+  readonly [key: string]: string | TranslationDictionary;
+}
+/** How a language reads. */
+type TextDirection = 'ltr' | 'rtl';
+/** A language and its strings. */
+interface Locale {
+  /** Its language tag (RFC 5646): `'en'`, `'nl'`, `'ar'`, `'zh-CN'`. */
+  readonly code: string;
+  /** Its name in itself, as a language picker shows it: `'Nederlands'`. */
+  readonly name: string;
+  /** How it reads; `'ltr'` when left out. */
+  readonly direction?: TextDirection;
+  readonly translations: TranslationDictionary;
+}
+/** Loads a language the first time someone switches to it. */
+type LocaleLoader = () => Promise<Locale>;
+/**
+ * The i18n plugin's settings. `i18nPlugin(config)` registers them over
+ * {@link I18N_DEFAULTS}, and `updateSettings()` changes them while the app runs: a new `locale`
+ * switches to it, new `locales` are registered, and `fallbackLocale` and `loaders` apply to the
+ * next lookup and the next switch.
+ */
+interface I18nSettings {
+  /**
+   * The language to start with; `null` starts with `fallbackLocale`. Pick it outside the plugin,
+   * which never reads the browser: `negotiateLocale(codes, navigator.languages)`. A language in
+   * `loaders` shows the fallback language until it has loaded.
+   */
+  readonly locale: string | null;
+  /** The language to use for a string another language doesn't have. */
+  readonly fallbackLocale: string;
+  /** Languages loaded from the start. */
+  readonly locales: readonly Locale[];
+  /**
+   * Languages loaded the first time someone switches to them, by code. Until then a language
+   * picker shows the code as the name.
+   */
+  readonly loaders: Readonly<Record<string, LocaleLoader>>;
+}
+/** What the i18n settings are when the app registers none. */
+declare const I18N_DEFAULTS: I18nSettings;
+/** What `i18nPlugin(config)` takes: any of the settings, merged over the defaults. */
+type I18nConfig = DeepPartial<I18nSettings>;
+interface TranslateOptions {
+  /**
+   * The values of the string's `{name}` slots. A number `count` also picks the plural: a key
+   * whose string is `{ one, other }` gives the form for the language's plural rule
+   * (`Intl.PluralRules`), and `other` when the rule's form is missing.
+   *
+   * ```ts
+   * // pages: { one: '{count} page', other: '{count} pages' }
+   * t('pages', { params: { count: 1 } }) // '1 page'
+   * ```
+   */
+  params?: Record<string, string | number>;
+  /**
+   * Another key, read in each language that has no string for the key, before the fallback
+   * language is: a specific key in front of a general one.
+   *
+   * ```ts
+   * // a language's 'review:approve', else its 'commands.approve'
+   * t('review:approve', { fallbackKey: 'commands.approve' })
+   * ```
+   */
+  fallbackKey?: string;
+  /** What to show, with its slots filled, when no language has the key; the key itself otherwise. */
+  fallback?: string;
+}
+/** A language as a picker shows it: the loaded ones and the ones in `loaders`. */
+interface LocaleInfo {
+  readonly code: string;
+  /** Its name in itself; the code until a language in `loaders` has loaded. */
+  readonly name: string;
+  readonly direction: TextDirection;
+  readonly loaded: boolean;
+}
+interface LocaleChangedEvent {
+  readonly locale: string;
+  readonly previousLocale: string;
+}
+interface LocaleLoadFailedEvent {
+  readonly locale: string;
+  readonly error: PluginErrorInfo;
+}
+interface I18nCapability extends SettingsApi<I18nSettings> {
+  /**
+   * A string in the current language, with `params` filled in: the app's strings for the
+   * language, then EmbedPDF's own (for the key, then `options.fallbackKey`), then the same for
+   * the fallback language, then `options.fallback`, then the key. A key no language has warns
+   * once in the console.
+   */
+  t(key: string, options?: TranslateOptions): string;
+  /**
+   * A `t` function that stays the same until the language or the strings change, so a memoized
+   * component holding it renders again exactly when its strings may differ.
+   */
+  getTranslator(): (key: string, options?: TranslateOptions) => string;
+  /** Whether a key has a string in the current or the fallback language. Never warns. */
+  hasKey(key: string): boolean;
+  /** The current language's code. */
+  getLocale(): string;
+  /** How the current language reads: set it as `dir` on your viewer's root. */
+  getDirection(): TextDirection;
+  /** Every language you can switch to, loaded or not, in the order they were added. The same array until one changes. */
+  listLocales(): readonly LocaleInfo[];
+  /** The code of the language being loaded, or `null`. */
+  getLoadingLocale(): string | null;
+  /**
+   * Switch the language, loading it first when it's in `loaders`. Resolves once it shows, and
+   * fires `onLocaleChanged`. Rejects `not-found` for a code that is neither loaded nor in
+   * `loaders`, `operation-failed` when it can't load (and fires `onLocaleLoadFailed`), and
+   * `operation-cancelled` when the signal fires or a newer call replaces it.
+   */
+  setLocale(code: string, options?: OperationOptions): Promise<void>;
+  /** Add a whole language, and get a function that removes it again. */
+  registerLocale(locale: Locale): Unsubscribe;
+  /**
+   * Add strings to a language, loaded or not, replacing the ones with the same key; dotted keys
+   * work. A language in `loaders` gets them when it loads, on top of its own. Throws `not-found`
+   * for a code that is neither loaded nor in `loaders`.
+   */
+  addTranslations(code: string, translations: TranslationDictionary): void;
+  /** The current language changed and shows; never while a language is still loading. */
+  readonly onLocaleChanged: EventHook<LocaleChangedEvent>;
+  /** A language in `loaders` couldn't be loaded; the current language stays. */
+  readonly onLocaleLoadFailed: EventHook<LocaleLoadFailedEvent>;
+}
+//#endregion
+export { Locale as a, LocaleLoadFailedEvent as c, TranslateOptions as d, TranslationDictionary as f, I18nSettings as i, LocaleLoader as l, I18nCapability as n, LocaleChangedEvent as o, I18nToken as p, I18nConfig as r, LocaleInfo as s, I18N_DEFAULTS as t, TextDirection as u };
+//# sourceMappingURL=contract-D2EGxESh.d.cts.map

package/dist/contract-D2EGxESh.d.ts

@@ -0,0 +1,140 @@
+import { DeepPartial, EventHook, OperationOptions, PluginErrorInfo, SettingsApi, Unsubscribe } from "@embedpdf/core";
+//#region src/token.d.ts
+declare const I18nToken: import("@embedpdf/core").CapabilityToken<I18nCapability>;
+//#endregion
+//#region src/contract.d.ts
+/**
+ * A tree of strings. A leaf may hold `{name}` slots. A dotted key is the same as a nested one:
+ * `{ 'review.reject': 'Reject' }` is `{ review: { reject: 'Reject' } }`.
+ */
+interface TranslationDictionary {
+  readonly [key: string]: string | TranslationDictionary;
+}
+/** How a language reads. */
+type TextDirection = 'ltr' | 'rtl';
+/** A language and its strings. */
+interface Locale {
+  /** Its language tag (RFC 5646): `'en'`, `'nl'`, `'ar'`, `'zh-CN'`. */
+  readonly code: string;
+  /** Its name in itself, as a language picker shows it: `'Nederlands'`. */
+  readonly name: string;
+  /** How it reads; `'ltr'` when left out. */
+  readonly direction?: TextDirection;
+  readonly translations: TranslationDictionary;
+}
+/** Loads a language the first time someone switches to it. */
+type LocaleLoader = () => Promise<Locale>;
+/**
+ * The i18n plugin's settings. `i18nPlugin(config)` registers them over
+ * {@link I18N_DEFAULTS}, and `updateSettings()` changes them while the app runs: a new `locale`
+ * switches to it, new `locales` are registered, and `fallbackLocale` and `loaders` apply to the
+ * next lookup and the next switch.
+ */
+interface I18nSettings {
+  /**
+   * The language to start with; `null` starts with `fallbackLocale`. Pick it outside the plugin,
+   * which never reads the browser: `negotiateLocale(codes, navigator.languages)`. A language in
+   * `loaders` shows the fallback language until it has loaded.
+   */
+  readonly locale: string | null;
+  /** The language to use for a string another language doesn't have. */
+  readonly fallbackLocale: string;
+  /** Languages loaded from the start. */
+  readonly locales: readonly Locale[];
+  /**
+   * Languages loaded the first time someone switches to them, by code. Until then a language
+   * picker shows the code as the name.
+   */
+  readonly loaders: Readonly<Record<string, LocaleLoader>>;
+}
+/** What the i18n settings are when the app registers none. */
+declare const I18N_DEFAULTS: I18nSettings;
+/** What `i18nPlugin(config)` takes: any of the settings, merged over the defaults. */
+type I18nConfig = DeepPartial<I18nSettings>;
+interface TranslateOptions {
+  /**
+   * The values of the string's `{name}` slots. A number `count` also picks the plural: a key
+   * whose string is `{ one, other }` gives the form for the language's plural rule
+   * (`Intl.PluralRules`), and `other` when the rule's form is missing.
+   *
+   * ```ts
+   * // pages: { one: '{count} page', other: '{count} pages' }
+   * t('pages', { params: { count: 1 } }) // '1 page'
+   * ```
+   */
+  params?: Record<string, string | number>;
+  /**
+   * Another key, read in each language that has no string for the key, before the fallback
+   * language is: a specific key in front of a general one.
+   *
+   * ```ts
+   * // a language's 'review:approve', else its 'commands.approve'
+   * t('review:approve', { fallbackKey: 'commands.approve' })
+   * ```
+   */
+  fallbackKey?: string;
+  /** What to show, with its slots filled, when no language has the key; the key itself otherwise. */
+  fallback?: string;
+}
+/** A language as a picker shows it: the loaded ones and the ones in `loaders`. */
+interface LocaleInfo {
+  readonly code: string;
+  /** Its name in itself; the code until a language in `loaders` has loaded. */
+  readonly name: string;
+  readonly direction: TextDirection;
+  readonly loaded: boolean;
+}
+interface LocaleChangedEvent {
+  readonly locale: string;
+  readonly previousLocale: string;
+}
+interface LocaleLoadFailedEvent {
+  readonly locale: string;
+  readonly error: PluginErrorInfo;
+}
+interface I18nCapability extends SettingsApi<I18nSettings> {
+  /**
+   * A string in the current language, with `params` filled in: the app's strings for the
+   * language, then EmbedPDF's own (for the key, then `options.fallbackKey`), then the same for
+   * the fallback language, then `options.fallback`, then the key. A key no language has warns
+   * once in the console.
+   */
+  t(key: string, options?: TranslateOptions): string;
+  /**
+   * A `t` function that stays the same until the language or the strings change, so a memoized
+   * component holding it renders again exactly when its strings may differ.
+   */
+  getTranslator(): (key: string, options?: TranslateOptions) => string;
+  /** Whether a key has a string in the current or the fallback language. Never warns. */
+  hasKey(key: string): boolean;
+  /** The current language's code. */
+  getLocale(): string;
+  /** How the current language reads: set it as `dir` on your viewer's root. */
+  getDirection(): TextDirection;
+  /** Every language you can switch to, loaded or not, in the order they were added. The same array until one changes. */
+  listLocales(): readonly LocaleInfo[];
+  /** The code of the language being loaded, or `null`. */
+  getLoadingLocale(): string | null;
+  /**
+   * Switch the language, loading it first when it's in `loaders`. Resolves once it shows, and
+   * fires `onLocaleChanged`. Rejects `not-found` for a code that is neither loaded nor in
+   * `loaders`, `operation-failed` when it can't load (and fires `onLocaleLoadFailed`), and
+   * `operation-cancelled` when the signal fires or a newer call replaces it.
+   */
+  setLocale(code: string, options?: OperationOptions): Promise<void>;
+  /** Add a whole language, and get a function that removes it again. */
+  registerLocale(locale: Locale): Unsubscribe;
+  /**
+   * Add strings to a language, loaded or not, replacing the ones with the same key; dotted keys
+   * work. A language in `loaders` gets them when it loads, on top of its own. Throws `not-found`
+   * for a code that is neither loaded nor in `loaders`.
+   */
+  addTranslations(code: string, translations: TranslationDictionary): void;
+  /** The current language changed and shows; never while a language is still loading. */
+  readonly onLocaleChanged: EventHook<LocaleChangedEvent>;
+  /** A language in `loaders` couldn't be loaded; the current language stays. */
+  readonly onLocaleLoadFailed: EventHook<LocaleLoadFailedEvent>;
+}
+//#endregion
+export { Locale as a, LocaleLoadFailedEvent as c, TranslateOptions as d, TranslationDictionary as f, I18nSettings as i, LocaleLoader as l, I18nCapability as n, LocaleChangedEvent as o, I18nToken as p, I18nConfig as r, LocaleInfo as s, I18N_DEFAULTS as t, TextDirection as u };
+//# sourceMappingURL=contract-D2EGxESh.d.ts.map

package/dist/contract-TF72RUxK.cjs

@@ -0,0 +1,25 @@
+//#region src/token.ts
+/** The package token, created once here and re-exported by `contract.ts`. */
+const I18nToken = (0, require("@embedpdf/core").createCapabilityToken)("i18n", { hint: `add i18nPlugin() from '@embedpdf/plugin-i18n' to your plugins list` });
+/** What the i18n settings are when the app registers none. */
+const I18N_DEFAULTS = {
+	locale: null,
+	fallbackLocale: "en",
+	locales: [],
+	loaders: {}
+};
+//#endregion
+Object.defineProperty(exports, "I18N_DEFAULTS", {
+	enumerable: true,
+	get: function() {
+		return I18N_DEFAULTS;
+	}
+});
+Object.defineProperty(exports, "I18nToken", {
+	enumerable: true,
+	get: function() {
+		return I18nToken;
+	}
+});
+
+//# sourceMappingURL=contract-TF72RUxK.cjs.map

package/dist/contract-TF72RUxK.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-TF72RUxK.cjs","names":[],"sources":["../src/token.ts","../src/contract.ts"],"sourcesContent":["/** The package token, created once here and re-exported by `contract.ts`. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { I18nCapability } from './contract';\n\nexport const I18nToken = createCapabilityToken<I18nCapability>('i18n', {\n  hint: `add i18nPlugin() from '@embedpdf/plugin-i18n' to your plugins list`,\n});\n","/**\n * @embedpdf/plugin-i18n/contract — translations and the current language.\n *\n * Languages are data: the packs live in the plugin's state, so `t()` is a pure\n * read and every reader follows the kernel's one change stream. The plugin is\n * workspace-scoped and needs no engine or document, so it translates a loading\n * screen and a password prompt too. It ships EmbedPDF's own strings (the\n * standard commands' labels) in eight languages, under the app's.\n */\nimport type {\n  DeepPartial,\n  EventHook,\n  OperationOptions,\n  PluginErrorInfo,\n  SettingsApi,\n  Unsubscribe,\n} from '@embedpdf/core';\n\nexport { I18nToken } from './token';\n\n/**\n * A tree of strings. A leaf may hold `{name}` slots. A dotted key is the same as a nested one:\n * `{ 'review.reject': 'Reject' }` is `{ review: { reject: 'Reject' } }`.\n */\nexport interface TranslationDictionary {\n  readonly [key: string]: string | TranslationDictionary;\n}\n\n/** How a language reads. */\nexport type TextDirection = 'ltr' | 'rtl';\n\n/** A language and its strings. */\nexport interface Locale {\n  /** Its language tag (RFC 5646): `'en'`, `'nl'`, `'ar'`, `'zh-CN'`. */\n  readonly code: string;\n  /** Its name in itself, as a language picker shows it: `'Nederlands'`. */\n  readonly name: string;\n  /** How it reads; `'ltr'` when left out. */\n  readonly direction?: TextDirection;\n  readonly translations: TranslationDictionary;\n}\n\n/** Loads a language the first time someone switches to it. */\nexport type LocaleLoader = () => Promise<Locale>;\n\n/**\n * The i18n plugin's settings. `i18nPlugin(config)` registers them over\n * {@link I18N_DEFAULTS}, and `updateSettings()` changes them while the app runs: a new `locale`\n * switches to it, new `locales` are registered, and `fallbackLocale` and `loaders` apply to the\n * next lookup and the next switch.\n */\nexport interface I18nSettings {\n  /**\n   * The language to start with; `null` starts with `fallbackLocale`. Pick it outside the plugin,\n   * which never reads the browser: `negotiateLocale(codes, navigator.languages)`. A language in\n   * `loaders` shows the fallback language until it has loaded.\n   */\n  readonly locale: string | null;\n  /** The language to use for a string another language doesn't have. */\n  readonly fallbackLocale: string;\n  /** Languages loaded from the start. */\n  readonly locales: readonly Locale[];\n  /**\n   * Languages loaded the first time someone switches to them, by code. Until then a language\n   * picker shows the code as the name.\n   */\n  readonly loaders: Readonly<Record<string, LocaleLoader>>;\n}\n\nconst NO_LOCALES: readonly Locale[] = [];\nconst NO_LOADERS: Readonly<Record<string, LocaleLoader>> = {};\n\n/** What the i18n settings are when the app registers none. */\nexport const I18N_DEFAULTS: I18nSettings = {\n  locale: null,\n  fallbackLocale: 'en',\n  locales: NO_LOCALES,\n  loaders: NO_LOADERS,\n};\n\n/** What `i18nPlugin(config)` takes: any of the settings, merged over the defaults. */\nexport type I18nConfig = DeepPartial<I18nSettings>;\n\nexport interface TranslateOptions {\n  /**\n   * The values of the string's `{name}` slots. A number `count` also picks the plural: a key\n   * whose string is `{ one, other }` gives the form for the language's plural rule\n   * (`Intl.PluralRules`), and `other` when the rule's form is missing.\n   *\n   * ```ts\n   * // pages: { one: '{count} page', other: '{count} pages' }\n   * t('pages', { params: { count: 1 } }) // '1 page'\n   * ```\n   */\n  params?: Record<string, string | number>;\n  /**\n   * Another key, read in each language that has no string for the key, before the fallback\n   * language is: a specific key in front of a general one.\n   *\n   * ```ts\n   * // a language's 'review:approve', else its 'commands.approve'\n   * t('review:approve', { fallbackKey: 'commands.approve' })\n   * ```\n   */\n  fallbackKey?: string;\n  /** What to show, with its slots filled, when no language has the key; the key itself otherwise. */\n  fallback?: string;\n}\n\n/** A language as a picker shows it: the loaded ones and the ones in `loaders`. */\nexport interface LocaleInfo {\n  readonly code: string;\n  /** Its name in itself; the code until a language in `loaders` has loaded. */\n  readonly name: string;\n  readonly direction: TextDirection;\n  readonly loaded: boolean;\n}\n\n// ── events ──\nexport interface LocaleChangedEvent {\n  readonly locale: string;\n  readonly previousLocale: string;\n}\nexport interface LocaleLoadFailedEvent {\n  readonly locale: string;\n  readonly error: PluginErrorInfo;\n}\n\nexport interface I18nCapability extends SettingsApi<I18nSettings> {\n  /**\n   * A string in the current language, with `params` filled in: the app's strings for the\n   * language, then EmbedPDF's own (for the key, then `options.fallbackKey`), then the same for\n   * the fallback language, then `options.fallback`, then the key. A key no language has warns\n   * once in the console.\n   */\n  t(key: string, options?: TranslateOptions): string;\n  /**\n   * A `t` function that stays the same until the language or the strings change, so a memoized\n   * component holding it renders again exactly when its strings may differ.\n   */\n  getTranslator(): (key: string, options?: TranslateOptions) => string;\n  /** Whether a key has a string in the current or the fallback language. Never warns. */\n  hasKey(key: string): boolean;\n  /** The current language's code. */\n  getLocale(): string;\n  /** How the current language reads: set it as `dir` on your viewer's root. */\n  getDirection(): TextDirection;\n  /** Every language you can switch to, loaded or not, in the order they were added. The same array until one changes. */\n  listLocales(): readonly LocaleInfo[];\n  /** The code of the language being loaded, or `null`. */\n  getLoadingLocale(): string | null;\n  /**\n   * Switch the language, loading it first when it's in `loaders`. Resolves once it shows, and\n   * fires `onLocaleChanged`. Rejects `not-found` for a code that is neither loaded nor in\n   * `loaders`, `operation-failed` when it can't load (and fires `onLocaleLoadFailed`), and\n   * `operation-cancelled` when the signal fires or a newer call replaces it.\n   */\n  setLocale(code: string, options?: OperationOptions): Promise<void>;\n  /** Add a whole language, and get a function that removes it again. */\n  registerLocale(locale: Locale): Unsubscribe;\n  /**\n   * Add strings to a language, loaded or not, replacing the ones with the same key; dotted keys\n   * work. A language in `loaders` gets them when it loads, on top of its own. Throws `not-found`\n   * for a code that is neither loaded nor in `loaders`.\n   */\n  addTranslations(code: string, translations: TranslationDictionary): void;\n  /** The current language changed and shows; never while a language is still loading. */\n  readonly onLocaleChanged: EventHook<LocaleChangedEvent>;\n  /** A language in `loaders` couldn't be loaded; the current language stays. */\n  readonly onLocaleLoadFailed: EventHook<LocaleLoadFailedEvent>;\n}\n"],"mappings":";;AAKA,MAAa,aAAA,2BAAA,CAAA,CAAA,sBAAA,CAAkD,QAAQ,EACrE,MAAM,qEACR,CAAC;;ACkED,MAAa,gBAA8B;CACzC,QAAQ;CACR,gBAAgB;CAChB,SAAS,CAAA;CACT,SAAS,CAAA;AACX"}

package/dist/contract-w0S-ipz5.js

@@ -0,0 +1,15 @@
+import { createCapabilityToken } from "@embedpdf/core";
+//#region src/token.ts
+/** The package token, created once here and re-exported by `contract.ts`. */
+const I18nToken = createCapabilityToken("i18n", { hint: `add i18nPlugin() from '@embedpdf/plugin-i18n' to your plugins list` });
+/** What the i18n settings are when the app registers none. */
+const I18N_DEFAULTS = {
+	locale: null,
+	fallbackLocale: "en",
+	locales: [],
+	loaders: {}
+};
+//#endregion
+export { I18nToken as n, I18N_DEFAULTS as t };
+
+//# sourceMappingURL=contract-w0S-ipz5.js.map

package/dist/contract-w0S-ipz5.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-w0S-ipz5.js","names":[],"sources":["../src/token.ts","../src/contract.ts"],"sourcesContent":["/** The package token, created once here and re-exported by `contract.ts`. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { I18nCapability } from './contract';\n\nexport const I18nToken = createCapabilityToken<I18nCapability>('i18n', {\n  hint: `add i18nPlugin() from '@embedpdf/plugin-i18n' to your plugins list`,\n});\n","/**\n * @embedpdf/plugin-i18n/contract — translations and the current language.\n *\n * Languages are data: the packs live in the plugin's state, so `t()` is a pure\n * read and every reader follows the kernel's one change stream. The plugin is\n * workspace-scoped and needs no engine or document, so it translates a loading\n * screen and a password prompt too. It ships EmbedPDF's own strings (the\n * standard commands' labels) in eight languages, under the app's.\n */\nimport type {\n  DeepPartial,\n  EventHook,\n  OperationOptions,\n  PluginErrorInfo,\n  SettingsApi,\n  Unsubscribe,\n} from '@embedpdf/core';\n\nexport { I18nToken } from './token';\n\n/**\n * A tree of strings. A leaf may hold `{name}` slots. A dotted key is the same as a nested one:\n * `{ 'review.reject': 'Reject' }` is `{ review: { reject: 'Reject' } }`.\n */\nexport interface TranslationDictionary {\n  readonly [key: string]: string | TranslationDictionary;\n}\n\n/** How a language reads. */\nexport type TextDirection = 'ltr' | 'rtl';\n\n/** A language and its strings. */\nexport interface Locale {\n  /** Its language tag (RFC 5646): `'en'`, `'nl'`, `'ar'`, `'zh-CN'`. */\n  readonly code: string;\n  /** Its name in itself, as a language picker shows it: `'Nederlands'`. */\n  readonly name: string;\n  /** How it reads; `'ltr'` when left out. */\n  readonly direction?: TextDirection;\n  readonly translations: TranslationDictionary;\n}\n\n/** Loads a language the first time someone switches to it. */\nexport type LocaleLoader = () => Promise<Locale>;\n\n/**\n * The i18n plugin's settings. `i18nPlugin(config)` registers them over\n * {@link I18N_DEFAULTS}, and `updateSettings()` changes them while the app runs: a new `locale`\n * switches to it, new `locales` are registered, and `fallbackLocale` and `loaders` apply to the\n * next lookup and the next switch.\n */\nexport interface I18nSettings {\n  /**\n   * The language to start with; `null` starts with `fallbackLocale`. Pick it outside the plugin,\n   * which never reads the browser: `negotiateLocale(codes, navigator.languages)`. A language in\n   * `loaders` shows the fallback language until it has loaded.\n   */\n  readonly locale: string | null;\n  /** The language to use for a string another language doesn't have. */\n  readonly fallbackLocale: string;\n  /** Languages loaded from the start. */\n  readonly locales: readonly Locale[];\n  /**\n   * Languages loaded the first time someone switches to them, by code. Until then a language\n   * picker shows the code as the name.\n   */\n  readonly loaders: Readonly<Record<string, LocaleLoader>>;\n}\n\nconst NO_LOCALES: readonly Locale[] = [];\nconst NO_LOADERS: Readonly<Record<string, LocaleLoader>> = {};\n\n/** What the i18n settings are when the app registers none. */\nexport const I18N_DEFAULTS: I18nSettings = {\n  locale: null,\n  fallbackLocale: 'en',\n  locales: NO_LOCALES,\n  loaders: NO_LOADERS,\n};\n\n/** What `i18nPlugin(config)` takes: any of the settings, merged over the defaults. */\nexport type I18nConfig = DeepPartial<I18nSettings>;\n\nexport interface TranslateOptions {\n  /**\n   * The values of the string's `{name}` slots. A number `count` also picks the plural: a key\n   * whose string is `{ one, other }` gives the form for the language's plural rule\n   * (`Intl.PluralRules`), and `other` when the rule's form is missing.\n   *\n   * ```ts\n   * // pages: { one: '{count} page', other: '{count} pages' }\n   * t('pages', { params: { count: 1 } }) // '1 page'\n   * ```\n   */\n  params?: Record<string, string | number>;\n  /**\n   * Another key, read in each language that has no string for the key, before the fallback\n   * language is: a specific key in front of a general one.\n   *\n   * ```ts\n   * // a language's 'review:approve', else its 'commands.approve'\n   * t('review:approve', { fallbackKey: 'commands.approve' })\n   * ```\n   */\n  fallbackKey?: string;\n  /** What to show, with its slots filled, when no language has the key; the key itself otherwise. */\n  fallback?: string;\n}\n\n/** A language as a picker shows it: the loaded ones and the ones in `loaders`. */\nexport interface LocaleInfo {\n  readonly code: string;\n  /** Its name in itself; the code until a language in `loaders` has loaded. */\n  readonly name: string;\n  readonly direction: TextDirection;\n  readonly loaded: boolean;\n}\n\n// ── events ──\nexport interface LocaleChangedEvent {\n  readonly locale: string;\n  readonly previousLocale: string;\n}\nexport interface LocaleLoadFailedEvent {\n  readonly locale: string;\n  readonly error: PluginErrorInfo;\n}\n\nexport interface I18nCapability extends SettingsApi<I18nSettings> {\n  /**\n   * A string in the current language, with `params` filled in: the app's strings for the\n   * language, then EmbedPDF's own (for the key, then `options.fallbackKey`), then the same for\n   * the fallback language, then `options.fallback`, then the key. A key no language has warns\n   * once in the console.\n   */\n  t(key: string, options?: TranslateOptions): string;\n  /**\n   * A `t` function that stays the same until the language or the strings change, so a memoized\n   * component holding it renders again exactly when its strings may differ.\n   */\n  getTranslator(): (key: string, options?: TranslateOptions) => string;\n  /** Whether a key has a string in the current or the fallback language. Never warns. */\n  hasKey(key: string): boolean;\n  /** The current language's code. */\n  getLocale(): string;\n  /** How the current language reads: set it as `dir` on your viewer's root. */\n  getDirection(): TextDirection;\n  /** Every language you can switch to, loaded or not, in the order they were added. The same array until one changes. */\n  listLocales(): readonly LocaleInfo[];\n  /** The code of the language being loaded, or `null`. */\n  getLoadingLocale(): string | null;\n  /**\n   * Switch the language, loading it first when it's in `loaders`. Resolves once it shows, and\n   * fires `onLocaleChanged`. Rejects `not-found` for a code that is neither loaded nor in\n   * `loaders`, `operation-failed` when it can't load (and fires `onLocaleLoadFailed`), and\n   * `operation-cancelled` when the signal fires or a newer call replaces it.\n   */\n  setLocale(code: string, options?: OperationOptions): Promise<void>;\n  /** Add a whole language, and get a function that removes it again. */\n  registerLocale(locale: Locale): Unsubscribe;\n  /**\n   * Add strings to a language, loaded or not, replacing the ones with the same key; dotted keys\n   * work. A language in `loaders` gets them when it loads, on top of its own. Throws `not-found`\n   * for a code that is neither loaded nor in `loaders`.\n   */\n  addTranslations(code: string, translations: TranslationDictionary): void;\n  /** The current language changed and shows; never while a language is still loading. */\n  readonly onLocaleChanged: EventHook<LocaleChangedEvent>;\n  /** A language in `loaders` couldn't be loaded; the current language stays. */\n  readonly onLocaleLoadFailed: EventHook<LocaleLoadFailedEvent>;\n}\n"],"mappings":";;;AAKA,MAAa,YAAY,sBAAsC,QAAQ,EACrE,MAAM,qEACR,CAAC;;ACkED,MAAa,gBAA8B;CACzC,QAAQ;CACR,gBAAgB;CAChB,SAAS,CAAA;CACT,SAAS,CAAA;AACX"}

package/dist/contract.cjs

@@ -1,3 +1,4 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_contract = require("./contract-BIk4Kv-7.cjs");
+const require_contract = require("./contract-TF72RUxK.cjs");
+exports.I18N_DEFAULTS = require_contract.I18N_DEFAULTS;
 exports.I18nToken = require_contract.I18nToken;

package/dist/contract.d.cts

@@ -1,2 +1,2 @@
-import { a as I18nToken, c as TranslateOptions, i as I18nState, l as TranslationDictionary, n as I18nCapability, o as Locale, r as I18nConfig, s as LocaleInfo } from "./contract-DCt9Ikqu.cjs";
-export { type I18nCapability, type I18nConfig, type I18nState, I18nToken, type Locale, type LocaleInfo, type TranslateOptions, type TranslationDictionary };
+import { a as Locale, c as LocaleLoadFailedEvent, d as TranslateOptions, f as TranslationDictionary, i as I18nSettings, l as LocaleLoader, n as I18nCapability, o as LocaleChangedEvent, p as I18nToken, r as I18nConfig, s as LocaleInfo, t as I18N_DEFAULTS, u as TextDirection } from "./contract-D2EGxESh.cjs";
+export { I18N_DEFAULTS, I18nCapability, I18nConfig, I18nSettings, I18nToken, Locale, LocaleChangedEvent, LocaleInfo, LocaleLoadFailedEvent, LocaleLoader, TextDirection, TranslateOptions, TranslationDictionary };

package/dist/contract.d.ts

@@ -1,2 +1,2 @@
-import { a as I18nToken, c as TranslateOptions, i as I18nState, l as TranslationDictionary, n as I18nCapability, o as Locale, r as I18nConfig, s as LocaleInfo } from "./contract-DCt9Ikqu.js";
-export { type I18nCapability, type I18nConfig, type I18nState, I18nToken, type Locale, type LocaleInfo, type TranslateOptions, type TranslationDictionary };
+import { a as Locale, c as LocaleLoadFailedEvent, d as TranslateOptions, f as TranslationDictionary, i as I18nSettings, l as LocaleLoader, n as I18nCapability, o as LocaleChangedEvent, p as I18nToken, r as I18nConfig, s as LocaleInfo, t as I18N_DEFAULTS, u as TextDirection } from "./contract-D2EGxESh.js";
+export { I18N_DEFAULTS, I18nCapability, I18nConfig, I18nSettings, I18nToken, Locale, LocaleChangedEvent, LocaleInfo, LocaleLoadFailedEvent, LocaleLoader, TextDirection, TranslateOptions, TranslationDictionary };

package/dist/contract.js

@@ -1,2 +1,2 @@
-import { t as I18nToken } from "./contract-D08iYq9-.js";
-export { I18nToken };
+import { n as I18nToken, t as I18N_DEFAULTS } from "./contract-w0S-ipz5.js";
+export { I18N_DEFAULTS, I18nToken };