Sylvain Duchesne
63ecfeeff8
Align the polyfill's surface and docs with the verified NextGraph reality and
remove application-level concepts:
- Identity is an ID, not a username: AccountRecord.id, shim predicate shim:id,
normalizeId; accounts core becomes IdentityStore (set/clear/get) — the faux
login/logout framing is gone (identity is set at wallet-import time).
- Relationship/connection is an application concept, not a platform primitive
(NextGraph has no bilateral-connection primitive: grantee is unpersisted
scaffolding, cap-send is unimplemented). Remove connections.ts; caps exposes
only a directed grantRead(doc, granteeId) + a read-only protectedDocsOf(owner).
Delete the now-dead isolation.ts social-visibility axis.
- Inbox docs: NextGraph has no separate curator — the recipient's own verifier
unseals and applies each queued sealed message inline (process_inbox);
inbox_post_link is a proposed/future API. Stop attributing the emulated
curator to the platform.
- Read isolation reframed around the outcome: no cap -> empty union read;
targeted read of an unheld repo -> RepoNotFound; cap introspection
(canRead/governsRead) is emulation-only with no NextGraph API behind it.
- read-model.md corrected: the listing path is per-doc ANCHORED default-graph
queries, never the anchorless GRAPH ?g union (that is O(wallet)); the probe
section no longer claims the opposite.
- README recap table restructured (target | current NextGraph status | current
emulation); INDEX_ACCOUNT documented as reservedAccount("index") in the
sentinel namespace; de-domained generic-layer comments; softened tone.
Consumer application (Festipod) rewired separately to own the relationship
concept and feed the lib an id. Lib gates: bun test 83 pass / 0 fail, tsc clean.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
# @ng-eventually/client
|
|
|
|
Two entry points — the data-plane is SDK-identical, the polyfill bootstrap is
|
|
separate:
|
|
|
|
| Import | Surface |
|
|
|---|---|
|
|
| `@ng-eventually/client` | The same signature as the SDK — `ng`, `useShape`, `inbox` (+ types). A drop-in for `@ng-org/web` / `@ng-org/orm`; as NextGraph matures it resolves to the real SDK (build alias removed) with no code change. |
|
|
| `@ng-eventually/client/polyfill` | The only non-SDK surface — `configure`, `setCurrentUser`, and capability helpers (`getCaps`, `grantRead`, `canRead`/`canWrite`). It falls away as NextGraph matures. |
|
|
|
|
```ts
|
|
// bootstrap (the only non-SDK call) — inject the real SDK
|
|
import { configure } from "@ng-eventually/client/polyfill";
|
|
configure({ ng: realNg, useShape: realUseShape, sharedWallet, currentUser });
|
|
|
|
// from here on, a pure SDK surface:
|
|
import { ng, useShape, inbox } from "@ng-eventually/client";
|
|
await ng.doc_create(/* … */);
|
|
const set = useShape(MyShape, scope); // filtered to what the identity may read
|
|
await inbox.post(targetInbox, ref); // deposit (anticipated SDK API)
|
|
```
|
|
|
|
What the polyfill adds on top of the real SDK (each emulated for now, native as
|
|
NextGraph matures):
|
|
- Shared-wallet identity (one wallet for everyone; the current identity id is
|
|
relayed to the SDK).
|
|
- Capability enforcement — a read filter + write guard over emulated grants
|
|
attached to documents; the app declares a document's read policy and issues
|
|
directed read grants.
|
|
- Anticipated methods (inbox `post`, capability ops) with their future-SDK shapes,
|
|
emulated for now.
|
|
|
|
Generic: no application domain. The consumer application injects its shapes and
|
|
performs the acts of granting access. The relationship concept ("who is connected
|
|
to whom") is the consumer application's own — the client exposes only directed
|
|
per-document read grants.
|