@liveblocks/react 0.16.4-beta1 → 0.16.5

package/index.mjs

@@ -0,0 +1,230 @@
+import * as React from "react";
+
+import { useReducer } from "react";
+
+import { LiveMap, LiveList, LiveObject } from "@liveblocks/client";
+
+import { deprecateIf } from "@liveblocks/client/internal";
+
+const ClientContext = React.createContext(null);
+
+function LiveblocksProvider(props) {
+ return React.createElement(ClientContext.Provider, {
+  value: props.client
+ }, props.children);
+}
+
+function useClient() {
+ const client = React.useContext(ClientContext);
+ if (null == client) throw new Error("LiveblocksProvider is missing from the react tree");
+ return client;
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+ return new (P || (P = Promise))((function(resolve, reject) {
+  function fulfilled(value) {
+   try {
+    step(generator.next(value));
+   } catch (e) {
+    reject(e);
+   }
+  }
+  function rejected(value) {
+   try {
+    step(generator.throw(value));
+   } catch (e) {
+    reject(e);
+   }
+  }
+  function step(result) {
+   var value;
+   result.done ? resolve(result.value) : (value = result.value, value instanceof P ? value : new P((function(resolve) {
+    resolve(value);
+   }))).then(fulfilled, rejected);
+  }
+  step((generator = generator.apply(thisArg, _arguments || [])).next());
+ }));
+}
+
+function useRerender() {
+ const [, update] = useReducer((x => x + 1), 0);
+ return update;
+}
+
+const {RoomProvider: RoomProvider, useRoom: useRoom, useMyPresence: useMyPresence, useUpdateMyPresence: useUpdateMyPresence, useOthers: useOthers, useBroadcastEvent: useBroadcastEvent, useErrorListener: useErrorListener, useEventListener: useEventListener, useSelf: useSelf, useStorage: useStorage, useMap: useMap, useList: useList, useObject: useObject, useUndo: useUndo, useRedo: useRedo, useBatch: useBatch, useHistory: useHistory} = function() {
+ const RoomContext = React.createContext(null);
+ function useRoom() {
+  const room = React.useContext(RoomContext);
+  if (null == room) throw new Error("RoomProvider is missing from the react tree");
+  return room;
+ }
+ function useStorage() {
+  const room = useRoom(), [root, setState] = React.useState(null);
+  return React.useEffect((() => {
+   let didCancel = !1;
+   return function() {
+    __awaiter(this, void 0, void 0, (function*() {
+     const storage = yield room.getStorage();
+     didCancel || setState(storage.root);
+    }));
+   }(), () => {
+    didCancel = !0;
+   };
+  }), [ room ]), [ root ];
+ }
+ function useHistory() {
+  return useRoom().history;
+ }
+ function useStorageValue(key, initialValue) {
+  const room = useRoom(), [root] = useStorage(), rerender = useRerender();
+  if (React.useEffect((() => {
+   if (null == root) return;
+   let liveValue = root.get(key);
+   null == liveValue && (liveValue = initialValue, root.set(key, liveValue));
+   let unsubscribeCrdt = room.subscribe(liveValue, rerender);
+   const unsubscribeRoot = room.subscribe(root, (function() {
+    const newCrdt = root.get(key);
+    newCrdt !== liveValue && (unsubscribeCrdt(), liveValue = newCrdt, unsubscribeCrdt = room.subscribe(liveValue, rerender), 
+    rerender());
+   }));
+   return rerender(), () => {
+    unsubscribeRoot(), unsubscribeCrdt();
+   };
+  }), [ root, room ]), null == root) return {
+   status: "loading"
+  };
+  {
+   const value = root.get(key);
+   return null == value ? {
+    status: "notfound"
+   } : {
+    status: "ok",
+    value: value
+   };
+  }
+ }
+ return {
+  RoomProvider: function(props) {
+   const {id: roomId, initialPresence: initialPresence, initialStorage: initialStorage, defaultPresence: defaultPresence, defaultStorageRoot: defaultStorageRoot} = props;
+   if ("production" !== process.env.NODE_ENV) {
+    if (null == roomId) throw new Error("RoomProvider id property is required. For more information: https://liveblocks.io/docs/errors/liveblocks-react/RoomProvider-id-property-is-required");
+    if ("string" != typeof roomId) throw new Error("RoomProvider id property should be a string.");
+   }
+   deprecateIf(defaultPresence, "RoomProvider's `defaultPresence` prop will be removed in @liveblocks/react 0.18. Please use `initialPresence` instead. For more info, see https://bit.ly/3Niy5aP", "defaultPresence"), 
+   deprecateIf(defaultStorageRoot, "RoomProvider's `defaultStorageRoot` prop will be removed in @liveblocks/react 0.18. Please use `initialStorage` instead. For more info, see https://bit.ly/3Niy5aP", "defaultStorageRoot");
+   const client = useClient(), [room, setRoom] = React.useState((() => client.enter(roomId, {
+    initialPresence: initialPresence,
+    initialStorage: initialStorage,
+    defaultPresence: defaultPresence,
+    defaultStorageRoot: defaultStorageRoot,
+    DO_NOT_USE_withoutConnecting: "undefined" == typeof window
+   })));
+   return React.useEffect((() => (setRoom(client.enter(roomId, {
+    initialPresence: initialPresence,
+    initialStorage: initialStorage,
+    defaultPresence: defaultPresence,
+    defaultStorageRoot: defaultStorageRoot,
+    DO_NOT_USE_withoutConnecting: "undefined" == typeof window
+   })), () => {
+    client.leave(roomId);
+   })), [ client, roomId ]), React.createElement(RoomContext.Provider, {
+    value: room
+   }, props.children);
+  },
+  useBatch: function() {
+   return useRoom().batch;
+  },
+  useBroadcastEvent: function() {
+   const room = useRoom();
+   return React.useCallback(((event, options = {
+    shouldQueueEventIfNotReady: !1
+   }) => {
+    room.broadcastEvent(event, options);
+   }), [ room ]);
+  },
+  useErrorListener: function(callback) {
+   const room = useRoom(), savedCallback = React.useRef(callback);
+   React.useEffect((() => {
+    savedCallback.current = callback;
+   })), React.useEffect((() => {
+    const unsubscribe = room.subscribe("error", (e => savedCallback.current(e)));
+    return () => {
+     unsubscribe();
+    };
+   }), [ room ]);
+  },
+  useEventListener: function(callback) {
+   const room = useRoom(), savedCallback = React.useRef(callback);
+   React.useEffect((() => {
+    savedCallback.current = callback;
+   })), React.useEffect((() => {
+    const unsubscribe = room.subscribe("event", (e => savedCallback.current(e)));
+    return () => {
+     unsubscribe();
+    };
+   }), [ room ]);
+  },
+  useHistory: useHistory,
+  useList: function(key, items) {
+   deprecateIf(items, `Support for initializing items in useList() directly will be removed in @liveblocks/react 0.18.\n\nInstead, please initialize this data where you set up your RoomProvider:\n\n    import { LiveList } from "@liveblocks/client";\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveList(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`);
+   const value = useStorageValue(key, new LiveList(items));
+   return "ok" === value.status ? value.value : (deprecateIf("notfound" === value.status, `Key ${JSON.stringify(key)} was not found in Storage. Starting with 0.18, useList() will no longer automatically create this key.\n\nInstead, please initialize your storage where you set up your RoomProvider:\n\n    import { LiveList } from "@liveblocks/client";\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveList(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`), 
+   null);
+  },
+  useMap: function(key, entries) {
+   deprecateIf(entries, `Support for initializing entries in useMap() directly will be removed in @liveblocks/react 0.18.\n\nInstead, please initialize this data where you set up your RoomProvider:\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveMap(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`);
+   const value = useStorageValue(key, new LiveMap(null != entries ? entries : void 0));
+   return "ok" === value.status ? value.value : (deprecateIf("notfound" === value.status, `Key ${JSON.stringify(key)} was not found in Storage. Starting with 0.18, useMap() will no longer automatically create this key.\n\nInstead, please initialize your storage where you set up your RoomProvider:\n\n    import { LiveMap } from "@liveblocks/client";\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveMap(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`), 
+   null);
+  },
+  useMyPresence: function() {
+   const room = useRoom(), presence = room.getPresence(), rerender = useRerender();
+   return React.useEffect((() => {
+    const unsubscribe = room.subscribe("my-presence", rerender);
+    return () => {
+     unsubscribe();
+    };
+   }), [ room ]), [ presence, React.useCallback(((overrides, options) => room.updatePresence(overrides, options)), [ room ]) ];
+  },
+  useObject: function(key, initialData) {
+   deprecateIf(initialData, `Support for initializing data in useObject() directly will be removed in @liveblocks/react 0.18.\n\nInstead, please initialize this data where you set up your RoomProvider:\n\n    import { LiveObject } from "@liveblocks/client";\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveObject(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`);
+   const value = useStorageValue(key, new LiveObject(initialData));
+   return "ok" === value.status ? value.value : (deprecateIf("notfound" === value.status, `Key ${JSON.stringify(key)} was not found in Storage. Starting with 0.18, useObject() will no longer automatically create this key.\n\nInstead, please initialize your storage where you set up your RoomProvider:\n\n    import { LiveObject } from "@liveblocks/client";\n\n    const initialStorage = () => {\n      ${JSON.stringify(key)}: new LiveObject(...),\n      ...\n    };\n\n    <RoomProvider initialStorage={initialStorage}>\n      ...\n    </RoomProvider>\n\nPlease see https://bit.ly/3Niy5aP for details.`), 
+   null);
+  },
+  useOthers: function() {
+   const room = useRoom(), rerender = useRerender();
+   return React.useEffect((() => {
+    const unsubscribe = room.subscribe("others", rerender);
+    return () => {
+     unsubscribe();
+    };
+   }), [ room ]), room.getOthers();
+  },
+  useRedo: function() {
+   return useHistory().redo;
+  },
+  useRoom: useRoom,
+  useSelf: function() {
+   const room = useRoom(), rerender = useRerender();
+   return React.useEffect((() => {
+    const unsubscribePresence = room.subscribe("my-presence", rerender), unsubscribeConnection = room.subscribe("connection", rerender);
+    return () => {
+     unsubscribePresence(), unsubscribeConnection();
+    };
+   }), [ room ]), room.getSelf();
+  },
+  useStorage: useStorage,
+  useUndo: function() {
+   return useHistory().undo;
+  },
+  useUpdateMyPresence: function() {
+   const room = useRoom();
+   return React.useCallback(((overrides, options) => {
+    room.updatePresence(overrides, options);
+   }), [ room ]);
+  }
+ };
+}();
+
+export { LiveblocksProvider, RoomProvider, useBatch, useBroadcastEvent, useClient, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };

package/package.json

@@ -1,21 +1,13 @@
 {
   "name": "@liveblocks/react",
-  "version": "0.16.4-beta1",
+  "version": "0.16.5",
   "description": "A set of React hooks and providers to use Liveblocks declaratively.",
   "main": "./index.js",
+  "module": "./index.mjs",
   "types": "./index.d.ts",
   "files": [
     "**"
   ],
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./index.d.ts",
-      "module": "./esm/index.js",
-      "import": "./esm/index.mjs",
-      "default": "./index.js"
-    }
-  },
   "keywords": [
     "react",
     "liveblocks",
@@ -29,22 +21,24 @@
   "scripts": {
     "build": "rollup -c && cp ./package.json ./README.md ./lib",
     "start": "rollup -c -w",
+    "format": "eslint --fix src/ && prettier --write src/",
     "lint": "eslint src/",
     "test": "jest --watch",
     "test-ci": "jest"
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@liveblocks/client": "0.16.4-beta1",
+    "@liveblocks/client": "0.16.5",
     "react": "^16.14.0 || ^17 || ^18"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.16",
-    "@babel/preset-env": "^7.12.16",
-    "@babel/preset-react": "^7.12.13",
-    "@babel/preset-typescript": "^7.12.16",
+    "@babel/core": "^7.17.10",
+    "@babel/preset-env": "^7.17.10",
+    "@babel/preset-react": "^7.16.7",
+    "@babel/preset-typescript": "^7.16.7",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-node-resolve": "^11.2.1",
+    "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-typescript": "^8.3.1",
     "@testing-library/jest-dom": "^5.11.9",
     "@testing-library/react": "^13.1.1",
@@ -53,16 +47,16 @@
     "@types/react-dom": "^17.0.14",
     "@typescript-eslint/eslint-plugin": "^5.18.0",
     "@typescript-eslint/parser": "^5.18.0",
-    "babel-core": "^6.26.3",
-    "babel-jest": "^26.6.3",
-    "babel-runtime": "^6.26.0",
     "eslint": "^8.12.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "jest": "^26.6.3",
     "msw": "^0.27.1",
     "react-error-boundary": "^3.1.1",
     "rollup": "^2.39.0",
+    "rollup-plugin-command": "^1.1.3",
     "rollup-plugin-dts": "^4.2.0",
-    "rollup-plugin-esbuild": "^4.8.2",
+    "rollup-plugin-terser": "^7.0.2",
     "typescript": "^4.1.5",
     "whatwg-fetch": "^3.6.2"
   },
@@ -70,5 +64,6 @@
     "type": "git",
     "url": "https://github.com/liveblocks/liveblocks.git",
     "directory": "packages/liveblocks-react"
-  }
+  },
+  "sideEffects": false
 }

package/esm/index.js

@@ -1,212 +0,0 @@
-import * as React from 'react';
-import { useReducer } from 'react';
-import { LiveMap, LiveList, LiveObject } from '@liveblocks/client';
-
-const ClientContext = React.createContext(null);
-function LiveblocksProvider(props) {
-  return /* @__PURE__ */ React.createElement(ClientContext.Provider, {
-    value: props.client
-  }, props.children);
-}
-function useClient() {
-  const client = React.useContext(ClientContext);
-  if (client == null) {
-    throw new Error("LiveblocksProvider is missing from the react tree");
-  }
-  return client;
-}
-
-function useRerender() {
-  const [, update] = useReducer((x) => x + 1, 0);
-  return update;
-}
-
-const RoomContext = React.createContext(null);
-function RoomProvider(props) {
-  const { id: roomId, defaultPresence, defaultStorageRoot } = props;
-  if (process.env.NODE_ENV !== "production") {
-    if (roomId == null) {
-      throw new Error("RoomProvider id property is required. For more information: https://liveblocks.io/docs/errors/liveblocks-react/RoomProvider-id-property-is-required");
-    }
-    if (typeof roomId !== "string") {
-      throw new Error("RoomProvider id property should be a string.");
-    }
-  }
-  const client = useClient();
-  const [room, setRoom] = React.useState(() => client.enter(roomId, {
-    defaultPresence: defaultPresence ? defaultPresence() : void 0,
-    defaultStorageRoot,
-    DO_NOT_USE_withoutConnecting: typeof window === "undefined"
-  }));
-  React.useEffect(() => {
-    setRoom(client.enter(roomId, {
-      defaultPresence: defaultPresence ? defaultPresence() : void 0,
-      defaultStorageRoot,
-      DO_NOT_USE_withoutConnecting: typeof window === "undefined"
-    }));
-    return () => {
-      client.leave(roomId);
-    };
-  }, [client, roomId]);
-  return /* @__PURE__ */ React.createElement(RoomContext.Provider, {
-    value: room
-  }, props.children);
-}
-function useRoom() {
-  const room = React.useContext(RoomContext);
-  if (room == null) {
-    throw new Error("RoomProvider is missing from the react tree");
-  }
-  return room;
-}
-function useMyPresence() {
-  const room = useRoom();
-  const presence = room.getPresence();
-  const rerender = useRerender();
-  React.useEffect(() => {
-    const unsubscribe = room.subscribe("my-presence", rerender);
-    return () => {
-      unsubscribe();
-    };
-  }, [room]);
-  const setPresence = React.useCallback((overrides, options) => room.updatePresence(overrides, options), [room]);
-  return [presence, setPresence];
-}
-function useUpdateMyPresence() {
-  const room = useRoom();
-  return React.useCallback((overrides, options) => {
-    room.updatePresence(overrides, options);
-  }, [room]);
-}
-function useOthers() {
-  const room = useRoom();
-  const rerender = useRerender();
-  React.useEffect(() => {
-    const unsubscribe = room.subscribe("others", rerender);
-    return () => {
-      unsubscribe();
-    };
-  }, [room]);
-  return room.getOthers();
-}
-function useBroadcastEvent() {
-  const room = useRoom();
-  return React.useCallback((event, options = { shouldQueueEventIfNotReady: false }) => {
-    room.broadcastEvent(event, options);
-  }, [room]);
-}
-function useErrorListener(callback) {
-  const room = useRoom();
-  const savedCallback = React.useRef(callback);
-  React.useEffect(() => {
-    savedCallback.current = callback;
-  });
-  React.useEffect(() => {
-    const listener = (e) => savedCallback.current(e);
-    const unsubscribe = room.subscribe("error", listener);
-    return () => {
-      unsubscribe();
-    };
-  }, [room]);
-}
-function useEventListener(callback) {
-  const room = useRoom();
-  const savedCallback = React.useRef(callback);
-  React.useEffect(() => {
-    savedCallback.current = callback;
-  });
-  React.useEffect(() => {
-    const listener = (e) => savedCallback.current(e);
-    const unsubscribe = room.subscribe("event", listener);
-    return () => {
-      unsubscribe();
-    };
-  }, [room]);
-}
-function useSelf() {
-  const room = useRoom();
-  const rerender = useRerender();
-  React.useEffect(() => {
-    const unsubscribePresence = room.subscribe("my-presence", rerender);
-    const unsubscribeConnection = room.subscribe("connection", rerender);
-    return () => {
-      unsubscribePresence();
-      unsubscribeConnection();
-    };
-  }, [room]);
-  return room.getSelf();
-}
-function useStorage() {
-  const room = useRoom();
-  const [root, setState] = React.useState(null);
-  React.useEffect(() => {
-    let didCancel = false;
-    async function fetchStorage() {
-      const storage = await room.getStorage();
-      if (!didCancel) {
-        setState(storage.root);
-      }
-    }
-    fetchStorage();
-    return () => {
-      didCancel = true;
-    };
-  }, [room]);
-  return [root];
-}
-function useMap(key, entries) {
-  return useCrdt(key, new LiveMap(entries));
-}
-function useList(key, items) {
-  return useCrdt(key, new LiveList(items));
-}
-function useObject(key, initialData) {
-  return useCrdt(key, new LiveObject(initialData));
-}
-function useUndo() {
-  return useRoom().history.undo;
-}
-function useRedo() {
-  return useRoom().history.redo;
-}
-function useBatch() {
-  return useRoom().batch;
-}
-function useHistory() {
-  return useRoom().history;
-}
-function useCrdt(key, initialCrdt) {
-  var _a;
-  const room = useRoom();
-  const [root] = useStorage();
-  const rerender = useRerender();
-  React.useEffect(() => {
-    if (root == null) {
-      return;
-    }
-    let crdt = root.get(key);
-    if (crdt == null) {
-      crdt = initialCrdt;
-      root.set(key, crdt);
-    }
-    function onRootChange() {
-      const newCrdt = root.get(key);
-      if (newCrdt !== crdt) {
-        unsubscribeCrdt();
-        crdt = newCrdt;
-        unsubscribeCrdt = room.subscribe(crdt, rerender);
-        rerender();
-      }
-    }
-    let unsubscribeCrdt = room.subscribe(crdt, rerender);
-    const unsubscribeRoot = room.subscribe(root, onRootChange);
-    rerender();
-    return () => {
-      unsubscribeRoot();
-      unsubscribeCrdt();
-    };
-  }, [root, room]);
-  return (_a = root == null ? void 0 : root.get(key)) != null ? _a : null;
-}
-
-export { LiveblocksProvider, RoomProvider, useBatch, useBroadcastEvent, useClient, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };