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

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 {
   /**
@@ -76,15 +76,13 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    protected _onUpdate(
+    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'> & {

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

@@ -1,24 +1,24 @@
-import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 import type {
   AmbientLightDataConstructorData,
   AmbientLightDataSource
-} from '../../common/data/data.mjs/ambientLightData';
+} from '../../../common/data/data.mjs/ambientLightData';
 import type {
   AmbientSoundDataConstructorData,
   AmbientSoundDataSource
-} from '../../common/data/data.mjs/ambientSoundData';
-import type { DrawingDataConstructorData, DrawingDataSource } from '../../common/data/data.mjs/drawingData';
+} from '../../../common/data/data.mjs/ambientSoundData';
+import type { DrawingDataConstructorData, DrawingDataSource } from '../../../common/data/data.mjs/drawingData';
 import type {
   MeasuredTemplateDataConstructorData,
   MeasuredTemplateDataSource
-} from '../../common/data/data.mjs/measuredTemplateData';
-import type { NoteDataConstructorData, NoteDataSource } from '../../common/data/data.mjs/noteData';
-import type { TileDataConstructorData, TileDataSource } from '../../common/data/data.mjs/tileData';
-import type { TokenDataConstructorData, TokenDataSource } from '../../common/data/data.mjs/tokenData';
-import type { WallDataConstructorData, WallDataSource } from '../../common/data/data.mjs/wallData';
+} from '../../../common/data/data.mjs/measuredTemplateData';
+import type { NoteDataConstructorData, NoteDataSource } from '../../../common/data/data.mjs/noteData';
+import type { TileDataConstructorData, TileDataSource } from '../../../common/data/data.mjs/tileData';
+import type { TokenDataConstructorData, TokenDataSource } from '../../../common/data/data.mjs/tokenData';
+import type { WallDataConstructorData, WallDataSource } from '../../../common/data/data.mjs/wallData';
 
-import type { SceneDataConstructorData } from '../../common/data/data.mjs/sceneData';
+import type { SceneDataConstructorData } from '../../../common/data/data.mjs/sceneData';
 
 declare global {
   /**
@@ -105,51 +105,46 @@ declare global {
     view(): Promise<this | undefined>;
 
     /**
-     * @override
      * @param createData - (default: `{}`)
      * @param options    - (default: `{}`)
      */
-    clone(
+    override clone(
       createData?: DeepPartial<SceneDataConstructorData | (SceneDataConstructorData & Record<string, unknown>)>,
       options?: { save?: boolean; keepId?: boolean }
     ): TemporaryDocument<this> | Promise<TemporaryDocument<this | undefined>>;
 
-    /** @override */
-    prepareBaseData(): void;
+    override prepareBaseData(): void;
 
-    /** @override */
-    protected _preCreate(
+    protected override _preCreate(
       data: SceneDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.SceneData['_source'],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override */
-    protected _preUpdate(
+    protected override _preUpdate(
       changed: DeepPartial<SceneDataConstructorData>,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       changed: DeepPartial<foundry.data.SceneData['_source']> & Record<string, unknown>,
       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>;
 
-    /** @override */
-    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Handle Scene activation workflow if the active state is changed to true
@@ -157,8 +152,7 @@ declare global {
      */
     protected _onActivate(active: boolean): ReturnType<this['view']> | ReturnType<Canvas['draw']> | void;
 
-    /** @override */
-    _preCreateEmbeddedDocuments(
+    override _preCreateEmbeddedDocuments(
       embeddedName: string,
       result: DrawingDataConstructorData[],
       options: DocumentModificationOptions,
@@ -207,8 +201,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    _onCreateEmbeddedDocuments(
+    override _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>[],
       result: DeepPartial<DrawingDataSource>[],
@@ -265,8 +258,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    _preUpdateEmbeddedDocuments(
+    override _preUpdateEmbeddedDocuments(
       embeddedName: string,
       result: DeepPartial<DrawingDataSource>[],
       options: DocumentModificationContext,
@@ -315,8 +307,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    _onUpdateEmbeddedDocuments(
+    override _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>[],
       result: DeepPartial<DrawingDataSource>[],
@@ -373,16 +364,14 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    _preDeleteEmbeddedDocuments(
+    override _preDeleteEmbeddedDocuments(
       embeddedName: string,
       result: string[],
       options: DocumentModificationContext,
       userId: string
     ): void;
 
-    /** @override */
-    _onDeleteEmbeddedDocuments(
+    override _onDeleteEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>[],
       result: string[],
@@ -439,8 +428,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    toCompendium(
+    override toCompendium(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
       options?: ClientDocumentMixin.CompendiumExportOptions | undefined
     ): Omit<foundry.data.SceneData['_source'], '_id' | 'folder' | 'permission'> & {

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

@@ -1,4 +1,4 @@
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 declare global {
   /**
    * The client-side Setting document which extends the common BaseSetting model.
@@ -18,8 +18,7 @@ declare global {
      */
     get value(): unknown;
 
-    /** @override */
-    protected _onCreate(
+    protected override _onCreate(
       data: foundry.data.SettingData['_source'],
       options: DocumentModificationOptions,
       userId: string

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

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**
@@ -92,8 +92,7 @@ declare global {
      */
     getResultsForRoll(value: number): InstanceType<ConfiguredDocumentClass<typeof TableResult>>[];
 
-    /** @override */
-    protected _onCreateEmbeddedDocuments(
+    protected override _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: foundry.abstract.Document<any, any>[],
       result: Record<string, unknown>[],
@@ -101,8 +100,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    _onDeleteEmbeddedDocuments(
+    override _onDeleteEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof TableResult>>[],
       result: string[],
@@ -110,8 +108,7 @@ declare global {
       userId: string
     ): void;
 
-    /** @override */
-    toCompendium(
+    override toCompendium(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
       options?: ClientDocumentMixin.CompendiumExportOptions | undefined
     ): Omit<foundry.data.RollTableData['_source'], '_id' | 'folder' | 'permission'> & {

package/src/foundry/{foundry.js/clientDocuments/canvasDocuments/tileDocument.d.ts → client/data/documents/tile.d.ts}

@@ -7,9 +7,7 @@
  * @see {@link applications.TileConfig}       The Tile configuration application
  */
 declare class TileDocument extends CanvasDocumentMixin(foundry.documents.BaseTile) {
-  /** @override */
-  prepareDerivedData(): void;
+  override prepareDerivedData(): void;
 
-  /** @override */
-  get layer(): ForegroundLayer | BackgroundLayer;
+  override get layer(): ForegroundLayer | BackgroundLayer;
 }

package/src/foundry/{foundry.js/clientDocuments/canvasDocuments/tokenDocument.d.ts → client/data/documents/token.d.ts}

@@ -1,7 +1,9 @@
 import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-import * as data from '../../../common/data/data.mjs';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs.js';
+import * as data from '../../../common/data/data.mjs/index.js';
+
 import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
+import type { PrototypeTokenDataConstructorData } from '../../../common/data/data.mjs/prototypeTokenData';
 
 declare global {
   /**
@@ -64,9 +66,8 @@ declare global {
     /**
      * @param data    - (default: `{}`, unused)
      * @param options - (default: `{}`, unused)
-     * @override
      */
-    clone(
+    override clone(
       data?: Parameters<foundry.documents.BaseToken['clone']>[0],
       options?: Parameters<foundry.documents.BaseToken['clone']>[1]
     ): TemporaryDocument<this>;
@@ -114,8 +115,7 @@ declare global {
       options: Parameters<this['update']>[1]
     ): Promise<[this['actor']]>;
 
-    /** @override */
-    getEmbeddedCollection(embeddedName: 'Item'): data.ActorData['items'];
+    override getEmbeddedCollection(embeddedName: 'Item'): data.ActorData['items'];
     getEmbeddedCollection(embeddedName: 'ActiveEffect'): data.ActorData['effects'];
 
     /**
@@ -172,8 +172,7 @@ declare global {
       options: Parameters<this['update']>[1]
     ): Promise<InstanceType<ConfiguredDocumentClass<typeof ActiveEffect>>[]>;
 
-    /** @override */
-    protected _preUpdate(
+    protected override _preUpdate(
       data: Parameters<foundry.documents.BaseToken['_preUpdate']>[0],
       options: DocumentModificationOptions,
       user: InstanceType<ConfiguredDocumentClass<typeof User>>
@@ -189,8 +188,7 @@ declare global {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>
     ): Promise<void>;
 
-    /** @override */
-    protected _onUpdate(
+    protected override _onUpdate(
       data: Parameters<foundry.documents.BaseToken['_onUpdate']>[0],
       options: DocumentModificationOptions,
       userId: string
@@ -230,6 +228,27 @@ declare global {
      */
     static getTrackedAttributeChoices(attributes?: TrackedAttributes): Record<string, string[]>;
   }
+
+  /**
+   * An extended Document definition used specifically
+   * This ensures that the PrototypeTokenData schema is used instead of the standard TokenData.
+   * This exists specifically for prototype Token configuration in the TokenConfig app and should not be used otherwise.
+   * @internal
+   * @remarks The types for this are incorrect, in particular everything related to the data should use
+   * {@link foundry.data.PrototypeTokenData} instead of {@link foundry.data.TokenData}. However, with the current approach
+   * to type documents, we don't see a way to do this. This class is just added for reference. As the documentation above
+   * says, don't use it (there really shouldn't be a need to do so).
+   */
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  class PrototypeTokenDocument extends TokenDocument {
+    static get schema(): typeof foundry.data.PrototypeTokenData;
+
+    override update(
+      data?: DeepPartial<PrototypeTokenDataConstructorData> | undefined,
+      context?: (DocumentModificationContext & foundry.utils.MergeObjectOptions) | undefined
+    ): Promise<this | undefined>;
+  }
 }
 
 interface SingleAttributeBar {

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

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentDataType, DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { DocumentDataType, DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   interface ActivityData {
@@ -135,15 +135,13 @@ declare global {
      */
     updateTokenTargets(targetIds?: string[]): void;
 
-    /** @override  */
-    _onUpdate(
+    override _onUpdate(
       data: DeepPartial<DocumentDataType<foundry.documents.BaseUser>>,
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    /** @override  */
-    _onDelete(options: DocumentModificationOptions, userId: string): void;
+    override _onDelete(options: DocumentModificationOptions, userId: string): void;
 
     /** @remarks This property is set by PlayerList.getData() */
     charname?: string;

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

@@ -0,0 +1,3 @@
+import './abstract';
+import './collections';
+import './documents';

package/src/foundry/{foundry.js/rollTerms/diceTerms → client/dice/dice}/coin.d.ts

@@ -21,20 +21,11 @@ declare class Coin extends DiceTerm {
    */
   static MODIFIERS: Coin.Modifiers;
 
-  /**
-   * @override
-   */
-  roll(options?: { maximize: boolean; minimize: boolean }): DiceTerm.Result;
+  override roll(options?: { maximize: boolean; minimize: boolean }): DiceTerm.Result;
 
-  /**
-   * @override
-   */
-  getResultLabel(result: DiceTerm.Result): string;
+  override getResultLabel(result: DiceTerm.Result): string;
 
-  /**
-   * @override
-   */
-  getResultCSS(result: DiceTerm.Result): (string | null)[];
+  override getResultCSS(result: DiceTerm.Result): (string | null)[];
 
   /**
    * Call the result of the coin flip, marking any coins that matched the called target as a success

package/src/foundry/{foundry.js/rollTerms/diceTerms → client/dice/dice}/die.d.ts

@@ -11,13 +11,11 @@ declare class Die extends DiceTerm {
   constructor(termData?: Partial<Die.TermData>);
 
   /**
-   * @override
    * @defaultValue `"d"`
    */
-  static DENOMINATION: string;
+  static override DENOMINATION: string;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * {
@@ -43,12 +41,9 @@ declare class Die extends DiceTerm {
    * }
    * ```
    */
-  static MODIFIERS: Die.Modifiers;
+  static override MODIFIERS: Die.Modifiers;
 
-  /**
-   * @override
-   */
-  get total(): number | null;
+  override get total(): number | null;
 
   /**
    * Re-roll the Die, rolling additional results for any values which fall within a target set.

package/src/foundry/{foundry.js/rollTerms/diceTerms/fateDie.d.ts → client/dice/dice/fate.d.ts}

@@ -12,18 +12,11 @@ declare class FateDie extends DiceTerm {
    */
   static DENOMINATION: string;
 
-  /** @override */
-  static MODIFIERS: FateDie.Modifiers;
+  static override MODIFIERS: FateDie.Modifiers;
 
-  /**
-   * @override
-   */
-  roll({ minimize, maximize }?: { minimize: boolean; maximize: boolean }): DiceTerm.Result;
+  override roll({ minimize, maximize }?: { minimize: boolean; maximize: boolean }): DiceTerm.Result;
 
-  /**
-   * @override
-   */
-  getResultLabel(result: DiceTerm.Result): string;
+  override getResultLabel(result: DiceTerm.Result): string;
 }
 
 declare namespace FateDie {

package/src/foundry/client/dice/dice/index.d.ts

@@ -0,0 +1,3 @@
+import './coin';
+import './die';
+import './fate';

package/src/foundry/client/dice/index.d.ts

@@ -0,0 +1,5 @@
+import './dice';
+import './roll';
+import './term';
+import './terms';
+import './twister';