Compare commits
3 Commits
ff78a70f14
...
v4.0.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 8bcea7c5be | |||
| 71667ca14e | |||
| e566c5b0b3 |
@@ -62,7 +62,7 @@ export const ENTRY_VALUE: string; // "urn:ng-helpers:index:value"
|
|||||||
- on the **index's own subject**, `INDEX_FIELD` carries the predicate an indexed object must carry, as a **literal**, not a URI. `create` writes it, and it is the only thing this package ever writes;
|
- on the **index's own subject**, `INDEX_FIELD` carries the predicate an indexed object must carry, as a **literal**, not a URI. `create` writes it, and it is the only thing this package ever writes;
|
||||||
- on **each entry**, whose subject is the indexed object's own `did:ng:` NURI, `ENTRY_VALUE` carries that object's value for the field, as a literal. One subject may carry more than one.
|
- on **each entry**, whose subject is the indexed object's own `did:ng:` NURI, `ENTRY_VALUE` carries that object's value for the field, as a literal. One subject may carry more than one.
|
||||||
|
|
||||||
That is everything reading takes: an anchored `SELECT ?object ?value WHERE { ?object <urn:ng-helpers:index:value> ?value }` returns the entries, for a stranger owning neither the index nor the objects exactly as for its creator; `readUnion([index])` returns the same subjects plus the index's own.
|
That is everything reading takes: an anchored `SELECT ?object ?value WHERE { ?object <urn:ng-helpers:index:value> ?value }` returns the entries, for a stranger owning neither the index nor the objects exactly as for its creator; an anchored `SELECT ?s ?p ?o WHERE { ?s ?p ?o }` returns the same subjects plus the index's own. That wider query also returns subjects under `urn:ng-eventually:` — the registers `@ng-eventually/polyfill` keeps in every document it manages; they are not this package's, and you skip them.
|
||||||
|
|
||||||
## Guarantees
|
## Guarantees
|
||||||
|
|
||||||
@@ -108,12 +108,14 @@ That is everything reading takes: an anchored `SELECT ?object ?value WHERE { ?ob
|
|||||||
|
|
||||||
- **`indexing(port)` → `indexing(sessionId)`, and it no longer returns a promise.** Pass the session id you were passing to `polyfillPort`, and delete the `polyfillPort({ sessionId })` call: this package does that wiring itself now, so `polyfillPort` and `PolyfillPortOptions` go with it. `await indexing(…)` still compiles — there is simply nothing left for it to wait for.
|
- **`indexing(port)` → `indexing(sessionId)`, and it no longer returns a promise.** Pass the session id you were passing to `polyfillPort`, and delete the `polyfillPort({ sessionId })` call: this package does that wiring itself now, so `polyfillPort` and `PolyfillPortOptions` go with it. `await indexing(…)` still compiles — there is simply nothing left for it to wait for.
|
||||||
- **`createIndex(field)` → `create(field)`**, and **`refer(index, object)` → `add(index, object)`.** Same behaviour, same throws; `add` is the verb every index carries, and it already says added-now-visible-later.
|
- **`createIndex(field)` → `create(field)`**, and **`refer(index, object)` → `add(index, object)`.** Same behaviour, same throws; `add` is the verb every index carries, and it already says added-now-visible-later.
|
||||||
- **`read(index)` is gone — read the document.** `readUnion([index])` gives you its subjects: skip the one whose subject is the index itself, take `ENTRY_VALUE` off the rest, or run the anchored `SELECT` under `## Surface`. Ordering is yours now; the call you are replacing ordered by value, broke ties on the object's NURI, and refused a document declaring no field.
|
- **`read(index)` is gone — read the document.** Run the anchored `SELECT` under `## Surface`, or read every triple of the document and skip the index's own subject, taking `ENTRY_VALUE` off the rest. Ordering is yours now; the call you are replacing ordered by value, broke ties on the object's NURI, and refused a document declaring no field.
|
||||||
- **`decodeReference` and `IndexDeposit` are gone**, with the types that served only the calls above: `NextGraphPort`, `IndexEntry`, `IndexDescriptor`, `ObjectResolution`, `IncomingDeposit`, `UnionSubject`. `Nuri`, `NuriLike` and `Indexing` stay.
|
- **`decodeReference` and `IndexDeposit` are gone**, with the types that served only the calls above: `NextGraphPort`, `IndexEntry`, `IndexDescriptor`, `ObjectResolution`, `IncomingDeposit`, `UnionSubject`. `Nuri`, `NuriLike` and `Indexing` stay.
|
||||||
- **Nothing replaces the guarantees about processing, and nothing needs to.** `3.0.0` engaged that awaiting a handle applied what an identity's indexes had received, kept applying it, caught up a backlog, resolved each reference, passed over an object carrying nothing or too much, and refused an index declaring two fields. None of that is engaged here any more. If your application relied on a handle being what made an index fill, it no longer is — and no longer has to be: the index fills whether that handle exists or not.
|
- **Nothing replaces the guarantees about processing, and nothing needs to.** `3.0.0` engaged that awaiting a handle applied what an identity's indexes had received, kept applying it, caught up a backlog, resolved each reference, passed over an object carrying nothing or too much, and refused an index declaring two fields. None of that is engaged here any more. If your application relied on a handle being what made an index fill, it no longer is — and no longer has to be: the index fills whether that handle exists or not.
|
||||||
|
|
||||||
**`3.0.0` stopped engaging on what `read` returned** — its ordering, its tie-breaks, what it made of a subject carrying several values — replacing those guarantees with the storage shape under `## Surface`, and dropped `PrincipalId`, listed as re-exported and never exported. **`2.0.0` removed `Indexing.curate(index)`**, with `CurationReport`, `CurationOutcome` and `SkipReason`. `2.0.1`, `1.0.1` and `1.0.0` keep resolving.
|
**`3.0.0` stopped engaging on what `read` returned** — its ordering, its tie-breaks, what it made of a subject carrying several values — replacing those guarantees with the storage shape under `## Surface`, and dropped `PrincipalId`, listed as re-exported and never exported. **`2.0.0` removed `Indexing.curate(index)`**, with `CurationReport`, `CurationOutcome` and `SkipReason`. `2.0.1`, `1.0.1` and `1.0.0` keep resolving.
|
||||||
|
|
||||||
Cut on `main`: pin `4.0.0`, and anchor your `usage_` leaf on `against: @ng-helpers/indexing@4.0.0`.
|
**`4.0.1` is a patch**: nothing exported and nothing under `## Guarantees` moved; what moved is how this leaf tells you to read an index. It used to name `@ng-eventually/polyfill`'s `readUnion([index])`, which that package has since withdrawn; the anchored `SELECT` it already named is now the only one, and a wider one meets the polyfill's own `urn:ng-eventually:` registers, which you skip.
|
||||||
|
|
||||||
|
Cut on `main`: pin `4.0.1`, and anchor your `usage_` leaf on `against: @ng-helpers/indexing@4.0.1`.
|
||||||
|
|
||||||
**No changelog file and no deprecation window: the sections above are the release note.** Diff `## Guarantees`, `## Non-guarantees` and `## Surface` between two pulls.
|
**No changelog file and no deprecation window: the sections above are the release note.** Diff `## Guarantees`, `## Non-guarantees` and `## Surface` between two pulls.
|
||||||
|
|||||||
@@ -0,0 +1,169 @@
|
|||||||
|
---
|
||||||
|
type: contract
|
||||||
|
summary: The machinery ng-e2e-helpers offers a NextGraph application's end-to-end suite — wallets, the broker crossing, per-run profiles, bounds, and a bounded report
|
||||||
|
pulled_from: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/e2e-harness/ng-e2e-helpers/contract_ng-e2e-helpers.md
|
||||||
|
pulled_version: d44063961682f84d4b804e5b349cd0a791dd9550
|
||||||
|
pulled_at: 2026-09-21
|
||||||
|
---
|
||||||
|
|
||||||
|
# contract_ng-e2e-helpers — `ng-e2e-helpers`
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This package is the end-to-end testing machinery a NextGraph application needs to get a real person into itself: minting a wallet by driving the wallet application, crossing the broker, and coming back inside the iframe the application runs in — plus per-run browser profiles, bounds that turn a hang into a named failure, and a run report whose size does not depend on what failed.
|
||||||
|
|
||||||
|
It covers **only what is generic to NextGraph**. It knows nothing about any one application, and nothing about any compatibility layer: an application calling the NextGraph SDK directly is its intended consumer. What is specific to your repository — the page that carries your application, how you build your bundle, which journeys you run — is yours to write, and this package deliberately offers no place to put it.
|
||||||
|
|
||||||
|
It is not a test runner, not an assertion library, and not a fixture system. You keep your own runner and your own `main()`.
|
||||||
|
|
||||||
|
### Deployment requirements
|
||||||
|
|
||||||
|
`playwright` and `@ng-org/web` are **peer dependencies**, and you own both versions: browser binaries have to match the driver, and the SDK the export page opens a session with must be the one your application and your broker agree on. Import the browser types from the helpers that return them rather than from `playwright` directly — a second resolution of the driver produces a structurally different `BrowserContext`, and a context you opened then cannot be handed back to the helper that opens contexts.
|
||||||
|
|
||||||
|
A machine running this needs a real Chromium, network reach to the wallet application and to the broker, and a writable temporary directory for the per-run profiles.
|
||||||
|
|
||||||
|
## Surface
|
||||||
|
|
||||||
|
Full typed shape: the package's `types` entry, `ng-e2e-helpers`. It also ships one executable, `ng-mint-wallet`, for provisioning a deployment's wallet file outside any run. `BrowserContext`, `Frame`, and `Page` — every Playwright type this surface mentions, no more — are re-exported as types from the same entry point, so a consumer can type its own helper functions against these signatures without a second, independently-versioned import of `playwright`. The load-bearing signatures:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ── bounds: a hang becomes a named failure ───────────────────────────────────
|
||||||
|
export function within<T>(what: string, ms: number, task: () => Promise<T>): Promise<T>;
|
||||||
|
export class DeadlineExceeded extends Error {} // thrown by `within` — names `what`
|
||||||
|
export class BrowserGone extends Error {} // the browser died; not the task's fault
|
||||||
|
export function enclosingBound(steps: readonly number[], margin: number): number;
|
||||||
|
export function closeQuietly(what: string, close: () => Promise<unknown>): Promise<void>;
|
||||||
|
export function armSuiteDeadline(suite: string, ms: number, thenReport?: () => void): void;
|
||||||
|
export function browserLost(reason: string): void; // declare it, once
|
||||||
|
export function lossDeclared(): string | null; // has it been declared?
|
||||||
|
export function firstLine(e: unknown): string;
|
||||||
|
export const CLOSE_MS: number, CONTEXT_ACTION_MS: number, CONTEXT_NAVIGATION_MS: number;
|
||||||
|
|
||||||
|
// ── measurement: how a bound gets its number ─────────────────────────────────
|
||||||
|
export function measured<T>(what: string, bound: number, task: (ms: number) => Promise<T>): Promise<T>;
|
||||||
|
export function record(what: string, ms: number, ok: boolean, bound: number): void;
|
||||||
|
export function timingsWanted(): boolean; // true under E2E_TIMINGS=1
|
||||||
|
export function printTimings(): void;
|
||||||
|
|
||||||
|
// ── browser and profiles: one run owns its own ───────────────────────────────
|
||||||
|
export interface RunProfile { readonly dir: string; readonly purpose: string; discard(): void }
|
||||||
|
export function newRunProfile(purpose: string): RunProfile;
|
||||||
|
export function isAlive(pid: number): boolean;
|
||||||
|
export function launchWatchedContext(label: string, dir: string): Promise<BrowserContext>;
|
||||||
|
export function closeContext(label: string, ctx: BrowserContext): Promise<void>;
|
||||||
|
export function newPage(label: string, ctx: BrowserContext): Promise<Page>;
|
||||||
|
export const LAUNCH_MS: number, NEW_PAGE_MS: number;
|
||||||
|
|
||||||
|
// ── the wallet: minted, carried, imported ────────────────────────────────────
|
||||||
|
export interface WalletCredentials { readonly name: string; readonly password: string }
|
||||||
|
export const DEFAULT_WALLET_NAME: string; // the password never has a default
|
||||||
|
export function mintWalletProfile(purpose: string, c: WalletCredentials): Promise<RunProfile>;
|
||||||
|
export function mintWalletProfileKeepingContext(
|
||||||
|
purpose: string, c: WalletCredentials): Promise<{ ctx: BrowserContext; profile: RunProfile }>;
|
||||||
|
export function mintWalletBytes(password: string, name?: string): Promise<Uint8Array>;
|
||||||
|
export function createWalletInContext(ctx: BrowserContext, c: WalletCredentials): Promise<void>;
|
||||||
|
export function emptyProfileContext(
|
||||||
|
purpose: string): Promise<{ ctx: BrowserContext; profile: RunProfile }>;
|
||||||
|
export function exportWalletBytes(ctx: BrowserContext, walletPassword: string): Promise<Uint8Array>;
|
||||||
|
export function exportWalletFile(ctx: BrowserContext, ngwPath: string, pw: string): Promise<number>;
|
||||||
|
export function importWalletFile(page: Page, ngwPath: string, password: string): Promise<void>;
|
||||||
|
|
||||||
|
// ── the broker crossing ──────────────────────────────────────────────────────
|
||||||
|
export function setupBrokerPage(page: Page, appUrl: string, walletPassword: string): Promise<Frame>;
|
||||||
|
export function completeBrokerLogin(page: Page, appUrl: string, pw: string): Promise<Frame>;
|
||||||
|
export const BROKER_LOGIN_MS: number, BROKER_ROUND_TRIP_MS: number;
|
||||||
|
export function brokerRedirectFor(appUrl: string): string;
|
||||||
|
export const BROKER_SCREENS: readonly BrokerScreenSpec[]; // the screens, in test order
|
||||||
|
export const WALLET_APP, WALLET_CREATION, WALLET_IMPORT; // the wallet application's own pages
|
||||||
|
export type BrokerScreen = "choose-broker" | "login-offered" | "wallet-list"
|
||||||
|
| "password" | "working" | "error";
|
||||||
|
export type { BrokerScreenSpec, ScreenSignature, ScreenResponse, TextPattern };
|
||||||
|
|
||||||
|
// ── serving your application to the browser ──────────────────────────────────
|
||||||
|
export function serveOnEphemeralPort(
|
||||||
|
handler: (req: IncomingMessage, res: ServerResponse) => void,
|
||||||
|
): Promise<{ url: string; close: () => void }>;
|
||||||
|
|
||||||
|
// ── failures that are not the application's ──────────────────────────────────
|
||||||
|
export function browserTrouble(label: string, ctx: BrowserContext): Promise<string | null>;
|
||||||
|
export function frameTrouble(id: string, page: Page, frame: Frame, marker: string): Promise<string | null>;
|
||||||
|
export const BROWSER_PROBE_MS: number, FRAME_PROBE_MS: number;
|
||||||
|
|
||||||
|
// ── the report ───────────────────────────────────────────────────────────────
|
||||||
|
export interface JourneyDeclaration { readonly name: string; readonly checks: readonly string[] }
|
||||||
|
export type Prerequisite = () => Promise<string | null> | (string | null);
|
||||||
|
export interface JourneySpec {
|
||||||
|
readonly name: string; // must be a declared journey
|
||||||
|
readonly needs?: readonly Prerequisite[]; // each answers null, or why it cannot start
|
||||||
|
readonly run: () => Promise<void>;
|
||||||
|
}
|
||||||
|
export interface SuiteOptions {
|
||||||
|
readonly label: string;
|
||||||
|
readonly journeys: readonly JourneyDeclaration[];
|
||||||
|
readonly journeyBound: number;
|
||||||
|
readonly diagnose?: () => Promise<string | null>;
|
||||||
|
}
|
||||||
|
export interface SuiteReport {
|
||||||
|
check(name: string, ok: boolean, detail?: string): void; // throws on an undeclared name
|
||||||
|
journey(spec: JourneySpec): Promise<void>;
|
||||||
|
finish(fatal: string | null): never; // prints, then leaves
|
||||||
|
}
|
||||||
|
export function declareSuite(options: SuiteOptions): SuiteReport;
|
||||||
|
|
||||||
|
// ── playwright types this surface mentions, re-exported so a second import isn't needed ─────
|
||||||
|
export type { BrowserContext, Frame, Page };
|
||||||
|
```
|
||||||
|
|
||||||
|
## Guarantees
|
||||||
|
|
||||||
|
**A bound names what it was waiting for.** `within(what, ms, task)` either settles the task or throws a `DeadlineExceeded` carrying `what` verbatim — never a bare timeout with no subject. `armSuiteDeadline` does the same for a whole run, and reports before leaving. `enclosingBound(steps, margin)` returns a number no smaller than the sum of the bounds it encloses, so an enclosure can never fire before the step that actually hung.
|
||||||
|
|
||||||
|
**A run owns its profile and discards it.** `newRunProfile` returns a directory belonging to this run alone; `discard()` kills whatever still holds it and removes it, is idempotent, and also runs when the process leaves — including when the run is killed. Two runs never share local state, so nothing a previous run left can make this one pass or fail.
|
||||||
|
|
||||||
|
**A minted wallet is new.** `mintWalletProfile`/`mintWalletBytes` walk the wallet application to create a wallet that did not exist a moment ago. `mintWalletBytes` keeps only the bytes and discards the profile it minted in; `mintWalletProfile` keeps the profile for the length of the run. The password is always a parameter and never has a default; the name defaults to `DEFAULT_WALLET_NAME` because nothing in NextGraph keys off it.
|
||||||
|
|
||||||
|
**The crossing dispatches on the screen it can see**, not on a fixed sequence: `setupBrokerPage` reads the page against `BROKER_SCREENS` in order, answers it, and returns the application's `Frame` once the crossing has completed. It identifies the application by ORIGIN. A terminal screen ends the crossing as a failure rather than an action.
|
||||||
|
|
||||||
|
**An empty-profile context starts with nothing local.** `emptyProfileContext` gives a context whose profile holds no wallet and no repo cache, which is the reconnection cold start: the wallet's repos are on the broker and not in this profile. `importWalletFile` then puts the wallet in — but not the repos' cache — so the next session over it still hits that cold start.
|
||||||
|
|
||||||
|
**A closed server is closed.** `serveOnEphemeralPort` tracks its open sockets and destroys them on `close()`, so a connection nobody hung up cannot be blamed on whatever goes wrong next.
|
||||||
|
|
||||||
|
**A known failure mode is named instead of the innocent operation.** `browserTrouble`/`frameTrouble` answer a string when the browser or the application frame is the actual cause, and `null` when they are not. `SuiteOptions.diagnose` puts that answer in FRONT of a journey's own reason, never in place of it. A frame that is attached, on the right URL, and empty is reported as trouble — that is the state a naive check misses.
|
||||||
|
|
||||||
|
**The report's size does not depend on what failed.** Journeys and their checks are declared up front to `declareSuite`; `check` throws on a name the journey did not declare, `journey` runs one journey bounded and isolated so it cannot change the report's shape, and `finish` reports every declared check the run did not get to before printing and exiting. A journey whose prerequisite is provably dead is reported as such instead of being driven.
|
||||||
|
|
||||||
|
**Errors are values where a caller can act on them.** `browserTrouble`/`frameTrouble`/`Prerequisite` answer `string | null`, never throw for the condition they detect. `DeadlineExceeded` and `BrowserGone` are exported classes, so `instanceof` is a supported way to tell a hang from a dead browser.
|
||||||
|
|
||||||
|
## Non-guarantees
|
||||||
|
|
||||||
|
**No assertion library, no runner, no fixtures.** `SuiteReport.check` records a boolean you computed; nothing here decides what is true.
|
||||||
|
|
||||||
|
**`finish` never returns** — it exits the process. Do not put cleanup after it; put it in the `discard()`/`closeQuietly` path.
|
||||||
|
|
||||||
|
**No message text is stable.** The strings from `browserTrouble`, `frameTrouble`, `DeadlineExceeded` and the report are for a human reading a run. Do not parse them, match on them, or branch on them.
|
||||||
|
|
||||||
|
**No timing promise.** Every exported `*_MS` constant is a bound sized from a measurement on one machine, not a service level: they change when the measurements change, and a run slower than one of them is a failed run, not a broken guarantee. `E2E_TIMINGS=1` reprints the measurements so you can resize your own.
|
||||||
|
|
||||||
|
**Nothing survives a run.** Profiles are discarded, and no artifact, cache, or wallet is carried from one run to the next. The one exception is a file you write yourself with `exportWalletFile` or `ng-mint-wallet`.
|
||||||
|
|
||||||
|
**No concurrency contract.** The suite machinery assumes one run per process. Two suites sharing a process share `armSuiteDeadline`, the timings table and the loss declaration.
|
||||||
|
|
||||||
|
**No wallet-application version pinning.** The crossing is driven against the wallet application as deployed at the broker you point it at. When that application changes its screens, `BROKER_SCREENS` is what has to be updated — a crossing that fails there is not necessarily your application's fault, and is not this package's promise to hold across upstream redesigns.
|
||||||
|
|
||||||
|
## Change policy
|
||||||
|
|
||||||
|
**Semver, and majors are the normal case.** This machinery tracks a NextGraph and a wallet application that are both still moving, so a screen inventory, a bound, or a call shape changes whenever they do — the major number will move often, and that frequency is the honest signal about this package, not an apology. Refusing to version would not slow the churn down; it would only take away the one tool you have for managing it. Pin a version, upgrade deliberately, and re-pull this contract each time.
|
||||||
|
|
||||||
|
What each level means here, in this package's own terms:
|
||||||
|
|
||||||
|
- **major** — an exported symbol is removed or renamed, **or** an existing call narrows: it now throws where it returned, requires an argument that was optional, or returns something a caller must newly handle. A change to what a `SuiteReport` accepts (a check name, a journey shape) is a major, because your suite is written against it. A signature change a caller must react to counts; one that only accepts more than before does not.
|
||||||
|
- **minor** — a symbol is added and nothing existing moves: a new helper, a new screen in `BROKER_SCREENS`, a new optional field on `SuiteOptions`.
|
||||||
|
- **patch** — a fix that changes neither the exported surface nor anything above under `## Guarantees` — including a re-sized `*_MS` constant, which is explicitly disclaimed above.
|
||||||
|
|
||||||
|
**A tag says where it comes from.** A release cut on `main` carries a **full version** (`1.0.0`), and the three rules above govern what changes between two full versions. Work still on a branch carries a **pre-release** of the version it is heading for (`1.0.0-dev.3`), which sorts *below* that version by construction — so you can pin what exists today while the tag itself tells you the surface has not been released and may still move before it is. Between two pre-releases of the same version nothing is promised: re-pull and read this leaf again. When the branch lands, the full version appears alongside; the pre-release keeps resolving, so no reference you pinned is ever withdrawn from under you.
|
||||||
|
|
||||||
|
**Tags carry the package name**, because this repository publishes more than one engagement and their versions move independently: `ng-e2e-helpers/v1.0.0-dev.2` is this package, `polyfill/v…` is the other one. A bare `v…` tag would say nothing about which surface it froze the day the two diverge — which is the day one of them takes a major and the other does not.
|
||||||
|
|
||||||
|
`1.0.0` is a baseline, not a claim of maturity: it is the number that makes your pin mean something. Nothing was released before it. What exists today is `1.0.0-dev.2`, on a branch: pin that string exactly, and anchor your `usage_` leaf's `against:` on it — `against: ng-e2e-helpers@1.0.0-dev.2`, the string you pinned, never the version it is heading for.
|
||||||
|
|
||||||
|
There is no changelog file and no deprecation window: **the sections above are the release note.** A removal or a narrowing lands in `## Surface` and `## Guarantees` in the same version that ships it. Diff this leaf between two pulls — `## Guarantees` and `## Non-guarantees` before `## Surface`, because that is where a narrowing shows up first.
|
||||||
@@ -1,49 +1,52 @@
|
|||||||
---
|
---
|
||||||
type: usage
|
type: usage
|
||||||
summary: What this repo's end-to-end suite calls from ng-e2e-helpers, the peer-dependency constraint it must respect, and the gaps it fills itself
|
summary: What this repository's end-to-end suite calls from ng-e2e-helpers - bounds, profiles, the minted wallet, the broker crossing, and the run report
|
||||||
against: ng-e2e-helpers@1.0.0-dev.1
|
against: "ng-e2e-helpers@1.0.0-dev.2 (pulled d44063961682f84d4b804e5b349cd0a791dd9550)"
|
||||||
---
|
---
|
||||||
|
|
||||||
# usage_ng-helpers — `@ng-helpers/indexing`'s end-to-end suite on `ng-e2e-helpers`
|
# usage_ng-helpers - `@ng-helpers/indexing`'s end-to-end suite on `ng-e2e-helpers`
|
||||||
|
|
||||||
The consumer is this repository's end-to-end suite: one run that builds a small indexing application, serves it, gets real people into it through the real broker, and drives depositing and curating between them.
|
The consumer is this repository's end-to-end suite: one run that builds a small indexing application, serves it, gets two real people into it through the real broker, and drives depositing and curating between them.
|
||||||
|
|
||||||
Everything generic — the wallet lifecycle, the broker crossing, per-run profiles, bounds, the report shape, the recognition of the known browser failure modes — comes from the engagement and is **used, never reimplemented**. What is specific to this repository is the page that carries our application and the name its runs mint, and nothing else.
|
Everything generic - the wallet lifecycle, the broker crossing, per-run profiles, bounds, the report shape, the recognition of the known browser failure modes - comes from the engagement and is **used, never reimplemented**. What is specific to this repository is the page that carries the application, the name its runs mint, and the journeys themselves. Two files touch the engagement: `e2e/harness-page.ts` and `e2e/run.ts`.
|
||||||
|
|
||||||
## Consumed surface
|
## Consumed surface
|
||||||
|
|
||||||
**Bounds** — `within`, `armSuiteDeadline`, `closeQuietly`, `firstLine`.
|
- **Bounds** - `within`, `armSuiteDeadline`, `closeQuietly`, `firstLine`.
|
||||||
|
- **Measurement** - `measured`.
|
||||||
|
- **Browser and profiles** - `launchWatchedContext`, `closeContext`, `newPage`, and the type `RunProfile`.
|
||||||
|
- **Wallet** - `mintWalletProfile` and the type `WalletCredentials`. Each run mints its own.
|
||||||
|
- **Broker crossing** - `setupBrokerPage`.
|
||||||
|
- **Serving** - `serveOnEphemeralPort`, for the application bundle.
|
||||||
|
- **Known failure modes** - `browserTrouble`, wired as the suite's `diagnose`.
|
||||||
|
- **Report** - `declareSuite` and the type `Prerequisite`; on the handle it returns, all three of `check`, `journey` and `finish`. The `JourneyDeclaration`, `JourneySpec` and `SuiteOptions` shapes are consumed structurally, through those calls, rather than imported.
|
||||||
|
- **Constants** - `BROKER_ROUND_TRIP_MS`, `NEW_PAGE_MS`, each used as a term of a bound this suite composes.
|
||||||
|
- **Browser types** - `BrowserContext`, `Page` and `Frame`, obtained by DERIVING them from the helpers that return them (`Awaited<ReturnType<typeof ...>>`) rather than by importing them. See `## Constraints`.
|
||||||
|
|
||||||
**Measurement** — `measured`.
|
**Not consumed**, and safely evolvable as far as this suite is concerned: `completeBrokerLogin`, `brokerRedirectFor`, `BROKER_SCREENS` and the screen inventory types, `WALLET_APP` / `WALLET_CREATION` / `WALLET_IMPORT`, `emptyProfileContext`, `importWalletFile`, `exportWalletBytes` / `exportWalletFile`, `mintWalletBytes`, `mintWalletProfileKeepingContext`, `createWalletInContext`, `newRunProfile`, `isAlive`, `browserLost`, `lossDeclared`, `enclosingBound`, `frameTrouble`, `record`, `timingsWanted`, `printTimings`, `DEFAULT_WALLET_NAME`, the exported error classes `DeadlineExceeded` and `BrowserGone`, the `ng-mint-wallet` executable, and the remaining `*_MS` constants.
|
||||||
|
|
||||||
**Browser and profiles** — `launchWatchedContext`, `closeContext`, `newPage`, and the type `RunProfile`.
|
|
||||||
|
|
||||||
**Wallet** — `mintWalletProfile` and the type `WalletCredentials`. Each run mints its own.
|
|
||||||
|
|
||||||
**Broker crossing** — `setupBrokerPage`.
|
|
||||||
|
|
||||||
**Serving** — `serveOnEphemeralPort`, for the application bundle.
|
|
||||||
|
|
||||||
**Known failure modes** — `browserTrouble`, wired as the suite's `diagnose`.
|
|
||||||
|
|
||||||
**Report** — `declareSuite` and the type `Prerequisite`.
|
|
||||||
|
|
||||||
**Constants** — `BROKER_ROUND_TRIP_MS`, `NEW_PAGE_MS`.
|
|
||||||
|
|
||||||
Everything else the engagement offers is NOT consumed here: the screen inventory and its types, `completeBrokerLogin`, `emptyProfileContext`, `importWalletFile`, `exportWalletBytes`/`exportWalletFile`, `mintWalletBytes`, `mintWalletProfileKeepingContext`, `createWalletInContext`, `newRunProfile`, `isAlive`, `browserLost`, `lossDeclared`, `enclosingBound`, `frameTrouble`, the exported error classes, and the remaining `*_MS` constants. It is safely evolvable as far as this suite is concerned.
|
|
||||||
|
|
||||||
## Constraints
|
## Constraints
|
||||||
|
|
||||||
**The browser types are DERIVED from the helpers, never imported from `playwright` here.** The engagement declares Playwright a peer dependency, and this package reaches it as symlinked files — so TypeScript resolves the helpers' `playwright` from where those files really live. Importing the driver in this repository as well produced two structurally different copies of `BrowserContext`, and a context this suite had opened could not be handed back to the helper that opens contexts. Taking the types from the calls that return them leaves exactly one set, and a version skew can no longer express itself as a type error in code that is correct.
|
**The browser types are DERIVED from the helpers, never imported from `playwright` here.** The engagement declares Playwright a peer dependency and this package reaches this repository as symlinked files, so TypeScript resolves the helpers' `playwright` from where those files really live. Importing the driver in this repository as well produced two structurally different copies of `BrowserContext`, and a context this suite had opened could not be handed back to the helper that opens contexts. Taking the types from the calls that return them leaves exactly one set. The engagement now re-exports those same three types from its own entry point, which reaches the same single-set guarantee by a shorter road; what must keep holding either way is that there is exactly ONE resolution of the driver in this repository.
|
||||||
|
|
||||||
**One wallet per run, minted, never carried.** The run's wallet name is stable and its identity is not; nothing survives a run, and no result depends on a previous one.
|
**One wallet per run, minted, never carried.** The run's wallet name is stable and its identity is not; nothing survives a run, and no result depends on a previous one. That is also what lets this suite run beside another repository's at the same time, against the same broker, without a lock.
|
||||||
|
|
||||||
**Nothing generic is reimplemented here.** Where a helper exists, it is called. That is a standing rule for this suite, not a preference — the crossing alone has cost days of misdiagnosis upstream, and a local copy of it would not carry those lessons.
|
**Nothing generic is reimplemented here.** Where a helper exists, it is called. That is a standing rule for this suite, not a preference - the crossing alone has cost days of misdiagnosis upstream, and a local copy of it would not carry those lessons.
|
||||||
|
|
||||||
**Every wait is entered bounded.** No page or frame operation runs outside `within` or a helper that bounds it itself.
|
**Every wait is entered bounded.** No page or frame operation runs outside `within` or a helper that bounds it itself.
|
||||||
|
|
||||||
|
**No failure text is parsed.** What `browserTrouble` answers and what a deadline carries are reported to a human reading the run and never matched on or branched on; a failed check carries an unexpected VALUE, and that is what the suite decides from.
|
||||||
|
|
||||||
|
**Two suites never share this run's machinery.** One suite deadline is armed and one timings table is kept, and nothing here assumes either can be shared - the engagement offers no concurrency guarantee and this suite asks for none.
|
||||||
|
|
||||||
## Frictions
|
## Frictions
|
||||||
|
|
||||||
**Nothing bounds a call into the application iframe.** `frame.evaluate` carries no timeout of its own, so this suite wraps every bridge call itself. The engagement offers no way to obtain that bound, so each consumer re-derives the same wrapper — and the derivation is not free: the calls this suite reached for outside its own wrapper are exactly the ones that can still hang it. A bounded `evaluate` here would delete the wrapper and close the gap in one move.
|
**The acquisition channel carries no version, so the Change policy has nothing to bite on.** The engagement asks for a pinned version; this repository reaches the package as a filesystem link, so what it compiles and runs against is whatever branch happens to be checked out at the other end - and the `ref:` pinned for this contract is a branch, for the same reason. The `against:` line above is the only pin that actually exists on this side. A tag-addressable, fetchable source would turn the semver discipline from a description into a mechanism.
|
||||||
|
|
||||||
**"Measured and bounded" is one intent and two calls.** Sizing a bound from its own measurement is the discipline the engagement itself prescribes, yet every step in this suite has to compose `measured(what, ms, (bound) => within(what, bound, task))` by hand. Two consumers writing the same three-line helper is the tell that the pair belongs on the engagement.
|
**Nothing bounds a call into the application iframe.** `frame.evaluate` carries no timeout of its own, so this suite wraps every bridge call itself. The engagement offers no way to obtain that bound, so each consumer re-derives the same wrapper - and the derivation is not free: the calls this suite reached for outside its own wrapper are exactly the ones that can still hang a run. A bounded `evaluate` here would delete the wrapper and close the gap in one move.
|
||||||
|
|
||||||
|
**"Measured and bounded" is one intent and two calls.** Sizing a bound from its own measurement is the discipline the engagement itself prescribes, yet every step in this suite has to compose `measured(what, ms, (bound) => within(what, bound, task))` by hand, in a local helper written for that purpose alone. Two consumers writing the same three-line helper is the tell that the pair belongs on the engagement.
|
||||||
|
|
||||||
|
## Needs
|
||||||
|
|
||||||
|
**A bounded read-until-it-holds that reports what it saw.** Convergence in NextGraph is asynchronous everywhere - nothing on any surface says "it has arrived" - so a check that reads the instant after an act reads too early, and this suite has to carry its own loop: read, test, sleep, and on expiry throw naming what never arrived AND what was held instead, so the journey's remaining checks are reported unreached with an observation rather than a bare timeout. That is not specific to indexing; it is what any application's suite needs against a system that converges, and it sits exactly where the engagement's bounds already sit. What must not be lost if it moves onto the engagement: the assertions run ONCE on the reading handed back, never re-run inside the loop - a loop that retried the assertions would turn a flapping result into a green one.
|
||||||
|
|||||||
@@ -0,0 +1,441 @@
|
|||||||
|
---
|
||||||
|
type: contract
|
||||||
|
summary: The API @ng-eventually/polyfill exposes to an application — signatures, guaranteed behaviour, and what it does not offer
|
||||||
|
pulled_from: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/app-contract/polyfill-surface/contract_polyfill-surface.md
|
||||||
|
pulled_version: ec3900077bfd090f5388e52b47a8132b2fc68d16
|
||||||
|
pulled_at: 2026-10-01
|
||||||
|
---
|
||||||
|
|
||||||
|
# contract_polyfill-surface — `@ng-eventually/polyfill`
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This package is a polyfill of NextGraph's SDK.
|
||||||
|
|
||||||
|
This package covers placement (creating an application's documents in one of its three stores), reading (a document's subjects, one-shot or reactive, by shape), writing one shape-typed object, sharing a document with a named user, and depositing into inboxes. It does not cover user management, display names, transport, or the operation of a deployment.
|
||||||
|
|
||||||
|
### Deployment requirements
|
||||||
|
|
||||||
|
An application using this package must:
|
||||||
|
|
||||||
|
- serve a wallet file (`.ngw`) from its own bundle, and pass its URL and password to `configure` as `sharedWallet: { fileUrl, password }`;
|
||||||
|
- pass `configure` the SDK's shape query (`ormSubscription: RdfOrmSubscription.getOrCreate`, from `@ng-org/orm`) and its `initNg`, and call this package's `initNg(ng, session)` once a session has arrived, if it uses `useShapeQuery`. That read goes through the SDK now, and the SDK is injected here rather than imported; without the injection the read publishes `isError` naming the field;
|
||||||
|
- pass `configure` the SDK's `getObjects` and `insertObject` (from `@ng-org/orm`, as they stand) if it calls the calls of the same name here. Same reason and same shape as the shape query: they are injected rather than imported, and without the injection each throws naming the field to pass;
|
||||||
|
- call this package's `initNg`, not the SDK's, whenever it uses anything of the ORM. That call decides which `ng` the ORM reaches the engine through, and this package substitutes its own - the same object `ng` publishes - so that an ORM write meets the same guard every other write meets. Calling `@ng-org/orm`'s `initNg` directly leaves ORM writes ungoverned;
|
||||||
|
- call `init(…)` — this package's, not the one it passed to `configure` — and then await `ensureIdentity()`, in a browser context, before rendering its interface. `ensureIdentity()` resolves once a session is open, and a session arrives only through `init`: awaited before `init` has been called, it throws and names the call to make first;
|
||||||
|
- **declare this package exactly once**, so that everything in the application resolves to one copy of it — see the single-copy rule under `## Non-guarantees`, which is the one packaging mistake this surface cannot protect you from.
|
||||||
|
|
||||||
|
**Obtaining it.** This package is not published to a public registry, and it is not distributed as built output: its published entry point is TypeScript source, so whatever builds the application is what compiles it, and a toolchain that accepts only JavaScript cannot consume it as it stands. By which channel the source reaches a given application is agreed with that application rather than fixed here; what this contract fixes is the version you pin and the rules below.
|
||||||
|
|
||||||
|
## Surface
|
||||||
|
|
||||||
|
Full typed shape: the package's `types` entry, `@ng-eventually/polyfill`. A type is published only when a published signature uses it. The load-bearing signatures:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// ── bootstrap ────────────────────────────────────────────────────────────
|
||||||
|
export function configure(c: EventuallyConfig): void;
|
||||||
|
export interface EventuallyConfig {
|
||||||
|
ng: NgLike; // the `ng` object from @ng-org/web
|
||||||
|
// The ORM's REACT hook. It is NOT on `@ng-org/orm`'s main entry - that resolves to
|
||||||
|
// `core`, which exports no `useShape` - so import it from `@ng-org/orm/react` (the
|
||||||
|
// default export) or as `reactUseShape` from `@ng-org/orm/all`. Pass it as it
|
||||||
|
// stands; no wrapper, no cast.
|
||||||
|
useShape: UseShapeLike;
|
||||||
|
// `RdfOrmSubscription.getOrCreate` from @ng-org/orm - the SDK's shape query, which
|
||||||
|
// `useShapeQuery` reads through. Pass it as it stands; no wrapper, no cast.
|
||||||
|
ormSubscription?: OrmSubscriptionLike;
|
||||||
|
getObjects?: GetObjectsLike; // `getObjects` from @ng-org/orm
|
||||||
|
insertObject?: InsertObjectLike; // `insertObject` from @ng-org/orm
|
||||||
|
sharedWallet?: SharedWalletConfig; // { fileUrl, password, importUrl? }
|
||||||
|
debugAccessLog?: boolean;
|
||||||
|
init?: (...args: any[]) => any;
|
||||||
|
initNg?: (...args: any[]) => any;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── identity — one await before the application renders ──────────────────
|
||||||
|
export async function ensureIdentity(): Promise<PrincipalId>; // returns who you are
|
||||||
|
|
||||||
|
// ── addressing ───────────────────────────────────────────────────────────
|
||||||
|
export type Nuri = `did:ng:${string}`;
|
||||||
|
export type NuriLike = Nuri | string;
|
||||||
|
// The SDK's own scope, re-exported unchanged. It scopes a READ, on two axes and no third.
|
||||||
|
export type Scope = { graphs?: string[] | string; subjects?: string[] };
|
||||||
|
|
||||||
|
// ── placement: where an application's documents live ─────────────────────
|
||||||
|
// A store is named by its REFERENCE — one accessor per store, and `createEntityDoc` takes
|
||||||
|
// one of them. Omit it and the document goes to the private store.
|
||||||
|
export const storeRegistry: { // no identity parameter — a session is one user's
|
||||||
|
privateStore(): Promise<Nuri>;
|
||||||
|
protectedStore(): Promise<Nuri>;
|
||||||
|
publicStore(): Promise<Nuri>;
|
||||||
|
createEntityDoc(store?: NuriLike): Promise<Nuri>;
|
||||||
|
openDocumentInbox(doc: NuriLike): Promise<Nuri>;
|
||||||
|
};
|
||||||
|
|
||||||
|
// ── reading ──────────────────────────────────────────────────────────────
|
||||||
|
// Reading a document BY NAME is `docs.sparqlQuery` below - one anchored query, one
|
||||||
|
// document. `readUnion` and `UnionSubject` were published here until `1.0.0-dev.8`;
|
||||||
|
// nothing takes their place, because they were that call in a loop plus policies of
|
||||||
|
// this package's own. See `## Change policy`.
|
||||||
|
export function useShape<T extends BaseType>( // read-filtered view
|
||||||
|
shapeType: ShapeType<T>,
|
||||||
|
conf: RdfOrmConfig<T> | string | undefined,
|
||||||
|
): ShapeResult; // { data, promise, subscription, isLoading, nextPage?, previousPage? }
|
||||||
|
// TWO positional arguments — the same pair `useShape` takes, both of them the SDK's own
|
||||||
|
// types. `ShapeQuery` is what you READ BACK (the snapshot), never what you pass in, and
|
||||||
|
// its items are the SHAPE's objects: `@id`, `@graph` and the shape's readable predicates.
|
||||||
|
export function useShapeQuery<T extends BaseType = BaseType>(
|
||||||
|
shapeType: ShapeType<T>,
|
||||||
|
scope: Scope,
|
||||||
|
): ShapeObservable<T>;
|
||||||
|
export interface ShapeObservable<T extends BaseType = BaseType> {
|
||||||
|
getSnapshot(): ShapeQuery<T>; // stable reference until the state changes
|
||||||
|
subscribe(onChange: () => void): () => void; // returns its own unsubscribe
|
||||||
|
refetch(): void; // ask again now; never polls
|
||||||
|
}
|
||||||
|
export interface ShapeQuery<T extends BaseType = BaseType> {
|
||||||
|
data: T[]; isPending: boolean; isSuccess: boolean; isError: boolean; error: unknown;
|
||||||
|
}
|
||||||
|
// The ORM's one-shot read, at the SDK's own name and signature. `config` is a `Scope`
|
||||||
|
// plus `where` and `orderBy`; the result is an ARRAY when it carries an `orderBy` and a
|
||||||
|
// `Set` otherwise, and it is a CLONE - mutating or deleting an item of it reaches nothing.
|
||||||
|
export async function getObjects<T extends BaseType>(
|
||||||
|
shapeType: ShapeType<T>,
|
||||||
|
config: Omit<RdfOrmConfig<T>, "pageSize" | "maxActivePages">,
|
||||||
|
): Promise<T[] | Set<T>>;
|
||||||
|
export type RdfOrmConfig<T> = Scope & { where?: ...; orderBy?: ... }; // the SDK's own
|
||||||
|
export function subscribeDoc(nuri: NuriLike, onChange: (r: DocChange, t: DocChangeType) => void): Unsubscribe;
|
||||||
|
export function subscribeDocs(nuris: NuriLike[], onChange: (r: DocChange, t: DocChangeType) => void): Unsubscribe;
|
||||||
|
// Extracts the variant key from a DocChange - "State" / "Patch" / "TabInfo" / ... -
|
||||||
|
// a convenience over the verified payload shape, not an upstream call.
|
||||||
|
export function docChangeType(resp: DocChange): DocChangeType;
|
||||||
|
|
||||||
|
// ── low-level document / SPARQL primitives ───────────────────────────────
|
||||||
|
export const docs: {
|
||||||
|
// `sessionId` is `string | number` — upstream's own declared type (`Session.session_id`).
|
||||||
|
// It is RELAYED, never converted: the wasm side deserializes a `u64`, and stringifying it
|
||||||
|
// fails for real (`Deserialization error of session_id JsValue("1")`).
|
||||||
|
docCreate(sessionId: string | number, crdt: string, cls: string, dest: string, store?: unknown): Promise<Nuri>;
|
||||||
|
sparqlQuery(sessionId: string | number, query: string, base?: string, anchor?: NuriLike, label?: string): Promise<unknown>;
|
||||||
|
// Returns the commits the update produced, as upstream does (it typed this `void` until
|
||||||
|
// 2026-08-14 while already relaying the value). A caller that ignores it is unaffected.
|
||||||
|
sparqlUpdate(sessionId: string | number, query: string, anchor?: NuriLike, label?: string): Promise<unknown>;
|
||||||
|
};
|
||||||
|
|
||||||
|
// -- writing one shape-typed object ---------------------------------------
|
||||||
|
// The SDK's own name and signature. The object MUST carry `@graph` - it is the only
|
||||||
|
// thing that says which document the write lands in - and what comes back is the object
|
||||||
|
// with its `@id` filled in where one was left empty.
|
||||||
|
export async function insertObject<T extends BaseType>(shapeType: ShapeType<T>, object: T): Promise<T>;
|
||||||
|
|
||||||
|
// ── inbox: giving to read, and depositing ────────────────────────────────
|
||||||
|
export const inbox: {
|
||||||
|
share(doc: NuriLike, toUser: string): Promise<void>; // give a reader the key
|
||||||
|
post(targetInbox: NuriLike, opts: PostOptions): Promise<void>;
|
||||||
|
postToDocument(doc: NuriLike, opts: PostOptions): Promise<void>;
|
||||||
|
read(targetInbox: NuriLike): Promise<Deposit[]>; // only your own
|
||||||
|
readForDocument(doc: NuriLike): Promise<Deposit[]>;
|
||||||
|
readSynced(targetInbox: NuriLike): Promise<Deposit[]>;
|
||||||
|
readSyncedForDocument(doc: NuriLike): Promise<Deposit[]>;
|
||||||
|
processInbox(targetInbox: NuriLike): Promise<Deposit[]>;
|
||||||
|
watch(targetInbox: NuriLike, onDeposits: (d: Deposit[]) => void): () => void;
|
||||||
|
// `materialize` (a second published name for `read`) was REMOVED on 2026-08-14 —
|
||||||
|
// an alias with no call site, and no counterpart upstream. Use `read`.
|
||||||
|
};
|
||||||
|
export interface Deposit { from: PrincipalId | null; payload: unknown; ts: number }
|
||||||
|
|
||||||
|
// ── the wrapped SDK objects ──────────────────────────────────────────────
|
||||||
|
export const ng: NG; // call this instead of the `ng` passed to `configure`
|
||||||
|
// `NG` is upstream's own type (`@ng-org/web`), fully typed
|
||||||
|
// members; it was `Record<string, any>` until 2026-08-14
|
||||||
|
export function init(...args: any[]): any; // likewise — not the `init` passed to `configure`
|
||||||
|
export function initNg(...args: any[]): any; // likewise, and position 0 is DISCARDED - see below
|
||||||
|
```
|
||||||
|
|
||||||
|
**A shape, in full, because one has to be written by hand.** `ShapeType` asks for `readablePredicate`, `minCardinality` and `maxCardinality` on every predicate, a `schema` keyed by the shape's own IRI, and objects carrying `@id` and `@graph` - and assembling that from the SDK's type declarations is a read this leaf exists to spare you. The shape below is `examples/notebook/app.ts`'s, predicate for predicate - that application reads with it against a deployed broker - and `rdf-orm build` generates exactly this object from a `.shex` file, so nothing here depends on the generator. The object interface and the type argument beside it are not that application's: it reads an untyped snapshot and narrows at the call site, which works and types nothing.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { useShapeQuery } from "@ng-eventually/polyfill";
|
||||||
|
import type { BaseType, ShapeType } from "@ng-eventually/polyfill";
|
||||||
|
|
||||||
|
const RDF_TYPE = "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
|
||||||
|
|
||||||
|
// What a read HANDS BACK: `@id` and `@graph` come from `BaseType`, plus one field per
|
||||||
|
// predicate, named by that predicate's `readablePredicate`.
|
||||||
|
interface NoteObject extends BaseType {
|
||||||
|
type: string;
|
||||||
|
title: string;
|
||||||
|
body: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const NoteShape = {
|
||||||
|
shape: "urn:notebook:NoteShape", // the shape's own IRI...
|
||||||
|
schema: {
|
||||||
|
"urn:notebook:NoteShape": { // ...which is also the `schema` key...
|
||||||
|
iri: "urn:notebook:NoteShape", // ...and the shape's own `iri`
|
||||||
|
predicates: [
|
||||||
|
// The matching constraint: a subject carrying `rdf:type urn:notebook:Note`.
|
||||||
|
{ iri: RDF_TYPE, readablePredicate: "type",
|
||||||
|
dataTypes: [{ valType: "iri", literals: ["urn:notebook:Note"] }],
|
||||||
|
minCardinality: 1, maxCardinality: 1 },
|
||||||
|
// And the fields that come BACK. A predicate the shape does not NAME is not
|
||||||
|
// projected, so a shape written only to match returns objects with no fields.
|
||||||
|
{ iri: "urn:notebook:title", readablePredicate: "title",
|
||||||
|
dataTypes: [{ valType: "string" }], minCardinality: 1, maxCardinality: 1 },
|
||||||
|
{ iri: "urn:notebook:body", readablePredicate: "body",
|
||||||
|
dataTypes: [{ valType: "string" }], minCardinality: 1, maxCardinality: 1 },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
} satisfies ShapeType<NoteObject>;
|
||||||
|
|
||||||
|
// Pass the object type as the TYPE ARGUMENT. `ShapeType<T>` mentions `T` in none of its
|
||||||
|
// members (it is `{ schema, shape }`), so nothing infers it from the shape: left out, `T`
|
||||||
|
// is `BaseType` and the snapshot is untyped. MEASURED - `tsc` refuses the assignment.
|
||||||
|
const notes = useShapeQuery<NoteObject>(NoteShape, { graphs: "did:ng:i" });
|
||||||
|
```
|
||||||
|
|
||||||
|
`minCardinality: 1` is what turns a predicate into a required triple pattern, so a shape whose every predicate is optional matches every subject in reach. `maxCardinality: -1` is unbounded. `valType` is one of `"number" | "string" | "boolean" | "iri" | "shape"`, and `literals` pins the required value - which is how the `rdf:type` entry above becomes the match rather than a field you read.
|
||||||
|
|
||||||
|
**`initNg`'s FIRST ARGUMENT IS DISCARDED, and what goes in its place is the `ng` above.** The Deployment requirements say to call `initNg(ng, session)` while `## Surface` says to use this package's `ng` rather than the one `configure` received, so there is a choice to make - and it makes none: this call drops whatever sits in position 0 and hands NextGraph's ORM the published `ng`, the same object, then passes every remaining argument and the return value straight through. MEASURED on `1.0.0-dev.14`: a sentinel object passed in position 0 never arrives, and what does arrive is `===` the exported `ng`. That is deliberate rather than a defect - the ORM reaches the engine through whatever this call resolves, an ORM write leaves by `ng.graph_orm_update`, and that is where the write guard sits - but it is not something to have to establish by experiment. The parameter stays in the signature because upstream's `initNg(ngImpl, session)` has it, and a call site written for the target must keep compiling.
|
||||||
|
|
||||||
|
**`ShapeObservable` is on the deletion list, and it goes WITH the shared wallet, not before it.** It is not a framework adapter: it carries the capability filter (`getSnapshot()` returns a view filtered by the capabilities held) and the capability-arrival re-publish (a subscription that re-publishes when a capability arrives). A capability arrives mid-session only because the wallet is shared; in the target an identity holds its own wallet and its capabilities from the start, so there is nothing to filter and no arrival to re-publish on. The announced form, a hook returning `{ data, isPending, isSuccess, isError, error }`, has nowhere to hang such a subscription, because the target does not need one. The type stays exported and you may write it down; what you cannot do is plan to drop it on its own ahead of the rest of the shared-wallet code.
|
||||||
|
|
||||||
|
**`refetch()` has NO RECORDED COUNTERPART.** It is the only published way out of a read that is stuck pending. The announcement recorded in this repository lists five fields, `{ data, isPending, isSuccess, isError, error }`, and `refetch` is not among them. That is a statement about the RECORD, nothing more: TanStack Query's own `useQuery` does return a `refetch`, so a successor may well exist, but this repository holds no record of one and cannot name what an application leaning on `refetch()` would migrate onto. Treat it as an open migration point, not as a call that has a mapped replacement.
|
||||||
|
|
||||||
|
## Guarantees
|
||||||
|
|
||||||
|
Every entry accepts `NuriLike` and validates at the door; what it returns is a precise `Nuri`. No type guard is published.
|
||||||
|
|
||||||
|
A returned reference carries no key — not `createEntityDoc`, not the three store accessors. A reference found inside a document yields a name, not a key.
|
||||||
|
|
||||||
|
You read a document whose key you hold: you created it, it was shared with you, or it sits in a public store, which serves its read key to whoever asks. No call answers "may I read this?".
|
||||||
|
|
||||||
|
What was shared with you becomes readable after `ensureIdentity()`.
|
||||||
|
|
||||||
|
**An anchored `docs.sparqlQuery` reads exactly the document you name, and returns its triples as written.** The anchor makes that document's graph the query's default graph, so a body with no `GRAPH <...>` wrapper reads that document and nothing else; a body that DOES carry one iterates the named graphs regardless of the anchor, so do not write one. Subjects come back as the document carries them — several subjects in one document is allowed and each stays its own, since a subject may be any IRI. Reading several documents is this call once per document; there is no call that takes a list, and composing one with an anchorless query instead would silently widen what the read reaches. Recommended placement is one document per business entity: access is granted per document.
|
||||||
|
|
||||||
|
**And a document it cannot read is refused OUT LOUD, never swallowed into an empty answer.** A document you hold no capability for - and whose public store has none to give - is refused before the read leaves, naming the document; a public store that could not be ASKED rejects with that failure instead, because both stop the read and only one of them tells you to try again. Nothing is skipped on your behalf: tolerating one unreadable document was the removed `readUnion`'s own policy, and it went with it in `1.0.0-dev.8`, so whether one ends a loop over several is now your decision at your call site. A rejection means "unknown", never "absent", here as everywhere.
|
||||||
|
|
||||||
|
**Which reads reach a document in a public store from nothing but its `reference`.** This is the stranger's case - the document was shared with nobody, its `reference` circulated, and the reader holds no key for it - and two calls serve it. An anchored `docs.sparqlQuery` asks the public store for the key before it reads, and already did so before `1.0.0-dev.6`: the removed `readUnion` was that same ask, once per document, so a one-shot `document read` of one named public document is exactly what it always was. `useShapeQuery` asks too, since `1.0.0-dev.9`, once per document NAMED in `scope.graphs` - so a `shape read` serves the same case now, reactively and typed, and a holder of nothing opens a public document named that way (measured in the unit suite, and live against the broker). The three that do NOT ask, and in which such a document therefore does not appear: `useShape`, `getObjects`, and `useShapeQuery` under `graphs: "did:ng:i"` or `""` - naming no document, there is nobody to ask about. Read it once by naming it and the key lands in what you hold, which all three re-read on.
|
||||||
|
|
||||||
|
`urn:ng-eventually:` is reserved, and the reservation has two faces. In a document: this package writes its own registers under subjects carrying that prefix, in the same graph as your data — so **an anchored `docs.sparqlQuery` returns them alongside your triples, and it is yours to ignore them**. Until `1.0.0-dev.8` the removed `readUnion` dropped them for you; nothing does now. This is not a gain of rights: the two registers an ordinary document carries are a document's inbox address and, for a public document, the read key its store already serves to whoever asks. Nothing else of this package's is written into your documents. Do not write under that prefix yourself. In a deposit: two payload shapes are this package's own and it acts on them — a payload that IS a reference (a bare `did:ng:…` string and nothing else), and an object whose `kind` property is a string starting with `urn:ng-eventually:inbox:`. **Every other payload is yours, and is delivered to you untouched.**
|
||||||
|
|
||||||
|
**Do not use either shape to carry your own data.** Depositing one is still accepted and it is still returned to you by `inbox.read` and its variants — nothing is withheld — but this package now also acts on it, and what you observe is one of two things: it writes an entry into the document the inbox belongs to, if that document is one it can index; otherwise it reports a refusal on its own log stream (`console.error`, ungated, as below). That refusal is reported ONCE and then the deposit is gone: this package consumes what it claims, whether or not the arm succeeded. Until `1.0.0-dev.4` the same refusal came back at every arrival on that inbox and at every connection, for as long as the deposit sat there. The same now applies when the referenced document resolves but carries **nothing for the field its index declares** — a draft, say: the reference is discarded and reported, where before it sat in the queue and would have been indexed by a later drain once the document gained that field. Deposit the reference again after the document says what it needs to say. Carry your own data in an object with a `kind` of your own — `{ kind: "join", … }` is yours and stays yours — and never as a bare reference on its own.
|
||||||
|
|
||||||
|
Only a document's owner writes to it. Holding its read key never grants a write. **Since `1.0.0-dev.7` that covers what you write through NextGraph's ORM too** - `insertObject`, and a mutation of the live set a shape query handed you (`set.add(...)`, `set.delete(...)`, assigning a property). It used to cover only `docs.sparqlUpdate`: an ORM write leaves by a different door, and nothing was standing at it. Refusal happens before the write is attempted, and one document you may not write refuses the whole batch the ORM was flushing.
|
||||||
|
|
||||||
|
**`getObjects(shapeType, config)` answers with what you hold, and nothing else.** Objects living in documents you have no key for are not in the result - the same rule the two shape reads follow, applied per document on what comes back. The collection keeps the shape the SDK gave it: an `orderBy` in the config yields an array, anything else a `Set`. What you get is a CLONE, detached from the database: changing an item of it changes nothing anywhere, and deleting an item of it removes nothing and reports nothing.
|
||||||
|
|
||||||
|
**`insertObject(shapeType, object)` needs the object's `@graph`**, and refuses a document you do not own. The `@graph` is the only thing that says which document the write lands in - upstream the insert subscribes to no document at all - and it is also what decides the refusal, so there is nothing extra to pass. An object with no `@graph` is forwarded and NextGraph refuses it in its own words.
|
||||||
|
|
||||||
|
**"This document has no inbox" is an answer, and only an answer, since `1.0.0-dev.9`.** `inbox.postToDocument` refuses a document whose owner never opened an inbox, and `inbox.readForDocument` / `readSyncedForDocument` answer `[]` for one - both unchanged, both still the ordinary case. What changed is that a read which could not HAPPEN no longer arrives as one of those: a broker that cannot answer for the document, or a public store that cannot be asked for its key, now rejects. Until this version a depositor was told the owner had opened nothing, and a reader was handed an empty list, for a document whose inbox is full.
|
||||||
|
|
||||||
|
`inbox.share(doc, toUser)` names the document and the person; the recipient calls nothing. It refuses a recipient nobody has signed in as, rather than creating them.
|
||||||
|
|
||||||
|
`inbox.post` refuses a target that is not an inbox; to reach a document's owner, use `inbox.postToDocument(doc, …)`. Anyone may deposit into an inbox; only its owner reads it.
|
||||||
|
|
||||||
|
**You never resolve an inbox address, on either side.** You deposit by naming a document (`inbox.postToDocument`), and you read what was left on your own by naming it too — `inbox.readForDocument(doc)` at any time, or `inbox.readSyncedForDocument(doc)` on a page that has just loaded. The second is the one to call when an empty answer has to MEAN empty: a session that has just loaded has synced neither the document nor its inbox, and an unsynced read of either comes back empty with no error — so the ungated form can answer `[]` for a document whose inbox holds messages. `readSyncedForDocument` waits for both before answering. `inbox.readSynced` is the same guarantee on an inbox you already hold the address of, which no application does: it takes an address, so nothing here hands you one.
|
||||||
|
|
||||||
|
`ensureIdentity()` settles the identity, completes the connection work it starts, and returns the identity. It takes no identifier, and no other call takes one.
|
||||||
|
|
||||||
|
It resolves **only once that work has actually completed**: if what was shared with you could not be restored, it throws instead of returning, and a rejected call must not be rendered past — the interface would show an empty account rather than an empty screen. A single queue that could not be drained is reported and does not reject: reaching your queues is infrastructure and must succeed, applying one deposit is data and must never cost you the session. So a resolved call means your own capabilities are restored; it does not promise that every deposit waiting for you has been applied, and those that were not stay in their queue.
|
||||||
|
|
||||||
|
`ensureIdentity()` mounts a full-screen barrier on every top-level load, and takes it down itself — past the broker round-trip it stays down, provided the identifier reached the other side. A person who comes back to the page from that round-trip finds the barrier live again, prefilled, and confirming it hands the page over a second time. The application's own page is never reloaded and nothing outside the barrier is touched.
|
||||||
|
|
||||||
|
**What decides which identity you get.** No call takes an identifier — not `configure`, not `init`, not `ensureIdentity` — so an application never chooses one, never keeps one, and never hands one over. It is settled once per page load, from the page itself, and the answer depends on which side of the broker round-trip is asking:
|
||||||
|
|
||||||
|
- **Before the round-trip, on your own top-level page — the barrier decides.** Whatever is already known fills the field, and the person may change it; the identity is the value they confirm. Confirming publishes that value into the address bar as `?ng-id=` and records it in this browser.
|
||||||
|
- **After the round-trip, on the page the broker loads back — `?ng-id=` decides**, and the barrier stays down. The parameter also wins over anything the browser remembers, on either side: it is read first, and reading it replaces what was remembered. Arrive with neither — a URL that dropped the parameter, and a partition that remembers nothing — and the barrier asks on that side too.
|
||||||
|
- **Failing both — whatever this browsing context last recorded.** This is the only path on which an identity is adopted with nobody confirming it. If the address bar lost `?ng-id=` while a *different* identifier was on record here, that different identity is adopted, and nothing is raised anywhere; if nothing was on record either, the barrier asks again on that side too.
|
||||||
|
|
||||||
|
**`?ng-id=` exists because it is the only thing that crosses.** Your page before the round-trip and your page after it sit in two separate storage partitions — nothing the browser remembers on one side is visible on the other, and the address bar is the sole channel between them. The package writes the parameter itself, without navigating. **An application that owns its URL must let it survive**: a router that drops query parameters it does not know, or a redirect that rebuilds the URL, sends the round-trip off without the identifier, and the consequence is the silent mis-identification above rather than an error. In a context that can neither write the address bar nor use storage, the barrier simply asks on both sides.
|
||||||
|
|
||||||
|
**Being remembered is a prefill, never a decision.** A top-level reload asks again every time, with the field already filled — one click, no typing. A remembered identifier is therefore not a signed-in state, and two tabs, two browsers or two devices do not share one: each keeps its own record, and only a URL carrying `?ng-id=` puts a second context under the same identity.
|
||||||
|
|
||||||
|
**The session is the package's, not yours.** You never build one, and no call takes one. Call this package's `init` (not the one you passed to `configure`): it captures the session the SDK delivers to `init`'s callback and keeps it, then calls your callback with that same event untouched — so an application that wants the `session_id` for the `docs` primitives reads it there, and one that does not may pass no callback at all. Identity normalisation is the package's too: `@Alice`, `alice ` and `ALICE` are one person.
|
||||||
|
|
||||||
|
Where a call must first find out whether something already exists — a document's record in its store, a user's inbox — it throws when it could not find out, instead of proceeding as though the answer were "nothing". So `createEntityDoc` throws if the document cannot be recorded in its store, and resolving an inbox throws rather than handing back a second one. **A rejection means "unknown", never "absent"** — retry it or surface it, but do not read it as an empty result.
|
||||||
|
|
||||||
|
**`storeRegistry.openDocumentInbox(doc)` is idempotent, including when calls overlap.** Asks for the same document that are in flight together are answered by one call, and every one of them gets the same inbox — you do not have to serialise them yourself, and firing one per component as they mount is a supported way to use it. This holds **within one page**; two pages doing it in the same moment is a non-guarantee below, and it is the only part of this you have to think about.
|
||||||
|
|
||||||
|
**A reactive read says "nothing" and "I could not find out" differently.** `useShapeQuery` answers in three states and only two of them are answers about your data: `isPending` while the question is still open, `isSuccess` once it has been answered, `isError` when it could not be. An empty `data` under `isSuccess` means this scope holds nothing of that shape — the distinction the surface exists for, and the one thing it will never do is publish that snapshot for a read that did not happen. And because an observable cannot take back a list a subscriber has already rendered, `data` under `isError` keeps the **last read that answered** rather than emptying — so an empty `data` is never handed to you as a failure's answer. Read the load state before `data`: **a rejection means "unknown", never "absent"** here too.
|
||||||
|
|
||||||
|
**A document you NAME in `graphs` is reached before the read opens, since `1.0.0-dev.9`.** Naming a document in a scope is the same act as anchoring `docs.sparqlQuery` on it, and it is now answered the same way: the key is asked of a public store if you do not already hold it, the document is refused out loud if you hold no key for it, and its repo is synced before the question is put. A named document you cannot read publishes `isError`, where until this version it reached the engine, came back, and was emptied by the per-document filter into `isSuccess` with `data: []` - the one snapshot this surface reserves for "this scope holds nothing". A named document that has never synced published that same snapshot for a document that is not empty; it now stays **PENDING** instead - the sync barrier is consulted on every publication, and a named document whose barrier was not crossed is not an answer. **Since `1.0.0-dev.10` that half carries no qualification.** It held only within one ordinary session until then, and the two situations that broke it - a second `configure(...)`, which published an empty or stale success, and a broker refusing a subscription after this package had stopped waiting for the document's first push, which left the read withheld with no way back - are closed: "is this document open in this session" now has exactly one answer, the state of the document's one real subscription, rather than three records that could disagree. Nothing failed there, so it is not `isError`: the subscribe succeeded and the read did not throw, what is missing is the authority to say the document is empty. If the document later syncs and brings data, the read answers by itself. If it never does, the read stays pending for that session - handle a `isPending` that does not end, as you already must for a shape query the engine refuses. **Naming SEVERAL documents fails as a whole** when one of them cannot be reached: a short list is the same lie as an empty one, so nothing is answered rather than half of it. What is NOT touched, and each stays a success: `graphs: "did:ng:i"` or `""` (you named no document - the per-document filter is the whole of the answer there, and an empty result means you hold nothing of that shape), `graphs: []` (no objects, by NextGraph's own definition), and a named document you can read that holds nothing of the shape.
|
||||||
|
|
||||||
|
**And it converges by itself.** A named scope refused this way is not a dead view. Whether you may reach the documents you named is re-read on every publication rather than decided once, so a key arriving turns the refusal into the document through the same channel that already re-published a filtered read - and a scope whose barrier failed outright is attempted again on that signal. The ordinary sequences all converge with no call from the application: a page whose components subscribe before the connection work has restored its keys, a document shared with you while you are looking at the screen, a broker that hiccupped once and healed, and a key arriving in the same instant the read was deciding. One consequence to design for: an interface that renders `isError` will briefly show it where it used to show an empty success, so branch on the load state rather than on `data` alone. Nothing here polls, so a scope refused in a session whose keyring never moves again stays `isError` until your own `refetch()` - which is what `isError` has always meant here, and what it means for every other failure this call reports.
|
||||||
|
|
||||||
|
**A named scope goes back to PENDING when the session changes under it.** Signing in again inside the same page gives a new session, whose repos this package has synced nothing for yet - so a named scope that was answering returns to its loading state until the documents it names are confirmed again, and `refetch()` is what confirms them. Withholding is deliberate: a barrier crossed in the session that has just gone is not one the new session has crossed, and the alternative is answering from a subscription nothing re-established. This is the one case where a read that had answered stops answering, and it does not arise on an ordinary page load - there the whole page is new.
|
||||||
|
|
||||||
|
**A standing failure is the SAME snapshot.** While a refusal persists unchanged, the snapshot object does not change either, so `useSyncExternalStore` and anything else comparing by identity see no update - even though the read is being attempted again underneath. A failure that says something different is published normally.
|
||||||
|
|
||||||
|
**What it costs.** One public-store ask and one sync barrier per document named, once per session. The opens for a scope naming several documents run together, so the wait is the slowest of them rather than their sum. The wait itself is bounded internally, so a document that never answers does not hold the open for ever - but the READ over it stays pending, because a barrier that was never crossed is not authority to call anything empty.
|
||||||
|
|
||||||
|
**Which failure lands in `isError` changed in `1.0.0-dev.6`, and one of them now stays PENDING.** The read goes through the SDK's own shape query, so what `isError` carries is the query failing to open: a shape the ORM cannot subscribe, or a `configure` that was never given `ormSubscription`. A start the underlying engine REFUSES does not reach it: NextGraph catches that failure and logs it, and its readiness signal is only ever resolved, never rejected, so such a read stays `isPending` indefinitely. The guarantee above is unaffected — you are still never told "there is nothing" for "nobody answered" — but an interface that handles only `isError` will show its loading state where it used to show an error. Handle a `isPending` that does not end.
|
||||||
|
|
||||||
|
**A read is scoped by document and by subject, never by store.** `Scope` has two axes and there is no third: `graphs` names one document's graph per entry — `did:ng:i` or `""` for the whole local dataset, `[]` or `undefined` for no objects at all — and `subjects` filters subject IRIs literally, with no prefix or hierarchy matching. There is no call that lists the documents in a store, and naming a store in `graphs` is not the question you meant: a store's graph holds its containment triples and nothing of the shape you asked for, so it answers empty rather than raising. That is the target's own shape, not a narrowing this package chose — and since `1.0.0-dev.6` nothing is translated on the way: the `Scope` object you write is the object the SDK receives.
|
||||||
|
|
||||||
|
**A deposit made while a person is looking at the page arrives while they are looking at it.** For as long as an identity is connected, every inbox it may read is watched and what lands in one is applied as it lands — its own inbox, and the inbox of every document it has opened one on, including a document whose inbox it opens later in the same session. So a `ReadCap` sent with `inbox.share` becomes usable in the recipient's live session with no reload and no call from the application, and a `useShapeQuery` that was empty for want of that `ReadCap` re-reads and publishes the document it now opens. Until 2026-08-17 only the backlog waiting at connection was applied, and a deposit made in front of its recipient converged only when that person reloaded the page.
|
||||||
|
|
||||||
|
**The watching is in place by the time `ensureIdentity()` resolves**, whatever else that call made of its own work: a connection that could not restore something still rejects, and the identity it settled is watched all the same. It lasts exactly as long as that identity stays connected — changing identity or clearing it stops it, and whoever connects next is watched in their own right, so nothing of the previous one keeps applying.
|
||||||
|
|
||||||
|
**A deposit this package applies is delivered ONCE, and a failure is not retried.** It is taken out of its inbox before the arm that handles it runs, so it is gone whether that arm succeeded or not — the same order the target has, where the broker removes a message from the queue as it hands it over and the verifier merely logs what it could not apply. A failure is reported on this package's own log stream (`console.error`, carrying this package's prefix), never gated by `debugAccessLog` — a diagnostic may be opt-in, a failure may not — and then the next deposit is processed. **Do not count on a failed deposit being applied later: there is no retry, no dead-letter queue and no way to ask what was lost.** If an arrival matters to your application, the record you keep of it must be your own. What this buys is the end of the opposite behaviour: an inbox that grew for ever, and one malformed deposit re-reported at every arrival and every connection for the life of the session.
|
||||||
|
|
||||||
|
**An unapplicable item and a failed one are not the same event.** A deposit this package cannot make sense of is reported and the next one is processed — one malformed item never holds up the queue behind it. A deposit whose handling could not be COMPLETED is different: the drain STOPS, the inbox is reported, and everything not yet taken out is preserved. Only the deposit in flight is lost. So a failing broker costs one deposit per attempt, not the whole queue, and a drain that stopped is retried by your next `ensureIdentity()`.
|
||||||
|
|
||||||
|
**A reference this package cannot read counts as failed, not as absent** — including a document you hold no capability for. That is deliberate and it costs latency: such a deposit stops one drain, and the deposits behind it land on the next connection instead of this one. The alternative was worse and was measured: treating "cannot read it" as "it is not there" destroyed deposits on a transient outage, and destroyed the re-deposits sent to repair them, because a failed capability fetch is remembered for the session. Only a document actually queried, from a synced repo, that still reads empty is called absent. **Consequence to plan for:** a queue holding many references you cannot read drains one per connection.
|
||||||
|
|
||||||
|
**`inbox.processInbox` now REJECTS on a broker failure**, where it used to resolve — including when a document a deposit referenced could not be READ. A referenced document that is merely absent is a different case: that is reported and the queue carries on. Awaiting it, handle the rejection: the deposit it was applying at that moment is already consumed, the rest of that inbox is intact, and calling again resumes from the next one. Connection-time draining is unaffected — `ensureIdentity()` reports such a queue and still grants the session, exactly as before.
|
||||||
|
|
||||||
|
**Failing to apply one inbox still denies nothing else.** The other inboxes were never involved, the session is not refused, and deposits this package does not claim — your own payloads — are untouched and stay readable through `inbox.read` and `inbox.watch`.
|
||||||
|
|
||||||
|
**Any number of subscriptions on one document coexist.** Opening a document, watching an inbox and following a scope no longer silence one another. Until 2026-08-17 a second `subscribeDoc` on a document killed the first, silently — nothing rejected, the first caller's unsubscribe still appeared to work, and what an application saw was a view that stopped re-reading and an inbox that stopped notifying, with no trace anywhere near the cause. A subscriber that joins a document somebody else already opened is handed the initial `State` its own subscription would have pushed it, so joining late is not the same as never firing; and unsubscribing silences that caller and no other, including when it happens from inside a push.
|
||||||
|
|
||||||
|
## Non-guarantees
|
||||||
|
|
||||||
|
**No display name.** `ensureIdentity()` returns an opaque identifier: do not parse it, split it, or render it as a readable name.
|
||||||
|
|
||||||
|
**Naming an identity proves nothing about who named it.** Any visitor may type any identifier at the barrier, or arrive on a URL that already carries one, and act as that identity — the wallet and its password are handed out on the barrier itself. The identifier is a choice of space, never a proof: anyone who knows one can act as it, so do not treat `ensureIdentity()`'s answer as an authenticated subject.
|
||||||
|
|
||||||
|
**The wrapped `ng` is a wrapper, and a wrapper can be wrong.** It forwards every member to the object you gave `configure`, adding two refusals of its own and nothing else. Until `1.0.0-dev.7` it did not forward them at all - every member came back as a promise, and calling one failed with NextGraph's own `<member> is not a function`. The cause, for anyone who met it: the passthrough did `Reflect.get(ng, prop).bind(ng)`, and `@ng-org/web`'s `ng` is ITSELF a proxy whose `get` trap answers every key - `bind` included - with a fresh path-carrying callable, so `bind` never reached `Function.prototype.bind` and what came back was a Promise. It is `Reflect.apply` since `1.0.0-dev.7`, pinned by a unit test that drives a proxy-shaped `ng` rather than the plain objects every other fake in the suite is. **What it cost most was a `shape read`**, and that is the part to read if you hit it: an application that passed this `ng` to `initNg` had the ORM call `ng.orm_start_graph`, which is where the Promise landed, and `@ng-org/orm` catches that to the console - so `orm_start_graph is not a function` on the console, with a `useShapeQuery` that never leaves `isPending`, is THIS defect and not the engine refusing your shape. Pin `1.0.0-dev.7` or later and it is gone. The lesson to keep is that a member of `ng` that misbehaves is worth reporting here rather than worked around: nothing in this package's own code goes through that wrapper, so this surface is the only place such a defect shows.
|
||||||
|
|
||||||
|
**A shape query the engine refuses never finishes loading.** Both shape reads — `useShape` and `useShapeQuery` — open a subscription through NextGraph's ORM, and a start the engine refuses is caught there, written to the console and nothing more: the set stays empty, its readiness never settles, and the only trace is that one console line. `useShapeQuery` reports it as a `isPending` that does not end (see the guarantee above); `useShape` answers with the ORM's own two states, which do not carry the distinction - its `isLoading` says whether the initial payload has arrived and has no value for "it never will". The cause is upstream and nothing in this package can work around it, and it is MEASURED in the release this package builds against rather than inferred: in `@ng-org/orm@0.1.2-alpha.21`'s shipped `dist/connector/RdfOrmSubscription.js`, `readyPromise_` is built with `resolve` alone and nothing anywhere rejects it, `resolveReady` is called on one path only (initial data arriving), and `ng.orm_start_graph` is awaited inside a `catch` whose whole body is `console.error(e)`. This was a total outage until the client packages caught up with the deployed broker on 2026-09-21; it is the residual failure mode, not the ordinary case. Since `1.0.0-dev.9` the commonest way in is closed for `useShapeQuery`: a document NAMED in `graphs` is opened and refused before the query is handed over, so an unreachable named document reads `isError` rather than pending for ever. What remains is the start the engine refuses for a document you can perfectly well reach, and everything under `graphs: "did:ng:i"`, where there was no name to check. **So the two faults you can tell apart today are the BARRIER refusing (named document, `isError`, naming the document) and the wiring being absent (`isError` naming the `configure` field); the two you cannot are the engine rejecting your shape and the ORM never having started, which arrive as the same unending `isPending`.** A way to separate those last two has been asked for and is not decided: it would have to be invented here, since there is nothing upstream to mirror and nothing upstream to read it from.
|
||||||
|
|
||||||
|
**No object removal call, and no document deletion at all.** There is no `deleteObject` and no `removeDocument` at any level of NextGraph, so there is none here. You remove an object by deleting it from the LIVE set a shape query handed you - the item the set is holding, reached by iterating it, by `.first()` or by `.getBy(graph, subject)`. What that removes is the predicates your SHAPE declares on that subject: triples under a predicate the shape does not name survive, the subject survives, and the document survives. Deleting an item of a `getObjects` result removes nothing, because that result is a clone. `@ng-org/orm@0.1.2-alpha.21` ships a `removeObject(graphNuri, subjectIri)`; it is not published here, because it exists in the package and not in the source this package is verified against, and a symbol whose only evidence is what an npm build happens to export is not something to build a guarantee on.
|
||||||
|
|
||||||
|
**A refused ORM write does not always reach you as a failed call.** `insertObject` rejects, and you can await it. A mutation of a live set does not: NextGraph batches those into one call it does not await, so a refusal surfaces as an unhandled rejection in the console rather than as an error at the line that made the change - the write did not happen, and nothing in your code was told. Write into documents you own, and treat a document you merely hold the key for as read-only.
|
||||||
|
|
||||||
|
**Nothing of NextGraph's ORM is re-exported as it stands.** `getObjects` and `insertObject` are the two this package offers, wrapped. `RdfOrmSubscription`, `DiscreteOrmSubscription`, `ngSession`, `getRaw`, `watch` and `effect` are NOT published and importing them from `@ng-org/orm` defeats everything above: one wallet hosts every identity here, so an unwrapped read returns every identity's objects and an unwrapped write reaches any document. `RdfOrmSubscription` in particular pools its subscriptions on the shape and the scope alone, with no identity in the key - what makes that safe is the filtering this package does on the way out.
|
||||||
|
|
||||||
|
**No revocation.** `inbox.share` cannot be undone.
|
||||||
|
|
||||||
|
**Nothing per reader on a document in a public store.** No grant, no revocation, no audience list.
|
||||||
|
|
||||||
|
**No delegated writing.** A received key never grants a write, and no call adds a writer to a document.
|
||||||
|
|
||||||
|
**No mailbox model.** Do not build on the raw deposit list.
|
||||||
|
|
||||||
|
**No cross-broker reference.** A returned reference resolves for users of the same broker.
|
||||||
|
|
||||||
|
**`openDocumentInbox` does not coalesce across PAGES.** Two tabs — or two sessions of the same person — that open the same document's inbox in the same moment can each create one, and the document is left with two: its owner drains one while deposits arrive in the other. Nothing raises, nothing reports it, and neither page can detect it afterwards. It is not an oversight to be patched later: a branch MERGES records rather than refusing the second, so there is no "create only if absent" to build the guarantee on, and the address a depositor reads is a separate record from the one the owner resolves — so the two cannot even be made to agree on which of the pair won. Open a document's inbox from one place: the page that creates the document, or one call the rest of the interface waits on.
|
||||||
|
|
||||||
|
**TWO COPIES OF THIS PACKAGE IN ONE APPLICATION MISBEHAVE SILENTLY, and nothing here can detect it.** What this package remembers it keeps in the package itself, not in any handle you hold: which documents are subscribed and who is listening for them, which identity the session settled on, which documents are open. None of that is shared between two copies. An application that ends up with two therefore runs two of everything — a document subscribed through one copy is invisible to the other, so changes to it simply never arrive; and the identity settled in one is not the identity the other acts as, so the same call writes as one user or the other depending on which copy it reached. Nothing raises, nothing warns, and no call can report it: from every entry point a second copy is indistinguishable from the first, and the symptoms surface far from the cause as missing updates and writes attributed to the wrong person. This is a packaging property, not a behaviour to code around — **declare this package once, as one dependency of the application**, and let your own code and every library built on it resolve to that copy. A library that builds on this package should declare it a *peer* rather than a dependency for exactly this reason, so that the application remains the one place it is named.
|
||||||
|
|
||||||
|
**No unfiltered read through `useShape`, and no way round it through the object it hands back.** What the call returns is NextGraph's own result, filtered: `data` and `promise` carry only items in documents you hold the key for, `isLoading` passes through, the two page commands run and whatever they hand back is held to the same rule as any other member, and `subscription` - the ORM's own handle, which reads and writes with no capability filter at all - is refused out loud rather than handed on. **Any member this package has not DECIDED is refused, whatever its type** - that is how a member a later `@ng-org/orm` adds is settled before anyone has seen it. It is not decided by type: a COUNT is a plain number that describes the items, and nothing separates it from a page size, so nothing undecided passes. A member the SDK does not carry at all reads `undefined`, since there is nothing behind it. Inside `data`, every member that yields items is filtered, and an ordered result addresses and counts the items you may read: `size`, `length`, an index, `Object.keys`, `in` and `JSON.stringify` all agree, and none of them says how many you may not. **Reading a member's DESCRIPTOR answers exactly what reading the member answers**, which is not a detail: `Object.getOwnPropertyDescriptor` - and the spread, `Object.entries` and console inspection built on it - reads a property without going through the view's own read, so a refused member throws there too rather than handing its value over. That holds for an ACCESSOR as much as for a value: the getter you are handed reads through the view, and its setter is refused. **A mutation reaches the collection underneath, and neither hands back nor acts past what the view shows.** Writing is not broken - your own `add` reaches the document and the reactivity it drives. **All three ask the same question**: `add` THROWS for an object naming a document you hold no key for, and for one naming NO document (there is then nothing that owns it, and it would land in a collection every identity shares - set `@graph` to a document you hold) (it returns the collection whether or not it did anything, so it has no value meaning "that did not happen"), `delete` of an item the view does not show answers `false` - the Set contract's own word for "it was not there", and true of the view - and `clear` empties the view rather than the collection every identity shares. `add` hands back the VIEW rather than the collection, because `Set.prototype.add` returns the collection so calls can chain and chaining onto the unfiltered one gives it away entirely. **Writing to what you are handed is refused** - `data[0] = x`, `delete data[0]`, `data.length = 0`, `Object.defineProperty`, `Object.setPrototypeOf` and `Object.freeze` - on the RESULT OBJECT as much as on `data`, and on this package's own account rather than because the ordered collection upstream happens to refuse some of them too. **Every member `@ng-org/alien-deepsignals` declares non-mutating answers**, computed over the items you may read: the iterator helpers, the array reads (`at`, `slice`, `join`, `indexOf`, `toSorted`, `with`) and the ES2025 set combinators (`union`, `difference`, `isSubsetOf`). The one exception is `copyWithin`, which that list names and which WRITES: it is refused here, and that is STRICTER than NextGraph's own ordered collection, which runs it and destroys an element (its guard is built from the same mislabelled list). A deliberate difference, stated so you do not discover it as a surprise. A document reached through that view alone, read nowhere else first, does not appear.
|
||||||
|
|
||||||
|
**`isLoading` does not mean what its name says, and the fault is upstream's.** `@ng-org/orm`'s declaration describes it as "`true` when no data is available yet"; the hook that ships computes it as the subscription's `isReady`, which is the inverse. Both artifacts were read and they disagree. This package forwards the value it is handed rather than correcting it, because a layer that quietly improves the target teaches you a behaviour you would have to unlearn. **Branch on `data === undefined`**, which is unambiguous, and treat `isLoading` as unusable until upstream settles it.
|
||||||
|
|
||||||
|
**`getObjects` does not fetch a public store's key for you either**, for the same reason as the two shape reads below: it goes through the same ORM query and spends no round-trip asking. Read the document once by naming it — `docs.sparqlQuery` anchored on it — and it appears.
|
||||||
|
|
||||||
|
**`useShape` does not fetch a public store's key for you, and `useShapeQuery` does so only for what you NAME.** A document in a public store gives up its key to whoever asks, but asking is a round-trip: `useShape`'s signature is NextGraph's own and has no await to spend, so a public document you have read nowhere else never appears in it. `useShapeQuery` spent none either until `1.0.0-dev.9`; it now asks once per document named in `graphs`, which is what lets a bare reference to a public document be read through that call. It still asks nothing under `graphs: "did:ng:i"` - the whole local dataset names no document, so there is nobody to ask about. For those two cases, read the document once by naming it - `docs.sparqlQuery` anchored on it, which is the whole of what `readUnion` did for this before it was removed in `1.0.0-dev.8` - and both reads pick it up: the key lands in what you hold, and that is a change both of them re-read on.
|
||||||
|
|
||||||
|
**A watch on one inbox that could not be opened does not come back on its own.** Opening it can fail — a broker that does not answer in that moment — and the failure is reported rather than passed over, but what follows is event-driven and this package deliberately never polls. The watch is opened again at the next moment this identity comes to hold something it did not: it creates a document, it opens an inbox on a document, a `ReadCap` reaches it through an inbox still being watched, it reads a public-store document for the first time. A session that does none of those goes on without that inbox — deposits made into it are not applied, nothing raises, and they wait unconsumed for the next connection. The exposed case is the identity that only ever READS, since it produces none of those events, where an identity that goes on creating recovers as a by-product of its own work. Awaiting `ensureIdentity()` again applies what is waiting — it drains every one of this identity's queues before it resolves, and shows no barrier a second time — but the watching itself comes back only on a fresh page.
|
||||||
|
|
||||||
|
### Asked for, not decided
|
||||||
|
|
||||||
|
Each of these is a standing request from an application, recorded here rather than answered in a message. None is refused on principle; each is an addition to a published surface, so each waits on a decision that is this package's to make. They are listed so that an application knows it is not missing a call it simply failed to find.
|
||||||
|
|
||||||
|
**`configure`'s `useShape` is REQUIRED even for an application that never calls it.** `@ng-org/orm` publishes `useShape` only through its react / svelte / vue adapters, so a page with no framework can produce none of them - and the field is not optional in `EventuallyConfig`, so such an application invents a value to satisfy the signature. What it does with that value is unobservable: the injected hook is consulted in exactly one place, inside this package's own `useShape`, so an application that reads through `useShapeQuery` never reaches it. This repository's own frameworkless example passes `useShape: (() => {}) as never` (`examples/notebook/app.ts`) and reads live with `useShapeQuery` beside it; a function that THROWS is equally sound and says more if anything ever does call it. Making the field optional is a change to a published signature, hence this list rather than a fix.
|
||||||
|
|
||||||
|
**No published NURI type guard, and no published escaping helpers.** Neither is an oversight. On the guard: every entry takes `NuriLike` and runs its own validation at the door - permissive in, precise out - so a guard would put validation in a caller's hands where the door already does it, and invite the cast the types exist to prevent. On the escaping: `escapeIri` / `escapeLiteral` were published until the surface was narrowed, and they came out under the rule that governs this whole leaf - a symbol with no counterpart at any level of the target is a symbol an application would have to unlearn, and neither `@ng-org/web` nor the ORM exposes an equivalent (the engine escapes ad hoc where it builds SPARQL). The consequence is stated rather than denied: an application composing SPARQL against `docs.sparqlUpdate` carries its own escaper, which is a second implementation of one rule, and the one running there is not the one this package tests.
|
||||||
|
|
||||||
|
**No published way to write triples above `docs.sparqlUpdate`.** The write that IS published above the raw primitive is `insertObject(shapeType, object)` - the SDK's own name and signature, which takes a shape-typed object, needs its `@graph`, and composes no SPARQL at all, so it removes the query building, the escaping and the NURI validation from a caller in one move. What it costs is the ORM: it is injected through `configure` (`insertObject`), so a library that wires no `@ng-org/*` of its own cannot reach it, and it writes shape-typed objects rather than arbitrary triples. An "add these triples to this document" entry, taking triples and no shape, is what has been asked for and is not decided.
|
||||||
|
|
||||||
|
**No call says WHICH STORE holds a document.** Not the enumeration that `storeRegistry.listMyEntityDocs` was - that was removed in `1.0.0-dev.5` because nothing upstream lists a store's documents - but the narrower question about a document whose `reference` the caller already holds. There is no accessor for it, and the consequence is worth stating plainly: an application cannot verify its own placement, so a document written to the wrong store is undetectable from here until some reader fails to open it.
|
||||||
|
|
||||||
|
**No per-deposit outcome, and no count that says a queue has been drained.** `## Guarantees` says a deposit this package applies is consumed whether or not the arm succeeded, that a refusal goes to this package's own log stream, and that there is no way to ask what was lost. The gap an application feels is the one before that: nothing distinguishes "this deposit was examined and discarded" from "this deposit has not been examined yet", so a check that an ineligible deposit produced NO entry cannot be waited for - only timed out, which makes it weaker than its name. Anything observable would close it, a per-deposit outcome or merely a counter that moves when a queue has been drained; neither exists.
|
||||||
|
|
||||||
|
## Change policy
|
||||||
|
|
||||||
|
**Semver, and majors are the normal case.** This surface converges on a NextGraph that does not ship yet, so most steps toward the target remove or narrow something — the major number will move often, and that frequency is the honest signal about this package, not an apology. Refusing to version would not slow the churn down; it would only take away the one tool you have for managing it. Pin a version, upgrade deliberately, and re-pull this contract each time.
|
||||||
|
|
||||||
|
What each level means here, in this package's own terms:
|
||||||
|
|
||||||
|
- **major** — a published symbol is removed (`getSession`, `normalizeId`, `currentUser`, `RegistrySession`, `inbox.materialize`, `storeRegistry.listMyEntityDocs`, `resolveScopeGraph`, `resolveWriteGraph`, `readUnion` and `UnionSubject` all left this way), **or** a published symbol is renamed (`watchShape` became `useShapeQuery`), **or** an existing call narrows: it now throws where it returned (`ensureIdentity` rejects rather than resolve on an incomplete restore), it reports a state you did not have to handle before (`useShapeQuery` publishing `isError` where it used to publish a synced-empty snapshot), or what it HANDS BACK changes shape (`useShapeQuery`'s `data` carrying the shape's own objects where it carried property bags). A signature change a caller must react to counts; one that only accepts more than before does not.
|
||||||
|
- **minor** — a symbol is added and nothing existing moves (`inbox.readSyncedForDocument` arrived this way).
|
||||||
|
- **patch** — a fix that changes neither the published surface nor anything above under `## Guarantees`.
|
||||||
|
|
||||||
|
**A tag says where it comes from.** A release cut on `main` carries a **full version** (`1.0.0`), and the three rules above govern what changes between two full versions. Work still on a branch carries a **pre-release** of the version it is heading for (`1.0.0-dev.15`), which sorts *below* that version by construction - so you can pin what exists today while the tag itself tells you the surface has not been released and may still move before it is. Between two pre-releases of the same version nothing is promised: re-pull and read this leaf again. When the branch lands, the full version appears alongside; the pre-release keeps resolving, so no reference you pinned is ever withdrawn from under you.
|
||||||
|
|
||||||
|
**Tags carry the package name**, because this repository publishes more than one engagement and their versions move independently: `polyfill/v1.0.0-dev.15` is this package, `ng-e2e-helpers/v...` is the other one. A bare `v...` tag would say nothing about which surface it froze the day the two diverge - which is the day one of them takes a major and the other does not.
|
||||||
|
|
||||||
|
**THE TAG IS THE PIN, and here is exactly what exists to pin.** The acquisition channel is agreed per application and carries no version of its own, so the mechanical anchor this engagement offers is the git tag `polyfill/v<version>` on this repository, cut over the commit at which `packages/polyfill/package.json` reads `<version>`. What an application should pin is that tag, and what its `usage_` leaf's `against:` should name is the version string the tag carries - `against: @ng-eventually/polyfill@1.0.0-dev.15`. There is deliberately no promise beyond that: **nothing is published to a registry, nothing is fetchable by version, and no range resolves** - a `*` peer range against a filesystem checkout compiles whatever is checked out at the other end, uncommitted edits included, and no pin on this side can prevent that. **And the tags lag the versions.** As of 2026-10-01 the newest tag cut on this repository is `polyfill/v1.0.0-dev.3`; every version from `1.0.0-dev.4` onward exists as a package.json value on a branch and has no tag. Until the tag for a version is cut, the only pin that names a version exactly is the COMMIT at which package.json reads it - which is what a `usage_` leaf's `against:` line names in parentheses, and it is a real pin, not a workaround. Pin the tag where there is one, the commit where there is not, and say which in the `against:` line either way.
|
||||||
|
|
||||||
|
`1.0.0` is a baseline, not a claim of maturity: it is the number that makes your pin mean something. Nothing was released before it, so none of the changes named above is a bump from anything - but the next release very likely is a major. What exists today is `1.0.0-dev.15`, on a branch: pin that string exactly, and anchor your `usage_` leaf's `against:` on it - `against: @ng-eventually/polyfill@1.0.0-dev.15`, the string you pinned, never the version it is heading for.
|
||||||
|
|
||||||
|
`1.0.0-dev.15` is a **patch** (2026-10-01), and it answers a consumer's standing requests. No signature changed, nothing was added or removed from the entry, and no behaviour moved - what moved is what this leaf SAYS, which is the only channel such a request has. `## Surface` gains a complete hand-written shape, with the type argument that types the snapshot, and the statement that `initNg` discards its first argument and substitutes the published `ng` (MEASURED, not inferred). `## Guarantees` now says out loud that an anchored `docs.sparqlQuery` refuses a document it cannot read instead of swallowing it - true since `1.0.0-dev.8`, stated only in that version's release note until now - and names, in one place, which reads reach a document in a public store from nothing but its `reference` (the anchored query, always; `useShapeQuery` on a document NAMED in `graphs`, since `1.0.0-dev.9`) and which do not. `## Non-guarantees` says what the `orm_start_graph is not a function` outage actually was (this package's own `ng` wrapper, fixed in `1.0.0-dev.7`, NOT the engine refusing a shape), pins the upstream swallow to the shipped artifact it was read in, and gains an **Asked for, not decided** list so that a request an application made leaves a trace here rather than in a message. `## Change policy` says which pin exists, and that the tags lag the versions.
|
||||||
|
|
||||||
|
`1.0.0-dev.14` is a **patch** (2026-10-01): `ShapeObservable` moved from the entry's SDK-SHAPED section to its POLYFILL-ERA one, and `## Surface` now states that `refetch()` has no recorded counterpart. No signature changed - same name, same shape, still exported from this one entry - so nothing under `## Guarantees` moved. The type was already annotated `kind=invention level=none ref=none` (no upstream observable exists), under a heading that promises a target counterpart for every symbol it lists. It stays exported because applications genuinely write the type down. What the move records is that it is not a framework adapter: it carries the capability filter and the capability-arrival re-publish, both of which exist only because one wallet is shared, so it is deleted when the shared wallet is, as one coupled migration. `ShapeQuery` stays SDK-SHAPED: its record exists and states `{ data, isPending, isSuccess, isError, error }` field for field.
|
||||||
|
|
||||||
|
`1.0.0-dev.13` is a **patch**: `NgLike`, `UseShapeLike`, `OrmSubscriptionLike`, `GetObjectsLike` and `InsertObjectLike` moved from the entry's SDK-SHAPED section to its POLYFILL-ERA one, beside `EventuallyConfig`, whose fields they type. No signature changed - same five names, same five shapes, all still exported from this one entry - so nothing under `## Surface` or `## Guarantees` moved, which is the patch/major line this leaf draws itself. What changed is classification only: each was already honestly annotated `kind=invention level=none ref=none` (no target counterpart, at any level), sitting under a heading that promises one for every symbol it lists, because each exists solely to describe what `configure` receives and `configure` was already on the deletion list. An application that already understood it would stop typing these five the day it deletes its `configure()` call was not misled about behaviour; this patch only makes the surface say so, instead of implying the opposite.
|
||||||
|
|
||||||
|
`1.0.0-dev.12` is a **major**, and it is one removal: **`Schema` (`@ng-org/shex-orm`) and `DeepSignalSet` (`@ng-org/alien-deepsignals`) are gone from the entry, and nothing replaces them.** Both were re-exported type-only under `## Surface`'s own rule - a type is published only when a published signature uses it - and neither was: `DeepSignalSet` is named only in prose describing what `useShape`'s result carries, never as an actual type anywhere in this package, and `Schema` was named nowhere at all beyond the re-export itself. The same rule already removed `ReadCap` and `InboxScope` from this list; this is that rule catching a second, later recurrence. If your code names either type, it stays DEFINED nowhere in this package to fall back on - name the SDK package directly (`@ng-org/shex-orm`, `@ng-org/alien-deepsignals`) if you need it.
|
||||||
|
|
||||||
|
`1.0.0-dev.11` is a **major**, and all of it is one rule: **`useShape` hands back NextGraph's own RESULT OBJECT, filtered - and the filter no longer decides what to hand on by what a member is CALLED.** Nothing is added, renamed or removed from the entry.
|
||||||
|
|
||||||
|
- **Read your objects through `data`, not by iterating what the call returned.** `@ng-org/orm`'s React hook returns `{ data, promise, subscription, isLoading, nextPage?, previousPage? }` around the collection, and it has for every release this package builds against. This package went on treating the return AS the collection: `[...result]` and `result.size` threw, and `result.data`, `result.promise` and `result.subscription` each handed back **every identity's items**, with nothing raised anywhere. If you were reading `.data`, you were reading unfiltered. That is the defect this version closes, and it is why this entry is worth reading before upgrading rather than after.
|
||||||
|
- **`subscription` is REFUSED where it used to be handed over.** It is the ORM's own `RdfOrmSubscription`, which reads and writes with no capability filter at all and which `## Non-guarantees` has always said this package does not publish. Reading it now throws, naming itself. `data`, `promise`, `isLoading` and the two page commands are what remains, and they are what a caller needs: the SDK's own example destructures `data` and `isLoading` and nothing else.
|
||||||
|
- **A member of that object that this package has not DECIDED is refused, whatever its type.** All six of the members `@ng-org/orm` ships are decided; a seventh that a later version adds refuses until someone decides it. Two earlier rules were tried and both let a leak through - "anything that is not a function is harmless", which handed over three members of the current shape, and "a plain scalar cannot reach an item", which handed over any count not spelled `size` or `length`. There is no test on a value's type that separates a count derived from your data from a page size, so the rule is not about types at all: it is that nothing undecided is answered.
|
||||||
|
- **The two arguments are the SDK's own types**, where the signature took `unknown` for both. `useShape(shapeType: ShapeType<T>, conf: RdfOrmConfig<T> | string | undefined)`, which is what the surface already said the pair was. A caller passing the SDK's shape and config compiles unchanged; one passing something else now does not, which is why this counts.
|
||||||
|
- **`size` and `length` count what you may read, and so does every other way of asking.** An ordered config (`orderBy`) makes the collection an array, which says how many items it holds in four places - `length`, `Object.keys`, `in`, and the descriptor of each index - and only the first was filtered. `data[0]` now names the first item you may read rather than the first the engine returned, and the positions past them do not exist.
|
||||||
|
- **A member's DESCRIPTOR answers what reading it answers.** `Object.getOwnPropertyDescriptor(result, "data")` returned the collection UNFILTERED, and `...(result, "subscription")` the handle that reading it refuses: that call does not go through the view's own read. Neither does a spread, `Object.entries`, `JSON.stringify` or a console inspection, so all of them were reading round the filter. They now read through it - which also means `{...result}` and `Object.keys(result)` THROW on `subscription`, where they used to hand it over. **But do not read that as "logging is filtered".** A console is the HOST's, not this package's: `console.log(result)` in Bun and in a browser devtools inspects the object BEHIND the view and prints `data` and `subscription` in full, for every identity, and no interception can prevent it - measured. That is a property of runtime introspection, not a hole a version can close. **Do not log or inspect what a shape read hands you when more than one identity shares the page**; iterate `data` and log what you mean to show.
|
||||||
|
- **A mutation no longer hands back the collection, nor acts past the view, and all three ask the same question.** `add` returned the collection - `Set.prototype.add` returns `this` so calls chain, measured on the plain `Set` and on the real `DeepSignalSet` alike - so `view.add(x)` gave every identity's items to a caller whose every way IN was filtered, through the first member the ORM's own example reaches for. It now hands back the view, and it now REFUSES an object naming a document you hold no key for: ungated, it let you plant an object into someone else's document, never see it again, and have the two-way binding commit it there. `delete` removed an item the view declines to confirm the existence of; `clear` emptied the collection every identity shares. **Your own writes still reach the document** - that is the one thing that must not change, and `e2e/orm-live-read.ts` measures it against the deployed broker.
|
||||||
|
- **A write to the collection itself is refused.** `data[0] = x`, `delete data[0]` and `data.length = 0` all went through against a collection that allowed them, the last defeating the emptying rule outright; `Object.setPrototypeOf(data, ...)` replaced the real collection's prototype, after which iterating it throws for every identity, and `Object.freeze(data)` made it non-extensible. The view refuses all of them itself now, rather than relying on the ordered collection upstream refusing some of them for it.
|
||||||
|
- **The members upstream declares non-mutating answer again.** Eighteen array reads on an ordered result, plus `includes` and the seven set combinators, were throwing for the holder whose data it was - a leak traded for an outage. They are served over the items you may read.
|
||||||
|
- **A member this package has not decided is refused, whatever its type.** The rule used to be "a plain scalar cannot reach an item, so it passes", and a COUNT is a plain scalar that describes the items: a member spelled `totalCount` published how many objects exist while you could read one. `size` and `length` were right only because they were computed by name. Nothing undecided passes now - what a later version adds refuses, loudly, naming itself.
|
||||||
|
- **The RESULT OBJECT is as write-protected as `data`.** `delete result.data`, `result.isLoading = x`, `Object.setPrototypeOf(result, ...)` and `Object.preventExtensions(result)` all reached the SDK's own object; the last two had been closed on `data` one version earlier and not here.
|
||||||
|
- **`add` refuses an object that names no document.** The gate asked the same question a READ asks, where an absent `@graph` means "names no document, nothing to check" - which let an object with no `@graph` into the collection every identity shares. Set `@graph` to a document you hold.
|
||||||
|
- **An ordered result yields indices where it used to yield items.** `keys()` handed back items, `entries()` handed back `[item, item]` and `forEach` handed the item as its second argument - the Set contract, applied to an array. No leak, and wrong output on your own data.
|
||||||
|
- **Unchanged**: the read still spends no round-trip asking a public store for a key, a document you have read nowhere else still does not appear, and nothing about `useShapeQuery`, `getObjects` or `insertObject` moves.
|
||||||
|
|
||||||
|
`1.0.0-dev.10` is a **major**, and all of it is one rule: **"is this document open in this session" now has exactly one answer.** This package kept three records of that fact - a set of live bootstrap subscriptions, a per-document barrier state, and the subscription layer's own listeners - and the first two outlived the third. Only one remains, the state of the document's one real subscription; the other two are gone rather than reconciled, because two records of one fact can disagree and these did. Nothing is added, renamed or removed from the entry.
|
||||||
|
|
||||||
|
- **The ARRIVAL half of a named scope's guarantee is delivered in full**, and the two non-guarantees `1.0.0-dev.9` carried against it are withdrawn. A second `configure(...)` no longer leaves a document recorded as synced against a subscription it tore down - that one DID publish an empty or stale success, and now stays pending until the document is heard from. A subscription the broker refuses no longer leaves the document recorded as open, in the one case where that was unbounded: when the refusal arrives after the subscription layer has been torn down from under it, nothing was ever told, and the document could not be opened again for the rest of the session. In both, the document is now re-opened and the read answers once it has actually been heard from.
|
||||||
|
- **What a caller sees change, and the two situations differ - said per situation rather than lumped together.** After a second `configure(...)` a named scope publishes `isPending` where it published `isSuccess`, and that is why this is counted a **major** on the conservative reading: `isPending` is a state this call already reports and this surface already requires you to handle, so no new state arrives at the caller, but an interface branching on `isSuccess` is handed a different value. When the broker refuses late, the read was already withheld - it is the RECOVERY that changes: the retry now subscribes again instead of being blocked for the rest of the session, so `refetch()` is an exit where it was not. **Calling `configure` once, at start-up, is still what the deployment requirements ask for**; this makes a second call recoverable rather than supported.
|
||||||
|
- **Unchanged, and each is still a success**: a named document you can read that holds nothing of the shape, `graphs: []`, and `graphs: "did:ng:i"` or `""`. Turning a genuine emptiness into a failure would only move the lie, and nothing here does.
|
||||||
|
|
||||||
|
`1.0.0-dev.9` is a **major**, and all of it is one rule: **a read that could not reach its document now FAILS, where it used to answer as though the document were empty.** Nothing is added, nothing is renamed, nothing is removed from the entry - three existing calls narrow.
|
||||||
|
|
||||||
|
- **`useShapeQuery` publishes `isError` for a document you NAME and cannot read.** Until this version a document named in `scope.graphs` was handed straight to the engine; whatever came back was filtered per document by what you hold, and a document you hold no key for was emptied out of the result. The snapshot was `isSuccess` with `data: []` - indistinguishable, byte for byte, from the scope genuinely holding nothing. It now asks the public store for the key, refuses out loud if there is none to be had, and crosses the sync barrier first, so the same read answers `isError`. **Handle `isError` on a named scope**; an interface that only branched on `isPending` / `isSuccess` will show its success state with nothing in it. Naming several documents fails as a whole when one of them fails.
|
||||||
|
- **A named document that has not SYNCED keeps the read pending**, where it used to publish the same empty success. Reaching a document and hearing back from it are two questions, and only the first was being asked. An interface must therefore expect a named scope to sit in its loading state while a document it named is not answering, rather than reading an empty success as "nothing there". The same applies after an in-page re-login, which returns a named scope to pending until its documents are confirmed under the new session - see `## Guarantees`. Complete since `1.0.0-dev.10`; in `1.0.0-dev.9` it held only within one ordinary session, and the two situations that broke it were carried as non-guarantees.
|
||||||
|
- **A named scope now costs round-trips it did not cost before**, once per named document per session: the key fetch, and the subscribe that syncs the repo. The opens run together, so several named documents cost the slowest wait rather than the sum. `graphs: "did:ng:i"` is unchanged and spends nothing.
|
||||||
|
- **A refused named scope RECOVERS on its own.** Reachability is re-read on every publication rather than remembered, and a scope whose barrier failed is attempted again when the keyring moves - including when the move happened while the read was still deciding. Without that a refusal would be terminal, and trading a silent empty answer for a permanently stuck error would have been no improvement at all. Expect to see `isError` briefly on a page that subscribes before its keys are restored. There is no polling: in a session whose keyring never moves again, `refetch()` is the recovery, as it is for every other failure this call reports.
|
||||||
|
- **`inbox.postToDocument`, `inbox.readForDocument` and `inbox.readSyncedForDocument` reject where they used to report "no inbox".** Resolving a document's inbox address reads that document, and when the read could not happen - the broker could not answer for it, or its public store could not be asked for the key - all three used to render the breakdown as the document's owner having opened nothing: a refusal on the deposit side, an empty list on the read side. They now reject. A document that genuinely has no inbox is unchanged, and still answers exactly as before.
|
||||||
|
- **Nothing that was already an ANSWER moves.** An empty document is a success holding zero objects, `graphs: []` is a success holding none, a document in a public store that exposes no key is a plain "no", and a document with no inbox answers `[]`. The whole change is that a *failure* stopped borrowing those shapes.
|
||||||
|
- **Why this direction, and not a richer set of outcomes.** The step that collapsed the two was this package's own emulation of a public store serving its key; NextGraph has no counterpart for it, because upstream nothing consults a capability on the read path at all. So there is no signature to mirror, and the alignment falls to the engine's own observable: an anchored query on a repo the verifier does not hold answers `NgError::RepoNotFound`, a rejected promise - **a read rejects, or it does not**. Inventing a third outcome for a caller to branch on would have been a vocabulary the target will never grow.
|
||||||
|
|
||||||
|
`1.0.0-dev.8` is a **major**, and it is one removal: **`readUnion` and `UnionSubject` are gone from this surface, and nothing replaces them.**
|
||||||
|
|
||||||
|
- **What they were.** `readUnion(docs)` issued one anchored `docs.sparqlQuery` per document, in parallel, and added four policies of its own on top: it swallowed a document it could not read into an empty answer, it dropped a document whose key you do not hold instead of refusing it, it grouped the rows into per-(document, subject) property bags, and it removed the reserved-prefix registers from the result. Nothing at any level of NextGraph answers that composition. Its own provenance annotation cited `sparql_query`, which is a citation a reader checks, finds correct, and moves on from - while the claim attached to it was false. **A composition cannot be aligned on a single function**, and that is the rule this removal serves.
|
||||||
|
- **What to call instead.** `docs.sparqlQuery(sessionId, "SELECT ?s ?p ?o WHERE { ?s ?p ?o }", undefined, doc)` - the primitive `readUnion` was built on, published beside it all along. It is the same anchored query and the same public-store key fetch, so **a bare `reference` is still enough to read a document in a public store**: nothing about that property moves. Reading several documents is this call once per document.
|
||||||
|
- **What comes back to you, and it is not a detail.** Three of the four policies were the batch's, and they are now yours: a read that FAILS rejects instead of reading as an empty document, so whether one unreadable document ends your loop is your decision at your call site; a document you hold no key for is REFUSED out loud instead of being dropped from a result; and the rows are rows - grouping them into objects is yours, or use `getObjects` / `useShapeQuery`, which return the SDK's own typed objects. The fourth is in `## Guarantees`: subjects under `urn:ng-eventually:` are no longer filtered out for you.
|
||||||
|
- **Why the losses are alignment rather than regression.** Upstream, an anchored query on a repo the verifier does not hold REJECTS (`resolve_target_for_sparql` -> `NgError::RepoNotFound`), which reaches JavaScript as a rejected promise. A "skip this one and carry on" policy is something the target does not have and will not grow, so a caller that learned it would have had to unlearn it. The one thing that genuinely disappears is the convenience, and it is three lines at your call site.
|
||||||
|
|
||||||
|
`1.0.0-dev.7` is a **major**, and what makes it one is not the two calls it adds but the rule it starts enforcing. Symbol by symbol:
|
||||||
|
|
||||||
|
- **`getObjects` and `insertObject` are published**, at NextGraph's own names, parameters and returns, wrapping the SDK's. That part is a minor on its own: nothing existing moves. Import them from this package rather than from `@ng-org/orm` - which is the point, since the unwrapped ones bypass the capability filter and the shared-wallet identity boundary entirely. Both are injected through `configure` (`getObjects`, `insertObject`), like the shape query beside them.
|
||||||
|
- **An ORM write into a document you do not own is now refused**, where it used to succeed. This is the major. It applies to `insertObject` and to every mutation of a live set a shape query handed you, because both leave by a door that had no guard on it. The guarantee itself did not move - *only a document's owner writes to it* has been in this contract from the start - but the implementation only enforced it on `docs.sparqlUpdate`. Code that relied on writing through the ORM into somebody else's document was relying on a hole. Note that a live-set mutation is refused WITHOUT your call failing: see the non-guarantee above.
|
||||||
|
- **`initNg` must be this package's**, and it now substitutes the `ng` it hands NextGraph's ORM. An application that calls `@ng-org/orm`'s `initNg` directly still works and is still unguarded - which is exactly the state being left behind, so call this package's.
|
||||||
|
- **`RdfOrmConfig` joins the published types**, because `getObjects`'s signature names it. It is re-exported from the SDK's `/all` subpath, which is where the SDK puts it.
|
||||||
|
- **`ng` works.** Until this version the published `ng` answered every one of its members with a promise instead of the function, so `ng.<anything>(...)` failed with NextGraph's own `<member> is not a function`. If you passed it anywhere - and the surface tells you to use it instead of the one you gave `configure` - that is what you were hitting, including a `useShapeQuery` that never left `isPending` because NextGraph swallows the failure it gets from `orm_start_graph`. Nothing about the call changes; it simply answers now.
|
||||||
|
|
||||||
|
`1.0.0-dev.6` is a **major**, and all of it is one change: `useShapeQuery` reads through NextGraph's OWN shape query instead of a read this package built. Nothing was renamed and nothing was removed from the entry, but three things move under a caller:
|
||||||
|
|
||||||
|
- **`data` items are the shape's objects, not property bags.** `ShapeQuery<T>`'s `T` is now the shape's type: each item carries `@id`, `@graph` and one field per predicate the shape DECLARES, under that predicate's readable name. `note.props["urn:notebook:title"]?.[0]` becomes `note.title`, and `note.graph` becomes `note["@graph"]`. **A predicate your shape does not name is not projected**, so a shape written only to match — an `rdf:type` constraint and nothing else — now comes back with no fields at all: declare the ones you read. (`readUnion` was unchanged by this version, and was removed in `1.0.0-dev.8`.)
|
||||||
|
- **`shapeType` is typed.** It was `unknown`; it is `ShapeType<T>` (the SDK's own, re-exported here), so the snapshot is typed without a cast — and a hand-written shape object must now satisfy that type, which means `readablePredicate`, `minCardinality` and `maxCardinality` on every predicate.
|
||||||
|
- **`configure` takes one more thing.** `ormSubscription: RdfOrmSubscription.getOrCreate`, plus `initNg` and a call to this package's `initNg(ng, session)` once the session has arrived. Optional in the type, required in practice for this read: without it `useShapeQuery` publishes `isError` naming the field.
|
||||||
|
|
||||||
|
And one guarantee narrows, which is the part to read twice: a shape query the engine REFUSES no longer reaches `isError` — it stays `isPending` for ever, because NextGraph swallows that failure. See `## Guarantees`.
|
||||||
|
|
||||||
|
`1.0.0-dev.5` before it was the largest **major** of the line: it renames one call, changes the parameter of two, and removes three. Every change is one step toward the surface NextGraph will ship, so none of them is reversible by asking. Symbol by symbol, with what replaces it:
|
||||||
|
|
||||||
|
- **`watchShape(shapeType, scope)` → `useShapeQuery(shapeType, scope)`.** The name is the target's own; `watchShape` appears nowhere in NextGraph and spends a verb the ORM already uses for signal observation. Everything you read back is unchanged — the same `ShapeObservable`, the same `ShapeQuery` snapshot, the same three states.
|
||||||
|
- **`Scope` is no longer `"public" | "protected" | "private"`.** The published `Scope` is now the SDK's own, `{ graphs?: string[] | string; subjects?: string[] }`, re-exported from `@ng-org/orm`, and it is what `useShapeQuery` takes. `watchShape(Shape, "protected")` becomes `useShapeQuery(Shape, { graphs: "did:ng:i" })` for everything you hold, or `useShapeQuery(Shape, { graphs: [doc1, doc2] })` for named documents. **There is no translation for "the documents in my protected store"**: that question is not expressible against the target, and the three strings were this package's own way of asking it.
|
||||||
|
- **`storeRegistry.createEntityDoc(scope)` → `createEntityDoc(store?)`.** `store` is a reference, not a word: `await storeRegistry.protectedStore()`, `publicStore()` or `privateStore()`. Omitting it places the document in the private store, exactly as `doc_create` does when no store is given. `createEntityDoc("protected")` becomes `createEntityDoc(await storeRegistry.protectedStore())`.
|
||||||
|
- **`storeRegistry.listMyEntityDocs(scope)` is REMOVED, with no replacement call.** There is no `doc_list` upstream, at any level. What replaces it is the read itself: ask `useShapeQuery` for a shape over `{ graphs: "did:ng:i" }` and what you hold of that shape comes back. An application that listed its documents in order to read them was doing in two steps what the read does in one — but it must now write something the shape can match, typically an `rdf:type` triple, since nothing indexes a document for you.
|
||||||
|
- **`storeRegistry.resolveScopeGraph(scope)` is REMOVED.** It handed out a value whose stated use was a read scope, and a store's graph holds its containment triples and nothing else — so pointing a shape query at it matches nothing and says so with an empty set, silently. If you were using it as a write anchor, use the store's reference from the accessor of the same name.
|
||||||
|
- **`storeRegistry.resolveWriteGraph(scope)` is REMOVED.** It returned the very reference `privateStore()` / `protectedStore()` / `publicStore()` return. One value, one published name.
|
||||||
|
|
||||||
|
`1.0.0-dev.4` before it narrowed a **guarantee** and added a rejection: a deposit this package applies is now consumed, so a failure that used to be retried at the next arrival or the next connection is now final and reported once; and `inbox.processInbox` rejects on a broker failure where it used to resolve. An application that leaned on the retry — however implicitly — has to keep its own record instead, and one that awaited `processInbox` without a `catch` now has a rejection to handle. `1.0.0-dev.3` before that narrowed an existing call the same way: two payload shapes an application could carry freely became this package's own, and one it cannot apply is reported. All of them land inside the pre-release line rather than on a new major number because `1.0.0` has not been cut, so there is nothing yet to break away from.
|
||||||
|
|
||||||
|
There is no changelog file and no deprecation window: **the sections above are the release note.** A removal or a narrowing lands in `## Surface` and `## Guarantees` in the same version that ships it, and a symbol is never left published-but-dead as a courtesy. Diff this leaf between two pulls — `## Guarantees` and `## Non-guarantees` before `## Surface`, because that is where a narrowing shows up first.
|
||||||
@@ -1,59 +1,80 @@
|
|||||||
---
|
---
|
||||||
type: usage
|
type: usage
|
||||||
summary: The nine polyfill entries the indexing layer stands on, the constraints it holds itself to, and what it had to build for want of a published helper
|
summary: The polyfill entries the indexing layer and its end-to-end application stand on - placement by store reference, one anchored write, the deposit that becomes an entry, the anchored read, and one shape query
|
||||||
against: "@ng-eventually/polyfill@1.0.0-dev.1"
|
against: "@ng-eventually/polyfill@1.0.0-dev.15 (tag polyfill/v1.0.0-dev.15, commit ec3900077bfd090f5388e52b47a8132b2fc68d16)"
|
||||||
---
|
---
|
||||||
|
|
||||||
# usage_ng-helpers — `@ng-helpers/indexing` on `polyfill-surface`
|
# usage_ng-helpers - `@ng-helpers/indexing` on `polyfill-surface`
|
||||||
|
|
||||||
The consumer is the indexing layer: an index is an ordinary public document, contributions reach it through its inbox, and its owner's session curates it by going through that inbox. NextGraph has no indexing concept, so nothing of what a deposit *means* belongs upstream — the polyfill's inbox stays generic and carries opaque payloads, and this layer decides what they say.
|
The consumer is the indexing layer: an index is an ordinary public document that declares a field, anyone may hand it a reference by depositing into it, and its entries appear because the layer below applies that deposit. NextGraph has no indexing concept, so nothing of what a deposit MEANS belongs upstream - the polyfill's inbox stays generic and carries an opaque payload.
|
||||||
|
|
||||||
The whole runtime dependency passes through **one file**, the adapter that builds our `NextGraphPort`. Everything else in the package is written against that port, so a change to the engagement breaks exactly one file and nothing else. The types are imported type-only, so they are literally the published ones rather than a copy that can drift.
|
Two callers here, and they consume different things. The **library** (`src/`) reaches the polyfill from exactly ONE file, `src/polyfill-adapter.ts`: everything else is written against an internal port, so a change to the engagement breaks that one file and nothing else. The **end-to-end application** (`e2e/indexing-app.ts`, `e2e/bridge.ts`) is written the way a consumer of `@ng-helpers/indexing` writes one, and consumes the polyfill directly for its bootstrap and for reading - which is the point: if something is awkward there, it is awkward for every application.
|
||||||
|
|
||||||
## Consumed surface
|
## Consumed surface
|
||||||
|
|
||||||
**Placement** — `storeRegistry.createEntityDoc("public")`, for the index document itself; `storeRegistry.listMyEntityDocs("public")`, to find again, at each connection, the indexes this identity owns; `storeRegistry.openDocumentInbox(doc)`, at creation to open one and afterwards to resolve its address.
|
**Library - placement, write, inbox** (`src/polyfill-adapter.ts`)
|
||||||
|
|
||||||
**Reading** — `readUnion([doc])` and the type `UnionSubject`. Used both for the index document and for resolving a deposited reference.
|
- `storeRegistry.publicStore()` then `storeRegistry.createEntityDoc(store)` - the index document, in its creator's public store. A store is named by the REFERENCE the accessor hands back, and the argument is never omitted: omitting it places the document in the private store, and an index nobody but its owner can open is not an index. This is the call that was still passing the withdrawn string `"public"` against the previous version.
|
||||||
|
- `storeRegistry.openDocumentInbox(doc)` - called once, at creation, under the owner. The address it returns is deliberately dropped.
|
||||||
|
- `docs.sparqlUpdate(sessionId, update, anchor)` - the only write this package makes, always an anchored `INSERT DATA` of one triple.
|
||||||
|
- `inbox.postToDocument(doc, { payload })` - the deposit, where the payload IS a bare `did:ng:` reference.
|
||||||
|
- Types `Nuri` and `NuriLike`, type-only, so they are literally the published ones rather than a copy that can drift.
|
||||||
|
|
||||||
**Writing** — `docs.sparqlUpdate(sessionId, update, anchor)`, with the document named ONCE as the anchor so the statement carries no `GRAPH <…>` wrapper. It is the only write this package makes, and it is always an `INSERT DATA` of literal triples.
|
**End-to-end application - bootstrap, reading, and one observation** (`e2e/indexing-app.ts`, `e2e/bridge.ts`)
|
||||||
|
|
||||||
**Inbox** — `inbox.postToDocument(doc, { payload })` for depositing, `inbox.readForDocument(doc)` for the owner going through it, `inbox.watch(address, onDeposits)` so that a deposit made while the owner is connected is applied as it lands, and the shape of `Deposit` (`from` / `payload` / `ts`), which our `IncomingDeposit` mirrors.
|
- `configure({ ng, useShape, ormSubscription, init, initNg, sharedWallet })`, this package's own `init(callback, true, [])` for the `session_id` its callback delivers, this package's `initNg(ng, session)` once that session has arrived, and `ensureIdentity()`. `ormSubscription` is `RdfOrmSubscription.getOrCreate` and the injected `initNg` is the SDK's, both from `@ng-org/orm@0.1.2-alpha.21`, passed as they stand; the `ng` and `init` handed to `configure` are `@ng-org/web@0.1.2-alpha.14`'s.
|
||||||
|
- The package's own published `ng`, as the argument `initNg` is given.
|
||||||
|
- `docs.sparqlQuery(sessionId, query, undefined, anchor)` - the anchored SELECT, and the ONLY way anything here reads a document by name: an index, a referenced object, and the stranger's case where the reader holds no key and the public store is asked for one. Two forms: the narrow `SELECT ?object ?value` a consumer of `@ng-helpers/indexing` is told to write, and `SELECT ?s ?p ?o`, whose rows the application groups by subject itself, skipping the polyfill's `urn:ng-eventually:` registers.
|
||||||
|
- `useShapeQuery(shape, { graphs: "did:ng:i" })`, `ShapeObservable`'s three members (`getSnapshot`, `subscribe`, `refetch`), the three states of `ShapeQuery` and its `data`, and the types `Scope` and `ShapeType`. ONE use, and it is an observation rather than a business read: after a failure is injected into the inbox step of `create`, this is how the suite finds the document that was left behind. The shape is hand-written and names one predicate - the descriptor `create` writes - which is what makes an index document matchable at all.
|
||||||
|
|
||||||
**Types** — `Nuri`, `NuriLike`, `PrincipalId`, `UnionSubject`.
|
**Not consumed**, and safely evolvable as far as this repository is concerned: `useShape` (a function that REFUSES is handed to `configure`, and nothing calls it - see `## Frictions`), `subscribeDoc` / `subscribeDocs`, `docs.docCreate`, `storeRegistry.privateStore` / `protectedStore`, `inbox.share` / `post` / `read` / `readForDocument` / `readSynced` / `readSyncedForDocument` / `processInbox` / `watch`, and the types `Deposit` and `PrincipalId`.
|
||||||
|
|
||||||
**Bootstrap, in the end-to-end application only** — `configure`, this package's `init` (for the `sessionId` its callback delivers), and `ensureIdentity`.
|
|
||||||
|
|
||||||
Everything else on the engagement is offered and NOT consumed: `watchShape`, `useShape`, `subscribeDoc`/`subscribeDocs`, `docs.docCreate`, `docs.sparqlQuery`, `storeRegistry.resolveScopeGraph`/`resolveWriteGraph`, `inbox.share`/`post`/`read`/`readSynced`/`readSyncedForDocument`/`processInbox`, `ng`, `initNg`. It is safely evolvable as far as this layer is concerned.
|
|
||||||
|
|
||||||
## Constraints
|
## Constraints
|
||||||
|
|
||||||
**One port is one identity.** The polyfill's session is one user's and no call takes an identifier, so an `Indexing` handle is one person's. Two users mean two handles — which is also what keeps our multi-actor tests honest: a depositor obtains the index NURI the way an application does, never through a shared variable.
|
**A bare reference deposited into a document's inbox becomes an entry on that document.** This is the single guarantee the whole layer rests on: `add` deposits a `did:ng:` reference and nothing else, precisely because that shape is this engagement's own and it acts on it. Nothing of indexing's meaning travels in the payload, and there is no second shape to fall back on.
|
||||||
|
|
||||||
**`sessionId` is relayed, never converted.** We carry it at the engagement's own `string | number` and hand it back untouched.
|
**An index is created in its creator's PUBLIC store, named by that store's reference.** The public store is what serves an index's read key to whoever asks, and that is the whole reason a stranger can reach one from its reference alone. The unit suite pins both halves - where the document landed, and that the store travelled as the reference an accessor produced - so the private placement that omitting the argument would give is red rather than silent.
|
||||||
|
|
||||||
**The write is add-only, and structurally so.** There is no delete builder anywhere in this package, and the only statement it can compose is an anchored `INSERT DATA`. Our own tests execute that SPARQL against an engine that refuses anything else, so a removal is unrunnable rather than merely undetected. This constrains what we ask of the engagement: we need exactly one write primitive and no more.
|
**One handle is one identity.** The session is one user's and no call takes an identifier, so an `Indexing` handle is one person's. Two users mean two handles - which is also what keeps the multi-actor end-to-end journeys honest: a depositor obtains the index reference the way an application does.
|
||||||
|
|
||||||
**The inbox is opened at creation, from one place — and resolved, never opened, afterwards.** The engagement disclaims coalescing `openDocumentInbox` across pages, so the only call that can CREATE one is in `createIndex`, under its owner, at the moment the document is created. Every later call is on a document whose inbox already exists, where the same entry resolves the address instead; the engagement guarantees that idempotence within a page, which is the level our watching lives at.
|
**`sessionId` is relayed, never converted.** It is carried at the engagement's own `string | number` and handed back untouched.
|
||||||
|
|
||||||
**One session watches its own indexes, and nothing stops it.** `inbox.watch`'s unsubscribe is deliberately dropped: our watching lasts exactly as long as the identity is connected, which is what the engagement does with the inboxes it watches on its own account. It also means the inbox address never leaves the one adapter function that resolves it — everything above names a document.
|
**The ORM is the APPLICATION's to wire, and the library never touches it.** `src/` performs no shape read of any kind, so a consumer of `@ng-helpers/indexing` that wants none wires nothing and declares no `@ng-org/*` dependency of its own. Only the end-to-end application here wires it, and only because one observation has no other door.
|
||||||
|
|
||||||
**Our watching relies on subscriptions coexisting on one document.** `inbox.watch` opens a `subscribeDoc` on the inbox document, and the engagement already watches every inbox this identity may read. Before subscriptions coexisted, one of those two would have silenced the other with nothing raised anywhere. Verified in the resolved copy: the fan-out holds a set of listeners.
|
**A reactive read's load state is read before its data, and a pending read is bounded.** An empty `data` means "this scope holds nothing" only under `isSuccess`; under anything else it means nobody answered, and the two never reach a check as one value - the state travels out to the report beside the result. The bound exists because a shape query the engine refuses never finishes loading, so without one that failure would be a hang rather than an observation.
|
||||||
|
|
||||||
**Every payload out of an inbox is untrusted input.** Anyone may deposit anything, so nothing read from a deposit reaches a query before being checked; a non-reference is reported, never thrown on.
|
**The write is add-only, and structurally so.** There is no delete builder anywhere in this package and the only statement it can compose is an anchored `INSERT DATA`; the unit suite executes that SPARQL against an engine that refuses anything else, so a removal is unrunnable rather than merely absent. What this asks of the engagement is exactly one write primitive and no more.
|
||||||
|
|
||||||
**An empty read is never treated as "empty".** Nothing in this layer reads `[]` from `readUnion` as "a valid index that happens to hold nothing" — the descriptor check refuses a document declaring no field, and that refusal aborts curation before a single write.
|
**The document is named once, as the anchor.** The statement carries no `GRAPH <...>` wrapper, because the anchor already scopes the write to that repo's default graph. Naming it twice would be two chances to disagree.
|
||||||
|
|
||||||
|
**A document's inbox is opened from ONE place** - `create`, under the owner, at the moment the document is created - and no address is held anywhere above that call. The non-guarantee about `openDocumentInbox` not coalescing across pages is therefore respected by construction rather than by care.
|
||||||
|
|
||||||
|
**This package declares the polyfill a PEER dependency**, so the application above remains the one place it is named. The single-copy rule is the one packaging mistake the surface cannot protect anyone from, and a library that declared it a direct dependency would be manufacturing exactly that.
|
||||||
|
|
||||||
|
**Every NURI is validated before it reaches a query or a deposit**, because no type guard is published (see `## Frictions`).
|
||||||
|
|
||||||
|
**This layer stays out of `urn:ng-eventually:` entirely.** Its predicates are `urn:ng-helpers:` and the subjects it writes are always `did:ng:` references, so nothing it writes falls under the reserved prefix - which is what lets a reader skip every subject under that prefix without losing anything of an index.
|
||||||
|
|
||||||
|
**A document that cannot be read is refused, not answered empty.** Every read here rests on the anchored query rejecting for a document the reader cannot reach, rather than returning no rows; the end-to-end suite lets that rejection surface as a failure and never reads it as an index holding nothing.
|
||||||
|
|
||||||
|
**An empty read is never concluded from.** Where the end-to-end suite reads an index it polls to a bound and reports what the index held instead, rather than reading once and calling an empty answer an answer.
|
||||||
|
|
||||||
|
**The identity `ensureIdentity()` returns is opaque here** - checked for non-emptiness, carried, printed in a run report, never parsed or rendered as a name.
|
||||||
|
|
||||||
## Frictions
|
## Frictions
|
||||||
|
|
||||||
**The engagement does not say what `readUnion` does with a document it cannot read.** It says what it returns for a document it can, and it says that a rejection means "unknown, never absent" — but not whether an unreadable document inside the list comes back as a rejection or is swallowed into the result. We assume the worst (swallowed, therefore indistinguishable from empty) and code defensively around it. A sentence in `## Guarantees` settling this would replace a guess we are carrying in every read path.
|
**`configure` requires `useShape`, and a frameworkless application has nothing to give it.** `@ng-org/orm` publishes `useShape` only through its react / svelte / vue adapters; a page with no framework can produce none of them. The field is not optional in `EventuallyConfig`, so this application hands over a function that THROWS if anything ever calls it - a value invented to satisfy a signature. Making the field optional removes it.
|
||||||
|
|
||||||
**No published NURI type guard.** `## Guarantees` states plainly that no type guard is published, so this layer carries its own — and it needs one, because a NURI arrives here from an untrusted inbox deposit and must be checked before it can be written between angle brackets. The check we wrote is a guess at what the engagement considers a valid `Nuri`, and a wrong guess is either a rejected legitimate reference or an injected one.
|
**No published NURI type guard.** Every entry validates at its own door, but this layer composes SPARQL before it reaches one, so it carries its own guard. It is a guess at what the engagement considers a valid `Nuri`, and a wrong guess either rejects a legitimate reference or lets one through into a query.
|
||||||
|
|
||||||
**No published escaping helpers.** The engagement lists no `escapeIri`/`escapeLiteral`, and we compose SPARQL against `docs.sparqlUpdate` — so this package carries its own escaping rather than reach into the provider's internals. That is a security-relevant duplication of something the provider certainly already has: two implementations of the same rule, one of which is not the one the provider tests.
|
**No published escaping helpers.** The engagement lists no `escapeIri` / `escapeLiteral`, and this package composes SPARQL against `docs.sparqlUpdate` - so it carries its own escaping rather than reach into the provider. That is a security-relevant duplication: two implementations of one rule, and the one running here is not the one the provider tests.
|
||||||
|
|
||||||
**Watching a document's inbox needs an address, and the only call that hands one out is the one that creates one.** The engagement is explicit that an application never resolves an inbox address, and it publishes `inbox.watch(address, …)` with no `watchForDocument(doc, …)` beside `readForDocument`. So the one thing an owner cannot avoid — being told about deposits on its own document — is also the one place this layer must hold an address, obtained from `openDocumentInbox`, whose other job is to create. A `watchForDocument(doc, onDeposits)` would close that gap and keep the "never resolve an address" rule whole.
|
**No published way to write triples above the raw SPARQL primitive that a library without the ORM can reach.** `insertObject` is the write above `docs.sparqlUpdate`, but it is injected through `configure` and this library wires no `@ng-org/*` by design (see `## Constraints`), so `docs.sparqlUpdate` remains the level it aligns on - which is where the two frictions above come from. An "add these triples to this document" entry, taking no shape, would delete the query composition, the escaping and the NURI validation from this package in a single move.
|
||||||
|
|
||||||
**The version declared and the version the guarantees describe disagree.** The resolved copy's `package.json` says `1.0.0-dev.1`, while the engagement dates the continuous inbox observation and the coexisting subscriptions to `1.0.0-dev.2`. The code has them, so nothing is broken; but a pin cannot express what we actually depend on, and `against:` above names the string we resolve rather than the one the guarantees belong to.
|
## Needs
|
||||||
|
|
||||||
**No published way to write triples above the raw SPARQL primitive.** `docs.sparqlUpdate` is the level we had to align on, which is why the two frictions above exist at all. A published "add these triples to this document" would remove the query composition, the escaping and the NURI validation from this layer in one move.
|
**A way to tell which store holds a document whose reference is already held.** The withdrawn `listMyEntityDocs` had one use here, and the shape read now covers most of it: after a failure is injected into the inbox step of `create`, the suite finds the document left behind by asking for every index document this identity HOLDS and diffing. What that cannot say is WHERE it sits, so the check it feeds now establishes that a document survived, and no longer that it survived in the public store. This is not the question the Change policy declined: it enumerates nothing, it names a document the caller already holds, and a store's graph is said to hold exactly the containment triples that would answer it. As it stands an application cannot verify its own placement at all - a document written to the wrong store is undetectable until some reader fails to open it.
|
||||||
|
|
||||||
|
**A way to tell a shape the ENGINE refused from a shape the application wrote wrong.** `## Non-guarantees` says a refused shape query is caught upstream, written to the console and nothing more: the set stays empty and its readiness never settles. From an application both faults look identical - an `isPending` that does not end - and the console line is not something a page can act on. That is the whole diagnostic surface for the one thing an application must hand-write itself, so the first shape anybody writes has no way of telling "the engine would not take this" from "the ORM was never started". Anything that separates them - a refusal that reaches `isError`, or a state that says "never opened" - turns a silent hang into something an interface can report.
|
||||||
|
|
||||||
|
**A way to tell "examined and discarded" from "not examined yet".** A deposit this engagement applies is consumed whether or not it produced an entry, and a refusal goes to the provider's own log stream - nothing an application can observe, and by the engagement's own words there is no way to ask what was lost. The cost here is concrete: the journey that checks that an object carrying nothing for an index's field is NOT indexed cannot be waited for, because no reading distinguishes "the deposit was examined and skipped" from "the deposit has not been examined yet" - and this repository's suite says so in its own header rather than hiding it, declaring that check weaker than its name. Anything observable from the application - a per-deposit outcome, or merely a count that moves when a queue has been drained - would make it a real one. This layer holds nothing of its own on purpose: an index only ever grows, and the reference is the whole of what is deposited.
|
||||||
|
|||||||
+11
-1
@@ -19,13 +19,23 @@
|
|||||||
|
|
||||||
publish:
|
publish:
|
||||||
# paths are relative to `.project/`
|
# paths are relative to `.project/`
|
||||||
|
#
|
||||||
|
# The engagement we OFFER, plus the two declarations we author as a CONSUMER. Listing a
|
||||||
|
# `usage_` leaf here is what lets each provider re-find it when it moves - and, more to
|
||||||
|
# the point, what makes it visible at all: a declaration nobody can discover leaves the
|
||||||
|
# provider with nothing but our source code to read.
|
||||||
|
#
|
||||||
|
# Both declarations are about this same repository, so the keys are qualified by the
|
||||||
|
# interface they speak on; publish keys must be unique.
|
||||||
indexing-layer: concepts/indexing/indexing-layer/contract_indexing-layer.md
|
indexing-layer: concepts/indexing/indexing-layer/contract_indexing-layer.md
|
||||||
|
polyfill-surface--ng-helpers: concepts/indexing/polyfill-surface/usage_ng-helpers.md
|
||||||
|
ng-e2e-helpers--ng-helpers: concepts/indexing/ng-e2e-helpers/usage_ng-helpers.md
|
||||||
|
|
||||||
consume:
|
consume:
|
||||||
- contract: polyfill-surface
|
- contract: polyfill-surface
|
||||||
type: git
|
type: git
|
||||||
pullFrom: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/app-contract/polyfill-surface/contract_polyfill-surface.md
|
pullFrom: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/app-contract/polyfill-surface/contract_polyfill-surface.md
|
||||||
ref: caps-p1a-and-virtual-user-boundary
|
ref: polyfill/v1.0.0-dev.15
|
||||||
into: concepts/indexing/polyfill-surface/
|
into: concepts/indexing/polyfill-surface/
|
||||||
|
|
||||||
- contract: ng-e2e-helpers
|
- contract: ng-e2e-helpers
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ That boundary is held by one file. `src/polyfill-adapter.ts` is the only place t
|
|||||||
|
|
||||||
**What travels is a bare reference. Nothing else.** It states no claim and gives no instruction: no operation, no index reference (the inbox address already identifies the index), no copy of the indexed value. Whoever processes it opens the object itself and takes what the object says. This is the shape NextGraph already uses upstream, where a `SocialQueryRequest` carries a reference to an RDF definition and the recipient composes its own update; a payload carrying an operation would be a licence for anyone to rewrite someone else's document.
|
**What travels is a bare reference. Nothing else.** It states no claim and gives no instruction: no operation, no index reference (the inbox address already identifies the index), no copy of the indexed value. Whoever processes it opens the object itself and takes what the object says. This is the shape NextGraph already uses upstream, where a `SocialQueryRequest` carries a reference to an RDF definition and the recipient composes its own update; a payload carrying an operation would be a licence for anyone to rewrite someone else's document.
|
||||||
|
|
||||||
**Reading needs nothing new.** An application that knows the NURI calls `readUnion([indexNuri])` and gets the entries as subjects, or runs an anchored `SELECT`. There is no read helper here, and that absence is deliberate: one would only teach a shape a caller has to unlearn.
|
**Reading needs nothing new.** An application that knows the NURI runs a `SELECT` anchored on it — `docs.sparqlQuery`, the same call it reads any other document with — and gets the entries. There is no read helper here, and that absence is deliberate: one would only teach a shape a caller has to unlearn.
|
||||||
|
|
||||||
## What this package does, and what it deliberately does not
|
## What this package does, and what it deliberately does not
|
||||||
|
|
||||||
|
|||||||
+31
-8
@@ -14,14 +14,23 @@
|
|||||||
* ends up typed as a reference.
|
* ends up typed as a reference.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import type { UnionSubject } from "@ng-eventually/polyfill";
|
/**
|
||||||
|
* One subject of a document and everything the document says about it, keyed by
|
||||||
|
* predicate. Declared here because nothing publishes it: the polyfill withdrew its own
|
||||||
|
* (`UnionSubject`, with `readUnion`) in `1.0.0-dev.8`, and grouping the rows of an
|
||||||
|
* anchored query is the application's business -- see `readDocument` in the page.
|
||||||
|
*/
|
||||||
|
export interface DocumentSubject {
|
||||||
|
readonly subject: string;
|
||||||
|
readonly props: Readonly<Record<string, readonly string[]>>;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* One entry, as THIS APPLICATION decodes one out of the index document.
|
* One entry, as THIS APPLICATION decodes one out of the index document.
|
||||||
*
|
*
|
||||||
* It is declared here and not imported, because `@ng-helpers/indexing` publishes no
|
* It is declared here and not imported, because `@ng-helpers/indexing` publishes no
|
||||||
* such type and no call that produces one: an index is an ordinary document, so its
|
* such type and no call that produces one: an index is an ordinary document, so its
|
||||||
* contents are whatever `readUnion` hands back, read with the two published IRIs.
|
* contents are whatever an anchored query hands back, read with the two published IRIs.
|
||||||
* A subject carrying several values shows up as several rows — the document's own
|
* A subject carrying several values shows up as several rows — the document's own
|
||||||
* truth, and the application's business to make something of.
|
* truth, and the application's business to make something of.
|
||||||
*/
|
*/
|
||||||
@@ -36,8 +45,24 @@ export interface BrokenInboxOutcome {
|
|||||||
readonly rejected: string | null;
|
readonly rejected: string | null;
|
||||||
/** What `create` returned, on the impossible branch where it did not reject. */
|
/** What `create` returned, on the impossible branch where it did not reject. */
|
||||||
readonly returned: string | null;
|
readonly returned: string | null;
|
||||||
/** The documents that appeared in this identity's public store despite the failure. */
|
/**
|
||||||
|
* The index documents this identity did not hold before, and holds after the failure.
|
||||||
|
*
|
||||||
|
* It does NOT enumerate a store, because there is no longer such a call: the documents in
|
||||||
|
* a store are not askable for, so what is read instead is every index document this
|
||||||
|
* identity HOLDS, through the shape query. The difference matters when reading the
|
||||||
|
* check it feeds: what it establishes is that a document survived, not where it sits.
|
||||||
|
*/
|
||||||
readonly appeared: readonly string[];
|
readonly appeared: readonly string[];
|
||||||
|
/**
|
||||||
|
* Which of the read's three states that observation came out of -- `success`, or the
|
||||||
|
* state it gave up in.
|
||||||
|
*
|
||||||
|
* An empty `appeared` means "nothing turned up" only under `success`. Under `pending`
|
||||||
|
* or `error` it means nobody answered, and a report that folded the two together would
|
||||||
|
* let a read that never started pass for a leak that never happened.
|
||||||
|
*/
|
||||||
|
readonly observed: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -104,13 +129,13 @@ export interface IndexingBridge {
|
|||||||
rebuildHandle(): Promise<void>;
|
rebuildHandle(): Promise<void>;
|
||||||
/**
|
/**
|
||||||
* The index's entries, ordered by value — decoded BY THIS APPLICATION, out of an
|
* The index's entries, ordered by value — decoded BY THIS APPLICATION, out of an
|
||||||
* ordinary `readUnion` of the index document, with nothing from the library but the
|
* ordinary anchored read of the index document, with nothing from the library but the
|
||||||
* two IRIs it publishes. That the suite can do this at all is the claim under test.
|
* two IRIs it publishes. That the suite can do this at all is the claim under test.
|
||||||
*/
|
*/
|
||||||
read(index: string): Promise<IndexRow[]>;
|
read(index: string): Promise<IndexRow[]>;
|
||||||
|
|
||||||
/** What a document literally holds, straight off `readUnion` — the write-form probe. */
|
/** What a document literally holds, grouped by subject — the write-form probe. */
|
||||||
readRaw(doc: string): Promise<UnionSubject[]>;
|
readRaw(doc: string): Promise<DocumentSubject[]>;
|
||||||
/**
|
/**
|
||||||
* Run a SPARQL SELECT anchored on a document, through `docs.sparqlQuery`.
|
* Run a SPARQL SELECT anchored on a document, through `docs.sparqlQuery`.
|
||||||
*
|
*
|
||||||
@@ -120,8 +145,6 @@ export interface IndexingBridge {
|
|||||||
* on the bridge because the claim had never been measured against a broker.
|
* on the bridge because the claim had never been measured against a broker.
|
||||||
*/
|
*/
|
||||||
select(anchor: string, query: string): Promise<SelectOutcome>;
|
select(anchor: string, query: string): Promise<SelectOutcome>;
|
||||||
/** This identity's public documents. How an owner discovers a document it did not keep. */
|
|
||||||
listPublicDocs(): Promise<string[]>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `create` with its inbox step made to fail — everything else real, against the
|
* `create` with its inbox step made to fail — everything else real, against the
|
||||||
|
|||||||
+224
-33
@@ -14,10 +14,16 @@
|
|||||||
* surface: `indexing(sessionId)`, the two acts on what it hands back, and the two IRIs.
|
* surface: `indexing(sessionId)`, the two acts on what it hands back, and the two IRIs.
|
||||||
* Nothing here makes an entry of a deposit, and nothing here can ask for one: that is
|
* Nothing here makes an entry of a deposit, and nothing here can ask for one: that is
|
||||||
* the business of the layer below, and this page is where that shows or does not.
|
* the business of the layer below, and this page is where that shows or does not.
|
||||||
* Everything else here is the polyfill (`configure`, `ensureIdentity`, `init`,
|
* Everything else here is the polyfill (`configure`, `ensureIdentity`, `init`, `initNg`,
|
||||||
* `readUnion`, `docs`, `storeRegistry`) — including reading the index, which is an
|
* `ng`, `docs`, `useShapeQuery`) -- including reading the index, which is an ordinary
|
||||||
* ordinary `readUnion` of an ordinary document. If something here is awkward, it is
|
* anchored `docs.sparqlQuery` of an ordinary document. If something here is awkward, it
|
||||||
* awkward for every consumer, which is the second reason to write it this way.
|
* is awkward for every consumer, which is the second reason to write it this way.
|
||||||
|
*
|
||||||
|
* This page WIRES THE ORM, because one thing here has no other door: the store enumeration it
|
||||||
|
* used to discover a leaked document left the engagement, and what replaces it is a shape
|
||||||
|
* query, which reads through NextGraph's own and therefore needs `ormSubscription`,
|
||||||
|
* `initNg` and a hand-written shape. An application that hands `configure` a stub gets
|
||||||
|
* none of it.
|
||||||
*
|
*
|
||||||
* The two things here no application does, and why they reach past the surface
|
* The two things here no application does, and why they reach past the surface
|
||||||
* `createIndexWithBrokenInbox` injects a failure into the inbox step of `create`: the
|
* `createIndexWithBrokenInbox` injects a failure into the inbox step of `create`: the
|
||||||
@@ -35,30 +41,57 @@ import {
|
|||||||
docs,
|
docs,
|
||||||
ensureIdentity,
|
ensureIdentity,
|
||||||
init,
|
init,
|
||||||
readUnion,
|
initNg,
|
||||||
storeRegistry,
|
ng,
|
||||||
type Nuri,
|
useShapeQuery,
|
||||||
type UnionSubject,
|
type Scope,
|
||||||
|
type ShapeObservable,
|
||||||
|
type ShapeQuery,
|
||||||
|
type ShapeType,
|
||||||
} from "@ng-eventually/polyfill";
|
} from "@ng-eventually/polyfill";
|
||||||
import { ng as realNg, init as realInit } from "@ng-org/web";
|
import { ng as realNg, init as realInit } from "@ng-org/web";
|
||||||
|
import { RdfOrmSubscription, initNg as ormInitNg } from "@ng-org/orm";
|
||||||
|
|
||||||
// The whole published surface of the package under test.
|
// The whole published surface of the package under test.
|
||||||
import { ENTRY_VALUE, indexing, type Indexing } from "../src/index";
|
import { ENTRY_VALUE, INDEX_FIELD, indexing, type Indexing } from "../src/index";
|
||||||
// NOT published, and reached only by the two probes above — see the header.
|
// NOT published, and reached only by the two probes above — see the header.
|
||||||
import { indexingOn } from "../src/indexing";
|
import { indexingOn } from "../src/indexing";
|
||||||
import type { NextGraphPort } from "../src/port";
|
import type { NextGraphPort } from "../src/port";
|
||||||
import { polyfillPort } from "../src/polyfill-adapter";
|
import { polyfillPort } from "../src/polyfill-adapter";
|
||||||
import type { BrokenInboxOutcome, IndexRow, IndexingBridge, SelectOutcome } from "./bridge";
|
import type {
|
||||||
|
BrokenInboxOutcome,
|
||||||
|
DocumentSubject,
|
||||||
|
IndexRow,
|
||||||
|
IndexingBridge,
|
||||||
|
SelectOutcome,
|
||||||
|
} from "./bridge";
|
||||||
|
|
||||||
// bootstrap: the one polyfill-era call, then the SDK-shaped ones
|
// bootstrap: the one polyfill-era call, then the SDK-shaped ones
|
||||||
//
|
//
|
||||||
// `sharedWallet` is declared because the access gate wants somewhere to point when it
|
// `sharedWallet` is declared because the access gate wants somewhere to point when it
|
||||||
// has to render, and never used: this suite always enters through the broker's redirect,
|
// has to render, and never used: this suite always enters through the broker's redirect,
|
||||||
// where the wallet is already open in the run's profile. Nothing is served at that path.
|
// where the wallet is already open in the run's profile. Nothing is served at that path.
|
||||||
|
//
|
||||||
|
// THE ORM IS WIRED HERE, and it is not optional dressing: `useShapeQuery` reads through
|
||||||
|
// NextGraph's own shape query, which arrives through `ormSubscription` and is started by
|
||||||
|
// `initNg`. Without them that read publishes `isError` naming the field it never got.
|
||||||
|
// `RdfOrmSubscription.getOrCreate` is passed as it stands -- no wrapper, no cast.
|
||||||
configure({
|
configure({
|
||||||
ng: realNg,
|
ng: realNg,
|
||||||
useShape: () => undefined, // this application reads through `readUnion`, not the ORM
|
// Required by `configure`, and `@ng-org/orm` publishes `useShape` only through its
|
||||||
|
// framework adapters (react / svelte / vue). This page has no framework, so there is
|
||||||
|
// nothing honest to hand over: it REFUSES instead of answering `undefined`, which a
|
||||||
|
// caller could not tell from an empty read-filtered view. Nothing here calls it, and
|
||||||
|
// the gap is declared in `usage_ng-helpers`'s `## Frictions`.
|
||||||
|
useShape: () => {
|
||||||
|
throw new Error(
|
||||||
|
"[e2e] useShape was never wired: this page has no framework adapter to give it, " +
|
||||||
|
"and it reads through docs.sparqlQuery and useShapeQuery instead",
|
||||||
|
);
|
||||||
|
},
|
||||||
|
ormSubscription: RdfOrmSubscription.getOrCreate,
|
||||||
init: realInit,
|
init: realInit,
|
||||||
|
initNg: ormInitNg,
|
||||||
sharedWallet: { fileUrl: "/wallet-never-served.ngw", password: "" },
|
sharedWallet: { fileUrl: "/wallet-never-served.ngw", password: "" },
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -96,6 +129,13 @@ async function boot(): Promise<void> {
|
|||||||
// and the identity comes back. The application keeps it only to show it.
|
// and the identity comes back. The application keeps it only to show it.
|
||||||
state.who = await ensureIdentity();
|
state.who = await ensureIdentity();
|
||||||
const session = await sessionReady;
|
const session = await sessionReady;
|
||||||
|
// The ORM is started once the session exists and not before: `useShapeQuery` reads
|
||||||
|
// through it, and this package's own `initNg` is the one to CALL -- not the SDK's,
|
||||||
|
// which was handed to `configure` and is reached from there. The `ng` it is given is
|
||||||
|
// this package's too, the one the surface says to call instead of the one `configure`
|
||||||
|
// was passed. The engagement states the argument is discarded either way: the call
|
||||||
|
// substitutes that same published `ng`.
|
||||||
|
initNg(ng, session);
|
||||||
// The session id, and nothing else — this application never names a port, and never
|
// The session id, and nothing else — this application never names a port, and never
|
||||||
// awaits anything here: a handle reaches nothing. A reference this application hands
|
// awaits anything here: a handle reaches nothing. A reference this application hands
|
||||||
// an index becomes an entry because the layer below processes that index's inbox,
|
// an index becomes an entry because the layer below processes that index's inbox,
|
||||||
@@ -127,26 +167,125 @@ async function probePort(): Promise<NextGraphPort> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wait for a document to appear in this identity's public store.
|
* THE SHAPE AN INDEX DOCUMENT MATCHES, hand-written here because there is no other way
|
||||||
|
* to ask this question any more.
|
||||||
*
|
*
|
||||||
* A store listing is a read like any other, and a document written a moment ago is not
|
* `storeRegistry.listMyEntityDocs` left the engagement, and what replaces it is the read
|
||||||
* owed to be in it instantly. Polling is therefore what an owner would actually do, and
|
* itself: a shape over `{ graphs: "did:ng:i" }` brings back what this identity HOLDS of
|
||||||
* it is bounded: an empty answer at the end is evidence, not a hang.
|
* that shape. So the descriptor `create` writes -- one triple, on the index document's
|
||||||
|
* own subject -- is what makes an index findable, and it is declared here as the one
|
||||||
|
* predicate this shape names. A predicate a shape does not name is not projected, so
|
||||||
|
* `field` is both the match and the whole of what comes back.
|
||||||
|
*
|
||||||
|
* NOT A STORE LISTING, and the difference is recorded rather than glossed: `Scope` has
|
||||||
|
* two axes, neither of them a store. This finds an index document wherever it sits, and
|
||||||
|
* says nothing about which of the three stores holds it.
|
||||||
*/
|
*/
|
||||||
async function publicDocsAfter(
|
type IndexDescriptor = {
|
||||||
before: ReadonlySet<string>,
|
"@id": string;
|
||||||
|
"@graph": string;
|
||||||
|
field: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
const INDEX_SHAPE = "urn:ng-helpers-e2e:shape:index";
|
||||||
|
|
||||||
|
const IndexShape: ShapeType<IndexDescriptor> = {
|
||||||
|
shape: INDEX_SHAPE,
|
||||||
|
schema: {
|
||||||
|
[INDEX_SHAPE]: {
|
||||||
|
iri: INDEX_SHAPE,
|
||||||
|
predicates: [
|
||||||
|
{
|
||||||
|
iri: INDEX_FIELD,
|
||||||
|
readablePredicate: "field",
|
||||||
|
dataTypes: [{ valType: "string" }],
|
||||||
|
minCardinality: 1,
|
||||||
|
maxCardinality: 1,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Everything this identity holds, which is as close to "my documents" as `Scope` goes. */
|
||||||
|
const EVERYTHING_HELD: Scope = { graphs: "did:ng:i" };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which of the three states a reactive read is in.
|
||||||
|
*
|
||||||
|
* Read BEFORE the data, always: an empty `data` under `isSuccess` means this scope holds
|
||||||
|
* nothing of that shape, and an empty `data` under anything else means nobody answered.
|
||||||
|
* The two must never be reported as one, which is the whole reason this is carried out
|
||||||
|
* to the report instead of being collapsed into an empty list.
|
||||||
|
*/
|
||||||
|
type LoadState = "pending" | "success" | "error";
|
||||||
|
|
||||||
|
function loadStateOf(snapshot: ShapeQuery<IndexDescriptor>): LoadState {
|
||||||
|
if (snapshot.isError) return "error";
|
||||||
|
if (snapshot.isSuccess) return "success";
|
||||||
|
return "pending";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The documents the snapshot's objects came out of -- one entry per index document. */
|
||||||
|
function documentsIn(snapshot: ShapeQuery<IndexDescriptor>): string[] {
|
||||||
|
return snapshot.data.map((descriptor) => descriptor["@graph"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wait for the read to ANSWER -- to reach `isSuccess` or `isError`.
|
||||||
|
*
|
||||||
|
* A shape query the engine refuses stays `isPending` for ever: NextGraph catches that
|
||||||
|
* failure, logs it, and its readiness signal is only ever resolved. So a bound here is
|
||||||
|
* not impatience, it is the only way that failure becomes a named observation instead of
|
||||||
|
* a hang, and what it returns is the state it gave up in.
|
||||||
|
*/
|
||||||
|
async function answered(
|
||||||
|
held: ShapeObservable<IndexDescriptor>,
|
||||||
budgetMs: number,
|
budgetMs: number,
|
||||||
): Promise<readonly string[]> {
|
): Promise<LoadState> {
|
||||||
const deadline = Date.now() + budgetMs;
|
const deadline = Date.now() + budgetMs;
|
||||||
let appeared: readonly string[] = [];
|
|
||||||
for (;;) {
|
for (;;) {
|
||||||
const now = await storeRegistry.listMyEntityDocs("public");
|
const state = loadStateOf(held.getSnapshot());
|
||||||
appeared = now.filter((d) => !before.has(d));
|
if (state !== "pending" || Date.now() >= deadline) return state;
|
||||||
if (appeared.length > 0 || Date.now() >= deadline) return appeared;
|
|
||||||
await new Promise((r) => setTimeout(r, 500));
|
await new Promise((r) => setTimeout(r, 500));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wait for an index document this identity did not hold before to turn up.
|
||||||
|
*
|
||||||
|
* A document written a moment ago is not owed to be readable instantly, and this read is
|
||||||
|
* push-driven rather than polled -- so the loop asks the OBSERVABLE again (`refetch`)
|
||||||
|
* rather than issuing a fresh read, and it is bounded: an empty answer under `success` at
|
||||||
|
* the end is evidence, not a hang. An empty answer under any other state is neither, and
|
||||||
|
* that is why the state travels back with it.
|
||||||
|
*/
|
||||||
|
async function indexDocsAfter(
|
||||||
|
held: ShapeObservable<IndexDescriptor>,
|
||||||
|
before: ReadonlySet<string>,
|
||||||
|
budgetMs: number,
|
||||||
|
): Promise<{ appeared: readonly string[]; observed: LoadState }> {
|
||||||
|
const deadline = Date.now() + budgetMs;
|
||||||
|
for (;;) {
|
||||||
|
const snapshot = held.getSnapshot();
|
||||||
|
const observed = loadStateOf(snapshot);
|
||||||
|
const appeared =
|
||||||
|
observed === "success" ? documentsIn(snapshot).filter((d) => !before.has(d)) : [];
|
||||||
|
if (appeared.length > 0 || Date.now() >= deadline) return { appeared, observed };
|
||||||
|
await new Promise((r) => setTimeout(r, 500));
|
||||||
|
held.refetch();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How long the reactive read has, both to answer at all and to notice what turned up.
|
||||||
|
*
|
||||||
|
* It replaces the bound the withdrawn store enumeration was polled under, and it carries one
|
||||||
|
* more job than that one did: a shape query the engine refuses never finishes loading, so
|
||||||
|
* this is also what turns that failure into a reported state.
|
||||||
|
*/
|
||||||
|
const OBSERVE_MS = 15_000;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* How much of an answer a report carries. Bounded so a report stays one, generous enough
|
* How much of an answer a report carries. Bounded so a report stays one, generous enough
|
||||||
* that the answer is readable rather than merely counted.
|
* that the answer is readable rather than merely counted.
|
||||||
@@ -190,6 +329,40 @@ function rowsOf(result: unknown): Array<Record<string, string>> {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Everything a document holds, grouped by subject -- what an application writes in place
|
||||||
|
* of the `readUnion` the polyfill withdrew in `1.0.0-dev.8`.
|
||||||
|
*
|
||||||
|
* One anchored `SELECT ?s ?p ?o`: the anchor makes the document the query's default graph,
|
||||||
|
* so the body names no graph and reads that document and nothing else. A document this
|
||||||
|
* identity cannot read REJECTS, and the rejection is left to reach the caller -- an
|
||||||
|
* unreadable document is "unknown", never "empty". The polyfill's own registers live
|
||||||
|
* under `urn:ng-eventually:` in the same graph and come back with the rest; they are the
|
||||||
|
* polyfill's, not the document's, so they are dropped here.
|
||||||
|
*/
|
||||||
|
async function readDocument(doc: string): Promise<DocumentSubject[]> {
|
||||||
|
const session = await sessionReady;
|
||||||
|
const result = await docs.sparqlQuery(
|
||||||
|
session.session_id,
|
||||||
|
"SELECT ?s ?p ?o WHERE { ?s ?p ?o }",
|
||||||
|
undefined,
|
||||||
|
doc,
|
||||||
|
);
|
||||||
|
const bySubject = new Map<string, Record<string, string[]>>();
|
||||||
|
for (const row of rowsOf(result)) {
|
||||||
|
const { s, p, o } = row;
|
||||||
|
if (s === undefined || p === undefined || o === undefined) continue;
|
||||||
|
if (s.startsWith(RESERVED_PREFIX)) continue;
|
||||||
|
const props = bySubject.get(s) ?? {};
|
||||||
|
(props[p] ??= []).push(o);
|
||||||
|
bySubject.set(s, props);
|
||||||
|
}
|
||||||
|
return [...bySubject].map(([subject, props]) => ({ subject, props }));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The polyfill's reserved prefix: what it writes into a document under it is its own. */
|
||||||
|
const RESERVED_PREFIX = "urn:ng-eventually:";
|
||||||
|
|
||||||
// the acts
|
// the acts
|
||||||
|
|
||||||
const bridge: IndexingBridge = {
|
const bridge: IndexingBridge = {
|
||||||
@@ -237,12 +410,12 @@ const bridge: IndexingBridge = {
|
|||||||
/**
|
/**
|
||||||
* The index read BY THIS APPLICATION, with nothing the package publishes but
|
* The index read BY THIS APPLICATION, with nothing the package publishes but
|
||||||
* `ENTRY_VALUE` — the claim "an index is an ordinary document" performed rather than
|
* `ENTRY_VALUE` — the claim "an index is an ordinary document" performed rather than
|
||||||
* repeated. `readUnion([index])` is the same call this page makes on any other
|
* repeated. `readDocument(index)` is the same read this page makes of any other
|
||||||
* document; the index's own subject is the one that is not an entry, told apart by
|
* document; the index's own subject is the one that is not an entry, told apart by
|
||||||
* being the document itself.
|
* being the document itself.
|
||||||
*/
|
*/
|
||||||
async read(index: string): Promise<IndexRow[]> {
|
async read(index: string): Promise<IndexRow[]> {
|
||||||
const subjects = await readUnion([index]);
|
const subjects = await readDocument(index);
|
||||||
const rows: IndexRow[] = [];
|
const rows: IndexRow[] = [];
|
||||||
for (const subject of subjects) {
|
for (const subject of subjects) {
|
||||||
if (subject.subject === index) continue;
|
if (subject.subject === index) continue;
|
||||||
@@ -259,8 +432,8 @@ const bridge: IndexingBridge = {
|
|||||||
return rows;
|
return rows;
|
||||||
},
|
},
|
||||||
|
|
||||||
async readRaw(doc: string): Promise<UnionSubject[]> {
|
async readRaw(doc: string): Promise<DocumentSubject[]> {
|
||||||
return readUnion([doc]);
|
return readDocument(doc);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -281,14 +454,23 @@ const bridge: IndexingBridge = {
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
async listPublicDocs(): Promise<string[]> {
|
|
||||||
const docs: Nuri[] = await storeRegistry.listMyEntityDocs("public");
|
|
||||||
return [...docs];
|
|
||||||
},
|
|
||||||
|
|
||||||
async createIndexWithBrokenInbox(field: string): Promise<BrokenInboxOutcome> {
|
async createIndexWithBrokenInbox(field: string): Promise<BrokenInboxOutcome> {
|
||||||
const p = await probePort();
|
const p = await probePort();
|
||||||
const before = new Set<string>(await storeRegistry.listMyEntityDocs("public"));
|
|
||||||
|
// The read that will notice the leak, opened BEFORE anything is created so that
|
||||||
|
// "what was already held" is a reading and not an assumption. It is subscribed
|
||||||
|
// because an observable with nobody listening has nowhere to push what arrives,
|
||||||
|
// and it is released at the end: the probe is its only caller.
|
||||||
|
const held = useShapeQuery(IndexShape, EVERYTHING_HELD);
|
||||||
|
const release = held.subscribe(() => {});
|
||||||
|
try {
|
||||||
|
// The opening read has to ANSWER first. A `before` taken from a read that never
|
||||||
|
// happened is empty, and an empty `before` would make the first document this
|
||||||
|
// identity has ever held look like something the failure left behind.
|
||||||
|
const opening = await answered(held, OBSERVE_MS);
|
||||||
|
const before = new Set<string>(
|
||||||
|
opening === "success" ? documentsIn(held.getSnapshot()) : [],
|
||||||
|
);
|
||||||
|
|
||||||
// Everything real except the inbox step. The failure is injected at the exact moment
|
// Everything real except the inbox step. The failure is injected at the exact moment
|
||||||
// the question is about: after the document exists and carries its descriptor, before
|
// the question is about: after the document exists and carries its descriptor, before
|
||||||
@@ -308,7 +490,16 @@ const bridge: IndexingBridge = {
|
|||||||
rejected = String((e as Error)?.message ?? e);
|
rejected = String((e as Error)?.message ?? e);
|
||||||
}
|
}
|
||||||
|
|
||||||
return { rejected, returned, appeared: await publicDocsAfter(before, 15_000) };
|
const after = await indexDocsAfter(held, before, OBSERVE_MS);
|
||||||
|
return {
|
||||||
|
rejected,
|
||||||
|
returned,
|
||||||
|
appeared: after.appeared,
|
||||||
|
observed: opening === "success" ? after.observed : `${opening} before the probe ran`,
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
release();
|
||||||
|
}
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
+19
-14
@@ -207,7 +207,7 @@ const { check, journey, finish } = declareSuite({
|
|||||||
name: "An index whose inbox cannot be opened leaves a document behind",
|
name: "An index whose inbox cannot be opened leaves a document behind",
|
||||||
checks: [
|
checks: [
|
||||||
"createIndex refuses when the inbox cannot be opened",
|
"createIndex refuses when the inbox cannot be opened",
|
||||||
"a document was nevertheless created in the owner's public store",
|
"a document was nevertheless created, and its owner still holds it",
|
||||||
"the leaked document carries a descriptor but accepts no deposit",
|
"the leaked document carries a descriptor but accepts no deposit",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -221,7 +221,7 @@ const { check, journey, finish } = declareSuite({
|
|||||||
{
|
{
|
||||||
name: "The index answers an ordinary SPARQL query",
|
name: "The index answers an ordinary SPARQL query",
|
||||||
checks: [
|
checks: [
|
||||||
"readUnion returns both entries and the index's own declaration",
|
"reading the document returns both entries and the index's own declaration",
|
||||||
"a SELECT for the entry predicate returns both entries, with their values",
|
"a SELECT for the entry predicate returns both entries, with their values",
|
||||||
"a SELECT of the index's own subject returns the field it declares",
|
"a SELECT of the index's own subject returns the field it declares",
|
||||||
"a stranger's SELECT returns the same entries",
|
"a stranger's SELECT returns the same entries",
|
||||||
@@ -278,7 +278,7 @@ function step<T>(what: string, ms: number, task: () => Promise<T>): Promise<T> {
|
|||||||
* to suit it.
|
* to suit it.
|
||||||
*
|
*
|
||||||
* ── It reads the way an application reads ───────────────────────────────────
|
* ── It reads the way an application reads ───────────────────────────────────
|
||||||
* `read` is an ordinary `readUnion` of an ordinary document, or an anchored SELECT — the
|
* `read` is an ordinary anchored read of an ordinary document, or a narrower SELECT — the
|
||||||
* only two ways anyone has of reading an index, the harness included. Nothing here reaches
|
* only two ways anyone has of reading an index, the harness included. Nothing here reaches
|
||||||
* for a way to hurry the layer below, because a consumer has none either.
|
* for a way to hurry the layer below, because a consumer has none either.
|
||||||
*
|
*
|
||||||
@@ -455,9 +455,9 @@ async function main(): Promise<void> {
|
|||||||
const declared = self?.props[INDEX_FIELD] ?? [];
|
const declared = self?.props[INDEX_FIELD] ?? [];
|
||||||
check(
|
check(
|
||||||
"the index document declares the field it indexes by",
|
"the index document declares the field it indexes by",
|
||||||
declared.length === 1 && declared[0] === PUBLISHED_AT && self?.graph === index,
|
declared.length === 1 && declared[0] === PUBLISHED_AT,
|
||||||
`subjects=${raw.length} self=${self === undefined ? "(not found)" : "found"} ` +
|
`subjects=${raw.length} self=${self === undefined ? "(not found)" : "found"} ` +
|
||||||
`graph=${self?.graph} declared=${JSON.stringify(declared)}`,
|
`declared=${JSON.stringify(declared)}`,
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
@@ -654,15 +654,20 @@ async function main(): Promise<void> {
|
|||||||
outcome.rejected !== null && outcome.returned === null,
|
outcome.rejected !== null && outcome.returned === null,
|
||||||
`rejected=${outcome.rejected} returned=${outcome.returned}`,
|
`rejected=${outcome.rejected} returned=${outcome.returned}`,
|
||||||
);
|
);
|
||||||
|
// WHAT IS OBSERVED HERE, and what is not. There is no call that lists a store any
|
||||||
|
// more, so the leak is found by reading every index document Alice HOLDS and
|
||||||
|
// diffing: that establishes the document survived, not which store it sits in.
|
||||||
|
// `observed` travels with it because an empty answer only means "nothing turned
|
||||||
|
// up" under `success` -- under any other state it means nobody answered.
|
||||||
check(
|
check(
|
||||||
"a document was nevertheless created in the owner's public store",
|
"a document was nevertheless created, and its owner still holds it",
|
||||||
outcome.appeared.length === 1,
|
outcome.appeared.length === 1 && outcome.observed === "success",
|
||||||
`appeared=${JSON.stringify(outcome.appeared)}`,
|
`appeared=${JSON.stringify(outcome.appeared)} observed=${outcome.observed}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
// What the leaked document IS: an index in every respect but the one that makes
|
// What the leaked document IS: an index in every respect but the one that makes
|
||||||
// it usable. Alice found it in her own store — the only way anyone can, since
|
// it usable. Alice found it among the documents she holds -- the only way anyone
|
||||||
// `createIndex` threw its reference away.
|
// can, since `createIndex` threw its reference away.
|
||||||
const leaked = outcome.appeared[0];
|
const leaked = outcome.appeared[0];
|
||||||
if (leaked === undefined) {
|
if (leaked === undefined) {
|
||||||
check(
|
check(
|
||||||
@@ -757,8 +762,8 @@ async function main(): Promise<void> {
|
|||||||
// which is the state the question is about — one entry cannot tell a query that
|
// which is the state the question is about — one entry cannot tell a query that
|
||||||
// returns everything from one that returns the first thing it finds.
|
// returns everything from one that returns the first thing it finds.
|
||||||
//
|
//
|
||||||
// WHAT IS BEING ASKED. This package documents one way of reading an index
|
// WHAT IS BEING ASKED. This package documents how to read an index and issues no
|
||||||
// (`readUnion`) and issues no query of its own, so "an index is an ordinary document
|
// query of its own, so "an index is an ordinary document
|
||||||
// anyone queries normally" has never been anything but plausible. These four checks
|
// anyone queries normally" has never been anything but plausible. These four checks
|
||||||
// are a measurement of that sentence, not a feature: an empty answer is a RESULT and
|
// are a measurement of that sentence, not a feature: an empty answer is a RESULT and
|
||||||
// is reported as one, and a rejection is reported apart from it, because "the query
|
// is reported as one, and a rejection is reported apart from it, because "the query
|
||||||
@@ -784,7 +789,7 @@ async function main(): Promise<void> {
|
|||||||
PUBLISHED_AT,
|
PUBLISHED_AT,
|
||||||
);
|
);
|
||||||
check(
|
check(
|
||||||
"readUnion returns both entries and the index's own declaration",
|
"reading the document returns both entries and the index's own declaration",
|
||||||
held.size === 2 && declares,
|
held.size === 2 && declares,
|
||||||
`entries=${JSON.stringify([...held.keys()])} declares=${declares}`,
|
`entries=${JSON.stringify([...held.keys()])} declares=${declares}`,
|
||||||
);
|
);
|
||||||
@@ -821,7 +826,7 @@ async function main(): Promise<void> {
|
|||||||
);
|
);
|
||||||
|
|
||||||
// The reader who matters: an index exists to be read by people who own neither it
|
// The reader who matters: an index exists to be read by people who own neither it
|
||||||
// nor anything in it. `readUnion` already answers him (the journey above); whether
|
// nor anything in it. Reading the whole document already answers him (the journey above); whether
|
||||||
// a query does is a separate question, and it is the one an application asks.
|
// a query does is a separate question, and it is the one an application asks.
|
||||||
const theirs = await step("Bob querying the index he does not own", BRIDGE_MS, () =>
|
const theirs = await step("Bob querying the index he does not own", BRIDGE_MS, () =>
|
||||||
bob!.frame.evaluate(
|
bob!.frame.evaluate(
|
||||||
|
|||||||
+3
-2
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ng-helpers/indexing",
|
"name": "@ng-helpers/indexing",
|
||||||
"version": "4.0.0",
|
"version": "4.0.1",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "An indexing helper built on top of NextGraph, via @ng-eventually/polyfill. An index is an ordinary public document; anyone may hand it a reference to an object, and that reference becomes an entry through the layer below — this package hides that an index is implemented by an inbox.",
|
"description": "An indexing helper built on top of NextGraph, via @ng-eventually/polyfill. An index is an ordinary public document; anyone may hand it a reference to an object, and that reference becomes an entry through the layer below — this package hides that an index is implemented by an inbox.",
|
||||||
@@ -14,7 +14,8 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@ng-eventually/polyfill": "link:../ng-eventually-js/packages/polyfill",
|
"@ng-eventually/polyfill": "link:../ng-eventually-js/packages/polyfill",
|
||||||
"@ng-org/web": "0.1.2-alpha.13",
|
"@ng-org/orm": "0.1.2-alpha.21",
|
||||||
|
"@ng-org/web": "0.1.2-alpha.14",
|
||||||
"@types/bun": "latest",
|
"@types/bun": "latest",
|
||||||
"ng-e2e-helpers": "link:../ng-eventually-js/packages/ng-e2e-helpers",
|
"ng-e2e-helpers": "link:../ng-eventually-js/packages/ng-e2e-helpers",
|
||||||
"playwright": "1.61.1",
|
"playwright": "1.61.1",
|
||||||
|
|||||||
Generated
+49
-5
@@ -11,9 +11,12 @@ importers:
|
|||||||
'@ng-eventually/polyfill':
|
'@ng-eventually/polyfill':
|
||||||
specifier: link:../ng-eventually-js/packages/polyfill
|
specifier: link:../ng-eventually-js/packages/polyfill
|
||||||
version: link:../ng-eventually-js/packages/polyfill
|
version: link:../ng-eventually-js/packages/polyfill
|
||||||
|
'@ng-org/orm':
|
||||||
|
specifier: 0.1.2-alpha.21
|
||||||
|
version: 0.1.2-alpha.21
|
||||||
'@ng-org/web':
|
'@ng-org/web':
|
||||||
specifier: 0.1.2-alpha.13
|
specifier: 0.1.2-alpha.14
|
||||||
version: 0.1.2-alpha.13
|
version: 0.1.2-alpha.14
|
||||||
'@types/bun':
|
'@types/bun':
|
||||||
specifier: latest
|
specifier: latest
|
||||||
version: 1.3.14
|
version: 1.3.14
|
||||||
@@ -29,8 +32,36 @@ importers:
|
|||||||
|
|
||||||
packages:
|
packages:
|
||||||
|
|
||||||
'@ng-org/web@0.1.2-alpha.13':
|
'@ng-org/alien-deepsignals@0.1.2-alpha.13':
|
||||||
resolution: {integrity: sha512-/xO0c+3NTphnws5Do2LDqgZWmAf+aNnYdChJKdU0dnp1U1iVSgi/y3yb8AYryf0v9sooj0aYJxt08B6DpirFMQ==}
|
resolution: {integrity: sha512-yOEh/J+9IrCo8WDXTdZLxRcO9IHAczrUA4pjSD4BaZzmWhnCFE/amy/0PsAdh/yePurBrtQj3tG/y+hReM15Ew==}
|
||||||
|
peerDependencies:
|
||||||
|
react: ^19.0.0 || ^18.0.0
|
||||||
|
svelte: ^5.0.0 || ^4.0.0
|
||||||
|
vue: ^3.0.0
|
||||||
|
peerDependenciesMeta:
|
||||||
|
react:
|
||||||
|
optional: true
|
||||||
|
svelte:
|
||||||
|
optional: true
|
||||||
|
vue:
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
'@ng-org/orm@0.1.2-alpha.21':
|
||||||
|
resolution: {integrity: sha512-+Dtt9jEa+277wonExxqC1BHqVwvWhXeXM51zcGg2w+Mc6C1F74qaXMGYZT3CcWCQISGEMOWV3n2movP3yQ8xJA==}
|
||||||
|
peerDependencies:
|
||||||
|
react: ^19.0.0 || ^18.0.0
|
||||||
|
svelte: ^5.0.0 || ^4.0.0
|
||||||
|
vue: ^3.0.0
|
||||||
|
peerDependenciesMeta:
|
||||||
|
react:
|
||||||
|
optional: true
|
||||||
|
svelte:
|
||||||
|
optional: true
|
||||||
|
vue:
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
'@ng-org/web@0.1.2-alpha.14':
|
||||||
|
resolution: {integrity: sha512-FPQ7kyngMhAXK/WJtZ6pkoEJwGcau6GaBH2nhjjYorMq7OG//I+zwghat90FsIeMrfYsps0+5Y0UrRqfxNdUXA==}
|
||||||
|
|
||||||
'@types/bun@1.3.14':
|
'@types/bun@1.3.14':
|
||||||
resolution: {integrity: sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw==}
|
resolution: {integrity: sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw==}
|
||||||
@@ -38,6 +69,9 @@ packages:
|
|||||||
'@types/node@26.2.0':
|
'@types/node@26.2.0':
|
||||||
resolution: {integrity: sha512-5IviulTZeRNp2vAJ514cc/HUlY5nZ9fCbq9DMyC52BrhFZACo3nI0R7qBxhQmo/d27NFe96ur/b7Wwxklda+kg==}
|
resolution: {integrity: sha512-5IviulTZeRNp2vAJ514cc/HUlY5nZ9fCbq9DMyC52BrhFZACo3nI0R7qBxhQmo/d27NFe96ur/b7Wwxklda+kg==}
|
||||||
|
|
||||||
|
alien-signals@2.0.8:
|
||||||
|
resolution: {integrity: sha512-844G1VLkk0Pe2SJjY0J8vp8ADI73IM4KliNu2OGlYzWpO28NexEUvjHTcFjFX3VXoiUtwTbHxLNI9ImkcoBqzA==}
|
||||||
|
|
||||||
async-proxy@0.4.1:
|
async-proxy@0.4.1:
|
||||||
resolution: {integrity: sha512-4e+zNtoGL4+cnqib8v169CnKcRfAsAubp2EsjBhAA5jyW7jjI3t36rVvuqLwmhtliwf8JvSnxinE4ecQN+DK4w==}
|
resolution: {integrity: sha512-4e+zNtoGL4+cnqib8v169CnKcRfAsAubp2EsjBhAA5jyW7jjI3t36rVvuqLwmhtliwf8JvSnxinE4ecQN+DK4w==}
|
||||||
|
|
||||||
@@ -72,7 +106,15 @@ packages:
|
|||||||
|
|
||||||
snapshots:
|
snapshots:
|
||||||
|
|
||||||
'@ng-org/web@0.1.2-alpha.13':
|
'@ng-org/alien-deepsignals@0.1.2-alpha.13':
|
||||||
|
dependencies:
|
||||||
|
alien-signals: 2.0.8
|
||||||
|
|
||||||
|
'@ng-org/orm@0.1.2-alpha.21':
|
||||||
|
dependencies:
|
||||||
|
'@ng-org/alien-deepsignals': 0.1.2-alpha.13
|
||||||
|
|
||||||
|
'@ng-org/web@0.1.2-alpha.14':
|
||||||
dependencies:
|
dependencies:
|
||||||
async-proxy: 0.4.1
|
async-proxy: 0.4.1
|
||||||
|
|
||||||
@@ -84,6 +126,8 @@ snapshots:
|
|||||||
dependencies:
|
dependencies:
|
||||||
undici-types: 8.3.0
|
undici-types: 8.3.0
|
||||||
|
|
||||||
|
alien-signals@2.0.8: {}
|
||||||
|
|
||||||
async-proxy@0.4.1:
|
async-proxy@0.4.1:
|
||||||
dependencies:
|
dependencies:
|
||||||
object-path-operator: 3.0.0
|
object-path-operator: 3.0.0
|
||||||
|
|||||||
+2
-3
@@ -15,9 +15,8 @@
|
|||||||
* A helper that hides that an index is implemented by an inbox — two acts, and the
|
* A helper that hides that an index is implemented by an inbox — two acts, and the
|
||||||
* addresses stay out of sight. It does not make an entry of what an index receives,
|
* addresses stay out of sight. It does not make an entry of what an index receives,
|
||||||
* and it does not read: an index is an ordinary document, so whoever holds its NURI
|
* and it does not read: an index is an ordinary document, so whoever holds its NURI
|
||||||
* queries it with the very calls any other document takes — `readUnion([index])`, or
|
* queries it with the very call any other document takes — a SPARQL `SELECT`
|
||||||
* a SPARQL `SELECT` anchored on it — using the two IRIs below to recognise what it
|
* anchored on it — using the two IRIs below to recognise what it finds. A helper of ours would only teach a shape that has to be unlearned.
|
||||||
* finds. A helper of ours would only teach a shape that has to be unlearned.
|
|
||||||
*
|
*
|
||||||
* ## Everything published is below, and this file wires nothing
|
* ## Everything published is below, and this file wires nothing
|
||||||
*
|
*
|
||||||
|
|||||||
+1
-1
@@ -11,7 +11,7 @@ import { INDEX_FIELD } from "./vocabulary";
|
|||||||
*
|
*
|
||||||
* TWO acts, and no third. What becomes of what is added is not one of them, and
|
* TWO acts, and no third. What becomes of what is added is not one of them, and
|
||||||
* neither is reading: an index is an ordinary document, so its contents come back
|
* neither is reading: an index is an ordinary document, so its contents come back
|
||||||
* through `readUnion` or a SPARQL `SELECT`, recognised by the two published IRIs.
|
* through a SPARQL `SELECT` anchored on it, recognised by the two published IRIs.
|
||||||
*/
|
*/
|
||||||
export interface Indexing {
|
export interface Indexing {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -38,7 +38,12 @@ export function polyfillPort(options: PolyfillPortOptions): NextGraphPort {
|
|||||||
async createPublicDocument() {
|
async createPublicDocument() {
|
||||||
// An index lives in its creator's public store, so that any reader can open
|
// An index lives in its creator's public store, so that any reader can open
|
||||||
// it from the reference alone.
|
// it from the reference alone.
|
||||||
return storeRegistry.createEntityDoc("public");
|
//
|
||||||
|
// A store is named by its REFERENCE and not by a word: `publicStore()` hands
|
||||||
|
// back the one this identity has, and `createEntityDoc` takes it. Omitting the
|
||||||
|
// argument would place the document in the PRIVATE store, where no reader could
|
||||||
|
// open it -- so this call names the store every time, and never by omission.
|
||||||
|
return storeRegistry.createEntityDoc(await storeRegistry.publicStore());
|
||||||
},
|
},
|
||||||
|
|
||||||
async addLiteralProperty(
|
async addLiteralProperty(
|
||||||
|
|||||||
+2
-1
@@ -26,7 +26,8 @@ export type { Nuri, NuriLike };
|
|||||||
export interface NextGraphPort {
|
export interface NextGraphPort {
|
||||||
/**
|
/**
|
||||||
* A new document in this identity's PUBLIC store, owned by this identity.
|
* A new document in this identity's PUBLIC store, owned by this identity.
|
||||||
* Backs onto `storeRegistry.createEntityDoc("public")`.
|
* Backs onto `storeRegistry.createEntityDoc(await storeRegistry.publicStore())`
|
||||||
|
* -- a store is named by its reference, and omitting it would mean the private one.
|
||||||
*/
|
*/
|
||||||
createPublicDocument(): Promise<Nuri>;
|
createPublicDocument(): Promise<Nuri>;
|
||||||
|
|
||||||
|
|||||||
+5
-4
@@ -2,10 +2,11 @@
|
|||||||
* The IRIs an index document is written with — published because a reader needs
|
* The IRIs an index document is written with — published because a reader needs
|
||||||
* them to make sense of one.
|
* them to make sense of one.
|
||||||
*
|
*
|
||||||
* `urn:ng-eventually:` is RESERVED by the polyfill — triples whose subject falls
|
* `urn:ng-eventually:` is RESERVED by the polyfill — it writes its own registers
|
||||||
* under it are dropped on read. This layer stays out of it entirely and uses its
|
* under subjects carrying that prefix, in the same graph, and a reader ignores them.
|
||||||
* own `urn:ng-helpers:` namespace, for PREDICATES only. Subjects in an index
|
* This layer stays out of it entirely and uses its own `urn:ng-helpers:` namespace,
|
||||||
* document are always `did:ng:` NURIs, so nothing here is ever filtered away.
|
* for PREDICATES only. Subjects this layer writes are always `did:ng:` NURIs, so
|
||||||
|
* nothing of it can be mistaken for the polyfill's.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -146,6 +146,21 @@ test("creating an index writes its field declaration, and nothing else", async (
|
|||||||
expect(world.contentsOf(ordinary)).toEqual([]);
|
expect(world.contentsOf(ordinary)).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("an index is recorded in its creator's PUBLIC store, named by that store's reference", async () => {
|
||||||
|
const index = await as("alice", async (alice) => indexingOn(alice).create(FIELD));
|
||||||
|
|
||||||
|
// WHERE it landed, read off the fake rather than inferred from the call: an index a
|
||||||
|
// stranger cannot open is not an index, and the private store is one keystroke away
|
||||||
|
// (omitting the argument places it there).
|
||||||
|
expect(world.storeOf(index)).toBe(world.storesOf("alice").public);
|
||||||
|
|
||||||
|
// And HOW the store was named: the reference the accessor handed back, not a word.
|
||||||
|
// A store is told apart from every other reference only by being one of the three,
|
||||||
|
// so the accessor is the only thing that can produce it.
|
||||||
|
const placed = world.calls.filter((call) => call.entry === "storeRegistry.createEntityDoc").at(-1);
|
||||||
|
expect(placed?.args).toEqual([world.storesOf("alice").public]);
|
||||||
|
});
|
||||||
|
|
||||||
test("the write is the polyfill's canonical anchored form: the document named once, as the anchor", async () => {
|
test("the write is the polyfill's canonical anchored form: the document named once, as the anchor", async () => {
|
||||||
const index = await as("alice", async (alice) => indexingOn(alice).create(FIELD));
|
const index = await as("alice", async (alice) => indexingOn(alice).create(FIELD));
|
||||||
const writes = world.calls.filter((call) => call.entry === "docs.sparqlUpdate");
|
const writes = world.calls.filter((call) => call.entry === "docs.sparqlUpdate");
|
||||||
|
|||||||
+125
-6
@@ -27,9 +27,17 @@ import type { Nuri } from "../src/port";
|
|||||||
* (`"DEL" + "ETE …"`) is one string by the time it arrives, so the split buys
|
* (`"DEL" + "ETE …"`) is one string by the time it arrives, so the split buys
|
||||||
* nothing.
|
* nothing.
|
||||||
*
|
*
|
||||||
* ## Every rule below is one the polyfill actually enforces
|
* ## Every rule below is one `contract_polyfill-surface` states
|
||||||
*
|
*
|
||||||
* - only a document's owner writes to it (`docs.sparqlUpdate`'s `assertMayWrite`);
|
* - a store is named by its REFERENCE and by nothing else: `privateStore()`,
|
||||||
|
* `protectedStore()` and `publicStore()` hand one out, `createEntityDoc(store?)`
|
||||||
|
* takes one, and every entry "accepts `NuriLike` and validates at the door" -- so
|
||||||
|
* a word where a reference belongs is refused rather than understood;
|
||||||
|
* - omitting the store places the document in the PRIVATE store;
|
||||||
|
* - "you read a document whose key you hold: you created it, it was shared with you,
|
||||||
|
* or it sits in a public store, which serves its read key to whoever asks" -- so a
|
||||||
|
* stranger reaches a document in its owner's public store, and no other;
|
||||||
|
* - only a document's owner writes to it, and holding a read key never grants a write;
|
||||||
* - anyone may DEPOSIT into a document's inbox (`inbox.postToDocument`);
|
* - anyone may DEPOSIT into a document's inbox (`inbox.postToDocument`);
|
||||||
* - depositing into a document whose owner never opened an inbox THROWS, rather
|
* - depositing into a document whose owner never opened an inbox THROWS, rather
|
||||||
* than going nowhere;
|
* than going nowhere;
|
||||||
@@ -37,6 +45,14 @@ import type { Nuri } from "../src/port";
|
|||||||
* (`openDocumentInbox`: doing so publishes the document's address);
|
* (`openDocumentInbox`: doing so publishes the document's address);
|
||||||
* - a document with no inbox has no address to read — a state, not an error.
|
* - a document with no inbox has no address to read — a state, not an error.
|
||||||
*
|
*
|
||||||
|
* ## The three withdrawn placement entries are modelled by their ABSENCE
|
||||||
|
*
|
||||||
|
* `listMyEntityDocs`, `resolveScopeGraph` and `resolveWriteGraph` left the engagement.
|
||||||
|
* Nothing here answers for them, so reaching for one throws by name (see
|
||||||
|
* {@link namespace}) -- which is the only thing a fake can honestly say about a call
|
||||||
|
* that no longer exists. The same holds for `useShapeQuery`: this package reads
|
||||||
|
* nothing, and the end-to-end application is where that read is exercised.
|
||||||
|
*
|
||||||
* ## What is NOT modelled, and what happens then
|
* ## What is NOT modelled, and what happens then
|
||||||
*
|
*
|
||||||
* Anything the adapter reaches for on `docs`, `inbox` or `storeRegistry` that is
|
* Anything the adapter reaches for on `docs`, `inbox` or `storeRegistry` that is
|
||||||
@@ -241,6 +257,8 @@ export interface RecordedCall {
|
|||||||
interface StoredDocument {
|
interface StoredDocument {
|
||||||
readonly nuri: Nuri;
|
readonly nuri: Nuri;
|
||||||
readonly owner: string;
|
readonly owner: string;
|
||||||
|
/** The store it was recorded in -- a REFERENCE, which is the only name a store has. */
|
||||||
|
readonly store: Nuri;
|
||||||
readonly subjects: Map<string, Map<string, string[]>>;
|
readonly subjects: Map<string, Map<string, string[]>>;
|
||||||
/** `undefined` until the owner opens one — the state `postToDocument` refuses. */
|
/** `undefined` until the owner opens one — the state `postToDocument` refuses. */
|
||||||
deposits: Deposit[] | undefined;
|
deposits: Deposit[] | undefined;
|
||||||
@@ -255,6 +273,15 @@ export interface FakePolyfill {
|
|||||||
sessionId(): string;
|
sessionId(): string;
|
||||||
/** Every triple in a document, read from outside the adapter. */
|
/** Every triple in a document, read from outside the adapter. */
|
||||||
contentsOf(doc: string): { subject: string; predicate: string; values: string[] }[];
|
contentsOf(doc: string): { subject: string; predicate: string; values: string[] }[];
|
||||||
|
/**
|
||||||
|
* The store a document was recorded in, as the reference the accessors hand out.
|
||||||
|
* An INSPECTION: placement is not something this package can read back, and the
|
||||||
|
* point of holding it is that a document placed in the wrong store is visible here
|
||||||
|
* rather than only in a broker's refusal.
|
||||||
|
*/
|
||||||
|
storeOf(doc: string): Nuri;
|
||||||
|
/** The three stores of an identity, as `privateStore()` and its two siblings answer. */
|
||||||
|
storesOf(user: string): { private: Nuri; protected: Nuri; public: Nuri };
|
||||||
/**
|
/**
|
||||||
* What is waiting in a document's inbox, oldest first — or `null` when its owner
|
* What is waiting in a document's inbox, oldest first — or `null` when its owner
|
||||||
* never opened one. An INSPECTION, not an entry of the polyfill: this package
|
* never opened one. An INSPECTION, not an entry of the polyfill: this package
|
||||||
@@ -270,6 +297,7 @@ export interface FakePolyfill {
|
|||||||
*/
|
*/
|
||||||
export function installFakePolyfill(): FakePolyfill {
|
export function installFakePolyfill(): FakePolyfill {
|
||||||
const documents = new Map<string, StoredDocument>();
|
const documents = new Map<string, StoredDocument>();
|
||||||
|
const stores = new Map<string, { private: Nuri; protected: Nuri; public: Nuri }>();
|
||||||
const calls: RecordedCall[] = [];
|
const calls: RecordedCall[] = [];
|
||||||
let currentUser = "nobody";
|
let currentUser = "nobody";
|
||||||
let documentCount = 0;
|
let documentCount = 0;
|
||||||
@@ -339,6 +367,16 @@ export function installFakePolyfill(): FakePolyfill {
|
|||||||
const inboxImpl = {
|
const inboxImpl = {
|
||||||
async postToDocument(doc: unknown, options: unknown): Promise<void> {
|
async postToDocument(doc: unknown, options: unknown): Promise<void> {
|
||||||
const stored = require(String(doc));
|
const stored = require(String(doc));
|
||||||
|
if (!mayRead(currentUser, stored)) {
|
||||||
|
// Reaching a document's owner goes THROUGH the document, so a depositor that
|
||||||
|
// cannot open it has no way in. This is what makes the public store a
|
||||||
|
// load-bearing choice of `create` rather than a decoration: place an index
|
||||||
|
// anywhere else and no stranger can hand it anything.
|
||||||
|
throw new Error(
|
||||||
|
`[ng-eventually] inbox.postToDocument: you cannot read the document ` +
|
||||||
|
`${JSON.stringify(doc)}, so you cannot reach its inbox`,
|
||||||
|
);
|
||||||
|
}
|
||||||
if (stored.deposits === undefined) {
|
if (stored.deposits === undefined) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`[ng-eventually] inbox.postToDocument: this document has no inbox — either its ` +
|
`[ng-eventually] inbox.postToDocument: this document has no inbox — either its ` +
|
||||||
@@ -354,14 +392,89 @@ export function installFakePolyfill(): FakePolyfill {
|
|||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The three stores an identity has, minted on first ask and stable afterwards.
|
||||||
|
*
|
||||||
|
* There is no identity parameter on any of the accessors -- a session is one user's
|
||||||
|
* -- so these are keyed by whoever is signed in, exactly as the engagement has it.
|
||||||
|
* A store is a REFERENCE: it carries no key, and it is told from every other
|
||||||
|
* reference only by being one of the three.
|
||||||
|
*/
|
||||||
|
function storesOf(user: string): { private: Nuri; protected: Nuri; public: Nuri } {
|
||||||
|
const known = stores.get(user);
|
||||||
|
if (known !== undefined) return known;
|
||||||
|
const minted = {
|
||||||
|
private: `did:ng:o:store-private-${user}` as Nuri,
|
||||||
|
protected: `did:ng:o:store-protected-${user}` as Nuri,
|
||||||
|
public: `did:ng:o:store-public-${user}` as Nuri,
|
||||||
|
};
|
||||||
|
stores.set(user, minted);
|
||||||
|
return minted;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether this identity holds a key that opens the document.
|
||||||
|
*
|
||||||
|
* Its creator does; so does anyone at all when it sits in a PUBLIC store, which
|
||||||
|
* serves its read key to whoever asks. Nothing else here shares a key, because
|
||||||
|
* nothing here calls `inbox.share`.
|
||||||
|
*/
|
||||||
|
function mayRead(user: string, stored: StoredDocument): boolean {
|
||||||
|
return stored.owner === user || stored.store === storesOf(stored.owner).public;
|
||||||
|
}
|
||||||
|
|
||||||
const storeRegistryImpl = {
|
const storeRegistryImpl = {
|
||||||
async createEntityDoc(scope: unknown): Promise<Nuri> {
|
async privateStore(): Promise<Nuri> {
|
||||||
if (scope !== "public" && scope !== "mine") {
|
return storesOf(currentUser).private;
|
||||||
throw new Error(`[fake-polyfill] unknown scope ${JSON.stringify(scope)}`);
|
},
|
||||||
|
|
||||||
|
async protectedStore(): Promise<Nuri> {
|
||||||
|
return storesOf(currentUser).protected;
|
||||||
|
},
|
||||||
|
|
||||||
|
async publicStore(): Promise<Nuri> {
|
||||||
|
return storesOf(currentUser).public;
|
||||||
|
},
|
||||||
|
|
||||||
|
async createEntityDoc(store?: unknown): Promise<Nuri> {
|
||||||
|
const mine = storesOf(currentUser);
|
||||||
|
// Omitted means the PRIVATE store, as `doc_create` does when no store is given.
|
||||||
|
// It is a real placement and not a default to shrug at: a document that lands
|
||||||
|
// there is one no stranger can open.
|
||||||
|
let placement: Nuri;
|
||||||
|
if (store === undefined) {
|
||||||
|
placement = mine.private;
|
||||||
|
} else {
|
||||||
|
// Validated AT THE DOOR, which is what makes a word where a reference belongs
|
||||||
|
// a refusal rather than a silent placement. This is the exact shape that was
|
||||||
|
// green here for a whole version while the broker rejected it.
|
||||||
|
if (typeof store !== "string" || !store.startsWith("did:ng:")) {
|
||||||
|
throw new Error(
|
||||||
|
"[fake-polyfill] storeRegistry.createEntityDoc: not a NextGraph reference " +
|
||||||
|
"-- a store is named by the reference privateStore(), protectedStore() " +
|
||||||
|
`or publicStore() hands back, got ${JSON.stringify(store)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const named = [mine.private, mine.protected, mine.public].find((s) => s === store);
|
||||||
|
if (named === undefined) {
|
||||||
|
// "A rejection means unknown, never absent": a store this identity does not
|
||||||
|
// have is a document that could not be recorded, so the call throws.
|
||||||
|
throw new Error(
|
||||||
|
`[fake-polyfill] storeRegistry.createEntityDoc: ${store} is not one of this ` +
|
||||||
|
`identity's stores, so the document could not be recorded in it`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
placement = named;
|
||||||
}
|
}
|
||||||
documentCount += 1;
|
documentCount += 1;
|
||||||
const nuri = `did:ng:o:doc-${documentCount}` as Nuri;
|
const nuri = `did:ng:o:doc-${documentCount}` as Nuri;
|
||||||
documents.set(nuri, { nuri, owner: currentUser, subjects: new Map(), deposits: undefined });
|
documents.set(nuri, {
|
||||||
|
nuri,
|
||||||
|
owner: currentUser,
|
||||||
|
store: placement,
|
||||||
|
subjects: new Map(),
|
||||||
|
deposits: undefined,
|
||||||
|
});
|
||||||
return nuri;
|
return nuri;
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -440,6 +553,12 @@ export function installFakePolyfill(): FakePolyfill {
|
|||||||
if (stored.deposits === undefined) return null;
|
if (stored.deposits === undefined) return null;
|
||||||
return [...stored.deposits].sort((a, b) => a.ts - b.ts);
|
return [...stored.deposits].sort((a, b) => a.ts - b.ts);
|
||||||
},
|
},
|
||||||
|
storeOf(doc: string) {
|
||||||
|
return require(doc).store;
|
||||||
|
},
|
||||||
|
storesOf(user: string) {
|
||||||
|
return storesOf(user);
|
||||||
|
},
|
||||||
contentsOf(doc: string) {
|
contentsOf(doc: string) {
|
||||||
const stored = require(doc);
|
const stored = require(doc);
|
||||||
const out: { subject: string; predicate: string; values: string[] }[] = [];
|
const out: { subject: string; predicate: string; values: string[] }[] = [];
|
||||||
|
|||||||
Reference in New Issue
Block a user