@devicerail/protocol 0.1.0

package/dist/generated/v1/media-stream-start-request.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 RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type MediaStreamStartMethodSchema = "media.stream.start";
+export type MediaStreamKind = "screenshot" | "video";
+export interface MediaStreamStartRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: MediaStreamStartMethodSchema;
+    params: MediaStreamStartParams;
+}
+/**
+ * Parameters accepted by `media.stream.start`.
+ *
+ * The caller chooses only a lifetime-unique stream identifier and the logical
+ * stream kind. The daemon assigns the media type from its selected, leased
+ * device producer; viewport metadata may be absent. This control method never
+ * accepts frame bytes, Evidence references, or filesystem paths.
+ */
+export interface MediaStreamStartParams {
+    kind: MediaStreamKind;
+    streamId: string;
+}

package/dist/generated/v1/media-stream-start-response.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type MediaStreamStartResponse = MediaStreamStartSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type MediaStreamKind = "screenshot" | "video";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface MediaStreamStartSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: MediaStreamStartResult;
+}
+/**
+ * Result returned by `media.stream.start`.
+ */
+export interface MediaStreamStartResult {
+    stream: MediaStreamInfo;
+}
+export interface MediaStreamInfo {
+    id: string;
+    kind: MediaStreamKind;
+    mediaType: string;
+    viewport?: Viewport | null;
+}
+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/media-stream-start-result.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 MediaStreamKind = "screenshot" | "video";
+/**
+ * Result returned by `media.stream.start`.
+ */
+export interface MediaStreamStartResult {
+    stream: MediaStreamInfo;
+}
+export interface MediaStreamInfo {
+    id: string;
+    kind: MediaStreamKind;
+    mediaType: string;
+    viewport?: Viewport | null;
+}
+export interface Viewport {
+    height: number;
+    scaleFactor: number;
+    width: number;
+    [k: string]: unknown;
+}

package/dist/generated/v1/method-map.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+import type { DeviceCapabilitiesRequest } from "./device-capabilities-request.js";
+import type { DeviceCapabilitiesResponse } from "./device-capabilities-response.js";
+import type { DeviceConnectRequest } from "./device-connect-request.js";
+import type { DeviceConnectResponse } from "./device-connect-response.js";
+import type { DeviceDisconnectRequest } from "./device-disconnect-request.js";
+import type { DeviceDisconnectResponse } from "./device-disconnect-response.js";
+import type { DeviceExecuteRequest } from "./device-execute-request.js";
+import type { DeviceExecuteResponse } from "./device-execute-response.js";
+import type { DeviceObserveRequest } from "./device-observe-request.js";
+import type { DeviceObserveResponse } from "./device-observe-response.js";
+import type { DeviceSelectRequest } from "./device-select-request.js";
+import type { DeviceSelectResponse } from "./device-select-response.js";
+import type { DevicesListRequest } from "./devices-list-request.js";
+import type { DevicesListResponse } from "./devices-list-response.js";
+import type { EventsClearRequest } from "./events-clear-request.js";
+import type { EventsClearResponse } from "./events-clear-response.js";
+import type { EventsListRequest } from "./events-list-request.js";
+import type { EventsListResponse } from "./events-list-response.js";
+import type { EventsStreamOpenRequest } from "./events-stream-open-request.js";
+import type { EventsStreamOpenResponse } from "./events-stream-open-response.js";
+import type { EventsSubscribeRequest } from "./events-subscribe-request.js";
+import type { EventsSubscribeResponse } from "./events-subscribe-response.js";
+import type { MediaStreamCaptureRequest } from "./media-stream-capture-request.js";
+import type { MediaStreamCaptureResponse } from "./media-stream-capture-response.js";
+import type { MediaStreamEndRequest } from "./media-stream-end-request.js";
+import type { MediaStreamEndResponse } from "./media-stream-end-response.js";
+import type { MediaStreamStartRequest } from "./media-stream-start-request.js";
+import type { MediaStreamStartResponse } from "./media-stream-start-response.js";
+import type { RequestCancelRequest } from "./request-cancel-request.js";
+import type { RequestCancelResponse } from "./request-cancel-response.js";
+import type { SessionCurrentRequest } from "./session-current-request.js";
+import type { SessionCurrentResponse } from "./session-current-response.js";
+import type { SessionEndRequest } from "./session-end-request.js";
+import type { SessionEndResponse } from "./session-end-response.js";
+import type { SessionExportRequest } from "./session-export-request.js";
+import type { SessionExportResponse } from "./session-export-response.js";
+import type { SessionStartRequest } from "./session-start-request.js";
+import type { SessionStartResponse } from "./session-start-response.js";
+import type { SessionsListRequest } from "./sessions-list-request.js";
+import type { SessionsListResponse } from "./sessions-list-response.js";
+import type { SystemDescribeRequest } from "./system-describe-request.js";
+import type { SystemDescribeResponse } from "./system-describe-response.js";
+import type { SystemHelloRequest } from "./system-hello-request.js";
+import type { SystemHelloResponse } from "./system-hello-response.js";
+import type { UiSnapshotGetRequest } from "./ui-snapshot-get-request.js";
+import type { UiSnapshotGetResponse } from "./ui-snapshot-get-response.js";
+import type { VerdictRecordRequest } from "./verdict-record-request.js";
+import type { VerdictRecordResponse } from "./verdict-record-response.js";
+export interface RpcMethodMap {
+    "device.capabilities": {
+        request: DeviceCapabilitiesRequest;
+        response: DeviceCapabilitiesResponse;
+    };
+    "device.connect": {
+        request: DeviceConnectRequest;
+        response: DeviceConnectResponse;
+    };
+    "device.disconnect": {
+        request: DeviceDisconnectRequest;
+        response: DeviceDisconnectResponse;
+    };
+    "device.execute": {
+        request: DeviceExecuteRequest;
+        response: DeviceExecuteResponse;
+    };
+    "device.observe": {
+        request: DeviceObserveRequest;
+        response: DeviceObserveResponse;
+    };
+    "device.select": {
+        request: DeviceSelectRequest;
+        response: DeviceSelectResponse;
+    };
+    "devices.list": {
+        request: DevicesListRequest;
+        response: DevicesListResponse;
+    };
+    "events.clear": {
+        request: EventsClearRequest;
+        response: EventsClearResponse;
+    };
+    "events.list": {
+        request: EventsListRequest;
+        response: EventsListResponse;
+    };
+    "events.stream.open": {
+        request: EventsStreamOpenRequest;
+        response: EventsStreamOpenResponse;
+    };
+    "events.subscribe": {
+        request: EventsSubscribeRequest;
+        response: EventsSubscribeResponse;
+    };
+    "media.stream.capture": {
+        request: MediaStreamCaptureRequest;
+        response: MediaStreamCaptureResponse;
+    };
+    "media.stream.end": {
+        request: MediaStreamEndRequest;
+        response: MediaStreamEndResponse;
+    };
+    "media.stream.start": {
+        request: MediaStreamStartRequest;
+        response: MediaStreamStartResponse;
+    };
+    "request.cancel": {
+        request: RequestCancelRequest;
+        response: RequestCancelResponse;
+    };
+    "session.current": {
+        request: SessionCurrentRequest;
+        response: SessionCurrentResponse;
+    };
+    "session.end": {
+        request: SessionEndRequest;
+        response: SessionEndResponse;
+    };
+    "session.export": {
+        request: SessionExportRequest;
+        response: SessionExportResponse;
+    };
+    "session.start": {
+        request: SessionStartRequest;
+        response: SessionStartResponse;
+    };
+    "sessions.list": {
+        request: SessionsListRequest;
+        response: SessionsListResponse;
+    };
+    "system.describe": {
+        request: SystemDescribeRequest;
+        response: SystemDescribeResponse;
+    };
+    "system.hello": {
+        request: SystemHelloRequest;
+        response: SystemHelloResponse;
+    };
+    "ui.snapshot.get": {
+        request: UiSnapshotGetRequest;
+        response: UiSnapshotGetResponse;
+    };
+    "verdict.record": {
+        request: VerdictRecordRequest;
+        response: VerdictRecordResponse;
+    };
+}
+export type RpcMethod = keyof RpcMethodMap;
+export type RpcRequestFor<M extends RpcMethod> = RpcMethodMap[M]["request"];
+export type RpcResponseFor<M extends RpcMethod> = RpcMethodMap[M]["response"];
+export type RpcParamsFor<M extends RpcMethod> = RpcRequestFor<M> extends {
+    params: infer P;
+} ? P : RpcRequestFor<M> extends {
+    params?: infer P;
+} ? P | undefined : undefined;
+export type RpcResultFor<M extends RpcMethod> = RpcResponseFor<M> extends infer Response ? Response extends {
+    result: infer Result;
+} ? Result : never : never;
+export type RpcSupportsTimeout<M extends RpcMethod> = "timeoutMs" extends keyof RpcRequestFor<M> ? true : false;

package/dist/generated/v1/observation.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 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/peer-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 PeerInfo {
+    name: string;
+    version: string;
+}

package/dist/generated/v1/platform.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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;
+};

package/dist/generated/v1/protocol-incompatibility-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 ProtocolIncompatibilityReason = "clientTooOld" | "serverTooOld" | "noCommonVersion";

package/dist/generated/v1/protocol-offer.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.
+ */
+/**
+ * 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/protocol-range.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.
+ */
+/**
+ * A contiguous minor-version range within one protocol major version.
+ */
+export interface ProtocolRange {
+    major: number;
+    maxMinor: number;
+    minMinor: number;
+}

package/dist/generated/v1/protocol-selection.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export interface ProtocolSelection {
+    selected: ProtocolVersion;
+}
+export interface ProtocolVersion {
+    major: number;
+    minor: number;
+}

package/dist/generated/v1/protocol-version.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 ProtocolVersion {
+    major: number;
+    minor: number;
+}

package/dist/generated/v1/recorded-action-call.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+/**
+ * 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;
+}

package/dist/generated/v1/request-cancel-params.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 type RpcIdSchema = string | number;
+export interface RequestCancelParams {
+    requestId: RpcIdSchema;
+}

package/dist/generated/v1/request-cancel-request.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 RequestCancelMethodSchema = "request.cancel";
+export interface RequestCancelRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: RequestCancelMethodSchema;
+    params: RequestCancelParams;
+}
+export interface RequestCancelParams {
+    requestId: RpcIdSchema;
+}

package/dist/generated/v1/request-cancel-response.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type RequestCancelResponse = RequestCancelSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type RequestCancelStatus = "requested" | "alreadyRequested" | "notFound";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface RequestCancelSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: RequestCancelResult;
+}
+export interface RequestCancelResult {
+    requestId: RpcIdSchema;
+    status: RequestCancelStatus;
+}
+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/request-cancel-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.
+ */
+export type RpcIdSchema = string | number;
+export type RequestCancelStatus = "requested" | "alreadyRequested" | "notFound";
+export interface RequestCancelResult {
+    requestId: RpcIdSchema;
+    status: RequestCancelStatus;
+}

package/dist/generated/v1/request-cancel-status.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 RequestCancelStatus = "requested" | "alreadyRequested" | "notFound";

package/dist/generated/v1/request-timeout-ms.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.
+ */
+/**
+ * A positive timeout in milliseconds that is safe to represent as a JSON
+ * number in every supported client language.
+ */
+export type RequestTimeoutMs = number;

package/dist/generated/v1/rpc-error.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 interface RpcError {
+    code: number;
+    data: ErrorInfo;
+    message: string;
+}
+export interface ErrorInfo {
+    code: string;
+    details?: unknown;
+    message: string;
+    retryable: boolean;
+}

package/dist/generated/v1/rpc-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 RpcId = string | number;

package/dist/generated/v1/rpc-params.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type RpcParams = {
+    [k: string]: unknown;
+} | unknown[];

package/dist/generated/v1/rpc-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 RpcParams = {
+    [k: string]: unknown;
+} | unknown[];
+/**
+ * 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 RpcRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: string;
+    params?: RpcParams;
+    timeoutMs?: RequestTimeoutMs;
+}

package/dist/generated/v1/rpc-response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type RpcResponse = RpcSuccessSchema | RpcFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface RpcSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: unknown;
+}
+export interface RpcFailureSchema {
+    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;
+}