@liveblocks/core 3.10.1 → 3.11.1
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/index.cjs +182 -150
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +31 -5
- package/dist/index.d.ts +31 -5
- package/dist/index.js +48 -16
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -609,8 +609,6 @@ type SerializedRegister = {
|
|
|
609
609
|
readonly parentKey: string;
|
|
610
610
|
readonly data: Json;
|
|
611
611
|
};
|
|
612
|
-
declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
|
|
613
|
-
declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
|
|
614
612
|
|
|
615
613
|
type LiveObjectUpdateDelta<O extends {
|
|
616
614
|
[key: string]: unknown;
|
|
@@ -1267,6 +1265,11 @@ type CommentUserReaction = {
|
|
|
1267
1265
|
userId: string;
|
|
1268
1266
|
};
|
|
1269
1267
|
type CommentUserReactionPlain = DateToString<CommentUserReaction>;
|
|
1268
|
+
type SearchCommentsResult = {
|
|
1269
|
+
threadId: string;
|
|
1270
|
+
commentId: string;
|
|
1271
|
+
content: string;
|
|
1272
|
+
};
|
|
1270
1273
|
/**
|
|
1271
1274
|
* Represents a thread of comments.
|
|
1272
1275
|
*/
|
|
@@ -1559,6 +1562,20 @@ interface RoomHttpApi<M extends BaseMetadata> {
|
|
|
1559
1562
|
requestedAt: Date;
|
|
1560
1563
|
permissionHints: Record<string, Permission[]>;
|
|
1561
1564
|
}>;
|
|
1565
|
+
searchComments(options: {
|
|
1566
|
+
roomId: string;
|
|
1567
|
+
query: {
|
|
1568
|
+
threadMetadata?: Partial<QueryMetadata<M>>;
|
|
1569
|
+
threadResolved?: boolean;
|
|
1570
|
+
hasAttachments?: boolean;
|
|
1571
|
+
hasMentions?: boolean;
|
|
1572
|
+
text: string;
|
|
1573
|
+
};
|
|
1574
|
+
}, requestOptions?: {
|
|
1575
|
+
signal?: AbortSignal;
|
|
1576
|
+
}): Promise<{
|
|
1577
|
+
data: Array<SearchCommentsResult>;
|
|
1578
|
+
}>;
|
|
1562
1579
|
createThread({ roomId, metadata, body, commentId, threadId, attachmentIds, }: {
|
|
1563
1580
|
roomId: string;
|
|
1564
1581
|
threadId?: string;
|
|
@@ -2463,13 +2480,12 @@ declare enum ServerMsgCode {
|
|
|
2463
2480
|
COMMENT_DELETED = 404,
|
|
2464
2481
|
COMMENT_REACTION_ADDED = 405,
|
|
2465
2482
|
COMMENT_REACTION_REMOVED = 406,
|
|
2466
|
-
/** @deprecated No longer sent by server */
|
|
2467
2483
|
REJECT_STORAGE_OP = 299
|
|
2468
2484
|
}
|
|
2469
2485
|
/**
|
|
2470
2486
|
* Messages that can be sent from the server to the client.
|
|
2471
2487
|
*/
|
|
2472
|
-
type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | CommentsEventServerMsg;
|
|
2488
|
+
type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
|
|
2473
2489
|
type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved;
|
|
2474
2490
|
type ThreadCreatedEvent = {
|
|
2475
2491
|
type: ServerMsgCode.THREAD_CREATED;
|
|
@@ -2674,6 +2690,16 @@ type UpdateStorageServerMsg = {
|
|
|
2674
2690
|
readonly type: ServerMsgCode.UPDATE_STORAGE;
|
|
2675
2691
|
readonly ops: Op[];
|
|
2676
2692
|
};
|
|
2693
|
+
/**
|
|
2694
|
+
* Sent by the WebSocket server to the client to indicate that certain opIds
|
|
2695
|
+
* have been rejected, possibly due to lack of permissions or exceeding
|
|
2696
|
+
* a limit.
|
|
2697
|
+
*/
|
|
2698
|
+
type RejectedStorageOpServerMsg = {
|
|
2699
|
+
readonly type: ServerMsgCode.REJECT_STORAGE_OP;
|
|
2700
|
+
readonly opIds: string[];
|
|
2701
|
+
readonly reason: string;
|
|
2702
|
+
};
|
|
2677
2703
|
|
|
2678
2704
|
type HistoryVersion = {
|
|
2679
2705
|
type: "historyVersion";
|
|
@@ -5107,4 +5133,4 @@ type EnsureJson<T> = T extends Json ? T : T extends Array<infer I> ? (EnsureJson
|
|
|
5107
5133
|
[K in keyof T as EnsureJson<T[K]> extends never ? never : K]: EnsureJson<T[K]>;
|
|
5108
5134
|
};
|
|
5109
5135
|
|
|
5110
|
-
export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DGI, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe,
|
|
5136
|
+
export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DGI, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isNumberOperator, isPlainObject, isStartsWithOperator, isUrl, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, url, urljoin, wait, warnOnce, warnOnceIf, withTimeout };
|
package/dist/index.d.ts
CHANGED
|
@@ -609,8 +609,6 @@ type SerializedRegister = {
|
|
|
609
609
|
readonly parentKey: string;
|
|
610
610
|
readonly data: Json;
|
|
611
611
|
};
|
|
612
|
-
declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
|
|
613
|
-
declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
|
|
614
612
|
|
|
615
613
|
type LiveObjectUpdateDelta<O extends {
|
|
616
614
|
[key: string]: unknown;
|
|
@@ -1267,6 +1265,11 @@ type CommentUserReaction = {
|
|
|
1267
1265
|
userId: string;
|
|
1268
1266
|
};
|
|
1269
1267
|
type CommentUserReactionPlain = DateToString<CommentUserReaction>;
|
|
1268
|
+
type SearchCommentsResult = {
|
|
1269
|
+
threadId: string;
|
|
1270
|
+
commentId: string;
|
|
1271
|
+
content: string;
|
|
1272
|
+
};
|
|
1270
1273
|
/**
|
|
1271
1274
|
* Represents a thread of comments.
|
|
1272
1275
|
*/
|
|
@@ -1559,6 +1562,20 @@ interface RoomHttpApi<M extends BaseMetadata> {
|
|
|
1559
1562
|
requestedAt: Date;
|
|
1560
1563
|
permissionHints: Record<string, Permission[]>;
|
|
1561
1564
|
}>;
|
|
1565
|
+
searchComments(options: {
|
|
1566
|
+
roomId: string;
|
|
1567
|
+
query: {
|
|
1568
|
+
threadMetadata?: Partial<QueryMetadata<M>>;
|
|
1569
|
+
threadResolved?: boolean;
|
|
1570
|
+
hasAttachments?: boolean;
|
|
1571
|
+
hasMentions?: boolean;
|
|
1572
|
+
text: string;
|
|
1573
|
+
};
|
|
1574
|
+
}, requestOptions?: {
|
|
1575
|
+
signal?: AbortSignal;
|
|
1576
|
+
}): Promise<{
|
|
1577
|
+
data: Array<SearchCommentsResult>;
|
|
1578
|
+
}>;
|
|
1562
1579
|
createThread({ roomId, metadata, body, commentId, threadId, attachmentIds, }: {
|
|
1563
1580
|
roomId: string;
|
|
1564
1581
|
threadId?: string;
|
|
@@ -2463,13 +2480,12 @@ declare enum ServerMsgCode {
|
|
|
2463
2480
|
COMMENT_DELETED = 404,
|
|
2464
2481
|
COMMENT_REACTION_ADDED = 405,
|
|
2465
2482
|
COMMENT_REACTION_REMOVED = 406,
|
|
2466
|
-
/** @deprecated No longer sent by server */
|
|
2467
2483
|
REJECT_STORAGE_OP = 299
|
|
2468
2484
|
}
|
|
2469
2485
|
/**
|
|
2470
2486
|
* Messages that can be sent from the server to the client.
|
|
2471
2487
|
*/
|
|
2472
|
-
type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | CommentsEventServerMsg;
|
|
2488
|
+
type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
|
|
2473
2489
|
type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved;
|
|
2474
2490
|
type ThreadCreatedEvent = {
|
|
2475
2491
|
type: ServerMsgCode.THREAD_CREATED;
|
|
@@ -2674,6 +2690,16 @@ type UpdateStorageServerMsg = {
|
|
|
2674
2690
|
readonly type: ServerMsgCode.UPDATE_STORAGE;
|
|
2675
2691
|
readonly ops: Op[];
|
|
2676
2692
|
};
|
|
2693
|
+
/**
|
|
2694
|
+
* Sent by the WebSocket server to the client to indicate that certain opIds
|
|
2695
|
+
* have been rejected, possibly due to lack of permissions or exceeding
|
|
2696
|
+
* a limit.
|
|
2697
|
+
*/
|
|
2698
|
+
type RejectedStorageOpServerMsg = {
|
|
2699
|
+
readonly type: ServerMsgCode.REJECT_STORAGE_OP;
|
|
2700
|
+
readonly opIds: string[];
|
|
2701
|
+
readonly reason: string;
|
|
2702
|
+
};
|
|
2677
2703
|
|
|
2678
2704
|
type HistoryVersion = {
|
|
2679
2705
|
type: "historyVersion";
|
|
@@ -5107,4 +5133,4 @@ type EnsureJson<T> = T extends Json ? T : T extends Array<infer I> ? (EnsureJson
|
|
|
5107
5133
|
[K in keyof T as EnsureJson<T[K]> extends never ? never : K]: EnsureJson<T[K]>;
|
|
5108
5134
|
};
|
|
5109
5135
|
|
|
5110
|
-
export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DGI, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe,
|
|
5136
|
+
export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DGI, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isNumberOperator, isPlainObject, isStartsWithOperator, isUrl, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, url, urljoin, wait, warnOnce, warnOnceIf, withTimeout };
|
package/dist/index.js
CHANGED
|
@@ -6,7 +6,7 @@ var __export = (target, all) => {
|
|
|
6
6
|
|
|
7
7
|
// src/version.ts
|
|
8
8
|
var PKG_NAME = "@liveblocks/core";
|
|
9
|
-
var PKG_VERSION = "3.
|
|
9
|
+
var PKG_VERSION = "3.11.1";
|
|
10
10
|
var PKG_FORMAT = "esm";
|
|
11
11
|
|
|
12
12
|
// src/dupe-detection.ts
|
|
@@ -1572,6 +1572,26 @@ function createApiClient({
|
|
|
1572
1572
|
throw err;
|
|
1573
1573
|
}
|
|
1574
1574
|
}
|
|
1575
|
+
async function searchComments(options, requestOptions) {
|
|
1576
|
+
const result = await httpClient.get(
|
|
1577
|
+
url`/v2/c/rooms/${options.roomId}/threads/comments/search`,
|
|
1578
|
+
await authManager.getAuthValue({
|
|
1579
|
+
requestedScope: "comments:read",
|
|
1580
|
+
roomId: options.roomId
|
|
1581
|
+
}),
|
|
1582
|
+
{
|
|
1583
|
+
text: options.query.text,
|
|
1584
|
+
query: objectToQuery({
|
|
1585
|
+
threadMetadata: options.query.threadMetadata,
|
|
1586
|
+
threadResolved: options.query.threadResolved,
|
|
1587
|
+
hasAttachments: options.query.hasAttachments,
|
|
1588
|
+
hasMentions: options.query.hasMentions
|
|
1589
|
+
})
|
|
1590
|
+
},
|
|
1591
|
+
{ signal: requestOptions?.signal }
|
|
1592
|
+
);
|
|
1593
|
+
return result;
|
|
1594
|
+
}
|
|
1575
1595
|
async function createThread(options) {
|
|
1576
1596
|
const commentId = options.commentId ?? createCommentId();
|
|
1577
1597
|
const threadId = options.threadId ?? createThreadId();
|
|
@@ -2399,6 +2419,7 @@ function createApiClient({
|
|
|
2399
2419
|
// Room threads
|
|
2400
2420
|
getThreads,
|
|
2401
2421
|
getThreadsSince,
|
|
2422
|
+
searchComments,
|
|
2402
2423
|
createThread,
|
|
2403
2424
|
getThread,
|
|
2404
2425
|
deleteThread,
|
|
@@ -3177,12 +3198,12 @@ function log(level, message) {
|
|
|
3177
3198
|
function logPrematureErrorOrCloseEvent(e) {
|
|
3178
3199
|
const conn = "Connection to Liveblocks websocket server";
|
|
3179
3200
|
return (ctx) => {
|
|
3180
|
-
if (e
|
|
3181
|
-
warn(`${conn} could not be established. ${String(e)}`);
|
|
3182
|
-
} else {
|
|
3201
|
+
if (isCloseEvent(e)) {
|
|
3183
3202
|
warn(
|
|
3184
|
-
|
|
3203
|
+
`${conn} closed prematurely (code: ${e.code}). Retrying in ${ctx.backoffDelay}ms.`
|
|
3185
3204
|
);
|
|
3205
|
+
} else {
|
|
3206
|
+
warn(`${conn} could not be established.`, e);
|
|
3186
3207
|
}
|
|
3187
3208
|
};
|
|
3188
3209
|
}
|
|
@@ -5959,12 +5980,6 @@ var CrdtType = /* @__PURE__ */ ((CrdtType2) => {
|
|
|
5959
5980
|
CrdtType2[CrdtType2["REGISTER"] = 3] = "REGISTER";
|
|
5960
5981
|
return CrdtType2;
|
|
5961
5982
|
})(CrdtType || {});
|
|
5962
|
-
function isRootCrdt(crdt) {
|
|
5963
|
-
return crdt.type === 0 /* OBJECT */ && !isChildCrdt(crdt);
|
|
5964
|
-
}
|
|
5965
|
-
function isChildCrdt(crdt) {
|
|
5966
|
-
return crdt.parentId !== void 0 && crdt.parentKey !== void 0;
|
|
5967
|
-
}
|
|
5968
5983
|
|
|
5969
5984
|
// src/crdts/LiveRegister.ts
|
|
5970
5985
|
var LiveRegister = class _LiveRegister extends AbstractCrdt {
|
|
@@ -7399,6 +7414,9 @@ var LiveMap = class _LiveMap extends AbstractCrdt {
|
|
|
7399
7414
|
|
|
7400
7415
|
// src/crdts/LiveObject.ts
|
|
7401
7416
|
var MAX_LIVE_OBJECT_SIZE = 128 * 1024;
|
|
7417
|
+
function isRootCrdt(id, _) {
|
|
7418
|
+
return id === "root";
|
|
7419
|
+
}
|
|
7402
7420
|
var LiveObject = class _LiveObject extends AbstractCrdt {
|
|
7403
7421
|
#map;
|
|
7404
7422
|
#propToLastUpdate;
|
|
@@ -7416,8 +7434,8 @@ var LiveObject = class _LiveObject extends AbstractCrdt {
|
|
|
7416
7434
|
const parentToChildren = /* @__PURE__ */ new Map();
|
|
7417
7435
|
let root = null;
|
|
7418
7436
|
for (const [id, crdt] of items) {
|
|
7419
|
-
if (isRootCrdt(crdt)) {
|
|
7420
|
-
root =
|
|
7437
|
+
if (isRootCrdt(id, crdt)) {
|
|
7438
|
+
root = crdt;
|
|
7421
7439
|
} else {
|
|
7422
7440
|
const tuple = [id, crdt];
|
|
7423
7441
|
const children = parentToChildren.get(crdt.parentId);
|
|
@@ -7437,7 +7455,7 @@ var LiveObject = class _LiveObject extends AbstractCrdt {
|
|
|
7437
7455
|
static _fromItems(items, pool) {
|
|
7438
7456
|
const [root, parentToChildren] = _LiveObject.#buildRootAndParentToChildren(items);
|
|
7439
7457
|
return _LiveObject._deserialize(
|
|
7440
|
-
root,
|
|
7458
|
+
["root", root],
|
|
7441
7459
|
parentToChildren,
|
|
7442
7460
|
pool
|
|
7443
7461
|
);
|
|
@@ -9296,6 +9314,22 @@ function createRoom(options, config) {
|
|
|
9296
9314
|
}
|
|
9297
9315
|
break;
|
|
9298
9316
|
}
|
|
9317
|
+
// Receiving a RejectedOps message in the client means that the server is no
|
|
9318
|
+
// longer in sync with the client. Trying to synchronize the client again by
|
|
9319
|
+
// rolling back particular Ops may be hard/impossible. It's fine to not try and
|
|
9320
|
+
// accept the out-of-sync reality and throw an error.
|
|
9321
|
+
case 299 /* REJECT_STORAGE_OP */: {
|
|
9322
|
+
errorWithTitle(
|
|
9323
|
+
"Storage mutation rejection error",
|
|
9324
|
+
message.reason
|
|
9325
|
+
);
|
|
9326
|
+
if (process.env.NODE_ENV !== "production") {
|
|
9327
|
+
throw new Error(
|
|
9328
|
+
`Storage mutations rejected by server: ${message.reason}`
|
|
9329
|
+
);
|
|
9330
|
+
}
|
|
9331
|
+
break;
|
|
9332
|
+
}
|
|
9299
9333
|
case 400 /* THREAD_CREATED */:
|
|
9300
9334
|
case 407 /* THREAD_DELETED */:
|
|
9301
9335
|
case 401 /* THREAD_METADATA_UPDATED */:
|
|
@@ -11280,7 +11314,6 @@ export {
|
|
|
11280
11314
|
getSubscriptionKey,
|
|
11281
11315
|
html,
|
|
11282
11316
|
htmlSafe,
|
|
11283
|
-
isChildCrdt,
|
|
11284
11317
|
isCommentBodyLink,
|
|
11285
11318
|
isCommentBodyMention,
|
|
11286
11319
|
isCommentBodyText,
|
|
@@ -11291,7 +11324,6 @@ export {
|
|
|
11291
11324
|
isNotificationChannelEnabled,
|
|
11292
11325
|
isNumberOperator,
|
|
11293
11326
|
isPlainObject,
|
|
11294
|
-
isRootCrdt,
|
|
11295
11327
|
isStartsWithOperator,
|
|
11296
11328
|
isUrl,
|
|
11297
11329
|
kInternal,
|