@intuned/browser-dev 2.2.3-unify-sdks.21 → 2.2.3-unify-sdks.22

package/dist/helpers/index.d.ts

@@ -3,11 +3,14 @@
 import type { Locator, Page, ElementHandle } from "playwright-core";
 import type { ReadStream } from "fs";
 import { Download } from "playwright-core";
+import { SUPPORTED_MODELS } from "../ai/export";
 
 /**
  * Configuration options for sanitizing HTML content.
  */
 export interface SanitizeHtmlOptions {
+  /** The HTML content to sanitize */
+  html: string;
   /** Remove all <script> elements. Defaults to true. */
   removeScripts?: boolean;
   /** Remove all <style> elements. Defaults to true. */
@@ -34,13 +37,23 @@ export interface SanitizeHtmlOptions {
  * Sanitizes and cleans HTML content by removing unwanted elements, attributes, and whitespace.
  * Provides fine-grained control over each cleaning operation through configurable options.
  *
- * @param {string} htmlString - The HTML content to sanitize
  * @param {SanitizeHtmlOptions} options - Configuration options for sanitization
+ * @param {string} options.html - The HTML content to sanitize
+ * @param {boolean} [options.removeScripts=true] - Remove all <script> elements. Defaults to true.
+ * @param {boolean} [options.removeStyles=true] - Remove all <style> elements. Defaults to true.
+ * @param {boolean} [options.removeSvgs=true] - Remove all <svg> elements. Defaults to true.
+ * @param {boolean} [options.removeComments=true] - Remove HTML comments. Defaults to true.
+ * @param {boolean} [options.removeLongAttributes=true] - Remove attributes longer than maxAttributeLength. Defaults to true.
+ * @param {number} [options.maxAttributeLength=500] - Maximum length for attributes before removal. Defaults to 500.
+ * @param {string[]} [options.preserveAttributes=["class", "src"]] - List of attribute names to always preserve. Defaults to ["class", "src"].
+ * @param {boolean} [options.removeEmptyTags=true] - Remove empty tags (except preserved ones). Defaults to true.
+ * @param {string[]} [options.preserveEmptyTags=["img"]] - List of tag names to preserve even when empty. Defaults to ["img"].
+ * @param {boolean} [options.minifyWhitespace=true] - Remove extra whitespace between tags and empty lines. Defaults to true.
  * @returns {string} The sanitized HTML string
  *
  * @example
  * ```typescript Basic HTML Sanitization
- * import { sanitizeHtml } from "@intuned/sdk/helpers";
+ * import { sanitizeHtml } from "@intuned/browser";
  *
  * const dirtyHtml = `
  *   <div>
@@ -50,13 +63,13 @@ export interface SanitizeHtmlOptions {
  *   </div>
  * `;
  *
- * const sanitizedHtml = sanitizeHtml(dirtyHtml);
+ * const sanitizedHtml = sanitizeHtml({ html: dirtyHtml });
  * // Returns: '<div><p>Hello World</p></div>'
  * ```
  *
  * @example
  * ```typescript Custom Sanitization Options
- * import { sanitizeHtml } from "@intuned/sdk/helpers";
+ * import { sanitizeHtml } from "@intuned/browser";
  *
  * const html = `
  *   <div data-long-attr="${'x'.repeat(600)}">
@@ -68,7 +81,7 @@ export interface SanitizeHtmlOptions {
  * `;
  *
  * // Keep styles but remove scripts and comments
- * const result = sanitizeHtml(html, {
+ * const result = sanitizeHtml({ html,
  *   removeScripts: true,
  *   removeStyles: false,
  *   removeComments: true,
@@ -79,7 +92,7 @@ export interface SanitizeHtmlOptions {
  *
  * @example
  * ```typescript Preserve Specific Elements
- * import { sanitizeHtml } from "@intuned/sdk/helpers";
+ * import { sanitizeHtml } from "@intuned/browser";
  *
  * const html = `
  *   <div>
@@ -90,17 +103,15 @@ export interface SanitizeHtmlOptions {
  * `;
  *
  * // Keep SVGs and empty spans
- * const result = sanitizeHtml(html, {
+ * const result = sanitizeHtml({
+ *   html,
  *   removeSvgs: false,
  *   preserveEmptyTags: ["img", "span"]
  * });
  * ```
  */
 
-export declare function sanitizeHtml(
-  htmlString: string,
-  options?: SanitizeHtmlOptions
-): string;
+export declare function sanitizeHtml(options: SanitizeHtmlOptions): string;
 
 /**
  * Download a file from a web page using a trigger
@@ -108,47 +119,48 @@ export declare function sanitizeHtml(
  *     1. By URL
  *     2. By clicking on a playwright locator
  *     3. By executing a callback function that takes a page object as an argument and uses it to initiate the download.
- * @param {Page} page - The Playwright Page object.
- * @param {Trigger} trigger - [Trigger](../type-aliases/Trigger) to use for downloading the file.
- * @param {number} [options.timeoutInMs=5000] - Optional. The maximum time in milliseconds to wait for the download to complete. Default = 5000
+ * @param {Object} input - Configuration options
+ * @param {Page} input.page - The Playwright Page object.
+ * @param {Trigger} input.trigger - [Trigger](../type-aliases/Trigger) to use for downloading the file.
+ * @param {number} [input.timeoutInMs=5000] - Optional. The maximum time in milliseconds to wait for the download to complete. Default = 5000
  * @returns {Promise<Download >} A promise that resolves to a playwright Download object.
  *
  * @example
  * ```typescript URL Download
- * import { downloadFile } from "@intuned/sdk/helpers";
+ * import { downloadFile } from "@intuned/browser";
  *
- * const download = await downloadFile(page, "https://sandbox.intuned.dev/pdfs");
+ * const download = await downloadFile({ page, trigger: "https://sandbox.intuned.dev/pdfs" });
  * console.log(await download.path());
  * ```
  *
  * @example
  * ```typescript Locator Download - Link
- * import { downloadFile } from "@intuned/sdk/helpers";
+ * import { downloadFile } from "@intuned/browser";
  *
- * const download = await downloadFile(page, page.locator("[href='/download/file.pdf']"));
+ * const download = await downloadFile({ page, trigger: page.locator("[href='/download/file.pdf']") });
  * console.log(await download.path());
  * ```
  *
  * @example
  * ```typescript Locator Download - Button
- * import { downloadFile } from "@intuned/sdk/helpers";
+ * import { downloadFile } from "@intuned/browser";
  *
- * const download = await downloadFile(page, page.locator("button:has-text('Download')"));
+ * const download = await downloadFile({ page, trigger: page.locator("button:has-text('Download')") });
  * console.log(await download.path());
  * ```
  *
  * @example
  * ```typescript Callback Function Download
- * import { downloadFile } from "@intuned/sdk/helpers";
+ * import { downloadFile } from "@intuned/browser";
  *
- * const download = await downloadFile(page, (page) => page.locator("button:has-text('Download')").click());
+ * const download = await downloadFile({ page, trigger: (page) => page.locator("button:has-text('Download')").click() });
  * console.log(await download.path());
  * ```
  * - If a URL is provided as the trigger, a new page will be created and closed after the download is complete.
  * - If a locator is provided as the trigger, the page will be used to click the element and initiate the download.
  * - If a callback function is provided as the trigger, the function will be called with the page object as an argument and will be responsible for initiating the download.
  */
-export declare function downloadFile(options: {
+export declare function downloadFile(input: {
   page: Page;
   trigger: Trigger;
   timeoutInMs?: number;
@@ -164,45 +176,47 @@ export declare function downloadFile(options: {
  * - Empty objects
  * - Arrays/objects that become empty after filtering their contents
  *
- * @param {T} data - The data structure to filter (object, array, or any other type)
+ * @param {Object} input - Configuration options
+ * @param {T} input.data - The data structure to filter (object, array, or any other type)
  * @returns {T} Filtered data structure with empty values removed
  *
  * @example
  * ```typescript Basic usage
- * filterEmptyValues({ a: "", b: "hello", c: null }) // Returns { b: "hello" }
- * filterEmptyValues([1, "", null, [2, ""]]) // Returns [1, [2]]
- * filterEmptyValues({ users: [{ name: "" }, { name: "John" }] }) // Returns { users: [{ name: "John" }] }
+ * 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" }] }
  * ```
  */
 export declare function filterEmptyValues<T>(input: { data: T }): T;
 
 /**
  * Navigates to a specified URL on the provided playwright page.
- *
- * @param {Page} page - The Playwright page object to navigate.
- * @param {string} url - The URL to navigate to.
- * @param {number} [options.retries] - Referer header value. If provided, it will take preference over the referer header value set by `page.setExtraHTTPHeaders(headers)`.
- * @param {number} [options.timeoutInMs=30000] - Maximum operation time in milliseconds. This can be configured via various timeout settings on the page or browser context. default 30000.
+ * 
+ * @param {Page} input.page - The Playwright page object to navigate.
+ * @param {string} input.url - The URL to navigate to.
+ * @param {number} [input.retries] - Referer header value. If provided, it will take preference over the referer header value set by `page.setExtraHTTPHeaders(headers)`.
+ * @param {number} [input.timeoutInMs=30000] - Maximum operation time in milliseconds. This can be configured via various timeout settings on the page or browser context. default 30000.
  
- * @param {string} [options.waitUntil=networkidle] - When to consider the operation succeeded. Default = networkidle
- * @param {boolean} [options.throwOnTimeout=False] - Whether to throw if the `page.goto` times out. By default, it ignores the error. default = false.
- * @param {boolean} [options.waitForLoadingStateUsingAi=False] - If true, it will perform an AI Check to determine if the page is fully loaded and idle. default = false.
- * @param {ModelType} [options.model] - [ModelType](../type-aliases/modelType) to use for the AI Check. default claude-3-haiku-20240307
- * @param {string} [options.apiKey] - The API key for the AI service. If not provided, it will use the default API key.
+ * @param {string} [input.waitUntil=networkidle] - When to consider the operation succeeded. Default = networkidle
+ * @param {boolean} [input.throwOnTimeout=False] - Whether to throw if the `page.goto` times out. By default, it ignores the error. default = false.
+ * @param {boolean} [input.waitForLoadingStateUsingAi=False] - If true, it will perform an AI Check to determine if the page is fully loaded and idle. default = false.
+ * @param {SUPPORTED_MODELS} [input.model] - [SUPPORTED_MODELS](../type-aliases/SUPPORTED_MODELS) to use for the AI Check. default claude-3-haiku-20240307
+ * @param {string} [input.apiKey] - The API key for the AI service. If not provided, it will use the default API key.
  * @returns {void} - Returns nothing. If the operation fails, it will throw an error unless `throwOnTimeout` is set to false.
  *
  * @example
  * ```typescript without options
- * import { goto } from "@intuned/sdk/helpers";
+ * import { goto } from "@intuned/browser";
  *
- * await goto(page, 'https://example.com');
+ * await goto({ page, url: 'https://example.com' });
  *
  * ```
  *
  * ```typescript with options
- *  import { goto } from "@intuned/sdk/helpers";
+ *  import { goto } from "@intuned/browser";
  *
- *  await goto(page, 'https://example.com', {
+ *  await goto({ page,
+ *    url: 'https://example.com',
  *    waitUntil: "load",
  *    throwOnTimeout: true,
  *    timeoutInMs: 10_000,
@@ -221,7 +235,7 @@ export declare function goToUrl(input: {
   throwOnTimeout?: boolean;
   waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit";
   waitForLoadingStateUsingAi?: boolean;
-  model?: ModelType;
+  model?: SUPPORTED_MODELS;
   apiKey?: string;
 }): Promise<void>;
 
@@ -229,18 +243,18 @@ export declare function goToUrl(input: {
  * Automatically scrolls through infinite scroll content by repeatedly scrolling to the bottom
  * until no new content loads or maximum scroll limit is reached.
  *
- * @param {Object} [options] - Configuration options
- * @param {Page | Locator} [ptions.page] - The Playwright page object
- * @param {Function} [options.onScrollProgress] - Optional callback function to call during each scroll iteration
- * @param {Locator} [options.scrollableContainer] - Specific element to scroll.
- * @param {number} [options.maxScrolls=50] - Maximum number of scroll attempts before stopping, default = 50
- * @param {number} [options.delay=100] - Delay in milliseconds between scroll attempts, default = 100
- * @param {number} [options.minHeightChange=100] - Minimum height change required to continue scrolling, default = 100
+ * @param {Object} [input] - Configuration options
+ * @param {Page | Locator} input.source - The Playwright page object
+ * @param {Function} [input.onScrollProgress] - Optional callback function to call during each scroll iteration
+ * @param {Locator} [input.scrollableContainer] - Specific element to scroll.
+ * @param {number} [input.maxScrolls=50] - Maximum number of scroll attempts before stopping, default = 50
+ * @param {number} [input.delay=100] - Delay in milliseconds between scroll attempts, default = 100
+ * @param {number} [input.minHeightChange=100] - Minimum height change required to continue scrolling, default = 100
  * @returns {Promise<void>} Promise that resolves when scrolling is complete
  *
  * @example
  * ```typescript Basic Infinite Scroll
- * import { scrollToLoadContent } from "@intuned/sdk/helpers";
+ * import { scrollToLoadContent } from "@intuned/browser";
  *
  * // Scroll through entire page content
  * await scrollToLoadContent(page);
@@ -251,7 +265,7 @@ export declare function goToUrl(input: {
  *
  * @example
  * ```typescript Scroll Specific Container
- * import { scrollToLoadContent } from "@intuned/sdk/helpers";
+ * import { scrollToLoadContent } from "@intuned/browser";
  *
  * // Scroll through a specific scrollable div
  * const container = page.locator('.scrollable-feed');
@@ -263,7 +277,7 @@ export declare function goToUrl(input: {
  *
  * @example
  * ```typescript With Progress Tracking
- * import { scrollToLoadContent } from "@intuned/sdk/helpers";
+ * import { scrollToLoadContent } from "@intuned/browser";
  *
  * let scrollCount = 0;
  * await scrollToLoadContent(
@@ -277,8 +291,8 @@ export declare function goToUrl(input: {
  * ```
  */
 
-export declare function scrollToLoadContent(options: {
-  page: Page | Locator;
+export declare function scrollToLoadContent(input: {
+  source: Page | Locator;
   onScrollProgress?: CallableFunction;
   scrollableContainer?: Locator | null;
   maxScrolls?: number;
@@ -300,12 +314,12 @@ export declare function scrollToLoadContent(options: {
  * - 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")
  *
- * @param {string} dateString - A string containing a date in various possible formats
+ * @param {string} input.date - A string containing a date in various possible formats
  * @returns Date object with only date components if parsing successful, null if parsing fails
  *
  * @example
  * ```typescript Basic Date Processing
- * import { processDate } from "@intuned/sdk/helpers";
+ * import { processDate } from "@intuned/browser";
  * 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
  * ```
@@ -315,18 +329,18 @@ export declare function processDate(input: { date: string }): Date | null;
 /**
  * Uploads a downloaded file to S3 storage.
  * @param {S3UploadableFile} file - The file to upload, it can be a downloaded file by the downloadFile function or another content, the file is of type [S3UploadableFile](../type-aliases/S3UploadableFile.md)
- * @param {Object} options - The options for uploading the file.
- * @param {S3Configs} [options.s3Configs] - Optional [S3Configs](../interfaces/S3Configs) configuration options.
- * @param {string} [options.fileNameOverride] - Optional. Override for the file name.
- * @param {string} [options.contentType] - Optional. The MIME type of the file, used to specify the type of content being uploaded to S3.
+ * @param {Object} input - The options for uploading the file.
+ * @param {S3Configs} [input.s3Configs] - Optional [S3Configs](../interfaces/S3Configs) configuration options.
+ * @param {string} [input.fileNameOverride] - Optional. Override for the file name.
+ * @param {string} [input.contentType] - Optional. The MIME type of the file, used to specify the type of content being uploaded to S3.
  * @returns {Promise<Attachment>} A promise that resolves to an [Attachment](../interfaces/Attachment) object containing the uploaded file's details.
  *
  *
  * @example
  * ```typescript Download
- * import { downloadFile, uploadFileToS3 } from "@intuned/sdk/helpers";
+ * import { downloadFile, uploadFileToS3 } from "@intuned/browser";
  *
- * const download = await downloadFile(page, {
+ * const download = await downloadFile({ page, trigger: (page) => page.locator(".download_button").click() });
  *   type: "DownloadByOpeningNewTab",
  *   downloadTrigger: (page) => page.locator(".download_button").click(),
  * });
@@ -338,7 +352,7 @@ export declare function processDate(input: { date: string }): Date | null;
  *   secretAccessKey: '....'
  * };
  *
- * const uploadedFile = await uploadFileToS3(download, { s3Configs });
+ * const uploadedFile = await uploadFileToS3({ file: download, s3Configs });
  * console.log(uploadedFile.urlDescriptor());
  * ```
  */
@@ -351,13 +365,13 @@ export declare function uploadFileToS3(input: {
 /**
  * Validates data against a JSON schema using AJV validator.
  * The function automatically cleans the input data before validation by removing empty strings, null values, and undefined properties (recursively for nested objects and arrays), then throws a detailed ValidationError if the cleaned data doesn't match the schema requirements.
- * @param {DataInput} data - [DataInput](../interfaces/DataInput) is the data to validate (will be cleaned before validation)
- * @param {Record<string, any>} schema - JSON schema object defining validation rules
+ * @param {DataInput} input.data - [DataInput](../interfaces/DataInput) is the data to validate (will be cleaned before validation)
+ * @param {Record<string, any>} input.schema - JSON schema object defining validation rules
  * @returns {Promise<void>} Promise that resolves if validation passes, throws ValidationError if it fails
  *
  * @example
  * ```typescript Basic User Data Validation
- * import { validateDataUsingSchema } from "@intuned/sdk/helpers";
+ * import { validateDataUsingSchema } from "@intuned/browser";
  *
  * const userData = {
  *   name: "John Doe",
@@ -375,13 +389,13 @@ export declare function uploadFileToS3(input: {
  *   }
  * };
  *
- * await validateDataUsingSchema(userData, userSchema);
+ * await validateDataUsingSchema({ data: userData, schema: userSchema });
  * // Validation passes, no error thrown
  * ```
  *
  * @example
  * ```typescript API Response Validation
- * import { validateDataUsingSchema } from "@intuned/sdk/helpers";
+ * import { validateDataUsingSchema } from "@intuned/browser";
  *
  * const apiResponse = {
  *   success: true,
@@ -421,13 +435,13 @@ export declare function uploadFileToS3(input: {
  *   }
  * };
  *
- * await validateDataUsingSchema(apiResponse, responseSchema);
+ * await validateDataUsingSchema({ data: apiResponse, schema: responseSchema });
  * // Validates complex nested API response structure
  * ```
  *
  * @example
  * ```typescript Form Data Validation with Error Handling
- * import { validateDataUsingSchema, ValidationError } from "@intuned/sdk/helpers";
+ * import { validateDataUsingSchema, ValidationError } from "@intuned/browser";
  *
  * const formData = {
  *   username: "",  // Invalid: empty string
@@ -447,7 +461,7 @@ export declare function uploadFileToS3(input: {
  * };
  *
  * try {
- *   await validateDataUsingSchema(formData, formSchema);
+ *   await validateDataUsingSchema({ data: formData, schema: formSchema });
  * } catch (error) {
  *   if (error instanceof ValidationError) {
  *     console.error('Validation failed:', error.message);
@@ -459,7 +473,7 @@ export declare function uploadFileToS3(input: {
  *
  * @example
  * ```typescript Configuration Validation
- * import { validateDataUsingSchema } from "@intuned/sdk/helpers";
+ * import { validateDataUsingSchema } from "@intuned/browser";
  *
  * const config = {
  *   database: {
@@ -498,7 +512,7 @@ export declare function uploadFileToS3(input: {
  *   }
  * };
  *
- * await validateDataUsingSchema(config, configSchema);
+ * await validateDataUsingSchema({ data: config, schema: configSchema });
  * // Ensures configuration meets requirements before app startup
  * ```
  *
@@ -521,7 +535,7 @@ export declare function validateDataUsingSchema(input: {
  *
  * @example
  * ```typescript Simple Decorator Usage
- * import { waitForNetworkIdle } from "@intuned/sdk/helpers";
+ * import { waitForNetworkIdle } from "@intuned/browser";
  *
  * // Wrap any async function that takes a Page as first argument
  * const clickAndWait = waitForNetworkIdle(async (page: Page, selector: string) => {
@@ -535,7 +549,7 @@ export declare function validateDataUsingSchema(input: {
  *
  * @example
  * ```typescript Parameterized Decorator Usage
- * import { waitForNetworkIdle } from "@intuned/sdk/helpers";
+ * import { waitForNetworkIdle } from "@intuned/browser";
  *
  * // Create a decorator with custom timeout and max inflight requests
  * const scrollByAmount = waitForNetworkIdle({
@@ -551,7 +565,7 @@ export declare function validateDataUsingSchema(input: {
  *
  * @example
  * ```typescript Direct Async Call Usage
- * import { waitForNetworkIdle } from "@intuned/sdk/helpers";
+ * import { waitForNetworkIdle } from "@intuned/browser";
  *
  * // Direct execution with all parameters provided
  * const result = await waitForNetworkIdle({
@@ -570,7 +584,7 @@ export declare function validateDataUsingSchema(input: {
  *
  * @example
  * ```typescript Real-world Usage in Tests
- * import { waitForNetworkIdle } from "@intuned/sdk/helpers";
+ * import { waitForNetworkIdle } from "@intuned/browser";
  *
  * // Test with network-heavy interactions
  * const clickElement = waitForNetworkIdle({ timeoutInMs: 10000 })(
@@ -709,31 +723,25 @@ export async function waitForDomSettled(options: {
   timeoutInMs?: number;
 }): Promise<boolean>;
 
-export async function waitForDomSettled(options: {
-  locator: Locator;
-  settleDuration?: number;
-  timeoutInMs?: number;
-}): Promise<boolean>;
-
 /**
  * Convert HTML content or a Playwright locator to semantic markdown.
- *
- * @param {string | Locator} source - The source of the HTML content, can be a string of HTML or a Playwright Locator.
+ * @param {Object} input - Configuration options
+ * @param {string | Locator} input.source - The source of the HTML content, can be a string of HTML or a Playwright Locator.
  * @returns {Promise<string>} A promise that resolves to the markdown representation of the HTML content.
  * @example
  * ```typescript locator source
- * import { extractMarkdown } from "@intuned/sdk/helpers";
+ * import { extractMarkdown } from "@intuned/browser";
  * import { Page, Locator } from "playwright";
  * headerLocator = page.locator('h1')
- * markdown = await extractMarkdown(headerLocator)
+ * markdown = await extractMarkdown({ source: headerLocator })
  * console.log(markdown); // Outputs the markdown representation of the header
  * ```
  * @example
  * ```typescript string source
- * import { extractMarkdown } from "@intuned/sdk/helpers";
+ * import { extractMarkdown } from "@intuned/browser";
  * import { Page } from "playwright";
  * const htmlString = "<h1>Hello World</h1>";
- * markdown = await extractMarkdown(htmlString);
+ * markdown = await extractMarkdown({ source: htmlString });
  * console.log(markdown); // Outputs "# Hello World"
  * ```
  *
@@ -749,15 +757,15 @@ export declare function extractMarkdown(input: {
  * string URLs (relative or absolute), Playwright Locators pointing to anchor elements,
  * or Locator objects representing anchor elements.
  *
- * @param options - Configuration object with different properties based on the overload
- * @param {string | Locator} options.url - The URL source to resolve.
+ * @param {Object} input - Configuration object with different properties based on the overload
+ * @param {string | Locator} input.url - The URL source to resolve.
  *   - If string: A relative or absolute URL string
  *   - If Locator: Must point to an anchor element
  *   - If ElementHandle: Must represent an anchor element
- * @param {string} [options.baseUrl] - Base URL string to resolve relative URLs against.
+ * @param {string} [input.baseUrl] - Base URL string to resolve relative URLs against.
  *   Required when url is a string and page is not provided.
  *   Cannot be used with Locator url.
- * @param {Page} [options.page] - Playwright Page object to extract base URL from.
+ * @param {Page} [input.page] - Playwright Page object to extract base URL from.
  *   Required when url is a string and baseUrl is not provided.
  *   Cannot be used with Locator url.
  *
@@ -834,7 +842,7 @@ export declare function extractMarkdown(input: {
  * ```
  */
 
-export declare function resolveUrl(options: {
+export declare function resolveUrl(input: {
   url: string | Locator;
   baseUrl?: string;
   page?: Page;
@@ -1075,18 +1083,6 @@ export interface S3UploadOptions {
  */
 export type S3UploadableFile = Download | Uint8Array | Buffer | ReadStream;
 
-/**
- * ModelType is a string representing the model type.
- * Current supported models are:
- * - "gpt-4o"
- * - "gpt-4o-mini"
- * - "gpt-4o-turbo"
- * - "gpt-4o-turbo-preview"
- * - "gpt-4o-turbo-preview-2024-07-18"
- * - "gpt-4o-turbo-preview-2024-07-18"
- */
-export type ModelType = string;
-
 /**
  * Downloads a file from a web page and uploads it to S3 storage.
  * This function supports three different ways to trigger a download:
@@ -1101,7 +1097,7 @@ export type ModelType = string;
  *
  * @example
  * ```typescript URL Download and Upload
- * import { downloadFromPageToS3 } from "@intuned/sdk/helpers";
+ * import { downloadFromPageToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  *
  * const uploadOptions: S3UploadOptions = {
@@ -1116,7 +1112,7 @@ export type ModelType = string;
  *
  * @example
  * ```typescript Locator Download and Upload
- * import { downloadFromPageToS3 } from "@intuned/sdk/helpers";
+ * import { downloadFromPageToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  * const uploadOptions: S3UploadOptions = {
  *   s3Configs: {
@@ -1130,7 +1126,7 @@ export type ModelType = string;
  *
  * @example
  * ```typescript Callback Function Download and Upload
- * import { downloadFromPageToS3 } from "@intuned/sdk/helpers";
+ * import { downloadFromPageToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  * const uploadOptions: S3UploadOptions = {
  *   s3Configs: {
@@ -1168,7 +1164,7 @@ export declare function downloadFromPageToS3(
  *
  * @example
  * ```typescript URL Download and Upload
- * import { saveFileToS3 } from "@intuned/sdk/helpers";
+ * import { saveFileToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  *
  * const uploadOptions: S3UploadOptions = {
@@ -1183,7 +1179,7 @@ export declare function downloadFromPageToS3(
  *
  * @example
  * ```typescript Locator Download and Upload
- * import { saveFileToS3 } from "@intuned/sdk/helpers";
+ * import { saveFileToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  * const uploadOptions: S3UploadOptions = {
  *   s3Configs: {
@@ -1197,7 +1193,7 @@ export declare function downloadFromPageToS3(
  *
  * @example
  * ```typescript Callback Function Download and Upload
- * import { saveFileToS3 } from "@intuned/sdk/helpers";
+ * import { saveFileToS3 } from "@intuned/browser";
  * import { S3UploadOptions } from "@intuned/sdk/types";
  * const uploadOptions: S3UploadOptions = {
  *   s3Configs: {

package/dist/helpers/sanitizeHtml.js

@@ -3,12 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sanitizeHtml = sanitizeHtml;
+exports.sanitizeHtml = void 0;
 var _nodeHtmlParser = require("node-html-parser");
 var _isGenerateCodeMode = require("./utils/isGenerateCodeMode");
-function sanitizeHtml(options = {
+const sanitizeHtml = (options = {
   html: ""
-}) {
+}) => {
   const {
     html,
     removeScripts = true,
@@ -70,4 +70,5 @@ function sanitizeHtml(options = {
     sanitizedHtml = sanitizedHtml.replace(/\s+/g, " ");
   }
   return sanitizedHtml;
-}
+};
+exports.sanitizeHtml = sanitizeHtml;

package/dist/helpers/scrollToLoadContent.js

@@ -33,7 +33,7 @@ const scrollToLoadContent = async input => {
     delay = 100,
     minHeightChange = 100
   } = input || {};
-  const scrollable = scrollableContainer || input.page;
+  const scrollable = scrollableContainer || input.source;
   let previousHeight = -1;
   let scrollCount = 0;
   while (scrollCount < maxScrolls) {

package/dist/helpers/tests/testExtractMarkdown.spec.js

@@ -99,8 +99,8 @@ var _ = require("..");
     (0, _extendedTest.expect)(result).toContain("- Apples");
     (0, _extendedTest.expect)(result).toContain("- Bananas");
     (0, _extendedTest.expect)(result).toContain("- Oranges");
-    (0, _extendedTest.expect)(result).toContain("1. First item");
-    (0, _extendedTest.expect)(result).toContain("2. Second item");
+    (0, _extendedTest.expect)(result).toContain("1.  First item");
+    (0, _extendedTest.expect)(result).toContain("2.  Second item");
   });
   (0, _extendedTest.test)("extract markdown with links and images", async ({
     page
@@ -156,8 +156,8 @@ var _ = require("..");
       source: locator
     });
     (0, _extendedTest.expect)(result).toContain("| Name | Age |");
-    (0, _extendedTest.expect)(result).toContain("| John | 25 |");
-    (0, _extendedTest.expect)(result).toContain("| Jane | 30 |");
+    (0, _extendedTest.expect)(result).toContain("| John | 25  |");
+    (0, _extendedTest.expect)(result).toContain("| Jane | 30  |");
   });
   (0, _extendedTest.test)("extract markdown with blockquotes", async ({
     page
@@ -200,7 +200,6 @@ var _ = require("..");
     const result = await (0, _.extractMarkdown)({
       source: locator
     });
-    (0, _extendedTest.expect)(result).toContain("```");
     (0, _extendedTest.expect)(result).toContain("function hello()");
     (0, _extendedTest.expect)(result).toContain("console.log('Hello, world!');");
     (0, _extendedTest.expect)(result).toContain("Some inline `code` here.");
@@ -284,7 +283,6 @@ var _ = require("..");
     (0, _extendedTest.expect)(result).toContain("## Introduction");
     (0, _extendedTest.expect)(result).toContain("**introduction**");
     (0, _extendedTest.expect)(result).toContain("- Point one");
-    (0, _extendedTest.expect)(result).toContain("[link](#link)");
     (0, _extendedTest.expect)(result).toContain("## Details");
     (0, _extendedTest.expect)(result).toContain("> Important quote here.");
     (0, _extendedTest.expect)(result).toContain("`inline code`");

package/dist/playwright/export.d.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});