@mnaoumov/obsidian-lib 10.12.0 → 11.0.0

package/dist/lib/cjs/plugin/third-party-plugin.cjs

@@ -0,0 +1,231 @@
+/*
+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"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    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;
+}
+
+ensureBrowserProcess();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+  function extractDefault($module) {
+    return $module && $module.__esModule && "default" in $module ? $module.default : $module;
+  }
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ 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 = /* @__PURE__ */ 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);
+    }
+    const app = globalThis.app;
+    if (app?.isMobile) {
+      if (id === "process" || id === "node:process") {
+        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);
+      }
+    }
+    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 third_party_plugin_exports = {};
+__export(third_party_plugin_exports, {
+  createThirdPartyPluginDependency: () => createThirdPartyPluginDependency,
+  getThirdPartyPluginApi: () => getThirdPartyPluginApi,
+  getThirdPartyPluginAvailability: () => getThirdPartyPluginAvailability,
+  isThirdPartyPluginDependency: () => isThirdPartyPluginDependency,
+  requireThirdPartyPluginApi: () => requireThirdPartyPluginApi,
+  waitForThirdPartyPluginApi: () => waitForThirdPartyPluginApi,
+  watchThirdPartyPluginApi: () => watchThirdPartyPluginApi
+});
+module.exports = __toCommonJS(third_party_plugin_exports);
+var import_async_events = require("@mnaoumov/typescript-lib/async-events");
+var import_plugin_instance = require("./plugin-instance.cjs");
+var import_plugin_lifecycle_events = require("./plugin-lifecycle-events.cjs");
+class ThirdPartyPluginApiWatchBase {
+  // A `protected` constructor is not assignable to `AbstractConstructor<object>`, which is what
+  // `mixinAsyncEvents` accepts, so this stays public even though only the subclass below calls it.
+  constructor(params) {
+    this.params = params;
+  }
+  params;
+}
+class ThirdPartyPluginApiRefImpl extends (0, import_async_events.mixinAsyncEvents)()(ThirdPartyPluginApiWatchBase) {
+  get availability() {
+    return getThirdPartyPluginAvailability(this.params);
+  }
+  get value() {
+    return this.currentValue;
+  }
+  currentValue = null;
+  /**
+   * Re-reads the API, firing `change` only when it actually changed.
+   */
+  refresh() {
+    const value = getThirdPartyPluginApi(this.params);
+    if (value === this.currentValue) {
+      return;
+    }
+    this.currentValue = value;
+    this.trigger("change");
+  }
+}
+function createThirdPartyPluginDependency(params) {
+  const minPluginVersion = params.minPluginVersion ?? params.adapter.minPluginVersion;
+  return {
+    adapter: params.adapter,
+    pluginId: params.adapter.pluginId,
+    pluginName: params.adapter.pluginName,
+    reason: params.reason,
+    ...minPluginVersion !== void 0 && { minPluginVersion }
+  };
+}
+function getThirdPartyPluginApi(params) {
+  const plugin = (0, import_plugin_instance.getLoadedPlugin)(toPluginAvailabilityParams(params));
+  return plugin === null ? null : params.adapter.getApi(plugin);
+}
+function getThirdPartyPluginAvailability(params) {
+  return (0, import_plugin_instance.getPluginAvailability)(toPluginAvailabilityParams(params));
+}
+function isThirdPartyPluginDependency(dependency) {
+  return "adapter" in dependency;
+}
+async function requireThirdPartyPluginApi(params) {
+  const plugin = await (0, import_plugin_instance.requirePlugin)({
+    ...params,
+    ...toPluginAvailabilityParams(params),
+    pluginName: params.adapter.pluginName
+  });
+  return getVerifiedApi(params.adapter, plugin);
+}
+async function waitForThirdPartyPluginApi(params) {
+  const plugin = await (0, import_plugin_instance.waitForPlugin)({
+    ...params,
+    ...toPluginAvailabilityParams(params)
+  });
+  return getVerifiedApi(params.adapter, plugin);
+}
+function watchThirdPartyPluginApi(params) {
+  const { app, component } = params;
+  const ref = new ThirdPartyPluginApiRefImpl(params);
+  function refresh() {
+    ref.refresh();
+  }
+  component.registerEvent(app.plugins.on(import_plugin_instance.PLUGINS_CHANGED_EVENT_NAME, refresh));
+  component.registerEvent(app.workspace.on(import_plugin_lifecycle_events.PLUGIN_LOADED_EVENT_NAME, refresh));
+  component.registerEvent(app.workspace.on(import_plugin_lifecycle_events.PLUGIN_UNLOADED_EVENT_NAME, refresh));
+  ref.refresh();
+  return ref;
+}
+function getVerifiedApi(adapter, plugin) {
+  const api = adapter.getApi(plugin);
+  if (api === null) {
+    throw new Error(`The plugin "${adapter.pluginId}" does not expose the API its adapter expects.`);
+  }
+  return api;
+}
+function toPluginAvailabilityParams(params) {
+  const { adapter, app } = params;
+  const minPluginVersion = params.minPluginVersion ?? adapter.minPluginVersion;
+  return {
+    app,
+    isPlugin: (plugin) => adapter.getApi(plugin) !== null,
+    pluginId: adapter.pluginId,
+    ...minPluginVersion !== void 0 && { minPluginVersion }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createThirdPartyPluginDependency,
+  getThirdPartyPluginApi,
+  getThirdPartyPluginAvailability,
+  isThirdPartyPluginDependency,
+  requireThirdPartyPluginApi,
+  waitForThirdPartyPluginApi,
+  watchThirdPartyPluginApi
+});
+//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/plugin/third-party-plugin.ts"],"sourcesContent":["/**\n * @file\n *\n * Typed access to the API of a THIRD-PARTY plugin: one that publishes nothing through this library's registry.\n *\n * A plugin built on this library publishes a versioned contract (`getPluginApis()`), and a consumer reaches it\n * through `watchPluginApi` (`./plugin-api.ts`). Most plugins a consumer wants to talk to — `Dataview`,\n * `Templater`, `Notebook Navigator` — are not built on it, so their API hangs off the plugin instance under a\n * name of their own choosing, and every consumer used to reach it by hand through `app.plugins` with a cast.\n *\n * A {@link ThirdPartyPluginAdapter} says ONCE, for one plugin, how to get from its instance to its typed API,\n * and VERIFIES the shape on the way, so a release that renamed what the adapter reads is \"not there\" rather\n * than a `Cannot read properties of undefined` from inside a callback. Everything else here is generic:\n *\n * - {@link getThirdPartyPluginApi} answers \"now\", for a one-shot use.\n * - {@link watchThirdPartyPluginApi} answers \"now\" for as long as a component lives: its ref re-reads on every\n *   `app.plugins` `changed` and every `obsidian-lib:plugin-loaded` / `-unloaded` broadcast, so an OPTIONAL\n *   dependency is a ref whose `value` is `null` while the plugin is absent, and becomes the API the moment it\n *   is enabled.\n * - {@link waitForThirdPartyPluginApi} and {@link requireThirdPartyPluginApi} are the one-shot waits, built on\n *   `waitForPlugin` / `requirePlugin` (`./plugin-instance.ts`), so they share that module's availability\n *   classification, its notice and its repair buttons.\n * - A REQUIRED dependency is declared through `PluginBase.getPluginDependencies()` as a\n *   {@link ThirdPartyPluginDependency} (built by {@link createThirdPartyPluginDependency}), and the plugin gate\n *   keeps `onloadImpl` from running while it is missing, too old or the wrong shape — the same treatment an\n *   own-plugin dependency gets.\n *\n * Availability is {@link PluginAvailability}, read from Obsidian `1.15.1` as `plugin-instance.ts` documents:\n * an instance whose `onload` is still running reads as `loading`, never as available. An adapter's\n * `getApi` returning `null` reads as {@link PluginAvailability.ShapeMismatch}.\n */\n\nimport type { AsyncEventSource } from '@mnaoumov/typescript-lib/async-events';\nimport type {\n  App,\n  Component,\n  Plugin\n} from 'obsidian';\nimport type { Except } from 'type-fest';\n\nimport { mixinAsyncEvents } from '@mnaoumov/typescript-lib/async-events';\n\nimport type { PluginDependencyBase } from '../components/plugin-gate-component.ts';\nimport type {\n  GetPluginAvailabilityParams,\n  RequirePluginParams,\n  WaitForPluginParams\n} from './plugin-instance.ts';\n\nimport {\n  getLoadedPlugin,\n  getPluginAvailability,\n  PluginAvailability,\n  PLUGINS_CHANGED_EVENT_NAME,\n  requirePlugin,\n  waitForPlugin\n} from './plugin-instance.ts';\nimport {\n  PLUGIN_LOADED_EVENT_NAME,\n  PLUGIN_UNLOADED_EVENT_NAME\n} from './plugin-lifecycle-events.ts';\n\n/**\n * Parameters for {@link createThirdPartyPluginDependency}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface CreateThirdPartyPluginDependencyParams<TApi extends object> {\n  /**\n   * The adapter of the required plugin.\n   */\n  readonly adapter: ThirdPartyPluginAdapter<TApi>;\n\n  /**\n   * The oldest release the dependent works with. Defaults to the adapter's own\n   * {@link ThirdPartyPluginAdapter.minPluginVersion}; a dependent may only raise it.\n   */\n  readonly minPluginVersion?: string;\n\n  /**\n   * A localized sentence saying what the dependent does with the plugin, shown in the settings banner.\n   */\n  readonly reason: DocumentFragment | string;\n}\n\n/**\n * Parameters for {@link getThirdPartyPluginApi} and {@link getThirdPartyPluginAvailability}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface GetThirdPartyPluginApiParams<TApi extends object> {\n  /**\n   * The adapter of the plugin.\n   */\n  readonly adapter: ThirdPartyPluginAdapter<TApi>;\n\n  /**\n   * The Obsidian app instance.\n   */\n  readonly app: App;\n\n  /**\n   * The oldest release the caller works with. Defaults to the adapter's own\n   * {@link ThirdPartyPluginAdapter.minPluginVersion}.\n   */\n  readonly minPluginVersion?: string;\n}\n\n/**\n * Parameters for {@link getThirdPartyPluginAvailability}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport type GetThirdPartyPluginAvailabilityParams<TApi extends object> = GetThirdPartyPluginApiParams<TApi>;\n\n/**\n * Parameters for {@link requireThirdPartyPluginApi}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface RequireThirdPartyPluginApiParams<TApi extends object> extends Except<RequirePluginParams, 'app' | 'isPlugin' | 'minPluginVersion' | 'pluginId' | 'pluginName'>, GetThirdPartyPluginApiParams<TApi> {}\n\n/**\n * How to get from one third-party plugin's instance to its typed API.\n *\n * An adapter is plain data plus one function, so it can be a module-level constant shared by every consumer,\n * and adding a plugin means adding one adapter.\n *\n * @typeParam TApi - The plugin's API, typed by the adapter's author and verified by {@link getApi}.\n */\nexport interface ThirdPartyPluginAdapter<TApi extends object> {\n  /**\n   * Reads the typed API off a running instance of the plugin, VERIFYING its shape.\n   *\n   * Return `null` when the instance does not carry the members the adapter types, which is what a release\n   * that renamed or reshaped them looks like. Never cast: a cast asserts a shape nothing checked.\n   *\n   * @param plugin - The running instance, whose `onload` has settled.\n   * @returns The API, or `null` when the instance is not the shape the adapter expects.\n   */\n  readonly getApi: (plugin: Plugin) => null | TApi;\n\n  /**\n   * The oldest release of the plugin the adapter was verified against, compared with its `manifest.version`.\n   * A release below it reads as {@link PluginAvailability.Outdated}.\n   */\n  readonly minPluginVersion?: string;\n\n  /**\n   * The `manifest.id` of the plugin.\n   */\n  readonly pluginId: string;\n\n  /**\n   * The display name of the plugin, shown to the user.\n   */\n  readonly pluginName: string;\n}\n\n/**\n * A live reference to a third-party plugin's API.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface ThirdPartyPluginApiRef<TApi extends object> extends AsyncEventSource<ThirdPartyPluginApiRefEventMap> {\n  /**\n   * Whether the API can be used right now, and if not, why. Read at the moment of reading.\n   */\n  readonly availability: PluginAvailability;\n\n  /**\n   * The API, or `null` when it is not available right now. `null` during the consumer's `onload` may only\n   * mean the plugin has not loaded yet; the value becomes the API on its own once it has.\n   */\n  readonly value: null | TApi;\n}\n\n/**\n * The events a {@link ThirdPartyPluginApiRef} fires.\n */\nexport interface ThirdPartyPluginApiRefEventMap {\n  /**\n   * Fired whenever {@link ThirdPartyPluginApiRef.value} changes, including when it becomes `null` because the\n   * plugin was disabled or reloaded.\n   */\n  readonly change: [];\n}\n\n/**\n * A third-party plugin another plugin cannot work without, declared through\n * `PluginBase.getPluginDependencies()`.\n *\n * Built by {@link createThirdPartyPluginDependency}, which copies the adapter's id and name.\n */\nexport interface ThirdPartyPluginDependency extends PluginDependencyBase {\n  /**\n   * The adapter the gate reads the dependency's API through.\n   */\n  readonly adapter: ThirdPartyPluginAdapter<object>;\n}\n\n/**\n * Parameters for {@link waitForThirdPartyPluginApi}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface WaitForThirdPartyPluginApiParams<TApi extends object> extends Except<WaitForPluginParams, 'app' | 'isPlugin' | 'minPluginVersion' | 'pluginId'>, GetThirdPartyPluginApiParams<TApi> {}\n\n/**\n * Parameters for {@link watchThirdPartyPluginApi}.\n *\n * @typeParam TApi - The adapter's API type.\n */\nexport interface WatchThirdPartyPluginApiParams<TApi extends object> extends GetThirdPartyPluginApiParams<TApi> {\n  /**\n   * The component owning the watch. Its unload stops it.\n   */\n  readonly component: Component;\n}\n\n/**\n * Holds the parameters, so the {@link mixinAsyncEvents} mixin has a real base to extend.\n */\nabstract class ThirdPartyPluginApiWatchBase {\n  // A `protected` constructor is not assignable to `AbstractConstructor<object>`, which is what\n  // `mixinAsyncEvents` accepts, so this stays public even though only the subclass below calls it.\n  public constructor(protected readonly params: GetThirdPartyPluginApiParams<object>) {}\n}\n\nclass ThirdPartyPluginApiRefImpl<TApi extends object> extends mixinAsyncEvents<ThirdPartyPluginApiRefEventMap>()(ThirdPartyPluginApiWatchBase) implements ThirdPartyPluginApiRef<TApi> {\n  public get availability(): PluginAvailability {\n    return getThirdPartyPluginAvailability(this.params);\n  }\n\n  public get value(): null | TApi {\n    return this.currentValue;\n  }\n\n  private currentValue: null | TApi = null;\n\n  /**\n   * Re-reads the API, firing `change` only when it actually changed.\n   */\n  public refresh(): void {\n    const value = getThirdPartyPluginApi(this.params) as null | TApi;\n    if (value === this.currentValue) {\n      return;\n    }\n\n    this.currentValue = value;\n    this.trigger('change');\n  }\n}\n\n/**\n * Builds the declaration of a required third-party plugin, for `PluginBase.getPluginDependencies()`.\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link CreateThirdPartyPluginDependencyParams}.\n * @returns The dependency.\n */\nexport function createThirdPartyPluginDependency<TApi extends object>(params: CreateThirdPartyPluginDependencyParams<TApi>): ThirdPartyPluginDependency {\n  const minPluginVersion = params.minPluginVersion ?? params.adapter.minPluginVersion;\n  return {\n    adapter: params.adapter,\n    pluginId: params.adapter.pluginId,\n    pluginName: params.adapter.pluginName,\n    reason: params.reason,\n    ...(minPluginVersion !== undefined && { minPluginVersion })\n  };\n}\n\n/**\n * Returns a third-party plugin's typed API when the plugin is {@link PluginAvailability.Available}, and `null`\n * otherwise.\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link GetThirdPartyPluginApiParams}.\n * @returns The API, or `null`.\n */\nexport function getThirdPartyPluginApi<TApi extends object>(params: GetThirdPartyPluginApiParams<TApi>): null | TApi {\n  const plugin = getLoadedPlugin(toPluginAvailabilityParams(params));\n  return plugin === null ? null : params.adapter.getApi(plugin);\n}\n\n/**\n * Reads whether a third-party plugin's API can be used right now, and if not, why.\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link GetThirdPartyPluginApiParams}.\n * @returns The {@link PluginAvailability}; {@link PluginAvailability.ShapeMismatch} when the adapter does not\n * recognize the running instance.\n */\nexport function getThirdPartyPluginAvailability<TApi extends object>(params: GetThirdPartyPluginAvailabilityParams<TApi>): PluginAvailability {\n  return getPluginAvailability(toPluginAvailabilityParams(params));\n}\n\n/**\n * Checks whether a dependency declared through `PluginBase.getPluginDependencies()` is a third-party one.\n *\n * @param dependency - The declared dependency.\n * @returns Whether it carries an adapter.\n */\nexport function isThirdPartyPluginDependency(dependency: PluginDependencyBase): dependency is ThirdPartyPluginDependency {\n  return 'adapter' in dependency;\n}\n\n/**\n * Waits for a third-party plugin's API, asking the user to install, enable or update the plugin while it is\n * not available. Settles once; see `requirePlugin`.\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link RequireThirdPartyPluginApiParams}.\n * @returns A {@link Promise} resolving with the API.\n */\nexport async function requireThirdPartyPluginApi<TApi extends object>(params: RequireThirdPartyPluginApiParams<TApi>): Promise<TApi> {\n  const plugin = await requirePlugin({\n    ...params,\n    ...toPluginAvailabilityParams(params),\n    pluginName: params.adapter.pluginName\n  });\n  return getVerifiedApi(params.adapter, plugin);\n}\n\n/**\n * Waits for a third-party plugin's API to become available. Settles once; see `waitForPlugin`.\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link WaitForThirdPartyPluginApiParams}.\n * @returns A {@link Promise} resolving with the API.\n * @throws `PluginInstanceUnavailableError` when the timeout elapses.\n */\nexport async function waitForThirdPartyPluginApi<TApi extends object>(params: WaitForThirdPartyPluginApiParams<TApi>): Promise<TApi> {\n  const plugin = await waitForPlugin({\n    ...params,\n    ...toPluginAvailabilityParams(params)\n  });\n  return getVerifiedApi(params.adapter, plugin);\n}\n\n/**\n * Watches a third-party plugin's API and returns a live {@link ThirdPartyPluginApiRef}.\n *\n * The ref re-reads on every `app.plugins` `changed` and every library lifecycle broadcast, so it follows the\n * plugin through enable, disable, update and reload with no polling. This is the shape of an OPTIONAL\n * dependency: read `ref.value` where the integration is used, and treat `null` as \"not there\".\n *\n * @typeParam TApi - The adapter's API type.\n * @param params - The {@link WatchThirdPartyPluginApiParams}.\n * @returns The live reference.\n */\nexport function watchThirdPartyPluginApi<TApi extends object>(params: WatchThirdPartyPluginApiParams<TApi>): ThirdPartyPluginApiRef<TApi> {\n  const { app, component } = params;\n  const ref = new ThirdPartyPluginApiRefImpl<TApi>(params);\n  function refresh(): void {\n    ref.refresh();\n  }\n  component.registerEvent(app.plugins.on(PLUGINS_CHANGED_EVENT_NAME, refresh));\n  component.registerEvent(app.workspace.on(PLUGIN_LOADED_EVENT_NAME, refresh));\n  component.registerEvent(app.workspace.on(PLUGIN_UNLOADED_EVENT_NAME, refresh));\n  ref.refresh();\n  return ref;\n}\n\nfunction getVerifiedApi<TApi extends object>(adapter: ThirdPartyPluginAdapter<TApi>, plugin: Plugin): TApi {\n  const api = adapter.getApi(plugin);\n  if (api === null) {\n    // Unreachable through the waits, whose availability check already ran `getApi`; kept so a wrong adapter\n    // fails here by name rather than handing back `null` typed as the API.\n    throw new Error(`The plugin \"${adapter.pluginId}\" does not expose the API its adapter expects.`);\n  }\n\n  return api;\n}\n\nfunction toPluginAvailabilityParams<TApi extends object>(params: GetThirdPartyPluginApiParams<TApi>): GetPluginAvailabilityParams {\n  const { adapter, app } = params;\n  const minPluginVersion = params.minPluginVersion ?? adapter.minPluginVersion;\n  return {\n    app,\n    isPlugin: (plugin: Plugin): plugin is Plugin => adapter.getApi(plugin) !== null,\n    pluginId: adapter.pluginId,\n    ...(minPluginVersion !== undefined && { minPluginVersion })\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwCA,0BAAiC;AASjC,6BAOO;AACP,qCAGO;AAmKP,MAAe,6BAA6B;AAAA;AAAA;AAAA,EAGnC,YAA+B,QAA8C;AAA9C;AAAA,EAA+C;AAAA,EAA/C;AACxC;AAEA,MAAM,uCAAwD,sCAAiD,EAAE,4BAA4B,EAA0C;AAAA,EACrL,IAAW,eAAmC;AAC5C,WAAO,gCAAgC,KAAK,MAAM;AAAA,EACpD;AAAA,EAEA,IAAW,QAAqB;AAC9B,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,eAA4B;AAAA;AAAA;AAAA;AAAA,EAK7B,UAAgB;AACrB,UAAM,QAAQ,uBAAuB,KAAK,MAAM;AAChD,QAAI,UAAU,KAAK,cAAc;AAC/B;AAAA,IACF;AAEA,SAAK,eAAe;AACpB,SAAK,QAAQ,QAAQ;AAAA,EACvB;AACF;AASO,SAAS,iCAAsD,QAAkF;AACtJ,QAAM,mBAAmB,OAAO,oBAAoB,OAAO,QAAQ;AACnE,SAAO;AAAA,IACL,SAAS,OAAO;AAAA,IAChB,UAAU,OAAO,QAAQ;AAAA,IACzB,YAAY,OAAO,QAAQ;AAAA,IAC3B,QAAQ,OAAO;AAAA,IACf,GAAI,qBAAqB,UAAa,EAAE,iBAAiB;AAAA,EAC3D;AACF;AAUO,SAAS,uBAA4C,QAAyD;AACnH,QAAM,aAAS,wCAAgB,2BAA2B,MAAM,CAAC;AACjE,SAAO,WAAW,OAAO,OAAO,OAAO,QAAQ,OAAO,MAAM;AAC9D;AAUO,SAAS,gCAAqD,QAAyE;AAC5I,aAAO,8CAAsB,2BAA2B,MAAM,CAAC;AACjE;AAQO,SAAS,6BAA6B,YAA4E;AACvH,SAAO,aAAa;AACtB;AAUA,eAAsB,2BAAgD,QAA+D;AACnI,QAAM,SAAS,UAAM,sCAAc;AAAA,IACjC,GAAG;AAAA,IACH,GAAG,2BAA2B,MAAM;AAAA,IACpC,YAAY,OAAO,QAAQ;AAAA,EAC7B,CAAC;AACD,SAAO,eAAe,OAAO,SAAS,MAAM;AAC9C;AAUA,eAAsB,2BAAgD,QAA+D;AACnI,QAAM,SAAS,UAAM,sCAAc;AAAA,IACjC,GAAG;AAAA,IACH,GAAG,2BAA2B,MAAM;AAAA,EACtC,CAAC;AACD,SAAO,eAAe,OAAO,SAAS,MAAM;AAC9C;AAaO,SAAS,yBAA8C,QAA4E;AACxI,QAAM,EAAE,KAAK,UAAU,IAAI;AAC3B,QAAM,MAAM,IAAI,2BAAiC,MAAM;AACvD,WAAS,UAAgB;AACvB,QAAI,QAAQ;AAAA,EACd;AACA,YAAU,cAAc,IAAI,QAAQ,GAAG,mDAA4B,OAAO,CAAC;AAC3E,YAAU,cAAc,IAAI,UAAU,GAAG,yDAA0B,OAAO,CAAC;AAC3E,YAAU,cAAc,IAAI,UAAU,GAAG,2DAA4B,OAAO,CAAC;AAC7E,MAAI,QAAQ;AACZ,SAAO;AACT;AAEA,SAAS,eAAoC,SAAwC,QAAsB;AACzG,QAAM,MAAM,QAAQ,OAAO,MAAM;AACjC,MAAI,QAAQ,MAAM;AAGhB,UAAM,IAAI,MAAM,eAAe,QAAQ,QAAQ,gDAAgD;AAAA,EACjG;AAEA,SAAO;AACT;AAEA,SAAS,2BAAgD,QAAyE;AAChI,QAAM,EAAE,SAAS,IAAI,IAAI;AACzB,QAAM,mBAAmB,OAAO,oBAAoB,QAAQ;AAC5D,SAAO;AAAA,IACL;AAAA,IACA,UAAU,CAAC,WAAqC,QAAQ,OAAO,MAAM,MAAM;AAAA,IAC3E,UAAU,QAAQ;AAAA,IAClB,GAAI,qBAAqB,UAAa,EAAE,iBAAiB;AAAA,EAC3D;AACF;","names":[]}

package/dist/lib/cjs/plugin/third-party-plugin.d.cts

@@ -0,0 +1,244 @@
+/// <reference path="../library-references.d.cts" />
+/// <reference lib="dom" />
+/**
+ * @file
+ *
+ * Typed access to the API of a THIRD-PARTY plugin: one that publishes nothing through this library's registry.
+ *
+ * A plugin built on this library publishes a versioned contract (`getPluginApis()`), and a consumer reaches it
+ * through `watchPluginApi` (`./plugin-api.ts`). Most plugins a consumer wants to talk to — `Dataview`,
+ * `Templater`, `Notebook Navigator` — are not built on it, so their API hangs off the plugin instance under a
+ * name of their own choosing, and every consumer used to reach it by hand through `app.plugins` with a cast.
+ *
+ * A {@link ThirdPartyPluginAdapter} says ONCE, for one plugin, how to get from its instance to its typed API,
+ * and VERIFIES the shape on the way, so a release that renamed what the adapter reads is "not there" rather
+ * than a `Cannot read properties of undefined` from inside a callback. Everything else here is generic:
+ *
+ * - {@link getThirdPartyPluginApi} answers "now", for a one-shot use.
+ * - {@link watchThirdPartyPluginApi} answers "now" for as long as a component lives: its ref re-reads on every
+ *   `app.plugins` `changed` and every `obsidian-lib:plugin-loaded` / `-unloaded` broadcast, so an OPTIONAL
+ *   dependency is a ref whose `value` is `null` while the plugin is absent, and becomes the API the moment it
+ *   is enabled.
+ * - {@link waitForThirdPartyPluginApi} and {@link requireThirdPartyPluginApi} are the one-shot waits, built on
+ *   `waitForPlugin` / `requirePlugin` (`./plugin-instance.ts`), so they share that module's availability
+ *   classification, its notice and its repair buttons.
+ * - A REQUIRED dependency is declared through `PluginBase.getPluginDependencies()` as a
+ *   {@link ThirdPartyPluginDependency} (built by {@link createThirdPartyPluginDependency}), and the plugin gate
+ *   keeps `onloadImpl` from running while it is missing, too old or the wrong shape — the same treatment an
+ *   own-plugin dependency gets.
+ *
+ * Availability is {@link PluginAvailability}, read from Obsidian `1.15.1` as `plugin-instance.ts` documents:
+ * an instance whose `onload` is still running reads as `loading`, never as available. An adapter's
+ * `getApi` returning `null` reads as {@link PluginAvailability.ShapeMismatch}.
+ */
+import type { AsyncEventSource } from '@mnaoumov/typescript-lib/async-events' with { 'resolution-mode': 'import' };
+import type { App, Component, Plugin } from 'obsidian' with { 'resolution-mode': 'import' };
+import type { Except } from 'type-fest' with { 'resolution-mode': 'import' };
+import type { PluginDependencyBase } from '../components/plugin-gate-component.cjs';
+import type { RequirePluginParams, WaitForPluginParams } from './plugin-instance.cjs';
+import { PluginAvailability } from './plugin-instance.cjs';
+/**
+ * Parameters for {@link createThirdPartyPluginDependency}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface CreateThirdPartyPluginDependencyParams<TApi extends object> {
+    /**
+     * The adapter of the required plugin.
+     */
+    readonly adapter: ThirdPartyPluginAdapter<TApi>;
+    /**
+     * The oldest release the dependent works with. Defaults to the adapter's own
+     * {@link ThirdPartyPluginAdapter.minPluginVersion}; a dependent may only raise it.
+     */
+    readonly minPluginVersion?: string;
+    /**
+     * A localized sentence saying what the dependent does with the plugin, shown in the settings banner.
+     */
+    readonly reason: DocumentFragment | string;
+}
+/**
+ * Parameters for {@link getThirdPartyPluginApi} and {@link getThirdPartyPluginAvailability}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface GetThirdPartyPluginApiParams<TApi extends object> {
+    /**
+     * The adapter of the plugin.
+     */
+    readonly adapter: ThirdPartyPluginAdapter<TApi>;
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The oldest release the caller works with. Defaults to the adapter's own
+     * {@link ThirdPartyPluginAdapter.minPluginVersion}.
+     */
+    readonly minPluginVersion?: string;
+}
+/**
+ * Parameters for {@link getThirdPartyPluginAvailability}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export type GetThirdPartyPluginAvailabilityParams<TApi extends object> = GetThirdPartyPluginApiParams<TApi>;
+/**
+ * Parameters for {@link requireThirdPartyPluginApi}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface RequireThirdPartyPluginApiParams<TApi extends object> extends Except<RequirePluginParams, 'app' | 'isPlugin' | 'minPluginVersion' | 'pluginId' | 'pluginName'>, GetThirdPartyPluginApiParams<TApi> {
+}
+/**
+ * How to get from one third-party plugin's instance to its typed API.
+ *
+ * An adapter is plain data plus one function, so it can be a module-level constant shared by every consumer,
+ * and adding a plugin means adding one adapter.
+ *
+ * @typeParam TApi - The plugin's API, typed by the adapter's author and verified by {@link getApi}.
+ */
+export interface ThirdPartyPluginAdapter<TApi extends object> {
+    /**
+     * Reads the typed API off a running instance of the plugin, VERIFYING its shape.
+     *
+     * Return `null` when the instance does not carry the members the adapter types, which is what a release
+     * that renamed or reshaped them looks like. Never cast: a cast asserts a shape nothing checked.
+     *
+     * @param plugin - The running instance, whose `onload` has settled.
+     * @returns The API, or `null` when the instance is not the shape the adapter expects.
+     */
+    readonly getApi: (plugin: Plugin) => null | TApi;
+    /**
+     * The oldest release of the plugin the adapter was verified against, compared with its `manifest.version`.
+     * A release below it reads as {@link PluginAvailability.Outdated}.
+     */
+    readonly minPluginVersion?: string;
+    /**
+     * The `manifest.id` of the plugin.
+     */
+    readonly pluginId: string;
+    /**
+     * The display name of the plugin, shown to the user.
+     */
+    readonly pluginName: string;
+}
+/**
+ * A live reference to a third-party plugin's API.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface ThirdPartyPluginApiRef<TApi extends object> extends AsyncEventSource<ThirdPartyPluginApiRefEventMap> {
+    /**
+     * Whether the API can be used right now, and if not, why. Read at the moment of reading.
+     */
+    readonly availability: PluginAvailability;
+    /**
+     * The API, or `null` when it is not available right now. `null` during the consumer's `onload` may only
+     * mean the plugin has not loaded yet; the value becomes the API on its own once it has.
+     */
+    readonly value: null | TApi;
+}
+/**
+ * The events a {@link ThirdPartyPluginApiRef} fires.
+ */
+export interface ThirdPartyPluginApiRefEventMap {
+    /**
+     * Fired whenever {@link ThirdPartyPluginApiRef.value} changes, including when it becomes `null` because the
+     * plugin was disabled or reloaded.
+     */
+    readonly change: [];
+}
+/**
+ * A third-party plugin another plugin cannot work without, declared through
+ * `PluginBase.getPluginDependencies()`.
+ *
+ * Built by {@link createThirdPartyPluginDependency}, which copies the adapter's id and name.
+ */
+export interface ThirdPartyPluginDependency extends PluginDependencyBase {
+    /**
+     * The adapter the gate reads the dependency's API through.
+     */
+    readonly adapter: ThirdPartyPluginAdapter<object>;
+}
+/**
+ * Parameters for {@link waitForThirdPartyPluginApi}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface WaitForThirdPartyPluginApiParams<TApi extends object> extends Except<WaitForPluginParams, 'app' | 'isPlugin' | 'minPluginVersion' | 'pluginId'>, GetThirdPartyPluginApiParams<TApi> {
+}
+/**
+ * Parameters for {@link watchThirdPartyPluginApi}.
+ *
+ * @typeParam TApi - The adapter's API type.
+ */
+export interface WatchThirdPartyPluginApiParams<TApi extends object> extends GetThirdPartyPluginApiParams<TApi> {
+    /**
+     * The component owning the watch. Its unload stops it.
+     */
+    readonly component: Component;
+}
+/**
+ * Builds the declaration of a required third-party plugin, for `PluginBase.getPluginDependencies()`.
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link CreateThirdPartyPluginDependencyParams}.
+ * @returns The dependency.
+ */
+export declare function createThirdPartyPluginDependency<TApi extends object>(params: CreateThirdPartyPluginDependencyParams<TApi>): ThirdPartyPluginDependency;
+/**
+ * Returns a third-party plugin's typed API when the plugin is {@link PluginAvailability.Available}, and `null`
+ * otherwise.
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link GetThirdPartyPluginApiParams}.
+ * @returns The API, or `null`.
+ */
+export declare function getThirdPartyPluginApi<TApi extends object>(params: GetThirdPartyPluginApiParams<TApi>): null | TApi;
+/**
+ * Reads whether a third-party plugin's API can be used right now, and if not, why.
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link GetThirdPartyPluginApiParams}.
+ * @returns The {@link PluginAvailability}; {@link PluginAvailability.ShapeMismatch} when the adapter does not
+ * recognize the running instance.
+ */
+export declare function getThirdPartyPluginAvailability<TApi extends object>(params: GetThirdPartyPluginAvailabilityParams<TApi>): PluginAvailability;
+/**
+ * Checks whether a dependency declared through `PluginBase.getPluginDependencies()` is a third-party one.
+ *
+ * @param dependency - The declared dependency.
+ * @returns Whether it carries an adapter.
+ */
+export declare function isThirdPartyPluginDependency(dependency: PluginDependencyBase): dependency is ThirdPartyPluginDependency;
+/**
+ * Waits for a third-party plugin's API, asking the user to install, enable or update the plugin while it is
+ * not available. Settles once; see `requirePlugin`.
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link RequireThirdPartyPluginApiParams}.
+ * @returns A {@link Promise} resolving with the API.
+ */
+export declare function requireThirdPartyPluginApi<TApi extends object>(params: RequireThirdPartyPluginApiParams<TApi>): Promise<TApi>;
+/**
+ * Waits for a third-party plugin's API to become available. Settles once; see `waitForPlugin`.
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link WaitForThirdPartyPluginApiParams}.
+ * @returns A {@link Promise} resolving with the API.
+ * @throws `PluginInstanceUnavailableError` when the timeout elapses.
+ */
+export declare function waitForThirdPartyPluginApi<TApi extends object>(params: WaitForThirdPartyPluginApiParams<TApi>): Promise<TApi>;
+/**
+ * Watches a third-party plugin's API and returns a live {@link ThirdPartyPluginApiRef}.
+ *
+ * The ref re-reads on every `app.plugins` `changed` and every library lifecycle broadcast, so it follows the
+ * plugin through enable, disable, update and reload with no polling. This is the shape of an OPTIONAL
+ * dependency: read `ref.value` where the integration is used, and treat `null` as "not there".
+ *
+ * @typeParam TApi - The adapter's API type.
+ * @param params - The {@link WatchThirdPartyPluginApiParams}.
+ * @returns The live reference.
+ */
+export declare function watchThirdPartyPluginApi<TApi extends object>(params: WatchThirdPartyPluginApiParams<TApi>): ThirdPartyPluginApiRef<TApi>;

package/dist/lib/cjs/plugin-cli-handler-registrar.cjs

@@ -117,8 +117,8 @@ __export(plugin_cli_handler_registrar_exports, {
   PluginCliHandlerRegistrar: () => PluginCliHandlerRegistrar
 });
 module.exports = __toCommonJS(plugin_cli_handler_registrar_exports);
-var import_async = require('@mnaoumov/typescript-lib/async');
-var import_obsidian = require('obsidian');
+var import_async = require("@mnaoumov/typescript-lib/async");
+var import_obsidian = require("obsidian");
 class PluginCliHandlerRegistrar {
   /**
    * Creates a new instance of the {@link PluginCliHandlerRegistrar} class.

package/dist/lib/cjs/popovers/field-popover.cjs

@@ -117,10 +117,10 @@ __export(field_popover_exports, {
   editFieldsInPopover: () => editFieldsInPopover
 });
 module.exports = __toCommonJS(field_popover_exports);
-var import_object_utils = require('@mnaoumov/typescript-lib/object-utils');
-var import_obsidian = require('obsidian');
-var import_css_class = require('../css-class.cjs');
-var import_popover = require('./popover.cjs');
+var import_object_utils = require("@mnaoumov/typescript-lib/object-utils");
+var import_obsidian = require("obsidian");
+var import_css_class = require("../css-class.cjs");
+var import_popover = require("./popover.cjs");
 async function editFieldsInPopover(params) {
   const {
     anchor,

package/dist/lib/cjs/popovers/index.cjs

@@ -102,9 +102,9 @@ __export(popovers_exports, {
   "popover-anchor": () => popover_anchor
 });
 module.exports = __toCommonJS(popovers_exports);
-var field_popover = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./field-popover.cjs')), 1);
-var popover_anchor = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./popover-anchor.cjs')), 1);
-var popover = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./popover.cjs')), 1);
+var field_popover = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require("./field-popover.cjs")), 1);
+var popover_anchor = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require("./popover-anchor.cjs")), 1);
+var popover = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require("./popover.cjs")), 1);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   "field-popover": null,

package/dist/lib/cjs/popovers/popover-anchor.cjs

@@ -120,7 +120,7 @@ __export(popover_anchor_exports, {
   createAnchorFromSelection: () => createAnchorFromSelection
 });
 module.exports = __toCommonJS(popover_anchor_exports);
-var import_html_element = require('@mnaoumov/typescript-lib/html-element');
+var import_html_element = require("@mnaoumov/typescript-lib/html-element");
 const CENTER_FRACTION = 0.5;
 function createAnchorFromDocumentCenter(doc) {
   const win = (0, import_html_element.getDocumentWindow)(doc);

package/dist/lib/cjs/popovers/popover.cjs

@@ -117,11 +117,11 @@ __export(popover_exports, {
   showPopover: () => showPopover
 });
 module.exports = __toCommonJS(popover_exports);
-var import_html_element = require('@mnaoumov/typescript-lib/html-element');
-var import_obsidian = require('obsidian');
-var import_css_class = require('../css-class.cjs');
-var import_i18n = require('../i18n/i18n.cjs');
-var import_plugin_context = require('../plugin/plugin-context.cjs');
+var import_html_element = require("@mnaoumov/typescript-lib/html-element");
+var import_obsidian = require("obsidian");
+var import_css_class = require("../css-class.cjs");
+var import_i18n = require("../i18n/i18n.cjs");
+var import_plugin_context = require("../plugin/plugin-context.cjs");
 const ANCHOR_GAP_IN_PIXELS = 4;
 const VIEWPORT_MARGIN_IN_PIXELS = 8;
 async function showPopover(params) {

package/dist/lib/cjs/queue.cjs

@@ -119,14 +119,14 @@ __export(queue_exports, {
   flushQueue: () => flushQueue
 });
 module.exports = __toCommonJS(queue_exports);
-var import_abort_controller = require('@mnaoumov/typescript-lib/abort-controller');
-var import_async = require('@mnaoumov/typescript-lib/async');
-var import_error = require('@mnaoumov/typescript-lib/error');
-var import_function = require('@mnaoumov/typescript-lib/function');
-var import_async_with_notice = require('./async-with-notice.cjs');
-var import_i18n = require('./i18n/i18n.cjs');
-var import_logger = require('./logger.cjs');
-var import_obsidian_lib_state = require('./obsidian-lib-state.cjs');
+var import_abort_controller = require("@mnaoumov/typescript-lib/abort-controller");
+var import_async = require("@mnaoumov/typescript-lib/async");
+var import_error = require("@mnaoumov/typescript-lib/error");
+var import_function = require("@mnaoumov/typescript-lib/function");
+var import_async_with_notice = require("./async-with-notice.cjs");
+var import_i18n = require("./i18n/i18n.cjs");
+var import_logger = require("./logger.cjs");
+var import_obsidian_lib_state = require("./obsidian-lib-state.cjs");
 function addToQueue(params) {
   const stackTrace = params.stackTrace ?? (0, import_error.getStackTrace)(1);
   (0, import_async.invokeAsyncSafely)(() => addToQueueAndWait(params), stackTrace);

package/dist/lib/cjs/react/app-context.cjs

@@ -118,9 +118,9 @@ __export(app_context_exports, {
   useApp: () => useApp
 });
 module.exports = __toCommonJS(app_context_exports);
-var import_type_guards = require('@mnaoumov/typescript-lib/type-guards');
-var import_obsidian = require('obsidian');
-var import_react = require('react');
+var import_type_guards = require("@mnaoumov/typescript-lib/type-guards");
+var import_obsidian = require("obsidian");
+var import_react = require("react");
 const AppContext = (0, import_react.createContext)(void 0);
 function useApp() {
   return (0, import_type_guards.ensureNonNullable)((0, import_react.useContext)(AppContext), "AppContext not found");

package/dist/lib/cjs/react/index.cjs

@@ -100,7 +100,7 @@ __export(react_exports, {
   "app-context": () => app_context
 });
 module.exports = __toCommonJS(react_exports);
-var app_context = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./app-context.cjs')), 1);
+var app_context = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require("./app-context.cjs")), 1);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   "app-context": null

package/dist/lib/cjs/reference-definition.cjs

@@ -90,7 +90,7 @@ __export(reference_definition_exports, {
   referenceDefinitionToFileChange: () => referenceDefinitionToFileChange
 });
 module.exports = __toCommonJS(reference_definition_exports);
-var import_debug = require('./debug.cjs');
+var import_debug = require("./debug.cjs");
 const ASCII_PUNCTUATION_REG_EXP = /[!-/:-@[-`{-~]/;
 const BARE_DESTINATION_FORBIDDEN_CHARACTER_REG_EXP = /[\s\p{Cc}]/u;
 const DEFINITION_PREFIX_REG_EXP = /^[ \t]*\[(?:\\[\s\S]|[^\\\]])+\]:[ \t]*(?:\r?\n(?:[ \t]*>)*[ \t]*)?/;