@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts

@@ -1,3 +1,5 @@
+import type ContextMenu from "#client-esm/applications/ux/context-menu.mjs";
+import type { DeepPartial } from "../../../../../utils/index.d.mts";
 import type ApplicationV2 from "../../api/application.d.mts";
 import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
 import type AbstractSidebarTab from "../sidebar-tab.d.mts";
@@ -10,10 +12,249 @@ declare class CombatTracker<
   RenderContext extends CombatTracker.RenderContext = CombatTracker.RenderContext,
   Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {}
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {
+  static override tabName: "combat";
+
+  // leaving out DEFAULT_OPTIONS and PARTS
+
+  /**
+   * The list combats applicable to the active Scene.
+   */
+  get combats(): Combat.Stored[];
+
+  /**
+   * Record the currently tracked combat encounter.
+   */
+  get viewed(): Combat.Stored | null;
+
+  set viewed(combat);
+
+  protected override _configureRenderOptions(options: DeepPartial<RenderOptions>): void;
+
+  /**
+   * Format a tooltip for displaying overflowing effects
+   * @param effects - The effect names and icons.
+   */
+  protected _formatEffectsTooltip(effects: CombatTracker.EffectContext[]): void;
+
+  /**
+   * Retrieve a source image for a combatant. If it is a video, use the first frame.
+   * @param combatant - The Combatant.
+   * @returns The image URL.
+   */
+  protected _getCombatantThumbnail(combatant: Combatant.Stored): Promise<string>;
+
+  protected override _onFirstRender(
+    context: DeepPartial<RenderContext>,
+    options: DeepPartial<RenderOptions>,
+  ): Promise<void>;
+
+  protected override _preparePartContext(
+    partId: string,
+    context: HandlebarsApplicationMixin.HandlebarsApplication.RenderContextFor<this>,
+    options: RenderOptions,
+  ): Promise<HandlebarsApplicationMixin.HandlebarsApplication.RenderContextFor<this>>;
+
+  /**
+   * Prepare render context for the footer part.
+   */
+  protected _prepareCombatContext(context: RenderContext, options: RenderOptions): Promise<CombatTracker.CombatContext>;
+
+  /**
+   * Prepare render context for the tracker part.
+   */
+  protected _prepareTrackerContext(
+    context: RenderContext,
+    options: RenderOptions,
+  ): Promise<CombatTracker.TrackerContext | void>;
+
+  /**
+   * Prepare render context for a single entry in the combat tracker.
+   * @param combat    - The active combat.
+   * @param combatant - The Combatant whose turn is being prepared.
+   * @param index     - The index of this entry in the turn order.
+   */
+  protected _prepareTurnContext(
+    combat: Combat.Stored,
+    combatant: Combatant.Stored,
+    index: number,
+  ): Promise<CombatTracker.TurnContext>;
+
+  protected override _attachFrameListeners(): void;
+
+  /**
+   * Get context menu entries for Combatants in the tracker.
+   */
+  protected _getEntryContextOptions(): ContextMenu.Entry<HTMLElement>[];
+
+  /**
+   * Get context menu entries for Combat in the tracker.
+   */
+  protected _getCombatContextOptions(): ContextMenu.Entry<HTMLElement>[];
+
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
+  protected override _onClickAction(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<void>;
+
+  /**
+   * Cycle to a different combat encounter in the tracker.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatCycle(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<Combat.Stored>;
+
+  /**
+   * Create a new combat.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatCreate(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<void>;
+
+  /**
+   * Handle performing some action for an individual combatant.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatantControl(event: PointerEvent, target: ApplicationV2.ActionTarget): Promise<unknown>;
+
+  /**
+   * Handle hovering over a combatant in the tracker.
+   * @param event - The triggering event
+   */
+  protected _onCombatantHoverIn(event: PointerEvent): void;
+
+  /**
+   * Handle hovering out a combatant in the tracker.
+   * @param event - The triggering event
+   */
+  protected _onCombatantHoverOut(event: PointerEvent): void;
+
+  /**
+   * Handle activating a combatant in the tracker.
+   * @param event  - The triggering event.
+   * @param target - The action target element.
+   */
+  protected _onCombatantMouseDown(event: PointerEvent, target: ApplicationV2.ActionTarget): void;
+
+  /**
+   * Handle panning to a combatant's token.
+   * @param combatant - The combatant.
+   */
+  protected _onPanToCombatant(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle pinging a combatant's token.
+   * @param combatant - The combatant.
+   */
+  protected _onPingCombatant(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle rolling initiative for a single combatant.
+   * @param combatant - The combatant.
+   */
+  protected _onRollInitiative(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle toggling the defeated status effect on a combatant token.
+   * @param combatant - The combatant.
+   */
+  protected _onToggleDefeatedStatus(combatant: Combatant.Stored): void;
+
+  /**
+   * Toggle a combatant's hidden state in the tracker.
+   * @param combatant - The combatant.
+   */
+  protected _onToggleHidden(combatant: Combatant.Stored): void;
+
+  /**
+   * Handle updating a combatant's initiative in-sheet.
+   * @param event - The triggering change event.
+   */
+  protected _onUpdateInitiative(event: Event): void;
+
+  /**
+   * Highlight a hovered combatant in the tracker.
+   * @param combatant - The Combatant.
+   * @param hover     - Whether they are being hovered in or out.
+   */
+  hoverCombatant(combatant: Combatant.Stored, hover: boolean): void;
+
+  /**
+   * Is the token of the combatant visible?
+   * @param token - The token of the combatant
+   * @returns Is the token visible?
+   */
+  protected _isTokenVisible(token: Token.Implementation): boolean;
+
+  /**
+   * Scroll to the current combatant in the combat log.
+   */
+  scrollToTurn(): void;
+
+  /**
+   * @deprecated since v13, will be removed in v13
+   * @remarks "CombatTracker#initialize is deprecated.
+   * The currently viewed combat can be changed by assigning to ui.combat.viewed directly,
+   * passed as an option to ui.combat.render, or by setting a Combat as active.
+   */
+  initialize(options: unknown): void;
+}
 
 declare namespace CombatTracker {
   interface RenderContext extends AbstractSidebarTab.RenderContext {}
+
+  interface EffectContext {
+    name: string;
+    img: string;
+  }
+
+  interface CombatContext {
+    combat: Combat.Stored | null;
+    hasCombat: boolean;
+    combats: CombatsRow[];
+    control: boolean;
+    css: string;
+    currentIndex: number;
+    displayCycle: boolean;
+    initiativeIcon: string;
+    link: boolean;
+    labels: CombatLabels;
+  }
+
+  interface CombatsRow {
+    id: string;
+    label: number;
+    active: boolean;
+  }
+
+  interface CombatLabels {
+    scope: string;
+  }
+
+  interface TrackerContext {
+    turns: TurnContext[];
+    hasDecimals: boolean;
+  }
+
+  interface TurnContext {
+    hasDecimals: boolean;
+    hidden: boolean;
+    id: string;
+    isDefeated: boolean;
+    initiative: number | null;
+    isOwner: boolean;
+    name: string;
+    resource: Combatant.Resource;
+    active: boolean;
+    canPing: boolean;
+    img: string;
+    css: string;
+    effects: TurnEffects;
+  }
+
+  interface TurnEffects {
+    icons: EffectContext[];
+    tooltip: string;
+  }
 }
 
 export default CombatTracker;

package/src/foundry/client-esm/applications/sidebar/tabs/item-directory.d.mts

@@ -9,7 +9,7 @@ declare class ItemDirectory<
   RenderContext extends ItemDirectory.RenderContext = ItemDirectory.RenderContext,
   Configuration extends ItemDirectory.Configuration = ItemDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<Item.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<Item.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace ItemDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/sidebar/tabs/journal-directory.d.mts

@@ -9,7 +9,7 @@ declare class JournalDirectory<
   RenderContext extends JournalDirectory.RenderContext = JournalDirectory.RenderContext,
   Configuration extends JournalDirectory.Configuration = JournalDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<JournalEntry.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<JournalEntry.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace JournalDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/sidebar/tabs/macro-directory.d.mts

@@ -9,7 +9,7 @@ declare class MacroDirectory<
   RenderContext extends MacroDirectory.RenderContext = MacroDirectory.RenderContext,
   Configuration extends MacroDirectory.Configuration = MacroDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<Macro.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<Macro.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace MacroDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/sidebar/tabs/playlist-directory.d.mts

@@ -9,7 +9,7 @@ declare class PlaylistDirectory<
   RenderContext extends PlaylistDirectory.RenderContext = PlaylistDirectory.RenderContext,
   Configuration extends PlaylistDirectory.Configuration = PlaylistDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<Playlist.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<Playlist.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace PlaylistDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/sidebar/tabs/roll-table-directory.d.mts

@@ -9,7 +9,7 @@ declare class RollTableDirectory<
   RenderContext extends RollTableDirectory.RenderContext = RollTableDirectory.RenderContext,
   Configuration extends RollTableDirectory.Configuration = RollTableDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<RollTable.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<RollTable.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace RollTableDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/sidebar/tabs/scene-directory.d.mts

@@ -9,7 +9,7 @@ declare class SceneDirectory<
   RenderContext extends SceneDirectory.RenderContext = SceneDirectory.RenderContext,
   Configuration extends SceneDirectory.Configuration = SceneDirectory.Configuration,
   RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends DocumentDirectory<Scene.ConfiguredClass, RenderContext, Configuration, RenderOptions> {}
+> extends DocumentDirectory<Scene.ImplementationClass, RenderContext, Configuration, RenderOptions> {}
 
 declare namespace SceneDirectory {
   interface RenderContext extends DocumentDirectory.RenderContext {}

package/src/foundry/client-esm/applications/ui/region-legend.d.mts

@@ -45,7 +45,7 @@ export default class RegionLegend<
    * @param region - The Region
    * @internal
    */
-  _isRegionVisible(region: RegionDocument.ConfiguredInstance): boolean;
+  _isRegionVisible(region: RegionDocument.Implementation): boolean;
 
   /**
    * Highlight a hovered region in the legend.
@@ -53,5 +53,5 @@ export default class RegionLegend<
    * @param hover   - Whether they are being hovered in or out
    * @internal
    */
-  _hoverRegion(region: RegionDocument.ConfiguredInstance, hover: boolean): void;
+  _hoverRegion(region: RegionDocument.Implementation, hover: boolean): void;
 }

package/src/foundry/client-esm/applications/ux/context-menu.d.mts

@@ -1,5 +1,4 @@
-import type { InexactPartial } from "../../../../utils/index.d.mts";
-import type ApplicationV2 from "../api/application.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -12,17 +11,16 @@ declare global {
  * Display a right-click activated Context Menu which provides a dropdown menu of options.
  * A ContextMenu is constructed by designating a parent HTML container and a target selector.
  * An Array of menuItems defines the entries of the menu which is displayed.
- * TODO: Rework again; this was written for 13.337
  */
 declare class ContextMenu<UsesJQuery extends boolean = true> {
   /**
-   * @param element   - The containing HTML element within which the menu is positioned
+   * @param container   - The containing HTML element within which the menu is positioned
    * @param selector  - A CSS selector which activates the context menu.
    * @param menuItems - An Array of entries to display in the menu
    * @param options   - Additional options to configure the context menu.
    */
   constructor(
-    element: JQuery | HTMLElement,
+    container: HTMLElement,
     selector: string | null | undefined,
     menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
     options: ContextMenu.ConstructorOptions<UsesJQuery>,
@@ -34,7 +32,35 @@ declare class ContextMenu<UsesJQuery extends boolean = true> {
    * In v14 the default will become false."
    */
   constructor(
-    element: JQuery | HTMLElement,
+    element: JQuery,
+    selector: string | null | undefined,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options: ContextMenu.ConstructorOptions<UsesJQuery>,
+  );
+
+  /**
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects for menu item callbacks.
+   * Because the jQuery option provided to the ContextMenu constructor was undefined, your  callbacks will receive jQuery objects.
+   * You may opt-out and receive HTMLElement references instead by passing jQuery: false to the constructor.
+   * This parameter will be false by default in v14 and deprecated entirely in v15 at which point only HTMLElement references will be used."
+   */
+  constructor(
+    element: HTMLElement,
+    selector: string | null | undefined,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options?: InexactPartial<ContextMenu.ConstructorOptions<UsesJQuery>, "jQuery">,
+  );
+
+  /**
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects. You must begin passing an HTMLElement instead."
+   *
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects for menu item callbacks.
+   * Because the jQuery option provided to the ContextMenu constructor was undefined, your  callbacks will receive jQuery objects.
+   * You may opt-out and receive HTMLElement references instead by passing jQuery: false to the constructor.
+   * This parameter will be false by default in v14 and deprecated entirely in v15 at which point only HTMLElement references will be used."
+   */
+  constructor(
+    element: JQuery,
     selector: string | null | undefined,
     menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
     options?: InexactPartial<ContextMenu.ConstructorOptions<UsesJQuery>, "jQuery">,
@@ -51,60 +77,52 @@ declare class ContextMenu<UsesJQuery extends boolean = true> {
    */
   static create<UsesJQuery extends boolean = true>(
     app: Application.Any,
-    html: JQuery | HTMLElement,
+    html: HTMLElement,
     selector: string,
     menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
     options: ContextMenu.CreateOptions<UsesJQuery>,
   ): ContextMenu<UsesJQuery>;
 
   /**
-   * @deprecated "ContextMenu is changing to no longer transact jQuery objects.
-   * You may temporarily pass the jQuery option to nominate a behavior.
-   * In v14 the default will become false."
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects for menu item callbacks.
+   * Because the jQuery option provided to the ContextMenu constructor was undefined, your  callbacks will receive jQuery objects.
+   * You may opt-out and receive HTMLElement references instead by passing jQuery: false to the constructor.
+   * This parameter will be false by default in v14 and deprecated entirely in v15 at which point only HTMLElement references will be used."
    */
   static create(
     app: Application.Any,
-    html: JQuery | HTMLElement,
+    html: HTMLElement,
     selector: string,
     menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<true>>[],
     options?: InexactPartial<ContextMenu.CreateOptions<true>, "jQuery">,
   ): ContextMenu<true>;
 
   /**
-   * @deprecated - `ContextMenu.create` no longer accepts the menuItems argument for ApplicationV2 applications.
-   * Instead it calls the `_get${hookName}Options` function, which defaults to `_getEntryContextOptions`
-   *
-   * @deprecated - "ContextMenu is changing to no longer transact jQuery objects.
-   * You may temporarily pass the jQuery option to nominate a behavior.
-   * In v14 the default will become false."
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects. You must begin passing an HTMLElement instead."
    */
   static create<UsesJQuery extends boolean = true>(
-    app: ApplicationV2.Any,
-    html: JQuery | HTMLElement,
+    app: Application.Any,
+    html: JQuery,
     selector: string,
     menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
-    options?: InexactPartial<ContextMenu.CreateOptions<UsesJQuery>, "jQuery">,
+    options: ContextMenu.CreateOptions<UsesJQuery>,
   ): ContextMenu<UsesJQuery>;
 
   /**
-   * @deprecated - "ContextMenu is changing to no longer transact jQuery objects.
-   * You may temporarily pass the jQuery option to nominate a behavior.
-   * In v14 the default will become false."
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects for menu item callbacks.
+   * Because the jQuery option provided to the ContextMenu constructor was undefined, your  callbacks will receive jQuery objects.
+   * You may opt-out and receive HTMLElement references instead by passing jQuery: false to the constructor.
+   * This parameter will be false by default in v14 and deprecated entirely in v15 at which point only HTMLElement references will be used."
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects. You must begin passing an HTMLElement instead."
    */
   static create(
-    app: ApplicationV2.Any,
-    html: JQuery | HTMLElement,
+    app: Application.Any,
+    html: JQuery,
     selector: string,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<true>>[],
     options?: InexactPartial<ContextMenu.CreateOptions<true>, "jQuery">,
   ): ContextMenu<true>;
 
-  static create<UsesJQuery extends boolean = true>(
-    app: ApplicationV2.Any,
-    html: JQuery | HTMLElement,
-    selector: string,
-    options: ContextMenu.CreateOptions<UsesJQuery>,
-  ): ContextMenu<UsesJQuery>;
-
   /**
    * The menu element.
    */
@@ -112,11 +130,13 @@ declare class ContextMenu<UsesJQuery extends boolean = true> {
 
   /**
    * A CSS selector to identify context menu targets.
+   * @defaultValue `container.attr("id")`
    */
   get selector(): string;
 
   /**
    * The event name to listen for.
+   * @defaultValue `"contextmenu"`
    */
   get eventName(): string;
 
@@ -233,15 +253,15 @@ declare class ContextMenu<UsesJQuery extends boolean = true> {
 
   /**
    * @deprecated since v13 until v15
-   * @remarks "ContextMenu#menu is deprecated. Please use ContextMenu#element instead."
+   * @remarks ""ContextMenu#_expandUp is deprecated. Please use ContextMenu#expandUp instead."
    */
-  get menu(): JQuery;
+  get _expandUp(): boolean;
 
   /**
    * @deprecated since v13 until v15
-   * @remarks ""ContextMenu#_expandUp is deprecated. Please use ContextMenu#expandUp instead."
+   * @remarks "ContextMenu#menu is deprecated. Please use ContextMenu#element instead."
    */
-  get _expandUp(): boolean;
+  get menu(): JQuery;
 
   #private: true;
 }

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 export {};
 
 // After seeing that none of these types add anything or are even exported a

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

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "fvtt-types/utils";
+import type { Identity, InexactPartial, NullishProps } from "fvtt-types/utils";
 
 /**
  * A sound effect which applies a biquad filter.
@@ -9,22 +9,8 @@ declare class BiquadFilterEffect extends BiquadFilterNode {
    * @param context - The audio context required by the BiquadFilterNode
    * @param options - Additional options which modify the BiquadFilterEffect behavior
    */
-  constructor(
-    context: AudioContext,
-    options?: InexactPartial<{
-      /**
-       * The filter type to apply
-       * @defaultValue `"lowpass"`
-       */
-      type: BiquadFilterType;
-
-      /**
-       * The initial intensity of the effect
-       * @defaultValue `5`
-       */
-      intensity: number;
-    }>,
-  );
+  // options: not null (destructured)
+  constructor(context: AudioContext, options?: BiquadFilterEffect.ConstructorOptions);
 
   /**
    * Adjust the intensity of the effect on a scale of 0 to 10
@@ -36,16 +22,80 @@ 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"`
    */
-  update(
-    options?: InexactPartial<{
-      /** A new effect intensity */
-      intensity: number;
-
-      /** A new filter type */
-      type: BiquadFilterType;
-    }>,
-  ): void;
+  // options: not null (destructured)
+  update(options?: BiquadFilterEffect.UpdateOptions): void;
+}
+
+declare namespace BiquadFilterEffect {
+  interface Any extends AnyBiquadFilterEffect {}
+  interface AnyConstructor extends Identity<typeof AnyBiquadFilterEffect> {}
+
+  /**
+   * @internal
+   * Foundry keeps this specific list in a private static property of {@link BiquadFilterEffect | `BiquadFilterEffect`}.
+   * It is typed as it is to make obvious where it comes from.
+   *
+   * @privateRemarks An `Exclude` would have been shorter but for all we know the lib type might change, this is reliable
+   */
+  type AspirationalAllowedFilterType = Extract<
+    "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch",
+    BiquadFilterType
+  >;
+
+  /**
+   * @remarks Despite `BiquadFilterEffect.#ALLOWED_TYPES` containing everything in the Aspirational
+   * type, the runtime logic will throw on anything but these two values
+   */
+  type AllowedFilterType = Extract<"highpass" | "lowpass", AspirationalAllowedFilterType>;
+
+  /** @internal */
+  type _ConstructorOptions = InexactPartial<{
+    /**
+     * 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 {@link BiquadFilterType | `BiquadFilterType`}s
+     */
+    type: AllowedFilterType;
+  }>;
+
+  /**
+   * @privateRemarks The {@link BiquadFilterEffect | `BiquadFilterEffect`} constructor only adds the one
+   * new property (`intensity`) to the parent interface. `type` is omitted and reimplemented to allow
+   * explicit `undefined`, as there's a parameter default available, and limit to Foundry's allowed values
+   */
+  interface ConstructorOptions extends _ConstructorOptions, Omit<BiquadFilterOptions, "type"> {}
+
+  type _UpdateOptions = NullishProps<{
+    /**
+     * A new effect intensity
+     * @remarks This is ignored if it fails a `Number.isFinite` check
+     */
+    intensity: number;
+
+    /**
+     * A new filter type
+     * @see {@link BiquadFilterEffect.AllowedFilterType | `BiquadFilterEffect.AllowedFilterType`}
+     * @see {@link BiquadFilterEffect.AspirationalAllowedFilterType | `BiquadFilterEffect.AspirationalAllowedFilterType`}
+     */
+    type: AllowedFilterType;
+  }>;
+
+  interface UpdateOptions extends _UpdateOptions {}
 }
 
 export default BiquadFilterEffect;
+
+declare abstract class AnyBiquadFilterEffect extends BiquadFilterEffect {
+  constructor(...args: never);
+}