@mnaoumov/obsidian-lib 1.0.1 → 2.0.0

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

@@ -90,18 +90,6 @@ export interface GetBacklinksForFileSafeParams extends GetBacklinksForFileSafeOp
      */
     readonly pathOrFile: PathOrFile;
 }
-/**
- * Wrapper for the getBacklinksForFile method that provides a safe overload.
- */
-export interface GetBacklinksForFileSafeWrapper {
-    /**
-     * Retrieves the backlinks for a file safely.
-     *
-     * @param pathOrFile - The path or file object.
-     * @returns A {@link Promise} that resolves to an array dictionary of backlinks.
-     */
-    safe: (pathOrFile: PathOrFile) => Promise<CustomArrayDict<Reference>>;
-}
 /**
  * Options for {@link getCacheSafe}.
  */
@@ -217,7 +205,7 @@ export interface RegisterFileCacheForNonExistingFileParams {
 /**
  * The plugin id of the Advanced Metadata Cache plugin, the successor to Backlink Cache.
  *
- * Used by {@link hasBacklinkCachePlugin}. Note that {@link getBacklinksForFileSafe} does NOT need this id: it detects the cache by the {@link GetBacklinksForFileSafeWrapper.safe} overload grafted onto `MetadataCache.getBacklinksForFile`, which both plugins install and which names no plugin.
+ * Used by {@link hasBacklinkCachePlugin}, and as the provider id under which {@link getBacklinksForFileOrPath} and {@link getBacklinksForFileSafe} look up the plugin's published API.
  */
 export declare const ADVANCED_METADATA_CACHE_PLUGIN_ID = "advanced-metadata-cache";
 /**
@@ -239,10 +227,9 @@ export declare function ensureMetadataCacheReady(app: App): Promise<void>;
  * Retrieves the backlinks for a file or path.
  * NOTE: The file may be non-existent.
  *
- * When a backlink-cache plugin has grafted its {@link GetBacklinksForFileSafeWrapper.safe} overload onto
- * `MetadataCache.getBacklinksForFile`, that patched method answers. Otherwise the answer comes from a backlink
- * index whose cost is proportional to the candidate notes rather than to every reference in the vault, and which
- * gives the same references Obsidian's own `getBacklinksForFile` gives.
+ * When Advanced Metadata Cache publishes its backlinks API and its `Backlinks` module is on, its cache answers.
+ * Otherwise the answer comes from a backlink index whose cost is proportional to the candidate notes rather than
+ * to every reference in the vault, and which gives the same references Obsidian's own `getBacklinksForFile` gives.
  *
  * @param app - The Obsidian application instance.
  * @param pathOrFile - The path or file object.
@@ -252,7 +239,9 @@ export declare function getBacklinksForFileOrPath(app: App, pathOrFile: PathOrFi
 /**
  * Retrieves the backlinks for a file safely.
  *
- * This is NOT a pure read. When no backlink-cache plugin supplies the `safe` overload, it verifies
+ * When Advanced Metadata Cache publishes its backlinks API and its `Backlinks` module is on, that API answers.
+ *
+ * Otherwise this is NOT a pure read. It verifies
  * each backlink against the note's current text, and to do that it calls {@link saveNote} on every
  * note that links to the file, which saves any open editor view of those notes that has unsaved
  * changes. Call it from an explicit user action. Do not call it from an automatic trigger (a vault or
@@ -303,7 +292,7 @@ export declare function getLinks(params: GetLinksParams): Reference[];
 /**
  * Determines whether a backlink cache plugin is currently loaded - either Advanced Metadata Cache ({@link ADVANCED_METADATA_CACHE_PLUGIN_ID}) or its retired predecessor Backlink Cache ({@link BACKLINK_CACHE_PLUGIN_ID}).
  *
- * Such a plugin grafts a drain-on-read backlink index onto the metadata cache and indexes canvas metadata, so a caller that compensates for Obsidian's own gaps can stand down while one is present. Both ids are recognized; {@link BACKLINK_CACHE_PLUGIN_ID} records when the retired one may be dropped.
+ * Such a plugin keeps a drain-on-read backlink index and indexes canvas metadata, so a caller that compensates for Obsidian's own gaps can stand down while one is present. Both ids are recognized; {@link BACKLINK_CACHE_PLUGIN_ID} records when the retired one may be dropped.
  *
  * This reads the LOADED plugin instance rather than `app.plugins.enabledPlugins`, deliberately: the question is whether the plugin's patches are in place right now, and they are not until it has loaded. Plugins load in an unspecified order, so call this from a user-driven path rather than from plugin load - see rule L25 in `AGENTS.md`.
  *

package/dist/lib/cjs/plugin/index.cjs

@@ -144,6 +144,7 @@ var plugin_exports = {};
 __export(plugin_exports, {
   plugin: () => plugin,
   "plugin-api": () => plugin_api,
+  "plugin-api-schema": () => plugin_api_schema,
   "plugin-context": () => plugin_context,
   "plugin-event-source": () => plugin_event_source,
   "plugin-install-state": () => plugin_install_state,
@@ -152,6 +153,7 @@ __export(plugin_exports, {
   "settings-migration-api": () => settings_migration_api
 });
 module.exports = __toCommonJS(plugin_exports);
+var plugin_api_schema = __toESM(__extractDefault(require('./plugin-api-schema.cjs')), 1);
 var plugin_api = __toESM(__extractDefault(require('./plugin-api.cjs')), 1);
 var plugin_context = __toESM(__extractDefault(require('./plugin-context.cjs')), 1);
 var plugin_event_source = __toESM(__extractDefault(require('./plugin-event-source.cjs')), 1);
@@ -164,6 +166,7 @@ var settings_migration_api = __toESM(__extractDefault(require('./settings-migrat
 0 && (module.exports = {
   plugin,
   "plugin-api": null,
+  "plugin-api-schema": null,
   "plugin-context": null,
   "plugin-event-source": null,
   "plugin-install-state": null,
@@ -171,4 +174,4 @@ var settings_migration_api = __toESM(__extractDefault(require('./settings-migrat
   "plugin-settings-tab": null,
   "settings-migration-api": null
 });
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzICdwbHVnaW4tYXBpJyBmcm9tICcuL3BsdWdpbi1hcGkudHMnO1xuZXhwb3J0ICogYXMgJ3BsdWdpbi1jb250ZXh0JyBmcm9tICcuL3BsdWdpbi1jb250ZXh0LnRzJztcbmV4cG9ydCAqIGFzICdwbHVnaW4tZXZlbnQtc291cmNlJyBmcm9tICcuL3BsdWdpbi1ldmVudC1zb3VyY2UudHMnO1xuZXhwb3J0ICogYXMgJ3BsdWdpbi1pbnN0YWxsLXN0YXRlJyBmcm9tICcuL3BsdWdpbi1pbnN0YWxsLXN0YXRlLnRzJztcbmV4cG9ydCAqIGFzICdwbHVnaW4tbGlmZWN5Y2xlLWV2ZW50cycgZnJvbSAnLi9wbHVnaW4tbGlmZWN5Y2xlLWV2ZW50cy50cyc7XG5leHBvcnQgKiBhcyAncGx1Z2luLXNldHRpbmdzLXRhYicgZnJvbSAnLi9wbHVnaW4tc2V0dGluZ3MtdGFiLnRzJztcbmV4cG9ydCAqIGFzICdwbHVnaW4nIGZyb20gJy4vcGx1Z2luLnRzJztcbmV4cG9ydCAqIGFzICdzZXR0aW5ncy1taWdyYXRpb24tYXBpJyBmcm9tICcuL3NldHRpbmdzLW1pZ3JhdGlvbi1hcGkudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBLHNCQUFBQTtBQUFBLEVBQUEsd0JBQUFDO0FBQUEsRUFBQSw2QkFBQUM7QUFBQSxFQUFBLDhCQUFBQztBQUFBLEVBQUEsaUNBQUFDO0FBQUEsRUFBQSw2QkFBQUM7QUFBQSxFQUFBLGdDQUFBQztBQUFBO0FBQUE7QUFFQSxJQUFBTixhQUE4QjtBQUM5QixJQUFBQyxpQkFBa0M7QUFDbEMsSUFBQUMsc0JBQXVDO0FBQ3ZDLElBQUFDLHVCQUF3QztBQUN4QyxJQUFBQywwQkFBMkM7QUFDM0MsSUFBQUMsc0JBQXVDO0FBQ3ZDLGFBQTBCO0FBQzFCLElBQUFDLHlCQUEwQzsiLAogICJuYW1lcyI6IFsicGx1Z2luLWFwaSIsICJwbHVnaW4tY29udGV4dCIsICJwbHVnaW4tZXZlbnQtc291cmNlIiwgInBsdWdpbi1pbnN0YWxsLXN0YXRlIiwgInBsdWdpbi1saWZlY3ljbGUtZXZlbnRzIiwgInBsdWdpbi1zZXR0aW5ncy10YWIiLCAic2V0dGluZ3MtbWlncmF0aW9uLWFwaSJdCn0K
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzICdwbHVnaW4tYXBpLXNjaGVtYScgZnJvbSAnLi9wbHVnaW4tYXBpLXNjaGVtYS50cyc7XG5leHBvcnQgKiBhcyAncGx1Z2luLWFwaScgZnJvbSAnLi9wbHVnaW4tYXBpLnRzJztcbmV4cG9ydCAqIGFzICdwbHVnaW4tY29udGV4dCcgZnJvbSAnLi9wbHVnaW4tY29udGV4dC50cyc7XG5leHBvcnQgKiBhcyAncGx1Z2luLWV2ZW50LXNvdXJjZScgZnJvbSAnLi9wbHVnaW4tZXZlbnQtc291cmNlLnRzJztcbmV4cG9ydCAqIGFzICdwbHVnaW4taW5zdGFsbC1zdGF0ZScgZnJvbSAnLi9wbHVnaW4taW5zdGFsbC1zdGF0ZS50cyc7XG5leHBvcnQgKiBhcyAncGx1Z2luLWxpZmVjeWNsZS1ldmVudHMnIGZyb20gJy4vcGx1Z2luLWxpZmVjeWNsZS1ldmVudHMudHMnO1xuZXhwb3J0ICogYXMgJ3BsdWdpbi1zZXR0aW5ncy10YWInIGZyb20gJy4vcGx1Z2luLXNldHRpbmdzLXRhYi50cyc7XG5leHBvcnQgKiBhcyAncGx1Z2luJyBmcm9tICcuL3BsdWdpbi50cyc7XG5leHBvcnQgKiBhcyAnc2V0dGluZ3MtbWlncmF0aW9uLWFwaScgZnJvbSAnLi9zZXR0aW5ncy1taWdyYXRpb24tYXBpLnRzJztcbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQSxzQkFBQUE7QUFBQSxFQUFBLDJCQUFBQztBQUFBLEVBQUEsd0JBQUFDO0FBQUEsRUFBQSw2QkFBQUM7QUFBQSxFQUFBLDhCQUFBQztBQUFBLEVBQUEsaUNBQUFDO0FBQUEsRUFBQSw2QkFBQUM7QUFBQSxFQUFBLGdDQUFBQztBQUFBO0FBQUE7QUFFQSxJQUFBTixvQkFBcUM7QUFDckMsSUFBQUQsYUFBOEI7QUFDOUIsSUFBQUUsaUJBQWtDO0FBQ2xDLElBQUFDLHNCQUF1QztBQUN2QyxJQUFBQyx1QkFBd0M7QUFDeEMsSUFBQUMsMEJBQTJDO0FBQzNDLElBQUFDLHNCQUF1QztBQUN2QyxhQUEwQjtBQUMxQixJQUFBQyx5QkFBMEM7IiwKICAibmFtZXMiOiBbInBsdWdpbi1hcGkiLCAicGx1Z2luLWFwaS1zY2hlbWEiLCAicGx1Z2luLWNvbnRleHQiLCAicGx1Z2luLWV2ZW50LXNvdXJjZSIsICJwbHVnaW4taW5zdGFsbC1zdGF0ZSIsICJwbHVnaW4tbGlmZWN5Y2xlLWV2ZW50cyIsICJwbHVnaW4tc2V0dGluZ3MtdGFiIiwgInNldHRpbmdzLW1pZ3JhdGlvbi1hcGkiXQp9Cg==

package/dist/lib/cjs/plugin/index.d.cts

@@ -1,4 +1,5 @@
 /// <reference path="../library.d.cts" />
+export * as 'plugin-api-schema' from './plugin-api-schema.cjs';
 export * as 'plugin-api' from './plugin-api.cjs';
 export * as 'plugin-context' from './plugin-context.cjs';
 export * as 'plugin-event-source' from './plugin-event-source.cjs';

package/dist/lib/cjs/plugin/plugin-api-schema.cjs

@@ -0,0 +1,171 @@
+/*
+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 ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for("Symbol.asyncDispose");
+  symbolConstructor.dispose ??= symbolConstructor.for("Symbol.dispose");
+}
+
+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;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(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);
+    }
+    if (globalThis.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 plugin_api_schema_exports = {};
+__export(plugin_api_schema_exports, {
+  createArgumentsSchema: () => createArgumentsSchema,
+  createTypeGuardSchema: () => createTypeGuardSchema
+});
+module.exports = __toCommonJS(plugin_api_schema_exports);
+var import_object_utils = require('@mnaoumov/typescript-lib/object-utils');
+var import_library = require('../library.cjs');
+function createArgumentsSchema(parameters) {
+  const parameterList = (0, import_object_utils.castTo)(parameters);
+  return createSchema((value) => {
+    if (!Array.isArray(value)) {
+      return { issues: [{ message: "Expected an argument list." }] };
+    }
+    if (value.length > parameterList.length) {
+      return { issues: [{ message: `Expected at most ${String(parameterList.length)} argument(s), got ${String(value.length)}.` }] };
+    }
+    const issues = parameterList.flatMap((parameter, index) => parameter.typeGuard(value[index]) ? [] : [{ message: `Expected ${parameter.expected}.`, path: [index] }]);
+    return issues.length === 0 ? { value: (0, import_object_utils.castTo)(value) } : { issues };
+  });
+}
+function createTypeGuardSchema(params) {
+  return createSchema((value) => params.typeGuard(value) ? { value } : { issues: [{ message: `Expected ${params.expected}.` }] });
+}
+function createSchema(validate) {
+  return {
+    "~standard": {
+      validate,
+      vendor: import_library.OBSIDIAN_LIBRARY_NAME,
+      version: 1
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createArgumentsSchema,
+  createTypeGuardSchema
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3BsdWdpbi9wbHVnaW4tYXBpLXNjaGVtYS50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIERlcGVuZGVuY3ktZnJlZSB7QGxpbmsgaHR0cHM6Ly9zdGFuZGFyZHNjaGVtYS5kZXYgfCBTdGFuZGFyZCBTY2hlbWF9IGJ1aWxkZXJzIGZvciB0aGUgcGF5bG9hZCBoYWx2ZXMgb2YgYVxuICogYFBsdWdpbkFwaUNvbnRyYWN0YC5cbiAqXG4gKiBBIGNvbnRyYWN0J3Mgc2NoZW1hcyBjcm9zcyB0aGUgcmVnaXN0cnkgaW5zaWRlIHRoZSBwcm92aWRlcidzIHJlY29yZCBhbmQgcnVuIGluc2lkZSB3aGljaGV2ZXIgbGlicmFyeSBjb3B5XG4gKiBtYWRlIHRoZSBjYWxsLCBzbyB0aGV5IGFyZSBwbGFpbiBvYmplY3RzIG92ZXIgcGxhaW4gZnVuY3Rpb25zIFx1MjAxNCB3aGljaCBhIHR5cGUgZ3VhcmQgYWxyZWFkeSBpcy4gVGhlc2UgYnVpbGRlcnNcbiAqIHR1cm4gdGhlIGd1YXJkcyBhIG1vZHVsZSBhbHJlYWR5IGhhcyBpbnRvIHRoZSB0d28gc2hhcGVzIGEgbWV0aG9kIGNvbnRyYWN0IG5lZWRzOiBvbmUgdmFsdWUgKGFuIG91dHB1dCkgYW5kXG4gKiBvbmUgYXJndW1lbnQgbGlzdCAoYW4gaW5wdXQpLiB6b2QgLyB2YWxpYm90IC8gYXJrdHlwZSBzY2hlbWFzIHBsdWcgaW50byB0aGUgc2FtZSBzbG90cyB1bmNoYW5nZWQ7IHRoaXMgbGlicmFyeVxuICoganVzdCBkb2VzIG5vdCBtYWtlIGV2ZXJ5IGNvbnN1bWVyIGJ1bmRsZSBvbmUgdG8gZGVzY3JpYmUgdHdvIGFyZ3VtZW50cy5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IFN0YW5kYXJkU2NoZW1hVjEgfSBmcm9tICdAc3RhbmRhcmQtc2NoZW1hL3NwZWMnO1xuXG5pbXBvcnQgeyBjYXN0VG8gfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvb2JqZWN0LXV0aWxzJztcblxuaW1wb3J0IHsgT0JTSURJQU5fTElCUkFSWV9OQU1FIH0gZnJvbSAnLi4vbGlicmFyeS50cyc7XG5cbi8qKlxuICogT25lIHR5cGUgZ3VhcmQgcGVyIHBhcmFtZXRlciBvZiBhIG1ldGhvZCwgaW4gb3JkZXIuXG4gKlxuICogQHR5cGVQYXJhbSBUUGFyYW1ldGVycyAtIFRoZSBtZXRob2QncyBwYXJhbWV0ZXJzLlxuICovXG5leHBvcnQgdHlwZSBBcmd1bWVudFR5cGVHdWFyZHM8VFBhcmFtZXRlcnMgZXh0ZW5kcyByZWFkb25seSB1bmtub3duW10+ID0ge1xuICByZWFkb25seSBbVEluZGV4IGluIGtleW9mIFRQYXJhbWV0ZXJzXTogQ3JlYXRlVHlwZUd1YXJkU2NoZW1hUGFyYW1zPFRQYXJhbWV0ZXJzW1RJbmRleF0+O1xufTtcblxuLyoqXG4gKiBPbmUgdmFsdWUgYSBzY2hlbWEgYWNjZXB0cywgZGVzY3JpYmVkIGJ5IGEgdHlwZSBndWFyZC5cbiAqXG4gKiBAdHlwZVBhcmFtIFQgLSBUaGUgdHlwZSB0aGUgZ3VhcmQgbmFycm93cyB0by5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBDcmVhdGVUeXBlR3VhcmRTY2hlbWFQYXJhbXM8VD4ge1xuICAvKipcbiAgICogV2hhdCB0aGUgdmFsdWUgc2hvdWxkIGhhdmUgYmVlbiwgcGhyYXNlZCB0byBmb2xsb3cgXCJFeHBlY3RlZFwiLCBlLmcuIGAnYSBzdHJpbmcnYC5cbiAgICovXG4gIHJlYWRvbmx5IGV4cGVjdGVkOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIERlY2lkZXMgd2hldGhlciB0aGUgdmFsdWUgaXMgYWNjZXB0YWJsZS5cbiAgICpcbiAgICogQHBhcmFtIHZhbHVlIC0gVGhlIHZhbHVlIHRvIGNoZWNrLlxuICAgKiBAcmV0dXJucyBXaGV0aGVyIHRoZSB2YWx1ZSBpcyBhIGBUYC5cbiAgICovXG4gIHJlYWRvbmx5IHR5cGVHdWFyZDogKHZhbHVlOiB1bmtub3duKSA9PiB2YWx1ZSBpcyBUO1xufVxuXG4vKipcbiAqIEJ1aWxkcyB0aGUgaW5wdXQgc2NoZW1hIG9mIGEgbWV0aG9kIGNvbnRyYWN0OiBhIHNjaGVtYSBvdmVyIHRoZSBtZXRob2QncyBBUkdVTUVOVCBMSVNULCBvbmUgdHlwZSBndWFyZCBwZXJcbiAqIHBhcmFtZXRlci4gQW4gYXJndW1lbnQgdGhhdCBmYWlscyBpdHMgZ3VhcmQgaXMgcmVwb3J0ZWQgd2l0aCBpdHMgaW5kZXggYXMgdGhlIGlzc3VlIHBhdGgsIGFuZCBhbiBhcmd1bWVudFxuICogbGlzdCBsb25nZXIgdGhhbiB0aGUgcGFyYW1ldGVyIGxpc3QgaXMgcmVmdXNlZC4gQSBtaXNzaW5nIGFyZ3VtZW50IHJlYWNoZXMgaXRzIGd1YXJkIGFzIGB1bmRlZmluZWRgLCBzbyBhblxuICogb3B0aW9uYWwgcGFyYW1ldGVyJ3MgZ3VhcmQgYWNjZXB0cyBgdW5kZWZpbmVkYC5cbiAqXG4gKiBAdHlwZVBhcmFtIFRQYXJhbWV0ZXJzIC0gVGhlIG1ldGhvZCdzIHBhcmFtZXRlcnMsIGluZmVycmVkIGZyb20gdGhlIGd1YXJkcy5cbiAqIEBwYXJhbSBwYXJhbWV0ZXJzIC0gT25lIGd1YXJkIHBlciBwYXJhbWV0ZXIsIGluIG9yZGVyLlxuICogQHJldHVybnMgVGhlIHNjaGVtYS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGNyZWF0ZUFyZ3VtZW50c1NjaGVtYTxUUGFyYW1ldGVycyBleHRlbmRzIHJlYWRvbmx5IHVua25vd25bXT4oXG4gIHBhcmFtZXRlcnM6IEFyZ3VtZW50VHlwZUd1YXJkczxUUGFyYW1ldGVycz5cbik6IFN0YW5kYXJkU2NoZW1hVjE8dW5rbm93biwgVFBhcmFtZXRlcnM+IHtcbiAgY29uc3QgcGFyYW1ldGVyTGlzdCA9IGNhc3RUbzxyZWFkb25seSBDcmVhdGVUeXBlR3VhcmRTY2hlbWFQYXJhbXM8dW5rbm93bj5bXT4ocGFyYW1ldGVycyk7XG4gIHJldHVybiBjcmVhdGVTY2hlbWEoKHZhbHVlOiB1bmtub3duKTogU3RhbmRhcmRTY2hlbWFWMS5SZXN1bHQ8VFBhcmFtZXRlcnM+ID0+IHtcbiAgICBpZiAoIUFycmF5LmlzQXJyYXkodmFsdWUpKSB7XG4gICAgICByZXR1cm4geyBpc3N1ZXM6IFt7IG1lc3NhZ2U6ICdFeHBlY3RlZCBhbiBhcmd1bWVudCBsaXN0LicgfV0gfTtcbiAgICB9XG5cbiAgICBpZiAodmFsdWUubGVuZ3RoID4gcGFyYW1ldGVyTGlzdC5sZW5ndGgpIHtcbiAgICAgIHJldHVybiB7IGlzc3VlczogW3sgbWVzc2FnZTogYEV4cGVjdGVkIGF0IG1vc3QgJHtTdHJpbmcocGFyYW1ldGVyTGlzdC5sZW5ndGgpfSBhcmd1bWVudChzKSwgZ290ICR7U3RyaW5nKHZhbHVlLmxlbmd0aCl9LmAgfV0gfTtcbiAgICB9XG5cbiAgICBjb25zdCBpc3N1ZXMgPSBwYXJhbWV0ZXJMaXN0LmZsYXRNYXAoKHBhcmFtZXRlciwgaW5kZXgpOiBTdGFuZGFyZFNjaGVtYVYxLklzc3VlW10gPT4gcGFyYW1ldGVyLnR5cGVHdWFyZCh2YWx1ZVtpbmRleF0pID8gW10gOiBbeyBtZXNzYWdlOiBgRXhwZWN0ZWQgJHtwYXJhbWV0ZXIuZXhwZWN0ZWR9LmAsIHBhdGg6IFtpbmRleF0gfV0pO1xuICAgIHJldHVybiBpc3N1ZXMubGVuZ3RoID09PSAwID8geyB2YWx1ZTogY2FzdFRvPFRQYXJhbWV0ZXJzPih2YWx1ZSkgfSA6IHsgaXNzdWVzIH07XG4gIH0pO1xufVxuXG4vKipcbiAqIEJ1aWxkcyBhIHNjaGVtYSBvdmVyIG9uZSB2YWx1ZSBmcm9tIGEgdHlwZSBndWFyZCBcdTIwMTQgdGhlIG91dHB1dCBzY2hlbWEgb2YgYSBtZXRob2QgY29udHJhY3QsIHR5cGljYWxseS5cbiAqXG4gKiBAdHlwZVBhcmFtIFQgLSBUaGUgdHlwZSB0aGUgZ3VhcmQgbmFycm93cyB0by5cbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgZ3VhcmQgYW5kIHdoYXQgaXQgZXhwZWN0cy5cbiAqIEByZXR1cm5zIFRoZSBzY2hlbWEuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBjcmVhdGVUeXBlR3VhcmRTY2hlbWE8VD4ocGFyYW1zOiBDcmVhdGVUeXBlR3VhcmRTY2hlbWFQYXJhbXM8VD4pOiBTdGFuZGFyZFNjaGVtYVYxPHVua25vd24sIFQ+IHtcbiAgcmV0dXJuIGNyZWF0ZVNjaGVtYSgodmFsdWU6IHVua25vd24pOiBTdGFuZGFyZFNjaGVtYVYxLlJlc3VsdDxUPiA9PiBwYXJhbXMudHlwZUd1YXJkKHZhbHVlKSA/IHsgdmFsdWUgfSA6IHsgaXNzdWVzOiBbeyBtZXNzYWdlOiBgRXhwZWN0ZWQgJHtwYXJhbXMuZXhwZWN0ZWR9LmAgfV0gfSk7XG59XG5cbmZ1bmN0aW9uIGNyZWF0ZVNjaGVtYTxUPih2YWxpZGF0ZTogKHZhbHVlOiB1bmtub3duKSA9PiBTdGFuZGFyZFNjaGVtYVYxLlJlc3VsdDxUPik6IFN0YW5kYXJkU2NoZW1hVjE8dW5rbm93biwgVD4ge1xuICByZXR1cm4ge1xuICAgICd+c3RhbmRhcmQnOiB7XG4gICAgICB2YWxpZGF0ZSxcbiAgICAgIHZlbmRvcjogT0JTSURJQU5fTElCUkFSWV9OQU1FLFxuICAgICAgdmVyc2lvbjogMVxuICAgIH1cbiAgfTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQWVBLDBCQUF1QjtBQUV2QixxQkFBc0M7QUF5Qy9CLFNBQVMsc0JBQ2QsWUFDd0M7QUFDeEMsUUFBTSxvQkFBZ0IsNEJBQXdELFVBQVU7QUFDeEYsU0FBTyxhQUFhLENBQUMsVUFBeUQ7QUFDNUUsUUFBSSxDQUFDLE1BQU0sUUFBUSxLQUFLLEdBQUc7QUFDekIsYUFBTyxFQUFFLFFBQVEsQ0FBQyxFQUFFLFNBQVMsNkJBQTZCLENBQUMsRUFBRTtBQUFBLElBQy9EO0FBRUEsUUFBSSxNQUFNLFNBQVMsY0FBYyxRQUFRO0FBQ3ZDLGFBQU8sRUFBRSxRQUFRLENBQUMsRUFBRSxTQUFTLG9CQUFvQixPQUFPLGNBQWMsTUFBTSxDQUFDLHFCQUFxQixPQUFPLE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxFQUFFO0FBQUEsSUFDL0g7QUFFQSxVQUFNLFNBQVMsY0FBYyxRQUFRLENBQUMsV0FBVyxVQUFvQyxVQUFVLFVBQVUsTUFBTSxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLFNBQVMsWUFBWSxVQUFVLFFBQVEsS0FBSyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQztBQUM3TCxXQUFPLE9BQU8sV0FBVyxJQUFJLEVBQUUsV0FBTyw0QkFBb0IsS0FBSyxFQUFFLElBQUksRUFBRSxPQUFPO0FBQUEsRUFDaEYsQ0FBQztBQUNIO0FBU08sU0FBUyxzQkFBeUIsUUFBc0U7QUFDN0csU0FBTyxhQUFhLENBQUMsVUFBK0MsT0FBTyxVQUFVLEtBQUssSUFBSSxFQUFFLE1BQU0sSUFBSSxFQUFFLFFBQVEsQ0FBQyxFQUFFLFNBQVMsWUFBWSxPQUFPLFFBQVEsSUFBSSxDQUFDLEVBQUUsQ0FBQztBQUNySztBQUVBLFNBQVMsYUFBZ0IsVUFBd0Y7QUFDL0csU0FBTztBQUFBLElBQ0wsYUFBYTtBQUFBLE1BQ1g7QUFBQSxNQUNBLFFBQVE7QUFBQSxNQUNSLFNBQVM7QUFBQSxJQUNYO0FBQUEsRUFDRjtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/cjs/plugin/plugin-api-schema.d.cts

@@ -0,0 +1,59 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Dependency-free {@link https://standardschema.dev | Standard Schema} builders for the payload halves of a
+ * `PluginApiContract`.
+ *
+ * A contract's schemas cross the registry inside the provider's record and run inside whichever library copy
+ * made the call, so they are plain objects over plain functions — which a type guard already is. These builders
+ * turn the guards a module already has into the two shapes a method contract needs: one value (an output) and
+ * one argument list (an input). zod / valibot / arktype schemas plug into the same slots unchanged; this library
+ * just does not make every consumer bundle one to describe two arguments.
+ */
+import type { StandardSchemaV1 } from '@standard-schema/spec' with { 'resolution-mode': 'import' };
+/**
+ * One type guard per parameter of a method, in order.
+ *
+ * @typeParam TParameters - The method's parameters.
+ */
+export type ArgumentTypeGuards<TParameters extends readonly unknown[]> = {
+    readonly [TIndex in keyof TParameters]: CreateTypeGuardSchemaParams<TParameters[TIndex]>;
+};
+/**
+ * One value a schema accepts, described by a type guard.
+ *
+ * @typeParam T - The type the guard narrows to.
+ */
+export interface CreateTypeGuardSchemaParams<T> {
+    /**
+     * What the value should have been, phrased to follow "Expected", e.g. `'a string'`.
+     */
+    readonly expected: string;
+    /**
+     * Decides whether the value is acceptable.
+     *
+     * @param value - The value to check.
+     * @returns Whether the value is a `T`.
+     */
+    readonly typeGuard: (value: unknown) => value is T;
+}
+/**
+ * Builds the input schema of a method contract: a schema over the method's ARGUMENT LIST, one type guard per
+ * parameter. An argument that fails its guard is reported with its index as the issue path, and an argument
+ * list longer than the parameter list is refused. A missing argument reaches its guard as `undefined`, so an
+ * optional parameter's guard accepts `undefined`.
+ *
+ * @typeParam TParameters - The method's parameters, inferred from the guards.
+ * @param parameters - One guard per parameter, in order.
+ * @returns The schema.
+ */
+export declare function createArgumentsSchema<TParameters extends readonly unknown[]>(parameters: ArgumentTypeGuards<TParameters>): StandardSchemaV1<unknown, TParameters>;
+/**
+ * Builds a schema over one value from a type guard — the output schema of a method contract, typically.
+ *
+ * @typeParam T - The type the guard narrows to.
+ * @param params - The guard and what it expects.
+ * @returns The schema.
+ */
+export declare function createTypeGuardSchema<T>(params: CreateTypeGuardSchemaParams<T>): StandardSchemaV1<unknown, T>;