@stonyx/orm 0.3.2-alpha.7 → 0.3.2-alpha.70

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 (60) hide show
  1. package/README.md +870 -11
  2. package/config/environment.js +8 -0
  3. package/dist/commands.js +34 -0
  4. package/dist/dynamodb/connection.d.ts +31 -0
  5. package/dist/dynamodb/connection.js +28 -0
  6. package/dist/dynamodb/dynamodb-db.d.ts +142 -0
  7. package/dist/dynamodb/dynamodb-db.js +596 -0
  8. package/dist/dynamodb/operation-builder.d.ts +76 -0
  9. package/dist/dynamodb/operation-builder.js +116 -0
  10. package/dist/dynamodb/type-map.d.ts +31 -0
  11. package/dist/dynamodb/type-map.js +48 -0
  12. package/dist/hooks.d.ts +15 -1
  13. package/dist/index.d.ts +1 -0
  14. package/dist/main.d.ts +116 -0
  15. package/dist/main.js +129 -0
  16. package/dist/manage-record.js +268 -12
  17. package/dist/mysql/connection.d.ts +1 -0
  18. package/dist/mysql/mysql-db.d.ts +8 -0
  19. package/dist/mysql/mysql-db.js +44 -10
  20. package/dist/orm-request.d.ts +264 -3
  21. package/dist/orm-request.js +975 -49
  22. package/dist/postgres/connection.d.ts +1 -0
  23. package/dist/postgres/connection.js +8 -6
  24. package/dist/postgres/postgres-db.d.ts +8 -0
  25. package/dist/postgres/postgres-db.js +44 -10
  26. package/dist/record.js +7 -5
  27. package/dist/relationships.js +1 -1
  28. package/dist/serializer.js +38 -2
  29. package/dist/setup-rest-server.js +51 -5
  30. package/dist/standalone-db.js +17 -5
  31. package/dist/store.d.ts +13 -1
  32. package/dist/store.js +65 -6
  33. package/dist/types/orm-types.d.ts +207 -0
  34. package/dist/utils.d.ts +44 -0
  35. package/dist/utils.js +47 -0
  36. package/package.json +16 -7
  37. package/src/commands.ts +43 -0
  38. package/src/dynamodb/connection.ts +50 -0
  39. package/src/dynamodb/dynamodb-db.ts +811 -0
  40. package/src/dynamodb/operation-builder.ts +202 -0
  41. package/src/dynamodb/type-map.ts +54 -0
  42. package/src/hooks.ts +15 -1
  43. package/src/index.ts +1 -0
  44. package/src/main.ts +133 -0
  45. package/src/manage-record.ts +294 -18
  46. package/src/mysql/connection.ts +1 -0
  47. package/src/mysql/mysql-db.ts +44 -12
  48. package/src/orm-request.ts +992 -52
  49. package/src/postgres/connection.ts +10 -6
  50. package/src/postgres/postgres-db.ts +44 -12
  51. package/src/record.ts +8 -5
  52. package/src/relationships.ts +1 -1
  53. package/src/serializer.ts +39 -2
  54. package/src/setup-rest-server.ts +59 -6
  55. package/src/standalone-db.ts +17 -6
  56. package/src/store.ts +68 -6
  57. package/src/types/orm-types.ts +214 -0
  58. package/src/types/stonyx-rest-server.d.ts +14 -1
  59. package/src/types/stonyx.d.ts +7 -1
  60. package/src/utils.ts +50 -0
@@ -1,10 +1,272 @@
1
+ /**
2
+ * REST request handling and access enforcement for @stonyx/orm.
3
+ *
4
+ * ---------------------------------------------------------------------------
5
+ * THE `access()` CONTRACT: `access(request, { model, operation })`
6
+ * ---------------------------------------------------------------------------
7
+ * `auth()` calls your predicate with TWO arguments. The second is the access
8
+ * CONTEXT -- the structural facts about the request, which the framework
9
+ * already holds and which you should read INSTEAD of parsing anything:
10
+ *
11
+ * context.model The model this route was mounted for, as a model name:
12
+ * kebab-case, exactly as declared under
13
+ * `config.orm.paths.model` and keyed in the store --
14
+ * `'owner'`, `'animal'`, `'phone-number'`. NOT the
15
+ * pluralised, dasherized, mount-prefixed ROUTE name. It is
16
+ * read from the OrmRequest instance, fixed at mount time,
17
+ * and no request can influence it.
18
+ *
19
+ * context.operation The operation being authorised. Exactly one of the four
20
+ * verbs `'read'`, `'create'`, `'update'`, `'delete'` --
21
+ * no second vocabulary ON THIS PATH, and never an HTTP
22
+ * method name like `'GET'`. These are the same four
23
+ * strings the permission-array return shape is written in
24
+ * (`['read', 'create']`), because both come from the one
25
+ * `methodAccessMap` below.
26
+ *
27
+ * NOT the hook vocabulary. `HookContext.operation`
28
+ * (`src/hooks.ts`, documented under "Hook Context Object"
29
+ * in the README) carries `'list' | 'get' | 'create' |
30
+ * 'update' | 'delete'` on an identically-named key of an
31
+ * identically-shaped context object, and the access
32
+ * vocabulary collapses `list` and `get` into `'read'`. For
33
+ * one `GET /animals/1` a hook sees `'get'` and `access()`
34
+ * sees `'read'`, so a predicate cannot tell a collection
35
+ * read from a record read. `AccessOperation` makes
36
+ * `operation === 'get'` a compile error for a TypeScript
37
+ * consumer, because a predicate that stops matching falls
38
+ * through to the permission array -- the misreading is
39
+ * fail-open shaped.
40
+ *
41
+ * `undefined` when the dispatched method has no entry in
42
+ * that map. Express delivers `HEAD` to the `GET` handler,
43
+ * so this is reachable. It is left undefined rather than
44
+ * defaulted on purpose -- a fabricated `'read'` would turn
45
+ * an unclassified request into an authorised one. Treat
46
+ * `undefined` as "not classified" and deny.
47
+ *
48
+ * So a consumer writes `if (model === 'owner' && operation === 'read')`. There
49
+ * is no string to parse, no variant to miss, and no way to fail open through a
50
+ * URL shape nobody anticipated.
51
+ *
52
+ * WHAT THE CONTEXT DOES NOT TELL YOU: WHICH SURFACE. It names the model and
53
+ * the verb, not the route. Measured over the live router, six surfaces produce
54
+ * one identical context:
55
+ *
56
+ * GET /owners { model: 'owner', operation: 'read' }
57
+ * GET /owners/gina { model: 'owner', operation: 'read' }
58
+ * GET /owners/gina/pets { model: 'owner', operation: 'read' }
59
+ * GET /owners/gina/relationships/pets { model: 'owner', operation: 'read' }
60
+ * GET /owners/archived { model: 'owner', operation: 'read' }
61
+ * GET /owners/gina?include=pets { model: 'owner', operation: 'read' }
62
+ *
63
+ * So a rule that depends on the SUB-PATH still needs `request.path` -- which is
64
+ * mount-relative and query-free, and is the one read of argument one the
65
+ * warning below sanctions. This repo's own fixture has such a rule: its
66
+ * `/archived` deny cannot be expressed from the context alone, and a predicate
67
+ * migrated to context-only would silently drop it, turning a deny into an
68
+ * allow. The related-resource and `?include=` surfaces serve ANOTHER model's
69
+ * records under `model: 'owner'`, and the context gives no signal of that
70
+ * (abofs/stonyx-orm#196).
71
+ *
72
+ * SUPERSEDED 2026-09-01 BY abofs/stonyx-orm#236/#237, AND KEPT FOR THE
73
+ * CONSTRAINT IT STATES RATHER THAN AS A DESCRIPTION OF THE CODE. The context
74
+ * now also carries `recordId` -- the DECODED route-parameter id, see
75
+ * `AccessContext.recordId` in ./types/orm-types.ts -- so the fixture's
76
+ * `/archived` deny IS expressible from the context alone, and the shipped
77
+ * sample no longer reads `request.path` at all. Retiring this wording WITH the
78
+ * measurement that retires it, rather than by deletion, is
79
+ * abofs/stonyx-orm#238.
80
+ *
81
+ * `record` IS NOT IN THIS CONTEXT, deliberately. `auth()` runs after route
82
+ * matching but BEFORE any handler executes (`@stonyx/rest-server`
83
+ * `src/request.ts:58-60`), so nothing has been fetched yet -- supplying a
84
+ * record would force a pre-fetch on every request, a second store hit and an
85
+ * ordering change in the middle of an authorization path. It is also
86
+ * unnecessary: the FUNCTION return shape already is the per-record hook. Return
87
+ * `(record) => boolean` and the handlers apply it to every record the request
88
+ * touches. Auth-time and record-time are separate decision points.
89
+ *
90
+ * THE SECOND ARGUMENT IS ADDITIVE. JavaScript ignores extra arguments, so an
91
+ * existing `access(request)` predicate keeps working exactly as before. The
92
+ * warning immediately below is therefore still live: `request` is still
93
+ * argument ONE, and reading it is still how predicates fail open.
94
+ *
95
+ * To reach ANOTHER model's predicate -- e.g. to check an animal while servicing
96
+ * an owners route -- use the boot-time registry:
97
+ *
98
+ * const predicate = Orm.instance.getAccess('animal');
99
+ * if (!predicate) return deny;
100
+ * const verdict = predicate(request, { model: 'animal', operation: 'read' });
101
+ *
102
+ * `undefined` means NO PREDICATE COULD BE RESOLVED for that name -- which
103
+ * includes the case where the model has an access class that failed to load,
104
+ * because `setup-rest-server.ts` catches a load failure, warns, and publishes
105
+ * whatever partial map it had. It does NOT mean the model is unrestricted.
106
+ * Treat it as DENY, the same way `operation === undefined` is treated above.
107
+ *
108
+ * PASSING THE CONTEXT MAKES A MODEL-CORRECT ANSWER POSSIBLE. It does not make
109
+ * the answer model-correct on its own -- the resolved predicate has to READ it.
110
+ * Measured against an ARITY-1 predicate, on a request express dispatched to
111
+ * `GET /owners/angela`, asked about ANIMALS:
112
+ *
113
+ * getAccess('animal')(ownersRequest, { model: 'animal', operation: 'read' })
114
+ * -> record => record.id !== 'angela' && record.id !== 'restricted'
115
+ *
116
+ * That is the OWNERS filter, and it returns `true` for animal 21 -- the record
117
+ * hidden on every animal surface. Under a mount that predicate recognises
118
+ * neither way it is worse: it falls through to
119
+ * `['read', 'create', 'update', 'delete']`, a full CRUD grant. Either way the
120
+ * context was supplied and the answer is not the animal answer, and it is wrong
121
+ * in the GRANTING direction, because that predicate is arity-1 and identifies
122
+ * its collection from the request. (Asserted on a live dispatch by AC9 in
123
+ * test/integration/orm-test.ts, against a deliberately arity-1 predicate.)
124
+ *
125
+ * This repo's own sample access class has since been MIGRATED to read the
126
+ * context (abofs/stonyx-orm#222), so `getAccess('animal')` here now answers
127
+ * with the animal filter. That is not true of a consumer tree: an arity-1
128
+ * predicate keeps working -- the second argument is additive -- and the caller
129
+ * has no supported way to tell which kind it got. The boot-time arity warning
130
+ * that surfaces one is abofs/stonyx-orm#221.
131
+ * So: pass the context, and do not treat a resolved predicate's answer as
132
+ * model-specific until that predicate has been migrated to read the context.
133
+ *
134
+ * ---------------------------------------------------------------------------
135
+ * DO NOT RECONSTRUCT THE REQUEST PATH INSIDE `access()`.
136
+ * ---------------------------------------------------------------------------
137
+ * You do not have to. `auth()` below hands your predicate the ACCESS CONTEXT as
138
+ * argument two, and `context.model` already names the collection -- see the
139
+ * contract section above. Argument ONE is still the raw transport artifact, and
140
+ * everything from here to the end of this banner is the record of what happened
141
+ * when predicates worked the collection out from it. IT IS HISTORY, NOT
142
+ * GUIDANCE: do not write any of it into a new predicate. Every attempt to
143
+ * identify the collection by parsing the request target has failed OPEN. Five
144
+ * distinct variants of the same three-line example have now been found, each
145
+ * after the previous was fixed, by five different people:
146
+ *
147
+ * 1. `request.url` is mount-relative under `RestServer.mountRoute`, so a
148
+ * prefix match against it is ALWAYS false.
149
+ * 2. `request.originalUrl` carries the query string, so an anchored equality
150
+ * check misses `/owners?filter[age]=30`.
151
+ * 3. The router is a bare `express()` (`caseSensitive: false`) while a
152
+ * hand-written matcher is case-SENSITIVE, so `GET /OwNeRs/angela` walks
153
+ * past it. Router-side: abofs/stonyx-rest-server#47.
154
+ * 4. Under a configured `ORM_REST_ROUTE` a hard-coded `/owners` matches
155
+ * nothing -- environment-specifically, which is worse.
156
+ * 5. HTTP/1.1 permits an ABSOLUTE-FORM request-target. Express routes on
157
+ * `parseurl(req).pathname`, but `originalUrl` is the raw target, so
158
+ * `GET http://anything.example/owners/angela` reaches the handler with
159
+ * `originalUrl === 'http://anything.example/owners/angela'`. A `/owners`
160
+ * prefix match is false, `access()` falls through to whatever it returns
161
+ * last, and the record comes back in full. It walks past a hard
162
+ * `return false` deny the same way.
163
+ *
164
+ * The fix is not a sixth rule, and it is not a better string to match. It is to
165
+ * stop identifying the collection at all: read `context.model`. That is a claim
166
+ * about IDENTIFYING THE COLLECTION, not about the sample as a whole -- the
167
+ * `/archived` SUB-PATH rule is still a string match, and abofs/stonyx-orm#228 is
168
+ * a sixth spelling that gets past it.
169
+ *
170
+ * SUPERSEDED 2026-09-01 BY abofs/stonyx-orm#236/#237: the `/archived` rule is
171
+ * no longer a string match against the request target -- it compares the
172
+ * decoded `recordId` the framework supplies -- and abofs/stonyx-orm#228 is
173
+ * CLOSED. Retirement of this wording: abofs/stonyx-orm#238.
174
+ *
175
+ * An intermediate revision of the sample read `request.baseUrl` -- the mount
176
+ * Express ACTUALLY MATCHED. That closed all five variants (no query string,
177
+ * not mount-relative, unaffected by absolute-form, already carrying the
178
+ * configured `ORM_REST_ROUTE` prefix), but it was a transport artifact
179
+ * standing in for a structural fact and the sample no longer does it.
180
+ * `context.model` IS the structural fact, so variants 1, 2, 4 and 5 are
181
+ * unconstructible against a migrated predicate rather than handled.
182
+ *
183
+ * VARIANT 3 SURVIVES, and is deliberately not in that list. It is the general
184
+ * shape "a hand-written matcher normalises differently from the router", and a
185
+ * migrated predicate still runs one string comparison for any SUB-PATH rule --
186
+ * in the shipped sample, the `/archived` deny. That comparison folds case but
187
+ * does not decode, so `GET /owners/%61rchived` steps past it. See the
188
+ * normalisation paragraph below and abofs/stonyx-orm#228.
189
+ *
190
+ * SUPERSEDED 2026-09-01 BY abofs/stonyx-orm#236/#237. Variant 3 lived in that
191
+ * one string comparison, and the comparison is gone: the sample compares the
192
+ * decoded `recordId`. Left standing rather than edited because the same
193
+ * "variant 3 survives" wording sits at four sites -- this header, README.md
194
+ * twice, and test/sample/access/global-access.ts -- three of which SHIP, so
195
+ * retiring one of four leaves the shipped copies contradicting each other.
196
+ * Retiring all four WITH their measurement is abofs/stonyx-orm#238.
197
+ *
198
+ * ONE READ OF ARGUMENT ONE SURVIVES, AND IT MUST: `request.path`. It is
199
+ * mount-relative and query-free, and it is for rules that distinguish SUB-PATHS
200
+ * beneath the mount. The context names which model and which verb, NOT which
201
+ * route, so the sample's `/archived` deny cannot be expressed from the context
202
+ * alone and a context-ONLY rewrite would silently turn that deny into an allow.
203
+ *
204
+ * SUPERSEDED 2026-09-01 BY abofs/stonyx-orm#236/#237: NO read of argument one
205
+ * survives in the shipped sample. `recordId` names WHICH RECORD the route was
206
+ * addressed to, so the `/archived` deny is expressible from the context alone
207
+ * -- and it still must not be dropped; expressible is not optional. Retirement
208
+ * of this wording: abofs/stonyx-orm#238.
209
+ *
210
+ * NORMALISE THE WAY THE ROUTER DOES, AND CASE-FOLDING ALONE IS NOT THAT. The
211
+ * sample lower-cases before comparing, because a matcher stricter than the
212
+ * case-insensitive router can be stepped around. That closes the case gap only.
213
+ * Express sets `request.path` from the RAW, UNDECODED pathname while the router
214
+ * DECODES `:id`, so `GET /owners/%61rchived` reaches a `path === '/archived'`
215
+ * comparison as `/%61rchived` and walks past the deny. That gap is live in the
216
+ * sample and is tracked as abofs/stonyx-orm#228; the `.toLowerCase()` is not a
217
+ * complete normalisation recipe. Compare record ids at their real case.
218
+ *
219
+ * DO NOT FOLLOW THE PARAGRAPH ABOVE. SUPERSEDED 2026-09-01 BY
220
+ * abofs/stonyx-orm#236/#237, and flagged here rather than merely dated because
221
+ * it is an INSTRUCTION, not a stale observation. `.toLowerCase()` on the access
222
+ * path was measured WRONG IN BOTH DIRECTIONS AT ONCE: with a distinct owner
223
+ * seeded at `ARCHIVED`, `GET /owners/ARCHIVED` was a false DENY on the wrong
224
+ * record and `GET /owners/%41RCHIVED` a false ALLOW on that same record. A
225
+ * record id is a VALUE, not a literal route segment, and express's
226
+ * `case sensitive routing` governs literal segments only. Compare
227
+ * `context.recordId` AS IT ARRIVES: do not case-fold it, do not decode it, do
228
+ * not derive it from `request.path`. `AccessContext.recordId` in
229
+ * ./types/orm-types.ts is the contract and says "Do NOT case-fold it"; the same
230
+ * published tarball ships both files, and THIS paragraph is the one that is
231
+ * wrong. Retiring it WITH its measurement is abofs/stonyx-orm#238.
232
+ *
233
+ * `?? ''` is not a defence. It converts an absent request target into an empty
234
+ * string, which matches no collection, which falls through to the permission
235
+ * array -- a total grant. An input you cannot identify must DENY, and that
236
+ * applies to BOTH arguments: since #202 the guard and the read can sit on
237
+ * different objects, and a guard on argument two does not protect a read of
238
+ * argument one. The sample returns `false` for an absent `model` AND for an
239
+ * absent or non-string `request.path`, rather than falling through either way.
240
+ *
241
+ * SUPERSEDED 2026-09-01 BY abofs/stonyx-orm#236/#237 as to WHAT is guarded --
242
+ * the principle is unchanged. The sample no longer reads `request.path`, so it
243
+ * returns `false` for an absent `model` AND for an absent `recordId`
244
+ * (`undefined`, the one spelling `auth()` never produces). Retirement of this
245
+ * wording: abofs/stonyx-orm#238.
246
+ *
247
+ * THE REAL FIX IS abofs/stonyx-orm#202: `access()` should receive the model,
248
+ * the operation and the record. Prefer the array shape (`['read']`) or `false`
249
+ * until #202 lands; the function shape is what requires any matching at all.
250
+ *
251
+ * The enforcement gates in this file (GATE 0/1/2, the create rollback, the
252
+ * per-handler `isDenied` re-checks) are correct independently of that -- they
253
+ * enforce whatever predicate you return. The stopgap is the part where YOU have
254
+ * to work out which predicate to return.
255
+ *
256
+ * AND A PREDICATE IS NOT A GUARANTEE THAT A HIDDEN RECORD CANNOT BE MODIFIED.
257
+ * It is evaluated against the record the route is ADDRESSED TO, on that model
258
+ * only. A write to a DIFFERENT collection can still re-parent a hidden record
259
+ * and de-hide it -- abofs/stonyx-orm#207, which is blocked on #202 and #196.
260
+ * See `### Known limitations` in README.
261
+ */
1
262
  import { Request } from '@stonyx/rest-server';
2
263
  import Orm, { store, createRecord, updateRecord } from '@stonyx/orm';
3
264
  import { camelCaseToKebabCase } from '@stonyx/utils/string';
4
265
  import { getPluralName } from './plural-registry.js';
5
266
  import { getBeforeHooks, getAfterHooks } from './hooks.js';
6
267
  import config from 'stonyx/config';
7
- import { isOrmRecord } from './utils.js';
268
+ import log from 'stonyx/log';
269
+ import { isOrmRecord, NO_FREE_ID_ERROR } from './utils.js';
8
270
  const methodAccessMap = {
9
271
  GET: 'read',
10
272
  POST: 'create',
@@ -48,13 +310,117 @@ function getBaseUrl(request) {
48
310
  const host = request.get('host');
49
311
  return `${protocol}://${host}`;
50
312
  }
313
+ /**
314
+ * The ONE coercion from a caller-supplied id to the key the store holds it
315
+ * under. Every id-bearing surface in this file goes through it, and none has a
316
+ * copy: `getId()` (URL params), `normalizeBodyId()` (JSON body), and the
317
+ * post-create `context.record` lookup in `_withHooks`.
318
+ *
319
+ * WHY IT IS SHARED RATHER THAN DUPLICATED. `getId()` and `normalizeBodyId()`
320
+ * each had their own arithmetic, and they disagreed: `parseInt(id)` versus
321
+ * `parseInt(id, 10)`. On a hex-shaped id that is a two-record difference --
322
+ *
323
+ * GET /animals/0x2391 -> record 9105 (getId -> parseInt('0x2391') = 9105)
324
+ * POST /animals {"id":"0x2391"} -> lookup under 0 (normalize -> parseInt('0x2391',10) = 0)
325
+ * -> a MISS, so the duplicate check was skipped and
326
+ * createRecord OVERWROTE 9105 in place, answering 200
327
+ *
328
+ * -- a narrower form of the raw-versus-normalised divergence that the body-id
329
+ * normalisation was added to close, reintroduced by the fix for it. Two
330
+ * coercions that must agree cannot be kept in agreement by review; they have to
331
+ * be one function. Pinned by assertion 43.
332
+ *
333
+ * The third copy was found later and in a quieter place: `_withHooks` populated
334
+ * `context.record` for `create` with `isNaN(id) ? id : parseInt(id)` -- this
335
+ * function's body, inlined verbatim, feeding `store.get`. It was equivalent on
336
+ * every input reachable there, which is exactly what the two that DID diverge
337
+ * looked like until someone tried a hex id.
338
+ *
339
+ * SHARING IT IS NOT THE SAME AS IT BEING RIGHT EVERYWHERE. On a model declaring
340
+ * `id = attr('string')` a numeric-looking id is filed under the STRING key, so
341
+ * this coercion resolves `'9107'` to `9107` and the post-create lookup misses:
342
+ * `context.record` is `undefined` for an after-`create` hook. Inherited -- the
343
+ * inlined copy computed the same thing -- and NOT fixed here, because picking
344
+ * the right coercion needs the model's declared id type, which is the same
345
+ * structural information abofs/stonyx-orm#202 is about. Filed as
346
+ * abofs/stonyx-orm#209 and pinned by assertion 50, so closing it turns a test
347
+ * red rather than passing silently.
348
+ *
349
+ * `parseInt` and not `Number`, deliberately, and the anchor is NOT `getId`.
350
+ * It is `src/transforms.ts:7` -- `number: (value) => parseInt(value as string)`,
351
+ * also radix-less -- because that transform is what actually produces the store
352
+ * KEY a record is filed under. `getId` merely agrees with it. They differ from
353
+ * `Number` on `'1e3'` (1 vs 1000) and `'9105.5'` (9105 vs 9105.5), so switching
354
+ * this function to `Number` would make the lookup key disagree with the landing
355
+ * key on those shapes.
356
+ *
357
+ * THE CHANGE THAT WOULD BREAK THIS: adding a radix to `transforms.number`
358
+ * (`parseInt(value, 10)`). That is a one-word edit in a file with no connection
359
+ * to authorization, it would silently reopen the hex divergence in the other
360
+ * direction, and this comment would still read as correct. Assertion 45 pins
361
+ * the transform's radix-less shape directly, so that edit turns a test red
362
+ * rather than shipping.
363
+ *
364
+ * The reason `parseInt` is safe here is the `isNaN` gate in front of it:
365
+ * `parseInt('9105h')` is `9105`, and truncating a partially-valid id into a
366
+ * DIFFERENT VALID key is exactly how a collision lookup gets skipped. The gate
367
+ * rejects it as a string instead, so nothing is ever truncated. That gate, not
368
+ * the parser, is the load-bearing half -- assertion 43 pins it.
369
+ */
370
+ function coerceId(id) {
371
+ if (isNaN(id))
372
+ return id;
373
+ return parseInt(id);
374
+ }
51
375
  function getId(params) {
52
376
  const id = params.id;
53
377
  if (!id)
54
378
  return '';
55
- if (isNaN(id))
379
+ return coerceId(id);
380
+ }
381
+ /**
382
+ * Normalise a caller-supplied BODY id to the key the store will hold it under.
383
+ *
384
+ * `getId()` above is params-shaped: it takes `{ id?: string }` off the URL,
385
+ * where the value is always a string and a falsy one means "no id". A JSON body
386
+ * id is neither -- it can arrive as a number, and `0` is a legitimate id that
387
+ * `getId()` would flatten to `''`.
388
+ *
389
+ * WHY THIS EXISTS AT ALL. createHandler used to look the collision up with the
390
+ * RAW body value while every other surface normalised through `getId()`. The
391
+ * store is a Map keyed by the coerced value, so `store.find(model, '21')` misses
392
+ * the entry held under `21` and the duplicate check is skipped by typing the id
393
+ * as a string. On `dev` that silently overwrote the colliding record and
394
+ * answered 200; combined with the denied-create rollback added for #190 it
395
+ * became an unauthenticated DELETE of any id. Normalising here is half of that
396
+ * fix -- see the rollback in createHandler for the other half.
397
+ *
398
+ * It shares `coerceId` with `getId` so the two surfaces cannot drift apart
399
+ * again, and differs from `getId` in exactly ONE place, below.
400
+ */
401
+ function normalizeBodyId(id) {
402
+ // Non-strings pass through untouched: a JSON body id can arrive as a number,
403
+ // and `getId`'s falsy-flatten must NOT apply to it -- `0` is a legitimate id
404
+ // and `getId` would turn it into `''`. (assertion 30 sweeps id `0`.)
405
+ if (typeof id !== 'string')
56
406
  return id;
57
- return parseInt(id);
407
+ // THE ONE DIVERGENCE FROM `getId`, and it mirrors rather than contradicts it:
408
+ // `getId` maps a falsy param to `''`, and `''` is the only string a body can
409
+ // carry that means "no id" -- `createRecord` treats it as absent and assigns a
410
+ // server id. Coercing it instead would make it address a real slot, because
411
+ // `parseInt('')` is `NaN` and a record CAN be held under `NaN` (a truthy but
412
+ // non-numeric id such as `' '` survives `assignRecordId`'s falsy guard and
413
+ // then NaNs in the id transform). So `POST {"id":""}` would answer 409 against
414
+ // an unrelated record it never named. Pinned by assertion 44.
415
+ //
416
+ // Note what is deliberately NOT special-cased here any more: whitespace.
417
+ // `id.trim() === ''` used to short-circuit `' '` as well, which made the
418
+ // body surface DISAGREE with the URL surface -- `getId({id:' '})` is `NaN`,
419
+ // so `' '` addresses the NaN slot on every other route while the collision
420
+ // lookup missed it. Same class of bug as the hex divergence above.
421
+ if (id === '')
422
+ return id;
423
+ return coerceId(id);
58
424
  }
59
425
  function buildResponse(data, includeParam, recordOrRecords, options = {}) {
60
426
  const { links, baseUrl } = options;
@@ -187,6 +553,39 @@ function createFilterPredicate(filters) {
187
553
  return String(current) === value;
188
554
  });
189
555
  }
556
+ /**
557
+ * A function-style `access` return is a per-record predicate, and it is only
558
+ * meaningful if every surface that can hand a record to a caller consults it.
559
+ * Before #190 exactly one of seven did.
560
+ *
561
+ * Enforcement is deliberately post-fetch. `access` returns an opaque JS
562
+ * predicate and `store.findAll(model, conditions)` accepts only an equality
563
+ * conditions object that the SQL drivers translate to a WHERE clause, so
564
+ * query-layer enforcement would require a breaking change to the published
565
+ * `access` contract. That belongs in #197, not in a security patch. Six of the
566
+ * seven surfaces fetch by primary key anyway, so this costs exactly one row.
567
+ */
568
+ function isDenied(filter, record) {
569
+ if (typeof filter !== 'function')
570
+ return false;
571
+ // A predicate that throws is treated as a denial. Unguarded, a throw escapes
572
+ // to express's default handler, which answers 500 (with a stack trace outside
573
+ // NODE_ENV=production) while a missing id still answers 404 -- so a
574
+ // record-dependent throw re-separates "hidden" from "does not exist" and
575
+ // hands back the oracle this whole change exists to close.
576
+ try {
577
+ return !filter(record);
578
+ }
579
+ catch (error) {
580
+ // Denied, but not silently. A consumer predicate that throws on every
581
+ // record turns the whole collection into a 404 wall, and with no
582
+ // diagnostic that is indistinguishable from an empty database. `stonyx/log`
583
+ // is the module convention (see setup-rest-server.ts); optional-call
584
+ // because a consumer may not have configured the log types.
585
+ log.error?.(`[@stonyx/orm] access filter threw for model -- denying. ${error instanceof Error ? error.message : String(error)}`);
586
+ return true;
587
+ }
588
+ }
190
589
  export default class OrmRequest extends Request {
191
590
  model;
192
591
  access;
@@ -216,10 +615,15 @@ export default class OrmRequest extends Request {
216
615
  baseUrl
217
616
  });
218
617
  };
219
- const getSingleHandler = async (request) => {
618
+ const getSingleHandler = async (request, { filter }) => {
220
619
  const record = await store.find(model, getId(request.params));
221
620
  if (!record)
222
621
  return 404;
622
+ // 404, never 403: the status for "exists but filtered out" must be
623
+ // identical to "does not exist", or the fix trades an authorization
624
+ // bypass for a narrower existence oracle.
625
+ if (isDenied(filter, record))
626
+ return 404;
223
627
  const fieldsMap = parseFields(request.query);
224
628
  const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
225
629
  const baseUrl = getBaseUrl(request);
@@ -228,19 +632,118 @@ export default class OrmRequest extends Request {
228
632
  baseUrl
229
633
  });
230
634
  };
231
- const createHandler = async ({ body, query }) => {
635
+ const createHandler = async ({ body, query }, { filter }) => {
232
636
  const { type, id, attributes, relationships: rels } = (body?.data || {});
233
637
  if (!type)
234
638
  return 400; // Bad request
235
639
  const fieldsMap = parseFields(query);
236
640
  const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
237
- // Check for duplicate ID
238
- if (id !== undefined && await store.find(model, id))
239
- return 409; // Conflict
641
+ // GATE 0 -- the POST existence oracle.
642
+ //
643
+ // The duplicate check runs before the filter and `store.find` sees hidden
644
+ // records, so POST leaks existence through its STATUS. A previous revision
645
+ // filtered the collision status (403 when the colliding record is denied,
646
+ // 409 when it is visible) and that is NOT sufficient, because the status
647
+ // of a create is a third outcome. With a payload the caller is permitted
648
+ // to create -- the normative case for a per-tenant filter, and the case an
649
+ // attacker picks -- all three are distinguishable in ONE request per id:
650
+ //
651
+ // POST /animals {id:22, owner:'gina'} -> 403 a HIDDEN record has this id
652
+ // POST /animals {id:9500, owner:'gina'} -> 200 this id is FREE
653
+ // POST /animals {id:8, owner:'gina'} -> 409 a VISIBLE record has this id
654
+ //
655
+ // Filtering only the collision status narrows that to callers who cannot
656
+ // create a record they are allowed to see. It does not close it.
657
+ //
658
+ // It cannot be closed while a caller both chooses the id and learns
659
+ // whether the create succeeded: a successful create must answer
660
+ // differently from a refused one. So when a per-record filter is in force
661
+ // the caller does not get to choose the id at all. The refusal is
662
+ // UNCONDITIONAL and happens BEFORE any store lookup, so no status, and no
663
+ // lookup cost, can depend on whether that id exists. 403 -- the same
664
+ // status as a denied create -- so the two cannot be separated either.
665
+ //
666
+ // BOTH HALVES OF THAT ARE PINNED, because both were once asserted here and
667
+ // pinned by nothing:
668
+ //
669
+ // status -- assertion 22 sweeps payload x id x id-type, plus `null`.
670
+ // latency -- assertion 41 asserts NO `store.find` is issued on this
671
+ // path. Moving the refusal to after a lookup and returning
672
+ // the same 403 left the suite green while re-opening a
673
+ // hit-versus-miss timing difference on every id-bearing POST,
674
+ // which is what would turn #197 from a ~0.06ms post-fetch
675
+ // residual into a live timing oracle on create.
676
+ //
677
+ // AND THE GUARANTEE IS ONLY AS WIDE AS THE CHANNELS IT COVERS. It reads on
678
+ // the `id` member of the resource object, so it holds only while that is
679
+ // the ONLY way a caller id can reach `createRecord`. It was not: the
680
+ // relationships loop below re-admitted one under `key === "id"` and the
681
+ // gate never fired. Both strips -- `attributes.id` and `relationships.id`
682
+ // -- are therefore part of THIS gate, not tidiness, and assertion 39 pins
683
+ // them. Adding a third channel without a strip re-opens the oracle.
684
+ //
685
+ // Scoped to function-style `access` because that is exactly the population
686
+ // the oracle exists for: with no per-record filter there are no hidden
687
+ // records, and 409 discloses nothing GET /:id does not already.
688
+ //
689
+ // RESIDUALS, stated rather than implied.
690
+ //
691
+ // - a caller can still learn that a collection HAS a per-record filter
692
+ // (403 rather than 409/200 for an id-bearing POST). That discloses a
693
+ // configuration fact, not a record.
694
+ // - this gate is about ids arriving on THIS model's create route. It
695
+ // says nothing about a write to ANOTHER collection: a `POST /owners`
696
+ // carrying `relationships: {pets: {data: {id: 21}}}` -- or
697
+ // `attributes: {pets: [21, 22]}`, which never enters the
698
+ // relationships loop at all -- re-parents hidden animal 21 onto an
699
+ // owner the caller may write, which changes the very field the
700
+ // animals predicate reads and DE-HIDES it. Blocking that needs animal
701
+ // 21 checked against the ANIMAL model's predicate while servicing an
702
+ // OWNERS route, i.e. cross-model access resolution: abofs/stonyx-orm
703
+ // #207, blocked on #202 (`access` receives the model structurally)
704
+ // and #196 (setup-rest-server discards the model->predicate map at
705
+ // boot). NOT closed here, and no comment in this file may say it is.
706
+ //
707
+ // See README `### Known limitations`.
708
+ if (id !== undefined) {
709
+ if (typeof filter === 'function')
710
+ return 403; // Forbidden
711
+ // `normalizeBodyId`, not the raw value: a string-typed id misses the
712
+ // store's numeric key, which skipped this check entirely.
713
+ const existing = await store.find(model, normalizeBodyId(id));
714
+ if (existing)
715
+ return 409; // Conflict
716
+ }
240
717
  const { id: _ignoredId, ...sanitizedAttributes } = attributes || {};
241
- // Extract relationship IDs from JSON:API relationships object
718
+ // Extract relationship IDs from JSON:API relationships object.
719
+ //
720
+ // `key` comes VERBATIM from the request body, so `id` is stripped here for
721
+ // exactly the same reason it is stripped from `attributes` on the line
722
+ // above -- and it must be, or GATE 0 is walked around by moving one field:
723
+ //
724
+ // POST /animals {"id":21, ...} -> 403 GATE 0 fires
725
+ // POST /animals {"relationships":{"id":{"data":{"id":21}}},
726
+ // "attributes":{"owner":"gina"}} -> 200 BYPASS
727
+ //
728
+ // Top-level `id` stayed `undefined`, so GATE 0 never fired and the
729
+ // collision lookup never ran; `createRecord` took its last-entry-wins
730
+ // branch, overwrote hidden record 21 in place and reset its `owner` to a
731
+ // value the caller chose -- de-hiding it permanently. That is #190 itself,
732
+ // on the create surface. Pinned by assertion 39.
733
+ //
734
+ // The `id` member of the resource object is now the ONLY channel a caller
735
+ // id can arrive on FOR THIS MODEL'S OWN CREATE ROUTE, which is what makes
736
+ // GATE 0's guarantee checkable rather than merely asserted. It is not a
737
+ // statement about the record's reachability in general -- a relationship
738
+ // write on another collection reaches it without ever touching this
739
+ // handler (abofs/stonyx-orm#207). INHERITED from `dev`, which carries this
740
+ // loop verbatim; the general form -- the loop accepts any key, not just
741
+ // `id`, so a body key that is not a declared relationship is still
742
+ // mass-assigned -- is abofs/stonyx-orm#204.
242
743
  if (rels) {
243
744
  for (const [key, value] of Object.entries(rels)) {
745
+ if (key === 'id')
746
+ continue;
244
747
  const relData = value?.data;
245
748
  if (relData && relData.id !== undefined) {
246
749
  sanitizedAttributes[key] = relData.id;
@@ -248,16 +751,144 @@ export default class OrmRequest extends Request {
248
751
  }
249
752
  }
250
753
  const recordAttributes = id !== undefined ? { id, ...sanitizedAttributes } : sanitizedAttributes;
251
- const created = createRecord(model, recordAttributes, { serialize: false, _skipAutoPersist: true });
754
+ // Slot count BEFORE the write. `createRecord` writes to the store before
755
+ // the predicate can run, and the rollback below must be able to prove the
756
+ // slot it removes is one THIS REQUEST created. Identity alone cannot
757
+ // prove it: when `assignRecordId` lands on an occupied id, `createRecord`
758
+ // mutates the existing OrmRecord IN PLACE, so `store.get(...) === record`
759
+ // is true for a record the request did not create. The map's size is the
760
+ // only O(1) signal that distinguishes an insert from an overwrite.
761
+ const slotsBefore = store.get(model)?.size ?? 0;
762
+ // THE ONE `createRecord` FAILURE THIS ROUTE ANSWERS RATHER THAN
763
+ // PROPAGATES, and it is narrow on purpose.
764
+ //
765
+ // `assignRecordId` throws when it cannot derive a free store key for a
766
+ // server-assigned id. Unguarded that rejection is auto-forwarded -- there
767
+ // is no catch here, none in @stonyx/rest-server's dispatcher
768
+ // (dist/request.js:41-70), and express 5 hands it to its default error
769
+ // handler, which serialises the STACK, with absolute install paths and the
770
+ // internal module graph, to an unauthenticated caller outside
771
+ // NODE_ENV=production. That is the hazard :553-558 already names in this
772
+ // file, and every sibling refusal in this handler returns an integer
773
+ // status instead. So this one returns 409, matching the client-duplicate
774
+ // refusal at :713: the caller asked for a record and the collection has no
775
+ // id to give it.
776
+ //
777
+ // MATCHED ON THE SHARED PREFIX, not on a literal, and NOT by catching
778
+ // everything: `createRecord` also throws for "ORM is not ready", a
779
+ // read-only view and an unregistered model store, and turning any of those
780
+ // into a 409 would report a configuration fault as a conflict. Anything
781
+ // else is re-thrown unchanged.
782
+ let created;
783
+ try {
784
+ created = createRecord(model, recordAttributes, { serialize: false, _skipAutoPersist: true });
785
+ }
786
+ catch (error) {
787
+ if (!(error instanceof Error) || !error.message.startsWith(NO_FREE_ID_ERROR))
788
+ throw error;
789
+ // Not silently. A collection that can no longer assign an id is a
790
+ // configuration fault (a non-injective id transform), and a bare 409
791
+ // with no diagnostic is indistinguishable from an ordinary duplicate.
792
+ log.error?.(`[@stonyx/orm] ${error.message}`);
793
+ return 409; // Conflict
794
+ }
252
795
  const record = isOrmRecord(created) ? created : null;
253
796
  if (!record)
254
797
  return 500;
798
+ const createdNewSlot = (store.get(model)?.size ?? 0) > slotsBefore;
799
+ // 403 here, NOT 404. The oracle argument does not apply to create: there
800
+ // is no pre-existing record whose existence could leak, the caller
801
+ // supplied the attributes, and 404 on a mounted collection route is
802
+ // indistinguishable from "model not mounted" -- a genuinely different
803
+ // failure a developer needs to diagnose.
804
+ //
805
+ // The rollback is not optional. createRecord writes to the store BEFORE
806
+ // the predicate can run, so returning 403 alone would leave the record
807
+ // behind: a worse bug than the bypass being fixed.
808
+ if (isDenied(filter, record)) {
809
+ // ROLL BACK BY IDENTITY, NEVER BY ID. `store.remove(model, record.id)`
810
+ // on its own is a write primitive keyed by a value the caller may have
811
+ // supplied: with the raw-id collision bypass above, a denied
812
+ // `POST {"id":"21"}` answered 403 and DELETED hidden record 21 -- an
813
+ // unauthenticated deletion primitive across the whole id space, created
814
+ // by adding a rollback to a lookup that could be skipped.
815
+ //
816
+ // Both conditions are required and neither implies the other:
817
+ // createdNewSlot -- the store grew, so this request inserted rather
818
+ // than overwrote. SURVIVOR AS OF #203, AND THAT IS
819
+ // WHAT THIS NOTE IS FOR. It used to be killable:
820
+ // `assignRecordId` returned last-INSERTED + 1, so a
821
+ // server-assigned id could land on an occupied slot,
822
+ // `createRecord` updated in place, and removing this
823
+ // half turned access-filter-enforcement-test.ts
824
+ // assertion 31 red. #203 closed that: the
825
+ // server-assigned path now walks past occupied keys,
826
+ // so no create reaching here can overwrite. Measured
827
+ // -- delete `createdNewSlot &&` below: `dev` gives
828
+ // 55 pass / 1 fail with assertion 31 RED, this tree
829
+ // gives 56 pass / 0 fail, GREEN.
830
+ // KEPT ANYWAY, AND NOT FOR THE OLD REASON. Without
831
+ // it a denied create becomes `store.remove` on a key
832
+ // the caller may have influenced, which :815-820
833
+ // records as having been an unauthenticated deletion
834
+ // primitive across the whole id space. BECOMES
835
+ // KILLABLE AGAIN the moment any caller-supplied id
836
+ // can reach `createRecord` from this handler --
837
+ // which is exactly what has-many.ts:65 and
838
+ // belongs-to.ts:45 already do for ANOTHER model's
839
+ // store (abofs/stonyx-orm#207), and what a third
840
+ // un-stripped id channel would do for this one
841
+ // (#204). Do not delete it on the strength of #203
842
+ // being closed; that is the reasoning :862-867 warns
843
+ // about, one level up.
844
+ // identity -- the slot still holds the object we just created,
845
+ // so nothing between createRecord and here replaced
846
+ // it. Deleting this half SURVIVES the suite, and it
847
+ // is kept anyway. WHY IT IS REDUNDANT: there is no
848
+ // `await` anywhere between `slotsBefore` and
849
+ // `store.remove` -- the whole window is synchronous,
850
+ // so it is atomic under Node's event loop; before-
851
+ // `create` hooks run BEFORE the handler
852
+ // (`_withHooks` runs its hook loop ahead of
853
+ // `await handler(...)`), and a consumer predicate
854
+ // inside `isDenied` runs AFTER `createdNewSlot` is
855
+ // computed and cannot flip it. That is a property of
856
+ // THIS function, not of GATE 0 -- an earlier note
857
+ // credited GATE 0, which was both wrong (a caller id
858
+ // reached createRecord through the relationships
859
+ // loop, #204) and the wrong kind of reason: a guard
860
+ // justified on code sixty lines upstream gets
861
+ // silently re-armed when that code moves.
862
+ // SO IT BECOMES REACHABLE IF AN `await` IS
863
+ // INTRODUCED HERE, which is the change a future
864
+ // editor would actually make. Stated here rather
865
+ // than by reference: `docs/` is not in `files`, so
866
+ // a pointer into it resolves to nothing for anyone
867
+ // who installed this package. README carries the
868
+ // consumer-facing half.
869
+ if (createdNewSlot && store.get(model, record.id) === record) {
870
+ store.remove(model, record.id, { _skipAutoPersist: true });
871
+ }
872
+ return 403;
873
+ }
255
874
  return { data: record.toJSON?.({ fields: modelFields }) };
256
875
  };
257
- const updateHandler = async ({ body, params }) => {
876
+ const updateHandler = async ({ body, params }, { filter }) => {
258
877
  const found = await store.find(model, getId(params));
259
878
  if (!found || !isOrmRecord(found))
260
879
  return 404;
880
+ // Checked BEFORE any attribute is applied. 404 rather than 403 for the
881
+ // same reason as GET /:id -- 403 would disclose both that the record
882
+ // exists and that this caller specifically is excluded.
883
+ //
884
+ // NOT redundant behind GATE 1, and not defence in depth either: GATE 1's
885
+ // verdict is computed BEFORE the before-hook loop runs, and a before-hook
886
+ // is a published extension point that can change the answer -- by
887
+ // mutating the record, or against a predicate that closes over
888
+ // per-request state. This is the only re-evaluation after that window.
889
+ // Pinned by assertion 32; deleting it turns a 404 into an applied update.
890
+ if (isDenied(filter, found))
891
+ return 404;
261
892
  const record = found;
262
893
  const { attributes, relationships: rels } = (body?.data || {});
263
894
  if (!attributes && !rels)
@@ -277,6 +908,19 @@ export default class OrmRequest extends Request {
277
908
  if (rels) {
278
909
  const relUpdates = {};
279
910
  for (const [key, value] of Object.entries(rels)) {
911
+ // The same missing key filter as createHandler's, and as the
912
+ // attribute loop directly above -- which already had it, while this
913
+ // loop did not. A PATCH carrying
914
+ // `relationships:{"id":{"data":{"id":9101}}}` reached `updateRecord`
915
+ // and RE-KEYED the record: the object held under store key 9102 then
916
+ // reported id 9101, so a visible record claimed a hidden record's
917
+ // identity on every surface that reads `record.id` rather than the map
918
+ // key. Gated by GATE 1 on the addressed record, so it is store
919
+ // corruption rather than a filter bypass -- but it is the same one-line
920
+ // omission two handlers apart. Pinned by assertion 40; INHERITED from
921
+ // `dev`; abofs/stonyx-orm#204.
922
+ if (key === 'id')
923
+ continue;
280
924
  const relData = value?.data;
281
925
  if (relData && relData.id !== undefined) {
282
926
  relUpdates[key] = relData.id;
@@ -288,8 +932,31 @@ export default class OrmRequest extends Request {
288
932
  }
289
933
  return { data: record.toJSON?.() };
290
934
  };
291
- const deleteHandler = ({ params }) => {
292
- store.remove(model, getId(params));
935
+ const deleteHandler = async ({ params }, { filter }) => {
936
+ // Coerced ONCE. `getId(params)` was evaluated twice here -- once to find
937
+ // the record and once to remove it -- and a coercion evaluated repeatedly
938
+ // is a coercion that can be edited in one place and not the other, which
939
+ // is the defect `coerceId` exists to prevent.
940
+ const recordId = getId(params);
941
+ const record = await store.find(model, recordId);
942
+ // BEHAVIOUR CHANGE (#190): a DELETE of a record that never existed
943
+ // returned 204 before this change. It now returns 404, matching the
944
+ // denied case below. This is deliberate and load-bearing -- if a denied
945
+ // delete returned 404 while a missing one returned 204, the pair would be
946
+ // a perfect existence oracle and the whole fix would be worthless.
947
+ // Returning 204 for a denied delete was rejected instead: it falsely
948
+ // reports success for a request that changed nothing.
949
+ if (!record)
950
+ return 404;
951
+ // Re-evaluated after the before-hook loop, exactly as in updateHandler --
952
+ // GATE 1 decided before the hooks ran. Pinned by assertion 33; deleting it
953
+ // turns a 404 into a destroyed record.
954
+ if (isDenied(filter, record))
955
+ return 404;
956
+ // Removed by the id of the record actually fetched, not by re-deriving it
957
+ // from the params a second time: the record the filter tested and the
958
+ // record removed are then provably the same one.
959
+ store.remove(model, record.id, { _skipAutoPersist: true });
293
960
  return 204;
294
961
  };
295
962
  // Wrap handlers with hooks
@@ -314,9 +981,63 @@ export default class OrmRequest extends Request {
314
981
  };
315
982
  }
316
983
  }
317
- // Wraps a handler with before/after hook execution
984
+ // Wraps a handler with before/after hook execution.
985
+ //
986
+ // ===========================================================================
987
+ // TWO AUTHORIZATION GATES, AND EVERY EXECUTOR SITS BEHIND ONE OF THEM (#190)
988
+ //
989
+ // The defect this function was fixed for is NOT "a delete persists past a
990
+ // 404". It is that _withHooks has SEVERAL executors downstream of the
991
+ // handler, and originally the handler's response gated none of them. Three
992
+ // exist today:
993
+ //
994
+ // 1. sqlDb.persist -- issues real SQL against the backing store
995
+ // 2. the after-hook pipeline -- the PUBLISHED consumer extension point;
996
+ // a cascade delete, a webhook, a search-index
997
+ // purge. `context.recordId` and
998
+ // `context.oldState` are populated for it.
999
+ // 3. Orm.db.save() -- a full serialize-and-write of the store
1000
+ //
1001
+ // Gating them one at a time is how this keeps regressing, so the rule is:
1002
+ // compute denial ONCE at each point where it becomes knowable, and keep every
1003
+ // executor downstream of a gate. If you add a fourth executor to this
1004
+ // function, it goes below GATE 2 or it is a security bug.
1005
+ //
1006
+ // GATE 1 (pre-handler) is required because before-hooks and `context.oldState`
1007
+ // run/are built BEFORE the handler can consult the filter. Without it a denied
1008
+ // DELETE still handed the hidden record's full contents to consumer code.
1009
+ // GATE 2 (post-handler) covers everything the handler's status can reach.
1010
+ // ===========================================================================
318
1011
  _withHooks(operation, handler) {
319
1012
  return async (request, state) => {
1013
+ // `|| {}` so this function behaves like the relationship routes below,
1014
+ // which declare `state` with a `= {}` default. It is unkillable through
1015
+ // the rest-server dispatcher, which always passes `getState(req)`; it is
1016
+ // listed as such in the guards-redundant-by-construction table rather
1017
+ // than left silently unkillable, and it defends the WHOLE function (the
1018
+ // context, the snapshot and the handler call all read `callState`) rather
1019
+ // than one destructure that the next line would throw past anyway.
1020
+ const callState = (state || {});
1021
+ // ---------------------------------------------------------------------
1022
+ // THE AUTHORIZATION SNAPSHOT. Read ONCE, here, before any consumer code
1023
+ // can run.
1024
+ //
1025
+ // `callState` is the object `auth()` planted the filter in, and it is
1026
+ // also handed to every before-hook as `context.state` -- a published,
1027
+ // WRITABLE extension point. So `state.filter` is an INPUT to the
1028
+ // authorization decision, not only an output channel, and re-reading it
1029
+ // after the hook loop lets a consumer hook disarm the filter:
1030
+ //
1031
+ // beforeHook('get', 'animal', ctx => { delete ctx.state.filter })
1032
+ // -> GET /animals/21 turned 404 into 200
1033
+ // -> GET /animals turned 20 records into 22
1034
+ //
1035
+ // GATE 1 already used this snapshot, so writes held; the READ handlers
1036
+ // re-destructured `filter` from the live bag and did not. Everything
1037
+ // downstream now reads `filter` from here, and the handler is handed
1038
+ // `handlerState` below -- never `callState`.
1039
+ // ---------------------------------------------------------------------
1040
+ const { filter } = callState;
320
1041
  // Build context object for hooks
321
1042
  const context = {
322
1043
  model: this.model,
@@ -325,11 +1046,35 @@ export default class OrmRequest extends Request {
325
1046
  params: request.params,
326
1047
  body: request.body,
327
1048
  query: request.query,
328
- state,
1049
+ // Deliberately the LIVE object: `redirect` and `pipe` are read back off
1050
+ // it by @stonyx/rest-server after the handler returns, so hooks must be
1051
+ // able to write to it. What must not happen is the authorization
1052
+ // decision reading it back, which is what the snapshot above prevents.
1053
+ state: callState,
329
1054
  };
330
1055
  // Capture old state for operations that modify data
331
1056
  if (operation === 'update' || operation === 'delete') {
332
1057
  const existingRecord = await store.find(this.model, getId(request.params));
1058
+ // GATE 1 -- pre-handler. This record fetch already happened for
1059
+ // oldState, so the check is free.
1060
+ //
1061
+ // Returning here rather than letting updateHandler/deleteHandler
1062
+ // produce the same 404 is the point: everything between here and there
1063
+ // is an executor the caller is not authorized to reach.
1064
+ // - context.oldState is a deep copy of the HIDDEN RECORD'S CONTENTS.
1065
+ // Building it and handing it to a before-hook discloses exactly what
1066
+ // the filter exists to hide.
1067
+ // - context.recordId is populated for delete BEFORE the handler runs,
1068
+ // which is the same shape as the sqlDb landmine one layer up:
1069
+ // `afterHook('delete', ctx => cascadeDelete(ctx.recordId))` destroys
1070
+ // children behind a correct 404.
1071
+ // - a before-hook may return a value and short-circuit, which would
1072
+ // otherwise return a response without the filter ever executing.
1073
+ //
1074
+ // 404, not 403, for the same reason as getSingleHandler: the status for
1075
+ // "exists but filtered out" must equal "does not exist".
1076
+ if (existingRecord && isDenied(filter, existingRecord))
1077
+ return 404;
333
1078
  if (existingRecord) {
334
1079
  // Deep copy the record's data to preserve old state
335
1080
  context.oldState = JSON.parse(JSON.stringify(existingRecord.__data || existingRecord));
@@ -347,10 +1092,49 @@ export default class OrmRequest extends Request {
347
1092
  }
348
1093
  }
349
1094
  // Execute main handler
350
- const response = await handler(request, state);
351
- // Persist to SQL database for create/update (delete is handled by store.remove auto-persist)
1095
+ // The handler receives the SNAPSHOT, never the live bag. `filter` is
1096
+ // assigned LAST so it wins over anything a before-hook wrote to
1097
+ // `callState.filter` -- including a `delete`, which the spread would
1098
+ // otherwise carry through as an absent key. Every other key a hook adds
1099
+ // is still visible to the handler; only the authorization input is
1100
+ // pinned.
1101
+ const handlerState = { ...callState, filter };
1102
+ const response = await handler(request, handlerState);
1103
+ // Set context.record for update BEFORE persist so SQL drivers can read it
1104
+ if (operation === 'update' && response?.data) {
1105
+ context.record = store.get(this.model, getId(request.params));
1106
+ }
1107
+ // GATE 2 -- post-handler. A denied or failed handler returns a bare status
1108
+ // integer, and no executor below may run for one.
1109
+ //
1110
+ // `>= 400` deliberately covers every failure status, not just the
1111
+ // authorization ones: a 400 (POST with no `type`) and a 409 (duplicate id)
1112
+ // are equally requests in which nothing happened, and a persist or a
1113
+ // cascade hook for one of them is just as wrong.
1114
+ // `Number.isInteger` is a TYPE guard, not a behaviour guard, and it is
1115
+ // unkillable TODAY: the only non-integer a handler in this file can
1116
+ // return is a `{ data, links }` object, and `{} >= 400` is `false` by JS
1117
+ // coercion, so dropping it changes no reachable outcome. It is kept
1118
+ // because `>=` coerces rather than rejects, and the shapes it coerces
1119
+ // are not obvious -- `[500] >= 400` is TRUE, so a handler that one day
1120
+ // returned an array would have every response read as a denial. Listed
1121
+ // as an equivalent mutant rather than left to read as coverage; it
1122
+ // becomes killable the moment a handler returns anything array-like or
1123
+ // numeric-string-like.
1124
+ const denied = Number.isInteger(response) && response >= 400;
1125
+ // EXECUTOR 1 -- SQL persistence, for all write operations.
1126
+ //
1127
+ // `response` is passed to sqlDb.persist below, but it is dropped at the
1128
+ // driver boundary: _persistDelete(modelName, context) never receives it
1129
+ // and guards only on context.recordId -- which _withHooks set above,
1130
+ // BEFORE the handler ran. Without this gate a correct 404 still issues
1131
+ // DELETE FROM ... WHERE id = ? on every SQL backend.
1132
+ //
1133
+ // No file-backed test can observe that, because Orm.instance.sqlDb is
1134
+ // null in file/directory mode. See the stubbed-sqlDb assertions in
1135
+ // test/unit/access-filter-enforcement-test.ts.
352
1136
  const sqlDb = Orm.instance.sqlDb;
353
- if (sqlDb && (operation === 'create' || operation === 'update')) {
1137
+ if (sqlDb && WRITE_OPERATIONS.has(operation) && !denied) {
354
1138
  await sqlDb.persist(operation, this.model, context, response);
355
1139
  }
356
1140
  // Add response and relevant records to context
@@ -364,22 +1148,44 @@ export default class OrmRequest extends Request {
364
1148
  else if (operation === 'create' && response?.data && (response.data.id)) {
365
1149
  // For create, get the record from store using the ID from the response
366
1150
  const responseData = response.data;
367
- const recordId = isNaN(responseData.id) ? responseData.id : parseInt(responseData.id);
368
- context.record = store.get(this.model, recordId);
369
- }
370
- else if (operation === 'update' && response?.data) {
371
- context.record = store.get(this.model, getId(request.params));
1151
+ // `normalizeBodyId`, not a copy of its body. This line WAS
1152
+ // `isNaN(id) ? id : parseInt(id)` -- `coerceId` inlined verbatim, a
1153
+ // third coercion feeding a store lookup, sitting under a docblock that
1154
+ // said neither surface had a copy. Equivalent on every input that can
1155
+ // reach this truthy-guarded branch (`21`->`21`, `'21'`->`21`,
1156
+ // `'angela'`->`'angela'`; `''` and `0` cannot reach it), so this is a
1157
+ // de-duplication rather than a behaviour change -- and that is the
1158
+ // point: the two that disagreed were equivalent on every input anyone
1159
+ // checked, too.
1160
+ context.record = store.get(this.model, normalizeBodyId(responseData.id));
372
1161
  }
373
1162
  else if (operation === 'delete') {
374
1163
  // For delete, the record may no longer exist, but we have oldState
375
1164
  context.recordId = getId(request.params);
376
1165
  }
377
- // Run after hooks sequentially
378
- for (const hook of getAfterHooks(operation, this.model)) {
379
- await hook(context);
1166
+ // EXECUTOR 2 -- the after-hook pipeline. This is the published consumer
1167
+ // extension point (`afterHook` is exported from @stonyx/orm and from
1168
+ // ./hooks), so it is the executor with the widest possible blast radius:
1169
+ // a cascade delete, a webhook, a token revocation, a search-index purge.
1170
+ //
1171
+ // BEHAVIOUR CHANGE (#190): after-hooks no longer fire for a request that
1172
+ // failed. Previously `afterHook('delete', ...)` ran with a populated
1173
+ // context.recordId on a 404, so a consumer cascade destroyed children for
1174
+ // a request that deleted nothing. Firing a hook named "after<operation>"
1175
+ // for an operation that did not occur is a booby trap, and the denied case
1176
+ // is unreachable-before-#190 while the missing case is inherited debt --
1177
+ // both are closed by the same gate. `context.response` therefore only ever
1178
+ // carries a success status into a hook.
1179
+ if (!denied) {
1180
+ for (const hook of getAfterHooks(operation, this.model)) {
1181
+ await hook(context);
1182
+ }
380
1183
  }
381
- // Auto-save DB after write operations when configured
382
- if (config.orm.db.autosave === 'onUpdate' && WRITE_OPERATIONS.has(operation)) {
1184
+ // EXECUTOR 3 -- file/directory autosave. Ungated this let an
1185
+ // unauthenticated caller force a full serialize-and-write of the entire
1186
+ // store on every DELETE of any id, with no record touched: amplification
1187
+ // rather than corruption, but the same root cause and the same fix.
1188
+ if (config.orm.db.autosave === 'onUpdate' && WRITE_OPERATIONS.has(operation) && !denied) {
383
1189
  await Orm.db.save();
384
1190
  }
385
1191
  return response;
@@ -391,10 +1197,21 @@ export default class OrmRequest extends Request {
391
1197
  // Dasherize the relationship name for URL paths (e.g., accessLinks -> access-links)
392
1198
  const dasherizedName = camelCaseToKebabCase(relationshipName);
393
1199
  // Related resource route: GET /:id/{relationship}
394
- routes[`/:id/${dasherizedName}`] = async (request) => {
1200
+ //
1201
+ // These generated routes are not wrapped by _withHooks, which is why they
1202
+ // were the least obvious two of the seven unguarded surfaces in #190.
1203
+ // They are still dispatched by @stonyx/rest-server as
1204
+ // `handler(req, getState(req))`, so `state` -- and therefore the filter
1205
+ // planted by auth() -- has always been available here; it was simply
1206
+ // never declared or read.
1207
+ routes[`/:id/${dasherizedName}`] = async (request, { filter } = {}) => {
395
1208
  const record = await store.find(model, getId(request.params));
396
1209
  if (!record)
397
1210
  return 404;
1211
+ // Filtering the PARENT: a caller who may not see the record may not see
1212
+ // what it is related to either.
1213
+ if (isDenied(filter, record))
1214
+ return 404;
398
1215
  const relatedData = record.__relationships[relationshipName];
399
1216
  const baseUrl = getBaseUrl(request);
400
1217
  let data;
@@ -413,10 +1230,12 @@ export default class OrmRequest extends Request {
413
1230
  };
414
1231
  };
415
1232
  // Relationship linkage route: GET /:id/relationships/{relationship}
416
- routes[`/:id/relationships/${dasherizedName}`] = async (request) => {
1233
+ routes[`/:id/relationships/${dasherizedName}`] = async (request, { filter } = {}) => {
417
1234
  const record = await store.find(model, getId(request.params));
418
1235
  if (!record)
419
1236
  return 404;
1237
+ if (isDenied(filter, record))
1238
+ return 404;
420
1239
  const relatedData = record.__relationships[relationshipName];
421
1240
  const baseUrl = getBaseUrl(request);
422
1241
  let data;
@@ -445,31 +1264,138 @@ export default class OrmRequest extends Request {
445
1264
  };
446
1265
  };
447
1266
  }
448
- // Catch-all for invalid relationship names on related resource route
449
- routes[`/:id/:relationship`] = async (request) => {
450
- const record = await store.find(model, getId(request.params));
451
- if (!record)
452
- return 404;
453
- // If we reach here, relationship doesn't exist (valid ones were registered above)
454
- return 404;
455
- };
456
- // Catch-all for invalid relationship names on relationship linkage route
457
- routes[`/:id/relationships/:relationship`] = async (request) => {
458
- const record = await store.find(model, getId(request.params));
459
- if (!record)
460
- return 404;
461
- return 404;
462
- };
1267
+ // Catch-alls for invalid relationship names. Every valid relationship was
1268
+ // registered above, so reaching either of these means the relationship does
1269
+ // not exist and the answer is 404 regardless of the record.
1270
+ //
1271
+ // These deliberately carry NO access check and no store lookup. An earlier
1272
+ // revision of #190 added `if (isDenied(filter, record)) return 404` here for
1273
+ // symmetry with the seven real surfaces, but both branches returned 404, so
1274
+ // the guard was unobservable by construction -- a mutation deleting it
1275
+ // survived the entire suite because no test that could distinguish it can
1276
+ // exist. Unkillable code in an authorization diff reads as coverage and is
1277
+ // not, so it is gone; skipping the lookup also removes the timing difference
1278
+ // between an existing and a missing parent.
1279
+ //
1280
+ // IF THIS ROUTE EVER RETURNS ANYTHING OTHER THAN A CONSTANT 404, it becomes
1281
+ // the eighth surface and must filter the parent first, exactly like
1282
+ // `/:id/{relationship}` above.
1283
+ routes[`/:id/:relationship`] = async () => 404;
1284
+ routes[`/:id/relationships/:relationship`] = async () => 404;
463
1285
  return routes;
464
1286
  }
465
1287
  auth(request, state) {
466
- const access = this.access(request);
1288
+ // A consumer `access()` that throws is a DENIAL, matching `isDenied` one
1289
+ // layer down. Unguarded it propagates to express's default handler, which
1290
+ // answers 500 -- and the documented sample itself can throw
1291
+ // (`request.originalUrl.split(...)` when originalUrl is absent), so the
1292
+ // failure mode is reachable by following the docs.
1293
+ // -------------------------------------------------------------------------
1294
+ // #202 -- hand the consumer the STRUCTURAL facts, not just the transport.
1295
+ //
1296
+ // Both members are already in hand here. `model` is `this.model`, the name
1297
+ // setup-rest-server mounted this route for; `operation` is the SAME
1298
+ // `methodAccessMap` lookup the permission-array branch at the bottom of
1299
+ // this method performs, so the predicate form and the array form cannot
1300
+ // answer differently about the same request.
1301
+ //
1302
+ // NEITHER IS DERIVED FROM THE REQUEST TARGET, and that is the whole point.
1303
+ // Deriving `model` here from `request.baseUrl` (or from the mounted route
1304
+ // name, or from `getPluralName(this.model)`) would move all five fail-open
1305
+ // variants listed in this file's header OUT of the consumer and INTO the
1306
+ // framework, where every consumer inherits them at once. `this.model` is
1307
+ // assigned once at mount time and no request can influence it.
1308
+ //
1309
+ // `operation` is left UNDEFINED for a method with no entry in
1310
+ // `methodAccessMap`, rather than defaulted. Express delivers HEAD to the
1311
+ // GET handler, so an unmapped method really does reach this line; a
1312
+ // `?? 'read'` here would hand the consumer a fabricated authorisation fact
1313
+ // and turn an unclassified request into an authorised one. Undefined is
1314
+ // the honest answer.
1315
+ //
1316
+ // `record` is deliberately absent -- see `AccessContext` in
1317
+ // src/types/orm-types.ts. Nothing is fetched at this point and adding a
1318
+ // lookup here would put a store read in the middle of an authorization
1319
+ // path. The function return shape below IS the per-record hook.
1320
+ //
1321
+ // -------------------------------------------------------------------------
1322
+ // #236 -- `recordId`, the DECODED route-parameter id, for the same reason.
1323
+ //
1324
+ // WHICH RECORD is the third structural fact the framework already holds and
1325
+ // the consumer was left to re-derive, and re-deriving it failed OPEN. The
1326
+ // documented sample compared `request.path` -- the RAW, undecoded pathname
1327
+ // -- against a literal `/archived`, while the router DECODES `:id`. So
1328
+ // `GET /owners/%61rchived` walked past the deny and was dispatched as the
1329
+ // record `archived`: 200 with the record in full, and DELETE answered 204
1330
+ // with the record destroyed, unauthenticated. Four spellings measured, all
1331
+ // four through; 255 non-canonical spellings of that 8-character id decode
1332
+ // to the same key, so this was never a deny-list of one.
1333
+ //
1334
+ // TWO CONSUMER-SIDE NORMALISATIONS WERE MEASURED WRONG IN OPPOSITE
1335
+ // DIRECTIONS, which is the argument for doing it once, here.
1336
+ // `.toLowerCase()` case-folds a route-parameter VALUE on the axis that
1337
+ // governs literal SEGMENTS: with a distinct owner seeded at `ARCHIVED`,
1338
+ // `GET /owners/ARCHIVED` was a false DENY on the wrong record and
1339
+ // `GET /owners/%41RCHIVED` a false ALLOW on that same one.
1340
+ // `decodeURIComponent(request.path)` decodes THEN splits while the router
1341
+ // splits THEN decodes, so it over-denied `/owners/archived%2fx` -- 403 for
1342
+ // a genuinely distinct record. Failing closed there was luck, not design.
1343
+ //
1344
+ // `getId(request.params)` AND NOT `request.params.id`, for exactly the
1345
+ // reason `operation` is a `methodAccessMap` lookup: it is the SAME single
1346
+ // coercion the store lookup one layer down performs, so the predicate and
1347
+ // the dispatch cannot disagree about which record a request addresses.
1348
+ // The raw string would reintroduce that divergence on hex-shaped ids --
1349
+ // `GET /animals/0x2391` looks up record `9105`.
1350
+ //
1351
+ // NOTHING HERE PARSES THE REQUEST TARGET EITHER. `request.params` is what
1352
+ // the router matched, so a mount prefix, an absolute-form target, a query
1353
+ // string or a case-varied mount cannot move this value -- the same
1354
+ // guarantee `model` carries, by the same means.
1355
+ //
1356
+ // `null` and not `undefined` on a collection route, so the KEY IS ALWAYS
1357
+ // PRESENT -- the rule `operation`'s own docblock already establishes. A
1358
+ // context reaching a predicate WITHOUT the key therefore did not come from
1359
+ // here; it was hand-assembled by a caller resolving the predicate through
1360
+ // `Orm.instance.getAccess()`, and that absence stays deniable only because
1361
+ // `auth()` never produces it.
1362
+ // -------------------------------------------------------------------------
1363
+ const context = {
1364
+ model: this.model,
1365
+ operation: methodAccessMap[request.method],
1366
+ recordId: request.params && 'id' in request.params ? getId(request.params) : null,
1367
+ };
1368
+ let access;
1369
+ try {
1370
+ access = this.access(request, context);
1371
+ }
1372
+ catch (error) {
1373
+ // Same reasoning as `isDenied`: fail closed, but say so. An `access()`
1374
+ // that throws denies EVERY request to the collection, and a silent 403
1375
+ // wall is the hardest possible thing to diagnose from the outside.
1376
+ log.error?.(`[@stonyx/orm] access() threw for model "${this.model}" -- denying. ${error instanceof Error ? error.message : String(error)}`);
1377
+ return 403; // Forbidden
1378
+ }
467
1379
  if (!access)
468
1380
  return 403;
469
- if (Array.isArray(access) && !access.includes(methodAccessMap[request.method]))
470
- return 403;
471
- if (typeof access === 'function')
1381
+ if (typeof access === 'function') {
472
1382
  state.filter = access;
1383
+ return undefined;
1384
+ }
1385
+ if (access === true)
1386
+ return undefined;
1387
+ // `AccessMethod` declares `string` legal and it fell through every branch
1388
+ // above, returning undefined -- i.e. FULL CRUD, no filter. `return 'read'`
1389
+ // is the natural reading of a type that lists `string` first, and it
1390
+ // granted DELETE. A bare string is one permission, not a grant of all four.
1391
+ const permitted = typeof access === 'string' ? [access] : access;
1392
+ // Anything that is not a permission array by this point -- an object, a
1393
+ // number, a Symbol -- is a consumer mistake, and the only safe reading of a
1394
+ // shape the contract does not define is a denial. Fail CLOSED.
1395
+ if (!Array.isArray(permitted))
1396
+ return 403;
1397
+ if (!permitted.includes(methodAccessMap[request.method]))
1398
+ return 403;
473
1399
  return undefined;
474
1400
  }
475
1401
  }