@intuned/browser-dev 0.1.7-dev.0 → 0.1.8-dev.0

package/generated-docs/ai/interfaces/ImageUrlContentItem.mdx

@@ -1,16 +0,0 @@
----
-title: ImageUrlContentItem
-description: ""
----
-
-```typescript
-export interface ImageUrlContentItem {
-  type: "image-url";
-  image_type: "png" | "jpeg" | "gif" | "webp";
-  data: string;
-}
-```
-
-Represents image content provided as a URL for AI extraction.
-Used when passing image URLs directly to extractStructuredData without a page source.
-The image will be fetched from the URL and analyzed by AI vision models for data extraction.

package/generated-docs/ai/interfaces/NumberSchema.mdx

@@ -1,35 +0,0 @@
----
-title: NumberSchema
-description: ""
----
-
-```typescript
-export interface NumberSchema extends BasicSchema {
-  type: "number" | "integer";
-  multipleOf?: number;
-  maximum?: number;
-  exclusiveMaximum?: number;
-  minimum?: number;
-  exclusiveMinimum?: number;
-}
-```
-
-Schema definition for numeric values (numbers and integers) with validation constraints.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Number Schema
-import { NumberSchema } from "@intuned/browser/ai";
-export default async function handler(params, page, context){
-const ageSchema: NumberSchema = {
-  type: "integer",
-  minimum: 0,
-  maximum: 150,
-  description: "Person's age in years"
-};
-}
-```
-
-</CodeGroup>

package/generated-docs/ai/interfaces/ObjectSchema.mdx

@@ -1,39 +0,0 @@
----
-title: ObjectSchema
-description: ""
----
-
-```typescript
-export interface ObjectSchema extends BasicSchema {
-  type: "object";
-  properties: Record<string,
-  JsonSchema | z.ZodSchema>;
-  required?: string[];
-  maxProperties?: number;
-  minProperties?: number;
-}
-```
-
-Schema definition for object values with property validation and constraints.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Object Schema
-import { ObjectSchema } from "@intuned/browser/ai";
-export default async function handler(params, page, context){
-const userSchema: ObjectSchema = {
-  type: "object",
-  properties: {
-    name: { type: "string" },
-    email: { type: "string", pattern: "^[^@]+@[^@]+\\.[^@]+$" },
-    age: { type: "integer", minimum: 0 }
-  },
-  required: ["name", "email"],
-  description: "User profile information"
-};
-}
-```
-
-</CodeGroup>

package/generated-docs/ai/interfaces/StringSchema.mdx

@@ -1,35 +0,0 @@
----
-title: StringSchema
-description: ""
----
-
-```typescript
-export interface StringSchema extends BasicSchema {
-  type: "string";
-  enum?: string[];
-  maxLength?: number;
-  minLength?: number;
-  pattern?: string;
-}
-```
-
-Schema definition for string values with validation constraints.
-
-## Examples
-
-<CodeGroup>
-
-```typescript String Schema
-import { StringSchema } from "@intuned/browser/ai";
-export default async function handler(params, page, context){
-const nameSchema: StringSchema = {
-  type: "string",
-  minLength: 2,
-  maxLength: 50,
-  pattern: "^[A-Za-z\\s]+$",
-  description: "Person's full name"
-};
-}
-```
-
-</CodeGroup>

package/generated-docs/ai/interfaces/TextContentItem.mdx

@@ -1,14 +0,0 @@
----
-title: TextContentItem
-description: ""
----
-
-```typescript
-export interface TextContentItem {
-  type: "text";
-  data: string;
-}
-```
-
-Represents text content for AI extraction.
-Used when passing text data directly to extractStructuredData without a page source.

package/generated-docs/ai/type-aliases/ContentItem.mdx

@@ -1,12 +0,0 @@
----
-title: ContentItem
-description: ""
----
-
-```typescript
-export type ContentItem = | TextContentItem
-  | ImageBufferContentItem
-  | ImageUrlContentItem;
-```
-
-Union type representing all content items for AI data extraction.

package/generated-docs/ai/type-aliases/JsonSchema.mdx

@@ -1,47 +0,0 @@
----
-title: JsonSchema
-description: ""
----
-
-```typescript
-export type JsonSchema = | StringSchema
-  | NumberSchema
-  | BooleanSchema
-  | ArraySchema
-  | ObjectSchema;
-```
-
-Union type representing all supported JSON schema types.
-Can be a StringSchema, NumberSchema, BooleanSchema, ArraySchema, or ObjectSchema.
-Each schema type provides validation constraints for its respective data type.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Object Schema
-import { JsonSchema } from "@intuned/browser/ai";
-export default async function handler(params, page, context){
-const schema: JsonSchema = {
-  type: "object",
-  properties: {
-    name: { type: "string" },
-    age: { type: "number" }
-  },
-  required: ["name"]
-};
-}
-```
-
-```typescript Array Schema
-import { JsonSchema } from "@intuned/browser/ai";
-export default async function handler(params, page, context){
-const schema: JsonSchema = {
-  type: "array",
-  items: { type: "string" },
-  minItems: 1
-};
-}
-```
-
-</CodeGroup>

package/generated-docs/ai/type-aliases/SUPPORTED_MODELS.mdx

@@ -1,85 +0,0 @@
----
-title: SUPPORTED_MODELS
-description: ""
----
-
-```typescript
-export type SUPPORTED_MODELS = | SUPPORTED_CLAUDE_MODELS
-  | SUPPORTED_OPENAI_MODELS;
-```
-
-Union type representing all supported AI models for data extraction.
-Includes models from both OpenAI and Anthropic.
-
-**Supported OpenAI Models:**
-"gpt-3.5-turbo"
-"gpt-3.5-turbo-0125"
-"gpt-3.5-turbo-0301"
-"gpt-3.5-turbo-0613"
-"gpt-3.5-turbo-1106"
-"gpt-3.5-turbo-16k"
-"gpt-3.5-turbo-16k-0613"
-"gpt-3.5-turbo-instruct"
-"gpt-3.5-turbo-instruct-0914"
-"gpt-4"
-"gpt-4-0314"
-"gpt-4-0613"
-"gpt-4-32k"
-"gpt-4-32k-0314"
-"gpt-4-32k-0613"
-"gpt-4-turbo"
-"gpt-4-turbo-2024-04-09"
-"gpt-4.1"
-"gpt-4.1-2025-04-14"
-"gpt-4.1-mini"
-"gpt-4.1-mini-2025-04-14"
-"gpt-4.1-nano"
-"gpt-4.1-nano-2025-04-14"
-"gpt-4o"
-"gpt-4o-2024-05-13"
-"gpt-4o-2024-08-06"
-"gpt-4o-2024-11-20"
-"gpt-4o-mini"
-"gpt-4o-mini-2024-07-18"
-"gpt-5"
-"gpt-5-2025-08-07"
-"gpt-5-chat"
-"gpt-5-chat-latest"
-"gpt-5-mini"
-"gpt-5-mini-2025-08-07"
-"gpt-5-nano"
-"gpt-5-nano-2025-08-07"
-"o1"
-"o1-2024-12-17"
-"o1-mini"
-"o1-mini-2024-09-12"
-"o1-pro"
-"o1-pro-2025-03-19"
-"o3"
-"o3-2025-04-16"
-"o3-deep-research"
-"o3-deep-research-2025-06-26"
-"o3-mini"
-"o3-mini-2025-01-31"
-"o3-pro"
-"o3-pro-2025-06-10"
-"o4-mini"
-"o4-mini-2025-04-16"
-"o4-mini-deep-research"
-"o4-mini-deep-research-2025-06-26"
-
-**Supported Anthropic (Claude) Models:**
-"claude-3-5-haiku-20241022"
-"claude-3-5-haiku-latest"
-"claude-3-5-sonnet-20240620"
-"claude-3-5-sonnet-20241022"
-"claude-3-5-sonnet-latest"
-"claude-3-7-sonnet-20250219"
-"claude-3-7-sonnet-latest"
-"claude-3-haiku-20240307"
-"claude-4-opus-20250514"
-"claude-4-sonnet-20250514"
-"claude-opus-4-1"
-"claude-opus-4-1-20250805"
-"claude-opus-4-20250514"
-"claude-sonnet-4-20250514"

package/generated-docs/helpers/functions/clickButtonAndWait.mdx

@@ -1,63 +0,0 @@
----
-title: clickButtonAndWait
-description: ""
----
-
-```typescript
-export declare function clickButtonAndWait(input: {
-  page: Page;
-  buttonLocator: Locator;
-  clickDelay?: number;
-}): Promise<void>;
-```
-
-Click a button and wait briefly for content to load.
-
-This function clicks a button element and waits for a specified delay, allowing time for
-any triggered content to load. It automatically waits for network activity to settle.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Button Click
-import { clickButtonAndWait } from "@intuned/browser";
-export default async function handler(params, page, context){
-await page.goto("https://example.com/products");
-const loadMoreButton = page.locator("#load-more-button");
-await clickButtonAndWait({
-  page,
-  buttonLocator: loadMoreButton,
-  clickDelay: 1.0
-});
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration options
-
-<Expandable title="input">
-<ParamField path="input.page" type="Page">
-Playwright Page object
-</ParamField>
-
-<ParamField path="input.buttonLocator" type="Locator">
-Locator for the button element to click
-</ParamField>
-
-<ParamField path="input.clickDelay" type="number">
-Delay after clicking the button (in seconds)
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<void>`
-
-Promise that resolves when the click and wait is complete

package/generated-docs/helpers/functions/clickUntilExhausted.mdx

@@ -1,112 +0,0 @@
----
-title: clickUntilExhausted
-description: ""
----
-
-```typescript
-export declare function clickUntilExhausted(input: {
-  page: Page;
-  buttonLocator: Locator;
-  heartbeat?: CallableFunction;
-  containerLocator?: Locator;
-  maxClicks?: number;
-  clickDelay?: number;
-  noChangeThreshold?: number;
-}): Promise<void>;
-```
-
-Repeatedly click a button until no new content appears or max clicks reached.
-
-This function is useful for "Load More" buttons or paginated content where you need to
-keep clicking until all content is loaded. It provides several stopping conditions:
-- Button becomes invisible
-- Button becomes disabled
-- Maximum number of clicks reached
-- No change detected in container content (when containerLocator is provided)
-
-## Examples
-
-<CodeGroup>
-
-```typescript Load All Items
-import { clickUntilExhausted } from "@intuned/browser";
-export default async function handler(params, page, context){
-await page.goto("https://example.com/products");
-const loadMoreButton = page.locator("button:has-text('Load More')");
-
-// Click until button disappears or is disabled
-await clickUntilExhausted({
-  page,
-  buttonLocator: loadMoreButton,
-  maxClicks: 20
-});
-}
-```
-
-```typescript Track Container Changes
-import { clickUntilExhausted } from "@intuned/browser";
-export default async function handler(params, page, context){
-await page.goto("https://example.com/products");
-const loadMoreButton = page.locator("#load-more");
-const productsContainer = page.locator("#products-list");
-
-let clickCount = 0;
-await clickUntilExhausted({
-  page,
-  buttonLocator: loadMoreButton,
-  containerLocator: productsContainer,
-  heartbeat: () => {
-    clickCount++;
-    console.log(`Clicked ${clickCount} times`);
-  },
-  maxClicks: 30,
-  clickDelay: 0.5,
-  noChangeThreshold: 0
-});
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration options
-
-<Expandable title="input">
-<ParamField path="input.page" type="Page">
-Playwright Page object
-</ParamField>
-
-<ParamField path="input.buttonLocator" type="Locator">
-Locator for the button to click repeatedly
-</ParamField>
-
-<ParamField path="input.heartbeat" type="CallableFunction">
-Optional callback invoked after each click
-</ParamField>
-
-<ParamField path="input.containerLocator" type="Locator">
-Optional content container to detect changes
-</ParamField>
-
-<ParamField path="input.maxClicks" type="number">
-Maximum number of times to click the button
-</ParamField>
-
-<ParamField path="input.clickDelay" type="number">
-Delay after each click (in seconds)
-</ParamField>
-
-<ParamField path="input.noChangeThreshold" type="number">
-Minimum change in content size to continue clicking
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<void>`
-
-Promise that resolves when clicking is exhausted

package/generated-docs/helpers/functions/downloadFile.mdx

@@ -1,99 +0,0 @@
----
-title: downloadFile
-description: ""
----
-
-```typescript
-export declare function downloadFile(input: {
-  page: Page;
-  trigger: Trigger;
-  timeoutInMs?: number;
-}): Promise<Download>;
-```
-
-<Note>
-**Trigger Behavior:**
-- **URL**: Creates a new page, navigates to the URL, waits for download, then closes the page
-- **Locator**: Uses the current page to click the element and capture the resulting download
-- **Callback**: Executes the provided function with the page object and captures the first triggered downloads
-</Note>
-
-Downloads a file from a web page using various trigger methods.
-
-This function provides three flexible ways to initiate file downloads:
-1. **URL Navigation**: Directly navigate to a URL that triggers a download
-2. **Element Interaction**: Click on a Playwright locator (e.g., download button or link)
-3. **Custom Callback**: Execute a custom function to trigger the download programmatically
-
-## Examples
-
-<CodeGroup>
-
-```typescript URL trigger
-import { downloadFile } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Download by navigating directly to a URL
-const download = await downloadFile({
-  page,
-  trigger: "https://intuned-docs-public-images.s3.amazonaws.com/32UP83A_ENG_US.pdf"
-});
-console.log(`Downloaded to: ${await download.path()}`);
-}
-```
-
-```typescript Locator trigger
-import { downloadFile } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Download by clicking a link or button
-await page.goto("https://sandbox.intuned.dev/pdfs")
-const download = await downloadFile({
-  page,
-  trigger: page.locator("xpath=//tbody/tr[1]//*[name()='svg']")
-});
-console.log(`File saved at: ${await download.path()}`);
-}
-```
-
-```typescript Callback trigger
-import { downloadFile } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Download using a custom interaction sequence
-await page.goto("https://sandbox.intuned.dev/pdfs")
-const download = await downloadFile({
-  page,
-  trigger: async (page) => {
-    await page.locator("xpath=//tbody/tr[1]//*[name()='svg']").click();
-  }
-});
-console.log(`Download completed: ${await download.path()}`);
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object for the download operation
-
-<Expandable title="input">
-<ParamField path="input.page" type="Page">
-The Playwright Page object to use for the download
-</ParamField>
-
-<ParamField path="input.trigger" type="Trigger">
-The [Trigger](../type-aliases/Trigger) method to initiate the download
-</ParamField>
-
-<ParamField path="input.timeoutInMs" type="number">
-Maximum time in milliseconds to wait for download completion. Defaults to 5000.
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<Download>`
-
-Promise that resolves to a Playwright Download object

package/generated-docs/helpers/functions/extractMarkdown.mdx

@@ -1,56 +0,0 @@
----
-title: extractMarkdown
-description: ""
----
-
-```typescript
-export declare function extractMarkdown(input: {
-  source: Page | Locator;
-}): Promise<string>;
-```
-
-Converts HTML content from a Playwright Page or Locator to semantic markdown format.
-
-## Examples
-
-<CodeGroup>
-
-```typescript locator source
-import { extractMarkdown } from "@intuned/browser";
-export default async function handler(params, page, context){
-await page.goto("https://example.com");
-const headerLocator = page.locator('h1')
-const markdown = await extractMarkdown({ source: headerLocator })
-console.log(markdown); // Outputs the markdown representation of the header
-}
-```
-
-```typescript string source
-import { extractMarkdown } from "@intuned/browser";
-export default async function handler(params, page, context){
-await page.goto("https://example.com");
-const markdown = await extractMarkdown({ source: page });
-console.log(markdown); // Outputs the markdown representation of the page
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing the source of the HTML content
-
-<Expandable title="input">
-<ParamField path="input.source" type="Page | Locator">
-The source of the HTML content. Can be a Playwright Page or a Playwright Locator. If a Playwright Page is provided, the HTML content will be extracted from the entire page. If a Playwright Locator is provided, the HTML content will be extracted from the specific element
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<string>`
-
-Promise that resolves to the markdown representation of the HTML content

package/generated-docs/helpers/functions/filterEmptyValues.mdx

@@ -1,51 +0,0 @@
----
-title: filterEmptyValues
-description: ""
----
-
-```typescript
-export declare function filterEmptyValues<T>(input: { data: T }): T;
-```
-
-Recursively filters out empty values from nested objects and arrays.
-
-This function removes the following empty values:
-- `null` and `undefined` values
-- Empty strings (after trimming whitespace)
-- Empty arrays
-- Empty objects
-- Arrays and objects that become empty after filtering their contents
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Usage
-import { filterEmptyValues } from "@intuned/browser";
-export default async function handler(params, page, context){
-filterEmptyValues({ data: { a: "", b: "hello", c: null } }) // Returns { b: "hello" }
-filterEmptyValues({ data: [1, "", null, [2, ""]] }) // Returns [1, [2]]
-filterEmptyValues({ data: { users: [{ name: "" }, { name: "John" }] } }) // Returns { users: [{ name: "John" }] }
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing the data to filter
-
-<Expandable title="input">
-<ParamField path="input.data" type="T">
-The data structure to filter (object, array, or any other type)
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `T`
-
-Filtered data structure with empty values removed