@liveblocks/react 1.10.0-beta1 → 1.10.0-beta3

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import { ReactElement, ReactNode, PropsWithChildren } from 'react';
 import { JsonObject, LsonObject, BaseUserMeta, LiveObject, User, Json, RoomNotificationSettings, Room, Status, BroadcastOptions, OthersEvent, LostConnectionEvent, History, BaseMetadata as BaseMetadata$1, Client } from '@liveblocks/client';
 export { Json, JsonObject, shallow } from '@liveblocks/client';
 import * as _liveblocks_core from '@liveblocks/core';
-import { BaseMetadata, GetThreadsOptions, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
+import { BaseMetadata, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
 
 declare type Props = {
     fallback: NonNullable<ReactNode> | null;
@@ -27,7 +27,11 @@ declare type Props = {
  */
 declare function ClientSideSuspense(props: Props): ReactElement;
 
-declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = GetThreadsOptions<TThreadMetadata>;
+declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = {
+    query?: {
+        metadata?: Partial<TThreadMetadata>;
+    };
+};
 
 declare type UserStateLoading = {
     isLoading: true;
@@ -1001,7 +1005,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
      * Returns the number of unread inbox notifications for the current user.
      *
      * @example
-     * const unreadCount = useUnreadInboxNotificationsCount();
+     * const { count, error, isLoading } = useUnreadInboxNotificationsCount();
      */
     useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountState;
     suspense: Resolve<LiveblocksContextBundleCommon & SharedContextBundle<TUserMeta>["suspense"] & {
@@ -1011,7 +1015,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
          * Returns the inbox notifications for the current user.
          *
          * @example
-         * const { inboxNotifications, error, isLoading } = useInboxNotifications();
+         * const { inboxNotifications } = useInboxNotifications();
          */
         useInboxNotifications(): InboxNotificationsStateSuccess;
         /**
@@ -1020,7 +1024,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
          * Returns the number of unread inbox notifications for the current user.
          *
          * @example
-         * const unreadCount = useUnreadInboxNotificationsCount();
+         * const { count } = useUnreadInboxNotificationsCount();
          */
         useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountStateSuccess;
     }>;
@@ -1049,7 +1053,23 @@ declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUs
  * This is an internal API, use `createRoomContext` instead.
  */
 declare function useRoomContextBundle(): RoomContextBundle<JsonObject, LsonObject, BaseUserMeta, never, BaseMetadata>;
-declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
+declare type Options<TUserMeta extends BaseUserMeta> = {
+    /**
+     * @deprecated Define 'resolveUsers' in 'createClient' from '@liveblocks/client' instead.
+     * Please refer to our Upgrade Guide to learn more, see https://liveblocks.io/docs/platform/upgrading/1.10.
+     *
+     * A function that returns user info from user IDs.
+     */
+    resolveUsers?: (args: ResolveUsersArgs) => OptionalPromise<(TUserMeta["info"] | undefined)[] | undefined>;
+    /**
+     * @deprecated Define 'resolveMentionSuggestions' in 'createClient' from '@liveblocks/client' instead.
+     * Please refer to our Upgrade Guide to learn more, see https://liveblocks.io/docs/platform/upgrading/1.10.
+     *
+     * A function that returns a list of user IDs matching a string.
+     */
+    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => OptionalPromise<string[]>;
+};
+declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client, options?: Options<TUserMeta>): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
 
 /**
  * @private

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { ReactElement, ReactNode, PropsWithChildren } from 'react';
 import { JsonObject, LsonObject, BaseUserMeta, LiveObject, User, Json, RoomNotificationSettings, Room, Status, BroadcastOptions, OthersEvent, LostConnectionEvent, History, BaseMetadata as BaseMetadata$1, Client } from '@liveblocks/client';
 export { Json, JsonObject, shallow } from '@liveblocks/client';
 import * as _liveblocks_core from '@liveblocks/core';
-import { BaseMetadata, GetThreadsOptions, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
+import { BaseMetadata, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
 
 declare type Props = {
     fallback: NonNullable<ReactNode> | null;
@@ -27,7 +27,11 @@ declare type Props = {
  */
 declare function ClientSideSuspense(props: Props): ReactElement;
 
-declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = GetThreadsOptions<TThreadMetadata>;
+declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = {
+    query?: {
+        metadata?: Partial<TThreadMetadata>;
+    };
+};
 
 declare type UserStateLoading = {
     isLoading: true;
@@ -1001,7 +1005,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
      * Returns the number of unread inbox notifications for the current user.
      *
      * @example
-     * const unreadCount = useUnreadInboxNotificationsCount();
+     * const { count, error, isLoading } = useUnreadInboxNotificationsCount();
      */
     useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountState;
     suspense: Resolve<LiveblocksContextBundleCommon & SharedContextBundle<TUserMeta>["suspense"] & {
@@ -1011,7 +1015,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
          * Returns the inbox notifications for the current user.
          *
          * @example
-         * const { inboxNotifications, error, isLoading } = useInboxNotifications();
+         * const { inboxNotifications } = useInboxNotifications();
          */
         useInboxNotifications(): InboxNotificationsStateSuccess;
         /**
@@ -1020,7 +1024,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
          * Returns the number of unread inbox notifications for the current user.
          *
          * @example
-         * const unreadCount = useUnreadInboxNotificationsCount();
+         * const { count } = useUnreadInboxNotificationsCount();
          */
         useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountStateSuccess;
     }>;
@@ -1049,7 +1053,23 @@ declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUs
  * This is an internal API, use `createRoomContext` instead.
  */
 declare function useRoomContextBundle(): RoomContextBundle<JsonObject, LsonObject, BaseUserMeta, never, BaseMetadata>;
-declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
+declare type Options<TUserMeta extends BaseUserMeta> = {
+    /**
+     * @deprecated Define 'resolveUsers' in 'createClient' from '@liveblocks/client' instead.
+     * Please refer to our Upgrade Guide to learn more, see https://liveblocks.io/docs/platform/upgrading/1.10.
+     *
+     * A function that returns user info from user IDs.
+     */
+    resolveUsers?: (args: ResolveUsersArgs) => OptionalPromise<(TUserMeta["info"] | undefined)[] | undefined>;
+    /**
+     * @deprecated Define 'resolveMentionSuggestions' in 'createClient' from '@liveblocks/client' instead.
+     * Please refer to our Upgrade Guide to learn more, see https://liveblocks.io/docs/platform/upgrading/1.10.
+     *
+     * A function that returns a list of user IDs matching a string.
+     */
+    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => OptionalPromise<string[]>;
+};
+declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client, options?: Options<TUserMeta>): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
 
 /**
  * @private