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

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

@@ -22,7 +22,6 @@ declare class KeybindingsConfig<
   protected _pendingEdits: Map<string, KeybindingsConfig.PendingBinding[]>;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -37,13 +36,9 @@ declare class KeybindingsConfig<
    * })
    * ```
    */
-  static get defaultOptions(): FormApplicationOptions;
+  static override get defaultOptions(): FormApplicationOptions;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<Options>): Data;
+  override getData(options?: Partial<Options>): Data;
 
   /**
    * Builds the set of Bindings into a form usable for display and configuration
@@ -98,8 +93,7 @@ declare class KeybindingsConfig<
    */
   protected _categorizeAction(action: KeybindingsConfig): KeybindingsConfig.BaseCategory;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle left-click events to filter to a certain category
@@ -195,11 +189,7 @@ declare class KeybindingsConfig<
    */
   protected _onKeydownBindingInput(event: KeyboardEvent): void;
 
-  /**
-   * @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;
 
   /** @remarks KeybindingsConfig does not implement this method. */
   protected _updateObject(event?: unknown, formData?: unknown): Promise<never>;

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

@@ -5,36 +5,25 @@
  * @typeParam Options - The type of the options object
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
-
 declare class ModuleManagement<
   Options extends FormApplicationOptions = FormApplicationOptions,
   Data extends object = ModuleManagement.Data
 > extends FormApplication<Options, Data, undefined> {
-  /**
-   * @defaultValue `'all'`
-   * @internal
-   */
+  /** @internal */
   protected _filter: ModuleManagement.FilterName;
 
   /**
-   * @defaultValue `false`
+   * @defaultValue `true`
    * @internal
    */
   protected _expanded: boolean;
 
-  /**
-   * @defaultValue `{}`
-   * @internal
-   */
-  protected _checked: Record<string, boolean>;
-
   /**
    * The named game setting which persists module configuration.
    */
   static CONFIG_SETTING: 'moduleConfiguration';
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * mergeObject(super.defaultOptions, {
@@ -50,28 +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
-   * @param event - (unused)
-   */
-  protected _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<Record<string, boolean>>;
+  protected override _renderInner(data: Data): Promise<JQuery>;
 
-  /**
-   * Restores the Form UI to the internal checked state
-   * @internal
-   */
-  protected _restoreCheckboxState(): void;
+  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
@@ -97,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 {
@@ -117,11 +94,11 @@ declare namespace ModuleManagement {
       count: number;
     }
 
-    type Module = foundry.packages.ModuleData['_source'] & {
+    type Module = Exclude<foundry.packages.ModuleData['_source'], 'authors'> & {
       active: boolean;
       availability: number;
       data: foundry.packages.ModuleData;
-      css: ' active' | '';
+      css: string;
       hasPacks: boolean;
       hasScripts: boolean;
       hasStyles: boolean;
@@ -130,6 +107,8 @@ declare namespace ModuleManagement {
       dependencies: string[] | null;
       unavailable?: string;
       incompatible?: string;
+      authors: string | undefined;
+      labels: string;
     };
   }
 

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<void>;
+  protected override _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<unknown>;
 }
 
 declare namespace PermissionConfig {

package/src/foundry/client/apps/sidebar/apps/support-details.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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> {
+  /**
+   * @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 override get defaultOptions(): ApplicationOptions;
+
+  /**
+   * Returns the support report data
+   */
+  getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
+
+  /**
+   * Binds the Support Report copy button
+   */
+  override 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/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,25 +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(options?: Partial<Options>): SidebarDirectory.Data<this['tree']>;
+    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
@@ -150,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
@@ -166,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';
 }