@league-of-foundry-developers/foundry-vtt-types 9.255.3 → 9.268.2

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

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

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

@@ -1,9 +1,11 @@
 import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { TokenDataConstructorData } from '../../../common/data/data.mjs/tokenData';
+import type { TokenBarData } from '../../../common/data/data.mjs/tokenBarData';
 
 declare global {
   /**
    * The Application responsible for configuring a single Token document within a parent Scene.
+   * Note that due to an oversight, this class does not inherit from {@link DocumentSheet} as it was intended to, and will
+   * be changed in v10.
    * @typeParam Options - The type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
@@ -25,7 +27,6 @@ declare global {
     token: InstanceType<ConfiguredDocumentClassForName<'Token'>> | PrototypeTokenDocument;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -33,14 +34,17 @@ declare global {
      *   template: "templates/scene/token-config.html",
      *   width: 480,
      *   height: "auto",
-     *   tabs: [{ navSelector: ".tabs", contentSelector: "form", initial: "character" }],
+     *   tabs: [
+     *     {navSelector: '.tabs[data-group="main"]', contentSelector: "form", initial: "character"},
+     *     {navSelector: '.tabs[data-group="light"]', contentSelector: '.tab[data-tab="light"]', initial: "basic"}
+     *   ],
+     *   sheetConfig: true
      * })
      * ```
      */
-    static get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplicationOptions;
 
-    /** @override */
-    get id(): string;
+    override get id(): string;
 
     /**
      * A convenience accessor to test whether we are configuring the prototype Token for an Actor.
@@ -52,14 +56,13 @@ declare global {
      */
     get actor(): InstanceType<ConfiguredDocumentClassForName<'Actor'>>;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<this>;
+    override render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<this>;
+
+    protected override _renderInner(...args: [Data]): Promise<JQuery>;
 
     /**
      * Get an Object of image paths and filenames to display in the Token sheet
@@ -67,21 +70,17 @@ declare global {
      */
     protected _getAlternateTokenImages(): Promise<Record<string, string>>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    protected override _getHeaderButtons(): Application.HeaderButton[];
+
+    /**
+     * Shim for {@link DocumentSheet#_onConfigureSheet} that will be replaced in v10 when this class subclasses it.
+     * @internal
+     */
+    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
 
-    /** @override */
-    protected _getSubmitData(updateData?: TokenDataConstructorData): Record<string, unknown> & { lightAlpha: number };
+    override activateListeners(html: JQuery): void;
 
-    /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: TokenConfig.FormData
-    ): Promise<
-      | InstanceType<ConfiguredDocumentClassForName<'Token'>>
-      | InstanceType<ConfiguredDocumentClassForName<'Actor'>>
-      | undefined
-    >;
+    protected override _updateObject(event: Event, formData: TokenConfig.FormData): Promise<unknown>;
 
     /**
      * Handle Token assignment requests to update the default prototype Token
@@ -110,15 +109,15 @@ declare global {
       alternateImages: Record<string, string> | [];
       object: foundry.data.PrototypeTokenData | foundry.data.TokenData;
       options: Options;
-      gridUnits: string | undefined;
+      gridUnits: string;
       barAttributes: Record<string, string[]>;
-      bar1: ReturnType<TokenDocument['getBarAttribute']>;
-      bar2: ReturnType<TokenDocument['getBarAttribute']>;
+      bar1: ReturnType<TokenDocument['getBarAttribute']> | undefined;
+      bar2: ReturnType<TokenDocument['getBarAttribute']> | undefined;
+      colorationTechniques: AdaptiveLightingShader.ColorationTechniques;
       displayModes: Record<foundry.CONST.TOKEN_DISPLAY_MODES, string>;
       actors: { _id: string; name: string }[];
       dispositions: Record<foundry.CONST.TOKEN_DISPOSITIONS, string>;
       lightAnimations: { [Key in keyof typeof CONFIG.Canvas.lightAnimations]: string } & { '': string };
-      lightAlpha: number;
       isGM: boolean;
     }
 
@@ -159,4 +158,69 @@ declare global {
       y: number | null;
     }
   }
+
+  /**
+   * A sheet that alters the values of the default Token configuration used when new Token documents are created.
+   */
+  class DefaultTokenConfig<
+    Options extends FormApplicationOptions = FormApplicationOptions,
+    Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
+  > extends TokenConfig<Options, Data> {
+    constructor(object: unknown, options?: Partial<Options> | undefined);
+
+    data: foundry.data.TokenData;
+
+    object: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
+
+    token: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
+
+    /**
+     * The named world setting that stores the default Token configuration
+     * @defaultValue `"defaultToken"`
+     */
+    static SETTING: string;
+
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   template: "templates/scene/default-token-config.html",
+     *   sheetConfig: false
+     * })
+     * ```
+     */
+    static override get defaultOptions(): FormApplicationOptions;
+
+    override get id(): string;
+
+    override get title(): string;
+
+    override getData(options: unknown): Data | Promise<Data>;
+
+    override _getSubmitData(
+      updateData?: Parameters<TokenConfig['_getSubmitData']>[0]
+    ): ReturnType<TokenConfig['_getSubmitData']>;
+
+    override _updateObject(event: Event, formData?: object): Promise<unknown>;
+
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * Reset the form to default values
+     */
+    reset(): void;
+
+    protected override _onBarChange(): Promise<void>;
+  }
+
+  namespace DefaultTokenConfig {
+    interface Data<Options extends FormApplicationOptions = FormApplicationOptions>
+      extends Omit<TokenConfig.Data<Options>, 'object' | 'bar1' | 'bar2'> {
+      object: foundry.data.TokenData['_source'];
+      isDefault: true;
+      barAttributes: ReturnType<typeof TokenDocument['getTrackedAttributeChoices']>;
+      bar1: TokenBarData;
+      bar2: TokenBarData;
+    }
+  }
 }

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

@@ -18,7 +18,6 @@ declare global {
     protected _statusEffects: boolean;
 
     /**
-     * @override
      * @defaultValue
      * ```
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -27,24 +26,18 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    bind(object: ConcreteToken): void;
+    override bind(object: ConcreteToken): void;
 
     /**
      * Refresh the currently active state of all status effect icons in the Token HUD selector.
      */
     refreshStatusIcons(): void;
 
-    /**
-     * @override
-     * @param _position - (unused)
-     */
-    setPosition(_position?: Partial<Application.Position>): void;
+    override setPosition(_position?: Partial<Application.Position>): void;
 
-    /** @override */
-    getData(options?: Partial<ApplicationOptions>): ReturnType<BasePlaceableHUD<ConcreteToken>['getData']> & {
+    override getData(options?: Partial<ApplicationOptions>): ReturnType<BasePlaceableHUD<ConcreteToken>['getData']> & {
       canConfigure: boolean;
       canToggleCombat: boolean;
       displayBar1: boolean;
@@ -74,11 +67,9 @@ declare global {
       }
     >;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
-    /** @override */
-    protected _onClickControl(event: JQuery.ClickEvent): unknown;
+    protected override _onClickControl(event: JQuery.ClickEvent): unknown;
 
     /**
      * Handle initial click to focus an attribute update field

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -7,41 +7,43 @@ declare global {
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class WallConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
+    Options extends DocumentSheetOptions = DocumentSheetOptions,
     Data extends object = WallConfig.Data<Options>
-  > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Wall'>>> {
+  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Wall'>>> {
     /**
      * @defaultValue
      * ```typescript
      * const options = super.defaultOptions;
-     * options.id = "wall-config";
-     * options.title = "Wall Configuration";
      * options.template = "templates/scene/wall-config.html";
      * options.width = 400;
      * ```
      */
-    static get defaultOptions(): FormApplicationOptions;
+    static get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get title(): string;
+    /**
+     * An array of Wall ids that should all be edited when changes to this config form are submitted
+     * @defaultValue `[]`
+     */
+    editTargets: string[];
+
+    override get title(): string;
 
-    /** @override */
-    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
+    override render(
+      force?: boolean,
+      options?: Application.RenderOptions<Options> & {
+        walls?: InstanceType<ConfiguredObjectClassForName<'Wall'>>[] | undefined;
+      }
+    ): this;
 
-    /** @override */
-    getData(): Data | Promise<Data>;
+    override getData(): Data | Promise<Data>;
 
-    /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: WallConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Wall'>> | undefined>;
+    protected override _updateObject(event: Event, formData: WallConfig.FormData): Promise<unknown>;
   }
 
   namespace WallConfig {
-    interface Data<Options extends FormApplicationOptions = FormApplicationOptions> {
-      object: foundry.data.WallData['_source'];
-      options: Options;
+    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
+      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Wall'>>, Options> {
+      object: DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Wall'>>, Options>['data'];
       moveTypes: {
         [Key in keyof typeof foundry.CONST.WALL_MOVEMENT_TYPES as typeof foundry.CONST.WALL_MOVEMENT_TYPES[Key]]: Titlecase<Key>;
       };
@@ -63,9 +65,10 @@ declare global {
     interface FormData {
       dir: foundry.CONST.WALL_DIRECTIONS;
       door: foundry.CONST.WALL_DOOR_TYPES;
+      light: foundry.CONST.WALL_SENSE_TYPES;
       ds?: foundry.CONST.WALL_DOOR_STATES;
       move: foundry.CONST.WALL_MOVEMENT_TYPES;
-      sense: foundry.CONST.WALL_SENSE_TYPES;
+      sight: foundry.CONST.WALL_SENSE_TYPES;
       sound: foundry.CONST.WALL_SENSE_TYPES;
     }
   }

package/src/foundry/{foundry.js/applications/chatPopout.d.ts → client/apps/sidebar/apps/chat-popout.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -9,12 +9,11 @@ declare global {
     constructor(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, options?: Partial<Options>);
 
     /**
-     * The displayed Chat Message entity
+     * The displayed Chat Message document
      */
     message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -24,19 +23,12 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    get id(): string;
+    override get id(): string;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @param data    - (unused)
-     * @param options - (unused)
-     * @override
-     */
-    protected _renderInner(data: object, options?: unknown): Promise<JQuery>;
+    protected override _renderInner(data: object, options?: unknown): Promise<JQuery>;
   }
 }

package/src/foundry/{foundry.js/applications/formApplications/settingsConfig.d.ts → client/apps/sidebar/apps/client-settings.d.ts}

@@ -1,8 +1,8 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
-   * The Application responsible for displaying and editing a single Setting document.
+   * The Application responsible for displaying and editing the client and world settings for this world.
    * This form renders the settings defined via the game.settings.register API which have config = true
    * @typeParam Options - The type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
@@ -12,7 +12,6 @@ declare global {
     Data extends object = SettingsConfig.Data
   > extends FormApplication<Options, Data> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -21,20 +20,17 @@ declare global {
      *   template: "templates/sidebar/apps/settings-config.html",
      *   width: 600,
      *   height: "auto",
-     *   tabs: [{ navSelector: ".tabs", contentSelector: ".content", initial: "core" }],
+     *   tabs: [
+     *     {navSelector: ".tabs", contentSelector: ".content", initial: "core"}
+     *   ]
      * })
      * ```
      */
-    static get defaultOptions(): typeof FormApplication['defaultOptions'];
+    static override get defaultOptions(): typeof FormApplication['defaultOptions'];
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle activating the button to configure User Role permissions
@@ -50,8 +46,16 @@ declare global {
      */
     protected _onResetDefaults(event: JQuery.ClickEvent): void;
 
-    /** @override */
-    protected _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<void>;
+    /**
+     * Preview font scaling as the setting is changed.
+     * @param event - The triggering event.
+     * @internal
+     */
+    protected _previewFontScaling(event: JQuery.ChangeEvent): void;
+
+    override close(options?: Application.CloseOptions | undefined): Promise<void>;
+
+    protected override _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<unknown>;
   }
 
   namespace SettingsConfig {

package/src/foundry/{foundry.js/applications → client/apps/sidebar/apps}/compendium.d.ts

@@ -2,17 +2,22 @@
  * An interface for displaying the content of a CompendiumCollection.
  * @typeParam Metadata - The metadata of the compendium
  * @typeParam Options  - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class Compendium<
   Metadata extends CompendiumCollection.Metadata,
-  Options extends ApplicationOptions = ApplicationOptions
+  Options extends ApplicationOptions = ApplicationOptions,
+  Data extends object = Compendium.Data<Metadata>
 > extends Application<Options> {
-  constructor(collection: CompendiumCollection<Metadata>, options?: Partial<Options>);
+  /**
+   * @param collection - The {@link CompendiumCollection} object represented by this interface.
+   * @param options    - Application configuration options.
+   */
+  constructor(collection: CompendiumCollection<Metadata>, options?: Partial<Options> | undefined);
 
   collection: CompendiumCollection<Metadata>;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -27,62 +32,55 @@ declare class Compendium<
    * });
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
-  /** @override */
-  get title(): string;
+  override get title(): string;
 
   /**
    * A convenience redirection back to the metadata object of the associated CompendiumCollection
    */
   get metadata(): this['collection']['metadata'];
 
-  /** @override */
-  getData(options?: Partial<Options>): Promise<Compendium.Data<Metadata>>;
+  override getData(options?: Partial<Options>): Promise<Data> | 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;
 
   /**
-   * Handle opening a single compendium entry by invoking the configured entity class and its sheet
+   * Handle opening a single compendium entry by invoking the configured document class and its sheet
    * @param event - The originating click event
-   * @remarks
-   * This actually returns a promise of {@link FormApplication} but the return type is not meant to be used, so it is
-   * typed as `unknown` to give deriving classes more freedom.
    */
-  protected _onClickEntry(event: JQuery.ClickEvent): Promise<unknown>;
+  protected _onClickEntry(event: JQuery.ClickEvent): void;
 
-  /** @override */
-  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
-  /** @override */
-  protected _canDragStart(selector: string): boolean;
+  protected override _canDragStart(selector: string): boolean;
 
-  /** @override */
-  protected _canDragDrop(selector: string): boolean;
+  protected override _canDragDrop(selector: string): boolean;
 
-  /** @override */
-  protected _onDragStart(event: DragEvent): void;
+  protected override _onDragStart(event: DragEvent): void;
 
   /**
-   * @override
    * @internal
    */
-  protected _onDrop(event: DragEvent): void;
+  protected override _onDrop(event: DragEvent): void;
+
+  protected override _contextMenu(html: JQuery): void;
 
   /**
-   * Render the ContextMenu which applies to each compendium Document
+   * Get Compendium entry context options
+   * @returns The Compendium entry context options
+   * @internal
    */
-  protected _contextMenu(html: JQuery): void;
+  protected _getEntryContextOptions(): ContextMenuEntry;
 }
 
 declare namespace Compendium {
   interface Data<Metadata extends CompendiumCollection.Metadata> {
     collection: CompendiumCollection<Metadata>;
-    cssClass: string;
+    documentCls: string;
     index: CompendiumCollection<Metadata>['index'];
+    documentPartial: string;
   }
 }

package/src/foundry/client/apps/sidebar/apps/controls-reference.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Keyboard Controls Reference Sheet
+ * @typeParam Options - the type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ * @deprecated since v9
+ */
+declare class ControlsReference<
+  Options extends ApplicationOptions = ApplicationOptions,
+  Data extends object = ControlsReference.Data
+> extends Application<Options> {
+  /**
+   * @defaultValue
+   * ```typescript
+   * const options = super.defaultOptions;
+   * options.title = game.i18n.localize("CONTROLS.Title");
+   * options.id = "controls-reference";
+   * options.template = "templates/sidebar/apps/controls-reference.html";
+   * options.width = 600;
+   * ```
+   */
+  static get defaultOptions(): ApplicationOptions;
+
+  override getData(options?: Partial<Options>): Data | Promise<Data>;
+}
+
+declare namespace ControlsReference {
+  interface Data {
+    controlKey: '⌘' | 'Control';
+  }
+}

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

@@ -0,0 +1,10 @@
+import './chat-popout';
+import './client-settings';
+import './compendium';
+import './controls-reference';
+import './invitation-links';
+import './keybindings-config';
+import './module-management';
+import './permission-config';
+import './support-details';
+import './world-config';

package/src/foundry/client/apps/sidebar/apps/invitation-links.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Game Invitation Links Reference
+ *
+ * @typeParam Options - the type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ */
+declare class InvitationLinks<
+  Options extends ApplicationOptions = ApplicationOptions,
+  Data extends object = InvitationLinks.Data
+> extends Application<Options> {
+  /**
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   id: "invitation-links",
+   *   template: "templates/sidebar/apps/invitation-links.html",
+   *   title: game.i18n.localize("INVITATIONS.Title"),
+   *   width: 400
+   * })
+   * ```
+   */
+  static override get defaultOptions(): ApplicationOptions;
+
+  override getData(options?: Partial<Options> | undefined): Promise<Data>;
+
+  override activateListeners(html: JQuery): void;
+}
+
+declare namespace InvitationLinks {
+  type Adddresses = Game.Data['addresses'];
+  interface Data extends Adddresses {
+    remoteClass?: string;
+    remoteTitle?: string;
+    failedCheck?: boolean;
+    canConnect?: boolean;
+  }
+}