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

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

@@ -1,124 +0,0 @@
----
-title: goToUrl
-description: ""
----
-
-```typescript
-export declare function goToUrl(input: {
-  page: Page;
-  url: string;
-  timeoutInMs?: number;
-  retries?: number;
-  throwOnTimeout?: boolean;
-  waitForLoadState?: "load" | "domcontentloaded" | "networkidle";
-  waitForLoadingStateUsingAi?: boolean;
-  model?: SUPPORTED_MODELS;
-  apiKey?: string;
-}): Promise<void>;
-```
-
-Navigates to a specified URL with enhanced reliability features including automatic retries with exponential backoff,
-intelligent timeout detection, and optional AI-powered loading verification.
-
-This function handles common navigation challenges by automatically retrying failed requests, detecting navigation hangs, and ensuring the page reaches a truly idle state. For dynamic applications,
-it can optionally verify page loading completion using AI vision to detect loading spinners, blank content, or incomplete states.
-The function can be configured to either throw errors or gracefully continue execution when navigation issues occur.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Navigation
-import { goToUrl } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Navigate with automatic retries on failure
-await goToUrl({
-  page,
-  url: 'https://example.com'
-});
-// Automatically retries up to 3 times with exponential backoff
-}
-```
-
-```typescript Navigation with options
-import { goToUrl } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Navigate to an unreliable site without throwing on timeout
-await goToUrl({
-  page,
-  url: 'https://www.google.com',
-  throwOnTimeout: false, // Continue even if navigation fails
-  retries: 5, // Try more times for unreliable sites
-  timeoutInMs: 60000 // Give it more time
-});
-// If navigation fails after all retries, execution continues
-}
-```
-
-```typescript AI-Verified Loading for Dynamic Sites
-import { goToUrl } from "@intuned/browser";
-export default async function handler(params, page, context){
-await goToUrl({
-  page,
-  url: 'https://sandbox.intuned.dev/',
-  waitForLoadState: "load",
-  waitForLoadingStateUsingAi: true, // AI checks for spinners/loading states
-  model: "gpt-4o",
-  retries: 3
-});
-// AI verifies no loading spinners or blank content before proceeding
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing the page and url
-
-<Expandable title="input">
-<ParamField path="input.page" type="Page">
-The Playwright page object to navigate
-</ParamField>
-
-<ParamField path="input.url" type="string">
-The URL to navigate to
-</ParamField>
-
-<ParamField path="input.retries" type="number">
-Number of retry attempts with exponential backoff (factor: 2, minTimeout: 1000ms). Defaults to 3
-</ParamField>
-
-<ParamField path="input.timeoutInMs" type="number">
-Maximum time in milliseconds to wait for navigation. Defaults to 30000
-</ParamField>
-
-<ParamField path="input.waitForLoadState" type="string">
-When to consider navigation succeeded. Options: "load", "domcontentloaded", "networkidle", "commit". Defaults to "load"
-</ParamField>
-
-<ParamField path="input.throwOnTimeout" type="boolean">
-Whether to throw an error if navigation times out. When false, the function returns without throwing, allowing continued execution. Defaults to true.
-</ParamField>
-
-<ParamField path="input.waitForLoadingStateUsingAi" type="boolean">
-When true, uses AI vision to verify the page is fully loaded by checking for loading spinners, blank content, or incomplete states. Retries up to 4 times with 5-second delays. Defaults to false
-</ParamField>
-
-<ParamField path="input.model" type="SUPPORTED_MODELS">
-AI model to use for loading verification. See [SUPPORTED_MODELS](../type-aliases/SUPPORTED_MODELS) for all supported models. Defaults to "gpt-4o-2024-08-06"
-</ParamField>
-
-<ParamField path="input.apiKey" type="string">
-Optional API key for the AI service (if provided, will not be billed to your account)
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<void>`
-
-Promise that resolves when navigation completes successfully. If the operation fails and `throwOnTimeout` is false, resolves without error

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

@@ -1,55 +0,0 @@
----
-title: processDate
-description: ""
----
-
-```typescript
-export declare function processDate(input: { date: string }): Date | null;
-```
-
-Parses various date string formats into Date objects.
-Returns only the date part (year, month, day) with time set to 00:00:00.
-
-Supports a wide variety of date formats including:
-- DD/MM/YYYY with optional time (e.g., "22/11/2024 21:19:05", "13/12/2024")
-- MM/DD/YYYY with optional time and timezone (e.g., "01/17/2025 3:00:00 PM CT", "10/25/2024")
-- MM/DD/YYYY with time and timezone abbreviations (e.g., "10/23/2024 12:06 PM CST")
-- MM/DD/YYYY with AM/PM time format (e.g., "11/28/2024 1:59:59 AM", "12/09/2024 9:00 AM")
-- MM/DD/YYYY with dash separator and time (e.g., "12/19/2024 - 2:00 PM")
-- M/DD/YYYY and MM/D/YYYY formats (e.g., "8/16/2019", "9/28/2024")
-- DD MMM YYYY with optional time and timezone (e.g., "5 Dec 2024 8:00 AM PST", "11 Sep 2024")
-- Full month name formats (e.g., "November 14, 2024", "January 31, 2025, 5:00 pm")
-- 24-hour time format (e.g., "22/11/2024 19:45:00", "09/01/2025 15:00:00")
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Date Processing
-import { processDate } from "@intuned/browser";
-export default async function handler(params, page, context){
-processDate("22/11/2024 21:19:05") // Returns Date with 2024-11-22 00:00:00
-processDate("5 Dec 2024 8:00 AM PST") // Returns Date with 2024-12-05 00:00:00
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing the date to process
-
-<Expandable title="input">
-<ParamField path="input.date" type="string">
-A string containing a date in various possible formats
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Date | any`
-
-Date object with only date components (time set to 00:00:00) if parsing successful, null if parsing fails

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

@@ -1,165 +0,0 @@
----
-title: resolveUrl
-description: ""
----
-
-<Tabs>
-
-<Tab title="From Base URL String">
-
-```typescript
-export declare function resolveUrl(input: {
-  url: string;
-  baseUrl: string;
-}): Promise<string>;
-```
-
-Converts any URL source to an absolute, properly encoded URL by combining a relative URL with a base URL string.
-
-## Examples
-
-<CodeGroup>
-
-```typescript String source
-import { resolveUrl } from '@intuned/browser';
-export default async function handler(params, page, context){
-await page.goto("https://example.com");
-
-// Using explicit base URL
-const absoluteUrl = await resolveUrl({
-  url: "/api/users",
-  baseUrl: "https://example.com"
-});
-// Returns: "https://example.com/api/users"
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object with different properties based on the overload
-
-<Expandable title="input">
-<ParamField path="input.url" type="string">
-The relative or absolute URL to resolve
-</ParamField>
-
-<ParamField path="input.baseUrl" type="string">
-Base URL string to resolve relative URLs against
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<string>`
-
-Promise that resolves to the absolute, properly encoded URL string
-
-</Tab>
-
-<Tab title="From The Current Page's URL">
-
-```typescript
-export declare function resolveUrl(input: {
-  url: string;
-  page: Page;
-}): Promise<string>;
-```
-
-Converts any URL source to an absolute, properly encoded URL by using the current page's URL as the base URL.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Page source
-import { resolveUrl } from '@intuned/browser';
-export default async function handler(params, page, context){
-await page.goto("https://example.com");
-// Using current page as base URL
-const absoluteUrl = await resolveUrl({
-  url: "/api/users",
-  page: page
-});
-// Returns: "https://example.com/api/users"
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object with different properties based on the overload
-
-<Expandable title="input">
-<ParamField path="input.url" type="string">
-The relative or absolute URL to resolve
-</ParamField>
-
-<ParamField path="input.page" type="Page">
-Playwright Page object to extract base URL from. The current page URL will be used as the base URL
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<string>`
-
-Promise that resolves to the absolute, properly encoded URL string
-
-</Tab>
-
-<Tab title="From Anchor Element">
-
-```typescript
-export declare function resolveUrl(input: { url: Locator }): Promise<string>;
-```
-
-Converts any URL source to an absolute, properly encoded URL by extracting the href attribute from a Playwright Locator pointing to an anchor element.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Locator source
-import { resolveUrl } from '@intuned/browser';
-export default async function handler(params, page, context){
-await page.goto("https://sandbox.intuned.dev/");
-const absoluteUrl = await resolveUrl({
-  url: page.locator("xpath=//a[normalize-space()='Steps Form']"),
-});
-// Returns: "https://sandbox.intuned.dev/steps-form"
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object with different properties based on the overload
-
-<Expandable title="input">
-<ParamField path="input.url" type="Locator">
-Playwright Locator pointing to an anchor element. The href attribute will be extracted and resolved
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<string>`
-
-Promise that resolves to the absolute, properly encoded URL string
-
-</Tab>
-
-</Tabs>

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

@@ -1,113 +0,0 @@
----
-title: sanitizeHtml
-description: ""
----
-
-```typescript
-export declare function sanitizeHtml(options: SanitizeHtmlOptions): string;
-```
-
-Sanitizes and cleans HTML content by removing unwanted elements, attributes, and whitespace.
-Provides fine-grained control over each cleaning operation through configurable options.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Sanitization
-import { sanitizeHtml } from "@intuned/browser";
-export default async function handler(params, page, context){
-const dirtyHtml = `
-  <div>
-    <script>alert('xss')</script>
-    <p style="color: red;">Hello World</p>
-    <span></span>
-  </div>
-`;
-const sanitizedHtml = sanitizeHtml({ html: dirtyHtml });
-// Returns: '<div><p>Hello World</p></div>'
-}
-```
-
-```typescript Sanitization Options
-import { sanitizeHtml } from "@intuned/browser";
-export default async function handler(params, page, context){
-const html = `
-  <div data-long-attr="${'x'.repeat(600)}">
-    <style>.test { color: red; }</style>
-    <script>alert('test')</script>
-    <p style="color: blue;">Content</p>
-    <!-- Comment -->
-  </div>
-`;
-// Keep styles but remove scripts and comments
-const result = sanitizeHtml({ html,
-  removeScripts: true,
-  removeStyles: false,
-  removeComments: true,
-  maxAttributeLength: 100,
-  preserveAttributes: ["class", "src", "style"]
-});
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="options" type="SanitizeHtmlOptions" required
->
-Configuration options for sanitization
-
-<Expandable title="options">
-<ParamField path="options.html" type="string">
-The HTML content to sanitize
-</ParamField>
-
-<ParamField path="options.removeScripts" type="boolean">
-Remove all `<script>` elements. Defaults to true.
-</ParamField>
-
-<ParamField path="options.removeStyles" type="boolean">
-Remove all `<style>` elements. Defaults to true.
-</ParamField>
-
-<ParamField path="options.removeSvgs" type="boolean">
-Remove all `<svg>` elements. Defaults to true.
-</ParamField>
-
-<ParamField path="options.removeComments" type="boolean">
-Remove HTML comments. Defaults to true.
-</ParamField>
-
-<ParamField path="options.removeLongAttributes" type="boolean">
-Remove attributes longer than maxAttributeLength. Defaults to true.
-</ParamField>
-
-<ParamField path="options.maxAttributeLength" type="number">
-Maximum length for attributes before removal. Defaults to 500.
-</ParamField>
-
-<ParamField path="options.preserveAttributes" type="Array<string>">
-List of attribute names to always preserve. Defaults to ["class", "src"].
-</ParamField>
-
-<ParamField path="options.removeEmptyTags" type="boolean">
-Remove empty tags (except preserved ones). Defaults to true.
-</ParamField>
-
-<ParamField path="options.preserveEmptyTags" type="Array<string>">
-List of tag names to preserve even when empty. Defaults to ["img"].
-</ParamField>
-
-<ParamField path="options.minifyWhitespace" type="boolean">
-Remove extra whitespace between tags and empty lines. Defaults to true.
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `string`
-
-The sanitized HTML string

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

@@ -1,127 +0,0 @@
----
-title: saveFileToS3
-description: ""
----
-
-```typescript
-export declare function saveFileToS3(input: {
-  page: Page;
-  trigger: Trigger;
-  timeoutInMs?: number;
-  configs?: S3Configs;
-  fileNameOverride?: string;
-  contentType?: string;
-}): Promise<Attachment>;
-```
-
-<Note>
-**S3 Configuration hierarchy:** (same as `uploadFileToS3`):
-1. Explicit `configs` values from the input
-2. Standard AWS environment variables (`AWS_BUCKET`, `AWS_REGION`, etc.)
-3. Intuned's default S3 configuration as fallback
-
-**Trigger Behavior** (same as `downloadFile`):
-- **URL**: Creates temporary page, navigates to URL, captures download, closes page
-- **Locator**: Uses current page to click element and capture download
-- **Callback**: Executes custom function and captures any resulting downloads
-</Note>
-
-Downloads a file from a web page and automatically uploads it to AWS S3 storage in a single operation.
-
-This convenience function combines the functionality of `downloadFile` and `uploadFileToS3`,
-providing a streamlined workflow for capturing files from web pages and storing them in S3.
-It supports the same flexible trigger methods as `downloadFile` with additional S3 upload configuration.
-
-## Examples
-
-<CodeGroup>
-
-```typescript URL trigger
-import { saveFileToS3 } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Download from URL and upload to S3 with custom configuration
-const uploadedFile = await saveFileToS3({
-  page,
-  trigger: "https://sandbox.intuned.dev/pdfs/report.pdf",
-  configs: {
-     bucket: 'document-storage',
-      region: 'us-east-1',
-      accessKeyId: 'accessKeyId',
-      secretAccessKey: 'SecretAccessKeyId'
-},
-fileNameOverride: 'reports/monthly-report.pdf',
-contentType: 'application/pdf'
-});
-
-console.log(`File uploaded to: ${uploadedFile.getS3Key()}`);
-}
-```
-
-```typescript Locator trigger
-import { saveFileToS3 } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Click download link and save to S3
-await page.goto("https://sandbox.intuned.dev/pdfs")
-const uploadedFile = await saveFileToS3({
-  page,
-  trigger: page.locator("xpath=//tbody/tr[1]//*[name()='svg']"),
-  timeoutInMs: 10000,
-  configs: {
-    bucket: 'invoice-archive',
-    region: 'us-west-2',
-    accessKeyId: 'accessKeyId',
-    secretAccessKey: 'SecretAccessKeyId'
-  },
-  fileNameOverride: 'invoices/invoice.pdf',
-  contentType: 'application/pdf'
-});
-
-// Generate temporary access URL
-const downloadUrl = await uploadedFile.getSignedUrl(7200); // 2 hours
-console.log(`Temporary access: ${downloadUrl}`);
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object for the download and upload operation
-
-<Expandable title="input">
-<ParamField path="input.page" type="Page">
-The Playwright Page object to use for downloading
-</ParamField>
-
-<ParamField path="input.trigger" type="Trigger">
-The [Trigger](../type-aliases/Trigger) method to initiate the download:
-  - **URL string**: Navigate directly to a download URL
-  - **Locator**: Click on an element to trigger download
-  - **Callback function**: Execute custom logic to initiate download
-</ParamField>
-
-<ParamField path="input.timeoutInMs" type="number">
-Maximum time in milliseconds to wait for download completion. Defaults to 5000.
-</ParamField>
-
-<ParamField path="input.configs" type="S3Configs">
-Optional [S3Configs](../interfaces/S3Configs) to customize the S3 upload
-</ParamField>
-
-<ParamField path="input.fileNameOverride" type="string">
-Optional filename override for the uploaded file
-</ParamField>
-
-<ParamField path="input.contentType" type="string">
-Optional content type for the uploaded file
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<Attachment>`
-
-Promise that resolves to an [Attachment](../interfaces/Attachment) object with file metadata and S3 utilities

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

@@ -1,83 +0,0 @@
----
-title: scrollToLoadContent
-description: ""
----
-
-```typescript
-export declare function scrollToLoadContent(input: {
-  source: Page | Locator;
-  onScrollProgress?: CallableFunction;
-  maxScrolls?: number;
-  delayInMs?: number;
-  minHeightChange?: number;
-}): Promise<void>;
-```
-
-Automatically scrolls through infinite scroll content by repeatedly scrolling to the bottom
-until no new content loads or maximum scroll limit is reached.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic Infinite Scroll
-import { scrollToLoadContent } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Scroll through entire page content
-await page.goto("https://docs.intunedhq.com/docs-old/getting-started/introduction")
-await scrollToLoadContent({
-  source: page,
-});
-// Now all content is loaded and visible
-}
-```
-
-```typescript Scroll Specific Container
-import { scrollToLoadContent } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Scroll through a specific scrollable div
-await page.goto("https://docs.intunedhq.com/docs-old/getting-started/introduction")
-const container = page.locator("xpath=//div[@id='sidebar-content']");
-await scrollToLoadContent({
-  source: container,
-  maxScrolls: 20
-});
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing the data to scroll to load content
-
-<Expandable title="input">
-<ParamField path="input.source" type="Page | Locator">
-The Playwright Page or Locator to scroll
-</ParamField>
-
-<ParamField path="input.onScrollProgress" type="Function">
-Optional callback function to call during each scroll iteration
-</ParamField>
-
-<ParamField path="input.maxScrolls" type="number">
-Maximum number of scroll attempts before stopping. Defaults to 50
-</ParamField>
-
-<ParamField path="input.delayInMs" type="number">
-Delay in milliseconds between scroll attempts. Defaults to 100
-</ParamField>
-
-<ParamField path="input.minHeightChange" type="number">
-Minimum height change in pixels required to continue scrolling. Defaults to 100
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<void>`
-
-Promise that resolves when scrolling is complete