obsidian-e2e 0.0.0-next.0

package/dist/types-5UxOZM7r.d.mts

@@ -0,0 +1,152 @@
+//#region src/core/types.d.ts
+type ObsidianArg = boolean | number | string | null | undefined;
+interface ExecOptions {
+  allowNonZeroExit?: boolean;
+  cwd?: string;
+  env?: NodeJS.ProcessEnv;
+  timeoutMs?: number;
+}
+interface ExecResult {
+  argv: string[];
+  command: string;
+  exitCode: number;
+  stderr: string;
+  stdout: string;
+}
+interface ExecuteRequest extends ExecOptions {
+  argv: string[];
+  bin: string;
+}
+type CommandTransport = (request: ExecuteRequest) => Promise<ExecResult>;
+interface WaitForOptions {
+  intervalMs?: number;
+  message?: string;
+  timeoutMs?: number;
+}
+interface CommandListOptions {
+  filter?: string;
+}
+interface OpenFileOptions {
+  file?: string;
+  newTab?: boolean;
+  path?: string;
+}
+interface OpenTabOptions {
+  file?: string;
+  group?: string;
+  view?: string;
+}
+interface PluginToggleOptions {
+  filter?: "community" | "core";
+}
+interface RestartAppOptions {
+  readyOptions?: WaitForOptions;
+  waitUntilReady?: boolean;
+}
+interface TabsOptions {
+  ids?: boolean;
+}
+interface WorkspaceOptions {
+  ids?: boolean;
+}
+type JsonFileUpdater<T> = (draft: T) => Promise<T | void> | T | void;
+interface JsonFile<T = unknown> {
+  patch(updater: JsonFileUpdater<T>): Promise<T>;
+  read(): Promise<T>;
+  write(value: T): Promise<void>;
+}
+interface PluginHandle {
+  readonly id: string;
+  data<T = unknown>(): JsonFile<T>;
+  dataPath(): Promise<string>;
+  disable(options?: PluginToggleOptions): Promise<void>;
+  enable(options?: PluginToggleOptions): Promise<void>;
+  isEnabled(): Promise<boolean>;
+  reload(): Promise<void>;
+  restoreData(): Promise<void>;
+}
+interface ObsidianAppHandle {
+  reload(options?: ExecOptions): Promise<void>;
+  restart(options?: RestartAppOptions & ExecOptions): Promise<void>;
+  version(options?: ExecOptions): Promise<string>;
+  waitUntilReady(options?: WaitForOptions): Promise<void>;
+}
+interface ObsidianCommandHandle {
+  readonly id: string;
+  exists(options?: CommandListOptions): Promise<boolean>;
+  run(options?: ExecOptions): Promise<void>;
+}
+interface ObsidianDevHandle {
+  dom(options: DevDomQueryOptions, execOptions?: ExecOptions): Promise<DevDomResult>;
+  eval<T = unknown>(code: string, options?: ExecOptions): Promise<T>;
+  screenshot(path: string, options?: ExecOptions): Promise<string>;
+}
+type DevDomResult = number | string | string[];
+interface DevDomQueryOptions {
+  all?: boolean;
+  attr?: string;
+  css?: string;
+  inner?: boolean;
+  selector: string;
+  text?: boolean;
+  total?: boolean;
+}
+interface WorkspaceNode {
+  children: WorkspaceNode[];
+  id?: string;
+  label: string;
+  title?: string;
+  viewType?: string;
+}
+interface WorkspaceTab {
+  id?: string;
+  title: string;
+  viewType: string;
+}
+interface ObsidianClient {
+  readonly app: ObsidianAppHandle;
+  readonly bin: string;
+  readonly dev: ObsidianDevHandle;
+  readonly vaultName: string;
+  command(id: string): ObsidianCommandHandle;
+  commands(options?: CommandListOptions, execOptions?: ExecOptions): Promise<string[]>;
+  exec(command: string, args?: Record<string, ObsidianArg>, options?: ExecOptions): Promise<ExecResult>;
+  execJson<T = unknown>(command: string, args?: Record<string, ObsidianArg>, options?: ExecOptions): Promise<T>;
+  execText(command: string, args?: Record<string, ObsidianArg>, options?: ExecOptions): Promise<string>;
+  open(options: OpenFileOptions, execOptions?: ExecOptions): Promise<void>;
+  openTab(options?: OpenTabOptions, execOptions?: ExecOptions): Promise<void>;
+  plugin(id: string): PluginHandle;
+  tabs(options?: TabsOptions, execOptions?: ExecOptions): Promise<WorkspaceTab[]>;
+  vaultPath(): Promise<string>;
+  verify(): Promise<void>;
+  waitFor<T>(fn: () => Promise<T | false | null | undefined> | T | false | null | undefined, options?: WaitForOptions): Promise<T>;
+  workspace(options?: WorkspaceOptions, execOptions?: ExecOptions): Promise<WorkspaceNode[]>;
+}
+interface CreateObsidianClientOptions {
+  bin?: string;
+  intervalMs?: number;
+  timeoutMs?: number;
+  transport?: CommandTransport;
+  vault: string;
+}
+interface DeleteOptions {
+  permanent?: boolean;
+}
+interface VaultApi {
+  delete(path: string, options?: DeleteOptions): Promise<void>;
+  exists(path: string): Promise<boolean>;
+  json<T = unknown>(path: string): JsonFile<T>;
+  mkdir(path: string): Promise<void>;
+  read(path: string): Promise<string>;
+  waitForExists(path: string, options?: WaitForOptions): Promise<void>;
+  waitForMissing(path: string, options?: WaitForOptions): Promise<void>;
+  write(path: string, content: string): Promise<void>;
+}
+interface SandboxApi extends VaultApi {
+  readonly root: string;
+  cleanup(): Promise<void>;
+  path(...segments: string[]): string;
+}
+//#endregion
+export { WaitForOptions as C, WorkspaceTab as E, VaultApi as S, WorkspaceOptions as T, PluginHandle as _, DevDomResult as a, SandboxApi as b, JsonFile as c, ObsidianArg as d, ObsidianClient as f, OpenTabOptions as g, OpenFileOptions as h, DevDomQueryOptions as i, JsonFileUpdater as l, ObsidianDevHandle as m, CommandTransport as n, ExecOptions as o, ObsidianCommandHandle as p, CreateObsidianClientOptions as r, ExecResult as s, CommandListOptions as t, ObsidianAppHandle as u, PluginToggleOptions as v, WorkspaceNode as w, TabsOptions as x, RestartAppOptions as y };
+//# sourceMappingURL=types-5UxOZM7r.d.mts.map

package/dist/vitest.d.mts

@@ -0,0 +1,46 @@
+import { S as VaultApi, _ as PluginHandle, b as SandboxApi, f as ObsidianClient, r as CreateObsidianClientOptions, v as PluginToggleOptions } from "./types-5UxOZM7r.mjs";
+import { TestAPI } from "vite-plus/test";
+
+//#region src/fixtures/types.d.ts
+interface FailureArtifactOptions {
+  activeFile?: boolean;
+  dom?: boolean;
+  editorText?: boolean;
+  screenshot?: boolean;
+  tabs?: boolean;
+  workspace?: boolean;
+}
+interface CreateObsidianTestOptions extends CreateObsidianClientOptions {
+  artifactsDir?: string;
+  captureOnFailure?: boolean | FailureArtifactOptions;
+  sandboxRoot?: string;
+}
+type VaultSeedEntry = string | {
+  json: unknown;
+};
+type VaultSeed = Record<string, VaultSeedEntry>;
+interface CreatePluginTestOptions extends CreateObsidianTestOptions {
+  pluginFilter?: PluginToggleOptions["filter"];
+  pluginId: string;
+  seedPluginData?: unknown;
+  seedVault?: VaultSeed;
+}
+interface ObsidianFixtures {
+  obsidian: ObsidianClient;
+  sandbox: SandboxApi;
+  vault: VaultApi;
+}
+interface PluginFixtures extends ObsidianFixtures {
+  plugin: PluginHandle;
+}
+type ObsidianTest = TestAPI<ObsidianFixtures>;
+type PluginTest = TestAPI<PluginFixtures>;
+//#endregion
+//#region src/fixtures/create-obsidian-test.d.ts
+declare function createObsidianTest(options: CreateObsidianTestOptions): ObsidianTest;
+//#endregion
+//#region src/fixtures/create-plugin-test.d.ts
+declare function createPluginTest(options: CreatePluginTestOptions): PluginTest;
+//#endregion
+export { type CreateObsidianTestOptions, type CreatePluginTestOptions, type ObsidianFixtures, type ObsidianTest, type PluginFixtures, type PluginTest, type VaultSeed, type VaultSeedEntry, createObsidianTest, createPluginTest };
+//# sourceMappingURL=vitest.d.mts.map

package/dist/vitest.mjs

@@ -0,0 +1,182 @@
+import { i as getClientInternals, n as createVaultApi, r as createObsidianClient, t as createSandboxApi } from "./sandbox-BhesE1S4.mjs";
+import { mkdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { test } from "vite-plus/test";
+//#region src/fixtures/failure-artifacts.ts
+const DEFAULT_ARTIFACTS_DIR = ".obsidian-e2e-artifacts";
+function getFailureArtifactConfig(options) {
+	if (!options.captureOnFailure) return {
+		artifactsDir: path.resolve(options.artifactsDir ?? DEFAULT_ARTIFACTS_DIR),
+		capture: {
+			activeFile: true,
+			dom: true,
+			editorText: true,
+			screenshot: true,
+			tabs: true,
+			workspace: true
+		},
+		enabled: false
+	};
+	const overrides = options.captureOnFailure === true ? {} : options.captureOnFailure;
+	return {
+		artifactsDir: path.resolve(options.artifactsDir ?? DEFAULT_ARTIFACTS_DIR),
+		capture: {
+			activeFile: overrides.activeFile ?? true,
+			dom: overrides.dom ?? true,
+			editorText: overrides.editorText ?? true,
+			screenshot: overrides.screenshot ?? true,
+			tabs: overrides.tabs ?? true,
+			workspace: overrides.workspace ?? true
+		},
+		enabled: true
+	};
+}
+function getFailureArtifactDirectory(artifactsDir, task) {
+	const suffix = task.id.split("_").at(-1) ?? "test";
+	return path.join(artifactsDir, `${sanitizeForPath(task.name)}-${suffix}`);
+}
+function registerFailureArtifacts(context, obsidian, options) {
+	const config = getFailureArtifactConfig(options);
+	if (!config.enabled) return;
+	context.onTestFailed(async () => {
+		const artifactDirectory = getFailureArtifactDirectory(config.artifactsDir, context.task);
+		await mkdir(artifactDirectory, { recursive: true });
+		await Promise.all([
+			captureJsonArtifact(artifactDirectory, "active-file.json", config.capture.activeFile, async () => ({ activeFile: await obsidian.dev.eval("app.workspace.getActiveFile()?.path ?? null") })),
+			captureTextArtifact(artifactDirectory, "dom.txt", config.capture.dom, async () => String(await obsidian.dev.dom({
+				inner: true,
+				selector: ".workspace"
+			}))),
+			captureJsonArtifact(artifactDirectory, "editor.json", config.capture.editorText, async () => ({ text: await obsidian.dev.eval("app.workspace.activeLeaf?.view?.editor?.getValue?.() ?? null") })),
+			captureScreenshotArtifact(artifactDirectory, config.capture.screenshot, obsidian),
+			captureJsonArtifact(artifactDirectory, "tabs.json", config.capture.tabs, () => obsidian.tabs()),
+			captureJsonArtifact(artifactDirectory, "workspace.json", config.capture.workspace, () => obsidian.workspace())
+		]);
+	});
+}
+function registerPluginFailureArtifacts(context, plugin, options) {
+	const config = getFailureArtifactConfig(options);
+	if (!config.enabled) return;
+	context.onTestFailed(async () => {
+		const artifactDirectory = getFailureArtifactDirectory(config.artifactsDir, context.task);
+		await mkdir(artifactDirectory, { recursive: true });
+		await captureJsonArtifact(artifactDirectory, `${plugin.id}-data.json`, true, () => plugin.data().read());
+	});
+}
+async function captureJsonArtifact(artifactDirectory, filename, enabled, readValue) {
+	if (!enabled) return;
+	try {
+		const value = await readValue();
+		await writeFile(path.join(artifactDirectory, filename), `${JSON.stringify(value, null, 2)}\n`, "utf8");
+	} catch (error) {
+		await writeFile(path.join(artifactDirectory, `${filename}.error.txt`), formatArtifactError(error), "utf8");
+	}
+}
+async function captureScreenshotArtifact(artifactDirectory, enabled, obsidian) {
+	if (!enabled) return;
+	const screenshotPath = path.join(artifactDirectory, "screenshot.png");
+	try {
+		await obsidian.dev.screenshot(screenshotPath);
+	} catch (error) {
+		await writeFile(path.join(artifactDirectory, "screenshot.error.txt"), formatArtifactError(error), "utf8");
+	}
+}
+async function captureTextArtifact(artifactDirectory, filename, enabled, readValue) {
+	if (!enabled) return;
+	try {
+		await writeFile(path.join(artifactDirectory, filename), await readValue(), "utf8");
+	} catch (error) {
+		await writeFile(path.join(artifactDirectory, `${filename}.error.txt`), formatArtifactError(error), "utf8");
+	}
+}
+function formatArtifactError(error) {
+	return error instanceof Error ? `${error.name}: ${error.message}\n` : `${String(error)}\n`;
+}
+function sanitizeForPath(value) {
+	return value.trim().toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "").slice(0, 60) || "test";
+}
+function createBaseFixtures(options, fixtureOptions = {}) {
+	const createVault = fixtureOptions.createVault ?? ((obsidian) => createVaultApi({ obsidian }));
+	return {
+		obsidian: async ({ onTestFailed, task }, use) => {
+			const obsidian = createObsidianClient(options);
+			await obsidian.verify();
+			registerFailureArtifacts({
+				onTestFailed,
+				task
+			}, obsidian, options);
+			try {
+				await use(obsidian);
+			} finally {
+				await getClientInternals(obsidian).restoreAll();
+			}
+		},
+		sandbox: async ({ obsidian }, use) => {
+			const sandbox = await createSandboxApi({
+				obsidian,
+				sandboxRoot: options.sandboxRoot ?? "__obsidian_e2e__",
+				testName: "test"
+			});
+			try {
+				await use(sandbox);
+			} finally {
+				await sandbox.cleanup();
+			}
+		},
+		vault: async ({ obsidian }, use) => {
+			await use(await createVault(obsidian));
+		}
+	};
+}
+//#endregion
+//#region src/fixtures/create-obsidian-test.ts
+function createObsidianTest(options) {
+	return test.extend(createBaseFixtures(options));
+}
+//#endregion
+//#region src/fixtures/create-plugin-test.ts
+function createPluginTest(options) {
+	return test.extend({
+		...createBaseFixtures(options, { async createVault(obsidian) {
+			if (options.seedVault) await applyVaultSeed(obsidian, options.seedVault);
+			return createVaultApi({ obsidian });
+		} }),
+		plugin: async ({ obsidian, onTestFailed, task }, use) => {
+			const plugin = obsidian.plugin(options.pluginId);
+			const wasEnabled = await plugin.isEnabled();
+			if (!wasEnabled) await plugin.enable({ filter: options.pluginFilter });
+			if (options.seedPluginData !== void 0) await plugin.data().write(options.seedPluginData);
+			registerPluginFailureArtifacts({
+				onTestFailed,
+				task
+			}, plugin, options);
+			try {
+				await use(plugin);
+			} finally {
+				if (!wasEnabled) await plugin.disable({ filter: options.pluginFilter });
+			}
+		}
+	});
+}
+async function applyVaultSeed(obsidian, seedVault) {
+	const vaultRoot = await obsidian.vaultPath();
+	for (const [targetPath, value] of Object.entries(seedVault)) {
+		const resolvedPath = path.resolve(vaultRoot, ...targetPath.split("/").filter(Boolean));
+		const normalizedVaultRoot = path.resolve(vaultRoot);
+		if (resolvedPath !== normalizedVaultRoot && !resolvedPath.startsWith(`${normalizedVaultRoot}${path.sep}`)) throw new Error(`Seed path escapes the vault root: ${targetPath}`);
+		await getClientInternals(obsidian).snapshotFileOnce(resolvedPath);
+		await mkdir(path.dirname(resolvedPath), { recursive: true });
+		await writeSeedValue(resolvedPath, value);
+	}
+}
+async function writeSeedValue(resolvedPath, value) {
+	if (typeof value === "string") {
+		await writeFile(resolvedPath, value, "utf8");
+		return;
+	}
+	await writeFile(resolvedPath, `${JSON.stringify(value.json, null, 2)}\n`, "utf8");
+}
+//#endregion
+export { createObsidianTest, createPluginTest };
+
+//# sourceMappingURL=vitest.mjs.map

package/dist/vitest.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.mjs","names":["base","base"],"sources":["../src/fixtures/failure-artifacts.ts","../src/fixtures/base-fixtures.ts","../src/fixtures/create-obsidian-test.ts","../src/fixtures/create-plugin-test.ts"],"sourcesContent":["import { mkdir, writeFile } from \"node:fs/promises\";\nimport path from \"node:path\";\n\nimport type { TestContext } from \"vite-plus/test\";\n\nimport type { ObsidianClient, PluginHandle } from \"../core/types\";\nimport type { CreateObsidianTestOptions, FailureArtifactOptions } from \"./types\";\n\nconst DEFAULT_ARTIFACTS_DIR = \".obsidian-e2e-artifacts\";\n\ninterface FailureArtifactConfig {\n  artifactsDir: string;\n  capture: Required<FailureArtifactOptions>;\n  enabled: boolean;\n}\n\nexport function getFailureArtifactConfig(\n  options: Pick<CreateObsidianTestOptions, \"artifactsDir\" | \"captureOnFailure\">,\n): FailureArtifactConfig {\n  if (!options.captureOnFailure) {\n    return {\n      artifactsDir: path.resolve(options.artifactsDir ?? DEFAULT_ARTIFACTS_DIR),\n      capture: {\n        activeFile: true,\n        dom: true,\n        editorText: true,\n        screenshot: true,\n        tabs: true,\n        workspace: true,\n      },\n      enabled: false,\n    };\n  }\n\n  const overrides = options.captureOnFailure === true ? {} : options.captureOnFailure;\n\n  return {\n    artifactsDir: path.resolve(options.artifactsDir ?? DEFAULT_ARTIFACTS_DIR),\n    capture: {\n      activeFile: overrides.activeFile ?? true,\n      dom: overrides.dom ?? true,\n      editorText: overrides.editorText ?? true,\n      screenshot: overrides.screenshot ?? true,\n      tabs: overrides.tabs ?? true,\n      workspace: overrides.workspace ?? true,\n    },\n    enabled: true,\n  };\n}\n\nexport function getFailureArtifactDirectory(\n  artifactsDir: string,\n  task: Pick<TestContext[\"task\"], \"id\" | \"name\">,\n): string {\n  const suffix = task.id.split(\"_\").at(-1) ?? \"test\";\n  return path.join(artifactsDir, `${sanitizeForPath(task.name)}-${suffix}`);\n}\n\nexport function registerFailureArtifacts(\n  context: Pick<TestContext, \"onTestFailed\" | \"task\">,\n  obsidian: ObsidianClient,\n  options: Pick<CreateObsidianTestOptions, \"artifactsDir\" | \"captureOnFailure\">,\n): void {\n  const config = getFailureArtifactConfig(options);\n\n  if (!config.enabled) {\n    return;\n  }\n\n  context.onTestFailed(async () => {\n    const artifactDirectory = getFailureArtifactDirectory(config.artifactsDir, context.task);\n    await mkdir(artifactDirectory, { recursive: true });\n\n    await Promise.all([\n      captureJsonArtifact(\n        artifactDirectory,\n        \"active-file.json\",\n        config.capture.activeFile,\n        async () => ({\n          activeFile: await obsidian.dev.eval<string | null>(\n            \"app.workspace.getActiveFile()?.path ?? null\",\n          ),\n        }),\n      ),\n      captureTextArtifact(artifactDirectory, \"dom.txt\", config.capture.dom, async () =>\n        String(\n          await obsidian.dev.dom({\n            inner: true,\n            selector: \".workspace\",\n          }),\n        ),\n      ),\n      captureJsonArtifact(\n        artifactDirectory,\n        \"editor.json\",\n        config.capture.editorText,\n        async () => ({\n          text: await obsidian.dev.eval<string | null>(\n            \"app.workspace.activeLeaf?.view?.editor?.getValue?.() ?? null\",\n          ),\n        }),\n      ),\n      captureScreenshotArtifact(artifactDirectory, config.capture.screenshot, obsidian),\n      captureJsonArtifact(artifactDirectory, \"tabs.json\", config.capture.tabs, () =>\n        obsidian.tabs(),\n      ),\n      captureJsonArtifact(artifactDirectory, \"workspace.json\", config.capture.workspace, () =>\n        obsidian.workspace(),\n      ),\n    ]);\n  });\n}\n\nexport function registerPluginFailureArtifacts(\n  context: Pick<TestContext, \"onTestFailed\" | \"task\">,\n  plugin: PluginHandle,\n  options: Pick<CreateObsidianTestOptions, \"artifactsDir\" | \"captureOnFailure\">,\n): void {\n  const config = getFailureArtifactConfig(options);\n\n  if (!config.enabled) {\n    return;\n  }\n\n  context.onTestFailed(async () => {\n    const artifactDirectory = getFailureArtifactDirectory(config.artifactsDir, context.task);\n    await mkdir(artifactDirectory, { recursive: true });\n    await captureJsonArtifact(artifactDirectory, `${plugin.id}-data.json`, true, () =>\n      plugin.data().read(),\n    );\n  });\n}\n\nasync function captureJsonArtifact(\n  artifactDirectory: string,\n  filename: string,\n  enabled: boolean,\n  readValue: () => Promise<unknown>,\n): Promise<void> {\n  if (!enabled) {\n    return;\n  }\n\n  try {\n    const value = await readValue();\n    await writeFile(\n      path.join(artifactDirectory, filename),\n      `${JSON.stringify(value, null, 2)}\\n`,\n      \"utf8\",\n    );\n  } catch (error) {\n    await writeFile(\n      path.join(artifactDirectory, `${filename}.error.txt`),\n      formatArtifactError(error),\n      \"utf8\",\n    );\n  }\n}\n\nasync function captureScreenshotArtifact(\n  artifactDirectory: string,\n  enabled: boolean,\n  obsidian: ObsidianClient,\n): Promise<void> {\n  if (!enabled) {\n    return;\n  }\n\n  const screenshotPath = path.join(artifactDirectory, \"screenshot.png\");\n\n  try {\n    await obsidian.dev.screenshot(screenshotPath);\n  } catch (error) {\n    await writeFile(\n      path.join(artifactDirectory, \"screenshot.error.txt\"),\n      formatArtifactError(error),\n      \"utf8\",\n    );\n  }\n}\n\nasync function captureTextArtifact(\n  artifactDirectory: string,\n  filename: string,\n  enabled: boolean,\n  readValue: () => Promise<string>,\n): Promise<void> {\n  if (!enabled) {\n    return;\n  }\n\n  try {\n    await writeFile(path.join(artifactDirectory, filename), await readValue(), \"utf8\");\n  } catch (error) {\n    await writeFile(\n      path.join(artifactDirectory, `${filename}.error.txt`),\n      formatArtifactError(error),\n      \"utf8\",\n    );\n  }\n}\n\nfunction formatArtifactError(error: unknown): string {\n  return error instanceof Error ? `${error.name}: ${error.message}\\n` : `${String(error)}\\n`;\n}\n\nfunction sanitizeForPath(value: string): string {\n  return (\n    value\n      .trim()\n      .toLowerCase()\n      .replace(/[^a-z0-9]+/g, \"-\")\n      .replace(/^-+|-+$/g, \"\")\n      .slice(0, 60) || \"test\"\n  );\n}\n","import type { TestContext } from \"vite-plus/test\";\n\nimport { createObsidianClient } from \"../core/client\";\nimport { getClientInternals } from \"../core/internals\";\nimport type { ObsidianClient, VaultApi } from \"../core/types\";\nimport { createSandboxApi } from \"../vault/sandbox\";\nimport { createVaultApi } from \"../vault/vault\";\nimport { registerFailureArtifacts } from \"./failure-artifacts\";\nimport type { CreateObsidianTestOptions } from \"./types\";\n\nexport const DEFAULT_SANDBOX_ROOT = \"__obsidian_e2e__\";\n\ninterface BaseFixtureOptions {\n  createVault?: (obsidian: ObsidianClient) => Promise<VaultApi> | VaultApi;\n}\n\nexport function createBaseFixtures(\n  options: CreateObsidianTestOptions,\n  fixtureOptions: BaseFixtureOptions = {},\n) {\n  const createVault =\n    fixtureOptions.createVault ?? ((obsidian: ObsidianClient) => createVaultApi({ obsidian }));\n\n  return {\n    // oxlint-disable-next-line no-empty-pattern\n    obsidian: async (\n      { onTestFailed, task }: Pick<TestContext, \"onTestFailed\" | \"task\">,\n      use: (obsidian: ObsidianClient) => Promise<void>,\n    ) => {\n      const obsidian = createObsidianClient(options);\n\n      await obsidian.verify();\n      registerFailureArtifacts({ onTestFailed, task }, obsidian, options);\n\n      try {\n        await use(obsidian);\n      } finally {\n        await getClientInternals(obsidian).restoreAll();\n      }\n    },\n    sandbox: async (\n      { obsidian }: { obsidian: ObsidianClient },\n      use: (sandbox: Awaited<ReturnType<typeof createSandboxApi>>) => Promise<void>,\n    ) => {\n      const sandbox = await createSandboxApi({\n        obsidian,\n        sandboxRoot: options.sandboxRoot ?? DEFAULT_SANDBOX_ROOT,\n        testName: \"test\",\n      });\n\n      try {\n        await use(sandbox);\n      } finally {\n        await sandbox.cleanup();\n      }\n    },\n    vault: async (\n      { obsidian }: { obsidian: ObsidianClient },\n      use: (vault: VaultApi) => Promise<void>,\n    ) => {\n      await use(await createVault(obsidian));\n    },\n  };\n}\n","import { test as base } from \"vite-plus/test\";\n\nimport { createBaseFixtures } from \"./base-fixtures\";\nimport type { CreateObsidianTestOptions, ObsidianFixtures, ObsidianTest } from \"./types\";\n\nexport function createObsidianTest(options: CreateObsidianTestOptions): ObsidianTest {\n  return base.extend<ObsidianFixtures>(createBaseFixtures(options));\n}\n","import { mkdir, writeFile } from \"node:fs/promises\";\nimport path from \"node:path\";\n\nimport { test as base } from \"vite-plus/test\";\nimport type { TestContext } from \"vite-plus/test\";\n\nimport { getClientInternals } from \"../core/internals\";\nimport type { ObsidianClient } from \"../core/types\";\nimport { createVaultApi } from \"../vault/vault\";\nimport { createBaseFixtures } from \"./base-fixtures\";\nimport { registerPluginFailureArtifacts } from \"./failure-artifacts\";\nimport type {\n  CreatePluginTestOptions,\n  PluginFixtures,\n  PluginTest,\n  VaultSeed,\n  VaultSeedEntry,\n} from \"./types\";\n\nexport function createPluginTest(options: CreatePluginTestOptions): PluginTest {\n  return base.extend<PluginFixtures>({\n    ...createBaseFixtures(options, {\n      async createVault(obsidian) {\n        if (options.seedVault) {\n          await applyVaultSeed(obsidian, options.seedVault);\n        }\n\n        return createVaultApi({ obsidian });\n      },\n    }),\n    plugin: async (\n      {\n        obsidian,\n        onTestFailed,\n        task,\n      }: Pick<PluginFixtures & TestContext, \"obsidian\" | \"onTestFailed\" | \"task\">,\n      use,\n    ) => {\n      const plugin = obsidian.plugin(options.pluginId);\n      const wasEnabled = await plugin.isEnabled();\n\n      if (!wasEnabled) {\n        await plugin.enable({ filter: options.pluginFilter });\n      }\n\n      if (options.seedPluginData !== undefined) {\n        await plugin.data().write(options.seedPluginData);\n      }\n\n      registerPluginFailureArtifacts({ onTestFailed, task }, plugin, options);\n\n      try {\n        await use(plugin);\n      } finally {\n        if (!wasEnabled) {\n          await plugin.disable({ filter: options.pluginFilter });\n        }\n      }\n    },\n  });\n}\n\nasync function applyVaultSeed(obsidian: ObsidianClient, seedVault: VaultSeed): Promise<void> {\n  const vaultRoot = await obsidian.vaultPath();\n\n  for (const [targetPath, value] of Object.entries(seedVault)) {\n    const resolvedPath = path.resolve(vaultRoot, ...targetPath.split(\"/\").filter(Boolean));\n    const normalizedVaultRoot = path.resolve(vaultRoot);\n\n    if (\n      resolvedPath !== normalizedVaultRoot &&\n      !resolvedPath.startsWith(`${normalizedVaultRoot}${path.sep}`)\n    ) {\n      throw new Error(`Seed path escapes the vault root: ${targetPath}`);\n    }\n\n    await getClientInternals(obsidian).snapshotFileOnce(resolvedPath);\n    await mkdir(path.dirname(resolvedPath), { recursive: true });\n    await writeSeedValue(resolvedPath, value);\n  }\n}\n\nasync function writeSeedValue(resolvedPath: string, value: VaultSeedEntry): Promise<void> {\n  if (typeof value === \"string\") {\n    await writeFile(resolvedPath, value, \"utf8\");\n    return;\n  }\n\n  await writeFile(resolvedPath, `${JSON.stringify(value.json, null, 2)}\\n`, \"utf8\");\n}\n"],"mappings":";;;;;AAQA,MAAM,wBAAwB;AAQ9B,SAAgB,yBACd,SACuB;AACvB,KAAI,CAAC,QAAQ,iBACX,QAAO;EACL,cAAc,KAAK,QAAQ,QAAQ,gBAAgB,sBAAsB;EACzE,SAAS;GACP,YAAY;GACZ,KAAK;GACL,YAAY;GACZ,YAAY;GACZ,MAAM;GACN,WAAW;GACZ;EACD,SAAS;EACV;CAGH,MAAM,YAAY,QAAQ,qBAAqB,OAAO,EAAE,GAAG,QAAQ;AAEnE,QAAO;EACL,cAAc,KAAK,QAAQ,QAAQ,gBAAgB,sBAAsB;EACzE,SAAS;GACP,YAAY,UAAU,cAAc;GACpC,KAAK,UAAU,OAAO;GACtB,YAAY,UAAU,cAAc;GACpC,YAAY,UAAU,cAAc;GACpC,MAAM,UAAU,QAAQ;GACxB,WAAW,UAAU,aAAa;GACnC;EACD,SAAS;EACV;;AAGH,SAAgB,4BACd,cACA,MACQ;CACR,MAAM,SAAS,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,GAAG,IAAI;AAC5C,QAAO,KAAK,KAAK,cAAc,GAAG,gBAAgB,KAAK,KAAK,CAAC,GAAG,SAAS;;AAG3E,SAAgB,yBACd,SACA,UACA,SACM;CACN,MAAM,SAAS,yBAAyB,QAAQ;AAEhD,KAAI,CAAC,OAAO,QACV;AAGF,SAAQ,aAAa,YAAY;EAC/B,MAAM,oBAAoB,4BAA4B,OAAO,cAAc,QAAQ,KAAK;AACxF,QAAM,MAAM,mBAAmB,EAAE,WAAW,MAAM,CAAC;AAEnD,QAAM,QAAQ,IAAI;GAChB,oBACE,mBACA,oBACA,OAAO,QAAQ,YACf,aAAa,EACX,YAAY,MAAM,SAAS,IAAI,KAC7B,8CACD,EACF,EACF;GACD,oBAAoB,mBAAmB,WAAW,OAAO,QAAQ,KAAK,YACpE,OACE,MAAM,SAAS,IAAI,IAAI;IACrB,OAAO;IACP,UAAU;IACX,CAAC,CACH,CACF;GACD,oBACE,mBACA,eACA,OAAO,QAAQ,YACf,aAAa,EACX,MAAM,MAAM,SAAS,IAAI,KACvB,+DACD,EACF,EACF;GACD,0BAA0B,mBAAmB,OAAO,QAAQ,YAAY,SAAS;GACjF,oBAAoB,mBAAmB,aAAa,OAAO,QAAQ,YACjE,SAAS,MAAM,CAChB;GACD,oBAAoB,mBAAmB,kBAAkB,OAAO,QAAQ,iBACtE,SAAS,WAAW,CACrB;GACF,CAAC;GACF;;AAGJ,SAAgB,+BACd,SACA,QACA,SACM;CACN,MAAM,SAAS,yBAAyB,QAAQ;AAEhD,KAAI,CAAC,OAAO,QACV;AAGF,SAAQ,aAAa,YAAY;EAC/B,MAAM,oBAAoB,4BAA4B,OAAO,cAAc,QAAQ,KAAK;AACxF,QAAM,MAAM,mBAAmB,EAAE,WAAW,MAAM,CAAC;AACnD,QAAM,oBAAoB,mBAAmB,GAAG,OAAO,GAAG,aAAa,YACrE,OAAO,MAAM,CAAC,MAAM,CACrB;GACD;;AAGJ,eAAe,oBACb,mBACA,UACA,SACA,WACe;AACf,KAAI,CAAC,QACH;AAGF,KAAI;EACF,MAAM,QAAQ,MAAM,WAAW;AAC/B,QAAM,UACJ,KAAK,KAAK,mBAAmB,SAAS,EACtC,GAAG,KAAK,UAAU,OAAO,MAAM,EAAE,CAAC,KAClC,OACD;UACM,OAAO;AACd,QAAM,UACJ,KAAK,KAAK,mBAAmB,GAAG,SAAS,YAAY,EACrD,oBAAoB,MAAM,EAC1B,OACD;;;AAIL,eAAe,0BACb,mBACA,SACA,UACe;AACf,KAAI,CAAC,QACH;CAGF,MAAM,iBAAiB,KAAK,KAAK,mBAAmB,iBAAiB;AAErE,KAAI;AACF,QAAM,SAAS,IAAI,WAAW,eAAe;UACtC,OAAO;AACd,QAAM,UACJ,KAAK,KAAK,mBAAmB,uBAAuB,EACpD,oBAAoB,MAAM,EAC1B,OACD;;;AAIL,eAAe,oBACb,mBACA,UACA,SACA,WACe;AACf,KAAI,CAAC,QACH;AAGF,KAAI;AACF,QAAM,UAAU,KAAK,KAAK,mBAAmB,SAAS,EAAE,MAAM,WAAW,EAAE,OAAO;UAC3E,OAAO;AACd,QAAM,UACJ,KAAK,KAAK,mBAAmB,GAAG,SAAS,YAAY,EACrD,oBAAoB,MAAM,EAC1B,OACD;;;AAIL,SAAS,oBAAoB,OAAwB;AACnD,QAAO,iBAAiB,QAAQ,GAAG,MAAM,KAAK,IAAI,MAAM,QAAQ,MAAM,GAAG,OAAO,MAAM,CAAC;;AAGzF,SAAS,gBAAgB,OAAuB;AAC9C,QACE,MACG,MAAM,CACN,aAAa,CACb,QAAQ,eAAe,IAAI,CAC3B,QAAQ,YAAY,GAAG,CACvB,MAAM,GAAG,GAAG,IAAI;;ACrMvB,SAAgB,mBACd,SACA,iBAAqC,EAAE,EACvC;CACA,MAAM,cACJ,eAAe,iBAAiB,aAA6B,eAAe,EAAE,UAAU,CAAC;AAE3F,QAAO;EAEL,UAAU,OACR,EAAE,cAAc,QAChB,QACG;GACH,MAAM,WAAW,qBAAqB,QAAQ;AAE9C,SAAM,SAAS,QAAQ;AACvB,4BAAyB;IAAE;IAAc;IAAM,EAAE,UAAU,QAAQ;AAEnE,OAAI;AACF,UAAM,IAAI,SAAS;aACX;AACR,UAAM,mBAAmB,SAAS,CAAC,YAAY;;;EAGnD,SAAS,OACP,EAAE,YACF,QACG;GACH,MAAM,UAAU,MAAM,iBAAiB;IACrC;IACA,aAAa,QAAQ,eAAA;IACrB,UAAU;IACX,CAAC;AAEF,OAAI;AACF,UAAM,IAAI,QAAQ;aACV;AACR,UAAM,QAAQ,SAAS;;;EAG3B,OAAO,OACL,EAAE,YACF,QACG;AACH,SAAM,IAAI,MAAM,YAAY,SAAS,CAAC;;EAEzC;;;;ACzDH,SAAgB,mBAAmB,SAAkD;AACnF,QAAOA,KAAK,OAAyB,mBAAmB,QAAQ,CAAC;;;;ACanE,SAAgB,iBAAiB,SAA8C;AAC7E,QAAOC,KAAK,OAAuB;EACjC,GAAG,mBAAmB,SAAS,EAC7B,MAAM,YAAY,UAAU;AAC1B,OAAI,QAAQ,UACV,OAAM,eAAe,UAAU,QAAQ,UAAU;AAGnD,UAAO,eAAe,EAAE,UAAU,CAAC;KAEtC,CAAC;EACF,QAAQ,OACN,EACE,UACA,cACA,QAEF,QACG;GACH,MAAM,SAAS,SAAS,OAAO,QAAQ,SAAS;GAChD,MAAM,aAAa,MAAM,OAAO,WAAW;AAE3C,OAAI,CAAC,WACH,OAAM,OAAO,OAAO,EAAE,QAAQ,QAAQ,cAAc,CAAC;AAGvD,OAAI,QAAQ,mBAAmB,KAAA,EAC7B,OAAM,OAAO,MAAM,CAAC,MAAM,QAAQ,eAAe;AAGnD,kCAA+B;IAAE;IAAc;IAAM,EAAE,QAAQ,QAAQ;AAEvE,OAAI;AACF,UAAM,IAAI,OAAO;aACT;AACR,QAAI,CAAC,WACH,OAAM,OAAO,QAAQ,EAAE,QAAQ,QAAQ,cAAc,CAAC;;;EAI7D,CAAC;;AAGJ,eAAe,eAAe,UAA0B,WAAqC;CAC3F,MAAM,YAAY,MAAM,SAAS,WAAW;AAE5C,MAAK,MAAM,CAAC,YAAY,UAAU,OAAO,QAAQ,UAAU,EAAE;EAC3D,MAAM,eAAe,KAAK,QAAQ,WAAW,GAAG,WAAW,MAAM,IAAI,CAAC,OAAO,QAAQ,CAAC;EACtF,MAAM,sBAAsB,KAAK,QAAQ,UAAU;AAEnD,MACE,iBAAiB,uBACjB,CAAC,aAAa,WAAW,GAAG,sBAAsB,KAAK,MAAM,CAE7D,OAAM,IAAI,MAAM,qCAAqC,aAAa;AAGpE,QAAM,mBAAmB,SAAS,CAAC,iBAAiB,aAAa;AACjE,QAAM,MAAM,KAAK,QAAQ,aAAa,EAAE,EAAE,WAAW,MAAM,CAAC;AAC5D,QAAM,eAAe,cAAc,MAAM;;;AAI7C,eAAe,eAAe,cAAsB,OAAsC;AACxF,KAAI,OAAO,UAAU,UAAU;AAC7B,QAAM,UAAU,cAAc,OAAO,OAAO;AAC5C;;AAGF,OAAM,UAAU,cAAc,GAAG,KAAK,UAAU,MAAM,MAAM,MAAM,EAAE,CAAC,KAAK,OAAO"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "obsidian-e2e",
+  "version": "0.0.0-next.0",
+  "description": "Vitest-first end-to-end test utilities for Obsidian plugins.",
+  "homepage": "https://github.com/chhoumann/obsidian-e2e#readme",
+  "bugs": {
+    "url": "https://github.com/chhoumann/obsidian-e2e/issues"
+  },
+  "license": "MIT",
+  "author": "Christian B. B. Houmann",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chhoumann/obsidian-e2e.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./vitest": {
+      "types": "./dist/vitest.d.mts",
+      "default": "./dist/vitest.mjs"
+    },
+    "./matchers": {
+      "types": "./dist/matchers.d.mts",
+      "default": "./dist/matchers.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "vite-plus": "^0.1.11"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "packageManager": "pnpm@10.32.1"
+}