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

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

@@ -1,59 +0,0 @@
-import type { GetDataReturnType, MaybePromise, ValueOf } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A Macro configuration sheet
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class MacroConfig<
-    Options extends DocumentSheet.Options<Macro.Implementation> = DocumentSheet.Options<Macro.Implementation>,
-  > extends DocumentSheet<Macro.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "macro-sheet"],
-     *   template: "templates/sheets/macro-config.html",
-     *   width: 560,
-     *   height: 480,
-     *   resizable: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options<Macro.Implementation>;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<MacroConfig.MacroConfigData>>;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _disableFields(form: HTMLElement): void;
-
-    /**
-     * Save and execute the macro using the button on the configuration sheet
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onExecute(event: MouseEvent): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
-  }
-
-  namespace MacroConfig {
-    interface Any extends MacroConfig<any> {}
-
-    interface FormData {
-      command: string;
-      img: string;
-      name: string;
-      type: ValueOf<typeof CONST.MACRO_TYPES>;
-    }
-
-    interface MacroConfigData<
-      Options extends DocumentSheet.Options<Macro.Implementation> = DocumentSheet.Options<Macro.Implementation>,
-    > extends DocumentSheet.DocumentSheetData<Options, Macro.Implementation> {
-      macroTypes: Record<string, string>;
-      macroScopes: typeof CONST.MACRO_TYPES;
-    }
-  }
-}

package/src/foundry/client/apps/forms/measure-template.d.mts

@@ -1,57 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single MeasuredTemplate document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   */
-  class MeasuredTemplateConfig<
-    Options extends
-      DocumentSheet.Options<MeasuredTemplateDocument.Implementation> = DocumentSheet.Options<MeasuredTemplateDocument.Implementation>,
-  > extends DocumentSheet<MeasuredTemplateDocument.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "template-config",
-     *   classes: ["sheet", "template-sheet"],
-     *   title: "TEMPLATE.MeasuredConfig",
-     *   template: "templates/scene/template-config.html",
-     *   width: 400,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options<MeasuredTemplateDocument.Implementation>;
-
-    override getData(): MaybePromise<GetDataReturnType<MeasuredTemplateConfig.MeasuredTemplateConfigData>>;
-
-    protected override _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
-  }
-
-  namespace MeasuredTemplateConfig {
-    interface Any extends MeasuredTemplateConfig<any> {}
-
-    interface FormData {
-      angle: number | null;
-      borderColor: string;
-      direction: number | null;
-      distance: number | null;
-      fillColor: string;
-      hidden: boolean;
-      t: foundry.CONST.MEASURED_TEMPLATE_TYPES;
-      texture: string;
-      width: number | null;
-      x: number | null;
-      y: number | null;
-    }
-
-    interface MeasuredTemplateConfigData<
-      Options extends
-        DocumentSheet.Options<MeasuredTemplateDocument.Implementation> = DocumentSheet.Options<MeasuredTemplateDocument.Implementation>,
-    > extends DocumentSheet.DocumentSheetData<Options, MeasuredTemplateDocument.Implementation> {
-      templateTypes: Record<foundry.CONST.MEASURED_TEMPLATE_TYPES, string>;
-      gridUnits: string;
-      submitText: string;
-    }
-  }
-}

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

@@ -1,66 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * A generic application for configuring permissions for various Document types
-   * @typeParam Options          - the type of the options object
-   * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
-   */
-  class DocumentOwnershipConfig<
-    Options extends DocumentSheet.Options<ConcreteDocument>,
-    ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-  > extends DocumentSheet<ConcreteDocument, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "permission",
-     *   template: "templates/apps/ownership.html",
-     *   width: 400
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options;
-
-    override get title(): string;
-
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<DocumentOwnershipConfig.DocumentOwnershipConfigData>>;
-
-    protected override _updateObject(event: Event, formData: DocumentOwnershipConfig.FormData): Promise<unknown>;
-  }
-
-  namespace DocumentOwnershipConfig {
-    interface Any extends DocumentOwnershipConfig<any, any> {}
-  }
-
-  /**
-   * @deprecated since v10.
-   */
-  class PermissionControl extends DocumentOwnershipConfig<any, any> {}
-
-  namespace DocumentOwnershipConfig {
-    interface FormData {
-      [userId: string]: FormData.InputPermissionLevel;
-      default: FormData.InputPermissionLevel;
-    }
-
-    namespace FormData {
-      type InputPermissionLevel = foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | -1 | -2;
-    }
-
-    interface DocumentOwnershipConfigData {
-      currentDefault: { level: number; label: string };
-      instructions: string;
-      defaultLevels: { level: number; label: string }[];
-      playerLevels: { level: number; label: string }[];
-      isFolder: boolean;
-      users: {
-        user: User.Implementation;
-        level: number;
-        isAuthor: boolean;
-      }[];
-    }
-  }
-}

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

@@ -1,44 +0,0 @@
-import type { GetDataReturnType, MaybePromise, ValueOf } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Playlist document.
-   * @typeParam Options - the type of the options object
-   */
-  class PlaylistConfig<
-    Options extends DocumentSheet.Options<Playlist.Implementation> = DocumentSheet.Options<Playlist.Implementation>,
-  > extends DocumentSheet<Playlist.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.id = "playlist-config";
-     * options.template = "templates/playlist/edit-playlist.html";
-     * options.width = 360;
-     * ```
-     */
-    static get defaultOptions(): DocumentSheet.Options<Playlist.Implementation>;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<PlaylistConfig.PlaylistConfigData>>;
-
-    protected override _getFilePickerOptions(event: PointerEvent): FilePicker.Options;
-
-    /**
-     * @remarks The return type could be given more concretely but it is not supposed to be used.
-     */
-    protected override _onSelectFile(selection: string, filePicker: FilePicker): unknown;
-  }
-
-  namespace PlaylistConfig {
-    interface Any extends PlaylistConfig<any> {}
-
-    interface PlaylistConfigData<
-      Options extends DocumentSheet.Options<Playlist.Implementation> = DocumentSheet.Options<Playlist.Implementation>,
-    > extends DocumentSheet.DocumentSheetData<Options, Playlist.Implementation> {
-      modes: Record<ValueOf<typeof foundry.CONST.PLAYLIST_MODES>, string>;
-      sorting: Record<ValueOf<typeof foundry.CONST.PLAYLIST_SORT_MODES>, string>;
-    }
-  }
-}

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

@@ -1,63 +0,0 @@
-import type { GetDataReturnType, MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single PlaylistSound document within a parent Playlist.
-   *
-   * @param sound   - The PlaylistSound document being configured
-   * @param options - Additional application rendering options
-   * @typeParam Options - the type of the options object
-   */
-  class PlaylistSoundConfig<
-    Options extends
-      DocumentSheet.Options<PlaylistSound.Implementation> = DocumentSheet.Options<PlaylistSound.Implementation>,
-  > extends DocumentSheet<PlaylistSound.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "track-config",
-     *   template: "templates/playlist/edit-track.html",
-     *   width: 360
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options<PlaylistSound.Implementation>;
-
-    override get title(): string;
-
-    override getData(
-      options?: Partial<Options>,
-    ): MaybePromise<GetDataReturnType<PlaylistSoundConfig.PlaylistSoundConfigData>>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Auto-populate the track name using the provided filename, if a name is not already set
-     * @internal
-     */
-    protected _onSourceChange(event: JQuery.ChangeEvent): void;
-
-    protected override _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<unknown>;
-  }
-
-  namespace PlaylistSoundConfig {
-    interface Any extends PlaylistSoundConfig<any> {}
-
-    interface FormData {
-      description: string;
-      fade: number | null;
-      lvolume: number;
-      name: string;
-      path: string;
-      repeat: boolean;
-    }
-
-    interface PlaylistSoundConfigData<
-      Options extends
-        DocumentSheet.Options<PlaylistSound.Implementation> = DocumentSheet.Options<PlaylistSound.Implementation>,
-    > extends DocumentSheet.DocumentSheetData<Options, PlaylistSound.Implementation> {
-      lvolume: number;
-    }
-  }
-}

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

@@ -1,161 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing a single RollTable document.
-   * @typeParam Options - the type of the options object
-   */
-  class RollTableConfig<
-    Options extends DocumentSheet.Options<RollTable.Implementation> = DocumentSheet.Options<RollTable.Implementation>,
-  > extends DocumentSheet<RollTable.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "roll-table-config"],
-     *   template: "templates/sheets/roll-table-config.html",
-     *   width: 720,
-     *   height: "auto",
-     *   closeOnSubmit: false,
-     *   viewPermission: CONST.DOCUMENT_OWNERSHIP_LEVELS.OBSERVER,
-     *   scrollY: ["table.table-results"],
-     *   dragDrop: [{ dragSelector: null, dropSelector: null }],
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options<RollTable.Implementation>;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: implement GetDataReturnType
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle creating a TableResult in the RollTable document
-     * @param event      - The originating mouse event
-     * @param resultData - An optional object of result data to use
-     * @internal
-     */
-    protected _onCreateResult(
-      event: JQuery.ClickEvent | DragEvent,
-      resultData?: foundry.documents.BaseTableResult.CreateData,
-    ): Promise<TableResult.Implementation[]>;
-
-    /**
-     * Submit the entire form when a table result type is changed, in case there are other active changes
-     * @internal
-     */
-    protected _onChangeResultType(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle deleting a TableResult from the RollTable document
-     * @param event - The originating click event
-     * @returns The deleted TableResult document
-     * @internal
-     */
-    protected _onDeleteResult(event: JQuery.ClickEvent): Promise<TableResult.Implementation>;
-
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    protected override _onDrop(event: DragEvent): Promise<TableResult.Implementation[]> | void;
-
-    /**
-     * Handle changing the actor profile image by opening a FilePicker
-     * @internal
-     */
-    protected _onEditImage(event: MouseEvent): Promise<void>;
-
-    /**
-     * Handle a button click to re-normalize dice result ranges across all RollTable results
-     * @internal
-     */
-    protected _onNormalizeResults(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle toggling the drawn status of the result in the table
-     * @internal
-     */
-    protected _onLockResult(event: JQuery.ClickEvent): void;
-
-    /**
-     * Reset the Table to it's original composition with all options unlocked
-     * @internal
-     */
-    protected _onResetTable(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle drawing a result from the RollTable
-     * @internal
-     */
-    protected _onRollTable(event: JQuery.ClickEvent): void;
-
-    /**
-     * Configure the update object workflow for the Roll Table configuration sheet
-     * Additional logic is needed here to reconstruct the results array from the editable fields on the sheet
-     * @param event    - The form submission event
-     * @param formData - The validated FormData translated into an Object for submission
-     * @internal
-     */
-    protected _updateObject(event: Event, formData: RollTableConfig.FormData): Promise<unknown>;
-
-    /**
-     * Display a roulette style animation when a Roll Table result is drawn from the sheet
-     * @param results - An Array of drawn table results to highlight
-     * @returns A Promise which resolves once the animation is complete
-     */
-    protected _animateRoll(results: TableResult.Implementation[]): Promise<void[]>;
-
-    /**
-     * Animate a "roulette" through the table until arriving at the final loop and a drawn result
-     */
-    protected _animateRoulette(
-      ol: HTMLOListElement,
-      drawnIds: Set<string>,
-      nLoops: number,
-      animTime: number,
-      animOffset: number,
-    ): Promise<void>;
-
-    /**
-     * Display a flashing animation on the selected result to emphasize the draw
-     * @param item - The HTML \<li\> item of the winning result
-     * @returns A Promise that resolves once the animation is complete
-     */
-    protected _flashResult(item: HTMLElement): Promise<void>;
-  }
-
-  namespace RollTableConfig {
-    interface Any extends RollTableConfig<any> {}
-
-    type FormData = {
-      description: string;
-      displayRoll: boolean;
-      formula: string;
-      img: string;
-      name: string;
-      replacement: boolean;
-    } & FormDataResults;
-
-    type FormDataResults = {
-      [Key in number as `results.${number}._id`]: string;
-    } & {
-      [Key in number as `results.${number}.documentCollection`]: string;
-    } & {
-      [Key in number as `results.${number}.documentId`]: string;
-    } & {
-      [Key in number as `results.${number}.drawn`]: boolean;
-    } & {
-      [Key in number as `results.${number}.img`]: string;
-    } & {
-      [Key in number as `results.${number}.rangeH`]: number;
-    } & {
-      [Key in number as `results.${number}.rangeL`]: number;
-    } & {
-      [Key in number as `results.${number}.text`]: string;
-    } & {
-      [Key in number as `results.${number}.type`]: foundry.CONST.TABLE_RESULT_TYPES;
-    } & {
-      [Key in number as `results.${number}.weight`]: string;
-    };
-  }
-}

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

@@ -1,156 +0,0 @@
-import type { MaybePromise } from "fvtt-types/utils";
-import type Document from "#common/abstract/document.d.mts";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Scene document.   *
-   * @typeParam Options - the type of the options object
-   */
-  class SceneConfig<
-    Options extends DocumentSheet.Options<Scene.Implementation> = DocumentSheet.Options<Scene.Implementation>,
-  > extends DocumentSheet<Scene.Implementation, Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "scene-config",
-     *   classes: ["sheet", "scene-sheet"],
-     *   template: "templates/scene/config.html",
-     *   width: 560,
-     *   height: "auto",
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheet.Options<Scene.Implementation>;
-
-    /**
-     * Indicates if width / height should change together to maintain aspect ratio
-     */
-    linkedDimensions: boolean;
-
-    override get title(): string;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: implement GetDataReturnType
-
-    /**
-     * Get an enumeration of the available grid types which can be applied to this Scene
-     * @internal
-     */
-    protected static _getGridTypes(): Record<foundry.CONST.GRID_TYPES, string>;
-
-    /**
-     * Get the available weather effect types which can be applied to this Scene
-     * @internal
-     */
-    protected _getWeatherTypes(): Record<string, string>;
-
-    /**
-     * Get the alphabetized Documents which can be chosen as a configuration for the Scene
-     * @internal
-     */
-    protected _getDocuments(
-      collection: WorldCollection<Document.AnyConstructor, string>,
-    ): { _id: string; name: string }[];
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Capture the current Scene position and zoom level as the initial view in the Scene config
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onCapturePosition(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle click events to open the grid configuration application
-     * @param event - The originating click event
-     */
-    protected _onGridConfig(event: Event): Promise<void>;
-
-    /**
-     * Handle click events to link or unlink the scene dimensions
-     */
-    protected _onLinkDimensions(event: Event): Promise<void>;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
-
-    protected override _onChangeColorPicker(event: JQuery.ChangeEvent): void;
-
-    protected override _onChangeRange(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Live update the scene as certain properties are changed.
-     * @param changed - The changed property.
-     * @internal
-     */
-    protected _previewScene(changed: string): void;
-
-    /**
-     * Reset the previewed darkness level, background color, grid alpha, and grid color back to their true values.
-     * @internal
-     */
-    protected _resetScenePreview(): void;
-
-    /**
-     * Handle updating the select menu of PlaylistSound options when the Playlist is changed
-     * @param event - The initiating select change event
-     * @internal
-     */
-    _onChangePlaylist(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle updating the select menu of JournalEntryPage options when the JournalEntry is changed.
-     * @param event - The initiating select change event.
-     */
-    protected _onChangeJournal(event: JQuery.ChangeEvent): void;
-
-    protected override _updateObject(event: Event, formData: SceneConfig.FormData): Promise<unknown>;
-  }
-
-  namespace SceneConfig {
-    interface Any extends SceneConfig<any> {}
-
-    interface FormData {
-      backgroundColor: Scene.Implementation["backgroundColor"];
-      "background.src": Scene.Implementation["background"]["src"];
-      "background.offsetX": Scene.Implementation["background"]["offsetX"];
-      "background.offsetY": Scene.Implementation["background"]["offsetY"];
-      darkness: Scene.Implementation["darkness"];
-      fogExploration: Scene.Implementation["fogExploration"];
-      fogOverlay: Scene.Implementation["fogOverlay"];
-      fogUnexploredColor: Scene.Implementation["fogUnexploredColor"];
-      foreground: Scene.Implementation["foreground"];
-      foregroundElevation: Scene.Implementation["foregroundElevation"];
-      globalLight: Scene.Implementation["globalLight"];
-      globalLightThreshold: Scene.Implementation["globalLightThreshold"];
-      grid: Scene.Implementation["grid"];
-      "grid.alpha": Scene.Implementation["grid"]["alpha"];
-      "grid.color": Scene.Implementation["grid"]["color"];
-      "grid.distance": Scene.Implementation["grid"]["distance"];
-      "grid.type": Scene.Implementation["grid"]["type"];
-      "grid.units": Scene.Implementation["grid"]["units"];
-      hasGlobalThreshold: boolean;
-      height: Scene.Implementation["height"];
-      "initial.scale": Scene.Implementation["initial"]["scale"];
-      "initial.x": Scene.Implementation["initial"]["x"];
-      "initial.y": Scene.Implementation["initial"]["y"];
-      journal: Scene.Implementation["_source"]["journal"];
-      journalEntryPage: Scene.Implementation["journalEntryPage"];
-      name: Scene.Implementation["name"];
-      navName: Scene.Implementation["navName"];
-      navigation: Scene.Implementation["navigation"];
-      padding: Scene.Implementation["padding"];
-      "ownership.default": Scene.Implementation["ownership"]["default"];
-      playlist: Scene.Implementation["playlist"];
-      playlistSound: Scene.Implementation["playlistSound"];
-      tokenVision: Scene.Implementation["tokenVision"];
-      weather: Scene.Implementation["weather"];
-      width: Scene.Implementation["width"];
-    }
-  }
-}