@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,81 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TestCrudFactory = void 0;
4
+ class TestCrudFactory {
5
+ static createTestService(ServiceClass, mockDb, mockTable, configOverrides = {}) {
6
+ const config = {
7
+ dialect: "postgresql",
8
+ db: mockDb,
9
+ table: mockTable,
10
+ primaryKey: "id",
11
+ primaryKeyType: "serial",
12
+ softDelete: { enabled: true, column: "deleted_at" },
13
+ timestamps: { createdAt: "created_at", updatedAt: "updated_at" },
14
+ pagination: { defaultLimit: 20, maxLimit: 100 },
15
+ sql: {
16
+ caseSensitive: false,
17
+ useReturning: true,
18
+ jsonSupport: true,
19
+ enableFullTextSearch: false,
20
+ },
21
+ ...configOverrides,
22
+ };
23
+ return new ServiceClass(config);
24
+ }
25
+ static createMockDb() {
26
+ const mockDb = {
27
+ select: jest.fn().mockImplementation(() => ({
28
+ from: jest.fn().mockReturnThis(),
29
+ where: jest.fn().mockReturnThis(),
30
+ limit: jest.fn().mockReturnThis(),
31
+ offset: jest.fn().mockReturnThis(),
32
+ orderBy: jest.fn().mockReturnThis(),
33
+ fields: jest.fn().mockReturnThis(),
34
+ })),
35
+ from: jest.fn().mockReturnThis(),
36
+ where: jest.fn().mockReturnThis(),
37
+ limit: jest.fn().mockReturnThis(),
38
+ offset: jest.fn().mockReturnThis(),
39
+ orderBy: jest.fn().mockReturnThis(),
40
+ insert: jest.fn().mockImplementation(() => ({
41
+ values: jest.fn().mockReturnThis(),
42
+ returning: jest.fn(),
43
+ })),
44
+ values: jest.fn().mockReturnThis(),
45
+ returning: jest.fn().mockReturnThis(),
46
+ update: jest.fn().mockImplementation(() => ({
47
+ set: jest.fn().mockReturnThis(),
48
+ where: jest.fn().mockReturnThis(),
49
+ returning: jest.fn(),
50
+ })),
51
+ set: jest.fn().mockReturnThis(),
52
+ delete: jest.fn().mockImplementation(() => ({
53
+ where: jest.fn().mockReturnThis(),
54
+ })),
55
+ transaction: jest.fn().mockImplementation((cb) => cb(mockDb)),
56
+ };
57
+ return mockDb;
58
+ }
59
+ static createMockTable() {
60
+ return {
61
+ id: "id",
62
+ name: "name",
63
+ email: "email",
64
+ created_at: "created_at",
65
+ updated_at: "updated_at",
66
+ deleted_at: "deleted_at",
67
+ };
68
+ }
69
+ static createMockEntity(overrides = {}) {
70
+ return {
71
+ id: 1,
72
+ name: "Test Entity",
73
+ email: "test@example.com",
74
+ created_at: new Date(),
75
+ updated_at: new Date(),
76
+ ...overrides,
77
+ };
78
+ }
79
+ }
80
+ exports.TestCrudFactory = TestCrudFactory;
81
+ //# sourceMappingURL=test-factory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"test-factory.js","sourceRoot":"","sources":["../../src/test-utils/test-factory.ts"],"names":[],"mappings":";;;AAGA;IACC,MAAM,CAAC,iBAAiB,CACvB,YAA8C,EAC9C,MAAW,EACX,SAAc,EACd,eAAe,GAA2B,EAAE;QAE5C,MAAM,MAAM,GAAkB;YAC7B,OAAO,EAAE,YAAY;YACrB,EAAE,EAAE,MAAM;YACV,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,IAAI;YAChB,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE;YACnD,UAAU,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE;YAChE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;YAC/C,GAAG,EAAE;gBACJ,aAAa,EAAE,KAAK;gBACpB,YAAY,EAAE,IAAI;gBAClB,WAAW,EAAE,IAAI;gBACjB,oBAAoB,EAAE,KAAK;aAC3B;YACD,GAAG,eAAe;SAClB,CAAC;QAEF,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,YAAY;QAClB,MAAM,MAAM,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC3C,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBAChC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBACjC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBACjC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBAClC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBACnC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;aAClC,CAAC,CAAC;YACH,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAChC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YACjC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YACjC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAClC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YACnC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC3C,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBAClC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;aACpB,CAAC,CAAC;YACH,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAClC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YACrC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC3C,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBAC/B,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;gBACjC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;aACpB,CAAC,CAAC;YACH,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;YAC/B,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC3C,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,EAAE;aACjC,CAAC,CAAC;YACH,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;SAC7D,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC;IAED,MAAM,CAAC,eAAe;QACrB,OAAO;YACN,EAAE,EAAE,IAAI;YACR,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,UAAU,EAAE,YAAY;YACxB,UAAU,EAAE,YAAY;YACxB,UAAU,EAAE,YAAY;SACxB,CAAC;IACH,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,GAAQ,EAAE;QAC1C,OAAO;YACN,EAAE,EAAE,CAAC;YACL,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,kBAAkB;YACzB,UAAU,EAAE,IAAI,IAAI,EAAE;YACtB,UAAU,EAAE,IAAI,IAAI,EAAE;YACtB,GAAG,SAAS;SACZ,CAAC;IACH,CAAC;CACD"}
package/package.json CHANGED
@@ -1,6 +1,111 @@
1
1
  {
2
- "name": "@avytrix/nestjs-drizzle-crud",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
2
+ "name": "@avytrix/nestjs-drizzle-crud",
3
+ "version": "3.6.0",
4
+ "description": "NestJS + Drizzle ORM CRUD: type-safe services with filtering, pagination, cursor pagination, relations, soft delete, upsert, multi-tenancy and OpenAPI for PostgreSQL and MySQL.",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "bin": {
8
+ "nestjs-drizzle-crud-mcp": "dist/mcp/server.js"
9
+ },
10
+ "files": [
11
+ "dist/**/*",
12
+ "README.md",
13
+ "AGENT.md",
14
+ "AGENTS.template.md",
15
+ "CLAUDE.template.md",
16
+ "CHANGELOG.md",
17
+ "LICENSE"
18
+ ],
19
+ "scripts": {
20
+ "prebuild": "rm -rf dist *.tsbuildinfo",
21
+ "build": "tsc -p tsconfig.build.json",
22
+ "build:watch": "tsc -p tsconfig.build.json --watch",
23
+ "typecheck": "tsc --noEmit -p tsconfig.json",
24
+ "prepublishOnly": "pnpm run build && pnpm test",
25
+ "release": "pnpm publish --access public --no-git-checks",
26
+ "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
27
+ "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
28
+ "test:cov": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
29
+ "lint": "biome lint src",
30
+ "format": "biome format --write src"
31
+ },
32
+ "keywords": [
33
+ "nestjs",
34
+ "drizzle",
35
+ "drizzle-orm",
36
+ "crud",
37
+ "nestjs-crud",
38
+ "nestjs-drizzle",
39
+ "rest-api",
40
+ "pagination",
41
+ "cursor-pagination",
42
+ "filtering",
43
+ "soft-delete",
44
+ "multi-tenant",
45
+ "upsert",
46
+ "openapi",
47
+ "swagger",
48
+ "postgresql",
49
+ "mysql",
50
+ "typescript",
51
+ "mcp",
52
+ "rest",
53
+ "api",
54
+ "database",
55
+ "orm",
56
+ "eager-loading",
57
+ "n+1",
58
+ "multi-tenancy"
59
+ ],
60
+ "author": "Suman Bonakurthi <sumanbonakurthi@gmail.com>",
61
+ "license": "MIT",
62
+ "repository": {
63
+ "type": "git",
64
+ "url": "git+https://github.com/avytrix/nestjs-drizzle-crud.git",
65
+ "directory": "packages/nestjs-drizzle-crud"
66
+ },
67
+ "bugs": {
68
+ "url": "https://github.com/avytrix/nestjs-drizzle-crud/issues"
69
+ },
70
+ "homepage": "https://crud.avytrix.dev",
71
+ "funding": {
72
+ "type": "github",
73
+ "url": "https://github.com/sponsors/avytrix"
74
+ },
75
+ "peerDependencies": {
76
+ "@nestjs/common": ">=10.0.0",
77
+ "@nestjs/core": ">=10.0.0",
78
+ "@nestjs/swagger": ">=7.0.0",
79
+ "drizzle-orm": ">=0.28.0 <1.0.0",
80
+ "postgres": ">=3.0.0",
81
+ "reflect-metadata": "^0.1.13 || ^0.2.0"
82
+ },
83
+ "peerDependenciesMeta": {
84
+ "@nestjs/swagger": {
85
+ "optional": true
86
+ },
87
+ "postgres": {
88
+ "optional": true
89
+ }
90
+ },
91
+ "devDependencies": {
92
+ "@electric-sql/pglite": "^0.5.4",
93
+ "@jest/globals": "^30.0.0",
94
+ "@nestjs/common": "^11.1.28",
95
+ "@nestjs/core": "^11.1.28",
96
+ "@nestjs/swagger": "^11.4.7",
97
+ "@nestjs/testing": "^11.1.28",
98
+ "@swc/core": "^1.7.0",
99
+ "@swc/jest": "^0.2.37",
100
+ "@types/jest": "^30.0.0",
101
+ "@types/node": "^26.0.0",
102
+ "drizzle-orm": "^0.45.2",
103
+ "jest": "^30.4.2",
104
+ "postgres": "^3.4.9",
105
+ "reflect-metadata": "^0.2.0",
106
+ "typescript": "^7.0.0"
107
+ },
108
+ "engines": {
109
+ "node": ">=20.0.0"
110
+ }
111
+ }