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",
     "mongodb": "^3.0.0"
   },

package.json

@@ -1,13 +1,15 @@
 import CountEntities from '@js-entity-repos/core/dist/signatures/CountEntities';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): CountEntities<E> => {
   return async ({ filter = {} }) => {
     const db = (await config.db());
     const collection = db.collection(config.collectionName);
     const constructedFilter = config.constructFilter(filter);
-    const count = await collection.find(constructedFilter).count();
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    const count = await collection.find(mongoFilter).count();
     return { count };
   };
 };

src/functions/countEntities.ts

@@ -8,6 +8,7 @@ import createGetEntitiesResult from '@js-entity-repos/core/dist/utils/createGetE
 import createPaginationFilter from '@js-entity-repos/core/dist/utils/createPaginationFilter';
 import { mapValues } from 'lodash';
 import FacadeConfig from '../FacadeConfig';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 const xor = (conditionA: boolean, conditionB: boolean) => {
   return (conditionA && !conditionB) || (!conditionA && conditionB);
@@ -28,12 +29,13 @@ export default <E extends Entity>(config: FacadeConfig<E>): GetEntities<E> => {
     const fullFilter = { $and: [filter, paginationFilter] };
     const constructedFilter = config.constructFilter(fullFilter);
     const constructedSort = config.constructSort(sort);
+    const mongoFilter = constructMongoFilter(constructedFilter);
     const mongoSort = mapValues(constructedSort, (sortOrder: SortOrder) => {
       return !xor(pagination.direction === forward, sortOrder === asc) ? 1 : -1;
     });
 
     const results = await collection
-      .find(constructedFilter)
+      .find(mongoFilter)
       .sort(mongoSort)
       .limit(pagination.limit + 1)
       .toArray();

src/functions/getEntities.ts

@@ -3,13 +3,15 @@ import GetEntity from '@js-entity-repos/core/dist/signatures/GetEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
 import constructIdFilter from '../utils/constructIdFilter';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): GetEntity<E> => {
   return async ({ id, filter = {} }) => {
     const db = (await config.db());
     const collection = db.collection(config.collectionName);
     const constructedFilter = constructIdFilter({ id, filter, config });
-    const document = await collection.findOne(constructedFilter);
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    const document = await collection.findOne(mongoFilter);
 
     if (document === undefined || document === null) {
       throw new MissingEntityError(config.entityName, id);

src/functions/getEntity.ts

@@ -3,6 +3,7 @@ import PatchEntity from '@js-entity-repos/core/dist/signatures/PatchEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
 import constructIdFilter from '../utils/constructIdFilter';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): PatchEntity<E> => {
   return async ({ id, patch, filter = {} }) => {
@@ -12,7 +13,8 @@ export default <E extends Entity>(config: FacadeConfig<E>): PatchEntity<E> => {
     const update = { $set: document };
     const opts = { returnOriginal: false, upsert: false };
     const constructedFilter = constructIdFilter({ id, filter, config });
-    const { value } = await collection.findOneAndUpdate(constructedFilter, update, opts);
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    const { value } = await collection.findOneAndUpdate(mongoFilter, update, opts);
 
     if (value === undefined || value === null) {
       throw new MissingEntityError(config.entityName, id);

src/functions/patchEntity.ts

@@ -1,12 +1,14 @@
 import RemoveEntities from '@js-entity-repos/core/dist/signatures/RemoveEntities';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntities<E> => {
   return async ({ filter = {} }) => {
     const db = (await config.db());
     const collection = db.collection(config.collectionName);
     const constructedFilter = config.constructFilter(filter);
-    await collection.remove(constructedFilter);
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    await collection.remove(mongoFilter);
   };
 };

src/functions/removeEntities.ts

@@ -3,13 +3,15 @@ import RemoveEntity from '@js-entity-repos/core/dist/signatures/RemoveEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
 import constructIdFilter from '../utils/constructIdFilter';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntity<E> => {
   return async ({ id, filter = {} }) => {
     const db = (await config.db());
     const collection = db.collection(config.collectionName);
     const constructedFilter = constructIdFilter({ id, filter, config });
-    const { value } = await collection.findOneAndDelete(constructedFilter);
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    const { value } = await collection.findOneAndDelete(mongoFilter);
 
     if (value === undefined || value === null) {
       throw new MissingEntityError(config.entityName, id);

src/functions/removeEntity.ts

@@ -3,14 +3,16 @@ import ReplaceEntity from '@js-entity-repos/core/dist/signatures/ReplaceEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import FacadeConfig from '../FacadeConfig';
 import constructIdFilter from '../utils/constructIdFilter';
+import constructMongoFilter from '../utils/constructMongoFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): ReplaceEntity<E> => {
   return async ({ id, entity, filter = {} }) => {
     const db = (await config.db());
     const collection = db.collection(config.collectionName);
     const opts = { returnOriginal: false, upsert: false };
     const constructedFilter = constructIdFilter({ id, filter, config });
-    const { value } = await collection.findOneAndUpdate(constructedFilter, entity, opts);
+    const mongoFilter = constructMongoFilter(constructedFilter);
+    const { value } = await collection.findOneAndUpdate(mongoFilter, entity, opts);
 
     if (value === undefined || value === null) {
       throw new MissingEntityError(config.entityName, id);

src/functions/replaceEntity.ts

@@ -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);
+};