@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250704113344 → 13.346.0-beta.20250704132251

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "13.346.0-beta.20250704113344",
+  "version": "13.346.0-beta.20250704132251",
   "description": "TypeScript type definitions for Foundry VTT",
   "type": "module",
   "types": "./src/index.d.mts",

package/src/configuration/configuration.d.mts

@@ -314,9 +314,9 @@ export interface SettingConfig {
       choices: InterfaceToObject<typeof CONFIG.Dice.rollModes>;
     },
     // Note(LukeAbby): This override is necessary because the `initial` wasn't removing `null`.
-    (string & keyof typeof CONFIG.Dice.rollModes) | null | undefined,
-    string & keyof typeof CONFIG.Dice.rollModes,
-    string & keyof typeof CONFIG.Dice.rollModes
+    CONFIG.Dice.RollMode | null | undefined,
+    CONFIG.Dice.RollMode,
+    CONFIG.Dice.RollMode
   >;
   "core.rtcClientSettings": typeof AVSettings.schemaFields.client;
   "core.rtcWorldSettings": typeof AVSettings.schemaFields.world;

package/src/foundry/client/applications/dice/roll-resolver.d.mts

@@ -114,8 +114,8 @@ declare namespace RollResolver {
   }
 
   interface Result {
-    denomination: DiceTerm.Any;
-    faces: DiceTerm.Any;
+    denomination: string;
+    faces: number | undefined;
     id: string;
     method: string;
     icon: string;

package/src/foundry/client/canvas/layers/base/placeables-layer.d.mts

@@ -308,19 +308,8 @@ declare class PlaceablesLayer<out DocumentName extends PlaceablesLayer.DocumentN
     options?: PlaceablesLayer.PasteOptions, // not:null (destructured)
   ): Promise<Document.ImplementationFor<DocumentName>[]>;
 
-  /**
-   * Get the data of the copied object pasted at the position given by the offset.
-   * Called by {@link PlaceablesLayer.pasteObjects | `PlaceablesLayer#pasteObjects`} for each copied object.
-   * @param copy    - The copied object that is pasted
-   * @param offset  - The offset relative from the current position to the destination
-   * @param options - Options of {@link PlaceablesLayer.pasteObjects | `PlaceablesLayer#pasteObjects`}
-   * @returns The update data
-   */
-  protected _pasteObject(
-    copy: Document.ObjectFor<DocumentName>,
-    offset: Canvas.Point,
-    options?: PlaceablesLayer.PasteOptions, // not:null (destructured)
-  ): Omit<Document.ImplementationFor<DocumentName>["_source"], "_id">;
+  /** @deprecated Foundry deleted this method in v13 (this warning will be removed in v14) */
+  protected _pasteObject(copy: never, offset: never, options?: never): never;
 
   /**
    * Select all PlaceableObject instances which fall within a coordinate rectangle.

package/src/foundry/client/canvas/layers/tokens.d.mts

@@ -78,12 +78,6 @@ declare class TokenLayer extends PlaceablesLayer<"Token"> {
 
   protected override _deactivate(): void;
 
-  protected override _pasteObject(
-    copy: Token.Implementation,
-    offset: Canvas.Point,
-    options?: PlaceablesLayer.PasteOptions, // not:null (destructured)
-  ): Omit<TokenDocument.Source, "_id">;
-
   /** @remarks Returns `[]` if the ruler is currently measuring */
   protected override _getMovableObjects(ids?: string[] | null, includeLocked?: boolean | null): Token.Implementation[];
 

package/src/foundry/client/canvas/layers/walls.d.mts

@@ -90,13 +90,6 @@ declare class WallsLayer extends PlaceablesLayer<"Wall"> {
 
   override releaseAll(options?: PlaceableObject.ReleaseOptions): number;
 
-  /** @remarks `options` is unused */
-  protected override _pasteObject(
-    copy: Wall.Implementation,
-    offset: Canvas.Point,
-    options?: PlaceablesLayer.PasteOptions | null,
-  ): Omit<WallDocument.Source, "_id">;
-
   /**
    * Pan the canvas view when the cursor position gets close to the edge of the frame
    * @param event - The originating mouse movement event

package/src/foundry/client/documents/abstract/world-collection.d.mts

@@ -32,15 +32,7 @@ declare abstract class WorldCollection<
    * In the case where `Lowercase<Name>` is not a property of {@linkcode ui}, this actually always returns `undefined`,
    * but {@linkcode RollTables} overrides this, so we need to allow a wider return type.
    */
-  get directory(): Lowercase<Name> extends keyof typeof ui
-    ? (typeof ui)[Lowercase<Name>]
-    :
-        | (DocumentName extends foundry.CONST.FOLDER_DOCUMENT_TYPES
-            ? DocumentDirectory<Document.ImplementationClassFor<DocumentName>>
-            : never)
-        | AbstractSidebarTab.Any
-        | undefined
-        | null;
+  get directory(): WorldCollection.Directory<DocumentName, Name>;
 
   /**
    * Return a reference to the singleton instance of this WorldCollection, or null if it has not yet been created.
@@ -139,6 +131,17 @@ declare namespace WorldCollection {
     DocumentName extends Folder.DocumentType ? Folder.Stored<DocumentName> : never
   >;
 
+  type Directory<DocumentName extends Document.WorldType, Name extends string> =
+    Lowercase<Name> extends keyof typeof ui
+      ? (typeof ui)[Lowercase<Name>]
+      :
+          | (DocumentName extends foundry.CONST.FOLDER_DOCUMENT_TYPES
+              ? DocumentDirectory<Document.ImplementationClassFor<DocumentName>>
+              : never)
+          | AbstractSidebarTab.Any
+          | undefined
+          | null;
+
   interface FromCompendiumOptions {
     /**
      * Clear the currently assigned folder

package/src/foundry/client/documents/actor-delta.d.mts

@@ -549,9 +549,9 @@ declare class ActorDelta<out SubType extends ActorDelta.SubType = ActorDelta.Sub
   protected override _initialize(options?: ActorDelta.InitializeOptions): void;
 
   /** Pass-through the type from the synthetic Actor, if it exists. */
-  get type(): string;
+  get type(): SubType;
 
-  set type(type: string);
+  set type(type);
 
   protected _type: string;
 

package/src/foundry/client/documents/actor.d.mts

@@ -708,7 +708,7 @@ declare class Actor<out SubType extends Actor.SubType = Actor.SubType> extends f
   /**
    * Provide a thumbnail image path used to represent this document.
    */
-  get thumbnail(): string;
+  get thumbnail(): string | null;
 
   /**
    * A convenience getter to an object that organizes all embedded Item instances by subtype. The object is cached and

package/src/foundry/client/documents/cards.d.mts

@@ -686,7 +686,13 @@ declare namespace Cards {
    * which wouldn't make sense to change, then passes that to {@link Cards.pass | `Cards#pass`}
    * @privateRemarks `action` omitted as it's already provided.
    */
-  interface DrawOptions extends _HowOption, Omit<PassOptions, "action"> {}
+  interface DrawOptions extends _HowOption, Omit<PassOptions, "action"> {
+    /**
+     * @deprecated While passing `action` is technically valid, it's unclear why this would ever be done.
+     * If you need to do this call `this.parent.pass` directly.
+     */
+    action?: never;
+  }
 
   interface ShuffleOptions extends _UpdateDataOption, _ChatNotificationOption {}
 

package/src/foundry/common/abstract/document.d.mts

@@ -1158,12 +1158,14 @@ declare namespace Document {
       | (SubType extends ModuleSubType | "base" ? UnknownSystem : never);
 
     // TODO(LukeAbby): Improve the type display with a helper here.
+    // TODO(LukeAbby): Add `StoredSource` for a better type display there.
     type Stored<D extends Document.Any> = Override<
       D,
       {
         id: string;
         _id: string;
         _source: Override<D["_source"], { _id: string }>;
+        toJSON(): Override<D["_source"], { _id: string }>;
       }
     >;
 
@@ -1419,7 +1421,9 @@ declare namespace Document {
   type MetadataFor<Name extends Document.Type> = ConfiguredMetadata[Name];
 
   type CollectionRecord<Schema extends DataSchema> = {
-    [Key in keyof Schema]: Schema[Key] extends EmbeddedCollectionField.Any ? Schema[Key] : never;
+    [Key in keyof Schema]: Schema[Key] extends EmbeddedCollectionField.Any
+      ? NonNullable<Schema[Key][" __fvtt_types_internal_initialized_data"]>
+      : never;
   };
 
   type Flags<ConcreteDocument extends Internal.Instance.Any> = OptionsForSchema<SchemaFor<ConcreteDocument>>;

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

@@ -1305,10 +1305,10 @@ declare namespace SchemaField {
 declare class BooleanField<
   const Options extends BooleanField.Options = BooleanField.DefaultOptions,
   // eslint-disable-next-line @typescript-eslint/no-deprecated
-  const AssignmentType = BooleanField.AssignmentType<SimpleMerge<Options, BooleanField.DefaultOptions>>,
-  const InitializedType = BooleanField.InitializedType<SimpleMerge<Options, BooleanField.DefaultOptions>>,
+  const AssignmentType = BooleanField.AssignmentType<SimpleMerge<BooleanField.DefaultOptions, Options>>,
+  const InitializedType = BooleanField.InitializedType<SimpleMerge<BooleanField.DefaultOptions, Options>>,
   const PersistedType extends boolean | null | undefined = BooleanField.InitializedType<
-    SimpleMerge<Options, BooleanField.DefaultOptions>
+    SimpleMerge<BooleanField.DefaultOptions, Options>
   >,
 > extends DataField<Options, AssignmentType, InitializedType, PersistedType> {
   /** @defaultValue `true` */

package/src/foundry/common/documents/active-effect.d.mts

@@ -89,6 +89,8 @@ declare abstract class BaseActiveEffect<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/actor-delta.d.mts

@@ -112,6 +112,12 @@ declare abstract class BaseActorDelta<
    * separate like this helps against circularities.
    */
 
+  // This is technically a property in this class but in the interest of avoiding an error it's been
+  // made a getter/setter pair.
+  get type(): SubType;
+
+  set type(type);
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/actor.d.mts

@@ -110,6 +110,8 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/card.d.mts

@@ -72,6 +72,8 @@ declare abstract class BaseCard<out SubType extends BaseCard.SubType = BaseCard.
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/cards.d.mts

@@ -86,6 +86,8 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/chat-message.d.mts

@@ -84,6 +84,8 @@ declare abstract class BaseChatMessage<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   override readonly parentCollection: ChatMessage.ParentCollectionName | null;

package/src/foundry/common/documents/combat.d.mts

@@ -89,6 +89,8 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/combatant-group.d.mts

@@ -55,6 +55,8 @@ declare abstract class BaseCombatantGroup<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/combatant.d.mts

@@ -70,6 +70,8 @@ declare abstract class BaseCombatant<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/folder.d.mts

@@ -11,7 +11,7 @@ import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare abstract class BaseFolder<out _SubType extends BaseFolder.SubType = BaseFolder.SubType> extends Document<
+declare abstract class BaseFolder<out SubType extends BaseFolder.SubType = BaseFolder.SubType> extends Document<
   "Folder",
   BaseFolder.Schema,
   any
@@ -76,6 +76,8 @@ declare abstract class BaseFolder<out _SubType extends BaseFolder.SubType = Base
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/item.d.mts

@@ -93,6 +93,8 @@ declare abstract class BaseItem<out SubType extends Item.SubType = Item.SubType>
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/macro.d.mts

@@ -11,7 +11,7 @@ import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMacro.SubType> extends Document<
+declare abstract class BaseMacro<out SubType extends BaseMacro.SubType = BaseMacro.SubType> extends Document<
   "Macro",
   BaseMacro.Schema,
   any
@@ -101,6 +101,8 @@ declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMa
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   override readonly parentCollection: Macro.ParentCollectionName | null;

package/src/foundry/common/documents/region-behavior.d.mts

@@ -73,6 +73,8 @@ declare abstract class BaseRegionBehavior<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now

package/src/foundry/common/documents/table-result.d.mts

@@ -12,7 +12,7 @@ import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
 declare abstract class BaseTableResult<
-  out _SubType extends BaseTableResult.SubType = BaseTableResult.SubType,
+  out SubType extends BaseTableResult.SubType = BaseTableResult.SubType,
 > extends Document<"TableResult", BaseTableResult.Schema, any> {
   /**
    * @param data    - Initial data from which to construct the `BaseTableResult`
@@ -87,6 +87,8 @@ declare abstract class BaseTableResult<
    * separate like this helps against circularities.
    */
 
+  type: SubType;
+
   /* Document overrides */
 
   // Same as Document for now