@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

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

@@ -1,256 +0,0 @@
-import type { InterfaceToObject, AnyObject } from "fvtt-types/utils";
-import type StringTerm from "../../../client-esm/dice/terms/string.d.mts";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Token document within a parent Scene.
-   */
-  class TokenConfig<
-    Options extends
-      DocumentSheetOptions<TokenDocument.ConfiguredInstance> = DocumentSheetOptions<TokenDocument.ConfiguredInstance>,
-  > extends DocumentSheet<Options, TokenDocument.ConfiguredInstance | Actor.ConfiguredInstance> {
-    constructor(object: TokenDocument.ConfiguredInstance | Actor.ConfiguredInstance, options?: Partial<Options>);
-
-    /**
-     * The placed Token object in the Scene
-     */
-    token: TokenDocument.ConfiguredInstance | foundry.data.PrototypeToken;
-
-    /**
-     * A reference to the Actor which the token depicts
-     */
-    actor: Actor.ConfiguredInstance;
-
-    /**
-     * Maintain a copy of the original to show a real-time preview of changes.
-     */
-    preview: TokenDocument.ConfiguredInstance | foundry.data.PrototypeToken;
-
-    /**
-     * @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"}
-     *     {navSelector: '.tabs[data-group="vision"]', contentSelector: '.tab[data-tab="vision"]', initial: "basic"}
-     *   ],
-     *   viewPermission: CONST.DOCUMENT_OWNERSHIP_LEVELS.OWNER,
-     *   sheetConfig: true
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions<TokenDocument.ConfiguredInstance>;
-
-    /**
-     * A convenience accessor to test whether we are configuring the prototype Token for an Actor.
-     */
-    get isPrototype(): boolean;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    /**
-     * Handle preview with a token.
-     */
-    protected _handleTokenPreview(force: boolean, options?: Options): Promise<void>;
-
-    protected override _canUserView(user: User): boolean;
-
-    override getData(options?: Partial<Options>): Promise<object>; // TODO: Implement GetDataReturnType
-
-    protected _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery<HTMLElement>>;
-
-    /**
-     * Get an Object of image paths and filenames to display in the Token sheet
-     * @internal
-     */
-    protected _getAlternateTokenImages(): Promise<Record<string, string>>;
-
-    override activateListeners(html: JQuery): void;
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    protected override _getSubmitData(updateData?: AnyObject | null): InterfaceToObject<TokenConfig.FormData>;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
-
-    /**
-     * Mimic changes to the Token document as if they were true document updates.
-     * @param change - The change to preview.
-     */
-    protected _previewChanges(change?: AnyObject): void;
-
-    /**
-     * Reset the temporary preview of the Token when the form is submitted or closed.
-     */
-    protected _resetPreview(): 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;
-
-    /**
-     * Handle click events on a token configuration sheet action button
-     * @param event - The originating click event
-     */
-    protected _onClickActionButton(event: PointerEvent): void;
-
-    /**
-     * Handle adding a detection mode.
-     * @param modes - The existing detection modes
-     */
-    protected _onAddDetectionMode(modes: TokenDocument["detectionModes"]): void;
-
-    /**
-     * Handle removing a detection mode.
-     * @param index - The index of the detection mode to remove.
-     * @param modes - The existing detection modes.
-     */
-    protected _onRemoveDetectionMode(index: number, modes: TokenDocument["detectionModes"]): void;
-
-    /**
-     * Disable the user's ability to edit the token image field if wildcard images are enabled and that user does not have
-     * file browser permissions.
-     * @internal
-     */
-    protected _disableEditImage(): void;
-  }
-
-  namespace TokenConfig {
-    type Any = AnyTokenConfig;
-    type AnyConstructor = typeof AnyTokenConfig;
-
-    interface FormData {
-      // TODO: Update
-      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
-      DocumentSheetOptions<TokenDocument.ConfiguredInstance> = DocumentSheetOptions<TokenDocument.ConfiguredInstance>,
-  > extends TokenConfig<Options> {
-    constructor(object?: unknown, options?: Partial<Options>);
-
-    object: TokenDocument.ConfiguredInstance;
-
-    /**
-     * 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(): DocumentSheetOptions<TokenDocument.ConfiguredInstance>;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override get isEditable(): boolean;
-
-    protected override _canUserView(user: User): boolean;
-
-    override getData(options: unknown): Promise<object>; // TODO: Implement GetDataReturnType
-
-    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;
-
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    protected override _onBarChange(): Promise<void>;
-
-    protected override _onAddDetectionMode(modes: TokenDocument["detectionModes"]): void;
-
-    protected override _onRemoveDetectionMode(index: number, modes: TokenDocument["detectionModes"]): void;
-  }
-
-  namespace DefaultTokenConfig {
-    type Any = AnyDefaultTokenConfig;
-    type AnyConstructor = typeof AnyDefaultTokenConfig;
-  }
-}
-
-declare abstract class AnyTokenConfig extends TokenConfig<DocumentSheetOptions<TokenDocument.ConfiguredInstance>> {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyDefaultTokenConfig extends DefaultTokenConfig<
-  DocumentSheetOptions<TokenDocument.ConfiguredInstance>
-> {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,139 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-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<
-    Token.ConfiguredInstance,
-    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: Token.ConfiguredInstance): 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>): MaybePromise<object>; // TODO: Implement GetDataReturnType
-
-    /**
-     * 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
-     * @param event  - The click event to toggle the effect
-     * @param options - Options which modify the toggle
-     * @internal
-     */
-    protected _onToggleEffect(
-      event: JQuery.ClickEvent | JQuery.ContextMenuEvent,
-      options?: {
-        /**
-         * Toggle the overlay effect?
-         * @defaultValue `false`
-         */
-        overlay?: boolean;
-      },
-    ): Promise<boolean>;
-
-    /**
-     * Handle toggling the target state for this Token
-     * @param event - The click event to toggle the target
-     * @internal
-     */
-    protected _onToggleTarget(event: JQuery.ClickEvent): void;
-  }
-
-  namespace TokenHUD {
-    type Any = AnyTokenHUD;
-    type AnyConstructor = typeof AnyTokenHUD;
-  }
-}
-
-declare abstract class AnyTokenHUD extends TokenHUD<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,64 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Wall document within a parent Scene.
-   * @typeParam Options - The type of the options object
-   */
-  class WallConfig<
-    Options extends
-      DocumentSheetOptions<WallDocument.ConfiguredInstance> = DocumentSheetOptions<WallDocument.ConfiguredInstance>,
-  > extends DocumentSheet<Options, WallDocument.ConfiguredInstance> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.classes.push("wall-config");
-     * options.template = "templates/scene/wall-config.html";
-     * options.width = 400;
-     * options.height = "auto";
-     * return options;
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions<WallDocument.ConfiguredInstance>;
-
-    /**
-     * 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?: Wall.ConfiguredInstance[] | undefined;
-      },
-    ): this;
-
-    override getData(): MaybePromise<object>; // TODO: Implement GetDataReturnType
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    protected _onChangeInput(event: JQuery.ChangeEvent<any, any, any, any>): Promise<void | object>;
-
-    protected _getSubmitData(updateData?: object | null): WallConfig.FormData;
-
-    protected override _updateObject(event: Event, formData: WallConfig.FormData): Promise<unknown>;
-  }
-
-  namespace WallConfig {
-    type Any = WallConfig<any>;
-
-    type FormData = Pick<
-      WallDocument["_source"],
-      "move" | "light" | "sight" | "sound" | "dir" | "door" | "ds" | "doorSound"
-    > & {
-      "threshold.light": WallDocument["_source"]["threshold"]["light"];
-      "threshold.sight": WallDocument["_source"]["threshold"]["sight"];
-      "threshold.sound": WallDocument["_source"]["threshold"]["sound"];
-      "threshold.attenuation": WallDocument["_source"]["threshold"]["attenuation"];
-    };
-  }
-}

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

@@ -1,39 +0,0 @@
-export {};
-
-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: ChatMessage.ConfiguredInstance, options?: Partial<Options>);
-
-    /**
-     * The displayed Chat Message document
-     */
-    message: ChatMessage.ConfiguredInstance;
-
-    /**
-     * @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;
-
-    /** @remarks Foundry references an options object as a second argument, but this is never used nor provided in the invocation */
-    protected override _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery>;
-  }
-
-  namespace ChatPopout {
-    type Any = ChatPopout<any>;
-  }
-}

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

@@ -1,98 +0,0 @@
-export {};
-
-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
-   */
-  class SettingsConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-  > extends PackageConfiguration<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: game.i18n.localize("SETTINGS.Title"),
-     *   id: "client-settings",
-     *   template: "templates/sidebar/apps/settings-config.html",
-     *   submitButton: true
-     * })
-     * ```
-     */
-    static override get defaultOptions(): typeof FormApplication.defaultOptions;
-
-    override _prepareCategoryData(): SettingsConfig.CategoryData;
-
-    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;
-
-    /**
-     * 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): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: SettingsConfig.FormData): Promise<unknown>;
-
-    /**
-     * Handle button click to reset default settings
-     * @param event - The initial button click event
-     * @internal
-     */
-    protected _onResetDefaults(event: JQuery.ClickEvent): void;
-
-    /**
-     * Confirm if the user wishes to reload the application
-     * @param options - Additional options to configure the prompt
-     */
-    static reloadConfirm(options?: {
-      /**
-       * Whether to reload all connected clients as well.
-       * @defaultValue `false`
-       */
-      world: boolean;
-    }): Promise<void>;
-  }
-
-  namespace SettingsConfig {
-    type Any = SettingsConfig<any>;
-
-    interface Category extends PackageConfiguration.Category {
-      menus: ClientSettings.SettingSubmenuConfig[];
-      settings: SettingConfig[];
-      count: number;
-    }
-
-    interface CategoryData extends PackageConfiguration.CategoryData<Category> {
-      user: Game["user"];
-      canConfigure: boolean;
-    }
-
-    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.mts

@@ -1,92 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * An interface for displaying the content of a CompendiumCollection.
-   * @typeParam Metadata - The metadata of the compendium
-   * @typeParam Options  - The type of the options object
-   */
-  class Compendium<
-    Metadata extends CompendiumCollection.Metadata,
-    Options extends Compendium.Options<Metadata> = Compendium.Options<Metadata>,
-  > extends DocumentDirectory<"Compendium", Options> {
-    /**
-     * @param options    - Compendium configuration options.
-     */
-    constructor(options: Partial<Options>);
-
-    override get entryType(): Metadata["type"];
-
-    static override entryPartial: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/apps/compendium.html",
-     *   width: 350,
-     *   height: window.innerHeight - 100,
-     *   top: 70,
-     *   left: 120,
-     *   popOut: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): Compendium.Options<CompendiumCollection.Metadata>;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override get tabName(): string;
-
-    override get canCreateEntry(): boolean;
-
-    override get canCreateFolder(): boolean;
-
-    /**
-     * A convenience redirection back to the metadata object of the associated CompendiumCollection
-     */
-    get metadata(): this["collection"]["metadata"];
-
-    override initialize(): void;
-
-    override render(force?: boolean, options?: Application.RenderOptions<ApplicationOptions>): unknown;
-
-    // TODO: Implement GetDataReturnType
-    override getData(options?: Partial<Options>): Promise<object>;
-
-    protected override _entryAlreadyExists(entry: DirectoryMixinEntry): boolean;
-
-    protected override _createDroppedEntry(entry: DirectoryMixinEntry, folderId?: string): Promise<DirectoryMixinEntry>;
-
-    protected override _getEntryDragData(entryId: string): { type: string; uuid: string };
-
-    protected override _onCreateEntry(event: PointerEvent): Promise<void>;
-
-    /**
-     * Handle clicks on a footer button
-     * @param event - The originating pointer event
-     * @internal
-     */
-    _onClickFooterButton(event: PointerEvent): AdventureExporter | void;
-
-    protected _getDocumentDragData(documentId: string): { type: string; uuid: string };
-
-    protected override _getFolderDragData(folderId: string): { type: "Folder"; uuid: string };
-
-    protected override _getFolderContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-
-    protected override _getEntryContextOptions(): foundry.applications.ux.ContextMenu.Entry<JQuery>[];
-  }
-
-  namespace Compendium {
-    type Any = Compendium<any, any>;
-
-    interface Options<_Metadata extends CompendiumCollection.Metadata = CompendiumCollection.Metadata>
-      extends DocumentDirectoryOptions {
-      // Note(LukeAbby): Replacing `any` with `Metadata` causes an OOM within TypeScript.
-      collection: CompendiumCollection<any>;
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/apps/index.d.mts

@@ -1,10 +0,0 @@
-import "./chat-popout.d.mts";
-import "./client-settings.d.mts";
-import "./compendium.d.mts";
-import "./invitation-links.d.mts";
-import "./keybindings-config.d.mts";
-import "./module-management.d.mts";
-import "./permission-config.d.mts";
-import "./support-details.d.mts";
-import "./tours-management.d.mts";
-import "./world-config.d.mts";