@oharness/server 0.9.3 → 0.11.0

package/dist/server.d.ts

@@ -3,7 +3,9 @@ import type { Session } from "@oharness/engine/agent/session.ts";
 import { Harness } from "@oharness/engine/harness.ts";
 import type { PermissionRequest } from "@oharness/engine/agent/permissions.ts";
 import type { QuestionRequest, QuestionResult } from "@oharness/engine/tools/questions.ts";
+import type { Message } from "@oharness/engine/core/types.ts";
 import type { SettingsScope } from "@oharness/engine/agent/settings.ts";
+import type { ComputerUsePlugin } from "@oharness/engine/computer/plugin.ts";
 import type { ScheduleRun } from "@oharness/engine/schedule/scheduler.ts";
 import type { BrowserTargetFactory, BrowserUsePlugin } from "@oharness/engine";
 /**
@@ -23,6 +25,29 @@ export interface WebServerOptions {
     port?: number;
     /** Defaults to loopback. Changing it publishes agent control to the network. */
     host?: string;
+    /**
+     * Remote control through a relay (remote.ts). The Mac dials out; a phone on
+     * the same account that this page has allowed can then drive it.
+     *
+     * Given, it makes remote control something this page offers: a switch in
+     * Settings, saved in prefs and off until somebody turns it on. Left out,
+     * there is no switch and nothing dials anywhere.
+     */
+    remote?: {
+        /** `wss://…/v1/connect` — `remoteRelay()` says which. */
+        relay: string;
+        /**
+         * On for this run whatever the setting says: a relay named in the
+         * environment, as remote control was switched on before it had a setting.
+         */
+        always?: boolean;
+        /**
+         * The account token presented to the relay, asked again on every
+         * reconnect. Defaults to OHARNESS_REMOTE_TOKEN, else the signed-in
+         * OHarness account.
+         */
+        token?: () => Promise<string | undefined>;
+    };
     /**
      * How the harness for another project is built.
      *
@@ -43,6 +68,24 @@ export interface WebServerOptions {
      */
     browserTarget?: BrowserTargetFactory;
     browserUsePlugin?: BrowserUsePlugin;
+    /**
+     * Computer Use, for the harnesses this server builds. Only the desktop app
+     * has one: it ships the native helper and holds the OS grants. Routines are
+     * never given it — a run nobody is watching does not get the screen.
+     */
+    computerUsePlugin?: ComputerUsePlugin;
+    /**
+     * Restart the app. macOS applies a Screen Recording grant only to a process
+     * started after it, so the permission card offers this once it is granted.
+     */
+    onRelaunch?: () => void;
+    /**
+     * The app macOS holds the grants for — the one the person has to switch on
+     * in System Settings. "OHarness" when packaged; a development run is
+     * Electron.app, and a card naming OHarness there sent people to a switch
+     * that was already on.
+     */
+    computerGrantee?: string;
     /**
      * Told when a turn starts waiting on a person — once, not again on a replay.
      * The desktop shell uses it to notify while its window is in the background;
@@ -103,10 +146,37 @@ export interface WebServer {
     }>;
     /** Answers `ask_user` from the page, the same way. */
     readonly questionPrompt: (request: QuestionRequest, signal: AbortSignal) => Promise<QuestionResult>;
+    /** Stop a conversation's running turn, as the page's stop button does. */
+    interrupt(sessionId: string): void;
 }
 export declare function startWebServer(opts: WebServerOptions): Promise<WebServer>;
+/** An upload waiting for the prompt that will carry it. */
+export interface Staged {
+    name: string;
+    mediaType: string;
+    data: Buffer;
+    /** When it arrived, for the sweep. */
+    at: number;
+}
 /** One thing the composer's + menu attached to a message. */
 export interface Reference {
     kind: "file" | "folder" | "connector" | "plugin" | "skill";
     value: string;
 }
+/**
+ * The user's message, with what they attached.
+ *
+ * An image goes to the model as an image. A PDF goes whole, as a document the
+ * model reads page by page, when the model reads them (`documents`). A text
+ * file is pasted in. Anything else — and every PDF too — is saved in the
+ * project, under .oharness/attachments/<session>/, and its path given, so the
+ * agent can open it with its own tools: a spreadsheet with Python, a model
+ * that takes no PDFs with a PDF tool. Binary files used to be skipped, and
+ * the person was left believing the agent had read what it never received.
+ */
+/** A user message's text without the attachment lines buildMessage adds to it. */
+export declare function withoutAttachmentNotes(text: string): string;
+export declare function buildMessage(prompt: string, staged: Staged[], opts: {
+    documents: boolean;
+    saveDir: string;
+}): Promise<Message[]>;