@techdocs/cli 0.0.0-nightly-20250116022939 → 0.0.0-nightly-20250117022919

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @techdocs/cli
 
-## 0.0.0-nightly-20250116022939
+## 0.0.0-nightly-20250117022919
 
 ### Minor Changes
 
@@ -8,9 +8,13 @@
 
 ### Patch Changes
 
+- 69f84ac: Internal update to work with dynamic imports.
 - Updated dependencies
-  - @backstage/backend-defaults@0.0.0-nightly-20250116022939
-  - @backstage/plugin-techdocs-node@0.0.0-nightly-20250116022939
+  - @backstage/backend-defaults@0.0.0-nightly-20250117022919
+  - @backstage/plugin-techdocs-node@0.0.0-nightly-20250117022919
+  - @backstage/catalog-model@1.7.3
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.2
 
 ## 1.8.25
 

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(
@@ -149,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",
@@ -167,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(
@@ -215,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) {
@@ -230,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      '--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').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,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,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

@@ -1440,7 +1440,7 @@
       "packageName": "@backstage/plugin-auth-backend-module-guest-provider"
     },
     {
-      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-components/config.d.ts",
+      "path": "../../node_modules/@backstage-community/plugin-stackstorm/node_modules/@backstage/core-components/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3044,7 +3044,7 @@
       "packageName": "@backstage/plugin-auth-backend-module-gcp-iap-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-gitlab-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-github-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3054,7 +3054,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "gitlab": {
+                  "github": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3067,10 +3067,10 @@
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "audience": {
+                        "callbackUrl": {
                           "type": "string"
                         },
-                        "callbackUrl": {
+                        "enterpriseInstanceUrl": {
                           "type": "string"
                         },
                         "additionalScopes": {
@@ -3157,21 +3157,20 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-gitlab-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-github-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-google-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-gitlab-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
           "auth": {
-            "description": "Configuration options for the auth plugin",
             "type": "object",
             "properties": {
               "providers": {
                 "type": "object",
                 "properties": {
-                  "google": {
+                  "gitlab": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3184,6 +3183,9 @@
                           "visibility": "secret",
                           "type": "string"
                         },
+                        "audience": {
+                          "type": "string"
+                        },
                         "callbackUrl": {
                           "type": "string"
                         },
@@ -3212,7 +3214,7 @@
                                     "properties": {
                                       "resolver": {
                                         "type": "string",
-                                        "const": "emailMatchingUserEntityAnnotation"
+                                        "const": "usernameMatchingUserEntityName"
                                       }
                                     },
                                     "required": [
@@ -3271,20 +3273,21 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-google-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-gitlab-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-microsoft-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-google-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
           "auth": {
+            "description": "Configuration options for the auth plugin",
             "type": "object",
             "properties": {
               "providers": {
                 "type": "object",
                 "properties": {
-                  "microsoft": {
+                  "google": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3293,16 +3296,10 @@
                         "clientId": {
                           "type": "string"
                         },
-                        "tenantId": {
-                          "type": "string"
-                        },
                         "clientSecret": {
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "domainHint": {
-                          "type": "string"
-                        },
                         "callbackUrl": {
                           "type": "string"
                         },
@@ -3319,9 +3316,6 @@
                             }
                           ]
                         },
-                        "skipUserProfile": {
-                          "type": "boolean"
-                        },
                         "signIn": {
                           "type": "object",
                           "properties": {
@@ -3382,8 +3376,7 @@
                       },
                       "required": [
                         "clientId",
-                        "clientSecret",
-                        "tenantId"
+                        "clientSecret"
                       ]
                     }
                   }
@@ -3394,10 +3387,10 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-microsoft-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-google-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-oauth2-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-microsoft-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3407,7 +3400,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "oauth2": {
+                  "microsoft": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3416,18 +3409,17 @@
                         "clientId": {
                           "type": "string"
                         },
-                        "clientSecret": {
-                          "visibility": "secret",
+                        "tenantId": {
                           "type": "string"
                         },
-                        "authorizationUrl": {
+                        "clientSecret": {
+                          "visibility": "secret",
                           "type": "string"
                         },
-                        "tokenUrl": {
+                        "domainHint": {
                           "type": "string"
                         },
-                        "scope": {
-                          "deprecated": "use `additionalScopes` instead",
+                        "callbackUrl": {
                           "type": "string"
                         },
                         "additionalScopes": {
@@ -3443,10 +3435,7 @@
                             }
                           ]
                         },
-                        "disableRefresh": {
-                          "type": "boolean"
-                        },
-                        "includeBasicAuth": {
+                        "skipUserProfile": {
                           "type": "boolean"
                         },
                         "signIn": {
@@ -3461,7 +3450,7 @@
                                     "properties": {
                                       "resolver": {
                                         "type": "string",
-                                        "const": "usernameMatchingUserEntityName"
+                                        "const": "emailMatchingUserEntityAnnotation"
                                       }
                                     },
                                     "required": [
@@ -3508,10 +3497,9 @@
                         }
                       },
                       "required": [
-                        "authorizationUrl",
                         "clientId",
                         "clientSecret",
-                        "tokenUrl"
+                        "tenantId"
                       ]
                     }
                   }
@@ -3522,10 +3510,10 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-oauth2-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-microsoft-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-oidc-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-oauth2-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3535,7 +3523,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "oidc": {
+                  "oauth2": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3548,16 +3536,14 @@
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "metadataUrl": {
-                          "type": "string"
-                        },
-                        "callbackUrl": {
+                        "authorizationUrl": {
                           "type": "string"
                         },
-                        "tokenEndpointAuthMethod": {
+                        "tokenUrl": {
                           "type": "string"
                         },
-                        "tokenSignedResponseAlg": {
+                        "scope": {
+                          "deprecated": "use `additionalScopes` instead",
                           "type": "string"
                         },
                         "additionalScopes": {
@@ -3573,8 +3559,11 @@
                             }
                           ]
                         },
-                        "prompt": {
-                          "type": "string"
+                        "disableRefresh": {
+                          "type": "boolean"
+                        },
+                        "includeBasicAuth": {
+                          "type": "boolean"
                         },
                         "signIn": {
                           "type": "object",
@@ -3583,6 +3572,18 @@
                               "type": "array",
                               "items": {
                                 "anyOf": [
+                                  {
+                                    "type": "object",
+                                    "properties": {
+                                      "resolver": {
+                                        "type": "string",
+                                        "const": "usernameMatchingUserEntityName"
+                                      }
+                                    },
+                                    "required": [
+                                      "resolver"
+                                    ]
+                                  },
                                   {
                                     "type": "object",
                                     "properties": {
@@ -3623,9 +3624,10 @@
                         }
                       },
                       "required": [
+                        "authorizationUrl",
                         "clientId",
                         "clientSecret",
-                        "metadataUrl"
+                        "tokenUrl"
                       ]
                     }
                   }
@@ -3636,10 +3638,10 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-oidc-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-oauth2-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-okta-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-oidc-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3649,7 +3651,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "okta": {
+                  "oidc": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3662,16 +3664,16 @@
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "audience": {
+                        "metadataUrl": {
                           "type": "string"
                         },
-                        "authServerId": {
+                        "callbackUrl": {
                           "type": "string"
                         },
-                        "idp": {
+                        "tokenEndpointAuthMethod": {
                           "type": "string"
                         },
-                        "callbackUrl": {
+                        "tokenSignedResponseAlg": {
                           "type": "string"
                         },
                         "additionalScopes": {
@@ -3687,6 +3689,9 @@
                             }
                           ]
                         },
+                        "prompt": {
+                          "type": "string"
+                        },
                         "signIn": {
                           "type": "object",
                           "properties": {
@@ -3694,18 +3699,6 @@
                               "type": "array",
                               "items": {
                                 "anyOf": [
-                                  {
-                                    "type": "object",
-                                    "properties": {
-                                      "resolver": {
-                                        "type": "string",
-                                        "const": "emailMatchingUserEntityAnnotation"
-                                      }
-                                    },
-                                    "required": [
-                                      "resolver"
-                                    ]
-                                  },
                                   {
                                     "type": "object",
                                     "properties": {
@@ -3747,7 +3740,8 @@
                       },
                       "required": [
                         "clientId",
-                        "clientSecret"
+                        "clientSecret",
+                        "metadataUrl"
                       ]
                     }
                   }
@@ -3758,10 +3752,10 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-okta-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-oidc-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-onelogin-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-okta-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3771,7 +3765,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "onelogin": {
+                  "okta": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3784,12 +3778,31 @@
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "issuer": {
+                        "audience": {
+                          "type": "string"
+                        },
+                        "authServerId": {
+                          "type": "string"
+                        },
+                        "idp": {
                           "type": "string"
                         },
                         "callbackUrl": {
                           "type": "string"
                         },
+                        "additionalScopes": {
+                          "anyOf": [
+                            {
+                              "type": "array",
+                              "items": {
+                                "type": "string"
+                              }
+                            },
+                            {
+                              "type": "string"
+                            }
+                          ]
+                        },
                         "signIn": {
                           "type": "object",
                           "properties": {
@@ -3802,7 +3815,7 @@
                                     "properties": {
                                       "resolver": {
                                         "type": "string",
-                                        "const": "usernameMatchingUserEntityName"
+                                        "const": "emailMatchingUserEntityAnnotation"
                                       }
                                     },
                                     "required": [
@@ -3850,8 +3863,7 @@
                       },
                       "required": [
                         "clientId",
-                        "clientSecret",
-                        "issuer"
+                        "clientSecret"
                       ]
                     }
                   }
@@ -3862,10 +3874,10 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-onelogin-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-okta-provider"
     },
     {
-      "path": "../../plugins/auth-backend-module-github-provider/config.d.ts",
+      "path": "../../plugins/auth-backend-module-onelogin-provider/config.d.ts",
       "value": {
         "type": "object",
         "properties": {
@@ -3875,7 +3887,7 @@
               "providers": {
                 "type": "object",
                 "properties": {
-                  "github": {
+                  "onelogin": {
                     "visibility": "frontend",
                     "type": "object",
                     "additionalProperties": {
@@ -3888,25 +3900,12 @@
                           "visibility": "secret",
                           "type": "string"
                         },
-                        "callbackUrl": {
+                        "issuer": {
                           "type": "string"
                         },
-                        "enterpriseInstanceUrl": {
+                        "callbackUrl": {
                           "type": "string"
                         },
-                        "additionalScopes": {
-                          "anyOf": [
-                            {
-                              "type": "array",
-                              "items": {
-                                "type": "string"
-                              }
-                            },
-                            {
-                              "type": "string"
-                            }
-                          ]
-                        },
                         "signIn": {
                           "type": "object",
                           "properties": {
@@ -3967,7 +3966,8 @@
                       },
                       "required": [
                         "clientId",
-                        "clientSecret"
+                        "clientSecret",
+                        "issuer"
                       ]
                     }
                   }
@@ -3978,7 +3978,7 @@
         },
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-github-provider"
+      "packageName": "@backstage/plugin-auth-backend-module-onelogin-provider"
     },
     {
       "path": "../integration-aws-node/config.d.ts",

package/dist/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.0.0-nightly-20250116022939";
+var version = "0.0.0-nightly-20250117022919";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techdocs/cli",
-  "version": "0.0.0-nightly-20250116022939",
+  "version": "0.0.0-nightly-20250117022919",
   "description": "Utility CLI for managing TechDocs sites in Backstage.",
   "backstage": {
     "role": "cli"
@@ -44,11 +44,11 @@
     "watch": "./src"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "0.0.0-nightly-20250116022939",
+    "@backstage/backend-defaults": "0.0.0-nightly-20250117022919",
     "@backstage/catalog-model": "1.7.3",
     "@backstage/cli-common": "0.1.15",
     "@backstage/config": "1.3.2",
-    "@backstage/plugin-techdocs-node": "0.0.0-nightly-20250116022939",
+    "@backstage/plugin-techdocs-node": "0.0.0-nightly-20250117022919",
     "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.29.5",
+    "@backstage/cli": "0.0.0-nightly-20250117022919",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^11.0.0",
     "@types/http-proxy": "^1.17.4",