@backstage/backend-app-api 0.7.10-next.1 → 0.8.1-next.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { LoggerService, RootConfigService, RootLoggerService, BackendFeature, ServiceFactoryOrFunction, DiscoveryService, LifecycleService, RootLifecycleService, RootHttpRouterService } from '@backstage/backend-plugin-api';
+import { LoggerService, RootConfigService, RootLoggerService, BackendFeature, ServiceFactory, DiscoveryService, LifecycleService, RootLifecycleService, RootHttpRouterService } from '@backstage/backend-plugin-api';
 import { Config, AppConfig } from '@backstage/config';
 import { ConfigSchema, LoadConfigOptionsRemote, RemoteConfigSourceOptions } from '@backstage/config-loader';
 import { RequestHandler, ErrorRequestHandler, Express, Handler } from 'express';
@@ -442,8 +442,18 @@ declare class WinstonLogger implements RootLoggerService {
  * @public
  */
 interface Backend {
-    add(feature: BackendFeature | (() => BackendFeature) | Promise<{
-        default: BackendFeature | (() => BackendFeature);
+    add(feature: BackendFeature | Promise<{
+        default: BackendFeature;
+    }>): void;
+    /**
+     * @deprecated The ability to add features defined as a callback is being
+     * removed. Please update the installed feature to no longer be defined as a
+     * callback, typically this means updating it to use the latest version of
+     * `@backstage/backend-plugin-api`. If the feature is from a third-party
+     * package, please reach out to the package maintainer to update it.
+     */
+    add(feature: (() => BackendFeature) | Promise<{
+        default: () => BackendFeature;
     }>): void;
     start(): Promise<void>;
     stop(): Promise<void>;
@@ -452,7 +462,7 @@ interface Backend {
  * @public
  */
 interface CreateSpecializedBackendOptions {
-    defaultServiceFactories: ServiceFactoryOrFunction[];
+    defaultServiceFactories: ServiceFactory[];
 }
 
 /**
@@ -464,7 +474,7 @@ declare function createSpecializedBackend(options: CreateSpecializedBackendOptio
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/cache` instead.
  */
-declare const cacheServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.CacheService, "plugin">;
+declare const cacheServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.CacheService, "plugin", undefined>;
 
 /**
  * @public
@@ -485,19 +495,19 @@ interface RootConfigFactoryOptions {
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
  */
-declare const rootConfigServiceFactory: (options?: RootConfigFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootConfigService, "root">;
+declare const rootConfigServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootConfigService, "root", RootConfigFactoryOptions>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/database` instead.
  */
-declare const databaseServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.DatabaseService, "plugin">;
+declare const databaseServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.DatabaseService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
  */
-declare const discoveryServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.DiscoveryService, "plugin">;
+declare const discoveryServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.DiscoveryService, "plugin", undefined>;
 
 /**
  * HostDiscovery is a basic PluginEndpointDiscovery implementation
@@ -562,7 +572,7 @@ type IdentityFactoryOptions = {
  * @public
  * @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
  */
-declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.IdentityService, "plugin">;
+declare const identityServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.IdentityService, "plugin", IdentityFactoryOptions>;
 
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
@@ -570,13 +580,13 @@ declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefi
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/lifecycle` instead.
  */
-declare const lifecycleServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<LifecycleService, "plugin">;
+declare const lifecycleServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<LifecycleService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/permissions` instead.
  */
-declare const permissionsServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.PermissionsService, "plugin">;
+declare const permissionsServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.PermissionsService, "plugin", undefined>;
 
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
@@ -584,47 +594,32 @@ declare const permissionsServiceFactory: () => _backstage_backend_plugin_api.Ser
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootLifecycle` instead.
  */
-declare const rootLifecycleServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<RootLifecycleService, "root">;
+declare const rootLifecycleServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<RootLifecycleService, "root", undefined>;
 
 /**
  * @public
  * @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
  */
-declare const tokenManagerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.TokenManagerService, "plugin">;
+declare const tokenManagerServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.TokenManagerService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/urlReader` instead.
  */
-declare const urlReaderServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.UrlReaderService, "plugin">;
+declare const urlReaderServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.UrlReaderService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/auth` instead.
  */
-declare const authServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.AuthService, "plugin">;
+declare const authServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.AuthService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/httpAuth` instead.
  */
-declare const httpAuthServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.HttpAuthService, "plugin">;
-
-/**
- * @public
- */
-interface HttpRouterFactoryOptions$1 {
-    /**
-     * A callback used to generate the path for each plugin, defaults to `/api/{pluginId}`.
-     */
-    getPath?(pluginId: string): string;
-}
+declare const httpAuthServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.HttpAuthService, "plugin", undefined>;
 
-/**
- * @public
- * @deprecated Please import from `@backstage/backend-defaults/httpRouter` instead.
- */
-type HttpRouterFactoryOptions = HttpRouterFactoryOptions$1;
 /**
  * HTTP route registration for plugins.
  *
@@ -635,7 +630,7 @@ type HttpRouterFactoryOptions = HttpRouterFactoryOptions$1;
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/httpRouter` instead.
  */
-declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions$1 | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.HttpRouterService, "plugin">;
+declare const httpRouterServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.HttpRouterService, "plugin", undefined>;
 
 /**
  * Options for {@link createLifecycleMiddleware}.
@@ -699,7 +694,7 @@ declare const createLifecycleMiddleware: typeof createLifecycleMiddleware$1;
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/logger` instead.
  */
-declare const loggerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.LoggerService, "plugin">;
+declare const loggerServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.LoggerService, "plugin", undefined>;
 
 /**
  * @public
@@ -753,7 +748,7 @@ type RootHttpRouterFactoryOptions = RootHttpRouterFactoryOptions$1;
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
  */
-declare const rootHttpRouterServiceFactory: (options?: RootHttpRouterFactoryOptions$1 | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">;
+declare const rootHttpRouterServiceFactory: ((options?: RootHttpRouterFactoryOptions$1 | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">) & _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">;
 
 /**
  * Options for the {@link DefaultRootHttpRouter} class.
@@ -800,18 +795,18 @@ declare class DefaultRootHttpRouter implements RootHttpRouterService {
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootLogger` instead.
  */
-declare const rootLoggerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootLoggerService, "root">;
+declare const rootLoggerServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.RootLoggerService, "root", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/scheduler` instead.
  */
-declare const schedulerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.SchedulerService, "plugin">;
+declare const schedulerServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.SchedulerService, "plugin", undefined>;
 
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/userInfo` instead.
  */
-declare const userInfoServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.UserInfoService, "plugin">;
+declare const userInfoServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<_backstage_backend_plugin_api.UserInfoService, "plugin", undefined>;
 
-export { type Backend, type CreateSpecializedBackendOptions, DefaultRootHttpRouter, type DefaultRootHttpRouterOptions, type ExtendedHttpServer, HostDiscovery, type HttpRouterFactoryOptions, type HttpServerCertificateOptions, type HttpServerOptions, type IdentityFactoryOptions, type LifecycleMiddlewareOptions, MiddlewareFactory, type MiddlewareFactoryErrorOptions, type MiddlewareFactoryOptions, type RootConfigFactoryOptions, type RootHttpRouterConfigureContext, type RootHttpRouterFactoryOptions, WinstonLogger, type WinstonLoggerOptions, authServiceFactory, cacheServiceFactory, createConfigSecretEnumerator, createHttpServer, createLifecycleMiddleware, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpAuthServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootConfigServiceFactory, rootHttpRouterServiceFactory, rootLifecycleServiceFactory, rootLoggerServiceFactory, schedulerServiceFactory, tokenManagerServiceFactory, urlReaderServiceFactory, userInfoServiceFactory };
+export { type Backend, type CreateSpecializedBackendOptions, DefaultRootHttpRouter, type DefaultRootHttpRouterOptions, type ExtendedHttpServer, HostDiscovery, type HttpServerCertificateOptions, type HttpServerOptions, type IdentityFactoryOptions, type LifecycleMiddlewareOptions, MiddlewareFactory, type MiddlewareFactoryErrorOptions, type MiddlewareFactoryOptions, type RootConfigFactoryOptions, type RootHttpRouterConfigureContext, type RootHttpRouterFactoryOptions, WinstonLogger, type WinstonLoggerOptions, authServiceFactory, cacheServiceFactory, createConfigSecretEnumerator, createHttpServer, createLifecycleMiddleware, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpAuthServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootConfigServiceFactory, rootHttpRouterServiceFactory, rootLifecycleServiceFactory, rootLoggerServiceFactory, schedulerServiceFactory, tokenManagerServiceFactory, urlReaderServiceFactory, userInfoServiceFactory };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-app-api",
-  "version": "0.7.10-next.1",
+  "version": "0.8.1-next.0",
   "description": "Core API used by Backstage backend apps",
   "backstage": {
     "role": "node-library"
@@ -49,16 +49,16 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.23.3-next.1",
-    "@backstage/backend-plugin-api": "^0.6.22-next.1",
-    "@backstage/backend-tasks": "^0.5.27-next.1",
+    "@backstage/backend-common": "^0.23.4-next.0",
+    "@backstage/backend-plugin-api": "^0.7.1-next.0",
+    "@backstage/backend-tasks": "^0.5.28-next.0",
     "@backstage/cli-common": "^0.1.14",
-    "@backstage/cli-node": "^0.2.6",
+    "@backstage/cli-node": "^0.2.7",
     "@backstage/config": "^1.2.0",
-    "@backstage/config-loader": "^1.8.1",
+    "@backstage/config-loader": "^1.8.2-next.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.17-next.1",
-    "@backstage/plugin-permission-node": "^0.7.33-next.1",
+    "@backstage/plugin-auth-node": "^0.4.18-next.0",
+    "@backstage/plugin-permission-node": "^0.8.1-next.0",
     "@backstage/types": "^1.1.1",
     "@manypkg/get-packages": "^1.1.3",
     "@types/cors": "^2.8.6",
@@ -89,9 +89,9 @@
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.3.4-next.1",
-    "@backstage/backend-test-utils": "^0.4.4-next.1",
-    "@backstage/cli": "^0.26.11-next.1",
+    "@backstage/backend-defaults": "^0.4.2-next.0",
+    "@backstage/backend-test-utils": "^0.4.5-next.0",
+    "@backstage/cli": "^0.27.0-next.0",
     "@types/compression": "^1.7.0",
     "@types/fs-extra": "^11.0.0",
     "@types/http-errors": "^2.0.0",