orca/src/preload/api/runtime-api.ts

import type {
  CrewSubscriptionAttemptArgs,
  CrewSubscriptionAttemptCallbacks,
  CrewSubscriptionSetupResult
} from '../../shared/remote-runtime/host-catalog/runtime-environment-subscription-setup'
import type { ManagedOrcadPreloadApi } from './managed-orcad-api'
import type { WslHostsPreloadApi } from './wsl-hosts-api'
import type { RuntimeHostStatusSnapshot } from '../../shared/remote-runtime/host-status/runtime-host-status'
import type {
  RuntimeBrowserDriverState,
  RuntimeRendererSyncWindowGraph,
  RuntimeStatus,
  RuntimeSyncWindowGraphResult,
  RuntimeTerminalDriverState
} from '../../shared/runtime-types'
import type { RuntimeRpcResponse } from '../../shared/runtime-rpc-envelope'
import type { ClientHostedBrowserRowsEvent } from '../../shared/client-hosted-browser-rows'
import type { SidebarInputsChangedEvent } from '../../shared/sidebar-list/sidebar-inputs-feed-contract'
import type {
  PublicKnownRuntimeEnvironment,
  RuntimeEnvironmentRemoval
} from '../../shared/remote-runtime/host-catalog/runtime-environments'
import type { VerifyAndAddRuntimeEnvironmentResult } from '../../shared/remote-runtime/pairing/remote-pairing-verification'
import type {
  BrowserClientHostPlacementPreparationRequest,
  BrowserPageCreationPlacement
} from '../../shared/browser/client-hosting/browser-client-host-placement'
import type { RemoteRuntimeSharedConnectionDiagnostics } from '../../shared/remote-runtime/control/remote-runtime-shared-control-types'
import type { WslOrcadAccountNotAppliedEvent } from '../../shared/wsl-orcad-account-notice'

export type RuntimeEnvironmentSubscriptionHandle = {
  unsubscribe: () => void
  sendBinary: (bytes: Uint8Array<ArrayBufferLike>) => void
}

export type RuntimeApi = {
  runtime: {
    syncWindowGraph: (
      graph: RuntimeRendererSyncWindowGraph
    ) => Promise<RuntimeSyncWindowGraphResult>
    getStatus: () => Promise<RuntimeStatus>
    call: (args: { method: string; params?: unknown }) => Promise<RuntimeRpcResponse<unknown>>
    subscribe: (
      args: { method: string; params?: unknown },
      callback: (response: RuntimeRpcResponse<unknown>) => void
    ) => Promise<RuntimeEnvironmentSubscriptionHandle>
    getTerminalFitOverrides: () => Promise<
      { ptyId: string; mode: 'mobile-fit' | 'remote-desktop-fit'; cols: number; rows: number }[]
    >
    getTerminalDrivers: () => Promise<
      {
        ptyId: string
        driver: RuntimeTerminalDriverState
      }[]
    >
    getBrowserDrivers: () => Promise<
      {
        browserPageId: string
        driver: RuntimeBrowserDriverState
      }[]
    >
    getBrowserRemoteViewerPages?: () => Promise<string[]>
    getClientHostedBrowserRows: () => Promise<ClientHostedBrowserRowsEvent[]>
    restoreTerminalFit: (ptyId: string) => Promise<{ restored: boolean }>
    reclaimBrowserForDesktop: (browserPageId: string) => Promise<{ reclaimed: boolean }>
    onTerminalFitOverrideChanged: (
      callback: (event: {
        ptyId: string
        mode: 'mobile-fit' | 'remote-desktop-fit' | 'desktop-fit'
        cols: number
        rows: number
      }) => void
    ) => () => void
    onTerminalDriverChanged: (
      callback: (event: { ptyId: string; driver: RuntimeTerminalDriverState }) => void
    ) => () => void
    onNativeChatLaunchDraftResolved?: (
      callback: (event: { tabId: string; text: string; createdAt: number }) => void
    ) => () => void
    onBrowserDriverChanged: (
      callback: (event: { browserPageId: string; driver: RuntimeBrowserDriverState }) => void
    ) => () => void
    // Older preloads lack this signal.
    onBrowserRemoteViewersChanged?: (
      callback: (event: { browserPageId: string; hasRemoteViewers: boolean }) => void
    ) => () => void
    onClientHostedBrowserRowsChanged: (
      callback: (event: ClientHostedBrowserRowsEvent) => void
    ) => () => void
    onSidebarInputsChanged: (callback: (event: SidebarInputsChangedEvent) => void) => () => void
  }
  runtimeEnvironments: {
    desktopCreatedChatIds?: () => Promise<string[]>
    getStatusSnapshots: () => Promise<RuntimeHostStatusSnapshot[]>
    onStatusChanged: (callback: (snapshot: RuntimeHostStatusSnapshot) => void) => () => void
    // Absent in the web client, whose catalog lives in the browser rather than a CLI-editable file.
    onCatalogChanged?: (callback: () => void) => () => void
    list: () => Promise<PublicKnownRuntimeEnvironment[]>
    addFromPairingCode: (args: {
      name: string
      pairingCode: string
    }) => Promise<{ environment: PublicKnownRuntimeEnvironment }>
    verifyAndAddFromPairingCode: (args: {
      name: string
      pairingCode: string
      allowLoopback?: boolean
    }) => Promise<VerifyAndAddRuntimeEnvironmentResult>
    /** Replaces a revoked pairing in place; refuses a link for a different server. */
    repairFromPairingCode: (args: {
      selector: string
      pairingCode: string
    }) => Promise<VerifyAndAddRuntimeEnvironmentResult>
    resolve: (args: { selector: string }) => Promise<PublicKnownRuntimeEnvironment>
    remove: (args: { selector: string }) => Promise<RuntimeEnvironmentRemoval>
    disconnect: (args: {
      selector: string
    }) => Promise<{ disconnected: PublicKnownRuntimeEnvironment }>
    connect: (args: {
      selector: string
      timeoutMs?: number
    }) => Promise<RuntimeRpcResponse<RuntimeStatus>>
    getStatus: (args: {
      selector: string
      timeoutMs?: number
      observeOnly?: true
    }) => Promise<RuntimeRpcResponse<RuntimeStatus>>
    onSharedControlDiagnostics?: (
      callback: (event: {
        environmentId: string
        transportGeneration: number
        diagnostics: RemoteRuntimeSharedConnectionDiagnostics
      }) => void
    ) => () => void
    // Absent in the web client, which has no desktop account shim.
    onWslAccountNotApplied?: (
      callback: (event: WslOrcadAccountNotAppliedEvent) => void
    ) => () => void
    prepareBrowserClientHostPlacement: (
      args: BrowserClientHostPlacementPreparationRequest
    ) => Promise<BrowserPageCreationPlacement>
    // Resume/online events advance only pending shared-control reconnect timers.
    retryConnectionsNow?: () => Promise<void>
    call: (args: {
      selector: string
      method: string
      params?: unknown
      timeoutMs?: number
      expectedEnvironmentPairingRevision?: number
      expectedEnvironmentRuntimeId?: string
    }) => Promise<RuntimeRpcResponse<unknown>>
    subscribeCrewAttempt?: (
      args: CrewSubscriptionAttemptArgs,
      callbacks: CrewSubscriptionAttemptCallbacks
    ) => Promise<CrewSubscriptionSetupResult>
    cancelSubscription: (args: { subscriptionId: string }) => Promise<void>
    subscribe: (
      args: {
        subscriptionId?: string
        selector: string
        method: string
        params?: unknown
        timeoutMs?: number
        expectedEnvironmentPairingRevision?: number
        expectedEnvironmentRuntimeId?: string
      },
      callbacks: {
        onResponse: (response: RuntimeRpcResponse<unknown>) => void
        onBinary?: (bytes: Uint8Array<ArrayBufferLike>) => void
        onError?: (error: { code: string; message: string }) => void
        onClose?: () => void
      }
    ) => Promise<RuntimeEnvironmentSubscriptionHandle>
    // Only desktop clients deploy servers over SSH.
    managedOrcad?: ManagedOrcadPreloadApi
    // Only Windows desktops (or e2e fakes) host WSL distros.
    wslHosts?: WslHostsPreloadApi
  }
  wsl: {
    isAvailable: () => Promise<boolean>
    listDistros: () => Promise<string[]>
  }
  pwsh: {
    isAvailable: () => Promise<boolean>
  }
  gitBash: {
    isAvailable: () => Promise<boolean>
  }
}