@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/common/constants.d.mts

@@ -1,4 +1,4 @@
-import type { Brand, ValueOf } from "fvtt-types/utils";
+import type { Brand, DeepReadonly, Identity, ValueOf } from "#utils";
 
 /**
  * The shortened software name
@@ -32,8 +32,8 @@ export const ASCII = `__________________________________________________________
 ===============================================================`;
 
 /**
- * Define the allowed ActiveEffect application modes
- * @remarks (by Foundry) Other arbitrary mode numbers can be used by systems and modules to identify special behaviors and are ignored
+ * Define the allowed ActiveEffect application modes.
+ * Other arbitrary mode numbers can be used by systems and modules to identify special behaviors and are ignored
  */
 export declare const ACTIVE_EFFECT_MODES: Readonly<{
   /**
@@ -88,33 +88,34 @@ export type ACTIVE_EFFECT_MODES = Brand<number, "constants.ACTIVE_EFFECT_MODES">
  * Define the string name used for the base document type when specific sub-types are not defined by the system
  */
 export declare const BASE_DOCUMENT_TYPE: "base";
+export type BASE_DOCUMENT_TYPE = typeof BASE_DOCUMENT_TYPE;
 
 /**
  * Define the methods by which a Card can be drawn from a Cards stack
- * TOP and FIRST are synonymous, as are BOTTOM and LAST.
+ * @remarks `TOP` and `FIRST` are synonymous, as are `BOTTOM` and `LAST`.
  */
 export declare const CARD_DRAW_MODES: Readonly<{
   /**
    * Draw the first card from the stack
-   * Synonymous with @see CARD_DRAW_MODES.TOP
+   * Synonymous with {@linkcode CARD_DRAW_MODES.TOP}
    */
   FIRST: 0 & CARD_DRAW_MODES;
 
   /**
    * Draw the top card from the stack
-   * Synonymous with @see CARD_DRAW_MODES.FIRST
+   * Synonymous with {@linkcode CARD_DRAW_MODES.FIRST}
    */
   TOP: 0 & CARD_DRAW_MODES;
 
   /**
    * Draw the last card from the stack
-   * Synonymous with @see CARD_DRAW_MODES.BOTTOM
+   * Synonymous with {@linkcode CARD_DRAW_MODES.BOTTOM}
    */
   LAST: 1 & CARD_DRAW_MODES;
 
   /**
    * Draw the bottom card from the stack
-   * Synonymous with @see CARD_DRAW_MODES.LAST
+   * Synonymous with {@linkcode CARD_DRAW_MODES.LAST}
    */
   BOTTOM: 1 & CARD_DRAW_MODES;
 
@@ -163,16 +164,15 @@ export declare const CHAT_MESSAGE_STYLES: Readonly<{
   EMOTE: 3 & CHAT_MESSAGE_STYLES;
 
   /**
-   * @deprecated since v12
-   *
-   * @remarks Define rolls directly in ChatMessage#rolls instead.
+   * @deprecated "`CONST.CHAT_MESSAGE_STYLES.ROLL` is deprecated in favor of defining rolls directly in
+   * {@linkcode ChatMessage.rolls | ChatMessage#rolls}" (since v12, until v14)
    */
   ROLL: 0 & CHAT_MESSAGE_STYLES;
 
   /**
-   * @deprecated since v12
-   *
-   * @remarks Define whispers directly in ChatMessage#whisper instead.
+   * @deprecated "`CONST.CHAT_MESSAGE_STYLES.Whisper` is deprecated in favor of defining whisper recipients
+   * directly in {@linkcode ChatMessage.whisper | ChatMessage#whisper}"
+   * (since v12, until v14)
    */
   WHISPER: 0 & CHAT_MESSAGE_STYLES;
 }>;
@@ -182,6 +182,7 @@ export type CHAT_MESSAGE_STYLES = Brand<number, "constants.CHAT_MESSAGE_STYLES">
  * Define the set of languages which have built-in support in the core software
  */
 export declare const CORE_SUPPORTED_LANGUAGES: readonly ["en"];
+export type CORE_SUPPORTED_LANGUAGES = ValueOf<typeof CORE_SUPPORTED_LANGUAGES>;
 
 /**
  * Configure the severity of compatibility warnings.
@@ -209,6 +210,21 @@ export declare const COMPATIBILITY_MODES: Readonly<{
 }>;
 export type COMPATIBILITY_MODES = Brand<number, "constants.COMPATIBILITY_MODES">;
 
+/**
+ * Configure custom cursor images to use when interacting with the application.
+ */
+export declare const CURSOR_STYLES: Readonly<{
+  default: "default";
+  "default-down": "default";
+  pointer: "pointer";
+  "pointer-down": "pointer";
+  grab: "grab";
+  "grab-down": "grabbing";
+  text: "text";
+  "text-down": "text";
+}>;
+export type CURSOR_STYLES = keyof typeof CURSOR_STYLES;
+
 /**
  * The lighting illumination levels which are supported.
  */
@@ -236,6 +252,7 @@ export type CSS_THEMES = ValueOf<typeof CSS_THEMES>;
  * The default artwork used for Token images if none is provided
  */
 export declare const DEFAULT_TOKEN: "icons/svg/mystery-man.svg";
+export type DEFAULT_TOKEN = typeof DEFAULT_TOKEN;
 
 /**
  * Define the allowed Document class types.
@@ -269,8 +286,10 @@ export const EMBEDDED_DOCUMENT_TYPES: readonly [
   "AmbientSound",
   "Card",
   "Combatant",
+  "CombatantGroup",
   "Drawing",
   "Item",
+  "JournalEntryCategory",
   "JournalEntryPage",
   "MeasuredTemplate",
   "Note",
@@ -287,7 +306,7 @@ export type EMBEDDED_DOCUMENT_TYPES = ValueOf<typeof EMBEDDED_DOCUMENT_TYPES>;
 /**
  * A listing of all valid Document types, both primary and embedded.
  */
-export const ALL_DOCUMENT_TYPES: ALL_DOCUMENT_TYPES[];
+export const ALL_DOCUMENT_TYPES: readonly ALL_DOCUMENT_TYPES[];
 export type ALL_DOCUMENT_TYPES = PRIMARY_DOCUMENT_TYPES | EMBEDDED_DOCUMENT_TYPES;
 
 /**
@@ -331,7 +350,7 @@ export type COMPENDIUM_DOCUMENT_TYPES = ValueOf<typeof COMPENDIUM_DOCUMENT_TYPES
  * Define the allowed ownership levels for a Document.
  * Each level is assigned a value in ascending order.
  * Higher levels grant more permissions.
- * @see https://foundryvtt.com/article/users/
+ * @see {@link https://foundryvtt.com/article/users/}
  */
 export declare const DOCUMENT_OWNERSHIP_LEVELS: Readonly<{
   /**
@@ -345,7 +364,8 @@ export declare const DOCUMENT_OWNERSHIP_LEVELS: Readonly<{
   NONE: 0 & DOCUMENT_OWNERSHIP_LEVELS;
 
   /**
-   * Allows the User to interact with the Document in basic ways, allowing them to see it in sidebars and see only limited aspects of its contents. The limits of this interaction are defined by the game system being used.
+   * Allows the User to interact with the Document in basic ways, allowing them to see it in sidebars and see only limited aspects of its contents.
+   * The limits of this interaction are defined by the game system being used.
    */
   LIMITED: 1 & DOCUMENT_OWNERSHIP_LEVELS;
 
@@ -387,7 +407,7 @@ export type DOCUMENT_LINK_TYPES = ValueOf<typeof DOCUMENT_LINK_TYPES>;
 
 /**
  * The supported dice roll visibility modes
- * @see https://foundryvtt.com/article/dice/
+ * @see {@link https://foundryvtt.com/article/dice/}
  */
 export declare const DICE_ROLL_MODES: Readonly<{
   /**
@@ -401,7 +421,7 @@ export declare const DICE_ROLL_MODES: Readonly<{
   PRIVATE: "gmroll";
 
   /**
-   * A private dice roll only visible to Game Master users. The rolling player will not see the result of their own roll.
+   * A private dice roll only visible to Gamemaster users. The rolling player will not see the result of their own roll.
    */
   BLIND: "blindroll";
 
@@ -414,7 +434,7 @@ export type DICE_ROLL_MODES = ValueOf<typeof DICE_ROLL_MODES>;
 
 /**
  * The allowed fill types which a Drawing object may display
- * @see https://foundryvtt.com/article/drawings/
+ * @see {@link https://foundryvtt.com/article/drawings/}
  */
 export declare const DRAWING_FILL_TYPES: Readonly<{
   /**
@@ -453,6 +473,7 @@ export type FOLDER_DOCUMENT_TYPES = ValueOf<typeof FOLDER_DOCUMENT_TYPES>;
 
 /**
  * The maximum allowed level of depth for Folder nesting
+ * @defaultValue `4`
  */
 export declare const FOLDER_MAX_DEPTH: number;
 
@@ -460,6 +481,7 @@ export declare const FOLDER_MAX_DEPTH: number;
  * A list of allowed game URL names
  */
 export declare const GAME_VIEWS: readonly ["game", "stream"];
+export type GAME_VIEWS = ValueOf<typeof GAME_VIEWS>;
 
 /**
  * The directions of movement.
@@ -469,21 +491,30 @@ export declare const MOVEMENT_DIRECTIONS: Readonly<{
   DOWN: 0x2 & MOVEMENT_DIRECTIONS;
   LEFT: 0x4 & MOVEMENT_DIRECTIONS;
   RIGHT: 0x8 & MOVEMENT_DIRECTIONS;
+
+  /** @remarks `0x1 | 0x4` */
   UP_LEFT: 0x5 & MOVEMENT_DIRECTIONS;
+
+  /** @remarks `0x1 | 0x8` */
   UP_RIGHT: 0x9 & MOVEMENT_DIRECTIONS;
+
+  /** @remarks `0x2 | 0x4` */
   DOWN_LEFT: 0x6 & MOVEMENT_DIRECTIONS;
+
+  /** @remarks `0x2 | 0x8` */
   DOWN_RIGHT: 0xa & MOVEMENT_DIRECTIONS;
 }>;
 export type MOVEMENT_DIRECTIONS = Brand<number, "constants.MOVEMENT_DIRECTIONS">;
 
 /**
  * The minimum allowed grid size which is supported by the software
+ * @defaultValue `20`
  */
 export declare const GRID_MIN_SIZE: number;
 
 /**
  * The allowed Grid types which are supported by the software
- * @see https://foundryvtt.com/article/scenes/
+ * @see {@link https://foundryvtt.com/article/scenes/}
  */
 export declare const GRID_TYPES: Readonly<{
   /**
@@ -520,7 +551,8 @@ export type GRID_TYPES = Brand<number, "constants.GRID_TYPES">;
 
 /**
  * The different rules to define and measure diagonal distance/cost in a square grid.
- * The description of each option refers to the distance/cost of moving diagonally relative to the distance/cost of a horizontal or vertical move.
+ * The description of each option refers to the distance/cost of moving diagonally relative to the distance/cost of a
+ * horizontal or vertical move.
  */
 export declare const GRID_DIAGONALS: Readonly<{
   /**
@@ -664,6 +696,7 @@ export type GRID_SNAPPING_MODES = Brand<number, "constants.GRID_SNAPPING_MODES">
  * A list of supported setup URL names
  */
 export declare const SETUP_VIEWS: readonly ["auth", "license", "setup", "players", "join", "update"];
+export type SETUP_VIEWS = ValueOf<typeof SETUP_VIEWS>;
 
 /**
  * An Array of valid MacroAction scope values
@@ -673,7 +706,7 @@ export type MACRO_SCOPES = ValueOf<typeof MACRO_SCOPES>;
 
 /**
  * An enumeration of valid Macro types
- * @see https://foundryvtt.com/article/macros/
+ * @see {@link https://foundryvtt.com/article/macros/}
  */
 export declare const MACRO_TYPES: Readonly<{
   /**
@@ -700,7 +733,7 @@ export type AUDIO_CHANNELS = ValueOf<typeof AUDIO_CHANNELS>;
 
 /**
  * The allowed playback modes for an audio Playlist
- * @see https://foundryvtt.com/article/playlists/
+ * @see {@link https://foundryvtt.com/article/playlists/}
  */
 export declare const PLAYLIST_MODES: Readonly<{
   /**
@@ -728,7 +761,7 @@ export type PLAYLIST_MODES = Brand<number, "constants.PLAYLIST_MODES">;
 /**
  * The available sort modes for an audio Playlist.
  * @defaultValue `"a"`
- * @see https://foundryvtt.com/article/playlists/
+ * @see {@link https://foundryvtt.com/article/playlists/}
  */
 export declare const PLAYLIST_SORT_MODES: Readonly<{
   /**
@@ -853,12 +886,13 @@ export type SOFTWARE_UPDATE_CHANNELS = ValueOf<typeof SOFTWARE_UPDATE_CHANNELS>;
 
 /**
  * The default sorting density for manually ordering child objects within a parent
+ * @defaultValue `100000`
  */
 export declare const SORT_INTEGER_DENSITY: number;
 
 /**
  * The allowed types of a TableResult document
- * @see https://foundryvtt.com/article/roll-tables/
+ * @see {@link https://foundryvtt.com/article/roll-tables/}
  */
 export declare const TABLE_RESULT_TYPES: Readonly<{
   /**
@@ -873,14 +907,16 @@ export declare const TABLE_RESULT_TYPES: Readonly<{
 
   /**
    * A Compendium Pack reference which will be linked to in the chat message.
+   * @deprecated "`CONST.TABLE_RESULT_TYPES.COMPENDIUM` is is deprecated in favor of {@linkcode CONST.TABLE_RESULT_TYPES.DOCUMENT}
+   * due to the "compendium" being merged with the "document" type." (since v13, until v15)
    */
-  COMPENDIUM: "pack";
+  get COMPENDIUM(): "pack";
 }>;
 export type TABLE_RESULT_TYPES = ValueOf<typeof TABLE_RESULT_TYPES>;
 
 /**
  * The allowed formats of a Journal Entry Page.
- * @see https://foundryvtt.com/article/journal/
+ * @see {@link https://foundryvtt.com/article/journal/}
  */
 export declare const JOURNAL_ENTRY_PAGE_FORMATS: Readonly<{
   /**
@@ -897,7 +933,7 @@ export type JOURNAL_ENTRY_PAGE_FORMATS = Brand<number, "constants.JOURNAL_ENTRY_
 
 /**
  * Define the valid anchor locations for a Tooltip displayed on a Placeable Object
- * @see TooltipManager
+ * @see {@linkcode foundry.helpers.interaction.TooltipManager}
  */
 export declare const TEXT_ANCHOR_POINTS: Readonly<{
   /**
@@ -929,8 +965,8 @@ export type TEXT_ANCHOR_POINTS = Brand<number, "constants.TEXT_ANCHOR_POINTS">;
 
 /**
  * Define the valid occlusion modes which a tile can use
- * @defaultValue `1`
- * @see https://foundryvtt.com/article/tiles/
+ * @remarks Foundry leaves a comment in the middle of the object: "// ROOF: 2;  This mode is no longer supported so we don't use 2 for any other mode"
+ * @see {@link https://foundryvtt.com/article/tiles/}
  */
 export declare const OCCLUSION_MODES: Readonly<{
   /**
@@ -944,8 +980,6 @@ export declare const OCCLUSION_MODES: Readonly<{
    */
   FADE: 1 & OCCLUSION_MODES;
 
-  // ROOF: 2;  This mode is no longer supported so we don't use 2 for any other mode
-
   /**
    * Causes the tile to reveal the background in the vicinity of an actor token under it. The radius is determined by the token's size.
    */
@@ -953,7 +987,7 @@ export declare const OCCLUSION_MODES: Readonly<{
 
   /**
    * Causes the tile to be partially revealed based on the vision of the actor, which does not need to be under the tile to see what's beneath it.
-   * @remarks (by Foundry) This is useful for rooves on buildings where players could see through a window or door, viewing only a portion of what is obscured by the roof itself.
+   * This is useful for roofs on buildings where players could see through a window or door, viewing only a portion of what is obscured by the roof itself.
    */
   VISION: 4 & OCCLUSION_MODES;
 }>;
@@ -961,9 +995,31 @@ export type OCCLUSION_MODES = Brand<number, "constants.OCCLUSION_MODES">;
 
 /**
  * Alias for old tile occlusion modes definition
+ * @remarks Foundry leaves a comment in the middle of the object: "// ROOF: 2;  This mode is no longer supported so we don't use 2 for any other mode"
+ * @privateRemarks Foundry just does `export const TILE_OCCLUSION_MODES = OCCLUSION_MODES` but we have to be un-DRY if we want a different brand
  */
 export declare const TILE_OCCLUSION_MODES: {
-  [K in keyof typeof OCCLUSION_MODES]: TILE_OCCLUSION_MODES;
+  /**
+   * Turns off occlusion, making the tile never fade while tokens are under it.
+   */
+  NONE: 0 & TILE_OCCLUSION_MODES;
+
+  /**
+   * Causes the whole tile to fade when an actor token moves under it.
+   * @defaultValue
+   */
+  FADE: 1 & TILE_OCCLUSION_MODES;
+
+  /**
+   * Causes the tile to reveal the background in the vicinity of an actor token under it. The radius is determined by the token's size.
+   */
+  RADIAL: 3 & TILE_OCCLUSION_MODES;
+
+  /**
+   * Causes the tile to be partially revealed based on the vision of the actor, which does not need to be under the tile to see what's beneath it.
+   * This is useful for roofs on buildings where players could see through a window or door, viewing only a portion of what is obscured by the roof itself.
+   */
+  VISION: 4 & TILE_OCCLUSION_MODES;
 };
 export type TILE_OCCLUSION_MODES = Brand<number, "constants.TILE_OCCLUSION_MODES">;
 
@@ -1000,7 +1056,7 @@ export type TOKEN_OCCLUSION_MODES = Brand<number, "constants.TOKEN_OCCLUSION_MOD
 
 /**
  * Describe the various thresholds of token control upon which to show certain pieces of information
- * @see https://foundryvtt.com/article/tokens/
+ * @see {@link https://foundryvtt.com/article/tokens/}
  */
 export declare const TOKEN_DISPLAY_MODES: Readonly<{
   /**
@@ -1037,7 +1093,7 @@ export type TOKEN_DISPLAY_MODES = Brand<number, "constants.TOKEN_DISPLAY_MODES">
 
 /**
  * The allowed Token disposition types
- * @see https://foundryvtt.com/article/tokens/
+ * @see {@link https://foundryvtt.com/article/tokens/}
  */
 export declare const TOKEN_DISPOSITIONS: Readonly<{
   /**
@@ -1063,45 +1119,66 @@ export declare const TOKEN_DISPOSITIONS: Readonly<{
 export type TOKEN_DISPOSITIONS = Brand<number, "constants.TOKEN_DISPOSITIONS">;
 
 /**
- * The possible shapes of Tokens in hexagonal grids.
+ * The allowed token turn markers modes.
+ */
+export declare const TOKEN_TURN_MARKER_MODES: Readonly<{
+  /**
+   * The turn marker is disabled for this token.
+   */
+  DISABLED: 0 & TOKEN_TURN_MARKER_MODES;
+
+  /**
+   * The turn marker for this token is using the combat tracker settings (which could be disabled).
+   */
+  DEFAULT: 1 & TOKEN_TURN_MARKER_MODES;
+
+  /**
+   * The turn marker is using the token settings (unless the combat tracker turn marker setting is disabled)
+   */
+  CUSTOM: 2 & TOKEN_TURN_MARKER_MODES;
+}>;
+export type TOKEN_TURN_MARKER_MODES = Brand<number, "constants.TOKEN_TURN_MARKER_MODES">;
+
+/**
+ * The possible shapes of Tokens.
  */
-export declare const TOKEN_HEXAGONAL_SHAPES: Readonly<{
+export declare const TOKEN_SHAPES: Readonly<{
   /**
    * Ellipse (Variant 1)
    */
-  ELLIPSE_1: 0 & TOKEN_HEXAGONAL_SHAPES;
+  ELLIPSE_1: 0 & TOKEN_SHAPES;
 
   /**
    * Ellipse (Variant 2)
    */
-  ELLIPSE_2: 1 & TOKEN_HEXAGONAL_SHAPES;
+  ELLIPSE_2: 1 & TOKEN_SHAPES;
 
   /**
    * Trapezoid (Variant 1)
    */
-  TRAPEZOID_1: 2 & TOKEN_HEXAGONAL_SHAPES;
+  TRAPEZOID_1: 2 & TOKEN_SHAPES;
 
   /**
    * Trapezoid (Variant 2)
    */
-  TRAPEZOID_2: 3 & TOKEN_HEXAGONAL_SHAPES;
+  TRAPEZOID_2: 3 & TOKEN_SHAPES;
 
   /**
    * Rectangle (Variant 1)
    */
-  RECTANGLE_1: 4 & TOKEN_HEXAGONAL_SHAPES;
+  RECTANGLE_1: 4 & TOKEN_SHAPES;
 
   /**
    * Rectangle (Variant 2)
    */
-  RECTANGLE_2: 5 & TOKEN_HEXAGONAL_SHAPES;
+  RECTANGLE_2: 5 & TOKEN_SHAPES;
 }>;
-export type TOKEN_HEXAGONAL_SHAPES = Brand<number, "constants.TOKEN_HEXAGONAL_SHAPES">;
+export type TOKEN_SHAPES = Brand<number, "constants.TOKEN_SHAPES">;
 
 /**
  * Define the allowed User permission levels.
  * Each level is assigned a value in ascending order. Higher levels grant more permissions.
- * @see https://foundryvtt.com/article/users/
+ * @see {@link https://foundryvtt.com/article/users/}
  */
 export declare const USER_ROLES: Readonly<{
   /**
@@ -1112,23 +1189,27 @@ export declare const USER_ROLES: Readonly<{
 
   /**
    * The User is able to join the game with permissions available to a standard player.
-   * They cannot take some more advanced actions which require Trusted permissions, but they have the basic functionalities needed to operate in the virtual tabletop.
+   * They cannot take some more advanced actions which require Trusted permissions, but they have the basic
+   * functionalities needed to operate in the virtual tabletop.
    */
   PLAYER: 1 & USER_ROLES;
 
   /**
-   * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions like create drawings, measured templates, or even to (optionally) upload media files to the server.
+   * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions
+   * like create drawings, measured templates, or even to (optionally) upload media files to the server.
    */
   TRUSTED: 2 & USER_ROLES;
 
   /**
-   * A special User who has many of the same in-game controls as a Game Master User, but does not have the ability to perform administrative actions like changing User roles or modifying World-level settings.
+   * A special User who has many of the same in-game controls as a Game Master User, but does not have the ability
+   * to perform administrative actions like changing User roles or modifying World-level settings.
    */
   ASSISTANT: 3 & USER_ROLES;
 
   /**
    * A special User who has administrative control over this specific World.
-   * Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
+   * Game Masters behave quite differently than Players in that they have the ability to see all Documents and
+   * Objects within the world as well as the capability to configure World settings.
    */
   GAMEMASTER: 4 & USER_ROLES;
 }>;
@@ -1146,23 +1227,27 @@ export declare const USER_ROLE_NAMES: Readonly<{
 
   /**
    * The User is able to join the game with permissions available to a standard player.
-   * They cannot take some more advanced actions which require Trusted permissions, but they have the basic functionalities needed to operate in the virtual tabletop.
+   * They cannot take some more advanced actions which require Trusted permissions, but they have the basic
+   * functionalities needed to operate in the virtual tabletop.
    */
   "1": "PLAYER";
 
   /**
-   * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions like create drawings, measured templates, or even to (optionally) upload media files to the server.
+   * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions
+   * like create drawings, measured templates, or even to (optionally) upload media files to the server.
    */
   "2": "TRUSTED";
 
   /**
-   * A special User who has many of the same in-game controls as a Game Master User, but does not have the ability to perform administrative actions like changing User roles or modifying World-level settings.
+   * A special User who has many of the same in-game controls as a Game Master User, but does not have the
+   * ability to perform administrative actions like changing User roles or modifying World-level settings.
    */
   "3": "ASSISTANT";
 
   /**
    * A special User who has administrative control over this specific World.
-   * Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
+   * Game Masters behave quite differently than Players in that they have the ability to see all Documents
+   * and Objects within the world as well as the capability to configure World settings.
    */
   "4": "GAMEMASTER";
 }>;
@@ -1170,7 +1255,7 @@ export type USER_ROLE_NAMES = ValueOf<typeof USER_ROLE_NAMES>;
 
 /**
  * An enumeration of the allowed types for a MeasuredTemplate embedded document
- * @see https://foundryvtt.com/article/measurement/
+ * @see {@link https://foundryvtt.com/article/measurement/}
  */
 export declare const MEASURED_TEMPLATE_TYPES: Readonly<{
   /**
@@ -1205,7 +1290,7 @@ export interface UserPermission {
 /**
  * Define the recognized User capabilities which individual Users or role levels may be permitted to perform
  */
-export declare const USER_PERMISSIONS: Readonly<{
+export declare const USER_PERMISSIONS: DeepReadonly<{
   /**
    * @defaultValue
    * ```typescript
@@ -1505,11 +1590,25 @@ export declare const USER_PERMISSIONS: Readonly<{
    * ```
    */
   WALL_DOORS: UserPermission;
+
+  /**
+   * @defaultValue
+   * ```ts
+   * {
+   *   label: "PERMISSION.QueryUser",
+   *   hint: "PERMISSION.QueryUserHint",
+   *   disableGM: false,
+   *   defaultRole: USER_ROLES.PLAYER
+   * }
+   * ```
+   */
+  QUERY_USER: UserPermission;
 }>;
+export type USER_PERMISSIONS = keyof typeof USER_PERMISSIONS;
 
 /**
  * The allowed directions of effect that a Wall can have
- * @see https://foundryvtt.com/article/walls/
+ * @see {@link https://foundryvtt.com/article/walls/}
  */
 export declare const WALL_DIRECTIONS: Readonly<{
   /**
@@ -1531,7 +1630,7 @@ export type WALL_DIRECTIONS = Brand<number, "constants.WALL_DIRECTIONS">;
 
 /**
  * The allowed door types which a Wall may contain
- * @see https://foundryvtt.com/article/walls/
+ * @see {@link https://foundryvtt.com/article/walls/}
  */
 export declare const WALL_DOOR_TYPES: Readonly<{
   /**
@@ -1553,7 +1652,7 @@ export type WALL_DOOR_TYPES = Brand<number, "constants.WALL_DOOR_TYPES">;
 
 /**
  * The allowed door states which may describe a Wall that contains a door
- * @see https://foundryvtt.com/article/walls/
+ * @see {@link https://foundryvtt.com/article/walls/}
  */
 export declare const WALL_DOOR_STATES: Readonly<{
   /**
@@ -1576,7 +1675,7 @@ export type WALL_DOOR_STATES = Brand<number, "constants.WALL_DOOR_STATES">;
 /**
  * The possible ways to interact with a door
  */
-export declare const WALL_DOOR_INTERACTIONS: ["open", "close", "lock", "unlock", "test"];
+export declare const WALL_DOOR_INTERACTIONS: readonly ["open", "close", "lock", "unlock", "test"];
 export type WALL_DOOR_INTERACTIONS = ValueOf<typeof WALL_DOOR_INTERACTIONS>;
 
 /**
@@ -1587,7 +1686,7 @@ export type WALL_RESTRICTION_TYPES = ValueOf<typeof WALL_RESTRICTION_TYPES>;
 
 /**
  * The types of sensory collision which a Wall may impose
- * @see https://foundryvtt.com/article/walls/
+ * @see {@link https://foundryvtt.com/article/walls/}
  */
 export declare const WALL_SENSE_TYPES: Readonly<{
   /**
@@ -1619,24 +1718,25 @@ export type WALL_SENSE_TYPES = Brand<number, "constants.WALL_SENSE_TYPES">;
 
 /**
  * The types of movement collision which a Wall may impose
- * @see https://foundryvtt.com/article/walls/
+ * @see {@link https://foundryvtt.com/article/walls/}
+ * @privateRemarks Foundry just does `NONE: WALL_SENSE_TYPES.NONE` etc but we want to have a separate brand
  */
 export declare const WALL_MOVEMENT_TYPES: Readonly<{
   /**
    * Movement does not collide with this wall.
    */
-  NONE: typeof WALL_SENSE_TYPES.NONE;
+  NONE: 0 & WALL_MOVEMENT_TYPES;
 
   /**
    * Movement collides with this wall.
    */
-  NORMAL: typeof WALL_SENSE_TYPES.NORMAL;
+  NORMAL: 20 & WALL_MOVEMENT_TYPES;
 }>;
-export type WALL_MOVEMENT_TYPES = ValueOf<typeof WALL_MOVEMENT_TYPES>;
+export type WALL_MOVEMENT_TYPES = Brand<number, "constants.WALL_MOVEMENT_TYPES">;
 
 /**
  * The possible precedence values a Keybinding might run in
- * @see https://foundryvtt.com/article/keybinds/
+ * @see {@link https://foundryvtt.com/article/keybinds/}
  */
 export declare const KEYBINDING_PRECEDENCE: Readonly<{
   /**
@@ -1656,45 +1756,54 @@ export declare const KEYBINDING_PRECEDENCE: Readonly<{
 }>;
 export type KEYBINDING_PRECEDENCE = Brand<number, "constants.KEYBINDING_PRECEDENCE">;
 
+/**
+ * Directories in the public storage path.
+ */
+export const FILE_PICKER_PUBLIC_DIRS: readonly ["cards", "css", "fonts", "icons", "lang", "scripts", "sounds", "ui"];
+export type FILE_PICKER_PUBLIC_DIRS = ValueOf<typeof FILE_PICKER_PUBLIC_DIRS>;
+
 /**
  * The allowed set of HTML template extensions
  */
-export declare const HTML_FILE_EXTENSIONS: readonly ["html", "handlebars", "hbs"];
-export declare type HTML_FILE_EXTENSIONS = ValueOf<typeof HTML_FILE_EXTENSIONS>;
+export declare const HTML_FILE_EXTENSIONS: Readonly<{
+  handlebars: "text/x-handlebars-template";
+  hbs: "text/x-handlebars-template";
+  html: "text/html";
+}>;
+export declare type HTML_FILE_EXTENSIONS = keyof typeof HTML_FILE_EXTENSIONS;
 
-interface _IMAGE_FILE_EXTENSIONS {
+/**
+ * The supported file extensions for image-type files, and their corresponding mime types.
+ */
+export declare const IMAGE_FILE_EXTENSIONS: Readonly<{
   apng: "image/apng";
   avif: "image/avif";
   bmp: "image/bmp";
   gif: "image/gif";
-  jpg: "image/jpeg";
   jpeg: "image/jpeg";
+  jpg: "image/jpeg";
   png: "image/png";
   svg: "image/svg+xml";
   tiff: "image/tiff";
   webp: "image/webp";
-}
+}>;
+export type IMAGE_FILE_EXTENSIONS = keyof typeof IMAGE_FILE_EXTENSIONS;
 
 /**
- * The supported file extensions for image-type files, and their corresponding mime types.
+ * The supported file extensions for video-type files, and their corresponding mime types.
  */
-export declare const IMAGE_FILE_EXTENSIONS: Readonly<_IMAGE_FILE_EXTENSIONS>;
-export type IMAGE_FILE_EXTENSIONS = ValueOf<_IMAGE_FILE_EXTENSIONS>;
-
-interface _VIDEO_FILE_EXTENSIONS {
+export declare const VIDEO_FILE_EXTENSIONS: Readonly<{
   m4v: "video/mp4";
   mp4: "video/mp4";
-  ogg: "video/ogg";
+  ogv: "video/ogg";
   webm: "video/webm";
-}
+}>;
+export type VIDEO_FILE_EXTENSIONS = keyof typeof VIDEO_FILE_EXTENSIONS;
 
 /**
- * The supported file extensions for video-type files, and their corresponding mime types.
+ * The supported file extensions for audio-type files, and their corresponding mime types.
  */
-export declare const VIDEO_FILE_EXTENSIONS: Readonly<_VIDEO_FILE_EXTENSIONS>;
-export type VIDEO_FILE_EXTENSIONS = ValueOf<_VIDEO_FILE_EXTENSIONS>;
-
-interface _AUDIO_FILE_EXTENSIONS {
+export declare const AUDIO_FILE_EXTENSIONS: Readonly<{
   aac: "audio/aac";
   flac: "audio/flac";
   m4a: "audio/mp4";
@@ -1704,14 +1813,13 @@ interface _AUDIO_FILE_EXTENSIONS {
   opus: "audio/opus";
   wav: "audio/wav";
   webm: "audio/webm";
-}
+}>;
+export type AUDIO_FILE_EXTENSIONS = keyof typeof AUDIO_FILE_EXTENSIONS;
+
 /**
- * The supported file extensions for audio-type files, and their corresponding mime types.
+ * The supported file extensions for text files, and their corresponding mime types.
  */
-export declare const AUDIO_FILE_EXTENSIONS: Readonly<_AUDIO_FILE_EXTENSIONS>;
-export type AUDIO_FILE_EXTENSIONS = ValueOf<_AUDIO_FILE_EXTENSIONS>;
-
-interface _TEXT_FILE_EXTENSIONS {
+export declare const TEXT_FILE_EXTENSIONS: Readonly<{
   csv: "text/csv";
   json: "application/json";
   md: "text/markdown";
@@ -1721,26 +1829,24 @@ interface _TEXT_FILE_EXTENSIONS {
   xml: "application/xml";
   yml: "application/yaml";
   yaml: "application/yaml";
-}
+}>;
+export type TEXT_FILE_EXTENSIONS = keyof typeof TEXT_FILE_EXTENSIONS;
+
 /**
- * The supported file extensions for text files, and their corresponding mime types.
+ * Supported file extensions for font files, and their corresponding mime types.
  */
-export declare const TEXT_FILE_EXTENSIONS: Readonly<_TEXT_FILE_EXTENSIONS>;
-export type TEXT_FILE_EXTENSIONS = ValueOf<_TEXT_FILE_EXTENSIONS>;
-
-interface _FONT_FILE_EXTENSIONS {
-  ttf: "font/ttf";
+export declare const FONT_FILE_EXTENSIONS: Readonly<{
   otf: "font/otf";
+  ttf: "font/ttf";
   woff: "font/woff";
   woff2: "font/woff2";
-}
+}>;
+export type FONT_FILE_EXTENSIONS = keyof typeof FONT_FILE_EXTENSIONS;
+
 /**
- * Supported file extensions for font files, and their corresponding mime types.
+ * Supported file extensions for 3D files, and their corresponding mime types.
  */
-export declare const FONT_FILE_EXTENSIONS: Readonly<_FONT_FILE_EXTENSIONS>;
-export type FONT_FILE_EXTENSIONS = ValueOf<_FONT_FILE_EXTENSIONS>;
-
-interface _GRAPHICS_FILE_EXTENSIONS {
+export declare const GRAPHICS_FILE_EXTENSIONS: Readonly<{
   fbx: "application/octet-stream";
   glb: "model/gltf-binary";
   gltf: "model/gltf+json";
@@ -1748,49 +1854,65 @@ interface _GRAPHICS_FILE_EXTENSIONS {
   obj: "model/obj";
   stl: "model/stl";
   usdz: "model/vnd.usdz+zip";
-}
+}>;
+export type GRAPHICS_FILE_EXTENSIONS = keyof typeof GRAPHICS_FILE_EXTENSIONS;
+
 /**
- * Supported file extensions for 3D files, and their corresponding mime types.
+ * @privateRemarks Video is spread in after audio, so its `ogg` and `webm` keys override
  */
-export declare const GRAPHICS_FILE_EXTENSIONS: Readonly<_GRAPHICS_FILE_EXTENSIONS>;
-export type GRAPHICS_FILE_EXTENSIONS = ValueOf<_GRAPHICS_FILE_EXTENSIONS>;
-
 interface _UPLOADABLE_FILE_EXTENSIONS
-  extends _IMAGE_FILE_EXTENSIONS,
-    Omit<_VIDEO_FILE_EXTENSIONS, "ogg" | "webm">,
-    _AUDIO_FILE_EXTENSIONS,
-    _TEXT_FILE_EXTENSIONS,
-    _FONT_FILE_EXTENSIONS,
-    _GRAPHICS_FILE_EXTENSIONS {}
+  extends Identity<typeof IMAGE_FILE_EXTENSIONS>,
+    Omit<typeof AUDIO_FILE_EXTENSIONS, "ogg" | "webm">,
+    Identity<typeof VIDEO_FILE_EXTENSIONS>,
+    Identity<typeof TEXT_FILE_EXTENSIONS>,
+    Identity<typeof FONT_FILE_EXTENSIONS>,
+    Identity<typeof GRAPHICS_FILE_EXTENSIONS> {}
 
-export declare const UPLOADABLE_FILE_EXTENSIONS: _UPLOADABLE_FILE_EXTENSIONS;
-export type UPLOADABLE_FILE_EXTENSIONS = ValueOf<_UPLOADABLE_FILE_EXTENSIONS>;
+export declare const UPLOADABLE_FILE_EXTENSIONS: Readonly<_UPLOADABLE_FILE_EXTENSIONS>;
+export type UPLOADABLE_FILE_EXTENSIONS = keyof typeof UPLOADABLE_FILE_EXTENSIONS;
 
 /**
- * A list of MIME types which are treated as uploaded "media", which are allowed to overwrite existing files.
- * Any non-media MIME type is not allowed to replace an existing file.
+ * An enumeration of file type categories which can be selected
+ */
+export declare const FILE_CATEGORIES: Readonly<{
+  HTML: typeof HTML_FILE_EXTENSIONS;
+  IMAGE: typeof IMAGE_FILE_EXTENSIONS;
+  VIDEO: typeof VIDEO_FILE_EXTENSIONS;
+  AUDIO: typeof AUDIO_FILE_EXTENSIONS;
+  TEXT: typeof TEXT_FILE_EXTENSIONS;
+  FONT: typeof FONT_FILE_EXTENSIONS;
+  GRAPHICS: typeof GRAPHICS_FILE_EXTENSIONS;
+
+  /**
+   * @deprecated "`CONST.FILE_CATEGORIES.MEDIA` is deprecated. Use {@linkcode CONST.MEDIA_MIME_TYPES} instead." (since v13, until v15)
+   * @remarks Included in the const body as a getter, *then* `defineProperty`'d to be `enumerable: false` separately
+   */
+  get MEDIA(): typeof MEDIA_MIME_TYPES;
+}>;
+export type FILE_CATEGORIES = keyof typeof FILE_CATEGORIES;
+
+/**
+ * The list of file categories that are "media".
  */
-export declare const MEDIA_MIME_TYPES: ValueOf<_UPLOADABLE_FILE_EXTENSIONS>;
-export type MEDIA_MIME_TYPES = typeof MEDIA_MIME_TYPES;
+export declare const MEDIA_FILE_CATEGORIES: readonly ["IMAGE", "VIDEO", "AUDIO", "TEXT", "FONT", "GRAPHICS"];
+export type MEDIA_FILE_CATEGORIES = ValueOf<typeof MEDIA_FILE_CATEGORIES>;
 
 /**
- * An enumeration of file type categories which can be selected
+ * A list of MIME types which are treated as uploaded "media", which are allowed to overwrite existing files.
+ * Any non-media MIME type is not allowed to replace an existing file.
+ * @remarks Not frozen as of 13.346
+ * @privateRemarks The *keys* `ogg` and `webm` conflict when building {@linkcode UPLOADABLE_FILE_EXTENSIONS}, but the values don't, and Foundry
+ * constructs this differently than we are so they keep the values
  */
-export declare const FILE_CATEGORIES: {
-  HTML: HTML_FILE_EXTENSIONS;
-  IMAGE: _IMAGE_FILE_EXTENSIONS;
-  VIDEO: _VIDEO_FILE_EXTENSIONS;
-  AUDIO: _AUDIO_FILE_EXTENSIONS;
-  TEXT: _TEXT_FILE_EXTENSIONS;
-  FONT: _FONT_FILE_EXTENSIONS;
-  GRAPHICS: _GRAPHICS_FILE_EXTENSIONS;
-  MEDIA: MEDIA_MIME_TYPES;
-};
+export declare const MEDIA_MIME_TYPES: MEDIA_MIME_TYPES[];
+export type MEDIA_MIME_TYPES =
+  | ValueOf<_UPLOADABLE_FILE_EXTENSIONS>
+  | ValueOf<Pick<typeof AUDIO_FILE_EXTENSIONS, "ogg" | "webm">>;
 
 /**
  * A font weight to name mapping.
  */
-export declare const FONT_WEIGHTS: {
+export declare const FONT_WEIGHTS: Readonly<{
   Thin: 100 & FONT_WEIGHTS;
   ExtraLight: 200 & FONT_WEIGHTS;
   Light: 300 & FONT_WEIGHTS;
@@ -1800,7 +1922,7 @@ export declare const FONT_WEIGHTS: {
   Bold: 700 & FONT_WEIGHTS;
   ExtraBold: 800 & FONT_WEIGHTS;
   Black: 900 & FONT_WEIGHTS;
-};
+}>;
 export type FONT_WEIGHTS = Brand<number, "constants.FONT_WEIGHTS">;
 
 /**
@@ -1810,19 +1932,23 @@ export declare const TIMEOUTS: Readonly<{
   /**
    * The default timeout for interacting with the foundryvtt.com API.
    */
-  FOUNDRY_WEBSITE: 10000 & TIMEOUTS;
+  FOUNDRY_WEBSITE: 10000;
 
   /**
    * The specific timeout for loading the list of packages from the foundryvtt.com API.
    */
-  PACKAGE_REPOSITORY: 5000 & TIMEOUTS;
+  PACKAGE_REPOSITORY: 10000;
 
   /**
    * The specific timeout for the IP address lookup service.
    */
-  IP_DISCOVERY: 5000 & TIMEOUTS;
+  IP_DISCOVERY: 5000;
+
+  /**
+   * A remote package manifest JSON or download ZIP.
+   */
+  REMOTE_PACKAGE: 5000;
 }>;
-export type TIMEOUTS = Brand<number, "constants.TIMEOUTS">;
 
 /**
  * A subset of Compendium types which require a specific system to be designated
@@ -1842,10 +1968,120 @@ export declare const SHOWDOWN_OPTIONS: Readonly<{
   tablesHeaderId: true;
 }>;
 
+/**
+ * The list of allowed HTML tags.
+ */
+export declare const ALLOWED_HTML_TAGS: readonly [
+  "header",
+  "main",
+  "section",
+  "article",
+  "aside",
+  "nav",
+  "footer",
+  "div",
+  "address", // Structural Elements
+  "h1",
+  "h2",
+  "h3",
+  "h4",
+  "h5",
+  "h6",
+  "hr",
+  "br", // Headers and Dividers
+  "p",
+  "blockquote",
+  "summary",
+  "details",
+  "span",
+  "code",
+  "pre",
+  "a",
+  "label",
+  "abbr",
+  "cite",
+  "mark",
+  "q",
+  "ruby",
+  "rp",
+  "rt",
+  "small",
+  "time",
+  "var",
+  "kbd",
+  "samp", // Text Types
+  "dfn",
+  "sub",
+  "sup",
+  "strong",
+  "em",
+  "b",
+  "i",
+  "u",
+  "s",
+  "del",
+  "ins", // Text Styles
+  "ol",
+  "ul",
+  "li",
+  "dl",
+  "dd",
+  "dt",
+  "menu", // Lists
+  "table",
+  "thead",
+  "tbody",
+  "tfoot",
+  "tr",
+  "th",
+  "td",
+  "col",
+  "colgroup", // Tables
+  "form",
+  "input",
+  "select",
+  "option",
+  "button",
+  "datalist",
+  "fieldset",
+  "legend",
+  "meter",
+  "optgroup",
+  "progress",
+  "textarea",
+  "output", // Forms
+  "figure",
+  "figcaption",
+  "caption",
+  "img",
+  "video",
+  "map",
+  "area",
+  "track",
+  "picture",
+  "source",
+  "audio", // Media
+  "iframe", // Embedded content
+  "color-picker",
+  "code-mirror",
+  "document-embed",
+  "document-tags",
+  "enriched-content",
+  "file-picker",
+  "hue-slider",
+  "multi-select",
+  "multi-checkbox",
+  "range-picker",
+  "secret-block",
+  "string-tags",
+  "prose-mirror", // Custom elements
+];
+export type ALLOWED_HTML_TAGS = ValueOf<typeof ALLOWED_HTML_TAGS>;
+
 /**
  * The list of allowed attributes in HTML elements.
  */
-export const ALLOWED_HTML_ATTRIBUTES: Readonly<{
+export const ALLOWED_HTML_ATTRIBUTES: DeepReadonly<{
   "*": [
     "class",
     "data-*",
@@ -1862,6 +2098,12 @@ export const ALLOWED_HTML_ATTRIBUTES: Readonly<{
     "is",
     "lang",
     "popover",
+    "autocapitalize",
+    "autocorrect",
+    "autofocus",
+    "contenteditable",
+    "spellcheck",
+    "translate",
   ];
   a: ["href", "name", "target", "rel"];
   area: ["alt", "coords", "href", "rel", "shape", "target"];
@@ -1870,9 +2112,16 @@ export const ALLOWED_HTML_ATTRIBUTES: Readonly<{
   button: ["disabled", "name", "type", "value"];
   col: ["span"];
   colgroup: ["span"];
+  "code-mirror": ["disabled", "name", "value", "placeholder", "readonly", "required", "language", "indent", "nowrap"];
+  "color-picker": ["disabled", "name", "value", "placeholder", "readonly", "required"];
   details: ["open"];
+  "document-embed": ["uuid"];
+  "document-tags": ["disabled", "name", "value", "placeholder", "readonly", "required", "type", "single", "max"];
+  "enriched-content": ["enricher"];
   fieldset: ["disabled"];
+  "file-picker": ["disabled", "name", "value", "placeholder", "readonly", "required", "type", "noupload"];
   form: ["name"];
+  "hue-slider": ["disabled", "name", "value", "readonly", "required"];
   iframe: ["src", "srcdoc", "name", "height", "width", "loading", "sandbox"];
   img: ["height", "src", "width", "usemap", "sizes", "srcset", "alt"];
   input: [
@@ -1887,32 +2136,50 @@ export const ALLOWED_HTML_ATTRIBUTES: Readonly<{
     "list",
     "max",
     "min",
-    "placeholder",
     "readonly",
     "size",
     "src",
     "step",
     "width",
+    "required",
   ];
   label: ["for"];
   li: ["value"];
   map: ["name"];
   meter: ["value", "min", "max", "low", "high", "optimum"];
+  "multi-checkbox": ["disabled", "name", "required"];
+  "multi-select": ["disabled", "name", "required"];
   ol: ["reversed", "start", "type"];
   optgroup: ["disabled", "label"];
   option: ["disabled", "selected", "label", "value"];
+  output: ["for", "form", "name"];
   progress: ["max", "value"];
-  select: ["name", "disabled", "multiple", "size"];
+  "prose-mirror": ["disabled", "name", "value", "placeholder", "readonly", "required", "toggled", "open"];
+  "range-picker": ["disabled", "name", "value", "placeholder", "readonly", "min", "max", "step"];
+  select: ["name", "disabled", "multiple", "size", "required"];
   source: ["media", "sizes", "src", "srcset", "type"];
+  "string-tags": ["disabled", "name", "value", "placeholder", "readonly", "required"];
   table: ["border"];
   td: ["colspan", "headers", "rowspan"];
-  textarea: ["rows", "cols", "disabled", "name", "readonly", "wrap"];
+  textarea: ["rows", "cols", "disabled", "name", "readonly", "wrap", "required"];
   time: ["datetime"];
   th: ["abbr", "colspan", "headers", "rowspan", "scope", "sorted"];
   track: ["default", "kind", "label", "src", "srclang"];
   video: ["controls", "height", "width", "loop", "muted", "poster", "src", "autoplay"];
 }>;
-export type ALLOWED_HTML_ATTRIBUTES = ValueOf<typeof ALLOWED_HTML_ATTRIBUTES>;
+export type ALLOWED_HTML_ATTRIBUTES = typeof ALLOWED_HTML_ATTRIBUTES;
+
+/**
+ * The list of allowed URL schemes.
+ */
+export declare const ALLOWED_URL_SCHEMES: readonly ["http", "https", "data", "mailto", "obsidian", "syrinscape-online"];
+export type ALLOWED_URL_SCHEMES = ValueOf<typeof ALLOWED_URL_SCHEMES>;
+
+/**
+ * The list of attributes validated as URLs.
+ */
+export declare const ALLOWED_URL_SCHEMES_APPLIED_TO_ATTRIBUTES: readonly ["href", "src", "cite"];
+export type ALLOWED_URL_SCHEMES_APPLIED_TO_ATTRIBUTES = ValueOf<typeof ALLOWED_URL_SCHEMES_APPLIED_TO_ATTRIBUTES>;
 
 /**
  * The list of trusted iframe domains.
@@ -1924,15 +2191,15 @@ export type TRUSTED_IFRAME_DOMAINS = ValueOf<typeof TRUSTED_IFRAME_DOMAINS>;
  * Available themes for the world join page.
  */
 export const WORLD_JOIN_THEMES: Readonly<{
-  default: "WORLD.JoinThemeDefault";
-  minimal: "WORLD.JoinThemeMinimal";
+  default: "WORLD.JOIN_THEMES.default";
+  minimal: "WORLD.JOIN_THEMES.minimal";
 }>;
 export type WORLD_JOIN_THEMES = ValueOf<typeof WORLD_JOIN_THEMES>;
 
 /**
  * Setup page package progress protocol.
  */
-export declare const SETUP_PACKAGE_PROGRESS: Readonly<{
+export declare const SETUP_PACKAGE_PROGRESS: DeepReadonly<{
   ACTIONS: {
     CREATE_BACKUP: "createBackup";
     RESTORE_BACKUP: "restoreBackup";
@@ -1945,10 +2212,11 @@ export declare const SETUP_PACKAGE_PROGRESS: Readonly<{
     UPDATE_CORE: "updateCore";
     UPDATE_DOWNLOAD: "updateDownload";
   };
-
   STEPS: {
     ARCHIVE: "archive";
     CHECK_DISK_SPACE: "checkDiskSpace";
+    CLEAN_WORLD: "cleanWorld";
+    EXTRACT_DEMO: "extractDemo";
     CONNECT_WORLD: "connectWorld";
     MIGRATE_WORLD: "migrateWorld";
     CONNECT_PKG: "connectPackage";
@@ -1980,13 +2248,14 @@ export declare const COMBAT_ANNOUNCEMENTS: readonly ["startEncounter", "nextUp",
 export type COMBAT_ANNOUNCEMENTS = ValueOf<typeof COMBAT_ANNOUNCEMENTS>;
 
 /**
- * The fit modes of {@link foundry.data.TextureData#fit}.
+ * The fit modes of {@link foundry.data.TextureData.fit | `foundry.data.TextureData#fit`}.
  */
 export declare const TEXTURE_DATA_FIT_MODES: readonly ["fill", "contain", "cover", "width", "height"];
 export type TEXTURE_DATA_FIT_MODES = ValueOf<typeof TEXTURE_DATA_FIT_MODES>;
 
 /**
  * The maximum depth to recurse to when embedding enriched text.
+ * @defaultValue `5`
  */
 export const TEXT_ENRICH_EMBED_MAX_DEPTH: number;
 
@@ -1996,63 +2265,167 @@ export const TEXT_ENRICH_EMBED_MAX_DEPTH: number;
 export declare const REGION_EVENTS: Readonly<{
   /**
    * Triggered when the shapes or bottom/top elevation of the Region are changed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionRegionBoundaryEvent}
    */
   REGION_BOUNDARY: "regionBoundary";
 
   /**
-   * Triggered when the behavior is enabled/disabled or the Scene its Region is in is viewed/unviewed.
+   * Triggered when the Region Behavior becomes active, i.e. is enabled or created without being disabled.
+   *
+   * The event is triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionBehaviorActivatedEvent}
    */
-  BEHAVIOR_STATUS: "behaviorStatus";
+  BEHAVIOR_ACTIVATED: "behaviorActivated";
 
   /**
-   * Triggered when a Token enters a Region.
+   * Triggered when the Region Behavior becomes inactive, i.e. is disabled or deleted without being disabled.
+   *
+   * The event is triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionBehaviorDeactivatedEvent}
    */
-  TOKEN_ENTER: "tokenEnter";
+  BEHAVIOR_DEACTIVATED: "behaviorDeactivated";
 
   /**
-   * Triggered when a Token exists a Region.
+   * Triggered when the Region Behavior becomes viewed, i.e. active and the Scene of its Region is viewed.
+   *
+   * The event is triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionBehaviorViewedEvent}
    */
-  TOKEN_EXIT: "tokenExit";
+  BEHAVIOR_VIEWED: "behaviorViewed";
+
+  /**
+   * Triggered when the Region Behavior becomes unviewed, i.e. inactive or the Scene of its Region is unviewed.
+   *
+   * The event is triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionBehaviorUnviewedEvent}
+   */
+  BEHAVIOR_UNVIEWED: "behaviorUnviewed";
 
   /**
-   * Triggered when a Token is about to move into, out of, through, or within a Region.
+   * Triggered when a Token enters a Region.
+   *
+   * A Token enters a Region whenever ...
+   *   - it is created within the Region,
+   *   - the boundary of the Region has changed such that the Token is now inside the Region,
+   *   - the Token moves into the Region (the Token's x, y, elevation, width, height, or shape
+   *     has changed such that it is now inside the Region), or
+   *   - a Region Behavior becomes active (i.e., is enabled or created while enabled), in which case
+   *     the event it triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenEnterEvent}
    */
-  TOKEN_PRE_MOVE: "tokenPreMove";
+  TOKEN_ENTER: "tokenEnter";
 
   /**
-   * Triggered when a Token moves into, out of, through, or within a Region.
+   * Triggered when a Token exits a Region.
+   *
+   * A Token exits a Region whenever ...
+   *   - it is deleted while inside the Region,
+   *   - the boundary of the Region has changed such that the Token is no longer inside the Region,
+   *   - the Token moves out of the Region (the Token's x, y, elevation, width, height, or shape
+   *     has changed such that it is no longer inside the Region), or
+   *   - a Region Behavior becomes inactive (i.e., is disabled or deleted while enabled), in which case
+   *     the event it triggered only for this Region Behavior.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenExitEvent}
    */
-  TOKEN_MOVE: "tokenMove";
+  TOKEN_EXIT: "tokenExit";
 
   /**
    * Triggered when a Token moves into a Region.
+   *
+   * A Token moves whenever its x, y, elevation, width, height, or shape is changed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenMoveInEvent}
    */
   TOKEN_MOVE_IN: "tokenMoveIn";
 
   /**
    * Triggered when a Token moves out of a Region.
+   *
+   * A Token moves whenever its x, y, elevation, width, height, or shape is changed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenMoveOutEvent}
    */
   TOKEN_MOVE_OUT: "tokenMoveOut";
 
+  /**
+   * Triggered when a Token moves within a Region.
+   *
+   * A token moves whenever its x, y, elevation, width, height, or shape is changed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenMoveWithinEvent}
+   */
+  TOKEN_MOVE_WITHIN: "tokenMoveWithin";
+
+  /**
+   * Triggered when a Token animates into a Region.
+   *
+   * This event is only triggered only if the Scene the Token is in is viewed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenAnimateInEvent}
+   */
+  TOKEN_ANIMATE_IN: "tokenAnimateIn";
+
+  /**
+   * Triggered when a Token animates out of a Region.
+   *
+   * This event is triggered only if the Scene the Token is in is viewed.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenAnimateOutEvent}
+   */
+  TOKEN_ANIMATE_OUT: "tokenAnimateOut";
+
   /**
    * Triggered when a Token starts its Combat turn in a Region.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenTurnStartEvent}
    */
   TOKEN_TURN_START: "tokenTurnStart";
 
   /**
    * Triggered when a Token ends its Combat turn in a Region.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenTurnEndEvent}
    */
   TOKEN_TURN_END: "tokenTurnEnd";
 
   /**
    * Triggered when a Token starts the Combat round in a Region.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenRoundStartEvent}
    */
   TOKEN_ROUND_START: "tokenRoundStart";
 
   /**
    * Triggered when a Token ends the Combat round in a Region.
+   *
+   * @see {@linkcode foundry.documents.types.RegionTokenRoundEndEvent}
    */
   TOKEN_ROUND_END: "tokenRoundEnd";
+
+  /**
+   * @deprecated "`CONST.REGION_EVENTS.BEHAVIOR_STATUS` is deprecated in favor of `BEHAVIOR_ACTIVATED`,
+   * `BEHAVIOR_DEACTIVATED`, `BEHAVIOR_VIEWED`, and `BEHAVIOR_UNVIEWED`." (since v13, until v15)
+   */
+  get BEHAVIOR_STATUS(): "behaviorStatus";
+
+  /**
+   * @deprecated "`CONST.REGION_EVENTS.TOKEN_PRE_MOVE` is deprecated without replacement. The `TOKEN_PRE_MOVE`
+   * event is not longer triggered." (since v13, until v15)
+   */
+  get TOKEN_PRE_MOVE(): "tokenPreMove";
+
+  /**
+   * @deprecated "`CONST.REGION_EVENTS.TOKEN_PRE_MOVE` is deprecated without replacement. The `TOKEN_MOVE`
+   * event is not longer triggered." (since v13, until v15)
+   */
+  get TOKEN_MOVE(): "tokenMove";
 }>;
 export type REGION_EVENTS = ValueOf<typeof REGION_EVENTS>;
 
@@ -2077,7 +2450,104 @@ export declare const REGION_VISIBILITY: Readonly<{
 }>;
 export type REGION_VISIBILITY = Brand<number, "constants.REGION_VISIBILITY">;
 
+export declare const REGION_MOVEMENT_SEGMENTS: Readonly<{
+  /**
+   * The segment crosses the boundary of the Region and exits it.
+   */
+  EXIT: -1 & REGION_MOVEMENT_SEGMENTS;
+
+  /**
+   * The segment does not cross the boundary of the region and is contained within it.
+   */
+  MOVE: 0 & REGION_MOVEMENT_SEGMENTS;
+
+  /**
+   * The segment crosses the boundary of the region and enters it.
+   */
+  ENTER: 1 & REGION_MOVEMENT_SEGMENTS;
+}>;
+export type REGION_MOVEMENT_SEGMENTS = Brand<number, "constants.REGION_MOVEMENT_SEGMENTS">;
+
+/**
+ * Available setting scopes.
+ */
+export declare const SETTING_SCOPES: Readonly<{
+  /**
+   * Settings scoped to the client device. Stored in localStorage.
+   */
+  CLIENT: "client";
+
+  /**
+   * Settings scoped to the game World. Applies to all Users in the World. Stored in the Settings database.
+   */
+  WORLD: "world";
+
+  /**
+   * Settings scoped to an individual User in the World. Stored in the Settings database.
+   */
+  USER: "user";
+}>;
+export type SETTING_SCOPES = ValueOf<typeof SETTING_SCOPES>;
+
+/**
+ * The scaling factor that is used for Clipper polygons/paths consistently everywhere core performs Clipper operations.
+ * @defaultValue `100`
+ */
+export declare const CLIPPER_SCALING_FACTOR: number;
+
+/**
+ * @deprecated (since v12, until v14)
+ */
+export declare const CHAT_MESSAGE_TYPES: Readonly<{
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  OTHER: typeof CHAT_MESSAGE_STYLES.OTHER;
+
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  OOC: typeof CHAT_MESSAGE_STYLES.OOC;
+
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  IC: typeof CHAT_MESSAGE_STYLES.IC;
+
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  EMOTE: typeof CHAT_MESSAGE_STYLES.EMOTE;
+
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
+  ROLL: typeof CHAT_MESSAGE_STYLES.ROLL;
+
+  /**
+   * @deprecated "`CONST.CHAT_MESSAGE_TYPES` is deprecated in favor of {@linkcode CONST.CHAT_MESSAGE_STYLES} because the {@linkcode ChatMessage.type | ChatMessage#type}
+   * field has been renamed to {@linkcode ChatMessage.style | ChatMessage#style}" (since v12, until v14)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
+  WHISPER: typeof CHAT_MESSAGE_STYLES.WHISPER;
+}>;
+export type CHAT_MESSAGE_TYPES = CHAT_MESSAGE_STYLES;
+
 /**
- * @deprecated since v12
+ * @deprecated "`CONST.DOCUMENT_TYPES` is deprecated in favor of either {@linkcode CONST.WORLD_DOCUMENT_TYPES} or {@linkcode CONST.COMPENDIUM_DOCUMENT_TYPES}." (since v12, until 14)
  */
+// eslint-disable-next-line @typescript-eslint/no-deprecated
+export declare const DOCUMENT_TYPES: DOCUMENT_TYPES[];
 export type DOCUMENT_TYPES = Exclude<WORLD_DOCUMENT_TYPES, "FogExploration" | "Setting">;
+
+/**
+ * @deprecated "`CONST.TOKEN_HEXAGONAL_SHAPES` is deprecated in favor of {@linkcode CONST.TOKEN_SHAPES}." (since v13, until v15)
+ */
+export declare const TOKEN_HEXAGONAL_SHAPES: typeof TOKEN_SHAPES;
+export type TOKEN_HEXAGONAL_SHAPES = TOKEN_SHAPES;