@k-int/stripes-kint-components 5.25.3 → 5.27.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [5.27.0](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.26.0...v5.27.0) (2025-10-21)
+
+
+### Features
+
+* **generateKiwtQueryParams:** Added filterConfig.filterPrefix and filterConfig.valuesMapping options ([77915db](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/77915db6b9d189531e80e9ea8af3bbf82636b9cb))
+* useStandaloneSASQQueryParameter for non-stripes filter options (not recommended) ([631ecfe](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/631ecfe4dae3d90b71e9468a1c2a8e2f30babb6b))
+
+# [5.26.0](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.25.3...v5.26.0) (2025-10-15)
+
+
+### Bug Fixes
+
+* Agreements/Licenses: Term / Suppl. property values disappear when other terms / optional properties of same category are deleted -- ERM-3813 ([37a70ac](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/37a70ac46b98146ca96f15cc39cf927bb32596a6))
+
+
+### Features
+
+* Add ability to choose view URL identifier in SASQRoute (and children) via `getNavigationIdentifier` -- refs ERM-3804 ([8356b97](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/8356b97488bba5220ed2cb81017149527e444068))
+
 ## [5.25.3](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.25.2...v5.25.3) (2025-09-16)
 
 

package/es/lib/CustomProperties/Edit/CustomPropertiesListField.js

@@ -89,7 +89,7 @@ const CustomPropertiesList = _ref => {
         onChange,
         setCustomProperties,
         value
-      }, "customPropertyField-".concat(customProperty.value, "-").concat(index));
+      }, "customPropertyField-".concat(customProperty.value));
     }).filter(cp => cp !== undefined);
   };
   return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {

package/es/lib/SASQLookupComponent/TableBody/TableBody.js

@@ -41,6 +41,7 @@ const TableBody = _ref => {
       resultColumns,
       rowNavigation = true,
       // Default navigation onRowClick
+      getNavigationIdentifier = row => row === null || row === void 0 ? void 0 : row.id,
       toggleFilterPane,
       query
     } = _ref,
@@ -60,14 +61,14 @@ const TableBody = _ref => {
   // Build the list of visible columns
   const visibleColumns = resultColumns.map(e => e.propertyPath);
   const getRowUrl = (0, _react.useCallback)(rowData => {
-    const baseUrl = "".concat(path, "/").concat(rowData === null || rowData === void 0 ? void 0 : rowData.id);
+    const baseUrl = "".concat(path, "/").concat(getNavigationIdentifier(rowData));
     return {
       url: "".concat(baseUrl).concat(location === null || location === void 0 ? void 0 : location.search),
       path,
       baseUrl,
       location
     };
-  }, [location, path]);
+  }, [getNavigationIdentifier, location, path]);
   const getEnhancedFormatter = (0, _react.useCallback)(() => {
     const enhancedFormatter = {};
     for (const [key, value] of Object.entries(formatter)) {
@@ -90,8 +91,8 @@ const TableBody = _ref => {
     let {
       item
     } = _ref2;
-    return item.id === (match === null || match === void 0 || (_match$params = match.params) === null || _match$params === void 0 ? void 0 : _match$params.id);
-  }, [match === null || match === void 0 || (_match$params2 = match.params) === null || _match$params2 === void 0 ? void 0 : _match$params2.id]);
+    return getNavigationIdentifier(item) === (match === null || match === void 0 || (_match$params = match.params) === null || _match$params === void 0 ? void 0 : _match$params.id);
+  }, [getNavigationIdentifier, match === null || match === void 0 || (_match$params2 = match.params) === null || _match$params2 === void 0 ? void 0 : _match$params2.id]);
   const NoResultsComponent = (0, _react.useMemo)(() => {
     var _noResultsProps$compo;
     return (_noResultsProps$compo = noResultsProps === null || noResultsProps === void 0 ? void 0 : noResultsProps.component) !== null && _noResultsProps$compo !== void 0 ? _noResultsProps$compo : _NoResultsMessage.default;
@@ -148,6 +149,7 @@ TableBody.propTypes = {
   query: _propTypes.default.object,
   resultColumns: _propTypes.default.arrayOf(_propTypes.default.object),
   rowNavigation: _propTypes.default.bool,
+  getNavigationIdentifier: _propTypes.default.func,
   toggleFilterPane: _propTypes.default.func
 };
 var _default = exports.default = TableBody;

package/es/lib/hooks/index.js

@@ -22,7 +22,8 @@ var _exportNames = {
   useMutateRefdataCategory: true,
   useMutateCustomProperties: true,
   useMutateModConfigEntry: true,
-  usePrevNextPagination: true
+  usePrevNextPagination: true,
+  useStandaloneSASQQueryParameter: true
 };
 Object.defineProperty(exports, "useActionListRef", {
   enumerable: true,
@@ -132,6 +133,12 @@ Object.defineProperty(exports, "useSASQQueryMeta", {
     return _useSASQQueryMeta.default;
   }
 });
+Object.defineProperty(exports, "useStandaloneSASQQueryParameter", {
+  enumerable: true,
+  get: function () {
+    return _useStandaloneSASQQueryParameter.default;
+  }
+});
 Object.defineProperty(exports, "useTemplates", {
   enumerable: true,
   get: function () {
@@ -157,6 +164,7 @@ var _useMutateRefdataCategory = _interopRequireDefault(require("./useMutateRefda
 var _useMutateCustomProperties = _interopRequireDefault(require("./useMutateCustomProperties"));
 var _useMutateModConfigEntry = _interopRequireDefault(require("./useMutateModConfigEntry"));
 var _usePrevNextPagination = _interopRequireDefault(require("./usePrevNextPagination"));
+var _useStandaloneSASQQueryParameter = _interopRequireDefault(require("./useStandaloneSASQQueryParameter"));
 var _intlHooks = require("./intlHooks");
 Object.keys(_intlHooks).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/es/lib/hooks/useStandaloneSASQQueryParameter/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _useStandaloneSASQQueryParameter.default;
+  }
+});
+var _useStandaloneSASQQueryParameter = _interopRequireDefault(require("./useStandaloneSASQQueryParameter"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/es/lib/hooks/useStandaloneSASQQueryParameter/useStandaloneSASQQueryParameter.js

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = require("react");
+var _reactRouter = require("react-router");
+var _queryString = _interopRequireDefault(require("query-string"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+// !WARNING! This pattern is not recommended
+// You likely want to make use of the filterConfig valuesMapping/filterPrefix
+// instead so SASQ filters can be used natively
+/**
+ * Custom hook for managing a single, standalone URL query parameter.
+ *
+ * This hook automatically reads a specified query parameter from the URL. If the
+ * parameter is missing on the initial load, it uses `defaultValue` and updates
+ * the URL to include it. It provides a `handler` function to update the
+ * parameter's value in the URL, which defaults to `fallbackValue` if no new
+ * value is explicitly provided to the handler.
+ *
+ * @param {object} props - The properties object.
+ * @param {string} props.name - The name of the query parameter to manage (e.g., 'showDetails').
+ * @param {string} [props.defaultValue='true'] - The value to set in the URL if the parameter is missing on initial load.
+ * @param {string} [props.fallbackValue='false'] - The value to set when the `handler` is called without a new value.
+ * @returns {{ handler: function, param: string }} An object containing the update handler and the current parameter value.
+ */
+const useStandaloneSASQQueryParameter = _ref => {
+  let {
+    name,
+    defaultValue,
+    // This is the value that will be spun up if no value is present in the url
+    fallbackValue // This is the value that will be set if there is no value passed to handler (values[0])
+  } = _ref;
+  const location = (0, _reactRouter.useLocation)();
+  const history = (0, _reactRouter.useHistory)();
+
+  // Special URL management for includeTerminal
+  const urlQuery = _queryString.default.parse(location.search);
+  const param = urlQuery[name];
+  const handler = _ref2 => {
+    var _values$;
+    let {
+      name: _name,
+      values
+    } = _ref2;
+    const newQuery = _objectSpread(_objectSpread({}, urlQuery), {}, {
+      [name]: (_values$ = values[1]) !== null && _values$ !== void 0 ? _values$ : fallbackValue // SECOND value is the new one
+    });
+    history.push({
+      pathname: location.pathname,
+      search: "?".concat(_queryString.default.stringify(newQuery))
+    });
+  };
+  (0, _react.useEffect)(() => {
+    if (!param) {
+      const newQuery = _objectSpread(_objectSpread({}, urlQuery), {}, {
+        [name]: defaultValue
+      });
+      history.push({
+        pathname: location.pathname,
+        search: "?".concat(_queryString.default.stringify(newQuery))
+      });
+    }
+  }, [defaultValue, history, location.pathname, name, param, urlQuery]);
+  return {
+    handler,
+    param
+  };
+};
+var _default = exports.default = useStandaloneSASQQueryParameter;

package/es/lib/utils/generateKiwtQueryParams/generateKiwtQueryParams.js

@@ -82,6 +82,29 @@ const generateKiwtQueryParams = function (options, nsValues) {
   } = nsValues;
   const {
       searchKey = '',
+      /*
+       * Array of objects to configure how filters coming from `nsValues.filters` are mapped into KIWT filter strings.
+       *
+       * Example structure:
+       * [
+       *   {
+       *     name: 'status', // Matches filter key in URL (e.g., filters=status.active)
+       *     filterPrefix: 'filters=', // Optional, defaults to 'filters='
+       *     // Optional function to entirely customize how the array of values is mapped to a string.
+       *     // (e.g., ['active', 'cancelled'] => 'is:active and is:cancelled')
+       *     // Defaults to constructing from `values` map below
+       *     // valuesMapping: (filterValues) => string,
+       *     values: [ // Optional: Specific configuration for individual filter values
+       *       {
+       *         name: 'active', // Matches filter value in URL
+       *         value: 'activeValue', // Actual value to use in the KIWT query (defaults to name)
+       *         comparator: '==' // Optional comparator override (defaults to '==')
+       *       },
+       *       // ... other values
+       *     ]
+       *   }
+       * ]
+       */
       filterConfig = [],
       /* Assumtion made that if no filterKey is provided then the given filterValues for that key are standalaone, ie require no comparator or key */
       filterKeys = {},
@@ -153,8 +176,11 @@ const generateKiwtQueryParams = function (options, nsValues) {
       const filterConfigEntry = filterConfig.find(conf => conf.name === filterName);
       const filterKey = filterKeys[filterName];
       if (filterConfigEntry) {
+        var _filterConfigEntry$fi;
         // We have a direct mapping instruction, use it
-        const filterString = filterValues.map(v => {
+
+        // Do we have a specific way to map values to a string?
+        const filterString = filterConfigEntry.valuesMapping ? filterConfigEntry.valuesMapping(filterValues) : filterValues.map(v => {
           var _filterConfigEntry$va, _filterConfigEntry$va2, _fcValueEntry$value, _fcValueEntry$compara;
           const fcValueEntry = (_filterConfigEntry$va = filterConfigEntry === null || filterConfigEntry === void 0 || (_filterConfigEntry$va2 = filterConfigEntry.values) === null || _filterConfigEntry$va2 === void 0 ? void 0 : _filterConfigEntry$va2.find(fce => fce.name === v)) !== null && _filterConfigEntry$va !== void 0 ? _filterConfigEntry$va : {};
           const fceValue = (_fcValueEntry$value = fcValueEntry.value) !== null && _fcValueEntry$value !== void 0 ? _fcValueEntry$value : v;
@@ -162,7 +188,10 @@ const generateKiwtQueryParams = function (options, nsValues) {
           const fceComparator = (_fcValueEntry$compara = fcValueEntry.comparator) !== null && _fcValueEntry$compara !== void 0 ? _fcValueEntry$compara : '==';
           return "".concat(filterKey !== null && filterKey !== void 0 ? filterKey : filterName).concat(fceComparator).concat(fceValue !== null && fceValue !== void 0 ? fceValue : v);
         }).join('||');
-        paramsArray.push("filters=".concat(conditionalEncodeURIComponent(filterString, encode)));
+
+        // This will NOT be url encoded by this component
+        const filterPrefix = (_filterConfigEntry$fi = filterConfigEntry.filterPrefix) !== null && _filterConfigEntry$fi !== void 0 ? _filterConfigEntry$fi : 'filters=';
+        paramsArray.push("".concat(filterPrefix).concat(conditionalEncodeURIComponent(filterString, encode)));
       } else if (!filterKey) {
         // These filters have no key mapping so we just pass the values to the backend as-is.
         paramsArray.push(...(filterValues !== null && filterValues !== void 0 ? filterValues : []).map(f => "filters=".concat(conditionalEncodeURIComponent(f, encode))));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-int/stripes-kint-components",
-  "version": "5.25.3",
+  "version": "5.27.0",
   "description": "Stripes Component library for K-Int specific applications",
   "sideEffects": [
     "*.css"

package/src/lib/CustomProperties/Edit/CustomPropertiesListField.js

@@ -72,7 +72,7 @@ const CustomPropertiesList = ({
 
       return (
         <CustomPropertyFormCard
-          key={`customPropertyField-${customProperty.value}-${index}`}
+          key={`customPropertyField-${customProperty.value}`}
           {...{
             availableCustomProperties,
             customProperty,

package/src/lib/SASQLookupComponent/README.md

@@ -88,6 +88,7 @@ In this example, **SASQLookupComponent**:
 | `path`                          | `string`          | (Provided by React Router) The path for the current route.                                                                                                                                                                                                                                                                                                |                                           | ✓        |
 | `resource`                      | `object`          | (Provided by Stripes) The resource object, typically containing data and metadata for the current resource.                                                                                                                                                                                                                                               |                                           | ✕        |
 | `resultColumns`                 | `arrayOf(object)` | An array of objects defining the columns for the MCL component, typically used by `RenderBody` (e.g., `TableBody`).                                                                                                                                                                                                                                       |                                           | ✕        |
+| `...props`            | `object`                     | Additional props will be passed down to the `RenderBody`. Use these to further customize behavior or appearance as needed.                                                                                                                                                                                                                                                                                                                                                                                                   |                          | ✕        |
 
 ## Exposed Ref Functionality
 

package/src/lib/SASQLookupComponent/TableBody/README.md

@@ -48,15 +48,15 @@ export default MyTableView;
 
 ### Explanation
 
-- **data:**  
+- **data:**
   Contains `results` (array of items) and `totalRecords` (total items for pagination).
-- **query:**  
+- **query:**
   Provides current search/sort state. Must include `sort` and `query` if applicable.
-- **path:**  
+- **path:**
   Base URL path for constructing row navigation links (e.g., `/my-items/1`).
-- **resultColumns:**  
+- **resultColumns:**
   Defines table columns via `propertyPath` (data key) and `label` (header text).
-- **fetchNextPage:**  
+- **fetchNextPage:**
   Called when more data is needed (e.g., scrolling to the bottom).
 
 ## Props
@@ -80,19 +80,20 @@ export default MyTableView;
 | `resultColumns`     | `Array<{ propertyPath: string, label: string }>` | ✓        | Columns to render. `propertyPath` accesses the data field, `label` sets the header.                                                                                                                                                                                                                                                        |
 | `rowNavigation`     | `boolean`                                        | ✕        | Enables navigation to detail views on row click. Default: `true`.                                                                                                                                                                                                                                                                          |
 | `toggleFilterPane`  | `() => void`                                     | ✕        | Callback to toggle filter pane. Used in `NoResultsMessage`.                                                                                                                                                                                                                                                                                |
+| `getNavigationIdentifier`  | `(row: object) => string \| number`                                     | ✕        | When row navigation is enabled, this function parses the row data to find the unique identitifer for URL routing. Defaults to `(row) => row.id`.                                                                                                                                                                      |
 
 ## Key Features
 
-1. **Row Navigation:**  
-   When `rowNavigation={true}` (default), clicking a row navigates to `{path}/{rowData.id}`. Uses `react-router` internally.
+1. **Row Navigation:**
+When `rowNavigation={true}` (default), clicking a row navigates to `{path}/{getNavigationIdentifier(row)}` (Default is `row.id`). Uses `react-router` internally.
 
-2. **Sorting:**  
+2. **Sorting:**
    Column headers trigger `onSort`, updating the `query.sort` value. The current sort is derived from `query.sort`.
 
-3. **Infinite Scroll:**  
+3. **Infinite Scroll:**
    `fetchNextPage` is called automatically as the user scrolls. Can alternatively use with pagination logic (e.g., `usePrevNextPagination` props passed to mclProps).
 
-4. **Custom Formatters:**  
+4. **Custom Formatters:**
    Pass a `formatter` in `mclProps` to customize cell rendering. Each formatter receives the row data and a `defaultRowUrl`:
    ```jsx
    mclProps={{
@@ -102,13 +103,13 @@ export default MyTableView;
    }}
    ```
 
-5. **Empty States:**  
+5. **Empty States:**
    `NoResultsMessage` handles loading, errors, and no-results states.
 
 ## Integration Notes
 
-- **Parent Components:**  
+- **Parent Components:**
   Designed to work within **SASQLookupComponent** (as its default `RenderBody`), but can be used standalone.
 
-- **Routing:**  
-  Must be rendered within a `react-router` context for navigation to work.
+- **Routing:**
+  Must be rendered within a `react-router` context for navigation to work.

package/src/lib/SASQLookupComponent/TableBody/TableBody.js

@@ -28,6 +28,7 @@ const TableBody = ({
   path,
   resultColumns,
   rowNavigation = true, // Default navigation onRowClick
+  getNavigationIdentifier = (row) => row?.id,
   toggleFilterPane,
   query,
 }) => {
@@ -48,14 +49,14 @@ const TableBody = ({
   const visibleColumns = resultColumns.map(e => e.propertyPath);
 
   const getRowUrl = useCallback((rowData) => {
-    const baseUrl = `${path}/${rowData?.id}`;
+    const baseUrl = `${path}/${getNavigationIdentifier(rowData)}`;
     return {
       url: `${baseUrl}${location?.search}`,
       path,
       baseUrl,
       location
     };
-  }, [location, path]);
+  }, [getNavigationIdentifier, location, path]);
 
   const getEnhancedFormatter = useCallback(() => {
     const enhancedFormatter = {};
@@ -76,7 +77,10 @@ const TableBody = ({
     return null;
   }, [getRowUrl, history, rowNavigation]);
 
-  const isSelected = useCallback(({ item }) => item.id === match?.params?.id, [match?.params?.id]);
+  const isSelected = useCallback(
+    ({ item }) => getNavigationIdentifier(item) === match?.params?.id,
+    [getNavigationIdentifier, match?.params?.id]
+  );
   const NoResultsComponent = useMemo(() => noResultsProps?.component ?? NoResultsMessage, [noResultsProps?.component]);
 
   return (
@@ -139,6 +143,7 @@ TableBody.propTypes = {
   query: PropTypes.object,
   resultColumns: PropTypes.arrayOf(PropTypes.object),
   rowNavigation: PropTypes.bool,
+  getNavigationIdentifier: PropTypes.func,
   toggleFilterPane: PropTypes.func
 };
 

package/src/lib/hooks/index.js

@@ -19,5 +19,6 @@ export { default as useMutateCustomProperties } from './useMutateCustomPropertie
 export { default as useMutateModConfigEntry } from './useMutateModConfigEntry';
 
 export { default as usePrevNextPagination } from './usePrevNextPagination';
+export { default as useStandaloneSASQQueryParameter } from './useStandaloneSASQQueryParameter';
 
 export * from './intlHooks';

package/src/lib/hooks/useStandaloneSASQQueryParameter/index.js

@@ -0,0 +1 @@
+export { default } from './useStandaloneSASQQueryParameter';

package/src/lib/hooks/useStandaloneSASQQueryParameter/useStandaloneSASQQueryParameter.js

@@ -0,0 +1,67 @@
+import { useEffect } from 'react';
+import { useHistory, useLocation } from 'react-router';
+import queryString from 'query-string';
+
+// !WARNING! This pattern is not recommended
+// You likely want to make use of the filterConfig valuesMapping/filterPrefix
+// instead so SASQ filters can be used natively
+/**
+ * Custom hook for managing a single, standalone URL query parameter.
+ *
+ * This hook automatically reads a specified query parameter from the URL. If the
+ * parameter is missing on the initial load, it uses `defaultValue` and updates
+ * the URL to include it. It provides a `handler` function to update the
+ * parameter's value in the URL, which defaults to `fallbackValue` if no new
+ * value is explicitly provided to the handler.
+ *
+ * @param {object} props - The properties object.
+ * @param {string} props.name - The name of the query parameter to manage (e.g., 'showDetails').
+ * @param {string} [props.defaultValue='true'] - The value to set in the URL if the parameter is missing on initial load.
+ * @param {string} [props.fallbackValue='false'] - The value to set when the `handler` is called without a new value.
+ * @returns {{ handler: function, param: string }} An object containing the update handler and the current parameter value.
+ */
+const useStandaloneSASQQueryParameter = ({
+  name,
+  defaultValue, // This is the value that will be spun up if no value is present in the url
+  fallbackValue, // This is the value that will be set if there is no value passed to handler (values[0])
+}) => {
+  const location = useLocation();
+  const history = useHistory();
+
+  // Special URL management for includeTerminal
+  const urlQuery = queryString.parse(location.search);
+  const param = urlQuery[name];
+
+  const handler = ({ name: _name, values }) => {
+    const newQuery = {
+      ...urlQuery,
+      [name]: values[1] ?? fallbackValue // SECOND value is the new one
+    };
+
+    history.push({
+      pathname: location.pathname,
+      search: `?${queryString.stringify(newQuery)}`
+    });
+  };
+
+  useEffect(() => {
+    if (!param) {
+      const newQuery = {
+        ...urlQuery,
+        [name]: defaultValue
+      };
+
+      history.push({
+        pathname: location.pathname,
+        search: `?${queryString.stringify(newQuery)}`
+      });
+    }
+  }, [defaultValue, history, location.pathname, name, param, urlQuery]);
+
+  return {
+    handler,
+    param
+  };
+};
+
+export default useStandaloneSASQQueryParameter;

package/src/lib/utils/generateKiwtQueryParams/generateKiwtQueryParams.js

@@ -67,6 +67,29 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
   const { qindex, query, filters, sort } = nsValues;
   const {
     searchKey = '',
+    /*
+     * Array of objects to configure how filters coming from `nsValues.filters` are mapped into KIWT filter strings.
+     *
+     * Example structure:
+     * [
+     *   {
+     *     name: 'status', // Matches filter key in URL (e.g., filters=status.active)
+     *     filterPrefix: 'filters=', // Optional, defaults to 'filters='
+     *     // Optional function to entirely customize how the array of values is mapped to a string.
+     *     // (e.g., ['active', 'cancelled'] => 'is:active and is:cancelled')
+     *     // Defaults to constructing from `values` map below
+     *     // valuesMapping: (filterValues) => string,
+     *     values: [ // Optional: Specific configuration for individual filter values
+     *       {
+     *         name: 'active', // Matches filter value in URL
+     *         value: 'activeValue', // Actual value to use in the KIWT query (defaults to name)
+     *         comparator: '==' // Optional comparator override (defaults to '==')
+     *       },
+     *       // ... other values
+     *     ]
+     *   }
+     * ]
+     */
     filterConfig = [],
     /* Assumtion made that if no filterKey is provided then the given filterValues for that key are standalaone, ie require no comparator or key */
     filterKeys = {},
@@ -140,15 +163,22 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
       const filterKey = filterKeys[filterName];
       if (filterConfigEntry) {
         // We have a direct mapping instruction, use it
-        const filterString = filterValues.map(v => {
-          const fcValueEntry = filterConfigEntry?.values?.find(fce => fce.name === v) ?? {};
-          const fceValue = fcValueEntry.value ?? v;
-          // This is especially useful where comparator acts strangely for a single value, such as `filters=foo isNotSet`
-          const fceComparator = fcValueEntry.comparator ?? '==';
-          return `${filterKey ?? filterName}${fceComparator}${fceValue ?? v}`;
-        }).join('||');
 
-        paramsArray.push(`filters=${conditionalEncodeURIComponent(filterString, encode)}`);
+        // Do we have a specific way to map values to a string?
+        const filterString = filterConfigEntry.valuesMapping ?
+          filterConfigEntry.valuesMapping(filterValues) :
+          filterValues.map(v => {
+            const fcValueEntry = filterConfigEntry?.values?.find(fce => fce.name === v) ?? {};
+            const fceValue = fcValueEntry.value ?? v;
+            // This is especially useful where comparator acts strangely for a single value, such as `filters=foo isNotSet`
+            const fceComparator = fcValueEntry.comparator ?? '==';
+            return `${filterKey ?? filterName}${fceComparator}${fceValue ?? v}`;
+          }).join('||');
+
+        // This will NOT be url encoded by this component
+        const filterPrefix = filterConfigEntry.filterPrefix ?? 'filters=';
+
+        paramsArray.push(`${filterPrefix}${conditionalEncodeURIComponent(filterString, encode)}`);
       } else if (!filterKey) {
         // These filters have no key mapping so we just pass the values to the backend as-is.
         paramsArray.push(...(filterValues ?? []).map(f => `filters=${conditionalEncodeURIComponent(f, encode)}`));