@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

package/src/foundry/client-esm/applications/elements/document-tags.d.mts

@@ -1,92 +0,0 @@
-import type { FormInputConfig } from "../forms/fields.d.mts";
-import type AbstractFormInputElement from "./form-element.d.mts";
-
-/**
- * A custom HTMLElement used to render a set of associated Documents referenced by UUID.
- */
-declare class HTMLDocumentTagsElement extends AbstractFormInputElement<Record<string, string> | string | string[]> {
-  constructor();
-
-  static override tagName: "document-tags";
-
-  protected _value: Record<string, string>;
-
-  set type(value: string);
-
-  /**
-   * Restrict this element to documents of a particular type.
-   */
-  get type(): string | null;
-
-  /**
-   * Restrict to only allow referencing a single Document instead of an array of documents.
-   */
-  get single(): boolean;
-  set single(value: boolean);
-
-  set max(value: number);
-
-  /**
-   * Allow a maximum number of documents to be tagged to the element.
-   */
-  get max(): number;
-
-  /**
-   * Initialize innerText or an initial value attribute of the element as a serialized JSON array.
-   */
-  protected _initializeTags(): void;
-
-  protected override _buildElements(): (HTMLButtonElement | HTMLDivElement)[];
-
-  protected override _refresh(): void;
-
-  /**
-   * Create an HTML string fragment for a single document tag.
-   * @param uuid     - The document UUID
-   * @param name     - The document name
-   * @param editable - Is the tag editable?
-   *                   (default: `true`)
-   */
-  static renderTag(uuid: string, name: string, editable?: boolean): HTMLDivElement;
-
-  /**
-   * Validate that the tagged document is allowed to be added to this field.
-   * Subclasses may impose more strict validation as to which types of documents are allowed.
-   * @param document - A candidate document or compendium index entry to tag
-   * @throws An error if the candidate document is not allowed
-   */
-  _validateDocument(document: foundry.abstract.Document.Any | Record<string, unknown>): void;
-
-  protected override _getValue(): string | string[];
-
-  protected override _setValue(value: string | string[]): void;
-
-  protected override _toggleDisabled(disabled: boolean): void;
-
-  /**
-   * Create a HTMLDocumentTagsElement using provided configuration data.
-   */
-  static create(config: HTMLDocumentTagsElement.DocumentTagsInputConfig): HTMLDocumentTagsElement;
-}
-
-declare namespace HTMLDocumentTagsElement {
-  interface DocumentTagsInputConfig extends FormInputConfig<unknown> {
-    /**
-     * A specific document type in CONST.ALL_DOCUMENT_TYPES
-     */
-    type?: foundry.CONST.ALL_DOCUMENT_TYPES;
-
-    /**
-     * Only allow referencing a single document. In this case the submitted form value will
-     *    be a single UUID string rather than an array
-     */
-    single?: boolean;
-
-    /**
-     * Only allow attaching a maximum number of documents
-     */
-    max?: number;
-  }
-}
-
-export default HTMLDocumentTagsElement;

package/src/foundry/client-esm/applications/elements/file-picker.d.mts

@@ -1,62 +0,0 @@
-import type { FormInputConfig } from "../forms/fields.d.mts";
-import type AbstractFormInputElement from "./form-element.d.mts";
-
-/**
- * A custom HTML element responsible for rendering a file input field and associated FilePicker button.
- */
-declare class HTMLFilePickerElement extends AbstractFormInputElement<string> {
-  constructor();
-
-  static override tagName: "file-picker";
-
-  /**
-   * The file path selected.
-   */
-  input: HTMLInputElement;
-
-  /**
-   * A button to open the file picker interface.
-   */
-  button: HTMLButtonElement;
-
-  /**
-   * A reference to the FilePicker application instance originated by this element.
-   */
-  picker: FilePicker;
-
-  /**
-   * A type of file which can be selected in this field.
-   * @see {@link FilePicker.FILE_TYPES | `FilePicker.FILE_TYPES`}
-   */
-  get type(): FilePicker.Type;
-  set type(value: FilePicker.Type);
-
-  /**
-   * Prevent uploading new files as part of this element's FilePicker dialog.
-   */
-  get noupload(): boolean;
-  set noupload(value: boolean);
-
-  protected override _buildElements(): (HTMLInputElement | HTMLButtonElement)[];
-
-  protected override _toggleDisabled(disabled: boolean): void;
-
-  protected override _activateListeners(): void;
-
-  protected override _onClick(event: PointerEvent): void;
-
-  /**
-   * Create a HTMLFilePickerElement using provided configuration data.
-   */
-  static create(config: HTMLFilePickerElement.FilePickerInputConfig): HTMLElement;
-}
-
-declare namespace HTMLFilePickerElement {
-  interface FilePickerInputConfig extends FormInputConfig<string> {
-    type?: FilePicker.Type;
-    placeholder?: string;
-    noupload?: boolean;
-  }
-}
-
-export default HTMLFilePickerElement;

package/src/foundry/client-esm/applications/elements/form-element.d.mts

@@ -1,106 +0,0 @@
-/**
- * An abstract custom HTMLElement designed for use with form inputs.
- * @remarks Fires input  - An "input" event when the value of the input changes
- * @remarks Fires change - A "change" event when the value of the element changes
- */
-export default abstract class AbstractFormInputElement<FormInputValueType> extends HTMLElement {
-  constructor();
-
-  /**
-   * The HTML tag name used by this element.
-   */
-  static tagName: string;
-
-  /**
-   * Declare that this custom element provides form element functionality.
-   */
-  static formAssociated: boolean;
-
-  /**
-   * Attached ElementInternals which provides form handling functionality.
-   */
-  protected _internals: ElementInternals;
-
-  /**
-   * The form this element belongs to.
-   */
-  get form(): HTMLFormElement;
-  set name(value: string);
-
-  /**
-   * The input element name.
-   */
-  get name(): string;
-  set value(value: FormInputValueType);
-
-  /**
-   * The value of the input element.
-   */
-  get value(): FormInputValueType;
-
-  /**
-   * The underlying value of the element.
-   */
-  protected _value: FormInputValueType;
-
-  /**
-   * Return the value of the input element which should be submitted to the form.
-   */
-  protected _getValue(): FormInputValueType;
-
-  /**
-   * Translate user-provided input value into the format that should be stored.
-   * @param value - A new value to assign to the element
-   * @throws An error if the provided value is invalid
-   */
-  protected _setValue(value: FormInputValueType): void;
-
-  set disabled(value: boolean);
-  /**
-   * Is this element disabled?
-   */
-  get disabled(): boolean;
-  /**
-   * Is this field editable? The field can be neither disabled nor readonly.
-   */
-  get editable(): boolean;
-
-  /**
-   * Special behaviors that the subclass should implement when toggling the disabled state of the input.
-   * @param disabled - The new disabled state
-   */
-  protected _toggleDisabled(disabled: boolean): void;
-
-  /**
-   * Initialize the custom element, constructing its HTML.
-   */
-  connectedCallback(): void;
-
-  /**
-   * Create the HTML elements that should be included in this custom element.
-   * Elements are returned as an array of ordered children.
-   */
-  protected _buildElements(): HTMLElement[];
-
-  /**
-   * Refresh the active state of the custom element.
-   */
-  protected _refresh(): void;
-
-  /**
-   * Apply key attributes on the containing custom HTML element to input elements contained within it.
-   * @internal
-   */
-  protected _applyInputAttributes(input: HTMLInputElement): void;
-
-  /**
-   * Activate event listeners which add dynamic behavior to the custom element.
-   */
-  protected _activateListeners(): void;
-
-  /**
-   * Special handling when the custom element is clicked. This should be implemented to transfer focus to an
-   * appropriate internal element.
-   */
-  protected _onClick(event: PointerEvent): void;
-}

package/src/foundry/client-esm/applications/elements/multi-select.d.mts

@@ -1,105 +0,0 @@
-import type { FormInputConfig, SelectInputConfig } from "../forms/fields.d.mts";
-import type AbstractFormInputElement from "./form-element.d.mts";
-
-/**
- * An abstract base class designed to standardize the behavior for a multi-select UI component.
- * Multi-select components return an array of values as part of form submission.
- * Different implementations may provide different experiences around how inputs are presented to the user.
- */
-export abstract class AbstractMultiSelectElement extends AbstractFormInputElement<Set<string> | string[]> {
-  constructor();
-
-  protected _value: Set<string>;
-
-  /**
-   * Predefined <option> and <optgroup> elements which were defined in the original HTML.
-   */
-  protected _options: (HTMLOptionElement | HTMLOptGroupElement)[];
-
-  /**
-   * An object which maps option values to displayed labels.
-   */
-  protected _choices: Record<string, string>;
-
-  /**
-   * Preserve existing <option> and <optgroup> elements which are defined in the original HTML.
-   */
-  protected _initialize(): void;
-
-  /**
-   * Mark a choice as selected.
-   * @param value - The value to add to the chosen set
-   */
-  select(value: string): void;
-
-  /**
-   * Mark a choice as un-selected.
-   * @param value - The value to delete from the chosen set
-   */
-  unselect(value: string): void;
-
-  protected override _getValue(): string[];
-
-  protected override _setValue(value: string[]): void;
-}
-/**
- * Provide a multi-select workflow using a select element as the input mechanism.
- *
- * @example Multi-Select HTML Markup
- * ```html
- * <multi-select name="select-many-things">
- *   <optgroup label="Basic Options">
- *     <option value="foo">Foo</option>
- *     <option value="bar">Bar</option>
- *     <option value="baz">Baz</option>
- *   </optgroup>
- *   <optgroup label="Advanced Options">
- *    <option value="fizz">Fizz</option>
- *     <option value="buzz">Buzz</option>
- *   </optgroup>
- * </multi-select>
- * ```
- */
-export class HTMLMultiSelectElement extends AbstractMultiSelectElement {
-  static override tagName: "multi-select";
-
-  protected override _buildElements(): (HTMLDivElement | HTMLSelectElement)[];
-
-  protected override _refresh(): void;
-
-  protected override _toggleDisabled(disabled: boolean): void;
-
-  /**
-   * Create a HTMLMultiSelectElement using provided configuration data.
-   */
-  static create(config: FormInputConfig<string[]> & Omit<SelectInputConfig, "blank">): HTMLMultiSelectElement;
-}
-/**
- * Provide a multi-select workflow as a grid of input checkbox elements.
- *
- * @example Multi-Checkbox HTML Markup
- * ```html
- * <multi-checkbox name="check-many-boxes">
- *   <optgroup label="Basic Options">
- *     <option value="foo">Foo</option>
- *     <option value="bar">Bar</option>
- *     <option value="baz">Baz</option>
- *   </optgroup>
- *   <optgroup label="Advanced Options">
- *    <option value="fizz">Fizz</option>
- *     <option value="buzz">Buzz</option>
- *   </optgroup>
- * </multi-checkbox>
- * ```
- */
-export class HTMLMultiCheckboxElement extends AbstractMultiSelectElement {
-  static override tagName: "multi-checkbox";
-
-  protected override _buildElements(): (HTMLFieldSetElement | HTMLLabelElement)[];
-
-  protected override _refresh(): void;
-
-  protected override _activateListeners(): void;
-
-  protected override _toggleDisabled(disabled: boolean): void;
-}

package/src/foundry/client-esm/applications/elements/prosemirror-editor.d.mts

@@ -1,53 +0,0 @@
-import type ProseMirrorPlugin from "#common/prosemirror/plugin.d.mts";
-import type { FormInputConfig } from "../forms/fields.d.mts";
-import type AbstractFormInputElement from "./form-element.d.mts";
-
-/**
- * A custom HTML element responsible displaying a ProseMirror rich text editor.
- */
-declare class HTMLProseMirrorElement extends AbstractFormInputElement<string> {
-  constructor();
-
-  static override tagName: "prose-mirror";
-
-  /**
-   * Actions to take when the custom element is removed from the document.
-   */
-  disconnectedCallback(): void;
-
-  override _buildElements(): (HTMLButtonElement | HTMLDivElement)[];
-
-  override _getValue(): string;
-  /**
-   * Configure ProseMirror editor plugins.
-   */
-  protected _configurePlugins(): Record<string, ProseMirrorPlugin>;
-
-  override _toggleDisabled(disabled: boolean): void;
-
-  /**
-   * Create a HTMLProseMirrorElement using provided configuration data.
-   */
-  static create(config: HTMLProseMirrorElement.ProseMirrorInputConfig): HTMLProseMirrorElement;
-}
-
-declare namespace HTMLProseMirrorElement {
-  interface ProseMirrorInputConfig extends FormInputConfig<string> {
-    /** Is this editor toggled (true) or always active (false) */
-    toggled: boolean;
-
-    /** If the editor is toggled, provide the enrichedHTML which is displayed while the editor is not active. */
-    enriched: string;
-
-    /** Does this editor instance support collaborative editing? */
-    collaborate: boolean;
-
-    /** Should the editor be presented in compact mode? */
-    compact: boolean;
-
-    /** A Document UUID. Required for collaborative editing */
-    documentUUID: string;
-  }
-}
-
-export default HTMLProseMirrorElement;

package/src/foundry/client-esm/applications/forms/fields.d.mts

@@ -1,270 +0,0 @@
-import type { NullishProps } from "fvtt-types/utils";
-
-export type CustomFormGroup = (
-  field: foundry.data.fields.DataField,
-  groupConfig: FormGroupConfig,
-  inputConfig: FormInputConfig<unknown>,
-) => HTMLDivElement;
-
-export type CustomFormInput = (
-  field: foundry.data.fields.DataField,
-  config: FormInputConfig<unknown>,
-) => HTMLElement | HTMLCollection;
-
-interface _FormGroupConfig {
-  /**
-   * An optional units string which is appended to the label
-   */
-  units: string;
-
-  /**
-   * Hint text displayed as part of the form group
-   */
-  hint: string | null | undefined;
-
-  /**
-   * Some parent CSS id within which field names are unique. If provided,
-   *                     this root ID is used to automatically assign "id" attributes to input
-   *                     elements and "for" attributes to corresponding labels
-   */
-  rootId: string | null | undefined;
-
-  /**
-   * An array of CSS classes applied to the form group element
-   */
-  classes: string[] | null | undefined;
-
-  /**
-   * Is the "stacked" class applied to the form group
-   */
-  stacked: boolean | null | undefined;
-
-  /**
-   * Should labels or other elements within this form group be
-   *            automatically localized?
-   */
-  localize: boolean | null | undefined;
-
-  /**
-   * A custom form group widget function which replaces the default
-   *            group HTML generation
-   */
-  widget: CustomFormGroup | null | undefined;
-}
-
-export interface FormGroupConfig extends NullishProps<_FormGroupConfig> {
-  /**
-   * A text label to apply to the form group
-   */
-  label: string;
-
-  /**
-   * An HTML element or collection of elements which provide the inputs
-   * for the group
-   */
-  input: HTMLElement | HTMLCollection;
-}
-
-interface _FormInputConfig<FormInputValue = unknown> {
-  /**
-   * The current value of the form element
-   */
-  value: FormInputValue;
-
-  /**
-   * Is the field required?
-   * @defaultValue `false`
-   */
-  required: boolean;
-
-  /**
-   * Is the field disabled?
-   * @defaultValue `false`
-   */
-  disabled: boolean;
-
-  /**
-   * Is the field readonly?
-   * @defaultValue `false`
-   */
-  readonly: boolean;
-
-  /**
-   * Is the field autofocused?
-   * @defaultValue `false`
-   */
-  autofocus: boolean;
-
-  /**
-   * Localize values of this field?
-   * @defaultValue `false`
-   */
-  localize: boolean;
-
-  /**
-   * Additional dataset attributes to assign to the input
-   */
-  dataset: Record<string, string>;
-
-  /**
-   * A placeholder value, if supported by the element type
-   */
-  placeholder: string;
-
-  input: CustomFormInput;
-}
-
-export interface FormInputConfig<FormInputValue> extends NullishProps<_FormInputConfig<FormInputValue>> {
-  /**
-   * The name of the form element
-   *
-   * @remarks
-   *
-   * An explicit `undefined` is not allowed here because of the line
-   * `{name: this.fieldPath, ...config};` in `DataField#toInput`.
-   */
-  name?: string;
-}
-
-/**
- * Create a standardized form field group.
- */
-export function createFormGroup(config: FormGroupConfig): HTMLDivElement;
-
-/**
- * Create an `<input type="checkbox">` element for a BooleanField.
- */
-export function createCheckboxInput(config: FormInputConfig<boolean>): HTMLInputElement;
-
-export interface EditorInputConfig extends FormInputConfig<string> {
-  /** @defaultValue `"prosemirror"` */
-  engine?: string;
-  height?: number;
-  editable?: boolean;
-  button?: boolean;
-  collaborate?: boolean;
-}
-
-/**
- * Create a `<div class="editor">` element for a StringField.
- */
-export function createEditorInput(config: EditorInputConfig): HTMLDivElement;
-
-interface MultiSelectInputConfig extends FormInputConfig<string[]>, Omit<SelectInputConfig, "blank"> {}
-
-/**
- * Create a `<multi-select>` element for a StringField.
- */
-export function createMultiSelectInput(config: MultiSelectInputConfig): HTMLSelectElement;
-
-export interface NumberInputConfig extends FormInputConfig<number> {
-  min?: number;
-  max?: number;
-  step?: number | "any";
-  type?: "range" | "number";
-}
-
-/**
- * Create an `<input type="number">` element for a NumberField.
- */
-export function createNumberInput(config: NumberInputConfig): HTMLInputElement;
-
-export interface FormSelectOption {
-  value: string;
-  label: string;
-  group?: string;
-  disabled?: boolean;
-  selected?: boolean;
-  rule?: boolean;
-}
-
-interface _SelectInputConfig {
-  /**
-   * An option to control the order and display of optgroup elements. The order of
-   * strings defines the displayed order of optgroup elements.
-   * A blank string may be used to define the position of ungrouped options.
-   * If not defined, the order of groups corresponds to the order of options.
-   */
-  groups: string[];
-
-  blank: string;
-
-  /**
-   * An alternative value key of the object passed to the options array
-   */
-  valueAttr: string;
-
-  /**
-   * An alternative label key of the object passed to the options array
-   */
-  labelAttr: string;
-
-  /**
-   * Localize value labels
-   *
-   * @defaultValue `false`
-   */
-  localize: boolean;
-
-  /**
-   * Sort options alphabetically by label within groups
-   *
-   * @defaultValue `false`
-   */
-  sort: boolean;
-
-  /**
-   * Customize the type of select that is created
-   */
-  type: "single" | "multi" | "checkboxes";
-}
-
-// Compatible with multiple different types of FormInputConfig so this does *not* extend that interface
-export interface SelectInputConfig extends NullishProps<_SelectInputConfig> {
-  options: FormSelectOption[];
-}
-
-/**
- * Create a `<select>` element for a StringField.
- */
-export function createSelectInput(config: SelectInputConfig & FormInputConfig<string>): HTMLSelectElement;
-
-export interface TextAreaInputConfig extends FormInputConfig<string> {
-  rows: number;
-}
-
-/**
- * Create a `<textarea>` element for a StringField.
- */
-export function createTextareaInput(config: TextAreaInputConfig): HTMLTextAreaElement;
-
-/**
- * Create an `<input type="text">` element for a StringField.
- */
-export function createTextInput(config: FormInputConfig<string>): HTMLInputElement;
-
-/**
- * Structure a provided array of select options into a standardized format for rendering optgroup and option elements.
- *
- * @example
- * ```js
- * const options = [
- *   {value: "bar", label: "Bar", selected: true, group: "Good Options"},
- *   {value: "foo", label: "Foo", disabled: true, group: "Bad Options"},
- *   {value: "baz", label: "Baz", group: "Good Options"}
- * ];
- * const groups = ["Good Options", "Bad Options", "Unused Options"];
- * const optgroups = foundry.applications.fields.prepareSelectOptionGroups({options, groups, blank: true, sort: true});
- * ```
- */
-export function prepareSelectOptionGroups(config: FormInputConfig<unknown> & SelectInputConfig): {
-  group: string;
-  options: FormSelectOption[];
-}[];
-
-/**
- * Apply standard attributes to all input elements.
- * @param input  - The element being configured
- * @param config - Configuration for the element
- */
-export function setInputAttributes(input: HTMLElement, config: FormInputConfig<unknown>): void;

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

@@ -1,3 +0,0 @@
-// TODO: Transfer functions into this file
-
-export {};