@backstage/plugin-scaffolder-backend-module-confluence-to-markdown 0.3.10-next.0 → 0.3.10-next.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
 
+## 0.3.10-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.9.0-next.2
+  - @backstage/backend-plugin-api@1.4.0-next.1
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/integration@1.17.0
+
+## 0.3.10-next.1
+
+### Patch Changes
+
+- 4a86bca: Migrate actions to new format
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.8.3-next.1
+  - @backstage/backend-plugin-api@1.4.0-next.1
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/integration@1.17.0
+
 ## 0.3.10-next.0
 
 ### Patch Changes

package/dist/actions/confluence/confluenceToMarkdown.cjs.js

@@ -23,22 +23,20 @@ const createConfluenceToMarkdownAction = (options) => {
     examples: confluenceToMarkdown_examples.examples,
     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} or https://{confluence+base+url}/spaces/{spacekey}/pages/1234567/{page+title} for Confluence Cloud",
-            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"
-          }
-        }
+        confluenceUrls: (z) => z.array(z.string(), {
+          description: "Paste your Confluence url. Ensure it follows this format: https://{confluence+base+url}/display/{spacekey}/{page+title} or https://{confluence+base+url}/spaces/{spacekey}/pages/1234567/{page+title} for Confluence Cloud"
+        }),
+        repoUrl: (z) => z.string({
+          description: "mkdocs.yml file location inside the github repo you want to store the document"
+        })
+      },
+      output: {
+        repo: (z) => z.string({
+          description: "Repository name"
+        }).optional(),
+        owner: (z) => z.string({
+          description: "Repository owner"
+        }).optional()
       }
     },
     async handler(ctx) {

package/dist/actions/confluence/confluenceToMarkdown.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"confluenceToMarkdown.cjs.js","sources":["../../../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 { ScmIntegrations } from '@backstage/integration';\nimport {\n  createTemplateAction,\n  fetchContents,\n} 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  getConfluenceConfig,\n} from './helpers';\nimport { examples } from './confluenceToMarkdown.examples';\nimport { UrlReaderService } from '@backstage/backend-plugin-api';\n\n/**\n * @public\n */\n\nexport const createConfluenceToMarkdownAction = (options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  config: Config;\n}) => {\n  const { config, reader, integrations } = options;\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    description: 'Transforms Confluence content to Markdown',\n    examples,\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} or https://{confluence+base+url}/spaces/{spacekey}/pages/1234567/{page+title} for Confluence Cloud',\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 confluenceConfig = getConfluenceConfig(config);\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      const repoFileDir = `${dirPath}/${parsedRepoUrl.filepath}`;\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      await fetchContents({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: `https://${parsedRepoUrl.resource}/${parsedRepoUrl.owner}/${parsedRepoUrl.name}`,\n        outputPath: ctx.workspacePath,\n      });\n\n      for (const url of confluenceUrls) {\n        const { spacekey, title, titleWithSpaces } =\n          createConfluenceVariables(url);\n        // This calls confluence to get the page html and page id\n        ctx.logger.info(`Fetching the Confluence content for ${url}`);\n        const getConfluenceDoc = await fetchConfluence(\n          `/rest/api/content?title=${title}&spaceKey=${spacekey}&expand=body.export_view`,\n          confluenceConfig,\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 attachments for the confluence page if they exist\n        const getDocAttachments = await fetchConfluence(\n          `/rest/api/content/${getConfluenceDoc.results[0].id}/child/attachment`,\n          confluenceConfig,\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            confluenceConfig,\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":["createTemplateAction","examples","getConfluenceConfig","parseGitUrl","fetchContents","createConfluenceVariables","fetchConfluence","InputError","fs","getAndWriteAttachments","readFileAsString","YAML","ConflictError","NodeHtmlMarkdown"],"mappings":";;;;;;;;;;;;;;;;;AAyCa,MAAA,gCAAA,GAAmC,CAAC,OAI3C,KAAA;AACJ,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,YAAA,EAAiB,GAAA,OAAA;AAKzC,EAAA,OAAOA,yCAGJ,CAAA;AAAA,IACD,EAAI,EAAA,+BAAA;AAAA,IACJ,WAAa,EAAA,2CAAA;AAAA,cACbC,sCAAA;AAAA,IACA,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,4NAAA;AAAA,YACF,KAAO,EAAA;AAAA,cACL,IAAM,EAAA,QAAA;AAAA,cACN,OAAS,EAAA;AAAA;AACX,WACF;AAAA,UACA,OAAS,EAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,gBAAA,GAAmBC,4BAAoB,MAAM,CAAA;AACnD,MAAA,MAAM,EAAE,cAAA,EAAgB,OAAQ,EAAA,GAAI,GAAI,CAAA,KAAA;AACxC,MAAM,MAAA,aAAA,GAAgBC,6BAAY,OAAO,CAAA;AACzC,MAAM,MAAA,gBAAA,GAAmB,cAAc,QAAS,CAAA,SAAA;AAAA,QAC9C,CAAA;AAAA,QACA,aAAc,CAAA,QAAA,CAAS,WAAY,CAAA,GAAG,CAAI,GAAA;AAAA,OAC5C;AACA,MAAA,MAAM,UAAU,GAAI,CAAA,aAAA;AACpB,MAAA,MAAM,WAAc,GAAA,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,cAAc,QAAQ,CAAA,CAAA;AACxD,MAAA,IAAI,eAA2B,EAAC;AAEhC,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,OAAO,CAAE,CAAA,CAAA;AAGjE,MAAA,MAAMC,kCAAc,CAAA;AAAA,QAClB,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,WAAW,aAAc,CAAA,QAAQ,IAAI,aAAc,CAAA,KAAK,CAAI,CAAA,EAAA,aAAA,CAAc,IAAI,CAAA,CAAA;AAAA,QACxF,YAAY,GAAI,CAAA;AAAA,OACjB,CAAA;AAED,MAAA,KAAA,MAAW,OAAO,cAAgB,EAAA;AAChC,QAAA,MAAM,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA,GACvCC,kCAA0B,GAAG,CAAA;AAE/B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAuC,oCAAA,EAAA,GAAG,CAAE,CAAA,CAAA;AAC5D,QAAA,MAAM,mBAAmB,MAAMC,uBAAA;AAAA,UAC7B,CAAA,wBAAA,EAA2B,KAAK,CAAA,UAAA,EAAa,QAAQ,CAAA,wBAAA,CAAA;AAAA,UACrD;AAAA,SACF;AACA,QAAI,IAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,KAAW,CAAG,EAAA;AACzC,UAAA,MAAM,IAAIC,iBAAA;AAAA,YACR,2BAA2B,GAAG,CAAA,0BAAA;AAAA,WAChC;AAAA;AAGF,QAAA,MAAM,oBAAoB,MAAMD,uBAAA;AAAA,UAC9B,CAAqB,kBAAA,EAAA,gBAAA,CAAiB,OAAQ,CAAA,CAAC,EAAE,EAAE,CAAA,iBAAA,CAAA;AAAA,UACnD;AAAA,SACF;AAEA,QAAI,IAAA,iBAAA,CAAkB,QAAQ,MAAQ,EAAA;AACpC,UAAAE,mBAAA,CAAG,SAAU,CAAA,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,gBAAgB,CAAY,QAAA,CAAA,EAAA;AAAA,YACrD,SAAW,EAAA;AAAA,WACZ,CAAA;AACD,UAAA,YAAA,GAAe,MAAMC,8BAAA;AAAA,YACnB,iBAAA;AAAA,YACA,OAAA;AAAA,YACA,gBAAA;AAAA,YACA;AAAA,WACF;AAAA;AAGF,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,kCAAkC,eAAe,CAAA,4BAAA;AAAA,SACnD;AAGA,QAAM,MAAA,iBAAA,GAAoB,MAAMC,wBAAA,CAAiB,WAAW,CAAA;AAC5D,QAAA,MAAM,UAAa,GAAA,MAAMC,qBAAK,CAAA,KAAA,CAAM,iBAAiB,CAAA;AACrD,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,qBAAqB,eAAe,CAAA,+BAAA;AAAA,SACtC;AAGA,QAAA,IAAI,UAAe,KAAA,KAAA,CAAA,IAAa,UAAW,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAChE,UAAM,MAAA,EAAE,KAAQ,GAAA,UAAA;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,CAAA,EAAG,gBAAgB,OAAQ,CAAA,MAAA,EAAQ,GAAG,CAAC,CAAA,GAAA;AAAA,aAC3D,CAAA;AACD,YAAA,UAAA,CAAW,GAAM,GAAA,GAAA;AAAA,WACZ,MAAA;AACL,YAAA,MAAM,IAAIC,oBAAA;AAAA,cACR;AAAA,aACF;AAAA;AACF;AAGF,QAAA,MAAMJ,oBAAG,SAAU,CAAA,WAAA,EAAaG,qBAAK,CAAA,SAAA,CAAU,UAAU,CAAC,CAAA;AAG1D,QAAA,MAAM,OAAO,gBAAiB,CAAA,OAAA,CAAQ,CAAC,CAAA,CAAE,KAAK,WAAY,CAAA,KAAA;AAC1D,QAAM,MAAA,iBAAA,GAAoBE,iCAAiB,CAAA,SAAA,CAAU,IAAI,CAAA;AACzD,QAAA,IAAI,SAAoB,GAAA,iBAAA;AACxB,QAAa,YAAA,CAAA,OAAA,CAAQ,CAAC,OAAsB,KAAA;AAE1C,UAAM,MAAA,KAAA,GAAQ,QAAQ,CAAC,CAAA,CAAE,SAAS,MAAM,CAAA,GACpC,IAAI,MAAA,CAAO,CAAqB,kBAAA,EAAA,OAAA,CAAQ,CAAC,CAAC,CAAA,SAAA,CAAA,EAAa,IAAI,CAAA,GAC3D,IAAI,MAAA,CAAO,wBAAwB,OAAQ,CAAA,CAAC,CAAC,CAAA,SAAA,CAAA,EAAa,IAAI,CAAA;AAClE,UAAA,SAAA,GAAY,UAAU,OAAQ,CAAA,KAAA,EAAO,WAAW,OAAQ,CAAA,CAAC,CAAC,CAAI,EAAA,CAAA,CAAA;AAAA,SAC/D,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAA0B,wBAAA,CAAA,CAAA;AAC1C,QAAA,MAAML,mBAAG,CAAA,UAAA;AAAA,UACP,CAAG,EAAA,OAAO,CAAI,CAAA,EAAA,gBAAgB,QAAQ,eAAgB,CAAA,OAAA;AAAA,YACpD,MAAA;AAAA,YACA;AAAA,WACD,CAAA,GAAA,CAAA;AAAA,UACD;AAAA,SACF;AAAA;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,aAAA,CAAc,IAAI,CAAA;AACrC,MAAI,GAAA,CAAA,MAAA,CAAO,OAAS,EAAA,aAAA,CAAc,KAAK,CAAA;AAAA;AACzC,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"confluenceToMarkdown.cjs.js","sources":["../../../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 { ScmIntegrations } from '@backstage/integration';\nimport {\n  createTemplateAction,\n  fetchContents,\n} 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  getConfluenceConfig,\n} from './helpers';\nimport { examples } from './confluenceToMarkdown.examples';\nimport { UrlReaderService } from '@backstage/backend-plugin-api';\n\n/**\n * @public\n */\n\nexport const createConfluenceToMarkdownAction = (options: {\n  reader: UrlReaderService;\n  integrations: ScmIntegrations;\n  config: Config;\n}) => {\n  const { config, reader, integrations } = options;\n  type Obj = {\n    [key: string]: string;\n  };\n\n  return createTemplateAction({\n    id: 'confluence:transform:markdown',\n    description: 'Transforms Confluence content to Markdown',\n    examples,\n    schema: {\n      input: {\n        confluenceUrls: z =>\n          z.array(z.string(), {\n            description:\n              'Paste your Confluence url. Ensure it follows this format: https://{confluence+base+url}/display/{spacekey}/{page+title} or https://{confluence+base+url}/spaces/{spacekey}/pages/1234567/{page+title} for Confluence Cloud',\n          }),\n        repoUrl: z =>\n          z.string({\n            description:\n              'mkdocs.yml file location inside the github repo you want to store the document',\n          }),\n      },\n      output: {\n        repo: z =>\n          z\n            .string({\n              description: 'Repository name',\n            })\n            .optional(),\n        owner: z =>\n          z\n            .string({\n              description: 'Repository owner',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const confluenceConfig = getConfluenceConfig(config);\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      const repoFileDir = `${dirPath}/${parsedRepoUrl.filepath}`;\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      await fetchContents({\n        reader,\n        integrations,\n        baseUrl: ctx.templateInfo?.baseUrl,\n        fetchUrl: `https://${parsedRepoUrl.resource}/${parsedRepoUrl.owner}/${parsedRepoUrl.name}`,\n        outputPath: ctx.workspacePath,\n      });\n\n      for (const url of confluenceUrls) {\n        const { spacekey, title, titleWithSpaces } =\n          createConfluenceVariables(url);\n        // This calls confluence to get the page html and page id\n        ctx.logger.info(`Fetching the Confluence content for ${url}`);\n        const getConfluenceDoc = await fetchConfluence(\n          `/rest/api/content?title=${title}&spaceKey=${spacekey}&expand=body.export_view`,\n          confluenceConfig,\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 attachments for the confluence page if they exist\n        const getDocAttachments = await fetchConfluence(\n          `/rest/api/content/${getConfluenceDoc.results[0].id}/child/attachment`,\n          confluenceConfig,\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            confluenceConfig,\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":["createTemplateAction","examples","getConfluenceConfig","parseGitUrl","fetchContents","createConfluenceVariables","fetchConfluence","InputError","fs","getAndWriteAttachments","readFileAsString","YAML","ConflictError","NodeHtmlMarkdown"],"mappings":";;;;;;;;;;;;;;;;;AAyCa,MAAA,gCAAA,GAAmC,CAAC,OAI3C,KAAA;AACJ,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,YAAA,EAAiB,GAAA,OAAA;AAKzC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,+BAAA;AAAA,IACJ,WAAa,EAAA,2CAAA;AAAA,cACbC,sCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,gBAAgB,CACd,CAAA,KAAA,CAAA,CAAE,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UAClB,WACE,EAAA;AAAA,SACH,CAAA;AAAA,QACH,OAAA,EAAS,CACP,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH;AAAA,OACL;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAA,EAAM,CACJ,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,gBAAA,GAAmBC,4BAAoB,MAAM,CAAA;AACnD,MAAA,MAAM,EAAE,cAAA,EAAgB,OAAQ,EAAA,GAAI,GAAI,CAAA,KAAA;AACxC,MAAM,MAAA,aAAA,GAAgBC,6BAAY,OAAO,CAAA;AACzC,MAAM,MAAA,gBAAA,GAAmB,cAAc,QAAS,CAAA,SAAA;AAAA,QAC9C,CAAA;AAAA,QACA,aAAc,CAAA,QAAA,CAAS,WAAY,CAAA,GAAG,CAAI,GAAA;AAAA,OAC5C;AACA,MAAA,MAAM,UAAU,GAAI,CAAA,aAAA;AACpB,MAAA,MAAM,WAAc,GAAA,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,cAAc,QAAQ,CAAA,CAAA;AACxD,MAAA,IAAI,eAA2B,EAAC;AAEhC,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,OAAO,CAAE,CAAA,CAAA;AAGjE,MAAA,MAAMC,kCAAc,CAAA;AAAA,QAClB,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,WAAW,aAAc,CAAA,QAAQ,IAAI,aAAc,CAAA,KAAK,CAAI,CAAA,EAAA,aAAA,CAAc,IAAI,CAAA,CAAA;AAAA,QACxF,YAAY,GAAI,CAAA;AAAA,OACjB,CAAA;AAED,MAAA,KAAA,MAAW,OAAO,cAAgB,EAAA;AAChC,QAAA,MAAM,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA,GACvCC,kCAA0B,GAAG,CAAA;AAE/B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAuC,oCAAA,EAAA,GAAG,CAAE,CAAA,CAAA;AAC5D,QAAA,MAAM,mBAAmB,MAAMC,uBAAA;AAAA,UAC7B,CAAA,wBAAA,EAA2B,KAAK,CAAA,UAAA,EAAa,QAAQ,CAAA,wBAAA,CAAA;AAAA,UACrD;AAAA,SACF;AACA,QAAI,IAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,KAAW,CAAG,EAAA;AACzC,UAAA,MAAM,IAAIC,iBAAA;AAAA,YACR,2BAA2B,GAAG,CAAA,0BAAA;AAAA,WAChC;AAAA;AAGF,QAAA,MAAM,oBAAoB,MAAMD,uBAAA;AAAA,UAC9B,CAAqB,kBAAA,EAAA,gBAAA,CAAiB,OAAQ,CAAA,CAAC,EAAE,EAAE,CAAA,iBAAA,CAAA;AAAA,UACnD;AAAA,SACF;AAEA,QAAI,IAAA,iBAAA,CAAkB,QAAQ,MAAQ,EAAA;AACpC,UAAAE,mBAAA,CAAG,SAAU,CAAA,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,gBAAgB,CAAY,QAAA,CAAA,EAAA;AAAA,YACrD,SAAW,EAAA;AAAA,WACZ,CAAA;AACD,UAAA,YAAA,GAAe,MAAMC,8BAAA;AAAA,YACnB,iBAAA;AAAA,YACA,OAAA;AAAA,YACA,gBAAA;AAAA,YACA;AAAA,WACF;AAAA;AAGF,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,kCAAkC,eAAe,CAAA,4BAAA;AAAA,SACnD;AAGA,QAAM,MAAA,iBAAA,GAAoB,MAAMC,wBAAA,CAAiB,WAAW,CAAA;AAC5D,QAAA,MAAM,UAAa,GAAA,MAAMC,qBAAK,CAAA,KAAA,CAAM,iBAAiB,CAAA;AACrD,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,qBAAqB,eAAe,CAAA,+BAAA;AAAA,SACtC;AAGA,QAAA,IAAI,UAAe,KAAA,KAAA,CAAA,IAAa,UAAW,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAChE,UAAM,MAAA,EAAE,KAAQ,GAAA,UAAA;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,CAAA,EAAG,gBAAgB,OAAQ,CAAA,MAAA,EAAQ,GAAG,CAAC,CAAA,GAAA;AAAA,aAC3D,CAAA;AACD,YAAA,UAAA,CAAW,GAAM,GAAA,GAAA;AAAA,WACZ,MAAA;AACL,YAAA,MAAM,IAAIC,oBAAA;AAAA,cACR;AAAA,aACF;AAAA;AACF;AAGF,QAAA,MAAMJ,oBAAG,SAAU,CAAA,WAAA,EAAaG,qBAAK,CAAA,SAAA,CAAU,UAAU,CAAC,CAAA;AAG1D,QAAA,MAAM,OAAO,gBAAiB,CAAA,OAAA,CAAQ,CAAC,CAAA,CAAE,KAAK,WAAY,CAAA,KAAA;AAC1D,QAAM,MAAA,iBAAA,GAAoBE,iCAAiB,CAAA,SAAA,CAAU,IAAI,CAAA;AACzD,QAAA,IAAI,SAAoB,GAAA,iBAAA;AACxB,QAAa,YAAA,CAAA,OAAA,CAAQ,CAAC,OAAsB,KAAA;AAE1C,UAAM,MAAA,KAAA,GAAQ,QAAQ,CAAC,CAAA,CAAE,SAAS,MAAM,CAAA,GACpC,IAAI,MAAA,CAAO,CAAqB,kBAAA,EAAA,OAAA,CAAQ,CAAC,CAAC,CAAA,SAAA,CAAA,EAAa,IAAI,CAAA,GAC3D,IAAI,MAAA,CAAO,wBAAwB,OAAQ,CAAA,CAAC,CAAC,CAAA,SAAA,CAAA,EAAa,IAAI,CAAA;AAClE,UAAA,SAAA,GAAY,UAAU,OAAQ,CAAA,KAAA,EAAO,WAAW,OAAQ,CAAA,CAAC,CAAC,CAAI,EAAA,CAAA,CAAA;AAAA,SAC/D,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAA0B,wBAAA,CAAA,CAAA;AAC1C,QAAA,MAAML,mBAAG,CAAA,UAAA;AAAA,UACP,CAAG,EAAA,OAAO,CAAI,CAAA,EAAA,gBAAgB,QAAQ,eAAgB,CAAA,OAAA;AAAA,YACpD,MAAA;AAAA,YACA;AAAA,WACD,CAAA,GAAA,CAAA;AAAA,UACD;AAAA,SACF;AAAA;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,aAAA,CAAc,IAAI,CAAA;AACrC,MAAI,GAAA,CAAA,MAAA,CAAO,OAAS,EAAA,aAAA,CAAc,KAAK,CAAA;AAAA;AACzC,GACD,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
-import * as _backstage_types from '@backstage/types';
 import { Config } from '@backstage/config';
 import { ScmIntegrations } from '@backstage/integration';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
@@ -15,7 +14,10 @@ declare const createConfluenceToMarkdownAction: (options: {
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     confluenceUrls: string[];
     repoUrl: string;
-}, _backstage_types.JsonObject, "v1">;
+}, {
+    repo?: string | undefined;
+    owner?: string | undefined;
+}, "v2">;
 
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-confluence-to-markdown",
-  "version": "0.3.10-next.0",
+  "version": "0.3.10-next.2",
   "description": "The confluence-to-markdown module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "backend-plugin-module",
@@ -53,20 +53,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.0-next.0",
+    "@backstage/backend-plugin-api": "1.4.0-next.1",
     "@backstage/config": "1.3.2",
     "@backstage/errors": "1.2.7",
     "@backstage/integration": "1.17.0",
-    "@backstage/plugin-scaffolder-node": "0.8.3-next.0",
+    "@backstage/plugin-scaffolder-node": "0.9.0-next.2",
     "fs-extra": "^11.2.0",
     "git-url-parse": "^15.0.0",
     "node-html-markdown": "^1.3.0",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.6.0-next.0",
-    "@backstage/cli": "0.32.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.2.3-next.0",
+    "@backstage/backend-test-utils": "1.6.0-next.2",
+    "@backstage/cli": "0.33.0-next.1",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.0-next.2",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"