@liveblocks/core 3.23.0 → 3.23.1-exp1

package/dist/index.d.cts

@@ -217,118 +217,6 @@ type BaseUserMeta = {
     info?: IUserInfo;
 };
 
-type CrdtType = (typeof CrdtType)[keyof typeof CrdtType];
-declare const CrdtType: Readonly<{
-    OBJECT: 0;
-    LIST: 1;
-    MAP: 2;
-    REGISTER: 3;
-    FILE: 5;
-}>;
-declare namespace CrdtType {
-    type OBJECT = typeof CrdtType.OBJECT;
-    type LIST = typeof CrdtType.LIST;
-    type MAP = typeof CrdtType.MAP;
-    type REGISTER = typeof CrdtType.REGISTER;
-    type FILE = typeof CrdtType.FILE;
-}
-type SerializedCrdt = SerializedRootObject | SerializedChild;
-type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister | SerializedFile;
-type LiveFileData = {
-    readonly id: string;
-    readonly name: string;
-    readonly size: number;
-    readonly mimeType: string;
-};
-type SerializedRootObject = {
-    readonly type: CrdtType.OBJECT;
-    readonly data: JsonObject;
-    readonly parentId?: never;
-    readonly parentKey?: never;
-};
-type SerializedObject = {
-    readonly type: CrdtType.OBJECT;
-    readonly parentId: string;
-    readonly parentKey: string;
-    readonly data: JsonObject;
-};
-type SerializedList = {
-    readonly type: CrdtType.LIST;
-    readonly parentId: string;
-    readonly parentKey: string;
-};
-type SerializedMap = {
-    readonly type: CrdtType.MAP;
-    readonly parentId: string;
-    readonly parentKey: string;
-};
-type SerializedRegister = {
-    readonly type: CrdtType.REGISTER;
-    readonly parentId: string;
-    readonly parentKey: string;
-    readonly data: Json;
-};
-type SerializedFile = {
-    readonly type: CrdtType.FILE;
-    readonly parentId: string;
-    readonly parentKey: string;
-    readonly data: LiveFileData;
-};
-type StorageNode = RootStorageNode | ChildStorageNode;
-type ChildStorageNode = ObjectStorageNode | ListStorageNode | MapStorageNode | RegisterStorageNode | FileStorageNode;
-type RootStorageNode = [id: "root", value: SerializedRootObject];
-type ObjectStorageNode = [id: string, value: SerializedObject];
-type ListStorageNode = [id: string, value: SerializedList];
-type MapStorageNode = [id: string, value: SerializedMap];
-type RegisterStorageNode = [id: string, value: SerializedRegister];
-type FileStorageNode = [id: string, value: SerializedFile];
-type NodeMap = Map<string, SerializedCrdt>;
-type NodeStream = Iterable<StorageNode>;
-declare function isRootStorageNode(node: StorageNode): node is RootStorageNode;
-declare function isObjectStorageNode(node: StorageNode): node is RootStorageNode | ObjectStorageNode;
-declare function isListStorageNode(node: StorageNode): node is ListStorageNode;
-declare function isMapStorageNode(node: StorageNode): node is MapStorageNode;
-declare function isRegisterStorageNode(node: StorageNode): node is RegisterStorageNode;
-declare function isFileStorageNode(node: StorageNode): node is FileStorageNode;
-type CompactNode = CompactRootNode | CompactChildNode;
-type CompactChildNode = CompactObjectNode | CompactListNode | CompactMapNode | CompactRegisterNode | CompactFileNode;
-type CompactRootNode = readonly [id: "root", data: JsonObject];
-type CompactObjectNode = readonly [
-    id: string,
-    type: CrdtType.OBJECT,
-    parentId: string,
-    parentKey: string,
-    data: JsonObject
-];
-type CompactListNode = readonly [
-    id: string,
-    type: CrdtType.LIST,
-    parentId: string,
-    parentKey: string
-];
-type CompactMapNode = readonly [
-    id: string,
-    type: CrdtType.MAP,
-    parentId: string,
-    parentKey: string
-];
-type CompactRegisterNode = readonly [
-    id: string,
-    type: CrdtType.REGISTER,
-    parentId: string,
-    parentKey: string,
-    data: Json
-];
-type CompactFileNode = readonly [
-    id: string,
-    type: CrdtType.FILE,
-    parentId: string,
-    parentKey: string,
-    data: LiveFileData
-];
-declare function compactNodesToNodeStream(compactNodes: CompactNode[]): NodeStream;
-declare function nodeStreamToCompactNodes(nodes: NodeStream): Iterable<CompactNode>;
-
 declare const brand: unique symbol;
 type Brand<T, TBrand extends string> = T & {
     [brand]: TBrand;
@@ -414,6 +302,8 @@ declare const OpCode: Readonly<{
     DELETE_OBJECT_KEY: 6;
     CREATE_MAP: 7;
     CREATE_REGISTER: 8;
+    CREATE_TEXT: 9;
+    UPDATE_TEXT: 10;
     CREATE_FILE: 11;
 }>;
 declare namespace OpCode {
@@ -426,14 +316,49 @@ declare namespace OpCode {
     type DELETE_OBJECT_KEY = typeof OpCode.DELETE_OBJECT_KEY;
     type CREATE_MAP = typeof OpCode.CREATE_MAP;
     type CREATE_REGISTER = typeof OpCode.CREATE_REGISTER;
+    type CREATE_TEXT = typeof OpCode.CREATE_TEXT;
+    type UPDATE_TEXT = typeof OpCode.UPDATE_TEXT;
     type CREATE_FILE = typeof OpCode.CREATE_FILE;
 }
+type TextAttributes = JsonObject;
+/**
+ * A single segment in a {@link LiveTextData} document.
+ *
+ * @example
+ * ["Hello world"]
+ * ["Hello ", { bold: true }]
+ */
+type LiveTextSegment = [text: string] | [text: string, attributes: TextAttributes];
+/**
+ * Serialized form of a {@link LiveText} document: an ordered list of text
+ * segments with optional inline attributes.
+ *
+ * @example
+ * [["Hello world"]]
+ * [["Hello ", { bold: true }], ["world"]]
+ */
+type LiveTextData = LiveTextSegment[];
+type TextOperation = {
+    type: "insert";
+    index: number;
+    text: string;
+    attributes?: TextAttributes;
+} | {
+    type: "delete";
+    index: number;
+    length: number;
+} | {
+    type: "format";
+    index: number;
+    length: number;
+    attributes: JsonObject;
+};
 /**
  * These operations are the payload for {@link UpdateStorageServerMsg} messages
  * only.
  */
-type Op = CreateOp | UpdateObjectOp | DeleteCrdtOp | SetParentKeyOp | DeleteObjectKeyOp;
-type CreateOp = CreateObjectOp | CreateRegisterOp | CreateMapOp | CreateListOp | CreateFileOp;
+type Op = CreateOp | UpdateObjectOp | UpdateTextOp | DeleteCrdtOp | SetParentKeyOp | DeleteObjectKeyOp;
+type CreateOp = CreateObjectOp | CreateRegisterOp | CreateMapOp | CreateListOp | CreateTextOp | CreateFileOp;
 type UpdateObjectOp = {
     readonly opId?: string;
     readonly id: string;
@@ -478,6 +403,17 @@ type CreateRegisterOp = {
     readonly intent?: "set" | "push";
     readonly deletedId?: string;
 };
+type CreateTextOp = {
+    readonly opId?: string;
+    readonly id: string;
+    readonly type: OpCode.CREATE_TEXT;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: LiveTextData;
+    readonly version: number;
+    readonly intent?: "set" | "push";
+    readonly deletedId?: string;
+};
 type CreateFileOp = {
     readonly opId?: string;
     readonly id: string;
@@ -488,6 +424,14 @@ type CreateFileOp = {
     readonly intent?: "set" | "push";
     readonly deletedId?: string;
 };
+type UpdateTextOp = {
+    readonly opId?: string;
+    readonly id: string;
+    readonly type: OpCode.UPDATE_TEXT;
+    readonly baseVersion: number;
+    readonly version?: number;
+    readonly ops: TextOperation[];
+};
 type DeleteCrdtOp = {
     readonly opId?: string;
     readonly id: string;
@@ -530,6 +474,157 @@ type TheirOp = DistributiveOmit<Op, "opId"> & {
     opId?: undefined;
 };
 
+type CrdtType = (typeof CrdtType)[keyof typeof CrdtType];
+declare const CrdtType: Readonly<{
+    OBJECT: 0;
+    LIST: 1;
+    MAP: 2;
+    REGISTER: 3;
+    TEXT: 4;
+    FILE: 5;
+}>;
+declare namespace CrdtType {
+    type OBJECT = typeof CrdtType.OBJECT;
+    type LIST = typeof CrdtType.LIST;
+    type MAP = typeof CrdtType.MAP;
+    type REGISTER = typeof CrdtType.REGISTER;
+    type TEXT = typeof CrdtType.TEXT;
+    type FILE = typeof CrdtType.FILE;
+}
+type SerializedCrdt = SerializedRootObject | SerializedChild;
+type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister | SerializedText | SerializedFile;
+type LiveFileData = {
+    readonly id: string;
+    readonly name: string;
+    readonly size: number;
+    readonly mimeType: string;
+};
+type SerializedRootObject = {
+    readonly type: CrdtType.OBJECT;
+    readonly data: JsonObject;
+    readonly parentId?: never;
+    readonly parentKey?: never;
+};
+type SerializedObject = {
+    readonly type: CrdtType.OBJECT;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: JsonObject;
+};
+type SerializedList = {
+    readonly type: CrdtType.LIST;
+    readonly parentId: string;
+    readonly parentKey: string;
+};
+type SerializedMap = {
+    readonly type: CrdtType.MAP;
+    readonly parentId: string;
+    readonly parentKey: string;
+};
+type SerializedRegister = {
+    readonly type: CrdtType.REGISTER;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: Json;
+};
+type SerializedText = {
+    readonly type: CrdtType.TEXT;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: LiveTextData;
+    readonly version: number;
+};
+type SerializedFile = {
+    readonly type: CrdtType.FILE;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: LiveFileData;
+};
+type StorageNode = RootStorageNode | ChildStorageNode;
+type ChildStorageNode = ObjectStorageNode | ListStorageNode | MapStorageNode | RegisterStorageNode | TextStorageNode | FileStorageNode;
+type RootStorageNode = [id: "root", value: SerializedRootObject];
+type ObjectStorageNode = [id: string, value: SerializedObject];
+type ListStorageNode = [id: string, value: SerializedList];
+type MapStorageNode = [id: string, value: SerializedMap];
+type RegisterStorageNode = [id: string, value: SerializedRegister];
+type TextStorageNode = [id: string, value: SerializedText];
+type FileStorageNode = [id: string, value: SerializedFile];
+type NodeMap = Map<string, SerializedCrdt>;
+type NodeStream = Iterable<StorageNode>;
+declare function isRootStorageNode(node: StorageNode): node is RootStorageNode;
+declare function isObjectStorageNode(node: StorageNode): node is RootStorageNode | ObjectStorageNode;
+declare function isListStorageNode(node: StorageNode): node is ListStorageNode;
+declare function isMapStorageNode(node: StorageNode): node is MapStorageNode;
+declare function isRegisterStorageNode(node: StorageNode): node is RegisterStorageNode;
+declare function isTextStorageNode(node: StorageNode): node is TextStorageNode;
+declare function isFileStorageNode(node: StorageNode): node is FileStorageNode;
+type CompactNode = CompactRootNode | CompactChildNode;
+type CompactChildNode = CompactObjectNode | CompactListNode | CompactMapNode | CompactRegisterNode | CompactTextNode | CompactFileNode;
+type CompactRootNode = readonly [id: "root", data: JsonObject];
+type CompactObjectNode = readonly [
+    id: string,
+    type: CrdtType.OBJECT,
+    parentId: string,
+    parentKey: string,
+    data: JsonObject
+];
+type CompactListNode = readonly [
+    id: string,
+    type: CrdtType.LIST,
+    parentId: string,
+    parentKey: string
+];
+type CompactMapNode = readonly [
+    id: string,
+    type: CrdtType.MAP,
+    parentId: string,
+    parentKey: string
+];
+type CompactRegisterNode = readonly [
+    id: string,
+    type: CrdtType.REGISTER,
+    parentId: string,
+    parentKey: string,
+    data: Json
+];
+type CompactTextNode = readonly [
+    id: string,
+    type: CrdtType.TEXT,
+    parentId: string,
+    parentKey: string,
+    data: LiveTextData,
+    version: number
+];
+type CompactFileNode = readonly [
+    id: string,
+    type: CrdtType.FILE,
+    parentId: string,
+    parentKey: string,
+    data: LiveFileData
+];
+declare function compactNodesToNodeStream(compactNodes: CompactNode[]): NodeStream;
+declare function nodeStreamToCompactNodes(nodes: NodeStream): Iterable<CompactNode>;
+
+/**
+ * Use this symbol to brand an object property as internal.
+ *
+ * @example
+ * Object.defineProperty(
+ *   {
+ *     public,
+ *     [kInternal]: {
+ *       private
+ *     },
+ *   },
+ *   kInternal,
+ *   {
+ *     enumerable: false,
+ *   }
+ * );
+ */
+declare const kInternal: unique symbol;
+declare const kStorageUpdateSource: unique symbol;
+
 type LiveListUpdateDelta = {
     type: "insert";
     index: number;
@@ -909,7 +1004,198 @@ declare class LiveRegister<TValue extends Json> extends AbstractCrdt {
     clone(): TValue;
 }
 
-type LiveStructure = LiveObject<LsonObject> | LiveList<Lson> | LiveMap<string, Lson> | LiveFile;
+/**
+ * The position of the ops being transformed relative to the ops they are
+ * transformed over, in the final (server-serialized) timeline:
+ *
+ * - "after": the transformed ops will be ordered after the `over` ops. Used
+ *   when rebasing a not-yet-accepted op over already-accepted ops. On
+ *   same-index insert ties, the transformed op shifts right (the earlier op
+ *   stays left), and conflicting format attributes are kept (they will
+ *   overwrite, since the op applies later).
+ * - "before": the transformed ops were ordered before the `over` ops. Used
+ *   when applying an accepted remote op on top of locally-pending ops. On
+ *   same-index insert ties, the transformed op stays left, and conflicting
+ *   format attributes are dropped on overlapping ranges (the later `over` op
+ *   wins).
+ */
+type TransformOrder = "before" | "after";
+/**
+ * Transform `ops` over `over` (see {@link transformTextOperationsX}),
+ * returning only the transformed `ops`.
+ */
+declare function transformTextOperations(ops: readonly TextOperation[], over: readonly TextOperation[], order: TransformOrder): TextOperation[];
+declare function applyLiveTextOperations(data: LiveTextData, ops: readonly TextOperation[]): LiveTextData;
+
+type LiveTextAttributes = TextAttributes;
+type LiveTextAttributesPatch = JsonObject;
+
+type LiveTextChange = {
+    /** Text was inserted at {@link LiveTextChange.index}. */
+    readonly type: "insert";
+    readonly index: number;
+    readonly text: string;
+    readonly attributes?: TextAttributes;
+} | {
+    /** Text was deleted starting at {@link LiveTextChange.index}. */
+    readonly type: "delete";
+    readonly index: number;
+    readonly length: number;
+    readonly deletedText: string;
+} | {
+    /** Inline attributes were updated on a range of text. */
+    readonly type: "format";
+    readonly index: number;
+    readonly length: number;
+    readonly attributes: LiveTextAttributesPatch;
+};
+/** Notification payload when a {@link LiveText} node changes. */
+type LiveTextUpdates = {
+    type: "LiveText";
+    node: LiveText;
+    version: number;
+    updates: LiveTextChange[];
+};
+/**
+ * @private
+ *
+ * Private methods on a LiveText node. As a user of Liveblocks, NEVER USE ANY
+ * OF THESE DIRECTLY, because bad things will probably happen if you do.
+ */
+type PrivateLiveTextApi = PrivateLiveNodeApi & {
+    /**
+     * Encode a local-document index into server-confirmed coordinates suitable
+     * for broadcasting to peers via presence or any other side channel. Pair
+     * the result with {@link LiveText.version} at the same instant when
+     * sending.
+     */
+    encodeIndex(localIndex: number): number;
+    /**
+     * Decode an `(index, fromVersion)` pair from a peer into an offset in this
+     * LiveText's current local document.
+     */
+    decodeIndex(index: number, fromVersion: number): number | null;
+};
+
+/**
+ * LiveText is a collaborative rich-text primitive built on server-ordered
+ * operational transformation.
+ *
+ * Use it to store plain text with optional inline formatting attributes in
+ * Liveblocks Storage. Each document is a flat sequence of text segments; it
+ * cannot contain child Storage structures.
+ *
+ * Outbound model (one-in-flight): at most one UpdateTextOp per node is
+ * awaiting server acknowledgement at any time. Local edits made while an op
+ * is in flight are queued and sent (composed into a single op) once the ack
+ * arrives. This guarantees every wire op is expressed against server-state
+ * coordinates, so the server can transform it over exactly the (foreign)
+ * ops the client hadn't seen — never over the client's own pending ops.
+ *
+ * Inbound model: accepted remote ops are transformed over the local pending
+ * ops before being applied ("before" order: the accepted op wins ties), and
+ * the pending ops are re-expressed over the remote op in turn ("after"
+ * order), keeping them in server coordinates at all times.
+ *
+ * @example
+ * const text = new LiveText("Hello");
+ * text.insert(5, " world");
+ * text.format(0, 5, { bold: true });
+ *
+ * // [["Hello", { bold: true }], [" world"]]
+ * text.toJSON();
+ *
+ * @example
+ * // Use in Storage
+ * declare global {
+ *   interface Liveblocks {
+ *     Storage: { document: LiveText };
+ *   }
+ * }
+ *
+ * const { root } = await room.getStorage();
+ * root.get("document").replace(0, root.get("document").length, "Updated");
+ */
+declare class LiveText extends AbstractCrdt {
+    #private;
+    /**
+     * @private
+     *
+     * Private methods and variables used in the core internals, but as a user
+     * of Liveblocks, NEVER USE ANY OF THESE DIRECTLY, because bad things
+     * will probably happen if you do.
+     */
+    readonly [kInternal]: PrivateLiveTextApi;
+    /**
+     * Creates a new LiveText document.
+     *
+     * @param textOrData Initial plain text, or an array of `[text]` /
+     *   `[text, attributes]` segments. Defaults to an empty document.
+     *
+     * @example
+     * new LiveText();
+     * new LiveText("Hello world");
+     * new LiveText([["Hello ", { bold: true }], ["world"]]);
+     */
+    constructor(textOrData?: string | LiveTextData, version?: number);
+    get version(): number;
+    get length(): number;
+    /**
+     * Inserts text at the given index.
+     *
+     * @param index Character index at which to insert. Values outside the
+     *   document range are clipped.
+     * @param text Text to insert.
+     * @param attributes Optional inline attributes for the inserted text.
+     *
+     * @example
+     * const text = new LiveText("Hello");
+     * text.insert(5, " world");
+     * text.insert(0, "Say: ", { italic: true });
+     */
+    insert(index: number, text: string, attributes?: TextAttributes): void;
+    /**
+     * Deletes `length` characters starting at `index`.
+     *
+     * @example
+     * const text = new LiveText("Hello world");
+     * text.delete(5, 6); // "Hello"
+     */
+    delete(index: number, length: number): void;
+    /**
+     * Replaces a range of text with new text.
+     *
+     * @example
+     * const text = new LiveText("Hello world");
+     * text.replace(0, 5, "Hi"); // "Hi world"
+     */
+    replace(index: number, length: number, text: string, attributes?: TextAttributes): void;
+    /**
+     * Applies or removes inline attributes on a range of text.
+     *
+     * Set an attribute to `null` to remove it from the range.
+     *
+     * @example
+     * const text = new LiveText("Hello world");
+     * text.format(0, 5, { bold: true });
+     * text.format(0, 5, { bold: null });
+     */
+    format(index: number, length: number, attributes: LiveTextAttributesPatch): void;
+    /** Returns the plain text content without attributes. Equivalent to joining the text from each segment in {@link LiveText.toJSON}. */
+    toString(): string;
+    /**
+     * Returns a JSON-compatible snapshot of the document as a {@link LiveTextData}
+     * array.
+     *
+     * @example
+     * new LiveText([["Hello ", { bold: true }], ["world"]]).toJSON();
+     * // [["Hello ", { bold: true }], ["world"]]
+     */
+    toJSON(): LiveTextData;
+    clone(): LiveText;
+}
+
+type LiveStructure = LiveObject<LsonObject> | LiveList<Lson> | LiveMap<string, Lson> | LiveText | LiveFile;
 /**
  * Think of Lson as a sibling of the Json data tree, except that the nested
  * data structure can contain a mix of Json values and LiveStructure instances.
@@ -945,7 +1231,7 @@ type ToJson<L extends Lson | LsonObject> = L extends LiveList<infer I extends Ls
     readonly [K in keyof O]: ToJson<Exclude<O[K], undefined>> | (undefined extends O[K] ? undefined : never);
 } : L extends LiveMap<infer KS extends string, infer V extends Lson> ? Lson extends V ? ReadonlyJsonObject : {
     readonly [K in KS]: ToJson<V>;
-} : L extends LiveFile ? LiveFileData : L extends LsonObject ? string extends keyof L ? ReadonlyJsonObject : {
+} : L extends LiveText ? LiveTextData : L extends LiveFile ? LiveFileData : L extends LsonObject ? string extends keyof L ? ReadonlyJsonObject : {
     readonly [K in keyof L]: ToJson<Exclude<L[K], undefined>> | (undefined extends L[K] ? undefined : never);
 } : L extends Json ? L : never;
 
@@ -953,12 +1239,29 @@ type StorageCallback = (updates: StorageUpdate[]) => void;
 type LiveMapUpdate = LiveMapUpdates<string, Lson>;
 type LiveObjectUpdate = LiveObjectUpdates<LsonObject>;
 type LiveListUpdate = LiveListUpdates<Lson>;
+type LiveTextUpdate = LiveTextUpdates;
+type StorageUpdateSource = {
+    origin: "remote";
+} | {
+    origin: "local";
+    via: "mutation";
+} | {
+    origin: "local";
+    via: "history";
+    action: "undo" | "redo";
+};
 /**
  * The payload of notifications sent (in-client) when LiveStructures change.
  * Messages of this kind are not originating from the network, but are 100%
  * in-client.
+ *
+ * Updates delivered through `room.subscribe` may carry
+ * `[kStorageUpdateSource]` to distinguish where a mutation came from.
+ * Undo/redo replays use `via: "history"` with `action: "undo" | "redo"`.
  */
-type StorageUpdate = LiveMapUpdate | LiveObjectUpdate | LiveListUpdate;
+type StorageUpdate = (LiveMapUpdate | LiveObjectUpdate | LiveListUpdate | LiveTextUpdate) & {
+    [kStorageUpdateSource]?: StorageUpdateSource;
+};
 
 /**
  * Read-only query surface over {@link UnacknowledgedOps}, handed to CRDTs so
@@ -984,6 +1287,27 @@ interface ReadonlyUnacknowledgedOps {
     isPossiblyStored(opId: string): boolean;
 }
 
+type DispatchOptions = {
+    /**
+     * Whether this dispatch should clear the redo stack. Defaults to true when
+     * any forward ops are included (a fresh local mutation), false otherwise.
+     * LiveText uses this to dispatch queued ops after an acknowledgement
+     * (which should not clear redo), and to register fresh local edits that
+     * don't carry wire ops yet (which should).
+     */
+    clearRedoStack?: boolean;
+};
+/**
+ * Private methods on any Liveblocks CRDT node. As a user of Liveblocks, NEVER
+ * USE ANY OF THESE DIRECTLY, because bad things will probably happen if you do.
+ */
+type PrivateLiveNodeApi = {
+    /**
+     * Returns the CRDT node id once attached to the room pool. Detached nodes
+     * that have not entered storage yet return `undefined`.
+     */
+    getId(): string | undefined;
+};
 /**
  * The managed pool is a namespace registry (i.e. a context) that "owns" all
  * the individual live nodes, ensuring each one has a unique ID, and holding on
@@ -1002,7 +1326,7 @@ interface ManagedPool {
      * - Add reverse operations to the undo/redo stack
      * - Notify room subscribers with updates (in-client, no networking)
      */
-    dispatch: (ops: ClientWireOp[], reverseOps: Op[], storageUpdates: Map<string, StorageUpdate>) => void;
+    dispatch: (ops: ClientWireOp[], reverseOps: Op[], storageUpdates: Map<string, StorageUpdate>, options?: DispatchOptions) => void;
     /**
      * Ensures storage can be written to else throws an error.
      * This is used to prevent writing to storage when the user does not have
@@ -1027,7 +1351,7 @@ type CreateManagedPoolOptions = {
     /**
      * Will get invoked when any Live structure calls .dispatch() on the pool.
      */
-    onDispatch?: (ops: ClientWireOp[], reverse: Op[], storageUpdates: Map<string, StorageUpdate>) => void;
+    onDispatch?: (ops: ClientWireOp[], reverse: Op[], storageUpdates: Map<string, StorageUpdate>, options?: DispatchOptions) => void;
     /**
      * Will get invoked when any Live structure calls .assertStorageIsWritable()
      * on the pool. Defaults to true when not provided. Return false if you want
@@ -1049,6 +1373,8 @@ type CreateManagedPoolOptions = {
 declare function createManagedPool(options: CreateManagedPoolOptions): ManagedPool;
 declare abstract class AbstractCrdt {
     #private;
+    readonly [kInternal]: PrivateLiveNodeApi;
+    constructor();
     /**
      * @private
      * Returns true if the cached JSON snapshot exists and is reference-equal
@@ -2061,25 +2387,6 @@ interface LiveblocksHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> ex
     getGroup(groupId: string): Promise<GroupData | undefined>;
 }
 
-/**
- * Use this symbol to brand an object property as internal.
- *
- * @example
- * Object.defineProperty(
- *   {
- *     public,
- *     [kInternal]: {
- *       private
- *     },
- *   },
- *   kInternal,
- *   {
- *     enumerable: false,
- *   }
- * );
- */
-declare const kInternal: unique symbol;
-
 /**
  * Back-port of TypeScript 5.4's built-in NoInfer utility type.
  * See https://stackoverflow.com/a/56688073/148872
@@ -4230,7 +4537,14 @@ interface SyncSource {
  */
 type PrivateRoomApi = {
     presenceBuffer: Json | undefined;
-    undoStack: readonly (readonly Readonly<Stackframe<JsonObject>>[])[];
+    undoStack: readonly {
+        readonly id: number;
+        readonly frames: readonly Readonly<Stackframe<JsonObject>>[];
+    }[];
+    redoStack: readonly {
+        readonly id: number;
+        readonly frames: readonly Readonly<Stackframe<JsonObject>>[];
+    }[];
     nodeCount: number;
     getYjsProvider(): IYjsProvider | undefined;
     setYjsProvider(provider: IYjsProvider | undefined): void;
@@ -4271,6 +4585,21 @@ type PrivateRoomApi = {
     };
     attachmentUrlsStore: BatchStore<string, string>;
     fileUrlsStore: BatchStore<FileUrlData, string>;
+    readonly history: Observable<{
+        action: "push";
+        id: number;
+    } | {
+        action: "undo";
+        id: number;
+    } | {
+        action: "redo";
+        id: number;
+    } | {
+        action: "clear";
+    } | {
+        action: "discard";
+        ids: number[];
+    }>;
 };
 type Stackframe<P extends JsonObject> = Op | PresenceStackframe<P>;
 type PresenceStackframe<P extends JsonObject> = {
@@ -5170,11 +5499,16 @@ type PlainLsonList = {
     liveblocksType: "LiveList";
     data: PlainLson[];
 };
+type PlainLsonText = {
+    liveblocksType: "LiveText";
+    data: LiveTextData;
+    version?: number;
+};
 type PlainLsonFile = {
     liveblocksType: "LiveFile";
     data: LiveFileData;
 };
-type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | PlainLsonFile | Json;
+type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | PlainLsonText | PlainLsonFile | Json;
 
 /**
  * Returns PlainLson for a given Json or LiveStructure, suitable for calling the storage init api
@@ -5890,4 +6224,4 @@ type EnsureJson<T> = T extends Json ? T : T extends Array<infer I> ? (EnsureJson
     [K in keyof T as EnsureJson<T[K]> extends never ? never : K]: EnsureJson<T[K]>;
 };
 
-export { type AccessLevel, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type ChildStorageNode, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type ClientWireOp, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type CompactChildNode, type CompactFileNode, type CompactListNode, type CompactMapNode, type CompactNode, type CompactObjectNode, type CompactRegisterNode, type CompactRootNode, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateFileOp, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DCM, type DE, type DFM, type DFMD, type DGI, type DP, type DRI, type DS, type DTM, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type Feed, type FeedCreateMetadata, type FeedDeletedServerMsg, type FeedFetchMetadataFilter, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesUpdatedServerMsg, type FeedRequestError, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedUpdateMetadata, type FeedsAddedServerMsg, type FeedsEventServerMsg, type FeedsListServerMsg, type FeedsUpdatedServerMsg, type FetchStorageClientMsg, type FetchYDocClientMsg, type FileStorageNode, type FileUrlData, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type HasOpId, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IgnoredOp, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LayerKey, type ListStorageNode, LiveFile, type LiveFileData, type LiveFileReference, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MapStorageNode, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NodeStream, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type ObjectStorageNode, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PermissionMatrix, type PermissionResources, type PlainLson, type PlainLsonFields, type PlainLsonFile, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type ReadonlyJson, type ReadonlyJsonObject, type RegisterStorageNode, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type RequiredAccessLevel, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomAccesses, type RoomEventMessage, type RoomPermissions, type RoomStateServerMsg, type RoomSubscriptionSettings, type RootStorageNode, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedFile, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type ServerWireOp, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageChunkServerMsg, type StorageNode, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncConfig, type SyncMode, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ThreadVisibility, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateRoomAccesses, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UploadFileOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactNodesToNodeStream, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createStorageFileId, createThreadId, deepLiveify, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getLiveFileId, getMentionsFromCommentBody, getSubscriptionKey, hasPermissionAccess, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isFileStorageNode, isJsonArray, isJsonObject, isJsonScalar, isListStorageNode, isLiveNode, isMapStorageNode, isNotificationChannelEnabled, isNumberOperator, isObjectStorageNode, isPlainObject, isRegisterStorageNode, isRootStorageNode, isStartsWithOperator, isUrl, kInternal, keys, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, mergeRoomPermissionScopes, nanoid, nn, nodeStreamToCompactNodes, normalizeRoomAccesses, normalizeRoomPermissions, normalizeUpdateRoomAccesses, objectToQuery, patchNotificationSettings, permissionMatrixFromScopes, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, url, urljoin, validatePermissionsSet, wait, warnOnce, warnOnceIf, withTimeout };
+export { type AccessLevel, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type ChildStorageNode, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type ClientWireOp, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type CompactChildNode, type CompactFileNode, type CompactListNode, type CompactMapNode, type CompactNode, type CompactObjectNode, type CompactRegisterNode, type CompactRootNode, type CompactTextNode, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateFileOp, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CreateTextOp, type Cursor, type CustomAuthenticationResult, type DAD, type DCM, type DE, type DFM, type DFMD, type DGI, type DP, type DRI, type DS, type DTM, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type Feed, type FeedCreateMetadata, type FeedDeletedServerMsg, type FeedFetchMetadataFilter, type FeedMessage, type FeedMessagesAddedServerMsg, type FeedMessagesDeletedServerMsg, type FeedMessagesListServerMsg, type FeedMessagesUpdatedServerMsg, type FeedRequestError, FeedRequestErrorCode, type FeedRequestFailedServerMsg, type FeedUpdateMetadata, type FeedsAddedServerMsg, type FeedsEventServerMsg, type FeedsListServerMsg, type FeedsUpdatedServerMsg, type FetchStorageClientMsg, type FetchYDocClientMsg, type FileStorageNode, type FileUrlData, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type HasOpId, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IgnoredOp, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LayerKey, type ListStorageNode, LiveFile, type LiveFileData, type LiveFileReference, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveText, type LiveTextAttributes, type LiveTextAttributesPatch, type LiveTextChange, type LiveTextData, type TextOperation as LiveTextOperation, type LiveTextSegment, type LiveTextUpdate, type LiveTextUpdates, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MapStorageNode, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NodeStream, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type ObjectStorageNode, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PermissionMatrix, type PermissionResources, type PlainLson, type PlainLsonFields, type PlainLsonFile, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type PlainLsonText, type Poller, type PrivateClientApi, type PrivateLiveNodeApi, type PrivateLiveTextApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type ReadonlyJson, type ReadonlyJsonObject, type RegisterStorageNode, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type RequiredAccessLevel, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomAccesses, type RoomEventMessage, type RoomPermissions, type RoomStateServerMsg, type RoomSubscriptionSettings, type RootStorageNode, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedFile, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type SerializedText, type ServerMsg, ServerMsgCode, type ServerWireOp, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageChunkServerMsg, type StorageNode, type StorageStatus, type StorageUpdate, type StorageUpdateSource, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncConfig, type SyncMode, type SyncSource, type SyncStatus, type TextAttributes, TextEditorType, type TextOperation, type TextStorageNode, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ThreadVisibility, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateRoomAccesses, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateTextOp, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UploadFileOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, applyLiveTextOperations, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactNodesToNodeStream, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createStorageFileId, createThreadId, deepLiveify, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getLiveFileId, getMentionsFromCommentBody, getSubscriptionKey, hasPermissionAccess, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isFileStorageNode, isJsonArray, isJsonObject, isJsonScalar, isListStorageNode, isLiveNode, isMapStorageNode, isNotificationChannelEnabled, isNumberOperator, isObjectStorageNode, isPlainObject, isRegisterStorageNode, isRootStorageNode, isStartsWithOperator, isTextStorageNode, isUrl, kInternal, kStorageUpdateSource, keys, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, mergeRoomPermissionScopes, nanoid, nn, nodeStreamToCompactNodes, normalizeRoomAccesses, normalizeRoomPermissions, normalizeUpdateRoomAccesses, objectToQuery, patchNotificationSettings, permissionMatrixFromScopes, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, transformTextOperations, tryParseJson, url, urljoin, validatePermissionsSet, wait, warnOnce, warnOnceIf, withTimeout };