@devicerail/protocol 0.1.0

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

@@ -0,0 +1,20 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * 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 SessionState = "active" | "ended";
+export interface SessionInfo {
+    endedAtMs?: number | null;
+    eventCount: EventSequence;
+    id: string;
+    lastSequence: EventSequence;
+    startedAtMs: number;
+    state: SessionState;
+}

package/dist/generated/v1/session-outcome.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 SessionOutcome = "completed" | "failed" | "cancelled" | "shutdown";

package/dist/generated/v1/session-start-request.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 RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type SessionStartMethodSchema = "session.start";
+export type NoParamsSchema = EmptyParamsObjectSchema | [];
+export interface SessionStartRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: SessionStartMethodSchema;
+    params?: NoParamsSchema;
+}
+export type EmptyParamsObjectSchema = Record<string, never>;

package/dist/generated/v1/session-start-response.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type SessionStartResponse = SessionStartSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+/**
+ * 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 SessionState = "active" | "ended";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface SessionStartSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: SessionInfo;
+}
+export interface SessionInfo {
+    endedAtMs?: number | null;
+    eventCount: EventSequence;
+    id: string;
+    lastSequence: EventSequence;
+    startedAtMs: number;
+    state: SessionState;
+}
+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/session-start-result.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * 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 SessionState = "active" | "ended";
+export interface SessionStartResult {
+    endedAtMs?: number | null;
+    eventCount: EventSequence;
+    id: string;
+    lastSequence: EventSequence;
+    startedAtMs: number;
+    state: SessionState;
+}

package/dist/generated/v1/session-state.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 SessionState = "active" | "ended";

package/dist/generated/v1/session-target-params.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.
+ */
+/**
+ * Optional session selector accepted by `events.clear`.
+ */
+export interface SessionTargetParams {
+    sessionId?: string | null;
+}

package/dist/generated/v1/sessions-list-request.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 RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type SessionsListMethodSchema = "sessions.list";
+export type NoParamsSchema = EmptyParamsObjectSchema | [];
+export interface SessionsListRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: SessionsListMethodSchema;
+    params?: NoParamsSchema;
+}
+export type EmptyParamsObjectSchema = Record<string, never>;

package/dist/generated/v1/sessions-list-response.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type SessionsListResponse = SessionsListSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+/**
+ * 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 SessionState = "active" | "ended";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface SessionsListSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: SessionInfo[];
+}
+export interface SessionInfo {
+    endedAtMs?: number | null;
+    eventCount: EventSequence;
+    id: string;
+    lastSequence: EventSequence;
+    startedAtMs: number;
+    state: SessionState;
+}
+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/sessions-list-result.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * 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 SessionState = "active" | "ended";
+export type SessionsListResult = SessionInfo[];
+export interface SessionInfo {
+    endedAtMs?: number | null;
+    eventCount: EventSequence;
+    id: string;
+    lastSequence: EventSequence;
+    startedAtMs: number;
+    state: SessionState;
+}

package/dist/generated/v1/set-element-value-arguments.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type ElementTarget = {
+    kind: "selector";
+    selector: ElementSelector;
+} | {
+    kind: "node";
+    node: UiNodeRef;
+};
+export type UiContextKind = "native" | "web";
+export interface SetElementValueArguments {
+    target: ElementTarget;
+    value: string;
+}
+/**
+ * Cross-channel selector. Native contexts use accessibility fields; web
+ * contexts may additionally use CSS. Context selection never carries a stale
+ * document epoch; resolved node references always carry the full context.
+ */
+export interface ElementSelector {
+    context?: UiContextSelector | null;
+    css?: string | null;
+    identifier?: string | null;
+    name?: string | null;
+    role?: string | null;
+    text?: TextMatch | null;
+    value?: string | null;
+}
+/**
+ * Selects a current context without pretending to own its document epoch.
+ */
+export interface UiContextSelector {
+    contextId?: string | null;
+    contextKind: UiContextKind;
+}
+export interface TextMatch {
+    caseSensitive?: boolean;
+    mode?: "exact" | "contains";
+    value: string;
+}
+/**
+ * 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/set-element-value-result.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.
+ */
+export type UiContextKind = "native" | "web";
+export interface SetElementValueResult {
+    element: UiNodeRef;
+}
+/**
+ * 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/system-describe-request.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 RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type SystemDescribeMethodSchema = "system.describe";
+export type NoParamsSchema = EmptyParamsObjectSchema | [];
+export interface SystemDescribeRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: SystemDescribeMethodSchema;
+    params?: NoParamsSchema;
+}
+export type EmptyParamsObjectSchema = Record<string, never>;

package/dist/generated/v1/system-describe-response.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type SystemDescribeResponse = SystemDescribeSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface SystemDescribeSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: SystemDescribeResult;
+}
+/**
+ * Result returned by `system.describe`.
+ */
+export interface SystemDescribeResult {
+    activeSessionId?: string | null;
+    client: PeerInfo;
+    connection: HelloResult;
+    deviceId?: string | null;
+}
+export interface PeerInfo {
+    name: string;
+    version: string;
+}
+export interface HelloResult {
+    connectionId: string;
+    features: FeatureSelection;
+    protocol: ProtocolSelection;
+    server: PeerInfo;
+    transport: TransportInfo;
+}
+export interface FeatureSelection {
+    enabled: string[];
+}
+export interface ProtocolSelection {
+    selected: ProtocolVersion;
+}
+export interface ProtocolVersion {
+    major: number;
+    minor: number;
+}
+export interface TransportInfo {
+    framing: string;
+    kind: string;
+}
+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/system-describe-result.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * Result returned by `system.describe`.
+ */
+export interface SystemDescribeResult {
+    activeSessionId?: string | null;
+    client: PeerInfo;
+    connection: HelloResult;
+    deviceId?: string | null;
+}
+export interface PeerInfo {
+    name: string;
+    version: string;
+}
+export interface HelloResult {
+    connectionId: string;
+    features: FeatureSelection;
+    protocol: ProtocolSelection;
+    server: PeerInfo;
+    transport: TransportInfo;
+}
+export interface FeatureSelection {
+    enabled: string[];
+}
+export interface ProtocolSelection {
+    selected: ProtocolVersion;
+}
+export interface ProtocolVersion {
+    major: number;
+    minor: number;
+}
+export interface TransportInfo {
+    framing: string;
+    kind: string;
+}

package/dist/generated/v1/system-hello-request.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 SystemHelloMethodSchema = "system.hello";
+export interface SystemHelloRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: SystemHelloMethodSchema;
+    params: HelloParams;
+}
+export interface HelloParams {
+    client: PeerInfo;
+    features?: FeatureOffer;
+    protocol: ProtocolOffer;
+}
+export interface PeerInfo {
+    name: string;
+    version: string;
+}
+export interface FeatureOffer {
+    optional?: string[];
+    required?: string[];
+}
+/**
+ * An explicit set of supported ranges. Multiple entries avoid implying support
+ * for major versions that a peer intentionally skipped.
+ */
+export interface ProtocolOffer {
+    /**
+     * @minItems 1
+     */
+    ranges: [ProtocolRange, ...ProtocolRange[]];
+}
+/**
+ * A contiguous minor-version range within one protocol major version.
+ */
+export interface ProtocolRange {
+    major: number;
+    maxMinor: number;
+    minMinor: number;
+}

package/dist/generated/v1/system-hello-response.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type SystemHelloResponse = SystemHelloSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface SystemHelloSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: HelloResult;
+}
+export interface HelloResult {
+    connectionId: string;
+    features: FeatureSelection;
+    protocol: ProtocolSelection;
+    server: PeerInfo;
+    transport: TransportInfo;
+}
+export interface FeatureSelection {
+    enabled: string[];
+}
+export interface ProtocolSelection {
+    selected: ProtocolVersion;
+}
+export interface ProtocolVersion {
+    major: number;
+    minor: number;
+}
+export interface PeerInfo {
+    name: string;
+    version: string;
+}
+export interface TransportInfo {
+    framing: string;
+    kind: string;
+}
+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/tap-element-arguments.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type ElementTarget = {
+    kind: "selector";
+    selector: ElementSelector;
+} | {
+    kind: "node";
+    node: UiNodeRef;
+};
+export type UiContextKind = "native" | "web";
+export interface TapElementArguments {
+    target: ElementTarget;
+}
+/**
+ * Cross-channel selector. Native contexts use accessibility fields; web
+ * contexts may additionally use CSS. Context selection never carries a stale
+ * document epoch; resolved node references always carry the full context.
+ */
+export interface ElementSelector {
+    context?: UiContextSelector | null;
+    css?: string | null;
+    identifier?: string | null;
+    name?: string | null;
+    role?: string | null;
+    text?: TextMatch | null;
+    value?: string | null;
+}
+/**
+ * Selects a current context without pretending to own its document epoch.
+ */
+export interface UiContextSelector {
+    contextId?: string | null;
+    contextKind: UiContextKind;
+}
+export interface TextMatch {
+    caseSensitive?: boolean;
+    mode?: "exact" | "contains";
+    value: string;
+}
+/**
+ * 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/tap-element-result.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.
+ */
+export type UiContextKind = "native" | "web";
+export interface TapElementResult {
+    element: UiNodeRef;
+}
+/**
+ * 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;
+}