obsidian-e2e 0.3.1 → 0.5.0

package/README.md

@@ -207,7 +207,13 @@ import { test } from "./setup";
 test("reloads a plugin after patching its data file", async ({ obsidian, vault, sandbox }) => {
   const plugin = obsidian.plugin("my-plugin");
 
-  await sandbox.write("tpl.md", "template body");
+  await sandbox.writeNote({
+    path: "tpl.md",
+    frontmatter: {
+      tags: ["template"],
+    },
+    body: "template body",
+  });
   await vault.write("notes/source.md", "existing");
 
   await plugin.data<{ enabled: boolean }>().patch((draft) => {
@@ -231,10 +237,70 @@ Fixture summary:
 - `sandbox`
   - a per-test disposable directory under `sandboxRoot`; automatically cleaned
     up after each test
+  - exposes note helpers such as `writeNote()`, `readNote()`, `frontmatter()`,
+    `waitForFrontmatter()`, and `waitForMetadata()`
 
 Plugin data mutations are snapshotted on first write and restored automatically
 after each test. Sandbox files are also cleaned up automatically.
 
+## Note Helpers And Test Context
+
+Use `sandbox.writeNote()` when the test cares about note structure rather than
+raw YAML formatting:
+
+```ts
+await sandbox.writeNote({
+  path: "Inbox/Today.md",
+  frontmatter: {
+    mood: "focused",
+    tags: ["daily"],
+  },
+  body: "# Today\n",
+});
+
+await expect(sandbox.readNote("Inbox/Today.md")).resolves.toMatchObject({
+  body: "# Today\n",
+  frontmatter: {
+    mood: "focused",
+    tags: ["daily"],
+  },
+});
+
+await sandbox.waitForFrontmatter("Inbox/Today.md", (frontmatter) =>
+  frontmatter.tags.includes("daily"),
+);
+```
+
+`readNote()` is file-derived. `sandbox.frontmatter()` and
+`sandbox.waitForMetadata()` are Obsidian metadata-cache reads, so tests can
+distinguish raw file content from “Obsidian has indexed this note”.
+
+Outside Vitest fixtures, use the public lifecycle wrapper:
+
+```ts
+import { withVaultSandbox } from "obsidian-e2e";
+
+await withVaultSandbox(
+  {
+    testName: "quickadd smoke",
+    vault: "dev",
+  },
+  async (context) => {
+    const plugin = await context.plugin("quickadd", {
+      filter: "community",
+      seedData: { enabled: true },
+    });
+
+    await context.sandbox.writeNote({
+      path: "fixtures/template.md",
+      body: "Hello from template",
+    });
+
+    await plugin.reload();
+  },
+);
+```
+
 ## Plugin Test Helper
 
 If you are testing one plugin repeatedly, `createPluginTest()` gives you a
@@ -250,7 +316,14 @@ export const test = createPluginTest({
   pluginFilter: "community",
   seedPluginData: { enabled: true },
   seedVault: {
-    "fixtures/template.md": "template body",
+    "fixtures/template.md": {
+      note: {
+        body: "template body",
+        frontmatter: {
+          tags: ["template"],
+        },
+      },
+    },
     "fixtures/state.json": { json: { ready: true } },
   },
 });
@@ -262,6 +335,7 @@ export const test = createPluginTest({
 - enables the target plugin for the test when needed and restores the prior
   enabled/disabled state afterward
 - seeds vault files before each test and restores the original files afterward
+  - `seedVault` accepts raw strings, `{ json }`, and `{ note }` descriptors
 - seeds `data.json` through the normal plugin snapshot/restore path
 - supports the same opt-in failure artifact capture as `createObsidianTest()`
 
@@ -321,8 +395,13 @@ task-id suffix, for example:
 `createObsidianTest()` captures:
 
 - `active-file.json`
+- `active-note.md`
+- `active-note-frontmatter.json`
+- `console-messages.json`
 - `dom.txt`
 - `editor.json`
+- `notices.json`
+- `runtime-errors.json`
 - `tabs.json`
 - `workspace.json`
 - `screenshot.png` when screenshot capture succeeds
@@ -338,6 +417,27 @@ part of the set: desktop permissions, display availability, or Obsidian state
 can prevent `screenshot.png` from being produced, in which case you should
 expect `screenshot.error.txt` instead.
 
+If you are not using the Vitest fixtures, the same artifact capture path is
+available directly from the main package:
+
+```ts
+import { captureFailureArtifacts, createObsidianClient } from "obsidian-e2e";
+
+const obsidian = createObsidianClient({ vault: "dev" });
+
+await captureFailureArtifacts(
+  {
+    id: "quickadd_case_1234abcd",
+    name: "captures quickadd diagnostics",
+  },
+  obsidian,
+  {
+    captureOnFailure: true,
+    plugin: obsidian.plugin("quickadd"),
+  },
+);
+```
+
 ## Maintainer CI And Releases
 
 This repo now ships with a hardened CI and release flow built around Vite+
@@ -374,7 +474,9 @@ Import `obsidian-e2e/matchers` once in your test setup to register:
 - `toHaveEditorTextContaining(needle)`
 - `toHaveFile(path)`
 - `toHaveFileContaining(path, needle)`
+- `toHaveFrontmatter(path, expected)`
 - `toHaveJsonFile(path)`
+- `toHaveNote(path, { frontmatter?, body?, bodyIncludes? })`
 - `toHaveOpenTab(title, viewType?)`
 - `toHavePluginData(expected)`
 - `toHaveWorkspaceNode(label)`
@@ -386,9 +488,23 @@ import { expect } from "vite-plus/test";
 import { test } from "./setup";
 
 test("writes valid JSON into the sandbox", async ({ sandbox }) => {
-  await sandbox.json("config.json").write({ enabled: true });
+  await sandbox.writeNote({
+    path: "Today.md",
+    frontmatter: {
+      mood: "focused",
+    },
+    body: "# Today\n",
+  });
 
-  await expect(sandbox).toHaveJsonFile("config.json");
+  await expect(sandbox).toHaveNote("Today.md", {
+    bodyIncludes: "Today",
+    frontmatter: {
+      mood: "focused",
+    },
+  });
+  await expect(sandbox).toHaveFrontmatter("Today.md", {
+    mood: "focused",
+  });
 });
 
 test("asserts active Obsidian state", async ({ obsidian, plugin }) => {
@@ -406,15 +522,27 @@ test("asserts active Obsidian state", async ({ obsidian, plugin }) => {
 If you need to work below the fixture layer:
 
 ```ts
-import { createObsidianClient } from "obsidian-e2e";
+import { createObsidianClient, createVaultApi, parseNoteDocument } from "obsidian-e2e";
 
 const obsidian = createObsidianClient({
   vault: "dev",
   bin: "obsidian",
+  defaultExecOptions: {
+    allowNonZeroExit: true,
+  },
 });
+const vault = createVaultApi({ obsidian });
 
 await obsidian.verify();
-await obsidian.exec("plugin:reload", { id: "my-plugin" });
+await vault.write("Inbox/Today.md", "# Today\n", { waitForContent: true });
+await expect(await obsidian.metadata.frontmatter("Inbox/Today.md")).toBeNull();
+await obsidian.plugin("my-plugin").reload({
+  waitUntilReady: true,
+  readyOptions: {
+    commandId: "my-plugin:refresh",
+  },
+});
+parseNoteDocument(await vault.read("Inbox/Today.md"));
 ```
 
 ## App And Commands
@@ -431,11 +559,24 @@ to the real `obsidian` CLI:
 - `obsidian.command(id).run()`
 - `obsidian.dev.dom({ ... })`
 - `obsidian.dev.eval(code)`
+- `obsidian.dev.evalRaw(code)`
+- `obsidian.dev.diagnostics()`
+- `obsidian.dev.resetDiagnostics()`
+- `obsidian.metadata.fileCache(path)`
+- `obsidian.metadata.frontmatter(path)`
+- `obsidian.metadata.waitForFileCache(path, predicate?)`
+- `obsidian.metadata.waitForFrontmatter(path, predicate?)`
+- `obsidian.metadata.waitForMetadata(path, predicate?)`
 - `obsidian.dev.screenshot(path)`
 - `obsidian.tabs()`
 - `obsidian.workspace()`
 - `obsidian.open({ file? | path?, newTab? })`
 - `obsidian.openTab({ file?, group?, view? })`
+- `obsidian.sleep(ms)`
+- `obsidian.waitForActiveFile(path)`
+- `obsidian.waitForConsoleMessage(predicate)`
+- `obsidian.waitForNotice(predicate)`
+- `obsidian.waitForRuntimeError(predicate)`
 
 Example:
 
@@ -463,6 +604,45 @@ test("reloads the app and runs a plugin command when it becomes available", asyn
 `obsidian.app.restart()` waits for the app to come back by default. Pass
 `{ waitUntilReady: false }` if you need to manage readiness explicitly.
 
+## Vault, Metadata, And Plugin Wait Helpers
+
+The higher-level vault and plugin handles now expose the most common polling
+patterns directly, so tests do not need to hand-roll `waitFor()` loops around
+content reads, command discovery, or plugin data migration:
+
+```ts
+test("waits for generated content and plugin state", async ({ obsidian, sandbox, vault }) => {
+  const plugin = obsidian.plugin("quickadd");
+
+  await vault.write("queue.md", "pending", {
+    waitForContent: true,
+  });
+
+  await vault.waitForContent("queue.md", (content) => content.includes("pending"));
+  await sandbox.writeNote({
+    path: "Inbox/Today.md",
+    frontmatter: {
+      tags: ["daily"],
+    },
+    body: "# Today\n",
+  });
+  await sandbox.waitForFrontmatter("Inbox/Today.md", (frontmatter) =>
+    frontmatter.tags.includes("daily"),
+  );
+
+  await plugin.updateDataAndReload<{ migrations: Record<string, boolean> }>((draft) => {
+    draft.migrations.quickadd_v2 = true;
+  });
+
+  await plugin.waitForData<{ migrations: Record<string, boolean> }>(
+    (data) => data.migrations.quickadd_v2 === true,
+  );
+});
+```
+
+If you just need time to pass without inventing a fake polling condition, use
+`await obsidian.sleep(ms)`.
+
 Workspace and tab readers return parsed structures, so you can inspect layout
 state without writing custom parsers in every test:
 
@@ -498,11 +678,44 @@ test("inspects live UI state", async ({ obsidian }) => {
 });
 ```
 
-`obsidian.dev.eval()` is the low-level escape hatch, while `dev.dom()` and
-`dev.screenshot()` give you safer wrappers around the built-in developer CLI
+`obsidian.dev.eval()` now uses a structured JSON envelope and throws remote
+stack information when the evaluated code fails. Use `obsidian.dev.evalRaw()`
+only when you intentionally need the unstructured CLI output. `dev.dom()` and
+`dev.screenshot()` remain the safer wrappers around the built-in developer CLI
 commands. Screenshot behavior depends on the active desktop environment, so
 start by validating it locally before relying on it in automation.
 
+## Layer Boundaries
+
+- `vault` stays filesystem-only. If the behavior depends on Obsidian parsing or
+  workspace state, it does not belong there.
+- `sandbox.readNote()` parses file content only. It does not imply that
+  Obsidian has indexed the note.
+- `sandbox.frontmatter()` and `obsidian.metadata.*` read metadata-cache state,
+  which is the right layer for frontmatter synchronization and race-sensitive
+  tests.
+- `obsidian.dev.eval()` is structured but still low-level. Prefer the
+  higher-level metadata, sandbox, wait, plugin, and matcher helpers first.
+
+## Migration Notes
+
+- If you relied on raw `obsidian.dev.eval()` output strings, switch those calls
+  to `obsidian.dev.evalRaw()`. The structured `eval()` path now expects JSON-safe
+  values and throws `DevEvalError` with the remote stack.
+- Prefer `sandbox.writeNote()` over hand-built YAML strings when the test is
+  describing note content rather than string formatting.
+- Prefer `plugin.updateDataAndReload()` or `plugin.withPatchedData()` over open-
+  coded patch/reload/restore sequences.
+
+## Regression Matrix
+
+- Metadata waits cover delayed file-cache population and frontmatter
+  synchronization after note writes.
+- Failure artifacts capture active note content, parsed frontmatter, recent
+  console/notices/runtime errors, and workspace snapshots.
+- Lifecycle cleanup restores tracked plugin data before disabling plugins and
+  removes sandbox content after teardown.
+
 ## End-To-End Workflow
 
 Putting it together, a realistic plugin test usually looks like this:

package/dist/document-DunL2Moz.mjs

@@ -0,0 +1,69 @@
+import { parse, stringify } from "yaml";
+//#region src/note/document.ts
+function parseNoteDocument(raw) {
+	const normalizedRaw = normalizeLineEndings(raw);
+	const parsed = parseFrontmatterBlock(normalizedRaw);
+	if (!parsed) return {
+		body: normalizedRaw,
+		frontmatter: null,
+		raw: normalizedRaw
+	};
+	const parsedFrontmatter = parse(parsed.frontmatterRaw);
+	if (parsedFrontmatter !== null && (typeof parsedFrontmatter !== "object" || Array.isArray(parsedFrontmatter))) throw new Error("Expected note frontmatter to be a YAML mapping object.");
+	return {
+		body: normalizeLineEndings(parsed.body),
+		frontmatter: parsedFrontmatter ?? {},
+		raw: normalizedRaw
+	};
+}
+function stringifyNoteDocument(input) {
+	const normalizedBody = normalizeLineEndings(input.body ?? "");
+	if (!input.frontmatter) return normalizedBody;
+	const frontmatterYaml = stringify(input.frontmatter).trimEnd();
+	return `${frontmatterYaml ? `---\n${frontmatterYaml}\n---\n` : "---\n---\n"}${normalizedBody}`;
+}
+function createNoteDocument(input) {
+	const body = normalizeLineEndings(input.body ?? "");
+	if (input.frontmatter === void 0 || input.frontmatter === null) return {
+		body,
+		frontmatter: null,
+		raw: stringifyNoteDocument({ body })
+	};
+	const frontmatter = cloneFrontmatter(input.frontmatter);
+	return {
+		body,
+		frontmatter,
+		raw: stringifyNoteDocument({
+			body,
+			frontmatter
+		})
+	};
+}
+function normalizeLineEndings(value) {
+	return value.replace(/\r\n?/gu, "\n");
+}
+function cloneFrontmatter(frontmatter) {
+	return JSON.parse(JSON.stringify(frontmatter));
+}
+function parseFrontmatterBlock(raw) {
+	if (!raw.startsWith("---")) return null;
+	const openingMatch = raw.match(/^---(?:\n|$)/u);
+	if (!openingMatch) return null;
+	const openLength = openingMatch[0].length;
+	const closingMatcher = /(?:^|\n)(?:---|\.\.\.)(?:\n|$)/gu;
+	closingMatcher.lastIndex = openLength;
+	const closingMatch = closingMatcher.exec(raw);
+	if (!closingMatch) return null;
+	const closingStart = closingMatch.index + (closingMatch[0].startsWith("\n") ? 1 : 0);
+	const closingLength = closingMatch[0].startsWith("\n") ? closingMatch[0].length - 1 : closingMatch[0].length;
+	const frontmatterRaw = raw.slice(openLength, closingStart);
+	const bodyStart = closingStart + closingLength;
+	return {
+		body: raw.slice(bodyStart),
+		frontmatterRaw: frontmatterRaw.trimEnd()
+	};
+}
+//#endregion
+export { parseNoteDocument as n, stringifyNoteDocument as r, createNoteDocument as t };
+
+//# sourceMappingURL=document-DunL2Moz.mjs.map

package/dist/document-DunL2Moz.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-DunL2Moz.mjs","names":["parseYaml","stringifyYaml"],"sources":["../src/note/document.ts"],"sourcesContent":["import { parse as parseYaml, stringify as stringifyYaml } from \"yaml\";\n\nimport type { NoteDocument, NoteFrontmatter, NoteInput } from \"../core/types\";\n\nexport function parseNoteDocument(raw: string): NoteDocument {\n  const normalizedRaw = normalizeLineEndings(raw);\n  const parsed = parseFrontmatterBlock(normalizedRaw);\n\n  if (!parsed) {\n    return {\n      body: normalizedRaw,\n      frontmatter: null,\n      raw: normalizedRaw,\n    };\n  }\n\n  const parsedFrontmatter = parseYaml(parsed.frontmatterRaw);\n\n  if (\n    parsedFrontmatter !== null &&\n    (typeof parsedFrontmatter !== \"object\" || Array.isArray(parsedFrontmatter))\n  ) {\n    throw new Error(\"Expected note frontmatter to be a YAML mapping object.\");\n  }\n\n  return {\n    body: normalizeLineEndings(parsed.body),\n    frontmatter: (parsedFrontmatter ?? {}) as NoteFrontmatter,\n    raw: normalizedRaw,\n  };\n}\n\nexport function stringifyNoteDocument(input: NoteInput): string {\n  const normalizedBody = normalizeLineEndings(input.body ?? \"\");\n\n  if (!input.frontmatter) {\n    return normalizedBody;\n  }\n\n  const frontmatterYaml = stringifyYaml(input.frontmatter).trimEnd();\n  const frontmatterSection = frontmatterYaml ? `---\\n${frontmatterYaml}\\n---\\n` : \"---\\n---\\n\";\n\n  return `${frontmatterSection}${normalizedBody}`;\n}\n\nexport function createNoteDocument(input: NoteInput): NoteDocument {\n  const body = normalizeLineEndings(input.body ?? \"\");\n\n  if (input.frontmatter === undefined || input.frontmatter === null) {\n    return {\n      body,\n      frontmatter: null,\n      raw: stringifyNoteDocument({ body }),\n    };\n  }\n\n  const frontmatter = cloneFrontmatter(input.frontmatter);\n\n  return {\n    body,\n    frontmatter,\n    raw: stringifyNoteDocument({\n      body,\n      frontmatter,\n    }),\n  };\n}\n\ninterface ParsedFrontmatterBlock {\n  body: string;\n  frontmatterRaw: string;\n}\n\nfunction normalizeLineEndings(value: string): string {\n  return value.replace(/\\r\\n?/gu, \"\\n\");\n}\n\nfunction cloneFrontmatter<TFrontmatter extends NoteFrontmatter>(\n  frontmatter: TFrontmatter,\n): TFrontmatter {\n  return JSON.parse(JSON.stringify(frontmatter)) as TFrontmatter;\n}\n\nfunction parseFrontmatterBlock(raw: string): ParsedFrontmatterBlock | null {\n  if (!raw.startsWith(\"---\")) {\n    return null;\n  }\n\n  const openingMatch = raw.match(/^---(?:\\n|$)/u);\n\n  if (!openingMatch) {\n    return null;\n  }\n\n  const openLength = openingMatch[0].length;\n  const closingMatcher = /(?:^|\\n)(?:---|\\.\\.\\.)(?:\\n|$)/gu;\n  closingMatcher.lastIndex = openLength;\n  const closingMatch = closingMatcher.exec(raw);\n\n  if (!closingMatch) {\n    return null;\n  }\n\n  const closingStart = closingMatch.index + (closingMatch[0].startsWith(\"\\n\") ? 1 : 0);\n  const closingLength = closingMatch[0].startsWith(\"\\n\")\n    ? closingMatch[0].length - 1\n    : closingMatch[0].length;\n  const frontmatterRaw = raw.slice(openLength, closingStart);\n  const bodyStart = closingStart + closingLength;\n\n  return {\n    body: raw.slice(bodyStart),\n    frontmatterRaw: frontmatterRaw.trimEnd(),\n  };\n}\n"],"mappings":";;AAIA,SAAgB,kBAAkB,KAA2B;CAC3D,MAAM,gBAAgB,qBAAqB,IAAI;CAC/C,MAAM,SAAS,sBAAsB,cAAc;AAEnD,KAAI,CAAC,OACH,QAAO;EACL,MAAM;EACN,aAAa;EACb,KAAK;EACN;CAGH,MAAM,oBAAoBA,MAAU,OAAO,eAAe;AAE1D,KACE,sBAAsB,SACrB,OAAO,sBAAsB,YAAY,MAAM,QAAQ,kBAAkB,EAE1E,OAAM,IAAI,MAAM,yDAAyD;AAG3E,QAAO;EACL,MAAM,qBAAqB,OAAO,KAAK;EACvC,aAAc,qBAAqB,EAAE;EACrC,KAAK;EACN;;AAGH,SAAgB,sBAAsB,OAA0B;CAC9D,MAAM,iBAAiB,qBAAqB,MAAM,QAAQ,GAAG;AAE7D,KAAI,CAAC,MAAM,YACT,QAAO;CAGT,MAAM,kBAAkBC,UAAc,MAAM,YAAY,CAAC,SAAS;AAGlE,QAAO,GAFoB,kBAAkB,QAAQ,gBAAgB,WAAW,eAEjD;;AAGjC,SAAgB,mBAAmB,OAAgC;CACjE,MAAM,OAAO,qBAAqB,MAAM,QAAQ,GAAG;AAEnD,KAAI,MAAM,gBAAgB,KAAA,KAAa,MAAM,gBAAgB,KAC3D,QAAO;EACL;EACA,aAAa;EACb,KAAK,sBAAsB,EAAE,MAAM,CAAC;EACrC;CAGH,MAAM,cAAc,iBAAiB,MAAM,YAAY;AAEvD,QAAO;EACL;EACA;EACA,KAAK,sBAAsB;GACzB;GACA;GACD,CAAC;EACH;;AAQH,SAAS,qBAAqB,OAAuB;AACnD,QAAO,MAAM,QAAQ,WAAW,KAAK;;AAGvC,SAAS,iBACP,aACc;AACd,QAAO,KAAK,MAAM,KAAK,UAAU,YAAY,CAAC;;AAGhD,SAAS,sBAAsB,KAA4C;AACzE,KAAI,CAAC,IAAI,WAAW,MAAM,CACxB,QAAO;CAGT,MAAM,eAAe,IAAI,MAAM,gBAAgB;AAE/C,KAAI,CAAC,aACH,QAAO;CAGT,MAAM,aAAa,aAAa,GAAG;CACnC,MAAM,iBAAiB;AACvB,gBAAe,YAAY;CAC3B,MAAM,eAAe,eAAe,KAAK,IAAI;AAE7C,KAAI,CAAC,aACH,QAAO;CAGT,MAAM,eAAe,aAAa,SAAS,aAAa,GAAG,WAAW,KAAK,GAAG,IAAI;CAClF,MAAM,gBAAgB,aAAa,GAAG,WAAW,KAAK,GAClD,aAAa,GAAG,SAAS,IACzB,aAAa,GAAG;CACpB,MAAM,iBAAiB,IAAI,MAAM,YAAY,aAAa;CAC1D,MAAM,YAAY,eAAe;AAEjC,QAAO;EACL,MAAM,IAAI,MAAM,UAAU;EAC1B,gBAAgB,eAAe,SAAS;EACzC"}

package/dist/index.d.mts

@@ -1,8 +1,22 @@
-import { A as ObsidianCommandHandle, B as WorkspaceNode, C as ExecOptions, D as ObsidianAppHandle, E as JsonFileUpdater, F as RestartAppOptions, H as WorkspaceTab, I as SandboxApi, L as TabsOptions, M as OpenFileOptions, N as OpenTabOptions, O as ObsidianArg, P as PluginHandle, R as VaultApi, S as DevDomResult, T as JsonFile, V as WorkspaceOptions, a as acquireVaultRunLock, b as CreateObsidianClientOptions, c as readVaultRunLockMarker, i as VaultRunLockState, j as ObsidianDevHandle, k as ObsidianClient, n as VaultRunLock, o as clearVaultRunLockMarker, r as VaultRunLockMetadata, s as inspectVaultRunLock, t as AcquireVaultRunLockOptions, v as CommandListOptions, w as ExecResult, x as DevDomQueryOptions, y as CommandTransport, z as WaitForOptions } from "./vault-lock-DarzOEzv.mjs";
+import { A as PluginHandle, B as VaultApi, C as ObsidianClient, D as OpenFileOptions, E as ObsidianMetadataHandle, F as PluginWaitUntilReadyOptions, G as WorkspaceNode, H as VaultWaitForContentOptions, I as PluginWithPatchedDataOptions, K as WorkspaceOptions, L as RestartAppOptions, N as PluginUpdateDataOptions, O as OpenTabOptions, P as PluginWaitForDataOptions, R as SandboxApi, S as ObsidianArg, T as ObsidianDevHandle, U as VaultWriteOptions, V as VaultContentPredicate, W as WaitForOptions, _ as NoteDocument, a as DevDiagnostics, b as NoteMatcherOptions, c as DevNoticeEvent, d as ExecResult, f as JsonFile, g as MetadataWaitOptions, h as MetadataPredicate, i as DevConsoleMessage, j as PluginReloadOptions, k as PluginDataPredicate, l as DevRuntimeError, m as MetadataFileCache, n as CommandTransport, o as DevDomQueryOptions, p as JsonFileUpdater, q as WorkspaceTab, r as CreateObsidianClientOptions, s as DevDomResult, t as CommandListOptions, u as ExecOptions, v as NoteFrontmatter, w as ObsidianCommandHandle, x as ObsidianAppHandle, y as NoteInput, z as TabsOptions } from "./types-C4cj443K.mjs";
+import { C as FailureArtifactConfig, D as captureFailureArtifacts, E as FailureArtifactTask, S as DEFAULT_FAILURE_ARTIFACTS_DIR, T as FailureArtifactRegistrationOptions, _ as TestContext, a as acquireVaultRunLock, b as VaultSeedEntry, c as readVaultRunLockMarker, d as ObsidianFixtures, f as ObsidianTest, g as SharedVaultLockOptions, h as PluginTest, i as VaultRunLockState, l as CreateObsidianTestOptions, m as PluginSessionOptions, n as VaultRunLock, o as clearVaultRunLockMarker, p as PluginFixtures, r as VaultRunLockMetadata, s as inspectVaultRunLock, t as AcquireVaultRunLockOptions, u as CreatePluginTestOptions, v as TestContextCleanupOptions, w as FailureArtifactOptions, x as CaptureFailureArtifactsOptions, y as VaultSeed } from "./vault-lock-CYyOdRP1.mjs";
 
 //#region src/core/client.d.ts
 declare function createObsidianClient(options: CreateObsidianClientOptions): ObsidianClient;
 //#endregion
+//#region src/fixtures/test-context.d.ts
+declare function createTestContext(options: CreateObsidianTestOptions & {
+  testName?: string;
+}): Promise<TestContext>;
+declare function withVaultSandbox<TResult>(options: CreateObsidianTestOptions & {
+  testName?: string;
+}, run: (context: TestContext) => Promise<TResult> | TResult): Promise<TResult>;
+//#endregion
+//#region src/note/document.d.ts
+declare function parseNoteDocument(raw: string): NoteDocument;
+declare function stringifyNoteDocument(input: NoteInput): string;
+declare function createNoteDocument(input: NoteInput): NoteDocument;
+//#endregion
 //#region src/vault/sandbox.d.ts
 interface CreateSandboxApiOptions {
   obsidian: ObsidianClient;
@@ -18,5 +32,5 @@ interface CreateVaultApiOptions {
 }
 declare function createVaultApi(options: CreateVaultApiOptions): VaultApi;
 //#endregion
-export { type AcquireVaultRunLockOptions, type CommandListOptions, type CommandTransport, type CreateObsidianClientOptions, type DevDomQueryOptions, type DevDomResult, type ExecOptions, type ExecResult, type JsonFile, type JsonFileUpdater, type ObsidianAppHandle, type ObsidianArg, type ObsidianClient, type ObsidianCommandHandle, type ObsidianDevHandle, type OpenFileOptions, type OpenTabOptions, type PluginHandle, type RestartAppOptions, type SandboxApi, type TabsOptions, type VaultApi, type VaultRunLock, type VaultRunLockMetadata, type VaultRunLockState, type WaitForOptions, type WorkspaceNode, type WorkspaceOptions, type WorkspaceTab, acquireVaultRunLock, clearVaultRunLockMarker, createObsidianClient, createSandboxApi, createVaultApi, inspectVaultRunLock, readVaultRunLockMarker };
+export { type AcquireVaultRunLockOptions, type CaptureFailureArtifactsOptions, type CommandListOptions, type CommandTransport, type CreateObsidianClientOptions, type CreateObsidianTestOptions, type CreatePluginTestOptions, DEFAULT_FAILURE_ARTIFACTS_DIR, type DevConsoleMessage, type DevDiagnostics, type DevDomQueryOptions, type DevDomResult, type DevNoticeEvent, type DevRuntimeError, type ExecOptions, type ExecResult, type FailureArtifactConfig, type FailureArtifactOptions, type FailureArtifactRegistrationOptions, type FailureArtifactTask, type JsonFile, type JsonFileUpdater, type MetadataFileCache, type MetadataPredicate, type MetadataWaitOptions, type NoteDocument, type NoteFrontmatter, type NoteInput, type NoteMatcherOptions, type ObsidianAppHandle, type ObsidianArg, type ObsidianClient, type ObsidianCommandHandle, type ObsidianDevHandle, type ObsidianFixtures, type ObsidianMetadataHandle, type ObsidianTest, type OpenFileOptions, type OpenTabOptions, type PluginDataPredicate, type PluginFixtures, type PluginHandle, type PluginReloadOptions, type PluginSessionOptions, type PluginTest, type PluginUpdateDataOptions, type PluginWaitForDataOptions, type PluginWaitUntilReadyOptions, type PluginWithPatchedDataOptions, type RestartAppOptions, type SandboxApi, type SharedVaultLockOptions, type TabsOptions, type TestContext, type TestContextCleanupOptions, type VaultApi, type VaultContentPredicate, type VaultRunLock, type VaultRunLockMetadata, type VaultRunLockState, type VaultSeed, type VaultSeedEntry, type VaultWaitForContentOptions, type VaultWriteOptions, type WaitForOptions, type WorkspaceNode, type WorkspaceOptions, type WorkspaceTab, acquireVaultRunLock, captureFailureArtifacts, clearVaultRunLockMarker, createNoteDocument, createObsidianClient, createSandboxApi, createTestContext, createVaultApi, inspectVaultRunLock, parseNoteDocument, readVaultRunLockMarker, stringifyNoteDocument, withVaultSandbox };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,2 +1,3 @@
-import { a as inspectVaultRunLock, i as clearVaultRunLockMarker, n as createVaultApi, o as readVaultRunLockMarker, r as acquireVaultRunLock, s as createObsidianClient, t as createSandboxApi } from "./sandbox-Cz3rj_Rn.mjs";
-export { acquireVaultRunLock, clearVaultRunLockMarker, createObsidianClient, createSandboxApi, createVaultApi, inspectVaultRunLock, readVaultRunLockMarker };
+import { a as clearVaultRunLockMarker, c as createSandboxApi, d as createVaultApi, i as acquireVaultRunLock, l as DEFAULT_FAILURE_ARTIFACTS_DIR, n as withVaultSandbox, o as inspectVaultRunLock, p as createObsidianClient, s as readVaultRunLockMarker, t as createTestContext, u as captureFailureArtifacts } from "./test-context-BprSx6U1.mjs";
+import { n as parseNoteDocument, r as stringifyNoteDocument, t as createNoteDocument } from "./document-DunL2Moz.mjs";
+export { DEFAULT_FAILURE_ARTIFACTS_DIR, acquireVaultRunLock, captureFailureArtifacts, clearVaultRunLockMarker, createNoteDocument, createObsidianClient, createSandboxApi, createTestContext, createVaultApi, inspectVaultRunLock, parseNoteDocument, readVaultRunLockMarker, stringifyNoteDocument, withVaultSandbox };

package/dist/matchers.d.mts

@@ -1,3 +1,5 @@
+import { b as NoteMatcherOptions, v as NoteFrontmatter } from "./types-C4cj443K.mjs";
+
 //#region src/matchers.d.ts
 declare module "vite-plus/test" {
   interface Assertion<T = any> {
@@ -6,7 +8,9 @@ declare module "vite-plus/test" {
     toHaveEditorTextContaining(needle: string): Promise<T>;
     toHaveFile(path: string): Promise<T>;
     toHaveFileContaining(path: string, needle: string): Promise<T>;
+    toHaveFrontmatter(path: string, expected: NoteFrontmatter): Promise<T>;
     toHaveJsonFile(path: string): Promise<T>;
+    toHaveNote(path: string, expected: NoteMatcherOptions): Promise<T>;
     toHaveOpenTab(title: string, viewType?: string): Promise<T>;
     toHavePluginData(expected: unknown): Promise<T>;
     toHaveWorkspaceNode(label: string): Promise<T>;
@@ -17,7 +21,9 @@ declare module "vite-plus/test" {
     toHaveEditorTextContaining(needle: string): void;
     toHaveFile(path: string): void;
     toHaveFileContaining(path: string, needle: string): void;
+    toHaveFrontmatter(path: string, expected: NoteFrontmatter): void;
     toHaveJsonFile(path: string): void;
+    toHaveNote(path: string, expected: NoteMatcherOptions): void;
     toHaveOpenTab(title: string, viewType?: string): void;
     toHavePluginData(expected: unknown): void;
     toHaveWorkspaceNode(label: string): void;

package/dist/matchers.mjs

@@ -1,9 +1,10 @@
+import { n as parseNoteDocument } from "./document-DunL2Moz.mjs";
 import { expect } from "vite-plus/test";
 import { isDeepStrictEqual } from "node:util";
 //#region src/matchers.ts
 expect.extend({
 	async toHaveActiveFile(target, targetPath) {
-		const actual = await target.dev.eval("app.workspace.getActiveFile()?.path ?? null");
+		const actual = await target.dev.activeFilePath();
 		const pass = actual === targetPath;
 		return {
 			message: () => pass ? `Expected active file not to be "${targetPath}"` : `Expected active file to be "${targetPath}", received ${JSON.stringify(actual)}`,
@@ -35,6 +36,14 @@ expect.extend({
 			pass
 		};
 	},
+	async toHaveFrontmatter(target, targetPath, expected) {
+		const actual = await target.frontmatter(targetPath);
+		const pass = isDeepStrictEqual(actual, expected);
+		return {
+			message: () => pass ? `Expected frontmatter for "${targetPath}" not to equal ${JSON.stringify(expected)}` : `Expected frontmatter for "${targetPath}" to equal ${JSON.stringify(expected)}, received ${JSON.stringify(actual)}`,
+			pass
+		};
+	},
 	async toHaveJsonFile(target, targetPath) {
 		if (!await target.exists(targetPath)) return {
 			message: () => `Expected JSON file to exist: ${targetPath}`,
@@ -53,6 +62,25 @@ expect.extend({
 			};
 		}
 	},
+	async toHaveNote(target, targetPath, expected) {
+		let actual;
+		try {
+			actual = parseNoteDocument(await target.read(targetPath));
+		} catch (error) {
+			return {
+				message: () => `Expected vault path "${targetPath}" to be readable as a note, but reading failed: ${error instanceof Error ? error.message : String(error)}`,
+				pass: false
+			};
+		}
+		const matchesFrontmatter = expected.frontmatter === void 0 || isDeepStrictEqual(actual.frontmatter, expected.frontmatter);
+		const matchesBody = expected.body === void 0 || actual.body === expected.body;
+		const matchesBodyIncludes = expected.bodyIncludes === void 0 || actual.body.includes(expected.bodyIncludes);
+		const pass = matchesFrontmatter && matchesBody && matchesBodyIncludes;
+		return {
+			message: () => pass ? `Expected vault path "${targetPath}" not to match the expected note shape` : `Expected vault path "${targetPath}" to match the expected note shape, received ${JSON.stringify(actual)}`,
+			pass
+		};
+	},
 	async toHaveOpenTab(target, title, viewType) {
 		const pass = (await target.tabs()).some((tab) => tab.title === title && (viewType === void 0 || tab.viewType === viewType));
 		return {
@@ -69,7 +97,7 @@ expect.extend({
 		};
 	},
 	async toHaveEditorTextContaining(target, needle) {
-		const actual = await target.dev.eval("app.workspace.activeLeaf?.view?.editor?.getValue?.() ?? null");
+		const actual = await target.dev.editorText();
 		const pass = typeof actual === "string" && actual.includes(needle);
 		return {
 			message: () => pass ? `Expected editor text not to contain "${needle}"` : `Expected editor text to contain "${needle}", received ${JSON.stringify(actual)}`,

package/dist/matchers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"matchers.mjs","names":[],"sources":["../src/matchers.ts"],"sourcesContent":["import { isDeepStrictEqual } from \"node:util\";\n\nimport { expect } from \"vite-plus/test\";\n\nimport type { ObsidianClient, PluginHandle, SandboxApi, VaultApi } from \"./core/types\";\n\ntype FileMatcherTarget = SandboxApi | VaultApi;\n\nexpect.extend({\n  async toHaveActiveFile(target: ObsidianClient, targetPath: string) {\n    const actual = await target.dev.eval<string | null>(\n      \"app.workspace.getActiveFile()?.path ?? null\",\n    );\n    const pass = actual === targetPath;\n\n    return {\n      message: () =>\n        pass\n          ? `Expected active file not to be \"${targetPath}\"`\n          : `Expected active file to be \"${targetPath}\", received ${JSON.stringify(actual)}`,\n      pass,\n    };\n  },\n  async toHaveCommand(target: ObsidianClient, commandId: string) {\n    const pass = await target.command(commandId).exists();\n\n    return {\n      message: () =>\n        pass\n          ? `Expected Obsidian command not to exist: ${commandId}`\n          : `Expected Obsidian command to exist: ${commandId}`,\n      pass,\n    };\n  },\n  async toHaveFile(target: FileMatcherTarget, targetPath: string) {\n    const pass = await target.exists(targetPath);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected vault path not to exist: ${targetPath}`\n          : `Expected vault path to exist: ${targetPath}`,\n      pass,\n    };\n  },\n  async toHaveFileContaining(target: FileMatcherTarget, targetPath: string, needle: string) {\n    const exists = await target.exists(targetPath);\n\n    if (!exists) {\n      return {\n        message: () => `Expected vault path to exist: ${targetPath}`,\n        pass: false,\n      };\n    }\n\n    const content = await target.read(targetPath);\n    const pass = content.includes(needle);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected vault path \"${targetPath}\" not to contain \"${needle}\"`\n          : `Expected vault path \"${targetPath}\" to contain \"${needle}\"`,\n      pass,\n    };\n  },\n  async toHaveJsonFile(target: FileMatcherTarget, targetPath: string) {\n    const exists = await target.exists(targetPath);\n\n    if (!exists) {\n      return {\n        message: () => `Expected JSON file to exist: ${targetPath}`,\n        pass: false,\n      };\n    }\n\n    try {\n      await target.json(targetPath).read();\n      return {\n        message: () => `Expected JSON file \"${targetPath}\" not to be valid JSON`,\n        pass: true,\n      };\n    } catch (error) {\n      return {\n        message: () =>\n          `Expected JSON file \"${targetPath}\" to be valid JSON, but parsing failed: ${\n            error instanceof Error ? error.message : String(error)\n          }`,\n        pass: false,\n      };\n    }\n  },\n  async toHaveOpenTab(target: ObsidianClient, title: string, viewType?: string) {\n    const tabs = await target.tabs();\n    const pass = tabs.some(\n      (tab) => tab.title === title && (viewType === undefined || tab.viewType === viewType),\n    );\n\n    return {\n      message: () =>\n        pass\n          ? `Expected no open tab matching \"${title}\"${\n              viewType ? ` with view type \"${viewType}\"` : \"\"\n            }`\n          : `Expected an open tab matching \"${title}\"${\n              viewType ? ` with view type \"${viewType}\"` : \"\"\n            }`,\n      pass,\n    };\n  },\n  async toHavePluginData(target: PluginHandle, expected: unknown) {\n    const actual = await target.data().read();\n    const pass = isDeepStrictEqual(actual, expected);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected plugin data not to equal ${JSON.stringify(expected)}`\n          : `Expected plugin data to equal ${JSON.stringify(expected)}, received ${JSON.stringify(\n              actual,\n            )}`,\n      pass,\n    };\n  },\n  async toHaveEditorTextContaining(target: ObsidianClient, needle: string) {\n    const actual = await target.dev.eval<string | null>(\n      \"app.workspace.activeLeaf?.view?.editor?.getValue?.() ?? null\",\n    );\n    const pass = typeof actual === \"string\" && actual.includes(needle);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected editor text not to contain \"${needle}\"`\n          : `Expected editor text to contain \"${needle}\", received ${JSON.stringify(actual)}`,\n      pass,\n    };\n  },\n  async toHaveWorkspaceNode(target: ObsidianClient, label: string) {\n    const pass = hasWorkspaceNode(await target.workspace(), label);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected workspace not to contain node \"${label}\"`\n          : `Expected workspace to contain node \"${label}\"`,\n      pass,\n    };\n  },\n});\n\ndeclare module \"vite-plus/test\" {\n  interface Assertion<T = any> {\n    toHaveActiveFile(path: string): Promise<T>;\n    toHaveCommand(commandId: string): Promise<T>;\n    toHaveEditorTextContaining(needle: string): Promise<T>;\n    toHaveFile(path: string): Promise<T>;\n    toHaveFileContaining(path: string, needle: string): Promise<T>;\n    toHaveJsonFile(path: string): Promise<T>;\n    toHaveOpenTab(title: string, viewType?: string): Promise<T>;\n    toHavePluginData(expected: unknown): Promise<T>;\n    toHaveWorkspaceNode(label: string): Promise<T>;\n  }\n\n  interface AsymmetricMatchersContaining {\n    toHaveActiveFile(path: string): void;\n    toHaveCommand(commandId: string): void;\n    toHaveEditorTextContaining(needle: string): void;\n    toHaveFile(path: string): void;\n    toHaveFileContaining(path: string, needle: string): void;\n    toHaveJsonFile(path: string): void;\n    toHaveOpenTab(title: string, viewType?: string): void;\n    toHavePluginData(expected: unknown): void;\n    toHaveWorkspaceNode(label: string): void;\n  }\n}\n\nexport {};\n\nfunction hasWorkspaceNode(\n  nodes: Awaited<ReturnType<ObsidianClient[\"workspace\"]>>,\n  label: string,\n): boolean {\n  for (const node of nodes) {\n    if (node.label === label || hasWorkspaceNode(node.children, label)) {\n      return true;\n    }\n  }\n\n  return false;\n}\n"],"mappings":";;;AAQA,OAAO,OAAO;CACZ,MAAM,iBAAiB,QAAwB,YAAoB;EACjE,MAAM,SAAS,MAAM,OAAO,IAAI,KAC9B,8CACD;EACD,MAAM,OAAO,WAAW;AAExB,SAAO;GACL,eACE,OACI,mCAAmC,WAAW,KAC9C,+BAA+B,WAAW,cAAc,KAAK,UAAU,OAAO;GACpF;GACD;;CAEH,MAAM,cAAc,QAAwB,WAAmB;EAC7D,MAAM,OAAO,MAAM,OAAO,QAAQ,UAAU,CAAC,QAAQ;AAErD,SAAO;GACL,eACE,OACI,2CAA2C,cAC3C,uCAAuC;GAC7C;GACD;;CAEH,MAAM,WAAW,QAA2B,YAAoB;EAC9D,MAAM,OAAO,MAAM,OAAO,OAAO,WAAW;AAE5C,SAAO;GACL,eACE,OACI,qCAAqC,eACrC,iCAAiC;GACvC;GACD;;CAEH,MAAM,qBAAqB,QAA2B,YAAoB,QAAgB;AAGxF,MAAI,CAFW,MAAM,OAAO,OAAO,WAAW,CAG5C,QAAO;GACL,eAAe,iCAAiC;GAChD,MAAM;GACP;EAIH,MAAM,QADU,MAAM,OAAO,KAAK,WAAW,EACxB,SAAS,OAAO;AAErC,SAAO;GACL,eACE,OACI,wBAAwB,WAAW,oBAAoB,OAAO,KAC9D,wBAAwB,WAAW,gBAAgB,OAAO;GAChE;GACD;;CAEH,MAAM,eAAe,QAA2B,YAAoB;AAGlE,MAAI,CAFW,MAAM,OAAO,OAAO,WAAW,CAG5C,QAAO;GACL,eAAe,gCAAgC;GAC/C,MAAM;GACP;AAGH,MAAI;AACF,SAAM,OAAO,KAAK,WAAW,CAAC,MAAM;AACpC,UAAO;IACL,eAAe,uBAAuB,WAAW;IACjD,MAAM;IACP;WACM,OAAO;AACd,UAAO;IACL,eACE,uBAAuB,WAAW,0CAChC,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM;IAE1D,MAAM;IACP;;;CAGL,MAAM,cAAc,QAAwB,OAAe,UAAmB;EAE5E,MAAM,QADO,MAAM,OAAO,MAAM,EACd,MACf,QAAQ,IAAI,UAAU,UAAU,aAAa,KAAA,KAAa,IAAI,aAAa,UAC7E;AAED,SAAO;GACL,eACE,OACI,kCAAkC,MAAM,GACtC,WAAW,oBAAoB,SAAS,KAAK,OAE/C,kCAAkC,MAAM,GACtC,WAAW,oBAAoB,SAAS,KAAK;GAErD;GACD;;CAEH,MAAM,iBAAiB,QAAsB,UAAmB;EAC9D,MAAM,SAAS,MAAM,OAAO,MAAM,CAAC,MAAM;EACzC,MAAM,OAAO,kBAAkB,QAAQ,SAAS;AAEhD,SAAO;GACL,eACE,OACI,qCAAqC,KAAK,UAAU,SAAS,KAC7D,iCAAiC,KAAK,UAAU,SAAS,CAAC,aAAa,KAAK,UAC1E,OACD;GACP;GACD;;CAEH,MAAM,2BAA2B,QAAwB,QAAgB;EACvE,MAAM,SAAS,MAAM,OAAO,IAAI,KAC9B,+DACD;EACD,MAAM,OAAO,OAAO,WAAW,YAAY,OAAO,SAAS,OAAO;AAElE,SAAO;GACL,eACE,OACI,wCAAwC,OAAO,KAC/C,oCAAoC,OAAO,cAAc,KAAK,UAAU,OAAO;GACrF;GACD;;CAEH,MAAM,oBAAoB,QAAwB,OAAe;EAC/D,MAAM,OAAO,iBAAiB,MAAM,OAAO,WAAW,EAAE,MAAM;AAE9D,SAAO;GACL,eACE,OACI,2CAA2C,MAAM,KACjD,uCAAuC,MAAM;GACnD;GACD;;CAEJ,CAAC;AA8BF,SAAS,iBACP,OACA,OACS;AACT,MAAK,MAAM,QAAQ,MACjB,KAAI,KAAK,UAAU,SAAS,iBAAiB,KAAK,UAAU,MAAM,CAChE,QAAO;AAIX,QAAO"}
+{"version":3,"file":"matchers.mjs","names":[],"sources":["../src/matchers.ts"],"sourcesContent":["import { isDeepStrictEqual } from \"node:util\";\n\nimport { expect } from \"vite-plus/test\";\n\nimport { parseNoteDocument } from \"./note/document\";\nimport type {\n  NoteMatcherOptions,\n  NoteFrontmatter,\n  ObsidianClient,\n  PluginHandle,\n  SandboxApi,\n  VaultApi,\n} from \"./core/types\";\n\ntype FileMatcherTarget = SandboxApi | VaultApi;\n\nexpect.extend({\n  async toHaveActiveFile(target: ObsidianClient, targetPath: string) {\n    const actual = await target.dev.activeFilePath();\n    const pass = actual === targetPath;\n\n    return {\n      message: () =>\n        pass\n          ? `Expected active file not to be \"${targetPath}\"`\n          : `Expected active file to be \"${targetPath}\", received ${JSON.stringify(actual)}`,\n      pass,\n    };\n  },\n  async toHaveCommand(target: ObsidianClient, commandId: string) {\n    const pass = await target.command(commandId).exists();\n\n    return {\n      message: () =>\n        pass\n          ? `Expected Obsidian command not to exist: ${commandId}`\n          : `Expected Obsidian command to exist: ${commandId}`,\n      pass,\n    };\n  },\n  async toHaveFile(target: FileMatcherTarget, targetPath: string) {\n    const pass = await target.exists(targetPath);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected vault path not to exist: ${targetPath}`\n          : `Expected vault path to exist: ${targetPath}`,\n      pass,\n    };\n  },\n  async toHaveFileContaining(target: FileMatcherTarget, targetPath: string, needle: string) {\n    const exists = await target.exists(targetPath);\n\n    if (!exists) {\n      return {\n        message: () => `Expected vault path to exist: ${targetPath}`,\n        pass: false,\n      };\n    }\n\n    const content = await target.read(targetPath);\n    const pass = content.includes(needle);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected vault path \"${targetPath}\" not to contain \"${needle}\"`\n          : `Expected vault path \"${targetPath}\" to contain \"${needle}\"`,\n      pass,\n    };\n  },\n  async toHaveFrontmatter(target: SandboxApi, targetPath: string, expected: NoteFrontmatter) {\n    const actual = await target.frontmatter(targetPath);\n    const pass = isDeepStrictEqual(actual, expected);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected frontmatter for \"${targetPath}\" not to equal ${JSON.stringify(expected)}`\n          : `Expected frontmatter for \"${targetPath}\" to equal ${JSON.stringify(\n              expected,\n            )}, received ${JSON.stringify(actual)}`,\n      pass,\n    };\n  },\n  async toHaveJsonFile(target: FileMatcherTarget, targetPath: string) {\n    const exists = await target.exists(targetPath);\n\n    if (!exists) {\n      return {\n        message: () => `Expected JSON file to exist: ${targetPath}`,\n        pass: false,\n      };\n    }\n\n    try {\n      await target.json(targetPath).read();\n      return {\n        message: () => `Expected JSON file \"${targetPath}\" not to be valid JSON`,\n        pass: true,\n      };\n    } catch (error) {\n      return {\n        message: () =>\n          `Expected JSON file \"${targetPath}\" to be valid JSON, but parsing failed: ${\n            error instanceof Error ? error.message : String(error)\n          }`,\n        pass: false,\n      };\n    }\n  },\n  async toHaveNote(target: FileMatcherTarget, targetPath: string, expected: NoteMatcherOptions) {\n    let actual: ReturnType<typeof parseNoteDocument>;\n\n    try {\n      actual = parseNoteDocument(await target.read(targetPath));\n    } catch (error) {\n      return {\n        message: () =>\n          `Expected vault path \"${targetPath}\" to be readable as a note, but reading failed: ${\n            error instanceof Error ? error.message : String(error)\n          }`,\n        pass: false,\n      };\n    }\n\n    const matchesFrontmatter =\n      expected.frontmatter === undefined ||\n      isDeepStrictEqual(actual.frontmatter, expected.frontmatter);\n    const matchesBody = expected.body === undefined || actual.body === expected.body;\n    const matchesBodyIncludes =\n      expected.bodyIncludes === undefined || actual.body.includes(expected.bodyIncludes);\n    const pass = matchesFrontmatter && matchesBody && matchesBodyIncludes;\n\n    return {\n      message: () =>\n        pass\n          ? `Expected vault path \"${targetPath}\" not to match the expected note shape`\n          : `Expected vault path \"${targetPath}\" to match the expected note shape, received ${JSON.stringify(\n              actual,\n            )}`,\n      pass,\n    };\n  },\n  async toHaveOpenTab(target: ObsidianClient, title: string, viewType?: string) {\n    const tabs = await target.tabs();\n    const pass = tabs.some(\n      (tab) => tab.title === title && (viewType === undefined || tab.viewType === viewType),\n    );\n\n    return {\n      message: () =>\n        pass\n          ? `Expected no open tab matching \"${title}\"${\n              viewType ? ` with view type \"${viewType}\"` : \"\"\n            }`\n          : `Expected an open tab matching \"${title}\"${\n              viewType ? ` with view type \"${viewType}\"` : \"\"\n            }`,\n      pass,\n    };\n  },\n  async toHavePluginData(target: PluginHandle, expected: unknown) {\n    const actual = await target.data().read();\n    const pass = isDeepStrictEqual(actual, expected);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected plugin data not to equal ${JSON.stringify(expected)}`\n          : `Expected plugin data to equal ${JSON.stringify(expected)}, received ${JSON.stringify(\n              actual,\n            )}`,\n      pass,\n    };\n  },\n  async toHaveEditorTextContaining(target: ObsidianClient, needle: string) {\n    const actual = await target.dev.editorText();\n    const pass = typeof actual === \"string\" && actual.includes(needle);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected editor text not to contain \"${needle}\"`\n          : `Expected editor text to contain \"${needle}\", received ${JSON.stringify(actual)}`,\n      pass,\n    };\n  },\n  async toHaveWorkspaceNode(target: ObsidianClient, label: string) {\n    const pass = hasWorkspaceNode(await target.workspace(), label);\n\n    return {\n      message: () =>\n        pass\n          ? `Expected workspace not to contain node \"${label}\"`\n          : `Expected workspace to contain node \"${label}\"`,\n      pass,\n    };\n  },\n});\n\ndeclare module \"vite-plus/test\" {\n  interface Assertion<T = any> {\n    toHaveActiveFile(path: string): Promise<T>;\n    toHaveCommand(commandId: string): Promise<T>;\n    toHaveEditorTextContaining(needle: string): Promise<T>;\n    toHaveFile(path: string): Promise<T>;\n    toHaveFileContaining(path: string, needle: string): Promise<T>;\n    toHaveFrontmatter(path: string, expected: NoteFrontmatter): Promise<T>;\n    toHaveJsonFile(path: string): Promise<T>;\n    toHaveNote(path: string, expected: NoteMatcherOptions): Promise<T>;\n    toHaveOpenTab(title: string, viewType?: string): Promise<T>;\n    toHavePluginData(expected: unknown): Promise<T>;\n    toHaveWorkspaceNode(label: string): Promise<T>;\n  }\n\n  interface AsymmetricMatchersContaining {\n    toHaveActiveFile(path: string): void;\n    toHaveCommand(commandId: string): void;\n    toHaveEditorTextContaining(needle: string): void;\n    toHaveFile(path: string): void;\n    toHaveFileContaining(path: string, needle: string): void;\n    toHaveFrontmatter(path: string, expected: NoteFrontmatter): void;\n    toHaveJsonFile(path: string): void;\n    toHaveNote(path: string, expected: NoteMatcherOptions): void;\n    toHaveOpenTab(title: string, viewType?: string): void;\n    toHavePluginData(expected: unknown): void;\n    toHaveWorkspaceNode(label: string): void;\n  }\n}\n\nexport {};\n\nfunction hasWorkspaceNode(\n  nodes: Awaited<ReturnType<ObsidianClient[\"workspace\"]>>,\n  label: string,\n): boolean {\n  for (const node of nodes) {\n    if (node.label === label || hasWorkspaceNode(node.children, label)) {\n      return true;\n    }\n  }\n\n  return false;\n}\n"],"mappings":";;;;AAgBA,OAAO,OAAO;CACZ,MAAM,iBAAiB,QAAwB,YAAoB;EACjE,MAAM,SAAS,MAAM,OAAO,IAAI,gBAAgB;EAChD,MAAM,OAAO,WAAW;AAExB,SAAO;GACL,eACE,OACI,mCAAmC,WAAW,KAC9C,+BAA+B,WAAW,cAAc,KAAK,UAAU,OAAO;GACpF;GACD;;CAEH,MAAM,cAAc,QAAwB,WAAmB;EAC7D,MAAM,OAAO,MAAM,OAAO,QAAQ,UAAU,CAAC,QAAQ;AAErD,SAAO;GACL,eACE,OACI,2CAA2C,cAC3C,uCAAuC;GAC7C;GACD;;CAEH,MAAM,WAAW,QAA2B,YAAoB;EAC9D,MAAM,OAAO,MAAM,OAAO,OAAO,WAAW;AAE5C,SAAO;GACL,eACE,OACI,qCAAqC,eACrC,iCAAiC;GACvC;GACD;;CAEH,MAAM,qBAAqB,QAA2B,YAAoB,QAAgB;AAGxF,MAAI,CAFW,MAAM,OAAO,OAAO,WAAW,CAG5C,QAAO;GACL,eAAe,iCAAiC;GAChD,MAAM;GACP;EAIH,MAAM,QADU,MAAM,OAAO,KAAK,WAAW,EACxB,SAAS,OAAO;AAErC,SAAO;GACL,eACE,OACI,wBAAwB,WAAW,oBAAoB,OAAO,KAC9D,wBAAwB,WAAW,gBAAgB,OAAO;GAChE;GACD;;CAEH,MAAM,kBAAkB,QAAoB,YAAoB,UAA2B;EACzF,MAAM,SAAS,MAAM,OAAO,YAAY,WAAW;EACnD,MAAM,OAAO,kBAAkB,QAAQ,SAAS;AAEhD,SAAO;GACL,eACE,OACI,6BAA6B,WAAW,iBAAiB,KAAK,UAAU,SAAS,KACjF,6BAA6B,WAAW,aAAa,KAAK,UACxD,SACD,CAAC,aAAa,KAAK,UAAU,OAAO;GAC3C;GACD;;CAEH,MAAM,eAAe,QAA2B,YAAoB;AAGlE,MAAI,CAFW,MAAM,OAAO,OAAO,WAAW,CAG5C,QAAO;GACL,eAAe,gCAAgC;GAC/C,MAAM;GACP;AAGH,MAAI;AACF,SAAM,OAAO,KAAK,WAAW,CAAC,MAAM;AACpC,UAAO;IACL,eAAe,uBAAuB,WAAW;IACjD,MAAM;IACP;WACM,OAAO;AACd,UAAO;IACL,eACE,uBAAuB,WAAW,0CAChC,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM;IAE1D,MAAM;IACP;;;CAGL,MAAM,WAAW,QAA2B,YAAoB,UAA8B;EAC5F,IAAI;AAEJ,MAAI;AACF,YAAS,kBAAkB,MAAM,OAAO,KAAK,WAAW,CAAC;WAClD,OAAO;AACd,UAAO;IACL,eACE,wBAAwB,WAAW,kDACjC,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM;IAE1D,MAAM;IACP;;EAGH,MAAM,qBACJ,SAAS,gBAAgB,KAAA,KACzB,kBAAkB,OAAO,aAAa,SAAS,YAAY;EAC7D,MAAM,cAAc,SAAS,SAAS,KAAA,KAAa,OAAO,SAAS,SAAS;EAC5E,MAAM,sBACJ,SAAS,iBAAiB,KAAA,KAAa,OAAO,KAAK,SAAS,SAAS,aAAa;EACpF,MAAM,OAAO,sBAAsB,eAAe;AAElD,SAAO;GACL,eACE,OACI,wBAAwB,WAAW,0CACnC,wBAAwB,WAAW,+CAA+C,KAAK,UACrF,OACD;GACP;GACD;;CAEH,MAAM,cAAc,QAAwB,OAAe,UAAmB;EAE5E,MAAM,QADO,MAAM,OAAO,MAAM,EACd,MACf,QAAQ,IAAI,UAAU,UAAU,aAAa,KAAA,KAAa,IAAI,aAAa,UAC7E;AAED,SAAO;GACL,eACE,OACI,kCAAkC,MAAM,GACtC,WAAW,oBAAoB,SAAS,KAAK,OAE/C,kCAAkC,MAAM,GACtC,WAAW,oBAAoB,SAAS,KAAK;GAErD;GACD;;CAEH,MAAM,iBAAiB,QAAsB,UAAmB;EAC9D,MAAM,SAAS,MAAM,OAAO,MAAM,CAAC,MAAM;EACzC,MAAM,OAAO,kBAAkB,QAAQ,SAAS;AAEhD,SAAO;GACL,eACE,OACI,qCAAqC,KAAK,UAAU,SAAS,KAC7D,iCAAiC,KAAK,UAAU,SAAS,CAAC,aAAa,KAAK,UAC1E,OACD;GACP;GACD;;CAEH,MAAM,2BAA2B,QAAwB,QAAgB;EACvE,MAAM,SAAS,MAAM,OAAO,IAAI,YAAY;EAC5C,MAAM,OAAO,OAAO,WAAW,YAAY,OAAO,SAAS,OAAO;AAElE,SAAO;GACL,eACE,OACI,wCAAwC,OAAO,KAC/C,oCAAoC,OAAO,cAAc,KAAK,UAAU,OAAO;GACrF;GACD;;CAEH,MAAM,oBAAoB,QAAwB,OAAe;EAC/D,MAAM,OAAO,iBAAiB,MAAM,OAAO,WAAW,EAAE,MAAM;AAE9D,SAAO;GACL,eACE,OACI,2CAA2C,MAAM,KACjD,uCAAuC,MAAM;GACnD;GACD;;CAEJ,CAAC;AAkCF,SAAS,iBACP,OACA,OACS;AACT,MAAK,MAAM,QAAQ,MACjB,KAAI,KAAK,UAAU,SAAS,iBAAiB,KAAK,UAAU,MAAM,CAChE,QAAO;AAIX,QAAO"}