@liveblocks/core 1.9.0-example1 → 1.9.1

package/dist/index.d.mts

@@ -96,6 +96,25 @@ declare type AckOp = {
     readonly id: "ACK";
     readonly opId: string;
 };
+/**
+ * Create an Op that can be used as an acknowledgement for the given opId, to
+ * send back to the originating client in cases where the server decided to
+ * ignore the Op and not forward it.
+ *
+ * Why?
+ * It's important for the client to receive an acknowledgement for this, so
+ * that it can correctly update its own unacknowledged Ops administration.
+ * Otherwise it could get in "synchronizing" state indefinitely.
+ *
+ * CLEVER HACK
+ * Introducing a new Op type for this would not be backward-compatible as
+ * receiving such Op would crash old clients :(
+ * So the clever backward-compatible hack pulled here is that we codify the
+ * acknowledgement as a "deletion Op" for the non-existing node id "ACK". In
+ * old clients such Op is accepted, but will effectively be a no-op as that
+ * node does not exist, but as a side-effect the Op will get acknowledged.
+ */
+declare function ackOp(opId: string): AckOp;
 declare type SetParentKeyOp = {
     readonly opId?: string;
     readonly id: string;
@@ -756,8 +775,13 @@ declare type Options = {
 declare type PartialNullable<T> = {
     [P in keyof T]?: T[P] | null | undefined;
 };
+declare type ThreadsFilterOptions<TThreadMetadata extends BaseMetadata> = {
+    query?: {
+        metadata?: Partial<TThreadMetadata>;
+    };
+};
 declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
-    getThreads(): Promise<ThreadData<TThreadMetadata>[]>;
+    getThreads(options?: ThreadsFilterOptions<TThreadMetadata>): Promise<ThreadData<TThreadMetadata>[]>;
     createThread(options: {
         threadId: string;
         commentId: string;
@@ -1718,8 +1742,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         addToHistory: boolean;
     }): void;
     /**
-     *
-     * Sends Yjs document updates to liveblocks server
+     * Sends Yjs document updates to Liveblocks server.
      *
      * @param {string} data the doc update to send to the server, base64 encoded uint8array
      */
@@ -2153,12 +2176,7 @@ declare const fancyConsole_errorWithTitle: typeof errorWithTitle;
 declare const fancyConsole_warn: typeof warn;
 declare const fancyConsole_warnWithTitle: typeof warnWithTitle;
 declare namespace fancyConsole {
-  export {
-    fancyConsole_error as error,
-    fancyConsole_errorWithTitle as errorWithTitle,
-    fancyConsole_warn as warn,
-    fancyConsole_warnWithTitle as warnWithTitle,
-  };
+  export { fancyConsole_error as error, fancyConsole_errorWithTitle as errorWithTitle, fancyConsole_warn as warn, fancyConsole_warnWithTitle as warnWithTitle };
 }
 
 /**
@@ -2323,14 +2341,7 @@ type DevToolsTreeNode_LsonTreeNode = LsonTreeNode;
 type DevToolsTreeNode_TreeNode = TreeNode;
 type DevToolsTreeNode_UserTreeNode = UserTreeNode;
 declare namespace DevToolsTreeNode {
-  export {
-    DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode,
-    DevToolsTreeNode_JsonTreeNode as JsonTreeNode,
-    DevToolsTreeNode_LiveTreeNode as LiveTreeNode,
-    DevToolsTreeNode_LsonTreeNode as LsonTreeNode,
-    DevToolsTreeNode_TreeNode as TreeNode,
-    DevToolsTreeNode_UserTreeNode as UserTreeNode,
-  };
+  export type { DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode, DevToolsTreeNode_JsonTreeNode as JsonTreeNode, DevToolsTreeNode_LiveTreeNode as LiveTreeNode, DevToolsTreeNode_LsonTreeNode as LsonTreeNode, DevToolsTreeNode_TreeNode as TreeNode, DevToolsTreeNode_UserTreeNode as UserTreeNode };
 }
 
 /**
@@ -2450,12 +2461,7 @@ type protocol_FullClientToPanelMessage = FullClientToPanelMessage;
 type protocol_FullPanelToClientMessage = FullPanelToClientMessage;
 type protocol_PanelToClientMessage = PanelToClientMessage;
 declare namespace protocol {
-  export {
-    protocol_ClientToPanelMessage as ClientToPanelMessage,
-    protocol_FullClientToPanelMessage as FullClientToPanelMessage,
-    protocol_FullPanelToClientMessage as FullPanelToClientMessage,
-    protocol_PanelToClientMessage as PanelToClientMessage,
-  };
+  export type { protocol_ClientToPanelMessage as ClientToPanelMessage, protocol_FullClientToPanelMessage as FullClientToPanelMessage, protocol_FullPanelToClientMessage as FullPanelToClientMessage, protocol_PanelToClientMessage as PanelToClientMessage };
 }
 
 declare type PromiseOrNot<T> = T | Promise<T>;
@@ -2581,4 +2587,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, Brand, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyResolveUsersArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentDataPlain, CommentReaction, CommentUserReaction, CommentUserReactionPlain, CommentsApi, CommentsApiError, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EnterOptions, EventSource, FetchStorageClientMsg, FetchYDocClientMsg, History, IUserInfo, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, OthersEvent, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, ThreadDataPlain, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { type AckOp, type AsyncCache, type AsyncState, type AsyncStateError, type AsyncStateInitial, type AsyncStateLoading, type AsyncStateResolved, type AsyncStateSuccess, type BaseAuthResult, type BaseMetadata, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyResolveUsersArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsApi, CommentsApiError, CrdtType, type CreateListOp, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type History, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IdTuple, type Immutable, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type LegacyConnectionStatus, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, type LostConnectionEvent, type Lson, type LsonObject, type NodeMap, type Op, OpCode, type Others, type OthersEvent, type ParentToChildNodeMap, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type RejectedStorageOpServerMsg, type Resolve, type Room, type RoomEventMessage, type RoomInitializers, type RoomStateServerMsg, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type ThreadData, type ThreadDataPlain, type ThreadsFilterOptions, type ToImmutable, type ToJson, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type User, type UserJoinServerMsg, type UserLeftServerMsg, WebsocketCloseCodes, type YDocUpdateServerMsg, ackOp, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, withTimeout };

package/dist/index.d.ts

@@ -96,6 +96,25 @@ declare type AckOp = {
     readonly id: "ACK";
     readonly opId: string;
 };
+/**
+ * Create an Op that can be used as an acknowledgement for the given opId, to
+ * send back to the originating client in cases where the server decided to
+ * ignore the Op and not forward it.
+ *
+ * Why?
+ * It's important for the client to receive an acknowledgement for this, so
+ * that it can correctly update its own unacknowledged Ops administration.
+ * Otherwise it could get in "synchronizing" state indefinitely.
+ *
+ * CLEVER HACK
+ * Introducing a new Op type for this would not be backward-compatible as
+ * receiving such Op would crash old clients :(
+ * So the clever backward-compatible hack pulled here is that we codify the
+ * acknowledgement as a "deletion Op" for the non-existing node id "ACK". In
+ * old clients such Op is accepted, but will effectively be a no-op as that
+ * node does not exist, but as a side-effect the Op will get acknowledged.
+ */
+declare function ackOp(opId: string): AckOp;
 declare type SetParentKeyOp = {
     readonly opId?: string;
     readonly id: string;
@@ -756,8 +775,13 @@ declare type Options = {
 declare type PartialNullable<T> = {
     [P in keyof T]?: T[P] | null | undefined;
 };
+declare type ThreadsFilterOptions<TThreadMetadata extends BaseMetadata> = {
+    query?: {
+        metadata?: Partial<TThreadMetadata>;
+    };
+};
 declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
-    getThreads(): Promise<ThreadData<TThreadMetadata>[]>;
+    getThreads(options?: ThreadsFilterOptions<TThreadMetadata>): Promise<ThreadData<TThreadMetadata>[]>;
     createThread(options: {
         threadId: string;
         commentId: string;
@@ -1718,8 +1742,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         addToHistory: boolean;
     }): void;
     /**
-     *
-     * Sends Yjs document updates to liveblocks server
+     * Sends Yjs document updates to Liveblocks server.
      *
      * @param {string} data the doc update to send to the server, base64 encoded uint8array
      */
@@ -2153,12 +2176,7 @@ declare const fancyConsole_errorWithTitle: typeof errorWithTitle;
 declare const fancyConsole_warn: typeof warn;
 declare const fancyConsole_warnWithTitle: typeof warnWithTitle;
 declare namespace fancyConsole {
-  export {
-    fancyConsole_error as error,
-    fancyConsole_errorWithTitle as errorWithTitle,
-    fancyConsole_warn as warn,
-    fancyConsole_warnWithTitle as warnWithTitle,
-  };
+  export { fancyConsole_error as error, fancyConsole_errorWithTitle as errorWithTitle, fancyConsole_warn as warn, fancyConsole_warnWithTitle as warnWithTitle };
 }
 
 /**
@@ -2323,14 +2341,7 @@ type DevToolsTreeNode_LsonTreeNode = LsonTreeNode;
 type DevToolsTreeNode_TreeNode = TreeNode;
 type DevToolsTreeNode_UserTreeNode = UserTreeNode;
 declare namespace DevToolsTreeNode {
-  export {
-    DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode,
-    DevToolsTreeNode_JsonTreeNode as JsonTreeNode,
-    DevToolsTreeNode_LiveTreeNode as LiveTreeNode,
-    DevToolsTreeNode_LsonTreeNode as LsonTreeNode,
-    DevToolsTreeNode_TreeNode as TreeNode,
-    DevToolsTreeNode_UserTreeNode as UserTreeNode,
-  };
+  export type { DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode, DevToolsTreeNode_JsonTreeNode as JsonTreeNode, DevToolsTreeNode_LiveTreeNode as LiveTreeNode, DevToolsTreeNode_LsonTreeNode as LsonTreeNode, DevToolsTreeNode_TreeNode as TreeNode, DevToolsTreeNode_UserTreeNode as UserTreeNode };
 }
 
 /**
@@ -2450,12 +2461,7 @@ type protocol_FullClientToPanelMessage = FullClientToPanelMessage;
 type protocol_FullPanelToClientMessage = FullPanelToClientMessage;
 type protocol_PanelToClientMessage = PanelToClientMessage;
 declare namespace protocol {
-  export {
-    protocol_ClientToPanelMessage as ClientToPanelMessage,
-    protocol_FullClientToPanelMessage as FullClientToPanelMessage,
-    protocol_FullPanelToClientMessage as FullPanelToClientMessage,
-    protocol_PanelToClientMessage as PanelToClientMessage,
-  };
+  export type { protocol_ClientToPanelMessage as ClientToPanelMessage, protocol_FullClientToPanelMessage as FullClientToPanelMessage, protocol_FullPanelToClientMessage as FullPanelToClientMessage, protocol_PanelToClientMessage as PanelToClientMessage };
 }
 
 declare type PromiseOrNot<T> = T | Promise<T>;
@@ -2581,4 +2587,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, Brand, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyResolveUsersArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentDataPlain, CommentReaction, CommentUserReaction, CommentUserReactionPlain, CommentsApi, CommentsApiError, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EnterOptions, EventSource, FetchStorageClientMsg, FetchYDocClientMsg, History, IUserInfo, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, OthersEvent, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, ThreadDataPlain, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { type AckOp, type AsyncCache, type AsyncState, type AsyncStateError, type AsyncStateInitial, type AsyncStateLoading, type AsyncStateResolved, type AsyncStateSuccess, type BaseAuthResult, type BaseMetadata, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyResolveUsersArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsApi, CommentsApiError, CrdtType, type CreateListOp, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type History, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IdTuple, type Immutable, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type LegacyConnectionStatus, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, type LostConnectionEvent, type Lson, type LsonObject, type NodeMap, type Op, OpCode, type Others, type OthersEvent, type ParentToChildNodeMap, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type RejectedStorageOpServerMsg, type Resolve, type Room, type RoomEventMessage, type RoomInitializers, type RoomStateServerMsg, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type ThreadData, type ThreadDataPlain, type ThreadsFilterOptions, type ToImmutable, type ToJson, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type User, type UserJoinServerMsg, type UserLeftServerMsg, WebsocketCloseCodes, type YDocUpdateServerMsg, ackOp, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, withTimeout };