api/io.devconsole.api

Package-level declarations

Types

class AccessInfo(val connectUrl: String, val sessionCode: String, val expiresAtEpochMs: Long)

Ephemeral connect information for the SESSION_CODE flow. sessionCode is a complete access credential -- the live 8-character code -- and connectUrl embeds it in the #code= fragment. There is no on-device approval step: whoever presents the code within its TTL gets a full session. Never log, display outside the trusted device screen, or persist either value.

BindingMode

enum BindingMode : Enum<BindingMode>

Network exposure requested by the host, passed per-call as StartRequest.bindingMode. Loopback is the safe default -- the dashboard speaks plaintext HTTP, and LAN exposes that traffic to anyone else on the local network; see docs/THREAT_MODEL.md at the repository root before ever passing LAN.

BrowserBinding

enum BrowserBinding : Enum<BrowserBinding>

Network exposure declared on BrowserConfig (DevConsoleConfig.browserConfig.binding), for server starts the host does not issue itself.

BrowserConfig

data class BrowserConfig(val binding: BrowserBinding = BrowserBinding.LOOPBACK, val portRange: IntRange = DEFAULT_PORT_RANGE_START..DEFAULT_PORT_RANGE_END, val sessionCodeTtlMs: Long = DEFAULT_SESSION_CODE_TTL_MS)

SESSION_CODE is the only browser-access flow; there is no longer an access-mode field to set.

BrowserEndpoint

data class BrowserEndpoint(val host: String, val port: Int, val bindingMode: BindingMode)

Public description of the server selected after a successful DevConsoleFacadeProvider.startBrowser.

CaptureCategory

enum CaptureCategory : Enum<CaptureCategory>

A capture surface a host can independently opt into or out of at DevConsoleConfig construction time -- see DevConsoleConfig.captureCategories. Every gate downstream is fail-open: a config that is absent, or a gate lambda that throws, always means "capture", never "drop".

CaptureRule

data class CaptureRule(val id: String, val host: String, val method: String? = null, val pathPrefix: String? = null, val enabled: Boolean = true)

A durable capture exclusion.

CaptureRuleEngine

class CaptureRuleEngine(initialRules: List<CaptureRule> = emptyList())

Evaluates capture exclusions on the network capture hot path.

CaptureRuleStore

interface CaptureRuleStore

Durable backing store for CaptureRules; implementations must survive process restart.

ConfigValidationCode

enum ConfigValidationCode : Enum<ConfigValidationCode>

ConfigValidationError

data class ConfigValidationError(val code: ConfigValidationCode, val field: String, val message: String)

CrashPolicy

data class CrashPolicy(val crashCaptureEnabled: Boolean = true, val anrWatchdogEnabled: Boolean = true, val anrThresholdMs: Long = DEFAULT_ANR_THRESHOLD_MS, val breadcrumbDepth: Int = DEFAULT_BREADCRUMB_DEPTH, val maxStackChars: Int = DEFAULT_MAX_STACK_CHARS, val maxThreadsInDump: Int = DEFAULT_MAX_THREADS_IN_DUMP, val maxFramesPerThread: Int = DEFAULT_MAX_FRAMES_PER_THREAD)

Controls uncaught-exception and ANR capture depth.

DevConsoleConfig

data class DevConsoleConfig(val eventBufferCapacity: Int = DEFAULT_EVENT_BUFFER_CAPACITY, val stateProviders: List<StateProvider> = emptyList(), val featureFlags: List<FeatureFlag> = emptyList(), val composerEnabled: Boolean = false, val composerAllowedHosts: Set<String> = emptySet(), val stateMutationsEnabled: Boolean = false, val redactionPolicy: RedactionPolicy = RedactionPolicy.default())

Host configuration supplied to io.devconsole.DevConsole.initialize.

DevConsoleFacadeProvider

interface DevConsoleFacadeProvider

DevConsoleState

sealed class DevConsoleState

Lifecycle state of the SDK runtime, observable via io.devconsole.DevConsole.state (a StateFlow). This tracks the runtime -- whether io.devconsole.DevConsole.initialize has succeeded and whether the embedded browser server is bound -- not individual capture sources; network/socket/push recording is available as soon as Initialized is reached, independent of whether the server has ever been started.

EditingCapabilities

data class EditingCapabilities(val preferences: Boolean = false, val featureFlags: Boolean = false, val database: Boolean = false, val files: Boolean = false, val mocks: Boolean = false, val requestExecution: Boolean = false, val captureRules: Boolean = false)

EventEnvelope

data class EventEnvelope(val id: UUID, val sessionId: UUID, val pluginId: String, val type: String, val timestampEpochMs: Long, val monotonicNanos: Long, val sequence: Long, val severity: EventSeverity, val summary: String, val correlationId: String? = null, val tags: Map<String, String> = emptyMap(), val payloadRef: String? = null, val schemaVersion: Int = CURRENT_SCHEMA_VERSION)

EventSeverity

enum EventSeverity : Enum<EventSeverity>

InitResult

sealed interface InitResult

Outcome of io.devconsole.DevConsole.initialize (or the internal provisional auto-init call).

InMemoryCaptureRuleStore

class InMemoryCaptureRuleStore(initialRules: List<CaptureRule> = emptyList()) : CaptureRuleStore

Test and default implementation; deliberately not durable.

InspectorOpenResult

sealed interface InspectorOpenResult

Outcome of io.devconsole.DevConsole.open -- launching the SDK's own in-app inspector (as opposed to the browser dashboard, which is io.devconsole.DevConsole.startBrowser's concern). The SDK never opens this on its own; it only launches from an explicit host trigger.

OpenTriggers

data class OpenTriggers(val shakeToOpen: Boolean = false, val shakeIntensity: ShakeIntensity = ShakeIntensity.MEDIUM, val floatingButton: Boolean = false)

Opt-in ways the SDK itself opens the in-app inspector -- see DevConsoleConfig.openTriggers. Everything defaults to off, so hosts that never touch this see no behaviour change. Triggers only open the inspector UI; they never start the embedded server.

RetentionPolicy

data class RetentionPolicy(val maxSessions: Int = DEFAULT_MAX_SESSIONS, val maxAgeMs: Long = DEFAULT_MAX_AGE_MS, val maxBytes: Long = DEFAULT_MAX_BYTES)

ScreenshotPolicy

data class ScreenshotPolicy(val enabled: Boolean = false, val maxLongestEdgePx: Int = DEFAULT_MAX_LONGEST_EDGE_PX, val maxBytes: Long = DEFAULT_MAX_BYTES)

Controls whether and how io.devconsole.DevConsole.captureScreenshot may capture the foreground window.

ScreenshotResult

sealed interface ScreenshotResult

Outcome of io.devconsole.DevConsole.captureScreenshot.

SessionPolicy

data class SessionPolicy(val maxAuthenticatedSessions: Int = DEFAULT_MAX_AUTHENTICATED_SESSIONS)

Concurrent-session cap. One access tier -- every session is equivalent, so the old CONTROL/ADMIN-specific caps are gone; maxAuthenticatedSessions alone still bounds total live sessions.

ShakeIntensity

enum ShakeIntensity : Enum<ShakeIntensity>

How hard a shake must be before the inspector opens -- see OpenTriggers.shakeIntensity.

StartRequest

data class StartRequest(val bindingMode: BindingMode = BindingMode.LOOPBACK, val portRange: IntRange = DEFAULT_PORT_RANGE_START..DEFAULT_PORT_RANGE_END)

Stable host-facing server start options.

StartResult

sealed interface StartResult

Outcome of io.devconsole.DevConsole.startBrowser / startBrowserAsync.

StopReason

sealed interface StopReason

Why io.devconsole.DevConsole.stop / stopAsync was called; informational, does not change stop behavior.

StoragePolicy

data class StoragePolicy(val maxBytes: Long = DEFAULT_MAX_BYTES, val maxAgeMs: Long = DEFAULT_MAX_AGE_MS, val maxTimelineEvents: Int = DEFAULT_MAX_TIMELINE_EVENTS, val maxNetworkTransactions: Int = DEFAULT_MAX_NETWORK_TRANSACTIONS)