@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250709090128 → 13.346.0-beta.20250709212159

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.20250709090128",
+  "version": "13.346.0-beta.20250709212159",
   "description": "TypeScript type definitions for Foundry VTT",
   "type": "module",
   "types": "./src/index.d.mts",

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

@@ -411,18 +411,18 @@ declare namespace ActiveEffect {
     /** Options passed along in Create operations for ActiveEffects */
     interface Create<Temporary extends boolean | undefined = boolean | undefined>
       extends foundry.abstract.types.DatabaseCreateOperation<ActiveEffect.CreateData, ActiveEffect.Parent, Temporary> {
-      animate?: boolean;
+      animate?: boolean | undefined;
     }
 
     /** Options passed along in Delete operations for ActiveEffects */
     interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<ActiveEffect.Parent> {
-      animate?: boolean;
+      animate?: boolean | undefined;
     }
 
     /** Options passed along in Update operations for ActiveEffects */
     interface Update
       extends foundry.abstract.types.DatabaseUpdateOperation<ActiveEffect.UpdateData, ActiveEffect.Parent> {
-      animate?: boolean;
+      animate?: boolean | undefined;
     }
 
     /** Operation for {@linkcode ActiveEffect.createDocuments} */

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

@@ -1268,17 +1268,20 @@ declare namespace Document {
       SubType extends AllSubType,
       TypeMap extends Record<AllSubType, { system: object | undefined }>,
       AllSubType extends string = SubType,
-    > = SubType extends unknown ? OfType<SubType, TypeMap, AllSubType> : never;
+    > = SubType extends unknown
+      ? [AllSubType] extends [SubType]
+        ? TypeMap[SubType] // There's only one subtype so avoid the worse type display of `OfType`.
+        : OfType<SubType, TypeMap, AllSubType>
+      : never;
 
     // Note(LukeAbby): This is named `OfType` to display as `Document.Internal.OfType` in quick info.
     interface OfType<
       OneSubType extends AllSubType,
       TypeMap extends Record<AllSubType, { system: object | undefined }>,
       AllSubType extends string,
-    > extends _Override<
-        TypeMap[OneSubType],
-        {
-          system: DiscriminatedSystem<
+    > extends _DynamicBase<
+        TypeMap[OneSubType] & {
+          system: SystemDiscriminant<
             Exclude<TypeMap[OneSubType]["system"], undefined>,
             Exclude<TypeMap[AllSubType]["system"], undefined>
           >;
@@ -1286,16 +1289,15 @@ declare namespace Document {
       > {}
 
     // @ts-expect-error This pattern is intrinsically an error.
-    interface _Override<Base extends object, OverrideWith extends object> extends OverrideWith, Base {}
+    interface _DynamicBase<Base extends object> extends Base {}
 
     /** @internal */
-    interface DiscriminatedSystem<System extends object, AllSystem extends object>
-      extends _Override<
-        {
-          [K in AllKeysOf<AllSystem>]?: never;
-        },
-        System
-      > {}
+    type SystemDiscriminant<System extends object, AllSystem extends object> = Omit<
+      {
+        [K in AllKeysOf<AllSystem>]?: never;
+      },
+      keyof System
+    >;
 
     interface DropData<DocumentType extends Document.Type> {
       /**
@@ -1926,7 +1928,7 @@ declare namespace Document {
 
     type CreateOperationForName<
       DocumentType extends Document.Type,
-      Temporary extends boolean | undefined = undefined,
+      Temporary extends boolean | undefined = boolean | undefined,
     > =
       | (DocumentType extends "ActiveEffect" ? ActiveEffect.Database.CreateOperation<Temporary> : never)
       | (DocumentType extends "ActorDelta" ? ActorDelta.Database.CreateOperation<Temporary> : never)

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

@@ -191,17 +191,14 @@ declare abstract class BaseActorDelta<
   override createEmbeddedDocuments<EmbeddedName extends ActorDelta.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends ActorDelta.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends ActorDelta.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -185,17 +185,14 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
   override createEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -161,17 +161,14 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
   override createEmbeddedDocuments<EmbeddedName extends Cards.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Cards.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Cards.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -164,17 +164,14 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
   override createEmbeddedDocuments<EmbeddedName extends Combat.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Combat.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Combat.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -170,17 +170,14 @@ declare abstract class BaseItem<out SubType extends Item.SubType = Item.SubType>
   override createEmbeddedDocuments<EmbeddedName extends Item.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Item.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Item.Embedded.Name>(
     embeddedName: EmbeddedName,

package/src/foundry/common/documents/journal-entry.d.mts

@@ -147,17 +147,14 @@ declare abstract class BaseJournalEntry extends Document<"JournalEntry", BaseJou
   override createEmbeddedDocuments<EmbeddedName extends JournalEntry.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends JournalEntry.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends JournalEntry.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -144,17 +144,14 @@ declare abstract class BasePlaylist extends Document<"Playlist", BasePlaylist.Sc
   override createEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -126,17 +126,14 @@ declare abstract class BaseRegion extends Document<"Region", BaseRegion.Schema,
   override createEmbeddedDocuments<EmbeddedName extends RegionDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends RegionDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends RegionDocument.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -147,17 +147,14 @@ declare abstract class BaseRollTable extends Document<"RollTable", BaseRollTable
   override createEmbeddedDocuments<EmbeddedName extends RollTable.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends RollTable.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends RollTable.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -250,17 +250,14 @@ declare abstract class BaseScene extends Document<"Scene", BaseScene.Schema, any
   override createEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
     embeddedName: EmbeddedName,

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

@@ -290,17 +290,14 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
   override createEmbeddedDocuments<EmbeddedName extends TokenDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     data: Document.CreateDataForName<EmbeddedName>[] | undefined,
-    // TODO(LukeAbby): The correct signature would be:
-    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
-    // However this causes a number of errors.
-    operation?: object,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+    operation?: Document.Database.CreateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override updateEmbeddedDocuments<EmbeddedName extends TokenDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends TokenDocument.Embedded.Name>(
     embeddedName: EmbeddedName,

package/src/foundry/common/utils/helpers.d.mts

@@ -331,6 +331,10 @@ export type DataType =
   | "undefined"
   | "Unknown";
 
+export type ExpandKey<K extends PropertyKey> = K extends `${infer First}.${infer Rest}`
+  ? { [_ in First]: ExpandKey<Rest> }
+  : { [_ in K]: unknown };
+
 /**
  * A helper function which tests whether an object has a property or nested property given a string key.
  * The string key supports the notation a.b.c which would return true if object[a][b][c] exists
@@ -338,7 +342,7 @@ export type DataType =
  * @param key    - An object property with notation a.b.c
  * @returns An indicator for whether the property exists
  */
-export function hasProperty(object: object, key: string): boolean;
+export function hasProperty<K extends PropertyKey>(object: object, key: K): object is ExpandKey<K>;
 
 /**
  * A helper function which searches through an object to retrieve a value by a string key.