@backstage/plugin-techdocs-node 1.12.4 → 1.12.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/plugin-techdocs-node
 
+## 1.12.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.22.1-next.0
+  - @backstage/backend-plugin-api@0.6.19-next.0
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.11.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/plugin-search-common@1.2.11
+
 ## 1.12.4
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -107,9 +107,8 @@ const getStaleFiles = (newFiles, oldFiles) => {
   return Array.from(staleFiles);
 };
 const getCloudPathForLocalPath = (entity, localPath = "", useLegacyPathCasing = false, externalStorageRootPath = "") => {
-  var _a, _b;
   const relativeFilePathPosix = localPath.split(path__default.default.sep).join(path__default.default.posix.sep);
-  const entityRootDir = `${(_b = (_a = entity.metadata) == null ? void 0 : _a.namespace) != null ? _b : catalogModel.DEFAULT_NAMESPACE}/${entity.kind}/${entity.metadata.name}`;
+  const entityRootDir = `${entity.metadata?.namespace ?? catalogModel.DEFAULT_NAMESPACE}/${entity.kind}/${entity.metadata.name}`;
   const relativeFilePathTriplet = `${entityRootDir}/${relativeFilePathPosix}`;
   const destination = useLegacyPathCasing ? relativeFilePathTriplet : lowerCaseEntityTriplet(relativeFilePathTriplet);
   const destinationWithRoot = [
@@ -187,10 +186,7 @@ const MKDOCS_SCHEMA = yaml.DEFAULT_SCHEMA.extend([
     kind: "scalar",
     multi: true,
     representName: (o) => o.type,
-    represent: (o) => {
-      var _a;
-      return (_a = o.data) != null ? _a : "";
-    },
+    represent: (o) => o.data ?? "",
     instanceOf: UnknownTag,
     construct: (data, type) => new UnknownTag(data, type)
   }),
@@ -198,19 +194,15 @@ const MKDOCS_SCHEMA = yaml.DEFAULT_SCHEMA.extend([
     kind: "sequence",
     multi: true,
     representName: (o) => o.type,
-    represent: (o) => {
-      var _a;
-      return (_a = o.data) != null ? _a : "";
-    },
+    represent: (o) => o.data ?? "",
     instanceOf: UnknownTag,
     construct: (data, type) => new UnknownTag(data, type)
   })
 ]);
 const generateMkdocsYml = async (inputDir, siteOptions) => {
-  var _a;
   try {
     const mkdocsYmlPath = path__default.default.join(inputDir, "mkdocs.yml");
-    const defaultSiteName = (_a = siteOptions == null ? void 0 : siteOptions.name) != null ? _a : "Documentation Site";
+    const defaultSiteName = siteOptions?.name ?? "Documentation Site";
     const defaultMkdocsContent = {
       site_name: defaultSiteName,
       docs_dir: "docs",
@@ -228,7 +220,7 @@ const getMkdocsYml = async (inputDir, options) => {
   let mkdocsYmlPath;
   let mkdocsYmlFileString;
   try {
-    if (options == null ? void 0 : options.mkdocsConfigFileName) {
+    if (options?.mkdocsConfigFileName) {
       mkdocsYmlPath = path__default.default.join(inputDir, options.mkdocsConfigFileName);
       if (!await fs__default.default.pathExists(mkdocsYmlPath)) {
         throw new Error(`The specified file ${mkdocsYmlPath} does not exist`);
@@ -437,23 +429,16 @@ const patchMkdocsYmlWithPlugins = async (mkdocsYmlPath, logger, defaultPlugins =
   });
 };
 
-var __defProp$a = Object.defineProperty;
-var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$a = (obj, key, value) => {
-  __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-const _TechdocsGenerator = class _TechdocsGenerator {
-  constructor(options) {
-    __publicField$a(this, "logger");
-    __publicField$a(this, "containerRunner");
-    __publicField$a(this, "options");
-    __publicField$a(this, "scmIntegrations");
-    this.logger = options.logger;
-    this.options = readGeneratorConfig(options.config, options.logger);
-    this.containerRunner = options.containerRunner;
-    this.scmIntegrations = options.scmIntegrations;
-  }
+class TechdocsGenerator {
+  /**
+   * The default docker image (and version) used to generate content. Public
+   * and static so that techdocs-node consumers can use the same version.
+   */
+  static defaultDockerImage = "spotify/techdocs:v1.2.3";
+  logger;
+  containerRunner;
+  options;
+  scmIntegrations;
   /**
    * Returns a instance of TechDocs generator
    * @param config - A Backstage configuration
@@ -462,16 +447,21 @@ const _TechdocsGenerator = class _TechdocsGenerator {
   static fromConfig(config, options) {
     const { containerRunner, logger } = options;
     const scmIntegrations = integration.ScmIntegrations.fromConfig(config);
-    return new _TechdocsGenerator({
+    return new TechdocsGenerator({
       logger,
       containerRunner,
       config,
       scmIntegrations
     });
   }
+  constructor(options) {
+    this.logger = options.logger;
+    this.options = readGeneratorConfig(options.config, options.logger);
+    this.containerRunner = options.containerRunner;
+    this.scmIntegrations = options.scmIntegrations;
+  }
   /** {@inheritDoc GeneratorBase.run} */
   async run(options) {
-    var _a, _b;
     const {
       inputDir,
       outputDir,
@@ -498,7 +488,7 @@ const _TechdocsGenerator = class _TechdocsGenerator {
     if (this.options.legacyCopyReadmeMdToIndexMd) {
       await patchIndexPreBuild({ inputDir, logger: childLogger, docsDir });
     }
-    const defaultPlugins = (_a = this.options.defaultPlugins) != null ? _a : [];
+    const defaultPlugins = this.options.defaultPlugins ?? [];
     if (!this.options.omitTechdocsCoreMkdocsPlugin && !defaultPlugins.includes("techdocs-core")) {
       defaultPlugins.push("techdocs-core");
     }
@@ -529,7 +519,7 @@ const _TechdocsGenerator = class _TechdocsGenerator {
             );
           }
           await this.containerRunner.runContainer({
-            imageName: (_b = this.options.dockerImage) != null ? _b : _TechdocsGenerator.defaultDockerImage,
+            imageName: this.options.dockerImage ?? TechdocsGenerator.defaultDockerImage,
             args: ["build", "-d", "/output"],
             logStream,
             mountDirs,
@@ -569,15 +559,8 @@ const _TechdocsGenerator = class _TechdocsGenerator {
       );
     }
   }
-};
-/**
- * The default docker image (and version) used to generate content. Public
- * and static so that techdocs-node consumers can use the same version.
- */
-__publicField$a(_TechdocsGenerator, "defaultDockerImage", "spotify/techdocs:v1.2.3");
-let TechdocsGenerator = _TechdocsGenerator;
+}
 function readGeneratorConfig(config, logger) {
-  var _a;
   const legacyGeneratorType = config.getOptionalString(
     "techdocs.generators.techdocs"
   );
@@ -587,7 +570,7 @@ function readGeneratorConfig(config, logger) {
     );
   }
   return {
-    runIn: (_a = legacyGeneratorType != null ? legacyGeneratorType : config.getOptionalString("techdocs.generator.runIn")) != null ? _a : "docker",
+    runIn: legacyGeneratorType ?? config.getOptionalString("techdocs.generator.runIn") ?? "docker",
     dockerImage: config.getOptionalString("techdocs.generator.dockerImage"),
     pullImage: config.getOptionalBoolean("techdocs.generator.pullImage"),
     omitTechdocsCoreMkdocsPlugin: config.getOptionalBoolean(
@@ -602,25 +585,16 @@ function readGeneratorConfig(config, logger) {
   };
 }
 
-var __defProp$9 = Object.defineProperty;
-var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$9 = (obj, key, value) => {
-  __defNormalProp$9(obj, key + "" , value);
-  return value;
-};
 class Generators {
-  constructor() {
-    __publicField$9(this, "generatorMap", /* @__PURE__ */ new Map());
-  }
+  generatorMap = /* @__PURE__ */ new Map();
   /**
    * Returns a generators instance containing a generator for TechDocs
    * @param config - A Backstage configuration
    * @param options - Options to configure the TechDocs generator
    */
   static async fromConfig(config, options) {
-    var _a;
     const generators = new Generators();
-    const techdocsGenerator = (_a = options.customGenerator) != null ? _a : TechdocsGenerator.fromConfig(config, options);
+    const techdocsGenerator = options.customGenerator ?? TechdocsGenerator.fromConfig(config, options);
     generators.register("techdocs", techdocsGenerator);
     return generators;
   }
@@ -649,8 +623,7 @@ class Generators {
 const getMkDocsYml = getMkdocsYml;
 
 const parseReferenceAnnotation = (annotationName, entity) => {
-  var _a;
-  const annotation = (_a = entity.metadata.annotations) == null ? void 0 : _a[annotationName];
+  const annotation = entity.metadata.annotations?.[annotationName];
   if (!annotation) {
     throw new errors.InputError(
       `No location annotation provided in entity: ${entity.metadata.name}`
@@ -704,34 +677,23 @@ const getLocationForEntity = (entity, scmIntegration) => {
   }
 };
 const getDocFilesFromRepository = async (reader, entity, opts) => {
-  var _a, _b;
   const { target } = parseReferenceAnnotation(
     "backstage.io/techdocs-ref",
     entity
   );
-  (_a = opts == null ? void 0 : opts.logger) == null ? void 0 : _a.debug(`Reading files from ${target}`);
-  const readTreeResponse = await reader.readTree(target, { etag: opts == null ? void 0 : opts.etag });
+  opts?.logger?.debug(`Reading files from ${target}`);
+  const readTreeResponse = await reader.readTree(target, { etag: opts?.etag });
   const preparedDir = await readTreeResponse.dir();
-  (_b = opts == null ? void 0 : opts.logger) == null ? void 0 : _b.debug(`Tree downloaded and stored at ${preparedDir}`);
+  opts?.logger?.debug(`Tree downloaded and stored at ${preparedDir}`);
   return {
     preparedDir,
     etag: readTreeResponse.etag
   };
 };
 
-var __defProp$8 = Object.defineProperty;
-var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$8 = (obj, key, value) => {
-  __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class DirectoryPreparer {
-  constructor(config, _logger, reader) {
-    __publicField$8(this, "scmIntegrations");
-    __publicField$8(this, "reader");
-    this.reader = reader;
-    this.scmIntegrations = integration.ScmIntegrations.fromConfig(config);
-  }
+  scmIntegrations;
+  reader;
   /**
    * Returns a directory preparer instance
    * @param config - A backstage config
@@ -740,13 +702,16 @@ class DirectoryPreparer {
   static fromConfig(config, options) {
     return new DirectoryPreparer(config, options.logger, options.reader);
   }
+  constructor(config, _logger, reader) {
+    this.reader = reader;
+    this.scmIntegrations = integration.ScmIntegrations.fromConfig(config);
+  }
   /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
   shouldCleanPreparedDirectory() {
     return false;
   }
   /** {@inheritDoc PreparerBase.prepare} */
   async prepare(entity, options) {
-    var _a, _b;
     const annotation = parseReferenceAnnotation(
       "backstage.io/techdocs-ref",
       entity
@@ -758,12 +723,12 @@ class DirectoryPreparer {
     );
     switch (type) {
       case "url": {
-        (_a = options == null ? void 0 : options.logger) == null ? void 0 : _a.debug(`Reading files from ${target}`);
+        options?.logger?.debug(`Reading files from ${target}`);
         const response = await this.reader.readTree(target, {
-          etag: options == null ? void 0 : options.etag
+          etag: options?.etag
         });
         const preparedDir = await response.dir();
-        (_b = options == null ? void 0 : options.logger) == null ? void 0 : _b.debug(`Tree downloaded and stored at ${preparedDir}`);
+        options?.logger?.debug(`Tree downloaded and stored at ${preparedDir}`);
         return {
           preparedDir,
           etag: response.etag
@@ -783,19 +748,9 @@ class DirectoryPreparer {
   }
 }
 
-var __defProp$7 = Object.defineProperty;
-var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$7 = (obj, key, value) => {
-  __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class UrlPreparer {
-  constructor(reader, logger) {
-    __publicField$7(this, "logger");
-    __publicField$7(this, "reader");
-    this.logger = logger;
-    this.reader = reader;
-  }
+  logger;
+  reader;
   /**
    * Returns a directory preparer instance
    * @param config - A URL preparer config containing the a logger and reader
@@ -803,6 +758,10 @@ class UrlPreparer {
   static fromConfig(options) {
     return new UrlPreparer(options.reader, options.logger);
   }
+  constructor(reader, logger) {
+    this.logger = logger;
+    this.reader = reader;
+  }
   /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
   shouldCleanPreparedDirectory() {
     return true;
@@ -811,13 +770,13 @@ class UrlPreparer {
   async prepare(entity, options) {
     try {
       return await getDocFilesFromRepository(this.reader, entity, {
-        etag: options == null ? void 0 : options.etag,
+        etag: options?.etag,
         logger: this.logger
       });
     } catch (error) {
       errors.assertError(error);
       if (error.name === "NotModifiedError") {
-        this.logger.debug(`Cache is valid for etag ${options == null ? void 0 : options.etag}`);
+        this.logger.debug(`Cache is valid for etag ${options?.etag}`);
       } else {
         this.logger.debug(
           `Unable to fetch files for building docs ${error.message}`
@@ -828,16 +787,8 @@ class UrlPreparer {
   }
 }
 
-var __defProp$6 = Object.defineProperty;
-var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$6 = (obj, key, value) => {
-  __defNormalProp$6(obj, key + "" , value);
-  return value;
-};
 class Preparers {
-  constructor() {
-    __publicField$6(this, "preparerMap", /* @__PURE__ */ new Map());
-  }
+  preparerMap = /* @__PURE__ */ new Map();
   /**
    * Returns a generators instance containing a generator for TechDocs
    * @public
@@ -884,12 +835,6 @@ class Preparers {
   }
 }
 
-var __defProp$5 = Object.defineProperty;
-var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$5 = (obj, key, value) => {
-  __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 const streamToBuffer$1 = (stream) => {
   return new Promise((resolve, reject) => {
     try {
@@ -906,13 +851,13 @@ const streamToBuffer$1 = (stream) => {
   });
 };
 class AwsS3Publish {
+  storageClient;
+  bucketName;
+  legacyPathCasing;
+  logger;
+  bucketRootPath;
+  sse;
   constructor(options) {
-    __publicField$5(this, "storageClient");
-    __publicField$5(this, "bucketName");
-    __publicField$5(this, "legacyPathCasing");
-    __publicField$5(this, "logger");
-    __publicField$5(this, "bucketRootPath");
-    __publicField$5(this, "sse");
     this.storageClient = options.storageClient;
     this.bucketName = options.bucketName;
     this.legacyPathCasing = options.legacyPathCasing;
@@ -1283,19 +1228,13 @@ class AwsS3Publish {
   }
 }
 
-var __defProp$4 = Object.defineProperty;
-var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$4 = (obj, key, value) => {
-  __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 const BATCH_CONCURRENCY = 3;
 class AzureBlobStoragePublish {
+  storageClient;
+  containerName;
+  legacyPathCasing;
+  logger;
   constructor(options) {
-    __publicField$4(this, "storageClient");
-    __publicField$4(this, "containerName");
-    __publicField$4(this, "legacyPathCasing");
-    __publicField$4(this, "logger");
     this.storageClient = options.storageClient;
     this.containerName = options.containerName;
     this.legacyPathCasing = options.legacyPathCasing;
@@ -1594,13 +1533,12 @@ class AzureBlobStoragePublish {
     prefix,
     maxPageSize
   }) {
-    var _a, _b;
     const blobs = [];
     const container = this.storageClient.getContainerClient(this.containerName);
     let iterator = container.listBlobsFlat({ prefix }).byPage({ maxPageSize });
     let response = (await iterator.next()).value;
     do {
-      for (const blob of (_b = (_a = response == null ? void 0 : response.segment) == null ? void 0 : _a.blobItems) != null ? _b : []) {
+      for (const blob of response?.segment?.blobItems ?? []) {
         blobs.push(blob.name);
       }
       iterator = container.listBlobsFlat({ prefix }).byPage({ continuationToken: response.continuationToken, maxPageSize });
@@ -1610,19 +1548,13 @@ class AzureBlobStoragePublish {
   }
 }
 
-var __defProp$3 = Object.defineProperty;
-var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$3 = (obj, key, value) => {
-  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class MigrateWriteStream extends stream.Writable {
+  logger;
+  removeOriginal;
+  maxConcurrency;
+  inFlight = 0;
   constructor(logger, removeOriginal, concurrency) {
     super({ objectMode: true });
-    __publicField$3(this, "logger");
-    __publicField$3(this, "removeOriginal");
-    __publicField$3(this, "maxConcurrency");
-    __publicField$3(this, "inFlight", 0);
     this.logger = logger;
     this.removeOriginal = removeOriginal;
     this.maxConcurrency = concurrency;
@@ -1660,19 +1592,13 @@ class MigrateWriteStream extends stream.Writable {
   }
 }
 
-var __defProp$2 = Object.defineProperty;
-var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$2 = (obj, key, value) => {
-  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class GoogleGCSPublish {
+  storageClient;
+  bucketName;
+  legacyPathCasing;
+  logger;
+  bucketRootPath;
   constructor(options) {
-    __publicField$2(this, "storageClient");
-    __publicField$2(this, "bucketName");
-    __publicField$2(this, "legacyPathCasing");
-    __publicField$2(this, "logger");
-    __publicField$2(this, "bucketRootPath");
     this.storageClient = options.storageClient;
     this.bucketName = options.bucketName;
     this.legacyPathCasing = options.legacyPathCasing;
@@ -1919,18 +1845,12 @@ class GoogleGCSPublish {
   }
 }
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class LocalPublish {
+  legacyPathCasing;
+  logger;
+  discovery;
+  staticDocsDir;
   constructor(options) {
-    __publicField$1(this, "legacyPathCasing");
-    __publicField$1(this, "logger");
-    __publicField$1(this, "discovery");
-    __publicField$1(this, "staticDocsDir");
     this.logger = options.logger;
     this.discovery = options.discovery;
     this.legacyPathCasing = options.legacyPathCasing;
@@ -1969,8 +1889,7 @@ class LocalPublish {
     entity,
     directory
   }) {
-    var _a;
-    const entityNamespace = (_a = entity.metadata.namespace) != null ? _a : "default";
+    const entityNamespace = entity.metadata.namespace ?? "default";
     let publishDir;
     try {
       publishDir = this.staticEntityPathJoin(
@@ -2075,8 +1994,7 @@ class LocalPublish {
     return router;
   }
   async hasDocsBeenGenerated(entity) {
-    var _a;
-    const namespace = (_a = entity.metadata.namespace) != null ? _a : "default";
+    const namespace = entity.metadata.namespace ?? "default";
     try {
       const indexHtmlPath = this.staticEntityPathJoin(
         namespace,
@@ -2153,12 +2071,6 @@ class LocalPublish {
   }
 }
 
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 const streamToBuffer = (stream) => {
   return new Promise((resolve, reject) => {
     try {
@@ -2178,10 +2090,10 @@ const bufferToStream = (buffer) => {
   return stream$1;
 };
 class OpenStackSwiftPublish {
+  storageClient;
+  containerName;
+  logger;
   constructor(options) {
-    __publicField(this, "storageClient");
-    __publicField(this, "containerName");
-    __publicField(this, "logger");
     this.storageClient = options.storageClient;
     this.containerName = options.containerName;
     this.logger = options.logger;
@@ -2431,11 +2343,10 @@ class Publisher {
    * @param options - Options for configuring the publisher factory
    */
   static async fromConfig(config, options) {
-    var _a;
     const { logger, discovery } = options;
-    const publisherType = (_a = config.getOptionalString(
+    const publisherType = config.getOptionalString(
       "techdocs.publisher.type"
-    )) != null ? _a : "local";
+    ) ?? "local";
     switch (publisherType) {
       case "googleGcs":
         logger.info("Creating Google Storage Bucket publisher for TechDocs");