@league-of-foundry-developers/foundry-vtt-types 0.8.9-7 → 9.238.1

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

@@ -1,89 +1,108 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * Top menu scene navigation
- */
-declare class SceneNavigation extends Application {
-  /**
-   * Assign the default options which are supported by the SceneNavigation UI
-   * @defaultValue
-   * ```typescript
-   * {
-   *   ...super.defaultOptions,
-   *   id: 'navigation',
-   *   template: 'templates/hud/navigation.html',
-   *   popOut: false,
-   *   dragDrop: [{dragSelector: ".scene"}]
-   * }
-   * ```
-   */
-  static get defaultOptions(): typeof Application['defaultOptions'];
+import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../types/helperTypes';
 
+declare global {
   /**
-   * Return an Array of Scenes which are displayed in the Navigation bar
+   * The UI element which displays the Scene documents which are currently enabled for quick navigation.
+   *
+   * @typeParam Options - the type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
    */
-  get scenes(): Scene[];
+  class SceneNavigation<
+    Options extends Application.Options = Application.Options,
+    Data extends object = SceneNavigation.Data
+  > extends Application<Options> {
+    constructor(options?: Partial<Options>);
 
-  /** @override */
-  render(force?: boolean, options?: Application.RenderOptions): this | undefined;
+    /**
+     * Navigation collapsed state
+     * @internal
+     */
+    protected _collapsed: boolean;
 
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions): Promise<void>;
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "navigation",
+     *   template: "templates/hud/navigation.html",
+     *   popOut: false,
+     *   dragDrop: [{ dragSelector: ".scene" }],
+     * })
+     * ```
+     */
+    static get defaultOptions(): Application.Options;
 
-  /** @override */
-  getData(options?: Partial<Application.Options>): SceneNavigation.Data | Promise<SceneNavigation.Data>;
+    /**
+     * Return an Array of Scenes which are displayed in the Navigation bar
+     */
+    get scenes(): InstanceType<ConfiguredDocumentClassForName<'Scene'>>[];
 
-  /**
-   * Expand the SceneNavigation menu, sliding it down if it is currently collapsed
-   */
-  expand(): Promise<boolean>;
+    /** @override */
+    render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
 
-  /**
-   * Collapse the SceneNavigation menu, sliding it up if it is currently expanded
-   */
-  collapse(): Promise<boolean>;
+    /** @override */
+    protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-  /**
-   * Activate Scene Navigation event listeners
-   */
-  activateListeners(html: JQuery): void;
+    /** @override */
+    getData(options?: Partial<Application.Options>): Data | Promise<Data>;
 
-  /**
-   * Get the set of ContextMenu options which should be applied for Scenes in the menu
-   */
-  private _getContextMenuOptions(): ContextMenuEntry[];
+    /**
+     * Expand the SceneNavigation menu, sliding it down if it is currently collapsed
+     */
+    expand(): Promise<boolean>;
 
-  /**
-   * Handle left-click events on the scenes in the navigation menu
-   */
-  private _onClickScene(event: JQuery.ClickEvent): void;
+    /**
+     * Collapse the SceneNavigation menu, sliding it up if it is currently expanded
+     */
+    collapse(): Promise<boolean>;
 
-  /** @override */
-  protected _onDragStart(event: DragEvent): void;
+    /** @override */
+    activateListeners(html: JQuery): void;
 
-  /** @override */
-  protected _onDrop(event: DragEvent): Promise<boolean | undefined | void>;
+    /**
+     * Get the set of ContextMenu options which should be applied for Scenes in the menu
+     * @returns The Array of context options passed to the ContextMenu instance
+     * @internal
+     */
+    protected _getContextMenuOptions(): ContextMenuEntry[];
 
-  /** @override */
-  private _onToggleNav(event: JQuery.ClickEvent): void;
+    /**
+     * Handle left-click events on the scenes in the navigation menu
+     * @internal
+     */
+    protected _onClickScene(event: JQuery.ClickEvent): void;
 
-  /**
-   * Updated the loading progress bar
-   * @param context - The message to display in the progress back
-   * @param pct     - The percentage the progress bar has completed
-   */
-  static _onLoadProgress(context: string, pct: number): void;
-}
+    /**
+     * @override
+     * @internal
+     */
+    protected _onDragStart(event: DragEvent): void;
+
+    /**
+     * @override
+     * @internal
+     */
+    protected _onDrop(event: DragEvent): void;
+
+    /**
+     * Handle navigation menu toggle click events
+     * @internal
+     */
+    protected _onToggleNav(event: JQuery.ClickEvent): void;
+
+    static _onLoadProgress(context: string, pct: number): void;
+  }
 
-declare namespace SceneNavigation {
-  interface Data {
-    collapsed: boolean;
-    scenes: (foundry.utils.Duplicated<Scene['data']> & {
-      users: { letter: string; color: User['data']['color'] };
-      visible: boolean;
-      css: [string | null];
-    })[];
+  namespace SceneNavigation {
+    interface Data {
+      collapsed: boolean;
+      scenes: (ToObjectFalseType<foundry.data.SceneData> & {
+        name: string;
+        users: { letter: string; color: string };
+        visible: boolean;
+        css: string;
+      })[];
+    }
   }
 }

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

@@ -8,7 +8,7 @@ declare abstract class SidebarTab<
   constructor(...args: ConstructorParameters<typeof Application>);
   /**
    * The base name of this sidebar tab
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   tabName: string;
 

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

@@ -1,4 +1,5 @@
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { ChatMessageDataConstructorData } from '../../../common/data/data.mjs/chatMessageData.js';
 
 declare global {
   /**
@@ -162,7 +163,7 @@ declare global {
     protected _processDiceCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -178,7 +179,7 @@ declare global {
     protected _processWhisperCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -193,7 +194,7 @@ declare global {
     protected _processChatCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -275,7 +276,7 @@ declare global {
      * @param mode - The new roll mode setting
      * @internal
      */
-    protected static _setRollMode(mode: foundry.CONST.DiceRollMode): void;
+    protected static _setRollMode(mode: foundry.CONST.DICE_ROLL_MODES): void;
   }
 
   namespace ChatLog {
@@ -296,7 +297,7 @@ declare global {
 
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      rollMode: foundry.CONST.DiceRollMode;
+      rollMode: foundry.CONST.DICE_ROLL_MODES;
       rollModes: typeof CONFIG['Dice']['rollModes'];
       isStream: boolean;
     }

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

@@ -60,10 +60,10 @@ declare global {
   namespace CompendiumDirectory {
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      packs: { [DocumentName in foundry.CONST.CompendiumEntityType]?: PackData<DocumentName> };
+      packs: { [DocumentName in foundry.CONST.COMPENDIUM_DOCUMENT_TYPES]?: PackData<DocumentName> };
     }
 
-    interface PackData<DocumentName extends foundry.CONST.CompendiumEntityType> {
+    interface PackData<DocumentName extends foundry.CONST.COMPENDIUM_DOCUMENT_TYPES> {
       label: DocumentName;
       packs: CompendiumCollection<CompendiumCollection.Metadata & { entity: DocumentName }>[];
     }

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

@@ -1,67 +1,24 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
- * A directory list of Actor entities in the Sidebar
- * @see {@link Actor}
+ * The sidebar directory which organizes and displays world-level Actor documents.
  */
-declare class ActorDirectory extends SidebarDirectory {
-  /**
-   * @override
-   */
-  static get entity(): 'Actor';
-
-  /**
-   * @override
-   * @see {@link Game.actors}
-   */
-  static get collection(): Game['actors'];
+declare class ActorDirectory extends SidebarDirectory<'Actor'> {
+  constructor(...args: ConstructorParameters<typeof SidebarDirectory>);
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<SidebarDirectory.Options>): ActorDirectory.Data;
+  /** @override */
+  static documentName: 'Actor';
 
-  /**
-   * @param selector - (unused)
-   * @override
-   */
-  protected _canDragStart(selector: string | null): boolean;
+  /** @override */
+  protected _canDragStart(selector: string): boolean;
 
-  /**
-   * @override
-   */
-  protected _onDragStart(event: DragEvent): false | void;
+  /**  @override */
+  protected _onDragStart(event: DragEvent): void;
 
-  /**
-   * @param selector - (unused)
-   * @override
-   */
-  protected _canDragDrop(selector: string | null): boolean;
+  /** @override */
+  protected _canDragDrop(selector: string): boolean;
 
-  /**
-   * @override
-   */
+  /** @override */
   protected _onClickEntityName(event: JQuery.ClickEvent): Promise<void>;
 
-  /**
-   * @override
-   */
+  /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }
-
-declare namespace ActorDirectory {
-  interface Data extends SidebarDirectory.Data {
-    /**
-     * @defaultValue `'templates/sidebar/folder-partial.html'`
-     */
-    folderPartial: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/actor-partial.html'`
-     */
-    entityPartial: string;
-  }
-}

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

@@ -0,0 +1,7 @@
+/**
+ * The sidebar directory which organizes and displays world-level Cards documents.
+ */
+declare class CardsDirectory extends SidebarDirectory<'Cards'> {
+  /** @override */
+  static documentName: 'Cards';
+}

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

@@ -1,4 +1,5 @@
 import './actorDirectory';
+import './cardsDirectory';
 import './itemDirectory';
 import './journalDirectory';
 import './macroDirectory';

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

@@ -1,36 +1,13 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
- * A directory of Item entities in the Sidebar
+ * The sidebar directory which organizes and displays world-level Item documents.
  */
-declare class ItemDirectory extends SidebarDirectory {
-  /**
-   * @override
-   */
-  static get entity(): 'Item';
-
-  /**
-   * @override
-   * @see {@link Game.items}
-   */
-  static get collection(): Game['items'];
-
-  /**
-   * @param selector - (unused)
-   * @override
-   */
-  protected _canDragStart(selector: string | null): boolean;
+declare class ItemDirectory extends SidebarDirectory<'Item'> {
+  /** @override */
+  static documentName: 'Item';
 
-  /**
-   * @param selector - (unused)
-   * @override
-   */
-  protected _canDragDrop(selector: string | null): boolean;
+  /** @override */
+  protected _canDragDrop(selector: string): boolean;
 
-  /**
-   * @override
-   */
+  /** @override */
   protected _getEntryContextOptions(): ContextMenuEntry[];
 }

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

@@ -114,13 +114,13 @@ declare global {
      * Given a constant playback mode, provide the FontAwesome icon used to display it
      * @internal
      */
-    protected _getModeIcon(mode: foundry.CONST.PlaylistMode): string;
+    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.PlaylistMode): string;
+    protected _getModeTooltip(mode: foundry.CONST.PLAYLIST_MODES): string;
 
     /** @override */
     activateListeners(html: JQuery): void;

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

@@ -8,7 +8,7 @@ declare global {
    * @typeParam Options - The type of the options object
    */
   abstract class SidebarDirectory<
-    Name extends foundry.CONST.EntityType | 'FogExploration',
+    Name extends foundry.CONST.DOCUMENT_TYPES | 'FogExploration',
     Options extends SidebarDirectory.Options = SidebarDirectory.Options
   > extends SidebarTab<Options> {
     constructor(options?: Partial<SidebarDirectory.Options>);
@@ -54,7 +54,7 @@ declare global {
      * The WorldCollection instance which this Sidebar Directory displays.
      */
     static get collection(): WorldCollection<
-      ConfiguredDocumentClassForName<foundry.CONST.EntityType | 'FogExploration'>,
+      ConfiguredDocumentClassForName<foundry.CONST.DOCUMENT_TYPES | 'FogExploration'>,
       string
     >;
 
@@ -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/avSettings.d.ts

@@ -116,22 +116,22 @@ declare class AVSettings {
       type: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       url: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       room: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       username: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       password: string;
     };
@@ -143,17 +143,17 @@ declare class AVSettings {
       type: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       url: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       username: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       password: string;
     };