@league-of-foundry-developers/foundry-vtt-types 0.8.9-4 → 0.8.9-8

package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts

@@ -1,82 +1,72 @@
-/**
- * Wall Configuration Sheet
- */
-declare class WallConfig<P extends WallConfig.Options = WallConfig.Options> extends FormApplication<
-  P,
-  WallConfig.Data,
-  Wall
-> {
-  /**
-   * @param object  - The Wall object for which settings are being configured
-   * @param options - Additional options which configure the rendering of the configuration sheet.
-   */
-  constructor(object: Wall, options?: Partial<P>);
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
+declare global {
   /**
-   * @defaultValue
-   * ```typescript
-   * const options = super.defaultOptions;
-   * options.id = "wall-config";
-   * options.title = "Wall Configuration";
-   * options.template = "templates/scene/wall-config.html";
-   * options.width = 400;
-   * options.editTargets = [];
-   * ```
+   * The Application responsible for configuring a single Wall document within a parent Scene.
+   * @typeParam Options - The type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
    */
-  static get defaultOptions(): WallConfig.Options;
+  class WallConfig<
+    Options extends FormApplication.Options = FormApplication.Options,
+    Data extends object = WallConfig.Data<Options>
+  > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Wall'>>> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * const options = super.defaultOptions;
+     * options.id = "wall-config";
+     * options.title = "Wall Configuration";
+     * options.template = "templates/scene/wall-config.html";
+     * options.width = 400;
+     * ```
+     */
+    static get defaultOptions(): FormApplication.Options;
 
-  /**
-   * Provide a dynamically rendered title for the Wall Configuration sheet
-   */
-  get title(): string;
+    /** @override */
+    get title(): string;
 
-  /**
-   * Construct and return the data object used to render the HTML template for this form application.
-   */
-  getData(): WallConfig.Data;
+    /** @override */
+    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
 
-  /**
-   * This method is called upon form submission after form data is validated
-   * @param event    - The initial triggering submission event
-   * @param formData - The object of validated form data with which to update the object
-   */
-  protected _updateObject(event: Event, formData: WallConfig.FormData): Promise<Wall>;
-}
+    /** @override */
+    getData(): Data | Promise<Data>;
 
-declare namespace WallConfig {
-  interface Data {
-    object: foundry.utils.Duplicated<WallConfig['object']['data']>;
-    options: WallConfig['options'];
-    moveTypes: {
-      [Key in keyof typeof foundry.CONST['WALL_MOVEMENT_TYPES'] as typeof foundry.CONST['WALL_MOVEMENT_TYPES'][Key]]: Titlecase<Key>;
-    };
-    senseTypes: {
-      [Key in keyof typeof foundry.CONST['WALL_SENSE_TYPES'] as typeof foundry.CONST['WALL_SENSE_TYPES'][Key]]: Titlecase<Key>;
-    };
-    dirTypes: {
-      [Key in keyof typeof foundry.CONST['WALL_DIRECTIONS'] as typeof foundry.CONST['WALL_DIRECTIONS'][Key]]: Titlecase<Key>;
-    };
-    doorTypes: {
-      [Key in keyof typeof foundry.CONST['WALL_DOOR_TYPES'] as typeof foundry.CONST['WALL_DOOR_TYPES'][Key]]: Titlecase<Key>;
-    };
-    doorStates: {
-      [Key in keyof typeof foundry.CONST['WALL_DOOR_STATES'] as typeof foundry.CONST['WALL_DOOR_STATES'][Key]]: Titlecase<Key>;
-    };
-    isDoor: boolean;
+    /** @override */
+    protected _updateObject(
+      event: Event,
+      formData: WallConfig.FormData
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Wall'>> | undefined>;
   }
 
-  interface FormData {
-    dir: foundry.CONST.WallDirection;
-    door: Wall['data']['door'];
-    ds?: Wall['data']['ds'];
-    move: Wall['data']['move'];
-    sense: Wall['data']['sense'];
-  }
+  namespace WallConfig {
+    interface Data<Options extends FormApplication.Options = FormApplication.Options> {
+      object: foundry.data.WallData['_source'];
+      options: Options;
+      moveTypes: {
+        [Key in keyof typeof foundry.CONST.WALL_MOVEMENT_TYPES as typeof foundry.CONST.WALL_MOVEMENT_TYPES[Key]]: Titlecase<Key>;
+      };
+      senseTypes: {
+        [Key in keyof typeof foundry.CONST.WALL_SENSE_TYPES as typeof foundry.CONST.WALL_SENSE_TYPES[Key]]: Titlecase<Key>;
+      };
+      dirTypes: {
+        [Key in keyof typeof foundry.CONST.WALL_DIRECTIONS as typeof foundry.CONST.WALL_DIRECTIONS[Key]]: Titlecase<Key>;
+      };
+      doorTypes: {
+        [Key in keyof typeof foundry.CONST.WALL_DOOR_TYPES as typeof foundry.CONST.WALL_DOOR_TYPES[Key]]: Titlecase<Key>;
+      };
+      doorStates: {
+        [Key in keyof typeof foundry.CONST.WALL_DOOR_STATES as typeof foundry.CONST.WALL_DOOR_STATES[Key]]: Titlecase<Key>;
+      };
+      isDoor: boolean;
+    }
 
-  interface Options extends FormApplication.Options {
-    /**
-     * @defaultValue `[]`
-     */
-    editTargets: string[];
+    interface FormData {
+      dir: foundry.CONST.WallDirection;
+      door: foundry.CONST.WallDoorType;
+      ds?: foundry.CONST.WallDoorState;
+      move: foundry.CONST.WallMovementType;
+      sense: foundry.CONST.WallSenseType;
+      sound: foundry.CONST.WallSenseType;
+    }
   }
 }

package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts

@@ -1,33 +1,33 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
  * The World Management setup application
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class WorldConfig extends FormApplication<WorldConfig.Options, WorldConfig.Data, Game.World> {
+declare class WorldConfig<
+  Options extends WorldConfig.Options = WorldConfig.Options,
+  Data extends object = WorldConfig.Data
+> extends FormApplication<Options, Data, Game.WorldData<foundry.packages.WorldData>> {
   /**
    * @defaultValue
    * ```typescript
-   * mergeObject(super.defaultOptions, {
+   * foundry.utils.mergeObject(super.defaultOptions, {
    *   id: "world-config",
-   *   template: "templates/setup/world-config.html",
+   *   template: "templates/sidebar/apps/world-config.html",
    *   width: 600,
    *   height: "auto",
-   *   create: false
-   * });
+   *   create: false,
+   * })
    * ```
    */
   static get defaultOptions(): WorldConfig.Options;
 
+  static WORLD_KB_URL: 'https://foundryvtt.com/article/game-worlds/';
+
   /** @override */
   get title(): string;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<WorldConfig.Options>): WorldConfig.Data;
+  /** @override */
+  getData(options?: Partial<Options>): Data | Promise<Data>;
 
   /**
    * @remarks This method returns `Promise<void>`.
@@ -39,16 +39,22 @@ declare class WorldConfig extends FormApplication<WorldConfig.Options, WorldConf
    * @remarks This method does not exist on WorldConfig and only exists to make the typescript compile!
    */
   protected _updateObject(...args: unknown[]): Promise<unknown>;
+
+  /** @override **/
+  activateEditor(name: string, options?: TextEditor.Options, initialContent?: string): void;
 }
 
 declare namespace WorldConfig {
   interface Data {
-    world: WorldConfig['object'];
-    systems: Game.System[];
-    isCreate: WorldConfig['options']['create'];
+    world: Game.WorldData<foundry.packages.WorldData>;
+    isCreate: boolean;
     submitText: string;
     nextDate: string;
     nextTime: string;
+    worldKbUrl: typeof WorldConfig['WORLD_KB_URL'];
+    inWorld: boolean;
+    showEditFields: boolean;
+    systems?: Game.SystemData<foundry.packages.SystemData>[];
   }
 
   interface Options extends FormApplication.Options {
@@ -56,5 +62,7 @@ declare namespace WorldConfig {
      * @defaultValue `false`
      */
     create: boolean;
+
+    inWorld?: boolean;
   }
 }

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

@@ -1,7 +1,8 @@
 /**
  * Render the HUD container
+ * @typeParam Options - the type of the options object
  */
-declare class HeadsUpDisplay extends Application {
+declare class HeadsUpDisplay<Options extends Application.Options = Application.Options> extends Application<Options> {
   /**
    * Token HUD
    */
@@ -23,7 +24,7 @@ declare class HeadsUpDisplay extends Application {
   bubbles: ChatBubbles;
 
   /**
-   * Define default options which configure the HUD
+   * @override
    * @defaultValue
    * ```
    * mergeObject(super.defaultOptions, {
@@ -33,11 +34,16 @@ declare class HeadsUpDisplay extends Application {
    * })
    * ```
    */
-  static get defaultOptions(): typeof Application['defaultOptions'];
+  static get defaultOptions(): Application.Options;
 
-  getData(): {} | { width: number; height: number };
+  /** @override */
+  getData(options?: Partial<Options>): {} | { width: number; height: number };
 
-  _render(...args: Parameters<Application['_render']>): Promise<void>;
+  /** @override */
+  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
+  /**
+   * Align the position of the HUD layer to the current position of the canvas
+   */
   align(): void;
 }

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

@@ -133,10 +133,11 @@ declare global {
      */
     protected _canDragDrop(selector: string): boolean;
 
-    /** @override */
-    protected _onDrop(
-      event: DragEvent
-    ): void | ReturnType<InstanceType<ConfiguredDocumentClass<typeof User>>['assignHotbarMacro']>;
+    /**
+     * @override
+     * @internal
+     */
+    protected _onDrop(event: DragEvent): void;
 
     /**
      * Handle click events to toggle display of the macro bar

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

@@ -1,15 +1,25 @@
-declare interface SceneControlTool {
+interface SceneControlToolBase {
   name: string;
   title: string;
   icon: string;
   visible?: boolean;
-  toggle?: boolean;
   active?: boolean;
+}
+
+interface SceneControlToolToggle extends SceneControlToolBase {
+  toggle: true;
+  onClick?: (toggled: boolean) => void;
+}
+
+interface SceneControlToolNoToggle extends SceneControlToolBase {
+  toggle?: false;
   button?: boolean;
   onClick?: () => void;
 }
 
-declare interface SceneControl {
+type SceneControlTool = SceneControlToolToggle | SceneControlToolNoToggle;
+
+interface SceneControl {
   name: string;
   title: string;
   layer: string;

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/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/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[];
 }