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

package/src/foundry/{foundry.js/pixi/shaders/abstractBaseShaders/baseSamplerShader.d.ts → client/pixi/webgl/sampler.d.ts}

@@ -2,14 +2,11 @@
  * A simple shader to emulate a PIXI.Sprite with a PIXI.Mesh (but faster!)
  */
 declare class BaseSamplerShader extends AbstractBaseShader {
-  /** @override */
-  static vertexShader: string;
+  static override vertexShader: string;
 
-  /** @override */
-  static fragmentShader: string;
+  static override fragmentShader: string;
 
   /**
-   * @override
    * @defaultValue
    * ```javascript
    * {
@@ -18,5 +15,5 @@ declare class BaseSamplerShader extends AbstractBaseShader {
    * };
    * ```
    */
-  static defaultUniforms: AbstractBaseShader.Uniforms;
+  static override defaultUniforms: AbstractBaseShader.Uniforms;
 }

package/src/foundry/client/tail.d.ts

@@ -0,0 +1,3 @@
+export {};
+
+declare global {}

package/src/foundry/{foundry.js/contextMenu.d.ts → client/ui/context.d.ts}

@@ -1,3 +1,25 @@
+interface ContextMenuEntry {
+  /**
+   * The context menu label. Can be localized.
+   */
+  name: string;
+
+  /**
+   * A string containing an HTML icon element for the menu item
+   */
+  icon: string;
+
+  /**
+   * The function to call when the menu item is clicked. Receives the HTML element of the SidebarTab entry that this context menu is for.
+   */
+  callback: (target: JQuery) => void;
+
+  /**
+   * A function to call to determine if this item appears in the menu. Receives the HTML element of the SidebarTab entry that this context menu is for.
+   */
+  condition?: boolean | ((target: JQuery) => boolean);
+}
+
 /**
  * Display a right-click activated Context Menu which provides a dropdown menu of options
  * A ContextMenu is constructed by designating a parent HTML container and a target selector
@@ -112,25 +134,3 @@ declare namespace ContextMenu {
     animate?: boolean;
   }
 }
-
-interface ContextMenuEntry {
-  /**
-   * The context menu label. Can be localized.
-   */
-  name: string;
-
-  /**
-   * A string containing an HTML icon element for the menu item
-   */
-  icon: string;
-
-  /**
-   * The function to call when the menu item is clicked. Receives the HTML element of the SidebarTab entry that this context menu is for.
-   */
-  callback: (target: JQuery) => void;
-
-  /**
-   * A function to call to determine if this item appears in the menu. Receives the HTML element of the SidebarTab entry that this context menu is for.
-   */
-  condition?: boolean | ((target: JQuery) => boolean);
-}

package/src/foundry/{foundry.js/applications → client/ui}/dialog.d.ts

@@ -46,7 +46,6 @@ declare class Dialog<Options extends DialogOptions = DialogOptions> extends Appl
   data: Dialog.Data;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -57,22 +56,13 @@ declare class Dialog<Options extends DialogOptions = DialogOptions> extends Appl
    * })
    * ```
    */
-  static get defaultOptions(): DialogOptions;
+  static override get defaultOptions(): DialogOptions;
 
-  /**
-   * @override
-   */
   static get title(): string;
 
-  /**
-   * @override
-   */
-  getData(options?: Partial<Options>): { content: string; buttons: Record<string, Dialog.Button> };
+  override getData(options?: Partial<Options>): { content: string; buttons: Record<string, Dialog.Button> };
 
-  /**
-   * @override
-   */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle a left-mouse click on one of the dialog choice buttons
@@ -93,10 +83,7 @@ declare class Dialog<Options extends DialogOptions = DialogOptions> extends Appl
    */
   protected submit(button: Dialog.Button): void;
 
-  /**
-   * @override
-   */
-  close(options?: Application.CloseOptions): Promise<void>;
+  override close(options?: Application.CloseOptions): Promise<void>;
 
   /**
    * A helper factory method to create simple confirmation dialog windows which consist of simple yes/no prompts.
@@ -200,7 +187,7 @@ declare namespace Dialog {
     /**
      * The name of the default button which should be triggered on Enter
      */
-    default: string;
+    default?: string | undefined;
   }
 }
 

package/src/foundry/{foundry.js/textEditor.d.ts → client/ui/editor.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../types/helperTypes';
 
 declare global {
   /**

package/src/foundry/{foundry.js/applications/filePicker.d.ts → client/ui/filepicker.d.ts}

@@ -127,7 +127,6 @@ declare class FilePicker<
   static S3_BUCKETS: string[] | null;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -141,7 +140,7 @@ declare class FilePicker<
    * })
    * ```
    */
-  static get defaultOptions(): FilePickerOptions;
+  static override get defaultOptions(): FilePickerOptions;
 
   /**
    * Given a current file path, determine the directory it belongs to
@@ -170,10 +169,7 @@ declare class FilePicker<
    */
   static parseS3URL(key: string): { bucket: string | null; keyPrefix: string };
 
-  /**
-   * @override
-   */
-  get title(): string;
+  override get title(): string;
 
   /**
    * Return the source object for the currently active source
@@ -195,11 +191,7 @@ declare class FilePicker<
    */
   static get uploadURL(): string;
 
-  /**
-   * @override
-   * @param options - (unused)
-   */
-  getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
+  override getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
   /**
    * Browse to a specific location for this FilePicker instance
@@ -283,13 +275,11 @@ declare class FilePicker<
   ): Promise<FilePicker.UploadResult | false | void | {}>;
 
   /**
-   * @override
    * Additional actions performed when the file-picker UI is rendered
    */
-  render(force?: boolean | undefined, options?: Application.RenderOptions<Options> | undefined): this;
+  override render(force?: boolean | undefined, options?: Application.RenderOptions<Options> | undefined): this;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+  override activateListeners(html: JQuery): void;
 
   /**
    * Handle a click event to change the display mode of the File Picker
@@ -298,36 +288,18 @@ declare class FilePicker<
    */
   protected _onChangeDisplayMode(event: JQuery.ClickEvent): void;
 
-  /**
-   * @param event - (unused)
-   * @param event - (unused)
-   * @override
-   * @internal
-   */
-  protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: this['activeSource']): void;
+  protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: this['activeSource']): void;
 
-  /**
-   * @override
-   * @param selector - (unused)
-   */
-  protected _canDragStart(selector: string | null): boolean;
+  protected override _canDragStart(selector: string | null): boolean;
 
-  /**
-   * @override
-   * @param selector - (unused)
-   */
-  protected _canDragDrop(selector: string | null): boolean;
+  protected override _canDragDrop(selector: string | null): boolean;
 
-  /**
-   * @override
-   */
-  protected _onDragStart(event: DragEvent): void;
+  protected override _onDragStart(event: DragEvent): void;
 
   /**
-   * @override
    * @internal
    */
-  protected _onDrop(event: DragEvent): void;
+  protected override _onDrop(event: DragEvent): void;
 
   /**
    * Handle user submission of the address bar to request an explicit target
@@ -367,11 +339,10 @@ declare class FilePicker<
    */
   protected _onChangeBucket(event: JQuery.ChangeEvent): void;
 
-  /**
-   * @override */
-  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+  /** */
+
+  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
-  /** @override */
   protected _onSubmit(ev: Event): void;
 
   /**

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

@@ -0,0 +1,10 @@
+import './context';
+import './dialog';
+import './drag';
+import './dragdrop';
+import './editor';
+import './filepicker';
+import './filter';
+import './forms';
+import './notifications';
+import './tabs';

package/src/foundry/{foundry.js/applications → client/ui}/notifications.d.ts

@@ -29,7 +29,6 @@ declare class Notifications<Options extends ApplicationOptions = ApplicationOpti
   active: JQuery[];
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * mergeObject(super.defaultOptions, {
@@ -39,18 +38,16 @@ declare class Notifications<Options extends ApplicationOptions = ApplicationOpti
    * });
    * ```
    */
-  static get defaultOptions(): ApplicationOptions;
+  static override get defaultOptions(): ApplicationOptions;
 
   /**
    * Initialize the Notifications system by displaying any system-generated messages which were passed from the server.
    */
   initialize(): void;
 
-  /** @override */
-  protected _renderInner(data: object): Promise<JQuery>;
+  protected override _renderInner(data: object): Promise<JQuery>;
 
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
   /**
    * Push a new notification into the queue

package/src/foundry/common/data/data.mjs/activeEffectData.d.ts

@@ -161,8 +161,7 @@ export class ActiveEffectData extends DocumentData<
   ActiveEffectDataConstructorData,
   documents.BaseActiveEffect
 > {
-  /** @override */
-  static defineSchema(): ActiveEffectDataSchema;
+  static override defineSchema(): ActiveEffectDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/actorData.d.ts

@@ -190,7 +190,6 @@ type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentDa
 interface ActorDataConstructor extends DocumentDataConstructor {
   new (data: ActorDataConstructorData, document?: documents.BaseActor | null): ActorData;
 
-  /** @override */
   defineSchema(): ActorDataSchema;
 
   /**
@@ -212,10 +211,8 @@ export type ActorData = DocumentData<
   documents.BaseActor
 > &
   ActorDataProperties & {
-    /** @override */
     _initializeSource(data: ActorDataConstructorData): ActorDataSource;
 
-    /** @override */
     _initialize(): void;
   };
 

package/src/foundry/common/data/data.mjs/adventureData.d.ts

@@ -145,8 +145,7 @@ export class AdventureData extends DocumentData<
   AdventureDataSource,
   AdventureDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): AdventureDataSchema;
+  static override defineSchema(): AdventureDataSchema;
 
   /**
    * A type of data field which stores a collection of document data objects

package/src/foundry/common/data/data.mjs/ambientLightData.d.ts

@@ -143,14 +143,11 @@ export class AmbientLightData extends DocumentData<
   AmbientLightDataConstructorData,
   BaseAmbientLight
 > {
-  /** @override */
-  static defineSchema(): AmbientLightDataSchema;
+  static override defineSchema(): AmbientLightDataSchema;
 
-  /** @override */
-  _initializeSource(data: AmbientLightDataConstructorData): AmbientLightDataSource;
+  override _initializeSource(data: AmbientLightDataConstructorData): AmbientLightDataSource;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/ambientSoundData.d.ts

@@ -184,14 +184,11 @@ export class AmbientSoundData extends DocumentData<
   AmbientSoundDataConstructorData,
   documents.BaseAmbientSound
 > {
-  /** @override */
-  static defineSchema(): AmbientSoundDataSchema;
+  static override defineSchema(): AmbientSoundDataSchema;
 
-  /** @override */
-  _initializeSource(data: AmbientSoundDataConstructorData): AmbientSoundDataSource;
+  override _initializeSource(data: AmbientSoundDataConstructorData): AmbientSoundDataSource;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/animationData.d.ts

@@ -84,8 +84,7 @@ export class AnimationData extends DocumentData<
   AnimationDataConstructorData,
   BaseAmbientLight
 > {
-  /** @override */
-  static defineSchema(): AnimationDataSchema;
+  static override defineSchema(): AnimationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/cardData.d.ts

@@ -245,7 +245,6 @@ type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentDa
 interface CardDataConstructor extends DocumentDataConstructor {
   new (data: CardDataConstructorData, document?: documents.BaseCard | null | undefined): CardData;
 
-  /** @override */
   defineSchema(): CardDataSchema;
 }
 

package/src/foundry/common/data/data.mjs/cardFaceData.d.ts

@@ -54,8 +54,7 @@ export class CardFaceData extends DocumentData<
   CardFaceDataSource,
   CardFaceDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): CardFaceDataSchema;
+  static override defineSchema(): CardFaceDataSchema;
 
   /**
    * The default icon used for a card face that does not have a custom image set

package/src/foundry/common/data/data.mjs/cardsData.d.ts

@@ -211,7 +211,6 @@ type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentDa
 interface CardsDataConstructor extends DocumentDataConstructor {
   new (data: CardsDataConstructorData, document?: documents.BaseCards | null | undefined): CardsData;
 
-  /** @override */
   defineSchema(): CardsDataSchema;
 
   /**

package/src/foundry/common/data/data.mjs/chatMessageData.d.ts

@@ -206,8 +206,7 @@ export class ChatMessageData extends DocumentData<
   ChatMessageDataConstructorData,
   documents.BaseChatMessage
 > {
-  /** @override */
-  static defineSchema(): ChatMessageDataSchema;
+  static override defineSchema(): ChatMessageDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/chatSpeakerData.d.ts

@@ -73,8 +73,7 @@ export class ChatSpeakerData extends DocumentData<
   ChatSpeakerDataConstructorData,
   BaseChatMessage
 > {
-  /** @override */
-  static defineSchema(): ChatSpeakerDataSchema;
+  static override defineSchema(): ChatSpeakerDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/combatData.d.ts

@@ -142,8 +142,7 @@ export class CombatData extends DocumentData<
   CombatDataConstructorData,
   documents.BaseCombat
 > {
-  /** @override */
-  static defineSchema(): CombatDataSchema;
+  static override defineSchema(): CombatDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/combatantData.d.ts

@@ -129,8 +129,7 @@ export class CombatantData extends DocumentData<
   CombatantDataConstructorData,
   documents.BaseCombatant
 > {
-  /** @override */
-  static defineSchema(): CombatantDataSchema;
+  static override defineSchema(): CombatantDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/darknessActivation.d.ts

@@ -48,8 +48,7 @@ export class DarknessActivation extends DocumentData<
   DarknessActivationConstructorData,
   BaseAmbientLight
 > {
-  /** @override */
-  static defineSchema(): DarknessActivationSchema;
+  static override defineSchema(): DarknessActivationSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/drawingData.d.ts

@@ -389,14 +389,11 @@ export class DrawingData extends DocumentData<
   DrawingDataConstructorData,
   documents.BaseFolder
 > {
-  /** @override */
-  static defineSchema(): DrawingDataSchema;
+  static override defineSchema(): DrawingDataSchema;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 
-  /** @override */
-  protected _validateDocument(): void;
+  protected override _validateDocument(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/effectChangeData.d.ts

@@ -27,7 +27,7 @@ interface EffectChangeDataProperties {
    * The modification mode with which the change is applied
    * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
    */
-  mode: foundry.CONST.ACTIVE_EFFECT_MODES;
+  mode: number;
 
   /**
    * The priority level with which this change is applied
@@ -52,7 +52,7 @@ interface EffectChangeDataConstructorData {
    * The modification mode with which the change is applied
    * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
    */
-  mode?: foundry.CONST.ACTIVE_EFFECT_MODES | null | undefined;
+  mode?: number | null | undefined;
 
   /**
    * The priority level with which this change is applied
@@ -73,8 +73,7 @@ export class EffectChangeData extends DocumentData<
   EffectChangeDataConstructorData,
   BaseActiveEffect
 > {
-  /** @override */
-  static defineSchema(): EffectChangeDataSchema;
+  static override defineSchema(): EffectChangeDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/effectDurationData.d.ts

@@ -102,8 +102,7 @@ export class EffectDurationData extends DocumentData<
   EffectDurationDataConstructorData,
   BaseActiveEffect
 > {
-  /** @override */
-  static defineSchema(): EffectDurationDataSchema;
+  static override defineSchema(): EffectDurationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/fogExplorationData.d.ts

@@ -108,8 +108,7 @@ export class FogExplorationData extends DocumentData<
   FogExplorationDataSource,
   FogExplorationDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): FogExplorationDataSchema;
+  static override defineSchema(): FogExplorationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/folderData.d.ts

@@ -144,8 +144,7 @@ export class FolderData extends DocumentData<
 > {
   constructor(data: FolderDataConstructorData, document?: documents.BaseFolder | null);
 
-  /** @override */
-  static defineSchema(): FolderDataSchema;
+  static override defineSchema(): FolderDataSchema;
 
   static SORTING_MODES: ['a', 'm'];
 }

package/src/foundry/common/data/data.mjs/itemData.d.ts

@@ -158,7 +158,6 @@ type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentDa
 interface ItemDataConstructor extends DocumentDataConstructor {
   new (data: ItemDataConstructorData, document?: documents.BaseItem | null): ItemData;
 
-  /** @override */
   defineSchema(): ItemDataSchema;
 
   /**
@@ -180,7 +179,6 @@ export type ItemData = DocumentData<
   documents.BaseItem
 > &
   ItemDataProperties & {
-    /** @override */
     _initializeSource(data: ItemDataConstructorData): ItemDataSource;
   };
 export const ItemData: ItemDataConstructor;

package/src/foundry/common/data/data.mjs/journalEntryData.d.ts

@@ -125,8 +125,7 @@ export class JournalEntryData extends DocumentData<
 > {
   constructor(data: JournalEntryDataConstructorData, document?: documents.BaseJournalEntry | null);
 
-  /** @override */
-  static defineSchema(): JournalEntryDataSchema;
+  static override defineSchema(): JournalEntryDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/data/data.mjs/lightData.d.ts

@@ -196,19 +196,16 @@ export class LightData extends DocumentData<
   LightDataConstructorData,
   documents.BaseAmbientLight | documents.BaseToken
 > {
-  /** @override */
-  static defineSchema(): LightDataSchema;
+  static override defineSchema(): LightDataSchema;
 
   /**
    * A reusable field definition for uniform fields used by LightData
    */
   static LIGHT_UNIFORM_FIELD: LightData.LightUniformField;
 
-  /** @override */
-  _initializeSource(data: LightDataConstructorData): LightDataSource;
+  override _initializeSource(data: LightDataConstructorData): LightDataSource;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 }
 
 declare namespace LightData {

package/src/foundry/common/data/data.mjs/macroData.d.ts

@@ -186,8 +186,7 @@ export class MacroData extends DocumentData<
 > {
   constructor(data: MacroDataConstructorData, document?: documents.BaseMacro | null);
 
-  /** @override */
-  static defineSchema(): MacroDataSchema;
+  static override defineSchema(): MacroDataSchema;
 
   /**
    * The default icon used for newly created Macro documents.

package/src/foundry/common/data/data.mjs/measuredTemplateData.d.ts

@@ -201,14 +201,11 @@ export class MeasuredTemplateData extends DocumentData<
     document: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
   );
 
-  /** @override */
-  static defineSchema(): MeasuredTemplateDataSchema;
+  static override defineSchema(): MeasuredTemplateDataSchema;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 
-  /** @override */
-  protected _validateDocument(): void;
+  protected override _validateDocument(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface