fix(engine): ObjectRepository declares the findOne / update shapes it already published - #17255
Conversation
…lready publishes `IScopedObjectRepository.findOne` / `.update` declare `Record<string, any> | null` and `Record<string, any> | number | null`, and `IDataEngine` — the call each of these forwards to — declares the same. `ObjectRepository` sat between two narrow declarations and re-widened the value back to `Promise<any>` on the way out, which `implements IScopedObjectRepository` accepts (a wider return always satisfies a narrower one) while every call site reaching a repository through the CLASS kept reading `any`, `ObjectQL.createContext(…).object(n).findOne(…)` included. Census: one consumer, `engine-filter-alias.test.ts`, which read `.status` off a value that can be null. Repaired with the file's own `not.toBeNull()` / `!` idiom. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU
…ared repository Compiler-driven probes (`ts.createProgram`, the idiom `packages/spec/src/contracts/scoped-context.test.ts` uses) over the exported class doors — `ScopedContext`, `ObjectQL.createContext`, `sudo()` — asserting the diagnostic NAMES the declared shape, so neither a bare "it errored" nor an `any` that erased the type can satisfy it. Anti-vacuity: the legal spelling must compile clean and no probe may report TS2307. Probes go through the CLASS, not `HookContext`: `HookContext.api` was narrowed to `IScopedContext` by #5945, so a `(ctx: HookContext)` probe is green on both sides of this fix and pins nothing. Measured, and recorded in the file header. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU
Graded `patch`: nothing is widened and no symbol is added. The contract already published these shapes; the implementation is coming back to a declaration it had already published. Checked against the recorded WHICH LEVEL ruling of 2026-09-04 (decision batch #35, on #15294), whose `minor` trigger is additive widening. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU
📓 Docs Drift CheckThis PR changes 1 package(s): 13 hand-written doc(s) NAME something this change touched and may need an implementation-accuracy re-verification:
⛔ 5 release-owned page(s) also name something this change touched. These are read-only:
What this run could not see
Coarse fallback — 17 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): Which tree this was computed onThis run read A worktree cut from an older # while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 460a9e569d4cca0db4718157b000f99eb4b8a6de && git checkout 460a9e569d4cca0db4718157b000f99eb4b8a6de
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin cf6e0a193b665e512c1e05a499464aae689ea838 6b1ab96140472c5cc425a170d8c831459e9b1a3f && git checkout -B drift-repro cf6e0a193b665e512c1e05a499464aae689ea838 && git merge --no-ff 6b1ab96140472c5cc425a170d8c831459e9b1a3f
node scripts/docs-audit/affected-docs.mjs --json cf6e0a193b665e512c1e05a499464aae689ea838
|
… BREAKING Landed precedent PR #15280 measured: `SqlDriver.update()` and the `TursoDriver.update()` override moved off an explicit `Promise<any>` onto the shape `IDataDriver` already declared -- no new exported symbol, `packages/spec` untouched -- and both changesets shipped `minor` with a **BREAKING** banner. That is this change's shape exactly, so the earlier `patch` reasoning ("the contract already published it, so nothing moved") is the very fact pattern that precedent grades `minor`: the emitted `.d.ts` read `any`, so no caller holding the class was ever asked to narrow. The ADR-0087 disposition is `no-migration-prescription`, as sibling PR #16783 used for the same family. `type-surface-only` is semantically the right category but its predicate 4 cannot address either narrowed symbol; the marker records that measurement. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU
Part of #16786
Clause-②: no
(Declared by the claiming seat, not by the implementer — the declaration is the seat's judgement (
check-clause2-carriers.mjs: ⛔ do not fill the line in on the claiming seat's behalf). This PR puts no new key on a published payload, adds no export, no closed-set member and no registry entry; it narrows two members that were already declared narrow onIScopedObjectRepository. The C5 widening-tell limb therefore has nothing to collide with. TheCheck ChangesetLEVEL AXIS refused for a MISSING declaration, not for a wrong grade —carrier: needs:contract-review is not on this PR (0 label(s) read)anddeclaration line: the PR body carries no Clause-②: line.)Deliberately not
Fixes. The card carries two gaps and this PR lands one ofthem; the seat ruling on the card keeps the other —
IScopedObjectRepository.updateById,which lives in
packages/specand belongs to thedomain:specseat — as anunfixed remainder, so this PR must not close the card on merge. The half left
open is named under "What this deliberately does not do" below.
The defect
ObjectRepository.findOneand.updatedeclaredPromise[any].Both sit between two declarations that are already narrow:
IScopedObjectRepository— the contract this class carries animplementsclause for — declares
findOneas a record-or-nullandupdateas arecord-or-count-or-
null, and has since ruling A on [finding]ObjectQL.findOne/update/deletereturnhookContext.resultunder aPromise[any]declaration — nothing to guard, because nothing is declared #16231 landed (PR feat(engine)!:findOne,updateanddeletedeclare what they answer, and their hook seams are guarded (#16231) #16783).IDataEngine.findOne/.update— the call each of these two methods forwardsto, one line down — declare the same shapes.
The class received a narrow value and re-widened it back to
anyon the way out.implementsdoes not catch that: a wider declared return always satisfies anarrower one, so
class ObjectRepository implements IScopedObjectRepositorycompiled green the entire time while the members it published were
any.So the interface's narrowing reached only call sites whose static type is the
interface. The doors this package exports are typed as the class:
What I measured, and where it refines the card
Probes compiled against
packages/objectql/srconorigin/mainae19f5edb7,before any edit:
ctx: HookContext;ctx.api!.object(n).findOne(…)api: ScopedContext;api.object(n).findOne(…)any— 0 diagnosticsql.createContext({}).object(n).findOne(…)any— 0 diagnosticsIsAny[Awaited[ReturnType[…findOne]]]on the class doortrue— confirmsanycall
ctx.api.object(name).findOne(…)"does not resolve through the narrowedinterface". For a handler typed
(ctx: HookContext) => …that is not thecase:
HookContext.apiwas narrowed toIScopedContextby #5945 / #6311, sothat exact spelling reads the narrow type today and read it before this PR too.
The defect the card names is real; the door it named is not the one that was
wide. The
anylives on the class-typed doors above, which is where the fixand the pin both go. A probe written through
HookContextis green on both sidesof this change and would have pinned nothing.
Why
minor+ BREAKING — re-graded, and why the first grade was wrongThis PR was first graded
patch, reasoning thatpackages/spec/src/contracts/scoped-context.tsalready publishes the narrower type, so the class coming into line moves no
contract. That reasoning is wrong, and the landed precedent refutes it in almost
the same words.
PR #15280 (merged 2026-09-04,
2200f8ec89) narrowedSqlDriver.update()and theTursoDriver.update()override off an explicitPromise[any]. I read its diff andboth changesets. Its files are driver src + tests + two changesets — no new
exported symbol, and
packages/specuntouched. Both changesets areminor, eachopening "BREAKING for TypeScript consumers — a published TYPE-surface
narrowing, shipped as
minorunder the launch-window convention". Its statedreason is my own
patchargument, verbatim:That is this PR exactly: contract already narrow, implementation re-widening,
.d.tspublishingany. #15280 also names PR #14434 doing the same on@objectstack/driver-memory, so it is a convention rather than one PR's choice.My earlier reading leaned on #16783's
minorbeing driven by its new exportedsymbols (three registered ADR-0112 error codes) and inferred that a pure narrowing
might stay
patch. #15280 isolates that variable and refutes the inference: no newsymbols, still
minor+ BREAKING.The break is real here for the same reason.
ObjectRepositoryis exported frompackages/objectql/src/index.ts:128, and the narrowed declarations reach thepublished
.d.ts(evidence below), so a consumer typed against the concrete class— rather than against the contract, which already said this — now gets the compiler
asking for the null check.
defect, and sibling card #15267 is landing this same family. This PR now matches.
ADR-0087 disposition:
no-migration-prescription, the category sibling #16783used for the same family.
type-surface-onlyis semantically the right category andis deliberately NOT claimed, because its predicate 4 cannot address either narrowed
symbol — measured in both spellings, and recorded in the marker itself:
packages/objectql/src/engine.ts#findOneresolves to the FIRST same-namedmember in the file,
ObjectQL.findOne(line 9761), which feat(engine)!:findOne,updateanddeletedeclare what they answer, and their hook seams are guarded (#16231) #16783 already narrowed,so predicate 4 correctly reports
narrowed-from-erased is FALSE … already CONCRETE— a true sentence about a member this diff never touches;OBJECT-LITERAL nesting and refuses a class member:
ObjectRepository.findOne does not resolve: no ObjectRepository object literal is declared.Both narrowed members are class members whose names repeat in the file, so neither
spelling can address them. Reported as a finding rather than worked around, and the
BREAKING banner is carried rather than dropped — which is the erosion #13080 was
filed about.
Census
The in-repo census for this change was one file:
engine-filter-alias.test.ts,reading
.statusoff a value that can benull. Repaired here with the file'sown
expect(...).not.toBeNull()/!idiom, which also makes the assertionnon-vacuous — under
Promise[any]that test's two spellings agreed trivially ifboth lookups returned
null.The test-typecheck debt ledger is unchanged at 44 files / 242 errors: nothing
was added to it.
The pin, and its ablation
packages/objectql/src/scoped-repository-return-narrowing.test.tsdrivests.createProgramover probe files — the idiompackages/spec/src/contracts/scoped-context.test.tsalready uses. Every negativeprobe asserts the diagnostic names the declared shape, so neither a bare "it
errored" nor an
anythat erased the type can satisfy it. Anti-vacuity: the legalspelling must compile clean, and no probe may report TS2307.
Reverse verification, run from the committed state, mutating
src/engine.tsbackto
Promise[any]on both members:No rebuild is involved in either leg: the probes resolve
../enginetosrc/engine.tsdirectly, so the mutation is visible to the compiler without adist/round trip.Verification
pnpm lint(full repo,eslint . --no-inline-config)pnpm --filter @objectstack/objectql typechecktsconfig.scripts.json+ test-layer ratchet)pnpm --filter @objectstack/objectql testscripts/pm/dispatch-gates.mjs --commands)pnpm check:dual-build-cjs-loadsPREREQUISITE NOT MET, exit 3; needs a full-repopnpm build. Its own words: "This is NOT a pass: nothing was measured." CI owns that build.pnpm check:type-check-debtPublished-surface evidence for the changeset (built, then grepped in the path
files[]actually ships):What this deliberately does not do
IScopedObjectRepository.updateByIdis untouched. It is still aPromise[any]inpackages/spec, and that surface belongs to thedomain:specseat. It stays open on [finding] Ruling A on #16231 narrows
IScopedObjectRepository, butctx.api.object(name)resolves through the CLASSObjectRepository— the hook-facing door keepsPromise<any>, andupdateByIdkeeps it too #16786 as the unfixed remainder — which is why this PRsays
Part of, not a closing keyword. Note the class side needs nothing here:ObjectRepository.updateByIdalready matches what the contract declares, sothere is no drift to repair on this side.
ScopedContext.object's return annotation is left asObjectRepository.The card's suggested shape (explicitly "not asserted") was to annotate it as
IScopedObjectRepository. I measured that route and did not take it: the classis deliberately wider than the contract in MEMBERSHIP —
create,delete,deleteById,aggregate,execute— and the class's own docblock records thatas intentional. Annotating the accessor removes those members from every
class-typed call site. Measured census for that route: 2 files / 8 errors,
six of them member-removal breaks (
Property 'delete' does not exist…,Property 'execute' does not exist…) inengine-filter-alias.test.tsandengine-repo-execute-elevation.test.ts. Repairing those would mean eithercasting around the fix or deleting live coverage. Narrowing the two drifting
members instead fixes strictly more doors (the class door, the exported
engine door, and a directly-held
ObjectRepository), removes nothing, andleaves the census at 1 file / 2 errors — both of which are the narrowing
working, not breakage.
packages/objectql/src/engine.tsin lines 11298–11801. This diff's hunk headers are
@@ -14710and@@ -14728—roughly 2,900 lines clear of the fenced region.
packages/spec/is touched. No governed surface is touched.🤖 Generated with Claude Code
https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU
Generated by Claude Code