@liveblocks/react 0.15.5 → 0.15.7

package/lib/index.d.ts

@@ -1,206 +1,208 @@
-import { Client, Others, Presence, LiveObject, LiveMap, Room, User, LiveList, BroadcastOptions } from "@liveblocks/client";
-import * as React from "react";
-declare type LiveblocksProviderProps = {
-    children: React.ReactNode;
-    client: Client;
-};
-/**
- * Makes the Liveblocks client available in the component hierarchy below.
- */
-export declare function LiveblocksProvider(props: LiveblocksProviderProps): JSX.Element;
-declare type RoomProviderProps<TStorageRoot> = {
-    /**
-     * The id of the room you want to connect to
-     */
-    id: string;
-    /**
-     * A callback that let you initialize the default presence when entering the room.
-     * If ommited, the default presence will be an empty object
-     */
-    defaultPresence?: () => Presence;
-    defaultStorageRoot?: TStorageRoot;
-    children: React.ReactNode;
-};
-/**
- * Makes a Room available in the component hierarchy below.
- * 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<TStorageRoot>({ id, children, defaultPresence, defaultStorageRoot, }: RoomProviderProps<TStorageRoot>): JSX.Element;
-/**
- * Returns the room of the nearest RoomProvider above in the react component tree
- */
-export declare function useRoom(): Room;
-/**
- * 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
- * import { useMyPresence } from "@liveblocks/react";
- *
- * const [myPresence, updateMyPresence] = useMyPresence();
- * updateMyPresence({ x: 0 });
- * updateMyPresence({ y: 0 });
- *
- * // At the next render, "myPresence" will be equal to "{ x: 0, y: 0 }"
- */
-export declare function useMyPresence<T extends Presence>(): [
-    T,
-    (overrides: Partial<T>, options?: {
-        addToHistory: boolean;
-    }) => void
-];
-/**
- * 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
- * import { useUpdateMyPresence } from "@liveblocks/react";
- *
- * const updateMyPresence = useUpdateMyPresence();
- * updateMyPresence({ x: 0 });
- * 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>, options?: {
-    addToHistory: boolean;
-}) => void;
-/**
- * Returns an object that lets you get information about all the the users currently connected in the room.
- *
- * @example
- * import { useOthers } from "@liveblocks/react";
- *
- * const others = useOthers();
- *
- * // Example to map all cursors in jsx
- * {
- *   others.map(({ connectionId, presence }) => {
- *     if(presence == null || presence.cursor == null) {
- *       return null;
- *     }
- *     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
- * import { useBroadcastEvent } from "@liveblocks/react";
- *
- * const broadcast = useBroadcastEvent();
- *
- * broadcast({ type: "CUSTOM_EVENT", data: { x: 0, y: 0 } });
- */
-export declare function useBroadcastEvent(): (event: any, options?: BroadcastOptions) => void;
-/**
- * useErrorListener is a react hook that lets you react to potential room connection errors.
- *
- * @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
- * import { useEventListener } from "@liveblocks/react";
- *
- * useEventListener(({ connectionId, event }) => {
- *   if (event.type === "CUSTOM_EVENT") {
- *     // Do something
- *   }
- * });
- */
-export declare function useEventListener<TEvent>(callback: ({ connectionId, event, }: {
-    connectionId: number;
-    event: TEvent;
-}) => void): void;
-/**
- * Gets the current user once it is connected to the room.
- *
- * @example
- * import { useSelf } from "@liveblocks/react";
- *
- * const user = useSelf();
- */
-export declare function useSelf<TPresence extends Presence = Presence>(): User<TPresence> | null;
-export declare function useStorage<TRoot extends Record<string, any>>(): [
-    root: LiveObject<TRoot> | null
-];
-/**
- * Returns the LiveMap associated with the provided key. If the LiveMap does not exist, a new empty LiveMap will be created.
- * The hook triggers 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
- * @param entries Optional entries that are used to create the LiveMap for the first time
- * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
- *
- * @example
- * const emptyMap = useMap("mapA");
- * const mapWithItems = useMap("mapB", [["keyA", "valueA"], ["keyB", "valueB"]]);
- */
-export declare function useMap<TKey extends string, TValue>(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.
- *
- * @param key The storage key associated with the LiveList
- * @param items Optional items that are used to create the LiveList for the first time
- * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
- *
- * @example
- * const emptyList = useList("listA");
- * const listWithItems = useList("listB", ["a", "b", "c"]);
- */
-export declare function useList<TValue>(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.
- *
- * @param key The storage key associated with the LiveObject
- * @param initialData Optional data that is used to create the LiveObject for the first time
- * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
- *
- * @example
- * const object = useObject("obj", {
- *   company: "Liveblocks",
- *   website: "https://liveblocks.io"
- * });
- */
-export declare function useObject<TData>(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.
- */
-export declare function useUndo(): () => void;
-/**
- * Returns a function that redoes the last operation executed by the current client.
- * It does not impact operations made by other clients.
- */
-export declare function useRedo(): () => void;
-/**
- * Returns a function that batches modifications made during the given function.
- * All the modifications are sent to other clients in a single message.
- * All the modifications are merged in a single history item (undo/redo).
- * All the subscribers are called only after the batch is over.
- */
-export declare function useBatch(): (fn: () => void) => void;
-/**
- * Returns the room.history
- */
-export declare function useHistory(): {
-    undo: () => void;
-    redo: () => void;
-    pause: () => void;
-    resume: () => void;
-};
-export {};
+import { Room, Presence, Others, BroadcastOptions, User, LiveObject, LiveMap, LiveList, Client } from '@liveblocks/client';
+import * as React from 'react';
+
+declare type LiveblocksProviderProps = {
+    children: React.ReactNode;
+    client: Client;
+};
+/**
+ * Makes the Liveblocks client available in the component hierarchy below.
+ */
+declare function LiveblocksProvider(props: LiveblocksProviderProps): JSX.Element;
+declare type RoomProviderProps<TStorageRoot> = {
+    /**
+     * The id of the room you want to connect to
+     */
+    id: string;
+    /**
+     * A callback that let you initialize the default presence when entering the room.
+     * If ommited, the default presence will be an empty object
+     */
+    defaultPresence?: () => Presence;
+    defaultStorageRoot?: TStorageRoot;
+    children: React.ReactNode;
+};
+/**
+ * Makes a Room available in the component hierarchy below.
+ * 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;
+/**
+ * Returns the room of the nearest RoomProvider above in the react component tree
+ */
+declare function useRoom(): Room;
+/**
+ * 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
+ * import { useMyPresence } from "@liveblocks/react";
+ *
+ * const [myPresence, updateMyPresence] = useMyPresence();
+ * updateMyPresence({ x: 0 });
+ * updateMyPresence({ y: 0 });
+ *
+ * // At the next render, "myPresence" will be equal to "{ x: 0, y: 0 }"
+ */
+declare function useMyPresence<T extends Presence>(): [
+    T,
+    (overrides: Partial<T>, options?: {
+        addToHistory: boolean;
+    }) => void
+];
+/**
+ * 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
+ * import { useUpdateMyPresence } from "@liveblocks/react";
+ *
+ * const updateMyPresence = useUpdateMyPresence();
+ * updateMyPresence({ x: 0 });
+ * updateMyPresence({ y: 0 });
+ *
+ * // At the next render, the presence of the current user will be equal to "{ x: 0, y: 0 }"
+ */
+declare function useUpdateMyPresence<T extends Presence>(): (overrides: Partial<T>, options?: {
+    addToHistory: boolean;
+}) => void;
+/**
+ * Returns an object that lets you get information about all the the users currently connected in the room.
+ *
+ * @example
+ * import { useOthers } from "@liveblocks/react";
+ *
+ * const others = useOthers();
+ *
+ * // Example to map all cursors in jsx
+ * {
+ *   others.map(({ connectionId, presence }) => {
+ *     if(presence == null || presence.cursor == null) {
+ *       return null;
+ *     }
+ *     return <Cursor key={connectionId} cursor={presence.cursor} />
+ *   })
+ * }
+ */
+declare function useOthers<T extends Presence>(): Others<T>;
+/**
+ * Returns a callback that lets you broadcast custom events to other users in the room
+ *
+ * @example
+ * import { useBroadcastEvent } from "@liveblocks/react";
+ *
+ * const broadcast = useBroadcastEvent();
+ *
+ * broadcast({ type: "CUSTOM_EVENT", data: { x: 0, y: 0 } });
+ */
+declare function useBroadcastEvent(): (event: any, options?: BroadcastOptions) => void;
+/**
+ * useErrorListener is a react hook that lets you react to potential room connection errors.
+ *
+ * @example
+ * import { useErrorListener } from "@liveblocks/react";
+ *
+ * useErrorListener(er => {
+ *   console.error(er);
+ * })
+ */
+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
+ * import { useEventListener } from "@liveblocks/react";
+ *
+ * useEventListener(({ connectionId, event }) => {
+ *   if (event.type === "CUSTOM_EVENT") {
+ *     // Do something
+ *   }
+ * });
+ */
+declare function useEventListener<TEvent>(callback: ({ connectionId, event, }: {
+    connectionId: number;
+    event: TEvent;
+}) => void): void;
+/**
+ * Gets the current user once it is connected to the room.
+ *
+ * @example
+ * import { useSelf } from "@liveblocks/react";
+ *
+ * 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
+];
+/**
+ * Returns the LiveMap associated with the provided key. If the LiveMap does not exist, a new empty LiveMap will be created.
+ * The hook triggers 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
+ * @param entries Optional entries that are used to create the LiveMap for the first time
+ * @returns null while the storage is loading, otherwise, returns the LiveMap associated to the storage
+ *
+ * @example
+ * 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;
+/**
+ * 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.
+ *
+ * @param key The storage key associated with the LiveList
+ * @param items Optional items that are used to create the LiveList for the first time
+ * @returns null while the storage is loading, otherwise, returns the LiveList associated to the storage
+ *
+ * @example
+ * const emptyList = useList("listA");
+ * const listWithItems = useList("listB", ["a", "b", "c"]);
+ */
+declare function useList<TValue>(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.
+ *
+ * @param key The storage key associated with the LiveObject
+ * @param initialData Optional data that is used to create the LiveObject for the first time
+ * @returns null while the storage is loading, otherwise, returns the LveObject associated to the storage
+ *
+ * @example
+ * const object = useObject("obj", {
+ *   company: "Liveblocks",
+ *   website: "https://liveblocks.io"
+ * });
+ */
+declare function useObject<TData>(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.
+ */
+declare function useUndo(): () => void;
+/**
+ * Returns a function that redoes the last operation executed by the current client.
+ * It does not impact operations made by other clients.
+ */
+declare function useRedo(): () => void;
+/**
+ * Returns a function that batches modifications made during the given function.
+ * All the modifications are sent to other clients in a single message.
+ * 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;
+/**
+ * Returns the room.history
+ */
+declare function useHistory(): {
+    undo: () => void;
+    redo: () => void;
+    pause: () => void;
+    resume: () => void;
+};
+
+export { LiveblocksProvider, RoomProvider, useBatch, useBroadcastEvent, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };