@databiosphere/findable-ui 35.2.0 → 37.0.0

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

@@ -0,0 +1,20 @@
+import { parseJsonQueryParam } from "../../../../utils/parseJsonQueryParam";
+import { DATA_DICTIONARY_URL_PARAMS } from "../../dictionaries/constants";
+import { buildNextDictionaries } from "../../dictionaries/state";
+/**
+ * Reducer function to handle the "URL >> state sync" action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function urlToStateAction(state, payload) {
+    if (typeof payload.query.dictionary !== "string")
+        return state;
+    return {
+        ...state,
+        dictionaries: buildNextDictionaries(state, payload.query.dictionary, {
+            columnFilters: parseJsonQueryParam(payload.query[DATA_DICTIONARY_URL_PARAMS.COLUMN_FILTERS], []),
+            globalFilter: payload.query[DATA_DICTIONARY_URL_PARAMS.GLOBAL_FILTER],
+        }),
+    };
+}

package/lib/providers/dataDictionaryState/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;

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

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

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

@@ -0,0 +1,9 @@
+import { NextRouter } from "next/router";
+import { DataDictionaryActionKind } from "../types";
+export type UrlToStateAction = {
+    payload: UrlToStatePayload;
+    type: DataDictionaryActionKind.UrlToState;
+};
+export type UrlToStatePayload = {
+    query: NextRouter["query"];
+};

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

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

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

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

package/lib/providers/dataDictionaryState/context.js

@@ -0,0 +1,6 @@
+import { createContext } from "react";
+import { INITIAL_DATA_DICTIONARY_STATE } from "./initializer/constants";
+export const DataDictionaryStateContext = createContext({
+    dataDictionaryDispatch: null,
+    dataDictionaryState: INITIAL_DATA_DICTIONARY_STATE,
+});

package/lib/providers/dataDictionaryState/dictionaries/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const DATA_DICTIONARY_URL_PARAMS: {
+    readonly COLUMN_FILTERS: "filter";
+    readonly GLOBAL_FILTER: "search";
+};

package/lib/providers/dataDictionaryState/dictionaries/constants.js

@@ -0,0 +1,4 @@
+export const DATA_DICTIONARY_URL_PARAMS = {
+    COLUMN_FILTERS: "filter",
+    GLOBAL_FILTER: "search",
+};

package/lib/providers/dataDictionaryState/dictionaries/state.d.ts

@@ -0,0 +1,11 @@
+import { TableState } from "@tanstack/react-table";
+import { DataDictionaryState } from "../types";
+import { DictionariesContext } from "./types";
+/**
+ * Builds the next dictionaries context.
+ * @param state - State.
+ * @param dictionaryKey - Dictionary key.
+ * @param nextDictionaryState - Next dictionary state.
+ * @returns Next dictionaries context.
+ */
+export declare function buildNextDictionaries(state: DataDictionaryState, dictionaryKey: string, nextDictionaryState: Partial<TableState>): DictionariesContext;

package/lib/providers/dataDictionaryState/dictionaries/state.js

@@ -0,0 +1,29 @@
+import { stateToUrlQuery } from "../../../utils/stateToUrlQuery";
+import { extractDictionaryUrlState as extractUrlState } from "./utils";
+/**
+ * Builds the next dictionaries context.
+ * @param state - State.
+ * @param dictionaryKey - Dictionary key.
+ * @param nextDictionaryState - Next dictionary state.
+ * @returns Next dictionaries context.
+ */
+export function buildNextDictionaries(state, dictionaryKey, nextDictionaryState) {
+    // Clone the dictionaries.
+    const dictionaries = { ...state.dictionaries };
+    for (const [key, dictionary] of Object.entries(dictionaries)) {
+        // Clone the dictionary context.
+        const dictionaryContext = { ...dictionary };
+        // If the dictionary key is a match, update the dictionary context.
+        if (key === dictionaryKey) {
+            // Update the dictionary state.
+            dictionaryContext.state = { ...dictionary.state, ...nextDictionaryState };
+            // Grab param values from the updated dictionary state.
+            const { columnFilters, globalFilter } = dictionaryContext.state;
+            // Update the dictionary query.
+            dictionaryContext.query = stateToUrlQuery(extractUrlState(key, { columnFilters, globalFilter }));
+        }
+        // Update the dictionary context.
+        dictionaries[key] = dictionaryContext;
+    }
+    return dictionaries;
+}

package/lib/providers/dataDictionaryState/dictionaries/types.d.ts

@@ -0,0 +1,9 @@
+import { TableState } from "@tanstack/react-table";
+import { NextRouter } from "next/router";
+export interface DictionariesContext {
+    [key: string]: DictionaryContext;
+}
+export interface DictionaryContext {
+    query: NextRouter["query"];
+    state: Partial<TableState>;
+}

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

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

package/lib/providers/dataDictionaryState/dictionaries/utils.d.ts

@@ -0,0 +1,14 @@
+import { ColumnFiltersState, TableState } from "@tanstack/react-table";
+/**
+ * Extracts dictionary state properties that should be synchronized with URL parameters.
+ * This function maps specific properties from the dictionary state to a format
+ * that can be used to generate URL query parameters.
+ * The extracted properties are:
+ * - dictionary: Dictionary key (string).
+ * - filter: Applied column filters (ColumnFiltersState).
+ * - search: Applied global filter (GlobalFilterTableState) - typed as string or undefined.
+ * @param dictionary - Dictionary key.
+ * @param state - Dictionary table state.
+ * @returns Object with properties ready for URL query serialization.
+ */
+export declare function extractDictionaryUrlState(dictionary: string, state: Partial<TableState>): Record<string, string | ColumnFiltersState | undefined>;

package/lib/providers/dataDictionaryState/dictionaries/utils.js

@@ -0,0 +1,20 @@
+import { DATA_DICTIONARY_URL_PARAMS } from "./constants";
+/**
+ * Extracts dictionary state properties that should be synchronized with URL parameters.
+ * This function maps specific properties from the dictionary state to a format
+ * that can be used to generate URL query parameters.
+ * The extracted properties are:
+ * - dictionary: Dictionary key (string).
+ * - filter: Applied column filters (ColumnFiltersState).
+ * - search: Applied global filter (GlobalFilterTableState) - typed as string or undefined.
+ * @param dictionary - Dictionary key.
+ * @param state - Dictionary table state.
+ * @returns Object with properties ready for URL query serialization.
+ */
+export function extractDictionaryUrlState(dictionary, state) {
+    return {
+        dictionary,
+        [DATA_DICTIONARY_URL_PARAMS.COLUMN_FILTERS]: state.columnFilters || [],
+        [DATA_DICTIONARY_URL_PARAMS.GLOBAL_FILTER]: state.globalFilter,
+    };
+}

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryInitialArgs/hook.d.ts

@@ -0,0 +1,2 @@
+import { UseDataDictionaryInitialArgs } from "./types";
+export declare const useDataDictionaryInitialArgs: () => UseDataDictionaryInitialArgs;

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryInitialArgs/hook.js

@@ -0,0 +1,6 @@
+import { useConfig } from "../../../../hooks/useConfig";
+export const useDataDictionaryInitialArgs = () => {
+    const { config } = useConfig();
+    const dataDictionaries = config.dataDictionaries;
+    return { dataDictionaries };
+};

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryInitialArgs/types.d.ts

@@ -0,0 +1,4 @@
+import { DataDictionaryConfig } from "../../../../common/entities";
+export interface UseDataDictionaryInitialArgs {
+    dataDictionaries?: DataDictionaryConfig[];
+}

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryInitialArgs/types.js

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

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryReducer/hook.d.ts

@@ -0,0 +1,2 @@
+import { DataDictionaryStateContextProps } from "../../types";
+export declare const useDataDictionaryReducer: () => DataDictionaryStateContextProps;

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryReducer/hook.js

@@ -0,0 +1,9 @@
+import { useReducer } from "react";
+import { initializer } from "../../initializer/initializer";
+import { dataDictionaryReducer } from "../../reducer";
+import { useDataDictionaryInitialArgs } from "../UseDataDictionaryInitialArgs/hook";
+export const useDataDictionaryReducer = () => {
+    const initialArgs = useDataDictionaryInitialArgs();
+    const [dataDictionaryState, dataDictionaryDispatch] = useReducer(dataDictionaryReducer, initialArgs, initializer);
+    return { dataDictionaryDispatch, dataDictionaryState };
+};

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryState/hook.d.ts

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

package/lib/providers/dataDictionaryState/hooks/UseDataDictionaryState/hook.js

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

package/lib/providers/dataDictionaryState/initializer/constants.d.ts

@@ -0,0 +1,2 @@
+import { DataDictionaryState } from "../types";
+export declare const INITIAL_DATA_DICTIONARY_STATE: DataDictionaryState;

package/lib/providers/dataDictionaryState/initializer/constants.js

@@ -0,0 +1,4 @@
+export const INITIAL_DATA_DICTIONARY_STATE = {
+    dictionaries: {},
+    meta: null,
+};

package/lib/providers/dataDictionaryState/initializer/initializer.d.ts

@@ -0,0 +1,9 @@
+import { UseDataDictionaryInitialArgs } from "../hooks/UseDataDictionaryInitialArgs/types";
+import { DataDictionaryState } from "../types";
+/**
+ * Initializer function for the data dictionary reducer, returning initial state.
+ * @param initialArgs - Initial arguments.
+ * @param initialArgs.dataDictionaries - Data dictionary configs.
+ * @returns The initialized data dictionary state.
+ */
+export declare function initializer({ dataDictionaries, }: UseDataDictionaryInitialArgs): DataDictionaryState;

package/lib/providers/dataDictionaryState/initializer/initializer.js

@@ -0,0 +1,17 @@
+import { INITIAL_DATA_DICTIONARY_STATE } from "./constants";
+import { initDictionaries } from "./utils";
+/**
+ * Initializer function for the data dictionary reducer, returning initial state.
+ * @param initialArgs - Initial arguments.
+ * @param initialArgs.dataDictionaries - Data dictionary configs.
+ * @returns The initialized data dictionary state.
+ */
+export function initializer({ dataDictionaries, }) {
+    // If no data dictionary configs are provided, return default initial state.
+    if (!dataDictionaries)
+        return INITIAL_DATA_DICTIONARY_STATE;
+    return {
+        dictionaries: initDictionaries(dataDictionaries),
+        meta: null,
+    };
+}

package/lib/providers/dataDictionaryState/initializer/utils.d.ts

@@ -0,0 +1,8 @@
+import { DataDictionaryConfig } from "../../../common/entities";
+import { DictionariesContext } from "../dictionaries/types";
+/**
+ * Initializes the dictionaries context.
+ * @param dataDictionaries - The data dictionary configs.
+ * @returns The initialized dictionaries context.
+ */
+export declare function initDictionaries(dataDictionaries: DataDictionaryConfig[]): DictionariesContext;

package/lib/providers/dataDictionaryState/initializer/utils.js

@@ -0,0 +1,29 @@
+import { initPaginationState } from "../../../components/Table/coreOptions/state/pagination/utils";
+/**
+ * Initializes the dictionaries context.
+ * @param dataDictionaries - The data dictionary configs.
+ * @returns The initialized dictionaries context.
+ */
+export function initDictionaries(dataDictionaries) {
+    return dataDictionaries.reduce((acc, { path, tableOptions }) => {
+        acc[path] = {
+            query: { dictionary: path },
+            state: initState(tableOptions),
+        };
+        return acc;
+    }, {});
+}
+/**
+ * Initializes the dictionary state (TanStack Table state).
+ * @param tableOptions - The table options.
+ * @returns The initialized dictionary state.
+ */
+function initState(tableOptions) {
+    const { initialState } = tableOptions;
+    return {
+        columnFilters: [],
+        globalFilter: undefined,
+        ...initialState,
+        ...initPaginationState(initialState),
+    };
+}

package/lib/providers/dataDictionaryState/provider.d.ts

@@ -0,0 +1,4 @@
+import { ReactNode } from "react";
+export declare function DataDictionaryStateProvider({ children, }: {
+    children: ReactNode | ReactNode[];
+}): JSX.Element;

package/lib/providers/dataDictionaryState/provider.js

@@ -0,0 +1,7 @@
+import React from "react";
+import { DataDictionaryStateContext } from "./context";
+import { useDataDictionaryReducer } from "./hooks/UseDataDictionaryReducer/hook";
+export function DataDictionaryStateProvider({ children, }) {
+    const reducer = useDataDictionaryReducer();
+    return (React.createElement(DataDictionaryStateContext.Provider, { value: reducer }, children));
+}

package/lib/providers/dataDictionaryState/reducer.d.ts

@@ -0,0 +1,9 @@
+import { DataDictionaryAction } from "./actions/types";
+import { DataDictionaryState } from "./types";
+/**
+ * Reducer for data dictionary.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export declare function dataDictionaryReducer(state: DataDictionaryState, action: DataDictionaryAction): DataDictionaryState;

package/lib/providers/dataDictionaryState/reducer.js

@@ -0,0 +1,34 @@
+import { clearMetaAction } from "./actions/clearMeta/action";
+import { stateToUrlAction } from "./actions/stateToUrl/action";
+import { DataDictionaryActionKind, } from "./actions/types";
+import { updateColumnFiltersAction } from "./actions/updateColumnFilters/action";
+import { updateGlobalFilterAction } from "./actions/updateGlobalFilter/action";
+import { urlToStateAction } from "./actions/urlToState/action";
+/**
+ * Reducer for data dictionary.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function dataDictionaryReducer(state, action) {
+    const { payload, type } = action;
+    switch (type) {
+        case DataDictionaryActionKind.ClearMeta: {
+            return clearMetaAction(state, payload);
+        }
+        case DataDictionaryActionKind.StateToUrl: {
+            return stateToUrlAction(state, payload);
+        }
+        case DataDictionaryActionKind.UpdateColumnFilters: {
+            return updateColumnFiltersAction(state, payload);
+        }
+        case DataDictionaryActionKind.UpdateGlobalFilter: {
+            return updateGlobalFilterAction(state, payload);
+        }
+        case DataDictionaryActionKind.UrlToState: {
+            return urlToStateAction(state, payload);
+        }
+        default:
+            return state;
+    }
+}

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

@@ -0,0 +1,15 @@
+import { Dispatch } from "react";
+import { META_COMMAND } from "../../hooks/stateSyncManager/hooks/UseMetaCommands/types";
+import { DataDictionaryAction } from "./actions/types";
+import { DictionariesContext } from "./dictionaries/types";
+export interface DataDictionaryState {
+    dictionaries: DictionariesContext;
+    meta: Meta | null;
+}
+export interface DataDictionaryStateContextProps {
+    dataDictionaryDispatch: Dispatch<DataDictionaryAction> | null;
+    dataDictionaryState: DataDictionaryState;
+}
+export interface Meta {
+    command: META_COMMAND;
+}

package/lib/providers/dataDictionaryState/types.js

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

package/lib/providers/fileManifestState/constants.js

@@ -1,4 +1,5 @@
 export const FILE_MANIFEST_STATE = {
+    fileCount: undefined,
     fileSummary: undefined,
     fileSummaryFacetName: undefined,
     fileSummaryFilters: [],

package/lib/providers/fileManifestState.d.ts

@@ -6,6 +6,7 @@ import { FileFacet } from "../hooks/useFileManifest/common/entities";
  * File manifest state.
  */
 export type FileManifestState = {
+    fileCount: number | undefined;
     filesFacets: FileFacet[];
     fileSummary?: AzulSummaryResponse;
     fileSummaryFacetName?: string;
@@ -37,6 +38,7 @@ export declare function FileManifestStateProvider({ children, }: FileManifestSta
 export declare enum FileManifestActionKind {
     ClearFileManifest = "CLEAR_FILE_MANIFEST",
     FetchFileManifest = "FETCH_FILE_MANIFEST",
+    UpdateFileCount = "UPDATE_FILE_COUNT",
     UpdateFileManifest = "UPDATE_FILE_MANIFEST",
     UpdateFilter = "UPDATE_FILTER",
     UpdateFiltersCategory = "UPDATE_FILTERS_CATEGORY"
@@ -44,7 +46,7 @@ export declare enum FileManifestActionKind {
 /**
  * File manifest action.
  */
-export type FileManifestAction = ClearFileManifestAction | FetchFileManifestAction | UpdateFileManifestAction | UpdateFilterAction | UpdateFiltersCategoryAction;
+export type FileManifestAction = ClearFileManifestAction | FetchFileManifestAction | UpdateFileCountAction | UpdateFileManifestAction | UpdateFilterAction | UpdateFiltersCategoryAction;
 /**
  * Resets file manifest state.
  */
@@ -66,6 +68,13 @@ type UpdateFileManifestAction = {
     payload: UpdateFileManifestPayload;
     type: FileManifestActionKind.UpdateFileManifest;
 };
+/**
+ * Update file count action.
+ */
+type UpdateFileCountAction = {
+    payload: UpdateFileCountPayload;
+    type: FileManifestActionKind.UpdateFileCount;
+};
 /**
  * Update filter action.
  */
@@ -87,6 +96,12 @@ type FetchFileManifestPayload = {
     fileSummaryFacetName?: string;
     filters: Filters;
 };
+/**
+ * Update file count payload.
+ */
+export type UpdateFileCountPayload = {
+    fileCount: number | undefined;
+};
 /**
  * Update file manifest payload.
  */

package/lib/providers/fileManifestState.js

@@ -58,6 +58,7 @@ export var FileManifestActionKind;
 (function (FileManifestActionKind) {
     FileManifestActionKind["ClearFileManifest"] = "CLEAR_FILE_MANIFEST";
     FileManifestActionKind["FetchFileManifest"] = "FETCH_FILE_MANIFEST";
+    FileManifestActionKind["UpdateFileCount"] = "UPDATE_FILE_COUNT";
     FileManifestActionKind["UpdateFileManifest"] = "UPDATE_FILE_MANIFEST";
     FileManifestActionKind["UpdateFilter"] = "UPDATE_FILTER";
     FileManifestActionKind["UpdateFiltersCategory"] = "UPDATE_FILTERS_CATEGORY";
@@ -75,6 +76,7 @@ function fileManifestReducer(state, action) {
         case FileManifestActionKind.ClearFileManifest: {
             return {
                 ...state,
+                fileCount: undefined,
                 isEnabled: false,
             };
         }
@@ -89,6 +91,10 @@ function fileManifestReducer(state, action) {
                 isEnabled: true,
             };
         }
+        // Updates file count.
+        case FileManifestActionKind.UpdateFileCount: {
+            return { ...state, ...payload };
+        }
         // Updates file manifest.
         case FileManifestActionKind.UpdateFileManifest: {
             return { ...state, ...payload };

package/lib/styles/common/mui/iconButton.d.ts

@@ -0,0 +1,11 @@
+import { IconButtonProps } from "@mui/material";
+type IconButtonPropsOptions = {
+    COLOR: typeof COLOR;
+    EDGE: typeof EDGE;
+    SIZE: typeof SIZE;
+};
+declare const COLOR: Record<string, IconButtonProps["color"]>;
+declare const EDGE: Record<string, IconButtonProps["edge"]>;
+declare const SIZE: Record<string, IconButtonProps["size"]>;
+export declare const ICON_BUTTON_PROPS: IconButtonPropsOptions;
+export {};

package/lib/styles/common/mui/iconButton.js

@@ -0,0 +1,29 @@
+const COLOR = {
+    DEFAULT: "default",
+    ERROR: "error",
+    INFO: "info",
+    INHERIT: "inherit",
+    INK: "ink",
+    INK_LIGHT: "inkLight",
+    PRIMARY: "primary",
+    SECONDARY: "secondary",
+    SUCCESS: "success",
+    WARNING: "warning",
+};
+const EDGE = {
+    END: "end",
+    START: "start",
+};
+const SIZE = {
+    LARGE: "large",
+    MEDIUM: "medium",
+    SMALL: "small",
+    XLARGE: "xlarge",
+    XSMALL: "xsmall",
+    XXSMALL: "xxsmall",
+};
+export const ICON_BUTTON_PROPS = {
+    COLOR,
+    EDGE,
+    SIZE,
+};

package/lib/styles/common/mui/inputAdornment.d.ts

@@ -0,0 +1,9 @@
+import { InputAdornmentProps } from "@mui/material";
+type InputAdornmentPropsOptions = {
+    POSITION: typeof POSITION;
+    VARIANT: typeof VARIANT;
+};
+declare const POSITION: Record<string, InputAdornmentProps["position"]>;
+declare const VARIANT: Record<string, InputAdornmentProps["variant"]>;
+export declare const INPUT_ADORNMENT_PROPS: InputAdornmentPropsOptions;
+export {};

package/lib/styles/common/mui/inputAdornment.js

@@ -0,0 +1,13 @@
+const POSITION = {
+    END: "end",
+    START: "start",
+};
+const VARIANT = {
+    FILLED: "filled",
+    OUTLINED: "outlined",
+    STANDARD: "standard",
+};
+export const INPUT_ADORNMENT_PROPS = {
+    POSITION,
+    VARIANT,
+};

package/lib/styles/common/mui/outlinedInput.d.ts

@@ -0,0 +1,7 @@
+import { OutlinedInputProps } from "@mui/material";
+type OutlinedInputPropsOptions = {
+    COLOR: typeof COLOR;
+};
+declare const COLOR: Record<string, OutlinedInputProps["color"]>;
+export declare const OUTLINED_INPUT_PROPS: OutlinedInputPropsOptions;
+export {};

package/lib/styles/common/mui/outlinedInput.js

@@ -0,0 +1,7 @@
+const COLOR = {
+    PRIMARY: "primary",
+    SECONDARY: "secondary",
+};
+export const OUTLINED_INPUT_PROPS = {
+    COLOR,
+};