fix: changed pagination for enveloped response

Author: mariocoski

README.md

@@ -15,12 +15,10 @@ The main differences to the @js-entity-repos/express:
 
 - different naming convention: using `item` instead of `entity`
 - cursor based pagination operates using `before` and `after` instead of `cursor` and `direction`
-- optional `enveloping` response (`GET /endpoint?envelope=true`) for clients not capable of working with headers and JSONP
 - `granular transactions handlers` for each `request handler` - this could be used for i.e. `authentication` or `permissions` checks
 - possibility to `override` each `request handler`
 - ability to disable json body parser middleware if already present in the stack (`enableJsonBodyParser: false`)
 - by default all responses are `pretty` which improves readability, you can disable that by query param (`/endpoint?pretty=false`)
-- dropped support for `/count` endpoint, instead allows client to get number of available items by adding query param (`/endpoint?total=true` for get request, resulting in additional header: `x-total-count` which name is configurable)
 
 ## Installation:
 

assets/jscpd-badge.svg

@@ -8,10 +8,16 @@ import TransactionHandler from './types/TransactionHandler';
 export default interface FacadeConfig<I extends Item> {
     readonly dataKeyName: string;
     readonly totalHeaderName: string;
-    readonly beforeHeaderName: string;
     readonly hasAfterHeaderName: string;
-    readonly hasBeforeHeaderName: string;
     readonly afterHeaderName: string;
+    readonly hasBeforeHeaderName: string;
+    readonly beforeHeaderName: string;
+    readonly paginationKey: string;
+    readonly afterKey: string;
+    readonly beforeKey: string;
+    readonly hasBeforeKey: string;
+    readonly hasAfterKey: string;
+    readonly totalKey: string;
     readonly envelopeParamName: string;
     readonly prettyParamName: string;
     readonly createFilter: CreateFilter<I>;

dist/FacadeConfig.d.ts

@@ -14,6 +14,12 @@ export default interface FactoryConfig<I extends Item> {
     readonly afterHeaderName?: string;
     readonly hasBeforeHeaderName?: string;
     readonly beforeHeaderName?: string;
+    readonly afterKey?: string;
+    readonly beforeKey?: string;
+    readonly hasBeforeKey?: string;
+    readonly hasAfterKey?: string;
+    readonly totalKey?: string;
+    readonly paginationKey?: string;
     readonly envelopParamName?: string;
     readonly prettyParamName?: string;
     readonly createFilter?: CreateFilter<I>;

dist/FactoryConfig.d.ts

@@ -1,5 +1,5 @@
 import { Item } from '@js-items/foundation';
 import { Router } from 'express';
 import FactoryConfig from './FactoryConfig';
-declare const _default: <I extends Item>({ deleteItem, deleteItems, getItem, getItems, updateItem, replaceItem, createItem, totalHeaderName, hasAfterHeaderName, afterHeaderName, hasBeforeHeaderName, beforeHeaderName, envelopParamName, prettyParamName, dataKeyName, ...config }: FactoryConfig<I>) => Router;
+declare const _default: <I extends Item>({ deleteItem, deleteItems, getItem, getItems, updateItem, replaceItem, createItem, totalHeaderName, hasAfterHeaderName, afterHeaderName, hasBeforeHeaderName, beforeHeaderName, afterKey, beforeKey, hasBeforeKey, hasAfterKey, totalKey, paginationKey, envelopParamName, prettyParamName, dataKeyName, ...config }: FactoryConfig<I>) => Router;
 export default _default;