@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

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

@@ -1,43 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Playlist document.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class PlaylistConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = PlaylistConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Playlist>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * const options = super.defaultOptions;
-     * options.id = "playlist-config";
-     * options.template = "templates/playlist/edit-playlist.html";
-     * options.width = 360;
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    protected override _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
-
-    /**
-     * @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 Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Playlist>>, Options> {
-      modes: Record<foundry.CONST.PLAYLIST_MODES, string>;
-      sorting: Record<foundry.CONST.PLAYLIST_SORT_MODES, string>;
-    }
-  }
-}

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

@@ -1,61 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-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
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class PlaylistSoundConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = PlaylistSoundConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "track-config",
-     *   template: "templates/playlist/edit-track.html",
-     *   width: 360
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    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 {
-    /**
-     * @typeParam Options - the type of the options object
-     */
-    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>, Options> {
-      lvolume: number;
-    }
-
-    interface FormData {
-      description: string;
-      fade: number | null;
-      lvolume: number;
-      name: string;
-      path: string;
-      repeat: boolean;
-    }
-  }
-}

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

@@ -1,175 +0,0 @@
-import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../../types/helperTypes';
-import type { TableResultDataConstructorData } from '../../../common/data/data.mjs/tableResultData';
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing a single RollTable document.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class RollTableConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = RollTableConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'RollTable'>>> {
-    /**
-     * @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_PERMISSION_LEVELS.OBSERVER,
-     *   scrollY: ["ol.table-results"],
-     *   dragDrop: [{ dragSelector: null, dropSelector: null }],
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    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?: TableResultDataConstructorData
-    ): Promise<ConfiguredDocumentClassForName<'TableResult'>[]>;
-
-    /**
-     * 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<InstanceType<ConfiguredDocumentClassForName<'TableResult'>> | undefined>;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Handle changing the actor profile image by opening a FilePicker
-     * @internal
-     */
-    protected _onEditImage(event: JQuery.ClickEvent): 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: InstanceType<ConfiguredDocumentClassForName<'TableResult'>>[]): 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 Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<RollTable, Options> {
-      results: ToObjectFalseType<foundry.data.TableResultData> & {
-        isText: boolean;
-        isDocument: boolean;
-        isCompendium: boolean;
-        img: string;
-        text: string;
-      };
-      resultTypes: {
-        [Key in keyof typeof foundry.CONST.TABLE_RESULT_TYPES as typeof foundry.CONST.TABLE_RESULT_TYPES[Key]]: Titlecase<Key>;
-      };
-      documentTypes: typeof foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-      compendiumPacks: string[];
-    }
-
-    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}.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.ts

@@ -1,148 +0,0 @@
-import type { ConfiguredDocumentClassForName, DocumentConstructor } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Scene document.   *
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class SceneConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = SceneConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Scene'>>> {
-    /**
-     * @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(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override close(options?: Application.CloseOptions | undefined): Promise<void>;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    override getData(options?: Partial<DocumentSheetOptions>): Data | Promise<Data>;
-
-    /**
-     * 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<DocumentConstructor, 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;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): 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 click events to open the grid configuration application
-     * @param event - The originating click event
-     */
-    protected _onGridConfig(event: JQuery.ClickEvent): void;
-
-    protected override _updateObject(event: Event, formData: SceneConfig.FormData): Promise<unknown>;
-  }
-
-  namespace SceneConfig {
-    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Scene'>>, Options> {
-      gridTypes: ReturnType<typeof SceneConfig['_getGridTypes']>;
-      weatherTypes: ReturnType<SceneConfig['_getWeatherTypes']>;
-      playlists: ReturnType<SceneConfig['_getDocuments']>;
-      sounds: ReturnType<SceneConfig['_getDocuments']>;
-      journals: ReturnType<SceneConfig['_getDocuments']>;
-      hasGlobalThreshold: boolean;
-      data: DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Scene'>>, Options>['data'] & {
-        /**
-         * @defaultValue `0`
-         */
-        globalLightThreshold: number;
-      };
-    }
-
-    type FormData = {
-      backgroundColor: string;
-      darkness: number;
-      fogExploration: boolean;
-      foreground: string;
-      globalLight: boolean;
-      globalLightThreshold: number;
-      grid: number | null;
-      gridAlpha: number;
-      gridColor: string;
-      gridDistance: number | null;
-      gridType: foundry.CONST.GRID_TYPES;
-      gridUnits: string;
-      hasGlobalThreshold: boolean;
-      height: number | null;
-      img: string;
-      'initial.scale': number | null;
-      'initial.x': number | null;
-      'initial.y': number | null;
-      journal: string;
-      name: string;
-      navName: string;
-      navigation: boolean;
-      padding: number;
-      'permission.default': foundry.CONST.DOCUMENT_PERMISSION_LEVELS;
-      playlist: string;
-      shiftX: number | null;
-      shiftY: number | null;
-      tokenVision: boolean;
-      weather: string;
-      width: number | null;
-    };
-  }
-}

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

@@ -1,184 +0,0 @@
-import type { DocumentConstructor, DocumentType } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * Document Sheet Configuration Application
-   * @typeParam Options          - The type of the options object
-   * @typeParam Data             - The data structure used to render the handlebars template.
-   * @typeParam ConcreteDocument - The type of the Document which is being managed
-   */
-  class DocumentSheetConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = DocumentSheetConfig.Data<foundry.abstract.Document<any, any>, Options>,
-    ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheetConfig.Data<infer T>
-      ? T
-      : foundry.abstract.Document<any, any>
-  > extends FormApplication<Options, Data, ConcreteDocument> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["form", "sheet-config"],
-     *   template: "templates/sheets/sheet-config.html",
-     *   width: 400
-     * })
-     * ```
-     */
-    static get defaultOptions(): FormApplicationOptions;
-
-    /**
-     * An array of pending sheet assignments which are submitted before other elements of the framework are ready.
-     * @internal
-     */
-    protected static _pending: Array<DocumentSheetConfig.SheetAssignment>;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    protected override _updateObject(event: Event, formData: DocumentSheetConfig.FormData): Promise<unknown>;
-
-    /**
-     * Initialize the configured Sheet preferences for Documents which support dynamic Sheet assignment
-     * Create the configuration structure for supported documents
-     * Process any pending sheet registrations
-     * Update the default values from settings data
-     */
-    static initializeSheets(): void;
-
-    /**
-     * @internal
-     */
-    protected static _getDocumentTypes(cls: DocumentConstructor, types?: string[]): string[];
-
-    /**
-     * Register a sheet class as a candidate which can be used to display documents of a given type
-     * @param documentClass - The Document class for which to register a new Sheet option
-     * @param scope         - Provide a unique namespace scope for this sheet
-     * @param sheetClass    - A defined Application class used to render the sheet
-     * @param options       - Additional options used for sheet registration
-     */
-    static registerSheet(
-      documentClass: DocumentConstructor,
-      scope: string,
-      sheetClass: ConstructorOf<FormApplication<FormApplicationOptions, any, any>>,
-      { label, types, makeDefault }?: DocumentSheetConfig.RegisterSheetOptions | undefined
-    ): void;
-
-    /**
-     * Perform the sheet registration
-     * @internal
-     */
-    protected static _registerSheet({
-      documentClass,
-      id,
-      label,
-      sheetClass,
-      types,
-      makeDefault
-    }: Omit<DocumentSheetConfig.SheetRegistration, 'action'>): void;
-
-    /**
-     * Unregister a sheet class, removing it from the list of available Applications to use for a Document type
-     * @param documentClass - The Document class for which to register a new Sheet option
-     * @param scope         - Provide a unique namespace scope for this sheet
-     * @param sheetClass    - A defined Application class used to render the sheet
-     * @param types         - An Array of types for which this sheet should be removed
-     */
-    static unregisterSheet(
-      documentClass: DocumentConstructor,
-      scope: string,
-      sheetClass: ConstructorOf<FormApplication<FormApplicationOptions, any, any>>,
-      { types }?: { types?: string[] }
-    ): void;
-
-    /**
-     * Perform the sheet de-registration
-     * @internal
-     */
-    protected static _unregisterSheet({
-      documentClass,
-      id,
-      types
-    }: Omit<DocumentSheetConfig.SheetUnregistration, 'action'>): void;
-
-    /**
-     * Update the currently default Sheets using a new core world setting
-     */
-    static updateDefaultSheets(setting?: Record<DocumentType, Record<string, string>>): void;
-
-    /**
-     * Initialize default sheet configurations for all document types.
-     * @internal
-     */
-    protected static _registerDefaultSheets(): void;
-  }
-
-  namespace DocumentSheetConfig {
-    type SheetRegistration = {
-      action: 'register';
-      documentClass: DocumentConstructor;
-      id: string;
-      label: string;
-      sheetClass: ConstructorOf<Application>;
-      types: string[];
-      makeDefault: boolean;
-    };
-
-    type SheetUnregistration = {
-      action: 'unregister';
-      documentClass: DocumentConstructor;
-      id: string;
-      types: string[];
-    };
-
-    type SheetAssignment = SheetRegistration | SheetUnregistration;
-
-    /**
-     * @typeParam ConcreteDocument - The type of the Document which is being managed
-     * @typeParam Options          - The type of the options object
-     */
-    interface Data<
-      ConcreteDocument extends foundry.abstract.Document<any, any>,
-      Options extends FormApplicationOptions = FormApplicationOptions
-    > {
-      isGM: boolean;
-      object: ConcreteDocument['data']['_source'];
-      options: Options;
-      sheetClass: string;
-      sheetClasses: Record<string, string>;
-      defaultClass: string;
-      blankLabel: string;
-    }
-
-    interface FormData {
-      defaultClass: string;
-      sheetClass: string;
-    }
-
-    interface RegisterSheetOptions {
-      /** A human readable label for the sheet name, which will be localized */
-      label?: string;
-
-      /** An array of document types for which this sheet should be used */
-      types?: string[];
-
-      /**
-       * Whether to make this sheet the default for provided types
-       * @defaultValue `false`
-       */
-      makeDefault?: boolean;
-    }
-  }
-
-  /**
-   * @deprecated since v9
-   */
-  class EntitySheetConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = DocumentSheetConfig.Data<foundry.abstract.Document<any, any>, Options>,
-    ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheetConfig.Data<infer T>
-      ? T
-      : foundry.abstract.Document<any, any>
-  > extends DocumentSheetConfig<Options, Data, ConcreteDocument> {}
-}

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

@@ -1,74 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single User document.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class UserConfig<
-    Options extends DocumentSheetOptions = UserConfig.Options,
-    Data extends object = UserConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof User>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "user-config"],
-     *   template: "templates/user/user-config.html",
-     *   width: 400,
-     *   height: "auto"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): UserConfig.Options;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Data;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle changing the user avatar image by opening a FilePicker
-     */
-    protected _onEditAvatar(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
-
-    /**
-     * @remarks This method not overridden in foundry but added to provide types when overriding the UserConfig.
-     */
-    protected _updateObject(event: Event, formData: FormData): Promise<unknown>;
-  }
-
-  namespace UserConfig {
-    interface Data<Options extends DocumentSheetOptions> {
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      actors: InstanceType<ConfiguredDocumentClass<typeof Actor>>[];
-      options: Options;
-    }
-
-    interface Options extends DocumentSheetOptions {
-      /**
-       * @defaultValue `["sheet", "user-config"]`
-       */
-      classes: DocumentSheetOptions['classes'];
-
-      /**
-       * @defaultValue `"templates/user/user-config.html"`
-       */
-      template: DocumentSheetOptions['template'];
-
-      /**
-       * @defaultValue `400`
-       */
-      width: DocumentSheetOptions['width'];
-
-      /**
-       * @defaultValue `auto`
-       */
-      height: DocumentSheetOptions['height'];
-    }
-  }
-}
-
-type FormData = Pick<foundry.data.UserData, 'avatar' | 'character' | 'color'>;