@backstage/plugin-scaffolder-backend-module-confluence-to-markdown 0.3.28-next.1 → 0.3.28

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-confluence-to-markdown
2
2
 
3
+ ## 0.3.28
4
+
5
+ ### Patch Changes
6
+
7
+ - 076f478: Fixed the Confluence to Markdown action leaking a file handle for every attachment it downloaded. A download that failed partway through also left the scaffolder step hanging. It now fails with the underlying error.
8
+ - Updated dependencies
9
+ - @backstage/integration@2.2.0
10
+ - @backstage/backend-plugin-api@1.12.0
11
+ - @backstage/errors@1.4.0
12
+ - @backstage/config@1.3.11
13
+ - @backstage/plugin-scaffolder-node@1.0.0
14
+
3
15
  ## 0.3.28-next.1
4
16
 
5
17
  ### Patch Changes
@@ -4,6 +4,7 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
4
4
  var errors = require('@backstage/errors');
5
5
  var fs = require('fs-extra');
6
6
  var node_stream = require('node:stream');
7
+ var promises = require('node:stream/promises');
7
8
 
8
9
  function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
9
10
 
@@ -99,15 +100,10 @@ const getAndWriteAttachments = async (arr, docsDir, config) => {
99
100
  attachmentDir,
100
101
  downloadTitle
101
102
  );
102
- fs__default.default.openSync(attachmentPath, "w");
103
- const writeStream = fs__default.default.createWriteStream(attachmentPath);
104
- node_stream.Readable.fromWeb(res.body).pipe(writeStream);
105
- await new Promise((resolve, reject) => {
106
- writeStream.on("finish", () => {
107
- resolve(attachmentPath);
108
- });
109
- writeStream.on("error", reject);
110
- });
103
+ await promises.pipeline(
104
+ node_stream.Readable.fromWeb(res.body),
105
+ fs__default.default.createWriteStream(attachmentPath)
106
+ );
111
107
  } else {
112
108
  throw new errors.ConflictError(
113
109
  "No Body on the response. Can not save images from Confluence Doc"
@@ -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 { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { ResponseError, ConflictError } from '@backstage/errors';\nimport fs from 'fs-extra';\nimport { Readable } from 'node: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 docsDir: string,\n config: LocalConfluenceConfig,\n) => {\n const productArr: string[][] = [];\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\n const attachmentDir = resolveSafeChildPath(docsDir, 'img');\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 const attachmentPath = resolveSafeChildPath(\n attachmentDir,\n downloadTitle,\n );\n fs.openSync(attachmentPath, 'w');\n const writeStream = fs.createWriteStream(attachmentPath);\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(attachmentPath);\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 const pathParts = params.pathname.split('/').filter(Boolean);\n\n if (pathParts.includes('display')) {\n // /display/<SPACEKEY>/<TITLE>\n const idx = pathParts.indexOf('display');\n spacekey = pathParts[idx + 1];\n title = pathParts[idx + 2];\n } else if (pathParts.includes('spaces')) {\n // /spaces/<SPACEKEY>/pages/<PAGEID>/<TITLE>\n const idx = pathParts.indexOf('spaces');\n spacekey = pathParts[idx + 1];\n title = pathParts[pathParts.length - 1];\n } else {\n throw new Error(\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>`',\n );\n }\n\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n};\n"],"names":["fs","ResponseError","resolveSafeChildPath","Readable","ConflictError"],"mappings":";;;;;;;;;;;AAuDO,MAAM,mBAAA,GAAsB,CAAC,MAAA,KAAmB;AACrD,EAAA,MAAM,gBAAA,GAAmB;AAAA,IACvB,OAAA,EAAS,MAAA,CAAO,SAAA,CAAU,oBAAoB,CAAA;AAAA,IAC9C,IAAA,EAAM,MAAA,CAAO,iBAAA,CAAkB,sBAAsB,CAAA,IAAK,QAAA;AAAA,IAC1D,KAAA,EAAO,MAAA,CAAO,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,KAAA,EAAO,MAAA,CAAO,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,QAAA,EAAU,MAAA,CAAO,iBAAA,CAAkB,0BAA0B,CAAA;AAAA,IAC7D,QAAA,EAAU,MAAA,CAAO,iBAAA,CAAkB,0BAA0B;AAAA,GAC/D;AAEA,EAAA,IAAA,CACG,gBAAA,CAAiB,SAAS,OAAA,IAAW,gBAAA,CAAiB,SAAS,QAAA,KAChE,CAAC,iBAAiB,KAAA,EAClB;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,IAAI,gBAAA,CAAiB,IAAA,KAAS,OAAA,IAAW,CAAC,iBAAiB,KAAA,EAAO;AAChE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,IACE,gBAAA,CAAiB,SAAS,UAAA,KACzB,CAAC,iBAAiB,QAAA,IAAY,CAAC,iBAAiB,QAAA,CAAA,EACjD;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kDAAA,EAAqD,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAC5E;AAAA,EACF;AAEA,EAAA,OAAO,gBAAA;AACT;AAEO,MAAM,2BAAA,GAA8B,CAAC,MAAA,KAAkC;AAC5E,EAAA,QAAQ,OAAO,IAAA;AAAM,IACnB,KAAK,QAAA;AACH,MAAA,OAAO,CAAA,OAAA,EAAU,OAAO,KAAK,CAAA,CAAA;AAAA,IAC/B,KAAK,OAAA,EAAS;AACZ,MAAA,MAAM,MAAA,GAAS,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAM,CAAA;AACpE,MAAA,OAAO,CAAA,MAAA,EAAS,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,IAC3C;AAAA,IACA,KAAK,UAAA,EAAY;AACf,MAAA,MAAM,SAAS,MAAA,CAAO,IAAA;AAAA,QACpB,CAAA,EAAG,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,OAAO,QAAQ,CAAA,CAAA;AAAA,QACrC;AAAA,OACF;AACA,MAAA,OAAO,CAAA,MAAA,EAAS,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,IAC3C;AAAA,IACA;AACE,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,MAAA,CAAO,IAAI,CAAA,UAAA,CAAY,CAAA;AAAA;AAErE;AAEO,MAAM,gBAAA,GAAmB,OAAO,OAAA,KAAoB;AACzD,EAAA,MAAM,OAAA,GAAU,MAAMA,mBAAA,CAAG,QAAA,CAAS,SAAS,OAAO,CAAA;AAClD,EAAA,OAAO,QAAQ,QAAA,EAAS;AAC1B;AAEO,MAAM,eAAA,GAAkB,OAC7B,WAAA,EACA,MAAA,KACG;AACH,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA;AACvB,EAAA,MAAM,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,GAAA,GAAM,CAAA,EAAG,OAAO,CAAA,EAAG,WAAW,CAAA,CAAA;AACpC,EAAA,MAAM,QAAA,GAAqB,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,IAC1C,MAAA,EAAQ,KAAA;AAAA,IACR,OAAA,EAAS;AAAA,MACP,aAAA,EAAe;AAAA;AACjB,GACD,CAAA;AACD,EAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,IAAA,MAAM,MAAMC,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,EACjD;AAEA,EAAA,OAAO,SAAS,IAAA,EAAK;AACvB;AAEO,MAAM,sBAAA,GAAyB,OACpC,GAAA,EACA,OAAA,EACA,MAAA,KACG;AACH,EAAA,MAAM,aAAyB,EAAC;AAChC,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA;AACvB,EAAA,MAAM,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,aAAA,GAAgBC,qCAAA,CAAqB,OAAA,EAAS,KAAK,CAAA;AACzD,EAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,IACZ,MAAM,GAAA,CAAI,OAAA,CAAQ,GAAA,CAAI,OAAO,MAAA,KAAmB;AAC9C,MAAA,MAAM,YAAA,GAAe,OAAO,MAAA,CAAO,QAAA;AACnC,MAAA,MAAM,aAAA,GAAgB,MAAA,CAAO,KAAA,CAAM,OAAA,CAAQ,MAAM,GAAG,CAAA;AACpD,MAAA,IAAI,MAAA,CAAO,QAAA,CAAS,SAAA,KAAc,yBAAA,EAA2B;AAC3D,QAAA,UAAA,CAAW,IAAA,CAAK,CAAC,MAAA,CAAO,KAAA,CAAM,QAAQ,IAAA,EAAM,KAAK,CAAA,EAAG,aAAa,CAAC,CAAA;AAAA,MACpE;AACA,MAAA,MAAM,GAAA,GAAM,CAAA,EAAG,OAAO,CAAA,EAAG,YAAY,CAAA,CAAA;AACrC,MAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,QAC3B,MAAA,EAAQ,KAAA;AAAA,QACR,OAAA,EAAS;AAAA,UACP,aAAA,EAAe;AAAA;AACjB,OACD,CAAA;AACD,MAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,QAAA,MAAM,MAAMD,oBAAA,CAAc,YAAA,CAAa,GAAG,CAAA;AAAA,MAC5C,CAAA,MAAA,IAAW,GAAA,CAAI,IAAA,KAAS,IAAA,EAAM;AAC5B,QAAA,MAAM,cAAA,GAAiBC,qCAAA;AAAA,UACrB,aAAA;AAAA,UACA;AAAA,SACF;AACA,QAAAF,mBAAA,CAAG,QAAA,CAAS,gBAAgB,GAAG,CAAA;AAC/B,QAAA,MAAM,WAAA,GAAcA,mBAAA,CAAG,iBAAA,CAAkB,cAAc,CAAA;AAGvD,QAAAG,oBAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,IAAW,CAAA,CAAE,KAAK,WAAW,CAAA;AAClD,QAAA,MAAM,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAA,KAAW;AACrC,UAAA,WAAA,CAAY,EAAA,CAAG,UAAU,MAAM;AAC7B,YAAA,OAAA,CAAQ,cAAc,CAAA;AAAA,UACxB,CAAC,CAAA;AACD,UAAA,WAAA,CAAY,EAAA,CAAG,SAAS,MAAM,CAAA;AAAA,QAChC,CAAC,CAAA;AAAA,MACH,CAAA,MAAO;AACL,QAAA,MAAM,IAAIC,oBAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,GACH;AACA,EAAA,OAAO,UAAA;AACT;AAEO,MAAM,yBAAA,GAA4B,CAAC,GAAA,KAAgB;AACxD,EAAA,IAAI,QAAA,GAA+B,MAAA;AACnC,EAAA,IAAI,KAAA,GAA4B,MAAA;AAChC,EAAA,IAAI,eAAA,GAAsC,EAAA;AAC1C,EAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAC1B,EAAA,MAAM,YAAY,MAAA,CAAO,QAAA,CAAS,MAAM,GAAG,CAAA,CAAE,OAAO,OAAO,CAAA;AAE3D,EAAA,IAAI,SAAA,CAAU,QAAA,CAAS,SAAS,CAAA,EAAG;AAEjC,IAAA,MAAM,GAAA,GAAM,SAAA,CAAU,OAAA,CAAQ,SAAS,CAAA;AACvC,IAAA,QAAA,GAAW,SAAA,CAAU,MAAM,CAAC,CAAA;AAC5B,IAAA,KAAA,GAAQ,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,EAC3B,CAAA,MAAA,IAAW,SAAA,CAAU,QAAA,CAAS,QAAQ,CAAA,EAAG;AAEvC,IAAA,MAAM,GAAA,GAAM,SAAA,CAAU,OAAA,CAAQ,QAAQ,CAAA;AACtC,IAAA,QAAA,GAAW,SAAA,CAAU,MAAM,CAAC,CAAA;AAC5B,IAAA,KAAA,GAAQ,SAAA,CAAU,SAAA,CAAU,MAAA,GAAS,CAAC,CAAA;AAAA,EACxC,CAAA,MAAO;AACL,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,eAAA,GAAkB,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAO,GAAG,CAAA;AAC3C,EAAA,OAAO,EAAE,QAAA,EAAU,KAAA,EAAO,eAAA,EAAgB;AAC5C;;;;;;;"}
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 { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { ResponseError, ConflictError } from '@backstage/errors';\nimport fs from 'fs-extra';\nimport { Readable } from 'node:stream';\nimport { pipeline } from 'node:stream/promises';\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 docsDir: string,\n config: LocalConfluenceConfig,\n) => {\n const productArr: string[][] = [];\n const baseUrl = config.baseUrl;\n const authHeaderValue = getAuthorizationHeaderValue(config);\n const attachmentDir = resolveSafeChildPath(docsDir, 'img');\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 const attachmentPath = resolveSafeChildPath(\n attachmentDir,\n 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 await pipeline(\n Readable.fromWeb(res.body as any),\n fs.createWriteStream(attachmentPath),\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 const pathParts = params.pathname.split('/').filter(Boolean);\n\n if (pathParts.includes('display')) {\n // /display/<SPACEKEY>/<TITLE>\n const idx = pathParts.indexOf('display');\n spacekey = pathParts[idx + 1];\n title = pathParts[idx + 2];\n } else if (pathParts.includes('spaces')) {\n // /spaces/<SPACEKEY>/pages/<PAGEID>/<TITLE>\n const idx = pathParts.indexOf('spaces');\n spacekey = pathParts[idx + 1];\n title = pathParts[pathParts.length - 1];\n } else {\n throw new Error(\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>`',\n );\n }\n\n titleWithSpaces = title?.replace(/\\+/g, ' ');\n return { spacekey, title, titleWithSpaces };\n};\n"],"names":["fs","ResponseError","resolveSafeChildPath","pipeline","Readable","ConflictError"],"mappings":";;;;;;;;;;;;AAwDO,MAAM,mBAAA,GAAsB,CAAC,MAAA,KAAmB;AACrD,EAAA,MAAM,gBAAA,GAAmB;AAAA,IACvB,OAAA,EAAS,MAAA,CAAO,SAAA,CAAU,oBAAoB,CAAA;AAAA,IAC9C,IAAA,EAAM,MAAA,CAAO,iBAAA,CAAkB,sBAAsB,CAAA,IAAK,QAAA;AAAA,IAC1D,KAAA,EAAO,MAAA,CAAO,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,KAAA,EAAO,MAAA,CAAO,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,IACvD,QAAA,EAAU,MAAA,CAAO,iBAAA,CAAkB,0BAA0B,CAAA;AAAA,IAC7D,QAAA,EAAU,MAAA,CAAO,iBAAA,CAAkB,0BAA0B;AAAA,GAC/D;AAEA,EAAA,IAAA,CACG,gBAAA,CAAiB,SAAS,OAAA,IAAW,gBAAA,CAAiB,SAAS,QAAA,KAChE,CAAC,iBAAiB,KAAA,EAClB;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,IAAI,gBAAA,CAAiB,IAAA,KAAS,OAAA,IAAW,CAAC,iBAAiB,KAAA,EAAO;AAChE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,sCAAA,EAAyC,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,IACE,gBAAA,CAAiB,SAAS,UAAA,KACzB,CAAC,iBAAiB,QAAA,IAAY,CAAC,iBAAiB,QAAA,CAAA,EACjD;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kDAAA,EAAqD,iBAAiB,IAAI,CAAA,aAAA;AAAA,KAC5E;AAAA,EACF;AAEA,EAAA,OAAO,gBAAA;AACT;AAEO,MAAM,2BAAA,GAA8B,CAAC,MAAA,KAAkC;AAC5E,EAAA,QAAQ,OAAO,IAAA;AAAM,IACnB,KAAK,QAAA;AACH,MAAA,OAAO,CAAA,OAAA,EAAU,OAAO,KAAK,CAAA,CAAA;AAAA,IAC/B,KAAK,OAAA,EAAS;AACZ,MAAA,MAAM,MAAA,GAAS,MAAA,CAAO,IAAA,CAAK,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,MAAM,CAAA;AACpE,MAAA,OAAO,CAAA,MAAA,EAAS,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,IAC3C;AAAA,IACA,KAAK,UAAA,EAAY;AACf,MAAA,MAAM,SAAS,MAAA,CAAO,IAAA;AAAA,QACpB,CAAA,EAAG,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,OAAO,QAAQ,CAAA,CAAA;AAAA,QACrC;AAAA,OACF;AACA,MAAA,OAAO,CAAA,MAAA,EAAS,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,IAC3C;AAAA,IACA;AACE,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,MAAA,CAAO,IAAI,CAAA,UAAA,CAAY,CAAA;AAAA;AAErE;AAEO,MAAM,gBAAA,GAAmB,OAAO,OAAA,KAAoB;AACzD,EAAA,MAAM,OAAA,GAAU,MAAMA,mBAAA,CAAG,QAAA,CAAS,SAAS,OAAO,CAAA;AAClD,EAAA,OAAO,QAAQ,QAAA,EAAS;AAC1B;AAEO,MAAM,eAAA,GAAkB,OAC7B,WAAA,EACA,MAAA,KACG;AACH,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA;AACvB,EAAA,MAAM,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,GAAA,GAAM,CAAA,EAAG,OAAO,CAAA,EAAG,WAAW,CAAA,CAAA;AACpC,EAAA,MAAM,QAAA,GAAqB,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,IAC1C,MAAA,EAAQ,KAAA;AAAA,IACR,OAAA,EAAS;AAAA,MACP,aAAA,EAAe;AAAA;AACjB,GACD,CAAA;AACD,EAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,IAAA,MAAM,MAAMC,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,EACjD;AAEA,EAAA,OAAO,SAAS,IAAA,EAAK;AACvB;AAEO,MAAM,sBAAA,GAAyB,OACpC,GAAA,EACA,OAAA,EACA,MAAA,KACG;AACH,EAAA,MAAM,aAAyB,EAAC;AAChC,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA;AACvB,EAAA,MAAM,eAAA,GAAkB,4BAA4B,MAAM,CAAA;AAC1D,EAAA,MAAM,aAAA,GAAgBC,qCAAA,CAAqB,OAAA,EAAS,KAAK,CAAA;AACzD,EAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,IACZ,MAAM,GAAA,CAAI,OAAA,CAAQ,GAAA,CAAI,OAAO,MAAA,KAAmB;AAC9C,MAAA,MAAM,YAAA,GAAe,OAAO,MAAA,CAAO,QAAA;AACnC,MAAA,MAAM,aAAA,GAAgB,MAAA,CAAO,KAAA,CAAM,OAAA,CAAQ,MAAM,GAAG,CAAA;AACpD,MAAA,IAAI,MAAA,CAAO,QAAA,CAAS,SAAA,KAAc,yBAAA,EAA2B;AAC3D,QAAA,UAAA,CAAW,IAAA,CAAK,CAAC,MAAA,CAAO,KAAA,CAAM,QAAQ,IAAA,EAAM,KAAK,CAAA,EAAG,aAAa,CAAC,CAAA;AAAA,MACpE;AACA,MAAA,MAAM,GAAA,GAAM,CAAA,EAAG,OAAO,CAAA,EAAG,YAAY,CAAA,CAAA;AACrC,MAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,QAC3B,MAAA,EAAQ,KAAA;AAAA,QACR,OAAA,EAAS;AAAA,UACP,aAAA,EAAe;AAAA;AACjB,OACD,CAAA;AACD,MAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACX,QAAA,MAAM,MAAMD,oBAAA,CAAc,YAAA,CAAa,GAAG,CAAA;AAAA,MAC5C,CAAA,MAAA,IAAW,GAAA,CAAI,IAAA,KAAS,IAAA,EAAM;AAC5B,QAAA,MAAM,cAAA,GAAiBC,qCAAA;AAAA,UACrB,aAAA;AAAA,UACA;AAAA,SACF;AAGA,QAAA,MAAMC,iBAAA;AAAA,UACJC,oBAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,IAAW,CAAA;AAAA,UAChCJ,mBAAA,CAAG,kBAAkB,cAAc;AAAA,SACrC;AAAA,MACF,CAAA,MAAO;AACL,QAAA,MAAM,IAAIK,oBAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,GACH;AACA,EAAA,OAAO,UAAA;AACT;AAEO,MAAM,yBAAA,GAA4B,CAAC,GAAA,KAAgB;AACxD,EAAA,IAAI,QAAA,GAA+B,MAAA;AACnC,EAAA,IAAI,KAAA,GAA4B,MAAA;AAChC,EAAA,IAAI,eAAA,GAAsC,EAAA;AAC1C,EAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAC1B,EAAA,MAAM,YAAY,MAAA,CAAO,QAAA,CAAS,MAAM,GAAG,CAAA,CAAE,OAAO,OAAO,CAAA;AAE3D,EAAA,IAAI,SAAA,CAAU,QAAA,CAAS,SAAS,CAAA,EAAG;AAEjC,IAAA,MAAM,GAAA,GAAM,SAAA,CAAU,OAAA,CAAQ,SAAS,CAAA;AACvC,IAAA,QAAA,GAAW,SAAA,CAAU,MAAM,CAAC,CAAA;AAC5B,IAAA,KAAA,GAAQ,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,EAC3B,CAAA,MAAA,IAAW,SAAA,CAAU,QAAA,CAAS,QAAQ,CAAA,EAAG;AAEvC,IAAA,MAAM,GAAA,GAAM,SAAA,CAAU,OAAA,CAAQ,QAAQ,CAAA;AACtC,IAAA,QAAA,GAAW,SAAA,CAAU,MAAM,CAAC,CAAA;AAC5B,IAAA,KAAA,GAAQ,SAAA,CAAU,SAAA,CAAU,MAAA,GAAS,CAAC,CAAA;AAAA,EACxC,CAAA,MAAO;AACL,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,eAAA,GAAkB,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAO,GAAG,CAAA;AAC3C,EAAA,OAAO,EAAE,QAAA,EAAU,KAAA,EAAO,eAAA,EAAgB;AAC5C;;;;;;;"}
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.28-next.1",
3
+ "version": "0.3.28",
4
4
  "description": "The confluence-to-markdown module for @backstage/plugin-scaffolder-backend",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -53,21 +53,21 @@
53
53
  "test": "backstage-cli package test"
54
54
  },
55
55
  "dependencies": {
56
- "@backstage/backend-plugin-api": "1.12.0-next.1",
57
- "@backstage/config": "1.3.11-next.0",
58
- "@backstage/errors": "1.4.0-next.0",
59
- "@backstage/integration": "2.1.4-next.0",
60
- "@backstage/plugin-scaffolder-node": "1.0.0-next.2",
56
+ "@backstage/backend-plugin-api": "^1.12.0",
57
+ "@backstage/config": "^1.3.11",
58
+ "@backstage/errors": "^1.4.0",
59
+ "@backstage/integration": "^2.2.0",
60
+ "@backstage/plugin-scaffolder-node": "^1.0.0",
61
61
  "fs-extra": "^11.2.0",
62
62
  "git-url-parse": "^15.0.0",
63
63
  "node-html-markdown": "^1.3.0",
64
64
  "yaml": "^2.0.0"
65
65
  },
66
66
  "devDependencies": {
67
- "@backstage/backend-test-utils": "1.12.0-next.2",
68
- "@backstage/cli": "0.36.8-next.2",
69
- "@backstage/plugin-scaffolder-node-test-utils": "0.3.17-next.1",
70
- "msw": "^2.0.0"
67
+ "@backstage/backend-test-utils": "^1.12.0",
68
+ "@backstage/cli": "^0.36.8",
69
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.3.17",
70
+ "msw": "^3.0.4"
71
71
  },
72
72
  "configSchema": "config.schema.json"
73
73
  }