@backstage/plugin-scaffolder-backend-module-notifications 0.1.10-next.1 → 0.1.10-next.3

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @backstage/plugin-scaffolder-backend-module-notifications
 
+## 0.1.10-next.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.8.2-next.3
+  - @backstage/backend-plugin-api@1.3.1-next.2
+  - @backstage/plugin-notifications-common@0.0.8
+  - @backstage/plugin-notifications-node@0.2.15-next.2
+
+## 0.1.10-next.2
+
+### Patch Changes
+
+- b60253d: Change notification send scaffolder action to use native zod schemas
+- Updated dependencies
+  - @backstage/plugin-notifications-node@0.2.15-next.1
+  - @backstage/plugin-scaffolder-node@0.8.2-next.2
+  - @backstage/backend-plugin-api@1.3.1-next.1
+  - @backstage/plugin-notifications-common@0.0.8
+
 ## 0.1.10-next.1
 
 ### Patch Changes

package/dist/actions/sendNotification.cjs.js

@@ -11,55 +11,20 @@ function createSendNotificationAction(options) {
     examples: sendNotification_examples.examples,
     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"
-          }
-        }
+        recipients: (z) => z.enum(["broadcast", "entity"]).describe(
+          "The recipient of the notification, either broadcast or entity. If using entity, also entityRef must be provided"
+        ),
+        entityRefs: (z) => z.array(z.string()).optional().describe(
+          "The entity references to send the notification to, required if using recipient of entity"
+        ),
+        title: (z) => z.string().describe("Notification title"),
+        info: (z) => z.string().optional().describe("Notification description"),
+        link: (z) => z.string().optional().describe("Notification link"),
+        severity: (z) => z.enum(["low", "normal", "high", "critical"]).optional().describe("Notification severity"),
+        scope: (z) => z.string().optional().describe("Notification scope"),
+        optional: (z) => z.boolean().optional().describe(
+          "Do not fail the action if the notification sending fails"
+        )
       }
     },
     async handler(ctx) {

package/dist/actions/sendNotification.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"sendNotification.cjs.js","sources":["../../src/actions/sendNotification.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';\nimport { examples } from './sendNotification.examples';\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    examples,\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 ctx.checkpoint({\n          key: `send.notification.${payload.title}`,\n          fn: async () => {\n            await notifications.send({\n              recipients: notificationRecipients,\n              payload,\n            });\n          },\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"],"names":["createTemplateAction","examples"],"mappings":";;;;;AA6BO,SAAS,6BAA6B,OAE1C,EAAA;AACD,EAAM,MAAA,EAAE,eAAkB,GAAA,OAAA;AAC1B,EAAA,OAAOA,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,mBAAA;AAAA,IACJ,WAAa,EAAA,gDAAA;AAAA,cACbC,kCAAA;AAAA,IACA,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;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;AAAA;AACR,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WAAa,EAAA,oBAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,0BAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,MAAA;AAAA,YACP,WAAa,EAAA,mBAAA;AAAA,YACb,IAAM,EAAA;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;AAAA,WAC5C;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,OAAA;AAAA,YACP,WAAa,EAAA,oBAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,UAAA;AAAA,YACP,WACE,EAAA,0DAAA;AAAA,YACF,IAAM,EAAA;AAAA;AACR;AACF;AACF,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;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,UAAU,CAAE,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;AAAA;AAEtD,QAAA;AAAA;AAGF,MAAM,MAAA,sBAAA,GACJ,UAAe,KAAA,WAAA,GACX,EAAE,IAAA,EAAM,WAAY,EAAA,GACpB,EAAE,IAAA,EAAM,QAAU,EAAA,SAAA,EAAW,UAAY,EAAA;AAC/C,MAAA,MAAM,OAA+B,GAAA;AAAA,QACnC,KAAA;AAAA,QACA,WAAa,EAAA,IAAA;AAAA,QACb,IAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,GAAA,EAAK,CAAqB,kBAAA,EAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,UACvC,IAAI,YAAY;AACd,YAAA,MAAM,cAAc,IAAK,CAAA;AAAA,cACvB,UAAY,EAAA,sBAAA;AAAA,cACZ;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAAA,eACM,CAAG,EAAA;AACV,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AACpD,QAAA,IAAI,aAAa,IAAM,EAAA;AACrB,UAAM,MAAA,CAAA;AAAA;AACR;AACF;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"sendNotification.cjs.js","sources":["../../src/actions/sendNotification.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 { NotificationPayload } from '@backstage/plugin-notifications-common';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { examples } from './sendNotification.examples';\n\n/**\n * @public\n */\nexport function createSendNotificationAction(options: {\n  notifications: NotificationService;\n}) {\n  const { notifications } = options;\n  return createTemplateAction({\n    id: 'notification:send',\n    description: 'Sends a notification using NotificationService',\n    examples,\n    schema: {\n      input: {\n        recipients: z =>\n          z\n            .enum(['broadcast', 'entity'])\n            .describe(\n              'The recipient of the notification, either broadcast or entity. If using entity, also entityRef must be provided',\n            ),\n        entityRefs: z =>\n          z\n            .array(z.string())\n            .optional()\n            .describe(\n              'The entity references to send the notification to, required if using recipient of entity',\n            ),\n        title: z => z.string().describe('Notification title'),\n        info: z => z.string().optional().describe('Notification description'),\n        link: z => z.string().optional().describe('Notification link'),\n        severity: z =>\n          z\n            .enum(['low', 'normal', 'high', 'critical'])\n            .optional()\n            .describe('Notification severity'),\n        scope: z => z.string().optional().describe('Notification scope'),\n        optional: z =>\n          z\n            .boolean()\n            .optional()\n            .describe(\n              'Do not fail the action if the notification sending fails',\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 ctx.checkpoint({\n          key: `send.notification.${payload.title}`,\n          fn: async () => {\n            await notifications.send({\n              recipients: notificationRecipients,\n              payload,\n            });\n          },\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"],"names":["createTemplateAction","examples"],"mappings":";;;;;AA0BO,SAAS,6BAA6B,OAE1C,EAAA;AACD,EAAM,MAAA,EAAE,eAAkB,GAAA,OAAA;AAC1B,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,mBAAA;AAAA,IACJ,WAAa,EAAA,gDAAA;AAAA,cACbC,kCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,UAAA,EAAY,OACV,CACG,CAAA,IAAA,CAAK,CAAC,WAAa,EAAA,QAAQ,CAAC,CAC5B,CAAA,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACJ,UAAA,EAAY,OACV,CACG,CAAA,KAAA,CAAM,EAAE,MAAO,EAAC,CAChB,CAAA,QAAA,EACA,CAAA,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACJ,OAAO,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,oBAAoB,CAAA;AAAA,QACpD,IAAA,EAAM,OAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA,CAAE,SAAS,0BAA0B,CAAA;AAAA,QACpE,IAAA,EAAM,OAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA,CAAE,SAAS,mBAAmB,CAAA;AAAA,QAC7D,QAAU,EAAA,CAAA,CAAA,KACR,CACG,CAAA,IAAA,CAAK,CAAC,KAAO,EAAA,QAAA,EAAU,MAAQ,EAAA,UAAU,CAAC,CAAA,CAC1C,QAAS,EAAA,CACT,SAAS,uBAAuB,CAAA;AAAA,QACrC,KAAA,EAAO,OAAK,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA,CAAE,SAAS,oBAAoB,CAAA;AAAA,QAC/D,UAAU,CACR,CAAA,KAAA,CAAA,CACG,OAAQ,EAAA,CACR,UACA,CAAA,QAAA;AAAA,UACC;AAAA;AACF;AACN,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;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,UAAU,CAAE,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;AAAA;AAEtD,QAAA;AAAA;AAGF,MAAM,MAAA,sBAAA,GACJ,UAAe,KAAA,WAAA,GACX,EAAE,IAAA,EAAM,WAAY,EAAA,GACpB,EAAE,IAAA,EAAM,QAAU,EAAA,SAAA,EAAW,UAAY,EAAA;AAC/C,MAAA,MAAM,OAA+B,GAAA;AAAA,QACnC,KAAA;AAAA,QACA,WAAa,EAAA,IAAA;AAAA,QACb,IAAA;AAAA,QACA,QAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,GAAA,EAAK,CAAqB,kBAAA,EAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,UACvC,IAAI,YAAY;AACd,YAAA,MAAM,cAAc,IAAK,CAAA;AAAA,cACvB,UAAY,EAAA,sBAAA;AAAA,cACZ;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAAA,eACM,CAAG,EAAA;AACV,QAAA,GAAA,CAAI,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AACpD,QAAA,IAAI,aAAa,IAAM,EAAA;AACrB,UAAM,MAAA,CAAA;AAAA;AACR;AACF;AACF,GACD,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,5 @@
 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';
 
 /**
@@ -10,15 +8,17 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 declare function createSendNotificationAction(options: {
     notifications: NotificationService;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
-    recipients: string;
-    entityRefs?: string[];
+    recipients: "entity" | "broadcast";
     title: string;
-    info?: string;
-    link?: string;
-    severity?: NotificationSeverity;
-    scope?: string;
-    optional?: boolean;
-}, _backstage_types.JsonObject, "v1">;
+    entityRefs?: string[] | undefined;
+    info?: string | undefined;
+    link?: string | undefined;
+    severity?: "normal" | "high" | "low" | "critical" | undefined;
+    scope?: string | undefined;
+    optional?: boolean | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-notifications",
-  "version": "0.1.10-next.1",
+  "version": "0.1.10-next.3",
   "description": "The notifications backend module for the scaffolder plugin.",
   "backstage": {
     "role": "backend-plugin-module",
@@ -36,16 +36,16 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.3.1-next.1",
+    "@backstage/backend-plugin-api": "1.3.1-next.2",
     "@backstage/plugin-notifications-common": "0.0.8",
-    "@backstage/plugin-notifications-node": "0.2.15-next.1",
-    "@backstage/plugin-scaffolder-node": "0.8.2-next.1",
+    "@backstage/plugin-notifications-node": "0.2.15-next.2",
+    "@backstage/plugin-scaffolder-node": "0.8.2-next.3",
     "octokit": "^3.0.0",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.32.1-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.2.2-next.1"
+    "@backstage/cli": "0.32.1-next.3",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.2.2-next.3"
   },
   "typesVersions": {
     "*": {