mongodb-dynamic-api 4.24.0 → 4.24.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/package.json +1 -1
- package/src/builders/route-decorators/paginated-response.builder.d.ts +3 -0
- package/src/builders/route-decorators/paginated-response.builder.js +35 -0
- package/src/builders/route-decorators/paginated-response.builder.js.map +1 -0
- package/src/builders/route-decorators/route-decorators.builder.d.ts +1 -1
- package/src/builders/route-decorators/route-decorators.builder.js +9 -2
- package/src/builders/route-decorators/route-decorators.builder.js.map +1 -1
- package/src/version.json +1 -1
- package/test/for-feature/aggregate-swagger-paginated-response.e2e-spec.d.ts +1 -0
- package/test/for-feature/aggregate-swagger-paginated-response.e2e-spec.js +98 -0
- package/test/for-feature/aggregate-swagger-paginated-response.e2e-spec.js.map +1 -0
- package/tsconfig.tsbuildinfo +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
Changelog
|
|
2
2
|
|
|
3
|
+
## [4.24.1](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v4.24.0...v4.24.1) (2026-09-01)
|
|
4
|
+
|
|
5
|
+
### aggregate
|
|
6
|
+
|
|
7
|
+
* **aggregate:** document paginated { list, count, totalPage } response shape in Swagger ([621bec5](https://github.com/MikeDev75015/mongodb-dynamic-api/commit/621bec59bb404eb3d9da951061a53e88386366a2)), closes [#12](https://github.com/MikeDev75015/mongodb-dynamic-api/issues/12) [#14](https://github.com/MikeDev75015/mongodb-dynamic-api/issues/14) [#14](https://github.com/MikeDev75015/mongodb-dynamic-api/issues/14)
|
|
8
|
+
|
|
3
9
|
## [4.24.0](https://github.com/MikeDev75015/mongodb-dynamic-api/compare/v4.23.0...v4.24.0) (2026-08-29)
|
|
4
10
|
|
|
5
11
|
### aggregate
|
package/package.json
CHANGED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.buildPaginatedResponseType = buildPaginatedResponseType;
|
|
13
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
14
|
+
function buildPaginatedResponseType(presenter) {
|
|
15
|
+
class PaginatedResponse {
|
|
16
|
+
}
|
|
17
|
+
__decorate([
|
|
18
|
+
(0, swagger_1.ApiProperty)({ type: [presenter] }),
|
|
19
|
+
__metadata("design:type", Array)
|
|
20
|
+
], PaginatedResponse.prototype, "list", void 0);
|
|
21
|
+
__decorate([
|
|
22
|
+
(0, swagger_1.ApiProperty)(),
|
|
23
|
+
__metadata("design:type", Number)
|
|
24
|
+
], PaginatedResponse.prototype, "count", void 0);
|
|
25
|
+
__decorate([
|
|
26
|
+
(0, swagger_1.ApiProperty)(),
|
|
27
|
+
__metadata("design:type", Number)
|
|
28
|
+
], PaginatedResponse.prototype, "totalPage", void 0);
|
|
29
|
+
Object.defineProperty(PaginatedResponse, 'name', {
|
|
30
|
+
value: `Paginated${presenter.name}`,
|
|
31
|
+
writable: false,
|
|
32
|
+
});
|
|
33
|
+
return PaginatedResponse;
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=paginated-response.builder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paginated-response.builder.js","sourceRoot":"","sources":["../../../../libs/dynamic-api/src/builders/route-decorators/paginated-response.builder.ts"],"names":[],"mappings":";;;;;;;;;;;AAoCS,gEAA0B;AAnCnC,6CAA8C;AAe9C,SAAS,0BAA0B,CAAC,SAAe;IACjD,MAAM,iBAAiB;KAStB;IAPC;QADC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;;mDACI;IAGvC;QADC,IAAA,qBAAW,GAAE;;oDACA;IAGd;QADC,IAAA,qBAAW,GAAE;;wDACI;IAGpB,MAAM,CAAC,cAAc,CAAC,iBAAiB,EAAE,MAAM,EAAE;QAC/C,KAAK,EAAE,YAAY,SAAS,CAAC,IAAI,EAAE;QACnC,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IAEH,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}
|
|
@@ -17,7 +17,7 @@ declare class RouteDecoratorsBuilder<Entity extends BaseEntity> implements Dynam
|
|
|
17
17
|
body?: Type;
|
|
18
18
|
presenter?: Type;
|
|
19
19
|
}, isArrayResponse?: boolean);
|
|
20
|
-
build(): (
|
|
20
|
+
build(): ((target: object, key?: string | symbol, descriptor?: TypedPropertyDescriptor<any>) => any)[];
|
|
21
21
|
private getRouteDecorators;
|
|
22
22
|
private getApiDecorators;
|
|
23
23
|
}
|
|
@@ -6,6 +6,7 @@ const swagger_1 = require("@nestjs/swagger");
|
|
|
6
6
|
const decorators_1 = require("../../decorators");
|
|
7
7
|
const dynamic_api_module_1 = require("../../dynamic-api.module");
|
|
8
8
|
const helpers_1 = require("../../helpers");
|
|
9
|
+
const paginated_response_builder_1 = require("./paginated-response.builder");
|
|
9
10
|
class RouteDecoratorsBuilder {
|
|
10
11
|
constructor(routeType, entity, subPath, version, description, isPublic, dTOs = {}, isArrayResponse = false) {
|
|
11
12
|
this.routeType = routeType;
|
|
@@ -93,15 +94,21 @@ class RouteDecoratorsBuilder {
|
|
|
93
94
|
}
|
|
94
95
|
getApiDecorators(paramKey) {
|
|
95
96
|
const feature = this.subPath ? `${(0, helpers_1.pascalCase)(this.subPath)}-${this.entity.name}` : this.entity.name;
|
|
97
|
+
const presenter = this.dTOs.presenter ?? this.entity;
|
|
98
|
+
const isPaginatedAggregate = this.routeType === 'Aggregate'
|
|
99
|
+
&& typeof presenter.fromAggregate === 'function';
|
|
100
|
+
const responseType = isPaginatedAggregate ? (0, paginated_response_builder_1.buildPaginatedResponseType)(presenter) : presenter;
|
|
96
101
|
return [
|
|
97
102
|
(0, swagger_1.ApiOperation)({
|
|
98
103
|
operationId: `${(0, helpers_1.lowerFirst)(this.routeType)}${feature}${this.version ? 'V' + this.version : ''}`,
|
|
99
104
|
summary: this.description ??
|
|
100
105
|
`${(0, helpers_1.upperFirst)((0, helpers_1.lowerCase)(this.routeType))} ${(0, helpers_1.lowerCase)(feature)}`,
|
|
101
106
|
}),
|
|
107
|
+
...(isPaginatedAggregate ? [(0, swagger_1.ApiExtraModels)(presenter)] : []),
|
|
102
108
|
(0, swagger_1.ApiResponse)({
|
|
103
|
-
type:
|
|
104
|
-
isArray:
|
|
109
|
+
type: responseType,
|
|
110
|
+
isArray: !isPaginatedAggregate
|
|
111
|
+
&& (this.responseRouteTypeIsArray.includes(this.routeType) || this.isArrayResponse),
|
|
105
112
|
}),
|
|
106
113
|
...(this.dTOs.body ? [
|
|
107
114
|
(0, swagger_1.ApiBody)({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"route-decorators.builder.js","sourceRoot":"","sources":["../../../../libs/dynamic-api/src/builders/route-decorators/route-decorators.builder.ts"],"names":[],"mappings":";;;AAAA,2CAAqE;AACrE,
|
|
1
|
+
{"version":3,"file":"route-decorators.builder.js","sourceRoot":"","sources":["../../../../libs/dynamic-api/src/builders/route-decorators/route-decorators.builder.ts"],"names":[],"mappings":";;;AAAA,2CAAqE;AACrE,6CAA8G;AAC9G,iDAA0C;AAC1C,iEAA4D;AAC5D,2CAA8E;AAG9E,6EAA0E;AAG1E,MAAM,sBAAsB;IAY1B,YACmB,SAAoB,EACpB,MAAoB,EACpB,OAA2B,EAC3B,OAA2B,EAC3B,WAA+B,EAC/B,QAA6B,EAC7B,OAIb,EAAE,EACW,kBAA2B,KAAK;QAXhC,cAAS,GAAT,SAAS,CAAW;QACpB,WAAM,GAAN,MAAM,CAAc;QACpB,YAAO,GAAP,OAAO,CAAoB;QAC3B,YAAO,GAAP,OAAO,CAAoB;QAC3B,gBAAW,GAAX,WAAW,CAAoB;QAC/B,aAAQ,GAAR,QAAQ,CAAqB;QAC7B,SAAI,GAAJ,IAAI,CAIf;QACW,oBAAe,GAAf,eAAe,CAAiB;QAvBlC,6BAAwB,GAAgB;YACvD,SAAS;YACT,YAAY;YACZ,eAAe;SAChB,CAAC;QAEe,4BAAuB,GAAgB;YACtD,cAAc;YACd,eAAe;SAChB,CAAC;IAeC,CAAC;IAEG,KAAK;QACV,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE7E,OAAO;YACL,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;SACnC,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,QAAiB;QAC1C,IAAI,eAAe,GAAyC,EAAE,CAAC;QAC/D,MAAM,aAAa,GAAG,qCAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAElE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,eAAe,CAAC,IAAI,CAAC,IAAA,mBAAM,GAAE,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,aAAa,EAAE,CAAC;YACzB,eAAe,CAAC,IAAI,CAAC,IAAA,uBAAa,GAAE,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAEnC,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,IAAI,EAAU,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC;QAC1D,CAAC,CAAC;QAEF,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,KAAK,SAAS;gBACZ,eAAe,CAAC,IAAI,CAAC,IAAA,YAAG,EAAC,OAAO,CAAC,CAAC,CAAC;gBACnC,MAAM;YACR,KAAK,QAAQ;gBACX,eAAe,CAAC,IAAI,CAAC,IAAA,YAAG,EAAC,GAAG,UAAU,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;gBACzD,MAAM;YACR,KAAK,YAAY;gBACf,eAAe,CAAC,IAAI,CAAC,IAAA,aAAI,EAAC,OAAO,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvD,MAAM;YACR,KAAK,WAAW;gBACd,eAAe,CAAC,IAAI,CAAC,IAAA,aAAI,EAAC,OAAO,CAAC,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,YAAY;gBACf,eAAe,CAAC,IAAI,CAAC,IAAA,cAAK,EAAC,OAAO,CAAC,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,WAAW;gBACd,eAAe,CAAC,IAAI,CAAC,IAAA,cAAK,EAAC,IAAI,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChE,MAAM;YACR,KAAK,YAAY;gBACf,eAAe,CAAC,IAAI,CAAC,IAAA,YAAG,EAAC,IAAI,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC9D,MAAM;YACR,KAAK,eAAe;gBAClB,eAAe,CAAC,IAAI,CAAC,IAAA,aAAI,EAAC,YAAY,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC5D,MAAM;YACR,KAAK,cAAc;gBACjB,eAAe,CAAC,IAAI,CAAC,IAAA,aAAI,EAAC,cAAc,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACzE,MAAM;YACR,KAAK,YAAY;gBACf,eAAe,CAAC,IAAI,CAAC,IAAA,eAAM,EAAC,OAAO,CAAC,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,WAAW;gBACd,eAAe,CAAC,IAAI,CAAC,IAAA,eAAM,EAAC,IAAI,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACjE,MAAM;YACR,KAAK,WAAW;gBACd,eAAe,CAAC,IAAI,CAAC,IAAA,YAAG,EAAC,OAAO,CAAC,CAAC,CAAC;gBACnC,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CACb,mEAAmE,IAAI,CAAC,SAAS,EAAE,CACpF,CAAC;QACN,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,gBAAgB,CAAC,QAAiB;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACpG,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;QAKrD,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,KAAK,WAAW;eACtD,OAAQ,SAAuC,CAAC,aAAa,KAAK,UAAU,CAAC;QAClF,MAAM,YAAY,GAAG,oBAAoB,CAAC,CAAC,CAAC,IAAA,uDAA0B,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE9F,OAAO;YACL,IAAA,sBAAY,EAAC;gBACX,WAAW,EAAE,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC/F,OAAO,EACL,IAAI,CAAC,WAAW;oBAChB,GAAG,IAAA,oBAAU,EAAC,IAAA,mBAAS,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,IAAA,mBAAS,EAAC,OAAO,CAAC,EAAE;aACnE,CAAC;YACF,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAA,wBAAc,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,IAAA,qBAAW,EAAC;gBACV,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,CAAC,oBAAoB;uBACzB,CAAC,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC;aACtF,CAAC;YACF,GAAG,CACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACf,IAAA,iBAAO,EAAC;oBACN,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;oBACpB,QAAQ,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;iBACjE,CAAC;aACH,CAAC,CAAC,CAAC,EAAE,CACP;YACD,GAAG,CACD,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ;gBACzB,CAAC,CAAC;oBACA,IAAA,kBAAQ,EAAC;wBACP,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC;wBAC5C,IAAI,EAAE,QAAQ;qBACf,CAAC;iBACH;gBACD,CAAC,CAAC,EAAE,CACP;SACF,CAAC;IACJ,CAAC;CACF;AAEQ,wDAAsB"}
|
package/src/version.json
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
13
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
14
|
+
const mongodb_pipeline_builder_1 = require("mongodb-pipeline-builder");
|
|
15
|
+
const mongoose_2 = require("mongoose");
|
|
16
|
+
const src_1 = require("../../src");
|
|
17
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
18
|
+
require("dotenv/config");
|
|
19
|
+
const shared_1 = require("../shared");
|
|
20
|
+
describe('DynamicApiModule forFeature - Aggregate paginated response in OpenAPI (e2e)', () => {
|
|
21
|
+
beforeEach(() => {
|
|
22
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
23
|
+
});
|
|
24
|
+
afterEach(async () => {
|
|
25
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
26
|
+
});
|
|
27
|
+
let OpenApiPaginatedProductEntity = class OpenApiPaginatedProductEntity extends src_1.BaseEntity {
|
|
28
|
+
};
|
|
29
|
+
__decorate([
|
|
30
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
31
|
+
__metadata("design:type", String)
|
|
32
|
+
], OpenApiPaginatedProductEntity.prototype, "name", void 0);
|
|
33
|
+
OpenApiPaginatedProductEntity = __decorate([
|
|
34
|
+
(0, mongoose_1.Schema)({ collection: 'openapi_paginated_products' })
|
|
35
|
+
], OpenApiPaginatedProductEntity);
|
|
36
|
+
class ProductPagedPresenter {
|
|
37
|
+
static fromAggregate(list, count, totalPage) {
|
|
38
|
+
return { list, count, totalPage };
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
class ProductAggregateQuery {
|
|
42
|
+
static toPipeline() {
|
|
43
|
+
return new mongodb_pipeline_builder_1.PipelineBuilder('openapi-paginated-products')
|
|
44
|
+
.Sort({ name: 1 })
|
|
45
|
+
.Paging(10, 1)
|
|
46
|
+
.build();
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
it('documents { list, count, totalPage } instead of a bare presenter when fromAggregate exists', async () => {
|
|
50
|
+
await (0, shared_1.initApp)({
|
|
51
|
+
entity: OpenApiPaginatedProductEntity,
|
|
52
|
+
controllerOptions: { path: 'openapi-paginated-products', isPublic: true },
|
|
53
|
+
routes: [
|
|
54
|
+
{
|
|
55
|
+
type: 'Aggregate',
|
|
56
|
+
subPath: 'aggregate',
|
|
57
|
+
dTOs: { query: ProductAggregateQuery, presenter: ProductPagedPresenter },
|
|
58
|
+
},
|
|
59
|
+
],
|
|
60
|
+
});
|
|
61
|
+
const document = swagger_1.SwaggerModule.createDocument(global.app, new swagger_1.DocumentBuilder().build());
|
|
62
|
+
const operation = document.paths['/openapi-paginated-products/aggregate']?.get;
|
|
63
|
+
expect(operation).toBeDefined();
|
|
64
|
+
const responseSchema = operation?.responses?.default?.content?.['application/json']?.schema;
|
|
65
|
+
expect(responseSchema).toBeDefined();
|
|
66
|
+
expect('$ref' in responseSchema).toBe(true);
|
|
67
|
+
const schemaName = (responseSchema.$ref).split('/').pop();
|
|
68
|
+
expect(schemaName).toMatch(/^Paginated/);
|
|
69
|
+
const wrapperSchema = document.components?.schemas?.[schemaName];
|
|
70
|
+
expect(wrapperSchema).toBeDefined();
|
|
71
|
+
expect(wrapperSchema.properties.list.type).toBe('array');
|
|
72
|
+
expect(wrapperSchema.properties.list.items).toHaveProperty('$ref');
|
|
73
|
+
expect(wrapperSchema.properties.count.type).toBe('number');
|
|
74
|
+
expect(wrapperSchema.properties.totalPage.type).toBe('number');
|
|
75
|
+
const itemSchemaName = wrapperSchema.properties.list.items.$ref.split('/').pop();
|
|
76
|
+
expect(document.components?.schemas?.[itemSchemaName]).toBeDefined();
|
|
77
|
+
});
|
|
78
|
+
it('keeps documenting a bare presenter for an Aggregate route with no fromAggregate', async () => {
|
|
79
|
+
await (0, shared_1.initApp)({
|
|
80
|
+
entity: OpenApiPaginatedProductEntity,
|
|
81
|
+
controllerOptions: { path: 'openapi-plain-products', isPublic: true },
|
|
82
|
+
routes: [
|
|
83
|
+
{
|
|
84
|
+
type: 'Aggregate',
|
|
85
|
+
subPath: 'aggregate',
|
|
86
|
+
dTOs: { query: ProductAggregateQuery },
|
|
87
|
+
},
|
|
88
|
+
],
|
|
89
|
+
});
|
|
90
|
+
const document = swagger_1.SwaggerModule.createDocument(global.app, new swagger_1.DocumentBuilder().build());
|
|
91
|
+
const operation = document.paths['/openapi-plain-products/aggregate']?.get;
|
|
92
|
+
const responseSchema = operation?.responses?.default?.content?.['application/json']?.schema;
|
|
93
|
+
expect(responseSchema).toBeDefined();
|
|
94
|
+
const schemaName = (responseSchema.$ref ?? '').split('/').pop() ?? '';
|
|
95
|
+
expect(schemaName).not.toMatch(/^Paginated/);
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
//# sourceMappingURL=aggregate-swagger-paginated-response.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"aggregate-swagger-paginated-response.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/aggregate-swagger-paginated-response.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,+CAAgD;AAChD,6CAAgF;AAChF,uEAA0E;AAC1E,uCAAgC;AAChC,mCAAyD;AACzD,4CAA+C;AAC/C,yBAAuB;AACvB,sCAAoC;AAepC,QAAQ,CAAC,6EAA6E,EAAE,GAAG,EAAE;IAE3F,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,6BAA6B,GAAnC,MAAM,6BAA8B,SAAQ,gBAAU;KAGrD,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+DAC1B;IAFT,6BAA6B;QADlC,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,4BAA4B,EAAE,CAAC;OAC/C,6BAA6B,CAGlC;IAED,MAAM,qBAAqB;QACzB,MAAM,CAAC,aAAa,CAAC,IAAqC,EAAE,KAAa,EAAE,SAAiB;YAC1F,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QACpC,CAAC;KACF;IAED,MAAM,qBAAqB;QACzB,MAAM,CAAC,UAAU;YACf,OAAO,IAAI,0CAAe,CAAC,4BAA4B,CAAC;iBACvD,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;iBACjB,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;iBACb,KAAK,EAAE,CAAC;QACX,CAAC;KACF;IAED,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;QAC1G,MAAM,IAAA,gBAAO,EAAC;YACZ,MAAM,EAAE,6BAA6B;YACrC,iBAAiB,EAAE,EAAE,IAAI,EAAE,4BAA4B,EAAE,QAAQ,EAAE,IAAI,EAAE;YACzE,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,WAAW;oBACpB,IAAI,EAAE,EAAE,KAAK,EAAE,qBAAqB,EAAE,SAAS,EAAE,qBAAqB,EAAE;iBACzE;aACF;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAkB,uBAAa,CAAC,cAAc,CAC1D,MAAM,CAAC,GAAuB,EAC9B,IAAI,yBAAe,EAAE,CAAC,KAAK,EAAE,CAC9B,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,uCAAuC,CAAC,EAAE,GAAG,CAAC;QAC/E,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAIhC,MAAM,cAAc,GAAI,SAAS,EAAE,SAAS,EAAE,OAAe,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QACrG,MAAM,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,CAAC,MAAM,IAAK,cAAyB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG,CAAE,cAAmC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,CAAC;QAC1F,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAEzC,MAAM,aAAa,GAAG,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,UAAU,CAAQ,CAAC;QACxE,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAI/D,MAAM,cAAc,GAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QAC7F,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,cAAwB,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,IAAA,gBAAO,EAAC;YACZ,MAAM,EAAE,6BAA6B;YACrC,iBAAiB,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,QAAQ,EAAE,IAAI,EAAE;YACrE,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,WAAW;oBAEpB,IAAI,EAAE,EAAE,KAAK,EAAE,qBAAqB,EAAE;iBACvC;aACF;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAkB,uBAAa,CAAC,cAAc,CAC1D,MAAM,CAAC,GAAuB,EAC9B,IAAI,yBAAe,EAAE,CAAC,KAAK,EAAE,CAC9B,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE,GAAG,CAAC;QAC3E,MAAM,cAAc,GAAI,SAAS,EAAE,SAAS,EAAE,OAAe,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAErG,MAAM,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QAGrC,MAAM,UAAU,GAAG,CAAE,cAAc,CAAC,IAAe,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QAClF,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|