@backstage/plugin-notifications-common 0.0.4 → 0.0.6-next.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/plugin-notifications-common
 
+## 0.0.6-next.0
+
+### Patch Changes
+
+- 97ba58f: Add support for user specific notification settings
+- Updated dependencies
+  - @backstage/config@1.2.0
+
+## 0.0.5
+
+### Patch Changes
+
+- 4e4ef2b: Move notification processor filter parsing to common package
+- Updated dependencies
+  - @backstage/config@1.2.0
+
 ## 0.0.4
 
 ### Patch Changes

package/dist/constants.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+const notificationSeverities = [
+  "critical",
+  "high",
+  "normal",
+  "low"
+];
+
+exports.notificationSeverities = notificationSeverities;
+//# sourceMappingURL=constants.cjs.js.map

package/dist/constants.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs.js","sources":["../src/constants.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 { NotificationSeverity } from './types';\n\n/** Ordered list of severities used by the Notifications.\n *\n * @public */\nexport const notificationSeverities: NotificationSeverity[] = [\n  'critical',\n  'high',\n  'normal',\n  'low',\n];\n"],"names":[],"mappings":";;AAoBO,MAAM,sBAAiD,GAAA;AAAA,EAC5D,UAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF;;;;"}

package/dist/filters.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var constants = require('./constants.cjs.js');
+
+const getProcessorFiltersFromConfig = (config) => {
+  const filter = {};
+  const minSeverity = config.getOptionalString(
+    "filter.minSeverity"
+  );
+  if (minSeverity) {
+    if (constants.notificationSeverities.includes(minSeverity)) {
+      filter.minSeverity = minSeverity;
+    } else {
+      throw new Error(`Invalid minSeverity: ${minSeverity}`);
+    }
+  }
+  const maxSeverity = config.getOptionalString(
+    "filter.maxSeverity"
+  );
+  if (maxSeverity) {
+    if (constants.notificationSeverities.includes(maxSeverity)) {
+      filter.maxSeverity = maxSeverity;
+    } else {
+      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);
+    }
+  }
+  filter.excludedTopics = config.getOptionalStringArray(
+    "filter.excludedTopics"
+  );
+  return filter;
+};
+
+exports.getProcessorFiltersFromConfig = getProcessorFiltersFromConfig;
+//# sourceMappingURL=filters.cjs.js.map

package/dist/filters.cjs.js.map

@@ -0,0 +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":";;;;AAoBa,MAAA,6BAAA,GAAgC,CAAC,MAAmB,KAAA;AAC/D,EAAA,MAAM,SAAuC,EAAC,CAAA;AAC9C,EAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,IACzB,oBAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAI,IAAAA,gCAAA,CAAuB,QAAS,CAAA,WAAW,CAAG,EAAA;AAChD,MAAA,MAAA,CAAO,WAAc,GAAA,WAAA,CAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,WAAW,CAAE,CAAA,CAAA,CAAA;AAAA,KACvD;AAAA,GACF;AACA,EAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,IACzB,oBAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAI,IAAAA,gCAAA,CAAuB,QAAS,CAAA,WAAW,CAAG,EAAA;AAChD,MAAA,MAAA,CAAO,WAAc,GAAA,WAAA,CAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,WAAW,CAAE,CAAA,CAAA,CAAA;AAAA,KACvD;AAAA,GACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAO,CAAA,sBAAA;AAAA,IAC7B,uBAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/filters.esm.js

@@ -0,0 +1,32 @@
+import { notificationSeverities } from './constants.esm.js';
+
+const getProcessorFiltersFromConfig = (config) => {
+  const filter = {};
+  const minSeverity = config.getOptionalString(
+    "filter.minSeverity"
+  );
+  if (minSeverity) {
+    if (notificationSeverities.includes(minSeverity)) {
+      filter.minSeverity = minSeverity;
+    } else {
+      throw new Error(`Invalid minSeverity: ${minSeverity}`);
+    }
+  }
+  const maxSeverity = config.getOptionalString(
+    "filter.maxSeverity"
+  );
+  if (maxSeverity) {
+    if (notificationSeverities.includes(maxSeverity)) {
+      filter.maxSeverity = maxSeverity;
+    } else {
+      throw new Error(`Invalid maxSeverity: ${maxSeverity}`);
+    }
+  }
+  filter.excludedTopics = config.getOptionalStringArray(
+    "filter.excludedTopics"
+  );
+  return filter;
+};
+
+export { getProcessorFiltersFromConfig };
+//# sourceMappingURL=filters.esm.js.map

package/dist/filters.esm.js.map

@@ -0,0 +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":";;AAoBa,MAAA,6BAAA,GAAgC,CAAC,MAAmB,KAAA;AAC/D,EAAA,MAAM,SAAuC,EAAC,CAAA;AAC9C,EAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,IACzB,oBAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAI,IAAA,sBAAA,CAAuB,QAAS,CAAA,WAAW,CAAG,EAAA;AAChD,MAAA,MAAA,CAAO,WAAc,GAAA,WAAA,CAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,WAAW,CAAE,CAAA,CAAA,CAAA;AAAA,KACvD;AAAA,GACF;AACA,EAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,IACzB,oBAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,WAAa,EAAA;AACf,IAAI,IAAA,sBAAA,CAAuB,QAAS,CAAA,WAAW,CAAG,EAAA;AAChD,MAAA,MAAA,CAAO,WAAc,GAAA,WAAA,CAAA;AAAA,KAChB,MAAA;AACL,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,WAAW,CAAE,CAAA,CAAA,CAAA;AAAA,KACvD;AAAA,GACF;AACA,EAAA,MAAA,CAAO,iBAAiB,MAAO,CAAA,sBAAA;AAAA,IAC7B,uBAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/index.cjs.js

@@ -1,11 +1,12 @@
 'use strict';
 
-const notificationSeverities = [
-  "critical",
-  "high",
-  "normal",
-  "low"
-];
-
-exports.notificationSeverities = notificationSeverities;
+var constants = require('./constants.cjs.js');
+var filters = require('./filters.cjs.js');
+var utils = require('./utils.cjs.js');
+
+
+
+exports.notificationSeverities = constants.notificationSeverities;
+exports.getProcessorFiltersFromConfig = filters.getProcessorFiltersFromConfig;
+exports.isNotificationsEnabledFor = utils.isNotificationsEnabledFor;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/constants.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 { NotificationSeverity } from './types';\n\n/** Ordered list of severities used by the Notifications.\n *\n * @public */\nexport const notificationSeverities: NotificationSeverity[] = [\n  'critical',\n  'high',\n  'normal',\n  'low',\n];\n"],"names":[],"mappings":";;AAoBO,MAAM,sBAAiD,GAAA;AAAA,EAC5D,UAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Config } from '@backstage/config';
+
 /** @public */
 type NotificationSeverity = 'critical' | 'high' | 'normal' | 'low';
 /** @public */
@@ -92,10 +94,36 @@ type NotificationReadSignal = {
 };
 /** @public */
 type NotificationSignal = NewNotificationSignal | NotificationReadSignal;
+/**
+ * @public
+ */
+type NotificationProcessorFilters = {
+    minSeverity?: NotificationSeverity;
+    maxSeverity?: NotificationSeverity;
+    excludedTopics?: string[];
+};
+/**
+ * @public
+ */
+type NotificationSettings = {
+    channels: {
+        id: string;
+        origins: {
+            id: string;
+            enabled: boolean;
+        }[];
+    }[];
+};
 
 /** Ordered list of severities used by the Notifications.
  *
  * @public */
 declare const notificationSeverities: NotificationSeverity[];
 
-export { type NewNotificationSignal, type Notification, type NotificationPayload, type NotificationReadSignal, type NotificationSeverity, type NotificationSignal, type NotificationStatus, notificationSeverities };
+/** @public */
+declare const getProcessorFiltersFromConfig: (config: Config) => NotificationProcessorFilters;
+
+/** @public */
+declare const isNotificationsEnabledFor: (settings: NotificationSettings, channelId: string, originId: string) => boolean;
+
+export { type NewNotificationSignal, type Notification, type NotificationPayload, type NotificationProcessorFilters, type NotificationReadSignal, type NotificationSettings, type NotificationSeverity, type NotificationSignal, type NotificationStatus, getProcessorFiltersFromConfig, isNotificationsEnabledFor, notificationSeverities };

package/dist/index.esm.js

@@ -1,2 +1,4 @@
 export { notificationSeverities } from './constants.esm.js';
+export { getProcessorFiltersFromConfig } from './filters.esm.js';
+export { isNotificationsEnabledFor } from './utils.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/utils.cjs.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const isNotificationsEnabledFor = (settings, channelId, originId) => {
+  const channel = settings.channels.find((c) => c.id === channelId);
+  if (!channel) {
+    return true;
+  }
+  const origin = channel.origins.find((o) => o.id === originId);
+  if (!origin) {
+    return true;
+  }
+  return origin.enabled;
+};
+
+exports.isNotificationsEnabledFor = isNotificationsEnabledFor;
+//# sourceMappingURL=utils.cjs.js.map

package/dist/utils.cjs.js.map

@@ -0,0 +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,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACA,EAAA,OAAO,MAAO,CAAA,OAAA,CAAA;AAChB;;;;"}

package/dist/utils.esm.js

@@ -0,0 +1,14 @@
+const isNotificationsEnabledFor = (settings, channelId, originId) => {
+  const channel = settings.channels.find((c) => c.id === channelId);
+  if (!channel) {
+    return true;
+  }
+  const origin = channel.origins.find((o) => o.id === originId);
+  if (!origin) {
+    return true;
+  }
+  return origin.enabled;
+};
+
+export { isNotificationsEnabledFor };
+//# sourceMappingURL=utils.esm.js.map

package/dist/utils.esm.js.map

@@ -0,0 +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,CAAA;AAC9D,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,SAAS,OAAQ,CAAA,OAAA,CAAQ,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,QAAQ,CAAA,CAAA;AAC1D,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACA,EAAA,OAAO,MAAO,CAAA,OAAA,CAAA;AAChB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-notifications-common",
-  "version": "0.0.4",
+  "version": "0.0.6-next.0",
   "description": "Common functionalities for the notifications plugin",
   "backstage": {
     "role": "common-library",
@@ -39,10 +39,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
+    "@backstage/config": "1.2.0",
     "@material-ui/icons": "^4.9.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.7"
+    "@backstage/cli": "0.29.0-next.0"
   },
   "module": "dist/index.esm.js"
 }