@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.1-beta

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

@@ -1,306 +0,0 @@
-import type { ConfiguredDocumentClass, ToObjectFalseType } from '../../../../../types/helperTypes';
-
-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 SidebarDirectory.Options = SidebarDirectory.Options> extends SidebarDirectory<
-    '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 `[]`
-     * @internal
-     */
-    protected _playingPlaylists: InstanceType<ConfiguredDocumentClass<typeof Playlist>>[];
-
-    /**
-     * Cache the set of PlaylistSound documents that are displayed as playing when the directory is rendered
-     * @defaultValue `[]`
-     * @internal
-     */
-    protected _playingSounds: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>[];
-
-    /**
-     * @internal
-     * @defaultValue `undefined`
-     * @remarks This is only initialized and set in `getData`.
-     */
-    protected _playingSoundsData?: PlaylistDirectory.Data.Sound[] | undefined;
-
-    static override documentName: 'Playlist';
-
-    /**
-     * @defaultValue `'templates/sidebar/playlist-partial.html'`
-     */
-    static override documentPartial: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.template = "templates/sidebar/playlists-directory.html";
-     * options.dragDrop[0].dragSelector = ".playlist-name, .sound-name";
-     * options.renderUpdateKeys = ["name", "playing", "mode", "sounds", "sort", "sorting", "folder"];
-     * options.contextMenuSelector = ".document .playlist-header";
-     * return options;
-     * ```
-     */
-    static override get defaultOptions(): SidebarDirectory.Options;
-
-    /**
-     * 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(): InstanceType<ConfiguredDocumentClass<typeof Playlist>>[];
-
-    /**
-     * Whether the 'currently playing' element is pinned to the top or bottom of the display.
-     * @internal
-     */
-    protected get _playingLocation(): 'top' | 'bottom';
-
-    override getData(options?: Partial<Options>): PlaylistDirectory.Data | Promise<PlaylistDirectory.Data>;
-
-    /**
-     * Augment the tree directory structure with playlist-level data objects for rendering
-     * @param leaf - The tree leaf node being prepared
-     * @internal
-     */
-    protected _prepareTreeData(
-      leaf: SidebarDirectory.Tree<InstanceType<ConfiguredDocumentClass<typeof Playlist>>>
-    ): 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: InstanceType<ConfiguredDocumentClass<typeof Playlist>>
-    ): PlaylistDirectory.Data.Playlist;
-
-    /**
-     * 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: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): 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: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): 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 change event
-     * @internal
-     */
-    protected _onGlobalVolume(event: JQuery.ChangeEvent): unknown;
-
-    override collapseAll(): void;
-
-    /**
-     * Handle Playlist collapse toggle
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onPlaylistCollapse(event: JQuery.ClickEvent): 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): unknown;
-
-    /**
-     * 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): unknown;
-
-    /**
-     * Handle cycling the playback mode for a Playlist
-     * @param event - The initial click event
-     * @internal
-     */
-    protected _onPlaylistToggleMode(event: JQuery.ClickEvent): unknown;
-
-    /**
-     * 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): unknown;
-
-    /**
-     * 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): 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(): ContextMenuEntry[];
-
-    protected override _getEntryContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Get context menu options for individual sound effects
-     * @returns The context options for each sound
-     * @internal
-     */
-    protected _getSoundContextOptions(): ContextMenuEntry[];
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    protected override _onDrop(event: DragEvent): void;
-  }
-
-  namespace PlaylistDirectory {
-    interface Data extends SidebarDirectory.Data<PlaylistDirectory.Data.Tree> {
-      playingSounds: PlaylistDirectory.Data.Sound[];
-      showPlaying: boolean;
-      playlistModifier: number;
-      ambientModifier: number;
-      interfaceModifier: number;
-      volumeExpanded: boolean;
-      currentlyPlaying: {
-        class: `location-${'top' | 'bottom'}`;
-        location: {
-          top: boolean;
-          bottom: boolean;
-        };
-        pin: {
-          label: string;
-          caret: 'down' | 'up';
-        };
-      };
-    }
-
-    namespace Data {
-      interface Tree extends SidebarDirectory.Tree<InstanceType<ConfiguredDocumentClass<typeof Playlist>>> {
-        playlists: PlaylistDirectory.Data.Playlist[];
-      }
-
-      type Playlist = ToObjectFalseType<foundry.data.PlaylistData> & {
-        modeTooltip: string;
-        modeIcon: string;
-        disabled: boolean;
-        expanded: boolean;
-        css: string;
-        controlCSS: string;
-        sounds: PlaylistDirectory.Data.Sound[];
-      };
-
-      type Sound = ToObjectFalseType<foundry.data.PlaylistSoundData> & {
-        playlistId: string | null;
-        css: string;
-        controlCSS: string;
-        playIcon: string;
-        playTitle: string;
-        isPaused?: boolean;
-        pauseIcon?: string;
-        lvolume?: number;
-        currentTime?: string;
-        durationTime?: string;
-      };
-    }
-  }
-}

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

@@ -1,9 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level RollTable documents.
- * @typeParam Options - The type of the options object
- */
-declare class RollTableDirectory<
-  Options extends SidebarDirectory.Options = SidebarDirectory.Options
-> extends SidebarDirectory<'RollTable', Options> {
-  static override documentName: 'RollTable';
-}

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

@@ -1,18 +0,0 @@
-/**
- * A directory listing of active game scenes
- */
-declare class SceneDirectory extends SidebarDirectory<'Scene'> {
-  static override documentName: 'Scene';
-
-  /**
-   * @defaultValue `"templates/sidebar/scene-partial.html"`
-   */
-  static override documentPartial: string;
-
-  protected override _render(
-    force?: boolean,
-    options?: Application.RenderOptions<SidebarDirectory.Options>
-  ): Promise<void>;
-
-  protected override _getEntryContextOptions(): ContextMenuEntry[];
-}

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

@@ -1,88 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-
-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
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class Settings<
-    Options extends ApplicationOptions = ApplicationOptions,
-    Data extends object = Settings.Data
-  > extends SidebarTab<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.id = "settings";
-     * options.template = "templates/sidebar/settings.html";
-     * options.title = "Settings";
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Delegate different actions for different settings buttons
-     * @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 {
-    interface Data {
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      system: Game['system'];
-      release: Game['data']['release'];
-      versionDisplay: Game['release']['display'];
-      isDemo: boolean;
-      canConfigure: boolean;
-      canEditWorld: boolean;
-      canManagePlayers: boolean;
-      canReturnSetup: boolean;
-      coreUpdate: string | false;
-      systemUpdate: string | false;
-      modules: number;
-    }
-  }
-
-  /**
-   * 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
-     * ```
-     * mergeObject(super.defaultOptions, {
-     *   height: window.innerHeight * 0.9,
-     *   width: Math.min(window.innerWidth * 0.9, 1200),
-     *   top: (window.innerHeight - height) / 2,
-     *   left: (window.innerWidth - width) / 2,
-     *   id: "documentation",
-     *   template: "templates/apps/documentation.html",
-     * })
-     * ```
-     */
-    static override get defaultOptions(): typeof Application['defaultOptions'];
-
-    override getData(options?: Partial<Options>): Promise<{ src: string }>;
-
-    override close(options?: Application.CloseOptions): ReturnType<Application['close']>;
-  }
-}