@mnaoumov/obsidian-lib 10.5.1 → 10.7.0

package/dist/lib/cjs/request-url.d.cts

@@ -0,0 +1,233 @@
+/// <reference path="./library-references.d.cts" />
+/// <reference lib="dom" />
+/// <reference lib="dom.iterable" />
+/**
+ * @file
+ *
+ * A wrapper over Obsidian's {@link requestUrl} that fills the gaps plugins keep hand-rolling: an abort signal and a
+ * timeout, request bodies beyond `string | ArrayBuffer` (`FormData`, `URLSearchParams`, `Blob`, typed arrays and
+ * streams), an error that carries the status and the body, an up-front protocol check, a streamed response body, and
+ * a `fetch`-compatible adapter that third-party SDKs can take.
+ *
+ * `requestUrl` itself cannot be cancelled: an abort or a timeout settles the returned promise at once, while the
+ * underlying request runs to completion and its result is dropped. The streamed variant really cancels on desktop,
+ * where it goes through `node:http` / `node:https`; that module is imported dynamically, so this one stays
+ * cross-platform-loadable. On mobile the streamed variant falls back to `requestUrl` and delivers the whole body as a
+ * single chunk.
+ */
+import type { RequestUrlResponse } from 'obsidian' with { 'resolution-mode': 'import' };
+/**
+ * Options for {@link createRequestUrlFetch}.
+ */
+export interface CreateRequestUrlFetchOptions {
+    /**
+     * Whether to stream the response body through {@link requestUrlStream} rather than buffer it. Streaming is real on
+     * desktop only; on mobile the body still arrives as one chunk. Defaults to `false`.
+     */
+    readonly shouldStream?: boolean;
+    /**
+     * The timeout in milliseconds applied to every request, on top of the request's own `signal`.
+     */
+    readonly timeoutInMilliseconds?: number;
+}
+/**
+ * The request in the form the transports take: validated, with the body encoded.
+ */
+export interface EncodedRequestUrlRequest {
+    /**
+     * Aborts the request.
+     */
+    readonly abortSignal: AbortSignal;
+    /**
+     * The encoded body.
+     */
+    readonly body?: ArrayBuffer | string;
+    /**
+     * The request headers, including the content type.
+     */
+    readonly headers: Readonly<Record<string, string>>;
+    /**
+     * The HTTP method, uppercase.
+     */
+    readonly method: string;
+    /**
+     * The URL.
+     */
+    readonly url: string;
+}
+/**
+ * Parameters for {@link encodeRequestUrlRequest}.
+ */
+export type EncodeRequestUrlRequestParams = RequestUrlExParams;
+/**
+ * Parameters for the {@link RequestUrlError} constructor.
+ */
+export interface RequestUrlErrorConstructorParams {
+    /**
+     * The response headers.
+     */
+    readonly headers: Readonly<Record<string, string>>;
+    /**
+     * The HTTP method.
+     */
+    readonly method: string;
+    /**
+     * The status code.
+     */
+    readonly status: number;
+    /**
+     * The response body as text.
+     */
+    readonly text: string;
+    /**
+     * The URL.
+     */
+    readonly url: string;
+}
+/**
+ * A request body {@link requestUrlEx} accepts: everything `fetch` accepts.
+ */
+export type RequestUrlExBody = ArrayBuffer | ArrayBufferView | Blob | FormData | ReadableStream<Uint8Array> | string | URLSearchParams;
+/**
+ * Parameters for {@link requestUrlEx}.
+ */
+export interface RequestUrlExParams {
+    /**
+     * Aborts the request. The promise rejects with the signal's reason.
+     */
+    readonly abortSignal?: AbortSignal | undefined;
+    /**
+     * The request body.
+     */
+    readonly body?: RequestUrlExBody | undefined;
+    /**
+     * The content type. When omitted, it is derived from the body: a `FormData` body gets `multipart/form-data` with its
+     * boundary, a `URLSearchParams` body `application/x-www-form-urlencoded` and a `Blob` body its own type — unless
+     * {@link RequestUrlExParams.headers} already carries a `Content-Type`.
+     */
+    readonly contentType?: string | undefined;
+    /**
+     * The request headers.
+     */
+    readonly headers?: Readonly<Record<string, string>> | undefined;
+    /**
+     * The HTTP method. Defaults to `GET`.
+     */
+    readonly method?: string | undefined;
+    /**
+     * Whether to throw a {@link RequestUrlError} when the status code is 400 or higher. Defaults to `true`.
+     */
+    readonly shouldThrowOnHttpError?: boolean | undefined;
+    /**
+     * The timeout in milliseconds. The promise rejects with a `TimeoutError` {@link DOMException} once it elapses.
+     */
+    readonly timeoutInMilliseconds?: number | undefined;
+    /**
+     * The URL. Only `http:` and `https:` URLs are accepted.
+     */
+    readonly url: string;
+}
+/**
+ * A `fetch`-compatible function built on {@link requestUrl}.
+ */
+export type RequestUrlFetch = (input: Request | string | URL, init?: RequestInit) => Promise<Response>;
+/**
+ * Parameters for {@link requestUrlStream}.
+ */
+export type RequestUrlStreamParams = RequestUrlExParams;
+/**
+ * The response of {@link requestUrlStream}.
+ */
+export interface RequestUrlStreamResponse {
+    /**
+     * The response body.
+     */
+    readonly body: ReadableStream<Uint8Array>;
+    /**
+     * The response headers, with lowercase names.
+     */
+    readonly headers: Readonly<Record<string, string>>;
+    /**
+     * The status code.
+     */
+    readonly status: number;
+    /**
+     * The final URL, after any redirects.
+     */
+    readonly url: string;
+}
+/**
+ * The error {@link requestUrlEx} and {@link requestUrlStream} throw for a status code of 400 or higher.
+ */
+export declare class RequestUrlError extends Error {
+    /**
+     * The response headers.
+     */
+    readonly headers: Readonly<Record<string, string>>;
+    /**
+     * The HTTP method.
+     */
+    readonly method: string;
+    /**
+     * The status code.
+     */
+    readonly status: number;
+    /**
+     * The response body as text.
+     */
+    readonly text: string;
+    /**
+     * The URL.
+     */
+    readonly url: string;
+    /**
+     * Creates a {@link RequestUrlError}.
+     *
+     * @param params - The failed request and its response.
+     */
+    constructor(params: RequestUrlErrorConstructorParams);
+    /**
+     * Parses the response body as JSON.
+     *
+     * @returns The parsed body.
+     */
+    json(): unknown;
+}
+/**
+ * Creates a `fetch`-compatible function built on {@link requestUrl}, for SDKs that take a custom `fetch` (OpenAI,
+ * LangChain, OAuth clients) and would otherwise hit CORS.
+ *
+ * Unlike `fetch`, it never rejects on an HTTP error status: it resolves with a {@link Response} carrying that status,
+ * exactly as `fetch` does. It rejects with a `TypeError` for a URL that is not `http:` or `https:`.
+ *
+ * @param options - The options.
+ * @returns The `fetch`-compatible function.
+ */
+export declare function createRequestUrlFetch(options?: CreateRequestUrlFetchOptions): RequestUrlFetch;
+/**
+ * Encodes a request for a transport: validates the URL, combines the abort signal with the timeout, encodes the body
+ * and settles the content type.
+ *
+ * @param params - The request.
+ * @returns The encoded request.
+ */
+export declare function encodeRequestUrlRequest(params: EncodeRequestUrlRequestParams): Promise<EncodedRequestUrlRequest>;
+/**
+ * Requests a URL through {@link requestUrl}, with an abort signal, a timeout, richer bodies, a protocol check and a
+ * {@link RequestUrlError} for an HTTP error status.
+ *
+ * @param params - The request.
+ * @returns The response.
+ */
+export declare function requestUrlEx(params: RequestUrlExParams): Promise<RequestUrlResponse>;
+/**
+ * Requests a URL and returns its body as a stream.
+ *
+ * On desktop the request goes through `node:http` / `node:https`, so the body streams as it arrives, an abort really
+ * cancels the request, and redirects are followed. On mobile it falls back to {@link requestUrl}, and the whole body
+ * arrives as a single chunk.
+ *
+ * @param params - The request.
+ * @returns The response, with a streamed body.
+ */
+export declare function requestUrlStream(params: RequestUrlStreamParams): Promise<RequestUrlStreamResponse>;

package/dist/lib/cjs/setting-components/folder-list-component.cjs

@@ -0,0 +1,216 @@
+/*
+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 folder_list_component_exports = {};
+__export(folder_list_component_exports, {
+  FolderInputSuggest: () => FolderInputSuggest,
+  FolderListComponent: () => FolderListComponent
+});
+module.exports = __toCommonJS(folder_list_component_exports);
+var import_obsidian = require('obsidian');
+var import_css_class = require('../css-class.cjs');
+var import_list_component = require('./list-component.cjs');
+class FolderInputSuggest extends import_obsidian.AbstractInputSuggest {
+  /**
+   * The input the suggest completes.
+   */
+  inputEl;
+  /**
+   * Creates a new folder suggest.
+   *
+   * @param app - The Obsidian app.
+   * @param inputEl - The input.
+   */
+  constructor(app, inputEl) {
+    super(app, inputEl);
+    this.inputEl = inputEl;
+  }
+  /**
+   * Renders a folder.
+   *
+   * @param folder - The folder.
+   * @param el - The element to render into.
+   */
+  renderSuggestion(folder, el) {
+    el.setText(getFolderDisplayPath(folder));
+  }
+  /**
+   * Puts the folder path into the input, dispatches an `input` event, then calls the `onSelect` callback.
+   *
+   * @param folder - The folder.
+   * @param $event - The event that picked it.
+   */
+  selectSuggestion(folder, $event) {
+    this.setValue(getFolderDisplayPath(folder));
+    this.inputEl.dispatchEvent(new Event("input", { bubbles: true }));
+    super.selectSuggestion(folder, $event);
+    this.close();
+  }
+  /**
+   * Gets the folders matching the typed text.
+   *
+   * @param query - The typed text.
+   * @returns The folders, best match first.
+   */
+  getSuggestions(query) {
+    const fuzzySearch = (0, import_obsidian.prepareFuzzySearch)(query.trim());
+    const results = [];
+    for (const folder of this.app.vault.getAllFolders(true)) {
+      const match = fuzzySearch(getFolderDisplayPath(folder));
+      if (match) {
+        results.push({ folder, score: match.score });
+      }
+    }
+    results.sort((result1, result2) => result2.score - result1.score);
+    return results.map((result) => result.folder);
+  }
+}
+class FolderListComponent extends import_list_component.ListComponent {
+  /**
+   * The folder suggest attached to {@link ListComponent.newItemInputEl}.
+   */
+  suggest;
+  /**
+   * Creates a new folder list component.
+   *
+   * @param containerEl - The container element.
+   * @param app - The Obsidian app.
+   */
+  constructor(containerEl, app) {
+    super(containerEl, import_css_class.CssClass.FolderListComponent);
+    this.suggest = new FolderInputSuggest(app, this.newItemInputEl);
+    this.suggest.onSelect(() => {
+      this.addTypedItem();
+    });
+  }
+  /**
+   * Normalizes a typed folder path.
+   *
+   * @param text - The typed text.
+   * @returns The normalized path, or `null` for empty text.
+   */
+  normalizeItem(text) {
+    const path = text.trim();
+    return path ? (0, import_obsidian.normalizePath)(path) : null;
+  }
+}
+function getFolderDisplayPath(folder) {
+  return folder.isRoot() ? "/" : folder.path;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FolderInputSuggest,
+  FolderListComponent
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9zZXR0aW5nLWNvbXBvbmVudHMvZm9sZGVyLWxpc3QtY29tcG9uZW50LnRzIl0sInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBDb250YWlucyBhIGNvbXBvbmVudCB0aGF0IGVkaXRzIGEgcmVvcmRlcmFibGUgbGlzdCBvZiBmb2xkZXJzLCB3aXRoIGEgZm9sZGVyIHN1Z2dlc3QuXG4gKi9cblxuaW1wb3J0IHR5cGUge1xuICBBcHAsXG4gIFRGb2xkZXJcbn0gZnJvbSAnb2JzaWRpYW4nO1xuXG5pbXBvcnQge1xuICBBYnN0cmFjdElucHV0U3VnZ2VzdCxcbiAgbm9ybWFsaXplUGF0aCxcbiAgcHJlcGFyZUZ1enp5U2VhcmNoXG59IGZyb20gJ29ic2lkaWFuJztcblxuLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFycyAtLSBXZSBuZWVkIHRvIGltcG9ydCBgU2V0dGluZ0V4YCB0byB1c2UgaXQgaW4gdGhlIHRzZG9jcy5cbmltcG9ydCB0eXBlIHsgU2V0dGluZ0V4IH0gZnJvbSAnLi4vc2V0dGluZy1leC50cyc7XG5cbmltcG9ydCB7IENzc0NsYXNzIH0gZnJvbSAnLi4vY3NzLWNsYXNzLnRzJztcbmltcG9ydCB7IExpc3RDb21wb25lbnQgfSBmcm9tICcuL2xpc3QtY29tcG9uZW50LnRzJztcblxuaW50ZXJmYWNlIEZvbGRlck1hdGNoIHtcbiAgcmVhZG9ubHkgZm9sZGVyOiBURm9sZGVyO1xuICByZWFkb25seSBzY29yZTogbnVtYmVyO1xufVxuXG4vKipcbiAqIFN1Z2dlc3RzIHRoZSB2YXVsdCdzIGZvbGRlcnMsIHRoZSByb290IGluY2x1ZGVkLCBpbiBhbiBgPGlucHV0PmAsIG1hdGNoaW5nIHRoZSB0eXBlZCB0ZXh0IGFnYWluc3QgdGhlIGZvbGRlciBwYXRoLlxuICovXG5leHBvcnQgY2xhc3MgRm9sZGVySW5wdXRTdWdnZXN0IGV4dGVuZHMgQWJzdHJhY3RJbnB1dFN1Z2dlc3Q8VEZvbGRlcj4ge1xuICAvKipcbiAgICogVGhlIGlucHV0IHRoZSBzdWdnZXN0IGNvbXBsZXRlcy5cbiAgICovXG4gIHByb3RlY3RlZCByZWFkb25seSBpbnB1dEVsOiBIVE1MSW5wdXRFbGVtZW50O1xuXG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IGZvbGRlciBzdWdnZXN0LlxuICAgKlxuICAgKiBAcGFyYW0gYXBwIC0gVGhlIE9ic2lkaWFuIGFwcC5cbiAgICogQHBhcmFtIGlucHV0RWwgLSBUaGUgaW5wdXQuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IoYXBwOiBBcHAsIGlucHV0RWw6IEhUTUxJbnB1dEVsZW1lbnQpIHtcbiAgICBzdXBlcihhcHAsIGlucHV0RWwpO1xuICAgIHRoaXMuaW5wdXRFbCA9IGlucHV0RWw7XG4gIH1cblxuICAvKipcbiAgICogUmVuZGVycyBhIGZvbGRlci5cbiAgICpcbiAgICogQHBhcmFtIGZvbGRlciAtIFRoZSBmb2xkZXIuXG4gICAqIEBwYXJhbSBlbCAtIFRoZSBlbGVtZW50IHRvIHJlbmRlciBpbnRvLlxuICAgKi9cbiAgcHVibGljIHJlbmRlclN1Z2dlc3Rpb24oZm9sZGVyOiBURm9sZGVyLCBlbDogSFRNTEVsZW1lbnQpOiB2b2lkIHtcbiAgICBlbC5zZXRUZXh0KGdldEZvbGRlckRpc3BsYXlQYXRoKGZvbGRlcikpO1xuICB9XG5cbiAgLyoqXG4gICAqIFB1dHMgdGhlIGZvbGRlciBwYXRoIGludG8gdGhlIGlucHV0LCBkaXNwYXRjaGVzIGFuIGBpbnB1dGAgZXZlbnQsIHRoZW4gY2FsbHMgdGhlIGBvblNlbGVjdGAgY2FsbGJhY2suXG4gICAqXG4gICAqIEBwYXJhbSBmb2xkZXIgLSBUaGUgZm9sZGVyLlxuICAgKiBAcGFyYW0gJGV2ZW50IC0gVGhlIGV2ZW50IHRoYXQgcGlja2VkIGl0LlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHNlbGVjdFN1Z2dlc3Rpb24oZm9sZGVyOiBURm9sZGVyLCAkZXZlbnQ6IEtleWJvYXJkRXZlbnQgfCBNb3VzZUV2ZW50KTogdm9pZCB7XG4gICAgdGhpcy5zZXRWYWx1ZShnZXRGb2xkZXJEaXNwbGF5UGF0aChmb2xkZXIpKTtcbiAgICB0aGlzLmlucHV0RWwuZGlzcGF0Y2hFdmVudChuZXcgRXZlbnQoJ2lucHV0JywgeyBidWJibGVzOiB0cnVlIH0pKTtcbiAgICBzdXBlci5zZWxlY3RTdWdnZXN0aW9uKGZvbGRlciwgJGV2ZW50KTtcbiAgICB0aGlzLmNsb3NlKCk7XG4gIH1cblxuICAvKipcbiAgICogR2V0cyB0aGUgZm9sZGVycyBtYXRjaGluZyB0aGUgdHlwZWQgdGV4dC5cbiAgICpcbiAgICogQHBhcmFtIHF1ZXJ5IC0gVGhlIHR5cGVkIHRleHQuXG4gICAqIEByZXR1cm5zIFRoZSBmb2xkZXJzLCBiZXN0IG1hdGNoIGZpcnN0LlxuICAgKi9cbiAgcHJvdGVjdGVkIG92ZXJyaWRlIGdldFN1Z2dlc3Rpb25zKHF1ZXJ5OiBzdHJpbmcpOiBURm9sZGVyW10ge1xuICAgIGNvbnN0IGZ1enp5U2VhcmNoID0gcHJlcGFyZUZ1enp5U2VhcmNoKHF1ZXJ5LnRyaW0oKSk7XG4gICAgY29uc3QgcmVzdWx0czogRm9sZGVyTWF0Y2hbXSA9IFtdO1xuICAgIGZvciAoY29uc3QgZm9sZGVyIG9mIHRoaXMuYXBwLnZhdWx0LmdldEFsbEZvbGRlcnModHJ1ZSkpIHtcbiAgICAgIGNvbnN0IG1hdGNoID0gZnV6enlTZWFyY2goZ2V0Rm9sZGVyRGlzcGxheVBhdGgoZm9sZGVyKSk7XG4gICAgICBpZiAobWF0Y2gpIHtcbiAgICAgICAgcmVzdWx0cy5wdXNoKHsgZm9sZGVyLCBzY29yZTogbWF0Y2guc2NvcmUgfSk7XG4gICAgICB9XG4gICAgfVxuICAgIHJlc3VsdHMuc29ydCgocmVzdWx0MSwgcmVzdWx0MikgPT4gcmVzdWx0Mi5zY29yZSAtIHJlc3VsdDEuc2NvcmUpO1xuICAgIHJldHVybiByZXN1bHRzLm1hcCgocmVzdWx0KSA9PiByZXN1bHQuZm9sZGVyKTtcbiAgfVxufVxuXG4vKipcbiAqIEEge0BsaW5rIExpc3RDb21wb25lbnR9IG9mIHZhdWx0IGZvbGRlciBwYXRoczogdGhlIGFkZCByb3cgc3VnZ2VzdHMgdGhlIHZhdWx0J3MgZm9sZGVycywgYW5kIGEgdHlwZWQgcGF0aCBpc1xuICogbm9ybWFsaXplZCB3aXRoIE9ic2lkaWFuJ3MgYG5vcm1hbGl6ZVBhdGhgLCBzbyB0aGUgcm9vdCByZWFkcyBhcyBgL2AuIEEgcGF0aCBuZWVkIG5vdCBleGlzdCB5ZXQuXG4gKlxuICogWW91IGNhbiBhZGQgdGhpcyBjb21wb25lbnQgdXNpbmcge0BsaW5rIFNldHRpbmdFeC5hZGRGb2xkZXJMaXN0fS5cbiAqL1xuZXhwb3J0IGNsYXNzIEZvbGRlckxpc3RDb21wb25lbnQgZXh0ZW5kcyBMaXN0Q29tcG9uZW50IHtcbiAgLyoqXG4gICAqIFRoZSBmb2xkZXIgc3VnZ2VzdCBhdHRhY2hlZCB0byB7QGxpbmsgTGlzdENvbXBvbmVudC5uZXdJdGVtSW5wdXRFbH0uXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgc3VnZ2VzdDogRm9sZGVySW5wdXRTdWdnZXN0O1xuXG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IGZvbGRlciBsaXN0IGNvbXBvbmVudC5cbiAgICpcbiAgICogQHBhcmFtIGNvbnRhaW5lckVsIC0gVGhlIGNvbnRhaW5lciBlbGVtZW50LlxuICAgKiBAcGFyYW0gYXBwIC0gVGhlIE9ic2lkaWFuIGFwcC5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3Rvcihjb250YWluZXJFbDogSFRNTEVsZW1lbnQsIGFwcDogQXBwKSB7XG4gICAgc3VwZXIoY29udGFpbmVyRWwsIENzc0NsYXNzLkZvbGRlckxpc3RDb21wb25lbnQpO1xuICAgIHRoaXMuc3VnZ2VzdCA9IG5ldyBGb2xkZXJJbnB1dFN1Z2dlc3QoYXBwLCB0aGlzLm5ld0l0ZW1JbnB1dEVsKTtcbiAgICB0aGlzLnN1Z2dlc3Qub25TZWxlY3QoKCkgPT4ge1xuICAgICAgdGhpcy5hZGRUeXBlZEl0ZW0oKTtcbiAgICB9KTtcbiAgfVxuXG4gIC8qKlxuICAgKiBOb3JtYWxpemVzIGEgdHlwZWQgZm9sZGVyIHBhdGguXG4gICAqXG4gICAqIEBwYXJhbSB0ZXh0IC0gVGhlIHR5cGVkIHRleHQuXG4gICAqIEByZXR1cm5zIFRoZSBub3JtYWxpemVkIHBhdGgsIG9yIGBudWxsYCBmb3IgZW1wdHkgdGV4dC5cbiAgICovXG4gIHByb3RlY3RlZCBvdmVycmlkZSBub3JtYWxpemVJdGVtKHRleHQ6IHN0cmluZyk6IG51bGwgfCBzdHJpbmcge1xuICAgIGNvbnN0IHBhdGggPSB0ZXh0LnRyaW0oKTtcbiAgICByZXR1cm4gcGF0aCA/IG5vcm1hbGl6ZVBhdGgocGF0aCkgOiBudWxsO1xuICB9XG59XG5cbmZ1bmN0aW9uIGdldEZvbGRlckRpc3BsYXlQYXRoKGZvbGRlcjogVEZvbGRlcik6IHN0cmluZyB7XG4gIHJldHVybiBmb2xkZXIuaXNSb290KCkgPyAnLycgOiBmb2xkZXIucGF0aDtcbn1cbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBV0Esc0JBSU87QUFLUCx1QkFBeUI7QUFDekIsNEJBQThCO0FBVXZCLE1BQU0sMkJBQTJCLHFDQUE4QjtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBSWpEO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRWixZQUFZLEtBQVUsU0FBMkI7QUFDdEQsVUFBTSxLQUFLLE9BQU87QUFDbEIsU0FBSyxVQUFVO0FBQUEsRUFDakI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFPLGlCQUFpQixRQUFpQixJQUF1QjtBQUM5RCxPQUFHLFFBQVEscUJBQXFCLE1BQU0sQ0FBQztBQUFBLEVBQ3pDO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRZ0IsaUJBQWlCLFFBQWlCLFFBQTBDO0FBQzFGLFNBQUssU0FBUyxxQkFBcUIsTUFBTSxDQUFDO0FBQzFDLFNBQUssUUFBUSxjQUFjLElBQUksTUFBTSxTQUFTLEVBQUUsU0FBUyxLQUFLLENBQUMsQ0FBQztBQUNoRSxVQUFNLGlCQUFpQixRQUFRLE1BQU07QUFDckMsU0FBSyxNQUFNO0FBQUEsRUFDYjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUW1CLGVBQWUsT0FBMEI7QUFDMUQsVUFBTSxrQkFBYyxvQ0FBbUIsTUFBTSxLQUFLLENBQUM7QUFDbkQsVUFBTSxVQUF5QixDQUFDO0FBQ2hDLGVBQVcsVUFBVSxLQUFLLElBQUksTUFBTSxjQUFjLElBQUksR0FBRztBQUN2RCxZQUFNLFFBQVEsWUFBWSxxQkFBcUIsTUFBTSxDQUFDO0FBQ3RELFVBQUksT0FBTztBQUNULGdCQUFRLEtBQUssRUFBRSxRQUFRLE9BQU8sTUFBTSxNQUFNLENBQUM7QUFBQSxNQUM3QztBQUFBLElBQ0Y7QUFDQSxZQUFRLEtBQUssQ0FBQyxTQUFTLFlBQVksUUFBUSxRQUFRLFFBQVEsS0FBSztBQUNoRSxXQUFPLFFBQVEsSUFBSSxDQUFDLFdBQVcsT0FBTyxNQUFNO0FBQUEsRUFDOUM7QUFDRjtBQVFPLE1BQU0sNEJBQTRCLG9DQUFjO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFJckM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFULFlBQVksYUFBMEIsS0FBVTtBQUNyRCxVQUFNLGFBQWEsMEJBQVMsbUJBQW1CO0FBQy9DLFNBQUssVUFBVSxJQUFJLG1CQUFtQixLQUFLLEtBQUssY0FBYztBQUM5RCxTQUFLLFFBQVEsU0FBUyxNQUFNO0FBQzFCLFdBQUssYUFBYTtBQUFBLElBQ3BCLENBQUM7QUFBQSxFQUNIO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRbUIsY0FBYyxNQUE2QjtBQUM1RCxVQUFNLE9BQU8sS0FBSyxLQUFLO0FBQ3ZCLFdBQU8sV0FBTywrQkFBYyxJQUFJLElBQUk7QUFBQSxFQUN0QztBQUNGO0FBRUEsU0FBUyxxQkFBcUIsUUFBeUI7QUFDckQsU0FBTyxPQUFPLE9BQU8sSUFBSSxNQUFNLE9BQU87QUFDeEM7IiwibmFtZXMiOltdfQ==

package/dist/lib/cjs/setting-components/folder-list-component.d.cts

@@ -0,0 +1,73 @@
+/// <reference path="../library-references.d.cts" />
+/// <reference lib="dom" />
+/**
+ * @file
+ *
+ * Contains a component that edits a reorderable list of folders, with a folder suggest.
+ */
+import type { App, TFolder } from 'obsidian' with { 'resolution-mode': 'import' };
+import { AbstractInputSuggest } from 'obsidian';
+import { ListComponent } from './list-component.cjs';
+/**
+ * Suggests the vault's folders, the root included, in an `<input>`, matching the typed text against the folder path.
+ */
+export declare class FolderInputSuggest extends AbstractInputSuggest<TFolder> {
+    /**
+     * The input the suggest completes.
+     */
+    protected readonly inputEl: HTMLInputElement;
+    /**
+     * Creates a new folder suggest.
+     *
+     * @param app - The Obsidian app.
+     * @param inputEl - The input.
+     */
+    constructor(app: App, inputEl: HTMLInputElement);
+    /**
+     * Renders a folder.
+     *
+     * @param folder - The folder.
+     * @param el - The element to render into.
+     */
+    renderSuggestion(folder: TFolder, el: HTMLElement): void;
+    /**
+     * Puts the folder path into the input, dispatches an `input` event, then calls the `onSelect` callback.
+     *
+     * @param folder - The folder.
+     * @param $event - The event that picked it.
+     */
+    selectSuggestion(folder: TFolder, $event: KeyboardEvent | MouseEvent): void;
+    /**
+     * Gets the folders matching the typed text.
+     *
+     * @param query - The typed text.
+     * @returns The folders, best match first.
+     */
+    protected getSuggestions(query: string): TFolder[];
+}
+/**
+ * A {@link ListComponent} of vault folder paths: the add row suggests the vault's folders, and a typed path is
+ * normalized with Obsidian's `normalizePath`, so the root reads as `/`. A path need not exist yet.
+ *
+ * You can add this component using {@link SettingEx.addFolderList}.
+ */
+export declare class FolderListComponent extends ListComponent {
+    /**
+     * The folder suggest attached to {@link ListComponent.newItemInputEl}.
+     */
+    readonly suggest: FolderInputSuggest;
+    /**
+     * Creates a new folder list component.
+     *
+     * @param containerEl - The container element.
+     * @param app - The Obsidian app.
+     */
+    constructor(containerEl: HTMLElement, app: App);
+    /**
+     * Normalizes a typed folder path.
+     *
+     * @param text - The typed text.
+     * @returns The normalized path, or `null` for empty text.
+     */
+    protected normalizeItem(text: string): null | string;
+}