@databiosphere/findable-ui 19.0.0 → 21.0.0

package/lib/components/TableCreator/options/columnTrackSizing/utils.js

@@ -0,0 +1,83 @@
+import { COLUMN_IDENTIFIER } from "../../../Table/common/columnIdentifier";
+import { isGridTrackMinMax } from "./typeGuards";
+/**
+ * Generates the grid track sizing for a table using a grid layout.
+ * Creates a string value for the `grid-template-columns` CSS property based on the visible columns.
+ * It ensures proper sizing for grouped, system, and non-system columns.
+ * - Grouped columns are excluded from grid sizing as they flex across the table.
+ * - System columns (e.g., "rowPosition" and "rowSelection") have pre-defined sizing.
+ * - Non-system columns collectively fill the table's width. If their total fractional sizing is less than `1fr`, the first non-system column is assigned `1fr` to ensure the table is filled.
+ * @param visibleColumns - Visible columns.
+ * @returns string defining the CSS `grid-template-columns` value for the table.
+ */
+export function getColumnTrackSizing(visibleColumns) {
+    // Precompute track sizing.
+    const trackSizing = [];
+    let columnCount = 0; // Non-system column count.
+    let firstNonSystemColumnIndex = -1;
+    let totalFractionalSize = 0;
+    for (const [i, column] of visibleColumns.entries()) {
+        if (column.getIsGrouped())
+            continue;
+        // Get the column's track size.
+        const columnTrackSize = getColumnTrackSize(column);
+        trackSizing.push(columnTrackSize);
+        // Extract the fractional value (if it exists), and accumulate the total.
+        const frSize = extractFractionalValue(columnTrackSize);
+        if (frSize)
+            totalFractionalSize += frSize;
+        // Skip system columns; track the first non-system column index.
+        if (isSystemColumn(column))
+            continue;
+        if (firstNonSystemColumnIndex < 0)
+            firstNonSystemColumnIndex = i;
+        columnCount++;
+    }
+    // Adjust track sizing for the first non-system column when:
+    // - the table is a single-column table, or
+    // - the total `fr` value is less than 1.
+    if (firstNonSystemColumnIndex >= 0 &&
+        (columnCount === 1 || totalFractionalSize < 1)) {
+        trackSizing[firstNonSystemColumnIndex] = "1fr";
+    }
+    return trackSizing.join(" ");
+}
+/**
+ * Determines the CSS grid track size for a given column.
+ * Calculates the track size for a column based on its width configuration.
+ * If the column's width is defined as a min-max range, it returns a `minmax()` CSS function.
+ * Otherwise, it defaults to the column's width or `1fr` if no width is specified.
+ * @param column - Column.
+ * @returns A string representing the CSS track size for the column. This can be a `minmax()` function or a fixed/flexible value (e.g., `auto`, `1fr`, `200px`).
+ */
+export function getColumnTrackSize(column) {
+    const width = column.columnDef.meta?.width || "1fr";
+    if (isGridTrackMinMax(width)) {
+        return `minmax(${width.min}, ${width.max})`;
+    }
+    return width;
+}
+/**
+ * Returns true if the column is a system column "rowPosition" or "rowSelection".
+ * @param column - Column.
+ * @returns true if the column is a system column.
+ */
+function isSystemColumn(column) {
+    return (column.id === COLUMN_IDENTIFIER.ROW_POSITION ||
+        column.id === COLUMN_IDENTIFIER.ROW_SELECTION);
+}
+/**
+ * Extracts the fractional value (`fr`) from a CSS track size string.
+ * This function parses a CSS track size (e.g., `1fr`, `minmax(168px, 0.5fr)`)
+ * and extracts the numeric fractional value that appears before `fr`.
+ * If the input does not contain a valid fractional value, the function returns `0`.
+ * @param columnTrackSize - The CSS track size string e.g. `1fr`, `minmax(100px, 0.5fr)`, `200px`, or `auto`.
+ * @returns The fractional value as a number, or `0` if no fractional value is found.
+ */
+export function extractFractionalValue(columnTrackSize) {
+    const match = columnTrackSize.match(/([\d.]+)fr/);
+    if (!match)
+        return 0;
+    const value = parseFloat(match[1]);
+    return Number.isNaN(value) ? 0 : value;
+}

package/lib/components/TableCreator/options/hook.js

@@ -1,25 +1,26 @@
 import { useConfig } from "../../../hooks/useConfig";
 import { useExpandedOptions } from "./expanded/hook";
 import { useGroupingOptions } from "./grouping/hook";
+import { useInitialState } from "./initialState/hook";
 import { useRowSelectionOptions } from "./rowSelection/hook";
 import { useSortingOptions } from "./sorting/hook";
+import { useVisibilityOptions } from "./visibility/hook";
 export function useTableOptions() {
-    const { entityConfig: { list: { defaultSort, tableOptions }, }, } = useConfig();
+    const { entityConfig } = useConfig();
+    const tableOptions = entityConfig.list.tableOptions;
     const expandedOptions = useExpandedOptions();
     const groupingOptions = useGroupingOptions();
     const rowSelectionOptions = useRowSelectionOptions();
     const sortingOptions = useSortingOptions();
+    const visibilityOptions = useVisibilityOptions();
+    const initialState = useInitialState(tableOptions);
     return {
         ...expandedOptions,
         ...groupingOptions,
         ...rowSelectionOptions,
         ...sortingOptions, // TODO(cc) merge of all sorting options.
+        ...visibilityOptions,
         ...tableOptions,
-        initialState: {
-            ...tableOptions?.initialState,
-            sorting: defaultSort
-                ? [defaultSort] // TODO(cc) deprecate `defaultSort` in favor of `initialState.sorting`.
-                : tableOptions?.initialState?.sorting,
-        },
+        initialState,
     };
 }

package/lib/components/TableCreator/options/initialState/columnVisibility.d.ts

@@ -0,0 +1,7 @@
+import { RowData, TableOptions, VisibilityState } from "@tanstack/react-table";
+/**
+ * Returns initial column visibility state.
+ * @param tableOptions - Table options.
+ * @returns column visibility state.
+ */
+export declare function getInitialColumnVisibilityState<T extends RowData>(tableOptions?: Partial<TableOptions<T>> | Partial<Omit<TableOptions<T>, "data" | "columns" | "getCoreRowModel">>): VisibilityState;

package/lib/components/TableCreator/options/initialState/columnVisibility.js

@@ -0,0 +1,16 @@
+import { COLUMN_IDENTIFIER } from "../../../Table/common/columnIdentifier";
+/**
+ * Returns initial column visibility state.
+ * @param tableOptions - Table options.
+ * @returns column visibility state.
+ */
+export function getInitialColumnVisibilityState(tableOptions) {
+    const { initialState } = tableOptions || {};
+    const enableRowPosition = Boolean(tableOptions?.enableRowPosition);
+    const enableRowSelection = Boolean(tableOptions?.enableRowSelection);
+    return {
+        [COLUMN_IDENTIFIER.ROW_POSITION]: enableRowPosition,
+        [COLUMN_IDENTIFIER.ROW_SELECTION]: enableRowSelection,
+        ...initialState?.columnVisibility,
+    };
+}

package/lib/components/TableCreator/options/initialState/hook.d.ts

@@ -0,0 +1,2 @@
+import { InitialTableState, RowData, TableOptions } from "@tanstack/react-table";
+export declare function useInitialState<T extends RowData>(tableOptions?: Partial<TableOptions<T>> | Partial<Omit<TableOptions<T>, "data" | "columns" | "getCoreRowModel">>): InitialTableState;

package/lib/components/TableCreator/options/initialState/hook.js

@@ -0,0 +1,10 @@
+import { useMemo } from "react";
+import { getInitialColumnVisibilityState } from "./columnVisibility";
+export function useInitialState(tableOptions) {
+    const { initialState } = tableOptions || {};
+    const columnVisibility = getInitialColumnVisibilityState(tableOptions);
+    return useMemo(() => ({
+        ...initialState,
+        columnVisibility,
+    }), [initialState, columnVisibility]);
+}

package/lib/components/TableCreator/options/visibility/constants.d.ts

@@ -0,0 +1,2 @@
+import { VisibilityOptions } from "@tanstack/react-table";
+export declare const VISIBILITY_OPTIONS: VisibilityOptions;

package/lib/components/TableCreator/options/visibility/constants.js

@@ -0,0 +1,3 @@
+export const VISIBILITY_OPTIONS = {
+    enableHiding: true,
+};

package/lib/components/TableCreator/options/visibility/hook.d.ts

@@ -0,0 +1,2 @@
+import { VisibilityOptions } from "@tanstack/react-table";
+export declare function useVisibilityOptions(): VisibilityOptions;

package/lib/components/TableCreator/options/visibility/hook.js

@@ -0,0 +1,11 @@
+import { useCallback } from "react";
+import { useExploreState } from "../../../../hooks/useExploreState";
+import { updateVisibility } from "../../../../providers/exploreState/actions/updateVisibility/dispatch";
+import { VISIBILITY_OPTIONS } from "./constants";
+export function useVisibilityOptions() {
+    const { exploreDispatch } = useExploreState();
+    const onColumnVisibilityChange = useCallback((updaterOrValue) => {
+        exploreDispatch(updateVisibility({ updaterOrValue }));
+    }, [exploreDispatch]);
+    return { ...VISIBILITY_OPTIONS, onColumnVisibilityChange };
+}

package/lib/components/TableCreator/tableCreator.js

@@ -3,23 +3,14 @@ import { PAPER_PANEL_STYLE } from "../common/Paper/paper";
 import { ComponentCreator } from "../ComponentCreator/ComponentCreator";
 import { Loading } from "../Loading/loading";
 import { COLUMN_DEF } from "../Table/common/columnDef";
-import { arrIncludesSome, getInitialState, sortingFn, } from "../Table/common/utils";
-import { RowSelectionCell } from "../Table/components/TableCell/components/RowSelectionCell/rowSelectionCell";
-import { HeadSelectionCell } from "../Table/components/TableHead/components/HeadSelectionCell/headSelectionCell";
+import { arrIncludesSome, sortingFn } from "../Table/common/utils";
 import { Table } from "../Table/table";
-import { COLUMN_CONFIGS } from "./common/constants";
 import { buildBaseColumnDef } from "./common/utils";
 import { useTableOptions } from "./options/hook";
 import { TableCreator as TableCreatorContainer } from "./tableCreator.styles";
 const createCell = (config) => function CellCreator(cellContext) {
     return (React.createElement(ComponentCreator, { components: [config.componentConfig], response: cellContext.row.original, viewContext: { cellContext } }));
 };
-const createHeaderSelectionCell = () => function CellCreator({ table }) {
-    return React.createElement(HeadSelectionCell, { tableInstance: table });
-};
-const createRowSelectionCell = () => function CellCreator({ row }) {
-    return React.createElement(RowSelectionCell, { row: row });
-};
 export const TableCreator = ({ columns, getRowId, items, listView, loading, }) => {
     const tableOptions = useTableOptions();
     const columnDefs = useMemo(() => columns.reduce((acc, columnConfig) => {
@@ -33,15 +24,10 @@ export const TableCreator = ({ columns, getRowId, items, listView, loading, }) =
     }, [
         /* Initialize column definitions with the "row position" column */
         COLUMN_DEF.ROW_POSITION,
-        /* Initialize column definitions with the "select" column */
-        {
-            ...buildBaseColumnDef(COLUMN_CONFIGS.SELECT),
-            cell: createRowSelectionCell(),
-            header: createHeaderSelectionCell(),
-        },
+        /* Initialize column definitions with the "row selection" column */
+        COLUMN_DEF.ROW_SELECTION,
     ]), [columns]);
-    const initialState = getInitialState(columns);
     return (React.createElement(TableCreatorContainer, null,
         React.createElement(Loading, { appear: false, loading: loading || false, panelStyle: PAPER_PANEL_STYLE.FLUID }),
-        React.createElement(Table, { columns: columnDefs, getRowId: getRowId, initialState: initialState, items: items, listView: listView, loading: loading, tableOptions: tableOptions })));
+        React.createElement(Table, { columns: columnDefs, getRowId: getRowId, items: items, listView: listView, loading: loading, tableOptions: tableOptions })));
 };

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

@@ -1,6 +1,6 @@
 import { Fade } from "@mui/material";
 import React from "react";
-import { useSessionTimeout } from "../../../../../hooks/useSessionTimeout";
+import { useSessionTimeout } from "../../../../../hooks/authentication/session/useSessionTimeout";
 import { Banner } from "../../banner";
 export const SessionTimeout = ({ children, className, content, ...props }) => {
     const { clearSessionTimeout, isSessionTimeout } = useSessionTimeout();

package/lib/components/common/CustomIcon/common/entities.d.ts

@@ -1,5 +1,2 @@
 import { SvgIconProps } from "@mui/material";
-export interface CustomSVGIconProps extends SvgIconProps {
-    fontSize?: SvgIconProps["fontSize"];
-    viewBox?: string;
-}
+export type CustomSVGIconProps = SvgIconProps;

package/lib/components/common/CustomIcon/components/GoogleIcon/googleIcon.d.ts

@@ -1,5 +1,5 @@
-import { CustomSVGIconProps } from "../../common/entities";
+import { SvgIconProps } from "@mui/material";
 /**
  * Custom Google logo icon.
  */
-export declare const GoogleIcon: ({ fontSize, viewBox, ...props }: CustomSVGIconProps) => JSX.Element;
+export declare const GoogleIcon: ({ fontSize, viewBox, ...props }: SvgIconProps) => JSX.Element;

package/lib/components/common/CustomIcon/components/GoogleIcon/googleIcon.js

@@ -3,7 +3,7 @@ import React from "react";
 /**
  * Custom Google logo icon.
  */
-export const GoogleIcon = ({ fontSize = "xsmall", viewBox = "0 0 20 20", ...props /* Spread props to allow for Mui SvgIconProps specific prop overrides e.g. "htmlColor". */ }) => {
+export const GoogleIcon = ({ fontSize = "xsmall", viewBox = "0 0 20 20", ...props }) => {
     return (React.createElement(SvgIcon, { fontSize: fontSize, viewBox: viewBox, ...props },
         React.createElement("path", { d: "M19.7874 10.2249C19.7874 9.56659 19.7291 8.94159 19.6291 8.33325H10.2124V12.0916H15.6041C15.3624 13.3249 14.6541 14.3666 13.6041 15.0749V17.5749H16.8207C18.7041 15.8333 19.7874 13.2666 19.7874 10.2249Z", fill: "#4285F4" }),
         React.createElement("path", { d: "M10.2126 20.0001C12.9126 20.0001 15.1709 19.1001 16.8209 17.5751L13.6043 15.0751C12.7043 15.6751 11.5626 16.0418 10.2126 16.0418C7.60427 16.0418 5.39593 14.2834 4.60427 11.9084H1.2876V14.4834C2.92926 17.7501 6.30427 20.0001 10.2126 20.0001Z", fill: "#34A853" }),

package/lib/config/entities.d.ts

@@ -6,7 +6,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";
@@ -22,13 +24,17 @@ 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.
  */
@@ -75,9 +81,7 @@ export interface CategoryConfig {
  */
 export type ColumnConfig<T extends RowData, TValue = unknown, C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any> = any> = Omit<ColumnDef<T, TValue>, "enableMultiSort"> & {
     columnPinned?: boolean;
-    columnVisible?: boolean;
     componentConfig: ComponentConfig<C, T>;
-    disableHiding?: boolean;
     header: string;
     id: string;
     meta?: ColumnMeta<T, unknown>;
@@ -169,14 +173,6 @@ export type GetIdFunction<T> = (detail: T) => string;
  * Get title function.
  */
 export type GetTitleFunction<T> = (detail?: T) => string | undefined;
-/**
- * Google GIS authentication configuration.
- */
-export interface GoogleGISAuthConfig {
-    clientId: string;
-    googleProfileEndpoint: string;
-    scope: string;
-}
 /**
  * Grid track configuration.
  */
@@ -203,7 +199,6 @@ export type GridTrackSize = GridTrackAuto | GridTrackLength | GridTrackFlex | Gr
  */
 export interface ListConfig<T extends RowData> {
     columns: ColumnConfig<T>[];
-    defaultSort?: ColumnSort;
     tableOptions?: Omit<TableOptions<T>, "columns" | "data" | "getCoreRowModel">;
 }
 /**
@@ -212,19 +207,24 @@ export interface ListConfig<T extends RowData> {
 export interface ListViewConfig {
     disablePagination?: boolean;
     enableDownload?: boolean;
-    enableRowPreview?: boolean;
     enableTab?: boolean;
     listHero?: ComponentsConfig;
     rowPreviewView?: ComponentsConfig;
     rowSelectionView?: ComponentsConfig;
     subTitleHero?: ComponentsConfig;
 }
-/**
- * Interface to define the authentication login notice component.
- */
-export interface LoginNotice {
-    conditionsUrl: string;
-    privacyUrl: string;
+export interface OAuthProvider<P = any> {
+    authorization: {
+        params: {
+            scope: string;
+        };
+    };
+    clientId: string;
+    icon: ReactNode;
+    id: ProviderId;
+    name: string;
+    profile: (profile: P) => UserProfile;
+    userinfo: string;
 }
 /**
  * Option Method.
@@ -345,11 +345,6 @@ export interface TabConfig {
     tabIconPosition?: MTabProps["iconPosition"];
     tabName?: string;
 }
-export interface TerraAuthConfig {
-    termsOfServiceEndpoint: string;
-    terraNIHProfileEndpoint?: string;
-    terraProfileEndpoint: string;
-}
 /**
  * Theme options function.
  * Defines theme options, and provides a reference to the specified theme.
@@ -359,7 +354,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/lib/hooks/authentication/auth/useAuthReducer.d.ts

@@ -0,0 +1,2 @@
+import { AuthContextProps } from "../../../providers/authentication/auth/types";
+export declare const useAuthReducer: (initialState?: import("../../../providers/authentication/auth/types").AuthState) => Omit<AuthContextProps, "service">;

package/lib/hooks/authentication/auth/useAuthReducer.js

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

package/lib/hooks/authentication/authentication/useAuthenticationReducer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticationContextProps } from "../../../providers/authentication/authentication/types";
+export declare const useAuthenticationReducer: (initialState?: import("../../../providers/authentication/authentication/types").AuthenticationState) => AuthenticationContextProps;

package/lib/hooks/authentication/authentication/useAuthenticationReducer.js

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

package/lib/hooks/authentication/config/useAuthenticationConfig.d.ts

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

package/lib/hooks/authentication/config/useAuthenticationConfig.js

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

package/lib/hooks/authentication/credentials/useCredentialsReducer.d.ts

@@ -0,0 +1,2 @@
+import { CredentialsContextProps } from "../../../providers/authentication/credentials/types";
+export declare const useCredentialsReducer: () => CredentialsContextProps;

package/lib/hooks/authentication/credentials/useCredentialsReducer.js

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

package/lib/hooks/authentication/profile/types.d.ts

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

package/lib/hooks/authentication/profile/types.js

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

package/lib/hooks/authentication/profile/useProfile.d.ts

@@ -0,0 +1,6 @@
+import { UseProfile } from "./types";
+/**
+ * Profile hook - returns user profile.
+ * @returns user profile.
+ */
+export declare const useProfile: () => UseProfile;

package/lib/hooks/authentication/profile/useProfile.js

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

package/lib/hooks/authentication/providers/types.d.ts

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

package/lib/hooks/authentication/providers/types.js

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

package/lib/hooks/authentication/providers/useProviders.d.ts

@@ -0,0 +1,6 @@
+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 declare const useProviders: () => UseProviders;

package/lib/hooks/authentication/providers/useProviders.js

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

package/lib/hooks/authentication/session/useSessionActive.d.ts

@@ -0,0 +1,12 @@
+import { AuthState } from "../../../providers/authentication/auth/types";
+import { AuthenticationState } from "../../../providers/authentication/authentication/types";
+export declare const useSessionActive: (authState: AuthState, authenticationState: AuthenticationState) => void;
+/**
+ * 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 declare function transformRoute(routes: string[]): string | undefined;

package/lib/hooks/authentication/session/useSessionActive.js

@@ -0,0 +1,36 @@
+import Router from "next/router";
+import { useEffect } from "react";
+import { escapeRegExp } from "../../../common/utils";
+import { AUTH_STATUS, } from "../../../providers/authentication/auth/types";
+import { AUTHENTICATION_STATUS, } from "../../../providers/authentication/authentication/types";
+import { ROUTE } from "../../../routes/constants";
+import { useRouteHistory } from "../../useRouteHistory";
+import { INACTIVITY_PARAM } from "./useSessionTimeout";
+export const useSessionActive = (authState, authenticationState) => {
+    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) {
+    for (const route of routes) {
+        if (route === ROUTE.LOGIN) {
+            continue;
+        }
+        return route?.replace(new RegExp(`\\?${escapeRegExp(INACTIVITY_PARAM)}(?:$|[=&].*)`), "");
+    }
+}

package/lib/hooks/authentication/session/useSessionCallbackUrl.d.ts

@@ -0,0 +1,4 @@
+export interface UseSessionCallbackUrl {
+    callbackUrl: string | undefined;
+}
+export declare const useSessionCallbackUrl: () => UseSessionCallbackUrl;

package/lib/hooks/authentication/session/useSessionCallbackUrl.js

@@ -0,0 +1,20 @@
+import { useMemo } from "react";
+import { useRouteRoot } from "../../useRouteRoot";
+import { INACTIVITY_PARAM } from "./useSessionTimeout";
+export const 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) {
+    if (typeof window === "undefined")
+        return;
+    const urlObj = new URL(url, window.location.origin);
+    urlObj.searchParams.set(INACTIVITY_PARAM, "true");
+    return urlObj.href;
+}

package/lib/hooks/authentication/session/useSessionIdleTimer.d.ts

@@ -0,0 +1,6 @@
+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 declare const useSessionIdleTimer: (idleTimerProps: IIdleTimerProps) => void;

package/lib/hooks/authentication/session/useSessionIdleTimer.js

@@ -0,0 +1,8 @@
+import { useIdleTimer } from "react-idle-timer";
+/**
+ * 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) => {
+    useIdleTimer(idleTimerProps);
+};

package/lib/hooks/{useSessionTimeout.js → authentication/session/useSessionTimeout.js}

@@ -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";
 /**
  * Session timeout hook.

package/lib/hooks/{useAuthentication → authentication/terra}/useAuthenticationForm.d.ts

@@ -9,7 +9,6 @@ export declare enum ONBOARDING_STEP {
 }
 interface UseAuthenticationForm {
     isComplete: boolean;
-    isReady: boolean;
     onboardingStatusByStep: Map<ONBOARDING_STEP, OnboardingStatus>;
 }
 /**