@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250724011756 → 13.346.0-beta.20250724185242

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

package/src/foundry/client/game.d.mts

@@ -1,17 +1,11 @@
 import type { Socket } from "socket.io-client";
-import type {
-  ConfiguredModule,
-  ValueOf,
-  FixedInstanceType,
-  InitializationHook,
-  InitializedOn,
-  EmptyObject,
-} from "#utils";
+import type { ValueOf, FixedInstanceType, InitializationHook, InitializedOn, EmptyObject, GetKey } from "#utils";
 import type BasePackage from "#common/packages/base-package.d.mts";
 import type { Document } from "#common/abstract/_module.d.mts";
 import type { Canvas } from "#client/canvas/_module.d.mts";
 
 import AVMaster = foundry.av.AVMaster;
+import Module = foundry.packages.Module;
 
 // Must be called with all hooks in a union.
 // Do not increase the complexity of this type. If you do Game related types may get complex enough to complain about not being statically known.
@@ -627,16 +621,38 @@ declare global {
 }
 
 declare namespace Game {
-  interface ModuleCollection extends Collection<foundry.packages.Module> {
+  interface ModuleCollection extends Collection<foundry.packages.Module, ModuleCollectionMethods> {}
+
+  interface ModuleCollectionMethods {
     /**
-     * Gets the module requested for by ID
-     * @see {@linkcode ModuleConfig} to add custom properties to modules like APIs.
+     * @remarks Gets the module requested for by ID
+     * @see {@linkcode ModuleConfig} to add custom properties to modules, for example APIs.
      * @see {@linkcode RequiredModules} to remove `undefined` from the return type for a given module
      * @param id - The module ID to look up
      */
-    get<T extends string>(id: T): foundry.packages.Module & ConfiguredModule<T>;
+    get<T extends string, Options extends Collection.GetOptions | undefined = undefined>(
+      id: T,
+      { strict }?: Options,
+    ): _ModuleCollectionGet<T, Options>;
   }
 
+  /** @internal */
+  type _ModuleCollectionGet<
+    Name extends string,
+    Options extends Collection.GetOptions | undefined = undefined,
+  > = Name extends keyof RequiredModules ? _Module<Name> : Collection.GetReturnType<_MaybeActiveModule<Name>, Options>;
+
+  /** @internal */
+  type _Module<Name extends string> =
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+    { active: true } & Module & GetKey<ModuleConfig, Name, {}>;
+
+  /** @internal */
+  type _MaybeActiveModule<Name extends string> =
+    | _Module<Name>
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+    | ({ active: false } & Module & { [K in keyof GetKey<ModuleConfig, Name, {}>]?: never });
+
   namespace Model {
     /**
      * Get the configured core and system type names for a specific document type.

package/src/foundry/client/hooks.d.mts

@@ -40,11 +40,11 @@ type RenderApplicationHooks = {
 };
 
 type GetApplicationHeaderButtonsHooks = {
-  [K in ApplicationName as `get${K}HeaderButtons`]: Hooks.RenderApplication<ApplicationConfig[K]>;
+  [K in ApplicationName as `get${K}HeaderButtons`]: Hooks.GetApplicationHeaderButtons<ApplicationConfig[K]>;
 };
 
 type CloseApplicationHooks = {
-  [K in ApplicationName as `close${K}`]: Hooks.RenderApplication<ApplicationConfig[K]>;
+  [K in ApplicationName as `close${K}`]: Hooks.CloseApplication<ApplicationConfig[K]>;
 };
 
 type GetApplicationEntryContextHooks = {

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

@@ -1229,13 +1229,22 @@ declare namespace Document {
       }
     >;
 
+    type Invalid<D extends Document.Any> = D extends { system: unknown } ? _InvalidSystem<D> : _Invalid<D>;
+
+    /** @internal */
     // @ts-expect-error This pattern is inherently an error.
-    interface Invalid<D extends Document.Any> extends _Invalid, D {}
+    interface _InvalidSystem<D extends Document.Any> extends D {
+      // `Record<string, unknown>` is used to allow arbitrary property access since `in` checks are
+      // a nuisance.
+      _source: Record<string, unknown>;
+      system: Record<string, unknown>;
+      get invalid(): true;
+    }
 
     /** @internal */
-    interface _Invalid {
-      _source: object;
-      system?: object | undefined;
+    // @ts-expect-error This pattern is inherently an error.
+    interface _Invalid<D extends Document.Any> extends D {
+      _source: Record<string, unknown>;
       get invalid(): true;
     }
 
@@ -1458,6 +1467,42 @@ declare namespace Document {
     | (DocumentType extends "Token" ? TokenDocument.Source : never)
     | (DocumentType extends "Wall" ? WallDocument.Source : never);
 
+  type ParentForName<DocumentType extends Document.Type> =
+    | (DocumentType extends "ActiveEffect" ? ActiveEffect.Parent : never)
+    | (DocumentType extends "ActorDelta" ? ActorDelta.Parent : never)
+    | (DocumentType extends "Actor" ? Actor.Parent : never)
+    | (DocumentType extends "Adventure" ? Adventure.Parent : never)
+    | (DocumentType extends "Card" ? Card.Parent : never)
+    | (DocumentType extends "Cards" ? Cards.Parent : never)
+    | (DocumentType extends "ChatMessage" ? ChatMessage.Parent : never)
+    | (DocumentType extends "Combat" ? Combat.Parent : never)
+    | (DocumentType extends "Combatant" ? Combatant.Parent : never)
+    | (DocumentType extends "CombatantGroup" ? CombatantGroup.Parent : never)
+    | (DocumentType extends "FogExploration" ? FogExploration.Parent : never)
+    | (DocumentType extends "Folder" ? Folder.Parent : never)
+    | (DocumentType extends "Item" ? Item.Parent : never)
+    | (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Parent : never)
+    | (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Parent : never)
+    | (DocumentType extends "JournalEntry" ? JournalEntry.Parent : never)
+    | (DocumentType extends "Macro" ? Macro.Parent : never)
+    | (DocumentType extends "PlaylistSound" ? PlaylistSound.Parent : never)
+    | (DocumentType extends "Playlist" ? Playlist.Parent : never)
+    | (DocumentType extends "RegionBehavior" ? RegionBehavior.Parent : never)
+    | (DocumentType extends "RollTable" ? RollTable.Parent : never)
+    | (DocumentType extends "Scene" ? Scene.Parent : never)
+    | (DocumentType extends "Setting" ? Setting.Parent : never)
+    | (DocumentType extends "TableResult" ? TableResult.Parent : never)
+    | (DocumentType extends "User" ? User.Parent : never)
+    | (DocumentType extends "AmbientLight" ? AmbientLightDocument.Parent : never)
+    | (DocumentType extends "AmbientSound" ? AmbientSoundDocument.Parent : never)
+    | (DocumentType extends "Drawing" ? DrawingDocument.Parent : never)
+    | (DocumentType extends "MeasuredTemplate" ? MeasuredTemplateDocument.Parent : never)
+    | (DocumentType extends "Note" ? NoteDocument.Parent : never)
+    | (DocumentType extends "Region" ? NoteDocument.Parent : never)
+    | (DocumentType extends "Tile" ? TileDocument.Parent : never)
+    | (DocumentType extends "Token" ? TokenDocument.Parent : never)
+    | (DocumentType extends "Wall" ? WallDocument.Parent : never);
+
   type SystemConstructor = AnyConstructor & {
     metadata: { name: SystemType };
   };

package/src/utils/index.d.mts

@@ -1,7 +1,5 @@
 import type { Document } from "../foundry/common/abstract/_module.d.mts";
 
-export {};
-
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 type ConfiguredModuleData<Name extends string> = Name extends keyof ModuleConfig ? ModuleConfig[Name] : {};
 
@@ -15,6 +13,7 @@ export type FixedInstanceType<T extends abstract new (...args: never) => any> =
   ? R
   : never;
 
+/** @deprecated Replaced with {@linkcode foundry.packages.Module.ForName | Module.ForName}, will be removed in v14 */
 export type ConfiguredModule<Name extends string> = Name extends keyof RequiredModules
   ? ConfiguredModuleData<Name>
   :