@backstage/plugin-techdocs-node 1.11.5 → 1.12.0-next.2

package/dist/index.d.ts

@@ -237,6 +237,7 @@ declare class Generators implements GeneratorBuilder {
     static fromConfig(config: Config, options: {
         logger: Logger;
         containerRunner: ContainerRunner;
+        customGenerator?: TechdocsGenerator;
     }): Promise<GeneratorBuilder>;
     /**
      * Register a generator in the generators collection
@@ -537,5 +538,19 @@ interface TechdocsBuildsExtensionPoint {
  * @public
  */
 declare const techdocsBuildsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsBuildsExtensionPoint>;
+/**
+ * Extension point type for configuring a custom Techdocs generator
+ *
+ * @public
+ */
+interface TechdocsGeneratorExtensionPoint {
+    setTechdocsGenerator(generator: TechdocsGenerator): void;
+}
+/**
+ * Extension point for configuring a custom Techdocs generator
+ *
+ * @public
+ */
+declare const techdocsGeneratorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsGeneratorExtensionPoint>;
 
-export { DirectoryPreparer, DocsBuildStrategy, ETag, GeneratorBase, GeneratorBuilder, GeneratorOptions, GeneratorRunOptions, Generators, MigrateRequest, ParsedLocationAnnotation, PreparerBase, PreparerBuilder, PreparerConfig, PreparerOptions, PreparerResponse, Preparers, PublishRequest, PublishResponse, Publisher, PublisherBase, PublisherFactory, PublisherType, ReadinessResponse, RemoteProtocol, SupportedGeneratorKey, TechDocsDocument, TechDocsMetadata, TechdocsBuildsExtensionPoint, TechdocsGenerator, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, transformDirLocation };
+export { DirectoryPreparer, DocsBuildStrategy, ETag, GeneratorBase, GeneratorBuilder, GeneratorOptions, GeneratorRunOptions, Generators, MigrateRequest, ParsedLocationAnnotation, PreparerBase, PreparerBuilder, PreparerConfig, PreparerOptions, PreparerResponse, Preparers, PublishRequest, PublishResponse, Publisher, PublisherBase, PublisherFactory, PublisherType, ReadinessResponse, RemoteProtocol, SupportedGeneratorKey, TechDocsDocument, TechDocsMetadata, TechdocsBuildsExtensionPoint, TechdocsGenerator, TechdocsGeneratorExtensionPoint, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, transformDirLocation };

package/package.json

@@ -1,42 +1,42 @@
 {
   "name": "@backstage/plugin-techdocs-node",
+  "version": "1.12.0-next.2",
   "description": "Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli",
-  "version": "1.11.5",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "backstage": {
+    "role": "node-library"
+  },
   "publishConfig": {
     "access": "public",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
-  "backstage": {
-    "role": "node-library"
-  },
+  "keywords": [
+    "techdocs",
+    "backstage"
+  ],
   "homepage": "https://backstage.io",
+  "bugs": {
+    "url": "https://github.com/backstage/backstage/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
     "directory": "plugins/techdocs-node"
   },
-  "keywords": [
-    "techdocs",
-    "backstage"
-  ],
   "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
     "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
     "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
     "prepack": "backstage-cli package prepack",
     "postpack": "backstage-cli package postpack",
-    "clean": "backstage-cli package clean",
-    "start": "backstage-cli package start"
-  },
-  "bugs": {
-    "url": "https://github.com/backstage/backstage/issues"
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.350.0",
@@ -45,14 +45,14 @@
     "@aws-sdk/types": "^3.347.0",
     "@azure/identity": "^4.0.0",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/backend-common": "^0.21.3",
-    "@backstage/backend-plugin-api": "^0.6.13",
-    "@backstage/catalog-model": "^1.4.4",
-    "@backstage/config": "^1.1.1",
-    "@backstage/errors": "^1.2.3",
-    "@backstage/integration": "^1.9.0",
-    "@backstage/integration-aws-node": "^0.1.9",
-    "@backstage/plugin-search-common": "^1.2.10",
+    "@backstage/backend-common": "^0.21.4-next.2",
+    "@backstage/backend-plugin-api": "^0.6.14-next.2",
+    "@backstage/catalog-model": "^1.4.5-next.0",
+    "@backstage/config": "^1.2.0-next.1",
+    "@backstage/errors": "^1.2.4-next.0",
+    "@backstage/integration": "^1.9.1-next.2",
+    "@backstage/integration-aws-node": "^0.1.10-next.1",
+    "@backstage/plugin-search-common": "^1.2.11-next.1",
     "@google-cloud/storage": "^7.0.0",
     "@smithy/node-http-handler": "^2.1.7",
     "@trendyol-js/openstack-swift-sdk": "^0.0.7",
@@ -69,8 +69,8 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.3",
-    "@backstage/cli": "^0.25.2",
+    "@backstage/backend-test-utils": "^0.3.4-next.2",
+    "@backstage/cli": "^0.25.3-next.2",
     "@types/fs-extra": "^11.0.0",
     "@types/js-yaml": "^4.0.0",
     "@types/mime-types": "^2.1.0",