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

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

@@ -1,60 +0,0 @@
-import type { GetDataReturnType, MaybePromise, ValueOf } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Folder document.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class FolderConfig<Options extends FolderConfig.Options = FolderConfig.Options> extends DocumentSheet<
-    Options,
-    Folder.ConfiguredInstance
-  > {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "folder-edit"],
-     *   template: "templates/sidebar/folder-edit.html",
-     *   width: 360
-     * })
-     * ```
-     */
-    static override get defaultOptions(): FolderConfig.Options;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<FolderConfig.FolderConfigData>>;
-
-    protected override _updateObject(event: Event, formData: FolderConfig.FormData): Promise<unknown>;
-  }
-
-  namespace FolderConfig {
-    type Any = FolderConfig<any>;
-
-    interface Options extends DocumentSheetOptions<Folder.ConfiguredInstance> {
-      resolve?: (doc: Folder.ConfiguredInstance) => void;
-    }
-
-    interface FormData {
-      color: string;
-      name: string;
-      parent: string;
-      sorting: ValueOf<typeof Folder.SORTING_MODES>;
-      type: foundry.CONST.FOLDER_DOCUMENT_TYPES;
-    }
-
-    interface FolderConfigData {
-      folder: ReturnType<FolderConfig["object"]["toObject"]>;
-      name: string;
-      newName: string;
-      safeColor: string;
-      sortingModes: { a: string; m: string };
-      submitText: string;
-    }
-  }
-}

package/src/foundry/client/apps/forms/fonts.d.mts

@@ -1,168 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  class FontConfig<Options extends FontConfig.Options = FontConfig.Options> extends FormApplication<
-    Options,
-    NewFontDefinition
-  > {
-    constructor(object?: NewFontDefinition, options?: Options);
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: game.i18n.localize("SETTINGS.FontConfigL"),
-     *   id: "font-config",
-     *   template: "templates/sidebar/apps/font-config.html",
-     *   popOut: true,
-     *   width: 600,
-     *   height: "auto",
-     *   closeOnSubmit: false,
-     *   submitOnChange: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): FontConfig.Options;
-
-    /**
-     * Whether a font is distributed to connected clients or found on their OS.
-     */
-    static FONT_TYPES: { FILE: "file"; SYSTEM: "system" };
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<FontConfig.FontConfigData>>;
-
-    /**
-     * Template data for a given font definition.
-     * @param family     - The font family.
-     * @param definition - The font family definition.
-     */
-    protected _getDataForDefinition(
-      family: string,
-      definition: CONFIG.Font.FamilyDefinition,
-    ): { family: string; index: number; font: string }[];
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    protected override _updateObject(event: Event, formData?: object): Promise<void>;
-
-    close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    /**
-     * Handle application controls.
-     * @param event - The click event.
-     */
-    protected _onClickControl(event: MouseEvent): void;
-
-    /**
-     * Add a new custom font definition.
-     */
-    protected _onAddFont(): Promise<void>;
-
-    /**
-     * Delete a font.
-     * @param event - The click event
-     */
-    protected _onDeleteFont(event: MouseEvent): Promise<void>;
-
-    /**
-     * Select a font to preview.
-     * @param event - The click event
-     */
-    protected _onSelectFont(event: MouseEvent): void;
-
-    /**
-     * Define the setting key where this world's font information will be stored.
-     */
-    static SETTING: "fonts";
-
-    /**
-     * Get the list of fonts that successfully loaded.
-     */
-    static getAvailableFonts(): string[];
-
-    /**
-     * Get the list of fonts formatted for display with selectOptions.
-     */
-    static getAvailableFontChoices(): Record<string, string>;
-
-    /**
-     * Load a font definition.
-     * @param family     - The font family name (case-sensitive).
-     * @param definition - The font family definition.
-     * @returns Returns true if the font was successfully loaded.
-     */
-    static loadFont(family: string, definition: CONFIG.Font.FamilyDefinition): Promise<boolean>;
-
-    /**
-     * Ensure that fonts have loaded and are ready for use.
-     * Enforce a maximum timeout in milliseconds.
-     * Proceed after that point even if fonts are not yet available.
-     * @param ms -  The maximum time to spend loading fonts before proceeding.
-     *              (default: `4500`)
-     */
-    protected static _loadFonts(ms?: number): Promise<void>;
-
-    /**
-     * Collect all the font definitions and combine them.
-     */
-    protected static _collectDefinitions(): Record<string, CONFIG.Font.FamilyDefinition>;
-
-    /**
-     * Create FontFace object from a FontDefinition.
-     * @param family - The font family name.
-     * @param font   - The font definition.
-     */
-    protected static _createFontFace(family: string, font: CONFIG.Font.Definition): FontFace;
-
-    /**
-     * Format a font definition for display.
-     * @param family     - The font family.
-     * @param definition - The font definition.
-     */
-    protected static _formatFont(family: string, definition: CONFIG.Font.Definition): string;
-  }
-
-  interface NewFontDefinition {
-    /**
-     * The font family.
-     */
-    family?: string;
-
-    /**
-     * The font weight.
-     * @defaultValue `400`
-     */
-    weight?: number;
-
-    /**
-     * The font style.
-     * @defaultValue `"normal"`
-     */
-    style?: string;
-
-    /**
-     * The font file
-     * @defaultValue `""`
-     */
-    src?: string;
-
-    /**
-     * The text to preview the font.
-     * @defaultValue `game.i18n.localize("FONTS.FontPreview")`
-     */
-    preview?: string;
-  }
-
-  namespace FontConfig {
-    type Any = FontConfig<any>;
-
-    interface Options extends FormApplicationOptions {}
-
-    interface FontConfigData {
-      fonts: { family: string; index: number; font: string }[];
-      selected: { family: string; index: number } | null;
-      family: string | undefined;
-      weights: Array<{ value: foundry.CONST.FONT_WEIGHTS; label: string }>;
-    }
-  }
-}

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

@@ -1,139 +0,0 @@
-import type { InterfaceToObject, AnyObject, GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A tool for fine tuning the grid in a Scene
-   * @typeParam Options - the type of the options object
-   */
-  class GridConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
-    Options,
-    Scene.ConfiguredInstance
-  > {
-    constructor(scene: Scene.ConfiguredInstance, sheet: GridConfig["sheet"], options?: Partial<Options>);
-
-    /**
-     * Track the Scene Configuration sheet reference
-     */
-    sheet: SceneConfig;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "grid-config",
-     *   template: "templates/scene/grid-config.html",
-     *   title: game.i18n.localize("SCENES.GridConfigTool"),
-     *   width: 480,
-     *   height: "auto",
-     *   closeOnSubmit: true,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): typeof FormApplication.defaultOptions;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<GridConfig.GridConfigData>>;
-
-    protected override _getSubmitData(updateData?: AnyObject | null): InterfaceToObject<GridConfig.FormData>;
-
-    override close(options?: FormApplication.CloseOptions): ReturnType<FormApplication["close"]>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle keyboard events.
-     * @param event - The original keydown event
-     * @internal
-     */
-    protected _onKeyDown(event: KeyboardEvent): void;
-
-    /**
-     * Handle mousewheel events.
-     * @param event - The original wheel event
-     * @internal
-     */
-    protected _onWheel(event: WheelEvent): void;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: GridConfig.FormData): Promise<void>;
-
-    /**
-     * Temporarily refresh the display of the BackgroundLayer and GridLayer for the new pending dimensions
-     * @param options - Options which define how the refresh is performed
-     * @internal
-     */
-    protected _refresh(options?: {
-      /**
-       * Refresh the background display?
-       * @defaultValue `false`
-       */
-      background?: boolean;
-
-      /**
-       * Refresh the grid display?
-       * @defaultValue `false`
-       */
-      grid?: boolean;
-    }): void;
-
-    /**
-     * Reset the scene back to its original settings
-     * @internal
-     */
-    protected _reset(): Promise<void>;
-
-    /**
-     * Scale the background size relative to the grid size
-     * @param delta - The directional change in background size
-     * @internal
-     */
-    protected _scaleBackgroundSize(delta: number): void;
-
-    /**
-     * Scale the grid size relative to the background image.
-     * When scaling the grid size in this way, constrain the allowed values between 50px and 300px.
-     * @param delta - The grid size in pixels
-     * @internal
-     */
-    protected _scaleGridSize(delta: number): void;
-
-    /**
-     * Shift the background image relative to the grid layer
-     * @param position - The position configuration to preview
-     * @internal
-     */
-    protected _shiftBackground(position?: {
-      /**
-       * The number of pixels to shift in the x-direction
-       * @defaultValue `0`
-       */
-      deltaX?: number;
-
-      /**
-       * The number of pixels to shift in the y-direction
-       * @defaultValue `0`
-       */
-      deltaY?: number;
-    }): void;
-  }
-
-  namespace GridConfig {
-    type Any = GridConfig<any>;
-
-    interface FormData {
-      "grid.type": Scene["grid"]["type"];
-      "grid.size": Scene["grid"]["size"];
-      scale: Scene["width"];
-      "background.offsetX": Scene["background"]["offsetX"];
-      "background.offsetY": Scene["background"]["offsetY"];
-    }
-
-    interface GridConfigData {
-      gridTypes: Record<foundry.CONST.GRID_TYPES, string>;
-      scale: number;
-      scene: Scene.ConfiguredInstance;
-    }
-  }
-}

package/src/foundry/client/apps/forms/image-popout.d.mts

@@ -1,179 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  interface ImagePopoutOptions extends FormApplicationOptions {
-    /**
-     * Caption text to display below the image.
-     * @defaultValue `false`
-     */
-    caption: boolean;
-
-    /**
-     * The UUID of some related {@link Document}.
-     * @defaultValue `null`
-     */
-    uuid: string | null;
-
-    /**
-     * Force showing or hiding the title.
-     */
-    showTitle: boolean;
-  }
-
-  /**
-   * An Image Popout Application which features a single image in a lightbox style frame.
-   * This popout can also be used as a form, allowing the user to edit an image which is being used.
-   * Furthermore, this application allows for sharing the display of an image with other connected players.
-   *
-   * @typeParam Options - The type of the options object
-   *
-   * @example
-   * ```typescript
-   * // Construct the Application instance
-   * const ip = new ImagePopout("path/to/image.jpg", {
-   *   title: "My Featured Image",
-   *   shareable: true,
-   *   uuid: game.actors.getName("My Hero").uuid
-   * });
-   *
-   * // Display the image popout
-   * ip.render(true);
-   *
-   * // Share the image with other connected players
-   * ip.share();
-   * ```
-   */
-  class ImagePopout<Options extends ImagePopoutOptions = ImagePopoutOptions> extends FormApplication<Options, string> {
-    constructor(src: string, options?: Partial<ImagePopout.Options>);
-
-    /**
-     * Whether the application should display video content.
-     */
-    get isVideo(): boolean;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/apps/image-popout.html",
-     *   classes: ["image-popout", "dark"],
-     *   editable: false,
-     *   resizable: true,
-     *   shareable: false,
-     *   uuid: null
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ImagePopoutOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>;
-
-    /**
-     * Test whether the title of the image popout should be visible to the user
-     */
-    isTitleVisible(): boolean;
-
-    /**
-     * Provide a reference to the Document referenced by this popout, if one exists
-     */
-    getRelatedObject(): Promise<foundry.abstract.Document.Any | null>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Determine the correct position and dimensions for the displayed image
-     * @param img - The image URL.
-     * @returns The positioning object which should be used for rendering
-     */
-    protected static getPosition(
-      img: string,
-    ): Promise<{ width: number; height: number } | { width: number; height: number; top: number; left: number }>;
-
-    /**
-     * Determine the Image dimensions given a certain path
-     * @param path - The image source.
-     */
-    static getImageSize(path: string): Promise<[width: number, height: number]>;
-
-    /**
-     * Determine the dimensions of the given video file.
-     * @param src - The URL to the video.
-     */
-    static getVideoSize(src: string): Promise<[width: number, height: number]>;
-
-    /**
-     * Share the displayed image with other connected Users
-     */
-    shareImage(options: ImagePopout.ShareImageConfig): void;
-
-    /**
-     * Handle a received request to display an image.
-     * @param config - The image configuration data.
-     */
-    protected static _handleShareImage(config: ImagePopout.ShareImageConfig): ImagePopout;
-
-    /**
-     * @remarks Not implemented for ImagePopout
-     */
-    protected override _updateObject(event: Event, formData?: object): never;
-  }
-
-  namespace ImagePopout {
-    type Any = ImagePopout<any>;
-
-    interface Options extends FormApplicationOptions {
-      /**
-       * @defaultValue `"templates/apps/image-popout.html"`
-       */
-      template: string;
-
-      /**
-       * @defaultValue `["image-popout", "dark"]`
-       */
-      classes: string[];
-
-      /**
-       * @defaultValue `false`
-       */
-      editable: boolean;
-
-      /**
-       * @defaultValue `true`
-       */
-      resizable: boolean;
-
-      /**
-       * @defaultValue `false`
-       */
-      shareable: boolean;
-
-      /**
-       * @defaultValue `null`
-       */
-      uuid: string | null;
-    }
-
-    interface ShareImageConfig {
-      /** The image URL to share. */
-      image: string;
-
-      /** The image title. */
-      title: string;
-
-      /** The UUID of a Document related to the image, used to determine permission to see the image title. */
-      uuid?: string;
-
-      /** If this is provided, the permissions of the related Document will be ignored and the title will be shown based on this parameter. */
-      showTitle?: boolean;
-
-      /** A list of user IDs to show the image to. */
-      users?: string[];
-    }
-  }
-}

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

@@ -1,26 +0,0 @@
-import "./actor.d.mts";
-import "./adventure-exporter.d.mts";
-import "./adventure-importer.d.mts";
-import "./base-sheet.d.mts";
-import "./card-config.d.mts";
-import "./cards-config.d.mts";
-import "./combat-config.d.mts";
-import "./combatant-config.d.mts";
-import "./default-sheets-config.d.mts";
-import "./effect-config.d.mts";
-import "./folder-config.d.mts";
-import "./fonts.d.mts";
-import "./grid-config.d.mts";
-import "./image-popout.d.mts";
-import "./item.d.mts";
-import "./journal-page-sheet.d.mts";
-import "./journal-sheet.d.mts";
-import "./macro-config.d.mts";
-import "./measure-template.d.mts";
-import "./ownership.d.mts";
-import "./playlist-config.d.mts";
-import "./playlist-sound-config.d.mts";
-import "./roll-table-config.d.mts";
-import "./scene-config.d.mts";
-import "./sheet-config.d.mts";
-import "./user-config.d.mts";

package/src/foundry/client/apps/forms/item.d.mts

@@ -1,58 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing a single Item document.
-   *
-   * @param item    - The Item instance being displayed within the sheet.
-   * @param options - Additional application configuration options.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class ItemSheet<
-    Options extends DocumentSheetOptions<Item.ConfiguredInstance> = DocumentSheetOptions<Item.ConfiguredInstance>,
-  > extends DocumentSheet<Options, Item.ConfiguredInstance> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/sheets/item-sheet.html",
-     *   width: 500,
-     *   closeOnSubmit: false,
-     *   submitOnClose: true,
-     *   submitOnChange: true,
-     *   resizable: true,
-     *   baseApplication: "ItemSheet",
-     *   id: "item",
-     *   secrets: [{parentSelector: ".editor"}]
-     * })
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions<Item.ConfiguredInstance>;
-
-    override get title(): string;
-
-    /**
-     * A convenience reference to the Item document
-     */
-    get item(): this["object"];
-
-    /**
-     * The Actor instance which owns this item. This may be null if the item is
-     * unowned.
-     */
-    get actor(): this["item"]["actor"];
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ItemSheet.ItemSheetData>>;
-  }
-
-  namespace ItemSheet {
-    type Any = ItemSheet<any>;
-
-    interface ItemSheetData<
-      Options extends DocumentSheetOptions<Item.ConfiguredInstance> = DocumentSheetOptions<Item.ConfiguredInstance>,
-    > extends DocumentSheet.DocumentSheetData<Options, Item.ConfiguredInstance> {
-      item: this["document"];
-    }
-  }
-}