@liveblocks/core 2.19.0 → 2.20.0

package/dist/index.cjs

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.19.0";
+var PKG_VERSION = "2.20.0";
 var PKG_FORMAT = "cjs";
 
 // src/dupe-detection.ts
@@ -187,6 +187,12 @@ function keys(obj) {
 function values(obj) {
   return Object.values(obj);
 }
+function create(obj, descriptors) {
+  if (typeof descriptors !== "undefined") {
+    return Object.create(obj, descriptors);
+  }
+  return Object.create(obj);
+}
 function mapValues(obj, mapFn) {
   const result = {};
   for (const pair of Object.entries(obj)) {
@@ -3597,6 +3603,71 @@ function unlinkDevTools(roomId) {
   });
 }
 
+// src/protocol/UserNotificationSettings.ts
+var kPlain = Symbol("user-notification-settings-plain");
+function createUserNotificationSettings(plain) {
+  const channels = [
+    "email",
+    "slack",
+    "teams",
+    "webPush"
+  ];
+  const descriptors = {
+    [kPlain]: {
+      value: plain,
+      enumerable: false
+    }
+  };
+  for (const channel of channels) {
+    descriptors[channel] = {
+      enumerable: true,
+      /**
+       * In the TypeScript standard library definitions, the built-in interface for a property descriptor
+       * does not include a specialized type for the “this” context in the getter or setter functions.
+       * As a result, both the ⁠get and ⁠set methods implicitly have ⁠this: any.
+       * The reason is that property descriptors in JavaScript are used across various objects with
+       * 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`.
+       */
+      get() {
+        const value = this[kPlain][channel];
+        if (typeof value === "undefined") {
+          error2(
+            `In order to use the '${channel}' channel, please set up your project first. For more information: https://liveblocks.io/docs/errors/enable-a-notification-channel`
+          );
+          return null;
+        }
+        return value;
+      }
+    };
+  }
+  return create(null, descriptors);
+}
+function patchUserNotificationSettings(existing, patch) {
+  const outcoming = createUserNotificationSettings({
+    ...existing[kPlain]
+  });
+  for (const channel of keys(patch)) {
+    const updates = patch[channel];
+    if (updates !== void 0) {
+      const kindUpdates = Object.fromEntries(
+        entries(updates).filter(([, value]) => value !== void 0)
+      );
+      outcoming[kPlain][channel] = {
+        ...outcoming[kPlain][channel],
+        ...kindUpdates
+      };
+    }
+  }
+  return outcoming;
+}
+function isNotificationChannelEnabled(settings) {
+  return settings !== null ? values(settings).every((enabled) => enabled === true) : false;
+}
+
 // src/lib/position.ts
 var MIN_CODE = 32;
 var MAX_CODE = 126;
@@ -8189,6 +8260,16 @@ function createClient(options) {
     const win = typeof window !== "undefined" ? window : void 0;
     _optionalChain([win, 'optionalAccess', _184 => _184.addEventListener, 'call', _185 => _185("beforeunload", maybePreventClose)]);
   }
+  async function getNotificationSettings(options2) {
+    const plainSettings = await httpClient.getUserNotificationSettings(options2);
+    const settings = createUserNotificationSettings(plainSettings);
+    return settings;
+  }
+  async function updateNotificationSettings(settings) {
+    const plainSettings = await httpClient.updateUserNotificationSettings(settings);
+    const settingsObject = createUserNotificationSettings(plainSettings);
+    return settingsObject;
+  }
   const client = Object.defineProperty(
     {
       enterRoom,
@@ -8202,9 +8283,9 @@ function createClient(options) {
       markInboxNotificationAsRead: httpClient.markInboxNotificationAsRead,
       deleteAllInboxNotifications: httpClient.deleteAllInboxNotifications,
       deleteInboxNotification: httpClient.deleteInboxNotification,
-      // Public channel notification settings API
-      getNotificationSettings: httpClient.getUserNotificationSettings,
-      updateNotificationSettings: httpClient.updateUserNotificationSettings,
+      // Public user notification settings API
+      getNotificationSettings,
+      updateNotificationSettings,
       // Advanced resolvers APIs
       resolvers: {
         invalidateUsers: invalidateResolvedUsers,
@@ -9194,11 +9275,6 @@ var SortedList = class _SortedList {
   }
 };
 
-// src/protocol/UserNotificationSettings.ts
-function isNotificationChannelEnabled(settings) {
-  return values(settings).every((enabled) => enabled === true);
-}
-
 // src/types/Others.ts
 var TextEditorType = /* @__PURE__ */ ((TextEditorType2) => {
   TextEditorType2["Lexical"] = "lexical";
@@ -9299,5 +9375,7 @@ 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.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.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.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.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.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.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.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.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;
 //# sourceMappingURL=index.cjs.map