@liveblocks/node 2.1.1-test1 → 2.2.0

package/dist/index.d.mts

@@ -432,7 +432,7 @@ declare class Liveblocks {
          * @example
          * ```
          * {
-         *   query: "metadata['organization']^'liveblocks:' AND metadata['status']:'open' AND metadata['resolved']:false AND metadata['priority']:3"
+         *   query: "metadata['organization']^'liveblocks:' AND metadata['status']:'open' AND metadata['pinned']:false AND metadata['priority']:3 AND resolved:true"
          * }
          * ```
          * @example
@@ -441,18 +441,20 @@ declare class Liveblocks {
          *   query: {
          *     metadata: {
          *       status: "open",
-         *       resolved: false,
+         *       pinned: false,
          *       priority: 3,
          *       organization: {
          *         startsWith: "liveblocks:"
          *       }
-         *     }
+         *     },
+         *     resolved: true
          *   }
          * }
          * ```
          */
         query?: string | {
             metadata?: Partial<QueryMetadata<M>>;
+            resolved?: boolean;
         };
     }): Promise<{
         data: ThreadData<M>[];
@@ -563,6 +565,34 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
     }): Promise<void>;
+    /**
+     * Mark a thread as resolved.
+     * @param params.roomId The room ID of the thread.
+     * @param params.threadId The thread ID to mark as resolved.
+     * @param params.data.userId The user ID of the user who marked the thread as resolved.
+     * @returns The thread marked as resolved.
+     */
+    markThreadAsResolved(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }): Promise<ThreadData<M>>;
+    /**
+     * Mark a thread as unresolved.
+     * @param params.roomId The room ID of the thread.
+     * @param params.threadId The thread ID to mark as unresolved.
+     * @param params.data.userId The user ID of the user who marked the thread as unresolved.
+     * @returns The thread marked as unresolved.
+     */
+    markThreadAsUnresolved(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }): Promise<ThreadData<M>>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -570,7 +600,7 @@ declare class Liveblocks {
      * @param params.data.metadata The metadata for the thread. Value must be a string, boolean or number
      * @param params.data.userId The user ID of the user who updated the thread.
      * @param params.data.updatedAt (optional) The date the thread is set to be updated.
-     * @returns The updated thread.
+     * @returns The updated thread metadata.
      */
     editThreadMetadata(params: {
         roomId: string;
@@ -736,7 +766,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | ThreadMarkedAsResolvedEvent | ThreadMarkedAsUnresolvedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -935,6 +965,34 @@ declare type ThreadDeletedEvent = {
         deletedAt: string;
     };
 };
+declare type ThreadMarkedAsResolvedEvent = {
+    type: "threadMarkedAsResolved";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        updatedAt: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedBy: string;
+    };
+};
+declare type ThreadMarkedAsUnresolvedEvent = {
+    type: "threadMarkedAsUnresolved";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        updatedAt: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedBy: string;
+    };
+};
 declare type ThreadNotificationEvent = {
     type: "notification";
     data: {
@@ -996,4 +1054,4 @@ declare type NotificationEvent = ThreadNotificationEvent | TextMentionNotificati
  */
 declare type RoomInfo = RoomData;
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent };

package/dist/index.d.ts

@@ -432,7 +432,7 @@ declare class Liveblocks {
          * @example
          * ```
          * {
-         *   query: "metadata['organization']^'liveblocks:' AND metadata['status']:'open' AND metadata['resolved']:false AND metadata['priority']:3"
+         *   query: "metadata['organization']^'liveblocks:' AND metadata['status']:'open' AND metadata['pinned']:false AND metadata['priority']:3 AND resolved:true"
          * }
          * ```
          * @example
@@ -441,18 +441,20 @@ declare class Liveblocks {
          *   query: {
          *     metadata: {
          *       status: "open",
-         *       resolved: false,
+         *       pinned: false,
          *       priority: 3,
          *       organization: {
          *         startsWith: "liveblocks:"
          *       }
-         *     }
+         *     },
+         *     resolved: true
          *   }
          * }
          * ```
          */
         query?: string | {
             metadata?: Partial<QueryMetadata<M>>;
+            resolved?: boolean;
         };
     }): Promise<{
         data: ThreadData<M>[];
@@ -563,6 +565,34 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
     }): Promise<void>;
+    /**
+     * Mark a thread as resolved.
+     * @param params.roomId The room ID of the thread.
+     * @param params.threadId The thread ID to mark as resolved.
+     * @param params.data.userId The user ID of the user who marked the thread as resolved.
+     * @returns The thread marked as resolved.
+     */
+    markThreadAsResolved(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }): Promise<ThreadData<M>>;
+    /**
+     * Mark a thread as unresolved.
+     * @param params.roomId The room ID of the thread.
+     * @param params.threadId The thread ID to mark as unresolved.
+     * @param params.data.userId The user ID of the user who marked the thread as unresolved.
+     * @returns The thread marked as unresolved.
+     */
+    markThreadAsUnresolved(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }): Promise<ThreadData<M>>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -570,7 +600,7 @@ declare class Liveblocks {
      * @param params.data.metadata The metadata for the thread. Value must be a string, boolean or number
      * @param params.data.userId The user ID of the user who updated the thread.
      * @param params.data.updatedAt (optional) The date the thread is set to be updated.
-     * @returns The updated thread.
+     * @returns The updated thread metadata.
      */
     editThreadMetadata(params: {
         roomId: string;
@@ -736,7 +766,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | ThreadMarkedAsResolvedEvent | ThreadMarkedAsUnresolvedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -935,6 +965,34 @@ declare type ThreadDeletedEvent = {
         deletedAt: string;
     };
 };
+declare type ThreadMarkedAsResolvedEvent = {
+    type: "threadMarkedAsResolved";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        updatedAt: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedBy: string;
+    };
+};
+declare type ThreadMarkedAsUnresolvedEvent = {
+    type: "threadMarkedAsUnresolved";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        updatedAt: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedBy: string;
+    };
+};
 declare type ThreadNotificationEvent = {
     type: "notification";
     data: {
@@ -996,4 +1054,4 @@ declare type NotificationEvent = ThreadNotificationEvent | TextMentionNotificati
  */
 declare type RoomInfo = RoomData;
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CustomNotificationEvent, Liveblocks, LiveblocksError, type LiveblocksOptions, type NotificationEvent, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent };

package/dist/index.js

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "2.1.1-test1";
+var PKG_VERSION = "2.2.0";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -943,6 +943,44 @@ var Liveblocks = class {
       throw new LiveblocksError(res.status, text);
     }
   }
+  /**
+   * Mark a thread as resolved.
+   * @param params.roomId The room ID of the thread.
+   * @param params.threadId The thread ID to mark as resolved.
+   * @param params.data.userId The user ID of the user who marked the thread as resolved.
+   * @returns The thread marked as resolved.
+   */
+  async markThreadAsResolved(params) {
+    const { roomId, threadId } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/mark-as-resolved`,
+      {}
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return _core.convertToThreadData.call(void 0, await res.json());
+  }
+  /**
+   * Mark a thread as unresolved.
+   * @param params.roomId The room ID of the thread.
+   * @param params.threadId The thread ID to mark as unresolved.
+   * @param params.data.userId The user ID of the user who marked the thread as unresolved.
+   * @returns The thread marked as unresolved.
+   */
+  async markThreadAsUnresolved(params) {
+    const { roomId, threadId } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/mark-as-unresolved`,
+      {}
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return _core.convertToThreadData.call(void 0, await res.json());
+  }
   /**
    * Updates the metadata of the specified thread in a room.
    * @param params.roomId The room ID to update the thread in.
@@ -950,7 +988,7 @@ var Liveblocks = class {
    * @param params.data.metadata The metadata for the thread. Value must be a string, boolean or number
    * @param params.data.userId The user ID of the user who updated the thread.
    * @param params.data.updatedAt (optional) The date the thread is set to be updated.
-   * @returns The updated thread.
+   * @returns The updated thread metadata.
    */
   async editThreadMetadata(params) {
     const { roomId, threadId, data } = params;
@@ -1229,7 +1267,9 @@ var _WebhookHandler = class _WebhookHandler {
       "threadCreated",
       "threadDeleted",
       "ydocUpdated",
-      "notification"
+      "notification",
+      "threadMarkedAsResolved",
+      "threadMarkedAsUnresolved"
     ].includes(event.type)) {
       if (event.type === "notification") {
         const notification = event;