@databiosphere/findable-ui 35.2.0 → 37.0.0

package/lib/hooks/useFileManifest/useFileManifestFileCount.js

@@ -0,0 +1,44 @@
+import { useEffect, useState } from "react";
+import { FileManifestActionKind } from "../../providers/fileManifestState";
+import { useCatalog } from "../useCatalog";
+import { useFileManifestState } from "../useFileManifestState";
+import { useFetchSummary } from "./useFetchSummary";
+/**
+ * Fetches the latest file count from the summary endpoint, excluding filters
+ * that match the provided species and file facet names, and updates the file manifest state.
+ *
+ * @param initialFilters - The initial set of filters to apply.
+ * @param speciesFacetName - The facet name representing species to exclude from the summary request.
+ * @param fileFacetName - The facet name representing file type to exclude from the summary request.
+ */
+export const useFileManifestFileCount = (initialFilters, speciesFacetName, fileFacetName) => {
+    // Initial file manifest filter.
+    const [initFilters] = useState(() => initialFilters);
+    // File manifest dispatch.
+    const { fileManifestDispatch } = useFileManifestState();
+    // Determine catalog.
+    const catalog = useCatalog(); // catalog should be defined.
+    // Get filters required for fetching the summary.
+    const filters = excludeFacetsFromFilters(initFilters, [
+        speciesFacetName,
+        fileFacetName,
+    ]);
+    // Fetch file count from summary.
+    const { summary: { fileCount } = {} } = useFetchSummary(filters, catalog, true);
+    useEffect(() => {
+        fileManifestDispatch({
+            payload: { fileCount },
+            type: FileManifestActionKind.UpdateFileCount,
+        });
+    }, [fileCount, fileManifestDispatch]);
+};
+/**
+ * Returns a new filters array with the specified facet names excluded.
+ *
+ * @param filters - The list of filters to process.
+ * @param facetNames - The facet names to exclude from the filters.
+ * @returns The filters array excluding any filters matching the provided facet names.
+ */
+function excludeFacetsFromFilters(filters, facetNames) {
+    return (filters || []).filter(({ categoryKey }) => !facetNames.includes(categoryKey));
+}

package/lib/hooks/useRequestManifest/utils.d.ts

@@ -4,18 +4,21 @@ import { FormFacet } from "../../components/Export/common/entities";
 import { FileManifestState } from "../../providers/fileManifestState";
 import { UseRequestManifest } from "./types";
 /**
- * Returns true if all form facets have all their terms selected.
- * @param formFacet - Form related file facets.
- * @returns true if all form facets have all their terms selected.
+ * Determines whether all files are selected by comparing the file count to the summary file count.
+ *
+ * @param state - The file manifest state object.
+ * @returns True if all files are selected; otherwise, false.
  */
-export declare function areAllFormFilterTermsSelected(formFacet: FormFacet): boolean;
+export declare function areAllFilesSelected(state: FileManifestState): boolean;
 /**
- * Generates the filters for a request URL based on the file manifest state.
- * - **all form facets have all their terms selected** - returns filters from state without form filters.
- * - **at least one form facet has an unselected term** - returns filters from state.
- * @param state - File manifest state.
- * @param formFacet - Form related file facets.
- * @returns filters for the request URL.
+ * Builds the filters object for a request URL based on the file manifest state and form facets.
+ *
+ * - If all files are selected, returns filters from state excluding fully selected form filters.
+ * - If only some files are selected, returns the current filters from state.
+ *
+ * @param state - The file manifest state object.
+ * @param formFacet - The form-related file facets.
+ * @returns The filters to use for the request URL.
  */
 export declare function buildRequestFilters(state: FileManifestState, formFacet: FormFacet): Filters;
 /**
@@ -42,11 +45,15 @@ export declare function excludeFullySelectedFormFilters(state: FileManifestState
  */
 export declare function isCatalogReady(catalog: string | undefined): boolean;
 /**
- * Returns true if the file manifest state is ready for a request.
- * A file manifest state is considered ready if it is both enabled (`isEnabled` is `true`)
- * and not currently loading (`isLoading` is `false`).
+ * Determines if the file manifest state is ready to be used in a request.
+ *
+ * The state is considered ready when:
+ * - isEnabled is true
+ * - fileCount is defined
+ * - isLoading is false
+ *
  * @param fileManifestState - File manifest state.
- * @returns true if the file manifest state is ready for a request.
+ * @returns true if the file manifest state is ready.
  */
 export declare function isFileManifestStateReady(fileManifestState: FileManifestState): boolean;
 /**

package/lib/hooks/useRequestManifest/utils.js

@@ -2,29 +2,35 @@ import { AZUL_PARAM, MANIFEST_DOWNLOAD_FORMAT, } from "../../apis/azul/common/en
 import { transformFilters } from "../../apis/azul/common/filterTransformer";
 import { REQUEST_MANIFEST } from "./constants";
 /**
- * Returns true if all form facets have all their terms selected.
- * @param formFacet - Form related file facets.
- * @returns true if all form facets have all their terms selected.
+ * Determines whether all files are selected by comparing the file count to the summary file count.
+ *
+ * @param state - The file manifest state object.
+ * @returns True if all files are selected; otherwise, false.
  */
-export function areAllFormFilterTermsSelected(formFacet) {
-    return Object.values(formFacet)
-        .filter(Boolean)
-        .every(({ selectedTermCount, termCount }) => selectedTermCount === termCount);
+export function areAllFilesSelected(state) {
+    const { fileCount, summary } = state;
+    // Return false if file count or summary file count is undefined.
+    if (fileCount === undefined || summary?.fileCount === undefined)
+        return false;
+    // Return true if file count equals summary file count.
+    return fileCount === summary.fileCount;
 }
 /**
- * Generates the filters for a request URL based on the file manifest state.
- * - **all form facets have all their terms selected** - returns filters from state without form filters.
- * - **at least one form facet has an unselected term** - returns filters from state.
- * @param state - File manifest state.
- * @param formFacet - Form related file facets.
- * @returns filters for the request URL.
+ * Builds the filters object for a request URL based on the file manifest state and form facets.
+ *
+ * - If all files are selected, returns filters from state excluding fully selected form filters.
+ * - If only some files are selected, returns the current filters from state.
+ *
+ * @param state - The file manifest state object.
+ * @param formFacet - The form-related file facets.
+ * @returns The filters to use for the request URL.
  */
 export function buildRequestFilters(state, formFacet) {
-    // Form terms are fully selected; return filters excluding form filters.
-    if (areAllFormFilterTermsSelected(formFacet)) {
+    // Return filters from state excluding form filters if all files are selected.
+    if (areAllFilesSelected(state)) {
         return excludeFullySelectedFormFilters(state, formFacet);
     }
-    // Form terms are partially selected; return filters.
+    // Return current filters from state.
     return state.filters;
 }
 /**
@@ -84,14 +90,20 @@ export function isCatalogReady(catalog) {
     return typeof catalog === "string";
 }
 /**
- * Returns true if the file manifest state is ready for a request.
- * A file manifest state is considered ready if it is both enabled (`isEnabled` is `true`)
- * and not currently loading (`isLoading` is `false`).
+ * Determines if the file manifest state is ready to be used in a request.
+ *
+ * The state is considered ready when:
+ * - isEnabled is true
+ * - fileCount is defined
+ * - isLoading is false
+ *
  * @param fileManifestState - File manifest state.
- * @returns true if the file manifest state is ready for a request.
+ * @returns true if the file manifest state is ready.
  */
 export function isFileManifestStateReady(fileManifestState) {
-    return fileManifestState.isEnabled && !fileManifestState.isLoading;
+    return (fileManifestState.isEnabled &&
+        fileManifestState.fileCount !== undefined &&
+        !fileManifestState.isLoading);
 }
 /**
  * Checks if the file manifest format is ready for use.

package/lib/mocks/useRequestFileManifest.mocks.js

@@ -59,9 +59,11 @@ export const FILTERS = {
     FORM_SUBSET: [FILTER_FILES_SUBSET, FILTER_OTHER, FILTER_SPECIES],
 };
 export const FILE_MANIFEST_STATE = {
+    fileCount: 10,
     filters: FILTERS.FORM_INITIAL_SET,
     isEnabled: true,
     isLoading: false,
+    summary: { fileCount: 10 },
 };
 export const FORM_FACET = {
     COMPLETE_SET: {

package/lib/providers/dataDictionary/context.d.ts

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

package/lib/providers/dataDictionary/context.js

@@ -0,0 +1,4 @@
+import { createContext } from "react";
+export const DataDictionaryContext = createContext({
+    dictionary: "",
+});

package/lib/providers/dataDictionary/hook.d.ts

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

package/lib/providers/dataDictionary/hook.js

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

package/lib/providers/dataDictionary/types.d.ts

@@ -0,0 +1,3 @@
+export interface DataDictionaryContextProps {
+    dictionary: string;
+}

package/lib/providers/dataDictionary/types.js

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

package/lib/providers/dataDictionaryState/actions/clearMeta/action.d.ts

@@ -0,0 +1,9 @@
+import { DataDictionaryState } from "../../types";
+import { ClearMetaPayload } from "./types";
+/**
+ * Reducer function to handle the "clear meta" action.
+ * @param state - Data Dictionary State.
+ * @param payload - Payload.
+ * @returns data dictionary state.
+ */
+export declare function clearMetaAction(state: DataDictionaryState, payload: ClearMetaPayload): DataDictionaryState;

package/lib/providers/dataDictionaryState/actions/clearMeta/action.js

@@ -0,0 +1,12 @@
+/**
+ * Reducer function to handle the "clear meta" action.
+ * @param state - Data Dictionary State.
+ * @param payload - Payload.
+ * @returns data dictionary state.
+ */
+export function clearMetaAction(state, payload) {
+    return {
+        ...state,
+        meta: payload,
+    };
+}

package/lib/providers/dataDictionaryState/actions/clearMeta/dispatch.d.ts

@@ -0,0 +1,6 @@
+import { ClearMetaAction } from "./types";
+/**
+ * Action creator for clearing meta in the state.
+ * @returns Action with payload and action type.
+ */
+export declare function clearMeta(): ClearMetaAction;

package/lib/providers/dataDictionaryState/actions/clearMeta/dispatch.js

@@ -0,0 +1,11 @@
+import { DataDictionaryActionKind } from "../types";
+/**
+ * Action creator for clearing meta in the state.
+ * @returns Action with payload and action type.
+ */
+export function clearMeta() {
+    return {
+        payload: null,
+        type: DataDictionaryActionKind.ClearMeta,
+    };
+}

package/lib/providers/dataDictionaryState/actions/clearMeta/types.d.ts

@@ -0,0 +1,6 @@
+import { DataDictionaryActionKind } from "../types";
+export type ClearMetaAction = {
+    payload: ClearMetaPayload;
+    type: DataDictionaryActionKind.ClearMeta;
+};
+export type ClearMetaPayload = null;

package/lib/providers/dataDictionaryState/actions/clearMeta/types.js

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

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

@@ -0,0 +1,9 @@
+import { DataDictionaryState } from "../../types";
+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: DataDictionaryState, payload: StateToUrlPayload): DataDictionaryState;

package/lib/providers/dataDictionaryState/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/dataDictionaryState/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/dataDictionaryState/actions/stateToUrl/dispatch.js

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

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

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

package/lib/providers/dataDictionaryState/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/dataDictionaryState/actions/types.d.ts

@@ -0,0 +1,13 @@
+import { ClearMetaAction } from "./clearMeta/types";
+import { StateToUrlAction } from "./stateToUrl/types";
+import { UpdateColumnFiltersAction } from "./updateColumnFilters/types";
+import { UpdateGlobalFilterAction } from "./updateGlobalFilter/types";
+import { UrlToStateAction } from "./urlToState/types";
+export type DataDictionaryAction = ClearMetaAction | StateToUrlAction | UpdateColumnFiltersAction | UpdateGlobalFilterAction | UrlToStateAction;
+export declare enum DataDictionaryActionKind {
+    ClearMeta = "CLEAR_META",
+    StateToUrl = "STATE_TO_URL",
+    UpdateColumnFilters = "UPDATE_COLUMN_FILTERS",
+    UpdateGlobalFilter = "UPDATE_GLOBAL_FILTER",
+    UrlToState = "URL_TO_STATE"
+}

package/lib/providers/dataDictionaryState/actions/types.js

@@ -0,0 +1,8 @@
+export var DataDictionaryActionKind;
+(function (DataDictionaryActionKind) {
+    DataDictionaryActionKind["ClearMeta"] = "CLEAR_META";
+    DataDictionaryActionKind["StateToUrl"] = "STATE_TO_URL";
+    DataDictionaryActionKind["UpdateColumnFilters"] = "UPDATE_COLUMN_FILTERS";
+    DataDictionaryActionKind["UpdateGlobalFilter"] = "UPDATE_GLOBAL_FILTER";
+    DataDictionaryActionKind["UrlToState"] = "URL_TO_STATE";
+})(DataDictionaryActionKind || (DataDictionaryActionKind = {}));

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/action.d.ts

@@ -0,0 +1,9 @@
+import { DataDictionaryState } from "../../types";
+import { UpdateColumnFiltersPayload } from "./types";
+/**
+ * Reducer function to handle the "update column filters" action.
+ * @param state - Data dictionary state.
+ * @param payload - Payload.
+ * @returns data dictionary state.
+ */
+export declare function updateColumnFiltersAction(state: DataDictionaryState, payload: UpdateColumnFiltersPayload): DataDictionaryState;

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/action.js

@@ -0,0 +1,18 @@
+import { META_COMMAND } from "../../../../hooks/stateSyncManager/hooks/UseMetaCommands/types";
+import { buildNextDictionaries } from "../../dictionaries/state";
+import { buildNextColumnFilters } from "./utils";
+/**
+ * Reducer function to handle the "update column filters" action.
+ * @param state - Data dictionary state.
+ * @param payload - Payload.
+ * @returns data dictionary state.
+ */
+export function updateColumnFiltersAction(state, payload) {
+    return {
+        ...state,
+        dictionaries: buildNextDictionaries(state, payload.dictionary, {
+            columnFilters: buildNextColumnFilters(state, payload),
+        }),
+        meta: { command: META_COMMAND.STATE_TO_URL_PUSH },
+    };
+}

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { UpdateColumnFiltersAction, UpdateColumnFiltersPayload } from "./types";
+/**
+ * Action creator for updating column filters in the state.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function updateColumnFilters(payload: UpdateColumnFiltersPayload): UpdateColumnFiltersAction;

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/dispatch.js

@@ -0,0 +1,12 @@
+import { DataDictionaryActionKind } from "../types";
+/**
+ * Action creator for updating column filters in the state.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function updateColumnFilters(payload) {
+    return {
+        payload,
+        type: DataDictionaryActionKind.UpdateColumnFilters,
+    };
+}

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/types.d.ts

@@ -0,0 +1,10 @@
+import { ColumnFiltersState, Updater } from "@tanstack/react-table";
+import { DataDictionaryActionKind } from "../types";
+export type UpdateColumnFiltersAction = {
+    payload: UpdateColumnFiltersPayload;
+    type: DataDictionaryActionKind.UpdateColumnFilters;
+};
+export interface UpdateColumnFiltersPayload {
+    dictionary: string;
+    updaterOrValue: Updater<ColumnFiltersState>;
+}

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/types.js

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

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/utils.d.ts

@@ -0,0 +1,11 @@
+import { ColumnFiltersState } from "@tanstack/react-table";
+import { DataDictionaryState } from "../../types";
+import { UpdateColumnFiltersPayload } from "./types";
+/**
+ * Builds the next column filters state for the current dictionary.
+ * Uses TanStack updater to update the column filters state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns column filters state.
+ */
+export declare function buildNextColumnFilters(state: DataDictionaryState, payload: UpdateColumnFiltersPayload): ColumnFiltersState;

package/lib/providers/dataDictionaryState/actions/updateColumnFilters/utils.js

@@ -0,0 +1,27 @@
+import { functionalUpdate } from "@tanstack/react-table";
+/**
+ * Builds the next column filters state for the current dictionary.
+ * Uses TanStack updater to update the column filters state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns column filters state.
+ */
+export function buildNextColumnFilters(state, payload) {
+    return functionalUpdate(payload.updaterOrValue, getOldColumnFilters(state, payload));
+}
+/**
+ * Retrieves the current "old" column filters state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns old column filters state.
+ */
+function getOldColumnFilters(state, payload) {
+    // Grab the dictionary.
+    const dictionary = state.dictionaries[payload.dictionary];
+    // If the dictionary is not found, return an empty array.
+    if (!dictionary)
+        return [];
+    // Grab column filters from dictionary state.
+    const { columnFilters = [] } = dictionary.state;
+    return columnFilters;
+}

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/action.d.ts

@@ -0,0 +1,9 @@
+import { DataDictionaryState } from "../../types";
+import { UpdateGlobalFilterPayload } from "./types";
+/**
+ * Reducer function to handle the "update global filter" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export declare function updateGlobalFilterAction(state: DataDictionaryState, payload: UpdateGlobalFilterPayload): DataDictionaryState;

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/action.js

@@ -0,0 +1,19 @@
+import { buildNextDictionaries } from "../../dictionaries/state";
+import { buildNextGlobalFilter, buildNextMeta } from "./utils";
+/**
+ * Reducer function to handle the "update global filter" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateGlobalFilterAction(state, payload) {
+    const globalFilter = buildNextGlobalFilter(payload);
+    const meta = buildNextMeta(state, payload, globalFilter);
+    return {
+        ...state,
+        dictionaries: buildNextDictionaries(state, payload.dictionary, {
+            globalFilter,
+        }),
+        meta,
+    };
+}

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { UpdateGlobalFilterAction, UpdateGlobalFilterPayload } from "./types";
+/**
+ * Action creator for updating global filter in the state.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function updateGlobalFilter(payload: UpdateGlobalFilterPayload): UpdateGlobalFilterAction;

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/dispatch.js

@@ -0,0 +1,12 @@
+import { DataDictionaryActionKind } from "../types";
+/**
+ * Action creator for updating global filter in the state.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function updateGlobalFilter(payload) {
+    return {
+        payload,
+        type: DataDictionaryActionKind.UpdateGlobalFilter,
+    };
+}

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/types.d.ts

@@ -0,0 +1,10 @@
+import { Updater } from "@tanstack/react-table";
+import { DataDictionaryActionKind } from "../types";
+export type UpdateGlobalFilterAction = {
+    payload: UpdateGlobalFilterPayload;
+    type: DataDictionaryActionKind.UpdateGlobalFilter;
+};
+export interface UpdateGlobalFilterPayload {
+    dictionary: string;
+    updaterOrValue: Updater<string | undefined>;
+}

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/types.js

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

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/utils.d.ts

@@ -0,0 +1,17 @@
+import { DataDictionaryState } from "../../types";
+import { UpdateGlobalFilterPayload } from "./types";
+/**
+ * Builds the next global filter state for the current dictionary.
+ * Uses TanStack updater to update the global filter state.
+ * @param payload - Payload.
+ * @returns global filter state.
+ */
+export declare function buildNextGlobalFilter(payload: UpdateGlobalFilterPayload): string | undefined;
+/**
+ * Builds the next meta state for the current dictionary.
+ * @param state - State.
+ * @param payload - Payload.
+ * @param nextGlobalFilter - Next global filter.
+ * @returns meta state.
+ */
+export declare function buildNextMeta(state: DataDictionaryState, payload: UpdateGlobalFilterPayload, nextGlobalFilter: string | undefined): DataDictionaryState["meta"];

package/lib/providers/dataDictionaryState/actions/updateGlobalFilter/utils.js

@@ -0,0 +1,36 @@
+import { functionalUpdate } from "@tanstack/react-table";
+import { META_COMMAND } from "../../../../hooks/stateSyncManager/hooks/UseMetaCommands/types";
+/**
+ * Builds the next global filter state for the current dictionary.
+ * Uses TanStack updater to update the global filter state.
+ * @param payload - Payload.
+ * @returns global filter state.
+ */
+export function buildNextGlobalFilter(payload) {
+    return functionalUpdate(payload.updaterOrValue, undefined) || undefined;
+}
+/**
+ * Builds the next meta state for the current dictionary.
+ * @param state - State.
+ * @param payload - Payload.
+ * @param nextGlobalFilter - Next global filter.
+ * @returns meta state.
+ */
+export function buildNextMeta(state, payload, nextGlobalFilter) {
+    const currentGlobalFilter = getCurrentGlobalFilter(state, payload);
+    // Use PUSH method with adding or removing the global filter.
+    if (currentGlobalFilter === undefined || nextGlobalFilter === undefined) {
+        return { command: META_COMMAND.STATE_TO_URL_PUSH };
+    }
+    // Use REPLACE method with edits to the global filter.
+    return { command: META_COMMAND.STATE_TO_URL_REPLACE };
+}
+/**
+ * Returns the current global filter for the current dictionary.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns global filter.
+ */
+function getCurrentGlobalFilter(state, payload) {
+    return state.dictionaries[payload.dictionary].state.globalFilter;
+}

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

@@ -0,0 +1,9 @@
+import { DataDictionaryState } from "../../types";
+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: DataDictionaryState, payload: UrlToStatePayload): DataDictionaryState;