@backstage/plugin-scaffolder-backend-module-confluence-to-markdown 0.0.0-nightly-20230325022054

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
+
+## 0.0.0-nightly-20230325022054
+
+### Minor Changes
+
+- 1b49a18bf8d: Created `confluence:transform:markdown` action for converting confluence docs to Markdown.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-backend@0.0.0-nightly-20230325022054
+  - @backstage/plugin-scaffolder-node@0.0.0-nightly-20230325022054
+  - @backstage/backend-common@0.0.0-nightly-20230325022054
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.3
+  - @backstage/types@1.0.2

package/README.md

@@ -0,0 +1,118 @@
+# @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
+
+Welcome to the `confluence:transform:markdown` action for the `scaffolder-backend`.
+
+## Getting started
+
+You need to configure the action in your backend:
+
+## From your Backstage root directory
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+import { createBuiltinActions } from '@backstage/plugin-scaffolder-backend';
+import { ScmIntegrations } from '@backstage/integration';
+import { createConfluenceToMarkdownAction } from '@backstage/plugin-scaffolder-backend-module-confluence-to-markdown';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  const catalogClient = new CatalogClient({ discoveryApi: env.discovery });
+  const integrations = ScmIntegrations.fromConfig(env.config);
+
+  const builtInActions = createBuiltinActions({
+    integrations,
+    catalogClient,
+    config: env.config,
+    reader: env.reader,
+  });
+
+  const actions = [
+    ...builtInActions,
+    createConfluenceToMarkdownAction({
+      integrations,
+      config: env.config,
+      reader: env.reader,
+    }),
+  ];
+
+  return createRouter({
+    actions,
+    catalogClient: catalogClient,
+    logger: env.logger,
+    config: env.config,
+    database: env.database,
+    reader: env.reader,
+  });
+}
+```
+
+You will also need an access token for authorization with `Read` permissions. You can create a Personal Access Token (PAT) in confluence and add the PAT to your `app-config.yaml`
+
+```yaml
+confluence:
+  baseUrl: ${CONFLUENCE_BASE_URL}
+  token: ${CONFLUENCE_TOKEN}
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: confluence-to-markdown
+  title: Confluence to Markdown
+  description: This template converts a single confluence document to Markdown for Techdocs and adds it to a given GitHub repo.
+  tags:
+    - do-not-use
+    - poc
+spec:
+  owner: <YOUR_EMAIL>
+  type: service
+  parameters:
+    - title: Confluence and Github Repo Information
+      properties:
+        confluenceUrls:
+          type: array
+          description: Urls for confluence doc to be converted to markdown. In format <CONFLUENCE_BASE_URL>/display/<SPACEKEY>/<PAGE+TITLE>
+          items:
+            type: string
+            default: confluence url
+          ui:options:
+            addable: true
+          minItems: 1
+          maxItems: 5
+        repoUrl:
+          type: string
+          title: GitHub URL mkdocs.yaml link
+          description: The GitHub repo URL to your mkdocs.yaml file. Example <https://github.com/blob/master/mkdocs.yml>
+  steps:
+    - id: create-docs
+      name: Get markdown file created and update markdown.yaml file
+      action: confluence:transform:markdown
+      input:
+        confluenceUrls: ${{ parameters.confluenceUrls }}
+        repoUrl: ${{ parameters.repoUrl }}
+    - id: publish
+      name: Publish PR to GitHub
+      action: publish:github:pull-request
+      input:
+        repoUrl: <GITHUB_BASE_URL>?repo=${{ steps['create-docs'].output.repo }}&owner=${{ steps['create-docs'].output.owner }}
+        branchName: confluence-to-markdown
+        title: Confluence to Markdown
+        description: PR for converting confluence page to mkdocs
+```
+
+Replace `<GITHUB_BASE_URL>` with your GitHub URL without `https://`.
+
+You can find a list of all registered actions including their parameters at the /create/actions route in your Backstage application.

package/dist/index.cjs.js

@@ -0,0 +1,209 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginScaffolderBackend = require('@backstage/plugin-scaffolder-backend');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var errors = require('@backstage/errors');
+var nodeHtmlMarkdown = require('node-html-markdown');
+var fs = require('fs-extra');
+var parseGitUrl = require('git-url-parse');
+var YAML = require('yaml');
+var fetch = require('node-fetch');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var parseGitUrl__default = /*#__PURE__*/_interopDefaultLegacy(parseGitUrl);
+var YAML__default = /*#__PURE__*/_interopDefaultLegacy(YAML);
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+
+const readFileAsString = async (fileDir) => {
+  const content = await fs__default["default"].readFile(fileDir, "utf-8");
+  return content.toString();
+};
+const fetchConfluence = async (relativeUrl, config) => {
+  const baseUrl = config.getString("confluence.baseUrl");
+  const token = config.getString("confluence.token");
+  const response = await fetch__default["default"](`${baseUrl}${relativeUrl}`, {
+    method: "GET",
+    headers: {
+      Authorization: `Bearer ${token}`
+    }
+  });
+  if (!response.ok) {
+    throw await errors.ResponseError.fromResponse(response);
+  }
+  return response.json();
+};
+const getAndWriteAttachments = async (arr, workspace, config, mkdocsDir) => {
+  const productArr = [];
+  const baseUrl = config.getString("confluence.baseUrl");
+  const token = config.getString("confluence.token");
+  await Promise.all(
+    await arr.results.map(async (result) => {
+      const downloadLink = result._links.download;
+      const downloadTitle = result.title.replace(/ /g, "-");
+      if (result.metadata.mediaType !== "application/gliffy+json") {
+        productArr.push([result.title.replace(/ /g, "%20"), downloadTitle]);
+      }
+      const res = await fetch__default["default"](`${baseUrl}${downloadLink}`, {
+        method: "GET",
+        headers: {
+          Authorization: `Bearer ${token}`
+        }
+      });
+      if (!res.ok) {
+        throw errors.ResponseError.fromResponse(res);
+      } else if (res.body !== null) {
+        fs__default["default"].openSync(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`, "w");
+        const writeStream = fs__default["default"].createWriteStream(
+          `${workspace}/${mkdocsDir}docs/img/${downloadTitle}`
+        );
+        res.body.pipe(writeStream);
+        await new Promise((resolve, reject) => {
+          writeStream.on("finish", () => {
+            resolve(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`);
+          });
+          writeStream.on("error", reject);
+        });
+      } else {
+        throw new errors.ConflictError(
+          "No Body on the response. Can not save images from Confluence Doc"
+        );
+      }
+    })
+  );
+  return productArr;
+};
+const createConfluenceVariables = async (url) => {
+  let spacekey = void 0;
+  let title = void 0;
+  let titleWithSpaces = "";
+  const params = new URL(url);
+  if (params.pathname.split("/")[1] === "display") {
+    spacekey = params.pathname.split("/")[2];
+    title = params.pathname.split("/")[3];
+    titleWithSpaces = title == null ? void 0 : title.replace(/\+/g, " ");
+    return { spacekey, title, titleWithSpaces };
+  }
+  throw new errors.InputError(
+    "The Url format for Confluence is incorrect. Acceptable format is `<CONFLUENCE_BASE_URL>/display/<SPACEKEY>/<PAGE+TITLE>`"
+  );
+};
+
+const createConfluenceToMarkdownAction = (options) => {
+  const { config, reader, integrations } = options;
+  const fetchPlainAction = pluginScaffolderBackend.createFetchPlainAction({ reader, integrations });
+  return pluginScaffolderNode.createTemplateAction({
+    id: "confluence:transform:markdown",
+    schema: {
+      input: {
+        properties: {
+          confluenceUrls: {
+            type: "array",
+            title: "Confluence URL",
+            description: "Paste your confluence url. Ensure it follows this format: https://{confluence+base+url}/display/{spacekey}/{page+title}",
+            items: {
+              type: "string",
+              default: "Confluence URL"
+            }
+          },
+          repoUrl: {
+            type: "string",
+            title: "GitHub Repo Url",
+            description: "mkdocs.yml file location inside the github repo you want to store the document"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const { confluenceUrls, repoUrl } = ctx.input;
+      const parsedRepoUrl = parseGitUrl__default["default"](repoUrl);
+      const filePathToMkdocs = parsedRepoUrl.filepath.substring(
+        0,
+        parsedRepoUrl.filepath.lastIndexOf("/") + 1
+      );
+      const dirPath = ctx.workspacePath;
+      let productArray = [];
+      ctx.logger.info(`Fetching the mkdocs.yml catalog from ${repoUrl}`);
+      const repoFileDir = `${dirPath}/${parsedRepoUrl.filepath}`;
+      await fetchPlainAction.handler({
+        ...ctx,
+        input: {
+          url: `https://${parsedRepoUrl.resource}/${parsedRepoUrl.owner}/${parsedRepoUrl.name}`,
+          targetPath: dirPath
+        }
+      });
+      for (const url of confluenceUrls) {
+        const { spacekey, title, titleWithSpaces } = await createConfluenceVariables(url);
+        const getConfluenceDoc = await fetchConfluence(
+          `/rest/api/content?title=${title}&spaceKey=${spacekey}&expand=body.export_view`,
+          config
+        );
+        if (getConfluenceDoc.results.length === 0) {
+          throw new errors.InputError(
+            `Could not find document ${url}. Please check your input.`
+          );
+        }
+        const getDocAttachments = await fetchConfluence(
+          `/rest/api/content/${getConfluenceDoc.results[0].id}/child/attachment`,
+          config
+        );
+        if (getDocAttachments.results.length) {
+          fs__default["default"].mkdirSync(`${dirPath}/${filePathToMkdocs}docs/img`, {
+            recursive: true
+          });
+          productArray = await getAndWriteAttachments(
+            getDocAttachments,
+            dirPath,
+            config,
+            filePathToMkdocs
+          );
+        }
+        ctx.logger.info(
+          `starting action for converting ${titleWithSpaces} from Confluence To Markdown`
+        );
+        const mkdocsFileContent = await readFileAsString(repoFileDir);
+        const mkdocsFile = await YAML__default["default"].parse(mkdocsFileContent);
+        ctx.logger.info(
+          `Adding new file - ${titleWithSpaces} to the current mkdocs.yml file`
+        );
+        if (mkdocsFile !== void 0 && mkdocsFile.hasOwnProperty("nav")) {
+          const { nav } = mkdocsFile;
+          if (!nav.some((i) => i.hasOwnProperty(titleWithSpaces))) {
+            nav.push({
+              [titleWithSpaces]: `${titleWithSpaces.replace(/\s+/g, "-")}.md`
+            });
+            mkdocsFile.nav = nav;
+          } else {
+            throw new errors.ConflictError(
+              "This document looks to exist inside the GitHub repo. Will end the action."
+            );
+          }
+        }
+        await fs__default["default"].writeFile(repoFileDir, YAML__default["default"].stringify(mkdocsFile));
+        const html = getConfluenceDoc.results[0].body.export_view.value;
+        const markdownToPublish = nodeHtmlMarkdown.NodeHtmlMarkdown.translate(html);
+        let newString = markdownToPublish;
+        productArray.forEach((product) => {
+          const regex = product[0].includes(".pdf") ? new RegExp(`(\\[.*?\\]\\()(.*?${product[0]}.*?)(\\))`, "gi") : new RegExp(`(\\!\\[.*?\\]\\()(.*?${product[0]}.*?)(\\))`, "gi");
+          newString = newString.replace(regex, `$1./img/${product[1]}$3`);
+        });
+        ctx.logger.info(`Adding new file to repo.`);
+        await fs__default["default"].outputFile(
+          `${dirPath}/${filePathToMkdocs}docs/${titleWithSpaces.replace(
+            /\s+/g,
+            "-"
+          )}.md`,
+          newString
+        );
+      }
+      ctx.output("repo", parsedRepoUrl.name);
+      ctx.output("owner", parsedRepoUrl.owner);
+    }
+  });
+};
+
+exports.createConfluenceToMarkdownAction = createConfluenceToMarkdownAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/confluence/helpers.ts","../src/actions/confluence/confluenceToMarkdown.ts"],"sourcesContent":["/*\n * Copyright 2023 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 */\n\nimport { Config } from '@backstage/config';\nimport { ResponseError, ConflictError, InputError } from '@backstage/errors';\nimport fs from 'fs-extra';\nimport fetch, { Response } from 'node-fetch';\n\ninterface Links {\n  webui: string;\n  download: string;\n  thumbnail: string;\n  self: string;\n}\n\ninterface Metadata {\n  mediaType: string;\n}\n\nexport interface Result {\n  id: string;\n  type: string;\n  status: string;\n  title: string;\n  metadata: Metadata;\n  _links: Links;\n}\n\nexport interface Results {\n  results: Result[];\n}\n\nexport const readFileAsString = async (fileDir: string) => {\n  const content = await fs.readFile(fileDir, 'utf-8');\n  return content.toString();\n};\n\nexport const fetchConfluence = async (relativeUrl: string, config: Config) => {\n  const baseUrl = config.getString('confluence.baseUrl');\n  const token = config.getString('confluence.token');\n  const response: Response = await fetch(`${baseUrl}${relativeUrl}`, {\n    method: 'GET',\n    headers: {\n      Authorization: `Bearer ${token}`,\n    },\n  });\n  if (!response.ok) {\n    throw await ResponseError.fromResponse(response);\n  }\n\n  return response.json();\n};\n\nexport const getAndWriteAttachments = async (\n  arr: Results,\n  workspace: string,\n  config: Config,\n  mkdocsDir: string,\n) => {\n  const productArr: string[][] = [];\n  const baseUrl = config.getString('confluence.baseUrl');\n  const token = config.getString('confluence.token');\n  await Promise.all(\n    await arr.results.map(async (result: Result) => {\n      const downloadLink = result._links.download;\n      const downloadTitle = result.title.replace(/ /g, '-');\n      if (result.metadata.mediaType !== 'application/gliffy+json') {\n        productArr.push([result.title.replace(/ /g, '%20'), downloadTitle]);\n      }\n\n      const res = await fetch(`${baseUrl}${downloadLink}`, {\n        method: 'GET',\n        headers: {\n          Authorization: `Bearer ${token}`,\n        },\n      });\n      if (!res.ok) {\n        throw ResponseError.fromResponse(res);\n      } else if (res.body !== null) {\n        fs.openSync(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`, 'w');\n        const writeStream = fs.createWriteStream(\n          `${workspace}/${mkdocsDir}docs/img/${downloadTitle}`,\n        );\n        res.body.pipe(writeStream);\n        await new Promise((resolve, reject) => {\n          writeStream.on('finish', () => {\n            resolve(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`);\n          });\n          writeStream.on('error', reject);\n        });\n      } else {\n        throw new ConflictError(\n          'No Body on the response. Can not save images from Confluence Doc',\n        );\n      }\n    }),\n  );\n  return productArr;\n};\n\nexport const createConfluenceVariables = async (url: string) => {\n  let spacekey: string | undefined = undefined;\n  let title: string | undefined = undefined;\n  let titleWithSpaces: string | undefined = '';\n  const params = new URL(url);\n  if (params.pathname.split('/')[1] === 'display') {\n    spacekey = params.pathname.split('/')[2];\n    title = params.pathname.split('/')[3];\n    titleWithSpaces = title?.replace(/\\+/g, ' ');\n    return { spacekey, title, titleWithSpaces };\n  }\n  throw new InputError(\n    'The Url format for Confluence is incorrect. Acceptable format is `<CONFLUENCE_BASE_URL>/display/<SPACEKEY>/<PAGE+TITLE>`',\n  );\n};\n","/*\n * Copyright 2023 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 { Config } from '@backstage/config';\nimport { UrlReader } from '@backstage/backend-common';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { createFetchPlainAction } from '@backstage/plugin-scaffolder-backend';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { InputError, ConflictError } from '@backstage/errors';\nimport { NodeHtmlMarkdown } from 'node-html-markdown';\nimport fs from 'fs-extra';\nimport parseGitUrl from 'git-url-parse';\nimport YAML from 'yaml';\nimport {\n  readFileAsString,\n  fetchConfluence,\n  getAndWriteAttachments,\n  createConfluenceVariables,\n} from './helpers';\n\n/**\n * @public\n */\n\nexport const createConfluenceToMarkdownAction = (options: {\n  reader: UrlReader;\n  integrations: ScmIntegrations;\n  config: Config;\n}) => {\n  const { config, reader, integrations } = options;\n  const fetchPlainAction = createFetchPlainAction({ reader, integrations });\n  type Obj = {\n    [key: string]: string;\n  };\n\n  return createTemplateAction<{\n    confluenceUrls: string[];\n    repoUrl: string;\n  }>({\n    id: 'confluence:transform:markdown',\n    schema: {\n      input: {\n        properties: {\n          confluenceUrls: {\n            type: 'array',\n            title: 'Confluence URL',\n            description:\n              'Paste your confluence url. Ensure it follows this format: https://{confluence+base+url}/display/{spacekey}/{page+title}',\n            items: {\n              type: 'string',\n              default: 'Confluence URL',\n            },\n          },\n          repoUrl: {\n            type: 'string',\n            title: 'GitHub Repo Url',\n            description:\n              'mkdocs.yml file location inside the github repo you want to store the document',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { confluenceUrls, repoUrl } = ctx.input;\n      const parsedRepoUrl = parseGitUrl(repoUrl);\n      const filePathToMkdocs = parsedRepoUrl.filepath.substring(\n        0,\n        parsedRepoUrl.filepath.lastIndexOf('/') + 1,\n      );\n      const dirPath = ctx.workspacePath;\n      let productArray: string[][] = [];\n\n      ctx.logger.info(`Fetching the mkdocs.yml catalog from ${repoUrl}`);\n\n      // This grabs the files from Github\n      const repoFileDir = `${dirPath}/${parsedRepoUrl.filepath}`;\n      await fetchPlainAction.handler({\n        ...ctx,\n        input: {\n          url: `https://${parsedRepoUrl.resource}/${parsedRepoUrl.owner}/${parsedRepoUrl.name}`,\n          targetPath: dirPath,\n        },\n      });\n\n      for (const url of confluenceUrls) {\n        const { spacekey, title, titleWithSpaces } =\n          await createConfluenceVariables(url);\n        // This calls confluence to get the page html and page id\n        const getConfluenceDoc = await fetchConfluence(\n          `/rest/api/content?title=${title}&spaceKey=${spacekey}&expand=body.export_view`,\n          config,\n        );\n        if (getConfluenceDoc.results.length === 0) {\n          throw new InputError(\n            `Could not find document ${url}. Please check your input.`,\n          );\n        }\n        // This gets attachements for the confluence page if they exist\n        const getDocAttachments = await fetchConfluence(\n          `/rest/api/content/${getConfluenceDoc.results[0].id}/child/attachment`,\n          config,\n        );\n\n        if (getDocAttachments.results.length) {\n          fs.mkdirSync(`${dirPath}/${filePathToMkdocs}docs/img`, {\n            recursive: true,\n          });\n          productArray = await getAndWriteAttachments(\n            getDocAttachments,\n            dirPath,\n            config,\n            filePathToMkdocs,\n          );\n        }\n\n        ctx.logger.info(\n          `starting action for converting ${titleWithSpaces} from Confluence To Markdown`,\n        );\n\n        // This reads mkdocs.yml file\n        const mkdocsFileContent = await readFileAsString(repoFileDir);\n        const mkdocsFile = await YAML.parse(mkdocsFileContent);\n        ctx.logger.info(\n          `Adding new file - ${titleWithSpaces} to the current mkdocs.yml file`,\n        );\n\n        // This modifies the mkdocs.yml file\n        if (mkdocsFile !== undefined && mkdocsFile.hasOwnProperty('nav')) {\n          const { nav } = mkdocsFile;\n          if (!nav.some((i: Obj) => i.hasOwnProperty(titleWithSpaces))) {\n            nav.push({\n              [titleWithSpaces]: `${titleWithSpaces.replace(/\\s+/g, '-')}.md`,\n            });\n            mkdocsFile.nav = nav;\n          } else {\n            throw new ConflictError(\n              'This document looks to exist inside the GitHub repo. Will end the action.',\n            );\n          }\n        }\n\n        await fs.writeFile(repoFileDir, YAML.stringify(mkdocsFile));\n\n        // This grabs the confluence html and converts it to markdown and adds attachments\n        const html = getConfluenceDoc.results[0].body.export_view.value;\n        const markdownToPublish = NodeHtmlMarkdown.translate(html);\n        let newString: string = markdownToPublish;\n        productArray.forEach((product: string[]) => {\n          // This regex is looking for either [](link to confluence) or ![](link to confluence) in the newly created markdown doc and updating it to point to the versions saved(in ./docs/img) in the local version of GitHub Repo during getAndWriteAttachments\n          const regex = product[0].includes('.pdf')\n            ? new RegExp(`(\\\\[.*?\\\\]\\\\()(.*?${product[0]}.*?)(\\\\))`, 'gi')\n            : new RegExp(`(\\\\!\\\\[.*?\\\\]\\\\()(.*?${product[0]}.*?)(\\\\))`, 'gi');\n          newString = newString.replace(regex, `$1./img/${product[1]}$3`);\n        });\n\n        ctx.logger.info(`Adding new file to repo.`);\n        await fs.outputFile(\n          `${dirPath}/${filePathToMkdocs}docs/${titleWithSpaces.replace(\n            /\\s+/g,\n            '-',\n          )}.md`,\n          newString,\n        );\n      }\n\n      ctx.output('repo', parsedRepoUrl.name);\n      ctx.output('owner', parsedRepoUrl.owner);\n    },\n  });\n};\n"],"names":["fs","fetch","ResponseError","ConflictError","InputError","createFetchPlainAction","createTemplateAction","parseGitUrl","YAML","NodeHtmlMarkdown"],"mappings":";;;;;;;;;;;;;;;;;;;;AA6Ca,MAAA,gBAAA,GAAmB,OAAO,OAAoB,KAAA;AACzD,EAAA,MAAM,OAAU,GAAA,MAAMA,sBAAG,CAAA,QAAA,CAAS,SAAS,OAAO,CAAA,CAAA;AAClD,EAAA,OAAO,QAAQ,QAAS,EAAA,CAAA;AAC1B,CAAA,CAAA;AAEa,MAAA,eAAA,GAAkB,OAAO,WAAA,EAAqB,MAAmB,KAAA;AAC5E,EAAM,MAAA,OAAA,GAAU,MAAO,CAAA,SAAA,CAAU,oBAAoB,CAAA,CAAA;AACrD,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,CAAA;AACjD,EAAA,MAAM,QAAqB,GAAA,MAAMC,yBAAM,CAAA,CAAA,EAAG,UAAU,WAAe,CAAA,CAAA,EAAA;AAAA,IACjE,MAAQ,EAAA,KAAA;AAAA,IACR,OAAS,EAAA;AAAA,MACP,eAAe,CAAU,OAAA,EAAA,KAAA,CAAA,CAAA;AAAA,KAC3B;AAAA,GACD,CAAA,CAAA;AACD,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,GACjD;AAEA,EAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AACvB,CAAA,CAAA;AAEO,MAAM,sBAAyB,GAAA,OACpC,GACA,EAAA,SAAA,EACA,QACA,SACG,KAAA;AACH,EAAA,MAAM,aAAyB,EAAC,CAAA;AAChC,EAAM,MAAA,OAAA,GAAU,MAAO,CAAA,SAAA,CAAU,oBAAoB,CAAA,CAAA;AACrD,EAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,CAAA;AACjD,EAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,IACZ,MAAM,GAAA,CAAI,OAAQ,CAAA,GAAA,CAAI,OAAO,MAAmB,KAAA;AAC9C,MAAM,MAAA,YAAA,GAAe,OAAO,MAAO,CAAA,QAAA,CAAA;AACnC,MAAA,MAAM,aAAgB,GAAA,MAAA,CAAO,KAAM,CAAA,OAAA,CAAQ,MAAM,GAAG,CAAA,CAAA;AACpD,MAAI,IAAA,MAAA,CAAO,QAAS,CAAA,SAAA,KAAc,yBAA2B,EAAA;AAC3D,QAAW,UAAA,CAAA,IAAA,CAAK,CAAC,MAAO,CAAA,KAAA,CAAM,QAAQ,IAAM,EAAA,KAAK,CAAG,EAAA,aAAa,CAAC,CAAA,CAAA;AAAA,OACpE;AAEA,MAAA,MAAM,GAAM,GAAA,MAAMD,yBAAM,CAAA,CAAA,EAAG,UAAU,YAAgB,CAAA,CAAA,EAAA;AAAA,QACnD,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,eAAe,CAAU,OAAA,EAAA,KAAA,CAAA,CAAA;AAAA,SAC3B;AAAA,OACD,CAAA,CAAA;AACD,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAM,MAAAC,oBAAA,CAAc,aAAa,GAAG,CAAA,CAAA;AAAA,OACtC,MAAA,IAAW,GAAI,CAAA,IAAA,KAAS,IAAM,EAAA;AAC5B,QAAAF,sBAAA,CAAG,QAAS,CAAA,CAAA,EAAG,SAAa,CAAA,CAAA,EAAA,SAAA,CAAA,SAAA,EAAqB,iBAAiB,GAAG,CAAA,CAAA;AACrE,QAAA,MAAM,cAAcA,sBAAG,CAAA,iBAAA;AAAA,UACrB,CAAA,EAAG,aAAa,SAAqB,CAAA,SAAA,EAAA,aAAA,CAAA,CAAA;AAAA,SACvC,CAAA;AACA,QAAI,GAAA,CAAA,IAAA,CAAK,KAAK,WAAW,CAAA,CAAA;AACzB,QAAA,MAAM,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACrC,UAAY,WAAA,CAAA,EAAA,CAAG,UAAU,MAAM;AAC7B,YAAQ,OAAA,CAAA,CAAA,EAAG,SAAa,CAAA,CAAA,EAAA,SAAA,CAAA,SAAA,EAAqB,aAAe,CAAA,CAAA,CAAA,CAAA;AAAA,WAC7D,CAAA,CAAA;AACD,UAAY,WAAA,CAAA,EAAA,CAAG,SAAS,MAAM,CAAA,CAAA;AAAA,SAC/B,CAAA,CAAA;AAAA,OACI,MAAA;AACL,QAAA,MAAM,IAAIG,oBAAA;AAAA,UACR,kEAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AACA,EAAO,OAAA,UAAA,CAAA;AACT,CAAA,CAAA;AAEa,MAAA,yBAAA,GAA4B,OAAO,GAAgB,KAAA;AAC9D,EAAA,IAAI,QAA+B,GAAA,KAAA,CAAA,CAAA;AACnC,EAAA,IAAI,KAA4B,GAAA,KAAA,CAAA,CAAA;AAChC,EAAA,IAAI,eAAsC,GAAA,EAAA,CAAA;AAC1C,EAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAC1B,EAAA,IAAI,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,SAAW,EAAA;AAC/C,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAO,QAAQ,KAAO,EAAA,GAAA,CAAA,CAAA;AACxC,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA,CAAA;AAAA,GAC5C;AACA,EAAA,MAAM,IAAIC,iBAAA;AAAA,IACR,0HAAA;AAAA,GACF,CAAA;AACF,CAAA;;AC3Fa,MAAA,gCAAA,GAAmC,CAAC,OAI3C,KAAA;AACJ,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,YAAA,EAAiB,GAAA,OAAA,CAAA;AACzC,EAAA,MAAM,gBAAmB,GAAAC,8CAAA,CAAuB,EAAE,MAAA,EAAQ,cAAc,CAAA,CAAA;AAKxE,EAAA,OAAOC,yCAGJ,CAAA;AAAA,IACD,EAAI,EAAA,+BAAA;AAAA,IACJ,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,UAAY,EAAA;AAAA,UACV,cAAgB,EAAA;AAAA,YACd,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA,gBAAA;AAAA,YACP,WACE,EAAA,yHAAA;AAAA,YACF,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,cACN,OAAS,EAAA,gBAAA;AAAA,aACX;AAAA,WACF;AAAA,UACA,OAAS,EAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WACE,EAAA,gFAAA;AAAA,WACJ;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,cAAA,EAAgB,OAAQ,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AACxC,MAAM,MAAA,aAAA,GAAgBC,gCAAY,OAAO,CAAA,CAAA;AACzC,MAAM,MAAA,gBAAA,GAAmB,cAAc,QAAS,CAAA,SAAA;AAAA,QAC9C,CAAA;AAAA,QACA,aAAc,CAAA,QAAA,CAAS,WAAY,CAAA,GAAG,CAAI,GAAA,CAAA;AAAA,OAC5C,CAAA;AACA,MAAA,MAAM,UAAU,GAAI,CAAA,aAAA,CAAA;AACpB,MAAA,IAAI,eAA2B,EAAC,CAAA;AAEhC,MAAI,GAAA,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,qCAAA,EAAwC,OAAS,CAAA,CAAA,CAAA,CAAA;AAGjE,MAAM,MAAA,WAAA,GAAc,CAAG,EAAA,OAAA,CAAA,CAAA,EAAW,aAAc,CAAA,QAAA,CAAA,CAAA,CAAA;AAChD,MAAA,MAAM,iBAAiB,OAAQ,CAAA;AAAA,QAC7B,GAAG,GAAA;AAAA,QACH,KAAO,EAAA;AAAA,UACL,KAAK,CAAW,QAAA,EAAA,aAAA,CAAc,QAAY,CAAA,CAAA,EAAA,aAAA,CAAc,SAAS,aAAc,CAAA,IAAA,CAAA,CAAA;AAAA,UAC/E,UAAY,EAAA,OAAA;AAAA,SACd;AAAA,OACD,CAAA,CAAA;AAED,MAAA,KAAA,MAAW,OAAO,cAAgB,EAAA;AAChC,QAAA,MAAM,EAAE,QAAU,EAAA,KAAA,EAAO,iBACvB,GAAA,MAAM,0BAA0B,GAAG,CAAA,CAAA;AAErC,QAAA,MAAM,mBAAmB,MAAM,eAAA;AAAA,UAC7B,2BAA2B,KAAkB,CAAA,UAAA,EAAA,QAAA,CAAA,wBAAA,CAAA;AAAA,UAC7C,MAAA;AAAA,SACF,CAAA;AACA,QAAI,IAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,KAAW,CAAG,EAAA;AACzC,UAAA,MAAM,IAAIH,iBAAA;AAAA,YACR,CAA2B,wBAAA,EAAA,GAAA,CAAA,0BAAA,CAAA;AAAA,WAC7B,CAAA;AAAA,SACF;AAEA,QAAA,MAAM,oBAAoB,MAAM,eAAA;AAAA,UAC9B,CAAqB,kBAAA,EAAA,gBAAA,CAAiB,OAAQ,CAAA,CAAC,CAAE,CAAA,EAAA,CAAA,iBAAA,CAAA;AAAA,UACjD,MAAA;AAAA,SACF,CAAA;AAEA,QAAI,IAAA,iBAAA,CAAkB,QAAQ,MAAQ,EAAA;AACpC,UAAGJ,sBAAA,CAAA,SAAA,CAAU,CAAG,EAAA,OAAA,CAAA,CAAA,EAAW,gBAA4B,CAAA,QAAA,CAAA,EAAA;AAAA,YACrD,SAAW,EAAA,IAAA;AAAA,WACZ,CAAA,CAAA;AACD,UAAA,YAAA,GAAe,MAAM,sBAAA;AAAA,YACnB,iBAAA;AAAA,YACA,OAAA;AAAA,YACA,MAAA;AAAA,YACA,gBAAA;AAAA,WACF,CAAA;AAAA,SACF;AAEA,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,CAAkC,+BAAA,EAAA,eAAA,CAAA,4BAAA,CAAA;AAAA,SACpC,CAAA;AAGA,QAAM,MAAA,iBAAA,GAAoB,MAAM,gBAAA,CAAiB,WAAW,CAAA,CAAA;AAC5D,QAAA,MAAM,UAAa,GAAA,MAAMQ,wBAAK,CAAA,KAAA,CAAM,iBAAiB,CAAA,CAAA;AACrD,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,CAAqB,kBAAA,EAAA,eAAA,CAAA,+BAAA,CAAA;AAAA,SACvB,CAAA;AAGA,QAAA,IAAI,UAAe,KAAA,KAAA,CAAA,IAAa,UAAW,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAChE,UAAM,MAAA,EAAE,KAAQ,GAAA,UAAA,CAAA;AAChB,UAAI,IAAA,CAAC,IAAI,IAAK,CAAA,CAAC,MAAW,CAAE,CAAA,cAAA,CAAe,eAAe,CAAC,CAAG,EAAA;AAC5D,YAAA,GAAA,CAAI,IAAK,CAAA;AAAA,cACP,CAAC,eAAe,GAAG,GAAG,eAAgB,CAAA,OAAA,CAAQ,QAAQ,GAAG,CAAA,CAAA,GAAA,CAAA;AAAA,aAC1D,CAAA,CAAA;AACD,YAAA,UAAA,CAAW,GAAM,GAAA,GAAA,CAAA;AAAA,WACZ,MAAA;AACL,YAAA,MAAM,IAAIL,oBAAA;AAAA,cACR,2EAAA;AAAA,aACF,CAAA;AAAA,WACF;AAAA,SACF;AAEA,QAAA,MAAMH,uBAAG,SAAU,CAAA,WAAA,EAAaQ,wBAAK,CAAA,SAAA,CAAU,UAAU,CAAC,CAAA,CAAA;AAG1D,QAAA,MAAM,OAAO,gBAAiB,CAAA,OAAA,CAAQ,CAAC,CAAA,CAAE,KAAK,WAAY,CAAA,KAAA,CAAA;AAC1D,QAAM,MAAA,iBAAA,GAAoBC,iCAAiB,CAAA,SAAA,CAAU,IAAI,CAAA,CAAA;AACzD,QAAA,IAAI,SAAoB,GAAA,iBAAA,CAAA;AACxB,QAAa,YAAA,CAAA,OAAA,CAAQ,CAAC,OAAsB,KAAA;AAE1C,UAAM,MAAA,KAAA,GAAQ,QAAQ,CAAC,CAAA,CAAE,SAAS,MAAM,CAAA,GACpC,IAAI,MAAO,CAAA,CAAA,kBAAA,EAAqB,QAAQ,CAAC,CAAA,CAAA,SAAA,CAAA,EAAc,IAAI,CAC3D,GAAA,IAAI,OAAO,CAAwB,qBAAA,EAAA,OAAA,CAAQ,CAAC,CAAA,CAAA,SAAA,CAAA,EAAc,IAAI,CAAA,CAAA;AAClE,UAAA,SAAA,GAAY,UAAU,OAAQ,CAAA,KAAA,EAAO,CAAW,QAAA,EAAA,OAAA,CAAQ,CAAC,CAAK,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SAC/D,CAAA,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAA0B,wBAAA,CAAA,CAAA,CAAA;AAC1C,QAAA,MAAMT,sBAAG,CAAA,UAAA;AAAA,UACP,CAAA,EAAG,OAAW,CAAA,CAAA,EAAA,gBAAA,CAAA,KAAA,EAAwB,eAAgB,CAAA,OAAA;AAAA,YACpD,MAAA;AAAA,YACA,GAAA;AAAA,WACF,CAAA,GAAA,CAAA;AAAA,UACA,SAAA;AAAA,SACF,CAAA;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,aAAA,CAAc,IAAI,CAAA,CAAA;AACrC,MAAI,GAAA,CAAA,MAAA,CAAO,OAAS,EAAA,aAAA,CAAc,KAAK,CAAA,CAAA;AAAA,KACzC;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import { Config } from '@backstage/config';
+import { UrlReader } from '@backstage/backend-common';
+import { ScmIntegrations } from '@backstage/integration';
+
+/**
+ * @public
+ */
+declare const createConfluenceToMarkdownAction: (options: {
+    reader: UrlReader;
+    integrations: ScmIntegrations;
+    config: Config;
+}) => _backstage_plugin_scaffolder_node.TemplateAction<{
+    confluenceUrls: string[];
+    repoUrl: string;
+}>;
+
+export { createConfluenceToMarkdownAction };

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-confluence-to-markdown",
+  "description": "The confluence-to-markdown module for @backstage/plugin-scaffolder-backend",
+  "version": "0.0.0-nightly-20230325022054",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "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",
+    "help": "backstage-cli help"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20230325022054",
+    "@backstage/config": "^1.0.7",
+    "@backstage/errors": "^1.1.5",
+    "@backstage/integration": "^1.4.3",
+    "@backstage/plugin-scaffolder-backend": "^0.0.0-nightly-20230325022054",
+    "@backstage/plugin-scaffolder-node": "^0.0.0-nightly-20230325022054",
+    "@backstage/types": "^1.0.2",
+    "fs-extra": "10.1.0",
+    "git-url-parse": "^13.1.0",
+    "node-fetch": "^2.6.7",
+    "node-html-markdown": "^1.3.0",
+    "yaml": "^2.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20230325022054",
+    "@backstage/test-utils": "^0.0.0-nightly-20230325022054",
+    "mock-fs": "^5.2.0",
+    "msw": "^1.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}