bridgeparity

Documentation

Overview

Package bridgeparity validates the local editor bridge, control API, and remote-session bootstrap surfaces as one readiness contract.

Index

• func RequiredBridgeMethods() []string
• func RequiredControlRoutes() []string
• type Options
• type Report
  • func Build(options Options) Report

Functions

func RequiredBridgeMethods

func RequiredBridgeMethods() []string

RequiredBridgeMethods returns the stable bridge-method checklist used by Build.

func RequiredControlRoutes

func RequiredControlRoutes() []string

RequiredControlRoutes returns the stable control-route checklist used by Build.

Types

type Options

type Options struct {
	RemoteAuthToken   string
	EditorBridgeToken string
	RemoteEnabled     bool
	RemoteEnv         map[string]string
	RemoteProxyPort   uint16
}

Options supplies runtime inputs that cannot be inferred from static bridge registries.

type Report

type Report struct {
	Status                    string   `json:"status"`
	BridgeMethodCount         int      `json:"bridge_method_count"`
	RequiredBridgeMethodCount int      `json:"required_bridge_method_count"`
	MissingBridgeMethods      []string `json:"missing_bridge_methods,omitempty"`
	ControlRouteCount         int      `json:"control_route_count"`
	RequiredControlRouteCount int      `json:"required_control_route_count"`
	MissingControlRoutes      []string `json:"missing_control_routes,omitempty"`
	RemoteEnabled             bool     `json:"remote_enabled"`
	RemoteAuthConfigured      bool     `json:"remote_auth_configured"`
	EditorAuthConfigured      bool     `json:"editor_auth_configured"`
	RemoteSessionConfigured   bool     `json:"remote_session_configured"`
	RemoteProxyReady          bool     `json:"remote_proxy_ready"`
	RemoteProxyMissing        []string `json:"remote_proxy_missing,omitempty"`
	ExcludedExternalSurfaces  []string `json:"excluded_external_surfaces,omitempty"`
}

Report is the JSON-safe bridge and remote-session readiness summary.

func Build

func Build(options Options) Report

Build returns a bridge readiness report without starting any listeners or reading local editor state.