@databiosphere/findable-ui 34.1.0 → 35.0.2

package/lib/hooks/useEntityListRelatedView.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useEntityListRelatedView = exports.buildRelatedEntityList = void 0;
+const react_1 = require("react");
+const exploreState_1 = require("../providers/exploreState");
+const useAsync_1 = require("./useAsync");
+const useConfig_1 = require("./useConfig");
+const useExploreState_1 = require("./useExploreState");
+/**
+ * Returns related entity lists filtered by related search results.
+ * @param listItems - Entity list items.
+ * @param relatedSearchResult - Related search result.
+ * @param excludedValues - Selected category values to be excluded from related entity lists.
+ * @returns related entities.
+ */
+function buildRelatedEntityList(listItems, relatedSearchResult, excludedValues) {
+    if (relatedSearchResult) {
+        const { resultKey, searchKey, values } = relatedSearchResult;
+        return listItems === null || listItems === void 0 ? void 0 : listItems.filter((listItem) => {
+            if (values.includes(listItem[resultKey].toLowerCase())) {
+                return !(excludedValues === null || excludedValues === void 0 ? void 0 : excludedValues.includes(listItem[searchKey])); // Exclude any row where any of the selected category values matches the corresponding row value.
+            }
+        });
+    }
+}
+exports.buildRelatedEntityList = buildRelatedEntityList;
+/**
+ * Updates related entity list.
+ */
+const useEntityListRelatedView = () => {
+    var _a;
+    const { entityConfig } = (0, useConfig_1.useConfig)();
+    const { exploreDispatch, exploreState } = (0, useExploreState_1.useExploreState)();
+    const { filterState, listItems } = exploreState;
+    const { listView } = entityConfig;
+    const relatedView = listView === null || listView === void 0 ? void 0 : listView.relatedView;
+    const { relatedSearchFn, resultKey, searchKey } = relatedView || {};
+    const { data: relatedSearchResult, run } = (0, useAsync_1.useAsync)();
+    const selectedCategoryValues = (_a = filterState.find(({ categoryKey }) => categoryKey === searchKey)) === null || _a === void 0 ? void 0 : _a.value;
+    (0, react_1.useEffect)(() => {
+        if (relatedSearchFn) {
+            run(relatedSearchFn(searchKey, resultKey, selectedCategoryValues));
+        }
+    }, [relatedSearchFn, resultKey, run, searchKey, selectedCategoryValues]);
+    (0, react_1.useEffect)(() => {
+        if (relatedSearchFn) {
+            exploreDispatch({
+                payload: {
+                    relatedListItems: buildRelatedEntityList(listItems, relatedSearchResult, selectedCategoryValues),
+                },
+                type: exploreState_1.ExploreActionKind.ProcessRelatedResponse,
+            });
+        }
+    }, [
+        exploreDispatch,
+        listItems,
+        relatedSearchFn,
+        relatedSearchResult,
+        selectedCategoryValues,
+    ]);
+};
+exports.useEntityListRelatedView = useEntityListRelatedView;

package/lib/hooks/useExploreMode.d.ts

@@ -0,0 +1,14 @@
+export type ExploreMode = EXPLORE_MODE;
+export declare enum EXPLORE_MODE {
+    CS_FETCH_CS_FILTERING = "CS_FETCH_CS_FILTERING",
+    SS_FETCH_CS_FILTERING = "SS_FETCH_CS_FILTERING",
+    SS_FETCH_SS_FILTERING = "SS_FETCH_SS_FILTERING"
+}
+/**
+ * Returns configured explore mode:
+ * - Client-side fetch, client-side filtering.
+ * - Server-side fetch, client-side filtering.
+ * - Server-side fetch, server-side filtering.
+ * @returns explore mode.
+ */
+export declare const useExploreMode: () => ExploreMode;

package/lib/hooks/useExploreMode.js

@@ -0,0 +1,20 @@
+import { useMemo } from "react";
+import { useConfig } from "./useConfig";
+export var EXPLORE_MODE;
+(function (EXPLORE_MODE) {
+    EXPLORE_MODE["CS_FETCH_CS_FILTERING"] = "CS_FETCH_CS_FILTERING";
+    EXPLORE_MODE["SS_FETCH_CS_FILTERING"] = "SS_FETCH_CS_FILTERING";
+    EXPLORE_MODE["SS_FETCH_SS_FILTERING"] = "SS_FETCH_SS_FILTERING";
+})(EXPLORE_MODE || (EXPLORE_MODE = {}));
+/**
+ * Returns configured explore mode:
+ * - Client-side fetch, client-side filtering.
+ * - Server-side fetch, client-side filtering.
+ * - Server-side fetch, server-side filtering.
+ * @returns explore mode.
+ */
+export const useExploreMode = () => {
+    const { entityConfig } = useConfig();
+    const { exploreMode } = entityConfig;
+    return useMemo(() => exploreMode, [exploreMode]);
+};

package/lib/hooks/useFileManifest/common/buildFileManifestRequestURL.d.ts

@@ -0,0 +1,15 @@
+import { ManifestDownloadFormat } from "../../../apis/azul/common/entities";
+import { Filters } from "../../../common/entities";
+export interface FileManifestRequestURL {
+    requestParams: URLSearchParams;
+    requestURL: string;
+}
+/**
+ * Build up file manifest request params and URL query string for the given search results, catalog and format.
+ * @param url - Data URL.
+ * @param filters - Selected filters.
+ * @param catalog - Configured catalog.
+ * @param manifestFormat - Manifest format.
+ * @returns file manifest request params and URL query string.
+ */
+export declare const buildFileManifestRequestURL: (url: string, filters: Filters, catalog: string, manifestFormat: ManifestDownloadFormat | undefined) => FileManifestRequestURL | undefined;

package/lib/hooks/useFileManifest/common/buildFileManifestRequestURL.js

@@ -0,0 +1,27 @@
+import { AZUL_PARAM, } from "../../../apis/azul/common/entities";
+import { transformFilters } from "../../../apis/azul/common/filterTransformer";
+/**
+ * Build up file manifest request params and URL query string for the given search results, catalog and format.
+ * @param url - Data URL.
+ * @param filters - Selected filters.
+ * @param catalog - Configured catalog.
+ * @param manifestFormat - Manifest format.
+ * @returns file manifest request params and URL query string.
+ */
+export const buildFileManifestRequestURL = (url, filters, catalog, manifestFormat) => {
+    if (!manifestFormat) {
+        return;
+    }
+    // Build request params.
+    const requestParams = new URLSearchParams({
+        [AZUL_PARAM.CATALOG]: catalog,
+        [AZUL_PARAM.FILTERS]: transformFilters(filters),
+        format: manifestFormat,
+    });
+    // Build file manifest URL
+    const requestURL = `${url}fetch/manifest/files?${requestParams.toString()}`;
+    return {
+        requestParams,
+        requestURL,
+    };
+};

package/lib/hooks/useFileManifest/useFileManifestURL.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns data URL for the integrations end point.
+ * @returns data URL for the integrations end point.
+ */
+export declare const useFileManifestURL: () => string;

package/lib/hooks/useFileManifest/useFileManifestURL.js

@@ -0,0 +1,11 @@
+import { useConfig } from "../useConfig";
+/**
+ * Returns data URL for the integrations end point.
+ * @returns data URL for the integrations end point.
+ */
+export const useFileManifestURL = () => {
+    const { config } = useConfig();
+    const { dataSource } = config;
+    const { url } = dataSource;
+    return url;
+};

package/lib/hooks/useFileManifest/useRequestFileManifest.d.ts

@@ -0,0 +1,9 @@
+import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
+import { Filters } from "../../common/entities";
+/**
+ * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
+ * @param fileManifestFormat - File manifest format.
+ * @param initialFilters - Filters to initialize file manifest request.
+ * @param fileSummaryFacetName - File summary facet name.
+ */
+export declare const useRequestFileManifest: (fileManifestFormat: ManifestDownloadFormat | undefined, initialFilters?: Filters | undefined, fileSummaryFacetName?: string) => void;

package/lib/hooks/useFileManifest/useRequestFileManifest.js

@@ -0,0 +1,37 @@
+import { useEffect, useState } from "react";
+import { FileManifestActionKind } from "../../providers/fileManifestState";
+import { useFileManifestState } from "../useFileManifestState";
+/**
+ * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
+ * @param fileManifestFormat - File manifest format.
+ * @param initialFilters - Filters to initialize file manifest request.
+ * @param fileSummaryFacetName - File summary facet name.
+ */
+export const useRequestFileManifest = (fileManifestFormat, initialFilters = [], fileSummaryFacetName) => {
+    // Initial file manifest filter.
+    const [initFilters] = useState(() => initialFilters);
+    // File manifest state.
+    const { fileManifestDispatch } = useFileManifestState();
+    // Fetches file manifest with the given file manifest filters, format.
+    useEffect(() => {
+        fileManifestDispatch({
+            payload: {
+                fileManifestFormat,
+                fileSummaryFacetName,
+                filters: initFilters,
+            },
+            type: FileManifestActionKind.FetchFileManifest,
+        });
+        return () => {
+            fileManifestDispatch({
+                payload: undefined,
+                type: FileManifestActionKind.ClearFileManifest,
+            });
+        };
+    }, [
+        fileManifestDispatch,
+        fileManifestFormat,
+        fileSummaryFacetName,
+        initFilters,
+    ]);
+};

package/lib/hooks/useLayoutState.d.ts

@@ -0,0 +1,6 @@
+import { LayoutStateContextProps } from "../providers/layoutState";
+/**
+ * Returns layout state context.
+ * @returns layout state context.
+ */
+export declare const useLayoutState: () => LayoutStateContextProps;

package/lib/hooks/useLayoutState.js

@@ -0,0 +1,9 @@
+import { useContext } from "react";
+import { LayoutStateContext, } from "../providers/layoutState";
+/**
+ * Returns layout state context.
+ * @returns layout state context.
+ */
+export const useLayoutState = () => {
+    return useContext(LayoutStateContext);
+};

package/lib/hooks/useMenu.d.ts

@@ -0,0 +1,10 @@
+export interface UseMenu {
+    onClose: () => void;
+    onOpen: () => void;
+    open: boolean;
+}
+/**
+ * Menu functionality for menu dropdown.
+ * @returns menu functionality.
+ */
+export declare const useMenu: () => UseMenu;

package/lib/hooks/useMenu.js

@@ -0,0 +1,17 @@
+import { useCallback, useState } from "react";
+/**
+ * Menu functionality for menu dropdown.
+ * @returns menu functionality.
+ */
+export const useMenu = () => {
+    const [open, setOpen] = useState(false);
+    // Closes header menu.
+    const onClose = useCallback(() => {
+        setOpen(false);
+    }, []);
+    // Opens header menu.
+    const onOpen = useCallback(() => {
+        setOpen(true);
+    }, []);
+    return { onClose, onOpen, open };
+};

package/lib/hooks/useMenuWithPosition.d.ts

@@ -0,0 +1,14 @@
+import { MenuProps as MMenuProps } from "@mui/material";
+import { MouseEvent } from "react";
+export interface UseMenuWithPosition {
+    anchorEl: MMenuProps["anchorEl"];
+    onClose: () => void;
+    onOpen: (event: MouseEvent<HTMLElement>) => void;
+    onToggleOpen: (event: MouseEvent<HTMLElement>) => void;
+    open: boolean;
+}
+/**
+ * Menu functionality for menu dropdown, with menu position.
+ * @returns menu functionality.
+ */
+export declare const useMenuWithPosition: () => UseMenuWithPosition;

package/lib/hooks/useMenuWithPosition.js

@@ -0,0 +1,33 @@
+import { useCallback, useMemo, useState } from "react";
+/**
+ * Menu functionality for menu dropdown, with menu position.
+ * @returns menu functionality.
+ */
+export const useMenuWithPosition = () => {
+    const [anchorEl, setAnchorEl] = useState(null);
+    const open = useMemo(() => Boolean(anchorEl), [anchorEl]);
+    // Closes header menu.
+    const onClose = useCallback(() => {
+        setAnchorEl(null);
+    }, []);
+    // Opens header menu.
+    const onOpen = useCallback((event) => {
+        setAnchorEl(event.currentTarget);
+    }, []);
+    // Toggles menu open/close.
+    const onToggleOpen = useCallback((event) => {
+        if (open) {
+            setAnchorEl(null);
+        }
+        else {
+            setAnchorEl(event.currentTarget);
+        }
+    }, [open]);
+    return {
+        anchorEl,
+        onClose,
+        onOpen,
+        onToggleOpen,
+        open,
+    };
+};

package/lib/hooks/useSessionTimeout.d.ts

@@ -0,0 +1,11 @@
+export declare const INACTIVITY_PARAM = "inactivityTimeout";
+interface UseSessionTimeout {
+    clearSessionTimeout: () => void;
+    isSessionTimeout: boolean;
+}
+/**
+ * Session timeout hook.
+ * @returns flag indicating if the session has timed out.
+ */
+export declare const useSessionTimeout: () => UseSessionTimeout;
+export {};

package/lib/hooks/useSessionTimeout.js

@@ -0,0 +1,28 @@
+import Router from "next/router";
+import { useCallback, useEffect, useState } from "react";
+import { useConfig } from "./useConfig";
+import { useLocation } from "./useLocation";
+export const INACTIVITY_PARAM = "inactivityTimeout";
+/**
+ * Session timeout hook.
+ * @returns flag indicating if the session has timed out.
+ */
+export const useSessionTimeout = () => {
+    const { config: { redirectRootToPath }, } = useConfig();
+    const [isSessionTimeout, setIsSessionTimeout] = useState(false);
+    // Get the session timeout from URL parameters.
+    const { search } = useLocation() || {};
+    const sessionTimeout = search?.get(INACTIVITY_PARAM);
+    // Clears session timeout state.
+    const clearSessionTimeout = useCallback(() => {
+        setIsSessionTimeout(false);
+        Router.replace(redirectRootToPath);
+    }, [redirectRootToPath]);
+    useEffect(() => {
+        setIsSessionTimeout(sessionTimeout === "true");
+    }, [sessionTimeout]);
+    return {
+        clearSessionTimeout,
+        isSessionTimeout,
+    };
+};

package/lib/providers/authentication.d.ts

@@ -0,0 +1,51 @@
+import React, { ReactNode } from "react";
+import { AUTHENTICATION_STATUS, LoginStatus } from "../hooks/useAuthentication/common/entities";
+import { UserProfile } from "../hooks/useAuthentication/useFetchGoogleProfile";
+import { TerraNIHResponse } from "../hooks/useAuthentication/useFetchTerraNIHProfile";
+import { TerraResponse } from "../hooks/useAuthentication/useFetchTerraProfile";
+import { TerraTermsOfServiceResponse } from "../hooks/useAuthentication/useFetchTerraTermsOfService";
+export declare const ROUTE_LOGIN = "/login";
+type AuthenticateUserFn = () => void;
+type RequestAuthenticationFn = () => void;
+/**
+ * Model of authentication context.
+ */
+export interface AuthContextProps {
+    authenticateUser: AuthenticateUserFn;
+    authenticationStatus: AUTHENTICATION_STATUS;
+    isAuthenticated: boolean;
+    isEnabled: boolean;
+    requestAuthentication: RequestAuthenticationFn;
+    terraNIHProfileLoginStatus: LoginStatus<TerraNIHResponse>;
+    terraProfileLoginStatus: LoginStatus<TerraResponse>;
+    terraTOSLoginStatus: LoginStatus<TerraTermsOfServiceResponse>;
+    token?: string;
+    userProfile?: UserProfile;
+}
+/**
+ * Auth context for storing and using auth-related state.
+ */
+export declare const AuthContext: React.Context<AuthContextProps>;
+interface Props {
+    children: ReactNode | ReactNode[];
+    sessionTimeout?: number;
+}
+/**
+ * Auth provider for consuming components to subscribe to changes in auth-related state.
+ * @param props - Component inputs.
+ * @param props.children - Set of children components that can possibly consume the query provider.
+ * @param props.sessionTimeout - If provided, will set the value for a session timeout (in milliseconds).
+ * @returns Provider element to be used by consumers to both update authentication state and subscribe to changes in authentication state.
+ */
+export declare function AuthProvider({ children, sessionTimeout }: Props): JSX.Element;
+/**
+ * Token is released for the following conditions:
+ * - Terra endpoint is configured and the terms of service response is successful, or
+ * - Terra endpoint is not configured and the user profile response is successful.
+ * @param userProfileLoginStatus - User profile login status.
+ * @param terraProfileLoginStatus - Terra profile login status.
+ * @param terraTOSLoginStatus - Terra terms of service login status.
+ * @returns true if the token should be released.
+ */
+export declare function shouldReleaseToken(userProfileLoginStatus: LoginStatus<UserProfile>, terraProfileLoginStatus: LoginStatus<TerraResponse>, terraTOSLoginStatus: LoginStatus<TerraTermsOfServiceResponse>): boolean;
+export {};

package/lib/providers/authentication.js

@@ -0,0 +1,110 @@
+import Router, { useRouter } from "next/router";
+import React, { createContext, useCallback } from "react";
+import { useIdleTimer } from "react-idle-timer";
+import { LOGIN_STATUS_NOT_STARTED } from "../hooks/useAuthentication/common/constants";
+import { AUTHENTICATION_STATUS, } from "../hooks/useAuthentication/common/entities";
+import { useAuthenticationComplete } from "../hooks/useAuthentication/useAuthenticationComplete";
+import { useAuthenticationStatus } from "../hooks/useAuthentication/useAuthenticationStatus";
+import { useFetchGoogleProfile, } from "../hooks/useAuthentication/useFetchGoogleProfile";
+import { useFetchTerraNIHProfile, } from "../hooks/useAuthentication/useFetchTerraNIHProfile";
+import { useFetchTerraProfile, } from "../hooks/useAuthentication/useFetchTerraProfile";
+import { useFetchTerraTermsOfService, } from "../hooks/useAuthentication/useFetchTerraTermsOfService";
+import { useTokenClient } from "../hooks/useAuthentication/useTokenClient";
+import { useConfig } from "../hooks/useConfig";
+import { INACTIVITY_PARAM } from "../hooks/useSessionTimeout";
+// Template constants
+export const ROUTE_LOGIN = "/login";
+/**
+ * Auth context for storing and using auth-related state.
+ */
+export const AuthContext = createContext({
+    // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
+    authenticateUser: () => { },
+    authenticationStatus: AUTHENTICATION_STATUS.INCOMPLETE,
+    isAuthenticated: false,
+    isEnabled: false,
+    // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
+    requestAuthentication: () => { },
+    terraNIHProfileLoginStatus: LOGIN_STATUS_NOT_STARTED,
+    terraProfileLoginStatus: LOGIN_STATUS_NOT_STARTED,
+    terraTOSLoginStatus: LOGIN_STATUS_NOT_STARTED,
+    token: undefined,
+    userProfile: undefined,
+});
+/**
+ * Auth provider for consuming components to subscribe to changes in auth-related state.
+ * @param props - Component inputs.
+ * @param props.children - Set of children components that can possibly consume the query provider.
+ * @param props.sessionTimeout - If provided, will set the value for a session timeout (in milliseconds).
+ * @returns Provider element to be used by consumers to both update authentication state and subscribe to changes in authentication state.
+ */
+export function AuthProvider({ children, sessionTimeout }) {
+    const { config } = useConfig();
+    const { authentication, redirectRootToPath } = config;
+    const { basePath } = useRouter();
+    const { token, tokenClient } = useTokenClient();
+    const terraNIHProfileLoginStatus = useFetchTerraNIHProfile(token);
+    const terraProfileLoginStatus = useFetchTerraProfile(token);
+    const terraTOSLoginStatus = useFetchTerraTermsOfService(token);
+    const userProfileLoginStatus = useFetchGoogleProfile(token);
+    const isEnabled = Boolean(authentication);
+    const isAuthenticated = userProfileLoginStatus.isSuccess;
+    const releaseToken = shouldReleaseToken(userProfileLoginStatus, terraProfileLoginStatus, terraTOSLoginStatus);
+    const authenticationStatus = useAuthenticationStatus(userProfileLoginStatus, terraProfileLoginStatus, terraTOSLoginStatus, terraNIHProfileLoginStatus);
+    // Handle completion of authentication process.
+    useAuthenticationComplete(authenticationStatus);
+    /**
+     * If sessionTimeout is set and user is authenticated, the app will reload and redirect to
+     * origin, including base path, root path, and query param.
+     */
+    useIdleTimer({
+        onIdle: () => isAuthenticated &&
+            sessionTimeout &&
+            (window.location.href =
+                window.location.origin +
+                    basePath +
+                    redirectRootToPath +
+                    "?" +
+                    `${INACTIVITY_PARAM}=true`),
+        timeout: sessionTimeout,
+    });
+    /**
+     * Requests access token and authenticates user.
+     */
+    const authenticateUser = useCallback(() => {
+        tokenClient.requestAccessToken();
+    }, [tokenClient]);
+    /**
+     * Navigates to login page.
+     */
+    const requestAuthentication = useCallback(() => {
+        Router.push(ROUTE_LOGIN);
+    }, []);
+    return (React.createElement(AuthContext.Provider, { value: {
+            authenticateUser,
+            authenticationStatus,
+            isAuthenticated,
+            isEnabled,
+            requestAuthentication,
+            terraNIHProfileLoginStatus,
+            terraProfileLoginStatus,
+            terraTOSLoginStatus,
+            token: releaseToken ? token : undefined,
+            userProfile: userProfileLoginStatus.response,
+        } }, children));
+}
+/**
+ * Token is released for the following conditions:
+ * - Terra endpoint is configured and the terms of service response is successful, or
+ * - Terra endpoint is not configured and the user profile response is successful.
+ * @param userProfileLoginStatus - User profile login status.
+ * @param terraProfileLoginStatus - Terra profile login status.
+ * @param terraTOSLoginStatus - Terra terms of service login status.
+ * @returns true if the token should be released.
+ */
+export function shouldReleaseToken(userProfileLoginStatus, terraProfileLoginStatus, terraTOSLoginStatus) {
+    if (terraProfileLoginStatus.isSupported) {
+        return terraTOSLoginStatus.isSuccess;
+    }
+    return userProfileLoginStatus.isSuccess;
+}

package/lib/providers/exploreState/actions/stateToUrl/action.d.ts

@@ -0,0 +1,9 @@
+import { ExploreState } from "../../../exploreState";
+import { StateToUrlPayload } from "./types";
+/**
+ * Reducer function to handle the "state >> URL sync" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export declare function stateToUrlAction(state: ExploreState, payload: StateToUrlPayload): ExploreState;

package/lib/providers/exploreState/actions/stateToUrl/action.js

@@ -0,0 +1,14 @@
+import { META_COMMAND } from "../../../../hooks/stateSyncManager/hooks/UseMetaCommands/types";
+import { ROUTER_METHOD } from "./types";
+/**
+ * Reducer function to handle the "state >> URL sync" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function stateToUrlAction(state, payload) {
+    const command = payload.method === ROUTER_METHOD.PUSH
+        ? META_COMMAND.STATE_TO_URL_PUSH
+        : META_COMMAND.STATE_TO_URL_REPLACE;
+    return { ...state, meta: { command } };
+}

package/lib/providers/exploreState/actions/stateToUrl/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { StateToUrlAction, StateToUrlPayload } from "./types";
+/**
+ * Action creator for state >> URL sync.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function stateToUrl(payload: StateToUrlPayload): StateToUrlAction;

package/lib/providers/exploreState/actions/{syncStateFromUrl → stateToUrl}/dispatch.js

@@ -1,12 +1,12 @@
 import { ExploreActionKind } from "../../../exploreState";
 /**
- * Action creator for syncing state from URL.
+ * Action creator for state >> URL sync.
  * @param payload - Payload.
  * @returns Action with payload and action type.
  */
-export function syncStateFromUrl(payload) {
+export function stateToUrl(payload) {
     return {
         payload,
-        type: ExploreActionKind.SyncStateFromUrl,
+        type: ExploreActionKind.StateToUrl,
     };
 }

package/lib/providers/exploreState/actions/stateToUrl/types.d.ts

@@ -0,0 +1,12 @@
+import { ExploreActionKind } from "../../../exploreState";
+export declare enum ROUTER_METHOD {
+    PUSH = "push",
+    REPLACE = "replace"
+}
+export type StateToUrlAction = {
+    payload: StateToUrlPayload;
+    type: ExploreActionKind.StateToUrl;
+};
+export type StateToUrlPayload = {
+    method: ROUTER_METHOD;
+};

package/lib/providers/exploreState/actions/stateToUrl/types.js

@@ -0,0 +1,5 @@
+export var ROUTER_METHOD;
+(function (ROUTER_METHOD) {
+    ROUTER_METHOD["PUSH"] = "push";
+    ROUTER_METHOD["REPLACE"] = "replace";
+})(ROUTER_METHOD || (ROUTER_METHOD = {}));

package/lib/providers/exploreState/actions/urlToState/action.d.ts

@@ -0,0 +1,9 @@
+import { ExploreState } from "../../../exploreState";
+import { UrlToStatePayload } from "./types";
+/**
+ * Reducer function to handle the "URL >> state sync" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export declare function urlToStateAction(state: ExploreState, payload: UrlToStatePayload): ExploreState;

package/lib/providers/exploreState/actions/urlToState/action.js

@@ -0,0 +1,38 @@
+import { EXPLORE_URL_PARAMS } from "../../../exploreState/constants";
+import { buildNextEntities } from "../../entities/state";
+import { getEntityCategoryGroupConfigKey, getFilterCount, updateEntityStateByCategoryGroupConfigKey, } from "../../utils";
+import { decodeFilterParamValue } from "./utils";
+/**
+ * Reducer function to handle the "URL >> state sync" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function urlToStateAction(state, payload) {
+    const { query } = payload;
+    // Get the entity list type from the query.
+    const { entityListType } = query;
+    // If the entityListType is not a string, return the current state.
+    if (typeof entityListType !== "string")
+        return state;
+    // Decode the catalog param value to catalog state.
+    const catalogState = query[EXPLORE_URL_PARAMS.CATALOG];
+    // Decode the filter param value to selected filters.
+    const filterState = decodeFilterParamValue(query[EXPLORE_URL_PARAMS.FILTER]);
+    // Decode the feature flag param value to feature flag state.
+    const featureFlagState = query[EXPLORE_URL_PARAMS.FEATURE_FLAG];
+    // Grab the category group config key for the entityListType.
+    const categoryGroupConfigKey = getEntityCategoryGroupConfigKey(entityListType, state.entityPageState);
+    // Update the entity state by category group config key.
+    updateEntityStateByCategoryGroupConfigKey(state, { filterState, savedFilterState: [] }, categoryGroupConfigKey);
+    return {
+        ...state,
+        catalogState,
+        entities: buildNextEntities({ ...state, catalogState, featureFlagState }, entityListType, { filterState }),
+        featureFlagState,
+        filterCount: entityListType === state.tabValue
+            ? getFilterCount(filterState)
+            : state.filterCount,
+        filterState: entityListType === state.tabValue ? filterState : state.filterState,
+    };
+}

package/lib/providers/exploreState/actions/urlToState/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { UrlToStateAction, UrlToStatePayload } from "./types";
+/**
+ * Action creator for URL >> state sync.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function urlToState(payload: UrlToStatePayload): UrlToStateAction;