@backstage/backend-app-api 0.4.3 → 0.4.4-next.1

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { RequestListener } from 'http';
 import { RequestHandler, ErrorRequestHandler, Express, Handler } from 'express';
 import { CorsOptions } from 'cors';
 import { HelmetOptions } from 'helmet';
-import { JsonObject } from '@backstage/types';
+import { JsonObject, HumanDuration } from '@backstage/types';
 import { Format } from 'logform';
 import { transport } from 'winston';
 import * as _backstage_backend_common from '@backstage/backend-common';
@@ -340,6 +340,35 @@ interface HttpRouterFactoryOptions {
 /** @public */
 declare const httpRouterServiceFactory: (options?: HttpRouterFactoryOptions | undefined) => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.HttpRouterService, "plugin">;
 
+/**
+ * Options for {@link createLifecycleMiddleware}.
+ * @public
+ */
+interface LifecycleMiddlewareOptions {
+    lifecycle: LifecycleService;
+    /**
+     * The maximum time that paused requests will wait for the service to start, before returning an error.
+     *
+     * Defaults to 5 seconds.
+     */
+    startupRequestPauseTimeout?: HumanDuration;
+}
+/**
+ * Creates a middleware that pauses requests until the service has started.
+ *
+ * @remarks
+ *
+ * Requests that arrive before the service has started will be paused until startup is complete.
+ * If the service does not start within the provided timeout, the request will be rejected with a
+ * {@link @backstage/errors#ServiceUnavailableError}.
+ *
+ * If the service is shutting down, all requests will be rejected with a
+ * {@link @backstage/errors#ServiceUnavailableError}.
+ *
+ * @public
+ */
+declare function createLifecycleMiddleware(options: LifecycleMiddlewareOptions): RequestHandler;
+
 /**
  * An identity client options object which allows extra configurations
  *
@@ -358,7 +387,7 @@ declare const identityServiceFactory: (options?: IdentityFactoryOptions | undefi
  * 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">;
+declare const lifecycleServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<LifecycleService, "plugin">;
 
 /** @public */
 declare const loggerServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.LoggerService, "plugin">;
@@ -436,4 +465,4 @@ declare const tokenManagerServiceFactory: () => _backstage_backend_plugin_api.Se
 /** @public */
 declare const urlReaderServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.UrlReader, "plugin">;
 
-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 };
+export { Backend, ConfigFactoryOptions, CreateSpecializedBackendOptions, DefaultRootHttpRouter, DefaultRootHttpRouterOptions, ExtendedHttpServer, HttpRouterFactoryOptions, HttpServerCertificateOptions, HttpServerOptions, IdentityFactoryOptions, LifecycleMiddlewareOptions, MiddlewareFactory, MiddlewareFactoryErrorOptions, MiddlewareFactoryOptions, RootHttpRouterConfigureContext, RootHttpRouterFactoryOptions, WinstonLogger, WinstonLoggerOptions, cacheServiceFactory, configServiceFactory, createConfigSecretEnumerator, createHttpServer, createLifecycleMiddleware, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootHttpRouterServiceFactory, rootLifecycleServiceFactory, rootLoggerServiceFactory, schedulerServiceFactory, tokenManagerServiceFactory, urlReaderServiceFactory };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-app-api",
   "description": "Core API used by Backstage backend apps",
-  "version": "0.4.3",
+  "version": "0.4.4-next.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -32,15 +32,15 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.5",
-    "@backstage/backend-plugin-api": "^0.5.2",
-    "@backstage/backend-tasks": "^0.5.2",
+    "@backstage/backend-common": "^0.19.0-next.1",
+    "@backstage/backend-plugin-api": "^0.5.3-next.1",
+    "@backstage/backend-tasks": "^0.5.3-next.1",
     "@backstage/cli-common": "^0.1.12",
     "@backstage/config": "^1.0.7",
-    "@backstage/config-loader": "^1.3.0",
-    "@backstage/errors": "^1.1.5",
-    "@backstage/plugin-auth-node": "^0.2.14",
-    "@backstage/plugin-permission-node": "^0.7.8",
+    "@backstage/config-loader": "^1.3.1-next.1",
+    "@backstage/errors": "^1.2.0-next.0",
+    "@backstage/plugin-auth-node": "^0.2.15-next.1",
+    "@backstage/plugin-permission-node": "^0.7.9-next.1",
     "@backstage/types": "^1.0.2",
     "@manypkg/get-packages": "^1.1.3",
     "@types/cors": "^2.8.6",
@@ -63,8 +63,8 @@
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.37",
-    "@backstage/cli": "^0.22.7",
+    "@backstage/backend-test-utils": "^0.1.38-next.1",
+    "@backstage/cli": "^0.22.8-next.1",
     "@types/compression": "^1.7.0",
     "@types/fs-extra": "^9.0.3",
     "@types/http-errors": "^2.0.0",