obsidian-integration-testing 10.4.0 → 11.0.0

package/dist/lib/cjs/obsidian-metadata.d.cts

@@ -53,6 +53,41 @@ export interface ObsidianRuntimeVersions {
      */
     readonly v8: string;
 }
+/**
+ * The changelog page URLs for a version, one per publication target, baked into
+ * `metadata.json` from Obsidian's own changelog feed (`obsidian.md/changelog.xml`
+ * — see the `metadata.json` section in `CLAUDE.md`).
+ *
+ * Obsidian publishes a *separate* changelog page per platform (desktop / mobile)
+ * and per channel (public / catalyst "early access"), each at its own dated slug
+ * — the catalyst page typically predates the public one by about a day. Every
+ * key is optional: a version carries only the pages the feed actually published
+ * for it (a catalyst-only build has no `desktop`, a desktop-only release has no
+ * `mobile`, and the oldest versions predate the mobile app entirely).
+ *
+ * Caveat for the mobile keys: before **1.4.8** (2023-09-05) the mobile app ran
+ * its own version line, so a same-keyed mobile page documents a *different*
+ * release than the desktop page beside it (mobile `1.4.5` shipped 2023-05-23,
+ * desktop `1.4.5` 2023-08-31). From 1.4.8 on the two lines track within days.
+ */
+export interface ObsidianVersionChangelogUrls {
+    /**
+    The public desktop changelog page URL.
+     */
+    readonly desktop?: string;
+    /**
+    The catalyst ("early access") desktop changelog page URL.
+     */
+    readonly desktopCatalyst?: string;
+    /**
+    The public mobile changelog page URL.
+     */
+    readonly mobile?: string;
+    /**
+    The catalyst ("early access") mobile changelog page URL.
+     */
+    readonly mobileCatalyst?: string;
+}
 /**
  * The pre-resolved asset download URLs for a version, baked into `metadata.json`
  * from the upstream `obsidian-versions.json` catalog (see the `metadata.json`
@@ -61,12 +96,26 @@ export interface ObsidianRuntimeVersions {
  * These are the exact URLs the version's assets are published at, so the
  * integration-time download paths can skip the GitHub release-API lookup and the
  * historical dot-vs-hyphen asset-name guessing. Only the assets this library
- * actually downloads are carried: the app `asar` and the x64 desktop installers.
- * A field is absent when the version publishes no such asset (e.g. a catalyst
- * build ships only the `asar`), in which case the caller falls back to its
- * hand-rolled resolution.
+ * actually downloads are carried: the app `asar`, the x64 desktop installers,
+ * and the Android `apk`. A field is absent when the version publishes no such
+ * asset (e.g. a catalyst build ships only the `asar`), in which case the caller
+ * falls back to its hand-rolled resolution.
  */
 export interface ObsidianVersionDownloads {
+    /**
+     * The public Android `.apk` URL. Published as a GitHub release asset named
+     * uniformly `Obsidian-<version>.apk` — the asset first appears at 1.5.8 and is
+     * hyphenated from the start, so it has no dot-separator era to guess around
+     * (unlike the desktop installers `installer-asset.ts` handles).
+     *
+     * There is deliberately no catalyst counterpart. Unlike the desktop catalyst
+     * asar, the mobile catalyst build is not published at a URL at all: Obsidian
+     * distributes it through a Discord-gated channel, per
+     * https://obsidian.md/help/early-access. What this table can carry for a
+     * catalyst mobile build is its changelog —
+     * {@link ObsidianVersionChangelogUrls.mobileCatalyst}.
+     */
+    readonly apk?: string;
     /**
     The `obsidian-<version>.asar.gz` package URL.
      */
@@ -96,9 +145,11 @@ export interface ObsidianVersionMetadata {
      */
     readonly available?: boolean;
     /**
-    URL of the version's changelog.
+     * The version's changelog page URLs, one per publication target (desktop /
+     * mobile × public / catalyst), baked from Obsidian's changelog feed. Absent
+     * for the few versions the feed never published a page for.
      */
-    readonly changelogUrl?: string;
+    readonly changelogUrl?: ObsidianVersionChangelogUrls;
     /**
     The release channel: `'public'`, `'catalyst'`, or `'public+catalyst'`.
      */

package/dist/lib/cjs/open-obsidian-settings-tab.cjs

@@ -0,0 +1,51 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var open_obsidian_settings_tab_exports = {};
+__export(open_obsidian_settings_tab_exports, {
+  openObsidianSettingsTab: () => openObsidianSettingsTab
+});
+module.exports = __toCommonJS(open_obsidian_settings_tab_exports);
+var import_eval_in_obsidian = require("./eval-in-obsidian.cjs");
+var import_normalize_optional_properties = require("./normalize-optional-properties.cjs");
+async function openObsidianSettingsTab(options) {
+  const {
+    tabId,
+    timeoutInMilliseconds,
+    transport,
+    vaultPath
+  } = options;
+  return await (0, import_eval_in_obsidian.evalInObsidian)((0, import_normalize_optional_properties.normalizeOptionalProperties)({
+    async callback({ lib, openParams }) {
+      return await lib.openSettingsTab(openParams);
+    },
+    input: {
+      openParams: (0, import_normalize_optional_properties.normalizeOptionalProperties)({
+        tabId,
+        timeoutInMilliseconds
+      })
+    },
+    transport,
+    vaultPath
+  }));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  openObsidianSettingsTab
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL29wZW4tb2JzaWRpYW4tc2V0dGluZ3MtdGFiLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogT3BlbnMgT2JzaWRpYW4ncyBzZXR0aW5ncyBtb2RhbCBvbiBhIGdpdmVuIHRhYiBpbiB0aGUgaW5zdGFuY2UgdGhlIGN1cnJlbnRcbiAqIHRlc3QgY29udGV4dCBpcyBhbHJlYWR5IGRyaXZpbmcuXG4gKlxuICogVGhlIHJlbmRlcmVyLXNpZGUgd29yayBsaXZlcyBpbiB0aGUgaW5qZWN0ZWQgYGxpYmAgYmFnXG4gKiAoYGxpYi5vcGVuU2V0dGluZ3NUYWJgKSwgd2hlcmUgYSBjYWxsYmFjayB0aGF0IGFsc28gcHJvYmVzIHRoZSByZW5kZXJlZCBET01cbiAqIGNhbiByZWFjaCBpdC4gVGhpcyBpcyB0aGUgY29udGV4dC1yZXNvbHZpbmcgZW50cnkgcG9pbnQgZm9yIHRoZSBmYXIgbW9yZVxuICogY29tbW9uIGNhc2UgXHUyMDE0IGEgc2NyZWVuc2hvdCBzdWl0ZSB0aGF0IG9ubHkgd2FudHMgdGhlIHRhYiBvbiBzY3JlZW4gYmVmb3JlIGl0XG4gKiBjYWxscyBgY2FwdHVyZU9ic2lkaWFuU2NyZWVuc2hvdGAsIGFuZCB3b3VsZCBvdGhlcndpc2Ugd3JpdGUgdGhlIHNhbWVcbiAqIGBldmFsSW5PYnNpZGlhbmAgd3JhcHBlciBpbiBldmVyeSBwbHVnaW4uXG4gKi9cblxuLyogdjggaWdub3JlIHN0YXJ0IC0tIEludGVncmF0aW9uLXRpbWUgY29kZSAoZHJpdmVzIGEgbGl2ZSBPYnNpZGlhbikgY292ZXJlZCBieSBpbnRlZ3JhdGlvbiB0ZXN0cywgbm90IHVuaXQgdGVzdHMuICovXG5cbmltcG9ydCB0eXBlIHtcbiAgRXZhbEluT2JzaWRpYW5QYXJhbXMsXG4gIE9wZW5TZXR0aW5nc1RhYlBhcmFtc1xufSBmcm9tICcuL2V2YWwtaW4tb2JzaWRpYW4uY2pzJztcbmltcG9ydCB0eXBlIHsgT2JzaWRpYW5UcmFuc3BvcnQgfSBmcm9tICcuL3RyYW5zcG9ydC5janMnO1xuXG5pbXBvcnQgeyBldmFsSW5PYnNpZGlhbiB9IGZyb20gJy4vZXZhbC1pbi1vYnNpZGlhbi5janMnO1xuaW1wb3J0IHsgbm9ybWFsaXplT3B0aW9uYWxQcm9wZXJ0aWVzIH0gZnJvbSAnLi9ub3JtYWxpemUtb3B0aW9uYWwtcHJvcGVydGllcy5janMnO1xuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHtAbGluayBvcGVuT2JzaWRpYW5TZXR0aW5nc1RhYn0uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgT3Blbk9ic2lkaWFuU2V0dGluZ3NUYWJPcHRpb25zIGV4dGVuZHMgT3BlblNldHRpbmdzVGFiUGFyYW1zIHtcbiAgLyoqXG4gICAqIE92ZXJyaWRlIHRoZSB0cmFuc3BvcnQuIFdoZW4gb21pdHRlZCwgdGhlIHRyYW5zcG9ydCB0aGUgY3VycmVudCB0ZXN0XG4gICAqIGNvbnRleHQgaXMgZHJpdmluZyBpcyB1c2VkLlxuICAgKi9cbiAgcmVhZG9ubHkgdHJhbnNwb3J0PzogT2JzaWRpYW5UcmFuc3BvcnQ7XG5cbiAgLyoqXG4gICAqIFRoZSB2YXVsdCB3aG9zZSBPYnNpZGlhbiB3aW5kb3cgdG8gb3BlbiB0aGUgc2V0dGluZ3MgaW4uIFdoZW4gb21pdHRlZCwgdGhlXG4gICAqIGN1cnJlbnQgdGVzdCBjb250ZXh0J3MgdmF1bHQgaXMgdXNlZC5cbiAgICovXG4gIHJlYWRvbmx5IHZhdWx0UGF0aD86IHN0cmluZztcbn1cblxuLyoqXG4gKiBUaGUgc2VyaWFsaXplZCBwYXlsb2FkIGhhbmRlZCB0byB0aGUgY2FsbGJhY2sgXHUyMDE0IHRoZSB3aG9sZVxuICoge0BsaW5rIE9wZW5TZXR0aW5nc1RhYlBhcmFtc30gYmFnIGluIG9uZSBKU09OLXNhZmUgZmllbGQuXG4gKi9cbnR5cGUgT3BlblNldHRpbmdzVGFiSW5wdXQgPSBSZWNvcmQ8J29wZW5QYXJhbXMnLCBPcGVuU2V0dGluZ3NUYWJQYXJhbXM+O1xuXG4vKipcbiAqIE9wZW5zIE9ic2lkaWFuJ3Mgc2V0dGluZ3MgbW9kYWwgb24gYSBnaXZlbiB0YWIgYW5kIHdhaXRzIHVudGlsIHRoYXQgdGFiIGhhc1xuICogYWN0dWFsbHkgcmVuZGVyZWQsIHJlc29sdmluZyB0aGUgdHJhbnNwb3J0IGFuZCB2YXVsdCBmcm9tIHRoZSBjdXJyZW50IHRlc3RcbiAqIGNvbnRleHQuXG4gKlxuICogU2VlIHtAbGluayBMaWIub3BlblNldHRpbmdzVGFifSBmb3Igd2h5IHNpbXBseSBjYWxsaW5nIGBhcHAuc2V0dGluZy5vcGVuKClgXG4gKiByZW5kZXJzIG5vdGhpbmcsIGFuZCB3aHkgdGhlIGNvbnRhaW5lciBtdXN0IGJlIGF0dGFjaGVkICoqYmVmb3JlKiogaXQuXG4gKlxuICogQ2xvc2UgaXQgYWdhaW4gZnJvbSBhIGNhbGxiYWNrIHdpdGggYGFwcC5zZXR0aW5nLmNsb3NlKClgOyByZS1vcGVuaW5nIHdvcmtzLFxuICogYmVjYXVzZSB0aGUgYXR0YWNoIGlzIGlkZW1wb3RlbnQuXG4gKlxuICogQHBhcmFtIG9wdGlvbnMgLSBUaGUgdGFiIHRvIG9wZW4sIGhvdyBsb25nIHRvIHdhaXQsIGFuZCB0cmFuc3BvcnQgLyB2YXVsdFxuICogICBvdmVycmlkZXMuXG4gKiBAcmV0dXJucyBBIHtAbGluayBQcm9taXNlfSByZXNvbHZpbmcgdG8gdGhlIG5hbWVzIG9mIHRoZSBzZXR0aW5nIHJvd3MgdGhlIHRhYlxuICogICByZW5kZXJlZC5cbiAqIEB0aHJvd3MgRXJyb3IgaWYgbm8gdGFiIGNhcnJpZXMge0BsaW5rIE9wZW5TZXR0aW5nc1RhYlBhcmFtcy50YWJJZH0sIG9yIGlmIHRoZVxuICogICB0YWIgZG9lcyBub3QgcmVuZGVyIHdpdGhpbiB0aGUgdGltZW91dC5cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIG9wZW5PYnNpZGlhblNldHRpbmdzVGFiKG9wdGlvbnM6IE9wZW5PYnNpZGlhblNldHRpbmdzVGFiT3B0aW9ucyk6IFByb21pc2U8c3RyaW5nW10+IHtcbiAgY29uc3Qge1xuICAgIHRhYklkLFxuICAgIHRpbWVvdXRJbk1pbGxpc2Vjb25kcyxcbiAgICB0cmFuc3BvcnQsXG4gICAgdmF1bHRQYXRoXG4gIH0gPSBvcHRpb25zO1xuXG4gIHJldHVybiBhd2FpdCBldmFsSW5PYnNpZGlhbihub3JtYWxpemVPcHRpb25hbFByb3BlcnRpZXM8RXZhbEluT2JzaWRpYW5QYXJhbXM8T3BlblNldHRpbmdzVGFiSW5wdXQsIHN0cmluZ1tdPj4oe1xuICAgIGFzeW5jIGNhbGxiYWNrKHsgbGliLCBvcGVuUGFyYW1zIH0pOiBQcm9taXNlPHN0cmluZ1tdPiB7XG4gICAgICByZXR1cm4gYXdhaXQgbGliLm9wZW5TZXR0aW5nc1RhYihvcGVuUGFyYW1zKTtcbiAgICB9LFxuICAgIGlucHV0OiB7XG4gICAgICBvcGVuUGFyYW1zOiBub3JtYWxpemVPcHRpb25hbFByb3BlcnRpZXM8T3BlblNldHRpbmdzVGFiUGFyYW1zPih7XG4gICAgICAgIHRhYklkLFxuICAgICAgICB0aW1lb3V0SW5NaWxsaXNlY29uZHNcbiAgICAgIH0pXG4gICAgfSxcbiAgICB0cmFuc3BvcnQsXG4gICAgdmF1bHRQYXRoXG4gIH0pKTtcbn1cblxuLyogdjggaWdub3JlIHN0b3AgKi9cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFzQkEsOEJBQStCO0FBQy9CLDJDQUE0QztBQTJDNUMsZUFBc0Isd0JBQXdCLFNBQTREO0FBQ3hHLFFBQU07QUFBQSxJQUNKO0FBQUEsSUFDQTtBQUFBLElBQ0E7QUFBQSxJQUNBO0FBQUEsRUFDRixJQUFJO0FBRUosU0FBTyxVQUFNLDRDQUFlLGtFQUFrRjtBQUFBLElBQzVHLE1BQU0sU0FBUyxFQUFFLEtBQUssV0FBVyxHQUFzQjtBQUNyRCxhQUFPLE1BQU0sSUFBSSxnQkFBZ0IsVUFBVTtBQUFBLElBQzdDO0FBQUEsSUFDQSxPQUFPO0FBQUEsTUFDTCxnQkFBWSxrRUFBbUQ7QUFBQSxRQUM3RDtBQUFBLFFBQ0E7QUFBQSxNQUNGLENBQUM7QUFBQSxJQUNIO0FBQUEsSUFDQTtBQUFBLElBQ0E7QUFBQSxFQUNGLENBQUMsQ0FBQztBQUNKOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/cjs/open-obsidian-settings-tab.d.cts

@@ -0,0 +1,49 @@
+/**
+ * @file
+ *
+ * Opens Obsidian's settings modal on a given tab in the instance the current
+ * test context is already driving.
+ *
+ * The renderer-side work lives in the injected `lib` bag
+ * (`lib.openSettingsTab`), where a callback that also probes the rendered DOM
+ * can reach it. This is the context-resolving entry point for the far more
+ * common case — a screenshot suite that only wants the tab on screen before it
+ * calls `captureObsidianScreenshot`, and would otherwise write the same
+ * `evalInObsidian` wrapper in every plugin.
+ */
+import type { OpenSettingsTabParams } from './eval-in-obsidian.cjs';
+import type { ObsidianTransport } from './transport.cjs';
+/**
+ * Options for {@link openObsidianSettingsTab}.
+ */
+export interface OpenObsidianSettingsTabOptions extends OpenSettingsTabParams {
+    /**
+     * Override the transport. When omitted, the transport the current test
+     * context is driving is used.
+     */
+    readonly transport?: ObsidianTransport;
+    /**
+     * The vault whose Obsidian window to open the settings in. When omitted, the
+     * current test context's vault is used.
+     */
+    readonly vaultPath?: string;
+}
+/**
+ * Opens Obsidian's settings modal on a given tab and waits until that tab has
+ * actually rendered, resolving the transport and vault from the current test
+ * context.
+ *
+ * See {@link Lib.openSettingsTab} for why simply calling `app.setting.open()`
+ * renders nothing, and why the container must be attached **before** it.
+ *
+ * Close it again from a callback with `app.setting.close()`; re-opening works,
+ * because the attach is idempotent.
+ *
+ * @param options - The tab to open, how long to wait, and transport / vault
+ *   overrides.
+ * @returns A {@link Promise} resolving to the names of the setting rows the tab
+ *   rendered.
+ * @throws Error if no tab carries {@link OpenSettingsTabParams.tabId}, or if the
+ *   tab does not render within the timeout.
+ */
+export declare function openObsidianSettingsTab(options: OpenObsidianSettingsTabOptions): Promise<string[]>;