New Line Support for Multi Value Filters (#156)

Author: RosalineP

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.23.0 - 2023-27-14
+- Update filters to support newline delimiting as well as semicolon delimiting. Update constants and comments accordingly
+
 ## 1.22.0 - 2023-07-14
 - Support `plateMetadata` JSON property on `AssayDOM.importRun`.
 - Rename `IImportRunOptions` to `ImportRunOptions`.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/api",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "JavaScript client API for LabKey Server",
   "scripts": {
     "build": "npm run build:dist && npm run build:docs",

package.json

@@ -77,8 +77,8 @@ const GREATER_THAN_OR_EQUAL = registerFilterType(
     false,
     '>='
 );
-/** Finds rows where the column value equals one of the supplied filter values. The values should be supplied as a semi-colon-delimited list (example usage: a;b;c).*/
-const IN = registerFilterType('Equals One Of', null, 'in', true, ';', 'Equals One Of (example usage: a;b;c)');
+/** Finds rows where the column value equals one of the supplied filter values. Use semicolons or new lines to separate entries.*/
+const IN = registerFilterType('Equals One Of', null, 'in', true, ';', 'Equals One Of');
 /** Finds rows where the column value is less than the filter value.*/
 const LESS_THAN = registerFilterType(
     'Is Less Than',
@@ -118,14 +118,14 @@ const NOT_EQUAL = registerFilterType(
     false,
     '<>'
 );
-/** Finds rows where the column value is not in any of the supplied filter values. The values should be supplied as a semi-colon-delimited list (example usage: a;b;c).*/
+/** Finds rows where the column value is not in any of the supplied filter values. Use semicolons or new lines to separate entries.*/
 const NOT_IN = registerFilterType(
     'Does Not Equal Any Of',
     null,
     'notin',
     true,
     ';',
-    'Does Not Equal Any Of (example usage: a;b;c)'
+    'Does Not Equal Any Of'
 );
 const NEQ_OR_NULL = registerFilterType(NOT_EQUAL.getDisplayText(), NOT_EQUAL.getDisplaySymbol(), 'neqornull', true);
 
@@ -239,15 +239,15 @@ export const Types: Record<string, IFilterType> = {
         'containsoneof',
         true,
         ';',
-        'Contains One Of (example usage: a;b;c)'
+        'Contains One Of'
     ),
     CONTAINS_NONE_OF: registerFilterType(
         'Does Not Contain Any Of',
         null,
         'containsnoneof',
         true,
         ';',
-        'Does Not Contain Any Of (example usage: a;b;c)'
+        'Does Not Contain Any Of'
     ),
 
     // NOTE: for some reason IN is aliased as EQUALS_ONE_OF. Not sure if this is for legacy purposes or it was
@@ -521,6 +521,8 @@ export function registerFilterType(
     const isDataValueRequired = () => dataValueRequired === true;
     const isMultiValued = () => multiValueSeparator != null;
     const isTableWise = () => tableWise === true;
+    // Note that while ';' and ',' are both used as primary separators, '\n' is the only secondary separator
+    const NEW_LINE_SEP = '\n';
 
     const type: IFilterType = {
         getDisplaySymbol: () => displaySymbol ?? null,
@@ -543,7 +545,8 @@ export function registerFilterType(
                     if (value.indexOf('{json:') === 0 && value.indexOf('}') === value.length - 1) {
                         value = JSON.parse(value.substring('{json:'.length, value.length - 1));
                     } else {
-                        value = value.split(type.getMultiValueSeparator());
+                        const regexPattern = new RegExp(`[${NEW_LINE_SEP}${type.getMultiValueSeparator()}]`);
+                        value = value.split(regexPattern);
                     }
                 }
 

src/labkey/filter/Types.ts

@@ -37,7 +37,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Does Not Contain Any Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Does Not Contain Any Of (example usage: a;b;c)",
+    "getLongDisplayText": "Does Not Contain Any Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",
@@ -54,7 +54,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Contains One Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Contains One Of (example usage: a;b;c)",
+    "getLongDisplayText": "Contains One Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",
@@ -241,7 +241,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Does Not Equal Any Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Does Not Equal Any Of (example usage: a;b;c)",
+    "getLongDisplayText": "Does Not Equal Any Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",
@@ -258,7 +258,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Equals One Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Equals One Of (example usage: a;b;c)",
+    "getLongDisplayText": "Equals One Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",
@@ -428,7 +428,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Equals One Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Equals One Of (example usage: a;b;c)",
+    "getLongDisplayText": "Equals One Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",
@@ -666,7 +666,7 @@
     "getDisplaySymbol": null,
     "getDisplayText": "Does Not Equal Any Of",
     "getLabKeySqlOperator": "undefined",
-    "getLongDisplayText": "Does Not Equal Any Of (example usage: a;b;c)",
+    "getLongDisplayText": "Does Not Equal Any Of",
     "getMultiValueFilter": null,
     "getMultiValueMaxOccurs": "undefined",
     "getMultiValueMinOccurs": "undefined",