@backstage/plugin-scaffolder-backend-module-notifications 0.0.0-nightly-20240507021634

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @backstage/plugin-scaffolder-backend-module-notifications
+
+## 0.0.0-nightly-20240507021634
+
+### Patch Changes
+
+- 503d769: Add a new scaffolder action to allow sending notifications from templates
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20240507021634
+  - @backstage/plugin-notifications-node@0.0.0-nightly-20240507021634
+  - @backstage/backend-plugin-api@0.0.0-nightly-20240507021634
+  - @backstage/plugin-scaffolder-node@0.0.0-nightly-20240507021634

package/README.md

@@ -0,0 +1,5 @@
+# @backstage/plugin-scaffolder-backend-module-notifications
+
+The notifications backend module for the scaffolder plugin.
+
+_This plugin was created through the Backstage CLI_

package/dist/index.cjs.js

@@ -0,0 +1,127 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginNotificationsNode = require('@backstage/plugin-notifications-node');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+
+function createSendNotificationAction(options) {
+  const { notifications } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "notification:send",
+    description: "Sends a notification using NotificationService",
+    schema: {
+      input: {
+        type: "object",
+        required: ["recipients", "title"],
+        properties: {
+          recipients: {
+            title: "Recipient",
+            enum: ["broadcast", "entity"],
+            description: "The recipient of the notification, either broadcast or entity. If using entity, also entityRef must be provided",
+            type: "string"
+          },
+          entityRefs: {
+            title: "Entity references",
+            description: "The entity references to send the notification to, required if using recipient of entity",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          title: {
+            title: "Title",
+            description: "Notification title",
+            type: "string"
+          },
+          info: {
+            title: "Description",
+            description: "Notification description",
+            type: "string"
+          },
+          link: {
+            title: "Link",
+            description: "Notification link",
+            type: "string"
+          },
+          severity: {
+            title: "Severity",
+            type: "string",
+            description: `Notification severity`,
+            enum: ["low", "normal", "high", "critical"]
+          },
+          scope: {
+            title: "Scope",
+            description: "Notification scope",
+            type: "string"
+          },
+          optional: {
+            title: "Optional",
+            description: "Do not fail the action if the notification sending fails",
+            type: "boolean"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        recipients,
+        entityRefs,
+        title,
+        info,
+        link,
+        severity,
+        scope,
+        optional
+      } = ctx.input;
+      ctx.logger.info(`Sending notification to ${recipients}`);
+      if (recipients === "entity" && !entityRefs) {
+        if (optional !== true) {
+          throw new Error("Entity references must be provided");
+        }
+        return;
+      }
+      const notificationRecipients = recipients === "broadcast" ? { type: "broadcast" } : { type: "entity", entityRef: entityRefs };
+      const payload = {
+        title,
+        description: info,
+        link,
+        severity,
+        scope
+      };
+      try {
+        await notifications.send({
+          recipients: notificationRecipients,
+          payload
+        });
+      } catch (e) {
+        ctx.logger.error(`Failed to send notification: ${e}`);
+        if (optional !== true) {
+          throw e;
+        }
+      }
+    }
+  });
+}
+
+const scaffolderModuleNotifications = backendPluginApi.createBackendModule({
+  pluginId: "scaffolder",
+  moduleId: "notifications",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        notifications: pluginNotificationsNode.notificationService,
+        scaffolder: alpha.scaffolderActionsExtensionPoint
+      },
+      async init({ notifications, scaffolder }) {
+        scaffolder.addActions(createSendNotificationAction({ notifications }));
+      }
+    });
+  }
+});
+
+exports.createSendNotificationAction = createSendNotificationAction;
+exports.default = scaffolderModuleNotifications;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/sendNotification.ts","../src/module.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 {\n  NotificationRecipients,\n  NotificationService,\n} from '@backstage/plugin-notifications-node';\nimport {\n  NotificationPayload,\n  NotificationSeverity,\n} from '@backstage/plugin-notifications-common';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\n\n/**\n * @public\n */\nexport function createSendNotificationAction(options: {\n  notifications: NotificationService;\n}) {\n  const { notifications } = options;\n  return createTemplateAction<{\n    recipients: string;\n    entityRefs?: string[];\n    title: string;\n    info?: string;\n    link?: string;\n    severity?: NotificationSeverity;\n    scope?: string;\n    optional?: boolean;\n  }>({\n    id: 'notification:send',\n    description: 'Sends a notification using NotificationService',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['recipients', 'title'],\n        properties: {\n          recipients: {\n            title: 'Recipient',\n            enum: ['broadcast', 'entity'],\n            description:\n              'The recipient of the notification, either broadcast or entity. If using entity, also entityRef must be provided',\n            type: 'string',\n          },\n          entityRefs: {\n            title: 'Entity references',\n            description:\n              'The entity references to send the notification to, required if using recipient of entity',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          title: {\n            title: 'Title',\n            description: 'Notification title',\n            type: 'string',\n          },\n          info: {\n            title: 'Description',\n            description: 'Notification description',\n            type: 'string',\n          },\n          link: {\n            title: 'Link',\n            description: 'Notification link',\n            type: 'string',\n          },\n          severity: {\n            title: 'Severity',\n            type: 'string',\n            description: `Notification severity`,\n            enum: ['low', 'normal', 'high', 'critical'],\n          },\n          scope: {\n            title: 'Scope',\n            description: 'Notification scope',\n            type: 'string',\n          },\n          optional: {\n            title: 'Optional',\n            description:\n              'Do not fail the action if the notification sending fails',\n            type: 'boolean',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        recipients,\n        entityRefs,\n        title,\n        info,\n        link,\n        severity,\n        scope,\n        optional,\n      } = ctx.input;\n\n      ctx.logger.info(`Sending notification to ${recipients}`);\n      if (recipients === 'entity' && !entityRefs) {\n        if (optional !== true) {\n          throw new Error('Entity references must be provided');\n        }\n        return;\n      }\n\n      const notificationRecipients: NotificationRecipients =\n        recipients === 'broadcast'\n          ? { type: 'broadcast' }\n          : { type: 'entity', entityRef: entityRefs! };\n      const payload: NotificationPayload = {\n        title,\n        description: info,\n        link,\n        severity,\n        scope,\n      };\n\n      try {\n        await notifications.send({\n          recipients: notificationRecipients,\n          payload,\n        });\n      } catch (e) {\n        ctx.logger.error(`Failed to send notification: ${e}`);\n        if (optional !== true) {\n          throw e;\n        }\n      }\n    },\n  });\n}\n","/*\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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { notificationService } from '@backstage/plugin-notifications-node';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport { createSendNotificationAction } from './actions';\n\n/**\n * @public\n * The Notifications module for the Scaffolder Backend\n */\nexport const scaffolderModuleNotifications = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'notifications',\n  register(reg) {\n    reg.registerInit({\n      deps: {\n        notifications: notificationService,\n        scaffolder: scaffolderActionsExtensionPoint,\n      },\n      async init({ notifications, scaffolder }) {\n        scaffolder.addActions(createSendNotificationAction({ notifications }));\n      },\n    });\n  },\n});\n"],"names":["createTemplateAction","createBackendModule","notificationService","scaffolderActionsExtensionPoint"],"mappings":";;;;;;;;;AA4BO,SAAS,6BAA6B,OAE1C,EAAA;AACD,EAAM,MAAA,EAAE,eAAkB,GAAA,OAAA,CAAA;AAC1B,EAAA,OAAOA,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,mBAAA;AAAA,IACJ,WAAa,EAAA,gDAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,YAAA,EAAc,OAAO,CAAA;AAAA,QAChC,UAAY,EAAA;AAAA,UACV,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,WAAA;AAAA,YACP,IAAA,EAAM,CAAC,WAAA,EAAa,QAAQ,CAAA;AAAA,YAC5B,WACE,EAAA,iHAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA,0FAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,aACR;AAAA,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WAAa,EAAA,oBAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,0BAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,MAAA;AAAA,YACP,WAAa,EAAA,mBAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,UAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,CAAA,qBAAA,CAAA;AAAA,YACb,IAAM,EAAA,CAAC,KAAO,EAAA,QAAA,EAAU,QAAQ,UAAU,CAAA;AAAA,WAC5C;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WAAa,EAAA,oBAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,UAAA;AAAA,YACP,WACE,EAAA,0DAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,KAAA;AAAA,QACA,QAAA;AAAA,UACE,GAAI,CAAA,KAAA,CAAA;AAER,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,UAAU,CAAE,CAAA,CAAA,CAAA;AACvD,MAAI,IAAA,UAAA,KAAe,QAAY,IAAA,CAAC,UAAY,EAAA;AAC1C,QAAA,IAAI,aAAa,IAAM,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,oCAAoC,CAAA,CAAA;AAAA,SACtD;AACA,QAAA,OAAA;AAAA,OACF;AAEA,MAAM,MAAA,sBAAA,GACJ,UAAe,KAAA,WAAA,GACX,EAAE,IAAA,EAAM,WAAY,EAAA,GACpB,EAAE,IAAA,EAAM,QAAU,EAAA,SAAA,EAAW,UAAY,EAAA,CAAA;AAC/C,MAAA,MAAM,OAA+B,GAAA;AAAA,QACnC,KAAA;AAAA,QACA,WAAa,EAAA,IAAA;AAAA,QACb,IAAA;AAAA,QACA,QAAA;AAAA,QACA,KAAA;AAAA,OACF,CAAA;AAEA,MAAI,IAAA;AACF,QAAA,MAAM,cAAc,IAAK,CAAA;AAAA,UACvB,UAAY,EAAA,sBAAA;AAAA,UACZ,OAAA;AAAA,SACD,CAAA,CAAA;AAAA,eACM,CAAG,EAAA;AACV,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AACpD,QAAA,IAAI,aAAa,IAAM,EAAA;AACrB,UAAM,MAAA,CAAA,CAAA;AAAA,SACR;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;ACzHO,MAAM,gCAAgCC,oCAAoB,CAAA;AAAA,EAC/D,QAAU,EAAA,YAAA;AAAA,EACV,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,aAAe,EAAAC,2CAAA;AAAA,QACf,UAAY,EAAAC,qCAAA;AAAA,OACd;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,aAAA,EAAe,YAAc,EAAA;AACxC,QAAA,UAAA,CAAW,UAAW,CAAA,4BAAA,CAA6B,EAAE,aAAA,EAAe,CAAC,CAAA,CAAA;AAAA,OACvE;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import * as _backstage_types from '@backstage/types';
+import { NotificationService } from '@backstage/plugin-notifications-node';
+import { NotificationSeverity } from '@backstage/plugin-notifications-common';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * @public
+ */
+declare function createSendNotificationAction(options: {
+    notifications: NotificationService;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    recipients: string;
+    entityRefs?: string[] | undefined;
+    title: string;
+    info?: string | undefined;
+    link?: string | undefined;
+    severity?: NotificationSeverity | undefined;
+    scope?: string | undefined;
+    optional?: boolean | undefined;
+}, _backstage_types.JsonObject>;
+
+/**
+ * @public
+ * The Notifications module for the Scaffolder Backend
+ */
+declare const scaffolderModuleNotifications: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { createSendNotificationAction, scaffolderModuleNotifications as default };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-notifications",
+  "version": "0.0.0-nightly-20240507021634",
+  "description": "The notifications backend module for the scaffolder plugin.",
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/scaffolder-backend-module-notifications"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20240507021634",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20240507021634",
+    "@backstage/plugin-notifications-common": "^0.0.3",
+    "@backstage/plugin-notifications-node": "^0.0.0-nightly-20240507021634",
+    "@backstage/plugin-scaffolder-node": "^0.0.0-nightly-20240507021634",
+    "octokit": "^3.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20240507021634",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.0.0-nightly-20240507021634"
+  }
+}