@grvpandey11/backstage-plugin-scaffolder-backend-module-ms-teams 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+# backstage-plugin-scaffolder-backend-module-ms-teams
+
+This is a `ms-teams` actions plugin for the `scaffolder-backend` in Backstage.
+
+This contains a collection of actions for using to send Microsoft Teams messages.
+
+## Prerequisites
+
+- Node must be installed in the environment
+
+- You must have a Microsoft Teams webhook URL available to send messages to
+
+## Getting Started
+
+In the root directory of your Backstage project:
+
+```shell
+yarn add --cwd packages/backend @grvpandey11/backstage-plugin-scaffolder-backend-module-ms-teams
+```
+
+Add the actions you'd like to the scaffolder:
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+import {
+  createSendTeamsMessageViaWebhookAction
+} from '@grvpandey11/backstage-plugin-scaffolder-backend-module-ms-teams'
+
+import { ScmIntegrations } from '@backstage/integration';
+import { createBuiltinActions, createRouter } from '@backstage/plugin-scaffolder-backend';
+
+...
+
+const integrations = ScmIntegrations.fromConfig(env.config);
+const builtInActions = createBuiltinActions({
+  catalogClient,
+  integrations,
+  config: env.config,
+  reader: env.reader
+});
+
+const actions = [
+    createSendTeamsMessageViaWebhookAction({config: env.config}),
+  ...builtInActions
+];
+
+return await createRouter({
+  logger: env.logger,
+  config: env.config,
+  database: env.database,
+  reader: env.reader,
+  catalogClient,
+  actions
+});
+```
+
+Add a ms-teams configuration section to your app-config.yaml.
+
+> You can omit this by providing a webhook URL in the input of the step in your scaffolder template, but it must be present in one place or the other.
+
+```yaml
+# app-config.yaml
+
+ms-teams:
+  webhookUrl: "https://your-url.com"
+```
+
+## Example of using the send message action in a template
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: ms-teams-demo
+  title: Microsoft Teams message demo
+  description: Send a message via MS Teams
+spec:
+  owner: user:grvpandey11
+  type: service
+
+  steps:
+    - id: send-ms-teams-message
+      name: Send message
+      action: ms-teams:sendMessage
+      input:
+        message: "Hello, world!"
+        webhookUrl: "https://your-url.com" # optional if the URL is supplied in the app-config.yaml
+```

package/dist/index.cjs.js

@@ -0,0 +1,64 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var axios = require('axios');
+var errors = require('@backstage/errors');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+
+function createSendTeamsMessageViaWebhookAction(options) {
+  const { config } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "ms-teams:sendMessage",
+    description: "Sends a Microsoft Teams message via a webhook",
+    schema: {
+      input: {
+        type: "object",
+        required: ["message"],
+        properties: {
+          message: {
+            title: "Message",
+            description: "The message to send via webhook",
+            type: "string"
+          },
+          webhookUrl: {
+            title: "Webhook URL",
+            description: "The Microsoft Teams webhook URL to send the request to. The URL must either be specified here or in the Backstage config",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      var _a;
+      const webhookUrl = (_a = config.getOptionalString("ms-teams.webhookUrl")) != null ? _a : ctx.input.webhookUrl;
+      if (!webhookUrl) {
+        throw new errors.InputError(
+          "Webhook URL is not specified in either the app-config or the action input. This must be specified in at least one place in order to send a message"
+        );
+      }
+      const body = {
+        text: ctx.input.message
+      };
+      const result = await axios__default["default"].post(webhookUrl, body);
+      if (result.status !== 200) {
+        ctx.logger.error(
+          `Something went wrong while trying to send a request to the Teams webhook URL - StatusCode ${result.status}`
+        );
+        ctx.logger.debug(`Response body: ${result.data}`);
+        ctx.logger.debug(`Webhook URL: ${webhookUrl}`);
+        ctx.logger.debug(`Input message: ${ctx.input.message}`);
+        throw new Error(
+          `Something went wrong while trying to send a request to the Teams webhook URL - StatusCode ${result.status}`
+        );
+      }
+    }
+  });
+}
+
+exports.createSendTeamsMessageViaWebhookAction = createSendTeamsMessageViaWebhookAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/ms-teams/send-ms-teams-message.ts"],"sourcesContent":["import { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport axios from 'axios';\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\n\n/**\n * Creates a `msteams:sendMessage` Scaffolder action.\n *\n * @public\n */\nexport function createSendTeamsMessageViaWebhookAction(options: {\n    config: Config;\n  }) {\n    const { config } = options;\n  \n    return createTemplateAction<{\n      message: string;\n      webhookUrl?: string;\n    }>({\n      id: 'ms-teams:sendMessage',\n      description: 'Sends a Microsoft Teams message via a webhook',\n      schema: {\n        input: {\n          type: 'object',\n          required: ['message'],\n          properties: {\n            message: {\n              title: 'Message',\n              description: 'The message to send via webhook',\n              type: 'string',\n            },\n            webhookUrl: {\n              title: 'Webhook URL',\n              description:\n                'The Microsoft Teams webhook URL to send the request to. The URL must either be specified here or in the Backstage config',\n              type: 'string',\n            },\n          },\n        },\n      },\n      async handler(ctx) {\n        const webhookUrl =\n          config.getOptionalString('ms-teams.webhookUrl') ?? ctx.input.webhookUrl;\n  \n        if (!webhookUrl) {\n          throw new InputError(\n            'Webhook URL is not specified in either the app-config or the action input. This must be specified in at least one place in order to send a message',\n          );\n        }\n  \n        const body = {\n          text: ctx.input.message,\n        };\n  \n        const result = await axios.post(webhookUrl, body);\n  \n        if (result.status !== 200) {\n          ctx.logger.error(\n            `Something went wrong while trying to send a request to the Teams webhook URL - StatusCode ${result.status}`,\n          );\n          ctx.logger.debug(`Response body: ${result.data}`);\n          ctx.logger.debug(`Webhook URL: ${webhookUrl}`);\n          ctx.logger.debug(`Input message: ${ctx.input.message}`);\n          throw new Error(\n            `Something went wrong while trying to send a request to the Teams webhook URL - StatusCode ${result.status}`,\n          );\n        }\n      },\n    });\n  }\n"],"names":["createTemplateAction","InputError","axios"],"mappings":";;;;;;;;;;;;AAUO,SAAS,uCAAuC,OAElD,EAAA;AACD,EAAM,MAAA,EAAE,QAAW,GAAA,OAAA,CAAA;AAEnB,EAAA,OAAOA,yCAGJ,CAAA;AAAA,IACD,EAAI,EAAA,sBAAA;AAAA,IACJ,WAAa,EAAA,+CAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,SAAA;AAAA,YACP,WAAa,EAAA,iCAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WACE,EAAA,0HAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AAxCzB,MAAA,IAAA,EAAA,CAAA;AAyCQ,MAAA,MAAM,cACJ,EAAO,GAAA,MAAA,CAAA,iBAAA,CAAkB,qBAAqB,CAA9C,KAAA,IAAA,GAAA,EAAA,GAAmD,IAAI,KAAM,CAAA,UAAA,CAAA;AAE/D,MAAA,IAAI,CAAC,UAAY,EAAA;AACf,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,oJAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,IAAO,GAAA;AAAA,QACX,IAAA,EAAM,IAAI,KAAM,CAAA,OAAA;AAAA,OAClB,CAAA;AAEA,MAAA,MAAM,MAAS,GAAA,MAAMC,yBAAM,CAAA,IAAA,CAAK,YAAY,IAAI,CAAA,CAAA;AAEhD,MAAI,IAAA,MAAA,CAAO,WAAW,GAAK,EAAA;AACzB,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA;AAAA,UACT,CAAA,0FAAA,EAA6F,OAAO,MAAM,CAAA,CAAA;AAAA,SAC5G,CAAA;AACA,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAkB,eAAA,EAAA,MAAA,CAAO,IAAI,CAAE,CAAA,CAAA,CAAA;AAChD,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAgB,aAAA,EAAA,UAAU,CAAE,CAAA,CAAA,CAAA;AAC7C,QAAA,GAAA,CAAI,OAAO,KAAM,CAAA,CAAA,eAAA,EAAkB,GAAI,CAAA,KAAA,CAAM,OAAO,CAAE,CAAA,CAAA,CAAA;AACtD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,0FAAA,EAA6F,OAAO,MAAM,CAAA,CAAA;AAAA,SAC5G,CAAA;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import * as _backstage_types from '@backstage/types';
+import { Config } from '@backstage/config';
+
+/**
+ * Creates a `msteams:sendMessage` Scaffolder action.
+ *
+ * @public
+ */
+declare function createSendTeamsMessageViaWebhookAction(options: {
+    config: Config;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    message: string;
+    webhookUrl?: string | undefined;
+}, _backstage_types.JsonObject>;
+
+export { createSendTeamsMessageViaWebhookAction };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@grvpandey11/backstage-plugin-scaffolder-backend-module-ms-teams",
+  "description": "The Microsoft Teams module for @backstage/plugin-scaffolder-backend",
+  "version": "1.0.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.19.0",
+    "@backstage/config": "^1.0.8",
+    "@backstage/errors": "^1.2.1",
+    "@backstage/plugin-scaffolder-node": "^0.1.5",
+    "@types/express": "*",
+    "axios": "^1.4.0",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "node-fetch": "^2.6.7",
+    "winston": "^3.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.22.8",
+    "@types/supertest": "^2.0.12",
+    "msw": "^1.0.0",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "dist"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+/***/
+/**
+ * The Ms Teams module for @backstage/plugin-scaffolder-backend.
+ *
+ * @packageDocumentation
+ */
+
+export * from './actions';