@techdocs/cli 1.9.6-next.0 → 1.9.7

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @techdocs/cli
 
+## 1.9.7
+
+### Patch Changes
+
+- 15da5af: Fixed an issue where `@techdocs/cli serve` command did not pick up the latest changes to TechDocs.
+
+## 1.9.6
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.12.0
+  - @backstage/plugin-techdocs-node@1.13.6
+
 ## 1.9.6-next.0
 
 ### Patch Changes

package/dist/commands/generate/generate.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport {\n  TechdocsGenerator,\n  ParsedLocationAnnotation,\n  getMkdocsYml,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n  getLogStream,\n} from '../../lib/utility';\n\nexport default async function generate(opts: OptionValues) {\n  // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const sourceDir = resolve(opts.sourceDir);\n  const outputDir = resolve(opts.outputDir);\n  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n  const dockerImage = opts.dockerImage;\n  const pullImage = opts.pull;\n  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n  const defaultPlugins = opts.defaultPlugin;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    sourceDir,\n  );\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        mkdocs: {\n          legacyCopyReadmeMdToIndexMd,\n          omitTechdocsCorePlugin,\n          defaultPlugins,\n        },\n      },\n    },\n  });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (opts.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        opts.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  // Generate docs using @backstage/plugin-techdocs-node\n  const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n    logger,\n  });\n\n  logger.info('Generating documentation...');\n\n  await techdocsGenerator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag: opts.etag,\n    logStream: getLogStream(logger),\n    siteOptions: { name: opts.siteName },\n    runAsDefaultUser: opts.runAsDefaultUser,\n  });\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","getLogStream"],"mappings":";;;;;;;;;;;;;;AA+BA,eAA8B,SAAS,IAAoB,EAAA;AAKzD,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA;AAErD,EAAM,MAAA,SAAA,GAAYC,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA;AACxC,EAAM,MAAA,SAAA,GAAYA,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAK,CAAA,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAK,CAAA,WAAA;AACzB,EAAA,MAAM,YAAY,IAAK,CAAA,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAK,CAAA,2BAAA;AACzC,EAAA,MAAM,iBAAiB,IAAK,CAAA,aAAA;AAE5B,EAAO,MAAA,CAAA,IAAA,CAAK,CAAoB,iBAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAC3C,EAAO,MAAA,CAAA,IAAA,CAAK,CAAkC,+BAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAM,MAAAC,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAM,MAAAC,QAAA,GAAS,IAAIC,mBAAa,CAAA;AAAA,IAC9B,QAAU,EAAA;AAAA,MACR,SAAW,EAAA;AAAA,QACT,KAAA,EAAO,IAAK,CAAA,MAAA,GAAS,QAAW,GAAA,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAQ,EAAA;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAa,EAAA;AACpB,IAAI,IAAA;AACF,MAA2B,wBAAA,GAAAC,8CAAA;AAAA,QACzB,IAAK,CAAA;AAAA,OACP;AAAA,aACO,GAAK,EAAA;AACZ,MAAO,MAAA,CAAA,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA;AAC1B;AAIF,EAAA,MAAM,iBAAoB,GAAA,MAAMC,oCAAkB,CAAA,UAAA,CAAWH,QAAQ,EAAA;AAAA,IACnE;AAAA,GACD,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAI,CAAA;AAAA,IAC1B,QAAU,EAAA,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WACL,GAAA;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,IACA,MAAM,IAAK,CAAA,IAAA;AAAA,IACX,SAAA,EAAWI,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAa,EAAA,EAAE,IAAM,EAAA,IAAA,CAAK,QAAS,EAAA;AAAA,IACnC,kBAAkB,IAAK,CAAA;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGN,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA;AAAA,KAC5B,CAAA;AAAA;AAGH,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;;;"}
+{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport {\n  TechdocsGenerator,\n  ParsedLocationAnnotation,\n  getMkdocsYml,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n  getLogStream,\n} from '../../lib/utility';\n\nexport default async function generate(opts: OptionValues) {\n  // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const sourceDir = resolve(opts.sourceDir);\n  const outputDir = resolve(opts.outputDir);\n  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n  const dockerImage = opts.dockerImage;\n  const pullImage = opts.pull;\n  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n  const defaultPlugins = opts.defaultPlugin;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    sourceDir,\n  );\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        mkdocs: {\n          legacyCopyReadmeMdToIndexMd,\n          omitTechdocsCorePlugin,\n          defaultPlugins,\n        },\n      },\n    },\n  });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (opts.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        opts.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  // Generate docs using @backstage/plugin-techdocs-node\n  const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n    logger,\n  });\n\n  logger.info('Generating documentation...');\n\n  await techdocsGenerator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag: opts.etag,\n    logStream: getLogStream(logger),\n    siteOptions: { name: opts.siteName },\n    runAsDefaultUser: opts.runAsDefaultUser,\n  });\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","getLogStream"],"mappings":";;;;;;;;;;;;;;AA+BA,eAA8B,SAAS,IAAA,EAAoB;AAKzD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,SAAA,GAAYC,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,GAAYA,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAA,CAAK,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAA,CAAK,WAAA;AACzB,EAAA,MAAM,YAAY,IAAA,CAAK,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAA,CAAK,2BAAA;AACzC,EAAA,MAAM,iBAAiB,IAAA,CAAK,aAAA;AAE5B,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,SAAS,CAAA,CAAE,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,+BAAA,EAAkC,SAAS,CAAA,CAAE,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAA,MAAMC,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAA,MAAMC,QAAA,GAAS,IAAIC,mBAAA,CAAa;AAAA,IAC9B,QAAA,EAAU;AAAA,MACR,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,IAAA,CAAK,MAAA,GAAS,QAAA,GAAW,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAA,EAAa;AACpB,IAAA,IAAI;AACF,MAAA,wBAAA,GAA2BC,8CAAA;AAAA,QACzB,IAAA,CAAK;AAAA,OACP;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAA,CAAO,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA,IAC1B;AAAA,EACF;AAGA,EAAA,MAAM,iBAAA,GAAoB,MAAMC,oCAAA,CAAkB,UAAA,CAAWH,QAAA,EAAQ;AAAA,IACnE;AAAA,GACD,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAA,CAAI;AAAA,IAC1B,QAAA,EAAU,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WAAA,GACL;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,IACA,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,SAAA,EAAWI,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAA,EAAa,EAAE,IAAA,EAAM,IAAA,CAAK,QAAA,EAAS;AAAA,IACnC,kBAAkB,IAAA,CAAK;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAN,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;;;"}

package/dist/commands/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Command } from 'commander';\nimport { TechdocsGenerator } from '@backstage/plugin-techdocs-node';\n\nconst defaultDockerImage = TechdocsGenerator.defaultDockerImage;\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n  program\n    .command('generate')\n    .description('Generate TechDocs documentation site using MkDocs.')\n    .option(\n      '--source-dir <PATH>',\n      'Source directory containing mkdocs.yml and docs/ directory.',\n      '.',\n    )\n    .option(\n      '--output-dir <PATH>',\n      'Output directory containing generated TechDocs site.',\n      './site/',\n    )\n    .option(\n      '--docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option('--no-pull', 'Do not pull the latest docker image')\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable and plugins in current user environment.',\n    )\n    .option(\n      '--techdocs-ref <HOST_TYPE:URL>',\n      'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n        '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n        '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n    )\n    .option(\n      '--etag <ETAG>',\n      'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .option(\n      '--omitTechdocsCoreMkdocsPlugin',\n      \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n      false,\n    )\n    .option(\n      '--legacyCopyReadmeMdToIndexMd',\n      'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n      false,\n    )\n    .option(\n      '--defaultPlugin [defaultPlugins...]',\n      'Plugins which should be added automatically to the mkdocs.yaml file',\n      [],\n    )\n    .option(\n      '--runAsDefaultUser',\n      'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n      false,\n    )\n    .alias('build')\n    .action(lazy(() => import('./generate/generate'), 'default'));\n\n  program\n    .command('migrate')\n    .description(\n      'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--removeOriginal',\n      'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n      false,\n    )\n    .option(\n      '--concurrency <MAX CONCURRENT REQS>',\n      'Optional Controls the number of API requests allowed to be performed simultaneously.',\n      '25',\n    )\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./migrate/migrate'), 'default'));\n\n  program\n    .command('publish')\n    .description(\n      'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .requiredOption(\n      '--entity <NAMESPACE/KIND/NAME>',\n      '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n    )\n    .option(\n      '--legacyUseCaseSensitiveTripletPaths',\n      'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n      false,\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsProxy <HTTPS Proxy>',\n      'Optional Proxy to use for AWS requests.',\n    )\n    .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Amazon S3',\n    )\n    .option(\n      '--awsMaxAttempts <AWS MAX ATTEMPTS>',\n      'Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Google cloud storage',\n    )\n    .option(\n      '--directory <PATH>',\n      'Path of the directory containing generated files to publish',\n      './site/',\n    )\n    .action(lazy(() => import('./publish/publish'), 'default'));\n\n  program\n    .command('serve:mkdocs')\n    .description('Serve a documentation project locally using MkDocs serve.')\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run `mkdocs serve` in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/mkdocs'), 'default'));\n\n  program\n    .command('serve')\n    .description(\n      'Serve a documentation project locally in a Backstage app-like environment',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .option(\n      '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n      'Preview documentation using another web app',\n    )\n    .option(\n      '--preview-app-port <PORT>',\n      'Port for the preview app to be served on',\n      defaultPreviewAppPort,\n    )\n    .option(\n      '-c, --mkdocs-config-file-name <FILENAME>',\n      'Mkdocs config file name',\n    )\n    .option(\n      '--mkdocs-parameter-clean',\n      'Pass \"--clean\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-dirtyreload',\n      'Pass \"--dirtyreload\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-strict',\n      'Pass \"--strict\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .hook('preAction', command => {\n      if (\n        command.opts().previewAppPort !== defaultPreviewAppPort &&\n        !command.opts().previewAppBundlePath\n      ) {\n        command.error(\n          '--preview-app-port can only be used together with --preview-app-bundle-path',\n        );\n      }\n    })\n    .action(lazy(() => import('./serve/serve'), 'default'));\n}\n\n// Humbly taken from backstage-cli's registerCommands\ntype ActionFunc = (...args: any[]) => Promise<void>;\ntype ActionExports<TModule extends object> = {\n  [KName in keyof TModule as TModule[KName] extends ActionFunc\n    ? KName\n    : never]: TModule[KName];\n};\n\n// Wraps an action function so that it always exits and handles errors\nexport function lazy<TModule extends object>(\n  moduleLoader: () => Promise<TModule>,\n  exportName: keyof ActionExports<TModule>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const mod = await moduleLoader();\n      const actualModule = (\n        mod as unknown as { default: ActionExports<TModule> }\n      ).default;\n      const actionFunc = actualModule[exportName] as ActionFunc;\n      await actionFunc(...args);\n\n      process.exit(0);\n    } catch (error) {\n      console.error(error.message);\n      process.exit(1);\n    }\n  };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAkB,CAAA,kBAAA;AAC7C,MAAM,qBAAwB,GAAA,MAAA;AAEvB,SAAS,iBAAiB,OAAkB,EAAA;AACjD,EAAA,OAAA,CACG,OAAQ,CAAA,UAAU,CAClB,CAAA,WAAA,CAAY,oDAAoD,CAChE,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,WAAa,EAAA,qCAAqC,CACzD,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAID,CAAA,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GAEF,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,KAAM,CAAA,OAAO,CACb,CAAA,MAAA,CAAO,IAAK,CAAA,MAAM,OAAO,4BAAqB,CAAG,EAAA,SAAS,CAAC,CAAA;AAE9D,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,MAAO,CAAA,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA,CAAO,sBAAwB,EAAA,yCAAyC,CACxE,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,IAAK,CAAA,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAQ,CAAA,cAAc,CACtB,CAAA,WAAA,CAAY,2DAA2D,CACvE,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,IAED,MAAO,CAAA,mBAAA,EAAqB,uCAAuC,MAAM,CAAA,CACzE,OAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,OAAO,IAAK,CAAA,MAAM,OAAO,uBAAgB,CAAA,EAAG,SAAS,CAAC,CAAA;AAEzD,EACG,OAAA,CAAA,OAAA,CAAQ,OAAO,CACf,CAAA,WAAA;AAAA,IACC;AAAA,GAED,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAO,CAAA,sBAAA,EAAwB,+BAAiC,EAAA,MAAM,EACtE,MAAO,CAAA,cAAA,EAAgB,wBAA0B,EAAA,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0CAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,gFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,IAAK,CAAA,WAAA,EAAa,CAAW,OAAA,KAAA;AAC5B,IACE,IAAA,OAAA,CAAQ,MAAO,CAAA,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAK,EAAA,CAAE,oBAChB,EAAA;AACA,MAAQ,OAAA,CAAA,KAAA;AAAA,QACN;AAAA,OACF;AAAA;AACF,GACD,EACA,MAAO,CAAA,IAAA,CAAK,MAAM,OAAO,sBAAe,CAAG,EAAA,SAAS,CAAC,CAAA;AAC1D;AAWgB,SAAA,IAAA,CACd,cACA,UACoC,EAAA;AACpC,EAAA,OAAO,UAAU,IAAgB,KAAA;AAC/B,IAAI,IAAA;AACF,MAAM,MAAA,GAAA,GAAM,MAAM,YAAa,EAAA;AAC/B,MAAA,MAAM,eACJ,GACA,CAAA,OAAA;AACF,MAAM,MAAA,UAAA,GAAa,aAAa,UAAU,CAAA;AAC1C,MAAM,MAAA,UAAA,CAAW,GAAG,IAAI,CAAA;AAExB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,aACP,KAAO,EAAA;AACd,MAAQ,OAAA,CAAA,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA;AAChB,GACF;AACF;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Command } from 'commander';\nimport { TechdocsGenerator } from '@backstage/plugin-techdocs-node';\n\nconst defaultDockerImage = TechdocsGenerator.defaultDockerImage;\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n  program\n    .command('generate')\n    .description('Generate TechDocs documentation site using MkDocs.')\n    .option(\n      '--source-dir <PATH>',\n      'Source directory containing mkdocs.yml and docs/ directory.',\n      '.',\n    )\n    .option(\n      '--output-dir <PATH>',\n      'Output directory containing generated TechDocs site.',\n      './site/',\n    )\n    .option(\n      '--docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option('--no-pull', 'Do not pull the latest docker image')\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable and plugins in current user environment.',\n    )\n    .option(\n      '--techdocs-ref <HOST_TYPE:URL>',\n      'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n        '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n        '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n    )\n    .option(\n      '--etag <ETAG>',\n      'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .option(\n      '--omitTechdocsCoreMkdocsPlugin',\n      \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n      false,\n    )\n    .option(\n      '--legacyCopyReadmeMdToIndexMd',\n      'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n      false,\n    )\n    .option(\n      '--defaultPlugin [defaultPlugins...]',\n      'Plugins which should be added automatically to the mkdocs.yaml file',\n      [],\n    )\n    .option(\n      '--runAsDefaultUser',\n      'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n      false,\n    )\n    .alias('build')\n    .action(lazy(() => import('./generate/generate'), 'default'));\n\n  program\n    .command('migrate')\n    .description(\n      'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--removeOriginal',\n      'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n      false,\n    )\n    .option(\n      '--concurrency <MAX CONCURRENT REQS>',\n      'Optional Controls the number of API requests allowed to be performed simultaneously.',\n      '25',\n    )\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./migrate/migrate'), 'default'));\n\n  program\n    .command('publish')\n    .description(\n      'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .requiredOption(\n      '--entity <NAMESPACE/KIND/NAME>',\n      '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n    )\n    .option(\n      '--legacyUseCaseSensitiveTripletPaths',\n      'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n      false,\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsProxy <HTTPS Proxy>',\n      'Optional Proxy to use for AWS requests.',\n    )\n    .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Amazon S3',\n    )\n    .option(\n      '--awsMaxAttempts <AWS MAX ATTEMPTS>',\n      'Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Google cloud storage',\n    )\n    .option(\n      '--directory <PATH>',\n      'Path of the directory containing generated files to publish',\n      './site/',\n    )\n    .action(lazy(() => import('./publish/publish'), 'default'));\n\n  program\n    .command('serve:mkdocs')\n    .description('Serve a documentation project locally using MkDocs serve.')\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run `mkdocs serve` in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/mkdocs'), 'default'));\n\n  program\n    .command('serve')\n    .description(\n      'Serve a documentation project locally in a Backstage app-like environment',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .option(\n      '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n      'Preview documentation using another web app',\n    )\n    .option(\n      '--preview-app-port <PORT>',\n      'Port for the preview app to be served on',\n      defaultPreviewAppPort,\n    )\n    .option(\n      '-c, --mkdocs-config-file-name <FILENAME>',\n      'Mkdocs config file name',\n    )\n    .option(\n      '--mkdocs-parameter-clean',\n      'Pass \"--clean\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-dirtyreload',\n      'Pass \"--dirtyreload\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-strict',\n      'Pass \"--strict\" parameter to mkdocs server running in containerized environment',\n      false,\n    )\n    .hook('preAction', command => {\n      if (\n        command.opts().previewAppPort !== defaultPreviewAppPort &&\n        !command.opts().previewAppBundlePath\n      ) {\n        command.error(\n          '--preview-app-port can only be used together with --preview-app-bundle-path',\n        );\n      }\n    })\n    .action(lazy(() => import('./serve/serve'), 'default'));\n}\n\n// Humbly taken from backstage-cli's registerCommands\ntype ActionFunc = (...args: any[]) => Promise<void>;\ntype ActionExports<TModule extends object> = {\n  [KName in keyof TModule as TModule[KName] extends ActionFunc\n    ? KName\n    : never]: TModule[KName];\n};\n\n// Wraps an action function so that it always exits and handles errors\nexport function lazy<TModule extends object>(\n  moduleLoader: () => Promise<TModule>,\n  exportName: keyof ActionExports<TModule>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const mod = await moduleLoader();\n      const actualModule = (\n        mod as unknown as { default: ActionExports<TModule> }\n      ).default;\n      const actionFunc = actualModule[exportName] as ActionFunc;\n      await actionFunc(...args);\n\n      process.exit(0);\n    } catch (error) {\n      console.error(error.message);\n      process.exit(1);\n    }\n  };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAA,CAAkB,kBAAA;AAC7C,MAAM,qBAAA,GAAwB,MAAA;AAEvB,SAAS,iBAAiB,OAAA,EAAkB;AACjD,EAAA,OAAA,CACG,OAAA,CAAQ,UAAU,CAAA,CAClB,WAAA,CAAY,oDAAoD,CAAA,CAChE,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,WAAA,EAAa,qCAAqC,CAAA,CACzD,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAGF,CACC,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,cAAA,EAAgB,wBAAA,EAA0B,KAAK,CAAA,CACtD,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GACH,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,KAAA,CAAM,OAAO,CAAA,CACb,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,4BAAqB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE9D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,cAAA,EAAgB,wBAAA,EAA0B,KAAK,CAAA,CACtD,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,sBAAA,EAAwB,yCAAyC,CAAA,CACxE,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAA,CAAQ,cAAc,CAAA,CACtB,WAAA,CAAY,2DAA2D,CAAA,CACvE,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,IAED,MAAA,CAAO,mBAAA,EAAqB,uCAAuC,MAAM,CAAA,CACzE,OAAO,cAAA,EAAgB,wBAAA,EAA0B,KAAK,CAAA,CACtD,OAAO,IAAA,CAAK,MAAM,OAAO,uBAAgB,CAAA,EAAG,SAAS,CAAC,CAAA;AAEzD,EAAA,OAAA,CACG,OAAA,CAAQ,OAAO,CAAA,CACf,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,sBAAA,EAAwB,+BAAA,EAAiC,MAAM,EACtE,MAAA,CAAO,cAAA,EAAgB,wBAAA,EAA0B,KAAK,CAAA,CACtD,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,gFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,IAAA,CAAK,WAAA,EAAa,CAAA,OAAA,KAAW;AAC5B,IAAA,IACE,OAAA,CAAQ,MAAK,CAAE,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAA,EAAK,CAAE,oBAAA,EAChB;AACA,MAAA,OAAA,CAAQ,KAAA;AAAA,QACN;AAAA,OACF;AAAA,IACF;AAAA,EACF,CAAC,EACA,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,sBAAe,CAAA,EAAG,SAAS,CAAC,CAAA;AAC1D;AAWO,SAAS,IAAA,CACd,cACA,UAAA,EACoC;AACpC,EAAA,OAAO,UAAU,IAAA,KAAgB;AAC/B,IAAA,IAAI;AACF,MAAA,MAAM,GAAA,GAAM,MAAM,YAAA,EAAa;AAC/B,MAAA,MAAM,eACJ,GAAA,CACA,OAAA;AACF,MAAA,MAAM,UAAA,GAAa,aAAa,UAAU,CAAA;AAC1C,MAAA,MAAM,UAAA,CAAW,GAAG,IAAI,CAAA;AAExB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB,SAAS,KAAA,EAAO;AACd,MAAA,OAAA,CAAQ,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB;AAAA,EACF,CAAA;AACF;;;;;"}

package/dist/commands/migrate/migrate.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrate.cjs.js","sources":["../../../src/commands/migrate/migrate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  if (!publisher.migrateDocsCase) {\n    throw new Error(`Migration not implemented for ${opts.publisherType}`);\n  }\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    throw new Error('');\n  }\n\n  // Validate and parse migration arguments.\n  const removeOriginal = opts.removeOriginal;\n  const numericConcurrency = parseInt(opts.concurrency, 10);\n\n  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n    throw new Error(\n      `Concurrency must be a number greater than 1. ${opts.concurrency} provided.`,\n    );\n  }\n\n  await publisher.migrateDocsCase({\n    concurrency: numericConcurrency,\n    removeOriginal,\n  });\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher"],"mappings":";;;;;;;;;AAsBA,eAA8B,QAAQ,IAAoB,EAAA;AACxD,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAE1E,EAAI,IAAA,CAAC,UAAU,eAAiB,EAAA;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAiC,8BAAA,EAAA,IAAA,CAAK,aAAa,CAAE,CAAA,CAAA;AAAA;AAIvE,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAM,MAAA,IAAI,MAAM,EAAE,CAAA;AAAA;AAIpB,EAAA,MAAM,iBAAiB,IAAK,CAAA,cAAA;AAC5B,EAAA,MAAM,kBAAqB,GAAA,QAAA,CAAS,IAAK,CAAA,WAAA,EAAa,EAAE,CAAA;AAExD,EAAA,IAAI,CAAC,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,IAAK,sBAAsB,CAAG,EAAA;AACpE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,6CAAA,EAAgD,KAAK,WAAW,CAAA,UAAA;AAAA,KAClE;AAAA;AAGF,EAAA,MAAM,UAAU,eAAgB,CAAA;AAAA,IAC9B,WAAa,EAAA,kBAAA;AAAA,IACb;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"migrate.cjs.js","sources":["../../../src/commands/migrate/migrate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  if (!publisher.migrateDocsCase) {\n    throw new Error(`Migration not implemented for ${opts.publisherType}`);\n  }\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    throw new Error('');\n  }\n\n  // Validate and parse migration arguments.\n  const removeOriginal = opts.removeOriginal;\n  const numericConcurrency = parseInt(opts.concurrency, 10);\n\n  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n    throw new Error(\n      `Concurrency must be a number greater than 1. ${opts.concurrency} provided.`,\n    );\n  }\n\n  await publisher.migrateDocsCase({\n    concurrency: numericConcurrency,\n    removeOriginal,\n  });\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher"],"mappings":";;;;;;;;;AAsBA,eAA8B,QAAQ,IAAA,EAAoB;AACxD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,MAAA,GAASC,+BAAA,CAAgB,cAAA,CAAe,IAAI,CAAA;AAClD,EAAA,MAAMC,WAAA,GAAYC,uBAAA,CAAc,UAAA,CAAW,MAAM,CAAA;AACjD,EAAA,MAAM,SAAA,GAAY,MAAMC,4BAAA,CAAU,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAE1E,EAAA,IAAI,CAAC,UAAU,eAAA,EAAiB;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,8BAAA,EAAiC,IAAA,CAAK,aAAa,CAAA,CAAE,CAAA;AAAA,EACvE;AAGA,EAAA,MAAM,EAAE,WAAA,EAAY,GAAI,MAAM,UAAU,YAAA,EAAa;AACrD,EAAA,IAAI,CAAC,WAAA,EAAa;AAEhB,IAAA,MAAM,IAAI,MAAM,EAAE,CAAA;AAAA,EACpB;AAGA,EAAA,MAAM,iBAAiB,IAAA,CAAK,cAAA;AAC5B,EAAA,MAAM,kBAAA,GAAqB,QAAA,CAAS,IAAA,CAAK,WAAA,EAAa,EAAE,CAAA;AAExD,EAAA,IAAI,CAAC,MAAA,CAAO,SAAA,CAAU,kBAAkB,CAAA,IAAK,sBAAsB,CAAA,EAAG;AACpE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,6CAAA,EAAgD,KAAK,WAAW,CAAA,UAAA;AAAA,KAClE;AAAA,EACF;AAEA,EAAA,MAAM,UAAU,eAAA,CAAgB;AAAA,IAC9B,WAAA,EAAa,kBAAA;AAAA,IACb;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/commands/publish/publish.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish.cjs.js","sources":["../../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    return Promise.reject(new Error(''));\n  }\n\n  const [namespace, kind, name] = opts.entity.split('/');\n  const entity = {\n    kind,\n    metadata: {\n      namespace,\n      name,\n    },\n  } as Entity;\n\n  const directory = resolve(opts.directory);\n  await publisher.publish({ entity, directory });\n\n  return true;\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAkC,EAAA;AACtE,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAA,OAAO,OAAQ,CAAA,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA;AAAA;AAGrC,EAAM,MAAA,CAAC,WAAW,IAAM,EAAA,IAAI,IAAI,IAAK,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA;AACrD,EAAA,MAAM,MAAS,GAAA;AAAA,IACb,IAAA;AAAA,IACA,QAAU,EAAA;AAAA,MACR,SAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAM,MAAA,SAAA,GAAYG,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAU,CAAA,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA;AAE7C,EAAO,OAAA,IAAA;AACT;;;;"}
+{"version":3,"file":"publish.cjs.js","sources":["../../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    return Promise.reject(new Error(''));\n  }\n\n  const [namespace, kind, name] = opts.entity.split('/');\n  const entity = {\n    kind,\n    metadata: {\n      namespace,\n      name,\n    },\n  } as Entity;\n\n  const directory = resolve(opts.directory);\n  await publisher.publish({ entity, directory });\n\n  return true;\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAA,EAAkC;AACtE,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,MAAA,GAASC,+BAAA,CAAgB,cAAA,CAAe,IAAI,CAAA;AAClD,EAAA,MAAMC,WAAA,GAAYC,uBAAA,CAAc,UAAA,CAAW,MAAM,CAAA;AACjD,EAAA,MAAM,SAAA,GAAY,MAAMC,4BAAA,CAAU,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAY,GAAI,MAAM,UAAU,YAAA,EAAa;AACrD,EAAA,IAAI,CAAC,WAAA,EAAa;AAEhB,IAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA;AAAA,EACrC;AAEA,EAAA,MAAM,CAAC,WAAW,IAAA,EAAM,IAAI,IAAI,IAAA,CAAK,MAAA,CAAO,MAAM,GAAG,CAAA;AACrD,EAAA,MAAM,MAAA,GAAS;AAAA,IACb,IAAA;AAAA,IACA,QAAA,EAAU;AAAA,MACR,SAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAA,MAAM,SAAA,GAAYG,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,CAAU,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA;AAE7C,EAAA,OAAO,IAAA;AACT;;;;"}

package/dist/commands/serve/mkdocs.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"mkdocs.cjs.js","sources":["../../../src/commands/serve/mkdocs.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${opts.port}`;\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;\n\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","checkIfDockerIsOperational","getMkdocsYml","openBrowser","runMkdocsServer","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;AAyBA,eAA8B,YAAY,IAAoB,EAAA;AAC5D,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA;AAErD,EAAM,MAAA,UAAA,GAAa,CAAkB,eAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,CAAoB,iBAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC/C,EAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,MAAA,GAAS,UAAa,GAAA,SAAA;AAEnD,EAAA,IAAI,KAAK,MAAQ,EAAA;AACf,IAAM,MAAA,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAA;AAAA;AACF;AAGF,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAK,CAAA;AAAA,GACP;AAGA,EAAA,IAAI,wBAA2B,GAAA,KAAA;AAE/B,EAAA,MAAM,UAAmB,CAAQ,IAAA,KAAA;AAE/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA;AAAA;AAIF,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,wBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,eAAe,EAAE,CAC7C,EAAA;AAEA,QAAA,MAAA,CAAO,IAAK,CAAA;AAAA,0BAAA,EAA+B,SAAS;AAAA,CAAI,CAAA;AACxD,QAAAC,4BAAA,CAAY,SAAS,CAAA;AACrB,QAA2B,wBAAA,GAAA,IAAA;AAAA;AAC7B,KACD,CAAA;AAAA,GACH;AAMA,EAAM,MAAA,YAAA,GAAe,MAAMC,4BAAgB,CAAA;AAAA,IACzC,MAAM,IAAK,CAAA,IAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,OAAA;AAAA,IACf,aAAe,EAAA;AAAA,GAChB,CAAA;AAGD,EAAM,MAAAC,iBAAA,CAAc,CAAC,YAAY,CAAC,CAAA;AAElC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA;AAAA,KAC5B,CAAA;AAAA;AAEL;;;;"}
+{"version":3,"file":"mkdocs.cjs.js","sources":["../../../src/commands/serve/mkdocs.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${opts.port}`;\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;\n\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","checkIfDockerIsOperational","getMkdocsYml","openBrowser","runMkdocsServer","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;AAyBA,eAA8B,YAAY,IAAA,EAAoB;AAC5D,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,UAAA,GAAa,CAAA,eAAA,EAAkB,IAAA,CAAK,IAAI,CAAA,CAAA;AAC9C,EAAA,MAAM,SAAA,GAAY,CAAA,iBAAA,EAAoB,IAAA,CAAK,IAAI,CAAA,CAAA;AAC/C,EAAA,MAAM,eAAA,GAAkB,IAAA,CAAK,MAAA,GAAS,UAAA,GAAa,SAAA;AAEnD,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAGA,EAAA,IAAI,wBAAA,GAA2B,KAAA;AAE/B,EAAA,MAAM,UAAmB,CAAA,IAAA,KAAQ;AAE/B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,MAAA,GAAS,iBAAA,GAAoB,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAGA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,wBAAA,IACD,IAAA,CAAK,SAAS,CAAA,WAAA,EAAc,eAAe,EAAE,CAAA,EAC7C;AAEA,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,0BAAA,EAA+B,SAAS;AAAA,CAAI,CAAA;AACxD,QAAAC,4BAAA,CAAY,SAAS,CAAA;AACrB,QAAA,wBAAA,GAA2B,IAAA;AAAA,MAC7B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAMA,EAAA,MAAM,YAAA,GAAe,MAAMC,4BAAA,CAAgB;AAAA,IACzC,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,aAAA,EAAe,OAAA;AAAA,IACf,aAAA,EAAe;AAAA,GAChB,CAAA;AAGD,EAAA,MAAMC,iBAAA,CAAc,CAAC,YAAY,CAAC,CAAA;AAElC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;;;"}

package/dist/commands/serve/serve.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"serve.cjs.js","sources":["../../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nfunction findPreviewBundlePath(): string {\n  try {\n    return path.join(\n      path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n      'dist',\n    );\n  } catch {\n    // If the techdocs-cli-embedded-app package is not available it means we're\n    // running a published package. For published packages the preview bundle is\n    // copied to dist/embedded-app be the prepack script.\n    //\n    // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n    // Within the extracted directory, run `npm install --only=prod`.\n    // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n    // eslint-disable-next-line no-restricted-syntax\n    return findPaths(__dirname).resolveOwn('dist/embedded-app');\n  }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n  return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = opts.docker\n    ? mkdocsDockerAddr\n    : mkdocsLocalAddr;\n  const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName,\n  });\n\n  // Validate that Docker is up and running\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: opts.mkdocsPort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n    mkdocsConfigFileName: mkdocsYmlPath,\n    mkdocsParameterClean: opts.mkdocsParameterClean,\n    mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,\n    mkdocsParameterStrict: opts.mkdocsParameterStrict,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n  const previewAppPath = getPreviewAppPath(opts);\n  const httpServer = new HTTPServer(\n    previewAppPath,\n    port,\n    mkdocsExpectedDevAddr,\n    opts.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["path","findPaths","createLogger","getMkdocsYml","checkIfDockerIsOperational","runMkdocsServer","httpServer","HTTPServer","openBrowser","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,SAAS,qBAAgC,GAAA;AACvC,EAAI,IAAA;AACF,IAAA,OAAOA,qBAAK,CAAA,IAAA;AAAA,MACVA,qBAAK,CAAA,OAAA,CAAQ,OAAQ,CAAA,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,GACM,CAAA,MAAA;AASN,IAAA,OAAOC,mBAAU,CAAA,SAAS,CAAE,CAAA,UAAA,CAAW,mBAAmB,CAAA;AAAA;AAE9D;AAEA,SAAS,kBAAkB,IAA4B,EAAA;AACrD,EAAO,OAAA,IAAA,CAAK,wBAAwB,qBAAsB,EAAA;AAC5D;AAEA,eAA8B,MAAM,IAAoB,EAAA;AACtD,EAAA,MAAM,SAASC,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA;AAKrD,EAAM,MAAA,SAAA,GAAY,OAAO,IAAK,CAAA,OAAA,CAAQ,GAAG,CAAE,CAAA,QAAA,CAAS,uBAAuB,CAAA,GACvE,IACA,GAAA,KAAA;AAEJ,EAAA,MAAM,oBAAuB,GAAA,IAAA;AAE7B,EAAM,MAAA,gBAAA,GAAmB,CAAkB,eAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAC1D,EAAM,MAAA,eAAA,GAAkB,CAAoB,iBAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAC3D,EAAM,MAAA,qBAAA,GAAwB,IAAK,CAAA,MAAA,GAC/B,gBACA,GAAA,eAAA;AACJ,EAAA,MAAM,uBAAuB,IAAK,CAAA,oBAAA;AAClC,EAAA,MAAM,WAAW,IAAK,CAAA,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAM,EAAA,aAAA,EAAe,mBAAsB,GAAA,MAAMC,gCAAa,IAAM,EAAA;AAAA,IAC1E,IAAM,EAAA,QAAA;AAAA,IACN;AAAA,GACD,CAAA;AAGD,EAAA,IAAI,KAAK,MAAQ,EAAA;AACf,IAAM,MAAA,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAA;AAAA;AACF;AAGF,EAAA,IAAI,sBAAyB,GAAA,KAAA;AAC7B,EAAA,MAAM,gBAAyB,CAAQ,IAAA,KAAA;AAErC,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA;AAAA;AAGF,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,sBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,qBAAqB,EAAE,CACnD,EAAA;AACA,QAAyB,sBAAA,GAAA,IAAA;AAAA;AAC3B,KACD,CAAA;AAAA,GACH;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA;AACrC,EAAM,MAAA,kBAAA,GAAqB,MAAMC,4BAAgB,CAAA;AAAA,IAC/C,MAAM,IAAK,CAAA,UAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,aAAA;AAAA,IACf,aAAe,EAAA,aAAA;AAAA,IACf,oBAAsB,EAAA,aAAA;AAAA,IACtB,sBAAsB,IAAK,CAAA,oBAAA;AAAA,IAC3B,4BAA4B,IAAK,CAAA,0BAAA;AAAA,IACjC,uBAAuB,IAAK,CAAA;AAAA,GAC7B,CAAA;AAID,EAAA,KAAA,IAAS,OAAU,GAAA,CAAA,EAAG,OAAU,GAAA,EAAA,EAAI,OAAW,EAAA,EAAA;AAC7C,IAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,CAAA,KAAK,UAAW,CAAA,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,sBAAwB,EAAA;AAC1B,MAAA;AAAA;AAEF,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA;AAAA;AAGrD,EAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,IAAO,MAAA,CAAA,KAAA;AAAA,MACL;AAAA,KACF;AAAA;AAGF,EAAM,MAAA,IAAA,GAAO,SAAY,GAAA,oBAAA,GAAuB,IAAK,CAAA,cAAA;AACrD,EAAM,MAAA,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAK,CAAA;AAAA,GACP;AAEA,EACGD,YAAA,CAAA,KAAA,EACA,CAAA,KAAA,CAAM,CAAO,GAAA,KAAA;AACZ,IAAO,MAAA,CAAA,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAK,EAAA;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,GACf,CACA,CAAA,IAAA,CAAK,MAAM;AAEV,IAAYE,4BAAA,CAAA,CAAA,iBAAA,EAAoB,IAAI,CAAgC,8BAAA,CAAA,CAAA;AACpE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,GACD,CAAA;AAEH,EAAM,MAAAC,iBAAA,CAAc,CAAC,kBAAkB,CAAC,CAAA;AAExC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA;AAAA,KAC5B,CAAA;AAAA;AAEL;;;;"}
+{"version":3,"file":"serve.cjs.js","sources":["../../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nfunction findPreviewBundlePath(): string {\n  try {\n    return path.join(\n      path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n      'dist',\n    );\n  } catch {\n    // If the techdocs-cli-embedded-app package is not available it means we're\n    // running a published package. For published packages the preview bundle is\n    // copied to dist/embedded-app be the prepack script.\n    //\n    // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n    // Within the extracted directory, run `npm install --only=prod`.\n    // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n    // eslint-disable-next-line no-restricted-syntax\n    return findPaths(__dirname).resolveOwn('dist/embedded-app');\n  }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n  return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = opts.docker\n    ? mkdocsDockerAddr\n    : mkdocsLocalAddr;\n  const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName,\n  });\n\n  // Validate that Docker is up and running\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: opts.mkdocsPort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n    mkdocsConfigFileName: mkdocsYmlPath,\n    mkdocsParameterClean: opts.mkdocsParameterClean,\n    mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,\n    mkdocsParameterStrict: opts.mkdocsParameterStrict,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n  const previewAppPath = getPreviewAppPath(opts);\n  const httpServer = new HTTPServer(\n    previewAppPath,\n    port,\n    mkdocsExpectedDevAddr,\n    opts.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["path","findPaths","createLogger","getMkdocsYml","checkIfDockerIsOperational","runMkdocsServer","httpServer","HTTPServer","openBrowser","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,SAAS,qBAAA,GAAgC;AACvC,EAAA,IAAI;AACF,IAAA,OAAOA,qBAAA,CAAK,IAAA;AAAA,MACVA,qBAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,EACF,CAAA,CAAA,MAAQ;AASN,IAAA,OAAOC,mBAAA,CAAU,SAAS,CAAA,CAAE,UAAA,CAAW,mBAAmB,CAAA;AAAA,EAC5D;AACF;AAEA,SAAS,kBAAkB,IAAA,EAA4B;AACrD,EAAA,OAAO,IAAA,CAAK,wBAAwB,qBAAA,EAAsB;AAC5D;AAEA,eAA8B,MAAM,IAAA,EAAoB;AACtD,EAAA,MAAM,SAASC,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAKrD,EAAA,MAAM,SAAA,GAAY,OAAO,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA,CAAE,QAAA,CAAS,uBAAuB,CAAA,GACvE,IAAA,GACA,KAAA;AAEJ,EAAA,MAAM,oBAAA,GAAuB,IAAA;AAE7B,EAAA,MAAM,gBAAA,GAAmB,CAAA,eAAA,EAAkB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC1D,EAAA,MAAM,eAAA,GAAkB,CAAA,iBAAA,EAAoB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC3D,EAAA,MAAM,qBAAA,GAAwB,IAAA,CAAK,MAAA,GAC/B,gBAAA,GACA,eAAA;AACJ,EAAA,MAAM,uBAAuB,IAAA,CAAK,oBAAA;AAClC,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,mBAAkB,GAAI,MAAMC,gCAAa,IAAA,EAAM;AAAA,IAC1E,IAAA,EAAM,QAAA;AAAA,IACN;AAAA,GACD,CAAA;AAGD,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,sBAAA,GAAyB,KAAA;AAC7B,EAAA,MAAM,gBAAyB,CAAA,IAAA,KAAQ;AAErC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,MAAA,GAAS,iBAAA,GAAoB,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,sBAAA,IACD,IAAA,CAAK,SAAS,CAAA,WAAA,EAAc,qBAAqB,EAAE,CAAA,EACnD;AACA,QAAA,sBAAA,GAAyB,IAAA;AAAA,MAC3B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA;AACrC,EAAA,MAAM,kBAAA,GAAqB,MAAMC,4BAAA,CAAgB;AAAA,IAC/C,MAAM,IAAA,CAAK,UAAA;AAAA,IACX,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,aAAA,EAAe,aAAA;AAAA,IACf,aAAA,EAAe,aAAA;AAAA,IACf,oBAAA,EAAsB,aAAA;AAAA,IACtB,sBAAsB,IAAA,CAAK,oBAAA;AAAA,IAC3B,4BAA4B,IAAA,CAAK,0BAAA;AAAA,IACjC,uBAAuB,IAAA,CAAK;AAAA,GAC7B,CAAA;AAID,EAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,GAAU,EAAA,EAAI,OAAA,EAAA,EAAW;AAC7C,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,sBAAA,EAAwB;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA;AAAA,EACrD;AAEA,EAAA,IAAI,CAAC,sBAAA,EAAwB;AAC3B,IAAA,MAAA,CAAO,KAAA;AAAA,MACL;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAM,IAAA,GAAO,SAAA,GAAY,oBAAA,GAAuB,IAAA,CAAK,cAAA;AACrD,EAAA,MAAM,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAEA,EAAAD,YAAA,CACG,KAAA,EAAM,CACN,KAAA,CAAM,CAAA,GAAA,KAAO;AACZ,IAAA,MAAA,CAAO,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAA,EAAK;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,EAChB,CAAC,CAAA,CACA,IAAA,CAAK,MAAM;AAEV,IAAAE,4BAAA,CAAY,CAAA,iBAAA,EAAoB,IAAI,CAAA,8BAAA,CAAgC,CAAA;AACpE,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,EACF,CAAC,CAAA;AAEH,EAAA,MAAMC,iBAAA,CAAc,CAAC,kBAAkB,CAAC,CAAA;AAExC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;;;"}

package/dist/commands/serve/utils.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs.js","sources":["../../../src/commands/serve/utils.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 { promisify } from 'util';\nimport * as winston from 'winston';\nimport { execFile } from 'child_process';\n\nexport async function checkIfDockerIsOperational(\n  logger: winston.Logger,\n): Promise<boolean> {\n  logger.info('Checking Docker status...');\n  try {\n    const runCheck = promisify(execFile);\n    await runCheck('docker', ['info'], { shell: true });\n    logger.info(\n      'Docker is up and running. Proceed to starting up mkdocs server',\n    );\n    return true;\n  } catch {\n    logger.error(\n      'Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running',\n    );\n    return false;\n  }\n}\n"],"names":["promisify","execFile"],"mappings":";;;;;AAoBA,eAAsB,2BACpB,MACkB,EAAA;AAClB,EAAA,MAAA,CAAO,KAAK,2BAA2B,CAAA;AACvC,EAAI,IAAA;AACF,IAAM,MAAA,QAAA,GAAWA,eAAUC,sBAAQ,CAAA;AACnC,IAAM,MAAA,QAAA,CAAS,UAAU,CAAC,MAAM,GAAG,EAAE,KAAA,EAAO,MAAM,CAAA;AAClD,IAAO,MAAA,CAAA,IAAA;AAAA,MACL;AAAA,KACF;AACA,IAAO,OAAA,IAAA;AAAA,GACD,CAAA,MAAA;AACN,IAAO,MAAA,CAAA,KAAA;AAAA,MACL;AAAA,KACF;AACA,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}
+{"version":3,"file":"utils.cjs.js","sources":["../../../src/commands/serve/utils.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 { promisify } from 'util';\nimport * as winston from 'winston';\nimport { execFile } from 'child_process';\n\nexport async function checkIfDockerIsOperational(\n  logger: winston.Logger,\n): Promise<boolean> {\n  logger.info('Checking Docker status...');\n  try {\n    const runCheck = promisify(execFile);\n    await runCheck('docker', ['info'], { shell: true });\n    logger.info(\n      'Docker is up and running. Proceed to starting up mkdocs server',\n    );\n    return true;\n  } catch {\n    logger.error(\n      'Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running',\n    );\n    return false;\n  }\n}\n"],"names":["promisify","execFile"],"mappings":";;;;;AAoBA,eAAsB,2BACpB,MAAA,EACkB;AAClB,EAAA,MAAA,CAAO,KAAK,2BAA2B,CAAA;AACvC,EAAA,IAAI;AACF,IAAA,MAAM,QAAA,GAAWA,eAAUC,sBAAQ,CAAA;AACnC,IAAA,MAAM,QAAA,CAAS,UAAU,CAAC,MAAM,GAAG,EAAE,KAAA,EAAO,MAAM,CAAA;AAClD,IAAA,MAAA,CAAO,IAAA;AAAA,MACL;AAAA,KACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA,CAAA,MAAQ;AACN,IAAA,MAAA,CAAO,KAAA;AAAA,MACL;AAAA,KACF;AACA,IAAA,OAAO,KAAA;AAAA,EACT;AACF;;;;"}

package/dist/embedded-app/.config-schema.json

@@ -973,6 +973,7 @@
                   "packages": {
                     "visibility": "frontend",
                     "deepVisibility": "frontend",
+                    "deprecated": "This is no longer experimental; use `app.packages` instead.",
                     "anyOf": [
                       {
                         "type": "object",
@@ -999,6 +1000,34 @@
                   }
                 }
               },
+              "packages": {
+                "description": "Controls what packages are loaded by the new frontend system.",
+                "visibility": "frontend",
+                "deepVisibility": "frontend",
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "include": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      "exclude": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  },
+                  {
+                    "const": "all",
+                    "type": "string"
+                  }
+                ]
+              },
               "routes": {
                 "type": "object",
                 "properties": {
@@ -2421,6 +2450,246 @@
                       "connection",
                       "store"
                     ]
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "store": {
+                        "description": "Infinispan cache store configuration.",
+                        "type": "string",
+                        "const": "infinispan"
+                      },
+                      "defaultTtl": {
+                        "description": "An optional default TTL (in milliseconds)."
+                      },
+                      "infinispan": {
+                        "description": "Configuration for the Infinispan cache store.",
+                        "type": "object",
+                        "properties": {
+                          "version": {
+                            "description": "Version of client/server protocol.",
+                            "default": "'2.9' is the latest version.",
+                            "enum": [
+                              "2.2",
+                              "2.5",
+                              "2.9"
+                            ],
+                            "type": "string"
+                          },
+                          "cacheName": {
+                            "description": "Infinispan Cache Name if not provided default is `cache` recommended to set this.",
+                            "type": "string"
+                          },
+                          "maxRetries": {
+                            "description": "Optional number of retries for operation.\nDefaults to 3.",
+                            "type": "number"
+                          },
+                          "topologyUpdates": {
+                            "description": "Optional flag to controls whether the client deals with topology updates or not.",
+                            "default": true,
+                            "type": "boolean"
+                          },
+                          "mediaType": {
+                            "description": "Media type of the cache contents.",
+                            "default": "'text/plain'",
+                            "enum": [
+                              "application/json",
+                              "text/plain"
+                            ],
+                            "type": "string"
+                          },
+                          "dataFormat": {
+                            "description": "Optional data format configuration.\nIf not provided, defaults to text/plain for both key and value.",
+                            "type": "object",
+                            "properties": {
+                              "keyType": {
+                                "description": "Type of the key in the cache.",
+                                "default": "'text/plain'",
+                                "enum": [
+                                  "application/json",
+                                  "text/plain"
+                                ],
+                                "type": "string"
+                              },
+                              "valueType": {
+                                "description": "Type of the value in the cache.",
+                                "default": "'text/plain'",
+                                "enum": [
+                                  "application/json",
+                                  "text/plain"
+                                ],
+                                "type": "string"
+                              }
+                            }
+                          },
+                          "servers": {
+                            "description": "Infinispan server host and port configuration.\nIf this is an array, the client will connect to all servers in the list based on TOPOLOGY_AWARE routing.\nIf this is a single object, it will be used as the default server.",
+                            "anyOf": [
+                              {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "host": {
+                                      "description": "Infinispan server host.",
+                                      "type": "string"
+                                    },
+                                    "port": {
+                                      "description": "Infinispan server port (Hot Rod protocol). Defaults to `11222`.",
+                                      "type": "number"
+                                    }
+                                  },
+                                  "required": [
+                                    "host"
+                                  ]
+                                }
+                              },
+                              {
+                                "type": "object",
+                                "properties": {
+                                  "host": {
+                                    "description": "Infinispan server host. Defaults to `127.0.0.1`.",
+                                    "type": "string"
+                                  },
+                                  "port": {
+                                    "description": "Infinispan server port (Hot Rod protocol). Defaults to `11222`.",
+                                    "type": "number"
+                                  }
+                                }
+                              }
+                            ]
+                          },
+                          "authentication": {
+                            "type": "object",
+                            "properties": {
+                              "enabled": {
+                                "description": "Enable authentication. Defaults to `false`.",
+                                "type": "boolean"
+                              },
+                              "saslMechanism": {
+                                "description": "Select the SASL mechanism to use. Can be one of PLAIN, DIGEST-MD5, SCRAM-SHA-1, SCRAM-SHA-256, SCRAM-SHA-384, SCRAM-SHA-512, EXTERNAL, OAUTHBEARER",
+                                "type": "string"
+                              },
+                              "userName": {
+                                "description": "userName for authentication.",
+                                "type": "string"
+                              },
+                              "password": {
+                                "description": "Password for authentication.",
+                                "visibility": "secret",
+                                "type": "string"
+                              },
+                              "token": {
+                                "description": "The OAuth token. Required by the OAUTHBEARER mechanism.",
+                                "visibility": "secret",
+                                "type": "string"
+                              },
+                              "authzid": {
+                                "description": "The SASL authorization ID.",
+                                "type": "string"
+                              }
+                            }
+                          },
+                          "ssl": {
+                            "description": "TLS/SSL configuration.",
+                            "type": "object",
+                            "properties": {
+                              "enabled": {
+                                "description": "Enable ssl connection. Defaults to `false`.",
+                                "default": false,
+                                "type": "boolean"
+                              },
+                              "secureProtocol": {
+                                "description": "Optional field with secure protocol in use.",
+                                "default": "TLSv1_2_method",
+                                "type": "string"
+                              },
+                              "trustCerts": {
+                                "description": "Optional paths of trusted SSL certificates.",
+                                "type": "array",
+                                "items": {
+                                  "type": "string"
+                                }
+                              },
+                              "clientAuth": {
+                                "type": "object",
+                                "properties": {
+                                  "key": {
+                                    "description": "Optional path to client authentication key",
+                                    "type": "string"
+                                  },
+                                  "passphrase": {
+                                    "description": "Optional password for client key",
+                                    "type": "string"
+                                  },
+                                  "cert": {
+                                    "description": "Optional client certificate",
+                                    "type": "string"
+                                  }
+                                }
+                              },
+                              "sniHostName": {
+                                "description": "Optional SNI host name.",
+                                "type": "string"
+                              },
+                              "cryptoStore": {
+                                "description": "Optional crypto store configuration.",
+                                "type": "object",
+                                "properties": {
+                                  "path": {
+                                    "description": "Optional crypto store path.",
+                                    "type": "string"
+                                  },
+                                  "passphrase": {
+                                    "description": "Optional password for crypto store.",
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "clusters": {
+                            "description": "Optional additional clusters for cross-site failovers.\nArray.<Cluster>",
+                            "type": "array",
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "name": {
+                                  "description": "Optional Cluster name",
+                                  "type": "string"
+                                },
+                                "servers": {
+                                  "description": "Cluster servers details.\nArray.<ServerAddress>",
+                                  "type": "array",
+                                  "items": {
+                                    "type": "object",
+                                    "properties": {
+                                      "host": {
+                                        "description": "Infinispan cluster server host.",
+                                        "type": "string"
+                                      },
+                                      "port": {
+                                        "description": "Infinispan server port (Hot Rod protocol). Defaults to `11222`.",
+                                        "type": "number"
+                                      }
+                                    },
+                                    "required": [
+                                      "host"
+                                    ]
+                                  }
+                                }
+                              },
+                              "required": [
+                                "servers"
+                              ]
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "required": [
+                      "store"
+                    ]
                   }
                 ]
               },