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

package/dist/index.cjs.js

@@ -1,238 +1,12 @@
 'use strict';
 
 var commander = require('commander');
-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('./cjs/generate-CHbYjdPP.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('./cjs/migrate-Ddd_MQkE.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('./cjs/publish-DH7Mbt7b.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('./cjs/mkdocs-HM8xNBvh.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('./cjs/serve-QoNUyZPw.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);
-    }
-  };
-}
-
-var version = "1.8.20-next.0";
+var index = require('./commands/index.cjs.js');
+var _package = require('./package.json.cjs.js');
 
 const main = (argv) => {
-  commander.program.name("techdocs-cli").version(version);
-  registerCommands(commander.program);
+  commander.program.name("techdocs-cli").version(_package.version);
+  index.registerCommands(commander.program);
   commander.program.parse(argv);
 };
 main(process.argv);

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/commands/index.ts","../src/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","/*\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 { program } from 'commander';\nimport { registerCommands } from './commands';\nimport { version } from '../package.json';\n\nconst main = (argv: string[]) => {\n  program.name('techdocs-cli').version(version);\n\n  registerCommands(program);\n\n  program.parse(argv);\n};\n\nmain(process.argv);\n"],"names":["TechdocsGenerator","program"],"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,gCAAqB,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,+BAAmB,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,+BAAmB,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,8BAAgB,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,6BAAe,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;;;;AChUA,MAAM,IAAA,GAAO,CAAC,IAAmB,KAAA;AAC/B,EAAAC,iBAAA,CAAQ,IAAK,CAAA,cAAc,CAAE,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AAE5C,EAAA,gBAAA,CAAiBA,iBAAO,CAAA,CAAA;AAExB,EAAAA,iBAAA,CAAQ,MAAM,IAAI,CAAA,CAAA;AACpB,CAAA,CAAA;AAEA,IAAA,CAAK,QAAQ,IAAI,CAAA;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/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 { program } from 'commander';\nimport { registerCommands } from './commands';\nimport { version } from '../package.json';\n\nconst main = (argv: string[]) => {\n  program.name('techdocs-cli').version(version);\n\n  registerCommands(program);\n\n  program.parse(argv);\n};\n\nmain(process.argv);\n"],"names":["program","version","registerCommands"],"mappings":";;;;;;AAoBA,MAAM,IAAA,GAAO,CAAC,IAAmB,KAAA;AAC/B,EAAAA,iBAAA,CAAQ,IAAK,CAAA,cAAc,CAAE,CAAA,OAAA,CAAQC,gBAAO,CAAA,CAAA;AAE5C,EAAAC,sBAAA,CAAiBF,iBAAO,CAAA,CAAA;AAExB,EAAAA,iBAAA,CAAQ,MAAM,IAAI,CAAA,CAAA;AACpB,CAAA,CAAA;AAEA,IAAA,CAAK,QAAQ,IAAI,CAAA;;"}

package/dist/{cjs/PublisherConfig-Cn5i8vF5.cjs.js → lib/PublisherConfig.cjs.js}

@@ -130,4 +130,4 @@ class PublisherConfig {
 }
 
 exports.PublisherConfig = PublisherConfig;
-//# sourceMappingURL=PublisherConfig-Cn5i8vF5.cjs.js.map
+//# sourceMappingURL=PublisherConfig.cjs.js.map

package/dist/lib/PublisherConfig.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublisherConfig.cjs.js","sources":["../../src/lib/PublisherConfig.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 { ConfigReader } from '@backstage/config';\nimport { OptionValues } from 'commander';\n\ntype Publisher = keyof (typeof PublisherConfig)['configFactories'];\ntype PublisherConfiguration = {\n  [p in Publisher]?: any;\n} & {\n  type: Publisher;\n};\n\n/**\n * Helper when working with publisher-related configurations.\n */\nexport class PublisherConfig {\n  /**\n   * Maps publisher-specific config keys to config getters.\n   */\n  private static configFactories = {\n    awsS3: PublisherConfig.getValidAwsS3Config,\n    azureBlobStorage: PublisherConfig.getValidAzureConfig,\n    googleGcs: PublisherConfig.getValidGoogleGcsConfig,\n    openStackSwift: PublisherConfig.getValidOpenStackSwiftConfig,\n  };\n\n  /**\n   * Returns Backstage config suitable for use when instantiating a Publisher. If\n   * there are any missing or invalid options provided, an error is thrown.\n   *\n   * Note: This assumes that proper credentials are set in Environment\n   * variables for the respective GCS/AWS clients to work.\n   */\n  static getValidConfig(opts: OptionValues): ConfigReader {\n    const publisherType = opts.publisherType;\n\n    if (!PublisherConfig.isKnownPublisher(publisherType)) {\n      throw new Error(`Unknown publisher type ${opts.publisherType}`);\n    }\n\n    return new ConfigReader({\n      // This backend config is not used at all. Just something needed a create a mock discovery instance.\n      backend: {\n        baseUrl: 'http://localhost:7007',\n        listen: {\n          port: 7007,\n        },\n      },\n      techdocs: {\n        publisher: PublisherConfig.configFactories[publisherType](opts),\n        legacyUseCaseSensitiveTripletPaths:\n          opts.legacyUseCaseSensitiveTripletPaths,\n      },\n    });\n  }\n\n  /**\n   * Typeguard to ensure the publisher has a known config getter.\n   */\n  private static isKnownPublisher(\n    type: string,\n  ): type is keyof (typeof PublisherConfig)['configFactories'] {\n    return PublisherConfig.configFactories.hasOwnProperty(type);\n  }\n\n  /**\n   * Retrieve valid AWS S3 configuration based on the command.\n   */\n  private static getValidAwsS3Config(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    return {\n      type: 'awsS3',\n      awsS3: {\n        bucketName: opts.storageName,\n        ...(opts.awsBucketRootPath && {\n          bucketRootPath: opts.awsBucketRootPath,\n        }),\n        ...(opts.awsRoleArn && { credentials: { roleArn: opts.awsRoleArn } }),\n        ...(opts.awsEndpoint && { endpoint: opts.awsEndpoint }),\n        ...(opts.awsS3ForcePathStyle && { s3ForcePathStyle: true }),\n        ...(opts.awsS3sse && { sse: opts.awsS3sse }),\n        ...(opts.awsProxy && { httpsProxy: opts.awsProxy }),\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid Azure Blob Storage configuration based on the command.\n   */\n  private static getValidAzureConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    if (!opts.azureAccountName) {\n      throw new Error(\n        `azureBlobStorage requires --azureAccountName to be specified`,\n      );\n    }\n\n    return {\n      type: 'azureBlobStorage',\n      azureBlobStorage: {\n        containerName: opts.storageName,\n        credentials: {\n          accountName: opts.azureAccountName,\n          accountKey: opts.azureAccountKey,\n        },\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid GCS configuration based on the command.\n   */\n  private static getValidGoogleGcsConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    return {\n      type: 'googleGcs',\n      googleGcs: {\n        bucketName: opts.storageName,\n        ...(opts.gcsBucketRootPath && {\n          bucketRootPath: opts.gcsBucketRootPath,\n        }),\n      },\n    };\n  }\n\n  /**\n   * Retrieves valid OpenStack Swift configuration based on the command.\n   */\n  private static getValidOpenStackSwiftConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    const missingParams = [\n      'osCredentialId',\n      'osSecret',\n      'osAuthUrl',\n      'osSwiftUrl',\n    ].filter((param: string) => !opts[param]);\n\n    if (missingParams.length) {\n      throw new Error(\n        `openStackSwift requires the following params to be specified: ${missingParams.join(\n          ', ',\n        )}`,\n      );\n    }\n\n    return {\n      type: 'openStackSwift',\n      openStackSwift: {\n        containerName: opts.storageName,\n        credentials: {\n          id: opts.osCredentialId,\n          secret: opts.osSecret,\n        },\n        authUrl: opts.osAuthUrl,\n        swiftUrl: opts.osSwiftUrl,\n      },\n    };\n  }\n}\n"],"names":["ConfigReader"],"mappings":";;;;AA6BO,MAAM,eAAgB,CAAA;AAAA;AAAA;AAAA;AAAA,EAI3B,OAAe,eAAkB,GAAA;AAAA,IAC/B,OAAO,eAAgB,CAAA,mBAAA;AAAA,IACvB,kBAAkB,eAAgB,CAAA,mBAAA;AAAA,IAClC,WAAW,eAAgB,CAAA,uBAAA;AAAA,IAC3B,gBAAgB,eAAgB,CAAA,4BAAA;AAAA,GAClC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,eAAe,IAAkC,EAAA;AACtD,IAAA,MAAM,gBAAgB,IAAK,CAAA,aAAA,CAAA;AAE3B,IAAA,IAAI,CAAC,eAAA,CAAgB,gBAAiB,CAAA,aAAa,CAAG,EAAA;AACpD,MAAA,MAAM,IAAI,KAAA,CAAM,CAA0B,uBAAA,EAAA,IAAA,CAAK,aAAa,CAAE,CAAA,CAAA,CAAA;AAAA,KAChE;AAEA,IAAA,OAAO,IAAIA,mBAAa,CAAA;AAAA;AAAA,MAEtB,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,uBAAA;AAAA,QACT,MAAQ,EAAA;AAAA,UACN,IAAM,EAAA,IAAA;AAAA,SACR;AAAA,OACF;AAAA,MACA,QAAU,EAAA;AAAA,QACR,SAAW,EAAA,eAAA,CAAgB,eAAgB,CAAA,aAAa,EAAE,IAAI,CAAA;AAAA,QAC9D,oCACE,IAAK,CAAA,kCAAA;AAAA,OACT;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe,iBACb,IAC2D,EAAA;AAC3D,IAAO,OAAA,eAAA,CAAgB,eAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAAA,GAC5D;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe,oBACb,IACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,OAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,YAAY,IAAK,CAAA,WAAA;AAAA,QACjB,GAAI,KAAK,iBAAqB,IAAA;AAAA,UAC5B,gBAAgB,IAAK,CAAA,iBAAA;AAAA,SACvB;AAAA,QACA,GAAI,KAAK,UAAc,IAAA,EAAE,aAAa,EAAE,OAAA,EAAS,IAAK,CAAA,UAAA,EAAa,EAAA;AAAA,QACnE,GAAI,IAAK,CAAA,WAAA,IAAe,EAAE,QAAA,EAAU,KAAK,WAAY,EAAA;AAAA,QACrD,GAAI,IAAA,CAAK,mBAAuB,IAAA,EAAE,kBAAkB,IAAK,EAAA;AAAA,QACzD,GAAI,IAAK,CAAA,QAAA,IAAY,EAAE,GAAA,EAAK,KAAK,QAAS,EAAA;AAAA,QAC1C,GAAI,IAAK,CAAA,QAAA,IAAY,EAAE,UAAA,EAAY,KAAK,QAAS,EAAA;AAAA,OACnD;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe,oBACb,IACwB,EAAA;AACxB,IAAI,IAAA,CAAC,KAAK,gBAAkB,EAAA;AAC1B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,4DAAA,CAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,kBAAA;AAAA,MACN,gBAAkB,EAAA;AAAA,QAChB,eAAe,IAAK,CAAA,WAAA;AAAA,QACpB,WAAa,EAAA;AAAA,UACX,aAAa,IAAK,CAAA,gBAAA;AAAA,UAClB,YAAY,IAAK,CAAA,eAAA;AAAA,SACnB;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe,wBACb,IACwB,EAAA;AACxB,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,WAAA;AAAA,MACN,SAAW,EAAA;AAAA,QACT,YAAY,IAAK,CAAA,WAAA;AAAA,QACjB,GAAI,KAAK,iBAAqB,IAAA;AAAA,UAC5B,gBAAgB,IAAK,CAAA,iBAAA;AAAA,SACvB;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe,6BACb,IACwB,EAAA;AACxB,IAAA,MAAM,aAAgB,GAAA;AAAA,MACpB,gBAAA;AAAA,MACA,UAAA;AAAA,MACA,WAAA;AAAA,MACA,YAAA;AAAA,MACA,MAAO,CAAA,CAAC,UAAkB,CAAC,IAAA,CAAK,KAAK,CAAC,CAAA,CAAA;AAExC,IAAA,IAAI,cAAc,MAAQ,EAAA;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,iEAAiE,aAAc,CAAA,IAAA;AAAA,UAC7E,IAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,gBAAA;AAAA,MACN,cAAgB,EAAA;AAAA,QACd,eAAe,IAAK,CAAA,WAAA;AAAA,QACpB,WAAa,EAAA;AAAA,UACX,IAAI,IAAK,CAAA,cAAA;AAAA,UACT,QAAQ,IAAK,CAAA,QAAA;AAAA,SACf;AAAA,QACA,SAAS,IAAK,CAAA,SAAA;AAAA,QACd,UAAU,IAAK,CAAA,UAAA;AAAA,OACjB;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/lib/httpServer.cjs.js

@@ -0,0 +1,93 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var serveHandler = require('serve-handler');
+var http = require('http');
+var httpProxy = require('http-proxy');
+var utility = require('./utility.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var serveHandler__default = /*#__PURE__*/_interopDefaultCompat(serveHandler);
+var http__default = /*#__PURE__*/_interopDefaultCompat(http);
+var httpProxy__default = /*#__PURE__*/_interopDefaultCompat(httpProxy);
+
+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);
+      });
+    });
+  }
+}
+
+exports.default = HTTPServer;
+//# sourceMappingURL=httpServer.cjs.js.map

package/dist/lib/httpServer.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpServer.cjs.js","sources":["../../src/lib/httpServer.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 serveHandler from 'serve-handler';\nimport http from 'http';\nimport httpProxy from 'http-proxy';\nimport { createLogger } from './utility';\n\nexport default class HTTPServer {\n  private readonly proxyEndpoint: string;\n  private readonly backstageBundleDir: string;\n  private readonly backstagePort: number;\n  private readonly mkdocsTargetAddress: string;\n  private readonly verbose: boolean;\n\n  constructor(\n    backstageBundleDir: string,\n    backstagePort: number,\n    mkdocsTargetAddress: string,\n    verbose: boolean,\n  ) {\n    this.proxyEndpoint = '/api/techdocs/';\n    this.backstageBundleDir = backstageBundleDir;\n    this.backstagePort = backstagePort;\n    this.mkdocsTargetAddress = mkdocsTargetAddress;\n    this.verbose = verbose;\n  }\n\n  // Create a Proxy for mkdocs server\n  private createProxy() {\n    const proxy = httpProxy.createProxyServer({\n      target: this.mkdocsTargetAddress,\n    });\n\n    return (request: http.IncomingMessage): [httpProxy, string] => {\n      // If the request path is prefixed with this.proxyEndpoint, remove it.\n      const proxyEndpointPath = new RegExp(`^${this.proxyEndpoint}`, 'i');\n      const forwardPath = request.url?.replace(proxyEndpointPath, '') || '';\n\n      return [proxy, forwardPath];\n    };\n  }\n\n  public async serve(): Promise<http.Server> {\n    return new Promise<http.Server>((resolve, reject) => {\n      const proxyHandler = this.createProxy();\n      const server = http.createServer(\n        (request: http.IncomingMessage, response: http.ServerResponse) => {\n          // This endpoind is used by the frontend to issue a cookie for the user.\n          // But the MkDocs server doesn't expose it as a the Backestage backend does.\n          // So we need to fake it here to prevent 404 errors.\n          if (request.url === '/api/techdocs/.backstage/auth/v1/cookie') {\n            const oneHourInMilliseconds = 60 * 60 * 1000;\n            const expiresAt = new Date(Date.now() + oneHourInMilliseconds);\n            const cookie = { expiresAt: expiresAt.toISOString() };\n            response.setHeader('Content-Type', 'application/json');\n            response.end(JSON.stringify(cookie));\n            return;\n          }\n\n          if (request.url?.startsWith(this.proxyEndpoint)) {\n            const [proxy, forwardPath] = proxyHandler(request);\n\n            proxy.on('error', (error: Error) => {\n              reject(error);\n            });\n\n            response.setHeader('Access-Control-Allow-Origin', '*');\n            response.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');\n\n            request.url = forwardPath;\n            proxy.web(request, response);\n            return;\n          }\n\n          // This endpoint is used by the frontend to detect where the backend is running.\n          if (request.url === '/.detect') {\n            response.setHeader('Content-Type', 'text/plain');\n            response.end('techdocs-cli-server');\n            return;\n          }\n\n          serveHandler(request, response, {\n            public: this.backstageBundleDir,\n            trailingSlash: true,\n            rewrites: [{ source: '**', destination: 'index.html' }],\n          });\n        },\n      );\n\n      const logger = createLogger({ verbose: false });\n      server.listen(this.backstagePort, () => {\n        if (this.verbose) {\n          logger.info(\n            `[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`,\n          );\n        }\n        resolve(server);\n      });\n\n      server.on('error', (error: Error) => {\n        reject(error);\n      });\n    });\n  }\n}\n"],"names":["httpProxy","http","serveHandler","createLogger"],"mappings":";;;;;;;;;;;;;;;AAqBA,MAAqB,UAAW,CAAA;AAAA,EACb,aAAA,CAAA;AAAA,EACA,kBAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,mBAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EAEjB,WACE,CAAA,kBAAA,EACA,aACA,EAAA,mBAAA,EACA,OACA,EAAA;AACA,IAAA,IAAA,CAAK,aAAgB,GAAA,gBAAA,CAAA;AACrB,IAAA,IAAA,CAAK,kBAAqB,GAAA,kBAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,aAAgB,GAAA,aAAA,CAAA;AACrB,IAAA,IAAA,CAAK,mBAAsB,GAAA,mBAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AAAA,GACjB;AAAA;AAAA,EAGQ,WAAc,GAAA;AACpB,IAAM,MAAA,KAAA,GAAQA,2BAAU,iBAAkB,CAAA;AAAA,MACxC,QAAQ,IAAK,CAAA,mBAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAA,OAAO,CAAC,OAAuD,KAAA;AAE7D,MAAA,MAAM,oBAAoB,IAAI,MAAA,CAAO,IAAI,IAAK,CAAA,aAAa,IAAI,GAAG,CAAA,CAAA;AAClE,MAAA,MAAM,cAAc,OAAQ,CAAA,GAAA,EAAK,OAAQ,CAAA,iBAAA,EAAmB,EAAE,CAAK,IAAA,EAAA,CAAA;AAEnE,MAAO,OAAA,CAAC,OAAO,WAAW,CAAA,CAAA;AAAA,KAC5B,CAAA;AAAA,GACF;AAAA,EAEA,MAAa,KAA8B,GAAA;AACzC,IAAA,OAAO,IAAI,OAAA,CAAqB,CAAC,OAAA,EAAS,MAAW,KAAA;AACnD,MAAM,MAAA,YAAA,GAAe,KAAK,WAAY,EAAA,CAAA;AACtC,MAAA,MAAM,SAASC,qBAAK,CAAA,YAAA;AAAA,QAClB,CAAC,SAA+B,QAAkC,KAAA;AAIhE,UAAI,IAAA,OAAA,CAAQ,QAAQ,yCAA2C,EAAA;AAC7D,YAAM,MAAA,qBAAA,GAAwB,KAAK,EAAK,GAAA,GAAA,CAAA;AACxC,YAAA,MAAM,YAAY,IAAI,IAAA,CAAK,IAAK,CAAA,GAAA,KAAQ,qBAAqB,CAAA,CAAA;AAC7D,YAAA,MAAM,MAAS,GAAA,EAAE,SAAW,EAAA,SAAA,CAAU,aAAc,EAAA,CAAA;AACpD,YAAS,QAAA,CAAA,SAAA,CAAU,gBAAgB,kBAAkB,CAAA,CAAA;AACrD,YAAA,QAAA,CAAS,GAAI,CAAA,IAAA,CAAK,SAAU,CAAA,MAAM,CAAC,CAAA,CAAA;AACnC,YAAA,OAAA;AAAA,WACF;AAEA,UAAA,IAAI,OAAQ,CAAA,GAAA,EAAK,UAAW,CAAA,IAAA,CAAK,aAAa,CAAG,EAAA;AAC/C,YAAA,MAAM,CAAC,KAAA,EAAO,WAAW,CAAA,GAAI,aAAa,OAAO,CAAA,CAAA;AAEjD,YAAM,KAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AAClC,cAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,aACb,CAAA,CAAA;AAED,YAAS,QAAA,CAAA,SAAA,CAAU,+BAA+B,GAAG,CAAA,CAAA;AACrD,YAAS,QAAA,CAAA,SAAA,CAAU,gCAAgC,cAAc,CAAA,CAAA;AAEjE,YAAA,OAAA,CAAQ,GAAM,GAAA,WAAA,CAAA;AACd,YAAM,KAAA,CAAA,GAAA,CAAI,SAAS,QAAQ,CAAA,CAAA;AAC3B,YAAA,OAAA;AAAA,WACF;AAGA,UAAI,IAAA,OAAA,CAAQ,QAAQ,UAAY,EAAA;AAC9B,YAAS,QAAA,CAAA,SAAA,CAAU,gBAAgB,YAAY,CAAA,CAAA;AAC/C,YAAA,QAAA,CAAS,IAAI,qBAAqB,CAAA,CAAA;AAClC,YAAA,OAAA;AAAA,WACF;AAEA,UAAAC,6BAAA,CAAa,SAAS,QAAU,EAAA;AAAA,YAC9B,QAAQ,IAAK,CAAA,kBAAA;AAAA,YACb,aAAe,EAAA,IAAA;AAAA,YACf,UAAU,CAAC,EAAE,QAAQ,IAAM,EAAA,WAAA,EAAa,cAAc,CAAA;AAAA,WACvD,CAAA,CAAA;AAAA,SACH;AAAA,OACF,CAAA;AAEA,MAAA,MAAM,MAAS,GAAAC,oBAAA,CAAa,EAAE,OAAA,EAAS,OAAO,CAAA,CAAA;AAC9C,MAAO,MAAA,CAAA,MAAA,CAAO,IAAK,CAAA,aAAA,EAAe,MAAM;AACtC,QAAA,IAAI,KAAK,OAAS,EAAA;AAChB,UAAO,MAAA,CAAA,IAAA;AAAA,YACL,CAAA,iFAAA,EAAoF,KAAK,aAAa,CAAA,CAAA;AAAA,WACxG,CAAA;AAAA,SACF;AACA,QAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AAAA,OACf,CAAA,CAAA;AAED,MAAO,MAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAiB,KAAA;AACnC,QAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,OACb,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/lib/mkdocsServer.cjs.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var run = require('./run.cjs.js');
+
+const runMkdocsServer = async (options) => {
+  const port = options.port ?? "8000";
+  const useDocker = options.useDocker ?? true;
+  const dockerImage = options.dockerImage ?? "spotify/techdocs";
+  if (useDocker) {
+    return await run.run(
+      "docker",
+      [
+        "run",
+        "--rm",
+        "-w",
+        "/content",
+        "-v",
+        `${process.cwd()}:/content`,
+        "-p",
+        `${port}:${port}`,
+        "-it",
+        ...options.dockerEntrypoint ? ["--entrypoint", options.dockerEntrypoint] : [],
+        ...options.dockerOptions || [],
+        dockerImage,
+        "serve",
+        "--dev-addr",
+        `0.0.0.0:${port}`,
+        ...options.mkdocsConfigFileName ? ["--config-file", options.mkdocsConfigFileName] : [],
+        ...options.mkdocsParameterClean ? ["--clean"] : [],
+        ...options.mkdocsParameterDirtyReload ? ["--dirtyreload"] : [],
+        ...options.mkdocsParameterStrict ? ["--strict"] : []
+      ],
+      {
+        stdoutLogFunc: options.stdoutLogFunc,
+        stderrLogFunc: options.stderrLogFunc
+      }
+    );
+  }
+  return await run.run(
+    "mkdocs",
+    [
+      "serve",
+      "--dev-addr",
+      `127.0.0.1:${port}`,
+      ...options.mkdocsConfigFileName ? ["--config-file", options.mkdocsConfigFileName] : [],
+      ...options.mkdocsParameterClean ? ["--clean"] : [],
+      ...options.mkdocsParameterDirtyReload ? ["--dirtyreload"] : [],
+      ...options.mkdocsParameterStrict ? ["--strict"] : []
+    ],
+    {
+      stdoutLogFunc: options.stdoutLogFunc,
+      stderrLogFunc: options.stderrLogFunc
+    }
+  );
+};
+
+exports.runMkdocsServer = runMkdocsServer;
+//# sourceMappingURL=mkdocsServer.cjs.js.map

package/dist/lib/mkdocsServer.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocsServer.cjs.js","sources":["../../src/lib/mkdocsServer.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 { ChildProcess } from 'child_process';\nimport { run, LogFunc } from './run';\n\nexport const runMkdocsServer = async (options: {\n  port?: string;\n  useDocker?: boolean;\n  dockerImage?: string;\n  dockerEntrypoint?: string;\n  dockerOptions?: string[];\n  stdoutLogFunc?: LogFunc;\n  stderrLogFunc?: LogFunc;\n  mkdocsConfigFileName?: string;\n  mkdocsParameterClean?: boolean;\n  mkdocsParameterDirtyReload?: boolean;\n  mkdocsParameterStrict?: boolean;\n}): Promise<ChildProcess> => {\n  const port = options.port ?? '8000';\n  const useDocker = options.useDocker ?? true;\n  const dockerImage = options.dockerImage ?? 'spotify/techdocs';\n\n  if (useDocker) {\n    return await run(\n      'docker',\n      [\n        'run',\n        '--rm',\n        '-w',\n        '/content',\n        '-v',\n        `${process.cwd()}:/content`,\n        '-p',\n        `${port}:${port}`,\n        '-it',\n        ...(options.dockerEntrypoint\n          ? ['--entrypoint', options.dockerEntrypoint]\n          : []),\n        ...(options.dockerOptions || []),\n        dockerImage,\n        'serve',\n        '--dev-addr',\n        `0.0.0.0:${port}`,\n        ...(options.mkdocsConfigFileName\n          ? ['--config-file', options.mkdocsConfigFileName]\n          : []),\n        ...(options.mkdocsParameterClean ? ['--clean'] : []),\n        ...(options.mkdocsParameterDirtyReload ? ['--dirtyreload'] : []),\n        ...(options.mkdocsParameterStrict ? ['--strict'] : []),\n      ],\n      {\n        stdoutLogFunc: options.stdoutLogFunc,\n        stderrLogFunc: options.stderrLogFunc,\n      },\n    );\n  }\n\n  return await run(\n    'mkdocs',\n    [\n      'serve',\n      '--dev-addr',\n      `127.0.0.1:${port}`,\n      ...(options.mkdocsConfigFileName\n        ? ['--config-file', options.mkdocsConfigFileName]\n        : []),\n      ...(options.mkdocsParameterClean ? ['--clean'] : []),\n      ...(options.mkdocsParameterDirtyReload ? ['--dirtyreload'] : []),\n      ...(options.mkdocsParameterStrict ? ['--strict'] : []),\n    ],\n    {\n      stdoutLogFunc: options.stdoutLogFunc,\n      stderrLogFunc: options.stderrLogFunc,\n    },\n  );\n};\n"],"names":["run"],"mappings":";;;;AAmBa,MAAA,eAAA,GAAkB,OAAO,OAYT,KAAA;AAC3B,EAAM,MAAA,IAAA,GAAO,QAAQ,IAAQ,IAAA,MAAA,CAAA;AAC7B,EAAM,MAAA,SAAA,GAAY,QAAQ,SAAa,IAAA,IAAA,CAAA;AACvC,EAAM,MAAA,WAAA,GAAc,QAAQ,WAAe,IAAA,kBAAA,CAAA;AAE3C,EAAA,IAAI,SAAW,EAAA;AACb,IAAA,OAAO,MAAMA,OAAA;AAAA,MACX,QAAA;AAAA,MACA;AAAA,QACE,KAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,UAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAA,EAAG,OAAQ,CAAA,GAAA,EAAK,CAAA,SAAA,CAAA;AAAA,QAChB,IAAA;AAAA,QACA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACf,KAAA;AAAA,QACA,GAAI,QAAQ,gBACR,GAAA,CAAC,gBAAgB,OAAQ,CAAA,gBAAgB,IACzC,EAAC;AAAA,QACL,GAAI,OAAQ,CAAA,aAAA,IAAiB,EAAC;AAAA,QAC9B,WAAA;AAAA,QACA,OAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAW,IAAI,CAAA,CAAA;AAAA,QACf,GAAI,QAAQ,oBACR,GAAA,CAAC,iBAAiB,OAAQ,CAAA,oBAAoB,IAC9C,EAAC;AAAA,QACL,GAAI,OAAQ,CAAA,oBAAA,GAAuB,CAAC,SAAS,IAAI,EAAC;AAAA,QAClD,GAAI,OAAQ,CAAA,0BAAA,GAA6B,CAAC,eAAe,IAAI,EAAC;AAAA,QAC9D,GAAI,OAAQ,CAAA,qBAAA,GAAwB,CAAC,UAAU,IAAI,EAAC;AAAA,OACtD;AAAA,MACA;AAAA,QACE,eAAe,OAAQ,CAAA,aAAA;AAAA,QACvB,eAAe,OAAQ,CAAA,aAAA;AAAA,OACzB;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,MAAMA,OAAA;AAAA,IACX,QAAA;AAAA,IACA;AAAA,MACE,OAAA;AAAA,MACA,YAAA;AAAA,MACA,aAAa,IAAI,CAAA,CAAA;AAAA,MACjB,GAAI,QAAQ,oBACR,GAAA,CAAC,iBAAiB,OAAQ,CAAA,oBAAoB,IAC9C,EAAC;AAAA,MACL,GAAI,OAAQ,CAAA,oBAAA,GAAuB,CAAC,SAAS,IAAI,EAAC;AAAA,MAClD,GAAI,OAAQ,CAAA,0BAAA,GAA6B,CAAC,eAAe,IAAI,EAAC;AAAA,MAC9D,GAAI,OAAQ,CAAA,qBAAA,GAAwB,CAAC,UAAU,IAAI,EAAC;AAAA,KACtD;AAAA,IACA;AAAA,MACE,eAAe,OAAQ,CAAA,aAAA;AAAA,MACvB,eAAe,OAAQ,CAAA,aAAA;AAAA,KACzB;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/lib/run.cjs.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var child_process = require('child_process');
+
+const run = async (name, args = [], options = {}) => {
+  const { stdoutLogFunc, stderrLogFunc } = options;
+  const env = {
+    ...process.env,
+    FORCE_COLOR: "true",
+    ...options.env ?? {}
+  };
+  const stdio = [
+    "inherit",
+    stdoutLogFunc ? "pipe" : "inherit",
+    stderrLogFunc ? "pipe" : "inherit"
+  ];
+  const childProcess = child_process.spawn(name, args, {
+    stdio,
+    ...options,
+    env
+  });
+  if (stdoutLogFunc && childProcess.stdout) {
+    childProcess.stdout.on("data", stdoutLogFunc);
+  }
+  if (stderrLogFunc && childProcess.stderr) {
+    childProcess.stderr.on("data", stderrLogFunc);
+  }
+  return childProcess;
+};
+async function waitForSignal(childProcesses) {
+  const promises = [];
+  for (const signal of ["SIGINT", "SIGTERM"]) {
+    process.on(signal, () => {
+      childProcesses.forEach((childProcess) => {
+        childProcess.kill();
+      });
+    });
+  }
+  childProcesses.forEach((childProcess) => {
+    if (typeof childProcess.exitCode === "number") {
+      if (childProcess.exitCode) {
+        throw new Error(`Non zero exit code from child process`);
+      }
+      return;
+    }
+    promises.push(
+      new Promise((resolve, reject) => {
+        childProcess.once("error", reject);
+        childProcess.once("exit", resolve);
+      })
+    );
+  });
+  await Promise.all(promises);
+}
+
+exports.run = run;
+exports.waitForSignal = waitForSignal;
+//# sourceMappingURL=run.cjs.js.map

package/dist/lib/run.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.cjs.js","sources":["../../src/lib/run.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 */\nimport { spawn, SpawnOptions, ChildProcess } from 'child_process';\n\nexport type LogFunc = (data: Buffer | string) => void;\ntype SpawnOptionsPartialEnv = Omit<SpawnOptions, 'env'> & {\n  env?: Partial<NodeJS.ProcessEnv>;\n  // Pipe stdout to this log function\n  stdoutLogFunc?: LogFunc;\n  // Pipe stderr to this log function\n  stderrLogFunc?: LogFunc;\n};\n\n// TODO: Accept log functions to pipe logs with.\n// Runs a child command, returning the child process instance.\n// Use it along with waitForSignal to run a long running process e.g. mkdocs serve\nexport const run = async (\n  name: string,\n  args: string[] = [],\n  options: SpawnOptionsPartialEnv = {},\n): Promise<ChildProcess> => {\n  const { stdoutLogFunc, stderrLogFunc } = options;\n\n  const env: NodeJS.ProcessEnv = {\n    ...process.env,\n    FORCE_COLOR: 'true',\n    ...(options.env ?? {}),\n  };\n\n  // Refer: https://nodejs.org/api/child_process.html#child_process_subprocess_stdio\n  const stdio = [\n    'inherit',\n    stdoutLogFunc ? 'pipe' : 'inherit',\n    stderrLogFunc ? 'pipe' : 'inherit',\n  ] as ('inherit' | 'pipe')[];\n\n  const childProcess = spawn(name, args, {\n    stdio: stdio,\n    ...options,\n    env,\n  });\n\n  if (stdoutLogFunc && childProcess.stdout) {\n    childProcess.stdout.on('data', stdoutLogFunc);\n  }\n  if (stderrLogFunc && childProcess.stderr) {\n    childProcess.stderr.on('data', stderrLogFunc);\n  }\n\n  return childProcess;\n};\n\n// Block indefinitely and wait for a signal to stop the child process(es)\n// Throw error if any child process errors\n// Resolves only when all processes exit with status code 0\nexport async function waitForSignal(\n  childProcesses: Array<ChildProcess>,\n): Promise<void> {\n  const promises: Array<Promise<void>> = [];\n\n  for (const signal of ['SIGINT', 'SIGTERM'] as const) {\n    process.on(signal, () => {\n      childProcesses.forEach(childProcess => {\n        childProcess.kill();\n      });\n    });\n  }\n\n  childProcesses.forEach(childProcess => {\n    if (typeof childProcess.exitCode === 'number') {\n      if (childProcess.exitCode) {\n        throw new Error(`Non zero exit code from child process`);\n      }\n      return;\n    }\n\n    promises.push(\n      new Promise<void>((resolve, reject) => {\n        childProcess.once('error', reject);\n        childProcess.once('exit', resolve);\n      }),\n    );\n  });\n\n  await Promise.all(promises);\n}\n"],"names":["spawn"],"mappings":";;;;AA6Ba,MAAA,GAAA,GAAM,OACjB,IACA,EAAA,IAAA,GAAiB,EACjB,EAAA,OAAA,GAAkC,EACR,KAAA;AAC1B,EAAM,MAAA,EAAE,aAAe,EAAA,aAAA,EAAkB,GAAA,OAAA,CAAA;AAEzC,EAAA,MAAM,GAAyB,GAAA;AAAA,IAC7B,GAAG,OAAQ,CAAA,GAAA;AAAA,IACX,WAAa,EAAA,MAAA;AAAA,IACb,GAAI,OAAQ,CAAA,GAAA,IAAO,EAAC;AAAA,GACtB,CAAA;AAGA,EAAA,MAAM,KAAQ,GAAA;AAAA,IACZ,SAAA;AAAA,IACA,gBAAgB,MAAS,GAAA,SAAA;AAAA,IACzB,gBAAgB,MAAS,GAAA,SAAA;AAAA,GAC3B,CAAA;AAEA,EAAM,MAAA,YAAA,GAAeA,mBAAM,CAAA,IAAA,EAAM,IAAM,EAAA;AAAA,IACrC,KAAA;AAAA,IACA,GAAG,OAAA;AAAA,IACH,GAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA,aAAA,IAAiB,aAAa,MAAQ,EAAA;AACxC,IAAa,YAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,aAAa,CAAA,CAAA;AAAA,GAC9C;AACA,EAAI,IAAA,aAAA,IAAiB,aAAa,MAAQ,EAAA;AACxC,IAAa,YAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,aAAa,CAAA,CAAA;AAAA,GAC9C;AAEA,EAAO,OAAA,YAAA,CAAA;AACT,EAAA;AAKA,eAAsB,cACpB,cACe,EAAA;AACf,EAAA,MAAM,WAAiC,EAAC,CAAA;AAExC,EAAA,KAAA,MAAW,MAAU,IAAA,CAAC,QAAU,EAAA,SAAS,CAAY,EAAA;AACnD,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,MAAM;AACvB,MAAA,cAAA,CAAe,QAAQ,CAAgB,YAAA,KAAA;AACrC,QAAA,YAAA,CAAa,IAAK,EAAA,CAAA;AAAA,OACnB,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,cAAA,CAAe,QAAQ,CAAgB,YAAA,KAAA;AACrC,IAAI,IAAA,OAAO,YAAa,CAAA,QAAA,KAAa,QAAU,EAAA;AAC7C,MAAA,IAAI,aAAa,QAAU,EAAA;AACzB,QAAM,MAAA,IAAI,MAAM,CAAuC,qCAAA,CAAA,CAAA,CAAA;AAAA,OACzD;AACA,MAAA,OAAA;AAAA,KACF;AAEA,IAAS,QAAA,CAAA,IAAA;AAAA,MACP,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AACrC,QAAa,YAAA,CAAA,IAAA,CAAK,SAAS,MAAM,CAAA,CAAA;AACjC,QAAa,YAAA,CAAA,IAAA,CAAK,QAAQ,OAAO,CAAA,CAAA;AAAA,OAClC,CAAA;AAAA,KACH,CAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,OAAA,CAAQ,IAAI,QAAQ,CAAA,CAAA;AAC5B;;;;;"}

package/dist/{cjs/utility-CsspJYjU.cjs.js → lib/utility.cjs.js}

@@ -60,4 +60,4 @@ const getLogStream = (logger) => {
 exports.convertTechDocsRefToLocationAnnotation = convertTechDocsRefToLocationAnnotation;
 exports.createLogger = createLogger;
 exports.getLogStream = getLogStream;
-//# sourceMappingURL=utility-CsspJYjU.cjs.js.map
+//# sourceMappingURL=utility.cjs.js.map

package/dist/lib/utility.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.cjs.js","sources":["../../src/lib/utility.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 */\nimport {\n  RemoteProtocol,\n  ParsedLocationAnnotation,\n} from '@backstage/plugin-techdocs-node';\nimport * as winston from 'winston';\nimport { Writable } from 'stream';\nimport { stdout } from 'process';\n\nexport const convertTechDocsRefToLocationAnnotation = (\n  techdocsRef: string,\n): ParsedLocationAnnotation => {\n  // Split on the first colon for the protocol and the rest after the first split\n  // is the location.\n  const [type, target] = techdocsRef.split(/:(.+)/) as [\n    RemoteProtocol?,\n    string?,\n  ];\n\n  if (!type || !target) {\n    throw new Error(\n      `Can not parse --techdocs-ref ${techdocsRef}. Should be of type HOST:URL.`,\n    );\n  }\n\n  return { type, target };\n};\n\nexport const createLogger = ({\n  verbose = false,\n}: {\n  verbose: boolean;\n}): winston.Logger => {\n  const logger = winston.createLogger({\n    level: verbose ? 'verbose' : 'info',\n    transports: [\n      new winston.transports.Console({ format: winston.format.simple() }),\n    ],\n  });\n\n  return logger;\n};\n\nexport const getLogStream = (logger: winston.Logger): Writable => {\n  if (process.env.LOG_LEVEL === 'debug') {\n    return stdout;\n  }\n\n  return new Writable({\n    defaultEncoding: 'utf8',\n    write(chunk, _encoding, next) {\n      logger.verbose(chunk.toString().trim());\n      next();\n    },\n  });\n};\n"],"names":["winston","stdout","Writable"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAuBa,MAAA,sCAAA,GAAyC,CACpD,WAC6B,KAAA;AAG7B,EAAA,MAAM,CAAC,IAAM,EAAA,MAAM,CAAI,GAAA,WAAA,CAAY,MAAM,OAAO,CAAA,CAAA;AAKhD,EAAI,IAAA,CAAC,IAAQ,IAAA,CAAC,MAAQ,EAAA;AACpB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gCAAgC,WAAW,CAAA,6BAAA,CAAA;AAAA,KAC7C,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,EAAE,MAAM,MAAO,EAAA,CAAA;AACxB,EAAA;AAEO,MAAM,eAAe,CAAC;AAAA,EAC3B,OAAU,GAAA,KAAA;AACZ,CAEsB,KAAA;AACpB,EAAM,MAAA,MAAA,GAASA,mBAAQ,YAAa,CAAA;AAAA,IAClC,KAAA,EAAO,UAAU,SAAY,GAAA,MAAA;AAAA,IAC7B,UAAY,EAAA;AAAA,MACV,IAAIA,kBAAQ,CAAA,UAAA,CAAW,OAAQ,CAAA,EAAE,QAAQA,kBAAQ,CAAA,MAAA,CAAO,MAAO,EAAA,EAAG,CAAA;AAAA,KACpE;AAAA,GACD,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT,EAAA;AAEa,MAAA,YAAA,GAAe,CAAC,MAAqC,KAAA;AAChE,EAAI,IAAA,OAAA,CAAQ,GAAI,CAAA,SAAA,KAAc,OAAS,EAAA;AACrC,IAAO,OAAAC,gBAAA,CAAA;AAAA,GACT;AAEA,EAAA,OAAO,IAAIC,eAAS,CAAA;AAAA,IAClB,eAAiB,EAAA,MAAA;AAAA,IACjB,KAAA,CAAM,KAAO,EAAA,SAAA,EAAW,IAAM,EAAA;AAC5B,MAAA,MAAA,CAAO,OAAQ,CAAA,KAAA,CAAM,QAAS,EAAA,CAAE,MAAM,CAAA,CAAA;AACtC,MAAK,IAAA,EAAA,CAAA;AAAA,KACP;AAAA,GACD,CAAA,CAAA;AACH;;;;;;"}

package/dist/package.json.cjs.js

@@ -0,0 +1,6 @@
+'use strict';
+
+var version = "1.8.20-next.2";
+
+exports.version = version;
+//# sourceMappingURL=package.json.cjs.js.map

package/dist/package.json.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.json.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techdocs/cli",
-  "version": "1.8.20-next.0",
+  "version": "1.8.20-next.2",
   "description": "Utility CLI for managing TechDocs sites in Backstage.",
   "backstage": {
     "role": "cli"
@@ -44,11 +44,11 @@
     "watch": "./src"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "^0.5.1-next.0",
-    "@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.0",
+    "@backstage/backend-defaults": "0.5.1-next.2",
+    "@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.2",
     "commander": "^12.0.0",
     "fs-extra": "^11.0.0",
     "global-agent": "^3.0.0",
@@ -58,7 +58,7 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.28.0-next.0",
+    "@backstage/cli": "0.28.0-next.2",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^11.0.0",
     "@types/http-proxy": "^1.17.4",