@devicerail/protocol 0.1.0

package/dist/generated/v1/test-event-payload.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type TestEventPayload = {
+    type: "sessionStarted";
+} | {
+    outcome: SessionOutcome;
+    reason?: string | null;
+    type: "sessionEnded";
+} | {
+    observation: Observation;
+    type: "observationCaptured";
+} | {
+    call: RecordedActionCall;
+    type: "actionStarted";
+} | {
+    callId: string;
+    outcome: ActionOutcome;
+    type: "actionCompleted";
+} | {
+    stream: MediaStreamInfo;
+    type: "mediaStreamStarted";
+} | {
+    frame: MediaFrame;
+    type: "mediaFrameCaptured";
+} | {
+    frameCount: number;
+    streamId: string;
+    type: "mediaStreamEnded";
+} | {
+    type: "verdictRecorded";
+    verdict: Verdict;
+} | {
+    error: ErrorInfo;
+    type: "error";
+};
+export type SessionOutcome = "completed" | "failed" | "cancelled" | "shutdown";
+export type ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+/**
+ * The terminal outcome for one action call.
+ *
+ * Keeping the four outcomes structurally distinct prevents clients from
+ * having to infer timeout or cancellation from human-readable error text.
+ */
+export type ActionOutcome = {
+    outcome: "succeeded";
+    result: ActionResult;
+} | {
+    error: ErrorInfo;
+    outcome: "failed";
+} | {
+    error: ErrorInfo;
+    outcome: "cancelled";
+} | {
+    error: ErrorInfo;
+    outcome: "timedOut";
+    timeoutMs: number;
+};
+export type ActionExecution = {
+    context: UiContextRef;
+    mode: "nativeSemantic";
+} | {
+    context: UiContextRef;
+    mode: "webSemantic";
+} | {
+    context: UiContextRef;
+    fallbackReason: CoordinateFallbackReason;
+    mode: "coordinateFallback";
+};
+export type CoordinateFallbackReason = "semanticInteractionUnavailable" | "platformLimitation";
+export type MediaStreamKind = "screenshot" | "video";
+/**
+ * A one-based sequence number within one session.
+ *
+ * The wire value is capped at JavaScript's maximum safe integer so generated
+ * clients can sort and resume event streams without losing precision.
+ */
+export type EventSequence = number;
+export type VerdictStatus = "pass" | "fail" | "unknown";
+export interface Observation {
+    capturedAtMs: number;
+    deviceId: string;
+    id: string;
+    metadata?: {
+        [k: string]: unknown;
+    };
+    screenshot?: AssetRef | null;
+    screenshotOmission?: ScreenshotOmissionReason | null;
+    uiSnapshot?: UiSnapshotRef | null;
+    uiSnapshotOmission?: UiSnapshotOmissionReason | null;
+    viewport: Viewport;
+    [k: string]: unknown;
+}
+export interface AssetRef {
+    id: string;
+    mediaType: string;
+    sha256?: string | null;
+    uri: string;
+    [k: string]: unknown;
+}
+/**
+ * Small Observation-side reference to a UI Tree Evidence object.
+ */
+export interface UiSnapshotRef {
+    byteLength: number;
+    context: UiContextRef;
+    evidence: AssetRef;
+    formatVersion: number;
+    nodeCount: number;
+}
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}
+export interface Viewport {
+    height: number;
+    scaleFactor: number;
+    width: number;
+    [k: string]: unknown;
+}
+/**
+ * Durable representation of an Action invocation.
+ *
+ * Standard calls preserve the historical wire shape. Protected and unknown
+ * calls retain only correlation fields and serialize `arguments` as `null`
+ * with an explicit `argumentsRedacted` marker.
+ */
+export interface RecordedActionCall {
+    arguments?: unknown;
+    argumentsRedacted?: boolean;
+    id: string;
+    name: string;
+    [k: string]: unknown;
+}
+export interface ActionResult {
+    after?: Observation | null;
+    before?: Observation | null;
+    callId: string;
+    evidence?: AssetRef[];
+    execution?: ActionExecution | null;
+    finishedAtMs: number;
+    output: unknown;
+    startedAtMs: number;
+    [k: string]: unknown;
+}
+export interface ErrorInfo {
+    code: string;
+    details?: unknown;
+    message: string;
+    retryable: boolean;
+}
+export interface MediaStreamInfo {
+    id: string;
+    kind: MediaStreamKind;
+    mediaType: string;
+    viewport?: Viewport | null;
+}
+export interface MediaFrame {
+    durationMs?: number | null;
+    evidence: AssetRef;
+    frameIndex: EventSequence;
+    keyFrame?: boolean;
+    streamId: string;
+}
+export interface Verdict {
+    /**
+     * @maxItems 64
+     */
+    evidence?: AssetRef[];
+    status: VerdictStatus;
+    summary: string;
+}

package/dist/generated/v1/test-event.d.ts

@@ -0,0 +1,191 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type TestEventPayload = {
+    type: "sessionStarted";
+} | {
+    outcome: SessionOutcome;
+    reason?: string | null;
+    type: "sessionEnded";
+} | {
+    observation: Observation;
+    type: "observationCaptured";
+} | {
+    call: RecordedActionCall;
+    type: "actionStarted";
+} | {
+    callId: string;
+    outcome: ActionOutcome;
+    type: "actionCompleted";
+} | {
+    stream: MediaStreamInfo;
+    type: "mediaStreamStarted";
+} | {
+    frame: MediaFrame;
+    type: "mediaFrameCaptured";
+} | {
+    frameCount: number;
+    streamId: string;
+    type: "mediaStreamEnded";
+} | {
+    type: "verdictRecorded";
+    verdict: Verdict;
+} | {
+    error: ErrorInfo;
+    type: "error";
+};
+export type SessionOutcome = "completed" | "failed" | "cancelled" | "shutdown";
+export type ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+/**
+ * The terminal outcome for one action call.
+ *
+ * Keeping the four outcomes structurally distinct prevents clients from
+ * having to infer timeout or cancellation from human-readable error text.
+ */
+export type ActionOutcome = {
+    outcome: "succeeded";
+    result: ActionResult;
+} | {
+    error: ErrorInfo;
+    outcome: "failed";
+} | {
+    error: ErrorInfo;
+    outcome: "cancelled";
+} | {
+    error: ErrorInfo;
+    outcome: "timedOut";
+    timeoutMs: number;
+};
+export type ActionExecution = {
+    context: UiContextRef;
+    mode: "nativeSemantic";
+} | {
+    context: UiContextRef;
+    mode: "webSemantic";
+} | {
+    context: UiContextRef;
+    fallbackReason: CoordinateFallbackReason;
+    mode: "coordinateFallback";
+};
+export type CoordinateFallbackReason = "semanticInteractionUnavailable" | "platformLimitation";
+export type MediaStreamKind = "screenshot" | "video";
+/**
+ * A one-based sequence number within one session.
+ *
+ * The wire value is capped at JavaScript's maximum safe integer so generated
+ * clients can sort and resume event streams without losing precision.
+ */
+export type EventSequence = number;
+export type VerdictStatus = "pass" | "fail" | "unknown";
+export type RpcIdSchema = string | number;
+export interface TestEvent {
+    atMs: number;
+    deviceId?: string | null;
+    eventId: string;
+    payload: TestEventPayload;
+    requestId?: RpcIdSchema | null;
+    sequence: EventSequence;
+    sessionId: string;
+}
+export interface Observation {
+    capturedAtMs: number;
+    deviceId: string;
+    id: string;
+    metadata?: {
+        [k: string]: unknown;
+    };
+    screenshot?: AssetRef | null;
+    screenshotOmission?: ScreenshotOmissionReason | null;
+    uiSnapshot?: UiSnapshotRef | null;
+    uiSnapshotOmission?: UiSnapshotOmissionReason | null;
+    viewport: Viewport;
+    [k: string]: unknown;
+}
+export interface AssetRef {
+    id: string;
+    mediaType: string;
+    sha256?: string | null;
+    uri: string;
+    [k: string]: unknown;
+}
+/**
+ * Small Observation-side reference to a UI Tree Evidence object.
+ */
+export interface UiSnapshotRef {
+    byteLength: number;
+    context: UiContextRef;
+    evidence: AssetRef;
+    formatVersion: number;
+    nodeCount: number;
+}
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}
+export interface Viewport {
+    height: number;
+    scaleFactor: number;
+    width: number;
+    [k: string]: unknown;
+}
+/**
+ * Durable representation of an Action invocation.
+ *
+ * Standard calls preserve the historical wire shape. Protected and unknown
+ * calls retain only correlation fields and serialize `arguments` as `null`
+ * with an explicit `argumentsRedacted` marker.
+ */
+export interface RecordedActionCall {
+    arguments?: unknown;
+    argumentsRedacted?: boolean;
+    id: string;
+    name: string;
+    [k: string]: unknown;
+}
+export interface ActionResult {
+    after?: Observation | null;
+    before?: Observation | null;
+    callId: string;
+    evidence?: AssetRef[];
+    execution?: ActionExecution | null;
+    finishedAtMs: number;
+    output: unknown;
+    startedAtMs: number;
+    [k: string]: unknown;
+}
+export interface ErrorInfo {
+    code: string;
+    details?: unknown;
+    message: string;
+    retryable: boolean;
+}
+export interface MediaStreamInfo {
+    id: string;
+    kind: MediaStreamKind;
+    mediaType: string;
+    viewport?: Viewport | null;
+}
+export interface MediaFrame {
+    durationMs?: number | null;
+    evidence: AssetRef;
+    frameIndex: EventSequence;
+    keyFrame?: boolean;
+    streamId: string;
+}
+export interface Verdict {
+    /**
+     * @maxItems 64
+     */
+    evidence?: AssetRef[];
+    status: VerdictStatus;
+    summary: string;
+}

package/dist/generated/v1/text-match-mode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type TextMatchMode = "exact" | "contains";

package/dist/generated/v1/text-match.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export interface TextMatch {
+    caseSensitive?: boolean;
+    mode?: "exact" | "contains";
+    value: string;
+}

package/dist/generated/v1/transport-info.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export interface TransportInfo {
+    framing: string;
+    kind: string;
+}

package/dist/generated/v1/ui-context-kind.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiContextKind = "native" | "web";

package/dist/generated/v1/ui-context-ref.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiContextKind = "native" | "web";
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}

package/dist/generated/v1/ui-context-selector.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiContextKind = "native" | "web";
+/**
+ * Selects a current context without pretending to own its document epoch.
+ */
+export interface UiContextSelector {
+    contextId?: string | null;
+    contextKind: UiContextKind;
+}

package/dist/generated/v1/ui-node-ref.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiContextKind = "native" | "web";
+/**
+ * Durable reference to one node in one observed UI Tree.
+ */
+export interface UiNodeRef {
+    context: UiContextRef;
+    observationId: string;
+    stableNodeId: string;
+}
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}

package/dist/generated/v1/ui-node.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * One node in the normalized preorder list. Unknown platform values remain
+ * `null`; Drivers must not manufacture optimistic enabled/hittable states.
+ */
+export interface UiNode {
+    bounds?: UiRect | null;
+    enabled?: boolean | null;
+    hittable?: boolean | null;
+    identifier?: string | null;
+    name?: string | null;
+    parentStableNodeId?: string | null;
+    role: string;
+    stableNodeId: string;
+    text?: string | null;
+    value?: string | null;
+}
+export interface UiRect {
+    height: number;
+    width: number;
+    x: number;
+    y: number;
+}

package/dist/generated/v1/ui-rect.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export interface UiRect {
+    height: number;
+    width: number;
+    x: number;
+    y: number;
+}

package/dist/generated/v1/ui-snapshot-get-params.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * Parameters accepted by `ui.snapshot.get`.
+ *
+ * The active Session owns the Observation lookup; callers cannot name a
+ * different Session or provide an arbitrary Evidence reference.
+ */
+export interface UiSnapshotGetParams {
+    observationId: string;
+}

package/dist/generated/v1/ui-snapshot-get-request.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type UiSnapshotGetMethodSchema = "ui.snapshot.get";
+export interface UiSnapshotGetRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: UiSnapshotGetMethodSchema;
+    params: UiSnapshotGetParams;
+}
+/**
+ * Parameters accepted by `ui.snapshot.get`.
+ *
+ * The active Session owns the Observation lookup; callers cannot name a
+ * different Session or provide an arbitrary Evidence reference.
+ */
+export interface UiSnapshotGetParams {
+    observationId: string;
+}

package/dist/generated/v1/ui-snapshot-get-response.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiSnapshotGetResponse = UiSnapshotGetSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type UiContextKind = "native" | "web";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface UiSnapshotGetSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: UiSnapshot;
+}
+/**
+ * Canonical UI Tree. `nodes` is preorder and every parent must precede its
+ * contiguous descendants. The serialized payload is bounded to 768 KiB.
+ */
+export interface UiSnapshot {
+    context: UiContextRef;
+    formatVersion: number;
+    /**
+     * @minItems 1
+     * @maxItems 10000
+     */
+    nodes: [UiNode, ...UiNode[]];
+    observationId: string;
+    /**
+     * @minItems 1
+     * @maxItems 10000
+     */
+    rootStableNodeIds: [string, ...string[]];
+}
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}
+/**
+ * One node in the normalized preorder list. Unknown platform values remain
+ * `null`; Drivers must not manufacture optimistic enabled/hittable states.
+ */
+export interface UiNode {
+    bounds?: UiRect | null;
+    enabled?: boolean | null;
+    hittable?: boolean | null;
+    identifier?: string | null;
+    name?: string | null;
+    parentStableNodeId?: string | null;
+    role: string;
+    stableNodeId: string;
+    text?: string | null;
+    value?: string | null;
+}
+export interface UiRect {
+    height: number;
+    width: number;
+    x: number;
+    y: number;
+}
+export interface SystemHelloFailureSchema {
+    error: RpcError;
+    id: NullableRpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+}
+export interface RpcError {
+    code: number;
+    data: ErrorInfo;
+    message: string;
+}
+export interface ErrorInfo {
+    code: string;
+    details?: unknown;
+    message: string;
+    retryable: boolean;
+}

package/dist/generated/v1/ui-snapshot-get-result.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiContextKind = "native" | "web";
+/**
+ * Canonical UI Tree. `nodes` is preorder and every parent must precede its
+ * contiguous descendants. The serialized payload is bounded to 768 KiB.
+ */
+export interface UiSnapshotGetResult {
+    context: UiContextRef;
+    formatVersion: number;
+    /**
+     * @minItems 1
+     * @maxItems 10000
+     */
+    nodes: [UiNode, ...UiNode[]];
+    observationId: string;
+    /**
+     * @minItems 1
+     * @maxItems 10000
+     */
+    rootStableNodeIds: [string, ...string[]];
+}
+/**
+ * Full identity of one native accessibility or web-document context.
+ * `documentEpoch` is required for both channels and changes after reconnect,
+ * navigation, or any replacement that invalidates prior node references.
+ */
+export interface UiContextRef {
+    contextId: string;
+    contextKind: UiContextKind;
+    documentEpoch: string;
+}
+/**
+ * One node in the normalized preorder list. Unknown platform values remain
+ * `null`; Drivers must not manufacture optimistic enabled/hittable states.
+ */
+export interface UiNode {
+    bounds?: UiRect | null;
+    enabled?: boolean | null;
+    hittable?: boolean | null;
+    identifier?: string | null;
+    name?: string | null;
+    parentStableNodeId?: string | null;
+    role: string;
+    stableNodeId: string;
+    text?: string | null;
+    value?: string | null;
+}
+export interface UiRect {
+    height: number;
+    width: number;
+    x: number;
+    y: number;
+}

package/dist/generated/v1/ui-snapshot-omission-reason.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";