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

package/src/foundry/client/apps/forms/sheet-config.d.mts

@@ -1,4 +1,4 @@
-import type { ConstructorOf, GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 import type DocumentSheetV2 from "../../../client-esm/applications/api/document-sheet.d.mts";
 import type { Document } from "../../../common/abstract/module.d.mts";
 
@@ -9,7 +9,7 @@ declare global {
    * @typeParam ConcreteDocument - The type of the Document which is being managed
    */
   class DocumentSheetConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
+    Options extends FormApplication.Options = FormApplication.Options,
     ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
   > extends FormApplication<Options, ConcreteDocument> {
     /**
@@ -22,7 +22,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): FormApplicationOptions;
+    static get defaultOptions(): FormApplication.Options;
 
     /**
      * An array of pending sheet assignments which are submitted before other elements of the framework are ready.
@@ -75,13 +75,6 @@ declare global {
       config?: DocumentSheetConfig.RegisterSheetOptions,
     ): void;
 
-    /**
-     * Perform the sheet registration.
-     * @param config - Configuration for how the sheet should be un-registered
-     * @internal
-     */
-    static #registerSheet(config: Omit<DocumentSheetConfig.SheetRegistration, "action">): void;
-
     /**
      * Unregister a sheet class, removing it from the list of available Applications to use for a Document type
      * @param documentClass - The Document class for which to register a new Sheet option
@@ -92,17 +85,10 @@ declare global {
     static unregisterSheet(
       documentClass: Document.AnyConstructor,
       scope: string,
-      sheetClass: ConstructorOf<FormApplication<FormApplicationOptions, any>>,
+      sheetClass: typeof FormApplication<FormApplication.Options, any>,
       { types }?: { types?: string[] },
     ): void;
 
-    /**
-     * Perform the sheet de-registration
-     * @param config - Configuration for how the sheet should be un-registered
-     * @internal
-     */
-    static #unregisterSheet(config: Omit<DocumentSheetConfig.SheetUnregistration, "action">): void;
-
     /**
      * Update the current default Sheets using a new core world setting.
      */
@@ -113,10 +99,12 @@ declare global {
      * @internal
      */
     protected static _registerDefaultSheets(): void;
+
+    #documentSheetConfig: true;
   }
 
   namespace DocumentSheetConfig {
-    type Any = DocumentSheetConfig<any>;
+    interface Any extends DocumentSheetConfig<any> {}
 
     interface SheetRegistration {
       action: "register";
@@ -131,7 +119,7 @@ declare global {
       label: string;
 
       /** The sheet class definition being registered */
-      sheetClass: ConstructorOf<Application>;
+      sheetClass: Application.AnyConstructor;
 
       /** An array of types for which this sheet is added */
       types: string[];
@@ -195,7 +183,7 @@ declare global {
     interface DocumentSheetConfigData extends SheetClassesForSubType {
       isGM: boolean;
       object: foundry.abstract.Document.Any;
-      options: FormApplicationOptions;
+      options: FormApplication.Options;
       sheetClass: string;
       blankLabel: string;
     }

package/src/foundry/client/apps/forms/user-config.d.mts

@@ -1,5 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
-import type Document from "../../../common/abstract/document.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 
 declare global {
   /**
@@ -8,7 +7,7 @@ declare global {
    */
   class UserConfig<Options extends UserConfig.Options = UserConfig.Options> extends DocumentSheet<
     Options,
-    User.ConfiguredInstance
+    User.Implementation
   > {
     /**
      * @defaultValue
@@ -36,36 +35,38 @@ declare global {
   }
 
   namespace UserConfig {
-    type Any = UserConfig<any>;
+    interface Any extends UserConfig<any> {}
 
-    interface Options extends DocumentSheetOptions<User> {
+    interface Options extends DocumentSheet.Options<User.Implementation> {
       /**
        * @defaultValue `["sheet", "user-config"]`
        */
-      classes: DocumentSheetOptions["classes"];
+      classes: DocumentSheet.Options["classes"];
 
       /**
        * @defaultValue `"templates/user/user-config.html"`
        */
-      template: DocumentSheetOptions["template"];
+      template: DocumentSheet.Options["template"];
 
       /**
        * @defaultValue `400`
        */
-      width: DocumentSheetOptions["width"];
+      width: DocumentSheet.Options["width"];
 
       /**
        * @defaultValue `"auto"`
        */
-      height: DocumentSheetOptions["height"];
+      height: DocumentSheet.Options["height"];
     }
 
-    interface UserConfigData<Options extends DocumentSheetOptions<User> = DocumentSheetOptions<User>> {
+    interface UserConfigData<
+      Options extends DocumentSheet.Options<User.Implementation> = DocumentSheet.Options<User.Implementation>,
+    > {
       user: UserConfig<Options>["object"];
-      actors: Document.ToConfiguredClass<typeof Actor>[];
+      actors: Actor.ImplementationClass[];
       options: UserConfig<Options>["options"];
     }
   }
 }
 
-type FormData = Pick<User["_source"], "avatar" | "character" | "color">;
+interface FormData extends Pick<User.Implementation["_source"], "avatar" | "character" | "color"> {}

package/src/foundry/client/apps/hud/chatbubble.d.mts

@@ -1,4 +1,5 @@
 import type { Socket } from "socket.io-client";
+import type { Identity } from "#utils";
 
 declare global {
   /**
@@ -27,7 +28,7 @@ declare global {
      * @defaultValue `null`
      * @internal
      */
-    protected _panned: Token | null;
+    protected _panned: Token.Object | null;
 
     /**
      * A reference to the chat bubbles HTML container in which rendered bubbles should live
@@ -40,7 +41,11 @@ declare global {
      * @param message - The spoken message text
      * @param options - Options which affect the bubble appearance
      */
-    broadcast(token: TokenDocument, message: string, options: ChatBubbles.ChatBubbleOptions): Promise<JQuery | null>;
+    broadcast(
+      token: TokenDocument.Implementation,
+      message: string,
+      options: ChatBubbles.ChatBubbleOptions,
+    ): Promise<JQuery | null>;
 
     /**
      * Speak a message as a particular Token, displaying it as a chat bubble
@@ -49,7 +54,7 @@ declare global {
      * @param emote   - Whether to style the speech bubble as an emote
      * @returns A Promise which resolves once the chat bubble has been created
      */
-    say(token: Token, message: string, { emote }?: { emote?: boolean }): Promise<void>;
+    say(token: Token.Object, message: string, { emote }?: { emote?: boolean }): Promise<void>;
 
     /**
      * Activate Socket event listeners which apply to the ChatBubbles UI.
@@ -61,7 +66,7 @@ declare global {
      * Clear any existing chat bubble for a certain Token
      * @internal
      */
-    protected _clearBubble(token: Token): Promise<void>;
+    protected _clearBubble(token: Token.Object): Promise<void>;
 
     /**
      * Render the HTML template for the chat bubble
@@ -69,7 +74,7 @@ declare global {
      * @returns The rendered HTML
      * @internal
      */
-    protected _renderHTML(data: { token: Token; message: string; emote: boolean }): Promise<string>;
+    protected _renderHTML(data: { token: Token.Object; message: string; emote: boolean }): Promise<string>;
 
     /**
      * Before displaying the chat message, determine it's constrained and unconstrained dimensions
@@ -83,7 +88,7 @@ declare global {
      * Assign styling parameters to the chat bubble, toggling either a left or right display (randomly)
      * @internal
      */
-    protected _setPosition(token: Token, html: JQuery, dimensions: ChatBubbles.Dimensions): void;
+    protected _setPosition(token: Token.Object, html: JQuery, dimensions: ChatBubbles.Dimensions): void;
 
     /**
      * Determine the length of time for which to display a chat bubble.
@@ -98,6 +103,9 @@ declare global {
   }
 
   namespace ChatBubbles {
+    interface Any extends AnyChatBubbles {}
+    interface AnyConstructor extends Identity<typeof AnyChatBubbles> {}
+
     interface Dimensions {
       width: number;
       height: number;
@@ -111,3 +119,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyChatBubbles extends ChatBubbles {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/hud/container.d.mts

@@ -1,11 +1,11 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
   /**
    * Render the HUD container
    * @typeParam Options - the type of the options object
    */
-  class HeadsUpDisplay<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class HeadsUpDisplay<Options extends Application.Options = Application.Options> extends Application<Options> {
     /**
      * Token HUD
      */
@@ -36,7 +36,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override getData(options?: Partial<Options>): MaybePromise<object>;
 
@@ -49,6 +49,6 @@ declare global {
   }
 
   namespace HeadsUpDisplay {
-    type Any = HeadsUpDisplay<any>;
+    interface Any extends HeadsUpDisplay<any> {}
   }
 }

package/src/foundry/client/apps/hud/controls.d.mts

@@ -1,68 +1,11 @@
-export {};
+import type { Identity } from "#utils";
 
 declare global {
-  interface SceneControlToolBase {
-    name: string;
-    title: string;
-    icon: string;
-    visible?: boolean;
-    active?: boolean;
-    toolclip?: ToolclipConfiguration;
-  }
-
-  interface SceneControlToolToggle extends SceneControlToolBase {
-    toggle: true;
-    onClick?: (toggled: boolean) => void;
-  }
-
-  interface SceneControlToolNoToggle extends SceneControlToolBase {
-    toggle?: false;
-    button?: boolean;
-    onClick?: () => void;
-  }
-
-  type SceneControlTool = SceneControlToolToggle | SceneControlToolNoToggle;
-
-  interface SceneControl {
-    name: string;
-    title: string;
-    layer: string;
-    icon: string;
-    visible: boolean;
-    tools: SceneControlTool[];
-    activeTool: string;
-  }
-
-  interface ToolclipConfiguration {
-    /** The filename of the toolclip video. */
-    src: string;
-
-    /** The heading string. */
-    heading: string;
-
-    /** The items in the toolclip body. */
-    items: ToolclipConfigurationItem[];
-  }
-
-  interface ToolclipConfigurationItem {
-    /** A plain paragraph of content for this item. */
-    paragraph?: string;
-
-    /** A heading for the item. */
-    heading?: string;
-
-    /** Content for the item. */
-    content?: string;
-
-    /** If the item is a single key reference, use this instead of content. */
-    reference?: string;
-  }
-
   /**
    * Scene controls navigation menu
    * @typeParam Options - the type of the options object
    */
-  class SceneControls<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class SceneControls<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -74,7 +17,7 @@ declare global {
     /**
      * The Array of Scene Control buttons which are currently rendered
      */
-    controls: SceneControl[];
+    controls: SceneControls.Control[];
 
     /**
      * @defaultValue
@@ -87,12 +30,12 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * Return the active control set
      */
-    get control(): SceneControl | null;
+    get control(): SceneControls.Control | null;
 
     /**
      * Return the name of the active tool within the active control set
@@ -102,7 +45,7 @@ declare global {
     /**
      * Return the actively controlled tool
      */
-    get tool(): SceneControlTool | null;
+    get tool(): SceneControls.Tool | null;
 
     /**
      * A convenience reference for whether the currently active tool is a Ruler
@@ -114,10 +57,10 @@ declare global {
      * @param options - Options which modify how the controls UI is initialized
      *                  (defaultValue: `{}`)
      */
-    initialize(options?: InitializeOptions): void;
+    initialize(options?: SceneControls.InitializeOptions): void;
 
     override getData(options?: Partial<Options>): {
-      controls: SceneControl[];
+      controls: SceneControls.Control[];
       active: boolean;
       cssClass: "" | "disabled";
     };
@@ -140,27 +83,129 @@ declare global {
      * Get the set of Control sets and tools that are rendered as the Scene Controls.
      * These controls may be extended using the "getSceneControlButtons" Hook.
      */
-    protected _getControlButtons(): SceneControl[];
+    protected _getControlButtons(): SceneControls.Control[];
   }
 
   namespace SceneControls {
-    type Any = SceneControls<any>;
+    interface Any extends AnySceneControls {}
+    interface AnyConstructor extends Identity<typeof AnySceneControls> {}
+
+    interface ToolBase {
+      name: string;
+      title: string;
+      icon: string;
+      visible?: boolean;
+      active?: boolean;
+      toolclip?: ToolclipConfiguration;
+    }
+
+    interface ToolToggle extends ToolBase {
+      toggle: true;
+      onClick?: (toggled: boolean) => void;
+    }
+
+    interface ToolNoToggle extends ToolBase {
+      toggle?: false;
+      button?: boolean;
+      onClick?: () => void;
+    }
+
+    type Tool = ToolToggle | ToolNoToggle;
+
+    interface Control {
+      name: string;
+      title: string;
+      layer: string;
+      icon: string;
+      visible: boolean;
+      tools: SceneControls.Tool[];
+      activeTool: string;
+    }
+
+    interface ToolclipConfiguration {
+      /** The filename of the toolclip video. */
+      src: string;
+
+      /** The heading string. */
+      heading: string;
+
+      /** The items in the toolclip body. */
+      items: ToolclipConfigurationItem[];
+    }
+
+    interface ToolclipConfigurationItem {
+      /** A plain paragraph of content for this item. */
+      paragraph?: string;
+
+      /** A heading for the item. */
+      heading?: string;
+
+      /** Content for the item. */
+      content?: string;
+
+      /** If the item is a single key reference, use this instead of content. */
+      reference?: string;
+    }
+
+    interface InitializeOptions {
+      /**
+       * An optional control set to set as active
+       */
+      control?: string;
+
+      /**
+       * An optional layer name to target as the active control
+       */
+      layer?: string;
+
+      /**
+       * A specific named tool to set as active for the palette
+       */
+      tool?: string;
+    }
   }
 
-  interface InitializeOptions {
-    /**
-     * An optional control set to set as active
-     */
-    control?: string;
+  /**
+   * @deprecated {@link SceneControls.InitializeOptions | `SceneControls.InitializeOptions`}
+   */
+  type InitializeOptions = SceneControls.InitializeOptions;
 
-    /**
-     * An optional layer name to target as the active control
-     */
-    layer?: string;
+  /**
+   * @deprecated {@link SceneControls.ToolBase | `SceneControls.ToolBase`}
+   */
+  type SceneControlToolBase = SceneControls.ToolBase;
 
-    /**
-     * A specific named tool to set as active for the palette
-     */
-    tool?: string;
-  }
+  /**
+   * @deprecated {@link SceneControls.ToolToggle | `SceneControls.ToolToggle`}
+   */
+  type SceneControlToolToggle = SceneControls.ToolToggle;
+
+  /**
+   * @deprecated {@link SceneControls.ToolNoToggle | `SceneControls.ToolNoToggle`}
+   */
+  type SceneControlToolNoToggle = SceneControls.ToolNoToggle;
+
+  /**
+   * @deprecated {@link SceneControls.Tool | `SceneControls.Tool`}
+   */
+  type SceneControlTool = SceneControls.Tool;
+
+  /**
+   * @deprecated {@link SceneControls.Control | `SceneControls.Control`}
+   */
+  type SceneControl = SceneControls.Control;
+
+  /**
+   * @deprecated {@link SceneControls.ToolclipConfiguration | `SceneControls.ToolclipConfiguration`}
+   */
+  type ToolclipConfiguration = SceneControls.ToolclipConfiguration;
+
+  /**
+   * @deprecated {@link SceneControls.ToolclipConfigurationItem | `SceneControls.ToolclipConfigurationItem`}
+   */
+  type ToolclipConfigurationItem = SceneControls.ToolclipConfigurationItem;
+}
+
+declare abstract class AnySceneControls extends SceneControls<Application.Options> {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/hud/hotbar.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, Identity } from "#utils";
 
 declare global {
   /**
@@ -11,12 +11,12 @@ declare global {
    * The number keys 1 through 0 activate numbered hotbar slots.
    * Pressing the delete key while hovering over a Macro will remove it from the bar.
    *
-   * @see {@link Macros}
-   * @see {@link Macro}
+   * @see {@link Macros | `Macros`}
+   * @see {@link Macro | `Macro`}
    *
    * @typeParam Options - the type of the options object
    */
-  class Hotbar<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class Hotbar<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -29,7 +29,7 @@ declare global {
      * The currently displayed set of macros
      * @defaultValue `[]`
      */
-    macros: Macro.ConfiguredInstance[];
+    macros: Macro.Implementation[];
 
     /**
      * Track collapsed state
@@ -54,7 +54,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<Hotbar.HotbarData>>;
 
@@ -67,7 +67,7 @@ declare global {
      * Get the Array of Macro (or null) values that should be displayed on a numbered page of the bar
      * @param page -
      */
-    protected _getMacrosByPage(page: number): Macro.ConfiguredInstance[];
+    protected _getMacrosByPage(page: number): Macro.Implementation[];
 
     /**
      * Collapse the Hotbar, minimizing its display.
@@ -103,7 +103,7 @@ declare global {
      * @returns The Macro entry context options
      * @internal
      */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
+    protected _getEntryContextOptions(): ContextMenu.Entry[];
 
     /**
      * Handle left-click events to
@@ -129,14 +129,14 @@ declare global {
      * Create a Macro which rolls a RollTable when executed
      * @param table - The RollTable document
      */
-    protected _createRollTableRollMacro(table: RollTable): Promise<Macro.ConfiguredInstance>;
+    protected _createRollTableRollMacro(table: RollTable.Implementation): Promise<Macro.Implementation>;
 
     /**
      * Create a Macro document which can be used to toggle display of a Journal Entry.
      * @param doc - A Document which should be toggled
      * @returns A created Macro document to add to the bar
      */
-    protected _createDocumentSheetToggle(doc: ClientDocument): Promise<Macro.ConfiguredInstance>;
+    protected _createDocumentSheetToggle(doc: ClientDocument): Promise<Macro.Implementation>;
 
     /**
      * Handle click events to toggle display of the macro bar
@@ -153,11 +153,12 @@ declare global {
      * @param uuid - The Document UUID to display
      * @remarks Returns a ui notification number if doc could not be found
      */
-    static toggleDocumentSheet(uuid: string): Promise<void> | Application | number;
+    static toggleDocumentSheet(uuid: string): Promise<void> | Application.Any | number;
   }
 
   namespace Hotbar {
-    type Any = Hotbar<any>;
+    interface Any extends AnyHotbar {}
+    interface AnyConstructor extends Identity<typeof AnyHotbar> {}
 
     interface HotbarData {
       page: Hotbar["page"];
@@ -167,3 +168,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyHotbar extends Hotbar {
+  constructor(...args: never);
+}

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

@@ -1,4 +1,4 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
   /**
@@ -8,7 +8,7 @@ declare global {
    */
   abstract class BasePlaceableHUD<
     Object extends PlaceableObject.Any = PlaceableObject,
-    Options extends ApplicationOptions = ApplicationOptions,
+    Options extends Application.Options = Application.Options,
   > extends Application<Options> {
     /**
      * Reference a PlaceableObject this HUD is currently bound to
@@ -25,13 +25,13 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * Convenience access for the canvas layer which this HUD modifies
      * @remarks Returns undefined only if there's no object
      */
-    get layer(): Object["layer"] | undefined;
+    get layer(): Object["layer"];
 
     /**
      * Bind the HUD to a new PlaceableObject and display it
@@ -82,6 +82,6 @@ declare global {
   }
 
   namespace BasePlaceableHUD {
-    type Any = BasePlaceableHUD<any, any>;
+    interface Any extends BasePlaceableHUD<any, any> {}
   }
 }