@backstage/core-app-api 1.6.0 → 1.7.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/core-app-api
 
+## 1.7.0-next.1
+
+### Patch Changes
+
+- 1e4f5e91b8e: Bump `zod` and `zod-to-json-schema` dependencies.
+- e0c6e8b9c3c: Update peer dependencies
+- Updated dependencies
+  - @backstage/core-plugin-api@1.5.1-next.0
+  - @backstage/version-bridge@1.0.4-next.0
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+
+## 1.7.0-next.0
+
+### Minor Changes
+
+- 7908d72e033: Introduce a new global config parameter, `auth.enableExperimentalRedirectFlow`. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.5.0
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.3
+
 ## 1.6.0
 
 ### Minor Changes

package/config.d.ts

@@ -115,4 +115,11 @@ export interface Config {
      */
     environment?: string;
   };
+
+  /**
+   $ Enable redirect authentication flow type, instead of a popup for authentication
+   * default value: 'false'
+   * @visibility frontend
+   */
+  enableExperimentalRedirectFlow?: boolean;
 }

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, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi, SessionState, AuthRequestOptions, BackstageIdentityResponse, ProfileInfo, oktaAuthApiRef, microsoftAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, 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, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, ConfigApi, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi, SessionState, AuthRequestOptions, BackstageIdentityResponse, ProfileInfo, oktaAuthApiRef, microsoftAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, 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';
@@ -107,6 +107,7 @@ declare type AuthApiCreateOptions = {
     discoveryApi: DiscoveryApi;
     environment?: string;
     provider?: AuthProviderInfo;
+    configApi?: ConfigApi;
 };
 
 /**
@@ -218,6 +219,7 @@ declare class MicrosoftAuth {
  * @public
  */
 declare type OneLoginAuthCreateOptions = {
+    configApi?: ConfigApi;
     discoveryApi: DiscoveryApi;
     oauthRequestApi: OAuthRequestApi;
     environment?: string;
@@ -613,7 +615,7 @@ declare type BootErrorPageProps = {
  */
 declare type SignInPageProps = {
     /**
-     * Set the IdentityApi on successful sign in. This should only be called once.
+     * Set the IdentityApi on successful sign-in. This should only be called once.
      */
     onSignInSuccess(identityApi: IdentityApi): void;
 };

package/dist/index.esm.js

@@ -215,12 +215,15 @@ function showLoginPopup(options) {
   });
 }
 
+let warned$1 = false;
 function defaultJoinScopes(scopes) {
   return [...scopes].join(" ");
 }
 class DefaultAuthConnector {
   constructor(options) {
+    var _a;
     const {
+      configApi,
       discoveryApi,
       environment,
       provider,
@@ -228,9 +231,21 @@ class DefaultAuthConnector {
       oauthRequestApi,
       sessionTransform = (id) => id
     } = options;
+    if (!warned$1 && !configApi) {
+      console.warn(
+        "DEPRECATION WARNING: Authentication providers require a configApi instance to configure the authentication flow. Please provide one to the authentication provider constructor."
+      );
+      warned$1 = true;
+    }
+    this.enableExperimentalRedirectFlow = configApi ? (_a = configApi.getOptionalBoolean("enableExperimentalRedirectFlow")) != null ? _a : false : false;
     this.authRequester = oauthRequestApi.createAuthRequester({
       provider,
-      onAuthRequest: (scopes) => this.showPopup(scopes)
+      onAuthRequest: async (scopes) => {
+        if (!this.enableExperimentalRedirectFlow) {
+          return this.showPopup(scopes);
+        }
+        return this.executeRedirect(scopes);
+      }
     });
     this.discoveryApi = discoveryApi;
     this.environment = environment;
@@ -240,6 +255,9 @@ class DefaultAuthConnector {
   }
   async createSession(options) {
     if (options.instantPopup) {
+      if (this.enableExperimentalRedirectFlow) {
+        return this.executeRedirect(options.scopes);
+      }
       return this.showPopup(options.scopes);
     }
     return this.authRequester(options.scopes);
@@ -293,7 +311,8 @@ class DefaultAuthConnector {
     const scope = this.joinScopesFunc(scopes);
     const popupUrl = await this.buildUrl("/start", {
       scope,
-      origin: window.location.origin
+      origin: window.location.origin,
+      flow: "popup"
     });
     const payload = await showLoginPopup({
       url: popupUrl,
@@ -304,6 +323,17 @@ class DefaultAuthConnector {
     });
     return await this.sessionTransform(payload);
   }
+  async executeRedirect(scopes) {
+    const scope = this.joinScopesFunc(scopes);
+    window.location.href = await this.buildUrl("/start", {
+      scope,
+      origin: window.location.origin,
+      redirectUrl: window.location.href,
+      flow: "redirect"
+    });
+    return new Promise(() => {
+    });
+  }
   async buildUrl(path, query) {
     const baseUrl = await this.discoveryApi.getBaseUrl("auth");
     const queryString = this.buildQueryString({
@@ -775,6 +805,7 @@ const DEFAULT_PROVIDER$a = {
 class OAuth2 {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$a,
@@ -783,6 +814,7 @@ class OAuth2 {
       scopeTransform = (x) => x
     } = options;
     const connector = new DefaultAuthConnector({
+      configApi,
       discoveryApi,
       environment,
       provider,
@@ -870,6 +902,7 @@ const DEFAULT_PROVIDER$9 = {
 class GithubAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$9,
@@ -877,6 +910,7 @@ class GithubAuth {
       defaultScopes = ["read:user"]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -894,6 +928,7 @@ const DEFAULT_PROVIDER$8 = {
 class GitlabAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$8,
@@ -901,6 +936,7 @@ class GitlabAuth {
       defaultScopes = ["read_user"]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -919,6 +955,7 @@ const SCOPE_PREFIX$1 = "https://www.googleapis.com/auth/";
 class GoogleAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       oauthRequestApi,
       environment = "development",
@@ -930,6 +967,7 @@ class GoogleAuth {
       ]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -971,6 +1009,7 @@ const OKTA_SCOPE_PREFIX = "okta.";
 class OktaAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$6,
@@ -978,6 +1017,7 @@ class OktaAuth {
       defaultScopes = ["openid", "email", "profile", "offline_access"]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -1071,6 +1111,7 @@ const DEFAULT_PROVIDER$4 = {
 class MicrosoftAuth {
   static create(options) {
     const {
+      configApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$4,
       oauthRequestApi,
@@ -1084,6 +1125,7 @@ class MicrosoftAuth {
       ]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -1111,12 +1153,14 @@ const SCOPE_PREFIX = "onelogin.";
 class OneLoginAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$3,
       oauthRequestApi
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -1145,6 +1189,7 @@ const DEFAULT_PROVIDER$2 = {
 class BitbucketAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$2,
@@ -1152,6 +1197,7 @@ class BitbucketAuth {
       defaultScopes = ["team"]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -1169,6 +1215,7 @@ const DEFAULT_PROVIDER$1 = {
 class BitbucketServerAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER$1,
@@ -1176,6 +1223,7 @@ class BitbucketServerAuth {
       defaultScopes = ["PROJECT_ADMIN"]
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,
@@ -1193,12 +1241,14 @@ const DEFAULT_PROVIDER = {
 class AtlassianAuth {
   static create(options) {
     const {
+      configApi,
       discoveryApi,
       environment = "development",
       provider = DEFAULT_PROVIDER,
       oauthRequestApi
     } = options;
     return OAuth2.create({
+      configApi,
       discoveryApi,
       oauthRequestApi,
       provider,