@backstage/backend-plugin-api 0.5.3-next.0 → 0.5.3-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/backend-plugin-api
 
+## 0.5.3-next.1
+
+### Patch Changes
+
+- 3bb4158a8aa4: Added startup hooks to the lifecycle services.
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.3-next.1
+  - @backstage/plugin-auth-node@0.2.15-next.1
+  - @backstage/plugin-permission-common@0.7.6-next.0
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+
 ## 0.5.3-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -339,6 +339,19 @@ interface LoggerService {
 interface RootLoggerService extends LoggerService {
 }
 
+/**
+ * @public
+ */
+type LifecycleServiceStartupHook = () => void | Promise<void>;
+/**
+ * @public
+ */
+interface LifecycleServiceStartupOptions {
+    /**
+     * Optional {@link LoggerService} that will be used for logging instead of the default logger.
+     */
+    logger?: LoggerService;
+}
 /**
  * @public
  */
@@ -356,6 +369,16 @@ interface LifecycleServiceShutdownOptions {
  * @public
  */
 interface LifecycleService {
+    /**
+     * Register a function to be called when the backend has been initialized.
+     *
+     * @remarks
+     *
+     * When used with plugin scope it will wait for the plugin itself to have been initialized.
+     *
+     * When used with root scope it will wait for all plugins to have been initialized.
+     */
+    addStartupHook(hook: LifecycleServiceStartupHook, options?: LifecycleServiceStartupOptions): void;
     /**
      * Register a function to be called when the backend is shutting down.
      */
@@ -913,4 +936,4 @@ interface BackendModuleConfig {
  */
 declare function createBackendModule<TOptions extends [options?: object] = []>(config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig)): (...params: TOptions) => BackendFeature;
 
-export { BackendFeature, BackendModuleConfig, BackendModuleRegistrationPoints, BackendPluginConfig, BackendPluginRegistrationPoints, CacheService, CacheServiceOptions, CacheServiceSetOptions, ConfigService, DatabaseService, DiscoveryService, ExtensionPoint, ExtensionPointConfig, HttpRouterService, IdentityService, LifecycleService, LifecycleServiceShutdownHook, LifecycleServiceShutdownOptions, LoggerService, PermissionsService, PluginMetadataService, PluginServiceFactoryConfig, ReadTreeOptions, ReadTreeResponse, ReadTreeResponseDirOptions, ReadTreeResponseFile, ReadUrlOptions, ReadUrlResponse, RootHttpRouterService, RootLifecycleService, RootLoggerService, RootServiceFactoryConfig, SchedulerService, SearchOptions, SearchResponse, SearchResponseFile, ServiceFactory, ServiceFactoryOrFunction, ServiceRef, ServiceRefConfig, SharedBackendEnvironment, SharedBackendEnvironmentConfig, TokenManagerService, UrlReaderService, coreServices, createBackendModule, createBackendPlugin, createExtensionPoint, createServiceFactory, createServiceRef, createSharedEnvironment };
+export { BackendFeature, BackendModuleConfig, BackendModuleRegistrationPoints, BackendPluginConfig, BackendPluginRegistrationPoints, CacheService, CacheServiceOptions, CacheServiceSetOptions, ConfigService, DatabaseService, DiscoveryService, ExtensionPoint, ExtensionPointConfig, HttpRouterService, IdentityService, LifecycleService, LifecycleServiceShutdownHook, LifecycleServiceShutdownOptions, LifecycleServiceStartupHook, LifecycleServiceStartupOptions, LoggerService, PermissionsService, PluginMetadataService, PluginServiceFactoryConfig, ReadTreeOptions, ReadTreeResponse, ReadTreeResponseDirOptions, ReadTreeResponseFile, ReadUrlOptions, ReadUrlResponse, RootHttpRouterService, RootLifecycleService, RootLoggerService, RootServiceFactoryConfig, SchedulerService, SearchOptions, SearchResponse, SearchResponseFile, ServiceFactory, ServiceFactoryOrFunction, ServiceRef, ServiceRefConfig, SharedBackendEnvironment, SharedBackendEnvironmentConfig, TokenManagerService, UrlReaderService, coreServices, createBackendModule, createBackendPlugin, createExtensionPoint, createServiceFactory, createServiceRef, createSharedEnvironment };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-plugin-api",
   "description": "Core API used by Backstage backend plugins",
-  "version": "0.5.3-next.0",
+  "version": "0.5.3-next.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -32,17 +32,17 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-tasks": "^0.5.3-next.0",
+    "@backstage/backend-tasks": "^0.5.3-next.1",
     "@backstage/config": "^1.0.7",
-    "@backstage/plugin-auth-node": "^0.2.15-next.0",
-    "@backstage/plugin-permission-common": "^0.7.5",
+    "@backstage/plugin-auth-node": "^0.2.15-next.1",
+    "@backstage/plugin-permission-common": "^0.7.6-next.0",
     "@backstage/types": "^1.0.2",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "knex": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.8-next.0"
+    "@backstage/cli": "^0.22.8-next.1"
   },
   "files": [
     "dist",