@backstage/plugin-techdocs-backend 1.10.14-next.2 → 1.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,39 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
+ ## 1.11.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-plugin-api@1.0.1
9
+ - @backstage/plugin-catalog-node@1.13.1
10
+ - @backstage/plugin-search-backend-module-techdocs@0.3.1
11
+ - @backstage/plugin-techdocs-node@1.12.12
12
+
13
+ ## 1.11.0
14
+
15
+ ### Minor Changes
16
+
17
+ - 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
18
+
19
+ ### Patch Changes
20
+
21
+ - 094eaa3: Remove references to in-repo backend-common
22
+ - fbdc631: Allow to pass StorageOptions to GCS Publisher
23
+ - Updated dependencies
24
+ - @backstage/plugin-search-backend-module-techdocs@0.3.0
25
+ - @backstage/plugin-catalog-node@1.13.1
26
+ - @backstage/plugin-techdocs-node@1.12.12
27
+ - @backstage/integration@1.15.1
28
+ - @backstage/catalog-client@1.7.1
29
+ - @backstage/backend-plugin-api@1.0.1
30
+ - @backstage/catalog-model@1.7.0
31
+ - @backstage/config@1.2.0
32
+ - @backstage/errors@1.2.4
33
+ - @backstage/plugin-catalog-common@1.1.0
34
+ - @backstage/plugin-permission-common@0.8.1
35
+ - @backstage/plugin-techdocs-common@0.1.0
36
+
3
37
  ## 1.10.14-next.2
4
38
 
5
39
  ### Patch Changes
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend__alpha",
3
- "version": "1.10.14-next.2",
3
+ "version": "1.11.1",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var plugin = require('./plugin.cjs.js');
6
6
 
7
+ const _feature = plugin.techdocsPlugin;
7
8
 
8
-
9
- exports.default = plugin.techdocsPlugin;
9
+ exports.default = _feature;
10
10
  //# sourceMappingURL=alpha.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}
1
+ {"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { techdocsPlugin } from './plugin';\n\n/** @alpha */\nconst _feature = techdocsPlugin;\nexport default _feature;\n"],"names":["techdocsPlugin"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}
package/dist/alpha.d.ts CHANGED
@@ -1,9 +1,6 @@
1
1
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
2
2
 
3
- /**
4
- * The TechDocs plugin is responsible for serving and building documentation for any entity.
5
- * @alpha
6
- */
7
- declare const techdocsPlugin: _backstage_backend_plugin_api.BackendFeature;
3
+ /** @alpha */
4
+ declare const _feature: _backstage_backend_plugin_api.BackendFeature;
8
5
 
9
- export { techdocsPlugin as default };
6
+ export { _feature as default };
package/dist/index.cjs.js CHANGED
@@ -1,5 +1,8 @@
1
1
  'use strict';
2
2
 
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var plugin = require('./plugin.cjs.js');
3
6
  var router = require('./service/router.cjs.js');
4
7
  var index = require('./search/index.cjs.js');
5
8
  var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
@@ -7,6 +10,7 @@ var DefaultTechDocsCollator = require('./search/DefaultTechDocsCollator.cjs.js')
7
10
 
8
11
 
9
12
 
13
+ exports.default = plugin.techdocsPlugin;
10
14
  exports.createRouter = router.createRouter;
11
15
  exports.DefaultTechDocsCollatorFactory = index.DefaultTechDocsCollatorFactory;
12
16
  exports.DefaultTechDocsCollator = DefaultTechDocsCollator.DefaultTechDocsCollator;
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  import { Entity } from '@backstage/catalog-model';
2
2
  import { PreparerBuilder, GeneratorBuilder, PublisherBase, DocsBuildStrategy as DocsBuildStrategy$1, TechDocsDocument as TechDocsDocument$1 } from '@backstage/plugin-techdocs-node';
3
3
  export * from '@backstage/plugin-techdocs-node';
4
+ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
5
+ import { DiscoveryService, HttpAuthService, AuthService } from '@backstage/backend-plugin-api';
4
6
  import { PluginCacheManager, TokenManager } from '@backstage/backend-common';
5
7
  import { CatalogApi } from '@backstage/catalog-client';
6
8
  import { Config } from '@backstage/config';
@@ -8,10 +10,15 @@ import express from 'express';
8
10
  import { Knex } from 'knex';
9
11
  import * as winston from 'winston';
10
12
  import { Logger } from 'winston';
11
- import { DiscoveryService, HttpAuthService, AuthService } from '@backstage/backend-plugin-api';
12
13
  import { TechDocsCollatorFactoryOptions as TechDocsCollatorFactoryOptions$1, DefaultTechDocsCollatorFactory as DefaultTechDocsCollatorFactory$1 } from '@backstage/plugin-search-backend-module-techdocs';
13
14
  import { Permission } from '@backstage/plugin-permission-common';
14
15
 
16
+ /**
17
+ * The TechDocs plugin is responsible for serving and building documentation for any entity.
18
+ * @public
19
+ */
20
+ declare const techdocsPlugin: _backstage_backend_plugin_api.BackendFeature;
21
+
15
22
  /**
16
23
  * Required dependencies for running TechDocs in the "out-of-the-box"
17
24
  * deployment configuration (prepare/generate/publish all in the Backend).
@@ -141,4 +148,4 @@ type ShouldBuildParameters = {
141
148
  */
142
149
  type TechDocsDocument = TechDocsDocument$1;
143
150
 
144
- export { DefaultTechDocsCollator, DefaultTechDocsCollatorFactory, type DocsBuildStrategy, type OutOfTheBoxDeploymentOptions, type RecommendedDeploymentOptions, type RouterOptions, type ShouldBuildParameters, type TechDocsCollatorFactoryOptions, type TechDocsCollatorOptions, type TechDocsDocument, createRouter };
151
+ export { DefaultTechDocsCollator, DefaultTechDocsCollatorFactory, type DocsBuildStrategy, type OutOfTheBoxDeploymentOptions, type RecommendedDeploymentOptions, type RouterOptions, type ShouldBuildParameters, type TechDocsCollatorFactoryOptions, type TechDocsCollatorOptions, type TechDocsDocument, createRouter, techdocsPlugin as default };
@@ -3,7 +3,7 @@
3
3
  var backendCommon = require('@backstage/backend-common');
4
4
  var backendPluginApi = require('@backstage/backend-plugin-api');
5
5
  var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
6
- var pluginTechdocsBackend = require('@backstage/plugin-techdocs-backend');
6
+ var router = require('./service/router.cjs.js');
7
7
  var alpha = require('@backstage/plugin-catalog-node/alpha');
8
8
 
9
9
  const techdocsPlugin = backendPluginApi.createBackendPlugin({
@@ -102,7 +102,7 @@ const techdocsPlugin = backendPluginApi.createBackendPlugin({
102
102
  await publisher.getReadiness();
103
103
  const cacheManager = backendCommon.cacheToPluginCacheManager(cache);
104
104
  http.use(
105
- await pluginTechdocsBackend.createRouter({
105
+ await router.createRouter({
106
106
  logger: winstonLogger,
107
107
  cache: cacheManager,
108
108
  docsBuildStrategy,
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n cacheToPluginCacheManager,\n loggerToWinstonLogger,\n} from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport {\n DocsBuildStrategy,\n Generators,\n PreparerBase,\n Preparers,\n Publisher,\n PublisherBase,\n PublisherSettings,\n PublisherType,\n RemoteProtocol,\n techdocsBuildsExtensionPoint,\n TechdocsGenerator,\n techdocsGeneratorExtensionPoint,\n techdocsPreparerExtensionPoint,\n techdocsPublisherExtensionPoint,\n} from '@backstage/plugin-techdocs-node';\nimport { createRouter } from '@backstage/plugin-techdocs-backend';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport * as winston from 'winston';\n\n/**\n * The TechDocs plugin is responsible for serving and building documentation for any entity.\n * @alpha\n */\nexport const techdocsPlugin = createBackendPlugin({\n pluginId: 'techdocs',\n register(env) {\n let docsBuildStrategy: DocsBuildStrategy | undefined;\n let buildLogTransport: winston.transport | undefined;\n env.registerExtensionPoint(techdocsBuildsExtensionPoint, {\n setBuildStrategy(buildStrategy: DocsBuildStrategy) {\n if (docsBuildStrategy) {\n throw new Error('DocsBuildStrategy may only be set once');\n }\n docsBuildStrategy = buildStrategy;\n },\n setBuildLogTransport(transport: winston.transport) {\n if (buildLogTransport) {\n throw new Error('BuildLogTransport may only be set once');\n }\n buildLogTransport = transport;\n },\n });\n\n let customTechdocsGenerator: TechdocsGenerator | undefined;\n env.registerExtensionPoint(techdocsGeneratorExtensionPoint, {\n setTechdocsGenerator(generator: TechdocsGenerator) {\n if (customTechdocsGenerator) {\n throw new Error('TechdocsGenerator may only be set once');\n }\n\n customTechdocsGenerator = generator;\n },\n });\n\n const customPreparers = new Map<RemoteProtocol, PreparerBase>();\n env.registerExtensionPoint(techdocsPreparerExtensionPoint, {\n registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase) {\n if (customPreparers.has(protocol)) {\n throw new Error(\n `Preparer for protocol ${protocol} is already registered`,\n );\n }\n customPreparers.set(protocol, preparer);\n },\n });\n\n let customTechdocsPublisher: PublisherBase | undefined;\n const publisherSettings: PublisherSettings = {};\n env.registerExtensionPoint(techdocsPublisherExtensionPoint, {\n registerPublisher(type: PublisherType, publisher: PublisherBase) {\n if (customTechdocsPublisher) {\n throw new Error(`Publisher for type ${type} is already registered`);\n }\n customTechdocsPublisher = publisher;\n },\n registerPublisherSettings<T extends keyof PublisherSettings>(\n publisher: T,\n settings: PublisherSettings[T],\n ) {\n publisherSettings[publisher] = settings;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n urlReader: coreServices.urlReader,\n http: coreServices.httpRouter,\n discovery: coreServices.discovery,\n cache: coreServices.cache,\n httpAuth: coreServices.httpAuth,\n auth: coreServices.auth,\n catalog: catalogServiceRef,\n },\n async init({\n config,\n logger,\n urlReader,\n http,\n discovery,\n cache,\n httpAuth,\n auth,\n catalog,\n }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n // Preparers are responsible for fetching source files for documentation.\n const preparers = await Preparers.fromConfig(config, {\n reader: urlReader,\n logger: winstonLogger,\n });\n for (const [protocol, preparer] of customPreparers.entries()) {\n preparers.register(protocol, preparer);\n }\n\n // Generators are used for generating documentation sites.\n const generators = await Generators.fromConfig(config, {\n logger: winstonLogger,\n customGenerator: customTechdocsGenerator,\n });\n\n // Publisher is used for\n // 1. Publishing generated files to storage\n // 2. Fetching files from storage and passing them to TechDocs frontend.\n const publisher = await Publisher.fromConfig(config, {\n logger: winstonLogger,\n discovery: discovery,\n customPublisher: customTechdocsPublisher,\n publisherSettings,\n });\n\n // checks if the publisher is working and logs the result\n await publisher.getReadiness();\n\n const cacheManager = cacheToPluginCacheManager(cache);\n http.use(\n await createRouter({\n logger: winstonLogger,\n cache: cacheManager,\n docsBuildStrategy,\n buildLogTransport,\n preparers,\n generators,\n publisher,\n config,\n discovery,\n httpAuth,\n auth,\n catalogClient: catalog,\n }),\n );\n\n http.addAuthPolicy({\n path: '/static',\n allow: 'user-cookie',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","techdocsBuildsExtensionPoint","techdocsGeneratorExtensionPoint","techdocsPreparerExtensionPoint","techdocsPublisherExtensionPoint","coreServices","catalogServiceRef","loggerToWinstonLogger","Preparers","Generators","Publisher","cacheToPluginCacheManager","createRouter"],"mappings":";;;;;;;;AAgDO,MAAM,iBAAiBA,oCAAoB,CAAA;AAAA,EAChD,QAAU,EAAA,UAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,+CAA8B,EAAA;AAAA,MACvD,iBAAiB,aAAkC,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,aAAA,CAAA;AAAA,OACtB;AAAA,MACA,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,SAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,uBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,kDAAiC,EAAA;AAAA,MAC1D,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AAEA,QAA0B,uBAAA,GAAA,SAAA,CAAA;AAAA,OAC5B;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,eAAA,uBAAsB,GAAkC,EAAA,CAAA;AAC9D,IAAA,GAAA,CAAI,uBAAuBC,iDAAgC,EAAA;AAAA,MACzD,gBAAA,CAAiB,UAA0B,QAAwB,EAAA;AACjE,QAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,QAAQ,CAAG,EAAA;AACjC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,yBAAyB,QAAQ,CAAA,sBAAA,CAAA;AAAA,WACnC,CAAA;AAAA,SACF;AACA,QAAgB,eAAA,CAAA,GAAA,CAAI,UAAU,QAAQ,CAAA,CAAA;AAAA,OACxC;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,uBAAA,CAAA;AACJ,IAAA,MAAM,oBAAuC,EAAC,CAAA;AAC9C,IAAA,GAAA,CAAI,uBAAuBC,kDAAiC,EAAA;AAAA,MAC1D,iBAAA,CAAkB,MAAqB,SAA0B,EAAA;AAC/D,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAA,MAAM,IAAI,KAAA,CAAM,CAAsB,mBAAA,EAAA,IAAI,CAAwB,sBAAA,CAAA,CAAA,CAAA;AAAA,SACpE;AACA,QAA0B,uBAAA,GAAA,SAAA,CAAA;AAAA,OAC5B;AAAA,MACA,yBAAA,CACE,WACA,QACA,EAAA;AACA,QAAA,iBAAA,CAAkB,SAAS,CAAI,GAAA,QAAA,CAAA;AAAA,OACjC;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,UAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAOA,6BAAa,CAAA,KAAA;AAAA,QACpB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,OAAS,EAAAC,uBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,SAAA;AAAA,UACR,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,KAAA,MAAW,CAAC,QAAU,EAAA,QAAQ,CAAK,IAAA,eAAA,CAAgB,SAAW,EAAA;AAC5D,UAAU,SAAA,CAAA,QAAA,CAAS,UAAU,QAAQ,CAAA,CAAA;AAAA,SACvC;AAGA,QAAA,MAAM,UAAa,GAAA,MAAMC,6BAAW,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACrD,MAAQ,EAAA,aAAA;AAAA,UACR,eAAiB,EAAA,uBAAA;AAAA,SAClB,CAAA,CAAA;AAKD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,UACA,eAAiB,EAAA,uBAAA;AAAA,UACjB,iBAAA;AAAA,SACD,CAAA,CAAA;AAGD,QAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AAE7B,QAAM,MAAA,YAAA,GAAeC,wCAA0B,KAAK,CAAA,CAAA;AACpD,QAAK,IAAA,CAAA,GAAA;AAAA,UACH,MAAMC,kCAAa,CAAA;AAAA,YACjB,MAAQ,EAAA,aAAA;AAAA,YACR,KAAO,EAAA,YAAA;AAAA,YACP,iBAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,UAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACH,CAAA;AAEA,QAAA,IAAA,CAAK,aAAc,CAAA;AAAA,UACjB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA,aAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
1
+ {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n cacheToPluginCacheManager,\n loggerToWinstonLogger,\n} from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport {\n DocsBuildStrategy,\n Generators,\n PreparerBase,\n Preparers,\n Publisher,\n PublisherBase,\n PublisherSettings,\n PublisherType,\n RemoteProtocol,\n techdocsBuildsExtensionPoint,\n TechdocsGenerator,\n techdocsGeneratorExtensionPoint,\n techdocsPreparerExtensionPoint,\n techdocsPublisherExtensionPoint,\n} from '@backstage/plugin-techdocs-node';\nimport { createRouter } from './service';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport * as winston from 'winston';\n\n/**\n * The TechDocs plugin is responsible for serving and building documentation for any entity.\n * @public\n */\nexport const techdocsPlugin = createBackendPlugin({\n pluginId: 'techdocs',\n register(env) {\n let docsBuildStrategy: DocsBuildStrategy | undefined;\n let buildLogTransport: winston.transport | undefined;\n env.registerExtensionPoint(techdocsBuildsExtensionPoint, {\n setBuildStrategy(buildStrategy: DocsBuildStrategy) {\n if (docsBuildStrategy) {\n throw new Error('DocsBuildStrategy may only be set once');\n }\n docsBuildStrategy = buildStrategy;\n },\n setBuildLogTransport(transport: winston.transport) {\n if (buildLogTransport) {\n throw new Error('BuildLogTransport may only be set once');\n }\n buildLogTransport = transport;\n },\n });\n\n let customTechdocsGenerator: TechdocsGenerator | undefined;\n env.registerExtensionPoint(techdocsGeneratorExtensionPoint, {\n setTechdocsGenerator(generator: TechdocsGenerator) {\n if (customTechdocsGenerator) {\n throw new Error('TechdocsGenerator may only be set once');\n }\n\n customTechdocsGenerator = generator;\n },\n });\n\n const customPreparers = new Map<RemoteProtocol, PreparerBase>();\n env.registerExtensionPoint(techdocsPreparerExtensionPoint, {\n registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase) {\n if (customPreparers.has(protocol)) {\n throw new Error(\n `Preparer for protocol ${protocol} is already registered`,\n );\n }\n customPreparers.set(protocol, preparer);\n },\n });\n\n let customTechdocsPublisher: PublisherBase | undefined;\n const publisherSettings: PublisherSettings = {};\n env.registerExtensionPoint(techdocsPublisherExtensionPoint, {\n registerPublisher(type: PublisherType, publisher: PublisherBase) {\n if (customTechdocsPublisher) {\n throw new Error(`Publisher for type ${type} is already registered`);\n }\n customTechdocsPublisher = publisher;\n },\n registerPublisherSettings<T extends keyof PublisherSettings>(\n publisher: T,\n settings: PublisherSettings[T],\n ) {\n publisherSettings[publisher] = settings;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n urlReader: coreServices.urlReader,\n http: coreServices.httpRouter,\n discovery: coreServices.discovery,\n cache: coreServices.cache,\n httpAuth: coreServices.httpAuth,\n auth: coreServices.auth,\n catalog: catalogServiceRef,\n },\n async init({\n config,\n logger,\n urlReader,\n http,\n discovery,\n cache,\n httpAuth,\n auth,\n catalog,\n }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n // Preparers are responsible for fetching source files for documentation.\n const preparers = await Preparers.fromConfig(config, {\n reader: urlReader,\n logger: winstonLogger,\n });\n for (const [protocol, preparer] of customPreparers.entries()) {\n preparers.register(protocol, preparer);\n }\n\n // Generators are used for generating documentation sites.\n const generators = await Generators.fromConfig(config, {\n logger: winstonLogger,\n customGenerator: customTechdocsGenerator,\n });\n\n // Publisher is used for\n // 1. Publishing generated files to storage\n // 2. Fetching files from storage and passing them to TechDocs frontend.\n const publisher = await Publisher.fromConfig(config, {\n logger: winstonLogger,\n discovery: discovery,\n customPublisher: customTechdocsPublisher,\n publisherSettings,\n });\n\n // checks if the publisher is working and logs the result\n await publisher.getReadiness();\n\n const cacheManager = cacheToPluginCacheManager(cache);\n http.use(\n await createRouter({\n logger: winstonLogger,\n cache: cacheManager,\n docsBuildStrategy,\n buildLogTransport,\n preparers,\n generators,\n publisher,\n config,\n discovery,\n httpAuth,\n auth,\n catalogClient: catalog,\n }),\n );\n\n http.addAuthPolicy({\n path: '/static',\n allow: 'user-cookie',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","techdocsBuildsExtensionPoint","techdocsGeneratorExtensionPoint","techdocsPreparerExtensionPoint","techdocsPublisherExtensionPoint","coreServices","catalogServiceRef","loggerToWinstonLogger","Preparers","Generators","Publisher","cacheToPluginCacheManager","createRouter"],"mappings":";;;;;;;;AAgDO,MAAM,iBAAiBA,oCAAoB,CAAA;AAAA,EAChD,QAAU,EAAA,UAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,+CAA8B,EAAA;AAAA,MACvD,iBAAiB,aAAkC,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,aAAA,CAAA;AAAA,OACtB;AAAA,MACA,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,SAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,uBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,kDAAiC,EAAA;AAAA,MAC1D,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AAEA,QAA0B,uBAAA,GAAA,SAAA,CAAA;AAAA,OAC5B;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,eAAA,uBAAsB,GAAkC,EAAA,CAAA;AAC9D,IAAA,GAAA,CAAI,uBAAuBC,iDAAgC,EAAA;AAAA,MACzD,gBAAA,CAAiB,UAA0B,QAAwB,EAAA;AACjE,QAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,QAAQ,CAAG,EAAA;AACjC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,yBAAyB,QAAQ,CAAA,sBAAA,CAAA;AAAA,WACnC,CAAA;AAAA,SACF;AACA,QAAgB,eAAA,CAAA,GAAA,CAAI,UAAU,QAAQ,CAAA,CAAA;AAAA,OACxC;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,uBAAA,CAAA;AACJ,IAAA,MAAM,oBAAuC,EAAC,CAAA;AAC9C,IAAA,GAAA,CAAI,uBAAuBC,kDAAiC,EAAA;AAAA,MAC1D,iBAAA,CAAkB,MAAqB,SAA0B,EAAA;AAC/D,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAA,MAAM,IAAI,KAAA,CAAM,CAAsB,mBAAA,EAAA,IAAI,CAAwB,sBAAA,CAAA,CAAA,CAAA;AAAA,SACpE;AACA,QAA0B,uBAAA,GAAA,SAAA,CAAA;AAAA,OAC5B;AAAA,MACA,yBAAA,CACE,WACA,QACA,EAAA;AACA,QAAA,iBAAA,CAAkB,SAAS,CAAI,GAAA,QAAA,CAAA;AAAA,OACjC;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,UAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAOA,6BAAa,CAAA,KAAA;AAAA,QACpB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,OAAS,EAAAC,uBAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,QACA,OAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,SAAA;AAAA,UACR,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,KAAA,MAAW,CAAC,QAAU,EAAA,QAAQ,CAAK,IAAA,eAAA,CAAgB,SAAW,EAAA;AAC5D,UAAU,SAAA,CAAA,QAAA,CAAS,UAAU,QAAQ,CAAA,CAAA;AAAA,SACvC;AAGA,QAAA,MAAM,UAAa,GAAA,MAAMC,6BAAW,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACrD,MAAQ,EAAA,aAAA;AAAA,UACR,eAAiB,EAAA,uBAAA;AAAA,SAClB,CAAA,CAAA;AAKD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,UACA,eAAiB,EAAA,uBAAA;AAAA,UACjB,iBAAA;AAAA,SACD,CAAA,CAAA;AAGD,QAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AAE7B,QAAM,MAAA,YAAA,GAAeC,wCAA0B,KAAK,CAAA,CAAA;AACpD,QAAK,IAAA,CAAA,GAAA;AAAA,UACH,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAQ,EAAA,aAAA;AAAA,YACR,KAAO,EAAA,YAAA;AAAA,YACP,iBAAA;AAAA,YACA,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,UAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,WAChB,CAAA;AAAA,SACH,CAAA;AAEA,QAAA,IAAA,CAAK,aAAc,CAAA;AAAA,UACjB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA,aAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
- "version": "1.10.14-next.2",
3
+ "version": "1.11.1",
4
4
  "description": "The Backstage backend plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "backend-plugin",
@@ -29,6 +29,7 @@
29
29
  "license": "Apache-2.0",
30
30
  "exports": {
31
31
  ".": {
32
+ "backstage": "@backstage/BackendFeature",
32
33
  "require": "./dist/index.cjs.js",
33
34
  "types": "./dist/index.d.ts",
34
35
  "default": "./dist/index.cjs.js"
@@ -59,18 +60,18 @@
59
60
  },
60
61
  "dependencies": {
61
62
  "@backstage/backend-common": "^0.25.0",
62
- "@backstage/backend-plugin-api": "1.0.1-next.1",
63
- "@backstage/catalog-client": "1.7.1-next.0",
64
- "@backstage/catalog-model": "1.7.0",
65
- "@backstage/config": "1.2.0",
66
- "@backstage/errors": "1.2.4",
67
- "@backstage/integration": "1.15.1-next.1",
68
- "@backstage/plugin-catalog-common": "1.1.0",
69
- "@backstage/plugin-catalog-node": "1.13.1-next.1",
70
- "@backstage/plugin-permission-common": "0.8.1",
71
- "@backstage/plugin-search-backend-module-techdocs": "0.2.3-next.2",
72
- "@backstage/plugin-techdocs-common": "0.1.0",
73
- "@backstage/plugin-techdocs-node": "1.12.12-next.2",
63
+ "@backstage/backend-plugin-api": "^1.0.1",
64
+ "@backstage/catalog-client": "^1.7.1",
65
+ "@backstage/catalog-model": "^1.7.0",
66
+ "@backstage/config": "^1.2.0",
67
+ "@backstage/errors": "^1.2.4",
68
+ "@backstage/integration": "^1.15.1",
69
+ "@backstage/plugin-catalog-common": "^1.1.0",
70
+ "@backstage/plugin-catalog-node": "^1.13.1",
71
+ "@backstage/plugin-permission-common": "^0.8.1",
72
+ "@backstage/plugin-search-backend-module-techdocs": "^0.3.1",
73
+ "@backstage/plugin-techdocs-common": "^0.1.0",
74
+ "@backstage/plugin-techdocs-node": "^1.12.12",
74
75
  "@types/express": "^4.17.6",
75
76
  "express": "^4.17.1",
76
77
  "express-promise-router": "^4.1.0",
@@ -82,9 +83,9 @@
82
83
  "winston": "^3.2.1"
83
84
  },
84
85
  "devDependencies": {
85
- "@backstage/backend-defaults": "0.5.1-next.2",
86
- "@backstage/backend-test-utils": "1.0.1-next.2",
87
- "@backstage/cli": "0.28.0-next.2",
86
+ "@backstage/backend-defaults": "^0.5.2",
87
+ "@backstage/backend-test-utils": "^1.0.2",
88
+ "@backstage/cli": "^0.28.0",
88
89
  "msw": "^1.0.0",
89
90
  "supertest": "^7.0.0"
90
91
  },