@k-int/stripes-kint-components 5.31.3 → 5.31.4

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [5.31.4](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.31.3...v5.31.4) (2026-02-04)
+
+
+### Bug Fixes
+
+* **dependencies:** Lock downshift to 9.0.13 to bring in line with fixes made to Stripes ([685233f](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/685233fb61e33c5139d916590e3745dfce5c9bb5))
+* **Settings:** useSettings "render" not triggering ([8b07c73](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/8b07c73f3f3fb1699ac8a984b3050a6fc35b669e))
+
 ## [5.31.3](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.31.2...v5.31.3) (2026-01-19)
 
 

package/es/lib/CustomProperties/View/CustomPropertiesViewCtx.js

@@ -89,7 +89,7 @@ const CustomPropertiesViewCtx = _ref => {
     return (cp[0]?.type?.ctx === ctx || ctx === 'isNull' && !cp[0]?.type?.ctx) &&
     // Either the ctx string matches, or isNull matches blank
     cp[0]?.type?.primary === primary // Only count non-primary set custprops
-    ;
+;
   })?.length ?? 0;
 
   // We need to display any set properties, along with any non-set primary properties

package/es/lib/SASQLookupComponent/SASQLookupComponent.test.js

@@ -0,0 +1,540 @@
+"use strict";
+
+var _react = require("react");
+var _reactRouterDom = require("react-router-dom");
+var _react2 = require("@folio/jest-config-stripes/testing-library/react");
+var _core = require("@folio/stripes/core");
+var _components = require("@folio/stripes/components");
+var _stripesErmTesting = require("@folio/stripes-erm-testing");
+var _reactQuery = require("react-query");
+var _jest = require("../../../test/jest");
+var _SASQLookupComponent = _interopRequireDefault(require("./SASQLookupComponent"));
+var _helpers = _interopRequireDefault(require("../../../test/helpers"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+jest.mock('react-query', () => {
+  const {
+    mockReactQuery
+  } = jest.requireActual('@folio/stripes-erm-testing');
+  return {
+    ...jest.requireActual('react-query'),
+    ...mockReactQuery,
+    useQuery: jest.fn((_key, func, opts) => {
+      const defaultData = {
+        results: [{
+          id: 1,
+          someData: false,
+          test: 'wibble'
+        }, {
+          id: 2,
+          someData: true,
+          test: 'wobble'
+        }],
+        totalRecords: 2
+      };
+
+      // Mock ensures the function is called so we can test outcomes
+      if (opts.enabled) {
+        func();
+      }
+      if (opts.select) {
+        return {
+          data: opts.select(defaultData),
+          extraProp: 'extraProp'
+        };
+      }
+      return {
+        data: defaultData,
+        extraProp: 'extraProp'
+      };
+    })
+  };
+});
+
+// TODO why does unmocking react-router-dom cause module hierarchy issues?
+// EXAMPLE mocking react-router-dom
+const mockHistoryPush = jest.fn();
+const mockHistoryReplace = jest.fn();
+jest.mock('react-router-dom', () => {
+  const {
+    mockReactRouterDom
+  } = jest.requireActual('@folio/stripes-erm-testing');
+  const actualReactRouterDom = jest.requireActual('react-router-dom');
+  return {
+    ...actualReactRouterDom,
+    ...mockReactRouterDom,
+    useHistory: jest.fn(() => ({
+      push: mockHistoryPush,
+      replace: mockHistoryReplace
+    })),
+    useLocation: actualReactRouterDom.useLocation // Bit ugly... idk why I need to put this back specifically like this instead of just unmocking react-router-dom
+  };
+});
+jest.mock('./TableBody', () => jest.fn(_ref => {
+  let {
+    mclProps
+  } = _ref;
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+      children: "TableBody"
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_components.Button, {
+      onClick: () => mclProps.onNeedMoreData(null, 1),
+      children: "Next Page"
+    })]
+  });
+}));
+jest.mock('../SearchKeyControl', () => jest.fn(() => /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+  children: "SearchKeyControl"
+})));
+const fetchParameters = {
+  endpoint: '/wibble',
+  SASQ_MAP: {
+    searchKey: 'test.test1.test2,test3',
+    filterKeys: {
+      status: 'status.value',
+      wobble: 'wobble.value'
+    }
+  }
+};
+const baseSASQLookupProps = {
+  id: 'testing-sasq-lookup-component',
+  path: 'the-path',
+  // Required as it's needed for children
+  fetchParameters
+};
+const baseSASQObj = {
+  filters: '',
+  qindex: undefined,
+  query: ''
+};
+const getBaseExpectedQueryNamespace = function () {
+  let obj = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : baseSASQLookupProps;
+  return ['@folio/test-implementor', 'SASQ', 'testing-sasq-lookup-component', 'viewAll', obj, 1];
+};
+let renderComponent;
+let theRef;
+describe('SASQLookupComponent', () => {
+  describe.each([{
+    testLabel: 'default behaviour',
+    props: baseSASQLookupProps,
+    expectQueryFire: false,
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1'
+  }, {
+    testLabel: 'with searchable indexes',
+    props: {
+      ...baseSASQLookupProps,
+      searchableIndexes: [{
+        key: 'name',
+        label: 'Name'
+      }]
+    },
+    expectQueryFire: false,
+    // No actual query yet
+    expectedSearchKeyControl: true
+  }, {
+    testLabel: 'starting with filters',
+    props: baseSASQLookupProps,
+    startingLocation: '/wibble?filters=status.testFilter',
+    expectedQueryNamespace: getBaseExpectedQueryNamespace({
+      filters: 'status.testFilter',
+      qindex: undefined,
+      query: ''
+    }),
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedMockKyCallAfterSearch: '/wibble?match=test.test1.test2&match=test3&term=some%20test%20query&filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedRef: {
+      lookupQueryProps: {
+        data: {
+          results: [{
+            'id': 1,
+            'someData': false,
+            'test': 'wibble'
+          }, {
+            'id': 2,
+            'someData': true,
+            'test': 'wobble'
+          }],
+          totalRecords: 2
+        },
+        'extraProp': 'extraProp'
+      },
+      queryParams: '?filters=status.value%3D%3DtestFilter&stats=true&page=1'
+    }
+  }, {
+    testLabel: 'starting with qindex and no query',
+    props: baseSASQLookupProps,
+    startingLocation: '/wibble?qindex=test.test1.test2',
+    expectQueryFire: false,
+    expectedQueryNamespace: getBaseExpectedQueryNamespace({
+      filters: '',
+      qindex: 'test.test1.test2',
+      query: ''
+    }),
+    expectedMockKyCallAfterSearch: '/wibble?match=test.test1.test2&term=some%20test%20query&stats=true&page=1'
+  }, {
+    testLabel: 'starting with qindex and query',
+    props: {
+      ...baseSASQLookupProps,
+      sasqProps: {
+        initialSearchState: {
+          query: 'hello',
+          qindex: 'test.test1.test2'
+        }
+      }
+    },
+    startingLocation: '/wibble?qindex=some.new.qindex.path&query=hello',
+    expectedQueryNamespace: getBaseExpectedQueryNamespace({
+      filters: '',
+      qindex: 'some.new.qindex.path',
+      query: 'hello'
+    }),
+    expectedMockKyCall: '/wibble?match=some.new.qindex.path&term=hello&stats=true&page=1',
+    expectedMockKyCallAfterSearch: '/wibble?match=some.new.qindex.path&term=some%20test%20query&stats=true&page=1',
+    expectedRef: {
+      lookupQueryProps: {
+        data: {
+          results: [{
+            'id': 1,
+            'someData': false,
+            'test': 'wibble'
+          }, {
+            'id': 2,
+            'someData': true,
+            'test': 'wobble'
+          }],
+          totalRecords: 2
+        },
+        'extraProp': 'extraProp'
+      },
+      queryParams: '?match=some.new.qindex.path&term=hello&stats=true&page=1'
+    }
+  }, {
+    testLabel: 'with FilterComponent',
+    props: {
+      ...baseSASQLookupProps,
+      FilterComponent: () => /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        children: "FilterComponent"
+      })
+    },
+    expectQueryFire: false,
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedFilterComponent: 'FilterComponent'
+  }, {
+    testLabel: 'with filter pane disabled',
+    props: {
+      ...baseSASQLookupProps,
+      hasFilterPane: false
+    },
+    expectQueryFire: false,
+    expectedSearchField: false,
+    expectedFilterPane: false
+  }, {
+    testLabel: 'with FilterHeaderComponent',
+    props: {
+      ...baseSASQLookupProps,
+      FilterPaneHeaderComponent: () => /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        children: "FilterPaneHeaderComponent"
+      })
+    },
+    expectQueryFire: false,
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedFilterHeaderComponent: 'FilterPaneHeaderComponent'
+  }, {
+    testLabel: 'no search field mode',
+    props: {
+      ...baseSASQLookupProps,
+      noSearchField: true
+    },
+    expectQueryFire: false,
+    expectedSearchField: false
+  }, {
+    testLabel: 'with RenderBody',
+    props: {
+      ...baseSASQLookupProps,
+      RenderBody: () => /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        children: "TheBodyComponent"
+      })
+    },
+    expectQueryFire: false,
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedBodyComponent: 'TheBodyComponent'
+  }, {
+    testLabel: 'with custom lookupQueryNamespaceGenerator',
+    props: {
+      ...baseSASQLookupProps,
+      lookupQueryNamespaceGenerator: _ref2 => {
+        let {
+          currentPage,
+          namespace,
+          id: passedId
+        } = _ref2;
+        return [`testing-${currentPage}`, `testing-${namespace}`, `testing-${passedId}`];
+      }
+    },
+    expectedQueryNamespace: ['testing-1', 'testing-@folio/test-implementor', 'testing-testing-sasq-lookup-component'],
+    startingLocation: '/wibble?filters=status.testFilter',
+    expectedMockKyCall: '/wibble?filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedMockKyCallAfterSearch: '/wibble?match=test.test1.test2&match=test3&term=some%20test%20query&filters=status.value%3D%3DtestFilter&stats=true&page=1',
+    expectedRef: {
+      lookupQueryProps: {
+        data: {
+          results: [{
+            'id': 1,
+            'someData': false,
+            'test': 'wibble'
+          }, {
+            'id': 2,
+            'someData': true,
+            'test': 'wobble'
+          }],
+          totalRecords: 2
+        },
+        'extraProp': 'extraProp'
+      },
+      queryParams: '?filters=status.value%3D%3DtestFilter&stats=true&page=1'
+    }
+  }, {
+    testLabel: 'with lookupResponseTransform',
+    props: {
+      ...baseSASQLookupProps,
+      sasqProps: {
+        initialSearchState: {
+          query: 'test',
+          qindex: 'test.test1.test2'
+        }
+      },
+      // Wrap results in an extra object to prove transform works
+      lookupResponseTransform: resp => ({
+        originalData: resp,
+        transformed: true
+      })
+    },
+    startingLocation: '/wibble?query=test',
+    expectedQueryNamespace: getBaseExpectedQueryNamespace({
+      filters: '',
+      qindex: undefined,
+      query: 'test'
+    }),
+    expectedMockKyCall: '/wibble?match=test.test1.test2&match=test3&term=test&stats=true&page=1',
+    expectedRef: {
+      lookupQueryProps: {
+        data: {
+          originalData: {
+            results: [{
+              'id': 1,
+              'someData': false,
+              'test': 'wibble'
+            }, {
+              'id': 2,
+              'someData': true,
+              'test': 'wobble'
+            }],
+            totalRecords: 2
+          },
+          transformed: true
+        },
+        'extraProp': 'extraProp'
+      },
+      queryParams: '?match=test.test1.test2&match=test3&term=test&stats=true&page=1'
+    },
+    expectedNumberOfResults: 0
+  }])('$testLabel', _ref3 => {
+    let {
+      props,
+      startingLocation = '/wibble',
+      expectQueryFire = true,
+      expectedQueryNamespace = getBaseExpectedQueryNamespace(baseSASQObj),
+      expectedMockKyCall = '/wibble?match=test.test1.test2&match=test3&term=some%20test%20query&stats=true&page=1',
+      expectedMockKyCallAfterSearch = '/wibble?match=test.test1.test2&match=test3&term=some%20test%20query&stats=true&page=1',
+      expectedFilterComponent,
+      expectedFilterHeaderComponent,
+      expectedFilterPane = true,
+      expectedBodyComponent,
+      expectedNumberOfResults = 2,
+      expectedSearchField = true,
+      expectedSearchKeyControl = false,
+      expectedRef
+    } = _ref3;
+    beforeEach(() => {
+      // CLEAR MOCKS
+      _core.mockKy.mockClear();
+      _reactQuery.useQuery.mockClear();
+
+      // CLEAR LOCAL STORAGE to ensure filter pane starts open
+      window.localStorage.clear();
+
+      // SET UP REF
+      theRef = /*#__PURE__*/(0, _react.createRef)();
+      renderComponent = (0, _jest.renderWithKintHarness)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactRouterDom.MemoryRouter, {
+        initialEntries: [startingLocation],
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_SASQLookupComponent.default, {
+          ref: theRef,
+          ...props,
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+            children: "CHILD COMPONENT"
+          })
+        })
+      }), undefined, _helpers.default);
+    });
+    test('renders children', () => {
+      const {
+        getByText
+      } = renderComponent;
+      expect(getByText('CHILD COMPONENT')).toBeInTheDocument();
+    });
+    test('renders the main pane', async () => {
+      await (0, _stripesErmTesting.Pane)({
+        id: `${props.id}-main-pane`
+      }).exists();
+    });
+
+    // This MUST happen before the Searching block as that will clear the mocks
+    describe('Initial lookup', () => {
+      // Called once without SASQ props, then once without page, then finally as expected, so call 2
+      test('useQuery namespace was as expected', () => {
+        expect(_reactQuery.useQuery.mock.calls[3][0]).toEqual(expectedQueryNamespace);
+      });
+      if (expectQueryFire) {
+        test('mockKy was called with expected values', () => {
+          expect(_core.mockKy).toHaveBeenCalledWith(expectedMockKyCall);
+        });
+        test('ref has gained lookup data', async () => {
+          await (0, _react2.waitFor)(() => {
+            expect(theRef.current).toEqual(expectedRef);
+          });
+        });
+      } else {
+        test('mockKy was not called', () => {
+          expect(_core.mockKy).toHaveBeenCalledTimes(0);
+        });
+      }
+    });
+    describe('Searching', () => {
+      if (expectedSearchKeyControl) {
+        test('renders SearchKeyControl', () => {
+          const {
+            getByText
+          } = renderComponent;
+          expect(getByText('SearchKeyControl')).toBeInTheDocument();
+        });
+      }
+      if (!expectedSearchField) {
+        test('does not render SearchField', async () => {
+          await (0, _stripesErmTesting.SearchField)().absent();
+        });
+      } else {
+        test('renders SearchField', async () => {
+          await (0, _stripesErmTesting.SearchField)().exists();
+        });
+        test('mockKy has not yet been called with expected search', async () => {
+          await (0, _react2.waitFor)(() => {
+            expect(_core.mockKy).not.toHaveBeenCalledWith(expectedMockKyCallAfterSearch);
+          });
+        });
+        describe('running a search', () => {
+          beforeEach(async () => {
+            _core.mockKy.mockClear();
+            await (0, _react2.waitFor)(async () => {
+              await (0, _stripesErmTesting.SearchField)().fillIn('some test query');
+              await (0, _stripesErmTesting.Button)('Search').click();
+            });
+          });
+          test('mockKy behaves as expected after search', async () => {
+            await (0, _react2.waitFor)(() => {
+              expect(_core.mockKy).toHaveBeenCalledWith(expectedMockKyCallAfterSearch);
+            });
+          });
+          describe('resetting search', () => {
+            beforeEach(async () => {
+              _core.mockKy.mockClear();
+              await (0, _react2.waitFor)(async () => {
+                await (0, _stripesErmTesting.Button)('Reset all').click();
+              });
+            });
+            if (expectQueryFire) {
+              test('mockKy was called with expected values after reset', async () => {
+                await (0, _react2.waitFor)(() => {
+                  expect(_core.mockKy).toHaveBeenCalledWith(expectedMockKyCall);
+                });
+              });
+            } else {
+              test('mockKy was not called  after reset', () => {
+                expect(_core.mockKy).toHaveBeenCalledTimes(0);
+              });
+            }
+          });
+        });
+      }
+    });
+
+    // TESTING TOTAL RECORDS DISPLAY
+    test('displays the correct number of found values', async () => {
+      // SASQ uses paneSub for "found X values"
+      await (0, _stripesErmTesting.Pane)({
+        subtitle: `Found ${expectedNumberOfResults} values`
+      }).exists();
+    });
+    if (expectedBodyComponent) {
+      test('renders the RenderBody', () => {
+        const {
+          getByText
+        } = renderComponent;
+        expect(getByText(expectedBodyComponent)).toBeInTheDocument();
+      });
+    } else {
+      test('renders the TableBody', () => {
+        const {
+          getByText
+        } = renderComponent;
+        expect(getByText('TableBody')).toBeInTheDocument();
+      });
+    }
+    if (expectedFilterPane) {
+      describe('Filter pane', () => {
+        test('renders the filter pane', async () => {
+          await (0, _stripesErmTesting.Pane)({
+            id: `${props.id}-filter-pane`
+          }).exists();
+        });
+        test('collapse filter pane button exists', async () => {
+          await (0, _stripesErmTesting.IconButton)('caret-left').exists();
+        });
+        test('expand filter pane button does not exist', async () => {
+          await (0, _stripesErmTesting.IconButton)('caret-right').absent();
+        });
+        describe('toggling the filter pane', () => {
+          beforeEach(async () => {
+            // Find the collapse button in the filter pane
+            await (0, _react2.waitFor)(async () => {
+              await (0, _stripesErmTesting.IconButton)('caret-left').click();
+            });
+          });
+          test('expand button appears in main pane', async () => {
+            await (0, _stripesErmTesting.IconButton)('caret-right').exists();
+          });
+          test('filter pane is removed from DOM', async () => {
+            await (0, _stripesErmTesting.Pane)({
+              id: `${props.id}-filter-pane`
+            }).absent();
+          });
+        });
+        if (expectedFilterComponent) {
+          test('FilterComponent renders', () => {
+            const {
+              getByText
+            } = renderComponent;
+            expect(getByText(expectedFilterComponent)).toBeInTheDocument();
+          });
+        }
+        if (expectedFilterHeaderComponent) {
+          test('FilterHeaderComponent renders', () => {
+            const {
+              getByText
+            } = renderComponent;
+            expect(getByText(expectedFilterHeaderComponent)).toBeInTheDocument();
+          });
+        }
+      });
+    }
+  });
+});

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

@@ -54,7 +54,7 @@ const TableBody = _ref => {
   const getRowUrl = (0, _react.useCallback)(rowData => {
     const baseUrl = `${path}/${getNavigationIdentifier(rowData)}`;
     return {
-      url: `${baseUrl}${location?.search}`,
+      url: `${baseUrl}${location?.search ?? ''}`,
       path,
       baseUrl,
       location
@@ -63,10 +63,14 @@ const TableBody = _ref => {
   const getEnhancedFormatter = (0, _react.useCallback)(() => {
     const enhancedFormatter = {};
     for (const [key, value] of Object.entries(formatter)) {
-      enhancedFormatter[key] = item => value({
-        ...item,
-        defaultRowUrl: getRowUrl(item)
-      });
+      if (typeof value === 'function') {
+        enhancedFormatter[key] = item => value({
+          ...item,
+          defaultRowUrl: getRowUrl(item)
+        });
+      } else {
+        enhancedFormatter[key] = value;
+      }
     }
     return enhancedFormatter;
   }, [formatter, getRowUrl]);