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

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

@@ -1,493 +0,0 @@
-import type { EditorView } from "prosemirror-view";
-import type { Editor } from "tinymce";
-import type { AnyObject, GetDataReturnType, InexactPartial, MaybePromise } from "fvtt-types/utils";
-import type { ProseMirrorKeyMaps, ProseMirrorMenu } from "../../common/prosemirror/_module.d.mts";
-import type Document from "../../common/abstract/document.d.mts";
-
-declare global {
-  interface FormApplicationOptions extends ApplicationOptions {
-    /**
-     * Whether to automatically close the application when it's contained
-     * form is submitted.
-     * @defaultValue `true`
-     */
-    closeOnSubmit: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when an input
-     * or select element is changed.
-     * @defaultValue `false`
-     */
-    submitOnChange: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when the
-     * application window is manually closed.
-     * @defaultValue `false`
-     */
-    submitOnClose: boolean;
-
-    /**
-     * Whether the application form is editable - if true, it's fields will
-     * be unlocked and the form can be submitted. If false, all form fields
-     * will be disabled and the form cannot be submitted.
-     * @defaultValue `true`
-     */
-    editable: boolean;
-
-    /**
-     * Support configuration of the sheet type used for this application.
-     * @defaultValue `false`
-     */
-    sheetConfig: boolean;
-  }
-
-  /**
-   * An abstract pattern for defining an Application responsible for updating some object using an HTML form
-   *
-   * A few critical assumptions:
-   * 1) This application is used to only edit one object at a time
-   * 2) The template used contains one (and only one) HTML form as it's outer-most element
-   * 3) This abstract layer has no knowledge of what is being updated, so the implementation must define _updateObject
-   *
-   * @typeParam Options        - the type of the options object
-   * @typeParam ConcreteObject - the type of the object or {@link foundry.abstract.Document} which is modified by this form
-   */
-  abstract class FormApplication<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    ConcreteObject = unknown,
-  > extends Application<Options> {
-    /**
-     * @param object  - Some object or entity which is the target to be updated.
-     *                  (default: `{}`)
-     *
-     * @param options - Additional options which modify the rendering of the sheet.
-     *                  (default: `{}`)
-     * @remarks Foundry allows passing no value to the constructor at all.
-     */
-    constructor(object: ConcreteObject, options?: Partial<Options>);
-    constructor(
-      ...args: ConcreteObject extends undefined
-        ? [ConcreteObject?, Partial<Options>?]
-        : [ConcreteObject, Partial<Options>?]
-    );
-
-    /**
-     * The object target which we are using this form to modify
-     */
-    object: ConcreteObject;
-
-    /**
-     * A convenience reference to the form HTLMElement
-     * @defaultValue `null`
-     */
-    form: HTMLElement | null;
-
-    /**
-     * Keep track of any mce editors which may be active as part of this form
-     * The values of this Array are inner-objects with references to the MCE editor and other metadata
-     * @defaultValue `{}`
-     */
-    editors: Record<string, FormApplication.FormApplicationEditor>;
-
-    /**
-     * An array of custom element tag names that should be listened to for changes.
-     */
-    protected static _customElements: string[];
-
-    /**
-     * Assign the default options which are supported by the entity edit sheet.
-     * @returns The default options for this FormApplication class
-     * @see {@link Application.defaultOptions}
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["form"],
-     *   closeOnSubmit: true,
-     *   editable: true,
-     *   sheetConfig: false,
-     *   submitOnChange: false,
-     *   submitOnClose: false
-     * });
-     * ```
-     */
-    static override get defaultOptions(): FormApplicationOptions;
-
-    /**
-     * Is the Form Application currently editable?
-     */
-    get isEditable(): boolean;
-
-    /**
-     * @param options - (default: `{}`)
-     */
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<FormApplication.FormApplicationData<Options, ConcreteObject>>>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    protected override _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery>;
-
-    protected override _activateCoreListeners(html: JQuery): void;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * If the form is not editable, disable its input fields
-     * @param form - The form HTML
-     */
-    protected _disableFields(form: HTMLElement): void;
-
-    /**
-     * Handle standard form submission steps
-     * @param event         - The submit event which triggered this handler
-     * @param updateData    - Additional specific data keys/values which override or extend the contents of
-     *                        the parsed form. This can be used to update other flags or data fields at the
-     *                        same time as processing a form submission to avoid multiple database operations.
-     *                        (default: `null`)
-     * @param preventClose  - Override the standard behavior of whether to close the form on submit
-     *                        (default: `false`)
-     * @param preventRender - Prevent the application from re-rendering as a result of form submission
-     *                        (default: `false`)
-     * @returns A promise which resolves to the validated update data
-     */
-    protected _onSubmit(
-      event: Event,
-      { updateData, preventClose, preventRender }?: FormApplication.OnSubmitOptions,
-    ): Promise<Partial<AnyObject>>;
-
-    /**
-     * Get an object of update data used to update the form's target object
-     * @param updateData - Additional data that should be merged with the form data
-     *                     (default: `{}`)
-     * @returns The prepared update data
-     */
-    // TODO: Maybe we can calculate how the flattened `updateData` looks like, then it would be Partial<Record<string, unknown>> & Flattened<T>
-    protected _getSubmitData(updateData?: AnyObject | null): AnyObject;
-
-    /**
-     * Handle changes to an input element, submitting the form if options.submitOnChange is true.
-     * Do not preventDefault in this handler as other interactions on the form may also be occurring.
-     * @param event - The initial change event
-     */
-    protected _onChangeInput(event: JQuery.ChangeEvent): Promise<void | object>;
-
-    /**
-     * Handle the change of a color picker input which enters it's chosen value into a related input field
-     * @param event - The color picker change event
-     */
-    protected _onChangeColorPicker(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle changes to a range type input by propagating those changes to the sibling range-value element
-     * @param event - The initial change event
-     */
-    protected _onChangeRange(event: JQuery.ChangeEvent): void;
-
-    /**
-     * This method is called upon form submission after form data is validated
-     * @param event    - The initial triggering submission event
-     * @param formData - The object of validated form data with which to update the object
-     * @returns A Promise which resolves once the update operation has completed
-     */
-    protected abstract _updateObject(event: Event, formData?: object): Promise<unknown>;
-
-    /**
-     * Activate a named TinyMCE text editor
-     * @param name           - The named data field which the editor modifies.
-     * @param options        - Editor initialization options passed to {@link TextEditor.create}.
-     *                         (default: `{}`)
-     * @param initialContent - Initial text content for the editor area.
-     *                         (default: `""`)
-     */
-    activateEditor(
-      name: string,
-      options?: TextEditor.Options,
-      initialContent?: string,
-    ): Promise<tinyMCE.Editor | EditorView>;
-
-    /**
-     * Handle saving the content of a specific editor by name
-     * @param name - The named editor to save
-     */
-    saveEditor(
-      name: string,
-      options?: InexactPartial<{
-        /**
-         * Remove the editor after saving its content
-         * @defaultValue `true`
-         */
-        remove: boolean;
-
-        /**
-         * Prevent normal re-rendering of the sheet after saving.
-         */
-        preventRender: boolean;
-      }>,
-    ): Promise<void>;
-
-    /**
-     * Activate an editor instance present within the form
-     * @param div - The element which contains the editor
-     */
-    protected _activateEditor(div: HTMLElement): void;
-
-    /**
-     * Configure ProseMirror plugins for this sheet.
-     * @param name    - The name of the editor.
-     * @param options - Additional options to configure the plugins.
-     */
-    protected _configureProseMirrorPlugins(
-      name: string,
-      options: {
-        /** Whether the editor should destroy itself on save. */
-        remove: boolean;
-      },
-    ): {
-      menu: ReturnType<(typeof ProseMirrorMenu)["build"]>;
-      keyMaps: ReturnType<(typeof ProseMirrorKeyMaps)["build"]>;
-    };
-
-    /**
-     * @param options - (default: `{}`)
-     */
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    /**
-     * Submit the contents of a Form Application, processing its content as defined by the Application
-     * @param options - Options passed to the _onSubmit event handler
-     *                  (default: `{}`)
-     * @returns Return a self-reference for convenient method chaining
-     */
-    submit(options?: FormApplication.OnSubmitOptions): Promise<this>;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    get filepickers(): FilePicker[];
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    protected _activateFilePicker(event: PointerEvent): void;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
-
-    /**
-     * @deprecated since v12, will be removed in v14
-     */
-    protected _onSelectFile(selection: string, filePicker: FilePicker): void;
-  }
-
-  namespace FormApplication {
-    type Any = FormApplication<any, any>;
-
-    type AnyConstructor = typeof AnyFormApplication;
-
-    interface CloseOptions extends Application.CloseOptions {
-      submit?: boolean;
-    }
-
-    interface FormApplicationEditor {
-      target: string;
-      button: HTMLElement;
-      hasButton: boolean;
-      instance: Awaited<ReturnType<(typeof TextEditor)["create"]>> | null;
-      mce: Awaited<ReturnType<(typeof TextEditor)["create"]>> | null;
-      active: boolean;
-      changed: boolean;
-      options: TextEditor.Options;
-      initial: string;
-    }
-
-    interface OnSubmitOptions {
-      /**
-       * Additional specific data keys/values which override or extend the contents of
-       * the parsed form. This can be used to update other flags or data fields at the
-       * same time as processing a form submission to avoid multiple database operations.
-       * @defaultValue `null`
-       */
-      updateData?: AnyObject | null | undefined;
-
-      /**
-       * Override the standard behavior of whether to close the form on submit
-       * @defaultValue `false`
-       */
-      preventClose?: boolean | undefined;
-
-      /**
-       * Prevent the application from re-rendering as a result of form submission
-       * @defaultValue `false`
-       */
-      preventRender?: boolean | undefined;
-    }
-
-    interface FormApplicationData<
-      Options extends FormApplicationOptions = FormApplicationOptions,
-      ConcreteObject = unknown,
-    > {
-      object: ConcreteObject;
-      options: Options;
-      title: string;
-    }
-  }
-
-  interface DocumentSheetOptions<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > extends FormApplicationOptions {
-    /**
-     * The default permissions required to view this Document sheet.
-     * @defaultValue {@link CONST.DOCUMENT_OWNERSHIP_LEVELS.LIMITED}
-     */
-    viewPermission: foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
-
-    /** An array of {@link HTMLSecret} configuration objects. */
-    secrets: HTMLSecretConfiguration<ConcreteDocument>[];
-  }
-
-  /**
-   * Extend the FormApplication pattern to incorporate specific logic for viewing or editing Document instances.
-   * See the FormApplication documentation for more complete description of this interface.
-   *
-   * @typeParam Options          - the type of the options object
-   * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
-   */
-  abstract class DocumentSheet<
-    Options extends DocumentSheetOptions<ConcreteDocument>,
-    ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-  > extends FormApplication<Options, ConcreteDocument> {
-    /**
-     * @param object  - A Document instance which should be managed by this form.
-     * @param options - Optional configuration parameters for how the form behaves.
-     *                  (default: `{}`)
-     */
-    constructor(object: ConcreteDocument, options?: Partial<Options>);
-
-    /** The list of handlers for secret block functionality. */
-    protected _secrets: HTMLSecret<ConcreteDocument>[];
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet"],
-     *   template: `templates/sheets/${this.name.toLowerCase()}.html`,
-     *   viewPermission: CONST.DOCUMENT_OWNERSHIP_LEVELS.LIMITED,
-     *   sheetConfig: true,
-     *   secrets: []
-     * });
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions;
-
-    /**
-     * A semantic convenience reference to the Document instance which is the target object for this form.
-     */
-    get document(): ConcreteDocument;
-
-    override get id(): string;
-
-    override get isEditable(): boolean;
-
-    override get title(): string;
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<DocumentSheet.DocumentSheetData<Options, ConcreteDocument>>>;
-
-    protected override _activateCoreListeners(html: JQuery<HTMLElement>): void;
-
-    override activateEditor(
-      name: string,
-      options?: TextEditor.Options,
-      initialContent?: string,
-    ): Promise<Editor | EditorView>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    protected override _renderOuter(): Promise<JQuery<HTMLElement>>;
-
-    /**
-     * Create an ID link button in the document sheet header which displays the document ID and copies to clipboard
-     */
-    protected _createDocumentIdLink(html: JQuery<HTMLElement>): void;
-
-    /**
-     * Test whether a certain User has permission to view this Document Sheet.
-     * @param user - The user requesting to render the sheet
-     * @returns Does the User have permission to view this sheet?
-     */
-    protected _canUserView(user: User): boolean;
-
-    /**
-     * Create objects for managing the functionality of secret blocks within this Document's content.
-     */
-    protected _createSecretHandlers(): HTMLSecret[];
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Get the HTML content that a given secret block is embedded in.
-     * @param secret - The secret block.
-     */
-    protected _getSecretContent(secret: HTMLElement): string;
-
-    /**
-     * Update the HTML content that a given secret block is embedded in.
-     * @param secret  - The secret block.
-     * @param content - The new content.
-     * @returns The updated Document.
-     */
-    protected _updateSecret(secret: HTMLElement, content: string): Promise<ConcreteDocument | void>;
-
-    /**
-     * Handle requests to configure the default sheet used by this Document
-     * @internal
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle changing a Document's image.
-     * @param event - The click event.
-     */
-    protected _onEditImage(event: MouseEvent): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: object): Promise<unknown>;
-  }
-
-  namespace DocumentSheet {
-    type Any = AnyDocumentSheet;
-    type AnyConstructor = typeof AnyDocumentSheet;
-
-    interface DocumentSheetData<
-      Options extends DocumentSheetOptions<ConcreteDocument>,
-      ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-    > extends FormApplication.FormApplicationData {
-      cssClass: string;
-      editable: boolean;
-      data: ReturnType<ConcreteDocument["toObject"]>;
-      limited: boolean;
-      options: DocumentSheet<Options, ConcreteDocument>["options"];
-      owner: boolean;
-      title: DocumentSheet<Options, ConcreteDocument>["title"];
-      document: DocumentSheet<Options, ConcreteDocument>["document"];
-    }
-  }
-}
-
-declare abstract class AnyFormApplication extends FormApplication<any, any> {
-  constructor(arg0: never, ...args: never[]);
-}
-
-declare abstract class AnyDocumentSheet extends DocumentSheet<
-  DocumentSheetOptions<foundry.abstract.Document.Any>,
-  foundry.abstract.Document.Any
-> {
-  constructor(arg0: never, ...args: never[]);
-}

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

@@ -1,176 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing a single Actor document.
-   * This Application is responsible for rendering an actor's attributes and allowing the actor to be edited.
-   * @param actor   - The Actor instance being displayed within the sheet.
-   * @param options - Additional application configuration options.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class ActorSheet<Options extends ActorSheet.Options = ActorSheet.Options> extends DocumentSheet<
-    Options,
-    Actor.ConfiguredInstance
-  > {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   height: 720,
-     *   width: 800,
-     *   template: "templates/sheets/actor-sheet.html",
-     *   closeOnSubmit: false,
-     *   submitOnClose: true,
-     *   submitOnChange: true,
-     *   resizable: true,
-     *   baseApplication: "ActorSheet",
-     *   dragDrop: [{ dragSelector: ".item-list .item", dropSelector: null }],
-     *   token: null,
-     * });
-     * ```
-     */
-    static get defaultOptions(): ActorSheet.Options;
-
-    override get title(): string;
-
-    /**
-     * A convenience reference to the Actor document
-     */
-    get actor(): this["object"];
-
-    /**
-     * If this Actor Sheet represents a synthetic Token actor, reference the active Token
-     */
-    get token(): Exclude<this["object"]["token"] | this["options"]["token"], undefined> | null;
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ActorSheet.ActorSheetData>>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    protected override _getSubmitData(updateData?: object | null): Partial<Record<string, unknown>>;
-
-    /**
-     * Handle requests to configure the Token for the Actor
-     */
-    protected _onConfigureToken(event: JQuery.ClickEvent): void;
-
-    protected override _canDragStart(selector: string): boolean;
-
-    protected override _canDragDrop(selector: string): boolean;
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Handle the dropping of ActiveEffect data onto an Actor Sheet
-     * @param event - The concluding DragEvent which contains drop data
-     * @param data  - The data transfer extracted from the event
-     * @returns A data object which describes the result of the drop
-     * @remarks This is intentionally typed to return `Promise<unknown>` to
-     * allow overriding methods to return whatever they want. The return type is
-     * not meant to be used aside from being awaited.
-     */
-    protected _onDropActiveEffect(event: DragEvent, data: ActorSheet.DropData.ActiveEffect): Promise<unknown>;
-
-    /**
-     * Handle dropping of an item reference or item data onto an Actor Sheet
-     * @param event - The concluding DragEvent which contains drop data
-     * @param data  - The data transfer extracted from the event
-     * @returns A data object which describes the result of the drop
-     * @remarks This is intentionally typed to return `Promise<unknown>` to
-     * allow overriding methods to return whatever they want. The return type is
-     * not meant to be used aside from being awaited.
-     */
-    protected _onDropActor(event: DragEvent, data: ActorSheet.DropData.Actor): Promise<unknown>;
-
-    /**
-     * Handle dropping of an item reference or item data onto an Actor Sheet
-     * @param event - The concluding DragEvent which contains drop data
-     * @param data  - The data transfer extracted from the event
-     * @remarks This is intentionally typed to return `Promise<unknown>` to
-     * allow overriding methods to return whatever they want. The return type is
-     * not meant to be used aside from being awaited.
-     */
-    protected _onDropItem(event: DragEvent, data: ActorSheet.DropData.Item): Promise<unknown>;
-
-    /**
-     * Handle dropping of a Folder on an Actor Sheet.
-     * Currently supports dropping a Folder of Items to create all items as owned items.
-     * @param event - The concluding DragEvent which contains drop data
-     * @param data  - The data transfer extracted from the event
-     * @remarks This is intentionally typed to return `Promise<unknown>` to
-     * allow overriding methods to return whatever they want. The return type is
-     * not meant to be used aside from being awaited.
-     */
-    protected _onDropFolder(event: DragEvent, data: ActorSheet.DropData.Folder): Promise<unknown>;
-
-    /**
-     * Handle the final creation of dropped Item data on the Actor.
-     * This method is factored out to allow downstream classes the opportunity to override item creation behavior.
-     * @param itemData - The item data requested for creation
-     */
-    protected _onDropItemCreate(itemData: Item["_source"][] | Item["_source"]): Promise<Item.ConfiguredInstance[]>;
-
-    /**
-     * Handle a drop event for an existing embedded Item to sort that Item relative to its siblings
-     */
-    protected _onSortItem(event: DragEvent, itemData: Item["_source"]): undefined | Promise<Item.ConfiguredInstance[]>;
-
-    /**
-     * Is the drop data coming from the same actor?
-     * @param data - The drop data.
-     * @internal
-     */
-    protected _isFromSameActor(data: ActorSheet.DropData.Item): Promise<boolean>;
-  }
-
-  namespace ActorSheet {
-    type Any = ActorSheet<any>;
-
-    type DropData =
-      | DropData.ActiveEffect
-      | DropData.Actor
-      | DropData.Item
-      | DropData.Folder
-      | (Partial<Record<string, unknown>> & { type: string });
-
-    namespace DropData {
-      interface ActiveEffect {
-        type: "ActiveEffect";
-        tokenId?: string;
-        actorId?: string;
-        data: foundry.documents.BaseActiveEffect["_source"];
-      }
-
-      interface Actor {
-        type: "Actor";
-      }
-
-      type Item = Document.DropData<Item.ConfiguredInstance> & {
-        type: "Item";
-      };
-
-      interface Folder {
-        type: "Folder";
-        documentName: foundry.CONST.FOLDER_DOCUMENT_TYPES;
-        id: string;
-      }
-    }
-
-    interface Options extends DocumentSheetOptions<Actor.ConfiguredInstance> {
-      token?: TokenDocument.ConfiguredInstance | null;
-    }
-
-    interface ActorSheetData<Options extends ActorSheet.Options = ActorSheet.Options>
-      extends DocumentSheet.DocumentSheetData<Options, Actor.ConfiguredInstance> {
-      actor: ActorSheet["actor"];
-      items: this["data"]["items"];
-      effects: this["data"]["effects"];
-    }
-  }
-}