@liveblocks/node 1.9.8-pre1 → 1.10.0-beta2

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction } from '@liveblocks/core';
-export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyResolveUsersArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, stringifyCommentBody } from '@liveblocks/core';
+import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings } from '@liveblocks/core';
+export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 /**
@@ -621,6 +621,44 @@ declare class Liveblocks {
             removedAt?: Date;
         };
     }): Promise<void>;
+    /**
+     * Returns the inbox notifications for a user.
+     * @param params.userId The user ID to get the inbox notifications from.
+     * @param params.inboxNotificationId The ID of the inbox notification to get.
+     */
+    getInboxNotification(params: {
+        userId: string;
+        inboxNotificationId: string;
+    }): Promise<InboxNotificationData>;
+    /**
+     * Gets the user's room notification settings.
+     * @param params.userId The user ID to get the room notifications from.
+     * @param params.roomId The room ID to get the room notification settings from.
+     */
+    getRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): Promise<RoomNotificationSettings>;
+    /**
+     * Updates the user's room notification settings.
+     * @param params.userId The user ID to update the room notification settings for.
+     * @param params.roomId The room ID to update the room notification settings for.
+     * @param params.data The new room notification settings for the user.
+     */
+    updateRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+        data: RoomNotificationSettings;
+    }): Promise<RoomNotificationSettings>;
+    /**
+     * Delete the user's room notification settings.
+     * @param params.userId The user ID to delete the room notification settings from.
+     * @param params.roomId The room ID to delete the room notification settings from.
+     */
+    deleteRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): Promise<void>;
 }
 
 declare class WebhookHandler {
@@ -679,7 +717,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | ThreadCreatedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | ThreadEmailNotificationEvent | ThreadCreatedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -860,5 +898,20 @@ declare type ThreadCreatedEvent = {
         createdBy: string;
     };
 };
+declare type ThreadEmailNotificationEvent = {
+    type: "threadEmailNotification";
+    data: {
+        projectId: string;
+        roomId: string;
+        userId: string;
+        threadId: string;
+        inboxNotificationId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        createdAt: string;
+    };
+};
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, type LiveblocksOptions, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, authorize };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, type LiveblocksOptions, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadEmailNotificationEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, authorize };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction } from '@liveblocks/core';
-export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyResolveUsersArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, stringifyCommentBody } from '@liveblocks/core';
+import { IUserInfo, Json, PlainLsonObject, JsonObject, ThreadData, BaseMetadata, CommentData, CommentBody, CommentUserReaction, InboxNotificationData, RoomNotificationSettings } from '@liveblocks/core';
+export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 /**
@@ -621,6 +621,44 @@ declare class Liveblocks {
             removedAt?: Date;
         };
     }): Promise<void>;
+    /**
+     * Returns the inbox notifications for a user.
+     * @param params.userId The user ID to get the inbox notifications from.
+     * @param params.inboxNotificationId The ID of the inbox notification to get.
+     */
+    getInboxNotification(params: {
+        userId: string;
+        inboxNotificationId: string;
+    }): Promise<InboxNotificationData>;
+    /**
+     * Gets the user's room notification settings.
+     * @param params.userId The user ID to get the room notifications from.
+     * @param params.roomId The room ID to get the room notification settings from.
+     */
+    getRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): Promise<RoomNotificationSettings>;
+    /**
+     * Updates the user's room notification settings.
+     * @param params.userId The user ID to update the room notification settings for.
+     * @param params.roomId The room ID to update the room notification settings for.
+     * @param params.data The new room notification settings for the user.
+     */
+    updateRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+        data: RoomNotificationSettings;
+    }): Promise<RoomNotificationSettings>;
+    /**
+     * Delete the user's room notification settings.
+     * @param params.userId The user ID to delete the room notification settings from.
+     * @param params.roomId The room ID to delete the room notification settings from.
+     */
+    deleteRoomNotificationSettings(params: {
+        userId: string;
+        roomId: string;
+    }): Promise<void>;
 }
 
 declare class WebhookHandler {
@@ -679,7 +717,7 @@ declare type WebhookRequest = {
      */
     rawBody: string;
 };
-declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | ThreadCreatedEvent | YDocUpdatedEvent;
+declare type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | ThreadEmailNotificationEvent | ThreadCreatedEvent | YDocUpdatedEvent;
 declare type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -860,5 +898,20 @@ declare type ThreadCreatedEvent = {
         createdBy: string;
     };
 };
+declare type ThreadEmailNotificationEvent = {
+    type: "threadEmailNotification";
+    data: {
+        projectId: string;
+        roomId: string;
+        userId: string;
+        threadId: string;
+        inboxNotificationId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        createdAt: string;
+    };
+};
 
-export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, type LiveblocksOptions, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, authorize };
+export { type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, Liveblocks, type LiveblocksOptions, type RoomAccesses, type RoomCreatedEvent, type RoomDeletedEvent, type RoomInfo, type RoomPermission, type RoomUser, type Schema, type StorageUpdatedEvent, type ThreadCreatedEvent, type ThreadEmailNotificationEvent, type ThreadMetadataUpdatedEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, authorize };

package/dist/index.js

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "1.9.8-pre1";
+var PKG_VERSION = "1.10.0-beta2";
 var PKG_FORMAT = "cjs";
 
 // src/utils.ts
@@ -1015,6 +1015,76 @@ var Liveblocks = class {
       throw new LiveblocksError(res.status, text);
     }
   }
+  /**
+   * Returns the inbox notifications for a user.
+   * @param params.userId The user ID to get the inbox notifications from.
+   * @param params.inboxNotificationId The ID of the inbox notification to get.
+   */
+  async getInboxNotification(params) {
+    const { userId, inboxNotificationId } = params;
+    const res = await this.get(
+      url`/v2/users/${userId}/inbox-notifications/${inboxNotificationId}`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    const data = await res.json();
+    return {
+      ...data,
+      notifiedAt: new Date(data.notifiedAt),
+      readAt: data.readAt ? new Date(data.readAt) : null
+    };
+  }
+  /**
+   * Gets the user's room notification settings.
+   * @param params.userId The user ID to get the room notifications from.
+   * @param params.roomId The room ID to get the room notification settings from.
+   */
+  async getRoomNotificationSettings(params) {
+    const { userId, roomId } = params;
+    const res = await this.get(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return await res.json();
+  }
+  /**
+   * Updates the user's room notification settings.
+   * @param params.userId The user ID to update the room notification settings for.
+   * @param params.roomId The room ID to update the room notification settings for.
+   * @param params.data The new room notification settings for the user.
+   */
+  async updateRoomNotificationSettings(params) {
+    const { userId, roomId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      data
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return await res.json();
+  }
+  /**
+   * Delete the user's room notification settings.
+   * @param params.userId The user ID to delete the room notification settings from.
+   * @param params.roomId The room ID to delete the room notification settings from.
+   */
+  async deleteRoomNotificationSettings(params) {
+    const { userId, roomId } = params;
+    const res = await this.delete(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
 };
 var LiveblocksError = class extends Error {
   constructor(status, message = "") {
@@ -1129,6 +1199,7 @@ var _WebhookHandler = class _WebhookHandler {
       "commentReactionAdded",
       "commentReactionRemoved",
       "threadMetadataUpdated",
+      "threadEmailNotification",
       "threadCreated",
       "ydocUpdated"
     ].includes(event.type))