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

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

@@ -0,0 +1,45 @@
+export {};
+
+declare global {
+  /**
+   * The Application responsible for configuring a single Combatant document within a parent Combat.
+   *
+   * @typeParam Options - the type of the options object
+   */
+  class CombatantConfig<Options extends CombatantConfig.Options = CombatantConfig.Options> extends DocumentSheet<
+    Options,
+    Combatant.ConfiguredInstance
+  > {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "combatant-config",
+     *   title: game.i18n.localize("COMBAT.CombatantConfig"),
+     *   classes: ["sheet", "combat-sheet"],
+     *   template: "templates/sheets/combatant-config.html",
+     *   width: 420
+     * });
+     * ```
+     */
+    static override get defaultOptions(): CombatantConfig.Options;
+
+    override get title(): string;
+
+    protected override _updateObject(event: Event, formData: CombatantConfig.FormData): Promise<unknown>;
+  }
+
+  namespace CombatantConfig {
+    type Any = CombatantConfig<any>;
+
+    interface Options extends DocumentSheetOptions<Combatant> {
+      id: "combatant-config";
+      title: string;
+      classes: string[];
+      template: string;
+      width: number;
+    }
+
+    type FormData = Pick<foundry.documents.BaseCombatant, "defeated" | "hidden" | "img" | "initiative" | "name">;
+  }
+}

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

@@ -0,0 +1,46 @@
+export {};
+
+declare global {
+  class DefaultSheetsConfig<
+    Options extends DefaultSheetsConfig.Options = DefaultSheetsConfig.Options,
+  > extends PackageConfiguration<Options> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   title: game.i18n.localize("SETTINGS.DefaultSheetsL"),
+     *   id: "default-sheets-config",
+     *   categoryTemplate: "templates/sidebar/apps/default-sheets-config.html",
+     *   submitButton: true
+     * });
+     * ```
+     */
+    static override get defaultOptions(): DefaultSheetsConfig.Options;
+
+    override _prepareCategoryData(): PackageConfiguration.CategoryData;
+
+    protected _updateObject(event: Event, formData?: object): Promise<unknown>;
+
+    protected _onResetDefaults(event: JQuery.ClickEvent): void;
+  }
+
+  namespace DefaultSheetsConfig {
+    type Any = DefaultSheetsConfig<any>;
+
+    interface Options extends PackageConfiguration.Options {}
+
+    interface CategorySubType {
+      type: string;
+      name: string;
+      defaultClasses: Record<string, string>;
+      defaultClass: string;
+    }
+
+    interface Category extends PackageConfiguration.Category {
+      count: number;
+      subtypes: CategorySubType[];
+    }
+
+    interface CategoryData extends PackageConfiguration.CategoryData<Category> {}
+  }
+}

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

@@ -0,0 +1,77 @@
+import type { GetDataReturnType, MaybePromise, SimpleMerge, ValueOf } from "../../../../types/utils.d.mts";
+
+declare global {
+  /**
+   * The Application responsible for configuring a single ActiveEffect document within a parent Actor or Item.
+   *
+   * @typeParam Options - the type of the options object
+   */
+  class ActiveEffectConfig<
+    Options extends
+      DocumentSheetOptions<ActiveEffect.ConfiguredInstance> = DocumentSheetOptions<ActiveEffect.ConfiguredInstance>,
+  > extends DocumentSheet<Options, ActiveEffect.ConfiguredInstance> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   classes: ["sheet", "active-effect-sheet"],
+     *   template: "templates/sheets/active-effect-config.html",
+     *   width: 560,
+     *   height: "auto",
+     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "details"}]
+     * });
+     * ```
+     */
+    static override get defaultOptions(): DocumentSheetOptions<ActiveEffect.ConfiguredInstance>;
+
+    override getData(
+      options?: Partial<Options>,
+    ): MaybePromise<GetDataReturnType<ActiveEffectConfig.ActiveEffectConfigData>>;
+
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * Provide centralized handling of mouse clicks on control buttons.
+     * Delegate responsibility out to action-specific handlers depending on the button action.
+     * @param event - The originating click event
+     */
+    protected _onEffectControl(event: MouseEvent): Promise<this>;
+
+    /**
+     * Handle adding a new change to the changes array.
+     */
+    protected _addEffectChange(): Promise<this>;
+
+    /**
+     * @param updateData - (default: `{}`)
+     */
+    override _getSubmitData(updateData?: FormApplication.OnSubmitOptions["updateData"]): Record<string, unknown>;
+    // TODO: Can we type this better?
+  }
+
+  namespace ActiveEffectConfig {
+    type Any = ActiveEffectConfig<any>;
+
+    type ActiveEffectConfigData<
+      Options extends
+        DocumentSheetOptions<ActiveEffect.ConfiguredInstance> = DocumentSheetOptions<ActiveEffect.ConfiguredInstance>,
+    > = SimpleMerge<
+      DocumentSheet.DocumentSheetData<Options, ActiveEffect.ConfiguredInstance>,
+      {
+        labels: {
+          transfer: {
+            name: string;
+            hint: string;
+          };
+        };
+        effect: ActiveEffectConfig["object"]; // Backwards compatibility
+        data: ActiveEffectConfig["object"];
+        isActorEffect: boolean;
+        isItemEffect: boolean;
+        submitText: string;
+        modes: Record<ValueOf<typeof CONST.ACTIVE_EFFECT_MODES>, string>;
+        descriptionHTML: string;
+      }
+    >;
+  }
+}

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

@@ -0,0 +1,60 @@
+import type { GetDataReturnType, MaybePromise, ValueOf } from "../../../../types/utils.d.mts";
+
+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

@@ -0,0 +1,168 @@
+import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+
+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

@@ -0,0 +1,144 @@
+import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
+import type { AnyObject, GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+
+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;
+    }
+  }
+}