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

package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts

@@ -2,9 +2,7 @@ import type { ConfiguredDocumentClassForName, DocumentConstructor } from '../../
 
 declare global {
   /**
-   * The Application responsible for configuring a single Scene document.
-   * @see {@link Scene} The Scene Document which is being configured
-   *
+   * The Application responsible for configuring a single Scene document.   *
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
@@ -20,8 +18,9 @@ declare global {
      *   id: "scene-config",
      *   classes: ["sheet", "scene-sheet"],
      *   template: "templates/scene/config.html",
-     *   width: 680,
+     *   width: 560,
      *   height: "auto",
+     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
      * });
      * ```
      */
@@ -32,13 +31,11 @@ declare global {
      */
     get title(): string;
 
-    /**
-     * @override
-     * @remarks This incorrectly overrides `Application#render` by potentially returning `void`, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6026.
-     */
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-expect-error
-    render(force?: boolean, options?: Application.RenderOptions<Options>): this | void;
+    /** @override */
+    close(options?: Application.CloseOptions | undefined): Promise<void>;
+
+    /** @override */
+    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
 
     /**
      * @param options - (unused)
@@ -74,9 +71,28 @@ declare global {
      */
     protected _onCapturePosition(event: JQuery.ClickEvent): void;
 
+    /** @override */
+    protected _onChangeInput(event: JQuery.ChangeEvent): void;
+
+    /** @override */
+    protected _onChangeColorPicker(event: JQuery.ChangeEvent): void;
+
     /** @override */
     protected _onChangeRange(event: JQuery.ChangeEvent): void;
 
+    /**
+     * Live update the scene as certain properties are changed.
+     * @param changed - The changed property.
+     * @internal
+     */
+    protected _previewScene(changed: string): void;
+
+    /**
+     * Reset the previewed darkness level, background color, grid alpha, and grid color back to their true values.
+     * @internal
+     */
+    protected _resetScenePreview(): void;
+
     /**
      * Handle updating the select menu of PlaylistSound options when the Playlist is changed
      * @param event - The initiating select change event
@@ -93,10 +109,7 @@ declare global {
     /**
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: SceneConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Scene'>> | undefined>;
+    protected _updateObject(event: Event, formData: SceneConfig.FormData): Promise<unknown>;
   }
 
   namespace SceneConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts

@@ -29,10 +29,10 @@ declare global {
     static get defaultOptions(): TileConfig.Options;
 
     /** @override */
-    close(options: Application.CloseOptions): Promise<void>;
+    close(options?: Application.CloseOptions | undefined): Promise<void>;
 
     /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
     /** @override */
     protected _onChangeInput(event: JQuery.ChangeEvent): void;
@@ -41,10 +41,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: TileConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Tile'>> | undefined>;
+    protected _updateObject(event: Event, formData: TileConfig.FormData): Promise<unknown>;
   }
 
   namespace TileConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/userConfig.d.ts

@@ -41,10 +41,7 @@ declare global {
     /**
      * @remarks This method not overridden in foundry but added to provide types when overriding the UserConfig.
      */
-    protected _updateObject(
-      event: Event,
-      formData: FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof User>> | undefined>;
+    protected _updateObject(event: Event, formData: FormData): Promise<unknown>;
   }
 
   namespace UserConfig {

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

@@ -1,16 +1,25 @@
 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'>>> {
     /**
+     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -18,17 +27,20 @@ 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 get defaultOptions(): DrawingConfigOptions;
 
     /** @override */
     get title(): string;
 
+    /** @override */
+    get id(): string;
+
     /** @override */
     getData(options?: Partial<Options>): Data | Promise<Data>;
 
@@ -39,10 +51,7 @@ declare global {
     protected static _getFillTypes(): DrawingConfig.FillTypes;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: DrawingConfig.FormData
-    ): Promise<foundry.data.DrawingData['_source'] | ConfiguredDocumentClassForName<'Drawing'> | undefined>;
+    protected _updateObject(event: Event, formData: DrawingConfig.FormData): Promise<unknown>;
 
     /** @override */
     close(options?: FormApplication.CloseOptions): Promise<void>;
@@ -58,7 +67,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 +102,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/formApplications/gridConfig.d.ts

@@ -75,14 +75,14 @@ declare global {
     close(options?: FormApplication.CloseOptions): ReturnType<FormApplication['close']>;
 
     /**
-     * Handle resetting the form and re-drawing back to the original dimensions
+     * Handle keyboard events.
      * @param event - The original keydown event
      * @internal
      */
     protected _onKeyDown(event: KeyboardEvent): void;
 
     /**
-     * Handle resetting the form and re-drawing back to the original dimensions
+     * Handle mousewheel events.
      * @param event - The original wheel event
      * @internal
      */
@@ -145,7 +145,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(event: Event, formData: GridConfig.FormData): ReturnType<Scene['update']>;
+    protected _updateObject(event: Event, formData: GridConfig.FormData): Promise<unknown>;
   }
 
   namespace GridConfig {

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

@@ -1,15 +1,32 @@
+interface ImagePopoutOptions extends FormApplicationOptions {
+  /**
+   * Can this image be shared with connected users?
+   * @defaultValue `false`
+   */
+  shareable: boolean;
+
+  /**
+   * The UUID of some related {@link Document}.
+   * @defaultValue `null`
+   */
+  uuid: string | null;
+}
+
 /**
  * An Image Popout Application which features a single image in a lightbox style frame.
  * This popout can also be used as a form, allowing the user to edit an image which is being used.
  * Furthermore, this application allows for sharing the display of an image with other connected players.
  *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ *
  * @example
  * ```typescript
  * // Construct the Application instance
  * const ip = new ImagePopout("path/to/image.jpg", {
  *   title: "My Featured Image",
  *   shareable: true,
- *   entity: game.actors.getName("My Hero")
+ *   uuid: game.actors.getName("My Hero").uuid
  * });
  *
  * // Display the image popout
@@ -19,7 +36,10 @@
  * ip.share();
  * ```
  */
-declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopout.Data, string> {
+declare class ImagePopout<
+  Options extends ImagePopoutOptions = ImagePopoutOptions,
+  Data extends object = ImagePopout.Data
+> extends FormApplication<Options, Data, string> {
   constructor(src: string, options?: Partial<ImagePopout.Options>);
 
   /**
@@ -27,14 +47,27 @@ declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopo
    */
   protected _related: foundry.abstract.Document<any, any> | null;
 
-  /** @override */
-  static get defaultOptions(): ImagePopout.Options;
+  /**
+   * @override
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   template: "templates/apps/image-popout.html",
+   *   classes: ["image-popout", "dark"],
+   *   editable: false,
+   *   resizable: true,
+   *   shareable: false,
+   *   uuid: null
+   * })
+   * ```
+   */
+  static get defaultOptions(): ImagePopoutOptions;
 
   /** @override */
   get title(): string;
 
   /** @override */
-  getData(options?: Partial<ImagePopout.Options>): Promise<ImagePopout.Data>;
+  getData(options?: Partial<Options> | undefined): Promise<Data>;
 
   /**
    * Test whether the title of the image popout should be visible to the user
@@ -42,12 +75,12 @@ declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopo
   isTitleVisible(): boolean;
 
   /**
-   * Provide a reference to the Entity referenced by this popout, if one exists
+   * Provide a reference to the Document referenced by this popout, if one exists
    */
   getRelatedObject(): Promise<foundry.abstract.Document<any, any> | null>;
 
   /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<ImagePopout.Options>): Promise<void>;
+  protected _render(force?: boolean, options?: Application.RenderOptions<Options> | undefined): Promise<void>;
 
   /** @override */
   protected _getHeaderButtons(): Application.HeaderButton[];

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

@@ -1,10 +1,9 @@
 import './avConfig';
 import './combatTrackerConfig';
-import './defaultTokenConfig';
 import './documentSheet';
+import './documentSheetConfig';
 import './documentSheets';
 import './drawingConfig';
-import './entitySheetConfig';
 import './gridConfig';
 import './imagePopout';
 import './keybindingsConfig';
@@ -12,5 +11,6 @@ import './moduleManagement';
 import './permissionConfig';
 import './settingsConfig';
 import './tokenConfig';
+import './tokenConfigs';
 import './wallConfig';
 import './worldConfig';

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';