@backstage/plugin-techdocs 1.10.8 → 1.10.9-next.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.d.ts +119 -71
  4. package/package.json +12 -12
package/CHANGELOG.md CHANGED
@@ -1,5 +1,50 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 1.10.9-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/frontend-plugin-api@0.8.0-next.1
9
+ - @backstage/core-compat-api@0.3.0-next.1
10
+ - @backstage/core-components@0.14.11-next.0
11
+ - @backstage/plugin-catalog-react@1.12.4-next.1
12
+ - @backstage/catalog-model@1.6.0
13
+ - @backstage/config@1.2.0
14
+ - @backstage/core-plugin-api@1.9.3
15
+ - @backstage/errors@1.2.4
16
+ - @backstage/integration@1.14.0
17
+ - @backstage/integration-react@1.1.30
18
+ - @backstage/theme@0.5.6
19
+ - @backstage/plugin-auth-react@0.1.6-next.0
20
+ - @backstage/plugin-search-common@1.2.14
21
+ - @backstage/plugin-search-react@1.8.0-next.1
22
+ - @backstage/plugin-techdocs-common@0.1.0
23
+ - @backstage/plugin-techdocs-react@1.2.8-next.1
24
+
25
+ ## 1.10.9-next.0
26
+
27
+ ### Patch Changes
28
+
29
+ - fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.
30
+ - Updated dependencies
31
+ - @backstage/frontend-plugin-api@0.8.0-next.0
32
+ - @backstage/plugin-techdocs-react@1.2.8-next.0
33
+ - @backstage/core-compat-api@0.2.9-next.0
34
+ - @backstage/plugin-catalog-react@1.12.4-next.0
35
+ - @backstage/plugin-search-react@1.8.0-next.0
36
+ - @backstage/catalog-model@1.6.0
37
+ - @backstage/config@1.2.0
38
+ - @backstage/core-components@0.14.10
39
+ - @backstage/core-plugin-api@1.9.3
40
+ - @backstage/errors@1.2.4
41
+ - @backstage/integration@1.14.0
42
+ - @backstage/integration-react@1.1.30
43
+ - @backstage/theme@0.5.6
44
+ - @backstage/plugin-auth-react@0.1.5
45
+ - @backstage/plugin-search-common@1.2.14
46
+ - @backstage/plugin-techdocs-common@0.1.0
47
+
3
48
  ## 1.10.8
4
49
 
5
50
  ### Patch Changes
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs__alpha",
3
- "version": "1.10.8",
3
+ "version": "1.10.9-next.1",
4
4
  "main": "../dist/alpha.esm.js",
5
5
  "module": "../dist/alpha.esm.js",
6
6
  "types": "../dist/alpha.d.ts"
package/dist/alpha.d.ts CHANGED
@@ -6,34 +6,38 @@ import React__default from 'react';
6
6
 
7
7
  /** @alpha */
8
8
  declare const techDocsSearchResultListItemExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
9
- title: string | undefined;
10
- lineClamp: number;
11
- asLink: boolean;
12
- asListItem: boolean;
13
- } & {
14
- noTrack: boolean;
15
- }, {
16
- title?: string | undefined;
17
- lineClamp?: number | undefined;
18
- asListItem?: boolean | undefined;
19
- asLink?: boolean | undefined;
20
- } & {
21
- noTrack?: boolean | undefined;
22
- }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
23
- predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
24
- component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
25
- }, "search.search-result-list-item.item", {}>, {
26
- [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
27
- optional: boolean;
28
- singleton: boolean;
29
- }>;
30
- }, {
9
+ config: {
10
+ title: string | undefined;
11
+ lineClamp: number;
12
+ asLink: boolean;
13
+ asListItem: boolean;
14
+ } & {
15
+ noTrack: boolean;
16
+ };
17
+ configInput: {
18
+ title?: string | undefined;
19
+ lineClamp?: number | undefined;
20
+ asListItem?: boolean | undefined;
21
+ asLink?: boolean | undefined;
22
+ } & {
23
+ noTrack?: boolean | undefined;
24
+ };
25
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
26
+ predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
27
+ component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
28
+ }, "search.search-result-list-item.item", {}>;
29
+ inputs: {
30
+ [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
31
+ optional: boolean;
32
+ singleton: boolean;
33
+ }>;
34
+ };
31
35
  kind: "search-result-list-item";
32
36
  namespace: undefined;
33
37
  name: undefined;
34
38
  }>;
35
39
  /** @alpha */
36
- declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
40
+ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
37
41
  root: _backstage_frontend_plugin_api.RouteRef<undefined>;
38
42
  docRoot: _backstage_frontend_plugin_api.RouteRef<{
39
43
  name: string;
@@ -42,76 +46,120 @@ declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
42
46
  }>;
43
47
  entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
44
48
  }, {}, {
45
- "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
46
- title: string;
47
- icon: _backstage_core_plugin_api.IconComponent;
48
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
49
- }, "core.nav-item.target", {}>, {}, {
49
+ "api:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
50
+ kind: "api";
51
+ namespace: undefined;
52
+ name: undefined;
53
+ config: {};
54
+ configInput: {};
55
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
56
+ inputs: {};
57
+ }>;
58
+ "page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
59
+ kind: "page";
60
+ namespace: undefined;
61
+ name: undefined;
62
+ config: {
63
+ path: string | undefined;
64
+ };
65
+ configInput: {
66
+ path?: string | undefined;
67
+ };
68
+ 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", {
69
+ optional: true;
70
+ }>;
71
+ inputs: {};
72
+ }>;
73
+ "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
50
74
  kind: "nav-item";
51
75
  namespace: undefined;
52
76
  name: undefined;
77
+ config: {};
78
+ configInput: {};
79
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
80
+ title: string;
81
+ icon: _backstage_core_plugin_api.IconComponent;
82
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
83
+ }, "core.nav-item.target", {}>;
84
+ inputs: {};
53
85
  }>;
54
- "api:techdocs/storage": _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>, {}, {
86
+ "api:techdocs/storage": _backstage_frontend_plugin_api.ExtensionDefinition<{
55
87
  kind: "api";
56
88
  namespace: undefined;
57
89
  name: "storage";
90
+ config: {};
91
+ configInput: {};
92
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
93
+ inputs: {};
58
94
  }>;
59
95
  "search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
60
- title: string | undefined;
61
- lineClamp: number;
62
- asLink: boolean;
63
- asListItem: boolean;
64
- } & {
65
- noTrack: boolean;
66
- }, {
67
- title?: string | undefined;
68
- lineClamp?: number | undefined;
69
- asListItem?: boolean | undefined;
70
- asLink?: boolean | undefined;
71
- } & {
72
- noTrack?: boolean | undefined;
73
- }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
74
- predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
75
- component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
76
- }, "search.search-result-list-item.item", {}>, {
77
- [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
78
- optional: boolean;
79
- singleton: boolean;
80
- }>;
81
- }, {
96
+ config: {
97
+ title: string | undefined;
98
+ lineClamp: number;
99
+ asLink: boolean;
100
+ asListItem: boolean;
101
+ } & {
102
+ noTrack: boolean;
103
+ };
104
+ configInput: {
105
+ title?: string | undefined;
106
+ lineClamp?: number | undefined;
107
+ asListItem?: boolean | undefined;
108
+ asLink?: boolean | undefined;
109
+ } & {
110
+ noTrack?: boolean | undefined;
111
+ };
112
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
113
+ predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
114
+ component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
115
+ }, "search.search-result-list-item.item", {}>;
116
+ inputs: {
117
+ [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
118
+ optional: boolean;
119
+ singleton: boolean;
120
+ }>;
121
+ };
82
122
  kind: "search-result-list-item";
83
123
  namespace: undefined;
84
124
  name: undefined;
85
125
  }>;
86
126
  "page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
87
- path: string | undefined;
88
- }, {
89
- path?: string | undefined;
90
- }, _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", {
91
- optional: true;
92
- }>, {}, {
93
127
  kind: "page";
94
128
  namespace: undefined;
95
129
  name: "reader";
130
+ config: {
131
+ path: string | undefined;
132
+ };
133
+ configInput: {
134
+ path?: string | undefined;
135
+ };
136
+ 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", {
137
+ optional: true;
138
+ }>;
139
+ inputs: {};
96
140
  }>;
97
141
  "entity-content:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
98
- path: string | undefined;
99
- title: string | undefined;
100
- filter: string | undefined;
101
- }, {
102
- filter?: string | undefined;
103
- title?: string | undefined;
104
- path?: string | undefined;
105
- }, _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", {
106
- optional: true;
107
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
108
- optional: true;
109
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
110
- optional: true;
111
- }>, {}, {
112
142
  kind: "entity-content";
113
143
  namespace: undefined;
114
144
  name: undefined;
145
+ config: {
146
+ path: string | undefined;
147
+ title: string | undefined;
148
+ filter: string | undefined;
149
+ };
150
+ configInput: {
151
+ filter?: string | undefined;
152
+ title?: string | undefined;
153
+ path?: string | undefined;
154
+ };
155
+ 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", {
156
+ optional: true;
157
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
158
+ optional: true;
159
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
160
+ optional: true;
161
+ }>;
162
+ inputs: {};
115
163
  }>;
116
164
  }>;
117
165
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "1.10.8",
3
+ "version": "1.10.9-next.1",
4
4
  "description": "The Backstage plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -60,19 +60,19 @@
60
60
  "dependencies": {
61
61
  "@backstage/catalog-model": "^1.6.0",
62
62
  "@backstage/config": "^1.2.0",
63
- "@backstage/core-compat-api": "^0.2.8",
64
- "@backstage/core-components": "^0.14.10",
63
+ "@backstage/core-compat-api": "^0.3.0-next.1",
64
+ "@backstage/core-components": "^0.14.11-next.0",
65
65
  "@backstage/core-plugin-api": "^1.9.3",
66
66
  "@backstage/errors": "^1.2.4",
67
- "@backstage/frontend-plugin-api": "^0.7.0",
67
+ "@backstage/frontend-plugin-api": "^0.8.0-next.1",
68
68
  "@backstage/integration": "^1.14.0",
69
69
  "@backstage/integration-react": "^1.1.30",
70
- "@backstage/plugin-auth-react": "^0.1.5",
71
- "@backstage/plugin-catalog-react": "^1.12.3",
70
+ "@backstage/plugin-auth-react": "^0.1.6-next.0",
71
+ "@backstage/plugin-catalog-react": "^1.12.4-next.1",
72
72
  "@backstage/plugin-search-common": "^1.2.14",
73
- "@backstage/plugin-search-react": "^1.7.14",
73
+ "@backstage/plugin-search-react": "^1.8.0-next.1",
74
74
  "@backstage/plugin-techdocs-common": "^0.1.0",
75
- "@backstage/plugin-techdocs-react": "^1.2.7",
75
+ "@backstage/plugin-techdocs-react": "^1.2.8-next.1",
76
76
  "@backstage/theme": "^0.5.6",
77
77
  "@material-ui/core": "^4.12.2",
78
78
  "@material-ui/icons": "^4.9.1",
@@ -88,11 +88,11 @@
88
88
  "react-use": "^17.2.4"
89
89
  },
90
90
  "devDependencies": {
91
- "@backstage/cli": "^0.27.0",
91
+ "@backstage/cli": "^0.27.1-next.1",
92
92
  "@backstage/core-app-api": "^1.14.2",
93
- "@backstage/dev-utils": "^1.0.37",
94
- "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.13",
95
- "@backstage/test-utils": "^1.5.10",
93
+ "@backstage/dev-utils": "^1.0.38-next.1",
94
+ "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.14-next.1",
95
+ "@backstage/test-utils": "^1.6.0-next.0",
96
96
  "@testing-library/dom": "^10.0.0",
97
97
  "@testing-library/jest-dom": "^6.0.0",
98
98
  "@testing-library/react": "^15.0.0",