@liveblocks/react 0.16.16 → 0.17.0-beta2

package/index.d.ts

@@ -1,62 +1,328 @@
 /// <reference types="react" />
-import { Client } from '@liveblocks/client';
-export { Json, JsonObject } from '@liveblocks/client';
-import * as React from 'react';
-import * as _liveblocks_client_shared from '@liveblocks/client/shared';
+import {
+  Client,
+  JsonObject,
+  LsonObject,
+  BaseUserMeta,
+  Json,
+  BroadcastOptions,
+  History,
+  Others,
+  Room,
+  User,
+  LiveObject,
+  Lson,
+  LiveList,
+  LiveMap,
+} from "@liveblocks/client";
+export { Json, JsonObject } from "@liveblocks/client";
+import * as React from "react";
+import { Resolve, RoomInitializers } from "@liveblocks/client/internal";
 
 declare type LiveblocksProviderProps = {
-    children: React.ReactNode;
-    client: Client;
+  children: React.ReactNode;
+  client: Client;
 };
 /**
  * Makes the Liveblocks client available in the component hierarchy below.
+ *
+ * @deprecated LiveblocksProvider is no longer needed in your component tree if
+ * you set up your Liveblocks context using `createRoomContext()`. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for
+ * details.
  */
-declare function LiveblocksProvider(props: LiveblocksProviderProps): JSX.Element;
+declare function LiveblocksProvider(
+  props: LiveblocksProviderProps
+): JSX.Element;
 /**
  * Returns the Client of the nearest LiveblocksProvider above in the React
  * component tree.
  */
 declare function useClient(): Client;
 
-declare const RoomProvider: <TStorage>(props: {
+declare type RoomProviderProps<
+  TPresence extends JsonObject,
+  TStorage extends LsonObject
+> = Resolve<
+  {
+    /**
+     * The id of the room you want to connect to
+     */
     id: string;
     children: React.ReactNode;
-    initialPresence?: Record<string, unknown> | ((roomId: string) => Record<string, unknown>) | undefined;
-    initialStorage?: TStorage | ((roomId: string) => TStorage) | undefined;
-    defaultPresence?: (() => Record<string, unknown>) | undefined;
-    defaultStorageRoot?: TStorage | undefined;
-}) => JSX.Element;
-declare const useRoom: () => _liveblocks_client_shared.R;
-declare const useMyPresence: <T extends Record<string, unknown>>() => [T, (overrides: Partial<T>, options?: {
-    addToHistory: boolean;
-} | undefined) => void];
-declare const useUpdateMyPresence: <T extends Record<string, unknown>>() => (overrides: Partial<T>, options?: {
-    addToHistory: boolean;
-} | undefined) => void;
-declare const useOthers: <T extends Record<string, unknown>>() => _liveblocks_client_shared.O<T>;
-declare const useBroadcastEvent: () => (event: any, options?: _liveblocks_client_shared.B | undefined) => void;
-declare const useErrorListener: (callback: (err: Error) => void) => void;
-declare const useEventListener: <TEvent extends _liveblocks_client_shared.J>(callback: ({ connectionId, event, }: {
-    connectionId: number;
-    event: TEvent;
-}) => void) => void;
-declare const useSelf: <TPresence extends Record<string, unknown> = Record<string, unknown>>() => _liveblocks_client_shared.U<TPresence> | null;
-declare const useStorage: <TStorage extends Record<string, any>>() => [root: _liveblocks_client_shared.L<TStorage> | null];
-declare const useMap: {
-    <TKey extends string, TValue extends _liveblocks_client_shared.e>(key: string): _liveblocks_client_shared.b<TKey, TValue> | null;
-    <TKey_1 extends string, TValue_1 extends _liveblocks_client_shared.e>(key: string, entries: readonly (readonly [TKey_1, TValue_1])[] | null): _liveblocks_client_shared.b<TKey_1, TValue_1> | null;
-};
-declare const useList: {
-    <TValue extends _liveblocks_client_shared.e>(key: string): _liveblocks_client_shared.c<TValue> | null;
-    <TValue_1 extends _liveblocks_client_shared.e>(key: string, items: TValue_1[]): _liveblocks_client_shared.c<TValue_1> | null;
+  } & RoomInitializers<TPresence, TStorage>
+>;
+declare function createRoomContext<
+  TPresence extends JsonObject,
+  TStorage extends LsonObject = LsonObject,
+  TUserMeta extends BaseUserMeta = BaseUserMeta,
+  TRoomEvent extends Json = never
+>(
+  client: Client
+): {
+  RoomProvider: (props: RoomProviderProps<TPresence, TStorage>) => JSX.Element;
+  useBatch: () => (callback: () => void) => void;
+  useBroadcastEvent: () => (
+    event: TRoomEvent,
+    options?: BroadcastOptions
+  ) => void;
+  useErrorListener: (callback: (err: Error) => void) => void;
+  useEventListener: (
+    callback: (eventData: { connectionId: number; event: TRoomEvent }) => void
+  ) => void;
+  useHistory: () => History;
+  useList: <TKey extends Extract<keyof TStorage, string>>(
+    key: TKey
+  ) => TStorage[TKey] | null;
+  useMap: <TKey_1 extends Extract<keyof TStorage, string>>(
+    key: TKey_1
+  ) => TStorage[TKey_1] | null;
+  useMyPresence: () => [
+    TPresence,
+    (
+      overrides: Partial<TPresence>,
+      options?: {
+        addToHistory: boolean;
+      }
+    ) => void
+  ];
+  useObject: <TKey_2 extends Extract<keyof TStorage, string>>(
+    key: TKey_2
+  ) => TStorage[TKey_2] | null;
+  useOthers: () => Others<TPresence, TUserMeta>;
+  useRedo: () => () => void;
+  useRoom: () => Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
+  useSelf: () => User<TPresence, TUserMeta> | null;
+  useStorage: () => [root: LiveObject<TStorage> | null];
+  useUndo: () => () => void;
+  useUpdateMyPresence: () => (
+    overrides: Partial<TPresence>,
+    options?: {
+      addToHistory: boolean;
+    }
+  ) => void;
+  deprecated_useList: {
+    <TValue extends Lson>(key: string): LiveList<TValue> | null;
+    <TValue_1 extends Lson>(
+      key: string,
+      items: TValue_1[]
+    ): LiveList<TValue_1> | null;
+  };
+  deprecated_useMap: {
+    <TKey_3 extends string, TValue_2 extends Lson>(key: string): LiveMap<
+      TKey_3,
+      TValue_2
+    > | null;
+    <TKey_4 extends string, TValue_3 extends Lson>(
+      key: string,
+      entries: readonly (readonly [TKey_4, TValue_3])[] | null
+    ): LiveMap<TKey_4, TValue_3> | null;
+  };
+  deprecated_useObject: {
+    <TData extends LsonObject>(key: string): LiveObject<TData> | null;
+    <TData_1 extends LsonObject>(
+      key: string,
+      initialData: TData_1
+    ): LiveObject<TData_1> | null;
+  };
 };
-declare const useObject: {
-    <TData extends _liveblocks_client_shared.f>(key: string): _liveblocks_client_shared.L<TData> | null;
-    <TData_1 extends _liveblocks_client_shared.f>(key: string, initialData: TData_1): _liveblocks_client_shared.L<TData_1> | null;
-};
-declare const useUndo: () => () => void;
-declare const useRedo: () => () => void;
-declare const useBatch: () => (callback: () => void) => void;
-declare const useHistory: () => _liveblocks_client_shared.H;
 
-export { LiveblocksProvider, RoomProvider, useBatch, useBroadcastEvent, useClient, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };
+/**
+ * NOTE:
+ * This file is AUTOGENERATED!
+ *
+ * Do not update it manually.
+ */
+
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `RoomProvider` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function RoomProvider<
+  TPresence extends JsonObject,
+  TStorage extends LsonObject
+>(props: RoomProviderProps<TPresence, TStorage>): JSX.Element;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useBatch` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useBatch(): (callback: () => void) => void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useBroadcastEvent` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useBroadcastEvent<TRoomEvent extends Json>(): (
+  event: TRoomEvent,
+  options?: BroadcastOptions
+) => void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useErrorListener` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useErrorListener(callback: (err: Error) => void): void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useEventListener` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useEventListener<TRoomEvent extends Json>(
+  callback: (eventData: { connectionId: number; event: TRoomEvent }) => void
+): void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useHistory` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useHistory(): History;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useMyPresence` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useMyPresence<TPresence extends JsonObject>(): [
+  TPresence,
+  (
+    overrides: Partial<TPresence>,
+    options?: {
+      addToHistory: boolean;
+    }
+  ) => void
+];
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useOthers` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useOthers<
+  TPresence extends JsonObject,
+  TUserMeta extends BaseUserMeta
+>(): Others<TPresence, TUserMeta>;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useRedo` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useRedo(): () => void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useRoom` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useRoom<
+  TPresence extends JsonObject,
+  TStorage extends LsonObject,
+  TUserMeta extends BaseUserMeta,
+  TRoomEvent extends Json
+>(): Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useSelf` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useSelf<
+  TPresence extends JsonObject,
+  TUserMeta extends BaseUserMeta
+>(): User<TPresence, TUserMeta> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useStorage` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useStorage<TStorage extends LsonObject>(): [
+  root: LiveObject<TStorage> | null
+];
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useUndo` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useUndo(): () => void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useUpdateMyPresence` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useUpdateMyPresence<TPresence extends JsonObject>(): (
+  overrides: Partial<TPresence>,
+  options?: {
+    addToHistory: boolean;
+  }
+) => void;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useList` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useList<TValue extends Lson>(
+  key: string
+): LiveList<TValue> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useList` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useList<TValue extends Lson>(
+  key: string,
+  items: TValue[]
+): LiveList<TValue> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useMap` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useMap<TKey extends string, TValue extends Lson>(
+  key: string
+): LiveMap<TKey, TValue> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useMap` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useMap<TKey extends string, TValue extends Lson>(
+  key: string,
+  entries: readonly (readonly [TKey, TValue])[] | null
+): LiveMap<TKey, TValue> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useObject` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useObject<TData extends LsonObject>(
+  key: string
+): LiveObject<TData> | null;
+/**
+ * @deprecated Please use `createRoomContext()` instead of importing
+ * `useObject` from `@liveblocks/react` directly. See
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
+ */
+declare function useObject<TData extends LsonObject>(
+  key: string,
+  initialData: TData
+): LiveObject<TData> | null;
+
+export {
+  LiveblocksProvider,
+  RoomProvider,
+  createRoomContext,
+  useBatch,
+  useBroadcastEvent,
+  useClient,
+  useErrorListener,
+  useEventListener,
+  useHistory,
+  useList,
+  useMap,
+  useMyPresence,
+  useObject,
+  useOthers,
+  useRedo,
+  useRoom,
+  useSelf,
+  useStorage,
+  useUndo,
+  useUpdateMyPresence,
+};