@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

package/src/foundry/client/ui/dialog.d.mts

@@ -1,69 +1,14 @@
-import type { MaybePromise } from "../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
-  interface DialogOptions extends ApplicationOptions {
-    /**
-     * Whether to provide jQuery objects to callback functions (if true) or plain
-     * HTMLElement instances (if false). This is currently true by default but in the
-     * future will become false by default.
-     * @defaultValue `true`
-     */
-    jQuery?: boolean;
-  }
-
-  interface DialogButton<T = unknown, JQueryOrHtml = JQuery | HTMLElement> {
-    /**
-     * A Font Awesome icon for the button
-     */
-    icon?: string;
-
-    /**
-     * The label for the button
-     */
-    label: string;
-
-    /**
-     * Whether the button is disabled
-     */
-    disabled?: boolean;
-
-    /**
-     * A callback function that fires when the button is clicked
-     */
-    callback?: (html: JQueryOrHtml, event?: MouseEvent) => T;
-  }
-
-  interface DialogData<JQueryOrHtml = JQuery | HTMLElement> {
-    /**
-     * The window title displayed in the dialog header
-     */
-    title: string;
+  /** @deprecated {@link Dialog.Options | `Dialog.Options`} */
+  type DialogOptions = Dialog.Options;
 
-    /**
-     * HTML content for the dialog form
-     */
-    content: string;
-
-    /**
-     * The buttons which are displayed as action choices for the dialog
-     */
-    buttons: Record<string, DialogButton<unknown, JQueryOrHtml>>;
+  /** @deprecated {@link Dialog.Button | `Dialog.Button`} */
+  type DialogButton = Dialog.Button;
 
-    /**
-     * The name of the default button which should be triggered on Enter keypress
-     */
-    default?: string;
-
-    /**
-     * A callback function invoked when the dialog is rendered
-     */
-    render?: (element: JQueryOrHtml) => void;
-
-    /**
-     * Common callback operations to perform when the dialog is closed
-     */
-    close?: (element: JQueryOrHtml) => void;
-  }
+  /** @deprecated {@link Dialog.Data | `Dialog.Data`} */
+  type DialogData<JQueryOrHTML extends JQuery | HTMLElement = JQuery | HTMLElement> = Dialog.Data<JQueryOrHTML>;
 
   /**
    * Create a modal dialog window displaying a title, a message, and a set of buttons which trigger callback functions.
@@ -93,14 +38,14 @@ declare global {
    * ```
    * @typeParam Options - the type of the options object
    */
-  class Dialog<Options extends DialogOptions = DialogOptions> extends Application<Options> {
+  class Dialog<Options extends Dialog.Options = Dialog.Options> extends Application<Options> {
     /**
      * @param data    - An object of dialog data which configures how the modal window is rendered
-     * @param options - Dialog rendering options, see {@link Application}
+     * @param options - Dialog rendering options, see {@link Application | `Application`}
      */
-    constructor(data: DialogData, options?: Partial<Options>);
+    constructor(data: Dialog.Data<Dialog.JQueryOrHTML<Options>>, options?: Partial<Options>);
 
-    data: DialogData;
+    data: Dialog.Data<JQuery | HTMLElement>;
 
     /**
      * A bound instance of the _onKeyDown method which is used to listen to keypress events while the Dialog is active.
@@ -119,7 +64,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): DialogOptions;
+    static override get defaultOptions(): Dialog.Options;
 
     override get title(): string;
 
@@ -147,7 +92,7 @@ declare global {
      * @param button - The configuration of the chosen button
      * @param event - The originating click event
      */
-    protected submit(button: DialogButton, event?: MouseEvent): void;
+    protected submit(button: Dialog.Button, event?: MouseEvent): void;
 
     override close(options?: Application.CloseOptions): Promise<void>;
 
@@ -169,40 +114,25 @@ declare global {
      * });
      * ```
      */
-    static confirm<Yes = true, No = false>(
-      config: Dialog.ConfirmConfig<Yes, No, JQuery> & { options?: { jQuery?: true }; rejectClose: true },
-    ): Promise<Yes | No>;
-    static confirm<Yes = true, No = false>(
-      config: Dialog.ConfirmConfig<Yes, No, JQuery> & { options?: { jQuery?: true } },
-    ): Promise<Yes | No | null>;
-    static confirm<Yes = true, No = false>(
-      config: Dialog.ConfirmConfig<Yes, No, HTMLElement> & { options: { jQuery: false }; rejectClose: true },
-    ): Promise<Yes | No>;
-    static confirm<Yes = true, No = false>(
-      config: Dialog.ConfirmConfig<Yes, No, HTMLElement> & { options: { jQuery: false } },
-    ): Promise<Yes | No | null>;
-    static confirm<Yes = true, No = false>(
-      config: Dialog.ConfirmConfig<Yes, No, JQuery | HTMLElement> & { rejectClose: true },
-    ): Promise<Yes | No>;
-    static confirm<Yes = true, No = false>(
-      config?: Dialog.ConfirmConfig<Yes, No, JQuery | HTMLElement>,
-    ): Promise<Yes | No | null>;
+    static confirm<
+      const Yes = true,
+      const No = false,
+      const RejectClose extends boolean | undefined = undefined,
+      const Options extends Partial<Dialog.Options> | undefined = undefined,
+    >(
+      config?: Dialog.ConfirmConfig<Yes, No, RejectClose, Options>,
+    ): Promise<Yes | No | Dialog.OnReject<RejectClose, false>>;
 
     /**
      * A helper factory method to display a basic "prompt" style Dialog with a single button
      * @param config - Dialog configuration options
      * @returns A promise which resolves when clicked, or rejects if closed
      */
-    static prompt<T>(
-      config: Dialog.PromptConfig<T, JQuery> & { options?: { jQuery?: true }; rejectClose: false },
-    ): Promise<T | null>;
-    static prompt<T>(config: Dialog.PromptConfig<T, JQuery> & { options?: { jQuery?: true } }): Promise<T>;
-    static prompt<T>(
-      config: Dialog.PromptConfig<T, HTMLElement> & { options: { jQuery: false }; rejectClose: false },
-    ): Promise<T | null>;
-    static prompt<T>(config: Dialog.PromptConfig<T, HTMLElement> & { options: { jQuery: false } }): Promise<T>;
-    static prompt<T>(config: Dialog.PromptConfig<T, JQuery | HTMLElement> & { rejectClose: false }): Promise<T | null>;
-    static prompt<T>(config: Dialog.PromptConfig<T, JQuery | HTMLElement>): Promise<T>;
+    static prompt<
+      const Value,
+      const RejectClose extends boolean | undefined = undefined,
+      const Options extends Partial<Dialog.Options> | undefined = undefined,
+    >(config: Dialog.PromptConfig<Value, RejectClose, Options>): Promise<Value | Dialog.OnReject<RejectClose, true>>;
 
     /**
      * Wrap the Dialog with an enclosing Promise which resolves or rejects when the client makes a choice.
@@ -211,30 +141,35 @@ declare global {
      * @param renderOptions - Options passed to the Dialog render call
      * @returns A promise which resolves to the dialogs result.
      */
-    static wait<Options extends DialogOptions = DialogOptions>(
-      data: DialogData<JQuery>,
-      options?: Partial<DialogOptions> & { jQuery?: true },
-      renderOptions?: Application.RenderOptions<Options>,
-    ): Promise<unknown>;
-    static wait<Options extends DialogOptions = DialogOptions>(
-      data: DialogData<HTMLElement>,
-      options?: Partial<DialogOptions> & { jQuery?: false },
-      renderOptions?: Application.RenderOptions<Options>,
-    ): Promise<unknown>;
-    static wait<Options extends DialogOptions = DialogOptions>(
-      data: DialogData<JQuery | HTMLElement>,
-      options?: Partial<DialogOptions>,
-      renderOptions?: Application.RenderOptions<Options>,
+    static wait<const Options extends Partial<Dialog.Options> | undefined = undefined>(
+      data: Dialog.Data<Dialog.JQueryOrHTML<Options>>,
+      options?: Options,
+      renderOptions?: Options & Application._RenderOptions,
     ): Promise<unknown>;
   }
 
   namespace Dialog {
+    /** @internal */
+    type _JQueryOrHTML<IsJQuery extends boolean | undefined> = IsJQuery extends true ? JQuery : HTMLElement;
+
+    type JQueryOrHTML<Options extends Partial<Dialog.Options> | undefined> = _JQueryOrHTML<
+      Options extends {
+        readonly jQuery: infer JQuery;
+      }
+        ? JQuery
+        : true
+    >;
+
     /**
-     * @typeParam Yes          - The value returned by the yes callback
-     * @typeParam No           - The value returned by the no callback
-     * @typeParam JQueryOrHtml - The parameter passed to the callbacks, either JQuery or HTMLElement
+     * @typeParam Yes - The value returned by the yes callback
+     * @typeParam No  - The value returned by the no callback
      */
-    interface ConfirmConfig<Yes, No, JQueryOrHtml> {
+    interface ConfirmConfig<
+      Yes,
+      No,
+      RejectClose extends boolean | undefined,
+      Options extends Partial<Dialog.Options> | undefined,
+    > {
       /**
        * The confirmation window title
        */
@@ -248,17 +183,18 @@ declare global {
       /**
        * Callback function upon yes
        */
-      yes?: (html: JQueryOrHtml) => Yes;
+      // Note(LukeAbby): This is a workaround for the lack of `const` type parameters in interfaces.
+      yes?: (html: JQueryOrHTML<Options>) => Yes | true;
 
       /**
        * Callback function upon no
        */
-      no?: (html: JQueryOrHtml) => No;
+      no?: (html: JQueryOrHTML<Options>) => No | false;
 
       /**
        * A function to call when the dialog is rendered
        */
-      render?: (html: JQueryOrHtml) => void;
+      render?: (html: JQueryOrHTML<Options>) => void;
 
       /**
        * Make "yes" the default choice?
@@ -270,20 +206,31 @@ declare global {
        * Reject the Promise if the Dialog is closed without making a choice.
        * @defaultValue `false`
        */
-      rejectClose?: boolean;
+      rejectClose?: RejectClose;
 
       /**
        * Additional rendering options passed to the Dialog
        * @defaultValue `{}`
        */
-      options?: Partial<DialogOptions>;
+      options?: Options;
     }
 
+    type OnReject<RejectClose extends boolean | undefined, Default extends boolean> = RejectClose extends undefined
+      ? Default extends false
+        ? null
+        : never
+      : RejectClose extends false
+        ? null
+        : never;
+
     /**
-     * @typeParam Value        - The value returned by the callback function
-     * @typeParam JQueryOrHtml - The parameter passed to the callbacks, either JQuery or HTMLElement
+     * @typeParam Value - The value returned by the callback function
      */
-    interface PromptConfig<Value, JQueryOrHtml> {
+    interface PromptConfig<
+      Value,
+      RejectClose extends boolean | undefined,
+      Options extends Partial<Dialog.Options> | undefined,
+    > {
       /**
        * The confirmation window title
        */
@@ -302,25 +249,89 @@ declare global {
       /**
        * A callback function to fire when the button is clicked
        */
-      callback: (html: JQueryOrHtml) => Value;
+      callback: (html: JQueryOrHTML<Options>) => Value;
 
       /**
        * A function that fires after the dialog is rendered
        */
-      render?: (html: JQueryOrHtml) => void;
+      render?: (html: JQueryOrHTML<Options>) => void;
 
       /**
        * Reject the promise if the dialog is closed without confirming the
        * choice, otherwise resolve as null
        * @defaultValue `true`
        */
-      rejectClose?: boolean;
+      rejectClose?: RejectClose;
 
       /**
        * Additional rendering options
        * @defaultValue `{}`
        */
-      options?: Partial<DialogOptions>;
+      options?: Options;
+    }
+
+    interface Options extends Application.Options {
+      /**
+       * Whether to provide jQuery objects to callback functions (if true) or plain
+       * HTMLElement instances (if false). This is currently true by default but in the
+       * future will become false by default.
+       * @defaultValue `true`
+       */
+      jQuery?: boolean;
+    }
+
+    interface Button<T = unknown, JQueryOrHtml = JQuery | HTMLElement> {
+      /**
+       * A Font Awesome icon for the button
+       */
+      icon?: string;
+
+      /**
+       * The label for the button
+       */
+      label: string;
+
+      /**
+       * Whether the button is disabled
+       */
+      disabled?: boolean;
+
+      /**
+       * A callback function that fires when the button is clicked
+       */
+      callback?: (html: JQueryOrHtml, event?: MouseEvent) => T;
+    }
+
+    interface Data<JQueryOrHTML extends JQuery | HTMLElement> {
+      /**
+       * The window title displayed in the dialog header
+       */
+      title: string;
+
+      /**
+       * HTML content for the dialog form
+       */
+      content: string;
+
+      /**
+       * The buttons which are displayed as action choices for the dialog
+       */
+      buttons: Record<string, Button<unknown, JQueryOrHTML>>;
+
+      /**
+       * The name of the default button which should be triggered on Enter keypress
+       */
+      default?: string;
+
+      /**
+       * A callback function invoked when the dialog is rendered
+       */
+      render?: (element: JQueryOrHTML) => void;
+
+      /**
+       * Common callback operations to perform when the dialog is closed
+       */
+      close?: (element: JQueryOrHTML) => void;
     }
   }
 }

package/src/foundry/client/ui/drag.d.mts

@@ -14,7 +14,7 @@ declare global {
      */
     constructor(app: Draggable["app"], element: JQuery, handle: Draggable["handle"], resizable?: R);
 
-    app: Application;
+    app: Application.Any;
 
     element: HTMLElement;
 

package/src/foundry/client/ui/dragdrop.d.mts

@@ -1,36 +1,15 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
-
-export {};
+import type { InexactPartial } from "#utils";
 
 declare global {
-  interface DragDropConfiguration {
-    /**
-     * The CSS selector used to target draggable elements.
-     */
-    dragSelector?: DragDrop["dragSelector"];
-
-    /**
-     * The CSS selector used to target viable drop targets.
-     */
-    dropSelector?: DragDrop["dropSelector"];
-
-    /**
-     * An object of permission test functions for each action
-     * @defaultValue `{}`
-     */
-    permissions?: DragDrop["permissions"];
-
-    /**
-     * An object of callback functions for each action
-     * @defaultValue `{}`
-     */
-    callbacks?: DragDrop["callbacks"];
-  }
+  /**
+   * @deprecated {@link DragDrop.Configuration | `DragDrop.Configuration`}
+   */
+  type DragDropConfiguration = DragDrop.Configuration;
 
   /**
    * A controller class for managing drag and drop workflows within an Application instance.
    * The controller manages the following actions: dragstart, dragover, drop
-   * @see {@link Application}
+   * @see {@link Application | `Application`}
    *
    * @example Activate drag-and-drop handling for a certain set of elements
    * ```typescript
@@ -47,7 +26,7 @@ declare global {
     /**
      * @param options - (default: `{}`)
      */
-    constructor({ dragSelector, dropSelector, permissions, callbacks }?: InexactPartial<DragDropConfiguration>);
+    constructor({ dragSelector, dropSelector, permissions, callbacks }?: DragDrop.Configuration);
 
     /**
      * The HTML selector which identifies draggable elements
@@ -120,5 +99,32 @@ declare global {
 
   namespace DragDrop {
     type Action = "dragstart" | "dragover" | "drop";
+
+    /** @internal */
+    interface _Configuration {
+      /**
+       * The CSS selector used to target draggable elements.
+       */
+      dragSelector?: DragDrop["dragSelector"];
+
+      /**
+       * The CSS selector used to target viable drop targets.
+       */
+      dropSelector?: DragDrop["dropSelector"];
+
+      /**
+       * An object of permission test functions for each action
+       * @defaultValue `{}`
+       */
+      permissions?: DragDrop["permissions"];
+
+      /**
+       * An object of callback functions for each action
+       * @defaultValue `{}`
+       */
+      callbacks?: DragDrop["callbacks"];
+    }
+
+    interface Configuration extends InexactPartial<_Configuration> {}
   }
 }

package/src/foundry/client/ui/editor.d.mts

@@ -1,6 +1,5 @@
 import type { EditorView } from "prosemirror-view";
-import type { AnyObject, InexactPartial, MaybePromise } from "../../../types/utils.d.mts";
-import type { ConfiguredDocumentClassForName } from "../../../types/helperTypes.d.mts";
+import type { AnyObject, JSONValue, MaybePromise } from "#utils";
 
 declare global {
   /**
@@ -119,10 +118,7 @@ declare global {
      * @param suffix     - A suffix string to append to denote that the text was truncated.
      *                     (default: `"…"`)
      */
-    static truncateText(
-      text: string,
-      { maxLength, splitWords, suffix }?: { maxLength?: number; splitWords?: boolean; suffix?: string },
-    ): string;
+    static truncateText(text: string, { maxLength, splitWords, suffix }?: TextEditor.TruncateTextOptions): string;
 
     /**
      * Recursively identify the text nodes within a parent HTML node for potential content replacement.
@@ -166,10 +162,7 @@ declare global {
      */
     protected static _createContentLink(
       match: RegExpMatchArray,
-      options?: InexactPartial<{
-        /** A document to resolve relative UUIDs against.*/
-        relativeTo: foundry.abstract.Document.Any;
-      }>,
+      options?: TextEditor.CreateContentLinkOptions,
     ): Promise<HTMLAnchorElement>;
 
     /**
@@ -288,9 +281,7 @@ declare global {
      * @remarks `TokensLayer#_onDropActorData` returns a number - a notification ID - the  if the user lacks permissions
      * @remarks `User#assignHotbarMacro` returns a promise to a user document
      */
-    static getDragEventData(
-      event: DragEvent,
-    ): PlaceableObject | number | Promise<ConfiguredDocumentClassForName<"User">>;
+    static getDragEventData(event: DragEvent): JSONValue;
 
     /**
      * Given a Drop event, returns a Content link if possible such as `@Actor[ABC123]`, else null
@@ -298,13 +289,7 @@ declare global {
      * @param options   - Additional options to configure link creation.
      */
     // TODO: improve as part of https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues/928
-    static getContentLink(
-      eventData: object,
-      options?: InexactPartial<{
-        /** A document to generate the link relative to. */
-        relativeTo: foundry.abstract.Document.Any;
-      }>,
-    ): Promise<string | null>;
+    static getContentLink(eventData: object, options?: TextEditor.GetContentLinkOptions): Promise<string | null>;
 
     /**
      * Upload an image to a document's asset path.
@@ -321,7 +306,7 @@ declare global {
       /**
        * Which rich text editor engine to use, "tinymce" or "prosemirror". TinyMCE
        * is deprecated and will be removed in a later version.
-       * @defaultValue "tinymce"
+       * @defaultValue `"tinymce"`
        */
       engine?: "tinymce" | "prosemirror";
 
@@ -435,6 +420,13 @@ declare global {
        */
       rolls?: boolean | undefined;
 
+      /**
+       * Replace embedded content?
+       */
+      embeds?: boolean | undefined;
+
+      _embedDepth?: number | null | undefined;
+
       /**
        * The data object providing context for inline rolls, or a function that produces it.
        */
@@ -542,5 +534,21 @@ declare global {
        */
       enricher: Enricher;
     }
+
+    interface TruncateTextOptions {
+      maxLength?: number;
+      splitWords?: boolean;
+      suffix?: string;
+    }
+
+    interface GetContentLinkOptions {
+      /** A document to generate the link relative to. */
+      relativeTo?: foundry.abstract.Document.Any | undefined;
+    }
+
+    interface CreateContentLinkOptions {
+      /** A document to resolve relative UUIDs against.*/
+      relativeTo?: foundry.abstract.Document.Any | undefined;
+    }
   }
 }

package/src/foundry/client/ui/filepicker.d.mts

@@ -1,47 +1,17 @@
-import type { EmptyObject, MaybePromise, ValueOf } from "../../../types/utils.d.mts";
+import type { EmptyObject, MaybePromise, ValueOf } from "#utils";
 
 declare global {
-  interface FilePickerOptions extends ApplicationOptions {
-    /** A type of file to target */
-    type?: FilePicker.Type | undefined;
-
-    /** The current file path being modified, if any */
-    current?: string | undefined;
-
-    /** A current file source in "data", "public", or "s3" */
-    activeSource?: FilePicker.SourceType | undefined;
-
-    /** A callback function to trigger once a file has been selected */
-    callback?: FilePicker.Callback | undefined;
-
-    /** A flag which permits explicitly disallowing upload, true by default */
-    allowUpload?: boolean | undefined;
-
-    /** An HTML form field that the result of this selection is applied to */
-    field?: HTMLElement | undefined;
-
-    /** An HTML button element which triggers the display of this picker */
-    button?: HTMLElement | undefined;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES */
-    favorites?: Record<string, FilePicker.FavoriteFolder>;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES */
-    displayMode?: FilePicker.DisplayMode | undefined;
-
-    /** Display the tile size configuration. */
-    tileSize?: boolean | undefined;
-
-    /** Redirect to the root directory rather than starting in the source directory of one of these files. */
-    redirectToRoot?: string[];
-  }
+  /**
+   * @deprecated {@link FilePicker.Options | `FilePicker.Options`}
+   */
+  type FilePickerOptions = FilePicker.Options;
 
   /**
    * The FilePicker application renders contents of the server-side public directory.
    * This app allows for navigating and uploading files to the public path.
    * @typeParam Options - the type of the options object
    */
-  class FilePicker<Options extends FilePickerOptions = FilePickerOptions> extends Application<Options> {
+  class FilePicker<Options extends FilePicker.Options = FilePicker.Options> extends Application<Options> {
     /**
      * @param options - Options that configure the behavior of the FilePicker
      */
@@ -177,7 +147,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): FilePickerOptions;
+    static override get defaultOptions(): FilePicker.Options;
 
     /**
      * Given a current file path, determine the directory it belongs to
@@ -348,6 +318,41 @@ declare global {
   }
 
   namespace FilePicker {
+    interface Options extends Application.Options {
+      /** A type of file to target */
+      type?: FilePicker.Type | undefined;
+
+      /** The current file path being modified, if any */
+      current?: string | undefined;
+
+      /** A current file source in "data", "public", or "s3" */
+      activeSource?: FilePicker.SourceType | undefined;
+
+      /** A callback function to trigger once a file has been selected */
+      callback?: FilePicker.Callback | undefined;
+
+      /** A flag which permits explicitly disallowing upload, true by default */
+      allowUpload?: boolean | undefined;
+
+      /** An HTML form field that the result of this selection is applied to */
+      field?: HTMLElement | undefined;
+
+      /** An HTML button element which triggers the display of this picker */
+      button?: HTMLElement | undefined;
+
+      /** The picker display mode in FilePicker.DISPLAY_MODES */
+      favorites?: Record<string, FilePicker.FavoriteFolder>;
+
+      /** The picker display mode in FilePicker.DISPLAY_MODES */
+      displayMode?: FilePicker.DisplayMode | undefined;
+
+      /** Display the tile size configuration. */
+      tileSize?: boolean | undefined;
+
+      /** Redirect to the root directory rather than starting in the source directory of one of these files. */
+      redirectToRoot?: string[];
+    }
+
     interface BrowseResult {
       target: string;
       private: boolean;
@@ -372,7 +377,7 @@ declare global {
 
       /**
        * The requested dir represents a wildcard path
-       * @defaultValue false
+       * @defaultValue `false`
        */
       wildcard?: boolean | undefined;
     }