@league-of-foundry-developers/foundry-vtt-types 9.242.0 → 9.249.2

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/combatEncounters.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Combat documents which exist within the active World.
    * This Collection is accessible within the Game object as game.combats.
    *
-   * @see {@link Combat} The Combat entity
+   * @see {@link Combat} The Combat document
    * @see {@link CombatTracker} The CombatTracker sidebar directory
    */
   class CombatEncounters extends WorldCollection<typeof foundry.documents.BaseCombat, 'CombatEncounters'> {
@@ -13,10 +13,13 @@ declare global {
     static documentName: 'Combat';
 
     /**
-     * Provide the settings object which configures the Combat entity
+     * Provide the settings object which configures the Combat document
      */
     static get settings(): ClientSettings.Values[`core.${typeof Combat['CONFIG_SETTING']}`];
 
+    /** @override */
+    get directory(): typeof ui['combat'];
+
     /**
      * Get an Array of Combat instances which apply to the current canvas scene
      */

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/fogExplorations.d.ts

@@ -1,7 +1,5 @@
 /**
  * The singleton collection of FogExploration documents which exist within the active World.
- * This Collection is accessible within the Game object as game.fog.
- *
  * @see {@link FogExploration} The FogExploration document
  */
 declare class FogExplorations extends WorldCollection<typeof foundry.documents.BaseFogExploration, 'FogExplorations'> {

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/folders.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Folder documents which exist within the active World.
    * This Collection is accessible within the Game object as game.fog.
    *
-   * @see {@link FogExploration} The FogExploration document
+   * @see {@link Folder} The Folder document
    */
   class Folders extends WorldCollection<typeof foundry.documents.BaseFolder, 'Folders'> {
     constructor(data?: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Folder>>>['data']['_source'][]);
@@ -19,7 +19,7 @@ declare global {
     static documentName: 'Folder';
 
     /** @override */
-    render(force?: boolean, context?: Application.Options): void;
+    render(force?: boolean, context?: ApplicationOptions): void;
 
     /**
      * Refresh the display of any active JournalSheet instances where the folder list will change.

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/items.d.ts

@@ -2,31 +2,10 @@
  * The singleton collection of Item documents which exist within the active World.
  * This Collection is accessible within the Game object as game.items.
  *
- * @see {@link Item} The Item entity
+ * @see {@link Item} The Item document
  * @see {@link ItemDirectory} The ItemDirectory sidebar directory
  */
 declare class Items extends WorldCollection<typeof foundry.documents.BaseItem, 'Items'> {
   /** @override */
   static documentName: 'Item';
-
-  /**
-   * Register an Item sheet class as a candidate which can be used to display Items of a given type
-   * See EntitySheetConfig.registerSheet for details
-   */
-  static registerSheet(
-    scope: string,
-    sheetClass: ConstructorOf<ItemSheet>,
-    { label, types, makeDefault }?: { label?: string; types?: string[]; makeDefault?: boolean }
-  ): void;
-
-  /**
-   * Unregister an Item sheet class, removing it from the list of available sheet Applications to use
-   * See EntitySheetConfig.unregisterSheet for details
-   */
-  static unregisterSheet(scope: string, sheetClass: ConstructorOf<ItemSheet>, { types }?: { types?: string[] }): void;
-
-  /**
-   * Return an Array of currently registered sheet classes for this Entity type
-   */
-  static get registeredSheets(): typeof ItemSheet[];
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/journal.d.ts

@@ -2,7 +2,7 @@
  * The singleton collection of JournalEntry documents which exist within the active World.
  * This Collection is accessible within the Game object as game.journal.
  *
- * @see {@link JournalEntry} The JournalEntry entity
+ * @see {@link JournalEntry} The JournalEntry document
  * @see {@link JournalDirectory} The JournalDirectory sidebar directory
  */
 declare class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, 'Journal'> {

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/macros.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Macro documents which exist within the active World.
    * This Collection is accessible within the Game object as game.macros.
    *
-   * @see {@link Macro} The Macro entity
+   * @see {@link Macro} The Macro document
    * @see {@link MacroDirectory} The MacroDirectory sidebar directory
    */
   class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, 'Macros'> {
@@ -19,16 +19,11 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
       '_id' | 'folder'
     >;
-
-    /**
-     * You are calling Macros.canUseScripts which has been deprecated in favor of User#can('MACRO_SCRIPT')
-     * @deprecated since 0.8.1
-     */
-    static canUseScripts(user: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>): boolean;
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/messages.d.ts

@@ -5,19 +5,24 @@ declare global {
    * The singleton collection of ChatMessage documents which exist within the active World.
    * This Collection is accessible within the Game object as game.messages.
    *
-   * @see {@link ChatMessage} The ChatMessage entity
+   * @see {@link ChatMessage} The ChatMessage document
    * @see {@link ChatLog} The ChatLog sidebar directory
    */
   class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, 'Messages'> {
     /** @override */
     static documentName: 'ChatMessage';
 
+    /**
+     * @override
+     * */
+    get directory(): typeof ui.chat;
+
     /** @override */
     render(force?: boolean): void;
 
     /**
      * If requested, dispatch a Chat Bubble UI for the newly created message
-     * @param message - The ChatMessage entity to say
+     * @param message - The ChatMessage document to say
      */
     sayBubble(message: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseChatMessage>>): void;
 

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/playlists.d.ts

@@ -1,12 +1,12 @@
 import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import type { SceneDataConstructorData } from '../../../../common/data/data.mjs/sceneData.js';
+import type { SceneDataConstructorData } from '../../../../common/data/data.mjs/sceneData';
 
 declare global {
   /**
    * The singleton collection of Playlist documents which exist within the active World.
    * This Collection is accessible within the Game object as game.playlists.
    *
-   * @see {@link Playlist} The Playlist entity
+   * @see {@link Playlist} The Playlist document
    * @see {@link PlaylistDirectory} The PlaylistDirectory sidebar directory
    */
   class Playlists extends WorldCollection<typeof foundry.documents.BasePlaylist, 'Playlists'> {
@@ -20,7 +20,7 @@ declare global {
     static documentName: 'Playlist';
 
     /**
-     * Return the subset of Playlist entities which are currently playing
+     * Return the subset of Playlist documents which are currently playing
      */
     get playing(): ReturnType<this['filter']>;
 
@@ -30,8 +30,8 @@ declare global {
     initialize(): void;
 
     /**
-     * Handle changes to a Scene to determine whether to trigger changes to Playlist entities.
-     * @param scene - The Scene entity being updated
+     * Handle changes to a Scene to determine whether to trigger changes to Playlist documents.
+     * @param scene - The Scene document being updated
      * @param data  - The incremental update data
      */
     protected _onChangeScene(

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/rollTables.d.ts

@@ -13,7 +13,7 @@ declare class RollTables extends WorldCollection<typeof foundry.documents.BaseRo
   get directory(): typeof ui['tables'];
 
   /**
-   * Register world settings related to RollTable entities
+   * Register world settings related to RollTable documents
    */
   static registerSettings(): void;
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/scenes.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Scene documents which exist within the active World.
    * This Collection is accessible within the Game object as game.scenes.
    *
-   * @see {@link Scene} The Scene entity
+   * @see {@link Scene} The Scene document
    * @see {@link SceneDirectory} The SceneDirectory sidebar directory
    */
   class Scenes extends WorldCollection<typeof foundry.documents.BaseScene, 'Scenes'> {
@@ -54,7 +54,8 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
       '_id' | 'folder'

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/users.d.ts

@@ -5,19 +5,21 @@ declare global {
    * The singleton collection of User documents which exist within the active World.
    * This Collection is accessible within the Game object as game.users.
    *
-   * @see {@link User} The User entity
+   * @see {@link User} The User document
    */
   class Users extends WorldCollection<typeof foundry.documents.BaseUser, 'Users'> {
     constructor(data?: foundry.data.UserData['_source'][]);
 
     /**
-     * The User entity of the currently connected user
+     * The User document of the currently connected user
      * @defaultValue `null`
      */
     current: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>> | null;
 
     /**
-     * Initialize the Map object and all its contained entities
+     * Initialize the Map object and all its contained documents
+     * @override
+     * @internal
      */
     protected _initialize(): void;
 
@@ -36,7 +38,8 @@ declare global {
      * Handle receipt of activity data from another User connected to the Game session
      * @param userId       - The User id who generated the activity data
      * @param activityData - The object of activity data
+     *                       (default: `{}`)
      */
-    protected static _handleUserActivity(userId: string, activityData?: User.ActivityData): void;
+    protected static _handleUserActivity(userId: string, activityData?: ActivityData | undefined): void;
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/worldSettings.d.ts

@@ -9,10 +9,10 @@ declare class WorldSettings extends WorldCollection<typeof foundry.documents.Bas
   static documentName: 'Setting';
 
   /** @override */
-  get directory(): null;
+  get directory(): undefined;
 
   /**
-   * Return the Setting document with the given key.
+   * Return the Setting or Keybind document with the given key.
    * @param key - The setting key
    * @returns The Setting.
    */

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

@@ -249,6 +249,9 @@ declare global {
       /** @defaultValue `Cards` */
       documentClass: ConfiguredDocumentClassOrDefault<typeof Cards>;
 
+      /** @defaultValue `"fas fa-id-badge"` */
+      sidebarIcon: string;
+
       presets: {
         /**
          * @defaultValue
@@ -505,7 +508,7 @@ declare global {
       /** @defaultValue `Macros` */
       collection: ConstructorOf<Macros>;
 
-      /** @defaultValue `'fas fa-terminal'` */
+      /** @defaultValue `'fas fa-code'` */
       sidebarIcon: string;
     };
 
@@ -973,7 +976,7 @@ declare global {
 
     /**
      * Suggested font families that are displayed wherever a choice is presented
-     * @defaultValue `['Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Times New Roman', 'Signika', 'Modesto Condensed']`
+     * @defaultValue `["Arial", "Courier", "Courier New", "Helvetica", "Signika", "Times", "Times New Roman", "Modesto Condensed"]`
      */
     fontFamilies: string[];
 

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

@@ -1,3 +1,27 @@
+interface DragDropConfiguration {
+  /**
+   * The CSS selector used to target draggable elements.
+   */
+  dragSelector?: DragDrop['dragSelector'];
+
+  /**
+   * The CSS selector used to target viable drop targets.
+   */
+  dropSelector?: DragDrop['dropSelector'];
+
+  /**
+   * An object of permission test functions for each action
+   * @defaultValue `{}`
+   */
+  permissions?: DragDrop['permissions'];
+
+  /**
+   * An object of callback functions for each action
+   * @defaultValue `{}`
+   */
+  callbacks?: DragDrop['callbacks'];
+}
+
 /**
  * A controller class for managing drag and drop workflows within an Application instance.
  * The controller manages the following actions: dragstart, dragover, drop
@@ -16,16 +40,9 @@
  */
 declare class DragDrop {
   /**
-   * @param dragSelector - The CSS selector used to target draggable elements.
-   *                       (default: `undefined`)
-   * @param dropSelector - The CSS selector used to target viable drop targets.
-   *                       (default: `undefined`)
-   * @param permissions  - An object of permission test functions for each action
-   *                       (default: `{}`)
-   * @param callbacks    - An object of callback functions for each action
-   *                       (default: `{}`)
+   * @param options - (default: `{}`)
    */
-  constructor({ dragSelector, dropSelector, permissions, callbacks }?: DragDrop.Options);
+  constructor({ dragSelector, dropSelector, permissions, callbacks }?: DragDropConfiguration);
 
   /**
    * The HTML selector which identifies draggable elements
@@ -65,7 +82,7 @@ declare class DragDrop {
   callback(event: DragEvent, action: DragDrop.Action): void;
 
   /**
-   * Test whether the current user has permission to perform a step of the workflow
+   * Execute a callback function associated with a certain action in the workflow
    * @param action   - The action being attempted
    * @param selector - The selector being targeted
    * @returns Can the action be performed?
@@ -97,29 +114,5 @@ declare class DragDrop {
 }
 
 declare namespace DragDrop {
-  interface Options {
-    /**
-     * The CSS selector used to target draggable elements.
-     */
-    dragSelector?: DragDrop['dragSelector'];
-
-    /**
-     * The CSS selector used to target viable drop targets.
-     */
-    dropSelector?: DragDrop['dropSelector'];
-
-    /**
-     * An object of permission test functions for each action
-     * @defaultValue `{}`
-     */
-    permissions?: DragDrop['permissions'];
-
-    /**
-     * An object of callback functions for each action
-     * @defaultValue `{}`
-     */
-    callbacks?: DragDrop['callbacks'];
-  }
-
   type Action = 'dragstart' | 'dragover' | 'drop';
 }

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

@@ -4,9 +4,9 @@ import {
   ConfiguredObjectClassForName,
   DocumentConstructor,
   ToObjectFalseType
-} from '../../types/helperTypes.js';
-import { DocumentModificationOptions } from '../common/abstract/document.mjs.js';
-import { EffectChangeData } from '../common/data/data.mjs/effectChangeData.js';
+} from '../../types/helperTypes';
+import { DocumentModificationOptions } from '../common/abstract/document.mjs';
+import { EffectChangeData } from '../common/data/data.mjs/effectChangeData';
 import { DropData } from './clientDocumentMixin';
 
 declare global {

package/src/foundry/foundry.js/pixi/containers/ruler.d.ts

@@ -1,6 +1,23 @@
 import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
 
 declare global {
+  interface RulerData {
+    /** The ruler measurement state. */
+    _state: Ruler['_state'];
+
+    /** A unique name for the ruler containing the owning user's ID. */
+    name: string;
+
+    /** The current point the ruler has been extended to. */
+    destination: PIXI.Point;
+
+    /** The class name of this ruler instance. */
+    class: string;
+
+    /** Additional waypoints along the ruler's length, including the starting point. */
+    waypoints: PIXI.Point[];
+  }
+
   /**
    * The Ruler - used to measure distances and trigger movements
    */
@@ -169,13 +186,7 @@ declare global {
      */
     protected _endMeasurement(): void;
 
-    toJSON(): {
-      class: 'Ruler';
-      name: string;
-      waypoints: Ruler['waypoints'];
-      destination: Ruler['destination'];
-      _state: Ruler['_state'];
-    };
+    toJSON(): RulerData;
 
     /**
      * Update a Ruler instance using data provided through the cursor activity socket

package/src/foundry/foundry.js/pixi/index.d.ts

@@ -2,8 +2,10 @@ import './blendModes';
 import './containers';
 import './filters';
 import './graphics';
+import './meshes';
 import './points';
 import './polygons';
 import './rectangles';
 import './shaders';
 import './texts';
+import './transforms';

package/src/foundry/foundry.js/pixi/meshes/index.d.ts

@@ -0,0 +1 @@
+import './samplerMesh';

package/src/foundry/foundry.js/pixi/meshes/samplerMesh.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A Mesh subclass used to render a texture with faster performance than a PIXI.Sprite.
+ */
+declare class SamplerMesh extends PIXI.Mesh {
+  /**
+   * The basic quad geometry used for the Mesh
+   * @defaultValue
+   * ```javascript
+   * new PIXI.Geometry()
+   *   .addAttribute('aVertexPosition', [0, 0, 1, 0, 1, 1, 0, 1], 2)
+   *   .addAttribute('aUvs', [0, 0, 1, 0, 1, 1, 0, 1], 2)
+   *   .addIndex([0, 1, 2, 0, 2, 3])
+   * ```
+   */
+  static QUAD: PIXI.Geometry;
+
+  /**
+   * Create a SamplerMesh using a provided RenderTexture
+   * @param texture - The texture to render using a Mesh
+   */
+  static create(texture: PIXI.RenderTexture): SamplerMesh;
+}

package/src/foundry/foundry.js/pixi/points/wallEndpoint.d.ts

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../../../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
 
 declare global {
   type VertexMap = Map<number, PolygonVertex>;
@@ -119,6 +119,14 @@ declare global {
     /** @override */
     protected _compute(): void;
 
+    /**
+     * Round vertices of a ray segment
+     * @param ray - The provided ray
+     * @returns The ray with rounded vertices
+     * @internal
+     */
+    protected _roundRayVertices(ray: Ray): Ray;
+
     /**
      * Translate walls and other obstacles into edges which limit visibility
      * @internal

package/src/foundry/foundry.js/pixi/rectangles/normalizedRectangle.d.ts

@@ -4,6 +4,13 @@
 declare class NormalizedRectangle extends PIXI.Rectangle {
   constructor(x: number, y: number, width: number, height: number);
 
+  /**
+   * Determine whether some other Rectangle intersects with this one.
+   * @param other - Some other rectangle against which to compare
+   * @returns Do the rectangles intersect?
+   */
+  intersects(other: PIXI.Rectangle): boolean;
+
   /**
    * Generate a new rectangle by rotating this one clockwise about its center by a certain number of radians
    * @param radians - The angle of rotation

package/src/foundry/foundry.js/pixi/shaders/abstractBaseShader.d.ts

@@ -14,7 +14,7 @@ declare abstract class AbstractBaseShader extends PIXI.Shader {
 
   /**
    * The raw vertex shader used by this class.
-   * A subclass of AbstractBaseShader must implement the fragmentShader static field.
+   * A subclass of AbstractBaseShader must implement the vertexShader static field.
    * @defaultValue `""`
    *
    * @remarks This is abstract, subclasses must implement it.

package/src/foundry/foundry.js/pixi/transforms/index.d.ts

@@ -0,0 +1 @@
+import './synchronizedTransform';

package/src/foundry/foundry.js/pixi/transforms/synchronizedTransform.d.ts

@@ -0,0 +1,38 @@
+/**
+ * An extension of PIXI.Transform.
+ * This uses a different DisplayObject than the current parent as the reference for the worldTransform.
+ */
+declare class SynchronizedTransform extends PIXI.Transform {
+  constructor(transform: PIXI.Transform);
+
+  /**
+   * A list of attributes from the transform reference which should be synchronized
+   * @defaultValue
+   * ```javascript
+   * [
+   *   "localTransform", "position", "scale", "pivot", "skew", "_rotation",
+   *   "_cx", "_sx", "_cy", "_sy", "_localID", "_currentLocalID"
+   * ];
+   * ```
+   */
+  static synchronizedAttributes: string[];
+
+  /**
+   * A Transform instance which defines the reference point for the worldTransform
+   */
+  get reference(): PIXI.Transform;
+
+  set reference(value: PIXI.Transform);
+
+  /** @internal */
+  protected _reference: PIXI.Transform;
+
+  /** @internal */
+  protected _syncLocalID: number;
+
+  /** @override */
+  updateTransform(parentTransform: PIXI.Transform): void;
+
+  /** @override */
+  updateLocalTransform(): void;
+}

package/src/foundry/foundry.js/pointSources/lightSource.d.ts

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../../types/helperTypes';
 
 declare global {
   /** @see {@link foundry.data.LightData} */

package/src/foundry/foundry.js/pointSources/soundSource.d.ts

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../../types/helperTypes';
 
 declare global {
   interface SoundSourceData extends PointSource.Data {

package/src/foundry/foundry.js/pointSources/visionSource.d.ts

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../../types/helperTypes';
 
 declare global {
   interface VisionSourceData extends Exclude<PointSource.Data, 'walls'> {

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

@@ -1,4 +1,4 @@
-import type { ConfiguredObjectClassForName } from '../../types/helperTypes.js';
+import type { ConfiguredObjectClassForName } from '../../types/helperTypes';
 
 declare global {
   /**

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

@@ -97,12 +97,12 @@ declare class Quadtree<T> {
 
   /**
    * Get all the objects which could collide with the provided rectangle
-   * @param rect - The target rectangle
+   * @param rect - The normalized target rectangle
    * @param _s   - The existing result set, for internal use.
    *               (default: `new Set<T>()`)
    * @returns The objects in the Quadtree which represent potential collisions
    */
-  getObjects(rect: Rectangle, _s?: Set<T>): Set<T>;
+  getObjects(rect: NormalizedRectangle, _s?: Set<T>): Set<T>;
 
   /**
    * Obtain the leaf nodes to which a target rectangle belongs.

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

@@ -1,4 +1,4 @@
-import type { LineIntersection } from '../common/utils/geometry.mjs.js';
+import type { LineIntersection } from '../common/utils/geometry.mjs';
 
 declare global {
   interface RayIntersection {