@liveblocks/react 1.12.0-test1 → 1.12.0-test2

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, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, LiveblocksError, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
+import { BaseMetadata, QueryMetadata, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, LiveblocksError, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
 
 declare type Props = {
     fallback: NonNullable<ReactNode> | null;
@@ -37,7 +37,7 @@ declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = {
          * The metadata to filter the threads by. If provided, only threads with metadata that matches
          * the provided metadata will be returned. If not provided, all threads will be returned.
          */
-        metadata?: Partial<TThreadMetadata>;
+        metadata?: Partial<QueryMetadata<TThreadMetadata>>;
     };
     /**
      * Whether to scroll to a comment on load based on the URL hash. Defaults to `true`.
@@ -952,7 +952,7 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
 /**
  * Properties that are the same in LiveblocksContext and LiveblocksContext["suspense"].
  */
-declare type LiveblocksContextBundleCommon = {
+declare type LiveblocksContextBundleCommon<TThreadMetadata extends BaseMetadata> = {
     /**
      * @beta
      *
@@ -980,6 +980,15 @@ declare type LiveblocksContextBundleCommon = {
      * markAllInboxNotificationsAsRead();
      */
     useMarkAllInboxNotificationsAsRead(): () => void;
+    /**
+     * @beta
+     *
+     * Returns the thread associated with a `"thread"` inbox notification.
+     *
+     * @example
+     * const thread = useInboxNotificationThread("in_xxx");
+     */
+    useInboxNotificationThread(inboxNotificationId: string): ThreadData<TThreadMetadata>;
 };
 /**
  * @private
@@ -989,15 +998,6 @@ declare type LiveblocksContextBundleCommon = {
  * will probably happen if you do.
  */
 declare type PrivateLiveblocksContextApi = {
-    /**
-     * @private
-     *
-     * Returns a thread from the cache.
-     *
-     * @example
-     * const thread = useThreadFromCache("th_xxx");
-     */
-    useThreadFromCache(threadId: string): ThreadData<BaseMetadata>;
     /**
      * @private
      *
@@ -1005,7 +1005,7 @@ declare type PrivateLiveblocksContextApi = {
      */
     useCurrentUserId(): string | null;
 };
-declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<LiveblocksContextBundleCommon & Omit<SharedContextBundle<TUserMeta>, "suspense"> & {
+declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta, TThreadMetadata extends BaseMetadata> = Resolve<LiveblocksContextBundleCommon<TThreadMetadata> & Omit<SharedContextBundle<TUserMeta>, "suspense"> & {
     /**
      * @beta
      *
@@ -1024,7 +1024,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
      * const { count, error, isLoading } = useUnreadInboxNotificationsCount();
      */
     useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountState;
-    suspense: Resolve<LiveblocksContextBundleCommon & SharedContextBundle<TUserMeta>["suspense"] & {
+    suspense: Resolve<LiveblocksContextBundleCommon<TThreadMetadata> & SharedContextBundle<TUserMeta>["suspense"] & {
         /**
          * @beta
          *
@@ -1060,8 +1060,8 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
  *
  * This is an internal API, use "createLiveblocksContext" instead.
  */
-declare function useLiveblocksContextBundle(): LiveblocksContextBundle<BaseUserMeta>;
-declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUserMeta, TThreadMetadata extends BaseMetadata$1 = never>(client: Client): LiveblocksContextBundle<TUserMeta>;
+declare function useLiveblocksContextBundle(): LiveblocksContextBundle<BaseUserMeta, BaseMetadata$1>;
+declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUserMeta, TThreadMetadata extends BaseMetadata$1 = never>(client: Client): LiveblocksContextBundle<TUserMeta, TThreadMetadata>;
 
 /**
  * @private
@@ -1092,6 +1092,6 @@ declare function createRoomContext<TPresence extends JsonObject, TStorage extend
  *
  * This is an internal API, use `createLiveblocksContext` or `createRoomContext` instead.
  */
-declare function useSharedContextBundle(): RoomContextBundle<_liveblocks_core.JsonObject, _liveblocks_core.LsonObject, BaseUserMeta$1, never, _liveblocks_core.BaseMetadata> | LiveblocksContextBundle<BaseUserMeta$1>;
+declare function useSharedContextBundle(): RoomContextBundle<_liveblocks_core.JsonObject, _liveblocks_core.LsonObject, BaseUserMeta$1, never, _liveblocks_core.BaseMetadata> | LiveblocksContextBundle<BaseUserMeta$1, _liveblocks_core.BaseMetadata>;
 
 export { ClientSideSuspense, type MutationContext, type UseThreadsOptions, createLiveblocksContext, createRoomContext, useLiveblocksContextBundle, useRoomContextBundle, useSharedContextBundle };

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, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, LiveblocksError, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
+import { BaseMetadata, QueryMetadata, Resolve, ToImmutable, kInternal, ThreadData, InboxNotificationData, LiveblocksError, RoomEventMessage, CommentData, RoomInfo, CommentBody, PartialNullable, RoomInitializers, ResolveUsersArgs, OptionalPromise, ResolveMentionSuggestionsArgs, BaseUserMeta as BaseUserMeta$1 } from '@liveblocks/core';
 
 declare type Props = {
     fallback: NonNullable<ReactNode> | null;
@@ -37,7 +37,7 @@ declare type UseThreadsOptions<TThreadMetadata extends BaseMetadata> = {
          * The metadata to filter the threads by. If provided, only threads with metadata that matches
          * the provided metadata will be returned. If not provided, all threads will be returned.
          */
-        metadata?: Partial<TThreadMetadata>;
+        metadata?: Partial<QueryMetadata<TThreadMetadata>>;
     };
     /**
      * Whether to scroll to a comment on load based on the URL hash. Defaults to `true`.
@@ -952,7 +952,7 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
 /**
  * Properties that are the same in LiveblocksContext and LiveblocksContext["suspense"].
  */
-declare type LiveblocksContextBundleCommon = {
+declare type LiveblocksContextBundleCommon<TThreadMetadata extends BaseMetadata> = {
     /**
      * @beta
      *
@@ -980,6 +980,15 @@ declare type LiveblocksContextBundleCommon = {
      * markAllInboxNotificationsAsRead();
      */
     useMarkAllInboxNotificationsAsRead(): () => void;
+    /**
+     * @beta
+     *
+     * Returns the thread associated with a `"thread"` inbox notification.
+     *
+     * @example
+     * const thread = useInboxNotificationThread("in_xxx");
+     */
+    useInboxNotificationThread(inboxNotificationId: string): ThreadData<TThreadMetadata>;
 };
 /**
  * @private
@@ -989,15 +998,6 @@ declare type LiveblocksContextBundleCommon = {
  * will probably happen if you do.
  */
 declare type PrivateLiveblocksContextApi = {
-    /**
-     * @private
-     *
-     * Returns a thread from the cache.
-     *
-     * @example
-     * const thread = useThreadFromCache("th_xxx");
-     */
-    useThreadFromCache(threadId: string): ThreadData<BaseMetadata>;
     /**
      * @private
      *
@@ -1005,7 +1005,7 @@ declare type PrivateLiveblocksContextApi = {
      */
     useCurrentUserId(): string | null;
 };
-declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<LiveblocksContextBundleCommon & Omit<SharedContextBundle<TUserMeta>, "suspense"> & {
+declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta, TThreadMetadata extends BaseMetadata> = Resolve<LiveblocksContextBundleCommon<TThreadMetadata> & Omit<SharedContextBundle<TUserMeta>, "suspense"> & {
     /**
      * @beta
      *
@@ -1024,7 +1024,7 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
      * const { count, error, isLoading } = useUnreadInboxNotificationsCount();
      */
     useUnreadInboxNotificationsCount(): UnreadInboxNotificationsCountState;
-    suspense: Resolve<LiveblocksContextBundleCommon & SharedContextBundle<TUserMeta>["suspense"] & {
+    suspense: Resolve<LiveblocksContextBundleCommon<TThreadMetadata> & SharedContextBundle<TUserMeta>["suspense"] & {
         /**
          * @beta
          *
@@ -1060,8 +1060,8 @@ declare type LiveblocksContextBundle<TUserMeta extends BaseUserMeta> = Resolve<L
  *
  * This is an internal API, use "createLiveblocksContext" instead.
  */
-declare function useLiveblocksContextBundle(): LiveblocksContextBundle<BaseUserMeta>;
-declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUserMeta, TThreadMetadata extends BaseMetadata$1 = never>(client: Client): LiveblocksContextBundle<TUserMeta>;
+declare function useLiveblocksContextBundle(): LiveblocksContextBundle<BaseUserMeta, BaseMetadata$1>;
+declare function createLiveblocksContext<TUserMeta extends BaseUserMeta = BaseUserMeta, TThreadMetadata extends BaseMetadata$1 = never>(client: Client): LiveblocksContextBundle<TUserMeta, TThreadMetadata>;
 
 /**
  * @private
@@ -1092,6 +1092,6 @@ declare function createRoomContext<TPresence extends JsonObject, TStorage extend
  *
  * This is an internal API, use `createLiveblocksContext` or `createRoomContext` instead.
  */
-declare function useSharedContextBundle(): RoomContextBundle<_liveblocks_core.JsonObject, _liveblocks_core.LsonObject, BaseUserMeta$1, never, _liveblocks_core.BaseMetadata> | LiveblocksContextBundle<BaseUserMeta$1>;
+declare function useSharedContextBundle(): RoomContextBundle<_liveblocks_core.JsonObject, _liveblocks_core.LsonObject, BaseUserMeta$1, never, _liveblocks_core.BaseMetadata> | LiveblocksContextBundle<BaseUserMeta$1, _liveblocks_core.BaseMetadata>;
 
 export { ClientSideSuspense, type MutationContext, type UseThreadsOptions, createLiveblocksContext, createRoomContext, useLiveblocksContextBundle, useRoomContextBundle, useSharedContextBundle };

package/dist/index.js

@@ -5,7 +5,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/react";
-var PKG_VERSION = "1.12.0-test1";
+var PKG_VERSION = "1.12.0-test2";
 var PKG_FORMAT = "cjs";
 
 // src/ClientSideSuspense.tsx
@@ -194,7 +194,14 @@ function selectedThreads(roomId, state, options) {
     if (!query)
       return true;
     for (const key in query.metadata) {
-      if (thread.metadata[key] !== query.metadata[key]) {
+      const metadataValue = thread.metadata[key];
+      const filterValue = query.metadata[key];
+      if (assertFilterIsStartsWithOperator(filterValue) && assertMetadataValueIsString(metadataValue)) {
+        if (metadataValue.startsWith(filterValue.startsWith)) {
+          return true;
+        }
+      }
+      if (metadataValue !== filterValue) {
         return false;
       }
     }
@@ -202,6 +209,16 @@ function selectedThreads(roomId, state, options) {
   });
   return threads.sort((a, b) => a.createdAt.getTime() - b.createdAt.getTime());
 }
+var assertFilterIsStartsWithOperator = (filter) => {
+  if (typeof filter === "object" && typeof filter.startsWith === "string") {
+    return true;
+  } else {
+    return false;
+  }
+};
+var assertMetadataValueIsString = (value) => {
+  return typeof value === "string";
+};
 
 // src/lib/use-initial.ts
 
@@ -2270,18 +2287,29 @@ function createLiveblocksContext(client) {
       );
     }, []);
   }
-  function useThreadFromCache(threadId) {
+  function useInboxNotificationThread(inboxNotificationId) {
     const selector = _react.useCallback.call(void 0, 
       (state) => {
-        const thread = state.threads[threadId];
+        const inboxNotification = state.inboxNotifications[inboxNotificationId];
+        if (inboxNotification === void 0) {
+          throw new Error(
+            `Inbox notification with ID "${inboxNotificationId}" not found`
+          );
+        }
+        if (inboxNotification.kind !== "thread") {
+          throw new Error(
+            `Inbox notification with ID "${inboxNotificationId}" is not of kind "thread"`
+          );
+        }
+        const thread = state.threads[inboxNotification.threadId];
         if (thread === void 0) {
           throw new Error(
-            `Internal error: thread with id "${threadId}" not found in cache`
+            `Thread with ID "${inboxNotification.threadId}" not found, this inbox notification might not be of kind "thread"`
           );
         }
         return thread;
       },
-      [threadId]
+      [inboxNotificationId]
     );
     return _withselectorjs.useSyncExternalStoreWithSelector.call(void 0, 
       store.subscribe,
@@ -2304,6 +2332,7 @@ function createLiveblocksContext(client) {
     useUnreadInboxNotificationsCount,
     useMarkInboxNotificationAsRead,
     useMarkAllInboxNotificationsAsRead,
+    useInboxNotificationThread,
     ...shared,
     suspense: {
       LiveblocksProvider,
@@ -2311,10 +2340,10 @@ function createLiveblocksContext(client) {
       useUnreadInboxNotificationsCount: useUnreadInboxNotificationsCountSuspense,
       useMarkInboxNotificationAsRead,
       useMarkAllInboxNotificationsAsRead,
+      useInboxNotificationThread,
       ...shared.suspense
     },
     [_core.kInternal]: {
-      useThreadFromCache,
       useCurrentUserId
     }
   };