@backstage/backend-app-api 0.3.2-next.0 → 0.4.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @backstage/backend-app-api
 
+## 0.4.0-next.2
+
+### Minor Changes
+
+- 01a075ec1d: **BREAKING**: Renamed `RootHttpRouterConfigureOptions` to `RootHttpRouterConfigureContext`, and removed the unused type `ServiceOrExtensionPoint`.
+- 4ae71b7f2e: **BREAKING** Renaming `*Factory` exports to `*ServiceFactory` instead. For example `configFactory` now is exported as `configServiceFactory`.
+- d31d8e00b3: **BREAKING** `HttpServerCertificateOptions` when specified with a `key` and `cert` should also have the `type: 'pem'` instead of `type: 'plain'`
+
+### Patch Changes
+
+- e716946103: Updated usage of the lifecycle service.
+- f60cca9da1: Updated database factory to pass service deps required for restoring database state during development.
+- 610d65e143: Updates to match new `BackendFeature` type.
+- ab22515647: The shutdown signal handlers are now installed as part of the backend instance rather than the lifecycle service, and explicitly cause the process to exit.
+- b729f9f31f: Moved the options of the `config` and `rootHttpRouter` services out to the factories themselves, where they belong
+- 71a5ec0f06: Updated usages of `LogMeta`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.0-next.2
+  - @backstage/backend-common@0.18.2-next.2
+  - @backstage/backend-tasks@0.4.3-next.2
+  - @backstage/plugin-auth-node@0.2.11-next.2
+  - @backstage/plugin-permission-node@0.7.5-next.2
+  - @backstage/cli-common@0.1.11
+  - @backstage/config@1.0.6
+  - @backstage/config-loader@1.1.8
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+
+## 0.3.2-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.18.2-next.1
+  - @backstage/backend-plugin-api@0.3.2-next.1
+  - @backstage/backend-tasks@0.4.3-next.1
+  - @backstage/cli-common@0.1.11
+  - @backstage/config@1.0.6
+  - @backstage/config-loader@1.1.8
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.11-next.1
+  - @backstage/plugin-permission-node@0.7.5-next.1
+
 ## 0.3.2-next.0
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-app-api",
-  "version": "0.3.2-next.0",
+  "version": "0.4.0-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -12,17 +12,16 @@ import { ConfigService } from '@backstage/backend-plugin-api';
 import { CorsOptions } from 'cors';
 import { ErrorRequestHandler } from 'express';
 import { Express as Express_2 } from 'express';
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
 import { Format } from 'logform';
 import { Handler } from 'express';
 import { HelmetOptions } from 'helmet';
 import * as http from 'http';
 import { HttpRouterService } from '@backstage/backend-plugin-api';
 import { IdentityService } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
 import { LifecycleService } from '@backstage/backend-plugin-api';
 import { LoadConfigOptionsRemote } from '@backstage/config-loader';
 import { LoggerService } from '@backstage/backend-plugin-api';
-import { LogMeta } from '@backstage/backend-plugin-api';
 import { PermissionsService } from '@backstage/backend-plugin-api';
 import { PluginCacheManager } from '@backstage/backend-common';
 import { PluginDatabaseManager } from '@backstage/backend-common';
@@ -35,7 +34,6 @@ import { RootLoggerService } from '@backstage/backend-plugin-api';
 import { SchedulerService } from '@backstage/backend-plugin-api';
 import { ServiceFactory } from '@backstage/backend-plugin-api';
 import { ServiceFactoryOrFunction } from '@backstage/backend-plugin-api';
-import { ServiceRef } from '@backstage/backend-plugin-api';
 import { TokenManagerService } from '@backstage/backend-plugin-api';
 import { transport } from 'winston';
 import { UrlReader } from '@backstage/backend-common';
@@ -50,10 +48,7 @@ export declare interface Backend {
 }
 
 /** @public */
-export declare const cacheFactory: () => ServiceFactory<PluginCacheManager>;
-
-/** @public */
-export declare const configFactory: () => ServiceFactory<ConfigService>;
+export declare const cacheServiceFactory: () => ServiceFactory<PluginCacheManager>;
 
 /** @public */
 export declare interface ConfigFactoryOptions {
@@ -67,6 +62,9 @@ export declare interface ConfigFactoryOptions {
     remote?: LoadConfigOptionsRemote;
 }
 
+/** @public */
+export declare const configServiceFactory: (options?: ConfigFactoryOptions | undefined) => ServiceFactory<ConfigService>;
+
 /** @public */
 export declare function createConfigSecretEnumerator(options: {
     logger: LoggerService;
@@ -95,7 +93,7 @@ export declare interface CreateSpecializedBackendOptions {
 }
 
 /** @public */
-export declare const databaseFactory: () => ServiceFactory<PluginDatabaseManager>;
+export declare const databaseServiceFactory: () => ServiceFactory<PluginDatabaseManager>;
 
 /**
  * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
@@ -125,7 +123,7 @@ export declare interface DefaultRootHttpRouterOptions {
 }
 
 /** @public */
-export declare const discoveryFactory: () => ServiceFactory<PluginEndpointDiscovery>;
+export declare const discoveryServiceFactory: () => ServiceFactory<PluginEndpointDiscovery>;
 
 /**
  * An HTTP server extended with utility methods.
@@ -138,9 +136,6 @@ export declare interface ExtendedHttpServer extends http.Server {
     port(): number;
 }
 
-/** @public */
-export declare const httpRouterFactory: (options?: HttpRouterFactoryOptions | undefined) => ServiceFactory<HttpRouterService>;
-
 /**
  * @public
  */
@@ -151,13 +146,16 @@ export declare interface HttpRouterFactoryOptions {
     getPath?(pluginId: string): string;
 }
 
+/** @public */
+export declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions | undefined) => ServiceFactory<HttpRouterService>;
+
 /**
  * Options for configuring HTTPS for an HTTP server.
  *
  * @public
  */
 export declare type HttpServerCertificateOptions = {
-    type: 'plain';
+    type: 'pem';
     key: string;
     cert: string;
 } | {
@@ -180,9 +178,6 @@ export declare type HttpServerOptions = {
     };
 };
 
-/** @public */
-export declare const identityFactory: (options?: IdentityFactoryOptions | undefined) => ServiceFactory<IdentityService>;
-
 /**
  * An identity client options object which allows extra configurations
  *
@@ -195,10 +190,14 @@ export declare type IdentityFactoryOptions = {
     algorithms?: string[];
 };
 
+/** @public */
+export declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefined) => ServiceFactory<IdentityService>;
+
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- * @public */
-export declare const lifecycleFactory: () => ServiceFactory<LifecycleService>;
+ * @public
+ */
+export declare const lifecycleServiceFactory: () => ServiceFactory<LifecycleService>;
 
 /**
  * Load configuration for a Backend.
@@ -215,7 +214,7 @@ export declare function loadBackendConfig(options: {
 }>;
 
 /** @public */
-export declare const loggerFactory: () => ServiceFactory<LoggerService>;
+export declare const loggerServiceFactory: () => ServiceFactory<LoggerService>;
 
 /**
  * A utility to configure common middleware.
@@ -341,7 +340,7 @@ export declare interface MiddlewareFactoryOptions {
 }
 
 /** @public */
-export declare const permissionsFactory: () => ServiceFactory<PermissionsService>;
+export declare const permissionsServiceFactory: () => ServiceFactory<PermissionsService>;
 
 /**
  * Attempts to read a CORS options object from the backend configuration object.
@@ -390,7 +389,7 @@ export declare function readHttpServerOptions(config?: Config): HttpServerOption
 /**
  * @public
  */
-export declare interface RootHttpRouterConfigureOptions {
+export declare interface RootHttpRouterConfigureContext {
     app: Express_2;
     middleware: MiddlewareFactory;
     routes: RequestHandler;
@@ -399,9 +398,6 @@ export declare interface RootHttpRouterConfigureOptions {
     lifecycle: LifecycleService;
 }
 
-/** @public */
-export declare const rootHttpRouterFactory: () => ServiceFactory<RootHttpRouterService>;
-
 /**
  * @public
  */
@@ -411,30 +407,30 @@ export declare type RootHttpRouterFactoryOptions = {
      * not given. Disables index path behavior if false is given.
      */
     indexPath?: string | false;
-    configure?(options: RootHttpRouterConfigureOptions): void;
+    configure?(context: RootHttpRouterConfigureContext): void;
 };
 
+/** @public */
+export declare const rootHttpRouterServiceFactory: (options?: RootHttpRouterFactoryOptions | undefined) => ServiceFactory<RootHttpRouterService>;
+
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- * @public */
-export declare const rootLifecycleFactory: () => ServiceFactory<RootLifecycleService>;
+ *
+ * @public
+ */
+export declare const rootLifecycleServiceFactory: () => ServiceFactory<RootLifecycleService>;
 
 /** @public */
-export declare const rootLoggerFactory: () => ServiceFactory<RootLoggerService>;
+export declare const rootLoggerServiceFactory: () => ServiceFactory<RootLoggerService>;
 
 /** @public */
-export declare const schedulerFactory: () => ServiceFactory<SchedulerService>;
-
-/**
- * @public
- */
-export declare type ServiceOrExtensionPoint<T = unknown> = ExtensionPoint<T> | ServiceRef<T>;
+export declare const schedulerServiceFactory: () => ServiceFactory<SchedulerService>;
 
 /** @public */
-export declare const tokenManagerFactory: () => ServiceFactory<TokenManagerService>;
+export declare const tokenManagerServiceFactory: () => ServiceFactory<TokenManagerService>;
 
 /** @public */
-export declare const urlReaderFactory: () => ServiceFactory<UrlReader>;
+export declare const urlReaderServiceFactory: () => ServiceFactory<UrlReader>;
 
 /**
  * A {@link @backstage/backend-plugin-api#LoggerService} implementation based on winston.
@@ -459,11 +455,11 @@ export declare class WinstonLogger implements RootLoggerService {
      */
     static colorFormat(): Format;
     private constructor();
-    error(message: string, meta?: LogMeta): void;
-    warn(message: string, meta?: LogMeta): void;
-    info(message: string, meta?: LogMeta): void;
-    debug(message: string, meta?: LogMeta): void;
-    child(meta: LogMeta): LoggerService;
+    error(message: string, meta?: JsonObject): void;
+    warn(message: string, meta?: JsonObject): void;
+    info(message: string, meta?: JsonObject): void;
+    debug(message: string, meta?: JsonObject): void;
+    child(meta: JsonObject): LoggerService;
     addRedactions(redactions: Iterable<string>): void;
 }
 
@@ -471,7 +467,7 @@ export declare class WinstonLogger implements RootLoggerService {
  * @public
  */
 export declare interface WinstonLoggerOptions {
-    meta?: LogMeta;
+    meta?: JsonObject;
     level: string;
     format: Format;
     transports: transport[];

package/dist/index.beta.d.ts

@@ -12,17 +12,16 @@ import { ConfigService } from '@backstage/backend-plugin-api';
 import { CorsOptions } from 'cors';
 import { ErrorRequestHandler } from 'express';
 import { Express as Express_2 } from 'express';
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
 import { Format } from 'logform';
 import { Handler } from 'express';
 import { HelmetOptions } from 'helmet';
 import * as http from 'http';
 import { HttpRouterService } from '@backstage/backend-plugin-api';
 import { IdentityService } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
 import { LifecycleService } from '@backstage/backend-plugin-api';
 import { LoadConfigOptionsRemote } from '@backstage/config-loader';
 import { LoggerService } from '@backstage/backend-plugin-api';
-import { LogMeta } from '@backstage/backend-plugin-api';
 import { PermissionsService } from '@backstage/backend-plugin-api';
 import { PluginCacheManager } from '@backstage/backend-common';
 import { PluginDatabaseManager } from '@backstage/backend-common';
@@ -35,7 +34,6 @@ import { RootLoggerService } from '@backstage/backend-plugin-api';
 import { SchedulerService } from '@backstage/backend-plugin-api';
 import { ServiceFactory } from '@backstage/backend-plugin-api';
 import { ServiceFactoryOrFunction } from '@backstage/backend-plugin-api';
-import { ServiceRef } from '@backstage/backend-plugin-api';
 import { TokenManagerService } from '@backstage/backend-plugin-api';
 import { transport } from 'winston';
 import { UrlReader } from '@backstage/backend-common';
@@ -50,10 +48,7 @@ export declare interface Backend {
 }
 
 /** @public */
-export declare const cacheFactory: () => ServiceFactory<PluginCacheManager>;
-
-/** @public */
-export declare const configFactory: () => ServiceFactory<ConfigService>;
+export declare const cacheServiceFactory: () => ServiceFactory<PluginCacheManager>;
 
 /** @public */
 export declare interface ConfigFactoryOptions {
@@ -67,6 +62,9 @@ export declare interface ConfigFactoryOptions {
     remote?: LoadConfigOptionsRemote;
 }
 
+/** @public */
+export declare const configServiceFactory: (options?: ConfigFactoryOptions | undefined) => ServiceFactory<ConfigService>;
+
 /** @public */
 export declare function createConfigSecretEnumerator(options: {
     logger: LoggerService;
@@ -95,7 +93,7 @@ export declare interface CreateSpecializedBackendOptions {
 }
 
 /** @public */
-export declare const databaseFactory: () => ServiceFactory<PluginDatabaseManager>;
+export declare const databaseServiceFactory: () => ServiceFactory<PluginDatabaseManager>;
 
 /**
  * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
@@ -125,7 +123,7 @@ export declare interface DefaultRootHttpRouterOptions {
 }
 
 /** @public */
-export declare const discoveryFactory: () => ServiceFactory<PluginEndpointDiscovery>;
+export declare const discoveryServiceFactory: () => ServiceFactory<PluginEndpointDiscovery>;
 
 /**
  * An HTTP server extended with utility methods.
@@ -138,9 +136,6 @@ export declare interface ExtendedHttpServer extends http.Server {
     port(): number;
 }
 
-/** @public */
-export declare const httpRouterFactory: (options?: HttpRouterFactoryOptions | undefined) => ServiceFactory<HttpRouterService>;
-
 /**
  * @public
  */
@@ -151,13 +146,16 @@ export declare interface HttpRouterFactoryOptions {
     getPath?(pluginId: string): string;
 }
 
+/** @public */
+export declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions | undefined) => ServiceFactory<HttpRouterService>;
+
 /**
  * Options for configuring HTTPS for an HTTP server.
  *
  * @public
  */
 export declare type HttpServerCertificateOptions = {
-    type: 'plain';
+    type: 'pem';
     key: string;
     cert: string;
 } | {
@@ -180,9 +178,6 @@ export declare type HttpServerOptions = {
     };
 };
 
-/** @public */
-export declare const identityFactory: (options?: IdentityFactoryOptions | undefined) => ServiceFactory<IdentityService>;
-
 /**
  * An identity client options object which allows extra configurations
  *
@@ -195,10 +190,14 @@ export declare type IdentityFactoryOptions = {
     algorithms?: string[];
 };
 
+/** @public */
+export declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefined) => ServiceFactory<IdentityService>;
+
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- * @public */
-export declare const lifecycleFactory: () => ServiceFactory<LifecycleService>;
+ * @public
+ */
+export declare const lifecycleServiceFactory: () => ServiceFactory<LifecycleService>;
 
 /**
  * Load configuration for a Backend.
@@ -215,7 +214,7 @@ export declare function loadBackendConfig(options: {
 }>;
 
 /** @public */
-export declare const loggerFactory: () => ServiceFactory<LoggerService>;
+export declare const loggerServiceFactory: () => ServiceFactory<LoggerService>;
 
 /**
  * A utility to configure common middleware.
@@ -341,7 +340,7 @@ export declare interface MiddlewareFactoryOptions {
 }
 
 /** @public */
-export declare const permissionsFactory: () => ServiceFactory<PermissionsService>;
+export declare const permissionsServiceFactory: () => ServiceFactory<PermissionsService>;
 
 /**
  * Attempts to read a CORS options object from the backend configuration object.
@@ -390,7 +389,7 @@ export declare function readHttpServerOptions(config?: Config): HttpServerOption
 /**
  * @public
  */
-export declare interface RootHttpRouterConfigureOptions {
+export declare interface RootHttpRouterConfigureContext {
     app: Express_2;
     middleware: MiddlewareFactory;
     routes: RequestHandler;
@@ -399,9 +398,6 @@ export declare interface RootHttpRouterConfigureOptions {
     lifecycle: LifecycleService;
 }
 
-/** @public */
-export declare const rootHttpRouterFactory: () => ServiceFactory<RootHttpRouterService>;
-
 /**
  * @public
  */
@@ -411,30 +407,30 @@ export declare type RootHttpRouterFactoryOptions = {
      * not given. Disables index path behavior if false is given.
      */
     indexPath?: string | false;
-    configure?(options: RootHttpRouterConfigureOptions): void;
+    configure?(context: RootHttpRouterConfigureContext): void;
 };
 
+/** @public */
+export declare const rootHttpRouterServiceFactory: (options?: RootHttpRouterFactoryOptions | undefined) => ServiceFactory<RootHttpRouterService>;
+
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- * @public */
-export declare const rootLifecycleFactory: () => ServiceFactory<RootLifecycleService>;
+ *
+ * @public
+ */
+export declare const rootLifecycleServiceFactory: () => ServiceFactory<RootLifecycleService>;
 
 /** @public */
-export declare const rootLoggerFactory: () => ServiceFactory<RootLoggerService>;
+export declare const rootLoggerServiceFactory: () => ServiceFactory<RootLoggerService>;
 
 /** @public */
-export declare const schedulerFactory: () => ServiceFactory<SchedulerService>;
-
-/**
- * @public
- */
-export declare type ServiceOrExtensionPoint<T = unknown> = ExtensionPoint<T> | ServiceRef<T>;
+export declare const schedulerServiceFactory: () => ServiceFactory<SchedulerService>;
 
 /** @public */
-export declare const tokenManagerFactory: () => ServiceFactory<TokenManagerService>;
+export declare const tokenManagerServiceFactory: () => ServiceFactory<TokenManagerService>;
 
 /** @public */
-export declare const urlReaderFactory: () => ServiceFactory<UrlReader>;
+export declare const urlReaderServiceFactory: () => ServiceFactory<UrlReader>;
 
 /**
  * A {@link @backstage/backend-plugin-api#LoggerService} implementation based on winston.
@@ -459,11 +455,11 @@ export declare class WinstonLogger implements RootLoggerService {
      */
     static colorFormat(): Format;
     private constructor();
-    error(message: string, meta?: LogMeta): void;
-    warn(message: string, meta?: LogMeta): void;
-    info(message: string, meta?: LogMeta): void;
-    debug(message: string, meta?: LogMeta): void;
-    child(meta: LogMeta): LoggerService;
+    error(message: string, meta?: JsonObject): void;
+    warn(message: string, meta?: JsonObject): void;
+    info(message: string, meta?: JsonObject): void;
+    debug(message: string, meta?: JsonObject): void;
+    child(meta: JsonObject): LoggerService;
     addRedactions(redactions: Iterable<string>): void;
 }
 
@@ -471,7 +467,7 @@ export declare class WinstonLogger implements RootLoggerService {
  * @public
  */
 export declare interface WinstonLoggerOptions {
-    meta?: LogMeta;
+    meta?: JsonObject;
     level: string;
     format: Format;
     transports: transport[];