@techdocs/cli 1.8.20-next.0 → 1.8.20-next.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @techdocs/cli
 
+## 1.8.20-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.5.1-next.2
+  - @backstage/plugin-techdocs-node@1.12.12-next.2
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+
+## 1.8.20-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.5.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/plugin-techdocs-node@1.12.12-next.1
+
 ## 1.8.20-next.0
 
 ### Patch Changes

package/dist/{cjs/generate-CHbYjdPP.cjs.js → commands/generate/generate.cjs.js}

@@ -1,13 +1,12 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var path = require('path');
 var fs = require('fs-extra');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var config = require('@backstage/config');
-var utility = require('./utility-CsspJYjU.cjs.js');
-require('winston');
-require('stream');
-require('process');
+var utility = require('../../lib/utility.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -78,4 +77,4 @@ async function generate(opts) {
 }
 
 exports.default = generate;
-//# sourceMappingURL=generate-CHbYjdPP.cjs.js.map
+//# sourceMappingURL=generate.cjs.js.map

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

@@ -0,0 +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,CAAA;AAErD,EAAM,MAAA,SAAA,GAAYC,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAM,MAAA,SAAA,GAAYA,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAK,CAAA,4BAAA,CAAA;AACpC,EAAA,MAAM,cAAc,IAAK,CAAA,WAAA,CAAA;AACzB,EAAA,MAAM,YAAY,IAAK,CAAA,IAAA,CAAA;AACvB,EAAA,MAAM,8BAA8B,IAAK,CAAA,2BAAA,CAAA;AACzC,EAAA,MAAM,iBAAiB,IAAK,CAAA,aAAA,CAAA;AAE5B,EAAO,MAAA,CAAA,IAAA,CAAK,CAAoB,iBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAC3C,EAAO,MAAA,CAAA,IAAA,CAAK,CAAkC,+BAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA,CAAA;AAEhE,EAAM,MAAAC,mBAAA,CAAG,UAAU,SAAS,CAAA,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,SAAA;AAAA,GACF,CAAA;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,cAAA;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC,CAAA;AAChC,EAAA,IAAI,KAAK,WAAa,EAAA;AACpB,IAAI,IAAA;AACF,MAA2B,wBAAA,GAAAC,8CAAA;AAAA,QACzB,IAAK,CAAA,WAAA;AAAA,OACP,CAAA;AAAA,aACO,GAAK,EAAA;AACZ,MAAO,MAAA,CAAA,KAAA,CAAM,IAAI,OAAO,CAAA,CAAA;AAAA,KAC1B;AAAA,GACF;AAGA,EAAA,MAAM,iBAAoB,GAAA,MAAMC,oCAAkB,CAAA,UAAA,CAAWH,QAAQ,EAAA;AAAA,IACnE,MAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAI,CAAA;AAAA,IAC1B,QAAU,EAAA,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WACL,GAAA;AAAA,MACE,wBAAA;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,gBAAA;AAAA,GACxB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGN,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACrB;;;;"}

package/dist/commands/index.cjs.js

@@ -0,0 +1,231 @@
+'use strict';
+
+var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
+
+const defaultDockerImage = pluginTechdocsNode.TechdocsGenerator.defaultDockerImage;
+const defaultPreviewAppPort = "3000";
+function registerCommands(program) {
+  program.command("generate").description("Generate TechDocs documentation site using MkDocs.").option(
+    "--source-dir <PATH>",
+    "Source directory containing mkdocs.yml and docs/ directory.",
+    "."
+  ).option(
+    "--output-dir <PATH>",
+    "Output directory containing generated TechDocs site.",
+    "./site/"
+  ).option(
+    "--docker-image <DOCKER_IMAGE>",
+    "The mkdocs docker container to use",
+    defaultDockerImage
+  ).option("--no-pull", "Do not pull the latest docker image").option(
+    "--no-docker",
+    "Do not use Docker, use MkDocs executable and plugins in current user environment."
+  ).option(
+    "--techdocs-ref <HOST_TYPE:URL>",
+    "The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\n"
+  ).option(
+    "--etag <ETAG>",
+    "A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json."
+  ).option(
+    "--site-name",
+    "Name for site when using default MkDocs config",
+    "Documentation Site"
+  ).option("-v --verbose", "Enable verbose output.", false).option(
+    "--omitTechdocsCoreMkdocsPlugin",
+    "Don't patch MkDocs file automatically with techdocs-core plugin.",
+    false
+  ).option(
+    "--legacyCopyReadmeMdToIndexMd",
+    "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.",
+    false
+  ).option(
+    "--defaultPlugin [defaultPlugins...]",
+    "Plugins which should be added automatically to the mkdocs.yaml file",
+    []
+  ).option(
+    "--runAsDefaultUser",
+    "Bypass setting the container user as the same user and group id as host for Linux and MacOS",
+    false
+  ).alias("build").action(lazy(() => Promise.resolve().then(function () { return require('./generate/generate.cjs.js'); }).then((m) => m.default)));
+  program.command("migrate").description(
+    "Migrate objects with case-sensitive entity triplets to lower-case versions."
+  ).requiredOption(
+    "--publisher-type <TYPE>",
+    "(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml"
+  ).requiredOption(
+    "--storage-name <BUCKET/CONTAINER NAME>",
+    "(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName"
+  ).option(
+    "--azureAccountName <AZURE ACCOUNT NAME>",
+    "(Required for Azure) specify when --publisher-type azureBlobStorage"
+  ).option(
+    "--azureAccountKey <AZURE ACCOUNT KEY>",
+    "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."
+  ).option(
+    "--awsRoleArn <AWS ROLE ARN>",
+    "Optional AWS ARN of role to be assumed."
+  ).option(
+    "--awsEndpoint <AWS ENDPOINT>",
+    "Optional AWS endpoint to send requests to."
+  ).option(
+    "--awsS3ForcePathStyle",
+    "Optional AWS S3 option to force path style."
+  ).option(
+    "--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osAuthUrl <OPENSTACK SWIFT AUTHURL>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--removeOriginal",
+    "Optional Files are copied by default. If flag is set, files are renamed/moved instead.",
+    false
+  ).option(
+    "--concurrency <MAX CONCURRENT REQS>",
+    "Optional Controls the number of API requests allowed to be performed simultaneously.",
+    "25"
+  ).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./migrate/migrate.cjs.js'); }).then((m) => m.default)));
+  program.command("publish").description(
+    "Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc."
+  ).requiredOption(
+    "--publisher-type <TYPE>",
+    "(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml"
+  ).requiredOption(
+    "--storage-name <BUCKET/CONTAINER NAME>",
+    "(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName"
+  ).requiredOption(
+    "--entity <NAMESPACE/KIND/NAME>",
+    "(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity "
+  ).option(
+    "--legacyUseCaseSensitiveTripletPaths",
+    "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.",
+    false
+  ).option(
+    "--azureAccountName <AZURE ACCOUNT NAME>",
+    "(Required for Azure) specify when --publisher-type azureBlobStorage"
+  ).option(
+    "--azureAccountKey <AZURE ACCOUNT KEY>",
+    "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."
+  ).option(
+    "--awsRoleArn <AWS ROLE ARN>",
+    "Optional AWS ARN of role to be assumed."
+  ).option(
+    "--awsEndpoint <AWS ENDPOINT>",
+    "Optional AWS endpoint to send requests to."
+  ).option(
+    "--awsProxy <HTTPS Proxy>",
+    "Optional Proxy to use for AWS requests."
+  ).option("--awsS3sse <AWS SSE>", "Optional AWS S3 Server Side Encryption.").option(
+    "--awsS3ForcePathStyle",
+    "Optional AWS S3 option to force path style."
+  ).option(
+    "--awsBucketRootPath <AWS BUCKET ROOT PATH>",
+    "Optional sub-directory to store files in Amazon S3"
+  ).option(
+    "--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osAuthUrl <OPENSTACK SWIFT AUTHURL>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>",
+    "(Required for OpenStack) specify when --publisher-type openStackSwift"
+  ).option(
+    "--gcsBucketRootPath <GCS BUCKET ROOT PATH>",
+    "Optional sub-directory to store files in Google cloud storage"
+  ).option(
+    "--directory <PATH>",
+    "Path of the directory containing generated files to publish",
+    "./site/"
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./publish/publish.cjs.js'); }).then((m) => m.default)));
+  program.command("serve:mkdocs").description("Serve a documentation project locally using MkDocs serve.").option(
+    "-i, --docker-image <DOCKER_IMAGE>",
+    "The mkdocs docker container to use",
+    defaultDockerImage
+  ).option(
+    "--docker-entrypoint <DOCKER_ENTRYPOINT>",
+    "Override the image entrypoint"
+  ).option(
+    "--docker-option <DOCKER_OPTION...>",
+    'Extra options to pass to the docker run command, e.g. "--add-host=internal.host:192.168.11.12" (can be added multiple times).'
+  ).option(
+    "--no-docker",
+    "Do not use Docker, run `mkdocs serve` in current user environment."
+  ).option(
+    "--site-name",
+    "Name for site when using default MkDocs config",
+    "Documentation Site"
+  ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./serve/mkdocs.cjs.js'); }).then((m) => m.default)));
+  program.command("serve").description(
+    "Serve a documentation project locally in a Backstage app-like environment"
+  ).option(
+    "-i, --docker-image <DOCKER_IMAGE>",
+    "The mkdocs docker container to use",
+    defaultDockerImage
+  ).option(
+    "--docker-entrypoint <DOCKER_ENTRYPOINT>",
+    "Override the image entrypoint"
+  ).option(
+    "--docker-option <DOCKER_OPTION...>",
+    'Extra options to pass to the docker run command, e.g. "--add-host=internal.host:192.168.11.12" (can be added multiple times).'
+  ).option(
+    "--no-docker",
+    "Do not use Docker, use MkDocs executable in current user environment."
+  ).option(
+    "--site-name",
+    "Name for site when using default MkDocs config",
+    "Documentation Site"
+  ).option("--mkdocs-port <PORT>", "Port for MkDocs server to use", "8000").option("-v --verbose", "Enable verbose output.", false).option(
+    "--preview-app-bundle-path <PATH_TO_BUNDLE>",
+    "Preview documentation using another web app"
+  ).option(
+    "--preview-app-port <PORT>",
+    "Port for the preview app to be served on",
+    defaultPreviewAppPort
+  ).option(
+    "-c, --mkdocs-config-file-name <FILENAME>",
+    "Mkdocs config file name"
+  ).option(
+    "--mkdocs-parameter-clean",
+    'Pass "--clean" parameter to mkdocs server running in containerized environment',
+    false
+  ).option(
+    "--mkdocs-parameter-dirtyreload",
+    'Pass "--dirtyreload" parameter to mkdocs server running in containerized environment',
+    false
+  ).option(
+    "--mkdocs-parameter-strict",
+    'Pass "--strict" parameter to mkdocs server running in containerized environment',
+    false
+  ).hook("preAction", (command) => {
+    if (command.opts().previewAppPort !== defaultPreviewAppPort && !command.opts().previewAppBundlePath) {
+      command.error(
+        "--preview-app-port can only be used together with --preview-app-bundle-path"
+      );
+    }
+  }).action(lazy(() => Promise.resolve().then(function () { return require('./serve/serve.cjs.js'); }).then((m) => m.default)));
+}
+function lazy(getActionFunc) {
+  return async (...args) => {
+    try {
+      const actionFunc = await getActionFunc();
+      await actionFunc(...args);
+      process.exit(0);
+    } catch (error) {
+      console.error(error.message);
+      process.exit(1);
+    }
+  };
+}
+
+exports.registerCommands = registerCommands;
+//# sourceMappingURL=index.cjs.js.map

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

@@ -0,0 +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').then(m => m.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').then(m => m.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      '--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').then(m => m.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').then(m => m.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').then(m => m.default)));\n}\n\n// Wraps an action function so that it always exits and handles errors\n// Humbly taken from backstage-cli's registerCommands\nfunction lazy(\n  getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const actionFunc = await getActionFunc();\n      await actionFunc(...args);\n      process.exit(0);\n    } catch (error) {\n      // eslint-disable-next-line no-console\n      console.error(error.message);\n      process.exit(1);\n    }\n  };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAkB,CAAA,kBAAA,CAAA;AAC7C,MAAM,qBAAwB,GAAA,MAAA,CAAA;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,GAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA,SAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA,kBAAA;AAAA,GAED,CAAA,MAAA,CAAO,WAAa,EAAA,qCAAqC,CACzD,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,mFAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sTAAA;AAAA,GAID,CAAA,MAAA;AAAA,IACC,eAAA;AAAA,IACA,qHAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA,oBAAA;AAAA,GAED,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CACtD,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA,EAAC;AAAA,GAEF,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,KAAA,CAAM,OAAO,CAAA,CACb,OAAO,IAAK,CAAA,MAAM,oDAAO,4BAAqB,MAAE,IAAK,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA,CAAA;AAExE,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC,6EAAA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA,wIAAA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA,+IAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,qEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA,sKAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA,yCAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA,4CAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA,6CAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA,IAAA;AAAA,IAED,MAAO,CAAA,cAAA,EAAgB,wBAA0B,EAAA,KAAK,EACtD,MAAO,CAAA,IAAA,CAAK,MAAM,oDAAO,0BAAmB,KAAE,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA,CAAA;AAEtE,EACG,OAAA,CAAA,OAAA,CAAQ,SAAS,CACjB,CAAA,WAAA;AAAA,IACC,iFAAA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,yBAAA;AAAA,IACA,wIAAA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,wCAAA;AAAA,IACA,+IAAA;AAAA,GAED,CAAA,cAAA;AAAA,IACC,gCAAA;AAAA,IACA,iIAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,qEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA,sKAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,6BAAA;AAAA,IACA,yCAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8BAAA;AAAA,IACA,4CAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,yCAAA;AAAA,GAED,CAAA,MAAA,CAAO,sBAAwB,EAAA,yCAAyC,CACxE,CAAA,MAAA;AAAA,IACC,uBAAA;AAAA,IACA,6CAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA,oDAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,8DAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4DAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,uCAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,4CAAA;AAAA,IACA,+DAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA,SAAA;AAAA,GAED,CAAA,MAAA,CAAO,IAAK,CAAA,MAAM,oDAAO,0BAAmB,KAAE,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAAC,CAAC,CAAA,CAAA;AAEtE,EAAA,OAAA,CACG,OAAQ,CAAA,cAAc,CACtB,CAAA,WAAA,CAAY,2DAA2D,CACvE,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA,kBAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,+BAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA,+HAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,oEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA,oBAAA;AAAA,GACF,CACC,OAAO,mBAAqB,EAAA,qCAAA,EAAuC,MAAM,CACzE,CAAA,MAAA,CAAO,cAAgB,EAAA,wBAAA,EAA0B,KAAK,CAAA,CACtD,OAAO,IAAK,CAAA,MAAM,oDAAO,uBAAgB,KAAA,CAAE,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAAC,CAAC,CAAA,CAAA;AAEnE,EACG,OAAA,CAAA,OAAA,CAAQ,OAAO,CACf,CAAA,WAAA;AAAA,IACC,2EAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA,kBAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,yCAAA;AAAA,IACA,+BAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,oCAAA;AAAA,IACA,+HAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,uEAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA,oBAAA;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,6CAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA,qBAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0CAAA;AAAA,IACA,yBAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,gFAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,sFAAA;AAAA,IACA,KAAA;AAAA,GAED,CAAA,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA,KAAA;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,6EAAA;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CACA,MAAO,CAAA,IAAA,CAAK,MAAM,oDAAO,sBAAe,KAAA,CAAE,IAAK,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,OAAO,CAAC,CAAC,CAAA,CAAA;AACpE,CAAA;AAIA,SAAS,KACP,aACoC,EAAA;AACpC,EAAA,OAAO,UAAU,IAAgB,KAAA;AAC/B,IAAI,IAAA;AACF,MAAM,MAAA,UAAA,GAAa,MAAM,aAAc,EAAA,CAAA;AACvC,MAAM,MAAA,UAAA,CAAW,GAAG,IAAI,CAAA,CAAA;AACxB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA;AAAA,aACP,KAAO,EAAA;AAEd,MAAQ,OAAA,CAAA,KAAA,CAAM,MAAM,OAAO,CAAA,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA;AAAA,KAChB;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/{cjs/migrate-Ddd_MQkE.cjs.js → commands/migrate/migrate.cjs.js}

@@ -1,13 +1,11 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var discovery = require('@backstage/backend-defaults/discovery');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
-var utility = require('./utility-CsspJYjU.cjs.js');
-var PublisherConfig = require('./PublisherConfig-Cn5i8vF5.cjs.js');
-require('winston');
-require('stream');
-require('process');
-require('@backstage/config');
+var utility = require('../../lib/utility.cjs.js');
+var PublisherConfig = require('../../lib/PublisherConfig.cjs.js');
 
 async function migrate(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
@@ -35,4 +33,4 @@ async function migrate(opts) {
 }
 
 exports.default = migrate;
-//# sourceMappingURL=migrate-Ddd_MQkE.cjs.js.map
+//# sourceMappingURL=migrate.cjs.js.map

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

@@ -0,0 +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,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA,CAAA;AAE1E,EAAI,IAAA,CAAC,UAAU,eAAiB,EAAA;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAiC,8BAAA,EAAA,IAAA,CAAK,aAAa,CAAE,CAAA,CAAA,CAAA;AAAA,GACvE;AAGA,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAM,MAAA,IAAI,MAAM,EAAE,CAAA,CAAA;AAAA,GACpB;AAGA,EAAA,MAAM,iBAAiB,IAAK,CAAA,cAAA,CAAA;AAC5B,EAAA,MAAM,kBAAqB,GAAA,QAAA,CAAS,IAAK,CAAA,WAAA,EAAa,EAAE,CAAA,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,CAAA;AAAA,KAClE,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,UAAU,eAAgB,CAAA;AAAA,IAC9B,WAAa,EAAA,kBAAA;AAAA,IACb,cAAA;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/{cjs/publish-DH7Mbt7b.cjs.js → commands/publish/publish.cjs.js}

@@ -1,14 +1,12 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var path = require('path');
-var utility = require('./utility-CsspJYjU.cjs.js');
+var utility = require('../../lib/utility.cjs.js');
 var discovery = require('@backstage/backend-defaults/discovery');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
-var PublisherConfig = require('./PublisherConfig-Cn5i8vF5.cjs.js');
-require('winston');
-require('stream');
-require('process');
-require('@backstage/config');
+var PublisherConfig = require('../../lib/PublisherConfig.cjs.js');
 
 async function publish(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
@@ -33,4 +31,4 @@ async function publish(opts) {
 }
 
 exports.default = publish;
-//# sourceMappingURL=publish-DH7Mbt7b.cjs.js.map
+//# sourceMappingURL=publish.cjs.js.map

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

@@ -0,0 +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,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAA,OAAO,OAAQ,CAAA,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA,CAAA;AAAA,GACrC;AAEA,EAAM,MAAA,CAAC,WAAW,IAAM,EAAA,IAAI,IAAI,IAAK,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AACrD,EAAA,MAAM,MAAS,GAAA;AAAA,IACb,IAAA;AAAA,IACA,QAAU,EAAA;AAAA,MACR,SAAA;AAAA,MACA,IAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,SAAA,GAAYG,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,SAAU,CAAA,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA,CAAA;AAE7C,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}

package/dist/{cjs/mkdocs-HM8xNBvh.cjs.js → commands/serve/mkdocs.cjs.js}

@@ -1,15 +1,14 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var openBrowser = require('react-dev-utils/openBrowser');
-var utility = require('./utility-CsspJYjU.cjs.js');
-var utils = require('./utils-FcpnJ4zG.cjs.js');
+var utility = require('../../lib/utility.cjs.js');
+var mkdocsServer = require('../../lib/mkdocsServer.cjs.js');
+var run = require('../../lib/run.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
-require('winston');
-require('stream');
-require('process');
-require('child_process');
-require('util');
+var utils = require('./utils.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -49,7 +48,7 @@ Starting mkdocs server on ${localAddr}
       }
     });
   };
-  const childProcess = await utils.runMkdocsServer({
+  const childProcess = await mkdocsServer.runMkdocsServer({
     port: opts.port,
     dockerImage: opts.dockerImage,
     dockerEntrypoint: opts.dockerEntrypoint,
@@ -58,7 +57,7 @@ Starting mkdocs server on ${localAddr}
     stdoutLogFunc: logFunc,
     stderrLogFunc: logFunc
   });
-  await utils.waitForSignal([childProcess]);
+  await run.waitForSignal([childProcess]);
   if (configIsTemporary) {
     process.on("exit", async () => {
       fs__default.default.rmSync(mkdocsYmlPath, {});
@@ -67,4 +66,4 @@ Starting mkdocs server on ${localAddr}
 }
 
 exports.default = serveMkdocs;
-//# sourceMappingURL=mkdocs-HM8xNBvh.cjs.js.map
+//# sourceMappingURL=mkdocs.cjs.js.map

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

@@ -0,0 +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,CAAA;AAErD,EAAM,MAAA,UAAA,GAAa,CAAkB,eAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC9C,EAAM,MAAA,SAAA,GAAY,CAAoB,iBAAA,EAAA,IAAA,CAAK,IAAI,CAAA,CAAA,CAAA;AAC/C,EAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,MAAA,GAAS,UAAa,GAAA,SAAA,CAAA;AAEnD,EAAA,IAAI,KAAK,MAAQ,EAAA;AACf,IAAM,MAAA,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAA,OAAA;AAAA,KACF;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAK,CAAA,QAAA;AAAA,GACP,CAAA;AAGA,EAAA,IAAI,wBAA2B,GAAA,KAAA,CAAA;AAE/B,EAAA,MAAM,UAAmB,CAAQ,IAAA,KAAA;AAE/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA,CAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA,OAAA;AAAA,OACF;AAGA,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,wBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,eAAe,EAAE,CAC7C,EAAA;AAEA,QAAA,MAAA,CAAO,IAAK,CAAA,CAAA;AAAA,0BAAA,EAA+B,SAAS,CAAA;AAAA,CAAI,CAAA,CAAA;AACxD,QAAAC,4BAAA,CAAY,SAAS,CAAA,CAAA;AACrB,QAA2B,wBAAA,GAAA,IAAA,CAAA;AAAA,OAC7B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;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,OAAA;AAAA,GAChB,CAAA,CAAA;AAGD,EAAM,MAAAC,iBAAA,CAAc,CAAC,YAAY,CAAC,CAAA,CAAA;AAElC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/{cjs/serve-QoNUyZPw.cjs.js → commands/serve/serve.cjs.js}

@@ -1,106 +1,24 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var path = require('path');
 var openBrowser = require('react-dev-utils/openBrowser');
 var cliCommon = require('@backstage/cli-common');
-var serveHandler = require('serve-handler');
-var http = require('http');
-var httpProxy = require('http-proxy');
-var utility = require('./utility-CsspJYjU.cjs.js');
-var utils = require('./utils-FcpnJ4zG.cjs.js');
+var httpServer = require('../../lib/httpServer.cjs.js');
+var mkdocsServer = require('../../lib/mkdocsServer.cjs.js');
+var run = require('../../lib/run.cjs.js');
+var utility = require('../../lib/utility.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
-require('winston');
-require('stream');
-require('process');
-require('child_process');
-require('util');
+var utils = require('./utils.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var path__default = /*#__PURE__*/_interopDefaultCompat(path);
 var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-var serveHandler__default = /*#__PURE__*/_interopDefaultCompat(serveHandler);
-var http__default = /*#__PURE__*/_interopDefaultCompat(http);
-var httpProxy__default = /*#__PURE__*/_interopDefaultCompat(httpProxy);
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-class HTTPServer {
-  proxyEndpoint;
-  backstageBundleDir;
-  backstagePort;
-  mkdocsTargetAddress;
-  verbose;
-  constructor(backstageBundleDir, backstagePort, mkdocsTargetAddress, verbose) {
-    this.proxyEndpoint = "/api/techdocs/";
-    this.backstageBundleDir = backstageBundleDir;
-    this.backstagePort = backstagePort;
-    this.mkdocsTargetAddress = mkdocsTargetAddress;
-    this.verbose = verbose;
-  }
-  // Create a Proxy for mkdocs server
-  createProxy() {
-    const proxy = httpProxy__default.default.createProxyServer({
-      target: this.mkdocsTargetAddress
-    });
-    return (request) => {
-      const proxyEndpointPath = new RegExp(`^${this.proxyEndpoint}`, "i");
-      const forwardPath = request.url?.replace(proxyEndpointPath, "") || "";
-      return [proxy, forwardPath];
-    };
-  }
-  async serve() {
-    return new Promise((resolve, reject) => {
-      const proxyHandler = this.createProxy();
-      const server = http__default.default.createServer(
-        (request, response) => {
-          if (request.url === "/api/techdocs/.backstage/auth/v1/cookie") {
-            const oneHourInMilliseconds = 60 * 60 * 1e3;
-            const expiresAt = new Date(Date.now() + oneHourInMilliseconds);
-            const cookie = { expiresAt: expiresAt.toISOString() };
-            response.setHeader("Content-Type", "application/json");
-            response.end(JSON.stringify(cookie));
-            return;
-          }
-          if (request.url?.startsWith(this.proxyEndpoint)) {
-            const [proxy, forwardPath] = proxyHandler(request);
-            proxy.on("error", (error) => {
-              reject(error);
-            });
-            response.setHeader("Access-Control-Allow-Origin", "*");
-            response.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
-            request.url = forwardPath;
-            proxy.web(request, response);
-            return;
-          }
-          if (request.url === "/.detect") {
-            response.setHeader("Content-Type", "text/plain");
-            response.end("techdocs-cli-server");
-            return;
-          }
-          serveHandler__default.default(request, response, {
-            public: this.backstageBundleDir,
-            trailingSlash: true,
-            rewrites: [{ source: "**", destination: "index.html" }]
-          });
-        }
-      );
-      const logger = utility.createLogger({ verbose: false });
-      server.listen(this.backstagePort, () => {
-        if (this.verbose) {
-          logger.info(
-            `[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`
-          );
-        }
-        resolve(server);
-      });
-      server.on("error", (error) => {
-        reject(error);
-      });
-    });
-  }
-}
-
 function findPreviewBundlePath() {
   try {
     return path__default.default.join(
@@ -148,7 +66,7 @@ async function serve(opts) {
     });
   };
   logger.info("Starting mkdocs server.");
-  const mkdocsChildProcess = await utils.runMkdocsServer({
+  const mkdocsChildProcess = await mkdocsServer.runMkdocsServer({
     port: opts.mkdocsPort,
     dockerImage: opts.dockerImage,
     dockerEntrypoint: opts.dockerEntrypoint,
@@ -175,13 +93,13 @@ async function serve(opts) {
   }
   const port = isDevMode ? backstageBackendPort : opts.previewAppPort;
   const previewAppPath = getPreviewAppPath(opts);
-  const httpServer = new HTTPServer(
+  const httpServer$1 = new httpServer.default(
     previewAppPath,
     port,
     mkdocsExpectedDevAddr,
     opts.verbose
   );
-  httpServer.serve().catch((err) => {
+  httpServer$1.serve().catch((err) => {
     logger.error("Failed to start HTTP server", err);
     mkdocsChildProcess.kill();
     process.exit(1);
@@ -192,7 +110,7 @@ async function serve(opts) {
 Opening browser.`
     );
   });
-  await utils.waitForSignal([mkdocsChildProcess]);
+  await run.waitForSignal([mkdocsChildProcess]);
   if (configIsTemporary) {
     process.on("exit", async () => {
       fs__default.default.rmSync(mkdocsYmlPath, {});
@@ -201,4 +119,4 @@ Opening browser.`
 }
 
 exports.default = serve;
-//# sourceMappingURL=serve-QoNUyZPw.cjs.js.map
+//# sourceMappingURL=serve.cjs.js.map