@backstage/backend-app-api 0.5.5 → 0.5.6

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, LifecycleService, RootHttpRouterService, RootLifecycleService } from '@backstage/backend-plugin-api';
+import { LoggerService, RootConfigService, RootLoggerService, BackendFeature, ServiceFactoryOrFunction, DiscoveryService, LifecycleService, RootHttpRouterService, RootLifecycleService } from '@backstage/backend-plugin-api';
 import { LoadConfigOptionsRemote, RemoteConfigSourceOptions } from '@backstage/config-loader';
 import { Config, AppConfig } from '@backstage/config';
 import * as http from 'http';
@@ -29,6 +29,7 @@ declare function loadBackendConfig(options: {
     remote?: LoadConfigOptionsRemote;
     argv: string[];
     additionalConfigs?: AppConfig[];
+    watch?: boolean;
 }): Promise<{
     config: Config;
 }>;
@@ -328,7 +329,54 @@ declare const rootConfigServiceFactory: (options?: RootConfigFactoryOptions | un
 declare const databaseServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.PluginDatabaseManager, "plugin">;
 
 /** @public */
-declare const discoveryServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_common.PluginEndpointDiscovery, "plugin">;
+declare const discoveryServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.DiscoveryService, "plugin">;
+
+/**
+ * HostDiscovery is a basic PluginEndpointDiscovery implementation
+ * that can handle plugins that are hosted in a single or multiple deployments.
+ *
+ * The deployment may be scaled horizontally, as long as the external URL
+ * is the same for all instances. However, internal URLs will always be
+ * resolved to the same host, so there won't be any balancing of internal traffic.
+ *
+ * @public
+ */
+declare class HostDiscovery implements DiscoveryService {
+    private readonly internalBaseUrl;
+    private readonly externalBaseUrl;
+    private readonly discoveryConfig;
+    /**
+     * Creates a new HostDiscovery discovery instance by reading
+     * from the `backend` config section, specifically the `.baseUrl` for
+     * discovering the external URL, and the `.listen` and `.https` config
+     * for the internal one.
+     *
+     * Can be overridden in config by providing a target and corresponding plugins in `discovery.endpoints`.
+     * eg.
+     * ```yaml
+     * discovery:
+     *  endpoints:
+     *    - target: https://internal.example.com/internal-catalog
+     *      plugins: [catalog]
+     *    - target: https://internal.example.com/secure/api/{{pluginId}}
+     *      plugins: [auth, permission]
+     *    - target:
+     *        internal: https://internal.example.com/search
+     *        external: https://example.com/search
+     *      plugins: [search]
+     * ```
+     *
+     * The basePath defaults to `/api`, meaning the default full internal
+     * path for the `catalog` plugin will be `http://localhost:7007/api/catalog`.
+     */
+    static fromConfig(config: Config, options?: {
+        basePath?: string;
+    }): HostDiscovery;
+    private constructor();
+    private getTargetFromConfig;
+    getBaseUrl(pluginId: string): Promise<string>;
+    getExternalBaseUrl(pluginId: string): Promise<string>;
+}
 
 /**
  * @public
@@ -467,4 +515,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, CreateSpecializedBackendOptions, DefaultRootHttpRouter, DefaultRootHttpRouterOptions, ExtendedHttpServer, HttpRouterFactoryOptions, HttpServerCertificateOptions, HttpServerOptions, IdentityFactoryOptions, LifecycleMiddlewareOptions, MiddlewareFactory, MiddlewareFactoryErrorOptions, MiddlewareFactoryOptions, RootConfigFactoryOptions, RootHttpRouterConfigureContext, RootHttpRouterFactoryOptions, WinstonLogger, WinstonLoggerOptions, cacheServiceFactory, createConfigSecretEnumerator, createHttpServer, createLifecycleMiddleware, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootConfigServiceFactory, rootHttpRouterServiceFactory, rootLifecycleServiceFactory, rootLoggerServiceFactory, schedulerServiceFactory, tokenManagerServiceFactory, urlReaderServiceFactory };
+export { Backend, CreateSpecializedBackendOptions, DefaultRootHttpRouter, DefaultRootHttpRouterOptions, ExtendedHttpServer, HostDiscovery, HttpRouterFactoryOptions, HttpServerCertificateOptions, HttpServerOptions, IdentityFactoryOptions, LifecycleMiddlewareOptions, MiddlewareFactory, MiddlewareFactoryErrorOptions, MiddlewareFactoryOptions, RootConfigFactoryOptions, RootHttpRouterConfigureContext, RootHttpRouterFactoryOptions, WinstonLogger, WinstonLoggerOptions, cacheServiceFactory, createConfigSecretEnumerator, createHttpServer, createLifecycleMiddleware, createSpecializedBackend, databaseServiceFactory, discoveryServiceFactory, httpRouterServiceFactory, identityServiceFactory, lifecycleServiceFactory, loadBackendConfig, loggerServiceFactory, permissionsServiceFactory, readCorsOptions, readHelmetOptions, readHttpServerOptions, rootConfigServiceFactory, 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.5.5",
+  "version": "0.5.6",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
   "publishConfig": {
@@ -43,16 +43,16 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.19.7",
-    "@backstage/backend-plugin-api": "^0.6.5",
-    "@backstage/backend-tasks": "^0.5.10",
-    "@backstage/cli-common": "^0.1.12",
-    "@backstage/cli-node": "^0.1.4",
-    "@backstage/config": "^1.1.0",
-    "@backstage/config-loader": "^1.5.0",
-    "@backstage/errors": "^1.2.2",
-    "@backstage/plugin-auth-node": "^0.3.2",
-    "@backstage/plugin-permission-node": "^0.7.16",
+    "@backstage/backend-common": "^0.19.8",
+    "@backstage/backend-plugin-api": "^0.6.6",
+    "@backstage/backend-tasks": "^0.5.11",
+    "@backstage/cli-common": "^0.1.13",
+    "@backstage/cli-node": "^0.1.5",
+    "@backstage/config": "^1.1.1",
+    "@backstage/config-loader": "^1.5.1",
+    "@backstage/errors": "^1.2.3",
+    "@backstage/plugin-auth-node": "^0.4.0",
+    "@backstage/plugin-permission-node": "^0.7.17",
     "@backstage/types": "^1.1.1",
     "@manypkg/get-packages": "^1.1.3",
     "@types/cors": "^2.8.6",
@@ -75,8 +75,8 @@
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.2.6",
-    "@backstage/cli": "^0.22.13",
+    "@backstage/backend-test-utils": "^0.2.7",
+    "@backstage/cli": "^0.23.0",
     "@types/compression": "^1.7.0",
     "@types/fs-extra": "^9.0.3",
     "@types/http-errors": "^2.0.0",
@@ -85,11 +85,12 @@
     "@types/node-forge": "^1.3.0",
     "@types/stoppable": "^1.1.0",
     "http-errors": "^2.0.0",
-    "mock-fs": "^5.2.0",
     "supertest": "^6.1.3"
   },
+  "configSchema": "config.d.ts",
   "files": [
     "dist",
+    "config.d.ts",
     "alpha"
   ]
 }