docxodus 12.3.0 → 12.4.1

package/README.md

@@ -92,7 +92,7 @@ runtime location auto-detected — no build step, no configuration:
 ```html
 <div id="doc" style="height: 100dvh"></div>
 <script type="module">
-  import { createRibbonEditor } from 'https://cdn.jsdelivr.net/npm/docxodus@12.2.0/dist/embed.bundle.js';
+  import { createRibbonEditor } from 'https://cdn.jsdelivr.net/npm/docxodus@12.3.0/dist/embed.bundle.js';
   const ribbon = await createRibbonEditor('#doc', './contract.docx'); // or bytes / Blob / File
   // ...later: const editedBytes = ribbon.save();
 </script>
@@ -275,6 +275,29 @@ function DocumentComparer() {
 }
 ```
 
+## Node.js (ES modules)
+
+Import the engine from `docxodus/core` for server-side conversion, comparison, annotations,
+and document sessions. It loads without a bundler or a custom Node loader:
+
+```js
+import { readFile, writeFile } from 'node:fs/promises';
+import { initialize, convertDocxToHtml, compareDocuments } from 'docxodus/core';
+
+await initialize(); // Finds the WASM runtime included in the installed package.
+const original = await readFile('original.docx');
+const revised = await readFile('revised.docx');
+await writeFile('original.html', await convertDocxToHtml(original));
+await writeFile('redline.docx', await compareDocuments(original, revised));
+```
+
+`docxodus/core` exposes the engine functions, types, enums, annotation helpers, and history
+APIs from `docxodus`, excluding `DocxEditor`, `CommentGutter`, `mountRibbon`, and their editor
+types. The existing `docxodus` entry includes those browser editor APIs and requires a browser
+bundler; use `docxodus/core` in plain Node ESM. Both entries share the same engine state.
+Browser helpers retained in `core`, such as pagination, the document viewport, IndexedDB
+storage, and history controls, still require their browser APIs when called.
+
 ## API Reference
 
 ### Package verification
@@ -580,7 +603,7 @@ so a page can embed a full viewer or editor without hosting anything itself.
 <div id="app" style="height: 100dvh"></div>
 <script type="module">
   import { createViewer, createEditor, createRibbonEditor }
-    from 'https://cdn.jsdelivr.net/npm/docxodus@12.2.0/dist/embed.bundle.js';
+    from 'https://cdn.jsdelivr.net/npm/docxodus@12.3.0/dist/embed.bundle.js';
 
   // Choose a factory, or render several into separate containers as shown.
   // Source may be a URL, Uint8Array, ArrayBuffer, Blob, or File.
@@ -610,7 +633,7 @@ For pages that can't use modules, `dist/embed.iife.js` exposes the same surface
 
 ```html
 <div id="doc"></div>
-<script src="https://cdn.jsdelivr.net/npm/docxodus@12.2.0/dist/embed.iife.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docxodus@12.3.0/dist/embed.iife.js"></script>
 <script>
   Docxodus.createRibbonEditor('#doc').then((ribbon) => { /* ... */ });
 </script>
@@ -626,7 +649,7 @@ first `<bundle dir>/wasm/`, then `<bundle dir>/` as a fallback. On a CDN that re
 
 ### CDN caveats
 
-- **Pin an exact version in production** (`docxodus@12.2.0`, not `@latest`) — CDN responses are
+- **Pin an exact version in production** (`docxodus@12.3.0`, not `@latest`) — CDN responses are
   cached as immutable, and the wire shapes between the JS wrappers and the WASM assemblies must
   come from the same release.
 - The build patches the .NET loader to fetch with `credentials: "omit"` — required because the
@@ -726,8 +749,10 @@ loading, comparison, checkpoint/restore and `.docxhistory` import/export over ho
 `mountHistoryControls` adds an accessible panel with separate previews, exact checkpoint retries
 and explicit history sharing. `openIndexedDbHistoryStore` provides optional browser persistence.
 These controls require `structuredClone` and `crypto.randomUUID`; the optional store also requires IndexedDB.
-The [TypeScript editor example](examples/history.ts) runs with `npm run build:history-example`
-and a local server serving `dist/wasm/history.html` after the WASM build.
+The [shared editor example](examples/editor.html) includes an optional **Version history** drawer.
+One `npm run build` produces the library, local editors and deployable site; run `npm run demo:serve`
+and open `http://localhost:8088/editor.html`. In an embed, pass `history: true` to
+`createRibbonEditor`, or `{ history: { workspaceId: "my-document" } }` to resume saved work across reloads.
 
 ## License