@techdocs/cli 1.8.25 → 1.9.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @techdocs/cli
 
+## 1.9.0-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.8.0-next.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.2
+  - @backstage/plugin-techdocs-node@1.13.0-next.0
+
+## 1.9.0-next.0
+
+### Minor Changes
+
+- 8de3d2d: Allow configurable optional retries for publisher AWS S3 operations.
+
+### Patch Changes
+
+- 69f84ac: Internal update to work with dynamic imports.
+- Updated dependencies
+  - @backstage/backend-defaults@0.8.0-next.0
+  - @backstage/plugin-techdocs-node@1.13.0-next.0
+  - @backstage/catalog-model@1.7.3
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.2
+
 ## 1.8.25
 
 ### Patch Changes

package/README.md

@@ -44,7 +44,8 @@ yarn techdocs-cli:dev [...options]
 
 ```sh
 # Prior to executing the techdocs-cli command
-export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY}
+export GLOBAL_AGENT_HTTP_PROXY=${HTTP_PROXY}
+export GLOBAL_AGENT_HTTPS_PROXY=${HTTPS_PROXY}
 export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
 ```
 

package/dist/commands/index.cjs.js

@@ -46,7 +46,7 @@ function registerCommands(program) {
     "--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)));
+  ).alias("build").action(lazy(() => import('./generate/generate.cjs.js'), "default"));
   program.command("migrate").description(
     "Migrate objects with case-sensitive entity triplets to lower-case versions."
   ).requiredOption(
@@ -90,7 +90,7 @@ function registerCommands(program) {
     "--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)));
+  ).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => import('./migrate/migrate.cjs.js'), "default"));
   program.command("publish").description(
     "Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc."
   ).requiredOption(
@@ -127,6 +127,9 @@ function registerCommands(program) {
   ).option(
     "--awsBucketRootPath <AWS BUCKET ROOT PATH>",
     "Optional sub-directory to store files in Amazon S3"
+  ).option(
+    "--awsMaxAttempts <AWS MAX ATTEMPTS>",
+    "Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used."
   ).option(
     "--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>",
     "(Required for OpenStack) specify when --publisher-type openStackSwift"
@@ -146,7 +149,7 @@ function registerCommands(program) {
     "--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)));
+  ).action(lazy(() => import('./publish/publish.cjs.js'), "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",
@@ -164,7 +167,7 @@ function registerCommands(program) {
     "--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)));
+  ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => import('./serve/mkdocs.cjs.js'), "default"));
   program.command("serve").description(
     "Serve a documentation project locally in a Backstage app-like environment"
   ).option(
@@ -212,12 +215,14 @@ function registerCommands(program) {
         "--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)));
+  }).action(lazy(() => import('./serve/serve.cjs.js'), "default"));
 }
-function lazy(getActionFunc) {
+function lazy(moduleLoader, exportName) {
   return async (...args) => {
     try {
-      const actionFunc = await getActionFunc();
+      const mod = await moduleLoader();
+      const actualModule = mod.default;
+      const actionFunc = actualModule[exportName];
       await actionFunc(...args);
       process.exit(0);
     } catch (error) {
@@ -227,5 +232,6 @@ function lazy(getActionFunc) {
   };
 }
 
+exports.lazy = lazy;
 exports.registerCommands = registerCommands;
 //# sourceMappingURL=index.cjs.js.map

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

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

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

@@ -1485,6 +1485,236 @@
       },
       "packageName": "@backstage/core-components"
     },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-app-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "app": {
+            "description": "Generic frontend configuration.",
+            "type": "object",
+            "properties": {
+              "baseUrl": {
+                "description": "The public absolute root URL that the frontend.",
+                "visibility": "frontend",
+                "type": "string"
+              },
+              "title": {
+                "description": "The title of the app, as shown in the Backstage web interface.",
+                "visibility": "frontend",
+                "type": "string"
+              },
+              "support": {
+                "description": "Information about support of this Backstage instance and how to contact the integrator team.",
+                "type": "object",
+                "properties": {
+                  "url": {
+                    "description": "The primary support url.",
+                    "visibility": "frontend",
+                    "type": "string"
+                  },
+                  "items": {
+                    "description": "A list of categorized support item groupings.",
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "title": {
+                          "description": "The title of the support item grouping.",
+                          "visibility": "frontend",
+                          "type": "string"
+                        },
+                        "icon": {
+                          "description": "An optional icon for the support item grouping.",
+                          "visibility": "frontend",
+                          "type": "string"
+                        },
+                        "links": {
+                          "description": "A list of support links for the Backstage instance inside this grouping.",
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "url": {
+                                "visibility": "frontend",
+                                "type": "string"
+                              },
+                              "title": {
+                                "visibility": "frontend",
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "url"
+                            ]
+                          }
+                        }
+                      },
+                      "required": [
+                        "links",
+                        "title"
+                      ]
+                    }
+                  }
+                },
+                "required": [
+                  "items",
+                  "url"
+                ]
+              },
+              "routes": {
+                "type": "object",
+                "properties": {
+                  "bindings": {
+                    "description": "Maps external route references to regular route references. Both the\nkey and the value is expected to be on the form `<pluginId>.<routeId>`.\nIf the value is `false`, the route will be disabled even if it has a\ndefault mapping.",
+                    "deepVisibility": "frontend",
+                    "type": "object",
+                    "additionalProperties": {
+                      "anyOf": [
+                        {
+                          "const": false,
+                          "type": "boolean"
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "baseUrl"
+            ]
+          },
+          "backend": {
+            "description": "Generic backend configuration.",
+            "type": "object",
+            "properties": {
+              "baseUrl": {
+                "description": "The public absolute root URL that the backend is reachable at, from the browser's perspective.",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            },
+            "required": [
+              "baseUrl"
+            ]
+          },
+          "organization": {
+            "description": "Configuration that provides information about the organization that the app is for.",
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "The name of the organization that the app belongs to.",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            }
+          },
+          "homepage": {
+            "description": "This config was used by the HomepageTimer but has been replaced  by the HeaderWorldClock in the home plugin",
+            "deprecated": "in favor of the HeaderWorldClock which is found in the home plugin",
+            "type": "object",
+            "properties": {
+              "clocks": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "visibility": "frontend",
+                      "type": "string"
+                    },
+                    "timezone": {
+                      "visibility": "frontend",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "label",
+                    "timezone"
+                  ]
+                }
+              }
+            }
+          },
+          "auth": {
+            "description": "Configuration that provides information on available configured authentication providers.",
+            "type": "object",
+            "properties": {
+              "environment": {
+                "description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\ndefault value: 'development'\noptional values: 'development' | 'production'",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            }
+          },
+          "enableExperimentalRedirectFlow": {
+            "description": "Enable redirect authentication flow type, instead of a popup for authentication.",
+            "visibility": "frontend",
+            "type": "boolean"
+          },
+          "discovery": {
+            "description": "Discovery options.",
+            "visibility": "frontend",
+            "type": "object",
+            "properties": {
+              "endpoints": {
+                "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
+                "visibility": "frontend",
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "target": {
+                      "description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend)\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.",
+                      "visibility": "frontend",
+                      "anyOf": [
+                        {
+                          "type": "object",
+                          "properties": {
+                            "external": {
+                              "visibility": "frontend",
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "external"
+                          ]
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ]
+                    },
+                    "plugins": {
+                      "description": "Array of plugins which use the target baseUrl.",
+                      "visibility": "frontend",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "required": [
+                    "plugins",
+                    "target"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "app",
+          "backend"
+        ],
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/core-app-api"
+    },
     {
       "path": "../../node_modules/@oriflame/backstage-plugin-score-card/node_modules/@backstage/core-components/config.d.ts",
       "value": {
@@ -3980,6 +4210,52 @@
       },
       "packageName": "@backstage/plugin-auth-backend-module-onelogin-provider"
     },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/plugin-catalog-react/node_modules/@backstage/core-components/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "auth": {
+            "type": "object",
+            "properties": {
+              "autologout": {
+                "description": "Autologout feature configuration",
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "description": "Enable or disable the autologout feature",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "idleTimeoutMinutes": {
+                    "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "promptBeforeIdleSeconds": {
+                    "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "useWorkerTimers": {
+                    "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "logoutIfDisconnected": {
+                    "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/core-components"
+    },
     {
       "path": "../integration-aws-node/config.d.ts",
       "value": {
@@ -4089,6 +4365,138 @@
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
       "packageName": "@backstage/integration-aws-node"
+    },
+    {
+      "path": "../../node_modules/@backstage/backend-common/node_modules/@backstage/backend-plugin-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "backend": {
+            "type": "object",
+            "properties": {
+              "workingDirectory": {
+                "description": "An absolute path to a directory that can be used as a working dir, for\nexample as scratch space for large operations.",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/backend-plugin-api"
+    },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/frontend-app-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "app": {
+            "type": "object",
+            "properties": {
+              "experimental": {
+                "type": "object",
+                "properties": {
+                  "packages": {
+                    "visibility": "frontend",
+                    "deepVisibility": "frontend",
+                    "anyOf": [
+                      {
+                        "type": "object",
+                        "properties": {
+                          "include": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "exclude": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          }
+                        }
+                      },
+                      {
+                        "const": "all",
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              },
+              "routes": {
+                "type": "object",
+                "properties": {
+                  "bindings": {
+                    "description": "Maps external route references to regular route references. Both the\nkey and the value is expected to be on the form `<pluginId>.<routeId>`.\nIf the value is `false`, the route will be disabled even if it has a\ndefault mapping.",
+                    "deepVisibility": "frontend",
+                    "type": "object",
+                    "additionalProperties": {
+                      "anyOf": [
+                        {
+                          "const": false,
+                          "type": "boolean"
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ]
+                    }
+                  }
+                }
+              },
+              "extensions": {
+                "deepVisibility": "frontend",
+                "type": "array",
+                "items": {
+                  "anyOf": [
+                    {
+                      "type": "object",
+                      "additionalProperties": {
+                        "anyOf": [
+                          {
+                            "type": "object",
+                            "properties": {
+                              "attachTo": {
+                                "type": "object",
+                                "properties": {
+                                  "id": {
+                                    "type": "string"
+                                  },
+                                  "input": {
+                                    "type": "string"
+                                  }
+                                },
+                                "required": [
+                                  "id",
+                                  "input"
+                                ]
+                              },
+                              "disabled": {
+                                "type": "boolean"
+                              },
+                              "config": {}
+                            }
+                          },
+                          {
+                            "type": "boolean"
+                          }
+                        ]
+                      }
+                    },
+                    {
+                      "type": "string"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/frontend-app-api"
     }
   ],
   "backstageConfigSchemaVersion": 1

package/dist/embedded-app/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.01d08696.js"></script><script defer="defer" src="/static/module-material-ui.909829ed.js"></script><script defer="defer" src="/static/module-lodash.aa647045.js"></script><script defer="defer" src="/static/module-date-fns.c633d602.js"></script><script defer="defer" src="/static/module-mui.f702282a.js"></script><script defer="defer" src="/static/module-material-table.84f30b2f.js"></script><script defer="defer" src="/static/module-react-dom.42a304d3.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.b474cfe9.js"></script><script defer="defer" src="/static/module-zod.4f2eeb8c.js"></script><script defer="defer" src="/static/module-i18next.f50c1612.js"></script><script defer="defer" src="/static/module-remix-run.ba6397c2.js"></script><script defer="defer" src="/static/vendor.01d08696.js"></script><script defer="defer" src="/static/main.01d08696.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.5b071983.js"></script><script defer="defer" src="/static/module-material-ui.b24ef3a3.js"></script><script defer="defer" src="/static/module-lodash.aa647045.js"></script><script defer="defer" src="/static/module-date-fns.c633d602.js"></script><script defer="defer" src="/static/module-mui.f702282a.js"></script><script defer="defer" src="/static/module-material-table.d6e8d890.js"></script><script defer="defer" src="/static/module-react-dom.42a304d3.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.b474cfe9.js"></script><script defer="defer" src="/static/module-zod.4f2eeb8c.js"></script><script defer="defer" src="/static/module-i18next.f50c1612.js"></script><script defer="defer" src="/static/module-remix-run.ae6d33c5.js"></script><script defer="defer" src="/static/vendor.5b071983.js"></script><script defer="defer" src="/static/main.5b071983.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>