nicot 1.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.
Files changed (65) hide show
  1. package/.eslintignore +4 -0
  2. package/.eslintrc.js +24 -0
  3. package/.prettierrc +4 -0
  4. package/LICENSE +22 -0
  5. package/README.md +3 -0
  6. package/dist/index.d.ts +5 -0
  7. package/dist/index.js +22 -0
  8. package/dist/index.js.map +1 -0
  9. package/dist/src/bases/id-base.d.ts +46 -0
  10. package/dist/src/bases/id-base.js +57 -0
  11. package/dist/src/bases/id-base.js.map +1 -0
  12. package/dist/src/bases/index.d.ts +2 -0
  13. package/dist/src/bases/index.js +19 -0
  14. package/dist/src/bases/index.js.map +1 -0
  15. package/dist/src/bases/time-base.d.ts +19 -0
  16. package/dist/src/bases/time-base.js +47 -0
  17. package/dist/src/bases/time-base.js.map +1 -0
  18. package/dist/src/crud-base.d.ts +103 -0
  19. package/dist/src/crud-base.js +262 -0
  20. package/dist/src/crud-base.js.map +1 -0
  21. package/dist/src/decorators/access.d.ts +2 -0
  22. package/dist/src/decorators/access.js +11 -0
  23. package/dist/src/decorators/access.js.map +1 -0
  24. package/dist/src/decorators/index.d.ts +5 -0
  25. package/dist/src/decorators/index.js +22 -0
  26. package/dist/src/decorators/index.js.map +1 -0
  27. package/dist/src/decorators/merge.d.ts +4 -0
  28. package/dist/src/decorators/merge.js +36 -0
  29. package/dist/src/decorators/merge.js.map +1 -0
  30. package/dist/src/decorators/pipes.d.ts +4 -0
  31. package/dist/src/decorators/pipes.js +23 -0
  32. package/dist/src/decorators/pipes.js.map +1 -0
  33. package/dist/src/decorators/property.d.ts +25 -0
  34. package/dist/src/decorators/property.js +110 -0
  35. package/dist/src/decorators/property.js.map +1 -0
  36. package/dist/src/decorators/restful.d.ts +28 -0
  37. package/dist/src/decorators/restful.js +86 -0
  38. package/dist/src/decorators/restful.js.map +1 -0
  39. package/dist/src/dto/import-entry.d.ts +11 -0
  40. package/dist/src/dto/import-entry.js +28 -0
  41. package/dist/src/dto/import-entry.js.map +1 -0
  42. package/dist/src/dto/index.d.ts +2 -0
  43. package/dist/src/dto/index.js +19 -0
  44. package/dist/src/dto/index.js.map +1 -0
  45. package/dist/src/dto/page-settings.d.ts +20 -0
  46. package/dist/src/dto/page-settings.js +61 -0
  47. package/dist/src/dto/page-settings.js.map +1 -0
  48. package/dist/src/dto/return-message.d.ts +42 -0
  49. package/dist/src/dto/return-message.js +110 -0
  50. package/dist/src/dto/return-message.js.map +1 -0
  51. package/dist/src/utility/bigint.d.ts +5 -0
  52. package/dist/src/utility/bigint.js +16 -0
  53. package/dist/src/utility/bigint.js.map +1 -0
  54. package/dist/src/utility/index.d.ts +1 -0
  55. package/dist/src/utility/index.js +18 -0
  56. package/dist/src/utility/index.js.map +1 -0
  57. package/dist/src/utility/insert-field.d.ts +17 -0
  58. package/dist/src/utility/insert-field.js +24 -0
  59. package/dist/src/utility/insert-field.js.map +1 -0
  60. package/dist/src/utility/query.d.ts +5 -0
  61. package/dist/src/utility/query.js +35 -0
  62. package/dist/src/utility/query.js.map +1 -0
  63. package/index.ts +5 -0
  64. package/package.json +66 -0
  65. package/tsconfig.json +20 -0
package/.eslintignore ADDED
@@ -0,0 +1,4 @@
1
+ webpack.config.js
2
+ dist/*
3
+ build/*
4
+ *.js
package/.eslintrc.js ADDED
@@ -0,0 +1,24 @@
1
+ module.exports = {
2
+ parser: '@typescript-eslint/parser',
3
+ parserOptions: {
4
+ project: 'tsconfig.json',
5
+ sourceType: 'module',
6
+ },
7
+ plugins: ['@typescript-eslint/eslint-plugin'],
8
+ extends: [
9
+ 'plugin:@typescript-eslint/recommended',
10
+ 'plugin:prettier/recommended',
11
+ ],
12
+ root: true,
13
+ env: {
14
+ node: true,
15
+ jest: true,
16
+ },
17
+ ignorePatterns: ['.eslintrc.js'],
18
+ rules: {
19
+ '@typescript-eslint/interface-name-prefix': 'off',
20
+ '@typescript-eslint/explicit-function-return-type': 'off',
21
+ '@typescript-eslint/explicit-module-boundary-types': 'off',
22
+ '@typescript-eslint/no-explicit-any': 'off',
23
+ },
24
+ };
package/.prettierrc ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "singleQuote": true,
3
+ "trailingComma": "all"
4
+ }
package/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 Nanahira
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
package/README.md ADDED
@@ -0,0 +1,3 @@
1
+ # nicot
2
+
3
+ Nest.js interacting with class-validator + OpenAPI + TypeORM for Nest.js Restful API development.
@@ -0,0 +1,5 @@
1
+ export * from './src/crud-base';
2
+ export * from './src/bases';
3
+ export * from './src/decorators';
4
+ export * from './src/dto';
5
+ export * from './src/utility';
package/dist/index.js ADDED
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/crud-base"), exports);
18
+ __exportStar(require("./src/bases"), exports);
19
+ __exportStar(require("./src/decorators"), exports);
20
+ __exportStar(require("./src/dto"), exports);
21
+ __exportStar(require("./src/utility"), exports);
22
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,8CAA4B;AAC5B,mDAAiC;AACjC,4CAA0B;AAC1B,gDAA8B"}
@@ -0,0 +1,46 @@
1
+ import { SelectQueryBuilder } from 'typeorm';
2
+ export interface IdOptions {
3
+ description?: string;
4
+ }
5
+ export declare function IdBase(idOptions?: IdOptions): {
6
+ new (): {
7
+ id: number;
8
+ applyQuery(qb: SelectQueryBuilder<any>, entityName: string): void;
9
+ createTime: Date;
10
+ updateTime: Date;
11
+ deleteTime: Date;
12
+ toObject(): any;
13
+ isValidInCreation(): string;
14
+ prepareForSaving(): Promise<void>;
15
+ afterSaving(): void;
16
+ pageCount: number;
17
+ recordsPerPage: number;
18
+ getActualPageSettings(): import("../dto").PageSettingsWise;
19
+ getPageCount(): number;
20
+ getRecordsPerPage(): number;
21
+ getStartingFrom(): number;
22
+ };
23
+ };
24
+ export interface StringIdOptions extends IdOptions {
25
+ length: number;
26
+ uuid?: boolean;
27
+ }
28
+ export declare function StringIdBase(idOptions: StringIdOptions): {
29
+ new (): {
30
+ id: string;
31
+ applyQuery(qb: SelectQueryBuilder<any>, entityName: string): void;
32
+ createTime: Date;
33
+ updateTime: Date;
34
+ deleteTime: Date;
35
+ toObject(): any;
36
+ isValidInCreation(): string;
37
+ prepareForSaving(): Promise<void>;
38
+ afterSaving(): void;
39
+ pageCount: number;
40
+ recordsPerPage: number;
41
+ getActualPageSettings(): import("../dto").PageSettingsWise;
42
+ getPageCount(): number;
43
+ getRecordsPerPage(): number;
44
+ getStartingFrom(): number;
45
+ };
46
+ };
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StringIdBase = exports.IdBase = void 0;
4
+ const time_base_1 = require("./time-base");
5
+ const typeorm_1 = require("typeorm");
6
+ const query_1 = require("../utility/query");
7
+ const decorators_1 = require("../decorators");
8
+ const class_validator_1 = require("class-validator");
9
+ function IdBase(idOptions = {}) {
10
+ const cl = class IdBase extends time_base_1.TimeBase {
11
+ applyQuery(qb, entityName) {
12
+ super.applyQuery(qb, entityName);
13
+ qb.orderBy(`${entityName}.id`, 'DESC');
14
+ (0, query_1.applyQueryProperty)(this, qb, entityName, 'id');
15
+ }
16
+ };
17
+ const dec = (0, decorators_1.MergePropertyDecorators)([
18
+ (0, decorators_1.NotWritable)(),
19
+ (0, decorators_1.IntColumn)('bigint', {
20
+ unsigned: true,
21
+ description: idOptions.description,
22
+ columnExtras: { nullable: false, primary: true },
23
+ }),
24
+ Reflect.metadata('design:type', Number),
25
+ (0, typeorm_1.Generated)('increment'),
26
+ ]);
27
+ dec(cl.prototype, 'id');
28
+ return cl;
29
+ }
30
+ exports.IdBase = IdBase;
31
+ function StringIdBase(idOptions) {
32
+ const cl = class StringIdBase extends time_base_1.TimeBase {
33
+ applyQuery(qb, entityName) {
34
+ super.applyQuery(qb, entityName);
35
+ qb.orderBy(`${entityName}.id`, 'ASC');
36
+ (0, query_1.applyQueryProperty)(this, qb, entityName, 'id');
37
+ }
38
+ };
39
+ const decs = [
40
+ (0, decorators_1.NotChangeable)(),
41
+ (0, decorators_1.StringColumn)(idOptions.length, {
42
+ required: !idOptions.uuid,
43
+ description: idOptions.description,
44
+ columnExtras: { primary: true, nullable: false },
45
+ }),
46
+ Reflect.metadata('design:type', String),
47
+ (0, class_validator_1.IsNotEmpty)(),
48
+ ];
49
+ if (idOptions.uuid) {
50
+ decs.push((0, typeorm_1.Generated)('uuid'));
51
+ }
52
+ const dec = (0, decorators_1.MergePropertyDecorators)(decs);
53
+ dec(cl.prototype, 'id');
54
+ return cl;
55
+ }
56
+ exports.StringIdBase = StringIdBase;
57
+ //# sourceMappingURL=id-base.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"id-base.js","sourceRoot":"","sources":["../../../src/bases/id-base.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AACvC,qCAAwD;AACxD,4CAAsD;AACtD,8CAMuB;AACvB,qDAA6C;AAM7C,SAAgB,MAAM,CAAC,YAAuB,EAAE;IAC9C,MAAM,EAAE,GAAG,MAAM,MAAO,SAAQ,oBAAQ;QAE7B,UAAU,CAAC,EAA8B,EAAE,UAAkB;YACpE,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YACjC,EAAE,CAAC,OAAO,CAAC,GAAG,UAAU,KAAK,EAAE,MAAM,CAAC,CAAC;YACvC,IAAA,0BAAkB,EAAC,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;KACF,CAAC;IACF,MAAM,GAAG,GAAG,IAAA,oCAAuB,EAAC;QAClC,IAAA,wBAAW,GAAE;QACb,IAAA,sBAAS,EAAC,QAAQ,EAAE;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,YAAY,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE;SACjD,CAAC;QACF,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QACvC,IAAA,mBAAS,EAAC,WAAW,CAAC;KACvB,CAAC,CAAC;IACH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACxB,OAAO,EAAE,CAAC;AACZ,CAAC;AArBD,wBAqBC;AAOD,SAAgB,YAAY,CAAC,SAA0B;IACrD,MAAM,EAAE,GAAG,MAAM,YAAa,SAAQ,oBAAQ;QAGnC,UAAU,CACjB,EAAoC,EACpC,UAAkB;YAElB,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YACjC,EAAE,CAAC,OAAO,CAAC,GAAG,UAAU,KAAK,EAAE,KAAK,CAAC,CAAC;YACtC,IAAA,0BAAkB,EAAC,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;KACF,CAAC;IACF,MAAM,IAAI,GAAG;QACX,IAAA,0BAAa,GAAE;QACf,IAAA,yBAAY,EAAC,SAAS,CAAC,MAAM,EAAE;YAC7B,QAAQ,EAAE,CAAC,SAAS,CAAC,IAAI;YACzB,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;SACjD,CAAC;QACF,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QACvC,IAAA,4BAAU,GAAE;KACb,CAAC;IACF,IAAI,SAAS,CAAC,IAAI,EAAE;QAClB,IAAI,CAAC,IAAI,CAAC,IAAA,mBAAS,EAAC,MAAM,CAAC,CAAC,CAAC;KAC9B;IACD,MAAM,GAAG,GAAG,IAAA,oCAAuB,EAAC,IAAI,CAAC,CAAC;IAC1C,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACxB,OAAO,EAAE,CAAC;AACZ,CAAC;AA7BD,oCA6BC"}
@@ -0,0 +1,2 @@
1
+ export * from './time-base';
2
+ export * from './id-base';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./time-base"), exports);
18
+ __exportStar(require("./id-base"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/bases/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,4CAA0B"}
@@ -0,0 +1,19 @@
1
+ import { PageSettingsDto } from '../dto/page-settings';
2
+ export interface DeletionWise {
3
+ deleteTime?: Date;
4
+ }
5
+ export interface ImportWise {
6
+ isValidInCreation(): string | undefined;
7
+ prepareForSaving(): Promise<void>;
8
+ afterSaving(): void;
9
+ }
10
+ export declare class TimeBase extends PageSettingsDto implements DeletionWise, ImportWise {
11
+ createTime: Date;
12
+ updateTime: Date;
13
+ deleteTime: Date;
14
+ toObject(): any;
15
+ isValidInCreation(): string | undefined;
16
+ prepareForSaving(): Promise<void>;
17
+ afterSaving(): void;
18
+ }
19
+ export declare const TimeBaseFields: (keyof TimeBase)[];
@@ -0,0 +1,47 @@
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.TimeBaseFields = exports.TimeBase = void 0;
13
+ const typeorm_1 = require("typeorm");
14
+ const page_settings_1 = require("../dto/page-settings");
15
+ const decorators_1 = require("../decorators");
16
+ class TimeBase extends page_settings_1.PageSettingsDto {
17
+ toObject() {
18
+ return JSON.parse(JSON.stringify(this));
19
+ }
20
+ isValidInCreation() {
21
+ return;
22
+ }
23
+ async prepareForSaving() { }
24
+ afterSaving() { }
25
+ }
26
+ __decorate([
27
+ (0, typeorm_1.CreateDateColumn)({ select: false }),
28
+ (0, decorators_1.NotColumn)(),
29
+ __metadata("design:type", Date)
30
+ ], TimeBase.prototype, "createTime", void 0);
31
+ __decorate([
32
+ (0, typeorm_1.UpdateDateColumn)({ select: false }),
33
+ (0, decorators_1.NotColumn)(),
34
+ __metadata("design:type", Date)
35
+ ], TimeBase.prototype, "updateTime", void 0);
36
+ __decorate([
37
+ (0, typeorm_1.DeleteDateColumn)({ select: false }),
38
+ (0, decorators_1.NotColumn)(),
39
+ __metadata("design:type", Date)
40
+ ], TimeBase.prototype, "deleteTime", void 0);
41
+ exports.TimeBase = TimeBase;
42
+ exports.TimeBaseFields = [
43
+ 'createTime',
44
+ 'updateTime',
45
+ 'deleteTime',
46
+ ];
47
+ //# sourceMappingURL=time-base.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"time-base.js","sourceRoot":"","sources":["../../../src/bases/time-base.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA+E;AAC/E,wDAAuD;AACvD,8CAA0C;AAY1C,MAAa,QACX,SAAQ,+BAAe;IAevB,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,iBAAiB;QACf,OAAO;IACT,CAAC;IAED,KAAK,CAAC,gBAAgB,KAAmB,CAAC;IAE1C,WAAW,KAAI,CAAC;CACjB;AArBC;IAFC,IAAA,0BAAgB,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACnC,IAAA,sBAAS,GAAE;8BACA,IAAI;4CAAC;AAIjB;IAFC,IAAA,0BAAgB,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACnC,IAAA,sBAAS,GAAE;8BACA,IAAI;4CAAC;AAIjB;IAFC,IAAA,0BAAgB,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACnC,IAAA,sBAAS,GAAE;8BACA,IAAI;4CAAC;AAdnB,4BA2BC;AAEY,QAAA,cAAc,GAAuB;IAChD,YAAY;IACZ,YAAY;IACZ,YAAY;CACb,CAAC"}
@@ -0,0 +1,103 @@
1
+ import { BlankReturnMessageDto, PageSettingsFactory, QueryWise } from './dto';
2
+ import { DeepPartial, FindOptionsWhere, Repository, SelectQueryBuilder } from 'typeorm';
3
+ import { DeletionWise, ImportWise } from './bases';
4
+ import { ImportEntry } from './dto/import-entry';
5
+ import { ConsoleLogger } from '@nestjs/common';
6
+ import { ClassType } from './utility/insert-field';
7
+ export declare type EntityId<T extends {
8
+ id: any;
9
+ }> = T['id'];
10
+ export interface RelationDef {
11
+ name: string;
12
+ inner?: boolean;
13
+ }
14
+ export declare const Inner: (name: string) => RelationDef;
15
+ export declare type ValidCrudEntity<T> = Record<string, any> & {
16
+ id: any;
17
+ } & QueryWise<T> & DeletionWise & ImportWise & PageSettingsFactory;
18
+ export interface CrudOptions<T extends ValidCrudEntity<T>> {
19
+ relations: (string | RelationDef)[];
20
+ extraGetQuery: (qb: SelectQueryBuilder<T>) => void;
21
+ hardDelete?: boolean;
22
+ }
23
+ export declare class CrudBase<T extends ValidCrudEntity<T>> {
24
+ entityClass: ClassType<T>;
25
+ repo: Repository<T>;
26
+ crudOptions: CrudOptions<T>;
27
+ readonly entityName: string;
28
+ readonly entityReturnMessageDto: new (statusCode: number, message?: string, data?: unknown) => import("./dto").GenericReturnMessageDto<unknown> & {
29
+ data: T;
30
+ };
31
+ readonly entityPaginatedReturnMessageDto: new (statusCode: number, message: string, data: unknown[], total: number, pageSettings: import("./dto").PageSettingsWise) => import("./dto").GenericPaginatedReturnMessageDto<unknown> & {
32
+ data: T[];
33
+ };
34
+ readonly entityRelations: (string | RelationDef)[];
35
+ readonly extraGetQuery: (qb: SelectQueryBuilder<T>) => void;
36
+ readonly log: ConsoleLogger;
37
+ constructor(entityClass: ClassType<T>, repo: Repository<T>, crudOptions: CrudOptions<T>);
38
+ batchCreate(ents: T[], beforeCreate?: (repo: Repository<T>) => Promise<void>, skipErrors?: boolean): Promise<{
39
+ results: (DeepPartial<T> & T)[];
40
+ skipped: {
41
+ result: string;
42
+ entry: T;
43
+ }[];
44
+ }>;
45
+ create(ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<import("./dto").GenericReturnMessageDto<unknown> & {
46
+ data: T;
47
+ }>;
48
+ get entityAliasName(): string;
49
+ applyRelationToQuery(qb: SelectQueryBuilder<T>, relation: RelationDef): void;
50
+ applyRelationsToQuery(qb: SelectQueryBuilder<T>): void;
51
+ queryBuilder(): SelectQueryBuilder<T>;
52
+ findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericReturnMessageDto<unknown> & {
53
+ data: T;
54
+ }>;
55
+ findAll(ent?: Partial<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericPaginatedReturnMessageDto<unknown> & {
56
+ data: T[];
57
+ }>;
58
+ update(id: EntityId<T>, entPart: Partial<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
59
+ remove(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
60
+ importEntities(ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<ImportEntry<T>[]>;
61
+ exists(id: EntityId<T>): Promise<boolean>;
62
+ }
63
+ export declare function CrudService<T extends ValidCrudEntity<T>>(entityClass: ClassType<T>, crudOptions: CrudOptions<T>): {
64
+ new (repo: Repository<T>): {
65
+ readonly entityName: string;
66
+ readonly entityReturnMessageDto: new (statusCode: number, message?: string, data?: unknown) => import("./dto").GenericReturnMessageDto<unknown> & {
67
+ data: T;
68
+ };
69
+ readonly entityPaginatedReturnMessageDto: new (statusCode: number, message: string, data: unknown[], total: number, pageSettings: import("./dto").PageSettingsWise) => import("./dto").GenericPaginatedReturnMessageDto<unknown> & {
70
+ data: T[];
71
+ };
72
+ readonly entityRelations: (string | RelationDef)[];
73
+ readonly extraGetQuery: (qb: SelectQueryBuilder<T>) => void;
74
+ readonly log: ConsoleLogger;
75
+ entityClass: ClassType<T>;
76
+ repo: Repository<T>;
77
+ crudOptions: CrudOptions<T>;
78
+ batchCreate(ents: T[], beforeCreate?: (repo: Repository<T>) => Promise<void>, skipErrors?: boolean): Promise<{
79
+ results: (DeepPartial<T> & T)[];
80
+ skipped: {
81
+ result: string;
82
+ entry: T;
83
+ }[];
84
+ }>;
85
+ create(ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<import("./dto").GenericReturnMessageDto<unknown> & {
86
+ data: T;
87
+ }>;
88
+ readonly entityAliasName: string;
89
+ applyRelationToQuery(qb: SelectQueryBuilder<T>, relation: RelationDef): void;
90
+ applyRelationsToQuery(qb: SelectQueryBuilder<T>): void;
91
+ queryBuilder(): SelectQueryBuilder<T>;
92
+ findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericReturnMessageDto<unknown> & {
93
+ data: T;
94
+ }>;
95
+ findAll(ent?: Partial<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericPaginatedReturnMessageDto<unknown> & {
96
+ data: T[];
97
+ }>;
98
+ update(id: EntityId<T>, entPart: Partial<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
99
+ remove(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
100
+ importEntities(ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<ImportEntry<T>[]>;
101
+ exists(id: EntityId<T>): Promise<boolean>;
102
+ };
103
+ };