@backstage/plugin-scaffolder-backend-module-confluence-to-markdown 0.3.3 → 0.3.4-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +29 -2
  2. package/dist/actions/confluence/helpers.cjs.js +4 -5
  3. package/dist/actions/confluence/helpers.cjs.js.map +1 -1
  4. package/package.json +9 -10
package/CHANGELOG.md CHANGED
@@ -1,11 +1,38 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
2
2
 
3
- ## 0.3.3
3
+ ## 0.3.4-next.2
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/plugin-scaffolder-node@0.6.1
8
+ - @backstage/backend-plugin-api@1.1.0-next.2
9
+ - @backstage/errors@1.2.6-next.0
10
+ - @backstage/plugin-scaffolder-node@0.6.2-next.2
11
+ - @backstage/config@1.3.1-next.0
12
+ - @backstage/integration@1.16.0-next.1
13
+
14
+ ## 0.3.4-next.1
15
+
16
+ ### Patch Changes
17
+
18
+ - 5c9cc05: Use native fetch instead of node-fetch
19
+ - Updated dependencies
20
+ - @backstage/plugin-scaffolder-node@0.6.2-next.1
21
+ - @backstage/backend-plugin-api@1.1.0-next.1
22
+ - @backstage/config@1.3.0
23
+ - @backstage/errors@1.2.5
24
+ - @backstage/integration@1.16.0-next.0
25
+
26
+ ## 0.3.3-next.0
27
+
28
+ ### Patch Changes
29
+
30
+ - Updated dependencies
31
+ - @backstage/integration@1.16.0-next.0
32
+ - @backstage/backend-plugin-api@1.0.3-next.0
33
+ - @backstage/plugin-scaffolder-node@0.6.1-next.0
34
+ - @backstage/config@1.3.0
35
+ - @backstage/errors@1.2.5
9
36
 
10
37
  ## 0.3.2
11
38
 
package/dist/actions/confluence/helpers.cjs.js CHANGED
@@ -2,12 +2,11 @@
2
2
 
3
3
  var errors = require('@backstage/errors');
4
4
  var fs = require('fs-extra');
5
- var fetch = require('node-fetch');
5
+ var stream = require('stream');
6
6
 
7
7
  function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
8
8
 
9
9
  var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
10
- var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
11
10
 
12
11
  const getConfluenceConfig = (config) => {
13
12
  const confluenceConfig = {
@@ -62,7 +61,7 @@ const fetchConfluence = async (relativeUrl, config) => {
62
61
  const baseUrl = config.baseUrl;
63
62
  const authHeaderValue = getAuthorizationHeaderValue(config);
64
63
  const url = `${baseUrl}${relativeUrl}`;
65
- const response = await fetch__default.default(url, {
64
+ const response = await fetch(url, {
66
65
  method: "GET",
67
66
  headers: {
68
67
  Authorization: authHeaderValue
@@ -85,7 +84,7 @@ const getAndWriteAttachments = async (arr, workspace, config, mkdocsDir) => {
85
84
  productArr.push([result.title.replace(/ /g, "%20"), downloadTitle]);
86
85
  }
87
86
  const url = `${baseUrl}${downloadLink}`;
88
- const res = await fetch__default.default(url, {
87
+ const res = await fetch(url, {
89
88
  method: "GET",
90
89
  headers: {
91
90
  Authorization: authHeaderValue
@@ -98,7 +97,7 @@ const getAndWriteAttachments = async (arr, workspace, config, mkdocsDir) => {
98
97
  const writeStream = fs__default.default.createWriteStream(
99
98
  `${workspace}/${mkdocsDir}docs/img/${downloadTitle}`
100
99
  );
101
- res.body.pipe(writeStream);
100
+ stream.Readable.fromWeb(res.body).pipe(writeStream);
102
101
  await new Promise((resolve, reject) => {
103
102
  writeStream.on("finish", () => {
104
103
  resolve(`${workspace}/${mkdocsDir}docs/img/${downloadTitle}`);
package/dist/actions/confluence/helpers.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"helpers.cjs.js","sources":["../../../src/actions/confluence/helpers.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 type LocalConfluenceConfig = {\n baseUrl: string;\n auth: string;\n token?: string;\n email?: string;\n username?: string;\n password?: string;\n};\n\nexport const getConfluenceConfig = (config: Config) => {\n const confluenceConfig = {\n baseUrl: config.getString('confluence.baseUrl'),\n auth: config.getOptionalString('confluence.auth.type') ?? 'bearer',\n token: config.getOptionalString('confluence.auth.token'),\n email: config.getOptionalString('confluence.auth.email'),\n username: config.getOptionalString('confluence.auth.username'),\n password: config.getOptionalString('confluence.auth.password'),\n };\n\n if (\n (confluenceConfig.auth === 'basic' || confluenceConfig.auth === 'bearer') &&\n !confluenceConfig.token\n ) {\n throw new Error(\n `No token provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n if (confluenceConfig.auth === 'basic' && !confluenceConfig.email) {\n throw new Error(\n `No email provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n if (\n confluenceConfig.auth === 'userpass' &&\n (!confluenceConfig.username || !confluenceConfig.password)\n ) {\n throw new Error(\n `No username/password provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n return confluenceConfig;\n};\n\nexport const getAuthorizationHeaderValue = (config: LocalConfluenceConfig) => {\n switch (config.auth) {\n case 'bearer':\n return `Bearer ${config.token}`;\n case 'basic': {\n const buffer = Buffer.from(`${config.email}:${config.token}`, 'utf8');\n return `Basic ${buffer.toString('base64')}`;\n }\n case 'userpass': {\n const buffer = Buffer.from(\n `${config.username}:${config.password}`,\n 'utf8',\n );\n return `Basic ${buffer.toString('base64')}`;\n }\n default:\n throw new Error(`Unknown auth method '${config.auth}' provided`);\n }\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 (\n relativeUrl: string,\n config: LocalConfluenceConfig,\n) => {\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\n const url = `${baseUrl}${relativeUrl}`;\n const response: Response = await fetch(url, {\n method: 'GET',\n headers: {\n Authorization: authHeaderValue,\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: LocalConfluenceConfig,\n mkdocsDir: string,\n) => {\n const productArr: string[][] = [];\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\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 const url = `${baseUrl}${downloadLink}`;\n const res = await fetch(url, {\n method: 'GET',\n headers: {\n Authorization: authHeaderValue,\n },\n });\n if (!res.ok) {\n throw await 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 = (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 // https://confluence.example.com/display/SPACEKEY/Page+Title\n spacekey = params.pathname.split('/')[2];\n title = params.pathname.split('/')[3];\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n } else if (params.pathname.split('/')[2] === 'display') {\n // https://confluence.example.com/prefix/display/SPACEKEY/Page+Title\n spacekey = params.pathname.split('/')[3];\n title = params.pathname.split('/')[4];\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n } else if (params.pathname.split('/')[2] === 'spaces') {\n // https://example.atlassian.net/wiki/spaces/SPACEKEY/pages/1234567/Page+Title\n spacekey = params.pathname.split('/')[3];\n title = params.pathname.split('/')[6];\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>` or `<CONFLUENCE_BASE_URL>/spaces/<SPACEKEY>/pages/<PAGEID>/<PAGE+TITLE>` for Confluence cloud',\n );\n};\n"],"names":["fs","fetch","ResponseError","ConflictError","InputError"],"mappings":";;;;;;;;;;;AAsDa,MAAA,mBAAA,GAAsB,CAAC,MAAmB,KAAA;AACrD,EAAA,MAAM,gBAAmB,GAAA;AAAA,IACvB,OAAA,EAAS,MAAO,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,IAC9C,IAAM,EAAA,MAAA,CAAO,iBAAkB,CAAA,sBAAsB,CAAK,IAAA,QAAA;AAAA,IAC1D,KAAA,EAAO,MAAO,CAAA,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,KAAA,EAAO,MAAO,CAAA,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,QAAA,EAAU,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAAA,IAC7D,QAAA,EAAU,MAAO,CAAA,iBAAA,CAAkB,0BAA0B;AAAA,GAC/D;AAEA,EACG,IAAA,CAAA,gBAAA,CAAiB,SAAS,OAAW,IAAA,gBAAA,CAAiB,SAAS,QAChE,KAAA,CAAC,iBAAiB,KAClB,EAAA;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA;AAGF,EAAA,IAAI,gBAAiB,CAAA,IAAA,KAAS,OAAW,IAAA,CAAC,iBAAiB,KAAO,EAAA;AAChE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA;AAGF,EACE,IAAA,gBAAA,CAAiB,SAAS,UACzB,KAAA,CAAC,iBAAiB,QAAY,IAAA,CAAC,iBAAiB,QACjD,CAAA,EAAA;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kDAAA,EAAqD,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAC5E;AAAA;AAGF,EAAO,OAAA,gBAAA;AACT;AAEa,MAAA,2BAAA,GAA8B,CAAC,MAAkC,KAAA;AAC5E,EAAA,QAAQ,OAAO,IAAM;AAAA,IACnB,KAAK,QAAA;AACH,MAAO,OAAA,CAAA,OAAA,EAAU,OAAO,KAAK,CAAA,CAAA;AAAA,IAC/B,KAAK,OAAS,EAAA;AACZ,MAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,KAAK,CAAI,CAAA,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAM,CAAA;AACpE,MAAA,OAAO,CAAS,MAAA,EAAA,MAAA,CAAO,QAAS,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA;AAC3C,IACA,KAAK,UAAY,EAAA;AACf,MAAA,MAAM,SAAS,MAAO,CAAA,IAAA;AAAA,QACpB,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,OAAO,QAAQ,CAAA,CAAA;AAAA,QACrC;AAAA,OACF;AACA,MAAA,OAAO,CAAS,MAAA,EAAA,MAAA,CAAO,QAAS,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA;AAC3C,IACA;AACE,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,MAAA,CAAO,IAAI,CAAY,UAAA,CAAA,CAAA;AAAA;AAErE;AAEa,MAAA,gBAAA,GAAmB,OAAO,OAAoB,KAAA;AACzD,EAAA,MAAM,OAAU,GAAA,MAAMA,mBAAG,CAAA,QAAA,CAAS,SAAS,OAAO,CAAA;AAClD,EAAA,OAAO,QAAQ,QAAS,EAAA;AAC1B;AAEa,MAAA,eAAA,GAAkB,OAC7B,WAAA,EACA,MACG,KAAA;AACH,EAAA,MAAM,UAAU,MAAO,CAAA,OAAA;AACvB,EAAM,MAAA,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,OAAO,CAAA,EAAG,WAAW,CAAA,CAAA;AACpC,EAAM,MAAA,QAAA,GAAqB,MAAMC,sBAAA,CAAM,GAAK,EAAA;AAAA,IAC1C,MAAQ,EAAA,KAAA;AAAA,IACR,OAAS,EAAA;AAAA,MACP,aAAe,EAAA;AAAA;AACjB,GACD,CAAA;AACD,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAGjD,EAAA,OAAO,SAAS,IAAK,EAAA;AACvB;AAEO,MAAM,sBAAyB,GAAA,OACpC,GACA,EAAA,SAAA,EACA,QACA,SACG,KAAA;AACH,EAAA,MAAM,aAAyB,EAAC;AAChC,EAAA,MAAM,UAAU,MAAO,CAAA,OAAA;AACvB,EAAM,MAAA,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,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;AACnC,MAAA,MAAM,aAAgB,GAAA,MAAA,CAAO,KAAM,CAAA,OAAA,CAAQ,MAAM,GAAG,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;AAAA;AAEpE,MAAA,MAAM,GAAM,GAAA,CAAA,EAAG,OAAO,CAAA,EAAG,YAAY,CAAA,CAAA;AACrC,MAAM,MAAA,GAAA,GAAM,MAAMD,sBAAA,CAAM,GAAK,EAAA;AAAA,QAC3B,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,aAAe,EAAA;AAAA;AACjB,OACD,CAAA;AACD,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA,OAC5C,MAAA,IAAW,GAAI,CAAA,IAAA,KAAS,IAAM,EAAA;AAC5B,QAAGF,mBAAA,CAAA,QAAA,CAAS,GAAG,SAAS,CAAA,CAAA,EAAI,SAAS,CAAY,SAAA,EAAA,aAAa,IAAI,GAAG,CAAA;AACrE,QAAA,MAAM,cAAcA,mBAAG,CAAA,iBAAA;AAAA,UACrB,CAAG,EAAA,SAAS,CAAI,CAAA,EAAA,SAAS,YAAY,aAAa,CAAA;AAAA,SACpD;AACA,QAAI,GAAA,CAAA,IAAA,CAAK,KAAK,WAAW,CAAA;AACzB,QAAA,MAAM,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACrC,UAAY,WAAA,CAAA,EAAA,CAAG,UAAU,MAAM;AAC7B,YAAA,OAAA,CAAQ,GAAG,SAAS,CAAA,CAAA,EAAI,SAAS,CAAA,SAAA,EAAY,aAAa,CAAE,CAAA,CAAA;AAAA,WAC7D,CAAA;AACD,UAAY,WAAA,CAAA,EAAA,CAAG,SAAS,MAAM,CAAA;AAAA,SAC/B,CAAA;AAAA,OACI,MAAA;AACL,QAAA,MAAM,IAAIG,oBAAA;AAAA,UACR;AAAA,SACF;AAAA;AACF,KACD;AAAA,GACH;AACA,EAAO,OAAA,UAAA;AACT;AAEa,MAAA,yBAAA,GAA4B,CAAC,GAAgB,KAAA;AACxD,EAAA,IAAI,QAA+B,GAAA,KAAA,CAAA;AACnC,EAAA,IAAI,KAA4B,GAAA,KAAA,CAAA;AAChC,EAAA,IAAI,eAAsC,GAAA,EAAA;AAC1C,EAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAC1B,EAAA,IAAI,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,SAAW,EAAA;AAE/C,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA,GAC5C,MAAA,IAAW,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,SAAW,EAAA;AAEtD,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA,GAC5C,MAAA,IAAW,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,QAAU,EAAA;AAErD,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA;AAE5C,EAAA,MAAM,IAAIC,iBAAA;AAAA,IACR;AAAA,GACF;AACF;;;;;;;;;"}
1
+ {"version":3,"file":"helpers.cjs.js","sources":["../../../src/actions/confluence/helpers.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 { Readable } from 'stream';\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 type LocalConfluenceConfig = {\n baseUrl: string;\n auth: string;\n token?: string;\n email?: string;\n username?: string;\n password?: string;\n};\n\nexport const getConfluenceConfig = (config: Config) => {\n const confluenceConfig = {\n baseUrl: config.getString('confluence.baseUrl'),\n auth: config.getOptionalString('confluence.auth.type') ?? 'bearer',\n token: config.getOptionalString('confluence.auth.token'),\n email: config.getOptionalString('confluence.auth.email'),\n username: config.getOptionalString('confluence.auth.username'),\n password: config.getOptionalString('confluence.auth.password'),\n };\n\n if (\n (confluenceConfig.auth === 'basic' || confluenceConfig.auth === 'bearer') &&\n !confluenceConfig.token\n ) {\n throw new Error(\n `No token provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n if (confluenceConfig.auth === 'basic' && !confluenceConfig.email) {\n throw new Error(\n `No email provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n if (\n confluenceConfig.auth === 'userpass' &&\n (!confluenceConfig.username || !confluenceConfig.password)\n ) {\n throw new Error(\n `No username/password provided for the configured '${confluenceConfig.auth}' auth method`,\n );\n }\n\n return confluenceConfig;\n};\n\nexport const getAuthorizationHeaderValue = (config: LocalConfluenceConfig) => {\n switch (config.auth) {\n case 'bearer':\n return `Bearer ${config.token}`;\n case 'basic': {\n const buffer = Buffer.from(`${config.email}:${config.token}`, 'utf8');\n return `Basic ${buffer.toString('base64')}`;\n }\n case 'userpass': {\n const buffer = Buffer.from(\n `${config.username}:${config.password}`,\n 'utf8',\n );\n return `Basic ${buffer.toString('base64')}`;\n }\n default:\n throw new Error(`Unknown auth method '${config.auth}' provided`);\n }\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 (\n relativeUrl: string,\n config: LocalConfluenceConfig,\n) => {\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\n const url = `${baseUrl}${relativeUrl}`;\n const response: Response = await fetch(url, {\n method: 'GET',\n headers: {\n Authorization: authHeaderValue,\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: LocalConfluenceConfig,\n mkdocsDir: string,\n) => {\n const productArr: string[][] = [];\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\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 const url = `${baseUrl}${downloadLink}`;\n const res = await fetch(url, {\n method: 'GET',\n headers: {\n Authorization: authHeaderValue,\n },\n });\n if (!res.ok) {\n throw await 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 // TODO(freben): This cast is sketchy, but for some reason the node types don't quite line up here\n // https://stackoverflow.com/questions/44672942/stream-response-to-file-using-fetch-api-and-fs-createwritestream/73879265#73879265\n Readable.fromWeb(res.body as any).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 = (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 // https://confluence.example.com/display/SPACEKEY/Page+Title\n spacekey = params.pathname.split('/')[2];\n title = params.pathname.split('/')[3];\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n } else if (params.pathname.split('/')[2] === 'display') {\n // https://confluence.example.com/prefix/display/SPACEKEY/Page+Title\n spacekey = params.pathname.split('/')[3];\n title = params.pathname.split('/')[4];\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n } else if (params.pathname.split('/')[2] === 'spaces') {\n // https://example.atlassian.net/wiki/spaces/SPACEKEY/pages/1234567/Page+Title\n spacekey = params.pathname.split('/')[3];\n title = params.pathname.split('/')[6];\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>` or `<CONFLUENCE_BASE_URL>/spaces/<SPACEKEY>/pages/<PAGEID>/<PAGE+TITLE>` for Confluence cloud',\n );\n};\n"],"names":["fs","ResponseError","Readable","ConflictError","InputError"],"mappings":";;;;;;;;;;AAsDa,MAAA,mBAAA,GAAsB,CAAC,MAAmB,KAAA;AACrD,EAAA,MAAM,gBAAmB,GAAA;AAAA,IACvB,OAAA,EAAS,MAAO,CAAA,SAAA,CAAU,oBAAoB,CAAA;AAAA,IAC9C,IAAM,EAAA,MAAA,CAAO,iBAAkB,CAAA,sBAAsB,CAAK,IAAA,QAAA;AAAA,IAC1D,KAAA,EAAO,MAAO,CAAA,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,KAAA,EAAO,MAAO,CAAA,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,QAAA,EAAU,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAAA,IAC7D,QAAA,EAAU,MAAO,CAAA,iBAAA,CAAkB,0BAA0B;AAAA,GAC/D;AAEA,EACG,IAAA,CAAA,gBAAA,CAAiB,SAAS,OAAW,IAAA,gBAAA,CAAiB,SAAS,QAChE,KAAA,CAAC,iBAAiB,KAClB,EAAA;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA;AAGF,EAAA,IAAI,gBAAiB,CAAA,IAAA,KAAS,OAAW,IAAA,CAAC,iBAAiB,KAAO,EAAA;AAChE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA;AAGF,EACE,IAAA,gBAAA,CAAiB,SAAS,UACzB,KAAA,CAAC,iBAAiB,QAAY,IAAA,CAAC,iBAAiB,QACjD,CAAA,EAAA;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kDAAA,EAAqD,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAC5E;AAAA;AAGF,EAAO,OAAA,gBAAA;AACT;AAEa,MAAA,2BAAA,GAA8B,CAAC,MAAkC,KAAA;AAC5E,EAAA,QAAQ,OAAO,IAAM;AAAA,IACnB,KAAK,QAAA;AACH,MAAO,OAAA,CAAA,OAAA,EAAU,OAAO,KAAK,CAAA,CAAA;AAAA,IAC/B,KAAK,OAAS,EAAA;AACZ,MAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,KAAK,CAAI,CAAA,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAM,CAAA;AACpE,MAAA,OAAO,CAAS,MAAA,EAAA,MAAA,CAAO,QAAS,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA;AAC3C,IACA,KAAK,UAAY,EAAA;AACf,MAAA,MAAM,SAAS,MAAO,CAAA,IAAA;AAAA,QACpB,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,OAAO,QAAQ,CAAA,CAAA;AAAA,QACrC;AAAA,OACF;AACA,MAAA,OAAO,CAAS,MAAA,EAAA,MAAA,CAAO,QAAS,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA;AAC3C,IACA;AACE,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,MAAA,CAAO,IAAI,CAAY,UAAA,CAAA,CAAA;AAAA;AAErE;AAEa,MAAA,gBAAA,GAAmB,OAAO,OAAoB,KAAA;AACzD,EAAA,MAAM,OAAU,GAAA,MAAMA,mBAAG,CAAA,QAAA,CAAS,SAAS,OAAO,CAAA;AAClD,EAAA,OAAO,QAAQ,QAAS,EAAA;AAC1B;AAEa,MAAA,eAAA,GAAkB,OAC7B,WAAA,EACA,MACG,KAAA;AACH,EAAA,MAAM,UAAU,MAAO,CAAA,OAAA;AACvB,EAAM,MAAA,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,OAAO,CAAA,EAAG,WAAW,CAAA,CAAA;AACpC,EAAM,MAAA,QAAA,GAAqB,MAAM,KAAA,CAAM,GAAK,EAAA;AAAA,IAC1C,MAAQ,EAAA,KAAA;AAAA,IACR,OAAS,EAAA;AAAA,MACP,aAAe,EAAA;AAAA;AACjB,GACD,CAAA;AACD,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AAGjD,EAAA,OAAO,SAAS,IAAK,EAAA;AACvB;AAEO,MAAM,sBAAyB,GAAA,OACpC,GACA,EAAA,SAAA,EACA,QACA,SACG,KAAA;AACH,EAAA,MAAM,aAAyB,EAAC;AAChC,EAAA,MAAM,UAAU,MAAO,CAAA,OAAA;AACvB,EAAM,MAAA,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,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;AACnC,MAAA,MAAM,aAAgB,GAAA,MAAA,CAAO,KAAM,CAAA,OAAA,CAAQ,MAAM,GAAG,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;AAAA;AAEpE,MAAA,MAAM,GAAM,GAAA,CAAA,EAAG,OAAO,CAAA,EAAG,YAAY,CAAA,CAAA;AACrC,MAAM,MAAA,GAAA,GAAM,MAAM,KAAA,CAAM,GAAK,EAAA;AAAA,QAC3B,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,aAAe,EAAA;AAAA;AACjB,OACD,CAAA;AACD,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA,OAC5C,MAAA,IAAW,GAAI,CAAA,IAAA,KAAS,IAAM,EAAA;AAC5B,QAAGD,mBAAA,CAAA,QAAA,CAAS,GAAG,SAAS,CAAA,CAAA,EAAI,SAAS,CAAY,SAAA,EAAA,aAAa,IAAI,GAAG,CAAA;AACrE,QAAA,MAAM,cAAcA,mBAAG,CAAA,iBAAA;AAAA,UACrB,CAAG,EAAA,SAAS,CAAI,CAAA,EAAA,SAAS,YAAY,aAAa,CAAA;AAAA,SACpD;AAGA,QAAAE,eAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,IAAW,CAAA,CAAE,KAAK,WAAW,CAAA;AAClD,QAAA,MAAM,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACrC,UAAY,WAAA,CAAA,EAAA,CAAG,UAAU,MAAM;AAC7B,YAAA,OAAA,CAAQ,GAAG,SAAS,CAAA,CAAA,EAAI,SAAS,CAAA,SAAA,EAAY,aAAa,CAAE,CAAA,CAAA;AAAA,WAC7D,CAAA;AACD,UAAY,WAAA,CAAA,EAAA,CAAG,SAAS,MAAM,CAAA;AAAA,SAC/B,CAAA;AAAA,OACI,MAAA;AACL,QAAA,MAAM,IAAIC,oBAAA;AAAA,UACR;AAAA,SACF;AAAA;AACF,KACD;AAAA,GACH;AACA,EAAO,OAAA,UAAA;AACT;AAEa,MAAA,yBAAA,GAA4B,CAAC,GAAgB,KAAA;AACxD,EAAA,IAAI,QAA+B,GAAA,KAAA,CAAA;AACnC,EAAA,IAAI,KAA4B,GAAA,KAAA,CAAA;AAChC,EAAA,IAAI,eAAsC,GAAA,EAAA;AAC1C,EAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAC1B,EAAA,IAAI,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,SAAW,EAAA;AAE/C,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA,GAC5C,MAAA,IAAW,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,SAAW,EAAA;AAEtD,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA,GAC5C,MAAA,IAAW,OAAO,QAAS,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,CAAC,MAAM,QAAU,EAAA;AAErD,IAAA,QAAA,GAAW,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACvC,IAAA,KAAA,GAAQ,MAAO,CAAA,QAAA,CAAS,KAAM,CAAA,GAAG,EAAE,CAAC,CAAA;AACpC,IAAkB,eAAA,GAAA,KAAA,EAAO,OAAQ,CAAA,KAAA,EAAO,GAAG,CAAA;AAC3C,IAAO,OAAA,EAAE,QAAU,EAAA,KAAA,EAAO,eAAgB,EAAA;AAAA;AAE5C,EAAA,MAAM,IAAIC,iBAAA;AAAA,IACR;AAAA,GACF;AACF;;;;;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-confluence-to-markdown",
3
- "version": "0.3.3",
3
+ "version": "0.3.4-next.2",
4
4
  "description": "The confluence-to-markdown module for @backstage/plugin-scaffolder-backend",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -51,21 +51,20 @@
51
51
  },
52
52
  "dependencies": {
53
53
  "@backstage/backend-common": "^0.25.0",
54
- "@backstage/backend-plugin-api": "^1.0.2",
55
- "@backstage/config": "^1.3.0",
56
- "@backstage/errors": "^1.2.5",
57
- "@backstage/integration": "^1.15.2",
58
- "@backstage/plugin-scaffolder-node": "^0.6.1",
54
+ "@backstage/backend-plugin-api": "1.1.0-next.2",
55
+ "@backstage/config": "1.3.1-next.0",
56
+ "@backstage/errors": "1.2.6-next.0",
57
+ "@backstage/integration": "1.16.0-next.1",
58
+ "@backstage/plugin-scaffolder-node": "0.6.2-next.2",
59
59
  "fs-extra": "^11.2.0",
60
60
  "git-url-parse": "^15.0.0",
61
- "node-fetch": "^2.7.0",
62
61
  "node-html-markdown": "^1.3.0",
63
62
  "yaml": "^2.0.0"
64
63
  },
65
64
  "devDependencies": {
66
- "@backstage/backend-test-utils": "^1.1.0",
67
- "@backstage/cli": "^0.29.2",
68
- "@backstage/plugin-scaffolder-node-test-utils": "^0.1.16",
65
+ "@backstage/backend-test-utils": "1.2.0-next.2",
66
+ "@backstage/cli": "0.29.3-next.2",
67
+ "@backstage/plugin-scaffolder-node-test-utils": "0.1.17-next.2",
69
68
  "msw": "^1.0.0"
70
69
  },
71
70
  "configSchema": "config.d.ts"