@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/{foundry.js/clientDocuments/chatMessage.d.ts → client/data/documents/chat-message.d.ts}

@@ -1,6 +1,10 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import type { ChatMessageDataConstructorData } from '../../common/data/data.mjs/chatMessageData';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredObjectClassForName,
+  ToObjectFalseType
+} from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { ChatMessageDataConstructorData } from '../../../common/data/data.mjs/chatMessageData';
 
 declare global {
   /**
@@ -13,17 +17,26 @@ declare global {
    * @param data - Initial data provided to construct the ChatMessage document
    */
   class ChatMessage extends ClientDocumentMixin(foundry.documents.BaseChatMessage) {
-    constructor(
-      data?: ConstructorParameters<ConstructorOf<foundry.documents.BaseChatMessage>>[0],
-      context?: ConstructorParameters<ConstructorOf<foundry.documents.BaseChatMessage>>[1]
-    );
-
     /**
-     * If the chat message contains a Roll instance, cache it here
+     * The cached Roll instance that this message contains, if any
      * @defaultValue `null`
+     * @internal
      */
     protected _roll: Roll | null;
 
+    /**
+     * Is the display of the roll in this message collapsed (false) or expanded (true)
+     * @defaultValue `false`
+     * @internal
+     */
+    protected _rollExpanded: boolean;
+
+    /**
+     * Is this ChatMessage currently displayed in the sidebar ChatLog?
+     * @defaultValue `false`
+     */
+    logged: boolean;
+
     /**
      * Return the recommended String alias for this message.
      * The alias could be a Token name in the case of in-character messages or dice rolls.
@@ -61,10 +74,9 @@ declare global {
     /**
      * The User who created the chat message.
      */
-    get user(): User | undefined;
+    get user(): InstanceType<ConfiguredDocumentClass<typeof User>> | undefined;
 
-    /** @override */
-    prepareData(): void;
+    override prepareData(): void;
 
     /**
      * Transform a provided object of ChatMessage data by applying a certain rollMode to the data object.
@@ -87,44 +99,32 @@ declare global {
      * Attempt to determine who is the speaking character (and token) for a certain Chat Message
      * First assume that the currently controlled Token is the speaker
      *
-     * @param scene - The Scene in which the speaker resides
-     * @param actor - The Actor whom is speaking
-     * @param token - The Token whom is speaking
-     * @param alias - The name of the speaker to display
+     * @param options - (default: `{}`)
      *
      * @returns The identified speaker data
      */
-    static getSpeaker({
-      scene,
-      actor,
-      token,
-      alias
-    }?: {
-      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>> | undefined;
-      actor?: InstanceType<ConfiguredDocumentClass<typeof Actor>> | undefined;
-      token?: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>> | undefined;
-      alias?: string | undefined;
-    }): foundry.data.ChatMessageData['speaker']['_source'];
+    static getSpeaker(
+      options?: ChatMessage.GetSpeakerOptions | undefined
+    ): foundry.data.ChatMessageData['speaker']['_source'];
 
     /**
      * A helper to prepare the speaker object based on a target TokenDocument
      *
-     * @param token - The TokenDocument of the speaker
-     * @param alias - The name of the speaker to display
      * @returns The identified speaker data
      */
     protected static _getSpeakerFromToken({
       token,
       alias
     }: {
-      token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>;
-      alias: string;
+      /** The TokenDocument of the speaker */
+      token: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>;
+
+      /** The name of the speaker to display */
+      alias?: string | undefined;
     }): foundry.data.ChatMessageData['speaker']['_source'];
     /**
      * A helper to prepare the speaker object based on a target TokenDocument
      *
-     * @param token - The TokenDocument of the speaker
-     * @param alias - The name of the speaker to display
      * @returns The identified speaker data
      * @deprecated Passing a Token is deprecated, a TokenDocument should be passed instead
      */
@@ -132,16 +132,16 @@ declare global {
       token,
       alias
     }: {
-      token: InstanceType<CONFIG['Token']['objectClass']>;
-      alias: string;
+      /** The TokenDocument of the speaker */
+      token: InstanceType<ConfiguredObjectClassForName<'Token'>>;
+
+      /** The name of the speaker to display */
+      alias?: string | undefined;
     }): foundry.data.ChatMessageData['speaker']['_source'];
 
     /**
      * A helper to prepare the speaker object based on a target Actor
      *
-     * @param scene - The Scene is which the speaker resides
-     * @param actor - The Actor that is speaking
-     * @param alias - The name of the speaker to display
      * @returns The identified speaker data
      */
     protected static _getSpeakerFromActor({
@@ -149,17 +149,19 @@ declare global {
       actor,
       alias
     }: {
-      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>>;
+      /** The Scene is which the speaker resides */
+      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>> | undefined;
+
+      /** The Actor that is speaking */
       actor: InstanceType<ConfiguredDocumentClass<typeof Actor>>;
-      alias?: string;
+
+      /** The name of the speaker to display */
+      alias?: string | undefined;
     }): foundry.data.ChatMessageData['speaker']['_source'];
 
     /**
      * A helper to prepare the speaker object based on a target User
      *
-     * @param scene - The Scene in which the speaker resides
-     * @param user  - The User who is speaking
-     * @param alias - The name of the speaker to display
      * @returns The identified speaker data
      */
     protected static _getSpeakerFromUser({
@@ -167,21 +169,28 @@ declare global {
       user,
       alias
     }: {
-      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>>;
+      /** The Scene in which the speaker resides */
+      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>> | undefined;
+
+      /** The User who is speaking */
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      alias?: string;
+
+      /** The name of the speaker to display */
+      alias?: string | undefined;
     }): foundry.data.ChatMessageData['speaker']['_source'];
 
     /**
      * Obtain an Actor instance which represents the speaker of this message (if any)
      * @param speaker - The speaker data object
      */
-    static getSpeakerActor(speaker: foundry.data.ChatMessageData['speaker']['_source']): Actor | null;
+    static getSpeakerActor(
+      speaker: foundry.data.ChatMessageData['speaker']['_source']
+    ): InstanceType<ConfiguredDocumentClass<typeof Actor>> | null;
 
     /**
      * Obtain a data object used to evaluate any dice rolls associated with this particular chat message
      */
-    getRollData(): InstanceType<ConfiguredDocumentClass<typeof Actor>>['getRollData'] | {};
+    getRollData(): object;
 
     /**
      * Given a string whisper target, return an Array of the user IDs which should be targeted for the whisper
@@ -196,35 +205,63 @@ declare global {
      */
     getHTML(): Promise<JQuery>;
 
-    /** @override */
-    _preCreate(
+    /**
+     * Render the inner HTML content for ROLL type messages.
+     * @param messageData - The chat message data used to render the message HTML
+     * @internal
+     */
+    protected _renderRollContent(messageData: ChatMessage.MessageData): Promise<void>;
+
+    protected override _preCreate(
       data: ChatMessageDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    _onCreate(
+    protected override _onCreate(
       data: foundry.data.ChatMessageData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<foundry.data.ChatMessageData['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Export the content of the chat message into a standardized log format
      */
     export(): string;
   }
-}
 
-export {};
+  namespace ChatMessage {
+    interface GetSpeakerOptions {
+      /** The Scene in which the speaker resides */
+      scene?: InstanceType<ConfiguredDocumentClass<typeof Scene>> | undefined;
+
+      /** The Actor whom is speaking */
+      actor?: InstanceType<ConfiguredDocumentClass<typeof Actor>> | undefined;
+
+      /** The Token whom is speaking */
+      token?: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>> | undefined;
+
+      /** The name of the speaker to display */
+      alias?: string | undefined;
+    }
+
+    interface MessageData {
+      message: ToObjectFalseType<ChatMessage>;
+      user: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof User>>>;
+      author: InstanceType<ConfiguredDocumentClass<typeof User>> | undefined;
+      alias: string;
+      cssClass: string;
+      isWhisper: boolean;
+      canDelete: boolean;
+      whisperTo: string;
+    }
+  }
+}

package/src/foundry/{foundry.js/clientDocuments → client/data/documents}/combat.d.ts

@@ -1,7 +1,7 @@
-import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import type { ChatMessageDataConstructorData } from '../../common/data/data.mjs/chatMessageData';
-import type { CombatantDataSource } from '../../common/data/data.mjs/combatantData';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { ChatMessageDataConstructorData } from '../../../common/data/data.mjs/chatMessageData';
+import type { CombatantDataSource } from '../../../common/data/data.mjs/combatantData';
 
 declare global {
   /**
@@ -97,8 +97,7 @@ declare global {
     /** Advance the combat to the next turn */
     nextTurn(): Promise<this | undefined>;
 
-    /** @override */
-    prepareDerivedData(): void;
+    override prepareDerivedData(): void;
 
     /** Rewind the combat to the previous round */
     previousRound(): Promise<this | undefined>;
@@ -160,21 +159,21 @@ declare global {
       b: InstanceType<ConfiguredDocumentClass<typeof Combatant>>
     ): number;
 
-    /** @override */
-    protected _onCreate(data: this['data']['_source'], options: DocumentModificationOptions, userId: string): void;
+    protected override _onCreate(
+      data: this['data']['_source'],
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<this['data']['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /** @override */
-    protected _onCreateEmbeddedDocuments(
+    protected override _onCreateEmbeddedDocuments(
       type: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
       result: CombatantDataSource[],
@@ -182,8 +181,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdateEmbeddedDocuments(
+    protected override _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
       result: CombatantDataSource[],
@@ -191,8 +189,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDeleteEmbeddedDocuments(
+    protected override _onDeleteEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[],
       result: string[],
@@ -226,5 +223,5 @@ interface RoundData {
   round: number | null;
   turn: number | null;
   tokenId: string | null;
-  combatantid: string | null;
+  combatantId: string | null;
 }

package/src/foundry/{foundry.js/clientDocuments → client/data/documents}/combatant.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
    */
   class Combatant extends ClientDocumentMixin(foundry.documents.BaseCombatant) {
     /**
-     * @override
      * @param data    - Initial data provided to construct the Combatant document
      * @param context - The document context, see {@link foundry.abstract.Document}
      */
@@ -38,11 +37,9 @@ declare global {
     /** This is treated as a non-player combatant if it has no associated actor and no player users who can control it */
     get isNPC(): boolean;
 
-    /** @override */
-    get isOwner(): boolean;
+    override get isOwner(): boolean;
 
-    /** @override */
-    get visible(): 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;
@@ -64,8 +61,7 @@ declare global {
      */
     get isDefeated(): boolean;
 
-    /** @override */
-    testUserPermission(
+    override testUserPermission(
       user: foundry.documents.BaseUser,
       permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
       { exact }?: { exact?: boolean }
@@ -85,8 +81,7 @@ declare global {
      */
     rollInitiative(formula: string): Promise<this | undefined>;
 
-    /** @override */
-    prepareDerivedData(): void;
+    override prepareDerivedData(): void;
 
     /**
      * Update the value of the tracked resource for this Combatant.

package/src/foundry/{foundry.js/clientDocuments/fogExploration.d.ts → client/data/documents/fog-exploration.d.ts}

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { RequestOptions } from '../../common/abstract/backend.mjs';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { RequestOptions } from '../../../common/abstract/backend.mjs';
 
 declare global {
   /**

package/src/foundry/{foundry.js/clientDocuments → client/data/documents}/folder.d.ts

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass, ConstructorDataType, DocumentConstructor } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass, ConstructorDataType, DocumentConstructor } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -60,11 +60,7 @@ declare global {
      *                  (default: `{}`)
      * @returns A Promise which resolves to the created Folder, or null if the dialog was closed.
      *
-     * @remarks
-     * For weird reasons, we need to make this generic.
-     *
-     * The type of `context` is actually `{options?: DocumentSheetOptions} | undefined` but that's incompatible with the
-     * base implementation. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6863.
+     * @remarks For weird reasons, we need to make this generic.
      */
     static createDialog<T extends DocumentConstructor>(
       this: T,
@@ -74,7 +70,7 @@ declare global {
             | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
           >
         | undefined,
-      context?: any
+      context?: Partial<Omit<FolderConfig.Options, 'resolve'>>
     ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
     /**

package/src/foundry/client/data/documents/index.d.ts

@@ -0,0 +1,27 @@
+import './active-effect';
+import './actor';
+import './ambient-light';
+import './ambient-sound';
+import './card';
+import './cards';
+import './chat-message';
+import './combat';
+import './combatant';
+import './drawing';
+import './fog-exploration';
+import './folder';
+import './item';
+import './journal-entry';
+import './macro';
+import './measured-template';
+import './note';
+import './playlist-sound';
+import './playlist';
+import './scene';
+import './setting';
+import './table-result';
+import './table';
+import './tile';
+import './token';
+import './user';
+import './wall';

package/src/foundry/{foundry.js/clientDocuments → client/data/documents}/item.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -44,14 +44,14 @@ declare global {
      */
     getRollData(): object;
 
-    /** @override */
-    protected static _onCreateDocuments(
+    // @ts-expect-error For some reason, proctected static methods from Document are lost, so ts complains that this isn't actually an override
+    protected static override _onCreateDocuments(
       items: Array<InstanceType<ConfiguredDocumentClass<typeof Item>>>,
       context: DocumentModificationContext
     ): Promise<unknown>;
 
-    /** @override */
-    protected static _onDeleteDocuments(
+    // @ts-expect-error For some reason, proctected static methods from Document are lost, so ts complains that this isn't actually an override
+    protected static override _onDeleteDocuments(
       items: Array<InstanceType<ConfiguredDocumentClass<typeof Item>>>,
       context: DocumentModificationContext
     ): Promise<unknown>;

package/src/foundry/{foundry.js/clientDocuments/journalEntry.d.ts → client/data/documents/journal-entry.d.ts}

@@ -1,4 +1,4 @@
-import { DocumentDataType, DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { DocumentDataType, DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -44,15 +44,13 @@ declare global {
      */
     panToNote(options?: PanToNoteOptions): Promise<void>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<DocumentDataType<foundry.documents.BaseJournalEntry>>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
   }
 }
 

package/src/foundry/{foundry.js/clientDocuments/playlistSound.d.ts → client/data/documents/playlist-sound.d.ts}

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName } from '../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -70,15 +70,19 @@ declare global {
      */
     sync(): void | Promise<void> | Promise<Sound>;
 
-    /** @override */
-    protected _onUpdate(
+    override _onCreate(
+      data: foundry.data.PlaylistSoundData['_source'],
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.PlaylistSoundData['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Special handling that occurs when a PlaylistSound reaches the natural conclusion of its playback.

package/src/foundry/{foundry.js/clientDocuments → client/data/documents}/playlist.d.ts

@@ -1,6 +1,6 @@
-import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import type { PlaylistDataConstructorData } from '../../common/data/data.mjs/playlistData';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { PlaylistDataConstructorData } from '../../../common/data/data.mjs/playlistData';
 
 declare global {
   /**
@@ -45,8 +45,7 @@ declare global {
      */
     get playing(): boolean;
 
-    /** @override */
-    get visible(): boolean;
+    override get visible(): boolean;
 
     /**
      * Begin simultaneous playback for all sounds in the Playlist.
@@ -120,25 +119,21 @@ declare global {
       b: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>
     ): number;
 
-    /** @override */
-    protected _preUpdate(
+    protected override _preUpdate(
       changed: DeepPartial<PlaylistDataConstructorData>,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.PlaylistData['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /** @override */
-    protected _onCreateEmbeddedDocuments(
+    protected override _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: Record<string, unknown>[],
@@ -146,8 +141,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdateEmbeddedDocuments(
+    protected override _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: Record<string, unknown>[],
@@ -155,8 +149,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDeleteEmbeddedDocuments(
+    protected override _onDeleteEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: string[],
@@ -179,8 +172,7 @@ declare global {
      */
     _onSoundStart(sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): Promise<void>;
 
-    /** @override */
-    toCompendium(
+    override toCompendium(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
       options?: ClientDocumentMixin.CompendiumExportOptions | undefined
     ): Omit<foundry.data.PlaylistData['_source'], '_id' | 'folder' | 'permission'> & {