Vibe.UI.Bus (vibe v0.2.0)

Copy Markdown View Source

Registry-backed access point for UI sessions.

Plugins and background workers use this module to update UI state without knowing whether the UI is rendered by the TUI, LiveView, or tests.

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

dispatch(session_id, command)
emit(session_id, type, data \\ %{})
emit_all(type, data \\ %{}, opts \\ [])
notify_all(notification, opts \\ [])
register(session_id, server)
server(session_id)
set_status(session_id, key, text)

Intentional facade for the public Vibe API boundary.

start_link(opts \\ [])
unregister(session_id, server)

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

dispatch(session_id, command)

@spec dispatch(String.t(), Vibe.UI.Command.t() | atom() | {atom(), map()}) ::
  :ok | {:error, :not_found}

emit(session_id, type, data \\ %{})

@spec emit(String.t(), atom(), map()) :: :ok | {:error, :not_found}

emit_all(type, data \\ %{}, opts \\ [])

@spec emit_all(atom(), map(), keyword()) :: :ok

notify_all(notification, opts \\ [])

@spec notify_all(
  Vibe.UI.Notification.t() | map() | keyword() | String.t(),
  keyword()
) :: :ok

register(session_id, server)

@spec register(String.t(), GenServer.server()) :: :ok

server(session_id)

@spec server(String.t()) :: {:ok, GenServer.server()} | {:error, :not_found}

set_status(session_id, key, text)

@spec set_status(String.t(), String.t() | atom(), String.t() | nil) ::
  :ok | {:error, :not_found}

Intentional facade for the public Vibe API boundary.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

unregister(session_id, server)

@spec unregister(String.t(), GenServer.server()) :: :ok