@liveblocks/node 2.17.0-rc1 → 2.17.0-usrnotsettings2

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS } 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 { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS, NotificationChannel } 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, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
@@ -755,6 +755,29 @@ declare class Liveblocks {
     deleteAllInboxNotifications(params: {
         userId: string;
     }): Promise<void>;
+    /**
+     * Get notification settings for a user for a project.
+     * @param params.userId The user ID to get the notifications settings for.
+     */
+    getNotificationSettings(params: {
+        userId: string;
+    }): Promise<UserNotificationSettings>;
+    /**
+     * Update the user's notification settings.
+     * @param params.userId The user ID to update the notification settings for.
+     * @param params.data The new notification settings for the user.
+     */
+    updateNotificationSettings(params: {
+        userId: string;
+        data: PartialUserNotificationSettings;
+    }): Promise<UserNotificationSettings>;
+    /**
+     * Delete the user's notification settings
+     * @param params.userId The user ID to update the notification settings for.
+     */
+    deleteNotificationSettings(params: {
+        userId: string;
+    }): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     status: number;
@@ -1027,7 +1050,7 @@ type ThreadMarkedAsUnresolvedEvent = {
 type ThreadNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: "thread";
         projectId: string;
         roomId: string;
@@ -1044,7 +1067,7 @@ type ThreadNotificationEvent = {
 type TextMentionNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: "textMention";
         projectId: string;
         roomId: string;
@@ -1058,11 +1081,10 @@ type TextMentionNotificationEvent = {
         createdAt: string;
     };
 };
-type CustomKind = `$${string}`;
 type CustomNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: CustomKind;
         projectId: string;
         roomId: string | null;
@@ -1100,6 +1122,17 @@ declare function isThreadNotificationEvent(event: WebhookEvent): event is Thread
  * @returns A boolean type predicate.
  */
 declare function isTextMentionNotificationEvent(event: WebhookEvent): event is TextMentionNotificationEvent;
+/**
+ * Type guard to check if a webhook event is a `CustomNotificationEvent`
+ *
+ * The check is made against the event type and event data kind.
+ * You should use this guard to safely check the webhook event you received
+ * when you're expecting a `CustomNotificationEvent`.
+ *
+ * @param event The webhook event received after calling `webhookHandler.verifyRequest()`.
+ * @returns A boolean type predicate.
+ */
+declare function isCustomNotificationEvent(event: WebhookEvent): event is CustomNotificationEvent;
 
 /**
  * @deprecated RoomInfo was renamed to RoomData, to avoid
@@ -1108,4 +1141,4 @@ declare function isTextMentionNotificationEvent(event: WebhookEvent): event is T
  */
 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 ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+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, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS } 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 { BaseUserMeta, DU, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, DS, NotificationChannel } 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, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
 declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
@@ -755,6 +755,29 @@ declare class Liveblocks {
     deleteAllInboxNotifications(params: {
         userId: string;
     }): Promise<void>;
+    /**
+     * Get notification settings for a user for a project.
+     * @param params.userId The user ID to get the notifications settings for.
+     */
+    getNotificationSettings(params: {
+        userId: string;
+    }): Promise<UserNotificationSettings>;
+    /**
+     * Update the user's notification settings.
+     * @param params.userId The user ID to update the notification settings for.
+     * @param params.data The new notification settings for the user.
+     */
+    updateNotificationSettings(params: {
+        userId: string;
+        data: PartialUserNotificationSettings;
+    }): Promise<UserNotificationSettings>;
+    /**
+     * Delete the user's notification settings
+     * @param params.userId The user ID to update the notification settings for.
+     */
+    deleteNotificationSettings(params: {
+        userId: string;
+    }): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     status: number;
@@ -1027,7 +1050,7 @@ type ThreadMarkedAsUnresolvedEvent = {
 type ThreadNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: "thread";
         projectId: string;
         roomId: string;
@@ -1044,7 +1067,7 @@ type ThreadNotificationEvent = {
 type TextMentionNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: "textMention";
         projectId: string;
         roomId: string;
@@ -1058,11 +1081,10 @@ type TextMentionNotificationEvent = {
         createdAt: string;
     };
 };
-type CustomKind = `$${string}`;
 type CustomNotificationEvent = {
     type: "notification";
     data: {
-        channel: "email";
+        channel: NotificationChannel;
         kind: CustomKind;
         projectId: string;
         roomId: string | null;
@@ -1100,6 +1122,17 @@ declare function isThreadNotificationEvent(event: WebhookEvent): event is Thread
  * @returns A boolean type predicate.
  */
 declare function isTextMentionNotificationEvent(event: WebhookEvent): event is TextMentionNotificationEvent;
+/**
+ * Type guard to check if a webhook event is a `CustomNotificationEvent`
+ *
+ * The check is made against the event type and event data kind.
+ * You should use this guard to safely check the webhook event you received
+ * when you're expecting a `CustomNotificationEvent`.
+ *
+ * @param event The webhook event received after calling `webhookHandler.verifyRequest()`.
+ * @returns A boolean type predicate.
+ */
+declare function isCustomNotificationEvent(event: WebhookEvent): event is CustomNotificationEvent;
 
 /**
  * @deprecated RoomInfo was renamed to RoomData, to avoid
@@ -1108,4 +1141,4 @@ declare function isTextMentionNotificationEvent(event: WebhookEvent): event is T
  */
 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 ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UserEnteredEvent, type UserLeftEvent, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+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, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

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.17.0-rc1";
+var PKG_VERSION = "2.17.0-usrnotsettings2";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -1201,6 +1201,50 @@ var Liveblocks = class {
       throw new LiveblocksError(res.status, text);
     }
   }
+  /**
+   * Get notification settings for a user for a project.
+   * @param params.userId The user ID to get the notifications settings for.
+   */
+  async getNotificationSettings(params) {
+    const { userId } = params;
+    const res = await this.#get(_core.url`/v2/users/${userId}/notification-settings`);
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return await res.json();
+  }
+  /**
+   * Update the user's notification settings.
+   * @param params.userId The user ID to update the notification settings for.
+   * @param params.data The new notification settings for the user.
+   */
+  async updateNotificationSettings(params) {
+    const { userId, data } = params;
+    const res = await this.#post(
+      _core.url`/v2/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 notification settings
+   * @param params.userId The user ID to update the notification settings for.
+   */
+  async deleteNotificationSettings(params) {
+    const { userId } = params;
+    const res = await this.#delete(
+      _core.url`/v2/users/${userId}/notification-settings`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
 };
 var LiveblocksError = class extends Error {
   
@@ -1325,11 +1369,11 @@ var WebhookHandler = class _WebhookHandler {
     ].includes(event.type)) {
       if (event.type === "notification") {
         const notification = event;
-        if (notification.data.kind === "thread" || notification.data.kind === "textMention" || notification.data.kind.startsWith("$")) {
+        if (notification.data.kind === "thread" || notification.data.kind === "textMention" || isCustomKind(notification.data.kind)) {
           return;
         } else {
           throw new Error(
-            `Unknown notification kind: ${notification.data.kind}`
+            `Unknown notification kind: ${JSON.stringify(notification.data.kind)}`
           );
         }
       }
@@ -1342,18 +1386,25 @@ var WebhookHandler = class _WebhookHandler {
 };
 var WEBHOOK_TOLERANCE_IN_SECONDS = 5 * 60;
 var isNotUndefined = (value) => value !== void 0;
+var isCustomKind = (value) => {
+  return isString(value) && value.startsWith("$");
+};
 function isThreadNotificationEvent(event) {
   return event.type === "notification" && event.data.kind === "thread";
 }
 function isTextMentionNotificationEvent(event) {
   return event.type === "notification" && event.data.kind === "textMention";
 }
+function isCustomNotificationEvent(event) {
+  return event.type === "notification" && isCustomKind(event.data.kind);
+}
 
 // src/index.ts
 
 
 
 
+
 _core.detectDupes.call(void 0, PKG_NAME, PKG_VERSION, PKG_FORMAT);
 
 
@@ -1363,5 +1414,7 @@ _core.detectDupes.call(void 0, PKG_NAME, PKG_VERSION, PKG_FORMAT);
 
 
 
-exports.Liveblocks = Liveblocks; exports.LiveblocksError = LiveblocksError; exports.WebhookHandler = WebhookHandler; exports.getMentionedIdsFromCommentBody = _core.getMentionedIdsFromCommentBody; exports.isTextMentionNotificationEvent = isTextMentionNotificationEvent; exports.isThreadNotificationEvent = isThreadNotificationEvent; exports.stringifyCommentBody = _core.stringifyCommentBody;
+
+
+exports.Liveblocks = Liveblocks; exports.LiveblocksError = LiveblocksError; exports.WebhookHandler = WebhookHandler; exports.getMentionedIdsFromCommentBody = _core.getMentionedIdsFromCommentBody; exports.isCustomNotificationEvent = isCustomNotificationEvent; exports.isNotificationChannelEnabled = _core.isNotificationChannelEnabled; exports.isTextMentionNotificationEvent = isTextMentionNotificationEvent; exports.isThreadNotificationEvent = isThreadNotificationEvent; exports.stringifyCommentBody = _core.stringifyCommentBody;
 //# sourceMappingURL=index.js.map