@league-of-foundry-developers/foundry-vtt-types 9.268.0 → 9.269.0

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections/cardStacks.d.ts → client/data/collections/cards.d.ts}

@@ -4,6 +4,5 @@
  * @see {@link Cards} The Cards document
  */
 declare class CardStacks extends WorldCollection<typeof foundry.documents.BaseCards, 'Cards'> {
-  /** @override */
-  static documentName: 'Cards';
+  static override documentName: 'Cards';
 }

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections/combatEncounters.d.ts → client/data/collections/combats.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -9,16 +9,14 @@ declare global {
    * @see {@link CombatTracker} The CombatTracker sidebar directory
    */
   class CombatEncounters extends WorldCollection<typeof foundry.documents.BaseCombat, 'CombatEncounters'> {
-    /** @override */
-    static documentName: 'Combat';
+    static override documentName: 'Combat';
 
     /**
      * 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'];
+    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/compendiumCollection.d.ts → client/data/collections/compendium.d.ts}

@@ -1,5 +1,5 @@
 import { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs.js';
 
 declare global {
   /**
@@ -226,8 +226,7 @@ declare global {
      */
     migrate(options?: Record<string, unknown> | undefined): Promise<this>;
 
-    /** @override */
-    updateAll(
+    override updateAll(
       transformation:
         | DeepPartial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']>
         | ((

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections/folders.d.ts → client/data/collections/folder.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -15,11 +15,9 @@ declare global {
      */
     protected _expanded: Partial<Record<string, boolean>>;
 
-    /** @override */
-    static documentName: 'Folder';
+    static override documentName: 'Folder';
 
-    /** @override */
-    render(force?: boolean, context?: ApplicationOptions): void;
+    override 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 → client/data/collections}/index.d.ts

@@ -1,14 +1,15 @@
 import './actors';
-import './cardStacks';
-import './combatEncounters';
-import './fogExplorations';
-import './folders';
+import './cards';
+import './combats';
+import './compendium';
+import './fog';
+import './folder';
 import './items';
 import './journal';
 import './macros';
 import './messages';
 import './playlists';
-import './rollTables';
 import './scenes';
+import './settings';
+import './tables';
 import './users';
-import './worldSettings';

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/items.d.ts

@@ -6,6 +6,5 @@
  * @see {@link ItemDirectory} The ItemDirectory sidebar directory
  */
 declare class Items extends WorldCollection<typeof foundry.documents.BaseItem, 'Items'> {
-  /** @override */
-  static documentName: 'Item';
+  static override documentName: 'Item';
 }

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/journal.d.ts

@@ -6,8 +6,7 @@
  * @see {@link JournalDirectory} The JournalDirectory sidebar directory
  */
 declare class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, 'Journal'> {
-  /** @override */
-  static documentName: 'JournalEntry';
+  static override documentName: 'JournalEntry';
 
   /**
    * Open Socket listeners which transact JournalEntry data

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/macros.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -9,14 +9,11 @@ declare global {
    * @see {@link MacroDirectory} The MacroDirectory sidebar directory
    */
   class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, 'Macros'> {
-    /** @override */
-    static documentName: 'Macro';
+    static override documentName: 'Macro';
 
-    /** @override */
-    get directory(): typeof ui.macros;
+    override get directory(): typeof ui.macros;
 
-    /** @override */
-    fromCompendium(
+    override fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/messages.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -9,16 +9,11 @@ declare global {
    * @see {@link ChatLog} The ChatLog sidebar directory
    */
   class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, 'Messages'> {
-    /** @override */
-    static documentName: 'ChatMessage';
+    static override documentName: 'ChatMessage';
 
-    /**
-     * @override
-     * */
-    get directory(): typeof ui.chat;
+    override get directory(): typeof ui.chat;
 
-    /** @override */
-    render(force?: boolean): void;
+    override render(force?: boolean): void;
 
     /**
      * If requested, dispatch a Chat Bubble UI for the newly created message

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/playlists.d.ts

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import type { SceneDataConstructorData } from '../../../../common/data/data.mjs/sceneData';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { SceneDataConstructorData } from '../../../common/data/data.mjs/sceneData';
 
 declare global {
   /**
@@ -16,8 +16,7 @@ declare global {
       >['data']['_source'][]
     );
 
-    /** @override */
-    static documentName: 'Playlist';
+    static override documentName: 'Playlist';
 
     /**
      * Return the subset of Playlist documents which are currently playing

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/scenes.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -9,8 +9,7 @@ declare global {
    * @see {@link SceneDirectory} The SceneDirectory sidebar directory
    */
   class Scenes extends WorldCollection<typeof foundry.documents.BaseScene, 'Scenes'> {
-    /** @override */
-    static documentName: 'Scene';
+    static override documentName: 'Scene';
 
     /**
      * Return a reference to the Scene which is currently active
@@ -50,8 +49,7 @@ declare global {
      */
     protected static _pullToScene(sceneId: string): void;
 
-    /** @override */
-    fromCompendium(
+    override fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections/worldSettings.d.ts → client/data/collections/settings.d.ts}

@@ -5,11 +5,9 @@
  * @see {@link Setting} The Setting document
  */
 declare class WorldSettings extends WorldCollection<typeof foundry.documents.BaseSetting, 'WorldSettings'> {
-  /** @override */
-  static documentName: 'Setting';
+  static override documentName: 'Setting';
 
-  /** @override */
-  get directory(): undefined;
+  override get directory(): undefined;
 
   /**
    * Return the Setting or Keybind document with the given key.

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections/rollTables.d.ts → client/data/collections/tables.d.ts}

@@ -6,11 +6,9 @@
  * @see {@link RollTableDirectory} The RollTableDirectory sidebar directory
  */
 declare class RollTables extends WorldCollection<typeof foundry.documents.BaseRollTable, 'RollTables'> {
-  /** @override */
-  static documentName: 'RollTable';
+  static override documentName: 'RollTable';
 
-  /** @override */
-  get directory(): typeof ui['tables'];
+  override get directory(): typeof ui['tables'];
 
   /**
    * Register world settings related to RollTable documents

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/users.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -18,13 +18,11 @@ declare global {
 
     /**
      * Initialize the Map object and all its contained documents
-     * @override
      * @internal
      */
-    protected _initialize(): void;
+    protected override _initialize(): void;
 
-    /** @override */
-    static documentName: 'User';
+    static override documentName: 'User';
 
     /**
      * Get the users with player roles

package/src/foundry/{foundry.js/clientDocuments/activeEffect.d.ts → client/data/documents/active-effect.d.ts}

@@ -1,7 +1,7 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import type { ActiveEffectDataConstructorData } from '../../common/data/data.mjs/activeEffectData';
-import { EffectChangeData } from '../../common/data/data.mjs/effectChangeData';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
+import { EffectChangeData } from '../../../common/data/data.mjs/effectChangeData';
 
 declare global {
   /**
@@ -138,22 +138,19 @@ declare global {
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.ActiveEffectData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<foundry.data.ActiveEffectData['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Display changes to active effects as scrolling Token status text.

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

@@ -1,7 +1,11 @@
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName, DocumentConstructor } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import EmbeddedCollection from '../../common/abstract/embedded-collection.mjs';
-import type { ActorDataConstructorData } from '../../common/data/data.mjs/actorData.js';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredObjectClassForName,
+  DocumentConstructor
+} from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import EmbeddedCollection from '../../../common/abstract/embedded-collection.mjs';
+import type { ActorDataConstructorData } from '../../../common/data/data.mjs/actorData.js';
 
 declare global {
   /**
@@ -28,7 +32,6 @@ declare global {
    */
   class Actor extends ClientDocumentMixin(foundry.documents.BaseActor) {
     /**
-     * @override
      * @param data    - Initial data provided to construct the Actor document
      * @param context - The document context, see {@link foundry.abstract.Document}
      */
@@ -88,8 +91,7 @@ declare global {
      */
     get token(): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
 
-    /** @override */
-    get uuid(): string;
+    override get uuid(): string;
 
     /**
      * Apply any transformations to the Actor data which are caused by ActiveEffects.
@@ -145,8 +147,7 @@ declare global {
      */
     modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
 
-    /** @override */
-    prepareEmbeddedDocuments(): void;
+    override prepareEmbeddedDocuments(): void;
 
     /**
      * Roll initiative for all Combatants in the currently active Combat encounter which are associated with this Actor.
@@ -158,25 +159,23 @@ declare global {
      */
     rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
 
-    /** @override */
-    getEmbeddedCollection(embeddedName: string): EmbeddedCollection<DocumentConstructor, foundry.data.ActorData>;
+    override getEmbeddedCollection(
+      embeddedName: string
+    ): EmbeddedCollection<DocumentConstructor, foundry.data.ActorData>;
 
-    /** @override */
-    protected _preCreate(
+    protected override _preCreate(
       data: ActorDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.ActorData['_source']>,
       options: DocumentModificationOptions,
       user: string
     ): void;
 
-    /** @override */
-    protected _onCreateEmbeddedDocuments(
+    protected override _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: Record<string, unknown>[],
@@ -184,8 +183,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdateEmbeddedDocuments(
+    protected override _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: Record<string, unknown>[],
@@ -193,8 +191,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onDeleteEmbeddedDocuments(
+    protected override _onDeleteEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: string[],

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -67,8 +67,7 @@ declare global {
      */
     get hasPreviousFace(): boolean;
 
-    /** @override */
-    prepareDerivedData(): void;
+    override prepareDerivedData(): void;
 
     /**
      * Flip this card to some other face. A specific face may be requested, otherwise:

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

@@ -3,8 +3,8 @@ import type {
   ConfiguredDocumentClassForName,
   ConstructorDataType,
   DocumentConstructor
-} from '../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+} from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -35,8 +35,7 @@ declare global {
      */
     get typeLabel(): string;
 
-    /** @override */
-    static createDocuments(
+    static override createDocuments(
       data: Array<
         | ConstructorDataType<foundry.data.CardsData>
         | (ConstructorDataType<foundry.data.CardsData> & Record<string, unknown>)
@@ -180,19 +179,19 @@ declare global {
       context: Record<string, unknown>
     ): Promise<InstanceType<ConfiguredDocumentClassForName<'ChatMessage'>> | undefined>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<foundry.data.CardsData>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _preDelete(options: DocumentModificationOptions, user: foundry.documents.BaseUser): Promise<void>;
+    protected override _preDelete(
+      options: DocumentModificationOptions,
+      user: foundry.documents.BaseUser
+    ): Promise<void>;
 
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
-    /** @override */
-    static deleteDocuments<T extends DocumentConstructor>(
+    static override deleteDocuments<T extends DocumentConstructor>(
       this: T,
       ids?: string[] | undefined,
       context?: DocumentModificationContext | undefined
@@ -231,12 +230,10 @@ declare global {
      */
     resetDialog(): Promise<InstanceType<ConfiguredDocumentClassForName<'Cards'>> | false | null>;
 
-    /** @override */
-    deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
+    override deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
-    /** @override */
-    static createDialog<T extends DocumentConstructor>(
+    static override createDialog<T extends DocumentConstructor>(
       this: T,
       data?:
         | DeepPartial<

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

@@ -1,6 +1,10 @@
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName, ToObjectFalseType } 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 {
   /**
@@ -72,8 +76,7 @@ declare global {
      */
     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.
@@ -209,29 +212,25 @@ declare global {
      */
     protected _renderRollContent(messageData: ChatMessage.MessageData): Promise<void>;
 
-    /** @override */
-    protected _preCreate(
+    protected override _preCreate(
       data: ChatMessageDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.ChatMessageData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: DeepPartial<foundry.data.ChatMessageData['_source']>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _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

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