@spec __options__(
  String.t(),
  keyword()
) :: {atom(), keyword(), keyword()}

Builds validated LiveView session and route options for the router macro.

@spec __session__(Plug.Conn.t() | map(), String.t(), String.t(), String.t()) :: map()

Builds the serializable session metadata used by the embedded LiveView.

@spec __session__(
  Plug.Conn.t() | map(),
  String.t(),
  String.t(),
  String.t(),
  map() | tuple() | nil
) :: map()

Merges a host-supplied session map with BeamConsole's reserved mount metadata.

Imports the beam_console/1 and beam_console/2 router macros.

Mounts the BeamConsole LiveView and its self-contained assets.

The macro belongs inside a Phoenix router. The host application is responsible for placing the route behind an appropriate browser pipeline and any required authentication or authorization.

Options

• :enabled - mounts the routes when true; defaults to true only in the :dev Mix environment
• :as - names the LiveView session and route helpers; defaults to :beam_console and must be distinct for multiple mounts
• :on_mount - host authorization hooks run before BeamConsole's hook; defaults to []
• :session - a string-keyed map or {module, function, arguments} callback merged into the LiveView session; defaults to nil
• :socket_path - the host LiveView socket path; defaults to "/live" and must match the socket configured by the endpoint
• :transport - "websocket" or "longpoll"; defaults to "websocket" and must match a transport enabled by the endpoint