ClawX/shared/types/gateway.ts

/**
 * Gateway Type Definitions
 * Types for Gateway communication and data structures
 */

export type GatewayRuntimeJsonValue =
  | string
  | number
  | boolean
  | null
  | GatewayRuntimeJsonValue[]
  | { [key: string]: GatewayRuntimeJsonValue | undefined };

export type GatewayRuntimePayload = GatewayRuntimeJsonValue | undefined;
export type GatewayRuntimeRecord = { [key: string]: GatewayRuntimeJsonValue | undefined };

/**
 * Gateway connection status
 */
export interface GatewayStatus {
  state: 'stopped' | 'starting' | 'running' | 'error' | 'reconnecting';
  port: number;
  pid?: number;
  uptime?: number;
  error?: string;
  connectedAt?: number;
  version?: string;
  reconnectAttempts?: number;
  /** True once the gateway's internal subsystems (skills, plugins) are ready for RPC calls. */
  gatewayReady?: boolean;
}

/**
 * Gateway RPC response
 */
export interface GatewayRpcResponse<T = unknown> {
  success: boolean;
  result?: T;
  error?: string;
}

/**
 * Gateway health check response
 */
export interface GatewayCapabilityProbe {
  state: 'unknown' | 'healthy' | 'degraded';
  checkedAt?: number;
  durationMs?: number;
  error?: string;
  payload?: GatewayRuntimePayload;
}

export interface GatewayCapabilitySnapshot {
  core: {
    process: GatewayStatus['state'];
    transport: 'connected' | 'disconnected';
    rpcRouter: 'unknown' | 'ready' | 'blocked';
    lastProbe?: {
      ok: boolean;
      checkedAt: number;
      durationMs?: number;
      error?: string;
    };
  };
  openclawHealth: GatewayCapabilityProbe;
  openclawStatus: GatewayCapabilityProbe;
  presence: GatewayCapabilityProbe;
  channels: GatewayCapabilityProbe;
  memory: GatewayCapabilityProbe;
  diagnostics: {
    lastAliveAt?: number;
    lastRpcSuccessAt?: number;
    lastRpcFailureAt?: number;
    lastRpcFailureMethod?: string;
    lastHeartbeatTimeoutAt?: number;
    consecutiveHeartbeatMisses: number;
    lastSocketCloseAt?: number;
    lastSocketCloseCode?: number;
    consecutiveRpcFailures: number;
  };
}

export interface GatewayHealth {
  ok: boolean;
  error?: string;
  uptime?: number;
  version?: string;
  capabilities?: GatewayCapabilitySnapshot;
  openclawHealth?: GatewayRuntimePayload;
  presence?: GatewayRuntimePayload;
}

/**
 * Gateway notification (server-initiated event)
 */
export interface GatewayNotification {
  method: string;
  params?: GatewayRuntimePayload;
}

/**
 * Provider configuration
 */
export interface ProviderConfig {
  id: string;
  name: string;
  type: 'openai' | 'anthropic' | 'ollama' | 'custom';
  apiKey?: string;
  baseUrl?: string;
  model?: string;
  enabled: boolean;
}