@databiosphere/findable-ui 50.6.1 → 50.7.1

package/src/providers/dataDictionaryState/reducer.ts

@@ -1,42 +0,0 @@
-import { clearMetaAction } from "./actions/clearMeta/action";
-import { stateToUrlAction } from "./actions/stateToUrl/action";
-import {
-  DataDictionaryAction,
-  DataDictionaryActionKind,
-} from "./actions/types";
-import { updateColumnFiltersAction } from "./actions/updateColumnFilters/action";
-import { updateGlobalFilterAction } from "./actions/updateGlobalFilter/action";
-import { urlToStateAction } from "./actions/urlToState/action";
-import { DataDictionaryState } from "./types";
-
-/**
- * Reducer for data dictionary.
- * @param state - State.
- * @param action - Action.
- * @returns state.
- */
-export function dataDictionaryReducer(
-  state: DataDictionaryState,
-  action: DataDictionaryAction,
-): DataDictionaryState {
-  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/src/providers/dataDictionaryState/types.ts

@@ -1,18 +0,0 @@
-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/src/providers/exploreState/actions/clearMeta/action.ts

@@ -1,18 +0,0 @@
-import { ExploreState } from "../../../exploreState";
-import { ClearMetaPayload } from "./types";
-
-/**
- * Reducer function to handle the "clear meta" action.
- * @param state - Explore State.
- * @param payload - Payload.
- * @returns explore state.
- */
-export function clearMetaAction(
-  state: ExploreState,
-  payload: ClearMetaPayload,
-): ExploreState {
-  return {
-    ...state,
-    meta: payload,
-  };
-}

package/src/providers/exploreState/actions/clearMeta/dispatch.ts

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

package/src/providers/exploreState/actions/clearMeta/types.ts

@@ -1,8 +0,0 @@
-import { ExploreActionKind } from "../../../exploreState";
-
-export type ClearMetaAction = {
-  payload: ClearMetaPayload;
-  type: ExploreActionKind.ClearMeta;
-};
-
-export type ClearMetaPayload = null;

package/src/providers/exploreState/actions/stateToUrl/action.ts

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

package/src/providers/exploreState/actions/stateToUrl/dispatch.ts

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

package/src/providers/exploreState/actions/stateToUrl/types.ts

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

package/src/providers/exploreState/actions/updateFilterSort/action.ts

@@ -1,30 +0,0 @@
-import { ExploreState } from "../../../exploreState";
-import { updateEntityStateByCategoryGroupConfigKey } from "../../utils";
-import { UpdateFilterSortPayload } from "./types";
-import { sortCategoryViews } from "./utils";
-
-/**
- * Reducer function to handle the "update filter sort" action.
- * Updates the filter sort in the state for the current entity.
- * @param state - Explore State.
- * @param payload - Payload.
- * @returns explore state.
- */
-export function updateFilterSortAction(
-  state: ExploreState,
-  payload: UpdateFilterSortPayload,
-): ExploreState {
-  const filterSort = payload;
-
-  // Sort the category views based on the new filter sort.
-  const categoryViews = sortCategoryViews(state, filterSort);
-
-  // Update entity state by category group config key
-  updateEntityStateByCategoryGroupConfigKey(state, { categoryViews });
-
-  return {
-    ...state,
-    categoryViews,
-    filterSort,
-  };
-}

package/src/providers/exploreState/actions/updateFilterSort/dispatch.ts

@@ -1,16 +0,0 @@
-import { ExploreActionKind } from "../../../exploreState";
-import { UpdateFilterSortAction, UpdateFilterSortPayload } from "./types";
-
-/**
- * Action creator for updating filter sort in the state.
- * @param payload - Payload.
- * @returns Action with payload and action type.
- */
-export function updateFilterSort(
-  payload: UpdateFilterSortPayload,
-): UpdateFilterSortAction {
-  return {
-    payload,
-    type: ExploreActionKind.UpdateFilterSort,
-  };
-}

package/src/providers/exploreState/actions/updateFilterSort/types.ts

@@ -1,9 +0,0 @@
-import { FILTER_SORT } from "../../../../common/filters/sort/config/types";
-import { ExploreActionKind } from "../../../exploreState";
-
-export type UpdateFilterSortAction = {
-  payload: UpdateFilterSortPayload;
-  type: ExploreActionKind.UpdateFilterSort;
-};
-
-export type UpdateFilterSortPayload = FILTER_SORT;

package/src/providers/exploreState/actions/updateFilterSort/utils.ts

@@ -1,30 +0,0 @@
-import { isRangeCategory } from "../../../../common/categories/models/range/typeGuards";
-import { CategoryView } from "../../../../common/categories/views/types";
-import { FILTER_SORT } from "../../../../common/filters/sort/config/types";
-import { sortCategoryValueViews } from "../../../../common/filters/sort/models/utils";
-import { ExploreState } from "../../../exploreState";
-
-/**
- * Sorts the category views for the current entity type, based on the filter sort.
- * @param state - Explore state.
- * @param filterSort - Filter sort.
- * @returns Sorted category views.
- */
-export function sortCategoryViews(
-  state: ExploreState,
-  filterSort: FILTER_SORT,
-): CategoryView[] {
-  return [...state.categoryViews].map((categoryView) => {
-    // Skip range categories.
-    if (isRangeCategory(categoryView)) return categoryView;
-
-    // Use structural clone for select categories that need sorting.
-    const nextCategoryView = {
-      ...categoryView,
-      values: [...categoryView.values],
-    };
-
-    sortCategoryValueViews(nextCategoryView.values, filterSort);
-    return nextCategoryView;
-  });
-}

package/src/providers/exploreState/actions/updateGrouping/action.ts

@@ -1,26 +0,0 @@
-import { ExploreState } from "../../../exploreState";
-import { updateEntityPageState } from "../../utils";
-import { UpdateGroupingPayload } from "./types";
-import { buildNextGrouping } from "./utils";
-
-/**
- * Reducer function to handle the "update grouping" action.
- * Updates the grouping in the state for the current entity.
- * @param state - Explore State.
- * @param payload - Payload.
- * @returns explore state.
- */
-export function updateGroupingAction(
-  state: ExploreState,
-  payload: UpdateGroupingPayload,
-): ExploreState {
-  const grouping = buildNextGrouping(state, payload.updaterOrValue);
-  return {
-    ...state,
-    entityPageState: updateEntityPageState(
-      state.tabValue,
-      state.entityPageState,
-      { grouping },
-    ),
-  };
-}

package/src/providers/exploreState/actions/updateGrouping/dispatch.ts

@@ -1,16 +0,0 @@
-import { ExploreActionKind } from "../../../exploreState";
-import { UpdateGroupingAction, UpdateGroupingPayload } from "./types";
-
-/**
- * Action creator for updating grouping in the state.
- * @param payload - Payload.
- * @returns Action with payload and action type.
- */
-export function updateGrouping(
-  payload: UpdateGroupingPayload,
-): UpdateGroupingAction {
-  return {
-    payload,
-    type: ExploreActionKind.UpdateGrouping,
-  };
-}

package/src/providers/exploreState/actions/updateGrouping/types.ts

@@ -1,11 +0,0 @@
-import { GroupingState, Updater } from "@tanstack/react-table";
-import { ExploreActionKind } from "../../../exploreState";
-
-export type UpdateGroupingAction = {
-  payload: UpdateGroupingPayload;
-  type: ExploreActionKind.UpdateGrouping;
-};
-
-export type UpdateGroupingPayload = {
-  updaterOrValue: Updater<GroupingState>;
-};

package/src/providers/exploreState/actions/updateGrouping/utils.ts

@@ -1,33 +0,0 @@
-import { GroupingState, Updater } from "@tanstack/react-table";
-import { resolveUpdater } from "../../../../components/Table/options/updater";
-import { ExploreState } from "../../../exploreState";
-
-/**
- * Builds the next grouping state for the current entity type.
- * Uses TanStack updater to update the grouping state.
- * @param state - Explore state.
- * @param updaterOrValue - Updater or value to update the grouping state.
- * @returns grouping state.
- */
-export function buildNextGrouping(
-  state: ExploreState,
-  updaterOrValue: Updater<GroupingState>,
-): GroupingState {
-  const grouping = resolveUpdater(updaterOrValue, getOldGrouping(state));
-  if (grouping.length > 1) {
-    // Explore state only supports single-column grouping.
-    return grouping.slice(-1);
-  }
-  return grouping;
-}
-
-/**
- * Retrieves the current "old" grouping state from the explore state, for the current entity type.
- * @param state - Explore state.
- * @returns old grouping state.
- */
-function getOldGrouping(state: ExploreState): GroupingState {
-  const { entityPageState, tabValue } = state;
-  const { grouping = [] } = entityPageState[tabValue];
-  return grouping;
-}

package/src/providers/exploreState/actions/updateVisibility/action.ts

@@ -1,29 +0,0 @@
-import { ExploreState } from "../../../exploreState";
-import { updateEntityPageState } from "../../utils";
-import { UpdateColumnVisibilityPayload } from "./types";
-import { buildNextColumnVisibility } from "./utils";
-
-/**
- * Reducer function to handle the "update column visibility" action.
- * Updates the column visibility in the state for the current entity.
- * @param state - Explore State.
- * @param payload - Payload.
- * @returns explore state.
- */
-export function updateColumnVisibilityAction(
-  state: ExploreState,
-  payload: UpdateColumnVisibilityPayload,
-): ExploreState {
-  const columnVisibility = buildNextColumnVisibility(
-    state,
-    payload.updaterOrValue,
-  );
-  return {
-    ...state,
-    entityPageState: updateEntityPageState(
-      state.tabValue,
-      state.entityPageState,
-      { columnVisibility },
-    ),
-  };
-}

package/src/providers/exploreState/actions/updateVisibility/dispatch.ts

@@ -1,19 +0,0 @@
-import { ExploreActionKind } from "../../../exploreState";
-import {
-  UpdateColumnVisibilityAction,
-  UpdateColumnVisibilityPayload,
-} from "./types";
-
-/**
- * Action creator for updating column visibility in the state.
- * @param payload - Payload.
- * @returns Action with payload and action type.
- */
-export function updateVisibility(
-  payload: UpdateColumnVisibilityPayload,
-): UpdateColumnVisibilityAction {
-  return {
-    payload,
-    type: ExploreActionKind.UpdateColumnVisibility,
-  };
-}

package/src/providers/exploreState/actions/updateVisibility/types.ts

@@ -1,11 +0,0 @@
-import { Updater, VisibilityState } from "@tanstack/react-table";
-import { ExploreActionKind } from "../../../exploreState";
-
-export type UpdateColumnVisibilityAction = {
-  payload: UpdateColumnVisibilityPayload;
-  type: ExploreActionKind.UpdateColumnVisibility;
-};
-
-export type UpdateColumnVisibilityPayload = {
-  updaterOrValue: Updater<VisibilityState>;
-};

package/src/providers/exploreState/actions/updateVisibility/utils.ts

@@ -1,28 +0,0 @@
-import { Updater, VisibilityState } from "@tanstack/react-table";
-import { resolveUpdater } from "../../../../components/Table/options/updater";
-import { ExploreState } from "../../../exploreState";
-
-/**
- * Builds the next column visibility state for the current entity type.
- * Uses TanStack updater to update the column visibility state.
- * @param state - Explore state.
- * @param updaterOrValue - Updater or value to update the column visibility state.
- * @returns column visibility state.
- */
-export function buildNextColumnVisibility(
-  state: ExploreState,
-  updaterOrValue: Updater<VisibilityState>,
-): VisibilityState {
-  return resolveUpdater(updaterOrValue, getOldColumnVisibility(state));
-}
-
-/**
- * Retrieves the current "old" state from the explore state, for the current entity type.
- * @param state - Explore state.
- * @returns old column visibility state.
- */
-function getOldColumnVisibility(state: ExploreState): VisibilityState {
-  const { entityPageState, tabValue } = state;
-  const { columnVisibility = {} } = entityPageState[tabValue];
-  return columnVisibility;
-}

package/src/providers/exploreState/actions/urlToState/action.ts

@@ -1,74 +0,0 @@
-import {
-  CatalogState,
-  ExploreState,
-  FeatureFlagState,
-} from "../../../exploreState";
-import { EXPLORE_URL_PARAMS } from "../../../exploreState/constants";
-import { buildNextEntities } from "../../entities/state";
-import {
-  getEntityCategoryGroupConfigKey,
-  getFilterCount,
-  updateEntityStateByCategoryGroupConfigKey,
-} from "../../utils";
-import { UrlToStatePayload } from "./types";
-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: ExploreState,
-  payload: UrlToStatePayload,
-): ExploreState {
-  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] as CatalogState;
-
-  // 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
-  ] as FeatureFlagState;
-
-  // 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/src/providers/exploreState/actions/urlToState/dispatch.ts

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

package/src/providers/exploreState/actions/urlToState/types.ts

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

package/src/providers/exploreState/actions/urlToState/utils.ts

@@ -1,18 +0,0 @@
-import { SelectedFilter } from "../../../../common/entities";
-
-/**
- * Returns the selected filters from the filter parameter value.
- * @param paramValue - The filter parameter value.
- * @returns The selected filters or an empty array.
- */
-export function decodeFilterParamValue(
-  paramValue: string | string[] | undefined,
-): SelectedFilter[] {
-  if (typeof paramValue === "string") {
-    // Return decoded filter param value if it is a string.
-    return JSON.parse(decodeURIComponent(paramValue));
-  }
-
-  // Default to an empty array.
-  return [];
-}

package/src/providers/exploreState/constants.ts

@@ -1,9 +0,0 @@
-export const EXPLORE_URL_PARAMS = {
-  CATALOG: "catalog",
-  FEATURE_FLAG: "ff",
-  FILTER: "filter",
-} as const;
-
-export const SELECT_CATEGORY_KEY = {
-  SAVED_FILTERS: "savedFilters",
-};

package/src/providers/exploreState/entities/query/buildQuery.ts

@@ -1,66 +0,0 @@
-import { NextRouter } from "next/router";
-import { SelectedFilter } from "../../../../common/entities";
-import { EntityState } from "../types";
-
-/**
- * Builds a query object from entity related state.
- * State values are expected to be undefined, string, or an array.
- * Undefined values and empty arrays are not included in the query.
- * @param entityListType - Entity list type.
- * @param state - Entity related state.
- * @returns A query object.
- */
-export function buildQuery(
-  entityListType: string,
-  state: EntityState,
-): NextRouter["query"] {
-  const query: NextRouter["query"] = {};
-
-  for (const [key, value] of Object.entries(
-    getQueryState(entityListType, state),
-  )) {
-    // Handle the undefined case.
-    if (value === undefined) continue;
-
-    // Handle the string case.
-    if (typeof value === "string") {
-      query[key] = value;
-      continue;
-    }
-
-    // Handle the array case.
-    if (value.length === 0) continue;
-    query[key] = JSON.stringify(value);
-  }
-
-  return query;
-}
-
-/**
- * Extracts URL-relevant values from the ExploreState for query parameter synchronization.
- *
- * This function maps specific properties from the full ExploreState to the
- * ExploreQueryState interface, which contains only the subset of state that
- * should be synchronized with the URL.
- *
- * The extracted properties are:
- * - catalog: Current catalog selection (string | undefined)
- * - entityListType: Entity list type (string)
- * - ff: Feature flag state (string | undefined)
- * - filter: Applied filters (SelectedFilter[])
- *
- * @param entityListType - Entity list type.
- * @param state - Entity related state.
- * @returns Subset of state used for URL query parameters.
- */
-export function getQueryState(
-  entityListType: string,
-  state: EntityState,
-): Record<string, string | SelectedFilter[] | undefined> {
-  return {
-    catalog: state.catalogState,
-    entityListType,
-    ff: state.featureFlagState,
-    filter: state.filterState,
-  };
-}