@edium/halifax 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 (135) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/LICENSE +21 -0
  3. package/README.md +148 -0
  4. package/README_AUTH.md +172 -0
  5. package/README_AUTOCRUD.md +253 -0
  6. package/README_CACHE.md +164 -0
  7. package/README_HTTP_ADAPTERS.md +309 -0
  8. package/README_MULTITENANCY.md +162 -0
  9. package/README_QUERYBUILDER.md +219 -0
  10. package/README_REPO_ADAPTERS.md +266 -0
  11. package/dist/adapters/http/ExpressAdapter.d.ts +40 -0
  12. package/dist/adapters/http/ExpressAdapter.d.ts.map +1 -0
  13. package/dist/adapters/http/ExpressAdapter.js +109 -0
  14. package/dist/adapters/http/ExpressAdapter.js.map +1 -0
  15. package/dist/adapters/orm/prisma/PrismaAdapter.d.ts +143 -0
  16. package/dist/adapters/orm/prisma/PrismaAdapter.d.ts.map +1 -0
  17. package/dist/adapters/orm/prisma/PrismaAdapter.js +277 -0
  18. package/dist/adapters/orm/prisma/PrismaAdapter.js.map +1 -0
  19. package/dist/adapters/orm/prisma/createPrismaResources.d.ts +15 -0
  20. package/dist/adapters/orm/prisma/createPrismaResources.d.ts.map +1 -0
  21. package/dist/adapters/orm/prisma/createPrismaResources.js +51 -0
  22. package/dist/adapters/orm/prisma/createPrismaResources.js.map +1 -0
  23. package/dist/adapters/orm/prisma/helpers.d.ts +27 -0
  24. package/dist/adapters/orm/prisma/helpers.d.ts.map +1 -0
  25. package/dist/adapters/orm/prisma/helpers.js +45 -0
  26. package/dist/adapters/orm/prisma/helpers.js.map +1 -0
  27. package/dist/adapters/orm/prisma/index.d.ts +4 -0
  28. package/dist/adapters/orm/prisma/index.d.ts.map +1 -0
  29. package/dist/adapters/orm/prisma/index.js +3 -0
  30. package/dist/adapters/orm/prisma/index.js.map +1 -0
  31. package/dist/adapters/orm/prisma/types.d.ts +49 -0
  32. package/dist/adapters/orm/prisma/types.d.ts.map +1 -0
  33. package/dist/adapters/orm/prisma/types.js +2 -0
  34. package/dist/adapters/orm/prisma/types.js.map +1 -0
  35. package/dist/auth/AuthStrategy.d.ts +198 -0
  36. package/dist/auth/AuthStrategy.d.ts.map +1 -0
  37. package/dist/auth/AuthStrategy.js +227 -0
  38. package/dist/auth/AuthStrategy.js.map +1 -0
  39. package/dist/classes/QueryBuilder.d.ts +33 -0
  40. package/dist/classes/QueryBuilder.d.ts.map +1 -0
  41. package/dist/classes/QueryBuilder.js +262 -0
  42. package/dist/classes/QueryBuilder.js.map +1 -0
  43. package/dist/core/crudRouter.d.ts +36 -0
  44. package/dist/core/crudRouter.d.ts.map +1 -0
  45. package/dist/core/crudRouter.js +391 -0
  46. package/dist/core/crudRouter.js.map +1 -0
  47. package/dist/core/queryString.d.ts +13 -0
  48. package/dist/core/queryString.d.ts.map +1 -0
  49. package/dist/core/queryString.js +89 -0
  50. package/dist/core/queryString.js.map +1 -0
  51. package/dist/core/types.d.ts +293 -0
  52. package/dist/core/types.d.ts.map +1 -0
  53. package/dist/core/types.js +13 -0
  54. package/dist/core/types.js.map +1 -0
  55. package/dist/core/validation.d.ts +75 -0
  56. package/dist/core/validation.d.ts.map +1 -0
  57. package/dist/core/validation.js +206 -0
  58. package/dist/core/validation.js.map +1 -0
  59. package/dist/enums/SqlComparison.d.ts +18 -0
  60. package/dist/enums/SqlComparison.d.ts.map +1 -0
  61. package/dist/enums/SqlComparison.js +19 -0
  62. package/dist/enums/SqlComparison.js.map +1 -0
  63. package/dist/enums/SqlOperator.d.ts +6 -0
  64. package/dist/enums/SqlOperator.d.ts.map +1 -0
  65. package/dist/enums/SqlOperator.js +7 -0
  66. package/dist/enums/SqlOperator.js.map +1 -0
  67. package/dist/enums/SqlOrder.d.ts +6 -0
  68. package/dist/enums/SqlOrder.d.ts.map +1 -0
  69. package/dist/enums/SqlOrder.js +7 -0
  70. package/dist/enums/SqlOrder.js.map +1 -0
  71. package/dist/errors/AuthenticationError.d.ts +10 -0
  72. package/dist/errors/AuthenticationError.d.ts.map +1 -0
  73. package/dist/errors/AuthenticationError.js +13 -0
  74. package/dist/errors/AuthenticationError.js.map +1 -0
  75. package/dist/errors/AuthorizationError.d.ts +10 -0
  76. package/dist/errors/AuthorizationError.d.ts.map +1 -0
  77. package/dist/errors/AuthorizationError.js +13 -0
  78. package/dist/errors/AuthorizationError.js.map +1 -0
  79. package/dist/errors/BadRequestError.d.ts +10 -0
  80. package/dist/errors/BadRequestError.d.ts.map +1 -0
  81. package/dist/errors/BadRequestError.js +13 -0
  82. package/dist/errors/BadRequestError.js.map +1 -0
  83. package/dist/errors/HttpError.d.ts +12 -0
  84. package/dist/errors/HttpError.d.ts.map +1 -0
  85. package/dist/errors/HttpError.js +17 -0
  86. package/dist/errors/HttpError.js.map +1 -0
  87. package/dist/errors/MethodNotAllowedError.d.ts +10 -0
  88. package/dist/errors/MethodNotAllowedError.d.ts.map +1 -0
  89. package/dist/errors/MethodNotAllowedError.js +13 -0
  90. package/dist/errors/MethodNotAllowedError.js.map +1 -0
  91. package/dist/errors/NotAcceptableError.d.ts +10 -0
  92. package/dist/errors/NotAcceptableError.d.ts.map +1 -0
  93. package/dist/errors/NotAcceptableError.js +13 -0
  94. package/dist/errors/NotAcceptableError.js.map +1 -0
  95. package/dist/errors/NotFoundError.d.ts +10 -0
  96. package/dist/errors/NotFoundError.d.ts.map +1 -0
  97. package/dist/errors/NotFoundError.js +13 -0
  98. package/dist/errors/NotFoundError.js.map +1 -0
  99. package/dist/errors/NotImplementedError.d.ts +10 -0
  100. package/dist/errors/NotImplementedError.d.ts.map +1 -0
  101. package/dist/errors/NotImplementedError.js +13 -0
  102. package/dist/errors/NotImplementedError.js.map +1 -0
  103. package/dist/errors/ServerError.d.ts +10 -0
  104. package/dist/errors/ServerError.d.ts.map +1 -0
  105. package/dist/errors/ServerError.js +13 -0
  106. package/dist/errors/ServerError.js.map +1 -0
  107. package/dist/errors/UnprocessableEntityError.d.ts +10 -0
  108. package/dist/errors/UnprocessableEntityError.d.ts.map +1 -0
  109. package/dist/errors/UnprocessableEntityError.js +13 -0
  110. package/dist/errors/UnprocessableEntityError.js.map +1 -0
  111. package/dist/errors/UnsupportedMediaTypeError.d.ts +10 -0
  112. package/dist/errors/UnsupportedMediaTypeError.d.ts.map +1 -0
  113. package/dist/errors/UnsupportedMediaTypeError.js +13 -0
  114. package/dist/errors/UnsupportedMediaTypeError.js.map +1 -0
  115. package/dist/index.d.ts +27 -0
  116. package/dist/index.d.ts.map +1 -0
  117. package/dist/index.js +27 -0
  118. package/dist/index.js.map +1 -0
  119. package/dist/interfaces/IParamQuery.d.ts +8 -0
  120. package/dist/interfaces/IParamQuery.d.ts.map +1 -0
  121. package/dist/interfaces/IParamQuery.js +2 -0
  122. package/dist/interfaces/IParamQuery.js.map +1 -0
  123. package/dist/interfaces/IQueryFilter.d.ts +18 -0
  124. package/dist/interfaces/IQueryFilter.d.ts.map +1 -0
  125. package/dist/interfaces/IQueryFilter.js +2 -0
  126. package/dist/interfaces/IQueryFilter.js.map +1 -0
  127. package/dist/interfaces/IQueryOptions.d.ts +20 -0
  128. package/dist/interfaces/IQueryOptions.d.ts.map +1 -0
  129. package/dist/interfaces/IQueryOptions.js +2 -0
  130. package/dist/interfaces/IQueryOptions.js.map +1 -0
  131. package/dist/interfaces/ISort.d.ts +9 -0
  132. package/dist/interfaces/ISort.d.ts.map +1 -0
  133. package/dist/interfaces/ISort.js +2 -0
  134. package/dist/interfaces/ISort.js.map +1 -0
  135. package/package.json +169 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IQueryOptions.js","sourceRoot":"","sources":["../../src/interfaces/IQueryOptions.ts"],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ import { SqlOrder } from '../enums/SqlOrder.js';
2
+ /** A single ORDER BY expression. */
3
+ export interface ISort {
4
+ /** Column name to sort by. */
5
+ field: string;
6
+ /** Sort direction. */
7
+ order: SqlOrder;
8
+ }
9
+ //# sourceMappingURL=ISort.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ISort.d.ts","sourceRoot":"","sources":["../../src/interfaces/ISort.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAE9C,oCAAoC;AACpC,MAAM,WAAW,KAAK;IACpB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,sBAAsB;IACtB,KAAK,EAAE,QAAQ,CAAA;CAChB"}
@@ -0,0 +1,2 @@
1
+ import { SqlOrder } from '../enums/SqlOrder.js';
2
+ //# sourceMappingURL=ISort.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ISort.js","sourceRoot":"","sources":["../../src/interfaces/ISort.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA"}
package/package.json ADDED
@@ -0,0 +1,169 @@
1
+ {
2
+ "name": "@edium/halifax",
3
+ "version": "1.0.0",
4
+ "description": "Auto-generate type-safe REST CRUD APIs from your data models. Adapter-driven: Express/Fastify/HyperExpress, Prisma (PostgreSQL, MySQL, SQLite, SQL Server, MongoDB, CockroachDB), JWT/API-key auth, multi-tenancy, a dynamic query builder, and pluggable Redis caching.",
5
+ "author": "David LaTour <david@edium.com>",
6
+ "homepage": "https://github.com/splayfee/halifax#readme",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/splayfee/halifax.git"
10
+ },
11
+ "bugs": {
12
+ "url": "https://github.com/splayfee/halifax/issues"
13
+ },
14
+ "license": "MIT",
15
+ "type": "module",
16
+ "main": "./dist/index.js",
17
+ "types": "./dist/index.d.ts",
18
+ "exports": {
19
+ ".": {
20
+ "types": "./dist/index.d.ts",
21
+ "import": "./dist/index.js",
22
+ "default": "./dist/index.js"
23
+ },
24
+ "./express": {
25
+ "types": "./dist/adapters/http/ExpressAdapter.d.ts",
26
+ "import": "./dist/adapters/http/ExpressAdapter.js",
27
+ "default": "./dist/adapters/http/ExpressAdapter.js"
28
+ },
29
+ "./fastify": {
30
+ "types": "./dist/adapters/http/FastifyAdapter.d.ts",
31
+ "import": "./dist/adapters/http/FastifyAdapter.js",
32
+ "default": "./dist/adapters/http/FastifyAdapter.js"
33
+ },
34
+ "./hyper-express": {
35
+ "types": "./dist/adapters/http/HyperExpressAdapter.d.ts",
36
+ "import": "./dist/adapters/http/HyperExpressAdapter.js",
37
+ "default": "./dist/adapters/http/HyperExpressAdapter.js"
38
+ },
39
+ "./ultimate-express": {
40
+ "types": "./dist/adapters/http/UltimateExpressAdapter.d.ts",
41
+ "import": "./dist/adapters/http/UltimateExpressAdapter.js",
42
+ "default": "./dist/adapters/http/UltimateExpressAdapter.js"
43
+ },
44
+ "./package.json": "./package.json"
45
+ },
46
+ "files": [
47
+ "dist",
48
+ "CHANGELOG.md",
49
+ "README.md",
50
+ "README_AUTH.md",
51
+ "README_AUTOCRUD.md",
52
+ "README_CACHE.md",
53
+ "README_HTTP_ADAPTERS.md",
54
+ "README_MULTITENANCY.md",
55
+ "README_QUERYBUILDER.md",
56
+ "README_REPO_ADAPTERS.md",
57
+ "LICENSE"
58
+ ],
59
+ "publishConfig": {
60
+ "access": "public"
61
+ },
62
+ "sideEffects": false,
63
+ "prepublishOnly": "npm run build",
64
+ "scripts": {
65
+ "build": "rm -rf dist && tsc --build && tsc-alias",
66
+ "dev": "tsx watch ./examples/express-prisma.ts",
67
+ "lint": "eslint .",
68
+ "lint:fix": "eslint . --fix",
69
+ "prettier": "prettier --check .",
70
+ "prettier:fix": "prettier --write .",
71
+ "test:unit": "vitest run tests/unit",
72
+ "test:unit:coverage": "vitest run --coverage tests/unit",
73
+ "test:integration": "dotenv -e .env.test -- vitest run --config vitest.integration.config.ts",
74
+ "test:integration:generate": "prisma generate --schema=tests/integration/prisma/schema.prisma",
75
+ "type-check": "tsc --noEmit && tsc --noEmit -p tests/tsconfig.json"
76
+ },
77
+ "engines": {
78
+ "node": ">=18.0.0"
79
+ },
80
+ "peerDependencies": {
81
+ "@prisma/client": ">=7.0.0",
82
+ "express": "^4.17.0 || ^5.0.0",
83
+ "fastify": ">=4.0.0",
84
+ "hyper-express": ">=6.0.0",
85
+ "ultimate-express": ">=2.0.0"
86
+ },
87
+ "peerDependenciesMeta": {
88
+ "@prisma/client": {
89
+ "optional": true
90
+ },
91
+ "express": {
92
+ "optional": true
93
+ },
94
+ "fastify": {
95
+ "optional": true
96
+ },
97
+ "hyper-express": {
98
+ "optional": true
99
+ },
100
+ "ultimate-express": {
101
+ "optional": true
102
+ }
103
+ },
104
+ "devDependencies": {
105
+ "@eslint/js": "^10.0.1",
106
+ "@prisma/adapter-better-sqlite3": "^7.8.0",
107
+ "@prisma/adapter-mariadb": "^7.8.0",
108
+ "@prisma/adapter-pg": "^7.8.0",
109
+ "@prisma/client": "^7.8.0",
110
+ "@types/express": "^5.0.6",
111
+ "@types/node": "^25.9.3",
112
+ "@types/pg": "^8.20.0",
113
+ "@types/supertest": "^7.2.0",
114
+ "@vitest/coverage-v8": "^4.1.8",
115
+ "better-sqlite3": "^12.10.0",
116
+ "dotenv-cli": "^11.0.0",
117
+ "eslint": "^10.4.1",
118
+ "eslint-config-prettier": "^10.1.8",
119
+ "express": "^5.2.1",
120
+ "fastify": "^5.8.5",
121
+ "globals": "^17.6.0",
122
+ "hyper-express": "^6.17.3",
123
+ "pg": "^8.21.0",
124
+ "prettier": "^3.8.4",
125
+ "prisma": "^7.8.0",
126
+ "redis": "^6.0.0",
127
+ "supertest": "^7.2.2",
128
+ "tsc-alias": "^1.8.17",
129
+ "tsx": "^4.22.4",
130
+ "typescript": "^6.0.3",
131
+ "typescript-eslint": "^8.61.0",
132
+ "ultimate-express": "^2.1.1",
133
+ "vitest": "^4.1.8"
134
+ },
135
+ "keywords": [
136
+ "api",
137
+ "api-framework",
138
+ "autocrud",
139
+ "cache",
140
+ "caching",
141
+ "cockroachdb",
142
+ "crud",
143
+ "crud-api",
144
+ "express",
145
+ "fastify",
146
+ "hyper-express",
147
+ "jwt",
148
+ "mongodb",
149
+ "multi-tenancy",
150
+ "multi-tenant",
151
+ "mysql",
152
+ "orm",
153
+ "passport",
154
+ "postgresql",
155
+ "prisma",
156
+ "query-builder",
157
+ "redis",
158
+ "rest",
159
+ "rest-api",
160
+ "sqlite",
161
+ "sqlserver",
162
+ "typescript",
163
+ "ultimate-express"
164
+ ],
165
+ "packageManager": "pnpm@11.5.3",
166
+ "dependencies": {
167
+ "uuid": "^14.0.0"
168
+ }
169
+ }