@league-of-foundry-developers/foundry-vtt-types 9.242.0 → 9.245.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.242.0",
+  "version": "9.245.0",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {

package/src/foundry/common/utils/primitives.mjs.d.ts

@@ -198,6 +198,13 @@ interface NumberConstructor {
    * @returns Is it a number?
    */
   isNumeric(n: unknown): n is number;
+
+  /**
+   * Attempt to create a number from a user-provided string.
+   * @param str - The string.
+   * @returns The number that the string represents, or NaN if no number could be determined.
+   */
+  fromString(str: string): number;
 }
 
 interface ArrayConstructor {

package/src/foundry/foundry.js/application.d.ts

@@ -11,11 +11,115 @@ declare let _maxZ: number;
 declare const MIN_WINDOW_WIDTH: 200;
 declare const MIN_WINDOW_HEIGHT: 50;
 
+interface ApplicationOptions {
+  /**
+   * A named "base application" which generates an additional hook
+   * @defaultValue `null`
+   */
+  baseApplication: string | null;
+
+  /**
+   * The default pixel width for the rendered HTML
+   * @defaultValue `null`
+   */
+  width: number | null;
+
+  /**
+   * The default pixel height for the rendered HTML
+   * @defaultValue `null`
+   */
+  height: number | 'auto' | null;
+
+  /**
+   * The default offset-top position for the rendered HTML
+   * @defaultValue `null`
+   */
+  top: number | null;
+
+  /**
+   * The default offset-left position for the rendered HTML
+   * @defaultValue `null`
+   */
+  left: number | null;
+
+  /**
+   * A transformation scale for the rendered HTML
+   * @defaultValue `null`
+   */
+  scale: number | null;
+
+  /**
+   * Whether to display the application as a pop-out container
+   * @defaultValue `true`
+   */
+  popOut: boolean;
+
+  /**
+   * Whether the rendered application can be minimized (popOut only)
+   * @defaultValue `true`
+   */
+  minimizable: boolean;
+
+  /**
+   * Whether the rendered application can be drag-resized (popOut only)
+   * @defaultValue `false`
+   */
+  resizable: boolean;
+
+  /**
+   * The default CSS id to assign to the rendered HTML
+   * @defaultValue `""`
+   */
+  id: string;
+
+  /**
+   * An array of CSS string classes to apply to the rendered HTML
+   * @defaultValue `[]`
+   */
+  classes: string[];
+
+  /**
+   * A default window title string (popOut only)
+   * @defaultValue `""`
+   */
+  title: string;
+
+  /**
+   * The default HTML template path to render for this Application
+   * @defaultValue `null`
+   */
+  template: string | null;
+
+  /**
+   * A list of unique CSS selectors which target containers that should
+   * have their vertical scroll positions preserved during a re-render.
+   * @defaultValue `[]`
+   */
+  scrollY: string[];
+
+  /**
+   * An array of tabbed container configurations which should be enabled
+   * for the application.
+   * @defaultValue `[]`
+   */
+  tabs: Omit<TabsConfiguration, 'callback'>[];
+
+  /**
+   * @defaultValue `[]`
+   */
+  dragDrop: Omit<DragDropConfiguration, 'permissions' | 'callbacks'>[];
+
+  /**
+   * @defaultValue `[]`
+   */
+  filters: Omit<SearchFilterConfiguration, 'callback'>[];
+}
+
 /**
  * The standard application window that is rendered for a large variety of UI elements in Foundry VTT.
  * @typeParam Options - the type of the options object
  */
-declare abstract class Application<Options extends Application.Options = Application.Options> {
+declare abstract class Application<Options extends ApplicationOptions = ApplicationOptions> {
   /**
    * @param options - Configuration options which control how the application is rendered.
    *                  Application subclasses may add additional supported options, but the
@@ -87,7 +191,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * Track the most recent scroll positions for any vertically scrolling containers
    * @defaultValue `null`
    */
-  protected _scrollPositions: Partial<Record<string, number>> | null;
+  protected _scrollPositions: Record<string, number> | null;
 
   /**
    * The sequence of rendering states that track the Application life-cycle.
@@ -105,18 +209,21 @@ declare abstract class Application<Options extends Application.Options = Applica
   /**
    * Create drag-and-drop workflow handlers for this Application
    * @returns An array of DragDrop handlers
+   * @internal
    */
   protected _createDragDropHandlers(): DragDrop[];
 
   /**
    * Create tabbed navigation handlers for this Application
    * @returns An array of Tabs handlers
+   * @internal
    */
   protected _createTabHandlers(): Tabs[];
 
   /**
    * Create search filter handlers for this Application
    * @returns An array of SearchFilter handlers
+   * @internal
    */
   protected _createSearchFilters(): SearchFilter[];
 
@@ -125,7 +232,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * in this object are merged with any provided option values which are passed to the constructor upon initialization.
    * Application subclasses may include additional options which are specific to their usage.
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * Return the CSS application ID which uniquely references this UI element
@@ -193,45 +300,52 @@ declare abstract class Application<Options extends Application.Options = Applica
 
   /**
    * Return the inheritance chain for this Application class up to (and including) it's base Application class.
+   * @internal
    */
   protected static _getInheritanceChain(): typeof Application[];
 
   /**
    * Persist the scroll positions of containers within the app before re-rendering the content
    * @param html - The HTML object being traversed
+   * @internal
    */
   protected _saveScrollPositions(html: JQuery): void;
 
   /**
    * Restore the scroll positions of containers within the app after re-rendering the content
    * @param html - The HTML object being traversed
+   * @internal
    */
   protected _restoreScrollPositions(html: JQuery): void;
 
   /**
    * Render the outer application wrapper
    * @returns A promise resolving to the constructed jQuery object
+   * @internal
    */
-  protected _renderOuter(): Promise<HTMLElement> | Promise<JQuery<JQuery.Node>>;
+  protected _renderOuter(): Promise<JQuery>;
 
   /**
    * Render the inner application content
    * @param data - The data used to render the inner template
    * @returns A promise resolving to the constructed jQuery object
    * @remarks Some subclasses do not return a promise but the jQuery object directly.
+   * @internal
    */
-  protected _renderInner(data: object): Promise<JQuery> | JQuery;
+  protected _renderInner(data: object): Promise<JQuery>;
 
   /**
    * Customize how inner HTML is replaced when the application is refreshed
    * @param element - The original HTML processed as a jQuery object
    * @param html    - New updated HTML as a jQuery object
+   * @internal
    */
   protected _replaceHTML(element: JQuery, html: JQuery): void;
 
   /**
    * Customize how a new HTML Application is added and first appears in the DOC
    * @param html - The HTML element which is ready to be added to the DOM
+   * @internal
    */
   protected _injectHTML(html: JQuery): void;
 
@@ -239,9 +353,17 @@ declare abstract class Application<Options extends Application.Options = Applica
    * Specify the set of config buttons which should appear in the Application header.
    * Buttons should be returned as an Array of objects.
    * The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.
+   * @internal
    */
   protected _getHeaderButtons(): Application.HeaderButton[];
 
+  /**
+   * Create a {@link ContextMenu} for this Application.
+   * @param html - The Application's HTML.
+   * @internal
+   */
+  protected _contextMenu(html: JQuery): void;
+
   /**
    * Activate required listeners which must be enabled on every Application.
    * These are internal interactions which should not be overridden by downstream subclasses.
@@ -262,6 +384,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    *                 (unused)
    * @param active - The new active tab name
    *                 (unused)
+   * @internal
    */
   protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
 
@@ -275,6 +398,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    *                (unused)
    * @param html  - The HTML element which should be filtered
    *                (unused)
+   * @internal
    */
   protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
@@ -283,6 +407,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * @param selector - The candidate HTML selector for dragging
    *                   (unused)
    * @returns Can the current user drag this selector?
+   * @internal
    */
   protected _canDragStart(selector: string): boolean;
 
@@ -291,6 +416,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * @param selector - The candidate HTML selector for the drop target
    *                   (unused)
    * @returns Can the current user drop on this selector?
+   * @internal
    */
   protected _canDragDrop(selector: string): boolean;
 
@@ -298,6 +424,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * Callback actions which occur at the beginning of a drag start workflow.
    * @param event - The originating DragEvent
    *                (unused)
+   * @internal
    */
   protected _onDragStart(event: DragEvent): void;
 
@@ -305,6 +432,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * Callback actions which occur when a dragged element is over a drop target.
    * @param event - originating DragEvent
    *                (unused)
+   * @internal
    */
   protected _onDragOver(event: DragEvent): void;
 
@@ -313,6 +441,7 @@ declare abstract class Application<Options extends Application.Options = Applica
    * @param event - The originating DragEvent
    *                (unused)
    * @internal
+   * @internal
    */
   protected _onDrop(event: DragEvent): void;
 
@@ -384,118 +513,17 @@ declare namespace Application {
     onclick: ((ev: JQuery.ClickEvent) => void) | null;
   }
 
-  interface Options {
-    /**
-     * A named "base application" which generates an additional hook
-     * @defaultValue `null`
-     */
-    baseApplication: string | null;
-
-    /**
-     * The default pixel width for the rendered HTML
-     * @defaultValue `null`
-     */
-    width: number | null;
-
-    /**
-     * The default pixel height for the rendered HTML
-     * @defaultValue `null`
-     */
-    height: number | 'auto' | null;
-
-    /**
-     * The default offset-top position for the rendered HTML
-     * @defaultValue `null`
-     */
-    top: number | null;
-
-    /**
-     * The default offset-left position for the rendered HTML
-     * @defaultValue `null`
-     */
-    left: number | null;
-
-    /**
-     * A transformation scale for the rendered HTML
-     */
-    scale?: number | null | undefined;
-
-    /**
-     * Whether to display the application as a pop-out container
-     * @defaultValue `true`
-     */
-    popOut: boolean;
-
-    /**
-     * Whether the rendered application can be minimized (popOut only)
-     * @defaultValue `true`
-     */
-    minimizable: boolean;
-
-    /**
-     * Whether the rendered application can be drag-resized (popOut only)
-     * @defaultValue `false`
-     */
-    resizable: boolean;
-
-    /**
-     * The default CSS id to assign to the rendered HTML
-     * @defaultValue `""`
-     */
-    id: string;
-
-    /**
-     * An array of CSS string classes to apply to the rendered HTML
-     * @defaultValue `[]`
-     */
-    classes: string[];
-
-    /**
-     * A default window title string (popOut only)
-     * @defaultValue `""`
-     */
-    title: string;
-
-    /**
-     * The default HTML template path to render for this Application
-     * @defaultValue `null`
-     */
-    template: string | null;
-
-    /**
-     * A list of unique CSS selectors which target containers that should
-     * have their vertical scroll positions preserved during a re-render.
-     * @defaultValue `[]`
-     */
-    scrollY: string[];
-
-    /**
-     * An array of tabbed container configurations which should be enabled
-     * for the application.
-     * @defaultValue `[]`
-     */
-    tabs: Omit<TabsConfiguration, 'callback'>[];
-
-    /**
-     * @defaultValue `[]`
-     */
-    dragDrop: Omit<DragDrop.Options, 'permissions' | 'callbacks'>[];
-
-    /**
-     * @defaultValue `[]`
-     */
-    filters: Omit<SearchFilter.Options, 'callback'>[];
-  }
-
   interface Position {
     width: number | null;
     height: number | null | 'auto';
     left: number | null;
     top: number | null;
-    scale: number | null | undefined;
+    scale: number | null;
+    /** @defaultValue `0` */
+    zIndex: number;
   }
 
-  type RenderOptions<Options extends Application.Options = Application.Options> = Partial<Options> & {
+  type RenderOptions<Options extends ApplicationOptions = ApplicationOptions> = Partial<Options> & {
     /**
      * The left positioning attribute
      */

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

@@ -5,7 +5,7 @@
  */
 declare abstract class BasePlaceableHUD<
   Object extends PlaceableObject<any> = PlaceableObject,
-  Options extends Application.Options = Application.Options
+  Options extends ApplicationOptions = ApplicationOptions
 > extends Application<Options> {
   /**
    * Reference a PlaceableObject this HUD is currently bound to
@@ -23,7 +23,7 @@ declare abstract class BasePlaceableHUD<
    * })
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * Convenience access for the canvas layer which this HUD modifies

package/src/foundry/foundry.js/applications/basePlaceableHUDs/drawingHUD.d.ts

@@ -5,7 +5,7 @@ declare global {
    * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Drawing objects.
    * @typeParam Options - the type of the options object
    */
-  class DrawingHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+  class DrawingHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
     ConcreteDrawing,
     Options
   > {
@@ -19,7 +19,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteDrawing>['getData']> & {

package/src/foundry/foundry.js/applications/basePlaceableHUDs/tileHUD.d.ts

@@ -5,7 +5,7 @@ declare global {
    * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects.
    * @typeParam Options - the type of the options object
    */
-  class TileHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+  class TileHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
     ConcreteTile,
     Options
   > {
@@ -19,7 +19,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteTile>['getData']> & {

package/src/foundry/foundry.js/applications/basePlaceableHUDs/tokenHUD.d.ts

@@ -6,7 +6,7 @@ declare global {
    * This interface provides controls for visibility, attribute bars, elevation, status effects, and more.
    * @typeParam Options - the type of the options object
    */
-  class TokenHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+  class TokenHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
     ConcreteToken,
     Options
   > {
@@ -27,7 +27,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     bind(object: ConcreteToken): void;
@@ -44,7 +44,7 @@ declare global {
     setPosition(_position?: Partial<Application.Position>): void;
 
     /** @override */
-    getData(options?: Partial<Application.Options>): ReturnType<BasePlaceableHUD<ConcreteToken>['getData']> & {
+    getData(options?: Partial<ApplicationOptions>): ReturnType<BasePlaceableHUD<ConcreteToken>['getData']> & {
       canConfigure: boolean;
       canToggleCombat: boolean;
       displayBar1: boolean;

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

@@ -4,7 +4,7 @@
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class CameraViews<
-  Options extends Application.Options = Application.Options,
+  Options extends ApplicationOptions = ApplicationOptions,
   Data extends object = CameraViews.Data
 > extends Application<Options> {
   /**
@@ -18,7 +18,7 @@ declare class CameraViews<
    * })
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /**
    * A reference to the master AV orchestrator instance

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

@@ -5,7 +5,7 @@ declare global {
    * A simple application which supports popping a ChatMessage out to a separate UI window.
    * @typeParam Options - the type of the options object
    */
-  class ChatPopout<Options extends Application.Options = Application.Options> extends Application<Options> {
+  class ChatPopout<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
     constructor(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, options?: Partial<Options>);
 
     /**
@@ -24,7 +24,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): Application.Options;
+    static get defaultOptions(): ApplicationOptions;
 
     /** @override */
     get id(): string;
@@ -37,6 +37,6 @@ declare global {
      * @param options - (unused)
      * @override
      */
-    protected _renderInner(data: object, options?: unknown): Promise<JQuery> | JQuery;
+    protected _renderInner(data: object, options?: unknown): Promise<JQuery>;
   }
 }

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

@@ -5,7 +5,7 @@
  */
 declare class Compendium<
   Metadata extends CompendiumCollection.Metadata,
-  Options extends Application.Options = Application.Options
+  Options extends ApplicationOptions = ApplicationOptions
 > extends Application<Options> {
   constructor(collection: CompendiumCollection<Metadata>, options?: Partial<Options>);
 
@@ -27,7 +27,7 @@ declare class Compendium<
    * });
    * ```
    */
-  static get defaultOptions(): Application.Options;
+  static get defaultOptions(): ApplicationOptions;
 
   /** @override */
   get title(): string;

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

@@ -193,7 +193,7 @@ declare namespace Dialog {
     default: string;
   }
 
-  interface Options extends Application.Options {
+  interface Options extends ApplicationOptions {
     /**
      * @defaultValue `400`
      */

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

@@ -470,7 +470,7 @@ declare namespace FilePicker {
   /**
    * Options for configuring FilePicker
    */
-  interface Options extends Application.Options {
+  interface Options extends ApplicationOptions {
     /**
      * A type of file to target, in "audio", "image", "video", "imagevideo" or "folder"
      */

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

@@ -1,3 +1,40 @@
+interface FormApplicationOptions extends ApplicationOptions {
+  /**
+   * Whether to automatically close the application when it's contained
+   * form is submitted.
+   * @defaultValue `true`
+   */
+  closeOnSubmit: boolean;
+
+  /**
+   * Whether to automatically submit the contained HTML form when an input
+   * or select element is changed.
+   * @defaultValue `false`
+   */
+  submitOnChange: boolean;
+
+  /**
+   * Whether to automatically submit the contained HTML form when the
+   * application window is manually closed.
+   * @defaultValue `false`
+   */
+  submitOnClose: boolean;
+
+  /**
+   * Whether the application form is editable - if true, it's fields will
+   * be unlocked and the form can be submitted. If false, all form fields
+   * will be disabled and the form cannot be submitted.
+   * @defaultValue `true`
+   */
+  editable: boolean;
+
+  /**
+   * Support configuration of the sheet type used for this application.
+   * @defaultValue `false`
+   */
+  sheetConfig: boolean;
+}
+
 /**
  * An abstract pattern for defining an Application responsible for updating some object using an HTML form
  *
@@ -11,7 +48,7 @@
  * @typeParam ConcreteObject - the type of the object or {@link foundry.abstract.Document} which is modified by this form
  */
 declare abstract class FormApplication<
-  Options extends FormApplication.Options = FormApplication.Options,
+  Options extends FormApplicationOptions = FormApplicationOptions,
   Data extends object = FormApplication.Data<{}, Options>,
   ConcreteObject = Data extends FormApplication.Data<infer T, Options> ? T : {}
 > extends Application<Options> {
@@ -46,7 +83,7 @@ declare abstract class FormApplication<
    * The values of this Array are inner-objects with references to the MCE editor and other metadata
    * @defaultValue `{}`
    */
-  editors: Partial<Record<string, FormApplication.FormApplicationEditor>>;
+  editors: Record<string, FormApplication.FormApplicationEditor>;
 
   /**
    * Assign the default options which are supported by the entity edit sheet.
@@ -56,15 +93,16 @@ declare abstract class FormApplication<
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
-   *   classes: ['form'],
+   *   classes: ["form"],
    *   closeOnSubmit: true,
+   *   editable: true,
+   *   sheetConfig: false,
    *   submitOnChange: false,
-   *   submitOnClose: false,
-   *   editable: true
+   *   submitOnClose: false
    * });
    * ```
    */
-  static get defaultOptions(): FormApplication.Options;
+  static get defaultOptions(): FormApplicationOptions;
 
   /**
    * Is the Form Application currently editable?
@@ -257,7 +295,7 @@ declare namespace FormApplication {
    * @typeParam ConcreteObject - the type of the object
    * @typeParam Options        - the type of the options object
    */
-  interface Data<ConcreteObject, Options extends FormApplication.Options = FormApplication.Options> {
+  interface Data<ConcreteObject, Options extends FormApplicationOptions = FormApplicationOptions> {
     object: ConcreteObject;
     options: Options;
     title: string;
@@ -295,11 +333,4 @@ declare namespace FormApplication {
      */
     preventRender?: boolean;
   }
-
-  interface Options extends Application.Options, ApplicationOptions {
-    /**
-     * @defaultValue `['form']`
-     */
-    classes: string[];
-  }
 }