@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

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

@@ -41,7 +41,7 @@ declare global {
   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: Dialog.Data<Dialog.JQueryOrHTML<Options>>, options?: Partial<Options>);
 
@@ -150,7 +150,7 @@ declare global {
 
   namespace Dialog {
     /** @internal */
-    type _JQueryOrHTML<IsJQuery extends boolean> = IsJQuery extends true ? JQuery : HTMLElement;
+    type _JQueryOrHTML<IsJQuery extends boolean | undefined> = IsJQuery extends true ? JQuery : HTMLElement;
 
     type JQueryOrHTML<Options extends Partial<Dialog.Options> | undefined> = _JQueryOrHTML<
       Options extends {
@@ -270,7 +270,7 @@ declare global {
       options?: Options;
     }
 
-    interface Options extends ApplicationOptions {
+    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

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

@@ -1,36 +1,15 @@
 import type { InexactPartial } from "fvtt-types/utils";
 
-export {};
-
 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 "fvtt-types/utils";
-import type Document from "../../common/abstract/document.d.mts";
+import type { AnyObject, JSONValue, MaybePromise } from "fvtt-types/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<Document.ConfiguredClassForName<"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 "fvtt-types/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;
     }

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

@@ -1,56 +1,19 @@
 import type { ValueOf } from "fvtt-types/utils";
 
 declare global {
-  /** Options which customize the behavior of the filter */
-  interface SearchFilterConfiguration {
-    /**
-     * The CSS selector used to target the text input element.
-     */
-    inputSelector: string;
-
-    /**
-     * The CSS selector used to target the content container for these tabs.
-     */
-    contentSelector: string;
-
-    /**
-     * A callback function which executes when the filter changes.
-     */
-    callback?: SearchFilter["callback"];
-
-    /**
-     * The initial value of the search query.
-     * @defaultValue `""`
-     */
-    initial?: SearchFilter["query"] | undefined;
-
-    /**
-     * The number of milliseconds to wait for text input before processing.
-     * @defaultValue `100`
-     */
-    delay?: number;
-  }
-
-  interface FieldFilter {
-    /** The dot-delimited path to the field being filtered */
-    field: string;
-
-    /**
-     * The search operator, from CONST.OPERATORS
-     * @defaultValue `SearchFilter.OPERATORS.EQUALS`
-     */
-    operator: ValueOf<typeof SearchFilter.OPERATORS>;
-
-    /** Negate the filter, returning results which do NOT match the filter criteria */
-    negate: boolean;
+  /**
+   * @deprecated {@link SearchFilter.Configuration | `SearchFilter.Configuration`}
+   */
+  type SearchFilterConfiguration = SearchFilter.Configuration;
 
-    /** The value against which to test */
-    value: any;
-  }
+  /**
+   * @deprecated {@link SearchFilter.FieldFilter | `SearchFilter.FieldFilter`}
+   */
+  type FieldFilter = SearchFilter.FieldFilter;
 
   /**
    * A controller class for managing a text input widget that filters the contents of some other UI element
-   * @see {@link Application}
+   * @see {@link Application | `Application`}
    */
   class SearchFilter {
     static readonly OPERATORS: {
@@ -69,7 +32,7 @@ declare global {
     /**
      * @param options - Options which customize the behavior of the filter
      */
-    constructor(options: SearchFilterConfiguration);
+    constructor(options: SearchFilter.Configuration);
 
     /**
      * The value of the current query string
@@ -123,7 +86,7 @@ declare global {
      * @param filter - The filter to test
      * @returns Whether the object matches the filter
      */
-    static evaluateFilter(obj: Record<string, any>, filter: FieldFilter): boolean;
+    static evaluateFilter(obj: Record<string, any>, filter: SearchFilter.FieldFilter): boolean;
 
     /**
      * Bind the SearchFilter controller to an HTML application
@@ -145,4 +108,53 @@ declare global {
      */
     static cleanQuery(query: string): string;
   }
+
+  namespace SearchFilter {
+    /** Options which customize the behavior of the filter */
+    interface Configuration {
+      /**
+       * The CSS selector used to target the text input element.
+       */
+      inputSelector: string;
+
+      /**
+       * The CSS selector used to target the content container for these tabs.
+       */
+      contentSelector: string;
+
+      /**
+       * A callback function which executes when the filter changes.
+       */
+      callback?: SearchFilter["callback"];
+
+      /**
+       * The initial value of the search query.
+       * @defaultValue `""`
+       */
+      initial?: SearchFilter["query"] | undefined;
+
+      /**
+       * The number of milliseconds to wait for text input before processing.
+       * @defaultValue `100`
+       */
+      delay?: number;
+    }
+
+    interface FieldFilter {
+      /** The dot-delimited path to the field being filtered */
+      field: string;
+
+      /**
+       * The search operator, from CONST.OPERATORS
+       * @defaultValue `SearchFilter.OPERATORS.EQUALS`
+       */
+      operator: ValueOf<typeof SearchFilter.OPERATORS>;
+
+      /** Negate the filter, returning results which do NOT match the filter criteria */
+      negate: boolean;
+
+      /** The value against which to test */
+      value: any;
+    }
+  }
 }

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

@@ -58,28 +58,28 @@ declare global {
      */
     override append(name: string, value: any): void;
   }
-}
 
-declare namespace FormDataExtended {
-  interface Options {
-    /**
-     * A record of TinyMCE editor metadata objects, indexed by their update key
-     * (default: `{}`)
-     */
-    editors?: FormDataExtended["editors"];
-    /**
-     * A mapping of data types for form fields
-     * (default: `{}`)
-     */
-    dtypes?: FormDataExtended["dtypes"];
-    /**
-     * Include disabled fields?
-     * (default: `false`)
-     */
-    disabled?: boolean;
-    /** Include readonly fields?
-     * (default: `true`)
-     */
-    readonly?: boolean;
+  namespace FormDataExtended {
+    interface Options {
+      /**
+       * A record of TinyMCE editor metadata objects, indexed by their update key
+       * (default: `{}`)
+       */
+      editors?: FormDataExtended["editors"];
+      /**
+       * A mapping of data types for form fields
+       * (default: `{}`)
+       */
+      dtypes?: FormDataExtended["dtypes"];
+      /**
+       * Include disabled fields?
+       * (default: `false`)
+       */
+      disabled?: boolean;
+      /** Include readonly fields?
+       * (default: `true`)
+       */
+      readonly?: boolean;
+    }
   }
 }

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

@@ -4,16 +4,16 @@ import type { EditorView } from "prosemirror-view";
 import type { Socket } from "socket.io-client";
 
 declare global {
-  interface ProseMirrorHistory {
-    /** The ID of the user who submitted the step. */
-    userId: string;
-    /** The step that was submitted. */
-    step: Step;
-  }
+  /**
+   * @deprecated {@link ProseMirrorEditor.History | `ProseMirrorEditor.History`}
+   */
+  type ProseMirrorHistory = ProseMirrorEditor.History;
+
   namespace ProseMirrorEditor {
     interface Options {
       document?: ClientDocument;
     }
+
     interface CreateOptions {
       /** A string to uniquely identify this ProseMirror instance. Ignored for a collaborative editor. */
       uuid: string;
@@ -26,7 +26,15 @@ declare global {
       /** Whether to enable collaborative editing for this editor. */
       collaborate: boolean;
     }
+
+    interface History {
+      /** The ID of the user who submitted the step. */
+      userId: string;
+      /** The step that was submitted. */
+      step: Step;
+    }
   }
+
   /**
    * A class responsible for managing state and collaborative editing of a single ProseMirror instance.
    */
@@ -84,7 +92,7 @@ declare global {
      * @param offset  - The offset into the history, representing the point at which it was last truncated.
      * @param history - The entire edit history.
      */
-    protected _onNewSteps(offset: string, history: ProseMirrorHistory[]): void;
+    protected _onNewSteps(offset: string, history: ProseMirrorEditor.History[]): void;
 
     /**
      * Disable source code editing if the user was editing it when new steps arrived.

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

@@ -1,37 +1,24 @@
-import type Document from "../../common/abstract/document.d.mts";
+import type Document from "#common/abstract/document.d.mts";
 
 declare global {
   /**
-   * @param secret - The secret element whose surrounding content we wish to retrieve.
-   * @returns The content where the secret is housed.
+   * @deprecated {@link HTMLSecret.ContentCallback | `HTMLSecret.ContentCallback`}
    */
-  type HTMLSecretContentCallback = (secret: HTMLElement) => string;
+  export import HTMLSecretContentCallback = HTMLSecret.ContentCallback;
 
   /**
-   * @param secret  - The secret element that is being manipulated.
-   * @param content - The content block containing the updated secret element.
-   * @returns The updated Document.
+   * @deprecated {@link HTMLSecret.UpdateCallback | `HTMLSecret.UpdateCallback`}
    */
-  type HTMLSecretUpdateCallback<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > = (secret: HTMLElement, content: string) => Promise<ConcreteDocument>;
+  export import HTMLSecretUpdateCallback = HTMLSecret.UpdateCallback;
 
-  interface HTMLSecretConfiguration<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > {
-    /** The CSS selector used to target content that contains secret blocks. */
-    parentSelector: string;
-
-    /** An object of callback functions for each operation. */
-    callbacks: {
-      content: HTMLSecretContentCallback;
-      update: HTMLSecretUpdateCallback<ConcreteDocument>;
-    };
-  }
+  /**
+   * @deprecated {@link HTMLSecret.Configuration | `HTMLSecret.Configuration`}
+   */
+  export import HTMLSecretConfiguration = HTMLSecret.Configuration;
 
   /**
    * A composable class for managing functionality for secret blocks within DocumentSheets.
-   * @see DocumentSheet
+   * @see {@link DocumentSheet | `DocumentSheet`}
    * @example Activate secret revealing functionality within a certain block of content.
    * ```js
    * const secrets = new HTMLSecret({
@@ -48,16 +35,13 @@ declare global {
     /**
      * @param config - Configuration options.
      */
-    constructor(
-      config: Omit<HTMLSecretConfiguration<ConcreteDocument>, "callbacks"> &
-        Partial<Pick<HTMLSecretConfiguration<ConcreteDocument>, "callbacks">>,
-    );
+    constructor(config: HTMLSecret.Configuration<ConcreteDocument>);
 
     /** The CSS selector used to target secret blocks. */
     readonly parentSelector: string;
 
     /** An object of callback functions for each operation. */
-    readonly callbacks: Readonly<HTMLSecretConfiguration<ConcreteDocument>["callbacks"]>;
+    readonly callbacks: Readonly<HTMLSecret.Callbacks<ConcreteDocument>>;
 
     /**
      * Add event listeners to the targeted secret blocks.
@@ -72,4 +56,35 @@ declare global {
      */
     protected _onToggleSecret(event: MouseEvent): ConcreteDocument | void;
   }
+
+  namespace HTMLSecret {
+    /**
+     * @param secret - The secret element whose surrounding content we wish to retrieve.
+     * @returns The content where the secret is housed.
+     */
+    type ContentCallback = (secret: HTMLElement) => string;
+
+    /**
+     * @param secret  - The secret element that is being manipulated.
+     * @param content - The content block containing the updated secret element.
+     * @returns The updated Document.
+     */
+    type UpdateCallback<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> = (
+      secret: HTMLElement,
+      content: string,
+    ) => Promise<ConcreteDocument>;
+
+    interface Configuration<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> {
+      /** The CSS selector used to target content that contains secret blocks. */
+      parentSelector: string;
+
+      /** An object of callback functions for each operation. */
+      callbacks?: Callbacks<ConcreteDocument> | undefined;
+    }
+
+    interface Callbacks<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> {
+      content: HTMLSecret.ContentCallback;
+      update: HTMLSecret.UpdateCallback<ConcreteDocument>;
+    }
+  }
 }