@league-of-foundry-developers/foundry-vtt-types 0.8.9-4 → 0.8.9-8

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/journalDirectory.d.ts

@@ -1,47 +1,27 @@
 /**
- * A directory list of JournalEntry entities in the Sidebar
+ * The sidebar directory which organizes and displays world-level JournalEntry documents.
  */
-// TODO: Remove when this class is updated!!!
-// eslint-disable-next-line
-// @ts-ignore
-declare class JournalDirectory extends SidebarDirectory<JournalDirectory.Options> {
-  /**
-   * @override
-   */
-  static get defaultOptions(): JournalDirectory.Options;
-
-  /**
-   * @override
-   */
-  get title(): string;
+declare class JournalDirectory extends SidebarDirectory<'JournalEntry'> {
+  /** @override */
+  static documentName: 'JournalEntry';
 
   /**
    * @override
+   * @defaultValue
+   * ```typescript
+   * const options = super.defaultOptions;
+   * options.id = "journal";
+   * options.template = "templates/sidebar/journal-directory.html";
+   * return options;
+   * ```
    */
-  static get entity(): 'JournalEntry';
+  static get defaultOptions(): SidebarDirectory.Options;
 
   /**
    * @override
-   * @see {@link Game.journal}
    */
-  static get collection(): Game['journal'];
+  get title(): string;
 
-  /**
-   * @override
-   */
+  /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }
-
-declare namespace JournalDirectory {
-  interface Options extends SidebarDirectory.Options {
-    /**
-     * @defaultValue `'journal'`
-     */
-    id: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/journal-directory.html'`
-     */
-    template: string;
-  }
-}

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/macroDirectory.d.ts

@@ -1,65 +1,19 @@
 /**
- * A directory list of Macro entities. Unlike other directories, this app is only rendered in pop-out mode.
+ * The directory, not displayed in the sidebar, which organizes and displays world-level Macro documents.
  *
- * @see {@link Macros}        The EntityCollection of Macro Entities
+ * @see {@link Macros}        The WorldCollection of Macro Entities
  * @see {@link Macro}         The Macro Entity
  * @see {@link MacroConfig}   The Macro Configuration Sheet
  */
-// TODO: Remove when this class is updated!!!
-// eslint-disable-next-line
-// @ts-ignore
-declare class MacroDirectory extends SidebarDirectory<MacroDirectory.Options> {
-  static get defaultOptions(): MacroDirectory.Options;
+declare class MacroDirectory extends SidebarDirectory<'Macro'> {
+  constructor(options?: Partial<SidebarDirectory.Options>);
 
-  /**
-   * @override
-   */
-  static get entity(): 'Macro';
-
-  /**
-   * @override
-   * @see {@link Game.macros}
-   */
-  static get collection(): Game['macros'];
-
-  /**
-   * @override
-   */
-  protected _render(force?: boolean, options?: SidebarDirectory.RenderContext<MacroDirectory.Options>): Promise<void>;
+  /** @override */
+  static documentName: 'Macro';
 
   /**
    * @override
    * @remarks This is never called.
    */
   protected _onCreate(event: Event): Promise<void>;
-
-  /**
-   * @param selector - (unused)
-   * @override
-   */
-  protected _canDragStart(selector: string | null): true;
-}
-
-declare namespace MacroDirectory {
-  interface Options extends SidebarDirectory.Options {
-    /**
-     * @defaultValue `'macros'`
-     */
-    id: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/macro-directory.html'`
-     */
-    template: string;
-
-    /**
-     * @defaultValue `true`
-     */
-    canDrag: boolean;
-
-    /**
-     * @defaultValue `680`
-     */
-    height: number;
-  }
 }

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts

@@ -1,175 +1,285 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * A directory listing of audio playlists
- */
-declare class PlaylistDirectory extends SidebarDirectory<PlaylistDirectory.Options> {
-  /**
-   * Track the playlist IDs which are currently expanded in their display
-   */
-  protected _expanded: Set<string>;
+import type { ConfiguredDocumentClass, ToObjectFalseType } from '../../../../../types/helperTypes';
 
+declare global {
   /**
-   * @override
+   * The sidebar directory which organizes and displays world-level Playlist documents.
+   * @typeParam Options - The type of the options object
    */
-  static get defaultOptions(): PlaylistDirectory.Options;
+  class PlaylistDirectory<Options extends SidebarDirectory.Options = SidebarDirectory.Options> extends SidebarDirectory<
+    'Playlist',
+    Options
+  > {
+    constructor(options?: Partial<Options>);
 
-  /**
-   * @override
-   */
-  static get entity(): 'Playlist';
+    /**
+     * Track the playlist IDs which are currently expanded in their display
+     * @internal
+     */
+    protected _expanded: Set<string>;
 
-  /**
-   * @override
-   * @see {@link Game.playlists}
-   */
-  static get collection(): Game['playlists'];
+    /**
+     * Are the global volume controls currently expanded?
+     * @defaultValue `false`
+     * @internal
+     */
+    protected _volumeExpanded: boolean;
 
-  /**
-   * Return an Array of the Playlist entities which are currently playing
-   */
-  get playing(): Playlist[];
+    /**
+     * Cache the set of Playlist documents that are displayed as playing when the directory is rendered
+     * @defaultValue `[]`
+     * @internal
+     */
+    protected _playingPlaylists: InstanceType<ConfiguredDocumentClass<typeof Playlist>>[];
 
-  /**
-   * Prepare the data used to render the AudioList application
-   * @param options - (unused)
-   */
-  getData(options?: Partial<PlaylistDirectory.Options>): PlaylistDirectory.Data;
+    /**
+     * Cache the set of PlaylistSound documents that are displayed as playing when the directory is rendered
+     * @defaultValue `[]`
+     * @internal
+     */
+    protected _playingSounds: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>[];
 
-  /**
-   * Given a constant playback mode, provide the FontAwesome icon used to display it
-   */
-  protected _getModeIcon(mode: foundry.CONST.PlaylistMode): string;
+    /**
+     * @internal
+     * @defaultValue `undefined`
+     * @remarks This is only initialized and set in `getData`.
+     */
+    protected _playingSoundsData?: PlaylistDirectory.Data.Sound[] | undefined;
 
-  /**
-   * Given a constant playback mode, provide the string tooltip used to describe it
-   */
-  protected _getModeTooltip(mode: foundry.CONST.PlaylistMode): string;
+    /** @override */
+    static documentName: 'Playlist';
 
-  /**
-   * @override
-   */
-  activateListeners(html: JQuery): void;
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * const options = super.defaultOptions;
+     * options.dragDrop[0].dragSelector = ".playlist-name";
+     * options.renderUpdateKeys = ["name", "playing", "mode", "sounds", "sort", "sorting", "folder"];
+     * options.contextMenuSelector = ".entity .playlist-header";
+     * return options;
+     * ```
+     */
+    static get defaultOptions(): SidebarDirectory.Options;
 
-  /**
-   * Handle global volume change for the playlist sidebar
-   */
-  protected _onGlobalVolume(event: JQuery.ChangeEvent): void;
+    /**
+     * Initialize the set of Playlists which should be displayed in an expanded form
+     * @internal
+     */
+    protected _createExpandedSet(): Set<string>;
 
-  /**
-   * Handle Playlist collapse toggle
-   */
-  protected _onPlaylistCollapse(event: JQuery.ClickEvent): void;
+    /**
+     * Return an Array of the Playlist entities which are currently playing
+     */
+    get playing(): InstanceType<ConfiguredDocumentClass<typeof Playlist>>[];
 
-  /**
-   * Helper method to render the expansion or collapse of playlists
-   * @param speed - (default: `250`)
-   */
-  protected _collapse(li: JQuery, collapse: boolean, speed: number): void;
+    /** @override */
+    getData(options?: Partial<Options>): PlaylistDirectory.Data;
 
-  /**
-   * Handle Playlist edit action
-   */
-  protected _onPlaylistEdit(event: JQuery.ClickEvent): void;
+    /**
+     * 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;
 
-  /**
-   * Handle Playlist deletion requests
-   * Confirm the deletion with a yes/no dialog prompt
-   */
-  protected _onPlaylistDelete(event: JQuery.ClickEvent): 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;
 
-  /**
-   * Handle Playlist track addition request
-   */
-  protected _onPlaylistAddTrack(event: JQuery.ClickEvent): void;
+    /**
+     * 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;
 
-  /**
-   * Handle Playlist playback state changes
-   */
-  protected _onPlaylistPlay(event: JQuery.ClickEvent, playing: boolean): void;
+    /**
+     * 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;
 
-  /**
-   * Handle cycling the playback mode for a Playlist
-   * @param event - The initial click event
-   */
-  protected _onPlaylistToggleMode(event: JQuery.ClickEvent): void;
+    /**
+     * Given a constant playback mode, provide the FontAwesome icon used to display it
+     * @internal
+     */
+    protected _getModeIcon(mode: foundry.CONST.PlaylistMode): string;
 
-  /**
-   * Handle editing a Sound within a PLaylist
-   * @param event - The initial click event
-   */
-  protected _onSoundEdit(event: JQuery.ClickEvent): void;
+    /**
+     * Given a constant playback mode, provide the string tooltip used to describe it
+     * @internal
+     */
+    protected _getModeTooltip(mode: foundry.CONST.PlaylistMode): string;
 
-  /**
-   * Modify the playback state of a Sound within a Playlist
-   * @param event - The initial click event
-   */
-  protected _onSoundPlay(event: JQuery.ClickEvent, playing: boolean): void;
+    /** @override */
+    activateListeners(html: JQuery): void;
 
-  /**
-   * Handle volume adjustments to sounds within a Playlist
-   * @param event - The initial change event
-   */
-  protected _onSoundVolume(event: JQuery.ChangeEvent): void;
+    /**
+     * Handle global volume change for the playlist sidebar
+     * @param event - The initial change event
+     * @internal
+     */
+    protected _onGlobalVolume(event: JQuery.ChangeEvent): unknown;
 
-  /**
-   * Handle changes to the sound playback mode
-   * @param event - The initial click event
-   */
-  protected _onSoundToggleMode(event: JQuery.ClickEvent): void;
+    /** @override */
+    collapseAll(): void;
 
-  /**
-   * Handle Playlist track deletion request
-   */
-  protected _onSoundDelete(event: JQuery.ClickEvent): void;
+    /**
+     * Handle Playlist collapse toggle
+     * @param event - The initial click event
+     * @internal
+     */
+    protected _onPlaylistCollapse(event: JQuery.ClickEvent): void;
 
-  /**
-   * Handle right click context-menu options on a Playlist or a Sound
-   */
-  protected _contextMenu(html: JQuery): void;
+    /**
+     * Handle global volume control collapse toggle
+     * @param event - The initial click event
+     * @internal
+     */
+    protected _onVolumeCollapse(event: JQuery.ClickEvent): void;
 
-  /**
-   * Get context menu options for individual sound effects
-   * @returns The context options for each sound
-   */
-  protected _getSoundContextOptions(): ContextMenuEntry[];
-}
+    /**
+     * Helper method to render the expansion or collapse of playlists
+     * @param speed - (default: `250`)
+     * @internal
+     */
+    protected _collapse(el: HTMLElement, collapse: boolean, speed?: number): void;
 
-declare namespace PlaylistDirectory {
-  interface Data {
-    user: User;
-    isGM: boolean;
-    entities: PlaylistEntity[];
-    playlistModifier: ReturnType<typeof AudioHelper['volumeToInput']>;
-    ambientModifier: ReturnType<typeof AudioHelper['volumeToInput']>;
-    interfaceModifier: ReturnType<typeof AudioHelper['volumeToInput']>;
-  }
+    /**
+     * 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;
 
-  interface PlaylistEntity extends foundry.utils.Duplicated<Playlist.Data> {
-    modeIcon: string;
-    modeTooltip: string;
-    disabled: boolean;
-    controlCSS: string;
-    expanded: boolean;
-    sounds: Sound[];
-  }
+    /**
+     * 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;
 
-  interface Sound extends foundry.utils.Duplicated<Playlist.Sound> {
-    lvolume: ReturnType<typeof AudioHelper['volumeToInput']>;
-    controlCSS: string;
-  }
+    /**
+     * 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;
 
-  interface Options extends SidebarDirectory.Options {
     /**
-     * @defaultValue The `dragSelector` of the first entry is `'.playlist-name'`.
+     * Modify the playback state of a Sound within a Playlist
+     * @param event  - The initial click event
+     * @param action - The sound control action performed
+     * @internal
      */
-    dragDrop: SidebarDirectory.Options['dragDrop'];
+    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): unknown;
+
+    /** @override */
+    protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
     /**
-     * @defaultValue `['name', 'playing', 'mode']`
+     * Update the displayed timestamps for all currently playing audio sources.
+     * Runs on an interval every 1000ms.
+     * @internal
      */
-    renderUpdateKeys: string[];
+    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;
+
+    /** @override */
+    protected _contextMenu(html: JQuery): void;
+
+    /** @override */
+    protected _getFolderContextOptions(): ContextMenuEntry[];
+
+    /** @override */
+    protected _getEntryContextOptions(): ContextMenuEntry[];
+
+    /**
+     * Get context menu options for individual sound effects
+     * @returns The context options for each sound
+     * @internal
+     */
+    protected _getSoundContextOptions(): ContextMenuEntry[];
+  }
+
+  namespace PlaylistDirectory {
+    interface Data extends SidebarDirectory.Data<PlaylistDirectory.Data.Tree> {
+      playingSounds: PlaylistDirectory.Data.Sound[];
+      showPlaying: boolean;
+      playlistModifier: number;
+      ambientModifier: number;
+      interfaceModifier: number;
+      volumeExpanded: boolean;
+    }
+
+    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/foundry.js/applications/sidebarTabs/sidebarDirectories/sceneDirectory.d.ts

@@ -1,30 +1,13 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
  * A directory listing of active game scenes
  */
-declare class SceneDirectory extends SidebarDirectory {
-  /**
-   * @override
-   */
-  static get entity(): 'Scene';
-
-  /**
-   * @override
-   * @see {@link Game.scenes}
-   */
-  static get collection(): Game['scenes'];
+declare class SceneDirectory extends SidebarDirectory<'Scene'> {
+  /** @override */
+  static documentName: 'Scene';
 
-  /**
-   * @override
-   * @remarks This is never called.
-   */
-  protected _onCreate(event: Event): Promise<Scene>;
+  /** @override */
+  protected _render(force?: boolean, options?: Application.RenderOptions<SidebarDirectory.Options>): Promise<void>;
 
-  /**
-   * @override
-   */
+  /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts

@@ -106,7 +106,7 @@ declare global {
      * This implementation doesn't actually return `PlaylistDirectory.Data`, it's only to allow {@link PlaylistDirectory}
      * to override accordingly.
      */
-    getData(options?: Partial<Options>): SidebarDirectory.Data<this['tree']> | PlaylistDirectory.Data;
+    getData(options?: Partial<Options>): SidebarDirectory.Data<this['tree']>;
 
     /**
      * @param event - (unused)
@@ -168,11 +168,9 @@ declare global {
 
     /**
      * @override
-     * @remarks
-     * The return type could be specified in more detail but it is not supposed to be used and this allows more
-     * flexibility for deriving classes.
+     * @internal
      */
-    protected _onDrop(event: DragEvent): unknown;
+    protected _onDrop(event: DragEvent): void;
 
     /**
      * Handle Document data being dropped into the directory.

package/src/foundry/foundry.js/cameraPopoutAppWrapper.d.ts

@@ -4,9 +4,9 @@
  */
 declare class CameraPopoutAppWrapper {
   /**
-   * @param view- The CameraViews application that this popout belongs to
-   * @param userId- ID of the user this popout belongs to
-   * @param element- The div element of this specific popout window
+   * @param view    - The CameraViews application that this popout belongs to
+   * @param userId  - ID of the user this popout belongs to
+   * @param element - The div element of this specific popout window
    */
   constructor(view: CameraViews, userId: string, element: JQuery);
 
@@ -25,16 +25,21 @@ declare class CameraPopoutAppWrapper {
    */
   userId: string;
 
+  /** @defaultValue `true` */
+  popOut: boolean;
+
+  /** @defaultValue `{}` */
+  options: Record<string, unknown>;
+
   /**
    * Get the current position of this popout window
    */
   get position(): Application.Position;
 
-  /** @override */
-  setPosition({ left, top, width, height, scale }?: Partial<Application.Position>): void;
+  setPosition(options?: Partial<Application.Position>): (Application.Position & { height: number }) | void;
 
-  private _onResize(event: Event): void;
+  /** @internal */
+  protected _onResize(event: Event): void;
 
-  /** @override */
   bringToTop(): void;
 }

package/src/foundry/foundry.js/canvas.d.ts

@@ -399,8 +399,9 @@ declare global {
 
     /**
      * Event handler for the drop portion of a drag-and-drop event.
+     * @internal
      */
-    protected _onDrop(event: DragEvent): unknown;
+    protected _onDrop(event: DragEvent): void;
 
     /**
      * Add a pending canvas operation that should fire once the socket handling workflow concludes.