@league-of-foundry-developers/foundry-vtt-types 9.255.1 → 9.268.0

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

@@ -2,12 +2,20 @@ 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,8 +65,19 @@ declare global {
      */
     _onChatKeyDownBinding: ((event: JQuery.KeyDownEvent) => void) | null;
 
-    /** @override */
-    static get defaultOptions(): ChatLog.Options;
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "chat",
+     *   template: "templates/sidebar/chat-log.html",
+     *   title: game.i18n.localize("CHAT.Title"),
+     *   stream: false
+     * })
+     * ```
+     */
+    static get defaultOptions(): ChatLogOptions;
 
     /**
      * A reference to the Messages collection that the chat log displays
@@ -66,10 +85,10 @@ declare global {
     get collection(): Messages;
 
     /** @override */
-    getData(options?: Partial<ChatLog.Options>): ChatLog.Data;
+    getData(options?: Partial<ChatLogOptions>): ChatLog.Data;
 
     /** @override */
-    protected _render(force?: boolean, options?: Application.RenderOptions<ChatLog.Options>): Promise<void>;
+    protected _render(force?: boolean, options?: Application.RenderOptions<ChatLogOptions>): Promise<void>;
 
     /**
      * @override
@@ -112,12 +131,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
@@ -142,10 +167,18 @@ declare global {
     /** @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
@@ -198,6 +231,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 +254,12 @@ 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
-     */
+    /** @override */
     protected _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 +323,15 @@ declare global {
       | 'gmroll'
       | 'blindroll'
       | 'selfroll'
+      | 'publicroll'
+      | 'ic'
+      | 'ooc'
+      | 'emote'
       | 'whisper'
       | 'reply'
       | 'gm'
       | 'players'
-      | 'ic'
-      | 'emote'
-      | 'ooc'
+      | 'macro'
       | 'invalid'
       | 'none';
 
@@ -302,27 +342,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 +349,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/compendiumDirectory.d.ts

@@ -4,8 +4,12 @@ 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
@@ -13,7 +17,7 @@ declare global {
      * foundry.utils.mergeObject(super.defaultOptions, {
      *   id: "compendium",
      *   template: "templates/sidebar/compendium-directory.html",
-     *   title: "Compendium Packs"
+     *   title: "COMPENDIUM.SidebarTitle"
      * });
      * ```
      */
@@ -23,7 +27,7 @@ declare global {
      * @param options - (unused)
      * @override
      */
-    getData(options?: Partial<Options>): CompendiumDirectory.Data;
+    getData(options?: Partial<Options>): Data | Promise<Data>;
 
     /**
      * @override
@@ -39,22 +43,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/foundry.js/applications/sidebarTabs/settings.d.ts

@@ -5,40 +5,40 @@ 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> extends SidebarTab<Options> {
+  class Settings<
+    Options extends ApplicationOptions = ApplicationOptions,
+    Data extends object = Settings.Data
+  > extends SidebarTab<Options> {
     /**
      * @override
      * @defaultValue
      * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "setting",
-     *   template: "templates/sidebar/settings.html".
-     *   title: "Settings"
-     * })
+     * const options = super.defaultOptions;
+     * options.id = "settings";
+     * options.template = "templates/sidebar/settings.html";
+     * options.title = "Settings";
      * ```
      */
     static get defaultOptions(): ApplicationOptions;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Settings.Data;
+    /** @override */
+    getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /**
-     * @override
-     */
+    /** @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;
   }
@@ -47,10 +47,13 @@ declare global {
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
       system: Game['system'];
-      coreVersion: Game['data']['version'];
+      release: Game['data']['release'];
+      versionDisplay: Game['release']['display'];
       isDemo: boolean;
       canConfigure: boolean;
-      canSetup: boolean;
+      canEditWorld: boolean;
+      canManagePlayers: boolean;
+      canReturnSetup: boolean;
       coreUpdate: string | false;
       systemUpdate: string | false;
       modules: number;

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

@@ -16,9 +16,6 @@ declare class ActorDirectory extends SidebarDirectory<'Actor'> {
   /** @override */
   protected _canDragDrop(selector: string): boolean;
 
-  /** @override */
-  protected _onClickEntityName(event: JQuery.ClickEvent): Promise<void>;
-
   /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }

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

@@ -1,27 +1,13 @@
 /**
  * The sidebar directory which organizes and displays world-level JournalEntry documents.
+ * @typeParam Options - The type of the options object
  */
-declare class JournalDirectory extends SidebarDirectory<'JournalEntry'> {
+declare class JournalDirectory<
+  Options extends SidebarDirectory.Options = SidebarDirectory.Options
+> extends SidebarDirectory<'JournalEntry', Options> {
   /** @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 defaultOptions(): SidebarDirectory.Options;
-
-  /**
-   * @override
-   */
-  get title(): string;
-
   /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }

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

@@ -1,8 +1,8 @@
 /**
  * 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'> {
@@ -10,10 +10,4 @@ declare class MacroDirectory extends SidebarDirectory<'Macro'> {
 
   /** @override */
   static documentName: 'Macro';
-
-  /**
-   * @override
-   * @remarks This is never called.
-   */
-  protected _onCreate(event: Event): Promise<void>;
 }

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

@@ -48,14 +48,21 @@ declare global {
     /** @override */
     static documentName: 'Playlist';
 
+    /**
+     * @override
+     * @defaultValue `'templates/sidebar/playlist-partial.html'`
+     */
+    static 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;
      * ```
      */
@@ -68,12 +75,18 @@ 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>>[];
 
+    /**
+     * 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;
+    getData(options?: Partial<Options>): PlaylistDirectory.Data | Promise<PlaylistDirectory.Data>;
 
     /**
      * Augment the tree directory structure with playlist-level data objects for rendering
@@ -206,7 +219,10 @@ 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;
@@ -241,6 +257,12 @@ declare global {
      * @internal
      */
     protected _getSoundContextOptions(): ContextMenuEntry[];
+
+    /** @override */
+    protected _onDragStart(event: DragEvent): void;
+
+    /** @override */
+    protected _onDrop(event: DragEvent): void;
   }
 
   namespace PlaylistDirectory {
@@ -251,6 +273,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/sceneDirectory.d.ts

@@ -5,6 +5,12 @@ declare class SceneDirectory extends SidebarDirectory<'Scene'> {
   /** @override */
   static documentName: 'Scene';
 
+  /**
+   * @override
+   * @defaultValue `"templates/sidebar/scene-partial.html"`
+   */
+  static documentPartial: string;
+
   /** @override */
   protected _render(force?: boolean, options?: Application.RenderOptions<SidebarDirectory.Options>): Promise<void>;
 

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

@@ -106,7 +106,9 @@ 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']>;
+    getData(
+      options?: Partial<Options>
+    ): SidebarDirectory.Data<this['tree']> | Promise<SidebarDirectory.Data<this['tree']>>;
 
     /**
      * @param event - (unused)

package/src/foundry/foundry.js/applications/supportDetails.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Support Info and Report
+ * @typeParam Options - the type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ */
+declare class SupportDetails<
+  Options extends ApplicationOptions = ApplicationOptions,
+  Data extends object = SupportDetails.Data
+> extends Application<Options> {
+  /**
+   * @override
+   * @defaultValue
+   * ```typescript
+   * const options = super.defaultOptions;
+   * options.title = "SUPPORT.Title";
+   * options.id = "support-details";
+   * options.template = "templates/sidebar/apps/support-details.html";
+   * options.width = 620;
+   * options.height = "auto";
+   * return options;
+   * ```
+   */
+  static get defaultOptions(): ApplicationOptions;
+
+  /**
+   * Returns the support report data
+   */
+  getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
+
+  /**
+   * @override
+   * Binds the Support Report copy button
+   */
+  activateListeners(html: JQuery): void;
+
+  /**
+   * Collects a number of metrics that is useful for Support
+   */
+  static generateSupportReport(): SupportReportData;
+
+  /**
+   * Get a WebGL renderer information string
+   * @param gl - The rendering context
+   * @returns The unmasked renderer string
+   */
+  static getWebGLRendererInfo(gl: WebGLRenderingContext): string;
+}
+
+interface SupportReportData {
+  coreVersion: number;
+  systemVersion: string;
+  activeModuleCount: number;
+  os: string;
+  client: string;
+  gpu: string;
+  maxTextureSize: number | string;
+  sceneDimensions: string;
+  grid: number;
+  padding: number;
+  walls: number;
+  lights: number;
+  sounds: number;
+  tiles: number;
+  tokens: number;
+  actors: number;
+  items: number;
+  journals: number;
+  tables: number;
+  playlists: number;
+  packs: number;
+  messages: number;
+}
+
+declare namespace SupportDetails {
+  interface Data {
+    report: SupportReportData;
+  }
+}

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

@@ -320,7 +320,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
           | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
         >
       | undefined,
-    context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<Dialog.Options>) | undefined
+    context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<DialogOptions>) | undefined
   ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
   /**
@@ -329,7 +329,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    *                  (default: `{}`)
    * @returns A Promise which resolves to the deleted Document
    */
-  deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
+  deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
   /**
    * Export document data to a JSON file which can be saved by the client and later imported into a different session.

package/src/foundry/foundry.js/clientDocuments/cards.d.ts

@@ -30,6 +30,11 @@ declare global {
      */
     get drawnCards(): InstanceType<ConfiguredDocumentClassForName<'Card'>>[];
 
+    /**
+     * Returns the localized Label for the type of Card Stack this is
+     */
+    get typeLabel(): string;
+
     /** @override */
     static createDocuments(
       data: Array<
@@ -182,6 +187,9 @@ declare global {
       userId: string
     ): void;
 
+    /** @override */
+    protected _preDelete(options: DocumentModificationOptions, user: foundry.documents.BaseUser): Promise<void>;
+
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
     /** @override */
     static deleteDocuments<T extends DocumentConstructor>(
@@ -224,7 +232,7 @@ declare global {
     resetDialog(): Promise<InstanceType<ConfiguredDocumentClassForName<'Cards'>> | false | null>;
 
     /** @override */
-    deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
+    deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
     /** @override */
@@ -236,7 +244,7 @@ declare global {
             | (ConstructorDataType<foundry.data.CardsData> & Record<string, unknown>)
           >
         | undefined,
-      context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<Dialog.Options>) | undefined
+      context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<DialogOptions>) | undefined
     ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
   }