refactor: Changes the FactoryConfig to have more defaults. (#14)

BREAKING CHANGE: Removes `collection` from `FactoryConfig`. Use `db` and `collectionName` instead.

Author: ryasmi

readme.md

@@ -23,16 +23,13 @@ export interface TodoEntity extends Entity {
 
 ```ts
 import factory from '@js-entity-repos/mongo/dist/factory';
-import connectToCollection from '@js-entity-repos/mongo/dist/utils/connectToCollection';
+import connectToDb from '@js-entity-repos/mongo/dist/utils/connectToDb';
 import parseFilterId from '@js-entity-repos/mongo/dist/utils/parseFilterId';
 import renameSortId from '@js-entity-repos/mongo/dist/utils/renameSortId';
 
 const todosFacade = factory<TodoEntity>({
-  collection: connectToCollection({
-    collectionName: 'todos',
-    dbName: 'todoapp',
-    url: 'mongodb://localhost:27017',
-  }),
+  // Optional property. Defaults to entityName.
+  collectionName: 'todos',
   // Optional property to convert an entity to a DB document. Defaults to "utils/constructIdDocument".
   constructDocument: ({ id, ...patch}) => {
     return { _id: id, ...patch };
@@ -48,7 +45,11 @@ const todosFacade = factory<TodoEntity>({
   // Optional property to convert an entity sort to a DB sort. Defaults to "utils/renameSortId".
   constructSort: (sort) => {
     return renameSortId(sort);
-  }.
+  },
+  db: connectToDb({
+    dbName: 'todoapp',
+    url: 'mongodb://localhost:27017',
+  }),
   // Optional property. Defaults to 10.
   defaultPaginationLimit: 10,
   entityName: 'todo',

src/FacadeConfig.ts

@@ -1,16 +1,17 @@
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Sort from '@js-entity-repos/core/dist/types/Sort';
-import { Collection } from 'mongodb';
+import { Db } from 'mongodb';
 
 export type Document = any;
 
 export default interface FacadeConfig<E extends Entity> {
-  readonly collection: () => Promise<Collection>;
-  readonly defaultPaginationLimit: number;
-  readonly entityName: string;
+  readonly collectionName: string;
   readonly constructDocument: (patch: Partial<E>) => Document;
   readonly constructEntity: (document: Document) => E;
   readonly constructFilter: (filter: Filter<E>) => any;
   readonly constructSort: (sort: Sort<E>) => any;
+  readonly db: () => Promise<Db>;
+  readonly defaultPaginationLimit: number;
+  readonly entityName: string;
 }

src/FactoryConfig.ts

@@ -1,16 +1,17 @@
 import Entity from '@js-entity-repos/core/dist/types/Entity';
 import Filter from '@js-entity-repos/core/dist/types/Filter';
 import Sort from '@js-entity-repos/core/dist/types/Sort';
-import { Collection } from 'mongodb';
+import { Db } from 'mongodb';
 
 export type Document = any;
 
 export default interface FactoryConfig<E extends Entity> {
-  readonly collection: () => Promise<Collection>;
-  readonly defaultPaginationLimit?: number;
-  readonly entityName: string;
+  readonly collectionName?: string;
   readonly constructDocument?: (patch: Partial<E>) => Document;
   readonly constructEntity?: (document: Document) => E;
   readonly constructFilter?: (filter: Filter<E>) => any;
   readonly constructSort?: (sort: Sort<E>) => any;
+  readonly db: () => Promise<Db>;
+  readonly defaultPaginationLimit?: number;
+  readonly entityName: string;
 }

src/factory.test.ts

@@ -1,13 +1,12 @@
 import facadeTest from '@js-entity-repos/core/dist/tests';
 import { TestEntity } from '@js-entity-repos/core/dist/tests/utils/testEntity';
 import factory from './factory';
-import connectToCollection from './utils/connectToCollection';
+import connectToDb from './utils/connectToDb';
 
 facadeTest(factory<TestEntity>({
-  collection: connectToCollection({
-    collectionName: 'testentities',
+  db: connectToDb({
     dbName: 'js-entity-repos-mongo',
     url: 'mongodb://localhost:27017',
   }),
-  entityName: 'Test Entity',
+  entityName: 'TestEntity',
 }));

src/factory.ts

@@ -17,6 +17,7 @@ import renameSortId from './utils/renameSortId';
 
 export default <E extends Entity>(factoryConfig: FactoryConfig<E>): Facade<E> => {
   const facadeConfig: FacadeConfig<E> = {
+    collectionName: factoryConfig.entityName,
     constructDocument: constructIdDocument,
     constructEntity: constructIdEntity,
     constructFilter: parseFilterId,

src/functions/countEntities.ts

@@ -4,7 +4,8 @@ import FacadeConfig from '../FacadeConfig';
 
 export default <E extends Entity>(config: FacadeConfig<E>): CountEntities<E> => {
   return async ({ filter = {} }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const constructedFilter = config.constructFilter(filter);
     const count = await collection.find(constructedFilter).count();
     return { count };

src/functions/createEntity.ts

@@ -6,7 +6,8 @@ import FacadeConfig from '../FacadeConfig';
 
 export default <E extends Entity>(config: FacadeConfig<E>): CreateEntity<E> => {
   return async ({ id, entity }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const document = config.constructDocument({ ...entity as any, id });
     const update = { $setOnInsert: document };
     const opts = { returnOriginal: false, upsert: true };

src/functions/getEntities.ts

@@ -21,7 +21,8 @@ export default <E extends Entity>(config: FacadeConfig<E>): GetEntities<E> => {
   };
   const defaultSort = { id: asc } as Sort<E>;
   return async ({ filter = {}, sort = defaultSort, pagination = defaultPagination }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
 
     const paginationFilter = createPaginationFilter(pagination, sort);
     const fullFilter = { $and: [filter, paginationFilter] };

src/functions/getEntity.ts

@@ -6,7 +6,8 @@ import constructIdFilter from '../utils/constructIdFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): GetEntity<E> => {
   return async ({ id, filter = {} }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const constructedFilter = constructIdFilter({ id, filter, config });
     const document = await collection.findOne(constructedFilter);
 

src/functions/patchEntity.ts

@@ -6,7 +6,8 @@ import constructIdFilter from '../utils/constructIdFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): PatchEntity<E> => {
   return async ({ id, patch, filter = {} }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const document = config.constructDocument({ ...patch as any, id });
     const update = { $set: document };
     const opts = { returnOriginal: false, upsert: false };

src/functions/removeEntities.ts

@@ -4,7 +4,8 @@ import FacadeConfig from '../FacadeConfig';
 
 export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntities<E> => {
   return async ({ filter = {} }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const constructedFilter = config.constructFilter(filter);
     await collection.remove(constructedFilter);
   };

src/functions/removeEntity.ts

@@ -6,7 +6,8 @@ import constructIdFilter from '../utils/constructIdFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): RemoveEntity<E> => {
   return async ({ id, filter = {} }) => {
-    const collection = (await config.collection());
+    const db = (await config.db());
+    const collection = db.collection(config.collectionName);
     const constructedFilter = constructIdFilter({ id, filter, config });
     const { value } = await collection.findOneAndDelete(constructedFilter);
 

src/functions/replaceEntity.ts

@@ -6,7 +6,8 @@ import constructIdFilter from '../utils/constructIdFilter';
 
 export default <E extends Entity>(config: FacadeConfig<E>): ReplaceEntity<E> => {
   return async ({ id, entity, filter = {} }) => {
-    const collection = (await config.collection());
+    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);