zidane-ui/extensions/headless

Clamps and snaps a number the way zidane does (clampExtensionConfigNumber), so a typed value persists the same from every client.

Creates an empty DialogQueue.

Creates an ExtensionEffectRouter over a host's effects.

Creates a UiEffectChannel.

Creates the bridge for one webview page.

The typed error behind any rejection: an ExtensionsHostError's own, else failed with the message.

The options whose label, description or group contains every word of query (case-insensitive).

Options grouped in first-seen group order; ungrouped options come first under group: undefined.

Whether a declarative config entry sets this setting (shown, not editable).

Whether data is a well-formed bridge request.

The scope an action needs that this client's token lacks, or null when it may run it: the token grants granted (null or absent: not limited, as a local or in-process host), the action needs required (default admin, as zidane's).

Opens url in a new browser tab (in the desktop app, main's window-open handler hands it to the system): the app's way for a web link.

The full id of a panel an extension names: <extension>/<id> when that extension has one by that id, else the id as given (already full, or a built-in tab such as todos).

Whether a renderer draws target. Languages compare case-insensitively; a renderer for several tools draws each of them, and one for '*' draws every tool. A block id matches as given or, with extension, under the extension that registered the renderer (<extension>/<id>, the form CommandOutputBlock.custom.renderer and PanelCustomItem.renderer carry).

The renderers for target, in the host's order: the first draws, the next ones take over when a fallthrough renderer draws nothing.

Opens url: through the extensions' link handlers first, else fallback (the app's own way). Resolves true when a handler opened it. A handler that fails counts as not opening it.

Every row's starting value, by extension then key.

The value a row shows: the stored value when its type fits, else the default.

Whether a slot item does something on click: opens a panel or runs a command.

The slot items for one place, lowest order first (stable). Items scoped to a session show only beside that session; unscoped items show everywhere. A transcript.turn-end item that names a turn shows only after that turn (turnId); one that names none, only where no turn is given (the end of the transcript).

The app.titlebar items, lowest order first, at most TITLEBAR_ITEMS_PER_EXTENSION per extension (its first ones in that order).

What a host action rejects with.

The default English strings of the extensions components.

Every token the kit draws, in a fixed order.

Every slot name, in a fixed order.

How many app.titlebar items one extension shows: as many as its composer badges.

Error type for a contract the webview does not list.

The type of a request the page posts.

The type of the reply the bridge posts.

Error type when the host offers no RPC.

A dialog queue: the stores the UI reads, and the entry the backend calls.

Where a request comes from.

The extension callbacks a host can invoke, by id: their arguments and what they answer.

The unified commands.

A command on the wire: zidane's CommandListing, plus what a palette shows.

A dialog waiting on the user.

ctx.ui dialogs routed to this client. A dialog the extension withdraws (timeout, abort) leaves the stores without an answer.

One route: what it applies, and which effects it takes.

An effect router.

One account connected to an integration.

Integrations: Settings' Connect, Disconnect and default account.

An integration on the wire: its spec without callbacks, and its connections.

One contribution: zidane's UiEntry.

A link the user opened, as ExtensionsHost.openLink offers it to the extensions' link handlers.

A panel that would load something new: its subscribe emitted, or its handle was updated.

Who changed a catalog item (Settings shows it): zidane's CatalogItemProvenance, with the catalog it is in.

Options of ExtensionsHost.rpc.

The extensions' settings.

Every extension's settings, as Settings draws them.

The extensions host.

The extensions' typed stores, as the UI reads and writes them.

One typed store of an extension (ctx.storage.store).

An effect and the id its result goes back under.

The ctx.ui / ctx.composer calls routed to this client, for the app to apply.

Where the extensions' webviews load from: the app's origin policy, so every webview the kit draws follows it.

The wire form of each token the kit draws, by token name.

Where and how a link was opened.

An effect channel.

A bridge for one page.

Options of createWebviewRpcBridge.

A request from the page.

Badge actions, and the badges they apply to: zidane's BadgeActionWire (zidane/extensions).

A component an item names, an export of the extension's ui.tsx bundle and its JSON props: zidane's ComponentWire (zidane/extensions).

A context breakdown or context panel section: zidane's ContextSectionWire (zidane/extensions).

The kinds of DialogRequestWire.

A dialog ctx.ui asked for, by kind: zidane's DialogRequest (zidane/extensions). A form's settings holds the initial values, and its answer is a value per key.

The least client token scope that may run something (chat ⊂ approve ⊂ admin): zidane's AccessScope, the scope of an action setting.

A callback id.

A file ctx.composer.attach sends: a path, or bytes in base64.

Applies one effect. A throw or a rejection reports "did nothing".

What applying an effect gave: whether it did, the open panel ids for panel-state, nothing for notify.

The items of every token, each a store.

Where a link was clicked: zidane's LinkSource.

Where ctx.ui.navigate goes. Screen ids are full (<extension>/<id>).

Why a host call failed, for the UI to word through its labels.

The shape of the extensions label dictionary.

A token the kit draws. (Native menus are the desktop app's own.)

One ctx.ui / ctx.composer call for the app to apply: zidane's UiClientPort calls.

What applying an effect gave: whether it did, the open panels, or nothing for a notification.

A link handler (its match and open stay with the extension): zidane's LinkHandlerWire (zidane/extensions).

A side or home panel (its load, onAction and subscribe stay with the extension): zidane's PanelWire (zidane/extensions).

What a renderer draws: a custom block id, a code-block language, a tool's result, or an artifact kind's detail.

A renderer: a component, with a markdown fallback: zidane's RendererWire (zidane/extensions).

A full-screen view, or a modal: zidane's ScreenWire (zidane/extensions).

One option of a select dialog.

A Settings page under an extension: zidane's SettingsPageWire (zidane/extensions).

A setting's value as a form holds it.

Extra data on the rows of matching sessions: zidane's SidebarDecorationWire (zidane/extensions).

A filter an extension offers in every space's filter menu: zidane's SidebarFilterWire (zidane/extensions).

A grouping an extension offers in the filter menu: zidane's SidebarGroupWire (zidane/extensions).

One action of a sidebar row's menu: zidane's SidebarRowActionWire (zidane/extensions).

A row an extension lists among a space's sessions: zidane's SidebarRowWire (zidane/extensions).

A sort an extension offers in the filter menu: zidane's SidebarSortWire (zidane/extensions).

The places every app knows. An app without the place ignores the item.

A small item in a slot: a status line, a banner, a composer badge: zidane's SlotWire (zidane/extensions).

A space an extension adds to the switcher, with its base query: zidane's SpaceWire (zidane/extensions).

The reply to a request.

A sandboxed web page in a panel or a screen (a file source is relative to the extension's folder): zidane's WebviewWire (zidane/extensions).

Everything a Settings UI needs to draw settings (values without secrets, locked keys as extension:key): zidane's WireSettings (zidane/extensions).

One page of an extension's settings in the settings sidebar: zidane's WireSettingsPage (zidane/extensions).