@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
39 lines (38 loc) • 1.71 kB
TypeScript
/**
* Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { AsgardeoBrowserClient, UserProfile, SignInOptions, SignOutOptions, User } from '@asgardeo/browser';
import { AsgardeoReactConfig } from './models/config';
/**
* Client for mplementing Asgardeo in React applications.
* This class provides the core functionality for managing user authentication and sessions.
*
* @typeParam T - Configuration type that extends AsgardeoReactConfig.
*/
declare class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> extends AsgardeoBrowserClient<T> {
private asgardeo;
constructor();
initialize(config: T): Promise<boolean>;
getUser(): Promise<User>;
getUserProfile(): Promise<UserProfile>;
isLoading(): boolean;
isSignedIn(): Promise<boolean>;
signIn(options?: SignInOptions): Promise<User>;
signOut(options?: SignOutOptions, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
}
export default AsgardeoReactClient;