@league-of-foundry-developers/foundry-vtt-types 9.249.0 → 9.249.1

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

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Actor documents which exist within the active World.
    * This Collection is accessible within the Game object as game.actors.
    *
-   * @see {@link Actor} The Actor entity
+   * @see {@link Actor} The Actor document
    * @see {@link ActorDirectory} The ActorDirectory sidebar directory
    *
    * @example <caption>Retrieve an existing Actor by its id</caption>
@@ -27,45 +27,11 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
       '_id' | 'folder'
     >;
-
-    /**
-     * Register an Actor sheet class as a candidate which can be used to display Actors of a given type
-     * See EntitySheetConfig.registerSheet for details
-     *
-     * @example <caption>Register a new ActorSheet subclass for use with certain Actor types.</caption>
-     * ```typescript
-     * Actors.registerSheet("dnd5e", ActorSheet5eCharacter, { types: ["character"], makeDefault: true });
-     * ```
-     */
-    static registerSheet(
-      scope: string,
-      sheetClass: ConstructorOf<ActorSheet>,
-      { label, types, makeDefault }?: { label?: string; types?: string[]; makeDefault?: boolean }
-    ): void;
-
-    /**
-     * Unregister an Actor sheet class, removing it from the list of avaliable sheet Applications to use
-     * See EntitySheetConfig.unregisterSheet for details
-     *
-     * @example <caption>Deregister the default ActorSheet subclass to replace it with others.</caption>
-     * ```typescript
-     * Actors.unregisterSheet("core", ActorSheet);
-     * ```
-     */
-    static unregisterSheet(
-      scope: string,
-      sheetClass: ConstructorOf<ActorSheet>,
-      { types }?: { types?: string[] }
-    ): void;
-
-    /**
-     * Return an Array of currently registered sheet classes for this Entity type
-     */
-    static get registeredSheets(): typeof ActorSheet[];
   }
 }

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'][]);

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/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/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>;

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/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 {

package/src/types/helperTypes.d.ts

@@ -63,9 +63,35 @@ export type ConfiguredDocumentClass<T extends DocumentConstructor> = ConfiguredD
   T['metadata']['name']
 >;
 
-export type DocumentType = keyof {
-  [Key in keyof CONFIG as 'documentClass' extends keyof CONFIG[Key] ? Key : never]: unknown;
-};
+export type DocumentType =
+  | 'Actor'
+  | 'Adventure'
+  | 'Cards'
+  | 'ChatMessage'
+  | 'Combat'
+  | 'FogExploration'
+  | 'Folder'
+  | 'Item'
+  | 'JournalEntry'
+  | 'Macro'
+  | 'Playlist'
+  | 'RollTable'
+  | 'Scene'
+  | 'Setting'
+  | 'User'
+  | 'ActiveEffect'
+  | 'Card'
+  | 'TableResult'
+  | 'PlaylistSound'
+  | 'AmbientLight'
+  | 'AmbientSound'
+  | 'Combatant'
+  | 'Drawing'
+  | 'MeasuredTemplate'
+  | 'Note'
+  | 'Tile'
+  | 'Token'
+  | 'Wall';
 
 export type PlaceableDocumentType =
   | 'AmbientLight'
@@ -77,17 +103,9 @@ export type PlaceableDocumentType =
   | 'Token'
   | 'Wall';
 
-export type ConfiguredDocumentClassForName<Name extends DocumentType> = 'documentClass' extends keyof CONFIG[Name]
-  ? CONFIG[Name]['documentClass']
-  : never;
-
-export type ObjectType = keyof {
-  [Key in keyof CONFIG as 'objectClass' extends keyof CONFIG[Key] ? Key : never]: unknown;
-};
+export type ConfiguredDocumentClassForName<Name extends DocumentType> = CONFIG[Name]['documentClass'];
 
-export type ConfiguredObjectClassForName<Name extends ObjectType> = 'objectClass' extends keyof CONFIG[Name]
-  ? CONFIG[Name]['objectClass']
-  : never;
+export type ConfiguredObjectClassForName<Name extends PlaceableDocumentType> = CONFIG[Name]['objectClass'];
 
 export type ConfiguredData<Name extends string> = Name extends keyof DataConfig ? DataConfig[Name] : {};