@mnaoumov/obsidian-lib 10.5.1 → 10.7.0

package/dist/lib/esm/anchored-suggest.d.mts

@@ -0,0 +1,116 @@
+/// <reference path="./library-references.d.mts" />
+/// <reference lib="dom" />
+/**
+ * @file
+ *
+ * A suggest popover opened at an element or a rectangle, with no input behind it.
+ */
+import type { App, Scope } from 'obsidian';
+import { PopoverSuggest } from 'obsidian';
+/**
+ * Parameters for {@link AnchoredSuggest.openAt}.
+ */
+export interface AnchoredSuggestOpenAtParams {
+    /**
+     * The element or the viewport rectangle the popover is placed against. When an element is given, the popover closes
+     * once the element leaves the DOM, and a pointer-down on it does not count as an outside click.
+     */
+    readonly anchor: DOMRectReadOnly | HTMLElement;
+    /**
+     * The query handed to {@link AnchoredSuggest.getSuggestions}. Defaults to `''`.
+     */
+    readonly query?: string;
+}
+/**
+ * A suggest popover opened at an anchor, for a picker that has no text input: a toolbar button, a context-menu action,
+ * a decoration in the editor.
+ *
+ * Obsidian's `AbstractInputSuggest` opens only from an input and `EditorSuggest` only from the editor. This one is
+ * opened by {@link AnchoredSuggest.openAt} and closes on Escape, on a pointer-down outside it, and when its anchor
+ * element leaves the DOM. The keyboard works as in Obsidian's own popovers: arrows move, Enter picks.
+ *
+ * ```ts
+ * class ColorSuggest extends AnchoredSuggest<string> {
+ *   protected getSuggestions(): string[] {
+ *     return ['red', 'green', 'blue'];
+ *   }
+ *
+ *   public renderSuggestion(color: string, el: HTMLElement): void {
+ *     el.setText(color);
+ *   }
+ *
+ *   protected onChooseSuggestion(color: string): void {
+ *     console.log(color);
+ *   }
+ * }
+ *
+ * await new ColorSuggest(this.app).openAt({ anchor: buttonEl });
+ * ```
+ *
+ * It relies on `PopoverSuggest` members that `obsidian.d.ts` does not declare (`suggestions`, `reposition`,
+ * `setAutoDestroy`, `suggestEl`), read from Obsidian `1.15.0`.
+ *
+ * @typeParam T - The type of a suggestion.
+ */
+export declare abstract class AnchoredSuggest<T> extends PopoverSuggest<T> {
+    /**
+     * The maximum number of suggestions shown. `0` disables the limit. Defaults to `100`.
+     */
+    limit: number;
+    private anchorEl;
+    private anchorRect;
+    private outsidePointerDownDocument;
+    private readonly outsidePointerDownHandler;
+    private requestCount;
+    /**
+     * Creates a new anchored suggest.
+     *
+     * @param app - The Obsidian app.
+     * @param scope - The parent keymap scope.
+     */
+    constructor(app: App, scope?: Scope);
+    /**
+     * Closes the popover.
+     */
+    close(): void;
+    /**
+     * Opens the popover at an anchor, or moves it there when it is already open.
+     *
+     * @param params - The parameters.
+     * @returns Whether the popover is open: `false` when there is nothing to suggest, or when it was closed or reopened
+     *   while the suggestions were computed.
+     */
+    openAt(params: AnchoredSuggestOpenAtParams): Promise<boolean>;
+    /**
+     * Picks a suggestion: closes the popover, then hands the suggestion to {@link AnchoredSuggest.onChooseSuggestion}.
+     *
+     * @param value - The suggestion.
+     * @param $event - The event that picked it.
+     */
+    selectSuggestion(value: T, $event: KeyboardEvent | MouseEvent): void;
+    /**
+     * Recomputes the suggestions for a new query at the current anchor.
+     *
+     * @param query - The query.
+     * @returns Whether the popover is open afterwards.
+     */
+    setQuery(query: string): Promise<boolean>;
+    /**
+     * Gets the suggestions for a query.
+     *
+     * @param query - The query passed to {@link AnchoredSuggest.openAt} or {@link AnchoredSuggest.setQuery}.
+     * @returns The suggestions, directly or as a promise.
+     */
+    protected abstract getSuggestions(query: string): Promise<T[]> | T[];
+    /**
+     * Called with the suggestion the user picked, after the popover closed.
+     *
+     * @param value - The suggestion.
+     * @param $event - The event that picked it.
+     */
+    protected abstract onChooseSuggestion(value: T, $event: KeyboardEvent | MouseEvent): void;
+    private addOutsidePointerDownHandler;
+    private onOutsidePointerDown;
+    private refresh;
+    private removeOutsidePointerDownHandler;
+}

package/dist/lib/esm/anchored-suggest.mjs

@@ -0,0 +1,144 @@
+/*
+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();
+})();
+
+import { PopoverSuggest } from "obsidian";
+const DEFAULT_LIMIT = 100;
+class AnchoredSuggest extends PopoverSuggest {
+  /**
+   * The maximum number of suggestions shown. `0` disables the limit. Defaults to `100`.
+   */
+  limit = DEFAULT_LIMIT;
+  anchorEl = null;
+  anchorRect = null;
+  outsidePointerDownDocument = null;
+  outsidePointerDownHandler = this.onOutsidePointerDown.bind(this);
+  requestCount = 0;
+  /**
+   * Creates a new anchored suggest.
+   *
+   * @param app - The Obsidian app.
+   * @param scope - The parent keymap scope.
+   */
+  constructor(app, scope) {
+    super(app, scope);
+  }
+  /**
+   * Closes the popover.
+   */
+  close() {
+    this.requestCount++;
+    this.removeOutsidePointerDownHandler();
+    super.close();
+  }
+  /**
+   * Opens the popover at an anchor, or moves it there when it is already open.
+   *
+   * @param params - The parameters.
+   * @returns Whether the popover is open: `false` when there is nothing to suggest, or when it was closed or reopened
+   *   while the suggestions were computed.
+   */
+  async openAt(params) {
+    const { anchor } = params;
+    if (isElement(anchor)) {
+      this.anchorEl = anchor;
+      this.anchorRect = anchor.getBoundingClientRect();
+    } else {
+      this.anchorEl = null;
+      this.anchorRect = anchor;
+    }
+    return await this.refresh(params.query ?? "", this.anchorRect);
+  }
+  /**
+   * Picks a suggestion: closes the popover, then hands the suggestion to {@link AnchoredSuggest.onChooseSuggestion}.
+   *
+   * @param value - The suggestion.
+   * @param $event - The event that picked it.
+   */
+  selectSuggestion(value, $event) {
+    this.close();
+    this.onChooseSuggestion(value, $event);
+  }
+  /**
+   * Recomputes the suggestions for a new query at the current anchor.
+   *
+   * @param query - The query.
+   * @returns Whether the popover is open afterwards.
+   */
+  async setQuery(query) {
+    return this.anchorRect ? await this.refresh(query, this.anchorRect) : false;
+  }
+  addOutsidePointerDownHandler() {
+    this.removeOutsidePointerDownHandler();
+    this.outsidePointerDownDocument = this.suggestEl.ownerDocument;
+    this.outsidePointerDownDocument.addEventListener("pointerdown", this.outsidePointerDownHandler, { capture: true });
+  }
+  onOutsidePointerDown(event_) {
+    const path = event_.composedPath();
+    if (path.includes(this.suggestEl) || this.anchorEl && path.includes(this.anchorEl)) {
+      return;
+    }
+    this.close();
+  }
+  async refresh(query, anchorRect) {
+    const requestId = ++this.requestCount;
+    let suggestions = await this.getSuggestions(query);
+    if (requestId !== this.requestCount) {
+      return false;
+    }
+    if (suggestions.length === 0) {
+      this.close();
+      return false;
+    }
+    if (this.limit > 0) {
+      suggestions = suggestions.slice(0, this.limit);
+    }
+    this.suggestions.setSuggestions(suggestions);
+    this.open();
+    this.reposition(DOMRect.fromRect(anchorRect));
+    if (this.anchorEl) {
+      this.setAutoDestroy(this.anchorEl);
+    }
+    this.addOutsidePointerDownHandler();
+    return true;
+  }
+  removeOutsidePointerDownHandler() {
+    this.outsidePointerDownDocument?.removeEventListener("pointerdown", this.outsidePointerDownHandler, { capture: true });
+    this.outsidePointerDownDocument = null;
+  }
+}
+function isElement(anchor) {
+  return "getBoundingClientRect" in anchor;
+}
+export {
+  AnchoredSuggest
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../src/anchored-suggest.ts"],"sourcesContent":["/**\n * @file\n *\n * A suggest popover opened at an element or a rectangle, with no input behind it.\n */\n\nimport type {\n  App,\n  Scope\n} from 'obsidian';\n\nimport { PopoverSuggest } from 'obsidian';\n\nconst DEFAULT_LIMIT = 100;\n\n/**\n * Parameters for {@link AnchoredSuggest.openAt}.\n */\nexport interface AnchoredSuggestOpenAtParams {\n  /**\n   * The element or the viewport rectangle the popover is placed against. When an element is given, the popover closes\n   * once the element leaves the DOM, and a pointer-down on it does not count as an outside click.\n   */\n  readonly anchor: DOMRectReadOnly | HTMLElement;\n\n  /**\n   * The query handed to {@link AnchoredSuggest.getSuggestions}. Defaults to `''`.\n   */\n  readonly query?: string;\n}\n\n/**\n * A suggest popover opened at an anchor, for a picker that has no text input: a toolbar button, a context-menu action,\n * a decoration in the editor.\n *\n * Obsidian's `AbstractInputSuggest` opens only from an input and `EditorSuggest` only from the editor. This one is\n * opened by {@link AnchoredSuggest.openAt} and closes on Escape, on a pointer-down outside it, and when its anchor\n * element leaves the DOM. The keyboard works as in Obsidian's own popovers: arrows move, Enter picks.\n *\n * ```ts\n * class ColorSuggest extends AnchoredSuggest<string> {\n *   protected getSuggestions(): string[] {\n *     return ['red', 'green', 'blue'];\n *   }\n *\n *   public renderSuggestion(color: string, el: HTMLElement): void {\n *     el.setText(color);\n *   }\n *\n *   protected onChooseSuggestion(color: string): void {\n *     console.log(color);\n *   }\n * }\n *\n * await new ColorSuggest(this.app).openAt({ anchor: buttonEl });\n * ```\n *\n * It relies on `PopoverSuggest` members that `obsidian.d.ts` does not declare (`suggestions`, `reposition`,\n * `setAutoDestroy`, `suggestEl`), read from Obsidian `1.15.0`.\n *\n * @typeParam T - The type of a suggestion.\n */\nexport abstract class AnchoredSuggest<T> extends PopoverSuggest<T> {\n  /**\n   * The maximum number of suggestions shown. `0` disables the limit. Defaults to `100`.\n   */\n  public limit = DEFAULT_LIMIT;\n\n  private anchorEl: HTMLElement | null = null;\n  private anchorRect: DOMRectReadOnly | null = null;\n  private outsidePointerDownDocument: Document | null = null;\n  private readonly outsidePointerDownHandler = this.onOutsidePointerDown.bind(this);\n  private requestCount = 0;\n\n  /**\n   * Creates a new anchored suggest.\n   *\n   * @param app - The Obsidian app.\n   * @param scope - The parent keymap scope.\n   */\n  public constructor(app: App, scope?: Scope) {\n    super(app, scope);\n  }\n\n  /**\n   * Closes the popover.\n   */\n  public override close(): void {\n    this.requestCount++;\n    this.removeOutsidePointerDownHandler();\n    super.close();\n  }\n\n  /**\n   * Opens the popover at an anchor, or moves it there when it is already open.\n   *\n   * @param params - The parameters.\n   * @returns Whether the popover is open: `false` when there is nothing to suggest, or when it was closed or reopened\n   *   while the suggestions were computed.\n   */\n  public async openAt(params: AnchoredSuggestOpenAtParams): Promise<boolean> {\n    const { anchor } = params;\n    if (isElement(anchor)) {\n      this.anchorEl = anchor;\n      this.anchorRect = anchor.getBoundingClientRect();\n    } else {\n      this.anchorEl = null;\n      this.anchorRect = anchor;\n    }\n    return await this.refresh(params.query ?? '', this.anchorRect);\n  }\n\n  /**\n   * Picks a suggestion: closes the popover, then hands the suggestion to {@link AnchoredSuggest.onChooseSuggestion}.\n   *\n   * @param value - The suggestion.\n   * @param $event - The event that picked it.\n   */\n  public override selectSuggestion(value: T, $event: KeyboardEvent | MouseEvent): void {\n    this.close();\n    this.onChooseSuggestion(value, $event);\n  }\n\n  /**\n   * Recomputes the suggestions for a new query at the current anchor.\n   *\n   * @param query - The query.\n   * @returns Whether the popover is open afterwards.\n   */\n  public async setQuery(query: string): Promise<boolean> {\n    return this.anchorRect ? (await this.refresh(query, this.anchorRect)) : false;\n  }\n\n  /**\n   * Gets the suggestions for a query.\n   *\n   * @param query - The query passed to {@link AnchoredSuggest.openAt} or {@link AnchoredSuggest.setQuery}.\n   * @returns The suggestions, directly or as a promise.\n   */\n  protected abstract getSuggestions(query: string): Promise<T[]> | T[];\n\n  /**\n   * Called with the suggestion the user picked, after the popover closed.\n   *\n   * @param value - The suggestion.\n   * @param $event - The event that picked it.\n   */\n  protected abstract onChooseSuggestion(value: T, $event: KeyboardEvent | MouseEvent): void;\n\n  private addOutsidePointerDownHandler(): void {\n    this.removeOutsidePointerDownHandler();\n    this.outsidePointerDownDocument = this.suggestEl.ownerDocument;\n    this.outsidePointerDownDocument.addEventListener('pointerdown', this.outsidePointerDownHandler, { capture: true });\n  }\n\n  private onOutsidePointerDown(event_: PointerEvent): void {\n    const path = event_.composedPath();\n    if (path.includes(this.suggestEl) || (this.anchorEl && path.includes(this.anchorEl))) {\n      return;\n    }\n    this.close();\n  }\n\n  private async refresh(query: string, anchorRect: DOMRectReadOnly): Promise<boolean> {\n    const requestId = ++this.requestCount;\n    let suggestions = await this.getSuggestions(query);\n    if (requestId !== this.requestCount) {\n      return false;\n    }\n    if (suggestions.length === 0) {\n      this.close();\n      return false;\n    }\n    if (this.limit > 0) {\n      suggestions = suggestions.slice(0, this.limit);\n    }\n\n    this.suggestions.setSuggestions(suggestions);\n    this.open();\n    this.reposition(DOMRect.fromRect(anchorRect));\n    if (this.anchorEl) {\n      this.setAutoDestroy(this.anchorEl);\n    }\n    this.addOutsidePointerDownHandler();\n    return true;\n  }\n\n  private removeOutsidePointerDownHandler(): void {\n    this.outsidePointerDownDocument?.removeEventListener('pointerdown', this.outsidePointerDownHandler, { capture: true });\n    this.outsidePointerDownDocument = null;\n  }\n}\n\nfunction isElement(anchor: DOMRectReadOnly | HTMLElement): anchor is HTMLElement {\n  return 'getBoundingClientRect' in anchor;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,SAAS,sBAAsB;AAE/B,MAAM,gBAAgB;AAiDf,MAAe,wBAA2B,eAAkB;AAAA;AAAA;AAAA;AAAA,EAI1D,QAAQ;AAAA,EAEP,WAA+B;AAAA,EAC/B,aAAqC;AAAA,EACrC,6BAA8C;AAAA,EACrC,4BAA4B,KAAK,qBAAqB,KAAK,IAAI;AAAA,EACxE,eAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhB,YAAY,KAAU,OAAe;AAC1C,UAAM,KAAK,KAAK;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA,EAKgB,QAAc;AAC5B,SAAK;AACL,SAAK,gCAAgC;AACrC,UAAM,MAAM;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,OAAO,QAAuD;AACzE,UAAM,EAAE,OAAO,IAAI;AACnB,QAAI,UAAU,MAAM,GAAG;AACrB,WAAK,WAAW;AAChB,WAAK,aAAa,OAAO,sBAAsB;AAAA,IACjD,OAAO;AACL,WAAK,WAAW;AAChB,WAAK,aAAa;AAAA,IACpB;AACA,WAAO,MAAM,KAAK,QAAQ,OAAO,SAAS,IAAI,KAAK,UAAU;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQgB,iBAAiB,OAAU,QAA0C;AACnF,SAAK,MAAM;AACX,SAAK,mBAAmB,OAAO,MAAM;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,SAAS,OAAiC;AACrD,WAAO,KAAK,aAAc,MAAM,KAAK,QAAQ,OAAO,KAAK,UAAU,IAAK;AAAA,EAC1E;AAAA,EAkBQ,+BAAqC;AAC3C,SAAK,gCAAgC;AACrC,SAAK,6BAA6B,KAAK,UAAU;AACjD,SAAK,2BAA2B,iBAAiB,eAAe,KAAK,2BAA2B,EAAE,SAAS,KAAK,CAAC;AAAA,EACnH;AAAA,EAEQ,qBAAqB,QAA4B;AACvD,UAAM,OAAO,OAAO,aAAa;AACjC,QAAI,KAAK,SAAS,KAAK,SAAS,KAAM,KAAK,YAAY,KAAK,SAAS,KAAK,QAAQ,GAAI;AACpF;AAAA,IACF;AACA,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,MAAc,QAAQ,OAAe,YAA+C;AAClF,UAAM,YAAY,EAAE,KAAK;AACzB,QAAI,cAAc,MAAM,KAAK,eAAe,KAAK;AACjD,QAAI,cAAc,KAAK,cAAc;AACnC,aAAO;AAAA,IACT;AACA,QAAI,YAAY,WAAW,GAAG;AAC5B,WAAK,MAAM;AACX,aAAO;AAAA,IACT;AACA,QAAI,KAAK,QAAQ,GAAG;AAClB,oBAAc,YAAY,MAAM,GAAG,KAAK,KAAK;AAAA,IAC/C;AAEA,SAAK,YAAY,eAAe,WAAW;AAC3C,SAAK,KAAK;AACV,SAAK,WAAW,QAAQ,SAAS,UAAU,CAAC;AAC5C,QAAI,KAAK,UAAU;AACjB,WAAK,eAAe,KAAK,QAAQ;AAAA,IACnC;AACA,SAAK,6BAA6B;AAClC,WAAO;AAAA,EACT;AAAA,EAEQ,kCAAwC;AAC9C,SAAK,4BAA4B,oBAAoB,eAAe,KAAK,2BAA2B,EAAE,SAAS,KAAK,CAAC;AACrH,SAAK,6BAA6B;AAAA,EACpC;AACF;AAEA,SAAS,UAAU,QAA8D;AAC/E,SAAO,2BAA2B;AACpC;","names":[]}

package/dist/lib/esm/broken-link-candidates.d.mts

@@ -0,0 +1,181 @@
+/// <reference path="./library-references.d.mts" />
+/**
+ * @file
+ *
+ * Where did a missing link target go? Pure, no `App`: every question about which file a broken link most likely
+ * meant is answerable from a list of paths, the notes' aliases and titles, and the vault's git renames.
+ *
+ * A rename is not recoverable from the link alone: a link to `alpha/bravo/charlie/!.md` says nothing about
+ * `charlie` having become `delta`. So every candidate carries the evidence that produced it, from outside the
+ * link, and the finder never picks one of several: a caller offers a one-click fix only when exactly one
+ * candidate exists.
+ */
+/**
+ * The kind of evidence that makes a file a candidate for a missing link target.
+ *
+ * Candidates list evidence strongest first, in EVIDENCE_KIND_ORDER below.
+ */
+export declare enum BrokenLinkEvidenceKind {
+    /**
+     * The candidate's `aliases` hold the missing target's old name.
+     */
+    Alias = "Alias",
+    /**
+     * The candidate's path differs from the missing one only in letter case.
+     */
+    CaseChange = "CaseChange",
+    /**
+     * The vault's git history records the missing path being renamed to the candidate.
+     */
+    GitRename = "GitRename",
+    /**
+     * The missing target's folder is gone, and a sibling folder holds every missing target that was under it.
+     */
+    RenamedFolder = "RenamedFolder",
+    /**
+     * A file with the same name, and the longest run of the same parent folders, sits elsewhere.
+     */
+    SameName = "SameName",
+    /**
+     * The candidate's `title` is the missing target's old name.
+     */
+    Title = "Title"
+}
+/**
+ * One file that a missing link target may have become, and why.
+ */
+export interface BrokenLinkCandidate {
+    /**
+     * Every reason this file is a candidate, strongest first.
+     */
+    readonly evidence: readonly BrokenLinkEvidence[];
+    /**
+     * The candidate's vault path.
+     */
+    readonly path: string;
+}
+/**
+ * The parameters for {@link BrokenLinkCandidateFinder}.
+ */
+export interface BrokenLinkCandidateFinderConstructorParams {
+    /**
+     * Each note's `aliases`, by note path.
+     */
+    readonly aliasesByPath: ReadonlyMap<string, readonly string[]>;
+    /**
+     * Every file in the vault.
+     */
+    readonly filePaths: readonly string[];
+    /**
+     * The file names a folder note is stored under, such as `index.md`. Such a name says nothing about which
+     * note it is, so a same-name candidate must share its folder's name too, and the old name an alias is
+     * matched against is the folder's.
+     */
+    readonly folderNoteFileNames: readonly string[];
+    /**
+     * The vault's git renames: each old vault path to the path it was renamed to, chains already followed.
+     */
+    readonly gitRenames: ReadonlyMap<string, GitRename>;
+    /**
+     * Each note's `title`, by note path.
+     */
+    readonly titlesByPath: ReadonlyMap<string, string>;
+}
+/**
+ * One reason a file is a candidate for a missing link target.
+ */
+export interface BrokenLinkEvidence {
+    /**
+     * A sentence naming the evidence, for the user to judge it by.
+     */
+    readonly description: string;
+    /**
+     * The kind of evidence.
+     */
+    readonly kind: BrokenLinkEvidenceKind;
+}
+/**
+ * A rename recorded in the vault's git history.
+ */
+export interface GitRename {
+    /**
+     * The abbreviated hash of the commit that made the last rename of the chain.
+     */
+    readonly commit: string;
+    /**
+     * The vault path the file was last renamed to.
+     */
+    readonly newPath: string;
+}
+/**
+ * The part of a missing path that a candidate replaced: what a "fix all like this" applies to every other link.
+ */
+export interface PathMapping {
+    /**
+     * The part of the candidate path that replaced {@link oldPrefix}; `''` for the vault root.
+     */
+    readonly newPrefix: string;
+    /**
+     * The leading part of the missing path that no longer exists; `''` for the vault root.
+     */
+    readonly oldPrefix: string;
+}
+/**
+ * Finds the candidates for missing link targets, from one snapshot of the vault.
+ */
+export declare class BrokenLinkCandidateFinder {
+    private readonly aliasesByPath;
+    private readonly childFoldersByFolder;
+    private readonly filePathSet;
+    private readonly filesByLowerCasePath;
+    private readonly filesByName;
+    private readonly folderNoteFileNames;
+    private readonly folderPaths;
+    private readonly gitRenames;
+    private readonly titlesByPath;
+    /**
+     * Indexes the vault snapshot.
+     *
+     * @param params - The snapshot.
+     */
+    constructor(params: BrokenLinkCandidateFinderConstructorParams);
+    /**
+     * Finds the candidates for every missing path at once.
+     *
+     * All at once because one kind of evidence is collective: a renamed folder is recognized by every missing
+     * target that was under it turning up together under one sibling folder.
+     *
+     * @param missingPaths - The vault paths that links lead to and no file holds.
+     * @returns The candidates for each missing path, strongest first; an empty list when nothing is known.
+     */
+    findAll(missingPaths: Iterable<string>): Map<string, BrokenLinkCandidate[]>;
+    private addAliasAndTitleCandidates;
+    private addCaseChangeCandidates;
+    private addGitRenameCandidate;
+    private addRenamedFolderCandidates;
+    private addSameNameCandidates;
+    /**
+     * Groups the missing paths by the highest missing folder above each, the root of a subtree that may have been
+     * renamed as a whole.
+     *
+     * @param missingPaths - The missing paths.
+     * @returns Each missing path's subtree; a path whose own folder exists has none.
+     */
+    private getMissingSubtrees;
+}
+/**
+ * The parent folder of a vault path.
+ *
+ * @param path - The path.
+ * @returns The parent folder; `''` for the vault root.
+ */
+export declare function getParentPath(path: string): string;
+/**
+ * The part of a missing path that a candidate path replaced, found by dropping the path segments they end with
+ * in common.
+ *
+ * @param oldPath - The missing path.
+ * @param newPath - The candidate path.
+ * @returns The prefixes that differ.
+ */
+export declare function getPathMapping(oldPath: string, newPath: string): PathMapping;