@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator
+
+## 0.2.0
+
+### Minor Changes
+
+- ebf64b9: Added yarn export-dynamic target

package/README.md

@@ -0,0 +1,93 @@
+# backstage-plugin-scaffolder-backend-module-orchestrator
+
+The Orchestrator module [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend) provides actions callable from the [Backstage templates](https://backstage.io/docs/features/software-templates/).
+
+An example of using these actions can be found in the `workspaces/orchestrator/entities/convertWorkflowToTemplate.yaml` template.
+
+## Installation
+
+### As a static plugin
+
+In `packages/backend/src/index.ts`:
+
+```
+backend.add(import('@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator'));
+```
+
+# The software template generating templates from workflows - convertWorkflowToTemplate
+
+The `workspaces/orchestrator/entities/convertWorkflowToTemplate.yaml` scaffolder software template is used for generating templates to be used to execute a serverless workflow via the Orchestrator.
+
+The generated template is a yaml document which is pushed to a GitHub repository for later consumption by the Backstage.
+
+The only specific input parameter is the `workflowId` of the desired workflow.
+
+The rest of parameters cover details about the target GitHub repository to either create a new repo or push a PR to an existing one.
+
+The generated yaml template is accompanied by a README file highlighting instructions how to register the new template in the Backstage catalog.
+
+## Important Note on Template Input Structure
+
+The structure of the template input differs from that of the page used for collecting input parameters for workflows, despite some similarities. These two pages are supported by distinct implementations. While the set of parameters should remain consistent, their visual representation and especially grouping into steps may vary.
+
+## What is a workflow ID
+
+The `[workflowId]` matches the identifier from the workflow definition.
+For example, in the [workflow definition](https://github.com/rhdhorchestrator/serverless-workflows/blob/main/workflows/greeting/greeting.sw.yaml) below, the identifier is `greeting`:
+
+```yaml greeting.sw.yaml
+id: greeting
+version: '1.0'
+specVersion: '0.8'
+name: Greeting workflow
+description: YAML based greeting workflow
+annotations:
+  - 'workflow-type/infrastructure'
+dataInputSchema: 'schemas/greeting.sw.input-schema.json'
+extensions:
+  - extensionid: workflow-output-schema
+    outputSchema: schemas/workflow-output-schema.json
+```
+
+## GitHub integration
+
+The `convertWorkflowToTemplate.yaml` template pushes the result into a GitHub repository.
+To make it work, the [Backstage integration with GitHub](https://backstage.io/docs/integrations/github/locations) needs to be properly set.
+
+In a nutshell:
+
+- add `@backstage/plugin-scaffolder-backend-module-github` to your `backend` application, sort of:
+
+```bash
+yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-github
+```
+
+- in `packages/backend/src/index.ts`:
+
+```
+backend.add(import('@backstage/plugin-scaffolder-backend-module-github'));
+```
+
+- generate GitHub access token, e.g. via https://github.com/settings/personal-access-tokens and set
+
+```bash
+export GITHUB_TOKEN=.......
+```
+
+- configure `app-config.yaml`:
+
+```
+integrations:
+  github:
+    - token: ${GITHUB_TOKEN}
+```
+
+## Resources
+
+- [Upstream documentation](https://backstage.io/docs/features/software-templates/builtin-actions)
+
+# Hints
+
+Mind using `export NODE_OPTIONS="${NODE_OPTIONS:-} --no-node-snapshot"` before running the Backstage backend app with Node 20+ (per actual [warning in the upstream documentation](https://backstage.io/docs/features/software-templates/#getting-started)) - this might be changed in the future.
+
+Before running the Backstage backend app with **Node 20+**, be sure to execute `export NODE_OPTIONS="${NODE_OPTIONS:-} --no-node-snapshot` as recommended by the [warning in the upstream documentation](https://backstage.io/docs/features/software-templates/#getting-started) (this might be changed in the future).

package/dist/actions/getWorkflowParams.cjs.js

@@ -0,0 +1,77 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var axios = require('axios');
+var jsYaml = require('js-yaml');
+var utils = require('./utils.cjs.js');
+
+const getError = (err) => {
+  if (axios.isAxiosError(err) && err.response?.data?.error?.message) {
+    const error = new Error(err.response?.data?.error?.message);
+    error.name = err.response?.data?.error?.name || "Error";
+    return error;
+  }
+  return err;
+};
+const indentString = (str, indent) => indent ? str.replace(/^/gm, " ".repeat(indent)) : str;
+const createGetWorkflowParamsAction = (discoveryService, authService) => pluginScaffolderNode.createTemplateAction({
+  id: "orchestrator:workflow:get_params",
+  description: "Collect parameters of a SonataFlow workflow.",
+  supportsDryRun: false,
+  schema: {
+    input: {
+      required: ["workflow_id"],
+      type: "object",
+      properties: {
+        workflow_id: {
+          type: "string"
+        }
+      }
+    }
+  },
+  async handler(ctx) {
+    const workflowId = ctx.input?.workflow_id;
+    if (!workflowId) {
+      throw new Error("Missing workflow_id required input parameter.");
+    }
+    const api = await utils.getOrchestratorApi(discoveryService);
+    const reqConfigOption = await utils.getRequestConfigOption(authService, ctx);
+    try {
+      const { data: workflow } = await api.getWorkflowOverviewById(
+        workflowId,
+        reqConfigOption
+      );
+      if (!workflow) {
+        throw new Error(`Can not find workflow ${workflowId}`);
+      }
+      const { data: inputSchemaWrapper } = await api.getWorkflowInputSchemaById(
+        workflowId,
+        void 0,
+        reqConfigOption
+      );
+      const inputSchema = inputSchemaWrapper.inputSchema;
+      ctx.output("title", workflow.name || workflowId);
+      ctx.output("description", workflow.description || "");
+      if (inputSchema?.properties) {
+        let parametersYaml = jsYaml.dump(
+          [
+            // scaffolder expects an array on the top-level
+            inputSchema
+          ],
+          { indent: 2 }
+        );
+        parametersYaml = indentString(parametersYaml, ctx.input?.indent || 0);
+        parametersYaml = `
+${parametersYaml}`;
+        ctx.output("parameters", parametersYaml);
+      } else {
+        ctx.output("parameters", "{}");
+      }
+    } catch (err) {
+      throw getError(err);
+    }
+  }
+});
+
+exports.createGetWorkflowParamsAction = createGetWorkflowParamsAction;
+//# sourceMappingURL=getWorkflowParams.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkflowParams.cjs.js","sources":["../../src/actions/getWorkflowParams.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 { AuthService } from '@backstage/backend-plugin-api';\nimport { DiscoveryApi } from '@backstage/plugin-permission-common/index';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { JsonObject } from '@backstage/types/index';\n\nimport { isAxiosError } from 'axios';\nimport { dump } from 'js-yaml';\n\nimport { getOrchestratorApi, getRequestConfigOption } from './utils';\n\ntype RunWorkflowTemplateActionInput = { workflow_id: string; indent?: number };\ntype RunWorkflowTemplateActionOutput = {\n  title: string;\n  description: string;\n  parameters: string;\n};\n\nconst getError = (err: unknown): Error => {\n  if (\n    isAxiosError<{ error: { message: string; name: string } }>(err) &&\n    err.response?.data?.error?.message\n  ) {\n    const error = new Error(err.response?.data?.error?.message);\n    error.name = err.response?.data?.error?.name || 'Error';\n    return error;\n  }\n  return err as Error;\n};\n\nconst indentString = (str: string, indent: number) =>\n  indent ? str.replace(/^/gm, ' '.repeat(indent)) : str;\n\nexport const createGetWorkflowParamsAction = (\n  discoveryService: DiscoveryApi,\n  authService: AuthService,\n) =>\n  createTemplateAction<\n    RunWorkflowTemplateActionInput,\n    RunWorkflowTemplateActionOutput\n  >({\n    id: 'orchestrator:workflow:get_params',\n    description: 'Collect parameters of a SonataFlow workflow.',\n    supportsDryRun: false,\n    schema: {\n      input: {\n        required: ['workflow_id'],\n        type: 'object',\n        properties: {\n          workflow_id: {\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const workflowId = ctx.input?.workflow_id;\n      if (!workflowId) {\n        throw new Error('Missing workflow_id required input parameter.');\n      }\n\n      const api = await getOrchestratorApi(discoveryService);\n      const reqConfigOption = await getRequestConfigOption(authService, ctx);\n\n      try {\n        const { data: workflow } = await api.getWorkflowOverviewById(\n          workflowId,\n          reqConfigOption,\n        );\n        if (!workflow) {\n          throw new Error(`Can not find workflow ${workflowId}`);\n        }\n\n        const { data: inputSchemaWrapper } =\n          await api.getWorkflowInputSchemaById(\n            workflowId,\n            undefined,\n            reqConfigOption,\n          );\n        const inputSchema: JsonObject | undefined =\n          inputSchemaWrapper.inputSchema;\n\n        ctx.output('title', workflow.name || workflowId);\n        ctx.output('description', workflow.description || '');\n\n        if (inputSchema?.properties) {\n          let parametersYaml = dump(\n            [\n              // scaffolder expects an array on the top-level\n              inputSchema,\n            ],\n            { indent: 2 },\n          );\n          parametersYaml = indentString(parametersYaml, ctx.input?.indent || 0);\n          parametersYaml = `\\n${parametersYaml}`;\n\n          ctx.output('parameters', parametersYaml);\n        } else {\n          ctx.output('parameters', '{}');\n        }\n      } catch (err) {\n        throw getError(err);\n      }\n    },\n  });\n"],"names":["isAxiosError","createTemplateAction","getOrchestratorApi","getRequestConfigOption","dump"],"mappings":";;;;;;;AAgCA,MAAM,QAAA,GAAW,CAAC,GAAwB,KAAA;AACxC,EAAA,IACEA,mBAA2D,GAAG,CAAA,IAC9D,IAAI,QAAU,EAAA,IAAA,EAAM,OAAO,OAC3B,EAAA;AACA,IAAA,MAAM,QAAQ,IAAI,KAAA,CAAM,IAAI,QAAU,EAAA,IAAA,EAAM,OAAO,OAAO,CAAA;AAC1D,IAAA,KAAA,CAAM,IAAO,GAAA,GAAA,CAAI,QAAU,EAAA,IAAA,EAAM,OAAO,IAAQ,IAAA,OAAA;AAChD,IAAO,OAAA,KAAA;AAAA;AAET,EAAO,OAAA,GAAA;AACT,CAAA;AAEA,MAAM,YAAe,GAAA,CAAC,GAAa,EAAA,MAAA,KACjC,MAAS,GAAA,GAAA,CAAI,OAAQ,CAAA,KAAA,EAAO,GAAI,CAAA,MAAA,CAAO,MAAM,CAAC,CAAI,GAAA,GAAA;AAE7C,MAAM,6BAAgC,GAAA,CAC3C,gBACA,EAAA,WAAA,KAEAC,yCAGE,CAAA;AAAA,EACA,EAAI,EAAA,kCAAA;AAAA,EACJ,WAAa,EAAA,8CAAA;AAAA,EACb,cAAgB,EAAA,KAAA;AAAA,EAChB,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA;AAAA,MACL,QAAA,EAAU,CAAC,aAAa,CAAA;AAAA,MACxB,IAAM,EAAA,QAAA;AAAA,MACN,UAAY,EAAA;AAAA,QACV,WAAa,EAAA;AAAA,UACX,IAAM,EAAA;AAAA;AACR;AACF;AACF,GACF;AAAA,EACA,MAAM,QAAQ,GAAK,EAAA;AACjB,IAAM,MAAA,UAAA,GAAa,IAAI,KAAO,EAAA,WAAA;AAC9B,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAM,MAAA,IAAI,MAAM,+CAA+C,CAAA;AAAA;AAGjE,IAAM,MAAA,GAAA,GAAM,MAAMC,wBAAA,CAAmB,gBAAgB,CAAA;AACrD,IAAA,MAAM,eAAkB,GAAA,MAAMC,4BAAuB,CAAA,WAAA,EAAa,GAAG,CAAA;AAErE,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAI,MAAM,GAAI,CAAA,uBAAA;AAAA,QACnC,UAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,IAAI,CAAC,QAAU,EAAA;AACb,QAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,UAAU,CAAE,CAAA,CAAA;AAAA;AAGvD,MAAA,MAAM,EAAE,IAAA,EAAM,kBAAmB,EAAA,GAC/B,MAAM,GAAI,CAAA,0BAAA;AAAA,QACR,UAAA;AAAA,QACA,KAAA,CAAA;AAAA,QACA;AAAA,OACF;AACF,MAAA,MAAM,cACJ,kBAAmB,CAAA,WAAA;AAErB,MAAA,GAAA,CAAI,MAAO,CAAA,OAAA,EAAS,QAAS,CAAA,IAAA,IAAQ,UAAU,CAAA;AAC/C,MAAA,GAAA,CAAI,MAAO,CAAA,aAAA,EAAe,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA;AAEpD,MAAA,IAAI,aAAa,UAAY,EAAA;AAC3B,QAAA,IAAI,cAAiB,GAAAC,WAAA;AAAA,UACnB;AAAA;AAAA,YAEE;AAAA,WACF;AAAA,UACA,EAAE,QAAQ,CAAE;AAAA,SACd;AACA,QAAA,cAAA,GAAiB,YAAa,CAAA,cAAA,EAAgB,GAAI,CAAA,KAAA,EAAO,UAAU,CAAC,CAAA;AACpE,QAAiB,cAAA,GAAA;AAAA,EAAK,cAAc,CAAA,CAAA;AAEpC,QAAI,GAAA,CAAA,MAAA,CAAO,cAAc,cAAc,CAAA;AAAA,OAClC,MAAA;AACL,QAAI,GAAA,CAAA,MAAA,CAAO,cAAc,IAAI,CAAA;AAAA;AAC/B,aACO,GAAK,EAAA;AACZ,MAAA,MAAM,SAAS,GAAG,CAAA;AAAA;AACpB;AAEJ,CAAC;;;;"}

package/dist/actions/runWorkflow.cjs.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var axios = require('axios');
+var utils = require('./utils.cjs.js');
+
+const getError = (err) => {
+  if (axios.isAxiosError(err) && err.response?.data?.error?.message) {
+    const error = new Error(err.response?.data?.error?.message);
+    error.name = err.response?.data?.error?.name || "Error";
+    return error;
+  }
+  return err;
+};
+const createRunWorkflowAction = (discoveryService, authService) => pluginScaffolderNode.createTemplateAction({
+  id: "orchestrator:workflow:run",
+  description: "Run a SonataFlow workflow.",
+  supportsDryRun: true,
+  schema: {
+    input: {
+      required: ["parameters"],
+      type: "object",
+      properties: {
+        parameters: {
+          type: "object",
+          title: "Parameters",
+          description: "The workflow parameters."
+        }
+      }
+    }
+  },
+  async handler(ctx) {
+    const entity = ctx.templateInfo?.entityRef;
+    if (!entity) {
+      throw new Error("No template entity");
+    }
+    const api = await utils.getOrchestratorApi(discoveryService);
+    const reqConfigOption = await utils.getRequestConfigOption(authService, ctx);
+    if (ctx.isDryRun) {
+      ctx.logger.info(`Dry run complete`);
+      return;
+    }
+    try {
+      const { data } = await api.executeWorkflow(
+        catalogModel.parseEntityRef(entity).name,
+        { inputData: ctx.input.parameters },
+        void 0,
+        reqConfigOption
+      );
+      ctx.output("instanceUrl", `/orchestrator/instances/${data.id}`);
+    } catch (err) {
+      throw getError(err);
+    }
+  }
+});
+
+exports.createRunWorkflowAction = createRunWorkflowAction;
+//# sourceMappingURL=runWorkflow.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runWorkflow.cjs.js","sources":["../../src/actions/runWorkflow.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 { AuthService } from '@backstage/backend-plugin-api';\nimport { parseEntityRef } from '@backstage/catalog-model';\nimport { DiscoveryApi } from '@backstage/plugin-permission-common/index';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { JsonObject } from '@backstage/types';\n\nimport { isAxiosError } from 'axios';\n\nimport { getOrchestratorApi, getRequestConfigOption } from './utils';\n\ntype RunWorkflowTemplateActionInput = { parameters: JsonObject };\ntype RunWorkflowTemplateActionOutput = { instanceUrl: string };\n\nconst getError = (err: unknown): Error => {\n  if (\n    isAxiosError<{ error: { message: string; name: string } }>(err) &&\n    err.response?.data?.error?.message\n  ) {\n    const error = new Error(err.response?.data?.error?.message);\n    error.name = err.response?.data?.error?.name || 'Error';\n    return error;\n  }\n  return err as Error;\n};\n\nexport const createRunWorkflowAction = (\n  discoveryService: DiscoveryApi,\n  authService: AuthService,\n) =>\n  createTemplateAction<\n    RunWorkflowTemplateActionInput,\n    RunWorkflowTemplateActionOutput\n  >({\n    id: 'orchestrator:workflow:run',\n    description: 'Run a SonataFlow workflow.',\n    supportsDryRun: true,\n    schema: {\n      input: {\n        required: ['parameters'],\n        type: 'object',\n        properties: {\n          parameters: {\n            type: 'object',\n            title: 'Parameters',\n            description: 'The workflow parameters.',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const entity = ctx.templateInfo?.entityRef;\n      if (!entity) {\n        throw new Error('No template entity');\n      }\n\n      const api = await getOrchestratorApi(discoveryService);\n      const reqConfigOption = await getRequestConfigOption(authService, ctx);\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const { data } = await api.executeWorkflow(\n          parseEntityRef(entity).name,\n          { inputData: ctx.input.parameters },\n          undefined,\n          reqConfigOption,\n        );\n        ctx.output('instanceUrl', `/orchestrator/instances/${data.id}`);\n      } catch (err) {\n        throw getError(err);\n      }\n    },\n  });\n"],"names":["isAxiosError","createTemplateAction","getOrchestratorApi","getRequestConfigOption","parseEntityRef"],"mappings":";;;;;;;AA4BA,MAAM,QAAA,GAAW,CAAC,GAAwB,KAAA;AACxC,EAAA,IACEA,mBAA2D,GAAG,CAAA,IAC9D,IAAI,QAAU,EAAA,IAAA,EAAM,OAAO,OAC3B,EAAA;AACA,IAAA,MAAM,QAAQ,IAAI,KAAA,CAAM,IAAI,QAAU,EAAA,IAAA,EAAM,OAAO,OAAO,CAAA;AAC1D,IAAA,KAAA,CAAM,IAAO,GAAA,GAAA,CAAI,QAAU,EAAA,IAAA,EAAM,OAAO,IAAQ,IAAA,OAAA;AAChD,IAAO,OAAA,KAAA;AAAA;AAET,EAAO,OAAA,GAAA;AACT,CAAA;AAEO,MAAM,uBAA0B,GAAA,CACrC,gBACA,EAAA,WAAA,KAEAC,yCAGE,CAAA;AAAA,EACA,EAAI,EAAA,2BAAA;AAAA,EACJ,WAAa,EAAA,4BAAA;AAAA,EACb,cAAgB,EAAA,IAAA;AAAA,EAChB,MAAQ,EAAA;AAAA,IACN,KAAO,EAAA;AAAA,MACL,QAAA,EAAU,CAAC,YAAY,CAAA;AAAA,MACvB,IAAM,EAAA,QAAA;AAAA,MACN,UAAY,EAAA;AAAA,QACV,UAAY,EAAA;AAAA,UACV,IAAM,EAAA,QAAA;AAAA,UACN,KAAO,EAAA,YAAA;AAAA,UACP,WAAa,EAAA;AAAA;AACf;AACF;AACF,GACF;AAAA,EACA,MAAM,QAAQ,GAAK,EAAA;AACjB,IAAM,MAAA,MAAA,GAAS,IAAI,YAAc,EAAA,SAAA;AACjC,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAM,MAAA,IAAI,MAAM,oBAAoB,CAAA;AAAA;AAGtC,IAAM,MAAA,GAAA,GAAM,MAAMC,wBAAA,CAAmB,gBAAgB,CAAA;AACrD,IAAA,MAAM,eAAkB,GAAA,MAAMC,4BAAuB,CAAA,WAAA,EAAa,GAAG,CAAA;AAGrE,IAAA,IAAI,IAAI,QAAU,EAAA;AAChB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,MAAA;AAAA;AAGF,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,IAAA,EAAS,GAAA,MAAM,GAAI,CAAA,eAAA;AAAA,QACzBC,2BAAA,CAAe,MAAM,CAAE,CAAA,IAAA;AAAA,QACvB,EAAE,SAAA,EAAW,GAAI,CAAA,KAAA,CAAM,UAAW,EAAA;AAAA,QAClC,KAAA,CAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,GAAA,CAAI,MAAO,CAAA,aAAA,EAAe,CAA2B,wBAAA,EAAA,IAAA,CAAK,EAAE,CAAE,CAAA,CAAA;AAAA,aACvD,GAAK,EAAA;AACZ,MAAA,MAAM,SAAS,GAAG,CAAA;AAAA;AACpB;AAEJ,CAAC;;;;"}

package/dist/actions/utils.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var axios = require('axios');
+var backstagePluginOrchestratorCommon = require('@red-hat-developer-hub/backstage-plugin-orchestrator-common');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultCompat(axios);
+
+const getOrchestratorApi = async (discoveryService) => {
+  const baseUrl = await discoveryService.getBaseUrl("orchestrator");
+  const config = new backstagePluginOrchestratorCommon.Configuration({});
+  const axiosInstance = axios__default.default.create({
+    baseURL: baseUrl
+  });
+  const api = new backstagePluginOrchestratorCommon.DefaultApi(config, baseUrl, axiosInstance);
+  return api;
+};
+const getRequestConfigOption = async (authService, ctx) => {
+  const { token } = await authService.getPluginRequestToken({
+    onBehalfOf: await ctx.getInitiatorCredentials(),
+    targetPluginId: "orchestrator"
+  }) ?? { token: ctx.secrets?.backstageToken };
+  const reqConfigOption = {
+    headers: {
+      Authorization: `Bearer ${token}`
+    }
+  };
+  return reqConfigOption;
+};
+
+exports.getOrchestratorApi = getOrchestratorApi;
+exports.getRequestConfigOption = getRequestConfigOption;
+//# sourceMappingURL=utils.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs.js","sources":["../../src/actions/utils.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 { AuthService } from '@backstage/backend-plugin-api';\nimport { DiscoveryApi } from '@backstage/plugin-permission-common/index';\n\nimport axios, { AxiosRequestConfig, isAxiosError } from 'axios';\n\nimport {\n  Configuration,\n  DefaultApi,\n} from '@red-hat-developer-hub/backstage-plugin-orchestrator-common';\n\nexport const getError = (err: unknown): Error => {\n  if (\n    isAxiosError<{ error: { message: string; name: string } }>(err) &&\n    err.response?.data?.error?.message\n  ) {\n    const error = new Error(err.response?.data?.error?.message);\n    error.name = err.response?.data?.error?.name || 'Error';\n    return error;\n  }\n  return err as Error;\n};\n\nexport const getOrchestratorApi = async (\n  discoveryService: DiscoveryApi,\n): Promise<DefaultApi> => {\n  const baseUrl = await discoveryService.getBaseUrl('orchestrator');\n  const config = new Configuration({});\n\n  const axiosInstance = axios.create({\n    baseURL: baseUrl,\n  });\n  const api = new DefaultApi(config, baseUrl, axiosInstance);\n\n  return api;\n};\nexport const getRequestConfigOption = async (\n  authService: AuthService,\n  ctx: any,\n) => {\n  const { token } = (await authService.getPluginRequestToken({\n    onBehalfOf: await ctx.getInitiatorCredentials(),\n    targetPluginId: 'orchestrator',\n  })) ?? { token: ctx.secrets?.backstageToken };\n\n  const reqConfigOption: AxiosRequestConfig = {\n    headers: {\n      Authorization: `Bearer ${token}`,\n    },\n  };\n\n  return reqConfigOption;\n};\n"],"names":["Configuration","axios","DefaultApi"],"mappings":";;;;;;;;;AAqCa,MAAA,kBAAA,GAAqB,OAChC,gBACwB,KAAA;AACxB,EAAA,MAAM,OAAU,GAAA,MAAM,gBAAiB,CAAA,UAAA,CAAW,cAAc,CAAA;AAChE,EAAA,MAAM,MAAS,GAAA,IAAIA,+CAAc,CAAA,EAAE,CAAA;AAEnC,EAAM,MAAA,aAAA,GAAgBC,uBAAM,MAAO,CAAA;AAAA,IACjC,OAAS,EAAA;AAAA,GACV,CAAA;AACD,EAAA,MAAM,GAAM,GAAA,IAAIC,4CAAW,CAAA,MAAA,EAAQ,SAAS,aAAa,CAAA;AAEzD,EAAO,OAAA,GAAA;AACT;AACa,MAAA,sBAAA,GAAyB,OACpC,WAAA,EACA,GACG,KAAA;AACH,EAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,YAAY,qBAAsB,CAAA;AAAA,IACzD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,IAC9C,cAAgB,EAAA;AAAA,GACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAE5C,EAAA,MAAM,eAAsC,GAAA;AAAA,IAC1C,OAAS,EAAA;AAAA,MACP,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA;AAChC,GACF;AAEA,EAAO,OAAA,eAAA;AACT;;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+
+
+
+exports.default = module$1.scaffolderModule;
+//# 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,8 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * A backend module that registers the action into the scaffolder
+ */
+declare const scaffolderModule: _backstage_backend_plugin_api.BackendFeature;
+
+export { scaffolderModule as default };

package/dist/module.cjs.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
+var runWorkflow = require('./actions/runWorkflow.cjs.js');
+var getWorkflowParams = require('./actions/getWorkflowParams.cjs.js');
+
+const scaffolderModule = backendPluginApi.createBackendModule({
+  moduleId: "orchestrator",
+  pluginId: "scaffolder",
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolderActions: alpha.scaffolderActionsExtensionPoint,
+        discoveryService: backendPluginApi.coreServices.discovery,
+        authService: backendPluginApi.coreServices.auth
+      },
+      async init({ scaffolderActions, discoveryService, authService }) {
+        scaffolderActions.addActions(
+          runWorkflow.createRunWorkflowAction(discoveryService, authService)
+        );
+        scaffolderActions.addActions(
+          getWorkflowParams.createGetWorkflowParamsAction(discoveryService, authService)
+        );
+      }
+    });
+  }
+});
+
+exports.scaffolderModule = scaffolderModule;
+//# 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 Red Hat, Inc.\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  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\n\nimport {\n  createGetWorkflowParamsAction,\n  createRunWorkflowAction,\n} from './actions';\n\n/**\n * A backend module that registers the action into the scaffolder\n */\nexport const scaffolderModule = createBackendModule({\n  moduleId: 'orchestrator',\n  pluginId: 'scaffolder',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolderActions: scaffolderActionsExtensionPoint,\n        discoveryService: coreServices.discovery,\n        authService: coreServices.auth,\n      },\n      async init({ scaffolderActions, discoveryService, authService }) {\n        scaffolderActions.addActions(\n          createRunWorkflowAction(discoveryService, authService),\n        );\n        scaffolderActions.addActions(\n          createGetWorkflowParamsAction(discoveryService, authService),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","createRunWorkflowAction","createGetWorkflowParamsAction"],"mappings":";;;;;;;AA6BO,MAAM,mBAAmBA,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,cAAA;AAAA,EACV,QAAU,EAAA,YAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAgB,EAAA;AACzB,IAAa,YAAA,CAAA;AAAA,MACX,IAAM,EAAA;AAAA,QACJ,iBAAmB,EAAAC,qCAAA;AAAA,QACnB,kBAAkBC,6BAAa,CAAA,SAAA;AAAA,QAC/B,aAAaA,6BAAa,CAAA;AAAA,OAC5B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,iBAAmB,EAAA,gBAAA,EAAkB,aAAe,EAAA;AAC/D,QAAkB,iBAAA,CAAA,UAAA;AAAA,UAChBC,mCAAA,CAAwB,kBAAkB,WAAW;AAAA,SACvD;AACA,QAAkB,iBAAA,CAAA,UAAA;AAAA,UAChBC,+CAAA,CAA8B,kBAAkB,WAAW;AAAA,SAC7D;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator",
+  "description": "The orchestrator module for @backstage/plugin-scaffolder-backend",
+  "version": "0.2.0",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/redhat-developer/rhdh-plugins",
+    "directory": "workspaces/orchestrator/plugins/scaffolder-backend-module-orchestrator"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "supported-versions": "1.32.5",
+    "pluginPackages": [
+      "@red-hat-developer-hub/backstage-plugin-orchestrator-common",
+      "@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator"
+    ],
+    "pluginPackage": "@backstage/plugin-scaffolder-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "bugs": "https://github.com/redhat-developer/rhdh-plugins/issues",
+  "keywords": [
+    "support:tech-preview",
+    "lifecycle:active",
+    "backstage",
+    "plugin",
+    "orchestrator",
+    "workflows"
+  ],
+  "exports": {
+    ".": {
+      "backstage": "@backstage/BackendFeature",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "tsc": "tsc",
+    "prettier:check": "prettier --ignore-unknown --check .",
+    "prettier:fix": "prettier --ignore-unknown --write .",
+    "lint:check": "backstage-cli package lint",
+    "lint:fix": "backstage-cli package lint --fix",
+    "export-dynamic": "janus-cli package export-dynamic-plugin --no-embed-as-dependencies --embed-package '@red-hat-developer-hub/backstage-plugin-orchestrator-common'"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^1.2.0-next.2",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/plugin-scaffolder-node": "^0.7.0-next.2",
+    "@backstage/types": "^1.2.1",
+    "@red-hat-developer-hub/backstage-plugin-orchestrator-common": "^1.26.0",
+    "axios": "^1.7.9",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.30.0-next.3",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.1.19-next.3",
+    "@janus-idp/cli": "3.2.0",
+    "@spotify/prettier-config": "^15.0.0"
+  },
+  "files": [
+    "app-config.yaml",
+    "dist",
+    "dist-dynamic/*.*",
+    "dist-dynamic/dist/**",
+    "static"
+  ],
+  "maintainers": [
+    "@mlibra",
+    "@batzionb",
+    "@gciavarrini"
+  ]
+}