@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/{foundry.js/applications → client/apps/hud}/hotbar.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -44,7 +44,6 @@ declare global {
     protected _hover: number | null;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * mergeObject(super.defaultOptions, {
@@ -55,10 +54,9 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    getData(options?: Partial<Options>): Hotbar.Data | Promise<Hotbar.Data>;
+    override getData(options?: Partial<Options>): Hotbar.Data | Promise<Hotbar.Data>;
 
     /**
      * Get the Array of Macro (or null) values that should be displayed on a numbered page of the bar
@@ -91,14 +89,16 @@ declare global {
      */
     cyclePage(direction?: number): void;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
+
+    protected override _contextMenu(html: JQuery): void;
 
     /**
-     * Create a Context Menu attached to each Macro button
-     * @param html - The HTML being rendered for the hotbar
+     * Get the Macro entry context options
+     * @returns The Macro entry context options
+     * @internal
      */
-    protected _contextMenu(html: JQuery): void;
+    protected _getEntryContextOptions(): ContextMenuEntry[];
 
     /**
      * Handle left-click events to
@@ -118,26 +118,13 @@ declare global {
      */
     protected _onClickPageControl(event: JQuery.ClickEvent): void;
 
-    /**
-     * @override
-     * @param selector - (unused)
-     */
-    protected _canDragStart(selector: string): boolean;
+    protected override _canDragStart(selector: string): boolean;
 
-    /** @override */
-    protected _onDragStart(event: DragEvent): false | void;
+    protected override _onDragStart(event: DragEvent): false | void;
 
-    /**
-     * @override
-     * @param selector - (unused)
-     */
-    protected _canDragDrop(selector: string): boolean;
+    protected override _canDragDrop(selector: string): boolean;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _onDrop(event: DragEvent): void;
+    protected override _onDrop(event: DragEvent): void;
 
     /**
      * Handle click events to toggle display of the macro bar

package/src/foundry/{foundry.js/applications/basePlaceableHUD.d.ts → client/apps/hud/hud.d.ts}

@@ -14,7 +14,6 @@ declare abstract class BasePlaceableHUD<
   object: Object | undefined;
 
   /**
-   * @override
    * @defaultValue
    * ```
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -23,7 +22,7 @@ declare abstract class BasePlaceableHUD<
    * })
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
   /**
    * Convenience access for the canvas layer which this HUD modifies
@@ -41,11 +40,9 @@ declare abstract class BasePlaceableHUD<
    */
   clear(): void;
 
-  /** @override */
-  _render(...args: Parameters<Application<Options>['_render']>): Promise<void>;
+  override _render(...args: Parameters<Application<Options>['_render']>): Promise<void>;
 
-  /** @override */
-  getData(options?: Partial<Options>): ReturnType<Object['data']['toJSON']> & {
+  override getData(options?: Partial<Options>): ReturnType<Object['data']['toJSON']> & {
     id: string;
     classes: string;
     appId: number;
@@ -53,11 +50,9 @@ declare abstract class BasePlaceableHUD<
     icons: typeof CONFIG['controlIcons'];
   };
 
-  /** @override */
-  setPosition({ left, top, width, height, scale }?: Partial<Application.Position>): void;
+  override setPosition({ left, top, width, height, scale }?: Partial<Application.Position>): void;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle mouse clicks to control a HUD control button

package/src/foundry/client/apps/hud/index.d.ts

@@ -0,0 +1,9 @@
+import './chatbubble';
+import './container';
+import './controls';
+import './hotbar';
+import './hud';
+import './menu';
+import './navigation';
+import './pause';
+import './players';

package/src/foundry/{foundry.js/applications/mainMenu.d.ts → client/apps/hud/menu.d.ts}

@@ -3,7 +3,6 @@
  */
 declare class MainMenu extends Application {
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * {
@@ -14,7 +13,7 @@ declare class MainMenu extends Application {
    * }
    * ```
    * */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
   /**
    * The structure of menu items
@@ -50,14 +49,9 @@ declare class MainMenu extends Application {
    */
   get items(): MainMenu.MenuStructure;
 
-  /**
-   * @override
-   * @param options - (unused)
-   */
-  getData(options?: Partial<ApplicationOptions>): { items: MainMenu.MenuStructure };
+  override getData(options?: Partial<ApplicationOptions>): { items: MainMenu.MenuStructure };
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Toggle display of the menu (or render it in the first place)

package/src/foundry/{foundry.js/applications/sceneNavigation.d.ts → client/apps/hud/navigation.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -20,7 +20,6 @@ declare global {
     protected _collapsed: boolean;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -31,21 +30,18 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
     /**
      * Return an Array of Scenes which are displayed in the Navigation bar
      */
     get scenes(): InstanceType<ConfiguredDocumentClassForName<'Scene'>>[];
 
-    /** @override */
-    render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
+    override render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
 
-    /** @override */
-    protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-    /** @override */
-    getData(options?: Partial<ApplicationOptions>): Data | Promise<Data>;
+    override getData(options?: Partial<ApplicationOptions>): Data | Promise<Data>;
 
     /**
      * Expand the SceneNavigation menu, sliding it down if it is currently collapsed
@@ -57,8 +53,7 @@ declare global {
      */
     collapse(): Promise<boolean>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Get the set of ContextMenu options which should be applied for Scenes in the menu
@@ -73,17 +68,9 @@ declare global {
      */
     protected _onClickScene(event: JQuery.ClickEvent): void;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _onDragStart(event: DragEvent): void;
+    protected override _onDragStart(event: DragEvent): void;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _onDrop(event: DragEvent): void;
+    protected override _onDrop(event: DragEvent): void;
 
     /**
      * Handle navigation menu toggle click events

package/src/foundry/{foundry.js/applications → client/apps/hud}/pause.d.ts

@@ -10,8 +10,7 @@ declare class Pause<
 > extends Application<Options> {
   static get defaultOptions(): ApplicationOptions;
 
-  /** @override */
-  getData(options?: Partial<Options>): Data | Promise<Data>;
+  override getData(options?: Partial<Options>): Data | Promise<Data>;
 }
 
 declare namespace Pause {

package/src/foundry/{foundry.js/applications/playerList.d.ts → client/apps/hud/players.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -27,14 +27,11 @@ declare global {
      */
     static get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
+    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
 
-    /** @override */
-    getData(options?: Partial<Options>): PlayerList.Data | Promise<PlayerList.Data>;
+    override getData(options?: Partial<Options>): PlayerList.Data | Promise<PlayerList.Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Return the default context options available for the Players application

package/src/foundry/{foundry.js/localization.d.ts → client/apps/i18n.d.ts}

@@ -1,4 +1,4 @@
-import { ModuleData, SystemData } from '../common/packages.mjs';
+import { ModuleData, SystemData } from '../../common/packages.mjs';
 
 declare global {
   /**
@@ -79,7 +79,6 @@ declare global {
      * Return whether a certain string has a known translation defined.
      * @param stringId - The string key being translated
      * @param fallback - Allow fallback translations to count?
-     *                   (unused)
      */
     has(stringId: string, fallback?: boolean): boolean;
 

package/src/foundry/client/apps/index.d.ts

@@ -0,0 +1,9 @@
+import './app';
+import './av';
+import './form';
+import './forms';
+import './hud';
+import './i18n';
+import './placeables';
+import './sidebar';
+import './templates';

package/src/foundry/{foundry.js/applications/formApplications/drawingConfig.d.ts → client/apps/placeables/drawing-config.d.ts}

@@ -1,13 +1,21 @@
 import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
+  interface DrawingConfigOptions extends FormApplicationOptions {
+    /**
+     * Configure the default drawing settings, instead of a specific Drawing
+     * @defaultValue `false`
+     */
+    configureDefault: boolean;
+  }
+
   /**
    * The Application responsible for configuring a single Drawing document within a parent Scene.
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class DrawingConfig<
-    Options extends DrawingConfig.Options = DrawingConfig.Options,
+    Options extends DrawingConfigOptions = DrawingConfigOptions,
     Data extends object = DrawingConfig.Data<Options>
   > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Drawing'>>> {
     /**
@@ -18,19 +26,19 @@ declare global {
      *   classes: ["sheet"],
      *   template: "templates/scene/drawing-config.html",
      *   width: 480,
-     *   height: 360,
+     *   height: "auto",
      *   configureDefault: false,
      *   tabs: [{ navSelector: ".tabs", contentSelector: "form", initial: "position" }],
      * });
      * ```
      */
-    static get defaultOptions(): DrawingConfig.Options;
+    static override get defaultOptions(): DrawingConfigOptions;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override get id(): string;
+
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
     /**
      * Get the names and labels of fill type choices which can be applied
@@ -38,17 +46,11 @@ declare global {
      */
     protected static _getFillTypes(): DrawingConfig.FillTypes;
 
-    /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: DrawingConfig.FormData
-    ): Promise<foundry.data.DrawingData['_source'] | ConfiguredDocumentClassForName<'Drawing'> | undefined>;
+    protected override _updateObject(event: Event, formData: DrawingConfig.FormData): Promise<unknown>;
 
-    /** @override */
-    close(options?: FormApplication.CloseOptions): Promise<void>;
+    override close(options?: FormApplication.CloseOptions): Promise<void>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Reset the user Drawing configuration settings to their default values
@@ -58,7 +60,7 @@ declare global {
   }
 
   namespace DrawingConfig {
-    interface Data<Options extends DrawingConfig.Options = DrawingConfig.Options> {
+    interface Data<Options extends DrawingConfigOptions = DrawingConfigOptions> {
       author: string;
       isDefault: boolean;
       fillTypes: DrawingConfig.FillTypes;
@@ -93,18 +95,5 @@ declare global {
       y: number | null;
       z: number | null;
     }
-
-    interface Options extends FormApplicationOptions {
-      /**
-       * Configure the default drawing settings, instead of a specific Drawing
-       * @defaultValue `false`
-       */
-      configureDefault: boolean;
-
-      /**
-       * Configure a preview version of the Drawing which is not yet saved
-       */
-      preview?: boolean;
-    }
   }
 }

package/src/foundry/{foundry.js/applications/basePlaceableHUDs/drawingHUD.d.ts → client/apps/placeables/drawing-hud.d.ts}

@@ -10,7 +10,6 @@ declare global {
     Options
   > {
     /**
-     * @override
      * @defaultValue
      * ```
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -19,19 +18,14 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteDrawing>['getData']> & {
+    override getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteDrawing>['getData']> & {
       lockedClass: string;
       visibilityClass: string;
     };
 
-    /**
-     * @override
-     * @param options - (unused)
-     */
-    setPosition(options?: Partial<Application.Position>): void;
+    override setPosition(options?: Partial<Application.Position>): void;
   }
 }
 

package/src/foundry/client/apps/placeables/index.d.ts

@@ -0,0 +1,10 @@
+import './drawing-config';
+import './drawing-hud';
+import './light-config';
+import './note-config';
+import './sound-config';
+import './tile-config';
+import './tile-hud';
+import './token-config';
+import './token-hud';
+import './wall-config';

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts → client/apps/placeables/light-config.d.ts}

@@ -1,8 +1,8 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import type { AmbientLightDataConstructorData } from '../../../../common/data/data.mjs/ambientLightData';
-import type { AnimationDataConstructorData } from '../../../../common/data/data.mjs/animationData';
-import type { DarknessActivationConstructorData } from '../../../../common/data/data.mjs/darknessActivation';
-import type { LightDataConstructorData } from '../../../../common/data/data.mjs/lightData';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { AmbientLightDataConstructorData } from '../../../common/data/data.mjs/ambientLightData';
+import type { AnimationDataConstructorData } from '../../../common/data/data.mjs/animationData';
+import type { DarknessActivationConstructorData } from '../../../common/data/data.mjs/darknessActivation';
+import type { LightDataConstructorData } from '../../../common/data/data.mjs/lightData';
 
 declare global {
   /**
@@ -15,7 +15,6 @@ declare global {
     Data extends object = AmbientLightConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -29,39 +28,24 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    close(options?: Application.CloseOptions): Promise<void>;
+    override close(options?: Application.CloseOptions): Promise<void>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Preview the change caused by a change on the form by refreshing the display of the light source
      */
     protected _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
 
-    /** @override */
     protected _onResetForm(event: PointerEvent): void;
 
-    /** @override */
-    protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
+    protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(
-      event: Event,
-      formData: AmbientLightConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>> | undefined>;
+    protected override _updateObject(event: Event, formData: AmbientLightConfig.FormData): Promise<unknown>;
 
     /**
      * Refresh the display of the AmbientLight object
@@ -101,4 +85,11 @@ declare global {
       'config.shadows': LightDataConstructorData['shadows'];
     }
   }
+
+  /**
+   * @deprecated since v9
+   */
+  class LightConfig extends AmbientLightConfig {
+    constructor(...args: ConstructorParameters<typeof AmbientLightConfig>);
+  }
 }

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts → client/apps/placeables/note-config.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -11,7 +11,6 @@ declare global {
     Data extends object = NoteConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Note'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -21,27 +20,13 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(
-      event: Event,
-      formData: NoteConfig.FormData
-    ): Promise<ConfiguredDocumentClassForName<'Note'> | undefined>;
+    protected override _updateObject(event: Event, formData: NoteConfig.FormData): Promise<unknown>;
 
-    /**
-     * @override
-     */
-    close(options?: Application.CloseOptions): Promise<void>;
+    override close(options?: Application.CloseOptions): Promise<void>;
   }
 
   namespace NoteConfig {

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/ambientSoundConfig.d.ts → client/apps/placeables/sound-config.d.ts}

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import type { AmbientSoundDataConstructorData } from '../../../../common/data/data.mjs/ambientSoundData';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { AmbientSoundDataConstructorData } from '../../../common/data/data.mjs/ambientSoundData';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = AmbientSoundConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -24,29 +23,20 @@ declare global {
      */
     static get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    getData(options?: Partial<Options>): Promise<Data> | Data;
+    override getData(options?: Partial<Options>): Promise<Data> | Data;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(
-      event: Event,
-      formData: AmbientSoundConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>>;
+    protected override _updateObject(event: Event, formData: AmbientSoundConfig.FormData): Promise<unknown>;
 
-    /** @override */
-    close(options?: Application.CloseOptions): Promise<void>;
+    override close(options?: Application.CloseOptions): Promise<void>;
   }
 
   namespace AmbientSoundConfig {
     interface Data<Options extends DocumentSheetOptions>
       extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>, Options> {
       submitText: string;
+      gridUnits: string;
     }
 
     type FormData = Pick<foundry.data.AmbientSoundData, 'easing' | 'path' | 'volume'> &

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts → client/apps/placeables/tile-config.d.ts}

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import type { TileDataConstructorData } from '../../../../common/data/data.mjs/tileData';
+import { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { TileDataConstructorData } from '../../../common/data/data.mjs/tileData';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = TileConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Tile'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * mergeObject(super.defaultOptions, {
@@ -26,25 +25,15 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): TileConfig.Options;
+    static override get defaultOptions(): TileConfig.Options;
 
-    /** @override */
-    close(options: Application.CloseOptions): Promise<void>;
+    override close(options?: Application.CloseOptions | undefined): Promise<void>;
 
-    /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
-    /** @override */
-    protected _onChangeInput(event: JQuery.ChangeEvent): void;
+    protected override _onChangeInput(event: JQuery.ChangeEvent): void;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(
-      event: Event,
-      formData: TileConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Tile'>> | undefined>;
+    protected override _updateObject(event: Event, formData: TileConfig.FormData): Promise<unknown>;
   }
 
   namespace TileConfig {