@databiosphere/findable-ui 50.6.0 → 50.7.0

package/lib/components/common/Banner/components/SessionTimeout/sessionTimeout.styles.d.ts

@@ -0,0 +1,3 @@
+export declare const Banner: import("@emotion/styled").StyledComponent<import("../BannerPrimary/bannerPrimary").BannerPrimaryProps & {
+    theme?: import("@emotion/react").Theme;
+}, {}, {}>;

package/lib/components/common/Banner/components/SessionTimeout/sessionTimeout.styles.js

@@ -0,0 +1,21 @@
+import styled from "@emotion/styled";
+import { mediaDesktopUp } from "../../../../../styles/common/mixins/breakpoints";
+import { BannerPrimary } from "../BannerPrimary/bannerPrimary";
+export const Banner = styled(BannerPrimary) `
+  gap: 12px;
+  padding: 8px 12px;
+
+  ${mediaDesktopUp} {
+    padding: 8px 16px;
+  }
+
+  .MuiAlert-message {
+    align-self: center;
+    flex: 1;
+  }
+
+  .MuiAlert-action {
+    margin: -8px;
+    padding: 0;
+  }
+`;

package/lib/components/common/Button/components/LoginButton/loginButton.d.ts

@@ -0,0 +1,3 @@
+import { ButtonProps } from "../../button";
+export type LoginButtonProps = Exclude<ButtonProps, "StartIcon">;
+export declare const LoginButton: ({ children, ...props }: LoginButtonProps) => JSX.Element;

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

@@ -0,0 +1,6 @@
+import React from "react";
+import { LoginButton as Button, LoginButtonText } from "./loginButton.styles";
+export const LoginButton = ({ children, ...props }) => {
+    return (React.createElement(Button, { fullWidth: true, ...props },
+        React.createElement(LoginButtonText, null, children)));
+};

package/lib/components/common/Button/components/LoginButton/loginButton.styles.d.ts

@@ -0,0 +1,7 @@
+export declare const LoginButton: import("@emotion/styled").StyledComponent<Omit<import("../../button").ButtonProps, "ref"> & import("react").RefAttributes<HTMLButtonElement> & {
+    theme?: import("@emotion/react").Theme;
+}, {}, {}>;
+export declare const LoginButtonText: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme;
+    as?: React.ElementType;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;

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/CustomIcon/components/AiIcon/aiIcon.d.ts

@@ -0,0 +1,2 @@
+import { SvgIconProps } from "@mui/material";
+export declare const AiIcon: ({ fontSize, viewBox, ...props }: SvgIconProps) => JSX.Element;

package/lib/components/common/CustomIcon/components/AiIcon/aiIcon.js

@@ -0,0 +1,6 @@
+import { SvgIcon } from "@mui/material";
+import React from "react";
+export const AiIcon = ({ fontSize = "xsmall", viewBox = "0 0 18 18", ...props }) => {
+    return (React.createElement(SvgIcon, { fontSize: fontSize, viewBox: viewBox, ...props },
+        React.createElement("path", { d: "M11.1162 6.90234C11.2961 6.9024 11.4745 6.95105 11.6299 7.0459C11.7834 7.15171 11.9008 7.30216 11.9668 7.47656L12.4541 8.94238C12.5992 9.39219 12.8493 9.80169 13.1836 10.1357C13.5179 10.4698 13.9271 10.7196 14.377 10.8643L15.8086 11.3711C15.9838 11.4261 16.1357 11.5388 16.2393 11.6904C16.3538 11.8377 16.4141 12.0176 16.4141 12.2041C16.4201 12.3885 16.3638 12.5695 16.2539 12.7178C16.1489 12.8712 15.9952 12.9849 15.8174 13.0391L14.376 13.5176C13.9309 13.6649 13.5259 13.9143 13.1953 14.2432C12.8635 14.5732 12.6151 14.9777 12.4707 15.4229L11.9639 16.8564C11.9131 17.0291 11.8064 17.18 11.6611 17.2861C11.5075 17.3914 11.3249 17.4481 11.1387 17.4473C10.9518 17.4552 10.7677 17.4003 10.6152 17.292C10.4626 17.1835 10.3499 17.0269 10.2959 16.8477L9.81543 15.4082C9.67122 14.9623 9.42202 14.5571 9.08984 14.2266C8.75607 13.8994 8.35384 13.6486 7.91211 13.4932L6.4707 13.0225C6.30005 12.9623 6.1501 12.8536 6.04004 12.71C5.92966 12.5587 5.86835 12.3767 5.86426 12.1895C5.8602 12.0023 5.91297 11.818 6.0166 11.6621C6.12376 11.5087 6.28117 11.3967 6.46094 11.3447L7.91016 10.8643C8.36039 10.7198 8.76986 10.4698 9.10449 10.1357C9.43912 9.80168 9.68974 9.39237 9.83496 8.94238L10.3145 7.51953C10.3633 7.34377 10.4677 7.18839 10.6123 7.07715C10.7569 6.96592 10.9338 6.90453 11.1162 6.90234ZM3.95801 2.82129C4.12861 2.81526 4.29719 2.86268 4.43945 2.95703C4.58008 3.05192 4.68784 3.18609 4.75 3.34473L5.10547 4.42285C5.20929 4.72108 5.37924 4.99253 5.60254 5.21582C5.82576 5.43896 6.09645 5.60911 6.39453 5.71289L7.44824 6.07617C7.60554 6.13033 7.74148 6.23319 7.83594 6.37012C7.93346 6.50778 7.98686 6.67407 7.9873 6.84277C7.9873 7.00805 7.93636 7.17082 7.84473 7.30664C7.7462 7.44318 7.60737 7.54552 7.44824 7.60059L6.38477 7.95605C6.08795 8.05868 5.81737 8.22579 5.59277 8.44531C5.37385 8.67009 5.20759 8.94062 5.10547 9.2373L4.74219 10.2832C4.69127 10.4445 4.58709 10.5836 4.44727 10.6787C4.30958 10.7762 4.14528 10.8287 3.97656 10.8291C3.80348 10.8284 3.63463 10.7733 3.49512 10.6709C3.36155 10.5712 3.26187 10.4325 3.20898 10.2744L2.86328 9.2207C2.7618 8.92528 2.59446 8.65685 2.37402 8.43555C2.15786 8.21005 1.8886 8.04258 1.59082 7.94824L0.536133 7.59277C0.373071 7.54121 0.231772 7.43734 0.132812 7.29785C0.0654437 7.19277 0.0217393 7.074 0.00585938 6.9502C-0.00996064 6.82648 0.00237279 6.70062 0.0410156 6.58203C0.0796627 6.46357 0.143911 6.35521 0.229492 6.26465C0.315194 6.17404 0.419905 6.10284 0.536133 6.05762L1.59082 5.71387C1.88888 5.60991 2.15969 5.4401 2.38281 5.2168C2.60612 4.99321 2.77627 4.72139 2.87988 4.42285L3.22559 3.38574C3.27404 3.22976 3.36761 3.09134 3.49512 2.98926C3.6284 2.88694 3.79014 2.82858 3.95801 2.82129ZM10.5156 0C10.6744 0.00096508 10.8295 0.0481569 10.9619 0.135742C11.0814 0.223688 11.1752 0.342585 11.2324 0.479492L11.4092 1.01953C11.4462 1.12253 11.503 1.21738 11.5771 1.29785C11.6552 1.37117 11.7475 1.42785 11.8477 1.46582L12.3789 1.64258C12.5138 1.69519 12.6326 1.78307 12.7227 1.89648C12.8148 2.0212 12.8657 2.17211 12.8672 2.32715C12.8604 2.48067 12.8099 2.62938 12.7227 2.75586C12.6359 2.87601 12.5125 2.9664 12.3711 3.01074L11.8477 3.1875C11.7459 3.22224 11.6532 3.28042 11.5771 3.35645C11.5013 3.43235 11.4439 3.52446 11.4092 3.62598L11.2236 4.1582C11.1708 4.2862 11.0866 4.39887 10.9785 4.48535C10.8544 4.58537 10.6994 4.63934 10.54 4.6377C10.3947 4.6291 10.2533 4.58578 10.1279 4.51172C10.0019 4.41845 9.90815 4.28692 9.85742 4.13965L9.68066 3.61816C9.64957 3.51476 9.59193 3.42101 9.5127 3.34766C9.43748 3.26809 9.34767 3.21243 9.24414 3.17969L8.7207 3.01074C8.58124 2.95739 8.45889 2.86686 8.36719 2.74902C8.27882 2.62302 8.23145 2.47218 8.23145 2.31836C8.23828 2.1649 8.28774 2.01608 8.375 1.88965C8.46456 1.77156 8.58796 1.68372 8.72852 1.63672L9.24219 1.46582C9.34512 1.42931 9.43985 1.37247 9.52051 1.29883C9.59458 1.21843 9.65249 1.12437 9.68945 1.02148L9.86621 0.49707C9.91523 0.366571 9.99619 0.250293 10.1025 0.160156C10.2227 0.0698452 10.3661 0.0145692 10.5156 0Z", fill: "currentColor" })));
+};

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/Switch/provider/context.d.ts

@@ -0,0 +1,2 @@
+import { SwitchContextProps } from "./types";
+export declare const SwitchContext: import("react").Context<SwitchContextProps>;

package/lib/components/common/Switch/provider/context.js

@@ -0,0 +1,6 @@
+import { createContext } from "react";
+export const SwitchContext = createContext({
+    checked: false,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars -- Default context implementation requires parameter signature
+    onChange: (e) => { },
+});

package/lib/components/common/Switch/provider/hook.d.ts

@@ -0,0 +1,6 @@
+import { SwitchContextProps } from "./types";
+/**
+ * Returns switch context.
+ * @returns switch context.
+ */
+export declare const useSwitch: () => SwitchContextProps;

package/lib/components/common/Switch/provider/hook.js

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

package/lib/components/common/Switch/provider/provider.d.ts

@@ -0,0 +1,9 @@
+import { SwitchProviderProps } from "./types";
+/**
+ * Switch provider component.
+ * Manages switch state for child components.
+ * @param props - Component props.
+ * @param props.children - Child elements to render.
+ * @returns Switch provider component.
+ */
+export declare function SwitchProvider({ children }: SwitchProviderProps): JSX.Element;

package/lib/components/common/Switch/provider/provider.js

@@ -0,0 +1,16 @@
+import React, { useCallback, useState } from "react";
+import { SwitchContext } from "./context";
+/**
+ * Switch provider component.
+ * Manages switch state for child components.
+ * @param props - Component props.
+ * @param props.children - Child elements to render.
+ * @returns Switch provider component.
+ */
+export function SwitchProvider({ children }) {
+    const [checked, setChecked] = useState(false);
+    const onChange = useCallback((e) => setChecked(e.target.checked), []);
+    return (React.createElement(SwitchContext.Provider, { value: { checked, onChange } }, typeof children === "function"
+        ? children({ checked, onChange })
+        : children));
+}

package/lib/components/common/Switch/provider/types.d.ts

@@ -0,0 +1,6 @@
+import { SwitchProps } from "@mui/material";
+import { ReactNode } from "react";
+export type SwitchContextProps = Pick<SwitchProps, "checked" | "onChange">;
+export type SwitchProviderProps = {
+    children: ReactNode | ((props: SwitchContextProps) => ReactNode);
+};

package/lib/components/common/Switch/provider/types.js

@@ -0,0 +1 @@
+export {};

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 {};