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

package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts

@@ -1,22 +1,6 @@
-import type { InterfaceToObject } from "../../../../../../types/helperTypes.d.mts";
-
-declare abstract class AnyRainShader extends RainShader {
-  constructor(arg0: never, ...args: never[]);
-}
+import type { InterfaceToObject } from "fvtt-types/utils";
 
 declare global {
-  namespace RainShader {
-    type AnyConstructor = typeof AnyRainShader;
-
-    interface DefaultUniforms extends AbstractBaseShader.Uniforms {
-      opacity: number;
-      intensity: number;
-      strength: number;
-      rotation: number;
-      resolution: [number, number];
-    }
-  }
-
   /**
    * Rain shader effect.
    */
@@ -39,4 +23,21 @@ declare global {
 
     static override fragmentShader: string;
   }
+
+  namespace RainShader {
+    interface Any extends AnyRainShader {}
+    type AnyConstructor = typeof AnyRainShader;
+
+    interface DefaultUniforms extends AbstractBaseShader.Uniforms {
+      opacity: number;
+      intensity: number;
+      strength: number;
+      rotation: number;
+      resolution: [number, number];
+    }
+  }
+}
+
+declare abstract class AnyRainShader extends RainShader {
+  constructor(arg0: never, ...args: never[]);
 }

package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts

@@ -1,18 +1,6 @@
-import type { InterfaceToObject } from "../../../../../../types/helperTypes.d.mts";
-
-declare abstract class AnySnowShader extends SnowShader {
-  constructor(arg0: never, ...args: never[]);
-}
+import type { InterfaceToObject } from "fvtt-types/utils";
 
 declare global {
-  namespace SnowShader {
-    type AnyConstructor = typeof AnySnowShader;
-
-    interface DefaultUniforms extends AbstractBaseShader.Uniforms {
-      direction: number;
-    }
-  }
-
   /**
    * Snow shader effect.
    */
@@ -31,4 +19,17 @@ declare global {
 
     static override fragmentShader: string;
   }
+
+  namespace SnowShader {
+    interface Any extends AnySnowShader {}
+    type AnyConstructor = typeof AnySnowShader;
+
+    interface DefaultUniforms extends AbstractBaseShader.Uniforms {
+      direction: number;
+    }
+  }
+}
+
+declare abstract class AnySnowShader extends SnowShader {
+  constructor(arg0: never, ...args: never[]);
 }

package/src/foundry/client/pixi/workers/texture-worker.d.mts

@@ -1,4 +1,11 @@
-export {};
+import type { NullishProps } from "../../../../utils/index.d.mts";
+import type {
+  _ProcessBufferToBase64Options,
+  Debug,
+  ProcessBufferRedToBufferRGBAReturn,
+  ProcessBufferRGBAToBufferREDReturn,
+  ProcessBufferToBase64Return,
+} from "../../../../types/workers/image-compressor.d.mts";
 
 declare global {
   /**
@@ -23,8 +30,8 @@ declare global {
       buffer: Uint8ClampedArray,
       width: number,
       height: number,
-      options?: TextureCompressor.compressBase64Options,
-    ): Promise<unknown>;
+      options?: TextureCompressor.CompressBase64Options,
+    ): Promise<ProcessBufferToBase64Return>;
 
     /**
      * Expand a buffer in RED format to a buffer in RGBA format.
@@ -36,8 +43,8 @@ declare global {
       buffer: Uint8ClampedArray,
       width: number,
       height: number,
-      options?: TextureCompressor.expandRedToRGBAOptions,
-    ): Promise<unknown>;
+      options?: TextureCompressor.ExpandOrReduceBufferOptions,
+    ): Promise<ProcessBufferRedToBufferRGBAReturn>;
 
     /**
      * Expand a buffer in RED format to a buffer in RGBA format.
@@ -49,77 +56,50 @@ declare global {
       buffer: Uint8ClampedArray,
       width: number,
       height: number,
-      options?: TextureCompressor.reduceRGBAToRedOptions,
-    ): Promise<unknown>;
+      options?: TextureCompressor.ExpandOrReduceBufferOptions,
+    ): Promise<ProcessBufferRGBAToBufferREDReturn>;
   }
 
   namespace TextureCompressor {
-    interface ConstructorOptions {
+    type Any = AnyTextureCompressor;
+    type AnyConstructor = typeof AnyTextureCompressor;
+
+    /** @internal */
+    type _ConstructorOptions = NullishProps<{
       /**
        * Should the worker run in debug mode?
        * @defaultValue `false`
        */
-      debug?: boolean;
+      debug: boolean;
 
       /**
        * @defaultValue `["./workers/image-compressor.js", "./spark-md5.min.js"]`
+       * @remarks Undocumented by Foundry
        */
-      scripts?: string[];
+      scripts: string[];
 
       /**
        * @defaultValue `false`
+       * @remarks Undocumented by Foundry
        */
-      loadPrimitives?: boolean;
+      loadPrimitives: boolean;
 
       /**
        * Do we need to control the hash?
        * @defaultValue `false`
        */
       controlHash?: boolean;
-    }
-
-    interface compressBase64Options {
-      /**
-       * The required image type.
-       * @defaultValue `"image/png"`
-       */
-      type?: string;
-
-      /**
-       * The required image quality.
-       * @defaultValue `1`
-       */
-      quality?: number;
-
-      /**
-       * The debug option.
-       * @defaultValue `false`
-       */
-      debug?: boolean;
+    }>;
 
-      readFormat: PIXI.FORMATS;
-    }
+    /** Options for the {@link TextureCompressor} constructor */
+    interface ConstructorOptions extends _ConstructorOptions {}
 
-    interface expandRedToRGBAOptions {
-      /**
-       * The debug option
-       * @defaultValue `false`
-       */
-      debug: boolean;
-    }
-
-    interface reduceRGBAToRedOptions {
-      /**
-       * The debug option
-       * @defaultValue `false`
-       */
-      debug?: boolean;
-
-      compression: (typeof TextureExtractor)["COMPRESSION_MODES"];
+    interface CompressBase64Options extends _ProcessBufferToBase64Options, Debug {}
 
-      type: string;
-
-      quality: number;
-    }
+    interface ExpandOrReduceBufferOptions extends Pick<_ProcessBufferToBase64Options, "hash">, Debug {}
   }
 }
+
+declare abstract class AnyTextureCompressor extends TextureCompressor {
+  constructor(arg0: never, ...args: never[]);
+}

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

@@ -1,69 +1,14 @@
-import type { MaybePromise } from "../../../types/utils.d.mts";
+import type { MaybePromise } from "fvtt-types/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}
      */
-    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> = 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 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 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,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 export {};
 

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

@@ -1,6 +1,6 @@
 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, InexactPartial, MaybePromise } from "fvtt-types/utils";
+import type Document from "../../common/abstract/document.d.mts";
 
 declare global {
   /**
@@ -290,7 +290,7 @@ declare global {
      */
     static getDragEventData(
       event: DragEvent,
-    ): PlaceableObject | number | Promise<ConfiguredDocumentClassForName<"User">>;
+    ): PlaceableObject | number | Promise<Document.ConfiguredClassForName<"User">>;
 
     /**
      * Given a Drop event, returns a Content link if possible such as `@Actor[ABC123]`, else null

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

@@ -1,4 +1,4 @@
-import type { EmptyObject, MaybePromise, ValueOf } from "../../../types/utils.d.mts";
+import type { EmptyObject, MaybePromise, ValueOf } from "fvtt-types/utils";
 
 declare global {
   interface FilePickerOptions extends ApplicationOptions {

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

@@ -1,4 +1,4 @@
-import type { ValueOf } from "../../../types/utils.d.mts";
+import type { ValueOf } from "fvtt-types/utils";
 
 declare global {
   /** Options which customize the behavior of the filter */
@@ -79,7 +79,7 @@ declare global {
     /**
      * A callback function to trigger when the tab is changed
      */
-    callback: (event: KeyboardEvent, query: string, rgx: RegExp, content: string) => void;
+    callback: (event: KeyboardEvent, query: string, rgx: RegExp, content: HTMLElement | null) => void;
 
     /**
      * The regular expression corresponding to the query that should be matched against

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

@@ -1,4 +1,3 @@
-import "./context.d.mts";
 import "./dialog.d.mts";
 import "./drag.d.mts";
 import "./dragdrop.d.mts";
@@ -6,7 +5,6 @@ import "./editor.d.mts";
 import "./filepicker.d.mts";
 import "./filter.d.mts";
 import "./forms.d.mts";
-import "./notifications.d.mts";
 import "./prosemirror.d.mts";
 import "./secrets.d.mts";
 import "./tabs.d.mts";