@flrande/browserctl 0.5.0 → 0.6.0

package/packages/driver-chrome-relay/src/chrome-relay-extension-runtime.ts

@@ -1,521 +0,0 @@
-import type {
-  ChromeRelayBrowser,
-  ChromeRelayBrowserContext,
-  ChromeRelayDriverRuntime,
-  ChromeRelayLocator,
-  ChromeRelayPage
-} from "./chrome-relay-driver";
-
-export type ChromeRelayExtensionTransport = {
-  invoke(method: string, params?: Record<string, unknown>): Promise<unknown>;
-  isConnected?(): boolean;
-  onEvent?(listener: (event: ChromeRelayExtensionTransportEvent) => void): () => void;
-};
-
-export type ChromeRelayExtensionRuntimeConfig = {
-  transport: ChromeRelayExtensionTransport;
-};
-
-export type ChromeRelayExtensionTransportConsoleEvent = {
-  kind: "console";
-  tabId: number;
-  entry: {
-    type: string;
-    text: string;
-    location?: {
-      url?: string;
-      lineNumber?: number;
-      columnNumber?: number;
-    };
-  };
-};
-
-export type ChromeRelayExtensionTransportNetworkEvent = {
-  kind: "response";
-  tabId: number;
-  response: {
-    requestId: string;
-    url: string;
-    status?: number;
-    method?: string;
-    resourceType?: string;
-    body?: string;
-    encoding?: "utf8" | "base64";
-  };
-};
-
-export type ChromeRelayExtensionTransportEvent =
-  | ChromeRelayExtensionTransportConsoleEvent
-  | ChromeRelayExtensionTransportNetworkEvent;
-
-type ExtensionPageState = {
-  tabId?: number;
-  currentUrl: string;
-  closed: boolean;
-};
-
-type ExtensionPageEventListener = (payload: unknown) => unknown;
-
-type ExtensionPageRecord = {
-  page: ChromeRelayPage;
-  state: ExtensionPageState;
-  close(): Promise<void>;
-  emitConsole(entry: ChromeRelayExtensionTransportConsoleEvent["entry"]): Promise<void>;
-  emitResponse(response: ChromeRelayExtensionTransportNetworkEvent["response"]): Promise<void>;
-};
-
-function isObjectRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function readObjectStringProperty(value: unknown, key: string): string | undefined {
-  if (!isObjectRecord(value)) {
-    return undefined;
-  }
-
-  const propertyValue = value[key];
-  return typeof propertyValue === "string" ? propertyValue : undefined;
-}
-
-function readObjectNumberProperty(value: unknown, key: string): number | undefined {
-  if (!isObjectRecord(value)) {
-    return undefined;
-  }
-
-  const propertyValue = value[key];
-  return typeof propertyValue === "number" ? propertyValue : undefined;
-}
-
-function toOptionalPositiveNumber(value: number | undefined): number | undefined {
-  return typeof value === "number" && Number.isFinite(value) && value > 0 ? value : undefined;
-}
-
-type ExtensionPageScreenshot = {
-  mimeType: string;
-  encoding: "base64";
-  imageBase64: string;
-  width?: number;
-  height?: number;
-};
-
-function readScreenshotResult(value: unknown): ExtensionPageScreenshot {
-  if (!isObjectRecord(value)) {
-    throw new Error("Extension relay response is missing screenshot payload.");
-  }
-
-  const imageBase64 = readObjectStringProperty(value, "imageBase64");
-  if (imageBase64 === undefined || imageBase64.trim().length === 0) {
-    throw new Error("Extension relay response is missing screenshot imageBase64.");
-  }
-
-  const rawEncoding = readObjectStringProperty(value, "encoding");
-  if (rawEncoding !== undefined && rawEncoding !== "base64") {
-    throw new Error(`Unsupported extension screenshot encoding: ${rawEncoding}`);
-  }
-
-  const mimeType = readObjectStringProperty(value, "mimeType") ?? "image/png";
-  const width = toOptionalPositiveNumber(readObjectNumberProperty(value, "width"));
-  const height = toOptionalPositiveNumber(readObjectNumberProperty(value, "height"));
-
-  return {
-    mimeType,
-    encoding: "base64",
-    imageBase64: imageBase64.trim(),
-    ...(width !== undefined ? { width } : {}),
-    ...(height !== undefined ? { height } : {})
-  };
-}
-
-function requireConnected(transport: ChromeRelayExtensionTransport): void {
-  if (transport.isConnected?.() === false) {
-    throw new Error("Chrome relay extension is not connected.");
-  }
-}
-
-function requireTabId(result: unknown, method: string): number {
-  const tabId = readObjectNumberProperty(result, "tabId");
-  if (typeof tabId !== "number" || !Number.isFinite(tabId)) {
-    throw new Error(`Extension relay response is missing numeric tabId for ${method}.`);
-  }
-
-  return tabId;
-}
-
-function createLocator(
-  transport: ChromeRelayExtensionTransport,
-  state: ExtensionPageState,
-  selector: string
-): ChromeRelayLocator {
-  const invokeAction = async (type: string, payload: Record<string, unknown>) => {
-    if (state.tabId === undefined) {
-      throw new Error("No extension-backed tab is currently attached to this page.");
-    }
-
-    await transport.invoke("tab.act", {
-      tabId: state.tabId,
-      action: {
-        type,
-        payload
-      }
-    });
-  };
-
-  return {
-    click: async () => {
-      await invokeAction("click", { selector });
-    },
-    fill: async (value) => {
-      await invokeAction("fill", { selector, value });
-    },
-    type: async (value) => {
-      await invokeAction("type", { selector, text: value });
-    },
-    setInputFiles: async (files: string[]) => {
-      await invokeAction("setFiles", { selector, files: [...files] });
-    }
-  };
-}
-
-function toConsoleEventPayload(entry: ChromeRelayExtensionTransportConsoleEvent["entry"]): {
-  type(): string;
-  text(): string;
-  location(): { url?: string; lineNumber?: number; columnNumber?: number };
-} {
-  return {
-    type: () => entry.type,
-    text: () => entry.text,
-    location: () => ({ ...(entry.location ?? {}) })
-  };
-}
-
-function toResponseEventPayload(response: ChromeRelayExtensionTransportNetworkEvent["response"]): {
-  url(): string;
-  status(): number;
-  request(): {
-    method(): string;
-    resourceType(): string | undefined;
-  };
-  text(): Promise<string>;
-  body(): Promise<string | Uint8Array>;
-} {
-  return {
-    url: () => response.url,
-    status: () => response.status ?? 0,
-    request: () => ({
-      method: () => response.method ?? "GET",
-      resourceType: () => response.resourceType
-    }),
-    text: async () => {
-      if (response.body === undefined) {
-        return "";
-      }
-
-      if (response.encoding === "base64") {
-        return Buffer.from(response.body, "base64").toString("utf8");
-      }
-
-      return response.body;
-    },
-    body: async () => {
-      if (response.body === undefined) {
-        return "";
-      }
-
-      if (response.encoding === "base64") {
-        return Buffer.from(response.body, "base64");
-      }
-
-      return response.body;
-    }
-  };
-}
-
-async function emitPageEvent(
-  listeners: Map<string, ExtensionPageEventListener[]>,
-  eventName: string,
-  payload: unknown
-): Promise<void> {
-  const eventListeners = listeners.get(eventName);
-  if (eventListeners === undefined || eventListeners.length === 0) {
-    return;
-  }
-
-  for (const listener of [...eventListeners]) {
-    await listener(payload);
-  }
-}
-
-function createPageRecord(
-  transport: ChromeRelayExtensionTransport,
-  releasePage: () => void
-): ExtensionPageRecord {
-  const state: ExtensionPageState = {
-    currentUrl: "about:blank",
-    closed: false
-  };
-  const listeners = new Map<string, ExtensionPageEventListener[]>();
-
-  const ensureOpen = () => {
-    if (state.closed) {
-      throw new Error("Cannot operate on closed extension-backed page.");
-    }
-  };
-
-  const ensureTabId = () => {
-    if (state.tabId === undefined) {
-      throw new Error("No extension-backed tab is currently attached to this page.");
-    }
-
-    return state.tabId;
-  };
-
-  const page: ChromeRelayPage = {
-    goto: async (url) => {
-      ensureOpen();
-      if (state.tabId === undefined) {
-        const result = await transport.invoke("tab.open", { url });
-        state.tabId = requireTabId(result, "tab.open");
-        state.currentUrl = readObjectStringProperty(result, "url") ?? url;
-        return;
-      }
-
-      const result = await transport.invoke("tab.goto", {
-        tabId: state.tabId,
-        url
-      });
-      state.currentUrl = readObjectStringProperty(result, "url") ?? url;
-    },
-    bringToFront: async () => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      await transport.invoke("tab.focus", { tabId });
-    },
-    close: async () => {
-      if (state.closed) {
-        return;
-      }
-
-      if (state.tabId !== undefined) {
-        await transport.invoke("tab.close", { tabId: state.tabId });
-      }
-      state.closed = true;
-      releasePage();
-    },
-    url: () => state.currentUrl,
-    title: async () => {
-      ensureOpen();
-      if (state.tabId === undefined) {
-        return "";
-      }
-
-      const result = await transport.invoke("tab.info", { tabId: state.tabId });
-      state.currentUrl = readObjectStringProperty(result, "url") ?? state.currentUrl;
-      return readObjectStringProperty(result, "title") ?? "";
-    },
-    content: async () => {
-      ensureOpen();
-      if (state.tabId === undefined) {
-        return "";
-      }
-
-      const result = await transport.invoke("tab.snapshot", { tabId: state.tabId });
-      state.currentUrl = readObjectStringProperty(result, "url") ?? state.currentUrl;
-      return readObjectStringProperty(result, "html") ?? "";
-    },
-    screenshot: async () => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.screenshot", { tabId });
-      return readScreenshotResult(result);
-    },
-    domQuery: async (selector: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.dom.query", { tabId, selector });
-      return isObjectRecord(result) ? result : { selector, found: false };
-    },
-    domQueryAll: async (selector: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.dom.queryAll", { tabId, selector });
-      return isObjectRecord(result) ? result : { selector, count: 0, nodes: [] };
-    },
-    elementScreenshot: async (selector: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.element.screenshot", { tabId, selector });
-      return isObjectRecord(result) ? result : { selector, found: false };
-    },
-    a11ySnapshot: async (selector?: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.a11y.snapshot", { tabId, selector });
-      return isObjectRecord(result) ? result : { found: false };
-    },
-    cookieGet: async (name?: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.cookie.get", { tabId, name });
-      return isObjectRecord(result) ? result : { cookies: [] };
-    },
-    cookieSet: async (cookie: { name: string; value: string; url?: string }) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.cookie.set", {
-        tabId,
-        ...cookie
-      });
-      return isObjectRecord(result) ? result : { set: true };
-    },
-    cookieClear: async (name?: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.cookie.clear", { tabId, name });
-      return isObjectRecord(result) ? result : { cleared: true };
-    },
-    storageGet: async (scope: string, key: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.storage.get", { tabId, scope, key });
-      return isObjectRecord(result) ? result : { scope, key, exists: false };
-    },
-    storageSet: async (scope: string, key: string, value: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.storage.set", { tabId, scope, key, value });
-      return isObjectRecord(result) ? result : { scope, key, value, set: true };
-    },
-    frameList: async () => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.frame.list", { tabId });
-      return isObjectRecord(result) ? result : { frames: [] };
-    },
-    frameSnapshot: async (frameId: string) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.frame.snapshot", { tabId, frameId });
-      return isObjectRecord(result) ? result : { frameId, found: false };
-    },
-    scroll: async (deltaX = 0, deltaY = 900) => {
-      ensureOpen();
-      const tabId = ensureTabId();
-      const result = await transport.invoke("tab.act", {
-        tabId,
-        action: {
-          type: "scroll",
-          payload: {
-            deltaX,
-            deltaY
-          }
-        }
-      });
-      return isObjectRecord(result)
-        ? result
-        : {
-            executed: true,
-            deltaX,
-            deltaY
-          };
-    },
-    locator: (selector) => createLocator(transport, state, selector),
-    on: (eventName, listener) => {
-      const currentListeners = listeners.get(eventName);
-      if (currentListeners !== undefined) {
-        currentListeners.push(listener as ExtensionPageEventListener);
-        return;
-      }
-
-      listeners.set(eventName, [listener as ExtensionPageEventListener]);
-    },
-    keyboard: {
-      press: async (key) => {
-        ensureOpen();
-        const tabId = ensureTabId();
-        await transport.invoke("tab.act", {
-          tabId,
-          action: {
-            type: "press",
-            payload: { key }
-          }
-        });
-      }
-    }
-  };
-
-  return {
-    page,
-    state,
-    close: async () => {
-      await page.close();
-    },
-    emitConsole: async (entry) => {
-      await emitPageEvent(listeners, "console", toConsoleEventPayload(entry));
-    },
-    emitResponse: async (response) => {
-      await emitPageEvent(listeners, "response", toResponseEventPayload(response));
-    }
-  };
-}
-
-function createBrowser(transport: ChromeRelayExtensionTransport): ChromeRelayBrowser {
-  const pageRecords = new Set<ExtensionPageRecord>();
-  let detachEventListener: (() => void) | undefined;
-
-  if (typeof transport.onEvent === "function") {
-    detachEventListener = transport.onEvent((event) => {
-      for (const pageRecord of [...pageRecords]) {
-        if (pageRecord.state.tabId === undefined || pageRecord.state.tabId !== event.tabId) {
-          continue;
-        }
-
-        if (event.kind === "console") {
-          void pageRecord.emitConsole(event.entry);
-          continue;
-        }
-
-        if (event.kind === "response") {
-          void pageRecord.emitResponse(event.response);
-        }
-      }
-    });
-  }
-
-  const context: ChromeRelayBrowserContext = {
-    newPage: async () => {
-      const pageRecord = createPageRecord(transport, () => {
-        pageRecords.delete(pageRecord);
-      });
-      pageRecords.add(pageRecord);
-      return pageRecord.page;
-    },
-    close: async () => {
-      for (const pageRecord of [...pageRecords]) {
-        await pageRecord.close();
-      }
-      pageRecords.clear();
-    }
-  };
-
-  return {
-    contexts: () => [context],
-    newContext: async () => context,
-    close: async () => {
-      await context.close?.();
-      detachEventListener?.();
-      detachEventListener = undefined;
-    }
-  };
-}
-
-export function createChromeRelayExtensionRuntime(
-  config: ChromeRelayExtensionRuntimeConfig
-): ChromeRelayDriverRuntime {
-  return {
-    connectOverCDP: async (_endpointUrl) => {
-      requireConnected(config.transport);
-      return createBrowser(config.transport);
-    },
-    isConnected: () => config.transport.isConnected?.() ?? false
-  };
-}

package/packages/driver-chrome-relay/src/index.ts

@@ -1,26 +0,0 @@
-export { createChromeRelayDriver } from "./chrome-relay-driver";
-export { createChromeRelayExtensionRuntime } from "./chrome-relay-extension-runtime";
-export type {
-  ChromeRelayBrowser,
-  ChromeRelayBrowserContext,
-  ChromeRelayConsoleEntry,
-  ChromeRelayConsoleEntryLocation,
-  ChromeRelayDriverConfig,
-  ChromeRelayDriverRuntime,
-  ChromeRelayDriverStatus,
-  ChromeRelayKeyboard,
-  ChromeRelayLocator,
-  ChromeRelayNetworkRequestSummary,
-  ChromeRelayNetworkResponseBody,
-  ChromeRelayPage,
-  ChromeRelayScreenshot,
-  ChromeRelaySnapshot,
-  ChromeRelayTelemetryDriverExtensions
-} from "./chrome-relay-driver";
-export type {
-  ChromeRelayExtensionRuntimeConfig,
-  ChromeRelayExtensionTransportEvent,
-  ChromeRelayExtensionTransportConsoleEvent,
-  ChromeRelayExtensionTransportNetworkEvent,
-  ChromeRelayExtensionTransport
-} from "./chrome-relay-extension-runtime";

package/packages/driver-managed/src/index.ts

@@ -1,22 +0,0 @@
-export { createManagedDriver } from "./managed-driver";
-export type { ManagedDriverStatus } from "./managed-driver";
-export { createManagedLocalDriver } from "./managed-local-driver";
-export type {
-  ManagedLocalBrowser,
-  ManagedLocalBrowserContext,
-  ManagedLocalBrowserLaunchConfig,
-  ManagedLocalBrowserName,
-  ManagedLocalConsoleEntry,
-  ManagedLocalConsoleEntryLocation,
-  ManagedLocalDriverConfig,
-  ManagedLocalDriverRuntime,
-  ManagedLocalDriverStatus,
-  ManagedLocalKeyboard,
-  ManagedLocalLocator,
-  ManagedLocalNetworkRequestSummary,
-  ManagedLocalNetworkResponseBody,
-  ManagedLocalPage,
-  ManagedLocalScreenshot,
-  ManagedLocalSnapshot,
-  ManagedLocalTelemetryDriverExtensions
-} from "./managed-local-driver";