@liveblocks/react 0.15.11 → 0.16.0

package/README.md

@@ -18,6 +18,8 @@
   </a>
 </p>
 
+A set of [React](https://reactjs.org/) hooks and providers to use [Liveblocks](https://liveblocks.io) declaratively.
+
 ## Installation
 
 ```

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-import { Room, Presence, Others, BroadcastOptions, User, LiveObject, LiveMap, LiveList, Client } from '@liveblocks/client';
+import { Room, Presence, Others, BroadcastOptions, Json, User, LiveObject, Lson, LiveMap, LiveList, LsonObject, History, Client } from '@liveblocks/client';
+export { Json, JsonObject } from '@liveblocks/client';
 import * as React from 'react';
 
 declare type LiveblocksProviderProps = {
@@ -108,7 +109,7 @@ declare function useBroadcastEvent(): (event: any, options?: BroadcastOptions) =
  *   console.error(er);
  * })
  */
-declare function useErrorListener(callback: (er: Error) => void): void;
+declare function useErrorListener(callback: (err: Error) => void): void;
 /**
  * useEventListener is a react hook that lets you react to event broadcasted by other users in the room.
  *
@@ -121,7 +122,7 @@ declare function useErrorListener(callback: (er: Error) => void): void;
  *   }
  * });
  */
-declare function useEventListener<TEvent>(callback: ({ connectionId, event, }: {
+declare function useEventListener<TEvent extends Json>(callback: ({ connectionId, event, }: {
     connectionId: number;
     event: TEvent;
 }) => void): void;
@@ -149,7 +150,7 @@ declare function useStorage<TRoot extends Record<string, any>>(): [
  * const emptyMap = useMap("mapA");
  * const mapWithItems = useMap("mapB", [["keyA", "valueA"], ["keyB", "valueB"]]);
  */
-declare function useMap<TKey extends string, TValue>(key: string, entries?: readonly (readonly [TKey, TValue])[] | null | undefined): LiveMap<TKey, TValue> | null;
+declare function useMap<TKey extends string, TValue extends Lson>(key: string, entries?: readonly (readonly [TKey, TValue])[] | null | undefined): LiveMap<TKey, TValue> | null;
 /**
  * Returns the LiveList associated with the provided key. If the LiveList does not exist, a new LiveList will be created.
  * The hook triggers a re-render if the LiveList is updated, however it does not triggers a re-render if a nested CRDT is updated.
@@ -162,7 +163,7 @@ declare function useMap<TKey extends string, TValue>(key: string, entries?: read
  * const emptyList = useList("listA");
  * const listWithItems = useList("listB", ["a", "b", "c"]);
  */
-declare function useList<TValue>(key: string, items?: TValue[] | undefined): LiveList<TValue> | null;
+declare function useList<TValue extends Lson>(key: string, items?: TValue[] | undefined): LiveList<TValue> | null;
 /**
  * Returns the LiveObject associated with the provided key. If the LiveObject does not exist, it will be created with the initialData parameter.
  * 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.
@@ -177,7 +178,7 @@ declare function useList<TValue>(key: string, items?: TValue[] | undefined): Liv
  *   website: "https://liveblocks.io"
  * });
  */
-declare function useObject<TData>(key: string, initialData?: TData): LiveObject<TData> | null;
+declare function useObject<TData extends LsonObject>(key: string, initialData?: TData): LiveObject<TData> | null;
 /**
  * Returns a function that undoes the last operation executed by the current client.
  * It does not impact operations made by other clients.
@@ -194,15 +195,10 @@ declare function useRedo(): () => void;
  * All the modifications are merged in a single history item (undo/redo).
  * All the subscribers are called only after the batch is over.
  */
-declare function useBatch(): (fn: () => void) => void;
+declare function useBatch(): (callback: () => void) => void;
 /**
  * Returns the room.history
  */
-declare function useHistory(): {
-    undo: () => void;
-    redo: () => void;
-    pause: () => void;
-    resume: () => void;
-};
+declare function useHistory(): History;
 
 export { LiveblocksProvider, RoomProvider, useBatch, useBroadcastEvent, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@liveblocks/react",
-  "version": "0.15.11",
-  "description": "",
+  "version": "0.16.0",
+  "description": "A set of React hooks and providers to use Liveblocks declaratively.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "files": [
@@ -33,7 +33,7 @@
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@liveblocks/client": "0.15.11",
+    "@liveblocks/client": "0.16.0",
     "react": "^16.14.0 || ^17 || ^18"
   },
   "devDependencies": {