@league-of-foundry-developers/foundry-vtt-types 9.249.2 → 9.255.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.249.2",
+  "version": "9.255.0",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {
@@ -73,8 +73,8 @@
     "husky": "^7.0.4",
     "lint-staged": "^12.1.2",
     "prettier": "^2.5.1",
-    "tsd": "~0.18.0",
-    "typescript": "~4.5.3"
+    "tsd": "^0.19.1",
+    "typescript": "~4.6.2"
   },
   "husky": {
     "hooks": {

package/src/foundry/common/abstract/data.mjs.d.ts

@@ -283,14 +283,14 @@ declare abstract class DocumentData<
   toObject(source: false): {
     [Key in keyof ConcreteDocumentSchema as string extends Key ? never : Key]: Key extends keyof this
       ? ToObjectFalseType<this[Key]>
-      : undefined;
+      : unknown;
   };
 
   /**
    * Extract the source data for the DocumentData into a simple object format that can be serialized.
    * @returns The document source data expressed as a plain object
    */
-  toJSON(): this['_id'] extends string ? SourceData & { _id: string } : SourceData;
+  toJSON(): this['_id'] extends string ? this['_source'] & { _id: string } : this['_source'];
 
   /**
    * Create a DocumentData instance using a provided serialized JSON string.

package/src/foundry/common/abstract/document.mjs.d.ts

@@ -673,7 +673,11 @@ declare abstract class Document<
    * @param source - Draw values from the underlying data source rather than transformed values
    * @returns The extracted primitive object
    */
-  toObject(source?: true): ReturnType<this['toJSON']>;
+  toObject(
+    source?: true
+  ): this['id'] extends string
+    ? ReturnType<this['data']['toJSON']> & { _id: string }
+    : ReturnType<this['data']['toJSON']>;
   toObject(
     source: false
   ): this['id'] extends string
@@ -686,8 +690,8 @@ declare abstract class Document<
    * @returns The document data expressed as a plain object
    */
   toJSON(): this['id'] extends string
-    ? ReturnType<ConcreteDocumentData['toJSON']> & { _id: string }
-    : ReturnType<ConcreteDocumentData['toJSON']>;
+    ? ReturnType<this['data']['toJSON']> & { _id: string }
+    : ReturnType<this['data']['toJSON']>;
 
   /**
    * For Documents which include game system data, migrate the system data object to conform to its latest data model.

package/src/foundry/common/constants.mjs.d.ts

@@ -817,6 +817,7 @@ export const TEXT_FILE_EXTENSIONS: Readonly<{
   md: 'text/markdown';
   pdf: 'application/pdf';
   txt: 'text/plain';
+  xml: 'application/xml';
 }>;
 export type TEXT_FILE_EXTENSIONS = ValueOf<typeof TEXT_FILE_EXTENSIONS>;
 

package/src/foundry/common/documents.mjs/baseMacro.d.ts

@@ -16,9 +16,6 @@ type MacroMetadata = Merge<
     types: [typeof CONST.MACRO_TYPES.SCRIPT, typeof CONST.MACRO_TYPES.CHAT];
     permissions: {
       create: 'PLAYER';
-      // TODO: fix when fixed by foundry (https://gitlab.com/foundrynet/foundryvtt/-/issues/6694)
-      // update: undefined;
-      // delete: undefined;
     };
   }
 >;

package/src/foundry/common/documents.mjs/baseMeasuredTemplate.d.ts

@@ -15,7 +15,7 @@ type MeasuredTemplateMetadata = Merge<
     labelPlural: 'DOCUMENT.MeasuredTemplates';
     isEmbedded: true;
     permissions: {
-      create: 'TEMPLATE_CREATE';
+      create: (user: BaseUser, doc: BaseMeasuredTemplate) => boolean;
       update: (
         user: BaseUser,
         doc: BaseMeasuredTemplate,
@@ -51,6 +51,13 @@ export declare class BaseMeasuredTemplate extends Document<
     { exact }?: { exact?: boolean }
   ): boolean;
 
+  /**
+   * Is a user able to create a new MeasuredTemplate?
+   * @param user - The user attempting the creation operation.
+   * @param doc  - The MeasuredTemplate being created.
+   */
+  protected static _canCreate(user: BaseUser, doc: BaseMeasuredTemplate): boolean;
+
   /**
    * Is a user able to modify an existing MeasuredTemplate?
    */

package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts

@@ -3,7 +3,13 @@ import { DocumentData } from '../abstract/module.mjs';
 import * as fields from '../data/fields.mjs';
 
 interface PackageCompendiumDataSchema extends DocumentSchema {
-  name: fields.RequiredString;
+  name: FieldReturnType<
+    fields.RequiredString,
+    {
+      validate: (v: string) => boolean;
+      validationError: "Invalid compendium name '{value}'. Compendium names cannot contain dots.";
+    }
+  >;
   label: fields.RequiredString;
   path: fields.RequiredString;
   private: FieldReturnType<fields.BooleanField, { default: false }>;

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

@@ -441,7 +441,6 @@ export declare function setProperty(object: object, key: string, value: any): bo
 
 /**
  * Express a timestamp as a relative string
- * TODO - figure out a way to localize this
  * @param timeStamp - A timestamp string or Date object to be formatted as a relative time
  * @returns A string expression for the relative time
  */

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

@@ -201,10 +201,10 @@ interface NumberConstructor {
 
   /**
    * Attempt to create a number from a user-provided string.
-   * @param str - The string.
+   * @param n - The value to convert; typically a string, but may already be a number.
    * @returns The number that the string represents, or NaN if no number could be determined.
    */
-  fromString(str: string): number;
+  fromString(str: string | number): number;
 }
 
 interface ArrayConstructor {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts

@@ -39,7 +39,7 @@ declare global {
     /**
      * A convenience reference to the Item entity
      */
-    get item(): InstanceType<ConfiguredDocumentClass<typeof Item>>;
+    get item(): this['object'];
 
     /**
      * The Actor instance which owns this item. This may be null if the item is

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

@@ -46,11 +46,8 @@ declare class Notifications<Options extends ApplicationOptions = ApplicationOpti
    */
   initialize(): void;
 
-  /**
-   * @override
-   * @remarks This return a `JQuery`, which is incompatible with the expected `Promise<JQuery>` (see https://gitlab.com/foundrynet/foundryvtt/-/issues/6554).
-   */
-  protected _renderInner(data: object): any;
+  /** @override */
+  protected _renderInner(data: object): Promise<JQuery>;
 
   /** @override */
   protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;

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

@@ -124,9 +124,6 @@ declare global {
       /** @defaultValue `[]` */
       values: number[];
 
-      /** @defaultValue `0` */
-      last: number;
-
       /** @defaultValue `0` */
       average: number;
 
@@ -135,9 +132,6 @@ declare global {
 
       /** @defaultValue `document.getElementById("fps")` */
       element: HTMLElement;
-
-      /** @defaultValue `undefined` */
-      fn: TickerCallback<void> | undefined;
     };
 
     /**
@@ -541,8 +535,6 @@ declare global {
   }
 }
 
-type TickerCallback<T> = (this: T, dt: number) => any;
-
 interface PerformanceSettings {
   mode: foundry.CONST.CANVAS_PERFORMANCE_MODES;
   blur: {

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

@@ -69,6 +69,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were created
      * @param response - The provided Socket response
      * @returns An Array of created Document instances
+     * @internal
      */
     protected _handleCreateDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -76,6 +77,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were created
      * @param response - The provided Socket response
      * @returns An Array of created Document instances
+     * @internal
      */
     protected _handleCreateEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -125,6 +127,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were updated
      * @param response - The provided Socket response
      * @returns An Array of updated Document instances
+     * @internal
      */
     protected _handleUpdateDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -132,6 +135,7 @@ declare global {
      * Handle a SocketResponse from the server when embedded Documents are updated in a parent Document.
      * @param response - The provided Socket response
      * @returns An Array of updated Document instances
+     * @internal
      */
     protected _handleUpdateEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -178,6 +182,7 @@ declare global {
      * Handle a SocketResponse from the server where Documents are deleted.
      * @param response - The provided Socket response
      * @returns An Array of deleted Document instances
+     * @internal
      */
     protected _handleDeleteDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -185,6 +190,7 @@ declare global {
      * Handle a SocketResponse from the server when embedded Documents are deleted from a parent Document.
      * @param response - The provided Socket response
      * @returns An Array of deleted Document instances
+     * @internal
      */
     protected _handleDeleteEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 

package/src/foundry/foundry.js/clientDocuments/cards.d.ts

@@ -72,7 +72,8 @@ declare global {
      * Pass an array of specific Card documents from this document to some other Cards stack.
      * @param to      - Some other Cards document that is the destination for the pass operation
      * @param ids     - The embedded Card ids which should be passed
-     * @param options - (default: `{}`)
+     * @param options - Additional options which modify the pass operation
+     *                  (default: `{}`)
      * @returns An array of the Card embedded documents created within the destination stack
      */
     pass(

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

@@ -1,249 +1,270 @@
-/**
- * A class responsible for managing defined game settings or settings menus.
- * Each setting is a string key/value pair belonging to a certain package and a certain store scope.
- *
- * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
- * Game object as as game.settings.
- *
- * @see {@link Game#settings}
- * @see {@link Settings}
- * @see {@link SettingsConfig}
- */
-declare class ClientSettings {
-  constructor(worldSettings?: Setting['data']['_source'][]);
+import type { DocumentSubTypes, DocumentType } from '../../types/helperTypes';
 
-  /**
-   * A object of registered game settings for this scope
-   */
-  settings: Map<string, ClientSettings.CompleteSetting>;
+import type { TokenDataSource } from '../common/data/data.mjs/tokenData';
 
+declare global {
   /**
-   * Registered settings menus which trigger secondary applications
+   * A class responsible for managing defined game settings or settings menus.
+   * Each setting is a string key/value pair belonging to a certain package and a certain store scope.
+   *
+   * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
+   * Game object as as game.settings.
+   *
+   * @see {@link Game#settings}
+   * @see {@link Settings}
+   * @see {@link SettingsConfig}
    */
-  menus: Map<string, ClientSettings.CompleteMenuSetting>;
+  class ClientSettings {
+    constructor(worldSettings?: Setting['data']['_source'][]);
 
-  /**
-   * The storage interfaces used for persisting settings
-   * Each storage interface shares the same API as window.localStorage
-   * @remarks This is a lie, it doesn't actually have the same interface...
-   */
-  storage: Map<string, Storage | WorldSettings>;
+    /**
+     * A object of registered game settings for this scope
+     */
+    settings: Map<string, ClientSettings.CompleteSetting>;
 
-  /**
-   * The types of settings which should be constructed as a primitive type
-   */
-  protected static PRIMITIVE_TYPES: [typeof String, typeof Number, typeof Boolean, typeof Array];
+    /**
+     * Registered settings menus which trigger secondary applications
+     */
+    menus: Map<string, ClientSettings.CompleteMenuSetting>;
 
-  /**
-   * Return a singleton instance of the Game Settings Configuration app
-   */
-  get sheet(): SettingsConfig;
+    /**
+     * The storage interfaces used for persisting settings
+     * Each storage interface shares the same API as window.localStorage
+     * @remarks This is a lie, it doesn't actually have the same interface...
+     */
+    storage: Map<string, Storage | WorldSettings>;
 
-  /**
-   * Register a new game setting under this setting scope
-   *
-   * @param module - The namespace under which the setting is registered
-   * @param key    - The key name for the setting under the namespace module
-   * @param data   - Configuration for setting data
-   * @typeParam M  - The module name to register the setting for
-   * @typeParam K  - The key to register the setting for
-   * @typeParam T  - The type of the setting value
-   *
-   * @example
-   * ```typescript
-   * // Register a client setting
-   * game.settings.register("myModule", "myClientSetting", {
-   *   name: "Register a Module Setting with Choices",
-   *   hint: "A description of the registered setting and its behavior.",
-   *   scope: "client",     // This specifies a client-stored setting
-   *   config: true,        // This specifies that the setting appears in the configuration view
-   *   type: String,
-   *   choices: {           // If choices are defined, the resulting setting will be a select menu
-   *     "a": "Option A",
-   *     "b": "Option B"
-   *   },
-   *   default: "a",        // The default value for the setting
-   *   onChange: value => { // A callback function which triggers when the setting is changed
-   *     console.log(value)
-   *   }
-   * });
-   * ```
-   *
-   * @example
-   * ```typescript
-   * // Register a world setting
-   * game.settings.register("myModule", "myWorldSetting", {
-   *   name: "Register a Module Setting with a Range slider",
-   *   hint: "A description of the registered setting and its behavior.",
-   *   scope: "world",      // This specifies a world-level setting
-   *   config: true,        // This specifies that the setting appears in the configuration view
-   *   type: Number,
-   *   range: {             // If range is specified, the resulting setting will be a range slider
-   *     min: 0,
-   *     max: 100,
-   *     step: 10
-   *   }
-   *   default: 50,         // The default value for the setting
-   *   onChange: value => { // A callback function which triggers when the setting is changed
-   *     console.log(value)
-   *   }
-   * });
-   * ```
-   */
-  register<M extends string, K extends string, T>(
-    module: M,
-    key: K,
-    data: ClientSettings.Values[`${M}.${K}`] extends boolean | number | bigint | string | symbol | object
-      ? ClientSettings.PartialSetting<ClientSettings.Values[`${M}.${K}`]>
-      : ClientSettings.PartialSetting<T>
-  ): void;
+    /**
+     * The types of settings which should be constructed as a primitive type
+     */
+    protected static PRIMITIVE_TYPES: [typeof String, typeof Number, typeof Boolean, typeof Array];
 
-  /**
-   * Register a new sub-settings menu
-   *
-   * @param module - The namespace under which the menu is registered
-   * @param key    - The key name for the setting under the namespace module
-   * @param data   - Configuration for setting data
-   * @typeParam M  - The module name to register the menu setting for
-   * @typeParam K  - The key to register the menu setting for
-   *
-   * @example
-   * ```typescript
-   * // Define a settings submenu which handles advanced configuration needs
-   * game.settings.registerMenu("myModule", "mySettingsMenu", {
-   *   name: "My Settings Submenu",
-   *   label: "Settings Menu Label",      // The text label used in the button
-   *   hint: "A description of what will occur in the submenu dialog.",
-   *   icon: "fas fa-bars",               // A Font Awesome icon used in the submenu button
-   *   type: MySubmenuApplicationClass,   // A FormApplication subclass which should be created
-   *   restricted: true                   // Restrict this submenu to gamemaster only?
-   * });
-   * ```
-   */
-  registerMenu<M extends string, K extends string>(
-    module: M,
-    key: K,
-    data: ClientSettings.RegisteredMenuSettings[`${M}.${K}`]
-  ): void;
+    /**
+     * Return a singleton instance of the Game Settings Configuration app
+     */
+    get sheet(): SettingsConfig;
 
-  /**
-   * Get the value of a game setting for a certain module and setting key
-   *
-   * @param module - The module namespace under which the setting is registered
-   * @param key    - The setting key to retrieve
-   * @typeParam M  - The module name to register the get for
-   * @typeParam K  - The key to get the setting for
-   *
-   * @example
-   * ```typescript
-   * // Retrieve the current setting value
-   * game.settings.get("myModule", "myClientSetting");
-   * ```
-   */
-  get<M extends string, K extends string>(module: M, key: K): ClientSettings.Values[`${M}.${K}`];
+    /**
+     * Register a new game setting under this setting scope
+     *
+     * @param module - The namespace under which the setting is registered
+     * @param key    - The key name for the setting under the namespace module
+     * @param data   - Configuration for setting data
+     * @typeParam M  - The module name to register the setting for
+     * @typeParam K  - The key to register the setting for
+     * @typeParam T  - The type of the setting value
+     *
+     * @example
+     * ```typescript
+     * // Register a client setting
+     * game.settings.register("myModule", "myClientSetting", {
+     *   name: "Register a Module Setting with Choices",
+     *   hint: "A description of the registered setting and its behavior.",
+     *   scope: "client",     // This specifies a client-stored setting
+     *   config: true,        // This specifies that the setting appears in the configuration view
+     *   type: String,
+     *   choices: {           // If choices are defined, the resulting setting will be a select menu
+     *     "a": "Option A",
+     *     "b": "Option B"
+     *   },
+     *   default: "a",        // The default value for the setting
+     *   onChange: value => { // A callback function which triggers when the setting is changed
+     *     console.log(value)
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Register a world setting
+     * game.settings.register("myModule", "myWorldSetting", {
+     *   name: "Register a Module Setting with a Range slider",
+     *   hint: "A description of the registered setting and its behavior.",
+     *   scope: "world",      // This specifies a world-level setting
+     *   config: true,        // This specifies that the setting appears in the configuration view
+     *   type: Number,
+     *   range: {             // If range is specified, the resulting setting will be a range slider
+     *     min: 0,
+     *     max: 100,
+     *     step: 10
+     *   }
+     *   default: 50,         // The default value for the setting
+     *   onChange: value => { // A callback function which triggers when the setting is changed
+     *     console.log(value)
+     *   }
+     * });
+     * ```
+     */
+    register<M extends string, K extends string, T>(
+      module: M,
+      key: K,
+      data: ClientSettings.Values[`${M}.${K}`] extends boolean | number | bigint | string | symbol | object
+        ? ClientSettings.PartialSetting<ClientSettings.Values[`${M}.${K}`]>
+        : ClientSettings.PartialSetting<T>
+    ): void;
 
-  /**
-   * Set the value of a game setting for a certain module and setting key
-   *
-   * @param module - The module namespace under which the setting is registered
-   * @param key    - The setting key to retrieve
-   * @param value  - The data to assign to the setting key
-   * @typeParam M  - The module name to register the get for
-   * @typeParam K  - The key to get the setting for
-   * @typeParam V  - The value type to get the value for
-   *
-   * @example
-   * ```typescript
-   * // Update the current value of a setting
-   * game.settings.set("myModule", "myClientSetting", "b");
-   * ```
-   */
-  set<M extends string, K extends string, V extends ClientSettings.Values[`${M}.${K}`]>(
-    module: M,
-    key: K,
-    value: V
-  ): Promise<V>;
-}
+    /**
+     * Register a new sub-settings menu
+     *
+     * @param module - The namespace under which the menu is registered
+     * @param key    - The key name for the setting under the namespace module
+     * @param data   - Configuration for setting data
+     * @typeParam M  - The module name to register the menu setting for
+     * @typeParam K  - The key to register the menu setting for
+     *
+     * @example
+     * ```typescript
+     * // Define a settings submenu which handles advanced configuration needs
+     * game.settings.registerMenu("myModule", "mySettingsMenu", {
+     *   name: "My Settings Submenu",
+     *   label: "Settings Menu Label",      // The text label used in the button
+     *   hint: "A description of what will occur in the submenu dialog.",
+     *   icon: "fas fa-bars",               // A Font Awesome icon used in the submenu button
+     *   type: MySubmenuApplicationClass,   // A FormApplication subclass which should be created
+     *   restricted: true                   // Restrict this submenu to gamemaster only?
+     * });
+     * ```
+     */
+    registerMenu<M extends string, K extends string>(
+      module: M,
+      key: K,
+      data: ClientSettings.RegisteredMenuSettings[`${M}.${K}`]
+    ): void;
 
-declare namespace ClientSettings {
-  interface CompleteSetting<T = unknown> extends PartialSetting<T> {
-    key: string;
-    module: string;
-  }
+    /**
+     * Get the value of a game setting for a certain module and setting key
+     *
+     * @param module - The module namespace under which the setting is registered
+     * @param key    - The setting key to retrieve
+     * @typeParam M  - The module name to register the get for
+     * @typeParam K  - The key to get the setting for
+     *
+     * @example
+     * ```typescript
+     * // Retrieve the current setting value
+     * game.settings.get("myModule", "myClientSetting");
+     * ```
+     */
+    get<M extends string, K extends string>(module: M, key: K): ClientSettings.Values[`${M}.${K}`];
 
-  interface CompleteMenuSetting extends PartialMenuSetting {
-    key: string;
-    module: string;
+    /**
+     * Set the value of a game setting for a certain module and setting key
+     *
+     * @param module - The module namespace under which the setting is registered
+     * @param key    - The setting key to retrieve
+     * @param value  - The data to assign to the setting key
+     * @typeParam M  - The module name to register the get for
+     * @typeParam K  - The key to get the setting for
+     * @typeParam V  - The value type to get the value for
+     *
+     * @example
+     * ```typescript
+     * // Update the current value of a setting
+     * game.settings.set("myModule", "myClientSetting", "b");
+     * ```
+     */
+    set<M extends string, K extends string, V extends ClientSettings.Values[`${M}.${K}`]>(
+      module: M,
+      key: K,
+      value: V
+    ): Promise<V>;
   }
 
-  interface PartialSetting<T = unknown> {
-    choices?: Record<string, string>;
-    config?: boolean;
-    default?: T;
-    hint?: string;
-    name?: string;
-    onChange?: (value: T) => void;
-    range?: T extends number
-      ? {
-          max: number;
-          min: number;
-          step: number;
-        }
-      : undefined;
-    filePicker?: T extends string ? true | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder' : undefined;
-    scope: string;
-    type?: T extends boolean
-      ? typeof Boolean
-      : T extends number
-      ? typeof Number
-      : T extends bigint
-      ? typeof BigInt
-      : T extends string
-      ? typeof String
-      : T extends symbol
-      ? typeof Symbol
-      : ConstructorOf<T>;
-  }
+  namespace ClientSettings {
+    interface CompleteSetting<T = unknown> extends PartialSetting<T> {
+      key: string;
+      module: string;
+    }
 
-  interface PartialMenuSetting {
-    hint?: string;
-    icon?: string;
-    label?: string;
-    name?: string;
-    restricted: boolean;
-    type: ConstructorOf<FormApplication<FormApplicationOptions, object>>;
-  }
+    interface CompleteMenuSetting extends PartialMenuSetting {
+      key: string;
+      module: string;
+    }
 
-  interface RegisteredMenuSettings {
-    [key: string]: PartialMenuSetting;
-  }
+    interface PartialSetting<T = unknown> {
+      choices?: Record<string, string>;
+      config?: boolean;
+      default?: T;
+      hint?: string;
+      name?: string;
+      onChange?: (value: T) => void;
+      range?: T extends number
+        ? {
+            max: number;
+            min: number;
+            step: number;
+          }
+        : undefined;
+      filePicker?: T extends string ? true | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder' : undefined;
+      scope: string;
+      type?: T extends boolean
+        ? typeof Boolean
+        : T extends number
+        ? typeof Number
+        : T extends bigint
+        ? typeof BigInt
+        : T extends string
+        ? typeof String
+        : T extends symbol
+        ? typeof Symbol
+        : ConstructorOf<T>;
+    }
+
+    interface PartialMenuSetting {
+      hint?: string;
+      icon?: string;
+      label?: string;
+      name?: string;
+      restricted: boolean;
+      type: ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
+    }
+
+    interface RegisteredMenuSettings {
+      [key: string]: PartialMenuSetting;
+    }
 
-  interface Values {
-    'core.animateRollTable': boolean;
-    'core.chatBubbles': boolean;
-    'core.chatBubblesPan': boolean;
-    'core.combatTrackerConfig': { resource: string; skipDefeated: boolean } | {};
-    'core.compendiumConfiguration': Partial<Record<string, CompendiumCollection.Configuration>>;
-    'core.coneTemplateType': 'round' | 'flat';
-    'core.defaultDrawingConfig': foundry.data.DrawingData['_source'] | {};
-    'core.globalAmbientVolume': number;
-    'core.globalInterfaceVolume': number;
-    'core.globalPlaylistVolume': number;
-    'core.keybindings': Record<string, KeybindingActionBinding[]>;
-    'core.language': string;
-    'core.leftClickRelease': boolean;
-    'core.lightAnimation': boolean;
-    'core.maxFPS': number;
-    'core.mipmap': boolean;
-    'core.moduleConfiguration': Record<string, boolean>;
-    'core.nue.shownTips': boolean;
-    'core.noCanvas': boolean;
-    'core.permissions': Game.Permissions;
-    'core.rollMode': keyof CONFIG.Dice.RollModes;
-    'core.softShadows': boolean;
-    'core.time': number;
-    'core.tokenDragPreview': boolean;
-    'core.visionAnimation': boolean;
-    [key: string]: unknown;
+    interface Values {
+      'core.animateRollTable': boolean;
+      'core.chatBubbles': boolean;
+      'core.chatBubblesPan': boolean;
+      'core.combatTrackerConfig': { resource: string; skipDefeated: boolean } | {};
+      'core.compendiumConfiguration': Partial<Record<string, CompendiumCollection.Configuration>>;
+      'core.coneTemplateType': 'round' | 'flat';
+      'core.defaultDrawingConfig': foundry.data.DrawingData['_source'] | {};
+      'core.defaultToken': DeepPartial<TokenDataSource>;
+      'core.disableResolutionScaling': boolean;
+      'core.fontSize': number;
+      'core.fpsMeter': boolean;
+      'core.globalAmbientVolume': number;
+      'core.globalInterfaceVolume': number;
+      'core.globalPlaylistVolume': number;
+      'core.keybindings': Record<string, KeybindingActionBinding[]>;
+      'core.language': string;
+      'core.leftClickRelease': boolean;
+      'core.lightAnimation': boolean;
+      'core.maxFPS': number;
+      'core.mipmap': boolean;
+      'core.moduleConfiguration': Record<string, boolean>;
+      'core.noCanvas': boolean;
+      'core.notesDisplayToggle': boolean;
+      'core.nue.shownTips': boolean;
+      'core.performanceMode': boolean;
+      'core.permissions': Game.Permissions;
+      'core.playlist.playingLocation': 'top' | 'bottom';
+      'core.rollMode': keyof CONFIG.Dice.RollModes;
+      'core.rtcClientSettings': typeof AVSettings.DEFAULT_CLIENT_SETTINGS;
+      'core.rtcWorldSettings': typeof AVSettings.DEFAULT_WORLD_SETTINGS;
+      'core.scrollingStatusText': boolean;
+      'core.sheetClasses': {
+        [Key in DocumentType as DocumentSubTypes<Key> extends string ? Key : never]?: Record<
+          DocumentSubTypes<Key> & string,
+          string
+        >;
+      };
+      'core.time': number;
+      'core.tokenDragPreview': boolean;
+      'core.visionAnimation': boolean;
+      [key: string]: unknown;
+    }
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts

@@ -164,7 +164,9 @@ declare global {
      * Provide a dialog form that prompts the user to import the full contents of a Compendium pack into the World.
      * @param options - Additional options passed to the Dialog.confirm method
      *                  (default: `{}`)
-     * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
+     * @returns A promise which resolves in the following ways: an array of imported
+     *          Documents if the "yes" button was pressed, false if the "no" button was pressed, or
+     *          null if the dialog was closed without making a choice.
      */
     importDialog(
       options?: Dialog.Options | undefined

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

@@ -382,6 +382,9 @@ declare global {
 
       /** @defaultValue `Folders` */
       collection: ConstructorOf<Folders>;
+
+      /** @defaultValue `'fas fa-folder'` */
+      sidebarIcon: string;
     };
 
     /**

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

@@ -524,7 +524,7 @@ declare global {
         private: boolean;
         system?: string;
         type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-      };
+      }[];
       scripts: string[];
       styles: string[];
       type: 'world' | 'system' | 'module';

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygon.d.ts

@@ -42,8 +42,9 @@ declare abstract class PointSourcePolygon extends PIXI.Polygon {
   /**
    * A cached array of SightRay objects used to compute the polygon.
    * @defaultValue `[]`
+   * @remarks This is documented as `SightRay[]` but that's only correct for the {@link RadialSweepPolygon}
    */
-  rays: SightRay[];
+  rays: Ray[];
 
   /**
    * Compute the rectangular bounds for the Polygon.
@@ -66,11 +67,12 @@ declare abstract class PointSourcePolygon extends PIXI.Polygon {
    * Compute the polygon given a point origin and radius
    * @param origin - The origin source point
    * @param config - Configuration options which customize the polygon computation
+   *                 (default: `{}`)
    * @returns The computed polygon instance
    */
   static create(
     origin: Point,
-    config: Parameters<PointSourcePolygon['initialize']>[1]
+    config?: Parameters<PointSourcePolygon['initialize']>[1] | undefined
   ): ReturnType<PointSourcePolygon['compute']>;
 
   /**

package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts

@@ -37,13 +37,13 @@ declare global {
      * The minimum ray of emission
      * @defaultValue `Ray.fromAngle(origin.x, origin.y, config.aMin, config.radius)`
      */
-    rMin?: Ray;
+    rMin?: PolygonRay;
 
     /**
      * The maximum ray of emission
      * @defaultValue `config.hasLimitedAngle && Ray.fromAngle(origin.x, origin.y, config.aMax, config.radius)`
      */
-    rMax?: Ray;
+    rMax?: PolygonRay;
 
     /**
      * Does this polygon have a limited radius?
@@ -70,6 +70,10 @@ declare global {
     radiusE?: number;
   }
 
+  interface PolygonRay extends Ray {
+    result: CollisionResult;
+  }
+
   /**
    * A PointSourcePolygon implementation that uses CCW (counter-clockwise) geometry orientation.
    * Sweep around the origin, accumulating collision points based on the set of active walls.
@@ -97,7 +101,7 @@ declare global {
     /**
      * A collection of rays which are fired at vertices
      */
-    rays: SightRay[];
+    rays: PolygonRay[];
 
     static benchmark(
       iterations: number,
@@ -125,7 +129,7 @@ declare global {
      * @returns The ray with rounded vertices
      * @internal
      */
-    protected _roundRayVertices(ray: Ray): Ray;
+    protected _roundRayVertices(ray: PolygonRay): PolygonRay;
 
     /**
      * Translate walls and other obstacles into edges which limit visibility
@@ -194,7 +198,7 @@ declare global {
      * @internal
      */
     protected _isVertexBehindActiveEdges(
-      ray: Ray,
+      ray: PolygonRay,
       vertex: PolygonVertex,
       activeEdges: EdgeSet
     ): { isBehind: boolean; wasLimited: boolean };
@@ -207,7 +211,12 @@ declare global {
      * @param activeEdges - The set of active edges
      * @internal
      */
-    protected _determineRayResult(ray: Ray, vertex: PolygonVertex, result: CollisionResult, activeEdges: EdgeSet): void;
+    protected _determineRayResult(
+      ray: PolygonRay,
+      vertex: PolygonVertex,
+      result: CollisionResult,
+      activeEdges: EdgeSet
+    ): void;
 
     /**
      * Jump to a new closest active edge.
@@ -223,7 +232,7 @@ declare global {
      *                          (default: `true`)
      */
     protected _beginNewEdge(
-      ray: Ray,
+      ray: PolygonRay,
       result: CollisionResult,
       activeEdges: EdgeSet,
       isBinding: boolean,
@@ -241,7 +250,12 @@ declare global {
      * @param activeEdges - The set of currently active edges
      * @param isBinding   - Is the target vertex a binding collision point?
      */
-    protected _completeCurrentEdge(ray: Ray, result: CollisionResult, activeEdges: EdgeSet, isBinding: boolean): void;
+    protected _completeCurrentEdge(
+      ray: PolygonRay,
+      result: CollisionResult,
+      activeEdges: EdgeSet,
+      isBinding: boolean
+    ): void;
 
     /**
      * Augment a CollisionResult with an additional secondary collision.
@@ -251,7 +265,7 @@ declare global {
      * @param edges  - The subset of active edges which are candidates for collision
      * @internal
      */
-    protected _getSecondaryCollisions(ray: Ray, result: CollisionResult, edges: EdgeSet): PolygonVertex[];
+    protected _getSecondaryCollisions(ray: PolygonRay, result: CollisionResult, edges: EdgeSet): PolygonVertex[];
 
     /**
      * Identify collision points for a required terminal ray.
@@ -261,7 +275,7 @@ declare global {
      * @param result      - The pending collision result
      * @param activeEdges - The set of currently active edges
      */
-    protected _findRequiredCollision(ray: Ray, result: CollisionResult, activeEdges: EdgeSet): void;
+    protected _findRequiredCollision(ray: PolygonRay, result: CollisionResult, activeEdges: EdgeSet): void;
 
     /**
      * Identify the collision points between an emitted Ray and a set of active edges.
@@ -271,7 +285,7 @@ declare global {
      * @internal
      */
     protected _getRayCollisions(
-      ray: Ray,
+      ray: PolygonRay,
       activeEdges: EdgeSet,
       {
         minimumDistance
@@ -304,7 +318,7 @@ declare global {
      * @param r1 - The next ray that collides with some vertex
      * @internal
      */
-    protected _getPaddingPoints(r0: Ray, r1: Ray): Point[];
+    protected _getPaddingPoints(r0: PolygonRay, r1: PolygonRay): Point[];
 
     /**
      * Test whether a wall should be included in the computed polygon for a given origin and type
@@ -328,7 +342,7 @@ declare global {
      * @param angle  - The angle being tested, in degrees
      * @returns Is the vertex between the two rays?
      */
-    static pointBetweenRays(vertex: PolygonVertex, rMin: Ray, rMax: Ray, angle: number): boolean;
+    static pointBetweenRays(vertex: PolygonVertex, rMin: PolygonRay, rMax: PolygonRay, angle: number): boolean;
 
     /** @override */
     visualize(): void;
@@ -342,7 +356,7 @@ declare global {
      *          The closest collision, if mode is "closest"
      */
     static getRayCollisions<Mode extends 'any' | 'closest' | 'all'>(
-      ray: Ray,
+      ray: PolygonRay,
       options?: {
         /**
          * Which collision type to check, a value in CONST.WALL_RESTRICTION_TYPES
@@ -368,7 +382,7 @@ declare global {
      * Visualize the polygon, displaying its computed area, rays, and collision points
      * @internal
      */
-    protected static _visualizeCollision(ray: Ray, edges: EdgeSet, collisions: PolygonVertex[]): void;
+    protected static _visualizeCollision(ray: PolygonRay, edges: EdgeSet, collisions: PolygonVertex[]): void;
   }
 
   namespace ClockwiseSweepPolygon {
@@ -385,12 +399,12 @@ declare global {
       rotation: number;
       hasLimitedAngle: boolean;
       density: number;
-      rMin: Ray;
+      rMin: PolygonRay;
     }
 
     interface LimitedAngleConfig extends InitializedConfig {
       hasLimitedAngle: true;
-      rMax: Ray;
+      rMax: PolygonRay;
     }
   }
 }

package/src/foundry/foundry.js/rollTerms/diceTerms/die.d.ts

@@ -207,11 +207,6 @@ declare class Die extends DiceTerm {
 }
 
 declare namespace Die {
-  interface Data extends Partial<TermData> {
-    class: 'Die';
-    results: DiceTerm.Result[];
-  }
-
   interface TermData extends DiceTerm.TermData {
     modifiers: Array<keyof typeof Die['MODIFIERS']>;
   }

package/src/foundry/foundry.js/rollTerms/diceTerms/fateDie.d.ts

@@ -3,7 +3,7 @@
  * Mathematically behaves like 1d3-2
  */
 declare class FateDie extends DiceTerm {
-  constructor(termData?: Partial<DiceTerm.TermData>);
+  constructor(termData?: Partial<FateDie.TermData>);
 
   faces: 3;
 
@@ -12,6 +12,9 @@ declare class FateDie extends DiceTerm {
    */
   static DENOMINATION: string;
 
+  /** @override */
+  static MODIFIERS: FateDie.Modifiers;
+
   /**
    * @override
    */
@@ -22,3 +25,20 @@ declare class FateDie extends DiceTerm {
    */
   getResultLabel(result: DiceTerm.Result): string;
 }
+
+declare namespace FateDie {
+  interface TermData extends DiceTerm.TermData {
+    modifiers: Array<keyof typeof FateDie['MODIFIERS']>;
+  }
+
+  interface Modifiers {
+    r: Die['reroll'];
+    rr: Die['rerollRecursive'];
+    k: Die['keep'];
+    kh: Die['keep'];
+    kl: Die['keep'];
+    d: Die['drop'];
+    dh: Die['drop'];
+    dl: Die['drop'];
+  }
+}

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

@@ -5,13 +5,6 @@
 declare class VideoHelper {
   constructor();
 
-  /**
-   * A collection of HTML5 video objects which are currently active within the FVTT page
-   * @defaultValue `[]`
-   * @remarks This seems to be unused.
-   */
-  videos: HTMLVideoElement[];
-
   /**
    * A user gesture must be registered before video playback can begin.
    * This Set records the video elements which await such a gesture.

package/src/types/helperTypes.d.ts

@@ -103,6 +103,12 @@ export type PlaceableDocumentType =
   | 'Token'
   | 'Wall';
 
+export type DocumentSubTypes<T extends DocumentType> = 'type' extends keyof InstanceType<
+  ConfiguredDocumentClassForName<T>
+>['data']
+  ? InstanceType<ConfiguredDocumentClassForName<T>>['data']['type']
+  : typeof foundry.CONST.BASE_DOCUMENT_TYPE;
+
 export type ConfiguredDocumentClassForName<Name extends DocumentType> = CONFIG[Name]['documentClass'];
 
 export type ConfiguredObjectClassForName<Name extends PlaceableDocumentType> = CONFIG[Name]['objectClass'];