@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 13.340.0

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

@@ -0,0 +1,86 @@
+import type { DeepPartial } from "../../../../utils/index.d.mts";
+import type ApplicationV2 from "../api/application.d.mts";
+
+/**
+ * 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 ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.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 {
+  type Any = AbstractSidebarTab<any, any, any>;
+  type AnyConstructor = typeof AbstractSidebarTab;
+
+  type EmittedEvents = Readonly<["render", "close", "position", "activate", "deactivate"]>;
+
+  interface RenderContext extends ApplicationV2.RenderContext {
+    user: User.ConfiguredInstance;
+  }
+}
+
+export default AbstractSidebarTab;

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

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

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

@@ -0,0 +1,17 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as ActorDirectory } from "./actor-directory.mjs";
+export { default as CardsDirectory } from "./cards-directory.mjs";
+export { default as ChatLog } from "./chat.mjs";
+export { default as CombatTracker } from "./combat-tracker.mjs";
+export { default as CompendiumDirectory } from "./compendium-directory.mjs";
+export { default as ItemDirectory } from "./item-directory.mjs";
+export { default as JournalDirectory } from "./journal-directory.mjs";
+export { default as MacroDirectory } from "./macro-directory.mjs";
+export { default as PlaylistDirectory } from "./playlist-directory.mjs";
+export { default as RollTableDirectory } from "./roll-table-directory.mjs";
+export { default as SceneDirectory } from "./scene-directory.mjs";
+export { default as Settings } from "./settings.mjs";

package/src/foundry/client-esm/applications/sidebar/tabs/actor-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 Actor directory listing.
+ * @remarks TODO: Stub
+ */
+declare class ActorDirectory<
+  RenderContext extends ActorDirectory.RenderContext = ActorDirectory.RenderContext,
+  Configuration extends ActorDirectory.Configuration = ActorDirectory.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<Actor.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ActorDirectory {
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+
+  interface Configuration extends DocumentDirectory.Configuration {}
+}
+
+export default ActorDirectory;

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.ConfiguredClass, 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,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";
+
+/**
+ * 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> {}
+
+declare namespace CombatTracker {
+  interface RenderContext extends AbstractSidebarTab.RenderContext {}
+}
+
+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.ConfiguredClass, 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.ConfiguredClass, 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.ConfiguredClass, 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.ConfiguredClass, 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.ConfiguredClass, 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.ConfiguredClass, 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

@@ -1,6 +1,13 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// 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;