@backstage/plugin-notifications-common 0.1.2-next.0 → 0.2.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @backstage/plugin-notifications-common
 
+## 0.2.0-next.1
+
+### Minor Changes
+
+- 87e597c: Adds support for default configuration for an entire notification channel.
+  This setting will also be inherited down to origins and topics while still respecting the users individual choices.
+
+  This will be handy if you want to use a "opt-in" strategy.
+
 ## 0.1.2-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -113,28 +113,58 @@ type NotificationProcessorFilters = {
  * @public
  */
 type TopicSetting = {
+    /**
+     * Topic identifier
+     */
     id: string;
+    /**
+     * Whether notifications for this topic are enabled
+     */
     enabled: boolean;
 };
 /**
  * @public
  */
 type OriginSetting = {
+    /**
+     * Origin identifier
+     */
     id: string;
+    /**
+     * Whether notifications from this origin are enabled
+     */
     enabled: boolean;
+    /**
+     * Optional array of topic-specific settings
+     */
     topics?: TopicSetting[];
 };
 /**
  * @public
  */
 type ChannelSetting = {
+    /**
+     * Channel identifier
+     */
     id: string;
+    /**
+     * Optional flag to enable/disable the channel by default.
+     * If not set, defaults to true for backwards compatibility.
+     * When set to false, the channel uses an opt-in strategy.
+     */
+    enabled?: boolean;
+    /**
+     * Array of origin settings for this channel
+     */
     origins: OriginSetting[];
 };
 /**
  * @public
  */
 type NotificationSettings = {
+    /**
+     * Array of channel settings
+     */
     channels: ChannelSetting[];
 };
 

package/dist/utils.cjs.js

@@ -7,16 +7,16 @@ const isNotificationsEnabledFor = (settings, channelId, originId, topicId) => {
   }
   const origin = channel.origins.find((o) => o.id === originId);
   if (!origin) {
-    return true;
-  }
-  if (topicId === null) {
-    return origin.enabled;
+    return channel.enabled ?? true;
   }
-  const topic = origin.topics?.find((t) => t.id === topicId);
-  if (!topic) {
+  if (topicId !== null) {
+    const topic = origin.topics?.find((t) => t.id === topicId);
+    if (topic) {
+      return topic.enabled;
+    }
     return origin.enabled;
   }
-  return topic.enabled;
+  return origin.enabled;
 };
 
 exports.isNotificationsEnabledFor = isNotificationsEnabledFor;

package/dist/utils.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs.js","sources":["../src/utils.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSettings } from './types';\n\n/** @public */\nexport const isNotificationsEnabledFor = (\n  settings: NotificationSettings,\n  channelId: string,\n  originId: string,\n  topicId: string | null,\n) => {\n  const channel = settings.channels.find(c => c.id === channelId);\n  if (!channel) {\n    return true;\n  }\n\n  const origin = channel.origins.find(o => o.id === originId);\n  if (!origin) {\n    return true;\n  }\n  if (topicId === null) {\n    return origin.enabled;\n  }\n  const topic = origin.topics?.find(t => t.id === topicId);\n  if (!topic) {\n    return origin.enabled;\n  }\n  return topic.enabled;\n};\n"],"names":[],"mappings":";;AAkBO,MAAM,yBAAA,GAA4B,CACvC,QAAA,EACA,SAAA,EACA,UACA,OAAA,KACG;AACH,EAAA,MAAM,UAAU,QAAA,CAAS,QAAA,CAAS,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AACA,EAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,EAAA,IAAI,CAAC,KAAA,EAAO;AACV,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AACA,EAAA,OAAO,KAAA,CAAM,OAAA;AACf;;;;"}
+{"version":3,"file":"utils.cjs.js","sources":["../src/utils.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSettings } from './types';\n\n/** @public */\nexport const isNotificationsEnabledFor = (\n  settings: NotificationSettings,\n  channelId: string,\n  originId: string,\n  topicId: string | null,\n) => {\n  const channel = settings.channels.find(c => c.id === channelId);\n  if (!channel) {\n    return true;\n  }\n\n  const origin = channel.origins.find(o => o.id === originId);\n  if (!origin) {\n    // If no origin is found, use channel's enabled flag (defaults to true if not set)\n    return channel.enabled ?? true;\n  }\n\n  // If topic is specified, check topic-level setting\n  if (topicId !== null) {\n    const topic = origin.topics?.find(t => t.id === topicId);\n    if (topic) {\n      return topic.enabled;\n    }\n    // No explicit topic setting, check origin\n    return origin.enabled;\n  }\n\n  // No topic specified, check origin-level setting\n  return origin.enabled;\n};\n"],"names":[],"mappings":";;AAkBO,MAAM,yBAAA,GAA4B,CACvC,QAAA,EACA,SAAA,EACA,UACA,OAAA,KACG;AACH,EAAA,MAAM,UAAU,QAAA,CAAS,QAAA,CAAS,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAA,EAAQ;AAEX,IAAA,OAAO,QAAQ,OAAA,IAAW,IAAA;AAAA,EAC5B;AAGA,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,OAAO,KAAA,CAAM,OAAA;AAAA,IACf;AAEA,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AAGA,EAAA,OAAO,MAAA,CAAO,OAAA;AAChB;;;;"}

package/dist/utils.esm.js

@@ -5,16 +5,16 @@ const isNotificationsEnabledFor = (settings, channelId, originId, topicId) => {
   }
   const origin = channel.origins.find((o) => o.id === originId);
   if (!origin) {
-    return true;
-  }
-  if (topicId === null) {
-    return origin.enabled;
+    return channel.enabled ?? true;
   }
-  const topic = origin.topics?.find((t) => t.id === topicId);
-  if (!topic) {
+  if (topicId !== null) {
+    const topic = origin.topics?.find((t) => t.id === topicId);
+    if (topic) {
+      return topic.enabled;
+    }
     return origin.enabled;
   }
-  return topic.enabled;
+  return origin.enabled;
 };
 
 export { isNotificationsEnabledFor };

package/dist/utils.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.esm.js","sources":["../src/utils.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSettings } from './types';\n\n/** @public */\nexport const isNotificationsEnabledFor = (\n  settings: NotificationSettings,\n  channelId: string,\n  originId: string,\n  topicId: string | null,\n) => {\n  const channel = settings.channels.find(c => c.id === channelId);\n  if (!channel) {\n    return true;\n  }\n\n  const origin = channel.origins.find(o => o.id === originId);\n  if (!origin) {\n    return true;\n  }\n  if (topicId === null) {\n    return origin.enabled;\n  }\n  const topic = origin.topics?.find(t => t.id === topicId);\n  if (!topic) {\n    return origin.enabled;\n  }\n  return topic.enabled;\n};\n"],"names":[],"mappings":"AAkBO,MAAM,yBAAA,GAA4B,CACvC,QAAA,EACA,SAAA,EACA,UACA,OAAA,KACG;AACH,EAAA,MAAM,UAAU,QAAA,CAAS,QAAA,CAAS,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AACA,EAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,EAAA,IAAI,CAAC,KAAA,EAAO;AACV,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AACA,EAAA,OAAO,KAAA,CAAM,OAAA;AACf;;;;"}
+{"version":3,"file":"utils.esm.js","sources":["../src/utils.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSettings } from './types';\n\n/** @public */\nexport const isNotificationsEnabledFor = (\n  settings: NotificationSettings,\n  channelId: string,\n  originId: string,\n  topicId: string | null,\n) => {\n  const channel = settings.channels.find(c => c.id === channelId);\n  if (!channel) {\n    return true;\n  }\n\n  const origin = channel.origins.find(o => o.id === originId);\n  if (!origin) {\n    // If no origin is found, use channel's enabled flag (defaults to true if not set)\n    return channel.enabled ?? true;\n  }\n\n  // If topic is specified, check topic-level setting\n  if (topicId !== null) {\n    const topic = origin.topics?.find(t => t.id === topicId);\n    if (topic) {\n      return topic.enabled;\n    }\n    // No explicit topic setting, check origin\n    return origin.enabled;\n  }\n\n  // No topic specified, check origin-level setting\n  return origin.enabled;\n};\n"],"names":[],"mappings":"AAkBO,MAAM,yBAAA,GAA4B,CACvC,QAAA,EACA,SAAA,EACA,UACA,OAAA,KACG;AACH,EAAA,MAAM,UAAU,QAAA,CAAS,QAAA,CAAS,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAA,EAAQ;AAEX,IAAA,OAAO,QAAQ,OAAA,IAAW,IAAA;AAAA,EAC5B;AAGA,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,QAAQ,MAAA,CAAO,MAAA,EAAQ,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,OAAO,KAAA,CAAM,OAAA;AAAA,IACf;AAEA,IAAA,OAAO,MAAA,CAAO,OAAA;AAAA,EAChB;AAGA,EAAA,OAAO,MAAA,CAAO,OAAA;AAChB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-notifications-common",
-  "version": "0.1.2-next.0",
+  "version": "0.2.0-next.1",
   "description": "Common functionalities for the notifications plugin",
   "backstage": {
     "role": "common-library",
@@ -44,7 +44,7 @@
     "@material-ui/icons": "^4.9.1"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.5-next.0"
+    "@backstage/cli": "0.34.5-next.1"
   },
   "typesVersions": {
     "*": {