@stubber/virtual-worker 1.1.0 → 1.2.0

package/app/commands/browser/browser_click.js

@@ -1,9 +1,8 @@
 import { create_error_conceptual } from "#app/functions/create_error_conceptual.js";
-import { create_error_technical } from "#app/functions/create_error_technical.js";
 import { create_success } from "#app/functions/create_success.js";
-import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 import fs from "fs";
 import { v4 } from "uuid";
+import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 
 /**
  *
@@ -16,7 +15,7 @@ export const browser_click = async (params, stubber_context) => {
   const { entries } = params || {};
 
   // use playwright to move the mouse and perform a left click
-  const page_result = await get_chromium_page(stubber_context.stubref);
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
 
   if (!page_result.success) {
     return page_result;

package/app/commands/browser/browser_extract_data.js

@@ -9,7 +9,7 @@ export const browser_extract_data = async (params, stubber_context) => {
   }
 
   // Get the Chromium page
-  const page_result = await get_chromium_page(stubber_context.stubref);
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_extract_html.js

@@ -10,7 +10,7 @@ import { get_chromium_page } from "../../helpers/get_chromium_page.js";
  */
 export const browser_extract_html = async (params, stubber_context) => {
   // Get the Chromium page
-  const page_result = await get_chromium_page(stubber_context.stubref);
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_get_clipboard_text.js

@@ -0,0 +1,39 @@
+import { create_error_conceptual } from "#app/functions/create_error_conceptual.js";
+import { create_error_technical } from "#app/functions/create_error_technical.js";
+import { create_success } from "#app/functions/create_success.js";
+import { get_chromium_page } from "../../helpers/get_chromium_page.js";
+
+/**
+ * Reads text from the system clipboard for the page's origin.
+ * Playwright sometimes requires permissions to use the Clipboard API; this tries to
+ * request clipboard-read permission for the page's origin before reading.
+ *
+ * @param {Object} params
+ * @param {string} [params.session_id] - optional session id for get_chromium_page
+ * @returns
+ */
+export const browser_get_clipboard_text = async (params, stubber_context) => {
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
+
+  if (!page_result.success) {
+    return page_result;
+  }
+
+  const page = page_result.payload;
+
+  const page_url = page.url();
+
+  if (!page_url || page_url === "about:blank") {
+    return create_error_conceptual({ message: "No page loaded", details: { url: page_url } });
+  }
+
+  // This will attempt to read the clipboard using the browser API.
+  // Some environments require user gesture or extra permissions; handle failures.
+  const text = await page.evaluate(async () => {
+    /* global navigator */
+    // navigator.clipboard.readText might throw if permission is denied
+    return await navigator.clipboard.readText();
+  });
+
+  return create_success({ message: "Clipboard text retrieved successfully", payload: { text } });
+};

package/app/commands/browser/browser_get_localstorage.js

@@ -1,10 +1,9 @@
 import { create_error_conceptual } from "#app/functions/create_error_conceptual.js";
-import { create_error_technical } from "#app/functions/create_error_technical.js";
 import { create_success } from "#app/functions/create_success.js";
 import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 
-export const browser_get_localstorage = async (param, stubber_context) => {
-  const page_result = await get_chromium_page(stubber_context.stubref);
+export const browser_get_localstorage = async (params, stubber_context) => {
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
 
   if (!page_result.success) {
     return page_result;

package/app/commands/browser/browser_navigate.js

@@ -3,16 +3,16 @@ import { create_success } from "#app/functions/create_success.js";
 import { get_chromium_page } from "../../helpers/get_chromium_page.js";
 
 export const browser_navigate = async (params, stubber_context) => {
-  const result = await get_chromium_page(stubber_context.stubref);
+  const result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!result.success) {
     return result;
   }
 
-  const { url } = params || {};
+  const { url, options } = params || {};
 
   const page = result.payload;
 
-  if (url) await page.goto(url);
+  if (url) await page.goto(url, options);
 
   return create_success({ message: "Navigated to new page", payload: {} });
 };

package/app/commands/browser/browser_press_key.js

@@ -9,8 +9,9 @@ import { get_chromium_page } from "#app/helpers/get_chromium_page.js";
  * @param {Array<{locator?: string, frame?:string, key?: string, keys?: string}>} params.entries - Array of locator and key pairs.
  * @returns
  */
-export const browser_press_key = async ({ entries }, stubber_context) => {
-  const page_result = await get_chromium_page(stubber_context.stubref);
+export const browser_press_key = async (params, stubber_context) => {
+  const { entries } = params || {};
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_screenshot.js

@@ -11,8 +11,10 @@ import { create_error_technical } from "#app/functions/create_error_technical.js
  * @param {string} [params.locator] - Optional locator to screenshot a specific element
  * @returns
  */
-export const browser_screenshot = async ({ screenshot_options, locator }, stubber_context) => {
-  const page_result = await get_chromium_page(stubber_context.stubref);
+export const browser_screenshot = async (params, stubber_context) => {
+  let { screenshot_options, locator } = params || {};
+
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/browser/browser_write_text.js

@@ -9,8 +9,9 @@ import { get_chromium_page } from "../../helpers/get_chromium_page.js";
  * @param {Array<{locator: string, frame?:string, text: string}>} params.entries - Array of locator and text pairs.
  * @returns
  */
-export const browser_write_text = async ({ entries }, stubber_context) => {
-  const page_result = await get_chromium_page(stubber_context.stubref);
+export const browser_write_text = async (params, stubber_context) => {
+  const { entries } = params || {};
+  const page_result = await get_chromium_page(params?.session_id || stubber_context.stubref);
   if (!page_result.success) {
     return page_result;
   }

package/app/commands/index.js

@@ -6,6 +6,7 @@ import { browser_write_text } from "./browser/browser_write_text.js";
 import { browser_press_key } from "./browser/browser_press_key.js";
 import { browser_extract_html } from "./browser/browser_extract_html.js";
 import { browser_screenshot } from "./browser/browser_screenshot.js";
+import { browser_get_clipboard_text } from "./browser/browser_get_clipboard_text.js";
 import { cli_run } from "./cli/cli_run.js";
 
 import { upload_files } from "./file-server/upload_files.js";
@@ -20,6 +21,7 @@ const all_commands = {
   browser_press_key,
   browser_extract_html,
   browser_screenshot,
+  browser_get_clipboard_text,
 
   cli_run,
 

package/app/helpers/get_chromium_page.js

@@ -13,12 +13,12 @@ let browser;
 const contexts = {};
 
 /**
- * @param {string} stubref
+ * @param {string} session_id
  * @returns {Promise<{ success: boolean, payload?: import("playwright").Page }>}
  */
-export const get_chromium_page = async (stubref) => {
-  if (!stubref) {
-    return create_error_conceptual({ message: "stubref is required to get a Chromium page." });
+export const get_chromium_page = async (session_id) => {
+  if (!session_id) {
+    return create_error_conceptual({ message: "session_id is required to get a Chromium page." });
   }
 
   // Launch the browser once and reuse it
@@ -26,22 +26,23 @@ export const get_chromium_page = async (stubref) => {
     browser = await chromium.launch({
       headless: false,
       // eslint-disable-next-line id-match
-      slowMo: 1500,
+      slowMo: 500,
     });
   }
 
   // Create a new context per stubref if not already created
-  if (!contexts[stubref]) {
+  if (!contexts[session_id]) {
     const context = await browser.newContext({
       // eslint-disable-next-line id-match
       ignoreHTTPSErrors: true,
+      permissions: ["clipboard-read", "clipboard-write"],
     });
-    contexts[stubref] = {
+    contexts[session_id] = {
       context,
     };
   }
 
-  const context = contexts[stubref].context;
+  const context = contexts[session_id].context;
 
   // Try to find an open page in the context
   let page = context.pages().find((p) => !p.isClosed());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stubber/virtual-worker",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Template to easily create a node app and keep development standards",
   "main": "app.js",
   "directories": {