@liveblocks/core 2.23.1 → 2.24.0-sub1

package/dist/index.cjs

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.23.1";
+var PKG_VERSION = "2.24.0-sub1";
 var PKG_FORMAT = "cjs";
 
 // src/dupe-detection.ts
@@ -118,6 +118,13 @@ function convertToInboxNotificationData(data) {
     readAt
   };
 }
+function convertToSubscriptionData(data) {
+  const createdAt = new Date(data.createdAt);
+  return {
+    ...data,
+    createdAt
+  };
+}
 function convertToThreadDeleteInfo(data) {
   const deletedAt = new Date(data.deletedAt);
   return {
@@ -132,6 +139,13 @@ function convertToInboxNotificationDeleteInfo(data) {
     deletedAt
   };
 }
+function convertToSubscriptionDeleteInfo(data) {
+  const deletedAt = new Date(data.deletedAt);
+  return {
+    ...data,
+    deletedAt
+  };
+}
 
 // src/lib/fancy-console.ts
 var fancy_console_exports = {};
@@ -1115,6 +1129,12 @@ function createApiClient({
           convertToInboxNotificationDeleteInfo
         )
       },
+      subscriptions: {
+        updated: result.subscriptions.map(convertToSubscriptionData),
+        deleted: result.deletedSubscriptions.map(
+          convertToSubscriptionDeleteInfo
+        )
+      },
       requestedAt: new Date(result.meta.requestedAt),
       permissionHints: result.meta.permissionHints
     };
@@ -1143,6 +1163,7 @@ function createApiClient({
         inboxNotifications: result.inboxNotifications.map(
           convertToInboxNotificationData
         ),
+        subscriptions: result.subscriptions.map(convertToSubscriptionData),
         nextCursor: result.meta.nextCursor,
         requestedAt: new Date(result.meta.requestedAt),
         permissionHints: result.meta.permissionHints
@@ -1152,6 +1173,7 @@ function createApiClient({
         return {
           threads: [],
           inboxNotifications: [],
+          subscriptions: [],
           nextCursor: null,
           //
           // HACK
@@ -1210,12 +1232,14 @@ function createApiClient({
       const json = await response.json();
       return {
         thread: convertToThreadData(json.thread),
-        inboxNotification: json.inboxNotification ? convertToInboxNotificationData(json.inboxNotification) : void 0
+        inboxNotification: json.inboxNotification ? convertToInboxNotificationData(json.inboxNotification) : void 0,
+        subscription: json.subscription ? convertToSubscriptionData(json.subscription) : void 0
       };
     } else if (response.status === 404) {
       return {
         thread: void 0,
-        inboxNotification: void 0
+        inboxNotification: void 0,
+        subscription: void 0
       };
     } else {
       throw new Error(
@@ -1310,6 +1334,25 @@ function createApiClient({
       })
     );
   }
+  async function subscribeToThread(options) {
+    const subscription = await httpClient.post(
+      url`/v2/c/rooms/${options.roomId}/threads/${options.threadId}/subscribe`,
+      await authManager.getAuthValue({
+        requestedScope: "comments:read",
+        roomId: options.roomId
+      })
+    );
+    return convertToSubscriptionData(subscription);
+  }
+  async function unsubscribeFromThread(options) {
+    await httpClient.post(
+      url`/v2/c/rooms/${options.roomId}/threads/${options.threadId}/unsubscribe`,
+      await authManager.getAuthValue({
+        requestedScope: "comments:read",
+        roomId: options.roomId
+      })
+    );
+  }
   async function uploadAttachment(options) {
     const roomId = options.roomId;
     const abortSignal = options.signal;
@@ -1480,9 +1523,9 @@ function createApiClient({
     const batch2 = getOrCreateAttachmentUrlsStore(options.roomId).batch;
     return batch2.get(options.attachmentId);
   }
-  async function getNotificationSettings(options) {
+  async function getSubscriptionSettings(options) {
     return httpClient.get(
-      url`/v2/c/rooms/${options.roomId}/notification-settings`,
+      url`/v2/c/rooms/${options.roomId}/subscription-settings`,
       await authManager.getAuthValue({
         requestedScope: "comments:read",
         roomId: options.roomId
@@ -1493,9 +1536,9 @@ function createApiClient({
       }
     );
   }
-  async function updateNotificationSettings(options) {
+  async function updateSubscriptionSettings(options) {
     return httpClient.post(
-      url`/v2/c/rooms/${options.roomId}/notification-settings`,
+      url`/v2/c/rooms/${options.roomId}/subscription-settings`,
       await authManager.getAuthValue({
         requestedScope: "comments:read",
         roomId: options.roomId
@@ -1676,6 +1719,7 @@ function createApiClient({
         convertToInboxNotificationData
       ),
       threads: json.threads.map(convertToThreadData),
+      subscriptions: json.subscriptions.map(convertToSubscriptionData),
       nextCursor: json.meta.nextCursor,
       requestedAt: new Date(json.meta.requestedAt)
     };
@@ -1698,6 +1742,10 @@ function createApiClient({
         updated: json.threads.map(convertToThreadData),
         deleted: json.deletedThreads.map(convertToThreadDeleteInfo)
       },
+      subscriptions: {
+        updated: json.subscriptions.map(convertToSubscriptionData),
+        deleted: json.deletedSubscriptions.map(convertToSubscriptionDeleteInfo)
+      },
       requestedAt: new Date(json.meta.requestedAt)
     };
   }
@@ -1749,7 +1797,7 @@ function createApiClient({
       await authManager.getAuthValue({ requestedScope: "comments:read" })
     );
   }
-  async function getUserNotificationSettings(options) {
+  async function getNotificationSettings(options) {
     return httpClient.get(
       url`/v2/c/notification-settings`,
       await authManager.getAuthValue({ requestedScope: "comments:read" }),
@@ -1757,7 +1805,7 @@ function createApiClient({
       { signal: _optionalChain([options, 'optionalAccess', _18 => _18.signal]) }
     );
   }
-  async function updateUserNotificationSettings(settings) {
+  async function updateNotificationSettings(settings) {
     return httpClient.post(
       url`/v2/c/notification-settings`,
       await authManager.getAuthValue({ requestedScope: "comments:read" }),
@@ -1784,6 +1832,7 @@ function createApiClient({
       inboxNotifications: json.inboxNotifications.map(
         convertToInboxNotificationData
       ),
+      subscriptions: json.subscriptions.map(convertToSubscriptionData),
       nextCursor: json.meta.nextCursor,
       requestedAt: new Date(json.meta.requestedAt),
       permissionHints: json.meta.permissionHints
@@ -1807,6 +1856,10 @@ function createApiClient({
           convertToInboxNotificationDeleteInfo
         )
       },
+      subscriptions: {
+        updated: json.subscriptions.map(convertToSubscriptionData),
+        deleted: json.deletedSubscriptions.map(convertToSubscriptionDeleteInfo)
+      },
       requestedAt: new Date(json.meta.requestedAt),
       permissionHints: json.meta.permissionHints
     };
@@ -1826,10 +1879,12 @@ function createApiClient({
     removeReaction,
     markThreadAsResolved,
     markThreadAsUnresolved,
+    subscribeToThread,
+    unsubscribeFromThread,
     markRoomInboxNotificationAsRead,
-    // Room notifications
-    getNotificationSettings,
-    updateNotificationSettings,
+    // Room subscription settings
+    getSubscriptionSettings,
+    updateSubscriptionSettings,
     // Room text editor
     createTextMention,
     deleteTextMention,
@@ -1845,7 +1900,7 @@ function createApiClient({
     // Room storage
     streamStorage,
     sendMessages,
-    // Notification
+    // Notifications
     getInboxNotifications,
     getInboxNotificationsSince,
     getUnreadInboxNotificationsCount,
@@ -1853,8 +1908,8 @@ function createApiClient({
     markInboxNotificationAsRead,
     deleteAllInboxNotifications,
     deleteInboxNotification,
-    getUserNotificationSettings,
-    updateUserNotificationSettings,
+    getNotificationSettings,
+    updateNotificationSettings,
     // User threads
     getUserThreads_experimental,
     getUserThreadsSince_experimental,
@@ -3603,9 +3658,9 @@ function unlinkDevTools(roomId) {
   });
 }
 
-// src/protocol/UserNotificationSettings.ts
-var kPlain = Symbol("user-notification-settings-plain");
-function createUserNotificationSettings(plain) {
+// src/protocol/NotificationSettings.ts
+var kPlain = Symbol("notification-settings-plain");
+function createNotificationSettings(plain) {
   const channels = [
     "email",
     "slack",
@@ -3629,8 +3684,8 @@ function createUserNotificationSettings(plain) {
        * no enforced shape for ⁠this. And so the standard library definitions have to remain as broad as possible
        * to support any valid JavaScript usage (e.g `Object.defineProperty`).
        *
-       * So we can safely tells that this getter is typed as `this: UserNotificationSettings` because we're
-       * creating a well known shaped object → `UserNotificationSettings`.
+       * So we can safely tells that this getter is typed as `this: NotificationSettings` because we're
+       * creating a well known shaped object → `NotificationSettings`.
        */
       get() {
         const value = this[kPlain][channel];
@@ -3646,8 +3701,8 @@ function createUserNotificationSettings(plain) {
   }
   return create(null, descriptors);
 }
-function patchUserNotificationSettings(existing, patch) {
-  const outcoming = createUserNotificationSettings({
+function patchNotificationSettings(existing, patch) {
+  const outcoming = createNotificationSettings({
     ...existing[kPlain]
   });
   for (const channel of keys(patch)) {
@@ -6509,6 +6564,10 @@ function defaultMessageFromContext(context) {
       return "Could not mark thread as resolved";
     case "MARK_THREAD_AS_UNRESOLVED_ERROR":
       return "Could not mark thread as unresolved";
+    case "SUBSCRIBE_TO_THREAD_ERROR":
+      return "Could not subscribe to thread";
+    case "UNSUBSCRIBE_FROM_THREAD_ERROR":
+      return "Could not unsubscribe from thread";
     case "CREATE_COMMENT_ERROR":
       return "Could not create new comment";
     case "EDIT_COMMENT_ERROR":
@@ -6529,8 +6588,10 @@ function defaultMessageFromContext(context) {
       return "Could not delete all inbox notifications";
     case "UPDATE_NOTIFICATION_SETTINGS_ERROR":
       return "Could not update notification settings";
+    case "UPDATE_ROOM_SUBSCRIPTION_SETTINGS_ERROR":
+      return "Could not update room subscription settings";
     case "UPDATE_USER_NOTIFICATION_SETTINGS_ERROR":
-      return "Could not update user notification settings";
+      return "Could not update notification settings";
     default:
       return assertNever(context, "Unhandled case");
   }
@@ -7717,6 +7778,12 @@ ${Array.from(traces).join("\n\n")}`
       threadId
     });
   }
+  async function subscribeToThread(threadId) {
+    return httpClient.subscribeToThread({ roomId, threadId });
+  }
+  async function unsubscribeFromThread(threadId) {
+    return httpClient.unsubscribeFromThread({ roomId, threadId });
+  }
   async function createComment(options2) {
     return httpClient.createComment({
       roomId,
@@ -7781,14 +7848,14 @@ ${Array.from(traces).join("\n\n")}`
   function getAttachmentUrl(attachmentId) {
     return httpClient.getAttachmentUrl({ roomId, attachmentId });
   }
-  function getNotificationSettings(options2) {
-    return httpClient.getNotificationSettings({
+  function getSubscriptionSettings(options2) {
+    return httpClient.getSubscriptionSettings({
       roomId,
       signal: _optionalChain([options2, 'optionalAccess', _158 => _158.signal])
     });
   }
-  function updateNotificationSettings(settings) {
-    return httpClient.updateNotificationSettings({ roomId, settings });
+  function updateSubscriptionSettings(settings) {
+    return httpClient.updateSubscriptionSettings({ roomId, settings });
   }
   async function markInboxNotificationAsRead(inboxNotificationId) {
     await httpClient.markRoomInboxNotificationAsRead({
@@ -7915,6 +7982,8 @@ ${Array.from(traces).join("\n\n")}`
       editThreadMetadata,
       markThreadAsResolved,
       markThreadAsUnresolved,
+      subscribeToThread,
+      unsubscribeFromThread,
       createComment,
       editComment,
       deleteComment,
@@ -7924,8 +7993,10 @@ ${Array.from(traces).join("\n\n")}`
       uploadAttachment,
       getAttachmentUrl,
       // Notifications
-      getNotificationSettings,
-      updateNotificationSettings,
+      getNotificationSettings: getSubscriptionSettings,
+      getSubscriptionSettings,
+      updateNotificationSettings: updateSubscriptionSettings,
+      updateSubscriptionSettings,
       markInboxNotificationAsRead
     },
     // Explictly make the internal field non-enumerable, to avoid aggressive
@@ -8275,13 +8346,13 @@ function createClient(options) {
     _optionalChain([win, 'optionalAccess', _185 => _185.addEventListener, 'call', _186 => _186("beforeunload", maybePreventClose)]);
   }
   async function getNotificationSettings(options2) {
-    const plainSettings = await httpClient.getUserNotificationSettings(options2);
-    const settings = createUserNotificationSettings(plainSettings);
+    const plainSettings = await httpClient.getNotificationSettings(options2);
+    const settings = createNotificationSettings(plainSettings);
     return settings;
   }
   async function updateNotificationSettings(settings) {
-    const plainSettings = await httpClient.updateUserNotificationSettings(settings);
-    const settingsObject = createUserNotificationSettings(plainSettings);
+    const plainSettings = await httpClient.updateNotificationSettings(settings);
+    const settingsObject = createNotificationSettings(plainSettings);
     return settingsObject;
   }
   const client = Object.defineProperty(
@@ -8297,7 +8368,7 @@ function createClient(options) {
       markInboxNotificationAsRead: httpClient.markInboxNotificationAsRead,
       deleteAllInboxNotifications: httpClient.deleteAllInboxNotifications,
       deleteInboxNotification: httpClient.deleteInboxNotification,
-      // Public user notification settings API
+      // Public notification settings API
       getNotificationSettings,
       updateNotificationSettings,
       // Advanced resolvers APIs
@@ -9166,6 +9237,9 @@ function makePoller(callback, intervalMs, options) {
       fsm.send({ type: "POLL" });
     }
   }
+  function markAsStale() {
+    context.lastSuccessfulPollAt = performance.now() - maxStaleTimeMs - 1;
+  }
   function setInForeground(inForeground) {
     context.inForeground = inForeground;
     startOrStop();
@@ -9182,6 +9256,7 @@ function makePoller(callback, intervalMs, options) {
     inc,
     dec,
     pollNowIfStale,
+    markAsStale,
     // Internal API, used by unit tests only to simulate visibility events
     setInForeground
   };
@@ -9298,6 +9373,14 @@ var SortedList = class _SortedList {
   }
 };
 
+// src/protocol/Subscriptions.ts
+function getSubscriptionKey(subscription, subjectId) {
+  if (typeof subscription === "string") {
+    return `${subscription}:${subjectId}`;
+  }
+  return `${subscription.kind}:${subscription.subjectId}`;
+}
+
 // src/types/Others.ts
 var TextEditorType = /* @__PURE__ */ ((TextEditorType2) => {
   TextEditorType2["Lexical"] = "lexical";
@@ -9404,5 +9487,6 @@ var NotificationsApiError = HttpError;
 
 
 
-exports.ClientMsgCode = ClientMsgCode; exports.CommentsApiError = CommentsApiError; exports.CrdtType = CrdtType; exports.DefaultMap = DefaultMap; exports.DerivedSignal = DerivedSignal; exports.HttpError = HttpError; exports.LiveList = LiveList; exports.LiveMap = LiveMap; exports.LiveObject = LiveObject; exports.LiveblocksError = LiveblocksError; exports.MutableSignal = MutableSignal; exports.NotificationsApiError = NotificationsApiError; exports.OpCode = OpCode; exports.Permission = Permission; exports.Promise_withResolvers = Promise_withResolvers; exports.ServerMsgCode = ServerMsgCode; exports.Signal = Signal; exports.SortedList = SortedList; exports.TextEditorType = TextEditorType; exports.WebsocketCloseCodes = WebsocketCloseCodes; exports.ackOp = ackOp; exports.asPos = asPos; exports.assert = assert; exports.assertNever = assertNever; exports.autoRetry = autoRetry; exports.b64decode = b64decode; exports.batch = batch; exports.checkBounds = checkBounds; exports.chunk = chunk; exports.cloneLson = cloneLson; exports.compactObject = compactObject; exports.console = fancy_console_exports; exports.convertToCommentData = convertToCommentData; exports.convertToCommentUserReaction = convertToCommentUserReaction; exports.convertToInboxNotificationData = convertToInboxNotificationData; exports.convertToThreadData = convertToThreadData; exports.createClient = createClient; exports.createCommentAttachmentId = createCommentAttachmentId; exports.createCommentId = createCommentId; exports.createInboxNotificationId = createInboxNotificationId; exports.createManagedPool = createManagedPool; exports.createThreadId = createThreadId; exports.createUserNotificationSettings = createUserNotificationSettings; exports.deprecate = deprecate; exports.deprecateIf = deprecateIf; exports.detectDupes = detectDupes; exports.entries = entries; exports.errorIf = errorIf; exports.freeze = freeze; exports.generateCommentUrl = generateCommentUrl; exports.getMentionedIdsFromCommentBody = getMentionedIdsFromCommentBody; exports.html = html; exports.htmlSafe = htmlSafe; exports.isChildCrdt = isChildCrdt; exports.isCommentBodyLink = isCommentBodyLink; exports.isCommentBodyMention = isCommentBodyMention; exports.isCommentBodyText = isCommentBodyText; exports.isJsonArray = isJsonArray; exports.isJsonObject = isJsonObject; exports.isJsonScalar = isJsonScalar; exports.isLiveNode = isLiveNode; exports.isNotificationChannelEnabled = isNotificationChannelEnabled; exports.isPlainObject = isPlainObject; exports.isRootCrdt = isRootCrdt; exports.isStartsWithOperator = isStartsWithOperator; exports.kInternal = kInternal; exports.keys = keys; exports.legacy_patchImmutableObject = legacy_patchImmutableObject; exports.lsonToJson = lsonToJson; exports.makeAbortController = makeAbortController; exports.makeEventSource = makeEventSource; exports.makePoller = makePoller; exports.makePosition = makePosition; exports.mapValues = mapValues; exports.memoizeOnSuccess = memoizeOnSuccess; exports.nanoid = nanoid; exports.nn = nn; exports.objectToQuery = objectToQuery; exports.patchLiveObjectKey = patchLiveObjectKey; exports.patchUserNotificationSettings = patchUserNotificationSettings; exports.raise = raise; exports.resolveUsersInCommentBody = resolveUsersInCommentBody; exports.shallow = shallow; exports.stableStringify = stableStringify; exports.stringifyCommentBody = stringifyCommentBody; exports.throwUsageError = throwUsageError; exports.toAbsoluteUrl = toAbsoluteUrl; exports.toPlainLson = toPlainLson; exports.tryParseJson = tryParseJson; exports.url = url; exports.urljoin = urljoin; exports.wait = wait; exports.withTimeout = withTimeout;
+
+exports.ClientMsgCode = ClientMsgCode; exports.CommentsApiError = CommentsApiError; exports.CrdtType = CrdtType; exports.DefaultMap = DefaultMap; exports.DerivedSignal = DerivedSignal; exports.HttpError = HttpError; exports.LiveList = LiveList; exports.LiveMap = LiveMap; exports.LiveObject = LiveObject; exports.LiveblocksError = LiveblocksError; exports.MutableSignal = MutableSignal; exports.NotificationsApiError = NotificationsApiError; exports.OpCode = OpCode; exports.Permission = Permission; exports.Promise_withResolvers = Promise_withResolvers; exports.ServerMsgCode = ServerMsgCode; exports.Signal = Signal; exports.SortedList = SortedList; exports.TextEditorType = TextEditorType; exports.WebsocketCloseCodes = WebsocketCloseCodes; exports.ackOp = ackOp; exports.asPos = asPos; exports.assert = assert; exports.assertNever = assertNever; exports.autoRetry = autoRetry; exports.b64decode = b64decode; exports.batch = batch; exports.checkBounds = checkBounds; exports.chunk = chunk; exports.cloneLson = cloneLson; exports.compactObject = compactObject; exports.console = fancy_console_exports; exports.convertToCommentData = convertToCommentData; exports.convertToCommentUserReaction = convertToCommentUserReaction; exports.convertToInboxNotificationData = convertToInboxNotificationData; exports.convertToThreadData = convertToThreadData; exports.createClient = createClient; exports.createCommentAttachmentId = createCommentAttachmentId; exports.createCommentId = createCommentId; exports.createInboxNotificationId = createInboxNotificationId; exports.createManagedPool = createManagedPool; exports.createNotificationSettings = createNotificationSettings; exports.createThreadId = createThreadId; exports.deprecate = deprecate; exports.deprecateIf = deprecateIf; exports.detectDupes = detectDupes; exports.entries = entries; exports.errorIf = errorIf; exports.freeze = freeze; exports.generateCommentUrl = generateCommentUrl; exports.getMentionedIdsFromCommentBody = getMentionedIdsFromCommentBody; exports.getSubscriptionKey = getSubscriptionKey; exports.html = html; exports.htmlSafe = htmlSafe; exports.isChildCrdt = isChildCrdt; exports.isCommentBodyLink = isCommentBodyLink; exports.isCommentBodyMention = isCommentBodyMention; exports.isCommentBodyText = isCommentBodyText; exports.isJsonArray = isJsonArray; exports.isJsonObject = isJsonObject; exports.isJsonScalar = isJsonScalar; exports.isLiveNode = isLiveNode; exports.isNotificationChannelEnabled = isNotificationChannelEnabled; exports.isPlainObject = isPlainObject; exports.isRootCrdt = isRootCrdt; exports.isStartsWithOperator = isStartsWithOperator; exports.kInternal = kInternal; exports.keys = keys; exports.legacy_patchImmutableObject = legacy_patchImmutableObject; exports.lsonToJson = lsonToJson; exports.makeAbortController = makeAbortController; exports.makeEventSource = makeEventSource; exports.makePoller = makePoller; exports.makePosition = makePosition; exports.mapValues = mapValues; exports.memoizeOnSuccess = memoizeOnSuccess; exports.nanoid = nanoid; exports.nn = nn; exports.objectToQuery = objectToQuery; exports.patchLiveObjectKey = patchLiveObjectKey; exports.patchNotificationSettings = patchNotificationSettings; exports.raise = raise; exports.resolveUsersInCommentBody = resolveUsersInCommentBody; exports.shallow = shallow; exports.stableStringify = stableStringify; exports.stringifyCommentBody = stringifyCommentBody; exports.throwUsageError = throwUsageError; exports.toAbsoluteUrl = toAbsoluteUrl; exports.toPlainLson = toPlainLson; exports.tryParseJson = tryParseJson; exports.url = url; exports.urljoin = urljoin; exports.wait = wait; exports.withTimeout = withTimeout;
 //# sourceMappingURL=index.cjs.map