@backstage/plugin-notifications-common 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage/plugin-notifications-common
 
+## 0.2.1
+
+### Patch Changes
+
+- e9eb400: Allow configuring included topics for email notifications.
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/filters.cjs.js

@@ -27,6 +27,9 @@ const getProcessorFiltersFromConfig = (config) => {
   filter.excludedTopics = config.getOptionalStringArray(
     "filter.excludedTopics"
   );
+  filter.includedTopics = config.getOptionalStringArray(
+    "filter.includedTopics"
+  );
   return filter;
 };
 

package/dist/filters.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"filters.cjs.js","sources":["../src/filters.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 { Config } from '@backstage/config';\nimport { NotificationProcessorFilters, NotificationSeverity } from './types';\nimport { notificationSeverities } from './constants';\n\n/** @public */\nexport const getProcessorFiltersFromConfig = (config: Config) => {\n  const filter: NotificationProcessorFilters = {};\n  const minSeverity = config.getOptionalString(\n    'filter.minSeverity',\n  ) as NotificationSeverity;\n  if (minSeverity) {\n    if (notificationSeverities.includes(minSeverity)) {\n      filter.minSeverity = minSeverity;\n    } else {\n      throw new Error(`Invalid minSeverity: ${minSeverity}`);\n    }\n  }\n  const maxSeverity = config.getOptionalString(\n    'filter.maxSeverity',\n  ) as NotificationSeverity;\n  if (maxSeverity) {\n    if (notificationSeverities.includes(maxSeverity)) {\n      filter.maxSeverity = maxSeverity;\n    } else {\n      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);\n    }\n  }\n  filter.excludedTopics = config.getOptionalStringArray(\n    'filter.excludedTopics',\n  );\n  return filter;\n};\n"],"names":["notificationSeverities"],"mappings":";;;;AAoBO,MAAM,6BAAA,GAAgC,CAAC,MAAA,KAAmB;AAC/D,EAAA,MAAM,SAAuC,EAAC;AAC9C,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAIA,gCAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAIA,gCAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,OAAO,MAAA;AACT;;;;"}
+{"version":3,"file":"filters.cjs.js","sources":["../src/filters.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 { Config } from '@backstage/config';\nimport { NotificationProcessorFilters, NotificationSeverity } from './types';\nimport { notificationSeverities } from './constants';\n\n/** @public */\nexport const getProcessorFiltersFromConfig = (config: Config) => {\n  const filter: NotificationProcessorFilters = {};\n  const minSeverity = config.getOptionalString(\n    'filter.minSeverity',\n  ) as NotificationSeverity;\n  if (minSeverity) {\n    if (notificationSeverities.includes(minSeverity)) {\n      filter.minSeverity = minSeverity;\n    } else {\n      throw new Error(`Invalid minSeverity: ${minSeverity}`);\n    }\n  }\n  const maxSeverity = config.getOptionalString(\n    'filter.maxSeverity',\n  ) as NotificationSeverity;\n  if (maxSeverity) {\n    if (notificationSeverities.includes(maxSeverity)) {\n      filter.maxSeverity = maxSeverity;\n    } else {\n      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);\n    }\n  }\n  filter.excludedTopics = config.getOptionalStringArray(\n    'filter.excludedTopics',\n  );\n  filter.includedTopics = config.getOptionalStringArray(\n    'filter.includedTopics',\n  );\n  return filter;\n};\n"],"names":["notificationSeverities"],"mappings":";;;;AAoBO,MAAM,6BAAA,GAAgC,CAAC,MAAA,KAAmB;AAC/D,EAAA,MAAM,SAAuC,EAAC;AAC9C,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAIA,gCAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAIA,gCAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,OAAO,MAAA;AACT;;;;"}

package/dist/filters.esm.js

@@ -25,6 +25,9 @@ const getProcessorFiltersFromConfig = (config) => {
   filter.excludedTopics = config.getOptionalStringArray(
     "filter.excludedTopics"
   );
+  filter.includedTopics = config.getOptionalStringArray(
+    "filter.includedTopics"
+  );
   return filter;
 };
 

package/dist/filters.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"filters.esm.js","sources":["../src/filters.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 { Config } from '@backstage/config';\nimport { NotificationProcessorFilters, NotificationSeverity } from './types';\nimport { notificationSeverities } from './constants';\n\n/** @public */\nexport const getProcessorFiltersFromConfig = (config: Config) => {\n  const filter: NotificationProcessorFilters = {};\n  const minSeverity = config.getOptionalString(\n    'filter.minSeverity',\n  ) as NotificationSeverity;\n  if (minSeverity) {\n    if (notificationSeverities.includes(minSeverity)) {\n      filter.minSeverity = minSeverity;\n    } else {\n      throw new Error(`Invalid minSeverity: ${minSeverity}`);\n    }\n  }\n  const maxSeverity = config.getOptionalString(\n    'filter.maxSeverity',\n  ) as NotificationSeverity;\n  if (maxSeverity) {\n    if (notificationSeverities.includes(maxSeverity)) {\n      filter.maxSeverity = maxSeverity;\n    } else {\n      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);\n    }\n  }\n  filter.excludedTopics = config.getOptionalStringArray(\n    'filter.excludedTopics',\n  );\n  return filter;\n};\n"],"names":[],"mappings":";;AAoBO,MAAM,6BAAA,GAAgC,CAAC,MAAA,KAAmB;AAC/D,EAAA,MAAM,SAAuC,EAAC;AAC9C,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAI,sBAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAI,sBAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,OAAO,MAAA;AACT;;;;"}
+{"version":3,"file":"filters.esm.js","sources":["../src/filters.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 { Config } from '@backstage/config';\nimport { NotificationProcessorFilters, NotificationSeverity } from './types';\nimport { notificationSeverities } from './constants';\n\n/** @public */\nexport const getProcessorFiltersFromConfig = (config: Config) => {\n  const filter: NotificationProcessorFilters = {};\n  const minSeverity = config.getOptionalString(\n    'filter.minSeverity',\n  ) as NotificationSeverity;\n  if (minSeverity) {\n    if (notificationSeverities.includes(minSeverity)) {\n      filter.minSeverity = minSeverity;\n    } else {\n      throw new Error(`Invalid minSeverity: ${minSeverity}`);\n    }\n  }\n  const maxSeverity = config.getOptionalString(\n    'filter.maxSeverity',\n  ) as NotificationSeverity;\n  if (maxSeverity) {\n    if (notificationSeverities.includes(maxSeverity)) {\n      filter.maxSeverity = maxSeverity;\n    } else {\n      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);\n    }\n  }\n  filter.excludedTopics = config.getOptionalStringArray(\n    'filter.excludedTopics',\n  );\n  filter.includedTopics = config.getOptionalStringArray(\n    'filter.includedTopics',\n  );\n  return filter;\n};\n"],"names":[],"mappings":";;AAoBO,MAAM,6BAAA,GAAgC,CAAC,MAAA,KAAmB;AAC/D,EAAA,MAAM,SAAuC,EAAC;AAC9C,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAI,sBAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,IACzB;AAAA,GACF;AACA,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,IAAI,sBAAA,CAAuB,QAAA,CAAS,WAAW,CAAA,EAAG;AAChD,MAAA,MAAA,CAAO,WAAA,GAAc,WAAA;AAAA,IACvB,CAAA,MAAO;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,WAAW,CAAA,CAAE,CAAA;AAAA,IACvD;AAAA,EACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAA,CAAO,sBAAA;AAAA,IAC7B;AAAA,GACF;AACA,EAAA,OAAO,MAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -108,6 +108,7 @@ type NotificationProcessorFilters = {
     minSeverity?: NotificationSeverity;
     maxSeverity?: NotificationSeverity;
     excludedTopics?: string[];
+    includedTopics?: string[];
 };
 /**
  * @public
@@ -179,4 +180,5 @@ declare const getProcessorFiltersFromConfig: (config: Config) => NotificationPro
 /** @public */
 declare const isNotificationsEnabledFor: (settings: NotificationSettings, channelId: string, originId: string, topicId: string | null) => boolean;
 
-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 };
+export { getProcessorFiltersFromConfig, isNotificationsEnabledFor, notificationSeverities };
+export type { ChannelSetting, NewNotificationSignal, Notification, NotificationPayload, NotificationProcessorFilters, NotificationReadSignal, NotificationSettings, NotificationSeverity, NotificationSignal, NotificationStatus, OriginSetting, TopicSetting };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-notifications-common",
-  "version": "0.2.0",
+  "version": "0.2.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"
+    "@backstage/cli": "^0.35.4"
   },
   "typesVersions": {
     "*": {