@arbidocs/coedit 0.4.110 → 0.4.112

package/dist/server.d.cts

@@ -2,6 +2,9 @@ import * as _docx_editor_dev_core_automation from '@docx-editor.dev/core/automat
 import { createServerAutomationHost, ServerAutomationHostOptions } from '@docx-editor.dev/core/automation';
 import * as Y from 'yjs';
 import { CollaborationIdentity } from '@docx-editor.dev/core/collaboration';
+import { TreePackageStore, PackageTransactResult, HeadlessDocumentView, ImageDecodePort } from '@docx-editor.dev/core/store';
+import { R as ReferencesPort } from './port-ip7WByvH.cjs';
+import { R as Revision } from './track-eYC94jTp.cjs';
 import { D as DocxCollaborationSession } from './session-Cf9iu1Vt.cjs';
 export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS } from './versions-DXiFQMA6.cjs';
 import 'y-protocols/awareness';
@@ -39,5 +42,41 @@ declare function openRoomAutomation(options: {
     identity: CollaborationIdentity;
     hostOptions?: Omit<ServerAutomationHostOptions, 'collaborationModel'>;
 }): RoomAutomation;
+/** A package store attached to a live room: writes go through `store` and reach the room on `flush`. */
+interface RoomStore {
+    store: TreePackageStore;
+    session: DocxCollaborationSession;
+    /**
+     * One transaction as the agent (attributed, outside the store's own history) on the body, or on
+     * another story (a note), mirrored into the room when it commits.
+     */
+    transact(build: Parameters<TreePackageStore['transact']>[1], scope?: Parameters<TreePackageStore['transact']>[0]): PackageTransactResult;
+    /** Mirror the store's other committed writes (an image insert) into the room. */
+    flush(): void;
+    /** The document as the store now holds it, for the shared readers (`@arbidocs/coedit/commands`). */
+    view(): HeadlessDocumentView;
+    /** Image dimensions from the file header, for `store.insertImage` (no pixel decode on a server). */
+    imageDecodePort: ImageDecodePort;
+    dispose(): void;
+}
+/**
+ * Open a package store over a live room, for the writes the automation protocol does not carry
+ * (fragment paste, notes, tracked table and image inserts, whole paragraph properties). Its commits
+ * are mirrored into `doc` exactly as a browser's are.
+ */
+declare function openRoomStore(options: {
+    doc: Y.Doc;
+    documentId: string;
+    identity: CollaborationIdentity;
+}): RoomStore;
+/**
+ * The defined-term and cross-reference commands' port (`@arbidocs/coedit/commands`) over a room
+ * store: the same commands the editor's toolbar runs, landing in the room. A caret is just a
+ * position here; pastes are fragment pastes, with a `revision` one tracked insertion by it.
+ */
+declare function roomCommandsPort(room: RoomStore, { revision, actorId }?: {
+    revision?: Revision | null;
+    actorId?: string;
+}): ReferencesPort;
 
-export { CollaborationCompatibilityError, type RoomAutomation, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, readRoom, seedRoom };
+export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, roomCommandsPort, seedRoom };

package/dist/server.d.ts

@@ -2,6 +2,9 @@ import * as _docx_editor_dev_core_automation from '@docx-editor.dev/core/automat
 import { createServerAutomationHost, ServerAutomationHostOptions } from '@docx-editor.dev/core/automation';
 import * as Y from 'yjs';
 import { CollaborationIdentity } from '@docx-editor.dev/core/collaboration';
+import { TreePackageStore, PackageTransactResult, HeadlessDocumentView, ImageDecodePort } from '@docx-editor.dev/core/store';
+import { R as ReferencesPort } from './port-ip7WByvH.js';
+import { R as Revision } from './track-eYC94jTp.js';
 import { D as DocxCollaborationSession } from './session-Cf9iu1Vt.js';
 export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS } from './versions-DXiFQMA6.js';
 import 'y-protocols/awareness';
@@ -39,5 +42,41 @@ declare function openRoomAutomation(options: {
     identity: CollaborationIdentity;
     hostOptions?: Omit<ServerAutomationHostOptions, 'collaborationModel'>;
 }): RoomAutomation;
+/** A package store attached to a live room: writes go through `store` and reach the room on `flush`. */
+interface RoomStore {
+    store: TreePackageStore;
+    session: DocxCollaborationSession;
+    /**
+     * One transaction as the agent (attributed, outside the store's own history) on the body, or on
+     * another story (a note), mirrored into the room when it commits.
+     */
+    transact(build: Parameters<TreePackageStore['transact']>[1], scope?: Parameters<TreePackageStore['transact']>[0]): PackageTransactResult;
+    /** Mirror the store's other committed writes (an image insert) into the room. */
+    flush(): void;
+    /** The document as the store now holds it, for the shared readers (`@arbidocs/coedit/commands`). */
+    view(): HeadlessDocumentView;
+    /** Image dimensions from the file header, for `store.insertImage` (no pixel decode on a server). */
+    imageDecodePort: ImageDecodePort;
+    dispose(): void;
+}
+/**
+ * Open a package store over a live room, for the writes the automation protocol does not carry
+ * (fragment paste, notes, tracked table and image inserts, whole paragraph properties). Its commits
+ * are mirrored into `doc` exactly as a browser's are.
+ */
+declare function openRoomStore(options: {
+    doc: Y.Doc;
+    documentId: string;
+    identity: CollaborationIdentity;
+}): RoomStore;
+/**
+ * The defined-term and cross-reference commands' port (`@arbidocs/coedit/commands`) over a room
+ * store: the same commands the editor's toolbar runs, landing in the room. A caret is just a
+ * position here; pastes are fragment pastes, with a `revision` one tracked insertion by it.
+ */
+declare function roomCommandsPort(room: RoomStore, { revision, actorId }?: {
+    revision?: Revision | null;
+    actorId?: string;
+}): ReferencesPort;
 
-export { CollaborationCompatibilityError, type RoomAutomation, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, readRoom, seedRoom };
+export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, roomCommandsPort, seedRoom };