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

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

@@ -1,3 +1,32 @@
+interface FilePickerOptions extends ApplicationOptions {
+  /** A type of file to target, in "audio", "image", "video", "imagevideo" or "folder" */
+  type?: FilePicker.Type | undefined;
+
+  /** The current file path being modified, if any */
+  current?: string | undefined;
+
+  /** A current file source in "data", "public", or "s3" */
+  activeSource?: FilePicker.SourceType | undefined;
+
+  /** A callback function to trigger once a file has been selected */
+  callback?: FilePicker.Callback | undefined;
+
+  /** A flag which permits explicitly disallowing upload, true by default */
+  allowUpload?: boolean | undefined;
+
+  /** An HTML form field that the result of this selection is applied to */
+  field?: HTMLElement | undefined;
+
+  /** An HTML button element which triggers the display of this picker */
+  button?: HTMLElement | undefined;
+
+  /** The picker display mode in FilePicker.DISPLAY_MODES */
+  displayMode?: FilePicker.DisplayMode | undefined;
+
+  /** Display the tile size configuration. */
+  tileSize?: boolean | undefined;
+}
+
 /**
  * The FilePicker application renders contents of the server-side public directory
  * This app allows for navigating and uploading files to the public path
@@ -5,13 +34,13 @@
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class FilePicker<
-  Options extends FilePicker.Options = FilePicker.Options,
+  Options extends FilePickerOptions = FilePickerOptions,
   Data extends object = FilePicker.Data
 > extends Application<Options> {
   /**
    * @param options - Options that configure the behavior of the FilePicker
    */
-  constructor(options?: Partial<Options>);
+  constructor(options?: Partial<Options> | undefined);
 
   /**
    * The full requested path given by the user
@@ -43,7 +72,7 @@ declare class FilePicker<
   /**
    * The general file type which controls the set of extensions which will be accepted
    */
-  type: FilePicker.Type | undefined;
+  type: FilePicker.Type;
 
   /**
    * The target HTML element this file picker is bound to
@@ -98,7 +127,6 @@ declare class FilePicker<
   static S3_BUCKETS: string[] | null;
 
   /**
-   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -112,7 +140,7 @@ declare class FilePicker<
    * })
    * ```
    */
-  static get defaultOptions(): FilePicker.Options;
+  static override get defaultOptions(): FilePickerOptions;
 
   /**
    * Given a current file path, determine the directory it belongs to
@@ -141,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
@@ -166,18 +191,14 @@ declare class FilePicker<
    */
   static get uploadURL(): string;
 
-  /**
-   * @override
-   * @param options - (unused)
-   */
-  getData(options?: Partial<Options>): Data | Promise<Data>;
+  override getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
   /**
    * Browse to a specific location for this FilePicker instance
    * @param target - The target within the currently active source location.
    * @param options - Browsing options (default: `{}`)
    */
-  browse(target: string, options?: FilePicker.BrowseOptions): Promise<FilePicker.BrowseResult | undefined>;
+  browse(target: string, options?: FilePicker.BrowseOptions | undefined): Promise<FilePicker.BrowseResult | undefined>;
 
   /**
    * Browse files for a certain directory location
@@ -190,7 +211,7 @@ declare class FilePicker<
   static browse(
     source: FilePicker.SourceType,
     target: string,
-    options?: FilePicker.BrowseOptions
+    options?: FilePicker.BrowseOptions | undefined
   ): Promise<FilePicker.BrowseResult>;
 
   /**
@@ -202,7 +223,7 @@ declare class FilePicker<
   static configurePath(
     source: FilePicker.SourceType,
     target: string,
-    options?: FilePicker.ConfigurePathOptions
+    options?: FilePicker.ConfigurePathOptions | undefined
   ): Promise<FilePicker.ConfigurePathResult>;
 
   /**
@@ -214,7 +235,7 @@ declare class FilePicker<
   static createDirectory(
     source: FilePicker.SourceType,
     target: string,
-    options?: FilePicker.CreateDirectoryOptions
+    options?: FilePicker.CreateDirectoryOptions | undefined
   ): Promise<string>;
 
   /**
@@ -223,15 +244,15 @@ declare class FilePicker<
    */
   protected static _manageFiles(
     data: FilePicker.BrowseFilesData,
-    options?: FilePicker.BrowseOptions
+    options?: FilePicker.BrowseOptions | undefined
   ): Promise<FilePicker.BrowseResult>;
   protected static _manageFiles(
     data: FilePicker.ConfigurePathData,
-    options?: FilePicker.ConfigurePathOptions
+    options?: FilePicker.ConfigurePathOptions | undefined
   ): Promise<FilePicker.ConfigurePathResult>;
   protected static _manageFiles(
     data: FilePicker.CreateDirectoryData,
-    options?: FilePicker.CreateDirectoryOptions
+    options?: FilePicker.CreateDirectoryOptions | undefined
   ): Promise<string>;
 
   /**
@@ -239,24 +260,26 @@ declare class FilePicker<
    * @param source  - The data source to which the file should be uploaded
    * @param path    - The destination path
    * @param file    - The File object to upload
-   * @param options - Additional file upload options passed as form data (default `{}`)
+   * @param body    - Additional file upload options sent in the POST body
+   *                  (default: `{}`)
+   * @param options - Additional options to configure how the method behaves
+   *                  (default `{}`)
    * @returns The response object
    */
   static upload(
     source: FilePicker.SourceType,
     path: string,
     file: File,
-    options?: FilePicker.UploadOptions
-  ): Promise<FilePicker.UploadResult | false | void>;
+    body?: FilePicker.UploadBody | undefined,
+    options?: FilePicker.UploadOptions | undefined
+  ): Promise<FilePicker.UploadResult | false | void | {}>;
 
   /**
-   * @override
    * Additional actions performed when the file-picker UI is rendered
    */
-  render(force?: boolean, options?: Application.RenderOptions<Options>): unknown;
+  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
@@ -265,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
@@ -323,8 +328,8 @@ declare class FilePicker<
   protected _onClickDirectoryControl(event: JQuery.ClickEvent): void;
 
   /**
-   * Present the user with a dialog to create a subdirectory within their currentl
-   * @internal browsed file storate location.
+   * Present the user with a dialog to create a subdirectory within their currently browsed file storate location.
+   * @internal
    */
   protected _createDirectoryDialog(source: FilePicker.Source): void;
 
@@ -334,19 +339,16 @@ declare class FilePicker<
    */
   protected _onChangeBucket(event: JQuery.ChangeEvent): void;
 
-  /**
-   * @override
-   * @param event - (unused)
-   */
-  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+  /** */
+
+  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
-  /**
-   * Handle file picker form submission
-   */
   protected _onSubmit(ev: Event): void;
 
   /**
    * Handle file upload
+   * @param ev - The file upload event
+   * @internal
    */
   protected _onUpload(ev: Event): void;
 
@@ -356,7 +358,7 @@ declare class FilePicker<
    * The data-target attribute should provide the name of the input field which should receive the selected file
    * The data-type attribute is a string in ["image", "audio"] which sets the file extensions which will be accepted
    *
-   * @param button  - The button element
+   * @param button - The button element
    */
   static fromButton(button: HTMLButtonElement): FilePicker;
 }
@@ -467,53 +469,6 @@ declare namespace FilePicker {
     action: 'createDirectory';
   }
 
-  /**
-   * Options for configuring FilePicker
-   */
-  interface Options extends ApplicationOptions {
-    /**
-     * A type of file to target, in "audio", "image", "video", "imagevideo" or "folder"
-     */
-    type?: Type | undefined;
-
-    /**
-     * The current file path being modified, if any
-     */
-    current?: string | undefined;
-
-    /**
-     * A current file source in "data", "public", or "s3"
-     */
-    activeSource?: SourceType | undefined;
-
-    /**
-     * A callback function to trigger once a file has been selected
-     */
-    callback?: Callback | undefined;
-
-    /**
-     * A flag which permits explicitly disallowing upload, true by default
-     */
-    allowUpload?: boolean | undefined;
-
-    /**
-     * An HTML form field that the result of this selection is applied to
-     */
-    field?: HTMLElement | undefined;
-
-    /**
-     * An HTML button element which triggers the display of this picker
-     */
-    button?: HTMLElement | undefined;
-
-    /**
-     * The picker display mode in FilePicker.DISPLAY_MODES
-     */
-    displayMode?: DisplayMode | undefined;
-
-    tileSize?: boolean | undefined;
-  }
-
   interface Source {
     target: string;
     label: string;
@@ -529,14 +484,22 @@ declare namespace FilePicker {
     };
   }
 
-  type Type = 'audio' | 'image' | 'video' | 'imagevideo' | 'folder';
+  type Type = 'any' | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder';
 
-  interface UploadOptions {
+  interface UploadBody {
     /**
      * A bucket to upload to, if using the S3 source
      * @defaultValue `""`
      */
-    bucket?: string | null;
+    bucket?: string | null | undefined;
+  }
+
+  interface UploadOptions {
+    /**
+     * Display a UI notification when the upload is processed
+     * @defaultValue `true`
+     */
+    notify?: string | undefined;
   }
 
   interface UploadResult {

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/index.d.ts

@@ -26,7 +26,6 @@ export { SceneData } from './sceneData';
 export { SettingData } from './settingData';
 export { TableResultData } from './tableResultData';
 export { TileData } from './tileData';
-export { TokenBarData } from './tokenBarData';
 export { TokenData } from './tokenData';
 export { UserData } from './userData';
 export { WallData } from './wallData';