@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
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OffsetPager = void 0;
|
|
4
|
+
const createEmptyPageResult = () => ({
|
|
5
|
+
nodes: [],
|
|
6
|
+
pageInfo: { hasNextPage: false, hasPreviousPage: false },
|
|
7
|
+
totalCount: undefined
|
|
8
|
+
});
|
|
9
|
+
const createDefaultPagingMeta = (query) => ({
|
|
10
|
+
opts: { offset: 0, limit: 0 },
|
|
11
|
+
query
|
|
12
|
+
});
|
|
13
|
+
class OffsetPager {
|
|
14
|
+
async page(queryMany, query, count) {
|
|
15
|
+
const pagingMeta = this.getPageMeta(query);
|
|
16
|
+
if (!this.isValidPaging(pagingMeta)) {
|
|
17
|
+
return createEmptyPageResult();
|
|
18
|
+
}
|
|
19
|
+
const results = await this.runQuery(queryMany, query, pagingMeta);
|
|
20
|
+
return this.createPagingResult(results, pagingMeta, await count?.(query.filter));
|
|
21
|
+
}
|
|
22
|
+
isValidPaging(pagingMeta) {
|
|
23
|
+
return pagingMeta.opts.limit > 0;
|
|
24
|
+
}
|
|
25
|
+
async runQuery(queryMany, query, pagingMeta) {
|
|
26
|
+
const windowedQuery = this.createQuery(query, pagingMeta);
|
|
27
|
+
const nodes = await queryMany(windowedQuery);
|
|
28
|
+
const returnNodes = this.checkForExtraNode(nodes, pagingMeta.opts);
|
|
29
|
+
const hasExtraNode = returnNodes.length !== nodes.length;
|
|
30
|
+
return { nodes: returnNodes, hasExtraNode };
|
|
31
|
+
}
|
|
32
|
+
getPageMeta(query) {
|
|
33
|
+
const { limit = 25, offset = 0 } = query.paging ?? {};
|
|
34
|
+
if (!limit) {
|
|
35
|
+
return createDefaultPagingMeta(query);
|
|
36
|
+
}
|
|
37
|
+
return { opts: { limit, offset }, query };
|
|
38
|
+
}
|
|
39
|
+
createPagingResult(results, pagingMeta, totalCount) {
|
|
40
|
+
const { nodes, hasExtraNode } = results;
|
|
41
|
+
const pageInfo = {
|
|
42
|
+
hasNextPage: hasExtraNode,
|
|
43
|
+
// we have a previous page if we are going backwards and have an extra node.
|
|
44
|
+
hasPreviousPage: pagingMeta.opts.offset > 0
|
|
45
|
+
};
|
|
46
|
+
return { nodes, pageInfo, totalCount };
|
|
47
|
+
}
|
|
48
|
+
createQuery(query, pagingMeta) {
|
|
49
|
+
const { limit, offset } = pagingMeta.opts;
|
|
50
|
+
return { ...query, paging: { limit: limit + 1, offset } };
|
|
51
|
+
}
|
|
52
|
+
checkForExtraNode(nodes, opts) {
|
|
53
|
+
const returnNodes = [...nodes];
|
|
54
|
+
const hasExtraNode = nodes.length > opts.limit;
|
|
55
|
+
if (hasExtraNode) {
|
|
56
|
+
returnNodes.pop();
|
|
57
|
+
}
|
|
58
|
+
return returnNodes;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
exports.OffsetPager = OffsetPager;
|
|
62
|
+
//# sourceMappingURL=pager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pager.js","sourceRoot":"","sources":["../../../../../../../packages/query-rest/src/connection/offset/pager/pager.ts"],"names":[],"mappings":";;;AAKA,MAAM,qBAAqB,GAAG,GAAgC,EAAE,CAAC,CAAC;IAChE,KAAK,EAAE,EAAE;IACT,QAAQ,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE;IACxD,UAAU,EAAE,SAAS;CACtB,CAAC,CAAA;AAEF,MAAM,uBAAuB,GAAG,CAAM,KAAiB,EAAyB,EAAE,CAAC,CAAC;IAClF,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7B,KAAK;CACN,CAAC,CAAA;AAEF,MAAa,WAAW;IACf,KAAK,CAAC,IAAI,CACf,SAA4B,EAC5B,KAAQ,EACR,KAAkB;QAElB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAC1C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;YACpC,OAAO,qBAAqB,EAAE,CAAA;QAChC,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;QACjE,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,KAAK,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IAClF,CAAC;IAEO,aAAa,CAAC,UAAiC;QACrD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAA;IAClC,CAAC;IAEO,KAAK,CAAC,QAAQ,CACpB,SAA4B,EAC5B,KAAQ,EACR,UAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QACzD,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,CAAA;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;QAClE,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAA;QACxD,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,CAAA;IAC7C,CAAC;IAEO,WAAW,CAAC,KAAiB;QACnC,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,IAAI,EAAE,CAAA;QACrD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,uBAAuB,CAAC,KAAK,CAAC,CAAA;QACvC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,CAAA;IAC3C,CAAC;IAEO,kBAAkB,CACxB,OAA0B,EAC1B,UAAiC,EACjC,UAAmB;QAEnB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,OAAO,CAAA;QACvC,MAAM,QAAQ,GAAG;YACf,WAAW,EAAE,YAAY;YACzB,4EAA4E;YAC5E,eAAe,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;SAC5C,CAAA;QAED,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAA;IACxC,CAAC;IAEO,WAAW,CAAiB,KAAQ,EAAE,UAAiC;QAC7E,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAA;QACzC,OAAO,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,CAAA;IAC3D,CAAC;IAEO,iBAAiB,CAAC,KAAY,EAAE,IAAsB;QAC5D,MAAM,WAAW,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;QAC9B,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAA;QAC9C,IAAI,YAAY,EAAE,CAAC;YACjB,WAAW,CAAC,GAAG,EAAE,CAAA;QACnB,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;CACF;AAlED,kCAkEC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { ApiOperationOptions } from '@nestjs/swagger';
|
|
2
|
+
import { QueryService } from '@ptc-org/nestjs-query-core';
|
|
3
|
+
import { DTONamesOpts } from '../common';
|
|
4
|
+
import { QueryOptionsDecoratorOpts, QueryResolverMethodOpts } from '../decorators';
|
|
5
|
+
import { PagingStrategies, QueryArgsTypeOpts } from '../types/query';
|
|
6
|
+
export type NamedEndpoint = {
|
|
7
|
+
/** Specify the REST endpoint path. */
|
|
8
|
+
path?: string;
|
|
9
|
+
/** Specify a description for the REST endpoint. */
|
|
10
|
+
description?: string;
|
|
11
|
+
operationOptions?: ApiOperationOptions;
|
|
12
|
+
};
|
|
13
|
+
export interface ControllerOpts extends QueryResolverMethodOpts, DTONamesOpts {
|
|
14
|
+
/**
|
|
15
|
+
* Options for single-record REST endpoints.
|
|
16
|
+
*/
|
|
17
|
+
one?: QueryResolverMethodOpts & NamedEndpoint;
|
|
18
|
+
/**
|
|
19
|
+
* Options for multiple-record REST endpoints.
|
|
20
|
+
*/
|
|
21
|
+
many?: QueryResolverMethodOpts & NamedEndpoint;
|
|
22
|
+
}
|
|
23
|
+
export type MutationOpts = Omit<ControllerOpts, 'many'>;
|
|
24
|
+
/** @internal */
|
|
25
|
+
export interface ServiceController<DTO, QS extends QueryService<DTO, unknown, unknown>> {
|
|
26
|
+
service: QS;
|
|
27
|
+
}
|
|
28
|
+
/** @internal */
|
|
29
|
+
export interface ControllerClass<DTO, QS extends QueryService<DTO, unknown, unknown>, Resolver extends ServiceController<DTO, QS>> {
|
|
30
|
+
new (service: QS): Resolver;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
* Base Resolver that takes in a service as a constructor argument.
|
|
35
|
+
*/
|
|
36
|
+
export declare class BaseServiceResolver<DTO, QS> {
|
|
37
|
+
readonly service: QS;
|
|
38
|
+
constructor(service: QS);
|
|
39
|
+
}
|
|
40
|
+
export type ExtractPagingStrategy<DTO, Opts extends QueryArgsTypeOpts<DTO>> = Opts['pagingStrategy'] extends PagingStrategies ? Opts['pagingStrategy'] : PagingStrategies.NONE;
|
|
41
|
+
export type MergePagingStrategyOpts<DTO, Opts extends QueryOptionsDecoratorOpts<DTO>, S extends PagingStrategies = PagingStrategies.NONE> = Opts['pagingStrategy'] extends PagingStrategies ? Opts : S extends PagingStrategies ? Omit<Opts, 'pagingStrategy'> & {
|
|
42
|
+
pagingStrategy: S;
|
|
43
|
+
} : Opts;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.BaseServiceResolver = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
* Base Resolver that takes in a service as a constructor argument.
|
|
7
|
+
*/
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
9
|
+
class BaseServiceResolver {
|
|
10
|
+
constructor(service) {
|
|
11
|
+
this.service = service;
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
exports.BaseServiceResolver = BaseServiceResolver;
|
|
15
|
+
//# sourceMappingURL=controller.interface.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"controller.interface.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/controllers/controller.interface.ts"],"names":[],"mappings":";;;AA0CA;;;GAGG;AACH,6DAA6D;AAC7D,MAAa,mBAAmB;IAC9B,YAAqB,OAAW;QAAX,YAAO,GAAP,OAAO,CAAI;IAAG,CAAC;CACrC;AAFD,kDAEC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { Class, DeepPartial, Filter, QueryService } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { MutationArgsType } from '../';
|
|
3
|
+
import { CreateOneInputType } from '../types';
|
|
4
|
+
import { ParamArgsType } from '../types/param-args.type';
|
|
5
|
+
import { ControllerClass, MutationOpts, ServiceController } from './controller.interface';
|
|
6
|
+
export interface CreateResolverOpts<DTO, C = DeepPartial<DTO>> extends MutationOpts {
|
|
7
|
+
/**
|
|
8
|
+
* The Input DTO that should be used to create records.
|
|
9
|
+
*/
|
|
10
|
+
CreateDTOClass?: Class<C>;
|
|
11
|
+
/**
|
|
12
|
+
* The class to be used for `createOne` input.
|
|
13
|
+
*/
|
|
14
|
+
CreateOneInput?: Class<CreateOneInputType<C>>;
|
|
15
|
+
}
|
|
16
|
+
export interface CreateController<DTO, C, QS extends QueryService<DTO, C, unknown>> extends ServiceController<DTO, QS> {
|
|
17
|
+
createOne(id: ParamArgsType, input: MutationArgsType<CreateOneInputType<C>>, authorizeFilter?: Filter<DTO>): Promise<DTO>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @internal
|
|
21
|
+
* Mixin to add `create` REST endpoints.
|
|
22
|
+
*/
|
|
23
|
+
export declare const Creatable: <DTO, C, QS extends QueryService<DTO, C, unknown>>(DTOClass: Class<DTO>, opts: CreateResolverOpts<DTO, C>) => <B extends Class<ServiceController<DTO, QS>>>(BaseClass: B) => Class<CreateController<DTO, C, QS>> & B;
|
|
24
|
+
/**
|
|
25
|
+
* Factory to create a new abstract class that can be extended to add `create` endpoints.
|
|
26
|
+
*
|
|
27
|
+
* Assume we have `TodoItemDTO`, you can create a controller with a `POST` endpoint using the following code.
|
|
28
|
+
*
|
|
29
|
+
* ```ts
|
|
30
|
+
* import { Controller } from '@nestjs/common'
|
|
31
|
+
* import { CreateController } from '@ptc-org/nestjs-query-rest'
|
|
32
|
+
*
|
|
33
|
+
* @Controller('todo-items')
|
|
34
|
+
* export class TodoItemController extends CreateController(TodoItemDTO) {
|
|
35
|
+
* constructor(readonly service: TodoItemService) {
|
|
36
|
+
* super(service)
|
|
37
|
+
* }
|
|
38
|
+
* }
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @param DTOClass - The DTO class returned from the `createOne` endpoint.
|
|
42
|
+
* @param opts - Options to customize endpoints.
|
|
43
|
+
* @typeparam DTO - The type of DTO that should be created.
|
|
44
|
+
* @typeparam C - The create DTO type.
|
|
45
|
+
*/
|
|
46
|
+
export declare const CreateController: <DTO, C = DeepPartial<DTO>, QS extends QueryService<DTO, C, unknown> = QueryService<DTO, C, unknown>>(DTOClass: Class<DTO>, opts?: CreateResolverOpts<DTO, C>) => ControllerClass<DTO, QS, CreateController<DTO, C, QS>>;
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CreateController = exports.Creatable = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
// eslint-disable-next-line max-classes-per-file
|
|
6
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
7
|
+
const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
|
|
8
|
+
const __1 = require("../");
|
|
9
|
+
const auth_1 = require("../auth");
|
|
10
|
+
const common_1 = require("../common");
|
|
11
|
+
const decorators_1 = require("../decorators");
|
|
12
|
+
const hook_args_decorator_1 = require("../decorators/hook-args.decorator");
|
|
13
|
+
const param_args_decorator_1 = require("../decorators/param-args.decorator");
|
|
14
|
+
const interceptors_1 = require("../interceptors");
|
|
15
|
+
const authorizer_interceptor_1 = require("../interceptors/authorizer.interceptor");
|
|
16
|
+
const types_1 = require("../types");
|
|
17
|
+
const param_args_type_1 = require("../types/param-args.type");
|
|
18
|
+
const controller_interface_1 = require("./controller.interface");
|
|
19
|
+
/** @internal */
|
|
20
|
+
const defaultCreateDTO = (dtoNames, DTOClass) => {
|
|
21
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
class DefaultCreateDTO extends (0, swagger_1.OmitType)(DTOClass, []) {
|
|
24
|
+
}
|
|
25
|
+
return DefaultCreateDTO;
|
|
26
|
+
};
|
|
27
|
+
/** @internal */
|
|
28
|
+
const defaultCreateOneInput = (dtoNames, InputDTO) => {
|
|
29
|
+
return (0, types_1.CreateOneInputType)(InputDTO);
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
* Mixin to add `create` REST endpoints.
|
|
34
|
+
*/
|
|
35
|
+
const Creatable = (DTOClass, opts) => (BaseClass) => {
|
|
36
|
+
if (opts.disabled) {
|
|
37
|
+
return BaseClass;
|
|
38
|
+
}
|
|
39
|
+
const dtoNames = (0, common_1.getDTONames)(DTOClass, opts);
|
|
40
|
+
const { CreateDTOClass = defaultCreateDTO(dtoNames, DTOClass), CreateOneInput = defaultCreateOneInput(dtoNames, CreateDTOClass) } = opts;
|
|
41
|
+
const commonResolverOpts = (0, lodash_omit_1.default)(opts, 'dtoName', 'one', 'many', 'CreateDTOClass', 'CreateOneInput', 'CreateManyInput');
|
|
42
|
+
let COI = class COI extends (0, __1.MutationArgsType)(CreateOneInput) {
|
|
43
|
+
};
|
|
44
|
+
COI = tslib_1.__decorate([
|
|
45
|
+
(0, __1.ApiSchema)({ name: `Create${DTOClass.name}` })
|
|
46
|
+
], COI);
|
|
47
|
+
let COP = class COP extends (0, param_args_type_1.ParamArgsType)(CreateDTOClass) {
|
|
48
|
+
};
|
|
49
|
+
COP = tslib_1.__decorate([
|
|
50
|
+
(0, __1.ApiSchema)({ name: `Create${DTOClass.name}Args` })
|
|
51
|
+
], COP);
|
|
52
|
+
class CreateControllerBase extends BaseClass {
|
|
53
|
+
async createOne(params, { input }, // eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
54
|
+
authorizeFilter) {
|
|
55
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
56
|
+
// @ts-ignore
|
|
57
|
+
return this.service.createOne({
|
|
58
|
+
...params,
|
|
59
|
+
...input
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
tslib_1.__decorate([
|
|
64
|
+
(0, __1.Post)(() => DTOClass, {
|
|
65
|
+
disabled: opts.disabled,
|
|
66
|
+
path: opts.one?.path,
|
|
67
|
+
operation: {
|
|
68
|
+
operationId: `${dtoNames.pluralBaseNameLower}.createOne`,
|
|
69
|
+
tags: [...(opts.tags || []), ...(opts.one?.tags ?? [])],
|
|
70
|
+
description: opts?.one?.description,
|
|
71
|
+
...opts?.one?.operationOptions
|
|
72
|
+
},
|
|
73
|
+
body: {
|
|
74
|
+
type: COI
|
|
75
|
+
}
|
|
76
|
+
}, {
|
|
77
|
+
interceptors: [(0, interceptors_1.HookInterceptor)(__1.HookTypes.BEFORE_CREATE_ONE, CreateDTOClass, DTOClass), (0, authorizer_interceptor_1.AuthorizerInterceptor)(DTOClass)]
|
|
78
|
+
}, commonResolverOpts, opts.one ?? {}),
|
|
79
|
+
tslib_1.__param(0, (0, param_args_decorator_1.ParamArgs)()),
|
|
80
|
+
tslib_1.__param(1, (0, hook_args_decorator_1.BodyHookArgs)()),
|
|
81
|
+
tslib_1.__param(2, (0, decorators_1.AuthorizerFilter)({
|
|
82
|
+
operationGroup: auth_1.OperationGroup.CREATE,
|
|
83
|
+
many: false
|
|
84
|
+
})),
|
|
85
|
+
tslib_1.__metadata("design:type", Function),
|
|
86
|
+
tslib_1.__metadata("design:paramtypes", [COP,
|
|
87
|
+
COI, Object]),
|
|
88
|
+
tslib_1.__metadata("design:returntype", Promise)
|
|
89
|
+
], CreateControllerBase.prototype, "createOne", null);
|
|
90
|
+
return CreateControllerBase;
|
|
91
|
+
};
|
|
92
|
+
exports.Creatable = Creatable;
|
|
93
|
+
/**
|
|
94
|
+
* Factory to create a new abstract class that can be extended to add `create` endpoints.
|
|
95
|
+
*
|
|
96
|
+
* Assume we have `TodoItemDTO`, you can create a controller with a `POST` endpoint using the following code.
|
|
97
|
+
*
|
|
98
|
+
* ```ts
|
|
99
|
+
* import { Controller } from '@nestjs/common'
|
|
100
|
+
* import { CreateController } from '@ptc-org/nestjs-query-rest'
|
|
101
|
+
*
|
|
102
|
+
* @Controller('todo-items')
|
|
103
|
+
* export class TodoItemController extends CreateController(TodoItemDTO) {
|
|
104
|
+
* constructor(readonly service: TodoItemService) {
|
|
105
|
+
* super(service)
|
|
106
|
+
* }
|
|
107
|
+
* }
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @param DTOClass - The DTO class returned from the `createOne` endpoint.
|
|
111
|
+
* @param opts - Options to customize endpoints.
|
|
112
|
+
* @typeparam DTO - The type of DTO that should be created.
|
|
113
|
+
* @typeparam C - The create DTO type.
|
|
114
|
+
*/
|
|
115
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare -- intentional
|
|
116
|
+
const CreateController = (DTOClass, opts = {}) => (0, exports.Creatable)(DTOClass, opts)(controller_interface_1.BaseServiceResolver);
|
|
117
|
+
exports.CreateController = CreateController;
|
|
118
|
+
//# sourceMappingURL=create.controller.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create.controller.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/controllers/create.controller.ts"],"names":[],"mappings":";;;;AAAA,gDAAgD;AAChD,6CAA0C;AAE1C,sEAA8B;AAE9B,2BAAkE;AAClE,kCAAwC;AACxC,sCAAiD;AACjD,8CAAgD;AAChD,2EAAgE;AAChE,6EAA8D;AAC9D,kDAAiD;AACjD,mFAA8E;AAC9E,oCAA6C;AAC7C,8DAAwD;AACxD,iEAA8G;AAiB9G,gBAAgB;AAChB,MAAM,gBAAgB,GAAG,CAAS,QAAkB,EAAE,QAAoB,EAAY,EAAE;IACtF,6DAA6D;IAC7D,aAAa;IACb,MAAM,gBAAiB,SAAQ,IAAA,kBAAQ,EAAC,QAAQ,EAAE,EAAE,CAAC;KAAG;IAExD,OAAO,gBAA4B,CAAA;AACrC,CAAC,CAAA;AAED,gBAAgB;AAChB,MAAM,qBAAqB,GAAG,CAAI,QAAkB,EAAE,QAAkB,EAAgC,EAAE;IACxG,OAAO,IAAA,0BAAkB,EAAC,QAAQ,CAAC,CAAA;AACrC,CAAC,CAAA;AAED;;;GAGG;AACI,MAAM,SAAS,GACpB,CAAmD,QAAoB,EAAE,IAAgC,EAAE,EAAE,CAC7G,CAA8C,SAAY,EAA2C,EAAE;IACrG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,OAAO,SAAkB,CAAA;IAC3B,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAE5C,MAAM,EACJ,cAAc,GAAG,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACrD,cAAc,GAAG,qBAAqB,CAAC,QAAQ,EAAE,cAAc,CAAC,EACjE,GAAG,IAAI,CAAA;IAER,MAAM,kBAAkB,GAAG,IAAA,qBAAI,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAA;IAGtH,IAAM,GAAG,GAAT,MAAM,GAAI,SAAQ,IAAA,oBAAgB,EAAC,cAAc,CAAC;KAAG,CAAA;IAA/C,GAAG;QADR,IAAA,aAAS,EAAC,EAAE,IAAI,EAAE,SAAS,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;OACxC,GAAG,CAA4C;IAGrD,IAAM,GAAG,GAAT,MAAM,GAAI,SAAQ,IAAA,+BAAa,EAAC,cAAc,CAAC;KAAG,CAAA;IAA5C,GAAG;QADR,IAAA,aAAS,EAAC,EAAE,IAAI,EAAE,SAAS,QAAQ,CAAC,IAAI,MAAM,EAAE,CAAC;OAC5C,GAAG,CAAyC;IAElD,MAAM,oBAAqB,SAAQ,SAAS;QAsB7B,AAAN,KAAK,CAAC,SAAS,CACP,MAAW,EACR,EAAE,KAAK,EAAO,EAI3B,6DAA6D;QAChE,eAA6B;YAE7B,6DAA6D;YAC7D,aAAa;YACb,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBAC5B,GAAG,MAAM;gBACT,GAAG,KAAK;aACT,CAAC,CAAA;QACJ,CAAC;KACF;IAhBc;QArBZ,IAAA,QAAI,EACH,GAAG,EAAE,CAAC,QAAQ,EACd;YACE,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI;YACpB,SAAS,EAAE;gBACT,WAAW,EAAE,GAAG,QAAQ,CAAC,mBAAmB,YAAY;gBACxD,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;gBACvD,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW;gBACnC,GAAG,IAAI,EAAE,GAAG,EAAE,gBAAgB;aAC/B;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG;aACV;SACF,EACD;YACE,YAAY,EAAE,CAAC,IAAA,8BAAe,EAAC,aAAS,CAAC,iBAAiB,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,IAAA,8CAAqB,EAAC,QAAQ,CAAC,CAAC;SACxH,EACD,kBAAkB,EAClB,IAAI,CAAC,GAAG,IAAI,EAAE,CACf;QAEE,mBAAA,IAAA,gCAAS,GAAE,CAAA;QACX,mBAAA,IAAA,kCAAY,GAAE,CAAA;QACd,mBAAA,IAAA,6BAAgB,EAAC;YAChB,cAAc,EAAE,qBAAc,CAAC,MAAM;YACrC,IAAI,EAAE,KAAK;SACZ,CAAC,CAAA;;iDALmB,GAAG;YACG,GAAG;;yDAa/B;IAGH,OAAO,oBAAoB,CAAA;AAC7B,CAAC,CAAA;AA/DU,QAAA,SAAS,aA+DnB;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,0EAA0E;AACnE,MAAM,gBAAgB,GAAG,CAK9B,QAAoB,EACpB,OAAmC,EAAE,EACmB,EAAE,CAAC,IAAA,iBAAS,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,0CAAmB,CAAC,CAAA;AAP9F,QAAA,gBAAgB,oBAO8E"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Class, DeepPartial, QueryService } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { ConnectionOptions } from '../connection/interfaces';
|
|
3
|
+
import { BaseResolverOptions } from '../decorators';
|
|
4
|
+
import { PagingStrategies } from '../types/query';
|
|
5
|
+
import { ControllerClass, MergePagingStrategyOpts } from './controller.interface';
|
|
6
|
+
import { CreateController, CreateResolverOpts } from './create.controller';
|
|
7
|
+
import { DeleteController, DeleteResolverOpts } from './delete.controller';
|
|
8
|
+
import { ExportController, ExportControllerOpts } from './export.controller';
|
|
9
|
+
import { ReadControllerFromOpts, ReadControllerOpts } from './read.controller';
|
|
10
|
+
import { UpdateController, UpdateControllerOpts } from './update.controller';
|
|
11
|
+
export interface CRUDControllerOpts<DTO, C = DeepPartial<DTO>, U = DeepPartial<DTO>, R = ReadControllerOpts<DTO>, PS extends PagingStrategies = PagingStrategies.NONE, E = DeepPartial<DTO>> extends BaseResolverOptions, Pick<ConnectionOptions, 'enableTotalCount'> {
|
|
12
|
+
/**
|
|
13
|
+
* The DTO that should be used as input for create endpoints.
|
|
14
|
+
*/
|
|
15
|
+
CreateDTOClass?: Class<C>;
|
|
16
|
+
/**
|
|
17
|
+
* The DTO that should be used as input for update endpoints.
|
|
18
|
+
*/
|
|
19
|
+
UpdateDTOClass?: Class<U>;
|
|
20
|
+
/**
|
|
21
|
+
* The DTO that should be used for filter of the aggregate endpoint.
|
|
22
|
+
*/
|
|
23
|
+
pagingStrategy?: PS;
|
|
24
|
+
create?: CreateResolverOpts<DTO, C>;
|
|
25
|
+
read?: R;
|
|
26
|
+
update?: UpdateControllerOpts<DTO, U>;
|
|
27
|
+
delete?: DeleteResolverOpts;
|
|
28
|
+
export?: ExportControllerOpts<DTO, E>;
|
|
29
|
+
basePath?: string;
|
|
30
|
+
tags?: string[];
|
|
31
|
+
}
|
|
32
|
+
export interface CRUDController<DTO, C, U, R extends ReadControllerOpts<DTO>, QS extends QueryService<DTO, C, U> = QueryService<DTO, C, U>> extends CreateController<DTO, C, QS>, ReadControllerFromOpts<DTO, R, QS>, UpdateController<DTO, U, QS>, DeleteController<DTO, QS>, ExportController<DTO, QS> {
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Factory to create a controller that includes create, read, update, delete, and export endpoints.
|
|
36
|
+
*
|
|
37
|
+
* ```ts
|
|
38
|
+
* import { Controller } from '@nestjs/common'
|
|
39
|
+
* import { CRUDController } from '@ptc-org/nestjs-query-rest'
|
|
40
|
+
*
|
|
41
|
+
* @Controller('todo-items')
|
|
42
|
+
* export class TodoItemController extends CRUDController(TodoItemDTO) {
|
|
43
|
+
* constructor(readonly service: TodoItemService) {
|
|
44
|
+
* super(service)
|
|
45
|
+
* }
|
|
46
|
+
* }
|
|
47
|
+
* ```
|
|
48
|
+
* @param DTOClass - The DTO class that the controller is for. All endpoints use types derived from this class.
|
|
49
|
+
* @param opts - Options to customize the controller endpoints.
|
|
50
|
+
*/
|
|
51
|
+
export declare const CRUDController: <DTO, C = DeepPartial<DTO>, U = DeepPartial<DTO>, R extends ReadControllerOpts<DTO> = ReadControllerOpts<DTO>, PS extends PagingStrategies = PagingStrategies.NONE, E = DeepPartial<DTO>>(DTOClass: Class<DTO>, opts?: CRUDControllerOpts<DTO, C, U, R, PS, E>) => ControllerClass<DTO, QueryService<DTO, C, U>, CRUDController<DTO, C, U, MergePagingStrategyOpts<DTO, R, PS>>>;
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CRUDController = void 0;
|
|
4
|
+
const common_1 = require("../common");
|
|
5
|
+
const create_controller_1 = require("./create.controller");
|
|
6
|
+
const delete_controller_1 = require("./delete.controller");
|
|
7
|
+
const export_controller_1 = require("./export.controller");
|
|
8
|
+
const read_controller_1 = require("./read.controller");
|
|
9
|
+
const update_controller_1 = require("./update.controller");
|
|
10
|
+
// DeleteResolver<DTO, QS>,
|
|
11
|
+
// AggregateResolver<DTO, QS> {
|
|
12
|
+
// function extractAggregateResolverOpts<DTO>(
|
|
13
|
+
// opts: CRUDResolverOpts<DTO, unknown, unknown, ReadResolverOpts<DTO>, PagingStrategies>
|
|
14
|
+
// ): AggregateResolverOpts<DTO> {
|
|
15
|
+
// const { AggregateDTOClass, enableAggregate, aggregate } = opts
|
|
16
|
+
// return mergeBaseResolverOpts<AggregateResolverOpts<DTO>>({ enabled: enableAggregate, AggregateDTOClass, ...aggregate }, opts)
|
|
17
|
+
// }
|
|
18
|
+
function extractCreateResolverOpts(opts) {
|
|
19
|
+
const { CreateDTOClass, create } = opts;
|
|
20
|
+
return (0, common_1.mergeBaseResolverOpts)({ CreateDTOClass, ...create }, opts);
|
|
21
|
+
}
|
|
22
|
+
function extractReadResolverOpts(opts) {
|
|
23
|
+
const { enableTotalCount, pagingStrategy, read } = opts;
|
|
24
|
+
return (0, common_1.mergeBaseResolverOpts)({
|
|
25
|
+
enableTotalCount,
|
|
26
|
+
pagingStrategy,
|
|
27
|
+
...read
|
|
28
|
+
}, opts);
|
|
29
|
+
}
|
|
30
|
+
function extractUpdateResolverOpts(opts) {
|
|
31
|
+
const { UpdateDTOClass, update } = opts;
|
|
32
|
+
return (0, common_1.mergeBaseResolverOpts)({ UpdateDTOClass, ...update }, opts);
|
|
33
|
+
}
|
|
34
|
+
function extractDeleteResolverOpts(opts) {
|
|
35
|
+
const { delete: deleteArgs = {} } = opts;
|
|
36
|
+
return (0, common_1.mergeBaseResolverOpts)(deleteArgs, opts);
|
|
37
|
+
}
|
|
38
|
+
function extractExportResolverOpts(opts) {
|
|
39
|
+
const { export: exportArgs = {} } = opts;
|
|
40
|
+
return (0, common_1.mergeBaseResolverOpts)(exportArgs, opts);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Factory to create a controller that includes create, read, update, delete, and export endpoints.
|
|
44
|
+
*
|
|
45
|
+
* ```ts
|
|
46
|
+
* import { Controller } from '@nestjs/common'
|
|
47
|
+
* import { CRUDController } from '@ptc-org/nestjs-query-rest'
|
|
48
|
+
*
|
|
49
|
+
* @Controller('todo-items')
|
|
50
|
+
* export class TodoItemController extends CRUDController(TodoItemDTO) {
|
|
51
|
+
* constructor(readonly service: TodoItemService) {
|
|
52
|
+
* super(service)
|
|
53
|
+
* }
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
56
|
+
* @param DTOClass - The DTO class that the controller is for. All endpoints use types derived from this class.
|
|
57
|
+
* @param opts - Options to customize the controller endpoints.
|
|
58
|
+
*/
|
|
59
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare -- intentional
|
|
60
|
+
const CRUDController = (DTOClass, opts = {}) => {
|
|
61
|
+
const readable = (0, read_controller_1.Readable)(DTOClass, extractReadResolverOpts(opts));
|
|
62
|
+
const updatable = (0, update_controller_1.Updateable)(DTOClass, extractUpdateResolverOpts(opts));
|
|
63
|
+
const deletable = (0, delete_controller_1.Deletable)(DTOClass, extractDeleteResolverOpts(opts));
|
|
64
|
+
const exportable = (0, export_controller_1.Exportable)(DTOClass, extractExportResolverOpts(opts));
|
|
65
|
+
return exportable(readable(deletable(updatable((0, create_controller_1.CreateController)(DTOClass, extractCreateResolverOpts(opts))))));
|
|
66
|
+
};
|
|
67
|
+
exports.CRUDController = CRUDController;
|
|
68
|
+
//# sourceMappingURL=crud.controller.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"crud.controller.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/controllers/crud.controller.ts"],"names":[],"mappings":";;;AAEA,sCAAiD;AAKjD,2DAA0E;AAC1E,2DAAqF;AACrF,2DAAwF;AACxF,uDAAwF;AACxF,2DAAwF;AAgDxF,2BAA2B;AAC3B,+BAA+B;AAE/B,8CAA8C;AAC9C,2FAA2F;AAC3F,kCAAkC;AAClC,mEAAmE;AACnE,kIAAkI;AAClI,IAAI;AAEJ,SAAS,yBAAyB,CAChC,IAA6F;IAE7F,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IACvC,OAAO,IAAA,8BAAqB,EAA6B,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,CAAA;AAC/F,CAAC;AAED,SAAS,uBAAuB,CAC9B,IAA6E;IAE7E,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;IACvD,OAAO,IAAA,8BAAqB,EAC1B;QACE,gBAAgB;QAChB,cAAc;QACd,GAAG,IAAI;KAC+B,EACxC,IAAI,CACL,CAAA;AACH,CAAC;AAED,SAAS,yBAAyB,CAChC,IAA6F;IAE7F,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IACvC,OAAO,IAAA,8BAAqB,EAA+B,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,CAAA;AACjG,CAAC;AAED,SAAS,yBAAyB,CAChC,IAAmG;IAEnG,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAA;IACxC,OAAO,IAAA,8BAAqB,EAAqB,UAAU,EAAE,IAAI,CAAC,CAAA;AACpE,CAAC;AAED,SAAS,yBAAyB,CAChC,IAA6F;IAE7F,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAA;IACxC,OAAO,IAAA,8BAAqB,EAA+B,UAAU,EAAE,IAAI,CAAC,CAAA;AAC9E,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,0EAA0E;AACnE,MAAM,cAAc,GAAG,CAQ5B,QAAoB,EACpB,OAAgD,EAAE,EAC6D,EAAE;IACjH,MAAM,QAAQ,GAAG,IAAA,0BAAQ,EAAC,QAAQ,EAAE,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAA;IAClE,MAAM,SAAS,GAAG,IAAA,8BAAU,EAAC,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAA;IACvE,MAAM,SAAS,GAAG,IAAA,6BAAS,EAAC,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAA;IACtE,MAAM,UAAU,GAAG,IAAA,8BAAU,EAAC,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAA;IAExE,OAAO,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,IAAA,oCAAgB,EAAC,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAChH,CAAC,CAAA;AAjBY,QAAA,cAAc,kBAiB1B"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { Class, Filter, QueryService } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { ParamArgsType } from '../';
|
|
3
|
+
import { ControllerClass, MutationOpts, ServiceController } from './controller.interface';
|
|
4
|
+
export interface DeleteResolverOpts extends MutationOpts {
|
|
5
|
+
/**
|
|
6
|
+
* Use soft delete when doing delete mutation
|
|
7
|
+
*/
|
|
8
|
+
useSoftDelete?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface DeleteController<DTO, QS extends QueryService<DTO, unknown, unknown>> extends ServiceController<DTO, QS> {
|
|
11
|
+
deleteOne(id: ParamArgsType, authorizeFilter?: Filter<DTO>): Promise<Partial<DTO>>;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
* Mixin to add `delete` REST endpoints.
|
|
16
|
+
*/
|
|
17
|
+
export declare const Deletable: <DTO, QS extends QueryService<DTO, unknown, unknown>>(DTOClass: Class<DTO>, opts: DeleteResolverOpts) => <B extends Class<ServiceController<DTO, QS>>>(BaseClass: B) => Class<DeleteController<DTO, QS>> & B;
|
|
18
|
+
export declare const DeleteController: <DTO, QS extends QueryService<DTO, unknown, unknown> = QueryService<DTO, unknown, unknown>>(DTOClass: Class<DTO>, opts?: DeleteResolverOpts) => ControllerClass<DTO, QS, DeleteController<DTO, QS>>;
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DeleteController = exports.Deletable = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
|
|
6
|
+
const __1 = require("../");
|
|
7
|
+
const common_1 = require("../common");
|
|
8
|
+
const param_args_decorator_1 = require("../decorators/param-args.decorator");
|
|
9
|
+
const controller_interface_1 = require("./controller.interface");
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
* Mixin to add `delete` REST endpoints.
|
|
13
|
+
*/
|
|
14
|
+
const Deletable = (DTOClass, opts) => (BaseClass) => {
|
|
15
|
+
if (opts.disabled) {
|
|
16
|
+
return BaseClass;
|
|
17
|
+
}
|
|
18
|
+
const dtoNames = (0, common_1.getDTONames)(DTOClass, opts);
|
|
19
|
+
const commonResolverOpts = (0, lodash_omit_1.default)(opts, 'dtoName', 'one', 'many', 'DeleteOneInput', 'DeleteManyInput', 'useSoftDelete');
|
|
20
|
+
class DOP extends (0, __1.ParamArgsType)(DTOClass) {
|
|
21
|
+
}
|
|
22
|
+
Object.defineProperty(DOP, 'name', {
|
|
23
|
+
writable: false,
|
|
24
|
+
// set a unique name otherwise DI does not inject a unique one for each request
|
|
25
|
+
value: `FindDelete${DTOClass.name}Args`
|
|
26
|
+
});
|
|
27
|
+
class DeleteResolverBase extends BaseClass {
|
|
28
|
+
async deleteOne(params, authorizeFilter) {
|
|
29
|
+
return this.service.deleteOne(params.getId(), {
|
|
30
|
+
filter: authorizeFilter ?? {},
|
|
31
|
+
useSoftDelete: opts?.useSoftDelete ?? false
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
tslib_1.__decorate([
|
|
36
|
+
(0, __1.Delete)(() => DTOClass, {
|
|
37
|
+
path: opts?.one?.path ?? ':id',
|
|
38
|
+
operation: {
|
|
39
|
+
operationId: `${dtoNames.pluralBaseNameLower}.deleteOne`,
|
|
40
|
+
tags: [...(opts.tags || []), ...(opts.one?.tags ?? [])],
|
|
41
|
+
description: opts?.one?.description,
|
|
42
|
+
...opts?.one?.operationOptions
|
|
43
|
+
}
|
|
44
|
+
}, { interceptors: [(0, __1.AuthorizerInterceptor)(DTOClass)] }, commonResolverOpts, opts.one ?? {}),
|
|
45
|
+
tslib_1.__param(0, (0, param_args_decorator_1.ParamArgs)()),
|
|
46
|
+
tslib_1.__param(1, (0, __1.AuthorizerFilter)({
|
|
47
|
+
operationGroup: __1.OperationGroup.DELETE,
|
|
48
|
+
many: false
|
|
49
|
+
})),
|
|
50
|
+
tslib_1.__metadata("design:type", Function),
|
|
51
|
+
tslib_1.__metadata("design:paramtypes", [DOP, Object]),
|
|
52
|
+
tslib_1.__metadata("design:returntype", Promise)
|
|
53
|
+
], DeleteResolverBase.prototype, "deleteOne", null);
|
|
54
|
+
return DeleteResolverBase;
|
|
55
|
+
};
|
|
56
|
+
exports.Deletable = Deletable;
|
|
57
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare -- intentional
|
|
58
|
+
const DeleteController = (DTOClass, opts = {}) => (0, exports.Deletable)(DTOClass, opts)(controller_interface_1.BaseServiceResolver);
|
|
59
|
+
exports.DeleteController = DeleteController;
|
|
60
|
+
//# sourceMappingURL=delete.controller.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delete.controller.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/controllers/delete.controller.ts"],"names":[],"mappings":";;;;AAEA,sEAA8B;AAE9B,2BAAoG;AACpG,sCAAuC;AACvC,6EAA8D;AAC9D,iEAA8G;AAa9G;;;GAGG;AACI,MAAM,SAAS,GACpB,CAAsD,QAAoB,EAAE,IAAwB,EAAE,EAAE,CACxG,CAA8C,SAAY,EAAwC,EAAE;IAClG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,OAAO,SAAkB,CAAA;IAC3B,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAE5C,MAAM,kBAAkB,GAAG,IAAA,qBAAI,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAA;IAErH,MAAM,GAAI,SAAQ,IAAA,iBAAa,EAAC,QAAQ,CAAC;KAAG;IAE5C,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE;QACjC,QAAQ,EAAE,KAAK;QACf,+EAA+E;QAC/E,KAAK,EAAE,aAAa,QAAQ,CAAC,IAAI,MAAM;KACxC,CAAC,CAAA;IAEF,MAAM,kBAAmB,SAAQ,SAAS;QAgBlC,AAAN,KAAK,CAAC,SAAS,CACA,MAAW,EAKxB,eAA6B;YAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE;gBAC5C,MAAM,EAAE,eAAe,IAAI,EAAE;gBAC7B,aAAa,EAAE,IAAI,EAAE,aAAa,IAAI,KAAK;aAC5C,CAAC,CAAA;QACJ,CAAC;KACF;IAbO;QAfL,IAAA,UAAM,EACL,GAAG,EAAE,CAAC,QAAQ,EACd;YACE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,IAAI,KAAK;YAC9B,SAAS,EAAE;gBACT,WAAW,EAAE,GAAG,QAAQ,CAAC,mBAAmB,YAAY;gBACxD,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;gBACvD,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW;gBACnC,GAAG,IAAI,EAAE,GAAG,EAAE,gBAAgB;aAC/B;SACF,EACD,EAAE,YAAY,EAAE,CAAC,IAAA,yBAAqB,EAAC,QAAQ,CAAC,CAAC,EAAE,EACnD,kBAAkB,EAClB,IAAI,CAAC,GAAG,IAAI,EAAE,CACf;QAEE,mBAAA,IAAA,gCAAS,GAAE,CAAA;QACX,mBAAA,IAAA,oBAAgB,EAAC;YAChB,cAAc,EAAE,kBAAc,CAAC,MAAM;YACrC,IAAI,EAAE,KAAK;SACZ,CAAC,CAAA;;iDAJmB,GAAG;;uDAWzB;IAGH,OAAO,kBAAkB,CAAA;AAC3B,CAAC,CAAA;AAnDU,QAAA,SAAS,aAmDnB;AACH,0EAA0E;AACnE,MAAM,gBAAgB,GAAG,CAC9B,QAAoB,EACpB,OAA2B,EAAE,EACwB,EAAE,CAAC,IAAA,iBAAS,EAAU,QAAQ,EAAE,IAAI,CAAC,CAAC,0CAAmB,CAAC,CAAA;AAHpG,QAAA,gBAAgB,oBAGoF"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { Class, DeepPartial, Filter, QueryService } from '@ptc-org/nestjs-query-core';
|
|
2
|
+
import { NonePagingQueryArgsTypeOpts, QueryType } from '../';
|
|
3
|
+
import { PagingStrategies, StaticQueryType } from '../types/query';
|
|
4
|
+
import { ControllerClass, ControllerOpts, ServiceController } from './controller.interface';
|
|
5
|
+
export type ExportControllerOpts<DTO, ExportDTO = DeepPartial<DTO>> = {
|
|
6
|
+
QueryArgs?: StaticQueryType<DTO, PagingStrategies>;
|
|
7
|
+
limit?: number;
|
|
8
|
+
/**
|
|
9
|
+
* DTO used to select fields for CSV serialization.
|
|
10
|
+
*/
|
|
11
|
+
ExportDTOClass?: Class<ExportDTO>;
|
|
12
|
+
} & ControllerOpts & NonePagingQueryArgsTypeOpts<DTO>;
|
|
13
|
+
export interface ExportController<DTO, QS extends QueryService<DTO, unknown, unknown>> extends ServiceController<DTO, QS> {
|
|
14
|
+
exportMany(query: QueryType<DTO, PagingStrategies.NONE>, authorizeFilter?: Filter<DTO>): Promise<string>;
|
|
15
|
+
}
|
|
16
|
+
export declare const stringifyExportCsv: <DTO, ExportDTO>(ExportDTOClass: Class<ExportDTO>, items: DTO[]) => string;
|
|
17
|
+
/**
|
|
18
|
+
* @internal
|
|
19
|
+
* Mixin to add `export` rest endpoint.
|
|
20
|
+
*/
|
|
21
|
+
export declare const Exportable: <DTO, ExportDTO, QS extends QueryService<DTO, unknown, unknown>>(DTOClass: Class<DTO>, opts: ExportControllerOpts<DTO, ExportDTO>) => <B extends Class<ServiceController<DTO, QS>>>(BaseClass: B) => Class<ExportController<DTO, QS>> & B;
|
|
22
|
+
export declare const ExportController: <DTO, ExportDTO = DeepPartial<DTO>, QS extends QueryService<DTO, unknown, unknown> = QueryService<DTO, unknown, unknown>>(DTOClass: Class<DTO>, opts?: ExportControllerOpts<DTO, ExportDTO>) => ControllerClass<DTO, QS, ExportController<DTO, QS>>;
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ExportController = exports.Exportable = exports.stringifyExportCsv = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const common_1 = require("@nestjs/common");
|
|
6
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
7
|
+
const nestjs_query_core_1 = require("@ptc-org/nestjs-query-core");
|
|
8
|
+
const class_transformer_1 = require("class-transformer");
|
|
9
|
+
const sync_1 = require("csv-stringify/sync");
|
|
10
|
+
const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
|
|
11
|
+
const __1 = require("../");
|
|
12
|
+
const common_2 = require("../common");
|
|
13
|
+
const decorators_1 = require("../decorators");
|
|
14
|
+
const interceptors_1 = require("../interceptors");
|
|
15
|
+
const export_paging_query_args_type_1 = require("../types/query/query-args/export-paging-query-args.type");
|
|
16
|
+
const controller_interface_1 = require("./controller.interface");
|
|
17
|
+
const stringifyExportCsv = (ExportDTOClass, items) => (0, sync_1.stringify)((0, class_transformer_1.plainToInstance)(ExportDTOClass, items, { excludeExtraneousValues: true }), {
|
|
18
|
+
header: true,
|
|
19
|
+
delimiter: ',',
|
|
20
|
+
defaultEncoding: 'utf8',
|
|
21
|
+
quoted_string: true,
|
|
22
|
+
escape_formulas: true
|
|
23
|
+
});
|
|
24
|
+
exports.stringifyExportCsv = stringifyExportCsv;
|
|
25
|
+
/**
|
|
26
|
+
* @internal
|
|
27
|
+
* Mixin to add `export` rest endpoint.
|
|
28
|
+
*/
|
|
29
|
+
const Exportable = (DTOClass, opts) => (BaseClass) => {
|
|
30
|
+
if (opts.disabled) {
|
|
31
|
+
return BaseClass;
|
|
32
|
+
}
|
|
33
|
+
const dtoNames = (0, common_2.getDTONames)(DTOClass, opts);
|
|
34
|
+
const { QueryArgs = (0, export_paging_query_args_type_1.createExportQueryArgs)(DTOClass, {
|
|
35
|
+
...opts,
|
|
36
|
+
connectionName: `${dtoNames.baseName}Connection`
|
|
37
|
+
}), ExportDTOClass = DTOClass } = opts;
|
|
38
|
+
const commonResolverOpts = (0, lodash_omit_1.default)(opts, 'dtoName', 'one', 'many', 'QueryArgs', 'FindDTOClass', 'Connection', 'withDeleted');
|
|
39
|
+
class EQA extends QueryArgs {
|
|
40
|
+
}
|
|
41
|
+
Object.defineProperty(EQA, 'name', {
|
|
42
|
+
writable: false,
|
|
43
|
+
// set a unique name otherwise DI does not inject a unique one for each request
|
|
44
|
+
value: `Export${DTOClass.name}Args`
|
|
45
|
+
});
|
|
46
|
+
class ExportResolverBase extends BaseClass {
|
|
47
|
+
// Returns CSV
|
|
48
|
+
async exportMany(query, authorizeFilter) {
|
|
49
|
+
const items = await this.service.exportMany((0, nestjs_query_core_1.mergeQuery)(query, {
|
|
50
|
+
filter: authorizeFilter,
|
|
51
|
+
paging: {
|
|
52
|
+
limit: opts?.limit ?? 1000,
|
|
53
|
+
offset: 0
|
|
54
|
+
}
|
|
55
|
+
}), {
|
|
56
|
+
withDeleted: opts?.many?.withDeleted
|
|
57
|
+
});
|
|
58
|
+
return (0, exports.stringifyExportCsv)(ExportDTOClass, items);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
tslib_1.__decorate([
|
|
62
|
+
(0, __1.Get)(() => String, {
|
|
63
|
+
path: `${opts?.many?.path ?? ''}/export`,
|
|
64
|
+
operation: {
|
|
65
|
+
operationId: `${dtoNames.pluralBaseNameLower}.exportMany`,
|
|
66
|
+
tags: [...(opts.tags || []), ...(opts.many?.tags ?? [])],
|
|
67
|
+
description: opts?.many?.description,
|
|
68
|
+
...opts?.many?.operationOptions
|
|
69
|
+
}
|
|
70
|
+
}, { interceptors: [(0, interceptors_1.HookInterceptor)(__1.HookTypes.BEFORE_QUERY_MANY, DTOClass), (0, interceptors_1.AuthorizerInterceptor)(DTOClass)] }, commonResolverOpts, opts.many ?? {}),
|
|
71
|
+
(0, common_1.Header)('content-type', 'text/csv'),
|
|
72
|
+
(0, swagger_1.ApiProduces)('text/csv'),
|
|
73
|
+
tslib_1.__param(0, (0, decorators_1.QueryHookArgs)()),
|
|
74
|
+
tslib_1.__param(1, (0, __1.AuthorizerFilter)({
|
|
75
|
+
operationGroup: __1.OperationGroup.EXPORT,
|
|
76
|
+
many: true
|
|
77
|
+
})),
|
|
78
|
+
tslib_1.__metadata("design:type", Function),
|
|
79
|
+
tslib_1.__metadata("design:paramtypes", [EQA, Object]),
|
|
80
|
+
tslib_1.__metadata("design:returntype", Promise)
|
|
81
|
+
], ExportResolverBase.prototype, "exportMany", null);
|
|
82
|
+
return ExportResolverBase;
|
|
83
|
+
};
|
|
84
|
+
exports.Exportable = Exportable;
|
|
85
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare -- intentional
|
|
86
|
+
const ExportController = (DTOClass, opts = {}) => (0, exports.Exportable)(DTOClass, opts)(controller_interface_1.BaseServiceResolver);
|
|
87
|
+
exports.ExportController = ExportController;
|
|
88
|
+
//# sourceMappingURL=export.controller.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"export.controller.js","sourceRoot":"","sources":["../../../../../packages/query-rest/src/controllers/export.controller.ts"],"names":[],"mappings":";;;;AAAA,2CAAuC;AACvC,6CAA6C;AAC7C,kEAAiG;AACjG,yDAAmD;AACnD,6CAA8D;AAC9D,sEAA8B;AAE9B,2BAA8G;AAC9G,sCAAuC;AACvC,8CAA6C;AAC7C,kDAAwE;AAExE,2GAA+F;AAC/F,iEAAgH;AAkBzG,MAAM,kBAAkB,GAAG,CAAiB,cAAgC,EAAE,KAAY,EAAU,EAAE,CAC3G,IAAA,gBAAY,EAAC,IAAA,mCAAe,EAAC,cAAc,EAAE,KAAK,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,EAAE;IACtF,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,GAAG;IACd,eAAe,EAAE,MAAM;IACvB,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACtB,CAAC,CAAA;AAPS,QAAA,kBAAkB,sBAO3B;AAEJ;;;GAGG;AACI,MAAM,UAAU,GACrB,CACE,QAAoB,EACpB,IAA0C,EAC1C,EAAE,CACJ,CAA8C,SAAY,EAAwC,EAAE;IAClG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,OAAO,SAAkB,CAAA;IAC3B,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC5C,MAAM,EACJ,SAAS,GAAG,IAAA,qDAAqB,EAAC,QAAQ,EAAE;QAC1C,GAAG,IAAI;QACP,cAAc,EAAE,GAAG,QAAQ,CAAC,QAAQ,YAAY;KACjD,CAAC,EACF,cAAc,GAAG,QAAQ,EAC1B,GAAG,IAAI,CAAA;IAER,MAAM,kBAAkB,GAAG,IAAA,qBAAI,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,CAAC,CAAA;IAEzH,MAAM,GAAI,SAAQ,SAAS;KAAG;IAE9B,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE;QACjC,QAAQ,EAAE,KAAK;QACf,+EAA+E;QAC/E,KAAK,EAAE,SAAS,QAAQ,CAAC,IAAI,MAAM;KACpC,CAAC,CAAA;IAEF,MAAM,kBAAmB,SAAQ,SAAS;QACxC,cAAc;QAkBD,AAAN,KAAK,CAAC,UAAU,CACJ,KAAU,EAK3B,eAA6B;YAE7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CACzC,IAAA,8BAAU,EAAC,KAAK,EAAE;gBAChB,MAAM,EAAE,eAAe;gBACvB,MAAM,EAAE;oBACN,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,IAAI;oBAC1B,MAAM,EAAE,CAAC;iBACV;aACF,CAAC,EACF;gBACE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW;aACrC,CACF,CAAA;YAED,OAAO,IAAA,0BAAkB,EAAiB,cAAkC,EAAE,KAAK,CAAC,CAAA;QACtF,CAAC;KACF;IAvBc;QAjBZ,IAAA,OAAG,EACF,GAAG,EAAE,CAAC,MAAM,EACZ;YACE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,SAAS;YACxC,SAAS,EAAE;gBACT,WAAW,EAAE,GAAG,QAAQ,CAAC,mBAAmB,aAAa;gBACzD,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;gBACxD,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW;gBACpC,GAAG,IAAI,EAAE,IAAI,EAAE,gBAAgB;aAChC;SACF,EACD,EAAE,YAAY,EAAE,CAAC,IAAA,8BAAe,EAAC,aAAS,CAAC,iBAAiB,EAAE,QAAQ,CAAC,EAAE,IAAA,oCAAqB,EAAC,QAAQ,CAAC,CAAC,EAAE,EAC3G,kBAAkB,EAClB,IAAI,CAAC,IAAI,IAAI,EAAE,CAChB;QACA,IAAA,eAAM,EAAC,cAAc,EAAE,UAAU,CAAC;QAClC,IAAA,qBAAW,EAAC,UAAU,CAAC;QAErB,mBAAA,IAAA,0BAAa,GAAE,CAAA;QACf,mBAAA,IAAA,oBAAgB,EAAC;YAChB,cAAc,EAAE,kBAAc,CAAC,MAAM;YACrC,IAAI,EAAE,IAAI;SACX,CAAC,CAAA;;iDAJsB,GAAG;;wDAqB5B;IAGH,OAAO,kBAA0D,CAAA;AACnE,CAAC,CAAA;AA1EU,QAAA,UAAU,cA0EpB;AAEH,0EAA0E;AACnE,MAAM,gBAAgB,GAAG,CAK9B,QAAoB,EACpB,OAA6C,EAAE,EACM,EAAE,CAAC,IAAA,kBAAU,EAAqB,QAAQ,EAAE,IAAI,CAAC,CAAC,0CAAmB,CAAC,CAAA;AAPhH,QAAA,gBAAgB,oBAOgG"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { ControllerOpts } from './controller.interface';
|
|
2
|
+
export { CreateController, CreateResolverOpts } from './create.controller';
|
|
3
|
+
export { CRUDController, CRUDControllerOpts } from './crud.controller';
|
|
4
|
+
export { DeleteController, DeleteResolverOpts } from './delete.controller';
|
|
5
|
+
export { ExportController, ExportControllerOpts } from './export.controller';
|
|
6
|
+
export { ReadController, ReadControllerOpts } from './read.controller';
|
|
7
|
+
export { UpdateController, UpdateControllerOpts } from './update.controller';
|