unexport OAuth2Response

Signed-off-by: Gasan.Guseinov <465806+gusega@users.noreply.github.com>

packages/core-app-api/report.api.md

@@ -21,7 +21,6 @@ import { AuthRequestOptions } from '@backstage/core-plugin-api';
 import { BackstageIdentityApi } from '@backstage/core-plugin-api';
 import { BackstageIdentityResponse } from '@backstage/core-plugin-api';
 import { BackstagePlugin } from '@backstage/core-plugin-api';
-import { BackstageUserIdentity } from '@backstage/core-plugin-api';
 import { bitbucketAuthApiRef } from '@backstage/core-plugin-api';
 import { bitbucketServerAuthApiRef } from '@backstage/core-plugin-api';
 import { ComponentType } from 'react';
@@ -592,22 +591,6 @@ export type OAuth2CreateOptionsWithAuthConnector = {
   authConnector: AuthConnector<OAuth2Session>;
 };
 
-// @public (undocumented)
-export type OAuth2Response = {
-  providerInfo: {
-    accessToken: string;
-    idToken: string;
-    scope: string;
-    expiresInSeconds?: number;
-  };
-  profile: ProfileInfo;
-  backstageIdentity: {
-    token: string;
-    expiresInSeconds?: number;
-    identity: BackstageUserIdentity;
-  };
-};
-
 // @public
 export type OAuth2Session = {
   providerInfo: {

packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2.ts

@@ -21,8 +21,10 @@ import {
   AuthRequestOptions,
   BackstageIdentityApi,
   BackstageIdentityResponse,
+  BackstageUserIdentity,
   OAuthApi,
   OpenIdConnectApi,
+  ProfileInfo,
   ProfileInfoApi,
   SessionApi,
   SessionState,
@@ -31,7 +33,6 @@ import { Observable } from '@backstage/types';
 import {
   OAuth2CreateOptions,
   OAuth2CreateOptionsWithAuthConnector,
-  OAuth2Response,
   OAuth2Session,
 } from './types';
 
@@ -41,6 +42,21 @@ const DEFAULT_PROVIDER = {
   icon: () => null,
 };
 
+export type OAuth2Response = {
+  providerInfo: {
+    accessToken: string;
+    idToken: string;
+    scope: string;
+    expiresInSeconds?: number;
+  };
+  profile: ProfileInfo;
+  backstageIdentity: {
+    token: string;
+    expiresInSeconds?: number;
+    identity: BackstageUserIdentity;
+  };
+};
+
 /**
  * Implements a generic OAuth2 flow for auth.
  *

packages/core-app-api/src/apis/implementations/auth/oauth2/OAuth2CustomAuthConnector.test.ts

@@ -21,9 +21,9 @@ import {
   AuthConnectorRefreshSessionOptions,
   openLoginPopup,
   OAuth2CreateOptionsWithAuthConnector,
-  OAuth2Response,
 } from '../../../../index';
 import { waitFor } from '@testing-library/react';
+import { BackstageUserIdentity, ProfileInfo } from '@backstage/core-plugin-api';
 
 const scopeTransform = (x: string[]) => x;
 
@@ -34,6 +34,27 @@ type Options = {
   sessionTransform?(response: any): OAuth2Session | Promise<OAuth2Session>;
 };
 
+/**
+ * A replica of private `OAuth2Response` from OAuth2.ts.
+ * `OAuth2Response` represents raw OAuth2 response from the `auth-backend` plugin.
+ * If custom auth connector calls `auth-backend` plugin, it will have to transform `OAuth2Response` into
+ * `OAuth2Session`.
+ */
+type OAuth2Response = {
+  providerInfo: {
+    accessToken: string;
+    idToken: string;
+    scope: string;
+    expiresInSeconds?: number;
+  };
+  profile: ProfileInfo;
+  backstageIdentity: {
+    token: string;
+    expiresInSeconds?: number;
+    identity: BackstageUserIdentity;
+  };
+};
+
 class CustomAuthConnector implements AuthConnector<OAuth2Session> {
   private readonly sessionTransform: (response: any) => Promise<OAuth2Session>;
 

packages/core-app-api/src/apis/implementations/auth/oauth2/types.ts

@@ -16,7 +16,6 @@
 
 import {
   BackstageIdentityResponse,
-  BackstageUserIdentity,
   ProfileInfo,
 } from '@backstage/core-plugin-api';
 import { OAuthApiCreateOptions } from '../types.ts';
@@ -39,24 +38,6 @@ export type OAuth2Session = {
   backstageIdentity?: BackstageIdentityResponse;
 };
 
-/**
- * @public
- */
-export type OAuth2Response = {
-  providerInfo: {
-    accessToken: string;
-    idToken: string;
-    scope: string;
-    expiresInSeconds?: number;
-  };
-  profile: ProfileInfo;
-  backstageIdentity: {
-    token: string;
-    expiresInSeconds?: number;
-    identity: BackstageUserIdentity;
-  };
-};
-
 /**
  * OAuth2 create options.
  * @public