superdoc 2.4.0-next.56 → 2.4.0-next.58

package/README.md

@@ -1,103 +1,28 @@
-# SuperDoc
+# superdoc
 
-> The document engine for DOCX files.
+Browser editor for opening, editing, and rendering DOCX files.
 
-[![Documentation](https://img.shields.io/badge/docs-available-1355ff.svg)](https://docs.superdoc.dev/)
-[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-1355ff.svg)](https://www.gnu.org/licenses/agpl-3.0)
-[![npm version](https://img.shields.io/npm/v/superdoc.svg?color=1355ff)](https://www.npmjs.com/package/superdoc)
-[![Discord](https://img.shields.io/badge/discord-join-1355ff)](https://discord.com/invite/b9UuaZRyaB)
-
-SuperDoc renders and edits DOCX files in the browser. Built on OOXML, not bolted onto HTML. As you type, you write directly to the XML, so edits do not pass through an HTML conversion step.
-
-## Features
-
-- **Real DOCX, not rich text** — Built on OOXML. Pagination, section breaks, headers/footers, and complex tables are modeled as themselves, not flattened into HTML. Not a contenteditable wrapper with export bolted on.
-- **Self-hosted** — The editor needs no server of its own. Documents go where your application sends them, and nowhere else by default.
-- **Any framework** — React, Vue, Angular, Svelte, vanilla JS. One component, zero lock-in.
-- **Real-time collaboration** — Yjs-based CRDT. Multiplayer editing with comments, tracked changes, and automatic conflict resolution.
-- **Built for agents** — [SDK](https://www.npmjs.com/package/@superdoc/sdk), [CLI](https://www.npmjs.com/package/@superdoc/cli), and [MCP server](https://www.npmjs.com/package/@superdoc/mcp) let LLMs read, edit, and save .docx files programmatically.
-- **Dual licensed** — AGPLv3 for community use. [Commercial license](https://www.superdocportal.dev/get-in-touch) for proprietary deployments.
-
-## Quick start
+## Install
 
 ```bash
 npm install superdoc
 ```
 
-SuperDoc mounts into an element you provide, so the page needs it before this
-runs:
-
-```html
-<div id="superdoc"></div>
-```
-
-```javascript
-import 'superdoc/style.css';
-import { SuperDoc } from 'superdoc';
-
-const superdoc = new SuperDoc({
-  selector: '#superdoc',
-  documentMode: 'editing',
-  document: fileObject,
-});
-```
-
-`document` accepts a URL, a `File`, or a `Blob`. Omit it to start from a blank
-DOCX. The constructor throws if `selector` matches no element.
-
-Supported document modes are `editing`, `viewing`, and `suggesting`. Do not use `edit`, `view`, or `suggest`.
-
-### Browser Document API contract
-
-`superdoc.activeEditor.doc` is the browser-facing v2 Document API facade. In the
-browser it is intentionally async-capable, so custom UI code must tolerate
-promise-returning reads and writes, including the default worker-backed runtime.
-SDK/headless document-automation surfaces remain synchronous; this async
-contract is specific to the browser `superdoc` package.
-
-### Vanilla wrapper for a DOCX file
-
-When an agent needs to create a small vanilla JS wrapper around a DOCX `File`, use this shape:
+## Quick start
 
-```javascript
+```js
 import { SuperDoc } from 'superdoc';
 import 'superdoc/style.css';
 
-export function embedSuperDoc({ file }) {
-  return new SuperDoc({
-    selector: '#editor',
-    documentMode: 'editing',
-    document: file,
-  });
-}
-```
-
-For React, Vue, and other frameworks, see the [documentation](https://docs.superdoc.dev).
-
-### Using an AI coding agent?
-
-```bash
-claude mcp add superdoc -- npx @superdoc/mcp        # connect agent to DOCX files
+const editor = new SuperDoc({
+  selector: '#editor',
+  document: '/document.docx',
+});
 ```
 
-## Documentation
-
-[docs.superdoc.dev](https://docs.superdoc.dev) — installation, integration guides, collaboration setup, API reference, and more.
-
-## Contributing
-
-Check the [issue tracker](https://github.com/superdoc/docx-editor/issues) for open issues, or read the [Contributing Guide](https://github.com/superdoc/docx-editor/blob/main/CONTRIBUTING.md) to get started. Bug reports with reproduction .docx files are especially valuable.
-
-## Community
-
-- [Discord](https://discord.com/invite/b9UuaZRyaB) — Chat with the team and other contributors
-- [Email](mailto:q@superdoc.dev) — Reach the team directly
+See the [editor quick start](https://docs.superdoc.dev/editor/quickstart) for a complete example and the
+[SuperDoc documentation](https://docs.superdoc.dev) for configuration and APIs.
 
 ## License
 
-- Open source: [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html)
-- Commercial: [Enterprise License](https://www.superdocportal.dev/get-in-touch)
-
----
-
-Created and maintained by [SuperDoc](https://www.superdoc.dev).
+AGPL-3.0. Commercial licenses are available from [SuperDoc](https://www.superdoc.dev).

package/dist/collaboration-upgrade-engine.cjs

@@ -19,7 +19,7 @@ var COLLABORATION_UPGRADE_ENGINE_MINIMUM_NODE_MAJOR = 20;
 var PRIVATE_ENGINE_INFO = (0, _superdoc_docx_engine_collaboration_upgrade_engine.getCollaborationUpgradeEngineInfo)();
 var ENGINE_INFO = Object.freeze({
 	...PRIVATE_ENGINE_INFO,
-	superdocVersion: "2.4.0-next.56",
+	superdocVersion: "2.4.0-next.58",
 	roomSchemaVersion: Object.freeze({ ...PRIVATE_ENGINE_INFO.roomSchemaVersion }),
 	supportedBundleVersions: SUPPORTED_COLLABORATION_UPGRADE_BUNDLE_VERSIONS,
 	supportedV1ReaderContractVersions: SUPPORTED_V1_READER_CONTRACT_VERSIONS

package/dist/collaboration-upgrade-engine.es.js

@@ -18,7 +18,7 @@ var COLLABORATION_UPGRADE_ENGINE_MINIMUM_NODE_MAJOR = 20;
 var PRIVATE_ENGINE_INFO = getCollaborationUpgradeEngineInfo$1();
 var ENGINE_INFO = Object.freeze({
 	...PRIVATE_ENGINE_INFO,
-	superdocVersion: "2.4.0-next.56",
+	superdocVersion: "2.4.0-next.58",
 	roomSchemaVersion: Object.freeze({ ...PRIVATE_ENGINE_INFO.roomSchemaVersion }),
 	supportedBundleVersions: SUPPORTED_COLLABORATION_UPGRADE_BUNDLE_VERSIONS,
 	supportedV1ReaderContractVersions: SUPPORTED_V1_READER_CONTRACT_VERSIONS

package/dist/layout-engine/layout-bridge/src/incrementalLayout.d.ts

@@ -195,6 +195,8 @@ export type IncrementalLayoutTailAdoption = {
     pageIndexDelta: number;
     sectionPageNumberTransform: IncrementalSectionPageNumberTransform | null;
     displayPageNumberTransform?: IncrementalDisplayPageNumberTransform | null;
+    /** Exact proof that PAGEREF page/numbering locations are unchanged in the adopted tail. */
+    pageReferenceLocationsStable: boolean;
     sourceLayoutEpoch: number | null;
     positionTransforms: readonly LayoutPositionTransform[];
     /** Lazy old->current block-id rekeys for an ordinal-changing structural splice. */

package/dist/superdoc.cjs

@@ -43261,7 +43261,7 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 		this.config.colors = shuffleArray(this.config.colors);
 		this.userColorMap = /* @__PURE__ */ new Map();
 		this.colorIndex = 0;
-		this.version = "2.4.0-next.56";
+		this.version = "2.4.0-next.58";
 		this.#log("🦋 [superdoc] Using SuperDoc version:", this.version);
 		this.superdocId = config.superdocId || require_uuid.v4();
 		this.colors = this.config.colors ?? [];

package/dist/superdoc.es.js

@@ -43194,7 +43194,7 @@ var SuperDoc = class extends import_eventemitter3.default {
 		this.config.colors = shuffleArray(this.config.colors);
 		this.userColorMap = /* @__PURE__ */ new Map();
 		this.colorIndex = 0;
-		this.version = "2.4.0-next.56";
+		this.version = "2.4.0-next.58";
 		this.#log("🦋 [superdoc] Using SuperDoc version:", this.version);
 		this.superdocId = config.superdocId || v4();
 		this.colors = this.config.colors ?? [];