API reference (TypeDoc)

The pages in this section explain the APIs you reach for most. For every exported type, class and function, generate the TypeDoc reference from your checkout. It is built from the same source the app runs, so it never drifts.

1. From the repository root, install and build once (see Contributing).
2. Run pnpm docs:api.
3. Open docs/generated/api/index.html in a browser. pnpm docs:api:watch rebuilds it as you edit.

What it covers

Package	Use it for
@teamhud/widget-mixins	The overlay hub and positioning mixins, hub appearance overrides, pin persistence.
@teamhud/widget-registration	Registering a widget and its component bundle.
@teamhud/component-bundle-registry	Component bundle discovery.
@teamhud/security	Permission grants, trust levels and capability requirements.
@teamhud/pipeline, @teamhud/pipeline-types	The pipeline engine that routes datasource items through processors into sinks.
@teamhud/storage	Typed key-value stores and secure storage helpers.
@teamhud/realtime-client, @teamhud/realtime-singleton	The realtime WebSocket client (topics, request/response) and the renderer singletons that share one signed-in connection.
@teamhud/context	Core context models shared by pipelines and plugins.

Note

The generated reference is not published on this site yet. Generate it locally as above. Writing your own TSDoc comments: follow the conventions in the repository’s docs/core/API-DOCUMENTATION.md.