@eigenpal/docx-editor-i18n 0.0.0 → 1.0.1

package/README.md

@@ -1,3 +1,17 @@
+<p align="center">
+  <a href="https://www.docx-editor.dev/">
+    <img src="https://raw.githubusercontent.com/eigenpal/docx-editor/main/assets/header.png" alt="DOCX Editor — .docx in, .docx out. Open source, agent ready, client-side." width="500" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@eigenpal/docx-editor-i18n"><img src="https://img.shields.io/npm/v/@eigenpal/docx-editor-i18n.svg?style=flat-square&color=3B5BDB" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/@eigenpal/docx-editor-i18n"><img src="https://img.shields.io/npm/dm/@eigenpal/docx-editor-i18n.svg?style=flat-square&color=3B5BDB" alt="npm downloads" /></a>
+  <a href="https://github.com/eigenpal/docx-editor/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache_2.0-blue.svg?style=flat-square&color=3B5BDB" alt="license" /></a>
+  <a href="https://docx-editor.dev/editor"><img src="https://img.shields.io/badge/Live_Demo-3B5BDB?style=flat-square&logo=vercel&logoColor=white" alt="Demo" /></a>
+  <a href="https://www.docx-editor.dev/docs"><img src="https://img.shields.io/badge/Docs-3B5BDB?style=flat-square&logo=readthedocs&logoColor=white" alt="Documentation" /></a>
+</p>
+
 # @eigenpal/docx-editor-i18n
 
 Shared locale strings, types, and runtime helpers for the [docx-editor](https://docx-editor.dev) adapters. One source of truth for translations consumed by `@eigenpal/docx-editor-react` and `@eigenpal/docx-editor-vue`.
@@ -33,6 +47,18 @@ const myLocale = {
 
 Keys set to `null` in any locale fall back to English.
 
+## Packages
+
+| Package                                                                                      | Description                                                                                                                                |
+| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [`@eigenpal/docx-editor-react`](https://www.npmjs.com/package/@eigenpal/docx-editor-react)   | <img src="https://cdn.simpleicons.org/react/61DAFB" width="20" align="middle" /> &nbsp; React adapter. Toolbar, paged editor, plugins.     |
+| [`@eigenpal/docx-editor-vue`](https://www.npmjs.com/package/@eigenpal/docx-editor-vue)       | <img src="https://cdn.simpleicons.org/vuedotjs/4FC08D" width="20" align="middle" /> &nbsp; Vue 3 adapter. Toolbar, paged editor, plugins.  |
+| [`@eigenpal/docx-editor-core`](https://www.npmjs.com/package/@eigenpal/docx-editor-core)     | Framework-agnostic core: OOXML parser, serializer, layout engine, ProseMirror schema. Depend on this if you fork the React or Vue adapter. |
+| [`@eigenpal/docx-editor-i18n`](https://www.npmjs.com/package/@eigenpal/docx-editor-i18n)     | Shared locale strings and types consumed by both adapters.                                                                                 |
+| [`@eigenpal/docx-editor-agents`](https://www.npmjs.com/package/@eigenpal/docx-editor-agents) | Agent SDK and chat UI: framework-agnostic bridge, MCP server, AI SDK adapters, plus React UI.                                              |
+
+> **Forking the adapter?** Keep your fork thin. Depend on `@eigenpal/docx-editor-core` directly so parser, serializer, and rendering fixes land in your build automatically, without backporting each upstream change by hand.
+
 ## Available locales
 
 | Code    | Export | Language            |
@@ -54,6 +80,20 @@ import { locales } from '@eigenpal/docx-editor-i18n';
 
 > Importing `locales` pulls every locale into your bundle. For a smaller bundle, import only the ones you need by name; `sideEffects: false` lets the rest tree-shake.
 
+## Per-locale subpaths
+
+For apps that pick the locale at runtime, the named exports above don't tree-shake — the bundler can't know which locale wins, so it ships them all. Use the per-locale subpaths instead. Each one bundles a single locale (~30KB) and code-splits cleanly:
+
+```ts
+// Static — bundler ships only this locale's strings
+import pl from '@eigenpal/docx-editor-i18n/pl';
+
+// Dynamic — splits into its own chunk, loaded on demand
+const pl = (await import('@eigenpal/docx-editor-i18n/pl')).default;
+```
+
+Subpaths ship for every locale: `/en`, `/de`, `/he`, `/pl`, `/pt-BR`, `/tr`, `/zh-CN`. Each also exports its locale as a named binding (`import { pl } from '@eigenpal/docx-editor-i18n/pl'`) for callers that prefer non-default imports.
+
 ## Types
 
 ```ts
@@ -80,6 +120,13 @@ t('toolbar.bold'); // 'Fett'
 t('dialogs.findReplace.matchCount', { current: 3, total: 15 }); // ICU plurals
 ```
 
+`en.json` is the source of truth. Add keys there, then run `bun run i18n:fix` from the repo root to sync community locales (new keys land as `null`). Full guide: [docs/i18n.md](https://github.com/eigenpal/docx-editor/blob/main/docs/i18n.md).
+
 ## Contributing
 
-`en.json` is the source of truth. Add keys there, then run `bun run i18n:fix` from the repo root to sync community locales (new keys land as `null`). Full guide: [docs/i18n.md](https://github.com/eigenpal/docx-editor/blob/main/docs/i18n.md).
+Contributions welcome. See [CONTRIBUTING.md](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) for setup, tests, and the one-time CLA signature.
+
+## Commercial Support
+
+> [!TIP]
+> Questions or custom features? Email **[docx-editor@eigenpal.com](mailto:docx-editor@eigenpal.com)**.

package/dist/de.d.mts

@@ -0,0 +1,33 @@
+/**
+ * @eigenpal/docx-editor-i18n/de
+ *
+ * German (`de`) — direct locale subpath for per-locale code-splitting.
+ *
+ * ```ts
+ * // Static — bundler ships only this locale's strings
+ * import de from '@eigenpal/docx-editor-i18n/de';
+ *
+ * // Dynamic — splits into its own chunk, loaded on demand
+ * const de = (await import('@eigenpal/docx-editor-i18n/de')).default;
+ * ```
+ *
+ * For multi-locale apps, prefer the per-locale subpaths over importing
+ * `locales` from the package root — `locales` pulls every locale into
+ * the bundle.
+ *
+ * @packageDocumentation
+ * @public
+ */
+import { PartialLocaleStrings } from './index.mjs';
+
+/**
+ * German (`de`) locale strings. Community-maintained; null leaves fall back to English.
+ *
+ * Identical content to the named `de` export from the package root;
+ * this subpath just lets bundlers code-split it.
+ *
+ * @public
+ */
+declare const de: PartialLocaleStrings;
+
+export { de, de as default };

package/dist/de.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @eigenpal/docx-editor-i18n/de
+ *
+ * German (`de`) — direct locale subpath for per-locale code-splitting.
+ *
+ * ```ts
+ * // Static — bundler ships only this locale's strings
+ * import de from '@eigenpal/docx-editor-i18n/de';
+ *
+ * // Dynamic — splits into its own chunk, loaded on demand
+ * const de = (await import('@eigenpal/docx-editor-i18n/de')).default;
+ * ```
+ *
+ * For multi-locale apps, prefer the per-locale subpaths over importing
+ * `locales` from the package root — `locales` pulls every locale into
+ * the bundle.
+ *
+ * @packageDocumentation
+ * @public
+ */
+import { PartialLocaleStrings } from './index.js';
+
+/**
+ * German (`de`) locale strings. Community-maintained; null leaves fall back to English.
+ *
+ * Identical content to the named `de` export from the package root;
+ * this subpath just lets bundlers code-split it.
+ *
+ * @public
+ */
+declare const de: PartialLocaleStrings;
+
+export { de, de as default };