From fe015869b39fbf6ac1c416a8132fff95ecef0409 Mon Sep 17 00:00:00 2001 From: Gasan Guseinov Date: Mon, 9 Dec 2024 16:07:37 +0100 Subject: [PATCH] update api specification Signed-off-by: Gasan Guseinov --- packages/core-app-api/report.api.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/packages/core-app-api/report.api.md b/packages/core-app-api/report.api.md index 0cec898bfd..73d940d1c4 100644 --- a/packages/core-app-api/report.api.md +++ b/packages/core-app-api/report.api.md @@ -294,6 +294,13 @@ export type AuthApiCreateOptions = { configApi?: ConfigApi; }; +// @public +export type AuthConnector = { + createSession(options: CreateSessionOptions): Promise; + refreshSession(scopes?: Set): Promise; + removeSession(): Promise; +}; + // @public export type BackstageApp = { getPlugins(): BackstagePlugin[]; @@ -353,6 +360,12 @@ export function createFetchApi(options: { middleware?: FetchMiddleware | FetchMiddleware[] | undefined; }): FetchApi; +// @public (undocumented) +export type CreateSessionOptions = { + scopes: Set; + instantPopup?: boolean; +}; + // @public export function createSpecializedApp(options: AppOptions): BackstageApp; @@ -478,6 +491,15 @@ export class LocalStorageFeatureFlags implements FeatureFlagsApi { save(options: FeatureFlagsSaveOptions): void; } +// @public +export type LoginPopupOptions = { + url: string; + name: string; + origin: string; + width?: number; + height?: number; +}; + // @public export class MicrosoftAuth { // (undocumented) @@ -640,6 +662,9 @@ export class SamlAuth signOut(): Promise; } +// @public +export function showLoginPopup(options: LoginPopupOptions): Promise; + // @public export type SignInPageProps = PropsWithChildren<{ onSignInSuccess(identityApi: IdentityApi): void;