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

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

@@ -231,7 +231,8 @@ const noChangeThresholdHtml = `
       const buttonLocator = page.locator("#load-more");
       await (0, _.clickUntilExhausted)({
         page,
-        buttonLocator
+        buttonLocator,
+        maxClicks: 10
       });
       const finalCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(finalCount).toBe(10);

package/dist/helpers/withNetworkSettledWait.js

@@ -11,7 +11,6 @@ const withNetworkSettledWait = async (callback, options) => {
     timeoutInMs = 30000,
     maxInflightRequests = 0
   } = options || {};
-  _Logger.logger.debug(`Page object: ${page}`);
   let networkSettledResolve = null;
   let networkSettledPromise = new Promise(resolve => {
     networkSettledResolve = resolve;
@@ -50,7 +49,6 @@ const withNetworkSettledWait = async (callback, options) => {
   const timeoutPromise = new Promise(resolve => {
     setTimeout(() => {
       var _networkSettledResolv2;
-      _Logger.logger.info("waiting for network to settle timed out");
       isTimeout = true;
       (_networkSettledResolv2 = networkSettledResolve) === null || _networkSettledResolv2 === void 0 || _networkSettledResolv2();
       resolve();
@@ -61,17 +59,15 @@ const withNetworkSettledWait = async (callback, options) => {
     actionDone = true;
     await new Promise(resolve => setTimeout(resolve, 500));
     await maybeSettle();
-    _Logger.logger.info("-- Start waiting for network to settle... --");
     let shouldContinue = true;
     while (shouldContinue) {
-      _Logger.logger.info(`waiting for network to settle, ${requestCounter} requests pending`);
       await Promise.race([networkSettledPromise, timeoutPromise]);
       await new Promise(resolve => setTimeout(resolve, 500));
       if (actionDone && requestCounter <= maxInflightRequests || isTimeout) {
         if (isTimeout) {
-          _Logger.logger.info("Exiting due to timeout, network did not settle");
+          _Logger.logger.debug("Network did not settle within timeout.");
         } else {
-          _Logger.logger.info("network settled, no pending requests");
+          _Logger.logger.debug("Network settled.");
         }
         shouldContinue = false;
       } else {
@@ -80,7 +76,6 @@ const withNetworkSettledWait = async (callback, options) => {
         });
       }
     }
-    _Logger.logger.info("-- Finished waiting for network to settle --");
     return result;
   } finally {
     page === null || page === void 0 || page.off("request", onRequest);

package/dist/optimized-extractors/export.d.ts

@@ -2,8 +2,8 @@ import { Locator, Page } from "playwright";
 import { BasicSchema } from "./types/jsonSchema";
 
 /**
- * this strategy will use a screenshot of the page/locator with some processing to extract the needed data.
- * should be used when the information you're trying to extract is not present in the dom as a text but can be identified visually.
+ * This strategy uses a screenshot of the page/locator with some processing to extract the needed data.
+ * Use when the information you're trying to extract isn't present in the DOM as text but can be identified visually.
  * @interface
  * @property model - the model to use in the extraction process.
  * @property  type - the type of the strategy
@@ -35,8 +35,8 @@ export interface ImageStrategy {
   type: "IMAGE";
 }
 /**
- * this strategy will use the html of the page/locator to extract the needed data. we filter out some of the attributes to reduce context.
- * the attributes included are only: `aria-label` `data-name` `name` `type` `placeholder` `value` `role` `title` `href` `id` `alt`,
+ * This strategy uses the HTML of the page/locator to extract the needed data. We filter out some attributes to reduce context.
+ * The attributes included are only: `aria-label` `data-name` `name` `type` `placeholder` `value` `role` `title` `href` `id` `alt`.
  *
  * @interface
  * @property model - the model to use in the extraction process
@@ -73,23 +73,22 @@ export interface HtmlStrategy {
   type: "HTML";
 }
 /**
- * Extracts an array of structured data from a web page in an optimized way, this function will use ai for the first n times, until it collects multiple examples
- * then it will build reliable selectors in the background to make the process more efficient
+ * Extracts an array of structured data from a web page in an optimized way. This function uses AI for the first few extractions until it collects multiple examples, then builds reliable selectors in the background for improved efficiency.
  * @deprecated This function is deprecated and will be removed in the future.
  * @param page - The Playwright Page object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.itemEntityName - The name of the entity items being extracted, it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.itemEntityName - The name of the entity items being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.itemEntitySchema - The schema of the entity items being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process, use this when the page has multiple variants/shapes.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to a list of extracted data.
  *
  * @example
  * ```typescript extractArrayFromPage
- *  import { extractArrayFromPage } from "@intuned/sdk/optimized-extractors";
+ *  import { extractArrayFromPage } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/")
  *  const books = await extractArrayFromPage(page,
@@ -149,18 +148,18 @@ export declare function extractArrayFromPage(
  * @deprecated This function is deprecated and will be removed in the future.
  * @param locator - The Playwright Locator object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.itemEntityName - The name of the entity items being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.itemEntityName - The name of the entity items being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.itemEntitySchema - The schema of the entity items being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to a list of extracted data.
  *
  * @example
  * ```typescript extractArrayFromLocator
- *  import { extractArrayFromLocator } from "@intuned/sdk/optimized-extractors";
+ *  import { extractArrayFromLocator } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/")
  *  const books = await extractArrayFromLocator(page.locator("section"),
@@ -266,17 +265,17 @@ export interface SimpleArrayItemSchema extends BasicSchema {
  * @deprecated This function is deprecated and will be removed in the future.
  * @param page - The Playwright Page object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.entityName - The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.entityName - The name of the entity being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.entitySchema - The schema of the entity being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to the extracted object.
  * @example
  * ```typescript extractObjectFromPage
- *  import { extractObjectFromPage } from "@intuned/sdk/optimized-extractors";
+ *  import { extractObjectFromPage } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html")
  *  const book = await extractObjectFromPage(page,
@@ -333,18 +332,18 @@ export declare function extractObjectFromPage(
  * @deprecated This function is deprecated and will be removed in the future.
  * @param locator - The Playwright Locator object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.entityName - The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.entityName - The name of the entity being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.entitySchema - The schema of the entity being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to the extracted object.
  *
  * @example
  * ```typescript extractObjectFromLocator
- *  import { extractObjectFromLocator } from "@intuned/sdk/optimized-extractors";
+ *  import { extractObjectFromLocator } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html")
  *  const book = await extractObjectFromLocator(page.locator(".page_inner"),

package/dist/optimized-extractors/index.d.ts

@@ -2,8 +2,8 @@ import { Locator, Page } from "playwright";
 import { BasicSchema } from "./types/jsonSchema";
 
 /**
- * this strategy will use a screenshot of the page/locator with some processing to extract the needed data.
- * should be used when the information you're trying to extract is not present in the dom as a text but can be identified visually.
+ * This strategy uses a screenshot of the page/locator with some processing to extract the needed data.
+ * Use when the information you're trying to extract isn't present in the DOM as text but can be identified visually.
  * @interface
  * @property model - the model to use in the extraction process.
  * @property  type - the type of the strategy
@@ -35,8 +35,8 @@ export interface ImageStrategy {
   type: "IMAGE";
 }
 /**
- * this strategy will use the html of the page/locator to extract the needed data. we filter out some of the attributes to reduce context.
- * the attributes included are only: `aria-label` `data-name` `name` `type` `placeholder` `value` `role` `title` `href` `id` `alt`,
+ * This strategy uses the HTML of the page/locator to extract the needed data. We filter out some attributes to reduce context.
+ * The attributes included are only: `aria-label` `data-name` `name` `type` `placeholder` `value` `role` `title` `href` `id` `alt`.
  *
  * @interface
  * @property model - the model to use in the extraction process
@@ -73,23 +73,22 @@ export interface HtmlStrategy {
   type: "HTML";
 }
 /**
- * Extracts an array of structured data from a web page in an optimized way, this function will use ai for the first n times, until it collects multiple examples
- * then it will build reliable selectors in the background to make the process more efficient
+ * Extracts an array of structured data from a web page in an optimized way. This function uses AI for the first few extractions until it collects multiple examples, then builds reliable selectors in the background for improved efficiency.
  * @deprecated This function is deprecated and will be removed in the future.
  * @param page - The Playwright Page object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.itemEntityName - The name of the entity items being extracted, it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.itemEntityName - The name of the entity items being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.itemEntitySchema - The schema of the entity items being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process, use this when the page has multiple variants/shapes.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to a list of extracted data.
  *
  * @example
  * ```typescript extractArrayFromPage
- *  import { extractArrayFromPage } from "@intuned/sdk/optimized-extractors";
+ *  import { extractArrayFromPage } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/")
  *  const books = await extractArrayFromPage(page,
@@ -149,18 +148,18 @@ export declare function extractArrayFromPage(
  * @deprecated This function is deprecated and will be removed in the future.
  * @param locator - The Playwright Locator object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.itemEntityName - The name of the entity items being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.itemEntityName - The name of the entity items being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.itemEntitySchema - The schema of the entity items being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to a list of extracted data.
  *
  * @example
  * ```typescript extractArrayFromLocator
- *  import { extractArrayFromLocator } from "@intuned/sdk/optimized-extractors";
+ *  import { extractArrayFromLocator } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/")
  *  const books = await extractArrayFromLocator(page.locator("section"),
@@ -266,17 +265,17 @@ export interface SimpleArrayItemSchema extends BasicSchema {
  * @deprecated This function is deprecated and will be removed in the future.
  * @param page - The Playwright Page object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.entityName - The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.entityName - The name of the entity being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.entitySchema - The schema of the entity being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to the extracted object.
  * @example
  * ```typescript extractObjectFromPage
- *  import { extractObjectFromPage } from "@intuned/sdk/optimized-extractors";
+ *  import { extractObjectFromPage } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html")
  *  const book = await extractObjectFromPage(page,
@@ -333,18 +332,18 @@ export declare function extractObjectFromPage(
  * @deprecated This function is deprecated and will be removed in the future.
  * @param locator - The Playwright Locator object from which to extract the data.
  * @param options.label - A label for this extraction process, used for billing and monitoring.
- * @param options.entityName - The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
+ * @param options.entityName - The name of the entity being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
  * @param options.entitySchema - The schema of the entity being extracted.
  * @param options.strategy - Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
  * @param options.prompt - Optional. A prompt to guide the extraction process.
  * @param options.optionalPropertiesInvalidator - Optional. A function to invalidate optional properties.
  * @param options.variantKey - Optional. A variant key for the extraction process.
- * @param options.apiKey - Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.
+ * @param options.apiKey - Optional. An API key for AI extraction. Extractions made with your API key won't be billed to your account.
  * @returns A promise that resolves to the extracted object.
  *
  * @example
  * ```typescript extractObjectFromLocator
- *  import { extractObjectFromLocator } from "@intuned/sdk/optimized-extractors";
+ *  import { extractObjectFromLocator } from "@intuned/browser/optimized-extractors";
  *
  *  await page.goto("https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html")
  *  const book = await extractObjectFromLocator(page.locator(".page_inner"),

package/how-to-generate-docs.md

@@ -1,50 +1,62 @@
 ## How to Generate Documentation
 
-### Generating Docs
+### Quick Start
 
 **Generate all docs (recommended):**
 
 ```bash
-yarn generate-all-docs
+yarn generate-docs
 ```
 
-This command processes all `export.d.ts` files from the 3 namespaces and generates their documentation.
+This command automatically processes all `export.d.ts` files from the 3 namespaces and outputs them to the correct paths in the docs folder to work with Mintlify.
 
-**Generate docs for a specific file:**
+### Output Structure
 
-```bash
-yarn generate-docs <input.d.ts> [outputdir]
-```
+Docs are automatically generated to:
 
-**Examples:**
+```
+docs/automation-sdks/intuned-sdk/typescript/
+├── helpers/
+│   ├── functions/
+│   ├── interfaces/
+│   └── type-aliases/
+├── ai/
+│   ├── functions/
+│   ├── interfaces/
+│   └── type-aliases/
+└── optimized-extractors/
+    ├── functions/
+    ├── interfaces/
+    └── type-aliases/
+```
 
-```bash
-# Generate docs for helpers (recommended)
-yarn generate-docs ./src/helpers/export.d.ts ./generated-docs/helpers
+### Available Namespaces
 
-# Generate docs for AI functions
-yarn generate-docs ./src/ai/export.d.ts ./generated-docs/ai
+The following namespaces are automatically processed:
 
-# Generate docs for optimized extractors
-yarn generate-docs ./src/optimized-extractors/export.d.ts ./generated-docs/optimized-extractors
+| Namespace            | Input File                             | Output Path                                 |
+| -------------------- | -------------------------------------- | ------------------------------------------- |
+| helpers              | `src/helpers/export.d.ts`              | `docs/.../typescript/helpers/`              |
+| ai                   | `src/ai/export.d.ts`                   | `docs/.../typescript/ai/`                   |
+| optimized-extractors | `src/optimized-extractors/export.d.ts` | `docs/.../typescript/optimized-extractors/` |
 
-# Use default output directory (./generated-docs)
-yarn generate-docs ./src/helpers/export.d.ts
-```
+### Legacy Usage (Single File)
 
-**Output Structure:**
+You can still process a single file with a custom output directory:
 
-- Functions will be written to `[outputdir]/functions/`
-- Interfaces will be written to `[outputdir]/interfaces/`
-- Type aliases will be written to `[outputdir]/type-aliases/`
+```bash
+yarn generate-docs <input.d.ts> [output-dir]
+```
 
-### Available Namespaces
+**Examples:**
 
-The following namespaces have `export.d.ts` files that can be processed:
+```bash
+# Generate docs for helpers to a custom directory
+yarn generate-docs ./src/helpers/export.d.ts ./custom-output/helpers
 
-- `./src/helpers/export.d.ts` - Helper functions for web automation
-- `./src/ai/export.d.ts` - AI-powered data extraction functions
-- `./src/optimized-extractors/export.d.ts` - Optimized data extraction functions
+# Generate docs for AI functions to a custom directory
+yarn generate-docs ./src/ai/export.d.ts ./custom-output/ai
+```
 
 ### How It Works
 
@@ -59,4 +71,4 @@ The script in `./scripts/generate-docs.ts` reads JSDocs from `export.d.ts` files
 - The markdown converters parse JSDocs into Mintlify-compatible format
 - Include `@example` blocks with TypeScript code snippets
 - Use `@param`, `@returns`, and `@interface` tags for proper documentation
-
+- Use `@overload` tag to specify tab titles for overloaded functions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/browser-dev",
-  "version": "0.1.7-dev.0",
+  "version": "0.1.9-dev.0",
   "description": "runner package for intuned functions",
   "types": "./dist/index.d.ts",
   "typesVersions": {
@@ -46,7 +46,6 @@
     "lint": "eslint .",
     "fix": "eslint . --fix",
     "generate-docs": "npx tsx ./scripts/generate-docs.ts",
-    "generate-all-docs": "npx tsx ./scripts/generate-docs.ts ./src/helpers/export.d.ts ./generated-docs/helpers && npx tsx ./scripts/generate-docs.ts ./src/ai/export.d.ts ./generated-docs/ai && npx tsx ./scripts/generate-docs.ts ./src/optimized-extractors/export.d.ts ./generated-docs/optimized-extractors",
     "build-browser-scripts": "rollup -c ./src/common/browserScripts/rollup.config.mjs",
     "copy-dts": "copyfiles -u 1 \"src/**/*.d.ts\" dist",
     "release": "npx tsx ./scripts/release.ts"
@@ -59,7 +58,6 @@
     "@anthropic-ai/sdk": "0.22.0",
     "@aws-sdk/client-s3": "3.821.0",
     "@aws-sdk/s3-request-presigner": "3.821.0",
-    "@intuned/runtime": "^1.3.12",
     "ai": "5.0.15",
     "ajv": "8.13.0",
     "ajv-formats": "2.1.1",
@@ -111,6 +109,7 @@
     "prettier": "^2.8.8",
     "rollup": "3.26.2",
     "ts-jest": "^29.4.0",
+    "ts-morph": "^27.0.2",
     "typescript": "5.4.4",
     "vite": "^5.4.12",
     "vite-plugin-babel-macros": "^1.0.6",