@liveblocks/react 1.3.4 → 1.3.6

package/dist/index.d.mts

@@ -438,7 +438,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      *
      * @example
      * const editThreadMetadata = useEditThreadMetadata();
-     * editThreadMetadata({ threadId: "th_xxx", metadata: {} } })
+     * editThreadMetadata({ threadId: "th_xxx", metadata: {} })
      */
     useEditThreadMetadata(): (options: EditThreadMetadataOptions<TThreadMetadata>) => void;
     /**
@@ -448,7 +448,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      *
      * @example
      * const createComment = useCreateComment();
-     * createComment({ threadId: "th_xxx", body: { {} } });
+     * createComment({ threadId: "th_xxx", body: {} });
      */
     useCreateComment(): (options: CreateCommentOptions) => CommentData;
     /**
@@ -549,11 +549,15 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
      * a re-render if the LiveList is updated, however it does not triggers
      * a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveList
-     * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
+     * @param key The top-level storage key associated with the LiveList
+     * @returns null while storage is still loading, otherwise, returns the LiveList instance at the storage key
      *
      * @example
-     * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]
+     * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]  // ❌ No longer recommended
+     * const animals = useStorage((root) => root.animals);                    // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useList`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useList<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     /**
@@ -562,22 +566,30 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
      * a re-render if the LiveMap is updated, however it does not triggers
      * a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveMap
-     * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
+     * @param key The top-level storage key associated with the LiveMap
+     * @returns null while storage is still loading, otherwise, returns the LiveMap instance at the storage key
      *
      * @example
-     * const shapesById = useMap("shapes");
+     * const shapesById = useMap("shapes");                   // ❌ No longer recommended
+     * const shapesById = useStorage((root) => root.shapes);  // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useMap`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useMap<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     /**
      * Returns the LiveObject associated with the provided key.
      * The hook triggers a re-render if the LiveObject is updated, however it does not triggers a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveObject
-     * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
+     * @param key The top-level storage key associated with the LiveObject
+     * @returns null while storage is still loading, otherwise, returns the LiveObject instance at the storage key
      *
      * @example
-     * const object = useObject("obj");
+     * const object = useObject("obj");                // ❌ No longer recommended
+     * const object = useStorage((root) => root.obj);  // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useObject`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useObject<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     suspense: Resolve<RoomContextBundleShared<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata> & {
@@ -656,11 +668,15 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
          * a re-render if the LiveList is updated, however it does not triggers
          * a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveList
-         * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
+         * @param key The top-level storage key associated with the LiveList
+         * @returns Returns the LiveList instance at the storage key
          *
          * @example
-         * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]
+         * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]  // ❌ No longer recommended
+         * const animals = useStorage((root) => root.animals);                    // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useList`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useList<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
         /**
@@ -669,22 +685,30 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
          * a re-render if the LiveMap is updated, however it does not triggers
          * a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveMap
-         * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
+         * @param key The top-level storage key associated with the LiveMap
+         * @returns Returns the LiveMap instance at the storage key
          *
          * @example
-         * const shapesById = useMap("shapes");
+         * const shapesById = useMap("shapes");                   // ❌ No longer recommended
+         * const shapesById = useStorage((root) => root.shapes);  // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useMap`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useMap<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
         /**
          * Returns the LiveObject associated with the provided key.
          * The hook triggers a re-render if the LiveObject is updated, however it does not triggers a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveObject
-         * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
+         * @param key The top-level storage key associated with the LiveObject
+         * @returns Returns the LiveObject instance at the storage key
          *
          * @example
-         * const object = useObject("obj");
+         * const object = useObject("obj");                // ❌ No longer recommended
+         * const object = useStorage((root) => root.obj);  // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useObject`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useObject<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
     }>;

package/dist/index.d.ts

@@ -438,7 +438,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      *
      * @example
      * const editThreadMetadata = useEditThreadMetadata();
-     * editThreadMetadata({ threadId: "th_xxx", metadata: {} } })
+     * editThreadMetadata({ threadId: "th_xxx", metadata: {} })
      */
     useEditThreadMetadata(): (options: EditThreadMetadataOptions<TThreadMetadata>) => void;
     /**
@@ -448,7 +448,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      *
      * @example
      * const createComment = useCreateComment();
-     * createComment({ threadId: "th_xxx", body: { {} } });
+     * createComment({ threadId: "th_xxx", body: {} });
      */
     useCreateComment(): (options: CreateCommentOptions) => CommentData;
     /**
@@ -549,11 +549,15 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
      * a re-render if the LiveList is updated, however it does not triggers
      * a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveList
-     * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
+     * @param key The top-level storage key associated with the LiveList
+     * @returns null while storage is still loading, otherwise, returns the LiveList instance at the storage key
      *
      * @example
-     * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]
+     * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]  // ❌ No longer recommended
+     * const animals = useStorage((root) => root.animals);                    // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useList`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useList<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     /**
@@ -562,22 +566,30 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
      * a re-render if the LiveMap is updated, however it does not triggers
      * a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveMap
-     * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
+     * @param key The top-level storage key associated with the LiveMap
+     * @returns null while storage is still loading, otherwise, returns the LiveMap instance at the storage key
      *
      * @example
-     * const shapesById = useMap("shapes");
+     * const shapesById = useMap("shapes");                   // ❌ No longer recommended
+     * const shapesById = useStorage((root) => root.shapes);  // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useMap`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useMap<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     /**
      * Returns the LiveObject associated with the provided key.
      * The hook triggers a re-render if the LiveObject is updated, however it does not triggers a re-render if a nested CRDT is updated.
      *
-     * @param key The storage key associated with the LiveObject
-     * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
+     * @param key The top-level storage key associated with the LiveObject
+     * @returns null while storage is still loading, otherwise, returns the LiveObject instance at the storage key
      *
      * @example
-     * const object = useObject("obj");
+     * const object = useObject("obj");                // ❌ No longer recommended
+     * const object = useStorage((root) => root.obj);  // ✅ Do this instead
+     *
+     * @deprecated We no longer recommend using `useObject`. Prefer `useStorage`
+     * for reading and `useMutation` for writing.
      */
     useObject<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey] | null;
     suspense: Resolve<RoomContextBundleShared<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata> & {
@@ -656,11 +668,15 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
          * a re-render if the LiveList is updated, however it does not triggers
          * a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveList
-         * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
+         * @param key The top-level storage key associated with the LiveList
+         * @returns Returns the LiveList instance at the storage key
          *
          * @example
-         * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]
+         * const animals = useList("animals");  // e.g. [] or ["🦁", "🐍", "🦍"]  // ❌ No longer recommended
+         * const animals = useStorage((root) => root.animals);                    // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useList`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useList<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
         /**
@@ -669,22 +685,30 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
          * a re-render if the LiveMap is updated, however it does not triggers
          * a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveMap
-         * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
+         * @param key The top-level storage key associated with the LiveMap
+         * @returns Returns the LiveMap instance at the storage key
          *
          * @example
-         * const shapesById = useMap("shapes");
+         * const shapesById = useMap("shapes");                   // ❌ No longer recommended
+         * const shapesById = useStorage((root) => root.shapes);  // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useMap`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useMap<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
         /**
          * Returns the LiveObject associated with the provided key.
          * The hook triggers a re-render if the LiveObject is updated, however it does not triggers a re-render if a nested CRDT is updated.
          *
-         * @param key The storage key associated with the LiveObject
-         * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
+         * @param key The top-level storage key associated with the LiveObject
+         * @returns Returns the LiveObject instance at the storage key
          *
          * @example
-         * const object = useObject("obj");
+         * const object = useObject("obj");                // ❌ No longer recommended
+         * const object = useStorage((root) => root.obj);  // ✅ Do this instead
+         *
+         * @deprecated We no longer recommend using `useObject`. Prefer `useStorage`
+         * for reading and `useMutation` for writing.
          */
         useObject<TKey extends Extract<keyof TStorage, string>>(key: TKey): TStorage[TKey];
     }>;