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

package/src/foundry/client/apps/templates.d.mts

@@ -1,486 +0,0 @@
-import type {
-  FormInputConfig,
-  NumberInputConfig,
-  SelectInputConfig,
-} from "../../client-esm/applications/forms/fields.d.mts";
-
-declare global {
-  /**
-   * 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
-   */
-  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 }}
-   * ```
-   */
-  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 rendered HTML
-   */
-  function renderTemplate(path: string, data: object): Promise<string>;
-
-  /**
-   * A collection of Handlebars template helpers which can be used within HTML templates.
-   */
-  class HandlebarsHelpers {
-    /**
-     * 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}}>
-     * ```
-     */
-    static 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>
-     * ```
-     */
-    static 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"}}
-     * ```
-     */
-    static 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}}
-     * ```
-     */
-    static editor(content: string, options: HandlebarsHelpers.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"}}
-     * ```
-     */
-    static ifThen(options: HandlebarsHelpers.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." -->
-     * ```
-     */
-    static localize(value: string, options: HandlebarsHelpers.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 -->
-     * ```
-     */
-    static numberFormat(value: string | number, options: HandlebarsHelpers.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}}
-     * ```
-     */
-    static numberInput(value: string, options: HandlebarsHelpers.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>
-     * ```
-     */
-    static radioBoxes(
-      name: string,
-      choices: Record<string, string>,
-      options: HandlebarsHelpers.RadioBoxesOptions,
-    ): Handlebars.SafeString;
-
-    /**
-     * Render a pair of inputs for selecting a value in a range.
-     * @param options - Helper options
-     */
-    static rangePicker(options: HandlebarsHelpers.RangePickerOptions): 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>
-     * ```
-     */
-    static selectOptions(
-      choices: Record<string, string> | Array<string>,
-      options: HandlebarsHelpers.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
-     */
-    static 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
-     */
-    static 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
-     */
-    static filePicker(options: HandlebarsHelpers.FilePickerOptions): Handlebars.SafeString | string;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    static colorPicker(options: HandlebarsHelpers.ColorPickerOptions): Handlebars.SafeString;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    static select(selected: string, options: HandlebarsHelpers.SelectOptions): string;
-  }
-
-  namespace HandlebarsHelpers {
-    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 {@link 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?: 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/av/clients/index.d.mts

@@ -1 +0,0 @@
-import "./simplepeer.d.mts";

package/src/foundry/client/av/index.d.mts

@@ -1,4 +0,0 @@
-import "./client.d.mts";
-import "./clients/index.d.mts";
-import "./master.d.mts";
-import "./settings.d.mts";

package/src/foundry/client/core/clipboard.d.mts

@@ -1,20 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * A helper class to manage requesting clipboard permissions and provide common functionality for working with the
-   * clipboard.
-   */
-  class ClipboardHelper {
-    /**
-     * @throws `"You may not re-initialize the singleton ClipboardHelper. Use game.clipboard instead."`
-     */
-    constructor();
-
-    /**
-     * Copies plain text to the clipboard in a cross-browser compatible way.
-     * @param text - The text to copy.
-     */
-    copyPlainText(text: string): Promise<void>;
-  }
-}

package/src/foundry/client/core/document-index.d.mts

@@ -1,118 +0,0 @@
-import type { DOCUMENT_OWNERSHIP_LEVELS } from "../../common/constants.d.mts";
-
-export {};
-
-declare global {
-  /**
-   * This class is responsible for indexing all documents available in the world and storing them in a word tree structure
-   * that allows for fast searching.
-   */
-  class DocumentIndex {
-    constructor();
-    /**
-     * A collection of WordTree structures for each document type.
-     * @defaultValue `{}`
-     */
-    trees: Record<string, foundry.utils.WordTree>;
-
-    /**
-     * A reverse-lookup of a document's UUID to its parent node in the word tree.
-     * @defaultValue `{}`
-     */
-    uuids: Record<string, foundry.utils.StringTree.StringTreeNode>;
-
-    /**
-     * Returns a Promise that resolves when the indexing process is complete.
-     */
-    get ready(): Promise<void> | null;
-
-    /**
-     * Index all available documents in the world and store them in a word tree.
-     */
-    index(): Promise<void>;
-
-    /**
-     * Return entries that match the given string prefix.
-     * @param prefix  - The prefix.
-     * @param options - Additional options to configure behaviour.
-     * @returns A number of entries that have the given prefix, grouped by document type.
-     */
-    lookup(
-      prefix: string,
-      options?: {
-        /**
-         * The maximum number of items per document type to retrieve. It is important to set this
-         * value as very short prefixes will naturally match large numbers of entries. (default: `10`)
-         * (default: `10`)
-         */
-        limit?: number;
-        /**
-         * Optionally provide an array of document types. Only entries of that type
-         * will be searched for. (default: `[]`)
-         */
-        documentTypes?: string[];
-        /**
-         * A filter function to apply to each candidate entry.
-         */
-        filterEntries?: foundry.utils.StringTree.StringTreeEntryFilter;
-        /**
-         * Only return entries that the user meets this ownership level for.
-         */
-        ownership?: DOCUMENT_OWNERSHIP_LEVELS;
-      },
-    ): Record<string, foundry.utils.WordTree.WordTreeEntry[]>;
-
-    /**
-     * Add an entry to the index.
-     * @param doc - The document entry.
-     */
-    addDocument(doc: foundry.abstract.Document.Any): void;
-
-    /**
-     * Remove an entry from the index.
-     * @param doc - The document entry.
-     */
-    removeDocument(doc: foundry.abstract.Document.Any): void;
-
-    /**
-     * Replace an entry in the index with an updated one.
-     * @param doc - The document entry.
-     */
-    replaceDocument(doc: foundry.abstract.Document.Any): void;
-
-    /**
-     * Add a leaf node to the word tree index.
-     * @param doc     - The document or compendium index entry to add.
-     * @param options - Additional information for indexing.
-     * @internal
-     */
-    protected _addLeaf(
-      doc: foundry.abstract.Document.Any,
-      options?: {
-        /** The compendium that the index belongs to. */
-        pack?: CompendiumCollection.Any;
-      },
-    ): void;
-
-    /**
-     * Aggregate the compendium index and add it to the word tree index.
-     * @param pack - The compendium pack.
-     * @internal
-     */
-    protected _indexCompendium(pack: CompendiumCollection.Any): void;
-
-    /**
-     * Add all of a parent document's embedded documents to the index.
-     * @param parent - The parent document.
-     * @internal
-     */
-    protected _indexEmbeddedDocuments(parent: foundry.abstract.Document.Any): void;
-
-    /**
-     * Aggregate all documents and embedded documents in a world collection and add them to the index.
-     * @param documentName - The name of the documents to index.
-     * @internal
-     */
-    protected _indexWorldCollection(documentName: string): void;
-  }
-}

package/src/foundry/client/core/gamepad.d.mts

@@ -1,76 +0,0 @@
-export {};
-
-declare global {
-  /** Management class for Gamepad events */
-  class GamepadManager {
-    constructor();
-
-    /**
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _gamepadPoller: number | null;
-
-    /**
-     * The connected Gamepads
-     * @internal
-     */
-    protected _connectedGamepads: Map<string, GamepadManager.ConnectedGamepad>;
-
-    /**
-     * How often Gamepad polling should check for button presses
-     * @defaultValue `100`
-     */
-    static GAMEPAD_POLLER_INTERVAL_MS: number;
-
-    /**
-     * Begin listening to gamepad events.
-     */
-    protected _activateListeners(): void;
-
-    /**
-     * Handles a Gamepad Connection event, adding its info to the poll list
-     * @param event - The originating Event
-     * @internal
-     */
-    protected _onGamepadConnect(event: GamepadEvent): void;
-
-    /**
-     * Handles a Gamepad Disconnect event, removing it from consideration for polling
-     * @param event - The originating Event
-     * @internal
-     */
-    protected _onGamepadDisconnect(event: GamepadEvent): void;
-
-    /**
-     * Polls all Connected Gamepads for updates. If they have been updated, checks status of Axis and Buttons,
-     * firing off Keybinding Contexts as appropriate
-     * @internal
-     */
-    protected _pollGamepads(): void;
-
-    /**
-     * Converts a Gamepad Input event into a KeyboardEvent, then fires it
-     * @param gamepadId - The string representation of the Gamepad Input
-     * @param up        - True if the Input is pressed or active
-     * @param repeat    - True if the Input is being held
-     *                    (default: `false`)
-     * @internal
-     */
-    protected _handleGamepadInput(gamepadId: string, up: boolean, repeat?: boolean): void;
-  }
-
-  namespace GamepadManager {
-    /**
-     * Connected Gamepad info
-     * @remarks Copied from `resources/app/common/types.mjs`
-     */
-    interface ConnectedGamepad {
-      /** A map of axes values */
-      axes: Map<string, number>;
-
-      /** The Set of pressed Buttons */
-      activeButtons: Set<string>;
-    }
-  }
-}