@hg-ts/http-controller 0.5.36 → 0.5.38
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/dist/decorators/decorators.d.ts +5 -1
- package/dist/decorators/decorators.d.ts.map +1 -1
- package/dist/decorators/decorators.js +44 -6
- package/dist/decorators/decorators.js.map +1 -1
- package/dist/services/swagger.service.d.ts.map +1 -1
- package/dist/services/swagger.service.js +5 -1
- package/dist/services/swagger.service.js.map +1 -1
- package/dist/tests/abstracts/base-controller-suite.d.ts.map +1 -1
- package/dist/tests/abstracts/base-controller-suite.js +3 -0
- package/dist/tests/abstracts/base-controller-suite.js.map +1 -1
- package/dist/tests/echo/controllers/dto/echo-get.query.d.ts +1 -1
- package/dist/tests/echo/controllers/dto/echo-get.query.d.ts.map +1 -1
- package/dist/tests/echo/controllers/dto/echo-get.query.js +6 -1
- package/dist/tests/echo/controllers/dto/echo-get.query.js.map +1 -1
- package/dist/tests/echo/controllers/echo.controller.d.ts.map +1 -1
- package/dist/tests/echo/controllers/echo.controller.js +6 -5
- package/dist/tests/echo/controllers/echo.controller.js.map +1 -1
- package/dist/tests/echo/echo.test.d.ts.map +1 -1
- package/dist/tests/echo/echo.test.js +3 -4
- package/dist/tests/echo/echo.test.js.map +1 -1
- package/package.json +16 -15
- package/src/decorators/decorators.ts +72 -6
- package/src/services/swagger.service.ts +15 -2
- package/src/tests/abstracts/base-controller-suite.ts +5 -1
- package/src/tests/echo/controllers/dto/echo-get.query.ts +6 -1
- package/src/tests/echo/controllers/echo.controller.ts +5 -6
- package/src/tests/echo/echo.test.ts +3 -4
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
import { BaseException } from '@hg-ts/exception';
|
|
2
2
|
import { z } from '@hg-ts/validation';
|
|
3
|
+
import { ApiResponseOptions } from '@nestjs/swagger';
|
|
3
4
|
export type ExceptionMap = Map<Class<BaseException, any[]>, number>;
|
|
4
5
|
export declare const EXCEPTION_METADATA_KEY: unique symbol;
|
|
5
6
|
export declare class Http {
|
|
6
7
|
private constructor();
|
|
7
|
-
static ExceptionStatus(exception: Class<BaseException, any[]>, statusCode: number): MethodDecorator;
|
|
8
|
+
static ExceptionStatus(exception: Class<BaseException, any[]>, statusCode: number, options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
|
|
9
|
+
static Params(): ParameterDecorator;
|
|
10
|
+
static Query(): ParameterDecorator;
|
|
8
11
|
static ValidatedHeader<T>(headerName: string, schema: z.ZodSchema<T>): () => ParameterDecorator;
|
|
12
|
+
private static getApiPropertyDecorator;
|
|
9
13
|
}
|
|
10
14
|
//# sourceMappingURL=decorators.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,
|
|
1
|
+
{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAGN,CAAC,EAED,MAAM,mBAAmB,CAAC;AAO3B,OAAO,EAIN,kBAAkB,EAClB,MAAM,iBAAiB,CAAC;AAMzB,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpE,eAAO,MAAM,sBAAsB,eAAmC,CAAC;AAEvE,qBAAa,IAAI;IAChB,OAAO;WAGO,eAAe,CAC5B,SAAS,EAAE,KAAK,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,EACtC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,GAC1C,eAAe;WA6BJ,MAAM,IAAI,kBAAkB;WAO5B,KAAK,IAAI,kBAAkB;WAO3B,eAAe,CAAC,CAAC,EAC9B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GACpB,MAAM,kBAAkB;IAyB3B,OAAO,CAAC,MAAM,CAAC,uBAAuB;CAetC"}
|
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
import { createSchema, } from '@hg-ts/validation';
|
|
2
|
-
import { createParamDecorator } from '@nestjs/common';
|
|
3
|
-
import { ApiResponse } from '@nestjs/swagger';
|
|
1
|
+
import { createSchema, isZodDto, } from '@hg-ts/validation';
|
|
2
|
+
import { createParamDecorator, Param, Query, } from '@nestjs/common';
|
|
3
|
+
import { ApiHeader, ApiProperty, ApiResponse, } from '@nestjs/swagger';
|
|
4
4
|
import { ExceptionStatusAlreadyDefinedException } from '../exceptions/index.js';
|
|
5
5
|
import { ExceptionService } from '../services/index.js';
|
|
6
6
|
export const EXCEPTION_METADATA_KEY = Symbol('EXCEPTION_METADATA_KEY');
|
|
7
7
|
export class Http {
|
|
8
|
-
constructor() {
|
|
9
|
-
|
|
8
|
+
constructor() {
|
|
9
|
+
}
|
|
10
|
+
static ExceptionStatus(exception, statusCode, options) {
|
|
10
11
|
return (target, propertyKey, descriptor) => {
|
|
11
12
|
const statusMap = Reflect.getMetadata(EXCEPTION_METADATA_KEY, target, propertyKey) ?? new Map();
|
|
12
13
|
if (statusMap.has(exception)) {
|
|
@@ -22,17 +23,54 @@ export class Http {
|
|
|
22
23
|
.map(item => createSchema(item, { io: 'input' }))
|
|
23
24
|
.map(item => item.schema);
|
|
24
25
|
ApiResponse({
|
|
26
|
+
...options,
|
|
25
27
|
schema: schemas.length === 1 ? schemas[0] : { oneOf: schemas },
|
|
26
28
|
status: statusCode,
|
|
27
29
|
})(target, propertyKey, descriptor);
|
|
28
30
|
};
|
|
29
31
|
}
|
|
32
|
+
static Params() {
|
|
33
|
+
return (target, propertyKey, parameterIndex) => {
|
|
34
|
+
Param()(target, propertyKey, parameterIndex);
|
|
35
|
+
this.getApiPropertyDecorator()(target, propertyKey, parameterIndex);
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
static Query() {
|
|
39
|
+
return (target, propertyKey, parameterIndex) => {
|
|
40
|
+
Query()(target, propertyKey, parameterIndex);
|
|
41
|
+
this.getApiPropertyDecorator()(target, propertyKey, parameterIndex);
|
|
42
|
+
};
|
|
43
|
+
}
|
|
30
44
|
static ValidatedHeader(headerName, schema) {
|
|
31
|
-
|
|
45
|
+
const validationDecorator = createParamDecorator((_data, ctx) => {
|
|
32
46
|
const request = ctx.switchToHttp().getRequest();
|
|
33
47
|
const header = request.headers[headerName];
|
|
34
48
|
return schema.parse(header);
|
|
49
|
+
})();
|
|
50
|
+
const { description, ...openApiSchema } = createSchema(schema).schema;
|
|
51
|
+
const openapiDecorator = ApiHeader({
|
|
52
|
+
name: headerName,
|
|
53
|
+
description: description ?? '',
|
|
54
|
+
schema: openApiSchema,
|
|
35
55
|
});
|
|
56
|
+
const decorator = (target, propertyKey, parameterIndex) => {
|
|
57
|
+
validationDecorator(target, propertyKey, parameterIndex);
|
|
58
|
+
openapiDecorator(target, propertyKey, Object.getOwnPropertyDescriptor(target, propertyKey));
|
|
59
|
+
};
|
|
60
|
+
return () => decorator;
|
|
61
|
+
}
|
|
62
|
+
static getApiPropertyDecorator() {
|
|
63
|
+
return (target, propertyKey, parameterIndex) => {
|
|
64
|
+
const metadata = Reflect.getMetadata('design:paramtypes', target, propertyKey);
|
|
65
|
+
const dto = metadata[parameterIndex];
|
|
66
|
+
if (isZodDto(dto)) {
|
|
67
|
+
Object.entries(dto.schema.shape).forEach(([key, value]) => {
|
|
68
|
+
const { description, deprecated, ...openApiSchema } = createSchema(value).schema;
|
|
69
|
+
const optional = value.safeParse().success;
|
|
70
|
+
ApiProperty({ schema: openApiSchema, required: !optional, description, deprecated })(dto.prototype, key);
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
};
|
|
36
74
|
}
|
|
37
75
|
}
|
|
38
76
|
//# sourceMappingURL=decorators.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators/decorators.ts"],"names":[],"mappings":"AACA,OAAO,EACN,YAAY,
|
|
1
|
+
{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators/decorators.ts"],"names":[],"mappings":"AACA,OAAO,EACN,YAAY,EACZ,QAAQ,GAGR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACN,oBAAoB,EACpB,KAAK,EACL,KAAK,GACL,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,SAAS,EACT,WAAW,EACX,WAAW,GAEX,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,sCAAsC,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAIxD,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAEvE,MAAM,OAAO,IAAI;IAChB;IACA,CAAC;IAEM,MAAM,CAAC,eAAe,CAC5B,SAAsC,EACtC,UAAkB,EAClB,OAA4C;QAE5C,OAAO,CAAC,MAAW,EAAE,WAA4B,EAAE,UAA8B,EAAE,EAAE;YACpF,MAAM,SAAS,GACd,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;YAE/E,IAAI,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,sCAAsC,CAAC,SAAS,CAAC,CAAC;YAC7D,CAAC;YAED,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACrC,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YAE/E,MAAM,iBAAiB,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;YAEnD,MAAM,OAAO,GAAG,iBAAiB;iBAC/B,MAAM,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,EAAE,EAAE,CAAC,mBAAmB,KAAK,UAAU,CAAC;iBACvE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;iBACjD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;iBACxB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;iBAChD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAa,CAAC,CAAC;YAElC,WAAW,CAAC;gBACX,GAAG,OAAO;gBACV,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE;gBAC9D,MAAM,EAAE,UAAU;aAClB,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,MAAM;QACnB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;YAC9C,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;YAC7C,IAAI,CAAC,uBAAuB,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QACrE,CAAC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QAClB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;YAC9C,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;YAC7C,IAAI,CAAC,uBAAuB,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QACrE,CAAC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAC5B,UAAkB,EAClB,MAAsB;QAEtB,MAAM,mBAAmB,GAAuB,oBAAoB,CAAC,CAAC,KAAc,EAAE,GAAG,EAAK,EAAE;YAC/F,MAAM,OAAO,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAkB,CAAC;YAChE,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE3C,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,EAAE,CAAC;QAEL,MAAM,EAAE,WAAW,EAAE,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAEtE,MAAM,gBAAgB,GAAoB,SAAS,CAAC;YACnD,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,WAAW,IAAI,EAAE;YAE9B,MAAM,EAAE,aAAa;SACrB,CAAC,CAAC;QAEH,MAAM,SAAS,GAAuB,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;YAC7E,mBAAmB,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;YACzD,gBAAgB,CAAC,MAAM,EAAE,WAAY,EAAE,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAY,CAAE,CAAC,CAAC;QAChG,CAAC,CAAC;QAEF,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,uBAAuB;QACrC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;YAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAY,CAAC,CAAC;YAChF,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;YACrC,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnB,MAAM,CAAC,OAAO,CAAE,GAAG,CAAC,MAAoB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBAExE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;oBACjF,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC;oBAE3C,WAAW,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;gBAC1G,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC;IACH,CAAC;CACD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"swagger.service.d.ts","sourceRoot":"","sources":["../../src/services/swagger.service.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"swagger.service.d.ts","sourceRoot":"","sources":["../../src/services/swagger.service.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAYlD,qBAAa,cAAc;IACnB,KAAK,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAYzC,OAAO,CAAC,kBAAkB;CAuB1B"}
|
|
@@ -9,7 +9,7 @@ export class SwaggerService {
|
|
|
9
9
|
.setOpenAPIVersion('3.0.0')
|
|
10
10
|
.build();
|
|
11
11
|
const document = SwaggerModule.createDocument(app, config);
|
|
12
|
-
SwaggerModule.setup('/api', app, document, { jsonDocumentUrl: '/api/json' });
|
|
12
|
+
SwaggerModule.setup('/api', app, document, { jsonDocumentUrl: '/api/json', yamlDocumentUrl: '/api/yaml' });
|
|
13
13
|
}
|
|
14
14
|
patchSwaggerModule() {
|
|
15
15
|
SchemaObjectFactory.prototype.exploreModelSchema = function (type, schemas) {
|
|
@@ -19,6 +19,10 @@ export class SwaggerService {
|
|
|
19
19
|
schemas[type.name] = createSchema(type.schema, { io: 'input' }).schema;
|
|
20
20
|
return type.name;
|
|
21
21
|
};
|
|
22
|
+
const originalMethod = SchemaObjectFactory.prototype.createFromModel;
|
|
23
|
+
SchemaObjectFactory.prototype.createFromModel = function (parameters, schemas) {
|
|
24
|
+
return originalMethod.call(this, parameters, schemas);
|
|
25
|
+
};
|
|
22
26
|
}
|
|
23
27
|
}
|
|
24
28
|
//# sourceMappingURL=swagger.service.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"swagger.service.js","sourceRoot":"","sources":["../../src/services/swagger.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EACN,YAAY,EACZ,QAAQ,GACR,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACN,eAAe,EACf,aAAa,GACb,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"swagger.service.js","sourceRoot":"","sources":["../../src/services/swagger.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EACN,YAAY,EACZ,QAAQ,GACR,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACN,eAAe,EACf,aAAa,GACb,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAC;AAE7F,MAAM,OAAO,cAAc;IACnB,KAAK,CAAC,GAAqB;QACjC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE;aAClC,iBAAiB,CAAC,OAAO,CAAC;aAC1B,KAAK,EAAE,CAAC;QAEV,MAAM,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE3D,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEO,kBAAkB;QACzB,mBAAmB,CAAC,SAAS,CAAC,kBAAkB,GAAG,UAClD,IAA4B,EAC5B,OAA2C;YAE3C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;YACjE,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;YAEvE,OAAO,IAAI,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC;QAGF,MAAM,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,eAAe,CAAC;QACrE,mBAAmB,CAAC,SAAS,CAAC,eAAe,GAAG,UAC/C,UAAmC,EACnC,OAAqC;YAErC,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACvD,CAAC,CAAC;IACH,CAAC;CACD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-controller-suite.d.ts","sourceRoot":"","sources":["../../../src/tests/abstracts/base-controller-suite.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAEN,aAAa,EACb,MAAM,iBAAiB,CAAC;AAEzB,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"base-controller-suite.d.ts","sourceRoot":"","sources":["../../../src/tests/abstracts/base-controller-suite.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAEN,aAAa,EACb,MAAM,iBAAiB,CAAC;AAEzB,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAI7C,8BAAsB,mBAAoB,SAAQ,KAAK;IACtD,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;IACtC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoB;gBAE5B,UAAU,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IAM1B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBtB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/C,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,MAAM;CACpC"}
|
|
@@ -4,6 +4,7 @@ import { FastifyAdapter } from '@nestjs/platform-fastify';
|
|
|
4
4
|
import { Test as TestFactory, } from '@nestjs/testing';
|
|
5
5
|
import axios from 'axios';
|
|
6
6
|
import { HttpControllerModule } from '../../http-controller.module.js';
|
|
7
|
+
import { SwaggerService } from '../../services/index.js';
|
|
7
8
|
export class BaseControllerSuite extends Suite {
|
|
8
9
|
module;
|
|
9
10
|
container;
|
|
@@ -20,6 +21,8 @@ export class BaseControllerSuite extends Suite {
|
|
|
20
21
|
const port = this.getPort();
|
|
21
22
|
this.container = this.module.createNestApplication(new FastifyAdapter());
|
|
22
23
|
await this.container.init();
|
|
24
|
+
const swagger = this.container.get(SwaggerService);
|
|
25
|
+
swagger.setup(this.container);
|
|
23
26
|
await this.container.listen(port, 'localhost');
|
|
24
27
|
this.client = axios.create({ baseURL: `http://localhost:${port}` });
|
|
25
28
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-controller-suite.js","sourceRoot":"","sources":["../../../src/tests/abstracts/base-controller-suite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACN,IAAI,IAAI,WAAW,GAEnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAwB,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"base-controller-suite.js","sourceRoot":"","sources":["../../../src/tests/abstracts/base-controller-suite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAGrC,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACN,IAAI,IAAI,WAAW,GAEnB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAwB,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,MAAM,OAAgB,mBAAoB,SAAQ,KAAK;IAC5C,MAAM,CAAgB;IACtB,SAAS,CAAmB;IAC5B,MAAM,CAAgB;IACf,UAAU,CAAoB;IAE/C,YAAmB,UAA6B;QAC/C,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC9B,CAAC;IAEe,KAAK,CAAC,KAAK;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,WAAW;aAC7B,mBAAmB,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,oBAAoB,CAAC,EAAE,CAAC;aACvF,OAAO,EAAE,CAAC;QAEZ,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC;QAEzE,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAE5B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACnD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAE/C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,oBAAoB,IAAI,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAEe,KAAK,CAAC,QAAQ;QAC7B,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;CAGD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo-get.query.d.ts","sourceRoot":"","sources":["../../../../../src/tests/echo/controllers/dto/echo-get.query.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"echo-get.query.d.ts","sourceRoot":"","sources":["../../../../../src/tests/echo/controllers/dto/echo-get.query.ts"],"names":[],"mappings":";;;AASA,qBAAa,YAAa,SAAQ,iBAA4B;CAAG"}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { z } from '@hg-ts/validation';
|
|
2
|
-
const echoGetQuerySchema = z.object({
|
|
2
|
+
const echoGetQuerySchema = z.object({
|
|
3
|
+
test: z.string()
|
|
4
|
+
.transform(value => Number(value))
|
|
5
|
+
.pipe(z.number())
|
|
6
|
+
.meta({ description: 'Test param', deprecated: true }),
|
|
7
|
+
});
|
|
3
8
|
export class EchoGetQuery extends echoGetQuerySchema.toClass() {
|
|
4
9
|
}
|
|
5
10
|
//# sourceMappingURL=echo-get.query.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo-get.query.js","sourceRoot":"","sources":["../../../../../src/tests/echo/controllers/dto/echo-get.query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAEtC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"echo-get.query.js","sourceRoot":"","sources":["../../../../../src/tests/echo/controllers/dto/echo-get.query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAEtC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;SACd,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACjC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAChB,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;CACvD,CAAC,CAAC;AAEH,MAAM,OAAO,YAAa,SAAQ,kBAAkB,CAAC,OAAO,EAAE;CAAG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo.controller.d.ts","sourceRoot":"","sources":["../../../../src/tests/echo/controllers/echo.controller.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"echo.controller.d.ts","sourceRoot":"","sources":["../../../../src/tests/echo/controllers/echo.controller.ts"],"names":[],"mappings":"AASA,OAAO,EACN,YAAY,EACZ,YAAY,EACZ,MAAM,gBAAgB,CAAC;AAKxB,qBAEa,cAAc;IAEb,YAAY,CACV,KAAK,EAAE,YAAY,GAC/B,OAAO,CAAC,YAAY,CAAC;IAKX,YAAY,CACT,MAAM,EAAE,YAAY,GACjC,OAAO,CAAC,YAAY,CAAC;IAKX,aAAa,CACX,IAAI,EAAE,MAAM,GACxB,OAAO,CAAC,YAAY,CAAC;IAKX,aAAa,CACX,KAAK,EAAE,YAAY,GAC/B,OAAO,CAAC,YAAY,CAAC;IAKX,YAAY,CAChB,IAAI,EAAE,YAAY,GACxB,OAAO,CAAC,YAAY,CAAC;CAGxB"}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { __decorate, __metadata, __param } from "tslib";
|
|
2
2
|
import { z } from '@hg-ts/validation';
|
|
3
|
-
import { Body, Controller, Get,
|
|
3
|
+
import { Body, Controller, Get, Post, } from '@nestjs/common';
|
|
4
4
|
import { ApiTags } from '@nestjs/swagger';
|
|
5
5
|
import { Http } from '../../../decorators/index.js';
|
|
6
6
|
import { EchoGetQuery, EchoPostBody, } from './dto/index.js';
|
|
7
|
-
const TestHeader = Http.ValidatedHeader('test', z.string().transform(value => Number(value)).pipe(z.number())
|
|
7
|
+
const TestHeader = Http.ValidatedHeader('test', z.string().transform(value => Number(value)).pipe(z.number())
|
|
8
|
+
.meta({ description: 'Test header' }));
|
|
8
9
|
let EchoController = class EchoController {
|
|
9
10
|
async getEchoQuery(query) {
|
|
10
11
|
return query;
|
|
@@ -24,14 +25,14 @@ let EchoController = class EchoController {
|
|
|
24
25
|
};
|
|
25
26
|
__decorate([
|
|
26
27
|
Get('/query'),
|
|
27
|
-
__param(0, Query()),
|
|
28
|
+
__param(0, Http.Query()),
|
|
28
29
|
__metadata("design:type", Function),
|
|
29
30
|
__metadata("design:paramtypes", [EchoGetQuery]),
|
|
30
31
|
__metadata("design:returntype", Promise)
|
|
31
32
|
], EchoController.prototype, "getEchoQuery", null);
|
|
32
33
|
__decorate([
|
|
33
34
|
Get('/param/:test'),
|
|
34
|
-
__param(0,
|
|
35
|
+
__param(0, Http.Params()),
|
|
35
36
|
__metadata("design:type", Function),
|
|
36
37
|
__metadata("design:paramtypes", [EchoGetQuery]),
|
|
37
38
|
__metadata("design:returntype", Promise)
|
|
@@ -45,7 +46,7 @@ __decorate([
|
|
|
45
46
|
], EchoController.prototype, "getEchoHeader", null);
|
|
46
47
|
__decorate([
|
|
47
48
|
Post('/query'),
|
|
48
|
-
__param(0, Query()),
|
|
49
|
+
__param(0, Http.Query()),
|
|
49
50
|
__metadata("design:type", Function),
|
|
50
51
|
__metadata("design:paramtypes", [EchoGetQuery]),
|
|
51
52
|
__metadata("design:returntype", Promise)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo.controller.js","sourceRoot":"","sources":["../../../../src/tests/echo/controllers/echo.controller.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AACtC,OAAO,EACN,IAAI,EACJ,UAAU,EACV,GAAG,EACH,
|
|
1
|
+
{"version":3,"file":"echo.controller.js","sourceRoot":"","sources":["../../../../src/tests/echo/controllers/echo.controller.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AACtC,OAAO,EACN,IAAI,EACJ,UAAU,EACV,GAAG,EACH,IAAI,GACJ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AACpD,OAAO,EACN,YAAY,EACZ,YAAY,GACZ,MAAM,gBAAgB,CAAC;AAExB,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KAC3G,IAAI,CAAC,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;AAIjC,IAAM,cAAc,GAApB,MAAM,cAAc;IAEb,AAAN,KAAK,CAAC,YAAY,CACV,KAAmB;QAEjC,OAAO,KAAK,CAAC;IACd,CAAC;IAGY,AAAN,KAAK,CAAC,YAAY,CACT,MAAoB;QAEnC,OAAO,MAAM,CAAC;IACf,CAAC;IAGY,AAAN,KAAK,CAAC,aAAa,CACX,IAAY;QAE1B,OAAO,EAAE,IAAI,EAAE,CAAC;IACjB,CAAC;IAGY,AAAN,KAAK,CAAC,aAAa,CACX,KAAmB;QAEjC,OAAO,KAAK,CAAC;IACd,CAAC;IAGY,AAAN,KAAK,CAAC,YAAY,CAChB,IAAkB;QAE1B,OAAO,IAAI,CAAC;IACb,CAAC;CACD,CAAA;AAjCa;IADZ,GAAG,CAAC,QAAQ,CAAC;IAEZ,WAAA,IAAI,CAAC,KAAK,EAAE,CAAA;;qCAAQ,YAAY;;kDAGjC;AAGY;IADZ,GAAG,CAAC,cAAc,CAAC;IAElB,WAAA,IAAI,CAAC,MAAM,EAAE,CAAA;;qCAAS,YAAY;;kDAGnC;AAGY;IADZ,GAAG,CAAC,UAAU,CAAC;IAEd,WAAA,UAAU,EAAE,CAAA;;;;mDAGb;AAGY;IADZ,IAAI,CAAC,QAAQ,CAAC;IAEb,WAAA,IAAI,CAAC,KAAK,EAAE,CAAA;;qCAAQ,YAAY;;mDAGjC;AAGY;IADZ,IAAI,CAAC,OAAO,CAAC;IAEZ,WAAA,IAAI,EAAE,CAAA;;qCAAO,YAAY;;kDAG1B;AAlCW,cAAc;IAF1B,OAAO,CAAC,MAAM,CAAC;IACf,UAAU,CAAC,OAAO,CAAC;GACP,cAAc,CAmC1B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo.test.d.ts","sourceRoot":"","sources":["../../../src/tests/echo/echo.test.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,qBACa,QAAS,SAAQ,mBAAmB;;IAMnC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IASxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAepC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAS9B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAS7B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"echo.test.d.ts","sourceRoot":"","sources":["../../../src/tests/echo/echo.test.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,qBACa,QAAS,SAAQ,mBAAmB;;IAMnC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IASxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAepC,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAS9B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAS7B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAS7B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQpC,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;cAOnC,OAAO,IAAI,MAAM;IAIpC,OAAO,CAAC,iBAAiB;CAGzB"}
|
|
@@ -11,7 +11,7 @@ let EchoTest = class EchoTest extends BaseControllerSuite {
|
|
|
11
11
|
const value = '3.12';
|
|
12
12
|
const params = { test: value };
|
|
13
13
|
const response = await this.client.get('/echo/query', { params });
|
|
14
|
-
expect(response.data).toMatchObject(
|
|
14
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
15
15
|
}
|
|
16
16
|
async echoHeader() {
|
|
17
17
|
const value = '3.12';
|
|
@@ -35,7 +35,7 @@ let EchoTest = class EchoTest extends BaseControllerSuite {
|
|
|
35
35
|
const value = '3.12';
|
|
36
36
|
const params = { test: value };
|
|
37
37
|
const response = await this.client.post('/echo/query', null, { params });
|
|
38
|
-
expect(response.data).toMatchObject(
|
|
38
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
39
39
|
}
|
|
40
40
|
async echoPostBody() {
|
|
41
41
|
const value = 3.12;
|
|
@@ -45,9 +45,8 @@ let EchoTest = class EchoTest extends BaseControllerSuite {
|
|
|
45
45
|
}
|
|
46
46
|
async echoGetParam() {
|
|
47
47
|
const value = '3.12';
|
|
48
|
-
const params = { test: value };
|
|
49
48
|
const response = await this.client.get(`/echo/param/${value}`);
|
|
50
|
-
expect(response.data).toMatchObject(
|
|
49
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
51
50
|
}
|
|
52
51
|
async echoGetInvalidQuery() {
|
|
53
52
|
const value = '5.16';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"echo.test.js","sourceRoot":"","sources":["../../../src/tests/echo/echo.test.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,QAAQ,EACR,MAAM,EACN,eAAe,EACf,IAAI,GACJ,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,UAAU,EACV,YAAY,GACZ,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGhD,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,mBAAmB;IAChD;QACC,KAAK,CAAC,cAAc,CAAC,CAAC;IACvB,CAAC;IAGY,AAAN,KAAK,CAAC,OAAO;QACnB,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,MAAM,GAA4B,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAElE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"echo.test.js","sourceRoot":"","sources":["../../../src/tests/echo/echo.test.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,QAAQ,EACR,MAAM,EACN,eAAe,EACf,IAAI,GACJ,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,UAAU,EACV,YAAY,GACZ,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGhD,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,mBAAmB;IAChD;QACC,KAAK,CAAC,cAAc,CAAC,CAAC;IACvB,CAAC;IAGY,AAAN,KAAK,CAAC,OAAO;QACnB,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,MAAM,GAA4B,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAElE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;IAGY,AAAN,KAAK,CAAC,UAAU;QACtB,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAErE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;IAIY,AAAN,KAAK,CAAC,mBAAmB;QAC/B,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,OAAO,CAAC;YACtB,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5C,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEzC,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAGY,AAAN,KAAK,CAAC,aAAa;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,MAAM,GAA4B,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEzE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;IAGY,AAAN,KAAK,CAAC,YAAY;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,MAAM,IAAI,GAA4B,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAE5D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAGY,AAAN,KAAK,CAAC,YAAY;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC;QAE/D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;IAIY,AAAN,KAAK,CAAC,mBAAmB;QAC/B,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,MAAM,GAA4B,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QAC9D,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAClD,CAAC;IAIY,AAAN,KAAK,CAAC,wBAAwB;QACpC,MAAM,KAAK,GAAG,mBAAmB,CAAC;QAClC,MAAM,MAAM,GAA4B,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;QAEhE,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC;IAEkB,OAAO;QACzB,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,iBAAiB,CAAC,YAAqB;QAC9C,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;CACD,CAAA;AAnFa;IADZ,IAAI,EAAE;;;;uCAON;AAGY;IADZ,IAAI,EAAE;;;;0CAON;AAIY;IAFZ,IAAI,EAAE;IACN,eAAe,CAAC,UAAU,CAAC;;;;mDAa3B;AAGY;IADZ,IAAI,EAAE;;;;6CAON;AAGY;IADZ,IAAI,EAAE;;;;4CAON;AAGY;IADZ,IAAI,EAAE;;;;4CAMN;AAIY;IAFZ,IAAI,EAAE;IACN,eAAe,EAAE;;;;mDAKjB;AAIY;IAFZ,IAAI,EAAE;IACN,eAAe,EAAE;;;;wDAMjB;AAhFW,QAAQ;IADpB,QAAQ,EAAE;;GACE,QAAQ,CAyFpB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hg-ts/http-controller",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.38",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -18,15 +18,16 @@
|
|
|
18
18
|
"test:dev": "vitest watch"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
|
-
"@
|
|
22
|
-
"@hg-ts/
|
|
23
|
-
"@hg-ts/
|
|
24
|
-
"@hg-ts/
|
|
25
|
-
"@hg-ts/
|
|
26
|
-
"@hg-ts/
|
|
27
|
-
"@hg-ts/
|
|
28
|
-
"@hg-ts/
|
|
29
|
-
"@hg-ts/
|
|
21
|
+
"@fastify/static": "9.0.0",
|
|
22
|
+
"@hg-ts-config/typescript": "0.5.38",
|
|
23
|
+
"@hg-ts/exception": "0.5.38",
|
|
24
|
+
"@hg-ts/execution-mode": "0.5.38",
|
|
25
|
+
"@hg-ts/knex": "0.5.38",
|
|
26
|
+
"@hg-ts/linter": "0.5.38",
|
|
27
|
+
"@hg-ts/logger": "0.5.38",
|
|
28
|
+
"@hg-ts/tests": "0.5.38",
|
|
29
|
+
"@hg-ts/types": "0.5.38",
|
|
30
|
+
"@hg-ts/validation": "0.5.38",
|
|
30
31
|
"@nestjs/common": "11.1.0",
|
|
31
32
|
"@nestjs/core": "11.1.0",
|
|
32
33
|
"@nestjs/platform-fastify": "11.1.0",
|
|
@@ -47,11 +48,11 @@
|
|
|
47
48
|
"vitest": "4.0.14"
|
|
48
49
|
},
|
|
49
50
|
"peerDependencies": {
|
|
50
|
-
"@hg-ts/exception": "0.5.
|
|
51
|
-
"@hg-ts/execution-mode": "0.5.
|
|
52
|
-
"@hg-ts/knex": "0.5.
|
|
53
|
-
"@hg-ts/logger": "0.5.
|
|
54
|
-
"@hg-ts/validation": "0.5.
|
|
51
|
+
"@hg-ts/exception": "0.5.38",
|
|
52
|
+
"@hg-ts/execution-mode": "0.5.38",
|
|
53
|
+
"@hg-ts/knex": "0.5.38",
|
|
54
|
+
"@hg-ts/logger": "0.5.38",
|
|
55
|
+
"@hg-ts/validation": "0.5.38",
|
|
55
56
|
"@nestjs/common": "*",
|
|
56
57
|
"@nestjs/core": "*",
|
|
57
58
|
"@nestjs/platform-fastify": "*",
|
|
@@ -1,11 +1,22 @@
|
|
|
1
1
|
import { BaseException } from '@hg-ts/exception';
|
|
2
2
|
import {
|
|
3
3
|
createSchema,
|
|
4
|
+
isZodDto,
|
|
4
5
|
z,
|
|
6
|
+
ZodObject,
|
|
5
7
|
} from '@hg-ts/validation';
|
|
6
|
-
import {
|
|
8
|
+
import {
|
|
9
|
+
createParamDecorator,
|
|
10
|
+
Param,
|
|
11
|
+
Query,
|
|
12
|
+
} from '@nestjs/common';
|
|
7
13
|
|
|
8
|
-
import {
|
|
14
|
+
import {
|
|
15
|
+
ApiHeader,
|
|
16
|
+
ApiProperty,
|
|
17
|
+
ApiResponse,
|
|
18
|
+
ApiResponseOptions,
|
|
19
|
+
} from '@nestjs/swagger';
|
|
9
20
|
import { FastifyRequest } from 'fastify';
|
|
10
21
|
|
|
11
22
|
import { ExceptionStatusAlreadyDefinedException } from '../exceptions/index.js';
|
|
@@ -16,9 +27,14 @@ export type ExceptionMap = Map<Class<BaseException, any[]>, number>;
|
|
|
16
27
|
export const EXCEPTION_METADATA_KEY = Symbol('EXCEPTION_METADATA_KEY');
|
|
17
28
|
|
|
18
29
|
export class Http {
|
|
19
|
-
private constructor() {
|
|
30
|
+
private constructor() {
|
|
31
|
+
}
|
|
20
32
|
|
|
21
|
-
public static ExceptionStatus(
|
|
33
|
+
public static ExceptionStatus(
|
|
34
|
+
exception: Class<BaseException, any[]>,
|
|
35
|
+
statusCode: number,
|
|
36
|
+
options?: Omit<ApiResponseOptions, 'status'>,
|
|
37
|
+
): MethodDecorator {
|
|
22
38
|
return (target: any, propertyKey: string | symbol, descriptor: PropertyDescriptor) => {
|
|
23
39
|
const statusMap: ExceptionMap =
|
|
24
40
|
Reflect.getMetadata(EXCEPTION_METADATA_KEY, target, propertyKey) ?? new Map();
|
|
@@ -40,18 +56,68 @@ export class Http {
|
|
|
40
56
|
.map(item => item.schema as any);
|
|
41
57
|
|
|
42
58
|
ApiResponse({
|
|
59
|
+
...options,
|
|
43
60
|
schema: schemas.length === 1 ? schemas[0] : { oneOf: schemas },
|
|
44
61
|
status: statusCode,
|
|
45
62
|
})(target, propertyKey, descriptor);
|
|
46
63
|
};
|
|
47
64
|
}
|
|
48
65
|
|
|
49
|
-
public static
|
|
50
|
-
return
|
|
66
|
+
public static Params(): ParameterDecorator {
|
|
67
|
+
return (target, propertyKey, parameterIndex) => {
|
|
68
|
+
Param()(target, propertyKey, parameterIndex);
|
|
69
|
+
this.getApiPropertyDecorator()(target, propertyKey, parameterIndex);
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
public static Query(): ParameterDecorator {
|
|
74
|
+
return (target, propertyKey, parameterIndex) => {
|
|
75
|
+
Query()(target, propertyKey, parameterIndex);
|
|
76
|
+
this.getApiPropertyDecorator()(target, propertyKey, parameterIndex);
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
public static ValidatedHeader<T>(
|
|
81
|
+
headerName: string,
|
|
82
|
+
schema: z.ZodSchema<T>,
|
|
83
|
+
): () => ParameterDecorator {
|
|
84
|
+
const validationDecorator: ParameterDecorator = createParamDecorator((_data: unknown, ctx): T => {
|
|
51
85
|
const request = ctx.switchToHttp().getRequest<FastifyRequest>();
|
|
52
86
|
const header = request.headers[headerName];
|
|
53
87
|
|
|
54
88
|
return schema.parse(header);
|
|
89
|
+
})();
|
|
90
|
+
|
|
91
|
+
const { description, ...openApiSchema } = createSchema(schema).schema;
|
|
92
|
+
|
|
93
|
+
const openapiDecorator: MethodDecorator = ApiHeader({
|
|
94
|
+
name: headerName,
|
|
95
|
+
description: description ?? '',
|
|
96
|
+
// @ts-expect-error
|
|
97
|
+
schema: openApiSchema,
|
|
55
98
|
});
|
|
99
|
+
|
|
100
|
+
const decorator: ParameterDecorator = (target, propertyKey, parameterIndex) => {
|
|
101
|
+
validationDecorator(target, propertyKey, parameterIndex);
|
|
102
|
+
openapiDecorator(target, propertyKey!, Object.getOwnPropertyDescriptor(target, propertyKey!)!);
|
|
103
|
+
};
|
|
104
|
+
|
|
105
|
+
return () => decorator;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
private static getApiPropertyDecorator(): ParameterDecorator {
|
|
109
|
+
return (target, propertyKey, parameterIndex) => {
|
|
110
|
+
const metadata = Reflect.getMetadata('design:paramtypes', target, propertyKey!);
|
|
111
|
+
const dto = metadata[parameterIndex];
|
|
112
|
+
if (isZodDto(dto)) {
|
|
113
|
+
Object.entries((dto.schema as ZodObject).shape).forEach(([key, value]) => {
|
|
114
|
+
// @ts-expect-error
|
|
115
|
+
const { description, deprecated, ...openApiSchema } = createSchema(value).schema;
|
|
116
|
+
const optional = value.safeParse().success;
|
|
117
|
+
// @ts-expect-error
|
|
118
|
+
ApiProperty({ schema: openApiSchema, required: !optional, description, deprecated })(dto.prototype, key);
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
};
|
|
56
122
|
}
|
|
57
123
|
}
|
|
@@ -9,7 +9,11 @@ import {
|
|
|
9
9
|
DocumentBuilder,
|
|
10
10
|
SwaggerModule,
|
|
11
11
|
} from '@nestjs/swagger';
|
|
12
|
-
import {
|
|
12
|
+
import {
|
|
13
|
+
BaseParameterObject,
|
|
14
|
+
SchemaObject,
|
|
15
|
+
} from '@nestjs/swagger/dist/interfaces/open-api-spec.interface.js';
|
|
16
|
+
import { ParamWithTypeMetadata } from '@nestjs/swagger/dist/services/parameter-metadata-accessor.js';
|
|
13
17
|
import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object-factory.js';
|
|
14
18
|
|
|
15
19
|
export class SwaggerService {
|
|
@@ -22,7 +26,7 @@ export class SwaggerService {
|
|
|
22
26
|
|
|
23
27
|
const document = SwaggerModule.createDocument(app, config);
|
|
24
28
|
|
|
25
|
-
SwaggerModule.setup('/api', app, document, { jsonDocumentUrl: '/api/json' });
|
|
29
|
+
SwaggerModule.setup('/api', app, document, { jsonDocumentUrl: '/api/json', yamlDocumentUrl: '/api/yaml' });
|
|
26
30
|
}
|
|
27
31
|
|
|
28
32
|
private patchSwaggerModule(): void {
|
|
@@ -38,5 +42,14 @@ export class SwaggerService {
|
|
|
38
42
|
|
|
39
43
|
return type.name;
|
|
40
44
|
};
|
|
45
|
+
|
|
46
|
+
// eslint-disable-next-line @typescript/unbound-method
|
|
47
|
+
const originalMethod = SchemaObjectFactory.prototype.createFromModel;
|
|
48
|
+
SchemaObjectFactory.prototype.createFromModel = function(
|
|
49
|
+
parameters: ParamWithTypeMetadata[],
|
|
50
|
+
schemas: Record<string, SchemaObject>,
|
|
51
|
+
): (ParamWithTypeMetadata | BaseParameterObject)[] {
|
|
52
|
+
return originalMethod.call(this, parameters, schemas);
|
|
53
|
+
};
|
|
41
54
|
}
|
|
42
55
|
}
|
|
@@ -10,6 +10,7 @@ import {
|
|
|
10
10
|
|
|
11
11
|
import axios, { AxiosInstance } from 'axios';
|
|
12
12
|
import { HttpControllerModule } from '../../http-controller.module.js';
|
|
13
|
+
import { SwaggerService } from '../../services/index.js';
|
|
13
14
|
|
|
14
15
|
export abstract class BaseControllerSuite extends Suite {
|
|
15
16
|
protected module: TestingModule;
|
|
@@ -30,10 +31,13 @@ export abstract class BaseControllerSuite extends Suite {
|
|
|
30
31
|
|
|
31
32
|
const port = this.getPort();
|
|
32
33
|
|
|
33
|
-
|
|
34
34
|
this.container = this.module.createNestApplication(new FastifyAdapter());
|
|
35
35
|
|
|
36
36
|
await this.container.init();
|
|
37
|
+
|
|
38
|
+
const swagger = this.container.get(SwaggerService);
|
|
39
|
+
swagger.setup(this.container);
|
|
40
|
+
|
|
37
41
|
await this.container.listen(port, 'localhost');
|
|
38
42
|
|
|
39
43
|
this.client = axios.create({ baseURL: `http://localhost:${port}` });
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { z } from '@hg-ts/validation';
|
|
2
2
|
|
|
3
|
-
const echoGetQuerySchema = z.object({
|
|
3
|
+
const echoGetQuerySchema = z.object({
|
|
4
|
+
test: z.string()
|
|
5
|
+
.transform(value => Number(value))
|
|
6
|
+
.pipe(z.number())
|
|
7
|
+
.meta({ description: 'Test param', deprecated: true }),
|
|
8
|
+
});
|
|
4
9
|
|
|
5
10
|
export class EchoGetQuery extends echoGetQuerySchema.toClass() {}
|
|
@@ -3,9 +3,7 @@ import {
|
|
|
3
3
|
Body,
|
|
4
4
|
Controller,
|
|
5
5
|
Get,
|
|
6
|
-
Param,
|
|
7
6
|
Post,
|
|
8
|
-
Query,
|
|
9
7
|
} from '@nestjs/common';
|
|
10
8
|
import { ApiTags } from '@nestjs/swagger';
|
|
11
9
|
import { Http } from '../../../decorators/index.js';
|
|
@@ -14,21 +12,22 @@ import {
|
|
|
14
12
|
EchoPostBody,
|
|
15
13
|
} from './dto/index.js';
|
|
16
14
|
|
|
17
|
-
const TestHeader = Http.ValidatedHeader('test', z.string().transform(value => Number(value)).pipe(z.number())
|
|
15
|
+
const TestHeader = Http.ValidatedHeader('test', z.string().transform(value => Number(value)).pipe(z.number())
|
|
16
|
+
.meta({ description: 'Test header' }));
|
|
18
17
|
|
|
19
18
|
@ApiTags('Echo')
|
|
20
19
|
@Controller('/echo')
|
|
21
20
|
export class EchoController {
|
|
22
21
|
@Get('/query')
|
|
23
22
|
public async getEchoQuery(
|
|
24
|
-
@Query() query: EchoGetQuery,
|
|
23
|
+
@Http.Query() query: EchoGetQuery,
|
|
25
24
|
): Promise<EchoGetQuery> {
|
|
26
25
|
return query;
|
|
27
26
|
}
|
|
28
27
|
|
|
29
28
|
@Get('/param/:test')
|
|
30
29
|
public async getEchoParam(
|
|
31
|
-
@
|
|
30
|
+
@Http.Params() params: EchoGetQuery,
|
|
32
31
|
): Promise<EchoGetQuery> {
|
|
33
32
|
return params;
|
|
34
33
|
}
|
|
@@ -42,7 +41,7 @@ export class EchoController {
|
|
|
42
41
|
|
|
43
42
|
@Post('/query')
|
|
44
43
|
public async postEchoQuery(
|
|
45
|
-
@Query() query: EchoGetQuery,
|
|
44
|
+
@Http.Query() query: EchoGetQuery,
|
|
46
45
|
): Promise<EchoGetQuery> {
|
|
47
46
|
return query;
|
|
48
47
|
}
|
|
@@ -24,7 +24,7 @@ export class EchoTest extends BaseControllerSuite {
|
|
|
24
24
|
const params: Record<string, unknown> = { test: value };
|
|
25
25
|
const response = await this.client.get('/echo/query', { params });
|
|
26
26
|
|
|
27
|
-
expect(response.data).toMatchObject(
|
|
27
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
@Test()
|
|
@@ -58,7 +58,7 @@ export class EchoTest extends BaseControllerSuite {
|
|
|
58
58
|
const params: Record<string, unknown> = { test: value };
|
|
59
59
|
const response = await this.client.post('/echo/query', null, { params });
|
|
60
60
|
|
|
61
|
-
expect(response.data).toMatchObject(
|
|
61
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
62
62
|
}
|
|
63
63
|
|
|
64
64
|
@Test()
|
|
@@ -73,10 +73,9 @@ export class EchoTest extends BaseControllerSuite {
|
|
|
73
73
|
@Test()
|
|
74
74
|
public async echoGetParam(): Promise<void> {
|
|
75
75
|
const value = '3.12';
|
|
76
|
-
const params: Record<string, unknown> = { test: value };
|
|
77
76
|
const response = await this.client.get(`/echo/param/${value}`);
|
|
78
77
|
|
|
79
|
-
expect(response.data).toMatchObject(
|
|
78
|
+
expect(response.data).toMatchObject({ test: Number(value) });
|
|
80
79
|
}
|
|
81
80
|
|
|
82
81
|
@Test()
|