@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/ui/tabs.d.mts

@@ -1,36 +1,14 @@
 export {};
 
 declare global {
-  interface TabsConfiguration {
-    /**
-     * The name of the tabs group
-     */
-    group?: string;
-
-    /**
-     * The CSS selector used to target the navigation element for these tabs
-     */
-    navSelector: string;
-
-    /**
-     * The CSS selector used to target the content container for these tabs
-     */
-    contentSelector?: string;
-
-    /**
-     * The tab name of the initially active tab
-     */
-    initial?: string;
-
-    /**
-     * An optional callback function that executes when the active tab is changed
-     */
-    callback?: ((event: MouseEvent | null, tabs: Tabs, tabName: string) => unknown) | null;
-  }
+  /**
+   * @deprecated {@link Tabs.Configuration | `Tabs.Configuration`}
+   */
+  type TabsConfiguration = Tabs.Configuration;
 
   /**
    * A controller class for managing tabbed navigation within an Application instance.
-   * @see {@link Application}
+   * @see {@link Application | `Application`}
    *
    * @example Configure tab-control for a set of HTML elements
    * ```html
@@ -56,27 +34,27 @@ declare global {
     /**
      * @param config - The Tabs Configuration to use for this tabbed container
      */
-    constructor(config: TabsConfiguration);
+    constructor(config: Tabs.Configuration);
 
     /**
      * The name of the tabs group
      */
-    group: TabsConfiguration["group"];
+    group: Tabs.Configuration["group"];
 
     /**
      * The value of the active tab
      */
-    active: TabsConfiguration["initial"];
+    active: Tabs.Configuration["initial"];
 
     /**
      * A callback function to trigger when the tab is changed
      */
-    callback: TabsConfiguration["callback"];
+    callback: Tabs.Configuration["callback"];
 
     /**
      * The CSS selector used to target the tab navigation element
      */
-    protected _navSelector: TabsConfiguration["navSelector"];
+    protected _navSelector: Tabs.Configuration["navSelector"];
 
     /**
      * A reference to the HTML navigation element the tab controller is bound to
@@ -87,7 +65,7 @@ declare global {
     /**
      * The CSS selector used to target the tab content element
      */
-    protected _contentSelector: TabsConfiguration["contentSelector"];
+    protected _contentSelector: Tabs.Configuration["contentSelector"];
 
     /**
      * A reference to the HTML container element of the tab content
@@ -113,5 +91,34 @@ declare global {
     protected _onClickNav(event: MouseEvent): void;
   }
 
+  namespace Tabs {
+    interface Configuration {
+      /**
+       * The name of the tabs group
+       */
+      group?: string;
+
+      /**
+       * The CSS selector used to target the navigation element for these tabs
+       */
+      navSelector: string;
+
+      /**
+       * The CSS selector used to target the content container for these tabs
+       */
+      contentSelector?: string;
+
+      /**
+       * The tab name of the initially active tab
+       */
+      initial?: string;
+
+      /**
+       * An optional callback function that executes when the active tab is changed
+       */
+      callback?: ((event: MouseEvent | null, tabs: Tabs, tabName: string) => unknown) | null;
+    }
+  }
+
   const TabsV2: typeof Tabs;
 }

package/src/foundry/client-esm/_module.d.mts

@@ -9,7 +9,7 @@
 
 // import * as globalUI from "./ui.mjs";
 
-export * as CONST from "@common/constants.mjs";
+export * as CONST from "#common/constants.mjs";
 
 // // declare global {
 // //   const logger: typeof console;
@@ -33,7 +33,7 @@ export * as packages from "./packages/_module.mjs";
 /**
  * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
  */
-export * as abstract from "@common/abstract/_module.mjs";
+export * as abstract from "#common/abstract/_module.mjs";
 
 /**
  * Utility functions providing helpful functionality.
@@ -43,17 +43,17 @@ export * as utils from "./utils/_module.mjs";
 /**
  * Application configuration options
  */
-export * as config from "@common/config.mjs";
+export * as config from "#common/config.mjs";
 
 /**
  * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
  */
-export * as prosemirror from "@common/prosemirror/_module.mjs";
+export * as prosemirror from "#common/prosemirror/_module.mjs";
 
 /**
  * Grid classes.
  */
-export * as grid from "@common/grid/_module.mjs";
+export * as grid from "#common/grid/_module.mjs";
 
 // /* -------------------------------------------- */
 // /*  Client                                      */

package/src/foundry/client-esm/_types.d.mts

@@ -5,4 +5,5 @@
 // them here because it has poor discoverability. The names Foundry has chosen
 // also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig
 
-export * from "@common/_types.mjs";
+// eslint-disable-next-line import-x/export, import-x/extensions
+export * from "#common/_types.mjs";

package/src/foundry/client-esm/applications/api/application.d.mts

@@ -6,8 +6,10 @@ import type {
   MaybePromise,
   ValueOf,
   AnyArray,
-} from "../../../../utils/index.d.mts";
-import type EventEmitterMixin from "@common/utils/event-emitter.d.mts";
+  Identity,
+} from "fvtt-types/utils";
+import type EventEmitterMixin from "#common/utils/event-emitter.d.mts";
+import type ContextMenu from "../ux/context-menu.d.mts";
 
 // TODO: Investigate use of DeepPartial vs Partial vs InexactPartial
 
@@ -21,12 +23,12 @@ type _ClassMustBeAssignableToInternal = MustConform<typeof ApplicationV2, Applic
 type _InstanceMustBeAssignableToInternal = MustConform<ApplicationV2, ApplicationV2.Internal.Instance.Any>;
 
 declare namespace ApplicationV2 {
-  type Any = ApplicationV2<any, any, any>;
-  type AnyConstructor = typeof AnyApplicationV2;
+  interface Any extends AnyApplicationV2 {}
+  interface AnyConstructor extends Identity<typeof AnyApplicationV2> {}
 
   // Documented at https://gist.github.com/LukeAbby/c7420b053d881db4a4d4496b95995c98
   namespace Internal {
-    type Constructor = (abstract new (arg0: never, ...args: never[]) => Instance.Any) & {
+    type Constructor = (abstract new (...args: never) => Instance.Any) & {
       [__ApplicationV2Brand]: never;
     };
 
@@ -52,7 +54,7 @@ declare namespace ApplicationV2 {
     }
 
     namespace Instance {
-      type Any = Instance<any, any, any>;
+      interface Any extends Instance<any, any, any> {}
     }
   }
 
@@ -83,18 +85,27 @@ declare namespace ApplicationV2 {
     /** Arguments passed to the requested hook function */
     hookArgs: string;
 
-    /** Add the handler response to hookArgs */
+    /**
+     * Add the handler response to hookArgs
+     * @defaultValue `false`
+     */
     hookResponse: boolean;
+
+    /**
+     * Call hooks for parent classes in the inheritance chain?
+     * @defaultValue `true`
+     */
+    parentClassHooks: boolean;
   }
 
   type RenderState = ValueOf<typeof ApplicationV2.RENDER_STATES>;
 
-  export interface RenderContext {
+  interface RenderContext {
     /** Tab data prepared from an entry in {@link ApplicationV2.TABS} */
     tabs?: Record<string, Tab>;
   }
 
-  export interface Configuration {
+  interface Configuration {
     /**
      * An HTML element identifier used for this Application instance
      */
@@ -288,6 +299,8 @@ declare namespace ApplicationV2 {
     submitted: boolean;
   }
 
+  type ActionTarget = HTMLElement & { dataset: { action: string } };
+
   /** An on-click action supported by the Application. Run in the context of a HandlebarsApplication. */
   type ClickAction = (
     /** The originating click event */
@@ -322,6 +335,20 @@ declare namespace ApplicationV2 {
     labelPrefix?: string | null | undefined;
   }
 
+  interface Window {
+    header?: HTMLElement | undefined;
+    resize?: HTMLElement | undefined;
+    title: HTMLHeadingElement | undefined;
+    icon: HTMLElement | undefined;
+    close: HTMLButtonElement | undefined;
+    controls: HTMLButtonElement | undefined;
+    controlsDropdown: HTMLDivElement | undefined;
+    onDrag: (event: PointerEvent) => void;
+    onResize: (event: PointerEvent) => void;
+    pointerStartPosition: ApplicationV2.Position | undefined;
+    pointerMoveThrottle: boolean;
+  }
+
   /** @remarks Used with `templates/generic/tab-navigation.hbs` */
   interface Tab {
     id: string;
@@ -397,6 +424,20 @@ declare namespace ApplicationV2 {
        */
       updatePosition: boolean;
     }> {}
+
+  type CreateContextMenuHandler = () => ContextMenu.Entry<HTMLElement>[];
+
+  interface CreateContextMenuOptions extends ContextMenu.ConstructorOptions<false> {
+    container?: HTMLElement | undefined | null;
+
+    hookName?: string | undefined | null;
+
+    /**
+     * @defaultValue `true`
+     */
+    // non-null due to default value
+    parentClassHooks?: boolean | undefined;
+  }
 }
 
 /**
@@ -409,12 +450,12 @@ declare class ApplicationV2<
   RenderContext extends object = ApplicationV2.RenderContext,
   Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends EventEmitterMixin(Object) {
+> extends EventEmitterMixin() {
   static [__ApplicationV2Brand]: never;
 
+  [__RenderContext]: RenderContext;
   [__Configuration]: Configuration;
   [__RenderOptions]: RenderOptions;
-  [__RenderContext]: RenderContext;
 
   /**
    * Applications are constructed by providing an object of configuration options.
@@ -456,6 +497,16 @@ declare class ApplicationV2<
     RENDERED: 2;
   };
 
+  /**
+   * An incrementing integer Application ID.
+   */
+  static _appId: number;
+
+  /**
+   * The current maximum z-index of any displayed Application.
+   */
+  static _maxZ: number;
+
   static override readonly emittedEvents: string[];
 
   /**
@@ -466,19 +517,7 @@ declare class ApplicationV2<
   /**
    * Convenience references to window header elements.
    */
-  get window(): {
-    header?: HTMLElement | undefined;
-    resize?: HTMLElement | undefined;
-    title: HTMLHeadingElement | undefined;
-    icon: HTMLElement | undefined;
-    close: HTMLButtonElement | undefined;
-    controls: HTMLButtonElement | undefined;
-    controlsDropdown: HTMLDivElement | undefined;
-    onDrag: (event: PointerEvent) => void;
-    onResize: (event: PointerEvent) => void;
-    pointerStartPosition: ApplicationV2.Position | undefined;
-    pointerMoveThrottle: boolean;
-  };
+  get window(): ApplicationV2.Window;
 
   /**
    * If this Application uses tabbed navigation groups, this mapping is updated whenever the changeTab method is called.
@@ -654,8 +693,7 @@ declare class ApplicationV2<
    * @param element - The element to insert
    * @returns The inserted element
    */
-  // TODO: Actual function def appears to be void?
-  protected _insertElement(element: HTMLElement): HTMLElement;
+  protected _insertElement(element: HTMLElement): void;
 
   /**
    * Close the Application, removing it from the DOM.
@@ -701,7 +739,7 @@ declare class ApplicationV2<
    * @returns A Promise which resolves once the control expansion animation is complete
    */
   // not: null
-  toggleControls(expanded?: boolean | null, options?: ApplicationV2.ToggleControlOptions): void;
+  toggleControls(expanded?: boolean | null, options?: ApplicationV2.ToggleControlOptions): Promise<void>;
 
   /**
    * Minimize the Application, collapsing it to a minimal header.
@@ -730,6 +768,17 @@ declare class ApplicationV2<
   // not: null
   changeTab(tab: string, group: string, options?: ApplicationV2.ChangeTabOptions): void;
 
+  /**
+   * Programmatically submit an ApplicationV2 instance which implements a single top-level form.
+   * @param submitOptions - Arbitrary options which are supported by and provided to the configured form submission handler.
+   * @returns A promise that resolves to the returned result of the form submission handler, if any.
+   * @remarks Return is accurate to 13.340, but https://github.com/foundryvtt/foundryvtt/issues/12661 classifies it as a bug.
+   * Correct return is based on the handler.
+   * @privateRemarks TODO: More precisely type the submitOptions, as they vary with the handler
+   * which means on DocumentSheet they can be the document's create or update operations
+   */
+  submit(submitOptions?: AnyObject): Promise<void>;
+
   /**
    * Perform an event in the application life-cycle.
    * Await an internal life-cycle method defined by the class.
@@ -825,7 +874,7 @@ declare class ApplicationV2<
    * @param event  - The originating click event
    * @param target - The capturing HTML element which defined a [data-action]
    */
-  protected _onClickAction(event: PointerEvent, target: HTMLElement & { dataset: { action: string } }): void;
+  protected _onClickAction(event: PointerEvent, target: ApplicationV2.ActionTarget): void;
 
   /**
    * Handle submission for an Application which uses the form element.
@@ -839,7 +888,7 @@ declare class ApplicationV2<
    * @param formConfig - The form configuration for which this handler is bound
    * @param event      - The form submission event
    */
-  _onChangeForm(formConfig: ApplicationV2.FormConfiguration, event: Event): void;
+  protected _onChangeForm(formConfig: ApplicationV2.FormConfiguration, event: Event): void;
 
   /**
    * Parse a CSS style rule into a number of pixels which apply to that dimension.
@@ -847,7 +896,7 @@ declare class ApplicationV2<
    * @param parentDimension - The relevant dimension of the parent element
    * @returns The parsed style dimension in pixels
    */
-  static parseCSSDimensions(style: string, parentDimension: number): number;
+  static parseCSSDimensions(style: string, parentDimension: number): number | undefined;
 
   /**
    * Wait for a CSS transition to complete for an element.
@@ -857,6 +906,19 @@ declare class ApplicationV2<
    */
   protected _awaitTransition(element: HTMLElement, timeout: number): Promise<void>;
 
+  /**
+   * Create a ContextMenu instance used in this Application.
+   * @param handler   - A handler function that provides initial context options
+   * @param selector  - A CSS selector to which the ContextMenu will be bound
+   * @param options   - Additional options which affect ContextMenu construction
+   * @returns A created ContextMenu or null if no menu items were defined
+   */
+  protected _createContextMenu(
+    handler: ApplicationV2.CreateContextMenuHandler,
+    selector: string,
+    options: ApplicationV2.CreateContextMenuOptions,
+  ): ContextMenu | null;
+
   /**
    * Wait for any images in the given element to load.
    * @param element - The element.
@@ -871,7 +933,7 @@ declare class ApplicationV2<
 }
 
 declare abstract class AnyApplicationV2 extends ApplicationV2<any, any, any> {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }
 
 export default ApplicationV2;

package/src/foundry/client-esm/applications/api/dialog.d.mts

@@ -151,7 +151,7 @@ declare class DialogV2<
    * @see {@link DialogV2.wait}
    */
   static query<T extends DialogV2.Type, Options extends DialogV2.QueryConfig<T>>(
-    user: User.ConfiguredInstance | string,
+    user: User.Implementation | string,
     type: T,
     config?: Options,
   ): Promise<DialogV2.QueryReturn<T, Options>>;
@@ -166,7 +166,22 @@ declare class DialogV2<
 }
 
 declare namespace DialogV2 {
-  export interface Button<CallbackReturn = string> {
+  interface Button<CallbackReturn> extends NoCallbackButton {
+    /**
+     * A function to invoke when the button is clicked. The value returned
+     * from this function will be used as the dialog's submitted value.
+     * Otherwise, the button's identifier is used.
+     */
+    callback?: ButtonCallback<CallbackReturn>;
+  }
+
+  type ButtonCallback<T> = (
+    event: PointerEvent | SubmitEvent,
+    button: HTMLButtonElement,
+    dialog: HTMLDialogElement,
+  ) => MaybePromise<T>;
+
+  interface NoCallbackButton {
     /**
      * The button action identifier.
      */
@@ -193,24 +208,9 @@ declare namespace DialogV2 {
      * keypress.
      */
     default?: boolean;
-
-    /**
-     * A function to invoke when the button is clicked. The value returned
-     * from this function will be used as the dialog's submitted value.
-     * Otherwise, the button's identifier is used.
-     */
-    callback?: ButtonCallback<CallbackReturn>;
   }
 
-  export type ButtonCallback<T> = (
-    event: PointerEvent | SubmitEvent,
-    button: HTMLButtonElement,
-    dialog: HTMLDialogElement,
-  ) => MaybePromise<T>;
-
-  type NoCallbackButton = Omit<Button, "callback">;
-
-  export interface Configuration extends ApplicationV2.Configuration {
+  interface Configuration extends ApplicationV2.Configuration {
     /**
      * Modal dialogs prevent interaction with the rest of the UI until they are dismissed or submitted.
      */
@@ -236,15 +236,15 @@ declare namespace DialogV2 {
     submit?: SubmitCallback | null | undefined;
   }
 
-  export type RenderCallback = (event: Event, dialog: HTMLDialogElement) => void;
+  type RenderCallback = (event: Event, dialog: HTMLDialogElement) => void;
 
-  export type CloseCallback = (event: Event, dialog: DialogV2) => void;
+  type CloseCallback = (event: Event, dialog: DialogV2) => void;
 
   // This is nominally receiving the results of the button callbacks,
   // but that just further complicates the conditional types
-  export type SubmitCallback = (result: unknown) => Promise<void>;
+  type SubmitCallback = (result: unknown) => Promise<void>;
 
-  export interface WaitOptions extends DeepPartial<Configuration> {
+  interface WaitOptions extends DeepPartial<Configuration> {
     /**
      * A synchronous function to invoke whenever the dialog is rendered.
      */
@@ -265,7 +265,7 @@ declare namespace DialogV2 {
     /**
      * The user that the dialog should be shown to.
      */
-    user?: User.ConfiguredInstance;
+    user?: User.Implementation;
   }
 
   interface ConfirmConfig<YesReturn, NoReturn> extends WaitOptions {