xray_inspector

Core orchestration package. Contains the inspector classes, repository layer, and the HTTP/WebSocket server that broadcasts inspector data to remote UI clients.

Installation

dependencies:
  xray_inspector: ^0.0.1

What's included

XRayNetworkInspector — captures and stores network calls
XRayLogInspector — captures and stores log entries
XRayKeyValueInspector — base class for key-value inspectors
XRayInspectorServer — HTTP + WebSocket + UDP discovery server
XRayInspectorServerConfig — server configuration

XRayNetworkInspector

final inspector = XRayNetworkInspector(title: 'Network');

Member	Type	Description
`title`	`String`	Display name (default: `"Network"`)
`id`	`String`	Derived from title, used as server route ID
`calls`	`List<XRayNetworkCall>`	Current captured calls (snapshot)
`callsNotifier`	`ValueNotifier<List<...>>`	Reactive calls list
`findById(id)`	`XRayNetworkCall?`	Look up a call by ID
`addListener(l)`	`void`	Register a listener
`removeListener(l)`	`void`	Unregister a listener
`clear()`	`void`	Clear all captured calls

XRayLogInspector

final inspector = XRayLogInspector(title: 'Logs');

Member	Type	Description
`title`	`String`	Display name (default: `"Logs"`)
`entries`	`List<XRayLogInspectorEntry>`	Current log entries
`entriesNotifier`	`ValueNotifier<List<...>>`	Reactive entries list
`verbose(message)`	`void`	Log at verbose level
`debug(message)`	`void`	Log at debug level
`info(message)`	`void`	Log at info level
`warning(message)`	`void`	Log at warning level
`error(message)`	`void`	Log at error level
`log(message, level:)`	`void`	Log with explicit level
`clear()`	`void`	Clear all entries

XRayKeyValueInspector

Base class used by XRaySharedPreferencesInspector and XRaySecureStorageInspector.

final inspector = XRayKeyValueInspector(source: mySource);

Member	Type	Description
`title`	`String`	Derived from `source.title`
`entriesNotifier`	`ValueNotifier<List<InspectorKeyValueEntry>>`	Reactive entries
`refresh()`	`Future<void>`	Re-read all entries from the source
`write(key, value)`	`Future<void>`	Write a value and refresh
`delete(key)`	`Future<void>`	Delete a key and refresh
`clear()`	`void`	Delete all keys

XRayInspectorServer

final server = XRayInspectorServer(
  config: XRayInspectorServerConfig(
    inspectors: [networkInspector, logInspector],
    httpPort: 8080,
    discoveryPort: 8081,
  ),
);

await server.start();
await server.stop();

XRayKeyValueSource

Implement this interface to add any key-value store:

abstract class XRayKeyValueSource {
  String get title;
  Future<Map<String, String>> readAll();
  Future<void> write(String key, String value);
  Future<void> delete(String key);
}

Getting Started

Guides

Packages

Legal