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

package/README.md

@@ -15,13 +15,27 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
 
 We aim to support the latest release of each Foundry VTT version (0.7, 0.8, 9, etc.), starting with 0.7.
 
-At the moment, versions 0.7, 0.8, and 9 are fully supported. Work on support for version 11 is well underway, but involves some catchup on Version 11. See the [open foundry V10 issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V10%22) as well as the [Version 11 tracking issue](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues/2461) to view the current progress
+At the moment, versions 0.7, 0.8, and 9 are fully supported with partial support for versions 10 and 11. Work on support for version 12 is currently underway. See the [open foundry V12 issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V12%22).
+
+## V12 Installation
+
+Currently v12 is still in beta. There are known bugs, issues in the ergonomics, and major unfinished work in the current implementation. To get a direct line of communication about the current status of development as well as to help us understand what areas need to be prioritizated first, join the [League of Extraordinary FoundryVTT Developers Discord](https://discord.gg/73HTMuK7dT) or file an issue.
+
+The recommended way to install for v12 is this command:
+
+```sh
+npm add --include=dev github:League-of-Foundry-Developers/foundry-vtt-types#main
+```
+
+Alternatively, if you're using yarn you'll need to use the command `yarn add --dev foundry-vtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main`.
+
+This will add the current commit on `main` as a dependency. Both npm and yarn's lockfile will store the commit you initially installed this command and so updates to your dependency will not happen automatically or even after a fresh install. To update you will need to be rerun the prior command periodically to update as improvements are added frequently.
 
 ## Installation
 
-You can install foundry-vtt-types from the [npm registry](https://npmjs.org/).
+You can install historical versions of foundry-vtt-types from the [npm registry](https://npmjs.org/).
 
-In order to install the latest version, run
+In order to install the latest stable version (v9), run
 
 ```sh
 npm install --save-dev @league-of-foundry-developers/foundry-vtt-types

package/package.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "12.331.1-beta",
+  "version": "12.331.3-beta",
   "description": "TypeScript type definitions for Foundry VTT",
   "type": "module",
   "types": "./index.d.mts",
   "scripts": {
-    "lint": "./node_modules/typescript/bin/tsc; eslint .",
-    "lint:fix": "eslint --fix .",
-    "lint:ci": "eslint .",
+    "lint": "./node_modules/typescript/bin/tsc; eslint .; prettier -c .",
+    "lint:fix": "eslint --fix .; prettier -w .",
+    "lint:ci": "eslint .; prettier -c .",
     "eslint:report": "eslint --output-file eslint_report.json --format json .",
     "test": "vitest --typecheck",
     "typecheck": "./node_modules/typescript/bin/tsc",
@@ -81,26 +81,26 @@
     "tinymce": "^6.8.3"
   },
   "devDependencies": {
-    "@types/fvtt-types": "file:.",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
+    "@fvtt-types/fvtt-types": "file:.",
+    "@typescript-eslint/eslint-plugin": "^8.12.2",
+    "@typescript-eslint/parser": "^8.12.2",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-tsdoc": "^0.3.0",
+    "eslint-plugin-tsdoc": "^0.4.0",
     "husky": "^9.1.4",
-    "is-ci": "^3.0.1",
-    "lint-staged": "^15.0.1",
+    "is-ci": "^4.1.0",
+    "lint-staged": "^15.2.10",
     "prettier": "^3.0.3",
-    "typescript": "~5.6",
-    "vitest": "^1.1.0"
+    "typescript": "~5.7",
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "typescript": "^5.4"
   },
   "overrides": {
-    "@types/css-font-loading-module": "^0.0.12s"
+    "@types/css-font-loading-module": "^0.0.14"
   },
   "resolutions": {
     "@types/earcut": "patch:@types/earcut@2.1.4#./patches/@types+earcut+2.1.4.patch"
@@ -121,6 +121,5 @@
   ],
   "publishConfig": {
     "access": "public"
-  },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  }
 }

package/src/foundry/client/apps/app.d.mts

@@ -7,7 +7,7 @@ declare global {
   let _appId: number;
 
   /**
-   * @defaultValue `100`
+   * @defaultValue `Number(getComputedStyle(document.body).getPropertyValue("--z-index-window") ?? 100)`
    */
   let _maxZ: number;
 
@@ -312,6 +312,13 @@ declare global {
      */
     protected static _getInheritanceChain(): (typeof Application)[];
 
+    /**
+     * Call all hooks for all applications in the inheritance chain.
+     * @param hookName - The hook being triggered, which formatted with the Application class name
+     * @param hookArgs - The arguments passed to the hook calls
+     */
+    protected _callHooks(hookName: string | ((className: string) => string), hookArgs?: unknown[]): void;
+
     /**
      * Persist the scroll positions of containers within the app before re-rendering the content
      * @param html - The HTML object being traversed

package/src/foundry/client/apps/form.d.mts

@@ -1,6 +1,6 @@
 import type { EditorView } from "prosemirror-view";
 import type { Editor } from "tinymce";
-import type { AnyObject, GetDataReturnType, MaybePromise } from "../../../types/utils.d.mts";
+import type { AnyObject, GetDataReturnType, InexactPartial, MaybePromise } from "../../../types/utils.d.mts";
 import type { ProseMirrorKeyMaps, ProseMirrorMenu } from "../../common/prosemirror/_module.d.mts";
 import type Document from "../../common/abstract/document.d.mts";
 
@@ -81,13 +81,6 @@ declare global {
      */
     form: HTMLElement | null;
 
-    /**
-     * Keep track of any FilePicker instances which are associated with this form
-     * The values of this Array are inner-objects with references to the FilePicker instances and other metadata
-     * @defaultValue `[]`
-     */
-    filepickers: FilePicker[];
-
     /**
      * Keep track of any mce editors which may be active as part of this form
      * The values of this Array are inner-objects with references to the MCE editor and other metadata
@@ -95,6 +88,11 @@ declare global {
      */
     editors: Record<string, FormApplication.FormApplicationEditor>;
 
+    /**
+     * An array of custom element tag names that should be listened to for changes.
+     */
+    protected static _customElements: string[];
+
     /**
      * Assign the default options which are supported by the entity edit sheet.
      * @returns The default options for this FormApplication class
@@ -185,13 +183,6 @@ declare global {
      */
     protected _onChangeRange(event: JQuery.ChangeEvent): void;
 
-    /**
-     * Additional handling which should trigger when a FilePicker contained within this FormApplication is submitted.
-     * @param selection  - The target path which was selected
-     * @param filePicker - The FilePicker instance which was submitted
-     */
-    protected _onSelectFile(selection: string, filePicker: FilePicker): void;
-
     /**
      * This method is called upon form submission after form data is validated
      * @param event    - The initial triggering submission event
@@ -216,11 +207,23 @@ declare global {
 
     /**
      * Handle saving the content of a specific editor by name
-     * @param name   - The named editor to save
-     * @param remove - Remove the editor after saving its content
-     *                 (default: `true`)
+     * @param name - The named editor to save
      */
-    saveEditor(name: string, { remove }?: { remove?: boolean }): Promise<void>;
+    saveEditor(
+      name: string,
+      options?: InexactPartial<{
+        /**
+         * Remove the editor after saving its content
+         * @defaultValue `true`
+         */
+        remove: boolean;
+
+        /**
+         * Prevent normal re-rendering of the sheet after saving.
+         */
+        preventRender: boolean;
+      }>,
+    ): Promise<void>;
 
     /**
      * Activate an editor instance present within the form
@@ -244,20 +247,6 @@ declare global {
       keyMaps: ReturnType<(typeof ProseMirrorKeyMaps)["build"]>;
     };
 
-    /**
-     * Activate a FilePicker instance present within the form
-     * @param event - The mouse click event on a file picker activation button
-     */
-    protected _activateFilePicker(event: PointerEvent): void;
-
-    /**
-     * Determine the configuration options used to initialize a FilePicker instance within this FormApplication.
-     * Subclasses can extend this method to customize the behavior of pickers within their form.
-     * @param event - The initiating mouse click event which opens the picker
-     * @returns Options passed to the FilePicker constructor
-     */
-    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
-
     /**
      * @param options - (default: `{}`)
      */
@@ -269,12 +258,34 @@ declare global {
      *                  (default: `{}`)
      * @returns Return a self-reference for convenient method chaining
      */
-    submit(options?: FormApplication.OnSubmitOptions): Promise<this> | void;
+    submit(options?: FormApplication.OnSubmitOptions): Promise<this>;
+
+    /**
+     * @deprecated since v12, will be removed in v14
+     */
+    get filepickers(): FilePicker[];
+
+    /**
+     * @deprecated since v12, will be removed in v14
+     */
+    protected _activateFilePicker(event: PointerEvent): void;
+
+    /**
+     * @deprecated since v12, will be removed in v14
+     */
+    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
+
+    /**
+     * @deprecated since v12, will be removed in v14
+     */
+    protected _onSelectFile(selection: string, filePicker: FilePicker): void;
   }
 
   namespace FormApplication {
     type Any = FormApplication<any, any>;
 
+    type AnyConstructor = typeof AnyFormApplication;
+
     interface CloseOptions extends Application.CloseOptions {
       submit?: boolean;
     }
@@ -397,7 +408,7 @@ declare global {
       initialContent?: string,
     ): Promise<Editor | EditorView>;
 
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
     protected override _renderOuter(): Promise<JQuery<HTMLElement>>;
 
@@ -467,3 +478,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyFormApplication extends FormApplication<any, any> {
+  constructor(arg0: never, ...args: never[]);
+}

package/src/foundry/client/apps/forms/combat-config.d.mts

@@ -43,7 +43,7 @@ declare global {
     interface CombatTrackerConfigData extends FormApplication.FormApplicationData {
       settings: SettingConfig["core.combatTrackerConfig"];
       attributeChoices: ReturnType<(typeof TokenDocument)["getTrackedAttributeChoices"]>;
-      combatTheme: SettingOptions<string>;
+      combatTheme: ClientSettings.SettingConfig<string>;
       selectedTheme: SettingConfig["core.combatTheme"];
       user: User;
     }

package/src/foundry/client/apps/forms/grid-config.d.mts

@@ -10,11 +10,7 @@ declare global {
     Options,
     Scene.ConfiguredInstance
   > {
-    constructor(
-      scene: Scene.ConfiguredInstance,
-      sheet: GridConfig["sheet"],
-      options?: Partial<Options>,
-    );
+    constructor(scene: Scene.ConfiguredInstance, sheet: GridConfig["sheet"], options?: Partial<Options>);
 
     /**
      * Track the Scene Configuration sheet reference

package/src/foundry/client/apps/forms/sheet-config.d.mts

@@ -1,4 +1,5 @@
 import type { ConstructorOf, GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../../../client-esm/applications/api/document-sheet.d.mts";
 import type { Document } from "../../../common/abstract/module.d.mts";
 
 declare global {
@@ -70,7 +71,7 @@ declare global {
     static registerSheet(
       documentClass: Document.AnyConstructor,
       scope: string,
-      sheetClass: typeof FormApplication,
+      sheetClass: FormApplication.AnyConstructor | DocumentSheetV2.AnyConstructor,
       config?: DocumentSheetConfig.RegisterSheetOptions,
     ): void;
 

package/src/foundry/client/apps/i18n.d.mts

@@ -41,6 +41,65 @@ declare global {
      */
     initialize(): Promise<void>;
 
+    /**
+     * Perform one-time localization of the fields in a DataModel schema, translating their label and hint properties.
+     * @param model   - The DataModel class to localize
+     * @param options - Options which configure how localization is performed
+     *
+     * @example
+     * JavaScript class definition and localization call.
+     * ```js
+     * class MyDataModel extends foundry.abstract.DataModel {
+     *   static defineSchema() {
+     *     return {
+     *       foo: new foundry.data.fields.StringField(),
+     *       bar: new foundry.data.fields.NumberField()
+     *     };
+     *   }
+     *   static LOCALIZATION_PREFIXES = ["MYMODULE.MYDATAMODEL"];
+     * }
+     *
+     * Hooks.on("i18nInit", () => {
+     *   Localization.localizeDataModel(MyDataModel);
+     * });
+     * ```
+     *
+     * JSON localization file
+     * ```json
+     * {
+     *   "MYMODULE": {
+     *     "MYDATAMODEL": {
+     *       "FIELDS" : {
+     *         "foo": {
+     *           "label": "Foo",
+     *           "hint": "Instructions for foo"
+     *         },
+     *         "bar": {
+     *           "label": "Bar",
+     *           "hint": "Instructions for bar"
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    static localizeDataModel(
+      model: foundry.abstract.DataModel.AnyConstructor,
+      options?: InexactPartial<{
+        /**
+         * An array of localization key prefixes to use. If not specified, prefixes
+         * are learned from the DataModel.LOCALIZATION_PREFIXES static property.
+         */
+        prefixes: string[];
+
+        /**
+         * A localization path prefix used to prefix all field names within this model. This is generally not required.
+         */
+        prefixPath: string;
+      }>,
+    ): void;
+
     /**
      * Set a language as the active translation source for the session
      * @param lang - A language string in CONFIG.supportedLanguages

package/src/foundry/client/apps/placeables/note-config.d.mts

@@ -1,4 +1,3 @@
-import type { ConfiguredDocumentClassForName } from "../../../../types/helperTypes.d.mts";
 import type { MaybePromise } from "../../../../types/utils.d.mts";
 
 declare global {
@@ -7,8 +6,9 @@ declare global {
    * @typeParam Options - the type of the options object
    */
   class NoteConfig<
-    Options extends DocumentSheetOptions<NoteDocument> = DocumentSheetOptions<NoteDocument>,
-  > extends DocumentSheet<Options, InstanceType<ConfiguredDocumentClassForName<"Note">>> {
+    Options extends
+      DocumentSheetOptions<NoteDocument.ConfiguredInstance> = DocumentSheetOptions<NoteDocument.ConfiguredInstance>,
+  > extends DocumentSheet<Options, NoteDocument.ConfiguredInstance> {
     /**
      * @defaultValue
      * ```typescript

package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts

@@ -68,7 +68,7 @@ declare global {
     type Any = SettingsConfig<any>;
 
     interface Category extends PackageConfiguration.Category {
-      menus: SettingSubmenuConfig[];
+      menus: ClientSettings.SettingSubmenuConfig[];
       settings: SettingConfig[];
       count: number;
     }

package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts

@@ -46,9 +46,9 @@ declare global {
      */
     protected _detectConflictingActions(
       actionId: string,
-      action: KeybindingActionConfig,
-      binding: KeybindingActionBinding,
-    ): KeybindingAction[];
+      action: ClientKeybindings.KeybindingActionConfig,
+      binding: ClientKeybindings.KeybindingActionBinding,
+    ): ClientKeybindings.KeybindingAction[];
 
     /**
      * Transforms a Binding into a human readable string representation
@@ -56,7 +56,7 @@ declare global {
      * @returns A human readable string
      * @internal
      */
-    protected static _humanizeBinding(binding: KeybindingActionBinding): string;
+    protected static _humanizeBinding(binding: ClientKeybindings.KeybindingActionBinding): string;
 
     override activateListeners(html: JQuery): void;
 
@@ -153,7 +153,7 @@ declare global {
 
     interface CategoryData extends PackageConfiguration.CategoryData<Category> {}
 
-    interface ActionData extends KeybindingActionConfig {
+    interface ActionData extends ClientKeybindings.KeybindingActionConfig {
       category: string;
       bindings: DisplayBinding[];
       id: string;
@@ -163,7 +163,7 @@ declare global {
       notes: string;
     }
 
-    interface DisplayBinding extends Partial<KeybindingActionBinding> {
+    interface DisplayBinding extends Partial<ClientKeybindings.KeybindingActionBinding> {
       id: string;
       display: string;
       cssClasses: string;
@@ -173,7 +173,7 @@ declare global {
       hasConflicts: boolean;
     }
 
-    interface PendingBinding extends KeybindingActionBinding {
+    interface PendingBinding extends ClientKeybindings.KeybindingActionBinding {
       index: number;
     }
   }

package/src/foundry/client/apps/sidebar/document-directory.d.mts

@@ -1,4 +1,3 @@
-import type { ConfiguredDocumentClassForName } from "../../../../types/helperTypes.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
@@ -29,7 +28,7 @@ declare global {
     /**
      * References to the set of Documents which are displayed in the Sidebar
      */
-    documents: FolderType extends Document.Type ? InstanceType<ConfiguredDocumentClassForName<FolderType>> : undefined;
+    documents: FolderType extends Document.Type ? Document.ConfiguredInstanceForName<FolderType>[] : undefined;
 
     /**
      * Reference the set of Folders which exist in this Sidebar