json-rest-api 1.0.28 → 2.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 (289) 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 +746 -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 +634 -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 +100 -0
  36. package/docs/GUIDE/31-positioning.md +181 -0
  37. package/docs/GUIDE/{GUIDE_Y_Appendices.md → 32-date-and-time.md} +90 -31
  38. package/docs/GUIDE/33-migrating-to-v2.md +3827 -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 +36 -0
  44. package/index.js +1 -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 +64 -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 -174
  67. package/plugins/core/lib/anyapi/anyapi-registry.js +213 -164
  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 +25 -16
  71. package/plugins/core/lib/anyapi/utils/descriptor-helpers.js +0 -64
  72. package/plugins/core/lib/dbIntrospection.js +228 -21
  73. package/plugins/core/lib/dbTablesOperations.js +409 -92
  74. package/plugins/core/lib/fractional-positioning.js +12 -48
  75. package/plugins/core/lib/querying/identifier-query.js +19 -0
  76. package/plugins/core/lib/querying/include-query-helpers.js +364 -0
  77. package/plugins/core/lib/querying/include-to-many.js +428 -0
  78. package/plugins/core/lib/querying/include-to-one.js +579 -0
  79. package/plugins/core/lib/querying/knex-cross-table-search.js +31 -307
  80. package/plugins/core/lib/querying/knex-json-api-transformers-querying.js +99 -401
  81. package/plugins/core/lib/querying/knex-pagination-helpers.js +67 -330
  82. package/plugins/core/lib/querying/knex-process-includes.js +5 -110
  83. package/plugins/core/lib/querying/knex-query-helpers-base.js +21 -56
  84. package/plugins/core/lib/querying/knex-query-helpers.js +298 -448
  85. package/plugins/core/lib/querying/knex-relationship-includes.js +120 -2138
  86. package/plugins/core/lib/querying/knex-window-queries.js +62 -253
  87. package/plugins/core/lib/querying/query-builder-utils.js +44 -4
  88. package/plugins/core/lib/querying/query-constraint.d.ts +12 -0
  89. package/plugins/core/lib/querying/query-constraint.js +27 -0
  90. package/plugins/core/lib/querying/query-field-sort-helpers.js +205 -30
  91. package/plugins/core/lib/querying/relationship-identifiers.js +208 -0
  92. package/plugins/core/lib/querying/sort-helpers.js +20 -1
  93. package/plugins/core/lib/querying/storage-adapter-utils.js +13 -5
  94. package/plugins/core/lib/querying/url-helpers.js +11 -4
  95. package/plugins/core/lib/querying-writing/compile-schemas.js +148 -249
  96. package/plugins/core/lib/querying-writing/connectors-query-parser.js +33 -118
  97. package/plugins/core/lib/querying-writing/database-capabilities.js +149 -223
  98. package/plugins/core/lib/querying-writing/database-value-normalizers.js +238 -187
  99. package/plugins/core/lib/querying-writing/default-data-helpers.js +15 -45
  100. package/plugins/core/lib/querying-writing/field-selection-types.d.ts +43 -0
  101. package/plugins/core/lib/querying-writing/field-utils.js +113 -92
  102. package/plugins/core/lib/querying-writing/knex-constants.d.ts +18 -0
  103. package/plugins/core/lib/querying-writing/knex-constants.js +2 -26
  104. package/plugins/core/lib/querying-writing/knex-field-helpers.js +111 -287
  105. package/plugins/core/lib/querying-writing/knex-json-api-transformers.js +31 -120
  106. package/plugins/core/lib/querying-writing/query-field-helpers.js +108 -32
  107. package/plugins/core/lib/querying-writing/query-field-types.d.ts +60 -0
  108. package/plugins/core/lib/querying-writing/relationship-contracts.js +33 -13
  109. package/plugins/core/lib/querying-writing/request-contracts.js +109 -44
  110. package/plugins/core/lib/querying-writing/resource-id-normalization.js +23 -5
  111. package/plugins/core/lib/querying-writing/response-options.js +35 -0
  112. package/plugins/core/lib/querying-writing/schema-helpers.js +203 -324
  113. package/plugins/core/lib/querying-writing/scope-validations.js +92 -290
  114. package/plugins/core/lib/querying-writing/simplified-helpers.js +113 -712
  115. package/plugins/core/lib/storage/canonical-data-helpers.js +683 -0
  116. package/plugins/core/lib/storage/canonical-storage-mapping.js +51 -20
  117. package/plugins/core/lib/storage/ordinary-data-helpers.js +710 -0
  118. package/plugins/core/lib/storage/storage-adapter.js +142 -62
  119. package/plugins/core/lib/storage/storage-mapping.js +78 -28
  120. package/plugins/core/lib/storage/storage-types.d.ts +502 -0
  121. package/plugins/core/lib/writing/many-to-many-manipulations.js +114 -284
  122. package/plugins/core/lib/writing/relationship-processor.js +94 -158
  123. package/plugins/core/lib/writing/resource-version.js +172 -0
  124. package/plugins/core/lib/writing/reverse-relationship-manipulations.js +110 -0
  125. package/plugins/core/rest-api-anyapi-knex-plugin.js +116 -2509
  126. package/plugins/core/rest-api-autofilter-plugin.js +17 -19
  127. package/plugins/core/rest-api-cors-plugin.js +52 -205
  128. package/plugins/core/rest-api-knex-plugin.js +45 -1069
  129. package/plugins/core/rest-api-label-plugin.js +25 -38
  130. package/plugins/core/rest-api-plugin-hooks/register-relationship-routes.js +5 -5
  131. package/plugins/core/rest-api-plugin-hooks/register-scope-routes.js +9 -6
  132. package/plugins/core/rest-api-plugin-hooks/turn-scope-init-into-vars.js +7 -26
  133. package/plugins/core/rest-api-plugin-hooks/validate-include-configurations.js +20 -26
  134. package/plugins/core/rest-api-plugin-methods/add-route.js +4 -6
  135. package/plugins/core/rest-api-plugin-methods/apply-query-filters.js +42 -13
  136. package/plugins/core/rest-api-plugin-methods/check-permissions.js +11 -5
  137. package/plugins/core/rest-api-plugin-methods/common.js +291 -385
  138. package/plugins/core/rest-api-plugin-methods/delete-relationship.js +49 -47
  139. package/plugins/core/rest-api-plugin-methods/delete.js +31 -25
  140. package/plugins/core/rest-api-plugin-methods/enrich-attributes.js +108 -145
  141. package/plugins/core/rest-api-plugin-methods/get-related.js +113 -305
  142. package/plugins/core/rest-api-plugin-methods/get-relationship.js +25 -18
  143. package/plugins/core/rest-api-plugin-methods/get.js +38 -69
  144. package/plugins/core/rest-api-plugin-methods/lifecycle-types.d.ts +225 -0
  145. package/plugins/core/rest-api-plugin-methods/patch-relationship.js +28 -25
  146. package/plugins/core/rest-api-plugin-methods/patch.js +46 -99
  147. package/plugins/core/rest-api-plugin-methods/post-relationship.js +49 -53
  148. package/plugins/core/rest-api-plugin-methods/post.js +51 -51
  149. package/plugins/core/rest-api-plugin-methods/put.js +69 -148
  150. package/plugins/core/rest-api-plugin-methods/query.js +39 -82
  151. package/plugins/core/rest-api-plugin-methods/release.js +2 -1
  152. package/plugins/core/rest-api-plugin.js +32 -46
  153. package/plugins/core/rest-api-positioning-plugin.js +183 -628
  154. package/plugins/core/rest-api-query-projections-plugin.js +19 -102
  155. package/plugins/core/rest-api-row-policy-plugin.js +3 -3
  156. package/plugins/core/socketio-plugin.js +364 -344
  157. package/plugins/storage/local-storage.js +40 -36
  158. package/types/autofilter.d.ts +57 -0
  159. package/types/bulk-methods.d.ts +63 -0
  160. package/types/errors.d.ts +118 -0
  161. package/types/fastify-options.d.ts +19 -0
  162. package/types/file-detectors.d.ts +33 -0
  163. package/types/file-storage.d.ts +48 -0
  164. package/types/hook-context.d.ts +180 -0
  165. package/types/plugin-options.d.ts +53 -0
  166. package/types/relationship-methods.d.ts +74 -0
  167. package/types/representations.d.ts +50 -0
  168. package/types/resource-methods.d.ts +95 -0
  169. package/types/resource-schema.d.ts +157 -0
  170. package/types/row-policy.d.ts +31 -0
  171. package/types/runtime.d.ts +132 -0
  172. package/types/transactions.d.ts +21 -0
  173. package/.claude/agents/library-guide-expert.md +0 -30
  174. package/.claude/agents/rest-api-internals-expert.md +0 -54
  175. package/.claude/settings.local.json +0 -70
  176. package/AGENTS.md +0 -34
  177. package/CLAUDE.md +0 -160
  178. package/CRUSH.md +0 -55
  179. package/JSKIT_BACKEND_MIGRATION_TRACKER.txt +0 -180
  180. package/SINGLE_VALIDATION_CONTRACT_TODO.txt +0 -172
  181. package/TODO.todo +0 -13
  182. package/connectors_ideas/fastify.js +0 -217
  183. package/connectors_ideas/koa-plugin.js +0 -112
  184. package/docs/.bundle/config +0 -2
  185. package/docs/COMPARISON.md +0 -433
  186. package/docs/GUIDE/GUIDE_1_Initial_Setup.md +0 -1057
  187. package/docs/GUIDE/GUIDE_2_1_The_Starting_Point.md +0 -88
  188. package/docs/GUIDE/GUIDE_2_2_Manipulating_And_Searching_Tables.md +0 -808
  189. package/docs/GUIDE/GUIDE_2_3_BelongsTo_Relationships.md +0 -491
  190. package/docs/GUIDE/GUIDE_2_4_HasMany_Records.md +0 -398
  191. package/docs/GUIDE/GUIDE_2_5_HasMany_Polymorphic.md +0 -898
  192. package/docs/GUIDE/GUIDE_2_6_Many_To_Many.md +0 -712
  193. package/docs/GUIDE/GUIDE_2_7_Pagination_And_Ordering.md +0 -1238
  194. package/docs/GUIDE/GUIDE_2_8_Effects_of_PUT_and_PATCH.md +0 -748
  195. package/docs/GUIDE/GUIDE_2_9_Relationships_Urls.md +0 -517
  196. package/docs/GUIDE/GUIDE_2_Data_And_Relations.md +0 -66
  197. package/docs/GUIDE/GUIDE_3_Field_Transformations.md +0 -1252
  198. package/docs/GUIDE/GUIDE_5_Non-Db_Resources.md +0 -1107
  199. package/docs/GUIDE/GUIDE_6_Positioning.md +0 -692
  200. package/docs/GUIDE/GUIDE_7_Hooks_Data_Management_And_Plugins.md +0 -1491
  201. package/docs/GUIDE/GUIDE_X_Bulk_Operations.md +0 -732
  202. package/docs/GUIDE/GUIDE_X_Cors.md +0 -1957
  203. package/docs/GUIDE/GUIDE_X_Fastify.md +0 -78
  204. package/docs/GUIDE/GUIDE_X_File_Uploads.md +0 -729
  205. package/docs/GUIDE/GUIDE_X_Knex_Schema_And_Migrations.md +0 -370
  206. package/docs/GUIDE/GUIDE_X_Query_Projections.md +0 -159
  207. package/docs/GUIDE/GUIDE_X_SocketIO.md +0 -1040
  208. package/docs/GUIDE/GUIDE_X_Writing_Plugins.md +0 -201
  209. package/docs/Gemfile +0 -6
  210. package/docs/Gemfile.lock +0 -308
  211. package/docs/ONBOARDING.md +0 -315
  212. package/docs/_config.yml +0 -36
  213. package/docs/_layouts/default.html +0 -123
  214. package/docs/apple-touch-icon.svg +0 -4
  215. package/docs/assets/css/style.scss +0 -392
  216. package/docs/favicon.svg +0 -4
  217. package/docs/index.md +0 -164
  218. package/docs/mini-guides/file-uploads-complete.md +0 -161
  219. package/eslint.config.js +0 -13
  220. package/examples/url-override-example.js +0 -137
  221. package/fixing_plan.md +0 -112
  222. package/plugins/core/lib/anyapi/query/anyapi-query-adapter.js +0 -657
  223. package/plugins/core/lib/querying-writing/return-record-settings.js +0 -47
  224. package/plugins/core/lib/writing/knex-json-api-transformers-writing.js +0 -110
  225. package/plugins/storage/s3-storage.js +0 -93
  226. package/quickTest.js +0 -136
  227. package/scripts/debug-anyapi-review-filter.mjs +0 -63
  228. package/scripts/inspect-anyapi-descriptor-country.mjs +0 -19
  229. package/scripts/inspect-anyapi-descriptor.mjs +0 -19
  230. package/scripts/run-docs.js +0 -133
  231. package/test-debug.js +0 -59
  232. package/tests/README.md +0 -202
  233. package/tests/TEST_TEMPLATE.test.js +0 -178
  234. package/tests/anyapi-basic.test.js +0 -105
  235. package/tests/anyapi-cursor-pagination.test.js +0 -150
  236. package/tests/anyapi-custom-idproperty.test.js +0 -163
  237. package/tests/autofilter.test.js +0 -463
  238. package/tests/bulk-operations.test.js +0 -657
  239. package/tests/computed-fields.test.js +0 -586
  240. package/tests/cors.test.js +0 -834
  241. package/tests/curl.test.js +0 -467
  242. package/tests/custom-id-mysql-returning-fallback.test.js +0 -128
  243. package/tests/custom-id-simplified-post.test.js +0 -75
  244. package/tests/custom-idproperty-relationships.test.js +0 -932
  245. package/tests/db-introspection.test.js +0 -521
  246. package/tests/db-table-operations.test.js +0 -798
  247. package/tests/fastify-plugin.test.js +0 -184
  248. package/tests/field-getters.test.js +0 -370
  249. package/tests/field-setters.test.js +0 -306
  250. package/tests/file-handling.test.js +0 -118
  251. package/tests/fixtures/api-configs.js +0 -2509
  252. package/tests/full-jsonapi-belongsto-linkage.test.js +0 -150
  253. package/tests/helpers/fake-fastify.js +0 -99
  254. package/tests/helpers/storage-mode.js +0 -65
  255. package/tests/helpers/test-utils.js +0 -203
  256. package/tests/http-connectors-parity.test.js +0 -395
  257. package/tests/id-normalization.test.js +0 -444
  258. package/tests/include-depth-validation.test.js +0 -331
  259. package/tests/includes.test.js +0 -427
  260. package/tests/local-storage.test.js +0 -96
  261. package/tests/logical-id-write-validation.test.js +0 -151
  262. package/tests/nested-includes.test.js +0 -617
  263. package/tests/pagination-cursor-multifield.test.js +0 -643
  264. package/tests/pagination-enhanced.test.js +0 -563
  265. package/tests/polymorphic-relationships.test.js +0 -347
  266. package/tests/polymorphic-simple.test.js +0 -148
  267. package/tests/positioning-advanced.test.js +0 -692
  268. package/tests/positioning-extended.test.js +0 -915
  269. package/tests/positioning-multifilter.test.js +0 -699
  270. package/tests/positioning.test.js +0 -560
  271. package/tests/post-commit-hooks.test.js +0 -120
  272. package/tests/projected-fields.test.js +0 -319
  273. package/tests/public-exports.test.js +0 -15
  274. package/tests/put-create-parity.test.js +0 -216
  275. package/tests/queries.test.js +0 -521
  276. package/tests/query-limits.test.js +0 -584
  277. package/tests/relationship-endpoints.test.js +0 -620
  278. package/tests/relationship-include-storage-adapter.test.js +0 -56
  279. package/tests/relationships.test.js +0 -681
  280. package/tests/rest-api.test.js +0 -337
  281. package/tests/return-record-settings.test.js +0 -184
  282. package/tests/row-policy.test.js +0 -489
  283. package/tests/s3-storage.test.js +0 -38
  284. package/tests/searchschema-knex-behavior.test.js +0 -187
  285. package/tests/searchschema-merge.test.js +0 -151
  286. package/tests/socketio.test.js +0 -860
  287. package/tests/storage-mapping.test.js +0 -362
  288. package/tests/test-development-guide.md +0 -370
  289. package/tests/virtual-fields.test.js +0 -404
@@ -1,306 +0,0 @@
1
- import { describe, it, before, beforeEach, after } from 'node:test'
2
- import assert from 'node:assert/strict'
3
- import knexLib from 'knex'
4
- import { createFieldSettersApi } from './fixtures/api-configs.js'
5
- import { cleanTables } from './helpers/test-utils.js'
6
-
7
- // Create Knex instance for tests
8
- const knex = knexLib({
9
- client: 'better-sqlite3',
10
- connection: {
11
- filename: ':memory:'
12
- },
13
- useNullAsDefault: true
14
- })
15
-
16
- // API instance that persists across tests
17
- let api
18
-
19
- describe('Field Setters', () => {
20
- before(async () => {
21
- // Initialize API once
22
- api = await createFieldSettersApi(knex)
23
- })
24
-
25
- after(async () => {
26
- // Close database connection to allow tests to exit
27
- await knex.destroy()
28
- })
29
-
30
- describe('Basic Field Transformations', () => {
31
- beforeEach(async () => {
32
- await cleanTables(knex, ['setter_users'])
33
- })
34
-
35
- it('should apply simple setter transformations on create', async () => {
36
- // Create user with data that needs transformation
37
- const user = await api.resources.users.post({
38
- email: ' USER@EXAMPLE.COM ',
39
- username: ' JohnDoe ',
40
- tags: 'tag1,tag2,tag3', // Pass as string
41
- preferences: '{"theme":"dark","notifications":true}' // Pass as JSON string
42
- })
43
-
44
- // Get the user to verify setters were applied
45
- const fetchedUser = await api.resources.users.get({ id: user.id })
46
-
47
- // The setters transformed the data before storage
48
- assert.equal(fetchedUser.email, 'user@example.com')
49
- assert.equal(fetchedUser.username, 'johndoe')
50
- assert.equal(fetchedUser.tags, 'tag1,tag2,tag3')
51
- assert.equal(fetchedUser.preferences, '{"theme":"dark","notifications":true}')
52
- })
53
-
54
- it('should apply setter transformations on update (PUT)', async () => {
55
- // Create initial user
56
- const user = await api.resources.users.post({
57
- email: 'original@example.com',
58
- username: 'originaluser',
59
- tags: 'old',
60
- preferences: '{"theme":"light"}'
61
- })
62
-
63
- // Update with PUT
64
- await api.resources.users.put({
65
- id: user.id,
66
- email: ' UPDATED@EXAMPLE.COM ',
67
- username: ' UpdatedUser ',
68
- tags: 'new1,new2',
69
- preferences: '{"theme":"dark","lang":"en"}'
70
- })
71
-
72
- // Get the user to verify setters were applied
73
- const updatedUser = await api.resources.users.get({ id: user.id })
74
- assert.equal(updatedUser.email, 'updated@example.com')
75
- assert.equal(updatedUser.username, 'updateduser')
76
- assert.equal(updatedUser.tags, 'new1,new2')
77
- assert.equal(updatedUser.preferences, '{"theme":"dark","lang":"en"}')
78
- })
79
-
80
- it('should apply setter transformations on partial update (PATCH)', async () => {
81
- // Create initial user
82
- const user = await api.resources.users.post({
83
- email: 'original@example.com',
84
- username: 'originaluser',
85
- tags: 'old',
86
- preferences: '{"theme":"light"}'
87
- })
88
-
89
- // Update only email with PATCH
90
- await api.resources.users.patch({
91
- id: user.id,
92
- email: ' PATCHED@EXAMPLE.COM '
93
- })
94
-
95
- // Get the user to verify setter was applied only to patched field
96
- const patchedUser = await api.resources.users.get({ id: user.id })
97
- assert.equal(patchedUser.email, 'patched@example.com')
98
- assert.equal(patchedUser.username, 'originaluser') // Unchanged
99
- })
100
- })
101
-
102
- describe('Type Conversion Setters', () => {
103
- beforeEach(async () => {
104
- await cleanTables(knex, ['setter_products'])
105
- })
106
-
107
- it('should apply type conversion setters after validation', async () => {
108
- const product = await api.resources.products.post({
109
- name: 'Test Product',
110
- price: 99.999, // Will be rounded to cents
111
- discount_percent: 15.678, // Will be rounded to integer
112
- metadata: { key: 'value' } // Will be stringified
113
- })
114
-
115
- // Get the product to verify setters were applied
116
- const fetchedProduct = await api.resources.products.get({ id: product.id })
117
- assert.equal(fetchedProduct.price, 10000) // 99.999 * 100 rounded = 10000 cents
118
- assert.equal(fetchedProduct.discount_percent, 16) // 15.678 rounded
119
- assert.equal(fetchedProduct.metadata, '{"key":"value"}')
120
- })
121
- })
122
-
123
- describe('Async Setters', () => {
124
- beforeEach(async () => {
125
- await cleanTables(knex, ['setter_secure'])
126
- })
127
-
128
- it('should support async setter functions', async () => {
129
- const record = await api.resources.secure_data.post({
130
- password: 'mysecretpassword',
131
- api_key: 'test-key-123',
132
- data: 'sensitive information'
133
- })
134
-
135
- assert.ok(record.id, 'Record should have an id')
136
-
137
- // Get the record to verify async setters were applied
138
- const fetchedRecord = await api.resources.secure_data.get({ id: record.id })
139
-
140
- // Password should be hashed (mock hash)
141
- assert.equal(fetchedRecord.password, 'hashed:mysecretpassword')
142
-
143
- // API key should be encrypted (base64)
144
- assert.equal(fetchedRecord.api_key, Buffer.from('test-key-123').toString('base64'))
145
-
146
- // Data should be encrypted
147
- assert.equal(fetchedRecord.data, Buffer.from('sensitive information').toString('base64'))
148
- })
149
- })
150
-
151
- describe('Setter Dependencies', () => {
152
- beforeEach(async () => {
153
- await cleanTables(knex, ['setter_computed'])
154
- })
155
-
156
- it('should apply setters in dependency order', async () => {
157
- const data = await api.resources.computed_data.post({
158
- base_value: 100,
159
- multiplier: 2,
160
- adjustment: 10
161
- // calculated_value depends on base_value and multiplier
162
- // final_value depends on calculated_value and adjustment
163
- })
164
-
165
- const fetchedData = await api.resources.computed_data.get({ id: data.id })
166
- assert.equal(fetchedData.base_value, 100)
167
- assert.equal(fetchedData.multiplier, 2)
168
- assert.equal(fetchedData.adjustment, 10)
169
- assert.equal(fetchedData.calculated_value, 200) // 100 * 2
170
- assert.equal(fetchedData.final_value, 210) // 200 + 10
171
- })
172
- })
173
-
174
- describe('Error Handling', () => {
175
- beforeEach(async () => {
176
- await cleanTables(knex, ['setter_users'])
177
- })
178
-
179
- it('should reject setter errors and roll back the write', async () => {
180
- // Create a resource with a failing setter
181
- await api.addResource('error_test', {
182
- schema: {
183
- id: { type: 'id' },
184
- good_field: {
185
- type: 'string',
186
- setter: (value) => value?.toLowerCase()
187
- },
188
- bad_field: {
189
- type: 'string',
190
- setter: (value) => {
191
- throw new Error('Setter failed!')
192
- }
193
- }
194
- },
195
- tableName: 'setter_errors'
196
- })
197
- await api.resources.error_test.createKnexTable()
198
-
199
- await assert.rejects(
200
- api.resources.error_test.post({
201
- good_field: 'HELLO',
202
- bad_field: 'world'
203
- }),
204
- /Setter for field 'bad_field' failed: Setter failed!/
205
- )
206
-
207
- const records = await api.resources.error_test.query()
208
- assert.equal(records?.length || 0, 0)
209
-
210
- await cleanTables(knex, ['setter_errors'])
211
- })
212
- })
213
-
214
- describe('Null and Undefined Handling', () => {
215
- beforeEach(async () => {
216
- await cleanTables(knex, ['setter_nullable'])
217
- })
218
-
219
- it('should handle null and undefined values in setters', async () => {
220
- const data = await api.resources.nullable_data.post({
221
- field1: null,
222
- field3: '',
223
- field4: 0
224
- })
225
-
226
- const fetchedData = await api.resources.nullable_data.get({ id: data.id })
227
- assert.equal(fetchedData.field1, null)
228
- assert.equal(fetchedData.field2, null)
229
- assert.equal(fetchedData.field3, 'empty') // Empty string transformed
230
- assert.equal(fetchedData.field4, -1) // Zero transformed
231
- })
232
- })
233
-
234
- describe('Validation Before Setters', () => {
235
- beforeEach(async () => {
236
- await cleanTables(knex, ['setter_validated'])
237
- })
238
-
239
- it('should run setters only after successful validation', async () => {
240
- // Try to create with invalid data
241
- await assert.rejects(
242
- api.resources.validated_data.post({
243
- email: 'not-an-email', // Should fail validation
244
- age: 150 // Should fail max validation
245
- }),
246
- /Schema validation failed/
247
- )
248
-
249
- // No records should be created - verify with query
250
- const records = await api.resources.validated_data.query()
251
- assert.equal(records?.length || 0, 0)
252
- })
253
-
254
- it('should apply setters to validated type-cast data', async () => {
255
- const data = await api.resources.validated_data.post({
256
- email: ' VALID@EXAMPLE.COM ',
257
- age: '25', // String will be cast to number
258
- score: '98.7' // String will be cast to number
259
- })
260
-
261
- const fetchedData = await api.resources.validated_data.get({ id: data.id })
262
- assert.equal(fetchedData.email, 'valid@example.com')
263
- assert.equal(fetchedData.age, 25) // Setter sees number, not string
264
- assert.equal(fetchedData.score, 99) // Rounded up by setter
265
- })
266
- })
267
-
268
- describe('Circular Dependencies', () => {
269
- it('should detect circular setter dependencies', async () => {
270
- await assert.rejects(
271
- api.addResource('circular_setters', {
272
- schema: {
273
- fieldA: {
274
- type: 'string',
275
- setter: (v) => v,
276
- runSetterAfter: ['fieldB']
277
- },
278
- fieldB: {
279
- type: 'string',
280
- setter: (v) => v,
281
- runSetterAfter: ['fieldA']
282
- }
283
- },
284
- tableName: 'circular_setters'
285
- }),
286
- /Circular dependency detected/
287
- )
288
- })
289
-
290
- it('should detect unknown setter dependencies', async () => {
291
- await assert.rejects(
292
- api.addResource('unknown_deps', {
293
- schema: {
294
- field1: {
295
- type: 'string',
296
- setter: (v) => v,
297
- runSetterAfter: ['nonexistent']
298
- }
299
- },
300
- tableName: 'unknown_deps'
301
- }),
302
- /setter dependency 'nonexistent' that does not exist/
303
- )
304
- })
305
- })
306
- })
@@ -1,118 +0,0 @@
1
- import { describe, it, before, after, beforeEach } from 'node:test'
2
- import assert from 'node:assert/strict'
3
- import knexLib from 'knex'
4
- import { cleanTables } from './helpers/test-utils.js'
5
- import { createFileUploadApi } from './fixtures/api-configs.js'
6
-
7
- const knex = knexLib({
8
- client: 'better-sqlite3',
9
- connection: {
10
- filename: ':memory:'
11
- },
12
- useNullAsDefault: true
13
- })
14
-
15
- let api
16
- let detectorState
17
- let storage
18
-
19
- function createTrackingStorage () {
20
- return {
21
- uploaded: [],
22
- deleted: [],
23
-
24
- async upload (file) {
25
- const url = `/uploads/${file.filename}`
26
- this.uploaded.push(url)
27
- return url
28
- },
29
-
30
- async delete (url) {
31
- this.deleted.push(url)
32
- }
33
- }
34
- }
35
-
36
- function createTestFile ({ filename = 'upload.png', mimetype = 'image/png', cleanup } = {}) {
37
- return {
38
- filename,
39
- mimetype,
40
- size: 1,
41
- data: Buffer.from('x'),
42
- cleanup
43
- }
44
- }
45
-
46
- describe('File handling cleanup', () => {
47
- before(async () => {
48
- detectorState = { payload: null }
49
- storage = createTrackingStorage()
50
- api = await createFileUploadApi(knex, { detectorState, storage })
51
- })
52
-
53
- after(async () => {
54
- await knex.destroy()
55
- })
56
-
57
- beforeEach(async () => {
58
- await cleanTables(knex, ['file_documents'])
59
- detectorState.payload = null
60
- storage.uploaded = []
61
- storage.deleted = []
62
- })
63
-
64
- it('cleans detector temp files when MIME validation rejects an upload', async () => {
65
- let cleanupCalls = 0
66
- detectorState.payload = {
67
- fields: { title: 'Invalid MIME' },
68
- files: {
69
- attachment: createTestFile({
70
- filename: 'invalid.txt',
71
- mimetype: 'text/plain',
72
- cleanup: async () => {
73
- cleanupCalls++
74
- }
75
- })
76
- }
77
- }
78
-
79
- await assert.rejects(
80
- api.resources.documents.post({
81
- inputRecord: { data: { type: 'documents', attributes: {} } },
82
- simplified: false
83
- }),
84
- /Invalid file type for field 'attachment'/
85
- )
86
-
87
- assert.equal(cleanupCalls, 1)
88
- assert.deepEqual(storage.uploaded, [])
89
- assert.deepEqual(storage.deleted, [])
90
- })
91
-
92
- it('deletes uploaded files when a later write validation error rolls back', async () => {
93
- let cleanupCalls = 0
94
- detectorState.payload = {
95
- fields: {},
96
- files: {
97
- attachment: createTestFile({
98
- filename: 'valid.png',
99
- cleanup: async () => {
100
- cleanupCalls++
101
- }
102
- })
103
- }
104
- }
105
-
106
- await assert.rejects(
107
- api.resources.documents.post({
108
- inputRecord: { data: { type: 'documents', attributes: {} } },
109
- simplified: false
110
- }),
111
- /Schema validation failed for resource attributes/
112
- )
113
-
114
- assert.equal(cleanupCalls, 1)
115
- assert.deepEqual(storage.uploaded, ['/uploads/valid.png'])
116
- assert.deepEqual(storage.deleted, ['/uploads/valid.png'])
117
- })
118
- })