@liveblocks/react 3.16.0-flow3 → 3.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/_private.cjs +7 -13
- package/dist/_private.cjs.map +1 -1
- package/dist/_private.d.cts +3 -11
- package/dist/_private.d.ts +3 -11
- package/dist/_private.js +1 -7
- package/dist/_private.js.map +1 -1
- package/dist/{chunk-5YUDJVMF.js → chunk-A7EFQVZ3.js} +2 -2
- package/dist/{chunk-2VF57BZV.js → chunk-EEXHY3OA.js} +462 -39
- package/dist/chunk-EEXHY3OA.js.map +1 -0
- package/dist/{chunk-QEGVIJNN.cjs → chunk-HFTIBRCD.cjs} +497 -74
- package/dist/chunk-HFTIBRCD.cjs.map +1 -0
- package/dist/{chunk-HULSMHSU.cjs → chunk-VSO26OCO.cjs} +2 -2
- package/dist/{chunk-HULSMHSU.cjs.map → chunk-VSO26OCO.cjs.map} +1 -1
- package/dist/index.cjs +20 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +18 -2
- package/dist/index.js.map +1 -1
- package/dist/{room-BvPZu216.d.cts → room-kE9R5ats.d.cts} +249 -19
- package/dist/{room-BvPZu216.d.ts → room-kE9R5ats.d.ts} +249 -19
- package/dist/suspense.cjs +20 -4
- package/dist/suspense.cjs.map +1 -1
- package/dist/suspense.d.cts +1 -1
- package/dist/suspense.d.ts +1 -1
- package/dist/suspense.js +18 -2
- package/dist/suspense.js.map +1 -1
- package/package.json +3 -3
- package/dist/chunk-2VF57BZV.js.map +0 -1
- package/dist/chunk-QEGVIJNN.cjs.map +0 -1
- /package/dist/{chunk-5YUDJVMF.js.map → chunk-A7EFQVZ3.js.map} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { BaseUserMeta, Client, JsonObject, LsonObject, LiveObject, User, Json, RoomSubscriptionSettings, Room, Status, BroadcastOptions, OthersEvent, LostConnectionEvent, History, BaseMetadata as BaseMetadata$1, ClientOptions, ThreadData as ThreadData$1, CommentData as CommentData$1 } from '@liveblocks/client';
|
|
1
|
+
import { BaseUserMeta, Client, JsonObject, LsonObject, LiveObject, User, Json, RoomSubscriptionSettings, Room, Status, BroadcastOptions, OthersEvent, LostConnectionEvent, History, BaseMetadata as BaseMetadata$1, ClientOptions, FeedCreateMetadata as FeedCreateMetadata$1, FeedUpdateMetadata as FeedUpdateMetadata$1, ThreadData as ThreadData$1, CommentData as CommentData$1 } from '@liveblocks/client';
|
|
2
2
|
import * as _liveblocks_core from '@liveblocks/core';
|
|
3
|
-
import { OpaqueClient, OpaqueRoom, AiKnowledgeSource, AiOpaqueToolDefinition, Relax, AiAssistantContentPart, BaseMetadata, QueryMetadata, AsyncResult, DRI, AsyncSuccess, DGI, GroupData, Resolve, CommentBody, CommentAttachment, PartialUnless, Patchable, InboxNotificationData, NotificationSettings, ToImmutable, MessageId, PartialNotificationSettings, AiChatsQuery, AsyncLoading, AsyncError, ThreadData, SearchCommentsResult, HistoryVersion, AiChat, UrlMetadata, Client as Client$1, LiveblocksError, SyncStatus, RoomEventMessage, CommentData, AiUserMessage, WithRequired, AiChatMessage, WithNavigation, MutableSignal, ThreadDataWithDeleteInfo, ThreadDeleteInfo, SubscriptionKey, SubscriptionData, DerivedSignal, DefaultMap, CommentUserReaction, InboxNotificationDeleteInfo, SubscriptionDeleteInfo, RoomSubscriptionSettings as RoomSubscriptionSettings$1, ISignal, Permission, BaseUserMeta as BaseUserMeta$1, DistributiveOmit, DU, DTM, DCM, TextEditorType, IYjsProvider, MentionData, DP, DS, DE } from '@liveblocks/core';
|
|
3
|
+
import { OpaqueClient, OpaqueRoom, AiKnowledgeSource, AiOpaqueToolDefinition, Relax, AiAssistantContentPart, BaseMetadata, QueryMetadata, AsyncResult, DRI, AsyncSuccess, DGI, GroupData, Resolve, CommentBody, CommentAttachment, PartialUnless, Patchable, InboxNotificationData, NotificationSettings, ToImmutable, FeedCreateMetadata, FeedUpdateMetadata, MessageId, PartialNotificationSettings, AiChatsQuery, FeedFetchMetadataFilter, AsyncLoading, AsyncError, ThreadData, SearchCommentsResult, Feed, FeedMessage, HistoryVersion, AiChat, UrlMetadata, Client as Client$1, LiveblocksError, SyncStatus, RoomEventMessage, CommentData, AiUserMessage, WithRequired, AiChatMessage, WithNavigation, MutableSignal, ThreadDataWithDeleteInfo, ThreadDeleteInfo, SubscriptionKey, SubscriptionData, DerivedSignal, DefaultMap, CommentUserReaction, InboxNotificationDeleteInfo, SubscriptionDeleteInfo, RoomSubscriptionSettings as RoomSubscriptionSettings$1, ISignal, Permission, BaseUserMeta as BaseUserMeta$1, DistributiveOmit, DU, DTM, DCM, TextEditorType, IYjsProvider, MentionData, DP, DS, DE, DFM, DFMD } from '@liveblocks/core';
|
|
4
4
|
import { Context, ComponentType, PropsWithChildren, ReactNode } from 'react';
|
|
5
5
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
6
6
|
|
|
@@ -208,6 +208,40 @@ type UseInboxNotificationsOptions = {
|
|
|
208
208
|
*/
|
|
209
209
|
query?: InboxNotificationsQuery;
|
|
210
210
|
};
|
|
211
|
+
type UseFeedsOptions = {
|
|
212
|
+
/**
|
|
213
|
+
* Optional timestamp filter. Applied to the client-side cache for this hook’s
|
|
214
|
+
* options: only feeds whose `createdAt` or `updatedAt` is at or after this
|
|
215
|
+
* timestamp (ms) are included in `feeds`.
|
|
216
|
+
*/
|
|
217
|
+
since?: number;
|
|
218
|
+
/**
|
|
219
|
+
* Optional metadata filter (`Record<string, string>`). Applied to the
|
|
220
|
+
* client-side cache: only feeds whose metadata matches every key/value pair
|
|
221
|
+
* are included in `feeds`.
|
|
222
|
+
*/
|
|
223
|
+
metadata?: FeedFetchMetadataFilter;
|
|
224
|
+
/**
|
|
225
|
+
* Page size for each server request when loading or loading more feeds. This
|
|
226
|
+
* does **not** cap the length of `feeds`—use pagination (`fetchMore`,
|
|
227
|
+
* `hasFetchedAll`) until you have loaded every page. Different hooks with
|
|
228
|
+
* different `limit` values still share one cache per room; each hook’s
|
|
229
|
+
* `feeds` array is filtered and sorted independently.
|
|
230
|
+
*/
|
|
231
|
+
limit?: number;
|
|
232
|
+
};
|
|
233
|
+
type UseFeedMessagesOptions = {
|
|
234
|
+
/**
|
|
235
|
+
* Optional cursor for pagination.
|
|
236
|
+
*/
|
|
237
|
+
cursor?: string;
|
|
238
|
+
/**
|
|
239
|
+
* Page size for each server request when loading or loading more messages.
|
|
240
|
+
* Does **not** cap the length of `messages`—pagination loads additional pages
|
|
241
|
+
* until `hasFetchedAll` is true.
|
|
242
|
+
*/
|
|
243
|
+
limit?: number;
|
|
244
|
+
};
|
|
211
245
|
type UserAsyncResult<T> = AsyncResult<T, "user">;
|
|
212
246
|
type UserAsyncSuccess<T> = AsyncSuccess<T, "user">;
|
|
213
247
|
type RoomInfoAsyncResult = AsyncResult<DRI, "info">;
|
|
@@ -270,6 +304,10 @@ type ThreadsAsyncResult<TM extends BaseMetadata, CM extends BaseMetadata> = Page
|
|
|
270
304
|
type SearchCommentsAsyncResult = AsyncResult<Array<SearchCommentsResult>, "results">;
|
|
271
305
|
type InboxNotificationsAsyncSuccess = PagedAsyncSuccess<InboxNotificationData[], "inboxNotifications">;
|
|
272
306
|
type InboxNotificationsAsyncResult = PagedAsyncResult<InboxNotificationData[], "inboxNotifications">;
|
|
307
|
+
type FeedsAsyncSuccess<FM extends Json = Json> = PagedAsyncSuccess<Feed<FM>[], "feeds">;
|
|
308
|
+
type FeedsAsyncResult<FM extends Json = Json> = PagedAsyncResult<Feed<FM>[], "feeds">;
|
|
309
|
+
type FeedMessagesAsyncSuccess<FMD extends Json = Json> = PagedAsyncSuccess<FeedMessage<FMD>[], "messages">;
|
|
310
|
+
type FeedMessagesAsyncResult<FMD extends Json = Json> = PagedAsyncResult<FeedMessage<FMD>[], "messages">;
|
|
273
311
|
type UnreadInboxNotificationsCountAsyncSuccess = AsyncSuccess<number, "count">;
|
|
274
312
|
type UnreadInboxNotificationsCountAsyncResult = AsyncResult<number, "count">;
|
|
275
313
|
type NotificationSettingsAsyncResult = AsyncResult<NotificationSettings, "settings">;
|
|
@@ -504,13 +542,13 @@ type SharedContextBundle<U extends BaseUserMeta> = {
|
|
|
504
542
|
/**
|
|
505
543
|
* Properties that are the same in RoomContext and RoomContext["suspense"].
|
|
506
544
|
*/
|
|
507
|
-
type RoomContextBundleCommon<P extends JsonObject, S extends LsonObject, U extends BaseUserMeta, E extends Json, TM extends BaseMetadata, CM extends BaseMetadata> = {
|
|
545
|
+
type RoomContextBundleCommon<P extends JsonObject, S extends LsonObject, U extends BaseUserMeta, E extends Json, TM extends BaseMetadata, CM extends BaseMetadata, FM extends Json = Json, FMD extends Json = Json> = {
|
|
508
546
|
/**
|
|
509
547
|
* You normally don't need to directly interact with the RoomContext, but
|
|
510
548
|
* it can be necessary if you're building an advanced app where you need to
|
|
511
549
|
* set up a context bridge between two React renderers.
|
|
512
550
|
*/
|
|
513
|
-
RoomContext: Context<Room<P, S, U, E, TM, CM> | null>;
|
|
551
|
+
RoomContext: Context<Room<P, S, U, E, TM, CM, FM, FMD> | null>;
|
|
514
552
|
/**
|
|
515
553
|
* Makes a Room available in the component hierarchy below.
|
|
516
554
|
* Joins the room when the component is mounted, and automatically leaves
|
|
@@ -523,10 +561,10 @@ type RoomContextBundleCommon<P extends JsonObject, S extends LsonObject, U exten
|
|
|
523
561
|
*/
|
|
524
562
|
useRoom(options?: {
|
|
525
563
|
allowOutsideRoom: false;
|
|
526
|
-
}): Room<P, S, U, E, TM, CM>;
|
|
564
|
+
}): Room<P, S, U, E, TM, CM, FM, FMD>;
|
|
527
565
|
useRoom(options: {
|
|
528
566
|
allowOutsideRoom: boolean;
|
|
529
|
-
}): Room<P, S, U, E, TM, CM> | null;
|
|
567
|
+
}): Room<P, S, U, E, TM, CM, FM, FMD> | null;
|
|
530
568
|
/**
|
|
531
569
|
* Returns the current connection status for the Room, and triggers
|
|
532
570
|
* a re-render whenever it changes. Can be used to render a status badge.
|
|
@@ -924,7 +962,7 @@ type RoomContextBundleCommon<P extends JsonObject, S extends LsonObject, U exten
|
|
|
924
962
|
*/
|
|
925
963
|
useThreadSubscription(threadId: string): ThreadSubscription;
|
|
926
964
|
};
|
|
927
|
-
type RoomContextBundle<P extends JsonObject, S extends LsonObject, U extends BaseUserMeta, E extends Json, TM extends BaseMetadata, CM extends BaseMetadata> = Resolve<RoomContextBundleCommon<P, S, U, E, TM, CM> & SharedContextBundle<U>["classic"] & {
|
|
965
|
+
type RoomContextBundle<P extends JsonObject, S extends LsonObject, U extends BaseUserMeta, E extends Json, TM extends BaseMetadata, CM extends BaseMetadata, FM extends Json = Json, FMD extends Json = Json> = Resolve<RoomContextBundleCommon<P, S, U, E, TM, CM, FM, FMD> & SharedContextBundle<U>["classic"] & {
|
|
928
966
|
/**
|
|
929
967
|
* Extract arbitrary data from the Liveblocks Storage state, using an
|
|
930
968
|
* arbitrary selector function.
|
|
@@ -986,6 +1024,76 @@ type RoomContextBundle<P extends JsonObject, S extends LsonObject, U extends Bas
|
|
|
986
1024
|
* const { threads, error, isLoading } = useThreads();
|
|
987
1025
|
*/
|
|
988
1026
|
useThreads(options?: UseThreadsOptions<TM>): ThreadsAsyncResult<TM, CM>;
|
|
1027
|
+
/**
|
|
1028
|
+
* Returns feeds for the current room.
|
|
1029
|
+
*
|
|
1030
|
+
* @example
|
|
1031
|
+
* const { feeds, error, isLoading } = useFeeds();
|
|
1032
|
+
*/
|
|
1033
|
+
useFeeds(options?: UseFeedsOptions): FeedsAsyncResult<FM>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Returns messages for a specific feed in the current room.
|
|
1036
|
+
*
|
|
1037
|
+
* @example
|
|
1038
|
+
* const { messages, error, isLoading } = useFeedMessages("feed-id");
|
|
1039
|
+
*/
|
|
1040
|
+
useFeedMessages(feedId: string, options?: UseFeedMessagesOptions): FeedMessagesAsyncResult<FMD>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Returns a function that creates a new feed in the current room.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* const createFeed = useCreateFeed();
|
|
1046
|
+
* createFeed("feed-id", { metadata: { name: "My Feed" } });
|
|
1047
|
+
*/
|
|
1048
|
+
useCreateFeed(): (feedId: string, options?: {
|
|
1049
|
+
metadata?: FeedCreateMetadata;
|
|
1050
|
+
createdAt?: number;
|
|
1051
|
+
}) => Promise<void>;
|
|
1052
|
+
/**
|
|
1053
|
+
* Returns a function that deletes a feed from the current room.
|
|
1054
|
+
*
|
|
1055
|
+
* @example
|
|
1056
|
+
* const deleteFeed = useDeleteFeed();
|
|
1057
|
+
* deleteFeed("feed-id");
|
|
1058
|
+
*/
|
|
1059
|
+
useDeleteFeed(): (feedId: string) => Promise<void>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Returns a function that updates a feed's metadata in the current room.
|
|
1062
|
+
*
|
|
1063
|
+
* @example
|
|
1064
|
+
* const updateFeedMetadata = useUpdateFeedMetadata();
|
|
1065
|
+
* updateFeedMetadata("feed-id", { name: "Updated Name" });
|
|
1066
|
+
*/
|
|
1067
|
+
useUpdateFeedMetadata(): (feedId: string, metadata: FeedUpdateMetadata) => Promise<void>;
|
|
1068
|
+
/**
|
|
1069
|
+
* Returns a function that adds a message to a feed in the current room.
|
|
1070
|
+
*
|
|
1071
|
+
* @example
|
|
1072
|
+
* const createFeedMessage = useCreateFeedMessage();
|
|
1073
|
+
* createFeedMessage("feed-id", { text: "Hello" });
|
|
1074
|
+
*/
|
|
1075
|
+
useCreateFeedMessage(): (feedId: string, data: JsonObject, options?: {
|
|
1076
|
+
id?: string;
|
|
1077
|
+
createdAt?: number;
|
|
1078
|
+
}) => Promise<void>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Returns a function that deletes a message from a feed in the current room.
|
|
1081
|
+
*
|
|
1082
|
+
* @example
|
|
1083
|
+
* const deleteFeedMessage = useDeleteFeedMessage();
|
|
1084
|
+
* deleteFeedMessage("feed-id", "message-id");
|
|
1085
|
+
*/
|
|
1086
|
+
useDeleteFeedMessage(): (feedId: string, messageId: string) => Promise<void>;
|
|
1087
|
+
/**
|
|
1088
|
+
* Returns a function that updates a feed message in the current room.
|
|
1089
|
+
*
|
|
1090
|
+
* @example
|
|
1091
|
+
* const updateFeedMessage = useUpdateFeedMessage();
|
|
1092
|
+
* updateFeedMessage("feed-id", "message-id", { text: "Updated" });
|
|
1093
|
+
*/
|
|
1094
|
+
useUpdateFeedMessage(): (feedId: string, messageId: string, data: JsonObject, options?: {
|
|
1095
|
+
updatedAt?: number;
|
|
1096
|
+
}) => Promise<void>;
|
|
989
1097
|
/**
|
|
990
1098
|
* Returns the result of searching comments by text in the current room. The result includes the id and the plain text content of the matched comments along with the parent thread id of the comment.
|
|
991
1099
|
*
|
|
@@ -1025,7 +1133,7 @@ type RoomContextBundle<P extends JsonObject, S extends LsonObject, U extends Bas
|
|
|
1025
1133
|
* const { data, error, isLoading } = useHistoryVersionData(version.id);
|
|
1026
1134
|
*/
|
|
1027
1135
|
useHistoryVersionData(id: string): HistoryVersionDataAsyncResult;
|
|
1028
|
-
suspense: Resolve<RoomContextBundleCommon<P, S, U, E, TM, CM> & SharedContextBundle<U>["suspense"] & {
|
|
1136
|
+
suspense: Resolve<RoomContextBundleCommon<P, S, U, E, TM, CM, FM, FMD> & SharedContextBundle<U>["suspense"] & {
|
|
1029
1137
|
/**
|
|
1030
1138
|
* Extract arbitrary data from the Liveblocks Storage state, using an
|
|
1031
1139
|
* arbitrary selector function.
|
|
@@ -1081,6 +1189,34 @@ type RoomContextBundle<P extends JsonObject, S extends LsonObject, U extends Bas
|
|
|
1081
1189
|
* const { threads } = useThreads();
|
|
1082
1190
|
*/
|
|
1083
1191
|
useThreads(options?: UseThreadsOptions<TM>): ThreadsAsyncSuccess<TM, CM>;
|
|
1192
|
+
/**
|
|
1193
|
+
* Returns feeds for the current room.
|
|
1194
|
+
*
|
|
1195
|
+
* @example
|
|
1196
|
+
* const { feeds } = useFeeds();
|
|
1197
|
+
*/
|
|
1198
|
+
useFeeds(options?: UseFeedsOptions): FeedsAsyncSuccess<FM>;
|
|
1199
|
+
/**
|
|
1200
|
+
* Returns messages for a specific feed in the current room.
|
|
1201
|
+
*
|
|
1202
|
+
* @example
|
|
1203
|
+
* const { messages } = useFeedMessages("feed-id");
|
|
1204
|
+
*/
|
|
1205
|
+
useFeedMessages(feedId: string, options?: UseFeedMessagesOptions): FeedMessagesAsyncSuccess<FMD>;
|
|
1206
|
+
useCreateFeed(): (feedId: string, options?: {
|
|
1207
|
+
metadata?: FeedCreateMetadata;
|
|
1208
|
+
createdAt?: number;
|
|
1209
|
+
}) => Promise<void>;
|
|
1210
|
+
useDeleteFeed(): (feedId: string) => Promise<void>;
|
|
1211
|
+
useUpdateFeedMetadata(): (feedId: string, metadata: FeedUpdateMetadata) => Promise<void>;
|
|
1212
|
+
useCreateFeedMessage(): (feedId: string, data: JsonObject, options?: {
|
|
1213
|
+
id?: string;
|
|
1214
|
+
createdAt?: number;
|
|
1215
|
+
}) => Promise<void>;
|
|
1216
|
+
useDeleteFeedMessage(): (feedId: string, messageId: string) => Promise<void>;
|
|
1217
|
+
useUpdateFeedMessage(): (feedId: string, messageId: string, data: JsonObject, options?: {
|
|
1218
|
+
updatedAt?: number;
|
|
1219
|
+
}) => Promise<void>;
|
|
1084
1220
|
/**
|
|
1085
1221
|
* (Private beta) Returns a history of versions of the current room.
|
|
1086
1222
|
*
|
|
@@ -1788,6 +1924,8 @@ declare class UmbrellaStore<TM extends BaseMetadata, CM extends BaseMetadata> {
|
|
|
1788
1924
|
readonly messagesByChatId: DefaultMap<string, DefaultMap<MessageId | null, LoadableResource<AiChatMessagesAsyncResult>>>;
|
|
1789
1925
|
readonly aiChatById: DefaultMap<string, LoadableResource<AiChatAsyncResult>>;
|
|
1790
1926
|
readonly urlMetadataByUrl: DefaultMap<string, LoadableResource<UrlMetadataAsyncResult>>;
|
|
1927
|
+
readonly loadingFeeds: DefaultMap<string, LoadableResource<FeedsAsyncResult>>;
|
|
1928
|
+
readonly loadingFeedMessages: DefaultMap<string, LoadableResource<FeedMessagesAsyncResult>>;
|
|
1791
1929
|
};
|
|
1792
1930
|
constructor(client: OpaqueClient);
|
|
1793
1931
|
/**
|
|
@@ -1852,6 +1990,22 @@ declare class UmbrellaStore<TM extends BaseMetadata, CM extends BaseMetadata> {
|
|
|
1852
1990
|
*/
|
|
1853
1991
|
updateRoomSubscriptionSettings(roomId: string, optimisticId: string, settings: Readonly<RoomSubscriptionSettings$1>): void;
|
|
1854
1992
|
fetchNotificationsDeltaUpdate(signal: AbortSignal): Promise<void>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Upserts feeds in the cache (for list/added/updated operations).
|
|
1995
|
+
*/
|
|
1996
|
+
upsertFeeds(roomId: RoomId, feeds: readonly Feed[]): void;
|
|
1997
|
+
/**
|
|
1998
|
+
* Removes a feed from the cache (for deleted operations).
|
|
1999
|
+
*/
|
|
2000
|
+
deleteFeed(roomId: RoomId, feedId: string): void;
|
|
2001
|
+
/**
|
|
2002
|
+
* Upserts feed messages in the cache (for list/added/updated operations).
|
|
2003
|
+
*/
|
|
2004
|
+
upsertFeedMessages(_roomId: RoomId, feedId: string, messages: readonly FeedMessage[]): void;
|
|
2005
|
+
/**
|
|
2006
|
+
* Removes feed messages from the cache (for deleted operations).
|
|
2007
|
+
*/
|
|
2008
|
+
deleteFeedMessages(_roomId: RoomId, feedId: string, messageIds: readonly string[]): void;
|
|
1855
2009
|
fetchUnreadNotificationsCount(queryKey: InboxNotificationsQueryKey, signal: AbortSignal): Promise<void>;
|
|
1856
2010
|
fetchRoomThreadsDeltaUpdate(roomId: string, signal: AbortSignal): Promise<void>;
|
|
1857
2011
|
fetchUserThreadsDeltaUpdate(signal: AbortSignal): Promise<void>;
|
|
@@ -2319,6 +2473,62 @@ declare function useCanRedo(): boolean;
|
|
|
2319
2473
|
* // [2, 4, 7]
|
|
2320
2474
|
*/
|
|
2321
2475
|
declare function useOthersConnectionIds(): readonly number[];
|
|
2476
|
+
/**
|
|
2477
|
+
* Returns a function that creates a new feed in the current room.
|
|
2478
|
+
*
|
|
2479
|
+
* @example
|
|
2480
|
+
* const createFeed = useCreateFeed();
|
|
2481
|
+
* createFeed("feed-id", { metadata: { name: "My Feed" } });
|
|
2482
|
+
*/
|
|
2483
|
+
declare function useCreateFeed(): (feedId: string, options?: {
|
|
2484
|
+
metadata?: FeedCreateMetadata$1;
|
|
2485
|
+
createdAt?: number;
|
|
2486
|
+
}) => Promise<void>;
|
|
2487
|
+
/**
|
|
2488
|
+
* Returns a function that deletes a feed from the current room.
|
|
2489
|
+
*
|
|
2490
|
+
* @example
|
|
2491
|
+
* const deleteFeed = useDeleteFeed();
|
|
2492
|
+
* deleteFeed("feed-id");
|
|
2493
|
+
*/
|
|
2494
|
+
declare function useDeleteFeed(): (feedId: string) => Promise<void>;
|
|
2495
|
+
/**
|
|
2496
|
+
* Returns a function that updates a feed's metadata in the current room.
|
|
2497
|
+
*
|
|
2498
|
+
* @example
|
|
2499
|
+
* const updateFeedMetadata = useUpdateFeedMetadata();
|
|
2500
|
+
* updateFeedMetadata("feed-id", { name: "Updated Name" });
|
|
2501
|
+
*/
|
|
2502
|
+
declare function useUpdateFeedMetadata(): (feedId: string, metadata: FeedUpdateMetadata$1) => Promise<void>;
|
|
2503
|
+
/**
|
|
2504
|
+
* Returns a function that adds a message to a feed in the current room.
|
|
2505
|
+
*
|
|
2506
|
+
* @example
|
|
2507
|
+
* const createFeedMessage = useCreateFeedMessage();
|
|
2508
|
+
* createFeedMessage("feed-id", { text: "Hello" });
|
|
2509
|
+
*/
|
|
2510
|
+
declare function useCreateFeedMessage(): (feedId: string, data: JsonObject, options?: {
|
|
2511
|
+
id?: string;
|
|
2512
|
+
createdAt?: number;
|
|
2513
|
+
}) => Promise<void>;
|
|
2514
|
+
/**
|
|
2515
|
+
* Returns a function that deletes a message from a feed in the current room.
|
|
2516
|
+
*
|
|
2517
|
+
* @example
|
|
2518
|
+
* const deleteFeedMessage = useDeleteFeedMessage();
|
|
2519
|
+
* deleteFeedMessage("feed-id", "message-id");
|
|
2520
|
+
*/
|
|
2521
|
+
declare function useDeleteFeedMessage(): (feedId: string, messageId: string) => Promise<void>;
|
|
2522
|
+
/**
|
|
2523
|
+
* Returns a function that updates a feed message in the current room.
|
|
2524
|
+
*
|
|
2525
|
+
* @example
|
|
2526
|
+
* const updateFeedMessage = useUpdateFeedMessage();
|
|
2527
|
+
* updateFeedMessage("feed-id", "message-id", { text: "Updated" });
|
|
2528
|
+
*/
|
|
2529
|
+
declare function useUpdateFeedMessage(): (feedId: string, messageId: string, data: JsonObject, options?: {
|
|
2530
|
+
updatedAt?: number;
|
|
2531
|
+
}) => Promise<void>;
|
|
2322
2532
|
/**
|
|
2323
2533
|
* @private
|
|
2324
2534
|
*/
|
|
@@ -2442,10 +2652,6 @@ declare function useHistoryVersionData(versionId: string): HistoryVersionDataAsy
|
|
|
2442
2652
|
* updateRoomSubscriptionSettings({ threads: "all" });
|
|
2443
2653
|
*/
|
|
2444
2654
|
declare function useUpdateRoomSubscriptionSettings(): (settings: Partial<RoomSubscriptionSettings$1>) => void;
|
|
2445
|
-
/**
|
|
2446
|
-
* @private For internal use only. Do not rely on this hook.
|
|
2447
|
-
*/
|
|
2448
|
-
declare function useSuspendUntilPresenceReady(): void;
|
|
2449
2655
|
/**
|
|
2450
2656
|
* Returns an array of connection IDs. This matches the values you'll get by
|
|
2451
2657
|
* using the `useOthers()` hook.
|
|
@@ -2461,10 +2667,6 @@ declare function useSuspendUntilPresenceReady(): void;
|
|
|
2461
2667
|
* // [2, 4, 7]
|
|
2462
2668
|
*/
|
|
2463
2669
|
declare function useOthersConnectionIdsSuspense(): readonly number[];
|
|
2464
|
-
/**
|
|
2465
|
-
* @private For internal use only. Do not rely on this hook.
|
|
2466
|
-
*/
|
|
2467
|
-
declare function useSuspendUntilStorageReady(): void;
|
|
2468
2670
|
/**
|
|
2469
2671
|
* Returns a presigned URL for an attachment by its ID.
|
|
2470
2672
|
*
|
|
@@ -2496,8 +2698,8 @@ declare function useRoomPermissions(roomId: string): Set<_liveblocks_core.Permis
|
|
|
2496
2698
|
* that any RoomProvider created in this way does not need to be nested in
|
|
2497
2699
|
* LiveblocksProvider, as it already has access to the client.
|
|
2498
2700
|
*/
|
|
2499
|
-
declare function createRoomContext<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUserMeta = DU, E extends Json = DE, TM extends BaseMetadata$1 = DTM, CM extends BaseMetadata$1 = DCM>(client: OpaqueClient): RoomContextBundle<P, S, U, E, TM, CM>;
|
|
2500
|
-
type TypedBundle = RoomContextBundle<DP, DS, DU, DE, DTM, DCM>;
|
|
2701
|
+
declare function createRoomContext<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUserMeta = DU, E extends Json = DE, TM extends BaseMetadata$1 = DTM, CM extends BaseMetadata$1 = DCM, FM extends Json = Json, FMD extends Json = Json>(client: OpaqueClient): RoomContextBundle<P, S, U, E, TM, CM, FM, FMD>;
|
|
2702
|
+
type TypedBundle = RoomContextBundle<DP, DS, DU, DE, DTM, DCM, DFM, DFMD>;
|
|
2501
2703
|
/**
|
|
2502
2704
|
* Makes a Room available in the component hierarchy below.
|
|
2503
2705
|
* Joins the room when the component is mounted, and automatically leaves
|
|
@@ -2728,6 +2930,34 @@ declare const _useOthersMappedSuspense: TypedBundle["suspense"]["useOthersMapped
|
|
|
2728
2930
|
* const { threads, error, isLoading } = useThreads();
|
|
2729
2931
|
*/
|
|
2730
2932
|
declare const _useThreads: TypedBundle["useThreads"];
|
|
2933
|
+
/**
|
|
2934
|
+
* Returns feeds for the current room.
|
|
2935
|
+
*
|
|
2936
|
+
* @example
|
|
2937
|
+
* const { feeds, error, isLoading } = useFeeds();
|
|
2938
|
+
*/
|
|
2939
|
+
declare const _useFeeds: TypedBundle["useFeeds"];
|
|
2940
|
+
/**
|
|
2941
|
+
* Returns messages for a specific feed in the current room.
|
|
2942
|
+
*
|
|
2943
|
+
* @example
|
|
2944
|
+
* const { messages, error, isLoading } = useFeedMessages("feed-id");
|
|
2945
|
+
*/
|
|
2946
|
+
declare const _useFeedMessages: TypedBundle["useFeedMessages"];
|
|
2947
|
+
/**
|
|
2948
|
+
* Returns feeds for the current room.
|
|
2949
|
+
*
|
|
2950
|
+
* @example
|
|
2951
|
+
* const { feeds } = useFeeds();
|
|
2952
|
+
*/
|
|
2953
|
+
declare const _useFeedsSuspense: TypedBundle["suspense"]["useFeeds"];
|
|
2954
|
+
/**
|
|
2955
|
+
* Returns messages for a specific feed in the current room.
|
|
2956
|
+
*
|
|
2957
|
+
* @example
|
|
2958
|
+
* const { messages } = useFeedMessages("feed-id");
|
|
2959
|
+
*/
|
|
2960
|
+
declare const _useFeedMessagesSuspense: TypedBundle["suspense"]["useFeedMessages"];
|
|
2731
2961
|
/**
|
|
2732
2962
|
* Returns the result of searching comments by text in the current room. The result includes the id and the plain text content of the matched comments along with the parent thread id of the comment.
|
|
2733
2963
|
*
|
|
@@ -2999,4 +3229,4 @@ declare const _useStorageRoot: TypedBundle["useStorageRoot"];
|
|
|
2999
3229
|
*/
|
|
3000
3230
|
declare const _useUpdateMyPresence: TypedBundle["useUpdateMyPresence"];
|
|
3001
3231
|
|
|
3002
|
-
export {
|
|
3232
|
+
export { _useEditThreadMetadata as $, type AiChatStatus as A, createLiveblocksContext as B, ClientContext as C, useDeleteAllInboxNotifications as D, useDeleteInboxNotification as E, useErrorListener as F, type GroupAsyncResult as G, useMarkAllInboxNotificationsAsRead as H, useMarkInboxNotificationAsRead as I, useSyncStatus as J, createRoomContext as K, LiveblocksProvider as L, type MutationContext as M, _RoomProvider as N, _useAddReaction as O, _useBroadcastEvent as P, useCanRedo as Q, type RegisterAiKnowledgeProps as R, type SendAiMessageOptions as S, useCanUndo as T, type UseSendAiMessageOptions as U, _useCreateComment as V, _useCreateThread as W, useDeleteComment as X, _useDeleteThread as Y, _useEditComment as Z, _useInboxNotificationThread as _, useAddRoomCommentReaction as a, _useStorageSuspense as a$, _useEditCommentMetadata as a0, useMarkThreadAsResolved as a1, useMarkThreadAsUnresolved as a2, useSubscribeToThread as a3, useUnsubscribeFromThread as a4, _useEventListener as a5, useHistory as a6, _useIsInsideRoom as a7, useLostConnectionListener as a8, useMarkThreadAsRead as a9, useDeleteFeedMessage as aA, useUpdateFeedMessage as aB, _useSearchComments as aC, useAttachmentUrl as aD, _useHistoryVersions as aE, _useRoomSubscriptionSettings as aF, useInboxNotifications as aG, useNotificationSettings as aH, useUpdateNotificationSettings as aI, useCreateAiChat as aJ, useDeleteAiChat as aK, useSendAiMessage as aL, _useUserThreads_experimental as aM, useRoomInfo as aN, useGroupInfo as aO, useUnreadInboxNotificationsCount as aP, _useUser as aQ, _useAiChat as aR, _useAiChats as aS, _useAiChatMessages as aT, useAiChatStatus as aU, _useUrlMetadata as aV, _useOtherSuspense as aW, _useOthersSuspense as aX, useOthersConnectionIdsSuspense as aY, _useOthersMappedSuspense as aZ, _useSelfSuspense as a_, _useMutation as aa, _useMyPresence as ab, _useOthersListener as ac, useRedo as ad, useRemoveReaction as ae, _useRoom as af, useStatus as ag, _useStorageRoot as ah, useThreadSubscription as ai, useUndo as aj, _useUpdateMyPresence as ak, useUpdateRoomSubscriptionSettings as al, useHistoryVersionData as am, _useOther as an, _useOthers as ao, useOthersConnectionIds as ap, _useOthersMapped as aq, _useSelf as ar, _useStorage as as, _useThreads as at, _useFeeds as au, _useFeedMessages as av, useCreateFeed as aw, useDeleteFeed as ax, useUpdateFeedMetadata as ay, useCreateFeedMessage as az, useCreateRoomComment as b, _useThreadsSuspense as b0, useAttachmentUrlSuspense as b1, _useHistoryVersionsSuspense as b2, _useRoomSubscriptionSettingsSuspense as b3, _useFeedsSuspense as b4, _useFeedMessagesSuspense as b5, useInboxNotificationsSuspense as b6, useNotificationSettingsSuspense as b7, useRoomInfoSuspense as b8, useGroupInfoSuspense as b9, useUnreadInboxNotificationsCountSuspense as ba, _useUserSuspense as bb, _useUserThreadsSuspense_experimental as bc, _useAiChatsSuspense as bd, _useAiChatMessagesSuspense as be, _useAiChatSuspense as bf, _useUrlMetadataSuspense as bg, useCreateRoomThread as c, useCreateTextMention as d, useDeleteRoomComment as e, useDeleteRoomThread as f, getUmbrellaStoreForClient as g, useDeleteTextMention as h, useEditRoomComment as i, useEditRoomThreadMetadata as j, useMarkRoomThreadAsRead as k, useMarkRoomThreadAsResolved as l, useMarkRoomThreadAsUnresolved as m, useMentionSuggestionsCache as n, useRemoveRoomCommentReaction as o, useReportTextEditor as p, useResolveMentionSuggestions as q, useRoomAttachmentUrl as r, useRoomPermissions as s, useRoomThreadSubscription as t, useClientOrNull as u, useYjsProvider as v, type RegisterAiToolProps as w, type UseThreadsOptions as x, GlobalRoomContext as y, useClient as z };
|