@asgardeo/auth-react 5.1.1 → 5.2.0

package/src/authenticate.tsx

@@ -1,325 +0,0 @@
-/**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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 {
-    AsgardeoAuthException,
-    AsgardeoSPAClient,
-    AuthClientConfig,
-    BasicUserInfo,
-    FetchResponse,
-    Hooks,
-    HttpRequestConfig,
-    SPAUtils,
-    SignInConfig
-} from "@asgardeo/auth-spa";
-import { SPACustomGrantConfig } from "@asgardeo/auth-spa/src/models/request-custom-grant";
-import React, {
-    FunctionComponent,
-    MutableRefObject,
-    PropsWithChildren,
-    ReactNode,
-    createContext,
-    useContext,
-    useEffect,
-    useMemo,
-    useRef,
-    useState
-} from "react";
-import { AuthParams, ReactConfig } from ".";
-import AuthAPI from "./api";
-import { AuthContextInterface, AuthReactConfig, AuthStateInterface } from "./models";
-
-/**
- * Default `AuthReactConfig` config.
- */
-const defaultConfig: Partial<ReactConfig> = {
-    disableAutoSignIn: true,
-    disableTrySignInSilently: true
-};
-
-/**
- * Authentication Context to hold global states in react components.
- */
-const AuthContext = createContext<AuthContextInterface>(null);
-
-interface AuthProviderPropsInterface {
-    config: AuthReactConfig;
-    fallback?: ReactNode;
-    getAuthParams?: () => Promise<AuthParams>;
-    onSignOut?: () => void;
-    plugin?: AsgardeoSPAClient;
-}
-
-const AuthProvider: FunctionComponent<PropsWithChildren<AuthProviderPropsInterface>> = (
-    props: PropsWithChildren<AuthProviderPropsInterface>
-) => {
-    const { children, config: passedConfig, fallback, getAuthParams, onSignOut, plugin } = props;
-    const AuthClient: AuthAPI = useMemo(() => {
-        return new AuthAPI(plugin);
-    }, [ plugin ]);
-
-    const [ state, dispatch ] = useState<AuthStateInterface>(AuthClient.getState());
-    const [ initialized, setInitialized ] = useState(false);
-
-    const config = useMemo(
-        (): AuthReactConfig => ({ ...defaultConfig, ...passedConfig }), [ passedConfig ]
-    );
-
-    const signIn = async(
-        config?: SignInConfig,
-        authorizationCode?: string,
-        sessionState?: string,
-        authState?: string,
-        callback?: (response: BasicUserInfo) => void,
-        tokenRequestConfig?: {
-            params: Record<string, unknown>
-        }
-    ): Promise<BasicUserInfo> => {
-        try {
-            setError(null);
-            return await AuthClient.signIn(
-                dispatch,
-                state,
-                config,
-                authorizationCode,
-                sessionState,
-                authState,
-                callback,
-                tokenRequestConfig
-            );
-        } catch (error) {
-            return Promise.reject(error);
-        }
-    };
-    const signOut = (callback?: (response: boolean) => void): Promise<boolean> => {
-        return AuthClient.signOut(dispatch, state, callback);
-    };
-    const getBasicUserInfo = () => AuthClient.getBasicUserInfo();
-    const httpRequest = (config: HttpRequestConfig) => AuthClient.httpRequest(config);
-    const httpRequestAll = (configs: HttpRequestConfig[]) => AuthClient.httpRequestAll(configs);
-    const requestCustomGrant = (
-        config: SPACustomGrantConfig,
-        callback?: (response: BasicUserInfo | FetchResponse<any>) => void
-    ) => AuthClient.requestCustomGrant(config, callback, dispatch);
-    const revokeAccessToken = () => AuthClient.revokeAccessToken(dispatch);
-    const getOIDCServiceEndpoints = () => AuthClient.getOIDCServiceEndpoints();
-    const getHttpClient = () => AuthClient.getHttpClient();
-    const getDecodedIDPIDToken = () => AuthClient.getDecodedIDPIDToken();
-    const getDecodedIDToken = () => AuthClient.getDecodedIDToken();
-    const getAccessToken = () => AuthClient.getAccessToken();
-    const refreshAccessToken = () => AuthClient.refreshAccessToken();
-    const isAuthenticated = () => AuthClient.isAuthenticated();
-    const enableHttpHandler = () => AuthClient.enableHttpHandler();
-    const disableHttpHandler = () => AuthClient.disableHttpHandler();
-    const getIDToken = () => AuthClient.getIDToken();
-    const updateConfig = (config: Partial<AuthClientConfig<AuthReactConfig>>) => AuthClient.updateConfig(config);
-    const on = (hook: Hooks, callback: (response?: any) => void, id?: string): Promise<void> => {
-        if (hook === Hooks.CustomGrant) {
-            return AuthClient.on(hook, callback, id);
-        }
-
-        return AuthClient.on(hook, callback);
-    };
-    const trySignInSilently = (
-        additionalParams?: Record<string, string | boolean>,
-        tokenRequestConfig?: { params: Record<string, unknown> }
-    ) => AuthClient.trySignInSilently(state, dispatch, additionalParams, tokenRequestConfig);
-    
-    const [ error, setError ] = useState<AsgardeoAuthException>();
-    const reRenderCheckRef: MutableRefObject<boolean> = useRef(false);
-
-    useEffect(() => {
-        if (state.isAuthenticated) {
-            return;
-        }
-        (async () => {
-            setInitialized(await AuthClient.init(config));
-            checkIsAuthenticated();
-        })();
-
-    }, [ config ]);
-
-    /**
-     * Try signing in when the component is mounted.
-     */
-    useEffect(() => {
-        // React 18.x Strict.Mode has a new check for `Ensuring reusable state` to facilitate an upcoming react feature.
-        // https://reactjs.org/docs/strict-mode.html#ensuring-reusable-state
-        // This will remount all the useEffects to ensure that there are no unexpected side effects.
-        // When react remounts the signIn hook of the AuthProvider, it will cause a race condition. Hence, we have to
-        // prevent the re-render of this hook as suggested in the following discussion.
-        // https://github.com/reactwg/react-18/discussions/18#discussioncomment-795623
-        if (reRenderCheckRef.current) {
-            return;
-        }
-
-        reRenderCheckRef.current = true;
-
-        (async () => {
-            let isSignedOut: boolean = false;
-            // If the component was mounted after the user was redirected to the application upon a successful logout,
-            // then the locally stored user session will be cleared as a side effect of registering this sign-out hook.
-            await on(Hooks.SignOut, () => {
-                isSignedOut = true;
-
-                if (onSignOut) {
-                    onSignOut();
-                }
-            });
-
-            // User is already authenticated. Skip...
-            if (state.isAuthenticated) {
-                return;
-            }
-
-            // If `skipRedirectCallback` is not true, check if the URL has `code` and `session_state` params.
-            // If so, initiate the sign in.
-            if (!config.skipRedirectCallback) {
-                let authParams: AuthParams = null;
-                if (getAuthParams && typeof getAuthParams === "function") {
-                    authParams = await getAuthParams();
-                }
-
-                const url = new URL(location.href);
-
-                if ((SPAUtils.hasAuthSearchParamsInURL()
-                    && new URL(url.origin + url.pathname).toString() === new URL(config?.signInRedirectURL).toString())
-                    || authParams?.authorizationCode
-                    || url.searchParams.get("error") )
-                {
-                    try{
-                        await signIn(
-                            { callOnlyOnRedirect: true }, 
-                            authParams?.authorizationCode, 
-                            authParams?.sessionState,
-                            authParams?.state
-                        );
-                        setError(null);
-                    } catch(error) {
-                        if(error && Object.prototype.hasOwnProperty.call(error, "code")) {
-                            setError(error);
-                        }
-                    }
-                }
-            }
-
-            if (AuthClient.getState().isAuthenticated) {
-                return;
-            }
-
-            if (!config.disableAutoSignIn && await AuthClient.isSessionActive()) {
-                signIn();
-            }  
-
-            if (config.disableTrySignInSilently || isSignedOut) {
-                dispatch({ ...state, isLoading: false });
-
-                return;
-            }
-
-            // This uses the RP iframe to get the session. Hence, will not work if 3rd party cookies are disabled.
-            // If the browser has these cookies disabled, we'll not be able to retrieve the session on refreshes.
-            await trySignInSilently()
-                .then(() => {
-                    // TODO: Add logs when a logger is available.
-                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
-                    setError(null);
-                })
-                .catch((error) => {
-                    // TODO: Add logs when a logger is available.
-                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
-                    if(error && Object.prototype.hasOwnProperty.call(error, "code")) {
-                        setError(error);
-                    }
-                });
-        })();
-
-    }, [ config ]);
-
-    /**
-     * Check if the user is authenticated and update the state.isAuthenticated value.
-     */
-    const checkIsAuthenticated = async () => {
-        const isAuthenticatedState = await AuthClient.isAuthenticated();        
-
-        if (isAuthenticatedState) {
-            const response = await AuthClient.getBasicUserInfo();
-
-            if (response) {
-                const stateToUpdate ={
-                    allowedScopes: response.allowedScopes,
-                    displayName: response.displayName,
-                    email: response.email,
-                    isAuthenticated: true,
-                    isLoading: false,
-                    isSigningOut: false,
-                    sub: response.sub,
-                    username: response.username
-                };
-
-                AuthClient.updateState(stateToUpdate);
-                dispatch({ ...state, ...stateToUpdate });
-
-                return;
-            }
-
-            AuthClient.updateState({ ...state, isAuthenticated: isAuthenticatedState, isLoading: false });
-            dispatch({ ...state, isAuthenticated: isAuthenticatedState, isLoading: false });
-        }
-    };
-
-    /**
-     * Render state and special case actions
-     */
-    return (
-            <AuthContext.Provider
-                value={ {
-                    disableHttpHandler,
-                    enableHttpHandler,
-                    getAccessToken,
-                    getBasicUserInfo,
-                    getDecodedIDPIDToken,
-                    getDecodedIDToken,
-                    getHttpClient,
-                    getIDToken,
-                    getOIDCServiceEndpoints,
-                    httpRequest,
-                    httpRequestAll,
-                    isAuthenticated,
-                    on,
-                    refreshAccessToken,
-                    requestCustomGrant,
-                    revokeAccessToken,
-                    signIn,
-                    signOut,
-                    state,
-                    trySignInSilently,
-                    updateConfig,
-                    error
-                } }
-            >
-                { initialized ? children : fallback ?? null }
-            </AuthContext.Provider>
-    );
-};
-
-const useAuthContext = (): AuthContextInterface => {
-    return useContext(AuthContext);
-};
-
-export { AuthProvider, useAuthContext };

package/src/authenticated-component.tsx

@@ -1,43 +0,0 @@
-/**
- * Copyright (c) 2021, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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 React, { FunctionComponent, PropsWithChildren, ReactNode } from "react";
-import { useAuthContext } from "./authenticate";
-
-/**
- * Prop types of the Authenticated component.
- */
-interface AuthenticatedComponentPropsInterface {
-    fallback: ReactNode;
-}
-
-/**
- * This component shows the child component only if the user is authenticated. Otherwise, it shows the placeholder.
- *
- * @param {AuthenticatedComponentPropsInterface} props The props of the component
- * @returns {ReactElement} The authenticated component.
- */
-export const AuthenticatedComponent: FunctionComponent<PropsWithChildren<AuthenticatedComponentPropsInterface>> = (
-    props: PropsWithChildren<AuthenticatedComponentPropsInterface>
-) => {
-
-    const { fallback, children } = props;
-    const { state: { isAuthenticated } } = useAuthContext();
-
-    return <> { isAuthenticated ? children : fallback ?? null } </>;
-};

package/src/index.ts

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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 "core-js";
-import "regenerator-runtime/runtime";
-
-export * from "@asgardeo/auth-spa";
-export * from "./public-api";

package/src/models.ts

@@ -1,138 +0,0 @@
-/**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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 {
-    AsgardeoAuthException,
-    AuthClientConfig,
-    AuthSPAClientConfig,
-    BasicUserInfo,
-    Config,
-    CustomGrantConfig,
-    DecodedIDTokenPayload,
-    FetchResponse,
-    Hooks,
-    HttpClientInstance,
-    HttpRequestConfig,
-    HttpResponse,
-    OIDCEndpoints,
-    SignInConfig
-} from "@asgardeo/auth-spa";
-
-export interface ReactConfig {
-    /**
-     * The SDK's `AuthProvider` by default is listening to the URL changes to see
-     * if `code` & `session_state` search params are available so that it could perform
-     * token exchange. This option could be used to override that behaviour.
-     */
-    skipRedirectCallback?: boolean;
-    /**
-     * The `AuthProvider`, by default, looks for an active session in the server and updates the session information
-     * with the latest session information from the server. This option could be used to disable that behaviour.
-     */
-    disableTrySignInSilently?: boolean;
-    disableAutoSignIn?: boolean;
-}
-
-export type AuthReactConfig = AuthSPAClientConfig & ReactConfig;
-
-/**
- * Interface for the Authenticated state of the user which is exposed
- * 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.
-     */
-    displayName?: string;
-    /**
-     * The email address of the user.
-     */
-    email?: string;
-    /**
-     * Specifies if the user is authenticated or not.
-     */
-    isAuthenticated: 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?: {
-            params: Record<string, unknown>
-        }
-    ) => Promise<BasicUserInfo>;
-    signOut: (callback?: (response: boolean) => void) => Promise<boolean>;
-    getBasicUserInfo(): Promise<BasicUserInfo>;
-    httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
-    httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
-    requestCustomGrant(
-        config: CustomGrantConfig,
-        callback?: (response: BasicUserInfo | FetchResponse<any>) => void
-    ): void;
-    revokeAccessToken(): Promise<boolean>;
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
-    getHttpClient(): Promise<HttpClientInstance>;
-    getDecodedIDPIDToken(): Promise<DecodedIDTokenPayload>;
-    getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
-    getIDToken(): Promise<string>;
-    getAccessToken(): Promise<string>;
-    refreshAccessToken(): Promise<BasicUserInfo>;
-    isAuthenticated(): Promise<boolean>;
-    enableHttpHandler(): Promise<boolean>;
-    disableHttpHandler(): Promise<boolean>;
-    updateConfig(config: Partial<AuthClientConfig<Config>>): Promise<void>;
-    trySignInSilently: (additionalParams?: Record<string, string | boolean>,
-        tokenRequestConfig?: { params: Record<string, unknown> }) => Promise<boolean | BasicUserInfo>;
-    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;
-    state: AuthStateInterface;
-    error: AsgardeoAuthException;
-}
-
-/**
- * The model of the object returned by the `getAuthParams` prop method of the `AuthProvider`.
- */
-export interface AuthParams {
-    authorizationCode?: string;
-    sessionState?: string;
-    state?: string;
-}

package/src/public-api.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) 2021, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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.
- */
-
-export * from "./authenticate";
-export * from "./models";
-export * from "./authenticated-component";
-export * from "./secure-app";

package/src/reducer.ts

@@ -1,68 +0,0 @@
-/**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
- *
- * WSO2 Inc. 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 { AuthContextReducerActionTypes } from "./actions";
-import { AuthStateInterface } from "./models";
-
-/**
- * Initial authenticate state.
- */
-const authenticateInitialState: AuthStateInterface = {
-    allowedScopes: "",
-    displayName: "",
-    email: "",
-    isAuthenticated: false,
-    isLoading: true,
-    username: "",
-    sub: ""
-};
-
-/**
- * Reducer to handle the state of authentication related actions.
- *
- * @param state - Previous state
- * @param action - Action type
- * @returns The new state
- */
-const authenticateReducer = (state, action) => {
-    switch (action.type) {
-        case AuthContextReducerActionTypes.SET_SIGN_IN:
-            return {
-                ...state,
-                allowedScopes: action.payload.allowedScopes,
-                displayName: action.payload.displayName,
-                email: action.payload.email,
-                isAuthenticated: true,
-                isLoading: false,
-                username: action.payload.username,
-                sub: action.payload.sub
-            };
-        case AuthContextReducerActionTypes.SET_SIGN_OUT:
-            return {
-                ...state,
-                authenticateInitialState,
-                isLoading: false
-            };
-        case AuthContextReducerActionTypes.SET_PROFILE_INFO:
-            return state;
-        default:
-            return state;
-    }
-};
-
-export { authenticateInitialState, authenticateReducer };