obsidian-dev-utils 101.6.0 → 101.7.0

package/dist/lib/cjs/obsidian/plugin/plugin-install-state.d.cts

@@ -0,0 +1,113 @@
+/// <reference path="../../library.d.cts" />
+/**
+ * @file
+ *
+ * How another plugin is present in this vault, and the one-click path to making it present.
+ *
+ * Shared by the two components that ask a user to bring another plugin in: `PluginSuggestionComponent`,
+ * which OFFERS one and keeps working without it, and `PluginGateComponent`, which REQUIRES one and
+ * does nothing until it is there. The offer and the requirement differ in what they do about the answer,
+ * not in how they read the state or how they install — so that part lives here rather than in both.
+ */
+import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
+import type { PluginNoticeComponent } from '../components/plugin-notice-component.cjs';
+/**
+ * How another plugin is currently present in the vault.
+ */
+export declare enum InstalledPluginState {
+    /**
+     * Installed and enabled — there is nothing to do.
+     */
+    Enabled = "enabled",
+    /**
+     * Installed but disabled. Only an enable is needed, so no download happens.
+     */
+    InstalledButDisabled = "installedButDisabled",
+    /**
+     * Not installed at all.
+     */
+    NotInstalled = "notInstalled"
+}
+/**
+ * Parameters for {@link getInstalledPluginState}.
+ */
+export interface GetInstalledPluginStateParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The `manifest.id` of the plugin to look for.
+     */
+    readonly pluginId: string;
+}
+/**
+ * Parameters for {@link getInstalledPluginVersion}.
+ */
+export interface GetInstalledPluginVersionParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The `manifest.id` of the plugin to look for.
+     */
+    readonly pluginId: string;
+}
+/**
+ * Parameters for {@link installAndEnablePlugin}.
+ */
+export interface InstallAndEnablePluginParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The `manifest.id` of the plugin to install and enable.
+     */
+    readonly pluginId: string;
+    /**
+     * The display name of the plugin, shown to the user.
+     */
+    readonly pluginName: string;
+    /**
+     * The notice component of the plugin doing the asking, used to report the outcome.
+     */
+    readonly pluginNoticeComponent: PluginNoticeComponent;
+}
+/**
+ * Resolves how another plugin is currently present in the vault.
+ *
+ * @param params - The {@link GetInstalledPluginStateParams}.
+ * @returns The {@link InstalledPluginState}.
+ */
+export declare function getInstalledPluginState(params: GetInstalledPluginStateParams): InstalledPluginState;
+/**
+ * Reads the version of another plugin as this vault has it installed, or `null` when it is not running.
+ *
+ * The version comes out of `app.plugins.manifests`, which is populated for every installed plugin at
+ * startup — so, unlike anything a plugin REGISTERS, it answers the same way no matter which plugin loaded
+ * first. That load-order independence is the whole reason a conflict is detected by version rather than by
+ * asking a registry.
+ *
+ * `null` for a plugin that is not installed OR is installed but disabled: a disabled plugin registers
+ * nothing, so for every question this answers the two cases are the same. An installed, enabled plugin
+ * whose manifest somehow carries no version reads as an empty string rather than `null`, which keeps
+ * "running, version unknown" distinguishable from "not running" — a caller comparing versions should fail
+ * closed on it rather than treat it as absent.
+ *
+ * @param params - The {@link GetInstalledPluginVersionParams}.
+ * @returns The installed version, or `null` when the plugin is not enabled.
+ */
+export declare function getInstalledPluginVersion(params: GetInstalledPluginVersionParams): null | string;
+/**
+ * Installs (when needed) and enables another plugin, reporting the outcome as a notice.
+ *
+ * A no-op when the plugin is already enabled, so a caller reacting to a click need not check first.
+ *
+ * @param params - The {@link InstallAndEnablePluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is enabled.
+ * @throws Whatever the install or enable threw, after reporting it as a notice — the caller decides
+ * whether a failure is worth more than the notice the user has already seen.
+ */
+export declare function installAndEnablePlugin(params: InstallAndEnablePluginParams): Promise<void>;

package/dist/lib/cjs/obsidian/plugin/plugin-lifecycle-events.cjs

@@ -0,0 +1,161 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  globalThisRecord['__name'] ??= keepName;
+  const originalRequire = require;
+  if (originalRequire && !originalRequire.__isPatched) {
+    // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+    require = Object.assign(
+      (id) => requirePatched(id),
+      originalRequire,
+      {
+        __isPatched: true
+      }
+    );
+  }
+
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+})();
+
+"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 plugin_lifecycle_events_exports = {};
+__export(plugin_lifecycle_events_exports, {
+  PLUGIN_LOADED_EVENT_NAME: () => PLUGIN_LOADED_EVENT_NAME,
+  PLUGIN_UNLOADED_EVENT_NAME: () => PLUGIN_UNLOADED_EVENT_NAME,
+  triggerPluginLifecycleEvent: () => triggerPluginLifecycleEvent
+});
+module.exports = __toCommonJS(plugin_lifecycle_events_exports);
+const PLUGIN_LOADED_EVENT_NAME = "obsidian-dev-utils:plugin-loaded";
+const PLUGIN_UNLOADED_EVENT_NAME = "obsidian-dev-utils:plugin-unloaded";
+function triggerPluginLifecycleEvent(params) {
+  params.app.workspace.trigger(params.name, params.payload);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PLUGIN_LOADED_EVENT_NAME,
+  PLUGIN_UNLOADED_EVENT_NAME,
+  triggerPluginLifecycleEvent
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../src/obsidian/plugin/plugin-lifecycle-events.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * The lifecycle broadcast every {@link PluginBase} makes: `obsidian-dev-utils:plugin-loaded` when it has\n * finished loading and `obsidian-dev-utils:plugin-unloaded` when it goes away.\n *\n * Obsidian gives a plugin no way to learn that ANOTHER plugin was enabled or disabled \u2014 there is no such\n * event on `app.plugins`, and a plugin's own `Events` source cannot help a listener that does not yet hold\n * the instance. So the broadcast goes through `app.workspace`, which is one object every plugin in the\n * vault can reach. Deliberately NOT the `globalThis.__obsidianDevUtils` bag the rest of the library shares\n * its state through: a listener there needs its own copy of this library, and these events are meant to be\n * consumable by any plugin at all.\n *\n * The names are past tense because a broadcast states something that has already happened. `loaded` in\n * particular carries a guarantee: it is triggered only after every API the plugin declares has been\n * published, so a listener may call them immediately.\n *\n * Both the event names and {@link PluginLifecycleEventPayload} are a CROSS-VERSION CONTRACT. Copies of\n * this library at different versions publish and consume them side by side in one vault, so neither may\n * change incompatibly: plain data only, and new payload fields only ever added.\n */\n\nimport type { App } from 'obsidian';\n\n/**\n * The name of either lifecycle event.\n */\nexport type PluginLifecycleEventName = typeof PLUGIN_LOADED_EVENT_NAME | typeof PLUGIN_UNLOADED_EVENT_NAME;\n\n/**\n * The payload of {@link PLUGIN_LOADED_EVENT_NAME} and {@link PLUGIN_UNLOADED_EVENT_NAME}.\n *\n * Plain data by design \u2014 no class instances and no types owned by this library \u2014 because it crosses\n * between independently bundled copies of it, and between plugins that do not use it at all.\n */\nexport interface PluginLifecycleEventPayload {\n  /**\n   * The contract versions the plugin published, empty when it publishes no API.\n   *\n   * An array rather than a single version because a provider may publish several contract versions side by\n   * side, so consumers pinned to an older range keep working across a breaking change.\n   *\n   * The API objects themselves are deliberately NOT here. A handle delivered by a one-shot event is a\n   * probe: it answers \"now\" and never says when \"now\" changed, and one that outlives the provider is\n   * exactly the stale handle the plugin-api registry's revocable handles exist to prevent. Reach the API\n   * through `watchPluginApi` instead, whose reference stays correct across unload and re-enable.\n   */\n  readonly apiVersions: readonly string[];\n\n  /**\n   * The ids of the plugins this one declares as mandatory dependencies, empty when it declares none.\n   *\n   * Present so the relationship can be read from the OTHER end: a provider has no way to ask who depends\n   * on it \u2014 the registry only answers consumer-to-provider \u2014 and \"which installed plugins need this one\"\n   * is what lets a provider's settings tab tell the user why it is in their vault at all.\n   */\n  readonly dependencyPluginIds: readonly string[];\n\n  /**\n   * The plugin's `manifest.id`.\n   */\n  readonly pluginId: string;\n\n  /**\n   * The plugin's `manifest.name`, for display.\n   */\n  readonly pluginName: string;\n\n  /**\n   * The plugin's `manifest.version`.\n   */\n  readonly pluginVersion: string;\n}\n\n/**\n * Parameters for {@link triggerPluginLifecycleEvent}.\n */\nexport interface TriggerPluginLifecycleEventParams {\n  /**\n   * The Obsidian app instance whose workspace carries the broadcast.\n   */\n  readonly app: App;\n\n  /**\n   * The event to trigger.\n   */\n  readonly name: PluginLifecycleEventName;\n\n  /**\n   * The payload describing the plugin.\n   */\n  readonly payload: PluginLifecycleEventPayload;\n}\n\n/**\n * Triggered once a plugin has finished loading AND published every API it declares, so a listener may call\n * those APIs immediately.\n *\n * Namespaced by the package name rather than by an abbreviation of it: the event is global to the vault\n * and aimed at plugin authors who have never heard of this library, so the prefix has to identify itself.\n */\nexport const PLUGIN_LOADED_EVENT_NAME = 'obsidian-dev-utils:plugin-loaded';\n\n/**\n * Triggered as a plugin unloads \u2014 whether the user disabled it, uninstalled it, or Obsidian is shutting\n * down. Its APIs are revoked by the time a listener runs.\n */\nexport const PLUGIN_UNLOADED_EVENT_NAME = 'obsidian-dev-utils:plugin-unloaded';\n\ndeclare module 'obsidian' {\n  interface Workspace {\n    /**\n     * Subscribes to a plugin finishing its load, or to one unloading.\n     *\n     * @param name - Should be {@link PLUGIN_LOADED_EVENT_NAME} or {@link PLUGIN_UNLOADED_EVENT_NAME}.\n     * @param callback - The callback receiving the plugin's payload.\n     * @param context - The context passed as `this` to the `callback` function.\n     * @returns The event reference.\n     */\n    on(name: PluginLifecycleEventName, callback: (payload: PluginLifecycleEventPayload) => unknown, context?: unknown): EventRef;\n  }\n}\n\n/**\n * Triggers one of the two lifecycle events on the app's workspace.\n *\n * A thin typed wrapper over `Workspace.trigger`, which accepts any event name and any arguments, so that\n * the one place a payload is constructed is checked against {@link PluginLifecycleEventPayload}.\n *\n * @param params - The {@link TriggerPluginLifecycleEventParams}.\n */\nexport function triggerPluginLifecycleEvent(params: TriggerPluginLifecycleEventParams): void {\n  params.app.workspace.trigger(params.name, params.payload);\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAqGO,MAAM,2BAA2B;AAMjC,MAAM,6BAA6B;AAwBnC,SAAS,4BAA4B,QAAiD;AAC3F,SAAO,IAAI,UAAU,QAAQ,OAAO,MAAM,OAAO,OAAO;AAC1D;",
  "names": []
}


package/dist/lib/cjs/obsidian/plugin/plugin-lifecycle-events.d.cts

@@ -0,0 +1,119 @@
+/// <reference path="../../library.d.cts" />
+/**
+ * @file
+ *
+ * The lifecycle broadcast every {@link PluginBase} makes: `obsidian-dev-utils:plugin-loaded` when it has
+ * finished loading and `obsidian-dev-utils:plugin-unloaded` when it goes away.
+ *
+ * Obsidian gives a plugin no way to learn that ANOTHER plugin was enabled or disabled — there is no such
+ * event on `app.plugins`, and a plugin's own `Events` source cannot help a listener that does not yet hold
+ * the instance. So the broadcast goes through `app.workspace`, which is one object every plugin in the
+ * vault can reach. Deliberately NOT the `globalThis.__obsidianDevUtils` bag the rest of the library shares
+ * its state through: a listener there needs its own copy of this library, and these events are meant to be
+ * consumable by any plugin at all.
+ *
+ * The names are past tense because a broadcast states something that has already happened. `loaded` in
+ * particular carries a guarantee: it is triggered only after every API the plugin declares has been
+ * published, so a listener may call them immediately.
+ *
+ * Both the event names and {@link PluginLifecycleEventPayload} are a CROSS-VERSION CONTRACT. Copies of
+ * this library at different versions publish and consume them side by side in one vault, so neither may
+ * change incompatibly: plain data only, and new payload fields only ever added.
+ */
+import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
+/**
+ * The name of either lifecycle event.
+ */
+export type PluginLifecycleEventName = typeof PLUGIN_LOADED_EVENT_NAME | typeof PLUGIN_UNLOADED_EVENT_NAME;
+/**
+ * The payload of {@link PLUGIN_LOADED_EVENT_NAME} and {@link PLUGIN_UNLOADED_EVENT_NAME}.
+ *
+ * Plain data by design — no class instances and no types owned by this library — because it crosses
+ * between independently bundled copies of it, and between plugins that do not use it at all.
+ */
+export interface PluginLifecycleEventPayload {
+    /**
+     * The contract versions the plugin published, empty when it publishes no API.
+     *
+     * An array rather than a single version because a provider may publish several contract versions side by
+     * side, so consumers pinned to an older range keep working across a breaking change.
+     *
+     * The API objects themselves are deliberately NOT here. A handle delivered by a one-shot event is a
+     * probe: it answers "now" and never says when "now" changed, and one that outlives the provider is
+     * exactly the stale handle the plugin-api registry's revocable handles exist to prevent. Reach the API
+     * through `watchPluginApi` instead, whose reference stays correct across unload and re-enable.
+     */
+    readonly apiVersions: readonly string[];
+    /**
+     * The ids of the plugins this one declares as mandatory dependencies, empty when it declares none.
+     *
+     * Present so the relationship can be read from the OTHER end: a provider has no way to ask who depends
+     * on it — the registry only answers consumer-to-provider — and "which installed plugins need this one"
+     * is what lets a provider's settings tab tell the user why it is in their vault at all.
+     */
+    readonly dependencyPluginIds: readonly string[];
+    /**
+     * The plugin's `manifest.id`.
+     */
+    readonly pluginId: string;
+    /**
+     * The plugin's `manifest.name`, for display.
+     */
+    readonly pluginName: string;
+    /**
+     * The plugin's `manifest.version`.
+     */
+    readonly pluginVersion: string;
+}
+/**
+ * Parameters for {@link triggerPluginLifecycleEvent}.
+ */
+export interface TriggerPluginLifecycleEventParams {
+    /**
+     * The Obsidian app instance whose workspace carries the broadcast.
+     */
+    readonly app: App;
+    /**
+     * The event to trigger.
+     */
+    readonly name: PluginLifecycleEventName;
+    /**
+     * The payload describing the plugin.
+     */
+    readonly payload: PluginLifecycleEventPayload;
+}
+/**
+ * Triggered once a plugin has finished loading AND published every API it declares, so a listener may call
+ * those APIs immediately.
+ *
+ * Namespaced by the package name rather than by an abbreviation of it: the event is global to the vault
+ * and aimed at plugin authors who have never heard of this library, so the prefix has to identify itself.
+ */
+export declare const PLUGIN_LOADED_EVENT_NAME = "obsidian-dev-utils:plugin-loaded";
+/**
+ * Triggered as a plugin unloads — whether the user disabled it, uninstalled it, or Obsidian is shutting
+ * down. Its APIs are revoked by the time a listener runs.
+ */
+export declare const PLUGIN_UNLOADED_EVENT_NAME = "obsidian-dev-utils:plugin-unloaded";
+declare module 'obsidian' {
+    interface Workspace {
+        /**
+         * Subscribes to a plugin finishing its load, or to one unloading.
+         *
+         * @param name - Should be {@link PLUGIN_LOADED_EVENT_NAME} or {@link PLUGIN_UNLOADED_EVENT_NAME}.
+         * @param callback - The callback receiving the plugin's payload.
+         * @param context - The context passed as `this` to the `callback` function.
+         * @returns The event reference.
+         */
+        on(name: PluginLifecycleEventName, callback: (payload: PluginLifecycleEventPayload) => unknown, context?: unknown): EventRef;
+    }
+}
+/**
+ * Triggers one of the two lifecycle events on the app's workspace.
+ *
+ * A thin typed wrapper over `Workspace.trigger`, which accepts any event name and any arguments, so that
+ * the one place a payload is constructed is checked against {@link PluginLifecycleEventPayload}.
+ *
+ * @param params - The {@link TriggerPluginLifecycleEventParams}.
+ */
+export declare function triggerPluginLifecycleEvent(params: TriggerPluginLifecycleEventParams): void;