@league-of-foundry-developers/foundry-vtt-types 9.268.0 → 9.269.0

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,24 +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<unknown>;
+    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,20 +23,13 @@ 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<unknown>;
+    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 {

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,22 +25,15 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): TileConfig.Options;
+    static override get defaultOptions(): TileConfig.Options;
 
-    /** @override */
-    close(options?: Application.CloseOptions | undefined): Promise<void>;
+    override close(options?: Application.CloseOptions | undefined): Promise<void>;
 
-    /** @override */
-    getData(options?: Partial<Options> | undefined): 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<unknown>;
+    protected override _updateObject(event: Event, formData: TileConfig.FormData): Promise<unknown>;
   }
 
   namespace TileConfig {

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,4 +1,5 @@
 import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { TokenBarData } from '../../../common/data/data.mjs/tokenBarData';
 
 declare global {
   /**
@@ -26,7 +27,6 @@ declare global {
     token: InstanceType<ConfiguredDocumentClassForName<'Token'>> | PrototypeTokenDocument;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -42,10 +42,9 @@ declare global {
      * })
      * ```
      */
-    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.
@@ -57,17 +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>;
 
-    /** @override */
-    protected _renderInner(...args: [Data]): Promise<JQuery>;
+    protected override _renderInner(...args: [Data]): Promise<JQuery>;
 
     /**
      * Get an Object of image paths and filenames to display in the Token sheet
@@ -75,8 +70,7 @@ declare global {
      */
     protected _getAlternateTokenImages(): Promise<Record<string, string>>;
 
-    /** @override */
-    protected _getHeaderButtons(): Application.HeaderButton[];
+    protected override _getHeaderButtons(): Application.HeaderButton[];
 
     /**
      * Shim for {@link DocumentSheet#_onConfigureSheet} that will be replaced in v10 when this class subclasses it.
@@ -84,11 +78,9 @@ declare global {
      */
     protected _onConfigureSheet(event: JQuery.ClickEvent): void;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
-    /** @override */
-    protected _updateObject(event: Event, formData: TokenConfig.FormData): Promise<unknown>;
+    protected override _updateObject(event: Event, formData: TokenConfig.FormData): Promise<unknown>;
 
     /**
      * Handle Token assignment requests to update the default prototype Token
@@ -166,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}

@@ -26,22 +26,18 @@ declare global {
      */
     editTargets: string[];
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    render(
+    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<unknown>;
+    protected override _updateObject(event: Event, formData: WallConfig.FormData): Promise<unknown>;
   }
 
   namespace WallConfig {

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 {
   /**
@@ -14,7 +14,6 @@ declare global {
     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,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = SettingsConfig.Data
   > extends FormApplication<Options, Data> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -27,16 +26,11 @@ declare global {
      * })
      * ```
      */
-    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
@@ -59,11 +53,9 @@ declare global {
      */
     protected _previewFontScaling(event: JQuery.ChangeEvent): void;
 
-    /** @override */
-    close(options?: Application.CloseOptions | undefined): Promise<void>;
+    override close(options?: Application.CloseOptions | undefined): Promise<void>;
 
-    /** @override */
-    protected _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<unknown>;
+    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

@@ -18,7 +18,6 @@ declare class Compendium<
   collection: CompendiumCollection<Metadata>;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -33,24 +32,20 @@ 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<Data> | Data;
+  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 document class and its sheet
@@ -58,26 +53,20 @@ declare class Compendium<
    */
   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;
 
-  /** @override */
-  protected _contextMenu(html: JQuery): void;
+  protected override _contextMenu(html: JQuery): void;
 
   /**
    * Get Compendium entry context options

package/src/foundry/{foundry.js/applications/controlsReference.d.ts → client/apps/sidebar/apps/controls-reference.d.ts}

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

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/{foundry.js/applications/invitationLinks.d.ts → client/apps/sidebar/apps/invitation-links.d.ts}

@@ -9,7 +9,6 @@ declare class InvitationLinks<
   Data extends object = InvitationLinks.Data
 > extends Application<Options> {
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -20,13 +19,11 @@ declare class InvitationLinks<
    * })
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
-  /** @override */
-  getData(options?: Partial<Options> | undefined): Promise<Data>;
+  override getData(options?: Partial<Options> | undefined): Promise<Data>;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 }
 
 declare namespace InvitationLinks {

package/src/foundry/{foundry.js/applications/formApplications/keybindingsConfig.d.ts → client/apps/sidebar/apps/keybindings-config.d.ts}

@@ -22,7 +22,6 @@ declare class KeybindingsConfig<
   protected _pendingEdits: Map<string, KeybindingsConfig.PendingBinding[]>;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -37,13 +36,9 @@ declare class KeybindingsConfig<
    * })
    * ```
    */
-  static get defaultOptions(): FormApplicationOptions;
+  static override get defaultOptions(): FormApplicationOptions;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<Options>): Data;
+  override getData(options?: Partial<Options>): Data;
 
   /**
    * Builds the set of Bindings into a form usable for display and configuration
@@ -98,8 +93,7 @@ declare class KeybindingsConfig<
    */
   protected _categorizeAction(action: KeybindingsConfig): KeybindingsConfig.BaseCategory;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle left-click events to filter to a certain category
@@ -195,11 +189,7 @@ declare class KeybindingsConfig<
    */
   protected _onKeydownBindingInput(event: KeyboardEvent): void;
 
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
   /** @remarks KeybindingsConfig does not implement this method. */
   protected _updateObject(event?: unknown, formData?: unknown): Promise<never>;