@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250922171059 → 13.346.0-beta.20250924172319

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

package/src/foundry/client/documents/collections/compendium-collection.d.mts

@@ -372,13 +372,15 @@ declare namespace CompendiumCollection {
   }
 
   // The type that's passed to `new CompendiumCollection(...)`
-  type ConstructorMetadata<Type extends CompendiumCollection.DocumentName> = Metadata<Type> & {
+  interface ConstructorMetadata<Type extends CompendiumCollection.DocumentName> extends Metadata<Type> {
     index: IndexTypeForMetadata<Type>;
-    folders: Folder.Implementation[];
-  };
+  }
 
-  // The type that appears in `compendium.metadata` after initialization.
-  interface Metadata<Type extends CompendiumCollection.DocumentName = CompendiumCollection.DocumentName> {
+  /** The type that appears in `compendium.metadata` after initialization. */
+  // Note that the `Omit` is because `delete metadata.index` and `delete metadata.folder` is called.
+  // This also deletes in `game.data` since its passed uncloned.
+  interface Metadata<Type extends CompendiumCollection.DocumentName = CompendiumCollection.DocumentName>
+    extends Omit<Game.Data.Pack, "index" | "folder"> {
     type: Type;
     label: string;
 
@@ -392,13 +394,6 @@ declare namespace CompendiumCollection {
     flags: Record<string, never>; // created by the server, but always empty and no way to change it in a way that is s
     ownership: foundry.packages.BasePackage.OwnershipRecord;
     path: string;
-    package: string;
-    system: string;
-
-    /** Added by PackageCompendiumPacks#initialize */
-    id: string;
-    packageType: string;
-    packageName: string;
   }
 
   interface GetIndexOptions<Type extends DocumentName> {

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

@@ -716,7 +716,8 @@ declare namespace Game {
     warning: string[];
   }
 
-  type Data = {
+  /** @internal */
+  type _Data = {
     activeUsers: string[];
     addresses: {
       local: string;
@@ -755,17 +756,7 @@ declare namespace Game {
       updateChannel: string;
     };
     packageWarnings: Record<string, PackageWarning>;
-    packs: Array<
-      PackageCompendiumData & {
-        /** @deprecated since v11 */
-        private?: boolean;
-        system?: string | undefined;
-        type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-        packageName: BasePackage["_source"]["id"];
-        packageType: BasePackage["type"];
-        id: string;
-      }
-    >;
+    packs: Array<Data.Pack>;
     paused: boolean;
     release: foundry.config.ReleaseData["_source"];
     system: foundry.packages.System["_source"];
@@ -788,6 +779,45 @@ declare namespace Game {
     >["_source"][];
   };
 
+  interface Data extends _Data {}
+
+  namespace Data {
+    interface Pack extends PackageCompendiumData {
+      /** @deprecated since v11 */
+      private?: boolean | undefined;
+      system?: string | undefined;
+      type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
+      packageName: BasePackage["_source"]["id"];
+      packageType: BasePackage["type"];
+      id: string;
+
+      /**
+       * @remarks This property is deleted right before `setup` is called, most likely inadvertently.
+       * This is ultimately because `CompendiumCollection` is passed a reference to an object in
+       * `game.data.packs` and calls `delete metadata.index` and `delete metadata.folders`.
+       *
+       * Specifically `Game#setupGame` calls `Game#setupPacks` and initializes `CompendiumCollection`
+       * with `new CompendiumCollection(metadata)` where `metadata` is defined from
+       * `for ( const metadata of this.data.packs ) {`.
+       */
+      // TODO(LukeAbby): Technically should be updated with compendium index types.
+      // It's probably not worth it because it is deleted after setup.
+      index?: { _id: string; uuid: string } & Record<string, unknown>;
+
+      /**
+       * @remarks This property is deleted after `setup`, most likely inadvertently.
+       * This is ultimately because `CompendiumCollection` is passed a reference to an object in
+       * `game.data.packs` and calls `delete metadata.index` and `delete metadata.folders`.
+       *
+       * Specifically `Game#setupGame` calls `Game#setupPacks` and initializes `CompendiumCollection`
+       * with `new CompendiumCollection(metadata)` where `metadata` is defined from
+       * `for ( const metadata of this.data.packs ) {`.
+       */
+      // TODO(LukeAbby): Technically a bit underspecified; may be more specific, though unlikely.
+      folders?: Folder.Source[];
+    }
+  }
+
   type Permissions = {
     [Key in keyof typeof foundry.CONST.USER_PERMISSIONS]: foundry.CONST.USER_ROLES[];
   };