@textbus/collaborate 5.2.6 → 5.3.0

package/README.en.md

@@ -0,0 +1,12 @@
+**[中文](README.md)**
+
+@textbus/collaborate
+=====================
+
+Textbus is a framework for highly interactive rich text editing. Unlike many editors, it centers on **components**, uses formats as helpers, simplifies common editor APIs, and raises the abstraction level so Textbus stays approachable while scaling to complex apps.
+
+This package adds **multi-user collaborative editing** for Textbus (including Yjs-oriented integrations).
+
+### Documentation
+
+More docs: [textbus.io](https://textbus.io) · [English](https://textbus.io/en/index.html)

package/README.md

@@ -1,4 +1,6 @@
-Textbus
+**[English](README.en.md)**
+
+@textbus/collaborate
 =====================
 
 Textbus 是一套用于构建富交互的富文本编辑框架。和大多数富文本编辑器不同的是，Textbus 以组件为核心，格式为辅助，并大幅简化了富文本编辑器开发中常见

package/dist/base/collab-history.d.ts

@@ -3,6 +3,7 @@ import { Observable } from '@tanbo/stream';
 import { Item, Transaction } from 'yjs';
 import { Collaborate } from './collaborate';
 export declare abstract class CustomUndoManagerConfig {
+    abstract captureTimeout?: number;
     abstract captureTransaction?(arg0: Transaction): boolean;
     abstract deleteFilter?(arg0: Item): boolean;
 }

package/dist/base/collaborate.d.ts

@@ -64,6 +64,17 @@ export declare class Collaborate {
     private createLocalModelBySharedByModel;
     private createSharedComponentByLocalComponent;
     private createLocalComponentBySharedComponent;
+    private createArrayHoleXmlElement;
+    private isArrayHoleElement;
+    /**
+     * 仅用于 YArray ↔ 可观察数组：本地 `undefined` 槽位用 XmlElement 占位同步到 Yjs（不与对象字面量同步混用）。
+     */
+    private sharedModelForArraySlot;
+    /**
+     * 在可观察数组中插入稀疏空洞（与 YArray 中 XmlElement 占位对齐）。
+     * 仅在远端同步路径调用；直接操作 raw，避免走插入 undefined 的可观察路径。
+     */
+    private insertSparseHole;
     /**
      * 双向同步数组
      * @param sharedArray

package/dist/connectors/_api.d.ts

@@ -1,2 +1,3 @@
 export * from './hocuspocus-connector';
+export * from './local-connector';
 export * from './y-websocket-connector';

package/dist/connectors/local-connector.d.ts

@@ -0,0 +1,32 @@
+import { Doc as YDoc } from 'yjs';
+import { SyncConnector } from '../base/sync-connector';
+export interface LocalConnectorOptions {
+    /**
+     * 与其它连接器一致，会出现在 `onStateChange` 的 `clientId` 中。
+     * 多实例场景可传入不同值以模拟多客户端。
+     */
+    clientId?: number;
+}
+/**
+ * 不经网络的协作连接器，实现与 {@link SyncConnector} 相同的对外行为，
+ * 便于在单元测试中配合 {@link CollaborateModule} 使用，无需 WebSocket / Provider。
+ *
+ * - `onLoad`：在微任务中触发一次，对应远端「已同步可编辑」的时机。
+ * - `onStateChange`：在每次 {@link LocalConnector.setLocalStateField} 后发出当前客户端状态，
+ *   载荷形状与 `YWebsocketConnector` 一致（`{ clientId, message }`，其中 `message` 为 awareness 上的 `message` 字段）。
+ *
+ * 第一个参数与 `createConnector(yDoc)` 对齐，便于直接传入 `Collaborate` 的文档；当前实现不读写该 `YDoc`。
+ */
+export declare class LocalConnector extends SyncConnector {
+    readonly clientId: number;
+    private destroyed;
+    private fields;
+    constructor(_yDoc?: YDoc, options?: LocalConnectorOptions);
+    setLocalStateField(key: string, data: Record<string, any>): void;
+    onDestroy(): void;
+    /**
+     * 读取当前本地 awareness 字段快照，仅用于测试断言。
+     */
+    getLocalAwarenessSnapshot(): Readonly<Record<string, any>>;
+    private emitAwarenessStates;
+}