feat: Adds $search operator.

Author: ryasmi

package-lock.json

@@ -25,7 +25,7 @@
     "check-coverage": true
   },
   "dependencies": {
-    "@js-entity-repos/core": "^9.0.0",
+    "@js-entity-repos/core": "^9.1.0",
     "lodash": "^4.17.4",
     "sift": "^5.0.0"
   },

package.json

@@ -0,0 +1,9 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import { Filter } from '@js-entity-repos/core/dist/types/Filter';
+import parseFilterKey from './parseFilterKey';
+
+export default <E extends Entity>(filter: Filter<E>) => {
+  return parseFilterKey('$search', (value: any) => {
+    return { $regex: new RegExp(value, 'i') };
+  })(filter);
+};

src/utils/constructSiftFilter.ts

@@ -2,13 +2,15 @@ import Entity from '@js-entity-repos/core/dist/types/Entity';
 // tslint:disable-next-line:no-unused import-spacing
 import { ConditionFilter, Filter, PropFilter } from '@js-entity-repos/core/dist/types/Filter';
 import sift from 'sift';
+import constructSiftFilter from './constructSiftFilter';
 
 export interface Opts<E extends Entity> {
   readonly entities: E[];
   readonly filter: Filter<E>;
 }
 
 export default <E extends Entity>({ entities, filter }: Opts<E>) => {
-  const sifter = sift(filter as any);
+  const siftFilter = constructSiftFilter(filter);
+  const sifter = sift(siftFilter as any);
   return entities.filter(sifter);
 };

src/utils/filterEntities.ts

@@ -0,0 +1,21 @@
+import { difference, get, has, isArray, isPlainObject, map, mapValues, pick } from 'lodash';
+
+type FilterParser = (filter: object) => object;
+
+const parseFilterKey = (key: string, parser: FilterParser): FilterParser => {
+  return (filter: object): object => {
+    if (has(filter, key)) {
+      const otherKeys = difference(Object.keys(filter), [key]);
+      const remainingFilter = pick(filter, otherKeys);
+      return { ...remainingFilter, ...parser(get(filter, key)) };
+    } else if (isArray(filter)) {
+      return map(filter, parseFilterKey(key, parser));
+    } else if (isPlainObject(filter)) {
+      return mapValues(filter, parseFilterKey(key, parser));
+    }
+
+    return filter;
+  };
+};
+
+export default parseFilterKey;