@backstage/backend-plugin-api 0.0.0-nightly-20230110023000 → 0.0.0-nightly-20230111022819

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # @backstage/backend-plugin-api
2
2
 
3
- ## 0.0.0-nightly-20230110023000
3
+ ## 0.0.0-nightly-20230111022819
4
4
 
5
5
  ### Minor Changes
6
6
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ### Patch Changes
10
10
 
11
- - 6cfd4d7073: Added `RootLifecycleService` and `rootLifecycleServiceRef`, as well as added a `labels` option to the existing `LifecycleServiceShutdownHook`.
11
+ - 6cfd4d7073: Added `RootLifecycleService` and `rootLifecycleServiceRef`, as well as added a `logger` option to the existing `LifecycleServiceShutdownHook`.
12
12
  - ecc6bfe4c9: Added `ServiceFactoryOrFunction` type, for use when either a `ServiceFactory` or `() => ServiceFactory` can be used.
13
13
  - 02b119ff93: Added a new `rootHttpRouterServiceRef` and `RootHttpRouterService` interface.
14
14
  - 5e2cebe9a3: Migrate `UrlReader` into this package to gradually remove the dependency on backend-common.
@@ -17,10 +17,29 @@
17
17
  - 16054afdec: Documented `coreServices` an all of its members.
18
18
  - 62b04bb865: Updates all `create*` methods to simplify their type definitions and ensure they all have configuration interfaces.
19
19
  - Updated dependencies
20
- - @backstage/config@0.0.0-nightly-20230110023000
21
- - @backstage/backend-tasks@0.0.0-nightly-20230110023000
20
+ - @backstage/backend-tasks@0.0.0-nightly-20230111022819
21
+ - @backstage/config@0.0.0-nightly-20230111022819
22
+ - @backstage/types@1.0.2
23
+ - @backstage/plugin-permission-common@0.0.0-nightly-20230111022819
24
+
25
+ ## 0.3.0-next.1
26
+
27
+ ### Minor Changes
28
+
29
+ - 8e06f3cf00: Moved `loggerToWinstonLogger` to `@backstage/backend-common`.
30
+
31
+ ### Patch Changes
32
+
33
+ - ecc6bfe4c9: Added `ServiceFactoryOrFunction` type, for use when either a `ServiceFactory` or `() => ServiceFactory` can be used.
34
+ - 02b119ff93: Added a new `rootHttpRouterServiceRef` and `RootHttpRouterService` interface.
35
+ - 5437fe488f: Migrated types related to `TokenManagerService`, `CacheService` and `DatabaseService` into backend-plugin-api.
36
+ - 16054afdec: Documented `coreServices` an all of its members.
37
+ - 62b04bb865: Updates all `create*` methods to simplify their type definitions and ensure they all have configuration interfaces.
38
+ - Updated dependencies
39
+ - @backstage/backend-tasks@0.4.1-next.1
40
+ - @backstage/config@1.0.6-next.0
22
41
  - @backstage/types@1.0.2
23
- - @backstage/plugin-permission-common@0.0.0-nightly-20230110023000
42
+ - @backstage/plugin-permission-common@0.7.3-next.0
24
43
 
25
44
  ## 0.2.1-next.0
26
45
 
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/backend-plugin-api",
3
- "version": "0.0.0-nightly-20230110023000",
3
+ "version": "0.0.0-nightly-20230111022819",
4
4
  "main": "../dist/index.cjs.js",
5
5
  "types": "../dist/index.alpha.d.ts"
6
6
  }
@@ -264,7 +264,7 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
264
264
 
265
265
  /**
266
266
  * The DatabaseService manages access to databases that Plugins get.
267
- *gs
267
+ *
268
268
  * @public
269
269
  */
270
270
  export declare interface DatabaseService {
@@ -385,8 +385,10 @@ export declare interface LifecycleService {
385
385
  **/
386
386
  export declare type LifecycleServiceShutdownHook = {
387
387
  fn: () => void | Promise<void>;
388
- /** Labels to help identify the shutdown hook */
389
- labels?: Record<string, string>;
388
+ /**
389
+ * Optional {@link LoggerService} that will be used for logging instead of the default logger.
390
+ */
391
+ logger?: LoggerService;
390
392
  };
391
393
 
392
394
  /**
@@ -264,7 +264,7 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
264
264
 
265
265
  /**
266
266
  * The DatabaseService manages access to databases that Plugins get.
267
- *gs
267
+ *
268
268
  * @public
269
269
  */
270
270
  export declare interface DatabaseService {
@@ -385,8 +385,10 @@ export declare interface LifecycleService {
385
385
  **/
386
386
  export declare type LifecycleServiceShutdownHook = {
387
387
  fn: () => void | Promise<void>;
388
- /** Labels to help identify the shutdown hook */
389
- labels?: Record<string, string>;
388
+ /**
389
+ * Optional {@link LoggerService} that will be used for logging instead of the default logger.
390
+ */
391
+ logger?: LoggerService;
390
392
  };
391
393
 
392
394
  /**
package/dist/index.d.ts CHANGED
@@ -264,7 +264,7 @@ export declare function createServiceRef<TService>(config: ServiceRefConfig<TSer
264
264
 
265
265
  /**
266
266
  * The DatabaseService manages access to databases that Plugins get.
267
- *gs
267
+ *
268
268
  * @public
269
269
  */
270
270
  export declare interface DatabaseService {
@@ -385,8 +385,10 @@ export declare interface LifecycleService {
385
385
  **/
386
386
  export declare type LifecycleServiceShutdownHook = {
387
387
  fn: () => void | Promise<void>;
388
- /** Labels to help identify the shutdown hook */
389
- labels?: Record<string, string>;
388
+ /**
389
+ * Optional {@link LoggerService} that will be used for logging instead of the default logger.
390
+ */
391
+ logger?: LoggerService;
390
392
  };
391
393
 
392
394
  /**
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.0.0-nightly-20230110023000",
4
+ "version": "0.0.0-nightly-20230111022819",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "publishConfig": {
@@ -33,16 +33,16 @@
33
33
  "start": "backstage-cli package start"
34
34
  },
35
35
  "dependencies": {
36
- "@backstage/backend-tasks": "^0.0.0-nightly-20230110023000",
37
- "@backstage/config": "^0.0.0-nightly-20230110023000",
38
- "@backstage/plugin-permission-common": "^0.0.0-nightly-20230110023000",
36
+ "@backstage/backend-tasks": "^0.0.0-nightly-20230111022819",
37
+ "@backstage/config": "^0.0.0-nightly-20230111022819",
38
+ "@backstage/plugin-permission-common": "^0.0.0-nightly-20230111022819",
39
39
  "@backstage/types": "^1.0.2",
40
40
  "@types/express": "^4.17.6",
41
41
  "express": "^4.17.1",
42
42
  "knex": "^2.0.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@backstage/cli": "^0.0.0-nightly-20230110023000"
45
+ "@backstage/cli": "^0.0.0-nightly-20230111022819"
46
46
  },
47
47
  "files": [
48
48
  "dist",