@rynx-ai/server 0.1.0 → 0.1.10-beta.2

package/dist/direct-runtime-browser-surface-server.d.ts

@@ -0,0 +1,74 @@
+import type { Server as HttpServer } from "node:http";
+import { DIRECT_RUNTIME_BROWSER_SURFACE_PATH } from "@rynx-ai/protocol/direct-runtime";
+import { type RuntimeBrowserSurfaceClientFrame, type RuntimeBrowserSurfaceClosedReason, type RuntimeBrowserSurfaceDriverChangedFrame, type RuntimeBrowserSurfaceImageFrame, type RuntimeBrowserSurfaceOpenFrame, type RuntimeBrowserSurfaceReadyFrame } from "@rynx-ai/protocol/runtime-browser-surface";
+import { WebSocket } from "ws";
+import type { DirectRuntimeAuthenticator, DirectRuntimePeer } from "./direct-runtime-server.js";
+type SurfaceClientControlFrame = Exclude<RuntimeBrowserSurfaceClientFrame, RuntimeBrowserSurfaceOpenFrame>;
+export type DirectRuntimeBrowserSurfaceAttachmentEvent = RuntimeBrowserSurfaceDriverChangedFrame | {
+    type: "browser.surface.closed";
+    subscriptionId: string;
+    reason: RuntimeBrowserSurfaceClosedReason;
+    message?: string;
+} | RuntimeBrowserSurfaceImageFrame;
+export type DirectRuntimeBrowserSurfaceTransportCloseReason = "client_closed" | "transport_error" | "grant_revoked" | "server_shutdown";
+/** Capture and driver coordination stay behind this transport-only boundary. */
+export interface DirectRuntimeBrowserSurfaceAttachment {
+    readonly ready: RuntimeBrowserSurfaceReadyFrame;
+    readonly events: AsyncIterable<DirectRuntimeBrowserSurfaceAttachmentEvent>;
+    handle(frame: SurfaceClientControlFrame): void | Promise<void>;
+    close(reason: DirectRuntimeBrowserSurfaceTransportCloseReason): void | Promise<void>;
+}
+export interface DirectRuntimeBrowserSurfaceHost {
+    open(frame: RuntimeBrowserSurfaceOpenFrame, context: {
+        peer: DirectRuntimePeer;
+        signal: AbortSignal;
+    }): DirectRuntimeBrowserSurfaceAttachment | Promise<DirectRuntimeBrowserSurfaceAttachment>;
+}
+export declare class DirectRuntimeBrowserSurfaceHostError extends Error {
+    readonly reason: RuntimeBrowserSurfaceClosedReason;
+    constructor(reason: RuntimeBrowserSurfaceClosedReason, message: string, options?: ErrorOptions);
+}
+export interface DirectRuntimeBrowserSurfaceServerLimits {
+    authenticationTimeoutMs: number;
+    maxConnections: number;
+    maxUnauthenticatedConnectionsPerSource: number;
+    maxAuthenticationAttemptsPerSource: number;
+    authenticationAttemptWindowMs: number;
+    maxTrackedAuthenticationSources: number;
+    maxConnectionsPerGrant: number;
+    maxQueuedFrames: number;
+    maxBufferedBytes: number;
+    heartbeatIntervalMs: number;
+    peerLivenessTimeoutMs: number;
+    shutdownDeadlineMs: number;
+}
+export interface DirectRuntimeBrowserSurfaceConnectionHub {
+    registerWithinLimit(grantId: string, connection: {
+        ws: WebSocket;
+        close(code: number, reason: string): void;
+    }, maxConnections: number): "registered" | "revoked" | "capacity";
+    unregister(connection: {
+        ws: WebSocket;
+        close(code: number, reason: string): void;
+    }): void;
+}
+export interface AttachDirectRuntimeBrowserSurfaceServerOptions {
+    e2ee: {
+        serverPublicKey: string;
+        deriveSharedSecret(clientEphemeralPublicKey: string): Uint8Array;
+    };
+    authenticator: DirectRuntimeAuthenticator;
+    host: DirectRuntimeBrowserSurfaceHost;
+    isPeerActive(peer: DirectRuntimePeer): boolean | Promise<boolean>;
+    connectionHub: DirectRuntimeBrowserSurfaceConnectionHub;
+    limits?: Partial<DirectRuntimeBrowserSurfaceServerLimits>;
+    onError?: (error: unknown, context: string) => void;
+}
+export interface DirectRuntimeBrowserSurfaceServer {
+    readonly path: typeof DIRECT_RUNTIME_BROWSER_SURFACE_PATH;
+    readonly activeConnectionCount: number;
+    shutdown(): Promise<void>;
+}
+/** Attach only the V3 Browser Surface route to an existing Direct HTTP server. */
+export declare function attachDirectRuntimeBrowserSurfaceServer(server: HttpServer, options: AttachDirectRuntimeBrowserSurfaceServerOptions): DirectRuntimeBrowserSurfaceServer;
+export {};