@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250719181625 → 13.346.0-beta.20250720141111

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "13.346.0-beta.20250719181625",
+  "version": "13.346.0-beta.20250720141111",
   "description": "TypeScript type definitions for Foundry VTT",
   "type": "module",
   "types": "./src/index.d.mts",
@@ -18,10 +18,10 @@
     "./configuration": {
       "types": "./src/configuration/index.d.mts"
     },
-    "./worker": {
+    "./workers": {
       "types": "./src/foundry/public/scripts/workers/index.d.mts"
     },
-    "./worker/image-compressor": {
+    "./workers/image-compressor": {
       "types": "./src/foundry/public/scripts/workers/image-compressor.d.mts"
     }
   },

package/src/foundry/client/applications/ui/game-pause.d.mts

@@ -11,15 +11,28 @@ declare module "#configuration" {
 
 /**
  * The Game Paused banner.
- * @remarks TODO: Stub
  */
 declare class GamePause<
   RenderContext extends GamePause.RenderContext = GamePause.RenderContext,
   Configuration extends GamePause.Configuration = GamePause.Configuration,
   RenderOptions extends GamePause.RenderOptions = GamePause.RenderOptions,
 > extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
-  // Fake override.
   static override DEFAULT_OPTIONS: GamePause.DefaultOptions;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  protected override _renderHTML(
+    _context: RenderContext,
+    _options: DeepPartial<RenderOptions>,
+  ): Promise<GamePause.RenderHTMLReturn>;
+
+  protected override _replaceHTML(
+    result: GamePause.RenderHTMLReturn,
+    content: HTMLElement,
+    _options: DeepPartial<RenderOptions>,
+  ): void;
 }
 
 declare namespace GamePause {
@@ -37,6 +50,8 @@ declare namespace GamePause {
     spin: boolean;
   }
 
+  type RenderHTMLReturn = [HTMLImageElement, HTMLElement];
+
   interface Configuration<GamePause extends GamePause.Any = GamePause.Any>
     extends ApplicationV2.Configuration<GamePause> {}
 

package/src/foundry/client/applications/ui/hotbar.d.mts

@@ -1,6 +1,7 @@
 import type { DeepPartial, Identity } from "#utils";
 import type ApplicationV2 from "../api/application.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type Document from "#common/abstract/document.d.mts";
 
 declare module "#configuration" {
   namespace Hooks {
@@ -16,15 +17,102 @@ declare module "#configuration" {
  * Left-clicking a Macro button triggers its effect.
  * Right-clicking the button displays a context menu of Macro options.
  * The number keys 1 through 0 activate numbered hotbar slots.
- * @remarks TODO: Stub
  */
 declare class Hotbar<
   RenderContext extends object = Hotbar.RenderContext,
   Configuration extends Hotbar.Configuration = Hotbar.Configuration,
   RenderOptions extends Hotbar.RenderOptions = Hotbar.RenderOptions,
 > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  // Fake override.
   static override DEFAULT_OPTIONS: Hotbar.DefaultOptions;
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  /**
+   * The current hotbar page number.
+   */
+  get page(): number;
+
+  /**
+   * The currently rendered macro data.
+   */
+  get slots(): Hotbar.SlotData[];
+
+  /**
+   * Whether the hotbar is locked.
+   */
+  get locked(): boolean;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
+
+  /**
+   * Get the set of ContextMenu options which should be applied for Macros in the hotbar.
+   */
+  protected _getContextMenuOptions(): foundry.applications.ux.ContextMenu.Entry<HTMLElement>[];
+
+  /**
+   * Change to a specific numbered page from 1 to 5
+   * @param page - The page number to change to
+   */
+  changePage(page: number): Promise<void>;
+
+  /**
+   * Change the page of the hotbar by cycling up (positive) or down (negative).
+   * @param direction - The direction to cycle
+   */
+  cyclePage(direction: number): Promise<void>;
+
+  /**
+   * A reusable helper that can be used for toggling display of a document sheet.
+   * @param uuid - The Document UUID to display
+   */
+  static toggleDocumentSheet(uuid: string): Promise<void>;
+
+  /**
+   * Update hotbar display based on viewport size.
+   * @internal
+   */
+  protected _onResize(): void;
+
+  /**
+   * Create a Macro which rolls a RollTable when executed
+   * @param table - The RollTable document
+   */
+  protected _createRollTableRollMacro(table: Document.Any): Promise<Macro.Implementation>;
+
+  /**
+   * Create a Macro document which can be used to toggle display of a Journal Entry.
+   * @param doc - A Document which should be toggled
+   */
+  protected _createDocumentSheetToggle(doc: Document.Any): Promise<Macro.Implementation>;
+
+  /**
+   * @deprecated "{@linkcode Hotbar#macros} is deprecated in favor of {@linkcode Hotbar#slots}." (since v13, until v15)
+   * @ignore
+   */
+  get macros(): Hotbar.SlotData[];
+
+  /**
+   * @deprecated "{@linkcode Hotbar#collapse} is no longer a supported feature." (since v13, until v15)
+   * @ignore
+   */
+  collapse(): void;
+
+  /**
+   * @deprecated "{@linkcode Hotbar#expand} is no longer a supported feature." (since v13, until v15)
+   * @ignore
+   */
+  expand(): void;
+
+  static #HotbarStatic: true;
+  #Hotbar: true;
 }
 
 declare namespace Hotbar {
@@ -33,6 +121,12 @@ declare namespace Hotbar {
 
   interface SlotData {
     slot: number;
+    macro: Macro.Implementation | null;
+    key: number;
+    img: Macro.Implementation["img"] | null;
+    cssClass: "full" | "open";
+    tooltip: string | null;
+    ariaLabel: string;
   }
 
   /**

package/src/foundry/client/applications/ui/main-menu.d.mts

@@ -12,15 +12,42 @@ declare module "#configuration" {
 
 /**
  * The main menu application which is toggled via the ESC key.
- * @remarks TODO: Stub
  */
 declare class MainMenu<
   RenderContext extends object = MainMenu.RenderContext,
   Configuration extends MainMenu.Configuration = MainMenu.Configuration,
   RenderOptions extends MainMenu.RenderOptions = MainMenu.RenderOptions,
 > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  // Fake override.
   static override DEFAULT_OPTIONS: MainMenu.DefaultOptions;
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  /**
+   * Configuration of Main Menu items.
+   */
+  static ITEMS: Record<string, MainMenu.MainMenuItem>;
+
+  /**
+   * A record of menu items which are currently enabled.
+   */
+  get items(): Record<string, MainMenu.MainMenuItem>;
+
+  protected override _insertElement(element: HTMLElement): void;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  /**
+   * Toggle display of the menu, or render it in the first place.
+   */
+  toggle(): Promise<void>;
+
+  static #MainMenuStatic: true;
 }
 
 declare namespace MainMenu {

package/src/foundry/client/applications/ui/players.d.mts

@@ -13,15 +13,82 @@ declare module "#configuration" {
 /**
  * A UI element which displays the Users defined for this world.
  * Currently active users are always displayed, while inactive users can be displayed on toggle.
- * @remarks TODO: Stub
  */
 declare class Players<
   RenderContext extends Players.RenderContext = Players.RenderContext,
   Configuration extends Players.Configuration = Players.Configuration,
   RenderOptions extends Players.RenderOptions = Players.RenderOptions,
 > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  // Fake override.
   static override DEFAULT_OPTIONS: Players.DefaultOptions;
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  /**
+   * How often latency is refreshed.
+   * @defaultValue `60 * 1000`
+   */
+  static REFRESH_LATENCY_FREQUENCY_MS: number;
+
+  /**
+   * A threshold of time in milliseconds after which a player is considered idle if they have no observed activity.
+   * @defaultValue `5 * 60 * 1000`
+   */
+  static IDLE_THRESHOLD_MS: number;
+
+  /**
+   * Is the application currently expanded?
+   */
+  get expanded(): boolean;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  /**
+   * Format the display of a user's name using their name, pronouns (if defined), and character name (if defined).
+   */
+  protected _formatName(user: User.Implementation): string;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
+
+  /**
+   * Collapse the players list.
+   */
+  collapse(): void;
+
+  /**
+   * Expand the players list.
+   */
+  expand(): void;
+
+  /**
+   * Update the display which reports average latency.
+   */
+  refreshLatency(): void;
+
+  /**
+   * Update the display which reports average framerate.
+   * @param options - Options which customize FPS reporting (default: `{}`)
+   */
+  refreshFPS({ deactivate }?: Players.RefreshFPSOptions): void;
+
+  /**
+   * Toggle the expanded state of scene navigation.
+   * @param expanded - Force the expanded state to the provided value, otherwise toggle the state.
+   */
+  toggleExpanded(expanded?: boolean): void;
+
+  /**
+   * Get the set of ContextMenu options which should be applied to each User in the Players UI.
+   */
+  protected _getContextMenuOptions(): foundry.applications.ux.ContextMenu.Entry<HTMLElement>[];
+
+  static #PlayersStatic: true;
+  #Players: true;
 }
 
 declare namespace Players {
@@ -48,6 +115,14 @@ declare namespace Players {
     border: string;
   }
 
+  interface RefreshFPSOptions {
+    /**
+     * Deactivate tracking
+     * @defaultValue `false`
+     */
+    deactivate?: boolean | undefined;
+  }
+
   interface Configuration<Players extends Players.Any = Players.Any>
     extends HandlebarsApplicationMixin.Configuration,
       ApplicationV2.Configuration<Players> {}

package/src/foundry/client/applications/ui/region-legend.d.mts

@@ -19,6 +19,7 @@ declare class RegionLegend<
   RenderOptions extends RegionLegend.RenderOptions = RegionLegend.RenderOptions,
 > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
   #RegionLegend: true;
+  static #RegionLegendStatic: true;
 
   static override DEFAULT_OPTIONS: RegionLegend.DefaultOptions;
   static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;

package/src/foundry/client/applications/ui/scene-navigation.d.mts

@@ -59,7 +59,7 @@ declare class SceneNavigation<
   toggleExpanded(expanded?: boolean): void;
 
   /**
-   * @deprecated "SceneNavigation.displayProgressBar is deprecated in favor of {@linkcode Notifications#notify} using the \{progress: true\} option" (since v13, until v15)
+   * @deprecated "{@linkcode SceneNavigation.displayProgressBar} is deprecated in favor of {@linkcode Notifications#notify} using the `{progress: true}` option" (since v13, until v15)
    * @ignore
    */
   static displayProgressBar({ label, pct }?: SceneNavigation.DisplayProgressBarOptions): void;

package/src/foundry/client/documents/active-effect.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredActiveEffect } from "fvtt-types/configuration";
+import type { ConfiguredActiveEffect } from "#configuration";
 import type {
   AnyMutableObject,
   Identity,

package/src/foundry/client/documents/actor-delta.d.mts

@@ -1,7 +1,7 @@
 import type { DataSchema } from "#common/data/fields.d.mts";
 import type { BaseActorDelta } from "#common/documents/_module.d.mts";
 import type Document from "#common/abstract/document.d.mts";
-import type { ConfiguredActorDelta } from "fvtt-types/configuration";
+import type { ConfiguredActorDelta } from "#configuration";
 import type { Identity, InexactPartial, Merge, NullishProps } from "#utils";
 import type DataModel from "#common/abstract/data.d.mts";
 

package/src/foundry/client/documents/actor.d.mts

@@ -2,7 +2,7 @@ import type { AnyObject, InexactPartial, NullishProps, Merge, Identity } from "#
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";
 import type BaseActor from "#common/documents/actor.d.mts";
-import type { ConfiguredActor } from "fvtt-types/configuration";
+import type { ConfiguredActor } from "#configuration";
 import type { DataSchema } from "#common/data/fields.d.mts";
 import type { PrototypeToken } from "#common/data/data.mjs";
 import type { Token } from "#client/canvas/placeables/_module.d.mts";

package/src/foundry/client/documents/card.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredCard } from "fvtt-types/configuration";
+import type { ConfiguredCard } from "#configuration";
 import type { AnyObject, DeepPartial, Identity, InexactPartial, Merge } from "#utils";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";

package/src/foundry/client/documents/cards.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredCards } from "fvtt-types/configuration";
+import type { ConfiguredCards } from "#configuration";
 import type { Identity, InexactPartial, Merge, NullishProps } from "#utils";
 import type Document from "#common/abstract/document.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/chat-message.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredChatMessage } from "fvtt-types/configuration";
+import type { ConfiguredChatMessage } from "#configuration";
 import type { AnyObject, Identity, InexactPartial, InterfaceToObject, Merge, NullishProps } from "#utils";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";

package/src/foundry/client/documents/combat.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredCombat } from "fvtt-types/configuration";
+import type { ConfiguredCombat } from "#configuration";
 import type { Identity, InexactPartial, Merge, NullishProps } from "#utils";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";

package/src/foundry/client/documents/combatant-group.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredCombatantGroup } from "fvtt-types/configuration";
+import type { ConfiguredCombatantGroup } from "#configuration";
 import type { Identity, InexactPartial, Merge } from "#utils";
 import type Document from "#common/abstract/document.mjs";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/combatant.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredCombatant } from "fvtt-types/configuration";
+import type { ConfiguredCombatant } from "#configuration";
 import type { Identity, InexactPartial, Merge } from "#utils";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";

package/src/foundry/client/documents/folder.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredFolder } from "fvtt-types/configuration";
+import type { ConfiguredFolder } from "#configuration";
 import type { Identity, InexactPartial, IntentionalPartial, Merge, NullishProps } from "#utils";
 import type Document from "#common/abstract/document.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/item.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredItem } from "fvtt-types/configuration";
+import type { ConfiguredItem } from "#configuration";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/journal-entry-page.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredJournalEntryPage } from "fvtt-types/configuration";
+import type { ConfiguredJournalEntryPage } from "#configuration";
 import type { AnyObject, Identity, InexactPartial, Merge, NullishProps } from "#utils";
 import type Document from "#common/abstract/document.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/macro.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredMacro } from "fvtt-types/configuration";
+import type { ConfiguredMacro } from "#configuration";
 import type { Identity, InexactPartial, Merge, NullishProps } from "#utils";
 import type { documents } from "#client/client.d.mts";
 import type Document from "#common/abstract/document.d.mts";

package/src/foundry/client/documents/region-behavior.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredRegionBehavior } from "fvtt-types/configuration";
+import type { ConfiguredRegionBehavior } from "#configuration";
 import type Document from "#common/abstract/document.d.mts";
 import type BaseRegionBehavior from "#common/documents/region-behavior.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/table-result.d.mts

@@ -1,4 +1,4 @@
-import type { ConfiguredTableResult } from "fvtt-types/configuration";
+import type { ConfiguredTableResult } from "#configuration";
 import type { Identity, InexactPartial, Merge } from "#utils";
 import type Document from "#common/abstract/document.d.mts";
 import type { DataSchema } from "#common/data/fields.d.mts";

package/src/foundry/client/documents/token.d.mts

@@ -1044,6 +1044,21 @@ declare namespace TokenDocument {
 
   interface GetBarAttributeOptions extends _GetBarAttributeOptions {}
 
+  interface SingleAttributeBar {
+    type: "value";
+    attribute: string;
+    value: number;
+    editable: boolean;
+  }
+
+  interface ObjectAttributeBar {
+    type: "bar";
+    attribute: string;
+    value: number;
+    max: number;
+    editable: boolean;
+  }
+
   type GetBarAttributeReturn = SingleAttributeBar | ObjectAttributeBar | null;
 
   /** @internal */
@@ -2132,19 +2147,4 @@ declare class TokenDocument extends BaseToken.Internal.CanvasDocument {
   #TokenDocument: true;
 }
 
-interface SingleAttributeBar {
-  type: "value";
-  attribute: string;
-  value: number;
-  editable: boolean;
-}
-
-interface ObjectAttributeBar {
-  type: "bar";
-  attribute: string;
-  value: number;
-  max: number;
-  editable: boolean;
-}
-
-export { TokenDocument as default, SingleAttributeBar, ObjectAttributeBar };
+export default TokenDocument;

package/src/foundry/client/hooks.d.mts

@@ -970,16 +970,15 @@ export interface AllHooks extends DynamicHooks {
   initializeDynamicTokenRingConfig: (ringConfig: TokenRingConfig) => void;
 
   /**
-   * A hook event that fires when the context menu for a PlayersList entry is constructed.
+   * A hook event that fires when the context menu for a Players entry is constructed.
    * @param app            - The Application instance that the context menu is constructed in
    * @param contextOptions - The context menu entries
-   * @remarks This is called by {@linkcode Hooks.call}.
-   * @see {@link PlayerList.activateListeners | `PlayerList#activateListeners`}
+   * @remarks This is called by {@linkcode Hooks.callAll}.
    */
   getUserContextOptions: (
     app: foundry.applications.ui.Players,
     contextOptions: ContextMenu.Entry<HTMLElement>[],
-  ) => boolean | void;
+  ) => void;
 
   /**
    * A hook event that fires when the context menu for a SceneNavigation entry is constructed.
@@ -991,6 +990,17 @@ export interface AllHooks extends DynamicHooks {
     app: foundry.applications.ui.SceneNavigation,
     contextOptions: ContextMenu.Entry<HTMLElement>[],
   ) => void;
+
+  /**
+   * A hook event that fires when the context menu for a Macro Hotbar entry is constructed.
+   * @param app            - The Application instance that the context menu is constructed in
+   * @param contextOptions - The context menu entries
+   * @remarks This is called by {@linkcode Hooks.callAll}.
+   */
+  getMacroContextOptions: (
+    app: foundry.applications.ui.Hotbar,
+    contextOptions: ContextMenu.Entry<HTMLElement>[],
+  ) => void;
 }
 
 declare global {

package/src/foundry/client/packages/system.d.mts

@@ -3,7 +3,7 @@ import type AdditionalTypesField from "#common/packages/sub-types.d.mts";
 import type DataModel from "#common/abstract/data.mjs";
 import type ClientPackageMixin from "./client-package.d.mts";
 import type { SystemNameConfig } from "#configuration";
-import type { GetKey } from "fvtt-types/utils";
+import type { GetKey } from "#utils";
 
 import fields = foundry.data.fields;
 import Game = foundry.Game;

package/tsconfig.json

@@ -5,5 +5,5 @@
   "include": ["**/*", ".*", ".**/**/*"],
   // `src/index-lenient.d.mts` is skipped because it sets `AssumeHookRan` which has some pretty global effects that would make it easy to write broken code.
   // `tests` are excluded to speed up typechecking.
-  "exclude": ["src/index-lenient.d.mts", "tests"]
+  "exclude": ["src/index-lenient.d.mts", "tests", "cvise"]
 }