@ptc-org/nestjs-query-rest 10.0.0
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 +23 -0
- package/package.json +58 -0
- package/src/auth/authorizer.d.ts +27 -0
- package/src/auth/authorizer.js +13 -0
- package/src/auth/authorizer.js.map +1 -0
- package/src/auth/default-crud.authorizer.d.ts +6 -0
- package/src/auth/default-crud.authorizer.js +68 -0
- package/src/auth/default-crud.authorizer.js.map +1 -0
- package/src/auth/index.d.ts +3 -0
- package/src/auth/index.js +7 -0
- package/src/auth/index.js.map +1 -0
- package/src/auth/tokens.d.ts +3 -0
- package/src/auth/tokens.js +8 -0
- package/src/auth/tokens.js.map +1 -0
- package/src/common/dto.utils.d.ts +14 -0
- package/src/common/dto.utils.js +22 -0
- package/src/common/dto.utils.js.map +1 -0
- package/src/common/index.d.ts +3 -0
- package/src/common/index.js +7 -0
- package/src/common/index.js.map +1 -0
- package/src/common/object.utils.d.ts +1 -0
- package/src/common/object.utils.js +14 -0
- package/src/common/object.utils.js.map +1 -0
- package/src/common/resolver.utils.d.ts +2 -0
- package/src/common/resolver.utils.js +20 -0
- package/src/common/resolver.utils.js.map +1 -0
- package/src/connection/array-connection.type.d.ts +4 -0
- package/src/connection/array-connection.type.js +20 -0
- package/src/connection/array-connection.type.js.map +1 -0
- package/src/connection/index.d.ts +1 -0
- package/src/connection/index.js +3 -0
- package/src/connection/index.js.map +1 -0
- package/src/connection/interfaces.d.ts +37 -0
- package/src/connection/interfaces.js +3 -0
- package/src/connection/interfaces.js.map +1 -0
- package/src/connection/offset/offset-connection.type.d.ts +4 -0
- package/src/connection/offset/offset-connection.type.js +49 -0
- package/src/connection/offset/offset-connection.type.js.map +1 -0
- package/src/connection/offset/offset-page-info.type.d.ts +5 -0
- package/src/connection/offset/offset-page-info.type.js +35 -0
- package/src/connection/offset/offset-page-info.type.js.map +1 -0
- package/src/connection/offset/pager/index.d.ts +2 -0
- package/src/connection/offset/pager/index.js +6 -0
- package/src/connection/offset/pager/index.js.map +1 -0
- package/src/connection/offset/pager/interfaces.d.ts +12 -0
- package/src/connection/offset/pager/interfaces.js +3 -0
- package/src/connection/offset/pager/interfaces.js.map +1 -0
- package/src/connection/offset/pager/pager.d.ts +12 -0
- package/src/connection/offset/pager/pager.js +62 -0
- package/src/connection/offset/pager/pager.js.map +1 -0
- package/src/controllers/controller.interface.d.ts +43 -0
- package/src/controllers/controller.interface.js +15 -0
- package/src/controllers/controller.interface.js.map +1 -0
- package/src/controllers/create.controller.d.ts +46 -0
- package/src/controllers/create.controller.js +118 -0
- package/src/controllers/create.controller.js.map +1 -0
- package/src/controllers/crud.controller.d.ts +51 -0
- package/src/controllers/crud.controller.js +68 -0
- package/src/controllers/crud.controller.js.map +1 -0
- package/src/controllers/delete.controller.d.ts +18 -0
- package/src/controllers/delete.controller.js +60 -0
- package/src/controllers/delete.controller.js.map +1 -0
- package/src/controllers/export.controller.d.ts +22 -0
- package/src/controllers/export.controller.js +88 -0
- package/src/controllers/export.controller.js.map +1 -0
- package/src/controllers/index.d.ts +7 -0
- package/src/controllers/index.js +16 -0
- package/src/controllers/index.js.map +1 -0
- package/src/controllers/read.controller.d.ts +23 -0
- package/src/controllers/read.controller.js +102 -0
- package/src/controllers/read.controller.js.map +1 -0
- package/src/controllers/update.controller.d.ts +17 -0
- package/src/controllers/update.controller.js +86 -0
- package/src/controllers/update.controller.js.map +1 -0
- package/src/decorators/api-schema.decorator.d.ts +6 -0
- package/src/decorators/api-schema.decorator.js +16 -0
- package/src/decorators/api-schema.decorator.js.map +1 -0
- package/src/decorators/authorize-filter.decorator.d.ts +4 -0
- package/src/decorators/authorize-filter.decorator.js +78 -0
- package/src/decorators/authorize-filter.decorator.js.map +1 -0
- package/src/decorators/authorizer.decorator.d.ts +5 -0
- package/src/decorators/authorizer.decorator.js +24 -0
- package/src/decorators/authorizer.decorator.js.map +1 -0
- package/src/decorators/constants.d.ts +5 -0
- package/src/decorators/constants.js +12 -0
- package/src/decorators/constants.js.map +1 -0
- package/src/decorators/controller-methods.decorator.d.ts +21 -0
- package/src/decorators/controller-methods.decorator.js +75 -0
- package/src/decorators/controller-methods.decorator.js.map +1 -0
- package/src/decorators/decorator.utils.d.ts +3 -0
- package/src/decorators/decorator.utils.js +20 -0
- package/src/decorators/decorator.utils.js.map +1 -0
- package/src/decorators/field.decorator.d.ts +36 -0
- package/src/decorators/field.decorator.js +107 -0
- package/src/decorators/field.decorator.js.map +1 -0
- package/src/decorators/filterable-field.decorator.d.ts +49 -0
- package/src/decorators/filterable-field.decorator.js +58 -0
- package/src/decorators/filterable-field.decorator.js.map +1 -0
- package/src/decorators/hook-args.decorator.d.ts +5 -0
- package/src/decorators/hook-args.decorator.js +64 -0
- package/src/decorators/hook-args.decorator.js.map +1 -0
- package/src/decorators/hook.decorator.d.ts +8 -0
- package/src/decorators/hook.decorator.js +33 -0
- package/src/decorators/hook.decorator.js.map +1 -0
- package/src/decorators/id-field.decorator.d.ts +27 -0
- package/src/decorators/id-field.decorator.js +44 -0
- package/src/decorators/id-field.decorator.js.map +1 -0
- package/src/decorators/index.d.ts +14 -0
- package/src/decorators/index.js +18 -0
- package/src/decorators/index.js.map +1 -0
- package/src/decorators/inject-authorizer.decorator.d.ts +2 -0
- package/src/decorators/inject-authorizer.decorator.js +8 -0
- package/src/decorators/inject-authorizer.decorator.js.map +1 -0
- package/src/decorators/param-args.decorator.d.ts +3 -0
- package/src/decorators/param-args.decorator.js +21 -0
- package/src/decorators/param-args.decorator.js.map +1 -0
- package/src/decorators/query-options.decorator.d.ts +5 -0
- package/src/decorators/query-options.decorator.js +16 -0
- package/src/decorators/query-options.decorator.js.map +1 -0
- package/src/decorators/resolver-method.decorator.d.ts +51 -0
- package/src/decorators/resolver-method.decorator.js +43 -0
- package/src/decorators/resolver-method.decorator.js.map +1 -0
- package/src/decorators/resolver-query.decorator.d.ts +4 -0
- package/src/decorators/resolver-query.decorator.js +3 -0
- package/src/decorators/resolver-query.decorator.js.map +1 -0
- package/src/decorators/skip-if.decorator.d.ts +8 -0
- package/src/decorators/skip-if.decorator.js +17 -0
- package/src/decorators/skip-if.decorator.js.map +1 -0
- package/src/hooks/default.hook.d.ts +3 -0
- package/src/hooks/default.hook.js +13 -0
- package/src/hooks/default.hook.js.map +1 -0
- package/src/hooks/hooks.d.ts +9 -0
- package/src/hooks/hooks.js +9 -0
- package/src/hooks/hooks.js.map +1 -0
- package/src/hooks/index.d.ts +4 -0
- package/src/hooks/index.js +10 -0
- package/src/hooks/index.js.map +1 -0
- package/src/hooks/tokens.d.ts +3 -0
- package/src/hooks/tokens.js +6 -0
- package/src/hooks/tokens.js.map +1 -0
- package/src/hooks/types.d.ts +10 -0
- package/src/hooks/types.js +15 -0
- package/src/hooks/types.js.map +1 -0
- package/src/index.d.ts +8 -0
- package/src/index.js +15 -0
- package/src/index.js.map +1 -0
- package/src/interceptors/authorizer.interceptor.d.ts +7 -0
- package/src/interceptors/authorizer.interceptor.js +30 -0
- package/src/interceptors/authorizer.interceptor.js.map +1 -0
- package/src/interceptors/hook.interceptor.d.ts +7 -0
- package/src/interceptors/hook.interceptor.js +41 -0
- package/src/interceptors/hook.interceptor.js.map +1 -0
- package/src/interceptors/index.d.ts +2 -0
- package/src/interceptors/index.js +6 -0
- package/src/interceptors/index.js.map +1 -0
- package/src/interfaces/return-type-func.d.ts +3 -0
- package/src/interfaces/return-type-func.js +3 -0
- package/src/interfaces/return-type-func.js.map +1 -0
- package/src/module.d.ts +26 -0
- package/src/module.js +45 -0
- package/src/module.js.map +1 -0
- package/src/providers/authorizer.provider.d.ts +3 -0
- package/src/providers/authorizer.provider.js +32 -0
- package/src/providers/authorizer.provider.js.map +1 -0
- package/src/providers/controller.provider.d.ts +20 -0
- package/src/providers/controller.provider.js +82 -0
- package/src/providers/controller.provider.js.map +1 -0
- package/src/providers/hook.provider.d.ts +5 -0
- package/src/providers/hook.provider.js +40 -0
- package/src/providers/hook.provider.js.map +1 -0
- package/src/providers/index.d.ts +3 -0
- package/src/providers/index.js +7 -0
- package/src/providers/index.js.map +1 -0
- package/src/types/create-one-input.type.d.ts +10 -0
- package/src/types/create-one-input.type.js +20 -0
- package/src/types/create-one-input.type.js.map +1 -0
- package/src/types/index.d.ts +7 -0
- package/src/types/index.js +11 -0
- package/src/types/index.js.map +1 -0
- package/src/types/mutation-args.type.d.ts +5 -0
- package/src/types/mutation-args.type.js +22 -0
- package/src/types/mutation-args.type.js.map +1 -0
- package/src/types/param-args.type.d.ts +13 -0
- package/src/types/param-args.type.js +50 -0
- package/src/types/param-args.type.js.map +1 -0
- package/src/types/query/buildable-query.type.d.ts +4 -0
- package/src/types/query/buildable-query.type.js +3 -0
- package/src/types/query/buildable-query.type.js.map +1 -0
- package/src/types/query/filter.type.d.ts +7 -0
- package/src/types/query/filter.type.js +80 -0
- package/src/types/query/filter.type.js.map +1 -0
- package/src/types/query/index.d.ts +2 -0
- package/src/types/query/index.js +6 -0
- package/src/types/query/index.js.map +1 -0
- package/src/types/query/paging/constants.d.ts +4 -0
- package/src/types/query/paging/constants.js +10 -0
- package/src/types/query/paging/constants.js.map +1 -0
- package/src/types/query/paging/index.d.ts +3 -0
- package/src/types/query/paging/index.js +8 -0
- package/src/types/query/paging/index.js.map +1 -0
- package/src/types/query/paging/interfaces.d.ts +6 -0
- package/src/types/query/paging/interfaces.js +3 -0
- package/src/types/query/paging/interfaces.js.map +1 -0
- package/src/types/query/paging/none-paging.type.d.ts +3 -0
- package/src/types/query/paging/none-paging.type.js +18 -0
- package/src/types/query/paging/none-paging.type.js.map +1 -0
- package/src/types/query/query-args/constants.d.ts +6 -0
- package/src/types/query/query-args/constants.js +10 -0
- package/src/types/query/query-args/constants.js.map +1 -0
- package/src/types/query/query-args/export-paging-query-args.type.d.ts +4 -0
- package/src/types/query/query-args/export-paging-query-args.type.js +38 -0
- package/src/types/query/query-args/export-paging-query-args.type.js.map +1 -0
- package/src/types/query/query-args/index.d.ts +2 -0
- package/src/types/query/query-args/index.js +6 -0
- package/src/types/query/query-args/index.js.map +1 -0
- package/src/types/query/query-args/interfaces.d.ts +51 -0
- package/src/types/query/query-args/interfaces.js +3 -0
- package/src/types/query/query-args/interfaces.js.map +1 -0
- package/src/types/query/query-args/none-paging-query-args.type.d.ts +4 -0
- package/src/types/query/query-args/none-paging-query-args.type.js +42 -0
- package/src/types/query/query-args/none-paging-query-args.type.js.map +1 -0
- package/src/types/query/query-args/offset-query-args.type.d.ts +4 -0
- package/src/types/query/query-args/offset-query-args.type.js +70 -0
- package/src/types/query/query-args/offset-query-args.type.js.map +1 -0
- package/src/types/query-args.type.d.ts +6 -0
- package/src/types/query-args.type.js +28 -0
- package/src/types/query-args.type.js.map +1 -0
- package/src/types/rest-query.type.d.ts +4 -0
- package/src/types/rest-query.type.js +3 -0
- package/src/types/rest-query.type.js.map +1 -0
- package/src/types/update-one-input.type.d.ts +10 -0
- package/src/types/update-one-input.type.js +20 -0
- package/src/types/update-one-input.type.js.map +1 -0
- package/src/types/validators/index.d.ts +1 -0
- package/src/types/validators/index.js +5 -0
- package/src/types/validators/index.js.map +1 -0
- package/src/types/validators/is-undefined.validator.d.ts +3 -0
- package/src/types/validators/is-undefined.validator.js +10 -0
- package/src/types/validators/is-undefined.validator.js.map +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://tripss.github.io/nestjs-query" target="blank"><img src="https://tripss.github.io/nestjs-query/img/logo.svg" width="120" alt="Nestjs-query Logo" /></a>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.org/package/@ptc-org/nestjs-query-rest)
|
|
6
|
+
[](https://github.com/tripss/nestjs-query/actions?query=workflow%3ATest+and+branch%3Amaster+)
|
|
7
|
+
[](https://codecov.io/gh/TriPSs/nestjs-query)
|
|
8
|
+
[](https://snyk.io/test/github/tripss/nestjs-query?targetFile=packages/query-rest/package.json)
|
|
9
|
+
|
|
10
|
+
# `@ptc-org/nestjs-query-rest`
|
|
11
|
+
|
|
12
|
+
This package provides a code first implementation of rest CRUD endpoints. It is built on top of
|
|
13
|
+
of [nestjs](https://nestjs.com/).
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
[Install Guide](https://tripss.github.io/nestjs-query/docs/introduction/install)
|
|
18
|
+
|
|
19
|
+
## Getting Started
|
|
20
|
+
|
|
21
|
+
The get started with the `@ptc-org/nestjs-query-rest` package checkout
|
|
22
|
+
the [Getting Started](https://tripss.github.io/nestjs-query/docs/rest/getting-started) docs.
|
|
23
|
+
|
package/package.json
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ptc-org/nestjs-query-rest",
|
|
3
|
+
"version": "10.0.0",
|
|
4
|
+
"description": "Nestjs rest query adapter",
|
|
5
|
+
"author": "doug-martin <doug@dougamartin.com>",
|
|
6
|
+
"homepage": "https://github.com/tripss/nestjs-query#readme",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"rest",
|
|
9
|
+
"crud",
|
|
10
|
+
"nestjs"
|
|
11
|
+
],
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"main": "src/index.js",
|
|
14
|
+
"types": "src/index.d.ts",
|
|
15
|
+
"directories": {
|
|
16
|
+
"lib": "src",
|
|
17
|
+
"test": "__tests__"
|
|
18
|
+
},
|
|
19
|
+
"files": [
|
|
20
|
+
"src/**"
|
|
21
|
+
],
|
|
22
|
+
"publishConfig": {
|
|
23
|
+
"access": "public"
|
|
24
|
+
},
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "git+https://github.com/tripss/nestjs-query.git",
|
|
28
|
+
"directory": "packages/query-rest"
|
|
29
|
+
},
|
|
30
|
+
"bugs": {
|
|
31
|
+
"url": "https://github.com/tripss/nestjs-query/issues"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"lodash.omit": "^4.18.0",
|
|
35
|
+
"lower-case-first": "^2.0.2",
|
|
36
|
+
"pluralize": "^8.0.0",
|
|
37
|
+
"tslib": "^2.8.1",
|
|
38
|
+
"upper-case-first": "^2.0.2",
|
|
39
|
+
"@ptc-org/nestjs-query-core": "10.0.0",
|
|
40
|
+
"lodash.merge": "4.6.2",
|
|
41
|
+
"reflect-metadata": "0.2.2"
|
|
42
|
+
},
|
|
43
|
+
"peerDependencies": {
|
|
44
|
+
"@nestjs/common": "^10.0.0 || ^11.0.0",
|
|
45
|
+
"@nestjs/core": "^10.0.0 || ^11.0.0",
|
|
46
|
+
"@nestjs/swagger": "^10.0.0 || ^11.0.0",
|
|
47
|
+
"class-transformer": "^0.5",
|
|
48
|
+
"class-validator": "^0.14.0"
|
|
49
|
+
},
|
|
50
|
+
"packageManager": "yarn@4.18.0",
|
|
51
|
+
"resolutions": {
|
|
52
|
+
"@apollo/gateway": "2.14.1",
|
|
53
|
+
"@apollo/server": "^5.5.1",
|
|
54
|
+
"@apollo/subgraph": "2.14.1",
|
|
55
|
+
"better-sqlite3": "^12.10.0"
|
|
56
|
+
},
|
|
57
|
+
"type": "commonjs"
|
|
58
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Filter } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
export declare enum OperationGroup {
|
|
3
|
+
READ = "read",
|
|
4
|
+
EXPORT = "export",
|
|
5
|
+
AGGREGATE = "aggregate",
|
|
6
|
+
CREATE = "create",
|
|
7
|
+
UPDATE = "update",
|
|
8
|
+
DELETE = "delete"
|
|
9
|
+
}
|
|
10
|
+
export interface AuthorizationContext {
|
|
11
|
+
/** The name of the method that uses the @AuthorizeFilter decorator */
|
|
12
|
+
readonly operationName: string;
|
|
13
|
+
/** The group this operation belongs to */
|
|
14
|
+
readonly operationGroup: OperationGroup;
|
|
15
|
+
/** If the operation does not modify any entities */
|
|
16
|
+
readonly readonly: boolean;
|
|
17
|
+
/** If the operation can affect multiple entities */
|
|
18
|
+
readonly many: boolean;
|
|
19
|
+
}
|
|
20
|
+
export interface CustomAuthorizer<DTO> {
|
|
21
|
+
authorize(context: any, authorizerContext: AuthorizationContext): Promise<Filter<DTO>>;
|
|
22
|
+
authorizeRelation?(relationName: string, context: any, authorizerContext: AuthorizationContext): Promise<Filter<unknown> | undefined>;
|
|
23
|
+
}
|
|
24
|
+
export interface Authorizer<DTO> extends CustomAuthorizer<DTO> {
|
|
25
|
+
authorize(context: any, authorizerContext: AuthorizationContext): Promise<Filter<DTO>>;
|
|
26
|
+
authorizeRelation(relationName: string, context: any, authorizerContext: AuthorizationContext): Promise<Filter<unknown> | undefined>;
|
|
27
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationGroup = void 0;
|
|
4
|
+
var OperationGroup;
|
|
5
|
+
(function (OperationGroup) {
|
|
6
|
+
OperationGroup["READ"] = "read";
|
|
7
|
+
OperationGroup["EXPORT"] = "export";
|
|
8
|
+
OperationGroup["AGGREGATE"] = "aggregate";
|
|
9
|
+
OperationGroup["CREATE"] = "create";
|
|
10
|
+
OperationGroup["UPDATE"] = "update";
|
|
11
|
+
OperationGroup["DELETE"] = "delete";
|
|
12
|
+
})(OperationGroup || (exports.OperationGroup = OperationGroup = {}));
|
|
13
|
+
//# sourceMappingURL=authorizer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authorizer.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/auth/authorizer.ts"],"names":[],"mappings":";;;AAEA,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { Class, Filter } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { AuthorizationContext, Authorizer, CustomAuthorizer } from './authorizer';
|
|
3
|
+
export interface AuthorizerOptions<DTO> {
|
|
4
|
+
authorize: (context: any, authorizationContext: AuthorizationContext) => Filter<DTO> | Promise<Filter<DTO>>;
|
|
5
|
+
}
|
|
6
|
+
export declare function createDefaultAuthorizer<DTO>(DTOClass: Class<DTO>, opts?: CustomAuthorizer<DTO> | AuthorizerOptions<DTO>): Class<Authorizer<DTO>>;
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createDefaultAuthorizer = createDefaultAuthorizer;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const common_1 = require("@nestjs/common");
|
|
6
|
+
const core_1 = require("@nestjs/core");
|
|
7
|
+
const tokens_1 = require("./tokens");
|
|
8
|
+
// const createRelationAuthorizer = (opts: AuthorizerOptions<unknown>): Authorizer<unknown> => ({
|
|
9
|
+
// // eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
10
|
+
// async authorize(context: any, authorizationContext: AuthorizationContext): Promise<Filter<unknown>> {
|
|
11
|
+
// return opts.authorize(context, authorizationContext) ?? {}
|
|
12
|
+
// },
|
|
13
|
+
// authorizeRelation(): Promise<Filter<unknown>> {
|
|
14
|
+
// return Promise.reject(new Error('Not implemented'))
|
|
15
|
+
// }
|
|
16
|
+
// })
|
|
17
|
+
function createDefaultAuthorizer(DTOClass, opts // instance of class or authorizer options
|
|
18
|
+
) {
|
|
19
|
+
let DefaultAuthorizer = class DefaultAuthorizer {
|
|
20
|
+
// private readonly relations: Map<string, ResolverRelation<unknown>>
|
|
21
|
+
constructor(moduleRef, customAuthorizer) {
|
|
22
|
+
this.moduleRef = moduleRef;
|
|
23
|
+
this.customAuthorizer = customAuthorizer;
|
|
24
|
+
this.authOptions = opts;
|
|
25
|
+
this.relationsAuthorizers = new Map();
|
|
26
|
+
// this.relations = this.getRelations()
|
|
27
|
+
}
|
|
28
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
29
|
+
async authorize(context, authorizationContext) {
|
|
30
|
+
return (this.customAuthorizer?.authorize(context, authorizationContext) ??
|
|
31
|
+
this.authOptions?.authorize(context, authorizationContext) ??
|
|
32
|
+
{});
|
|
33
|
+
}
|
|
34
|
+
async authorizeRelation(relationName,
|
|
35
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
36
|
+
context, authorizationContext) {
|
|
37
|
+
if (this.customAuthorizer && typeof this.customAuthorizer.authorizeRelation === 'function') {
|
|
38
|
+
const filterFromCustomAuthorizer = await this.customAuthorizer.authorizeRelation(relationName, context, authorizationContext);
|
|
39
|
+
if (filterFromCustomAuthorizer) {
|
|
40
|
+
return filterFromCustomAuthorizer;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return {};
|
|
44
|
+
// this.addRelationAuthorizerIfNotExist(relationName)
|
|
45
|
+
// return this.relationsAuthorizers.get(relationName)?.authorize(context, authorizationContext) ?? {}
|
|
46
|
+
}
|
|
47
|
+
addRelationAuthorizerIfNotExist(relationName) {
|
|
48
|
+
if (!this.relationsAuthorizers.has(relationName)) {
|
|
49
|
+
return;
|
|
50
|
+
// const relation = this.relations.get(relationName)
|
|
51
|
+
// if (!relation) return
|
|
52
|
+
// if (relation.auth) {
|
|
53
|
+
// this.relationsAuthorizers.set(relationName, createRelationAuthorizer(relation.auth))
|
|
54
|
+
// } else if (getAuthorizer(relation.DTO)) {
|
|
55
|
+
// this.relationsAuthorizers.set(relationName, this.moduleRef.get(getAuthorizerToken(relation.DTO), { strict: false }))
|
|
56
|
+
// }
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
};
|
|
60
|
+
DefaultAuthorizer = tslib_1.__decorate([
|
|
61
|
+
(0, common_1.Injectable)(),
|
|
62
|
+
tslib_1.__param(1, (0, common_1.Optional)()),
|
|
63
|
+
tslib_1.__param(1, (0, common_1.Inject)((0, tokens_1.getCustomAuthorizerToken)(DTOClass))),
|
|
64
|
+
tslib_1.__metadata("design:paramtypes", [core_1.ModuleRef, Object])
|
|
65
|
+
], DefaultAuthorizer);
|
|
66
|
+
return DefaultAuthorizer;
|
|
67
|
+
}
|
|
68
|
+
//# sourceMappingURL=default-crud.authorizer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"default-crud.authorizer.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/auth/default-crud.authorizer.ts"],"names":[],"mappings":";;AAwBA,0DA0EC;;AAlGD,2CAA6D;AAC7D,uCAAwC;AAMxC,qCAAmD;AAOnD,iGAAiG;AACjG,mEAAmE;AACnE,0GAA0G;AAC1G,iEAAiE;AACjE,OAAO;AACP,oDAAoD;AACpD,0DAA0D;AAC1D,MAAM;AACN,KAAK;AAEL,SAAgB,uBAAuB,CACrC,QAAoB,EACpB,IAAqD,CAAC,0CAA0C;;IAEhG,IACM,iBAAiB,GADvB,MACM,iBAAiB;QAKrB,qEAAqE;QAErE,YACmB,SAAoB,EACmB,gBAAyD;YADhG,cAAS,GAAT,SAAS,CAAW;YACoC,qBAAgB,GAAhB,gBAAgB,CAAwB;YAR1G,gBAAW,GAAoD,IAAI,CAAA;YAU1E,IAAI,CAAC,oBAAoB,GAAG,IAAI,GAAG,EAA2C,CAAA;YAC9E,uCAAuC;QACzC,CAAC;QAED,8DAA8D;QACvD,KAAK,CAAC,SAAS,CAAC,OAAY,EAAE,oBAA0C;YAC7E,OAAO,CACL,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,OAAO,EAAE,oBAAoB,CAAC;gBAC/D,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,oBAAoB,CAAC;gBAC1D,EAAE,CACH,CAAA;QACH,CAAC;QAEM,KAAK,CAAC,iBAAiB,CAC5B,YAAoB;QACpB,8DAA8D;QAC9D,OAAY,EACZ,oBAA0C;YAE1C,IAAI,IAAI,CAAC,gBAAgB,IAAI,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC3F,MAAM,0BAA0B,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAC9E,YAAY,EACZ,OAAO,EACP,oBAAoB,CACrB,CAAA;gBAED,IAAI,0BAA0B,EAAE,CAAC;oBAC/B,OAAO,0BAA0B,CAAA;gBACnC,CAAC;YACH,CAAC;YACD,OAAO,EAAE,CAAA;YACT,qDAAqD;YACrD,qGAAqG;QACvG,CAAC;QAEO,+BAA+B,CAAC,YAAoB;YAC1D,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACjD,OAAM;gBACN,oDAAoD;gBACpD,wBAAwB;gBACxB,uBAAuB;gBACvB,yFAAyF;gBACzF,4CAA4C;gBAC5C,yHAAyH;gBACzH,IAAI;YACN,CAAC;QACH,CAAC;KASF,CAAA;IAlEK,iBAAiB;QADtB,IAAA,mBAAU,GAAE;QAUR,mBAAA,IAAA,iBAAQ,GAAE,CAAA;QAAE,mBAAA,IAAA,eAAM,EAAC,IAAA,iCAAwB,EAAC,QAAQ,CAAC,CAAC,CAAA;iDAD3B,gBAAS;OARnC,iBAAiB,CAkEtB;IAED,OAAO,iBAAiB,CAAA;AAC1B,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
tslib_1.__exportStar(require("./authorizer"), exports);
|
|
5
|
+
tslib_1.__exportStar(require("./default-crud.authorizer"), exports);
|
|
6
|
+
tslib_1.__exportStar(require("./tokens"), exports);
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/auth/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B;AAC5B,oEAAyC;AACzC,mDAAwB"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getCustomAuthorizerToken = exports.getAuthorizerToken = void 0;
|
|
4
|
+
const getAuthorizerToken = (DTOClass) => `${DTOClass.name}Authorizer`;
|
|
5
|
+
exports.getAuthorizerToken = getAuthorizerToken;
|
|
6
|
+
const getCustomAuthorizerToken = (DTOClass) => `${DTOClass.name}CustomAuthorizer`;
|
|
7
|
+
exports.getCustomAuthorizerToken = getCustomAuthorizerToken;
|
|
8
|
+
//# sourceMappingURL=tokens.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/auth/tokens.ts"],"names":[],"mappings":";;;AAEO,MAAM,kBAAkB,GAAG,CAAM,QAAoB,EAAU,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,YAAY,CAAA;AAAxF,QAAA,kBAAkB,sBAAsE;AAC9F,MAAM,wBAAwB,GAAG,CAAM,QAAoB,EAAU,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,kBAAkB,CAAA;AAApG,QAAA,wBAAwB,4BAA4E"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Class } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
export interface DTONamesOpts {
|
|
3
|
+
dtoName?: string;
|
|
4
|
+
}
|
|
5
|
+
/** @internal */
|
|
6
|
+
export interface DTONames {
|
|
7
|
+
baseName: string;
|
|
8
|
+
baseNameLower: string;
|
|
9
|
+
pluralBaseName: string;
|
|
10
|
+
pluralBaseNameLower: string;
|
|
11
|
+
endpointName: string;
|
|
12
|
+
}
|
|
13
|
+
/** @internal */
|
|
14
|
+
export declare const getDTONames: <DTO>(DTOClass: Class<DTO>, opts?: DTONamesOpts) => DTONames;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getDTONames = void 0;
|
|
4
|
+
const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
|
|
5
|
+
const pluralize_1 = require("pluralize");
|
|
6
|
+
const kebabize = (str) => str.replace(/[A-Z]+(?![a-z])|[A-Z]/g, ($, ofs) => (ofs ? '-' : '') + $.toLowerCase());
|
|
7
|
+
/** @internal */
|
|
8
|
+
const getDTONames = (DTOClass, opts) => {
|
|
9
|
+
const baseName = (0, nestjs_query_core_1.upperCaseFirst)(opts?.dtoName ?? DTOClass.name);
|
|
10
|
+
const pluralBaseName = (0, pluralize_1.plural)(baseName);
|
|
11
|
+
const baseNameLower = (0, nestjs_query_core_1.lowerCaseFirst)(baseName);
|
|
12
|
+
const pluralBaseNameLower = (0, pluralize_1.plural)(baseNameLower);
|
|
13
|
+
return {
|
|
14
|
+
baseName,
|
|
15
|
+
baseNameLower,
|
|
16
|
+
pluralBaseName,
|
|
17
|
+
pluralBaseNameLower,
|
|
18
|
+
endpointName: kebabize(pluralBaseName)
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
exports.getDTONames = getDTONames;
|
|
22
|
+
//# sourceMappingURL=dto.utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dto.utils.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/common/dto.utils.ts"],"names":[],"mappings":";;;AAAA,kEAAkF;AAClF,yCAAkC;AAelC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;AAEvH,gBAAgB;AACT,MAAM,WAAW,GAAG,CAAM,QAAoB,EAAE,IAAmB,EAAY,EAAE;IACtF,MAAM,QAAQ,GAAG,IAAA,kCAAc,EAAC,IAAI,EAAE,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC/D,MAAM,cAAc,GAAG,IAAA,kBAAM,EAAC,QAAQ,CAAC,CAAA;IACvC,MAAM,aAAa,GAAG,IAAA,kCAAc,EAAC,QAAQ,CAAC,CAAA;IAC9C,MAAM,mBAAmB,GAAG,IAAA,kBAAM,EAAC,aAAa,CAAC,CAAA;IAEjD,OAAO;QACL,QAAQ;QACR,aAAa;QACb,cAAc;QACd,mBAAmB;QACnB,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC;KACvC,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,WAAW,eAavB"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
tslib_1.__exportStar(require("./dto.utils"), exports);
|
|
5
|
+
tslib_1.__exportStar(require("./object.utils"), exports);
|
|
6
|
+
tslib_1.__exportStar(require("./resolver.utils"), exports);
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/common/index.ts"],"names":[],"mappings":";;;AAAA,sDAA2B;AAC3B,yDAA8B;AAC9B,2DAAgC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const removeUndefinedValues: <T>(obj: T) => T;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.removeUndefinedValues = void 0;
|
|
4
|
+
const removeUndefinedValues = (obj) => {
|
|
5
|
+
const keys = Object.keys(obj);
|
|
6
|
+
return keys.reduce((cleansed, key) => {
|
|
7
|
+
if (obj[key] === undefined) {
|
|
8
|
+
return cleansed;
|
|
9
|
+
}
|
|
10
|
+
return { ...cleansed, [key]: obj[key] };
|
|
11
|
+
}, {});
|
|
12
|
+
};
|
|
13
|
+
exports.removeUndefinedValues = removeUndefinedValues;
|
|
14
|
+
//# sourceMappingURL=object.utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"object.utils.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/common/object.utils.ts"],"names":[],"mappings":";;;AAAO,MAAM,qBAAqB,GAAG,CAAI,GAAM,EAAK,EAAE;IACpD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAgB,CAAA;IAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,QAAW,EAAE,GAAG,EAAE,EAAE;QACtC,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAA;QACjB,CAAC;QACD,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAA;IACzC,CAAC,EAAE,EAAO,CAAC,CAAA;AACb,CAAC,CAAA;AARY,QAAA,qBAAqB,yBAQjC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.mergeBaseResolverOpts = void 0;
|
|
4
|
+
const mergeArrays = (arr1, arr2) => {
|
|
5
|
+
if (arr1 || arr2) {
|
|
6
|
+
return [...(arr1 ?? []), ...(arr2 ?? [])];
|
|
7
|
+
}
|
|
8
|
+
return undefined;
|
|
9
|
+
};
|
|
10
|
+
const mergeBaseResolverOpts = (into, from) => {
|
|
11
|
+
const guards = mergeArrays(from.guards, into.guards);
|
|
12
|
+
const interceptors = mergeArrays(from.interceptors, into.interceptors);
|
|
13
|
+
const pipes = mergeArrays(from.pipes, into.pipes);
|
|
14
|
+
const filters = mergeArrays(from.filters, into.filters);
|
|
15
|
+
const decorators = mergeArrays(from.decorators, into.decorators);
|
|
16
|
+
const tags = mergeArrays(from.tags, into.tags);
|
|
17
|
+
return { ...into, tags, guards, interceptors, pipes, filters, decorators };
|
|
18
|
+
};
|
|
19
|
+
exports.mergeBaseResolverOpts = mergeBaseResolverOpts;
|
|
20
|
+
//# sourceMappingURL=resolver.utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolver.utils.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/common/resolver.utils.ts"],"names":[],"mappings":";;;AAEA,MAAM,WAAW,GAAG,CAAI,IAAU,EAAE,IAAU,EAAmB,EAAE;IACjE,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAA;IAC3C,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAEM,MAAM,qBAAqB,GAAG,CAAmC,IAAU,EAAE,IAAyB,EAAQ,EAAE;IACrH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACpD,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;IACtE,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACjD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IACvD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAChE,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;IAE9C,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAA;AAC5E,CAAC,CAAA;AATY,QAAA,qBAAqB,yBASjC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Class } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { NonePagingQueryArgsTypeOpts, PagingStrategies } from '../types';
|
|
3
|
+
import { StaticConnectionType } from './interfaces';
|
|
4
|
+
export declare function getOrCreateArrayConnectionType<DTO>(TItemClass: Class<DTO>, opts: NonePagingQueryArgsTypeOpts<DTO>): StaticConnectionType<DTO, PagingStrategies.NONE>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getOrCreateArrayConnectionType = getOrCreateArrayConnectionType;
|
|
4
|
+
const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
|
|
5
|
+
const reflector = new nestjs_query_core_1.MapReflector('nestjs-query:array-connection-type');
|
|
6
|
+
function getOrCreateArrayConnectionType(TItemClass, opts) {
|
|
7
|
+
const connectionName = opts?.connectionName || `${TItemClass.name}Connection`;
|
|
8
|
+
return reflector.memoize(TItemClass, connectionName, () => {
|
|
9
|
+
class AbstractConnection extends Array {
|
|
10
|
+
static async createFromPromise(queryMany, query) {
|
|
11
|
+
// remove paging from the query because the ArrayConnection does not support paging.
|
|
12
|
+
const { paging, ...rest } = query;
|
|
13
|
+
return queryMany(rest);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
Object.defineProperty(AbstractConnection, 'name', { value: connectionName, writable: false });
|
|
17
|
+
return AbstractConnection;
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=array-connection.type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"array-connection.type.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/connection/array-connection.type.ts"],"names":[],"mappings":";;AAOA,wEAmBC;AA1BD,kEAAuE;AAKvE,MAAM,SAAS,GAAG,IAAI,gCAAY,CAAC,oCAAoC,CAAC,CAAA;AAExE,SAAgB,8BAA8B,CAC5C,UAAsB,EACtB,IAAsC;IAEtC,MAAM,cAAc,GAAG,IAAI,EAAE,cAAc,IAAI,GAAG,UAAU,CAAC,IAAI,YAAY,CAAA;IAE7E,OAAO,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,EAAE;QACxD,MAAM,kBAAmB,SAAQ,KAAU;YACzC,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAuB,SAA4B,EAAE,KAAQ;gBACzF,oFAAoF;gBACpF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;gBACjC,OAAO,SAAS,CAAC,IAAS,CAAC,CAAA;YAC7B,CAAC;SACF;QAED,MAAM,CAAC,cAAc,CAAC,kBAAkB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QAE7F,OAAO,kBAAkB,CAAA;IAC3B,CAAC,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { ArrayConnectionType, ConnectionType, OffsetConnectionType, OffsetPageInfoType } from './interfaces';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/connection/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Class, Filter, Query } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { PagingStrategies } from '../types/query';
|
|
3
|
+
interface BaseConnectionOptions {
|
|
4
|
+
enableTotalCount?: boolean;
|
|
5
|
+
connectionName?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface OffsetConnectionOptions extends BaseConnectionOptions {
|
|
8
|
+
pagingStrategy?: PagingStrategies.OFFSET;
|
|
9
|
+
}
|
|
10
|
+
export interface ArrayConnectionOptions extends BaseConnectionOptions {
|
|
11
|
+
pagingStrategy?: PagingStrategies.NONE;
|
|
12
|
+
}
|
|
13
|
+
export type ConnectionOptions = OffsetConnectionOptions | ArrayConnectionOptions;
|
|
14
|
+
export interface OffsetPageInfoType {
|
|
15
|
+
hasNextPage: boolean;
|
|
16
|
+
hasPreviousPage: boolean;
|
|
17
|
+
}
|
|
18
|
+
export type OffsetConnectionType<DTO> = {
|
|
19
|
+
pageInfo: OffsetPageInfoType;
|
|
20
|
+
totalCount?: number;
|
|
21
|
+
nodes: DTO[];
|
|
22
|
+
};
|
|
23
|
+
export type ArrayConnectionType<DTO> = DTO[];
|
|
24
|
+
export type ConnectionType<DTO> = OffsetConnectionType<DTO> | ArrayConnectionType<DTO>;
|
|
25
|
+
export type QueryMany<DTO, Q extends Query<DTO>> = (query: Q) => Promise<DTO[]>;
|
|
26
|
+
export type Count<DTO> = (filter: Filter<DTO>) => Promise<number>;
|
|
27
|
+
export type PagerResult = {
|
|
28
|
+
totalCount?: number;
|
|
29
|
+
};
|
|
30
|
+
export interface Pager<DTO, R extends PagerResult> {
|
|
31
|
+
page<Q extends Query<DTO>>(queryMany: QueryMany<DTO, Q>, query: Q, count?: Count<DTO>): Promise<R>;
|
|
32
|
+
}
|
|
33
|
+
export type InferConnectionTypeFromStrategy<DTO, S extends PagingStrategies> = S extends PagingStrategies.NONE ? ArrayConnectionType<DTO> : S extends PagingStrategies.OFFSET ? OffsetConnectionType<DTO> : never;
|
|
34
|
+
export interface StaticConnectionType<DTO, S extends PagingStrategies> extends Class<InferConnectionTypeFromStrategy<DTO, S>> {
|
|
35
|
+
createFromPromise<Q extends Query<DTO>>(queryMany: QueryMany<DTO, Q>, query: Q, count?: Count<DTO>): Promise<InferConnectionTypeFromStrategy<DTO, S>>;
|
|
36
|
+
}
|
|
37
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/connection/interfaces.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Class } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { OffsetQueryArgsTypeOpts, PagingStrategies } from '../../types/query';
|
|
3
|
+
import { StaticConnectionType } from '../interfaces';
|
|
4
|
+
export declare function getOrCreateOffsetConnectionType<DTO>(TItemClass: Class<DTO>, opts: OffsetQueryArgsTypeOpts<DTO>): StaticConnectionType<DTO, PagingStrategies.OFFSET>;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getOrCreateOffsetConnectionType = getOrCreateOffsetConnectionType;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
|
|
6
|
+
const class_transformer_1 = require("class-transformer");
|
|
7
|
+
const decorators_1 = require("../../decorators");
|
|
8
|
+
const offset_page_info_type_1 = require("./offset-page-info.type");
|
|
9
|
+
const pager_1 = require("./pager");
|
|
10
|
+
const reflector = new nestjs_query_core_1.MapReflector('nestjs-query:offset-connection-type');
|
|
11
|
+
function getOrCreateOffsetConnectionType(TItemClass, opts) {
|
|
12
|
+
const connectionName = opts?.connectionName || `${TItemClass.name}OffsetConnection`;
|
|
13
|
+
return reflector.memoize(TItemClass, connectionName, () => {
|
|
14
|
+
const PIT = (0, offset_page_info_type_1.getOrCreateOffsetPageInfoType)();
|
|
15
|
+
const pager = new pager_1.OffsetPager();
|
|
16
|
+
class OffsetConnection {
|
|
17
|
+
static async createFromPromise(queryMany, query, count) {
|
|
18
|
+
const { pageInfo, nodes, totalCount } = await pager.page(queryMany, query, opts.enableTotalCount ? count : undefined);
|
|
19
|
+
return new OffsetConnection(new PIT(pageInfo.hasNextPage, pageInfo.hasPreviousPage), nodes, totalCount);
|
|
20
|
+
}
|
|
21
|
+
constructor(pageInfo, nodes, totalCount) {
|
|
22
|
+
this.pageInfo = pageInfo ?? { hasNextPage: false, hasPreviousPage: false };
|
|
23
|
+
this.nodes = (0, class_transformer_1.plainToInstance)(TItemClass, nodes ?? [], { excludeExtraneousValues: true });
|
|
24
|
+
this.totalCount = totalCount;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
tslib_1.__decorate([
|
|
28
|
+
(0, decorators_1.Field)(() => PIT, {
|
|
29
|
+
description: 'Paging information'
|
|
30
|
+
}),
|
|
31
|
+
tslib_1.__metadata("design:type", Object)
|
|
32
|
+
], OffsetConnection.prototype, "pageInfo", void 0);
|
|
33
|
+
tslib_1.__decorate([
|
|
34
|
+
(0, decorators_1.SkipIf)(() => !opts.enableTotalCount, (0, decorators_1.Field)({
|
|
35
|
+
description: 'Total amount of records.'
|
|
36
|
+
})),
|
|
37
|
+
tslib_1.__metadata("design:type", Number)
|
|
38
|
+
], OffsetConnection.prototype, "totalCount", void 0);
|
|
39
|
+
tslib_1.__decorate([
|
|
40
|
+
(0, decorators_1.Field)(() => [TItemClass], {
|
|
41
|
+
description: 'Array of nodes.'
|
|
42
|
+
}),
|
|
43
|
+
tslib_1.__metadata("design:type", Array)
|
|
44
|
+
], OffsetConnection.prototype, "nodes", void 0);
|
|
45
|
+
Object.defineProperty(OffsetConnection, 'name', { value: connectionName, writable: false });
|
|
46
|
+
return OffsetConnection;
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=offset-connection.type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"offset-connection.type.js","sourceRoot":"","sources":["../../../../../../packages/query-rest/src/connection/offset/offset-connection.type.ts"],"names":[],"mappings":";;AAWA,0EAkDC;;AA7DD,kEAAuE;AACvE,yDAAmD;AAEnD,iDAAgD;AAGhD,mEAAuE;AACvE,mCAAqC;AAErC,MAAM,SAAS,GAAG,IAAI,gCAAY,CAAC,qCAAqC,CAAC,CAAA;AAEzE,SAAgB,+BAA+B,CAC7C,UAAsB,EACtB,IAAkC;IAElC,MAAM,cAAc,GAAG,IAAI,EAAE,cAAc,IAAI,GAAG,UAAU,CAAC,IAAI,kBAAkB,CAAA;IAEnF,OAAO,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,EAAE;QACxD,MAAM,GAAG,GAAG,IAAA,qDAA6B,GAAE,CAAA;QAC3C,MAAM,KAAK,GAAG,IAAI,mBAAW,EAAO,CAAA;QAEpC,MAAM,gBAAgB;YACb,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACnC,SAA4B,EAC5B,KAAiB,EACjB,KAAkB;gBAElB,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;gBAErH,OAAO,IAAI,gBAAgB,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;YACzG,CAAC;YAED,YAAY,QAA6B,EAAE,KAAa,EAAE,UAAmB;gBAC3E,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,CAAA;gBAC1E,IAAI,CAAC,KAAK,GAAG,IAAA,mCAAe,EAAC,UAAU,EAAE,KAAK,IAAI,EAAE,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAA;gBACxF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAC9B,CAAC;SAmBF;QAdQ;YAHN,IAAA,kBAAK,EAAC,GAAG,EAAE,CAAC,GAAG,EAAE;gBAChB,WAAW,EAAE,oBAAoB;aAClC,CAAC;;0DACkC;QAQ7B;YANN,IAAA,mBAAM,EACL,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAC5B,IAAA,kBAAK,EAAC;gBACJ,WAAW,EAAE,0BAA0B;aACxC,CAAC,CACH;;4DACyB;QAKnB;YAHN,IAAA,kBAAK,EAAC,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE;gBACzB,WAAW,EAAE,iBAAiB;aAC/B,CAAC;;uDACkB;QAGtB,MAAM,CAAC,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QAE3F,OAAO,gBAAgB,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { OffsetPageInfoType } from '../interfaces';
|
|
2
|
+
export interface OffsetPageInfoTypeConstructor {
|
|
3
|
+
new (hasNextPage: boolean, hasPreviousPage: boolean): OffsetPageInfoType;
|
|
4
|
+
}
|
|
5
|
+
export declare const getOrCreateOffsetPageInfoType: () => OffsetPageInfoTypeConstructor;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getOrCreateOffsetPageInfoType = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const decorators_1 = require("../../decorators");
|
|
6
|
+
/** @internal */
|
|
7
|
+
let pageInfoType = null;
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare -- intentional
|
|
9
|
+
const getOrCreateOffsetPageInfoType = () => {
|
|
10
|
+
if (pageInfoType) {
|
|
11
|
+
return pageInfoType;
|
|
12
|
+
}
|
|
13
|
+
class PageInfoType {
|
|
14
|
+
constructor(hasNextPage, hasPreviousPage) {
|
|
15
|
+
this.hasNextPage = hasNextPage;
|
|
16
|
+
this.hasPreviousPage = hasPreviousPage;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
tslib_1.__decorate([
|
|
20
|
+
(0, decorators_1.Field)({
|
|
21
|
+
description: '`true` if paging forward and there are more records.'
|
|
22
|
+
}),
|
|
23
|
+
tslib_1.__metadata("design:type", Boolean)
|
|
24
|
+
], PageInfoType.prototype, "hasNextPage", void 0);
|
|
25
|
+
tslib_1.__decorate([
|
|
26
|
+
(0, decorators_1.Field)({
|
|
27
|
+
description: '`true` if paging backwards and there are more records.'
|
|
28
|
+
}),
|
|
29
|
+
tslib_1.__metadata("design:type", Boolean)
|
|
30
|
+
], PageInfoType.prototype, "hasPreviousPage", void 0);
|
|
31
|
+
pageInfoType = PageInfoType;
|
|
32
|
+
return pageInfoType;
|
|
33
|
+
};
|
|
34
|
+
exports.getOrCreateOffsetPageInfoType = getOrCreateOffsetPageInfoType;
|
|
35
|
+
//# sourceMappingURL=offset-page-info.type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"offset-page-info.type.js","sourceRoot":"","sources":["../../../../../../packages/query-rest/src/connection/offset/offset-page-info.type.ts"],"names":[],"mappings":";;;;AAEA,iDAAwC;AAOxC,gBAAgB;AAChB,IAAI,YAAY,GAAqC,IAAI,CAAA;AACzD,0EAA0E;AACnE,MAAM,6BAA6B,GAAG,GAAkC,EAAE;IAC/E,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,MAAM,YAAY;QAChB,YAAY,WAAoB,EAAE,eAAwB;YACxD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;YAC9B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACxC,CAAC;KAWF;IANC;QAHC,IAAA,kBAAK,EAAC;YACL,WAAW,EAAE,sDAAsD;SACpE,CAAC;;qDACkB;IAKpB;QAHC,IAAA,kBAAK,EAAC;YACL,WAAW,EAAE,wDAAwD;SACtE,CAAC;;yDACsB;IAG1B,YAAY,GAAG,YAAY,CAAA;IAC3B,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAxBY,QAAA,6BAA6B,iCAwBzC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OffsetPager = void 0;
|
|
4
|
+
var pager_1 = require("./pager");
|
|
5
|
+
Object.defineProperty(exports, "OffsetPager", { enumerable: true, get: function () { return pager_1.OffsetPager; } });
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/query-rest/src/connection/offset/pager/index.ts"],"names":[],"mappings":";;;AACA,iCAAqC;AAA5B,oGAAA,WAAW,OAAA"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Paging, Query } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { OffsetConnectionType, PagerResult } from '../../interfaces';
|
|
3
|
+
export type OffsetPagingOpts = Required<Paging>;
|
|
4
|
+
export interface OffsetPagingMeta<DTO> {
|
|
5
|
+
opts: OffsetPagingOpts;
|
|
6
|
+
query: Query<DTO>;
|
|
7
|
+
}
|
|
8
|
+
export interface QueryResults<DTO> {
|
|
9
|
+
nodes: DTO[];
|
|
10
|
+
hasExtraNode: boolean;
|
|
11
|
+
}
|
|
12
|
+
export type OffsetPagerResult<DTO> = PagerResult & Omit<OffsetConnectionType<DTO>, 'totalCount'>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../../../../packages/query-rest/src/connection/offset/pager/interfaces.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Query } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { Count, Pager, QueryMany } from '../../interfaces';
|
|
3
|
+
import { OffsetPagerResult } from './interfaces';
|
|
4
|
+
export declare class OffsetPager<DTO> implements Pager<DTO, OffsetPagerResult<DTO>> {
|
|
5
|
+
page<Q extends Query<DTO>>(queryMany: QueryMany<DTO, Q>, query: Q, count?: Count<DTO>): Promise<OffsetPagerResult<DTO>>;
|
|
6
|
+
private isValidPaging;
|
|
7
|
+
private runQuery;
|
|
8
|
+
private getPageMeta;
|
|
9
|
+
private createPagingResult;
|
|
10
|
+
private createQuery;
|
|
11
|
+
private checkForExtraNode;
|
|
12
|
+
}
|