@backstage/plugin-techdocs-node 1.12.7 → 1.12.8

package/dist/index.d.ts

@@ -207,7 +207,7 @@ declare class TechdocsGenerator implements GeneratorBase {
      * The default docker image (and version) used to generate content. Public
      * and static so that techdocs-node consumers can use the same version.
      */
-    static readonly defaultDockerImage = "spotify/techdocs:v1.2.3";
+    static readonly defaultDockerImage = "spotify/techdocs:v1.2.4";
     private readonly logger;
     private readonly containerRunner?;
     private readonly options;
@@ -362,6 +362,7 @@ declare class Preparers implements PreparerBuilder {
 type PublisherFactory = {
     logger: Logger;
     discovery: PluginEndpointDiscovery;
+    customPublisher?: PublisherBase | undefined;
 };
 /**
  * Key for all the different types of TechDocs publishers that are supported.
@@ -473,13 +474,24 @@ interface PublisherBase {
      */
     migrateDocsCase?(migrateRequest: MigrateRequest): Promise<void>;
 }
+/**
+ * Definition for a TechDocs publisher builder
+ * @public
+ */
+type PublisherBuilder = {
+    register(type: PublisherType, publisher: PublisherBase): void;
+    get(config: Config): PublisherBase;
+};
 
 /**
  * Factory class to create a TechDocs publisher based on defined publisher type in app config.
  * Uses `techdocs.publisher.type`.
  * @public
  */
-declare class Publisher {
+declare class Publisher implements PublisherBuilder {
+    private publishers;
+    register(type: PublisherType | 'techdocs', publisher: PublisherBase): void;
+    get(config: Config): PublisherBase;
     /**
      * Returns a instance of TechDocs publisher
      * @param config - A Backstage configuration
@@ -572,5 +584,19 @@ interface TechdocsPreparerExtensionPoint {
  * @public
  */
 declare const techdocsPreparerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsPreparerExtensionPoint>;
+/**
+ * Extension point type for configuring a custom Techdocs publisher
+ *
+ * @public
+ */
+interface TechdocsPublisherExtensionPoint {
+    registerPublisher(type: PublisherType, publisher: PublisherBase): void;
+}
+/**
+ * Extension point for configuring a custom Techdocs publisher
+ *
+ * @public
+ */
+declare const techdocsPublisherExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsPublisherExtensionPoint>;
 
-export { DirectoryPreparer, type DocsBuildStrategy, type ETag, type GeneratorBase, type GeneratorBuilder, type GeneratorOptions, type GeneratorRunOptions, Generators, type MigrateRequest, type ParsedLocationAnnotation, type PreparerBase, type PreparerBuilder, type PreparerConfig, type PreparerOptions, type PreparerResponse, Preparers, type PublishRequest, type PublishResponse, Publisher, type PublisherBase, type PublisherFactory, type PublisherType, type ReadinessResponse, type RemoteProtocol, type SupportedGeneratorKey, type TechDocsDocument, type TechDocsMetadata, type TechdocsBuildsExtensionPoint, TechdocsGenerator, type TechdocsGeneratorExtensionPoint, type TechdocsPreparerExtensionPoint, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, transformDirLocation };
+export { DirectoryPreparer, type DocsBuildStrategy, type ETag, type GeneratorBase, type GeneratorBuilder, type GeneratorOptions, type GeneratorRunOptions, Generators, type MigrateRequest, type ParsedLocationAnnotation, type PreparerBase, type PreparerBuilder, type PreparerConfig, type PreparerOptions, type PreparerResponse, Preparers, type PublishRequest, type PublishResponse, Publisher, type PublisherBase, type PublisherBuilder, type PublisherFactory, type PublisherType, type ReadinessResponse, type RemoteProtocol, type SupportedGeneratorKey, type TechDocsDocument, type TechDocsMetadata, type TechdocsBuildsExtensionPoint, TechdocsGenerator, type TechdocsGeneratorExtensionPoint, type TechdocsPreparerExtensionPoint, type TechdocsPublisherExtensionPoint, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, techdocsPublisherExtensionPoint, transformDirLocation };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs-node",
-  "version": "1.12.7",
+  "version": "1.12.8",
   "description": "Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
   "backstage": {
     "role": "node-library",
@@ -52,14 +52,14 @@
     "@aws-sdk/types": "^3.347.0",
     "@azure/identity": "^4.0.0",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/backend-common": "^0.23.2",
-    "@backstage/backend-plugin-api": "^0.6.21",
+    "@backstage/backend-common": "^0.23.3",
+    "@backstage/backend-plugin-api": "^0.7.0",
     "@backstage/catalog-model": "^1.5.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/integration": "^1.12.0",
+    "@backstage/integration": "^1.13.0",
     "@backstage/integration-aws-node": "^0.1.12",
-    "@backstage/plugin-search-common": "^1.2.12",
+    "@backstage/plugin-search-common": "^1.2.13",
     "@google-cloud/storage": "^7.0.0",
     "@smithy/node-http-handler": "^2.1.7",
     "@trendyol-js/openstack-swift-sdk": "^0.0.7",
@@ -77,8 +77,8 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.4.3",
-    "@backstage/cli": "^0.26.10",
+    "@backstage/backend-test-utils": "^0.4.4",
+    "@backstage/cli": "^0.26.11",
     "@types/fs-extra": "^11.0.0",
     "@types/js-yaml": "^4.0.0",
     "@types/mime-types": "^2.1.0",