nestjs-paginate 11.0.2 → 11.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -3
- package/lib/__tests__/cat-hair.entity.js +1 -1
- package/lib/__tests__/cat-hair.entity.js.map +1 -1
- package/lib/__tests__/cat.entity.d.ts +1 -1
- package/lib/__tests__/cat.entity.js +1 -1
- package/lib/__tests__/cat.entity.js.map +1 -1
- package/lib/decorator.d.ts +3 -0
- package/lib/decorator.js +3 -0
- package/lib/decorator.js.map +1 -1
- package/lib/decorator.spec.js +18 -0
- package/lib/decorator.spec.js.map +1 -1
- package/lib/helper.js +3 -3
- package/lib/helper.js.map +1 -1
- package/lib/paginate.d.ts +9 -4
- package/lib/paginate.js +99 -16
- package/lib/paginate.js.map +1 -1
- package/lib/paginate.spec.js +231 -1
- package/lib/paginate.spec.js.map +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -17,6 +17,7 @@ Pagination and filtering helper method for TypeORM repositories or query builder
|
|
|
17
17
|
- Filter using operators (`$eq`, `$not`, `$null`, `$in`, `$gt`, `$gte`, `$lt`, `$lte`, `$btw`, `$ilike`, `$sw`, `$contains`)
|
|
18
18
|
- Include relations and nested relations
|
|
19
19
|
- Virtual column support
|
|
20
|
+
- Cursor-based pagination
|
|
20
21
|
|
|
21
22
|
## Installation
|
|
22
23
|
|
|
@@ -93,6 +94,61 @@ http://localhost:3000/cats?limit=5&page=2&sortBy=color:DESC&search=i&filter.age=
|
|
|
93
94
|
}
|
|
94
95
|
```
|
|
95
96
|
|
|
97
|
+
### Example (Cursor-based Pagination)
|
|
98
|
+
|
|
99
|
+
The following code exposes a route using cursor-based pagination:
|
|
100
|
+
|
|
101
|
+
#### Endpoint
|
|
102
|
+
|
|
103
|
+
```url
|
|
104
|
+
http://localhost:3000/cats?limit=5&cursor=2022-12-20T10:00:00.000Z&cursorColumn=lastVetVisit&cursorDirection=after
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
#### Result
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"data": [
|
|
112
|
+
{
|
|
113
|
+
"id": 3,
|
|
114
|
+
"name": "Shadow",
|
|
115
|
+
"lastVetVisit": "2022-12-21T10:00:00.000Z"
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"id": 4,
|
|
119
|
+
"name": "Luna",
|
|
120
|
+
"lastVetVisit": "2022-12-22T10:00:00.000Z"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"id": 5,
|
|
124
|
+
"name": "Pepper",
|
|
125
|
+
"lastVetVisit": "2022-12-23T10:00:00.000Z"
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"id": 6,
|
|
129
|
+
"name": "Simba",
|
|
130
|
+
"lastVetVisit": "2022-12-24T10:00:00.000Z"
|
|
131
|
+
},
|
|
132
|
+
{
|
|
133
|
+
"id": 7,
|
|
134
|
+
"name": "Tiger",
|
|
135
|
+
"lastVetVisit": "2022-12-25T10:00:00.000Z"
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"meta": {
|
|
139
|
+
"itemsPerPage": 5,
|
|
140
|
+
"cursor": "2022-12-20T10:00:00.000Z",
|
|
141
|
+
"firstCursor": "2022-12-21T10:00:00.000Z",
|
|
142
|
+
"lastCursor": "2022-12-25T10:00:00.000Z"
|
|
143
|
+
},
|
|
144
|
+
"links": {
|
|
145
|
+
"previous": "http://localhost:3000/cats?limit=5&sortBy=lastVetVisit:ASC&cursor=2022-12-21T10:00:00.000Z&cursorColumn=lastVetVisit&cursorDirection=before",
|
|
146
|
+
"current": "http://localhost:3000/cats?limit=5&sortBy=lastVetVisit:ASC&cursor=2022-12-20T10:00:00.000Z&cursorColumn=lastVetVisit&cursorDirection=after",
|
|
147
|
+
"next": "http://localhost:3000/cats?limit=5&sortBy=lastVetVisit:ASC&cursor=2022-12-25T10:00:00.000Z&cursorColumn=lastVetVisit&cursorDirection=after"
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
96
152
|
#### Code
|
|
97
153
|
|
|
98
154
|
```ts
|
|
@@ -232,6 +288,17 @@ const paginateConfig: PaginateConfig<CatEntity> {
|
|
|
232
288
|
*/
|
|
233
289
|
filterableColumns: { age: [FilterOperator.EQ, FilterOperator.IN] },
|
|
234
290
|
|
|
291
|
+
/**
|
|
292
|
+
* Required: false
|
|
293
|
+
* Type: (keyof CatEntity)[]
|
|
294
|
+
* Default: None
|
|
295
|
+
* Description: Columns that can be used as cursors for cursor-based pagination.
|
|
296
|
+
* Typically used with date or unique & sequential columns like 'lastVetVisit' or 'id'.
|
|
297
|
+
* If `cursorColumn` is not provided in the query, the first column in this array is used as the default.
|
|
298
|
+
* If `cursorDirection` is not provided in the query, 'before' is used as the default direction.
|
|
299
|
+
*/
|
|
300
|
+
cursorableColumns: ['lastVetVisit'],
|
|
301
|
+
|
|
235
302
|
/**
|
|
236
303
|
* Required: false
|
|
237
304
|
* Type: RelationColumn<CatEntity>
|
|
@@ -259,8 +326,10 @@ const paginateConfig: PaginateConfig<CatEntity> {
|
|
|
259
326
|
/**
|
|
260
327
|
* Required: false
|
|
261
328
|
* Type: string
|
|
262
|
-
* Description: Allow user to choose between limit/offset and take/skip.
|
|
329
|
+
* Description: Allow user to choose between limit/offset and take/skip, or cursor-based pagination.
|
|
263
330
|
* Default: PaginationType.TAKE_AND_SKIP
|
|
331
|
+
* Options: PaginationType.LIMIT_AND_OFFSET, PaginationType.TAKE_AND_SKIP, PaginationType.CURSOR
|
|
332
|
+
* Note: CURSOR requires `cursorableColumns` to be defined.
|
|
264
333
|
*
|
|
265
334
|
* However, using limit/offset can cause problems with relations.
|
|
266
335
|
*/
|
|
@@ -303,7 +372,7 @@ const paginateConfig: PaginateConfig<CatEntity> {
|
|
|
303
372
|
* Default: 'leftJoinAndSelect'
|
|
304
373
|
* Description: Relationships will be joined with either LEFT JOIN or INNER JOIN, and their columns selected. Can be specified per column with `joinMethods` configuration.
|
|
305
374
|
*/
|
|
306
|
-
defaultJoinMethod: 'leftJoinAndSelect'
|
|
375
|
+
defaultJoinMethod: 'leftJoinAndSelect',
|
|
307
376
|
|
|
308
377
|
/**
|
|
309
378
|
* Required: false
|
|
@@ -311,7 +380,7 @@ const paginateConfig: PaginateConfig<CatEntity> {
|
|
|
311
380
|
* Default: false
|
|
312
381
|
* Description: Overrides the join method per relationship.
|
|
313
382
|
*/
|
|
314
|
-
joinMethods: {age: 'innerJoinAndSelect', size: 'leftJoinAndSelect'}
|
|
383
|
+
joinMethods: {age: 'innerJoinAndSelect', size: 'leftJoinAndSelect'},
|
|
315
384
|
|
|
316
385
|
/**
|
|
317
386
|
* Required: false
|
|
@@ -31,7 +31,7 @@ __decorate([
|
|
|
31
31
|
__metadata("design:type", String)
|
|
32
32
|
], CatHairEntity.prototype, "createdAt", void 0);
|
|
33
33
|
__decorate([
|
|
34
|
-
(0, typeorm_1.Column)({ type: '
|
|
34
|
+
(0, typeorm_1.Column)({ type: 'jsonb', nullable: true }),
|
|
35
35
|
__metadata("design:type", Object)
|
|
36
36
|
], CatHairEntity.prototype, "metadata", void 0);
|
|
37
37
|
__decorate([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cat-hair.entity.js","sourceRoot":"","sources":["../../src/__tests__/cat-hair.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAwG;AAGjG,IAAM,aAAa,GAAnB,MAAM,aAAa;CAmBzB,CAAA;AAnBY,sCAAa;AAEtB;IADC,IAAA,gCAAsB,GAAE;;yCACf;AAGV;IADC,IAAA,gBAAM,GAAE;;2CACG;AAGZ;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;6CACrC;AAGhB;IADC,IAAA,0BAAgB,GAAE;;gDACF;AAGjB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,
|
|
1
|
+
{"version":3,"file":"cat-hair.entity.js","sourceRoot":"","sources":["../../src/__tests__/cat-hair.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAwG;AAGjG,IAAM,aAAa,GAAnB,MAAM,aAAa;CAmBzB,CAAA;AAnBY,sCAAa;AAEtB;IADC,IAAA,gCAAsB,GAAE;;yCACf;AAGV;IADC,IAAA,gBAAM,GAAE;;2CACG;AAGZ;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;6CACrC;AAGhB;IADC,IAAA,0BAAgB,GAAE;;gDACF;AAGjB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACb;AAI7B;IAFC,IAAA,kBAAQ,EAAC,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC/E,IAAA,oBAAU,GAAE;8BACF,aAAa;gDAAA;wBAlBf,aAAa;IADzB,IAAA,gBAAM,GAAE;GACI,aAAa,CAmBzB"}
|
|
@@ -11,8 +11,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.CatEntity = exports.CutenessLevel = void 0;
|
|
13
13
|
const typeorm_1 = require("typeorm");
|
|
14
|
-
const cat_toy_entity_1 = require("./cat-toy.entity");
|
|
15
14
|
const cat_home_entity_1 = require("./cat-home.entity");
|
|
15
|
+
const cat_toy_entity_1 = require("./cat-toy.entity");
|
|
16
16
|
const size_embed_1 = require("./size.embed");
|
|
17
17
|
var CutenessLevel;
|
|
18
18
|
(function (CutenessLevel) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cat.entity.js","sourceRoot":"","sources":["../../src/__tests__/cat.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAYgB;AAChB,qDAA+C;AAC/C,
|
|
1
|
+
{"version":3,"file":"cat.entity.js","sourceRoot":"","sources":["../../src/__tests__/cat.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAYgB;AAChB,uDAAiD;AACjD,qDAA+C;AAC/C,6CAAwC;AAExC,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4BAAW,CAAA;IACX,kCAAiB,CAAA;IACjB,8BAAa,CAAA;AACjB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAGM,IAAM,SAAS,GAAf,MAAM,SAAS;IA4CV,SAAS;;QACb,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,EAAE,CAAA,EAAE,CAAC;YAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QACpB,CAAC;IACL,CAAC;CACJ,CAAA;AAjDY,8BAAS;AAElB;IADC,IAAA,gCAAsB,GAAE;;qCACf;AAGV;IADC,IAAA,gBAAM,GAAE;;uCACG;AAGZ;IADC,IAAA,gBAAM,GAAE;;wCACI;AAGb;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sCACT;AAGlB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,yFAAyF;;;gDACvF;AAG5B;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACb,IAAI;+CAAO;AAGzB;IADC,IAAA,gBAAM,EAAC,GAAG,EAAE,CAAC,sBAAS,CAAC;8BAClB,sBAAS;uCAAA;AAKf;IAHC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,6BAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE;QACnD,KAAK,EAAE,IAAI;KACd,CAAC;;uCACkB;AAIpB;IAFC,IAAA,kBAAQ,EAAC,GAAG,EAAE,CAAC,+BAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC3E,IAAA,oBAAU,GAAE;8BACP,+BAAa;uCAAA;AAGnB;IADC,IAAA,0BAAgB,GAAE;;4CACF;AAGjB;IADC,IAAA,0BAAgB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACnB;AAIlB;IAFC,IAAA,oBAAU,EAAC,GAAG,EAAE,CAAC,SAAS,CAAC;IAC3B,IAAA,mBAAS,GAAE;;0CACQ;AAKZ;IAHP,IAAA,mBAAS,GAAE;IACZ,yDAAyD;IACzD,mGAAmG;;;;;0CAKlG;oBAhDQ,SAAS;IADrB,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;GACX,SAAS,CAiDrB"}
|
package/lib/decorator.d.ts
CHANGED
|
@@ -8,6 +8,9 @@ export interface PaginateQuery {
|
|
|
8
8
|
[column: string]: string | string[];
|
|
9
9
|
};
|
|
10
10
|
select?: string[];
|
|
11
|
+
cursor?: string;
|
|
12
|
+
cursorColumn?: string;
|
|
13
|
+
cursorDirection?: 'before' | 'after';
|
|
11
14
|
path: string;
|
|
12
15
|
}
|
|
13
16
|
export declare const Paginate: (...dataOrPipes: unknown[]) => ParameterDecorator;
|
package/lib/decorator.js
CHANGED
|
@@ -72,6 +72,9 @@ exports.Paginate = (0, common_1.createParamDecorator)((_data, ctx) => {
|
|
|
72
72
|
searchBy,
|
|
73
73
|
filter: Object.keys(filter).length ? filter : undefined,
|
|
74
74
|
select,
|
|
75
|
+
cursor: query.cursor ? query.cursor.toString() : undefined,
|
|
76
|
+
cursorColumn: query.cursorColumn ? query.cursorColumn.toString() : undefined,
|
|
77
|
+
cursorDirection: query.cursorDirection === 'after' || query.cursorDirection === 'before' ? query.cursorDirection : undefined,
|
|
75
78
|
path,
|
|
76
79
|
};
|
|
77
80
|
});
|
package/lib/decorator.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAGvE,mCAA8D;AAE9D,SAAS,QAAQ,CAAC,IAAa;IAC3B,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAA;AACjE,CAAC;
|
|
1
|
+
{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAuE;AAGvE,mCAA8D;AAE9D,SAAS,QAAQ,CAAC,IAAa;IAC3B,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAA;AACjE,CAAC;AAgBD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAElE,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,GAAG,CAAC,IAAI,CAAC,KAAyB,CAAC,CAAA;IACvC,CAAC;AACL,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAE,GAAU,EAAE,EAAE;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;AACzC,CAAC,CAAA;AAED,SAAS,UAAU,CAAI,UAAmB,EAAE,WAAgD;IACxF,MAAM,GAAG,GAAG,EAAE,CAAA;IACd,IAAI,UAAU,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;QACrE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;gBAClB,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC3B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;AACvC,CAAC;AAEY,QAAA,QAAQ,GAAG,IAAA,6BAAoB,EAAC,CAAC,KAAc,EAAE,GAAqB,EAAiB,EAAE;IAClG,IAAI,IAAY,CAAA;IAChB,IAAI,KAA8B,CAAA;IAElC,QAAQ,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QACpB,KAAK,MAAM;YACP,MAAM,OAAO,GAAoC,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAA;YAChF,KAAK,GAAG,OAAO,CAAC,KAAgC,CAAA;YAEhD,6GAA6G;YAC7G,IAAI,WAAmB,CAAA;YACvB,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAA;YACtF,CAAC;iBAAM,CAAC;gBACJ,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAA;YAC3E,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;YACrC,IAAI,GAAG,QAAQ,CAAC,QAAQ,GAAG,IAAI,GAAG,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAA;YACnE,MAAK;QACT,KAAK,IAAI;YACL,KAAK,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,CAAA;YAClC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;QACT,KAAK,KAAK;YACN,KAAK,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,CAAA;YACnC,IAAI,GAAG,IAAI,CAAA;YACX,MAAK;IACb,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAS,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAChE,MAAM,MAAM,GAAG,UAAU,CAAmB,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACxE,MAAM,MAAM,GAAG,UAAU,CAAS,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAEtE,MAAM,MAAM,GAAG,IAAA,gBAAO,EAClB,IAAA,eAAM,EACF,KAAK,EACL,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,CAAC,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAK,KAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAC/D,EAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAChD,CAAA;IAED,OAAO;QACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;QACrE,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,QAAQ;QACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACvD,MAAM;QACN,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC1D,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC5E,eAAe,EACX,KAAK,CAAC,eAAe,KAAK,OAAO,IAAI,KAAK,CAAC,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;QAC/G,IAAI;KACP,CAAA;AACL,CAAC,CAAC,CAAA"}
|
package/lib/decorator.spec.js
CHANGED
|
@@ -108,6 +108,9 @@ describe('Decorator', () => {
|
|
|
108
108
|
searchBy: undefined,
|
|
109
109
|
filter: undefined,
|
|
110
110
|
select: undefined,
|
|
111
|
+
cursor: undefined,
|
|
112
|
+
cursorColumn: undefined,
|
|
113
|
+
cursorDirection: undefined,
|
|
111
114
|
path: 'http://localhost/items',
|
|
112
115
|
});
|
|
113
116
|
});
|
|
@@ -122,6 +125,9 @@ describe('Decorator', () => {
|
|
|
122
125
|
searchBy: undefined,
|
|
123
126
|
filter: undefined,
|
|
124
127
|
select: undefined,
|
|
128
|
+
cursor: undefined,
|
|
129
|
+
cursorColumn: undefined,
|
|
130
|
+
cursorDirection: undefined,
|
|
125
131
|
path: 'http://localhost/items',
|
|
126
132
|
});
|
|
127
133
|
});
|
|
@@ -134,6 +140,9 @@ describe('Decorator', () => {
|
|
|
134
140
|
'filter.name': '$not:$eq:Kitty',
|
|
135
141
|
'filter.createdAt': ['$gte:2020-01-01', '$lte:2020-12-31'],
|
|
136
142
|
select: ['name', 'createdAt'],
|
|
143
|
+
cursor: 'abc123',
|
|
144
|
+
cursorColumn: 'id',
|
|
145
|
+
cursorDirection: 'after',
|
|
137
146
|
});
|
|
138
147
|
const result = decoratorfactory(null, context);
|
|
139
148
|
expect(result).toStrictEqual({
|
|
@@ -151,6 +160,9 @@ describe('Decorator', () => {
|
|
|
151
160
|
name: '$not:$eq:Kitty',
|
|
152
161
|
createdAt: ['$gte:2020-01-01', '$lte:2020-12-31'],
|
|
153
162
|
},
|
|
163
|
+
cursor: 'abc123',
|
|
164
|
+
cursorColumn: 'id',
|
|
165
|
+
cursorDirection: 'after',
|
|
154
166
|
});
|
|
155
167
|
});
|
|
156
168
|
it('should handle fastify defined query fields', () => {
|
|
@@ -162,6 +174,9 @@ describe('Decorator', () => {
|
|
|
162
174
|
'filter.name': '$not:$eq:Kitty',
|
|
163
175
|
'filter.createdAt': ['$gte:2020-01-01', '$lte:2020-12-31'],
|
|
164
176
|
select: ['name', 'createdAt'],
|
|
177
|
+
cursor: 'abc123',
|
|
178
|
+
cursorColumn: 'id',
|
|
179
|
+
cursorDirection: 'after',
|
|
165
180
|
});
|
|
166
181
|
const result = decoratorfactory(null, context);
|
|
167
182
|
expect(result).toStrictEqual({
|
|
@@ -179,6 +194,9 @@ describe('Decorator', () => {
|
|
|
179
194
|
createdAt: ['$gte:2020-01-01', '$lte:2020-12-31'],
|
|
180
195
|
},
|
|
181
196
|
select: ['name', 'createdAt'],
|
|
197
|
+
cursor: 'abc123',
|
|
198
|
+
cursorColumn: 'id',
|
|
199
|
+
cursorDirection: 'after',
|
|
182
200
|
});
|
|
183
201
|
});
|
|
184
202
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorator.spec.js","sourceRoot":"","sources":["../src/decorator.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAA8D;AAW9D,2CAAqD;AAErD,wDAAwD;AACxD,SAAS,wBAAwB,CAAI,SAAmB;IACpD,MAAM,IAAI;QACC,IAAI,CAAc,MAAS;YAC9B,EAAE;QACN,CAAC;KACJ;IAHU;QAAM,WAAA,SAAS,EAAE,CAAA;;;;oCAEvB;IAEL,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,+BAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACnE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7C,CAAC;AACD,MAAM,gBAAgB,GAAG,wBAAwB,CAAgB,oBAAQ,CAAC,CAAA;AAE1E,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW;gBACtB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,WAAW;gBACrB,GAAG,EAAE,oBAAoB;gBACzB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"decorator.spec.js","sourceRoot":"","sources":["../src/decorator.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAA8D;AAW9D,2CAAqD;AAErD,wDAAwD;AACxD,SAAS,wBAAwB,CAAI,SAAmB;IACpD,MAAM,IAAI;QACC,IAAI,CAAc,MAAS;YAC9B,EAAE;QACN,CAAC;KACJ;IAHU;QAAM,WAAA,SAAS,EAAE,CAAA;;;;oCAEvB;IAEL,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,+BAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACnE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;AAC7C,CAAC;AACD,MAAM,gBAAgB,GAAG,wBAAwB,CAAgB,oBAAQ,CAAC,CAAA;AAE1E,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW;gBACtB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B;IACzD,MAAM,WAAW,GAAqB;QAClC,OAAO,EAAE,GAAgB,EAAE,CAAC,MAAqB;QACjD,YAAY,EAAE,GAAsB,EAAE,CAClC,MAAM,CAAC;YACH,UAAU,EAAE,GAA4B,EAAE,CACtC,MAAM,CAAC;gBACH,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,WAAW;gBACrB,GAAG,EAAE,oBAAoB;gBACzB,WAAW,EAAE,oBAAoB;gBACjC,KAAK,EAAE,KAAK;aACf,CAAC;SACT,CAAC;QACN,QAAQ,EAAE,GAAqB,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAiB,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,EAAE,GAAoC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,aAAa,EAAE,GAAe,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,GAAqB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAChD,CAAC;KACJ,CAAA;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,YAAY,EAAE,SAAS;YACvB,eAAe,EAAE,SAAS;YAC1B,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,SAAS;YACjB,YAAY,EAAE,SAAS;YACvB,eAAe,EAAE,SAAS;YAC1B,IAAI,EAAE,wBAAwB;SACjC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,OAAO;SAC3B,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,OAAO;SAC3B,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,qBAAqB,CAAC;YAClC,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,MAAM,EAAE,OAAO;YACf,aAAa,EAAE,gBAAgB;YAC/B,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC1D,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,OAAO;SAC3B,CAAC,CAAA;QAEF,MAAM,MAAM,GAAkB,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,EAAE;YACT,MAAM,EAAE;gBACJ,CAAC,IAAI,EAAE,KAAK,CAAC;gBACb,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB;YACD,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;aACpD;YACD,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC7B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,OAAO;SAC3B,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}
|
package/lib/helper.js
CHANGED
|
@@ -18,9 +18,9 @@ exports.isRepository = isRepository;
|
|
|
18
18
|
exports.isFindOperator = isFindOperator;
|
|
19
19
|
exports.createRelationSchema = createRelationSchema;
|
|
20
20
|
exports.mergeRelationSchema = mergeRelationSchema;
|
|
21
|
+
const lodash_1 = require("lodash");
|
|
21
22
|
const typeorm_1 = require("typeorm");
|
|
22
23
|
const OrmUtils_1 = require("typeorm/util/OrmUtils");
|
|
23
|
-
const lodash_1 = require("lodash");
|
|
24
24
|
function isEntityKey(entityColumns, column) {
|
|
25
25
|
return !!entityColumns.find((c) => c === column);
|
|
26
26
|
}
|
|
@@ -111,9 +111,9 @@ function checkIsJsonb(qb, propertyName) {
|
|
|
111
111
|
if (propertyName.includes('.')) {
|
|
112
112
|
const parts = propertyName.split('.');
|
|
113
113
|
const dbColumnName = parts[parts.length - 2];
|
|
114
|
-
return ((_c = (_b = (_a = qb === null || qb === void 0 ? void 0 : qb.expressionMap) === null || _a === void 0 ? void 0 : _a.mainAlias) === null || _b === void 0 ? void 0 : _b.metadata.findColumnWithPropertyName(dbColumnName)) === null || _c === void 0 ? void 0 : _c.type) === '
|
|
114
|
+
return ((_c = (_b = (_a = qb === null || qb === void 0 ? void 0 : qb.expressionMap) === null || _a === void 0 ? void 0 : _a.mainAlias) === null || _b === void 0 ? void 0 : _b.metadata.findColumnWithPropertyName(dbColumnName)) === null || _c === void 0 ? void 0 : _c.type) === 'jsonb';
|
|
115
115
|
}
|
|
116
|
-
return ((_f = (_e = (_d = qb === null || qb === void 0 ? void 0 : qb.expressionMap) === null || _d === void 0 ? void 0 : _d.mainAlias) === null || _e === void 0 ? void 0 : _e.metadata.findColumnWithPropertyName(propertyName)) === null || _f === void 0 ? void 0 : _f.type) === '
|
|
116
|
+
return ((_f = (_e = (_d = qb === null || qb === void 0 ? void 0 : qb.expressionMap) === null || _d === void 0 ? void 0 : _d.mainAlias) === null || _e === void 0 ? void 0 : _e.metadata.findColumnWithPropertyName(propertyName)) === null || _f === void 0 ? void 0 : _f.type) === 'jsonb';
|
|
117
117
|
}
|
|
118
118
|
// This function is used to fix the column alias when using relation, embedded or virtual properties
|
|
119
119
|
function fixColumnAlias(properties, alias, isRelation = false, isVirtualProperty = false, isEmbedded = false, query) {
|
package/lib/helper.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helper.js","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":";;;AAiGA,kCAEC;AAOD,8DAsBC;AAED,wDAcC;AAED,oEAOC;AAED,8DAQC;AAED,0CAKC;AAED,sDAUC;AAED,0CAKC;AAED,oCAKC;AAED,oCAaC;AAGD,wCAkCC;AAED,sDAYC;AAMD,8BAEC;AAED,oCAQC;AAED,wCAQC;AAED,oDAIC;AAED,kDAGC;AA7SD,qCAMgB;AAEhB,oDAAgD;
|
|
1
|
+
{"version":3,"file":"helper.js","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":";;;AAiGA,kCAEC;AAOD,8DAsBC;AAED,wDAcC;AAED,oEAOC;AAED,8DAQC;AAED,0CAKC;AAED,sDAUC;AAED,0CAKC;AAED,oCAKC;AAED,oCAaC;AAGD,wCAkCC;AAED,sDAYC;AAMD,8BAEC;AAED,oCAQC;AAED,wCAQC;AAED,oDAIC;AAED,kDAGC;AA7SD,mCAAkC;AAClC,qCAMgB;AAEhB,oDAAgD;AAwFhD,SAAgB,WAAW,CAAI,aAA0B,EAAE,MAAc;IACrE,OAAO,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAA;AACpD,CAAC;AAEM,MAAM,uBAAuB,GAAG,CAAC,KAAyB,EAAE,YAAoB,EAAE,WAAkB,CAAC,EAAE,EAAE,CAC5G,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAA;AADrD,QAAA,uBAAuB,2BAC8B;AAIlE,SAAgB,yBAAyB,CAAC,MAAc;IACpD,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACtC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC9C,IAAI,QAAQ,GAAG,KAAK,EAChB,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAE7C,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,QAAQ,GAAG,IAAI,CAAA;QACnB,CAAC;QAED,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QAE7D,OAAO;YACH,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;YAC7B,YAAY,EAAE,4CAA4C;YAC1D,QAAQ;YACR,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,EAAE;SAC/C,CAAA;IACL,CAAC;SAAM,CAAC;QACJ,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAA;IACtF,CAAC;AACL,CAAC;AAED,SAAgB,sBAAsB,CAClC,EAA+B,EAC/B,gBAAkC;;IAElC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,YAAY;QAC1C,CAAC,CAAC,MAAA,MAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,0CAAE,0BAA0B,CAAC,gBAAgB,CAAC,YAAY,CAAC,0CAC3F,gBAAgB,0CAAE,cAAc,CAAC,cAAc;QACvD,CAAC,CAAC,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,CAAA;IAC5C,OAAO,CACH,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,gBAAgB,CAAC,YAAY,CAAC,KAAI;QAC1F,iBAAiB,EAAE,KAAK;QACxB,KAAK,EAAE,SAAS;KACnB,CACJ,CAAA;AACL,CAAC;AAED,SAAgB,4BAA4B,CAAC,EAA+B,EAAE,YAAsB;;IAChG,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,OAAO,MAAA,MAAA,EAAE,CAAC,aAAa,CAAC,SAAS,0CAAE,QAAQ,0CAAE,cAAc,CACtD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,EACnC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACzD,CAAC;AAED,SAAgB,yBAAyB,CACrC,EAA+B,EAC/B,gBAAkC;;IAElC,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,CAAA,MAAA,MAAA,EAAE,CAAC,aAAa,CAAC,SAAS,0CAAE,QAAQ,0CAAE,yBAAyB,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAA,CAAA;AAC3G,CAAC;AAED,SAAgB,eAAe,CAAC,EAA+B,EAAE,YAAoB;;IACjF,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,CAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,0CAAE,2BAA2B,CAAC,YAAY,CAAC,CAAA,CAAA;AAC9F,CAAC;AAED,SAAgB,qBAAqB,CAAC,EAA+B,EAAE,YAAoB;;IACvF,IAAI,QAAQ,GAAG,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,CAAA;IACrD,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,KAAK,YAAY,CAAC,CAAA;QAC/F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,QAAQ,GAAG,QAAQ,CAAC,qBAAqB,CAAA;IAC7C,CAAC;IACD,OAAO,IAAI,CAAA;AACf,CAAC;AAED,SAAgB,eAAe,CAAC,EAA+B,EAAE,YAAoB;;IACjF,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,CAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,0CAAE,2BAA2B,CAAC,YAAY,CAAC,CAAA,CAAA;AAC9F,CAAC;AAED,SAAgB,YAAY,CAAC,EAA+B,EAAE,YAAoB;;IAC9E,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,CAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,CAAC,0BAA0B,CAAC,YAAY,CAAC,0CAAE,OAAO,CAAA,CAAA;AACrG,CAAC;AAED,SAAgB,YAAY,CAAC,EAA+B,EAAE,YAAoB;;IAC9E,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5C,OAAO,CAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,CAAC,0BAA0B,CAAC,YAAY,CAAC,0CAAE,IAAI,MAAK,OAAO,CAAA;IAC5G,CAAC;IAED,OAAO,CAAA,MAAA,MAAA,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,aAAa,0CAAE,SAAS,0CAAE,QAAQ,CAAC,0BAA0B,CAAC,YAAY,CAAC,0CAAE,IAAI,MAAK,OAAO,CAAA;AAC5G,CAAC;AAED,oGAAoG;AACpG,SAAgB,cAAc,CAC1B,UAA4B,EAC5B,KAAa,EACb,UAAU,GAAG,KAAK,EAClB,iBAAiB,GAAG,KAAK,EACzB,UAAU,GAAG,KAAK,EAClB,KAA+B;IAE/B,IAAI,UAAU,EAAE,CAAC;QACb,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;YAC7B,OAAO,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,MAAM,CAAC,GAAG,CAAA,CAAC,2CAA2C;QAC9G,CAAC;aAAM,IAAI,CAAC,iBAAiB,IAAI,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC9D,IAAI,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxC,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACvD,MAAM,eAAe,GAAG,YAAY;qBAC/B,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;qBACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;qBACtB,IAAI,CAAC,GAAG,CAAC,CAAA;gBACd,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;gBAEvD,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,QAAQ,eAAe,IAAI,SAAS,EAAE,CAAA;YACpF,CAAC;iBAAM,CAAC;gBACJ,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,QAAQ,UAAU,CAAC,YAAY,EAAE,CAAA;YAC/E,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,QAAQ,UAAU,CAAC,YAAY,EAAE,CAAA;QAC/E,CAAC;IACL,CAAC;SAAM,IAAI,iBAAiB,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,EAAE,CAAA;IACnF,CAAC;SAAM,IAAI,UAAU,EAAE,CAAC;QACpB,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,IAAI,UAAU,CAAC,YAAY,EAAE,CAAA;IAC3E,CAAC;SAAM,CAAC;QACJ,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,YAAY,EAAE,CAAA;IAChD,CAAC;AACL,CAAC;AAED,SAAgB,qBAAqB,CAAC,IAAY;IAC9C,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAA;IAC7C,IAAI,WAAW,GAAG,EAAE,CAAA;IACpB,IAAI,SAAS,GAAG,EAAE,CAAA;IAClB,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;QACzB,WAAW,GAAG,GAAG,CAAC,MAAM,CAAA;QACxB,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAA;IAC5B,CAAC;SAAM,CAAC;QACJ,SAAS,GAAG,IAAI,CAAA;IACpB,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,CAAA;AACrC,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,MAAM,CAC5B,gNAAgN,CACnN,CAAA;AAED,SAAgB,SAAS,CAAC,GAAW;IACjC,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAClC,CAAC;AAED,SAAgB,YAAY,CAAI,IAA6B;IACzD,IAAI,IAAI,YAAY,oBAAU;QAAE,OAAO,IAAI,CAAA;IAC3C,IAAI,CAAC;QACD,IAAI,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO,IAAI,CAAA;QAC9E,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,SAAS,IAAI,IAAI,CAAA;IACnF,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC;AAED,SAAgB,cAAc,CAAI,KAAgC;IAC9D,IAAI,KAAK,YAAY,sBAAY;QAAE,OAAO,IAAI,CAAA;IAC9C,IAAI,CAAC;QACD,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,KAAK,cAAc;YAAE,OAAO,IAAI,CAAA;QACjF,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAA;IAC7E,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC;AAED,SAAgB,oBAAoB,CAAI,sBAA8C;IAClF,OAAO,KAAK,CAAC,OAAO,CAAC,sBAAsB,CAAC;QACxC,CAAC,CAAC,mBAAQ,CAAC,2BAA2B,CAAC,sBAAsB,CAAC;QAC9D,CAAC,CAAE,sBAA4C,CAAA;AACvD,CAAC;AAED,SAAgB,mBAAmB,CAAC,GAAG,OAAyB;IAC5D,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAChG,OAAO,IAAA,kBAAS,EAAC,EAAE,EAAE,GAAG,OAAO,EAAE,cAAc,CAAC,CAAA;AACpD,CAAC"}
|
package/lib/paginate.d.ts
CHANGED
|
@@ -7,9 +7,9 @@ export declare class Paginated<T> {
|
|
|
7
7
|
data: T[];
|
|
8
8
|
meta: {
|
|
9
9
|
itemsPerPage: number;
|
|
10
|
-
totalItems
|
|
11
|
-
currentPage
|
|
12
|
-
totalPages
|
|
10
|
+
totalItems?: number;
|
|
11
|
+
currentPage?: number;
|
|
12
|
+
totalPages?: number;
|
|
13
13
|
sortBy: SortBy<T>;
|
|
14
14
|
searchBy: Column<T>[];
|
|
15
15
|
search: string;
|
|
@@ -17,6 +17,9 @@ export declare class Paginated<T> {
|
|
|
17
17
|
filter?: {
|
|
18
18
|
[column: string]: string | string[];
|
|
19
19
|
};
|
|
20
|
+
cursor?: string;
|
|
21
|
+
firstCursor?: string;
|
|
22
|
+
lastCursor?: string;
|
|
20
23
|
};
|
|
21
24
|
links: {
|
|
22
25
|
first?: string;
|
|
@@ -28,7 +31,8 @@ export declare class Paginated<T> {
|
|
|
28
31
|
}
|
|
29
32
|
export declare enum PaginationType {
|
|
30
33
|
LIMIT_AND_OFFSET = "limit",
|
|
31
|
-
TAKE_AND_SKIP = "take"
|
|
34
|
+
TAKE_AND_SKIP = "take",
|
|
35
|
+
CURSOR = "cursor"
|
|
32
36
|
}
|
|
33
37
|
export interface PaginateConfig<T> {
|
|
34
38
|
relations?: RelationSchemaInput<T>;
|
|
@@ -51,6 +55,7 @@ export interface PaginateConfig<T> {
|
|
|
51
55
|
multiWordSearch?: boolean;
|
|
52
56
|
defaultJoinMethod?: JoinMethod;
|
|
53
57
|
joinMethods?: Partial<MappedColumns<T, JoinMethod>>;
|
|
58
|
+
cursorableColumns?: Column<T>[];
|
|
54
59
|
}
|
|
55
60
|
export declare enum PaginationLimit {
|
|
56
61
|
NO_PAGINATION = -1,
|
package/lib/paginate.js
CHANGED
|
@@ -19,6 +19,7 @@ var PaginationType;
|
|
|
19
19
|
(function (PaginationType) {
|
|
20
20
|
PaginationType["LIMIT_AND_OFFSET"] = "limit";
|
|
21
21
|
PaginationType["TAKE_AND_SKIP"] = "take";
|
|
22
|
+
PaginationType["CURSOR"] = "cursor";
|
|
22
23
|
})(PaginationType || (exports.PaginationType = PaginationType = {}));
|
|
23
24
|
var PaginationLimit;
|
|
24
25
|
(function (PaginationLimit) {
|
|
@@ -80,8 +81,14 @@ function flattenWhereAndTransform(queryBuilder, obj, separator = '.', parentKey
|
|
|
80
81
|
}
|
|
81
82
|
});
|
|
82
83
|
}
|
|
84
|
+
function fixCursorValue(value) {
|
|
85
|
+
if ((0, helper_1.isISODate)(value)) {
|
|
86
|
+
return new Date(value);
|
|
87
|
+
}
|
|
88
|
+
return value;
|
|
89
|
+
}
|
|
83
90
|
async function paginate(query, repo, config) {
|
|
84
|
-
var _a, _b, _c;
|
|
91
|
+
var _a, _b, _c, _d;
|
|
85
92
|
const page = (0, helper_1.positiveNumberOrDefault)(query.page, 1, 1);
|
|
86
93
|
const defaultLimit = config.defaultLimit || PaginationLimit.DEFAULT_LIMIT;
|
|
87
94
|
const maxLimit = config.maxLimit || PaginationLimit.DEFAULT_MAX_LIMIT;
|
|
@@ -99,14 +106,33 @@ async function paginate(query, repo, config) {
|
|
|
99
106
|
const sortBy = [];
|
|
100
107
|
const searchBy = [];
|
|
101
108
|
let [items, totalItems] = [[], 0];
|
|
109
|
+
let cursorColumn;
|
|
110
|
+
let cursorDirection;
|
|
102
111
|
const queryBuilder = (0, helper_1.isRepository)(repo) ? repo.createQueryBuilder('__root') : repo;
|
|
103
112
|
if ((0, helper_1.isRepository)(repo) && !config.relations && config.loadEagerRelations === true) {
|
|
104
113
|
if (!config.relations) {
|
|
105
114
|
typeorm_1.FindOptionsUtils.joinEagerRelations(queryBuilder, queryBuilder.alias, repo.metadata);
|
|
106
115
|
}
|
|
107
116
|
}
|
|
117
|
+
if (config.paginationType === PaginationType.CURSOR) {
|
|
118
|
+
const formatMessage = (msg) => {
|
|
119
|
+
logger.debug(msg);
|
|
120
|
+
throw new common_1.ServiceUnavailableException(msg);
|
|
121
|
+
};
|
|
122
|
+
if (!((_c = config.cursorableColumns) === null || _c === void 0 ? void 0 : _c.length)) {
|
|
123
|
+
formatMessage("Missing required 'cursorableColumns' config.");
|
|
124
|
+
}
|
|
125
|
+
cursorColumn = query.cursorColumn || config.cursorableColumns[0];
|
|
126
|
+
cursorDirection = query.cursorDirection || 'before';
|
|
127
|
+
if (!(0, helper_1.isEntityKey)(config.cursorableColumns, cursorColumn)) {
|
|
128
|
+
formatMessage(`Invalid cursorColumn '${cursorColumn}'. It must be one of: ${config.cursorableColumns.join(', ')}.`);
|
|
129
|
+
}
|
|
130
|
+
if (!['before', 'after'].includes(cursorDirection)) {
|
|
131
|
+
formatMessage(`Invalid cursorDirection '${cursorDirection}'. It must be 'before' or 'after'.`);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
108
134
|
if (isPaginated) {
|
|
109
|
-
// Allow user to choose between limit/offset and take/skip.
|
|
135
|
+
// Allow user to choose between limit/offset and take/skip, or cursor-based pagination.
|
|
110
136
|
// However, using limit/offset can cause problems when joining one-to-many etc.
|
|
111
137
|
if (config.paginationType === PaginationType.LIMIT_AND_OFFSET) {
|
|
112
138
|
queryBuilder.limit(limit).offset((page - 1) * limit);
|
|
@@ -114,6 +140,15 @@ async function paginate(query, repo, config) {
|
|
|
114
140
|
else {
|
|
115
141
|
queryBuilder.take(limit).skip((page - 1) * limit);
|
|
116
142
|
}
|
|
143
|
+
if (config.paginationType === PaginationType.CURSOR && query.cursor) {
|
|
144
|
+
{
|
|
145
|
+
const columnProperties = (0, helper_1.getPropertiesByColumnName)(cursorColumn);
|
|
146
|
+
const alias = (0, helper_1.fixColumnAlias)(columnProperties, queryBuilder.alias);
|
|
147
|
+
const operator = cursorDirection === 'before' ? '<' : '>';
|
|
148
|
+
const cursorValue = fixCursorValue(query.cursor);
|
|
149
|
+
queryBuilder.andWhere(`${alias} ${operator} :cursor`, { cursor: cursorValue });
|
|
150
|
+
}
|
|
151
|
+
}
|
|
117
152
|
}
|
|
118
153
|
if (config.withDeleted) {
|
|
119
154
|
queryBuilder.withDeleted();
|
|
@@ -146,6 +181,10 @@ async function paginate(query, repo, config) {
|
|
|
146
181
|
logger.debug(message);
|
|
147
182
|
throw new common_1.ServiceUnavailableException(message);
|
|
148
183
|
}
|
|
184
|
+
// If paginationType is cursor, add the cursor column and direction before adding other query.sortBy.
|
|
185
|
+
if (config.paginationType === PaginationType.CURSOR) {
|
|
186
|
+
sortBy.push([cursorColumn, cursorDirection === 'before' ? 'DESC' : 'ASC']);
|
|
187
|
+
}
|
|
149
188
|
if (query.sortBy) {
|
|
150
189
|
for (const order of query.sortBy) {
|
|
151
190
|
if ((0, helper_1.isEntityKey)(config.sortableColumns, order[0]) && ['ASC', 'DESC'].includes(order[1])) {
|
|
@@ -266,20 +305,35 @@ async function paginate(query, repo, config) {
|
|
|
266
305
|
if (query.limit === PaginationLimit.COUNTER_ONLY) {
|
|
267
306
|
totalItems = await queryBuilder.getCount();
|
|
268
307
|
}
|
|
269
|
-
else if (isPaginated) {
|
|
308
|
+
else if (isPaginated && config.paginationType !== PaginationType.CURSOR) {
|
|
270
309
|
;
|
|
271
310
|
[items, totalItems] = await queryBuilder.getManyAndCount();
|
|
272
311
|
}
|
|
273
312
|
else {
|
|
274
313
|
items = await queryBuilder.getMany();
|
|
275
314
|
}
|
|
315
|
+
let firstCursor;
|
|
316
|
+
let lastCursor;
|
|
317
|
+
if (config.paginationType === PaginationType.CURSOR && items.length > 0) {
|
|
318
|
+
const cursorValueToString = (value) => {
|
|
319
|
+
if (value === null || value === undefined) {
|
|
320
|
+
return undefined;
|
|
321
|
+
}
|
|
322
|
+
if (value instanceof Date) {
|
|
323
|
+
return value.toISOString();
|
|
324
|
+
}
|
|
325
|
+
return String(value);
|
|
326
|
+
};
|
|
327
|
+
firstCursor = cursorValueToString(items[0][cursorColumn]);
|
|
328
|
+
lastCursor = cursorValueToString(items[items.length - 1][cursorColumn]);
|
|
329
|
+
}
|
|
276
330
|
const sortByQuery = sortBy.map((order) => `&sortBy=${order.join(':')}`).join('');
|
|
277
331
|
const searchQuery = query.search ? `&search=${query.search}` : '';
|
|
278
332
|
const searchByQuery = query.searchBy && searchBy.length && !config.ignoreSearchByInQueryParam
|
|
279
333
|
? searchBy.map((column) => `&searchBy=${column}`).join('')
|
|
280
334
|
: '';
|
|
281
335
|
// Only expose select in meta data if query select differs from config select
|
|
282
|
-
const isQuerySelected = (selectParams === null || selectParams === void 0 ? void 0 : selectParams.length) !== ((
|
|
336
|
+
const isQuerySelected = (selectParams === null || selectParams === void 0 ? void 0 : selectParams.length) !== ((_d = config.select) === null || _d === void 0 ? void 0 : _d.length);
|
|
283
337
|
const selectQuery = isQuerySelected ? `&select=${selectParams.join(',')}` : '';
|
|
284
338
|
const filterQuery = query.filter
|
|
285
339
|
? '&' +
|
|
@@ -300,30 +354,59 @@ async function paginate(query, repo, config) {
|
|
|
300
354
|
path = queryOrigin + queryPath;
|
|
301
355
|
}
|
|
302
356
|
}
|
|
303
|
-
const buildLink = (p
|
|
357
|
+
const buildLink = (p, isCursor = false, isReversed = false) => {
|
|
358
|
+
if (isCursor) {
|
|
359
|
+
let adjustedOptions = options;
|
|
360
|
+
if (isReversed) {
|
|
361
|
+
// Reverse ASC/DESC of first sortBy
|
|
362
|
+
const match = options.match(/sortBy=([^&]+)/); // Match 'sortBy=' value and extract the part after ':'
|
|
363
|
+
if (match) {
|
|
364
|
+
const fullSortBy = match[0];
|
|
365
|
+
const [column, order] = match[1].split(':');
|
|
366
|
+
const newOrder = order === 'ASC' ? 'DESC' : 'ASC';
|
|
367
|
+
adjustedOptions = options.replace(fullSortBy, `sortBy=${column}:${newOrder}`);
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
return (path +
|
|
371
|
+
adjustedOptions.replace(/^./, '?') +
|
|
372
|
+
`&${p ? 'cursor=' + p : ''}&cursorColumn=${cursorColumn}&cursorDirection=${isReversed ? (cursorDirection === 'before' ? 'after' : 'before') : cursorDirection}`);
|
|
373
|
+
}
|
|
374
|
+
return path + '?page=' + p + options;
|
|
375
|
+
};
|
|
376
|
+
const itemsPerPage = limit === PaginationLimit.COUNTER_ONLY ? totalItems : isPaginated ? limit : items.length;
|
|
377
|
+
const totalItemsForMeta = limit === PaginationLimit.COUNTER_ONLY || isPaginated ? totalItems : items.length;
|
|
304
378
|
const totalPages = isPaginated ? Math.ceil(totalItems / limit) : 1;
|
|
305
379
|
const results = {
|
|
306
380
|
data: items,
|
|
307
381
|
meta: {
|
|
308
|
-
itemsPerPage:
|
|
309
|
-
totalItems:
|
|
310
|
-
currentPage: page,
|
|
311
|
-
totalPages,
|
|
382
|
+
itemsPerPage: config.paginationType === PaginationType.CURSOR ? items.length : itemsPerPage,
|
|
383
|
+
totalItems: config.paginationType === PaginationType.CURSOR ? undefined : totalItemsForMeta,
|
|
384
|
+
currentPage: config.paginationType === PaginationType.CURSOR ? undefined : page,
|
|
385
|
+
totalPages: config.paginationType === PaginationType.CURSOR ? undefined : totalPages,
|
|
312
386
|
sortBy,
|
|
313
387
|
search: query.search,
|
|
314
388
|
searchBy: query.search ? searchBy : undefined,
|
|
315
389
|
select: isQuerySelected ? selectParams : undefined,
|
|
316
390
|
filter: query.filter,
|
|
391
|
+
cursor: config.paginationType === PaginationType.CURSOR ? query.cursor : undefined,
|
|
392
|
+
firstCursor: config.paginationType === PaginationType.CURSOR ? firstCursor : undefined,
|
|
393
|
+
lastCursor: config.paginationType === PaginationType.CURSOR ? lastCursor : undefined,
|
|
317
394
|
},
|
|
318
395
|
// If there is no `path`, don't build links.
|
|
319
396
|
links: path !== null
|
|
320
|
-
?
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
397
|
+
? config.paginationType === PaginationType.CURSOR
|
|
398
|
+
? {
|
|
399
|
+
previous: query.cursor && items.length ? buildLink(firstCursor, true, true) : undefined, // If no data exists, firstCursor is missing, so "previous" link is undefined.
|
|
400
|
+
current: query.cursor ? buildLink(query.cursor, true) : buildLink('', true),
|
|
401
|
+
next: lastCursor ? buildLink(lastCursor, true) : undefined,
|
|
402
|
+
}
|
|
403
|
+
: {
|
|
404
|
+
first: page == 1 ? undefined : buildLink(1),
|
|
405
|
+
previous: page - 1 < 1 ? undefined : buildLink(page - 1),
|
|
406
|
+
current: buildLink(page),
|
|
407
|
+
next: page + 1 > totalPages ? undefined : buildLink(page + 1),
|
|
408
|
+
last: page == totalPages || !totalItems ? undefined : buildLink(totalPages),
|
|
409
|
+
}
|
|
327
410
|
: {},
|
|
328
411
|
};
|
|
329
412
|
return Object.assign(new Paginated(), results);
|