@k-int/stripes-kint-components 5.0.0 → 5.1.1

package/src/lib/CustomProperties/Edit/CustomPropertyField.test.js

@@ -1,11 +1,12 @@
-import React from 'react';
+import { waitFor } from '@folio/jest-config-stripes/testing-library/react';
 
 import {
   Datepicker,
   MultiSelect,
   TextArea,
   TextInput,
-  TestForm
+  TestForm,
+  Select
 } from '@folio/stripes-erm-testing';
 
 import CustomPropertyField from './CustomPropertyField';
@@ -76,8 +77,9 @@ describe('CustomPropertyField', () => {
       await TextArea('Internal note').has({ value: 'this is an internal note' });
     });
 
-    test('Displays expected visibilities dropdwon values  ', () => {
-      MultiSelect('Visibility').select(['Internal', 'Public']);
+    test('Displays expected visibilities dropdown values  ', async () => {
+      await Select('Visibility').choose('Internal');
+      await Select('Visibility').choose('Public');
     });
 
     it('Displays expected Public note label ', () => {
@@ -158,7 +160,9 @@ describe('CustomPropertyField', () => {
     });
 
     test('renders multi-select Refdata values', async () => {
-      await MultiSelect('Value(s)').select(['Future', 'Current', 'Historical', 'Does not apply']);
+      await waitFor(async () => {
+        await MultiSelect('Value(s)').select(['Future', 'Current', 'Historical', 'Does not apply']);
+      });
     });
   });
 

package/src/lib/CustomProperties/Filter/CustomPropertiesFilterFieldArray.test.js

@@ -1,8 +1,5 @@
-import React from 'react';
-
-import { TestForm } from '@folio/stripes-erm-testing';
+import { Button, TestForm } from '@folio/stripes-erm-testing';
 import { waitFor } from '@folio/jest-config-stripes/testing-library/react';
-import { Button } from '@folio/stripes-erm-testing';
 import { FieldArray } from 'react-final-form-arrays';
 
 import CustomPropertiesFilterFieldArray from './CustomPropertiesFilterFieldArray';

package/src/lib/CustomProperties/Filter/CustomPropertiesRule.test.js

@@ -1,6 +1,6 @@
-import React from 'react';
-
 import { MemoryRouter } from 'react-router-dom';
+
+import { waitFor } from '@folio/jest-config-stripes/testing-library/react';
 import { Select, TestForm } from '@folio/stripes-erm-testing';
 
 import CustomPropertiesRule from './CustomPropertiesRule';
@@ -32,7 +32,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is set operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is set');
+      await waitFor(async () => {
+        await Select().choose('Is set');
+      });
     });
 
     it('renders expected Is set operator', async () => {
@@ -42,7 +44,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is not set operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is not set');
+      await waitFor(async () => {
+        await Select().choose('Is not set');
+      });
     });
 
     it('renders expected is not set operator in comparator dropdown', async () => {
@@ -52,7 +56,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Equals from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Equals');
+      await waitFor(async () => {
+        await Select().choose('Equals');
+      });
     });
 
     it('renders expected Equals operator', async () => {
@@ -62,7 +68,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select not equal operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Does not equal');
+      await waitFor(async () => {
+        await Select().choose('Does not equal');
+      });
     });
 
     it('renders expected Does not equal operator in comparator dropdown', async () => {
@@ -72,7 +80,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is greater than or equal to operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is greater than or equal to');
+      await waitFor(async () => {
+        await Select().choose('Is greater than or equal to');
+      });
     });
 
     it('renders expected Is greater than or equal to operator in comparator dropdown', async () => {
@@ -82,7 +92,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is less than or equal to operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is less than or equal to');
+      await waitFor(async () => {
+        await Select().choose('Is less than or equal to');
+      });
     });
 
     it('renders expected Is less than or equal to operator in comparator dropdown', async () => {
@@ -92,7 +104,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is operator from comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is');
+      await waitFor(async () => {
+        await Select().choose('Is');
+      });
     });
 
     it('renders expected is operator', async () => {
@@ -102,7 +116,9 @@ describe('CustomPropertiesRule', () => {
 
   describe('select Is not operator form comparator dropdown', () => {
     beforeEach(async () => {
-      await Select().choose('Is not');
+      await waitFor(async () => {
+        await Select().choose('Is not');
+      });
     });
 
     it('renders expected is not operator ', async () => {

package/src/lib/constants/comparators.js

@@ -0,0 +1,13 @@
+export default [
+  '==',
+  '!=',
+  '=~',
+  '!~',
+  '=i=',
+  'isEmpty',
+  'isNotEmpty',
+  'isSet',
+  'isNotSet',
+  'isNull',
+  'isNotNull',
+];

package/src/lib/hooks/useKiwtSASQuery.js

@@ -1,4 +1,4 @@
-import React, { useState } from 'react';
+import { useState } from 'react';
 import { useLocation, useHistory } from 'react-router-dom';
 
 import buildUrl from '../utils/buildUrl';

package/src/lib/utils/buildUrl.js

@@ -7,10 +7,6 @@ import {
   forOwn,
 } from 'lodash';
 
-function getLocationQuery(location) {
-  return location.query ? location.query : queryString.parse(location.search);
-}
-
 function removeEmpty(obj) {
   const cleanObj = {};
 
@@ -22,7 +18,7 @@ function removeEmpty(obj) {
 }
 
 export default function buildUrl(location, values, basePath) {
-  const locationQuery = getLocationQuery(location);
+  const locationQuery = location?.query ?? queryString.parse(location.search);
   let url = values._path || basePath || location.pathname;
   const params = removeEmpty(Object.assign(locationQuery, values));
 

package/src/lib/utils/filterParsers/deparseKiwtQueryFilters.js

@@ -0,0 +1,32 @@
+// Does not validate object... make sure you pass it the right thing
+export const deparseKiwtQueryFiltersObject = (queryObject) => {
+  let returnString = `${queryObject.path} ${queryObject.comparator}`;
+  if (queryObject.value) {
+    returnString += ` ${queryObject.value}`;
+  }
+
+  return returnString;
+};
+
+// Takes an Array of the shape defined by parseKiwtQuery and restructures that into an equivalent KIWT queryString
+const deparseKiwtQueryFilters = (queryArray) => {
+  if (Array.isArray(queryArray)) {
+    let returnString = '';
+    queryArray.forEach(qa => {
+      if (Array.isArray(qa)) {
+        returnString += ` (${deparseKiwtQueryFilters(qa)})`;
+      } else if (typeof qa === 'string') {
+        returnString += ` ${qa}`;
+      } else {
+        // Assuming object at this stage
+        returnString += ` ${deparseKiwtQueryFiltersObject(qa)}`;
+      }
+    });
+
+    return returnString.trim();
+  } else {
+    throw new Error(`deparseKiwtQuery expects a parameter of type Array, passed: ${queryArray}`);
+  }
+};
+
+export default deparseKiwtQueryFilters;

package/src/lib/utils/filterParsers/index.js

@@ -0,0 +1,13 @@
+export { default as parseKiwtQueryGroups } from './parseKiwtQueryGroups';
+
+export { default as parseKiwtQueryString } from './parseKiwtQueryString';
+
+export {
+  default as parseKiwtQueryFilters,
+  parseKiwtQueryFiltersRecursive
+} from './parseKiwtQueryFilters';
+
+export {
+  default as deparseKiwtQueryFilters,
+  deparseKiwtQueryFiltersObject
+} from './deparseKiwtQueryFilters';

package/src/lib/utils/filterParsers/parseKiwtQueryFilters.js

@@ -0,0 +1,42 @@
+import parseKiwtQueryGroups from './parseKiwtQueryGroups';
+import parseKiwtQueryString from './parseKiwtQueryString';
+
+// This is an amalgam of parseKiwtQueryGroups, which splits up grouped queries
+// and parseKiwtQueryString, which figures out comparator vs attribute, etc
+
+// This will handle the nested recursion logic, switching between String and Array
+export const parseKiwtQueryFiltersRecursive = (query) => {
+  if (Array.isArray(query)) {
+    return query.map(q => parseKiwtQueryFiltersRecursive(q));
+  } else if (typeof query === 'string') {
+    if (query === '&&' || query === '||') {
+      return query;
+    } else {
+      return parseKiwtQueryString(query);
+    }
+  } else {
+    throw new Error(`Unexpected query type: ${query}`);
+  }
+};
+
+// This accepts a STRING only
+const parseKiwtQueryFilters = (queryString) => {
+  if (typeof queryString === 'string') {
+    // parseKiwtQueryGroups already recurses, so we know is the right shape all the way down
+    const queryGroups = parseKiwtQueryGroups(queryString);
+
+    return parseKiwtQueryFiltersRecursive(queryGroups);
+  } else {
+    throw new Error(`parseKiwtQuery expects a parameter of type String, passed: ${queryString}`);
+  }
+};
+
+/* RETURN SHAPE
+ * This will return nested arrays of Objects, Strings and Arrays.
+ * Each array refers to a bracketed group
+ * Each object is a single query value (attribute, comparator and value)
+ * Each string should be boolean && or ||
+ * To be read from left to right
+ */
+
+export default parseKiwtQueryFilters;

package/src/lib/utils/{parseKiwtQueryGroups.js → filterParsers/parseKiwtQueryGroups.js}

@@ -27,7 +27,9 @@ const parseKiwtQueryGroups = (query) => {
   // but Webkit hasn't implemented look-behind yet so that breaks Safari.
   // https://bugs.webkit.org/show_bug.cgi?id=174931
   // <sigh>
-  const splitString = query.split(/(\|\||&&|\(|\))/).filter(Boolean);
+  const splitString = query.split(/(\|\||&&|\(|\))/)
+                        .map(ss => ss.trim())
+                        .filter(Boolean);
 
   // Keep track of what to skip over when we return from each level of nesting
   let skipCount = [0];

package/src/lib/utils/filterParsers/parseKiwtQueryString.js

@@ -0,0 +1,33 @@
+import comparators from '../../constants/comparators';
+
+/*
+ * This is designed to take a SINGLE query string of the form
+ * attribute == value, or attribute isEmpty, or attribute ~= value, etc
+ *
+ * Will return an object: {path: 'attribute', comparator: '==', value: 'value'}
+ */
+// No magic numbers sonarlint -.-
+const FIRST = 0;
+const SECOND = 1;
+const THIRD = 2;
+
+const parseKiwtQueryString = (queryString) => {
+  const comparatorMatch = new RegExp(`(${comparators.join('|')})`);
+  // See parseKiwtQueryGroups for breakdown of why this filter is needed
+  const splitString = queryString.split(comparatorMatch)
+                                 .map(ss => ss.trim())
+                                 .filter(Boolean);
+
+  /*
+   * As far as I can tell, with input of a SINGLE query string at a time,
+   * with 2 entries we will have a special case comparator, with 3 we
+   * have a comparator, attribute and value.. value can be null in those cases
+   */
+  return ({
+    path: splitString[FIRST],
+    comparator: splitString[SECOND],
+    value: splitString[THIRD]
+  });
+};
+
+export default parseKiwtQueryString;

package/src/lib/utils/generateKiwtQueryParams.js

@@ -6,6 +6,8 @@ const conditionalEncodeURIComponent = (str, encode = true) => {
   return str;
 };
 
+// TODO might be nice to allow for filterOptions to be of the shape of parsedKiwtQueryFilters,
+// so we can make use of the deparser there optionally for built in query grouping
 const buildFilterOptionBlock = (opf, isNested = false, encode = true) => {
   if (opf?.groupValues) {
     const groupValues = opf.groupValues;
@@ -96,7 +98,7 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
   const paramsArray = [];
 
   if (query) {
-    paramsArray.push(...(qindex || searchKey).split(',')?.map(m => `match=${conditionalEncodeURIComponent(m, encode)}`));
+    paramsArray.push(...((qindex || searchKey)?.split(',') ?? []).map(m => `match=${conditionalEncodeURIComponent(m, encode)}`));
     paramsArray.push(`term=${conditionalEncodeURIComponent(query, encode)}`);
   }
 
@@ -113,7 +115,7 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
   if (filters) {
     const filterMap = {};
     filters.split(',').forEach(filter => {
-      const [filterName, ...filterRest] = filter.trim()?.split('.');
+      const [filterName, ...filterRest] = filter.trim()?.split('.') ?? [];
       const filterValue = filterRest.join('.');
 
       if (filterMap[filterName] === undefined) filterMap[filterName] = [];
@@ -134,7 +136,7 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
         paramsArray.push(`filters=${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)}`));
+        paramsArray.push(...(filterValues ?? []).map(f => `filters=${conditionalEncodeURIComponent(f, encode)}`));
       } else {
         const filterString = filterValues.map(v => `${filterKey}==${v}`).join('||');
         paramsArray.push(`filters=${conditionalEncodeURIComponent(filterString, encode)}`);
@@ -154,7 +156,7 @@ const generateKiwtQueryParams = (options, nsValues, encode = true) => {
   }
 
   if (sort) {
-    paramsArray.push(...sort.trim()?.split(',').map(sortKey => {
+    paramsArray.push(...(sort.trim()?.split(',') ?? []).map(sortKey => {
       const descending = sortKey.startsWith('-');
       let term = sortKey.replace('-', '');
 

package/src/lib/utils/index.js

@@ -19,7 +19,14 @@ export { default as toCamelCase } from './toCamelCase'; // I hate that this exis
 export { default as matchString } from './matchString';
 export { boldString, highlightString } from './highlightString';
 
-export { default as parseKiwtQueryGroups } from './parseKiwtQueryGroups';
+export {
+  parseKiwtQueryGroups,
+  parseKiwtQueryString,
+  parseKiwtQueryFilters,
+  parseKiwtQueryFiltersRecursive,
+  deparseKiwtQueryFilters,
+  deparseKiwtQueryFiltersObject
+} from './filterParsers';
 
 // HTTP Utils
 export { default as parseErrorResponse } from './parseErrorResponse';