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

package/src/foundry/client/apps/forms/sheet-config.d.mts

@@ -1,191 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-import type DocumentSheetV2 from "../../../client-esm/applications/api/document-sheet.d.mts";
-import type { Document } from "../../../common/abstract/_module.d.mts";
-
-declare global {
-  /**
-   * Document Sheet Configuration Application
-   * @typeParam Options          - The type of the options object
-   * @typeParam ConcreteDocument - The type of the Document which is being managed
-   */
-  class DocumentSheetConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-  > extends FormApplication<Options, ConcreteDocument> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["form", "sheet-config"],
-     *   template: "templates/sheets/sheet-config.html",
-     *   width: 400
-     * })
-     * ```
-     */
-    static get defaultOptions(): FormApplicationOptions;
-
-    /**
-     * An array of pending sheet assignments which are submitted before other elements of the framework are ready.
-     * @internal
-     */
-    static #pending: Array<DocumentSheetConfig.SheetAssignment>;
-
-    override get title(): string;
-
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<DocumentSheetConfig.DocumentSheetConfigData>>;
-
-    protected override _updateObject(event: Event, formData: DocumentSheetConfig.FormData): Promise<unknown>;
-
-    /**
-     * Marshal information on the available sheet classes for a given document type and sub-type, and format it for
-     * @param documentName - The Document type.
-     * @param subType      - The Document sub-type. // TODO: Generic to specify string options?
-     */
-    static getSheetClassesForSubType(
-      documentName: Document.Type,
-      subType: string,
-    ): DocumentSheetConfig.SheetClassesForSubType;
-
-    /**
-     * Initialize the configured Sheet preferences for Documents which support dynamic Sheet assignment
-     * Create the configuration structure for supported documents
-     * Process any pending sheet registrations
-     * Update the default values from settings data
-     */
-    static initializeSheets(): void;
-
-    /**
-     * @internal
-     */
-    protected static _getDocumentTypes(cls: Document.AnyConstructor, types?: string[]): string[];
-
-    /**
-     * Register a sheet class as a candidate which can be used to display documents of a given type
-     * @param documentClass - The Document class for which to register a new Sheet option
-     * @param scope         - Provide a unique namespace scope for this sheet
-     * @param sheetClass    - A defined Application class used to render the sheet
-     * @param config        - Additional options used for sheet registration
-     */
-    static registerSheet(
-      documentClass: Document.AnyConstructor,
-      scope: string,
-      sheetClass: FormApplication.AnyConstructor | DocumentSheetV2.AnyConstructor,
-      config?: DocumentSheetConfig.RegisterSheetOptions,
-    ): void;
-
-    /**
-     * Unregister a sheet class, removing it from the list of available Applications to use for a Document type
-     * @param documentClass - The Document class for which to register a new Sheet option
-     * @param scope         - Provide a unique namespace scope for this sheet
-     * @param sheetClass    - A defined DocumentSheet subclass used to render the sheet
-     * @param types         - An Array of types for which this sheet should be removed
-     */
-    static unregisterSheet(
-      documentClass: Document.AnyConstructor,
-      scope: string,
-      sheetClass: typeof FormApplication<FormApplicationOptions, any>,
-      { types }?: { types?: string[] },
-    ): void;
-
-    /**
-     * Update the current default Sheets using a new core world setting.
-     */
-    static updateDefaultSheets(setting?: Record<Document.Type, Record<string, string>>): void;
-
-    /**
-     * Initialize default sheet configurations for all document types.
-     * @internal
-     */
-    protected static _registerDefaultSheets(): void;
-
-    #documentSheetConfig: true;
-  }
-
-  namespace DocumentSheetConfig {
-    type Any = DocumentSheetConfig<any>;
-
-    interface SheetRegistration {
-      action: "register";
-
-      /** The Document class being registered */
-      documentClass: Document.AnyConstructor;
-
-      /** The sheet ID being registered */
-      id: string;
-
-      /** The human-readable sheet label */
-      label: string;
-
-      /** The sheet class definition being registered */
-      sheetClass: Application.AnyConstructor;
-
-      /** An array of types for which this sheet is added */
-      types: string[];
-
-      /** Make this sheet the default for provided types? */
-      makeDefault: boolean;
-    }
-
-    interface SheetUnregistration {
-      action: "unregister";
-
-      /** The Document class being unregistered */
-      documentClass: Document.AnyConstructor;
-
-      /** The sheet ID being unregistered */
-      id: string;
-
-      /** An array of types for which this sheet is removed */
-      types: string[];
-    }
-
-    type SheetAssignment = SheetRegistration | SheetUnregistration;
-
-    interface FormData {
-      defaultClass: string;
-      sheetClass: string;
-    }
-
-    interface RegisterSheetOptions {
-      /** A human-readable label for the sheet name, which will be localized */
-      label?: string;
-
-      /** An array of document types for which this sheet should be used */
-      types?: string[];
-
-      /**
-       * Whether to make this sheet the default for provided types
-       * @defaultValue `false`
-       */
-      makeDefault?: boolean;
-
-      /**
-       * Whether this sheet is available to be selected as a default sheet for all Documents of that type.
-       * @defaultValue `true`
-       */
-      canBeDefault?: boolean;
-
-      /**
-       * Whether this sheet appears in the sheet configuration UI for users.
-       * @defaultValue `true`
-       */
-      canConfigure?: boolean;
-    }
-
-    interface SheetClassesForSubType {
-      sheetClasses: Record<string, string>;
-      defaultClass: string;
-      defaultClasses: Record<string, string>;
-    }
-
-    interface DocumentSheetConfigData extends SheetClassesForSubType {
-      isGM: boolean;
-      object: foundry.abstract.Document.Any;
-      options: FormApplicationOptions;
-      sheetClass: string;
-      blankLabel: string;
-    }
-  }
-}

package/src/foundry/client/apps/forms/user-config.d.mts

@@ -1,72 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single User document.
-   * @typeParam Options - the type of the options object
-   */
-  class UserConfig<Options extends UserConfig.Options = UserConfig.Options> extends DocumentSheet<
-    Options,
-    User.ConfiguredInstance
-  > {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "user-config"],
-     *   template: "templates/user/user-config.html",
-     *   width: 400,
-     *   height: "auto"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): UserConfig.Options;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<UserConfig.UserConfigData>>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle changing the user avatar image by opening a FilePicker
-     */
-    protected _onEditAvatar(event: JQuery.ClickEvent): ReturnType<FilePicker["browse"]>;
-  }
-
-  namespace UserConfig {
-    type Any = UserConfig<any>;
-
-    interface Options extends DocumentSheetOptions<User.ConfiguredInstance> {
-      /**
-       * @defaultValue `["sheet", "user-config"]`
-       */
-      classes: DocumentSheetOptions["classes"];
-
-      /**
-       * @defaultValue `"templates/user/user-config.html"`
-       */
-      template: DocumentSheetOptions["template"];
-
-      /**
-       * @defaultValue `400`
-       */
-      width: DocumentSheetOptions["width"];
-
-      /**
-       * @defaultValue `"auto"`
-       */
-      height: DocumentSheetOptions["height"];
-    }
-
-    interface UserConfigData<
-      Options extends DocumentSheetOptions<User.ConfiguredInstance> = DocumentSheetOptions<User.ConfiguredInstance>,
-    > {
-      user: UserConfig<Options>["object"];
-      actors: Actor.ConfiguredClass[];
-      options: UserConfig<Options>["options"];
-    }
-  }
-}
-
-type FormData = Pick<User["_source"], "avatar" | "character" | "color">;

package/src/foundry/client/apps/hud/chatbubble.d.mts

@@ -1,120 +0,0 @@
-import type { Socket } from "socket.io-client";
-
-declare global {
-  /**
-   * The Chat Bubble Class
-   * This application displays a temporary message sent from a particular Token in the active Scene.
-   * The message is displayed on the HUD layer just above the Token.
-   */
-  class ChatBubbles {
-    constructor();
-
-    /**
-     * @defaultValue `"templates/hud/chat-bubble.html"`
-     */
-    template: string;
-
-    /**
-     * Track active Chat Bubbles
-     * @defaultValue `{}`
-     * @remarks This is never used
-     */
-    bubbles: object;
-
-    /**
-     * Track which Token was most recently panned to highlight
-     * Use this to avoid repeat panning
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _panned: Token | null;
-
-    /**
-     * A reference to the chat bubbles HTML container in which rendered bubbles should live
-     */
-    get container(): JQuery;
-
-    /**
-     * Create a chat bubble message for a certain token which is synchronized for display across all connected clients.
-     * @param token   - The speaking Token Document
-     * @param message - The spoken message text
-     * @param options - Options which affect the bubble appearance
-     */
-    broadcast(token: TokenDocument, message: string, options: ChatBubbles.ChatBubbleOptions): Promise<JQuery | null>;
-
-    /**
-     * Speak a message as a particular Token, displaying it as a chat bubble
-     * @param token   - The speaking Token
-     * @param message - The spoken message text
-     * @param emote   - Whether to style the speech bubble as an emote
-     * @returns A Promise which resolves once the chat bubble has been created
-     */
-    say(token: Token, message: string, { emote }?: { emote?: boolean }): Promise<void>;
-
-    /**
-     * Activate Socket event listeners which apply to the ChatBubbles UI.
-     * @param socket - The active web socket connection
-     */
-    protected static _activateSocketListeners(socket: Socket): Promise<void>;
-
-    /**
-     * Clear any existing chat bubble for a certain Token
-     * @internal
-     */
-    protected _clearBubble(token: Token): Promise<void>;
-
-    /**
-     * Render the HTML template for the chat bubble
-     * @param data - Template data
-     * @returns The rendered HTML
-     * @internal
-     */
-    protected _renderHTML(data: { token: Token; message: string; emote: boolean }): Promise<string>;
-
-    /**
-     * Before displaying the chat message, determine it's constrained and unconstrained dimensions
-     * @param message - The message content
-     * @returns The rendered message dimensions
-     * @internal
-     */
-    protected _getMessageDimensions(message: string): ChatBubbles.Dimensions;
-
-    /**
-     * Assign styling parameters to the chat bubble, toggling either a left or right display (randomly)
-     * @internal
-     */
-    protected _setPosition(token: Token, html: JQuery, dimensions: ChatBubbles.Dimensions): void;
-
-    /**
-     * Determine the length of time for which to display a chat bubble.
-     * Research suggests that average reading speed is 200 words per minute.
-     * Since these are short-form messages, we multiply reading speed by 1.5.
-     * Clamp the result between 1 second (minimum) and 20 seconds (maximum)
-     *
-     * @param html - The HTML message
-     * @returns The number of milliseconds for which to display the message
-     */
-    protected _getDuration(html: JQuery): number;
-  }
-
-  namespace ChatBubbles {
-    type Any = AnyChatBubbles;
-    type AnyConstructor = typeof AnyChatBubbles;
-
-    interface Dimensions {
-      width: number;
-      height: number;
-      unconstrained: number;
-    }
-
-    interface ChatBubbleOptions {
-      cssClasses?: string;
-      pan: boolean;
-      requireVisible: false;
-    }
-  }
-}
-
-declare abstract class AnyChatBubbles extends ChatBubbles {
-  constructor(arg0: never, ...args: never[]);
-}

package/src/foundry/client/apps/hud/container.d.mts

@@ -1,54 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * Render the HUD container
-   * @typeParam Options - the type of the options object
-   */
-  class HeadsUpDisplay<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    /**
-     * Token HUD
-     */
-    token: TokenHUD;
-
-    /**
-     * Tile HUD
-     */
-    tile: TileHUD;
-
-    /**
-     * Drawing HUD
-     */
-    drawing: DrawingHUD;
-
-    /**
-     * Chat Bubbles
-     */
-    bubbles: ChatBubbles;
-
-    /**
-     * @defaultValue
-     * ```
-     * mergeObject(super.defaultOptions, {
-     *   id: "hud",
-     *   template: "templates/hud/hud.html",
-     *   popOut: false,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    /**
-     * Align the position of the HUD layer to the current position of the canvas
-     */
-    align(): void;
-  }
-
-  namespace HeadsUpDisplay {
-    type Any = HeadsUpDisplay<any>;
-  }
-}

package/src/foundry/client/apps/hud/controls.d.mts

@@ -1,171 +0,0 @@
-export {};
-
-declare global {
-  interface SceneControlToolBase {
-    name: string;
-    title: string;
-    icon: string;
-    visible?: boolean;
-    active?: boolean;
-    toolclip?: ToolclipConfiguration;
-  }
-
-  interface SceneControlToolToggle extends SceneControlToolBase {
-    toggle: true;
-    onClick?: (toggled: boolean) => void;
-  }
-
-  interface SceneControlToolNoToggle extends SceneControlToolBase {
-    toggle?: false;
-    button?: boolean;
-    onClick?: () => void;
-  }
-
-  type SceneControlTool = SceneControlToolToggle | SceneControlToolNoToggle;
-
-  interface SceneControl {
-    name: string;
-    title: string;
-    layer: string;
-    icon: string;
-    visible: boolean;
-    tools: SceneControlTool[];
-    activeTool: string;
-  }
-
-  interface ToolclipConfiguration {
-    /** The filename of the toolclip video. */
-    src: string;
-
-    /** The heading string. */
-    heading: string;
-
-    /** The items in the toolclip body. */
-    items: ToolclipConfigurationItem[];
-  }
-
-  interface ToolclipConfigurationItem {
-    /** A plain paragraph of content for this item. */
-    paragraph?: string;
-
-    /** A heading for the item. */
-    heading?: string;
-
-    /** Content for the item. */
-    content?: string;
-
-    /** If the item is a single key reference, use this instead of content. */
-    reference?: string;
-  }
-
-  /**
-   * Scene controls navigation menu
-   * @typeParam Options - the type of the options object
-   */
-  class SceneControls<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * The name of the active Scene Control toolset
-     * @defaultValue `"token"`
-     */
-    activeControl: string;
-
-    /**
-     * The Array of Scene Control buttons which are currently rendered
-     */
-    controls: SceneControl[];
-
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   width: 100,
-     *   id: "controls",
-     *   template: "templates/hud/controls.html",
-     *   popOut: false,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    /**
-     * Return the active control set
-     */
-    get control(): SceneControl | null;
-
-    /**
-     * Return the name of the active tool within the active control set
-     */
-    get activeTool(): string | null;
-
-    /**
-     * Return the actively controlled tool
-     */
-    get tool(): SceneControlTool | null;
-
-    /**
-     * A convenience reference for whether the currently active tool is a Ruler
-     */
-    get isRuler(): boolean;
-
-    /**
-     * Initialize the Scene Controls by obtaining the set of control buttons and rendering the HTML
-     * @param options - Options which modify how the controls UI is initialized
-     *                  (defaultValue: `{}`)
-     */
-    initialize(options?: InitializeOptions): void;
-
-    override getData(options?: Partial<Options>): {
-      controls: SceneControl[];
-      active: boolean;
-      cssClass: "" | "disabled";
-    };
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle click events on a Control set
-     * @param event - A click event on a tool control
-     */
-    protected _onClickLayer(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle click events on Tool controls
-     * @param event - A click event on a tool control
-     */
-    protected _onClickTool(event: JQuery.ClickEvent): void;
-
-    /**
-     * Get the set of Control sets and tools that are rendered as the Scene Controls.
-     * These controls may be extended using the "getSceneControlButtons" Hook.
-     */
-    protected _getControlButtons(): SceneControl[];
-  }
-
-  namespace SceneControls {
-    type Any = AnySceneControls;
-    type AnyConstructor = typeof AnySceneControls;
-  }
-
-  interface InitializeOptions {
-    /**
-     * An optional control set to set as active
-     */
-    control?: string;
-
-    /**
-     * An optional layer name to target as the active control
-     */
-    layer?: string;
-
-    /**
-     * A specific named tool to set as active for the palette
-     */
-    tool?: string;
-  }
-}
-
-declare abstract class AnySceneControls extends SceneControls<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
-}