@liveblocks/core 1.8.2 → 1.9.0-example1

package/dist/index.d.mts

@@ -686,13 +686,16 @@ declare type CommentBody = {
     content: CommentBodyBlockElement[];
 };
 
-declare type CommentReactionUser = {
-    id: string;
+declare type DateToString<T> = {
+    [P in keyof T]: T[P] extends Date ? string : T[P];
 };
+
 declare type CommentReaction = {
     emoji: string;
-    createdAt: string;
-    users: CommentReactionUser[];
+    createdAt: Date;
+    users: {
+        id: string;
+    }[];
 };
 /**
  * Represents a comment.
@@ -703,17 +706,33 @@ declare type CommentData = {
     threadId: string;
     roomId: string;
     userId: string;
-    createdAt: string;
-    editedAt?: string;
+    createdAt: Date;
+    editedAt?: Date;
     reactions: CommentReaction[];
 } & ({
     body: CommentBody;
     deletedAt?: never;
+} | {
+    body?: never;
+    deletedAt: Date;
+});
+declare type CommentDataPlain = Omit<DateToString<CommentData>, "reaction" | "body"> & {
+    reactions: DateToString<CommentReaction[]>;
+} & ({
+    body: CommentBody;
+    deletedAt?: never;
 } | {
     body?: never;
     deletedAt: string;
 });
 
+declare type CommentUserReaction = {
+    emoji: string;
+    createdAt: Date;
+    userId: string;
+};
+declare type CommentUserReactionPlain = DateToString<CommentUserReaction>;
+
 /**
  * Represents a thread of comments.
  */
@@ -721,11 +740,15 @@ declare type ThreadData<TThreadMetadata extends BaseMetadata = never> = {
     type: "thread";
     id: string;
     roomId: string;
-    createdAt: string;
-    updatedAt?: string;
+    createdAt: Date;
+    updatedAt?: Date;
     comments: CommentData[];
     metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
 };
+declare type ThreadDataPlain<TThreadMetadata extends BaseMetadata = never> = Omit<DateToString<ThreadData<TThreadMetadata>>, "comments" | "metadata"> & {
+    comments: CommentDataPlain[];
+    metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
+};
 
 declare type Options = {
     baseUrl: string;
@@ -744,7 +767,7 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
     editThreadMetadata(options: {
         metadata: PartialNullable<TThreadMetadata>;
         threadId: string;
-    }): Promise<ThreadData<TThreadMetadata>>;
+    }): Promise<TThreadMetadata>;
     createComment(options: {
         threadId: string;
         commentId: string;
@@ -763,12 +786,12 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
         threadId: string;
         commentId: string;
         emoji: string;
-    }): Promise<CommentData>;
+    }): Promise<CommentUserReaction>;
     removeReaction(options: {
         threadId: string;
         commentId: string;
         emoji: string;
-    }): Promise<CommentData>;
+    }): Promise<void>;
 };
 declare class CommentsApiError extends Error {
     message: string;
@@ -2524,6 +2547,27 @@ declare function getMentionedIdsFromCommentBody(body: CommentBody): string[];
  * Markdown, HTML, or a custom format.
  */
 declare function stringifyCommentBody<TUserMeta extends BaseUserMeta = BaseUserMeta>(body: CommentBody, options?: StringifyCommentBodyOptions<TUserMeta>): Promise<string>;
+/**
+ * Converts a plain comment data object (usually returned by the API) to a comment data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain comment data object (usually returned by the API)
+ * @returns The rich comment data object that can be used by the client.
+ */
+declare function convertToCommentData(data: CommentDataPlain): CommentData;
+/**
+ * Converts a plain thread data object (usually returned by the API) to a thread data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain thread data object (usually returned by the API)
+ * @returns The rich hread data object that can be used by the client.
+ */
+declare function convertToThreadData<TThreadMetadata extends BaseMetadata = never>(data: ThreadDataPlain<TThreadMetadata>): ThreadData<TThreadMetadata>;
+/**
+ * Converts a plain comment reaction object (usually returned by the API) to a comment reaction object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain comment reaction object (usually returned by the API)
+ * @returns The rich comment reaction object that can be used by the client.
+ */
+declare function convertToCommentUserReaction(data: CommentUserReactionPlain): CommentUserReaction;
 
 /**
  * Helper type to help users adopt to Lson types from interface definitions.
@@ -2537,4 +2581,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, CommentReaction, 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, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, 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 { 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 };

package/dist/index.d.ts

@@ -686,13 +686,16 @@ declare type CommentBody = {
     content: CommentBodyBlockElement[];
 };
 
-declare type CommentReactionUser = {
-    id: string;
+declare type DateToString<T> = {
+    [P in keyof T]: T[P] extends Date ? string : T[P];
 };
+
 declare type CommentReaction = {
     emoji: string;
-    createdAt: string;
-    users: CommentReactionUser[];
+    createdAt: Date;
+    users: {
+        id: string;
+    }[];
 };
 /**
  * Represents a comment.
@@ -703,17 +706,33 @@ declare type CommentData = {
     threadId: string;
     roomId: string;
     userId: string;
-    createdAt: string;
-    editedAt?: string;
+    createdAt: Date;
+    editedAt?: Date;
     reactions: CommentReaction[];
 } & ({
     body: CommentBody;
     deletedAt?: never;
+} | {
+    body?: never;
+    deletedAt: Date;
+});
+declare type CommentDataPlain = Omit<DateToString<CommentData>, "reaction" | "body"> & {
+    reactions: DateToString<CommentReaction[]>;
+} & ({
+    body: CommentBody;
+    deletedAt?: never;
 } | {
     body?: never;
     deletedAt: string;
 });
 
+declare type CommentUserReaction = {
+    emoji: string;
+    createdAt: Date;
+    userId: string;
+};
+declare type CommentUserReactionPlain = DateToString<CommentUserReaction>;
+
 /**
  * Represents a thread of comments.
  */
@@ -721,11 +740,15 @@ declare type ThreadData<TThreadMetadata extends BaseMetadata = never> = {
     type: "thread";
     id: string;
     roomId: string;
-    createdAt: string;
-    updatedAt?: string;
+    createdAt: Date;
+    updatedAt?: Date;
     comments: CommentData[];
     metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
 };
+declare type ThreadDataPlain<TThreadMetadata extends BaseMetadata = never> = Omit<DateToString<ThreadData<TThreadMetadata>>, "comments" | "metadata"> & {
+    comments: CommentDataPlain[];
+    metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
+};
 
 declare type Options = {
     baseUrl: string;
@@ -744,7 +767,7 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
     editThreadMetadata(options: {
         metadata: PartialNullable<TThreadMetadata>;
         threadId: string;
-    }): Promise<ThreadData<TThreadMetadata>>;
+    }): Promise<TThreadMetadata>;
     createComment(options: {
         threadId: string;
         commentId: string;
@@ -763,12 +786,12 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
         threadId: string;
         commentId: string;
         emoji: string;
-    }): Promise<CommentData>;
+    }): Promise<CommentUserReaction>;
     removeReaction(options: {
         threadId: string;
         commentId: string;
         emoji: string;
-    }): Promise<CommentData>;
+    }): Promise<void>;
 };
 declare class CommentsApiError extends Error {
     message: string;
@@ -2524,6 +2547,27 @@ declare function getMentionedIdsFromCommentBody(body: CommentBody): string[];
  * Markdown, HTML, or a custom format.
  */
 declare function stringifyCommentBody<TUserMeta extends BaseUserMeta = BaseUserMeta>(body: CommentBody, options?: StringifyCommentBodyOptions<TUserMeta>): Promise<string>;
+/**
+ * Converts a plain comment data object (usually returned by the API) to a comment data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain comment data object (usually returned by the API)
+ * @returns The rich comment data object that can be used by the client.
+ */
+declare function convertToCommentData(data: CommentDataPlain): CommentData;
+/**
+ * Converts a plain thread data object (usually returned by the API) to a thread data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain thread data object (usually returned by the API)
+ * @returns The rich hread data object that can be used by the client.
+ */
+declare function convertToThreadData<TThreadMetadata extends BaseMetadata = never>(data: ThreadDataPlain<TThreadMetadata>): ThreadData<TThreadMetadata>;
+/**
+ * Converts a plain comment reaction object (usually returned by the API) to a comment reaction object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain comment reaction object (usually returned by the API)
+ * @returns The rich comment reaction object that can be used by the client.
+ */
+declare function convertToCommentUserReaction(data: CommentUserReactionPlain): CommentUserReaction;
 
 /**
  * Helper type to help users adopt to Lson types from interface definitions.
@@ -2537,4 +2581,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, CommentReaction, 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, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, 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 { 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 };