@techdocs/cli 0.8.7 → 0.8.11-next.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @techdocs/cli
 
+## 0.8.11-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.10.4-next.0
+  - @backstage/config@0.1.13-next.0
+  - @backstage/techdocs-common@0.11.4-next.0
+  - @backstage/catalog-model@0.9.10-next.0
+
+## 0.8.10
+
+### Patch Changes
+
+- 8fbc988bfc: remove internal and inline CSS from index.html
+- Updated dependencies
+  - @backstage/techdocs-common@0.11.2
+  - @backstage/backend-common@0.10.1
+
+## 0.8.9
+
+### Patch Changes
+
+- 5fdc8df0e8: The `index.html` template was updated to use the new `config` global.
+- Updated dependencies
+  - @backstage/backend-common@0.10.0
+  - @backstage/techdocs-common@0.11.1
+
+## 0.8.8
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.9.13
+  - @backstage/techdocs-common@0.11.0
+
 ## 0.8.7
 
 ### Patch Changes

package/dist/cjs/PublisherConfig-a09bdfcc.cjs.js

@@ -0,0 +1,97 @@
+'use strict';
+
+var config = require('@backstage/config');
+
+const _PublisherConfig = class {
+  static getValidConfig(cmd) {
+    const publisherType = cmd.publisherType;
+    if (!_PublisherConfig.isKnownPublisher(publisherType)) {
+      throw new Error(`Unknown publisher type ${cmd.publisherType}`);
+    }
+    return new config.ConfigReader({
+      backend: {
+        baseUrl: "http://localhost:7007",
+        listen: {
+          port: 7007
+        }
+      },
+      techdocs: {
+        publisher: _PublisherConfig.configFactories[publisherType](cmd),
+        legacyUseCaseSensitiveTripletPaths: cmd.legacyUseCaseSensitiveTripletPaths
+      }
+    });
+  }
+  static isKnownPublisher(type) {
+    return _PublisherConfig.configFactories.hasOwnProperty(type);
+  }
+  static getValidAwsS3Config(cmd) {
+    return {
+      type: "awsS3",
+      awsS3: {
+        bucketName: cmd.storageName,
+        ...cmd.awsBucketRootPath && { bucketRootPath: cmd.awsBucketRootPath },
+        ...cmd.awsRoleArn && { credentials: { roleArn: cmd.awsRoleArn } },
+        ...cmd.awsEndpoint && { endpoint: cmd.awsEndpoint },
+        ...cmd.awsS3ForcePathStyle && { s3ForcePathStyle: true },
+        ...cmd.awsS3sse && { sse: cmd.awsS3sse }
+      }
+    };
+  }
+  static getValidAzureConfig(cmd) {
+    if (!cmd.azureAccountName) {
+      throw new Error(`azureBlobStorage requires --azureAccountName to be specified`);
+    }
+    return {
+      type: "azureBlobStorage",
+      azureBlobStorage: {
+        containerName: cmd.storageName,
+        credentials: {
+          accountName: cmd.azureAccountName,
+          accountKey: cmd.azureAccountKey
+        }
+      }
+    };
+  }
+  static getValidGoogleGcsConfig(cmd) {
+    return {
+      type: "googleGcs",
+      googleGcs: {
+        bucketName: cmd.storageName,
+        ...cmd.gcsBucketRootPath && { bucketRootPath: cmd.gcsBucketRootPath }
+      }
+    };
+  }
+  static getValidOpenStackSwiftConfig(cmd) {
+    const missingParams = [
+      "osCredentialId",
+      "osSecret",
+      "osAuthUrl",
+      "osSwiftUrl"
+    ].filter((param) => !cmd[param]);
+    if (missingParams.length) {
+      throw new Error(`openStackSwift requires the following params to be specified: ${missingParams.join(", ")}`);
+    }
+    return {
+      type: "openStackSwift",
+      openStackSwift: {
+        containerName: cmd.storageName,
+        credentials: {
+          id: cmd.osCredentialId,
+          secret: cmd.osSecret
+        },
+        authUrl: cmd.osAuthUrl,
+        swiftUrl: cmd.osSwiftUrl
+      }
+    };
+  }
+};
+let PublisherConfig = _PublisherConfig;
+PublisherConfig.configFactories = {
+  awsS3: _PublisherConfig.getValidAwsS3Config,
+  azureBlobStorage: _PublisherConfig.getValidAzureConfig,
+  googleGcs: _PublisherConfig.getValidGoogleGcsConfig,
+  openStackSwift: _PublisherConfig.getValidOpenStackSwiftConfig
+};
+
+exports.PublisherConfig = PublisherConfig;
+//# sourceMappingURL=PublisherConfig-a09bdfcc.cjs.js.map

package/dist/cjs/PublisherConfig-a09bdfcc.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublisherConfig-a09bdfcc.cjs.js","sources":["../../src/lib/PublisherConfig.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ConfigReader } from '@backstage/config';\nimport { Command } from 'commander';\n\ntype Publisher = keyof typeof PublisherConfig['configFactories'];\ntype PublisherConfiguration = {\n  [p in Publisher]?: any;\n} & {\n  type: Publisher;\n};\n\n/**\n * Helper when working with publisher-related configurations.\n */\nexport class PublisherConfig {\n  /**\n   * Maps publisher-specific config keys to config getters.\n   */\n  private static configFactories = {\n    awsS3: PublisherConfig.getValidAwsS3Config,\n    azureBlobStorage: PublisherConfig.getValidAzureConfig,\n    googleGcs: PublisherConfig.getValidGoogleGcsConfig,\n    openStackSwift: PublisherConfig.getValidOpenStackSwiftConfig,\n  };\n\n  /**\n   * Returns Backstage config suitable for use when instantiating a Publisher. If\n   * there are any missing or invalid options provided, an error is thrown.\n   *\n   * Note: This assumes that proper credentials are set in Environment\n   * variables for the respective GCS/AWS clients to work.\n   */\n  static getValidConfig(cmd: Command): ConfigReader {\n    const publisherType = cmd.publisherType;\n\n    if (!PublisherConfig.isKnownPublisher(publisherType)) {\n      throw new Error(`Unknown publisher type ${cmd.publisherType}`);\n    }\n\n    return new ConfigReader({\n      // This backend config is not used at all. Just something needed a create a mock discovery instance.\n      backend: {\n        baseUrl: 'http://localhost:7007',\n        listen: {\n          port: 7007,\n        },\n      },\n      techdocs: {\n        publisher: PublisherConfig.configFactories[publisherType](cmd),\n        legacyUseCaseSensitiveTripletPaths:\n          cmd.legacyUseCaseSensitiveTripletPaths,\n      },\n    });\n  }\n\n  /**\n   * Typeguard to ensure the publisher has a known config getter.\n   */\n  private static isKnownPublisher(\n    type: string,\n  ): type is keyof typeof PublisherConfig['configFactories'] {\n    return PublisherConfig.configFactories.hasOwnProperty(type);\n  }\n\n  /**\n   * Retrieve valid AWS S3 configuration based on the command.\n   */\n  private static getValidAwsS3Config(cmd: Command): PublisherConfiguration {\n    return {\n      type: 'awsS3',\n      awsS3: {\n        bucketName: cmd.storageName,\n        ...(cmd.awsBucketRootPath && { bucketRootPath: cmd.awsBucketRootPath }),\n        ...(cmd.awsRoleArn && { credentials: { roleArn: cmd.awsRoleArn } }),\n        ...(cmd.awsEndpoint && { endpoint: cmd.awsEndpoint }),\n        ...(cmd.awsS3ForcePathStyle && { s3ForcePathStyle: true }),\n        ...(cmd.awsS3sse && { sse: cmd.awsS3sse }),\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid Azure Blob Storage configuration based on the command.\n   */\n  private static getValidAzureConfig(cmd: Command): PublisherConfiguration {\n    if (!cmd.azureAccountName) {\n      throw new Error(\n        `azureBlobStorage requires --azureAccountName to be specified`,\n      );\n    }\n\n    return {\n      type: 'azureBlobStorage',\n      azureBlobStorage: {\n        containerName: cmd.storageName,\n        credentials: {\n          accountName: cmd.azureAccountName,\n          accountKey: cmd.azureAccountKey,\n        },\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid GCS configuration based on the command.\n   */\n  private static getValidGoogleGcsConfig(cmd: Command): PublisherConfiguration {\n    return {\n      type: 'googleGcs',\n      googleGcs: {\n        bucketName: cmd.storageName,\n        ...(cmd.gcsBucketRootPath && { bucketRootPath: cmd.gcsBucketRootPath }),\n      },\n    };\n  }\n\n  /**\n   * Retrieves valid OpenStack Swift configuration based on the command.\n   */\n  private static getValidOpenStackSwiftConfig(\n    cmd: Command,\n  ): PublisherConfiguration {\n    const missingParams = [\n      'osCredentialId',\n      'osSecret',\n      'osAuthUrl',\n      'osSwiftUrl',\n    ].filter((param: string) => !cmd[param]);\n\n    if (missingParams.length) {\n      throw new Error(\n        `openStackSwift requires the following params to be specified: ${missingParams.join(\n          ', ',\n        )}`,\n      );\n    }\n\n    return {\n      type: 'openStackSwift',\n      openStackSwift: {\n        containerName: cmd.storageName,\n        credentials: {\n          id: cmd.osCredentialId,\n          secret: cmd.osSecret,\n        },\n        authUrl: cmd.osAuthUrl,\n        swiftUrl: cmd.osSwiftUrl,\n      },\n    };\n  }\n}\n"],"names":["ConfigReader"],"mappings":";;;;AA6BO,+BAAsB;AAAA,SAkBpB,eAAe,KAA4B;AAChD,UAAM,gBAAgB,IAAI;AAE1B,QAAI,CAAC,iBAAgB,iBAAiB,gBAAgB;AACpD,YAAM,IAAI,MAAM,0BAA0B,IAAI;AAAA;AAGhD,WAAO,IAAIA,oBAAa;AAAA,MAEtB,SAAS;AAAA,QACP,SAAS;AAAA,QACT,QAAQ;AAAA,UACN,MAAM;AAAA;AAAA;AAAA,MAGV,UAAU;AAAA,QACR,WAAW,iBAAgB,gBAAgB,eAAe;AAAA,QAC1D,oCACE,IAAI;AAAA;AAAA;AAAA;AAAA,SAQG,iBACb,MACyD;AACzD,WAAO,iBAAgB,gBAAgB,eAAe;AAAA;AAAA,SAMzC,oBAAoB,KAAsC;AACvE,WAAO;AAAA,MACL,MAAM;AAAA,MACN,OAAO;AAAA,QACL,YAAY,IAAI;AAAA,WACZ,IAAI,qBAAqB,EAAE,gBAAgB,IAAI;AAAA,WAC/C,IAAI,cAAc,EAAE,aAAa,EAAE,SAAS,IAAI;AAAA,WAChD,IAAI,eAAe,EAAE,UAAU,IAAI;AAAA,WACnC,IAAI,uBAAuB,EAAE,kBAAkB;AAAA,WAC/C,IAAI,YAAY,EAAE,KAAK,IAAI;AAAA;AAAA;AAAA;AAAA,SAQtB,oBAAoB,KAAsC;AACvE,QAAI,CAAC,IAAI,kBAAkB;AACzB,YAAM,IAAI,MACR;AAAA;AAIJ,WAAO;AAAA,MACL,MAAM;AAAA,MACN,kBAAkB;AAAA,QAChB,eAAe,IAAI;AAAA,QACnB,aAAa;AAAA,UACX,aAAa,IAAI;AAAA,UACjB,YAAY,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA,SAST,wBAAwB,KAAsC;AAC3E,WAAO;AAAA,MACL,MAAM;AAAA,MACN,WAAW;AAAA,QACT,YAAY,IAAI;AAAA,WACZ,IAAI,qBAAqB,EAAE,gBAAgB,IAAI;AAAA;AAAA;AAAA;AAAA,SAQ1C,6BACb,KACwB;AACxB,UAAM,gBAAgB;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO,CAAC,UAAkB,CAAC,IAAI;AAEjC,QAAI,cAAc,QAAQ;AACxB,YAAM,IAAI,MACR,iEAAiE,cAAc,KAC7E;AAAA;AAKN,WAAO;AAAA,MACL,MAAM;AAAA,MACN,gBAAgB;AAAA,QACd,eAAe,IAAI;AAAA,QACnB,aAAa;AAAA,UACX,IAAI,IAAI;AAAA,UACR,QAAQ,IAAI;AAAA;AAAA,QAEd,SAAS,IAAI;AAAA,QACb,UAAU,IAAI;AAAA;AAAA;AAAA;AAAA;;AApIf,gBAIU,kBAAkB;AAAA,EAC/B,OAAO,iBAAgB;AAAA,EACvB,kBAAkB,iBAAgB;AAAA,EAClC,WAAW,iBAAgB;AAAA,EAC3B,gBAAgB,iBAAgB;AAAA;;;;"}

package/dist/cjs/generate-86756c8c.cjs.js

@@ -0,0 +1,66 @@
+'use strict';
+
+var path = require('path');
+var fs = require('fs-extra');
+var Docker = require('dockerode');
+var techdocsCommon = require('@backstage/techdocs-common');
+var backendCommon = require('@backstage/backend-common');
+var config = require('@backstage/config');
+var utility = require('./utility-6042a9ba.cjs.js');
+var process$1 = require('process');
+require('winston');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var Docker__default = /*#__PURE__*/_interopDefaultLegacy(Docker);
+
+async function generate(cmd) {
+  const logger = utility.createLogger({ verbose: cmd.verbose });
+  const sourceDir = path.resolve(cmd.sourceDir);
+  const outputDir = path.resolve(cmd.outputDir);
+  const dockerImage = cmd.dockerImage;
+  const pullImage = cmd.pull;
+  logger.info(`Using source dir ${sourceDir}`);
+  logger.info(`Will output generated files in ${outputDir}`);
+  logger.verbose("Creating output directory if it does not exist.");
+  await fs__default["default"].ensureDir(outputDir);
+  const config$1 = new config.ConfigReader({
+    techdocs: {
+      generator: {
+        runIn: cmd.docker ? "docker" : "local",
+        dockerImage,
+        pullImage
+      }
+    }
+  });
+  const dockerClient = new Docker__default["default"]();
+  const containerRunner = new backendCommon.DockerContainerRunner({ dockerClient });
+  let parsedLocationAnnotation = {};
+  if (cmd.techdocsRef) {
+    try {
+      parsedLocationAnnotation = utility.convertTechDocsRefToLocationAnnotation(cmd.techdocsRef);
+    } catch (err) {
+      logger.error(err.message);
+    }
+  }
+  const techdocsGenerator = await techdocsCommon.TechdocsGenerator.fromConfig(config$1, {
+    logger,
+    containerRunner
+  });
+  logger.info("Generating documentation...");
+  await techdocsGenerator.run({
+    inputDir: sourceDir,
+    outputDir,
+    ...cmd.techdocsRef ? {
+      parsedLocationAnnotation
+    } : {},
+    logger,
+    etag: cmd.etag,
+    ...process.env.LOG_LEVEL === "debug" ? { logStream: process$1.stdout } : {}
+  });
+  logger.info("Done!");
+}
+
+exports["default"] = generate;
+//# sourceMappingURL=generate-86756c8c.cjs.js.map

package/dist/cjs/generate-86756c8c.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-86756c8c.cjs.js","sources":["../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { resolve } from 'path';\nimport { Command } from 'commander';\nimport fs from 'fs-extra';\nimport Docker from 'dockerode';\nimport {\n  TechdocsGenerator,\n  ParsedLocationAnnotation,\n} from '@backstage/techdocs-common';\nimport { DockerContainerRunner } from '@backstage/backend-common';\nimport { ConfigReader } from '@backstage/config';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n} from '../../lib/utility';\nimport { stdout } from 'process';\n\nexport default async function generate(cmd: Command) {\n  // Use techdocs-common package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: cmd.verbose });\n\n  const sourceDir = resolve(cmd.sourceDir);\n  const outputDir = resolve(cmd.outputDir);\n  const dockerImage = cmd.dockerImage;\n  const pullImage = cmd.pull;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: cmd.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n      },\n    },\n  });\n\n  // Docker client (conditionally) used by the generators, based on techdocs.generators config.\n  const dockerClient = new Docker();\n  const containerRunner = new DockerContainerRunner({ dockerClient });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (cmd.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        cmd.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  // Generate docs using @backstage/techdocs-common\n  const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n    logger,\n    containerRunner,\n  });\n\n  logger.info('Generating documentation...');\n\n  await techdocsGenerator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(cmd.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag: cmd.etag,\n    ...(process.env.LOG_LEVEL === 'debug' ? { logStream: stdout } : {}),\n  });\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","config","ConfigReader","Docker","DockerContainerRunner","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","stdout"],"mappings":";;;;;;;;;;;;;;;;;wBAgCuC,KAAc;AAKnD,QAAM,SAASA,qBAAa,EAAE,SAAS,IAAI;AAE3C,QAAM,YAAYC,aAAQ,IAAI;AAC9B,QAAM,YAAYA,aAAQ,IAAI;AAC9B,QAAM,cAAc,IAAI;AACxB,QAAM,YAAY,IAAI;AAEtB,SAAO,KAAK,oBAAoB;AAChC,SAAO,KAAK,kCAAkC;AAE9C,SAAO,QAAQ;AAEf,QAAMC,uBAAG,UAAU;AAEnB,QAAMC,WAAS,IAAIC,oBAAa;AAAA,IAC9B,UAAU;AAAA,MACR,WAAW;AAAA,QACT,OAAO,IAAI,SAAS,WAAW;AAAA,QAC/B;AAAA,QACA;AAAA;AAAA;AAAA;AAMN,QAAM,eAAe,IAAIC;AACzB,QAAM,kBAAkB,IAAIC,oCAAsB,EAAE;AAEpD,MAAI,2BAA2B;AAC/B,MAAI,IAAI,aAAa;AACnB,QAAI;AACF,iCAA2BC,+CACzB,IAAI;AAAA,aAEC,KAAP;AACA,aAAO,MAAM,IAAI;AAAA;AAAA;AAKrB,QAAM,oBAAoB,MAAMC,iCAAkB,WAAWL,UAAQ;AAAA,IACnE;AAAA,IACA;AAAA;AAGF,SAAO,KAAK;AAEZ,QAAM,kBAAkB,IAAI;AAAA,IAC1B,UAAU;AAAA,IACV;AAAA,OACI,IAAI,cACJ;AAAA,MACE;AAAA,QAEF;AAAA,IACJ;AAAA,IACA,MAAM,IAAI;AAAA,OACN,QAAQ,IAAI,cAAc,UAAU,EAAE,WAAWM,qBAAW;AAAA;AAGlE,SAAO,KAAK;AAAA;;;;"}

package/dist/cjs/migrate-04a51fb3.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var backendCommon = require('@backstage/backend-common');
+var techdocsCommon = require('@backstage/techdocs-common');
+var utility = require('./utility-6042a9ba.cjs.js');
+var PublisherConfig = require('./PublisherConfig-a09bdfcc.cjs.js');
+require('winston');
+require('@backstage/config');
+
+async function migrate(cmd) {
+  const logger = utility.createLogger({ verbose: cmd.verbose });
+  const config = PublisherConfig.PublisherConfig.getValidConfig(cmd);
+  const discovery = backendCommon.SingleHostDiscovery.fromConfig(config);
+  const publisher = await techdocsCommon.Publisher.fromConfig(config, { logger, discovery });
+  if (!publisher.migrateDocsCase) {
+    throw new Error(`Migration not implemented for ${cmd.publisherType}`);
+  }
+  const { isAvailable } = await publisher.getReadiness();
+  if (!isAvailable) {
+    throw new Error("");
+  }
+  const removeOriginal = cmd.removeOriginal;
+  const numericConcurrency = parseInt(cmd.concurrency, 10);
+  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {
+    throw new Error(`Concurrency must be a number greater than 1. ${cmd.concurrency} provided.`);
+  }
+  await publisher.migrateDocsCase({
+    concurrency: numericConcurrency,
+    removeOriginal
+  });
+}
+
+exports["default"] = migrate;
+//# sourceMappingURL=migrate-04a51fb3.cjs.js.map

package/dist/cjs/migrate-04a51fb3.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate-04a51fb3.cjs.js","sources":["../../src/commands/migrate/migrate.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { SingleHostDiscovery } from '@backstage/backend-common';\nimport { Publisher } from '@backstage/techdocs-common';\nimport { Command } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(cmd: Command) {\n  const logger = createLogger({ verbose: cmd.verbose });\n\n  const config = PublisherConfig.getValidConfig(cmd);\n  const discovery = SingleHostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  if (!publisher.migrateDocsCase) {\n    throw new Error(`Migration not implemented for ${cmd.publisherType}`);\n  }\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    throw new Error('');\n  }\n\n  // Validate and parse migration arguments.\n  const removeOriginal = cmd.removeOriginal;\n  const numericConcurrency = parseInt(cmd.concurrency, 10);\n\n  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n    throw new Error(\n      `Concurrency must be a number greater than 1. ${cmd.concurrency} provided.`,\n    );\n  }\n\n  await publisher.migrateDocsCase({\n    concurrency: numericConcurrency,\n    removeOriginal,\n  });\n}\n"],"names":["createLogger","PublisherConfig","SingleHostDiscovery","Publisher"],"mappings":";;;;;;;;;uBAsBsC,KAAc;AAClD,QAAM,SAASA,qBAAa,EAAE,SAAS,IAAI;AAE3C,QAAM,SAASC,gCAAgB,eAAe;AAC9C,QAAM,YAAYC,kCAAoB,WAAW;AACjD,QAAM,YAAY,MAAMC,yBAAU,WAAW,QAAQ,EAAE,QAAQ;AAE/D,MAAI,CAAC,UAAU,iBAAiB;AAC9B,UAAM,IAAI,MAAM,iCAAiC,IAAI;AAAA;AAIvD,QAAM,EAAE,gBAAgB,MAAM,UAAU;AACxC,MAAI,CAAC,aAAa;AAEhB,UAAM,IAAI,MAAM;AAAA;AAIlB,QAAM,iBAAiB,IAAI;AAC3B,QAAM,qBAAqB,SAAS,IAAI,aAAa;AAErD,MAAI,CAAC,OAAO,UAAU,uBAAuB,sBAAsB,GAAG;AACpE,UAAM,IAAI,MACR,gDAAgD,IAAI;AAAA;AAIxD,QAAM,UAAU,gBAAgB;AAAA,IAC9B,aAAa;AAAA,IACb;AAAA;AAAA;;;;"}

package/dist/cjs/mkdocs-f1cf9408.cjs.js

@@ -0,0 +1,47 @@
+'use strict';
+
+var openBrowser = require('react-dev-utils/openBrowser');
+var utility = require('./utility-6042a9ba.cjs.js');
+var mkdocsServer = require('./mkdocsServer-7058189d.cjs.js');
+require('winston');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var openBrowser__default = /*#__PURE__*/_interopDefaultLegacy(openBrowser);
+
+async function serveMkdocs(cmd) {
+  const logger = utility.createLogger({ verbose: cmd.verbose });
+  const dockerAddr = `http://0.0.0.0:${cmd.port}`;
+  const localAddr = `http://127.0.0.1:${cmd.port}`;
+  const expectedDevAddr = cmd.docker ? dockerAddr : localAddr;
+  let boolOpenBrowserTriggered = false;
+  const logFunc = (data) => {
+    const logLines = data.toString().split("\n");
+    const logPrefix = cmd.docker ? "[docker/mkdocs]" : "[mkdocs]";
+    logLines.forEach((line) => {
+      if (line === "") {
+        return;
+      }
+      logger.verbose(`${logPrefix} ${line}`);
+      if (!boolOpenBrowserTriggered && line.includes(`Serving on ${expectedDevAddr}`)) {
+        logger.info(`
+Starting mkdocs server on ${localAddr}
+`);
+        openBrowser__default["default"](localAddr);
+        boolOpenBrowserTriggered = true;
+      }
+    });
+  };
+  const childProcess = await mkdocsServer.runMkdocsServer({
+    port: cmd.port,
+    dockerImage: cmd.dockerImage,
+    useDocker: cmd.docker,
+    stdoutLogFunc: logFunc,
+    stderrLogFunc: logFunc
+  });
+  await mkdocsServer.waitForSignal([childProcess]);
+}
+
+exports["default"] = serveMkdocs;
+//# sourceMappingURL=mkdocs-f1cf9408.cjs.js.map

package/dist/cjs/mkdocs-f1cf9408.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocs-f1cf9408.cjs.js","sources":["../../src/commands/serve/mkdocs.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Command } from 'commander';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\n\nexport default async function serveMkdocs(cmd: Command) {\n  const logger = createLogger({ verbose: cmd.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${cmd.port}`;\n  const localAddr = `http://127.0.0.1:${cmd.port}`;\n  const expectedDevAddr = cmd.docker ? dockerAddr : localAddr;\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = cmd.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: cmd.port,\n    dockerImage: cmd.dockerImage,\n    useDocker: cmd.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n}\n"],"names":["createLogger","runMkdocsServer","waitForSignal"],"mappings":";;;;;;;;;;;;2BAsB0C,KAAc;AACtD,QAAM,SAASA,qBAAa,EAAE,SAAS,IAAI;AAE3C,QAAM,aAAa,kBAAkB,IAAI;AACzC,QAAM,YAAY,oBAAoB,IAAI;AAC1C,QAAM,kBAAkB,IAAI,SAAS,aAAa;AAElD,MAAI,2BAA2B;AAE/B,QAAM,UAAmB,UAAQ;AAE/B,UAAM,WAAW,KAAK,WAAW,MAAM;AACvC,UAAM,YAAY,IAAI,SAAS,oBAAoB;AACnD,aAAS,QAAQ,UAAQ;AACvB,UAAI,SAAS,IAAI;AACf;AAAA;AAIF,aAAO,QAAQ,GAAG,aAAa;AAG/B,UACE,CAAC,4BACD,KAAK,SAAS,cAAc,oBAC5B;AAEA,eAAO,KAAK;AAAA,4BAA+B;AAAA;AAC3C,wCAAY;AACZ,mCAA2B;AAAA;AAAA;AAAA;AASjC,QAAM,eAAe,MAAMC,6BAAgB;AAAA,IACzC,MAAM,IAAI;AAAA,IACV,aAAa,IAAI;AAAA,IACjB,WAAW,IAAI;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA;AAIjB,QAAMC,2BAAc,CAAC;AAAA;;;;"}

package/dist/cjs/mkdocsServer-7058189d.cjs.js

@@ -0,0 +1,88 @@
+'use strict';
+
+var child_process = require('child_process');
+
+const run = async (name, args = [], options = {}) => {
+  var _a;
+  const { stdoutLogFunc, stderrLogFunc } = options;
+  const env = {
+    ...process.env,
+    FORCE_COLOR: "true",
+    ...(_a = options.env) != null ? _a : {}
+  };
+  const stdio = [
+    "inherit",
+    stdoutLogFunc ? "pipe" : "inherit",
+    stderrLogFunc ? "pipe" : "inherit"
+  ];
+  const childProcess = child_process.spawn(name, args, {
+    stdio,
+    ...options,
+    env
+  });
+  if (stdoutLogFunc && childProcess.stdout) {
+    childProcess.stdout.on("data", stdoutLogFunc);
+  }
+  if (stderrLogFunc && childProcess.stderr) {
+    childProcess.stderr.on("data", stderrLogFunc);
+  }
+  return childProcess;
+};
+async function waitForSignal(childProcesses) {
+  const promises = [];
+  for (const signal of ["SIGINT", "SIGTERM"]) {
+    process.on(signal, () => {
+      childProcesses.forEach((childProcess) => {
+        childProcess.kill();
+      });
+    });
+  }
+  childProcesses.forEach((childProcess) => {
+    if (typeof childProcess.exitCode === "number") {
+      if (childProcess.exitCode) {
+        throw new Error(`Non zero exit code from child process`);
+      }
+      return;
+    }
+    promises.push(new Promise((resolve, reject) => {
+      childProcess.once("error", reject);
+      childProcess.once("exit", resolve);
+    }));
+  });
+  await Promise.all(promises);
+}
+
+const runMkdocsServer = async (options) => {
+  var _a, _b, _c;
+  const port = (_a = options.port) != null ? _a : "8000";
+  const useDocker = (_b = options.useDocker) != null ? _b : true;
+  const dockerImage = (_c = options.dockerImage) != null ? _c : "spotify/techdocs";
+  if (useDocker) {
+    return await run("docker", [
+      "run",
+      "--rm",
+      "-w",
+      "/content",
+      "-v",
+      `${process.cwd()}:/content`,
+      "-p",
+      `${port}:${port}`,
+      "-it",
+      dockerImage,
+      "serve",
+      "--dev-addr",
+      `0.0.0.0:${port}`
+    ], {
+      stdoutLogFunc: options.stdoutLogFunc,
+      stderrLogFunc: options.stderrLogFunc
+    });
+  }
+  return await run("mkdocs", ["serve", "--dev-addr", `127.0.0.1:${port}`], {
+    stdoutLogFunc: options.stdoutLogFunc,
+    stderrLogFunc: options.stderrLogFunc
+  });
+};
+
+exports.runMkdocsServer = runMkdocsServer;
+exports.waitForSignal = waitForSignal;
+//# sourceMappingURL=mkdocsServer-7058189d.cjs.js.map

package/dist/cjs/mkdocsServer-7058189d.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocsServer-7058189d.cjs.js","sources":["../../src/lib/run.ts","../../src/lib/mkdocsServer.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { spawn, SpawnOptions, ChildProcess } from 'child_process';\n\nexport type LogFunc = (data: Buffer | string) => void;\ntype SpawnOptionsPartialEnv = Omit<SpawnOptions, 'env'> & {\n  env?: Partial<NodeJS.ProcessEnv>;\n  // Pipe stdout to this log function\n  stdoutLogFunc?: LogFunc;\n  // Pipe stderr to this log function\n  stderrLogFunc?: LogFunc;\n};\n\n// TODO: Accept log functions to pipe logs with.\n// Runs a child command, returning the child process instance.\n// Use it along with waitForSignal to run a long running process e.g. mkdocs serve\nexport const run = async (\n  name: string,\n  args: string[] = [],\n  options: SpawnOptionsPartialEnv = {},\n): Promise<ChildProcess> => {\n  const { stdoutLogFunc, stderrLogFunc } = options;\n\n  const env: NodeJS.ProcessEnv = {\n    ...process.env,\n    FORCE_COLOR: 'true',\n    ...(options.env ?? {}),\n  };\n\n  // Refer: https://nodejs.org/api/child_process.html#child_process_subprocess_stdio\n  const stdio = [\n    'inherit',\n    stdoutLogFunc ? 'pipe' : 'inherit',\n    stderrLogFunc ? 'pipe' : 'inherit',\n  ] as ('inherit' | 'pipe')[];\n\n  const childProcess = spawn(name, args, {\n    stdio: stdio,\n    ...options,\n    env,\n  });\n\n  if (stdoutLogFunc && childProcess.stdout) {\n    childProcess.stdout.on('data', stdoutLogFunc);\n  }\n  if (stderrLogFunc && childProcess.stderr) {\n    childProcess.stderr.on('data', stderrLogFunc);\n  }\n\n  return childProcess;\n};\n\n// Block indefinitely and wait for a signal to kill the child process(es)\n// Throw error if any child process errors\n// Resolves only when all processes exit with status code 0\nexport async function waitForSignal(\n  childProcesses: Array<ChildProcess>,\n): Promise<void> {\n  const promises: Array<Promise<void>> = [];\n\n  for (const signal of ['SIGINT', 'SIGTERM'] as const) {\n    process.on(signal, () => {\n      childProcesses.forEach(childProcess => {\n        childProcess.kill();\n      });\n    });\n  }\n\n  childProcesses.forEach(childProcess => {\n    if (typeof childProcess.exitCode === 'number') {\n      if (childProcess.exitCode) {\n        throw new Error(`Non zero exit code from child process`);\n      }\n      return;\n    }\n\n    promises.push(\n      new Promise<void>((resolve, reject) => {\n        childProcess.once('error', reject);\n        childProcess.once('exit', resolve);\n      }),\n    );\n  });\n\n  await Promise.all(promises);\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ChildProcess } from 'child_process';\nimport { run, LogFunc } from './run';\n\nexport const runMkdocsServer = async (options: {\n  port?: string;\n  useDocker?: boolean;\n  dockerImage?: string;\n  stdoutLogFunc?: LogFunc;\n  stderrLogFunc?: LogFunc;\n}): Promise<ChildProcess> => {\n  const port = options.port ?? '8000';\n  const useDocker = options.useDocker ?? true;\n  const dockerImage = options.dockerImage ?? 'spotify/techdocs';\n\n  if (useDocker) {\n    return await run(\n      'docker',\n      [\n        'run',\n        '--rm',\n        '-w',\n        '/content',\n        '-v',\n        `${process.cwd()}:/content`,\n        '-p',\n        `${port}:${port}`,\n        '-it',\n        dockerImage,\n        'serve',\n        '--dev-addr',\n        `0.0.0.0:${port}`,\n      ],\n      {\n        stdoutLogFunc: options.stdoutLogFunc,\n        stderrLogFunc: options.stderrLogFunc,\n      },\n    );\n  }\n\n  return await run('mkdocs', ['serve', '--dev-addr', `127.0.0.1:${port}`], {\n    stdoutLogFunc: options.stdoutLogFunc,\n    stderrLogFunc: options.stderrLogFunc,\n  });\n};\n"],"names":["spawn"],"mappings":";;;;MA6Ba,MAAM,OACjB,MACA,OAAiB,IACjB,UAAkC,OACR;AAjC5B;AAkCE,QAAM,EAAE,eAAe,kBAAkB;AAEzC,QAAM,MAAyB;AAAA,OAC1B,QAAQ;AAAA,IACX,aAAa;AAAA,OACT,cAAQ,QAAR,YAAe;AAAA;AAIrB,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA,gBAAgB,SAAS;AAAA,IACzB,gBAAgB,SAAS;AAAA;AAG3B,QAAM,eAAeA,oBAAM,MAAM,MAAM;AAAA,IACrC;AAAA,OACG;AAAA,IACH;AAAA;AAGF,MAAI,iBAAiB,aAAa,QAAQ;AACxC,iBAAa,OAAO,GAAG,QAAQ;AAAA;AAEjC,MAAI,iBAAiB,aAAa,QAAQ;AACxC,iBAAa,OAAO,GAAG,QAAQ;AAAA;AAGjC,SAAO;AAAA;6BAOP,gBACe;AACf,QAAM,WAAiC;AAEvC,aAAW,UAAU,CAAC,UAAU,YAAqB;AACnD,YAAQ,GAAG,QAAQ,MAAM;AACvB,qBAAe,QAAQ,kBAAgB;AACrC,qBAAa;AAAA;AAAA;AAAA;AAKnB,iBAAe,QAAQ,kBAAgB;AACrC,QAAI,OAAO,aAAa,aAAa,UAAU;AAC7C,UAAI,aAAa,UAAU;AACzB,cAAM,IAAI,MAAM;AAAA;AAElB;AAAA;AAGF,aAAS,KACP,IAAI,QAAc,CAAC,SAAS,WAAW;AACrC,mBAAa,KAAK,SAAS;AAC3B,mBAAa,KAAK,QAAQ;AAAA;AAAA;AAKhC,QAAM,QAAQ,IAAI;AAAA;;MC9EP,kBAAkB,OAAO,YAMT;AAzB7B;AA0BE,QAAM,OAAO,cAAQ,SAAR,YAAgB;AAC7B,QAAM,YAAY,cAAQ,cAAR,YAAqB;AACvC,QAAM,cAAc,cAAQ,gBAAR,YAAuB;AAE3C,MAAI,WAAW;AACb,WAAO,MAAM,IACX,UACA;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,GAAG,QAAQ;AAAA,MACX;AAAA,MACA,GAAG,QAAQ;AAAA,MACX;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW;AAAA,OAEb;AAAA,MACE,eAAe,QAAQ;AAAA,MACvB,eAAe,QAAQ;AAAA;AAAA;AAK7B,SAAO,MAAM,IAAI,UAAU,CAAC,SAAS,cAAc,aAAa,SAAS;AAAA,IACvE,eAAe,QAAQ;AAAA,IACvB,eAAe,QAAQ;AAAA;AAAA;;;;;"}

package/dist/cjs/publish-d1ccb001.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var path = require('path');
+var utility = require('./utility-6042a9ba.cjs.js');
+var backendCommon = require('@backstage/backend-common');
+var techdocsCommon = require('@backstage/techdocs-common');
+var PublisherConfig = require('./PublisherConfig-a09bdfcc.cjs.js');
+require('winston');
+require('@backstage/config');
+
+async function publish(cmd) {
+  const logger = utility.createLogger({ verbose: cmd.verbose });
+  const config = PublisherConfig.PublisherConfig.getValidConfig(cmd);
+  const discovery = backendCommon.SingleHostDiscovery.fromConfig(config);
+  const publisher = await techdocsCommon.Publisher.fromConfig(config, { logger, discovery });
+  const { isAvailable } = await publisher.getReadiness();
+  if (!isAvailable) {
+    return Promise.reject(new Error(""));
+  }
+  const [namespace, kind, name] = cmd.entity.split("/");
+  const entity = {
+    kind,
+    metadata: {
+      namespace,
+      name
+    }
+  };
+  const directory = path.resolve(cmd.directory);
+  await publisher.publish({ entity, directory });
+  return true;
+}
+
+exports["default"] = publish;
+//# sourceMappingURL=publish-d1ccb001.cjs.js.map

package/dist/cjs/publish-d1ccb001.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-d1ccb001.cjs.js","sources":["../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { resolve } from 'path';\nimport { Command } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { SingleHostDiscovery } from '@backstage/backend-common';\nimport { Publisher } from '@backstage/techdocs-common';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(cmd: Command): Promise<any> {\n  const logger = createLogger({ verbose: cmd.verbose });\n\n  const config = PublisherConfig.getValidConfig(cmd);\n  const discovery = SingleHostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    return Promise.reject(new Error(''));\n  }\n\n  const [namespace, kind, name] = cmd.entity.split('/');\n  const entity = {\n    kind,\n    metadata: {\n      namespace,\n      name,\n    },\n  } as Entity;\n\n  const directory = resolve(cmd.directory);\n  await publisher.publish({ entity, directory });\n\n  return true;\n}\n"],"names":["createLogger","PublisherConfig","SingleHostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;uBAwBsC,KAA4B;AAChE,QAAM,SAASA,qBAAa,EAAE,SAAS,IAAI;AAE3C,QAAM,SAASC,gCAAgB,eAAe;AAC9C,QAAM,YAAYC,kCAAoB,WAAW;AACjD,QAAM,YAAY,MAAMC,yBAAU,WAAW,QAAQ,EAAE,QAAQ;AAG/D,QAAM,EAAE,gBAAgB,MAAM,UAAU;AACxC,MAAI,CAAC,aAAa;AAEhB,WAAO,QAAQ,OAAO,IAAI,MAAM;AAAA;AAGlC,QAAM,CAAC,WAAW,MAAM,QAAQ,IAAI,OAAO,MAAM;AACjD,QAAM,SAAS;AAAA,IACb;AAAA,IACA,UAAU;AAAA,MACR;AAAA,MACA;AAAA;AAAA;AAIJ,QAAM,YAAYC,aAAQ,IAAI;AAC9B,QAAM,UAAU,QAAQ,EAAE,QAAQ;AAElC,SAAO;AAAA;;;;"}

package/dist/cjs/serve-639872a5.cjs.js

@@ -0,0 +1,131 @@
+'use strict';
+
+var path = require('path');
+var openBrowser = require('react-dev-utils/openBrowser');
+var serveHandler = require('serve-handler');
+var http = require('http');
+var httpProxy = require('http-proxy');
+var utility = require('./utility-6042a9ba.cjs.js');
+var mkdocsServer = require('./mkdocsServer-7058189d.cjs.js');
+require('winston');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var openBrowser__default = /*#__PURE__*/_interopDefaultLegacy(openBrowser);
+var serveHandler__default = /*#__PURE__*/_interopDefaultLegacy(serveHandler);
+var http__default = /*#__PURE__*/_interopDefaultLegacy(http);
+var httpProxy__default = /*#__PURE__*/_interopDefaultLegacy(httpProxy);
+
+class HTTPServer {
+  constructor(backstageBundleDir, backstagePort, mkdocsPort, verbose) {
+    this.proxyEndpoint = "/api/";
+    this.backstageBundleDir = backstageBundleDir;
+    this.backstagePort = backstagePort;
+    this.mkdocsPort = mkdocsPort;
+    this.verbose = verbose;
+  }
+  createProxy() {
+    const proxy = httpProxy__default["default"].createProxyServer({
+      target: `http://localhost:${this.mkdocsPort}`
+    });
+    return (request) => {
+      var _a, _b;
+      const [, , ...pathChunks] = (_b = (_a = request.url) == null ? void 0 : _a.split("/")) != null ? _b : [];
+      const forwardPath = pathChunks.join("/");
+      return [proxy, forwardPath];
+    };
+  }
+  async serve() {
+    return new Promise((resolve, reject) => {
+      const proxyHandler = this.createProxy();
+      const server = http__default["default"].createServer((request, response) => {
+        var _a;
+        if ((_a = request.url) == null ? void 0 : _a.startsWith(this.proxyEndpoint)) {
+          const [proxy, forwardPath] = proxyHandler(request);
+          proxy.on("error", (error) => {
+            reject(error);
+          });
+          response.setHeader("Access-Control-Allow-Origin", "*");
+          response.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
+          request.url = forwardPath;
+          return proxy.web(request, response);
+        }
+        return serveHandler__default["default"](request, response, {
+          public: this.backstageBundleDir,
+          trailingSlash: true,
+          rewrites: [{ source: "**", destination: "index.html" }]
+        });
+      });
+      const logger = utility.createLogger({ verbose: false });
+      server.listen(this.backstagePort, () => {
+        if (this.verbose) {
+          logger.info(`[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`);
+        }
+        resolve(server);
+      });
+      server.on("error", (error) => {
+        reject(error);
+      });
+    });
+  }
+}
+
+async function serve(cmd) {
+  const logger = utility.createLogger({ verbose: cmd.verbose });
+  const isDevMode = Object.keys(process.env).includes("TECHDOCS_CLI_DEV_MODE") ? true : false;
+  const backstagePort = 3e3;
+  const backstageBackendPort = 7007;
+  const mkdocsDockerAddr = `http://0.0.0.0:${cmd.mkdocsPort}`;
+  const mkdocsLocalAddr = `http://127.0.0.1:${cmd.mkdocsPort}`;
+  const mkdocsExpectedDevAddr = cmd.docker ? mkdocsDockerAddr : mkdocsLocalAddr;
+  let mkdocsServerHasStarted = false;
+  const mkdocsLogFunc = (data) => {
+    const logLines = data.toString().split("\n");
+    const logPrefix = cmd.docker ? "[docker/mkdocs]" : "[mkdocs]";
+    logLines.forEach((line) => {
+      if (line === "") {
+        return;
+      }
+      logger.verbose(`${logPrefix} ${line}`);
+      if (!mkdocsServerHasStarted && line.includes(`Serving on ${mkdocsExpectedDevAddr}`)) {
+        mkdocsServerHasStarted = true;
+      }
+    });
+  };
+  logger.info("Starting mkdocs server.");
+  const mkdocsChildProcess = await mkdocsServer.runMkdocsServer({
+    port: cmd.mkdocsPort,
+    dockerImage: cmd.dockerImage,
+    useDocker: cmd.docker,
+    stdoutLogFunc: mkdocsLogFunc,
+    stderrLogFunc: mkdocsLogFunc
+  });
+  for (let attempt = 0; attempt < 30; attempt++) {
+    await new Promise((r) => setTimeout(r, 3e3));
+    if (mkdocsServerHasStarted) {
+      break;
+    }
+    logger.info("Waiting for mkdocs server to start...");
+  }
+  if (!mkdocsServerHasStarted) {
+    logger.error("mkdocs server did not start. Exiting. Try re-running command with -v option for more details.");
+  }
+  const techdocsPreviewBundlePath = path__default["default"].join(path__default["default"].dirname(require.resolve("@techdocs/cli/package.json")), "dist", "techdocs-preview-bundle");
+  const port = isDevMode ? backstageBackendPort : backstagePort;
+  const httpServer = new HTTPServer(techdocsPreviewBundlePath, port, cmd.mkdocsPort, cmd.verbose);
+  httpServer.serve().catch((err) => {
+    logger.error(err);
+    mkdocsChildProcess.kill();
+    process.exit(1);
+  }).then(() => {
+    openBrowser__default["default"](`http://localhost:${port}/docs/default/component/local/`);
+    logger.info(`Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/
+Opening browser.`);
+  });
+  await mkdocsServer.waitForSignal([mkdocsChildProcess]);
+}
+
+exports["default"] = serve;
+//# sourceMappingURL=serve-639872a5.cjs.js.map

package/dist/cjs/serve-639872a5.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-639872a5.cjs.js","sources":["../../src/lib/httpServer.ts","../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport serveHandler from 'serve-handler';\nimport http from 'http';\nimport httpProxy from 'http-proxy';\nimport { createLogger } from './utility';\n\nexport default class HTTPServer {\n  private readonly proxyEndpoint: string;\n  private readonly backstageBundleDir: string;\n  private readonly backstagePort: number;\n  private readonly mkdocsPort: number;\n  private readonly verbose: boolean;\n\n  constructor(\n    backstageBundleDir: string,\n    backstagePort: number,\n    mkdocsPort: number,\n    verbose: boolean,\n  ) {\n    this.proxyEndpoint = '/api/';\n    this.backstageBundleDir = backstageBundleDir;\n    this.backstagePort = backstagePort;\n    this.mkdocsPort = mkdocsPort;\n    this.verbose = verbose;\n  }\n\n  // Create a Proxy for mkdocs server\n  private createProxy() {\n    const proxy = httpProxy.createProxyServer({\n      target: `http://localhost:${this.mkdocsPort}`,\n    });\n\n    return (request: http.IncomingMessage): [httpProxy, string] => {\n      // If the request goes to /api/ we want to remove /api/ from the prefix of the request URL.\n      // e.g. ['/', 'api', pathChunks]\n      const [, , ...pathChunks] = request.url?.split('/') ?? [];\n      const forwardPath = pathChunks.join('/');\n\n      return [proxy, forwardPath];\n    };\n  }\n\n  public async serve(): Promise<http.Server> {\n    return new Promise<http.Server>((resolve, reject) => {\n      const proxyHandler = this.createProxy();\n      const server = http.createServer(\n        (request: http.IncomingMessage, response: http.ServerResponse) => {\n          if (request.url?.startsWith(this.proxyEndpoint)) {\n            const [proxy, forwardPath] = proxyHandler(request);\n\n            proxy.on('error', (error: Error) => {\n              reject(error);\n            });\n\n            response.setHeader('Access-Control-Allow-Origin', '*');\n            response.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');\n\n            request.url = forwardPath;\n            return proxy.web(request, response);\n          }\n\n          return serveHandler(request, response, {\n            public: this.backstageBundleDir,\n            trailingSlash: true,\n            rewrites: [{ source: '**', destination: 'index.html' }],\n          });\n        },\n      );\n\n      const logger = createLogger({ verbose: false });\n      server.listen(this.backstagePort, () => {\n        if (this.verbose) {\n          logger.info(\n            `[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`,\n          );\n        }\n        resolve(server);\n      });\n\n      server.on('error', (error: Error) => {\n        reject(error);\n      });\n    });\n  }\n}\n","/*\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 path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\n\nexport default async function serve(cmd: Command) {\n  const logger = createLogger({ verbose: cmd.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  // TODO: Backstage app port should also be configurable as a CLI option. However, since we bundle\n  // a backstage app, we define app.baseUrl in the app-config.yaml.\n  // Hence, it is complicated to make this configurable.\n  const backstagePort = 3000;\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${cmd.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${cmd.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = cmd.docker ? mkdocsDockerAddr : mkdocsLocalAddr;\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = cmd.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: cmd.mkdocsPort,\n    dockerImage: cmd.dockerImage,\n    useDocker: cmd.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  // Run the embedded-techdocs Backstage app\n  const techdocsPreviewBundlePath = path.join(\n    path.dirname(require.resolve('@techdocs/cli/package.json')),\n    'dist',\n    'techdocs-preview-bundle',\n  );\n\n  const port = isDevMode ? backstageBackendPort : backstagePort;\n  const httpServer = new HTTPServer(\n    techdocsPreviewBundlePath,\n    port,\n    cmd.mkdocsPort,\n    cmd.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error(err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n}\n"],"names":["httpProxy","http","serveHandler","createLogger","runMkdocsServer","path","waitForSignal"],"mappings":";;;;;;;;;;;;;;;;;;;;iBAqBgC;AAAA,EAO9B,YACE,oBACA,eACA,YACA,SACA;AACA,SAAK,gBAAgB;AACrB,SAAK,qBAAqB;AAC1B,SAAK,gBAAgB;AACrB,SAAK,aAAa;AAClB,SAAK,UAAU;AAAA;AAAA,EAIT,cAAc;AACpB,UAAM,QAAQA,8BAAU,kBAAkB;AAAA,MACxC,QAAQ,oBAAoB,KAAK;AAAA;AAGnC,WAAO,CAAC,YAAuD;AA/CnE;AAkDM,YAAM,QAAQ,cAAc,oBAAQ,QAAR,mBAAa,MAAM,SAAnB,YAA2B;AACvD,YAAM,cAAc,WAAW,KAAK;AAEpC,aAAO,CAAC,OAAO;AAAA;AAAA;AAAA,QAIN,QAA8B;AACzC,WAAO,IAAI,QAAqB,CAAC,SAAS,WAAW;AACnD,YAAM,eAAe,KAAK;AAC1B,YAAM,SAASC,yBAAK,aAClB,CAAC,SAA+B,aAAkC;AA7D1E;AA8DU,YAAI,cAAQ,QAAR,mBAAa,WAAW,KAAK,gBAAgB;AAC/C,gBAAM,CAAC,OAAO,eAAe,aAAa;AAE1C,gBAAM,GAAG,SAAS,CAAC,UAAiB;AAClC,mBAAO;AAAA;AAGT,mBAAS,UAAU,+BAA+B;AAClD,mBAAS,UAAU,gCAAgC;AAEnD,kBAAQ,MAAM;AACd,iBAAO,MAAM,IAAI,SAAS;AAAA;AAG5B,eAAOC,iCAAa,SAAS,UAAU;AAAA,UACrC,QAAQ,KAAK;AAAA,UACb,eAAe;AAAA,UACf,UAAU,CAAC,EAAE,QAAQ,MAAM,aAAa;AAAA;AAAA;AAK9C,YAAM,SAASC,qBAAa,EAAE,SAAS;AACvC,aAAO,OAAO,KAAK,eAAe,MAAM;AACtC,YAAI,KAAK,SAAS;AAChB,iBAAO,KACL,oFAAoF,KAAK;AAAA;AAG7F,gBAAQ;AAAA;AAGV,aAAO,GAAG,SAAS,CAAC,UAAiB;AACnC,eAAO;AAAA;AAAA;AAAA;AAAA;;qBCvEqB,KAAc;AAChD,QAAM,SAASA,qBAAa,EAAE,SAAS,IAAI;AAK3C,QAAM,YAAY,OAAO,KAAK,QAAQ,KAAK,SAAS,2BAChD,OACA;AAKJ,QAAM,gBAAgB;AACtB,QAAM,uBAAuB;AAE7B,QAAM,mBAAmB,kBAAkB,IAAI;AAC/C,QAAM,kBAAkB,oBAAoB,IAAI;AAChD,QAAM,wBAAwB,IAAI,SAAS,mBAAmB;AAE9D,MAAI,yBAAyB;AAC7B,QAAM,gBAAyB,UAAQ;AAErC,UAAM,WAAW,KAAK,WAAW,MAAM;AACvC,UAAM,YAAY,IAAI,SAAS,oBAAoB;AACnD,aAAS,QAAQ,UAAQ;AACvB,UAAI,SAAS,IAAI;AACf;AAAA;AAGF,aAAO,QAAQ,GAAG,aAAa;AAG/B,UACE,CAAC,0BACD,KAAK,SAAS,cAAc,0BAC5B;AACA,iCAAyB;AAAA;AAAA;AAAA;AAO/B,SAAO,KAAK;AACZ,QAAM,qBAAqB,MAAMC,6BAAgB;AAAA,IAC/C,MAAM,IAAI;AAAA,IACV,aAAa,IAAI;AAAA,IACjB,WAAW,IAAI;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA;AAKjB,WAAS,UAAU,GAAG,UAAU,IAAI,WAAW;AAC7C,UAAM,IAAI,QAAQ,OAAK,WAAW,GAAG;AACrC,QAAI,wBAAwB;AAC1B;AAAA;AAEF,WAAO,KAAK;AAAA;AAGd,MAAI,CAAC,wBAAwB;AAC3B,WAAO,MACL;AAAA;AAKJ,QAAM,4BAA4BC,yBAAK,KACrCA,yBAAK,QAAQ,QAAQ,QAAQ,gCAC7B,QACA;AAGF,QAAM,OAAO,YAAY,uBAAuB;AAChD,QAAM,aAAa,IAAI,WACrB,2BACA,MACA,IAAI,YACJ,IAAI;AAGN,aACG,QACA,MAAM,SAAO;AACZ,WAAO,MAAM;AACb,uBAAmB;AACnB,YAAQ,KAAK;AAAA,KAEd,KAAK,MAAM;AAEV,oCAAY,oBAAoB;AAChC,WAAO,KACL,iDAAiD;AAAA;AAAA;AAIvD,QAAMC,2BAAc,CAAC;AAAA;;;;"}