@asgardeo/react 0.3.0 → 0.4.0

package/README.md

@@ -124,6 +124,10 @@ function App() {
 }
 ```
 
+## Documentation
+
+For complete API documentation including all components, hooks, and customization options, see [API.md](./API.md).
+
 ## License
 
-Apache-2.0
+Licenses this source under the Apache License, Version 2.0 [LICENSE](../../LICENSE), You may not use this file except in compliance with the License.

package/dist/AsgardeoReactClient.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoBrowserClient, SignInOptions, SignOutOptions, User } from '@asgardeo/browser';
+import { AsgardeoBrowserClient, UserProfile, SignInOptions, SignOutOptions, User } from '@asgardeo/browser';
 import { AsgardeoReactConfig } from './models/config';
 /**
  * Client for mplementing Asgardeo in React applications.
@@ -27,7 +27,8 @@ declare class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactC
     private asgardeo;
     constructor();
     initialize(config: T): Promise<boolean>;
-    getUser(): Promise<any>;
+    getUser(): Promise<User>;
+    getUserProfile(): Promise<UserProfile>;
     isLoading(): boolean;
     isSignedIn(): Promise<boolean>;
     signIn(options?: SignInOptions): Promise<User>;

package/dist/__temp__/api.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoSPAClient, AuthClientConfig, BasicUserInfo, LegacyConfig as Config, IdTokenPayload, FetchResponse, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/browser';
+import { AsgardeoSPAClient, AuthClientConfig, User, LegacyConfig as Config, IdTokenPayload, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/browser';
 import { AuthStateInterface } from './models';
 declare class AuthAPI {
     static DEFAULT_STATE: AuthStateInterface;
@@ -25,7 +25,6 @@ declare class AuthAPI {
     constructor(spaClient?: AsgardeoSPAClient);
     _setIsLoading(isLoading: boolean): void;
     _getIsLoading(): boolean;
-    isSignedIn(): Promise<boolean>;
     isLoading(): boolean;
     /**
      * Method to return Auth Client instance authentication state.
@@ -52,9 +51,9 @@ declare class AuthAPI {
      * @param {AuthStateInterface} state - Current authentication state in React Auth Context.
      * @param {any} callback - Action to trigger on successful sign in.
      */
-    signIn(config: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
+    signIn(config: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: User) => void, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }): Promise<BasicUserInfo>;
+    }): Promise<any>;
     /**
      * Method to handle user Sign Out requests.
      *
@@ -72,9 +71,9 @@ declare class AuthAPI {
     /**
      * This method returns a Promise that resolves with the basic user information obtained from the ID token.
      *
-     * @return {Promise<BasicUserInfo>} - A promise that resolves with the user information.
+     * @return {Promise<User>} - A promise that resolves with the user information.
      */
-    getBasicUserInfo(): Promise<BasicUserInfo>;
+    getUser(): Promise<User>;
     /**
      * This method sends an API request to a protected endpoint.
      * The access token is automatically attached to the header of the request.
@@ -83,7 +82,7 @@ declare class AuthAPI {
      *
      * @param {HttpRequestConfig} config -  The config object containing attributes necessary to send a request.
      *
-     * @return {Promise<FetchResponse>} - Returns a Promise that resolves with the response to the request.
+     * @return {Promise<Response>} - Returns a Promise that resolves with the response to the request.
      */
     httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
     /**
@@ -94,7 +93,7 @@ declare class AuthAPI {
      *
      * @param {HttpRequestConfig[]} config -  The config object containing attributes necessary to send a request.
      *
-     * @return {Promise<FetchResponse[]>} - Returns a Promise that resolves with the responses to the requests.
+     * @return {Promise<Response>} - Returns a Promise that resolves with the responses to the requests.
      */
     httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
     /**
@@ -102,10 +101,10 @@ declare class AuthAPI {
      *
      * @param {CustomGrantRequestParams} config - The request parameters.
      *
-     * @return {Promise<FetchResponse<any> | SignInResponse>} - A Promise that resolves with
+     * @return {Promise<Response | SignInResponse>} - A Promise that resolves with
      * the value returned by the custom grant request.
      */
-    requestCustomGrant(config: SPACustomGrantConfig, callback: (response: BasicUserInfo | FetchResponse<any>) => void, dispatch: (state: AuthStateInterface) => void): Promise<BasicUserInfo | FetchResponse<any>>;
+    exchangeToken(config: SPACustomGrantConfig, callback: (response: User | Response) => void, dispatch: (state: AuthStateInterface) => void): Promise<User | Response>;
     /**
      * This method ends a user session. The access token is revoked and the session information is destroyed.
      *
@@ -117,7 +116,7 @@ declare class AuthAPI {
      *
      * @return {Promise<ServiceResourcesType} - A Promise that resolves with an object containing the service endpoints.
      */
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
     /**
      * This methods returns the Axios http client.
      *
@@ -130,7 +129,7 @@ declare class AuthAPI {
      * @return {Promise<DecodedIDTokenPayloadInterface>} - A Promise that resolves with
      * the decoded payload of the id token.
      */
-    getDecodedIDToken(): Promise<IdTokenPayload>;
+    getDecodedIdToken(): Promise<IdTokenPayload>;
     /**
      * This method decodes the payload of the idp id token and returns it.
      *
@@ -143,7 +142,7 @@ declare class AuthAPI {
      *
      * @return {Promise<string>} - A Promise that resolves with the id token.
      */
-    getIDToken(): Promise<string>;
+    getIdToken(): Promise<string>;
     /**
      * This method return a Promise that resolves with the access token.
      *
@@ -167,13 +166,13 @@ declare class AuthAPI {
      * @return {TokenResponseInterface} - A Promise that resolves with an object containing
      * information about the refreshed access token.
      */
-    refreshAccessToken(): Promise<BasicUserInfo>;
+    refreshAccessToken(): Promise<User>;
     /**
      * This method specifies if the user is authenticated or not.
      *
      * @return {Promise<boolean>} - A Promise that resolves with `true` if teh user is authenticated.
      */
-    isAuthenticated(): Promise<boolean>;
+    isSignedIn(): Promise<boolean>;
     /**
      * This method specifies if the session is active or not.
      *
@@ -198,7 +197,7 @@ declare class AuthAPI {
      *
      * @param {Partial<AuthClientConfig<T>>} config - A config object to update the SDK configurations with.
      */
-    updateConfig(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
     /**
      * This method attaches a callback function to an event hook that fires the callback when the event happens.
      *
@@ -214,7 +213,7 @@ declare class AuthAPI {
      * First, this method sends a prompt none request to see if there is an active user session in the identity server.
      * If there is one, then it requests the access token and stores it. Else, it returns false.
      *
-     * @return {Promise<BasicUserInfo | boolean>} - A Promise that resolves with the user information after signing in
+     * @return {Promise<User | boolean>} - A Promise that resolves with the user information after signing in
      * or with `false` if the user is not signed in.
      *
      * @example
@@ -224,6 +223,6 @@ declare class AuthAPI {
      */
     trySignInSilently(state: AuthStateInterface, dispatch: (state: AuthStateInterface) => void, additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }): Promise<BasicUserInfo | boolean | undefined>;
+    }): Promise<User | boolean | undefined>;
 }
 export default AuthAPI;

package/dist/__temp__/models.d.ts

@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoAuthException, AuthClientConfig, AuthSPAClientConfig, BasicUserInfo, Config, CustomGrantConfig, IdTokenPayload, FetchResponse, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig } from '@asgardeo/browser';
+import { AsgardeoAuthException, AuthClientConfig, AuthSPAClientConfig, Config, TokenExchangeRequestConfig, IdTokenPayload, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, User } from '@asgardeo/browser';
 export interface ReactConfig {
     /**
      * The SDK's `AuthProvider` by default is listening to the URL changes to see
@@ -36,10 +36,6 @@ export type AuthReactConfig = AuthSPAClientConfig & ReactConfig;
  * via `state` object from `useAuthContext` hook.
  */
 export interface AuthStateInterface {
-    /**
-     * The scopes that are allowed for the user.
-     */
-    allowedScopes: string;
     /**
      * The display name of the user.
      */
@@ -51,44 +47,40 @@ export interface AuthStateInterface {
     /**
      * Specifies if the user is authenticated or not.
      */
-    isAuthenticated: boolean;
+    isSignedIn: boolean;
     /**
      * Are the Auth requests loading.
      */
     isLoading: boolean;
-    /**
-     * The uid corresponding to the user who the ID token belonged to.
-     */
-    sub?: string;
     /**
      * The username of the user.
      */
     username?: string;
 }
 export interface AuthContextInterface {
-    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, state?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
+    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, state?: string, callback?: (response: User) => void, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }) => Promise<BasicUserInfo>;
+    }) => Promise<User>;
     signOut: (callback?: (response: boolean) => void) => Promise<boolean>;
-    getBasicUserInfo(): Promise<BasicUserInfo>;
+    getUser(): Promise<User>;
     httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
     httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
-    requestCustomGrant(config: CustomGrantConfig, callback?: (response: BasicUserInfo | FetchResponse<any>) => void): void;
+    exchangeToken(config: TokenExchangeRequestConfig, callback?: (response: User | Response) => void): void;
     revokeAccessToken(): Promise<boolean>;
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
     getHttpClient(): Promise<HttpClientInstance>;
     getDecodedIDPIDToken(): Promise<IdTokenPayload>;
-    getDecodedIDToken(): Promise<IdTokenPayload>;
-    getIDToken(): Promise<string>;
+    getDecodedIdToken(): Promise<IdTokenPayload>;
+    getIdToken(): Promise<string>;
     getAccessToken(): Promise<string>;
-    refreshAccessToken(): Promise<BasicUserInfo>;
-    isAuthenticated(): Promise<boolean>;
+    refreshAccessToken(): Promise<User>;
+    isSignedIn(): Promise<boolean>;
     enableHttpHandler(): Promise<boolean>;
     disableHttpHandler(): Promise<boolean>;
-    updateConfig(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
     trySignInSilently: (additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
         params: Record<string, unknown>;
-    }) => Promise<boolean | BasicUserInfo>;
+    }) => Promise<boolean | User>;
     on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): void;
     on(hook: Exclude<Hooks, Hooks.CustomGrant>, callback: (response?: any) => void): void;
     on(hook: Hooks, callback: (response?: any) => void, id?: string): void;