fix(deps): Updates to core v7. (#14)

Author: ryasmi

package-lock.json

@@ -25,7 +25,7 @@
     "check-coverage": true
   },
   "dependencies": {
-    "@js-entity-repos/core": "^6.0.2",
+    "@js-entity-repos/core": "^7.1.0",
     "knex": "^0.14.2",
     "lodash": "^4.17.4"
   },

package.json

@@ -5,7 +5,6 @@
 1. Install it with `npm i @js-entity-repos/knex`.
 1. For each entity you will need to do the following.
     1. [Create an 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,27 +19,27 @@ export interface TodoEntity extends Entity {
 }
 ```
 
-### Factory Config
+### Construct the Facade
 
 ```ts
-import FactoryConfig from '@js-entity-repos/knex/dist/FactoryConfig';
+import factory from '@js-entity-repos/knex/dist/factory';
 import connectToDb from '@js-entity-repos/knex/dist/utils/connectToDb';
 
-const todoFactoryConfig: FactoryConfig<TodoEntity> = {
+const todosFacade = factory<TodoEntity>({
+  // Optional property to convert an entity to a DB document. Defaults to the function below.
   constructDocument: (patch) => {
-    // Optional property that converts an entity to a document for the database.
     return patch;
   },
+  // Optional property to convert a DB document to an entity. Defaults to the function below.
   constructEntity: (document) => {
-    // Optional property that converts a document from the database to an entity.
     return document;
   },
+  // Optional property to convert an entity filter to a DB filter. Defaults to the function below.
   constructFilter: (filter) => {
-    // Optional property that converts an entity filter to a filter for the DB.
     return filter;
   },
+  // Optional property to convert an entity sort to a DB sort. Defaults to the function below.
   constructSort: (sort) => {
-    // Optional property that converts an entity sort to a sort for the DB.
     return sort;
   }.
   db: connectToDb({
@@ -52,16 +51,10 @@ const todoFactoryConfig: FactoryConfig<TodoEntity> = {
       user: 'todouser',
     },
   }),
-  defaultPaginationLimit: 100, // Optional property.
+  // Optional property. Defaults to 10.
+  defaultPaginationLimit: 10,
   entityName: 'todo',
+  // Optional property. Defaults to the entityName.
   tableName: 'todos',
-};
-```
-
-### Construct the Facade
-
-```ts
-import factory from '@js-entity-repos/knex/dist/factory';
-
-const todosFacade = factory(todoFactoryConfig);
+});
 ```

readme.md

@@ -13,5 +13,5 @@ export default interface FacadeConfig<E extends Entity> {
   readonly db: () => Promise<knex>;
   readonly defaultPaginationLimit?: number;
   readonly entityName: string;
-  readonly tableName: string;
+  readonly tableName?: string;
 }

src/FactoryConfig.ts

@@ -17,7 +17,8 @@ export default <E extends Entity>(factoryConfig: FactoryConfig<E>): Facade<E> =>
     constructEntity: (document) => document,
     constructFilter: (filter) => filter,
     constructSort: (sort) => sort,
-    defaultPaginationLimit: 100,
+    defaultPaginationLimit: 10,
+    tableName: factoryConfig.entityName,
     ...factoryConfig,
   };
   return {

src/factory.ts

@@ -1,6 +1,9 @@
 import GetEntities from '@js-entity-repos/core/dist/signatures/GetEntities';
 import Entity from '@js-entity-repos/core/dist/types/Entity';
+import Pagination from '@js-entity-repos/core/dist/types/Pagination';
+import { forward } from '@js-entity-repos/core/dist/types/PaginationDirection';
 import Sort from '@js-entity-repos/core/dist/types/Sort';
+import SortOrder, { 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, mapValues } from 'lodash';
@@ -12,21 +15,21 @@ const xor = (conditionA: boolean, conditionB: boolean) => {
 };
 
 export default <E extends Entity>(config: FacadeConfig<E>): GetEntities<E> => {
-  const defaultPagination = {
+  const defaultPagination: Pagination = {
     cursor: undefined,
-    forward: true,
+    direction: forward,
     limit: config.defaultPaginationLimit,
   };
-  const defaultSort = { id: true } as Sort<E>;
+  const defaultSort = { id: asc } as Sort<E>;
   return async ({ filter = {}, sort = defaultSort, pagination = defaultPagination }) => {
     const table = (await config.db()).table(config.tableName);
 
     const paginationFilter = createPaginationFilter(pagination, sort);
     const fullFilter = { $and: [filter, paginationFilter] };
     const constructedFilter = config.constructFilter(fullFilter);
     const constructedSort = config.constructSort(sort);
-    const knexSort = mapValues(constructedSort, (sortValue): string => {
-      return !xor(pagination.forward, sortValue) ? 'asc' : 'desc';
+    const knexSort = mapValues(constructedSort, (sortOrder: SortOrder): string => {
+      return !xor(pagination.direction === forward, sortOrder === asc) ? 'asc' : 'desc';
     });
 
     const filterQuery = filterEntities(table, constructedFilter);