feat: allows like to search by many words, adds contain to match exac…

…t strings
payloadcms · Apr 5, 2022 · ec91757 · ec91757
1 parent b99f6b1
commit ec91757
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 17 deletions.
diff --git a/docs/queries/overview.mdx b/docs/queries/overview.mdx
@@ -59,7 +59,8 @@ The above example demonstrates a simple query but you can get much more complex.
 | `greater_than_equal` | For numeric or date-based fields. |
 | `less_than`          | For numeric or date-based fields. |
 | `less_than_equal`    | For numeric or date-based fields. |
-| `like`               | The value must partially match. |
+| `like`               | Case-insensitive string must be present. If string of words, all words must be present, in any order. |
+| `contains`           | Must contain the value entered, case-insensitive. |
 | `in`                 | The value must be found within the provided comma-delimited list of values. |
 | `not_in`             | The value must NOT be within the provided comma-delimited list of values. |
 | `exists`             | Only return documents where the value either exists (`true`) or does not exist (`false`). |

diff --git a/src/admin/components/elements/WhereBuilder/field-types.tsx b/src/admin/components/elements/WhereBuilder/field-types.tsx
@@ -62,26 +62,31 @@ const like = {
   value: 'like',
 };
 
+const contains = {
+  label: 'contains',
+  value: 'contains',
+};
+
 const fieldTypeConditions = {
   text: {
     component: 'Text',
-    operators: [...base, like],
+    operators: [...base, like, contains],
   },
   email: {
     component: 'Text',
-    operators: [...base, like],
+    operators: [...base, contains],
   },
   textarea: {
     component: 'Text',
-    operators: [...base, like],
+    operators: [...base, like, contains],
   },
-  wysiwyg: {
+  code: {
     component: 'Text',
-    operators: [...base, like],
+    operators: [...base, like, contains],
   },
-  code: {
+  richText: {
     component: 'Text',
-    operators: [...base, like],
+    operators: [...base, like, contains],
   },
   number: {
     component: 'Number',

diff --git a/src/graphql/schema/fieldToSchemaMap.ts b/src/graphql/schema/fieldToSchemaMap.ts
@@ -44,7 +44,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         field,
         type,
         parentName,
-        [...operators.equality, 'like'],
+        [...operators.equality, 'like', 'contains'],
       ),
     };
   },
@@ -55,7 +55,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         field,
         type,
         parentName,
-        [...operators.equality, 'like'],
+        [...operators.equality, 'like', 'contains'],
       ),
     };
   },
@@ -66,7 +66,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         field,
         type,
         parentName,
-        [...operators.equality, 'like'],
+        [...operators.equality, 'like', 'contains'],
       ),
     };
   },
@@ -77,7 +77,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         field,
         type,
         parentName,
-        [...operators.equality, 'like'],
+        [...operators.equality, 'like', 'contains'],
       ),
     };
   },
@@ -88,7 +88,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         field,
         type,
         parentName,
-        [...operators.equality, 'like'],
+        [...operators.equality, 'like', 'contains'],
       ),
     };
   },
@@ -116,7 +116,7 @@ const fieldToSchemaMap: (parentName: string) => any = (parentName: string) => ({
         }, {}),
       }),
       parentName,
-      [...operators.equality, 'like'],
+      [...operators.equality, 'like', 'contains'],
     ),
   }),
   date: (field: DateField) => {

diff --git a/src/mongoose/buildQuery.ts b/src/mongoose/buildQuery.ts
@@ -8,7 +8,7 @@ import { getSchemaTypeOptions } from './getSchemaTypeOptions';
 import { operatorMap } from './operatorMap';
 import { sanitizeQueryValue } from './sanitizeFormattedValue';
 
-const validOperators = ['like', 'in', 'all', 'not_in', 'greater_than_equal', 'greater_than', 'less_than_equal', 'less_than', 'not_equals', 'equals', 'exists', 'near'];
+const validOperators = ['like', 'contains', 'in', 'all', 'not_in', 'greater_than_equal', 'greater_than', 'less_than_equal', 'less_than', 'not_equals', 'equals', 'exists', 'near'];
 
 const subQueryOptions = {
   limit: 50,

diff --git a/src/mongoose/sanitizeFormattedValue.ts b/src/mongoose/sanitizeFormattedValue.ts
@@ -90,8 +90,19 @@ export const sanitizeQueryValue = (schemaType: SchemaType, path: string, operato
     }
   }
 
-  if (operator === 'like' && path !== '_id') {
-    formattedValue = { $regex: formattedValue, $options: 'i' };
+  if (path !== '_id') {
+    if (operator === 'contains') {
+      formattedValue = { $regex: formattedValue, $options: 'i' };
+    }
+
+    if (operator === 'like' && typeof formattedValue === 'string') {
+      const words = formattedValue.split(' ');
+      const regex = words.reduce((pattern, word, i) => {
+        return `${pattern}(?=.*\\b${word}\\b)${i + 1 === words.length ? '.+' : ''}`;
+      }, '');
+
+      formattedValue = { $regex: new RegExp(regex), $options: 'i' };
+    }
   }
 
   if (operator === 'exists') {