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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/backend-app-api
 
+## 0.4.1-next.0
+
+### Patch Changes
+
+- 928a12a9b3: Internal refactor of `/alpha` exports.
+- Updated dependencies
+  - @backstage/backend-tasks@0.4.4-next.0
+  - @backstage/backend-plugin-api@0.4.1-next.0
+  - @backstage/backend-common@0.18.3-next.0
+  - @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.12-next.0
+  - @backstage/plugin-permission-node@0.7.6-next.0
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,160 +1,67 @@
-/**
- * Core API used by Backstage backend apps.
- *
- * @packageDocumentation
- */
-
 /// <reference types="node" />
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
-import { CacheClient } from '@backstage/backend-common';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService, ConfigService, RootLoggerService, BackendFeature, ServiceFactoryOrFunction, LifecycleService, RootHttpRouterService, RootLifecycleService } from '@backstage/backend-plugin-api';
+import { LoadConfigOptionsRemote } from '@backstage/config-loader';
 import { Config } from '@backstage/config';
-import { ConfigService } from '@backstage/backend-plugin-api';
+import * as http from 'http';
+import { RequestListener } from 'http';
+import { RequestHandler, ErrorRequestHandler, Express, Handler } from 'express';
 import { CorsOptions } from 'cors';
-import { ErrorRequestHandler } from 'express';
-import { Express as Express_2 } from 'express';
-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 { PermissionsService } from '@backstage/backend-plugin-api';
-import { PluginDatabaseManager } from '@backstage/backend-common';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { RequestHandler } from 'express';
-import { RequestListener } from 'http';
-import { RootHttpRouterService } from '@backstage/backend-plugin-api';
-import { RootLifecycleService } from '@backstage/backend-plugin-api';
-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 { TokenManagerService } from '@backstage/backend-plugin-api';
+import { Format } from 'logform';
 import { transport } from 'winston';
-import { UrlReader } from '@backstage/backend-common';
-
-/**
- * @public
- */
-export declare interface Backend {
-    add(feature: BackendFeature): void;
-    start(): Promise<void>;
-    stop(): Promise<void>;
-}
-
-/** @public */
-export declare const cacheServiceFactory: () => ServiceFactory<CacheClient, "plugin">;
+import * as _backstage_backend_common from '@backstage/backend-common';
 
 /** @public */
-export declare interface ConfigFactoryOptions {
-    /**
-     * Process arguments to use instead of the default `process.argv()`.
-     */
-    argv?: string[];
-    /**
-     * Enables and sets options for remote configuration loading.
-     */
-    remote?: LoadConfigOptionsRemote;
-}
-
-/** @public */
-export declare const configServiceFactory: (options?: ConfigFactoryOptions | undefined) => ServiceFactory<ConfigService, "root">;
-
-/** @public */
-export declare function createConfigSecretEnumerator(options: {
+declare function createConfigSecretEnumerator(options: {
     logger: LoggerService;
     dir?: string;
 }): Promise<(config: Config) => Iterable<string>>;
-
 /**
- * Creates a Node.js HTTP or HTTPS server instance.
- *
- * @public
- */
-export declare function createHttpServer(listener: RequestListener, options: HttpServerOptions, deps: {
-    logger: LoggerService;
-}): Promise<ExtendedHttpServer>;
-
-/**
- * @public
- */
-export declare function createSpecializedBackend(options: CreateSpecializedBackendOptions): Backend;
-
-/**
- * @public
- */
-export declare interface CreateSpecializedBackendOptions {
-    services: ServiceFactoryOrFunction[];
-}
-
-/** @public */
-export declare const databaseServiceFactory: () => ServiceFactory<PluginDatabaseManager, "plugin">;
-
-/**
- * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
- * {@link @backstage/backend-plugin-api#coreServices.rootHttpRouter}.
+ * Load configuration for a Backend.
  *
- * @public
- */
-export declare class DefaultRootHttpRouter implements RootHttpRouterService {
-    #private;
-    static create(options?: DefaultRootHttpRouterOptions): DefaultRootHttpRouter;
-    private constructor();
-    use(path: string, handler: Handler): void;
-    handler(): Handler;
-}
-
-/**
- * Options for the {@link DefaultRootHttpRouter} class.
+ * This function should only be called once, during the initialization of the backend.
  *
  * @public
  */
-export declare interface DefaultRootHttpRouterOptions {
-    /**
-     * The path to forward all unmatched requests to. Defaults to '/api/app' if
-     * not given. Disables index path behavior if false is given.
-     */
-    indexPath?: string | false;
-}
-
-/** @public */
-export declare const discoveryServiceFactory: () => ServiceFactory<PluginEndpointDiscovery, "plugin">;
+declare function loadBackendConfig(options: {
+    remote?: LoadConfigOptionsRemote;
+    argv: string[];
+}): Promise<{
+    config: Config;
+}>;
 
 /**
  * An HTTP server extended with utility methods.
  *
  * @public
  */
-export declare interface ExtendedHttpServer extends http.Server {
+interface ExtendedHttpServer extends http.Server {
     start(): Promise<void>;
     stop(): Promise<void>;
     port(): number;
 }
-
 /**
+ * Options for starting up an HTTP server.
+ *
  * @public
  */
-export declare interface HttpRouterFactoryOptions {
-    /**
-     * A callback used to generate the path for each plugin, defaults to `/api/{pluginId}`.
-     */
-    getPath?(pluginId: string): string;
-}
-
-/** @public */
-export declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions | undefined) => ServiceFactory<HttpRouterService, "plugin">;
-
+declare type HttpServerOptions = {
+    listen: {
+        port: number;
+        host: string;
+    };
+    https?: {
+        certificate: HttpServerCertificateOptions;
+    };
+};
 /**
  * Options for configuring HTTPS for an HTTP server.
  *
  * @public
  */
-export declare type HttpServerCertificateOptions = {
+declare type HttpServerCertificateOptions = {
     type: 'pem';
     key: string;
     cert: string;
@@ -164,64 +71,64 @@ export declare type HttpServerCertificateOptions = {
 };
 
 /**
- * Options for starting up an HTTP server.
+ * Reads {@link HttpServerOptions} from a {@link @backstage/config#Config} object.
  *
  * @public
+ * @remarks
+ *
+ * The provided configuration object should contain the `listen` and
+ * additional keys directly.
+ *
+ * @example
+ * ```ts
+ * const opts = readHttpServerOptions(config.getConfig('backend'));
+ * ```
  */
-export declare type HttpServerOptions = {
-    listen: {
-        port: number;
-        host: string;
-    };
-    https?: {
-        certificate: HttpServerCertificateOptions;
-    };
-};
+declare function readHttpServerOptions(config?: Config): HttpServerOptions;
 
 /**
- * An identity client options object which allows extra configurations
+ * Creates a Node.js HTTP or HTTPS server instance.
  *
  * @public
  */
-export declare type IdentityFactoryOptions = {
-    issuer?: string;
-    /** JWS "alg" (Algorithm) Header Parameter values. Defaults to an array containing just ES256.
-     * More info on supported algorithms: https://github.com/panva/jose */
-    algorithms?: string[];
-};
-
-/** @public */
-export declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefined) => ServiceFactory<IdentityService, "plugin">;
+declare function createHttpServer(listener: RequestListener, options: HttpServerOptions, deps: {
+    logger: LoggerService;
+}): Promise<ExtendedHttpServer>;
 
 /**
- * Allows plugins to register shutdown hooks that are run when the process is about to exit.
+ * Options used to create a {@link MiddlewareFactory}.
+ *
  * @public
  */
-export declare const lifecycleServiceFactory: () => ServiceFactory<LifecycleService, "plugin">;
-
+interface MiddlewareFactoryOptions {
+    config: ConfigService;
+    logger: LoggerService;
+}
 /**
- * Load configuration for a Backend.
- *
- * This function should only be called once, during the initialization of the backend.
+ * Options passed to the {@link MiddlewareFactory.error} middleware.
  *
  * @public
  */
-export declare function loadBackendConfig(options: {
-    remote?: LoadConfigOptionsRemote;
-    argv: string[];
-}): Promise<{
-    config: Config;
-}>;
-
-/** @public */
-export declare const loggerServiceFactory: () => ServiceFactory<LoggerService, "plugin">;
-
+interface MiddlewareFactoryErrorOptions {
+    /**
+     * Whether error response bodies should show error stack traces or not.
+     *
+     * If not specified, by default shows stack traces only in development mode.
+     */
+    showStackTraces?: boolean;
+    /**
+     * Whether any 4xx errors should be logged or not.
+     *
+     * If not specified, default to only logging 5xx errors.
+     */
+    logAllErrors?: boolean;
+}
 /**
  * A utility to configure common middleware.
  *
  * @public
  */
-export declare class MiddlewareFactory {
+declare class MiddlewareFactory {
     #private;
     /**
      * Creates a new {@link MiddlewareFactory}.
@@ -309,39 +216,6 @@ export declare class MiddlewareFactory {
     error(options?: MiddlewareFactoryErrorOptions): ErrorRequestHandler;
 }
 
-/**
- * Options passed to the {@link MiddlewareFactory.error} middleware.
- *
- * @public
- */
-export declare interface MiddlewareFactoryErrorOptions {
-    /**
-     * Whether error response bodies should show error stack traces or not.
-     *
-     * If not specified, by default shows stack traces only in development mode.
-     */
-    showStackTraces?: boolean;
-    /**
-     * Whether any 4xx errors should be logged or not.
-     *
-     * If not specified, default to only logging 5xx errors.
-     */
-    logAllErrors?: boolean;
-}
-
-/**
- * Options used to create a {@link MiddlewareFactory}.
- *
- * @public
- */
-export declare interface MiddlewareFactoryOptions {
-    config: ConfigService;
-    logger: LoggerService;
-}
-
-/** @public */
-export declare const permissionsServiceFactory: () => ServiceFactory<PermissionsService, "plugin">;
-
 /**
  * Attempts to read a CORS options object from the backend configuration object.
  *
@@ -354,7 +228,7 @@ export declare const permissionsServiceFactory: () => ServiceFactory<Permissions
  * const corsOptions = readCorsOptions(config.getConfig('backend'));
  * ```
  */
-export declare function readCorsOptions(config?: Config): CorsOptions;
+declare function readCorsOptions(config?: Config): CorsOptions;
 
 /**
  * Attempts to read Helmet options from the backend configuration object.
@@ -368,109 +242,197 @@ export declare function readCorsOptions(config?: Config): CorsOptions;
  * const helmetOptions = readHelmetOptions(config.getConfig('backend'));
  * ```
  */
-export declare function readHelmetOptions(config?: Config): HelmetOptions;
+declare function readHelmetOptions(config?: Config): HelmetOptions;
 
 /**
- * Reads {@link HttpServerOptions} from a {@link @backstage/config#Config} object.
- *
  * @public
- * @remarks
- *
- * The provided configuration object should contain the `listen` and
- * additional keys directly.
+ */
+interface WinstonLoggerOptions {
+    meta?: JsonObject;
+    level: string;
+    format: Format;
+    transports: transport[];
+}
+/**
+ * A {@link @backstage/backend-plugin-api#LoggerService} implementation based on winston.
  *
- * @example
- * ```ts
- * const opts = readHttpServerOptions(config.getConfig('backend'));
- * ```
+ * @public
  */
-export declare function readHttpServerOptions(config?: Config): HttpServerOptions;
+declare class WinstonLogger implements RootLoggerService {
+    #private;
+    /**
+     * Creates a {@link WinstonLogger} instance.
+     */
+    static create(options: WinstonLoggerOptions): WinstonLogger;
+    /**
+     * Creates a winston log formatter for redacting secrets.
+     */
+    static redacter(): {
+        format: Format;
+        add: (redactions: Iterable<string>) => void;
+    };
+    /**
+     * Creates a pretty printed winston log formatter.
+     */
+    static colorFormat(): Format;
+    private constructor();
+    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;
+}
 
 /**
  * @public
  */
-export declare interface RootHttpRouterConfigureContext {
-    app: Express_2;
-    middleware: MiddlewareFactory;
-    routes: RequestHandler;
-    config: ConfigService;
-    logger: LoggerService;
-    lifecycle: LifecycleService;
+interface Backend {
+    add(feature: BackendFeature): void;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+}
+/**
+ * @public
+ */
+interface CreateSpecializedBackendOptions {
+    services: ServiceFactoryOrFunction[];
 }
 
 /**
  * @public
  */
-export declare type RootHttpRouterFactoryOptions = {
+declare function createSpecializedBackend(options: CreateSpecializedBackendOptions): Backend;
+
+/** @public */
+declare const cacheServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.CacheClient, "plugin">;
+
+/** @public */
+interface ConfigFactoryOptions {
     /**
-     * The path to forward all unmatched requests to. Defaults to '/api/app' if
-     * not given. Disables index path behavior if false is given.
+     * Process arguments to use instead of the default `process.argv()`.
      */
-    indexPath?: string | false;
-    configure?(context: RootHttpRouterConfigureContext): void;
-};
+    argv?: string[];
+    /**
+     * Enables and sets options for remote configuration loading.
+     */
+    remote?: LoadConfigOptionsRemote;
+}
+/** @public */
+declare const configServiceFactory: (options?: ConfigFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.ConfigService, "root">;
+
+/** @public */
+declare const databaseServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.PluginDatabaseManager, "plugin">;
 
 /** @public */
-export declare const rootHttpRouterServiceFactory: (options?: RootHttpRouterFactoryOptions | undefined) => ServiceFactory<RootHttpRouterService, "root">;
+declare const discoveryServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.PluginEndpointDiscovery, "plugin">;
 
 /**
- * Allows plugins to register shutdown hooks that are run when the process is about to exit.
- *
  * @public
  */
-export declare const rootLifecycleServiceFactory: () => ServiceFactory<RootLifecycleService, "root">;
-
+interface HttpRouterFactoryOptions {
+    /**
+     * A callback used to generate the path for each plugin, defaults to `/api/{pluginId}`.
+     */
+    getPath?(pluginId: string): string;
+}
 /** @public */
-export declare const rootLoggerServiceFactory: () => ServiceFactory<RootLoggerService, "root">;
+declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.HttpRouterService, "plugin">;
 
+/**
+ * An identity client options object which allows extra configurations
+ *
+ * @public
+ */
+declare type IdentityFactoryOptions = {
+    issuer?: string;
+    /** JWS "alg" (Algorithm) Header Parameter values. Defaults to an array containing just ES256.
+     * More info on supported algorithms: https://github.com/panva/jose */
+    algorithms?: string[];
+};
 /** @public */
-export declare const schedulerServiceFactory: () => ServiceFactory<SchedulerService, "plugin">;
+declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.IdentityService, "plugin">;
+
+/**
+ * Allows plugins to register shutdown hooks that are run when the process is about to exit.
+ * @public
+ */
+declare const lifecycleServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.LifecycleService, "plugin">;
 
 /** @public */
-export declare const tokenManagerServiceFactory: () => ServiceFactory<TokenManagerService, "plugin">;
+declare const loggerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.LoggerService, "plugin">;
 
 /** @public */
-export declare const urlReaderServiceFactory: () => ServiceFactory<UrlReader, "plugin">;
+declare const permissionsServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.PermissionsService, "plugin">;
 
 /**
- * A {@link @backstage/backend-plugin-api#LoggerService} implementation based on winston.
- *
  * @public
  */
-export declare class WinstonLogger implements RootLoggerService {
-    #private;
-    /**
-     * Creates a {@link WinstonLogger} instance.
-     */
-    static create(options: WinstonLoggerOptions): WinstonLogger;
+interface RootHttpRouterConfigureContext {
+    app: Express;
+    middleware: MiddlewareFactory;
+    routes: RequestHandler;
+    config: ConfigService;
+    logger: LoggerService;
+    lifecycle: LifecycleService;
+}
+/**
+ * @public
+ */
+declare type RootHttpRouterFactoryOptions = {
     /**
-     * Creates a winston log formatter for redacting secrets.
+     * The path to forward all unmatched requests to. Defaults to '/api/app' if
+     * not given. Disables index path behavior if false is given.
      */
-    static redacter(): {
-        format: Format;
-        add: (redactions: Iterable<string>) => void;
-    };
+    indexPath?: string | false;
+    configure?(context: RootHttpRouterConfigureContext): void;
+};
+/** @public */
+declare const rootHttpRouterServiceFactory: (options?: RootHttpRouterFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootHttpRouterService, "root">;
+
+/**
+ * Options for the {@link DefaultRootHttpRouter} class.
+ *
+ * @public
+ */
+interface DefaultRootHttpRouterOptions {
     /**
-     * Creates a pretty printed winston log formatter.
+     * The path to forward all unmatched requests to. Defaults to '/api/app' if
+     * not given. Disables index path behavior if false is given.
      */
-    static colorFormat(): Format;
+    indexPath?: string | false;
+}
+/**
+ * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
+ * {@link @backstage/backend-plugin-api#coreServices.rootHttpRouter}.
+ *
+ * @public
+ */
+declare class DefaultRootHttpRouter implements RootHttpRouterService {
+    #private;
+    static create(options?: DefaultRootHttpRouterOptions): DefaultRootHttpRouter;
     private constructor();
-    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;
+    use(path: string, handler: Handler): void;
+    handler(): Handler;
 }
 
 /**
+ * Allows plugins to register shutdown hooks that are run when the process is about to exit.
+ *
  * @public
  */
-export declare interface WinstonLoggerOptions {
-    meta?: JsonObject;
-    level: string;
-    format: Format;
-    transports: transport[];
-}
+declare const rootLifecycleServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<RootLifecycleService, "root">;
+
+/** @public */
+declare const rootLoggerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootLoggerService, "root">;
+
+/** @public */
+declare const schedulerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.SchedulerService, "plugin">;
+
+/** @public */
+declare const tokenManagerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.TokenManagerService, "plugin">;
+
+/** @public */
+declare const urlReaderServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.UrlReader, "plugin">;
 
-export { }
+export { Backend, ConfigFactoryOptions, CreateSpecializedBackendOptions, DefaultRootHttpRouter, DefaultRootHttpRouterOptions, ExtendedHttpServer, HttpRouterFactoryOptions, HttpServerCertificateOptions, HttpServerOptions, IdentityFactoryOptions, MiddlewareFactory, MiddlewareFactoryErrorOptions, MiddlewareFactoryOptions, RootHttpRouterConfigureContext, RootHttpRouterFactoryOptions, WinstonLogger, WinstonLoggerOptions, cacheServiceFactory, configServiceFactory, createConfigSecretEnumerator, createHttpServer, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootHttpRouterServiceFactory, rootLifecycleServiceFactory, rootLoggerServiceFactory, schedulerServiceFactory, tokenManagerServiceFactory, urlReaderServiceFactory };