surfsky 0.0.4 → 0.0.6

package/README.md

@@ -99,7 +99,7 @@ Cookies and browser state persist between leases. Handlers are not retried.
 
 - [SDK API reference](https://github.com/surfskyio/surfsky-js/blob/main/docs/api.md)
 - [REST API](https://docs.surfsky.io/api-reference)
-- [Examples](https://github.com/surfskyio/surfsky-js/tree/main/examples): forms, tabs, retries, profiles and CDP connections.
+- [Examples](https://github.com/surfskyio/surfsky-js/tree/main/examples): forms, tabs, retries, profiles, a closed shadow root and CDP connections.
 
 `client.session()` exposes a WebSocket URL for external browser clients.
 See the [Playwright](https://github.com/surfskyio/surfsky-js/blob/main/examples/playwright_connect.ts),

package/dist/index.d.ts

@@ -1097,8 +1097,6 @@ declare abstract class Actions {
   click(selector: string, options?: ClickOptions): Promise<any>;
   dblclick(selector: string, options?: DblclickOptions): Promise<any>;
   hover(selector: string, options?: HoverOptions): Promise<any>;
-  type(selector: string, text: string): Promise<any>;
-  fill(selector: string, text: string): Promise<any>;
   scroll(options?: ScrollOptions): Promise<any>;
   scrollIntoView(selector: string, options?: {
     behavior?: ScrollBehavior;
@@ -1368,8 +1366,16 @@ declare class Page extends Actions {
   waitForFunction(expression: string | ((...args: any[]) => unknown), options?: EvaluateOptions & WaitOptions): Promise<any>;
   innerText(selector: string): Promise<string | null>;
   allInnerTexts(selector: string): Promise<string[]>;
+  type(selector: string, text: string): Promise<any>;
+  fill(selector: string, text: string): Promise<any>;
   getAttribute(selector: string, name: string): Promise<string | null>;
   count(selector: string): Promise<number>;
+  boundingBox(selector: string): Promise<{
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  } | null>;
   selectOption(selector: string, option: string | {
     value?: string;
     label?: string;

package/dist/index.js

@@ -85,14 +85,6 @@ var Actions = class {
 			...options
 		}));
 	}
-	async type(selector, text) {
-		await this.click(selector);
-		return this.keyboard.type(text);
-	}
-	async fill(selector, text) {
-		await this.click(selector, { clickCount: 3 });
-		return this.keyboard.type(text);
-	}
 	scroll(options = {}) {
 		return this.send("Human.scroll", cdpParams({ ...options }));
 	}
@@ -868,18 +860,26 @@ const FUNCTION = /^\s*(async\s+)?(function\b|\([^()]*\)\s*=>|[\w$]+\s*=>)/;
 function asXPath(s) {
 	return /^\s*(xpath=|\/\/|\.\.)/.test(s) ? s.trim().replace(/^xpath=/, "") : void 0;
 }
-const SELECT = `(selector, value, label) => {
-  const el = document.querySelector(selector);
-  if (!el) return null;
-  const option = Array.from(el.options).find(
+const SELECT = `function (value, label) {
+  const option = Array.from(this.options).find(
     o => label === null ? o.value === value : o.label === label || o.text === label
   );
   if (!option) return false;
-  el.value = option.value;
-  el.dispatchEvent(new Event("input", {bubbles: true}));
-  el.dispatchEvent(new Event("change", {bubbles: true}));
+  this.value = option.value;
+  this.dispatchEvent(new Event("input", {bubbles: true}));
+  this.dispatchEvent(new Event("change", {bubbles: true}));
   return option.value;
 }`;
+const INNER_TEXT = "function () { return this.innerText }";
+const IS_FOCUSED = "function () { return this.getRootNode().activeElement === this }";
+const MATCHES = "function (s) { return this.nodeType === 1 && (s == null || this.matches(s)) }";
+const WORLD_GONE = ["Cannot find context", "does not belong to the document"];
+const worldIsGone = (err) => err instanceof CDPError && WORLD_GONE.some((text) => err.message.includes(text));
+function remoteResult(result, what) {
+	const details = result.exceptionDetails;
+	if (details) throw new CDPError(`${what} failed: ${(details.exception ?? {}).description ?? details.text}`);
+	return result.result;
+}
 function cookieParam(cookie) {
 	const out = dropNulls(cookie);
 	const expires = out.expirationDate;
@@ -1070,11 +1070,13 @@ var Page = class extends Actions {
 	}
 	/** @internal */
 	async _setup(waiting) {
+		const patterns = this._browser._fetchPatterns;
 		const commands = [
 			["Page.enable", void 0],
 			["Page.setLifecycleEventsEnabled", { enabled: true }],
-			["Fetch.enable", { patterns: this._browser._fetchPatterns }]
+			["Network.enable", void 0]
 		];
+		if (patterns.length > 0) commands.push(["Fetch.enable", { patterns }]);
 		if (waiting) commands.push(["Runtime.runIfWaitingForDebugger", void 0]);
 		const timeout = this._browser.commandTimeout;
 		let posted = [];
@@ -1175,15 +1177,13 @@ var Page = class extends Actions {
 	/** Record responses whose URL contains a fragment. Call before navigating. */
 	async captureResponses(...fragments) {
 		if (fragments.length === 0) throw new TypeError("captureResponses needs at least one URL fragment");
-		if (this._captures.length === 0) await this.send("Network.enable");
+		this._requireOpen();
 		this._captures.push(...fragments);
 	}
 	async stopCapturing() {
-		if (this._captures.length === 0) return;
 		this._captures = [];
 		this._responses = [];
 		this._inFlight.clear();
-		await this.send("Network.disable");
 	}
 	async waitForResponse(fragment, options = {}) {
 		if (this._captures.length === 0) throw new Error("call captureResponses() before the navigation");
@@ -1199,6 +1199,7 @@ var Page = class extends Actions {
 	/** @internal */
 	_onResponse(event) {
 		const response = isRecord(event.response) ? event.response : {};
+		if (event.type === "Document" && event.frameId === this._frameId) this._status = typeof response.status === "number" ? response.status : void 0;
 		const url = typeof response.url === "string" ? response.url : "";
 		if (this._captures.some((fragment) => url.includes(fragment))) this._inFlight.set(String(event.requestId), response);
 	}
@@ -1287,14 +1288,38 @@ var Page = class extends Actions {
 		try {
 			result = await this.send("Runtime.evaluate", params);
 		} catch (err) {
-			if (!isolated || !(err instanceof CDPError) || !err.message.includes("Cannot find context")) throw err;
+			if (!isolated || !worldIsGone(err)) throw err;
 			this._worldId = void 0;
 			params.contextId = await this.#world();
 			result = await this.send("Runtime.evaluate", params);
 		}
-		const details = result.exceptionDetails;
-		if (details) throw new CDPError(`evaluate failed: ${(details.exception ?? {}).description ?? details.text}`);
-		return result.result;
+		return remoteResult(result, "evaluate");
+	}
+	async #call(nodeId, fn, ...args) {
+		const params = {
+			functionDeclaration: fn,
+			arguments: args.map((value) => ({ value })),
+			returnByValue: true
+		};
+		let result;
+		try {
+			result = await this.#callInWorld(nodeId, params);
+		} catch (err) {
+			if (!worldIsGone(err)) throw err;
+			this._worldId = void 0;
+			result = await this.#callInWorld(nodeId, params);
+		}
+		return remoteResult(result, "call").value;
+	}
+	async #callInWorld(nodeId, params) {
+		const resolved = await this.send("DOM.resolveNode", {
+			nodeId,
+			executionContextId: await this.#world()
+		});
+		return await this.send("Runtime.callFunctionOn", {
+			...params,
+			objectId: resolved.object.objectId
+		});
 	}
 	async #world() {
 		if (this._worldId === void 0) {
@@ -1317,12 +1342,29 @@ var Page = class extends Actions {
 			await sleep(100);
 		}
 	}
-	innerText(selector) {
-		return this.evaluate("s => document.querySelector(s)?.innerText ?? null", { args: [selector] });
+	async innerText(selector) {
+		const nodeId = await this.#nodeId(selector);
+		if (nodeId === void 0) return null;
+		return await this.#call(nodeId, INNER_TEXT);
 	}
 	allInnerTexts(selector) {
 		return this.evaluate("s => Array.from(document.querySelectorAll(s), e => e.innerText)", { args: [selector] });
 	}
+	async type(selector, text) {
+		await this.click(selector);
+		await this.#validateFocus(selector);
+		return this.keyboard.type(text);
+	}
+	async fill(selector, text) {
+		await this.click(selector, { clickCount: 3 });
+		await this.#validateFocus(selector);
+		if (text === "") return this.keyboard.press("Backspace");
+		return this.keyboard.type(text);
+	}
+	async #validateFocus(selector) {
+		const nodeId = await this.#nodeId(selector);
+		if (nodeId === void 0 || !await this.#call(nodeId, IS_FOCUSED)) throw new Error(`'${selector}' did not take focus`);
+	}
 	async getAttribute(selector, name) {
 		const nodeId = await this.#nodeId(selector);
 		if (nodeId === void 0) return null;
@@ -1332,22 +1374,38 @@ var Page = class extends Actions {
 	}
 	async count(selector) {
 		const document = await this.send("DOM.getDocument", { depth: 0 });
-		const xpath = asXPath(selector);
-		if (xpath !== void 0) return (await this.#search(xpath)).length;
-		return ((await this.send("DOM.querySelectorAll", {
+		if (asXPath(selector) !== void 0) return (await this.#search(selector)).length;
+		const nodeIds = (await this.send("DOM.querySelectorAll", {
 			nodeId: document.root.nodeId,
 			selector
-		})).nodeIds ?? []).length;
+		})).nodeIds ?? [];
+		if (nodeIds.length > 0) return nodeIds.length;
+		return (await this.#search(selector)).length;
+	}
+	async boundingBox(selector) {
+		const nodeId = await this.#nodeId(selector);
+		if (nodeId === void 0) return null;
+		let box;
+		try {
+			box = await this.send("DOM.getBoxModel", { nodeId });
+		} catch (err) {
+			if (err instanceof CDPError) return null;
+			throw err;
+		}
+		const quad = box.model.content;
+		return {
+			x: quad[0],
+			y: quad[1],
+			width: quad[2] - quad[0],
+			height: quad[5] - quad[1]
+		};
 	}
 	async selectOption(selector, option) {
 		const { value, label } = typeof option === "string" ? { value: option } : option;
 		if (value === void 0 === (label === void 0)) throw new TypeError("selectOption takes either a value or a label");
-		const picked = await this.evaluate(SELECT, { args: [
-			selector,
-			value ?? null,
-			label ?? null
-		] });
-		if (picked === null) throw new Error(`nothing matches '${selector}'`);
+		const nodeId = await this.#nodeId(selector);
+		if (nodeId === void 0) throw new Error(`nothing matches '${selector}'`);
+		const picked = await this.#call(nodeId, SELECT, value ?? null, label ?? null);
 		if (picked === false) throw new Error(`'${selector}' has no option '${label ?? value}'`);
 		return picked;
 	}
@@ -1376,22 +1434,34 @@ var Page = class extends Actions {
 	}
 	async #nodeId(selector) {
 		const document = await this.send("DOM.getDocument", { depth: 0 });
-		const xpath = asXPath(selector);
-		if (xpath !== void 0) return (await this.#search(xpath))[0];
-		return (await this.send("DOM.querySelector", {
+		if (asXPath(selector) !== void 0) return (await this.#search(selector))[0];
+		const found = await this.send("DOM.querySelector", {
 			nodeId: document.root.nodeId,
 			selector
-		})).nodeId || void 0;
+		});
+		if (found.nodeId) return found.nodeId;
+		return (await this.#search(selector))[0];
 	}
-	async #search(query) {
-		const { searchId, resultCount = 0 } = await this.send("DOM.performSearch", { query });
+	async #search(selector) {
+		const xpath = asXPath(selector);
+		const { searchId, resultCount = 0 } = await this.send("DOM.performSearch", {
+			query: xpath ?? selector,
+			includeUserAgentShadowDOM: false
+		});
 		try {
 			if (!resultCount) return [];
-			return (await this.send("DOM.getSearchResults", {
+			const nodeIds = (await this.send("DOM.getSearchResults", {
 				searchId,
 				fromIndex: 0,
 				toIndex: resultCount
 			})).nodeIds ?? [];
+			const css = xpath === void 0 ? selector : null;
+			await this.#world();
+			const kept = await Promise.all(nodeIds.map((nodeId) => this.#call(nodeId, MATCHES, css).catch((err) => {
+				if (err instanceof CDPError) return false;
+				throw err;
+			})));
+			return nodeIds.filter((_, i) => kept[i]);
 		} finally {
 			await this.send("DOM.discardSearchResults", { searchId }).catch(() => void 0);
 		}
@@ -1514,12 +1584,7 @@ var Page = class extends Actions {
 			this._browser.logger.warn("Fetch.requestPaused without a requestId");
 			return;
 		}
-		const status = event.responseStatusCode;
-		if (status !== void 0 && status !== null) {
-			if (event.frameId === this._frameId) this._status = status;
-			this._spawn(this._send("Fetch.continueResponse", { requestId }));
-		} else if (event.responseErrorReason) this._spawn(this._send("Fetch.continueRequest", { requestId }));
-		else this._spawn(this._send("Fetch.failRequest", {
+		this._spawn(this._send("Fetch.failRequest", {
 			requestId,
 			errorReason: "BlockedByClient"
 		}));
@@ -1531,11 +1596,6 @@ var Page = class extends Actions {
 };
 //#endregion
 //#region src/browser/browser.ts
-const STATUS_PATTERN = {
-	urlPattern: "*",
-	resourceType: "Document",
-	requestStage: "Response"
-};
 const AUTO_ATTACH = {
 	autoAttach: true,
 	waitForDebuggerOnStart: true,
@@ -1653,7 +1713,7 @@ var Browser = class extends Page {
 			resourceType: RESOURCE_TYPES[name]
 		}));
 		for (const pattern of this.blockedUrls) patterns.push({ urlPattern: pattern });
-		return [...patterns, STATUS_PATTERN];
+		return patterns;
 	}
 	/** Replace this browser with a fresh one after the lease. */
 	retire() {
@@ -2618,7 +2678,7 @@ var Proxies = class {
 };
 //#endregion
 //#region src/version.ts
-const VERSION = "0.0.4";
+const VERSION = "0.0.6";
 //#endregion
 //#region src/client.ts
 function userAgent() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "surfsky",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "TypeScript SDK for the Surfsky antidetect browser cloud.",
   "keywords": [
     "surfsky",