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

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

@@ -1,111 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A compendium of knowledge arcane and mystical!
-   * Renders the sidebar directory of compendium packs
-   * @typeParam Options - The type of the options object
-   */
-  class CompendiumDirectory<
-    Options extends DocumentDirectoryOptions = DocumentDirectoryOptions,
-  > extends DirectoryApplicationMixin(SidebarTab)<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "compendium",
-     *   template: "templates/sidebar/compendium-directory.html",
-     *   title: "COMPENDIUM.SidebarTitle",
-     *   contextMenuSelector: ".directory-item.compendium",
-     *   entryClickSelector: ".compendium"
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentDirectoryOptions;
-
-    get activeFilters(): string[];
-
-    // NOTE: It seems in source this is erroneously defined as a property, not a getter
-    override get entryType(): "Compendium";
-
-    static override entryPartial: "templates/sidebar/partials/pack-partial.html";
-
-    protected override _entryAlreadyExists(entry: DirectoryMixinEntry): boolean;
-
-    protected override _getEntryDragData(entryId: string): object;
-
-    protected override _entryIsSelf(entry: DirectoryMixinEntry, otherEntry: DirectoryMixinEntry): boolean;
-
-    protected override _sortRelative(
-      entry: DirectoryMixinEntry,
-      sortData: { sortKey: string; sortBefore: boolean; updateData: object },
-    ): Promise<object>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Display a menu of compendium types to filter by
-     * @param event - The originating pointer event
-     */
-    protected _displayFilterCompendiumMenu(event: PointerEvent): Promise<void>;
-
-    /**
-     * Handle toggling a compendium type filter
-     * @param event - The originating pointer event
-     * @param type  - The compendium type to filter by. If null, clear all filters.
-     */
-    protected _onToggleCompendiumFilterType(event: PointerEvent, type: string | null): void;
-
-    /**
-     * The collection of Compendium Packs which are displayed in this Directory
-     */
-    get collection(): CompendiumPacks;
-
-    /**
-     * Get the dropped Entry from the drop data
-     * @param data - The data being dropped
-     * @returns The dropped Entry
-     */
-    protected _getDroppedEntryFromData(data: object): Promise<DirectoryMixinEntry>;
-
-    protected override _createDroppedEntry(entry: DirectoryMixinEntry, folderId?: string): Promise<DirectoryMixinEntry>;
-
-    protected override _getEntryName(entry: object): string;
-
-    protected override _getEntryId(entry: object): string;
-
-    // TODO: Implement GetDataReturnType
-    override getData(options?: Partial<Options>): Promise<object>;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<unknown>;
-
-    /**
-     * Get the sidebar directory entry context options
-     * @returns The sidebar entry context options
-     * @internal
-     */
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    protected override _onClickEntryName(event: PointerEvent): Promise<void>;
-
-    protected override _onCreateEntry(event: PointerEvent): Promise<void>;
-
-    /**
-     * Handle a Compendium Pack deletion request
-     * @param pack - The pack object requested for deletion
-     * @internal
-     */
-    protected _onDeleteCompendium(
-      pack: CompendiumCollection<CompendiumCollection.Metadata>,
-    ): Promise<CompendiumCollection<CompendiumCollection.Metadata> | void>;
-  }
-
-  namespace CompendiumDirectory {
-    type Any = AnyCompendiumDirectory;
-    type AnyConstructor = typeof AnyCompendiumDirectory;
-  }
-}
-
-declare abstract class AnyCompendiumDirectory extends CompendiumDirectory<DocumentDirectoryOptions> {
-  constructor(...args: ConstructorParameters<typeof CompendiumDirectory>);
-}

package/src/foundry/client/apps/sidebar/tabs/index.d.mts

@@ -1,12 +0,0 @@
-import "./actors-directory.d.mts";
-import "./cards-directory.d.mts";
-import "./chat-log.d.mts";
-import "./combat-tracker.d.mts";
-import "./compendium-directory.d.mts";
-import "./items-directory.d.mts";
-import "./journal-directory.d.mts";
-import "./macros-directory.d.mts";
-import "./playlists-directory.d.mts";
-import "./roll-table-directory.d.mts";
-import "./scenes-directory.d.mts";
-import "./settings.d.mts";

package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts

@@ -1,23 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The sidebar directory which organizes and displays world-level Item documents.
-   */
-  class ItemDirectory extends DocumentDirectory<"Item"> {
-    static override documentName: "Item";
-
-    protected override _canDragDrop(selector: string): boolean;
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-  }
-
-  namespace ItemDirectory {
-    type Any = AnyItemDirectory;
-    type AnyConstructor = typeof AnyItemDirectory;
-  }
-}
-
-declare abstract class AnyItemDirectory extends ItemDirectory {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,22 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The sidebar directory which organizes and displays world-level JournalEntry documents.
-   * @typeParam Options - The type of the options object
-   */
-  class JournalDirectory extends DocumentDirectory<"JournalEntry"> {
-    static override documentName: "JournalEntry";
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-  }
-
-  namespace JournalDirectory {
-    type Any = AnyJournalDirectory;
-    type AnyConstructor = typeof AnyJournalDirectory;
-  }
-}
-
-declare abstract class AnyJournalDirectory extends JournalDirectory {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts

@@ -1,25 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The directory, not displayed in the sidebar, which organizes and displays world-level Macro documents.
-   *
-   * @see {@link Macros}        The WorldCollection of Macro Documents
-   * @see {@link Macro}         The Macro Document
-   * @see {@link MacroConfig}   The Macro Configuration Sheet
-   */
-  class MacroDirectory extends DocumentDirectory<"Macro"> {
-    constructor(options?: Partial<DocumentDirectoryOptions>);
-
-    static override documentName: "Macro";
-  }
-
-  namespace MacroDirectory {
-    type Any = AnyMacroDirectory;
-    type AnyConstructor = typeof AnyMacroDirectory;
-  }
-}
-
-declare abstract class AnyMacroDirectory extends MacroDirectory {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts

@@ -1,283 +0,0 @@
-import type Document from "../../../../common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * The sidebar directory which organizes and displays world-level Playlist documents.
-   * @typeParam Options - The type of the options object
-   */
-  class PlaylistDirectory<
-    Options extends DocumentDirectoryOptions = DocumentDirectoryOptions,
-  > extends DocumentDirectory<"Playlist", Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * Track the playlist IDs which are currently expanded in their display
-     * @internal
-     */
-    protected _expanded: Set<string>;
-
-    /**
-     * Are the global volume controls currently expanded?
-     * @defaultValue `false`
-     * @internal
-     */
-    protected _volumeExpanded: boolean;
-
-    /**
-     * Cache the set of Playlist documents that are displayed as playing when the directory is rendered
-     * @defaultValue `[]`
-     */
-    protected _playingPlaylists: Playlist.ConfiguredInstance[];
-
-    /**
-     * Cache the set of PlaylistSound documents that are displayed as playing when the directory is rendered
-     * @defaultValue `[]`
-     */
-    protected _playingSounds: PlaylistSound.ConfiguredInstance[];
-
-    /**
-     * @internal
-     * @defaultValue `undefined`
-     * @remarks This is only initialized and set in `getData`.
-     */
-    protected _playingSoundsData?: PlaylistDirectory.SoundData[] | undefined;
-
-    static override documentName: "Playlist";
-
-    /**
-     * @defaultValue `"templates/sidebar/partials/playlist-partial.html"`
-     */
-    static override entryPartial: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.template = "templates/sidebar/playlists-directory.html";
-     * options.dragDrop[0].dragSelector = ".folder, .playlist-name, .sound-name";
-     * options.renderUpdateKeys = ["name", "playing", "mode", "sounds", "sort", "sorting", "folder"];
-     * options.contextMenuSelector = ".document .playlist-header";
-     * return options;
-     * ```
-     */
-    static override get defaultOptions(): DocumentDirectoryOptions;
-
-    /**
-     * Initialize the set of Playlists which should be displayed in an expanded form
-     * @internal
-     */
-    protected _createExpandedSet(): Set<string>;
-
-    /**
-     * Return an Array of the Playlist documents which are currently playing
-     */
-    get playing(): Playlist.ConfiguredInstance[];
-
-    /**
-     * Whether the "currently playing" element is pinned to the top or bottom of the display.
-     * @internal
-     */
-    protected get _playingLocation(): "top" | "bottom";
-
-    // TODO: Implement GetDataReturnType
-    override getData(options?: Partial<Options>): Promise<object>;
-
-    /**
-     * Converts a volume level to a human-friendly % value
-     * @param volume - Value between [0, 1] of the volume level
-     */
-    static volumeToTooltip(volume: number): string;
-
-    /**
-     * Augment the tree directory structure with playlist-level data objects for rendering
-     * @param node - The tree leaf node being prepared
-     * @internal
-     */
-    protected _prepareTreeData(node: DirectoryCollectionMixin.TreeNode<Playlist.ConfiguredInstance>): void;
-
-    /**
-     * Create an object of rendering data for each Playlist document being displayed
-     * @param playlist - The playlist to display
-     * @returns The data for rendering
-     * @internal
-     */
-    protected _preparePlaylistData(playlist: Playlist.ConfiguredInstance): PlaylistDirectory.PlaylistData;
-
-    /**
-     * Get the icon used to represent the "play/stop" icon for the PlaylistSound
-     * @param sound - The sound being rendered
-     * @returns The icon that should be used
-     * @internal
-     */
-    protected _getPlayIcon(sound: PlaylistSound.ConfiguredInstance): string;
-
-    /**
-     * Get the icon used to represent the pause/loading icon for the PlaylistSound
-     * @param sound - The sound being rendered
-     * @returns The icon that should be used
-     * @internal
-     */
-    protected _getPauseIcon(sound: PlaylistSound.ConfiguredInstance): string;
-
-    /**
-     * Given a constant playback mode, provide the FontAwesome icon used to display it
-     * @internal
-     */
-    protected _getModeIcon(mode: foundry.CONST.PLAYLIST_MODES): string;
-
-    /**
-     * Given a constant playback mode, provide the string tooltip used to describe it
-     * @internal
-     */
-    protected _getModeTooltip(mode: foundry.CONST.PLAYLIST_MODES): string;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle global volume change for the playlist sidebar
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onGlobalVolume(event: JQuery.ClickEvent): unknown;
-
-    override collapseAll(): void;
-
-    protected override _onClickEntryName(event: PointerEvent): Promise<void>;
-
-    /**
-     * Handle global volume control collapse toggle
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onVolumeCollapse(event: JQuery.ClickEvent): void;
-
-    /**
-     * Helper method to render the expansion or collapse of playlists
-     * @param speed - (default: `250`)
-     * @internal
-     */
-    protected _collapse(el: HTMLElement, collapse: boolean, speed?: number): void;
-
-    /**
-     * Handle Playlist playback state changes
-     * @param event   - The initial click event
-     * @param playing - Is the playlist now playing?
-     * @internal
-     */
-    protected _onPlaylistPlay(event: JQuery.ClickEvent, playing: boolean): Promise<Playlist.ConfiguredInstance>;
-
-    /**
-     * Handle advancing the playlist to the next (or previous) sound
-     * @param event  - The initial click event
-     * @param action - The control action requested
-     * @internal
-     */
-    protected _onPlaylistSkip(event: JQuery.ClickEvent, action: string): Promise<Playlist.ConfiguredInstance>;
-
-    /**
-     * Handle cycling the playback mode for a Playlist
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onPlaylistToggleMode(event: JQuery.ClickEvent): Promise<Playlist.ConfiguredInstance>;
-
-    /**
-     * Handle Playlist track addition request
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onSoundCreate(event: JQuery.ClickEvent): void;
-
-    /**
-     * Modify the playback state of a Sound within a Playlist
-     * @param event  - The initial click event
-     * @param action - The sound control action performed
-     * @internal
-     */
-    protected _onSoundPlay(event: JQuery.ClickEvent, action: string): Promise<Playlist.ConfiguredInstance | undefined>;
-
-    /**
-     * Handle volume adjustments to sounds within a Playlist
-     * @param event - The initial change event
-     * @internal
-     */
-    protected _onSoundVolume(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle changes to the sound playback mode
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onSoundToggleMode(event: JQuery.ClickEvent): Promise<void>;
-
-    /** @internal */
-    protected _onPlayingPin(): void;
-
-    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-    /**
-     * Update the displayed timestamps for all currently playing audio sources.
-     * Runs on an interval every 1000ms.
-     * @internal
-     */
-    protected _updateTimestamps(): void;
-
-    /**
-     * Format the displayed timestamp given a number of seconds as input
-     * @param seconds - The current playback time in seconds
-     * @returns The formatted timestamp
-     * @internal
-     */
-    protected _formatTimestamp(seconds: number): string;
-
-    protected override _contextMenu(html: JQuery): void;
-
-    protected override _getFolderContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    /**
-     * Get context menu options for individual sound effects
-     * @returns The context options for each sound
-     * @internal
-     */
-    protected _getSoundContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    protected override _onDrop(event: DragEvent): Promise<Playlist.ConfiguredInstance | boolean>;
-  }
-
-  namespace PlaylistDirectory {
-    type Any = AnyPlaylistDirectory;
-    type AnyConstructor = typeof AnyPlaylistDirectory;
-
-    interface PlaylistData extends Document.ToObjectFalseType<Playlist.ConfiguredInstance> {
-      modeTooltip: string;
-      modeIcon: string;
-      disabled: boolean;
-      expanded: boolean;
-      css: string;
-      controlCSS: string;
-      sounds: SoundData[];
-    }
-
-    interface SoundData extends Document.ToObjectFalseType<PlaylistSound.ConfiguredInstance> {
-      playlistId: string | null;
-      css: string;
-      controlCSS: string;
-      playIcon: string;
-      playTitle: string;
-      isPaused?: boolean;
-      pauseIcon?: string;
-      lvolume?: number;
-      currentTime?: string;
-      durationTime?: string;
-    }
-  }
-}
-
-declare abstract class AnyPlaylistDirectory extends PlaylistDirectory<DocumentDirectoryOptions> {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,22 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The sidebar directory which organizes and displays world-level RollTable documents.
-   * @typeParam Options - The type of the options object
-   */
-  class RollTableDirectory extends DocumentDirectory<"RollTable"> {
-    static override documentName: "RollTable";
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-  }
-
-  namespace RollTableDirectory {
-    type Any = AnyRollTableDirectory;
-    type AnyConstructor = typeof AnyRollTableDirectory;
-  }
-}
-
-declare abstract class AnyRollTableDirectory extends RollTableDirectory {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts

@@ -1,43 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A directory listing of active game scenes
-   */
-  class SceneDirectory extends DocumentDirectory<"Scene"> {
-    static override documentName: "Scene";
-
-    /**
-     * @defaultValue `"templates/sidebar/scene-partial.html"`
-     */
-    static override entryPartial: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.renderUpdateKeys.push("background");
-     * return options;
-     * ```
-     */
-    static override get defaultOptions(): DocumentDirectoryOptions;
-
-    protected override _render(
-      force?: boolean,
-      options?: Application.RenderOptions<DocumentDirectoryOptions>,
-    ): Promise<void>;
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    protected override _getFolderContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-  }
-
-  namespace SceneDirectory {
-    type Any = AnySceneDirectory;
-    type AnyConstructor = typeof AnySceneDirectory;
-  }
-}
-
-declare abstract class AnySceneDirectory extends SceneDirectory {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,90 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The sidebar tab which displays various game settings, help messages, and configuration options.
-   * The Settings sidebar is the furthest-to-right using a triple-cogs icon.
-   * @typeParam Options - The type of the options object
-   */
-  class Settings<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "settings",
-     *   template: "templates/sidebar/settings.html",
-     *   title: "Settings"
-     * });
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    // TODO: Implement GetDataReturnType
-    override getData(options?: Partial<Options>): Promise<object>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Delegate different actions for different settings buttons
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onSettingsButton(event: JQuery.ClickEvent): void;
-
-    /**
-     * Executes with the update notification pip is clicked
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onUpdateNotificationClick(event: JQuery.ClickEvent): void;
-  }
-
-  namespace Settings {
-    type Any = AnySettings;
-    type AnyConstructor = typeof AnySettings;
-  }
-
-  /**
-   * A simple window application which shows the built documentation pages within an iframe
-   * @typeParam Options - the type of the options object
-   */
-  class FrameViewer<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    constructor(url: string, options?: Partial<Options>);
-
-    url: string;
-
-    /**
-     * @defaultValue
-     * ```
-     * const options = super.defaultOptions;
-     * const h = window.innerHeight * 0.9;
-     * const w = Math.min(window.innerWidth * 0.9, 1200);
-     * options.height = h;
-     * options.width = w;
-     * options.top = (window.innerHeight - h) / 2;
-     * options.left = (window.innerWidth - w) / 2;
-     * options.id = "documentation";
-     * options.template = "templates/apps/documentation.html";
-     * return options;
-     * ```
-     */
-    static override get defaultOptions(): typeof Application.defaultOptions;
-
-    override getData(options?: Partial<Options>): Promise<{ src: string }>;
-
-    override close(options?: Application.CloseOptions): ReturnType<Application["close"]>;
-  }
-
-  namespace FrameViewer {
-    type Any = AnyFrameViewer;
-    type AnyConstructor = typeof AnyFrameViewer;
-  }
-}
-
-declare abstract class AnySettings extends Settings<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyFrameViewer extends FrameViewer<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
-}