fix(deps): Updates core to 6.0.2.

ryasmi · ryasmi · commit 944596687ce9 · 2018-01-07T01:18:58.000Z
BREAKING CHANGE: The `filter`, `sort`, and `paginate` options are now optional.
BREAKING CHANGE: The `upsertEntity` function has been removed due to filter issues.
BREAKING CHANGE: The `overwriteEntity` function was renamed to `replaceEntity`.
BREAKING CHANGE: Removes Id interface from all functions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,7 +25,7 @@
     "check-coverage": true
   },
   "dependencies": {
-    "@js-entity-repos/core": "^4.1.1",
+    "@js-entity-repos/core": "^6.0.2",
     "lodash": "^4.17.4",
     "sift": "^5.0.0"
   },
diff --git a/src/Config.ts b/src/Config.ts
@@ -1,5 +1,8 @@
-export default interface Config<Entity> {
-  readonly getEntities: () => Entity[];
-  readonly setEntities: (entities: Entity[]) => void;
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+
+export default interface Config<E extends Entity> {
+  readonly getEntities: () => E[];
+  readonly setEntities: (entities: E[]) => void;
   readonly entityName: string;
+  readonly defaultPaginationLimit: number;
 }
diff --git a/src/facade.test.ts b/src/facade.test.ts
@@ -1,5 +1,5 @@
 import facadeTest from '@js-entity-repos/core/dist/tests';
-import { TestEntity, TestId } from '@js-entity-repos/core/dist/tests/utils/testEntity';
+import { TestEntity } from '@js-entity-repos/core/dist/tests/utils/testEntity';
 import facade from './facade';
 
 interface State {
@@ -9,7 +9,8 @@ interface State {
 
 const state: State = { entities: [] };
 
-facadeTest(facade<TestId, TestEntity>({
+facadeTest(facade<TestEntity>({
+  defaultPaginationLimit: 100,
   entityName: 'Test Entity',
   getEntities: () => state.entities,
   setEntities: (entities) => state.entities = entities,
diff --git a/src/facade.ts b/src/facade.ts
@@ -1,25 +1,24 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Config from './Config';
 import countEntities from './functions/countEntities';
 import createEntity from './functions/createEntity';
 import getEntities from './functions/getEntities';
 import getEntity from './functions/getEntity';
-import overwriteEntity from './functions/overwriteEntity';
 import patchEntity from './functions/patchEntity';
 import removeEntities from './functions/removeEntities';
 import removeEntity from './functions/removeEntity';
-import upsertEntity from './functions/upsertEntity';
+import replaceEntity from './functions/replaceEntity';
 
-export default <Id, Entity extends Id>(config: Config<Entity>): Facade<Id, Entity> => {
+export default <E extends Entity>(config: Config<E>): Facade<E> => {
   return {
-    countEntities: countEntities<Entity>(config),
-    createEntity: createEntity<Id, Entity>(config),
-    getEntities: getEntities<Entity>(config),
-    getEntity: getEntity<Id, Entity>(config),
-    overwriteEntity: overwriteEntity<Id, Entity>(config),
-    patchEntity: patchEntity<Id, Entity>(config),
-    removeEntities: removeEntities<Entity>(config),
-    removeEntity: removeEntity<Id, Entity>(config),
-    upsertEntity: upsertEntity<Id, Entity>(config),
+    countEntities: countEntities<E>(config),
+    createEntity: createEntity<E>(config),
+    getEntities: getEntities<E>(config),
+    getEntity: getEntity<E>(config),
+    patchEntity: patchEntity<E>(config),
+    removeEntities: removeEntities<E>(config),
+    removeEntity: removeEntity<E>(config),
+    replaceEntity: replaceEntity<E>(config),
   };
 };
diff --git a/src/functions/countEntities.ts b/src/functions/countEntities.ts
@@ -1,9 +1,10 @@
 import CountEntities from '@js-entity-repos/core/dist/signatures/CountEntities';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Entity>(config: Config<Entity>): CountEntities<Entity> => {
-  return async ({ filter }) => {
+export default <E extends Entity>(config: Config<E>): CountEntities<E> => {
+  return async ({ filter = {} }) => {
     const storedEntities = config.getEntities();
     const matchedEntities = filterEntities(storedEntities, filter);
     const count = matchedEntities.length;
diff --git a/src/functions/createEntity.ts b/src/functions/createEntity.ts
@@ -1,16 +1,20 @@
 import ConflictingEntityError from '@js-entity-repos/core/dist/errors/ConflictingEntityError';
 import CreateEntity from '@js-entity-repos/core/dist/signatures/CreateEntity';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Id, Entity extends Id>(config: Config<Entity>): CreateEntity<Id, Entity> => {
+export default <E extends Entity>(config: Config<E>): CreateEntity<E> => {
   return async ({ id, entity }) => {
     const storedEntities = config.getEntities();
-    const matchedEntities = filterEntities(storedEntities, id);
+    const idFilter = { id } as Filter<E>;
+    const matchedEntities = filterEntities(storedEntities, idFilter);
     if (matchedEntities.length > 0) {
       throw new ConflictingEntityError(config.entityName, id);
     }
-    config.setEntities([...config.getEntities(), entity]);
-    return { entity };
+    const createdEntity = { ...entity as any, id };
+    config.setEntities([...config.getEntities(), createdEntity]);
+    return { entity: createdEntity };
   };
 };
diff --git a/src/functions/getEntities.ts b/src/functions/getEntities.ts
@@ -1,13 +1,21 @@
 import GetEntities from '@js-entity-repos/core/dist/signatures/GetEntities';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Sort from '@js-entity-repos/core/dist/types/Sort';
 import createCursorFromEntity from '@js-entity-repos/core/dist/utils/createCursorFromEntity';
 import createPaginationFilter from '@js-entity-repos/core/dist/utils/createPaginationFilter';
 import { first, last } from 'lodash';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 import sortEntities from '../utils/sortEntities';
 
-export default <Entity>(config: Config<Entity>): GetEntities<Entity> => {
-  return async ({ filter, sort, pagination }) => {
+export default <E extends Entity>(config: Config<E>): GetEntities<E> => {
+  const defaultPagination = {
+    cursor: undefined,
+    forward: true,
+    limit: config.defaultPaginationLimit,
+  };
+  const defaultSort = { id: true } as Sort<E>;
+  return async ({ filter = {}, sort = defaultSort, pagination = defaultPagination }) => {
     const paginationFilter = createPaginationFilter(pagination, sort);
     const fullFilter = { $and: [filter, paginationFilter] };
     const storedEntities = config.getEntities();
diff --git a/src/functions/getEntity.ts b/src/functions/getEntity.ts
@@ -1,13 +1,17 @@
 import ConflictingEntityError from '@js-entity-repos/core/dist/errors/ConflictingEntityError';
 import MissingEntityError from '@js-entity-repos/core/dist/errors/MissingEntityError';
 import GetEntity from '@js-entity-repos/core/dist/signatures/GetEntity';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Id, Entity extends Id>(config: Config<Entity>): GetEntity<Id, Entity> => {
-  return async ({ id }) => {
+export default <E extends Entity>(config: Config<E>): GetEntity<E> => {
+  return async ({ id, filter = {} }) => {
     const storedEntities = config.getEntities();
-    const matchedEntities = filterEntities(storedEntities, id);
+    const idFilter = { id } as Filter<E>;
+    const fullFilter = { $and: [idFilter, filter] };
+    const matchedEntities = filterEntities(storedEntities, fullFilter);
     if (matchedEntities.length === 0) {
       throw new MissingEntityError(config.entityName, id);
     }
diff --git a/src/functions/overwriteEntity.ts b/src/functions/overwriteEntity.ts
diff --git a/src/functions/patchEntity.ts b/src/functions/patchEntity.ts
@@ -1,13 +1,17 @@
 import ConflictingEntityError from '@js-entity-repos/core/dist/errors/ConflictingEntityError';
 import MissingEntityError from '@js-entity-repos/core/dist/errors/MissingEntityError';
 import PatchEntity from '@js-entity-repos/core/dist/signatures/PatchEntity';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Id, Entity extends Id>(config: Config<Entity>): PatchEntity<Id, Entity> => {
-  return async ({ id, patch }) => {
+export default <E extends Entity>(config: Config<E>): PatchEntity<E> => {
+  return async ({ id, patch, filter = {} }) => {
     const storedEntities = config.getEntities();
-    const matchedEntities = filterEntities(storedEntities, id);
+    const idFilter = { id } as Filter<E>;
+    const fullFilter = { $and: [idFilter, filter] };
+    const matchedEntities = filterEntities(storedEntities, fullFilter);
     if (matchedEntities.length === 0) {
       throw new MissingEntityError(config.entityName, id);
     }
@@ -16,10 +20,10 @@ export default <Id, Entity extends Id>(config: Config<Entity>): PatchEntity<Id,
       throw new ConflictingEntityError(config.entityName, id);
     }
 
-    const patchEntities = matchedEntities.map((matchedEntity) => {
-      return { ...matchedEntity as any, ...patch as any } as Entity;
+    const patchEntities = matchedEntities.map((matchedEntity: E) => {
+      return { ...matchedEntity as any, ...patch as any } as E;
     });
-    const unmatchedEntities = filterEntities(storedEntities, { $nor: [id] });
+    const unmatchedEntities = filterEntities(storedEntities, { $nor: [idFilter] });
     config.setEntities([...unmatchedEntities, ...patchEntities]);
     return { entity: patchEntities[0] };
   };
diff --git a/src/functions/removeEntities.ts b/src/functions/removeEntities.ts
@@ -1,9 +1,10 @@
 import RemoveEntities from '@js-entity-repos/core/dist/signatures/RemoveEntities';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Entity>(config: Config<Entity>): RemoveEntities<Entity> => {
-  return async ({ filter }) => {
+export default <E extends Entity>(config: Config<E>): RemoveEntities<E> => {
+  return async ({ filter = {} }) => {
     const storedEntities = config.getEntities();
     const unmatchedEntities = filterEntities(storedEntities, { $nor: [filter] });
     config.setEntities(unmatchedEntities);
diff --git a/src/functions/removeEntity.ts b/src/functions/removeEntity.ts
@@ -1,13 +1,17 @@
 import ConflictingEntityError from '@js-entity-repos/core/dist/errors/ConflictingEntityError';
 import MissingEntityError from '@js-entity-repos/core/dist/errors/MissingEntityError';
 import RemoveEntity from '@js-entity-repos/core/dist/signatures/RemoveEntity';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Config from '../Config';
 import filterEntities from '../utils/filterEntities';
 
-export default <Id, Entity extends Id>(config: Config<Entity>): RemoveEntity<Id> => {
-  return async ({ id }) => {
+export default <E extends Entity>(config: Config<E>): RemoveEntity<E> => {
+  return async ({ id, filter = {} }) => {
     const storedEntities = config.getEntities();
-    const unmatchedEntities = filterEntities(storedEntities, { $nor: [id] });
+    const idFilter = { id } as Filter<E>;
+    const fullFilter = { $and: [idFilter, filter] };
+    const unmatchedEntities = filterEntities(storedEntities, { $nor: [fullFilter] });
     if (unmatchedEntities.length === storedEntities.length) {
       throw new MissingEntityError(config.entityName, id);
     }
diff --git a/src/functions/replaceEntity.ts b/src/functions/replaceEntity.ts
@@ -0,0 +1,30 @@
+import ConflictingEntityError from '@js-entity-repos/core/dist/errors/ConflictingEntityError';
+import MissingEntityError from '@js-entity-repos/core/dist/errors/MissingEntityError';
+import ReplaceEntity from '@js-entity-repos/core/dist/signatures/ReplaceEntity';
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Filter from '@js-entity-repos/core/dist/types/Filter';
+import Config from '../Config';
+import filterEntities from '../utils/filterEntities';
+
+export default <E extends Entity>(config: Config<E>): ReplaceEntity<E> => {
+  return async ({ id, entity, filter = {} }) => {
+    const storedEntities = config.getEntities();
+    const idFilter = { id } as Filter<E>;
+    const fullFilter = { $and: [idFilter, filter] };
+    const matchedEntities = filterEntities(storedEntities, fullFilter);
+    if (matchedEntities.length === 0) {
+      throw new MissingEntityError(config.entityName, id);
+    }
+    /* istanbul ignore next */
+    if (matchedEntities.length > 1) {
+      throw new ConflictingEntityError(config.entityName, id);
+    }
+
+    const replacedEntities = matchedEntities.map(() => {
+      return { ...entity as any, id } as E;
+    });
+    const unmatchedEntities = filterEntities(storedEntities, { $nor: [fullFilter] });
+    config.setEntities([...unmatchedEntities, ...replacedEntities]);
+    return { entity: replacedEntities[0] };
+  };
+};
diff --git a/src/functions/upsertEntity.ts b/src/functions/upsertEntity.ts
diff --git a/src/utils/filterEntities.ts b/src/utils/filterEntities.ts
@@ -1,9 +1,9 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
 // tslint:disable-next-line:no-unused import-spacing
-import { AndFilter, Filter, NorFilter, NotFilter, OrFilter }
-  from '@js-entity-repos/core/dist/types/Filter';
+import { ConditionFilter, Filter, PropFilter } from '@js-entity-repos/core/dist/types/Filter';
 import sift from 'sift';
 
-export default <Entity>(entities: Entity[], filter: Filter<Entity>) => {
+export default <E extends Entity>(entities: E[], filter: Filter<E>) => {
   const sifter = sift(filter as any);
   return entities.filter(sifter);
 };
diff --git a/src/utils/sortEntities.ts b/src/utils/sortEntities.ts
@@ -1,7 +1,8 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Sort from '@js-entity-repos/core/dist/types/Sort';
 import { orderBy } from 'lodash';
 
-export default <Entity>(entities: Entity[], sort: Sort<Entity>) => {
+export default <E extends Entity>(entities: E[], sort: Sort<E>) => {
   const sortKeys = Object.keys(sort);
   const sortDirections = sortKeys.map((sortKey) => {
     const sortAscending = (sort as any)[sortKey] as boolean;
