@backstage/plugin-techdocs-backend 0.13.4 → 0.13.5

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/index.d.ts +74 -0
  3. package/package.json +11 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
+ ## 0.13.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Fix for the previous release with missing type declarations.
8
+ - Updated dependencies
9
+ - @backstage/backend-common@0.10.9
10
+ - @backstage/catalog-client@0.7.1
11
+ - @backstage/catalog-model@0.10.1
12
+ - @backstage/config@0.1.15
13
+ - @backstage/errors@0.2.2
14
+ - @backstage/integration@0.7.4
15
+ - @backstage/search-common@0.2.4
16
+ - @backstage/techdocs-common@0.11.9
17
+ - @backstage/plugin-catalog-common@0.1.4
18
+
3
19
  ## 0.13.4
4
20
 
5
21
  ### Patch Changes
package/dist/index.d.ts ADDED
@@ -0,0 +1,74 @@
1
+ import { PluginEndpointDiscovery, PluginCacheManager, TokenManager } from '@backstage/backend-common';
2
+ import { Config } from '@backstage/config';
3
+ import { PreparerBuilder, GeneratorBuilder, PublisherBase, TechDocsDocument } from '@backstage/techdocs-common';
4
+ export * from '@backstage/techdocs-common';
5
+ export { TechDocsDocument } from '@backstage/techdocs-common';
6
+ import express from 'express';
7
+ import { Knex } from 'knex';
8
+ import { Logger } from 'winston';
9
+ import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
10
+ import { DocumentCollator } from '@backstage/search-common';
11
+ import { CatalogApi } from '@backstage/catalog-client';
12
+
13
+ /**
14
+ * All of the required dependencies for running TechDocs in the "out-of-the-box"
15
+ * deployment configuration (prepare/generate/publish all in the Backend).
16
+ */
17
+ declare type OutOfTheBoxDeploymentOptions = {
18
+ preparers: PreparerBuilder;
19
+ generators: GeneratorBuilder;
20
+ publisher: PublisherBase;
21
+ logger: Logger;
22
+ discovery: PluginEndpointDiscovery;
23
+ database?: Knex;
24
+ config: Config;
25
+ cache: PluginCacheManager;
26
+ };
27
+ /**
28
+ * Required dependencies for running TechDocs in the "recommended" deployment
29
+ * configuration (prepare/generate handled externally in CI/CD).
30
+ */
31
+ declare type RecommendedDeploymentOptions = {
32
+ publisher: PublisherBase;
33
+ logger: Logger;
34
+ discovery: PluginEndpointDiscovery;
35
+ config: Config;
36
+ cache: PluginCacheManager;
37
+ };
38
+ /**
39
+ * One of the two deployment configurations must be provided.
40
+ */
41
+ declare type RouterOptions = RecommendedDeploymentOptions | OutOfTheBoxDeploymentOptions;
42
+ declare function createRouter(options: RouterOptions): Promise<express.Router>;
43
+
44
+ declare type TechDocsCollatorOptions = {
45
+ discovery: PluginEndpointDiscovery;
46
+ logger: Logger;
47
+ tokenManager: TokenManager;
48
+ locationTemplate?: string;
49
+ catalogClient?: CatalogApi;
50
+ parallelismLimit?: number;
51
+ legacyPathCasing?: boolean;
52
+ };
53
+ declare class DefaultTechDocsCollator implements DocumentCollator {
54
+ protected discovery: PluginEndpointDiscovery;
55
+ protected locationTemplate: string;
56
+ private readonly logger;
57
+ private readonly catalogClient;
58
+ private readonly tokenManager;
59
+ private readonly parallelismLimit;
60
+ private readonly legacyPathCasing;
61
+ readonly type: string;
62
+ readonly visibilityPermission: _backstage_plugin_permission_common.Permission;
63
+ /**
64
+ * @deprecated use static fromConfig method instead.
65
+ */
66
+ constructor(options: TechDocsCollatorOptions);
67
+ static fromConfig(config: Config, options: TechDocsCollatorOptions): DefaultTechDocsCollator;
68
+ execute(): Promise<TechDocsDocument[]>;
69
+ protected applyArgsToFormat(format: string, args: Record<string, string>): string;
70
+ private static constructDocsIndexUrl;
71
+ private static handleEntityInfoCasing;
72
+ }
73
+
74
+ export { DefaultTechDocsCollator, OutOfTheBoxDeploymentOptions, RecommendedDeploymentOptions, RouterOptions, TechDocsCollatorOptions, createRouter };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
3
  "description": "The Backstage backend plugin that renders technical documentation for your components",
4
- "version": "0.13.4",
4
+ "version": "0.13.5",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -34,15 +34,15 @@
34
34
  "clean": "backstage-cli package clean"
35
35
  },
36
36
  "dependencies": {
37
- "@backstage/backend-common": "^0.10.8",
38
- "@backstage/catalog-client": "^0.7.0",
39
- "@backstage/catalog-model": "^0.10.0",
40
- "@backstage/config": "^0.1.14",
41
- "@backstage/errors": "^0.2.1",
42
- "@backstage/integration": "^0.7.3",
43
- "@backstage/plugin-catalog-common": "^0.1.3",
44
- "@backstage/search-common": "^0.2.3",
45
- "@backstage/techdocs-common": "^0.11.8",
37
+ "@backstage/backend-common": "^0.10.9",
38
+ "@backstage/catalog-client": "^0.7.1",
39
+ "@backstage/catalog-model": "^0.10.1",
40
+ "@backstage/config": "^0.1.15",
41
+ "@backstage/errors": "^0.2.2",
42
+ "@backstage/integration": "^0.7.4",
43
+ "@backstage/plugin-catalog-common": "^0.1.4",
44
+ "@backstage/search-common": "^0.2.4",
45
+ "@backstage/techdocs-common": "^0.11.9",
46
46
  "@types/express": "^4.17.6",
47
47
  "dockerode": "^3.3.1",
48
48
  "express": "^4.17.1",
@@ -66,5 +66,5 @@
66
66
  "config.d.ts"
67
67
  ],
68
68
  "configSchema": "config.d.ts",
69
- "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc"
69
+ "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba"
70
70
  }