@k-int/stripes-kint-components 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [5.4.0](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.3.1...v5.4.0) (2024-02-29)
+
+
+### Features
+
+* EditSettingValue: refdata default sort ([9e7f530](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/9e7f5301bb43050ba263b303e0e05462b1268a8a))
+* matchString and highlightString improvements ([83f98e9](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/83f98e9ebc678c3a893504a9959d35f9e1318b7b))
+
 ## [5.3.1](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.3.0...v5.3.1) (2024-01-26)
 
 

package/es/lib/EditableSettingsList/SettingField/EditSettingValue.js

@@ -37,10 +37,14 @@ const EditSettingValue = props => {
       if (refdata.length > 0 && refdata.length <= 4) {
         RefdataComponent = _RefdataButtons.default;
       }
+
+      // Adding default sort to refdata object in ascending order by label
+      const sortByLabel = (a, b) => a.label.localeCompare(b.label);
+      const sortedRefdata = refdata.sort(sortByLabel);
       return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactFinalForm.Field, {
         "aria-label": fieldLabel,
         component: RefdataComponent,
-        dataOptions: refdata,
+        dataOptions: sortedRefdata,
         name: "".concat(input.name, ".value")
       });
     case 'Password':

package/es/lib/utils/highlightString.js

@@ -9,21 +9,37 @@ var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const highlightString = function (match, str) {
   let ignoreNull = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
-  const [parts, regex] = (0, _matchString.default)(match, str, ignoreNull);
-  return parts.filter(part => part).map((part, i) => regex.test(part) ? /*#__PURE__*/(0, _jsxRuntime.jsx)("mark", {
-    children: part
-  }, i) : /*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
-    children: part
-  }, i));
+  let simpleSplit = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+  const [parts, regex] = (0, _matchString.default)(match, str, ignoreNull, simpleSplit);
+  return parts.map((part, i) => {
+    // RegExp is stateful, set up a new one to work with
+    const immutableRegex = new RegExp(regex);
+    if (immutableRegex.exec(part) !== null) {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)("mark", {
+        children: part
+      }, i);
+    }
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
+      children: part
+    }, i);
+  });
 };
 exports.highlightString = highlightString;
 const boldString = function (match, str) {
   let ignoreNull = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
-  const [parts, regex] = (0, _matchString.default)(match, str, ignoreNull);
-  return parts.filter(part => part).map((part, i) => regex.test(part) ? /*#__PURE__*/(0, _jsxRuntime.jsx)("strong", {
-    children: part
-  }, i) : /*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
-    children: part
-  }, i));
+  let simpleSplit = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+  const [parts, regex] = (0, _matchString.default)(match, str, ignoreNull, simpleSplit);
+  return parts.map((part, i) => {
+    // RegExp is stateful, set up a new one to work with
+    const immutableRegex = new RegExp(regex);
+    if (immutableRegex.exec(part) !== null) {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)("strong", {
+        children: part
+      }, i);
+    }
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)("span", {
+      children: part
+    }, i);
+  });
 };
 exports.boldString = boldString;

package/es/lib/utils/matchString.js

@@ -7,13 +7,28 @@ exports.default = void 0;
 var _escapeRegExp = _interopRequireDefault(require("lodash/escapeRegExp"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const matchString = function (match, str) {
+  var _str$split2;
   let ignoreNull = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
-  const regex = new RegExp("".concat(match.split(/(\s+)/).filter(h => h.trim()).map(hl => '(' + (0, _escapeRegExp.default)(hl) + ')').join('|')), 'gi');
+  let simpleSplit = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+  // Simple regex split -- this is default behaviour
+  const regexSimple = new RegExp("".concat(match.split(/(\s+)/).filter(h => h.trim()).map(hl => '(' + (0, _escapeRegExp.default)(hl) + ')').join('|')), 'gi');
+
+  // Split Elivis "The King" Presley into [Elvis, The King, Presley]
+  const regex = new RegExp("".concat(match.split(/(?!\B"[^"]*)\s+(?![^"]*"\B)/).filter(h => h.trim()).map(quotedSection => {
+    if (quotedSection.charAt(0) === '"' && quotedSection.charAt(quotedSection.length - 1) === '"') {
+      return quotedSection.slice(1, quotedSection.length - 1);
+    }
+    return quotedSection;
+  }).map(hl => '(' + (0, _escapeRegExp.default)(hl) + ')').join('|')), 'gi');
   if (ignoreNull && !match) {
     const nullRegex = /a^/gi; // Should match nothing
 
     return [[str], nullRegex];
   }
-  return [str.split(regex), regex];
+  if (simpleSplit) {
+    var _str$split;
+    return [(_str$split = str.split(regexSimple)) === null || _str$split === void 0 ? void 0 : _str$split.filter(s => s && s.trim()), regexSimple];
+  }
+  return [(_str$split2 = str.split(regex)) === null || _str$split2 === void 0 ? void 0 : _str$split2.filter(s => s && s.trim()), regex];
 };
 var _default = exports.default = matchString;

package/package.json

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

package/src/lib/EditableSettingsList/SettingField/EditSettingValue.js

@@ -36,11 +36,15 @@ const EditSettingValue = (props) => {
         RefdataComponent = RefdataButtons;
       }
 
+      // Adding default sort to refdata object in ascending order by label
+      const sortByLabel = (a, b) => (a.label.localeCompare(b.label));
+      const sortedRefdata = refdata.sort(sortByLabel);
+
       return (
         <Field
           aria-label={fieldLabel}
           component={RefdataComponent}
-          dataOptions={refdata}
+          dataOptions={sortedRefdata}
           name={`${input.name}.value`}
         />
       );

package/src/lib/utils/highlightString.js

@@ -1,38 +1,54 @@
 import matchString from './matchString';
 
-const highlightString = (match, str, ignoreNull = true) => {
-  const [parts, regex] = matchString(match, str, ignoreNull);
+const highlightString = (match, str, ignoreNull = true, simpleSplit = true) => {
+  const [parts, regex] = matchString(match, str, ignoreNull, simpleSplit);
 
   return (
-    parts.filter(part => part).map((part, i) => (
-      regex.test(part) ?
-        <mark
-          key={i}
-        >
-          {part}
-        </mark> :
+    parts.map((part, i) => {
+      // RegExp is stateful, set up a new one to work with
+      const immutableRegex = new RegExp(regex);
+      if (immutableRegex.exec(part) !== null) {
+        return (
+          <mark
+            key={i}
+          >
+            {part}
+          </mark>
+        );
+      }
+
+      return (
         <span key={i}>
           {part}
         </span>
-    ))
+      );
+    })
   );
 };
 
-const boldString = (match, str, ignoreNull = true) => {
-  const [parts, regex] = matchString(match, str, ignoreNull);
+const boldString = (match, str, ignoreNull = true, simpleSplit = true) => {
+  const [parts, regex] = matchString(match, str, ignoreNull, simpleSplit);
 
   return (
-    parts.filter(part => part).map((part, i) => (
-      regex.test(part) ?
-        <strong
-          key={i}
-        >
-          {part}
-        </strong> :
+    parts.map((part, i) => {
+      // RegExp is stateful, set up a new one to work with
+      const immutableRegex = new RegExp(regex);
+      if (immutableRegex.exec(part) !== null) {
+        return (
+          <strong
+            key={i}
+          >
+            {part}
+          </strong>
+        );
+      }
+
+      return (
         <span key={i}>
           {part}
         </span>
-    ))
+      );
+    })
   );
 };
 

package/src/lib/utils/matchString.js

@@ -1,14 +1,35 @@
 import escapeRegExp from 'lodash/escapeRegExp';
 
-const matchString = (match, str, ignoreNull = true) => {
-  const regex = new RegExp(`${match.split(/(\s+)/).filter(h => h.trim()).map(hl => '(' + escapeRegExp(hl) + ')').join('|')}`, 'gi');
+const matchString = (match, str, ignoreNull = true, simpleSplit = true) => {
+  // Simple regex split -- this is default behaviour
+  const regexSimple = new RegExp(`${match.split(/(\s+)/).filter(h => h.trim()).map(hl => '(' + escapeRegExp(hl) + ')').join('|')}`, 'gi');
+
+  // Split Elivis "The King" Presley into [Elvis, The King, Presley]
+  const regex = new RegExp(`${
+    match.split(/(?!\B"[^"]*)\s+(?![^"]*"\B)/)
+         .filter(h => h.trim())
+         .map(quotedSection => {
+            if (quotedSection.charAt(0) === '"' && quotedSection.charAt(quotedSection.length - 1) === '"') {
+              return quotedSection.slice(1, quotedSection.length - 1);
+            }
+            return quotedSection;
+          })
+         .map(hl => '(' + escapeRegExp(hl) + ')')
+         .join('|')
+    }`,
+    'gi');
+
   if (ignoreNull && !match) {
     const nullRegex = /a^/gi; // Should match nothing
 
     return [[str], nullRegex];
   }
 
-  return [str.split(regex), regex];
+  if (simpleSplit) {
+    return [str.split(regexSimple)?.filter(s => s && s.trim()), regexSimple];
+  }
+
+  return [str.split(regex)?.filter(s => s && s.trim()), regex];
 };
 
 export default matchString;