@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

package/src/foundry/client/apps/forms/cards-config.d.mts

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName } from "../../../../types/helperTypes.d.mts";
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
+import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
   /**
@@ -9,9 +9,9 @@ declare global {
    */
   class CardsConfig<Options extends CardsConfig.Options = CardsConfig.Options> extends DocumentSheet<
     Options,
-    Cards.ConfiguredInstance
+    Cards.Implementation
   > {
-    constructor(object: ConfiguredDocumentClassForName<"Cards">, options: Options);
+    constructor(object: Document.ImplementationClassFor<"Cards">, options?: Options);
 
     /**
      * The allowed sorting methods which can be used for this sheet
@@ -53,7 +53,7 @@ declare global {
 
     /**
      * Handle lazy-loading card face images.
-     * See {@link SidebarTab#_onLazyLoadImage}
+     * See {@link SidebarTab._onLazyLoadImage | `SidebarTab#_onLazyLoadImage`}
      * @param entries  - The entries which are now in the observer frame
      * @param observer - The intersection observer instance
      */
@@ -65,6 +65,7 @@ declare global {
 
     protected override _canDragDrop(selector: string): boolean;
 
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     protected override _onDrop(event: DragEvent): Promise<void>;
 
     /**
@@ -75,12 +76,12 @@ declare global {
      */
     protected _onSortCard(
       event: DragEvent,
-      card: Card.ConfiguredInstance,
-    ): ReturnType<Cards.ConfiguredInstance["updateEmbeddedDocuments"]>;
+      card: Card.Implementation,
+    ): ReturnType<Cards.Implementation["updateEmbeddedDocuments"]>;
   }
 
   namespace CardsConfig {
-    type Any = CardsConfig<any>;
+    interface Any extends CardsConfig<any> {}
   }
 
   /**
@@ -101,7 +102,7 @@ declare global {
   }
 
   namespace CardsHand {
-    type Any = CardsHand<any>;
+    interface Any extends CardsHand<any> {}
   }
 
   /**
@@ -122,18 +123,18 @@ declare global {
   }
 
   namespace CardsPile {
-    type Any = CardsPile<any>;
+    interface Any extends CardsPile<any> {}
   }
 
   namespace CardsConfig {
-    interface Options extends DocumentSheetOptions<Cards> {
+    interface Options extends DocumentSheet.Options<Cards.Implementation> {
       sort: string;
     }
 
     interface CardsConfigData<Options extends CardsConfig.Options = CardsConfig.Options>
-      extends DocumentSheet.DocumentSheetData<Options, Cards.ConfiguredInstance> {
-      cards: Card.ConfiguredInstance[];
-      //TODO: Find if we can better type this
+      extends DocumentSheet.DocumentSheetData<Options, Cards.Implementation> {
+      cards: Card.Implementation[];
+      // TODO: Find if we can better type this
       types: Record<string, string>;
       inCompendium: boolean;
     }

package/src/foundry/client/apps/forms/combat-config.d.mts

@@ -1,13 +1,13 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 
 declare global {
   /**
    * The Application responsible for configuring the CombatTracker and its contents.
    * @typeParam Options - The type of the options object
    */
-  class CombatTrackerConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
+  class CombatTrackerConfig<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
     Options,
-    undefined
+    FormApplication.NoObject
   > {
     /**
      * @defaultValue
@@ -21,7 +21,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplication.Options;
 
     override getData(
       options?: Partial<Options>,
@@ -38,14 +38,14 @@ declare global {
   }
 
   namespace CombatTrackerConfig {
-    type Any = CombatTrackerConfig<any>;
+    interface Any extends CombatTrackerConfig<any> {}
 
     interface CombatTrackerConfigData extends FormApplication.FormApplicationData {
       settings: SettingConfig["core.combatTrackerConfig"];
-      attributeChoices: ReturnType<(typeof TokenDocument)["getTrackedAttributeChoices"]>;
+      attributeChoices: ReturnType<typeof TokenDocument.getTrackedAttributeChoices>;
       combatTheme: ClientSettings.SettingConfig<string>;
       selectedTheme: SettingConfig["core.combatTheme"];
-      user: User;
+      user: User.Implementation;
     }
   }
 }

package/src/foundry/client/apps/forms/combatant-config.d.mts

@@ -8,7 +8,7 @@ declare global {
    */
   class CombatantConfig<Options extends CombatantConfig.Options = CombatantConfig.Options> extends DocumentSheet<
     Options,
-    Combatant.ConfiguredInstance
+    Combatant.Implementation
   > {
     /**
      * @defaultValue
@@ -30,9 +30,9 @@ declare global {
   }
 
   namespace CombatantConfig {
-    type Any = CombatantConfig<any>;
+    interface Any extends CombatantConfig<any> {}
 
-    interface Options extends DocumentSheetOptions<Combatant> {
+    interface Options extends DocumentSheet.Options<Combatant.Implementation> {
       id: "combatant-config";
       title: string;
       classes: string[];

package/src/foundry/client/apps/forms/default-sheets-config.d.mts

@@ -25,7 +25,7 @@ declare global {
   }
 
   namespace DefaultSheetsConfig {
-    type Any = DefaultSheetsConfig<any>;
+    interface Any extends DefaultSheetsConfig<any> {}
 
     interface Options extends PackageConfiguration.Options {}
 

package/src/foundry/client/apps/forms/effect-config.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise, SimpleMerge, ValueOf } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, SimpleMerge, ValueOf } from "#utils";
 
 declare global {
   /**
@@ -8,8 +8,8 @@ declare global {
    */
   class ActiveEffectConfig<
     Options extends
-      DocumentSheetOptions<ActiveEffect.ConfiguredInstance> = DocumentSheetOptions<ActiveEffect.ConfiguredInstance>,
-  > extends DocumentSheet<Options, ActiveEffect.ConfiguredInstance> {
+      DocumentSheet.Options<ActiveEffect.Implementation> = DocumentSheet.Options<ActiveEffect.Implementation>,
+  > extends DocumentSheet<Options, ActiveEffect.Implementation> {
     /**
      * @defaultValue
      * ```typescript
@@ -22,7 +22,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): DocumentSheetOptions<ActiveEffect.ConfiguredInstance>;
+    static override get defaultOptions(): DocumentSheet.Options<ActiveEffect.Implementation>;
 
     override getData(
       options?: Partial<Options>,
@@ -50,13 +50,13 @@ declare global {
   }
 
   namespace ActiveEffectConfig {
-    type Any = ActiveEffectConfig<any>;
+    interface Any extends ActiveEffectConfig<any> {}
 
     type ActiveEffectConfigData<
       Options extends
-        DocumentSheetOptions<ActiveEffect.ConfiguredInstance> = DocumentSheetOptions<ActiveEffect.ConfiguredInstance>,
+        DocumentSheet.Options<ActiveEffect.Implementation> = DocumentSheet.Options<ActiveEffect.Implementation>,
     > = SimpleMerge<
-      DocumentSheet.DocumentSheetData<Options, ActiveEffect.ConfiguredInstance>,
+      DocumentSheet.DocumentSheetData<Options, ActiveEffect.Implementation>,
       {
         labels: {
           transfer: {

package/src/foundry/client/apps/forms/folder-config.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise, ValueOf } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, ValueOf } from "#utils";
 
 declare global {
   /**
@@ -8,7 +8,7 @@ declare global {
    */
   class FolderConfig<Options extends FolderConfig.Options = FolderConfig.Options> extends DocumentSheet<
     Options,
-    Folder.ConfiguredInstance
+    Folder.Implementation
   > {
     /**
      * @defaultValue
@@ -34,10 +34,15 @@ declare global {
   }
 
   namespace FolderConfig {
-    type Any = FolderConfig<any>;
+    interface Any extends FolderConfig<any> {}
 
-    interface Options extends DocumentSheetOptions<Folder.ConfiguredInstance> {
-      resolve?: (doc: Folder.ConfiguredInstance) => void;
+    interface Options extends DocumentSheet.Options<Folder.Implementation> {
+      /**
+       * @remarks Gets called with either the created Folder in `#_updateObject` or `null` in `#close`
+       *
+       * Foundry passes this inside {@link Folder.createDialog | `Folder.createDialog`}
+       */
+      resolve?: (doc: Folder.Implementation | null) => void;
     }
 
     interface FormData {

package/src/foundry/client/apps/forms/fonts.d.mts

@@ -1,11 +1,11 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 
 declare global {
   class FontConfig<Options extends FontConfig.Options = FontConfig.Options> extends FormApplication<
     Options,
-    NewFontDefinition
+    FontConfig.NewFontDefinition
   > {
-    constructor(object?: NewFontDefinition, options?: Options);
+    constructor(object?: FontConfig.NewFontDefinition, options?: Options);
 
     /**
      * @defaultValue
@@ -29,7 +29,7 @@ declare global {
      */
     static FONT_TYPES: { FILE: "file"; SYSTEM: "system" };
 
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<FontConfig.FontConfigData>>;
+    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<FontConfig.Data>>;
 
     /**
      * Template data for a given font definition.
@@ -122,47 +122,54 @@ declare global {
     protected static _formatFont(family: string, definition: CONFIG.Font.Definition): string;
   }
 
-  interface NewFontDefinition {
-    /**
-     * The font family.
-     */
-    family?: string;
-
-    /**
-     * The font weight.
-     * @defaultValue `400`
-     */
-    weight?: number;
+  type NewFontDefinition = FontConfig.NewFontDefinition;
 
-    /**
-     * The font style.
-     * @defaultValue `"normal"`
-     */
-    style?: string;
+  namespace FontConfig {
+    interface Any extends FontConfig<any> {}
 
-    /**
-     * The font file
-     * @defaultValue `""`
-     */
-    src?: string;
+    interface Options extends FormApplication.Options {}
 
     /**
-     * The text to preview the font.
-     * @defaultValue `game.i18n.localize("FONTS.FontPreview")`
+     * @deprecated {@link FontConfig.Data | `FontConfig.Data`}
      */
-    preview?: string;
-  }
-
-  namespace FontConfig {
-    type Any = FontConfig<any>;
-
-    interface Options extends FormApplicationOptions {}
+    type FontConfigData = Data;
 
-    interface FontConfigData {
+    interface Data {
       fonts: { family: string; index: number; font: string }[];
       selected: { family: string; index: number } | null;
       family: string | undefined;
       weights: Array<{ value: foundry.CONST.FONT_WEIGHTS; label: string }>;
     }
+
+    interface NewFontDefinition {
+      /**
+       * The font family.
+       */
+      family?: string;
+
+      /**
+       * The font weight.
+       * @defaultValue `400`
+       */
+      weight?: number;
+
+      /**
+       * The font style.
+       * @defaultValue `"normal"`
+       */
+      style?: string;
+
+      /**
+       * The font file
+       * @defaultValue `""`
+       */
+      src?: string;
+
+      /**
+       * The text to preview the font.
+       * @defaultValue `game.i18n.localize("FONTS.FontPreview")`
+       */
+      preview?: string;
+    }
   }
 }

package/src/foundry/client/apps/forms/grid-config.d.mts

@@ -1,16 +1,15 @@
-import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { InterfaceToObject, AnyObject, GetDataReturnType, MaybePromise } from "#utils";
 
 declare global {
   /**
    * A tool for fine tuning the grid in a Scene
    * @typeParam Options - the type of the options object
    */
-  class GridConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
+  class GridConfig<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
     Options,
-    Scene.ConfiguredInstance
+    Scene.Implementation
   > {
-    constructor(scene: Scene.ConfiguredInstance, sheet: GridConfig["sheet"], options?: Partial<Options>);
+    constructor(scene: Scene.Implementation, sheet: GridConfig["sheet"], options?: Partial<Options>);
 
     /**
      * Track the Scene Configuration sheet reference
@@ -30,7 +29,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): (typeof FormApplication)["defaultOptions"];
+    static override get defaultOptions(): typeof FormApplication.defaultOptions;
 
     protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
@@ -121,20 +120,20 @@ declare global {
   }
 
   namespace GridConfig {
-    type Any = GridConfig<any>;
+    interface Any extends GridConfig<any> {}
 
     interface FormData {
-      "grid.type": Scene["grid"]["type"];
-      "grid.size": Scene["grid"]["size"];
-      scale: Scene["width"];
-      "background.offsetX": Scene["background"]["offsetX"];
-      "background.offsetY": Scene["background"]["offsetY"];
+      "grid.type": Scene.Implementation["grid"]["type"];
+      "grid.size": Scene.Implementation["grid"]["size"];
+      scale: Scene.Implementation["width"];
+      "background.offsetX": Scene.Implementation["background"]["offsetX"];
+      "background.offsetY": Scene.Implementation["background"]["offsetY"];
     }
 
     interface GridConfigData {
       gridTypes: Record<foundry.CONST.GRID_TYPES, string>;
       scale: number;
-      scene: Scene.ConfiguredInstance;
+      scene: Scene.Implementation;
     }
   }
 }

package/src/foundry/client/apps/forms/image-popout.d.mts

@@ -1,24 +1,8 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
-  interface ImagePopoutOptions extends FormApplicationOptions {
-    /**
-     * Caption text to display below the image.
-     * @defaultValue `false`
-     */
-    caption: boolean;
-
-    /**
-     * The UUID of some related {@link Document}.
-     * @defaultValue `null`
-     */
-    uuid: string | null;
-
-    /**
-     * Force showing or hiding the title.
-     */
-    showTitle: boolean;
-  }
+  /** @deprecated {@link ImagePopout.Options | `ImagePopout.Options`} */
+  type ImagePopoutOptions = ImagePopout.Options;
 
   /**
    * An Image Popout Application which features a single image in a lightbox style frame.
@@ -43,7 +27,10 @@ declare global {
    * ip.share();
    * ```
    */
-  class ImagePopout<Options extends ImagePopoutOptions = ImagePopoutOptions> extends FormApplication<Options, string> {
+  class ImagePopout<Options extends ImagePopout.Options = ImagePopout.Options> extends FormApplication<
+    Options,
+    string
+  > {
     constructor(src: string, options?: Partial<ImagePopout.Options>);
 
     /**
@@ -64,7 +51,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ImagePopoutOptions;
+    static override get defaultOptions(): ImagePopout.Options;
 
     override get title(): string;
 
@@ -125,9 +112,9 @@ declare global {
   }
 
   namespace ImagePopout {
-    type Any = ImagePopout<any>;
+    interface Any extends ImagePopout<any> {}
 
-    interface Options extends FormApplicationOptions {
+    interface Options extends FormApplication.Options {
       /**
        * @defaultValue `"templates/apps/image-popout.html"`
        */
@@ -175,5 +162,24 @@ declare global {
       /** A list of user IDs to show the image to. */
       users?: string[];
     }
+
+    interface Options extends FormApplication.Options {
+      /**
+       * Caption text to display below the image.
+       * @defaultValue `false`
+       */
+      caption: boolean;
+
+      /**
+       * The UUID of some related {@link Document | `Document`}.
+       * @defaultValue `null`
+       */
+      uuid: string | null;
+
+      /**
+       * Force showing or hiding the title.
+       */
+      showTitle: boolean;
+    }
   }
 }

package/src/foundry/client/apps/forms/item.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 
 declare global {
   /**
@@ -9,10 +9,9 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class ItemSheet<Options extends DocumentSheetOptions<Item> = DocumentSheetOptions<Item>> extends DocumentSheet<
-    Options,
-    Item.ConfiguredInstance
-  > {
+  class ItemSheet<
+    Options extends DocumentSheet.Options<Item.Implementation> = DocumentSheet.Options<Item.Implementation>,
+  > extends DocumentSheet<Options, Item.Implementation> {
     /**
      * @defaultValue
      * ```typescript
@@ -29,7 +28,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions<Item>;
+    static get defaultOptions(): DocumentSheet.Options<Item.Implementation>;
 
     override get title(): string;
 
@@ -48,10 +47,11 @@ declare global {
   }
 
   namespace ItemSheet {
-    type Any = ItemSheet<any>;
+    interface Any extends ItemSheet<any> {}
 
-    interface ItemSheetData<Options extends DocumentSheetOptions<Item> = DocumentSheetOptions<Item>>
-      extends DocumentSheet.DocumentSheetData<Options, Item.ConfiguredInstance> {
+    interface ItemSheetData<
+      Options extends DocumentSheet.Options<Item.Implementation> = DocumentSheet.Options<Item.Implementation>,
+    > extends DocumentSheet.DocumentSheetData<Options, Item.Implementation> {
       item: this["document"];
     }
   }

package/src/foundry/client/apps/forms/journal-page-sheet.d.mts

@@ -1,6 +1,6 @@
 import type { Editor } from "tinymce";
 import type { EditorView } from "prosemirror-view";
-import type { GetDataReturnType, InexactPartial, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise } from "#utils";
 import type Showdown from "showdown";
 
 declare global {
@@ -9,7 +9,7 @@ declare global {
    */
   class JournalPageSheet<Options extends JournalPageSheet.Options = JournalPageSheet.Options> extends DocumentSheet<
     Options,
-    JournalEntryPage.ConfiguredInstance
+    JournalEntryPage.Implementation
   > {
     /**
      * @defaultValue
@@ -43,7 +43,10 @@ declare global {
 
     protected override _getSecretContent(secret: HTMLElement): string;
 
-    protected override _updateSecret(secret: HTMLElement, content: string): Promise<void | JournalEntryPage>;
+    protected override _updateSecret(
+      secret: HTMLElement,
+      content: string,
+    ): Promise<void | JournalEntryPage.Implementation>;
 
     override activateEditor(
       name: string,
@@ -64,12 +67,11 @@ declare global {
   }
 
   namespace JournalPageSheet {
-    type Any = JournalPageSheet<any>;
+    interface Any extends JournalPageSheet<any> {}
 
-    interface Options extends DocumentSheetOptions<JournalEntryPage.ConfiguredInstance> {}
+    interface Options extends DocumentSheet.Options<JournalEntryPage.Implementation> {}
 
-    interface JournalPageSheetData
-      extends DocumentSheet.DocumentSheetData<Options, JournalEntryPage.ConfiguredInstance> {
+    interface JournalPageSheetData extends DocumentSheet.DocumentSheetData<Options, JournalEntryPage.Implementation> {
       headingLevels: Record<number, string>;
     }
   }
@@ -188,9 +190,9 @@ declare global {
      * @param components - The time components
      * @returns The timestamp, in second
      */
-    _timeComponentsToTimestamp(components?: InexactPartial<JournalVideoPageSheet.TimeComponents>): number;
+    _timeComponentsToTimestamp(components?: JournalVideoPageSheet.TimeComponents): number;
 
-    _timestampToTimeComponents(timestamp: number): Partial<JournalVideoPageSheet.TimeComponents>;
+    _timestampToTimeComponents(timestamp: number): JournalVideoPageSheet.TimeComponents;
   }
 
   namespace JournalVideoPageSheet {
@@ -205,9 +207,9 @@ declare global {
     }
 
     interface TimeComponents {
-      h: number;
-      m: number;
-      s: number;
+      h?: number | undefined;
+      m?: number | undefined;
+      s?: number | undefined;
     }
   }
 
@@ -249,7 +251,7 @@ declare global {
   }
 
   /**
-   * A subclass of {@link JournalTextPageSheet} that implements a markdown editor for editing the text content.
+   * A subclass of {@link JournalTextPageSheet | `JournalTextPageSheet`} that implements a markdown editor for editing the text content.
    */
   class MarkdownJournalPageSheet extends JournalTextPageSheet {
     /**
@@ -292,7 +294,7 @@ declare global {
   }
 
   /**
-   * A subclass of {@link JournalTextPageSheet} that implements a TinyMCE editor.
+   * A subclass of {@link JournalTextPageSheet | `JournalTextPageSheet`} that implements a TinyMCE editor.
    */
   class JournalTextTinyMCESheet extends JournalTextPageSheet {
     override getData(