Open-source AI coworkers that each get a computer of their own: a browser, files and tools, with every action decided before it happens and recorded after. Bring any AG-UI agent.
import {
type BotBrowserApiState,
botBrowserApiPaths,
} from "@openbot/shared/bot-browser";
import type {
BrowserNavigateRequest,
BrowserTabsRequest,
} from "@openbot/shared/openbot-browser";
import { mutationOptions, type QueryClient } from "@tanstack/react-query";
import {
type NarrationAnswer,
type NarrationPost,
sendNarrationTo,
} from "@/lib/browser/mutations";
import { client } from "@/lib/client";
import { botBrowserKeys } from "./queries";
/*
* WRITES TO A BOT'S BROWSER, by the person holding its wheel. The server refuses each of them (409, with its own
* sentence) to anyone else, so these carry no rule of their own about who may: the app shows the server's sentence.
*
* Each factory is for one Bot, as the screen it is pressed in is: the request bodies are then exactly the person's own
* browser's, which is what lets the Bot's screen share the bar and the Record controls with the Browser page.
*/
function invalidateBotBrowser(queryClient: QueryClient, botId: string) {
return queryClient.invalidateQueries({
queryKey: botBrowserKeys.state(botId),
});
}
/**
* Starts recording the tab the person is on in the Bot's browser, named for the task, for the person alone.
*
* Whether they narrate is not passed on: a Bot's browser is narrated from this page (`external`), whose microphone opens
* only by the person's choice (`useNarration`), and the Recorder there has no microphone to open.
*/
export function startBotBrowserRecordingMutationOptions(
queryClient: QueryClient,
botId: string,
) {
return mutationOptions({
mutationFn: async (variables: {
title: string;
language?: string;
}): Promise<BotBrowserApiState> =>
(
await client(botBrowserApiPaths.recording(botId), {
method: "POST",
body: {
action: "start",
title: variables.title,
...(variables.language ? { language: variables.language } : {}),
},
fallback: "Couldn't start recording. Try again.",
})
).json(),
onSuccess: () => invalidateBotBrowser(queryClient, botId),
});
}
/**
* Stops the person's recording. Read again on a refusal as well as on success: the one refusal there is, a recording
* that is not theirs or not running, means the computer ended it under them (the wheel went back), and the read is what
* says so.
*/
export function stopBotBrowserRecordingMutationOptions(
queryClient: QueryClient,
botId: string,
) {
return mutationOptions({
mutationFn: async (): Promise<BotBrowserApiState> =>
(
await client(botBrowserApiPaths.recording(botId), {
method: "POST",
body: { action: "stop" },
fallback: "Couldn't stop recording. Try again.",
})
).json(),
onSettled: () => invalidateBotBrowser(queryClient, botId),
});
}
/** A new tab, or switching to or closing one, in the Bot's browser. */
export function botBrowserTabsMutationOptions(
queryClient: QueryClient,
botId: string,
) {
return mutationOptions({
mutationFn: async (
request: BrowserTabsRequest,
): Promise<BotBrowserApiState> =>
(
await client(botBrowserApiPaths.tabs(botId), {
method: "POST",
body: request,
fallback: "Couldn't change the tabs. Try again.",
})
).json(),
onSuccess: () => invalidateBotBrowser(queryClient, botId),
});
}
/** An address typed into the bar, or back, forward or reload, in the tab the person is on in the Bot's browser. */
export function navigateBotBrowserMutationOptions(
queryClient: QueryClient,
botId: string,
) {
return mutationOptions({
mutationFn: async (
request: BrowserNavigateRequest,
): Promise<BotBrowserApiState> =>
(
await client(botBrowserApiPaths.navigate(botId), {
method: "POST",
body: request,
fallback: "Couldn't open that page. Try again.",
})
).json(),
onSuccess: () => invalidateBotBrowser(queryClient, botId),
});
}
/**
* Wipes the Bot's browser for the person holding its wheel: cookies, saved passwords, history and site storage, which
* signs it out of everything. The answer is the fresh browser, started again under them.
*/
export function clearBotBrowserMutationOptions(
queryClient: QueryClient,
botId: string,
) {
return mutationOptions({
mutationFn: async (): Promise<BotBrowserApiState> =>
(
await client(botBrowserApiPaths.clear(botId), {
method: "POST",
fallback: "Couldn't clear the browser. Try again.",
})
).json(),
onSettled: () => invalidateBotBrowser(queryClient, botId),
});
}
/**
* One thing the person's narration says to the Recorder in the Bot's browser, exactly as `sendNarration` does for their
* own: a plain function for the same reasons, answering rather than throwing.
*/
export function sendBotBrowserNarration(
botId: string,
post: NarrationPost,
): Promise<NarrationAnswer> {
return sendNarrationTo(botBrowserApiPaths.narration(botId), post);
}