codex-chatgpt-control 0.1.0-alpha.1

package/dist/src/client.d.ts

@@ -0,0 +1,167 @@
+import type { AskArgs, AttachFilesArgs, BootstrapArgs, CommandResult, CopyResponseArgs, DownloadLatestArgs, NewThreadArgs, OpenThreadArgs, ReadLatestArgs, RuntimeEnv, SearchThreadsArgs, SelectToolArgs, SequencePlan, SetModeArgs, ThreadTarget, WaitArgs } from "./types.js";
+import { type DoctorArgs, type DoctorReport } from "./commands/doctor.js";
+import { type RunReportData, type RunReportOptions } from "./commands/reports.js";
+import { type CommandDescriptor } from "./commands/registry.js";
+import type { ChatGPTAgent, ChatGPTAgentConfig, ChatGPTResponse, ChatGPTRunner, ChatGPTRunInput, ChatGPTRunResult } from "./runner/types.js";
+import { type ChatGPTResponsesCreateArgs } from "./runner/responses.js";
+import { type ReportRedactionOptions } from "./safety/report-redaction.js";
+export type ChatGPTClientOptions = RuntimeEnv & {
+    defaults?: {
+        mode?: SetModeArgs;
+        wait?: boolean | WaitArgs;
+        read?: boolean | ReadLatestArgs;
+        existingTab?: BootstrapArgs["existingTab"];
+        preferExistingTab?: boolean;
+    };
+    limits?: Partial<RunLimits>;
+    reporting?: RunReportOptions;
+};
+export type RunLimits = {
+    maxPromptsPerRun: number;
+    maxThreadsOpenedPerRun: number;
+    maxMessagesReadPerRun: number;
+    maxReportBytesPerRun: number;
+    maxReportPreviewChars: number;
+};
+export type ThreadSelector = {
+    type: "new";
+} | {
+    type: "current";
+} | {
+    type: "url";
+    url: string;
+} | {
+    type: "conversationId";
+    conversationId: string;
+} | {
+    type: "conversation_id";
+    conversationId: string;
+} | {
+    type: "search";
+    query: string;
+    select?: "first" | {
+        index: number;
+    } | {
+        title: string;
+    };
+    limit?: number;
+} | {
+    type: "title";
+    title: string;
+};
+export type WorkflowThread = ThreadTarget | ThreadSelector;
+export type FileInput = string | {
+    path: string;
+};
+export type AskWorkflowArgs = {
+    prompt: string;
+    thread?: WorkflowThread;
+    existingTab?: BootstrapArgs["existingTab"];
+    preferExistingTab?: boolean;
+    mode?: SetModeArgs;
+    tools?: SelectToolArgs[];
+    files?: FileInput[];
+    attachments?: FileInput[];
+    wait?: boolean | WaitArgs;
+    read?: boolean | ReadLatestArgs;
+    download?: DownloadLatestArgs;
+    report?: boolean | RunReportOptions;
+};
+export type AskInThreadWorkflowArgs = Omit<AskWorkflowArgs, "thread"> & {
+    thread: Exclude<WorkflowThread, {
+        type: "new";
+    }>;
+};
+export type AskWithFilesWorkflowArgs = Omit<AskWorkflowArgs, "files" | "attachments"> & {
+    files: FileInput[];
+};
+export type AskAndDownloadWorkflowArgs = AskWorkflowArgs & {
+    download: DownloadLatestArgs;
+};
+export type RunMessagesArgs = {
+    thread?: WorkflowThread;
+    existingTab?: BootstrapArgs["existingTab"];
+    preferExistingTab?: boolean;
+    mode?: SetModeArgs;
+    messages: Array<{
+        id?: string;
+        prompt: string;
+        wait?: boolean | WaitArgs;
+        read?: boolean | ReadLatestArgs;
+    }>;
+    report?: boolean | RunReportOptions;
+};
+export type NamedWorkflowInvocation = {
+    name: string;
+    input?: Record<string, unknown>;
+    report?: boolean | RunReportOptions;
+};
+export type ChatGPTClient = {
+    agent<TOutput = string>(config: ChatGPTAgentConfig<TOutput>): ChatGPTAgent<TOutput>;
+    run<TOutput = string>(agent: ChatGPTAgent<TOutput>, input: ChatGPTRunInput): Promise<ChatGPTRunResult<TOutput>>;
+    runner: ChatGPTRunner;
+    responses: {
+        create(args: ChatGPTResponsesCreateArgs | Record<string, unknown>): Promise<ChatGPTResponse>;
+    };
+    ask(args: AskWorkflowArgs): Promise<CommandResult<unknown>>;
+    askInThread(args: AskInThreadWorkflowArgs): Promise<CommandResult<unknown>>;
+    askWithFiles(args: AskWithFilesWorkflowArgs): Promise<CommandResult<unknown>>;
+    askAndDownload(args: AskAndDownloadWorkflowArgs): Promise<CommandResult<unknown>>;
+    runMessages(args: RunMessagesArgs): Promise<CommandResult<unknown>>;
+    openThread(thread: WorkflowThread): Promise<CommandResult<unknown>>;
+    readLatest(args?: ReadLatestArgs): Promise<CommandResult<unknown>>;
+    copyLatest(args?: CopyResponseArgs): Promise<CommandResult<unknown>>;
+    downloadLatest(args: DownloadLatestArgs): Promise<CommandResult<unknown>>;
+    runPlan(plan: SequencePlan | NamedWorkflowInvocation): Promise<CommandResult<unknown>>;
+    doctor(args?: DoctorArgs): Promise<CommandResult<DoctorReport>>;
+    createReport(result: CommandResult<unknown>, args?: RunReportOptions): Promise<CommandResult<RunReportData>>;
+    reports: {
+        create(result: CommandResult<unknown>, args?: RunReportOptions): Promise<CommandResult<RunReportData>>;
+        redact(value: unknown, args?: ReportRedactionOptions): Promise<CommandResult<unknown>>;
+        summarize(result: CommandResult<unknown>, args?: ReportRedactionOptions): Promise<CommandResult<unknown>>;
+    };
+    plan(name: string, args?: unknown): SequencePlan | undefined;
+    commands(filter?: {
+        layer?: CommandDescriptor["layer"];
+    }): CommandDescriptor[];
+    describe(name: string): CommandDescriptor | undefined;
+    help(topic?: string): string;
+    session: {
+        bootstrap(args?: BootstrapArgs): Promise<CommandResult<unknown>>;
+    };
+    threads: {
+        "new"(args?: NewThreadArgs): Promise<CommandResult<unknown>>;
+        search(args: SearchThreadsArgs): Promise<CommandResult<unknown>>;
+        open(args: OpenThreadArgs): Promise<CommandResult<unknown>>;
+    };
+    messages: {
+        compose(args: {
+            text: string;
+            mode?: "replace" | "append";
+            timeoutMs?: number;
+        }): Promise<CommandResult<unknown>>;
+        submit(args?: {
+            text?: string;
+            previousTurnCount?: number;
+            timeoutMs?: number;
+        }): Promise<CommandResult<unknown>>;
+        ask(args: AskArgs): Promise<CommandResult<unknown>>;
+        wait(args?: WaitArgs): Promise<CommandResult<unknown>>;
+        readLatest(args?: ReadLatestArgs): Promise<CommandResult<unknown>>;
+        waitAndRead(args?: WaitArgs & ReadLatestArgs): Promise<CommandResult<unknown>>;
+    };
+    files: {
+        attach(args: AttachFilesArgs): Promise<CommandResult<unknown>>;
+        downloadLatest(args: DownloadLatestArgs): Promise<CommandResult<unknown>>;
+    };
+    modes: {
+        set(args: SetModeArgs): Promise<CommandResult<unknown>>;
+    };
+    tools: {
+        select(args: SelectToolArgs): Promise<CommandResult<unknown>>;
+    };
+    response: {
+        copy(args?: CopyResponseArgs): Promise<CommandResult<unknown>>;
+    };
+};
+export declare function createChatGPT(options?: ChatGPTClientOptions): ChatGPTClient;