@backstage/core-app-api 0.4.0 → 0.5.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/core-app-api
 
+## 0.5.0-next.0
+
+### Minor Changes
+
+- ceebe25391: Removed deprecated `SignInResult` type, which was replaced with the new `onSignInSuccess` callback.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@0.6.0-next.0
+  - @backstage/config@0.1.13-next.0
+
 ## 0.4.0
 
 ### Minor 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, RouteRef, SubRouteRef } from '@backstage/core-plugin-api';
+import { ApiHolder, ApiRef, ApiFactory, AnyApiRef, ProfileInfo, BackstageIdentityResponse, 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';
@@ -104,7 +104,7 @@ declare type GithubSession = {
         expiresAt?: Date;
     };
     profile: ProfileInfo;
-    backstageIdentity: BackstageIdentity;
+    backstageIdentity: BackstageIdentityResponse;
 };
 
 /**
@@ -138,7 +138,7 @@ declare class GithubAuth implements OAuthApi, SessionApi {
     signOut(): Promise<void>;
     sessionState$(): Observable<SessionState>;
     getAccessToken(scope?: string, options?: AuthRequestOptions): Promise<string>;
-    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
+    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentityResponse | undefined>;
     getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
     static normalizeScope(scope?: string): Set<string>;
 }
@@ -183,7 +183,7 @@ declare class OAuth2 implements OAuthApi, OpenIdConnectApi, ProfileInfoApi, Back
     sessionState$(): Observable<SessionState>;
     getAccessToken(scope?: string | string[], options?: AuthRequestOptions): Promise<string>;
     getIdToken(options?: AuthRequestOptions): Promise<string>;
-    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
+    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentityResponse | undefined>;
     getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
     private static normalizeScopes;
 }
@@ -201,7 +201,7 @@ declare type OAuth2Session = {
         expiresAt: Date;
     };
     profile: ProfileInfo;
-    backstageIdentity: BackstageIdentity;
+    backstageIdentity: BackstageIdentityResponse;
 };
 
 /**
@@ -225,7 +225,7 @@ declare class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionA
     private constructor();
     signIn(): Promise<void>;
     signOut(): Promise<void>;
-    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentity | undefined>;
+    getBackstageIdentity(options?: AuthRequestOptions): Promise<BackstageIdentityResponse | undefined>;
     getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
 }
 
@@ -238,7 +238,7 @@ declare class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionA
 declare type ExportedSamlSession = {
     userId: string;
     profile: ProfileInfo;
-    backstageIdentity: BackstageIdentity;
+    backstageIdentity: BackstageIdentityResponse;
 };
 
 /**
@@ -307,7 +307,7 @@ declare type BitbucketSession = {
         expiresAt?: Date;
     };
     profile: ProfileInfo;
-    backstageIdentity: BackstageIdentity;
+    backstageIdentity: BackstageIdentityResponse;
 };
 
 /**
@@ -578,27 +578,6 @@ declare type BootErrorPageProps = {
     step: 'load-config' | 'load-chunk';
     error: Error;
 };
-/**
- * The outcome of signing in on the sign-in page.
- *
- * @public
- * @deprecated replaced by passing the {@link @backstage/core-plugin-api#IdentityApi} to the {@link SignInPageProps.onSignInSuccess} instead.
- */
-declare type SignInResult = {
-    /**
-     * User ID that will be returned by the IdentityApi
-     */
-    userId: string;
-    profile: ProfileInfo;
-    /**
-     * Function used to retrieve an ID token for the signed in user.
-     */
-    getIdToken?: () => Promise<string>;
-    /**
-     * Sign out handler that will be called if the user requests to sign out.
-     */
-    signOut?: () => Promise<void>;
-};
 /**
  * Props for the `SignInPage` component of {@link AppComponents}.
  *
@@ -937,4 +916,4 @@ declare type FeatureFlaggedProps = {
  */
 declare const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
 
-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 };
+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, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -2183,6 +2183,9 @@ const AppContextProvider = ({
 function mkError(thing) {
   return new Error(`Tried to access IdentityApi ${thing} before app was loaded`);
 }
+function logDeprecation(thing) {
+  console.warn(`WARNING: Call to ${thing} is deprecated and will break in the future`);
+}
 class AppIdentityProxy {
   setTarget(identityApi) {
     this.target = identityApi;
@@ -2191,12 +2194,20 @@ class AppIdentityProxy {
     if (!this.target) {
       throw mkError("getUserId");
     }
+    if (!this.target.getUserId) {
+      throw new Error("IdentityApi does not implement getUserId");
+    }
+    logDeprecation("getUserId");
     return this.target.getUserId();
   }
   getProfile() {
     if (!this.target) {
       throw mkError("getProfile");
     }
+    if (!this.target.getProfile) {
+      throw new Error("IdentityApi does not implement getProfile");
+    }
+    logDeprecation("getProfile");
     return this.target.getProfile();
   }
   async getProfileInfo() {
@@ -2209,7 +2220,11 @@ class AppIdentityProxy {
     if (!this.target) {
       throw mkError("getBackstageIdentity");
     }
-    return this.target.getBackstageIdentity();
+    const identity = await this.target.getBackstageIdentity();
+    if (!identity.userEntityRef.match(/^.*:.*\/.*$/)) {
+      console.warn(`WARNING: The App IdentityApi provided an invalid userEntityRef, '${identity.userEntityRef}'. It must be a full Entity Reference of the form '<kind>:<namespace>/<name>'.`);
+    }
+    return identity;
   }
   async getCredentials() {
     if (!this.target) {
@@ -2221,6 +2236,10 @@ class AppIdentityProxy {
     if (!this.target) {
       throw mkError("getIdToken");
     }
+    if (!this.target.getIdToken) {
+      throw new Error("IdentityApi does not implement getIdToken");
+    }
+    logDeprecation("getIdToken");
     return this.target.getIdToken();
   }
   async signOut() {