@backstage/backend-plugin-api 0.5.1-next.1 → 0.5.1-next.2
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.
- package/CHANGELOG.md +11 -0
- package/dist/index.d.ts +16 -16
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @backstage/backend-plugin-api
|
|
2
2
|
|
|
3
|
+
## 0.5.1-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-tasks@0.5.1-next.2
|
|
9
|
+
- @backstage/config@1.0.7
|
|
10
|
+
- @backstage/types@1.0.2
|
|
11
|
+
- @backstage/plugin-auth-node@0.2.13-next.2
|
|
12
|
+
- @backstage/plugin-permission-common@0.7.5-next.0
|
|
13
|
+
|
|
3
14
|
## 0.5.1-next.1
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ interface UrlReaderService {
|
|
|
36
36
|
*
|
|
37
37
|
* @public
|
|
38
38
|
*/
|
|
39
|
-
|
|
39
|
+
type ReadUrlOptions = {
|
|
40
40
|
/**
|
|
41
41
|
* An ETag which can be provided to check whether a
|
|
42
42
|
* {@link UrlReaderService.readUrl} response has changed from a previous execution.
|
|
@@ -89,7 +89,7 @@ declare type ReadUrlOptions = {
|
|
|
89
89
|
*
|
|
90
90
|
* @public
|
|
91
91
|
*/
|
|
92
|
-
|
|
92
|
+
type ReadUrlResponse = {
|
|
93
93
|
/**
|
|
94
94
|
* Returns the data that was read from the remote URL.
|
|
95
95
|
*/
|
|
@@ -120,7 +120,7 @@ declare type ReadUrlResponse = {
|
|
|
120
120
|
*
|
|
121
121
|
* @public
|
|
122
122
|
*/
|
|
123
|
-
|
|
123
|
+
type ReadTreeOptions = {
|
|
124
124
|
/**
|
|
125
125
|
* A filter that can be used to select which files should be included.
|
|
126
126
|
*
|
|
@@ -171,7 +171,7 @@ declare type ReadTreeOptions = {
|
|
|
171
171
|
*
|
|
172
172
|
* @public
|
|
173
173
|
*/
|
|
174
|
-
|
|
174
|
+
type ReadTreeResponseDirOptions = {
|
|
175
175
|
/**
|
|
176
176
|
* The directory to write files to.
|
|
177
177
|
*
|
|
@@ -186,7 +186,7 @@ declare type ReadTreeResponseDirOptions = {
|
|
|
186
186
|
*
|
|
187
187
|
* @public
|
|
188
188
|
*/
|
|
189
|
-
|
|
189
|
+
type ReadTreeResponse = {
|
|
190
190
|
/**
|
|
191
191
|
* Returns an array of all the files inside the tree, and corresponding
|
|
192
192
|
* functions to read their content.
|
|
@@ -217,7 +217,7 @@ declare type ReadTreeResponse = {
|
|
|
217
217
|
*
|
|
218
218
|
* @public
|
|
219
219
|
*/
|
|
220
|
-
|
|
220
|
+
type ReadTreeResponseFile = {
|
|
221
221
|
/**
|
|
222
222
|
* The filepath of the data.
|
|
223
223
|
*/
|
|
@@ -236,7 +236,7 @@ declare type ReadTreeResponseFile = {
|
|
|
236
236
|
*
|
|
237
237
|
* @public
|
|
238
238
|
*/
|
|
239
|
-
|
|
239
|
+
type SearchOptions = {
|
|
240
240
|
/**
|
|
241
241
|
* An etag can be provided to check whether the search response has changed from a previous execution.
|
|
242
242
|
*
|
|
@@ -263,7 +263,7 @@ declare type SearchOptions = {
|
|
|
263
263
|
*
|
|
264
264
|
* @public
|
|
265
265
|
*/
|
|
266
|
-
|
|
266
|
+
type SearchResponse = {
|
|
267
267
|
/**
|
|
268
268
|
* The files that matched the search query.
|
|
269
269
|
*/
|
|
@@ -278,7 +278,7 @@ declare type SearchResponse = {
|
|
|
278
278
|
*
|
|
279
279
|
* @public
|
|
280
280
|
*/
|
|
281
|
-
|
|
281
|
+
type SearchResponseFile = {
|
|
282
282
|
/**
|
|
283
283
|
* The full URL to the file.
|
|
284
284
|
*/
|
|
@@ -342,7 +342,7 @@ interface RootLoggerService extends LoggerService {
|
|
|
342
342
|
/**
|
|
343
343
|
* @public
|
|
344
344
|
*/
|
|
345
|
-
|
|
345
|
+
type LifecycleServiceShutdownHook = () => void | Promise<void>;
|
|
346
346
|
/**
|
|
347
347
|
* @public
|
|
348
348
|
*/
|
|
@@ -479,7 +479,7 @@ interface ConfigService extends Config {
|
|
|
479
479
|
*
|
|
480
480
|
* @public
|
|
481
481
|
*/
|
|
482
|
-
|
|
482
|
+
type ServiceRef<TService, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
|
|
483
483
|
id: string;
|
|
484
484
|
/**
|
|
485
485
|
* This determines the scope at which this service is available.
|
|
@@ -509,7 +509,7 @@ interface ServiceFactory<TService = unknown, TScope extends 'plugin' | 'root' =
|
|
|
509
509
|
*
|
|
510
510
|
* @public
|
|
511
511
|
*/
|
|
512
|
-
|
|
512
|
+
type ServiceFactoryOrFunction = ServiceFactory | (() => ServiceFactory);
|
|
513
513
|
/** @public */
|
|
514
514
|
interface ServiceRefConfig<TService, TScope extends 'root' | 'plugin'> {
|
|
515
515
|
id: string;
|
|
@@ -529,7 +529,7 @@ declare function createServiceRef<TService>(config: ServiceRefConfig<TService, '
|
|
|
529
529
|
*/
|
|
530
530
|
declare function createServiceRef<TService>(config: ServiceRefConfig<TService, 'root'>): ServiceRef<TService, 'root'>;
|
|
531
531
|
/** @ignore */
|
|
532
|
-
|
|
532
|
+
type ServiceRefsToInstances<T extends {
|
|
533
533
|
[key in string]: ServiceRef<unknown>;
|
|
534
534
|
}, TScope extends 'root' | 'plugin' = 'root' | 'plugin'> = {
|
|
535
535
|
[key in keyof T as T[key]['scope'] extends TScope ? key : never]: T[key]['T'];
|
|
@@ -611,7 +611,7 @@ declare function createServiceFactory<TService, TImpl extends TService, TDeps ex
|
|
|
611
611
|
*
|
|
612
612
|
* @public
|
|
613
613
|
*/
|
|
614
|
-
|
|
614
|
+
type CacheServiceSetOptions = {
|
|
615
615
|
/**
|
|
616
616
|
* Optional TTL in milliseconds. Defaults to the TTL provided when the client
|
|
617
617
|
* was set up (or no TTL if none are provided).
|
|
@@ -623,7 +623,7 @@ declare type CacheServiceSetOptions = {
|
|
|
623
623
|
*
|
|
624
624
|
* @public
|
|
625
625
|
*/
|
|
626
|
-
|
|
626
|
+
type CacheServiceOptions = {
|
|
627
627
|
/**
|
|
628
628
|
* An optional default TTL (in milliseconds) to be set when getting a client
|
|
629
629
|
* instance. If not provided, data will persist indefinitely by default (or
|
|
@@ -792,7 +792,7 @@ declare function createSharedEnvironment<TOptions extends [options?: object] = [
|
|
|
792
792
|
*
|
|
793
793
|
* @public
|
|
794
794
|
*/
|
|
795
|
-
|
|
795
|
+
type ExtensionPoint<T> = {
|
|
796
796
|
id: string;
|
|
797
797
|
/**
|
|
798
798
|
* Utility for getting the type of the extension point, using `typeof extensionPoint.T`.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/backend-plugin-api",
|
|
3
3
|
"description": "Core API used by Backstage backend plugins",
|
|
4
|
-
"version": "0.5.1-next.
|
|
4
|
+
"version": "0.5.1-next.2",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"publishConfig": {
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
"start": "backstage-cli package start"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@backstage/backend-tasks": "^0.5.1-next.
|
|
35
|
+
"@backstage/backend-tasks": "^0.5.1-next.2",
|
|
36
36
|
"@backstage/config": "^1.0.7",
|
|
37
|
-
"@backstage/plugin-auth-node": "^0.2.13-next.
|
|
37
|
+
"@backstage/plugin-auth-node": "^0.2.13-next.2",
|
|
38
38
|
"@backstage/plugin-permission-common": "^0.7.5-next.0",
|
|
39
39
|
"@backstage/types": "^1.0.2",
|
|
40
40
|
"@types/express": "^4.17.6",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"knex": "^2.0.0"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@backstage/cli": "^0.22.6-next.
|
|
45
|
+
"@backstage/cli": "^0.22.6-next.2"
|
|
46
46
|
},
|
|
47
47
|
"files": [
|
|
48
48
|
"dist",
|