Skip to content

host:variant

FieldValue
Prefixhost:variant
Namespace constantVariantNamespace
Subjects constantVariantSubjects
Kindbus
Schema recordVariantSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/variant/namespace.ts
KeyWireTypeSchema
getInfohost:variant.getInforpcschemas.ts
requestUpgradehost:variant.requestUpgraderpcschemas.ts
upgradeProgresshost:variant.upgradeProgresseventschemas.ts

Query the current variant configuration from the host.

Request: empty — the handler reads the resolved variant at startup. Response: full variant info — identifier, CEF-bundle flag, and default renderer.

Subject: host:variant.getInfo Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
bundleCEFbooleanyes
defaultRenderer"cef" | "native"yes
variant"base" | "cef"yes

Request a variant switch on the host.

The host may accept or decline the request. When accepted it may report the estimated download size so the caller can display a confirmation UI. A declined response must include a human-readable message explaining why.

Subject: host:variant.requestUpgrade Type: Request (RPC)

Request:

FieldTypeRequired
targetVariant"base" | "cef"yes

Response:

FieldTypeRequired
acceptedbooleanyes
messagestring | undefinedno

Emitted by the host while a variant upgrade is in progress.

Consumers subscribe to track download and apply progress for display in the UI (e.g. a progress bar).

Subject: host:variant.upgradeProgress Type: Event

FieldTypeRequired
messagestring | undefinedno
percentnumber | undefinedno
status"error" | "complete" | "progress" | "downloading" | "applying"yes

Auto-generated by yarn docs:bus. Do not edit manually.