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

package/src/foundry/client/applications/handlebars.d.mts

@@ -0,0 +1,475 @@
+import type { AnyObject } from "../../../utils/index.d.mts";
+import type { FormInputConfig, NumberInputConfig, SelectInputConfig } from "#client/applications/forms/fields.d.mts";
+
+/**
+ * Get a template from the server by fetch request and caching the retrieved result
+ * @param path - The web-accessible HTML template URL
+ * @param id   - An ID to register the partial with.
+ * @returns A Promise which resolves to the compiled Handlebars template
+ */
+export function getTemplate(path: string, id?: string): Promise<Handlebars.TemplateDelegate>;
+
+/**
+ * Load and cache a set of templates by providing an Array of paths
+ * @param paths - An array of template file paths to load, or an object of Handlebars partial IDs to paths.
+ *
+ * @example Loading a list of templates.
+ * ```js
+ * await loadTemplates(["templates/apps/foo.html", "templates/apps/bar.html"]);
+ * ```
+ * ```hbs
+ * <!-- Include a pre-loaded template as a partial -->
+ * {{> "templates/apps/foo.html" }}
+ * ```
+ *
+ * @example Loading an object of templates.
+ * ```js
+ * await loadTemplates({
+ *   foo: "templates/apps/foo.html",
+ *   bar: "templates/apps/bar.html"
+ * });
+ * ```
+ * ```hbs
+ * <!-- Include a pre-loaded template as a partial -->
+ * {{> foo }}
+ * ```
+ */
+export function loadTemplates(paths: string[] | Record<string, string>): Promise<Handlebars.TemplateDelegate[]>;
+
+/**
+ * Get and render a template using provided data and handle the returned HTML
+ * Support asynchronous file template file loading with a client-side caching layer
+ *
+ * Allow resolution of prototype methods and properties since this all occurs within the safety of the client.
+ * @see {@link https://handlebarsjs.com/api-reference/runtime-options.html#options-to-control-prototype-access}
+ *
+ * @param path - The file path to the target HTML template
+ * @param data - A data object against which to compile the template
+ *
+ * @returns Returns the compiled and rendered template as a string
+ */
+// TODO(LukeAbby): Create a registry for templates or some abstraction to make this type safe.
+export function renderTemplate(path: string, data: AnyObject): Promise<string>;
+
+/**
+ * For checkboxes, if the value of the checkbox is true, add the "checked" property, otherwise add nothing.
+ *
+ * @example
+ * ```hbs
+ * <label>My Checkbox</label>
+ * <input type="checkbox" name="myCheckbox" {{checked myCheckbox}}>
+ * ```
+ */
+export function checked(value: unknown): string;
+
+/**
+ * For use in form inputs. If the supplied value is truthy, add the "disabled" property, otherwise add nothing.
+ *
+ * @example
+ * ```hbs
+ * <button type="submit" {{disabled myValue}}>Submit</button>
+ * ```
+ */
+export function disabled(value: unknown): string;
+
+/**
+ * Concatenate a number of string terms into a single string.
+ * This is useful for passing arguments with variable names.
+ * @param values - The values to concatenate
+ *
+ * @example Concatenate several string parts to create a dynamic variable
+ * ```handlebars
+ * {{filePicker target=(concat "faces." i ".img") type="image"}}
+ * ```
+ */
+export function concat(...values: string[]): Handlebars.SafeString;
+
+/**
+ * Construct an editor element for rich text editing with TinyMCE or ProseMirror.
+ * @param content - The content to display and edit
+ *
+ * @example
+ * ```hbs
+ * {{editor world.description target="description" button=false engine="prosemirror" collaborate=false}}
+ * ```
+ */
+export function editor(content: string, options: TextEditorOptions): Handlebars.SafeString;
+
+/**
+ * A ternary expression that allows inserting A or B depending on the value of C.
+ * @param options - Helper options
+ * @returns The ternary result
+ *
+ * @example Ternary if-then template usage
+ * ```hbs
+ * {{ifThen true "It is true" "It is false"}}
+ * ```
+ */
+export function ifThen(options: IfThenOptions): string;
+
+/**
+ * Translate a provided string key by using the loaded dictionary of localization strings.
+ *
+ * @example Translate a provided localization string, optionally including formatting parameters
+ * ```handlebars
+ * <label>{{localize "ACTOR.Create"}}</label> <!-- "Create Actor" -->
+ * <label>{{localize "CHAT.InvalidCommand" command=foo}}</label> <!-- "foo is not a valid chat message command." -->
+ * ```
+ */
+export function localize(value: string, options: LocalizeOptions): string;
+
+/**
+ * A string formatting helper to display a number with a certain fixed number of decimals and an explicit sign.
+ * @param value   - A numeric value to format
+ * @param options - Additional options which customize the resulting format
+ * @returns The formatted string to be included in a template
+ *
+ * @example
+ * ```hbs
+ * {{formatNumber 5.5}} <!-- 5.5 -->
+ * {{formatNumber 5.5 decimals=2}} <!-- 5.50 -->
+ * {{formatNumber 5.5 decimals=2 sign=true}} <!-- +5.50 -->
+ * {{formatNumber null decimals=2 sign=false}} <!-- NaN -->
+ * {{formatNumber undefined decimals=0 sign=true}} <!-- NaN -->
+ * ```
+ */
+export function numberFormat(value: string | number, options: NumberFormatOptions): string;
+
+/**
+ * Render a form input field of type number with value appropriately rounded to step size.
+ *
+ * @example
+ * ```hbs
+ * {{numberInput value name="numberField" step=1 min=0 max=10}}
+ * ```
+ */
+export function numberInput(value: string, options: NumberInputOptions): Handlebars.SafeString;
+
+/**
+ * A helper to create a set of radio checkbox input elements in a named set.
+ * The provided keys are the possible radio values while the provided values are human readable labels.
+ *
+ * @param name     - The radio checkbox field name
+ * @param choices  - A mapping of radio checkbox values to human readable labels
+ * @param options  - Options which customize the radio boxes creation
+ *
+ * @example The provided input data
+ * ```typescript
+ * let groupName = "importantChoice";
+ * let choices = {a: "Choice A", b: "Choice B"};
+ * let chosen = "a";
+ * ```
+ *
+ * @example The template HTML structure
+ * ```handlebars
+ * <div class="form-group">
+ *   <label>Radio Group Label</label>
+ *   <div class="form-fields">
+ *     {{radioBoxes groupName choices checked=chosen localize=true}}
+ *   </div>
+ * </div>
+ * ```
+ */
+export function radioBoxes(
+  name: string,
+  choices: Record<string, string>,
+  options: RadioBoxesOptions,
+): Handlebars.SafeString;
+
+/**
+ * A helper to create a set of `<option>` elements in a `<select>` block based on a provided dictionary.
+ * The provided keys are the option values while the provided values are human readable labels.
+ * This helper supports both single-select as well as multi-select input fields.
+ *
+ * @param choices - A mapping of radio checkbox values to human readable labels
+ * @param options - Options which configure how select options are generated by the helper
+ * @returns Generated HTML safe for rendering into a Handlebars template
+ *
+ * @example The provided input data
+ * ```typescript
+ * let choices = {a: "Choice A", b: "Choice B"};
+ * let value = "a";
+ * ```
+ *
+ * @example The template HTML structure
+ * ```handlebars
+ * <select name="importantChoice">
+ *   {{selectOptions choices selected=value localize=true}}
+ * </select>
+ * ```
+ *
+ * @example The resulting HTML
+ * ```handlebars
+ * <select name="importantChoice">
+ *   <option value="a" selected>Choice A</option>
+ *   <option value="b">Choice B</option>
+ * </select>
+ * ```
+ *
+ * @example Using inverted choices
+ * ```typescript
+ * let choices = {"Choice A": "a", "Choice B": "b"};
+ * let value = "a";
+ * ```
+ *
+ * @example The template HTML structure
+ * ```handlebars
+ * <select name="importantChoice">
+ *   {{selectOptions choices selected=value inverted=true}}
+ * </select>
+ * ```
+ *
+ * @example Using nameAttr and labelAttr with objects
+ * ```typescript
+ * let choices = {foo: {key: "a", label: "Choice A"}, bar: {key: "b", label: "Choice B"}};
+ * let value = "b";
+ * ```
+ *
+ * @example The template HTML structure
+ * ```handlebars
+ * <select name="importantChoice">
+ *   {{selectOptions choices selected=value nameAttr="key" labelAttr="label"}}
+ * </select>
+ * ```
+ *
+ * @example Using nameAttr and labelAttr with arrays
+ * ```typescript
+ * let choices = [{key: "a", label: "Choice A"}, {key: "b", label: "Choice B"}];
+ * let value = "b";
+ * ```
+ *
+ * @example The template HTML structure
+ * ```handlebars
+ * <select name="importantChoice">
+ *   {{selectOptions choices selected=value nameAttr="key" labelAttr="label"}}
+ * </select>
+ * ```
+ */
+export function selectOptions(
+  choices: Record<string, string> | Array<string>,
+  options: SelectOptionsOptions,
+): Handlebars.SafeString;
+
+/**
+ * Convert a DataField instance into an HTML input fragment.
+ * @param field   - The DataField instance to convert to an input
+ * @param options - Helper options
+ */
+export function formInput<Field extends foundry.data.fields.DataField.Any>(
+  field: Field,
+  options: {
+    hash?: Parameters<Field["toInput"]>[0];
+  },
+): Handlebars.SafeString;
+
+/**
+ * Convert a DataField instance into an HTML input fragment.
+ * @param field   - The DataField instance to convert to an input
+ * @param options - Helper options
+ */
+export function formGroup<Field extends foundry.data.fields.DataField.Any>(
+  field: Field,
+  options: {
+    hash?: Parameters<Field["toFormGroup"]>[0] & Parameters<Field["toFormGroup"]>[1];
+  },
+): Handlebars.SafeString;
+
+/**
+ * @deprecated since v12, will be removed in v14
+ */
+export function filePicker(options: FilePickerOptions): Handlebars.SafeString | string;
+
+/**
+ * @deprecated since v12, will be removed in v14
+ */
+export function colorPicker(options: ColorPickerOptions): Handlebars.SafeString;
+
+/**
+ * @deprecated since v12, will be removed in v14
+ */
+export function select(selected: string, options: SelectOptions): string;
+
+/**
+ * @deprecated since v13, will be removed in v15
+ * @remarks "The \{\{rangePicker\}\} Handlebars helper is deprecated and replaced by use of the <range-picker> custom HTML element"
+ */
+export function rangePicker(options: RangePickerOptions): Handlebars.SafeString;
+
+interface ColorPickerOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * The name of the field to create
+     */
+    name?: string | undefined;
+
+    /**
+     * The current color value
+     */
+    value?: string | undefined;
+
+    /**
+     * A default color string if a value is not provided
+     */
+    default?: string | undefined;
+  };
+}
+
+interface TextEditorOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * The named target data element
+     */
+    target: string;
+
+    /**
+     * Include a button used to activate the editor later?
+     */
+    button?: boolean | undefined;
+
+    /**
+     * A specific CSS class to add to the editor container
+     */
+    class?: string | undefined;
+
+    /**
+     * Is the text editor area currently editable?
+     * @defaultValue `true`
+     */
+    editable?: boolean | undefined;
+
+    /**
+     * The engine editor to use, see {@linkcode TextEditor.create}
+     * @defaultValue `"tinymce"`
+     */
+    engine?: "tinymce" | "prosemirror" | undefined;
+
+    /**
+     * Whether to turn on collaborative editing features for ProseMirror
+     * @defaultValue `false`
+     */
+    collaborate?: boolean | undefined;
+  };
+}
+
+interface FilePickerOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * The type of FilePicker instance to display
+     */
+    type?: foundry.applications.apps.FilePicker.Type;
+
+    /**
+     * The field name in the target data
+     */
+    target: string;
+  };
+}
+
+interface IfThenOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * The test criteria
+     */
+    criteria: boolean;
+
+    /**
+     * The string to output if true
+     */
+    ifTrue: string;
+
+    /**
+     * The string to output if false
+     */
+    ifFalse: string;
+  };
+}
+
+interface LocalizeOptions extends Partial<Handlebars.HelperOptions> {
+  hash: Record<string, unknown>;
+}
+
+interface NumberFormatOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * The number of decimal places to include in the resulting string
+     * @defaultValue `0`
+     */
+    decimals?: number | undefined;
+
+    /**
+     * Whether to include an explicit "+" sign for positive numbers
+     * @defaultValue `false`
+     */
+    sign?: boolean | undefined;
+  };
+}
+
+interface NumberInputOptions extends Partial<Handlebars.HelperOptions> {
+  hash: FormInputConfig<number> &
+    NumberInputConfig & {
+      /**
+       * @defaultValue `""`
+       */
+      class?: string;
+    };
+}
+
+interface RadioBoxesOptions extends Partial<Handlebars.HelperOptions> {
+  hash: {
+    /**
+     * Which key is currently checked?
+     * @defaultValue `null`
+     */
+    checked?: string | undefined;
+
+    /**
+     * Pass each label through string localization?
+     * @defaultValue `false`
+     */
+    localize?: boolean | undefined;
+  };
+}
+
+interface RangePickerOptions extends Partial<Handlebars.HelperOptions> {
+  /**
+   * The name of the field to create
+   * @defaultValue `"range"`
+   */
+  name?: string;
+
+  /**
+   * The current range value
+   */
+  value?: number;
+
+  /**
+   * The minimum allowed value
+   */
+  min?: number;
+
+  /**
+   * The maximum allowed value
+   */
+  max?: number;
+
+  /**
+   * The allowed step size
+   */
+  step?: number;
+}
+
+interface SelectOptions extends Handlebars.HelperOptions {}
+
+interface SelectOptionsOptions extends Partial<Handlebars.HelperOptions> {
+  hash: SelectInputConfig & {
+    /**
+     * The currently selected value or values
+     */
+    selected?: string | string[] | undefined;
+
+    /**
+     * Invert the key/value order of a provided choices object
+     */
+    inverted?: boolean | undefined;
+  };
+}

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

@@ -0,0 +1,50 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type DrawingHUD from "./drawing-hud.d.mts";
+import type TileHUD from "./tile-hud.d.mts";
+import type TokenHUD from "./token-hud.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      HeadsUpDisplayContainer: HeadsUpDisplayContainer.Any;
+    }
+  }
+}
+
+/**
+ * The Heads-Up Display Container is a canvas-sized Application which renders HTML overtop of the game canvas.
+ * @remarks TODO: Stub
+ */
+declare class HeadsUpDisplayContainer<
+  RenderContext extends HeadsUpDisplayContainer.RenderContext = HeadsUpDisplayContainer.RenderContext,
+  Configuration extends HeadsUpDisplayContainer.Configuration = HeadsUpDisplayContainer.Configuration,
+  RenderOptions extends HeadsUpDisplayContainer.RenderOptions = HeadsUpDisplayContainer.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
+  token: TokenHUD;
+
+  tile: TileHUD;
+
+  drawing: DrawingHUD;
+}
+
+declare namespace HeadsUpDisplayContainer {
+  interface Any extends AnyHeadsUpDisplayContainer {}
+  interface AnyConstructor extends Identity<typeof AnyHeadsUpDisplayContainer> {}
+
+  interface RenderContext extends ApplicationV2.RenderContext {}
+
+  interface Configuration extends ApplicationV2.Configuration {}
+
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyHeadsUpDisplayContainer extends HeadsUpDisplayContainer<
+  HeadsUpDisplayContainer.RenderContext,
+  HeadsUpDisplayContainer.Configuration,
+  HeadsUpDisplayContainer.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default HeadsUpDisplayContainer;

package/src/foundry/client/applications/hud/drawing-hud.d.mts

@@ -0,0 +1,47 @@
+import type BasePlaceableHUD from "./placeable-hud.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type { Identity } from "#utils";
+import type { Drawing } from "#client/canvas/placeables/_module.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      DrawingHUD: DrawingHUD.Any;
+    }
+  }
+}
+
+/**
+ * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Drawing objects.
+ * The DrawingHUD implementation can be configured and replaced via {@link CONFIG.Drawing.hudClass}.
+ * @remarks TODO: Stub
+ */
+declare class DrawingHUD<
+  RenderContext extends DrawingHUD.RenderContext = DrawingHUD.RenderContext,
+  Configuration extends DrawingHUD.Configuration = DrawingHUD.Configuration,
+  RenderOptions extends DrawingHUD.RenderOptions = DrawingHUD.RenderOptions,
+> extends HandlebarsApplicationMixin(BasePlaceableHUD)<
+  Drawing.Implementation,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}
+
+declare namespace DrawingHUD {
+  interface Any extends AnyDrawingHUD {}
+  interface AnyConstructor extends Identity<typeof AnyDrawingHUD> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, BasePlaceableHUD.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, BasePlaceableHUD.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, BasePlaceableHUD.RenderOptions {}
+}
+
+declare abstract class AnyDrawingHUD extends DrawingHUD<
+  DrawingHUD.RenderContext,
+  DrawingHUD.Configuration,
+  DrawingHUD.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default DrawingHUD;

package/src/foundry/client/applications/hud/placeable-hud.d.mts

@@ -0,0 +1,66 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type { PlaceableObject } from "#client/canvas/placeables/_module.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      BasePlaceableHUD: BasePlaceableHUD.Any;
+    }
+  }
+}
+
+/**
+ * An abstract base class for displaying a heads-up-display interface bound to a Placeable Object on the Canvas.
+ * @remarks TODO: Stub
+ */
+declare class BasePlaceableHUD<
+  ActiveHUDObject extends PlaceableObject.Any = PlaceableObject,
+  RenderContext extends object = BasePlaceableHUD.RenderContext,
+  Configuration extends BasePlaceableHUD.Configuration = BasePlaceableHUD.Configuration,
+  RenderOptions extends BasePlaceableHUD.RenderOptions = BasePlaceableHUD.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
+  /**
+   * Reference a PlaceableObject this HUD is currently bound to.
+   */
+  get object(): ActiveHUDObject;
+
+  /**
+   * Convenience access to the Document which this HUD modifies.
+   */
+  get document(): ActiveHUDObject["document"];
+
+  /**
+   * Convenience access for the canvas layer which this HUD modifies
+   */
+  get layer(): ActiveHUDObject["layer"];
+}
+
+declare namespace BasePlaceableHUD {
+  interface Any extends AnyBasePlaceableHUD {}
+  interface AnyConstructor extends Identity<typeof AnyBasePlaceableHUD> {}
+
+  // TODO: Make generic so it can extend the document source data (calls document#toObject with Object.assign)
+  interface RenderContext {
+    id: string;
+    classes: string;
+    appId: string;
+    isGM: boolean;
+    isGamePaused: boolean;
+    // TODO: Remaining properties
+  }
+
+  interface Configuration extends ApplicationV2.Configuration {}
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyBasePlaceableHUD extends BasePlaceableHUD<
+  PlaceableObject.Any,
+  object,
+  BasePlaceableHUD.Configuration,
+  BasePlaceableHUD.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default BasePlaceableHUD;

package/src/foundry/client/applications/hud/tile-hud.d.mts

@@ -0,0 +1,43 @@
+import type BasePlaceableHUD from "./placeable-hud.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type { Identity } from "#utils";
+import type { Tile } from "#client/canvas/placeables/_module.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      TileHUD: TileHUD.Any;
+    }
+  }
+}
+
+/**
+ * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects.
+ * The TileHUD implementation can be configured and replaced via {@link CONFIG.Tile.hudClass}.
+ * @remarks TODO: Stub
+ */
+declare class TileHUD<
+  RenderContext extends TileHUD.RenderContext = TileHUD.RenderContext,
+  Configuration extends TileHUD.Configuration = TileHUD.Configuration,
+  RenderOptions extends TileHUD.RenderOptions = TileHUD.RenderOptions,
+> extends HandlebarsApplicationMixin(BasePlaceableHUD)<
+  Tile.Implementation,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}
+
+declare namespace TileHUD {
+  interface Any extends AnyTileHUD {}
+  interface AnyConstructor extends Identity<typeof AnyTileHUD> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, BasePlaceableHUD.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, BasePlaceableHUD.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, BasePlaceableHUD.RenderOptions {}
+}
+
+declare abstract class AnyTileHUD extends TileHUD<TileHUD.RenderContext, TileHUD.Configuration, TileHUD.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default TileHUD;