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

package/src/foundry/{foundry.js/applications/formApplications/moduleManagement.d.ts → client/apps/sidebar/apps/module-management.d.ts}

@@ -24,7 +24,6 @@ declare class ModuleManagement<
   static CONFIG_SETTING: 'moduleConfiguration';
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * mergeObject(super.defaultOptions, {
@@ -40,22 +39,17 @@ declare class ModuleManagement<
    * });
    * ```
    */
-  static get defaultOptions(): FormApplicationOptions;
+  static override get defaultOptions(): FormApplicationOptions;
 
-  /** @override */
-  get isEditable(): boolean;
+  override get isEditable(): boolean;
 
-  /** @override */
-  getData(options?: Partial<Options>): Data | Promise<Data>;
+  override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
-  /** @override */
-  protected _renderInner(data: Data): Promise<JQuery>;
+  protected override _renderInner(data: Data): Promise<JQuery>;
 
-  /** @override */
-  protected _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<unknown>;
+  protected override _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<unknown>;
 
   /**
    * Handle changes to a module checkbox to prompt for whether or not to enable dependencies
@@ -81,8 +75,7 @@ declare class ModuleManagement<
    */
   protected _onFilterList(event: JQuery.ClickEvent): 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;
 }
 
 declare namespace ModuleManagement {

package/src/foundry/{foundry.js/applications/formApplications/permissionConfig.d.ts → client/apps/sidebar/apps/permission-config.d.ts}

@@ -3,7 +3,6 @@
  */
 declare class PermissionConfig extends FormApplication<FormApplicationOptions, PermissionConfig.Data> {
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * mergeObject(super.defaultOptions, {
@@ -17,21 +16,16 @@ declare class PermissionConfig extends FormApplication<FormApplicationOptions, P
    * })
    * ```
    */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
+  static override get defaultOptions(): typeof FormApplication['defaultOptions'];
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<FormApplicationOptions>): PermissionConfig.Data;
+  override getData(options?: Partial<FormApplicationOptions>): PermissionConfig.Data;
 
   /**
    * Prepare the permissions object used to render the configuration template
    */
   protected _getPermissions(current: Game.Permissions): PermissionConfig.Permission[];
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle button click to reset default settings
@@ -39,17 +33,12 @@ declare class PermissionConfig extends FormApplication<FormApplicationOptions, P
    */
   protected _onResetDefaults(event: JQuery.ClickEvent): void;
 
-  /** @override */
-  protected _onSubmit(
+  protected override _onSubmit(
     event: Event,
     options?: FormApplication.OnSubmitOptions
   ): ReturnType<FormApplication['_onSubmit']>;
 
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<unknown>;
+  protected override _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<unknown>;
 }
 
 declare namespace PermissionConfig {

package/src/foundry/{foundry.js/applications/supportDetails.d.ts → client/apps/sidebar/apps/support-details.d.ts}

@@ -8,7 +8,6 @@ declare class SupportDetails<
   Data extends object = SupportDetails.Data
 > extends Application<Options> {
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * const options = super.defaultOptions;
@@ -20,7 +19,7 @@ declare class SupportDetails<
    * return options;
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
   /**
    * Returns the support report data
@@ -28,10 +27,9 @@ declare class SupportDetails<
   getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
   /**
-   * @override
    * Binds the Support Report copy button
    */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Collects a number of metrics that is useful for Support

package/src/foundry/{foundry.js/applications/formApplications/worldConfig.d.ts → client/apps/sidebar/apps/world-config.d.ts}

@@ -18,7 +18,6 @@ declare class WorldConfig<
   Data extends object = WorldConfig.Data
 > extends FormApplication<Options, Data, Game.WorldData<foundry.packages.WorldData>> {
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -30,24 +29,20 @@ declare class WorldConfig<
    * })
    * ```
    */
-  static get defaultOptions(): WorldConfigOptions;
+  static override get defaultOptions(): WorldConfigOptions;
 
   static WORLD_KB_URL: 'https://foundryvtt.com/article/game-worlds/';
 
-  /** @override */
-  get title(): string;
+  override get title(): string;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
-  /** @override */
-  getData(options?: Partial<Options>): Data | Promise<Data>;
+  override getData(options?: Partial<Options>): Data | Promise<Data>;
 
   /**
    * @remarks This method returns `Promise<void>`.
-   * @override
    */
-  protected _onSubmit(event: Event): Promise<any>;
+  protected override _onSubmit(event: Event): Promise<any>;
 
   /**
    * @remarks This method does not exist on WorldConfig and only exists to make the typescript compile!
@@ -60,8 +55,11 @@ declare class WorldConfig<
    */
   protected _onTitleChange(event: JQuery.TriggeredEvent): void;
 
-  /** @override **/
-  activateEditor(name: string, options?: TextEditor.Options | undefined, initialContent?: string | undefined): void;
+  override activateEditor(
+    name: string,
+    options?: TextEditor.Options | undefined,
+    initialContent?: string | undefined
+  ): void;
 }
 
 declare namespace WorldConfig {

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

@@ -0,0 +1,5 @@
+import './apps';
+import './tabs';
+import './sidebar';
+import './tab-base';
+import './tab-directory';

package/src/foundry/{foundry.js/applications → client/apps/sidebar}/sidebar.d.ts

@@ -17,7 +17,6 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
   protected _collapsed: boolean;
 
   /**
-   * @override
    * @defaultValue
    * ```ts
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -29,7 +28,7 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
    * }
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
   /**
    * Return the name of the active Sidebar tab
@@ -41,17 +40,12 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
    */
   get popouts(): Partial<Record<string, SidebarTab>>;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<Options>): Sidebar.Data;
+  override getData(options?: Partial<Options>): Sidebar.Data;
 
   /**
-   * @override
    * @internal
    */
-  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
   /**
    * Activate a Sidebar tab by it's name
@@ -71,18 +65,12 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
    */
   collapse(): void;
 
-  /**
-   * @override
-   */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
-   * @param event - (unused)
-   * @param tabs - (unused)
-   * @override
    * @internal
    */
-  protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
+  protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
 
   /**
    * Handle the special case of left-clicking a tab when the sidebar is collapsed.

package/src/foundry/{foundry.js/applications/sidebarTab.d.ts → client/apps/sidebar/tab-base.d.ts}

@@ -25,7 +25,6 @@ declare abstract class SidebarTab<
   protected _original: this | null;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -36,21 +35,18 @@ declare abstract class SidebarTab<
    * });
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-  /**  @override */
-  protected _renderInner(data: object): Promise<JQuery>;
+  protected override _renderInner(data: object): Promise<JQuery>;
 
   /**
    * Activate this SidebarTab, switching focus to it
    */
   activate(): void;
 
-  /** @override */
-  close(options?: Application.CloseOptions): Promise<void>;
+  override close(options?: Application.CloseOptions): Promise<void>;
 
   /**
    * Create a second instance of this SidebarTab class which represents a singleton popped-out container

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts → client/apps/sidebar/tab-directory.d.ts}

@@ -1,5 +1,5 @@
 import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DropData } from '../../clientDocumentMixin';
+import { DropData } from '../../data/abstract/client-document';
 
 declare global {
   /**
@@ -30,7 +30,18 @@ declare global {
     static documentName: string;
 
     /**
-     * @override
+     * The path to the template partial which renders a single Document within this directory
+     * @defaultValue `"templates/sidebar/document-partial.html"`
+     */
+    static documentPartial: string;
+
+    /**
+     * The path to the template partial which renders a single Folder within this directory
+     * @defaultValue `"templates/sidebar/folder-partial.html"`
+     */
+    static folderPartial: string;
+
+    /**
      * @defaultValue
      * ```typescript
      * const cls = getDocumentClass(this.documentName);
@@ -48,7 +59,7 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): SidebarDirectory.Options;
+    static override get defaultOptions(): SidebarDirectory.Options;
 
     /**
      * The WorldCollection instance which this Sidebar Directory displays.
@@ -94,27 +105,13 @@ declare global {
       }
     ): [T['folders'], T['documents']];
 
-    /**
-     * @override
-     */
-    render(force?: boolean, context?: SidebarDirectory.RenderContext<Options>): this | void;
+    override render(force?: boolean, context?: SidebarDirectory.RenderContext<Options>): this | void;
 
-    /**
-     * @param options - (unused)
-     * @override
-     * @remarks
-     * This implementation doesn't actually return `PlaylistDirectory.Data`, it's only to allow {@link PlaylistDirectory}
-     * to override accordingly.
-     */
-    getData(
+    override getData(
       options?: Partial<Options>
     ): SidebarDirectory.Data<this['tree']> | Promise<SidebarDirectory.Data<this['tree']>>;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
     /**
      * Collapse all subfolders in this directory
@@ -152,15 +149,11 @@ declare global {
      */
     protected _toggleFolder(event: JQuery.ClickEvent): void;
 
-    /**
-     * @override
-     */
-    protected _onDragStart(event: DragEvent): void;
+    protected override _onDragStart(event: DragEvent): void;
 
     protected _dragType: string;
 
-    /** @override */
-    protected _canDragStart(selector: string): boolean;
+    protected override _canDragStart(selector: string): boolean;
 
     /**
      * Highlight folders as drop targets when a drag event enters or exits their area
@@ -168,11 +161,7 @@ declare global {
      */
     protected _onDragHighlight(event: JQuery.DragEnterEvent | JQuery.DragLeaveEvent): void;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _onDrop(event: DragEvent): void;
+    protected override _onDrop(event: DragEvent): void;
 
     /**
      * Handle Document data being dropped into the directory.

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

@@ -0,0 +1,16 @@
+/**
+ * The sidebar directory which organizes and displays world-level Actor documents.
+ */
+declare class ActorDirectory extends SidebarDirectory<'Actor'> {
+  constructor(...args: ConstructorParameters<typeof SidebarDirectory>);
+
+  static override documentName: 'Actor';
+
+  protected override _canDragStart(selector: string): boolean;
+
+  protected override _onDragStart(event: DragEvent): void;
+
+  protected override _canDragDrop(selector: string): boolean;
+
+  protected override _getEntryContextOptions(): ContextMenuEntry[];
+}

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

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

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

@@ -1,5 +1,5 @@
-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 {
@@ -66,7 +66,6 @@ declare global {
     _onChatKeyDownBinding: ((event: JQuery.KeyDownEvent) => void) | null;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -77,24 +76,18 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): ChatLogOptions;
+    static override get defaultOptions(): ChatLogOptions;
 
     /**
      * A reference to the Messages collection that the chat log displays
      */
     get collection(): Messages;
 
-    /** @override */
-    getData(options?: Partial<ChatLogOptions>): ChatLog.Data;
+    override getData(options?: Partial<ChatLogOptions>): ChatLog.Data;
 
-    /** @override */
-    protected _render(force?: boolean, options?: Application.RenderOptions<ChatLogOptions>): 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
@@ -164,8 +157,7 @@ declare global {
      */
     updateTimestamps(): void;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle dropping of transferred data onto the chat editor
@@ -190,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(
@@ -254,8 +245,7 @@ declare global {
      */
     protected _recall(direction: number): string;
 
-    /** @override */
-    protected _contextMenu(html: JQuery): void;
+    protected override _contextMenu(html: JQuery): void;
 
     /**
      * Get the ChatLog entry context options

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,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -11,7 +11,6 @@ declare global {
     Data extends object = CompendiumDirectory.Data
   > extends SidebarTab<Options> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -21,18 +20,11 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /**
-     * @override
-     */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Compendium sidebar Context Menu creation

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/{foundry.js/applications/sidebarTabs/sidebarDirectories/journalDirectory.d.ts → client/apps/sidebar/tabs/journal-directory.d.ts}

@@ -5,9 +5,7 @@
 declare class JournalDirectory<
   Options extends SidebarDirectory.Options = SidebarDirectory.Options
 > extends SidebarDirectory<'JournalEntry', Options> {
-  /** @override */
-  static documentName: 'JournalEntry';
+  static override documentName: 'JournalEntry';
 
-  /** @override */
-  protected _getEntryContextOptions(): ContextMenuEntry[];
+  protected override _getEntryContextOptions(): ContextMenuEntry[];
 }

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

@@ -8,6 +8,5 @@
 declare class MacroDirectory extends SidebarDirectory<'Macro'> {
   constructor(options?: Partial<SidebarDirectory.Options>);
 
-  /** @override */
-  static documentName: 'Macro';
+  static override documentName: 'Macro';
 }