obsidian-integration-testing 4.3.0 → 5.0.0

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

@@ -1,154 +0,0 @@
-/**
- * @file
- *
- * Desktop CLI transport — evaluates expressions via `obsidian eval` and manages
- * vaults via Electron IPC.
- */
-import type { ObsidianTransport, TransportEvalOptions } from './transport.cjs';
-interface InvokeAndWriteResultParams {
-    evaluate(): Promise<unknown>;
-    readonly resultPath: string;
-    serializeError(error: unknown): string;
-}
-/**
- * Transport that communicates with Desktop Obsidian via the `obsidian eval` CLI command
- * and manages vaults via Electron IPC.
- */
-export declare class DesktopCliTransport implements ObsidianTransport {
-    /**
-     * Indicates whether this transport is for a mobile platform. Always `false` for this transport.
-     */
-    readonly isMobile = false;
-    /**
-     * Evaluates a JavaScript expression inside Obsidian via `obsidian eval`.
-     *
-     * Writes the expression to a temporary `.cjs` file and executes a tiny
-     * `require().invoke()` call via the CLI. The result is written to a
-     * `.result.json` file by the script, avoiding CLI stdout size limits
-     * and IPC buffer issues.
-     *
-     * Handles auto-start: if Obsidian is not running, launches it via URI protocol
-     * and retries until it becomes available.
-     *
-     * @param expression - The JavaScript expression to evaluate.
-     * @param options - Evaluation options.
-     * @returns The normalized result string (transport-specific prefixes stripped).
-     */
-    evaluate(expression: string, options: TransportEvalOptions): Promise<string>;
-    /**
-     * Runs CLI-specific preflight checks.
-     *
-     * Verifies that the vault is registered, CLI is enabled in Obsidian settings,
-     * and the `obsidian` CLI binary is available in PATH. If the vault is registered
-     * but not open, opens it via URI protocol and polls until it is ready.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    preflightCheck(vaultPath: string): Promise<void>;
-    /**
-     * Registers a vault in the running Obsidian instance via Electron IPC.
-     *
-     * Uses `vault-open` IPC to register and open the vault, then polls until
-     * the vault's CLI is ready and `getBasePath()` matches `vaultPath`.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    registerVault(vaultPath: string): Promise<void>;
-    /**
-     * Unregisters a vault from the running Obsidian instance.
-     *
-     * Schedules the vault window to close, waits, then removes the vault
-     * from the registry via `vault-remove` IPC.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    unregisterVault(vaultPath: string): Promise<void>;
-    /**
-     * Checks whether the Obsidian CLI binary is available in the system PATH.
-     */
-    private assertCliAvailable;
-    /**
-     * Dismisses the "Do you trust the author of this vault?" dialog if present.
-     *
-     * Clicks the "Trust author and enable plugins" button (`.mod-cta`) inside any
-     * modal whose text includes "Do you trust the author". Acts as a safety net
-     * for both registration paths:
-     *
-     * - First vault registered via config file (no prior `enable-plugin-<id>` entry).
-     * - Subsequent vault registered while another vault is already open. The
-     *   `enable-plugin-<newVaultId>` write happens in the existing vault's renderer,
-     *   but the new vault's renderer may read `localStorage` before that cross-renderer
-     *   write becomes visible (race observed in Obsidian 1.13.0).
-     *
-     * @param vaultPath - The vault path to evaluate in.
-     */
-    private dismissTrustDialog;
-    /**
-     * Sets `enable-plugin-<vaultId>` in Obsidian's localStorage to prevent
-     * the "Do you trust the author of this vault?" dialog from appearing
-     * when a vault with community plugins is opened for the first time.
-     *
-     * Must be called after the `vault-open` IPC (so the vault ID exists in
-     * `obsidian.json`) and before the new vault window finishes loading.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     * @param evalTargetVaultPath - The vault path to use as eval target (an existing, loaded vault).
-     *   localStorage is shared across all Obsidian windows (same Electron origin), so the
-     *   `localStorage.setItem` call can run in any loaded vault window.
-     */
-    private enablePluginsInLocalStorage;
-    /**
-     * Launches Obsidian binary and retries the eval until it responds.
-     *
-     * @param command - The CLI command array to retry.
-     * @param cwd - The working directory.
-     */
-    private ensureObsidianRunningAndRetry;
-    /**
-     * Returns the path of an already-open vault to use as an `obsidian eval`
-     * target, or `undefined` if there is none.
-     *
-     * The `open` flag in `obsidian.json` is only trustworthy while Obsidian is
-     * running — a killed or crashed process never resets it, leaving the user's
-     * last-session vault marked open. Acting on that stale flag would target the
-     * (possibly heavy) last-session vault and cause auto-start to reopen it.
-     * When Obsidian is not running we therefore report no open vault, so callers
-     * fall back to the direct-config path that opens only the temp vault.
-     *
-     * @returns The absolute path to an open vault, or `undefined`.
-     */
-    private getOpenEvalTargetVaultPath;
-    /**
-     * Kills the running Obsidian process (if any) and waits for it to exit.
-     */
-    private killObsidian;
-    /**
-     * Polls until the vault is ready and responding to eval calls.
-     *
-     * Each `obsidian eval` in the loop is given a per-call timeout. The overall
-     * deadline is only re-checked between awaits, so without it a single hung
-     * eval (e.g. a vault window that opened but never finished loading) would
-     * block past the deadline forever instead of failing and retrying.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    private pollVaultReady;
-    /**
-     * Restarts Obsidian by killing the running process and relaunching it.
-     *
-     * Used when a config change (like enabling CLI) requires a restart to take effect.
-     *
-     * @param vaultPath - The vault path to use for polling after restart.
-     */
-    private restartObsidian;
-}
-/**
- * Evaluates an expression, writes the result to a JSON file.
- *
- * Serialized via `toString()` and executed inside the Obsidian process.
- * Must NOT reference any outer scope.
- *
- * @param params - The invocation parameters.
- */
-export declare function invokeAndWriteResult(params: InvokeAndWriteResultParams): Promise<void>;
-export {};

package/dist/lib/esm/transport-desktop-cli.d.mts

@@ -1,154 +0,0 @@
-/**
- * @file
- *
- * Desktop CLI transport — evaluates expressions via `obsidian eval` and manages
- * vaults via Electron IPC.
- */
-import type { ObsidianTransport, TransportEvalOptions } from './transport.mjs';
-interface InvokeAndWriteResultParams {
-    evaluate(): Promise<unknown>;
-    readonly resultPath: string;
-    serializeError(error: unknown): string;
-}
-/**
- * Transport that communicates with Desktop Obsidian via the `obsidian eval` CLI command
- * and manages vaults via Electron IPC.
- */
-export declare class DesktopCliTransport implements ObsidianTransport {
-    /**
-     * Indicates whether this transport is for a mobile platform. Always `false` for this transport.
-     */
-    readonly isMobile = false;
-    /**
-     * Evaluates a JavaScript expression inside Obsidian via `obsidian eval`.
-     *
-     * Writes the expression to a temporary `.cjs` file and executes a tiny
-     * `require().invoke()` call via the CLI. The result is written to a
-     * `.result.json` file by the script, avoiding CLI stdout size limits
-     * and IPC buffer issues.
-     *
-     * Handles auto-start: if Obsidian is not running, launches it via URI protocol
-     * and retries until it becomes available.
-     *
-     * @param expression - The JavaScript expression to evaluate.
-     * @param options - Evaluation options.
-     * @returns The normalized result string (transport-specific prefixes stripped).
-     */
-    evaluate(expression: string, options: TransportEvalOptions): Promise<string>;
-    /**
-     * Runs CLI-specific preflight checks.
-     *
-     * Verifies that the vault is registered, CLI is enabled in Obsidian settings,
-     * and the `obsidian` CLI binary is available in PATH. If the vault is registered
-     * but not open, opens it via URI protocol and polls until it is ready.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    preflightCheck(vaultPath: string): Promise<void>;
-    /**
-     * Registers a vault in the running Obsidian instance via Electron IPC.
-     *
-     * Uses `vault-open` IPC to register and open the vault, then polls until
-     * the vault's CLI is ready and `getBasePath()` matches `vaultPath`.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    registerVault(vaultPath: string): Promise<void>;
-    /**
-     * Unregisters a vault from the running Obsidian instance.
-     *
-     * Schedules the vault window to close, waits, then removes the vault
-     * from the registry via `vault-remove` IPC.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    unregisterVault(vaultPath: string): Promise<void>;
-    /**
-     * Checks whether the Obsidian CLI binary is available in the system PATH.
-     */
-    private assertCliAvailable;
-    /**
-     * Dismisses the "Do you trust the author of this vault?" dialog if present.
-     *
-     * Clicks the "Trust author and enable plugins" button (`.mod-cta`) inside any
-     * modal whose text includes "Do you trust the author". Acts as a safety net
-     * for both registration paths:
-     *
-     * - First vault registered via config file (no prior `enable-plugin-<id>` entry).
-     * - Subsequent vault registered while another vault is already open. The
-     *   `enable-plugin-<newVaultId>` write happens in the existing vault's renderer,
-     *   but the new vault's renderer may read `localStorage` before that cross-renderer
-     *   write becomes visible (race observed in Obsidian 1.13.0).
-     *
-     * @param vaultPath - The vault path to evaluate in.
-     */
-    private dismissTrustDialog;
-    /**
-     * Sets `enable-plugin-<vaultId>` in Obsidian's localStorage to prevent
-     * the "Do you trust the author of this vault?" dialog from appearing
-     * when a vault with community plugins is opened for the first time.
-     *
-     * Must be called after the `vault-open` IPC (so the vault ID exists in
-     * `obsidian.json`) and before the new vault window finishes loading.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     * @param evalTargetVaultPath - The vault path to use as eval target (an existing, loaded vault).
-     *   localStorage is shared across all Obsidian windows (same Electron origin), so the
-     *   `localStorage.setItem` call can run in any loaded vault window.
-     */
-    private enablePluginsInLocalStorage;
-    /**
-     * Launches Obsidian binary and retries the eval until it responds.
-     *
-     * @param command - The CLI command array to retry.
-     * @param cwd - The working directory.
-     */
-    private ensureObsidianRunningAndRetry;
-    /**
-     * Returns the path of an already-open vault to use as an `obsidian eval`
-     * target, or `undefined` if there is none.
-     *
-     * The `open` flag in `obsidian.json` is only trustworthy while Obsidian is
-     * running — a killed or crashed process never resets it, leaving the user's
-     * last-session vault marked open. Acting on that stale flag would target the
-     * (possibly heavy) last-session vault and cause auto-start to reopen it.
-     * When Obsidian is not running we therefore report no open vault, so callers
-     * fall back to the direct-config path that opens only the temp vault.
-     *
-     * @returns The absolute path to an open vault, or `undefined`.
-     */
-    private getOpenEvalTargetVaultPath;
-    /**
-     * Kills the running Obsidian process (if any) and waits for it to exit.
-     */
-    private killObsidian;
-    /**
-     * Polls until the vault is ready and responding to eval calls.
-     *
-     * Each `obsidian eval` in the loop is given a per-call timeout. The overall
-     * deadline is only re-checked between awaits, so without it a single hung
-     * eval (e.g. a vault window that opened but never finished loading) would
-     * block past the deadline forever instead of failing and retrying.
-     *
-     * @param vaultPath - The absolute path to the vault folder.
-     */
-    private pollVaultReady;
-    /**
-     * Restarts Obsidian by killing the running process and relaunching it.
-     *
-     * Used when a config change (like enabling CLI) requires a restart to take effect.
-     *
-     * @param vaultPath - The vault path to use for polling after restart.
-     */
-    private restartObsidian;
-}
-/**
- * Evaluates an expression, writes the result to a JSON file.
- *
- * Serialized via `toString()` and executed inside the Obsidian process.
- * Must NOT reference any outer scope.
- *
- * @param params - The invocation parameters.
- */
-export declare function invokeAndWriteResult(params: InvokeAndWriteResultParams): Promise<void>;
-export {};