@league-of-foundry-developers/foundry-vtt-types 12.331.4-beta → 13.340.1

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * The World Cards directory listing.
+ * @remarks TODO: Stub
+ */
+declare class CardsDirectory<
+  RenderContext extends CardsDirectory.RenderContext = CardsDirectory.RenderContext,
+  Configuration extends CardsDirectory.Configuration = CardsDirectory.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Cards.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace CardsDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default CardsDirectory;

package/src/foundry/client-esm/applications/sidebar/tabs/chat.d.mts

@@ -0,0 +1,19 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+
+/**
+ * The sidebar chat tab.
+ * @remarks TODO: Stub
+ */
+declare class ChatLog<
+  RenderContext extends ChatLog.RenderContext = ChatLog.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ChatLog {
+  interface RenderContext extends AbstractSidebarTab.RenderContext {}
+}
+
+export default ChatLog;

package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts

@@ -0,0 +1,260 @@
+import type ContextMenu from "#client-esm/applications/ux/context-menu.mjs";
+import type { DeepPartial } from "../../../../../utils/index.d.mts";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+
+/**
+ * An Application that manages switching between Combats and tracking the Combatants in those Combats.
+ * @remarks TODO: Stub
+ */
+declare class CombatTracker<
+  RenderContext extends CombatTracker.RenderContext = CombatTracker.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {
+  static override tabName: "combat";
+
+  // leaving out DEFAULT_OPTIONS and PARTS
+
+  /**
+   * The list combats applicable to the active Scene.
+   */
+  get combats(): Combat.Stored[];
+
+  /**
+   * Record the currently tracked combat encounter.
+   */
+  get viewed(): Combat.Stored | null;
+
+  set viewed(combat);
+
+  protected override _configureRenderOptions(options: DeepPartial<RenderOptions>): void;
+
+  /**
+   * Format a tooltip for displaying overflowing effects
+   * @param effects - The effect names and icons.
+   */
+  protected _formatEffectsTooltip(effects: CombatTracker.EffectContext[]): void;
+
+  /**
+   * Retrieve a source image for a combatant. If it is a video, use the first frame.
+   * @param combatant - The Combatant.
+   * @returns The image URL.
+   */
+  protected _getCombatantThumbnail(combatant: Combatant.Stored): Promise<string>;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _preparePartContext(
+    partId: string,
+    context: HandlebarsApplicationMixin.HandlebarsApplication.RenderContextFor<this>,
+    options: RenderOptions,
+  ): Promise<HandlebarsApplicationMixin.HandlebarsApplication.RenderContextFor<this>>;
+
+  /**
+   * Prepare render context for the footer part.
+   */
+  protected _prepareCombatContext(context: RenderContext, options: RenderOptions): Promise<CombatTracker.CombatContext>;
+
+  /**
+   * Prepare render context for the tracker part.
+   */
+  protected _prepareTrackerContext(
+    context: RenderContext,
+    options: RenderOptions,
+  ): Promise<CombatTracker.TrackerContext | void>;
+
+  /**
+   * Prepare render context for a single entry in the combat tracker.
+   * @param combat    - The active combat.
+   * @param combatant - The Combatant whose turn is being prepared.
+   * @param index     - The index of this entry in the turn order.
+   */
+  protected _prepareTurnContext(
+    combat: Combat.Stored,
+    combatant: Combatant.Stored,
+    index: number,
+  ): Promise<CombatTracker.TurnContext>;
+
+  protected override _attachFrameListeners(): void;
+
+  /**
+   * Get context menu entries for Combatants in the tracker.
+   */
+  protected _getEntryContextOptions(): ContextMenu.Entry<HTMLElement>[];
+
+  /**
+   * Get context menu entries for Combat in the tracker.
+   */
+  protected _getCombatContextOptions(): ContextMenu.Entry<HTMLElement>[];
+
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
+  protected override _onClickAction(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<void>;
+
+  /**
+   * Cycle to a different combat encounter in the tracker.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatCycle(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<Combat.Stored>;
+
+  /**
+   * Create a new combat.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatCreate(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<void>;
+
+  /**
+   * Handle performing some action for an individual combatant.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatantControl(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<unknown>;
+
+  /**
+   * Handle hovering over a combatant in the tracker.
+   * @param event - The triggering event
+   */
+  protected _onCombatantHoverIn(event: PointerEvent): void;
+
+  /**
+   * Handle hovering out a combatant in the tracker.
+   * @param event - The triggering event
+   */
+  protected _onCombatantHoverOut(event: PointerEvent): void;
+
+  /**
+   * Handle activating a combatant in the tracker.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatantMouseDown(event: PointerEvent, target: ApplicationV2.ActionTarget): void;
+
+  /**
+   * Handle panning to a combatant's token.
+   * @param combatant - The combatant.
+   */
+  protected _onPanToCombatant(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle pinging a combatant's token.
+   * @param combatant - The combatant.
+   */
+  protected _onPingCombatant(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle rolling initiative for a single combatant.
+   * @param combatant - The combatant.
+   */
+  protected _onRollInitiative(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle toggling the defeated status effect on a combatant token.
+   * @param combatant - The combatant.
+   */
+  protected _onToggleDefeatedStatus(combatant: Combatant.Stored): void;
+
+  /**
+   * Toggle a combatant's hidden state in the tracker.
+   * @param combatant - The combatant.
+   */
+  protected _onToggleHidden(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle updating a combatant's initiative in-sheet.
+   * @param event - The triggering change event.
+   */
+  protected _onUpdateInitiative(event: Event): void;
+
+  /**
+   * Highlight a hovered combatant in the tracker.
+   * @param combatant - The Combatant.
+   * @param hover     - Whether they are being hovered in or out.
+   */
+  hoverCombatant(combatant: Combatant.Stored, hover: boolean): void;
+
+  /**
+   * Is the token of the combatant visible?
+   * @param token - The token of the combatant
+   * @returns Is the token visible?
+   */
+  protected _isTokenVisible(token: Token.Implementation): boolean;
+
+  /**
+   * Scroll to the current combatant in the combat log.
+   */
+  scrollToTurn(): void;
+
+  /**
+   * @deprecated since v13, will be removed in v13
+   * @remarks "CombatTracker#initialize is deprecated.
+   * The currently viewed combat can be changed by assigning to ui.combat.viewed directly,
+   * passed as an option to ui.combat.render, or by setting a Combat as active.
+   */
+  initialize(options: unknown): void;
+}
+
+declare namespace CombatTracker {
+  interface RenderContext extends AbstractSidebarTab.RenderContext {}
+
+  interface EffectContext {
+    name: string;
+    img: string;
+  }
+
+  interface CombatContext {
+    combat: Combat.Stored | null;
+    hasCombat: boolean;
+    combats: CombatsRow[];
+    control: boolean;
+    css: string;
+    currentIndex: number;
+    displayCycle: boolean;
+    initiativeIcon: string;
+    link: boolean;
+    labels: CombatLabels;
+  }
+
+  interface CombatsRow {
+    id: string;
+    label: number;
+    active: boolean;
+  }
+
+  interface CombatLabels {
+    scope: string;
+  }
+
+  interface TrackerContext {
+    turns: TurnContext[];
+    hasDecimals: boolean;
+  }
+
+  interface TurnContext {
+    hasDecimals: boolean;
+    hidden: boolean;
+    id: string;
+    isDefeated: boolean;
+    initiative: number | null;
+    isOwner: boolean;
+    name: string;
+    resource: Combatant.Resource;
+    active: boolean;
+    canPing: boolean;
+    img: string;
+    css: string;
+    effects: TurnEffects;
+  }
+
+  interface TurnEffects {
+    icons: EffectContext[];
+    tooltip: string;
+  }
+}
+
+export default CombatTracker;

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

@@ -0,0 +1,19 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+
+/**
+ * The listing of compendiums available in the World.
+ * @remarks TODO: Stub
+ */
+declare class CompendiumDirectory<
+  RenderContext extends CompendiumDirectory.RenderContext = CompendiumDirectory.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace CompendiumDirectory {
+  interface RenderContext extends AbstractSidebarTab.RenderContext {}
+}
+
+export default CompendiumDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * 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 ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Item.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ItemDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default ItemDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * The World Journal.
+ * @remarks TODO: Stub
+ */
+declare class JournalDirectory<
+  RenderContext extends JournalDirectory.RenderContext = JournalDirectory.RenderContext,
+  Configuration extends JournalDirectory.Configuration = JournalDirectory.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<JournalEntry.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace JournalDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default JournalDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * 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 ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Macro.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace MacroDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default MacroDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * 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 ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Playlist.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace PlaylistDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default PlaylistDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * 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 ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<RollTable.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace RollTableDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default RollTableDirectory;

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

@@ -0,0 +1,20 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+/**
+ * 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 ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Scene.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace SceneDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default SceneDirectory;

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

@@ -0,0 +1,18 @@
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+
+/**
+ * @remarks TODO: Stub
+ */
+declare class Settings<
+  RenderContext extends Settings.RenderContext = Settings.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace Settings {
+  interface RenderContext extends AbstractSidebarTab.RenderContext {}
+}
+
+export default Settings;

package/src/foundry/client-esm/applications/ui/_module.d.mts

@@ -3,4 +3,11 @@
 // While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
 /* eslint-disable import-x/extensions */
 
+export { default as GamePause } from "./game-pause.mjs";
+export { default as Hotbar } from "./hotbar.mjs";
+export { default as MainMenu } from "./main-menu.mjs";
+export { default as Notifications } from "./notifications.mjs";
+export { default as Players } from "./players.mjs";
 export { default as RegionLegend } from "./region-legend.mjs";
+export { default as SceneControls } from "./scene-controls.mjs";
+export { default as SceneNavigation } from "./scene-navigation.mjs";

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

@@ -0,0 +1,22 @@
+import type ApplicationV2 from "../api/application.d.mts";
+
+/**
+ * The Game Paused banner.
+ * @remarks TODO: Stub
+ */
+declare class GamePause<
+  RenderContext extends GamePause.RenderContext = GamePause.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace GamePause {
+  interface RenderContext {
+    cssClass: string;
+    icon: string;
+    text: string;
+    spin: boolean;
+  }
+}
+
+export default GamePause;

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

@@ -0,0 +1,29 @@
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * 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 SlotData {
+    slot: number;
+  }
+
+  interface RenderContext {
+    slots: SlotData[];
+    page: number;
+  }
+}
+
+export default Hotbar;

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

@@ -0,0 +1,27 @@
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The main menu application which is toggled via the ESC key.
+ * @remarks TODO: Stub
+ */
+declare class MainMenu<
+  RenderContext extends object = MainMenu.RenderContext,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace MainMenu {
+  interface MainMenuItem {
+    label: string;
+    icon: string;
+    enabled: boolean | (() => boolean);
+    onClick: (ev: PointerEvent) => void;
+  }
+
+  interface RenderContext {
+    items: Record<string, MainMenuItem>;
+  }
+}
+
+export default MainMenu;