@stonyx/orm 0.3.2-alpha.8 → 0.3.2-alpha.80

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 (65) hide show
  1. package/README.md +1137 -11
  2. package/config/environment.js +8 -0
  3. package/dist/access-verdict.d.ts +85 -0
  4. package/dist/access-verdict.js +284 -0
  5. package/dist/commands.js +34 -0
  6. package/dist/dynamodb/connection.d.ts +31 -0
  7. package/dist/dynamodb/connection.js +28 -0
  8. package/dist/dynamodb/dynamodb-db.d.ts +142 -0
  9. package/dist/dynamodb/dynamodb-db.js +596 -0
  10. package/dist/dynamodb/operation-builder.d.ts +76 -0
  11. package/dist/dynamodb/operation-builder.js +116 -0
  12. package/dist/dynamodb/type-map.d.ts +31 -0
  13. package/dist/dynamodb/type-map.js +48 -0
  14. package/dist/hooks.d.ts +15 -1
  15. package/dist/index.d.ts +3 -0
  16. package/dist/index.js +8 -0
  17. package/dist/main.d.ts +116 -0
  18. package/dist/main.js +129 -0
  19. package/dist/manage-record.js +268 -12
  20. package/dist/mysql/connection.d.ts +1 -0
  21. package/dist/mysql/mysql-db.d.ts +8 -0
  22. package/dist/mysql/mysql-db.js +44 -10
  23. package/dist/orm-request.d.ts +264 -3
  24. package/dist/orm-request.js +1138 -61
  25. package/dist/postgres/connection.d.ts +1 -0
  26. package/dist/postgres/connection.js +8 -6
  27. package/dist/postgres/postgres-db.d.ts +8 -0
  28. package/dist/postgres/postgres-db.js +44 -10
  29. package/dist/record.d.ts +16 -0
  30. package/dist/record.js +154 -6
  31. package/dist/relationships.js +1 -1
  32. package/dist/serializer.js +38 -2
  33. package/dist/setup-rest-server.js +51 -5
  34. package/dist/standalone-db.js +17 -5
  35. package/dist/store.d.ts +13 -1
  36. package/dist/store.js +65 -6
  37. package/dist/types/orm-types.d.ts +234 -0
  38. package/dist/utils.d.ts +44 -0
  39. package/dist/utils.js +47 -0
  40. package/package.json +16 -7
  41. package/src/access-verdict.ts +312 -0
  42. package/src/commands.ts +43 -0
  43. package/src/dynamodb/connection.ts +50 -0
  44. package/src/dynamodb/dynamodb-db.ts +811 -0
  45. package/src/dynamodb/operation-builder.ts +202 -0
  46. package/src/dynamodb/type-map.ts +54 -0
  47. package/src/hooks.ts +15 -1
  48. package/src/index.ts +10 -0
  49. package/src/main.ts +133 -0
  50. package/src/manage-record.ts +294 -18
  51. package/src/mysql/connection.ts +1 -0
  52. package/src/mysql/mysql-db.ts +44 -12
  53. package/src/orm-request.ts +1159 -63
  54. package/src/postgres/connection.ts +10 -6
  55. package/src/postgres/postgres-db.ts +44 -12
  56. package/src/record.ts +182 -6
  57. package/src/relationships.ts +1 -1
  58. package/src/serializer.ts +39 -2
  59. package/src/setup-rest-server.ts +59 -6
  60. package/src/standalone-db.ts +17 -6
  61. package/src/store.ts +68 -6
  62. package/src/types/orm-types.ts +242 -1
  63. package/src/types/stonyx-rest-server.d.ts +14 -1
  64. package/src/types/stonyx.d.ts +7 -1
  65. package/src/utils.ts +50 -0
@@ -1,3 +1,264 @@
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';
@@ -5,8 +266,10 @@ import { getPluralName } from './plural-registry.js';
5
266
  import { getBeforeHooks, getAfterHooks } from './hooks.js';
6
267
  import type { HookContext } from './hooks.js';
7
268
  import config from 'stonyx/config';
8
- import type { OrmRecord } from './types/orm-types.js';
9
- import { isOrmRecord } from './utils.js';
269
+ import log from 'stonyx/log';
270
+ import type { OrmRecord, AccessContext, AccessFunction, AccessMethod, AccessOperation, LinkageFilter } from './types/orm-types.js';
271
+ import { isOrmRecord, NO_FREE_ID_ERROR } from './utils.js';
272
+ import { interpretAccess, createLinkageFilter } from './access-verdict.js';
10
273
 
11
274
  interface OrmRequest$ extends Request {
12
275
  protocol?: string;
@@ -33,10 +296,9 @@ interface JsonApiResponse {
33
296
  included?: unknown[];
34
297
  }
35
298
 
36
- type AccessMethod = string | boolean | string[] | ((record: unknown) => boolean);
37
299
  type HandlerFn = (request: OrmRequest$, state: { [key: string]: unknown }) => unknown | Promise<unknown>;
38
300
 
39
- const methodAccessMap: { [key: string]: string } = {
301
+ const methodAccessMap: { [key: string]: AccessOperation } = {
40
302
  GET: 'read',
41
303
  POST: 'create',
42
304
  DELETE: 'delete',
@@ -84,21 +346,128 @@ function getBaseUrl(request: OrmRequest$): string {
84
346
  return `${protocol}://${host}`;
85
347
  }
86
348
 
349
+ /**
350
+ * The ONE coercion from a caller-supplied id to the key the store holds it
351
+ * under. Every id-bearing surface in this file goes through it, and none has a
352
+ * copy: `getId()` (URL params), `normalizeBodyId()` (JSON body), and the
353
+ * post-create `context.record` lookup in `_withHooks`.
354
+ *
355
+ * WHY IT IS SHARED RATHER THAN DUPLICATED. `getId()` and `normalizeBodyId()`
356
+ * each had their own arithmetic, and they disagreed: `parseInt(id)` versus
357
+ * `parseInt(id, 10)`. On a hex-shaped id that is a two-record difference --
358
+ *
359
+ * GET /animals/0x2391 -> record 9105 (getId -> parseInt('0x2391') = 9105)
360
+ * POST /animals {"id":"0x2391"} -> lookup under 0 (normalize -> parseInt('0x2391',10) = 0)
361
+ * -> a MISS, so the duplicate check was skipped and
362
+ * createRecord OVERWROTE 9105 in place, answering 200
363
+ *
364
+ * -- a narrower form of the raw-versus-normalised divergence that the body-id
365
+ * normalisation was added to close, reintroduced by the fix for it. Two
366
+ * coercions that must agree cannot be kept in agreement by review; they have to
367
+ * be one function. Pinned by assertion 43.
368
+ *
369
+ * The third copy was found later and in a quieter place: `_withHooks` populated
370
+ * `context.record` for `create` with `isNaN(id) ? id : parseInt(id)` -- this
371
+ * function's body, inlined verbatim, feeding `store.get`. It was equivalent on
372
+ * every input reachable there, which is exactly what the two that DID diverge
373
+ * looked like until someone tried a hex id.
374
+ *
375
+ * SHARING IT IS NOT THE SAME AS IT BEING RIGHT EVERYWHERE. On a model declaring
376
+ * `id = attr('string')` a numeric-looking id is filed under the STRING key, so
377
+ * this coercion resolves `'9107'` to `9107` and the post-create lookup misses:
378
+ * `context.record` is `undefined` for an after-`create` hook. Inherited -- the
379
+ * inlined copy computed the same thing -- and NOT fixed here, because picking
380
+ * the right coercion needs the model's declared id type, which is the same
381
+ * structural information abofs/stonyx-orm#202 is about. Filed as
382
+ * abofs/stonyx-orm#209 and pinned by assertion 50, so closing it turns a test
383
+ * red rather than passing silently.
384
+ *
385
+ * `parseInt` and not `Number`, deliberately, and the anchor is NOT `getId`.
386
+ * It is `src/transforms.ts:7` -- `number: (value) => parseInt(value as string)`,
387
+ * also radix-less -- because that transform is what actually produces the store
388
+ * KEY a record is filed under. `getId` merely agrees with it. They differ from
389
+ * `Number` on `'1e3'` (1 vs 1000) and `'9105.5'` (9105 vs 9105.5), so switching
390
+ * this function to `Number` would make the lookup key disagree with the landing
391
+ * key on those shapes.
392
+ *
393
+ * THE CHANGE THAT WOULD BREAK THIS: adding a radix to `transforms.number`
394
+ * (`parseInt(value, 10)`). That is a one-word edit in a file with no connection
395
+ * to authorization, it would silently reopen the hex divergence in the other
396
+ * direction, and this comment would still read as correct. Assertion 45 pins
397
+ * the transform's radix-less shape directly, so that edit turns a test red
398
+ * rather than shipping.
399
+ *
400
+ * The reason `parseInt` is safe here is the `isNaN` gate in front of it:
401
+ * `parseInt('9105h')` is `9105`, and truncating a partially-valid id into a
402
+ * DIFFERENT VALID key is exactly how a collision lookup gets skipped. The gate
403
+ * rejects it as a string instead, so nothing is ever truncated. That gate, not
404
+ * the parser, is the load-bearing half -- assertion 43 pins it.
405
+ */
406
+ function coerceId(id: string): string | number {
407
+ if (isNaN(id as unknown as number)) return id;
408
+
409
+ return parseInt(id);
410
+ }
411
+
87
412
  function getId(params: { id?: string; [key: string]: unknown }): string | number {
88
413
  const id = params.id;
89
414
  if (!id) return '';
90
- if (isNaN(id as unknown as number)) return id;
91
415
 
92
- return parseInt(id);
416
+ return coerceId(id);
417
+ }
418
+
419
+ /**
420
+ * Normalise a caller-supplied BODY id to the key the store will hold it under.
421
+ *
422
+ * `getId()` above is params-shaped: it takes `{ id?: string }` off the URL,
423
+ * where the value is always a string and a falsy one means "no id". A JSON body
424
+ * id is neither -- it can arrive as a number, and `0` is a legitimate id that
425
+ * `getId()` would flatten to `''`.
426
+ *
427
+ * WHY THIS EXISTS AT ALL. createHandler used to look the collision up with the
428
+ * RAW body value while every other surface normalised through `getId()`. The
429
+ * store is a Map keyed by the coerced value, so `store.find(model, '21')` misses
430
+ * the entry held under `21` and the duplicate check is skipped by typing the id
431
+ * as a string. On `dev` that silently overwrote the colliding record and
432
+ * answered 200; combined with the denied-create rollback added for #190 it
433
+ * became an unauthenticated DELETE of any id. Normalising here is half of that
434
+ * fix -- see the rollback in createHandler for the other half.
435
+ *
436
+ * It shares `coerceId` with `getId` so the two surfaces cannot drift apart
437
+ * again, and differs from `getId` in exactly ONE place, below.
438
+ */
439
+ function normalizeBodyId(id: string | number): string | number {
440
+ // Non-strings pass through untouched: a JSON body id can arrive as a number,
441
+ // and `getId`'s falsy-flatten must NOT apply to it -- `0` is a legitimate id
442
+ // and `getId` would turn it into `''`. (assertion 30 sweeps id `0`.)
443
+ if (typeof id !== 'string') return id;
444
+
445
+ // THE ONE DIVERGENCE FROM `getId`, and it mirrors rather than contradicts it:
446
+ // `getId` maps a falsy param to `''`, and `''` is the only string a body can
447
+ // carry that means "no id" -- `createRecord` treats it as absent and assigns a
448
+ // server id. Coercing it instead would make it address a real slot, because
449
+ // `parseInt('')` is `NaN` and a record CAN be held under `NaN` (a truthy but
450
+ // non-numeric id such as `' '` survives `assignRecordId`'s falsy guard and
451
+ // then NaNs in the id transform). So `POST {"id":""}` would answer 409 against
452
+ // an unrelated record it never named. Pinned by assertion 44.
453
+ //
454
+ // Note what is deliberately NOT special-cased here any more: whitespace.
455
+ // `id.trim() === ''` used to short-circuit `' '` as well, which made the
456
+ // body surface DISAGREE with the URL surface -- `getId({id:' '})` is `NaN`,
457
+ // so `' '` addresses the NaN slot on every other route while the collision
458
+ // lookup missed it. Same class of bug as the hex divergence above.
459
+ if (id === '') return id;
460
+
461
+ return coerceId(id);
93
462
  }
94
463
 
95
464
  function buildResponse(
96
465
  data: unknown,
97
466
  includeParam: string | undefined,
98
467
  recordOrRecords: OrmRecord | OrmRecord[],
99
- options: { links?: { [key: string]: string }; baseUrl?: string } = {}
468
+ options: { links?: { [key: string]: string }; baseUrl?: string; linkage?: LinkageFilter } = {}
100
469
  ): JsonApiResponse {
101
- const { links, baseUrl } = options;
470
+ const { links, baseUrl, linkage } = options;
102
471
  const response: JsonApiResponse = { data };
103
472
 
104
473
  // Add top-level links
@@ -113,7 +482,53 @@ function buildResponse(
113
482
 
114
483
  const includedRecords = collectIncludedRecords(recordOrRecords, includes);
115
484
  if (includedRecords.length > 0) {
116
- response.included = includedRecords.map(record => record.toJSON?.({ baseUrl }));
485
+ // LINKAGE, NOT MEMBERSHIP -- and the distinction is the whole reason this
486
+ // line is one story's and the line above it is another's
487
+ // (abofs/stonyx-orm#235 and #233 respectively).
488
+ //
489
+ // - WHICH RESOURCES REACH THIS ARRAY is decided by
490
+ // `collectIncludedRecords` on the line above. That is MEMBERSHIP, it is
491
+ // #233's, and it is deliberately untouched here: a hidden owner is
492
+ // still a member of `included` after this change. Pinned green by
493
+ // `[GUARD] #235 X1` so that #235 cannot close #233 incidentally.
494
+ // - WHAT A RECORD ALREADY IN THIS ARRAY MAY NAME in its own
495
+ // `relationships.*.data` is LINKAGE -- the same question #234 answers
496
+ // for the primary document -- and that is what the `linkage` option
497
+ // below decides. Before it, `GET /animals/1?include=owner,owner.pets`
498
+ // filtered the primary document's `owner.data` to `null` and then
499
+ // handed back eight PERMITTED animals in `included` each naming
500
+ // `{"type":"owner","id":"angela"}` -- angela's whole `pets` set,
501
+ // `[1, 3, 7, 10, 11, 15, 17, 20]`. `included` itself is NINE
502
+ // resources there: those eight animals plus the hidden owner, whose
503
+ // membership is #233's and not an animal. Neither #233 nor #234
504
+ // closes that.
505
+ //
506
+ // THE FILTER IS THE CALLER'S, PASSED IN, NOT BUILT HERE. Both call sites
507
+ // already hold one for the primary document, and sharing it is what keeps
508
+ // the per-type verdict cache and the per-(type, id) decision cache alive
509
+ // across the primary document AND the sideload -- one verdict resolution
510
+ // per type for the whole response, pinned by `[GUARD] #235 C1`. Building a
511
+ // fresh filter here would resolve the consumer's `access()` once per
512
+ // included record instead.
513
+ //
514
+ // `linkage` IS OPTIONAL IN THE TYPE AND IS NOT OPTIONAL IN PRACTICE.
515
+ // Stating it precisely because the opposite claim stood here in an earlier
516
+ // draft of this change: BOTH of this function's callers supply a filter
517
+ // (`getCollectionHandler` and `getSingleHandler`, the only two), so the
518
+ // `undefined` branch has no live caller in this module today. It is
519
+ // optional so that omitting it degrades to the PRE-#234 document rather
520
+ // than to a denial -- `Record.toJSON` reads an ABSENT option as "no verdict
521
+ // was supplied" and emits linkage in full.
522
+ //
523
+ // WHAT IT MUST NEVER BE HANDED IS A NON-FUNCTION. `toJSON` does NOT read a
524
+ // non-function as absent: `Object.prototype.toString.call(linkage)` must be
525
+ // `'[object Function]'`, and anything else -- `null`, an `AsyncFunction`,
526
+ // and INCLUDING the primitive `true` -- DENIES every relationship on the
527
+ // document and logs once. `toJSON({ linkage: true })` emits `null` linkage.
528
+ // So do not "simplify" this to a boolean, and do not make it default to
529
+ // `true`: both spellings look like "allow everything" and mean the exact
530
+ // opposite (abofs/stonyx-orm#224).
531
+ response.included = includedRecords.map(record => record.toJSON?.({ baseUrl, linkage }));
117
532
  }
118
533
 
119
534
  return response;
@@ -251,12 +666,46 @@ function createFilterPredicate(filters: Filter[]): ((record: { [key: string]: un
251
666
  });
252
667
  }
253
668
 
669
+ /**
670
+ * A function-style `access` return is a per-record predicate, and it is only
671
+ * meaningful if every surface that can hand a record to a caller consults it.
672
+ * Before #190 exactly one of seven did.
673
+ *
674
+ * Enforcement is deliberately post-fetch. `access` returns an opaque JS
675
+ * predicate and `store.findAll(model, conditions)` accepts only an equality
676
+ * conditions object that the SQL drivers translate to a WHERE clause, so
677
+ * query-layer enforcement would require a breaking change to the published
678
+ * `access` contract. That belongs in #197, not in a security patch. Six of the
679
+ * seven surfaces fetch by primary key anyway, so this costs exactly one row.
680
+ */
681
+ function isDenied(filter: unknown, record: unknown): boolean {
682
+ if (typeof filter !== 'function') return false;
683
+
684
+ // A predicate that throws is treated as a denial. Unguarded, a throw escapes
685
+ // to express's default handler, which answers 500 (with a stack trace outside
686
+ // NODE_ENV=production) while a missing id still answers 404 -- so a
687
+ // record-dependent throw re-separates "hidden" from "does not exist" and
688
+ // hands back the oracle this whole change exists to close.
689
+ try {
690
+ return !(filter as (record: unknown) => boolean)(record);
691
+ } catch (error) {
692
+ // Denied, but not silently. A consumer predicate that throws on every
693
+ // record turns the whole collection into a 404 wall, and with no
694
+ // diagnostic that is indistinguishable from an empty database. `stonyx/log`
695
+ // is the module convention (see setup-rest-server.ts); optional-call
696
+ // because a consumer may not have configured the log types.
697
+ log.error?.(`[@stonyx/orm] access filter threw for model -- denying. ${error instanceof Error ? error.message : String(error)}`);
698
+
699
+ return true;
700
+ }
701
+ }
702
+
254
703
  export default class OrmRequest extends Request {
255
704
  model: string;
256
- access: (request: unknown) => AccessMethod;
705
+ access: AccessFunction;
257
706
  handlers: { [key: string]: { [key: string]: HandlerFn } };
258
707
 
259
- constructor({ model, access }: { model: string; access: (request: unknown) => AccessMethod }) {
708
+ constructor({ model, access }: { model: string; access: AccessFunction }) {
260
709
  super(...arguments as unknown as unknown[]);
261
710
 
262
711
  this.model = model;
@@ -279,29 +728,62 @@ export default class OrmRequest extends Request {
279
728
  if (queryFilterPredicate) recordsToReturn = recordsToReturn.filter(queryFilterPredicate as (record: OrmRecord) => boolean);
280
729
 
281
730
  const baseUrl = getBaseUrl(request);
282
- const data = recordsToReturn.map(record => record.toJSON?.({ fields: modelFields, baseUrl }));
731
+
732
+ // ONE filter per REQUEST, not one per record: it carries the per-type
733
+ // verdict cache and the per-(type, id) decision cache, and both are
734
+ // worthless if it is rebuilt inside the map. Measured on this exact
735
+ // surface with no `include=`: 48 linkage entries collapse to 7 distinct
736
+ // (type, id) pairs.
737
+ const linkage = createLinkageFilter(request);
738
+ const data = recordsToReturn.map(record => record.toJSON?.({ fields: modelFields, baseUrl, linkage }));
283
739
 
284
740
  return buildResponse(data, request.query?.include, recordsToReturn, {
285
741
  links: { self: `${baseUrl}/${pluralizedModel}` },
286
- baseUrl
742
+ baseUrl,
743
+ // THE SAME filter object the primary documents above were serialized
744
+ // with, deliberately: it carries the caches, and rebuilding one here
745
+ // would re-resolve every type (abofs/stonyx-orm#235).
746
+ linkage
287
747
  });
288
748
  };
289
749
 
290
- const getSingleHandler: HandlerFn = async (request) => {
750
+ const getSingleHandler: HandlerFn = async (request, { filter }) => {
291
751
  const record = await store.find(model, getId(request.params)) as OrmRecord | undefined;
292
752
  if (!record) return 404;
753
+ // 404, never 403: the status for "exists but filtered out" must be
754
+ // identical to "does not exist", or the fix trades an authorization
755
+ // bypass for a narrower existence oracle.
756
+ if (isDenied(filter, record)) return 404;
293
757
 
294
758
  const fieldsMap = parseFields(request.query);
295
759
  const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
296
760
 
297
761
  const baseUrl = getBaseUrl(request);
298
- return buildResponse(record.toJSON?.({ fields: modelFields, baseUrl }), request.query?.include, record, {
762
+ const linkage = createLinkageFilter(request);
763
+
764
+ // `buildResponse` IS given the filter now (abofs/stonyx-orm#235), and it
765
+ // is the SAME object the primary document is serialized with -- one
766
+ // verdict per type for the whole response, sideload included.
767
+ //
768
+ // The boundary that remains, so the next reader does not have to derive
769
+ // it: this closes what a record already in `included` may NAME. WHETHER a
770
+ // resource appears in `included` at all is MEMBERSHIP and it is
771
+ // abofs/stonyx-orm#233's -- a hidden owner is still a member here.
772
+ // Neither question closes the other.
773
+ return buildResponse(record.toJSON?.({ fields: modelFields, baseUrl, linkage }), request.query?.include, record, {
299
774
  links: { self: `${baseUrl}/${pluralizedModel}/${request.params.id}` },
300
- baseUrl
775
+ baseUrl,
776
+ linkage
301
777
  });
302
778
  };
303
779
 
304
- const createHandler: HandlerFn = async ({ body, query }) => {
780
+ const createHandler: HandlerFn = async (request, { filter }) => {
781
+ // BOUND, not destructured (abofs/stonyx-orm#235). `HandlerFn` has always
782
+ // delivered the request as argument one; this handler simply discarded
783
+ // the binding, which is why its response document named ids every read
784
+ // surface withholds. `createLinkageFilter` needs the live request and
785
+ // there is no signature change involved in giving it one.
786
+ const { body, query } = request;
305
787
  const { type, id, attributes, relationships: rels } = (body?.data || {}) as {
306
788
  type?: string;
307
789
  id?: string | number;
@@ -314,14 +796,113 @@ export default class OrmRequest extends Request {
314
796
  const fieldsMap = parseFields(query);
315
797
  const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
316
798
 
317
- // Check for duplicate ID
318
- if (id !== undefined && await store.find(model, id)) return 409; // Conflict
799
+ // GATE 0 -- the POST existence oracle.
800
+ //
801
+ // The duplicate check runs before the filter and `store.find` sees hidden
802
+ // records, so POST leaks existence through its STATUS. A previous revision
803
+ // filtered the collision status (403 when the colliding record is denied,
804
+ // 409 when it is visible) and that is NOT sufficient, because the status
805
+ // of a create is a third outcome. With a payload the caller is permitted
806
+ // to create -- the normative case for a per-tenant filter, and the case an
807
+ // attacker picks -- all three are distinguishable in ONE request per id:
808
+ //
809
+ // POST /animals {id:22, owner:'gina'} -> 403 a HIDDEN record has this id
810
+ // POST /animals {id:9500, owner:'gina'} -> 200 this id is FREE
811
+ // POST /animals {id:8, owner:'gina'} -> 409 a VISIBLE record has this id
812
+ //
813
+ // Filtering only the collision status narrows that to callers who cannot
814
+ // create a record they are allowed to see. It does not close it.
815
+ //
816
+ // It cannot be closed while a caller both chooses the id and learns
817
+ // whether the create succeeded: a successful create must answer
818
+ // differently from a refused one. So when a per-record filter is in force
819
+ // the caller does not get to choose the id at all. The refusal is
820
+ // UNCONDITIONAL and happens BEFORE any store lookup, so no status, and no
821
+ // lookup cost, can depend on whether that id exists. 403 -- the same
822
+ // status as a denied create -- so the two cannot be separated either.
823
+ //
824
+ // BOTH HALVES OF THAT ARE PINNED, because both were once asserted here and
825
+ // pinned by nothing:
826
+ //
827
+ // status -- assertion 22 sweeps payload x id x id-type, plus `null`.
828
+ // latency -- assertion 41 asserts NO `store.find` is issued on this
829
+ // path. Moving the refusal to after a lookup and returning
830
+ // the same 403 left the suite green while re-opening a
831
+ // hit-versus-miss timing difference on every id-bearing POST,
832
+ // which is what would turn #197 from a ~0.06ms post-fetch
833
+ // residual into a live timing oracle on create.
834
+ //
835
+ // AND THE GUARANTEE IS ONLY AS WIDE AS THE CHANNELS IT COVERS. It reads on
836
+ // the `id` member of the resource object, so it holds only while that is
837
+ // the ONLY way a caller id can reach `createRecord`. It was not: the
838
+ // relationships loop below re-admitted one under `key === "id"` and the
839
+ // gate never fired. Both strips -- `attributes.id` and `relationships.id`
840
+ // -- are therefore part of THIS gate, not tidiness, and assertion 39 pins
841
+ // them. Adding a third channel without a strip re-opens the oracle.
842
+ //
843
+ // Scoped to function-style `access` because that is exactly the population
844
+ // the oracle exists for: with no per-record filter there are no hidden
845
+ // records, and 409 discloses nothing GET /:id does not already.
846
+ //
847
+ // RESIDUALS, stated rather than implied.
848
+ //
849
+ // - a caller can still learn that a collection HAS a per-record filter
850
+ // (403 rather than 409/200 for an id-bearing POST). That discloses a
851
+ // configuration fact, not a record.
852
+ // - this gate is about ids arriving on THIS model's create route. It
853
+ // says nothing about a write to ANOTHER collection: a `POST /owners`
854
+ // carrying `relationships: {pets: {data: {id: 21}}}` -- or
855
+ // `attributes: {pets: [21, 22]}`, which never enters the
856
+ // relationships loop at all -- re-parents hidden animal 21 onto an
857
+ // owner the caller may write, which changes the very field the
858
+ // animals predicate reads and DE-HIDES it. Blocking that needs animal
859
+ // 21 checked against the ANIMAL model's predicate while servicing an
860
+ // OWNERS route, i.e. cross-model access resolution: abofs/stonyx-orm
861
+ // #207, blocked on #202 (`access` receives the model structurally)
862
+ // and #196 (setup-rest-server discards the model->predicate map at
863
+ // boot). NOT closed here, and no comment in this file may say it is.
864
+ //
865
+ // See README `### Known limitations`.
866
+ if (id !== undefined) {
867
+ if (typeof filter === 'function') return 403; // Forbidden
868
+
869
+ // `normalizeBodyId`, not the raw value: a string-typed id misses the
870
+ // store's numeric key, which skipped this check entirely.
871
+ const existing = await store.find(model, normalizeBodyId(id));
872
+ if (existing) return 409; // Conflict
873
+ }
319
874
 
320
875
  const { id: _ignoredId, ...sanitizedAttributes } = attributes || {};
321
876
 
322
- // Extract relationship IDs from JSON:API relationships object
877
+ // Extract relationship IDs from JSON:API relationships object.
878
+ //
879
+ // `key` comes VERBATIM from the request body, so `id` is stripped here for
880
+ // exactly the same reason it is stripped from `attributes` on the line
881
+ // above -- and it must be, or GATE 0 is walked around by moving one field:
882
+ //
883
+ // POST /animals {"id":21, ...} -> 403 GATE 0 fires
884
+ // POST /animals {"relationships":{"id":{"data":{"id":21}}},
885
+ // "attributes":{"owner":"gina"}} -> 200 BYPASS
886
+ //
887
+ // Top-level `id` stayed `undefined`, so GATE 0 never fired and the
888
+ // collision lookup never ran; `createRecord` took its last-entry-wins
889
+ // branch, overwrote hidden record 21 in place and reset its `owner` to a
890
+ // value the caller chose -- de-hiding it permanently. That is #190 itself,
891
+ // on the create surface. Pinned by assertion 39.
892
+ //
893
+ // The `id` member of the resource object is now the ONLY channel a caller
894
+ // id can arrive on FOR THIS MODEL'S OWN CREATE ROUTE, which is what makes
895
+ // GATE 0's guarantee checkable rather than merely asserted. It is not a
896
+ // statement about the record's reachability in general -- a relationship
897
+ // write on another collection reaches it without ever touching this
898
+ // handler (abofs/stonyx-orm#207). INHERITED from `dev`, which carries this
899
+ // loop verbatim; the general form -- the loop accepts any key, not just
900
+ // `id`, so a body key that is not a declared relationship is still
901
+ // mass-assigned -- is abofs/stonyx-orm#204.
323
902
  if (rels) {
324
903
  for (const [key, value] of Object.entries(rels)) {
904
+ if (key === 'id') continue;
905
+
325
906
  const relData = value?.data;
326
907
  if (relData && relData.id !== undefined) {
327
908
  (sanitizedAttributes as { [key: string]: unknown })[key] = relData.id;
@@ -330,16 +911,169 @@ export default class OrmRequest extends Request {
330
911
  }
331
912
 
332
913
  const recordAttributes = id !== undefined ? { id, ...sanitizedAttributes } : sanitizedAttributes;
333
- const created = createRecord(model, recordAttributes as { [key: string]: unknown }, { serialize: false, _skipAutoPersist: true });
914
+
915
+ // Slot count BEFORE the write. `createRecord` writes to the store before
916
+ // the predicate can run, and the rollback below must be able to prove the
917
+ // slot it removes is one THIS REQUEST created. Identity alone cannot
918
+ // prove it: when `assignRecordId` lands on an occupied id, `createRecord`
919
+ // mutates the existing OrmRecord IN PLACE, so `store.get(...) === record`
920
+ // is true for a record the request did not create. The map's size is the
921
+ // only O(1) signal that distinguishes an insert from an overwrite.
922
+ const slotsBefore = store.get(model)?.size ?? 0;
923
+
924
+ // THE ONE `createRecord` FAILURE THIS ROUTE ANSWERS RATHER THAN
925
+ // PROPAGATES, and it is narrow on purpose.
926
+ //
927
+ // `assignRecordId` throws when it cannot derive a free store key for a
928
+ // server-assigned id. Unguarded that rejection is auto-forwarded -- there
929
+ // is no catch here, none in @stonyx/rest-server's dispatcher
930
+ // (dist/request.js:41-70), and express 5 hands it to its default error
931
+ // handler, which serialises the STACK, with absolute install paths and the
932
+ // internal module graph, to an unauthenticated caller outside
933
+ // NODE_ENV=production. That is the hazard :553-558 already names in this
934
+ // file, and every sibling refusal in this handler returns an integer
935
+ // status instead. So this one returns 409, matching the client-duplicate
936
+ // refusal at :713: the caller asked for a record and the collection has no
937
+ // id to give it.
938
+ //
939
+ // MATCHED ON THE SHARED PREFIX, not on a literal, and NOT by catching
940
+ // everything: `createRecord` also throws for "ORM is not ready", a
941
+ // read-only view and an unregistered model store, and turning any of those
942
+ // into a 409 would report a configuration fault as a conflict. Anything
943
+ // else is re-thrown unchanged.
944
+ let created;
945
+
946
+ try {
947
+ created = createRecord(model, recordAttributes as { [key: string]: unknown }, { serialize: false, _skipAutoPersist: true });
948
+ } catch (error) {
949
+ if (!(error instanceof Error) || !error.message.startsWith(NO_FREE_ID_ERROR)) throw error;
950
+
951
+ // Not silently. A collection that can no longer assign an id is a
952
+ // configuration fault (a non-injective id transform), and a bare 409
953
+ // with no diagnostic is indistinguishable from an ordinary duplicate.
954
+ log.error?.(`[@stonyx/orm] ${error.message}`);
955
+
956
+ return 409; // Conflict
957
+ }
958
+
334
959
  const record = isOrmRecord(created) ? created : null;
335
960
  if (!record) return 500;
336
961
 
337
- return { data: record.toJSON?.({ fields: modelFields }) };
962
+ const createdNewSlot = (store.get(model)?.size ?? 0) > slotsBefore;
963
+
964
+ // 403 here, NOT 404. The oracle argument does not apply to create: there
965
+ // is no pre-existing record whose existence could leak, the caller
966
+ // supplied the attributes, and 404 on a mounted collection route is
967
+ // indistinguishable from "model not mounted" -- a genuinely different
968
+ // failure a developer needs to diagnose.
969
+ //
970
+ // The rollback is not optional. createRecord writes to the store BEFORE
971
+ // the predicate can run, so returning 403 alone would leave the record
972
+ // behind: a worse bug than the bypass being fixed.
973
+ if (isDenied(filter, record)) {
974
+ // ROLL BACK BY IDENTITY, NEVER BY ID. `store.remove(model, record.id)`
975
+ // on its own is a write primitive keyed by a value the caller may have
976
+ // supplied: with the raw-id collision bypass above, a denied
977
+ // `POST {"id":"21"}` answered 403 and DELETED hidden record 21 -- an
978
+ // unauthenticated deletion primitive across the whole id space, created
979
+ // by adding a rollback to a lookup that could be skipped.
980
+ //
981
+ // Both conditions are required and neither implies the other:
982
+ // createdNewSlot -- the store grew, so this request inserted rather
983
+ // than overwrote. SURVIVOR AS OF #203, AND THAT IS
984
+ // WHAT THIS NOTE IS FOR. It used to be killable:
985
+ // `assignRecordId` returned last-INSERTED + 1, so a
986
+ // server-assigned id could land on an occupied slot,
987
+ // `createRecord` updated in place, and removing this
988
+ // half turned access-filter-enforcement-test.ts
989
+ // assertion 31 red. #203 closed that: the
990
+ // server-assigned path now walks past occupied keys,
991
+ // so no create reaching here can overwrite. Measured
992
+ // -- delete `createdNewSlot &&` below: `dev` gives
993
+ // 55 pass / 1 fail with assertion 31 RED, this tree
994
+ // gives 56 pass / 0 fail, GREEN.
995
+ // KEPT ANYWAY, AND NOT FOR THE OLD REASON. Without
996
+ // it a denied create becomes `store.remove` on a key
997
+ // the caller may have influenced, which :815-820
998
+ // records as having been an unauthenticated deletion
999
+ // primitive across the whole id space. BECOMES
1000
+ // KILLABLE AGAIN the moment any caller-supplied id
1001
+ // can reach `createRecord` from this handler --
1002
+ // which is exactly what has-many.ts:65 and
1003
+ // belongs-to.ts:45 already do for ANOTHER model's
1004
+ // store (abofs/stonyx-orm#207), and what a third
1005
+ // un-stripped id channel would do for this one
1006
+ // (#204). Do not delete it on the strength of #203
1007
+ // being closed; that is the reasoning :862-867 warns
1008
+ // about, one level up.
1009
+ // identity -- the slot still holds the object we just created,
1010
+ // so nothing between createRecord and here replaced
1011
+ // it. Deleting this half SURVIVES the suite, and it
1012
+ // is kept anyway. WHY IT IS REDUNDANT: there is no
1013
+ // `await` anywhere between `slotsBefore` and
1014
+ // `store.remove` -- the whole window is synchronous,
1015
+ // so it is atomic under Node's event loop; before-
1016
+ // `create` hooks run BEFORE the handler
1017
+ // (`_withHooks` runs its hook loop ahead of
1018
+ // `await handler(...)`), and a consumer predicate
1019
+ // inside `isDenied` runs AFTER `createdNewSlot` is
1020
+ // computed and cannot flip it. That is a property of
1021
+ // THIS function, not of GATE 0 -- an earlier note
1022
+ // credited GATE 0, which was both wrong (a caller id
1023
+ // reached createRecord through the relationships
1024
+ // loop, #204) and the wrong kind of reason: a guard
1025
+ // justified on code sixty lines upstream gets
1026
+ // silently re-armed when that code moves.
1027
+ // SO IT BECOMES REACHABLE IF AN `await` IS
1028
+ // INTRODUCED HERE, which is the change a future
1029
+ // editor would actually make. Stated here rather
1030
+ // than by reference: `docs/` is not in `files`, so
1031
+ // a pointer into it resolves to nothing for anyone
1032
+ // who installed this package. README carries the
1033
+ // consumer-facing half.
1034
+ if (createdNewSlot && store.get(model, record.id as string | number) === record) {
1035
+ store.remove(model, record.id as string | number, { _skipAutoPersist: true });
1036
+ }
1037
+
1038
+ return 403;
1039
+ }
1040
+
1041
+ // The filter is built HERE, per invocation, and never hoisted into the
1042
+ // OrmRequest constructor where the other per-mount values live: a verdict
1043
+ // cached across requests answers a second caller with the first caller's
1044
+ // authorization (src/access-verdict.ts says so at the constructor an
1045
+ // implementer would reach for).
1046
+ //
1047
+ // AND IT IS BUILT AFTER `createRecord`, AFTER THE ROLLBACK WINDOW AND
1048
+ // AFTER `isDenied`, so the record is in its final form at the call. The
1049
+ // filter is lazy per type and per (type, id), so it cannot observe a
1050
+ // pre-write state even if it were built earlier.
1051
+ //
1052
+ // `fields` is passed here and NOT in `updateHandler`: the two handlers
1053
+ // are asymmetric on purpose (`updateHandler` has no `fieldsMap` in
1054
+ // scope), and a single copy-pasted wiring would drop it from one of them.
1055
+ return { data: record.toJSON?.({ fields: modelFields, linkage: createLinkageFilter(request) }) };
338
1056
  };
339
1057
 
340
- const updateHandler: HandlerFn = async ({ body, params }) => {
1058
+ const updateHandler: HandlerFn = async (request, { filter }) => {
1059
+ // Bound rather than destructured, for the reason given in
1060
+ // `createHandler` above (abofs/stonyx-orm#235). `PATCH /animals/1`
1061
+ // returned 200 naming angela seconds after `GET /animals/1` returned
1062
+ // `owner.data: null` for the same record -- one HTTP verb apart.
1063
+ const { body, params } = request;
341
1064
  const found = await store.find(model, getId(params));
342
1065
  if (!found || !isOrmRecord(found)) return 404;
1066
+ // Checked BEFORE any attribute is applied. 404 rather than 403 for the
1067
+ // same reason as GET /:id -- 403 would disclose both that the record
1068
+ // exists and that this caller specifically is excluded.
1069
+ //
1070
+ // NOT redundant behind GATE 1, and not defence in depth either: GATE 1's
1071
+ // verdict is computed BEFORE the before-hook loop runs, and a before-hook
1072
+ // is a published extension point that can change the answer -- by
1073
+ // mutating the record, or against a predicate that closes over
1074
+ // per-request state. This is the only re-evaluation after that window.
1075
+ // Pinned by assertion 32; deleting it turns a 404 into an applied update.
1076
+ if (isDenied(filter, found)) return 404;
343
1077
  const record = found;
344
1078
  const { attributes, relationships: rels } = (body?.data || {}) as {
345
1079
  attributes?: { [key: string]: unknown };
@@ -362,6 +1096,19 @@ export default class OrmRequest extends Request {
362
1096
  if (rels) {
363
1097
  const relUpdates: { [key: string]: unknown } = {};
364
1098
  for (const [key, value] of Object.entries(rels)) {
1099
+ // The same missing key filter as createHandler's, and as the
1100
+ // attribute loop directly above -- which already had it, while this
1101
+ // loop did not. A PATCH carrying
1102
+ // `relationships:{"id":{"data":{"id":9101}}}` reached `updateRecord`
1103
+ // and RE-KEYED the record: the object held under store key 9102 then
1104
+ // reported id 9101, so a visible record claimed a hidden record's
1105
+ // identity on every surface that reads `record.id` rather than the map
1106
+ // key. Gated by GATE 1 on the addressed record, so it is store
1107
+ // corruption rather than a filter bypass -- but it is the same one-line
1108
+ // omission two handlers apart. Pinned by assertion 40; INHERITED from
1109
+ // `dev`; abofs/stonyx-orm#204.
1110
+ if (key === 'id') continue;
1111
+
365
1112
  const relData = value?.data;
366
1113
  if (relData && relData.id !== undefined) {
367
1114
  relUpdates[key] = relData.id;
@@ -372,11 +1119,41 @@ export default class OrmRequest extends Request {
372
1119
  }
373
1120
  }
374
1121
 
375
- return { data: record.toJSON?.() };
1122
+ // No `fields` and no `baseUrl`, both unchanged: `updateHandler` has no
1123
+ // `fieldsMap` in scope, and adding `baseUrl` would put `links` on a
1124
+ // document that has never carried them -- an unrelated behaviour change.
1125
+ // #224 AC6's "emits `data: []` WITH links" is a statement about the READ
1126
+ // surfaces; on these two handlers a filtered relationship and a
1127
+ // genuinely-empty one are both a bare `{ data }`, which is what makes
1128
+ // them indistinguishable here too.
1129
+ return { data: record.toJSON?.({ linkage: createLinkageFilter(request) }) };
376
1130
  };
377
1131
 
378
- const deleteHandler: HandlerFn = ({ params }) => {
379
- store.remove(model, getId(params));
1132
+ const deleteHandler: HandlerFn = async ({ params }, { filter }) => {
1133
+ // Coerced ONCE. `getId(params)` was evaluated twice here -- once to find
1134
+ // the record and once to remove it -- and a coercion evaluated repeatedly
1135
+ // is a coercion that can be edited in one place and not the other, which
1136
+ // is the defect `coerceId` exists to prevent.
1137
+ const recordId = getId(params);
1138
+ const record = await store.find(model, recordId) as OrmRecord | undefined;
1139
+
1140
+ // BEHAVIOUR CHANGE (#190): a DELETE of a record that never existed
1141
+ // returned 204 before this change. It now returns 404, matching the
1142
+ // denied case below. This is deliberate and load-bearing -- if a denied
1143
+ // delete returned 404 while a missing one returned 204, the pair would be
1144
+ // a perfect existence oracle and the whole fix would be worthless.
1145
+ // Returning 204 for a denied delete was rejected instead: it falsely
1146
+ // reports success for a request that changed nothing.
1147
+ if (!record) return 404;
1148
+ // Re-evaluated after the before-hook loop, exactly as in updateHandler --
1149
+ // GATE 1 decided before the hooks ran. Pinned by assertion 33; deleting it
1150
+ // turns a 404 into a destroyed record.
1151
+ if (isDenied(filter, record)) return 404;
1152
+
1153
+ // Removed by the id of the record actually fetched, not by re-deriving it
1154
+ // from the params a second time: the record the filter tested and the
1155
+ // record removed are then provably the same one.
1156
+ store.remove(model, record.id as string | number, { _skipAutoPersist: true });
380
1157
  return 204;
381
1158
  };
382
1159
 
@@ -405,9 +1182,65 @@ export default class OrmRequest extends Request {
405
1182
  }
406
1183
  }
407
1184
 
408
- // Wraps a handler with before/after hook execution
1185
+ // Wraps a handler with before/after hook execution.
1186
+ //
1187
+ // ===========================================================================
1188
+ // TWO AUTHORIZATION GATES, AND EVERY EXECUTOR SITS BEHIND ONE OF THEM (#190)
1189
+ //
1190
+ // The defect this function was fixed for is NOT "a delete persists past a
1191
+ // 404". It is that _withHooks has SEVERAL executors downstream of the
1192
+ // handler, and originally the handler's response gated none of them. Three
1193
+ // exist today:
1194
+ //
1195
+ // 1. sqlDb.persist -- issues real SQL against the backing store
1196
+ // 2. the after-hook pipeline -- the PUBLISHED consumer extension point;
1197
+ // a cascade delete, a webhook, a search-index
1198
+ // purge. `context.recordId` and
1199
+ // `context.oldState` are populated for it.
1200
+ // 3. Orm.db.save() -- a full serialize-and-write of the store
1201
+ //
1202
+ // Gating them one at a time is how this keeps regressing, so the rule is:
1203
+ // compute denial ONCE at each point where it becomes knowable, and keep every
1204
+ // executor downstream of a gate. If you add a fourth executor to this
1205
+ // function, it goes below GATE 2 or it is a security bug.
1206
+ //
1207
+ // GATE 1 (pre-handler) is required because before-hooks and `context.oldState`
1208
+ // run/are built BEFORE the handler can consult the filter. Without it a denied
1209
+ // DELETE still handed the hidden record's full contents to consumer code.
1210
+ // GATE 2 (post-handler) covers everything the handler's status can reach.
1211
+ // ===========================================================================
409
1212
  private _withHooks(operation: string, handler: HandlerFn): HandlerFn {
410
1213
  return async (request: OrmRequest$, state: { [key: string]: unknown }) => {
1214
+ // `|| {}` so this function behaves like the relationship routes below,
1215
+ // which declare `state` with a `= {}` default. It is unkillable through
1216
+ // the rest-server dispatcher, which always passes `getState(req)`; it is
1217
+ // listed as such in the guards-redundant-by-construction table rather
1218
+ // than left silently unkillable, and it defends the WHOLE function (the
1219
+ // context, the snapshot and the handler call all read `callState`) rather
1220
+ // than one destructure that the next line would throw past anyway.
1221
+ const callState = (state || {}) as { [key: string]: unknown };
1222
+
1223
+ // ---------------------------------------------------------------------
1224
+ // THE AUTHORIZATION SNAPSHOT. Read ONCE, here, before any consumer code
1225
+ // can run.
1226
+ //
1227
+ // `callState` is the object `auth()` planted the filter in, and it is
1228
+ // also handed to every before-hook as `context.state` -- a published,
1229
+ // WRITABLE extension point. So `state.filter` is an INPUT to the
1230
+ // authorization decision, not only an output channel, and re-reading it
1231
+ // after the hook loop lets a consumer hook disarm the filter:
1232
+ //
1233
+ // beforeHook('get', 'animal', ctx => { delete ctx.state.filter })
1234
+ // -> GET /animals/21 turned 404 into 200
1235
+ // -> GET /animals turned 20 records into 22
1236
+ //
1237
+ // GATE 1 already used this snapshot, so writes held; the READ handlers
1238
+ // re-destructured `filter` from the live bag and did not. Everything
1239
+ // downstream now reads `filter` from here, and the handler is handed
1240
+ // `handlerState` below -- never `callState`.
1241
+ // ---------------------------------------------------------------------
1242
+ const { filter } = callState as { filter?: unknown };
1243
+
411
1244
  // Build context object for hooks
412
1245
  const context: HookContext = {
413
1246
  model: this.model,
@@ -416,12 +1249,37 @@ export default class OrmRequest extends Request {
416
1249
  params: request.params,
417
1250
  body: request.body,
418
1251
  query: request.query,
419
- state,
1252
+ // Deliberately the LIVE object: `redirect` and `pipe` are read back off
1253
+ // it by @stonyx/rest-server after the handler returns, so hooks must be
1254
+ // able to write to it. What must not happen is the authorization
1255
+ // decision reading it back, which is what the snapshot above prevents.
1256
+ state: callState,
420
1257
  };
421
1258
 
422
1259
  // Capture old state for operations that modify data
423
1260
  if (operation === 'update' || operation === 'delete') {
424
1261
  const existingRecord = await store.find(this.model, getId(request.params)) as OrmRecord | undefined;
1262
+
1263
+ // GATE 1 -- pre-handler. This record fetch already happened for
1264
+ // oldState, so the check is free.
1265
+ //
1266
+ // Returning here rather than letting updateHandler/deleteHandler
1267
+ // produce the same 404 is the point: everything between here and there
1268
+ // is an executor the caller is not authorized to reach.
1269
+ // - context.oldState is a deep copy of the HIDDEN RECORD'S CONTENTS.
1270
+ // Building it and handing it to a before-hook discloses exactly what
1271
+ // the filter exists to hide.
1272
+ // - context.recordId is populated for delete BEFORE the handler runs,
1273
+ // which is the same shape as the sqlDb landmine one layer up:
1274
+ // `afterHook('delete', ctx => cascadeDelete(ctx.recordId))` destroys
1275
+ // children behind a correct 404.
1276
+ // - a before-hook may return a value and short-circuit, which would
1277
+ // otherwise return a response without the filter ever executing.
1278
+ //
1279
+ // 404, not 403, for the same reason as getSingleHandler: the status for
1280
+ // "exists but filtered out" must equal "does not exist".
1281
+ if (existingRecord && isDenied(filter, existingRecord)) return 404;
1282
+
425
1283
  if (existingRecord) {
426
1284
  // Deep copy the record's data to preserve old state
427
1285
  context.oldState = JSON.parse(JSON.stringify(existingRecord.__data || existingRecord));
@@ -441,11 +1299,52 @@ export default class OrmRequest extends Request {
441
1299
  }
442
1300
 
443
1301
  // Execute main handler
444
- const response = await handler(request, state);
1302
+ // The handler receives the SNAPSHOT, never the live bag. `filter` is
1303
+ // assigned LAST so it wins over anything a before-hook wrote to
1304
+ // `callState.filter` -- including a `delete`, which the spread would
1305
+ // otherwise carry through as an absent key. Every other key a hook adds
1306
+ // is still visible to the handler; only the authorization input is
1307
+ // pinned.
1308
+ const handlerState = { ...callState, filter };
1309
+ const response = await handler(request, handlerState);
1310
+
1311
+ // Set context.record for update BEFORE persist so SQL drivers can read it
1312
+ if (operation === 'update' && (response as JsonApiResponse)?.data) {
1313
+ context.record = store.get(this.model, getId(request.params));
1314
+ }
445
1315
 
446
- // Persist to SQL database for create/update (delete is handled by store.remove auto-persist)
1316
+ // GATE 2 -- post-handler. A denied or failed handler returns a bare status
1317
+ // integer, and no executor below may run for one.
1318
+ //
1319
+ // `>= 400` deliberately covers every failure status, not just the
1320
+ // authorization ones: a 400 (POST with no `type`) and a 409 (duplicate id)
1321
+ // are equally requests in which nothing happened, and a persist or a
1322
+ // cascade hook for one of them is just as wrong.
1323
+ // `Number.isInteger` is a TYPE guard, not a behaviour guard, and it is
1324
+ // unkillable TODAY: the only non-integer a handler in this file can
1325
+ // return is a `{ data, links }` object, and `{} >= 400` is `false` by JS
1326
+ // coercion, so dropping it changes no reachable outcome. It is kept
1327
+ // because `>=` coerces rather than rejects, and the shapes it coerces
1328
+ // are not obvious -- `[500] >= 400` is TRUE, so a handler that one day
1329
+ // returned an array would have every response read as a denial. Listed
1330
+ // as an equivalent mutant rather than left to read as coverage; it
1331
+ // becomes killable the moment a handler returns anything array-like or
1332
+ // numeric-string-like.
1333
+ const denied = Number.isInteger(response) && (response as number) >= 400;
1334
+
1335
+ // EXECUTOR 1 -- SQL persistence, for all write operations.
1336
+ //
1337
+ // `response` is passed to sqlDb.persist below, but it is dropped at the
1338
+ // driver boundary: _persistDelete(modelName, context) never receives it
1339
+ // and guards only on context.recordId -- which _withHooks set above,
1340
+ // BEFORE the handler ran. Without this gate a correct 404 still issues
1341
+ // DELETE FROM ... WHERE id = ? on every SQL backend.
1342
+ //
1343
+ // No file-backed test can observe that, because Orm.instance.sqlDb is
1344
+ // null in file/directory mode. See the stubbed-sqlDb assertions in
1345
+ // test/unit/access-filter-enforcement-test.ts.
447
1346
  const sqlDb = Orm.instance.sqlDb;
448
- if (sqlDb && (operation === 'create' || operation === 'update')) {
1347
+ if (sqlDb && WRITE_OPERATIONS.has(operation) && !denied) {
449
1348
  await sqlDb.persist(operation, this.model, context, response);
450
1349
  }
451
1350
 
@@ -459,22 +1358,45 @@ export default class OrmRequest extends Request {
459
1358
  } else if (operation === 'create' && (response as JsonApiResponse)?.data && ((response as { data: { id?: unknown } }).data.id)) {
460
1359
  // For create, get the record from store using the ID from the response
461
1360
  const responseData = (response as { data: { id: string | number } }).data;
462
- const recordId = isNaN(responseData.id as unknown as number) ? responseData.id : parseInt(responseData.id as string);
463
- context.record = store.get(this.model, recordId);
464
- } else if (operation === 'update' && (response as JsonApiResponse)?.data) {
465
- context.record = store.get(this.model, getId(request.params));
1361
+ // `normalizeBodyId`, not a copy of its body. This line WAS
1362
+ // `isNaN(id) ? id : parseInt(id)` -- `coerceId` inlined verbatim, a
1363
+ // third coercion feeding a store lookup, sitting under a docblock that
1364
+ // said neither surface had a copy. Equivalent on every input that can
1365
+ // reach this truthy-guarded branch (`21`->`21`, `'21'`->`21`,
1366
+ // `'angela'`->`'angela'`; `''` and `0` cannot reach it), so this is a
1367
+ // de-duplication rather than a behaviour change -- and that is the
1368
+ // point: the two that disagreed were equivalent on every input anyone
1369
+ // checked, too.
1370
+ context.record = store.get(this.model, normalizeBodyId(responseData.id) as string | number);
466
1371
  } else if (operation === 'delete') {
467
1372
  // For delete, the record may no longer exist, but we have oldState
468
1373
  context.recordId = getId(request.params);
469
1374
  }
470
1375
 
471
- // Run after hooks sequentially
472
- for (const hook of getAfterHooks(operation, this.model)) {
473
- await hook(context);
1376
+ // EXECUTOR 2 -- the after-hook pipeline. This is the published consumer
1377
+ // extension point (`afterHook` is exported from @stonyx/orm and from
1378
+ // ./hooks), so it is the executor with the widest possible blast radius:
1379
+ // a cascade delete, a webhook, a token revocation, a search-index purge.
1380
+ //
1381
+ // BEHAVIOUR CHANGE (#190): after-hooks no longer fire for a request that
1382
+ // failed. Previously `afterHook('delete', ...)` ran with a populated
1383
+ // context.recordId on a 404, so a consumer cascade destroyed children for
1384
+ // a request that deleted nothing. Firing a hook named "after<operation>"
1385
+ // for an operation that did not occur is a booby trap, and the denied case
1386
+ // is unreachable-before-#190 while the missing case is inherited debt --
1387
+ // both are closed by the same gate. `context.response` therefore only ever
1388
+ // carries a success status into a hook.
1389
+ if (!denied) {
1390
+ for (const hook of getAfterHooks(operation, this.model)) {
1391
+ await hook(context);
1392
+ }
474
1393
  }
475
1394
 
476
- // Auto-save DB after write operations when configured
477
- if (config.orm.db.autosave === 'onUpdate' && WRITE_OPERATIONS.has(operation)) {
1395
+ // EXECUTOR 3 -- file/directory autosave. Ungated this let an
1396
+ // unauthenticated caller force a full serialize-and-write of the entire
1397
+ // store on every DELETE of any id, with no record touched: amplification
1398
+ // rather than corruption, but the same root cause and the same fix.
1399
+ if (config.orm.db.autosave === 'onUpdate' && WRITE_OPERATIONS.has(operation) && !denied) {
478
1400
  await (Orm.db as { save(): Promise<void> }).save();
479
1401
  }
480
1402
 
@@ -494,21 +1416,38 @@ export default class OrmRequest extends Request {
494
1416
  const dasherizedName = camelCaseToKebabCase(relationshipName);
495
1417
 
496
1418
  // Related resource route: GET /:id/{relationship}
497
- routes[`/:id/${dasherizedName}`] = async (request: OrmRequest$) => {
1419
+ //
1420
+ // These generated routes are not wrapped by _withHooks, which is why they
1421
+ // were the least obvious two of the seven unguarded surfaces in #190.
1422
+ // They are still dispatched by @stonyx/rest-server as
1423
+ // `handler(req, getState(req))`, so `state` -- and therefore the filter
1424
+ // planted by auth() -- has always been available here; it was simply
1425
+ // never declared or read.
1426
+ routes[`/:id/${dasherizedName}`] = async (request: OrmRequest$, { filter }: { [key: string]: unknown } = {}) => {
498
1427
  const record = await store.find(model, getId(request.params)) as OrmRecord | undefined;
499
1428
  if (!record) return 404;
1429
+ // Filtering the PARENT: a caller who may not see the record may not see
1430
+ // what it is related to either.
1431
+ if (isDenied(filter, record)) return 404;
500
1432
 
501
1433
  const relatedData = record.__relationships[relationshipName];
502
1434
  const baseUrl = getBaseUrl(request);
503
1435
 
1436
+ // LINKAGE ONLY. This filter decides which ids the emitted documents may
1437
+ // NAME in their own `relationships.*.data`; it does NOT decide whether
1438
+ // the related records themselves are served -- that is the parent-only
1439
+ // filtering this route has done since #190, and widening it to the
1440
+ // related record is abofs/stonyx-orm#196.
1441
+ const linkage = createLinkageFilter(request);
1442
+
504
1443
  let data: unknown;
505
1444
  if (info.isArray) {
506
1445
  // hasMany - return array
507
1446
  const related = Array.isArray(relatedData) ? relatedData.filter(isOrmRecord) : [];
508
- data = related.map(r => r.toJSON?.({ baseUrl }));
1447
+ data = related.map(r => r.toJSON?.({ baseUrl, linkage }));
509
1448
  } else {
510
1449
  // belongsTo - return single or null
511
- data = isOrmRecord(relatedData) ? relatedData.toJSON?.({ baseUrl }) : null;
1450
+ data = isOrmRecord(relatedData) ? relatedData.toJSON?.({ baseUrl, linkage }) : null;
512
1451
  }
513
1452
 
514
1453
  return {
@@ -518,9 +1457,58 @@ export default class OrmRequest extends Request {
518
1457
  };
519
1458
 
520
1459
  // Relationship linkage route: GET /:id/relationships/{relationship}
521
- routes[`/:id/relationships/${dasherizedName}`] = async (request: OrmRequest$) => {
1460
+ //
1461
+ // NO `linkage` FILTER FROM abofs/stonyx-orm#235, AND THAT IS A SCOPE
1462
+ // BOUNDARY RATHER THAN AN OVERSIGHT -- abofs/stonyx-orm#232 OWNS THIS
1463
+ // ROUTE, and PR #247 is IN FLIGHT against it in this same sprint. If you
1464
+ // are reading this after #247 landed, the filtering below is #232's and
1465
+ // this note records why it was never #235's to add.
1466
+ //
1467
+ // The three sites #235 does own -- `buildResponse`'s `included`, and the
1468
+ // two write handlers, `POST /:models` and `PATCH /:models/:id` -- all
1469
+ // reach the filter through `record.toJSON()`, which is where the
1470
+ // `linkage` OPTION is applied.
1471
+ //
1472
+ // The related-resource branch above ALSO passes a `linkage` filter, and
1473
+ // it is NOT one of those three: it is abofs/stonyx-orm#234's code and
1474
+ // predates this change. `git diff 8dda5d6..HEAD -- src/orm-request.ts`
1475
+ // leaves that branch byte-unchanged.
1476
+ //
1477
+ // This branch builds its `{ type, id }` objects BY
1478
+ // HAND and never calls `toJSON` at all, so the `linkage` option cannot
1479
+ // reach it -- whatever this route filters, it has to filter itself, which
1480
+ // is precisely why doing so is a separate change with a separate owner.
1481
+ //
1482
+ // It is also a DIFFERENT QUESTION. Everywhere #235 touches, linkage is
1483
+ // metadata ABOUT a document. Here the linkage IS the primary data, so
1484
+ // dropping an entry is a MEMBERSHIP decision about what this route
1485
+ // serves -- the same class as abofs/stonyx-orm#233 and #196, not the
1486
+ // class #234/#235 close. That is why it is absent from #224 §2a's
1487
+ // seven-site inventory.
1488
+ //
1489
+ // MEASURED, so the next person does not re-derive it. Against this
1490
+ // branch's baseline of 1011/0, wiring `createLinkageFilter` into the
1491
+ // belongsTo branch below takes the suite to 1009/2, reddening
1492
+ // `[GUARD] #235 X2` and the
1493
+ // `GET /animals/:id/relationships/owner returns relationship linkage`
1494
+ // test -- the latter is #232's own reproduction, not a regression.
1495
+ //
1496
+ // THE BASELINE IS QUOTED WITH THE RESULT BECAUSE AN EARLIER REVISION OF
1497
+ // THIS COMMENT SAID 993/2 AND SHIPPED IT. This file lands in consumers'
1498
+ // `node_modules`, so a wrong number here is a wrong number in the
1499
+ // published package. 993+2 = 995 is the DEV baseline, carried over from
1500
+ // a branch on which `[GUARD] #235 X2` does not exist. A pass/fail pair
1501
+ // with no baseline beside it cannot be checked by reading, which is how
1502
+ // it survived three artifacts and a review; the qualitative claim was
1503
+ // right the whole time and only the count was wrong.
1504
+ //
1505
+ // `[GUARD] #235 X2` in test/integration/orm-test.ts pins the OWNERSHIP
1506
+ // BOUNDARY here rather than this route's current answer, so that it
1507
+ // survives #247 landing. Read its comment before changing it.
1508
+ routes[`/:id/relationships/${dasherizedName}`] = async (request: OrmRequest$, { filter }: { [key: string]: unknown } = {}) => {
522
1509
  const record = await store.find(model, getId(request.params)) as OrmRecord | undefined;
523
1510
  if (!record) return 404;
1511
+ if (isDenied(filter, record)) return 404;
524
1512
 
525
1513
  const relatedData = record.__relationships[relationshipName];
526
1514
  const baseUrl = getBaseUrl(request);
@@ -551,32 +1539,140 @@ export default class OrmRequest extends Request {
551
1539
  };
552
1540
  }
553
1541
 
554
- // Catch-all for invalid relationship names on related resource route
555
- routes[`/:id/:relationship`] = async (request: OrmRequest$) => {
556
- const record = await store.find(model, getId(request.params));
557
- if (!record) return 404;
1542
+ // Catch-alls for invalid relationship names. Every valid relationship was
1543
+ // registered above, so reaching either of these means the relationship does
1544
+ // not exist and the answer is 404 regardless of the record.
1545
+ //
1546
+ // These deliberately carry NO access check and no store lookup. An earlier
1547
+ // revision of #190 added `if (isDenied(filter, record)) return 404` here for
1548
+ // symmetry with the seven real surfaces, but both branches returned 404, so
1549
+ // the guard was unobservable by construction -- a mutation deleting it
1550
+ // survived the entire suite because no test that could distinguish it can
1551
+ // exist. Unkillable code in an authorization diff reads as coverage and is
1552
+ // not, so it is gone; skipping the lookup also removes the timing difference
1553
+ // between an existing and a missing parent.
1554
+ //
1555
+ // IF THIS ROUTE EVER RETURNS ANYTHING OTHER THAN A CONSTANT 404, it becomes
1556
+ // the eighth surface and must filter the parent first, exactly like
1557
+ // `/:id/{relationship}` above.
1558
+ routes[`/:id/:relationship`] = async () => 404;
1559
+ routes[`/:id/relationships/:relationship`] = async () => 404;
558
1560
 
559
- // If we reach here, relationship doesn't exist (valid ones were registered above)
560
- return 404;
1561
+ return routes;
1562
+ }
1563
+
1564
+ auth(request: OrmRequest$, state: { [key: string]: unknown }): number | undefined {
1565
+ // A consumer `access()` that throws is a DENIAL, matching `isDenied` one
1566
+ // layer down. Unguarded it propagates to express's default handler, which
1567
+ // answers 500 -- and the documented sample itself can throw
1568
+ // (`request.originalUrl.split(...)` when originalUrl is absent), so the
1569
+ // failure mode is reachable by following the docs.
1570
+ // -------------------------------------------------------------------------
1571
+ // #202 -- hand the consumer the STRUCTURAL facts, not just the transport.
1572
+ //
1573
+ // Both members are already in hand here. `model` is `this.model`, the name
1574
+ // setup-rest-server mounted this route for; `operation` is the SAME
1575
+ // `methodAccessMap` lookup the permission-array branch at the bottom of
1576
+ // this method performs, so the predicate form and the array form cannot
1577
+ // answer differently about the same request.
1578
+ //
1579
+ // NEITHER IS DERIVED FROM THE REQUEST TARGET, and that is the whole point.
1580
+ // Deriving `model` here from `request.baseUrl` (or from the mounted route
1581
+ // name, or from `getPluralName(this.model)`) would move all five fail-open
1582
+ // variants listed in this file's header OUT of the consumer and INTO the
1583
+ // framework, where every consumer inherits them at once. `this.model` is
1584
+ // assigned once at mount time and no request can influence it.
1585
+ //
1586
+ // `operation` is left UNDEFINED for a method with no entry in
1587
+ // `methodAccessMap`, rather than defaulted. Express delivers HEAD to the
1588
+ // GET handler, so an unmapped method really does reach this line; a
1589
+ // `?? 'read'` here would hand the consumer a fabricated authorisation fact
1590
+ // and turn an unclassified request into an authorised one. Undefined is
1591
+ // the honest answer.
1592
+ //
1593
+ // `record` is deliberately absent -- see `AccessContext` in
1594
+ // src/types/orm-types.ts. Nothing is fetched at this point and adding a
1595
+ // lookup here would put a store read in the middle of an authorization
1596
+ // path. The function return shape below IS the per-record hook.
1597
+ //
1598
+ // -------------------------------------------------------------------------
1599
+ // #236 -- `recordId`, the DECODED route-parameter id, for the same reason.
1600
+ //
1601
+ // WHICH RECORD is the third structural fact the framework already holds and
1602
+ // the consumer was left to re-derive, and re-deriving it failed OPEN. The
1603
+ // documented sample compared `request.path` -- the RAW, undecoded pathname
1604
+ // -- against a literal `/archived`, while the router DECODES `:id`. So
1605
+ // `GET /owners/%61rchived` walked past the deny and was dispatched as the
1606
+ // record `archived`: 200 with the record in full, and DELETE answered 204
1607
+ // with the record destroyed, unauthenticated. Four spellings measured, all
1608
+ // four through; 255 non-canonical spellings of that 8-character id decode
1609
+ // to the same key, so this was never a deny-list of one.
1610
+ //
1611
+ // TWO CONSUMER-SIDE NORMALISATIONS WERE MEASURED WRONG IN OPPOSITE
1612
+ // DIRECTIONS, which is the argument for doing it once, here.
1613
+ // `.toLowerCase()` case-folds a route-parameter VALUE on the axis that
1614
+ // governs literal SEGMENTS: with a distinct owner seeded at `ARCHIVED`,
1615
+ // `GET /owners/ARCHIVED` was a false DENY on the wrong record and
1616
+ // `GET /owners/%41RCHIVED` a false ALLOW on that same one.
1617
+ // `decodeURIComponent(request.path)` decodes THEN splits while the router
1618
+ // splits THEN decodes, so it over-denied `/owners/archived%2fx` -- 403 for
1619
+ // a genuinely distinct record. Failing closed there was luck, not design.
1620
+ //
1621
+ // `getId(request.params)` AND NOT `request.params.id`, for exactly the
1622
+ // reason `operation` is a `methodAccessMap` lookup: it is the SAME single
1623
+ // coercion the store lookup one layer down performs, so the predicate and
1624
+ // the dispatch cannot disagree about which record a request addresses.
1625
+ // The raw string would reintroduce that divergence on hex-shaped ids --
1626
+ // `GET /animals/0x2391` looks up record `9105`.
1627
+ //
1628
+ // NOTHING HERE PARSES THE REQUEST TARGET EITHER. `request.params` is what
1629
+ // the router matched, so a mount prefix, an absolute-form target, a query
1630
+ // string or a case-varied mount cannot move this value -- the same
1631
+ // guarantee `model` carries, by the same means.
1632
+ //
1633
+ // `null` and not `undefined` on a collection route, so the KEY IS ALWAYS
1634
+ // PRESENT -- the rule `operation`'s own docblock already establishes. A
1635
+ // context reaching a predicate WITHOUT the key therefore did not come from
1636
+ // here; it was hand-assembled by a caller resolving the predicate through
1637
+ // `Orm.instance.getAccess()`, and that absence stays deniable only because
1638
+ // `auth()` never produces it.
1639
+ // -------------------------------------------------------------------------
1640
+ const context: AccessContext = {
1641
+ model: this.model,
1642
+ operation: methodAccessMap[request.method],
1643
+ recordId: request.params && 'id' in request.params ? getId(request.params) : null,
561
1644
  };
562
1645
 
563
- // Catch-all for invalid relationship names on relationship linkage route
564
- routes[`/:id/relationships/:relationship`] = async (request: OrmRequest$) => {
565
- const record = await store.find(model, getId(request.params));
566
- if (!record) return 404;
1646
+ let access: AccessMethod;
1647
+ try {
1648
+ access = this.access(request, context);
1649
+ } catch (error) {
1650
+ // Same reasoning as `isDenied`: fail closed, but say so. An `access()`
1651
+ // that throws denies EVERY request to the collection, and a silent 403
1652
+ // wall is the hardest possible thing to diagnose from the outside.
1653
+ log.error?.(`[@stonyx/orm] access() threw for model "${this.model}" -- denying. ${error instanceof Error ? error.message : String(error)}`);
567
1654
 
568
- return 404;
569
- };
1655
+ return 403; // Forbidden
1656
+ }
570
1657
 
571
- return routes;
572
- }
1658
+ // THE READING OF THE RETURN SHAPE LIVES IN ONE PLACE (#234).
1659
+ //
1660
+ // It used to be inline here, and it was the only copy, which was fine while
1661
+ // `auth()` was the only thing that had to ask. It is not any more: the
1662
+ // linkage path has to ask model X's predicate about model X's records while
1663
+ // servicing a request routed to model Y, and a second inline copy of these
1664
+ // six branches would be a second authorization vocabulary -- one that can
1665
+ // drift, and that reviewers would have to notice had drifted. The branch
1666
+ // order in `interpretAccess` is this block, moved, not rewritten.
1667
+ const verdict = interpretAccess(access, methodAccessMap[request.method]);
573
1668
 
574
- auth(request: OrmRequest$, state: { [key: string]: unknown }): number | undefined {
575
- const access = this.access(request);
1669
+ if (!verdict.granted) return 403;
1670
+
1671
+ // The function return shape is the per-record hook, and `state` is the
1672
+ // whole transport for it: @stonyx/rest-server memoises one state object per
1673
+ // request and hands the same one to `auth()` and to the handler.
1674
+ if (verdict.filter) state.filter = verdict.filter;
576
1675
 
577
- if (!access) return 403;
578
- if (Array.isArray(access) && !access.includes(methodAccessMap[request.method])) return 403;
579
- if (typeof access === 'function') state.filter = access;
580
1676
  return undefined;
581
1677
  }
582
1678
  }