@league-of-foundry-developers/foundry-vtt-types 0.8.9-9 → 9.245.0

package/src/foundry/foundry.js/clientDocuments/combat.d.ts

@@ -1,6 +1,7 @@
-import { ConfiguredDocumentClass, ConstructorDataType, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import { CombatantDataProperties } from '../../common/data/data.mjs/combatantData';
+import type { ConfiguredDocumentClass, PropertiesToSource } from '../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import type { ChatMessageDataConstructorData } from '../../common/data/data.mjs/chatMessageData.js';
+import type { CombatantDataProperties } from '../../common/data/data.mjs/combatantData';
 
 declare global {
   /**
@@ -11,10 +12,11 @@ declare global {
    * @see {@link documents.Combats}             The world-level collection of Combat documents
    * @see {@link embedded.Combatant}            The Combatant embedded document which exists within a Combat document
    * @see {@link applications.CombatConfig}     The Combat configuration application
-   *
-   * @param data - Initial data provided to construct the Combat document
    */
   class Combat extends ClientDocumentMixin(foundry.documents.BaseCombat) {
+    /**
+     * @param data - Initial data provided to construct the Combat document
+     */
     constructor(
       data?: ConstructorParameters<ConstructorOf<foundry.documents.BaseCombat>>[0],
       context?: ConstructorParameters<ConstructorOf<foundry.documents.BaseCombat>>[1]
@@ -32,6 +34,7 @@ declare global {
     /**
      * Track whether a sound notification is currently being played to avoid double-dipping
      * @defaultValue `false`
+     * @internal
      */
     protected _soundPlaying: boolean;
 
@@ -39,7 +42,7 @@ declare global {
     static CONFIG_SETTING: 'combatTrackerConfig';
 
     /** Get the Combatant who has the current turn. */
-    get combatant(): this['turns'][number];
+    get combatant(): this['turns'][number] | undefined;
 
     /** The numeric round of the Combat encounter */
     get round(): number;
@@ -57,10 +60,13 @@ declare global {
     get started(): boolean;
 
     /** The numeric turn of the combat round in the Combat encounter */
-    get turn(): number;
+    get turn(): number | null;
 
     get visible(): true;
 
+    /** Is this combat active in the current scene? */
+    get isActive(): boolean;
+
     /**
      * Set the current Combat encounter as active within the Scene.
      * Deactivate all other Combat encounters within the viewed Scene and set this one as active
@@ -77,7 +83,13 @@ declare global {
      * Get a Combatant using its Token id
      * @param tokenId - The id of the Token for which to acquire the combatant
      */
-    getCombatantByToken(tokenId: string): ReturnType<this['combatants']['find']>;
+    getCombatantByToken(tokenId: string): InstanceType<ConfiguredDocumentClass<typeof Combatant>> | undefined;
+
+    /**
+     * Get a Combatant using its Actor id
+     * @param actorId - The id of the Actor for which to acquire the combatant
+     */
+    getCombatantByActor(actorId: string): InstanceType<ConfiguredDocumentClass<typeof Combatant>> | undefined;
 
     /** Advance the combat to the next round */
     nextRound(): Promise<this | undefined>;
@@ -94,15 +106,18 @@ declare global {
     /** Rewind the combat to the previous turn */
     previousTurn(): Promise<this | undefined>;
 
+    /** Toggle whether this combat is linked to the scene or globally available. */
+    toggleSceneLink(): Promise<this | undefined>;
+
     /** Reset all combatant initiative scores, setting the turn back to zero */
     resetAll(): Promise<this | undefined>;
 
     /**
-     * Roll initiative for one or multiple Combatants within the Combat entity
-     * @param ids - A Combatant id or Array of ids for which to roll
+     * Roll initiative for one or multiple Combatants within the Combat document
+     * @param ids     - A Combatant id or Array of ids for which to roll
      * @param options - Additional options which modify how initiative rolls are created or presented.
      *                  default `{}`
-     * @returns  A promise which resolves to the updated Combat entity once updates are complete.
+     * @returns A promise which resolves to the updated Combat document once updates are complete.
      */
     rollInitiative(ids: string | string[], options?: InitiativeOptions): Promise<this>;
 
@@ -111,19 +126,19 @@ declare global {
      * @param options - Additional options forwarded to the Combat.rollInitiative method
      *                  default `{}`
      */
-    rollAll(options?: InitiativeOptions): this['rollInitiative'];
+    rollAll(options?: InitiativeOptions): Promise<this>;
 
     /**
      * Roll initiative for all non-player actors who have not already rolled
      * @param options - Additional options forwarded to the Combat.rollInitiative method
      *                  default `{}`
      */
-    rollNPC(options?: InitiativeOptions): this['rollInitiative'];
+    rollNPC(options?: InitiativeOptions): Promise<this>;
 
     /**
      * Assign initiative for a single Combatant within the Combat encounter.
      * Update the Combat turn order to maintain the same combatant as the current turn.
-     * @param id - The combatant ID for which to set initiative
+     * @param id    - The combatant ID for which to set initiative
      * @param value - A specific initiative value to set
      */
     setInitiative(id: string, value: number): Promise<void>;
@@ -138,71 +153,52 @@ declare global {
      * Define how the array of Combatants is sorted in the displayed list of the tracker.
      * This method can be overridden by a system or module which needs to display combatants in an alternative order.
      * By default sort by initiative, next falling back to name, lastly tie-breaking by combatant id.
+     * @internal
      */
     protected _sortCombatants(
       a: InstanceType<ConfiguredDocumentClass<typeof Combatant>>,
       b: InstanceType<ConfiguredDocumentClass<typeof Combatant>>
     ): number;
 
+    /** @override */
     protected _onCreate(data: this['data']['_source'], options: DocumentModificationOptions, userId: string): void;
 
+    /** @override */
     protected _onUpdate(
       changed: DeepPartial<this['data']['_source']>,
       options: DocumentModificationOptions,
       userId: string
-    ): void; //TODO Returntype could also be CombatTracker.scrollToTurn
+    ): void;
 
+    /** @override */
     protected _onDelete(options: DocumentModificationOptions, userId: string): void;
 
+    /** @override */
     protected _onCreateEmbeddedDocuments(
-      embeddedName: string,
-      documents: Combatant[],
-      result: DeepPartial<PropertiesToSource<CombatantDataProperties>>[],
+      type: string,
+      documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
+      result: PropertiesToSource<CombatantDataProperties>[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
+    /** @override */
     protected _onUpdateEmbeddedDocuments(
       embeddedName: string,
-      documents: Combatant[],
-      result: DeepPartial<PropertiesToSource<CombatantDataProperties>>[],
+      documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
+      result: PropertiesToSource<CombatantDataProperties>[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
+    /** @override */
     protected _onDeleteEmbeddedDocuments(
       embeddedName: string,
-      documents: Combatant[],
+      documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
       result: string[],
       options: DocumentModificationContext,
       userId: string
     ): void;
-
-    /** @deprecated since 0.8.0 */
-    getCombatant(id: string): this['combatants']['get'];
-
-    /** @deprecated since 0.8.0 */
-    createCombatant(
-      data:
-        | ConstructorDataType<foundry.data.CombatData>
-        | (ConstructorDataType<foundry.data.CombatData> & Record<string, unknown>),
-      options?: DocumentModificationContext
-    ): this['createEmbeddedDocuments'];
-
-    /** @deprecated since 0.8.0 */
-    updateCombatant(
-      data: DeepPartial<
-        | ConstructorDataType<foundry.data.CombatData>
-        | (ConstructorDataType<foundry.data.CombatData> & Record<string, unknown>)
-      >,
-      options?: DocumentModificationContext
-    ): NonNullable<ReturnType<this['combatants']['get']>>['update'];
-
-    /** @deprecated since 0.8.0 */
-    deleteCombatant(
-      id: string,
-      options?: DocumentModificationContext
-    ): NonNullable<ReturnType<this['combatants']['get']>>['delete'];
   }
 }
 
@@ -212,16 +208,18 @@ interface InitiativeOptions {
    * @defaultValue `null`
    */
   formula?: string | null;
+
   /**
    * Update the Combat turn after adding new initiative scores to keep the turn on the same Combatant.
    * @defaultValue `true`
    */
   updateTurn?: boolean;
+
   /**
    * Additional options with which to customize created Chat Messages
    * @defaultValue `{}`
    */
-  messageOptions?: object; //TODO Type properly once ChatMessage is typed
+  messageOptions?: ChatMessageDataConstructorData;
 }
 
 interface RoundData {

package/src/foundry/foundry.js/clientDocuments/combatant.d.ts

@@ -1,5 +1,4 @@
 import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { BaseUser } from '../../common/documents.mjs';
 
 declare global {
   /**
@@ -22,18 +21,6 @@ declare global {
       context: ConstructorParameters<typeof foundry.documents.BaseCombatant>[1]
     );
 
-    /**
-     * A cached reference to the Token which this Combatant represents, if any
-     * @defaultValue `undefined`
-     * */
-    protected _token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null | undefined;
-
-    /**
-     * A cached reference to the Actor which this Combatant represents, if any
-     * @defaultValue `undefined`
-     * */
-    protected _actor: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>> | null | undefined;
-
     /** The current value of the special tracked resource which pertains to this Combatant */
     resource: `${number}` | number | boolean | null;
 
@@ -54,8 +41,8 @@ declare global {
     /** @override */
     get isOwner(): boolean;
 
-    /** Is this Combatant entry currently visible in the Combat Tracker? */
-    get isVisible(): boolean;
+    /** @override */
+    get visible(): boolean;
 
     /** Is this Combatant "hidden", either because they are explicitly marked as hidden or because their token is hidden */
     get hidden(): boolean;
@@ -72,10 +59,15 @@ declare global {
     /** An array of User documents who have ownership of this Document */
     get players(): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>[];
 
+    /**
+     * Has this combatant been marked as defeated?
+     */
+    get isDefeated(): boolean;
+
     /** @override */
     testUserPermission(
-      user: BaseUser,
-      permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
+      user: foundry.documents.BaseUser,
+      permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
       { exact }?: { exact?: boolean }
     ): boolean;
 
@@ -89,7 +81,7 @@ declare global {
     /**
      * Roll initiative for this particular combatant.
      * @param formula - A dice formula which overrides the default for this Combatant.
-     * @returns The Roll instance to use for the combatant.
+     * @returns The updated Combatant.
      */
     rollInitiative(formula: string): Promise<this | undefined>;
 
@@ -107,6 +99,11 @@ declare global {
      * @returns  The initiative formula to use for this combatant.
      */
     protected _getInitiativeFormula(): string;
+
+    /**
+     * @deprecated since v9
+     */
+    get isVisible(): boolean;
   }
 }
 export {};

package/src/foundry/foundry.js/clientDocuments/folder.d.ts

@@ -1,5 +1,5 @@
+import { ConfiguredDocumentClass, ConstructorDataType, DocumentConstructor } from '../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
 
 declare global {
   /**
@@ -64,17 +64,21 @@ declare global {
      * @returns An active FolderConfig instance for creating the new Folder entity
      *
      * @remarks
-     * This actually returns a FolderConfig but that is incorrectly overriding
-     * ClientDocumentMixin.createDialog, for which a Promise of the created
-     * Document is returned.
+     * The documented return type is incorrect. It now returns a promise that resolves to the
+     * created folder as intended. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6619
+     *
+     * For weird reasons, we need to make this generic.
      */
-    static createDialog(
-      data?: DeepPartial<
-        | ConstructorDataType<foundry.data.FolderData>
-        | (ConstructorDataType<foundry.data.FolderData> & Record<string, unknown>)
-      >,
-      options?: Dialog.Options
-    ): any;
+    static createDialog<T extends DocumentConstructor>(
+      this: T,
+      data?:
+        | DeepPartial<
+            | ConstructorDataType<InstanceType<T>['data']>
+            | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
+          >
+        | undefined,
+      options?: Partial<DocumentSheetOptions> | undefined
+    ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
     /**
      * Export all Documents contained in this Folder to a given Compendium pack.

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

@@ -1,6 +1,8 @@
 import './activeEffect';
 import './actor';
 import './canvasDocuments';
+import './card';
+import './cards';
 import './chatMessage';
 import './combat';
 import './combatant';

package/src/foundry/foundry.js/clientDocuments/item.d.ts

@@ -1,4 +1,5 @@
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import type { ItemDataConstructorData } from '../../common/data/data.mjs/itemData.js';
 
 declare global {
   /**
@@ -69,9 +70,7 @@ declare global {
      * @deprecated since 0.8.1
      */
     static createOwned(
-      itemData:
-        | ConstructorDataType<foundry.data.ItemData>
-        | (ConstructorDataType<foundry.data.ItemData> & Record<string, unknown>),
+      itemData: ItemDataConstructorData | (ItemDataConstructorData & Record<string, unknown>),
       actor: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
     ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>>;
   }

package/src/foundry/foundry.js/clientDocuments/playlist.d.ts

@@ -1,5 +1,6 @@
-import type { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import type { PlaylistDataConstructorData } from '../../common/data/data.mjs/playlistData.js';
 
 declare global {
   /**
@@ -38,7 +39,7 @@ declare global {
     /**
      * The playback mode for the Playlist instance
      */
-    get mode(): foundry.CONST.PlaylistMode;
+    get mode(): foundry.CONST.PLAYLIST_MODES;
 
     /**
      * The order in which sounds within this playlist will be played (if sequential or shuffled)
@@ -128,7 +129,7 @@ declare global {
 
     /** @override */
     protected _preUpdate(
-      changed: DeepPartial<ConstructorDataType<foundry.data.PlaylistData>>,
+      changed: DeepPartial<PlaylistDataConstructorData>,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;

package/src/foundry/foundry.js/clientDocuments/rollTable.d.ts

@@ -158,7 +158,7 @@ declare global {
       /**
        * The chat roll mode to use when displaying the result
        */
-      rollMode: foundry.CONST.DiceRollMode;
+      rollMode: keyof CONFIG.Dice.RollModes | 'roll';
     }
 
     /**
@@ -180,7 +180,7 @@ declare global {
        * Additional options which customize the created messages
        * @defaultValue `{}`
        */
-      messageOptions: ConstructorParameters<typeof foundry.documents.BaseChatMessage>[1];
+      messageOptions: DocumentModificationContext & { rollMode: keyof CONFIG.Dice.RollModes | 'roll' };
     }
 
     interface RollOptions {

package/src/foundry/foundry.js/clientDocuments/scene.d.ts

@@ -1,13 +1,23 @@
-import { ConfiguredDocumentClass, ConstructorDataType, PropertiesToSource } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass, PropertiesToSource } from '../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import { AmbientLightDataProperties } from '../../common/data/data.mjs/ambientLightData';
-import { AmbientSoundDataProperties } from '../../common/data/data.mjs/ambientSoundData';
-import { DrawingDataProperties } from '../../common/data/data.mjs/drawingData';
-import { MeasuredTemplateDataProperties } from '../../common/data/data.mjs/measuredTemplateData';
-import { NoteDataProperties } from '../../common/data/data.mjs/noteData';
-import { TileDataProperties } from '../../common/data/data.mjs/tileData';
-import { TokenDataProperties } from '../../common/data/data.mjs/tokenData';
-import { WallDataProperties } from '../../common/data/data.mjs/wallData';
+import {
+  AmbientLightDataConstructorData,
+  AmbientLightDataProperties
+} from '../../common/data/data.mjs/ambientLightData';
+import {
+  AmbientSoundDataConstructorData,
+  AmbientSoundDataProperties
+} from '../../common/data/data.mjs/ambientSoundData';
+import { DrawingDataConstructorData, DrawingDataProperties } from '../../common/data/data.mjs/drawingData';
+import {
+  MeasuredTemplateDataConstructorData,
+  MeasuredTemplateDataProperties
+} from '../../common/data/data.mjs/measuredTemplateData';
+import { NoteDataConstructorData, NoteDataProperties } from '../../common/data/data.mjs/noteData';
+import type { SceneDataConstructorData } from '../../common/data/data.mjs/sceneData.js';
+import { TileDataConstructorData, TileDataProperties } from '../../common/data/data.mjs/tileData';
+import { TokenDataConstructorData, TokenDataProperties } from '../../common/data/data.mjs/tokenData';
+import { WallDataConstructorData, WallDataProperties } from '../../common/data/data.mjs/wallData';
 
 declare global {
   /**
@@ -94,10 +104,7 @@ declare global {
      * @param options    - (default: `{}`)
      */
     clone(
-      createData?: DeepPartial<
-        | ConstructorDataType<foundry.data.SceneData>
-        | (ConstructorDataType<foundry.data.SceneData> & Record<string, unknown>)
-      >,
+      createData?: DeepPartial<SceneDataConstructorData | (SceneDataConstructorData & Record<string, unknown>)>,
       options?: { save?: boolean; keepId?: boolean }
     ): TemporaryDocument<this> | Promise<TemporaryDocument<this | undefined>>;
 
@@ -106,7 +113,7 @@ declare global {
 
     /** @override */
     protected _preCreate(
-      data: ConstructorDataType<foundry.data.SceneData>,
+      data: SceneDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
@@ -120,7 +127,7 @@ declare global {
 
     /** @override */
     protected _preUpdate(
-      changed: DeepPartial<ConstructorDataType<foundry.data.SceneData>>,
+      changed: DeepPartial<SceneDataConstructorData>,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
@@ -147,49 +154,49 @@ declare global {
     /** @override */
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.DrawingData>[],
+      result: DrawingDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.TokenData>[],
+      result: TokenDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.AmbientLightData>[],
+      result: AmbientLightDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.NoteData>[],
+      result: NoteDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.AmbientSoundData>[],
+      result: AmbientSoundDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.MeasuredTemplateData>[],
+      result: MeasuredTemplateDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.TileData>[],
+      result: TileDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
     _preCreateEmbeddedDocuments(
       embeddedName: string,
-      result: ConstructorDataType<foundry.data.WallData>[],
+      result: WallDataConstructorData[],
       options: DocumentModificationOptions,
       userId: string
     ): void;