obsidian-integration-testing 9.2.2 → 10.1.0

package/dist/lib/cjs/transport-desktop-cdp.d.cts

@@ -6,7 +6,7 @@
  *
  * Two modes:
  * - **Owned (default)**: the transport launches and owns an isolated Obsidian
- *   instance against a temporary `--user-data-dir` on a free `--remote-debugging-port`,
+ *   instance against a temporary `--user-data-directory` on a free `--remote-debugging-port`,
  *   never touching the user's Obsidian. Supports version pinning via the user-data asar.
  * - **Attach**: when an explicit CDP port is configured, the transport connects
  *   to an already-running Obsidian on that port.
@@ -17,6 +17,7 @@
  * Requirements: Node.js 22+ (uses built-in `WebSocket` and `fetch` globals).
  */
 import type { AsarFallback } from './asar-fallback-detection.cjs';
+import type { CaptureScreenshotParams } from './capture-screenshot.cjs';
 import type { ElectronCompatibility } from './electron-compatibility.cjs';
 import type { InstallerCompatibility } from './installer-compatibility.cjs';
 import type { ObsidianTransport, TransportEvalOptions } from './transport.cjs';
@@ -97,22 +98,28 @@ export interface DesktopCdpTransportConfig {
     shouldWarnOnCompatibilityIssues?: boolean;
 }
 /**
- * An asar to provision into a harness-owned instance's user-data dir before launch.
+ * An asar to provision into a harness-owned instance's user-data directory before launch.
  */
 export interface OwnedInstanceAsar {
-    /** Absolute path to the cached/source asar file. */
+    /**
+    Absolute path to the cached/source asar file.
+     */
     readonly path: string;
-    /** The asar's `x.y.z` version. */
+    /**
+    The asar's `x.y.z` version.
+     */
     readonly version: string;
 }
 /**
  * Configuration for a harness-owned, isolated Obsidian instance.
  *
  * When present, the transport launches and owns its own Obsidian process
- * against an isolated user-data dir instead of attaching to a running instance.
+ * against an isolated user-data directory instead of attaching to a running instance.
  */
 export interface OwnedInstanceConfig {
-    /** Optional asar to provision into {@link userDataDir} before launch. */
+    /**
+    Optional asar to provision into {@link userDataDirectory} before launch.
+     */
     readonly asar?: OwnedInstanceAsar | undefined;
     /**
      * The resolved installer↔app compatibility verdict, when it could be determined
@@ -123,21 +130,27 @@ export interface OwnedInstanceConfig {
      * `IncompatibleInstallerVersionError` before the config is built.
      */
     readonly compatibility?: InstallerCompatibility | undefined;
-    /** Absolute path to the Obsidian shell executable to launch. */
+    /**
+    Absolute path to the Obsidian shell executable to launch.
+     */
     readonly exePath: string;
     /**
-     * Absolute path to the isolated user-data dir. Created and owned by the
+     * Absolute path to the isolated user-data directory. Created and owned by the
      * transport, and deleted on dispose.
      */
-    readonly userDataDir: string;
+    readonly userDataDirectory: string;
 }
 /**
  * The CDP endpoint of a launched, harness-owned instance.
  */
 interface OwnedInstanceEndpoint {
-    /** CDP host (e.g. `'localhost'`). */
+    /**
+    CDP host (e.g. `'localhost'`).
+     */
     readonly host: string;
-    /** The free CDP port the owned instance was launched on. */
+    /**
+    The free CDP port the owned instance was launched on.
+     */
     readonly port: number;
 }
 /**
@@ -174,9 +187,23 @@ export declare class DesktopCdpTransport implements ObsidianTransport {
      * @param config - CDP connection configuration.
      */
     constructor(config?: DesktopCdpTransportConfig);
+    /**
+     * Captures a PNG screenshot of the Obsidian window showing the given vault.
+     *
+     * When a size is requested the viewport is pinned to it with
+     * `Emulation.setDeviceMetricsOverride` for the duration of the capture, so the
+     * emitted PNG is exactly that size whatever size the window happens to be —
+     * and the override is always cleared afterwards, including when the capture
+     * throws, so a failed capture cannot leave the window stuck at the override.
+     *
+     * @param params - Which vault window to capture, and the exact size to capture it at.
+     * @returns The raw PNG bytes.
+     * @throws Error if CDP returns no image data, or data that is not a PNG.
+     */
+    captureScreenshot(params: CaptureScreenshotParams): Promise<Uint8Array>;
     /**
      * Disposes of the active WebSocket connection and, in owned-instance mode,
-     * kills the owned Obsidian process and removes its isolated user-data dir.
+     * kills the owned Obsidian process and removes its isolated user-data directory.
      *
      * The removal is retried because Windows briefly holds the just-killed
      * process's file handles, which would otherwise fail `rmSync` with `EPERM`.
@@ -184,8 +211,8 @@ export declare class DesktopCdpTransport implements ObsidianTransport {
     dispose(): Promise<void>;
     /**
      * Synchronous disposal — kills the owned instance and makes a best-effort
-     * removal of its user-data dir. Safe to call from a process `exit` handler
-     * (where async retries are impossible; a leftover temp dir is acceptable).
+     * removal of its user-data directory. Safe to call from a process `exit` handler
+     * (where async retries are impossible; a leftover temp directory is acceptable).
      */
     disposeSync(): void;
     /**
@@ -368,7 +395,7 @@ export declare class DesktopCdpTransport implements ObsidianTransport {
      * Finds the CDP target that has the given vault open.
      *
      * Probes every target by evaluating `getBasePath()` and returns the one whose
-     * base path matches `vaultPath` (via {@link vaultPathsMatch}, tolerant of
+     * base path matches `vaultPath` (via {@link areVaultPathsMatching}, tolerant of
      * separator/case differences). A single target is **not** returned blindly: with
      * more than one vault open (attach mode's shared instance), the sole-target
      * shortcut would return whichever window happens to be open regardless of which
@@ -392,7 +419,7 @@ export declare class DesktopCdpTransport implements ObsidianTransport {
      * so the next launch gets a pristine single-window instance.
      *
      * Relaunching over a live instance is forwarded by Electron's single-instance
-     * lock on the shared user-data dir and surfaces the vault picker, and opening a
+     * lock on the shared user-data directory and surfaces the vault picker, and opening a
      * second window via IPC leaves stale windows that break vault-target routing —
      * hence a full kill + wait-for-exit (releasing the lock) between launches. A
      * no-op on the first attempt, when no instance is running yet.
@@ -467,7 +494,7 @@ export declare class DesktopCdpTransport implements ObsidianTransport {
     /**
      * Polls a killed owned instance's CDP endpoint until it stops responding,
      * confirming the process has exited and released Electron's single-instance
-     * lock on the shared user-data dir before a fresh instance is launched into it.
+     * lock on the shared user-data directory before a fresh instance is launched into it.
      *
      * @param cdpUrl - The CDP URL of the instance that was just killed.
      */