@oya-ai/browser 1.0.99 → 1.0.101

package/dist/index.cjs

@@ -258,9 +258,12 @@ var Browser = class {
     await this.command("navigate", { url }, NAVIGATE_TIMEOUT_MS);
     if (this.autoCaptcha) assertCaptchaCleared(await this.solveCaptcha());
   }
-  /** The page as markdown plus numbered elements to act on. */
-  async analyze() {
-    return this.command("analyze");
+  /**
+   * The page, written as markdown (the default), TOON or JSONL, plus its blocks and
+   * the numbered elements to act on.
+   */
+  async analyze(options = {}) {
+    return this.command("analyze", options.format ? { format: options.format } : {});
   }
   /** Only the visible elements, which is what an agent almost always wants. */
   async elements() {

package/dist/index.d.cts

@@ -96,10 +96,40 @@ interface Element {
     /** Action of the enclosing form. */
     formName?: string;
 }
+/** How `analyze()` writes the page: markdown (the default) or toon (toonformat.dev). */
+type PageFormat = 'markdown' | 'toon' | 'jsonl';
+/** What `analyze()` accepts. */
+interface AnalyzeOptions {
+    /** How the page is written: markdown (the default) or toon. */
+    format?: PageFormat;
+}
+/** One block of a page, in reading order: a heading, paragraph, list item, table row, image or element. */
+interface Block {
+    /** The element's id, for interactive elements; act on it with click and type. */
+    id?: number;
+    /** The part of the page it is in: nav, main, form/…, dialog, or empty. */
+    region: string;
+    /** What it is: h1-h6, text, item, row, header, quote, code, image, or an element kind (link, button, input:email…). */
+    kind: string;
+    /** Its text, or an element's name. */
+    text?: string;
+    /** Where a link goes, or what a field holds now. */
+    target?: string;
+    /** An element's state: checked, disabled, required, off-screen, hint… */
+    state?: string;
+}
 /** The page as `analyze()` sees it. */
 interface Analysis {
-    /** The page as markdown. */
-    markdown: string;
+    /** The format `page` is written in. */
+    format?: PageFormat;
+    /** The page, written in `format`. */
+    page?: string;
+    /** The page as markdown; present when the format is markdown (the default). */
+    markdown?: string;
+    /** The page's facts: url, title, scroll, and when they apply panelScroll, modal, covered, truncated. */
+    facts?: Record<string, string | number>;
+    /** The page as data: every block in reading order, whatever the format. */
+    blocks?: Block[];
     /** Every numbered element, visible or not. */
     elements: Element[];
     /** The window size, in CSS pixels. */
@@ -1077,8 +1107,11 @@ declare class Browser {
     private command;
     /** Navigates, then clears any CAPTCHA when `captcha: 'auto'` was asked for. */
     goto(url: string): Promise<void>;
-    /** The page as markdown plus numbered elements to act on. */
-    analyze(): Promise<Analysis>;
+    /**
+     * The page, written as markdown (the default), TOON or JSONL, plus its blocks and
+     * the numbered elements to act on.
+     */
+    analyze(options?: AnalyzeOptions): Promise<Analysis>;
     /** Only the visible elements, which is what an agent almost always wants. */
     elements(): Promise<Element[]>;
     /** Clicks an element by its id from `analyze()`. */
@@ -1319,4 +1352,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AttentionRequest, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, 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 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 };

package/dist/index.d.ts

@@ -96,10 +96,40 @@ interface Element {
     /** Action of the enclosing form. */
     formName?: string;
 }
+/** How `analyze()` writes the page: markdown (the default) or toon (toonformat.dev). */
+type PageFormat = 'markdown' | 'toon' | 'jsonl';
+/** What `analyze()` accepts. */
+interface AnalyzeOptions {
+    /** How the page is written: markdown (the default) or toon. */
+    format?: PageFormat;
+}
+/** One block of a page, in reading order: a heading, paragraph, list item, table row, image or element. */
+interface Block {
+    /** The element's id, for interactive elements; act on it with click and type. */
+    id?: number;
+    /** The part of the page it is in: nav, main, form/…, dialog, or empty. */
+    region: string;
+    /** What it is: h1-h6, text, item, row, header, quote, code, image, or an element kind (link, button, input:email…). */
+    kind: string;
+    /** Its text, or an element's name. */
+    text?: string;
+    /** Where a link goes, or what a field holds now. */
+    target?: string;
+    /** An element's state: checked, disabled, required, off-screen, hint… */
+    state?: string;
+}
 /** The page as `analyze()` sees it. */
 interface Analysis {
-    /** The page as markdown. */
-    markdown: string;
+    /** The format `page` is written in. */
+    format?: PageFormat;
+    /** The page, written in `format`. */
+    page?: string;
+    /** The page as markdown; present when the format is markdown (the default). */
+    markdown?: string;
+    /** The page's facts: url, title, scroll, and when they apply panelScroll, modal, covered, truncated. */
+    facts?: Record<string, string | number>;
+    /** The page as data: every block in reading order, whatever the format. */
+    blocks?: Block[];
     /** Every numbered element, visible or not. */
     elements: Element[];
     /** The window size, in CSS pixels. */
@@ -1077,8 +1107,11 @@ declare class Browser {
     private command;
     /** Navigates, then clears any CAPTCHA when `captcha: 'auto'` was asked for. */
     goto(url: string): Promise<void>;
-    /** The page as markdown plus numbered elements to act on. */
-    analyze(): Promise<Analysis>;
+    /**
+     * The page, written as markdown (the default), TOON or JSONL, plus its blocks and
+     * the numbered elements to act on.
+     */
+    analyze(options?: AnalyzeOptions): Promise<Analysis>;
     /** Only the visible elements, which is what an agent almost always wants. */
     elements(): Promise<Element[]>;
     /** Clicks an element by its id from `analyze()`. */
@@ -1319,4 +1352,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AttentionRequest, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, 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 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 };

package/dist/index.js

@@ -226,9 +226,12 @@ var Browser = class {
     await this.command("navigate", { url }, NAVIGATE_TIMEOUT_MS);
     if (this.autoCaptcha) assertCaptchaCleared(await this.solveCaptcha());
   }
-  /** The page as markdown plus numbered elements to act on. */
-  async analyze() {
-    return this.command("analyze");
+  /**
+   * The page, written as markdown (the default), TOON or JSONL, plus its blocks and
+   * the numbered elements to act on.
+   */
+  async analyze(options = {}) {
+    return this.command("analyze", options.format ? { format: options.format } : {});
   }
   /** Only the visible elements, which is what an agent almost always wants. */
   async elements() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oya-ai/browser",
-  "version": "1.0.99",
+  "version": "1.0.101",
   "description": "Rotate thousands of browsers behind one API — personas, proxies, stealth, CAPTCHA and MFA.",
   "license": "MIT",
   "homepage": "https://browser.getoya.ai",