@avytrix/nestjs-drizzle-crud 0.0.0-stage → 3.6.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 (82) hide show
  1. package/AGENT.md +513 -0
  2. package/AGENTS.template.md +31 -0
  3. package/CHANGELOG.md +565 -0
  4. package/CLAUDE.template.md +18 -0
  5. package/LICENSE +21 -0
  6. package/README.md +1307 -2
  7. package/dist/controller/crud-controller.factory.d.ts +28 -0
  8. package/dist/controller/crud-controller.factory.js +279 -0
  9. package/dist/controller/crud-controller.factory.js.map +1 -0
  10. package/dist/core/abstract/sql-base-crud.service.d.ts +230 -0
  11. package/dist/core/abstract/sql-base-crud.service.js +2899 -0
  12. package/dist/core/abstract/sql-base-crud.service.js.map +1 -0
  13. package/dist/core/context/crud-context.d.ts +6 -0
  14. package/dist/core/context/crud-context.js +27 -0
  15. package/dist/core/context/crud-context.js.map +1 -0
  16. package/dist/core/events/crud-event-bus.d.ts +7 -0
  17. package/dist/core/events/crud-event-bus.js +30 -0
  18. package/dist/core/events/crud-event-bus.js.map +1 -0
  19. package/dist/core/interfaces/crud-service.interface.d.ts +54 -0
  20. package/dist/core/interfaces/crud-service.interface.js +3 -0
  21. package/dist/core/interfaces/crud-service.interface.js.map +1 -0
  22. package/dist/core/interfaces/drizzle-crud-config.interface.d.ts +39 -0
  23. package/dist/core/interfaces/drizzle-crud-config.interface.js +3 -0
  24. package/dist/core/interfaces/drizzle-crud-config.interface.js.map +1 -0
  25. package/dist/core/interfaces/events.interface.d.ts +39 -0
  26. package/dist/core/interfaces/events.interface.js +3 -0
  27. package/dist/core/interfaces/events.interface.js.map +1 -0
  28. package/dist/core/interfaces/query.interface.d.ts +112 -0
  29. package/dist/core/interfaces/query.interface.js +3 -0
  30. package/dist/core/interfaces/query.interface.js.map +1 -0
  31. package/dist/core/interfaces/scope.interface.d.ts +3 -0
  32. package/dist/core/interfaces/scope.interface.js +3 -0
  33. package/dist/core/interfaces/scope.interface.js.map +1 -0
  34. package/dist/core/interfaces/sql-crud-config.interface.d.ts +87 -0
  35. package/dist/core/interfaces/sql-crud-config.interface.js +3 -0
  36. package/dist/core/interfaces/sql-crud-config.interface.js.map +1 -0
  37. package/dist/core/types/sql.types.d.ts +7 -0
  38. package/dist/core/types/sql.types.js +3 -0
  39. package/dist/core/types/sql.types.js.map +1 -0
  40. package/dist/core/utils/cursor.d.ts +2 -0
  41. package/dist/core/utils/cursor.js +44 -0
  42. package/dist/core/utils/cursor.js.map +1 -0
  43. package/dist/core/utils/merge-config.d.ts +2 -0
  44. package/dist/core/utils/merge-config.js +22 -0
  45. package/dist/core/utils/merge-config.js.map +1 -0
  46. package/dist/core/utils/query-parser.d.ts +4 -0
  47. package/dist/core/utils/query-parser.js +538 -0
  48. package/dist/core/utils/query-parser.js.map +1 -0
  49. package/dist/decorators/crud-service.decorator.d.ts +4 -0
  50. package/dist/decorators/crud-service.decorator.js +10 -0
  51. package/dist/decorators/crud-service.decorator.js.map +1 -0
  52. package/dist/decorators/index.d.ts +1 -0
  53. package/dist/decorators/index.js +6 -0
  54. package/dist/decorators/index.js.map +1 -0
  55. package/dist/exceptions/crud.exceptions.d.ts +46 -0
  56. package/dist/exceptions/crud.exceptions.js +93 -0
  57. package/dist/exceptions/crud.exceptions.js.map +1 -0
  58. package/dist/index.d.ts +23 -0
  59. package/dist/index.js +61 -0
  60. package/dist/index.js.map +1 -0
  61. package/dist/mcp/server.d.ts +8 -0
  62. package/dist/mcp/server.js +236 -0
  63. package/dist/mcp/server.js.map +1 -0
  64. package/dist/modules/drizzle-connection.d.ts +12 -0
  65. package/dist/modules/drizzle-connection.js +73 -0
  66. package/dist/modules/drizzle-connection.js.map +1 -0
  67. package/dist/modules/drizzle-crud.module.d.ts +11 -0
  68. package/dist/modules/drizzle-crud.module.js +165 -0
  69. package/dist/modules/drizzle-crud.module.js.map +1 -0
  70. package/dist/openapi/api-crud.decorators.d.ts +10 -0
  71. package/dist/openapi/api-crud.decorators.js +216 -0
  72. package/dist/openapi/api-crud.decorators.js.map +1 -0
  73. package/dist/test-utils/base-crud.spec-helper.d.ts +64 -0
  74. package/dist/test-utils/base-crud.spec-helper.js +119 -0
  75. package/dist/test-utils/base-crud.spec-helper.js.map +1 -0
  76. package/dist/test-utils/index.d.ts +2 -0
  77. package/dist/test-utils/index.js +8 -0
  78. package/dist/test-utils/index.js.map +1 -0
  79. package/dist/test-utils/test-factory.d.ts +29 -0
  80. package/dist/test-utils/test-factory.js +81 -0
  81. package/dist/test-utils/test-factory.js.map +1 -0
  82. package/package.json +110 -5
@@ -0,0 +1,165 @@
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 DrizzleCrudModule_1;
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.DrizzleCrudModule = void 0;
11
+ const common_1 = require("@nestjs/common");
12
+ const crud_event_bus_1 = require("../core/events/crud-event-bus");
13
+ const merge_config_1 = require("../core/utils/merge-config");
14
+ const drizzle_connection_1 = require("./drizzle-connection");
15
+ const DRIZZLE_RAW_CONFIG = "DRIZZLE_RAW_CONFIG";
16
+ function normalizeConfig(config) {
17
+ return {
18
+ dialect: config.dialect,
19
+ defaults: {
20
+ softDelete: true,
21
+ timestamps: true,
22
+ ...config.defaults,
23
+ pagination: {
24
+ defaultLimit: 20,
25
+ maxLimit: 100,
26
+ ...config.defaults?.pagination,
27
+ },
28
+ },
29
+ sql: {
30
+ caseSensitive: false,
31
+ useReturning: config.dialect === "postgresql",
32
+ jsonSupport: true,
33
+ enableFullTextSearch: false,
34
+ ...config.sql,
35
+ },
36
+ hooks: {
37
+ enableGlobalHooks: config.hooks?.enableGlobalHooks === true,
38
+ },
39
+ };
40
+ }
41
+ function buildEntityConfig(service, table, entityConfig, db, globalConfig, events) {
42
+ const decoratorConfig = Reflect.getMetadata?.("crud:config", service) || {};
43
+ const perEntity = (0, merge_config_1.mergeCrudConfig)(decoratorConfig, entityConfig);
44
+ const gd = globalConfig?.defaults || {};
45
+ const projectConfig = {
46
+ dialect: globalConfig?.dialect,
47
+ db,
48
+ primaryKey: "id",
49
+ primaryKeyType: "serial",
50
+ softDelete: gd.softDelete === false
51
+ ? { enabled: false, column: "deleted_at" }
52
+ : { enabled: true, column: "deleted_at" },
53
+ timestamps: gd.timestamps === false
54
+ ? undefined
55
+ : { createdAt: "created_at", updatedAt: "updated_at" },
56
+ };
57
+ if (gd.pagination)
58
+ projectConfig.pagination = gd.pagination;
59
+ if (globalConfig?.hooks?.enableGlobalHooks && events) {
60
+ projectConfig.events = events;
61
+ }
62
+ if (globalConfig?.sql)
63
+ projectConfig.sql = globalConfig.sql;
64
+ const finalConfig = (0, merge_config_1.mergeCrudConfig)(projectConfig, perEntity);
65
+ finalConfig.table = table ?? perEntity.table;
66
+ if (!finalConfig.defaultSort &&
67
+ gd.sortOrder &&
68
+ finalConfig.timestamps?.createdAt) {
69
+ finalConfig.defaultSort = [
70
+ { column: finalConfig.timestamps.createdAt, order: gd.sortOrder },
71
+ ];
72
+ }
73
+ return finalConfig;
74
+ }
75
+ function connectionProviders(rawConfigProvider) {
76
+ return [
77
+ rawConfigProvider,
78
+ {
79
+ provide: drizzle_connection_1.DRIZZLE_CRUD_CONFIG,
80
+ inject: [DRIZZLE_RAW_CONFIG],
81
+ useFactory: (raw) => normalizeConfig(raw),
82
+ },
83
+ {
84
+ provide: drizzle_connection_1.DRIZZLE_CONNECTION,
85
+ inject: [DRIZZLE_RAW_CONFIG],
86
+ useFactory: async (raw) => {
87
+ const connection = new drizzle_connection_1.DrizzleConnection();
88
+ await connection.init(raw);
89
+ return connection;
90
+ },
91
+ },
92
+ {
93
+ provide: drizzle_connection_1.DRIZZLE_DB,
94
+ inject: [drizzle_connection_1.DRIZZLE_CONNECTION],
95
+ useFactory: (connection) => connection.db,
96
+ },
97
+ {
98
+ provide: crud_event_bus_1.CrudEventBus,
99
+ inject: [DRIZZLE_RAW_CONFIG],
100
+ useFactory: (raw) => {
101
+ const bus = new crud_event_bus_1.CrudEventBus();
102
+ for (const subscriber of raw.hooks?.subscribers ?? []) {
103
+ bus.subscribe(subscriber);
104
+ }
105
+ if (bus.size > 0 && !raw.hooks?.enableGlobalHooks) {
106
+ console.warn("[nestjs-drizzle-crud] hooks.subscribers is set but hooks.enableGlobalHooks is not, so no events will fire.");
107
+ }
108
+ return bus;
109
+ },
110
+ },
111
+ ];
112
+ }
113
+ const EXPORTED_TOKENS = [
114
+ drizzle_connection_1.DRIZZLE_CRUD_CONFIG,
115
+ drizzle_connection_1.DRIZZLE_DB,
116
+ drizzle_connection_1.DRIZZLE_CONNECTION,
117
+ crud_event_bus_1.CrudEventBus,
118
+ ];
119
+ let DrizzleCrudModule = DrizzleCrudModule_1 = class DrizzleCrudModule {
120
+ static forRoot(config) {
121
+ return {
122
+ module: DrizzleCrudModule_1,
123
+ providers: connectionProviders({
124
+ provide: DRIZZLE_RAW_CONFIG,
125
+ useValue: config,
126
+ }),
127
+ exports: EXPORTED_TOKENS,
128
+ global: true,
129
+ };
130
+ }
131
+ static forRootAsync(options) {
132
+ return {
133
+ module: DrizzleCrudModule_1,
134
+ imports: options.imports || [],
135
+ providers: connectionProviders({
136
+ provide: DRIZZLE_RAW_CONFIG,
137
+ useFactory: options.useFactory,
138
+ inject: options.inject || [],
139
+ }),
140
+ exports: EXPORTED_TOKENS,
141
+ global: true,
142
+ };
143
+ }
144
+ static forFeature(entities) {
145
+ const providers = entities.map((entity) => ({
146
+ provide: entity.service,
147
+ inject: [
148
+ drizzle_connection_1.DRIZZLE_DB,
149
+ drizzle_connection_1.DRIZZLE_CRUD_CONFIG,
150
+ { token: crud_event_bus_1.CrudEventBus, optional: true },
151
+ ],
152
+ useFactory: (db, globalConfig, events) => new entity.service(buildEntityConfig(entity.service, entity.table, entity.config, db, globalConfig, events)),
153
+ }));
154
+ return {
155
+ module: DrizzleCrudModule_1,
156
+ providers,
157
+ exports: providers,
158
+ };
159
+ }
160
+ };
161
+ exports.DrizzleCrudModule = DrizzleCrudModule;
162
+ exports.DrizzleCrudModule = DrizzleCrudModule = DrizzleCrudModule_1 = __decorate([
163
+ (0, common_1.Module)({})
164
+ ], DrizzleCrudModule);
165
+ //# sourceMappingURL=drizzle-crud.module.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"drizzle-crud.module.js","sourceRoot":"","sources":["../../src/modules/drizzle-crud.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA2E;AAM3E,kEAA6D;AAC7D,6DAA6D;AAC7D,6DAK8B;AAE9B,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAGhD,SAAS,eAAe,CAAC,MAAyB;IACjD,OAAO;QACN,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE;YACT,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,IAAI;YAChB,GAAG,MAAM,CAAC,QAAQ;YAElB,UAAU,EAAE;gBACX,YAAY,EAAE,EAAE;gBAChB,QAAQ,EAAE,GAAG;gBACb,GAAG,MAAM,CAAC,QAAQ,EAAE,UAAU;aAC9B;SACD;QACD,GAAG,EAAE;YACJ,aAAa,EAAE,KAAK;YACpB,YAAY,EAAE,MAAM,CAAC,OAAO,KAAK,YAAY;YAC7C,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,GAAG,MAAM,CAAC,GAAG;SACb;QACD,KAAK,EAAE;YACN,iBAAiB,EAAE,MAAM,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI;SAC3D;KACD,CAAC;AACH,CAAC;AAID,SAAS,iBAAiB,CACzB,OAAY,EACZ,KAAU,EACV,YAAmC,EACnC,EAAO,EACP,YAAiB,EACjB,MAAqB;IAErB,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAG5E,MAAM,SAAS,GAAwB,IAAA,8BAAe,EACrD,eAAe,EACf,YAAY,CACZ,CAAC;IACF,MAAM,EAAE,GAAG,YAAY,EAAE,QAAQ,IAAI,EAAE,CAAC;IAExC,MAAM,aAAa,GAAQ;QAC1B,OAAO,EAAE,YAAY,EAAE,OAAO;QAC9B,EAAE;QACF,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,QAAQ;QACxB,UAAU,EACT,EAAE,CAAC,UAAU,KAAK,KAAK;YACtB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE;YAC1C,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE;QAG3C,UAAU,EACT,EAAE,CAAC,UAAU,KAAK,KAAK;YACtB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE;KACxD,CAAC;IACF,IAAI,EAAE,CAAC,UAAU;QAAE,aAAa,CAAC,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC;IAE5D,IAAI,YAAY,EAAE,KAAK,EAAE,iBAAiB,IAAI,MAAM,EAAE,CAAC;QACtD,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;IAC/B,CAAC;IACD,IAAI,YAAY,EAAE,GAAG;QAAE,aAAa,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC;IAG5D,MAAM,WAAW,GAAQ,IAAA,8BAAe,EAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACnE,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,SAAS,CAAC,KAAK,CAAC;IAI7C,IACC,CAAC,WAAW,CAAC,WAAW;QACxB,EAAE,CAAC,SAAS;QACZ,WAAW,CAAC,UAAU,EAAE,SAAS,EAChC,CAAC;QACF,WAAW,CAAC,WAAW,GAAG;YACzB,EAAE,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,EAAE;SACjE,CAAC;IACH,CAAC;IAED,OAAO,WAA4B,CAAC;AACrC,CAAC;AAID,SAAS,mBAAmB,CAAC,iBAA2B;IACvD,OAAO;QACN,iBAAiB;QACjB;YACC,OAAO,EAAE,wCAAmB;YAC5B,MAAM,EAAE,CAAC,kBAAkB,CAAC;YAC5B,UAAU,EAAE,CAAC,GAAsB,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC;SAC5D;QACD;YACC,OAAO,EAAE,uCAAkB;YAC3B,MAAM,EAAE,CAAC,kBAAkB,CAAC;YAC5B,UAAU,EAAE,KAAK,EAChB,GAAsB,EACO,EAAE;gBAC/B,MAAM,UAAU,GAAG,IAAI,sCAAiB,EAAE,CAAC;gBAC3C,MAAM,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,UAAU,CAAC;YACnB,CAAC;SACD;QACD;YACC,OAAO,EAAE,+BAAU;YACnB,MAAM,EAAE,CAAC,uCAAkB,CAAC;YAC5B,UAAU,EAAE,CAAC,UAA6B,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE;SAC5D;QACD;YACC,OAAO,EAAE,6BAAY;YACrB,MAAM,EAAE,CAAC,kBAAkB,CAAC;YAC5B,UAAU,EAAE,CAAC,GAAsB,EAAE,EAAE;gBACtC,MAAM,GAAG,GAAG,IAAI,6BAAY,EAAE,CAAC;gBAC/B,KAAK,MAAM,UAAU,IAAI,GAAG,CAAC,KAAK,EAAE,WAAW,IAAI,EAAE,EAAE,CAAC;oBACvD,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC3B,CAAC;gBACD,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,iBAAiB,EAAE,CAAC;oBACnD,OAAO,CAAC,IAAI,CACX,4GAA4G,CAC5G,CAAC;gBACH,CAAC;gBACD,OAAO,GAAG,CAAC;YACZ,CAAC;SACD;KACD,CAAC;AACH,CAAC;AAED,MAAM,eAAe,GAAG;IACvB,wCAAmB;IACnB,+BAAU;IACV,uCAAkB;IAClB,6BAAY;CACZ,CAAC;AAGK,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IACtB,AAAP,MAAM,CAAC,OAAO,CAAC,MAAyB;QACvC,OAAO;YACN,MAAM,qBAAmB;YACzB,SAAS,EAAE,mBAAmB,CAAC;gBAC9B,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,MAAM;aAChB,CAAC;YACF,OAAO,EAAE,eAAe;YACxB,MAAM,EAAE,IAAI;SACZ,CAAC;IACH,CAAC;IAEM,AAAP,MAAM,CAAC,YAAY,CAAC,OAMnB;QACA,OAAO;YACN,MAAM,qBAAmB;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE,mBAAmB,CAAC;gBAC9B,OAAO,EAAE,kBAAkB;gBAC3B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC5B,CAAC;YACF,OAAO,EAAE,eAAe;YACxB,MAAM,EAAE,IAAI;SACZ,CAAC;IACH,CAAC;IAEM,AAAP,MAAM,CAAC,UAAU,CAAC,QAAuB;QACxC,MAAM,SAAS,GAAe,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACvD,OAAO,EAAE,MAAM,CAAC,OAAO;YAGvB,MAAM,EAAE;gBACP,+BAAU;gBACV,wCAAmB;gBACnB,EAAE,KAAK,EAAE,6BAAY,EAAE,QAAQ,EAAE,IAAI,EAAE;aACvC;YACD,UAAU,EAAE,CAAC,EAAO,EAAE,YAAiB,EAAE,MAAqB,EAAE,EAAE,CACjE,IAAI,MAAM,CAAC,OAAO,CACjB,iBAAiB,CAChB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,MAAM,EACb,EAAE,EACF,YAAY,EACZ,MAAM,CACN,CACD;SACF,CAAC,CAAC,CAAC;QAEJ,OAAO;YACN,MAAM,qBAAmB;YACzB,SAAS;YACT,OAAO,EAAE,SAAS;SAClB,CAAC;IACH,CAAC;CACD,CAAA;;4BA9DY,iBAAiB;IAD7B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,iBAAiB,CA8D7B"}
@@ -0,0 +1,10 @@
1
+ import type { ParseCrudQueryOptions } from "../core/interfaces/query.interface";
2
+ export type ApiCrudSource = (ParseCrudQueryOptions & {
3
+ table: any;
4
+ }) | (abstract new (...args: any[]) => unknown);
5
+ export interface ApiCrudQueryOptions {
6
+ cursor?: boolean;
7
+ trash?: boolean;
8
+ }
9
+ export declare function ApiCrudQuery(source: ApiCrudSource, options?: ApiCrudQueryOptions): MethodDecorator;
10
+ export declare function ApiCrudList(source: ApiCrudSource, options?: ApiCrudQueryOptions): MethodDecorator;
@@ -0,0 +1,216 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ApiCrudQuery = ApiCrudQuery;
4
+ exports.ApiCrudList = ApiCrudList;
5
+ const drizzle_orm_1 = require("drizzle-orm");
6
+ let swagger;
7
+ function loadSwagger() {
8
+ if (swagger)
9
+ return swagger;
10
+ try {
11
+ swagger = require("@nestjs/swagger");
12
+ }
13
+ catch {
14
+ throw new Error("[nestjs-drizzle-crud] ApiCrudQuery and ApiCrudList need @nestjs/swagger. Install it, or remove the decorators.");
15
+ }
16
+ return swagger;
17
+ }
18
+ function resolveSource(source) {
19
+ if (typeof source === "function") {
20
+ const config = Reflect.getMetadata?.("crud:config", source);
21
+ if (!config?.table) {
22
+ throw new Error(`[nestjs-drizzle-crud] ${source.name} has no @CrudService({ table }) metadata; pass { table, ...allowlists } to the decorator instead.`);
23
+ }
24
+ return config;
25
+ }
26
+ if (!source?.table) {
27
+ throw new Error("[nestjs-drizzle-crud] ApiCrudQuery needs the entity's table");
28
+ }
29
+ return source;
30
+ }
31
+ function schemaOf(column) {
32
+ switch (column?.dataType) {
33
+ case "number":
34
+ return /Serial|Integer|SmallInt|Int$/.test(column.columnType ?? "")
35
+ ? { type: "integer" }
36
+ : { type: "number" };
37
+ case "bigint":
38
+ return { type: "string", format: "int64" };
39
+ case "boolean":
40
+ return { type: "boolean" };
41
+ case "date":
42
+ return { type: "string", format: "date-time" };
43
+ case "array":
44
+ return { type: "array", items: schemaOf(column.baseColumn) };
45
+ case "json":
46
+ return { type: "object" };
47
+ }
48
+ if (/UUID/i.test(column?.columnType ?? "")) {
49
+ return { type: "string", format: "uuid" };
50
+ }
51
+ if (Array.isArray(column?.enumValues) && column.enumValues.length > 0) {
52
+ return { type: "string", enum: column.enumValues };
53
+ }
54
+ return { type: "string" };
55
+ }
56
+ function columnsOf(table) {
57
+ try {
58
+ return (0, drizzle_orm_1.getTableColumns)(table) ?? {};
59
+ }
60
+ catch {
61
+ return {};
62
+ }
63
+ }
64
+ function columnAt(table, relations, path) {
65
+ const parts = path.split(".");
66
+ let current = table;
67
+ let level = relations;
68
+ for (const name of parts.slice(0, -1)) {
69
+ const relation = Object.hasOwn(level, name) ? level[name] : undefined;
70
+ if (!relation)
71
+ return undefined;
72
+ current = relation.table;
73
+ level = relation.relations ?? {};
74
+ }
75
+ return columnsOf(current)[parts[parts.length - 1]];
76
+ }
77
+ const OPERATORS = "eq, neq, gt, gte, lt, lte, in, notIn, between, isNull, isNotNull, like, ilike, startsWith, endsWith, contains, iStartsWith, iEndsWith, iContains";
78
+ function queryName(path) {
79
+ const [head, ...rest] = path.split(".");
80
+ return head + rest.map((part) => `[${part}]`).join("");
81
+ }
82
+ function queryParams(source, options) {
83
+ const columns = columnsOf(source.table);
84
+ const relations = source.relations ?? {};
85
+ const list = (names, fallback) => (names ?? fallback).join(", ");
86
+ const own = Object.keys(columns);
87
+ const params = [
88
+ {
89
+ name: "page",
90
+ schema: { type: "integer", minimum: 1 },
91
+ description: "Page number, from 1.",
92
+ },
93
+ {
94
+ name: "limit",
95
+ schema: { type: "integer", minimum: 1 },
96
+ description: "Rows per page, capped by the entity's maxLimit.",
97
+ },
98
+ {
99
+ name: "sortBy",
100
+ schema: { type: "string" },
101
+ description: `Comma-separated columns; a leading "-" sorts descending. Sortable: ${list(source.sortableColumns, own)}.`,
102
+ },
103
+ {
104
+ name: "sortOrder",
105
+ schema: { type: "string", enum: ["asc", "desc"] },
106
+ description: "Direction for a single sortBy column without a prefix.",
107
+ },
108
+ {
109
+ name: "withCount",
110
+ schema: { type: "boolean" },
111
+ description: "false skips the COUNT(*): total is null and hasMore says whether another page follows.",
112
+ },
113
+ {
114
+ name: "fields",
115
+ schema: { type: "string" },
116
+ description: `Comma-separated columns to return ("relation.column" for a relation). Selectable: ${list(source.selectableColumns, own)}.`,
117
+ },
118
+ ];
119
+ const relationNames = Object.keys(relations);
120
+ if (relationNames.length > 0) {
121
+ params.push({
122
+ name: "with",
123
+ schema: { type: "string" },
124
+ description: `Comma-separated relations to load (dotted for nested). Loadable: ${list(source.loadableRelations, relationNames)}.`,
125
+ }, {
126
+ name: "counts",
127
+ schema: { type: "string" },
128
+ description: "Comma-separated has-many or many-to-many relations to count, returned under _count.",
129
+ });
130
+ }
131
+ const searchColumns = source.searchColumns ?? source.searchableColumns;
132
+ if (searchColumns && searchColumns.length > 0) {
133
+ params.push({
134
+ name: "search",
135
+ schema: { type: "string" },
136
+ description: `Case-insensitive search in ${searchColumns.join(", ")}.`,
137
+ });
138
+ }
139
+ if (options.cursor !== false) {
140
+ params.push({
141
+ name: "cursor",
142
+ schema: { type: "string" },
143
+ description: "Keyset pagination: empty for the first page, then the nextCursor of the previous page.",
144
+ }, {
145
+ name: "count",
146
+ schema: { type: "boolean" },
147
+ description: "With cursor: also return total.",
148
+ });
149
+ }
150
+ if (source.allowTrash && !options.trash) {
151
+ params.push({
152
+ name: "withDeleted",
153
+ schema: { type: "boolean" },
154
+ description: "Include soft-deleted rows.",
155
+ }, {
156
+ name: "onlyDeleted",
157
+ schema: { type: "boolean" },
158
+ description: "Only soft-deleted rows.",
159
+ });
160
+ }
161
+ for (const path of source.filterableColumns ?? own) {
162
+ const column = path.includes(".")
163
+ ? columnAt(source.table, relations, path)
164
+ : columns[path];
165
+ if (!column)
166
+ continue;
167
+ const name = queryName(path);
168
+ params.push({
169
+ name,
170
+ schema: schemaOf(column),
171
+ description: `Filter on ${path}: an exact value, or an operator as ${name}[gte]=... (${OPERATORS}).`,
172
+ });
173
+ }
174
+ return params.map((param) => ({ required: false, ...param }));
175
+ }
176
+ function ApiCrudQuery(source, options = {}) {
177
+ const { ApiQuery } = loadSwagger();
178
+ const resolved = resolveSource(source);
179
+ const decorators = queryParams(resolved, options).map((param) => ApiQuery(param));
180
+ return (target, key, descriptor) => {
181
+ for (const decorate of decorators)
182
+ decorate(target, key, descriptor);
183
+ };
184
+ }
185
+ function ApiCrudList(source, options = {}) {
186
+ const { ApiOkResponse } = loadSwagger();
187
+ const resolved = resolveSource(source);
188
+ const properties = {};
189
+ for (const [name, column] of Object.entries(columnsOf(resolved.table))) {
190
+ properties[name] = {
191
+ ...schemaOf(column),
192
+ ...(column?.notNull ? {} : { nullable: true }),
193
+ };
194
+ }
195
+ const query = ApiCrudQuery(source, options);
196
+ const response = ApiOkResponse({
197
+ description: "A page of rows. Offset pages carry total (null with withCount=false), page, limit and hasMore; cursor pages carry nextCursor.",
198
+ schema: {
199
+ type: "object",
200
+ properties: {
201
+ data: { type: "array", items: { type: "object", properties } },
202
+ total: { type: "integer", nullable: true },
203
+ page: { type: "integer" },
204
+ limit: { type: "integer" },
205
+ hasMore: { type: "boolean" },
206
+ nextCursor: { type: "string", nullable: true },
207
+ },
208
+ required: ["data", "limit"],
209
+ },
210
+ });
211
+ return (target, key, descriptor) => {
212
+ query(target, key, descriptor);
213
+ response(target, key, descriptor);
214
+ };
215
+ }
216
+ //# sourceMappingURL=api-crud.decorators.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-crud.decorators.js","sourceRoot":"","sources":["../../src/openapi/api-crud.decorators.ts"],"names":[],"mappings":";;;;AAAA,6CAA8C;AAwB9C,IAAI,OAAY,CAAC;AACjB,SAAS,WAAW;IACnB,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,IAAI,CAAC;QAGJ,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACR,MAAM,IAAI,KAAK,CACd,gHAAgH,CAChH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAAqB;IAG3C,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACd,yBAAyB,MAAM,CAAC,IAAI,mGAAmG,CACvI,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACd,6DAA6D,CAC7D,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAGD,SAAS,QAAQ,CAAC,MAAW;IAC5B,QAAQ,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC1B,KAAK,QAAQ;YACZ,OAAO,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;gBAClE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE;gBACrB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QACvB,KAAK,QAAQ;YACZ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAC5C,KAAK,SAAS;YACb,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC5B,KAAK,MAAM;YACV,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAChD,KAAK,OAAO;YACX,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9D,KAAK,MAAM;YACV,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;IACpD,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,SAAS,CAAC,KAAU;IAC5B,IAAI,CAAC;QACJ,OAAO,IAAA,6BAAe,EAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC;AAGD,SAAS,QAAQ,CAChB,KAAU,EACV,SAA0B,EAC1B,IAAY;IAEZ,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,KAAK,GAAG,SAAS,CAAC;IACtB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QAChC,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC;QACzB,KAAK,GAAG,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,SAAS,GACd,kJAAkJ,CAAC;AAGpJ,SAAS,SAAS,CAAC,IAAY;IAC9B,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,WAAW,CACnB,MAA8C,EAC9C,OAA4B;IAE5B,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,CAAC,KAA2B,EAAE,QAAkB,EAAE,EAAE,CAChE,CAAC,KAAK,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,MAAM,GAAmC;QAC9C;YACC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;YACvC,WAAW,EAAE,sBAAsB;SACnC;QACD;YACC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;YACvC,WAAW,EAAE,iDAAiD;SAC9D;QACD;YACC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EAAE,sEAAsE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC,GAAG;SACvH;QACD;YACC,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;YACjD,WAAW,EAAE,wDAAwD;SACrE;QACD;YACC,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3B,WAAW,EACV,wFAAwF;SACzF;QACD;YACC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EAAE,qFAAqF,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,GAAG,CAAC,GAAG;SACxI;KACD,CAAC;IACF,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7C,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CACV;YACC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EAAE,oEAAoE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,aAAa,CAAC,GAAG;SACjI,EACD;YACC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EACV,qFAAqF;SACtF,CACD,CAAC;IACH,CAAC;IACD,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,iBAAiB,CAAC;IACvE,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EAAE,8BAA8B,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACtE,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CACV;YACC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,WAAW,EACV,wFAAwF;SACzF,EACD;YACC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3B,WAAW,EAAE,iCAAiC;SAC9C,CACD,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACzC,MAAM,CAAC,IAAI,CACV;YACC,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3B,WAAW,EAAE,4BAA4B;SACzC,EACD;YACC,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3B,WAAW,EAAE,yBAAyB;SACtC,CACD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,iBAAiB,IAAI,GAAG,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAChC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC;YACzC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC;YACX,IAAI;YACJ,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,aAAa,IAAI,uCAAuC,IAAI,cAAc,SAAS,IAAI;SACpG,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAKD,sBACC,MAAqB,EACrB,OAAO,GAAwB,EAAE;IAEjC,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,UAAU,GAAsB,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,GAAG,CACvE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAC1B,CAAC;IACF,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAClC,KAAK,MAAM,QAAQ,IAAI,UAAU;YAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACtE,CAAC,CAAC;AACH,CAAC;AAID,qBACC,MAAqB,EACrB,OAAO,GAAwB,EAAE;IAEjC,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,CAAC;IACxC,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACxE,UAAU,CAAC,IAAI,CAAC,GAAG;YAClB,GAAG,QAAQ,CAAC,MAAM,CAAC;YACnB,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;SAC9C,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,aAAa,CAAC;QAC9B,WAAW,EACV,+HAA+H;QAChI,MAAM,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACX,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE;gBAC9D,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC1C,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC5B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;aAC9C;YACD,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;SAC3B;KACD,CAAC,CAAC;IACH,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAClC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAC/B,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACnC,CAAC,CAAC;AACH,CAAC"}
@@ -0,0 +1,64 @@
1
+ import type { SqlBaseCrudService } from "../core/abstract/sql-base-crud.service";
2
+ export declare class BaseCrudSpecHelper<T extends Record<string, any>, C, U, F> {
3
+ protected getServiceClass: () => new (config: any) => SqlBaseCrudService<T, C, U, F>;
4
+ protected getMockTable: () => any;
5
+ protected getCreateDto: () => C;
6
+ protected getUpdateDto: () => U;
7
+ protected getEntity: () => T;
8
+ protected service: SqlBaseCrudService<T, C, U, F>;
9
+ protected mockDb: any;
10
+ protected mockTable: any;
11
+ constructor(getServiceClass: () => new (config: any) => SqlBaseCrudService<T, C, U, F>, getMockTable: () => any, getCreateDto: () => C, getUpdateDto: () => U, getEntity: () => T);
12
+ protected setup(): void;
13
+ getCreateDtoData(): C;
14
+ getUpdateDtoData(): U;
15
+ getEntityData(): T;
16
+ getFindSuccessScenario(): {
17
+ input: number;
18
+ expected: T;
19
+ mockEntity: T;
20
+ };
21
+ getFindNotFoundScenario(): {
22
+ input: number;
23
+ expected: null;
24
+ };
25
+ getCreateSuccessScenario(): {
26
+ input: C;
27
+ expected: T;
28
+ mockEntity: T;
29
+ mockInsert: {
30
+ values: jest.Mock<any, any, any>;
31
+ returning: jest.Mock<any, any, any>;
32
+ };
33
+ };
34
+ getUpdateSuccessScenario(): {
35
+ input: {
36
+ id: number;
37
+ data: U;
38
+ };
39
+ expected: T & U;
40
+ mockEntity: T;
41
+ updatedEntity: T & U;
42
+ mockUpdate: {
43
+ set: jest.Mock<any, any, any>;
44
+ where: jest.Mock<any, any, any>;
45
+ returning: jest.Mock<any, any, any>;
46
+ };
47
+ };
48
+ getDeleteSuccessScenario(): {
49
+ input: number;
50
+ expected: boolean;
51
+ mockEntity: T;
52
+ };
53
+ getFindAllSuccessScenario(): {
54
+ input: {};
55
+ expected: {
56
+ data: T[];
57
+ total: number;
58
+ page: number;
59
+ limit: number;
60
+ };
61
+ mockEntities: T[];
62
+ };
63
+ resetMocks(): void;
64
+ }
@@ -0,0 +1,119 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BaseCrudSpecHelper = void 0;
4
+ const test_factory_1 = require("./test-factory");
5
+ class BaseCrudSpecHelper {
6
+ getServiceClass;
7
+ getMockTable;
8
+ getCreateDto;
9
+ getUpdateDto;
10
+ getEntity;
11
+ service;
12
+ mockDb;
13
+ mockTable;
14
+ constructor(getServiceClass, getMockTable, getCreateDto, getUpdateDto, getEntity) {
15
+ this.getServiceClass = getServiceClass;
16
+ this.getMockTable = getMockTable;
17
+ this.getCreateDto = getCreateDto;
18
+ this.getUpdateDto = getUpdateDto;
19
+ this.getEntity = getEntity;
20
+ this.setup();
21
+ }
22
+ setup() {
23
+ this.mockDb = test_factory_1.TestCrudFactory.createMockDb();
24
+ this.mockTable = this.getMockTable();
25
+ this.service = test_factory_1.TestCrudFactory.createTestService(this.getServiceClass(), this.mockDb, this.mockTable);
26
+ }
27
+ getCreateDtoData() {
28
+ return this.getCreateDto();
29
+ }
30
+ getUpdateDtoData() {
31
+ return this.getUpdateDto();
32
+ }
33
+ getEntityData() {
34
+ return this.getEntity();
35
+ }
36
+ getFindSuccessScenario() {
37
+ const mockEntity = this.getEntity();
38
+ this.mockDb.select.mockResolvedValue([mockEntity]);
39
+ return {
40
+ input: 1,
41
+ expected: mockEntity,
42
+ mockEntity,
43
+ };
44
+ }
45
+ getFindNotFoundScenario() {
46
+ this.mockDb.select.mockResolvedValue([]);
47
+ return {
48
+ input: 999,
49
+ expected: null,
50
+ };
51
+ }
52
+ getCreateSuccessScenario() {
53
+ const createDto = this.getCreateDto();
54
+ const mockEntity = this.getEntity();
55
+ const mockInsert = {
56
+ values: jest.fn().mockReturnThis(),
57
+ returning: jest.fn().mockResolvedValue([mockEntity]),
58
+ };
59
+ this.mockDb.insert.mockReturnValue(mockInsert);
60
+ return {
61
+ input: createDto,
62
+ expected: mockEntity,
63
+ mockEntity,
64
+ mockInsert,
65
+ };
66
+ }
67
+ getUpdateSuccessScenario() {
68
+ const updateDto = this.getUpdateDto();
69
+ const mockEntity = this.getEntity();
70
+ const updatedEntity = { ...mockEntity, ...updateDto };
71
+ this.mockDb.select.mockResolvedValue([mockEntity]);
72
+ const mockUpdate = {
73
+ set: jest.fn().mockReturnThis(),
74
+ where: jest.fn().mockReturnThis(),
75
+ returning: jest.fn().mockResolvedValue([updatedEntity]),
76
+ };
77
+ this.mockDb.update.mockReturnValue(mockUpdate);
78
+ return {
79
+ input: { id: 1, data: updateDto },
80
+ expected: updatedEntity,
81
+ mockEntity,
82
+ updatedEntity,
83
+ mockUpdate,
84
+ };
85
+ }
86
+ getDeleteSuccessScenario() {
87
+ const mockEntity = this.getEntity();
88
+ this.mockDb.select.mockResolvedValue([mockEntity]);
89
+ this.mockDb.delete.mockResolvedValue([{ affectedRows: 1 }]);
90
+ return {
91
+ input: 1,
92
+ expected: true,
93
+ mockEntity,
94
+ };
95
+ }
96
+ getFindAllSuccessScenario() {
97
+ const mockEntities = [this.getEntity(), this.getEntity()];
98
+ const mockCountResult = [{ count: "2" }];
99
+ this.mockDb.select
100
+ .mockResolvedValueOnce(mockEntities)
101
+ .mockResolvedValueOnce(mockCountResult);
102
+ return {
103
+ input: {},
104
+ expected: {
105
+ data: mockEntities,
106
+ total: 2,
107
+ page: 1,
108
+ limit: 20,
109
+ },
110
+ mockEntities,
111
+ };
112
+ }
113
+ resetMocks() {
114
+ jest.clearAllMocks();
115
+ this.setup();
116
+ }
117
+ }
118
+ exports.BaseCrudSpecHelper = BaseCrudSpecHelper;
119
+ //# sourceMappingURL=base-crud.spec-helper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base-crud.spec-helper.js","sourceRoot":"","sources":["../../src/test-utils/base-crud.spec-helper.ts"],"names":[],"mappings":";;;AACA,iDAAiD;AAEjD;IAOY,eAAe;IAGf,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,SAAS;IAXV,OAAO,CAAkC;IACzC,MAAM,CAAM;IACZ,SAAS,CAAM;IAEzB,YACW,eAEyB,EACzB,YAAuB,EACvB,YAAqB,EACrB,YAAqB,EACrB,SAAkB;+BANlB,eAAe;4BAGf,YAAY;4BACZ,YAAY;4BACZ,YAAY;yBACZ,SAAS;QAEnB,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IAES,KAAK;QACd,IAAI,CAAC,MAAM,GAAG,8BAAe,CAAC,YAAY,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAErC,IAAI,CAAC,OAAO,GAAG,8BAAe,CAAC,iBAAiB,CAC/C,IAAI,CAAC,eAAe,EAAE,EACtB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,CACd,CAAC;IACH,CAAC;IAGD,gBAAgB;QACf,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;IAED,gBAAgB;QACf,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;IAED,aAAa;QACZ,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAGD,sBAAsB;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QACnD,OAAO;YACN,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE,UAAU;YACpB,UAAU;SACV,CAAC;IACH,CAAC;IAED,uBAAuB;QACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACzC,OAAO;YACN,KAAK,EAAE,GAAG;YACV,QAAQ,EAAE,IAAI;SACd,CAAC;IACH,CAAC;IAED,wBAAwB;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAGpC,MAAM,UAAU,GAAG;YAClB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAClC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,UAAU,CAAC,CAAC;SACpD,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAE/C,OAAO;YACN,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,UAAU;YACpB,UAAU;YACV,UAAU;SACV,CAAC;IACH,CAAC;IAED,wBAAwB;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,aAAa,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,SAAS,EAAE,CAAC;QAEtD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnD,MAAM,UAAU,GAAG;YAClB,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAC/B,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YACjC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAC,CAAC;SACvD,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAE/C,OAAO;YACN,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE;YACjC,QAAQ,EAAE,aAAa;YACvB,UAAU;YACV,aAAa;YACb,UAAU;SACV,CAAC;IACH,CAAC;IAED,wBAAwB;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5D,OAAO;YACN,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,UAAU;SACV,CAAC;IACH,CAAC;IAED,yBAAyB;QACxB,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1D,MAAM,eAAe,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAGzC,IAAI,CAAC,MAAM,CAAC,MAAM;aAChB,qBAAqB,CAAC,YAAY,CAAC;aACnC,qBAAqB,CAAC,eAAe,CAAC,CAAC;QAEzC,OAAO;YACN,KAAK,EAAE,EAAE;YACT,QAAQ,EAAE;gBACT,IAAI,EAAE,YAAY;gBAClB,KAAK,EAAE,CAAC;gBACR,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,EAAE;aACT;YACD,YAAY;SACZ,CAAC;IACH,CAAC;IAGD,UAAU;QACT,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;CACD"}
@@ -0,0 +1,2 @@
1
+ export { BaseCrudSpecHelper } from "./base-crud.spec-helper";
2
+ export { TestCrudFactory } from "./test-factory";
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TestCrudFactory = exports.BaseCrudSpecHelper = void 0;
4
+ var base_crud_spec_helper_1 = require("./base-crud.spec-helper");
5
+ Object.defineProperty(exports, "BaseCrudSpecHelper", { enumerable: true, get: function () { return base_crud_spec_helper_1.BaseCrudSpecHelper; } });
6
+ var test_factory_1 = require("./test-factory");
7
+ Object.defineProperty(exports, "TestCrudFactory", { enumerable: true, get: function () { return test_factory_1.TestCrudFactory; } });
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/test-utils/index.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAApD,2HAAA,kBAAkB,OAAA;AAC3B,+CAAiD;AAAxC,+GAAA,eAAe,OAAA"}
@@ -0,0 +1,29 @@
1
+ import type { SqlBaseCrudService } from "../core/abstract/sql-base-crud.service";
2
+ import type { SqlCrudConfig } from "../core/interfaces/sql-crud-config.interface";
3
+ export declare class TestCrudFactory {
4
+ static createTestService<T extends SqlBaseCrudService<any, any, any, any>>(ServiceClass: new (config: SqlCrudConfig) => T, mockDb: any, mockTable: any, configOverrides?: Partial<SqlCrudConfig>): T;
5
+ static createMockDb(): {
6
+ select: jest.Mock<any, any, any>;
7
+ from: jest.Mock<any, any, any>;
8
+ where: jest.Mock<any, any, any>;
9
+ limit: jest.Mock<any, any, any>;
10
+ offset: jest.Mock<any, any, any>;
11
+ orderBy: jest.Mock<any, any, any>;
12
+ insert: jest.Mock<any, any, any>;
13
+ values: jest.Mock<any, any, any>;
14
+ returning: jest.Mock<any, any, any>;
15
+ update: jest.Mock<any, any, any>;
16
+ set: jest.Mock<any, any, any>;
17
+ delete: jest.Mock<any, any, any>;
18
+ transaction: jest.Mock<any, any, any>;
19
+ };
20
+ static createMockTable(): {
21
+ id: string;
22
+ name: string;
23
+ email: string;
24
+ created_at: string;
25
+ updated_at: string;
26
+ deleted_at: string;
27
+ };
28
+ static createMockEntity(overrides?: any): any;
29
+ }