@marble-sh/backstage-plugin-scaffolder-backend-module-grafana 0.2.0

package/README.md

@@ -0,0 +1,104 @@
+# @marble-sh/backstage-plugin-scaffolder-backend-module-grafana
+
+A scaffolder backend module that adds Grafana provisioning actions to the
+[Backstage Software Templates](https://backstage.io/docs/features/software-templates/)
+scaffolder.
+
+> This is the **only write path** in the Grafana plugin suite — every other
+> package is strictly read-only. The action writes to Grafana using the same
+> `grafana.instances` configuration (and service-account tokens) as the rest of
+> the suite.
+
+## Actions
+
+### `grafana:dashboard:create`
+
+Creates (or, with `overwrite`, updates) a dashboard in a configured Grafana
+instance via the App Platform `dashboard.grafana.app/v1` API.
+
+| Input          | Type       | Required | Description                                                                |
+| -------------- | ---------- | -------- | -------------------------------------------------------------------------- |
+| `title`        | `string`   | yes      | The dashboard title.                                                       |
+| `instanceName` | `string`   | no       | Which configured instance to target. Optional when only one is configured. |
+| `uid`          | `string`   | no       | Dashboard uid (`metadata.name`). Grafana generates one when omitted.       |
+| `folderUid`    | `string`   | no       | The uid of the folder to create the dashboard in.                          |
+| `tags`         | `string[]` | no       | Dashboard tags.                                                            |
+| `dashboard`    | `object`   | no       | Extra dashboard spec fields (panels, templating, …) merged into the spec.  |
+| `overwrite`    | `boolean`  | no       | Update the dashboard if it already exists (requires `uid`).                |
+
+Outputs: `uid`, `url`, and `instanceName`.
+
+Example template step:
+
+```yaml
+steps:
+  - id: create-dashboard
+    name: Create Grafana dashboard
+    action: grafana:dashboard:create
+    input:
+      instanceName: production
+      title: ${{ parameters.name }} overview
+      tags:
+        - ${{ parameters.name }}
+  - id: log
+    name: Log
+    action: debug:log
+    input:
+      message: 'Created ${{ steps["create-dashboard"].output.url }}'
+```
+
+## Installation
+
+```sh
+yarn --cwd packages/backend add @marble-sh/backstage-plugin-scaffolder-backend-module-grafana
+```
+
+```ts
+// packages/backend/src/index.ts
+backend.add(import('@backstage/plugin-scaffolder-backend'));
+backend.add(
+  import('@marble-sh/backstage-plugin-scaffolder-backend-module-grafana'),
+);
+```
+
+The action reads its connection details from `grafana.instances` (see the
+[backend plugin](../grafana-backend/README.md) for that configuration). The
+service-account token must have permission to create dashboards.
+
+## Guard rails (`grafana.scaffolder`)
+
+Because this module is the suite's only write path, two config options restrict
+what templates may do:
+
+```yaml
+grafana:
+  scaffolder:
+    allowedInstances: [staging] # defaults to every configured instance
+    allowOverwrite: false # defaults to true
+```
+
+- **`allowedInstances`** — which instances the actions may write to.
+  - unset (default): every instance under `grafana.instances` is writable.
+  - a list of names: writes to any other instance fail with a
+    `NotAllowedError`, and automatic instance selection (when `instanceName`
+    is omitted) only considers the listed instances — so a template can omit
+    `instanceName` whenever exactly one instance is writable, regardless of
+    how many are configured. An empty list makes nothing writable. A listed
+    name that doesn't exist under `grafana.instances` fails the action with a
+    configuration error.
+- **`allowOverwrite`** — whether `grafana:dashboard:create` may update
+  existing dashboards.
+  - `true` (default): the action's `overwrite: true` input updates the
+    dashboard with the given `uid` in place.
+  - `false`: any run requesting `overwrite` fails with a `NotAllowedError`;
+    the action can only create new dashboards.
+
+## Testing
+
+```sh
+yarn workspace @marble-sh/backstage-plugin-scaffolder-backend-module-grafana test
+```
+
+The action is unit-tested with an injected `fetch` and
+`createMockActionContext`; the module is verified to register its action via
+`startTestBackend`.

package/config.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "grafana": {
+      "type": "object",
+      "properties": {
+        "scaffolder": {
+          "type": "object",
+          "properties": {
+            "allowedInstances": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Which configured Grafana instances the scaffolder actions may write to.\n\n - unset (default): every instance under `grafana.instances` is    writable.  - a list of instance names: only those instances accept writes.    Targeting any other instance fails the action with a 403-style    error, and automatic instance selection (when `instanceName` is    omitted) only considers the listed instances. A listed name that    does not exist under `grafana.instances` fails the action with a    configuration error."
+            },
+            "allowOverwrite": {
+              "type": "boolean",
+              "description": "Whether the `grafana:dashboard:create` action may update existing dashboards.\n\n - `true` (default): the action's `overwrite: true` input updates the    dashboard with the given `uid` in place.  - `false`: any run requesting `overwrite` fails; the action can only    create new dashboards."
+            }
+          },
+          "description": "Guard rails for the Grafana scaffolder actions — the only write path in the plugin suite."
+        }
+      }
+    }
+  }
+}

package/dist/actions/createDashboard.cjs.js

@@ -0,0 +1,139 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var backstagePluginGrafanaNode = require('@marble-sh/backstage-plugin-grafana-node');
+
+function readGuardConfig(rootConfig) {
+  const config = rootConfig.getOptionalConfig("grafana.scaffolder");
+  return {
+    allowedInstances: config?.getOptionalStringArray("allowedInstances"),
+    allowOverwrite: config?.getOptionalBoolean("allowOverwrite") ?? true
+  };
+}
+function resolveInstance(instances, guard, name) {
+  const { allowedInstances } = guard;
+  if (allowedInstances) {
+    const known = new Set(instances.map((instance) => instance.name));
+    const unknown = allowedInstances.filter((allowed) => !known.has(allowed));
+    if (unknown.length > 0) {
+      throw new errors.InputError(
+        `grafana.scaffolder.allowedInstances names unknown instance(s) '${unknown.join(
+          "', '"
+        )}'; configured instances are: ${[...known].join(", ")}`
+      );
+    }
+  }
+  if (name) {
+    const found = instances.find((instance) => instance.name === name);
+    if (!found) {
+      throw new errors.NotFoundError(
+        `No Grafana instance configured with name '${name}'`
+      );
+    }
+    if (allowedInstances && !allowedInstances.includes(found.name)) {
+      throw new errors.NotAllowedError(
+        `Grafana instance '${found.name}' is not writable by the scaffolder (grafana.scaffolder.allowedInstances)`
+      );
+    }
+    return found;
+  }
+  const writable = allowedInstances ? instances.filter((instance) => allowedInstances.includes(instance.name)) : instances;
+  if (writable.length === 0) {
+    throw new errors.InputError(
+      "No Grafana instances are configured and writable by the scaffolder"
+    );
+  }
+  if (writable.length > 1) {
+    throw new errors.InputError(
+      "Multiple Grafana instances are configured; set input.instanceName to choose one"
+    );
+  }
+  return writable[0];
+}
+function createGrafanaDashboardCreateAction(options) {
+  const fetchApi = options.fetch ?? fetch;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "grafana:dashboard:create",
+    description: "Creates or updates a Grafana dashboard via the App Platform API",
+    schema: {
+      input: {
+        instanceName: (z) => z.string({
+          description: "The configured Grafana instance to target. Optional when only one instance is configured."
+        }).optional(),
+        title: (z) => z.string({ description: "The dashboard title" }),
+        uid: (z) => z.string({
+          description: "The dashboard uid (metadata.name). When omitted, Grafana generates one."
+        }).optional(),
+        folderUid: (z) => z.string({ description: "The uid of the folder to create it in" }).optional(),
+        tags: (z) => z.array(z.string(), { description: "Dashboard tags" }).optional(),
+        dashboard: (z) => z.record(z.any(), {
+          description: "Additional dashboard spec fields (panels, templating, etc.), merged into the request spec."
+        }).optional(),
+        overwrite: (z) => z.boolean({
+          description: "Update the dashboard if it already exists (requires uid)."
+        }).optional()
+      },
+      output: {
+        uid: (z) => z.string({ description: "The uid of the dashboard" }),
+        url: (z) => z.string({ description: "The URL of the dashboard" }),
+        instanceName: (z) => z.string({
+          description: "The instance the dashboard was created in"
+        })
+      }
+    },
+    async handler(ctx) {
+      const { title, uid, folderUid, tags, dashboard, overwrite } = ctx.input;
+      const guard = readGuardConfig(options.config);
+      const instance = resolveInstance(
+        backstagePluginGrafanaNode.readGrafanaInstances(options.config),
+        guard,
+        ctx.input.instanceName
+      );
+      if (overwrite && !guard.allowOverwrite) {
+        throw new errors.NotAllowedError(
+          "Updating existing dashboards is disabled by configuration (grafana.scaffolder.allowOverwrite)"
+        );
+      }
+      const isUpdate = Boolean(overwrite && uid);
+      const collection = `/apis/dashboard.grafana.app/v1/namespaces/${instance.namespace}/dashboards`;
+      const path = isUpdate ? `${collection}/${uid}` : collection;
+      ctx.logger.info(
+        `${isUpdate ? "Updating" : "Creating"} Grafana dashboard '${title}' in instance '${instance.name}'`
+      );
+      const response = await fetchApi(`${instance.baseUrl}${path}`, {
+        method: isUpdate ? "PUT" : "POST",
+        headers: {
+          Authorization: `Bearer ${instance.token}`,
+          "Content-Type": "application/json",
+          Accept: "application/json"
+        },
+        body: JSON.stringify({
+          metadata: {
+            ...uid ? { name: uid } : {},
+            ...folderUid ? { annotations: { "grafana.app/folder": folderUid } } : {}
+          },
+          spec: {
+            title,
+            schemaVersion: 41,
+            tags: tags ?? [],
+            panels: [],
+            ...dashboard ?? {}
+          }
+        })
+      });
+      if (!response.ok) {
+        throw await errors.ResponseError.fromResponse(response);
+      }
+      const body = await response.json();
+      const resultUid = body.metadata?.name ?? uid ?? "";
+      const url = `${instance.baseUrl}/d/${resultUid}/${backstagePluginGrafanaNode.slugify(title)}`;
+      ctx.output("uid", resultUid);
+      ctx.output("url", url);
+      ctx.output("instanceName", instance.name);
+    }
+  });
+}
+
+exports.createGrafanaDashboardCreateAction = createGrafanaDashboardCreateAction;
+//# sourceMappingURL=createDashboard.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createDashboard.cjs.js","sources":["../../src/actions/createDashboard.ts"],"sourcesContent":["/*\n * Copyright 2026 Cassidy Marble\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 */\n\nimport { Config } from '@backstage/config';\nimport {\n  InputError,\n  NotAllowedError,\n  NotFoundError,\n  ResponseError,\n} from '@backstage/errors';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport {\n  FetchApi,\n  GrafanaInstanceConfig,\n  readGrafanaInstances,\n  slugify,\n} from '@marble-sh/backstage-plugin-grafana-node';\n\ntype ScaffolderGuardConfig = {\n  allowedInstances?: string[];\n  allowOverwrite: boolean;\n};\n\nfunction readGuardConfig(rootConfig: Config): ScaffolderGuardConfig {\n  const config = rootConfig.getOptionalConfig('grafana.scaffolder');\n  return {\n    allowedInstances: config?.getOptionalStringArray('allowedInstances'),\n    allowOverwrite: config?.getOptionalBoolean('allowOverwrite') ?? true,\n  };\n}\n\nfunction resolveInstance(\n  instances: GrafanaInstanceConfig[],\n  guard: ScaffolderGuardConfig,\n  name?: string,\n): GrafanaInstanceConfig {\n  const { allowedInstances } = guard;\n  if (allowedInstances) {\n    const known = new Set(instances.map(instance => instance.name));\n    const unknown = allowedInstances.filter(allowed => !known.has(allowed));\n    if (unknown.length > 0) {\n      throw new InputError(\n        `grafana.scaffolder.allowedInstances names unknown instance(s) '${unknown.join(\n          \"', '\",\n        )}'; configured instances are: ${[...known].join(', ')}`,\n      );\n    }\n  }\n\n  if (name) {\n    const found = instances.find(instance => instance.name === name);\n    if (!found) {\n      throw new NotFoundError(\n        `No Grafana instance configured with name '${name}'`,\n      );\n    }\n    if (allowedInstances && !allowedInstances.includes(found.name)) {\n      throw new NotAllowedError(\n        `Grafana instance '${found.name}' is not writable by the scaffolder (grafana.scaffolder.allowedInstances)`,\n      );\n    }\n    return found;\n  }\n\n  // Automatic selection only considers writable instances.\n  const writable = allowedInstances\n    ? instances.filter(instance => allowedInstances.includes(instance.name))\n    : instances;\n  if (writable.length === 0) {\n    throw new InputError(\n      'No Grafana instances are configured and writable by the scaffolder',\n    );\n  }\n  if (writable.length > 1) {\n    throw new InputError(\n      'Multiple Grafana instances are configured; set input.instanceName to choose one',\n    );\n  }\n  return writable[0];\n}\n\n/**\n * Creates the `grafana:dashboard:create` scaffolder action, which creates (or\n * updates) a dashboard in a configured Grafana instance via the App Platform\n * `dashboard.grafana.app/v1` API.\n *\n * @public\n */\nexport function createGrafanaDashboardCreateAction(options: {\n  config: Config;\n  fetch?: FetchApi;\n}) {\n  const fetchApi = options.fetch ?? fetch;\n\n  return createTemplateAction({\n    id: 'grafana:dashboard:create',\n    description:\n      'Creates or updates a Grafana dashboard via the App Platform API',\n    schema: {\n      input: {\n        instanceName: z =>\n          z\n            .string({\n              description:\n                'The configured Grafana instance to target. Optional when only one instance is configured.',\n            })\n            .optional(),\n        title: z => z.string({ description: 'The dashboard title' }),\n        uid: z =>\n          z\n            .string({\n              description:\n                'The dashboard uid (metadata.name). When omitted, Grafana generates one.',\n            })\n            .optional(),\n        folderUid: z =>\n          z\n            .string({ description: 'The uid of the folder to create it in' })\n            .optional(),\n        tags: z =>\n          z.array(z.string(), { description: 'Dashboard tags' }).optional(),\n        dashboard: z =>\n          z\n            .record(z.any(), {\n              description:\n                'Additional dashboard spec fields (panels, templating, etc.), merged into the request spec.',\n            })\n            .optional(),\n        overwrite: z =>\n          z\n            .boolean({\n              description:\n                'Update the dashboard if it already exists (requires uid).',\n            })\n            .optional(),\n      },\n      output: {\n        uid: z => z.string({ description: 'The uid of the dashboard' }),\n        url: z => z.string({ description: 'The URL of the dashboard' }),\n        instanceName: z =>\n          z.string({\n            description: 'The instance the dashboard was created in',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const { title, uid, folderUid, tags, dashboard, overwrite } = ctx.input;\n      const guard = readGuardConfig(options.config);\n      const instance = resolveInstance(\n        readGrafanaInstances(options.config),\n        guard,\n        ctx.input.instanceName,\n      );\n\n      if (overwrite && !guard.allowOverwrite) {\n        throw new NotAllowedError(\n          'Updating existing dashboards is disabled by configuration (grafana.scaffolder.allowOverwrite)',\n        );\n      }\n\n      const isUpdate = Boolean(overwrite && uid);\n      const collection = `/apis/dashboard.grafana.app/v1/namespaces/${instance.namespace}/dashboards`;\n      const path = isUpdate ? `${collection}/${uid}` : collection;\n\n      ctx.logger.info(\n        `${\n          isUpdate ? 'Updating' : 'Creating'\n        } Grafana dashboard '${title}' in instance '${instance.name}'`,\n      );\n\n      const response = await fetchApi(`${instance.baseUrl}${path}`, {\n        method: isUpdate ? 'PUT' : 'POST',\n        headers: {\n          Authorization: `Bearer ${instance.token}`,\n          'Content-Type': 'application/json',\n          Accept: 'application/json',\n        },\n        body: JSON.stringify({\n          metadata: {\n            ...(uid ? { name: uid } : {}),\n            ...(folderUid\n              ? { annotations: { 'grafana.app/folder': folderUid } }\n              : {}),\n          },\n          spec: {\n            title,\n            schemaVersion: 41,\n            tags: tags ?? [],\n            panels: [],\n            ...(dashboard ?? {}),\n          },\n        }),\n      });\n\n      if (!response.ok) {\n        throw await ResponseError.fromResponse(response);\n      }\n\n      const body = (await response.json()) as { metadata?: { name?: string } };\n      const resultUid = body.metadata?.name ?? uid ?? '';\n      const url = `${instance.baseUrl}/d/${resultUid}/${slugify(title)}`;\n\n      ctx.output('uid', resultUid);\n      ctx.output('url', url);\n      ctx.output('instanceName', instance.name);\n    },\n  });\n}\n"],"names":["InputError","NotFoundError","NotAllowedError","createTemplateAction","readGrafanaInstances","ResponseError","slugify"],"mappings":";;;;;;AAoCA,SAAS,gBAAgB,UAAA,EAA2C;AAClE,EAAA,MAAM,MAAA,GAAS,UAAA,CAAW,iBAAA,CAAkB,oBAAoB,CAAA;AAChE,EAAA,OAAO;AAAA,IACL,gBAAA,EAAkB,MAAA,EAAQ,sBAAA,CAAuB,kBAAkB,CAAA;AAAA,IACnE,cAAA,EAAgB,MAAA,EAAQ,kBAAA,CAAmB,gBAAgB,CAAA,IAAK;AAAA,GAClE;AACF;AAEA,SAAS,eAAA,CACP,SAAA,EACA,KAAA,EACA,IAAA,EACuB;AACvB,EAAA,MAAM,EAAE,kBAAiB,GAAI,KAAA;AAC7B,EAAA,IAAI,gBAAA,EAAkB;AACpB,IAAA,MAAM,KAAA,GAAQ,IAAI,GAAA,CAAI,SAAA,CAAU,IAAI,CAAA,QAAA,KAAY,QAAA,CAAS,IAAI,CAAC,CAAA;AAC9D,IAAA,MAAM,OAAA,GAAU,iBAAiB,MAAA,CAAO,CAAA,OAAA,KAAW,CAAC,KAAA,CAAM,GAAA,CAAI,OAAO,CAAC,CAAA;AACtE,IAAA,IAAI,OAAA,CAAQ,SAAS,CAAA,EAAG;AACtB,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,kEAAkE,OAAA,CAAQ,IAAA;AAAA,UACxE;AAAA,SACD,gCAAgC,CAAC,GAAG,KAAK,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,OACxD;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,IAAA,EAAM;AACR,IAAA,MAAM,QAAQ,SAAA,CAAU,IAAA,CAAK,CAAA,QAAA,KAAY,QAAA,CAAS,SAAS,IAAI,CAAA;AAC/D,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,6CAA6C,IAAI,CAAA,CAAA;AAAA,OACnD;AAAA,IACF;AACA,IAAA,IAAI,oBAAoB,CAAC,gBAAA,CAAiB,QAAA,CAAS,KAAA,CAAM,IAAI,CAAA,EAAG;AAC9D,MAAA,MAAM,IAAIC,sBAAA;AAAA,QACR,CAAA,kBAAA,EAAqB,MAAM,IAAI,CAAA,yEAAA;AAAA,OACjC;AAAA,IACF;AACA,IAAA,OAAO,KAAA;AAAA,EACT;AAGA,EAAA,MAAM,QAAA,GAAW,gBAAA,GACb,SAAA,CAAU,MAAA,CAAO,CAAA,QAAA,KAAY,iBAAiB,QAAA,CAAS,QAAA,CAAS,IAAI,CAAC,CAAA,GACrE,SAAA;AACJ,EAAA,IAAI,QAAA,CAAS,WAAW,CAAA,EAAG;AACzB,IAAA,MAAM,IAAIF,iBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AACA,EAAA,IAAI,QAAA,CAAS,SAAS,CAAA,EAAG;AACvB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AACA,EAAA,OAAO,SAAS,CAAC,CAAA;AACnB;AASO,SAAS,mCAAmC,OAAA,EAGhD;AACD,EAAA,MAAM,QAAA,GAAW,QAAQ,KAAA,IAAS,KAAA;AAElC,EAAA,OAAOG,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,0BAAA;AAAA,IACJ,WAAA,EACE,iEAAA;AAAA,IACF,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,YAAA,EAAc,CAAA,CAAA,KACZ,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,OAAO,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,EAAE,WAAA,EAAa,uBAAuB,CAAA;AAAA,QAC3D,GAAA,EAAK,CAAA,CAAA,KACH,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,OACT,CAAA,CACG,MAAA,CAAO,EAAE,WAAA,EAAa,uCAAA,EAAyC,CAAA,CAC/D,QAAA,EAAS;AAAA,QACd,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,MAAA,EAAO,EAAG,EAAE,WAAA,EAAa,gBAAA,EAAkB,CAAA,CAAE,QAAA,EAAS;AAAA,QAClE,WAAW,CAAA,CAAA,KACT,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,KAAI,EAAG;AAAA,UACf,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,EAAE,WAAA,EAAa,4BAA4B,CAAA;AAAA,QAC9D,KAAK,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,EAAE,WAAA,EAAa,4BAA4B,CAAA;AAAA,QAC9D,YAAA,EAAc,CAAA,CAAA,KACZ,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd;AAAA;AACL,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,OAAO,GAAA,EAAK,SAAA,EAAW,MAAM,SAAA,EAAW,SAAA,KAAc,GAAA,CAAI,KAAA;AAClE,MAAA,MAAM,KAAA,GAAQ,eAAA,CAAgB,OAAA,CAAQ,MAAM,CAAA;AAC5C,MAAA,MAAM,QAAA,GAAW,eAAA;AAAA,QACfC,+CAAA,CAAqB,QAAQ,MAAM,CAAA;AAAA,QACnC,KAAA;AAAA,QACA,IAAI,KAAA,CAAM;AAAA,OACZ;AAEA,MAAA,IAAI,SAAA,IAAa,CAAC,KAAA,CAAM,cAAA,EAAgB;AACtC,QAAA,MAAM,IAAIF,sBAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,SAAA,IAAa,GAAG,CAAA;AACzC,MAAA,MAAM,UAAA,GAAa,CAAA,0CAAA,EAA6C,QAAA,CAAS,SAAS,CAAA,WAAA,CAAA;AAClF,MAAA,MAAM,OAAO,QAAA,GAAW,CAAA,EAAG,UAAU,CAAA,CAAA,EAAI,GAAG,CAAA,CAAA,GAAK,UAAA;AAEjD,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACT,CAAA,EACE,WAAW,UAAA,GAAa,UAC1B,uBAAuB,KAAK,CAAA,eAAA,EAAkB,SAAS,IAAI,CAAA,CAAA;AAAA,OAC7D;AAEA,MAAA,MAAM,QAAA,GAAW,MAAM,QAAA,CAAS,CAAA,EAAG,SAAS,OAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI;AAAA,QAC5D,MAAA,EAAQ,WAAW,KAAA,GAAQ,MAAA;AAAA,QAC3B,OAAA,EAAS;AAAA,UACP,aAAA,EAAe,CAAA,OAAA,EAAU,QAAA,CAAS,KAAK,CAAA,CAAA;AAAA,UACvC,cAAA,EAAgB,kBAAA;AAAA,UAChB,MAAA,EAAQ;AAAA,SACV;AAAA,QACA,IAAA,EAAM,KAAK,SAAA,CAAU;AAAA,UACnB,QAAA,EAAU;AAAA,YACR,GAAI,GAAA,GAAM,EAAE,IAAA,EAAM,GAAA,KAAQ,EAAC;AAAA,YAC3B,GAAI,YACA,EAAE,WAAA,EAAa,EAAE,oBAAA,EAAsB,SAAA,EAAU,EAAE,GACnD;AAAC,WACP;AAAA,UACA,IAAA,EAAM;AAAA,YACJ,KAAA;AAAA,YACA,aAAA,EAAe,EAAA;AAAA,YACf,IAAA,EAAM,QAAQ,EAAC;AAAA,YACf,QAAQ,EAAC;AAAA,YACT,GAAI,aAAa;AAAC;AACpB,SACD;AAAA,OACF,CAAA;AAED,MAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,QAAA,MAAM,MAAMG,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,MACjD;AAEA,MAAA,MAAM,IAAA,GAAQ,MAAM,QAAA,CAAS,IAAA,EAAK;AAClC,MAAA,MAAM,SAAA,GAAY,IAAA,CAAK,QAAA,EAAU,IAAA,IAAQ,GAAA,IAAO,EAAA;AAChD,MAAA,MAAM,GAAA,GAAM,GAAG,QAAA,CAAS,OAAO,MAAM,SAAS,CAAA,CAAA,EAAIC,kCAAA,CAAQ,KAAK,CAAC,CAAA,CAAA;AAEhE,MAAA,GAAA,CAAI,MAAA,CAAO,OAAO,SAAS,CAAA;AAC3B,MAAA,GAAA,CAAI,MAAA,CAAO,OAAO,GAAG,CAAA;AACrB,MAAA,GAAA,CAAI,MAAA,CAAO,cAAA,EAAgB,QAAA,CAAS,IAAI,CAAA;AAAA,IAC1C;AAAA,GACD,CAAA;AACH;;"}

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+var createDashboard = require('./actions/createDashboard.cjs.js');
+
+
+
+exports.default = module$1.scaffolderModuleGrafana;
+exports.createGrafanaDashboardCreateAction = createDashboard.createGrafanaDashboardCreateAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import { Config } from '@backstage/config';
+import { FetchApi } from '@marble-sh/backstage-plugin-grafana-node';
+
+/**
+ * Scaffolder backend module that registers Grafana provisioning actions.
+ *
+ * @public
+ */
+declare const scaffolderModuleGrafana: _backstage_backend_plugin_api.BackendFeature;
+
+/**
+ * Creates the `grafana:dashboard:create` scaffolder action, which creates (or
+ * updates) a dashboard in a configured Grafana instance via the App Platform
+ * `dashboard.grafana.app/v1` API.
+ *
+ * @public
+ */
+declare function createGrafanaDashboardCreateAction(options: {
+    config: Config;
+    fetch?: FetchApi;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    title: string;
+    instanceName?: string | undefined;
+    uid?: string | undefined;
+    folderUid?: string | undefined;
+    tags?: string[] | undefined;
+    dashboard?: Record<string, any> | undefined;
+    overwrite?: boolean | undefined;
+}, {
+    uid: string;
+    url: string;
+    instanceName: string;
+}, "v2">;
+
+export { createGrafanaDashboardCreateAction, scaffolderModuleGrafana as default };

package/dist/module.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var createDashboard = require('./actions/createDashboard.cjs.js');
+
+const scaffolderModuleGrafana = backendPluginApi.createBackendModule({
+  moduleId: "grafana",
+  pluginId: "scaffolder",
+  register(env) {
+    env.registerInit({
+      deps: {
+        scaffolder: pluginScaffolderNode.scaffolderActionsExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig
+      },
+      async init({ scaffolder, config }) {
+        scaffolder.addActions(createDashboard.createGrafanaDashboardCreateAction({ config }));
+      }
+    });
+  }
+});
+
+exports.scaffolderModuleGrafana = scaffolderModuleGrafana;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2026 Cassidy Marble\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 */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\nimport { createGrafanaDashboardCreateAction } from './actions';\n\n/**\n * Scaffolder backend module that registers Grafana provisioning actions.\n *\n * @public\n */\nexport const scaffolderModuleGrafana = createBackendModule({\n  moduleId: 'grafana',\n  pluginId: 'scaffolder',\n  register(env) {\n    env.registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        config: coreServices.rootConfig,\n      },\n      async init({ scaffolder, config }) {\n        scaffolder.addActions(createGrafanaDashboardCreateAction({ config }));\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","createGrafanaDashboardCreateAction"],"mappings":";;;;;;AA4BO,MAAM,0BAA0BA,oCAAA,CAAoB;AAAA,EACzD,QAAA,EAAU,SAAA;AAAA,EACV,QAAA,EAAU,YAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,QAAQC,6BAAA,CAAa;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,EAAY,QAAO,EAAG;AACjC,QAAA,UAAA,CAAW,UAAA,CAAWC,kDAAA,CAAmC,EAAE,MAAA,EAAQ,CAAC,CAAA;AAAA,MACtE;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@marble-sh/backstage-plugin-scaffolder-backend-module-grafana",
+  "version": "0.2.0",
+  "description": "Scaffolder backend module with actions for provisioning Grafana dashboards",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "pluginPackage": "@backstage/plugin-scaffolder-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "start": "backstage-cli package start",
+    "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",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "backstage:^",
+    "@backstage/config": "backstage:^",
+    "@backstage/errors": "backstage:^",
+    "@backstage/plugin-scaffolder-node": "backstage:^",
+    "@marble-sh/backstage-plugin-grafana-node": "workspace:^"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "backstage:^",
+    "@backstage/cli": "backstage:^",
+    "@backstage/plugin-scaffolder-node-test-utils": "backstage:^",
+    "@backstage/types": "backstage:^"
+  },
+  "files": [
+    "dist",
+    "config.schema.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/marble-sh/backstage-plugins-grafana",
+    "directory": "plugins/scaffolder-backend-module-grafana"
+  },
+  "keywords": [
+    "backstage",
+    "plugin",
+    "grafana",
+    "scaffolder"
+  ],
+  "author": "Cassidy Marble",
+  "homepage": "https://github.com/marble-sh/backstage-plugins-grafana/tree/main/plugins/scaffolder-backend-module-grafana",
+  "bugs": "https://github.com/marble-sh/backstage-plugins-grafana/issues",
+  "exports": {
+    ".": {
+      "backstage": "@backstage/BackendFeature",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
+  "configSchema": "config.schema.json"
+}