@devicerail/protocol 0.1.0

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

@@ -0,0 +1,75 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DeviceSelectResponse = DeviceSelectSuccessSchema | 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 DeviceSelectSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: DeviceSelectResult;
+}
+/**
+ * Result returned by `device.select`.
+ */
+export interface DeviceSelectResult {
+    device: 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-select-result.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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;
+};
+/**
+ * Result returned by `device.select`.
+ */
+export interface DeviceSelectResult {
+    device: DeviceInfo;
+}
+export interface DeviceInfo {
+    connected: boolean;
+    id: string;
+    name: string;
+    osVersion?: string | null;
+    platform: Platform;
+    [k: string]: unknown;
+}

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

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

@@ -0,0 +1,76 @@
+/**
+ * Generated from the checked-in DeviceRail JSON Schema. DO NOT EDIT.
+ * Run `pnpm protocol:types:generate` from the repository root.
+ */
+export type DevicesListResponse = DevicesListSuccessSchema | 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 DevicesListSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: DevicesListResult;
+}
+/**
+ * Result returned by `devices.list`.
+ */
+export interface DevicesListResult {
+    devices: DeviceInfo[];
+    selectedDeviceId?: string | null;
+}
+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/devices-list-result.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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;
+};
+/**
+ * Result returned by `devices.list`.
+ */
+export interface DevicesListResult {
+    devices: DeviceInfo[];
+    selectedDeviceId?: string | null;
+}
+export interface DeviceInfo {
+    connected: boolean;
+    id: string;
+    name: string;
+    osVersion?: string | null;
+    platform: Platform;
+    [k: string]: unknown;
+}

package/dist/generated/v1/element-selector.d.ts

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

package/dist/generated/v1/element-target.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 ElementTarget = {
+    kind: "selector";
+    selector: ElementSelector;
+} | {
+    kind: "node";
+    node: UiNodeRef;
+};
+export type UiContextKind = "native" | "web";
+/**
+ * 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/error-info.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 ErrorInfo {
+    code: string;
+    details?: unknown;
+    message: string;
+    retryable: boolean;
+}

package/dist/generated/v1/event-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 EventId = string;

package/dist/generated/v1/event-sequence.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.
+ */
+/**
+ * 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;

package/dist/generated/v1/event-stream-cursor.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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;
+/**
+ * Identifies one daemon process lifetime. A cursor from another epoch must
+ * never be accepted as a resumable position.
+ */
+export type EventStreamEpoch = string;
+/**
+ * A Session-scoped, daemon-epoch-scoped application acknowledgement.
+ */
+export interface EventStreamCursor {
+    sequence: EventSequence;
+    sessionId: string;
+    streamEpoch: EventStreamEpoch;
+}

package/dist/generated/v1/event-stream-endpoint.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.
+ */
+/**
+ * A short-lived bearer URL. Debug intentionally never exposes its contents.
+ */
+export type EventStreamEndpoint = string;

package/dist/generated/v1/event-stream-epoch.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.
+ */
+/**
+ * Identifies one daemon process lifetime. A cursor from another epoch must
+ * never be accepted as a resumable position.
+ */
+export type EventStreamEpoch = string;

package/dist/generated/v1/event-stream-origin-policy.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.
+ */
+/**
+ * Browser Origin policy bound to a single-use stream capability.
+ */
+export type EventStreamOriginPolicy = {
+    kind: "absent";
+} | {
+    kind: "exact";
+    origin: string;
+};

package/dist/generated/v1/event-subscription-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 EventSubscriptionId = string;

package/dist/generated/v1/events-clear-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 EventsClearMethodSchema = "events.clear";
+export interface EventsClearRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: EventsClearMethodSchema;
+    params?: SessionTargetParams;
+}
+/**
+ * Optional session selector accepted by `events.clear`.
+ */
+export interface SessionTargetParams {
+    sessionId?: string | null;
+}

package/dist/generated/v1/events-clear-response.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 EventsClearResponse = EventsClearSuccessSchema | SystemHelloFailureSchema;
+export type RpcIdSchema = string | number;
+export type JsonRpcVersion = "2.0";
+export type NullableRpcIdSchema = RpcIdSchema | null;
+export interface EventsClearSuccessSchema {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    result: EventsClearResult;
+}
+/**
+ * Result returned by `events.clear`.
+ */
+export interface EventsClearResult {
+    deleted: boolean;
+    sessionId: 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/events-clear-result.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.
+ */
+/**
+ * Result returned by `events.clear`.
+ */
+export interface EventsClearResult {
+    deleted: boolean;
+    sessionId: string;
+}

package/dist/generated/v1/events-list-params.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.
+ */
+/**
+ * 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;
+/**
+ * Optional parameters accepted by `events.list`.
+ */
+export interface EventsListParams {
+    afterSequence?: EventSequence | null;
+    limit?: number | null;
+    sessionId?: string | null;
+}

package/dist/generated/v1/events-list-request.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 EventsListMethodSchema = "events.list";
+/**
+ * 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 interface EventsListRequest {
+    id: RpcIdSchema;
+    jsonrpc: JsonRpcVersion;
+    method: EventsListMethodSchema;
+    params?: EventsListParams;
+}
+/**
+ * Optional parameters accepted by `events.list`.
+ */
+export interface EventsListParams {
+    afterSequence?: EventSequence | null;
+    limit?: number | null;
+    sessionId?: string | null;
+}