API reference
API reference
Everything a workspace can import from @norbital-ai/bolt, @norbital-ai/ui and @norbital-ai/std, generated from the source at the pinned release: signatures, parameters and props, examples, and a link to each definition. The guides explain how the pieces fit; this is the exact surface.
Namespaces
@norbital-ai/bolt251 symbols — @norbital-ai/bolt: the declaration functions and their types. Nothing else is a runtime value (P29).@norbital-ai/bolt/page16 symbols — @norbital-ai/bolt/page (§3.3.10, §3.5, D9): the booted shell client, the ui edge it runs on, and optional host device. $bolt is its generated alias (.norbital/bolt.d.ts for types; the client build resolves the module itself), exporting bolt, run, fork, query, live, attach.@norbital-ai/bolt/test23 symbols — Public test edge: one scoped workspace layer and Effect-native callers.@norbital-ai/std/billing45 symbols — repository-health:allow SEM_PARALLEL -- index is the barrel over rate-card and schemas; the public surface, not a second implementation.@norbital-ai/std/calendar6 symbols — std/calendar (§3.7, §5.4): pay and billing cycles (a cycle is named by the day it OPENS), working days and business-hour deadlines (SLAs) over a work week and holiday rows.@norbital-ai/std/csv1 symbols — RFC 4180 CSV: quoted fields, doubled quotes, CRLF, LF or CR rows; a trailing newline adds no row.@norbital-ai/std/date20 symbols — std/date (§3.7, rule 68, X-11): a date is a zone-free calendar day, an instant is UTC, and a date period is inclusive { from, to | null } (null = open). Values are branded strings, so they are their own wire form.@norbital-ai/std/decimal8 symbols — std/decimal (§3.7, rule 68): exact decimals. A value is a bigint coefficient and a scale, so no amount ever passes through a float; Decimal.fromNumber is the one explicit door from a double. valueOf throws, so a + b on two decimals fails loudly instead of concatenating strings (> on Decimal is doctor DR-1).@norbital-ai/std/facts3 symbols — std/facts (§3.7): runtime-declared fields. An administrator declares the keys a record may carry (a jurisdiction's statutory facts, an intake form's questions) as rows; the record stores the values in one json field, and the collection's transform validates them with validateFacts. facts checks the declarations themselves.@norbital-ai/std/formula6 symbols — std/formula (§3.7, D21, M1): user-edited rules as CEL text, compiled against a context declared with field-kind literals (object roots included) and evaluated over plain values. The numeric mode belongs to the context: 'decimal' (default) evaluates money and decimals exactly as Decimal, 'float' in doubles (hr's law, D21). Registered functions keep today's registerFunction signatures, so hr's law seed (.age_on(, .birthday() runs unchanged; object roots are map<string, dyn> for them, and their member paths are checked here instead.@norbital-ai/std/host-op7 symbols — std/host-op (§7.1 "Operations"): the one signed-host-operation scheme for hosts and their operator CLIs. A MAC (HMAC-SHA256, base64url) over the newline-joined v1 · scope · host · op · ts · nonce · sha256(body), carried in the bolt-op-* headers. A request older or newer than five minutes, one for another scope, host or operation, a bad MAC and a replayed nonce are refused before the body is read as an operation. Nonces are durable: the host's NonceStore.@norbital-ai/std/json2 symbols — std/json (§3.7, L-BOLT-956).@norbital-ai/std/kind18 symbols — std/kind (D7): the one field-kind table. The kind literal a model, an input or a shape declares (structurally, so ui and std need no bolt dependency), its traits, and its Schema: inputSchema(spec) is the one validator of input and stored values (callables, write flatten, IR literals, configuration, feed rows, AI output kinds). A decoded value is JSON with std's Decimal for decimals; its encoding is the wire's (std/wire): { $dec }, ISO dates and instants.@norbital-ai/std/label1 symbols — std/label (§3.7): a record's title from its model's label paths. Each path's value is shown per kind (show, the ui's formatter where one is at hand; else a locale-free default for dates, instants, decimals and relations), empty terms are dropped and the rest joined with ' · '. Never a uuid and never a JSON blob: a record that cannot name itself is null, and the caller shows its own placeholder.@norbital-ai/std/pricing3 symbols — std/pricing (§3.7, M2): catalogue lines → bands → formula → bucket → line. A catalogue line carries ordered bands of formula text; a band that holds (when) takes a slice of the quantity (take, default all that is left) and prices it (price, reading the slice as the root quantity); each priced slice is one line in the catalogue line's bucket. Payroll overtime bands, allowance families, CRM price breaks and commissions are all this shape.@norbital-ai/std/sheet6 symbols — std/sheet (§3.7, §5.4, D15): the one Cell[][] ⇄ rows codec. The host reads file references through ctx.files.table (a string-cell table) or ctx.files.sheet (worksheets with typed cells); this module only maps cells to typed rows and back. The first row is the header; a header matches a column name, a date period is two columns <name>.from / <name>.to (inclusive, blank to = open), and an unknown header is an error.@norbital-ai/std/versioned5 symbols — std/versioned (§3.7, §6.3 "Versioned lineage", PH GAP-4): pure helpers over the rows of the lineage recipe (period, sealed_at, voided_at, void_reason, sealed-only noOverlap). A sealed version never changes except for a shortened period (its successor was sealed) or one void with a reason; a correction is a new draft built by cloneNext and sealed over the old version. The seal's write is held by the collection's update grant (§3.8).@norbital-ai/std/wire4 symbols — std/wire (D6): the one wire value codec. $dec is the only tag: a decimal is { $dec: '1.20' } in both directions (Decimal.toJSON emits it); dates and instants are their ISO strings, which std's branded PlainDate/Instant already are. SQL encoding, the guest prelude (which evaluates reviveWire from its source text), the page client, ctx.existing and the test kit all read the wire through here.@norbital-ai/std/zone3 symbols — std/zone: wall-clock ⇄ UTC in an IANA zone through Intl (std/date and std/calendar build on it). Milliseconds in a UTC day.@norbital-ai/ui237 symbols — @norbital-ai/ui (§3.6, Appendix D.2): the views, the field kinds and inputs, Form/Field, and the primitives. Layout is ./layout; CaptureKit is ./capture, so its face engine loads only in pages that import it. The views of §3.6 over $bolt. The shell provides bolt (and the representation registry) once per page. A collection-backed view is exported typed by what its naked prop names (Workspace in ./collection/types.ts): the component is Svelte's generic-component shape over its own name-erased implementation. Live collection rows grouped into state, enum or relation lanes; dragging a card updates its lane field under the viewer's grants.@norbital-ai/ui/capture7 symbols — @norbital-ai/ui/capture (§3.6): its own entry, so the face engine and weights load only in pages that import it.@norbital-ai/ui/layout51 symbols — The layout layer (§3.6 ./layout): the layoutPack primitives and AppShell. Inset and scroll-port context stay internal.