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

package/src/foundry/client/apps/app.d.mts

@@ -1,4 +1,4 @@
-import type { MaybePromise, ValueOf } from "../../../types/utils.d.mts";
+import type { MaybePromise, Identity, ValueOf } from "#utils";
 
 declare global {
   /**
@@ -14,115 +14,14 @@ declare global {
   const MIN_WINDOW_WIDTH: 200;
   const MIN_WINDOW_HEIGHT: 50;
 
-  interface ApplicationOptions {
-    /**
-     * A named "base application" which generates an additional hook
-     * @defaultValue `null`
-     */
-    baseApplication: string | null;
-
-    /**
-     * The default pixel width for the rendered HTML
-     * @defaultValue `null`
-     */
-    width: number | null;
-
-    /**
-     * The default pixel height for the rendered HTML
-     * @defaultValue `null`
-     */
-    height: number | "auto" | null;
-
-    /**
-     * The default offset-top position for the rendered HTML
-     * @defaultValue `null`
-     */
-    top: number | null;
-
-    /**
-     * The default offset-left position for the rendered HTML
-     * @defaultValue `null`
-     */
-    left: number | null;
-
-    /**
-     * A transformation scale for the rendered HTML
-     * @defaultValue `null`
-     */
-    scale: number | null;
-
-    /**
-     * Whether to display the application as a pop-out container
-     * @defaultValue `true`
-     */
-    popOut: boolean;
-
-    /**
-     * Whether the rendered application can be minimized (popOut only)
-     * @defaultValue `true`
-     */
-    minimizable: boolean;
-
-    /**
-     * Whether the rendered application can be drag-resized (popOut only)
-     * @defaultValue `false`
-     */
-    resizable: boolean;
-
-    /**
-     * The default CSS id to assign to the rendered HTML
-     * @defaultValue `""`
-     */
-    id: string;
-
-    /**
-     * An array of CSS string classes to apply to the rendered HTML
-     * @defaultValue `[]`
-     */
-    classes: string[];
-
-    /**
-     * A default window title string (popOut only)
-     * @defaultValue `""`
-     */
-    title: string;
-
-    /**
-     * The default HTML template path to render for this Application
-     * @defaultValue `null`
-     */
-    template: string | null;
-
-    /**
-     * A list of unique CSS selectors which target containers that should
-     * have their vertical scroll positions preserved during a re-render.
-     * @defaultValue `[]`
-     */
-    scrollY: string[];
-
-    /**
-     * An array of tabbed container configurations which should be enabled
-     * for the application.
-     * @defaultValue `[]`
-     */
-    tabs: Omit<TabsConfiguration, "callback">[];
-
-    /**
-     * @defaultValue `[]`
-     */
-    dragDrop: Omit<DragDropConfiguration, "permissions" | "callbacks">[];
-
-    /**
-     * @defaultValue `[]`
-     */
-    filters: Omit<SearchFilterConfiguration, "callback">[];
-  }
+  /** @deprecated {@link Application.Options | `Application.Options`} */
+  type ApplicationOptions = Application.Options;
 
   /**
    * The standard application window that is rendered for a large variety of UI elements in Foundry VTT.
    * @typeParam Options - the type of the options object
    */
-  abstract class Application<Options extends ApplicationOptions = ApplicationOptions> {
+  abstract class Application<Options extends Application.Options = Application.Options> {
     /**
      * @param options - Configuration options which control how the application is rendered.
      *                  Application subclasses may add additional supported options, but the
@@ -177,16 +76,16 @@ declare global {
 
     /**
      * Track the render state of the Application
-     * @defaultValue {@link Application.RENDER_STATES.NONE}
-     * @see {@link Application.RENDER_STATES}
+     * @defaultValue {@link Application.RENDER_STATES.NONE | `Application.RENDER_STATES.NONE`}
+     * @see {@link Application.RENDER_STATES | `Application.RENDER_STATES`}
      */
     protected _state: Application.RenderState;
 
     /**
      * The prior render state of this Application.
      * This allows for rendering logic to understand if the application is being rendered for the first time.
-     * @defaultValue {@link Application.RENDER_STATES.NONE}
-     * @see {@link Application.RENDER_STATES}
+     * @defaultValue {@link Application.RENDER_STATES.NONE | `Application.RENDER_STATES.NONE`}
+     * @see {@link Application.RENDER_STATES | `Application.RENDER_STATES`}
      */
     protected _priorState: Application.RenderState;
 
@@ -198,7 +97,7 @@ declare global {
 
     /**
      * The sequence of rendering states that track the Application life-cycle.
-     * @see {@link Application.RenderState}
+     * @see {@link Application.RenderState | `Application.RenderState`}
      */
     static RENDER_STATES: Readonly<{
       CLOSING: -2;
@@ -235,7 +134,7 @@ declare global {
      * in this object are merged with any provided option values which are passed to the constructor upon initialization.
      * Application subclasses may include additional options which are specific to their usage.
      */
-    static get defaultOptions(): ApplicationOptions;
+    static get defaultOptions(): Application.Options;
 
     /**
      * Return the CSS application ID which uniquely references this UI element
@@ -294,7 +193,7 @@ declare global {
      * @returns The rendered Application instance
      * @remarks Some subclasses return other results.
      */
-    render(force?: boolean, options?: Application.RenderOptions<Options>): unknown;
+    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
 
     /**
      * An asynchronous inner function which handles the rendering of the Application
@@ -310,7 +209,7 @@ declare global {
      * Return the inheritance chain for this Application class up to (and including) it's base Application class.
      * @internal
      */
-    protected static _getInheritanceChain(): (typeof Application)[];
+    protected static _getInheritanceChain(): Application.AnyConstructor[];
 
     /**
      * Call all hooks for all applications in the inheritance chain.
@@ -370,7 +269,7 @@ declare global {
     protected _getHeaderButtons(): Application.HeaderButton[];
 
     /**
-     * Create a {@link ContextMenu} for this Application.
+     * Create a {@link ContextMenu | `ContextMenu`} for this Application.
      * @param html - The Application's HTML.
      * @internal
      */
@@ -511,9 +410,112 @@ declare global {
   }
 
   namespace Application {
-    type Any = Application<any>;
+    interface Any extends AnyApplication {}
+    interface AnyConstructor extends Identity<typeof AnyApplication> {}
 
-    type AnyConstructor = typeof AnyApplication;
+    interface Options {
+      /**
+       * A named "base application" which generates an additional hook
+       * @defaultValue `null`
+       */
+      baseApplication: string | null;
+
+      /**
+       * The default pixel width for the rendered HTML
+       * @defaultValue `null`
+       */
+      width: number | null;
+
+      /**
+       * The default pixel height for the rendered HTML
+       * @defaultValue `null`
+       */
+      height: number | "auto" | null;
+
+      /**
+       * The default offset-top position for the rendered HTML
+       * @defaultValue `null`
+       */
+      top: number | null;
+
+      /**
+       * The default offset-left position for the rendered HTML
+       * @defaultValue `null`
+       */
+      left: number | null;
+
+      /**
+       * A transformation scale for the rendered HTML
+       * @defaultValue `null`
+       */
+      scale: number | null;
+
+      /**
+       * Whether to display the application as a pop-out container
+       * @defaultValue `true`
+       */
+      popOut: boolean;
+
+      /**
+       * Whether the rendered application can be minimized (popOut only)
+       * @defaultValue `true`
+       */
+      minimizable: boolean;
+
+      /**
+       * Whether the rendered application can be drag-resized (popOut only)
+       * @defaultValue `false`
+       */
+      resizable: boolean;
+
+      /**
+       * The default CSS id to assign to the rendered HTML
+       * @defaultValue `""`
+       */
+      id: string;
+
+      /**
+       * An array of CSS string classes to apply to the rendered HTML
+       * @defaultValue `[]`
+       */
+      classes: string[];
+
+      /**
+       * A default window title string (popOut only)
+       * @defaultValue `""`
+       */
+      title: string;
+
+      /**
+       * The default HTML template path to render for this Application
+       * @defaultValue `null`
+       */
+      template: string | null;
+
+      /**
+       * A list of unique CSS selectors which target containers that should
+       * have their vertical scroll positions preserved during a re-render.
+       * @defaultValue `[]`
+       */
+      scrollY: string[];
+
+      /**
+       * An array of tabbed container configurations which should be enabled
+       * for the application.
+       * @defaultValue `[]`
+       */
+      tabs: Omit<Tabs.Configuration, "callback">[];
+
+      /**
+       * @defaultValue `[]`
+       */
+      dragDrop: Omit<DragDrop.Configuration, "permissions" | "callbacks">[];
+
+      /**
+       * @defaultValue `[]`
+       */
+      filters: Omit<SearchFilter.Configuration, "callback">[];
+    }
 
     interface CloseOptions {
       force?: boolean | undefined;
@@ -546,7 +548,12 @@ declare global {
       zIndex: number;
     }
 
-    type RenderOptions<Options extends ApplicationOptions = ApplicationOptions> = Partial<Options> & {
+    // TODO(LukeAbby): This should accept already partial options but all callers have to be changed.
+    // `_RenderOptions` should probably become the default and applications will extend that plus their optional options.
+    type RenderOptions<Options extends Application.Options = Application.Options> = Partial<Options> & _RenderOptions;
+
+    /** @internal */
+    interface _RenderOptions {
       /**
        * The left positioning attribute
        */
@@ -588,15 +595,15 @@ declare global {
        * The data change which motivated the render request
        */
       renderData?: object | undefined;
-    };
+    }
 
     /**
-     * @see {@link Application.RENDER_STATES}
+     * @see {@link Application.RENDER_STATES | `Application.RENDER_STATES`}
      */
-    type RenderState = ValueOf<(typeof Application)["RENDER_STATES"]>;
+    type RenderState = ValueOf<typeof Application.RENDER_STATES>;
   }
 }
 
-declare abstract class AnyApplication extends Application<any> {
-  constructor(arg0: never, ...args: never[]);
+declare abstract class AnyApplication extends Application<Application.Options> {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/av/av-config.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, Identity } from "#utils";
 
 declare global {
   /**
@@ -6,12 +6,12 @@ declare global {
    *
    * @typeParam Options - The type of the options object
    */
-  class AVConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
+  class AVConfig<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
     Options,
     AVMaster
   > {
     /**
-     * @param object  - The {@link AVMaster} instance being configured.
+     * @param object  - The {@link AVMaster | `AVMaster`} instance being configured.
      * @param options - Application configuration options.
      */
     constructor(object?: AVMaster, options?: Partial<Options>);
@@ -30,9 +30,9 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplication.Options;
 
-    override getData(options: Partial<Options>): MaybePromise<GetDataReturnType<AVConfig.AVConfigData>>;
+    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<AVConfig.AVConfigData>>;
 
     override activateListeners(html: JQuery): void;
 
@@ -66,10 +66,11 @@ declare global {
   }
 
   namespace AVConfig {
-    type Any = AVConfig<any>;
+    interface Any extends AnyAVConfig {}
+    interface AnyConstructor extends Identity<typeof AnyAVConfig> {}
 
     interface AVConfigData {
-      user: User;
+      user: User.Implementation;
       modes: Record<AVSettings.AV_MODES, string>;
       voiceModes: Record<AVSettings.VOICE_MODES, string>;
       serverTypes: { FVTT: "WEBRTC.FVTTSignalingServer"; custom: "WEBRTC.CustomSignalingServer" };
@@ -91,3 +92,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyAVConfig extends AVConfig<FormApplication.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/av/cameras.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
@@ -6,7 +6,7 @@ declare global {
    * The Camera UI View that displays all the camera feeds as individual video elements.
    * @typeParam Options - the type of the options object
    */
-  class CameraViews<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class CameraViews<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(options: Options);
 
     /** @defaultValue `undefined` */
@@ -24,7 +24,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * A reference to the master AV orchestrator instance
@@ -66,7 +66,7 @@ declare global {
     /**
      * @param force   - Render and display the application even if it is not currently displayed.
      *                  (default: `false`)
-     * @param options - Additional options which update the current values of the @see Application#options object
+     * @param options - Additional options which update the current values of the @see {@link Application.options | `Application#options`} object
      * @internal
      */
     protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
@@ -161,12 +161,13 @@ declare global {
   }
 
   namespace CameraViews {
-    type Any = CameraViews<any>;
+    interface Any extends AnyCameraViews {}
+    interface AnyConstructor extends Identity<typeof AnyCameraViews> {}
 
     interface User {
-      user: Document.Stored<globalThis.User>;
+      user: Document.Stored<globalThis.User.Implementation>;
       settings: AVSettings.UserSettings;
-      local: Document.Stored<globalThis.User>["isSelf"];
+      local: Document.Stored<globalThis.User.Implementation>["isSelf"];
       charname: string;
       volume: number;
       cameraViewClass: string;
@@ -187,3 +188,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyCameraViews extends CameraViews<Application.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/dice/dice-config.d.mts

@@ -0,0 +1,59 @@
+import type { MaybePromise, GetDataReturnType, EmptyObject, Identity } from "#utils";
+
+declare global {
+  /**
+   * An application responsible for configuring how dice are rolled and evaluated.
+   */
+  class DiceConfig<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
+    Options,
+    FormApplication.NoObject
+  > {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *    id: "dice-config",
+     *    template: "templates/dice/config.html",
+     *    title: "DICE.CONFIG.Title",
+     *    width: 500
+     * });
+     * ```
+     */
+    static get defaultOptions(): FormApplication.Options;
+
+    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<DiceConfig.Data>>;
+
+    protected override _updateObject(
+      event: Event,
+      formData?: object,
+    ): Promise<Record<CONFIG.Dice.DTermDiceStrings, string>>;
+  }
+
+  namespace DiceConfig {
+    interface Any extends AnyDiceConfig {}
+    interface AnyConstructor extends Identity<typeof AnyDiceConfig> {}
+
+    /** @deprecated {@link DiceConfig.Data | `DiceConfig.Data`} */
+    type DiceConfigData = Data;
+
+    /** @deprecated {@link DiceConfig.DiceDat | `DiceConfig.DiceDat`} */
+    type DiceConfigDiceData = DiceData;
+
+    interface Data {
+      dice: DiceData[];
+      methods: Record<string, CONFIG.Dice.FulfillmentMethod>;
+      object: EmptyObject;
+    }
+
+    interface DiceData {
+      label: string;
+      icon: string;
+      denomination: CONFIG.Dice.DTermDiceStrings;
+      method: string;
+    }
+  }
+}
+
+declare abstract class AnyDiceConfig extends DiceConfig<FormApplication.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/dice/index.d.mts

@@ -0,0 +1 @@
+import "./dice-config.d.mts";