@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250824190511 → 13.346.0-beta.20250825020008

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

package/src/configuration/configuration.d.mts

@@ -266,9 +266,7 @@ export interface SettingConfig {
   "core.chatBubbles": fields.BooleanField<{ initial: true }>;
   "core.chatBubblesPan": fields.BooleanField<{ initial: true }>;
   "core.combatTrackerConfig": MaybeEmpty<{ resource: string; skipDefeated: boolean }>;
-  "core.compendiumConfiguration": Partial<
-    Record<string, foundry.documents.collections.CompendiumCollection.Configuration>
-  >;
+  "core.compendiumConfiguration": foundry.documents.collections.CompendiumCollection.SettingField;
   "core.gridTemplates": fields.BooleanField<{ initial: false }>;
   "core.coneTemplateType": "round" | "flat";
   "core.colorSchema": fields.StringField<{
@@ -297,9 +295,9 @@ export interface SettingConfig {
   "core.disableResolutionScaling": boolean;
   "core.fontSize": number;
   "core.fpsMeter": boolean;
-  "core.globalAmbientVolume": number;
-  "core.globalInterfaceVolume": number;
-  "core.globalPlaylistVolume": number;
+  "core.globalAmbientVolume": fields.AlphaField<{ required: true; initial: 0.5 }>;
+  "core.globalInterfaceVolume": fields.AlphaField<{ required: true; initial: 0.5 }>;
+  "core.globalPlaylistVolume": fields.AlphaField<{ required: true; initial: 0.5 }>;
   "core.keybindings": Record<string, foundry.helpers.interaction.ClientKeybindings.KeybindingActionBinding[]>;
   "core.language": fields.StringField<{
     required: true;

package/src/configuration/globals.d.mts

@@ -12,7 +12,7 @@
 
 // eslint-disable-next-line import-x/no-named-default
 import { default as AlphaBlurFilter, AlphaBlurFilterPass } from "#client/canvas/rendering/filters/blur.mjs";
-import { ShaderField } from "#client/canvas/perception/vision-mode.mjs";
+import { ShaderField } from "#client/data/fields.mjs";
 import { DarknessLevelContainer } from "#client/canvas/layers/_module.mjs";
 
 export import AVSettings = globalThis.AVSettings;

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

@@ -81,9 +81,9 @@ type ManageCompendiumRequest = unknown;
 
 type ManageCompendiumResponse = unknown;
 
-type WorldCompendiumPackConfiguration = unknown;
+type WorldCompendiumPackConfiguration = foundry.documents.collections.CompendiumCollection.Configuration;
 
-type WorldCompendiumConfiguration = Record<string, WorldCompendiumPackConfiguration>;
+type WorldCompendiumConfiguration = foundry.documents.collections.CompendiumCollection.SettingData;
 
 type SettingConfig = foundry.helpers.ClientSettings.SettingConfig;
 

package/src/foundry/client/applications/ui/scene-controls.d.mts

@@ -115,14 +115,34 @@ declare namespace SceneControls {
   }
 
   /**
-   * The data structure for a set of controls in the {@link SceneControls#controls} record.
+   * The data structure for a set of controls in the {@linkcode SceneControls.controls | SceneControls#controls} record.
    */
   interface Control {
+    /**
+     * A unique identifier for the control
+     */
     name: string;
+
+    /**
+     * An integer indicating the control's order, with 0 being at the top
+     */
     order: number;
+
+    /**
+     * A title for the control: can be a localization path
+     */
     title: string;
+
+    /**
+     * One or more icon classes for the control, typically Font Awesome classes such as `"fa-solid fa-face-smile"`
+     */
     icon: string;
+
+    /**
+     * Whether the control should be visible to the current User
+     */
     visible?: boolean | undefined;
+
     tools: Record<string, Tool>;
 
     /**
@@ -138,17 +158,47 @@ declare namespace SceneControls {
   }
 
   /**
-   * The data structure for a single tool in the {@link Control#tools} record.
+   * The data structure for a single tool in the {@linkcode Control.tools | Control#tools} record.
    */
   interface Tool {
+    /**
+     * An identifier for the tool, unique among the tools of its SceneControl
+     */
     name: string;
+
+    /**
+     * An integer indicating the tool's order, with 0 being at the top
+     */
     order: number;
+
+    /**
+     * A title for the tool: can be a localization path
+     */
     title: string;
+
+    /**
+     * One or more icon classes for the tool, typically Font Awesome classes such as `"fa-solid fa-face-smile"`
+     */
     icon: string;
 
+    /**
+     * Whether the tool should be visible to the current User
+     */
     visible?: boolean | undefined;
+
+    /**
+     * Is the tool an on-or-off toggle?
+     */
     toggle?: boolean | undefined;
+
+    /**
+     * Is the tool the currently the active one? Not applicable to toggles or buttons.
+     */
     active?: boolean | undefined;
+
+    /**
+     * Is the tool a "button" in the sense of immediately resolving on click without becoming the active tool?
+     */
     button?: boolean | undefined;
 
     /** A callback invoked when the tool is activated or deactivated */

package/src/foundry/client/audio/_types.d.mts

@@ -16,3 +16,14 @@ type SoundCreationOptions = foundry.audio.AudioHelper.SoundCreationOptions;
 type SoundPlaybackOptions = foundry.audio.Sound.PlaybackOptions;
 
 type SoundScheduleCallback = foundry.audio.Sound.ScheduleCallback;
+
+type AnalysisDataValue = foundry.audio.AudioHelper.AnalysisDataValue;
+
+type AnalysisData = foundry.audio.AudioHelper.AnalysisData;
+
+type ContextName = foundry.audio.AudioHelper.ContextName;
+
+type BandName = foundry.audio.AudioHelper.BandName;
+
+/** @privateRemarks We have no implementation of this type to point to because it is completely unused by core as of 13.347 */
+type AnalysisNodes = unknown;

package/src/foundry/client/audio/biquad.d.mts

@@ -1,4 +1,4 @@
-import type { Identity, InexactPartial, NullishProps } from "#utils";
+import type { Identity, InexactPartial } from "#utils";
 
 /**
  * A sound effect which applies a biquad filter.
@@ -9,7 +9,6 @@ declare class BiquadFilterEffect extends BiquadFilterNode {
    * @param context - The audio context required by the BiquadFilterNode
    * @param options - Additional options which modify the BiquadFilterEffect behavior
    */
-  // options: not null (destructured)
   constructor(context: AudioContext, options?: BiquadFilterEffect.ConstructorOptions);
 
   /**
@@ -22,10 +21,12 @@ declare class BiquadFilterEffect extends BiquadFilterNode {
   /**
    * Update the state of the effect node given the active flag and numeric intensity.
    * @param options - Options which are updated
-   * @throws If `type` is set to any value in {@link BiquadFilterEffect.AllowedFilterType} other than `"highpass"` or `"lowpass"`
+   * @remarks
+   * @throws If `type` is set to any value in {@linkcode BiquadFilterEffect.AllowedFilterType} other than `"highpass"` or `"lowpass"`
    */
-  // options: not null (destructured)
   update(options?: BiquadFilterEffect.UpdateOptions): void;
+
+  #BiquadFilterEffect: true;
 }
 
 declare namespace BiquadFilterEffect {
@@ -56,16 +57,13 @@ declare namespace BiquadFilterEffect {
     /**
      * The initial intensity of the effect
      * @defaultValue `5`
-     * @remarks Can't be `null` as it only has a parameter default
      */
     intensity: number;
 
     /**
      * The filter type to apply
      * @defaultValue `"lowpass"`
-     * @remarks Can't be `null` as it only has a parameter default.
-     *
-     * Only allows a subset of {@linkcode BiquadFilterType}s
+     * @remarks Only allows a subset of {@linkcode BiquadFilterType}s
      */
     type: AllowedFilterType;
   }>;
@@ -77,7 +75,7 @@ declare namespace BiquadFilterEffect {
    */
   interface ConstructorOptions extends _ConstructorOptions, Omit<BiquadFilterOptions, "type"> {}
 
-  type _UpdateOptions = NullishProps<{
+  type _UpdateOptions = InexactPartial<{
     /**
      * A new effect intensity
      * @remarks This is ignored if it fails a `Number.isFinite` check

package/src/foundry/client/audio/cache.d.mts

@@ -4,7 +4,7 @@ import type { Identity } from "#utils";
  * A specialized cache used for audio buffers.
  * This is an LRU cache which expires buffers from the cache once the maximum cache size is exceeded.
  */
-declare class AudioBufferCache extends Map {
+declare class AudioBufferCache extends Map<string, AudioBufferCache.Entry> {
   /**
    * Construct an AudioBufferCache providing a maximum disk size beyond which entries are expired.
    * @param cacheSize - The maximum cache size in bytes. 1GB by default.
@@ -42,10 +42,11 @@ declare class AudioBufferCache extends Map {
    * @param src    - The audio buffer source path
    * @param locked - Lock the buffer, preventing its expiration?
    */
-  // locked: not null (put directly into an Entry)
   lock(src: string, locked?: boolean): void;
 
   override toString(): string;
+
+  #AudioBufferCache: true;
 }
 
 declare namespace AudioBufferCache {

package/src/foundry/client/audio/convolver.d.mts

@@ -1,4 +1,4 @@
-import type { Identity, InexactPartial, NullishProps } from "#utils";
+import type { Identity, InexactPartial } from "#utils";
 
 declare namespace ConvolverEffect {}
 
@@ -16,7 +16,6 @@ declare class ConvolverEffect extends ConvolverNode {
    * @param context - The audio context required by the ConvolverNode
    * @param options - Additional options which modify the ConvolverEffect behavior
    */
-  // options: not null (destructured)
   constructor(context: AudioContext, options?: ConvolverEffect.ConstructorOptions);
 
   /**
@@ -30,7 +29,6 @@ declare class ConvolverEffect extends ConvolverNode {
    * Update the state of the effect node given the active flag and numeric intensity.
    * @param options - Options which are updated
    */
-  // options: not null (destructured)
   update(options?: ConvolverEffect.UpdateOptions): void;
 
   /** @privateRemarks This override only does side effects then forwards args to super, no type changes */
@@ -61,14 +59,12 @@ declare namespace ConvolverEffect {
     /**
      * The file path to the impulse response buffer to use
      * @defaultValue `"sounds/impulse-responses/ir-full.wav"`
-     * @remarks Can't be `null` as it only has a parameter default
      */
     impulseResponsePath: string;
 
     /**
      * The initial intensity of the effect
      * @defaultValue `5`
-     * @remarks Can't be `null` as it only has a parameter default
      */
     intensity: number;
   }>;
@@ -76,7 +72,7 @@ declare namespace ConvolverEffect {
   interface ConstructorOptions extends _ConstructorOptions, ConvolverOptions {}
 
   /** @internal */
-  type _UpdateOptions = NullishProps<{
+  type _UpdateOptions = InexactPartial<{
     /**
      * A new effect intensity
      * @remarks This is ignored if it fails a `Number.isFinite` check