@backstage/backend-app-api 0.7.6 → 0.7.8

package/dist/index.d.ts

@@ -3,9 +3,9 @@ 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 { Config, AppConfig } from '@backstage/config';
 import { ConfigSchema, LoadConfigOptionsRemote, RemoteConfigSourceOptions } from '@backstage/config-loader';
+import { RequestHandler, ErrorRequestHandler, Express, Handler } from 'express';
 import * as http from 'http';
 import { RequestListener } from 'http';
-import { RequestHandler, ErrorRequestHandler, Express, Handler } from 'express';
 import { CorsOptions } from 'cors';
 import { HelmetOptions } from 'helmet';
 import { JsonObject, HumanDuration } from '@backstage/types';
@@ -278,7 +278,93 @@ declare const readHelmetOptions: typeof readHelmetOptions$1;
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.
  */
-declare const MiddlewareFactory: typeof MiddlewareFactory$1;
+declare class MiddlewareFactory {
+    private readonly impl;
+    /**
+     * Creates a new {@link MiddlewareFactory}.
+     */
+    static create(options: MiddlewareFactoryOptions): MiddlewareFactory;
+    private constructor();
+    /**
+     * Returns a middleware that unconditionally produces a 404 error response.
+     *
+     * @remarks
+     *
+     * Typically you want to place this middleware at the end of the chain, such
+     * that it's the last one attempted after no other routes matched.
+     *
+     * @returns An Express request handler
+     */
+    notFound(): RequestHandler;
+    /**
+     * Returns the compression middleware.
+     *
+     * @remarks
+     *
+     * The middleware will attempt to compress response bodies for all requests
+     * that traverse through the middleware.
+     */
+    compression(): RequestHandler;
+    /**
+     * Returns a request logging middleware.
+     *
+     * @remarks
+     *
+     * Typically you want to place this middleware at the start of the chain, such
+     * that it always logs requests whether they are "caught" by handlers farther
+     * down or not.
+     *
+     * @returns An Express request handler
+     */
+    logging(): RequestHandler;
+    /**
+     * Returns a middleware that implements the helmet library.
+     *
+     * @remarks
+     *
+     * This middleware applies security policies to incoming requests and outgoing
+     * responses. It is configured using config keys such as `backend.csp`.
+     *
+     * @see {@link https://helmetjs.github.io/}
+     *
+     * @returns An Express request handler
+     */
+    helmet(): RequestHandler;
+    /**
+     * Returns a middleware that implements the cors library.
+     *
+     * @remarks
+     *
+     * This middleware handles CORS. It is configured using the config key
+     * `backend.cors`.
+     *
+     * @see {@link https://github.com/expressjs/cors}
+     *
+     * @returns An Express request handler
+     */
+    cors(): RequestHandler;
+    /**
+     * Express middleware to handle errors during request processing.
+     *
+     * @remarks
+     *
+     * This is commonly the very last middleware in the chain.
+     *
+     * Its primary purpose is not to do translation of business logic exceptions,
+     * but rather to be a global catch-all for uncaught "fatal" errors that are
+     * expected to result in a 500 error. However, it also does handle some common
+     * error types (such as http-error exceptions, and the well-known error types
+     * in the `@backstage/errors` package) and returns the enclosed status code
+     * accordingly.
+     *
+     * It will also produce a response body with a serialized form of the error,
+     * unless a previous handler already did send a body. See
+     * {@link @backstage/errors#ErrorResponseBody} for the response shape used.
+     *
+     * @returns An Express error request handler
+     */
+    error(options?: MiddlewareFactoryErrorOptions): ErrorRequestHandler;
+}
 /**
  * @public
  * @deprecated Please import from `@backstage/backend-defaults/rootHttpRouter` instead.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-app-api",
-  "version": "0.7.6",
+  "version": "0.7.8",
   "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.0",
-    "@backstage/backend-plugin-api": "^0.6.19",
-    "@backstage/backend-tasks": "^0.5.24",
+    "@backstage/backend-common": "^0.23.1",
+    "@backstage/backend-plugin-api": "^0.6.20",
+    "@backstage/backend-tasks": "^0.5.25",
     "@backstage/cli-common": "^0.1.14",
     "@backstage/cli-node": "^0.2.6",
     "@backstage/config": "^1.2.0",
     "@backstage/config-loader": "^1.8.1",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.14",
-    "@backstage/plugin-permission-node": "^0.7.30",
+    "@backstage/plugin-auth-node": "^0.4.15",
+    "@backstage/plugin-permission-node": "^0.7.31",
     "@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.0",
-    "@backstage/backend-test-utils": "^0.4.0",
-    "@backstage/cli": "^0.26.7",
+    "@backstage/backend-defaults": "^0.3.2",
+    "@backstage/backend-test-utils": "^0.4.2",
+    "@backstage/cli": "^0.26.9",
     "@types/compression": "^1.7.0",
     "@types/fs-extra": "^11.0.0",
     "@types/http-errors": "^2.0.0",