@liveblocks/react 0.9.0 → 0.12.0-beta.10

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { Client, RecordData, Others, Presence, Record, InitialStorageFactory, Room, User } from "@liveblocks/client";
+import { Client, Others, Presence, LiveObject, LiveMap, User, LiveList } from "@liveblocks/client";
 import * as React from "react";
 declare type LiveblocksProviderProps = {
     children: React.ReactNode;
@@ -8,7 +8,7 @@ declare type LiveblocksProviderProps = {
  * Makes the Liveblocks client available in the component hierarchy below.
  */
 export declare function LiveblocksProvider(props: LiveblocksProviderProps): JSX.Element;
-declare type RoomProviderProps = {
+declare type RoomProviderProps<TStorageRoot> = {
     /**
      * The id of the room you want to connect to
      */
@@ -18,6 +18,7 @@ declare type RoomProviderProps = {
      * If ommited, the default presence will be an empty object
      */
     defaultPresence?: () => Presence;
+    defaultStorageRoot?: TStorageRoot;
     children: React.ReactNode;
 };
 /**
@@ -25,14 +26,13 @@ declare type RoomProviderProps = {
  * 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.
  */
-export declare function RoomProvider({ id, children, defaultPresence, }: RoomProviderProps): JSX.Element;
+export declare function RoomProvider<TStorageRoot>({ id, children, defaultPresence, defaultStorageRoot, }: RoomProviderProps<TStorageRoot>): JSX.Element;
 /**
  * Returns the presence of the current user of the current room, and a function to update it.
  * It is different from the setState function returned by the useState hook from React.
  * You don't need to pass the full presence object to update it.
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useMyPresence } from "@liveblocks/react";
  *
  * const [myPresence, updateMyPresence] = useMyPresence();
@@ -40,7 +40,6 @@ export declare function RoomProvider({ id, children, defaultPresence, }: RoomPro
  * updateMyPresence({ y: 0 });
  *
  * // At the next render, "myPresence" will be equal to "{ x: 0, y: 0 }"
- * ```
  */
 export declare function useMyPresence<T extends Presence>(): [
     T,
@@ -50,8 +49,7 @@ export declare function useMyPresence<T extends Presence>(): [
  * useUpdateMyPresence is similar to useMyPresence but it only returns the function to update the current user presence.
  * If you don't use the current user presence in your component, but you need to update it (e.g. live cursor), it's better to use useUpdateMyPresence to avoid unnecessary renders.
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useUpdateMyPresence } from "@liveblocks/react";
  *
  * const updateMyPresence = useUpdateMyPresence();
@@ -59,14 +57,12 @@ export declare function useMyPresence<T extends Presence>(): [
  * updateMyPresence({ y: 0 });
  *
  * // At the next render, the presence of the current user will be equal to "{ x: 0, y: 0 }"
- * ```
  */
 export declare function useUpdateMyPresence<T extends Presence>(): (overrides: Partial<T>) => void;
 /**
  * Returns an object that lets you get information about all the the users currently connected in the room.
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useOthers } from "@liveblocks/react";
  *
  * const others = useOthers();
@@ -80,40 +76,34 @@ export declare function useUpdateMyPresence<T extends Presence>(): (overrides: P
  *     return <Cursor key={connectionId} cursor={presence.cursor} />
  *   })
  * }
- * ```
  */
 export declare function useOthers<T extends Presence>(): Others<T>;
 /**
  * Returns a callback that lets you broadcast custom events to other users in the room
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useBroadcastEvent } from "@liveblocks/react";
  *
  * const broadcast = useBroadcastEvent();
  *
  * broadcast({ type: "CUSTOM_EVENT", data: { x: 0, y: 0 } });
- * ```
  */
 export declare function useBroadcastEvent(): (event: any) => void;
 /**
  * useErrorListener is a react hook that lets you react to potential room connection errors.
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useErrorListener } from "@liveblocks/react";
  *
  * useErrorListener(er => {
  *   console.error(er);
  * })
- * ```
  */
 export declare function useErrorListener(callback: (er: Error) => void): void;
 /**
  * useEventListener is a react hook that lets you react to event broadcasted by other users in the room.
  *
- * ### Example
- * ``` typescript
+ * @example
  * import { useEventListener } from "@liveblocks/react";
  *
  * useEventListener(({ connectionId, event }) => {
@@ -121,33 +111,24 @@ export declare function useErrorListener(callback: (er: Error) => void): void;
  *     // Do something
  *   }
  * });
- * ```
  */
 export declare function useEventListener<TEvent>(callback: ({ connectionId, event, }: {
     connectionId: number;
     event: TEvent;
 }) => void): void;
 /**
- * useCurrentUser is a react hook that lets you react to get the current user once it is connected to the room.
+ * Gets the current user once it is connected to the room.
  *
- * ### Example
- * ``` typescript
- * import { useCurrentUser } from "@liveblocks/react";
+ * @example
+ * import { useSelf } from "@liveblocks/react";
  *
- * const user = useCurrentUser();
- * ```
+ * const user = useSelf();
  */
-export declare function useCurrentUser<TPresence extends Presence = Presence>(): User<TPresence> | null;
-declare type StorageActions = {
-    createRecord: Room["createRecord"];
-    updateRecord: Room["updateRecord"];
-    createList: Room["createList"];
-    moveItem: Room["moveItem"];
-    deleteItem: Room["deleteItem"];
-    deleteItemById: Room["deleteItemById"];
-    pushItem: Room["pushItem"];
-};
-export declare function useStorage<TRoot extends RecordData>(initialStorage: InitialStorageFactory<TRoot>): [root: Record<TRoot> | null, actions: StorageActions];
-export declare function useStorageActions(): StorageActions;
-export { createClient } from "@liveblocks/client";
-export type { Record, Client, List } from "@liveblocks/client";
+export declare function useSelf<TPresence extends Presence = Presence>(): User<TPresence> | null;
+export declare function useStorage<TRoot extends Record<string, any>>(): [
+    root: LiveObject<TRoot> | null
+];
+export declare function useMap<TKey extends string, TValue>(key: string): LiveMap<TKey, TValue> | null;
+export declare function useList<TValue>(key: string): LiveList<TValue> | null;
+export declare function useObject<TData>(key: string): LiveObject<TData> | null;
+export {};