@docx-editor.dev/core 2.10.0 → 2.12.0

package/dist/collaboration/replication.d.ts

@@ -0,0 +1,216 @@
+import { T as TreeModelChange } from '../tree-store-B7hd6cEa.js';
+import { g as OoxmlElement, b as OoxmlPackage } from '../tree-op-types-HKfUzt_-.js';
+import { T as TreePackageStore } from '../tree-package-fragment-oJZX_5iN.js';
+import '../contracts/types.js';
+
+/** Attribute name as the journal addresses it. Prefix is authored fidelity, not identity. @public */
+interface CanonicalAttributeName {
+    readonly namespaceUri: string;
+    readonly localName: string;
+    readonly prefix?: string;
+}
+/** Content-addressed binary part reference. Bytes stay out of the journal. @public */
+interface CanonicalBinaryDescriptor {
+    readonly storageKey: string;
+    readonly digest: string;
+    readonly size: number;
+    readonly mediaType: string;
+}
+/** Text node shell. Value arrives later through `spliceText`. @public */
+interface CanonicalTextNodeDescriptor {
+    readonly logicalId: string;
+    readonly kind: 'textValue';
+}
+/** OOXML element shell. Attributes, bindings, and children arrive as later effects. @public */
+interface CanonicalElementNodeDescriptor {
+    readonly logicalId: string;
+    readonly kind: OoxmlElement['kind'];
+    readonly qname: CanonicalAttributeName;
+}
+/** Immutable node record required to create a registry entry. @public */
+type CanonicalNodeDescriptor = CanonicalTextNodeDescriptor | CanonicalElementNodeDescriptor;
+/** One relationship as the journal records it. @public */
+interface CanonicalRelationshipRecord {
+    readonly ownerPart: string;
+    readonly id: string;
+    readonly type: string;
+    readonly rawTarget: string;
+    readonly targetMode: 'Internal' | 'External';
+    readonly order: number;
+}
+/** One compositional tree or package effect captured from a canonical write. @public */
+type CanonicalPrimitiveEffect = {
+    readonly kind: 'putNode';
+    readonly descriptor: CanonicalNodeDescriptor;
+} | {
+    readonly kind: 'spliceText';
+    readonly logicalId: string;
+    readonly utf16Start: number;
+    readonly deleteCount: number;
+    readonly insert: string;
+} | {
+    readonly kind: 'setAttribute';
+    readonly logicalId: string;
+    readonly qname: CanonicalAttributeName;
+    readonly value: string | null;
+} | {
+    readonly kind: 'setNamespaceBinding';
+    readonly logicalId: string;
+    readonly prefix: string;
+    readonly uri: string | null;
+} | {
+    readonly kind: 'spliceChildren';
+    readonly parentLogicalId: string;
+    readonly start: number;
+    readonly deleteCount: number;
+    readonly childLogicalIds: readonly string[];
+} | {
+    readonly kind: 'moveNode';
+    readonly logicalId: string;
+    readonly destinationParentLogicalId: string;
+    readonly destinationIndex: number;
+} | {
+    readonly kind: 'putXmlPart';
+    readonly name: string;
+    readonly rootLogicalId: string;
+} | {
+    readonly kind: 'deleteXmlPart';
+    readonly name: string;
+} | {
+    readonly kind: 'putRelationship';
+    readonly owner: string;
+    readonly record: CanonicalRelationshipRecord;
+} | {
+    readonly kind: 'deleteRelationship';
+    readonly owner: string;
+    readonly relationshipId: string;
+} | {
+    readonly kind: 'putContentTypeOverride';
+    readonly partName: string;
+    readonly mediaType: string;
+} | {
+    readonly kind: 'deleteContentTypeOverride';
+    readonly partName: string;
+} | {
+    readonly kind: 'putBinary';
+    readonly descriptor: CanonicalBinaryDescriptor;
+} | {
+    readonly kind: 'deleteBinary';
+    readonly storageKey: string;
+};
+/**
+ * One immutable journal for one `TreePackageStore` transaction.
+ *
+ * Empty only when a committed write used a path the journal does not yet intercept.
+ *
+ * @public
+ */
+interface CanonicalPrimitiveJournal {
+    readonly effects: readonly CanonicalPrimitiveEffect[];
+}
+
+/** Options for a canonical collaboration document port. @public */
+interface CreateCollaborationDocumentPortOptions {
+    readonly documentId: string;
+}
+/** Create the narrow collaboration view over one canonical package store. @public */
+declare function createCollaborationDocumentPort(store: TreePackageStore, options: CreateCollaborationDocumentPortOptions): CollaborationDocumentPort;
+
+/**
+ * `@docx-editor.dev/core/collaboration/replication` — the seam a replication implementation
+ * binds to, not the surface a host consumes.
+ *
+ * Everything here exists for the layer BETWEEN a CRDT and the canonical tree: the document
+ * port an adapter writes through, the primitive journal it reads, and the descriptors that
+ * journal is made of. A host that renders presence and reads a status needs none of it, which
+ * is why it lives behind its own subpath — autocomplete on
+ * `@docx-editor.dev/core/collaboration` should not offer `putXmlPart` and `spliceChildren` to
+ * somebody wiring up an avatar stack.
+ *
+ * Reach for this when you are writing a provider. `@docx-editor.dev/pro` is one.
+ *
+ * @packageDocumentation
+ * @public
+ */
+
+/** One existing body paragraph exposed to the replication adapter. @public */
+interface CollaborationParagraph {
+    /** Uppercase `w14:paraId`, stable across save and reopen. */
+    readonly paragraphId: string;
+    /** Replica-local canonical node identity. Never sent as wire identity. */
+    readonly nodeId: string;
+    /** Current canonical UTF-16 text. */
+    readonly text: string;
+}
+/** Attribution for one collaboration-derived canonical publication. @public */
+interface CollaborationMutation {
+    readonly origin: string;
+    readonly actorId: string;
+    readonly operationId: string;
+}
+/** One paragraph text value in an atomic collaboration publication. @public */
+interface CollaborationParagraphTextUpdate {
+    readonly paragraphId: string;
+    readonly text: string;
+}
+/** Result of replacing one supported paragraph's canonical text. @public */
+type CollaborationApplyResult = {
+    readonly ok: true;
+    readonly changed: boolean;
+} | {
+    readonly ok: false;
+    readonly reason: string;
+};
+/**
+ * Narrow canonical document capability handed to a collaboration implementation.
+ *
+ * It deliberately exposes no mutable package or tree store. Every write returns through the
+ * same validated transaction path as browser and automation edits.
+ *
+ * @public
+ */
+interface CollaborationDocumentPort {
+    readonly documentId: string;
+    paragraphs(): readonly CollaborationParagraph[];
+    paragraphByNodeId(nodeId: string): CollaborationParagraph | null;
+    /**
+     * Resolve a stable `w14:paraId` in any story this replica holds.
+     *
+     * `paragraphs()` stays body-only because text publication transacts against the body
+     * store. Presence may name a header, a footer, a note, or a cell, so this lookup covers
+     * those parts too. It resolves through an index, not a scan, because a remote caret
+     * resolves two addresses per selection on every caret move.
+     */
+    paragraphByStableId(paragraphId: string): CollaborationParagraph | null;
+    applyParagraphText(paragraphId: string, text: string, mutation: CollaborationMutation): CollaborationApplyResult;
+    applyParagraphTexts(updates: readonly CollaborationParagraphTextUpdate[], mutation: CollaborationMutation): CollaborationApplyResult;
+    /**
+     * Publish one remotely materialized canonical package as one revision.
+     *
+     * The package is frozen canonical state. This port exposes no mutable store or CRDT.
+     */
+    applyRemotePackage(pkg: OoxmlPackage, mutation: CollaborationMutation): CollaborationApplyResult;
+    revision(): number;
+    subscribe(listener: (change: TreeModelChange) => void): () => void;
+    /**
+     * Observe one settled primitive journal per committed canonical transaction.
+     *
+     * Disabled observation allocates no journal. This is the collaboration write seam;
+     * adapters never write a CRDT through this port.
+     */
+    observePrimitiveJournal(listener: (journal: CanonicalPrimitiveJournal) => void): () => void;
+    /** True when a committed journal has not yet been frozen or delivered to observers. */
+    hasPendingJournals(): boolean;
+    /**
+     * Freeze and deliver queued journals in production order.
+     *
+     * Local edit, layout, and paint do not wait for this. Tests and teardown call it
+     * instead of sleeping on the publication timer.
+     */
+    flushPendingJournals(): void;
+    save(): Uint8Array;
+    /** Bytes of one binary package part, or null when the part is absent. */
+    binaryPart(storageKey: string): Uint8Array | null;
+}
+
+export { type CanonicalAttributeName, type CanonicalBinaryDescriptor, type CanonicalElementNodeDescriptor, type CanonicalNodeDescriptor, type CanonicalPrimitiveEffect, type CanonicalPrimitiveJournal, type CanonicalRelationshipRecord, type CanonicalTextNodeDescriptor, type CollaborationApplyResult, type CollaborationDocumentPort, type CollaborationMutation, type CollaborationParagraph, type CollaborationParagraphTextUpdate, type CreateCollaborationDocumentPortOptions, createCollaborationDocumentPort };

package/dist/collaboration/replication.js

@@ -0,0 +1 @@
+export{b as createCollaborationDocumentPort}from'../chunk-W77HJGYX.js';import'../chunk-L6XZTLPS.js';

package/dist/collaboration.cjs

@@ -0,0 +1 @@
+'use strict';var chunkBTQKU64Q_cjs=require('./chunk-BTQKU64Q.cjs');var u={"already-initialized":true,"authentication-failed":true,"baseline-digest-mismatch":true,"baseline-too-large":true,"blob-digest-mismatch":true,"blob-read":true,"blob-store-full":true,"blob-too-large":true,"collaboration-session-destroyed":true,"collaboration-session-not-attached":true,"collaboration-session-not-ready":true,"collaboration-text-limit":true,"concurrent-seed":true,"document-id-mismatch":true,"duplicate-paragraph-id":true,"experimental-collaboration-body-text-only":true,"experimental-collaboration-existing-paragraphs-only":true,"experimental-collaboration-text-only":true,"experimental-collaboration-untracked-text-only":true,"immutable-baseline-changed":true,"immutable-metadata-changed":true,"initialization-aborted":true,"initialization-timeout":true,"invalid-baseline":true,"invalid-blob-descriptor":true,"invalid-bound":true,"invalid-document-id":true,"invalid-identity":true,"invalid-identity-color":true,"invalid-logical-id":true,"invalid-relationships":true,"invalid-session-id":true,"invalid-shared-metadata":true,"invalid-string":true,"local-mirror-failed":true,"materialize-dropped-content":true,"missing-blob":true,"missing-local-blob":true,"missing-root":true,"no-main-document-part":true,"not-initialized":true,"paragraph-set-mismatch":true,"port-already-attached":true,"protocol-version-mismatch":true,"prototype-key":true,"remote-apply-failed":true,"schema-version-mismatch":true,"shared-schema-invalid":true,"text-too-long":true,"too-many-attributes":true,"too-many-children":true,"too-many-nodes":true,"too-many-parts":true,"too-many-relationships":true,transport:true,"transport-disconnected":true,"tree-too-deep":true,"unknown-logical-id":true,"unknown-paragraph-id":true,"unsafe-part-name":true,"unsupported-root-key":true};function c(t){return Object.hasOwn(u,t)}function b(t,o){return t===o?true:!t||!o?false:t.code===o.code&&t.detail===o.detail}function p(t,o){return Object.freeze(o!==void 0&&o.length>0?{code:t,detail:o}:{code:t})}function m(t="initializing"){let o=t,e,r,n=Object.freeze({status:o,reason:e,lastFailure:r});return {status:()=>o,snapshot:()=>n,set(i,l,s){let a=l===void 0?void 0:p(l,s);return o===i&&b(e,a)?false:(o=i,e=a,i==="error"&&a&&(r=a),n=Object.freeze({status:o,reason:e,lastFailure:r}),true)}}}Object.defineProperty(exports,"safeParticipantColor",{enumerable:true,get:function(){return chunkBTQKU64Q_cjs.a}});exports.createCollaborationStatusTracker=m;exports.isCollaborationFailureCode=c;

package/dist/collaboration.d.cts

@@ -0,0 +1,176 @@
+import { S as StoryScope } from './tree-package-fragment-Cz-v-0B3.cjs';
+import { T as TreeDocOp } from './tree-op-types-CA7qgAUF.cjs';
+import { CollaborationDocumentPort } from './collaboration/replication.cjs';
+import { C as CollaborationStatus, a as CollaborationStatusSnapshot, b as CollaborationFailureCode } from './failure-BnGjoXf0.cjs';
+export { c as CollaborationFailure, d as createCollaborationStatusTracker, i as isCollaborationFailureCode } from './failure-BnGjoXf0.cjs';
+import './tree-store-BenW0Mg_.cjs';
+import './contracts/types.cjs';
+
+/**
+ * A peer's presence color is attacker-controlled: it arrives over awareness from whoever is in
+ * the room, and the engine paints it into a CSS custom property that the stylesheet consumes in
+ * a `background` shorthand. A custom property substitutes verbatim, so `url(...)` is a valid
+ * `<bg-image>` there — an unvalidated color is a zero-click GET to any host the peer names, on
+ * every replica that paints their caret. A length cap does not help: `url(//host/t)` is short.
+ *
+ * So the only colors that reach a style property are the two shapes this engine itself produces:
+ * a hex literal, or a reference to one of the review author slots the core stylesheet owns.
+ * Anything else is dropped and the caller falls back to the accent color.
+ */
+/**
+ * Return `value` when it is a color this engine can safely paint, otherwise `undefined`.
+ *
+ * @public
+ */
+declare function safeParticipantColor(value: string | undefined): string | undefined;
+
+/**
+ * `@docx-editor.dev/core/collaboration` — provider-neutral collaboration contracts.
+ *
+ * This lane names the attachment between the canonical tree and an optional replication
+ * implementation. It performs no networking and imports no CRDT.
+ *
+ * @packageDocumentation
+ * @public
+ */
+
+/** Human or automation identity attached to authored collaboration transactions. @public */
+interface CollaborationIdentity {
+    readonly actorId: string;
+    readonly name: string;
+    readonly color?: string;
+    readonly role?: 'human' | 'agent';
+}
+/** One validated identity visible through ephemeral collaboration presence. @public */
+interface CollaborationParticipant extends CollaborationIdentity {
+    readonly isLocal: boolean;
+}
+/**
+ * One endpoint of a published selection: a stable paragraph id and a UTF-16 offset.
+ *
+ * The wire payload carries only these two endpoints. The receiver walks its own canonical
+ * tree to find the paragraphs between them, so a select-all does not grow with document size.
+ *
+ * @public
+ */
+interface CollaborationSelectionAddress {
+    readonly paragraphId: string;
+    readonly offset: number;
+}
+/**
+ * How a published selection covers the document.
+ *
+ * Absent or omitted means a character range. `cells` means the table rectangle whose
+ * corner cells contain the two endpoints. The payload still carries only those endpoints,
+ * so a large table selection does not grow with the number of selected cells.
+ *
+ * @public
+ */
+type CollaborationSelectionKind = 'cells';
+/**
+ * One endpoint of a remote selection resolved into this replica's canonical addresses.
+ *
+ * `paragraphId` is the stable `w14:paraId`. `nodeId` is replica-local and is used to paint.
+ *
+ * @public
+ */
+interface CollaborationRemoteSelectionAddress {
+    readonly paragraphId: string;
+    readonly nodeId: string;
+    readonly offset: number;
+}
+/**
+ * Stable remote selection resolved into this replica's canonical paragraph addresses.
+ *
+ * Anchor and head may name different paragraphs. A collapsed caret is the same address twice.
+ *
+ * @public
+ */
+interface CollaborationRemoteSelection {
+    readonly actorId: string;
+    readonly name: string;
+    readonly color?: string;
+    readonly anchor: CollaborationRemoteSelectionAddress;
+    readonly head: CollaborationRemoteSelectionAddress;
+    readonly kind?: CollaborationSelectionKind;
+}
+/**
+ * Selection published by the local editor through ephemeral awareness.
+ *
+ * Publish an anchor address and a head address. Do not materialize every covered paragraph.
+ *
+ * @public
+ */
+interface CollaborationLocalSelection {
+    readonly anchor: CollaborationSelectionAddress;
+    readonly head: CollaborationSelectionAddress;
+    readonly kind?: CollaborationSelectionKind;
+}
+/**
+ * Optional replication session attached to an editor or headless automation host.
+ *
+ * Implementations own replication state only. The attached document port remains the authored
+ * authority for reads, layout, paint, and save.
+ *
+ * @public
+ */
+interface EditorCollaborationSession {
+    readonly documentId: string;
+    /** Unique identity for this attachment lifetime. It prevents operation ID reuse after reconnect. */
+    readonly sessionId: string;
+    readonly identity: CollaborationIdentity;
+    status(): CollaborationStatus;
+    /**
+     * Cached status, current reason, and last failure.
+     *
+     * Same reference until any of those values change. A host that mounts after a
+     * recovered error still reads {@link CollaborationStatusSnapshot.lastFailure}.
+     */
+    statusSnapshot(): CollaborationStatusSnapshot;
+    subscribeStatus(listener: (status: CollaborationStatus, reason?: CollaborationFailureCode, detail?: string) => void): () => void;
+    attach(port: CollaborationDocumentPort): () => void;
+    /**
+     * Whether an editor has attached its document port to this replica.
+     *
+     * False means edits do not replicate, whatever `status()` says — the usual cause is a host
+     * that did not remount the editor when the session appeared, so `collaborationModule`
+     * never attached. That mistake used to be reachable only as a `console.warn`, which a
+     * production build discards; this is the same fact as a value a host can render.
+     */
+    readonly attached: boolean;
+    gateOperations(ops: readonly TreeDocOp[], scope: StoryScope): CollaborationFailureCode | null;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    undo(): boolean;
+    redo(): boolean;
+    setLocalSelection(selection: CollaborationLocalSelection | null): void;
+    participants(): readonly CollaborationParticipant[];
+    subscribeParticipants(listener: (participants: readonly CollaborationParticipant[]) => void): () => void;
+    remoteSelections(): readonly CollaborationRemoteSelection[];
+    subscribeRemoteSelections(listener: (selections: readonly CollaborationRemoteSelection[]) => void): () => void;
+    /**
+     * Publish queued local journals to shared state.
+     *
+     * Local typing does not wait for replication. Undo, destroy, and page hide call this
+     * so a queued journal is never dropped.
+     */
+    flushPendingJournals(): void;
+    destroy(): void;
+}
+/**
+ * What a collaboration module contributes: the replica the surface attaches.
+ *
+ * @public
+ */
+interface CollaborationModuleContribution {
+    /**
+     * A ready session. The host creates the Yjs room, then wraps it with
+     * `collaborationModule({ session })`.
+     *
+     * Core does not build a session from a document id: the opened package has
+     * no collaboration room identity. That identity is chosen before mount.
+     */
+    readonly session: EditorCollaborationSession;
+}
+
+export { CollaborationFailureCode, type CollaborationIdentity, type CollaborationLocalSelection, type CollaborationModuleContribution, type CollaborationParticipant, type CollaborationRemoteSelection, type CollaborationRemoteSelectionAddress, type CollaborationSelectionAddress, type CollaborationSelectionKind, CollaborationStatus, CollaborationStatusSnapshot, type EditorCollaborationSession, safeParticipantColor };

package/dist/collaboration.d.ts

@@ -0,0 +1,176 @@
+import { S as StoryScope } from './tree-package-fragment-oJZX_5iN.js';
+import { T as TreeDocOp } from './tree-op-types-HKfUzt_-.js';
+import { CollaborationDocumentPort } from './collaboration/replication.js';
+import { C as CollaborationStatus, a as CollaborationStatusSnapshot, b as CollaborationFailureCode } from './failure-BnGjoXf0.js';
+export { c as CollaborationFailure, d as createCollaborationStatusTracker, i as isCollaborationFailureCode } from './failure-BnGjoXf0.js';
+import './tree-store-B7hd6cEa.js';
+import './contracts/types.js';
+
+/**
+ * A peer's presence color is attacker-controlled: it arrives over awareness from whoever is in
+ * the room, and the engine paints it into a CSS custom property that the stylesheet consumes in
+ * a `background` shorthand. A custom property substitutes verbatim, so `url(...)` is a valid
+ * `<bg-image>` there — an unvalidated color is a zero-click GET to any host the peer names, on
+ * every replica that paints their caret. A length cap does not help: `url(//host/t)` is short.
+ *
+ * So the only colors that reach a style property are the two shapes this engine itself produces:
+ * a hex literal, or a reference to one of the review author slots the core stylesheet owns.
+ * Anything else is dropped and the caller falls back to the accent color.
+ */
+/**
+ * Return `value` when it is a color this engine can safely paint, otherwise `undefined`.
+ *
+ * @public
+ */
+declare function safeParticipantColor(value: string | undefined): string | undefined;
+
+/**
+ * `@docx-editor.dev/core/collaboration` — provider-neutral collaboration contracts.
+ *
+ * This lane names the attachment between the canonical tree and an optional replication
+ * implementation. It performs no networking and imports no CRDT.
+ *
+ * @packageDocumentation
+ * @public
+ */
+
+/** Human or automation identity attached to authored collaboration transactions. @public */
+interface CollaborationIdentity {
+    readonly actorId: string;
+    readonly name: string;
+    readonly color?: string;
+    readonly role?: 'human' | 'agent';
+}
+/** One validated identity visible through ephemeral collaboration presence. @public */
+interface CollaborationParticipant extends CollaborationIdentity {
+    readonly isLocal: boolean;
+}
+/**
+ * One endpoint of a published selection: a stable paragraph id and a UTF-16 offset.
+ *
+ * The wire payload carries only these two endpoints. The receiver walks its own canonical
+ * tree to find the paragraphs between them, so a select-all does not grow with document size.
+ *
+ * @public
+ */
+interface CollaborationSelectionAddress {
+    readonly paragraphId: string;
+    readonly offset: number;
+}
+/**
+ * How a published selection covers the document.
+ *
+ * Absent or omitted means a character range. `cells` means the table rectangle whose
+ * corner cells contain the two endpoints. The payload still carries only those endpoints,
+ * so a large table selection does not grow with the number of selected cells.
+ *
+ * @public
+ */
+type CollaborationSelectionKind = 'cells';
+/**
+ * One endpoint of a remote selection resolved into this replica's canonical addresses.
+ *
+ * `paragraphId` is the stable `w14:paraId`. `nodeId` is replica-local and is used to paint.
+ *
+ * @public
+ */
+interface CollaborationRemoteSelectionAddress {
+    readonly paragraphId: string;
+    readonly nodeId: string;
+    readonly offset: number;
+}
+/**
+ * Stable remote selection resolved into this replica's canonical paragraph addresses.
+ *
+ * Anchor and head may name different paragraphs. A collapsed caret is the same address twice.
+ *
+ * @public
+ */
+interface CollaborationRemoteSelection {
+    readonly actorId: string;
+    readonly name: string;
+    readonly color?: string;
+    readonly anchor: CollaborationRemoteSelectionAddress;
+    readonly head: CollaborationRemoteSelectionAddress;
+    readonly kind?: CollaborationSelectionKind;
+}
+/**
+ * Selection published by the local editor through ephemeral awareness.
+ *
+ * Publish an anchor address and a head address. Do not materialize every covered paragraph.
+ *
+ * @public
+ */
+interface CollaborationLocalSelection {
+    readonly anchor: CollaborationSelectionAddress;
+    readonly head: CollaborationSelectionAddress;
+    readonly kind?: CollaborationSelectionKind;
+}
+/**
+ * Optional replication session attached to an editor or headless automation host.
+ *
+ * Implementations own replication state only. The attached document port remains the authored
+ * authority for reads, layout, paint, and save.
+ *
+ * @public
+ */
+interface EditorCollaborationSession {
+    readonly documentId: string;
+    /** Unique identity for this attachment lifetime. It prevents operation ID reuse after reconnect. */
+    readonly sessionId: string;
+    readonly identity: CollaborationIdentity;
+    status(): CollaborationStatus;
+    /**
+     * Cached status, current reason, and last failure.
+     *
+     * Same reference until any of those values change. A host that mounts after a
+     * recovered error still reads {@link CollaborationStatusSnapshot.lastFailure}.
+     */
+    statusSnapshot(): CollaborationStatusSnapshot;
+    subscribeStatus(listener: (status: CollaborationStatus, reason?: CollaborationFailureCode, detail?: string) => void): () => void;
+    attach(port: CollaborationDocumentPort): () => void;
+    /**
+     * Whether an editor has attached its document port to this replica.
+     *
+     * False means edits do not replicate, whatever `status()` says — the usual cause is a host
+     * that did not remount the editor when the session appeared, so `collaborationModule`
+     * never attached. That mistake used to be reachable only as a `console.warn`, which a
+     * production build discards; this is the same fact as a value a host can render.
+     */
+    readonly attached: boolean;
+    gateOperations(ops: readonly TreeDocOp[], scope: StoryScope): CollaborationFailureCode | null;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    undo(): boolean;
+    redo(): boolean;
+    setLocalSelection(selection: CollaborationLocalSelection | null): void;
+    participants(): readonly CollaborationParticipant[];
+    subscribeParticipants(listener: (participants: readonly CollaborationParticipant[]) => void): () => void;
+    remoteSelections(): readonly CollaborationRemoteSelection[];
+    subscribeRemoteSelections(listener: (selections: readonly CollaborationRemoteSelection[]) => void): () => void;
+    /**
+     * Publish queued local journals to shared state.
+     *
+     * Local typing does not wait for replication. Undo, destroy, and page hide call this
+     * so a queued journal is never dropped.
+     */
+    flushPendingJournals(): void;
+    destroy(): void;
+}
+/**
+ * What a collaboration module contributes: the replica the surface attaches.
+ *
+ * @public
+ */
+interface CollaborationModuleContribution {
+    /**
+     * A ready session. The host creates the Yjs room, then wraps it with
+     * `collaborationModule({ session })`.
+     *
+     * Core does not build a session from a document id: the opened package has
+     * no collaboration room identity. That identity is chosen before mount.
+     */
+    readonly session: EditorCollaborationSession;
+}
+
+export { CollaborationFailureCode, type CollaborationIdentity, type CollaborationLocalSelection, type CollaborationModuleContribution, type CollaborationParticipant, type CollaborationRemoteSelection, type CollaborationRemoteSelectionAddress, type CollaborationSelectionAddress, type CollaborationSelectionKind, CollaborationStatus, CollaborationStatusSnapshot, type EditorCollaborationSession, safeParticipantColor };

package/dist/collaboration.js

@@ -0,0 +1 @@
+export{a as safeParticipantColor}from'./chunk-6JIJOZDW.js';var u={"already-initialized":true,"authentication-failed":true,"baseline-digest-mismatch":true,"baseline-too-large":true,"blob-digest-mismatch":true,"blob-read":true,"blob-store-full":true,"blob-too-large":true,"collaboration-session-destroyed":true,"collaboration-session-not-attached":true,"collaboration-session-not-ready":true,"collaboration-text-limit":true,"concurrent-seed":true,"document-id-mismatch":true,"duplicate-paragraph-id":true,"experimental-collaboration-body-text-only":true,"experimental-collaboration-existing-paragraphs-only":true,"experimental-collaboration-text-only":true,"experimental-collaboration-untracked-text-only":true,"immutable-baseline-changed":true,"immutable-metadata-changed":true,"initialization-aborted":true,"initialization-timeout":true,"invalid-baseline":true,"invalid-blob-descriptor":true,"invalid-bound":true,"invalid-document-id":true,"invalid-identity":true,"invalid-identity-color":true,"invalid-logical-id":true,"invalid-relationships":true,"invalid-session-id":true,"invalid-shared-metadata":true,"invalid-string":true,"local-mirror-failed":true,"materialize-dropped-content":true,"missing-blob":true,"missing-local-blob":true,"missing-root":true,"no-main-document-part":true,"not-initialized":true,"paragraph-set-mismatch":true,"port-already-attached":true,"protocol-version-mismatch":true,"prototype-key":true,"remote-apply-failed":true,"schema-version-mismatch":true,"shared-schema-invalid":true,"text-too-long":true,"too-many-attributes":true,"too-many-children":true,"too-many-nodes":true,"too-many-parts":true,"too-many-relationships":true,transport:true,"transport-disconnected":true,"tree-too-deep":true,"unknown-logical-id":true,"unknown-paragraph-id":true,"unsafe-part-name":true,"unsupported-root-key":true};function c(t){return Object.hasOwn(u,t)}function b(t,o){return t===o?true:!t||!o?false:t.code===o.code&&t.detail===o.detail}function p(t,o){return Object.freeze(o!==void 0&&o.length>0?{code:t,detail:o}:{code:t})}function m(t="initializing"){let o=t,e,r,n=Object.freeze({status:o,reason:e,lastFailure:r});return {status:()=>o,snapshot:()=>n,set(i,l,s){let a=l===void 0?void 0:p(l,s);return o===i&&b(e,a)?false:(o=i,e=a,i==="error"&&a&&(r=a),n=Object.freeze({status:o,reason:e,lastFailure:r}),true)}}}export{m as createCollaborationStatusTracker,c as isCollaborationFailureCode};

package/dist/contracts/editor.cjs

@@ -1 +1 @@
-'use strict';var chunkYMYCPY5Y_cjs=require('../chunk-YMYCPY5Y.cjs');Object.defineProperty(exports,"EditorFontError",{enumerable:true,get:function(){return chunkYMYCPY5Y_cjs.a}});
+'use strict';var chunkOHJQ7GPZ_cjs=require('../chunk-OHJQ7GPZ.cjs');Object.defineProperty(exports,"EditorFontError",{enumerable:true,get:function(){return chunkOHJQ7GPZ_cjs.a}});

package/dist/contracts/editor.d.cts

@@ -1,11 +1,10 @@
 export { ContentControlSummary, DocEdits, DocQueries, DocQueryResults, ParagraphSummary } from './document.cjs';
-export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, a as ReviewItem, e as ReviewPosition, f as ReviewRange, b as ReviewRevisionItem, g as ReviewRevisionKind } from '../review-items-CwixiHNe.cjs';
-export { A as AuthoredNoteNumbering, C as CanResult, q as DocumentChange, r as DocumentEditingMode, t as DocumentHandle, D as DocumentSource, l as Editor, b as EditorCommand, u as EditorCommandShape, w as EditorCommands, x as EditorError, y as EditorEvents, E as EditorFontError, z as EditorFontErrorCode, B as EditorHeaderFooterCommands, G as EditorNoteCommands, H as EditorPosition, J as EditorQueries, K as EditorQuery, L as EditorQueryResults, M as EditorScope, N as EditorSelection, a as EditorSnapshot, F as FontConfiguration, m as FontFaceRequest, j as FontSource, k as FontSourceSubstitution, O as FurnitureVariant, P as HeaderFooterSlotArgs, Q as HeaderFooterState, R as HyperlinkInfo, I as ImageContext, c as ImageCropPercent, U as InteractionAffinity, W as InteractionOutcome, X as InteractionOutcomeCode, Y as NoteKind, _ as NotePropertiesSide, $ as NotePropertiesState, a0 as PageSetup, a1 as ResolvedNoteNumbering, a2 as ReviewActivationOptions, a3 as ReviewCommentPlacement, a4 as ReviewCustomPlacement, a5 as ReviewItemPlacement, a6 as ReviewItemPlacementBase, a7 as ReviewItemQuery, a8 as ReviewRevisionPlacement, S as SelectedImageState, a9 as SemanticIdentity, aa as SemanticTarget, T as TableBorderEdgeTarget, n as TableBorderSpec, o as TableBorderStyle, ab as TableBorderTarget, ac as TableCellVerticalAlignment, ad as TableColumnDividerResizeTarget, ae as TableColumnOccurrenceTarget, p as TableContext, af as TableRightEdgeResizeTarget, ag as TableRowOccurrenceTarget, ah as TextMatch, V as ViewScope, ai as ZoomFitTarget, Z as ZoomMode } from '../editor-CwzY2Hcg.cjs';
-export { S as SemanticPosition, a as SemanticSelection } from '../semantic-interaction-Z0xKQcB4.cjs';
+export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, a as ReviewItem, e as ReviewPosition, f as ReviewRange, b as ReviewRevisionItem, g as ReviewRevisionKind } from '../review-items-C-2WQdEb.cjs';
+export { A as AuthoredNoteNumbering, C as CanResult, r as DocumentChange, t as DocumentEditingMode, u as DocumentHandle, D as DocumentSource, l as Editor, b as EditorCommand, w as EditorCommandShape, x as EditorCommands, y as EditorError, z as EditorEvents, E as EditorFontError, B as EditorFontErrorCode, G as EditorFormatPainterCommands, H as EditorHeaderFooterCommands, J as EditorNoteCommands, K as EditorPosition, L as EditorQueries, M as EditorQuery, N as EditorQueryResults, O as EditorScope, P as EditorSelection, a as EditorSnapshot, F as FontConfiguration, n as FontFaceRequest, j as FontSource, k as FontSourceSubstitution, Q as FormatPainterLevel, R as FormatPainterMode, m as FormatPainterSurfaceState, U as FurnitureVariant, W as HeaderFooterSlotArgs, X as HeaderFooterState, Y as HyperlinkInfo, I as ImageContext, c as ImageCropPercent, _ as InteractionAffinity, $ as InteractionOutcome, a0 as InteractionOutcomeCode, a1 as NoteKind, a2 as NotePropertiesSide, a3 as NotePropertiesState, a4 as PageSetup, a5 as ResolvedNoteNumbering, a6 as ReviewActivationOptions, a7 as ReviewCommentPlacement, a8 as ReviewCustomPlacement, a9 as ReviewItemPlacement, aa as ReviewItemPlacementBase, ab as ReviewItemQuery, ac as ReviewRevisionPlacement, S as SelectedImageState, ad as SemanticIdentity, ae as SemanticTarget, T as TableBorderEdgeTarget, o as TableBorderSpec, p as TableBorderStyle, af as TableBorderTarget, ag as TableCellVerticalAlignment, ah as TableColumnDividerResizeTarget, ai as TableColumnOccurrenceTarget, q as TableContext, aj as TableRightEdgeResizeTarget, ak as TableRowOccurrenceTarget, al as TextMatch, V as ViewScope, am as ZoomFitTarget, Z as ZoomMode } from '../editor-B76SEMZw.cjs';
+export { S as SemanticPosition, a as SemanticSelection } from '../semantic-interaction-DiOX0FIH.cjs';
+export { z as DrawingHorizontalReferenceFrame, D as DrawingKind, w as DrawingLocks, v as DrawingPositionInput, A as DrawingVerticalReferenceFrame, x as ImageResourceState, u as ImageWrapTarget, P as PreservedImageMime, t as RenderableImageMime, R as RevisionAddress, y as SupportedImageMime, V as ValidatedImageBytesHandle, B as VectorImageMime } from '../tree-op-types-CA7qgAUF.cjs';
 export { Block, ColorValue, ContainerRef, ContentControl, ContentControlFilter, ContentControlType, DocAnchor, DocAnchorRange, DocComment, DocLocation, DocRange, DocTarget, DocumentBody, DocxDocument, DocxDocumentJSON, ExecErrorCode, ExecResult, Extent, FontDefinition, HeaderFooterSet, IndentFormatting, InsertableContentControlType, NumberingRef, PageMargins, Paragraph, ParagraphDisagreements, ParagraphFlags, ParagraphFormatCommand, ParagraphTabStop, Point, Rect, Revision, RevisionType, Run, RunFormatting, Section, SectionProperties, SelectionPin, StyleDefinition, StyleDefinitions, Table, TableCell, TableRow, Theme, ThemeColorScheme, Unsubscribe, Watermark } from './types.cjs';
-export { g as DrawingHorizontalReferenceFrame, D as DrawingKind, e as DrawingLocks, d as DrawingPositionInput, h as DrawingVerticalReferenceFrame, f as ImageResourceState, b as ImageWrapTarget, P as PreservedImageMime, R as RenderableImageMime, c as SupportedImageMime, V as ValidatedImageBytesHandle, i as VectorImageMime } from '../tree-op-types-DSJYmf5b.cjs';
-export { R as RevisionAddress } from '../tree-op-revision-attribution-CN06Xshv.cjs';
-import '../ooxml-package-CdEy9ufK.cjs';
-import '../semantic-records-CMakzQ1X.cjs';
-import '../revision-projection-Cc4wz30g.cjs';
-import '../omml-equation-BD-LsmWE.cjs';
+import '../failure-BnGjoXf0.cjs';
+import '../semantic-records-CRG1r6-a.cjs';
+import '../revision-projection-6u8lae9J.cjs';
+import '../omml-equation-BmV51rim.cjs';

package/dist/contracts/editor.d.ts

@@ -1,11 +1,10 @@
 export { ContentControlSummary, DocEdits, DocQueries, DocQueryResults, ParagraphSummary } from './document.js';
-export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, a as ReviewItem, e as ReviewPosition, f as ReviewRange, b as ReviewRevisionItem, g as ReviewRevisionKind } from '../review-items-Dw-8a6Ie.js';
-export { A as AuthoredNoteNumbering, C as CanResult, q as DocumentChange, r as DocumentEditingMode, t as DocumentHandle, D as DocumentSource, l as Editor, b as EditorCommand, u as EditorCommandShape, w as EditorCommands, x as EditorError, y as EditorEvents, E as EditorFontError, z as EditorFontErrorCode, B as EditorHeaderFooterCommands, G as EditorNoteCommands, H as EditorPosition, J as EditorQueries, K as EditorQuery, L as EditorQueryResults, M as EditorScope, N as EditorSelection, a as EditorSnapshot, F as FontConfiguration, m as FontFaceRequest, j as FontSource, k as FontSourceSubstitution, O as FurnitureVariant, P as HeaderFooterSlotArgs, Q as HeaderFooterState, R as HyperlinkInfo, I as ImageContext, c as ImageCropPercent, U as InteractionAffinity, W as InteractionOutcome, X as InteractionOutcomeCode, Y as NoteKind, _ as NotePropertiesSide, $ as NotePropertiesState, a0 as PageSetup, a1 as ResolvedNoteNumbering, a2 as ReviewActivationOptions, a3 as ReviewCommentPlacement, a4 as ReviewCustomPlacement, a5 as ReviewItemPlacement, a6 as ReviewItemPlacementBase, a7 as ReviewItemQuery, a8 as ReviewRevisionPlacement, S as SelectedImageState, a9 as SemanticIdentity, aa as SemanticTarget, T as TableBorderEdgeTarget, n as TableBorderSpec, o as TableBorderStyle, ab as TableBorderTarget, ac as TableCellVerticalAlignment, ad as TableColumnDividerResizeTarget, ae as TableColumnOccurrenceTarget, p as TableContext, af as TableRightEdgeResizeTarget, ag as TableRowOccurrenceTarget, ah as TextMatch, V as ViewScope, ai as ZoomFitTarget, Z as ZoomMode } from '../editor-C0my6Uta.js';
-export { S as SemanticPosition, a as SemanticSelection } from '../semantic-interaction-B6hFRQLy.js';
+export { C as CommentRecord, c as ReviewCommentItem, d as ReviewCustomItem, a as ReviewItem, e as ReviewPosition, f as ReviewRange, b as ReviewRevisionItem, g as ReviewRevisionKind } from '../review-items-B78OsJU2.js';
+export { A as AuthoredNoteNumbering, C as CanResult, r as DocumentChange, t as DocumentEditingMode, u as DocumentHandle, D as DocumentSource, l as Editor, b as EditorCommand, w as EditorCommandShape, x as EditorCommands, y as EditorError, z as EditorEvents, E as EditorFontError, B as EditorFontErrorCode, G as EditorFormatPainterCommands, H as EditorHeaderFooterCommands, J as EditorNoteCommands, K as EditorPosition, L as EditorQueries, M as EditorQuery, N as EditorQueryResults, O as EditorScope, P as EditorSelection, a as EditorSnapshot, F as FontConfiguration, n as FontFaceRequest, j as FontSource, k as FontSourceSubstitution, Q as FormatPainterLevel, R as FormatPainterMode, m as FormatPainterSurfaceState, U as FurnitureVariant, W as HeaderFooterSlotArgs, X as HeaderFooterState, Y as HyperlinkInfo, I as ImageContext, c as ImageCropPercent, _ as InteractionAffinity, $ as InteractionOutcome, a0 as InteractionOutcomeCode, a1 as NoteKind, a2 as NotePropertiesSide, a3 as NotePropertiesState, a4 as PageSetup, a5 as ResolvedNoteNumbering, a6 as ReviewActivationOptions, a7 as ReviewCommentPlacement, a8 as ReviewCustomPlacement, a9 as ReviewItemPlacement, aa as ReviewItemPlacementBase, ab as ReviewItemQuery, ac as ReviewRevisionPlacement, S as SelectedImageState, ad as SemanticIdentity, ae as SemanticTarget, T as TableBorderEdgeTarget, o as TableBorderSpec, p as TableBorderStyle, af as TableBorderTarget, ag as TableCellVerticalAlignment, ah as TableColumnDividerResizeTarget, ai as TableColumnOccurrenceTarget, q as TableContext, aj as TableRightEdgeResizeTarget, ak as TableRowOccurrenceTarget, al as TextMatch, V as ViewScope, am as ZoomFitTarget, Z as ZoomMode } from '../editor-BcdsPdbY.js';
+export { S as SemanticPosition, a as SemanticSelection } from '../semantic-interaction-C00BpIyC.js';
+export { z as DrawingHorizontalReferenceFrame, D as DrawingKind, w as DrawingLocks, v as DrawingPositionInput, A as DrawingVerticalReferenceFrame, x as ImageResourceState, u as ImageWrapTarget, P as PreservedImageMime, t as RenderableImageMime, R as RevisionAddress, y as SupportedImageMime, V as ValidatedImageBytesHandle, B as VectorImageMime } from '../tree-op-types-HKfUzt_-.js';
 export { Block, ColorValue, ContainerRef, ContentControl, ContentControlFilter, ContentControlType, DocAnchor, DocAnchorRange, DocComment, DocLocation, DocRange, DocTarget, DocumentBody, DocxDocument, DocxDocumentJSON, ExecErrorCode, ExecResult, Extent, FontDefinition, HeaderFooterSet, IndentFormatting, InsertableContentControlType, NumberingRef, PageMargins, Paragraph, ParagraphDisagreements, ParagraphFlags, ParagraphFormatCommand, ParagraphTabStop, Point, Rect, Revision, RevisionType, Run, RunFormatting, Section, SectionProperties, SelectionPin, StyleDefinition, StyleDefinitions, Table, TableCell, TableRow, Theme, ThemeColorScheme, Unsubscribe, Watermark } from './types.js';
-export { g as DrawingHorizontalReferenceFrame, D as DrawingKind, e as DrawingLocks, d as DrawingPositionInput, h as DrawingVerticalReferenceFrame, f as ImageResourceState, b as ImageWrapTarget, P as PreservedImageMime, R as RenderableImageMime, c as SupportedImageMime, V as ValidatedImageBytesHandle, i as VectorImageMime } from '../tree-op-types-BuOfCrkp.js';
-export { R as RevisionAddress } from '../tree-op-revision-attribution-CN06Xshv.js';
-import '../ooxml-package-CdEy9ufK.js';
-import '../semantic-records-Do3-i5oB.js';
-import '../revision-projection-CILpvv4M.js';
-import '../omml-equation-Dd3mBep-.js';
+import '../failure-BnGjoXf0.js';
+import '../semantic-records-CzI0ZEuR.js';
+import '../revision-projection-B2v9U3qx.js';
+import '../omml-equation-69O1Pd8G.js';

package/dist/contracts/editor.js

@@ -1 +1 @@
-export{a as EditorFontError}from'../chunk-PSZH2VXP.js';
+export{a as EditorFontError}from'../chunk-GOEBQ26R.js';