@league-of-foundry-developers/foundry-vtt-types 0.8.9-4 → 0.8.9-8

package/src/foundry/foundry.js/applications/filePicker.d.ts

@@ -1,13 +1,17 @@
 /**
  * The FilePicker application renders contents of the server-side public directory
  * This app allows for navigating and uploading files to the public path
- * @typeParam P - the type of the options object
+ * @typeParam Options - the type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> extends Application<P> {
+declare class FilePicker<
+  Options extends FilePicker.Options = FilePicker.Options,
+  Data extends object = FilePicker.Data
+> extends Application<Options> {
   /**
    * @param options - Options that configure the behavior of the FilePicker
    */
-  constructor(options?: Partial<P>);
+  constructor(options?: Partial<Options>);
 
   /**
    * The full requested path given by the user
@@ -17,13 +21,13 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
   /**
    * The file sources which are available for browsing
    */
-  sources: Partial<FilePicker.Sources>;
+  sources: FilePicker.Sources;
 
   /**
    * Track the active source tab which is being browsed
    * @defaultValue `'data'`
    */
-  activeSource: FilePicker.DataSource;
+  activeSource: FilePicker.SourceType;
 
   /**
    * A callback function to trigger once a file has been selected
@@ -95,6 +99,18 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
 
   /**
    * @override
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   template: "templates/apps/filepicker.html",
+   *   classes: ["filepicker"],
+   *   width: 520,
+   *   tabs: [{navSelector: ".tabs"}],
+   *   dragDrop: [{dragSelector: ".file", dropSelector: ".filepicker-body"}],
+   *   tileSize: false,
+   *   filters: [{inputSelector: 'input[name="filter"]', contentSelector: ".filepicker-body"}]
+   * })
+   * ```
    */
   static get defaultOptions(): FilePicker.Options;
 
@@ -102,13 +118,13 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * Given a current file path, determine the directory it belongs to
    * @param target - The currently requested target path
    * @returns An array of the inferred source and target directory path
+   * @internal
    */
   protected _inferCurrentDirectory(target: string | undefined): [string, string];
 
   /**
    * Get the valid file extensions for a given named file picker type
-   * @param type - The general type of file
-   * @returns A list of file extensions
+   * @internal
    */
   protected _getExtensions(type: FilePicker.Type): string[] | undefined;
 
@@ -151,17 +167,17 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
   static get uploadURL(): string;
 
   /**
-   * @param options - (unused)
    * @override
+   * @param options - (unused)
    */
-  getData(options?: Partial<P>): Promise<FilePicker.Data>;
+  getData(options?: Partial<Options>): 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.BrowsingOptions): Promise<FilePicker.BrowseResult>;
+  browse(target: string, options?: FilePicker.BrowseOptions): Promise<FilePicker.BrowseResult | undefined>;
 
   /**
    * Browse files for a certain directory location
@@ -172,9 +188,9 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * @returns A Promise which resolves to the directories and files contained in the location
    */
   static browse(
-    source: FilePicker.DataSource,
-    target?: string,
-    options?: FilePicker.BrowsingOptions
+    source: FilePicker.SourceType,
+    target: string,
+    options?: FilePicker.BrowseOptions
   ): Promise<FilePicker.BrowseResult>;
 
   /**
@@ -184,7 +200,7 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * @param options - Optional arguments which modify the request (default: `{}`)
    */
   static configurePath(
-    source: FilePicker.DataSource,
+    source: FilePicker.SourceType,
     target: string,
     options?: FilePicker.ConfigurePathOptions
   ): Promise<FilePicker.ConfigurePathResult>;
@@ -196,18 +212,27 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * @param options - Optional arguments which modify the request (default: `{}`)
    */
   static createDirectory(
-    source: FilePicker.DataSource,
+    source: FilePicker.SourceType,
     target: string,
     options?: FilePicker.CreateDirectoryOptions
   ): Promise<string>;
 
   /**
    * General dispatcher method to submit file management commands to the server
+   * @internal
    */
   protected static _manageFiles(
-    data: FilePicker.ManageData,
-    options?: Record<string, unknown>
-  ): Promise<Record<string, unknown>>;
+    data: FilePicker.BrowseFilesData,
+    options?: FilePicker.BrowseOptions
+  ): Promise<FilePicker.BrowseResult>;
+  protected static _manageFiles(
+    data: FilePicker.ConfigurePathData,
+    options?: FilePicker.ConfigurePathOptions
+  ): Promise<FilePicker.ConfigurePathResult>;
+  protected static _manageFiles(
+    data: FilePicker.CreateDirectoryData,
+    options?: FilePicker.CreateDirectoryOptions
+  ): Promise<string>;
 
   /**
    * Dispatch a POST request to the server containing a directory path and a file to upload
@@ -218,16 +243,17 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * @returns The response object
    */
   static upload(
-    source: FilePicker.DataSource,
+    source: FilePicker.SourceType,
     path: string,
     file: File,
     options?: FilePicker.UploadOptions
-  ): Promise<(Response & { path: string; message?: string }) | false | void>;
+  ): Promise<FilePicker.UploadResult | false | void>;
 
   /**
+   * @override
    * Additional actions performed when the file-picker UI is rendered
    */
-  render(force?: boolean, options?: Application.RenderOptions<P>): ReturnType<this['browse']> | void;
+  render(force?: boolean, options?: Application.RenderOptions<Options>): unknown;
 
   /** @override */
   activateListeners(html: JQuery): void;
@@ -235,6 +261,7 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
   /**
    * Handle a click event to change the display mode of the File Picker
    * @param event - The triggering click event
+   * @internal
    */
   protected _onChangeDisplayMode(event: JQuery.ClickEvent): void;
 
@@ -242,20 +269,21 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
    * @param event - (unused)
    * @param event - (unused)
    * @override
+   * @internal
    */
   protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: this['activeSource']): void;
 
   /**
-   * @param selector - (unused)
    * @override
+   * @param selector - (unused)
    */
   protected _canDragStart(selector: string | null): boolean;
 
   /**
-   * @param selector - (unused)
    * @override
+   * @param selector - (unused)
    */
-  protected _canDragDrop(selector: string | null): this['canUpload'];
+  protected _canDragDrop(selector: string | null): boolean;
 
   /**
    * @override
@@ -264,51 +292,51 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
 
   /**
    * @override
+   * @internal
    */
-  protected _onDrop(event: DragEvent): Promise<PromisedType<ReturnType<this['browse']>> | void>;
+  protected _onDrop(event: DragEvent): void;
 
   /**
    * Handle user submission of the address bar to request an explicit target
    * @param event - The originating keydown event
+   * @internal
    */
-  protected _onRequestTarget(event: KeyboardEvent): ReturnType<this['browse']> | void;
+  protected _onRequestTarget(event: KeyboardEvent): void;
 
   /**
    * Handle requests from the IntersectionObserver to lazily load an image file
-   * @param entries  - The entries which are now observed
-   * @param observer - The intersection observer instance
+   * @internal
    */
-  protected _onLazyLoadImages(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void;
+  protected _onLazyLoadImages(...args: Parameters<SidebarTab['_onLazyLoadImage']>): void;
 
   /**
    * Handle file or folder selection within the file picker
    * @param event - The originating click event
+   * @internal
    */
-  protected _onPick(event: JQuery.ClickEvent): ReturnType<this['browse']> | void;
+  protected _onPick(event: JQuery.ClickEvent): void;
 
   /**
    * Handle backwards navigation of the fol6der structure
+   * @internal
    */
-  protected _onClickDirectoryControl(
-    event: JQuery.ClickEvent
-  ):
-    | ReturnType<this['browse']>
-    | Promise<ReturnType<this['browse']> | void | null>
-    | ReturnType<typeof FilePicker['configurePath']>;
+  protected _onClickDirectoryControl(event: JQuery.ClickEvent): void;
 
   /**
-   * Present the user with a dialog to create a subdirectory within their currently browsed file storate location.
+   * Present the user with a dialog to create a subdirectory within their currentl
+   * @internal browsed file storate location.
    */
-  protected _createDirectoryDialog(source: FilePicker.Source): Promise<ReturnType<this['browse']> | void | null>;
+  protected _createDirectoryDialog(source: FilePicker.Source): void;
 
   /**
    * Handle changes to the bucket selector
+   * @internal
    */
-  protected _onChangeBucket(event: JQuery.ChangeEvent): ReturnType<this['browse']>;
+  protected _onChangeBucket(event: JQuery.ChangeEvent): void;
 
   /**
-   * @param event - (unused)
    * @override
+   * @param event - (unused)
    */
   protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
@@ -320,7 +348,7 @@ declare class FilePicker<P extends FilePicker.Options = FilePicker.Options> exte
   /**
    * Handle file upload
    */
-  protected _onUpload(ev: Event): Promise<void>;
+  protected _onUpload(ev: Event): void;
 
   /**
    * Bind the file picker to a new target field.
@@ -340,14 +368,13 @@ declare namespace FilePicker {
     dirs: string[];
     privateDirs: string[];
     files: string[];
-    gridSize?: number;
+    gridSize: number | null;
     extensions: [];
   }
 
-  interface BrowsingOptions {
+  interface BrowseOptions {
     /**
      * A bucket within which to search, if using the S3 source
-     * @defaultValue `""`
      */
     bucket?: string;
 
@@ -364,43 +391,26 @@ declare namespace FilePicker {
     wildcard?: boolean;
   }
 
-  /**
-   * A callback function to trigger once a file has been selected
-   * @param path - The path that was chosen
-   */
   type Callback = (path: string) => void;
 
   interface ConfigurePathOptions {
-    /**
-     * A bucket to use, if using the S3 source
-     * @defaultValue `""`
-     */
-    bucket?: string;
+    bucket?: string | undefined | null;
 
-    /**
-     * Set the privacy mode on this path
-     * @defaultValue true
-     */
-    private?: boolean;
+    private?: boolean | undefined;
 
-    /**
-     * Set the grid size
-     * @defaultValue `undefined`
-     */
-    gridSize?: number;
+    gridSize?: number | undefined;
   }
 
   interface ConfigurePathResult {
-    private: boolean;
+    private?: boolean;
     gridSize?: number;
   }
 
   interface CreateDirectoryOptions {
     /**
-     * A bucket to use, if using the S3 source
      * @defaultValue `""`
      */
-    bucket?: string;
+    bucket?: string | null;
   }
 
   interface Data {
@@ -415,17 +425,16 @@ declare namespace FilePicker {
     files: File[];
     isS3: boolean;
     noResults: boolean;
-    request: string;
     selected: string | undefined;
     source: Source;
     sources: Sources;
     target: string;
     tileSize: number | null;
     user: Game['user'];
-    submitText: 'FILES.SelectFolder' | 'FILES.SelectFile';
+    submitText: string;
   }
 
-  type DataSource = 'data' | 'public' | 's3';
+  type SourceType = 'data' | 'public' | 's3';
 
   interface Dir {
     name: string;
@@ -441,80 +450,68 @@ declare namespace FilePicker {
     img: string;
   }
 
-  interface ManageData {
-    action: 'browseFiles' | 'configurePath' | 'createDirectory' | 'manageFiles';
+  interface ManageFilesDataBase {
     source: string;
     target: string;
   }
 
+  interface BrowseFilesData extends ManageFilesDataBase {
+    action: 'browseFiles';
+  }
+
+  interface ConfigurePathData extends ManageFilesDataBase {
+    action: 'configurePath';
+  }
+
+  interface CreateDirectoryData extends ManageFilesDataBase {
+    action: 'createDirectory';
+  }
+
   /**
    * Options for configuring FilePicker
    */
   interface Options extends Application.Options {
-    /**
-     * The current file path being modified, if any
-     */
-    current?: FilePicker['request'];
-
-    /**
-     * A current file source in "data", "public", or "s3"
-     */
-    activeSource?: DataSource;
-
     /**
      * A type of file to target, in "audio", "image", "video", "imagevideo" or "folder"
      */
-    type?: FilePicker['type'];
+    type?: Type | undefined;
 
     /**
-     * An HTML form field that the result of this selection is applied to
+     * The current file path being modified, if any
      */
-    field?: FilePicker['field'];
+    current?: string | undefined;
 
     /**
-     * An HTML button element which triggers the display of this picker
+     * A current file source in "data", "public", or "s3"
      */
-    button?: FilePicker['button'];
+    activeSource?: SourceType | undefined;
 
     /**
      * A callback function to trigger once a file has been selected
      */
-    callback?: Callback;
+    callback?: Callback | undefined;
 
     /**
-     * @defaultValue `'templates/apps/filepicker.html'`
+     * A flag which permits explicitly disallowing upload, true by default
      */
-    template: Application.Options['template'];
+    allowUpload?: boolean | undefined;
 
     /**
-     * @defaultValue `['filepicker']`
-     */
-    classes: Application.Options['classes'];
-
-    /**
-     * @defaultValue `520`
-     */
-    width: Application.Options['width'];
-
-    /**
-     * @defaultValue `[{navSelector: ".tabs"}]`
+     * An HTML form field that the result of this selection is applied to
      */
-    tabs: Application.Options['tabs'];
+    field?: HTMLElement | undefined;
 
     /**
-     * @defaultValue `[{dragSelector: '.file', dropSelector: '.filepicker-body'}]`
+     * An HTML button element which triggers the display of this picker
      */
-    dragDrop: Application.Options['dragDrop'];
+    button?: HTMLElement | undefined;
 
     /**
-     * @defaultValue `false`
+     * The picker display mode in FilePicker.DISPLAY_MODES
      */
-    tileSize: boolean;
+    displayMode?: DisplayMode | undefined;
 
-    /**
-     * @defaultValue `[{ inputSelector: 'input[name="filter"]', contentSelector: ".filepicker-body" }]`
-     */
-    filters: Application.Options['filters'];
+    tileSize?: boolean | undefined;
   }
 
   interface Source {
@@ -526,7 +523,7 @@ declare namespace FilePicker {
   interface Sources {
     data: Source;
     public: Source;
-    s3: Source & {
+    s3?: Source & {
       buckets: string[];
       bucket: string;
     };
@@ -534,14 +531,17 @@ declare namespace FilePicker {
 
   type Type = 'audio' | 'image' | 'video' | 'imagevideo' | 'folder';
 
-  /**
-   * Optional arguments for the `upload` method
-   */
   interface UploadOptions {
     /**
      * A bucket to upload to, if using the S3 source
      * @defaultValue `""`
      */
-    bucket?: string;
+    bucket?: string | null;
+  }
+
+  interface UploadResult {
+    message: string;
+    path: string;
+    status: 'success';
   }
 }

package/src/foundry/foundry.js/applications/formApplication.d.ts

@@ -128,14 +128,14 @@ declare abstract class FormApplication<
    * @returns The prepared update data
    */
   // TODO: Maybe we can calculate how the flattened `updateData` looks like, then it would be Partial<Record<string, unknown>> & Flattened<T>
-  protected _getSubmitData(updateData?: object | null): Partial<Record<string, unknown>>;
+  protected _getSubmitData(updateData?: object | null): Record<string, unknown>;
 
   /**
    * Handle changes to an input element, submitting the form if options.submitOnChange is true.
    * Do not preventDefault in this handler as other interactions on the form may also be occurring.
    * @param event - The initial change event
    */
-  protected _onChangeInput(event: JQuery.ChangeEvent): void | Promise<Partial<Record<string, unknown>>>;
+  protected _onChangeInput(event: JQuery.ChangeEvent): void | Promise<unknown>;
 
   /**
    * Handle the change of a color picker input which enters it's chosen value into a related input field
@@ -200,7 +200,7 @@ declare abstract class FormApplication<
    * @param event - The initiating mouse click event which opens the picker
    * @returns Options passed to the FilePicker constructor
    */
-  protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
+  protected _getFilePickerOptions(event: PointerEvent): FilePicker.Options;
 
   /**
    * @param options - (default: `{}`)
@@ -303,11 +303,3 @@ declare namespace FormApplication {
     classes: string[];
   }
 }
-
-interface FilePickerOptions {
-  field: HTMLElement | null;
-  type: string;
-  current: string;
-  button: HTMLElement;
-  callback: FormApplication['_onSelectFile'];
-}

package/src/foundry/foundry.js/applications/formApplications/combatTrackerConfig.d.ts

@@ -1,46 +1,39 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
- * Configure the Combat tracker to display additional information as appropriate
+ * The Application responsible for configuring the CombatTracker and its contents.
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class CombatTrackerConfig extends FormApplication<FormApplication.Options, CombatTrackerConfig.Data> {
+declare class CombatTrackerConfig<
+  Options extends FormApplication.Options = FormApplication.Options,
+  Data extends object = CombatTrackerConfig.Data
+> extends FormApplication<Options, Data, undefined> {
   /**
    * @defaultValue
    * ```typescript
-   * mergeObject(super.defaultOptions, {
+   * foundry.utils.mergeObject(super.defaultOptions, {
    *   id: "combat-config",
    *   title: game.i18n.localize("COMBAT.Settings"),
    *   classes: ["sheet", "combat-sheet"],
    *   template: "templates/sheets/combat-config.html",
-   *   width: 420
-   * });
+   *   width: 420,
+   * })
    * ```
    */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<FormApplication.Options>): Promise<CombatTrackerConfig.Data>;
+  static get defaultOptions(): FormApplication.Options;
 
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _updateObject(event?: Event, formData?: Combat.ConfigValue): Promise<Combat.ConfigValue>;
+  /** @override */
+  getData(options?: Partial<Options>): Data | Promise<Data>;
 
-  /**
-   * Get an Array of attribute choices which could be tracked for Actors in the Combat Tracker
-   */
-  getAttributeChoices(): ReturnType<typeof TokenConfig['getTrackedAttributeChoices']>;
+  /** @override */
+  protected _updateObject(
+    event: Event,
+    formData: ClientSettings.Values['core.combatTrackerConfig']
+  ): Promise<ClientSettings.Values['core.combatTrackerConfig']>;
 }
 
 declare namespace CombatTrackerConfig {
   interface Data {
-    settings: Combat.ConfigValue;
-    attributeChoices: ReturnType<CombatTrackerConfig['getAttributeChoices']>;
+    settings: ClientSettings.Values['core.combatTrackerConfig'];
+    attributeChoices: Record<string, string[]>;
   }
 }

package/src/foundry/foundry.js/applications/formApplications/defaultTokenConfig.d.ts

@@ -0,0 +1,66 @@
+declare global {
+  /**
+   * A sheet that alters the values of the default Token configuration used when new Token documents are created.
+   */
+  class DefaultTokenConfig<
+    Options extends FormApplication.Options = FormApplication.Options,
+    Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
+  > extends FormApplication<Options, Data, foundry.data.TokenData['_source']> {
+    constructor(object: unknown, options: Options);
+
+    data: foundry.data.TokenData;
+
+    /**
+     * The named world setting that stores the default Token configuration
+     */
+    static SETTING: string;
+
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "default-token-config",
+     *   classes: ["sheet"],
+     *   template: "templates/scene/default-token-config.html",
+     *   title: "Default Token Configuration",
+     *   width: 480,
+     *   height: "auto"
+     * })
+     * ```
+     */
+    static get defaultOptions(): typeof FormApplication['defaultOptions'];
+
+    /** @override */
+    getData(options: unknown): Data | Promise<Data>;
+
+    /** @override */
+    _getSubmitData(
+      updateData?: Parameters<FormApplication['_getSubmitData']>[0]
+    ): ReturnType<FormApplication['_getSubmitData']>;
+
+    /** @override */
+    _updateObject(event: Event, formData?: object): Promise<unknown>;
+
+    /** @override */
+    activateListeners(html: JQuery): void;
+
+    /**
+     * Reset the form to default values
+     */
+    reset(): void;
+  }
+
+  namespace DefaultTokenConfig {
+    interface Data {
+      object: DefaultTokenConfig['object'];
+      barAttributes: ReturnType<typeof TokenDocument['getTrackedAttributeChoices']>;
+      dispositions: Record<ValueOf<typeof CONST.TOKEN_DISPOSITIONS>, string>;
+      lightAnimations: Record<string, string>;
+      displayModes: Record<ValueOf<typeof CONST.TOKEN_DISPLAY_MODES>, string>;
+      lightAlpha: number;
+    }
+  }
+}
+
+export {};

package/src/foundry/foundry.js/applications/formApplications/documentSheet.d.ts

@@ -75,7 +75,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(event: Event, formData: object): Promise<ConcreteDocument | undefined>;
+    protected _updateObject(event: Event, formData: object): Promise<unknown>;
 
     /**
      * @deprecated since 0.8.0