@liveblocks/node 3.23.0-file4 → 3.23.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { Permission, Json, DFMD, FeedCreateMetadata, RoomPermissions, RoomAccesses, OptionalTupleUnless, BaseUserMeta, DU, PartialUnless, UpdateRoomAccesses, DE, JsonObject, PlainLsonObject, ToJson, DS, QueryMetadata, DTM, ThreadVisibility, ThreadData, DCM, UserSubscriptionData, CommentData, BaseMetadata, CommentBody, Patchable, LiveFile, LiveFileReference, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LiveObject, Awaitable, DFM, Feed, FeedUpdateMetadata, FeedMessage, NotificationChannel } from '@liveblocks/core';
-export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveFile, LiveFileData, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, RoomAccesses, RoomPermissions, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
+import { Permission, Json, DFMD, FeedCreateMetadata, RoomPermissions, RoomAccesses, OptionalTupleUnless, BaseUserMeta, DU, PartialUnless, UpdateRoomAccesses, DE, JsonObject, PlainLsonObject, ToJson, DS, QueryMetadata, DTM, ThreadVisibility, ThreadData, DCM, UserSubscriptionData, CommentData, BaseMetadata, CommentBody, Patchable, CommentAttachment, LiveFile, LiveFileReference, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LiveObject, Awaitable, DFM, Feed, FeedUpdateMetadata, FeedMessage, NotificationChannel } from '@liveblocks/core';
+export { CommentAttachment, CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveFile, LiveFileData, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, RoomAccesses, RoomPermissions, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 /**
@@ -114,6 +114,7 @@ type CreateThreadOptions<TM extends BaseMetadata, CM extends BaseMetadata> = {
             userId: string;
             createdAt?: Date;
             body: CommentBody;
+            attachmentIds?: string[];
         } & PartialUnless<CM, {
             metadata: CM;
         }>;
@@ -128,6 +129,7 @@ type CreateCommentOptions<CM extends BaseMetadata> = {
         userId: string;
         createdAt?: Date;
         body: CommentBody;
+        attachmentIds?: string[];
     } & PartialUnless<CM, {
         metadata: CM;
     }>;
@@ -930,6 +932,7 @@ declare class Liveblocks {
      * @param params.data.userId The user ID of the user who is set to create the comment.
      * @param params.data.createdAt (optional) The date the comment is set to be created.
      * @param params.data.body The body of the comment.
+     * @param params.data.attachmentIds (optional) The attachment IDs to add to the comment.
      * @param params.data.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created comment.
@@ -941,6 +944,7 @@ declare class Liveblocks {
      * @param params.threadId The thread ID to edit the comment in.
      * @param params.commentId The comment ID to edit.
      * @param params.data.body The body of the comment.
+     * @param params.data.attachmentIds (optional) The IDs of every attachment that should remain on the comment.
      * @param params.data.metadata (optional) The metadata for the comment. Value must be a string, boolean or number. Use null to delete a key.
      * @param params.data.editedAt (optional) The date the comment was edited.
      * @param options.signal (optional) An abort signal to cancel the request.
@@ -952,6 +956,7 @@ declare class Liveblocks {
         commentId: string;
         data: {
             body: CommentBody;
+            attachmentIds?: string[];
             metadata?: Patchable<CM>;
             editedAt?: Date;
         };
@@ -980,6 +985,20 @@ declare class Liveblocks {
         roomId: string;
         attachmentId: string;
     }, options?: RequestOptions): Promise<AttachmentWithUrl>;
+    /**
+     * Uploads an attachment that can be added to a comment.
+     *
+     * @param params.roomId The room ID to upload the attachment to.
+     * @param params.userId The user ID of the user uploading the attachment.
+     * @param params.file The file to upload.
+     * @param options.signal (optional) An abort signal to cancel the upload.
+     * @returns The uploaded attachment.
+     */
+    uploadAttachment(params: {
+        roomId: string;
+        userId: string;
+        file: File;
+    }, options?: RequestOptions): Promise<CommentAttachment>;
     uploadFile(params: {
         roomId: string;
         file: File;
@@ -996,6 +1015,7 @@ declare class Liveblocks {
      * @param params.thread.comment.userId The user ID of the user who created the comment.
      * @param params.thread.comment.createdAt (optional) The date the comment was created.
      * @param params.thread.comment.body The body of the comment.
+     * @param params.thread.comment.attachmentIds (optional) The attachment IDs to add to the comment.
      * @param params.thread.comment.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created thread. The thread will be created with the specified comment as its first comment.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Permission, Json, DFMD, FeedCreateMetadata, RoomPermissions, RoomAccesses, OptionalTupleUnless, BaseUserMeta, DU, PartialUnless, UpdateRoomAccesses, DE, JsonObject, PlainLsonObject, ToJson, DS, QueryMetadata, DTM, ThreadVisibility, ThreadData, DCM, UserSubscriptionData, CommentData, BaseMetadata, CommentBody, Patchable, LiveFile, LiveFileReference, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LiveObject, Awaitable, DFM, Feed, FeedUpdateMetadata, FeedMessage, NotificationChannel } from '@liveblocks/core';
-export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveFile, LiveFileData, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, RoomAccesses, RoomPermissions, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
+import { Permission, Json, DFMD, FeedCreateMetadata, RoomPermissions, RoomAccesses, OptionalTupleUnless, BaseUserMeta, DU, PartialUnless, UpdateRoomAccesses, DE, JsonObject, PlainLsonObject, ToJson, DS, QueryMetadata, DTM, ThreadVisibility, ThreadData, DCM, UserSubscriptionData, CommentData, BaseMetadata, CommentBody, Patchable, CommentAttachment, LiveFile, LiveFileReference, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LiveObject, Awaitable, DFM, Feed, FeedUpdateMetadata, FeedMessage, NotificationChannel } from '@liveblocks/core';
+export { CommentAttachment, CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveFile, LiveFileData, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, RoomAccesses, RoomPermissions, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 /**
@@ -114,6 +114,7 @@ type CreateThreadOptions<TM extends BaseMetadata, CM extends BaseMetadata> = {
             userId: string;
             createdAt?: Date;
             body: CommentBody;
+            attachmentIds?: string[];
         } & PartialUnless<CM, {
             metadata: CM;
         }>;
@@ -128,6 +129,7 @@ type CreateCommentOptions<CM extends BaseMetadata> = {
         userId: string;
         createdAt?: Date;
         body: CommentBody;
+        attachmentIds?: string[];
     } & PartialUnless<CM, {
         metadata: CM;
     }>;
@@ -930,6 +932,7 @@ declare class Liveblocks {
      * @param params.data.userId The user ID of the user who is set to create the comment.
      * @param params.data.createdAt (optional) The date the comment is set to be created.
      * @param params.data.body The body of the comment.
+     * @param params.data.attachmentIds (optional) The attachment IDs to add to the comment.
      * @param params.data.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created comment.
@@ -941,6 +944,7 @@ declare class Liveblocks {
      * @param params.threadId The thread ID to edit the comment in.
      * @param params.commentId The comment ID to edit.
      * @param params.data.body The body of the comment.
+     * @param params.data.attachmentIds (optional) The IDs of every attachment that should remain on the comment.
      * @param params.data.metadata (optional) The metadata for the comment. Value must be a string, boolean or number. Use null to delete a key.
      * @param params.data.editedAt (optional) The date the comment was edited.
      * @param options.signal (optional) An abort signal to cancel the request.
@@ -952,6 +956,7 @@ declare class Liveblocks {
         commentId: string;
         data: {
             body: CommentBody;
+            attachmentIds?: string[];
             metadata?: Patchable<CM>;
             editedAt?: Date;
         };
@@ -980,6 +985,20 @@ declare class Liveblocks {
         roomId: string;
         attachmentId: string;
     }, options?: RequestOptions): Promise<AttachmentWithUrl>;
+    /**
+     * Uploads an attachment that can be added to a comment.
+     *
+     * @param params.roomId The room ID to upload the attachment to.
+     * @param params.userId The user ID of the user uploading the attachment.
+     * @param params.file The file to upload.
+     * @param options.signal (optional) An abort signal to cancel the upload.
+     * @returns The uploaded attachment.
+     */
+    uploadAttachment(params: {
+        roomId: string;
+        userId: string;
+        file: File;
+    }, options?: RequestOptions): Promise<CommentAttachment>;
     uploadFile(params: {
         roomId: string;
         file: File;
@@ -996,6 +1015,7 @@ declare class Liveblocks {
      * @param params.thread.comment.userId The user ID of the user who created the comment.
      * @param params.thread.comment.createdAt (optional) The date the comment was created.
      * @param params.thread.comment.body The body of the comment.
+     * @param params.thread.comment.attachmentIds (optional) The attachment IDs to add to the comment.
      * @param params.thread.comment.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created thread. The thread will be created with the specified comment as its first comment.

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "3.23.0-file4";
+var PKG_VERSION = "3.23.0";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -19,6 +19,7 @@ import {
   convertToSubscriptionData,
   convertToThreadData,
   convertToUserSubscriptionData,
+  createCommentAttachmentId,
   createManagedPool,
   createNotificationSettings,
   createStorageFileId,
@@ -294,9 +295,9 @@ var Session = class {
 };
 
 // src/client.ts
-var STORAGE_FILE_PART_SIZE = 5 * 1024 * 1024;
-var STORAGE_FILE_RETRY_ATTEMPTS = 10;
-var STORAGE_FILE_RETRY_DELAYS = [
+var ROOM_FILE_PART_SIZE = 5 * 1024 * 1024;
+var ROOM_FILE_RETRY_ATTEMPTS = 10;
+var ROOM_FILE_RETRY_DELAYS = [
   2e3,
   2e3,
   2e3,
@@ -308,10 +309,11 @@ var STORAGE_FILE_RETRY_DELAYS = [
   2e3,
   2e3
 ];
-async function uploadStorageFile({
+async function uploadRoomFile({
   file,
   signal,
   abortErrorMessage,
+  retryMultipartCompletion,
   uploadSingle,
   createMultipartUpload,
   uploadMultipartPart,
@@ -328,11 +330,11 @@ async function uploadStorageFile({
     }
     return err instanceof LiveblocksError && err.status >= 400 && err.status < 500;
   };
-  if (file.size <= STORAGE_FILE_PART_SIZE) {
+  if (file.size <= ROOM_FILE_PART_SIZE) {
     return autoRetry(
       uploadSingle,
-      STORAGE_FILE_RETRY_ATTEMPTS,
-      STORAGE_FILE_RETRY_DELAYS,
+      ROOM_FILE_RETRY_ATTEMPTS,
+      ROOM_FILE_RETRY_DELAYS,
       handleRetryError
     );
   }
@@ -340,8 +342,8 @@ async function uploadStorageFile({
   const uploadedParts = [];
   const multipartUpload = await autoRetry(
     createMultipartUpload,
-    STORAGE_FILE_RETRY_ATTEMPTS,
-    STORAGE_FILE_RETRY_DELAYS,
+    ROOM_FILE_RETRY_ATTEMPTS,
+    ROOM_FILE_RETRY_DELAYS,
     handleRetryError
   );
   const partUploadController = new AbortController();
@@ -360,7 +362,7 @@ async function uploadStorageFile({
     if (signal?.aborted) {
       throw abortError;
     }
-    const batches = chunk(splitStorageFileIntoParts(file), 5);
+    const batches = chunk(splitRoomFileIntoParts(file), 5);
     for (const parts of batches) {
       const firstPartUploadFailure = {};
       const partUploads$ = [];
@@ -373,8 +375,8 @@ async function uploadStorageFile({
               part,
               partUploadSignal
             ),
-            STORAGE_FILE_RETRY_ATTEMPTS,
-            STORAGE_FILE_RETRY_DELAYS,
+            ROOM_FILE_RETRY_ATTEMPTS,
+            ROOM_FILE_RETRY_DELAYS,
             (error) => {
               if (signal?.aborted) {
                 throw abortError;
@@ -406,12 +408,12 @@ async function uploadStorageFile({
     const sortedParts = uploadedParts.sort(
       (a, b) => a.partNumber - b.partNumber
     );
-    return autoRetry(
+    return retryMultipartCompletion ? autoRetry(
       () => completeMultipartUpload(multipartUpload.uploadId, sortedParts),
-      STORAGE_FILE_RETRY_ATTEMPTS,
-      STORAGE_FILE_RETRY_DELAYS,
+      ROOM_FILE_RETRY_ATTEMPTS,
+      ROOM_FILE_RETRY_DELAYS,
       handleRetryError
-    );
+    ) : completeMultipartUpload(uploadId, sortedParts);
   } catch (err) {
     if (uploadId) {
       try {
@@ -424,11 +426,11 @@ async function uploadStorageFile({
     signal?.removeEventListener("abort", handleExternalAbort);
   }
 }
-function splitStorageFileIntoParts(file) {
+function splitRoomFileIntoParts(file) {
   const parts = [];
   let start = 0;
   while (start < file.size) {
-    const end = Math.min(start + STORAGE_FILE_PART_SIZE, file.size);
+    const end = Math.min(start + ROOM_FILE_PART_SIZE, file.size);
     parts.push({
       partNumber: parts.length + 1,
       part: file.slice(start, end)
@@ -1352,6 +1354,7 @@ var Liveblocks = class {
    * @param params.data.userId The user ID of the user who is set to create the comment.
    * @param params.data.createdAt (optional) The date the comment is set to be created.
    * @param params.data.body The body of the comment.
+   * @param params.data.attachmentIds (optional) The attachment IDs to add to the comment.
    * @param params.data.metadata (optional) The metadata for the comment.
    * @param options.signal (optional) An abort signal to cancel the request.
    * @returns The created comment.
@@ -1377,6 +1380,7 @@ var Liveblocks = class {
    * @param params.threadId The thread ID to edit the comment in.
    * @param params.commentId The comment ID to edit.
    * @param params.data.body The body of the comment.
+   * @param params.data.attachmentIds (optional) The IDs of every attachment that should remain on the comment.
    * @param params.data.metadata (optional) The metadata for the comment. Value must be a string, boolean or number. Use null to delete a key.
    * @param params.data.editedAt (optional) The date the comment was edited.
    * @param options.signal (optional) An abort signal to cancel the request.
@@ -1389,6 +1393,7 @@ var Liveblocks = class {
       {
         body: data.body,
         editedAt: data.editedAt?.toISOString(),
+        attachmentIds: data.attachmentIds,
         metadata: data.metadata
       },
       options
@@ -1436,13 +1441,77 @@ var Liveblocks = class {
     }
     return await res.json();
   }
+  /**
+   * Uploads an attachment that can be added to a comment.
+   *
+   * @param params.roomId The room ID to upload the attachment to.
+   * @param params.userId The user ID of the user uploading the attachment.
+   * @param params.file The file to upload.
+   * @param options.signal (optional) An abort signal to cancel the upload.
+   * @returns The uploaded attachment.
+   */
+  async uploadAttachment(params, options) {
+    const { roomId, userId, file } = params;
+    const attachmentId = createCommentAttachmentId();
+    return await uploadRoomFile({
+      file,
+      signal: options?.signal,
+      abortErrorMessage: `Upload of attachment ${attachmentId} was aborted.`,
+      retryMultipartCompletion: false,
+      uploadSingle: async () => {
+        const res = await this.#putBlob(
+          url2`/v2/rooms/${roomId}/attachments/${attachmentId}/upload/${file.name}`,
+          file,
+          { fileSize: file.size, userId },
+          options
+        );
+        return await this.#readJsonResponse(res);
+      },
+      createMultipartUpload: async () => {
+        const res = await this.#post(
+          url2`/v2/rooms/${roomId}/attachments/${attachmentId}/multipart/${file.name}`,
+          void 0,
+          options,
+          { fileSize: file.size }
+        );
+        return await this.#readJsonResponse(res);
+      },
+      uploadMultipartPart: async (uploadId, partNumber, part, signal) => {
+        const res = await this.#putBlob(
+          url2`/v2/rooms/${roomId}/attachments/${attachmentId}/multipart/${uploadId}/${String(partNumber)}`,
+          part,
+          void 0,
+          { signal }
+        );
+        return await this.#readJsonResponse(res);
+      },
+      completeMultipartUpload: async (uploadId, parts) => {
+        const res = await this.#post(
+          url2`/v2/rooms/${roomId}/attachments/${attachmentId}/multipart/${uploadId}/complete`,
+          { parts },
+          options,
+          { userId }
+        );
+        return await this.#readJsonResponse(res);
+      },
+      abortMultipartUpload: async (uploadId) => {
+        const res = await this.#delete(
+          url2`/v2/rooms/${roomId}/attachments/${attachmentId}/multipart/${uploadId}`
+        );
+        if (!res.ok) {
+          throw await LiveblocksError.from(res);
+        }
+      }
+    });
+  }
   async uploadFile(params, options) {
     const { roomId, file } = params;
     const fileId = createStorageFileId();
-    const fileData = await uploadStorageFile({
+    const fileData = await uploadRoomFile({
       file,
       signal: options?.signal,
       abortErrorMessage: `Upload of file ${fileId} was aborted.`,
+      retryMultipartCompletion: true,
       uploadSingle: async () => {
         const res = await this.#putBlob(
           url2`/v2/rooms/${roomId}/storage/files/${fileId}/upload/${file.name}`,
@@ -1511,6 +1580,7 @@ var Liveblocks = class {
    * @param params.thread.comment.userId The user ID of the user who created the comment.
    * @param params.thread.comment.createdAt (optional) The date the comment was created.
    * @param params.thread.comment.body The body of the comment.
+   * @param params.thread.comment.attachmentIds (optional) The attachment IDs to add to the comment.
    * @param params.thread.comment.metadata (optional) The metadata for the comment.
    * @param options.signal (optional) An abort signal to cancel the request.
    * @returns The created thread. The thread will be created with the specified comment as its first comment.