@liveblocks/client 0.16.13 → 0.16.16

package/index.d.ts

@@ -1,5 +1,5 @@
 import { C as ClientOptions, a as Client } from './shared';
-export { B as BroadcastOptions, a as Client, H as History, J as Json, d as JsonObject, L as LiveList, b as LiveMap, c as LiveObject, e as LiveStructure, f as Lson, g as LsonObject, O as Others, P as Presence, R as Room, S as StorageUpdate, U as User } from './shared';
+export { B as BroadcastOptions, a as Client, H as History, J as Json, d as JsonObject, c as LiveList, b as LiveMap, L as LiveObject, e as Lson, f as LsonObject, O as Others, P as Presence, R as Room, S as StorageUpdate, U as User } from './shared';
 
 /**
  * Create a client that will be responsible to communicate with liveblocks servers.

package/index.js

@@ -6,6 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 
 var LiveObject = require("./shared.js"), _excluded = [ "_hasReceivedInitialPresence" ], BACKOFF_RETRY_DELAYS = [ 250, 500, 1e3, 2e3, 4e3, 8e3, 1e4 ], BACKOFF_RETRY_DELAYS_SLOW = [ 2e3, 3e4, 6e4, 3e5 ];
 
+function isValidRoomEventType(value) {
+ return "my-presence" === value || "others" === value || "event" === value || "error" === value || "connection" === value;
+}
+
 function makeOthers(userMap) {
  var _ref, users = Object.values(userMap).map((function(user) {
   return user._hasReceivedInitialPresence, LiveObject._objectWithoutPropertiesLoose(user, _excluded);
@@ -93,8 +97,8 @@ function makeStateMachine(state, context, mockedEffects) {
    roomId: context.roomId
   })), state.defaultStorageRoot) null == state.root.get(_key) && state.root.set(_key, state.defaultStorageRoot[_key]);
  }
- function addItem(id, liveItem) {
-  state.items.set(id, liveItem);
+ function addItem(id, item) {
+  state.items.set(id, item);
  }
  function deleteItem(id) {
   state.items.delete(id);
@@ -160,34 +164,40 @@ function makeStateMachine(state, context, mockedEffects) {
     if (state.me = LiveObject._extends({}, state.me, op.data), null == state.buffer.presence) state.buffer.presence = op.data; else for (var _key3 in op.data) state.buffer.presence[_key3] = op.data[_key3];
     result.reverse.unshift(reverse), result.updates.presence = !0;
    } else {
-    var source = void 0;
-    if (op.opId || (op.opId = generateOpId()), isLocal) source = LiveObject.OpSource.UNDOREDO_RECONNECT; else source = state.offlineOperations.delete(LiveObject.nn(op.opId)) ? LiveObject.OpSource.ACK : LiveObject.OpSource.REMOTE;
-    var applyOpResult = applyOp(op, source);
+    isLocal && !op.opId && (op.opId = generateOpId());
+    var applyOpResult = applyOp(op, isLocal);
     if (applyOpResult.modified) {
-     var _result$reverse, parentId = "HasParent" === applyOpResult.modified.node.parent.type ? LiveObject.nn(applyOpResult.modified.node.parent.node._id, "Expected parent node to have an ID") : void 0;
-     if (!parentId || !createdNodeIds.has(parentId)) result.updates.storageUpdates.set(LiveObject.nn(applyOpResult.modified.node._id), LiveObject.mergeStorageUpdates(result.updates.storageUpdates.get(LiveObject.nn(applyOpResult.modified.node._id)), applyOpResult.modified)), 
+     var _applyOpResult$modifi, _result$reverse, parentId = null == (_applyOpResult$modifi = applyOpResult.modified.node._parent) ? void 0 : _applyOpResult$modifi._id;
+     if (!createdNodeIds.has(parentId)) result.updates.storageUpdates.set(applyOpResult.modified.node._id, LiveObject.mergeStorageUpdates(result.updates.storageUpdates.get(applyOpResult.modified.node._id), applyOpResult.modified)), 
      (_result$reverse = result.reverse).unshift.apply(_result$reverse, applyOpResult.reverse);
-     op.type !== LiveObject.OpCode.CREATE_LIST && op.type !== LiveObject.OpCode.CREATE_MAP && op.type !== LiveObject.OpCode.CREATE_OBJECT || createdNodeIds.add(LiveObject.nn(applyOpResult.modified.node._id));
+     op.type !== LiveObject.OpCode.CREATE_LIST && op.type !== LiveObject.OpCode.CREATE_MAP && op.type !== LiveObject.OpCode.CREATE_OBJECT || createdNodeIds.add(applyOpResult.modified.node._id);
     }
    }
   }
   return result;
  }
- function applyOp(op, source) {
-  switch (op.type) {
+ function applyOp(op, isLocal) {
+  switch (op.opId && state.offlineOperations.delete(op.opId), op.type) {
   case LiveObject.OpCode.DELETE_OBJECT_KEY:
   case LiveObject.OpCode.UPDATE_OBJECT:
   case LiveObject.OpCode.DELETE_CRDT:
    var item = state.items.get(op.id);
    return null == item ? {
     modified: !1
-   } : item._apply(op, source === LiveObject.OpSource.UNDOREDO_RECONNECT);
+   } : item._apply(op, isLocal);
 
   case LiveObject.OpCode.SET_PARENT_KEY:
    var _item = state.items.get(op.id);
-   return null == _item ? {
+   if (null == _item) return {
     modified: !1
-   } : "HasParent" === _item.parent.type && LiveObject.isLiveList(_item.parent.node) ? _item.parent.node._setChildKey(op.parentKey, _item, source) : {
+   };
+   if (_item._parent instanceof LiveObject.LiveList) {
+    var previousKey = _item._parentKey;
+    return previousKey === op.parentKey ? {
+     modified: !1
+    } : _item._parent._setChildKey(op.parentKey, _item, previousKey);
+   }
+   return {
     modified: !1
    };
 
@@ -195,13 +205,10 @@ function makeStateMachine(state, context, mockedEffects) {
   case LiveObject.OpCode.CREATE_LIST:
   case LiveObject.OpCode.CREATE_MAP:
   case LiveObject.OpCode.CREATE_REGISTER:
-   if (void 0 === op.parentId) return {
-    modified: !1
-   };
    var parent = state.items.get(op.parentId);
    return null == parent ? {
     modified: !1
-   } : parent._attachChild(op, source);
+   } : parent._attachChild(op, isLocal);
   }
  }
  function connect() {
@@ -440,7 +447,7 @@ function makeStateMachine(state, context, mockedEffects) {
  function tryFlushing() {
   var storageOps = state.buffer.storageOperations;
   if (storageOps.length > 0 && storageOps.forEach((function(op) {
-   state.offlineOperations.set(LiveObject.nn(op.opId), op);
+   state.offlineOperations.set(op.opId, op);
   })), null != state.socket && state.socket.readyState === state.socket.OPEN) {
    var now = Date.now();
    if (now - state.lastFlushTime > context.throttleDelay) {
@@ -488,10 +495,10 @@ function makeStateMachine(state, context, mockedEffects) {
    "unavailable" === state.connection.state && reconnect();
   },
   simulateSocketClose: function() {
-   state.socket && (state.socket = null);
+   state.socket && state.socket.close();
   },
   simulateSendCloseEvent: function(event) {
-   onClose(event);
+   state.socket && onClose(event);
   },
   onVisibilityChange: function(visibilityState) {
    "visible" === visibilityState && "open" === state.connection.state && heartbeat();
@@ -519,23 +526,28 @@ function makeStateMachine(state, context, mockedEffects) {
    }();
   },
   subscribe: function(firstParam, listener, options) {
-   if (LiveObject.isLiveNode(firstParam)) return function(liveValue, innerCallback, options) {
+   if (firstParam instanceof LiveObject.AbstractCrdt) return function(crdt, innerCallback, options) {
     return genericSubscribe((function(updates) {
      for (var _step, relatedUpdates = [], _iterator = LiveObject._createForOfIteratorHelperLoose(updates); !(_step = _iterator()).done; ) {
       var update = _step.value;
-      null != options && options.isDeep && LiveObject.isSameNodeOrChildOf(update.node, liveValue) ? relatedUpdates.push(update) : update.node._id === liveValue._id && innerCallback(update.node);
+      null != options && options.isDeep && LiveObject.isSameNodeOrChildOf(update.node, crdt) ? relatedUpdates.push(update) : update.node._id === crdt._id && innerCallback(update.node);
      }
      null != options && options.isDeep && relatedUpdates.length > 0 && innerCallback(relatedUpdates);
     }));
    }(firstParam, listener, options);
    if ("function" == typeof firstParam) return genericSubscribe(firstParam);
-   if ("my-presence" !== (value = firstParam) && "others" !== value && "event" !== value && "error" !== value && "connection" !== value) throw new Error('"' + firstParam + '" is not a valid event name');
-   var value;
+   if (!isValidRoomEventType(firstParam)) throw new Error('"' + firstParam + '" is not a valid event name');
    return state.listeners[firstParam].push(listener), function() {
     var callbacks = state.listeners[firstParam];
     LiveObject.remove(callbacks, listener);
    };
   },
+  unsubscribe: function(event, callback) {
+   if (console.warn("unsubscribe is depreacted and will be removed in a future version.\nuse the callback returned by subscribe instead.\nSee v0.13 release notes for more information.\n"), 
+   !isValidRoomEventType(event)) throw new Error('"' + event + '" is not a valid event name');
+   var callbacks = state.listeners[event];
+   LiveObject.remove(callbacks, callback);
+  },
   updatePresence: function(overrides, options) {
    var oldValues = {};
    for (var _key4 in null == state.buffer.presence && (state.buffer.presence = {}), 
@@ -623,7 +635,7 @@ function makeStateMachine(state, context, mockedEffects) {
     return _getInitialStateResolver = resolve;
    }))), _getInitialStatePromise.then((function() {
     return {
-     root: LiveObject.nn(state.root)
+     root: state.root
     };
    })));
   },
@@ -709,6 +721,7 @@ function createRoom(options, context) {
   getConnectionState: machine.selectors.getConnectionState,
   getSelf: machine.selectors.getSelf,
   subscribe: machine.subscribe,
+  unsubscribe: machine.unsubscribe,
   getPresence: machine.selectors.getPresence,
   updatePresence: machine.updatePresence,
   getOthers: machine.selectors.getOthers,
@@ -721,9 +734,9 @@ function createRoom(options, context) {
    pause: machine.pauseHistory,
    resume: machine.resumeHistory
   },
-  __INTERNAL_DO_NOT_USE: {
-   simulateCloseWebsocket: machine.simulateSocketClose,
-   simulateSendCloseEvent: machine.simulateSendCloseEvent
+  internalDevTools: {
+   closeWebsocket: machine.simulateSocketClose,
+   sendCloseEvent: machine.simulateSendCloseEvent
   }
  };
  return {
@@ -819,8 +832,8 @@ exports.createClient = function(options) {
   enter: function(roomId, options) {
    void 0 === options && (options = {});
    var internalRoom = rooms.get(roomId);
-   return internalRoom || (LiveObject.errorIf(options.defaultPresence, "Argument `defaultPresence` will be removed in @liveblocks/client 0.18. Please use `initialPresence` instead. For more info, see https://bit.ly/3Niy5aP"), 
-   LiveObject.errorIf(options.defaultStorageRoot, "Argument `defaultStorageRoot` will be removed in @liveblocks/client 0.18. Please use `initialStorage` instead. For more info, see https://bit.ly/3Niy5aP"), 
+   return internalRoom || (LiveObject.deprecateIf(options.defaultPresence, "Argument `defaultPresence` will be removed in @liveblocks/client 0.18. Please use `initialPresence` instead. For more info, see https://bit.ly/3Niy5aP", "defaultPresence"), 
+   LiveObject.deprecateIf(options.defaultStorageRoot, "Argument `defaultStorageRoot` will be removed in @liveblocks/client 0.18. Please use `initialStorage` instead. For more info, see https://bit.ly/3Niy5aP", "defaultStorageRoot"), 
    internalRoom = createRoom({
     initialPresence: options.initialPresence,
     initialStorage: options.initialStorage,

package/index.mjs

@@ -1,9 +1,13 @@
-import { i as isLiveNode, r as remove, S as ServerMsgCode, m as mergeStorageUpdates, W as WebsocketCloseCodes, C as ClientMsgCode, n as nn, a as isTokenValid, b as isSameNodeOrChildOf, L as LiveObject, g as getTreesDiffOperations, O as OpSource, c as OpCode, d as isLiveList, t as tryParseJson, e as isJsonArray, f as compact, h as b64decode, j as isJsonObject, k as isRootCrdt, l as errorIf } from "./shared.mjs";
+import { A as AbstractCrdt, r as remove, S as ServerMsgCode, m as mergeStorageUpdates, W as WebsocketCloseCodes, C as ClientMsgCode, i as isTokenValid, a as isSameNodeOrChildOf, L as LiveObject, g as getTreesDiffOperations, O as OpCode, b as LiveList, t as tryParseJson, c as isJsonArray, d as compact, e as b64decode, f as isJsonObject, h as isRootCrdt, j as deprecateIf } from "./shared.mjs";
 
-export { o as LiveList, p as LiveMap, L as LiveObject } from "./shared.mjs";
+export { b as LiveList, k as LiveMap, L as LiveObject } from "./shared.mjs";
 
 const BACKOFF_RETRY_DELAYS = [ 250, 500, 1e3, 2e3, 4e3, 8e3, 1e4 ], BACKOFF_RETRY_DELAYS_SLOW = [ 2e3, 3e4, 6e4, 3e5 ];
 
+function isValidRoomEventType(value) {
+ return "my-presence" === value || "others" === value || "event" === value || "error" === value || "connection" === value;
+}
+
 function makeOthers(userMap) {
  const users = Object.values(userMap).map((user => function(s, e) {
   var t = {};
@@ -84,8 +88,8 @@ function makeStateMachine(state, context, mockedEffects) {
   }(message.items);
   for (const key in state.defaultStorageRoot) null == state.root.get(key) && state.root.set(key, state.defaultStorageRoot[key]);
  }
- function addItem(id, liveItem) {
-  state.items.set(id, liveItem);
+ function addItem(id, item) {
+  state.items.set(id, item);
  }
  function deleteItem(id) {
   state.items.delete(id);
@@ -124,6 +128,7 @@ function makeStateMachine(state, context, mockedEffects) {
   return `${getConnectionId()}:${state.opClock++}`;
  }
  function apply(item, isLocal) {
+  var _a;
   const result = {
    reverse: [],
    updates: {
@@ -140,21 +145,18 @@ function makeStateMachine(state, context, mockedEffects) {
    if (state.me = Object.assign(Object.assign({}, state.me), op.data), null == state.buffer.presence) state.buffer.presence = op.data; else for (const key in op.data) state.buffer.presence[key] = op.data[key];
    result.reverse.unshift(reverse), result.updates.presence = !0;
   } else {
-   let source;
-   if (op.opId || (op.opId = generateOpId()), isLocal) source = OpSource.UNDOREDO_RECONNECT; else {
-    source = state.offlineOperations.delete(nn(op.opId)) ? OpSource.ACK : OpSource.REMOTE;
-   }
-   const applyOpResult = applyOp(op, source);
+   isLocal && !op.opId && (op.opId = generateOpId());
+   const applyOpResult = applyOp(op, isLocal);
    if (applyOpResult.modified) {
-    const parentId = "HasParent" === applyOpResult.modified.node.parent.type ? nn(applyOpResult.modified.node.parent.node._id, "Expected parent node to have an ID") : void 0;
-    parentId && createdNodeIds.has(parentId) || (result.updates.storageUpdates.set(nn(applyOpResult.modified.node._id), mergeStorageUpdates(result.updates.storageUpdates.get(nn(applyOpResult.modified.node._id)), applyOpResult.modified)), 
-    result.reverse.unshift(...applyOpResult.reverse)), op.type !== OpCode.CREATE_LIST && op.type !== OpCode.CREATE_MAP && op.type !== OpCode.CREATE_OBJECT || createdNodeIds.add(nn(applyOpResult.modified.node._id));
+    const parentId = null === (_a = applyOpResult.modified.node._parent) || void 0 === _a ? void 0 : _a._id;
+    createdNodeIds.has(parentId) || (result.updates.storageUpdates.set(applyOpResult.modified.node._id, mergeStorageUpdates(result.updates.storageUpdates.get(applyOpResult.modified.node._id), applyOpResult.modified)), 
+    result.reverse.unshift(...applyOpResult.reverse)), op.type !== OpCode.CREATE_LIST && op.type !== OpCode.CREATE_MAP && op.type !== OpCode.CREATE_OBJECT || createdNodeIds.add(applyOpResult.modified.node._id);
    }
   }
   return result;
  }
- function applyOp(op, source) {
-  switch (op.type) {
+ function applyOp(op, isLocal) {
+  switch (op.opId && state.offlineOperations.delete(op.opId), op.type) {
   case OpCode.DELETE_OBJECT_KEY:
   case OpCode.UPDATE_OBJECT:
   case OpCode.DELETE_CRDT:
@@ -162,15 +164,22 @@ function makeStateMachine(state, context, mockedEffects) {
     const item = state.items.get(op.id);
     return null == item ? {
      modified: !1
-    } : item._apply(op, source === OpSource.UNDOREDO_RECONNECT);
+    } : item._apply(op, isLocal);
    }
 
   case OpCode.SET_PARENT_KEY:
    {
     const item = state.items.get(op.id);
-    return null == item ? {
+    if (null == item) return {
      modified: !1
-    } : "HasParent" === item.parent.type && isLiveList(item.parent.node) ? item.parent.node._setChildKey(op.parentKey, item, source) : {
+    };
+    if (item._parent instanceof LiveList) {
+     const previousKey = item._parentKey;
+     return previousKey === op.parentKey ? {
+      modified: !1
+     } : item._parent._setChildKey(op.parentKey, item, previousKey);
+    }
+    return {
      modified: !1
     };
    }
@@ -180,13 +189,10 @@ function makeStateMachine(state, context, mockedEffects) {
   case OpCode.CREATE_MAP:
   case OpCode.CREATE_REGISTER:
    {
-    if (void 0 === op.parentId) return {
-     modified: !1
-    };
     const parent = state.items.get(op.parentId);
     return null == parent ? {
      modified: !1
-    } : parent._attachChild(op, source);
+    } : parent._attachChild(op, isLocal);
    }
   }
  }
@@ -418,7 +424,7 @@ function makeStateMachine(state, context, mockedEffects) {
  function tryFlushing() {
   const storageOps = state.buffer.storageOperations;
   if (storageOps.length > 0 && storageOps.forEach((op => {
-   state.offlineOperations.set(nn(op.opId), op);
+   state.offlineOperations.set(op.opId, op);
   })), null == state.socket || state.socket.readyState !== state.socket.OPEN) return void (state.buffer.storageOperations = []);
   const now = Date.now();
   if (now - state.lastFlushTime > context.throttleDelay) {
@@ -460,10 +466,10 @@ function makeStateMachine(state, context, mockedEffects) {
    "unavailable" === state.connection.state && reconnect();
   },
   simulateSocketClose: function() {
-   state.socket && (state.socket = null);
+   state.socket && state.socket.close();
   },
   simulateSendCloseEvent: function(event) {
-   onClose(event);
+   state.socket && onClose(event);
   },
   onVisibilityChange: function(visibilityState) {
    "visible" === visibilityState && "open" === state.connection.state && heartbeat();
@@ -487,21 +493,26 @@ function makeStateMachine(state, context, mockedEffects) {
    }();
   },
   subscribe: function(firstParam, listener, options) {
-   if (isLiveNode(firstParam)) return function(liveValue, innerCallback, options) {
+   if (firstParam instanceof AbstractCrdt) return function(crdt, innerCallback, options) {
     return genericSubscribe((updates => {
      const relatedUpdates = [];
-     for (const update of updates) (null == options ? void 0 : options.isDeep) && isSameNodeOrChildOf(update.node, liveValue) ? relatedUpdates.push(update) : update.node._id === liveValue._id && innerCallback(update.node);
+     for (const update of updates) (null == options ? void 0 : options.isDeep) && isSameNodeOrChildOf(update.node, crdt) ? relatedUpdates.push(update) : update.node._id === crdt._id && innerCallback(update.node);
      (null == options ? void 0 : options.isDeep) && relatedUpdates.length > 0 && innerCallback(relatedUpdates);
     }));
    }(firstParam, listener, options);
    if ("function" == typeof firstParam) return genericSubscribe(firstParam);
-   if ("my-presence" !== (value = firstParam) && "others" !== value && "event" !== value && "error" !== value && "connection" !== value) throw new Error(`"${firstParam}" is not a valid event name`);
-   var value;
+   if (!isValidRoomEventType(firstParam)) throw new Error(`"${firstParam}" is not a valid event name`);
    return state.listeners[firstParam].push(listener), () => {
     const callbacks = state.listeners[firstParam];
     remove(callbacks, listener);
    };
   },
+  unsubscribe: function(event, callback) {
+   if (console.warn("unsubscribe is depreacted and will be removed in a future version.\nuse the callback returned by subscribe instead.\nSee v0.13 release notes for more information.\n"), 
+   !isValidRoomEventType(event)) throw new Error(`"${event}" is not a valid event name`);
+   const callbacks = state.listeners[event];
+   remove(callbacks, callback);
+  },
   updatePresence: function(overrides, options) {
    const oldValues = {};
    null == state.buffer.presence && (state.buffer.presence = {});
@@ -577,7 +588,7 @@ function makeStateMachine(state, context, mockedEffects) {
     type: ClientMsgCode.FETCH_STORAGE
    }), tryFlushing(), _getInitialStatePromise = new Promise((resolve => _getInitialStateResolver = resolve))), 
    _getInitialStatePromise.then((() => ({
-    root: nn(state.root)
+    root: state.root
    }))));
   },
   selectors: {
@@ -663,6 +674,7 @@ function createRoom(options, context) {
   getConnectionState: machine.selectors.getConnectionState,
   getSelf: machine.selectors.getSelf,
   subscribe: machine.subscribe,
+  unsubscribe: machine.unsubscribe,
   getPresence: machine.selectors.getPresence,
   updatePresence: machine.updatePresence,
   getOthers: machine.selectors.getOthers,
@@ -675,9 +687,9 @@ function createRoom(options, context) {
    pause: machine.pauseHistory,
    resume: machine.resumeHistory
   },
-  __INTERNAL_DO_NOT_USE: {
-   simulateCloseWebsocket: machine.simulateSocketClose,
-   simulateSendCloseEvent: machine.simulateSendCloseEvent
+  internalDevTools: {
+   closeWebsocket: machine.simulateSocketClose,
+   sendCloseEvent: machine.simulateSendCloseEvent
   }
  };
  return {
@@ -748,8 +760,8 @@ function createClient(options) {
   },
   enter: function(roomId, options = {}) {
    let internalRoom = rooms.get(roomId);
-   return internalRoom || (errorIf(options.defaultPresence, "Argument `defaultPresence` will be removed in @liveblocks/client 0.18. Please use `initialPresence` instead. For more info, see https://bit.ly/3Niy5aP"), 
-   errorIf(options.defaultStorageRoot, "Argument `defaultStorageRoot` will be removed in @liveblocks/client 0.18. Please use `initialStorage` instead. For more info, see https://bit.ly/3Niy5aP"), 
+   return internalRoom || (deprecateIf(options.defaultPresence, "Argument `defaultPresence` will be removed in @liveblocks/client 0.18. Please use `initialPresence` instead. For more info, see https://bit.ly/3Niy5aP", "defaultPresence"), 
+   deprecateIf(options.defaultStorageRoot, "Argument `defaultStorageRoot` will be removed in @liveblocks/client 0.18. Please use `initialStorage` instead. For more info, see https://bit.ly/3Niy5aP", "defaultStorageRoot"), 
    internalRoom = createRoom({
     initialPresence: options.initialPresence,
     initialStorage: options.initialStorage,