@backstage/plugin-techdocs-backend 0.0.0-nightly-20220216022224 → 0.0.0-nightly-20220217022146

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 +11 -9
  2. package/package.json +22 -19
  3. package/dist/index.d.ts +0 -74
package/CHANGELOG.md CHANGED
@@ -1,22 +1,24 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
- ## 0.0.0-nightly-20220216022224
3
+ ## 0.0.0-nightly-20220217022146
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - 453145abba: Do not use cross-fetch in the backend
8
8
  - 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
9
+ - c77c5c7eb6: Added `backstage.role` to `package.json`
9
10
  - 811c710a21: Fix bug where tech docs collator stores search indices with wrong entity ref casing. Make the collator to conform legacyPathCasing configuration option.
10
11
  - 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
11
12
  - Updated dependencies
12
- - @backstage/backend-common@0.0.0-nightly-20220216022224
13
- - @backstage/catalog-client@0.0.0-nightly-20220216022224
14
- - @backstage/errors@0.0.0-nightly-20220216022224
15
- - @backstage/integration@0.0.0-nightly-20220216022224
16
- - @backstage/catalog-model@0.0.0-nightly-20220216022224
17
- - @backstage/techdocs-common@0.0.0-nightly-20220216022224
18
- - @backstage/search-common@0.0.0-nightly-20220216022224
19
- - @backstage/plugin-catalog-common@0.0.0-nightly-20220216022224
13
+ - @backstage/backend-common@0.0.0-nightly-20220217022146
14
+ - @backstage/catalog-client@0.0.0-nightly-20220217022146
15
+ - @backstage/errors@0.0.0-nightly-20220217022146
16
+ - @backstage/integration@0.0.0-nightly-20220217022146
17
+ - @backstage/catalog-model@0.0.0-nightly-20220217022146
18
+ - @backstage/config@0.0.0-nightly-20220217022146
19
+ - @backstage/search-common@0.0.0-nightly-20220217022146
20
+ - @backstage/techdocs-common@0.0.0-nightly-20220217022146
21
+ - @backstage/plugin-catalog-common@0.0.0-nightly-20220217022146
20
22
 
21
23
  ## 0.13.3
22
24
 
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.0.0-nightly-20220216022224",
4
+ "version": "0.0.0-nightly-20220217022146",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -11,6 +11,9 @@
11
11
  "main": "dist/index.cjs.js",
12
12
  "types": "dist/index.d.ts"
13
13
  },
14
+ "backstage": {
15
+ "role": "backend-plugin"
16
+ },
14
17
  "homepage": "https://backstage.io",
15
18
  "repository": {
16
19
  "type": "git",
@@ -22,24 +25,24 @@
22
25
  "techdocs"
23
26
  ],
24
27
  "scripts": {
25
- "start": "backstage-cli backend:dev",
26
- "build": "backstage-cli backend:build",
27
- "lint": "backstage-cli lint",
28
- "test": "backstage-cli test",
29
- "prepack": "backstage-cli prepack",
30
- "postpack": "backstage-cli postpack",
31
- "clean": "backstage-cli clean"
28
+ "start": "backstage-cli package start",
29
+ "build": "backstage-cli package build",
30
+ "lint": "backstage-cli package lint",
31
+ "test": "backstage-cli package test",
32
+ "prepack": "backstage-cli package prepack",
33
+ "postpack": "backstage-cli package postpack",
34
+ "clean": "backstage-cli package clean"
32
35
  },
33
36
  "dependencies": {
34
- "@backstage/backend-common": "^0.0.0-nightly-20220216022224",
35
- "@backstage/catalog-client": "^0.0.0-nightly-20220216022224",
36
- "@backstage/catalog-model": "^0.0.0-nightly-20220216022224",
37
- "@backstage/config": "^0.1.13",
38
- "@backstage/errors": "^0.0.0-nightly-20220216022224",
39
- "@backstage/integration": "^0.0.0-nightly-20220216022224",
40
- "@backstage/plugin-catalog-common": "^0.0.0-nightly-20220216022224",
41
- "@backstage/search-common": "^0.0.0-nightly-20220216022224",
42
- "@backstage/techdocs-common": "^0.0.0-nightly-20220216022224",
37
+ "@backstage/backend-common": "^0.0.0-nightly-20220217022146",
38
+ "@backstage/catalog-client": "^0.0.0-nightly-20220217022146",
39
+ "@backstage/catalog-model": "^0.0.0-nightly-20220217022146",
40
+ "@backstage/config": "^0.0.0-nightly-20220217022146",
41
+ "@backstage/errors": "^0.0.0-nightly-20220217022146",
42
+ "@backstage/integration": "^0.0.0-nightly-20220217022146",
43
+ "@backstage/plugin-catalog-common": "^0.0.0-nightly-20220217022146",
44
+ "@backstage/search-common": "^0.0.0-nightly-20220217022146",
45
+ "@backstage/techdocs-common": "^0.0.0-nightly-20220217022146",
43
46
  "@types/express": "^4.17.6",
44
47
  "dockerode": "^3.3.1",
45
48
  "express": "^4.17.1",
@@ -52,8 +55,8 @@
52
55
  "winston": "^3.2.1"
53
56
  },
54
57
  "devDependencies": {
55
- "@backstage/cli": "^0.0.0-nightly-20220216022224",
56
- "@backstage/test-utils": "^0.0.0-nightly-20220216022224",
58
+ "@backstage/cli": "^0.0.0-nightly-20220217022146",
59
+ "@backstage/test-utils": "^0.0.0-nightly-20220217022146",
57
60
  "@types/dockerode": "^3.3.0",
58
61
  "msw": "^0.35.0",
59
62
  "supertest": "^6.1.3"
package/dist/index.d.ts DELETED
@@ -1,74 +0,0 @@
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 };