@asgardeo/auth-react 0.2.1

package/src/authenticate.tsx

@@ -0,0 +1,180 @@
+/**
+ * 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 {
+    AuthClientConfig,
+    BasicUserInfo,
+    CustomGrantConfig,
+    Hooks,
+    HttpRequestConfig,
+    HttpResponse,
+    SignInConfig,
+    SPAUtils
+} from "@asgardeo/auth-spa";
+import React, {
+    FunctionComponent,
+    PropsWithChildren,
+    createContext,
+    useContext,
+    useEffect,
+    useState
+} from "react";
+import AuthAPI from "./api";
+import { AuthContextInterface, AuthReactConfig, AuthStateInterface } from "./models";
+
+const AuthClient = new AuthAPI();
+
+/**
+ * Authentication Context to hold global states in react components.
+ */
+const AuthContext = createContext<AuthContextInterface>(null);
+
+interface AuthProviderPropsInterface {
+    config: AuthClientConfig<AuthReactConfig>;
+}
+
+const AuthProvider: FunctionComponent<PropsWithChildren<AuthProviderPropsInterface>> = (
+    props: PropsWithChildren<AuthProviderPropsInterface>
+) => {
+    const [ state, dispatch ] = useState<AuthStateInterface>(AuthClient.getState());
+    const [ configState, setConfigState ] = useState(null);
+
+    const { children, config } = props;
+
+    const signIn = async(
+        config?: SignInConfig,
+        authorizationCode?: string,
+        sessionState?: string,
+        callback?: (response: BasicUserInfo) => void
+    ) => {
+        await AuthClient.signIn(dispatch, state, config, authorizationCode, sessionState, callback);
+    };
+    const signOut = (callback?) => {
+        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: CustomGrantConfig,
+        callback?: (response: BasicUserInfo | HttpResponse<any>) => void
+    ) => AuthClient.requestCustomGrant(config, callback, dispatch);
+    const revokeAccessToken = () => AuthClient.revokeAccessToken(dispatch);
+    const getOIDCServiceEndpoints = () => AuthClient.getOIDCServiceEndpoints();
+    const getHttpClient = () => AuthClient.getHttpClient();
+    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 = () => AuthClient.trySignInSilently(state, dispatch);
+
+    useEffect(() => {
+        if (state.isAuthenticated) {
+            return;
+        }
+
+        AuthClient.init(config);
+        setConfigState(config);
+    }, [ config ]);
+
+    /**
+     * Try signing in when the component is mounted.
+     */
+    useEffect(() => {
+
+        // 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 not, try to login silently.
+        if (!config.skipRedirectCallback && SPAUtils.hasAuthSearchParamsInURL()) {
+            signIn({ callOnlyOnRedirect: true })
+                .then(() => {
+                    // TODO: Add logs when a logger is available.
+                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
+                })
+                .catch(() => {
+                    // TODO: Add logs when a logger is available.
+                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
+                })
+        } else {
+            // 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.
+            trySignInSilently()
+                .then((_: BasicUserInfo | boolean) => {
+                    // TODO: Add logs when a logger is available.
+                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
+                })
+                .catch(() => {
+                    // TODO: Add logs when a logger is available.
+                    // Tracked here https://github.com/asgardeo/asgardeo-auth-js-sdk/issues/151.
+                });
+        }
+    }, []);
+
+    /**
+     * Render state and special case actions
+     */
+    return (
+        <AuthContext.Provider
+            value={ {
+                disableHttpHandler,
+                enableHttpHandler,
+                getAccessToken,
+                getBasicUserInfo,
+                getDecodedIDToken,
+                getHttpClient,
+                getIDToken,
+                getOIDCServiceEndpoints,
+                httpRequest,
+                httpRequestAll,
+                isAuthenticated,
+                on,
+                refreshAccessToken,
+                requestCustomGrant,
+                revokeAccessToken,
+                signIn,
+                signOut,
+                state,
+                trySignInSilently,
+                updateConfig
+            } }
+        >
+            { configState && children }
+        </AuthContext.Provider>
+    );
+};
+
+const useAuthContext = (): AuthContextInterface => {
+    return useContext(AuthContext);
+};
+
+export { AuthClient, AuthProvider, useAuthContext };

package/src/index.ts

@@ -0,0 +1,23 @@
+/**
+ * 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

@@ -0,0 +1,96 @@
+/**
+ * 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 {
+    AuthClientConfig,
+    BasicUserInfo,
+    Config,
+    CustomGrantConfig,
+    DecodedIDTokenPayload,
+    Hooks,
+    HttpClientInstance,
+    HttpRequestConfig,
+    HttpResponse,
+    OIDCEndpoints,
+    SPAConfig
+} from "@asgardeo/auth-spa";
+
+export interface AuthReactConfig extends SPAConfig {
+    /**
+     * 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;
+}
+
+export interface AuthStateInterface {
+    allowedScopes: string;
+    displayName?: string;
+    email?: string;
+    isAuthenticated: boolean;
+    /**
+     * Are the Auth requests loading.
+     */
+    isLoading: boolean;
+    username: string;
+}
+
+export interface AuthContextInterface {
+    signIn: (callback?) => Promise<void>;
+    signOut: () => void;
+    getBasicUserInfo(): Promise<BasicUserInfo>;
+    httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
+    httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
+    requestCustomGrant(
+        config: CustomGrantConfig,
+        callback?: (response: BasicUserInfo | HttpResponse<any>) => void
+    ): void;
+    revokeAccessToken(): Promise<boolean>;
+    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getHttpClient(): Promise<HttpClientInstance>;
+    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: () => Promise<boolean | BasicUserInfo>;
+    on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): void;
+    on(
+        hook:
+            | Hooks.RevokeAccessToken
+            | Hooks.HttpRequestError
+            | Hooks.HttpRequestFinish
+            | Hooks.HttpRequestStart
+            | Hooks.HttpRequestSuccess
+            | Hooks.Initialize
+            | Hooks.SignIn
+            | Hooks.SignOut,
+        callback: (response?: any) => void
+    ): void;
+    on(hook: Hooks, callback: (response?: any) => void, id?: string): void;
+    state: AuthStateInterface;
+}
+
+export interface SecureRouteInterface {
+    callback: () => void;
+    component: any;
+}

package/src/public-api.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 "./secure-route";

package/src/reducer.ts

@@ -0,0 +1,66 @@
+/**
+ * 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: ""
+};
+
+/**
+ * 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
+            };
+        case AuthContextReducerActionTypes.SET_SIGN_OUT:
+            return {
+                ...state,
+                authenticateInitialState,
+                isLoading: false
+            };
+        case AuthContextReducerActionTypes.SET_PROFILE_INFO:
+            return state
+        default:
+            return state;
+    }
+};
+
+export { authenticateInitialState, authenticateReducer };

package/src/secure-route.tsx

@@ -0,0 +1,58 @@
+/**
+ * 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 React, { FunctionComponent, ReactElement, useEffect } from "react";
+import { Route, RouteProps } from "react-router-dom";
+import { useAuthContext } from "./authenticate";
+import { SecureRouteInterface } from "./models";
+
+/**
+ * Protected route component.
+ *
+ * @param {SecureRouteInterface} props - Props injected in to the component.
+ *
+ * @return {React.ReactElement}
+ */
+const SecureRoute: FunctionComponent<SecureRouteInterface & RouteProps> = (props: SecureRouteInterface & RouteProps
+): ReactElement => {
+    const { state } = useAuthContext();
+
+    const { component: Component, callback, ...rest } = props;
+
+    useEffect(() => {
+        if (!state.isAuthenticated) {
+            callback && callback();
+        }
+
+    }, [ state.isAuthenticated ]);
+
+    if (!state.isAuthenticated) {
+        return null;
+    }
+
+    return (
+        <Route
+            { ...rest }
+            render={ (props) =>
+                <Component { ...props } />
+            }
+        />
+    );
+};
+
+export { SecureRoute };