@intuned/browser-dev 0.1.6-dev.1 → 0.1.8-dev.0

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

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

@@ -1,121 +0,0 @@
----
-title: uploadFileToS3
-description: ""
----
-
-```typescript
-export declare function uploadFileToS3(input: {
-  file: FileType;
-  configs?: S3Configs;
-  fileNameOverride?: string;
-  contentType?: string;
-}): Promise<Attachment>;
-```
-
-<Note>
-**S3 Configuration Priority:**
-1. **Explicit configs**: Values provided in `input.configs.s3Configs`
-2. **Environment variables**: Standard AWS environment variables:
-   - `AWS_BUCKET`
-   - `AWS_REGION`
-   - `AWS_ACCESS_KEY_ID`
-   - `AWS_SECRET_ACCESS_KEY`
-   - `AWS_ENDPOINT_URL`
-3. **Default fallback**: Intuned's default S3 configuration
-</Note>
-
-Uploads files to AWS S3 storage with flexible configuration options.
-
-This function accepts various file types including Playwright Download objects, binary data,
-and file streams, making it versatile for different upload scenarios. It automatically
-handles file metadata and provides comprehensive S3 configuration options.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Upload Downloaded File
-import { downloadFile, uploadFileToS3 } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Download and upload a file with custom S3 configuration
-await page.goto("https://sandbox.intuned.dev/pdfs")
-const download = await downloadFile({
-  page,
-  trigger: page.locator("xpath=//tbody/tr[1]//*[name()='svg']")
-});
-
-const uploadedFile = await uploadFileToS3({
-  file: download,
-  configs: {
-      bucket: 'my-documents',
-      region: 'us-west-2',
-      accessKeyId: 'accessKeyId',
-      secretAccessKey: 'SecretAccessKeyId'
-    },
-    fileNameOverride: 'reports/monthly-report.pdf'
-  }
-});
-
-console.log(`File uploaded: ${uploadedFile.suggestedFileName}`);
-console.log(`S3 URL: ${uploadedFile.getS3Key()}`);
-}
-```
-
-```typescript Upload Binary Data
-import { uploadFileToS3 } from "@intuned/browser";
-export default async function handler(params, page, context){
-// Upload binary data with minimal configuration
-const fileBuffer = Buffer.from('Hello World', 'utf8');
-const uploadedFile = await uploadFileToS3({
-  file: fileBuffer,
-  configs: {
-    bucket: 'my-documents',
-    region: 'us-west-2',
-    accessKeyId: 'accessKeyId',
-    secretAccessKey: 'SecretAccessKeyId'
-  },
-  fileNameOverride: 'data/text-file.txt',
-  contentType: 'text/plain'
-  }
-});
-
-// Generate a temporary download URL
-const downloadUrl = await uploadedFile.getSignedUrl(3600); // 1 hour
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-Configuration object for the upload operation
-
-<Expandable title="input">
-<ParamField path="input.file" type="FileType">
-The file to upload. Accepts [FileType](../type-aliases/FileType) types including:
-  - Playwright Download objects (from `downloadFile`)
-  - Uint8Array or Buffer (binary data)
-  - ReadStream (file streams)
-</ParamField>
-
-<ParamField path="input.configs" type="S3Configs">
-Optional [S3Configs](../interfaces/S3Configs) for customizing the S3 upload. If not provided, uses environment variables or default configuration
-</ParamField>
-
-<ParamField path="input.fileNameOverride" type="string">
-Optional custom filename for the uploaded file. If not provided, uses the original filename
-</ParamField>
-
-<ParamField path="input.contentType" type="string">
-Optional MIME type for the uploaded file (e.g., "application/pdf", "image/png")
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `Promise<Attachment>`
-
-Promise that resolves to an [Attachment](../interfaces/Attachment) object with file metadata and utility methods

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

@@ -1,90 +0,0 @@
----
-title: validateDataUsingSchema
-description: ""
----
-
-```typescript
-export declare function validateDataUsingSchema(input: {
-  data: Record<string, any>[] | Record<string, any>;
-  schema: Record<string, any>;
-}): void;
-```
-
-Validates data against a JSON schema using the AJV validator.
-This function can validate any given data against a given schema. It supports validating custom data types such as the [Attachment](../interfaces/Attachment) type.
-
-## Examples
-
-<CodeGroup>
-
-```typescript Basic User Data Validation
-import { validateDataUsingSchema } from "@intuned/browser";
-export default async function handler(params, page, context){
-const userData = {
-  name: "John Doe",
-  email: "john@example.com",
-  age: 30
-};
-
-const userSchema = {
-  type: "object",
-  required: ["name", "email", "age"],
-  properties: {
-    name: { type: "string", minLength: 1 },
-    email: { type: "string", format: "email" },
-    age: { type: "number", minimum: 0 }
-  }
-};
-
-validateDataUsingSchema({ data: userData, schema: userSchema });
-// Validation passes, no error thrown
-}
-```
-
-```typescript Invalid Data Validation
-import { validateDataUsingSchema } from "@intuned/browser";
-export default async function handler(params, page, context){
-const userData = {
-  name: "John Doe",
-  email: "john@example.com",
-};
-
-const userSchema = {
-  type: "object",
-  required: ["name", "email", "age"],
-  properties: {
-    name: { type: "string", minLength: 1 },
-    email: { type: "string", format: "email" },
-    age: { type: "number", minimum: 0 }
-  }
-};
-
-validateDataUsingSchema({ data: userData, schema: userSchema });
-// Validation fails, throws ValidationError
-}
-```
-
-</CodeGroup>
-
-## Arguments
-
-<ParamField path="input" type="Object" required
->
-The input object containing data and schema
-
-<Expandable title="input">
-<ParamField path="input.data" type="Record<string, any> | Array<Record<string, any>>">
-The data to validate. Can be a single data object or an array of data objects
-</ParamField>
-
-<ParamField path="input.schema" type="Record<string, any>">
-JSON schema object defining validation rules
-</ParamField>
-
-</Expandable>
-
-</ParamField>
-
-## Returns: `void`
-
-Returns nothing if validation passes, throws ValidationError if it fails