@databiosphere/findable-ui 35.1.0 → 36.0.0

package/lib/components/common/OutlinedInput/outlinedInput.styles.js

@@ -0,0 +1,18 @@
+import { css } from "@emotion/react";
+import styled from "@emotion/styled";
+import { OutlinedInput } from "@mui/material";
+import { PALETTE } from "../../../styles/common/constants/palette";
+export const StyledOutlinedInput = styled(OutlinedInput, {
+    shouldForwardProp: (prop) => prop !== "hasValue",
+}) `
+  ${({ hasValue }) => hasValue &&
+    css `
+      & {
+        color: ${PALETTE.INK_MAIN};
+
+        .MuiOutlinedInput-input {
+          color: inherit;
+        }
+      }
+    `};
+`;

package/lib/hooks/stateSyncManager/hooks/UseMetaCommands/hook.js

@@ -10,11 +10,11 @@ export const useMetaCommands = ({ actions, dispatch, state, }) => {
         switch (command) {
             case META_COMMAND.STATE_TO_URL_PUSH:
                 Router.push({ query }, undefined, { shallow: true });
-                dispatch(actions.clearMeta());
+                dispatch?.(actions.clearMeta());
                 break;
             case META_COMMAND.STATE_TO_URL_REPLACE:
                 Router.replace({ query }, undefined, { shallow: true });
-                dispatch(actions.clearMeta());
+                dispatch?.(actions.clearMeta());
                 break;
             default:
                 break;

package/lib/hooks/stateSyncManager/hooks/UseStateSync/hook.js

@@ -23,18 +23,18 @@ export const useStateSync = ({ actions, dispatch, state, }) => {
         // Dispatch action sync URL >> state.
         if (wasPop(basePath, pathname, popRef.current)) {
             // When the user navigates with the back/forward buttons.
-            dispatch(actions.urlToState({ query }));
+            dispatch?.(actions.urlToState({ query }));
             onClearPopRef();
             return;
         }
         // Dispatch action sync URL >> state.
         if (hasParams(query, paramKeys)) {
             // When the URL has parameters.
-            dispatch(actions.urlToState({ query }));
+            dispatch?.(actions.urlToState({ query }));
             return;
         }
         // Otherwise, dispatch action sync URL << state.
-        dispatch(actions.stateToUrl({ method: ROUTER_METHOD.REPLACE }));
+        dispatch?.(actions.stateToUrl({ method: ROUTER_METHOD.REPLACE }));
         // eslint-disable-next-line react-hooks/exhaustive-deps -- deliberate omission of `state.query`, `state.paramKeys`, `actions` and `dispatch` from dependencies, hook is only expected to run when the Next.js router changes.
     }, [basePath, isReady, pathname, query]);
 };

package/lib/hooks/stateSyncManager/types.d.ts

@@ -21,6 +21,6 @@ export interface StateSyncManagerContext {
 }
 export interface UseStateSyncManagerProps<Action> {
     actions: StateSyncManagerActions<Action>;
-    dispatch: Dispatch<Action>;
+    dispatch: Dispatch<Action> | null;
     state: StateSyncManagerContext;
 }

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

@@ -4,11 +4,11 @@ export interface ManifestDownload {
     isIdle: boolean;
     isLoading: boolean;
     manifestURL?: string;
+    requestManifest: () => void;
 }
 /**
  * Returns file manifest download url and file name.
  * @param filters - Filters.
- * @param disabled - Disabled.
  * @returns file manifest download url and file name.
  */
-export declare const useFileManifestDownload: (filters: Filters, disabled: boolean) => ManifestDownload;
+export declare const useFileManifestDownload: (filters: Filters) => ManifestDownload;

package/lib/hooks/useFileManifest/useFileManifestDownload.js

@@ -1,4 +1,3 @@
-import { useEffect } from "react";
 import { MANIFEST_DOWNLOAD_FORMAT } from "../../apis/azul/common/entities";
 import { BULK_DOWNLOAD_EXECUTION_ENVIRONMENT } from "../../components/Export/common/entities";
 import { useCatalog } from "../useCatalog";
@@ -8,10 +7,9 @@ import { buildRequestManifest } from "../useRequestManifest/utils";
 /**
  * Returns file manifest download url and file name.
  * @param filters - Filters.
- * @param disabled - Disabled.
  * @returns file manifest download url and file name.
  */
-export const useFileManifestDownload = (filters, disabled) => {
+export const useFileManifestDownload = (filters) => {
     // Retrieve the endpoint URL from configured data source.
     const config = useConfig();
     const endpointUrl = config.config.dataSource.url;
@@ -19,20 +17,15 @@ export const useFileManifestDownload = (filters, disabled) => {
     const catalog = useCatalog(); // catalog should be defined.
     // Build request manifest request URL.
     const { requestMethod, requestUrl } = buildRequestManifest(endpointUrl, catalog, filters, MANIFEST_DOWNLOAD_FORMAT.COMPACT);
-    const { data, isIdle, isLoading, run } = useRequestFileLocation(requestUrl, requestMethod);
+    const { data, isIdle, isLoading, run: requestManifest, } = useRequestFileLocation(requestUrl, requestMethod);
     const manifestURL = getManifestDownloadURL(data);
     const fileName = getManifestDownloadFileName(data);
-    // Requests file manifest.
-    useEffect(() => {
-        if (disabled)
-            return;
-        run();
-    }, [disabled, requestUrl, run]);
     return {
         fileName,
         isIdle,
         isLoading,
         manifestURL,
+        requestManifest,
     };
 };
 /**

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

@@ -1,14 +1,15 @@
 import { Filters } from "../../common/entities";
 export interface ManifestSpreadsheet {
-    exists?: boolean;
-    fileFormat?: string;
     fileName?: string;
     fileUrl?: string;
+    isIdle?: boolean;
+    isLoading?: boolean;
+    requestManifest?: () => void;
+    spreadsheetUrl?: string;
 }
 /**
  * Returns file manifest spreadsheet.
  * @param filters - Filters.
- * @param disabled - Disabled.
  * @returns file manifest spreadsheet.
  */
-export declare const useFileManifestSpreadsheet: (filters: Filters, disabled: boolean) => ManifestSpreadsheet | undefined;
+export declare const useFileManifestSpreadsheet: (filters: Filters) => Omit<ManifestSpreadsheet, "fileUrl">;

package/lib/hooks/useFileManifest/useFileManifestSpreadsheet.js

@@ -1,17 +1,17 @@
-import { useEffect, useMemo } from "react";
+import { useCallback, useEffect, useMemo } from "react";
 import { APIEndpoints, } from "../../apis/azul/common/entities";
 import { fetchEntitiesFromURL } from "../../entity/common/service";
 import { fetchQueryParams } from "../../utils/fetchQueryParams";
 import { useAsync } from "../useAsync";
 import { useCatalog } from "../useCatalog";
 import { useFetchRequestURL } from "../useFetchRequestURL";
+import { useRequestFileLocation } from "../useRequestFileLocation";
 /**
  * Returns file manifest spreadsheet.
  * @param filters - Filters.
- * @param disabled - Disabled.
  * @returns file manifest spreadsheet.
  */
-export const useFileManifestSpreadsheet = (filters, disabled) => {
+export const useFileManifestSpreadsheet = (filters) => {
     // Determine catalog.
     const catalog = useCatalog(); // catalog should be defined.
     // Build request params.
@@ -19,16 +19,26 @@ export const useFileManifestSpreadsheet = (filters, disabled) => {
     // Build request URL.
     const requestURL = useFetchRequestURL(APIEndpoints.FILES, requestParams);
     // Fetch files to determine if file exists.
-    const { data, run } = useAsync();
+    const { data: files, isIdle, isLoading: isFilesLoading, run: requestFiles, } = useAsync();
     // Grab manifest spreadsheet.
-    const manifestSpreadsheet = useMemo(() => getManifestSpreadsheet(data?.hits), [data]);
+    const { fileName, fileUrl } = useMemo(() => getManifestSpreadsheet(files?.hits), [files]);
+    // Fetch file manifest.
+    const { data, isLoading, run } = useRequestFileLocation(fileUrl);
     // Fetch response from files endpoint.
+    const requestManifest = useCallback(() => {
+        requestFiles(fetchEntitiesFromURL(requestURL, undefined));
+    }, [requestFiles, requestURL]);
+    // Fetch file manifest.
     useEffect(() => {
-        if (disabled)
-            return;
-        run(fetchEntitiesFromURL(requestURL, undefined));
-    }, [disabled, requestURL, run]);
-    return manifestSpreadsheet;
+        run();
+    }, [fileUrl, run]);
+    return {
+        fileName,
+        isIdle,
+        isLoading: isFilesLoading || isLoading,
+        requestManifest,
+        spreadsheetUrl: data?.location,
+    };
 };
 /**
  * Prepend "/fetch" to the path of the specified file URL, if not already included.
@@ -52,20 +62,14 @@ function buildFetchFileUrl(fileUrl) {
  * @returns manifest spreadsheet.
  */
 function getManifestSpreadsheet(files) {
-    if (!files) {
-        return;
-    }
+    if (!files)
+        return { fileName: undefined, fileUrl: undefined };
     // Handle case where file does not exist.
-    if (files.length === 0) {
-        return {
-            exists: false,
-        };
-    }
+    if (files.length === 0)
+        return { fileName: undefined, fileUrl: undefined };
     // Project manifest spreadsheet exists.
     const file = files[0];
     return {
-        exists: true,
-        fileFormat: file.files[0]?.format,
         fileName: file.files[0]?.name,
         fileUrl: buildFetchFileUrl(file.files[0]?.url),
     };

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