@backstage/plugin-techdocs 0.0.0-nightly-20240918022959 → 0.0.0-nightly-20240920023120

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 +5 -5
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.d.ts +31 -9
  4. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
- ## 0.0.0-nightly-20240918022959
3
+ ## 0.0.0-nightly-20240920023120
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/frontend-plugin-api@0.0.0-nightly-20240918022959
9
- - @backstage/core-compat-api@0.0.0-nightly-20240918022959
10
- - @backstage/plugin-catalog-react@0.0.0-nightly-20240918022959
11
- - @backstage/plugin-search-react@0.0.0-nightly-20240918022959
8
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20240920023120
9
+ - @backstage/core-compat-api@0.0.0-nightly-20240920023120
10
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20240920023120
11
+ - @backstage/plugin-search-react@0.0.0-nightly-20240920023120
12
12
  - @backstage/catalog-model@1.7.0
13
13
  - @backstage/config@1.2.0
14
14
  - @backstage/core-components@0.15.0
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs__alpha",
3
- "version": "0.0.0-nightly-20240918022959",
3
+ "version": "0.0.0-nightly-20240920023120",
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
@@ -33,8 +33,8 @@ declare const techDocsSearchResultListItemExtension: _backstage_frontend_plugin_
33
33
  }>;
34
34
  };
35
35
  kind: "search-result-list-item";
36
- namespace: undefined;
37
36
  name: undefined;
37
+ params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
38
38
  }>;
39
39
  /** @alpha */
40
40
  declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
@@ -48,16 +48,17 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
48
48
  }, {}, {
49
49
  "api:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
50
50
  kind: "api";
51
- namespace: undefined;
52
51
  name: undefined;
53
52
  config: {};
54
53
  configInput: {};
55
54
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
56
55
  inputs: {};
56
+ params: {
57
+ factory: _backstage_frontend_plugin_api.AnyApiFactory;
58
+ };
57
59
  }>;
58
60
  "page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
59
61
  kind: "page";
60
- namespace: undefined;
61
62
  name: undefined;
62
63
  config: {
63
64
  path: string | undefined;
@@ -69,10 +70,14 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
69
70
  optional: true;
70
71
  }>;
71
72
  inputs: {};
73
+ params: {
74
+ defaultPath: string;
75
+ loader: () => Promise<JSX.Element>;
76
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
77
+ };
72
78
  }>;
73
79
  "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
74
80
  kind: "nav-item";
75
- namespace: undefined;
76
81
  name: undefined;
77
82
  config: {};
78
83
  configInput: {};
@@ -82,15 +87,22 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
82
87
  routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
83
88
  }, "core.nav-item.target", {}>;
84
89
  inputs: {};
90
+ params: {
91
+ title: string;
92
+ icon: _backstage_core_plugin_api.IconComponent;
93
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
94
+ };
85
95
  }>;
86
96
  "api:techdocs/storage": _backstage_frontend_plugin_api.ExtensionDefinition<{
87
97
  kind: "api";
88
- namespace: undefined;
89
98
  name: "storage";
90
99
  config: {};
91
100
  configInput: {};
92
101
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
93
102
  inputs: {};
103
+ params: {
104
+ factory: _backstage_frontend_plugin_api.AnyApiFactory;
105
+ };
94
106
  }>;
95
107
  "search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
96
108
  config: {
@@ -120,12 +132,11 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
120
132
  }>;
121
133
  };
122
134
  kind: "search-result-list-item";
123
- namespace: undefined;
124
135
  name: undefined;
136
+ params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
125
137
  }>;
126
138
  "page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
127
139
  kind: "page";
128
- namespace: undefined;
129
140
  name: "reader";
130
141
  config: {
131
142
  path: string | undefined;
@@ -137,6 +148,11 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
137
148
  optional: true;
138
149
  }>;
139
150
  inputs: {};
151
+ params: {
152
+ defaultPath: string;
153
+ loader: () => Promise<JSX.Element>;
154
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
155
+ };
140
156
  }>;
141
157
  "entity-content:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
142
158
  config: {
@@ -163,8 +179,14 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
163
179
  }>;
164
180
  };
165
181
  kind: "entity-content";
166
- namespace: undefined;
167
182
  name: undefined;
183
+ params: {
184
+ loader: () => Promise<JSX.Element>;
185
+ defaultPath: string;
186
+ defaultTitle: string;
187
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
188
+ filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
189
+ };
168
190
  }>;
169
191
  "empty-state:techdocs/entity-content": _backstage_frontend_plugin_api.ExtensionDefinition<{
170
192
  config: {};
@@ -178,8 +200,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
178
200
  singleton: boolean;
179
201
  }>;
180
202
  };
203
+ params: never;
181
204
  kind: "empty-state";
182
- namespace: undefined;
183
205
  name: "entity-content";
184
206
  }>;
185
207
  }>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs",
3
- "version": "0.0.0-nightly-20240918022959",
3
+ "version": "0.0.0-nightly-20240920023120",
4
4
  "description": "The Backstage plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -60,17 +60,17 @@
60
60
  "dependencies": {
61
61
  "@backstage/catalog-model": "^1.7.0",
62
62
  "@backstage/config": "^1.2.0",
63
- "@backstage/core-compat-api": "^0.0.0-nightly-20240918022959",
63
+ "@backstage/core-compat-api": "^0.0.0-nightly-20240920023120",
64
64
  "@backstage/core-components": "^0.15.0",
65
65
  "@backstage/core-plugin-api": "^1.9.4",
66
66
  "@backstage/errors": "^1.2.4",
67
- "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240918022959",
67
+ "@backstage/frontend-plugin-api": "^0.0.0-nightly-20240920023120",
68
68
  "@backstage/integration": "^1.15.0",
69
69
  "@backstage/integration-react": "^1.1.31",
70
70
  "@backstage/plugin-auth-react": "^0.1.6",
71
- "@backstage/plugin-catalog-react": "^0.0.0-nightly-20240918022959",
71
+ "@backstage/plugin-catalog-react": "^0.0.0-nightly-20240920023120",
72
72
  "@backstage/plugin-search-common": "^1.2.14",
73
- "@backstage/plugin-search-react": "^0.0.0-nightly-20240918022959",
73
+ "@backstage/plugin-search-react": "^0.0.0-nightly-20240920023120",
74
74
  "@backstage/plugin-techdocs-common": "^0.1.0",
75
75
  "@backstage/plugin-techdocs-react": "^1.2.8",
76
76
  "@backstage/theme": "^0.5.7",
@@ -88,9 +88,9 @@
88
88
  "react-use": "^17.2.4"
89
89
  },
90
90
  "devDependencies": {
91
- "@backstage/cli": "^0.0.0-nightly-20240918022959",
91
+ "@backstage/cli": "^0.0.0-nightly-20240920023120",
92
92
  "@backstage/core-app-api": "^1.15.0",
93
- "@backstage/dev-utils": "^0.0.0-nightly-20240918022959",
93
+ "@backstage/dev-utils": "^0.0.0-nightly-20240920023120",
94
94
  "@backstage/plugin-techdocs-module-addons-contrib": "^1.1.14",
95
95
  "@backstage/test-utils": "^1.6.0",
96
96
  "@testing-library/dom": "^10.0.0",