@league-of-foundry-developers/foundry-vtt-types 9.238.0 → 9.249.0

package/src/foundry/foundry.js/applications/formApplications/permissionConfig.d.ts

@@ -1,7 +1,7 @@
 /**
  * An application for configuring the permissions which are available to each User role.
  */
-declare class PermissionConfig extends FormApplication<FormApplication.Options, PermissionConfig.Data> {
+declare class PermissionConfig extends FormApplication<FormApplicationOptions, PermissionConfig.Data> {
   /**
    * @override
    * @defaultValue
@@ -23,7 +23,7 @@ declare class PermissionConfig extends FormApplication<FormApplication.Options,
    * @param options - (unused)
    * @override
    */
-  getData(options?: Partial<FormApplication.Options>): PermissionConfig.Data;
+  getData(options?: Partial<FormApplicationOptions>): PermissionConfig.Data;
 
   /**
    * Prepare the permissions object used to render the configuration template

package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts

@@ -8,7 +8,7 @@ declare global {
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class SettingsConfig<
-    Options extends FormApplication.Options = FormApplication.Options,
+    Options extends FormApplicationOptions = FormApplicationOptions,
     Data extends object = SettingsConfig.Data
   > extends FormApplication<Options, Data> {
     /**

package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts

@@ -8,7 +8,7 @@ declare global {
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class TokenConfig<
-    Options extends FormApplication.Options = FormApplication.Options,
+    Options extends FormApplicationOptions = FormApplicationOptions,
     Data extends object = TokenConfig.Data<Options>
   > extends FormApplication<
     Options,
@@ -37,7 +37,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): FormApplication.Options;
+    static get defaultOptions(): FormApplicationOptions;
 
     /** @override */
     get id(): string;
@@ -103,7 +103,7 @@ declare global {
       value: string[][];
     }
 
-    interface Data<Options extends FormApplication.Options = FormApplication.Options> {
+    interface Data<Options extends FormApplicationOptions = FormApplicationOptions> {
       cssClasses: string;
       isPrototype: boolean;
       hasAlternates: boolean;

package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts

@@ -7,7 +7,7 @@ declare global {
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class WallConfig<
-    Options extends FormApplication.Options = FormApplication.Options,
+    Options extends FormApplicationOptions = FormApplicationOptions,
     Data extends object = WallConfig.Data<Options>
   > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Wall'>>> {
     /**
@@ -20,7 +20,7 @@ declare global {
      * options.width = 400;
      * ```
      */
-    static get defaultOptions(): FormApplication.Options;
+    static get defaultOptions(): FormApplicationOptions;
 
     /** @override */
     get title(): string;
@@ -39,7 +39,7 @@ declare global {
   }
 
   namespace WallConfig {
-    interface Data<Options extends FormApplication.Options = FormApplication.Options> {
+    interface Data<Options extends FormApplicationOptions = FormApplicationOptions> {
       object: foundry.data.WallData['_source'];
       options: Options;
       moveTypes: {

package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts

@@ -57,7 +57,7 @@ declare namespace WorldConfig {
     systems?: Game.SystemData<foundry.packages.SystemData>[];
   }
 
-  interface Options extends FormApplication.Options {
+  interface Options extends FormApplicationOptions {
     /**
      * @defaultValue `false`
      */

package/src/foundry/foundry.js/applications/frameViewer.d.ts

@@ -21,7 +21,7 @@ declare class FrameViewer extends Application {
   static get defaultOptions(): typeof Application['defaultOptions'];
 
   /** @override */
-  getData(options?: Partial<Application.Options>): Promise<{ src: string }>;
+  getData(options?: Partial<ApplicationOptions>): Promise<{ src: string }>;
 
   /** @override */
   close(options?: Application.CloseOptions): ReturnType<Application['close']>;

package/src/foundry/foundry.js/applications/headsUpDisplay.d.ts

@@ -2,7 +2,7 @@
  * Render the HUD container
  * @typeParam Options - the type of the options object
  */
-declare class HeadsUpDisplay<Options extends Application.Options = Application.Options> extends Application<Options> {
+declare class HeadsUpDisplay<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
   /**
    * Token HUD
    */
@@ -34,7 +34,7 @@ declare class HeadsUpDisplay<Options extends Application.Options = Application.O
    * })
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /** @override */
   getData(options?: Partial<Options>): {} | { width: number; height: number };

package/src/foundry/foundry.js/applications/hotbar.d.ts

@@ -16,7 +16,7 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class Hotbar<Options extends Application.Options = Application.Options> extends Application<Options> {
+  class Hotbar<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -55,7 +55,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     getData(options?: Partial<Options>): Hotbar.Data | Promise<Hotbar.Data>;

package/src/foundry/foundry.js/applications/mainMenu.d.ts

@@ -14,7 +14,7 @@ declare class MainMenu extends Application {
    * }
    * ```
    * */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * The structure of menu items
@@ -54,7 +54,7 @@ declare class MainMenu extends Application {
    * @override
    * @param options - (unused)
    */
-  getData(options?: Partial<Application.Options>): { items: MainMenu.MenuStructure };
+  getData(options?: Partial<ApplicationOptions>): { items: MainMenu.MenuStructure };
 
   /** @override */
   activateListeners(html: JQuery): void;

package/src/foundry/foundry.js/applications/notifications.d.ts

@@ -13,7 +13,7 @@
  *
  * @typeParam Options - the type of the options object
  */
-declare class Notifications<Options extends Application.Options = Application.Options> extends Application<Options> {
+declare class Notifications<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
   constructor(options?: Partial<Options>);
 
   /**
@@ -39,15 +39,18 @@ declare class Notifications<Options extends Application.Options = Application.Op
    * });
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * Initialize the Notifications system by displaying any system-generated messages which were passed from the server.
    */
   initialize(): void;
 
-  /** @override */
-  protected _renderInner(data: object): JQuery;
+  /**
+   * @override
+   * @remarks This return a `JQuery`, which is incompatible with the expected `Promise<JQuery>` (see https://gitlab.com/foundrynet/foundryvtt/-/issues/6554).
+   */
+  protected _renderInner(data: object): any;
 
   /** @override */
   protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;

package/src/foundry/foundry.js/applications/pause.d.ts

@@ -5,10 +5,10 @@
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class Pause<
-  Options extends Application.Options = Application.Options,
+  Options extends ApplicationOptions = ApplicationOptions,
   Data extends object = Pause.Data
 > extends Application<Options> {
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /** @override */
   getData(options?: Partial<Options>): Data | Promise<Data>;

package/src/foundry/foundry.js/applications/playerList.d.ts

@@ -6,7 +6,7 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class PlayerList<Options extends Application.Options = Application.Options> extends Application<Options> {
+  class PlayerList<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -25,7 +25,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     render(force?: boolean, options?: Application.RenderOptions<Options>): this;

package/src/foundry/foundry.js/applications/sceneControls.d.ts

@@ -33,7 +33,7 @@ interface SceneControl {
  * Scene controls navigation menu
  * @typeParam Options - the type of the options object
  */
-declare class SceneControls<Options extends Application.Options = Application.Options> extends Application<Options> {
+declare class SceneControls<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
   constructor(options?: Partial<Options>);
 
   /**
@@ -118,7 +118,7 @@ declare class SceneControls<Options extends Application.Options = Application.Op
 }
 
 declare namespace SceneControls {
-  export interface Options extends Application.Options {
+  export interface Options extends ApplicationOptions {
     /**
      * @defaultValue `100`
      */

package/src/foundry/foundry.js/applications/sceneNavigation.d.ts

@@ -8,7 +8,7 @@ declare global {
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class SceneNavigation<
-    Options extends Application.Options = Application.Options,
+    Options extends ApplicationOptions = ApplicationOptions,
     Data extends object = SceneNavigation.Data
   > extends Application<Options> {
     constructor(options?: Partial<Options>);
@@ -31,7 +31,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /**
      * Return an Array of Scenes which are displayed in the Navigation bar
@@ -45,7 +45,7 @@ declare global {
     protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
     /** @override */
-    getData(options?: Partial<Application.Options>): Data | Promise<Data>;
+    getData(options?: Partial<ApplicationOptions>): Data | Promise<Data>;
 
     /**
      * Expand the SceneNavigation menu, sliding it down if it is currently collapsed

package/src/foundry/foundry.js/applications/sidebar.d.ts

@@ -2,7 +2,7 @@
  * Render the Sidebar container, and after rendering insert Sidebar tabs.
  * @typeParam Options - the type of the options object
  */
-declare class Sidebar<Options extends Application.Options = Application.Options> extends Application<Options> {
+declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
   /**
    * Singleton application instances for each sidebar tab
    * @defaultValue `{}`
@@ -29,7 +29,7 @@ declare class Sidebar<Options extends Application.Options = Application.Options>
    * }
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * Return the name of the active Sidebar tab

package/src/foundry/foundry.js/applications/sidebarTab.d.ts

@@ -3,7 +3,7 @@
  * @typeParam Options - The type of the options object
  */
 declare abstract class SidebarTab<
-  Options extends Application.Options = Application.Options
+  Options extends ApplicationOptions = ApplicationOptions
 > extends Application<Options> {
   constructor(...args: ConstructorParameters<typeof Application>);
   /**
@@ -36,16 +36,13 @@ declare abstract class SidebarTab<
    * });
    * ```
    */
-  static get defaultOptions(): Application.Options;
-
-  /**  @override */
-  protected _renderInner(data: object): Promise<JQuery>;
+  static get defaultOptions(): ApplicationOptions;
 
   /** @override */
   protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-  /** @override */
-  render(force?: boolean, options?: Application.RenderOptions<Options>): unknown;
+  /**  @override */
+  protected _renderInner(data: object): Promise<JQuery>;
 
   /**
    * Activate this SidebarTab, switching focus to it

package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts

@@ -276,7 +276,7 @@ declare global {
      * @param mode - The new roll mode setting
      * @internal
      */
-    protected static _setRollMode(mode: foundry.CONST.DICE_ROLL_MODES): void;
+    protected static _setRollMode(mode: keyof CONFIG.Dice.RollModes): void;
   }
 
   namespace ChatLog {
@@ -297,12 +297,12 @@ declare global {
 
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      rollMode: foundry.CONST.DICE_ROLL_MODES;
+      rollMode: keyof CONFIG.Dice.RollModes;
       rollModes: typeof CONFIG['Dice']['rollModes'];
       isStream: boolean;
     }
 
-    interface Options extends Application.Options {
+    interface Options extends ApplicationOptions {
       /**
        * @defaultValue `'chat'`
        */

package/src/foundry/foundry.js/applications/sidebarTabs/combatTracker.d.ts

@@ -4,7 +4,7 @@ declare global {
   /**
    * The sidebar directory which organizes and displays world-level Combat documents.
    */
-  class CombatTracker<Options extends Application.Options = CombatTracker.Options> extends SidebarTab<Options> {
+  class CombatTracker<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -20,13 +20,23 @@ declare global {
      */
     viewed: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>> | null;
 
-    /** @override */
-    static get defaultOptions(): CombatTracker.Options;
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "combat",
+     *   template: "templates/sidebar/combat-tracker.html",
+     *   title: "COMBAT.SidebarTitle",
+     *   scrollY: [".directory-list"]
+     * })
+     * ```
+     */
+    static get defaultOptions(): ApplicationOptions;
 
     /**
      * Return an array of Combat encounters which occur within the current Scene.
      */
-    get combats(): ReturnType<CombatEncounters['filter']>;
+    get combats(): StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>>[];
 
     /** @override */
     createPopout(): this;
@@ -115,6 +125,12 @@ declare global {
      */
     protected _onCombatantHoverOut(event: JQuery.MouseLeaveEvent): void;
 
+    /**
+     * Highlight a hovered combatant in the tracker.
+     * @param combatant - The Combatant
+     * @param hover     - Whether they are being hovered in or out.
+     */
+    hoverCombatant(combatant: InstanceType<ConfiguredDocumentClass<typeof Combatant>>, hover: boolean): void;
     /**
      * Attach context menu options to elements in the tracker
      * @param html - The HTML element to which context options are attached
@@ -123,8 +139,8 @@ declare global {
     protected _contextMenu(html: JQuery): void;
 
     /**
-     * Get the sidebar directory entry context options
-     * @returns The sidebar entry context options
+     * Get the Combatant entry context options
+     * @returns The Combatant entry context options
      * @internal
      */
     protected _getEntryContextOptions(): ContextMenuEntry[];
@@ -144,6 +160,8 @@ declare global {
           combatCount: number;
           started: boolean;
           settings: ClientSettings.Values[`core.${typeof Combat.CONFIG_SETTING}`];
+          linked: boolean;
+          labels: { scoped: string };
           currentIndex: -1;
           hasCombat: false;
           combat: null;
@@ -158,6 +176,8 @@ declare global {
           combatCount: number;
           started: boolean;
           settings: ClientSettings.Values[`core.${typeof Combat.CONFIG_SETTING}`];
+          linked: boolean;
+          labels: { scoped: string };
           currentIndex: number;
           hasCombat: true;
           combat: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>>;
@@ -184,27 +204,5 @@ declare global {
       css: string;
       effects: Set<string>;
     };
-
-    interface Options extends Application.Options {
-      /**
-       * @defaultValue `'combat'`
-       */
-      id: string;
-
-      /**
-       * @defaultValue `'templates/sidebar/combat-tracker.html'`
-       */
-      template: string;
-
-      /**
-       * @defaultValue `'Combat Tracker'`
-       */
-      title: string;
-
-      /**
-       * @defaultValue `['.directory-list']`
-       */
-      scrollY: string[];
-    }
   }
 }

package/src/foundry/foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts

@@ -5,7 +5,7 @@ declare global {
    * A compendium of knowledge arcane and mystical!
    * @typeParam Options - The type of the options object
    */
-  class CompendiumDirectory<Options extends Application.Options = Application.Options> extends SidebarTab<Options> {
+  class CompendiumDirectory<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
     /**
      * @override
      * @defaultValue
@@ -17,7 +17,7 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /**
      * @param options - (unused)

package/src/foundry/foundry.js/applications/sidebarTabs/settings.d.ts

@@ -6,7 +6,7 @@ declare global {
    * The Settings sidebar is the furthest-to-right using a triple-cogs icon.
    * @typeParam Options - The type of the options object
    */
-  class Settings<Options extends Application.Options = Application.Options> extends SidebarTab<Options> {
+  class Settings<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
     /**
      * @override
      * @defaultValue
@@ -18,7 +18,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /**
      * @param options - (unused)

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts

@@ -224,7 +224,7 @@ declare global {
       sidebarIcon: string;
     }
 
-    interface Options extends Application.Options {
+    interface Options extends ApplicationOptions {
       renderUpdateKeys: string[];
       contextMenuSelector: string;
     }

package/src/foundry/foundry.js/audioContainer.d.ts

@@ -2,7 +2,6 @@
  * An AudioSourceNode container which handles the strategy of node type to use for playback.
  * Used by the Sound interface which controls playback.
  * This class is for internal use only and should not be used by external callers.
- * @internal
  */
 declare class AudioContainer {
   constructor(src: string);
@@ -31,16 +30,11 @@ declare class AudioContainer {
   isBuffer: boolean;
 
   /**
-   * Has the source for this audio container been loaded to a point that playback can begin?
-   * @defaultValue `false`
-   */
-  loaded: boolean;
-
-  /**
-   * Did the audio source fail to load (a 404 or some other reason).
-   * @defaultValue `false`
+   * Whether we have attempted to load the audio node or not, and whether it failed.
+   * @see {@link LOAD_STATES}
+   * @defaultValue `AudioContainer.LOAD_STATES.NONE`
    */
-  failed: boolean;
+  loadState: AudioContainer.LOAD_STATES;
 
   /**
    * Is the audio source currently playing?
@@ -65,6 +59,26 @@ declare class AudioContainer {
    */
   static MAX_BUFFER_DURATION: number;
 
+  /**
+   * The sequence of container loading states.
+   */
+  static LOAD_STATES: {
+    FAILED: -1;
+    NONE: 0;
+    LOADING: 1;
+    LOADED: 2;
+  };
+
+  /**
+   * Has the audio file been loaded either fully or for streaming.
+   */
+  get loaded(): boolean;
+
+  /**
+   * Did the audio file fail to load.
+   */
+  get failed(): boolean;
+
   /**
    * A reference to the AudioBuffer if the sourceNode is a AudioBufferSourceNode.
    */
@@ -155,3 +169,7 @@ declare class AudioContainer {
    */
   protected _unloadMediaNode(): void;
 }
+
+declare namespace AudioContainer {
+  type LOAD_STATES = ValueOf<typeof AudioContainer['LOAD_STATES']>;
+}

package/src/foundry/foundry.js/canvas.d.ts

@@ -72,6 +72,11 @@ declare global {
      */
     initialized: boolean;
 
+    /**
+     * A promise that resolves when the canvas is first initialized and ready.
+     */
+    initializing: Promise<void> | null;
+
     /**
      * Track the timestamp of the last stage zoom operation
      * @defaultValue `0`

package/src/foundry/foundry.js/canvasAnimation.d.ts

@@ -1,3 +1,17 @@
+interface CanvasAnimationData {
+  /** The animation function being executed each frame */
+  fn: (dt: number) => void;
+
+  /** The object context within which animation occurs */
+  context: PIXI.DisplayObject;
+
+  /** A Promise which resolves once the animation is complete */
+  promise: Promise<boolean>;
+
+  /** The resolution function, allowing animation to be ended early */
+  resolve: (value: boolean) => void;
+}
+
 /**
  * A helper class providing utility methods for PIXI Canvas animation
  */
@@ -8,9 +22,7 @@ declare class CanvasAnimation {
    * Track an object of active animations by name, context, and function
    * This allows a currently playing animation to be referenced and terminated
    */
-  static animations: Partial<
-    Record<string, { fn: (dt: number) => void; context: PIXI.Container; resolve: (value: boolean) => void }>
-  >;
+  static animations: Record<string, CanvasAnimationData>;
 
   /**
    * Apply a linear animation from the current value of some attribute to a new value
@@ -42,6 +54,13 @@ declare class CanvasAnimation {
     options?: InexactPartial<LinearAnimationOptions>
   ): Promise<boolean>;
 
+  /**
+   * Retrieve an animation currently in progress by its name
+   * @param name - The animation name to retrieve
+   * @returns The animation data, or undefined
+   */
+  static getAnimation(name: string): CanvasAnimationData | undefined;
+
   /**
    * If an animation using a certain name already exists, terminate it
    * @param name - The animation name to terminate
@@ -75,7 +94,7 @@ declare class CanvasAnimation {
    */
   protected static _animateFrame(
     deltaTime: number,
-    resolve: (value: boolean) => void,
+    resolve: CanvasAnimationData['resolve'],
     reject: (reason?: any) => void,
     attributes: CanvasAnimation.Attribute[],
     duration: number,
@@ -85,8 +104,12 @@ declare class CanvasAnimation {
 
 declare namespace CanvasAnimation {
   interface Attribute {
-    parent: any;
     attribute: string;
+    d?: number;
+    delta?: number;
+    done?: number;
+    parent: any;
+    remaining?: number;
     to: number;
   }
 }
@@ -95,7 +118,7 @@ interface LinearAnimationOptions {
   /**
    * An animation context to use which defines scope
    */
-  context: PIXI.Container;
+  context: PIXI.DisplayObject;
 
   /**
    * Provide a unique animation name which may be referenced later
@@ -117,7 +140,7 @@ interface LinearAnimationOptions {
 type TickFunction = (dt: number, attributes: CanvasAnimation.Attribute[]) => void;
 type TransitionFunction = (
   dt: number,
-  resolve: (value: boolean) => void,
+  resolve: CanvasAnimationData['resolve'],
   reject: (reason?: any) => void,
   attributes: CanvasAnimation.Attribute[],
   duration: number,

package/src/foundry/foundry.js/clientDocumentMixin.d.ts

@@ -275,7 +275,8 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    *                  (default: `{}`)
    * @param context - Additional context options or dialog positioning options
    *                  (default: `{}`)
-   * @returns A Promise which resolves to the created Document
+   * @returns A Promise which resolves to the created Document, or null if the dialog was
+   *          closed.
    */
   static createDialog<T extends DocumentConstructor>(
     this: T,