fix: Improves factory config defaults.

Author: ryasmi

readme.md

@@ -5,7 +5,6 @@
 1. Install it with `npm i @js-entity-repos/memory`.
 1. For each entity you will need to do the following.
     1. [Create Entity interface](#entity-interface).
-    1. [Create a factory config](#factory-config).
     1. [Construct the facade](#construct-the-facade).
     1. [Use the facade](https://github.com/js-entity-repos/core/blob/master/docs/facade.md).
 
@@ -20,28 +19,21 @@ export interface TodoEntity extends Entity {
 }
 ```
 
-### Factory Config
+### Construct the Facade
 
 ```ts
-import FactoryConfig from '@js-entity-repos/memory/dist/Config';
-
-interface State {
-  todos: TodoEntity[];
-}
+import factory from '@js-entity-repos/memory/dist/factory';
 
+interface State { todos: TodoEntity[]; }
 const state: State = { todos: [] };
-const todoFactoryConfig: FactoryConfig = {
-  defaultPaginationLimit: 100,
+
+const todosFacade = factory({
+  // Optional property. Defaults to 10.
+  defaultPaginationLimit: 10,
   entityName: 'todo',
+  // Optional property. Defaults to using entities stored locally in the factory.
   getEntities: () => state.todos,
+  // Optional property. Defaults to using entities stored locally in the factory.
   setEntities: (todos) => state.todos = todos,
-};
-```
-
-### Construct the Facade
-
-```ts
-import factory from '@js-entity-repos/memory/dist/factory';
-
-const todosFacade = factory(todoFactoryConfig);
+});
 ```

src/Config.ts renamed to src/FacadeConfig.ts

@@ -1,6 +1,6 @@
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 
-export default interface Config<E extends Entity> {
+export default interface FacadeConfig<E extends Entity> {
   readonly getEntities: () => E[];
   readonly setEntities: (entities: E[]) => void;
   readonly entityName: string;

src/FactoryConfig.ts

@@ -0,0 +1,8 @@
+import Entity from '@js-entity-repos/core/dist/types/Entity';
+
+export default interface FactoryConfig<E extends Entity> {
+  readonly getEntities?: () => E[];
+  readonly setEntities?: (entities: E[]) => void;
+  readonly entityName: string;
+  readonly defaultPaginationLimit?: number;
+}

src/factory.test.ts

@@ -1,17 +1,6 @@
 import facadeTest from '@js-entity-repos/core/dist/tests';
-import { TestEntity } from '@js-entity-repos/core/dist/tests/utils/testEntity';
 import factory from './factory';
 
-interface State {
-  // tslint:disable-next-line:readonly-keyword
-  entities: TestEntity[];
-}
-
-const state: State = { entities: [] };
-
 facadeTest(factory({
-  defaultPaginationLimit: 100,
   entityName: 'Test Entity',
-  getEntities: () => state.entities,
-  setEntities: (entities) => state.entities = entities,
 }));

src/factory.ts

@@ -1,6 +1,7 @@
 import Facade from '@js-entity-repos/core/dist/Facade';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
-import Config from './Config';
+import FacadeConfig from './FacadeConfig';
+import FactoryConfig from './FactoryConfig';
 import countEntities from './functions/countEntities';
 import createEntity from './functions/createEntity';
 import getEntities from './functions/getEntities';
@@ -10,15 +11,23 @@ import removeEntities from './functions/removeEntities';
 import removeEntity from './functions/removeEntity';
 import replaceEntity from './functions/replaceEntity';
 
-export default <E extends Entity>(config: Config<E>): Facade<E> => {
+export default <E extends Entity>(factoryConfig: FactoryConfig<E>): Facade<E> => {
+  // tslint:disable-next-line:no-let
+  let entities: E[] = [];
+  const facadeConfig: FacadeConfig<E> = {
+    defaultPaginationLimit: 10,
+    getEntities: () => entities,
+    setEntities: (nextEntities) => entities = nextEntities,
+    ...factoryConfig,
+  };
   return {
-    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),
+    countEntities: countEntities<E>(facadeConfig),
+    createEntity: createEntity<E>(facadeConfig),
+    getEntities: getEntities<E>(facadeConfig),
+    getEntity: getEntity<E>(facadeConfig),
+    patchEntity: patchEntity<E>(facadeConfig),
+    removeEntities: removeEntities<E>(facadeConfig),
+    removeEntity: removeEntity<E>(facadeConfig),
+    replaceEntity: replaceEntity<E>(facadeConfig),
   };
 };

src/functions/countEntities.ts

@@ -1,9 +1,9 @@
 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 FacadeConfig from '../FacadeConfig';
 import filterEntities from '../utils/filterEntities';
 
-export default <E extends Entity>(config: Config<E>): CountEntities<E> => {
+export default <E extends Entity>(config: FacadeConfig<E>): CountEntities<E> => {
   return async ({ filter = {} }) => {
     const entities = config.getEntities();
     const matchedEntities = filterEntities({ entities, filter });

src/functions/createEntity.ts

@@ -2,14 +2,14 @@ import ConflictingEntityError from '@js-entity-repos/core/dist/errors/Conflictin
 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 FacadeConfig from '../FacadeConfig';
 import filterEntities from '../utils/filterEntities';
 
 export default <E extends Entity>({
   entityName,
   getEntities,
   setEntities,
-}: Config<E>): CreateEntity<E> => {
+}: FacadeConfig<E>): CreateEntity<E> => {
   return async ({ id, entity }) => {
     const entities = getEntities();
     const idFilter = { id } as Filter<E>;

src/functions/getEntities.ts

@@ -7,11 +7,11 @@ import { asc } from '@js-entity-repos/core/dist/types/SortOrder';
 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 FacadeConfig from '../FacadeConfig';
 import filterEntities from '../utils/filterEntities';
 import sortEntities from '../utils/sortEntities';
 
-export default <E extends Entity>(config: Config<E>): GetEntities<E> => {
+export default <E extends Entity>(config: FacadeConfig<E>): GetEntities<E> => {
   const defaultPagination: Pagination = {
     cursor: undefined,
     direction: forward,

src/functions/getEntity.ts

@@ -1,12 +1,12 @@
 import GetEntity from '@js-entity-repos/core/dist/signatures/GetEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
-import Config from '../Config';
+import FacadeConfig from '../FacadeConfig';
 import filterEntity from '../utils/filterEntity';
 
 export default <E extends Entity>({
   entityName,
   getEntities,
-}: Config<E>): GetEntity<E> => {
+}: FacadeConfig<E>): GetEntity<E> => {
   return async ({ id, filter = {} }) => {
     const entities = getEntities();
     const entity = filterEntity({ entities, entityName, id, filter });

src/functions/patchEntity.ts

@@ -1,14 +1,14 @@
 import PatchEntity from '@js-entity-repos/core/dist/signatures/PatchEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import { difference } from 'lodash';
-import Config from '../Config';
+import FacadeConfig from '../FacadeConfig';
 import filterEntity from '../utils/filterEntity';
 
 export default <E extends Entity>({
   entityName,
   getEntities,
   setEntities,
-}: Config<E>): PatchEntity<E> => {
+}: FacadeConfig<E>): PatchEntity<E> => {
   return async ({ id, patch, filter = {} }) => {
     const entities = getEntities();
     const matchedEntity = filterEntity({ entities, entityName, id, filter });

src/functions/removeEntities.ts

@@ -1,9 +1,9 @@
 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 FacadeConfig from '../FacadeConfig';
 import filterEntities from '../utils/filterEntities';
 
-export default <E extends Entity>(config: Config<E>): RemoveEntities<E> => {
+export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntities<E> => {
   return async ({ filter = {} }) => {
     const entities = config.getEntities();
     const removalFilter = { $nor: [filter] };

src/functions/removeEntity.ts

@@ -3,10 +3,10 @@ import MissingEntityError from '@js-entity-repos/core/dist/errors/MissingEntityE
 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 FacadeConfig from '../FacadeConfig';
 import filterEntities from '../utils/filterEntities';
 
-export default <E extends Entity>(config: Config<E>): RemoveEntity<E> => {
+export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntity<E> => {
   return async ({ id, filter = {} }) => {
     const entities = config.getEntities();
     const idFilter = { id } as Filter<E>;

src/functions/replaceEntity.ts

@@ -1,14 +1,14 @@
 import ReplaceEntity from '@js-entity-repos/core/dist/signatures/ReplaceEntity';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import { difference } from 'lodash';
-import Config from '../Config';
+import FacadeConfig from '../FacadeConfig';
 import filterEntity from '../utils/filterEntity';
 
 export default <E extends Entity>({
   entityName,
   getEntities,
   setEntities,
-}: Config<E>): ReplaceEntity<E> => {
+}: FacadeConfig<E>): ReplaceEntity<E> => {
   return async ({ id, entity, filter = {} }) => {
     const entities = getEntities();
     const matchedEntity = filterEntity({ entities, entityName, id, filter });