@databiosphere/findable-ui 3.0.0 → 3.2.0

package/lib/components/Links/common/constants.d.ts

@@ -0,0 +1 @@
+export declare const URL_OBJECT_KEYS: string[];

package/lib/components/Links/common/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.URL_OBJECT_KEYS = void 0;
+exports.URL_OBJECT_KEYS = ["href", "query"];

package/lib/components/Links/common/entities.d.ts

@@ -1,4 +1,12 @@
+/// <reference types="node" />
+import { UrlObject } from "url";
 export declare enum ANCHOR_TARGET {
     BLANK = "_blank",
     SELF = "_self"
 }
+export declare type StrictUrlObject = Omit<UrlObject, "href" | "query"> & {
+    href: string;
+    query: string;
+};
+export declare type Url = string | UrlObjectWithHrefAndQuery;
+export declare type UrlObjectWithHrefAndQuery = Pick<StrictUrlObject, "href" | "query">;

package/lib/components/Links/common/utils.d.ts

@@ -1,6 +1,19 @@
+import { Url, UrlObjectWithHrefAndQuery } from "./entities";
 /**
  * Returns true if the given link is an internal link.
  * @param link - Link.
  * @returns true if the given link is an internal link.
  */
 export declare function isClientSideNavigation(link: string): boolean;
+/**
+ * Returns true if the given url is a URL object with href and query.
+ * @param value - URL.
+ * @returns true if the given url is a URL object with href and query.
+ */
+export declare function isURLObjectWithHrefAndQuery(value: Url): value is UrlObjectWithHrefAndQuery;
+/**
+ * Returns true if the given url is a string.
+ * @param value - URL.
+ * @returns true if the given url is a string.
+ */
+export declare function isURLString(value: Url): value is string;

package/lib/components/Links/common/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isClientSideNavigation = void 0;
+exports.isURLString = exports.isURLObjectWithHrefAndQuery = exports.isClientSideNavigation = void 0;
+const constants_1 = require("./constants");
 /**
  * Returns true if the given link is an internal link.
  * @param link - Link.
@@ -10,3 +11,22 @@ function isClientSideNavigation(link) {
     return /^\/(?!\/)/.test(link);
 }
 exports.isClientSideNavigation = isClientSideNavigation;
+/**
+ * Returns true if the given url is a URL object with href and query.
+ * @param value - URL.
+ * @returns true if the given url is a URL object with href and query.
+ */
+function isURLObjectWithHrefAndQuery(value) {
+    return (typeof value !== "string" &&
+        Object.entries(value).every(([key, value]) => constants_1.URL_OBJECT_KEYS.includes(key) && !!value));
+}
+exports.isURLObjectWithHrefAndQuery = isURLObjectWithHrefAndQuery;
+/**
+ * Returns true if the given url is a string.
+ * @param value - URL.
+ * @returns true if the given url is a string.
+ */
+function isURLString(value) {
+    return typeof value === "string";
+}
+exports.isURLString = isURLString;

package/lib/components/Links/components/Link/components/ExploreViewLink/exploreViewLink.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { UrlObjectWithHrefAndQuery } from "../../../../common/entities";
+import { LinkProps } from "../../link";
+export interface ExploreViewLinkProps extends Omit<LinkProps, "copyable" | "noWrap" | "url"> {
+    url: UrlObjectWithHrefAndQuery;
+}
+export declare const ExploreViewLink: ({ className, label, onClick, target, url, }: ExploreViewLinkProps) => JSX.Element;

package/lib/components/Links/components/Link/components/ExploreViewLink/exploreViewLink.js

@@ -0,0 +1,148 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExploreViewLink = void 0;
+const link_1 = __importDefault(require("next/link"));
+const react_1 = __importStar(require("react"));
+const useExploreState_1 = require("../../../../../../hooks/useExploreState");
+const exploreState_1 = require("../../../../../../providers/exploreState");
+const entities_1 = require("../../../../common/entities");
+const PARAM_FILTER = "filter";
+const ExploreViewLink = ({ className, label, onClick, target = entities_1.ANCHOR_TARGET.SELF, url, }) => {
+    const { exploreDispatch, exploreState } = (0, useExploreState_1.useExploreState)();
+    if (!isValidExploreURL(url, exploreState)) {
+        throwError(url);
+    }
+    const onNavigate = (0, react_1.useCallback)(() => {
+        const entityListType = getEntityListType(url.href);
+        const filters = getSelectedFilters(url.query);
+        exploreDispatch({
+            payload: { entityListType, filters },
+            type: exploreState_1.ExploreActionKind.UpdateEntityFilters,
+        });
+        onClick === null || onClick === void 0 ? void 0 : onClick();
+    }, [exploreDispatch, onClick, url]);
+    return (react_1.default.createElement(link_1.default, { className: className, href: url.href, onClick: onNavigate, rel: "noopener", target: target }, label));
+};
+exports.ExploreViewLink = ExploreViewLink;
+/**
+ * Returns the entity list type "entityListType" inferred from the given href.
+ * @param href - Href.
+ * @returns entity list type.
+ */
+function getEntityListType(href) {
+    return href.substring(1);
+}
+/**
+ * Returns the selected filters from the given query.
+ * @param query - Query.
+ * @returns selected filters.
+ */
+function getSelectedFilters(query) {
+    const decodedQuery = decodeURIComponent(query);
+    const parsedQuery = JSON.parse(decodedQuery);
+    return parsedQuery[PARAM_FILTER];
+}
+/**
+ * Returns true if the given value is a SelectedFilter.
+ * @param value - Value.
+ * @returns true if the given value is a SelectedFilter.
+ */
+function isSelectedFilter(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "categoryKey" in value &&
+        "value" in value);
+}
+/**
+ * Returns true if the given query string is a valid JSON string.
+ * @param query - Query string.
+ * @returns true if the given query string is a valid JSON string.
+ */
+function isValidJsonString(query) {
+    try {
+        JSON.parse(query);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * Returns true if the given explore link is valid.
+ * @param url - Explore link URL.
+ * @param exploreState - Explore state.
+ * @returns true if the given explore link is valid.
+ */
+function isValidExploreURL(url, exploreState) {
+    const validHref = isValidHref(url, exploreState);
+    const validQuery = isValidQuery(url);
+    return validHref && validQuery;
+}
+/**
+ * Returns true if the given href is a configured key in the explore state's entityPageState.
+ * @param url - Explore link URL.
+ * @param exploreState - Explore state.
+ * @returns true if the given href is configured in the explore state.
+ */
+function isValidHref(url, exploreState) {
+    const { entityPageState } = exploreState;
+    const { href } = url;
+    return href.startsWith("/") && href.substring(1) in entityPageState;
+}
+/**
+ * Returns true if the given explore query is valid.
+ * @param url - Explore link URL.
+ * @returns true if the given explore query is valid.
+ */
+function isValidQuery(url) {
+    const { query } = url;
+    // Decode and parse the query.
+    const decodedQuery = decodeURIComponent(query);
+    // Query should be a valid JSON string.
+    if (isValidJsonString(decodedQuery)) {
+        const parsedQuery = JSON.parse(decodedQuery);
+        // Query should contain "filter" key.
+        if (PARAM_FILTER in parsedQuery) {
+            const filters = parsedQuery[PARAM_FILTER];
+            // Filter should be an array.
+            if (Array.isArray(filters)) {
+                // Filter should contain only SelectedFilter objects.
+                return filters.every(isSelectedFilter);
+            }
+        }
+    }
+    return false;
+}
+/**
+ * Throws an error with the given URL object.
+ * @param url - URL object.
+ */
+function throwError(url) {
+    throw new Error(`Invalid explore URL href or query: ${url.href}, ${url.query}`);
+}

package/lib/components/Links/components/Link/link.d.ts

@@ -1,6 +1,6 @@
 import { LinkProps as MLinkProps } from "@mui/material";
 import { ReactNode } from "react";
-import { ANCHOR_TARGET } from "../../common/entities";
+import { ANCHOR_TARGET, Url } from "../../common/entities";
 export interface LinkProps {
     className?: string;
     copyable?: boolean;
@@ -8,6 +8,6 @@ export interface LinkProps {
     noWrap?: MLinkProps["noWrap"];
     onClick?: () => void;
     target?: ANCHOR_TARGET;
-    url: string;
+    url: Url;
 }
 export declare const Link: ({ className, copyable, label, noWrap, onClick, target, url, }: LinkProps) => JSX.Element;

package/lib/components/Links/components/Link/link.js

@@ -11,12 +11,28 @@ const utils_1 = require("../../../../common/utils");
 const copyToClipboard_1 = require("../../../common/CopyToClipboard/copyToClipboard");
 const entities_1 = require("../../common/entities");
 const utils_2 = require("../../common/utils");
+const exploreViewLink_1 = require("./components/ExploreViewLink/exploreViewLink");
 const Link = ({ className, copyable = false, label, noWrap = false, onClick, target, url, }) => {
-    return (react_1.default.createElement(react_1.default.Fragment, null, (0, utils_2.isClientSideNavigation)(url) ? (react_1.default.createElement(react_1.default.Fragment, null,
-        react_1.default.createElement(link_1.default, { href: url, legacyBehavior: true, passHref: true },
-            react_1.default.createElement(material_1.Link, { className: className, rel: "noopener", noWrap: noWrap, target: target || entities_1.ANCHOR_TARGET.SELF, onClick: onClick }, label)),
-        copyable && react_1.default.createElement(copyToClipboard_1.CopyToClipboard, { copyStr: url }))) : (0, utils_1.isValidUrl)(url) ? (react_1.default.createElement(react_1.default.Fragment, null,
-        react_1.default.createElement(material_1.Link, { className: className, href: url, rel: "noopener noreferrer", noWrap: noWrap, target: target || entities_1.ANCHOR_TARGET.BLANK, onClick: onClick }, label),
-        copyable && react_1.default.createElement(copyToClipboard_1.CopyToClipboard, { copyStr: url }))) : (label)));
+    if ((0, utils_2.isURLObjectWithHrefAndQuery)(url)) {
+        /* Internal navigation - explore link */
+        return (react_1.default.createElement(exploreViewLink_1.ExploreViewLink, { className: className, label: label, onClick: onClick, target: target, url: url }));
+    }
+    if ((0, utils_2.isURLString)(url)) {
+        if ((0, utils_2.isClientSideNavigation)(url)) {
+            /* Client-side navigation */
+            return (react_1.default.createElement(react_1.default.Fragment, null,
+                react_1.default.createElement(link_1.default, { href: url, legacyBehavior: true, passHref: true },
+                    react_1.default.createElement(material_1.Link, { className: className, rel: "noopener", noWrap: noWrap, target: target || entities_1.ANCHOR_TARGET.SELF, onClick: onClick }, label)),
+                copyable && react_1.default.createElement(copyToClipboard_1.CopyToClipboard, { copyStr: url })));
+        }
+        if ((0, utils_1.isValidUrl)(url)) {
+            /* External navigation */
+            return (react_1.default.createElement(react_1.default.Fragment, null,
+                react_1.default.createElement(material_1.Link, { className: className, href: url, noWrap: noWrap, onClick: onClick, rel: "noopener noreferrer", target: target || entities_1.ANCHOR_TARGET.BLANK }, label),
+                copyable && react_1.default.createElement(copyToClipboard_1.CopyToClipboard, { copyStr: url })));
+        }
+    }
+    /* Invalid URL */
+    return react_1.default.createElement(react_1.default.Fragment, null, label);
 };
 exports.Link = Link;

package/lib/components/common/Progress/components/CircularProgress/circularProgress.d.ts

@@ -0,0 +1,7 @@
+import { CircularProgressProps as MCircularProgressProps } from "@mui/material";
+import { ElementType } from "react";
+export interface CircularProgressProps extends MCircularProgressProps {
+    className?: string;
+    Track?: ElementType<CircularProgressProps>;
+}
+export declare const CircularProgress: ({ className, value, Track, ...props }: CircularProgressProps) => JSX.Element;

package/lib/components/common/Progress/components/CircularProgress/circularProgress.js

@@ -0,0 +1,28 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircularProgress = void 0;
+const material_1 = require("@mui/material");
+const react_1 = __importDefault(require("react"));
+const circularProgress_styles_1 = require("./circularProgress.styles");
+const circularProgressTrack_1 = require("./components/CircularProgressTrack/circularProgressTrack");
+const CircularProgress = (_a) => {
+    var { className, value, Track = circularProgressTrack_1.CircularProgressTrack } = _a, props = __rest(_a, ["className", "value", "Track"]) /* Spread props to allow for CircularProgress specific props e.g. "disableShrink". */;
+    return (react_1.default.createElement(circularProgress_styles_1.ProgressPositioner, { className: className },
+        react_1.default.createElement(Track, Object.assign({}, props)),
+        react_1.default.createElement(material_1.CircularProgress, Object.assign({ value: value }, props))));
+};
+exports.CircularProgress = CircularProgress;

package/lib/components/common/Progress/components/CircularProgress/circularProgress.styles.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const ProgressPositioner: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any> | undefined;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;

package/lib/components/common/Progress/components/CircularProgress/circularProgress.styles.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgressPositioner = void 0;
+const styled_1 = __importDefault(require("@emotion/styled"));
+exports.ProgressPositioner = styled_1.default.div `
+  display: flex;
+  position: relative; /* positions track */
+`;

package/lib/components/common/Progress/components/CircularProgress/components/CircularProgressTrack/circularProgressTrack.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { CircularProgressProps as MCircularProgressProps } from "@mui/material";
+export interface CircularProgressTrackProps extends MCircularProgressProps {
+    className?: string;
+    track?: boolean;
+}
+export declare const CircularProgressTrack: ({ className, track, value, ...props }: CircularProgressTrackProps) => JSX.Element;

package/lib/components/common/Progress/components/CircularProgress/components/CircularProgressTrack/circularProgressTrack.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircularProgressTrack = void 0;
+const react_1 = __importStar(require("react"));
+const circularProgressTrack_styles_1 = require("./circularProgressTrack.styles");
+const CircularProgressTrack = (_a) => {
+    var { className, track = true, value = 100 } = _a, props = __rest(_a, ["className", "track", "value"]) /* Spread props to allow for CircularProgress specific props e.g. "disableShrink". */;
+    return (react_1.default.createElement(react_1.Fragment, null, track && (react_1.default.createElement(circularProgressTrack_styles_1.CircularProgress, Object.assign({ className: className, value: value }, props)))));
+};
+exports.CircularProgressTrack = CircularProgressTrack;

package/lib/components/common/Progress/components/CircularProgress/components/CircularProgressTrack/circularProgressTrack.styles.d.ts

@@ -0,0 +1,3 @@
+export declare const CircularProgress: import("@emotion/styled").StyledComponent<import("@mui/material").CircularProgressProps & {
+    theme?: import("@emotion/react").Theme | undefined;
+}, {}, {}>;

package/lib/components/common/Progress/components/CircularProgress/components/CircularProgressTrack/circularProgressTrack.styles.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircularProgress = void 0;
+const styled_1 = __importDefault(require("@emotion/styled"));
+const material_1 = require("@mui/material");
+const colors_1 = require("../../../../../../../styles/common/mixins/colors");
+exports.CircularProgress = (0, styled_1.default)(material_1.CircularProgress) `
+  color: ${colors_1.smokeLight};
+  left: 0;
+  position: absolute;
+  top: 0;
+  z-index: 0;
+
+  &.MuiCircularProgress-colorAlert {
+    color: ${colors_1.alertLight};
+  }
+
+  &.MuiCircularProgress-colorInfo {
+    color: ${colors_1.infoLight};
+  }
+
+  &.MuiCircularProgress-colorSuccess {
+    color: ${colors_1.successLight};
+  }
+
+  &.MuiCircularProgress-colorWarning {
+    color: ${colors_1.warningLight};
+  }
+`;

package/lib/config/entities.d.ts

@@ -1,7 +1,7 @@
 import { TabProps as MTabProps, Theme, ThemeOptions } from "@mui/material";
 import { ColumnSort } from "@tanstack/react-table";
 import { JSXElementConstructor, ReactNode } from "react";
-import { CategoryKey, SelectedFilter, SelectedFilterValue } from "../common/entities";
+import { CategoryKey, SelectCategoryValueView, SelectedFilter, SelectedFilterValue } from "../common/entities";
 import { HeroTitle } from "../components/common/Title/title";
 import { FooterProps } from "../components/Layout/components/Footer/footer";
 import { HeaderProps } from "../components/Layout/components/Header/header";
@@ -66,6 +66,7 @@ export interface CategoryGroup {
 export interface CategoryConfig {
     key: string;
     label: string;
+    mapSelectCategoryValue?: (selectCategoryValue: SelectCategoryValueView) => SelectCategoryValueView;
 }
 /**
  * Column configuration.

package/lib/hooks/useCategoryFilter.d.ts

@@ -1,4 +1,4 @@
-import { CategoryKey, CategoryValueKey, Filters, SelectCategory, SelectCategoryView } from "../common/entities";
+import { CategoryKey, CategoryValueKey, Filters, SelectCategory, SelectCategoryValue, SelectCategoryView } from "../common/entities";
 import { CategoryConfig } from "../config/entities";
 /**
  * State backing filter functionality and calculations. Converted to view model for display.
@@ -33,3 +33,9 @@ export declare function buildCategoryViews(categories: SelectCategory[], categor
  * @returns New filter state generated from the current set of selected values and the newly selected value.
  */
 export declare function buildNextFilterState(filterState: FilterState, categoryKey: CategoryKey, selectedValue: CategoryValueKey, selected: boolean): FilterState;
+/**
+ * Default function returning select category value, unmodified.
+ * @param selectCategoryValue - Select category value.
+ * @returns original select category value.
+ */
+export declare function getSelectCategoryValue(selectCategoryValue: SelectCategoryValue): SelectCategoryValue;

package/lib/hooks/useCategoryFilter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildNextFilterState = exports.buildCategoryViews = void 0;
+exports.getSelectCategoryValue = exports.buildNextFilterState = exports.buildCategoryViews = void 0;
 const constants_1 = require("../common/constants");
 /**
  * Build the view-specific model of the given category value.
@@ -27,11 +27,13 @@ function buildCategoryValueView(categoryValue, categorySelectedFilter) {
  * @returns Full built category value view, ready for display.
  */
 function buildCategoryView(category, categoryValueViews, categoryConfigs) {
+    const categoryConfig = findCategoryConfig(category.key, categoryConfigs);
+    const mapSelectCategoryValue = (categoryConfig === null || categoryConfig === void 0 ? void 0 : categoryConfig.mapSelectCategoryValue) || getSelectCategoryValue;
     return {
         isDisabled: false,
         key: category.key,
-        label: getCategoryLabel(category.key, categoryConfigs),
-        values: categoryValueViews,
+        label: getCategoryLabel(category.key, categoryConfig),
+        values: categoryValueViews.map(mapSelectCategoryValue),
     };
 }
 /**
@@ -107,16 +109,33 @@ function getCategorySelectedFilter(categoryKey, filterState) {
 /**
  * Get the label for the given category key as per the config.
  * @param key - Key of category to find label of.
- * @param categoryConfigs - Category accept list.
+ * @param categoryConfig - Category.
  * @returns the display value for the given category.
  */
-function getCategoryLabel(key, categoryConfigs) {
-    const categoryConfig = categoryConfigs.find((categoryConfig) => categoryConfig.key === key);
+function getCategoryLabel(key, categoryConfig) {
     if (!categoryConfig) {
         return key;
     }
     return categoryConfig.label;
 }
+/**
+ * Default function returning select category value, unmodified.
+ * @param selectCategoryValue - Select category value.
+ * @returns original select category value.
+ */
+function getSelectCategoryValue(selectCategoryValue) {
+    return selectCategoryValue;
+}
+exports.getSelectCategoryValue = getSelectCategoryValue;
+/**
+ * Returns the category config for the given category config key.
+ * @param key - Category config key.
+ * @param categoryConfigs - Category configs.
+ * @returns category config.
+ */
+function findCategoryConfig(key, categoryConfigs) {
+    return categoryConfigs.find((categoryConfig) => categoryConfig.key === key);
+}
 /**
  * Determine if given category value is selected.
  * @param categoryValueKey - The key of the category value to check if selected in the filter state.

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

@@ -1,5 +1,7 @@
+import { CategoryGroup } from "../../../config/entities";
 import { ExploreState, PaginationState } from "../../exploreState";
 import { EntityState } from "../entities";
+export declare const DEFAULT_CATEGORY_GROUP_SAVED_FILTERS: CategoryGroup;
 export declare const DEFAULT_ENTITY_STATE: EntityState;
 export declare const DEFAULT_PAGINATION_STATE: PaginationState;
 export declare const INITIAL_STATE: ExploreState;

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

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.INITIAL_STATE = exports.DEFAULT_PAGINATION_STATE = exports.DEFAULT_ENTITY_STATE = void 0;
+exports.INITIAL_STATE = exports.DEFAULT_PAGINATION_STATE = exports.DEFAULT_ENTITY_STATE = exports.DEFAULT_CATEGORY_GROUP_SAVED_FILTERS = void 0;
+const constants_1 = require("../constants");
+exports.DEFAULT_CATEGORY_GROUP_SAVED_FILTERS = {
+    categoryConfigs: [
+        { key: constants_1.SELECT_CATEGORY_KEY.SAVED_FILTERS, label: "Saved Filters" },
+    ],
+};
 exports.DEFAULT_ENTITY_STATE = {
     categoryViews: [],
     filterState: [],

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

@@ -16,14 +16,7 @@ function buildCategoryGroups(categoryGroupConfig) {
     const { categoryGroups, savedFilters } = categoryGroupConfig;
     if (!savedFilters)
         return categoryGroups;
-    const clonedCategoryGroups = [...categoryGroups];
-    const savedFiltersCategoryGroup = {
-        categoryConfigs: [
-            { key: constants_2.SELECT_CATEGORY_KEY.SAVED_FILTERS, label: "Saved Filters" },
-        ],
-    };
-    clonedCategoryGroups.unshift(savedFiltersCategoryGroup);
-    return clonedCategoryGroups;
+    return [constants_3.DEFAULT_CATEGORY_GROUP_SAVED_FILTERS, ...categoryGroups];
 }
 /**
  * Returns the saved filters as select categories.

package/lib/providers/exploreState/payloads/entities.d.ts

@@ -1,5 +1,5 @@
 import { ColumnSort, RowSelectionState, VisibilityState } from "@tanstack/react-table";
-import { CategoryKey, CategoryValueKey, PaginationDirectionType, SelectCategory } from "../../../common/entities";
+import { CategoryKey, CategoryValueKey, PaginationDirectionType, SelectCategory, SelectedFilter } from "../../../common/entities";
 import { ENTITY_VIEW, ListItems, PaginationResponse, RelatedListItems } from "../../exploreState";
 import { ListItem } from "../entities";
 /**
@@ -48,6 +48,13 @@ export declare type ToggleEntityViewPayload = ENTITY_VIEW;
  * Update column visibility payload.
  */
 export declare type UpdateColumnVisibilityPayload = VisibilityState;
+/**
+ * Update entity filters payload.
+ */
+export interface UpdateEntityFiltersPayload {
+    entityListType: string;
+    filters: SelectedFilter[];
+}
 /**
  * Update entity view access payload.
  */

package/lib/providers/exploreState/utils.d.ts

@@ -70,9 +70,10 @@ export declare function resetPage(paginationState: PaginationState): PaginationS
 /**
  * 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.
  */
-export declare function resetRowSelection(state: ExploreState): EntityPageStateMapper;
+export declare function resetRowSelection(state: ExploreState, categoryGroupConfigKey?: string): EntityPageStateMapper;
 /**
  * Updates entity page state for the given entity path.
  * @param entityPath - Entity path.
@@ -93,9 +94,10 @@ export declare function updateEntityPageStateSorting(state: ExploreState, sortin
  * Updates entity state by category group config key.
  * @param state - Explore state.
  * @param nextEntityState - Partial next entity state.
+ * @param categoryGroupConfigKey - Category group config key.
  * @returns updated entity state by category group config key.
  */
-export declare function updateEntityStateByCategoryGroupConfigKey(state: ExploreState, nextEntityState: Partial<EntityState>): void;
+export declare function updateEntityStateByCategoryGroupConfigKey(state: ExploreState, nextEntityState: Partial<EntityState>, categoryGroupConfigKey?: string): void;
 /**
  *  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.

package/lib/providers/exploreState/utils.js

@@ -118,10 +118,10 @@ 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) {
-    const categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState);
+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: {} }) });
@@ -173,10 +173,10 @@ exports.updateEntityPageStateSorting = updateEntityPageStateSorting;
  * Updates entity state by category group config key.
  * @param state - Explore state.
  * @param nextEntityState - Partial next entity state.
+ * @param categoryGroupConfigKey - Category group config key.
  * @returns updated entity state by category group config key.
  */
-function updateEntityStateByCategoryGroupConfigKey(state, nextEntityState) {
-    const categoryGroupConfigKey = getEntityCategoryGroupConfigKey(state.tabValue, state.entityPageState);
+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));