json-rest-api 1.0.29 → 2.1.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 (294) hide show
  1. package/LICENSE +10 -670
  2. package/LICENSE-GPL-3.0 +674 -0
  3. package/LICENSE-MIT +21 -0
  4. package/README.md +39 -30
  5. package/docs/API.md +744 -1273
  6. package/docs/GUIDE/01-getting-started.md +338 -0
  7. package/docs/GUIDE/02-resources-and-relationships.md +33 -0
  8. package/docs/GUIDE/03-running-example.md +87 -0
  9. package/docs/GUIDE/04-creating-and-querying.md +181 -0
  10. package/docs/GUIDE/05-belongs-to.md +177 -0
  11. package/docs/GUIDE/06-has-many.md +184 -0
  12. package/docs/GUIDE/07-polymorphic-relationships.md +191 -0
  13. package/docs/GUIDE/08-many-to-many.md +184 -0
  14. package/docs/GUIDE/09-pagination-and-sorting.md +149 -0
  15. package/docs/GUIDE/10-put-and-patch.md +174 -0
  16. package/docs/GUIDE/11-relationship-endpoints.md +174 -0
  17. package/docs/GUIDE/12-field-transformations.md +287 -0
  18. package/docs/GUIDE/13-hooks-and-lifecycle.md +479 -0
  19. package/docs/GUIDE/14-custom-resource-methods.md +125 -0
  20. package/docs/GUIDE/15-query-projections.md +266 -0
  21. package/docs/GUIDE/{GUIDE_X_Autofiltering.md → 16-autofiltering.md} +77 -15
  22. package/docs/GUIDE/{GUIDE_X_Row_Policies.md → 17-row-policies.md} +137 -44
  23. package/docs/GUIDE/18-labels.md +86 -0
  24. package/docs/GUIDE/19-managed-transactions.md +179 -0
  25. package/docs/GUIDE/20-transaction-outcomes.md +207 -0
  26. package/docs/GUIDE/21-schema-and-migrations.md +733 -0
  27. package/docs/GUIDE/22-version-field-migrations.md +208 -0
  28. package/docs/GUIDE/23-fastify.md +179 -0
  29. package/docs/GUIDE/24-cors.md +172 -0
  30. package/docs/GUIDE/{GUIDE_X_URL_Management.md → 25-url-management.md} +7 -1
  31. package/docs/GUIDE/26-file-uploads.md +278 -0
  32. package/docs/GUIDE/27-bulk-operations.md +277 -0
  33. package/docs/GUIDE/28-socketio.md +325 -0
  34. package/docs/GUIDE/29-writing-plugins.md +278 -0
  35. package/docs/GUIDE/30-backend-capabilities.md +103 -0
  36. package/docs/GUIDE/31-positioning.md +181 -0
  37. package/docs/GUIDE/{GUIDE_Y_Appendices.md → 32-date-and-time.md} +74 -30
  38. package/docs/GUIDE/33-migrating-to-v2.md +3838 -0
  39. package/docs/GUIDE/index.md +51 -59
  40. package/docs/QUICKSTART.md +120 -287
  41. package/docs/architecture.md +75 -0
  42. package/docs/contributing.md +178 -0
  43. package/index.d.ts +37 -0
  44. package/index.js +3 -22
  45. package/lib/enhanced-logger.js +91 -85
  46. package/lib/error-context.js +445 -5
  47. package/lib/error-formatter.js +219 -59
  48. package/lib/knex-transaction.js +70 -0
  49. package/lib/logger-types.d.ts +22 -0
  50. package/lib/missing-package.js +4 -0
  51. package/lib/rest-api-errors.js +103 -8
  52. package/lib/runtime/json-rest-api.js +172 -0
  53. package/lib/transaction-types.d.ts +59 -0
  54. package/package.json +97 -27
  55. package/plugins/core/bulk-operations-plugin.js +191 -184
  56. package/plugins/core/connectors/express-plugin.js +148 -219
  57. package/plugins/core/connectors/fastify-plugin.js +125 -82
  58. package/plugins/core/connectors/lib/busboy-detector.js +74 -156
  59. package/plugins/core/connectors/lib/connector-core.js +144 -20
  60. package/plugins/core/connectors/lib/formidable-detector.js +63 -120
  61. package/plugins/core/connectors/lib/http-validators.js +77 -0
  62. package/plugins/core/connectors/lib/multipart-helpers.js +18 -0
  63. package/plugins/core/connectors/lib/request-helpers.js +10 -1
  64. package/plugins/core/connectors/lib/transport-http-helpers.js +89 -8
  65. package/plugins/core/connectors/lib/transport-route-schemas.js +7 -4
  66. package/plugins/core/file-handling-plugin.js +87 -177
  67. package/plugins/core/lib/anyapi/anyapi-registry.js +586 -418
  68. package/plugins/core/lib/anyapi/canonical-link-store.js +507 -0
  69. package/plugins/core/lib/anyapi/canonical-relationship-reader.js +598 -0
  70. package/plugins/core/lib/anyapi/schema-utils.js +120 -56
  71. package/plugins/core/lib/anyapi/stored-definition.js +109 -0
  72. package/plugins/core/lib/anyapi/utils/descriptor-helpers.js +0 -64
  73. package/plugins/core/lib/dbIntrospection.js +228 -21
  74. package/plugins/core/lib/dbTablesOperations.js +409 -92
  75. package/plugins/core/lib/fractional-positioning.js +12 -48
  76. package/plugins/core/lib/querying/identifier-query.js +19 -0
  77. package/plugins/core/lib/querying/include-query-helpers.js +364 -0
  78. package/plugins/core/lib/querying/include-to-many.js +428 -0
  79. package/plugins/core/lib/querying/include-to-one.js +579 -0
  80. package/plugins/core/lib/querying/knex-cross-table-search.js +31 -307
  81. package/plugins/core/lib/querying/knex-json-api-transformers-querying.js +99 -401
  82. package/plugins/core/lib/querying/knex-pagination-helpers.js +48 -317
  83. package/plugins/core/lib/querying/knex-process-includes.js +5 -110
  84. package/plugins/core/lib/querying/knex-query-helpers-base.js +21 -56
  85. package/plugins/core/lib/querying/knex-query-helpers.js +298 -448
  86. package/plugins/core/lib/querying/knex-relationship-includes.js +120 -2138
  87. package/plugins/core/lib/querying/knex-window-queries.js +62 -253
  88. package/plugins/core/lib/querying/query-builder-utils.js +44 -4
  89. package/plugins/core/lib/querying/query-constraint.d.ts +12 -0
  90. package/plugins/core/lib/querying/query-constraint.js +27 -0
  91. package/plugins/core/lib/querying/query-field-sort-helpers.js +134 -37
  92. package/plugins/core/lib/querying/relationship-identifiers.js +208 -0
  93. package/plugins/core/lib/querying/sort-helpers.js +13 -1
  94. package/plugins/core/lib/querying/storage-adapter-utils.js +13 -5
  95. package/plugins/core/lib/querying/url-helpers.js +11 -4
  96. package/plugins/core/lib/querying-writing/compile-schemas.js +148 -249
  97. package/plugins/core/lib/querying-writing/connectors-query-parser.js +33 -118
  98. package/plugins/core/lib/querying-writing/database-capabilities.js +149 -223
  99. package/plugins/core/lib/querying-writing/database-value-normalizers.js +179 -194
  100. package/plugins/core/lib/querying-writing/default-data-helpers.js +15 -45
  101. package/plugins/core/lib/querying-writing/field-selection-types.d.ts +43 -0
  102. package/plugins/core/lib/querying-writing/field-utils.js +113 -92
  103. package/plugins/core/lib/querying-writing/knex-constants.d.ts +18 -0
  104. package/plugins/core/lib/querying-writing/knex-constants.js +2 -26
  105. package/plugins/core/lib/querying-writing/knex-field-helpers.js +100 -290
  106. package/plugins/core/lib/querying-writing/knex-json-api-transformers.js +31 -120
  107. package/plugins/core/lib/querying-writing/query-field-helpers.js +108 -32
  108. package/plugins/core/lib/querying-writing/query-field-types.d.ts +60 -0
  109. package/plugins/core/lib/querying-writing/relationship-contracts.js +33 -13
  110. package/plugins/core/lib/querying-writing/request-contracts.js +93 -38
  111. package/plugins/core/lib/querying-writing/resource-id-normalization.js +23 -5
  112. package/plugins/core/lib/querying-writing/response-options.js +35 -0
  113. package/plugins/core/lib/querying-writing/schema-helpers.js +203 -324
  114. package/plugins/core/lib/querying-writing/scope-validations.js +92 -290
  115. package/plugins/core/lib/querying-writing/simplified-helpers.js +113 -712
  116. package/plugins/core/lib/storage/canonical-data-helpers.js +683 -0
  117. package/plugins/core/lib/storage/canonical-storage-mapping.js +51 -20
  118. package/plugins/core/lib/storage/ordinary-data-helpers.js +710 -0
  119. package/plugins/core/lib/storage/storage-adapter.js +128 -62
  120. package/plugins/core/lib/storage/storage-mapping.js +78 -28
  121. package/plugins/core/lib/storage/storage-types.d.ts +502 -0
  122. package/plugins/core/lib/writing/many-to-many-manipulations.js +114 -284
  123. package/plugins/core/lib/writing/relationship-processor.js +94 -158
  124. package/plugins/core/lib/writing/resource-version.js +172 -0
  125. package/plugins/core/lib/writing/reverse-relationship-manipulations.js +110 -0
  126. package/plugins/core/rest-api-anyapi-knex-plugin.js +290 -2475
  127. package/plugins/core/rest-api-autofilter-plugin.js +17 -19
  128. package/plugins/core/rest-api-cors-plugin.js +52 -205
  129. package/plugins/core/rest-api-knex-plugin.js +45 -1077
  130. package/plugins/core/rest-api-label-plugin.js +25 -38
  131. package/plugins/core/rest-api-plugin-hooks/register-relationship-routes.js +5 -5
  132. package/plugins/core/rest-api-plugin-hooks/register-scope-routes.js +9 -6
  133. package/plugins/core/rest-api-plugin-hooks/turn-scope-init-into-vars.js +7 -26
  134. package/plugins/core/rest-api-plugin-hooks/validate-include-configurations.js +20 -26
  135. package/plugins/core/rest-api-plugin-methods/add-route.js +4 -6
  136. package/plugins/core/rest-api-plugin-methods/apply-query-filters.js +42 -13
  137. package/plugins/core/rest-api-plugin-methods/check-permissions.js +11 -5
  138. package/plugins/core/rest-api-plugin-methods/common.js +291 -395
  139. package/plugins/core/rest-api-plugin-methods/delete-relationship.js +49 -47
  140. package/plugins/core/rest-api-plugin-methods/delete.js +31 -25
  141. package/plugins/core/rest-api-plugin-methods/enrich-attributes.js +108 -148
  142. package/plugins/core/rest-api-plugin-methods/get-related.js +113 -305
  143. package/plugins/core/rest-api-plugin-methods/get-relationship.js +25 -18
  144. package/plugins/core/rest-api-plugin-methods/get.js +36 -68
  145. package/plugins/core/rest-api-plugin-methods/lifecycle-types.d.ts +225 -0
  146. package/plugins/core/rest-api-plugin-methods/patch-relationship.js +28 -25
  147. package/plugins/core/rest-api-plugin-methods/patch.js +46 -99
  148. package/plugins/core/rest-api-plugin-methods/post-relationship.js +49 -53
  149. package/plugins/core/rest-api-plugin-methods/post.js +51 -51
  150. package/plugins/core/rest-api-plugin-methods/put.js +69 -148
  151. package/plugins/core/rest-api-plugin-methods/query.js +37 -81
  152. package/plugins/core/rest-api-plugin-methods/release.js +2 -1
  153. package/plugins/core/rest-api-plugin.js +32 -46
  154. package/plugins/core/rest-api-positioning-plugin.js +183 -628
  155. package/plugins/core/rest-api-query-projections-plugin.js +19 -102
  156. package/plugins/core/rest-api-row-policy-plugin.js +3 -3
  157. package/plugins/core/socketio-plugin.js +364 -344
  158. package/plugins/storage/local-storage.js +40 -36
  159. package/types/anyapi.d.ts +30 -0
  160. package/types/autofilter.d.ts +57 -0
  161. package/types/bulk-methods.d.ts +63 -0
  162. package/types/errors.d.ts +118 -0
  163. package/types/fastify-options.d.ts +19 -0
  164. package/types/file-detectors.d.ts +33 -0
  165. package/types/file-storage.d.ts +48 -0
  166. package/types/hook-context.d.ts +180 -0
  167. package/types/plugin-options.d.ts +65 -0
  168. package/types/relationship-methods.d.ts +74 -0
  169. package/types/representations.d.ts +50 -0
  170. package/types/resource-methods.d.ts +95 -0
  171. package/types/resource-schema.d.ts +157 -0
  172. package/types/row-policy.d.ts +31 -0
  173. package/types/runtime.d.ts +132 -0
  174. package/types/transactions.d.ts +21 -0
  175. package/.claude/agents/library-guide-expert.md +0 -30
  176. package/.claude/agents/rest-api-internals-expert.md +0 -54
  177. package/.claude/settings.local.json +0 -70
  178. package/AGENTS.md +0 -34
  179. package/CLAUDE.md +0 -160
  180. package/CRUSH.md +0 -55
  181. package/JSKIT_BACKEND_MIGRATION_TRACKER.txt +0 -180
  182. package/SINGLE_VALIDATION_CONTRACT_TODO.txt +0 -172
  183. package/TODO.todo +0 -13
  184. package/connectors_ideas/fastify.js +0 -217
  185. package/connectors_ideas/koa-plugin.js +0 -112
  186. package/docs/.bundle/config +0 -2
  187. package/docs/COMPARISON.md +0 -433
  188. package/docs/GUIDE/GUIDE_1_Initial_Setup.md +0 -1057
  189. package/docs/GUIDE/GUIDE_2_1_The_Starting_Point.md +0 -88
  190. package/docs/GUIDE/GUIDE_2_2_Manipulating_And_Searching_Tables.md +0 -808
  191. package/docs/GUIDE/GUIDE_2_3_BelongsTo_Relationships.md +0 -491
  192. package/docs/GUIDE/GUIDE_2_4_HasMany_Records.md +0 -398
  193. package/docs/GUIDE/GUIDE_2_5_HasMany_Polymorphic.md +0 -898
  194. package/docs/GUIDE/GUIDE_2_6_Many_To_Many.md +0 -712
  195. package/docs/GUIDE/GUIDE_2_7_Pagination_And_Ordering.md +0 -1247
  196. package/docs/GUIDE/GUIDE_2_8_Effects_of_PUT_and_PATCH.md +0 -748
  197. package/docs/GUIDE/GUIDE_2_9_Relationships_Urls.md +0 -517
  198. package/docs/GUIDE/GUIDE_2_Data_And_Relations.md +0 -66
  199. package/docs/GUIDE/GUIDE_3_Field_Transformations.md +0 -1252
  200. package/docs/GUIDE/GUIDE_5_Non-Db_Resources.md +0 -1107
  201. package/docs/GUIDE/GUIDE_6_Positioning.md +0 -692
  202. package/docs/GUIDE/GUIDE_7_Hooks_Data_Management_And_Plugins.md +0 -1491
  203. package/docs/GUIDE/GUIDE_X_Bulk_Operations.md +0 -732
  204. package/docs/GUIDE/GUIDE_X_Cors.md +0 -1957
  205. package/docs/GUIDE/GUIDE_X_Fastify.md +0 -78
  206. package/docs/GUIDE/GUIDE_X_File_Uploads.md +0 -729
  207. package/docs/GUIDE/GUIDE_X_Knex_Schema_And_Migrations.md +0 -370
  208. package/docs/GUIDE/GUIDE_X_Query_Projections.md +0 -159
  209. package/docs/GUIDE/GUIDE_X_SocketIO.md +0 -1040
  210. package/docs/GUIDE/GUIDE_X_Writing_Plugins.md +0 -201
  211. package/docs/Gemfile +0 -6
  212. package/docs/Gemfile.lock +0 -308
  213. package/docs/ONBOARDING.md +0 -315
  214. package/docs/_config.yml +0 -36
  215. package/docs/_layouts/default.html +0 -123
  216. package/docs/apple-touch-icon.svg +0 -4
  217. package/docs/assets/css/style.scss +0 -392
  218. package/docs/favicon.svg +0 -4
  219. package/docs/index.md +0 -164
  220. package/docs/mini-guides/file-uploads-complete.md +0 -161
  221. package/eslint.config.js +0 -13
  222. package/examples/url-override-example.js +0 -137
  223. package/fixing_plan.md +0 -112
  224. package/plugins/core/lib/anyapi/query/anyapi-query-adapter.js +0 -657
  225. package/plugins/core/lib/querying-writing/return-record-settings.js +0 -47
  226. package/plugins/core/lib/writing/knex-json-api-transformers-writing.js +0 -110
  227. package/plugins/storage/s3-storage.js +0 -93
  228. package/quickTest.js +0 -136
  229. package/scripts/debug-anyapi-review-filter.mjs +0 -63
  230. package/scripts/inspect-anyapi-descriptor-country.mjs +0 -19
  231. package/scripts/inspect-anyapi-descriptor.mjs +0 -19
  232. package/scripts/run-docs.js +0 -133
  233. package/test-debug.js +0 -59
  234. package/tests/README.md +0 -202
  235. package/tests/TEST_TEMPLATE.test.js +0 -178
  236. package/tests/anyapi-basic.test.js +0 -105
  237. package/tests/anyapi-cursor-pagination.test.js +0 -148
  238. package/tests/anyapi-custom-idproperty.test.js +0 -163
  239. package/tests/autofilter.test.js +0 -463
  240. package/tests/bulk-operations.test.js +0 -657
  241. package/tests/computed-fields.test.js +0 -586
  242. package/tests/cors.test.js +0 -834
  243. package/tests/curl.test.js +0 -467
  244. package/tests/custom-id-mysql-returning-fallback.test.js +0 -128
  245. package/tests/custom-id-simplified-post.test.js +0 -75
  246. package/tests/custom-idproperty-relationships.test.js +0 -932
  247. package/tests/db-introspection.test.js +0 -521
  248. package/tests/db-table-operations.test.js +0 -798
  249. package/tests/fastify-plugin.test.js +0 -184
  250. package/tests/field-getters.test.js +0 -370
  251. package/tests/field-setters.test.js +0 -306
  252. package/tests/file-handling.test.js +0 -155
  253. package/tests/fixtures/api-configs.js +0 -2566
  254. package/tests/full-jsonapi-belongsto-linkage.test.js +0 -150
  255. package/tests/helpers/fake-fastify.js +0 -99
  256. package/tests/helpers/storage-mode.js +0 -65
  257. package/tests/helpers/test-utils.js +0 -203
  258. package/tests/http-connectors-parity.test.js +0 -395
  259. package/tests/id-normalization.test.js +0 -444
  260. package/tests/include-depth-validation.test.js +0 -331
  261. package/tests/includes.test.js +0 -427
  262. package/tests/local-storage.test.js +0 -96
  263. package/tests/logical-id-write-validation.test.js +0 -151
  264. package/tests/nested-includes.test.js +0 -617
  265. package/tests/pagination-boundaries.test.js +0 -154
  266. package/tests/pagination-contract.test.js +0 -122
  267. package/tests/pagination-cursor-multifield.test.js +0 -641
  268. package/tests/pagination-enhanced.test.js +0 -563
  269. package/tests/polymorphic-relationships.test.js +0 -347
  270. package/tests/polymorphic-simple.test.js +0 -148
  271. package/tests/positioning-advanced.test.js +0 -692
  272. package/tests/positioning-extended.test.js +0 -915
  273. package/tests/positioning-multifilter.test.js +0 -699
  274. package/tests/positioning.test.js +0 -560
  275. package/tests/post-commit-hooks.test.js +0 -120
  276. package/tests/projected-fields.test.js +0 -319
  277. package/tests/public-exports.test.js +0 -15
  278. package/tests/put-create-parity.test.js +0 -216
  279. package/tests/queries.test.js +0 -521
  280. package/tests/query-limits.test.js +0 -584
  281. package/tests/relationship-endpoints.test.js +0 -620
  282. package/tests/relationship-include-storage-adapter.test.js +0 -56
  283. package/tests/relationships.test.js +0 -681
  284. package/tests/rest-api.test.js +0 -337
  285. package/tests/return-record-settings.test.js +0 -184
  286. package/tests/row-policy.test.js +0 -489
  287. package/tests/s3-storage.test.js +0 -38
  288. package/tests/searchschema-knex-behavior.test.js +0 -187
  289. package/tests/searchschema-merge.test.js +0 -151
  290. package/tests/socketio.test.js +0 -860
  291. package/tests/storage-mapping.test.js +0 -362
  292. package/tests/temporal-boundaries.test.js +0 -208
  293. package/tests/test-development-guide.md +0 -370
  294. package/tests/virtual-fields.test.js +0 -404
@@ -0,0 +1,172 @@
1
+ export class Hooks {
2
+ #events = new Map()
3
+
4
+ add (event, name, options, handler, resource) {
5
+ if (typeof handler !== 'function') throw new TypeError(`Hook '${name}' needs a function`)
6
+ const { beforeFunction, afterFunction, ...unsupported } = options
7
+ if (Object.keys(unsupported).length || (beforeFunction && afterFunction)) {
8
+ throw new TypeError(`Hook '${name}' requires at most one beforeFunction or afterFunction`)
9
+ }
10
+ const handlers = this.#events.get(event) || []
11
+ const anchor = beforeFunction || afterFunction
12
+ let index = handlers.length
13
+ if (anchor) {
14
+ index = handlers.findIndex(entry => entry.name === anchor)
15
+ if (index < 0) throw new Error(`Hook '${event}' has no handler '${anchor}'`)
16
+ if (afterFunction) index++
17
+ }
18
+ handlers.splice(index, 0, { name, handler, resource })
19
+ this.#events.set(event, handlers)
20
+ }
21
+
22
+ async run (event, args) {
23
+ for (const entry of [...(this.#events.get(event) || [])]) {
24
+ if (entry.resource && entry.resource !== args.scope) continue
25
+ if (await entry.handler(args) === false) return false
26
+ }
27
+ return true
28
+ }
29
+ }
30
+
31
+ function checkName (name) {
32
+ if (typeof name !== 'string' || !/^[A-Za-z_$][\w$]*$/.test(name) ||
33
+ ['__proto__', 'prototype', 'constructor', 'then'].includes(name)) {
34
+ throw new TypeError(`Invalid name '${name}'`)
35
+ }
36
+ }
37
+
38
+ function checkResourceMethodName (name) {
39
+ checkName(name)
40
+ if (['name', 'vars', 'helpers', 'scopeOptions'].includes(name)) {
41
+ throw new Error(`Resource member '${name}' is reserved`)
42
+ }
43
+ }
44
+
45
+ function assignValues (target, values = {}) {
46
+ for (const [name, value] of Object.entries(values)) {
47
+ checkName(name)
48
+ target[name] = value
49
+ }
50
+ }
51
+
52
+ export class JsonRestApi {
53
+ #hooks = new Hooks()
54
+ #plugins = new Set()
55
+ #resourceMethods = Object.create(null)
56
+
57
+ constructor ({ name, logger = {}, ...options } = {}) {
58
+ if ('log' in options || 'logging' in options) throw new TypeError('Pass logger directly instead of log or logging options')
59
+ this.name = name
60
+ this.log = Object.fromEntries(['trace', 'debug', 'info', 'warn', 'error', 'fatal'].map(level => [
61
+ level, (...args) => logger[level]?.(...args)
62
+ ]))
63
+ this.options = Object.freeze(options)
64
+ this.vars = Object.create(null)
65
+ this.helpers = Object.create(null)
66
+ this.resources = Object.create(null)
67
+ }
68
+
69
+ // Existing operation handlers receive the same explicit argument object.
70
+ #arguments (resource, params = {}, context = {}) {
71
+ return {
72
+ api: this,
73
+ name: this.name,
74
+ apiOptions: this.options,
75
+ params,
76
+ context,
77
+ scope: resource,
78
+ scopeName: resource?.name,
79
+ scopeOptions: resource?.scopeOptions,
80
+ scopes: this.resources,
81
+ vars: resource?.vars || this.vars,
82
+ helpers: resource?.helpers || this.helpers,
83
+ log: this.log,
84
+ runHooks: (event, nextContext = context) => this.#hooks.run(event, this.#arguments(resource, {}, nextContext))
85
+ }
86
+ }
87
+
88
+ #method (handler, resource) {
89
+ if (typeof handler !== 'function') throw new TypeError('Method needs a function')
90
+ return async (params = {}, context = {}) => handler(this.#arguments(resource, params, context))
91
+ }
92
+
93
+ #addApiMethod (name, handler) {
94
+ checkName(name)
95
+ if (name in this) throw new Error(`API member '${name}' already exists`)
96
+ this[name] = this.#method(handler)
97
+ }
98
+
99
+ #addResourceMethod (name, handler) {
100
+ checkResourceMethodName(name)
101
+ if (typeof handler !== 'function') throw new TypeError('Method needs a function')
102
+ const api = this
103
+ this.#resourceMethods[name] = async function (params = {}, context = {}) {
104
+ return handler(api.#arguments(this, params, context))
105
+ }
106
+ }
107
+
108
+ #addHooks (hooks = {}, resource) {
109
+ for (const [event, definition] of Object.entries(hooks)) {
110
+ const { handler, functionName = event, ...options } = typeof definition === 'function'
111
+ ? { handler: definition }
112
+ : definition
113
+ this.#hooks.add(event, functionName, options, handler, resource)
114
+ }
115
+ }
116
+
117
+ async use (plugin, pluginOptions = {}) {
118
+ if (!plugin?.name || typeof plugin.install !== 'function') throw new TypeError('Invalid plugin')
119
+ if (this.#plugins.has(plugin.name)) throw new Error(`Plugin '${plugin.name}' already installed`)
120
+ for (const dependency of plugin.dependencies || []) {
121
+ const alternatives = Array.isArray(dependency) ? dependency : [dependency]
122
+ if (!alternatives.some(name => this.#plugins.has(name))) {
123
+ throw new Error(`Plugin '${plugin.name}' requires ${alternatives.join(' or ')}`)
124
+ }
125
+ }
126
+ await plugin.install({
127
+ ...this.#arguments(),
128
+ pluginOptions,
129
+ addApiMethod: (name, handler) => this.#addApiMethod(name, handler),
130
+ addResourceMethod: (name, handler) => this.#addResourceMethod(name, handler),
131
+ addHook: (event, name, options, handler) => this.#hooks.add(event, name, options, handler)
132
+ })
133
+ this.#plugins.add(plugin.name)
134
+ return this
135
+ }
136
+
137
+ async addResource (name, { hooks, methods = {}, vars, helpers, ...scopeOptions } = {}) {
138
+ if ('scopeMethods' in scopeOptions) throw new TypeError('Use methods instead of scopeMethods')
139
+ checkName(name)
140
+ if (Object.hasOwn(this.resources, name)) throw new Error(`Resource '${name}' already exists`)
141
+ const resource = Object.assign(Object.create(this.#resourceMethods), {
142
+ name,
143
+ scopeOptions: Object.freeze(scopeOptions),
144
+ // One ordinary prototype link supplies live API defaults; writes stay local.
145
+ vars: Object.create(this.vars),
146
+ helpers: Object.create(this.helpers)
147
+ })
148
+ assignValues(resource.vars, vars)
149
+ assignValues(resource.helpers, helpers)
150
+ for (const [method, handler] of Object.entries(methods)) {
151
+ checkResourceMethodName(method)
152
+ resource[method] = this.#method(handler, resource)
153
+ }
154
+ this.resources[name] = resource
155
+ await this.runHooks('resource:added', { scopeName: name, scopeOptions, vars: resource.vars, helpers: resource.helpers })
156
+ this.#addHooks(hooks, resource)
157
+ return resource
158
+ }
159
+
160
+ async customize ({ hooks, methods = {}, vars, helpers, ...unsupported } = {}) {
161
+ if (Object.keys(unsupported).length) throw new TypeError(`Unsupported customization: ${Object.keys(unsupported).join(', ')}`)
162
+ assignValues(this.vars, vars)
163
+ assignValues(this.helpers, helpers)
164
+ for (const [name, handler] of Object.entries(methods)) this.#addResourceMethod(name, handler)
165
+ this.#addHooks(hooks)
166
+ return this
167
+ }
168
+
169
+ async runHooks (event, context = {}) {
170
+ return this.#hooks.run(event, this.#arguments(undefined, {}, context))
171
+ }
172
+ }
@@ -0,0 +1,59 @@
1
+ import type { Knex } from 'knex'
2
+ import type { StorageRow } from '../plugins/core/lib/storage/storage-types.js'
3
+ import type { TransactionOutcome } from '../types/errors.js'
4
+
5
+ export type { TransactionOutcome } from '../types/errors.js'
6
+ export type OwnedTransaction = Knex.Transaction<StorageRow, StorageRow[]>
7
+
8
+ export interface CleanupDiagnostic {
9
+ phase: string
10
+ error: unknown
11
+ operationIndex?: number
12
+ finalizerIndex?: number
13
+ scopeName?: string
14
+ method?: string
15
+ }
16
+
17
+ // Only the context fields used by transaction orchestration; resource stages extend it.
18
+ export interface TransactionContext {
19
+ transaction?: OwnedTransaction
20
+ transactionOutcome?: TransactionOutcome
21
+ transactionCommitted?: boolean
22
+ shouldCommit?: boolean
23
+ error?: unknown
24
+ cleanupErrors?: CleanupDiagnostic[]
25
+ scopeName?: string
26
+ method?: string
27
+ }
28
+
29
+ export type CompletionHook = (name: 'afterCommit' | 'afterRollback') => unknown | Promise<unknown>
30
+ export type TransactionFactory = (context: TransactionContext) => Promise<OwnedTransaction>
31
+ export type TransactionCallback<T> = ((transaction: OwnedTransaction) => T | Promise<T>) & {
32
+ transaction?: OwnedTransaction
33
+ }
34
+ export interface WriteRequest {
35
+ context: TransactionContext
36
+ params?: { transaction?: OwnedTransaction } | TransactionCallback<unknown>
37
+ }
38
+
39
+ export interface TransactionState {
40
+ transaction: OwnedTransaction
41
+ owner: TransactionContext
42
+ phase: 'pending' | 'completing' | 'finishing' | 'finished'
43
+ failed: boolean
44
+ error?: unknown
45
+ participants: Array<{
46
+ context: TransactionContext
47
+ runHooks: CompletionHook
48
+ operationIndex: number
49
+ failed?: boolean
50
+ }>
51
+ contexts: Set<TransactionContext>
52
+ finalizers: Array<() => unknown | Promise<unknown>>
53
+ inFlight: Map<TransactionContext, {
54
+ promise: Promise<void>
55
+ resolve: () => void
56
+ reject: (reason?: unknown) => void
57
+ }>
58
+ onQueryError?: (error: unknown) => void
59
+ }
package/package.json CHANGED
@@ -1,47 +1,114 @@
1
1
  {
2
2
  "name": "json-rest-api",
3
- "version": "1.0.29",
3
+ "version": "2.1.0",
4
4
  "main": "index.js",
5
+ "types": "index.d.ts",
5
6
  "type": "module",
7
+ "files": [
8
+ "index.js",
9
+ "index.d.ts",
10
+ "lib/**/*.js",
11
+ "lib/**/*.d.ts",
12
+ "plugins/**/*.js",
13
+ "plugins/**/*.d.ts",
14
+ "types/**/*.d.ts",
15
+ "LICENSE",
16
+ "LICENSE-MIT",
17
+ "LICENSE-GPL-3.0",
18
+ "README.md",
19
+ "docs/API.md",
20
+ "docs/QUICKSTART.md",
21
+ "docs/GUIDE/**/*.md",
22
+ "docs/architecture.md",
23
+ "docs/contributing.md"
24
+ ],
6
25
  "scripts": {
7
26
  "test": "node --test tests/*.test.js",
27
+ "test:public-types": "node scripts/check-public-types.js",
28
+ "test:clean-package": "node scripts/check-clean-package.js",
29
+ "test:api-reference": "node scripts/check-api-reference.js",
30
+ "test:quickstart": "node scripts/check-quickstart.js",
31
+ "test:setup-guide": "node scripts/check-setup-guide.js",
32
+ "test:relationship-guides": "node scripts/check-relationship-guides.js",
33
+ "test:tutorial-guides": "node scripts/check-tutorial-guides.js",
34
+ "test:tutorial-guides:databases": "node scripts/test-databases.js all scripts/check-tutorial-guides.js",
35
+ "test:server-examples": "node scripts/check-server-examples.js",
36
+ "test:migration-guide": "node scripts/check-migration-guide.js",
37
+ "test:migration-guide:package": "node scripts/check-packaged-migration-guide.js",
38
+ "test:migration-guide:databases": "node scripts/test-databases.js all scripts/check-migration-guide.js",
39
+ "test:socket-guide": "node scripts/check-socket-guide.js && node --import ./tests/helpers/select-express4.js scripts/check-socket-guide.js",
40
+ "test:file-guide": "node scripts/check-file-guide.js && node --import ./tests/helpers/select-express4.js scripts/check-file-guide.js",
8
41
  "test:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/*.test.js",
9
- "test:id-contracts": "node --test tests/id-normalization.test.js tests/logical-id-write-validation.test.js tests/custom-id-simplified-post.test.js",
10
- "test:id-contracts:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/id-normalization.test.js",
42
+ "test:conformance": "npm run test:conformance:knex && npm run test:conformance:anyapi",
43
+ "test:conformance:knex": "JSON_REST_API_STORAGE=knex node --test tests/conformance-*.test.js",
44
+ "test:conformance:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/conformance-*.test.js",
45
+ "test:consumer": "node scripts/check-consumer-package.js",
46
+ "test:multipart": "npm run test:multipart:knex && npm run test:multipart:anyapi",
47
+ "test:multipart:knex": "JSON_REST_API_STORAGE=knex node --test tests/multipart-detectors.test.js tests/multipart-uploads.test.js tests/file-handling.test.js",
48
+ "test:multipart:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/multipart-detectors.test.js tests/multipart-uploads.test.js tests/file-handling.test.js",
49
+ "test:connectors": "npm run test:connectors:knex && npm run test:connectors:anyapi && npm run test:connectors:express4",
50
+ "test:connectors:knex": "JSON_REST_API_STORAGE=knex node --test tests/http-connectors-parity.test.js tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/fastify-plugin.test.js tests/connectors-query-parser.test.js tests/multipart-detectors.test.js tests/multipart-uploads.test.js tests/file-handling.test.js tests/cors.test.js tests/cors-transport.test.js tests/socketio.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js tests/anyapi-descriptor-failures.test.js tests/conformance-field-callback-failures.test.js tests/conformance-relationship-metadata.test.js tests/conformance-schema-enrichment.test.js tests/http-connector-diagnostics.test.js tests/conformance-http-validators.test.js tests/http-validator-client-example.test.js tests/http-validators.test.js tests/http-response-replacement.test.js tests/conformance-versioned-bulk.test.js tests/conformance-route-transactions.test.js",
51
+ "test:connectors:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/http-connectors-parity.test.js tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/fastify-plugin.test.js tests/connectors-query-parser.test.js tests/multipart-detectors.test.js tests/multipart-uploads.test.js tests/file-handling.test.js tests/cors.test.js tests/cors-transport.test.js tests/socketio.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js tests/anyapi-descriptor-failures.test.js tests/conformance-field-callback-failures.test.js tests/conformance-relationship-metadata.test.js tests/conformance-schema-enrichment.test.js tests/http-connector-diagnostics.test.js tests/conformance-http-validators.test.js tests/http-validator-client-example.test.js tests/http-validators.test.js tests/http-response-replacement.test.js tests/conformance-versioned-bulk.test.js tests/conformance-route-transactions.test.js",
52
+ "test:connectors:express4": "npm run test:connectors:express4:knex && npm run test:connectors:express4:anyapi",
53
+ "test:connectors:express4:knex": "JSON_REST_API_STORAGE=knex node --import ./tests/helpers/select-express4.js --test --test-name-pattern 'HTTP serialized validators express|Conditional HTTP client example express|HTTP bulk version conditions express|HTTP diagnostic route metadata express|Real express|Real Socket.IO|Bulk HTTP authorization through express|Related HTTP authorization through express|Include HTTP authorization through express|Search HTTP authorization through express|Reference sort HTTP authorization through express|Include limit HTTP through express|Schema enrichment HTTP express' tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/http-connectors-parity.test.js tests/multipart-uploads.test.js tests/cors-transport.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js tests/anyapi-descriptor-failures.test.js tests/conformance-field-callback-failures.test.js tests/conformance-relationship-metadata.test.js tests/conformance-schema-enrichment.test.js tests/http-connector-diagnostics.test.js tests/conformance-versioned-bulk.test.js tests/conformance-http-validators.test.js tests/http-validator-client-example.test.js",
54
+ "test:connectors:express4:anyapi": "JSON_REST_API_STORAGE=anyapi node --import ./tests/helpers/select-express4.js --test --test-name-pattern 'HTTP serialized validators express|Conditional HTTP client example express|HTTP bulk version conditions express|HTTP diagnostic route metadata express|Real express|Real Socket.IO|Bulk HTTP authorization through express|Related HTTP authorization through express|Include HTTP authorization through express|Search HTTP authorization through express|Reference sort HTTP authorization through express|Include limit HTTP through express|Schema enrichment HTTP express' tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/http-connectors-parity.test.js tests/multipart-uploads.test.js tests/cors-transport.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js tests/anyapi-descriptor-failures.test.js tests/conformance-field-callback-failures.test.js tests/conformance-relationship-metadata.test.js tests/conformance-schema-enrichment.test.js tests/http-connector-diagnostics.test.js tests/conformance-versioned-bulk.test.js tests/conformance-http-validators.test.js tests/http-validator-client-example.test.js",
55
+ "test:id-contracts": "npm run test:id-contracts:knex && npm run test:id-contracts:anyapi",
56
+ "test:id-contracts:knex": "JSON_REST_API_STORAGE=knex node --test tests/conformance-ids.test.js tests/id-normalization.test.js tests/logical-id-write-validation.test.js tests/custom-id-simplified-post.test.js tests/custom-idproperty-relationships.test.js",
57
+ "test:id-contracts:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/conformance-ids.test.js tests/id-normalization.test.js tests/custom-idproperty-relationships.test.js tests/anyapi-custom-idproperty.test.js",
58
+ "test:temporal": "npm run test:temporal:knex && npm run test:temporal:anyapi",
59
+ "test:temporal:knex": "JSON_REST_API_STORAGE=knex node --test tests/conformance-temporal.test.js tests/temporal-boundaries.test.js tests/storage-mapping.test.js tests/field-getters.test.js tests/field-setters.test.js tests/computed-fields.test.js",
60
+ "test:temporal:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/conformance-temporal.test.js tests/temporal-boundaries.test.js tests/field-getters.test.js tests/field-setters.test.js tests/computed-fields.test.js",
11
61
  "docs": "node scripts/run-docs.js",
12
62
  "docs:dev": "node scripts/run-docs.js --serve",
13
- "verify": "npm run test:id-contracts && npm run test:id-contracts:anyapi && npm run docs",
14
- "sloc": "sloc --exclude \"(_site|node_modules|\\.git|vendor|docs)\" .",
15
- "slod": "cd docs;echo 'DOC LINES:'; cat `find . -iname \\*md | grep -v _site | grep -v vendor` | wc",
63
+ "verify": "npm run typecheck && npm run test:public-types && npm run test:query-budgets && npm test && npm run test:anyapi && npm run test:connectors:express4 && npm run lint && npm run docs",
16
64
  "lint": "eslint .",
17
- "lint:fix": "eslint . --fix"
65
+ "lint:fix": "eslint . --fix",
66
+ "test:socketio": "npm run test:socketio:knex && npm run test:socketio:anyapi",
67
+ "test:socketio:knex": "JSON_REST_API_STORAGE=knex node --test tests/socketio.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js",
68
+ "test:socketio:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/socketio.test.js tests/socketio-contract.test.js tests/conformance-socketio-authorization.test.js",
69
+ "test:queries": "npm run test:queries:knex && npm run test:queries:anyapi",
70
+ "test:query-budgets": "npm run test:query-budgets:knex && npm run test:query-budgets:anyapi",
71
+ "test:query-budgets:knex": "JSON_REST_API_STORAGE=knex node scripts/measure-query-baseline.js",
72
+ "test:query-budgets:anyapi": "JSON_REST_API_STORAGE=anyapi node scripts/measure-query-baseline.js",
73
+ "test:stress": "npm run test:stress:knex && npm run test:stress:anyapi",
74
+ "test:stress:knex": "JSON_REST_API_STORAGE=knex node --expose-gc scripts/stress-resources.js",
75
+ "test:stress:anyapi": "JSON_REST_API_STORAGE=anyapi node --expose-gc scripts/stress-resources.js",
76
+ "test:queries:knex": "JSON_REST_API_STORAGE=knex node --test tests/conformance-queries.test.js tests/conformance-related.test.js tests/queries.test.js tests/projected-fields.test.js tests/nested-includes.test.js tests/include-traversal.test.js tests/searchschema-merge.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js",
77
+ "test:queries:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/conformance-queries.test.js tests/conformance-related.test.js tests/queries.test.js tests/projected-fields.test.js tests/nested-includes.test.js tests/include-traversal.test.js tests/searchschema-merge.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js",
78
+ "test:authorization": "npm run test:authorization:knex && npm run test:authorization:anyapi",
79
+ "test:authorization:knex": "JSON_REST_API_STORAGE=knex node --test tests/conformance-authorization.test.js tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/conformance-transaction-context.test.js tests/bulk-operations.test.js tests/row-policy.test.js tests/autofilter.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js",
80
+ "test:authorization:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/conformance-authorization.test.js tests/conformance-bulk-authorization.test.js tests/conformance-related-permissions.test.js tests/conformance-transaction-context.test.js tests/bulk-operations.test.js tests/row-policy.test.js tests/autofilter.test.js tests/conformance-socketio-authorization.test.js tests/conformance-include-permissions.test.js tests/conformance-search-authorization.test.js tests/conformance-reference-sorting.test.js tests/conformance-include-limits.test.js",
81
+ "test:redis": "node scripts/test-databases.js redis",
82
+ "test:databases": "node scripts/test-databases.js",
83
+ "test:databases:sqlite": "node scripts/test-databases.js better-sqlite3",
84
+ "test:databases:pg": "node scripts/test-databases.js pg",
85
+ "test:databases:mysql": "node scripts/test-databases.js mysql2",
86
+ "typecheck": "tsc --project tsconfig.json"
18
87
  },
19
88
  "repository": {
20
89
  "type": "git",
21
- "url": "git+https://github.com/mobily-enterprises/jsonrestapi.git"
90
+ "url": "git+https://github.com/mobily-enterprises/json-rest-api.git"
22
91
  },
23
92
  "author": "Tony Mobily",
24
- "license": "GPL-3.0-or-later",
93
+ "license": "(GPL-3.0-or-later OR MIT)",
25
94
  "bugs": {
26
- "url": "https://github.com/mobily-enterprises/jsonrestapi/issues"
95
+ "url": "https://github.com/mobily-enterprises/json-rest-api/issues"
27
96
  },
28
97
  "homepage": "https://mobily-enterprises.github.io/json-rest-api",
29
- "description": "REST API plugin for hooked-api with JSON:API compliance",
98
+ "description": "JSON:API mini-ORM with resource hooks and pluggable storage",
30
99
  "dependencies": {
31
- "hooked-api": "^1.0.24",
100
+ "content-type": "^1.0.5",
32
101
  "json-rest-schema": "^1.0.17",
33
- "semver": "^7.7.2"
102
+ "on-headers": "^1.1.0",
103
+ "vary": "^1.1.2"
34
104
  },
35
105
  "peerDependencies": {
36
106
  "@socket.io/redis-adapter": "^8.3.0",
37
107
  "busboy": "^1.0.0",
38
- "content-type": "^1.0.0",
39
108
  "express": "^4.0.0 || ^5.0.0",
40
109
  "formidable": "^3.0.0",
41
110
  "fractional-indexing": "^3.2.0",
42
- "jose": "^5.10.0 || ^6.0.0",
43
111
  "knex": "^3.1.0",
44
- "raw-body": "^2.0.0",
45
112
  "redis": "^5.6.0",
46
113
  "socket.io": "^4.8.1"
47
114
  },
@@ -52,9 +119,6 @@
52
119
  "busboy": {
53
120
  "optional": true
54
121
  },
55
- "content-type": {
56
- "optional": true
57
- },
58
122
  "express": {
59
123
  "optional": true
60
124
  },
@@ -64,15 +128,9 @@
64
128
  "fractional-indexing": {
65
129
  "optional": true
66
130
  },
67
- "jose": {
68
- "optional": true
69
- },
70
131
  "knex": {
71
132
  "optional": true
72
133
  },
73
- "raw-body": {
74
- "optional": true
75
- },
76
134
  "redis": {
77
135
  "optional": true
78
136
  },
@@ -82,16 +140,28 @@
82
140
  },
83
141
  "devDependencies": {
84
142
  "@socket.io/redis-adapter": "^8.3.0",
143
+ "@types/node": "24.0.14",
85
144
  "better-sqlite3": "^11.10.0",
145
+ "busboy": "^1.6.0",
146
+ "eslint": "^9.37.0",
86
147
  "express": "^5.1.0",
148
+ "express4": "npm:express@^4.22.2",
149
+ "fast-check": "^4.9.0",
150
+ "fastify": "^5.12.3",
151
+ "formidable": "^3.5.4",
87
152
  "fractional-indexing": "^3.2.0",
88
153
  "jose": "^6.2.2",
89
154
  "knex": "^3.1.0",
155
+ "mysql2": "^3.24.4",
156
+ "neostandard": "^0.12.2",
157
+ "pg": "^8.23.0",
90
158
  "redis": "^5.6.0",
91
159
  "socket.io": "^4.8.1",
92
160
  "socket.io-client": "^4.8.1",
93
161
  "supertest": "^7.1.3",
94
- "eslint": "^9.37.0",
95
- "neostandard": "^0.12.2"
162
+ "typescript": "5.9.3"
163
+ },
164
+ "engines": {
165
+ "node": ">=24.0.0"
96
166
  }
97
167
  }