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

package/src/foundry/client/applications/sidebar/sidebar-tab.d.mts

@@ -0,0 +1,106 @@
+import type { DeepPartial, Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      AbstractSidebarTab: AbstractSidebarTab.Any;
+    }
+  }
+}
+
+/**
+ * The sidebar tab interface that allows any sidebar tab to also be rendered as a popout.
+ */
+declare abstract class AbstractSidebarTab<
+  RenderContext extends AbstractSidebarTab.RenderContext = AbstractSidebarTab.RenderContext,
+  Configuration extends AbstractSidebarTab.Configuration = AbstractSidebarTab.Configuration,
+  RenderOptions extends AbstractSidebarTab.RenderOptions = AbstractSidebarTab.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
+  static tabName: string;
+
+  static override readonly emittedEvents: string[];
+
+  /**
+   * Whether this tab is currently active in the sidebar.
+   */
+  get active(): boolean;
+
+  /**
+   * Whether this is the popped-out tab or the in-sidebar one.
+   */
+  get isPopout(): boolean;
+
+  /**
+   * A reference to the popped-out version of this tab, if one exists.
+   */
+  get popout(): this | undefined;
+
+  /**
+   * The base name of the sidebar tab.
+   */
+  get tabName(): string;
+
+  protected override _initializeApplicationOptions(options: DeepPartial<Configuration>): Configuration;
+
+  protected override _prepareContext(
+    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
+  ): Promise<RenderContext>;
+
+  protected override _renderFrame(options: DeepPartial<RenderOptions>): Promise<HTMLElement>;
+
+  override render(options?: DeepPartial<RenderOptions>): Promise<this>;
+  override render(options: boolean, _options?: DeepPartial<RenderOptions>): Promise<this>;
+
+  /**
+   * Activate this tab in the sidebar.
+   */
+  activate(): void;
+
+  /**
+   * Pop-out this sidebar tab as a new application.
+   */
+  renderPopout(): Promise<this>;
+
+  /**
+   * Actions performed when this tab is activated in the sidebar.
+   */
+  protected _onActivate(): void;
+
+  protected override _onClose(options: DeepPartial<RenderOptions>): void;
+
+  /**
+   * Actions performed when this tab is deactivated in the sidebar.
+   */
+  protected _onDeactivate(): void;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+}
+
+declare namespace AbstractSidebarTab {
+  interface Any extends AnyAbstractSidebarTab {}
+  interface AnyConstructor extends Identity<typeof AnyAbstractSidebarTab> {}
+
+  interface RenderContext extends ApplicationV2.RenderContext {}
+  interface Configuration extends ApplicationV2.Configuration {}
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+
+  type EmittedEvents = Readonly<["render", "close", "position", "activate", "deactivate"]>;
+
+  interface RenderContext extends ApplicationV2.RenderContext {
+    user: User.Implementation;
+  }
+}
+
+declare abstract class AnyAbstractSidebarTab extends AbstractSidebarTab<
+  AbstractSidebarTab.RenderContext,
+  AbstractSidebarTab.Configuration,
+  AbstractSidebarTab.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default AbstractSidebarTab;

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

@@ -0,0 +1,129 @@
+import type { DeepPartial, Identity } from "#utils";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+import ApplicationV2 = foundry.applications.api.ApplicationV2;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      Sidebar: Sidebar.Any;
+    }
+  }
+}
+
+/**
+ * The main sidebar application.
+ */
+declare class Sidebar<
+  RenderContext extends Sidebar.RenderContext = Sidebar.RenderContext,
+  Configuration extends Sidebar.Configuration = Sidebar.Configuration,
+  RenderOptions extends Sidebar.RenderOptions = Sidebar.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
+  static override DEFAULT_OPTIONS: Partial<Sidebar.Configuration>;
+
+  // TODO: This override of `TABS` is completely unsound subclassing-wise.
+  // static override TABS: Record<string, Sidebar.TabDescriptor>;
+
+  override tabGroups: {
+    /** @defaultValue `"chat"` */
+    primary: string;
+  };
+
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  /**
+   * Whether the sidebar is currently expanded.
+   */
+  get expanded(): boolean;
+
+  /**
+   * The currently popped-out sidebar tabs.
+   */
+  popouts: Record<string, foundry.applications.sidebar.AbstractSidebarTab>;
+
+  protected override _configureRenderOptions(options: DeepPartial<RenderOptions>): void;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _preparePartContext(
+    partId: string,
+    context: ApplicationV2.RenderContextOf<this>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<ApplicationV2.RenderContextOf<this>>;
+
+  /**
+   * Prepare render context for the tabs.
+   * @param context - Shared context provided by _prepareContext.
+   * @param options - Options for configuring rendering behavior.
+   */
+  protected _prepareTabContext(
+    context: ApplicationV2.RenderContext,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _renderHTML(
+    _context: RenderContext,
+    _options: DeepPartial<RenderOptions>,
+  ): Promise<HTMLFormElement>;
+
+  protected override _onClickTab(event: PointerEvent): void;
+
+  override changeTab(tab: string, group: string, options?: ApplicationV2.ChangeTabOptions): void;
+
+  /**
+   * Collapse the sidebar.
+   */
+  collapse(): void;
+
+  /**
+   * Expand the sidebar.
+   */
+  expand(): void;
+
+  /**
+   * Toggle the expanded state of the sidebar.
+   * @param expanded - Force the expanded state to the provided value, otherwise toggle the state.
+   */
+  toggleExpanded(expanded?: boolean): void;
+
+  /**
+   * @deprecated since v13 will be removed in v15
+   * @ignore
+   */
+  activateTab(tabName: string): void;
+
+  static #SidebarStatic: true;
+  #Sidebar: true;
+}
+
+declare namespace Sidebar {
+  interface Any extends AnySidebar {}
+  interface AnyConstructor extends Identity<typeof AnySidebar> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, ApplicationV2.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+
+  interface TabDescriptor {
+    /** The tab's tooltip. */
+    tooltip?: string | undefined;
+
+    /** The tab's Font Awesome icon class. */
+    icon?: string | undefined;
+
+    /** A Document name to retrieve tooltip and icon information from automatically. */
+    documentName?: string | undefined;
+
+    /** Whether the tab is only rendered for GM users. */
+    gmOnly?: boolean | undefined;
+  }
+}
+
+declare abstract class AnySidebar extends Sidebar<Sidebar.RenderContext, Sidebar.Configuration, Sidebar.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default Sidebar;

package/src/foundry/client/applications/sidebar/tabs/actor-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 {
+      ActorDirectory: ActorDirectory.Any;
+    }
+  }
+}
+
+/**
+ * The World Actor directory listing.
+ * @remarks TODO: Stub
+ */
+declare class ActorDirectory<
+  RenderContext extends ActorDirectory.RenderContext = ActorDirectory.RenderContext,
+  Configuration extends ActorDirectory.Configuration = ActorDirectory.Configuration,
+  RenderOptions extends ActorDirectory.RenderOptions = ActorDirectory.RenderOptions,
+> extends DocumentDirectory<Actor.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ActorDirectory {
+  interface Any extends AnyActorDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyActorDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyActorDirectory extends ActorDirectory<
+  ActorDirectory.RenderContext,
+  ActorDirectory.Configuration,
+  ActorDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ActorDirectory;

package/src/foundry/client/applications/sidebar/tabs/cards-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 {
+      CardsDirectory: CardsDirectory.Any;
+    }
+  }
+}
+
+/**
+ * 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 CardsDirectory.RenderOptions = CardsDirectory.RenderOptions,
+> extends DocumentDirectory<Cards.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace CardsDirectory {
+  interface Any extends AnyCardsDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyCardsDirectory> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyCardsDirectory extends CardsDirectory<
+  CardsDirectory.RenderContext,
+  CardsDirectory.Configuration,
+  CardsDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default CardsDirectory;

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

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

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

@@ -0,0 +1,283 @@
+import type ContextMenu from "#client/applications/ux/context-menu.mjs";
+import type { DeepPartial, Identity } from "../../../../../utils/index.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type AbstractSidebarTab from "../sidebar-tab.d.mts";
+import type { Token } from "#client/canvas/placeables/_module.d.mts";
+
+import ApplicationV2 = foundry.applications.api.ApplicationV2;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      CombatTracker: CombatTracker.Any;
+    }
+  }
+}
+
+/**
+ * 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 CombatTracker.Configuration = CombatTracker.Configuration,
+  RenderOptions extends CombatTracker.RenderOptions = CombatTracker.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: ApplicationV2.RenderContextOf<this>,
+    options: RenderOptions,
+  ): Promise<ApplicationV2.RenderContextOf<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 Any extends AnyCombatTracker {}
+  interface AnyConstructor extends Identity<typeof AnyCombatTracker> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, AbstractSidebarTab.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, AbstractSidebarTab.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, AbstractSidebarTab.RenderOptions {}
+
+  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;
+  }
+}
+
+declare abstract class AnyCombatTracker extends CombatTracker<
+  CombatTracker.RenderContext,
+  CombatTracker.Configuration,
+  CombatTracker.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default CombatTracker;

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

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