@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

package/src/foundry/client/apps/placeables/token-config.d.ts

@@ -1,226 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { TokenBarData } from '../../../common/data/data.mjs/tokenBarData';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Token document within a parent Scene.
-   * Note that due to an oversight, this class does not inherit from {@link DocumentSheet} as it was intended to, and will
-   * be changed in v10.
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class TokenConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = TokenConfig.Data<Options>
-  > extends FormApplication<
-    Options,
-    Data,
-    InstanceType<ConfiguredDocumentClassForName<'Token'>> | InstanceType<ConfiguredDocumentClassForName<'Actor'>>
-  > {
-    constructor(
-      object:
-        | InstanceType<ConfiguredDocumentClassForName<'Token'>>
-        | InstanceType<ConfiguredDocumentClassForName<'Actor'>>,
-      options?: Partial<Options>
-    );
-
-    token: InstanceType<ConfiguredDocumentClassForName<'Token'>> | PrototypeTokenDocument;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "token-sheet"],
-     *   template: "templates/scene/token-config.html",
-     *   width: 480,
-     *   height: "auto",
-     *   tabs: [
-     *     {navSelector: '.tabs[data-group="main"]', contentSelector: "form", initial: "character"},
-     *     {navSelector: '.tabs[data-group="light"]', contentSelector: '.tab[data-tab="light"]', initial: "basic"}
-     *   ],
-     *   sheetConfig: true
-     * })
-     * ```
-     */
-    static override get defaultOptions(): FormApplicationOptions;
-
-    override get id(): string;
-
-    /**
-     * A convenience accessor to test whether we are configuring the prototype Token for an Actor.
-     */
-    get isPrototype(): boolean;
-
-    /**
-     * Convenience access to the Actor document that this Token represents
-     */
-    get actor(): InstanceType<ConfiguredDocumentClassForName<'Actor'>>;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<this>;
-
-    protected override _renderInner(...args: [Data]): Promise<JQuery>;
-
-    /**
-     * Get an Object of image paths and filenames to display in the Token sheet
-     * @internal
-     */
-    protected _getAlternateTokenImages(): Promise<Record<string, string>>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Shim for {@link DocumentSheet#_onConfigureSheet} that will be replaced in v10 when this class subclasses it.
-     * @internal
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _updateObject(event: Event, formData: TokenConfig.FormData): Promise<unknown>;
-
-    /**
-     * Handle Token assignment requests to update the default prototype Token
-     * @param event - The left-click event on the assign token button
-     * @internal
-     */
-    protected _onAssignToken(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle changing the attribute bar in the drop-down selector to update the default current and max value
-     * @internal
-     */
-    protected _onBarChange(ev: JQuery.ChangeEvent): void;
-  }
-
-  namespace TokenConfig {
-    interface Attributes {
-      bar: string[][];
-      value: string[][];
-    }
-
-    interface Data<Options extends FormApplicationOptions = FormApplicationOptions> {
-      cssClasses: string;
-      isPrototype: boolean;
-      hasAlternates: boolean;
-      alternateImages: Record<string, string> | [];
-      object: foundry.data.PrototypeTokenData | foundry.data.TokenData;
-      options: Options;
-      gridUnits: string;
-      barAttributes: Record<string, string[]>;
-      bar1: ReturnType<TokenDocument['getBarAttribute']> | undefined;
-      bar2: ReturnType<TokenDocument['getBarAttribute']> | undefined;
-      colorationTechniques: AdaptiveLightingShader.ColorationTechniques;
-      displayModes: Record<foundry.CONST.TOKEN_DISPLAY_MODES, string>;
-      actors: { _id: string; name: string }[];
-      dispositions: Record<foundry.CONST.TOKEN_DISPOSITIONS, string>;
-      lightAnimations: { [Key in keyof typeof CONFIG.Canvas.lightAnimations]: string } & { '': string };
-      isGM: boolean;
-    }
-
-    interface FormData {
-      actorId: string;
-      actorLink: boolean;
-      alternateImages?: string;
-      alpha: number;
-      'bar1.attribute': string;
-      'bar2.attribute': string;
-      brightLight: number | null;
-      brightSight: number | null;
-      dimLight: number | null;
-      dimSight: number | null;
-      displayBars: foundry.CONST.TOKEN_DISPLAY_MODES;
-      displayName: foundry.CONST.TOKEN_DISPLAY_MODES;
-      disposition: foundry.CONST.TOKEN_DISPOSITIONS;
-      elevation: number | null;
-      height: number | null;
-      img: string;
-      lightAlpha: number;
-      lightAngle: number | null;
-      'lightAnimation.intensity': number;
-      'lightAnimation.speed': number;
-      'lightAnimation.type': string;
-      lightColor: string;
-      lockRotation: boolean;
-      mirrorX: boolean;
-      mirrorY: boolean;
-      name: StringTerm;
-      rotation: number | null;
-      scale: number;
-      sightAngle: number | null;
-      tint: string;
-      vision: boolean;
-      width: number | null;
-      x: number | null;
-      y: number | null;
-    }
-  }
-
-  /**
-   * A sheet that alters the values of the default Token configuration used when new Token documents are created.
-   */
-  class DefaultTokenConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
-  > extends TokenConfig<Options, Data> {
-    constructor(object: unknown, options?: Partial<Options> | undefined);
-
-    data: foundry.data.TokenData;
-
-    object: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
-
-    token: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
-
-    /**
-     * The named world setting that stores the default Token configuration
-     * @defaultValue `"defaultToken"`
-     */
-    static SETTING: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/scene/default-token-config.html",
-     *   sheetConfig: false
-     * })
-     * ```
-     */
-    static override get defaultOptions(): FormApplicationOptions;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override getData(options: unknown): Data | Promise<Data>;
-
-    override _getSubmitData(
-      updateData?: Parameters<TokenConfig['_getSubmitData']>[0]
-    ): ReturnType<TokenConfig['_getSubmitData']>;
-
-    override _updateObject(event: Event, formData?: object): Promise<unknown>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Reset the form to default values
-     */
-    reset(): void;
-
-    protected override _onBarChange(): Promise<void>;
-  }
-
-  namespace DefaultTokenConfig {
-    interface Data<Options extends FormApplicationOptions = FormApplicationOptions>
-      extends Omit<TokenConfig.Data<Options>, 'object' | 'bar1' | 'bar2'> {
-      object: foundry.data.TokenData['_source'];
-      isDefault: true;
-      barAttributes: ReturnType<typeof TokenDocument['getTrackedAttributeChoices']>;
-      bar1: TokenBarData;
-      bar2: TokenBarData;
-    }
-  }
-}

package/src/foundry/client/apps/placeables/token-hud.d.ts

@@ -1,140 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Token objects.
-   * This interface provides controls for visibility, attribute bars, elevation, status effects, and more.
-   * @typeParam Options - the type of the options object
-   */
-  class TokenHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    ConcreteToken,
-    Options
-  > {
-    /**
-     * Track whether the status effects control palette is currently expanded or hidden
-     * @defaultValue `false`
-     * @internal
-     */
-    protected _statusEffects: boolean;
-
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "token-hud",
-     *   template: "templates/hud/token-hud.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override bind(object: ConcreteToken): void;
-
-    /**
-     * Refresh the currently active state of all status effect icons in the Token HUD selector.
-     */
-    refreshStatusIcons(): void;
-
-    override setPosition(_position?: Partial<Application.Position>): void;
-
-    override getData(options?: Partial<ApplicationOptions>): ReturnType<BasePlaceableHUD<ConcreteToken>['getData']> & {
-      canConfigure: boolean;
-      canToggleCombat: boolean;
-      displayBar1: boolean;
-      bar1Data: ReturnType<ConcreteToken['document']['getBarAttribute']>;
-      displayBar2: boolean;
-      bar2Data: ReturnType<ConcreteToken['document']['getBarAttribute']>;
-      visibilityClass: string;
-      effectsClass: string;
-      combatClass: string;
-      targetClass: string;
-      statusEffects: ReturnType<TokenHUD['_getStatusEffectChoices']>;
-    };
-
-    /**
-     * Get an array of icon paths which represent valid status effect choices
-     * @internal
-     */
-    protected _getStatusEffectChoices(): Record<
-      string,
-      {
-        id: string;
-        title: string | null;
-        src: string;
-        isActive: boolean;
-        isOverlay: boolean;
-        cssClass: string;
-      }
-    >;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _onClickControl(event: JQuery.ClickEvent): unknown;
-
-    /**
-     * Handle initial click to focus an attribute update field
-     * @internal
-     */
-    protected _onAttributeClick(event: JQuery.ClickEvent): void;
-
-    /**
-     * Force field handling on an Enter keypress even if the value of the field did not change.
-     * This is important to suppose use cases with negative number values.
-     * @param event - The originating keydown event
-     * @internal
-     */
-    protected _onAttributeKeydown(event: JQuery.KeyDownEvent): void;
-
-    /**
-     * Handle attribute bar update
-     * @internal
-     */
-    protected _onAttributeUpdate(event: JQuery.FocusOutEvent): void;
-
-    /**
-     * Toggle Token combat state
-     * @internal
-     */
-    protected _onToggleCombat(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle Token configuration button click
-     * @internal
-     */
-    protected _onTokenConfig(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle left-click events to toggle the displayed state of the status effect selection palette
-     * @internal
-     */
-    protected _onToggleStatusEffects(event: JQuery.ClickEvent): void;
-
-    /**
-     * Assign css selectors for the active state of the status effects selection palette
-     * @internal
-     */
-    protected _toggleStatusEffects(active: boolean): void;
-
-    /**
-     * Handle toggling a token status effect icon
-     * @internal
-     */
-    protected _onToggleEffect(
-      event: JQuery.ClickEvent | JQuery.ContextMenuEvent,
-      {
-        overlay
-      }?: {
-        /** @defaultValue `@false` */
-        overlay?: boolean;
-      }
-    ): Promise<boolean>;
-
-    /**
-     * Handle toggling the target state for this Token
-     * @internal
-     */
-    protected _onToggleTarget(event: JQuery.ClickEvent): void;
-  }
-}
-
-type ConcreteToken = InstanceType<ConfiguredObjectClassForName<'Token'>>;

package/src/foundry/client/apps/placeables/wall-config.d.ts

@@ -1,75 +0,0 @@
-import type { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Wall document within a parent Scene.
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class WallConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = WallConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Wall'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.template = "templates/scene/wall-config.html";
-     * options.width = 400;
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions;
-
-    /**
-     * An array of Wall ids that should all be edited when changes to this config form are submitted
-     * @defaultValue `[]`
-     */
-    editTargets: string[];
-
-    override get title(): string;
-
-    override render(
-      force?: boolean,
-      options?: Application.RenderOptions<Options> & {
-        walls?: InstanceType<ConfiguredObjectClassForName<'Wall'>>[] | undefined;
-      }
-    ): this;
-
-    override getData(): Data | Promise<Data>;
-
-    protected override _updateObject(event: Event, formData: WallConfig.FormData): Promise<unknown>;
-  }
-
-  namespace WallConfig {
-    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Wall'>>, Options> {
-      object: DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Wall'>>, Options>['data'];
-      moveTypes: {
-        [Key in keyof typeof foundry.CONST.WALL_MOVEMENT_TYPES as typeof foundry.CONST.WALL_MOVEMENT_TYPES[Key]]: Titlecase<Key>;
-      };
-      senseTypes: {
-        [Key in keyof typeof foundry.CONST.WALL_SENSE_TYPES as typeof foundry.CONST.WALL_SENSE_TYPES[Key]]: Titlecase<Key>;
-      };
-      dirTypes: {
-        [Key in keyof typeof foundry.CONST.WALL_DIRECTIONS as typeof foundry.CONST.WALL_DIRECTIONS[Key]]: Titlecase<Key>;
-      };
-      doorTypes: {
-        [Key in keyof typeof foundry.CONST.WALL_DOOR_TYPES as typeof foundry.CONST.WALL_DOOR_TYPES[Key]]: Titlecase<Key>;
-      };
-      doorStates: {
-        [Key in keyof typeof foundry.CONST.WALL_DOOR_STATES as typeof foundry.CONST.WALL_DOOR_STATES[Key]]: Titlecase<Key>;
-      };
-      isDoor: boolean;
-    }
-
-    interface FormData {
-      dir: foundry.CONST.WALL_DIRECTIONS;
-      door: foundry.CONST.WALL_DOOR_TYPES;
-      light: foundry.CONST.WALL_SENSE_TYPES;
-      ds?: foundry.CONST.WALL_DOOR_STATES;
-      move: foundry.CONST.WALL_MOVEMENT_TYPES;
-      sight: foundry.CONST.WALL_SENSE_TYPES;
-      sound: foundry.CONST.WALL_SENSE_TYPES;
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/apps/chat-popout.d.ts

@@ -1,34 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A simple application which supports popping a ChatMessage out to a separate UI window.
-   * @typeParam Options - the type of the options object
-   */
-  class ChatPopout<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    constructor(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, options?: Partial<Options>);
-
-    /**
-     * The displayed Chat Message document
-     */
-    message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   width: 300,
-     *   height: "auto",
-     *   classes: ["chat-popout"]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    protected override _renderInner(data: object, options?: unknown): Promise<JQuery>;
-  }
-}

package/src/foundry/client/apps/sidebar/apps/client-settings.d.ts

@@ -1,116 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing the client and world settings for this world.
-   * This form renders the settings defined via the game.settings.register API which have config = true
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class SettingsConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = SettingsConfig.Data
-  > extends FormApplication<Options, Data> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: game.i18n.localize("SETTINGS.Title"),
-     *   id: "client-settings",
-     *   template: "templates/sidebar/apps/settings-config.html",
-     *   width: 600,
-     *   height: "auto",
-     *   tabs: [
-     *     {navSelector: ".tabs", contentSelector: ".content", initial: "core"}
-     *   ]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle activating the button to configure User Role permissions
-     * @param event - The initial button click event
-     * @internal
-     */
-    protected _onClickSubmenu(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle button click to reset default settings
-     * @param event - The initial button click event
-     * @internal
-     */
-    protected _onResetDefaults(event: JQuery.ClickEvent): void;
-
-    /**
-     * Preview font scaling as the setting is changed.
-     * @param event - The triggering event.
-     * @internal
-     */
-    protected _previewFontScaling(event: JQuery.ChangeEvent): void;
-
-    override close(options?: Application.CloseOptions | undefined): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<unknown>;
-  }
-
-  namespace SettingsConfig {
-    interface Data {
-      user: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof User>>>;
-      canConfigure: boolean;
-      systemTitle: Game['system']['data']['title'];
-      data: Data.Data;
-    }
-
-    namespace Data {
-      interface Data {
-        core: {
-          version: string;
-          menus: SettingSubmenuConfig[];
-          settings: Setting[];
-          none: boolean;
-        };
-        system: {
-          title: Game['system']['data']['title'];
-          menus: SettingSubmenuConfig[];
-          settings: Setting[];
-          none: boolean;
-        };
-        modules: { title: string; menus: SettingSubmenuConfig[]; settings: Setting[] }[];
-      }
-
-      interface Setting extends Omit<SettingConfig, 'type'> {
-        id: string;
-        name: string;
-        hint: string;
-        value: unknown;
-        type: string;
-        isCheckbox: boolean;
-        isSelect: boolean;
-        isRange: boolean;
-        filePickerType: FilePicker.Type | undefined;
-      }
-    }
-
-    interface FormData {
-      'core.animateRollTable': boolean;
-      'core.chatBubbles': boolean;
-      'core.chatBubblesPan': boolean;
-      'core.coneTemplateType': 'round' | 'flat';
-      'core.language': string;
-      'core.leftClickRelease': boolean;
-      'core.lightAnimation': boolean;
-      'core.maxFPS': number;
-      'core.mipmap': boolean;
-      'core.noCanvas': boolean;
-      'core.softShadows': boolean;
-      'core.tokenDragPreview': boolean;
-      'core.visionAnimation': boolean;
-      [key: string]: unknown;
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/apps/compendium.d.ts

@@ -1,86 +0,0 @@
-/**
- * An interface for displaying the content of a CompendiumCollection.
- * @typeParam Metadata - The metadata of the compendium
- * @typeParam Options  - The type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class Compendium<
-  Metadata extends CompendiumCollection.Metadata,
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = Compendium.Data<Metadata>
-> extends Application<Options> {
-  /**
-   * @param collection - The {@link CompendiumCollection} object represented by this interface.
-   * @param options    - Application configuration options.
-   */
-  constructor(collection: CompendiumCollection<Metadata>, options?: Partial<Options> | undefined);
-
-  collection: CompendiumCollection<Metadata>;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   template: "templates/apps/compendium.html",
-   *   width: 350,
-   *   height: window.innerHeight - 100,
-   *   top: 70,
-   *   left: 120,
-   *   scrollY: [".directory-list"],
-   *   dragDrop: [{ dragSelector: ".directory-item", dropSelector: ".directory-list" }],
-   *   filters: [{inputSelector: 'input[name="search"]', contentSelector: ".directory-list"}]
-   * });
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  override get title(): string;
-
-  /**
-   * A convenience redirection back to the metadata object of the associated CompendiumCollection
-   */
-  get metadata(): this['collection']['metadata'];
-
-  override getData(options?: Partial<Options>): Promise<Data> | Data;
-
-  override close(options?: Application.CloseOptions): Promise<void>;
-
-  override activateListeners(html: JQuery): void;
-
-  /**
-   * Handle opening a single compendium entry by invoking the configured document class and its sheet
-   * @param event - The originating click event
-   */
-  protected _onClickEntry(event: JQuery.ClickEvent): void;
-
-  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-  protected override _canDragStart(selector: string): boolean;
-
-  protected override _canDragDrop(selector: string): boolean;
-
-  protected override _onDragStart(event: DragEvent): void;
-
-  /**
-   * @internal
-   */
-  protected override _onDrop(event: DragEvent): void;
-
-  protected override _contextMenu(html: JQuery): void;
-
-  /**
-   * Get Compendium entry context options
-   * @returns The Compendium entry context options
-   * @internal
-   */
-  protected _getEntryContextOptions(): ContextMenuEntry;
-}
-
-declare namespace Compendium {
-  interface Data<Metadata extends CompendiumCollection.Metadata> {
-    collection: CompendiumCollection<Metadata>;
-    documentCls: string;
-    index: CompendiumCollection<Metadata>['index'];
-    documentPartial: string;
-  }
-}