@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/apps/hud/players.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
+import type { GetDataReturnType, MaybePromise, Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -6,7 +6,7 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class PlayerList<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class PlayerList<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -25,7 +25,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static get defaultOptions(): Application.Options;
 
     /**
      * Whether the players list is in a configuration where it is hidden
@@ -39,7 +39,7 @@ declare global {
     /**
      * Prepare a displayed name string for the User which includes their name, pronouns, character, or GM tag.
      */
-    protected _getDisplayName(user: User): string;
+    protected _getDisplayName(user: User.Implementation): string;
 
     /**
      * Position this Application in the main DOM appropriately.
@@ -61,13 +61,13 @@ declare global {
   }
 
   namespace PlayerList {
-    type Any = AnyPlayerList;
-    type AnyConstructor = typeof AnyPlayerList;
+    interface Any extends AnyPlayerList {}
+    interface AnyConstructor extends Identity<typeof AnyPlayerList> {}
 
     interface UserData {
-      active: User["active"];
-      isGM: User["isGM"];
-      isSelf: User["isSelf"];
+      active: User.Implementation["active"];
+      isGM: User.Implementation["isGM"];
+      isSelf: User.Implementation["isSelf"];
       charname: string;
       color: string;
       border: string;
@@ -82,6 +82,6 @@ declare global {
   }
 }
 
-declare abstract class AnyPlayerList extends PlayerList<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
+declare abstract class AnyPlayerList extends PlayerList<Application.Options> {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/i18n.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "fvtt-types/utils";
+export {};
 
 declare global {
   /**
@@ -86,18 +86,7 @@ declare global {
      */
     static localizeDataModel(
       model: foundry.abstract.DataModel.AnyConstructor,
-      options?: InexactPartial<{
-        /**
-         * An array of localization key prefixes to use. If not specified, prefixes
-         * are learned from the DataModel.LOCALIZATION_PREFIXES static property.
-         */
-        prefixes: string[];
-
-        /**
-         * A localization path prefix used to prefix all field names within this model. This is generally not required.
-         */
-        prefixPath: string;
-      }>,
+      options?: Localization.LocalizeDataModelOptions,
     ): void;
 
     /**
@@ -190,26 +179,16 @@ declare global {
 
     /**
      * Retreive list formatter configured to the world's language setting.
-     * @see [Intl.ListFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat)
-     */
-    getListFormatter(
-      options?: InexactPartial<{
-        /**
-         * The list formatter style, either "long", "short", or "narrow".
-         */
-        style: Intl.ListFormatStyle;
-        /**
-         * The list formatter type, either "conjunction", "disjunction", or "unit".
-         */
-        type: Intl.ListFormatType;
-      }>,
-    ): Intl.ListFormat;
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat | Intl.ListFormat}
+     */
+    getListFormatter(options?: Localization.GetListFormatterOptions): Intl.ListFormat;
 
     /**
      * Sort an array of objects by a given key in a localization-aware manner.
      * @param objects - The objects to sort, this array will be mutated
      * @param key     - The key to sort the objects by. This can be provided in dot-notation.
      */
+    // TODO(LukeAbby): Should be constrainted to dot property keys of `objects`
     sortObjects<T extends object>(objects: Array<T>, key: string): T[];
   }
 
@@ -217,5 +196,30 @@ declare global {
     interface Translations {
       [K: string]: string | Translations;
     }
+
+    interface LocalizeDataModelOptions {
+      /**
+       * An array of localization key prefixes to use. If not specified, prefixes
+       * are learned from the DataModel.LOCALIZATION_PREFIXES static property.
+       */
+      prefixes?: string[] | undefined;
+
+      /**
+       * A localization path prefix used to prefix all field names within this model. This is generally not required.
+       */
+      prefixPath?: string | undefined;
+    }
+
+    interface GetListFormatterOptions {
+      /**
+       * The list formatter style, either "long", "short", or "narrow".
+       */
+      style?: Intl.ListFormatStyle | undefined;
+
+      /**
+       * The list formatter type, either "conjunction", "disjunction", or "unit".
+       */
+      type?: Intl.ListFormatType | undefined;
+    }
   }
 }

package/src/foundry/client/apps/placeables/drawing-config.d.mts

@@ -1,21 +1,16 @@
 import type { MaybePromise } from "fvtt-types/utils";
 
 declare global {
-  interface DrawingConfigOptions extends FormApplicationOptions {
-    /**
-     * Configure the default drawing settings, instead of a specific Drawing
-     * @defaultValue `false`
-     */
-    configureDefault: boolean;
-  }
+  /** @deprecated {@link DrawingConfig.Options | `DrawingConfig.Options`} */
+  type DrawingConfigOptions = DrawingConfig.Options;
 
   /**
    * The Application responsible for configuring a single Drawing document within a parent Scene.
    * @typeParam Options - the type of the options object
    */
-  class DrawingConfig<Options extends DrawingConfigOptions = DrawingConfigOptions> extends FormApplication<
-    Options,
-    DrawingDocument.ConfiguredInstance
+  class DrawingConfig<Options extends DrawingConfig.Options = DrawingConfig.Options> extends FormApplication<
+    DrawingDocument.Implementation,
+    Options
   > {
     /**
      * @defaultValue
@@ -30,7 +25,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): DrawingConfigOptions;
+    static override get defaultOptions(): DrawingConfig.Options;
 
     override get title(): string;
 
@@ -52,29 +47,42 @@ declare global {
   }
 
   namespace DrawingConfig {
-    type Any = DrawingConfig<any>;
+    interface Any extends DrawingConfig<any> {}
+
+    interface Options extends FormApplication.Options {
+      /**
+       * Configure the default drawing settings, instead of a specific Drawing
+       * @defaultValue `false`
+       */
+      configureDefault: boolean;
+    }
 
-    interface FormData {
-      author: string;
-      bezierFactor: DrawingDocument["bezierFactor"];
-      fillAlpha: DrawingDocument["fillAlpha"];
-      fillColor: DrawingDocument["fillColor"];
-      fillType: DrawingDocument["fillType"];
-      fontFamily: DrawingDocument["fontFamily"];
-      fontSize: DrawingDocument["fontSize"];
-      "shape.height": DrawingDocument["shape"]["height"];
-      rotation: DrawingDocument["rotation"];
-      strokeAlpha: DrawingDocument["strokeAlpha"];
-      strokeColor: DrawingDocument["strokeColor"];
-      strokeWidth: DrawingDocument["strokeWidth"];
-      text: DrawingDocument["text"];
-      textAlpha: DrawingDocument["textAlpha"];
-      textColor: DrawingDocument["textColor"];
-      texture: DrawingDocument["texture"];
-      "shape.width": DrawingDocument["shape"]["width"];
-      x: DrawingDocument["x"];
-      y: DrawingDocument["y"];
-      z: DrawingDocument["z"];
+    /** @internal */
+    type _FormData = Pick<
+      DrawingDocument.Implementation,
+      | "author"
+      | "bezierFactor"
+      | "elevation"
+      | "fillAlpha"
+      | "fillColor"
+      | "fillType"
+      | "fontFamily"
+      | "fontSize"
+      | "rotation"
+      | "sort"
+      | "strokeAlpha"
+      | "strokeColor"
+      | "strokeWidth"
+      | "text"
+      | "textAlpha"
+      | "textColor"
+      | "texture"
+      | "x"
+      | "y"
+    >;
+    interface FormData extends _FormData {
+      "shape.height": DrawingDocument.Implementation["shape"]["height"];
+      "shape.width": DrawingDocument.Implementation["shape"]["width"];
     }
   }
 }

package/src/foundry/client/apps/placeables/drawing-hud.d.mts

@@ -5,8 +5,8 @@ declare global {
    * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Drawing objects.
    * @typeParam Options - the type of the options object
    */
-  class DrawingHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    Drawing.ConfiguredInstance,
+  class DrawingHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+    Drawing.Implementation,
     Options
   > {
     /**
@@ -18,7 +18,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: Implement GetDataReturnType
 
@@ -26,6 +26,6 @@ declare global {
   }
 
   namespace DrawingHUD {
-    type Any = DrawingHUD<any>;
+    interface Any extends DrawingHUD<any> {}
   }
 }

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

@@ -1,8 +1,6 @@
 import "./drawing-config.d.mts";
 import "./drawing-hud.d.mts";
-import "./light-config.d.mts";
 import "./note-config.d.mts";
-import "./sound-config.d.mts";
 import "./tile-config.d.mts";
 import "./tile-hud.d.mts";
 import "./token-config.d.mts";

package/src/foundry/client/apps/placeables/note-config.d.mts

@@ -7,8 +7,8 @@ declare global {
    */
   class NoteConfig<
     Options extends
-      DocumentSheetOptions<NoteDocument.ConfiguredInstance> = DocumentSheetOptions<NoteDocument.ConfiguredInstance>,
-  > extends DocumentSheet<Options, NoteDocument.ConfiguredInstance> {
+      DocumentSheet.Options<NoteDocument.Implementation> = DocumentSheet.Options<NoteDocument.Implementation>,
+  > extends DocumentSheet<NoteDocument.Implementation, Options> {
     /**
      * @defaultValue
      * ```typescript
@@ -19,7 +19,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): DocumentSheetOptions<NoteDocument.ConfiguredInstance>;
+    static override get defaultOptions(): DocumentSheet.Options<NoteDocument.Implementation>;
 
     override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: Implement GetDataReturnType
 
@@ -45,21 +45,31 @@ declare global {
   }
 
   namespace NoteConfig {
-    type Any = NoteConfig<any>;
+    interface Any extends NoteConfig<any> {}
 
-    interface FormData {
-      entryId: NoteDocument["entryId"];
-      fontFamily: NoteDocument["fontFamily"];
-      fontSize: NoteDocument["fontSize"];
-      "icon.selected": NoteDocument["texture"]["src"];
-      "icon.custom": NoteDocument["texture"]["src"];
-      iconSize: NoteDocument["iconSize"];
-      iconTint: NoteDocument["texture"]["tint"];
-      text: NoteDocument["text"];
-      textAnchor: NoteDocument["textAnchor"];
-      textColor: NoteDocument["textColor"];
-      x: NoteDocument["x"];
-      y: NoteDocument["y"];
+    /** @internal */
+    type _FormData = Pick<
+      NoteDocument.Implementation,
+      | "elevation"
+      | "entryId"
+      | "fontFamily"
+      | "fontSize"
+      | "global"
+      | "iconSize"
+      | "pageId"
+      | "sort"
+      | "text"
+      | "textAnchor"
+      | "textColor"
+      | "x"
+      | "y"
+    >;
+
+    interface FormData extends _FormData {
+      "icon.selected": NoteDocument.Implementation["texture"]["src"];
+
+      /** @remarks Only appears in the form data if `icon.selected` is set to "Custom" (`""` value) */
+      "icon.custom"?: NoteDocument.Implementation["texture"]["src"];
     }
   }
 }

package/src/foundry/client/apps/placeables/tile-config.d.mts

@@ -6,8 +6,8 @@ declare global {
    * @typeParam Options - the type of the options object
    */
   class TileConfig<Options extends TileConfig.Options = TileConfig.Options> extends DocumentSheet<
-    Options,
-    TileDocument.ConfiguredInstance
+    TileDocument.Implementation,
+    Options
   > {
     /**
      * @defaultValue
@@ -35,16 +35,29 @@ declare global {
   }
 
   namespace TileConfig {
-    type Any = TileConfig<any>;
+    interface Any extends TileConfig<any> {}
 
-    type FormData = Pick<TileDocument, "alpha" | "height" | "rotation" | "width" | "x" | "y" | "overhead" | "roof"> & {
-      "texture.src": string | null;
-      "texture.scaleX": number | null;
-      "texture.scaleY": number | null;
-      "texture.tint": string;
-    };
+    /** @internal */
+    type _FormData = Pick<
+      TileDocument.Implementation,
+      "alpha" | "elevation" | "height" | "rotation" | "sort" | "width" | "x" | "y"
+    >;
 
-    interface Options extends DocumentSheetOptions<TileDocument.ConfiguredInstance> {
+    interface FormData extends _FormData {
+      "occlusion.alpha": TileDocument.Implementation["occlusion"]["alpha"];
+      "occlusion.mode": TileDocument.Implementation["occlusion"]["mode"];
+      "restrictions.light": TileDocument.Implementation["restrictions"]["light"];
+      "restrictions.weather": TileDocument.Implementation["restrictions"]["weather"];
+      "texture.src": TileDocument.Implementation["texture"]["src"];
+      "texture.scaleX": TileDocument.Implementation["texture"]["scaleX"];
+      "texture.scaleY": TileDocument.Implementation["texture"]["scaleY"];
+      "texture.tint": TileDocument.Implementation["texture"]["tint"];
+      "video.autoplay": TileDocument.Implementation["video"]["autoplay"];
+      "video.loop": TileDocument.Implementation["video"]["loop"];
+      "video.volume": TileDocument.Implementation["video"]["volume"];
+    }
+
+    interface Options extends DocumentSheet.Options<TileDocument.Implementation> {
       /**
        * Configure a preview version of a tile which is not yet saved
        */

package/src/foundry/client/apps/placeables/tile-hud.d.mts

@@ -1,12 +1,12 @@
-import type { MaybePromise } from "fvtt-types/utils";
+import type { MaybePromise, Identity } from "fvtt-types/utils";
 
 declare global {
   /**
    * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects.
    * @typeParam Options - the type of the options object
    */
-  class TileHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    Tile.ConfiguredInstance,
+  class TileHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+    Tile.Implementation,
     Options
   > {
     /**
@@ -18,7 +18,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: Implement GetDataReturnType
 
@@ -32,11 +32,11 @@ declare global {
   }
 
   namespace TileHUD {
-    type Any = AnyTileHUD;
-    type AnyConstructor = typeof AnyTileHUD;
+    interface Any extends AnyTileHUD {}
+    interface AnyConstructor extends Identity<typeof AnyTileHUD> {}
   }
 }
 
-declare abstract class AnyTileHUD extends TileHUD<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
+declare abstract class AnyTileHUD extends TileHUD<Application.Options> {
+  constructor(...args: never);
 }