@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/common/prosemirror/content-link-plugin.d.mts

@@ -2,6 +2,7 @@ import type { Schema, Slice } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type { EditorView } from "prosemirror-view";
 import type ProseMirrorPlugin from "./plugin.d.mts";
+import type Document from "#common/abstract/document.mjs";
 
 /**
  * A class responsible for handling the dropping of Documents onto the editor and creating content links for them.
@@ -11,19 +12,21 @@ declare class ProseMirrorContentLinkPlugin extends ProseMirrorPlugin {
    * @param schema  - The ProseMirror schema.
    * @param options - Additional options to configure the plugin's behaviour.
    */
-  constructor(schema: Schema, options?: ProseMirrorContentLinkPlugin.ProseMirrorContentLinkOptions);
+  constructor(schema: Schema, options?: ProseMirrorContentLinkPlugin.ConstructionOptions);
 
   /**
    * The parent document housing this editor.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly document: foundry.abstract.Document.Any;
+  readonly document: Document.Any | undefined;
 
   /**
    * Whether to generate links relative to the parent document.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
   readonly relativeLinks: boolean;
 
-  static override build(schema: Schema, options?: ProseMirrorContentLinkPlugin.ProseMirrorContentLinkOptions): Plugin;
+  static override build(schema: Schema, options?: ProseMirrorContentLinkPlugin.ConstructionOptions): Plugin;
 
   /**
    * Handle a drop onto the editor.
@@ -32,16 +35,33 @@ declare class ProseMirrorContentLinkPlugin extends ProseMirrorPlugin {
    * @param slice - A slice of editor content.
    * @param moved - Whether the slice has been moved from a different part of the editor.
    */
-  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): void | true;
+  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): boolean | void;
 }
 
 declare namespace ProseMirrorContentLinkPlugin {
-  interface ProseMirrorContentLinkOptions {
+  interface ConstructionOptionsNoRelative {
     /** The parent document housing this editor. */
-    document?: foundry.abstract.Document.Any | undefined;
-    /** @defaultValue `false` */
-    relativeLinks?: boolean | undefined;
+    document?: Document.Any | undefined;
+
+    /**
+     * @defaultValue `false`
+     * @remarks If `relativeLinks` is `true`, a valid `document` must be passed or construction will throw
+     */
+    relativeLinks?: false | undefined;
+  }
+
+  interface ConstructionOptionsRelative {
+    /** The parent document housing this editor. */
+    document: Document.Any;
+
+    /**
+     * @defaultValue `false`
+     * @remarks If `relativeLinks` is `true`, a valid `document` must be passed or construction will throw
+     */
+    relativeLinks: true;
   }
+
+  type ConstructionOptions = ConstructionOptionsRelative | ConstructionOptionsNoRelative;
 }
 
 export default ProseMirrorContentLinkPlugin;

package/src/foundry/common/prosemirror/dirty-plugin.d.mts

@@ -1,7 +1,7 @@
 import type { Schema } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { EmptyObject } from "fvtt-types/utils";
+import type { AnyObject } from "#utils";
 
 export default ProseMirrorDirtyPlugin;
 
@@ -9,5 +9,5 @@ export default ProseMirrorDirtyPlugin;
  * A simple plugin that records the dirty state of the editor.
  */
 declare class ProseMirrorDirtyPlugin extends ProseMirrorPlugin {
-  static override build(schema: Schema, options?: EmptyObject): Plugin;
+  static override build(schema: Schema, options?: AnyObject): Plugin;
 }

package/src/foundry/common/prosemirror/dom-parser.d.mts

@@ -1,10 +1,10 @@
-import { DOMParser as BaseDOMParser, Node, ParseOptions, Schema } from "prosemirror-model";
-import type { FixedInstanceType } from "fvtt-types/utils";
-
-export default DOMParser;
+import type { DOMParser as BaseDOMParser, Node, ParseOptions, Schema } from "prosemirror-model";
+import type { FixedInstanceType } from "#utils";
 
 declare class DOMParser extends BaseDOMParser {
   override parse(dom: FixedInstanceType<typeof window.Node>, options?: ParseOptions): Node;
 
   static override fromSchema(schema: Schema): BaseDOMParser;
 }
+
+export default DOMParser;

package/src/foundry/common/prosemirror/dropdown.d.mts

@@ -1,35 +1,25 @@
-import type { ProseMirrorDropDown as ProseMirrorDropDownMenu } from "./menu.d.mts";
-
-interface Options {
-  /** The menu CSS class name. Required if providing an action. */
-  cssClass?: string;
-  /** Use an icon for the dropdown rather than a text label. */
-  icon?: string;
-  /** A callback to fire when a menu item is clicked. */
-  onAction?: (event: MouseEvent) => void;
-}
+import type { InexactPartial } from "#utils";
+import type ProseMirrorMenu from "./menu.d.mts";
 
-export default ProseMirrorDropDown;
 declare class ProseMirrorDropDown {
   /**
    * A class responsible for rendering a menu drop-down.
    * @param title - The default title.
    * @param items - The configured menu items.
    */
-  constructor(title: string, items: ProseMirrorDropDownMenu.Entry[], options?: Options);
-
-  // placeholder private attribute to limit what can count as a subtype at compile time
-  #proseMirrorDropDown: true;
+  constructor(title: string, items: ProseMirrorDropDown.Entry[], options?: ProseMirrorDropDown.ConstructionOptions);
 
   /**
    * The default title for this drop-down.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
   readonly title: string;
 
   /**
    * The items configured for this drop-down.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly items: ProseMirrorDropDownMenu.Entry[];
+  readonly items: ProseMirrorDropDown.Entry[];
 
   /**
    * Attach event listeners.
@@ -47,19 +37,61 @@ declare class ProseMirrorDropDown {
    * Recurse through the menu structure and apply a function to each item in it.
    * @param fn - The function to call on each item. Return false to prevent iterating over any further items.
    */
-  forEachItem(fn: (entry: ProseMirrorDropDownMenu.Entry) => boolean): void;
+  forEachItem(/** @immediate */ fn: (entry: ProseMirrorDropDown.Entry) => boolean): void;
 
   /**
    * Render a list of drop-down menu items.
    * @param entries - The menu items.
    * @returns HTML contents as a string.
    */
-  protected static _renderMenu(entries: ProseMirrorDropDownMenu.Entry[]): string;
+  protected static _renderMenu(entries: ProseMirrorDropDown.Entry[]): string;
 
   /**
    * Render an individual drop-down menu item.
    * @param item - The menu item.
    * @returns HTML contents as a string.
    */
-  protected static _renderMenuItem(item: ProseMirrorDropDownMenu.Entry): string;
+  protected static _renderMenuItem(item: ProseMirrorDropDown.Entry): string;
+
+  #ProseMirrorDropDown: true;
+}
+
+declare namespace ProseMirrorDropDown {
+  /** @internal */
+  type _ConstructionOptions = InexactPartial<{
+    /** The menu CSS class name. Required if providing an action. */
+    cssClass: string;
+
+    /** Use an icon for the dropdown rather than a text label. */
+    icon: string;
+
+    /** A callback to fire when a menu item is clicked. */
+    onAction: (event: MouseEvent) => void;
+  }>;
+
+  interface ConstructionOptions extends _ConstructionOptions {}
+
+  interface Entry extends ProseMirrorMenu.Item {
+    /** Any child entries. */
+    children?: Entry[] | undefined;
+  }
+
+  interface Config {
+    /** The default title of the drop-down. */
+    title: string;
+
+    /** The menu CSS class. */
+    cssClass: string;
+
+    /**
+     * An optional icon to use instead of a text label.
+     * @remarks Takes the form of an HTML string, e.g `'<i class="fa-solid fa-table fa-fw"></i>'`
+     */
+    icon?: string | undefined;
+
+    /** The drop-down entries. */
+    entries: Entry[];
+  }
 }
+
+export default ProseMirrorDropDown;

package/src/foundry/common/prosemirror/extensions.d.mts

@@ -1,4 +1,4 @@
-import type { NodeType } from "prosemirror-model";
+import type { Attrs, NodeType } from "prosemirror-model";
 
 declare module "prosemirror-model" {
   interface ResolvedPos {
@@ -6,7 +6,10 @@ declare module "prosemirror-model" {
      * Determine whether a given position has an ancestor node of the given type.
      * @param other - The other node type.
      * @param attrs - An object of attributes that must also match, if provided.
+     * @privateRemarks {@linkcode foundry.prosemirror.ProseMirrorMenu._toggleBlock | ProseMirrorMenu#_toggleBlock} and
+     * {@linkcode foundry.prosemirror.ProseMirrorMenu._toggleTextBlock | #_toggleTextBlock} call this with an `attrs`
+     * parameter that has a default of `null`
      */
-    hasAncestor(other: NodeType, attrs?: ReturnType<ResolvedPos["node"]>["attrs"]): boolean;
+    hasAncestor(other: NodeType, attrs?: Attrs | null): boolean;
   }
 }

package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts

@@ -1,82 +1,69 @@
 import { Schema } from "prosemirror-model";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { ProseMirrorMenu } from "./menu.d.mts";
 import { EditorState, Plugin } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
-import type { EmptyObject, InexactPartial } from "fvtt-types/utils";
+import type { AnyObject } from "#utils";
 
-declare namespace ProseMirrorHighlightMatchesPlugin {
+/**
+ * A class responsible for handling the display of automated link recommendations when a user highlights text in a
+ * ProseMirror editor.
+ * @remarks This class is never exported or available directly, {@linkcode ProseMirrorHighlightMatchesPlugin.build} creates a
+ * plugin to return by passing a `view` options property that will instantiate one of these.
+ */
+declare class _PossibleMatchesTooltip {
   /**
-   * A class responsible for handling the display of automated link recommendations when a user highlights text in a
-   * ProseMirror editor.
+   * @param view - The editor view
    */
-  class PossibleMatchesTooltip {
-    /**
-     * @param view - The editor view
-     */
-    constructor(view: EditorView);
+  constructor(view: EditorView);
 
-    /**
-     * A reference to any existing tooltip that has been generated as part of a highlight match.
-     */
-    tooltip: HTMLElement;
+  /**
+   * A reference to any existing tooltip that has been generated as part of a highlight match.
+   */
+  tooltip: HTMLElement | undefined;
 
-    update(view: EditorView, lastState: EditorState): Promise<void>;
+  update(view: EditorView, lastState: EditorState): Promise<void>;
 
-    /**
-     * Create a locked tooltip at the given position
-     * @param position - A position object with coordinates for where the tooltip should be placed
-     * @param text     - Explicit tooltip text or HTML to display.
-     * @param options  - Additional options which can override tooltip behavior.
-     */
-    _createTooltip(
-      position: InexactPartial<{
-        /** Explicit top position for the tooltip */
-        top?: string;
-        /** Explicit right position for the tooltip */
-        right?: string;
-        /** Explicit bottom position for the tooltip */
-        bottom?: string;
-        /** Explicit left position for the tooltip */
-        left?: string;
-      }>,
-      text: string,
-      options?: {
-        /** An optional, space-separated list of CSS classes to apply to the activated tooltip. */
-        cssClass: string;
-      },
-    ): void;
+  /** @remarks Made hard private in v13 (this warning will be removed in v14) */
+  _createTooltip(position: never, text: never, options: never): never;
 
-    /**
-     * Update the tooltip with new HTML
-     * @param html - The HTML to be included in the tooltip
-     */
-    _updateTooltip(html: string): void;
+  /** @remarks Made hard private in v13 (this warning will be removed in v14) */
+  _updateTooltip(html: never): never;
 
-    /**
-     * Dismiss all locked tooltips and set this tooltip to undefined.
-     */
-    _deactivateTooltip(): void;
+  /** @remarks Made hard private in v13 (this warning will be removed in v14) */
+  _deactivateTooltip(): never;
 
-    /**
-     * Find all Documents in the world/compendia with names that match the selection insensitive to case.
-     * @param text - A string which will be matched against document names
-     */
-    _findMatches(text: string): string;
-  }
+  /** @remarks Made hard private in v13 (this warning will be removed in v14) */
+  _findMatches(text: never): never;
+
+  #PossibleMatchesTooltip;
 }
 
 /**
- * A ProseMirrorPlugin wrapper around the {@link PossibleMatchesTooltip} class.
+ * A ProseMirrorPlugin wrapper around the {@linkcode PossibleMatchesTooltip} class.
  */
 declare class ProseMirrorHighlightMatchesPlugin extends ProseMirrorPlugin {
   /**
    * @param schema  - The ProseMirror schema.
    * @param options - Additional options to configure the plugin's behaviour.
+   * @remarks Foundry types the options as {@linkcode ProseMirrorMenu.ConstructionOptions},
+   * but they're unused other than being stored in `this.options`. Suspected copy & paste error.
    */
-  constructor(schema: Schema, options: ProseMirrorMenu.ProseMirrorMenuOptions);
+  constructor(schema: Schema, options?: AnyObject);
+
+  /** @remarks `options` is unused */
+  static override build(
+    schema: Schema,
+    options?: AnyObject,
+  ): Plugin<ProseMirrorHighlightMatchesPlugin.HighlightMatchesPluginSpec>;
+}
 
-  static override build(schema: Schema, options?: EmptyObject): Plugin;
+declare namespace ProseMirrorHighlightMatchesPlugin {
+  interface PossibleMatchesTooltip extends _PossibleMatchesTooltip {}
+
+  interface HighlightMatchesPluginSpec {
+    view(editorView: EditorView): PossibleMatchesTooltip;
+    isHighlightMatchesPlugin: true;
+  }
 }
 
 export default ProseMirrorHighlightMatchesPlugin;

package/src/foundry/common/prosemirror/image-plugin.d.mts

@@ -2,32 +2,26 @@ import type { Schema, Slice } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type { EditorView } from "prosemirror-view";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { EmptyObject } from "fvtt-types/utils";
+import type Document from "#common/abstract/document.mjs";
 
-export default ProseMirrorImagePlugin;
 /**
  * A class responsible for handle drag-and-drop and pasting of image content. Ensuring no base64 data is injected
  * directly into the journal content and it is instead uploaded to the user's data directory.
  */
-declare class ProseMirrorImagePlugin<RelatedDocument extends foundry.abstract.Document.Any> extends ProseMirrorPlugin {
+declare class ProseMirrorImagePlugin<Doc extends Document.Any> extends ProseMirrorPlugin {
   /**
    * @param schema   - The ProseMirror schema.
    * @param options  - Additional options to configure the plugin's behaviour.
    */
-  constructor(
-    schema: Schema,
-    options?: {
-      /** A related Document to store extract base64 images for. */
-      document?: RelatedDocument;
-    },
-  );
+  constructor(schema: Schema, options: ProseMirrorImagePlugin.ConstructionOptions<Doc>);
 
   /**
    * The related Document to store extracted base64 images for.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly document: RelatedDocument;
+  readonly document: Doc;
 
-  static override build(schema: Schema, options?: EmptyObject): Plugin;
+  static override build(schema: Schema, options: ProseMirrorImagePlugin.ConstructionOptions<Document.Any>): Plugin;
 
   /**
    * Handle a drop onto the editor.
@@ -36,21 +30,21 @@ declare class ProseMirrorImagePlugin<RelatedDocument extends foundry.abstract.Do
    * @param slice - A slice of editor content.
    * @param moved - Whether the slice has been moved from a different part of the editor.
    */
-  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): void | true;
+  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): boolean | void;
 
   /**
    * Handle a paste into the editor.
    * @param view  - The ProseMirror editor view.
    * @param event - The paste event.
    */
-  protected _onPaste(view: EditorView, event: ClipboardEvent): void | true;
+  protected _onPaste(view: EditorView, event: ClipboardEvent): boolean | void;
 
   /**
    * Upload any image files encountered in the drop.
    * @param view  - The ProseMirror editor view.
    * @param files - The files to upload.
-   * @param pos   - The position in the document to insert at. If not provided, the current
-   *                selection will be replaced instead.
+   * @param pos   - The position in the document to insert at. If not provided,
+   * the current selection will be replaced instead.
    */
   protected _uploadImages(view: EditorView, files: FileList, pos?: number): Promise<void>;
 
@@ -63,14 +57,14 @@ declare class ProseMirrorImagePlugin<RelatedDocument extends foundry.abstract.Do
   protected _replaceBase64Images(
     view: EditorView,
     html: string,
-    images: [full: string, mime: string, data: string][],
+    images: ProseMirrorImagePlugin.ImageData[],
   ): Promise<void>;
 
   /**
    * Detect base64 image data embedded in an HTML string and extract it.
    * @param html - The HTML data as a string.
    */
-  protected _extractBase64Images(html: string): [full: string, mime: string, data: string][];
+  protected _extractBase64Images(html: string): ProseMirrorImagePlugin.ImageData[];
 
   /**
    * Convert a base64 string into a File object.
@@ -80,3 +74,14 @@ declare class ProseMirrorImagePlugin<RelatedDocument extends foundry.abstract.Do
    */
   static base64ToFile(data: string, filename: string, mimetype: string): File;
 }
+
+declare namespace ProseMirrorImagePlugin {
+  interface ConstructionOptions<Doc extends Document.Any> {
+    /** A related Document to store extract base64 images for. */
+    document: Doc;
+  }
+
+  type ImageData = [full: string, mime: string, data: string];
+}
+
+export default ProseMirrorImagePlugin;

package/src/foundry/common/prosemirror/input-rules.d.mts

@@ -2,20 +2,8 @@ import type { InputRule } from "prosemirror-inputrules";
 import type { Schema } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type ProseMirrorPlugin from "./plugin.d.mts";
+import type { InexactPartial } from "#utils";
 
-export declare namespace ProseMirrorInputRules {
-  export interface ProseMirrorInputRulesOptions {
-    /**
-     * The minimum heading level to start from when generating heading input rules.
-     * The resulting heading level for a heading rule is equal to the number of
-     * leading hashes minus this number.
-     * @defaultValue `0`
-     */
-    minHeadingLevel?: number;
-  }
-}
-
-export default ProseMirrorInputRules;
 /**
  * A class responsible for building the input rules for the ProseMirror editor.
  */
@@ -24,11 +12,28 @@ declare class ProseMirrorInputRules extends ProseMirrorPlugin {
    * Build the plugin.
    * @param schema  - The ProseMirror schema to build the plugin against.
    * @param options - Additional options to pass to the plugin.
-   * */
-  static build(schema: Schema, options?: ProseMirrorInputRules.ProseMirrorInputRulesOptions): Plugin;
+   */
+  static build(schema: Schema, options?: ProseMirrorInputRules.BuildOptions): Plugin;
 
   /**
    * Build input rules for node types present in the schema.
    */
   buildRules(): InputRule[];
+
+  #ProseMirrorInputRules: true;
 }
+
+declare namespace ProseMirrorInputRules {
+  /** @internal */
+  type _BuildOptions = InexactPartial<{
+    /**
+     * The minimum heading level to start from when generating heading input rules.
+     * The resulting heading level for a heading rule is equal to the number of leading hashes minus this number.
+     * @defaultValue `0`
+     */
+    minHeadingLevel?: number;
+  }>;
+  interface BuildOptions extends _BuildOptions {}
+}
+
+export default ProseMirrorInputRules;

package/src/foundry/common/prosemirror/keymaps.d.mts

@@ -3,25 +3,6 @@ import type { EditorState, Plugin, Transaction } from "prosemirror-state";
 import type { EditorView } from "prosemirror-view";
 import type ProseMirrorPlugin from "./plugin.d.mts";
 
-/**
- * @param state    - The current editor state.
- * @param dispatch - A function to dispatch a transaction.
- * @param view     - Escape-hatch for when the command needs to interact directly with the UI.
- * @returns Whether the command has performed any action and consumed the event.
- */
-export type ProseMirrorCommand = (
-  state: EditorState,
-  dispatch: (transaction: Transaction) => void,
-  view: EditorView,
-) => boolean;
-export declare namespace ProseMirrorKeyMaps {
-  export interface Options {
-    /** A function to call when Ctrl+S is pressed. */
-    onSave?: () => void;
-  }
-}
-
-export default ProseMirrorKeyMaps;
 /**
  * A class responsible for building the keyboard commands for the ProseMirror editor.
  */
@@ -34,8 +15,9 @@ declare class ProseMirrorKeyMaps extends ProseMirrorPlugin {
 
   /**
    * A function to call when Ctrl+S is pressed.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly onSave: () => void;
+  readonly onSave: (() => void) | undefined;
 
   static override build(schema: Schema, options?: ProseMirrorKeyMaps.Options): Plugin;
 
@@ -43,5 +25,26 @@ declare class ProseMirrorKeyMaps extends ProseMirrorPlugin {
    * Build keyboard commands for nodes and marks present in the schema.
    * @returns An object of keyboard shortcuts to editor functions.
    */
-  buildMapping(): Record<string, ProseMirrorCommand>;
+  buildMapping(): Record<string, ProseMirrorKeyMaps.Command>;
+
+  #ProseMirrorKeyMaps: true;
+}
+
+declare namespace ProseMirrorKeyMaps {
+  interface Options {
+    /** A function to call when Ctrl+S is pressed. */
+    onSave?: (() => void) | undefined;
+  }
+
+  /**
+   * @param state    - The current editor state.
+   * @param dispatch - A function to dispatch a transaction.
+   * @param view     - Escape-hatch for when the command needs to interact directly with the UI.
+   * @returns Whether the command has performed any action and consumed the event.
+   */
+  type Command = (state: EditorState, dispatch: DispatchFunction, view: EditorView) => boolean;
+
+  type DispatchFunction = (transaction: Transaction) => void;
 }
+
+export default ProseMirrorKeyMaps;