@backstage/plugin-notifications-common 0.0.8 → 0.0.9-next.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-notifications-common
 
+## 0.0.9-next.0
+
+### Patch Changes
+
+- 1fb5f06: Adds ability for user to turn on/off notifications for specific topics within an origin.
+- Updated dependencies
+  - @backstage/config@1.3.2
+
 ## 0.0.8
 
 ### Patch Changes

package/dist/index.d.ts

@@ -102,17 +102,33 @@ type NotificationProcessorFilters = {
     maxSeverity?: NotificationSeverity;
     excludedTopics?: string[];
 };
+/**
+ * @public
+ */
+type TopicSetting = {
+    id: string;
+    enabled: boolean;
+};
+/**
+ * @public
+ */
+type OriginSetting = {
+    id: string;
+    enabled: boolean;
+    topics?: TopicSetting[];
+};
+/**
+ * @public
+ */
+type ChannelSetting = {
+    id: string;
+    origins: OriginSetting[];
+};
 /**
  * @public
  */
 type NotificationSettings = {
-    channels: {
-        id: string;
-        origins: {
-            id: string;
-            enabled: boolean;
-        }[];
-    }[];
+    channels: ChannelSetting[];
 };
 
 /** Ordered list of severities used by the Notifications.
@@ -124,6 +140,6 @@ declare const notificationSeverities: NotificationSeverity[];
 declare const getProcessorFiltersFromConfig: (config: Config) => NotificationProcessorFilters;
 
 /** @public */
-declare const isNotificationsEnabledFor: (settings: NotificationSettings, channelId: string, originId: string) => boolean;
+declare const isNotificationsEnabledFor: (settings: NotificationSettings, channelId: string, originId: string, topicId: string | null) => boolean;
 
-export { type NewNotificationSignal, type Notification, type NotificationPayload, type NotificationProcessorFilters, type NotificationReadSignal, type NotificationSettings, type NotificationSeverity, type NotificationSignal, type NotificationStatus, getProcessorFiltersFromConfig, isNotificationsEnabledFor, notificationSeverities };
+export { type ChannelSetting, type NewNotificationSignal, type Notification, type NotificationPayload, type NotificationProcessorFilters, type NotificationReadSignal, type NotificationSettings, type NotificationSeverity, type NotificationSignal, type NotificationStatus, type OriginSetting, type TopicSetting, getProcessorFiltersFromConfig, isNotificationsEnabledFor, notificationSeverities };

package/dist/utils.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const isNotificationsEnabledFor = (settings, channelId, originId) => {
+const isNotificationsEnabledFor = (settings, channelId, originId, topicId) => {
   const channel = settings.channels.find((c) => c.id === channelId);
   if (!channel) {
     return true;
@@ -9,7 +9,14 @@ const isNotificationsEnabledFor = (settings, channelId, originId) => {
   if (!origin) {
     return true;
   }
-  return origin.enabled;
+  if (topicId === null) {
+    return origin.enabled;
+  }
+  const topic = origin.topics?.find((t) => t.id === topicId);
+  if (!topic) {
+    return origin.enabled;
+  }
+  return topic.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) => {\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  return origin.enabled;\n};\n"],"names":[],"mappings":";;AAkBO,MAAM,yBAA4B,GAAA,CACvC,QACA,EAAA,SAAA,EACA,QACG,KAAA;AACH,EAAA,MAAM,UAAU,QAAS,CAAA,QAAA,CAAS,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AAGT,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA;AAAA;AAET,EAAA,OAAO,MAAO,CAAA,OAAA;AAChB;;;;"}
+{"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,yBAA4B,GAAA,CACvC,QACA,EAAA,SAAA,EACA,UACA,OACG,KAAA;AACH,EAAA,MAAM,UAAU,QAAS,CAAA,QAAA,CAAS,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AAGT,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA;AAAA;AAET,EAAA,IAAI,YAAY,IAAM,EAAA;AACpB,IAAA,OAAO,MAAO,CAAA,OAAA;AAAA;AAEhB,EAAA,MAAM,QAAQ,MAAO,CAAA,MAAA,EAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,EAAA,IAAI,CAAC,KAAO,EAAA;AACV,IAAA,OAAO,MAAO,CAAA,OAAA;AAAA;AAEhB,EAAA,OAAO,KAAM,CAAA,OAAA;AACf;;;;"}

package/dist/utils.esm.js

@@ -1,4 +1,4 @@
-const isNotificationsEnabledFor = (settings, channelId, originId) => {
+const isNotificationsEnabledFor = (settings, channelId, originId, topicId) => {
   const channel = settings.channels.find((c) => c.id === channelId);
   if (!channel) {
     return true;
@@ -7,7 +7,14 @@ const isNotificationsEnabledFor = (settings, channelId, originId) => {
   if (!origin) {
     return true;
   }
-  return origin.enabled;
+  if (topicId === null) {
+    return origin.enabled;
+  }
+  const topic = origin.topics?.find((t) => t.id === topicId);
+  if (!topic) {
+    return origin.enabled;
+  }
+  return topic.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) => {\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  return origin.enabled;\n};\n"],"names":[],"mappings":"AAkBO,MAAM,yBAA4B,GAAA,CACvC,QACA,EAAA,SAAA,EACA,QACG,KAAA;AACH,EAAA,MAAM,UAAU,QAAS,CAAA,QAAA,CAAS,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AAGT,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA;AAAA;AAET,EAAA,OAAO,MAAO,CAAA,OAAA;AAChB;;;;"}
+{"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,yBAA4B,GAAA,CACvC,QACA,EAAA,SAAA,EACA,UACA,OACG,KAAA;AACH,EAAA,MAAM,UAAU,QAAS,CAAA,QAAA,CAAS,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA;AAAA;AAGT,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA;AAAA;AAET,EAAA,IAAI,YAAY,IAAM,EAAA;AACpB,IAAA,OAAO,MAAO,CAAA,OAAA;AAAA;AAEhB,EAAA,MAAM,QAAQ,MAAO,CAAA,MAAA,EAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,OAAO,CAAA;AACvD,EAAA,IAAI,CAAC,KAAO,EAAA;AACV,IAAA,OAAO,MAAO,CAAA,OAAA;AAAA;AAEhB,EAAA,OAAO,KAAM,CAAA,OAAA;AACf;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-notifications-common",
-  "version": "0.0.8",
+  "version": "0.0.9-next.0",
   "description": "Common functionalities for the notifications plugin",
   "backstage": {
     "role": "common-library",
@@ -39,16 +39,16 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/config": "^1.3.2",
+    "@backstage/config": "1.3.2",
     "@material-ui/icons": "^4.9.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.29.5"
+    "@backstage/cli": "0.32.2-next.0"
   },
   "typesVersions": {
     "*": {
-      "index": [
-        "dist/index.d.ts"
+      "package.json": [
+        "package.json"
       ]
     }
   },