@league-of-foundry-developers/foundry-vtt-types 9.255.3 → 9.268.2

package/src/foundry/{foundry.js/applications/sidebarTabs/chatLog.d.ts → client/apps/sidebar/tabs/chat-log.d.ts}

@@ -1,13 +1,21 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import type { ChatMessageDataConstructorData } from '../../../common/data/data.mjs/chatMessageData';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ChatMessageDataConstructorData } from '../../../../common/data/data.mjs/chatMessageData';
 
 declare global {
+  interface ChatLogOptions extends ApplicationOptions {
+    /**
+     * Is this chat log being rendered as part of the stream view?
+     * @defaultValue `false`
+     */
+    stream: boolean;
+  }
+
   /**
    * The sidebar directory which organizes and displays world-level ChatMessage documents.
    * @see {@link Sidebar}
    */
-  class ChatLog extends SidebarTab<ChatLog.Options> {
-    constructor(options?: Partial<ChatLog.Options>);
+  class ChatLog extends SidebarTab<ChatLogOptions> {
+    constructor(options?: Partial<ChatLogOptions>);
 
     /**
      * Track any pending text which the user has submitted in the chat log textarea
@@ -57,25 +65,29 @@ declare global {
      */
     _onChatKeyDownBinding: ((event: JQuery.KeyDownEvent) => void) | null;
 
-    /** @override */
-    static get defaultOptions(): ChatLog.Options;
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "chat",
+     *   template: "templates/sidebar/chat-log.html",
+     *   title: game.i18n.localize("CHAT.Title"),
+     *   stream: false
+     * })
+     * ```
+     */
+    static override get defaultOptions(): ChatLogOptions;
 
     /**
      * A reference to the Messages collection that the chat log displays
      */
     get collection(): Messages;
 
-    /** @override */
-    getData(options?: Partial<ChatLog.Options>): ChatLog.Data;
+    override getData(options?: Partial<ChatLogOptions>): ChatLog.Data;
 
-    /** @override */
-    protected _render(force?: boolean, options?: Application.RenderOptions<ChatLog.Options>): Promise<void>;
+    protected override _render(force?: boolean, options?: Application.RenderOptions<ChatLogOptions>): Promise<void>;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _renderInner(data: ChatLog.Data): Promise<JQuery>;
+    protected override _renderInner(data: ChatLog.Data): Promise<JQuery>;
 
     /**
      * Render a batch of additional messages, prepending them to the top of the log
@@ -112,12 +124,18 @@ declare global {
 
     /**
      * Post a single chat message to the log
-     * @param message - A ChatMessage entity instance to post to the log
+     * @param message - A ChatMessage document instance to post to the log
      * @param notify  - Trigger a notification which shows the log as having a new unread message
      *                  (default: `false`)
+     * @param options - Additional options for how the message is posted to the log
+     *                  (default: `{}`)
      * @returns A Promise which resolves once the message is posted
      */
-    postOne(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, notify?: boolean): Promise<void>;
+    postOne(
+      message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>,
+      notify?: boolean | undefined,
+      options?: ChatLog.PostOneOptions | undefined
+    ): Promise<void>;
 
     /**
      * Scroll the chat log to the bottom
@@ -139,13 +157,20 @@ declare global {
      */
     updateTimestamps(): void;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * Handle dropping of transferred data onto the chat editor
+     * @param event - The originating drop event which triggered the data transfer
+     * @internal
+     */
+    protected static _onDropTextAreaData(event: DragEvent): void;
 
     /**
      * Prepare the data object of chat message data depending on the type of message being posted
      * @param message - The original string of the message content
-     * @returns A Promise resolving to the prepared chat data object
+     * @returns A Promise resolving to the prepared chat data object, or void if we were executing
+     *          a macro instead.
      */
     protected processMessage(
       message: string
@@ -157,7 +182,6 @@ declare global {
      * @param match         - The matched RegExp expressions
      * @param chatData      - The initial chat data
      * @param createOptions - Options used to create the message
-     *                        (unused)
      * @internal
      */
     protected _processDiceCommand(
@@ -198,6 +222,14 @@ declare global {
       createOptions: DocumentModificationContext
     ): void;
 
+    /**
+     * Process messages which execute a macro.
+     * @param command - The chat command typed.
+     * @param match   - The RegExp matches.
+     * @internal
+     */
+    protected _processMacroCommand(command: string, match: RegExpMatchArray): void;
+
     /**
      * Add a sent message to an array of remembered messages to be re-sent if the user pages up with the up arrow key
      * @param message - The message text being remembered
@@ -213,15 +245,11 @@ declare global {
      */
     protected _recall(direction: number): string;
 
-    /**
-     * Attach context menu options to messages in the chat log.
-     * @param html - The HTML element to which context options are attached
-     */
-    protected _contextMenu(html: JQuery): void;
+    protected override _contextMenu(html: JQuery): void;
 
     /**
      * Get the ChatLog entry context options
-     * @returns The sidebar entry context options
+     * @returns The ChatLog entry context options
      * @internal
      */
     protected _getEntryContextOptions(): ContextMenuEntry[];
@@ -285,13 +313,15 @@ declare global {
       | 'gmroll'
       | 'blindroll'
       | 'selfroll'
+      | 'publicroll'
+      | 'ic'
+      | 'ooc'
+      | 'emote'
       | 'whisper'
       | 'reply'
       | 'gm'
       | 'players'
-      | 'ic'
-      | 'emote'
-      | 'ooc'
+      | 'macro'
       | 'invalid'
       | 'none';
 
@@ -302,27 +332,6 @@ declare global {
       isStream: boolean;
     }
 
-    interface Options extends ApplicationOptions {
-      /**
-       * @defaultValue `'chat'`
-       */
-      id: string;
-
-      /**
-       * @defaultValue `'templates/sidebar/chat-log.html'`
-       */
-      template: string;
-
-      title: string;
-
-      scrollContainer: null;
-
-      /**
-       * @defaultValue `false`
-       */
-      stream: boolean;
-    }
-
     interface ScrollBottomOptions {
       /**
        * If a popout exists, scroll it too
@@ -330,5 +339,13 @@ declare global {
        */
       popout?: boolean;
     }
+
+    interface PostOneOptions {
+      /**
+       * An existing message ID to append the message before, by default the new message is
+       * appended to the end of the log.
+       */
+      before?: string | undefined;
+    }
   }
 }

package/src/foundry/{foundry.js/applications/sidebarTabs/combatTracker.d.ts → client/apps/sidebar/tabs/combat-tracker.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -38,8 +38,7 @@ declare global {
      */
     get combats(): StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>>[];
 
-    /** @override */
-    createPopout(): this;
+    override createPopout(): this;
 
     /**
      * Initialize the combat tracker to display a specific combat encounter.
@@ -56,11 +55,9 @@ declare global {
      */
     scrollToTurn(): void;
 
-    /** @override */
-    getData(options?: Partial<Options>): Promise<CombatTracker.Data>;
+    override getData(options?: Partial<Options>): Promise<CombatTracker.Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle new Combat creation request

package/src/foundry/{foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts → client/apps/sidebar/tabs/compendium-directory.d.ts}

@@ -1,34 +1,30 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
    * A compendium of knowledge arcane and mystical!
    * @typeParam Options - The type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
    */
-  class CompendiumDirectory<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
+  class CompendiumDirectory<
+    Options extends ApplicationOptions = ApplicationOptions,
+    Data extends object = CompendiumDirectory.Data
+  > extends SidebarTab<Options> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
      *   id: "compendium",
      *   template: "templates/sidebar/compendium-directory.html",
-     *   title: "Compendium Packs"
+     *   title: "COMPENDIUM.SidebarTitle"
      * });
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): CompendiumDirectory.Data;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /**
-     * @override
-     */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Compendium sidebar Context Menu creation
@@ -39,22 +35,32 @@ declare global {
     /**
      * Get the sidebar directory entry context options
      * @returns The sidebar entry context options
+     * @internal
      */
     protected _getEntryContextOptions(): ContextMenuEntry[];
 
     /**
      * Handle a Compendium Pack creation request
      * @param event - The originating click event
+     * @internal
      */
     protected _onCreateCompendium(event: JQuery.ClickEvent): 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>;
+
+    /**
+     * Toggle the compendium entry open/closed state in the sidebar.
+     * @param pack - The name of the compendium pack.
+     * @internal
+     */
+    protected _toggleOpenState(pack: string): void;
   }
 
   namespace CompendiumDirectory {

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * The sidebar directory which organizes and displays world-level Item documents.
+ */
+declare class ItemDirectory extends SidebarDirectory<'Item'> {
+  static override documentName: 'Item';
+
+  protected override _canDragDrop(selector: string): boolean;
+
+  protected override _getEntryContextOptions(): ContextMenuEntry[];
+}

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

@@ -0,0 +1,11 @@
+/**
+ * The sidebar directory which organizes and displays world-level JournalEntry documents.
+ * @typeParam Options - The type of the options object
+ */
+declare class JournalDirectory<
+  Options extends SidebarDirectory.Options = SidebarDirectory.Options
+> extends SidebarDirectory<'JournalEntry', Options> {
+  static override documentName: 'JournalEntry';
+
+  protected override _getEntryContextOptions(): ContextMenuEntry[];
+}

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectories/macroDirectory.d.ts → client/apps/sidebar/tabs/macros-directory.d.ts}

@@ -1,19 +1,12 @@
 /**
  * The directory, not displayed in the sidebar, which organizes and displays world-level Macro documents.
  *
- * @see {@link Macros}        The WorldCollection of Macro Entities
- * @see {@link Macro}         The Macro Entity
+ * @see {@link Macros}        The WorldCollection of Macro Documents
+ * @see {@link Macro}         The Macro Document
  * @see {@link MacroConfig}   The Macro Configuration Sheet
  */
 declare class MacroDirectory extends SidebarDirectory<'Macro'> {
   constructor(options?: Partial<SidebarDirectory.Options>);
 
-  /** @override */
-  static documentName: 'Macro';
-
-  /**
-   * @override
-   * @remarks This is never called.
-   */
-  protected _onCreate(event: Event): Promise<void>;
+  static override documentName: 'Macro';
 }

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts → client/apps/sidebar/tabs/playlists-directory.d.ts}

@@ -45,21 +45,25 @@ declare global {
      */
     protected _playingSoundsData?: PlaylistDirectory.Data.Sound[] | undefined;
 
-    /** @override */
-    static documentName: 'Playlist';
+    static override documentName: 'Playlist';
+
+    /**
+     * @defaultValue `'templates/sidebar/playlist-partial.html'`
+     */
+    static override documentPartial: string;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * const options = super.defaultOptions;
-     * options.dragDrop[0].dragSelector = ".playlist-name";
+     * 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 = ".entity .playlist-header";
+     * options.contextMenuSelector = ".document .playlist-header";
      * return options;
      * ```
      */
-    static get defaultOptions(): SidebarDirectory.Options;
+    static override get defaultOptions(): SidebarDirectory.Options;
 
     /**
      * Initialize the set of Playlists which should be displayed in an expanded form
@@ -68,12 +72,17 @@ declare global {
     protected _createExpandedSet(): Set<string>;
 
     /**
-     * Return an Array of the Playlist entities which are currently playing
+     * Return an Array of the Playlist documents which are currently playing
      */
     get playing(): InstanceType<ConfiguredDocumentClass<typeof Playlist>>[];
 
-    /** @override */
-    getData(options?: Partial<Options>): PlaylistDirectory.Data;
+    /**
+     * 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
@@ -122,8 +131,7 @@ declare global {
      */
     protected _getModeTooltip(mode: foundry.CONST.PLAYLIST_MODES): string;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle global volume change for the playlist sidebar
@@ -132,8 +140,7 @@ declare global {
      */
     protected _onGlobalVolume(event: JQuery.ChangeEvent): unknown;
 
-    /** @override */
-    collapseAll(): void;
+    override collapseAll(): void;
 
     /**
      * Handle Playlist collapse toggle
@@ -206,10 +213,12 @@ declare global {
      * @param event - The initial click event
      * @internal
      */
-    protected _onSoundToggleMode(event: JQuery.ClickEvent): unknown;
+    protected _onSoundToggleMode(event: JQuery.ClickEvent): void;
+
+    /** @internal */
+    protected _onPlayingPin(): void;
 
-    /** @override */
-    protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
     /**
      * Update the displayed timestamps for all currently playing audio sources.
@@ -226,14 +235,11 @@ declare global {
      */
     protected _formatTimestamp(seconds: number): string;
 
-    /** @override */
-    protected _contextMenu(html: JQuery): void;
+    protected override _contextMenu(html: JQuery): void;
 
-    /** @override */
-    protected _getFolderContextOptions(): ContextMenuEntry[];
+    protected override _getFolderContextOptions(): ContextMenuEntry[];
 
-    /** @override */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
+    protected override _getEntryContextOptions(): ContextMenuEntry[];
 
     /**
      * Get context menu options for individual sound effects
@@ -241,6 +247,10 @@ declare global {
      * @internal
      */
     protected _getSoundContextOptions(): ContextMenuEntry[];
+
+    protected override _onDragStart(event: DragEvent): void;
+
+    protected override _onDrop(event: DragEvent): void;
   }
 
   namespace PlaylistDirectory {
@@ -251,6 +261,17 @@ declare global {
       ambientModifier: number;
       interfaceModifier: number;
       volumeExpanded: boolean;
+      currentlyPlaying: {
+        class: `location-${'top' | 'bottom'}`;
+        location: {
+          top: boolean;
+          bottom: boolean;
+        };
+        pin: {
+          label: string;
+          caret: 'down' | 'up';
+        };
+      };
     }
 
     namespace Data {

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectories/rollTableDirectory.d.ts → client/apps/sidebar/tabs/roll-table-directory.d.ts}

@@ -5,6 +5,5 @@
 declare class RollTableDirectory<
   Options extends SidebarDirectory.Options = SidebarDirectory.Options
 > extends SidebarDirectory<'RollTable', Options> {
-  /** @override */
-  static documentName: 'RollTable';
+  static override documentName: 'RollTable';
 }

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

@@ -0,0 +1,18 @@
+/**
+ * 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

@@ -0,0 +1,85 @@
+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
+   */
+  class FrameViewer extends Application {
+    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<ApplicationOptions>): Promise<{ src: string }>;
+
+    override close(options?: Application.CloseOptions): ReturnType<Application['close']>;
+  }
+}