@liveblocks/react 0.16.3 → 0.16.4-beta1

package/esm/index.js

@@ -22,39 +22,35 @@ function useRerender() {
 }
 
 const RoomContext = React.createContext(null);
-function RoomProvider({
-  id,
-  children,
-  defaultPresence,
-  defaultStorageRoot
-}) {
+function RoomProvider(props) {
+  const { id: roomId, defaultPresence, defaultStorageRoot } = props;
   if (process.env.NODE_ENV !== "production") {
-    if (id == null) {
+    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 id !== "string") {
+    if (typeof roomId !== "string") {
       throw new Error("RoomProvider id property should be a string.");
     }
   }
   const client = useClient();
-  const [room, setRoom] = React.useState(() => client.enter(id, {
+  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(id, {
+    setRoom(client.enter(roomId, {
       defaultPresence: defaultPresence ? defaultPresence() : void 0,
       defaultStorageRoot,
       DO_NOT_USE_withoutConnecting: typeof window === "undefined"
     }));
     return () => {
-      client.leave(id);
+      client.leave(roomId);
     };
-  }, [client, id]);
+  }, [client, roomId]);
   return /* @__PURE__ */ React.createElement(RoomContext.Provider, {
     value: room
-  }, children);
+  }, props.children);
 }
 function useRoom() {
   const room = React.useContext(RoomContext);

package/esm/index.mjs

@@ -22,39 +22,35 @@ function useRerender() {
 }
 
 const RoomContext = React.createContext(null);
-function RoomProvider({
-  id,
-  children,
-  defaultPresence,
-  defaultStorageRoot
-}) {
+function RoomProvider(props) {
+  const { id: roomId, defaultPresence, defaultStorageRoot } = props;
   if (process.env.NODE_ENV !== "production") {
-    if (id == null) {
+    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 id !== "string") {
+    if (typeof roomId !== "string") {
       throw new Error("RoomProvider id property should be a string.");
     }
   }
   const client = useClient();
-  const [room, setRoom] = React.useState(() => client.enter(id, {
+  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(id, {
+    setRoom(client.enter(roomId, {
       defaultPresence: defaultPresence ? defaultPresence() : void 0,
       defaultStorageRoot,
       DO_NOT_USE_withoutConnecting: typeof window === "undefined"
     }));
     return () => {
-      client.leave(id);
+      client.leave(roomId);
     };
-  }, [client, id]);
+  }, [client, roomId]);
   return /* @__PURE__ */ React.createElement(RoomContext.Provider, {
     value: room
-  }, children);
+  }, props.children);
 }
 function useRoom() {
   const room = React.useContext(RoomContext);

package/index.d.ts

@@ -16,7 +16,7 @@ declare function LiveblocksProvider(props: LiveblocksProviderProps): JSX.Element
  */
 declare function useClient(): Client;
 
-declare type RoomProviderProps<TStorageRoot> = {
+declare type RoomProviderProps<TStorage> = {
     /**
      * The id of the room you want to connect to
      */
@@ -26,7 +26,7 @@ declare type RoomProviderProps<TStorageRoot> = {
      * If ommited, the default presence will be an empty object
      */
     defaultPresence?: () => Presence;
-    defaultStorageRoot?: TStorageRoot;
+    defaultStorageRoot?: TStorage;
     children: React.ReactNode;
 };
 /**
@@ -34,7 +34,7 @@ declare type RoomProviderProps<TStorageRoot> = {
  * When this component is unmounted, the current user leave the room.
  * That means that you can't have 2 RoomProvider with the same room id in your react tree.
  */
-declare function RoomProvider<TStorageRoot>({ id, children, defaultPresence, defaultStorageRoot, }: RoomProviderProps<TStorageRoot>): JSX.Element;
+declare function RoomProvider<TStorage>(props: RoomProviderProps<TStorage>): JSX.Element;
 /**
  * Returns the Room of the nearest RoomProvider above in the React component
  * tree.
@@ -142,8 +142,8 @@ declare function useEventListener<TEvent extends Json>(callback: ({ connectionId
  * const user = useSelf();
  */
 declare function useSelf<TPresence extends Presence = Presence>(): User<TPresence> | null;
-declare function useStorage<TRoot extends Record<string, any>>(): [
-    root: LiveObject<TRoot> | null
+declare function useStorage<TStorage extends Record<string, any>>(): [
+    root: LiveObject<TStorage> | null
 ];
 /**
  * Returns the LiveMap associated with the provided key. If the LiveMap does not exist, a new empty LiveMap will be created.

package/index.js

@@ -87,18 +87,17 @@ function useRerender() {
 }
 
 var RoomContext = React__namespace.createContext(null);
-function RoomProvider(_ref) {
-  var id = _ref.id,
-      children = _ref.children,
-      defaultPresence = _ref.defaultPresence,
-      defaultStorageRoot = _ref.defaultStorageRoot;
+function RoomProvider(props) {
+  var roomId = props.id,
+      defaultPresence = props.defaultPresence,
+      defaultStorageRoot = props.defaultStorageRoot;
 
   if (process.env.NODE_ENV !== "production") {
-    if (id == null) {
+    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 id !== "string") {
+    if (typeof roomId !== "string") {
       throw new Error("RoomProvider id property should be a string.");
     }
   }
@@ -106,7 +105,7 @@ function RoomProvider(_ref) {
   var client = useClient();
 
   var _React$useState = React__namespace.useState(function () {
-    return client.enter(id, {
+    return client.enter(roomId, {
       defaultPresence: defaultPresence ? defaultPresence() : undefined,
       defaultStorageRoot: defaultStorageRoot,
       DO_NOT_USE_withoutConnecting: typeof window === "undefined"
@@ -116,18 +115,18 @@ function RoomProvider(_ref) {
       setRoom = _React$useState[1];
 
   React__namespace.useEffect(function () {
-    setRoom(client.enter(id, {
+    setRoom(client.enter(roomId, {
       defaultPresence: defaultPresence ? defaultPresence() : undefined,
       defaultStorageRoot: defaultStorageRoot,
       DO_NOT_USE_withoutConnecting: typeof window === "undefined"
     }));
     return function () {
-      client.leave(id);
+      client.leave(roomId);
     };
-  }, [client, id]);
+  }, [client, roomId]);
   return React__namespace.createElement(RoomContext.Provider, {
     value: room
-  }, children);
+  }, props.children);
 }
 function useRoom() {
   var room = React__namespace.useContext(RoomContext);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/react",
-  "version": "0.16.3",
+  "version": "0.16.4-beta1",
   "description": "A set of React hooks and providers to use Liveblocks declaratively.",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -29,11 +29,13 @@
   "scripts": {
     "build": "rollup -c && cp ./package.json ./README.md ./lib",
     "start": "rollup -c -w",
-    "test": "jest --watch"
+    "lint": "eslint src/",
+    "test": "jest --watch",
+    "test-ci": "jest"
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@liveblocks/client": "0.16.3",
+    "@liveblocks/client": "0.16.4-beta1",
     "react": "^16.14.0 || ^17 || ^18"
   },
   "devDependencies": {