@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250829013804 → 13.346.0-beta.20250901211521

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

package/src/foundry/client/applications/ui/hotbar.d.mts

@@ -57,6 +57,13 @@ declare class Hotbar<
    */
   protected _getContextMenuOptions(): foundry.applications.ux.ContextMenu.Entry<HTMLElement>[];
 
+  /**
+   * Update the presented state of toggle buttons.
+   * @internal
+   * @remarks Called externally in {@linkcode foundry.applications.sidebar.tabs.PlaylistDirectory._onGlobalVolume | PlaylistDirectory#_onGlobalVolume}
+   */
+  _updateToggles(): void;
+
   /**
    * Change to a specific numbered page from 1 to 5
    * @param page - The page number to change to

package/src/foundry/client/documents/abstract/client-document.d.mts

@@ -635,6 +635,7 @@ declare global {
       // eslint-disable-next-line @typescript-eslint/no-empty-object-type
     > = _ToCompendiumReturnType<DocumentName, Coalesce<Options, {}>>;
 
+    // TODO: `ownership` and the `_stats` sources are recursively removed from descendent document sources, not just the top level
     type _ToCompendiumReturnType<DocumentName extends Document.Type, Options extends ToCompendiumOptions> = _ClearFog<
       Options["clearState"],
       _ClearStats<

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

@@ -53,7 +53,7 @@ declare class CompendiumCollection<
 
   /**
    * A reference to the Application class which provides an interface to interact with this compendium content.
-   * @defaultValue `Compendium`
+   * @defaultValue {@linkcode foundry.applications.sidebar.apps.Compendium}
    */
   applicationClass: Application.AnyConstructor | ApplicationV2.AnyConstructor;
 
@@ -97,6 +97,7 @@ declare class CompendiumCollection<
 
   /**
    * The visibility configuration of this compendium pack.
+   * @remarks Foundry wants this to be {@linkcode CompendiumCollection.OwnershipData} (omitting the `NONE` key), but due to {@link https://github.com/foundryvtt/foundryvtt/issues/13354} it's not
    */
   get ownership(): BasePackage.OwnershipRecord;
 
@@ -272,9 +273,6 @@ declare class CompendiumCollection<
    */
   configure(configuration?: CompendiumCollection.Configuration): Promise<void>;
 
-  /** @deprecated The `ownership` key is currently non-functional, see {@link https://github.com/foundryvtt/foundryvtt/issues/13283} */
-  configure(configuration: CompendiumCollection.ConfigurationBroken): Promise<void>;
-
   /**
    * Delete an existing world-level Compendium Collection.
    * This action may only be performed for world-level packs by a Gamemaster User.
@@ -313,6 +311,16 @@ declare namespace CompendiumCollection {
 
   type DocumentName = CONST.COMPENDIUM_DOCUMENT_TYPES;
 
+  /** @internal */
+  type _OwnershipChoices = (keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS)[];
+
+  interface OwnershipFieldSchema extends fields.DataSchema {
+    GAMEMASTER: fields.StringField<{ required: true; choices: ["OWNER"]; initial: "OWNER" }>;
+    ASSISTANT: fields.StringField<{ required: true; choices: _OwnershipChoices; initial: "OWNER" }>;
+    TRUSTED: fields.StringField<{ required: true; choices: _OwnershipChoices; initial: "INHERIT" }>;
+    PLAYER: fields.StringField<{ required: true; choices: _OwnershipChoices; initial: "INHERIT" }>;
+  }
+
   interface ConfigSettingElementSchema extends fields.DataSchema {
     /**
      * @defaultValue `undefined`
@@ -338,7 +346,7 @@ declare namespace CompendiumCollection {
     /** @remarks Is the compendium edit lock engaged? */
     locked: fields.BooleanField<{ required: false; initial: undefined }>;
 
-    // Presumably the resolution to https://github.com/foundryvtt/foundryvtt/issues/13283 will be a CompendiumOwnershipField here
+    ownership: fields.SchemaField<OwnershipFieldSchema, { required: false; initial: undefined }>;
   }
 
   interface StoredConfiguration extends fields.SchemaField.InitializedData<ConfigSettingElementSchema> {}
@@ -346,18 +354,6 @@ declare namespace CompendiumCollection {
   /** @remarks The partial'd interface for passing to {@linkcode CompendiumCollection.configure}, if you want the stored interface see {@linkcode CompendiumCollection.StoredConfiguration} */
   interface Configuration extends InexactPartial<StoredConfiguration> {}
 
-  /** @internal */
-  type _Ownership = InexactPartial<{
-    /**
-     * @deprecated As of 13.347, an implementation change has rendered this key (presumably temporarily) non-functional
-     * (see {@link https://github.com/foundryvtt/foundryvtt/issues/13283}).
-     */
-    ownership: foundry.packages.BasePackage.OwnershipRecord;
-  }>;
-
-  /** @privateRemarks See {@linkcode _Ownership.ownership} */
-  interface ConfigurationBroken extends Configuration, _Ownership {}
-
   type SettingFieldElement = fields.SchemaField<ConfigSettingElementSchema>;
 
   type SettingField = fields.TypedObjectField<SettingFieldElement>;
@@ -365,6 +361,9 @@ declare namespace CompendiumCollection {
   interface SettingData
     extends fields.TypedObjectField.InitializedType<SettingFieldElement, fields.TypedObjectField.DefaultOptions> {}
 
+  /** @remarks Currently unused due to {@link https://github.com/foundryvtt/foundryvtt/issues/13354} */
+  type OwnershipData = NonNullable<SettingData["ownership"]>;
+
   // The type that's passed to `createCompendium`.
   interface CreateCompendiumMetadata<Type extends DocumentName> {
     type: Type;

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

@@ -699,7 +699,7 @@ declare namespace Scene {
 
   interface EnvironmentSchema extends DataSchema {
     /**
-     * The environment darkness level.
+     * The ambient darkness level in this Scene, where 0 represents midday (maximum illumination) and 1 represents midnight (maximum darkness)
      * @defaultValue `0`
      */
     darknessLevel: fields.AlphaField<{ initial: 0 }>;
@@ -721,64 +721,64 @@ declare namespace Scene {
       enabled: fields.BooleanField<{ required: true; initial: false }>;
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.alpha}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.alpha}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       alpha: LightData.Schema["alpha"];
 
       /**
        * Is the global light in bright mode?
        * @defaultValue `false`
-       * @remarks This is `boolean` here instead {@linkcode foundry.data.LightData} schema's `number`, because the global light has infinite range
+       * @remarks This is `boolean` here instead {@linkcode LightData} schema's `number`, because the global light has infinite range
        */
       bright: fields.BooleanField<{ required: true; initial: false }>;
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.color}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.color}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       color: LightData.Schema["color"];
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.coloration}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.coloration}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       coloration: LightData.Schema["coloration"];
 
       /**
        * The luminosity applied in the shader
        * @defaultValue `0`
-       * @remarks Doesn't pull from the {@linkcode foundry.data.LightData} schema, unlike its siblings, as it has a different `initial`
+       * @remarks Doesn't pull from the {@linkcode LightData} schema, unlike its siblings, as it has a different `initial`
        */
       luminosity: fields.NumberField<{ required: true; nullable: false; initial: 0; min: 0; max: 1 }>;
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.saturation}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.saturation}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       saturation: LightData.Schema["saturation"];
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.contrast}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.contrast}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       contrast: LightData.Schema["contrast"];
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.shadows}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.shadows}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       shadows: LightData.Schema["shadows"];
 
       /**
-       * @see {@linkcode foundry.data.LightData.Schema.darkness}
-       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode foundry.data.LightData} schema
+       * @see {@linkcode LightData.Schema.darkness}
+       * @privateRemarks The field is defined in Foundry by pulling from the {@linkcode LightData} schema
        */
       darkness: LightData.Schema["darkness"];
     }>;
 
     /**
-     * If cycling between Night and Day is activated.
+     * If cycling between {@linkcode base} and {@linkcode dark} is activated.
      * @defaultValue `true`
      */
     cycle: fields.BooleanField<{ initial: true }>;

package/src/foundry/common/packages/base-package.d.mts

@@ -83,9 +83,8 @@ declare namespace BasePackage {
     flags: fields.ObjectField;
   }
 
-  type OwnershipRecord = Record<
-    keyof typeof CONST.USER_ROLES,
-    keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | undefined
+  type OwnershipRecord = InexactPartial<
+    Record<keyof typeof CONST.USER_ROLES, keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS>
   >;
 
   interface PackageCompendiumSchema extends DataSchema {