@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

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

@@ -1,192 +0,0 @@
-import { ConfiguredDocumentClass, ToObjectFalseType } from '../../../../types/helperTypes';
-import { DropData as ClientDocumentMixinDropData } from '../../data/abstract/client-document';
-
-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
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class ActorSheet<
-    Options extends ActorSheet.Options = ActorSheet.Options,
-    Data extends object = ActorSheet.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Actor>>> {
-    /**
-     * @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 id(): string;
-
-    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>): Data | Promise<Data>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    protected override _getSubmitData(updateData?: object | null): Partial<Record<string, unknown>>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle requests to configure the Token for the Actor
-     */
-    protected _onConfigureToken(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle changing the actor profile image by opening a FilePicker
-     */
-    protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
-
-    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: foundry.data.ItemData['_source'][] | foundry.data.ItemData['_source']
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Item>>[]>;
-
-    /**
-     * Handle a drop event for an existing embedded Item to sort that Item relative to its siblings
-     */
-    protected _onSortItem(
-      event: DragEvent,
-      itemData: foundry.data.ItemData['_source']
-    ): undefined | Promise<InstanceType<ConfiguredDocumentClass<typeof Item>>[]>;
-
-    /**
-     * 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 {
-    /**
-     * @typeParam Options - the type of the options object
-     */
-    interface Data<Options extends ActorSheet.Options = ActorSheet.Options>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Actor>>, Options> {
-      actor: this['document'];
-      items: ToObjectFalseType<foundry.data.ActorData>['items'];
-      effects: ToObjectFalseType<foundry.data.ActorData>['effects'];
-    }
-
-    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.data.ActiveEffectData['_source'];
-      }
-
-      interface Actor {
-        type: 'Actor';
-      }
-
-      type Item = ClientDocumentMixinDropData<InstanceType<ConfiguredDocumentClass<typeof Item>>> & {
-        type: 'Item';
-      };
-
-      interface Folder {
-        type: 'Folder';
-        documentName: foundry.CONST.FOLDER_DOCUMENT_TYPES;
-        id: string;
-      }
-    }
-
-    interface Options extends DocumentSheetOptions {
-      token?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
-    }
-  }
-}

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

@@ -1,51 +0,0 @@
-import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../types/helperTypes.js';
-import type { CardFaceData } from '../../../common/data/module.mjs.js';
-
-declare global {
-  /**
-   * A DocumentSheet application responsible for displaying and editing a single embedded Card document.
-   *
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CardConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends CardConfig.Data<Options> = CardConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Card'>>> {
-    /**
-     * @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;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _getSubmitData(
-      updateData?: object | null
-    ): Record<string, unknown> & { faces: ConstructorDataType<CardFaceData>[] };
-
-    /**
-     * 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<void>;
-  }
-
-  namespace CardConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Card'>>, Options> {
-      types: Record<string, string>;
-    }
-  }
-}

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

@@ -1,128 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes.js';
-
-declare global {
-  /**
-   * A DocumentSheet application responsible for displaying and editing a single Cards stack.
-   *
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CardsConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Cards'>>> {
-    constructor(object: ConfiguredDocumentClassForName<'Cards'>, options: Options);
-
-    /**
-     * The sorting mode used to display the sheet, "standard" if true, otherwise "shuffled"
-     * @internal
-     * @defaultValue `false`
-     */
-    protected _sortStandard: boolean;
-
-    /**
-     * @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_PERMISSION_LEVELS.OBSERVER,
-     *   dragDrop: [{dragSelector: "ol.cards li.card", dropSelector: "ol.cards"}],
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "cards"}],
-     *   scrollY: ["ol.cards"]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    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}
-     */
-    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;
-
-    protected override _onDrop(event: DragEvent): 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: InstanceType<ConfiguredDocumentClassForName<'Card'>>
-    ): ReturnType<InstanceType<ConfiguredDocumentClassForName<'Cards'>>['updateEmbeddedDocuments']>;
-  }
-
-  /**
-   * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "hand" type.
-   *
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CardsHand<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
-  > extends CardsConfig<Options, Data> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/cards/cards-hand.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-  }
-
-  /**
-   * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "pile" type.
-   *
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CardsPile<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
-  > extends CardsConfig<Options, Data> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/cards/cards-pile.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-  }
-
-  namespace CardsConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Cards'>>, Options> {
-      cards: InstanceType<ConfiguredDocumentClassForName<'Card'>>[];
-      types: Record<string, string>;
-      inCompendium: boolean;
-    }
-  }
-}

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

@@ -1,41 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * The Application responsible for configuring the CombatTracker and its contents.
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CombatTrackerConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = CombatTrackerConfig.Data
-  > extends FormApplication<Options, Data, 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>): Data | Promise<Data>;
-
-    protected override _updateObject(
-      event: Event,
-      formData: ClientSettings.Values['core.combatTrackerConfig']
-    ): Promise<unknown>;
-  }
-
-  namespace CombatTrackerConfig {
-    interface Data {
-      settings: ClientSettings.Values['core.combatTrackerConfig'];
-      attributeChoices: Record<string, string[]>;
-    }
-  }
-}

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

@@ -1,49 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Combatant document within a parent Combat.
-   *
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CombatantConfig<
-    Options extends DocumentSheetOptions = CombatantConfig.Options,
-    Data extends CombatantConfig.Data<Options> = CombatantConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Combatant>>> {
-    /**
-     * @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 {
-    interface Options extends DocumentSheetOptions {
-      id: 'combatant-config';
-      title: string;
-      classes: string[];
-      template: string;
-      width: number;
-    }
-
-    type Data<Options extends DocumentSheetOptions> = DocumentSheet.Data<
-      InstanceType<ConfiguredDocumentClass<typeof Combatant>>,
-      Options
-    >;
-
-    type FormData = Pick<foundry.data.CombatantData, 'defeated' | 'hidden' | 'img' | 'initiative' | 'name'>;
-  }
-}

package/src/foundry/client/apps/forms/effect-config.d.ts

@@ -1,65 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-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
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class ActiveEffectConfig<
-    Options extends DocumentSheetOptions = ActiveEffectConfig.Options,
-    Data extends object = ActiveEffectConfig.Data
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof ActiveEffect>>> {
-    /**
-     * @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(): ActiveEffectConfig.Options;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    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: JQuery.ClickEvent): Promise<this> | void;
-
-    /**
-     * 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 {
-    interface Data {
-      effect: ActiveEffectConfig['object']['data'];
-      data: ActiveEffectConfig['object']['data'];
-      isActorEffect: boolean;
-      isItemEffect: boolean;
-      submitText: string;
-      modes: Record<foundry.CONST.ACTIVE_EFFECT_MODES, string>;
-    }
-
-    type Options = DocumentSheetOptions;
-  }
-}

package/src/foundry/client/apps/forms/folder-config.d.ts

@@ -1,63 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import type { SortingModes } from '../../../common/data/data.mjs/folderData';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Folder document.
-   *
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class FolderConfig<
-    Options extends FolderConfig.Options = FolderConfig.Options,
-    Data extends object = FolderConfig.Data
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Folder>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "folder-edit"],
-     *   template: "templates/sidebar/folder-edit.html",
-     *   width: 360
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    override close(options?: Application.CloseOptions | undefined): Promise<void>;
-
-    override getData(options?: Partial<Options>): Promise<Data>;
-
-    protected override _updateObject(event: Event, formData: FolderConfig.FormData): Promise<unknown>;
-  }
-
-  namespace FolderConfig {
-    interface Options extends DocumentSheetOptions {
-      resolve?: (doc: InstanceType<ConfiguredDocumentClass<typeof Folder>>) => void;
-    }
-
-    interface Data {
-      name: string;
-      newName: string;
-      folder: foundry.data.FolderData;
-      safeColor: string;
-      sortingModes: {
-        a: 'FOLDER.SortAlphabetical';
-        m: 'FOLDER.SortManual';
-      };
-      submitText: string;
-    }
-
-    interface FormData {
-      color: string;
-      name: string;
-      parent: string;
-      sorting: SortingModes;
-      type: foundry.CONST.FOLDER_DOCUMENT_TYPES;
-    }
-  }
-}