nicot 1.0.19 → 1.0.20
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 +3 -2
- package/dist/src/decorators/restful.d.ts +9 -0
- package/dist/src/decorators/restful.js +13 -0
- package/dist/src/decorators/restful.js.map +1 -1
- package/dist/src/dto/import-entry.d.ts +7 -1
- package/dist/src/dto/import-entry.js +18 -1
- package/dist/src/dto/import-entry.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,7 +89,8 @@ Would also register proper OpenAPI documentation for the controller.
|
|
|
89
89
|
|
|
90
90
|
```ts
|
|
91
91
|
const dec = new RestfulFactory(User);
|
|
92
|
-
class
|
|
92
|
+
class FindAllUsersDto extends dec.findAllDto {} // to extract type and class
|
|
93
|
+
class UpdateUserDto extends dec.updateDto {}
|
|
93
94
|
|
|
94
95
|
@Controller('user')
|
|
95
96
|
export class UserController {
|
|
@@ -106,7 +107,7 @@ export class UserController {
|
|
|
106
107
|
}
|
|
107
108
|
|
|
108
109
|
@dec.findAll() // GET /
|
|
109
|
-
findAll(@dec.findAllParam() user:
|
|
110
|
+
findAll(@dec.findAllParam() user: FindAllUsersDto) {
|
|
110
111
|
return this.userService.findAll(user);
|
|
111
112
|
}
|
|
112
113
|
|
|
@@ -12,9 +12,17 @@ export declare class RestfulFactory<T> {
|
|
|
12
12
|
readonly entityArrayReturnMessageDto: new (statusCode: number, message: string, data: unknown[], total: number, pageSettings: import("../bases").PageSettingsWise) => import("../dto").GenericPaginatedReturnMessageDto<unknown> & {
|
|
13
13
|
data: T[];
|
|
14
14
|
};
|
|
15
|
+
readonly importReturnMessageDto: new (statusCode: number, message?: string, data?: unknown) => import("../dto").GenericReturnMessageDto<unknown> & {
|
|
16
|
+
data: import("../dto").ImportEntryBaseDto & {
|
|
17
|
+
entry: T;
|
|
18
|
+
};
|
|
19
|
+
};
|
|
15
20
|
readonly fieldsToOmit: (keyof T)[];
|
|
16
21
|
private readonly basicDto;
|
|
17
22
|
readonly createDto: ClassType<T>;
|
|
23
|
+
readonly importDto: new () => import("../dto").ImportDataBaseDto<unknown> & {
|
|
24
|
+
entry: T[];
|
|
25
|
+
};
|
|
18
26
|
readonly findAllDto: ClassType<T>;
|
|
19
27
|
readonly updateDto: ClassType<T>;
|
|
20
28
|
readonly idType: Function;
|
|
@@ -28,4 +36,5 @@ export declare class RestfulFactory<T> {
|
|
|
28
36
|
update(extras?: Partial<OperationObject>): MethodDecorator;
|
|
29
37
|
updateParam(): ParameterDecorator;
|
|
30
38
|
delete(extras?: Partial<OperationObject>): MethodDecorator;
|
|
39
|
+
import(extras?: Partial<OperationObject>): MethodDecorator;
|
|
31
40
|
}
|
|
@@ -17,12 +17,14 @@ class RestfulFactory {
|
|
|
17
17
|
this.options = options;
|
|
18
18
|
this.entityReturnMessageDto = (0, dto_1.ReturnMessageDto)(this.entityClass);
|
|
19
19
|
this.entityArrayReturnMessageDto = (0, dto_1.PaginatedReturnMessageDto)(this.entityClass);
|
|
20
|
+
this.importReturnMessageDto = (0, dto_1.ReturnMessageDto)((0, dto_1.ImportEntryDto)(this.entityClass));
|
|
20
21
|
this.fieldsToOmit = lodash_1.default.uniq([
|
|
21
22
|
...(0, metadata_1.getSpecificFields)(this.entityClass, 'notColumn'),
|
|
22
23
|
...(this.options.fieldsToOmit || []),
|
|
23
24
|
]);
|
|
24
25
|
this.basicDto = (0, swagger_1.OmitType)(this.entityClass, this.fieldsToOmit);
|
|
25
26
|
this.createDto = (0, swagger_1.OmitType)(this.entityClass, (0, metadata_1.getSpecificFields)(this.entityClass, 'notWritable'));
|
|
27
|
+
this.importDto = (0, dto_1.ImportDataDto)(this.createDto);
|
|
26
28
|
this.findAllDto = (0, swagger_1.PartialType)(this.basicDto);
|
|
27
29
|
this.updateDto = (0, swagger_1.PartialType)((0, swagger_1.OmitType)(this.createDto, (0, metadata_1.getSpecificFields)(this.entityClass, 'notChangeable')));
|
|
28
30
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
@@ -97,6 +99,17 @@ class RestfulFactory {
|
|
|
97
99
|
(0, swagger_1.ApiNoContentResponse)({ type: dto_1.BlankReturnMessageDto }),
|
|
98
100
|
]);
|
|
99
101
|
}
|
|
102
|
+
import(extras = {}) {
|
|
103
|
+
return (0, merge_1.MergeMethodDecorators)([
|
|
104
|
+
(0, common_1.Post)('import'),
|
|
105
|
+
(0, swagger_1.ApiOperation)({
|
|
106
|
+
summary: `Import ${this.entityClass.name}`,
|
|
107
|
+
...extras,
|
|
108
|
+
}),
|
|
109
|
+
(0, swagger_1.ApiBody)({ type: this.importDto }),
|
|
110
|
+
(0, swagger_1.ApiCreatedResponse)({ type: this.importReturnMessageDto }),
|
|
111
|
+
]);
|
|
112
|
+
}
|
|
100
113
|
}
|
|
101
114
|
exports.RestfulFactory = RestfulFactory;
|
|
102
115
|
//# sourceMappingURL=restful.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"restful.js","sourceRoot":"","sources":["../../../src/decorators/restful.ts"],"names":[],"mappings":";;;;;;AAAA,2CASwB;AACxB,
|
|
1
|
+
{"version":3,"file":"restful.js","sourceRoot":"","sources":["../../../src/decorators/restful.ts"],"names":[],"mappings":";;;;;;AAAA,2CASwB;AACxB,gCAMgB;AAChB,mCAAgD;AAEhD,6CASyB;AACzB,mCAA0D;AAE1D,oDAAuB;AACvB,kDAAwD;AAMxD,MAAa,cAAc;IAmCzB,YACkB,WAAyB,EACjC,UAAoC,EAAE;QAD9B,gBAAW,GAAX,WAAW,CAAc;QACjC,YAAO,GAAP,OAAO,CAA+B;QApCvC,2BAAsB,GAAG,IAAA,sBAAgB,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,gCAA2B,GAAG,IAAA,+BAAyB,EAC9D,IAAI,CAAC,WAAW,CACjB,CAAC;QACO,2BAAsB,GAAG,IAAA,sBAAgB,EAChD,IAAA,oBAAc,EAAC,IAAI,CAAC,WAAW,CAAC,CACjC,CAAC;QACO,iBAAY,GAAG,gBAAC,CAAC,IAAI,CAAC;YAC7B,GAAI,IAAA,4BAAiB,EAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAiB;YACpE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;SACrC,CAAC,CAAC;QACc,aAAQ,GAAG,IAAA,kBAAQ,EAClC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,YAAY,CACF,CAAC;QACT,cAAS,GAAG,IAAA,kBAAQ,EAC3B,IAAI,CAAC,WAAW,EAChB,IAAA,4BAAiB,EAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAgB,CAClD,CAAC;QACT,cAAS,GAAG,IAAA,mBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,eAAU,GAAG,IAAA,qBAAW,EAAC,IAAI,CAAC,QAAQ,CAAiB,CAAC;QACxD,cAAS,GAAG,IAAA,qBAAW,EAC9B,IAAA,kBAAQ,EACN,IAAI,CAAC,SAAS,EACd,IAAA,4BAAiB,EAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAgB,CACpE,CACc,CAAC;QAClB,wDAAwD;QAC/C,WAAM,GAAa,OAAO,CAAC,WAAW,CAC7C,aAAa,EACb,IAAI,CAAC,WAAW,CAAC,SAAS,EAC1B,IAAI,CACL,CAAC;IAKC,CAAC;IAEJ,MAAM,CAAC,SAAmC,EAAE;QAC1C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,aAAI,GAAE;YACN,IAAA,sBAAY,EAAC;gBACX,OAAO,EAAE,gBAAgB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAChD,GAAG,MAAM;aACV,CAAC;YACF,IAAA,iBAAO,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,IAAA,4BAAkB,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAA,aAAI,EAAC,kBAAU,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,CAAC,SAAmC,EAAE;QAC3C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,YAAG,EAAC,KAAK,CAAC;YACV,IAAA,sBAAY,EAAC;gBACX,OAAO,EAAE,UAAU,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ;gBAChD,GAAG,MAAM;aACV,CAAC;YACF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC3D,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC;SACrD,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE;YAC1B,OAAO,IAAA,cAAK,EAAC,IAAI,EAAE,qBAAY,CAAC,CAAC;SAClC;aAAM;YACL,OAAO,IAAA,cAAK,EAAC,IAAI,CAAC,CAAC;SACpB;IACH,CAAC;IAED,OAAO,CAAC,SAAmC,EAAE;QAC3C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,YAAG,GAAE;YACL,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,YAAY,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC;YACzE,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,2BAA2B,EAAE,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC;IAED,YAAY;QACV,OAAO,IAAA,cAAK,EAAC,eAAO,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,SAAmC,EAAE;QAC1C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,cAAK,EAAC,KAAK,CAAC;YACZ,IAAA,sBAAY,EAAC;gBACX,OAAO,EAAE,YAAY,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ;gBAClD,GAAG,MAAM;aACV,CAAC;YACF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC3D,IAAA,iBAAO,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,2BAAqB,EAAE,CAAC;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAA,aAAI,EAAC,kBAAU,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,SAAmC,EAAE;QAC1C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,eAAM,EAAC,KAAK,CAAC;YACb,IAAA,sBAAY,EAAC;gBACX,OAAO,EAAE,YAAY,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ;gBAClD,GAAG,MAAM;aACV,CAAC;YACF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC3D,IAAA,8BAAoB,EAAC,EAAE,IAAI,EAAE,2BAAqB,EAAE,CAAC;SACtD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,SAAmC,EAAE;QAC1C,OAAO,IAAA,6BAAqB,EAAC;YAC3B,IAAA,aAAI,EAAC,QAAQ,CAAC;YACd,IAAA,sBAAY,EAAC;gBACX,OAAO,EAAE,UAAU,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC1C,GAAG,MAAM;aACV,CAAC;YACF,IAAA,iBAAO,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,IAAA,4BAAkB,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC;CACF;AAhID,wCAgIC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ClassOrArray } from '../utility/insert-field';
|
|
1
|
+
import { AnyClass, ClassOrArray } from '../utility/insert-field';
|
|
2
2
|
export declare class ImportEntryBaseDto {
|
|
3
3
|
result: string;
|
|
4
4
|
}
|
|
@@ -9,3 +9,9 @@ export interface ImportEntry<T> {
|
|
|
9
9
|
export declare function ImportEntryDto<C extends ClassOrArray>(type: C): new () => ImportEntryBaseDto & {
|
|
10
10
|
entry: import("../utility/insert-field").ParseType<C>;
|
|
11
11
|
};
|
|
12
|
+
export declare class ImportDataBaseDto<T> {
|
|
13
|
+
data: T[];
|
|
14
|
+
}
|
|
15
|
+
export declare function ImportDataDto<C extends AnyClass>(type: C): new () => ImportDataBaseDto<unknown> & {
|
|
16
|
+
entry: import("../utility/insert-field").TypeFromClass<C>[];
|
|
17
|
+
};
|
|
@@ -9,8 +9,10 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
9
9
|
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.ImportEntryDto = exports.ImportEntryBaseDto = void 0;
|
|
12
|
+
exports.ImportDataDto = exports.ImportDataBaseDto = exports.ImportEntryDto = exports.ImportEntryBaseDto = void 0;
|
|
13
13
|
const swagger_1 = require("@nestjs/swagger");
|
|
14
|
+
const class_transformer_1 = require("class-transformer");
|
|
15
|
+
const class_validator_1 = require("class-validator");
|
|
14
16
|
const insert_field_1 = require("../utility/insert-field");
|
|
15
17
|
class ImportEntryBaseDto {
|
|
16
18
|
}
|
|
@@ -25,4 +27,19 @@ function ImportEntryDto(type) {
|
|
|
25
27
|
}, `${(0, insert_field_1.getClassFromClassOrArray)(type).name}ImportEntry`);
|
|
26
28
|
}
|
|
27
29
|
exports.ImportEntryDto = ImportEntryDto;
|
|
30
|
+
class ImportDataBaseDto {
|
|
31
|
+
}
|
|
32
|
+
__decorate([
|
|
33
|
+
(0, class_validator_1.ValidateNested)(),
|
|
34
|
+
__metadata("design:type", Array)
|
|
35
|
+
], ImportDataBaseDto.prototype, "data", void 0);
|
|
36
|
+
exports.ImportDataBaseDto = ImportDataBaseDto;
|
|
37
|
+
function ImportDataDto(type) {
|
|
38
|
+
const dtoClass = (0, insert_field_1.InsertField)(ImportDataBaseDto, {
|
|
39
|
+
entry: { type: [type], options: { description: 'Import data' } },
|
|
40
|
+
}, `${(0, insert_field_1.getClassFromClassOrArray)(type).name}ImportData`);
|
|
41
|
+
(0, class_transformer_1.Type)(() => dtoClass)(dtoClass.prototype, 'data');
|
|
42
|
+
return dtoClass;
|
|
43
|
+
}
|
|
44
|
+
exports.ImportDataDto = ImportDataDto;
|
|
28
45
|
//# sourceMappingURL=import-entry.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"import-entry.js","sourceRoot":"","sources":["../../../src/dto/import-entry.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA8C;AAC9C,
|
|
1
|
+
{"version":3,"file":"import-entry.js","sourceRoot":"","sources":["../../../src/dto/import-entry.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA8C;AAC9C,yDAAyC;AACzC,qDAAiD;AACjD,0DAKiC;AAEjC,MAAa,kBAAkB;CAG9B;AADC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;kDAC7C;AAFjB,gDAGC;AAOD,SAAgB,cAAc,CAAyB,IAAO;IAC5D,OAAO,IAAA,0BAAW,EAChB,kBAAkB,EAClB;QACE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;KAC1D,EACD,GAAG,IAAA,uCAAwB,EAAC,IAAI,CAAC,CAAC,IAAI,aAAa,CACpD,CAAC;AACJ,CAAC;AARD,wCAQC;AAED,MAAa,iBAAiB;CAG7B;AADC;IADC,IAAA,gCAAc,GAAE;;+CACP;AAFZ,8CAGC;AAED,SAAgB,aAAa,CAAqB,IAAO;IACvD,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAC1B,iBAAiB,EACjB;QACE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,EAAE;KACjE,EACD,GAAG,IAAA,uCAAwB,EAAC,IAAI,CAAC,CAAC,IAAI,YAAY,CACnD,CAAC;IACF,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACjD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAVD,sCAUC"}
|
package/package.json
CHANGED