Eve library

@oshun/workbench-kit API reference

Evidence

Revision 1

On this page

Generated from the contracts, never written beside them. A hand-written reference for a package with eighteen entry points is wrong within a week and nobody finds out, because the only reader who would notice already knew the answer.

Generated by node scripts/v1-workbenches/generate-workbench-kit-api-reference.mjs. Do not edit by hand.

Pages#

Page Ledger Owns Symbols
Immutable activity-feed events S8.9 activity-feed 112
Approval workflows S8.1 approval-workflows 41
Assignments S8.5 assignments 143
Capability S1.6 / S1.7 capability-state, registry 72
Container inventory and card use S7.22.a card-use 61
The chrome audit S7.22.d chrome 30
Collaborator presence S8.6 collaborator-presence 101
Command and query S1.5 view over envelopes 5
Anchored comment threads S8.2 comment-threads 64
Composition and flattening S7.22.b composition 53
Concurrency, history and semantic diff S2.3 / S2.4 / S2.5 / S2.6 / S2.8 / S2.12 concurrency, diff, restore, revisions, scores, staleness 260
Error S1.9 / S1.10 errors 52
Event and job S1.5 view over envelopes 6
The first screen of a working surface S7.22.c first-screen 44
Identity S1.4 / S1.13.d identity, synthetic 97
Invariants ADR-S2 / S0.7.g invariants 13
Lifecycle and deprecation S1.12 deprecation 42
Mentions S8.4 mentions 107
Digest coalescing and deduplication S8.8 notification-digests 77
Notification routing S8.7 notification-routing 116
Plugin and stage machine S1.9 / S2.1 / S2.2 / S2.7 / S2.9 / S2.10 / S2.11 / S2.13 / S2.14 / S3.2 / S3.3 / S3.4 / S3.5 / S3.6 / S3.7 / S3.8 / S3.9 / S3.10 / S3.11 / S3.12 audit, blobs, decisions, deletion, gate-definitions, gate-runs, gate-waivers, guards, idempotency, inbox, indexes, job-graphs, jobs, outbox, plugins, probes, protection, quarantine, reclamation, signoff, stages, tenancy 1210
Protected sources, learner records, biometrics, and unreleased assets S8.12 redaction 105
Review inbox and saved queues S8.10 review-inbox 170
Reviewer handoff and temporary delegation S8.11 reviewer-handoff 112
Route S1.8 routes 42
Schema and envelope S1.5 envelopes 43
The token and contrast audit S7.22.e signals 67
Suggestions S8.3 suggestions 67
Version negotiation S1.11 negotiation 28
The hierarchy review S7.22.f working-surface 53

How this is generated#

  • Sources. Only EXPORTED declarations of the production modules under libs/oshun/workbench-kit/src/. Every production module is owned by exactly one page, so a symbol nobody documents fails the gate.
  • Excluded. Non-exported declarations (a private helper in a reference is an invitation to depend on it), every module under src/testing/ (11 of them), unratified capability subpaths (91 S0.12 rows are still pending, so no capability page exists yet), and anything credential-shaped — five leak classes are scanned for and named in the generator.
  • Cross-cutting sections. Authorization, idempotency, pagination, state, compatibility and deprecation are DERIVED by matching declared field and symbol names against a named vocabulary. A section that matches nothing says so rather than being omitted. The rule is mechanical on purpose: the alternative is a paragraph somebody wrote once.
  • Examples. Drawn from the committed fixture corpora, split into accepted and refused by one uniform rule. A page shows at most 3 of each and states the full count, so a truncated view never reads as complete coverage.
  • Determinism. Symbols sorted, examples serialized with a stable stringifier, and every page formatted through the repository's own Prettier 3.8.3 with TypeScript 6.0.3. Two runs are byte-identical; a formatter upgrade shows up as drift, which is correct — the formatter is part of the output contract.