@liveblocks/client 0.13.2 → 0.15.0-alpha.1

package/lib/esm/LiveObject.js

@@ -35,13 +35,14 @@ export class LiveObject extends AbstractCrdt {
     /**
      * INTERNAL
      */
-    _serialize(parentId, parentKey) {
+    _serialize(parentId, parentKey, doc) {
         if (this._id == null) {
             throw new Error("Cannot serialize item is not attached");
         }
         const ops = [];
         const op = {
             id: this._id,
+            opId: doc === null || doc === void 0 ? void 0 : doc.generateOpId(),
             type: OpType.CreateObject,
             parentId,
             parentKey,
@@ -50,7 +51,7 @@ export class LiveObject extends AbstractCrdt {
         ops.push(op);
         for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
             if (value instanceof AbstractCrdt) {
-                ops.push(...value._serialize(this._id, key));
+                ops.push(...value._serialize(this._id, key, doc));
             }
             else {
                 op.data[key] = value;
@@ -67,7 +68,13 @@ export class LiveObject extends AbstractCrdt {
         }
         const object = new LiveObject(item.data);
         object._attach(id, doc);
-        const children = parentToChildren.get(id);
+        return this._deserializeChildren(object, parentToChildren, doc);
+    }
+    /**
+     * INTERNAL
+     */
+    static _deserializeChildren(object, parentToChildren, doc) {
+        const children = parentToChildren.get(object._id);
         if (children == null) {
             return object;
         }
@@ -96,7 +103,7 @@ export class LiveObject extends AbstractCrdt {
     /**
      * INTERNAL
      */
-    _attachChild(id, key, child) {
+    _attachChild(id, key, child, isLocal) {
         if (this._doc == null) {
             throw new Error("Can't attach child if doc is not present");
         }
@@ -123,19 +130,45 @@ export class LiveObject extends AbstractCrdt {
         __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, child);
         child._setParentLink(this, key);
         child._attach(id, this._doc);
-        return { reverse, modified: this };
+        return {
+            reverse,
+            modified: {
+                node: this,
+                type: "LiveObject",
+                updates: { [key]: { type: "update" } },
+            },
+        };
     }
     /**
      * INTERNAL
      */
     _detachChild(child) {
-        for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
-            if (value === child) {
-                __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
-            }
-        }
         if (child) {
+            const reverse = this._serialize(this._id, child._parentKey, this._doc);
+            for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
+                if (value === child) {
+                    __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
+                }
+            }
             child._detach();
+            const storageUpdate = {
+                node: this,
+                type: "LiveObject",
+                updates: {
+                    [child._parentKey]: { type: "delete" },
+                },
+            };
+            return { modified: storageUpdate, reverse };
+        }
+        return { modified: false };
+    }
+    /**
+     * INTERNAL
+     */
+    _detachChildren() {
+        for (const [key, value] of __classPrivateFieldGet(this, _LiveObject_map, "f")) {
+            __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
+            value._detach();
         }
     }
     /**
@@ -152,14 +185,32 @@ export class LiveObject extends AbstractCrdt {
     /**
      * INTERNAL
      */
-    _apply(op) {
+    _apply(op, isLocal) {
         if (op.type === OpType.UpdateObject) {
-            return __classPrivateFieldGet(this, _LiveObject_instances, "m", _LiveObject_applyUpdate).call(this, op);
+            return __classPrivateFieldGet(this, _LiveObject_instances, "m", _LiveObject_applyUpdate).call(this, op, isLocal);
         }
         else if (op.type === OpType.DeleteObjectKey) {
             return __classPrivateFieldGet(this, _LiveObject_instances, "m", _LiveObject_applyDeleteObjectKey).call(this, op);
         }
-        return super._apply(op);
+        return super._apply(op, isLocal);
+    }
+    /**
+     * INTERNAL
+     */
+    _toSerializedCrdt() {
+        var _a;
+        return {
+            type: CrdtType.Object,
+            parentId: (_a = this._parent) === null || _a === void 0 ? void 0 : _a._id,
+            parentKey: this._parentKey,
+            data: this.toObject(),
+        };
+    }
+    /**
+     * INTERNAL
+     */
+    _getType() {
+        return "LiveObject";
     }
     /**
      * Transform the LiveObject into a javascript object
@@ -215,7 +266,20 @@ export class LiveObject extends AbstractCrdt {
             ];
         }
         __classPrivateFieldGet(this, _LiveObject_map, "f").delete(keyAsString);
-        this._doc.dispatch([{ type: OpType.DeleteObjectKey, key: keyAsString, id: this._id }], reverse, [this]);
+        const storageUpdates = new Map();
+        storageUpdates.set(this._id, {
+            node: this,
+            type: "LiveObject",
+            updates: { [key]: { type: "delete" } },
+        });
+        this._doc.dispatch([
+            {
+                type: OpType.DeleteObjectKey,
+                key: keyAsString,
+                id: this._id,
+                opId: this._doc.generateOpId(),
+            },
+        ], reverse, storageUpdates);
     }
     /**
      * Adds or updates multiple properties at once with an object.
@@ -245,6 +309,7 @@ export class LiveObject extends AbstractCrdt {
             type: OpType.UpdateObject,
             data: {},
         };
+        const updateDelta = {};
         for (const key in overrides) {
             __classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").set(key, opId);
             const oldValue = __classPrivateFieldGet(this, _LiveObject_map, "f").get(key);
@@ -262,12 +327,13 @@ export class LiveObject extends AbstractCrdt {
             if (newValue instanceof AbstractCrdt) {
                 newValue._setParentLink(this, key);
                 newValue._attach(this._doc.generateId(), this._doc);
-                ops.push(...newValue._serialize(this._id, key));
+                ops.push(...newValue._serialize(this._id, key, this._doc));
             }
             else {
                 updatedProps[key] = newValue;
             }
             __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, newValue);
+            updateDelta[key] = { type: "update" };
         }
         if (Object.keys(reverseUpdateOp.data).length !== 0) {
             reverseOps.unshift(reverseUpdateOp);
@@ -280,10 +346,16 @@ export class LiveObject extends AbstractCrdt {
                 data: updatedProps,
             });
         }
-        this._doc.dispatch(ops, reverseOps, [this]);
+        const storageUpdates = new Map();
+        storageUpdates.set(this._id, {
+            node: this,
+            type: "LiveObject",
+            updates: updateDelta,
+        });
+        this._doc.dispatch(ops, reverseOps, storageUpdates);
     }
 }
-_LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _LiveObject_instances = new WeakSet(), _LiveObject_applyUpdate = function _LiveObject_applyUpdate(op) {
+_LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _LiveObject_instances = new WeakSet(), _LiveObject_applyUpdate = function _LiveObject_applyUpdate(op, isLocal) {
     let isModified = false;
     const reverse = [];
     const reverseUpdate = {
@@ -305,11 +377,7 @@ _LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _
             reverse.push({ type: OpType.DeleteObjectKey, id: this._id, key });
         }
     }
-    let isLocal = false;
-    if (op.opId == null) {
-        isLocal = true;
-        op.opId = this._doc.generateOpId();
-    }
+    let updateDelta = {};
     for (const key in op.data) {
         if (isLocal) {
             __classPrivateFieldGet(this, _LiveObject_propToLastUpdate, "f").set(key, op.opId);
@@ -332,12 +400,22 @@ _LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _
             oldValue._detach();
         }
         isModified = true;
+        updateDelta[key] = { type: "update" };
         __classPrivateFieldGet(this, _LiveObject_map, "f").set(key, op.data[key]);
     }
     if (Object.keys(reverseUpdate.data).length !== 0) {
         reverse.unshift(reverseUpdate);
     }
-    return isModified ? { modified: this, reverse } : { modified: false };
+    return isModified
+        ? {
+            modified: {
+                node: this,
+                type: "LiveObject",
+                updates: updateDelta,
+            },
+            reverse,
+        }
+        : { modified: false };
 }, _LiveObject_applyDeleteObjectKey = function _LiveObject_applyDeleteObjectKey(op) {
     const key = op.key;
     // If property does not exist, exit without notifying
@@ -360,5 +438,12 @@ _LiveObject_map = new WeakMap(), _LiveObject_propToLastUpdate = new WeakMap(), _
         ];
     }
     __classPrivateFieldGet(this, _LiveObject_map, "f").delete(key);
-    return { modified: this, reverse };
+    return {
+        modified: {
+            node: this,
+            type: "LiveObject",
+            updates: { [op.key]: { type: "delete" } },
+        },
+        reverse,
+    };
 };

package/lib/esm/LiveRegister.d.ts

@@ -1,5 +1,5 @@
 import { AbstractCrdt, Doc, ApplyResult } from "./AbstractCrdt";
-import { SerializedCrdtWithId, Op } from "./live";
+import { SerializedCrdtWithId, Op, SerializedCrdt } from "./live";
 /**
  * INTERNAL
  */
@@ -14,8 +14,16 @@ export declare class LiveRegister<TValue = any> extends AbstractCrdt {
     /**
      * INTERNAL
      */
-    _serialize(parentId: string, parentKey: string): Op[];
-    _attachChild(id: string, key: string, crdt: AbstractCrdt): ApplyResult;
-    _detachChild(crdt: AbstractCrdt): void;
-    _apply(op: Op): ApplyResult;
+    _serialize(parentId: string, parentKey: string, doc?: Doc): Op[];
+    /**
+     * INTERNAL
+     */
+    _toSerializedCrdt(): SerializedCrdt;
+    _attachChild(id: string, key: string, crdt: AbstractCrdt, isLocal: boolean): ApplyResult;
+    _detachChild(crdt: AbstractCrdt): ApplyResult;
+    _apply(op: Op, isLocal: boolean): ApplyResult;
+    /**
+     * INTERNAL
+     */
+    _getType(): string;
 }

package/lib/esm/LiveRegister.js

@@ -11,7 +11,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _LiveRegister_data;
 import { AbstractCrdt } from "./AbstractCrdt";
-import { CrdtType, OpType } from "./live";
+import { CrdtType, OpType, } from "./live";
 /**
  * INTERNAL
  */
@@ -38,13 +38,14 @@ export class LiveRegister extends AbstractCrdt {
     /**
      * INTERNAL
      */
-    _serialize(parentId, parentKey) {
+    _serialize(parentId, parentKey, doc) {
         if (this._id == null || parentId == null || parentKey == null) {
             throw new Error("Cannot serialize register if parentId or parentKey is undefined");
         }
         return [
             {
                 type: OpType.CreateRegister,
+                opId: doc === null || doc === void 0 ? void 0 : doc.generateOpId(),
                 id: this._id,
                 parentId,
                 parentKey,
@@ -52,14 +53,32 @@ export class LiveRegister extends AbstractCrdt {
             },
         ];
     }
-    _attachChild(id, key, crdt) {
+    /**
+     * INTERNAL
+     */
+    _toSerializedCrdt() {
+        var _a;
+        return {
+            type: CrdtType.Register,
+            parentId: (_a = this._parent) === null || _a === void 0 ? void 0 : _a._id,
+            parentKey: this._parentKey,
+            data: this.data,
+        };
+    }
+    _attachChild(id, key, crdt, isLocal) {
         throw new Error("Method not implemented.");
     }
     _detachChild(crdt) {
         throw new Error("Method not implemented.");
     }
-    _apply(op) {
-        return super._apply(op);
+    _apply(op, isLocal) {
+        return super._apply(op, isLocal);
+    }
+    /**
+     * INTERNAL
+     */
+    _getType() {
+        return "LiveRegister";
     }
 }
 _LiveRegister_data = new WeakMap();

package/lib/esm/{immutable/index.d.ts → immutable.d.ts}

@@ -1,7 +1,9 @@
-import { LiveList } from "../LiveList";
-import { LiveObject } from "../LiveObject";
-import { StorageUpdate } from "../types";
+import { LiveList } from "./LiveList";
+import { LiveObject } from "./LiveObject";
+import { StorageUpdate } from "./types";
 export declare function liveObjectToJson(liveObject: LiveObject<any>): any;
+export declare function liveNodeToJson(value: any): any;
 export declare function patchLiveList<T>(liveList: LiveList<T>, prev: Array<T>, next: Array<T>): void;
+export declare function patchLiveObjectKey<T>(liveObject: LiveObject<T>, key: keyof T, prev: any, next: any): void;
 export declare function patchLiveObject<T extends Record<string, any>>(root: LiveObject<T>, prev: T, next: T): void;
 export declare function patchImmutableObject<T>(state: T, updates: StorageUpdate[]): T;

package/lib/esm/{immutable/index.js → immutable.js}

@@ -1,6 +1,7 @@
-import { LiveList } from "../LiveList";
-import { LiveMap } from "../LiveMap";
-import { LiveObject } from "../LiveObject";
+import { LiveList } from "./LiveList";
+import { LiveMap } from "./LiveMap";
+import { LiveObject } from "./LiveObject";
+import { LiveRegister } from "./LiveRegister";
 export function liveObjectToJson(liveObject) {
     const result = {};
     const obj = liveObject.toObject();
@@ -20,7 +21,7 @@ function liveMapToJson(map) {
 function liveListToJson(value) {
     return value.toArray().map(liveNodeToJson);
 }
-function liveNodeToJson(value) {
+export function liveNodeToJson(value) {
     if (value instanceof LiveObject) {
         return liveObjectToJson(value);
     }
@@ -30,6 +31,9 @@ function liveNodeToJson(value) {
     else if (value instanceof LiveMap) {
         return liveMapToJson(value);
     }
+    else if (value instanceof LiveRegister) {
+        return value.data;
+    }
     return value;
 }
 function isPlainObject(obj) {
@@ -127,21 +131,35 @@ export function patchLiveList(liveList, prev, next) {
         }
     }
 }
+export function patchLiveObjectKey(liveObject, key, prev, next) {
+    const value = liveObject.get(key);
+    if (next === undefined) {
+        liveObject.delete(key);
+    }
+    else if (value === undefined) {
+        liveObject.set(key, anyToCrdt(next));
+    }
+    else if (prev === next) {
+        return;
+    }
+    else if (value instanceof LiveList &&
+        Array.isArray(prev) &&
+        Array.isArray(next)) {
+        patchLiveList(value, prev, next);
+    }
+    else if (value instanceof LiveObject &&
+        isPlainObject(prev) &&
+        isPlainObject(next)) {
+        patchLiveObject(value, prev, next);
+    }
+    else {
+        liveObject.set(key, anyToCrdt(next));
+    }
+}
 export function patchLiveObject(root, prev, next) {
     const updates = {};
     for (const key in next) {
-        if (prev[key] === next[key]) {
-            continue;
-        }
-        else if (Array.isArray(prev[key]) && Array.isArray(next[key])) {
-            patchLiveList(root.get(key), prev[key], next[key]);
-        }
-        else if (isPlainObject(prev[key]) && isPlainObject(next[key])) {
-            patchLiveObject(root.get(key), prev[key], next[key]);
-        }
-        else {
-            updates[key] = anyToCrdt(next[key]);
-        }
+        patchLiveObjectKey(root, key, prev[key], next[key]);
     }
     for (const key in prev) {
         if (next[key] === undefined) {
@@ -173,6 +191,7 @@ function patchImmutableObjectWithUpdate(state, update) {
     return patchImmutableNode(state, path, update);
 }
 function patchImmutableNode(state, path, update) {
+    var _a, _b, _c, _d;
     const pathItem = path.pop();
     if (pathItem === undefined) {
         switch (update.type) {
@@ -180,19 +199,56 @@ function patchImmutableNode(state, path, update) {
                 if (typeof state !== "object") {
                     throw new Error("Internal: received update on LiveObject but state was not an object");
                 }
-                return liveObjectToJson(update.node);
+                let newState = Object.assign({}, state);
+                for (const key in update.updates) {
+                    if (((_a = update.updates[key]) === null || _a === void 0 ? void 0 : _a.type) === "update") {
+                        newState[key] = liveNodeToJson(update.node.get(key));
+                    }
+                    else if (((_b = update.updates[key]) === null || _b === void 0 ? void 0 : _b.type) === "delete") {
+                        delete newState[key];
+                    }
+                }
+                return newState;
             }
             case "LiveList": {
                 if (Array.isArray(state) === false) {
                     throw new Error("Internal: received update on LiveList but state was not an array");
                 }
-                return liveListToJson(update.node);
+                let newState = state.map((x) => x);
+                const newArray = update.node.toArray();
+                for (const listUpdate of update.updates) {
+                    if (listUpdate.type === "insert") {
+                        if (listUpdate.index === newState.length) {
+                            newState.push(liveNodeToJson(newArray[listUpdate.index]));
+                        }
+                        else {
+                            newState = [
+                                ...newState.slice(0, listUpdate.index),
+                                liveNodeToJson(newArray[listUpdate.index]),
+                                ...newState.slice(listUpdate.index),
+                            ];
+                        }
+                    }
+                    else if (listUpdate.type === "delete") {
+                        newState.splice(listUpdate.index, 1);
+                    }
+                }
+                return newState;
             }
             case "LiveMap": {
                 if (typeof state !== "object") {
                     throw new Error("Internal: received update on LiveMap but state was not an object");
                 }
-                return liveMapToJson(update.node);
+                let newState = Object.assign({}, state);
+                for (const key in update.updates) {
+                    if (((_c = update.updates[key]) === null || _c === void 0 ? void 0 : _c.type) === "update") {
+                        newState[key] = liveNodeToJson(update.node.get(key));
+                    }
+                    else if (((_d = update.updates[key]) === null || _d === void 0 ? void 0 : _d.type) === "delete") {
+                        delete newState[key];
+                    }
+                }
+                return newState;
             }
         }
     }

package/lib/esm/index.d.ts

@@ -1,5 +1,6 @@
 export { LiveObject } from "./LiveObject";
 export { LiveMap } from "./LiveMap";
 export { LiveList } from "./LiveList";
-export type { Others, Presence, Room, Client, User } from "./types";
+export type { Others, Presence, Room, Client, User, BroadcastOptions, } from "./types";
 export { createClient } from "./client";
+export { liveObjectToJson, liveNodeToJson, patchLiveList, patchImmutableObject, patchLiveObject, patchLiveObjectKey, } from "./immutable";

package/lib/esm/index.js

@@ -2,3 +2,4 @@ export { LiveObject } from "./LiveObject";
 export { LiveMap } from "./LiveMap";
 export { LiveList } from "./LiveList";
 export { createClient } from "./client";
+export { liveObjectToJson, liveNodeToJson, patchLiveList, patchImmutableObject, patchLiveObject, patchLiveObjectKey, } from "./immutable";

package/lib/esm/live.d.ts

@@ -122,6 +122,7 @@ export declare type UpdateObjectOp = {
     };
 };
 export declare type CreateObjectOp = {
+    opId?: string;
     id: string;
     type: OpType.CreateObject;
     parentId?: string;
@@ -131,18 +132,21 @@ export declare type CreateObjectOp = {
     };
 };
 export declare type CreateListOp = {
+    opId?: string;
     id: string;
     type: OpType.CreateList;
     parentId: string;
     parentKey: string;
 };
 export declare type CreateMapOp = {
+    opId?: string;
     id: string;
     type: OpType.CreateMap;
     parentId: string;
     parentKey: string;
 };
 export declare type CreateRegisterOp = {
+    opId?: string;
     id: string;
     type: OpType.CreateRegister;
     parentId: string;
@@ -150,15 +154,18 @@ export declare type CreateRegisterOp = {
     data: any;
 };
 export declare type DeleteCrdtOp = {
+    opId?: string;
     id: string;
     type: OpType.DeleteCrdt;
 };
 export declare type SetParentKeyOp = {
+    opId?: string;
     id: string;
     type: OpType.SetParentKey;
     parentKey: string;
 };
 export declare type DeleteObjectKeyOp = {
+    opId?: string;
     id: string;
     type: OpType.DeleteObjectKey;
     key: string;

package/lib/esm/room.d.ts

@@ -1,4 +1,4 @@
-import { Others, Presence, ClientOptions, Room, MyPresenceCallback, OthersEventCallback, AuthEndpoint, EventCallback, User, Connection, ErrorCallback, AuthenticationToken, ConnectionCallback, StorageCallback, StorageUpdate } from "./types";
+import { Others, Presence, ClientOptions, Room, MyPresenceCallback, OthersEventCallback, AuthEndpoint, EventCallback, User, Connection, ErrorCallback, AuthenticationToken, ConnectionCallback, StorageCallback, StorageUpdate, BroadcastOptions } from "./types";
 import { ClientMessage, Op } from "./live";
 import { LiveMap } from "./LiveMap";
 import { LiveObject } from "./LiveObject";
@@ -11,6 +11,7 @@ declare type HistoryItem = Array<Op | {
 declare type IdFactory = () => string;
 export declare type State = {
     connection: Connection;
+    lastConnectionId: number | null;
     socket: WebSocket | null;
     lastFlushTime: number;
     buffer: {
@@ -59,9 +60,10 @@ export declare type State = {
         updates: {
             others: [];
             presence: boolean;
-            nodes: Set<AbstractCrdt>;
+            storageUpdates: Map<string, StorageUpdate>;
         };
     };
+    offlineOperations: Map<string, Op>;
 };
 export declare type Effects = {
     authenticate(): void;
@@ -89,6 +91,12 @@ export declare function makeStateMachine(state: State, context: Context, mockedE
     authenticationSuccess: (token: AuthenticationToken, socket: WebSocket) => void;
     heartbeat: () => void;
     onNavigatorOnline: () => void;
+    simulateSocketClose: () => void;
+    simulateSendCloseEvent: (event: {
+        code: number;
+        wasClean: boolean;
+        reason: any;
+    }) => void;
     onVisibilityChange: (visibilityState: VisibilityState) => void;
     getUndoStack: () => HistoryItem[];
     getItemsCount: () => number;
@@ -118,7 +126,7 @@ export declare function makeStateMachine(state: State, context: Context, mockedE
     updatePresence: <T_4 extends Presence>(overrides: Partial<T_4>, options?: {
         addToHistory: boolean;
     } | undefined) => void;
-    broadcastEvent: (event: any) => void;
+    broadcastEvent: (event: any, options?: BroadcastOptions) => void;
     batch: (callback: () => void) => void;
     undo: () => void;
     redo: () => void;