@backstage/plugin-techdocs 1.12.4-next.1 → 1.12.4

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 (4) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/dist/alpha.d.ts +96 -95
  3. package/dist/index.d.ts +7 -8
  4. package/package.json +25 -25
package/CHANGELOG.md CHANGED
@@ -1,5 +1,56 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 1.12.4
4
+
5
+ ### Patch Changes
6
+
7
+ - fffe3c0: Fixed double scrollbar issue that would appear on the Entity TechDocs view page that would stop the page from full scrolling to the top when navigating to a new page
8
+ - 065e6b9: Excludes SVG styling from sanitization
9
+ - b5a8208: Added `TechDocsAddonsBlueprint` extension to allow adding of techdocs addons.
10
+ - ed1cb3e: Adds the page name of techdocs to the document's title.
11
+ - fe4abb8: Updates logic to check for SVG sources when inlining them.
12
+ - Updated dependencies
13
+ - @backstage/core-components@0.17.0
14
+ - @backstage/core-plugin-api@1.10.5
15
+ - @backstage/integration@1.16.2
16
+ - @backstage/plugin-search-react@1.8.7
17
+ - @backstage/frontend-plugin-api@0.10.0
18
+ - @backstage/plugin-catalog-react@1.16.0
19
+ - @backstage/core-compat-api@0.4.0
20
+ - @backstage/plugin-techdocs-react@1.2.15
21
+ - @backstage/integration-react@1.2.5
22
+ - @backstage/plugin-auth-react@0.1.13
23
+ - @backstage/catalog-client@1.9.1
24
+ - @backstage/catalog-model@1.7.3
25
+ - @backstage/config@1.3.2
26
+ - @backstage/errors@1.2.7
27
+ - @backstage/theme@0.6.4
28
+ - @backstage/plugin-search-common@1.2.17
29
+ - @backstage/plugin-techdocs-common@0.1.0
30
+
31
+ ## 1.12.4-next.2
32
+
33
+ ### Patch Changes
34
+
35
+ - Updated dependencies
36
+ - @backstage/frontend-plugin-api@0.10.0-next.2
37
+ - @backstage/plugin-catalog-react@1.16.0-next.2
38
+ - @backstage/core-compat-api@0.4.0-next.2
39
+ - @backstage/core-components@0.16.5-next.1
40
+ - @backstage/integration@1.16.2-next.0
41
+ - @backstage/plugin-search-react@1.8.7-next.2
42
+ - @backstage/plugin-techdocs-react@1.2.15-next.2
43
+ - @backstage/catalog-client@1.9.1
44
+ - @backstage/catalog-model@1.7.3
45
+ - @backstage/config@1.3.2
46
+ - @backstage/core-plugin-api@1.10.4
47
+ - @backstage/errors@1.2.7
48
+ - @backstage/integration-react@1.2.5-next.0
49
+ - @backstage/theme@0.6.4
50
+ - @backstage/plugin-auth-react@0.1.13-next.1
51
+ - @backstage/plugin-search-common@1.2.17
52
+ - @backstage/plugin-techdocs-common@0.1.0
53
+
3
54
  ## 1.12.4-next.1
4
55
 
5
56
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- import * as _backstage_catalog_model from '@backstage/catalog-model';
2
- import * as _backstage_plugin_techdocs_react from '@backstage/plugin-techdocs-react';
3
1
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
2
+ import * as _backstage_plugin_techdocs_react from '@backstage/plugin-techdocs-react';
3
+ import * as _backstage_catalog_model from '@backstage/catalog-model';
4
+ import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
4
5
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
5
6
  import * as _backstage_plugin_search_react_alpha from '@backstage/plugin-search-react/alpha';
6
7
  import React__default from 'react';
@@ -24,7 +25,7 @@ declare const techDocsSearchResultListItemExtension: _backstage_frontend_plugin_
24
25
  noTrack?: boolean | undefined;
25
26
  };
26
27
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
27
- predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
28
+ predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate;
28
29
  component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
29
30
  }, "search.search-result-list-item.item", {}>;
30
31
  inputs: {
@@ -47,23 +48,6 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
47
48
  }>;
48
49
  entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
49
50
  }, {}, {
50
- "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
51
- kind: "nav-item";
52
- name: undefined;
53
- config: {};
54
- configInput: {};
55
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
56
- title: string;
57
- icon: _backstage_core_plugin_api.IconComponent;
58
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
59
- }, "core.nav-item.target", {}>;
60
- inputs: {};
61
- params: {
62
- title: string;
63
- icon: _backstage_core_plugin_api.IconComponent;
64
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
65
- };
66
- }>;
67
51
  "api:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
68
52
  kind: "api";
69
53
  name: undefined;
@@ -86,89 +70,31 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
86
70
  factory: _backstage_frontend_plugin_api.AnyApiFactory;
87
71
  };
88
72
  }>;
89
- "page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
90
- kind: "page";
91
- name: undefined;
92
- config: {
93
- path: string | undefined;
94
- };
95
- configInput: {
96
- path?: string | undefined;
97
- };
98
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
73
+ "empty-state:techdocs/entity-content": _backstage_frontend_plugin_api.ExtensionDefinition<{
74
+ config: {};
75
+ configInput: {};
76
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {
99
77
  optional: true;
100
78
  }>;
101
- inputs: {};
102
- params: {
103
- defaultPath: string;
104
- loader: () => Promise<JSX.Element>;
105
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
106
- };
107
- }>;
108
- "search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
109
- config: {
110
- title: string | undefined;
111
- lineClamp: number;
112
- asLink: boolean;
113
- asListItem: boolean;
114
- } & {
115
- noTrack: boolean;
116
- };
117
- configInput: {
118
- title?: string | undefined;
119
- lineClamp?: number | undefined;
120
- asListItem?: boolean | undefined;
121
- asLink?: boolean | undefined;
122
- } & {
123
- noTrack?: boolean | undefined;
124
- };
125
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
126
- predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
127
- component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
128
- }, "search.search-result-list-item.item", {}>;
129
79
  inputs: {
130
80
  [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
131
81
  optional: boolean;
132
82
  singleton: boolean;
133
83
  }>;
134
84
  };
135
- kind: "search-result-list-item";
136
- name: undefined;
137
- params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
138
- }>;
139
- "page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
140
- config: {
141
- path: string | undefined;
142
- };
143
- configInput: {
144
- path?: string | undefined;
145
- };
146
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
147
- optional: true;
148
- }>;
149
- inputs: {
150
- addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
151
- singleton: false;
152
- optional: false;
153
- }>;
154
- };
155
- kind: "page";
156
- name: "reader";
157
- params: {
158
- defaultPath: string;
159
- loader: () => Promise<JSX.Element>;
160
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
161
- };
85
+ params: never;
86
+ kind: "empty-state";
87
+ name: "entity-content";
162
88
  }>;
163
89
  "entity-content:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
164
90
  config: {
165
91
  path: string | undefined;
166
92
  title: string | undefined;
167
- filter: string | undefined;
93
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
168
94
  group: string | false | undefined;
169
95
  };
170
96
  configInput: {
171
- filter?: string | undefined;
97
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
172
98
  title?: string | undefined;
173
99
  path?: string | undefined;
174
100
  group?: string | false | undefined;
@@ -200,26 +126,101 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
200
126
  loader: () => Promise<JSX.Element>;
201
127
  defaultPath: string;
202
128
  defaultTitle: string;
203
- defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
204
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
205
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
129
+ defaultGroup?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
130
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
131
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
206
132
  };
207
133
  }>;
208
- "empty-state:techdocs/entity-content": _backstage_frontend_plugin_api.ExtensionDefinition<{
134
+ "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
135
+ kind: "nav-item";
136
+ name: undefined;
209
137
  config: {};
210
138
  configInput: {};
211
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {
139
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
140
+ title: string;
141
+ icon: _backstage_core_plugin_api.IconComponent;
142
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
143
+ }, "core.nav-item.target", {}>;
144
+ inputs: {};
145
+ params: {
146
+ title: string;
147
+ icon: _backstage_core_plugin_api.IconComponent;
148
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
149
+ };
150
+ }>;
151
+ "page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
152
+ kind: "page";
153
+ name: undefined;
154
+ config: {
155
+ path: string | undefined;
156
+ };
157
+ configInput: {
158
+ path?: string | undefined;
159
+ };
160
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
161
+ optional: true;
162
+ }>;
163
+ inputs: {};
164
+ params: {
165
+ defaultPath: string;
166
+ loader: () => Promise<JSX.Element>;
167
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
168
+ };
169
+ }>;
170
+ "page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
171
+ config: {
172
+ path: string | undefined;
173
+ };
174
+ configInput: {
175
+ path?: string | undefined;
176
+ };
177
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
212
178
  optional: true;
213
179
  }>;
180
+ inputs: {
181
+ addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
182
+ singleton: false;
183
+ optional: false;
184
+ }>;
185
+ };
186
+ kind: "page";
187
+ name: "reader";
188
+ params: {
189
+ defaultPath: string;
190
+ loader: () => Promise<JSX.Element>;
191
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
192
+ };
193
+ }>;
194
+ "search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
195
+ config: {
196
+ title: string | undefined;
197
+ lineClamp: number;
198
+ asLink: boolean;
199
+ asListItem: boolean;
200
+ } & {
201
+ noTrack: boolean;
202
+ };
203
+ configInput: {
204
+ title?: string | undefined;
205
+ lineClamp?: number | undefined;
206
+ asListItem?: boolean | undefined;
207
+ asLink?: boolean | undefined;
208
+ } & {
209
+ noTrack?: boolean | undefined;
210
+ };
211
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
212
+ predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate;
213
+ component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
214
+ }, "search.search-result-list-item.item", {}>;
214
215
  inputs: {
215
216
  [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
216
217
  optional: boolean;
217
218
  singleton: boolean;
218
219
  }>;
219
220
  };
220
- params: never;
221
- kind: "empty-state";
222
- name: "entity-content";
221
+ kind: "search-result-list-item";
222
+ name: undefined;
223
+ params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
223
224
  }>;
224
225
  }>;
225
226
 
package/dist/index.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import { TechDocsMetadata, TechDocsEntityMetadata, TechDocsApi as TechDocsApi$1, TechDocsStorageApi as TechDocsStorageApi$1, SyncResult as SyncResult$1 } from '@backstage/plugin-techdocs-react';
3
2
  import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
4
3
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
@@ -408,8 +407,8 @@ declare const EntityListDocsTable: {
408
407
  (props: EntityListDocsTableProps): React__default.JSX.Element;
409
408
  columns: {
410
409
  createTitleColumn(options?: {
411
- hidden?: boolean | undefined;
412
- } | undefined): TableColumn<DocsTableRow>;
410
+ hidden?: boolean;
411
+ }): TableColumn<DocsTableRow>;
413
412
  createNameColumn(): TableColumn<DocsTableRow>;
414
413
  createOwnerColumn(): TableColumn<DocsTableRow>;
415
414
  createKindColumn(): TableColumn<DocsTableRow>;
@@ -454,8 +453,8 @@ declare const DocsTable: {
454
453
  (props: DocsTableProps): React__default.JSX.Element | null;
455
454
  columns: {
456
455
  createTitleColumn(options?: {
457
- hidden?: boolean | undefined;
458
- } | undefined): TableColumn<DocsTableRow>;
456
+ hidden?: boolean;
457
+ }): TableColumn<DocsTableRow>;
459
458
  createNameColumn(): TableColumn<DocsTableRow>;
460
459
  createOwnerColumn(): TableColumn<DocsTableRow>;
461
460
  createKindColumn(): TableColumn<DocsTableRow>;
@@ -642,7 +641,7 @@ declare const TechdocsPage: () => React.JSX.Element;
642
641
  * @public
643
642
  */
644
643
  declare const EntityTechdocsContent: ({ children, withSearch, }: React.PropsWithChildren<{
645
- withSearch?: boolean | undefined;
644
+ withSearch?: boolean;
646
645
  }>) => React.JSX.Element;
647
646
  /**
648
647
  * Component which takes a custom tabs config object and renders a documentation landing page.
@@ -686,8 +685,8 @@ declare const Router: () => React__default.JSX.Element;
686
685
  *
687
686
  * @public
688
687
  */
689
- declare const LegacyEmbeddedDocsRouter: ({ children, withSearch, }: React__default.PropsWithChildren<{
690
- withSearch?: boolean | undefined;
688
+ declare const LegacyEmbeddedDocsRouter: ({ children, withSearch, }: PropsWithChildren<{
689
+ withSearch?: boolean;
691
690
  }>) => React__default.JSX.Element;
692
691
 
693
692
  /** @public */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "1.12.4-next.1",
3
+ "version": "1.12.4",
4
4
  "description": "The Backstage plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -49,7 +49,7 @@
49
49
  "types": "./dist/index.d.ts",
50
50
  "typesVersions": {
51
51
  "*": {
52
- "index": [
52
+ "*": [
53
53
  "dist/index.d.ts"
54
54
  ],
55
55
  "alpha": [
@@ -71,23 +71,23 @@
71
71
  "test": "backstage-cli package test"
72
72
  },
73
73
  "dependencies": {
74
- "@backstage/catalog-client": "1.9.1",
75
- "@backstage/catalog-model": "1.7.3",
76
- "@backstage/config": "1.3.2",
77
- "@backstage/core-compat-api": "0.3.7-next.1",
78
- "@backstage/core-components": "0.16.5-next.0",
79
- "@backstage/core-plugin-api": "1.10.4",
80
- "@backstage/errors": "1.2.7",
81
- "@backstage/frontend-plugin-api": "0.9.6-next.1",
82
- "@backstage/integration": "1.16.1",
83
- "@backstage/integration-react": "1.2.4",
84
- "@backstage/plugin-auth-react": "0.1.13-next.0",
85
- "@backstage/plugin-catalog-react": "1.16.0-next.1",
86
- "@backstage/plugin-search-common": "1.2.17",
87
- "@backstage/plugin-search-react": "1.8.7-next.1",
88
- "@backstage/plugin-techdocs-common": "0.1.0",
89
- "@backstage/plugin-techdocs-react": "1.2.15-next.1",
90
- "@backstage/theme": "0.6.4",
74
+ "@backstage/catalog-client": "^1.9.1",
75
+ "@backstage/catalog-model": "^1.7.3",
76
+ "@backstage/config": "^1.3.2",
77
+ "@backstage/core-compat-api": "^0.4.0",
78
+ "@backstage/core-components": "^0.17.0",
79
+ "@backstage/core-plugin-api": "^1.10.5",
80
+ "@backstage/errors": "^1.2.7",
81
+ "@backstage/frontend-plugin-api": "^0.10.0",
82
+ "@backstage/integration": "^1.16.2",
83
+ "@backstage/integration-react": "^1.2.5",
84
+ "@backstage/plugin-auth-react": "^0.1.13",
85
+ "@backstage/plugin-catalog-react": "^1.16.0",
86
+ "@backstage/plugin-search-common": "^1.2.17",
87
+ "@backstage/plugin-search-react": "^1.8.7",
88
+ "@backstage/plugin-techdocs-common": "^0.1.0",
89
+ "@backstage/plugin-techdocs-react": "^1.2.15",
90
+ "@backstage/theme": "^0.6.4",
91
91
  "@material-ui/core": "^4.12.2",
92
92
  "@material-ui/icons": "^4.9.1",
93
93
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -101,12 +101,12 @@
101
101
  "react-use": "^17.2.4"
102
102
  },
103
103
  "devDependencies": {
104
- "@backstage/cli": "0.30.1-next.0",
105
- "@backstage/core-app-api": "1.15.5",
106
- "@backstage/dev-utils": "1.1.8-next.1",
107
- "@backstage/plugin-catalog": "1.28.0-next.1",
108
- "@backstage/plugin-techdocs-module-addons-contrib": "1.1.22-next.1",
109
- "@backstage/test-utils": "1.7.5",
104
+ "@backstage/cli": "^0.31.0",
105
+ "@backstage/core-app-api": "^1.16.0",
106
+ "@backstage/dev-utils": "^1.1.8",
107
+ "@backstage/plugin-catalog": "^1.28.0",
108
+ "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.22",
109
+ "@backstage/test-utils": "^1.7.6",
110
110
  "@testing-library/dom": "^10.0.0",
111
111
  "@testing-library/jest-dom": "^6.0.0",
112
112
  "@testing-library/react": "^16.0.0",