API reference / @docmentis/udoc-node / Entitlements

Interface: Entitlements

What a session is entitled to, resolved once as it starts. A feature is enabled two ways: the valid license carries it, or — with no license — the permit grants it.

The session keeps this and every gate reads it. The host reads it too, to label its UI and disable controls it knows are refused — advisory there only: every entitlement is enforced in Rust at the call it guards, so a host that ignores this gets an error rather than an unlicensed edit.

Properties

Property	Description
licensed boolean	Whether a valid commercial license backs this session.
features Feature[]	Features this session may use: the ones its license carries, or with no license, the ones its permit grants — in the viewer's, only those [Feature::in_viewer] allows.
organization string | null	Organization the license was issued to.
expiresAt number | null	Expiry (Unix seconds), absent when the license never expires.
attributionHidden boolean	Whether the decal is actually suppressed — the host's request and a license agreeing. False when it asked without one.
telemetryDisabled boolean	Whether usage is actually unreported, on the same terms.
wasmVersion string	This wasm's own version, independent of the wrapper's.