@databiosphere/findable-ui 5.0.0 → 7.0.0

package/lib/providers/exploreState/utils.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateSelectColumnVisibility = exports.updateEntityStateByCategoryGroupConfigKey = exports.updateEntityPageStateSorting = exports.updateEntityPageState = exports.resetRowSelection = exports.resetPage = exports.patchEntityListItems = exports.getFilterCount = exports.getEntityStateSavedSorting = exports.getEntityStateSavedFilter = exports.getEntityState = exports.getEntityCategoryGroupConfigKey = exports.buildNextSavedFilterState = exports.buildEntityStateSavedFilterState = void 0;
-const constants_1 = require("../../components/TableCreator/common/constants");
-const constants_2 = require("./initializer/constants");
+import { ACCESSOR_KEYS } from "../../components/TableCreator/common/constants";
+import { DEFAULT_ENTITY_STATE } from "./initializer/constants";
 /**
  * Returns the entity state saved filter state for the given category key.
  * @param categoryKey - Category key.
@@ -10,12 +7,11 @@ const constants_2 = require("./initializer/constants");
  * @param selected - True if value is selected, false if de-selected.
  * @returns entity state saved filter state.
  */
-function buildEntityStateSavedFilterState(categoryKey, selectedValue, selected) {
+export function buildEntityStateSavedFilterState(categoryKey, selectedValue, selected) {
     if (!selected)
         return [];
     return [{ categoryKey, value: [selectedValue] }];
 }
-exports.buildEntityStateSavedFilterState = buildEntityStateSavedFilterState;
 /**
  * Build new set of selected filters on de/select of a "saved filter" filter.
  * @param state - Explore state.
@@ -23,46 +19,53 @@ exports.buildEntityStateSavedFilterState = buildEntityStateSavedFilterState;
  * @param selected - True if value is selected, false if de-selected.
  * @returns new selected filters.
  */
-function buildNextSavedFilterState(state, selectedValue, selected) {
+export function buildNextSavedFilterState(state, selectedValue, selected) {
     if (!selected)
         return []; // Clears all filters on de-select of saved filter.
     const savedFilter = getEntityStateSavedFilter(state, selectedValue);
-    return (savedFilter === null || savedFilter === void 0 ? void 0 : savedFilter.filters) || [];
+    return savedFilter?.filters || [];
+}
+/**
+ * Closes row preview, if row preview is enabled.
+ * If row preview is enabled, the row preview state value is set to false.
+ * @param rowPreview - Row preview state.
+ * @returns row preview state with row preview value set to false.
+ */
+export function closeRowPreview(rowPreview) {
+    if (!rowPreview)
+        return rowPreview;
+    const [[key]] = Object.entries(rowPreview);
+    return { [key]: false };
 }
-exports.buildNextSavedFilterState = buildNextSavedFilterState;
 /**
  * Returns the category group config key for the current entity.
  * @param entityPath - Entity path.
  * @param entityPageState - Entity page state mapper.
  * @returns category group config key.
  */
-function getEntityCategoryGroupConfigKey(entityPath, entityPageState) {
+export function getEntityCategoryGroupConfigKey(entityPath, entityPageState) {
     return entityPageState[entityPath].categoryGroupConfigKey;
 }
-exports.getEntityCategoryGroupConfigKey = getEntityCategoryGroupConfigKey;
 /**
  * Returns the entity state for the current entity.
  * @param state - Explore state.
  * @param categoryGroupConfigKey - Category group config key.
  * @returns entity state.
  */
-function getEntityState(state, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
+export function getEntityState(state, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
     return (state.entityStateByCategoryGroupConfigKey.get(categoryGroupConfigKey) ||
-        constants_2.DEFAULT_ENTITY_STATE);
+        DEFAULT_ENTITY_STATE);
 }
-exports.getEntityState = getEntityState;
 /**
  * Returns the saved filter/sorting for the given category key.
  * @param state - Explore state.
  * @param categoryValueKey - Category key.
  * @returns saved filter/sorting for the category key.
  */
-function getEntityStateSavedFilter(state, categoryValueKey) {
-    var _a;
+export function getEntityStateSavedFilter(state, categoryValueKey) {
     const entityState = getEntityState(state);
-    return (_a = entityState.savedFilterByCategoryValueKey) === null || _a === void 0 ? void 0 : _a.get(categoryValueKey);
+    return entityState.savedFilterByCategoryValueKey?.get(categoryValueKey);
 }
-exports.getEntityStateSavedFilter = getEntityStateSavedFilter;
 /**
  * Returns entity state "saved filter" sorting for the given category value key.
  * @param state - Explore state.
@@ -70,22 +73,20 @@ exports.getEntityStateSavedFilter = getEntityStateSavedFilter;
  * @param selected - True if value is selected, false if de-selected.
  * @returns sorting.
  */
-function getEntityStateSavedSorting(state, selectedValue, selected) {
+export function getEntityStateSavedSorting(state, selectedValue, selected) {
     if (!selected)
         return;
     const savedFilter = getEntityStateSavedFilter(state, selectedValue);
-    return savedFilter === null || savedFilter === void 0 ? void 0 : savedFilter.sorting;
+    return savedFilter?.sorting;
 }
-exports.getEntityStateSavedSorting = getEntityStateSavedSorting;
 /**
  * Returns the filter count.
  * @param filterState - Filter state.
  * @returns filter count.
  */
-function getFilterCount(filterState) {
+export function getFilterCount(filterState) {
     return filterState.reduce((acc, filter) => acc + filter.value.length, 0);
 }
-exports.getFilterCount = getFilterCount;
 /**
  * Returns list items with updated list items patched.
  * @param listItems - List items.
@@ -93,7 +94,7 @@ exports.getFilterCount = getFilterCount;
  * @param listItemKey - List item key identifier to map list items.
  * @returns list items with updated list items patched.
  */
-function patchEntityListItems(listItems, updatedListItems, listItemKey) {
+export function patchEntityListItems(listItems, updatedListItems, listItemKey) {
     if (!listItems || !updatedListItems)
         return listItems;
     const listItemById = new Map(listItems.map((listItem) => [listItem[listItemKey], listItem]));
@@ -102,34 +103,17 @@ function patchEntityListItems(listItems, updatedListItems, listItemKey) {
     });
     return [...listItemById.values()];
 }
-exports.patchEntityListItems = patchEntityListItems;
 /**
  * Resets pagination.
  * @param paginationState - Pagination state.
  * @returns a reset pagination state.
  */
-function resetPage(paginationState) {
-    const nextPaginationState = Object.assign({}, paginationState);
+export function resetPage(paginationState) {
+    const nextPaginationState = { ...paginationState };
     nextPaginationState.index = null;
     nextPaginationState.currentPage = 1;
     return nextPaginationState;
 }
-exports.resetPage = resetPage;
-/**
- * Resets row selection for the current entity and entities that share the same category group config key.
- * @param state - Explore state.
- * @param categoryGroupConfigKey - Category group config key.
- * @returns entity page state mapper with row selection reset.
- */
-function resetRowSelection(state, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
-    return Object.entries(state.entityPageState).reduce((acc, [entityPath, entityPageState]) => {
-        if (entityPageState.categoryGroupConfigKey === categoryGroupConfigKey) {
-            return Object.assign(Object.assign({}, acc), { [entityPath]: Object.assign(Object.assign({}, entityPageState), { rowSelection: {} }) });
-        }
-        return Object.assign(Object.assign({}, acc), { [entityPath]: entityPageState });
-    }, {});
-}
-exports.resetRowSelection = resetRowSelection;
 /**
  * Sets entity state for the given category group config key.
  * @param categoryGroupConfigKey - Category group config key.
@@ -146,29 +130,34 @@ function setEntityStateByCategoryGroupConfigKey(categoryGroupConfigKey, state, n
  * @param nextEntityPageState - Partial next entity page state.
  * @returns updated entity page state.
  */
-function updateEntityPageState(entityPath, // entityListType.
+export function updateEntityPageState(entityPath, // entityListType.
 entityPageState, nextEntityPageState) {
-    return Object.assign(Object.assign({}, entityPageState), { [entityPath]: Object.assign(Object.assign({}, entityPageState[entityPath]), nextEntityPageState) });
+    return {
+        ...entityPageState,
+        [entityPath]: {
+            ...entityPageState[entityPath],
+            ...nextEntityPageState,
+        },
+    };
 }
-exports.updateEntityPageState = updateEntityPageState;
 /**
- * Updates entity page state sorting for all entities with the same category group config key.
+ * Updates entity page state for the current entity and entities that share the same category group config key.
  * @param state - Explore state.
- * @param sorting - Sorting.
+ * @param nextEntityPageState - Partial next entity page state.
+ * @param categoryGroupConfigKey - Category group config key.
  * @returns entity page state.
  */
-function updateEntityPageStateSorting(state, sorting) {
-    if (!sorting)
-        return state.entityPageState;
-    const categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState);
+export function updateEntityPageStateWithCommonCategoryGroupConfigKey(state, nextEntityPageState, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
     return Object.entries(state.entityPageState).reduce((acc, [entityPath, entityPageState]) => {
         if (entityPageState.categoryGroupConfigKey === categoryGroupConfigKey) {
-            return Object.assign(Object.assign({}, acc), { [entityPath]: Object.assign(Object.assign({}, entityPageState), { sorting }) });
+            return {
+                ...acc,
+                [entityPath]: { ...entityPageState, ...nextEntityPageState },
+            };
         }
-        return Object.assign(Object.assign({}, acc), { [entityPath]: entityPageState });
+        return { ...acc, [entityPath]: entityPageState };
     }, {});
 }
-exports.updateEntityPageStateSorting = updateEntityPageStateSorting;
 /**
  * Updates entity state by category group config key.
  * @param state - Explore state.
@@ -176,13 +165,15 @@ exports.updateEntityPageStateSorting = updateEntityPageStateSorting;
  * @param categoryGroupConfigKey - Category group config key.
  * @returns updated entity state by category group config key.
  */
-function updateEntityStateByCategoryGroupConfigKey(state, nextEntityState, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
+export function updateEntityStateByCategoryGroupConfigKey(state, nextEntityState, categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState)) {
     const entityState = getEntityState(state, categoryGroupConfigKey);
     if (entityState) {
-        setEntityStateByCategoryGroupConfigKey(categoryGroupConfigKey, state, Object.assign(Object.assign({}, entityState), nextEntityState));
+        setEntityStateByCategoryGroupConfigKey(categoryGroupConfigKey, state, {
+            ...entityState,
+            ...nextEntityState,
+        });
     }
 }
-exports.updateEntityStateByCategoryGroupConfigKey = updateEntityStateByCategoryGroupConfigKey;
 /**
  *  Updates the entity page state for each entity with row selection enabled,
  *  by updating the visibility of the "select" column based on user access and resetting row selection state.
@@ -190,12 +181,21 @@ exports.updateEntityStateByCategoryGroupConfigKey = updateEntityStateByCategoryG
  * @param canEdit - User has edit access.
  * @returns new entity page state mapper with updated column visibility and row selection state.
  */
-function updateSelectColumnVisibility(state, canEdit) {
+export function updateSelectColumnVisibility(state, canEdit) {
     return Object.entries(state.entityPageState).reduce((acc, [entityPath, entityPageState]) => {
         if (entityPageState.enableRowSelection) {
-            return Object.assign(Object.assign({}, acc), { [entityPath]: Object.assign(Object.assign({}, entityPageState), { columnsVisibility: Object.assign(Object.assign({}, entityPageState.columnsVisibility), { [constants_1.ACCESSOR_KEYS.SELECT]: canEdit }), rowSelection: {} }) });
+            return {
+                ...acc,
+                [entityPath]: {
+                    ...entityPageState,
+                    columnsVisibility: {
+                        ...entityPageState.columnsVisibility,
+                        [ACCESSOR_KEYS.SELECT]: canEdit,
+                    },
+                    rowSelection: {},
+                },
+            };
         }
-        return Object.assign(Object.assign({}, acc), { [entityPath]: entityPageState });
+        return { ...acc, [entityPath]: entityPageState };
     }, {});
 }
-exports.updateSelectColumnVisibility = updateSelectColumnVisibility;

package/lib/providers/exploreState.d.ts

@@ -1,17 +1,11 @@
 import React, { Dispatch, ReactNode } from "react";
 import { AzulSearchIndex } from "../apis/azul/common/entities";
 import { SelectCategoryView, SelectedFilter } from "../common/entities";
+import { RowPreviewState } from "../components/Table/features/RowPreview/entities";
 import { CategoryGroup, SiteConfig } from "../config/entities";
 import { EntityPageStateMapper, EntityStateByCategoryGroupConfigKey, ListItem } from "./exploreState/entities";
-import { ApplySavedFilterPayload, PaginateTablePayload, PatchExploreResponsePayload, ProcessExploreResponsePayload, ProcessRelatedResponsePayload, ResetExploreResponsePayload, ToggleEntityViewPayload, UpdateColumnVisibilityPayload, UpdateEntityFiltersPayload, UpdateEntityViewAccessPayload, UpdateFilterPayload, UpdateRowSelectionPayload, UpdateSortingPayload } from "./exploreState/payloads/entities";
+import { ApplySavedFilterPayload, PaginateTablePayload, PatchExploreResponsePayload, ProcessExploreResponsePayload, ResetExploreResponsePayload, UpdateColumnVisibilityPayload, UpdateEntityFiltersPayload, UpdateEntityViewAccessPayload, UpdateFilterPayload, UpdateRowPreviewPayload, UpdateRowSelectionPayload, UpdateSortingPayload } from "./exploreState/payloads/entities";
 export declare type CatalogState = string | undefined;
-/**
- * Entity view.
- */
-export declare enum ENTITY_VIEW {
-    EXACT = "EXACT",
-    RELATED = "RELATED"
-}
 /**
  * Explore context.
  */
@@ -31,12 +25,10 @@ export declare type ExploreState = {
     featureFlagState: FeatureFlagState;
     filterCount: number;
     filterState: SelectedFilter[];
-    isRelatedView: boolean;
     listItems: ListItems;
-    listView: ENTITY_VIEW | undefined;
     loading: boolean;
     paginationState: PaginationState;
-    relatedListItems: RelatedListItems;
+    rowPreview: RowPreviewState;
     tabValue: string;
 };
 /**
@@ -80,10 +72,6 @@ export interface PaginationState {
     previousIndex: PaginationIndex | null;
     rows: number;
 }
-/**
- * Related list items.
- */
-export declare type RelatedListItems = any[] | undefined;
 /**
  * Explore state context for storing and using filter-related and explore state.
  */
@@ -108,22 +96,21 @@ export declare enum ExploreActionKind {
     PaginateTable = "PAGINATE_TABLE",
     PatchExploreResponse = "PATCH_EXPLORE_RESPONSE",
     ProcessExploreResponse = "PROCESS_EXPLORE_RESPONSE",
-    ProcessRelatedResponse = "PROCESS_RELATED_RESPONSE",
     ResetExploreResponse = "RESET_EXPLORE_RESPONSE",
     ResetState = "RESET_STATE",
     SelectEntityType = "SELECT_ENTITY_TYPE",
-    ToggleEntityView = "TOGGLE_ENTITY_VIEW",
     UpdateColumnVisibility = "UPDATE_COLUMN_VISIBILITY",
     UpdateEntityFilters = "UPDATE_ENTITY_FILTERS",
     UpdateEntityViewAccess = "UPDATE_ENTITY_VIEW_ACCESS",
     UpdateFilter = "UPDATE_FILTER",
+    UpdateRowPreview = "UPDATE_ROW_PREVIEW",
     UpdateRowSelection = "UPDATE_ROW_SELECTION",
     UpdateSorting = "UPDATE_SORTING"
 }
 /**
  * Explore action.
  */
-export declare type ExploreAction = ApplySavedFilterAction | ClearFiltersAction | PaginateTableAction | PatchExploreResponseAction | ProcessExploreResponseAction | ProcessRelatedResponseAction | ResetExploreResponseAction | ResetStateAction | SelectEntityTypeAction | ToggleEntityViewAction | UpdateColumnVisibilityAction | UpdateEntityFiltersAction | UpdateEntityViewAccessAction | UpdateFilterAction | UpdateRowSelectionAction | UpdateSortingAction;
+export declare type ExploreAction = ApplySavedFilterAction | ClearFiltersAction | PaginateTableAction | PatchExploreResponseAction | ProcessExploreResponseAction | ResetExploreResponseAction | ResetStateAction | SelectEntityTypeAction | UpdateColumnVisibilityAction | UpdateEntityFiltersAction | UpdateEntityViewAccessAction | UpdateFilterAction | UpdateRowPreviewAction | UpdateRowSelectionAction | UpdateSortingAction;
 /**
  * Apply saved filter action.
  */
@@ -159,13 +146,6 @@ declare type ProcessExploreResponseAction = {
     payload: ProcessExploreResponsePayload;
     type: ExploreActionKind.ProcessExploreResponse;
 };
-/**
- * Process related response action.
- */
-declare type ProcessRelatedResponseAction = {
-    payload: ProcessRelatedResponsePayload;
-    type: ExploreActionKind.ProcessRelatedResponse;
-};
 /**
  * Reset explore response action.
  */
@@ -187,13 +167,6 @@ declare type SelectEntityTypeAction = {
     payload: string;
     type: ExploreActionKind.SelectEntityType;
 };
-/**
- * Toggle entity view action.
- */
-declare type ToggleEntityViewAction = {
-    payload: ToggleEntityViewPayload;
-    type: ExploreActionKind.ToggleEntityView;
-};
 /**
  * Update column visibility action.
  */
@@ -222,6 +195,13 @@ declare type UpdateFilterAction = {
     payload: UpdateFilterPayload;
     type: ExploreActionKind.UpdateFilter;
 };
+/**
+ * Update row preview action.
+ */
+export declare type UpdateRowPreviewAction = {
+    payload: UpdateRowPreviewPayload;
+    type: ExploreActionKind.UpdateRowPreview;
+};
 /**
  * Update row selection action.
  */