@dna113p/machines 0.1.0 → 0.3.0

package/dist/src/chatgpt-web.d.ts

@@ -0,0 +1,143 @@
+import type { AgentReporter, AgentRequest, Event } from "./index.ts";
+/** CSS selectors for the ChatGPT page. Override them when the web UI changes. */
+export interface ChatGptWebSelectors {
+    readonly composer: string;
+    readonly send: string;
+    readonly stop: string;
+    readonly assistant: string;
+    readonly plus: string;
+    readonly menuItem: string;
+    /** A control only a signed-out page shows. Links and buttons labelled "Log in" or "Sign in" also count. */
+    readonly signIn: string;
+}
+/** Each list names the page as it is today and as it was before, for accounts a rollout has not reached. */
+export declare const defaultChatGptWebSelectors: ChatGptWebSelectors;
+export interface ChatGptWebBrowserLaunch {
+    /** Chromium-family executable. Defaults to `CHATGPT_WEB_BROWSER`, then a PATH search. */
+    readonly executable?: string;
+    /** Dedicated browser profile holding the ChatGPT login. */
+    readonly userDataDir?: string;
+    readonly headless?: boolean;
+    readonly args?: readonly string[];
+}
+/** Explicit handoff notification recorded by rig-bridge when an assistant finishes a stretch of work. */
+export interface RigBridgeHandoff {
+    readonly id: string;
+    readonly projectId: string;
+    readonly threadId: string;
+    readonly runId?: string;
+    readonly reason: "completed" | "needs_input" | "blocked" | "failed" | "cancelled" | string;
+    readonly summary: string;
+    readonly createdAt: number;
+}
+/** Event returned by the ChatGPT Web runner, enriched with handoff and conversation metadata. */
+export interface ChatGptWebEvent extends Event {
+    readonly type: string;
+    readonly summary?: string;
+    readonly message?: string;
+    readonly handoff?: RigBridgeHandoff;
+    /** The chat's lasting address. Absent when ChatGPT did not show one before the run ended. */
+    readonly conversation?: string;
+}
+export interface RigBridgeStatusView {
+    readonly version?: string;
+    readonly startedAt?: number;
+    readonly uptimeSeconds?: number;
+    readonly workspacesCount?: number;
+    readonly activeCommandsCount?: number;
+    readonly workspaces: readonly {
+        readonly id: string;
+        readonly projectId?: string;
+        readonly threadId?: string;
+        readonly cwd: string;
+        readonly createdAt?: number;
+    }[];
+    readonly notifications?: readonly RigBridgeHandoff[];
+    readonly unreadCount?: number;
+}
+export interface ChatGptWebAgentOptions {
+    readonly env?: Readonly<Record<string, string>>;
+    readonly harness?: string;
+    /** Start page: ChatGPT, a Project, or a GPT. Defaults to `CHATGPT_WEB_URL` or https://chatgpt.com/. */
+    readonly url?: string;
+    /** Model slug appended as `?model=`. Defaults to `CHATGPT_WEB_MODEL`. */
+    readonly model?: string;
+    /** DevTools endpoint. Defaults to `CHATGPT_WEB_CDP_URL` or http://127.0.0.1:9222. */
+    readonly cdpUrl?: string;
+    /** Launch a persistent, detached browser when the endpoint is unreachable. Defaults to true. */
+    readonly launch?: boolean | ChatGptWebBrowserLaunch;
+    /**
+     * Name the rig-bridge app has in this person's ChatGPT, matched against the text of the composer's add menu.
+     * Defaults to `CHATGPT_WEB_CONNECTOR` or "rig-bridge".
+     */
+    readonly connector?: string;
+    /** Try to enable the connector from the composer's + menu. Defaults to true. */
+    readonly selectConnector?: boolean;
+    /** Click visible tool confirmation buttons. Defaults to false. */
+    readonly approveToolCalls?: boolean;
+    readonly approveLabels?: readonly string[];
+    /** rig-bridge status endpoint used for activity, or false. Defaults to `RIG_BRIDGE_STATUS_URL` or :8767. */
+    readonly bridgeStatusUrl?: string | false;
+    /** Automatically mark handoff notifications read on rig-bridge when completed. Defaults to true. */
+    readonly acknowledgeHandoff?: boolean;
+    readonly timeoutMs?: number;
+    /** How long the composer may take to appear after the tab opens. Defaults to 45 seconds. */
+    readonly composerTimeoutMs?: number;
+    /** Quiet period after generation stops before the reply is treated as final. */
+    readonly settleMs?: number;
+    readonly pollMs?: number;
+    /** Keep the tab after success. Failed runs always keep their tab for inspection. */
+    readonly keepTab?: boolean;
+    readonly selectors?: Partial<ChatGptWebSelectors>;
+    readonly output?: "capture" | "stream";
+}
+/** Finds a Chromium-family browser able to expose the DevTools protocol. */
+export declare function findChromeExecutable(env?: Readonly<Record<string, string | undefined>>): Promise<string | undefined>;
+export declare function defaultChatGptWebProfile(env?: Readonly<Record<string, string | undefined>>): string;
+/** Builds the conversation opener that points ChatGPT at the local workspace through rig-bridge. */
+export declare function chatGptWebPrompt(request: AgentRequest & {
+    readonly cwd: string;
+}, connector: string): string;
+export type ChatGptWebAgentRunner = (request: AgentRequest, report?: AgentReporter) => Promise<ChatGptWebEvent>;
+/** One message for an existing ChatGPT web conversation that works in `cwd` through rig-bridge. */
+export interface ChatGptWebContinueInput {
+    /** Conversation URL, such as the `conversation` of an earlier ChatGPT Web event. */
+    readonly conversation: string;
+    /** Message to send. It is submitted exactly as given. */
+    readonly text: string;
+    readonly cwd: string;
+    /** Only count a handoff from this rig-bridge thread. */
+    readonly bridgeThreadId?: string;
+}
+export type ChatGptWebContinueRunner = (input: ChatGptWebContinueInput, report?: AgentReporter) => Promise<ChatGptWebEvent>;
+/** Runs one fresh ChatGPT web conversation that works in the request's directory via rig-bridge. */
+export declare function chatGptWebAgent(options?: ChatGptWebAgentOptions): ChatGptWebAgentRunner;
+/**
+ * Sends one message to an existing ChatGPT web conversation and returns the next rig-bridge handoff.
+ * The handoff is the whole result: assistant messages are never read from the page.
+ */
+export declare function chatGptWebContinue(options?: ChatGptWebAgentOptions): ChatGptWebContinueRunner;
+/** Fetches the latest bridge status from rig-bridge. */
+export declare function fetchRigBridgeStatus(statusUrl?: string): Promise<RigBridgeStatusView | undefined>;
+/** Finds the most recent handoff notification from rig-bridge matching the given directory or thread. */
+export declare function fetchLatestRigBridgeHandoff(options?: {
+    readonly cwd?: string;
+    readonly threadId?: string;
+    readonly statusUrl?: string;
+    readonly since?: number;
+}): Promise<RigBridgeHandoff | undefined>;
+/** Acknowledges / marks read a handoff on rig-bridge. */
+export declare function acknowledgeRigBridgeHandoff(handoffId: string, options?: {
+    readonly statusUrl?: string;
+}): Promise<boolean>;
+/**
+ * Creates an Operation for a Machine that inspects rig-bridge for the latest handoff notification,
+ * returning an Event with `type = handoff.reason` and attaching `summary` and `handoff`.
+ */
+export declare function rigBridgeHandoffOperation(options?: {
+    readonly cwd?: string;
+    readonly threadId?: string;
+    readonly statusUrl?: string;
+    readonly since?: number;
+    readonly acknowledge?: boolean;
+}): () => Promise<ChatGptWebEvent>;