@databiosphere/findable-ui 46.1.3 → 47.0.2

package/lib/components/common/Button/components/LoginButton/loginButton.styles.js

@@ -0,0 +1,11 @@
+import styled from "@emotion/styled";
+import { ButtonSecondary } from "../ButtonSecondary/buttonSecondary";
+export const LoginButton = styled(ButtonSecondary) `
+  .MuiButton-endIcon {
+    margin-right: -6px;
+  }
+`;
+export const LoginButtonText = styled.span `
+  flex: 1;
+  text-align: left;
+`;

package/lib/components/common/IconButton/components/LoadingIconButton/loadingIconButton.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/**
+ * Mock "loading" icon button - a placeholder element styled like a primary icon button without the use of a button element.
+ */
+export declare const LoadingIconButton: () => JSX.Element;

package/lib/components/common/IconButton/components/LoadingIconButton/loadingIconButton.js

@@ -0,0 +1,10 @@
+import React from "react";
+import { LoadingIcon } from "../../../CustomIcon/components/LoadingIcon/loadingIcon";
+import { MockIconButtonPrimary } from "../../iconButton.styles";
+/**
+ * Mock "loading" icon button - a placeholder element styled like a primary icon button without the use of a button element.
+ */
+export const LoadingIconButton = () => {
+    return (React.createElement(MockIconButtonPrimary, null,
+        React.createElement(LoadingIcon, { fontSize: "small" })));
+};

package/lib/components/common/IconButton/components/LoadingIconButton/loadingIconButton.stories.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0fc72a6d").R, unknown>;
+export default _default;
+export declare const LoadingIconButtonStory: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0fc72a6d").R, unknown>;

package/lib/components/common/IconButton/components/LoadingIconButton/loadingIconButton.stories.js

@@ -0,0 +1,9 @@
+import React from "react";
+import { LoadingIconButton } from "./loadingIconButton";
+export default {
+    component: LoadingIconButton,
+    title: "Components/Common/IconButton/Download",
+};
+const LoadingIconButtonTemplate = () => React.createElement(LoadingIconButton, null);
+export const LoadingIconButtonStory = LoadingIconButtonTemplate.bind({});
+LoadingIconButtonStory.args = {};

package/lib/components/common/ToggleButtonGroup/toggleButtonGroup.js

@@ -22,7 +22,8 @@ export const ToggleButtonGroup = ({ toggleButtons, ...props }) => {
     const onChangeToggleButton = (mouseEvent, newToggleValue, onToggleFn) => {
         if (newToggleValue) {
             setToggleValue(newToggleValue);
-            onToggleFn && onToggleFn();
+            if (onToggleFn)
+                onToggleFn();
         }
     };
     return (React.createElement(MToggleButtonGroup, { exclusive: true, onChange: (e, value) => onChangeToggleButton(e, value, getSelectedToggleButtonAction(toggleButtons, value)), value: toggleValue, ...props }, toggleButtons.map(({ label, value }) => (React.createElement(MToggleButton, { key: label, value: value }, label)))));

package/lib/hooks/useAuthentication/common/constants.d.ts

@@ -0,0 +1,4 @@
+import { LoginResponse, LoginStatus } from "./entities";
+export declare const LOGIN_STATUS_FAILED: LoginStatus<LoginResponse>;
+export declare const LOGIN_STATUS_NOT_STARTED: LoginStatus<LoginResponse>;
+export declare const LOGIN_STATUS_NOT_SUPPORTED: LoginStatus<LoginResponse>;

package/lib/hooks/useAuthentication/common/constants.js

@@ -0,0 +1,19 @@
+import { REQUEST_STATUS } from "./entities";
+export const LOGIN_STATUS_FAILED = {
+    isSuccess: false,
+    isSupported: true,
+    requestStatus: REQUEST_STATUS.FAILED,
+    response: undefined,
+};
+export const LOGIN_STATUS_NOT_STARTED = {
+    isSuccess: false,
+    isSupported: true,
+    requestStatus: REQUEST_STATUS.NOT_STARTED,
+    response: undefined,
+};
+export const LOGIN_STATUS_NOT_SUPPORTED = {
+    isSuccess: false,
+    isSupported: false,
+    requestStatus: REQUEST_STATUS.NOT_STARTED,
+    response: undefined,
+};

package/lib/hooks/useAuthentication/common/entities.d.ts

@@ -0,0 +1,25 @@
+import { GoogleResponse } from "../useFetchGoogleProfile";
+import { TerraNIHResponse } from "../useFetchTerraNIHProfile";
+import { TerraResponse } from "../useFetchTerraProfile";
+import { TerraTermsOfServiceResponse } from "../useFetchTerraTermsOfService";
+export declare enum AUTHENTICATION_STATUS {
+    COMPLETED = "COMPLETED",
+    INCOMPLETE = "INCOMPLETE"
+}
+export type LoginResponse = GoogleResponse | TerraResponse | TerraNIHResponse | TerraTermsOfServiceResponse;
+export interface LoginResponseError {
+    message: string;
+    source: string;
+    statusCode: number;
+}
+export interface LoginStatus<T> {
+    isSuccess: boolean;
+    isSupported: boolean;
+    requestStatus: REQUEST_STATUS;
+    response: T | undefined;
+}
+export declare enum REQUEST_STATUS {
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    NOT_STARTED = "NOT_STARTED"
+}

package/lib/hooks/useAuthentication/common/entities.js

@@ -0,0 +1,11 @@
+export var AUTHENTICATION_STATUS;
+(function (AUTHENTICATION_STATUS) {
+    AUTHENTICATION_STATUS["COMPLETED"] = "COMPLETED";
+    AUTHENTICATION_STATUS["INCOMPLETE"] = "INCOMPLETE";
+})(AUTHENTICATION_STATUS || (AUTHENTICATION_STATUS = {}));
+export var REQUEST_STATUS;
+(function (REQUEST_STATUS) {
+    REQUEST_STATUS["COMPLETED"] = "COMPLETED";
+    REQUEST_STATUS["FAILED"] = "FAILED";
+    REQUEST_STATUS["NOT_STARTED"] = "NOT_STARTED";
+})(REQUEST_STATUS || (REQUEST_STATUS = {}));

package/lib/hooks/useAuthentication/common/utils.d.ts

@@ -0,0 +1,15 @@
+import { LoginResponse, LoginStatus } from "./entities";
+/**
+ * Returns the options for an authentication request.
+ * @param token - Token.
+ * @returns request options.
+ */
+export declare function getAuthenticationRequestOptions(token: string): RequestInit;
+/**
+ * Returns login status.
+ * An undefined endpoint will return a not supported login status,
+ * otherwise a not started login status is returned.
+ * @param endpoint - Endpoint.
+ * @returns initial login status.
+ */
+export declare function initLoginStatus(endpoint?: string): LoginStatus<LoginResponse>;

package/lib/hooks/useAuthentication/common/utils.js

@@ -0,0 +1,25 @@
+import { LOGIN_STATUS_NOT_STARTED, LOGIN_STATUS_NOT_SUPPORTED, } from "./constants";
+/**
+ * Returns the options for an authentication request.
+ * @param token - Token.
+ * @returns request options.
+ */
+export function getAuthenticationRequestOptions(token) {
+    const headers = new Headers();
+    headers.append("authorization", "Bearer " + token);
+    return { headers };
+}
+/**
+ * Returns login status.
+ * An undefined endpoint will return a not supported login status,
+ * otherwise a not started login status is returned.
+ * @param endpoint - Endpoint.
+ * @returns initial login status.
+ */
+export function initLoginStatus(endpoint) {
+    if (!endpoint) {
+        // Endpoint not supported.
+        return LOGIN_STATUS_NOT_SUPPORTED;
+    }
+    return LOGIN_STATUS_NOT_STARTED;
+}

package/lib/hooks/useAuthentication/useAuthentication.d.ts

@@ -0,0 +1,6 @@
+import { AuthContextProps } from "../../providers/authentication";
+/**
+ * Returns authentication context.
+ * @returns authentication context.
+ */
+export declare const useAuthentication: () => AuthContextProps;

package/lib/hooks/useAuthentication/useAuthentication.js

@@ -0,0 +1,9 @@
+import { useContext } from "react";
+import { AuthContext } from "../../providers/authentication";
+/**
+ * Returns authentication context.
+ * @returns authentication context.
+ */
+export const useAuthentication = () => {
+    return useContext(AuthContext);
+};

package/lib/hooks/useAuthentication/useAuthenticationComplete.d.ts

@@ -0,0 +1,6 @@
+import { AUTHENTICATION_STATUS } from "./common/entities";
+/**
+ * Handles the completion of the authentication process.
+ * @param authenticationStatus - Authentication status.
+ */
+export declare const useAuthenticationComplete: (authenticationStatus: AUTHENTICATION_STATUS) => void;

package/lib/hooks/useAuthentication/useAuthenticationComplete.js

@@ -0,0 +1,55 @@
+import Router, { useRouter } from "next/router";
+import { useEffect, useMemo, useRef } from "react";
+import { escapeRegExp } from "../../common/utils";
+import { ROUTE_LOGIN } from "../../providers/authentication";
+import { INACTIVITY_PARAM } from "../useSessionTimeout";
+import { AUTHENTICATION_STATUS } from "./common/entities";
+/**
+ * Handles the completion of the authentication process.
+ * @param authenticationStatus - Authentication status.
+ */
+export const useAuthenticationComplete = (authenticationStatus) => {
+    const { asPath } = useRouter();
+    const routeHistoryRef = useRef(initRouteHistory(asPath));
+    // Maintain a history of routes that have been visited prior to authentication.
+    routeHistoryRef.current = useMemo(() => updateRouteHistory(routeHistoryRef.current, asPath), [asPath]);
+    // Redirect to the previous route after authentication is completed.
+    useEffect(() => {
+        if (authenticationStatus === AUTHENTICATION_STATUS.COMPLETED) {
+            Router.push(routeHistoryRef.current);
+        }
+    }, [authenticationStatus]);
+};
+/**
+ * Initializes route history with the current path.
+ * Returns base path if current path is the login route.
+ * @param path - current browser path.
+ * @returns path to be used as the initial route history.
+ */
+function initRouteHistory(path) {
+    return path === ROUTE_LOGIN ? "/" : removeInactivityTimeoutQueryParam(path);
+}
+/**
+ * Removes the inactivity timeout query parameter from the path.
+ * the inactivity timeout parameter is used to indicate that the session has timed out; remove the parameter to
+ * clear the session timeout banner after the user logs in again.
+ * @param path - Path.
+ * @returns path without the inactivity timeout query parameter.
+ */
+function removeInactivityTimeoutQueryParam(path) {
+    const regex = new RegExp(`\\?${escapeRegExp(INACTIVITY_PARAM)}(?:$|[=&].*)`);
+    return path.replace(regex, "");
+}
+/**
+ * Updates route history with the current path, unless the current path is the LoginView page.
+ * @param prevPath - route history path.
+ * @param path - current browser path.
+ * @returns updated path to be used as the route history.
+ */
+function updateRouteHistory(prevPath, path) {
+    let currentPath = prevPath;
+    if (path !== ROUTE_LOGIN) {
+        currentPath = path;
+    }
+    return removeInactivityTimeoutQueryParam(currentPath);
+}

package/lib/hooks/useAuthentication/useAuthenticationForm.d.ts

@@ -0,0 +1,20 @@
+export interface OnboardingStatus {
+    active: boolean;
+    completed: boolean;
+}
+export declare enum ONBOARDING_STEP {
+    NIH_ACCOUNT = 3,
+    TERRA_ACCOUNT = 1,
+    TERRA_TOS = 2
+}
+interface UseAuthenticationForm {
+    isComplete: boolean;
+    isReady: boolean;
+    onboardingStatusByStep: Map<ONBOARDING_STEP, OnboardingStatus>;
+}
+/**
+ * Handles authentication form onboarding.
+ * @returns onboarding steps and corresponding status.
+ */
+export declare const useAuthenticationForm: () => UseAuthenticationForm;
+export {};

package/lib/hooks/useAuthentication/useAuthenticationForm.js

@@ -0,0 +1,88 @@
+import { AUTHENTICATION_STATUS, } from "./common/entities";
+import { useAuthentication } from "./useAuthentication";
+export var ONBOARDING_STEP;
+(function (ONBOARDING_STEP) {
+    ONBOARDING_STEP[ONBOARDING_STEP["NIH_ACCOUNT"] = 3] = "NIH_ACCOUNT";
+    ONBOARDING_STEP[ONBOARDING_STEP["TERRA_ACCOUNT"] = 1] = "TERRA_ACCOUNT";
+    ONBOARDING_STEP[ONBOARDING_STEP["TERRA_TOS"] = 2] = "TERRA_TOS";
+})(ONBOARDING_STEP || (ONBOARDING_STEP = {}));
+/**
+ * Handles authentication form onboarding.
+ * @returns onboarding steps and corresponding status.
+ */
+export const useAuthenticationForm = () => {
+    const authentication = useAuthentication();
+    const isReady = authentication.authenticationStatus === AUTHENTICATION_STATUS.COMPLETED;
+    const loginStatuses = concatLoginStatuses(authentication).filter(filterLoginStatus);
+    const onboardingStatusByStep = getOnboardingStatusByStep(loginStatuses);
+    const isComplete = isAuthenticationComplete(onboardingStatusByStep);
+    return {
+        isComplete,
+        isReady,
+        onboardingStatusByStep,
+    };
+};
+/**
+ * Returns true if all authentication steps are complete.
+ * @param onboardingStatusByStep - Onboarding status by step.
+ * @returns true if all authentication steps are complete.
+ */
+function isAuthenticationComplete(onboardingStatusByStep) {
+    for (const { completed } of onboardingStatusByStep.values()) {
+        if (!completed) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Returns all login statuses, ordered by onboarding step.
+ * @param authentication - Authentication.
+ * @returns login statuses.
+ */
+function concatLoginStatuses(authentication) {
+    const { terraNIHProfileLoginStatus, terraProfileLoginStatus, terraTOSLoginStatus, } = authentication;
+    return [
+        terraProfileLoginStatus,
+        terraTOSLoginStatus,
+        terraNIHProfileLoginStatus,
+    ];
+}
+/**
+ * Returns true if login is supported.
+ * @param loginStatus - Login status.
+ * @returns true if login is supported.
+ */
+function filterLoginStatus(loginStatus) {
+    return loginStatus.isSupported;
+}
+/**
+ * Returns a map of onboarding steps and their status.
+ * @param loginStatuses - Login statuses.
+ * @returns map of onboarding steps and their status.
+ */
+function getOnboardingStatusByStep(loginStatuses) {
+    const onboardingStatusByStep = new Map();
+    for (let i = 0; i < loginStatuses.length; i++) {
+        const { isSuccess } = loginStatuses[i];
+        onboardingStatusByStep.set(i + 1, {
+            active: isStepActive(isSuccess, onboardingStatusByStep),
+            completed: isSuccess,
+        });
+    }
+    return onboardingStatusByStep;
+}
+/**
+ * Returns true if step is active.
+ * @param isSuccess - Response is successful.
+ * @param onboardingStatusByStep - Onboarding status by step.
+ * @returns true if step is active.
+ */
+function isStepActive(isSuccess, onboardingStatusByStep) {
+    for (const { active } of onboardingStatusByStep.values()) {
+        if (active) {
+            return false;
+        }
+    }
+    return !isSuccess;
+}

package/lib/hooks/useAuthentication/useAuthenticationNIHExpiry.d.ts

@@ -0,0 +1,18 @@
+interface UseAuthenticationNIHExpiry {
+    isReady: boolean;
+    linkExpired?: boolean;
+    linkExpireTime?: number;
+    linkWillExpire?: boolean;
+}
+/**
+ * Handles authentication NIH expiry.
+ * @returns NIH expiry status.
+ */
+export declare const useAuthenticationNIHExpiry: () => UseAuthenticationNIHExpiry;
+/**
+ * Calculates the remaining time in seconds until the given expiration time.
+ * @param expireTime - Expire time in seconds.
+ * @returns remaining time in seconds.
+ */
+export declare function expireTimeInSeconds(expireTime: number): number;
+export {};

package/lib/hooks/useAuthentication/useAuthenticationNIHExpiry.js

@@ -0,0 +1,50 @@
+import { REQUEST_STATUS } from "./common/entities";
+import { useAuthentication } from "./useAuthentication";
+const WARNING_WINDOW_SECONDS = 60 * 60 * 24 * 5; // 5 days.
+/**
+ * Handles authentication NIH expiry.
+ * @returns NIH expiry status.
+ */
+export const useAuthenticationNIHExpiry = () => {
+    const authentication = useAuthentication();
+    const { terraNIHProfileLoginStatus } = authentication;
+    const { requestStatus, response } = terraNIHProfileLoginStatus;
+    const { linkExpireTime } = response || {};
+    const isReady = requestStatus === REQUEST_STATUS.COMPLETED;
+    const linkExpired = hasLinkedNIHAccountExpired(linkExpireTime);
+    const linkWillExpire = isLinkedNIHAccountWillExpire(linkExpireTime);
+    return {
+        isReady,
+        linkExpireTime,
+        linkExpired,
+        linkWillExpire,
+    };
+};
+/**
+ * Calculates the remaining time in seconds until the given expiration time.
+ * @param expireTime - Expire time in seconds.
+ * @returns remaining time in seconds.
+ */
+export function expireTimeInSeconds(expireTime) {
+    return expireTime - Date.now() / 1000;
+}
+/**
+ * Returns true if the linked NIH account has expired.
+ * @param expireTime - Expire time in seconds.
+ * @returns true if the linked NIH account has expired.
+ */
+function hasLinkedNIHAccountExpired(expireTime) {
+    if (!expireTime)
+        return;
+    return expireTimeInSeconds(expireTime) < 0;
+}
+/**
+ * Returns true if the linked NIH account will expire in less than a week.
+ * @param expireTime - Expire time in seconds.
+ * @returns true if the linked NIH account will expire in less than a week.
+ */
+function isLinkedNIHAccountWillExpire(expireTime) {
+    if (!expireTime)
+        return;
+    return expireTimeInSeconds(expireTime) < WARNING_WINDOW_SECONDS;
+}

package/lib/hooks/useAuthentication/useAuthenticationStatus.d.ts

@@ -0,0 +1,20 @@
+import { AUTHENTICATION_STATUS, LoginResponse, LoginStatus } from "./common/entities";
+import { GoogleResponse } from "./useFetchGoogleProfile";
+import { TerraNIHResponse } from "./useFetchTerraNIHProfile";
+import { TerraResponse } from "./useFetchTerraProfile";
+import { TerraTermsOfServiceResponse } from "./useFetchTerraTermsOfService";
+/**
+ * Handles the status of the authentication process.
+ * @param userProfileLoginStatus - User profile login status.
+ * @param terraProfileLoginStatus - Terra profile login status.
+ * @param terraTOSLoginStatus - Terra terms of service login status.
+ * @param terraNIHProfileLoginStatus - Terra NIH profile login status.
+ * @returns authentication status.
+ */
+export declare const useAuthenticationStatus: (userProfileLoginStatus: LoginStatus<GoogleResponse>, terraProfileLoginStatus: LoginStatus<TerraResponse>, terraTOSLoginStatus: LoginStatus<TerraTermsOfServiceResponse>, terraNIHProfileLoginStatus: LoginStatus<TerraNIHResponse>) => AUTHENTICATION_STATUS;
+/**
+ * Returns the authentication status ("INCOMPLETE" or "COMPLETE").
+ * @param loginStatuses - Login statuses.
+ * @returns authentication status.
+ */
+export declare function getAuthenticationStatus(loginStatuses: LoginStatus<LoginResponse>[]): AUTHENTICATION_STATUS;

package/lib/hooks/useAuthentication/useAuthenticationStatus.js

@@ -0,0 +1,32 @@
+import { AUTHENTICATION_STATUS, REQUEST_STATUS, } from "./common/entities";
+/**
+ * Handles the status of the authentication process.
+ * @param userProfileLoginStatus - User profile login status.
+ * @param terraProfileLoginStatus - Terra profile login status.
+ * @param terraTOSLoginStatus - Terra terms of service login status.
+ * @param terraNIHProfileLoginStatus - Terra NIH profile login status.
+ * @returns authentication status.
+ */
+export const useAuthenticationStatus = (userProfileLoginStatus, terraProfileLoginStatus, terraTOSLoginStatus, terraNIHProfileLoginStatus) => {
+    return getAuthenticationStatus([
+        terraNIHProfileLoginStatus,
+        terraProfileLoginStatus,
+        terraTOSLoginStatus,
+        userProfileLoginStatus,
+    ]);
+};
+/**
+ * Returns the authentication status ("INCOMPLETE" or "COMPLETE").
+ * @param loginStatuses - Login statuses.
+ * @returns authentication status.
+ */
+export function getAuthenticationStatus(loginStatuses) {
+    for (const loginStatus of loginStatuses) {
+        if (!loginStatus.isSupported)
+            continue;
+        if (loginStatus.requestStatus === REQUEST_STATUS.NOT_STARTED) {
+            return AUTHENTICATION_STATUS.INCOMPLETE;
+        }
+    }
+    return AUTHENTICATION_STATUS.COMPLETED;
+}

package/lib/hooks/useAuthentication/useFetchGoogleProfile.d.ts

@@ -0,0 +1,21 @@
+import { LoginStatus } from "./common/entities";
+export type UserProfile = GoogleResponse;
+export interface GoogleResponse {
+    email: string;
+    email_verified: boolean;
+    family_name: string;
+    given_name: string;
+    hd: string;
+    locale: string;
+    name: string;
+    picture: string;
+    sub: string;
+}
+type Status = LoginStatus<GoogleResponse>;
+/**
+ * Returns user profile login status from configured endpoint.
+ * @param token - Token.
+ * @returns google profile login status.
+ */
+export declare const useFetchGoogleProfile: (token?: string) => Status;
+export {};

package/lib/hooks/useAuthentication/useFetchGoogleProfile.js

@@ -0,0 +1,41 @@
+import { useCallback, useEffect, useState } from "react";
+import { useAuthenticationConfig } from "../useAuthenticationConfig";
+import { LOGIN_STATUS_FAILED, LOGIN_STATUS_NOT_STARTED, } from "./common/constants";
+import { REQUEST_STATUS } from "./common/entities";
+import { getAuthenticationRequestOptions } from "./common/utils";
+/**
+ * Returns user profile login status from configured endpoint.
+ * @param token - Token.
+ * @returns google profile login status.
+ */
+export const useFetchGoogleProfile = (token) => {
+    const authenticationConfig = useAuthenticationConfig();
+    const { googleGISAuthConfig: { googleProfileEndpoint: endpoint } = {} } = authenticationConfig;
+    const [loginStatus, setLoginStatus] = useState(LOGIN_STATUS_NOT_STARTED);
+    // Fetch google user profile.
+    const fetchEndpointData = useCallback((endpoint, accessToken) => {
+        fetch(endpoint, getAuthenticationRequestOptions(accessToken))
+            .then((response) => response.json())
+            .then((profile) => {
+            setLoginStatus((prevStatus) => ({
+                ...prevStatus,
+                isSuccess: true,
+                requestStatus: REQUEST_STATUS.COMPLETED,
+                response: profile,
+            }));
+        })
+            .catch((err) => {
+            console.log(err); // TODO handle error.
+            setLoginStatus(LOGIN_STATUS_FAILED);
+        });
+    }, []);
+    // Fetches user profile.
+    useEffect(() => {
+        if (!token)
+            return;
+        if (!endpoint)
+            return;
+        fetchEndpointData(endpoint, token);
+    }, [endpoint, fetchEndpointData, token]);
+    return loginStatus;
+};

package/lib/hooks/useAuthentication/useFetchTerraNIHProfile.d.ts

@@ -0,0 +1,18 @@
+import { LoginStatus } from "./common/entities";
+interface DatasetPermission {
+    authorized: boolean;
+    name: string;
+}
+type Status = LoginStatus<TerraNIHResponse>;
+export interface TerraNIHResponse {
+    datasetPermissions: DatasetPermission[];
+    linkedNihUsername: string;
+    linkExpireTime: number;
+}
+/**
+ * Returns Terra NIH login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra NIH login status.
+ */
+export declare const useFetchTerraNIHProfile: (token?: string) => Status;
+export {};

package/lib/hooks/useAuthentication/useFetchTerraNIHProfile.js

@@ -0,0 +1,62 @@
+import { useCallback, useEffect, useState } from "react";
+import { useAuthenticationConfig } from "../useAuthenticationConfig";
+import { LOGIN_STATUS_FAILED } from "./common/constants";
+import { REQUEST_STATUS, } from "./common/entities";
+import { getAuthenticationRequestOptions, initLoginStatus, } from "./common/utils";
+/**
+ * Returns Terra NIH login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra NIH login status.
+ */
+export const useFetchTerraNIHProfile = (token) => {
+    const authenticationConfig = useAuthenticationConfig();
+    const { terraAuthConfig: { terraNIHProfileEndpoint: endpoint } = {} } = authenticationConfig;
+    const [loginStatus, setLoginStatus] = useState(initLoginStatus(endpoint));
+    // Fetch Terra NIH account profile.
+    const fetchEndpointData = useCallback((endpoint, accessToken) => {
+        fetch(endpoint, getAuthenticationRequestOptions(accessToken))
+            .then((response) => response.json())
+            .then((response) => {
+            if (isResponseError(response)) {
+                setLoginStatus(LOGIN_STATUS_FAILED);
+            }
+            else {
+                setLoginStatus((prevStatus) => ({
+                    ...prevStatus,
+                    isSuccess: isResponseSuccess(response),
+                    requestStatus: REQUEST_STATUS.COMPLETED,
+                    response,
+                }));
+            }
+        })
+            .catch((err) => {
+            console.log(err); // TODO handle error.
+            setLoginStatus(LOGIN_STATUS_FAILED);
+        });
+    }, []);
+    // Fetches Terra NIH account profile.
+    useEffect(() => {
+        if (!token)
+            return;
+        if (!endpoint)
+            return;
+        fetchEndpointData(endpoint, token);
+    }, [endpoint, fetchEndpointData, token]);
+    return loginStatus;
+};
+/**
+ * Returns true if response is an error response.
+ * @param response - Response.
+ * @returns true if response is an error response.
+ */
+function isResponseError(response) {
+    return Boolean(response.statusCode);
+}
+/**
+ * Returns true if the user accepted terms of service version is current.
+ * @param response - Response.
+ * @returns true if response is successful.
+ */
+function isResponseSuccess(response) {
+    return Boolean(response.linkedNihUsername);
+}

package/lib/hooks/useAuthentication/useFetchTerraProfile.d.ts

@@ -0,0 +1,24 @@
+import { LoginStatus } from "./common/entities";
+type Status = LoginStatus<TerraResponse>;
+export interface TerraResponse {
+    enabled: TerraResponseEnabled;
+    userInfo: TerraResponseUserInfo;
+}
+interface TerraResponseEnabled {
+    adminEnabled: boolean;
+    allUsersGroup: boolean;
+    google: boolean;
+    ldap: boolean;
+    tosAccepted: boolean;
+}
+interface TerraResponseUserInfo {
+    userEmail: string;
+    userSubjectId: string;
+}
+/**
+ * Returns Terra profile login status from configured endpoint.
+ * @param token - Token.
+ * @returns Terra profile login status.
+ */
+export declare const useFetchTerraProfile: (token?: string) => Status;
+export {};