@liveblocks/client 0.12.2 → 0.13.1

package/lib/cjs/room.js

@@ -27,15 +27,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRoom = exports.defaultState = exports.makeStateMachine = void 0;
 const utils_1 = require("./utils");
 const authentication_1 = __importStar(require("./authentication"));
 const live_1 = require("./live");
-const storage_1 = __importDefault(require("./storage"));
+const LiveMap_1 = require("./LiveMap");
+const LiveObject_1 = require("./LiveObject");
+const LiveList_1 = require("./LiveList");
+const AbstractCrdt_1 = require("./AbstractCrdt");
+const LiveRegister_1 = require("./LiveRegister");
 const BACKOFF_RETRY_DELAYS = [250, 500, 1000, 2000, 4000, 8000, 10000];
 const HEARTBEAT_INTERVAL = 30000;
 // const WAKE_UP_CHECK_INTERVAL = 2000;
@@ -107,13 +108,275 @@ function makeStateMachine(state, context, mockedEffects) {
             return setTimeout(connect, delay);
         },
     };
-    function subscribe(type, listener) {
-        if (!isValidRoomEventType(type)) {
-            throw new Error(`"${type}" is not a valid event name`);
+    function genericSubscribe(callback) {
+        state.listeners.storage.push(callback);
+        return () => (0, utils_1.remove)(state.listeners.storage, callback);
+    }
+    function crdtSubscribe(crdt, innerCallback, options) {
+        const cb = (updates) => {
+            const relatedUpdates = [];
+            for (const update of updates) {
+                if ((options === null || options === void 0 ? void 0 : options.isDeep) && (0, utils_1.isSameNodeOrChildOf)(update.node, crdt)) {
+                    relatedUpdates.push(update);
+                }
+                else if (update.node._id === crdt._id) {
+                    innerCallback(update.node);
+                }
+            }
+            if ((options === null || options === void 0 ? void 0 : options.isDeep) && relatedUpdates.length > 0) {
+                innerCallback(relatedUpdates);
+            }
+        };
+        return genericSubscribe(cb);
+    }
+    function createRootFromMessage(message) {
+        state.root = load(message.items);
+        for (const key in state.defaultStorageRoot) {
+            if (state.root.get(key) == null) {
+                state.root.set(key, state.defaultStorageRoot[key]);
+            }
+        }
+    }
+    function load(items) {
+        if (items.length === 0) {
+            throw new Error("Internal error: cannot load storage without items");
+        }
+        const parentToChildren = new Map();
+        let root = null;
+        for (const tuple of items) {
+            const parentId = tuple[1].parentId;
+            if (parentId == null) {
+                root = tuple;
+            }
+            else {
+                const children = parentToChildren.get(parentId);
+                if (children != null) {
+                    children.push(tuple);
+                }
+                else {
+                    parentToChildren.set(parentId, [tuple]);
+                }
+            }
+        }
+        if (root == null) {
+            throw new Error("Root can't be null");
+        }
+        return LiveObject_1.LiveObject._deserialize(root, parentToChildren, {
+            addItem,
+            deleteItem,
+            generateId,
+            generateOpId,
+            dispatch: storageDispatch,
+        });
+    }
+    function addItem(id, item) {
+        state.items.set(id, item);
+    }
+    function deleteItem(id) {
+        state.items.delete(id);
+    }
+    function getItem(id) {
+        return state.items.get(id);
+    }
+    function addToUndoStack(historyItem) {
+        // If undo stack is too large, we remove the older item
+        if (state.undoStack.length >= 50) {
+            state.undoStack.shift();
+        }
+        if (state.isHistoryPaused) {
+            state.pausedHistory.unshift(...historyItem);
+        }
+        else {
+            state.undoStack.push(historyItem);
+        }
+    }
+    function storageDispatch(ops, reverse, modified) {
+        if (state.isBatching) {
+            state.batch.ops.push(...ops);
+            for (const item of modified) {
+                state.batch.updates.nodes.add(item);
+            }
+            state.batch.reverseOps.push(...reverse);
+        }
+        else {
+            addToUndoStack(reverse);
+            state.redoStack = [];
+            dispatch(ops);
+            notify({ nodes: new Set(modified) });
+        }
+    }
+    function notify({ nodes = new Set(), presence = false, others = [], }) {
+        if (others.length > 0) {
+            state.others = makeOthers(state.users);
+            for (const event of others) {
+                for (const listener of state.listeners["others"]) {
+                    listener(state.others, event);
+                }
+            }
+        }
+        if (presence) {
+            for (const listener of state.listeners["my-presence"]) {
+                listener(state.me);
+            }
+        }
+        if (nodes.size > 0) {
+            for (const subscriber of state.listeners.storage) {
+                subscriber(Array.from(nodes).map((m) => {
+                    if (m instanceof LiveObject_1.LiveObject) {
+                        return {
+                            type: "LiveObject",
+                            node: m,
+                        };
+                    }
+                    else if (m instanceof LiveList_1.LiveList) {
+                        return {
+                            type: "LiveList",
+                            node: m,
+                        };
+                    }
+                    else {
+                        return {
+                            type: "LiveMap",
+                            node: m,
+                        };
+                    }
+                }));
+            }
+        }
+    }
+    function getConnectionId() {
+        if (state.connection.state === "open" ||
+            state.connection.state === "connecting") {
+            return state.connection.id;
+        }
+        throw new Error("Internal. Tried to get connection id but connection is not open");
+    }
+    function generateId() {
+        return `${getConnectionId()}:${state.clock++}`;
+    }
+    function generateOpId() {
+        return `${getConnectionId()}:${state.opClock++}`;
+    }
+    function apply(item) {
+        const result = {
+            reverse: [],
+            updates: { nodes: new Set(), presence: false },
+        };
+        for (const op of item) {
+            if (op.type === "presence") {
+                const reverse = {
+                    type: "presence",
+                    data: {},
+                };
+                for (const key in op.data) {
+                    reverse.data[key] = state.me[key];
+                }
+                state.me = Object.assign(Object.assign({}, state.me), op.data);
+                if (state.buffer.presence == null) {
+                    state.buffer.presence = op.data;
+                }
+                else {
+                    for (const key in op.data) {
+                        state.buffer.presence[key] = op.data;
+                    }
+                }
+                result.reverse.unshift(reverse);
+                result.updates.presence = true;
+            }
+            else {
+                const applyOpResult = applyOp(op);
+                if (applyOpResult.modified) {
+                    result.updates.nodes.add(applyOpResult.modified);
+                    result.reverse.unshift(...applyOpResult.reverse);
+                }
+            }
+        }
+        return result;
+    }
+    function applyOp(op) {
+        switch (op.type) {
+            case live_1.OpType.DeleteObjectKey:
+            case live_1.OpType.UpdateObject:
+            case live_1.OpType.DeleteCrdt: {
+                const item = state.items.get(op.id);
+                if (item == null) {
+                    return { modified: false };
+                }
+                return item._apply(op);
+            }
+            case live_1.OpType.SetParentKey: {
+                const item = state.items.get(op.id);
+                if (item == null) {
+                    return { modified: false };
+                }
+                if (item._parent instanceof LiveList_1.LiveList) {
+                    const previousKey = item._parentKey;
+                    item._parent._setChildKey(op.parentKey, item);
+                    return {
+                        reverse: [
+                            {
+                                type: live_1.OpType.SetParentKey,
+                                id: item._id,
+                                parentKey: previousKey,
+                            },
+                        ],
+                        modified: item._parent,
+                    };
+                }
+                return { modified: false };
+            }
+            case live_1.OpType.CreateObject: {
+                const parent = state.items.get(op.parentId);
+                if (parent == null || getItem(op.id) != null) {
+                    return { modified: false };
+                }
+                return parent._attachChild(op.id, op.parentKey, new LiveObject_1.LiveObject(op.data));
+            }
+            case live_1.OpType.CreateList: {
+                const parent = state.items.get(op.parentId);
+                if (parent == null || getItem(op.id) != null) {
+                    return { modified: false };
+                }
+                return parent._attachChild(op.id, op.parentKey, new LiveList_1.LiveList());
+            }
+            case live_1.OpType.CreateRegister: {
+                const parent = state.items.get(op.parentId);
+                if (parent == null || getItem(op.id) != null) {
+                    return { modified: false };
+                }
+                return parent._attachChild(op.id, op.parentKey, new LiveRegister_1.LiveRegister(op.data));
+            }
+            case live_1.OpType.CreateMap: {
+                const parent = state.items.get(op.parentId);
+                if (parent == null || getItem(op.id) != null) {
+                    return { modified: false };
+                }
+                return parent._attachChild(op.id, op.parentKey, new LiveMap_1.LiveMap());
+            }
         }
-        state.listeners[type].push(listener);
+        return { modified: false };
+    }
+    function subscribe(firstParam, listener, options) {
+        if (firstParam instanceof AbstractCrdt_1.AbstractCrdt) {
+            return crdtSubscribe(firstParam, listener, options);
+        }
+        else if (typeof firstParam === "function") {
+            return genericSubscribe(firstParam);
+        }
+        else if (!isValidRoomEventType(firstParam)) {
+            throw new Error(`"${firstParam}" is not a valid event name`);
+        }
+        state.listeners[firstParam].push(listener);
+        return () => {
+            const callbacks = state.listeners[firstParam];
+            (0, utils_1.remove)(callbacks, listener);
+        };
     }
     function unsubscribe(event, callback) {
+        console.warn(`unsubscribe is depreacted and will be removed in a future version.
+use the callback returned by subscribe instead.
+See v0.13 release notes for more information.
+`);
         if (!isValidRoomEventType(event)) {
             throw new Error(`"${event}" is not a valid event name`);
         }
@@ -145,20 +408,28 @@ function makeStateMachine(state, context, mockedEffects) {
         updateConnection({ state: "authenticating" });
         effects.authenticate();
     }
-    function updatePresence(overrides) {
-        const newPresence = Object.assign(Object.assign({}, state.me), overrides);
-        if (state.flushData.presence == null) {
-            state.flushData.presence = overrides;
+    function updatePresence(overrides, options) {
+        const oldValues = {};
+        if (state.buffer.presence == null) {
+            state.buffer.presence = {};
         }
-        else {
-            for (const key in overrides) {
-                state.flushData.presence[key] = overrides[key];
+        for (const key in overrides) {
+            state.buffer.presence[key] = overrides[key];
+            oldValues[key] = state.me[key];
+        }
+        state.me = Object.assign(Object.assign({}, state.me), overrides);
+        if (state.isBatching) {
+            if (options === null || options === void 0 ? void 0 : options.addToHistory) {
+                state.batch.reverseOps.push({ type: "presence", data: oldValues });
             }
+            state.batch.updates.presence = true;
         }
-        state.me = newPresence;
-        tryFlushing();
-        for (const listener of state.listeners["my-presence"]) {
-            listener(state.me);
+        else {
+            tryFlushing();
+            if (options === null || options === void 0 ? void 0 : options.addToHistory) {
+                addToUndoStack([{ type: "presence", data: oldValues }]);
+            }
+            notify({ presence: true });
         }
     }
     function authenticationSuccess(token, socket) {
@@ -199,25 +470,20 @@ function makeStateMachine(state, context, mockedEffects) {
                 presence: Object.assign(Object.assign({}, user.presence), message.data),
             };
         }
-        updateUsers({
+        return {
             type: "update",
             updates: message.data,
             user: state.users[message.actor],
-        });
-    }
-    function updateUsers(event) {
-        state.others = makeOthers(state.users);
-        for (const listener of state.listeners["others"]) {
-            listener(state.others, event);
-        }
+        };
     }
     function onUserLeftMessage(message) {
         const userLeftMessage = message;
         const user = state.users[userLeftMessage.actor];
         if (user) {
             delete state.users[userLeftMessage.actor];
-            updateUsers({ type: "leave", user });
+            return { type: "leave", user };
         }
+        return null;
     }
     function onRoomStateMessage(message) {
         const newUsers = {};
@@ -231,7 +497,7 @@ function makeStateMachine(state, context, mockedEffects) {
             };
         }
         state.users = newUsers;
-        updateUsers({ type: "reset" });
+        return { type: "reset" };
     }
     function onNavigatorOnline() {
         if (state.connection.state === "unavailable") {
@@ -250,17 +516,17 @@ function makeStateMachine(state, context, mockedEffects) {
             info: message.info,
             id: message.id,
         };
-        updateUsers({ type: "enter", user: state.users[message.actor] });
         if (state.me) {
             // Send current presence to new user
             // TODO: Consider storing it on the backend
-            state.flushData.messages.push({
+            state.buffer.messages.push({
                 type: live_1.ClientMessageType.UpdatePresence,
                 data: state.me,
                 targetActor: message.actor,
             });
             tryFlushing();
         }
+        return { type: "enter", user: state.users[message.actor] };
     }
     function onMessage(event) {
         if (event.data === "pong") {
@@ -268,29 +534,57 @@ function makeStateMachine(state, context, mockedEffects) {
             return;
         }
         const message = JSON.parse(event.data);
-        switch (message.type) {
-            case live_1.ServerMessageType.UserJoined: {
-                onUserJoinedMessage(message);
-                break;
-            }
-            case live_1.ServerMessageType.UpdatePresence: {
-                onUpdatePresenceMessage(message);
-                break;
-            }
-            case live_1.ServerMessageType.Event: {
-                onEvent(message);
-                break;
-            }
-            case live_1.ServerMessageType.UserLeft: {
-                onUserLeftMessage(message);
-                break;
-            }
-            case live_1.ServerMessageType.RoomState: {
-                onRoomStateMessage(message);
-                break;
+        let subMessages = [];
+        if (Array.isArray(message)) {
+            subMessages = message;
+        }
+        else {
+            subMessages.push(message);
+        }
+        const updates = {
+            nodes: new Set(),
+            others: [],
+        };
+        for (const subMessage of subMessages) {
+            switch (subMessage.type) {
+                case live_1.ServerMessageType.UserJoined: {
+                    updates.others.push(onUserJoinedMessage(message));
+                    break;
+                }
+                case live_1.ServerMessageType.UpdatePresence: {
+                    updates.others.push(onUpdatePresenceMessage(subMessage));
+                    break;
+                }
+                case live_1.ServerMessageType.Event: {
+                    onEvent(subMessage);
+                    break;
+                }
+                case live_1.ServerMessageType.UserLeft: {
+                    const event = onUserLeftMessage(subMessage);
+                    if (event) {
+                        updates.others.push(event);
+                    }
+                    break;
+                }
+                case live_1.ServerMessageType.RoomState: {
+                    updates.others.push(onRoomStateMessage(subMessage));
+                    break;
+                }
+                case live_1.ServerMessageType.InitialStorageState: {
+                    createRootFromMessage(subMessage);
+                    _getInitialStateResolver === null || _getInitialStateResolver === void 0 ? void 0 : _getInitialStateResolver();
+                    break;
+                }
+                case live_1.ServerMessageType.UpdateStorage: {
+                    const applyResult = apply(subMessage.ops);
+                    for (const node of applyResult.updates.nodes) {
+                        updates.nodes.add(node);
+                    }
+                    break;
+                }
             }
         }
-        storage.onMessage(message);
+        notify(updates);
     }
     // function onWakeUp() {
     //   // Sometimes, the browser can put the webpage on pause (computer is on sleep mode for example)
@@ -310,7 +604,7 @@ function makeStateMachine(state, context, mockedEffects) {
         }
         clearTimeout(state.timeoutHandles.reconnect);
         state.users = {};
-        updateUsers({ type: "reset" });
+        notify({ others: [{ type: "reset" }] });
         if (event.code >= 4000 && event.code <= 4100) {
             updateConnection({ state: "failed" });
             const error = new LiveblocksError(event.reason, event.code);
@@ -399,7 +693,7 @@ function makeStateMachine(state, context, mockedEffects) {
                 return;
             }
             effects.send(messages);
-            state.flushData = {
+            state.buffer = {
                 messages: [],
                 storageOperations: [],
                 presence: null,
@@ -415,19 +709,19 @@ function makeStateMachine(state, context, mockedEffects) {
     }
     function flushDataToMessages(state) {
         const messages = [];
-        if (state.flushData.presence) {
+        if (state.buffer.presence) {
             messages.push({
                 type: live_1.ClientMessageType.UpdatePresence,
-                data: state.flushData.presence,
+                data: state.buffer.presence,
             });
         }
-        for (const event of state.flushData.messages) {
+        for (const event of state.buffer.messages) {
             messages.push(event);
         }
-        if (state.flushData.storageOperations.length > 0) {
+        if (state.buffer.storageOperations.length > 0) {
             messages.push({
                 type: live_1.ClientMessageType.UpdateStorage,
-                ops: state.flushData.storageOperations,
+                ops: state.buffer.storageOperations,
             });
         }
         return messages;
@@ -449,7 +743,7 @@ function makeStateMachine(state, context, mockedEffects) {
         clearTimeout(state.timeoutHandles.pongTimeout);
         clearInterval(state.intervalHandles.heartbeat);
         state.users = {};
-        updateUsers({ type: "reset" });
+        notify({ others: [{ type: "reset" }] });
         clearListeners();
     }
     function clearListeners() {
@@ -467,44 +761,115 @@ function makeStateMachine(state, context, mockedEffects) {
         if (state.socket == null) {
             return;
         }
-        state.flushData.messages.push({
+        state.buffer.messages.push({
             type: live_1.ClientMessageType.ClientEvent,
             event,
         });
         tryFlushing();
     }
     function dispatch(ops) {
-        state.flushData.storageOperations.push(...ops);
+        state.buffer.storageOperations.push(...ops);
         tryFlushing();
     }
-    const storage = new storage_1.default({
-        fetchStorage: () => {
-            state.flushData.messages.push({ type: live_1.ClientMessageType.FetchStorage });
-            tryFlushing();
-        },
-        dispatch,
-        getConnectionId: () => {
-            const me = getSelf();
-            if (me) {
-                return me.connectionId;
-            }
-            throw new Error("Unexpected");
-        },
-        defaultRoot: state.defaultStorageRoot,
-    });
+    let _getInitialStatePromise = null;
+    let _getInitialStateResolver = null;
     function getStorage() {
         return __awaiter(this, void 0, void 0, function* () {
-            const doc = yield storage.getDocument();
+            if (state.root) {
+                return {
+                    root: state.root,
+                };
+            }
+            if (_getInitialStatePromise == null) {
+                state.buffer.messages.push({ type: live_1.ClientMessageType.FetchStorage });
+                tryFlushing();
+                _getInitialStatePromise = new Promise((resolve) => (_getInitialStateResolver = resolve));
+            }
+            yield _getInitialStatePromise;
             return {
-                root: doc.root,
+                root: state.root,
             };
         });
     }
     function undo() {
-        storage.undo();
+        if (state.isBatching) {
+            throw new Error("undo is not allowed during a batch");
+        }
+        const historyItem = state.undoStack.pop();
+        if (historyItem == null) {
+            return;
+        }
+        state.isHistoryPaused = false;
+        const result = apply(historyItem);
+        notify(result.updates);
+        state.redoStack.push(result.reverse);
+        for (const op of historyItem) {
+            if (op.type !== "presence") {
+                state.buffer.storageOperations.push(op);
+            }
+        }
+        tryFlushing();
     }
     function redo() {
-        storage.redo();
+        if (state.isBatching) {
+            throw new Error("redo is not allowed during a batch");
+        }
+        const historyItem = state.redoStack.pop();
+        if (historyItem == null) {
+            return;
+        }
+        state.isHistoryPaused = false;
+        const result = apply(historyItem);
+        notify(result.updates);
+        state.undoStack.push(result.reverse);
+        for (const op of historyItem) {
+            if (op.type !== "presence") {
+                state.buffer.storageOperations.push(op);
+            }
+        }
+        tryFlushing();
+    }
+    function batch(callback) {
+        if (state.isBatching) {
+            throw new Error("batch should not be called during a batch");
+        }
+        state.isBatching = true;
+        try {
+            callback();
+        }
+        finally {
+            state.isBatching = false;
+            if (state.batch.reverseOps.length > 0) {
+                addToUndoStack(state.batch.reverseOps);
+            }
+            // Clear the redo stack because batch is always called from a local operation
+            state.redoStack = [];
+            if (state.batch.ops.length > 0) {
+                dispatch(state.batch.ops);
+            }
+            notify(state.batch.updates);
+            state.batch = {
+                ops: [],
+                reverseOps: [],
+                updates: {
+                    others: [],
+                    nodes: new Set(),
+                    presence: false,
+                },
+            };
+            tryFlushing();
+        }
+    }
+    function pauseHistory() {
+        state.pausedHistory = [];
+        state.isHistoryPaused = true;
+    }
+    function resumeHistory() {
+        state.isHistoryPaused = false;
+        if (state.pausedHistory.length > 0) {
+            addToUndoStack(state.pausedHistory);
+        }
+        state.pausedHistory = [];
     }
     return {
         // Internal
@@ -516,6 +881,8 @@ function makeStateMachine(state, context, mockedEffects) {
         onNavigatorOnline,
         // onWakeUp,
         onVisibilityChange,
+        getUndoStack: () => state.undoStack,
+        getItemsCount: () => state.items.size,
         // Core
         connect,
         disconnect,
@@ -524,8 +891,11 @@ function makeStateMachine(state, context, mockedEffects) {
         // Presence
         updatePresence,
         broadcastEvent,
+        batch,
         undo,
         redo,
+        pauseHistory,
+        resumeHistory,
         getStorage,
         selectors: {
             // Core
@@ -548,6 +918,7 @@ function defaultState(me, defaultStorageRoot) {
             "my-presence": [],
             error: [],
             connection: [],
+            storage: [],
         },
         numberOfRetry: 0,
         lastFlushTime: 0,
@@ -556,7 +927,7 @@ function defaultState(me, defaultStorageRoot) {
             reconnect: 0,
             pongTimeout: 0,
         },
-        flushData: {
+        buffer: {
             presence: me == null ? {} : me,
             messages: [],
             storageOperations: [],
@@ -569,12 +940,27 @@ function defaultState(me, defaultStorageRoot) {
         others: makeOthers({}),
         defaultStorageRoot,
         idFactory: null,
+        // Storage
+        clock: 0,
+        opClock: 0,
+        items: new Map(),
+        root: undefined,
+        undoStack: [],
+        redoStack: [],
+        isHistoryPaused: false,
+        pausedHistory: [],
+        isBatching: false,
+        batch: {
+            ops: [],
+            updates: { nodes: new Set(), presence: false, others: [] },
+            reverseOps: [],
+        },
     };
 }
 exports.defaultState = defaultState;
 function createRoom(name, options) {
     const throttleDelay = options.throttle || 100;
-    const liveblocksServer = options.liveblocksServer || "wss://liveblocks.net/v4";
+    const liveblocksServer = options.liveblocksServer || "wss://liveblocks.net/v5";
     let authEndpoint;
     if (options.authEndpoint) {
         authEndpoint = options.authEndpoint;
@@ -608,8 +994,13 @@ function createRoom(name, options) {
         getOthers: machine.selectors.getOthers,
         broadcastEvent: machine.broadcastEvent,
         getStorage: machine.getStorage,
-        undo: machine.undo,
-        redo: machine.redo,
+        batch: machine.batch,
+        history: {
+            undo: machine.undo,
+            redo: machine.redo,
+            pause: machine.pauseHistory,
+            resume: machine.resumeHistory,
+        },
     };
     return {
         connect: machine.connect,