npm - @databiosphere/findable-ui - Versions diffs - 19.0.0 → 20.0.0 - Mend

@databiosphere/findable-ui 19.0.0 → 20.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (363) hide show

package/src/config/entities.ts CHANGED Viewed

@@ -15,7 +15,9 @@ import { HeroTitle } from "../components/common/Title/title";
 import { FooterProps } from "../components/Layout/components/Footer/footer";
 import { HeaderProps } from "../components/Layout/components/Header/header";
 import { ExploreMode } from "../hooks/useExploreMode";
-import { AuthContextProps } from "../providers/authentication";
+import { AuthState } from "../providers/authentication/auth/types";
+import { UserProfile } from "../providers/authentication/authentication/types";
+import { ProviderId } from "../providers/authentication/common/types";
 import { ExploreState } from "../providers/exploreState";
 import { FileManifestState } from "../providers/fileManifestState";
 import { SystemStatus, SystemStatusResponse } from "../providers/systemStatus";
@@ -33,14 +35,19 @@ export interface AnalyticsConfig {
  * Interface to define the authentication configuration for a given site.
  */
 export interface AuthenticationConfig {
-  googleGISAuthConfig?: GoogleGISAuthConfig;
+  providers?: OAuthProvider[];
+  services?: AuthService[];
   termsOfService?: ReactNode;
-  terraAuthConfig?: TerraAuthConfig;
   text?: ReactNode;
   title: string;
   warning?: ReactNode;
 }
+export interface AuthService {
+  endpoint: Record<string, string>;
+  id: string;
+}
 /**
  * Interface to define the set of components that will be used for the back page.
  */
@@ -216,15 +223,6 @@ export type GetIdFunction<T> = (detail: T) => string;
  */
 export type GetTitleFunction<T> = (detail?: T) => string | undefined;
-/**
- * Google GIS authentication configuration.
- */
-export interface GoogleGISAuthConfig {
-  clientId: string;
-  googleProfileEndpoint: string;
-  scope: string;
-}
 /**
  * Grid track configuration.
  */
@@ -278,12 +276,15 @@ export interface ListViewConfig {
   subTitleHero?: ComponentsConfig;
 }
-/**
- * Interface to define the authentication login notice component.
- */
-export interface LoginNotice {
-  conditionsUrl: string;
-  privacyUrl: string;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Use of `any` is intentional to allow for flexibility in the model.
+export interface OAuthProvider<P = any> {
+  authorization: { params: { scope: string } };
+  clientId: string;
+  icon: ReactNode;
+  id: ProviderId;
+  name: string;
+  profile: (profile: P) => UserProfile;
+  userinfo: string;
 }
 /**
@@ -425,12 +426,6 @@ export interface TabConfig {
   tabName?: string; // Used by the entity view to generate a title for the <Head> component; when label is not typed string.
 }
-export interface TerraAuthConfig {
-  termsOfServiceEndpoint: string;
-  terraNIHProfileEndpoint?: string;
-  terraProfileEndpoint: string;
-}
 /**
  * Theme options function.
  * Defines theme options, and provides a reference to the specified theme.
@@ -441,7 +436,7 @@ export type ThemeOptionsFn = (theme: Theme) => ThemeOptions;
  * View context.
  */
 export interface ViewContext<T extends RowData, TData = unknown> {
-  authState: Pick<AuthContextProps, "authenticationStatus" | "isAuthenticated">;
+  authState: Pick<AuthState, "isAuthenticated">;
   cellContext?: CellContext<T, TData>;
   entityConfig: EntityConfig;
   exploreState: ExploreState;

package/src/hooks/authentication/auth/useAuthReducer.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { useReducer } from "react";
+import { DEFAULT_AUTH_STATE } from "../../../providers/authentication/auth/constants";
+import { authReducer } from "../../../providers/authentication/auth/reducer";
+import { AuthContextProps } from "../../../providers/authentication/auth/types";
+import { initializer } from "../../../providers/authentication/common/utils";
+export const useAuthReducer = (
+  initialState = DEFAULT_AUTH_STATE
+): Omit<AuthContextProps, "service"> => {
+  const [authState, authDispatch] = useReducer(
+    authReducer,
+    initialState,
+    initializer
+  );
+  return { authDispatch, authState };
+};

package/src/hooks/authentication/authentication/useAuthenticationReducer.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { useReducer } from "react";
+import { DEFAULT_AUTHENTICATION_STATE } from "../../../providers/authentication/authentication/constants";
+import { authenticationReducer } from "../../../providers/authentication/authentication/reducer";
+import { AuthenticationContextProps } from "../../../providers/authentication/authentication/types";
+import { initializer } from "../../../providers/authentication/common/utils";
+export const useAuthenticationReducer = (
+  initialState = DEFAULT_AUTHENTICATION_STATE
+): AuthenticationContextProps => {
+  const [authenticationState, authenticationDispatch] = useReducer(
+    authenticationReducer,
+    initialState,
+    initializer
+  );
+  return { authenticationDispatch, authenticationState };
+};

package/src/hooks/authentication/config/useAuthenticationConfig.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { AuthenticationConfig } from "../../../config/entities";
+import { useConfig } from "../../useConfig";
+/**
+ * Returns the authentication configuration.
+ * @returns authentication configuration.
+ */
+export const useAuthenticationConfig = (): AuthenticationConfig | undefined => {
+  const {
+    config: { authentication },
+  } = useConfig();
+  return authentication;
+};

package/src/hooks/authentication/credentials/useCredentialsReducer.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { useReducer } from "react";
+import { DEFAULT_CREDENTIALS_STATE } from "../../../providers/authentication/credentials/constants";
+import { credentialsReducer } from "../../../providers/authentication/credentials/reducer";
+import { CredentialsContextProps } from "../../../providers/authentication/credentials/types";
+export const useCredentialsReducer = (): CredentialsContextProps => {
+  const [credentialsState, credentialsDispatch] = useReducer(
+    credentialsReducer,
+    undefined,
+    () => DEFAULT_CREDENTIALS_STATE
+  );
+  return { credentialsDispatch, credentialsState };
+};

package/src/hooks/authentication/profile/types.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import {
+  Profile,
+  UserProfile,
+} from "../../../providers/authentication/authentication/types";
+export interface UseProfile {
+  isLoading: boolean;
+  profile: Profile<UserProfile>;
+}

package/src/hooks/authentication/profile/useProfile.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import { useAuth } from "../../../providers/authentication/auth/hook";
+import { AUTH_STATUS } from "../../../providers/authentication/auth/types";
+import { useAuthentication } from "../../../providers/authentication/authentication/hook";
+import { UseProfile } from "./types";
+/**
+ * Profile hook - returns user profile.
+ * @returns user profile.
+ */
+export const useProfile = (): UseProfile => {
+  const {
+    authState: { status },
+  } = useAuth();
+  const {
+    authenticationState: { profile },
+  } = useAuthentication();
+  return {
+    isLoading: status === AUTH_STATUS.PENDING,
+    profile: profile,
+  };
+};

package/src/hooks/authentication/providers/types.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { OAuthProvider } from "../../../config/entities";
+import { ProviderId } from "../../../providers/authentication/common/types";
+export interface UseProviders {
+  findProvider: (providerId: ProviderId) => OAuthProvider | undefined;
+  providers: OAuthProvider[] | undefined;
+}

package/src/hooks/authentication/providers/useProviders.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import { useCallback } from "react";
+import { ProviderId } from "../../../providers/authentication/common/types";
+import { useConfig } from "../../useConfig";
+import { UseProviders } from "./types";
+/**
+ * Hook to facilitate the retrieval of authentication providers.
+ * @returns authentication providers and a function to find a provider by id.
+ */
+export const useProviders = (): UseProviders => {
+  const { config } = useConfig();
+  const providers = config.authentication?.providers;
+  const findProvider = useCallback(
+    (providerId: ProviderId) => {
+      return providers?.find(({ id }) => id === providerId);
+    },
+    [providers]
+  );
+  return { findProvider, providers };
+};

package/src/hooks/authentication/session/useSessionActive.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import Router from "next/router";
+import { useEffect } from "react";
+import { escapeRegExp } from "../../../common/utils";
+import {
+  AUTH_STATUS,
+  AuthState,
+} from "../../../providers/authentication/auth/types";
+import {
+  AUTHENTICATION_STATUS,
+  AuthenticationState,
+} from "../../../providers/authentication/authentication/types";
+import { ROUTE } from "../../../routes/constants";
+import { useRouteHistory } from "../../useRouteHistory";
+import { INACTIVITY_PARAM } from "./useSessionTimeout";
+export const useSessionActive = (
+  authState: AuthState,
+  authenticationState: AuthenticationState
+): void => {
+  const { status: authStatus } = authState;
+  const { status: authenticationStatus } = authenticationState;
+  const { callbackUrl } = useRouteHistory(2);
+  const isReady =
+    authenticationStatus === AUTHENTICATION_STATUS.SETTLED &&
+    authStatus === AUTH_STATUS.SETTLED;
+  useEffect(() => {
+    if (!isReady) return;
+    Router.push(callbackUrl(transformRoute));
+  }, [callbackUrl, isReady]);
+};
+/**
+ * Finds the most recent route in the history that is not the login route and removes the inactivity timeout query parameter.
+ * The inactivity timeout query parameter is appended to a URL to indicate that a session has expired. This function iterates
+ * through the history of routes in reverse order, skipping any routes that lead to the login page, and returns the first route
+ * that isn't the login route with the inactivity timeout parameter removed.
+ * @param routes - An array of routes representing the navigation history, in order of navigation.
+ * @returns The most recent valid route without the inactivity timeout parameter, or `undefined` if no such route is found.
+ */
+export function transformRoute(routes: string[]): string | undefined {
+  for (const route of routes) {
+    if (route === ROUTE.LOGIN) {
+      continue;
+    }
+    return route?.replace(
+      new RegExp(`\\?${escapeRegExp(INACTIVITY_PARAM)}(?:$|[=&].*)`),
+      ""
+    );
+  }
+}

package/src/hooks/authentication/session/useSessionCallbackUrl.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import { useMemo } from "react";
+import { useRouteRoot } from "../../useRouteRoot";
+import { INACTIVITY_PARAM } from "./useSessionTimeout";
+export interface UseSessionCallbackUrl {
+  callbackUrl: string | undefined;
+}
+export const useSessionCallbackUrl = (): UseSessionCallbackUrl => {
+  const route = useRouteRoot();
+  const callbackUrl = useMemo(() => getUrl(route), [route]);
+  return { callbackUrl };
+};
+/**
+ * Returns the URL with the inactivity query parameter set to true.
+ * @param url - URL.
+ * @returns URL.
+ */
+function getUrl(url: string): string | undefined {
+  if (typeof window === "undefined") return;
+  const urlObj = new URL(url, window.location.origin);
+  urlObj.searchParams.set(INACTIVITY_PARAM, "true");
+  return urlObj.href;
+}

package/src/hooks/authentication/session/useSessionIdleTimer.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { useIdleTimer } from "react-idle-timer";
+import { IIdleTimerProps } from "react-idle-timer/dist/types/IIdleTimerProps";
+/**
+ * Sets a session timeout that triggers when the user has been idle for the specified duration.
+ * @param idleTimerProps - The parameters for the session timeout.
+ */
+export const useSessionIdleTimer = (idleTimerProps: IIdleTimerProps): void => {
+  useIdleTimer(idleTimerProps);
+};

package/src/hooks/{useSessionTimeout.ts → authentication/session/useSessionTimeout.ts} RENAMED Viewed

@@ -1,7 +1,7 @@
 import Router from "next/router";
 import { useCallback, useEffect, useState } from "react";
-import { useConfig } from "./useConfig";
-import { useLocation } from "./useLocation";
+import { useConfig } from "../../useConfig";
+import { useLocation } from "../../useLocation";
 export const INACTIVITY_PARAM = "inactivityTimeout";

package/src/hooks/{useAuthentication → authentication/terra}/useAuthenticationForm.ts RENAMED Viewed

@@ -1,10 +1,9 @@
-import { AuthContextProps } from "../../providers/authentication";
+import { useTerraProfile } from "../../../providers/authentication/terra/hook";
 import {
-  AUTHENTICATION_STATUS,
   LoginResponse,
   LoginStatus,
-} from "./common/entities";
-import { useAuthentication } from "./useAuthentication";
+} from "../../../providers/authentication/terra/hooks/common/entities";
+import { TerraProfileContextProps } from "../../../providers/authentication/terra/types";
 export interface OnboardingStatus {
   active: boolean;
@@ -19,7 +18,6 @@ export enum ONBOARDING_STEP {
 interface UseAuthenticationForm {
   isComplete: boolean;
-  isReady: boolean;
   onboardingStatusByStep: Map<ONBOARDING_STEP, OnboardingStatus>;
 }
@@ -28,16 +26,13 @@ interface UseAuthenticationForm {
  * @returns onboarding steps and corresponding status.
  */
 export const useAuthenticationForm = (): UseAuthenticationForm => {
-  const authentication = useAuthentication();
-  const isReady =
-    authentication.authenticationStatus === AUTHENTICATION_STATUS.COMPLETED;
+  const terraProfile = useTerraProfile();
   const loginStatuses =
-    concatLoginStatuses(authentication).filter(filterLoginStatus);
+    concatLoginStatuses(terraProfile).filter(filterLoginStatus);
   const onboardingStatusByStep = getOnboardingStatusByStep(loginStatuses);
   const isComplete = isAuthenticationComplete(onboardingStatusByStep);
   return {
     isComplete,
-    isReady,
     onboardingStatusByStep,
   };
 };
@@ -60,17 +55,17 @@ function isAuthenticationComplete(
 /**
  * Returns all login statuses, ordered by onboarding step.
- * @param authentication - Authentication.
+ * @param terraProfile - Terra profile.
  * @returns login statuses.
  */
 function concatLoginStatuses(
-  authentication: AuthContextProps
+  terraProfile: TerraProfileContextProps
 ): LoginStatus<LoginResponse>[] {
   const {
     terraNIHProfileLoginStatus,
     terraProfileLoginStatus,
     terraTOSLoginStatus,
-  } = authentication;
+  } = terraProfile;
   return [
     terraProfileLoginStatus,
     terraTOSLoginStatus,

package/src/hooks/{useAuthentication → authentication/terra}/useAuthenticationNIHExpiry.ts RENAMED Viewed

@@ -1,5 +1,5 @@
-import { REQUEST_STATUS } from "./common/entities";
-import { useAuthentication } from "./useAuthentication";
+import { useTerraProfile } from "../../../providers/authentication/terra/hook";
+import { REQUEST_STATUS } from "../../../providers/authentication/terra/hooks/common/entities";
 const WARNING_WINDOW_SECONDS = 60 * 60 * 24 * 5; // 5 days.
@@ -15,8 +15,7 @@ interface UseAuthenticationNIHExpiry {
  * @returns NIH expiry status.
  */
 export const useAuthenticationNIHExpiry = (): UseAuthenticationNIHExpiry => {
-  const authentication = useAuthentication();
-  const { terraNIHProfileLoginStatus } = authentication;
+  const { terraNIHProfileLoginStatus } = useTerraProfile();
   const { requestStatus, response } = terraNIHProfileLoginStatus;
   const { linkExpireTime } = response || {};
   const isReady = requestStatus === REQUEST_STATUS.COMPLETED;

package/src/hooks/authentication/token/types.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { Credentials } from "../../../providers/authentication/credentials/types";
+export interface UseToken {
+  token: Credentials;
+}

package/src/hooks/authentication/token/useToken.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { useCredentials } from "../../../providers/authentication/credentials/hook";
+import { UseToken } from "./types";
+export const useToken = (): UseToken => {
+  const {
+    credentialsState: { credentials: token },
+  } = useCredentials();
+  return { token };
+};

package/src/hooks/authentication/token/useTokenReducer.ts ADDED Viewed

@@ -0,0 +1,19 @@
+import { useReducer } from "react";
+import { DEFAULT_TOKEN_STATE } from "../../../providers/authentication/token/constants";
+import { tokenReducer } from "../../../providers/authentication/token/reducer";
+import { TokenContextProps } from "../../../providers/authentication/token/types";
+/**
+ * Token reducer: Manages the internal state of the token within the OAuth provider.
+ * This reducer handles the token locally until certain conditions are met.
+ * For releasing the token to the rest of the app, use the credentials reducer.
+ */
+export const useTokenReducer = (): TokenContextProps => {
+  const [tokenState, tokenDispatch] = useReducer(
+    tokenReducer,
+    undefined,
+    () => DEFAULT_TOKEN_STATE
+  );
+  return { tokenDispatch, tokenState };
+};

package/src/hooks/useEntityList.ts CHANGED Viewed

@@ -13,8 +13,8 @@ import { EntityMapper } from "../config/entities";
 import { getEntityConfig } from "../config/utils";
 import { ExploreActionKind } from "../providers/exploreState";
 import { DEFAULT_PAGINATION_STATE } from "../providers/exploreState/initializer/constants";
+import { useToken } from "./authentication/token/useToken";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 import { useConfig } from "./useConfig";
 import { useEntityService } from "./useEntityService";
 import { EXPLORE_MODE, ExploreMode, useExploreMode } from "./useExploreMode";
@@ -31,7 +31,7 @@ export const useEntityList = (
   staticResponse: AzulEntitiesStaticResponse
 ): void => {
   const { data: staticData, entityListType } = staticResponse;
-  const { token } = useAuthentication();
+  const { token } = useToken();
   const { config } = useConfig();
   const { apiPath } = getEntityConfig(config.entities, entityListType);
   const exploreMode = useExploreMode();

package/src/hooks/useFetchEntity.tsx CHANGED Viewed

@@ -2,8 +2,8 @@ import { useRouter } from "next/router";
 import { useEffect, useMemo } from "react";
 import { PARAMS_INDEX_UUID } from "../common/constants";
 import { EntityDetailViewProps } from "../views/EntityDetailView/entityDetailView";
+import { useToken } from "./authentication/token/useToken";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 import { useEntityService } from "./useEntityService";
 import { EXPLORE_MODE, useExploreMode } from "./useExploreMode";
 import { useExploreState } from "./useExploreState";
@@ -23,7 +23,7 @@ export const useFetchEntity = <T,>(
   detailViewProps?: EntityDetailViewProps
 ): UseEntityDetailResponse<T> => {
   const { data: staticData, entityListType } = detailViewProps || {};
-  const { token } = useAuthentication();
+  const { token } = useToken();
   const exploreMode = useExploreMode();
   const { exploreState } = useExploreState();
   const { catalogState } = exploreState;
@@ -37,7 +37,7 @@ export const useFetchEntity = <T,>(
     () =>
       isFetchRequired(
         exploreMode !== EXPLORE_MODE.CS_FETCH_CS_FILTERING,
-        Boolean(token),
+        Boolean(token), // TODO(cc), note a fetch is required if the token is true, but is unable to re-fetch on logout when token is undefined! Page is required to reload!
         Boolean(catalogState),
         Boolean(entityResponse)
       ),

package/src/hooks/useFileManifest/useFetchFilesFacets.ts CHANGED Viewed

@@ -6,8 +6,8 @@ import {
 import { Filters } from "../../common/entities";
 import { fetchEntitiesFromURL } from "../../entity/common/service";
 import { fetchQueryParams, SearchParams } from "../../utils/fetchQueryParams";
+import { useToken } from "../authentication/token/useToken";
 import { useAsync } from "../useAsync";
-import { useAuthentication } from "../useAuthentication/useAuthentication";
 import { useFetchRequestURL } from "../useFetchRequestURL";
 import { FetchFilesFacets } from "./common/entities";
 import { bindEntitySearchResultsResponse } from "./common/utils";
@@ -26,8 +26,7 @@ export const useFetchFilesFacets = (
   searchParams: SearchParams | undefined,
   isEnabled: boolean
 ): FetchFilesFacets => {
-  // Grab token from authentication.
-  const { token } = useAuthentication();
+  const { token } = useToken();
   // Build request params.
   const requestParams = fetchQueryParams(filters, catalog, searchParams);
   // Build request URL.

package/src/hooks/useFileManifest/useFetchSummary.ts CHANGED Viewed

@@ -6,8 +6,8 @@ import {
 import { Filters } from "../../common/entities";
 import { fetchSummaryFromURL } from "../../entity/api/service";
 import { fetchQueryParams } from "../../utils/fetchQueryParams";
+import { useToken } from "../authentication/token/useToken";
 import { useAsync } from "../useAsync";
-import { useAuthentication } from "../useAuthentication/useAuthentication";
 import { useFetchRequestURL } from "../useFetchRequestURL";
 import { FetchFileSummary } from "./common/entities";
@@ -23,8 +23,7 @@ export const useFetchSummary = (
   catalog: string,
   isEnabled: boolean
 ): FetchFileSummary => {
-  // Grab token from authentication.
-  const { token } = useAuthentication();
+  const { token } = useToken();
   // Build request params.
   const requestParams = fetchQueryParams(filters, catalog, undefined);
   // Build request URL.

package/src/hooks/useRequestFileLocation.ts CHANGED Viewed

@@ -4,9 +4,9 @@ import {
   FILE_LOCATION_SUCCESSFULLY,
 } from "../apis/azul/common/constants";
 import { FileLocationResponse } from "../apis/azul/common/entities";
+import { useToken } from "./authentication/token/useToken";
 import { METHOD } from "./types";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 export interface FileLocation {
   commandLine?: { [key: string]: string };
@@ -123,8 +123,7 @@ export const useRequestFileLocation = (
   url?: string,
   method?: Method
 ): UseRequestFileLocationResult => {
-  // Grab token from authentication.
-  const { token } = useAuthentication();
+  const { token } = useToken();
   const {
     data,
     isIdle,

package/src/hooks/useRouteHistory.ts ADDED Viewed

@@ -0,0 +1,65 @@
+import Router, { useRouter } from "next/router";
+import { useCallback, useEffect, useRef } from "react";
+import { useRouteRoot } from "./useRouteRoot";
+const ROUTE_CHANGE_EVENT = "routeChangeComplete";
+const MAX_HISTORY_LENGTH = 4;
+export type TransformRouteFn = (routes: string[]) => string | undefined;
+export interface UseRouteHistory {
+  callbackUrl: (transformFn?: TransformRouteFn) => string;
+}
+export function useRouteHistory(
+  maxHistory = MAX_HISTORY_LENGTH
+): UseRouteHistory {
+  const { asPath } = useRouter();
+  const rootPath = useRouteRoot();
+  const historyRef = useRef<string[]>([asPath]);
+  const onRouteChange = useCallback(
+    (route: string): void => {
+      if (route === historyRef.current[0]) return;
+      historyRef.current.unshift(route);
+      if (historyRef.current.length > maxHistory) {
+        historyRef.current.pop();
+      }
+    },
+    [maxHistory]
+  );
+  useEffect(() => {
+    Router.events.on(ROUTE_CHANGE_EVENT, onRouteChange);
+    return (): void => {
+      Router.events.off(ROUTE_CHANGE_EVENT, onRouteChange);
+    };
+  }, [onRouteChange]);
+  const callbackUrl = useCallback(
+    (transformFn?: TransformRouteFn): string =>
+      getCallbackUrl(historyRef.current, rootPath, transformFn),
+    [rootPath]
+  );
+  return { callbackUrl };
+}
+/**
+ * Generates a callback URL based on the provided history and root path.
+ * Returns the callback URL determined by the transform function or the second item in history and if neither condition is met, returns the root path.
+ * @param history - Navigation history.
+ * @param rootPath - The default root path to return if no other conditions are met.
+ * @param [transformFn] - An optional function that transforms the history array to a specific route.
+ * @returns {string} - The callback UR.
+ */
+export function getCallbackUrl(
+  history: string[],
+  rootPath: string,
+  transformFn?: TransformRouteFn
+): string {
+  if (transformFn) {
+    return transformFn(history) || rootPath;
+  }
+  return history[1] || rootPath;
+}

package/src/hooks/useRouteRoot.ts ADDED Viewed

@@ -0,0 +1,11 @@
+import { useRouter } from "next/router";
+import { useMemo } from "react";
+import { useConfig } from "./useConfig";
+export function useRouteRoot(): string {
+  const {
+    config: { redirectRootToPath: path },
+  } = useConfig();
+  const { basePath } = useRouter();
+  return useMemo(() => `${basePath}${path}`, [basePath, path]);
+}

package/src/hooks/useSummary.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import { useEffect } from "react";
 import { AzulSummaryResponse } from "../apis/azul/common/entities";
+import { useToken } from "./authentication/token/useToken";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 import { useConfig } from "./useConfig";
 import { useEntityService } from "./useEntityService";
 import { useExploreState } from "./useExploreState";
@@ -16,7 +16,7 @@ interface UseSummaryResponse {
  * @returns an object with the loaded data and a flag indicating is the data is loading
  */
 export const useSummary = (): UseSummaryResponse => {
-  const { token } = useAuthentication();
+  const { token } = useToken();
   const { config } = useConfig();
   const { exploreState } = useExploreState();
   const { filterState } = exploreState;
@@ -39,7 +39,7 @@ export const useSummary = (): UseSummaryResponse => {
     return { isLoading: false }; //TODO: return a summary placeholder
   }
-  // Return the fetch status and summary data once fetch is complete..
+  // Return the fetch status and summary data once fetch is complete.
   return {
     isLoading: apiIsLoading,
     response,