@backstage/core-app-api 0.5.4 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/core-app-api
 
+## 0.6.0
+
+### Minor Changes
+
+- bb2bb36651: **BREAKING**: Removed the deprecated `get` method from `StorageAPI` and its implementations, this method has been replaced by the `snapshot` method. The return value from snapshot no longer includes `newValue` which has been replaced by `value`. For getting notified when a value changes, use `observe# @backstage/core-app-api.
+- f3cce3dcf7: **BREAKING**: Removed export of `GithubSession` and `SamlSession` which are only used internally.
+- af5eaa87f4: **BREAKING**: Removed deprecated `auth0AuthApiRef`, `oauth2ApiRef`, `samlAuthApiRef` and `oidcAuthApiRef` as these APIs are too generic to be useful. Instructions for how to migrate can be found at [https://backstage.io/docs/api/deprecations#generic-auth-api-refs](https://backstage.io/docs/api/deprecations#generic-auth-api-refs).
+- dbf84eee55: **BREAKING**: Removed the deprecated `GithubAuth.normalizeScopes` method.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@0.8.0
+
 ## 0.5.4
 
 ### 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, BackstageIdentityResponse, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi, SessionState, AuthRequestOptions, 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, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi, SessionState, AuthRequestOptions, BackstageIdentityResponse, ProfileInfo, oktaAuthApiRef, 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';
@@ -91,22 +91,6 @@ declare class ApiFactoryRegistry implements ApiFactoryHolder {
     getAllApis(): Set<AnyApiRef>;
 }
 
-/**
- * Session information for GitHub auth.
- *
- * @public
- * @deprecated This type is internal and will be removed
- */
-declare type GithubSession = {
-    providerInfo: {
-        accessToken: string;
-        scopes: Set<string>;
-        expiresAt?: Date;
-    };
-    profile: ProfileInfo;
-    backstageIdentity: BackstageIdentityResponse;
-};
-
 /**
  * Create options for OAuth APIs.
  * @public
@@ -132,10 +116,6 @@ declare type AuthApiCreateOptions = {
  */
 declare class GithubAuth {
     static create(options: OAuthApiCreateOptions): typeof githubAuthApiRef.T;
-    /**
-     * @deprecated This method is deprecated and will be removed in a future release.
-     */
-    static normalizeScope(scope?: string): Set<string>;
 }
 
 /**
@@ -224,44 +204,6 @@ declare class SamlAuth implements ProfileInfoApi, BackstageIdentityApi, SessionA
     getProfile(options?: AuthRequestOptions): Promise<ProfileInfo | undefined>;
 }
 
-/**
- * Session information for SAML auth.
- *
- * @public
- * @deprecated This type is internal and will be removed
- */
-declare type ExportedSamlSession = {
-    userId: string;
-    profile: ProfileInfo;
-    backstageIdentity: BackstageIdentityResponse;
-};
-
-/**
- * Implements the OAuth flow to Auth0 products.
- *
- * @public
- * @deprecated Use {@link OAuth2} instead
- *
- * @example
- *
- * ```ts
- * OAuth2.create({
- *   discoveryApi,
- *   oauthRequestApi,
- *   provider: {
- *     id: 'auth0',
- *     title: 'Auth0',
- *     icon: () => null,
- *   },
- *   defaultScopes: ['openid', 'email', 'profile'],
- *   environment: configApi.getOptionalString('auth.environment'),
- * })
- * ```
- */
-declare class Auth0Auth {
-    static create(options: OAuthApiCreateOptions): typeof auth0AuthApiRef.T;
-}
-
 /**
  * Implements the OAuth flow to Microsoft products.
  *
@@ -913,4 +855,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, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };
+export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -725,7 +725,7 @@ class AuthSessionStore {
   }
 }
 
-const DEFAULT_PROVIDER$a = {
+const DEFAULT_PROVIDER$9 = {
   id: "oauth2",
   title: "Your Identity Provider",
   icon: () => null
@@ -735,7 +735,7 @@ class OAuth2 {
     const {
       discoveryApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$a,
+      provider = DEFAULT_PROVIDER$9,
       oauthRequestApi,
       defaultScopes = [],
       scopeTransform = (x) => x
@@ -812,7 +812,7 @@ class OAuth2 {
   }
 }
 
-const DEFAULT_PROVIDER$9 = {
+const DEFAULT_PROVIDER$8 = {
   id: "github",
   title: "GitHub",
   icon: () => null
@@ -822,7 +822,7 @@ class GithubAuth {
     const {
       discoveryApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$9,
+      provider = DEFAULT_PROVIDER$8,
       oauthRequestApi,
       defaultScopes = ["read:user"]
     } = options;
@@ -834,16 +834,9 @@ class GithubAuth {
       defaultScopes
     });
   }
-  static normalizeScope(scope) {
-    if (!scope) {
-      return /* @__PURE__ */ new Set();
-    }
-    const scopeList = Array.isArray(scope) ? scope : scope.split(/[\s|,]/).filter(Boolean);
-    return new Set(scopeList);
-  }
 }
 
-const DEFAULT_PROVIDER$8 = {
+const DEFAULT_PROVIDER$7 = {
   id: "gitlab",
   title: "GitLab",
   icon: () => null
@@ -853,7 +846,7 @@ class GitlabAuth {
     const {
       discoveryApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$8,
+      provider = DEFAULT_PROVIDER$7,
       oauthRequestApi,
       defaultScopes = ["read_user"]
     } = options;
@@ -867,7 +860,7 @@ class GitlabAuth {
   }
 }
 
-const DEFAULT_PROVIDER$7 = {
+const DEFAULT_PROVIDER$6 = {
   id: "google",
   title: "Google",
   icon: () => null
@@ -879,7 +872,7 @@ class GoogleAuth {
       discoveryApi,
       oauthRequestApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$7,
+      provider = DEFAULT_PROVIDER$6,
       defaultScopes = [
         "openid",
         `${SCOPE_PREFIX$1}userinfo.email`,
@@ -910,7 +903,7 @@ class GoogleAuth {
   }
 }
 
-const DEFAULT_PROVIDER$6 = {
+const DEFAULT_PROVIDER$5 = {
   id: "okta",
   title: "Okta",
   icon: () => null
@@ -930,7 +923,7 @@ class OktaAuth {
     const {
       discoveryApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$6,
+      provider = DEFAULT_PROVIDER$5,
       oauthRequestApi,
       defaultScopes = ["openid", "email", "profile", "offline_access"]
     } = options;
@@ -972,7 +965,7 @@ const samlSessionSchema = z.object({
   })
 });
 
-const DEFAULT_PROVIDER$5 = {
+const DEFAULT_PROVIDER$4 = {
   id: "saml",
   title: "SAML",
   icon: () => null
@@ -985,7 +978,7 @@ class SamlAuth {
     const {
       discoveryApi,
       environment = "development",
-      provider = DEFAULT_PROVIDER$5
+      provider = DEFAULT_PROVIDER$4
     } = options;
     const connector = new DirectAuthConnector({
       discoveryApi,
@@ -1021,30 +1014,6 @@ class SamlAuth {
   }
 }
 
-const DEFAULT_PROVIDER$4 = {
-  id: "auth0",
-  title: "Auth0",
-  icon: () => null
-};
-class Auth0Auth {
-  static create(options) {
-    const {
-      discoveryApi,
-      environment = "development",
-      provider = DEFAULT_PROVIDER$4,
-      oauthRequestApi,
-      defaultScopes = ["openid", `email`, `profile`]
-    } = options;
-    return OAuth2.create({
-      discoveryApi,
-      oauthRequestApi,
-      provider,
-      environment,
-      defaultScopes
-    });
-  }
-}
-
 const DEFAULT_PROVIDER$3 = {
   id: "microsoft",
   title: "Microsoft",
@@ -1520,9 +1489,6 @@ class OAuthRequestManager {
     this.handlerCount = 0;
   }
   createAuthRequester(options) {
-    if (!options.provider.id) {
-      console.warn("DEPRECATION WARNING: Not passing a provider id to createAuthRequester is deprecated, it will be required in the future");
-    }
     const handler = new OAuthPendingRequests();
     const index = this.handlerCount;
     this.handlerCount++;
@@ -1603,7 +1569,7 @@ class WebStorage {
     } catch (e) {
       this.errorApi.post(new Error(`Error when parsing JSON config from storage for: ${key}`));
     }
-    return { key, value, newValue: value, presence };
+    return { key, value, presence };
   }
   forBucket(name) {
     const bucketPath = `${this.namespace}/${name}`;
@@ -2591,5 +2557,5 @@ const FlatRoutes = (props) => {
   return useRoutes(routes);
 };
 
-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 };
+export { AlertApiForwarder, ApiFactoryRegistry, ApiProvider, ApiResolver, AppThemeSelector, AtlassianAuth, 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