docs(plugin): the planner door's hiddenIds contract is the answer, not the mechanism
Some checks are pending
CI / Node 22 (push) Waiting to run
CI / Node 24 (push) Waiting to run
CI / Integration + conformance (Node 22) (push) Waiting to run
CI / Bun (latest) (push) Waiting to run

This commit is contained in:
David Snelling 2026-09-02 09:10:44 -07:00
parent f763317af7
commit 2633e8d5e1

View file

@ -460,8 +460,10 @@ export interface MetadataIndexProvider {
* @param params - The find params, already normalized by `find()`
* (natural-language parsed, `connected` anchors resolved to canonical ids,
* an empty `where` dropped).
* @param hiddenIds - Ids this read must not return; apply BEFORE paging so
* `limit` stays exact.
* @param hiddenIds - Ids this read must not return. The contract is the ANSWER, not the
* mechanism: a provider may subtract this set before paging, or derive the
* same exclusion from the params' visibility tiers itself either way the
* page must equal the engine's own answer with none of these ids in it.
* @param graphIndex - The active graph provider, for a `connected` plan.
* @returns The page's ids plus the stage that emptied it, or `null`.
*/