@intuned/browser-dev 2.2.3-test-build.1 → 2.2.3-test-build.2

package/BROWSER_SCRIPTS_SETUP.md

@@ -0,0 +1,78 @@
+# Browser Scripts Setup
+
+This document explains how the TypeScript SDK handles the shared `browser_scripts.js` file from the monorepo root.
+
+## Overview
+
+The `common/browser_scripts.js` file at the root of the monorepo needs to be included in both the TypeScript and Python SDK builds. Instead of copying the file at runtime, we generate a TypeScript module that exports the script content as a constant.
+
+## How It Works
+
+1. **Source File**: `/common/browser_scripts.js` - The shared browser scripts file
+2. **Generated File**: `/typescript-sdk/src/common/script.ts` - Auto-generated TypeScript module
+3. **Generator Script**: `/typescript-sdk/scripts/generate-browser-script.js` - Node.js script that reads the source and generates the TS module
+
+## Build Process
+
+The generation happens automatically:
+
+### During Installation
+
+When you run `yarn install`, the `postinstall` hook automatically generates `script.ts`:
+
+```bash
+yarn install  # automatically runs generate-browser-script
+```
+
+### During Build
+
+The build script also regenerates `script.ts` before compiling:
+
+```bash
+yarn build  # runs generate-browser-script → tsc → babel
+```
+
+### Manual Generation
+
+You can manually regenerate the file:
+
+```bash
+yarn generate-browser-script
+```
+
+## Usage in Code
+
+In `ensureBrowserScripts.ts`:
+
+```typescript
+import { BROWSER_SCRIPT } from "./script";
+
+async function ensureBrowserScripts(page: Page): Promise<void> {
+  // Check if already loaded
+  const pageHasScript = await page.evaluate(
+    '() => typeof window.__INTUNED__ !== "undefined"'
+  );
+
+  if (pageHasScript) {
+    return;
+  }
+
+  // Inject the script
+  await page.evaluate(BROWSER_SCRIPT);
+}
+```
+
+## Important Notes
+
+- **DO NOT** edit `script.ts` manually - it's auto-generated
+- **DO NOT** commit `script.ts` to git - it's in `.gitignore`
+- The file is regenerated on every build and install
+- If you update `common/browser_scripts.js`, run `yarn generate-browser-script` to update
+
+## Benefits
+
+1. ✅ **No runtime file reading** - Script is bundled as a string constant
+2. ✅ **Type-safe** - TypeScript can check imports
+3. ✅ **Better performance** - No filesystem access at runtime
+4. ✅ **Cleaner builds** - No need to copy .js files during build
+5. ✅ **Single source of truth** - Always uses the latest from `common/`

package/dist/common/ensureBrowserScripts.js

@@ -4,14 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.ensureBrowserScripts = ensureBrowserScripts;
-var _fs = require("fs");
-var _path = require("path");
+var _script = require("./script");
 async function ensureBrowserScripts(page) {
   const pageHasScript = await page.evaluate('() => typeof window.__INTUNED__ !== "undefined"');
   if (pageHasScript) {
     return;
   }
-  const scriptPath = (0, _path.join)(__dirname, "./assets/browser_scripts.js");
-  const scriptContent = (0, _fs.readFileSync)(scriptPath, "utf-8");
-  await page.evaluate(scriptContent);
+  await page.evaluate(_script.BROWSER_SCRIPT);
 }

package/dist/common/script.js

@@ -822,7 +822,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     const mdCharsMatcher = /([\\\\[\\]()])/g;
     function escapeMd(text) {
       // Escapes markdown-sensitive characters within other markdown constructs.
-      return text.replace(mdCharsMatcher, "\\\\\$1");
+      return text.replace(mdCharsMatcher, "\\\\$1");
     }
     function listNumberingStart(attrs) {
       const start = attrs.getNamedItem("start")?.value;
@@ -836,8 +836,8 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     const slashChars = "\\\\\`*_{}[]()#+-.!";
     // Escape any special regex characters in slashChars
     const escapedSlashChars = slashChars.replace(
-      /[-/\\\\^\$*+?.()|[\\]{}]/g,
-      "\\\\\$&"
+      /[-/\\\\^$*+?.()|[\\]{}]/g,
+      "\\\\$&"
     );
     // Create the regular expression
     const mdBackslashMatcher = new RegExp(
@@ -849,9 +849,9 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     const mdDashMatcher = new RegExp(\`^(\\\\s*)(-)(?=\\\\s|-)\`, "gm");
     function escapeMdSection(text) {
       text = text.replace(mdBackslashMatcher, "\\\\\\\\");
-      text = text.replace(mdDotMatcher, "\$1\\\\\$2");
-      text = text.replace(mdPlusMatcher, "\$1\\\\\$2");
-      text = text.replace(mdDashMatcher, "\$1\\\\\$2");
+      text = text.replace(mdDotMatcher, "$1\\\\$2");
+      text = text.replace(mdPlusMatcher, "$1\\\\$2");
+      text = text.replace(mdDashMatcher, "$1\\\\$2");
       return text;
     }
     function isFirstTbody(element) {
@@ -860,7 +860,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
         element.nodeName === "TBODY" &&
         (!previousSibling ||
           (previousSibling.nodeName === "THEAD" &&
-            /^\\s*\$/i.test(previousSibling.textContent ?? "")))
+            /^\\s*$/i.test(previousSibling.textContent ?? "")))
       );
     }
     function isHeadingRow(tr) {
@@ -1324,7 +1324,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
 
   var node = {};
 
-  var htmlToMarkdownAST\$1 = {};
+  var htmlToMarkdownAST$1 = {};
 
   var ElementNode = {};
 
@@ -1365,9 +1365,9 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 0x20,
   };
 
-  Object.defineProperty(htmlToMarkdownAST\$1, "__esModule", { value: true });
-  htmlToMarkdownAST\$1.htmlToMarkdownAST = htmlToMarkdownAST;
-  const ElementNode_1\$1 = ElementNode;
+  Object.defineProperty(htmlToMarkdownAST$1, "__esModule", { value: true });
+  htmlToMarkdownAST$1.htmlToMarkdownAST = htmlToMarkdownAST;
+  const ElementNode_1$1 = ElementNode;
   function htmlToMarkdownAST(element, options, indentLevel = 0) {
     let result = [];
     const debugLog = (message) => {
@@ -1384,7 +1384,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
       if (overriddenElementProcessing) {
         debugLog(\`Element Processing Overridden: '\${childElement.nodeType}'\`);
         result.push(...overriddenElementProcessing);
-      } else if (childElement.nodeType === ElementNode_1\$1._Node.TEXT_NODE) {
+      } else if (childElement.nodeType === ElementNode_1$1._Node.TEXT_NODE) {
         const textContent = escapeMarkdownCharacters(
           childElement.textContent?.trim() ?? ""
         );
@@ -1396,9 +1396,9 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
             content: childElement.textContent?.trim(),
           });
         }
-      } else if (childElement.nodeType === ElementNode_1\$1._Node.ELEMENT_NODE) {
+      } else if (childElement.nodeType === ElementNode_1$1._Node.ELEMENT_NODE) {
         const elem = childElement;
-        if (/^h[1-6]\$/i.test(elem.tagName)) {
+        if (/^h[1-6]$/i.test(elem.tagName)) {
           const level = parseInt(elem.tagName.substring(1));
           const content = escapeMarkdownCharacters(
             elem.textContent || ""
@@ -1443,7 +1443,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
             // if all children are text,
             if (
               Array.from(elem.childNodes).every(
-                (_) => _.nodeType === ElementNode_1\$1._Node.TEXT_NODE
+                (_) => _.nodeType === ElementNode_1$1._Node.TEXT_NODE
               )
             ) {
               result.push({
@@ -1537,7 +1537,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
                 const cellNode = {
                   type: "tableCell",
                   content:
-                    cell.nodeType === ElementNode_1\$1._Node.TEXT_NODE
+                    cell.nodeType === ElementNode_1$1._Node.TEXT_NODE
                       ? escapeMarkdownCharacters(cell.textContent?.trim() ?? "")
                       : htmlToMarkdownAST(cell, options, indentLevel + 1),
                   colId: colIds[columnIndex],
@@ -1751,7 +1751,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
       .replace(/</g, "&lt;")
       .replace(/>/g, "&gt;");
     // Then escape characters that have special meaning in Markdown
-    escapedText = escapedText.replace(/([\\\\\`*_{}[\\]#+!|])/g, "\\\\\$1");
+    escapedText = escapedText.replace(/([\\\\\`*_{}[\\]#+!|])/g, "\\\\$1");
     return escapedText;
   }
 
@@ -1763,9 +1763,9 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     if (hasRequiredMarkdownASTToString) return markdownASTToString;
     hasRequiredMarkdownASTToString = 1;
     Object.defineProperty(markdownASTToString, "__esModule", { value: true });
-    markdownASTToString.markdownASTToString = markdownASTToString\$1;
+    markdownASTToString.markdownASTToString = markdownASTToString$1;
     const index_1 = requireNode();
-    function markdownASTToString\$1(nodes, options, indentLevel = 0) {
+    function markdownASTToString$1(nodes, options, indentLevel = 0) {
       let markdownString = "";
       markdownString += markdownMetaASTToString(nodes, options, indentLevel);
       markdownString += markdownContentASTToString(nodes, options, indentLevel);
@@ -2477,7 +2477,7 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
       exports.convertElementToMarkdown = convertElementToMarkdown;
       exports.findInMarkdownAST = findInMarkdownAST;
       exports.findAllInMarkdownAST = findAllInMarkdownAST;
-      const htmlToMarkdownAST_1 = htmlToMarkdownAST\$1;
+      const htmlToMarkdownAST_1 = htmlToMarkdownAST$1;
       Object.defineProperty(exports, "htmlToMarkdownAST", {
         enumerable: true,
         get: function () {

package/dist/helpers/clickUntilExhausted.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.clickButtonUntilNoChange = exports.clickButtonAndWait = void 0;
+exports.clickUntilExhausted = exports.clickButtonAndWait = void 0;
 var _withNetworkSettledWait = require("./withNetworkSettledWait");
 var _Logger = require("../common/Logger");
 const getContainerState = async container => {
@@ -35,7 +35,7 @@ const clickButtonAndWait = async input => {
   });
 };
 exports.clickButtonAndWait = clickButtonAndWait;
-const clickButtonUntilNoChange = async input => {
+const clickUntilExhausted = async input => {
   const {
     page,
     buttonLocator,
@@ -82,4 +82,4 @@ const clickButtonUntilNoChange = async input => {
     timeoutInMs: 30000
   });
 };
-exports.clickButtonUntilNoChange = clickButtonUntilNoChange;
+exports.clickUntilExhausted = clickUntilExhausted;

package/dist/helpers/export.d.ts

@@ -367,13 +367,13 @@ export declare function clickButtonAndWait(input: {
  *
  * @example
  * ```typescript Load All Items
- * import { clickButtonUntilNoChange } from "@intuned/browser";
+ * import { clickUntilExhausted } from "@intuned/browser";
  * export default async function handler(params, page, context){
  * await page.goto("https://example.com/products");
  * const loadMoreButton = page.locator("button:has-text('Load More')");
  *
  * // Click until button disappears or is disabled
- * await clickButtonUntilNoChange({
+ * await clickUntilExhausted({
  *   page,
  *   buttonLocator: loadMoreButton,
  *   maxClicks: 20
@@ -383,14 +383,14 @@ export declare function clickButtonAndWait(input: {
  *
  * @example
  * ```typescript Track Container Changes
- * import { clickButtonUntilNoChange } from "@intuned/browser";
+ * import { clickUntilExhausted } from "@intuned/browser";
  * export default async function handler(params, page, context){
  * await page.goto("https://example.com/products");
  * const loadMoreButton = page.locator("#load-more");
  * const productsContainer = page.locator("#products-list");
  *
  * let clickCount = 0;
- * await clickButtonUntilNoChange({
+ * await clickUntilExhausted({
  *   page,
  *   buttonLocator: loadMoreButton,
  *   containerLocator: productsContainer,
@@ -405,7 +405,7 @@ export declare function clickButtonAndWait(input: {
  * }
  * ```
  */
-export declare function clickButtonUntilNoChange(input: {
+export declare function clickUntilExhausted(input: {
   page: Page;
   buttonLocator: Locator;
   heartbeat?: CallableFunction;

package/dist/helpers/index.d.ts

@@ -367,13 +367,13 @@ export declare function clickButtonAndWait(input: {
  *
  * @example
  * ```typescript Load All Items
- * import { clickButtonUntilNoChange } from "@intuned/browser";
+ * import { clickUntilExhausted } from "@intuned/browser";
  * export default async function handler(params, page, context){
  * await page.goto("https://example.com/products");
  * const loadMoreButton = page.locator("button:has-text('Load More')");
  *
  * // Click until button disappears or is disabled
- * await clickButtonUntilNoChange({
+ * await clickUntilExhausted({
  *   page,
  *   buttonLocator: loadMoreButton,
  *   maxClicks: 20
@@ -383,14 +383,14 @@ export declare function clickButtonAndWait(input: {
  *
  * @example
  * ```typescript Track Container Changes
- * import { clickButtonUntilNoChange } from "@intuned/browser";
+ * import { clickUntilExhausted } from "@intuned/browser";
  * export default async function handler(params, page, context){
  * await page.goto("https://example.com/products");
  * const loadMoreButton = page.locator("#load-more");
  * const productsContainer = page.locator("#products-list");
  *
  * let clickCount = 0;
- * await clickButtonUntilNoChange({
+ * await clickUntilExhausted({
  *   page,
  *   buttonLocator: loadMoreButton,
  *   containerLocator: productsContainer,
@@ -405,7 +405,7 @@ export declare function clickButtonAndWait(input: {
  * }
  * ```
  */
-export declare function clickButtonUntilNoChange(input: {
+export declare function clickUntilExhausted(input: {
   page: Page;
   buttonLocator: Locator;
   heartbeat?: CallableFunction;

package/dist/helpers/index.js

@@ -21,16 +21,10 @@ Object.defineProperty(exports, "CustomTypeValidator", {
     return _types.CustomTypeValidator;
   }
 });
-Object.defineProperty(exports, "clickButtonAndWait", {
+Object.defineProperty(exports, "clickUntilExhausted", {
   enumerable: true,
   get: function () {
-    return _clickUntilExhausted.clickButtonAndWait;
-  }
-});
-Object.defineProperty(exports, "clickButtonUntilNoChange", {
-  enumerable: true,
-  get: function () {
-    return _clickUntilExhausted.clickButtonUntilNoChange;
+    return _clickUntilExhausted.clickUntilExhausted;
   }
 });
 Object.defineProperty(exports, "downloadFile", {

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

@@ -223,28 +223,13 @@ const noChangeThresholdHtml = `
   (0, _extendedTest.afterEach)(async () => {
     await page.close();
   });
-  (0, _extendedTest.describe)("clickButtonAndWait", () => {
-    (0, _extendedTest.test)("should click button and wait for content", async () => {
-      await page.setContent(basicClickHtml);
-      const initialCount = await page.locator(".item").count();
-      (0, _extendedTest.expect)(initialCount).toBe(3);
-      const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonAndWait)({
-        page,
-        buttonLocator,
-        clickDelay: 0.1
-      });
-      const finalCount = await page.locator(".item").count();
-      (0, _extendedTest.expect)(finalCount).toBe(4);
-    });
-  });
-  (0, _extendedTest.describe)("clickButtonUntilNoChange", () => {
+  (0, _extendedTest.describe)("clickUntilExhausted", () => {
     (0, _extendedTest.test)("should click button until max items loaded with default parameters", async () => {
       await page.setContent(basicClickHtml);
       const initialCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(initialCount).toBe(3);
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator
       });
@@ -256,7 +241,7 @@ const noChangeThresholdHtml = `
       const initialCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(initialCount).toBe(3);
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         maxClicks: 3,
@@ -272,7 +257,7 @@ const noChangeThresholdHtml = `
         heartbeatCalls.push(1);
       };
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         heartbeat: onHeartbeat,
@@ -286,7 +271,7 @@ const noChangeThresholdHtml = `
       const initialCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(initialCount).toBe(1);
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         maxClicks: 20,
@@ -302,7 +287,7 @@ const noChangeThresholdHtml = `
       const initialCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(initialCount).toBe(1);
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         maxClicks: 20,
@@ -319,7 +304,7 @@ const noChangeThresholdHtml = `
       (0, _extendedTest.expect)(initialCount).toBe(2);
       const buttonLocator = page.locator("#load-more");
       const containerLocator = page.locator("#container");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         containerLocator,
@@ -335,7 +320,7 @@ const noChangeThresholdHtml = `
       (0, _extendedTest.expect)(initialCount).toBe(1);
       const buttonLocator = page.locator("#load-more");
       const containerLocator = page.locator("#content");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         containerLocator,
@@ -351,7 +336,7 @@ const noChangeThresholdHtml = `
       const initialCount = await page.locator(".item").count();
       (0, _extendedTest.expect)(initialCount).toBe(3);
       const buttonLocator = page.locator("#load-more");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         maxClicks: 3,
@@ -370,7 +355,7 @@ const noChangeThresholdHtml = `
       (0, _extendedTest.expect)(initialCount).toBe(2);
       const buttonLocator = page.locator("#load-more");
       const containerLocator = page.locator("#container");
-      await (0, _.clickButtonUntilNoChange)({
+      await (0, _.clickUntilExhausted)({
         page,
         buttonLocator,
         heartbeat: onHeartbeat,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/browser-dev",
-  "version": "2.2.3-test-build.1",
+  "version": "2.2.3-test-build.2",
   "description": "runner package for intuned functions",
   "types": "./dist/index.d.ts",
   "typesVersions": {
@@ -35,7 +35,9 @@
   "author": "Intuned Team",
   "license": "Elastic-2.0",
   "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.json  && yarn copy-dts && babel src --out-dir dist --extensions '.ts' && node scripts/ensure-index-types.js && cp -r ./src/common/assets dist/common/assets",
+    "generate-browser-script": "node scripts/generate-browser-script.js",
+    "postinstall": "yarn generate-browser-script",
+    "build": "rm -rf dist && yarn generate-browser-script && tsc -p tsconfig.json && yarn copy-dts && babel src --out-dir dist --extensions '.ts' && node scripts/ensure-index-types.js",
     "ensure-types": "node scripts/ensure-index-types.js",
     "test": "vitest run",
     "test:dev": "vitest",