@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1-beta.20250704.94554

package/src/foundry/client/applications/sidebar/tabs/item-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      ItemDirectory: ItemDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Item directory listing.
+ * @remarks TODO: Stub
+ */
+declare class ItemDirectory<
+  RenderContext extends ItemDirectory.RenderContext = ItemDirectory.RenderContext,
+  Configuration extends ItemDirectory.Configuration = ItemDirectory.Configuration,
+  RenderOptions extends ItemDirectory.RenderOptions = ItemDirectory.RenderOptions,
+> extends DocumentDirectory<Item.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ItemDirectory {
+  interface Any extends AnyItemDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyItemDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyItemDirectory extends ItemDirectory<
+  ItemDirectory.RenderContext,
+  ItemDirectory.Configuration,
+  ItemDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ItemDirectory;

package/src/foundry/client/applications/sidebar/tabs/journal-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      JournalDirectory: JournalDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Journal.
+ * @remarks TODO: Stub
+ */
+declare class JournalDirectory<
+  RenderContext extends JournalDirectory.RenderContext = JournalDirectory.RenderContext,
+  Configuration extends JournalDirectory.Configuration = JournalDirectory.Configuration,
+  RenderOptions extends JournalDirectory.RenderOptions = JournalDirectory.RenderOptions,
+> extends DocumentDirectory<JournalEntry.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace JournalDirectory {
+  interface Any extends AnyJournalDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyJournalDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyJournalDirectory extends JournalDirectory<
+  JournalDirectory.RenderContext,
+  JournalDirectory.Configuration,
+  JournalDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default JournalDirectory;

package/src/foundry/client/applications/sidebar/tabs/macro-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      MacroDirectory: MacroDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Macro directory listing.
+ * @remarks TODO: Stub
+ */
+declare class MacroDirectory<
+  RenderContext extends MacroDirectory.RenderContext = MacroDirectory.RenderContext,
+  Configuration extends MacroDirectory.Configuration = MacroDirectory.Configuration,
+  RenderOptions extends MacroDirectory.RenderOptions = MacroDirectory.RenderOptions,
+> extends DocumentDirectory<Macro.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace MacroDirectory {
+  interface Any extends AnyMacroDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyMacroDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyMacroDirectory extends MacroDirectory<
+  MacroDirectory.RenderContext,
+  MacroDirectory.Configuration,
+  MacroDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default MacroDirectory;

package/src/foundry/client/applications/sidebar/tabs/playlist-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      PlaylistDirectory: PlaylistDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Playlist directory listing.
+ * @remarks TODO: Stub
+ */
+declare class PlaylistDirectory<
+  RenderContext extends PlaylistDirectory.RenderContext = PlaylistDirectory.RenderContext,
+  Configuration extends PlaylistDirectory.Configuration = PlaylistDirectory.Configuration,
+  RenderOptions extends PlaylistDirectory.RenderOptions = PlaylistDirectory.RenderOptions,
+> extends DocumentDirectory<Playlist.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace PlaylistDirectory {
+  interface Any extends AnyPlaylistDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyPlaylistDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyPlaylistDirectory extends PlaylistDirectory<
+  PlaylistDirectory.RenderContext,
+  PlaylistDirectory.Configuration,
+  PlaylistDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default PlaylistDirectory;

package/src/foundry/client/applications/sidebar/tabs/roll-table-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      RollTableDirectory: RollTableDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World RollTable directory listing.
+ * @remarks TODO: Stub
+ */
+declare class RollTableDirectory<
+  RenderContext extends RollTableDirectory.RenderContext = RollTableDirectory.RenderContext,
+  Configuration extends RollTableDirectory.Configuration = RollTableDirectory.Configuration,
+  RenderOptions extends RollTableDirectory.RenderOptions = RollTableDirectory.RenderOptions,
+> extends DocumentDirectory<RollTable.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace RollTableDirectory {
+  interface Any extends AnyRollTableDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyRollTableDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyRollTableDirectory extends RollTableDirectory<
+  RollTableDirectory.RenderContext,
+  RollTableDirectory.Configuration,
+  RollTableDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default RollTableDirectory;

package/src/foundry/client/applications/sidebar/tabs/scene-directory.d.mts

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      SceneDirectory: SceneDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Scene directory listing.
+ * @remarks TODO: Stub
+ */
+declare class SceneDirectory<
+  RenderContext extends SceneDirectory.RenderContext = SceneDirectory.RenderContext,
+  Configuration extends SceneDirectory.Configuration = SceneDirectory.Configuration,
+  RenderOptions extends SceneDirectory.RenderOptions = SceneDirectory.RenderOptions,
+> extends DocumentDirectory<Scene.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace SceneDirectory {
+  interface Any extends AnySceneDirectory {}
+  interface AnyConstructor extends Identity<typeof AnySceneDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnySceneDirectory extends SceneDirectory<
+  SceneDirectory.RenderContext,
+  SceneDirectory.Configuration,
+  SceneDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default SceneDirectory;

package/src/foundry/client/applications/sidebar/tabs/settings.d.mts

@@ -0,0 +1,39 @@
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type { Identity } from "#utils";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      Settings: Settings.Any;
+    }
+  }
+}
+
+/**
+ * @remarks TODO: Stub
+ */
+declare class Settings<
+  RenderContext extends Settings.RenderContext = Settings.RenderContext,
+  Configuration extends Settings.Configuration = Settings.Configuration,
+  RenderOptions extends Settings.RenderOptions = Settings.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace Settings {
+  interface Any extends AnySettings {}
+  interface AnyConstructor extends Identity<typeof AnySettings> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, AbstractSidebarTab.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, AbstractSidebarTab.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, AbstractSidebarTab.RenderOptions {}
+}
+
+declare abstract class AnySettings extends Settings<
+  Settings.RenderContext,
+  Settings.Configuration,
+  Settings.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default Settings;

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

@@ -0,0 +1,49 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      GamePause: GamePause.Any;
+    }
+  }
+}
+
+/**
+ * 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> {}
+
+declare namespace GamePause {
+  interface Any extends AnyGamePause {}
+  interface AnyConstructor extends Identity<typeof AnyGamePause> {}
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    cssClass: string;
+    icon: string;
+    text: string;
+    spin: boolean;
+  }
+
+  interface Configuration extends ApplicationV2.Configuration {}
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyGamePause extends GamePause<
+  GamePause.RenderContext,
+  GamePause.Configuration,
+  GamePause.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default GamePause;

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

@@ -0,0 +1,52 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      Hotbar: Hotbar.Any;
+    }
+  }
+}
+
+/**
+ * An action bar displayed at the bottom of the game view which contains Macros as interactive buttons.
+ * The Hotbar supports 5 pages of macros which can be dragged and dropped to organize as you wish.
+ * 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 ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace Hotbar {
+  interface Any extends AnyHotbar {}
+  interface AnyConstructor extends Identity<typeof AnyHotbar> {}
+
+  interface SlotData {
+    slot: number;
+  }
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    slots: SlotData[];
+    page: number;
+  }
+
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyHotbar extends Hotbar<object, Hotbar.Configuration, Hotbar.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default Hotbar;

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

@@ -0,0 +1,50 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      MainMenu: MainMenu.Any;
+    }
+  }
+}
+
+/**
+ * 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> {}
+
+declare namespace MainMenu {
+  interface Any extends AnyMainMenu {}
+  interface AnyConstructor extends Identity<typeof AnyMainMenu> {}
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    items: Record<string, MainMenuItem>;
+  }
+
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+
+  interface MainMenuItem {
+    label: string;
+    icon: string;
+    enabled: boolean | (() => boolean);
+    onClick: (ev: PointerEvent) => void;
+  }
+}
+
+declare abstract class AnyMainMenu extends MainMenu<object, MainMenu.Configuration, MainMenu.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default MainMenu;

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

@@ -0,0 +1,56 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      Players: Players.Any;
+    }
+  }
+}
+
+/**
+ * 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> {}
+
+declare namespace Players {
+  interface Any extends AnyPlayers {}
+  interface AnyConstructor extends Identity<typeof AnyPlayers> {}
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    active: UserContext[];
+    inactive: UserContext[];
+  }
+
+  interface UserContext {
+    id: string;
+    name: string;
+    role: CONST.USER_ROLES;
+    tooltip: string;
+    isSelf: boolean;
+    cssClass: string;
+    color: string;
+    border: string;
+  }
+
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyPlayers extends Players<Players.RenderContext, Players.Configuration, Players.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default Players;

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

@@ -0,0 +1,97 @@
+import type { DeepPartial, Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      RegionLegend: RegionLegend.Any;
+    }
+  }
+}
+
+/**
+ * Scene Region Legend.
+ */
+declare class RegionLegend<
+  RenderContext extends RegionLegend.RenderContext = RegionLegend.RenderContext,
+  Configuration extends RegionLegend.Configuration = RegionLegend.Configuration,
+  RenderOptions extends RegionLegend.RenderOptions = RegionLegend.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
+  #RegionLegend: true;
+
+  static override DEFAULT_OPTIONS: DeepPartial<ApplicationV2.Configuration> & object;
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  /** The currently viewed elevation range. */
+  elevation: { bottom: number; top: number };
+
+  protected override _configureRenderOptions(options: DeepPartial<RenderOptions>): void;
+
+  protected override _canRender(options: DeepPartial<RenderOptions>): false | void;
+
+  protected override _renderFrame(options: DeepPartial<RenderOptions>): Promise<HTMLElement>;
+
+  override close(options?: DeepPartial<ApplicationV2.ClosingOptions>): Promise<this>;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
+
+  protected override _onClose(options: DeepPartial<RenderOptions>): void;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  /**
+   * Is this Region visible in this RegionLegend?
+   * @param region - The Region
+   * @internal
+   */
+  _isRegionVisible(region: RegionDocument.Implementation): boolean;
+
+  /**
+   * Highlight a hovered region in the legend.
+   * @param region  - The Region
+   * @param hover   - Whether they are being hovered in or out
+   * @internal
+   */
+  _hoverRegion(region: RegionDocument.Implementation, hover: boolean): void;
+}
+
+declare namespace RegionLegend {
+  interface Any extends AnyRegionLegend {}
+  interface AnyConstructor extends Identity<typeof AnyRegionLegend> {}
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    regions: RegionDocument.Implementation[];
+    elevation: Elevation;
+  }
+
+  interface Elevation {
+    bottom: number | string;
+    top: number | string;
+  }
+
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyRegionLegend extends RegionLegend<
+  RegionLegend.RenderContext,
+  RegionLegend.Configuration,
+  RegionLegend.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default RegionLegend;