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

package/src/foundry/client/apps/forms/adventure-exporter.d.mts

@@ -1,132 +0,0 @@
-import type { EditorView } from "prosemirror-view";
-import type { Editor } from "tinymce";
-import type { GetDataReturnType } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An interface for packaging Adventure content and loading it to a compendium pack.
-   */
-  class AdventureExporter<Options extends AdventureExporter.Options = AdventureExporter.Options> extends DocumentSheet<
-    Options,
-    Adventure.ConfiguredInstance
-  > {
-    constructor(object?: Adventure.ConfiguredInstance & { pack: string }, options?: Partial<Options>);
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/adventure/exporter.html",
-     *   id: "adventure-exporter",
-     *   classes: ["sheet", "adventure", "adventure-exporter"],
-     *   width: 560,
-     *   height: "auto",
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "summary"}],
-     *   dragDrop: [{ dropSelector: "form" }],
-     *   scrollY: [".tab.contents"],
-     *   submitOnClose: false,
-     *   closeOnSubmit: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): AdventureExporter.Options;
-
-    /**
-     * An alias for the Adventure document
-     */
-    adventure: this["object"];
-
-    contentTree: Record<string, AdventureExporter.AdventureContentTreeRoot>;
-
-    override get isEditable(): boolean;
-
-    override getData(options?: Partial<Options>): Promise<GetDataReturnType<AdventureExporter.AdventureExporterData>>;
-
-    override activateEditor(
-      name: string,
-      options?: TextEditor.Options,
-      initialContent?: string,
-    ): Promise<Editor | EditorView>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    protected override _updateObject(event: Event, adventureData: object): Promise<unknown>;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Stage a document for addition to the Adventure.
-     * This adds the document locally, the change is not yet submitted to the database.
-     * @param document - Some document to be added to the Adventure.
-     */
-    addContent(document: ClientDocument): void;
-
-    /**
-     * Remove a single Document from the Adventure.
-     * @param document - The Document being removed from the Adventure.
-     */
-    removeContent(document: ClientDocument): void;
-  }
-
-  namespace AdventureExporter {
-    type Any = AdventureExporter<any>;
-
-    interface Options extends DocumentSheetOptions<Adventure.ConfiguredInstance> {}
-
-    interface AdventureContentTreeNode {
-      /** An alias for folder.id */
-      id: string | null;
-
-      /** An alias for folder.name */
-      name: string;
-
-      /** The Folder at this node level */
-      folder: Folder;
-
-      /** The modification state of the Folder */
-      state: string;
-
-      /** An array of child nodes */
-      children: AdventureContentTreeNode[];
-
-      /** An array of documents */
-      documents: { id: string; name: string; document: ClientDocument; state: string }[];
-    }
-
-    interface AdventureContentTreeRoot extends AdventureContentTreeNode {
-      /** The folder ID is null at the root level */
-      id: null;
-
-      /** The Document name contained in this tree */
-      documentName: string;
-
-      /** The Document collection name of this tree */
-      collection: string;
-
-      /** The name displayed at the root level of the tree */
-      name: string;
-
-      /** The icon displayed at the root level of the tree */
-      icon: string;
-
-      /** The icon which represents the current collapsed state of the tree */
-      collapseIcon: string;
-
-      /** CSS classes which describe the display of the tree */
-      cssClass: string;
-
-      /** The number of documents which are present in the tree */
-      documentCount: number;
-    }
-
-    interface AdventureExporterData {
-      adventure: Adventure.ConfiguredInstance;
-
-      contentTree: AdventureExporter["contentTree"];
-    }
-  }
-}

package/src/foundry/client/apps/forms/adventure-importer.d.mts

@@ -1,85 +0,0 @@
-import type { GetDataReturnType } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An interface for importing an adventure from a compendium pack.
-   */
-  class AdventureImporter<Options extends AdventureImporter.Options = AdventureImporter.Options> extends DocumentSheet<
-    Options,
-    Adventure.ConfiguredInstance
-  > {
-    /**
-     * An alias for the Adventure document
-     */
-    adventure: this["object"];
-
-    override get isEditable(): boolean;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/adventure/importer.html",
-     *   id: "adventure-importer",
-     *   classes: ["sheet", "adventure", "adventure-importer"],
-     *   width: 800,
-     *   height: "auto",
-     *   submitOnClose: false,
-     *   closeOnSubmit: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): AdventureImporter.Options;
-
-    override getData(options?: Partial<Options>): Promise<GetDataReturnType<AdventureImporter.AdventureImporterData>>;
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    /**
-     * Handle toggling the import all checkbox.
-     * @param event - The change event
-     */
-    protected _onToggleImportAll(event: Event): void;
-
-    /**
-     * Prepare a list of content types provided by this adventure.
-     */
-    protected _getContentList(): { icon: string; label: string; count: number }[];
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    protected override _updateObject(event: Event, formData: object): Promise<void | ReturnType<Adventure["import"]>>;
-
-    /**
-     * Mirror Adventure#import but call AdventureImporter#_importContent and AdventureImport#_prepareImportData
-     * @deprecated since v11, will be removed in v13
-     */
-    _importLegacy(formData: object): Promise<void>;
-
-    /**
-     * @deprecated since v11, will be removed in v13
-     * @remarks `"AdventureImporter#_prepareImportData is deprecated. Please use Adventure#prepareImport instead."`
-     */
-    _prepareImportData(formData: object): Promise<void>;
-
-    /**
-     * @deprecated since v11, will be removed in v13
-     * @remarks `"AdventureImporter#_importContent is deprecated. Please use Adventure#importContent instead."`
-     */
-    _importContent(formData: object): Promise<void>;
-  }
-
-  namespace AdventureImporter {
-    type Any = AdventureImporter<any>;
-
-    interface Options extends DocumentSheetOptions<Adventure.ConfiguredInstance> {}
-
-    interface AdventureImporterData {
-      adventure: Adventure.ConfiguredInstance;
-
-      contents: ReturnType<AdventureImporter["_getContentList"]>;
-
-      imported: boolean;
-    }
-  }
-}

package/src/foundry/client/apps/forms/base-sheet.d.mts

@@ -1,46 +0,0 @@
-import type { EditorView } from "prosemirror-view";
-import type { Editor } from "tinymce";
-import type { GetDataReturnType } from "fvtt-types/utils";
-
-declare global {
-  class BaseSheet<
-    ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-    Options extends BaseSheet.Options<ConcreteDocument> = BaseSheet.Options<ConcreteDocument>,
-  > extends DocumentSheet<Options, ConcreteDocument> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/sheets/base-sheet.html",
-     *   classes: ["sheet", "base-sheet"],
-     *   width: 450,
-     *   height: "auto",
-     *   resizable: true,
-     *   submitOnChange: true,
-     *   closeOnSubmit: false
-     * });
-     * ```
-     */
-    static override get defaultOptions(): BaseSheet.Options;
-
-    override getData(): Promise<GetDataReturnType<BaseSheet.BaseSheetData>>;
-
-    protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    activateEditor(name: string, options?: TextEditor.Options, initialContent?: string): Promise<Editor | EditorView>;
-  }
-
-  namespace BaseSheet {
-    type Any = BaseSheet<any>;
-
-    interface Options<ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any>
-      extends DocumentSheetOptions<ConcreteDocument> {}
-
-    interface BaseSheetData extends DocumentSheet.DocumentSheetData<Options, foundry.abstract.Document.Any> {
-      hasName: boolean;
-      hasImage: boolean;
-      hasDescription: boolean;
-      desriptionHTML?: string;
-    }
-  }
-}

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

@@ -1,48 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A DocumentSheet application responsible for displaying and editing a single embedded Card document.
-   *
-   * @typeParam Options - The type of the options object
-   */
-  class CardConfig<
-    Options extends DocumentSheetOptions<Card.ConfiguredInstance> = DocumentSheetOptions<Card.ConfiguredInstance>,
-  > extends DocumentSheet<Options, Card.ConfiguredInstance> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "card-config"],
-     *   template: "templates/cards/card-config.html",
-     *   width: 480,
-     *   height: "auto",
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "details"}]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions<Card.ConfiguredInstance>;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<CardConfig.CardConfigData>>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle card face control actions which modify single cards on the sheet.
-     * @param event - The originating click event
-     * @returns A Promise which resolves once the handler has completed
-     */
-    protected _onFaceControl(event: JQuery.ClickEvent): Promise<unknown>;
-  }
-
-  namespace CardConfig {
-    type Any = CardConfig<any>;
-
-    interface CardConfigData<
-      Options extends DocumentSheetOptions<Card.ConfiguredInstance> = DocumentSheetOptions<Card.ConfiguredInstance>,
-    > extends DocumentSheet.DocumentSheetData<Options, Card.ConfiguredInstance> {
-      //TODO: Find if we can better type this
-      types: Record<string, string>;
-    }
-  }
-}

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

@@ -1,142 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * A DocumentSheet application responsible for displaying and editing a single Cards stack.
-   *
-   * @typeParam Options - The type of the options object
-   */
-  class CardsConfig<Options extends CardsConfig.Options = CardsConfig.Options> extends DocumentSheet<
-    Options,
-    Cards.ConfiguredInstance
-  > {
-    constructor(object: Document.ConfiguredClassForName<"Cards">, options: Options);
-
-    /**
-     * The allowed sorting methods which can be used for this sheet
-     */
-    static SORT_TYPES: {
-      STANDARD: "standard";
-      SHUFFLED: "shuffled";
-    };
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "cards-config"],
-     *   template: "templates/cards/cards-deck.html",
-     *   width: 620,
-     *   height: "auto",
-     *   closeOnSubmit: false,
-     *   viewPermission: CONST.DOCUMENT_OWNERSHIP_LEVELS.OBSERVER,
-     *   dragDrop: [{dragSelector: "ol.cards li.card", dropSelector: "ol.cards"}],
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "cards"}],
-     *   scrollY: ["ol.cards"],
-     *   sort: this.SORT_TYPES.SHUFFLED
-     * })
-     * ```
-     */
-    static override get defaultOptions(): CardsConfig.Options;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<CardsConfig.CardsConfigData>>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle card control actions which modify single cards on the sheet.
-     * @param event - The originating click event
-     * @returns A Promise which resolves once the handler has completed
-     */
-    protected _onCardControl(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle lazy-loading card face images.
-     * See {@link SidebarTab#_onLazyLoadImage}
-     * @param entries  - The entries which are now in the observer frame
-     * @param observer - The intersection observer instance
-     */
-    protected _onLazyLoadImage(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void;
-
-    protected override _canDragStart(selector: string): boolean;
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    protected override _canDragDrop(selector: string): boolean;
-
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    protected override _onDrop(event: DragEvent): Promise<void>;
-
-    /**
-     * Handle sorting a Card relative to other siblings within this document
-     * @param event - The drag drop event
-     * @param card  - The card being dragged
-     * @internal
-     */
-    protected _onSortCard(
-      event: DragEvent,
-      card: Card.ConfiguredInstance,
-    ): ReturnType<Cards.ConfiguredInstance["updateEmbeddedDocuments"]>;
-  }
-
-  namespace CardsConfig {
-    type Any = CardsConfig<any>;
-  }
-
-  /**
-   * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "hand" type.
-   *
-   * @typeParam Options - The type of the options object
-   */
-  class CardsHand<Options extends CardsConfig.Options = CardsConfig.Options> extends CardsConfig<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/cards/cards-hand.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): CardsConfig.Options;
-  }
-
-  namespace CardsHand {
-    type Any = CardsHand<any>;
-  }
-
-  /**
-   * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "pile" type.
-   *
-   * @typeParam Options - The type of the options object
-   */
-  class CardsPile<Options extends CardsConfig.Options = CardsConfig.Options> extends CardsConfig<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/cards/cards-pile.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): CardsConfig.Options;
-  }
-
-  namespace CardsPile {
-    type Any = CardsPile<any>;
-  }
-
-  namespace CardsConfig {
-    interface Options extends DocumentSheetOptions<Cards.ConfiguredInstance> {
-      sort: string;
-    }
-
-    interface CardsConfigData<Options extends CardsConfig.Options = CardsConfig.Options>
-      extends DocumentSheet.DocumentSheetData<Options, Cards.ConfiguredInstance> {
-      cards: Card.ConfiguredInstance[];
-      //TODO: Find if we can better type this
-      types: Record<string, string>;
-      inCompendium: boolean;
-    }
-  }
-}

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

@@ -1,51 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring the CombatTracker and its contents.
-   * @typeParam Options - The type of the options object
-   */
-  class CombatTrackerConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
-    Options,
-    undefined
-  > {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "combat-config",
-     *   title: game.i18n.localize("COMBAT.Settings"),
-     *   classes: ["sheet", "combat-sheet"],
-     *   template: "templates/sheets/combat-config.html",
-     *   width: 420,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): FormApplicationOptions;
-
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<CombatTrackerConfig.CombatTrackerConfigData>>;
-
-    protected override _updateObject(
-      event: Event,
-      formData: SettingConfig["core.combatTrackerConfig"],
-    ): Promise<unknown>;
-
-    override activateListeners(html: JQuery<HTMLElement>): void;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent<any, any, any, any>): Promise<void | object>;
-  }
-
-  namespace CombatTrackerConfig {
-    type Any = CombatTrackerConfig<any>;
-
-    interface CombatTrackerConfigData extends FormApplication.FormApplicationData {
-      settings: SettingConfig["core.combatTrackerConfig"];
-      attributeChoices: ReturnType<(typeof TokenDocument)["getTrackedAttributeChoices"]>;
-      combatTheme: ClientSettings.SettingConfig<string>;
-      selectedTheme: SettingConfig["core.combatTheme"];
-      user: User;
-    }
-  }
-}

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

@@ -1,45 +0,0 @@
-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.ConfiguredInstance> {
-      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

@@ -1,46 +0,0 @@
-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

@@ -1,77 +0,0 @@
-import type { GetDataReturnType, MaybePromise, SimpleMerge, ValueOf } from "fvtt-types/utils";
-
-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;
-      }
-    >;
-  }
-}