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

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

@@ -5,29 +5,19 @@
  * @typeParam Options - The type of the options object
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
-
 declare class ModuleManagement<
   Options extends FormApplicationOptions = FormApplicationOptions,
   Data extends object = ModuleManagement.Data
 > extends FormApplication<Options, Data, undefined> {
-  /**
-   * @defaultValue `'all'`
-   * @internal
-   */
+  /** @internal */
   protected _filter: ModuleManagement.FilterName;
 
   /**
-   * @defaultValue `false`
+   * @defaultValue `true`
    * @internal
    */
   protected _expanded: boolean;
 
-  /**
-   * @defaultValue `{}`
-   * @internal
-   */
-  protected _checked: Record<string, boolean>;
-
   /**
    * The named game setting which persists module configuration.
    */
@@ -61,17 +51,11 @@ declare class ModuleManagement<
   /** @override */
   activateListeners(html: JQuery): void;
 
-  /**
-   * @override
-   * @param event - (unused)
-   */
-  protected _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<Record<string, boolean>>;
+  /** @override */
+  protected _renderInner(data: Data): Promise<JQuery>;
 
-  /**
-   * Restores the Form UI to the internal checked state
-   * @internal
-   */
-  protected _restoreCheckboxState(): void;
+  /** @override */
+  protected _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<unknown>;
 
   /**
    * Handle changes to a module checkbox to prompt for whether or not to enable dependencies
@@ -117,11 +101,11 @@ declare namespace ModuleManagement {
       count: number;
     }
 
-    type Module = foundry.packages.ModuleData['_source'] & {
+    type Module = Exclude<foundry.packages.ModuleData['_source'], 'authors'> & {
       active: boolean;
       availability: number;
       data: foundry.packages.ModuleData;
-      css: ' active' | '';
+      css: string;
       hasPacks: boolean;
       hasScripts: boolean;
       hasStyles: boolean;
@@ -130,6 +114,8 @@ declare namespace ModuleManagement {
       dependencies: string[] | null;
       unavailable?: string;
       incompatible?: string;
+      authors: string | undefined;
+      labels: string;
     };
   }
 

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

@@ -49,7 +49,7 @@ declare class PermissionConfig extends FormApplication<FormApplicationOptions, P
    * @param event - (unused)
    * @override
    */
-  protected _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<void>;
+  protected _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<unknown>;
 }
 
 declare namespace PermissionConfig {

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

@@ -2,7 +2,7 @@ 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.
@@ -21,7 +21,9 @@ 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"}
+     *   ]
      * })
      * ```
      */
@@ -50,8 +52,18 @@ declare global {
      */
     protected _onResetDefaults(event: JQuery.ClickEvent): 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>;
+
     /** @override */
-    protected _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<void>;
+    protected _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<unknown>;
   }
 
   namespace SettingsConfig {

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

@@ -1,9 +1,10 @@
 import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { TokenDataConstructorData } from '../../../common/data/data.mjs/tokenData';
 
 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.
    */
@@ -33,7 +34,11 @@ 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
      * })
      * ```
      */
@@ -61,6 +66,9 @@ declare global {
     /** @override */
     render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<this>;
 
+    /** @override */
+    protected _renderInner(...args: [Data]): Promise<JQuery>;
+
     /**
      * Get an Object of image paths and filenames to display in the Token sheet
      * @internal
@@ -68,20 +76,19 @@ declare global {
     protected _getAlternateTokenImages(): Promise<Record<string, string>>;
 
     /** @override */
-    activateListeners(html: JQuery): void;
+    protected _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 };
+    activateListeners(html: JQuery): void;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: TokenConfig.FormData
-    ): Promise<
-      | InstanceType<ConfiguredDocumentClassForName<'Token'>>
-      | InstanceType<ConfiguredDocumentClassForName<'Actor'>>
-      | undefined
-    >;
+    protected _updateObject(event: Event, formData: TokenConfig.FormData): Promise<unknown>;
 
     /**
      * Handle Token assignment requests to update the default prototype Token
@@ -110,15 +117,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;
     }
 

package/src/foundry/foundry.js/applications/formApplications/{defaultTokenConfig.d.ts → tokenConfigs/defaultTokenConfig.d.ts}

@@ -1,3 +1,6 @@
+import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
+import type { TokenBarData } from '../../../../common/data/data.mjs/tokenBarData';
+
 declare global {
   /**
    * A sheet that alters the values of the default Token configuration used when new Token documents are created.
@@ -5,13 +8,18 @@ declare global {
   class DefaultTokenConfig<
     Options extends FormApplicationOptions = FormApplicationOptions,
     Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
-  > extends FormApplication<Options, Data, foundry.data.TokenData['_source']> {
-    constructor(object: unknown, options: Options);
+  > 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;
 
@@ -20,24 +28,26 @@ declare global {
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "default-token-config",
-     *   classes: ["sheet"],
      *   template: "templates/scene/default-token-config.html",
-     *   title: "Default Token Configuration",
-     *   width: 480,
-     *   height: "auto"
+     *   sheetConfig: false
      * })
      * ```
      */
-    static get defaultOptions(): typeof FormApplication['defaultOptions'];
+    static get defaultOptions(): FormApplicationOptions;
+
+    /** @override */
+    get id(): string;
+
+    /** @override */
+    get title(): string;
 
     /** @override */
     getData(options: unknown): Data | Promise<Data>;
 
     /** @override */
     _getSubmitData(
-      updateData?: Parameters<FormApplication['_getSubmitData']>[0]
-    ): ReturnType<FormApplication['_getSubmitData']>;
+      updateData?: Parameters<TokenConfig['_getSubmitData']>[0]
+    ): ReturnType<TokenConfig['_getSubmitData']>;
 
     /** @override */
     _updateObject(event: Event, formData?: object): Promise<unknown>;
@@ -49,16 +59,19 @@ declare global {
      * Reset the form to default values
      */
     reset(): void;
+
+    /** @override */
+    protected _onBarChange(): Promise<void>;
   }
 
   namespace DefaultTokenConfig {
-    interface Data {
-      object: DefaultTokenConfig['object'];
+    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']>;
-      dispositions: Record<ValueOf<typeof CONST.TOKEN_DISPOSITIONS>, string>;
-      lightAnimations: Record<string, string>;
-      displayModes: Record<ValueOf<typeof CONST.TOKEN_DISPLAY_MODES>, string>;
-      lightAlpha: number;
+      bar1: TokenBarData;
+      bar2: TokenBarData;
     }
   }
 }

package/src/foundry/foundry.js/applications/formApplications/tokenConfigs/index.d.ts

@@ -0,0 +1 @@
+import './defaultTokenConfig';

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -7,41 +7,47 @@ 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;
+
+    /**
+     * 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;
+    render(
+      force?: boolean,
+      options?: Application.RenderOptions<Options> & {
+        walls?: InstanceType<ConfiguredObjectClassForName<'Wall'>>[] | undefined;
+      }
+    ): this;
 
     /** @override */
     getData(): Data | Promise<Data>;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: WallConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Wall'>> | undefined>;
+    protected _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 +69,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/formApplications/worldConfig.d.ts

@@ -1,13 +1,24 @@
+interface WorldConfigOptions extends FormApplicationOptions {
+  /**
+   * Whether the world is being created or updated.
+   * @defaultValue `false`
+   */
+  create: boolean;
+
+  inWorld?: boolean | undefined;
+}
+
 /**
  * The World Management setup application
  * @typeParam Options - The type of the options object
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class WorldConfig<
-  Options extends WorldConfig.Options = WorldConfig.Options,
+  Options extends WorldConfigOptions = WorldConfigOptions,
   Data extends object = WorldConfig.Data
 > extends FormApplication<Options, Data, Game.WorldData<foundry.packages.WorldData>> {
   /**
+   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -19,13 +30,16 @@ declare class WorldConfig<
    * })
    * ```
    */
-  static get defaultOptions(): WorldConfig.Options;
+  static get defaultOptions(): WorldConfigOptions;
 
   static WORLD_KB_URL: 'https://foundryvtt.com/article/game-worlds/';
 
   /** @override */
   get title(): string;
 
+  /** @override */
+  activateListeners(html: JQuery): void;
+
   /** @override */
   getData(options?: Partial<Options>): Data | Promise<Data>;
 
@@ -40,8 +54,14 @@ declare class WorldConfig<
    */
   protected _updateObject(...args: unknown[]): Promise<unknown>;
 
+  /**
+   * Update the world name placeholder when the title is changed.
+   * @internal
+   */
+  protected _onTitleChange(event: JQuery.TriggeredEvent): void;
+
   /** @override **/
-  activateEditor(name: string, options?: TextEditor.Options, initialContent?: string): void;
+  activateEditor(name: string, options?: TextEditor.Options | undefined, initialContent?: string | undefined): void;
 }
 
 declare namespace WorldConfig {
@@ -56,13 +76,4 @@ declare namespace WorldConfig {
     showEditFields: boolean;
     systems?: Game.SystemData<foundry.packages.SystemData>[];
   }
-
-  interface Options extends FormApplicationOptions {
-    /**
-     * @defaultValue `false`
-     */
-    create: boolean;
-
-    inWorld?: boolean;
-  }
 }

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

@@ -94,11 +94,15 @@ declare global {
     /** @override */
     activateListeners(html: JQuery): void;
 
+    /** @override */
+    protected _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

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

@@ -21,3 +21,4 @@ import './sceneNavigation';
 import './sidebar';
 import './sidebarTab';
 import './sidebarTabs';
+import './supportDetails';

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

@@ -1,25 +1,40 @@
 /**
  * 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 extends Application {
+declare class InvitationLinks<
+  Options extends ApplicationOptions = ApplicationOptions,
+  Data extends object = InvitationLinks.Data
+> extends Application<Options> {
   /**
+   * @override
    * @defaultValue
    * ```typescript
-   * {
-   *   ...super.defaultOptions,
-   *   id: 'invitation-links',
-   *   template: 'templates/sidebar/apps/invitation-links.html',
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   id: "invitation-links",
+   *   template: "templates/sidebar/apps/invitation-links.html",
    *   title: game.i18n.localize("INVITATIONS.Title"),
-   *   width: 400,
-   * }
+   *   width: 400
+   * })
    * ```
    */
-  static get defaultOptions(): typeof Application['defaultOptions'];
+  static get defaultOptions(): ApplicationOptions;
 
   /** @override */
-  getData(): { local?: string; remote?: string };
+  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;
+  }
+}

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

@@ -91,7 +91,10 @@ declare global {
      */
     protected _onToggleNav(event: JQuery.ClickEvent): void;
 
-    static _onLoadProgress(context: string, pct: number): void;
+    /**
+     * Display progress of some major operation like loading Scene textures.
+     */
+    static displayProgressBar(options: SceneNavigation.DisplayProgressBarOptions): void;
   }
 
   namespace SceneNavigation {
@@ -104,5 +107,17 @@ declare global {
         css: string;
       })[];
     }
+
+    interface DisplayProgressBarOptions {
+      /**
+       * A text label to display
+       */
+      label?: string | undefined;
+
+      /**
+       * A percentage of progress between 0 and 100
+       */
+      pct: number;
+    }
   }
 }

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

@@ -84,6 +84,13 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
    */
   protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
 
+  /**
+   * Handle the special case of left-clicking a tab when the sidebar is collapsed.
+   * @param event - The originating click event
+   * @internal
+   */
+  protected _onLeftClickTab(event: MouseEvent): void;
+
   /**
    * Handle right-click events on tab controls to trigger pop-out containers for each tab
    * @param event - The originating contextmenu event