@liveblocks/core 2.18.4-uns1 → 2.18.4-uns2

package/dist/index.d.cts

@@ -2528,7 +2528,9 @@ type PrivateUserNotificationSettingsApi = {
  * User notification settings.
  * One channel for one set of settings.
  */
-type UserNotificationSettings = Required<UserNotificationSettingsPlain> & {
+type UserNotificationSettings = {
+    [C in NotificationChannel]: NotificationChannelSettings | null;
+} & {
     /**
      * @private
      *
@@ -2559,13 +2561,13 @@ type PartialUserNotificationSettings = DeepPartialWithAugmentation<UserNotificat
  * @private
  *
  * Creates a `UserNotificationSettings` object with the given initial plain settings.
- * It defines a getter for each channel to access the settings and throws and error
+ * It defines a getter for each channel to access the settings and returns `null` with an error log
  * in case the required channel isn't enabled in the dashboard.
  *
  * You can see this function as `Proxy` like around `UserNotificationSettingsPlain` type.
  * We can't predict what will be enabled on the dashboard or not, so it's important
- * provide a good DX to developers by throwing an error when they try to access a channel
- * that isn't enabled in the dashboard.
+ * provide a good DX to developers by returning `null` completed by an error log
+ * when they try to access a channel that isn't enabled in the dashboard.
  */
 declare function createUserNotificationSettings(plain: UserNotificationSettingsPlain): UserNotificationSettings;
 /**
@@ -2584,13 +2586,8 @@ declare function patchUserNotificationSettings(existing: UserNotificationSetting
  * ```ts
  * const isEmailChannelEnabled = isNotificationChannelEnabled(settings.email);
  * ```
- *
- * ⚠️ Warning: when using this function, you should be aware
- * you need to ensure you have notification kinds enabled in the dashboard
- * for the channel you're checking. Otherwise, it will raise an error at runtime because
- * the backend don't send the settings for a not enabled channel (e.g. no notification kinds enabled in a channel).
  */
-declare function isNotificationChannelEnabled(settings: NotificationChannelSettings): boolean;
+declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
 
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {

package/dist/index.d.ts

@@ -2528,7 +2528,9 @@ type PrivateUserNotificationSettingsApi = {
  * User notification settings.
  * One channel for one set of settings.
  */
-type UserNotificationSettings = Required<UserNotificationSettingsPlain> & {
+type UserNotificationSettings = {
+    [C in NotificationChannel]: NotificationChannelSettings | null;
+} & {
     /**
      * @private
      *
@@ -2559,13 +2561,13 @@ type PartialUserNotificationSettings = DeepPartialWithAugmentation<UserNotificat
  * @private
  *
  * Creates a `UserNotificationSettings` object with the given initial plain settings.
- * It defines a getter for each channel to access the settings and throws and error
+ * It defines a getter for each channel to access the settings and returns `null` with an error log
  * in case the required channel isn't enabled in the dashboard.
  *
  * You can see this function as `Proxy` like around `UserNotificationSettingsPlain` type.
  * We can't predict what will be enabled on the dashboard or not, so it's important
- * provide a good DX to developers by throwing an error when they try to access a channel
- * that isn't enabled in the dashboard.
+ * provide a good DX to developers by returning `null` completed by an error log
+ * when they try to access a channel that isn't enabled in the dashboard.
  */
 declare function createUserNotificationSettings(plain: UserNotificationSettingsPlain): UserNotificationSettings;
 /**
@@ -2584,13 +2586,8 @@ declare function patchUserNotificationSettings(existing: UserNotificationSetting
  * ```ts
  * const isEmailChannelEnabled = isNotificationChannelEnabled(settings.email);
  * ```
- *
- * ⚠️ Warning: when using this function, you should be aware
- * you need to ensure you have notification kinds enabled in the dashboard
- * for the channel you're checking. Otherwise, it will raise an error at runtime because
- * the backend don't send the settings for a not enabled channel (e.g. no notification kinds enabled in a channel).
  */
-declare function isNotificationChannelEnabled(settings: NotificationChannelSettings): boolean;
+declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
 
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.18.4-uns1";
+var PKG_VERSION = "2.18.4-uns2";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -3636,10 +3636,11 @@ function createUserNotificationSettings(plain) {
        */
       get() {
         const value = this[kPrivate].__plain__[channel];
-        if (!value) {
-          raise(
-            `In order to use the '${channel}' channel, please set up your project first. See <link to docs>`
+        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;
       }
@@ -3666,7 +3667,7 @@ function patchUserNotificationSettings(existing, patch) {
   return outcoming;
 }
 function isNotificationChannelEnabled(settings) {
-  return values(settings).every((enabled) => enabled === true);
+  return settings !== null ? values(settings).every((enabled) => enabled === true) : false;
 }
 
 // src/lib/position.ts