@ptc-org/nestjs-query-core 2.1.0 → 2.2.0-alpha.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/package.json +1 -1
- package/src/interfaces/find-by-id-options.interface.d.ts +2 -1
- package/src/interfaces/find-relation-options.interface.d.ts +4 -0
- package/src/interfaces/index.d.ts +1 -0
- package/src/interfaces/index.js +1 -0
- package/src/interfaces/index.js.map +1 -1
- package/src/interfaces/query.inteface.d.ts +8 -2
- package/src/interfaces/select-relation.interface.d.ts +11 -0
- package/src/interfaces/select-relation.interface.js +3 -0
- package/src/interfaces/select-relation.interface.js.map +1 -0
- package/src/services/assembler-query.service.js.map +1 -1
- package/src/services/query.service.d.ts +1 -0
- package/src/services/query.service.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Filterable } from './filterable.interface';
|
|
2
|
-
|
|
2
|
+
import { SelectRelations } from './select-relation.interface';
|
|
3
|
+
export interface FindByIdOptions<DTO> extends Filterable<DTO>, SelectRelations<DTO> {
|
|
3
4
|
/**
|
|
4
5
|
* Allow also deleted records to be retrieved
|
|
5
6
|
*/
|
|
@@ -12,6 +12,7 @@ export * from './get-by-id-options.interface';
|
|
|
12
12
|
export * from './modify-relation-options.interface';
|
|
13
13
|
export * from './paging.interface';
|
|
14
14
|
export * from './query.inteface';
|
|
15
|
+
export * from './select-relation.interface';
|
|
15
16
|
export * from './sort-field.interface';
|
|
16
17
|
export * from './update-many-response.interface';
|
|
17
18
|
export * from './update-one-options.interface';
|
package/src/interfaces/index.js
CHANGED
|
@@ -15,6 +15,7 @@ tslib_1.__exportStar(require("./get-by-id-options.interface"), exports);
|
|
|
15
15
|
tslib_1.__exportStar(require("./modify-relation-options.interface"), exports);
|
|
16
16
|
tslib_1.__exportStar(require("./paging.interface"), exports);
|
|
17
17
|
tslib_1.__exportStar(require("./query.inteface"), exports);
|
|
18
|
+
tslib_1.__exportStar(require("./select-relation.interface"), exports);
|
|
18
19
|
tslib_1.__exportStar(require("./sort-field.interface"), exports);
|
|
19
20
|
tslib_1.__exportStar(require("./update-many-response.interface"), exports);
|
|
20
21
|
tslib_1.__exportStar(require("./update-one-options.interface"), exports);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,sEAA2C;AAC3C,yEAA8C;AAC9C,0EAA+C;AAC/C,2EAAgD;AAChD,yEAA8C;AAC9C,6DAAkC;AAClC,8EAAmD;AACnD,iEAAsC;AACtC,yEAA8C;AAC9C,4EAAiD;AACjD,wEAA6C;AAC7C,8EAAmD;AACnD,6DAAkC;AAClC,2DAAgC;AAChC,iEAAsC;AACtC,2EAAgD;AAChD,yEAA8C"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,sEAA2C;AAC3C,yEAA8C;AAC9C,0EAA+C;AAC/C,2EAAgD;AAChD,yEAA8C;AAC9C,6DAAkC;AAClC,8EAAmD;AACnD,iEAAsC;AACtC,yEAA8C;AAC9C,4EAAiD;AACjD,wEAA6C;AAC7C,8EAAmD;AACnD,6DAAkC;AAClC,2DAAgC;AAChC,sEAA2C;AAC3C,iEAAsC;AACtC,2EAAgD;AAChD,yEAA8C"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Filterable } from './filterable.interface';
|
|
2
2
|
import { Paging } from './paging.interface';
|
|
3
|
+
import { SelectRelation } from './select-relation.interface';
|
|
3
4
|
import { SortField } from './sort-field.interface';
|
|
4
5
|
/**
|
|
5
6
|
* Interface for all queries to a collection of items.
|
|
@@ -25,7 +26,7 @@ import { SortField } from './sort-field.interface';
|
|
|
25
26
|
*
|
|
26
27
|
* @typeparam T - the type of the object to query for.
|
|
27
28
|
*/
|
|
28
|
-
export interface Query<
|
|
29
|
+
export interface Query<DTO> extends Filterable<DTO> {
|
|
29
30
|
/**
|
|
30
31
|
* Option to page through the collection.
|
|
31
32
|
*/
|
|
@@ -33,5 +34,10 @@ export interface Query<T> extends Filterable<T> {
|
|
|
33
34
|
/**
|
|
34
35
|
* Option to sort the collection.
|
|
35
36
|
*/
|
|
36
|
-
sorting?: SortField<
|
|
37
|
+
sorting?: SortField<DTO>[];
|
|
38
|
+
/**
|
|
39
|
+
* Select relations when doing the query.
|
|
40
|
+
* @internal this implementation is not final and subjected to change! Use at own risk!
|
|
41
|
+
*/
|
|
42
|
+
relations?: SelectRelation<DTO>[];
|
|
37
43
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Query } from './query.inteface';
|
|
2
|
+
export interface SelectRelation<DTO> {
|
|
3
|
+
name: string;
|
|
4
|
+
query: Omit<Query<DTO>, 'relations'>;
|
|
5
|
+
}
|
|
6
|
+
export interface SelectRelations<DTO> {
|
|
7
|
+
/**
|
|
8
|
+
* Select relations when doing the database query
|
|
9
|
+
*/
|
|
10
|
+
relations?: SelectRelation<DTO>[];
|
|
11
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"select-relation.interface.js","sourceRoot":"","sources":["../../../../../packages/core/src/interfaces/select-relation.interface.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assembler-query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/assembler-query.service.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"assembler-query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/assembler-query.service.ts"],"names":[],"mappings":";;;AAoBA,MAAa,qBAAqB;IAGhC,YAAqB,SAA+C,EAAW,YAA0C;QAApG,cAAS,GAAT,SAAS,CAAsC;QAAW,iBAAY,GAAZ,YAAY,CAA8B;IAAG,CAAC;IAE7H,YAAY,CACV,YAAoB,EACpB,EAAmB,EACnB,WAAgC,EAChC,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CACxG,CAAA;IACH,CAAC;IAED,UAAU,CAAC,KAAU;QACnB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;QAC1B,MAAM,SAAS,GAAG,SAAS,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAA;QAC1D,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IACnF,CAAC;IAED,SAAS,CAAC,IAAO;QACf,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAAmB;QAClC,oEAAoE;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAA;IACrF,CAAC;IAED,SAAS,CAAC,EAAmB,EAAE,IAA4B;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACxG,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAmB,EAAE,IAA2B;QAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;QACjF,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAA;SACjB;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;IAED,OAAO,CAAC,EAAmB,EAAE,IAA0B;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACtG,CAAC;IAED,KAAK,CAAC,KAAiB;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAmB,EAAE,SAA8B;QACjE,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CACzD,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE,EACpD,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAChD,CAAA;QACD,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAA;IACrF,CAAC;IAED,KAAK,CAAC,MAAmB;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAA;IACtF,CAAC;IA8BD,KAAK,CAAC,cAAc,CAClB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,KAAsB;QAEtB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;YACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;YAExG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;gBACvC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBAEtC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;gBAE1B,OAAO,GAAG,CAAA;YACZ,CAAC,EAAE,IAAI,GAAG,EAAmB,CAAC,CAAA;SAC/B;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAA;IAClH,CAAC;IAgBD,KAAK,CAAC,cAAc,CAClB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,MAAwB;QAExB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;YACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;YACzG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;gBACvC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBACrC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;gBAC1B,OAAO,GAAG,CAAA;YACZ,CAAC,EAAE,IAAI,GAAG,EAAe,CAAC,CAAA;SAC3B;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAA;IACnH,CAAC;IA8BD,KAAK,CAAC,YAAY,CAChB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,IAAoC;QAEpC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;YACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAA;YACrG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;gBACvC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;gBACvC,OAAO,GAAG,CAAA;YACZ,CAAC,EAAE,IAAI,GAAG,EAA6B,CAAC,CAAA;SACzC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAA;IACzG,CAAC;IAED,cAAc,CACZ,YAAoB,EACpB,EAAmB,EACnB,UAA2B,EAC3B,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CACzG,CAAA;IACH,CAAC;IAED,eAAe,CACb,YAAoB,EACpB,EAAmB,EACnB,WAAgC,EAChC,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAC3G,CAAA;IACH,CAAC;IAED,YAAY,CACV,YAAoB,EACpB,EAAmB,EACnB,WAAgC,EAChC,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CACxG,CAAA;IACH,CAAC;IAED,WAAW,CACT,YAAoB,EACpB,EAAmB,EACnB,UAA2B,EAC3B,IAA2C;QAE3C,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CACtG,CAAA;IACH,CAAC;IAED,UAAU,CAAC,MAAS,EAAE,MAAmB;QACvC,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CACjC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC;QAC5C,oEAAoE;QACpE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAC/C,CAAA;IACH,CAAC;IAED,SAAS,CAAC,EAAmB,EAAE,MAAS,EAAE,IAA4B;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACrC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAC5G,CAAA;IACH,CAAC;IAgBD,KAAK,CAAC,kBAAkB,CACtB,aAA8B,EAC9B,YAAoB,EACpB,GAAgB,EAChB,MAAwB,EACxB,SAAmC;QAEnC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;YACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;YACxH,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE;gBACvC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBACtC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;gBAC1B,OAAO,GAAG,CAAA;YACZ,CAAC,EAAE,IAAI,GAAG,EAAsC,CAAC,CAAA;SAClD;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CACzC,aAAa,EACb,YAAY,EACZ,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,EACnC,MAAM,EACN,SAAS,CACV,CAAA;IACH,CAAC;IAEO,iBAAiB,CAAC,UAA4B;QACpD,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;IACtG,CAAC;IAEO,6BAA6B,CACnC,qBAA4D;QAE5D,IAAI,CAAC,qBAAqB,EAAE;YAC1B,OAAO,SAAS,CAAA;SACjB;QACD,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM;YACrF,cAAc,EAAE,qBAAqB,CAAC,cAAc;SACrD,CAAA;IACH,CAAC;CACF;AAnTD,sDAmTC"}
|
|
@@ -9,6 +9,7 @@ export interface QueryService<DTO, C = DeepPartial<DTO>, U = DeepPartial<DTO>> {
|
|
|
9
9
|
/**
|
|
10
10
|
* Query for multiple records of type `T`.
|
|
11
11
|
* @param query - the query used to filer, page or sort records.
|
|
12
|
+
* @param selectRelations - additional relation to select and fetch in the same query.
|
|
12
13
|
* @returns a promise with an array of records that match the query.
|
|
13
14
|
*/
|
|
14
15
|
query(query: Query<DTO>): Promise<DTO[]>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/query.service.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;
|
|
1
|
+
{"version":3,"file":"query.service.js","sourceRoot":"","sources":["../../../../../packages/core/src/services/query.service.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AAwR3C;;;GAGG;AACH,4GAA4G;AAC5G,SAAgB,YAAY,CAAkD,QAAoB;IAChG,OAAO,CAA6C,GAAQ,EAAc,EAAE,CAAC,IAAA,mBAAU,GAAE,CAAC,GAAG,CAAC,CAAA;AAChG,CAAC;AAFD,oCAEC"}
|