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

package/src/foundry/common/abstract/embedded-collection.d.mts

@@ -247,7 +247,7 @@ declare class EmbeddedCollection<
     documents: foundry.abstract.Document.Any[],
     result: unknown,
     operation: DatabaseOperation,
-    user: User,
+    user: User.Implementation,
   ): void;
 
   /**
@@ -269,7 +269,7 @@ declare class EmbeddedCollection<
        * An array of filters to apply
        * @defaultValue `[]`
        */
-      filters: FieldFilter[];
+      filters: SearchFilter.FieldFilter[];
       /**
        * An array of document IDs to exclude from search results
        * @defaultValue `[]`

package/src/foundry/common/abstract/singleton-collection.d.mts

@@ -1,7 +1,7 @@
 import type EmbeddedCollection from "./embedded-collection.d.mts";
 
 /**
- * This class provides a {@link Collection} wrapper around a singleton embedded Document so that it can be interacted
+ * This class provides a {@link Collection | `Collection`} wrapper around a singleton embedded Document so that it can be interacted
  * with via a common interface.
  */
 export default class SingletonEmbeddedCollection<

package/src/foundry/common/abstract/type-data.d.mts

@@ -7,22 +7,18 @@ import type {
   Merge,
   RemoveIndexSignatures,
   SimpleMerge,
-} from "../../../utils/index.d.mts";
+  Identity,
+} from "fvtt-types/utils";
 import type { SchemaField } from "../data/fields.d.mts";
+import type { DatabaseCreateOperation, DatabaseDeleteOperation, DatabaseUpdateOperation } from "./_types.d.mts";
 import type { DataModel } from "./data.d.mts";
 import type Document from "./document.d.mts";
 
 type DataSchema = foundry.data.fields.DataSchema;
 
-declare class AnyDataModel extends DataModel<any, any, any> {
-  constructor(...args: any[]);
-}
-
-type StaticDataModel = typeof AnyDataModel;
-
-interface _InternalTypeDataModelInterface extends StaticDataModel {
-  new <Schema extends DataSchema, Parent extends Document.Any, _ComputedInstance extends DataModel<Schema, Parent>>(
-    ...args: ConstructorParameters<typeof DataModel<Schema, Parent>>
+interface _InternalTypeDataModelInterface extends DataModel.AnyConstructor {
+  new <Schema extends DataSchema, Parent extends Document.Any, _ComputedInstance extends object>(
+    ...args: DataModel.ConstructorArgs<Schema, Parent>
 
     // Note(LukeAbby): This seemingly redundant `DataModel<Schema, Parent>` is to
     // Ensure that TypeScript allows overriding `protected` methods in subclasses.
@@ -35,18 +31,11 @@ declare const _InternalTypeDataModelConst: _InternalTypeDataModelInterface;
 // @ts-expect-error Ignore the error, this is a workaround for a dynamic class.
 declare class _InternalTypeDataModel<
   Schema extends DataSchema,
-  Parent extends Document<any, DataSchema, any>,
+  Parent extends Document<Document.Type, DataSchema, Document.Any | null>,
   BaseData extends AnyObject = EmptyObject,
   DerivedData extends AnyObject = EmptyObject,
   // This does not work if inlined. It's weird to put it here but it works.
-  _ComputedInstance extends DataModel<Schema, Parent> = SimpleMerge<
-    Merge<RemoveIndexSignatures<BaseData>, RemoveIndexSignatures<DerivedData>>,
-    // The merge is written this way because properties in the data model _cannot_ be allowed to be overridden by the base or derived data.
-    // In theory this could be allowed but it causes a few difficulties.
-    // The fundamental issue is that allowing this would cause subclasses to no longer guaranteed to be valid subtypes.
-    // A particularly thorny but not fully fundamental issue is that it also causes difficulties with `this` inside of classes generic over `BaseData`.
-    DataModel<Schema, Parent>
-  >,
+  _ComputedInstance extends object = Merge<RemoveIndexSignatures<BaseData>, RemoveIndexSignatures<DerivedData>>,
 > extends _InternalTypeDataModelConst<Schema, Parent, _ComputedInstance> {}
 
 declare const __TypeDataModelBrand: unique symbol;
@@ -114,15 +103,15 @@ type InnerMerge<U, K extends keyof U, T> = T extends { readonly [_ in K]?: infer
   : U[K];
 
 declare namespace TypeDataModel {
-  type Any = TypeDataModel<any, any, any, any>;
-  type AnyConstructor = typeof AnyTypeDataModel;
+  interface Any extends AnyTypeDataModel {}
+  interface AnyConstructor extends Identity<typeof AnyTypeDataModel> {}
 
   type ConfigurationFailureInstance = ConfigurationFailure;
   type ConfigurationFailureClass = typeof ConfigurationFailure;
 
   // Documented at https://gist.github.com/LukeAbby/c7420b053d881db4a4d4496b95995c98
   namespace Internal {
-    type Constructor = (abstract new (arg0: never, ...args: never[]) => Instance.Any) & {
+    type Constructor = (abstract new (...args: never) => Instance.Any) & {
       [__TypeDataModelBrand]: never;
     };
 
@@ -144,7 +133,7 @@ declare namespace TypeDataModel {
     }
 
     namespace Instance {
-      type Any = Instance<any, any, any, any, any>;
+      interface Any extends Instance<any, any, any, any, any> {}
     }
   }
 
@@ -162,17 +151,17 @@ declare namespace TypeDataModel {
       : never;
 
   type ParentAssignmentType<Schema extends DataSchema, Parent extends Document.Internal.Instance.Any> = SimpleMerge<
-    SchemaField.InitializedType<Document.SchemaFor<Parent>>,
+    SchemaField.InitializedData<Document.SchemaFor<Parent>>,
     {
       // FIXME(LukeAbby): Callers handle making this partial when obvious.
       // However also should make system partial using the regular rules: if `initial` is assignable to the field or if `required` is false etc.
-      system: SchemaField.InitializedType<Schema>;
+      system: SchemaField.InitializedData<Schema>;
     }
   >;
 }
 
 declare abstract class AnyTypeDataModel extends TypeDataModel<any, any, any, any> {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }
 
 /**
@@ -255,15 +244,15 @@ declare abstract class TypeDataModel<
   /**
    * Prepare data related to this DataModel itself, before any derived data is computed.
    *
-   * Called before {@link ClientDocument#prepareBaseData} in {@link ClientDocument#prepareData}.
-   * */
+   * Called before {@link ClientDocument.prepareBaseData | `ClientDocument#prepareBaseData`} in {@link ClientDocument.prepareData | `ClientDocument#prepareData`}.
+   */
   prepareBaseData(this: TypeDataModel.PrepareBaseDataThis<this>): void;
 
   /**
    * Apply transformations of derivations to the values of the source data object.
    * Compute data fields whose values are not stored to the database.
    *
-   * Called before {@link ClientDocument#prepareDerivedData} in {@link ClientDocument#prepareData}.
+   * Called before {@link ClientDocument.prepareDerivedData | `ClientDocument#prepareDerivedData`} in {@link ClientDocument.prepareData | `ClientDocument#prepareData`}.
    */
   prepareDerivedData(this: TypeDataModel.PrepareDerivedDataThis<this>): void;
 
@@ -283,7 +272,7 @@ declare abstract class TypeDataModel<
   /* -------------------------------------------- */
 
   /**
-   * Called by {@link ClientDocument#_preCreate}.
+   * Called by {@link ClientDocument._preCreate | `ClientDocument#_preCreate`}.
    *
    * @param data    - The initial data object provided to the document creation request
    * @param options - Additional options which modify the creation request
@@ -292,12 +281,12 @@ declare abstract class TypeDataModel<
    */
   protected _preCreate(
     data: TypeDataModel.ParentAssignmentType<Schema, Parent>,
-    options: Document.PreCreateOptions<any>,
-    user: User,
+    options: Document.Database.PreCreateOptions<DatabaseCreateOperation>,
+    user: User.Implementation,
   ): Promise<boolean | void>;
 
   /**
-   * Called by {@link ClientDocument#_onCreate}.
+   * Called by {@link ClientDocument._onCreate | `ClientDocument#_onCreate`}.
    *
    * @param data    - The initial data object provided to the document creation request
    * @param options - Additional options which modify the creation request
@@ -305,12 +294,12 @@ declare abstract class TypeDataModel<
    */
   protected _onCreate(
     data: TypeDataModel.ParentAssignmentType<Schema, Parent>,
-    options: Document.OnCreateOptions<any>,
+    options: Document.Database.CreateOptions<DatabaseCreateOperation>,
     userId: string,
   ): void;
 
   /**
-   * Called by {@link ClientDocument#_preUpdate}.
+   * Called by {@link ClientDocument._preUpdate | `ClientDocument#_preUpdate`}.
    *
    * @param changes - The candidate changes to the Document
    * @param options - Additional options which modify the update request
@@ -319,12 +308,12 @@ declare abstract class TypeDataModel<
    */
   protected _preUpdate(
     changes: DeepPartial<TypeDataModel.ParentAssignmentType<Schema, Parent>>,
-    options: Document.PreUpdateOptions<any>,
-    userId: string,
+    options: Document.Database.PreUpdateOptions<DatabaseUpdateOperation>,
+    user: User.Implementation,
   ): Promise<boolean | void>;
 
   /**
-   * Called by {@link ClientDocument#_onUpdate}.
+   * Called by {@link ClientDocument._onUpdate | `ClientDocument#_onUpdate`}.
    *
    * @param changed - The differential data that was changed relative to the documents prior values
    * @param options - Additional options which modify the update request
@@ -332,26 +321,29 @@ declare abstract class TypeDataModel<
    */
   protected _onUpdate(
     changed: DeepPartial<TypeDataModel.ParentAssignmentType<Schema, Parent>>,
-    options: Document.OnUpdateOptions<any>,
+    options: Document.Database.UpdateOptions<DatabaseUpdateOperation>,
     userId: string,
   ): void;
 
   /**
-   * Called by {@link ClientDocument#_preDelete}.
+   * Called by {@link ClientDocument._preDelete | `ClientDocument#_preDelete`}.
    *
    * @param options - Additional options which modify the deletion request
    * @param user    - The User requesting the document deletion
    * @returns A return value of false indicates the deletion operation should be cancelled.
    */
-  protected _preDelete(options: Document.PreDeleteOptions<any>, user: User): Promise<boolean | void>;
+  protected _preDelete(
+    options: Document.Database.PreDeleteOperationInstance<DatabaseDeleteOperation>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
   /**
-   * Called by {@link ClientDocument#_onDelete}.
+   * Called by {@link ClientDocument._onDelete | `ClientDocument#_onDelete`}.
    *
    * @param options - Additional options which modify the deletion request
    * @param userId  - The id of the User requesting the document update
    */
-  protected _onDelete(options: Document.OnDeleteOptions<any>, userId: string): void;
+  protected _onDelete(options: Document.Database.DeleteOptions<DatabaseDeleteOperation>, userId: string): void;
 }
 
 declare class ConfigurationFailure extends TypeDataModel<any, any, any, any> {}

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

@@ -1,7 +1,7 @@
 import type { DataModel } from "./abstract/data.d.mts";
 import type * as fields from "./data/fields.d.mts";
 import type { SOFTWARE_UPDATE_CHANNELS } from "./constants.d.mts";
-import type { AnyObject } from "fvtt-types/utils";
+import type { AnyMutableObject } from "fvtt-types/utils";
 
 type DataSchema = foundry.data.fields.DataSchema;
 
@@ -193,7 +193,7 @@ declare namespace ApplicationConfiguration {
 declare class ApplicationConfiguration extends DataModel<ApplicationConfiguration.Schema> {
   static defineSchema(): ApplicationConfiguration.Schema;
 
-  static override migrateData(source: AnyObject): AnyObject;
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
    * Validate a port assignment.
@@ -224,7 +224,7 @@ declare namespace ReleaseData {
       nullable: false;
       integer: true;
       min: 1;
-      // initial: () => fields.SchemaField.InnerInitializedType<Schema["generation"]>;
+      // initial: () => fields.SchemaField.InitializedData<Schema["generation"]>;
     }>;
 
     /**

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

@@ -88,6 +88,7 @@ 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 = "base";
 
 /**
  * Define the methods by which a Card can be drawn from a Cards stack
@@ -96,25 +97,25 @@ export declare const BASE_DOCUMENT_TYPE: "base";
 export declare const CARD_DRAW_MODES: Readonly<{
   /**
    * Draw the first card from the stack
-   * Synonymous with @see CARD_DRAW_MODES.TOP
+   * Synonymous with @see {@link CARD_DRAW_MODES.TOP | `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 @see {@link CARD_DRAW_MODES.FIRST | `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 @see {@link CARD_DRAW_MODES.BOTTOM | `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 @see {@link CARD_DRAW_MODES.LAST | `CARD_DRAW_MODES.LAST`}
    */
   BOTTOM: 1 & CARD_DRAW_MODES;
 
@@ -331,7 +332,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<{
   /**
@@ -387,7 +388,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<{
   /**
@@ -414,7 +415,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<{
   /**
@@ -483,7 +484,7 @@ 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<{
   /**
@@ -673,7 +674,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 +701,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 +729,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<{
   /**
@@ -858,7 +859,7 @@ 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<{
   /**
@@ -880,7 +881,7 @@ 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 +898,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 {@link TooltipManager | `TooltipManager`}
  */
 export declare const TEXT_ANCHOR_POINTS: Readonly<{
   /**
@@ -930,7 +931,7 @@ 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/
+ * @see {@link https://foundryvtt.com/article/tiles/}
  */
 export declare const OCCLUSION_MODES: Readonly<{
   /**
@@ -1000,7 +1001,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 +1038,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<{
   /**
@@ -1101,7 +1102,7 @@ export type TOKEN_HEXAGONAL_SHAPES = Brand<number, "constants.TOKEN_HEXAGONAL_SH
 /**
  * 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<{
   /**
@@ -1170,7 +1171,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<{
   /**
@@ -1509,7 +1510,7 @@ export declare const USER_PERMISSIONS: Readonly<{
 
 /**
  * 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 +1532,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 +1554,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<{
   /**
@@ -1587,7 +1588,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,7 +1620,7 @@ 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/}
  */
 export declare const WALL_MOVEMENT_TYPES: Readonly<{
   /**
@@ -1636,7 +1637,7 @@ export type WALL_MOVEMENT_TYPES = ValueOf<typeof 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<{
   /**
@@ -1980,7 +1981,7 @@ 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>;

package/src/foundry/common/data/_types.d.mts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?
 //