@devicerail/protocol 0.1.0

package/dist/generated/v1/device-connect-response.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DeviceConnectResponse = DeviceConnectSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type Platform = {
+    kind: "web";
+    [k: string]: unknown;
+} | {
+    kind: "android";
+    [k: string]: unknown;
+} | {
+    kind: "ios";
+    [k: string]: unknown;
+} | {
+    kind: "harmonyOs";
+    [k: string]: unknown;
+} | {
+    kind: "macOs";
+    [k: string]: unknown;
+} | {
+    kind: "windows";
+    [k: string]: unknown;
+} | {
+    kind: "linux";
+    [k: string]: unknown;
+} | {
+    kind: "rdp";
+    [k: string]: unknown;
+} | {
+    kind: "mock";
+    [k: string]: unknown;
+} | {
+    kind: "other";
+    value: string;
+    [k: string]: unknown;
+};
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface DeviceConnectSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: DeviceInfo;
+}
+export interface DeviceInfo {
+    connected: boolean;
+    id: string;
+    name: string;
+    osVersion?: string | null;
+    platform: Platform;
+    [k: string]: unknown;
+}
+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/device-connect-result.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 Platform = {
+    kind: "web";
+    [k: string]: unknown;
+} | {
+    kind: "android";
+    [k: string]: unknown;
+} | {
+    kind: "ios";
+    [k: string]: unknown;
+} | {
+    kind: "harmonyOs";
+    [k: string]: unknown;
+} | {
+    kind: "macOs";
+    [k: string]: unknown;
+} | {
+    kind: "windows";
+    [k: string]: unknown;
+} | {
+    kind: "linux";
+    [k: string]: unknown;
+} | {
+    kind: "rdp";
+    [k: string]: unknown;
+} | {
+    kind: "mock";
+    [k: string]: unknown;
+} | {
+    kind: "other";
+    value: string;
+    [k: string]: unknown;
+};
+export interface DeviceConnectResult {
+    connected: boolean;
+    id: string;
+    name: string;
+    osVersion?: string | null;
+    platform: Platform;
+    [k: string]: unknown;
+}

package/dist/generated/v1/device-disconnect-request.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.
+ */
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type DeviceDisconnectMethodSchema = "device.disconnect";
+export type NoParamsSchema = EmptyParamsObjectSchema | [];
+/**
+ * A positive timeout in milliseconds that is safe to represent as a JSON
+ * number in every supported client language.
+ */
+export type RequestTimeoutMs = number;
+export interface DeviceDisconnectRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: DeviceDisconnectMethodSchema;
+    params?: NoParamsSchema;
+    timeoutMs?: RequestTimeoutMs;
+}
+export type EmptyParamsObjectSchema = Record<string, never>;

package/dist/generated/v1/device-disconnect-response.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DeviceDisconnectResponse = DeviceDisconnectSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface DeviceDisconnectSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: DeviceDisconnectResult;
+}
+/**
+ * Result returned by `device.disconnect`.
+ */
+export interface DeviceDisconnectResult {
+    disconnected: boolean;
+}
+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/device-disconnect-result.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.
+ */
+/**
+ * Result returned by `device.disconnect`.
+ */
+export interface DeviceDisconnectResult {
+    disconnected: boolean;
+}

package/dist/generated/v1/device-execute-params.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.
+ */
+/**
+ * A positive timeout in milliseconds that is safe to represent as a JSON
+ * number in every supported client language.
+ */
+export type RequestTimeoutMs = number;
+/**
+ * Parameters for `device.execute`.
+ *
+ * The action fields intentionally remain flat on the wire. The optional
+ * timeout controls only the Driver action, while the request envelope timeout
+ * controls the request-scoped device-operation budget. Durable terminal event
+ * finalization is shielded so cancellation cannot leave a half-open Action.
+ */
+export interface DeviceExecuteParams {
+    actionTimeoutMs?: RequestTimeoutMs;
+    arguments?: unknown;
+    id: string;
+    name: string;
+}

package/dist/generated/v1/device-execute-request.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 DeviceExecuteMethodSchema = "device.execute";
+/**
+ * A positive timeout in milliseconds that is safe to represent as a JSON
+ * number in every supported client language.
+ */
+export type RequestTimeoutMs = number;
+export interface DeviceExecuteRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: DeviceExecuteMethodSchema;
+    params: DeviceExecuteParams;
+    timeoutMs?: RequestTimeoutMs;
+}
+/**
+ * Parameters for `device.execute`.
+ *
+ * The action fields intentionally remain flat on the wire. The optional
+ * timeout controls only the Driver action, while the request envelope timeout
+ * controls the request-scoped device-operation budget. Durable terminal event
+ * finalization is shielded so cancellation cannot leave a half-open Action.
+ */
+export interface DeviceExecuteParams {
+    actionTimeoutMs?: RequestTimeoutMs;
+    arguments?: unknown;
+    id: string;
+    name: string;
+}

package/dist/generated/v1/device-execute-response.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DeviceExecuteResponse = DeviceExecuteSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+export type ActionExecution = {
+    context: UiContextRef;
+    mode: "nativeSemantic";
+} | {
+    context: UiContextRef;
+    mode: "webSemantic";
+} | {
+    context: UiContextRef;
+    fallbackReason: CoordinateFallbackReason;
+    mode: "coordinateFallback";
+};
+export type CoordinateFallbackReason = "semanticInteractionUnavailable" | "platformLimitation";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface DeviceExecuteSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: ActionResult;
+}
+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 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;
+}
+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/device-execute-result.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+export type ActionExecution = {
+    context: UiContextRef;
+    mode: "nativeSemantic";
+} | {
+    context: UiContextRef;
+    mode: "webSemantic";
+} | {
+    context: UiContextRef;
+    fallbackReason: CoordinateFallbackReason;
+    mode: "coordinateFallback";
+};
+export type CoordinateFallbackReason = "semanticInteractionUnavailable" | "platformLimitation";
+export interface DeviceExecuteResult {
+    after?: Observation | null;
+    before?: Observation | null;
+    callId: string;
+    evidence?: AssetRef[];
+    execution?: ActionExecution | null;
+    finishedAtMs: number;
+    output: unknown;
+    startedAtMs: number;
+    [k: string]: 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;
+}

package/dist/generated/v1/device-id.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 DeviceId = string;

package/dist/generated/v1/device-info.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 Platform = {
+    kind: "web";
+    [k: string]: unknown;
+} | {
+    kind: "android";
+    [k: string]: unknown;
+} | {
+    kind: "ios";
+    [k: string]: unknown;
+} | {
+    kind: "harmonyOs";
+    [k: string]: unknown;
+} | {
+    kind: "macOs";
+    [k: string]: unknown;
+} | {
+    kind: "windows";
+    [k: string]: unknown;
+} | {
+    kind: "linux";
+    [k: string]: unknown;
+} | {
+    kind: "rdp";
+    [k: string]: unknown;
+} | {
+    kind: "mock";
+    [k: string]: unknown;
+} | {
+    kind: "other";
+    value: string;
+    [k: string]: unknown;
+};
+export interface DeviceInfo {
+    connected: boolean;
+    id: string;
+    name: string;
+    osVersion?: string | null;
+    platform: Platform;
+    [k: string]: unknown;
+}

package/dist/generated/v1/device-observe-request.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.
+ */
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type DeviceObserveMethodSchema = "device.observe";
+export type NoParamsSchema = EmptyParamsObjectSchema | [];
+/**
+ * A positive timeout in milliseconds that is safe to represent as a JSON
+ * number in every supported client language.
+ */
+export type RequestTimeoutMs = number;
+export interface DeviceObserveRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: DeviceObserveMethodSchema;
+    params?: NoParamsSchema;
+    timeoutMs?: RequestTimeoutMs;
+}
+export type EmptyParamsObjectSchema = Record<string, never>;

package/dist/generated/v1/device-observe-response.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DeviceObserveResponse = DeviceObserveSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface DeviceObserveSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: Observation;
+}
+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;
+}
+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/device-observe-result.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 ScreenshotOmissionReason = "policy" | "protectedAction";
+export type UiContextKind = "native" | "web";
+export type UiSnapshotOmissionReason = "driverUnsupported" | "policy" | "protectedAction";
+export interface DeviceObserveResult {
+    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;
+}

package/dist/generated/v1/device-select-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.
+ */
+/**
+ * Parameters accepted by `device.select`.
+ */
+export interface DeviceSelectParams {
+    deviceId: string;
+}

package/dist/generated/v1/device-select-request.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 DeviceSelectMethodSchema = "device.select";
+export interface DeviceSelectRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: DeviceSelectMethodSchema;
+    params: DeviceSelectParams;
+}
+/**
+ * Parameters accepted by `device.select`.
+ */
+export interface DeviceSelectParams {
+    deviceId: string;
+}