@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

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

@@ -1,56 +1,19 @@
-import type { ValueOf } from "../../../types/utils.d.mts";
+import type { ValueOf } from "#utils";
 
 declare global {
-  /** Options which customize the behavior of the filter */
-  interface SearchFilterConfiguration {
-    /**
-     * The CSS selector used to target the text input element.
-     */
-    inputSelector: string;
-
-    /**
-     * The CSS selector used to target the content container for these tabs.
-     */
-    contentSelector: string;
-
-    /**
-     * A callback function which executes when the filter changes.
-     */
-    callback?: SearchFilter["callback"];
-
-    /**
-     * The initial value of the search query.
-     * @defaultValue `""`
-     */
-    initial?: SearchFilter["query"] | undefined;
-
-    /**
-     * The number of milliseconds to wait for text input before processing.
-     * @defaultValue `100`
-     */
-    delay?: number;
-  }
-
-  interface FieldFilter {
-    /** The dot-delimited path to the field being filtered */
-    field: string;
-
-    /**
-     * The search operator, from CONST.OPERATORS
-     * @defaultValue `SearchFilter.OPERATORS.EQUALS`
-     */
-    operator: ValueOf<typeof SearchFilter.OPERATORS>;
-
-    /** Negate the filter, returning results which do NOT match the filter criteria */
-    negate: boolean;
+  /**
+   * @deprecated {@link SearchFilter.Configuration | `SearchFilter.Configuration`}
+   */
+  type SearchFilterConfiguration = SearchFilter.Configuration;
 
-    /** The value against which to test */
-    value: any;
-  }
+  /**
+   * @deprecated {@link SearchFilter.FieldFilter | `SearchFilter.FieldFilter`}
+   */
+  type FieldFilter = SearchFilter.FieldFilter;
 
   /**
    * A controller class for managing a text input widget that filters the contents of some other UI element
-   * @see {@link Application}
+   * @see {@link Application | `Application`}
    */
   class SearchFilter {
     static readonly OPERATORS: {
@@ -69,7 +32,7 @@ declare global {
     /**
      * @param options - Options which customize the behavior of the filter
      */
-    constructor(options: SearchFilterConfiguration);
+    constructor(options: SearchFilter.Configuration);
 
     /**
      * The value of the current query string
@@ -79,7 +42,7 @@ declare global {
     /**
      * A callback function to trigger when the tab is changed
      */
-    callback: (event: KeyboardEvent, query: string, rgx: RegExp, content: string) => void;
+    callback: (event: KeyboardEvent, query: string, rgx: RegExp, content: HTMLElement | null) => void;
 
     /**
      * The regular expression corresponding to the query that should be matched against
@@ -123,7 +86,7 @@ declare global {
      * @param filter - The filter to test
      * @returns Whether the object matches the filter
      */
-    static evaluateFilter(obj: Record<string, any>, filter: FieldFilter): boolean;
+    static evaluateFilter(obj: Record<string, any>, filter: SearchFilter.FieldFilter): boolean;
 
     /**
      * Bind the SearchFilter controller to an HTML application
@@ -145,4 +108,53 @@ declare global {
      */
     static cleanQuery(query: string): string;
   }
+
+  namespace SearchFilter {
+    /** Options which customize the behavior of the filter */
+    interface Configuration {
+      /**
+       * The CSS selector used to target the text input element.
+       */
+      inputSelector: string;
+
+      /**
+       * The CSS selector used to target the content container for these tabs.
+       */
+      contentSelector: string;
+
+      /**
+       * A callback function which executes when the filter changes.
+       */
+      callback?: SearchFilter["callback"];
+
+      /**
+       * The initial value of the search query.
+       * @defaultValue `""`
+       */
+      initial?: SearchFilter["query"] | undefined;
+
+      /**
+       * The number of milliseconds to wait for text input before processing.
+       * @defaultValue `100`
+       */
+      delay?: number;
+    }
+
+    interface FieldFilter {
+      /** The dot-delimited path to the field being filtered */
+      field: string;
+
+      /**
+       * The search operator, from CONST.OPERATORS
+       * @defaultValue `SearchFilter.OPERATORS.EQUALS`
+       */
+      operator: ValueOf<typeof SearchFilter.OPERATORS>;
+
+      /** Negate the filter, returning results which do NOT match the filter criteria */
+      negate: boolean;
+
+      /** The value against which to test */
+      value: any;
+    }
+  }
 }

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

@@ -58,28 +58,28 @@ declare global {
      */
     override append(name: string, value: any): void;
   }
-}
 
-declare namespace FormDataExtended {
-  interface Options {
-    /**
-     * A record of TinyMCE editor metadata objects, indexed by their update key
-     * (default: `{}`)
-     */
-    editors?: FormDataExtended["editors"];
-    /**
-     * A mapping of data types for form fields
-     * (default: `{}`)
-     */
-    dtypes?: FormDataExtended["dtypes"];
-    /**
-     * Include disabled fields?
-     * (default: `false`)
-     */
-    disabled?: boolean;
-    /** Include readonly fields?
-     * (default: `true`)
-     */
-    readonly?: boolean;
+  namespace FormDataExtended {
+    interface Options {
+      /**
+       * A record of TinyMCE editor metadata objects, indexed by their update key
+       * (default: `{}`)
+       */
+      editors?: FormDataExtended["editors"];
+      /**
+       * A mapping of data types for form fields
+       * (default: `{}`)
+       */
+      dtypes?: FormDataExtended["dtypes"];
+      /**
+       * Include disabled fields?
+       * (default: `false`)
+       */
+      disabled?: boolean;
+      /** Include readonly fields?
+       * (default: `true`)
+       */
+      readonly?: boolean;
+    }
   }
 }

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

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "../../../utils/index.d.mts";
 
 declare global {
   /**
@@ -16,7 +16,7 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class Notifications<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class Notifications<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(options?: Partial<Options>);
 
     /**
@@ -41,7 +41,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * Initialize the Notifications system by displaying any system-generated messages which were passed from the server.
@@ -105,6 +105,9 @@ declare global {
   }
 
   namespace Notifications {
+    interface Any extends AnyNotifications {}
+    interface AnyConstructor extends Identity<typeof AnyNotifications> {}
+
     interface NotifyOptions {
       /**
        * Should the notification be permanently displayed until dismissed
@@ -134,3 +137,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyNotifications extends Notifications<Application.Options> {
+  constructor(...args: never);
+}

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

@@ -4,16 +4,16 @@ import type { EditorView } from "prosemirror-view";
 import type { Socket } from "socket.io-client";
 
 declare global {
-  interface ProseMirrorHistory {
-    /** The ID of the user who submitted the step. */
-    userId: string;
-    /** The step that was submitted. */
-    step: Step;
-  }
+  /**
+   * @deprecated {@link ProseMirrorEditor.History | `ProseMirrorEditor.History`}
+   */
+  type ProseMirrorHistory = ProseMirrorEditor.History;
+
   namespace ProseMirrorEditor {
     interface Options {
       document?: ClientDocument;
     }
+
     interface CreateOptions {
       /** A string to uniquely identify this ProseMirror instance. Ignored for a collaborative editor. */
       uuid: string;
@@ -26,7 +26,15 @@ declare global {
       /** Whether to enable collaborative editing for this editor. */
       collaborate: boolean;
     }
+
+    interface History {
+      /** The ID of the user who submitted the step. */
+      userId: string;
+      /** The step that was submitted. */
+      step: Step;
+    }
   }
+
   /**
    * A class responsible for managing state and collaborative editing of a single ProseMirror instance.
    */
@@ -84,7 +92,7 @@ declare global {
      * @param offset  - The offset into the history, representing the point at which it was last truncated.
      * @param history - The entire edit history.
      */
-    protected _onNewSteps(offset: string, history: ProseMirrorHistory[]): void;
+    protected _onNewSteps(offset: string, history: ProseMirrorEditor.History[]): void;
 
     /**
      * Disable source code editing if the user was editing it when new steps arrived.

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

@@ -2,36 +2,23 @@ import type Document from "../../common/abstract/document.d.mts";
 
 declare global {
   /**
-   * @param secret - The secret element whose surrounding content we wish to retrieve.
-   * @returns The content where the secret is housed.
+   * @deprecated {@link HTMLSecret.ContentCallback | `HTMLSecret.ContentCallback`}
    */
-  type HTMLSecretContentCallback = (secret: HTMLElement) => string;
+  export import HTMLSecretContentCallback = HTMLSecret.ContentCallback;
 
   /**
-   * @param secret  - The secret element that is being manipulated.
-   * @param content - The content block containing the updated secret element.
-   * @returns The updated Document.
+   * @deprecated {@link HTMLSecret.UpdateCallback | `HTMLSecret.UpdateCallback`}
    */
-  type HTMLSecretUpdateCallback<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > = (secret: HTMLElement, content: string) => Promise<ConcreteDocument>;
+  export import HTMLSecretUpdateCallback = HTMLSecret.UpdateCallback;
 
-  interface HTMLSecretConfiguration<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > {
-    /** The CSS selector used to target content that contains secret blocks. */
-    parentSelector: string;
-
-    /** An object of callback functions for each operation. */
-    callbacks: {
-      content: HTMLSecretContentCallback;
-      update: HTMLSecretUpdateCallback<ConcreteDocument>;
-    };
-  }
+  /**
+   * @deprecated {@link HTMLSecret.Configuration | `HTMLSecret.Configuration`}
+   */
+  export import HTMLSecretConfiguration = HTMLSecret.Configuration;
 
   /**
    * A composable class for managing functionality for secret blocks within DocumentSheets.
-   * @see DocumentSheet
+   * @see {@link DocumentSheet | `DocumentSheet`}
    * @example Activate secret revealing functionality within a certain block of content.
    * ```js
    * const secrets = new HTMLSecret({
@@ -48,16 +35,13 @@ declare global {
     /**
      * @param config - Configuration options.
      */
-    constructor(
-      config: Omit<HTMLSecretConfiguration<ConcreteDocument>, "callbacks"> &
-        Partial<Pick<HTMLSecretConfiguration<ConcreteDocument>, "callbacks">>,
-    );
+    constructor(config: HTMLSecret.Configuration<ConcreteDocument>);
 
     /** The CSS selector used to target secret blocks. */
     readonly parentSelector: string;
 
     /** An object of callback functions for each operation. */
-    readonly callbacks: Readonly<HTMLSecretConfiguration<ConcreteDocument>["callbacks"]>;
+    readonly callbacks: Readonly<HTMLSecret.Callbacks<ConcreteDocument>>;
 
     /**
      * Add event listeners to the targeted secret blocks.
@@ -72,4 +56,35 @@ declare global {
      */
     protected _onToggleSecret(event: MouseEvent): ConcreteDocument | void;
   }
+
+  namespace HTMLSecret {
+    /**
+     * @param secret - The secret element whose surrounding content we wish to retrieve.
+     * @returns The content where the secret is housed.
+     */
+    type ContentCallback = (secret: HTMLElement) => string;
+
+    /**
+     * @param secret  - The secret element that is being manipulated.
+     * @param content - The content block containing the updated secret element.
+     * @returns The updated Document.
+     */
+    type UpdateCallback<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> = (
+      secret: HTMLElement,
+      content: string,
+    ) => Promise<ConcreteDocument>;
+
+    interface Configuration<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> {
+      /** The CSS selector used to target content that contains secret blocks. */
+      parentSelector: string;
+
+      /** An object of callback functions for each operation. */
+      callbacks?: Callbacks<ConcreteDocument> | undefined;
+    }
+
+    interface Callbacks<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> {
+      content: HTMLSecret.ContentCallback;
+      update: HTMLSecret.UpdateCallback<ConcreteDocument>;
+    }
+  }
 }

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/applications/_module.d.mts

@@ -1,7 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export * as types from "./_types.mjs";
 export * as api from "./api/_module.mjs";
@@ -15,7 +15,7 @@ export * as ui from "./ui/_module.mjs";
 /**
  * A registry of currently rendered ApplicationV2 instances.
  */
-export const instances: Map<number, foundry.applications.api.ApplicationV2>;
+export const instances: Map<string, foundry.applications.api.ApplicationV2.Any>;
 
 /**
  * Parse an HTML string, returning a processed HTMLElement or HTMLCollection.

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

@@ -1,7 +1,5 @@
 import type ApplicationV2 from "./api/application.d.mts";
 
-export {};
-
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?
 //

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

@@ -1,7 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export { default as ApplicationV2 } from "./application.mjs";
 export { default as DialogV2 } from "./dialog.mjs";

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

@@ -1,5 +1,4 @@
-import type { MustConform } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial, EmptyObject, InexactPartial, MaybePromise } from "../../../../types/utils.d.mts";
+import type { MustConform, AnyObject, DeepPartial, EmptyObject, InexactPartial, MaybePromise, Identity } from "#utils";
 import type EventEmitterMixin from "../../../common/utils/event-emitter.d.mts";
 
 // TODO: Investigate use of DeepPartial vs Partial vs InexactPartial
@@ -14,11 +13,12 @@ type _ClassMustBeAssignableToInternal = MustConform<typeof ApplicationV2, Applic
 type _InstanceMustBeAssignableToInternal = MustConform<ApplicationV2, ApplicationV2.Internal.Instance.Any>;
 
 declare namespace ApplicationV2 {
-  type Any = ApplicationV2<any, any, any>;
+  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;
     };
 
@@ -44,11 +44,11 @@ declare namespace ApplicationV2 {
     }
 
     namespace Instance {
-      type Any = Instance<any, any, any>;
+      interface Any extends Instance<any, any, any> {}
     }
   }
 
-  export interface Configuration {
+  interface Configuration {
     /**
      * An HTML element identifier used for this Application instance
      */
@@ -274,7 +274,7 @@ declare namespace ApplicationV2 {
 
     field?: foundry.data.fields.DataField | undefined;
 
-    value?: unknown | undefined;
+    value?: unknown;
   }
 
   /** @remarks Used with `templates/generic/form-footer.hbs` */
@@ -330,15 +330,17 @@ declare class ApplicationV2<
 > extends EventEmitterMixin(Object) {
   static [__ApplicationV2Brand]: never;
 
+  [__RenderContext]: RenderContext;
   [__Configuration]: Configuration;
   [__RenderOptions]: RenderOptions;
-  [__RenderContext]: RenderContext;
 
-  constructor(options: DeepPartial<Configuration>);
+  constructor(options?: DeepPartial<Configuration>);
 
   static BASE_APPLICATION: typeof ApplicationV2;
 
-  static DEFAULT_OPTIONS: DeepPartial<ApplicationV2.Configuration>;
+  // Note(LukeAbby): This `& object` is so that the `DEFAULT_OPTIONS` can be overridden more easily
+  // Without it then `static override DEFAULT_OPTIONS = { unrelatedProp: 123 }` would error.
+  static DEFAULT_OPTIONS: DeepPartial<ApplicationV2.Configuration> & object;
 
   static readonly RENDER_STATES: {
     ERROR: -3;
@@ -354,7 +356,7 @@ declare class ApplicationV2<
   /**
    * Application instance configuration options.
    */
-  options: Readonly<DeepPartial<Configuration>>;
+  options: Readonly<Configuration>;
 
   /**
    * Convenience references to window header elements.
@@ -429,7 +431,7 @@ declare class ApplicationV2<
    * Iterate over the inheritance chain of this Application.
    * The chain includes this Application itself and all parents until the base application is encountered.
    */
-  static inheritanceChain(): Generator<typeof ApplicationV2>;
+  static inheritanceChain(): Generator<ApplicationV2.AnyConstructor>;
 
   /**
    * Initialize configuration options for the Application instance.
@@ -440,20 +442,23 @@ declare class ApplicationV2<
    * @param options - Options provided directly to the constructor
    * @returns Configured options for the application instance
    */
-  protected _initializeApplicationOptions(
-    options: DeepPartial<Configuration>,
-  ): DeepPartial<Configuration> & Record<string, unknown>;
+  protected _initializeApplicationOptions(options: DeepPartial<Configuration>): Configuration;
 
   /**
    * Render the Application, creating its HTMLElement and replacing its innerHTML.
    * Add it to the DOM if it is not currently rendered and rendering is forced. Otherwise, re-render its contents.
    * @param options  - Options which configure application rendering behavior.
    *                   A boolean is interpreted as the "force" option.
-   * @param _options - Legacy options for backwards-compatibility with the original
-   *                   ApplicationV1#render signature.
    * @returns A Promise which resolves to the rendered Application instance
    */
-  render(options?: DeepPartial<Configuration> | boolean, _options?: DeepPartial<RenderOptions>): Promise<this>;
+  render(options?: DeepPartial<RenderOptions>): Promise<this>;
+
+  /**
+   * @deprecated Exists for backwards compatability with the original `ApplicationV1#render` signature.
+   *
+   * @param _options - Legacy options for backwards-compatibility with the original ApplicationV1#render signature.
+   */
+  render(options: boolean, _options?: DeepPartial<RenderOptions>): Promise<this>;
 
   /**
    * Modify the provided options passed to a render request.
@@ -466,7 +471,7 @@ declare class ApplicationV2<
    * @param options - Options which configure application rendering behavior
    * @returns Context data for the render operation
    */
-  protected _prepareContext(options: DeepPartial<RenderOptions>): Promise<RenderContext>;
+  protected _prepareContext(options: DeepPartial<RenderOptions> & { isFirstRender: boolean }): Promise<RenderContext>;
 
   /**
    * Configure the array of header control menu options
@@ -703,4 +708,8 @@ declare class ApplicationV2<
   bringToTop(): void;
 }
 
+declare abstract class AnyApplicationV2 extends ApplicationV2<any, any, any> {
+  constructor(...args: never);
+}
+
 export default ApplicationV2;