@backstage/core-app-api 1.7.0 → 1.7.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/core-app-api
 
+## 1.7.1-next.0
+
+### Patch Changes
+
+- 42d817e76ab: Added `FrontendHostDiscovery` for config driven discovery implementation
+- Updated dependencies
+  - @backstage/core-plugin-api@1.5.1
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.4
+
 ## 1.7.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -411,6 +411,43 @@ declare class UrlPatternDiscovery implements DiscoveryApi {
     getBaseUrl(pluginId: string): Promise<string>;
 }
 
+/**
+ * FrontendHostDiscovery is a config driven DiscoveryApi implementation.
+ * It uses the app-config to determine the url for a plugin.
+ *
+ * @public
+ */
+declare class FrontendHostDiscovery implements DiscoveryApi {
+    private readonly endpoints;
+    private readonly defaultEndpoint;
+    /**
+     * Creates a new FrontendHostDiscovery discovery instance by reading
+     * the external target URL from the `discovery.endpoints` config section.
+     *
+     * eg.
+     * ```yaml
+     * discovery:
+     *  endpoints:
+     *    - target: https://internal.example.com/internal-catalog
+     *      plugins: [catalog]
+     *    - target: https://internal.example.com/secure/api/{{pluginId}}
+     *      plugins: [auth, permissions]
+     *    - target:
+     *        internal: https://internal.example.com/search
+     *        external: https://example.com/search
+     *      plugins: [search]
+     * ```
+     *
+     * If a plugin is not declared in the config, the discovery will fall back to using the baseUrl with
+     * the provided `pathPattern` appended. The default path pattern is `"/api/{{ pluginId }}"`.
+     */
+    static fromConfig(config: Config, options?: {
+        pathPattern?: string;
+    }): FrontendHostDiscovery;
+    private constructor();
+    getBaseUrl(pluginId: string): Promise<string>;
+}
+
 /**
  * Decorates an ErrorApi by also forwarding error messages
  * to the alertApi with an 'error' severity.
@@ -1004,4 +1041,4 @@ type FeatureFlaggedProps = {
  */
 declare const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
 
-export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppRouter, AppRouterProps, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketServerAuth, BitbucketServerSession, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppRouter, AppRouterProps, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketServerAuth, BitbucketServerSession, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, FrontendHostDiscovery, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -1476,7 +1476,56 @@ class UrlPatternDiscovery {
     return new UrlPatternDiscovery(parts);
   }
   async getBaseUrl(pluginId) {
-    return this.parts.join(pluginId);
+    return this.parts.join(encodeURIComponent(pluginId));
+  }
+}
+
+class FrontendHostDiscovery {
+  constructor(endpoints, defaultEndpoint) {
+    this.endpoints = endpoints;
+    this.defaultEndpoint = defaultEndpoint;
+  }
+  /**
+   * Creates a new FrontendHostDiscovery discovery instance by reading
+   * the external target URL from the `discovery.endpoints` config section.
+   *
+   * eg.
+   * ```yaml
+   * discovery:
+   *  endpoints:
+   *    - target: https://internal.example.com/internal-catalog
+   *      plugins: [catalog]
+   *    - target: https://internal.example.com/secure/api/{{pluginId}}
+   *      plugins: [auth, permissions]
+   *    - target:
+   *        internal: https://internal.example.com/search
+   *        external: https://example.com/search
+   *      plugins: [search]
+   * ```
+   *
+   * If a plugin is not declared in the config, the discovery will fall back to using the baseUrl with
+   * the provided `pathPattern` appended. The default path pattern is `"/api/{{ pluginId }}"`.
+   */
+  static fromConfig(config, options) {
+    var _a, _b;
+    const path = (_a = options == null ? void 0 : options.pathPattern) != null ? _a : "/api/{{ pluginId }}";
+    const baseUrl = config.getString("backend.baseUrl");
+    const endpoints = (_b = config.getOptionalConfigArray("discovery.endpoints")) == null ? void 0 : _b.flatMap((e) => {
+      const target = typeof e.get("target") === "object" ? e.getString("target.external") : e.getString("target");
+      const discovery = UrlPatternDiscovery.compile(target);
+      return e.getStringArray("plugins").map((pluginId) => [pluginId, discovery]);
+    });
+    return new FrontendHostDiscovery(
+      new Map(endpoints),
+      UrlPatternDiscovery.compile(`${baseUrl}${path}`)
+    );
+  }
+  async getBaseUrl(pluginId) {
+    const endpoint = this.endpoints.get(pluginId);
+    if (endpoint) {
+      return endpoint.getBaseUrl(pluginId);
+    }
+    return this.defaultEndpoint.getBaseUrl(pluginId);
   }
 }
 
@@ -3263,5 +3312,5 @@ const FlatRoutes = (props) => {
   return useRoutes(withNotFound);
 };
 
-export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppRouter, AppThemeSelector, AtlassianAuth, BitbucketAuth, BitbucketServerAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppRouter, AppThemeSelector, AtlassianAuth, BitbucketAuth, BitbucketServerAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, FrontendHostDiscovery, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
 //# sourceMappingURL=index.esm.js.map