@liveblocks/react 1.0.2 → 1.0.6-test1

package/README.md

@@ -32,8 +32,9 @@ npm install @liveblocks/client @liveblocks/react
 
 ## Documentation
 
-Read the [documentation](https://liveblocks.io/docs) for guides and API
-references.
+Read the
+[documentation](https://liveblocks.io/docs/api-reference/liveblocks-react) for
+guides and API references.
 
 ## Examples
 

package/dist/index.js

@@ -5,9 +5,7 @@ function ClientSideSuspense(props) {
   React.useEffect(() => {
     setMounted(true);
   }, []);
-  return /* @__PURE__ */ React.createElement(React.Suspense, {
-    fallback: props.fallback
-  }, mounted ? props.children() : props.fallback);
+  return /* @__PURE__ */ React.createElement(React.Suspense, { fallback: props.fallback }, mounted ? props.children() : props.fallback);
 }
 
 // src/factory.tsx
@@ -24,6 +22,9 @@ var _withselector = require('use-sync-external-store/shim/with-selector');
 
 function useRerender() {
   const [, update] = _react.useReducer.call(void 0, 
+    // This implementation works by incrementing a hidden counter value that is
+    // never consumed. Simply incrementing the counter changes the component's
+    // state and, thus, trigger a re-render.
     (x) => x + 1,
     0
   );
@@ -52,7 +53,10 @@ var superfluous_unstable_batchedUpdates = "You don\u2019t need to pass unstable_
 function useSyncExternalStore(s, gs, gss) {
   return _withselector.useSyncExternalStoreWithSelector.call(void 0, s, gs, gss, identity);
 }
-var EMPTY_OTHERS = _core.asArrayWithLegacyMethods.call(void 0, []);
+var EMPTY_OTHERS = (
+  // NOTE: asArrayWithLegacyMethods() wrapping should no longer be necessary in 0.19
+  _core.asArrayWithLegacyMethods.call(void 0, [])
+);
 function getEmptyOthers() {
   return EMPTY_OTHERS;
 }
@@ -140,9 +144,7 @@ function createRoomContext(client) {
         client.leave(roomId);
       };
     }, [roomId, frozen]);
-    return /* @__PURE__ */ React2.createElement(RoomContext.Provider, {
-      value: room
-    }, props.children);
+    return /* @__PURE__ */ React2.createElement(RoomContext.Provider, { value: room }, props.children);
   }
   function connectionIdSelector(others) {
     return others.map((user) => user.connectionId);
@@ -340,6 +342,7 @@ function createRoomContext(client) {
           liveValue = newCrdt;
           unsubscribeCrdt = room.subscribe(
             liveValue,
+            // TODO: This is hiding a bug! If `liveValue` happens to be the string `"event"` this actually subscribes an event handler!
             rerender
           );
           rerender();
@@ -347,10 +350,12 @@ function createRoomContext(client) {
       }
       let unsubscribeCrdt = room.subscribe(
         liveValue,
+        // TODO: This is hiding a bug! If `liveValue` happens to be the string `"event"` this actually subscribes an event handler!
         rerender
       );
       const unsubscribeRoot = room.subscribe(
         root,
+        // TODO: This is hiding a bug! If `liveValue` happens to be the string `"event"` this actually subscribes an event handler!
         onRootChange
       );
       rerender();
@@ -429,6 +434,7 @@ function createRoomContext(client) {
           () => callback(makeMutationContext(room), ...args)
         );
       },
+      // eslint-disable-next-line react-hooks/exhaustive-deps
       [room, ...deps]
     );
   }
@@ -482,6 +488,7 @@ function createRoomContext(client) {
     useRedo,
     useCanRedo,
     useCanUndo,
+    // These are just aliases. The passed-in key will define their return values.
     useList: useLegacyKey,
     useMap: useLegacyKey,
     useObject: useLegacyKey,
@@ -508,6 +515,7 @@ function createRoomContext(client) {
       useRedo,
       useCanRedo,
       useCanUndo,
+      // Legacy hooks
       useList: useLegacyKeySuspense,
       useMap: useLegacyKeySuspense,
       useObject: useLegacyKeySuspense,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/react",
-  "version": "1.0.2",
+  "version": "1.0.6-test1",
   "description": "A set of React hooks and providers to use Liveblocks declaratively. Liveblocks is the all-in-one toolkit to build collaborative products like Figma, Notion, and more.",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -20,8 +20,8 @@
     "test:watch": "jest --silent --verbose --color=always --watch"
   },
   "dependencies": {
-    "@liveblocks/client": "1.0.2",
-    "@liveblocks/core": "1.0.2",
+    "@liveblocks/client": "1.0.6-test1",
+    "@liveblocks/core": "1.0.6-test1",
     "use-sync-external-store": "^1.2.0"
   },
   "peerDependencies": {