fvtt-types/src/foundry/client/applications/apps/combat-tracker-config.d.mts

TypeScript type definitions for Foundry VTT

import type ApplicationV2 from "../api/application.d.mts";
import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
import type { DeepPartial, Identity } from "#utils";

declare module "#configuration" {
  namespace Hooks {
    interface ApplicationV2Config {
      CombatTrackerConfig: CombatTrackerConfig.Any;
    }
  }
}

/**
 * The Application responsible for configuring the CombatTracker and its contents.
 * @remarks TODO: Stub
 */
declare class CombatTrackerConfig<
  RenderContext extends CombatTrackerConfig.RenderContext = CombatTrackerConfig.RenderContext,
  Configuration extends CombatTrackerConfig.Configuration = CombatTrackerConfig.Configuration,
  RenderOptions extends CombatTrackerConfig.RenderOptions = CombatTrackerConfig.RenderOptions,
> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
  static override DEFAULT_OPTIONS: CombatTrackerConfig.DefaultOptions;
}

declare namespace CombatTrackerConfig {
  interface Any extends AnyCombatTrackerConfig {}
  interface AnyConstructor extends Identity<typeof AnyCombatTrackerConfig> {}

  /**
   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
   * inherit context from its parent class.
   */
  interface RenderContext {
    rootId: string;
  }

  interface Configuration<CombatTrackerConfig extends CombatTrackerConfig.Any = CombatTrackerConfig.Any>
    extends HandlebarsApplicationMixin.Configuration,
      ApplicationV2.Configuration<CombatTrackerConfig> {}

  // Note(LukeAbby): This `& object` is so that the `DEFAULT_OPTIONS` can be overridden more easily
  // Without it then `static override DEFAULT_OPTIONS = { unrelatedProp: 123 }` would error.
  type DefaultOptions<CombatTrackerConfig extends CombatTrackerConfig.Any = CombatTrackerConfig.Any> = DeepPartial<
    Configuration<CombatTrackerConfig>
  > &
    object;

  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
}

declare abstract class AnyCombatTrackerConfig extends CombatTrackerConfig<
  CombatTrackerConfig.RenderContext,
  CombatTrackerConfig.Configuration,
  CombatTrackerConfig.RenderOptions
> {}

export default CombatTrackerConfig;