@oya-ai/browser 1.0.110 → 1.0.113

package/dist/index.d.cts

@@ -255,6 +255,8 @@ interface BrowserInfo {
 }
 /** A browser plus what it has been doing, from `browser.status()`. */
 interface BrowserDetail extends BrowserInfo {
+    /** The actions it does, sorted, one spelling each: an action not listed answers action_unsupported or action_unknown. */
+    actions: string[];
     /** Its most recent commands, newest first. */
     activity: Activity[];
 }
@@ -342,10 +344,6 @@ interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider'
     }>;
 }
 
-/**
- * OyaError: the one error type the SDK throws for a failed call, carrying the
- * HTTP status and the server's answer so a caller can branch on either.
- */
 /** A failed API call or browser command. */
 declare class OyaError extends Error {
     /** The HTTP status, or the SDK's own status for errors it raises itself. */
@@ -721,6 +719,13 @@ type CookieFormat = 'json' | 'playwright';
  */
 /** What a member or credential may do: read, operate browsers, or also administer the project. */
 type ControlRole = 'viewer' | 'operator' | 'administrator';
+/** How to recover a session: in place (the default), or replaced by a fresh one. */
+interface RecoverOptions {
+    /** Start a fresh session in its place. */
+    replace?: boolean;
+    /** cdp only: the Chrome the replacement runs on. */
+    wsUrl?: string;
+}
 /** What a human holding the control lease may send. Mirrors the server's allowlist. */
 type HumanInputAction = 'click' | 'type' | 'press_key' | 'scroll' | 'click_coordinates' | 'double_click' | 'drag' | 'mouse_move' | 'scroll_at' | 'type_text' | 'keyboard_type' | 'navigate' | 'back' | 'forward' | 'reload' | 'screenshot' | 'analyze' | 'read_page';
 /** A browser session as the control plane records it, including ones no longer connected. */
@@ -834,14 +839,24 @@ interface OyaOptions {
     fetch?: typeof globalThis.fetch;
 }
 
+/** Where the key and the address came from, so a message names the one to fix. */
+interface Origin {
+    /** The key's source, as a message names it: "the apiKey option", "OYA_API_KEY" or "~/.oya/config.json". */
+    apiKeyFrom: string;
+    /** The address's source, named the same way, or "default" for the hosted one. */
+    baseUrlFrom: string;
+    /** Whether a key is also saved by `oya login`, which an environment key overrides. */
+    savedKey: boolean;
+}
 /** The one HTTP path. Everything else in this package is a wrapper over it. */
 declare class Http {
     readonly baseUrl: string;
     readonly apiKey: string;
     private readonly timeoutMs;
     private readonly fetchImpl;
-    /** Stores where to call, with which key, how long to wait and which fetch to use. */
-    constructor(baseUrl: string, apiKey: string, timeoutMs: number, fetchImpl: typeof globalThis.fetch);
+    readonly origin: Origin;
+    /** Stores where to call, with which key, how long to wait, which fetch to use, and where the key and address came from. */
+    constructor(baseUrl: string, apiKey: string, timeoutMs: number, fetchImpl: typeof globalThis.fetch, origin?: Origin);
     /** Sends one request and returns the parsed answer, or throws an OyaError when it failed. */
     request<T>(method: string, path: string, body?: unknown, timeoutMs?: number, headers?: Record<string, string>): Promise<T>;
     /** The fetch options for one call, with this client's key on them. */
@@ -1214,6 +1229,11 @@ declare class Browser {
      * with filters like `{{name|first}}`, so a playbook saved from the run stores no values.
      */
     ask(prompt: string, { data, secrets }?: AskValues): Promise<string>;
+    /**
+     * `ask()` for data: the agent does the task and answers in the shape of `schema`
+     * (a JSON schema), instead of in words. Throws when the agent reports it could not.
+     */
+    extract<T = unknown>(prompt: string, schema: Record<string, unknown>, values?: AskValues): Promise<T>;
     /**
      * Save the last `ask()` on this browser as a named playbook. Every value that was
      * typed, picked or clicked becomes a variable, with what the run used kept in
@@ -1322,7 +1342,7 @@ declare class Oya {
         removeMember: (userId: string) => Promise<Ack>;
         createCredential: (options: CredentialRequest) => Promise<NewCredential>;
         revokeCredential: (id: string) => Promise<Ack>;
-        recover: (id: string, replace?: boolean) => Promise<unknown>;
+        recover: (id: string, options?: boolean | RecoverOptions) => Promise<unknown>;
         ticket: (id: string) => Promise<Ticket>;
         events: (after?: number) => Promise<EventPage>;
         cancel: (id: string) => Promise<ControlSession>;
@@ -1413,4 +1433,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };
+export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };

package/dist/index.d.ts

@@ -255,6 +255,8 @@ interface BrowserInfo {
 }
 /** A browser plus what it has been doing, from `browser.status()`. */
 interface BrowserDetail extends BrowserInfo {
+    /** The actions it does, sorted, one spelling each: an action not listed answers action_unsupported or action_unknown. */
+    actions: string[];
     /** Its most recent commands, newest first. */
     activity: Activity[];
 }
@@ -342,10 +344,6 @@ interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider'
     }>;
 }
 
-/**
- * OyaError: the one error type the SDK throws for a failed call, carrying the
- * HTTP status and the server's answer so a caller can branch on either.
- */
 /** A failed API call or browser command. */
 declare class OyaError extends Error {
     /** The HTTP status, or the SDK's own status for errors it raises itself. */
@@ -721,6 +719,13 @@ type CookieFormat = 'json' | 'playwright';
  */
 /** What a member or credential may do: read, operate browsers, or also administer the project. */
 type ControlRole = 'viewer' | 'operator' | 'administrator';
+/** How to recover a session: in place (the default), or replaced by a fresh one. */
+interface RecoverOptions {
+    /** Start a fresh session in its place. */
+    replace?: boolean;
+    /** cdp only: the Chrome the replacement runs on. */
+    wsUrl?: string;
+}
 /** What a human holding the control lease may send. Mirrors the server's allowlist. */
 type HumanInputAction = 'click' | 'type' | 'press_key' | 'scroll' | 'click_coordinates' | 'double_click' | 'drag' | 'mouse_move' | 'scroll_at' | 'type_text' | 'keyboard_type' | 'navigate' | 'back' | 'forward' | 'reload' | 'screenshot' | 'analyze' | 'read_page';
 /** A browser session as the control plane records it, including ones no longer connected. */
@@ -834,14 +839,24 @@ interface OyaOptions {
     fetch?: typeof globalThis.fetch;
 }
 
+/** Where the key and the address came from, so a message names the one to fix. */
+interface Origin {
+    /** The key's source, as a message names it: "the apiKey option", "OYA_API_KEY" or "~/.oya/config.json". */
+    apiKeyFrom: string;
+    /** The address's source, named the same way, or "default" for the hosted one. */
+    baseUrlFrom: string;
+    /** Whether a key is also saved by `oya login`, which an environment key overrides. */
+    savedKey: boolean;
+}
 /** The one HTTP path. Everything else in this package is a wrapper over it. */
 declare class Http {
     readonly baseUrl: string;
     readonly apiKey: string;
     private readonly timeoutMs;
     private readonly fetchImpl;
-    /** Stores where to call, with which key, how long to wait and which fetch to use. */
-    constructor(baseUrl: string, apiKey: string, timeoutMs: number, fetchImpl: typeof globalThis.fetch);
+    readonly origin: Origin;
+    /** Stores where to call, with which key, how long to wait, which fetch to use, and where the key and address came from. */
+    constructor(baseUrl: string, apiKey: string, timeoutMs: number, fetchImpl: typeof globalThis.fetch, origin?: Origin);
     /** Sends one request and returns the parsed answer, or throws an OyaError when it failed. */
     request<T>(method: string, path: string, body?: unknown, timeoutMs?: number, headers?: Record<string, string>): Promise<T>;
     /** The fetch options for one call, with this client's key on them. */
@@ -1214,6 +1229,11 @@ declare class Browser {
      * with filters like `{{name|first}}`, so a playbook saved from the run stores no values.
      */
     ask(prompt: string, { data, secrets }?: AskValues): Promise<string>;
+    /**
+     * `ask()` for data: the agent does the task and answers in the shape of `schema`
+     * (a JSON schema), instead of in words. Throws when the agent reports it could not.
+     */
+    extract<T = unknown>(prompt: string, schema: Record<string, unknown>, values?: AskValues): Promise<T>;
     /**
      * Save the last `ask()` on this browser as a named playbook. Every value that was
      * typed, picked or clicked becomes a variable, with what the run used kept in
@@ -1322,7 +1342,7 @@ declare class Oya {
         removeMember: (userId: string) => Promise<Ack>;
         createCredential: (options: CredentialRequest) => Promise<NewCredential>;
         revokeCredential: (id: string) => Promise<Ack>;
-        recover: (id: string, replace?: boolean) => Promise<unknown>;
+        recover: (id: string, options?: boolean | RecoverOptions) => Promise<unknown>;
         ticket: (id: string) => Promise<Ticket>;
         events: (after?: number) => Promise<EventPage>;
         cancel: (id: string) => Promise<ControlSession>;
@@ -1413,4 +1433,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };
+export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };