@backstage/core-app-api 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/core-app-api
 
+## 0.4.0
+
+### Minor Changes
+
+- e2eb92c109: Removed previously deprecated `ApiRegistry` export.
+
+### Patch Changes
+
+- 34442cd5cf: Fixed an issue where valid SAML and GitHub sessions would be considered invalid and not be stored.
+
+  Deprecated the `SamlSession` and `GithubSession` types.
+
+- 784d8078ab: Removed direct and transitive MUI dependencies.
+- Updated dependencies
+  - @backstage/config@0.1.12
+  - @backstage/core-plugin-api@0.5.0
+
 ## 0.3.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode, PropsWithChildren, ComponentType } from 'react';
 import PropTypes from 'prop-types';
-import { ApiHolder, ApiRef, ApiFactory, AnyApiRef, ProfileInfo, BackstageIdentity, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, OAuthApi, SessionApi, SessionState, AuthRequestOptions, gitlabAuthApiRef, googleAuthApiRef, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, oktaAuthApiRef, auth0AuthApiRef, microsoftAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, atlassianAuthApiRef, AlertApi, AlertMessage, AnalyticsApi, AnalyticsEvent, AppThemeApi, AppTheme, ErrorApi, ErrorApiError, ErrorApiErrorContext, FeatureFlagsApi, FeatureFlag, FeatureFlagsSaveOptions, FetchApi, IdentityApi, OAuthRequesterOptions, OAuthRequester, PendingOAuthRequest, StorageApi, StorageValueSnapshot, BackstagePlugin, IconComponent, ExternalRouteRef, AnyApiFactory, PluginOutput, RouteRef, SubRouteRef } from '@backstage/core-plugin-api';
+import { ApiHolder, ApiRef, ApiFactory, AnyApiRef, ProfileInfo, BackstageIdentity, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, OAuthApi, SessionApi, SessionState, AuthRequestOptions, gitlabAuthApiRef, googleAuthApiRef, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, oktaAuthApiRef, auth0AuthApiRef, microsoftAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, atlassianAuthApiRef, AlertApi, AlertMessage, AnalyticsApi, AnalyticsEvent, AppThemeApi, AppTheme, ErrorApi, ErrorApiError, ErrorApiErrorContext, FeatureFlagsApi, FeatureFlag, FeatureFlagsSaveOptions, FetchApi, IdentityApi, OAuthRequesterOptions, OAuthRequester, PendingOAuthRequest, StorageApi, StorageValueSnapshot, BackstagePlugin, IconComponent, ExternalRouteRef, AnyApiFactory, RouteRef, SubRouteRef } from '@backstage/core-plugin-api';
 import * as _backstage_types from '@backstage/types';
 import { Observable, JsonValue } from '@backstage/types';
 import { Config, AppConfig } from '@backstage/config';
@@ -30,45 +30,6 @@ declare const ApiProvider: {
     };
 };
 
-declare type ApiImpl<T = unknown> = readonly [ApiRef<T>, T];
-declare class ApiRegistryBuilder {
-    private apis;
-    add<T, I extends T>(api: ApiRef<T>, impl: I): I;
-    build(): ApiRegistry;
-}
-/**
- * A registry for utility APIs.
- *
- * @public
- * @deprecated Will be removed, use {@link @backstage/test-utils#TestApiProvider} or {@link @backstage/test-utils#TestApiRegistry} instead.
- */
-declare class ApiRegistry implements ApiHolder {
-    private readonly apis;
-    static builder(): ApiRegistryBuilder;
-    /**
-     * Creates a new ApiRegistry with a list of API implementations.
-     *
-     * @param apis - A list of pairs mapping an ApiRef to its respective implementation
-     */
-    static from(apis: ApiImpl[]): ApiRegistry;
-    /**
-     * Creates a new ApiRegistry with a single API implementation.
-     *
-     * @param api - ApiRef for the API to add
-     * @param impl - Implementation of the API to add
-     */
-    static with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
-    constructor(apis: Map<string, unknown>);
-    /**
-     * Returns a new ApiRegistry with the provided API added to the existing ones.
-     *
-     * @param api - ApiRef for the API to add
-     * @param impl - Implementation of the API to add
-     */
-    with<T>(api: ApiRef<T>, impl: T): ApiRegistry;
-    get<T>(api: ApiRef<T>): T | undefined;
-}
-
 /**
  * @public
  */
@@ -134,6 +95,7 @@ declare class ApiFactoryRegistry implements ApiFactoryHolder {
  * Session information for GitHub auth.
  *
  * @public
+ * @deprecated This type is internal and will be removed
  */
 declare type GithubSession = {
     providerInfo: {
@@ -271,8 +233,9 @@ declare class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionA
  * Session information for SAML auth.
  *
  * @public
+ * @deprecated This type is internal and will be removed
  */
-declare type SamlSession = {
+declare type ExportedSamlSession = {
     userId: string;
     profile: ProfileInfo;
     backstageIdentity: BackstageIdentity;
@@ -782,11 +745,14 @@ declare type AppOptions = {
     /**
      * A list of all plugins to include in the app.
      */
-    plugins?: (Omit<BackstagePlugin<any, any>, 'output'> & {
-        output(): (PluginOutput | {
+    plugins?: Array<BackstagePlugin<any, any> & {
+        output?(): Array<{
+            type: 'feature-flag';
+            name: string;
+        } | {
             type: string;
-        })[];
-    })[];
+        }>;
+    }>;
     /**
      * Supply components to the app to override the default ones.
      */
@@ -971,4 +937,4 @@ declare type FeatureFlaggedProps = {
  */
 declare const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
 
-export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiRegistry, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppThemeSelector, AtlassianAuth, Auth0Auth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GithubSession, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SamlSession, SignInPageProps, SignInResult, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppThemeSelector, AtlassianAuth, Auth0Auth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GithubSession, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, ExportedSamlSession as SamlSession, SignInPageProps, SignInResult, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -8,7 +8,6 @@ import { ConfigReader } from '@backstage/config';
 export { ConfigReader } from '@backstage/config';
 import { matchRoutes, generatePath, useLocation, Routes, Route, useRoutes } from 'react-router-dom';
 import useAsync from 'react-use/lib/useAsync';
-import { UserIdentity } from '@backstage/core-components';
 import useObservable from 'react-use/lib/useObservable';
 
 class ApiAggregator {
@@ -42,39 +41,6 @@ ApiProvider.propTypes = {
   children: PropTypes.node
 };
 
-class ApiRegistryBuilder {
-  constructor() {
-    this.apis = [];
-  }
-  add(api, impl) {
-    this.apis.push([api.id, impl]);
-    return impl;
-  }
-  build() {
-    return new ApiRegistry(new Map(this.apis));
-  }
-}
-class ApiRegistry {
-  constructor(apis) {
-    this.apis = apis;
-  }
-  static builder() {
-    return new ApiRegistryBuilder();
-  }
-  static from(apis) {
-    return new ApiRegistry(new Map(apis.map(([api, impl]) => [api.id, impl])));
-  }
-  static with(api, impl) {
-    return new ApiRegistry(/* @__PURE__ */ new Map([[api.id, impl]]));
-  }
-  with(api, impl) {
-    return new ApiRegistry(new Map([...this.apis, [api.id, impl]]));
-  }
-  get(api) {
-    return this.apis.get(api.id);
-  }
-}
-
 class ApiResolver {
   constructor(factories) {
     this.factories = factories;
@@ -1119,7 +1085,6 @@ class OktaAuth {
 }
 
 const samlSessionSchema = z.object({
-  userId: z.string(),
   profile: z.object({
     email: z.string().optional(),
     displayName: z.string().optional(),
@@ -2344,6 +2309,39 @@ const defaultConfigLoader = async (runtimeConfigJson = "__APP_INJECTED_RUNTIME_C
   return configs;
 };
 
+class ApiRegistryBuilder {
+  constructor() {
+    this.apis = [];
+  }
+  add(api, impl) {
+    this.apis.push([api.id, impl]);
+    return impl;
+  }
+  build() {
+    return new ApiRegistry(new Map(this.apis));
+  }
+}
+class ApiRegistry {
+  constructor(apis) {
+    this.apis = apis;
+  }
+  static builder() {
+    return new ApiRegistryBuilder();
+  }
+  static from(apis) {
+    return new ApiRegistry(new Map(apis.map(([api, impl]) => [api.id, impl])));
+  }
+  static with(api, impl) {
+    return new ApiRegistry(/* @__PURE__ */ new Map([[api.id, impl]]));
+  }
+  with(api, impl) {
+    return new ApiRegistry(new Map([...this.apis, [api.id, impl]]));
+  }
+  get(api) {
+    return this.apis.get(api.id);
+  }
+}
+
 function generateBoundRoutes(bindRoutes) {
   const result = /* @__PURE__ */ new Map();
   if (bindRoutes) {
@@ -2390,7 +2388,7 @@ function useConfigLoader(configLoader, components, appThemeApi) {
   if (noConfigNode) {
     return {
       node: /* @__PURE__ */ React.createElement(ApiProvider, {
-        apis: ApiRegistry.from([[appThemeApiRef, appThemeApi]])
+        apis: ApiRegistry.with(appThemeApiRef, appThemeApi)
       }, /* @__PURE__ */ React.createElement(ThemeProvider, null, noConfigNode))
     };
   }
@@ -2475,14 +2473,11 @@ class AppManager {
               }
             } else {
               for (const output of plugin.output()) {
-                switch (output.type) {
-                  case "feature-flag": {
-                    featureFlagsApi.registerFlag({
-                      name: output.name,
-                      pluginId: plugin.getId()
-                    });
-                    break;
-                  }
+                if (output.type === "feature-flag") {
+                  featureFlagsApi.registerFlag({
+                    name: output.name,
+                    pluginId: plugin.getId()
+                  });
                 }
               }
             }
@@ -2529,7 +2524,26 @@ class AppManager {
       const configApi = useApi(configApiRef);
       const mountPath = `${getBasePath(configApi)}/*`;
       if (!SignInPageComponent) {
-        this.appIdentityProxy.setTarget(UserIdentity.createGuest());
+        this.appIdentityProxy.setTarget({
+          getUserId: () => "guest",
+          getIdToken: async () => void 0,
+          getProfile: () => ({
+            email: "guest@example.com",
+            displayName: "Guest"
+          }),
+          getProfileInfo: async () => ({
+            email: "guest@example.com",
+            displayName: "Guest"
+          }),
+          getBackstageIdentity: async () => ({
+            type: "user",
+            userEntityRef: "user:default/guest",
+            ownershipEntityRefs: ["user:default/guest"]
+          }),
+          getCredentials: async () => ({}),
+          signOut: async () => {
+          }
+        });
         return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
           tree: children
         }), /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
@@ -2653,5 +2667,5 @@ const FlatRoutes = (props) => {
   return useRoutes(routes);
 };
 
-export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiRegistry, ApiResolver, AppThemeSelector, AtlassianAuth, Auth0Auth, BitbucketAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppThemeSelector, AtlassianAuth, Auth0Auth, BitbucketAuth, ErrorAlerter, ErrorApiForwarder, FeatureFlagged, FetchMiddlewares, FlatRoutes, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuthRequestManager, OktaAuth, OneLoginAuth, SamlAuth, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
 //# sourceMappingURL=index.esm.js.map