@league-of-foundry-developers/foundry-vtt-types 9.255.1 → 9.268.0

package/src/foundry/foundry.js/applications/formApplications/documentSheets/journalSheet.d.ts

@@ -1,13 +1,18 @@
 import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
+  interface JournalSheetOptions extends DocumentSheetOptions {
+    /** The current display mode of the journal. Either 'text' or 'image'. */
+    sheetMode?: JournalSheet.SheetMode | null;
+  }
+
   /**
    * The Application responsible for displaying and editing a single JournalEntry document.
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class JournalSheet<
-    Options extends JournalSheet.Options = JournalSheet.Options,
+    Options extends JournalSheetOptions = JournalSheetOptions,
     Data extends object = JournalSheet.Data<Options>
   > extends DocumentSheet<Options, Data> {
     /**
@@ -41,11 +46,11 @@ declare global {
      *   resizable: true,
      *   closeOnSubmit: false,
      *   submitOnClose: true,
-     *   viewPermission: CONST.ENTITY_PERMISSIONS.NONE
+     *   viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.NONE
      * })
      * ```
      */
-    static get defaultOptions(): JournalSheet.Options;
+    static get defaultOptions(): JournalSheetOptions;
 
     /** @override */
     get template(): string;
@@ -72,10 +77,7 @@ declare global {
     getData(options?: Partial<Options>): Promise<Data> | Data;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: JournalSheet.FormData
-    ): ReturnType<DocumentSheet<Options, Data>['_updateObject']>;
+    protected _updateObject(event: Event, formData: JournalSheet.FormData): Promise<unknown>;
 
     /**
      * Handle requests to switch the rendered mode of the Journal Entry sheet
@@ -96,11 +98,7 @@ declare global {
   }
 
   namespace JournalSheet {
-    interface Options extends DocumentSheetOptions {
-      sheetMode?: SheetMode | null;
-    }
-
-    interface Data<Options extends JournalSheet.Options = JournalSheet.Options>
+    interface Data<Options extends JournalSheetOptions = JournalSheetOptions>
       extends DocumentSheet.Data<ConcreteJournalEntry, Options> {
       image: string;
       folders: ReturnType<NonNullable<Game['folders']>['filter']>;

package/src/foundry/foundry.js/applications/formApplications/documentSheets/macroConfig.d.ts

@@ -4,7 +4,6 @@ declare global {
   /**
    * A Macro configuration sheet
    *
-   * @see {@link Macro} The Macro Entity which is being configured
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
@@ -36,6 +35,9 @@ declare global {
     /** @override */
     activateListeners(html: JQuery): void;
 
+    /** @override */
+    protected _disableFields(form: HTMLElement): void;
+
     /**
      * Handle changing the actor profile image by opening a FilePicker
      * @internal
@@ -50,10 +52,7 @@ declare global {
     protected _onExecute(event: JQuery.ClickEvent): Promise<void>;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: MacroConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Macro>> | undefined>;
+    protected _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
   }
 
   namespace MacroConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts

@@ -3,7 +3,6 @@ import type { ConfiguredDocumentClassForName } from '../../../../../types/helper
 declare global {
   /**
    * The Application responsible for configuring a single MeasuredTemplate document within a parent Scene.
-   * @see {@link MeasuredTemplate}
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
@@ -18,7 +17,7 @@ declare global {
      * foundry.utils.mergeObject(super.defaultOptions, {
      *   id: "template-config",
      *   classes: ["sheet", "template-sheet"],
-     *   title: "Measurement Template Configuration",
+     *   title: "TEMPLATE.MeasuredConfig",
      *   template: "templates/scene/template-config.html",
      *   width: 400,
      * })
@@ -30,10 +29,7 @@ declare global {
     getData(): Data | Promise<Data>;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: MeasuredTemplateConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>> | undefined>;
+    protected _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
   }
 
   namespace MeasuredTemplateConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts

@@ -33,10 +33,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: NoteConfig.FormData
-    ): Promise<ConfiguredDocumentClassForName<'Note'> | undefined>;
+    protected _updateObject(event: Event, formData: NoteConfig.FormData): Promise<unknown>;
 
     /**
      * @override

package/src/foundry/foundry.js/applications/formApplications/documentSheets/permissionControl.d.ts

@@ -2,27 +2,27 @@ import type { ConfiguredDocumentClassForName } from '../../../../../types/helper
 
 declare global {
   /**
-   * A generic application for configuring permissions for various Entity types
+   * A generic application for configuring permissions for various Document types
    * @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 should be managed by this form sheet
    */
   class PermissionControl<
     Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = DocumentSheet.Data,
+    Data extends object = PermissionControl.Data,
     ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
       ? T
       : foundry.abstract.Document<any, any>
-  > extends DocumentSheet<Options, PermissionControl.Data<ConcreteDocument>, ConcreteDocument> {
+  > extends DocumentSheet<Options, PermissionControl.Data, ConcreteDocument> {
     /**
      * @override
      * @defaultValue
      * ```typescript
-     * mergeObject(super.defaultOptions, {
+     * foundry.utils.mergeObject(super.defaultOptions, {
      *   id: "permission",
      *   template: "templates/apps/permission.html",
      *   width: 400
-     * });
+     * })
      * ```
      */
     static get defaultOptions(): DocumentSheetOptions;
@@ -30,19 +30,15 @@ declare global {
     /** @override */
     get title(): string;
 
-    /**
-     * @override
-     * @param options - (unused)
-     */
-    getData(options?: Partial<Options>): PermissionControl.Data<ConcreteDocument>;
+    /** @override */
+    getData(options?: Partial<Options> | undefined): PermissionControl.Data | Promise<PermissionControl.Data>;
 
     /** @override */
     protected _updateObject(event: Event, formData: PermissionControl.FormData): Promise<unknown>;
   }
 
   namespace PermissionControl {
-    interface Data<ConcreteDocument extends foundry.abstract.Document<any, any>> extends DocumentSheet.Data {
-      entity: ConcreteDocument;
+    interface Data {
       currentDefault: foundry.CONST.DOCUMENT_PERMISSION_LEVELS | '-1';
       instructions: string;
       defaultLevels: Record<foundry.CONST.DOCUMENT_PERMISSION_LEVELS, string> & { '-1'?: string };

package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistConfig.d.ts

@@ -31,7 +31,7 @@ declare global {
     getData(options?: Partial<Options>): Data | Promise<Data>;
 
     /** @override */
-    protected _getFilePickerOptions(event: PointerEvent): FilePicker.Options;
+    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
 
     /**
      * @override
@@ -44,6 +44,7 @@ declare global {
     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/foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts

@@ -48,10 +48,7 @@ declare global {
      * @override
      * @param event - (unused)
      */
-    protected _updateObject(
-      event: Event,
-      formData: PlaylistSoundConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>> | undefined>;
+    protected _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<unknown>;
   }
 
   namespace PlaylistSoundConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts

@@ -9,9 +9,10 @@ declare global {
    */
   class RollTableConfig<
     Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = RollTableConfig.Data
+    Data extends object = RollTableConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'RollTable'>>> {
     /**
+     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -20,7 +21,7 @@ declare global {
      *   width: 720,
      *   height: "auto",
      *   closeOnSubmit: false,
-     *   viewPermission: CONST.ENTITY_PERMISSIONS.OBSERVER,
+     *   viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.OBSERVER,
      *   scrollY: ["ol.table-results"],
      *   dragDrop: [{ dragSelector: null, dropSelector: null }],
      * })
@@ -45,7 +46,7 @@ declare global {
     activateListeners(html: JQuery): void;
 
     /**
-     * Handle creating a TableResult in the RollTable entity
+     * 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
@@ -62,7 +63,7 @@ declare global {
     protected _onChangeResultType(event: JQuery.ChangeEvent): void;
 
     /**
-     * Handle deleting a TableResult from the RollTable entity
+     * Handle deleting a TableResult from the RollTable document
      * @param event - The originating click event
      * @returns The deleted TableResult document
      * @internal
@@ -114,10 +115,7 @@ declare global {
      * @param formData - The validated FormData translated into an Object for submission
      * @internal
      */
-    protected _updateObject(
-      event: Event,
-      formData: RollTableConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'RollTable'>> | undefined>;
+    protected _updateObject(event: Event, formData: RollTableConfig.FormData): Promise<unknown>;
 
     /**
      * Display a roulette style animation when a Roll Table result is drawn from the sheet
@@ -146,10 +144,11 @@ declare global {
   }
 
   namespace RollTableConfig {
-    interface Data extends DocumentSheet.Data<RollTable> {
+    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
+      extends DocumentSheet.Data<RollTable, Options> {
       results: ToObjectFalseType<foundry.data.TableResultData> & {
         isText: boolean;
-        isEntity: boolean;
+        isDocument: boolean;
         isCompendium: boolean;
         img: string;
         text: string;
@@ -157,7 +156,7 @@ declare global {
       resultTypes: {
         [Key in keyof typeof foundry.CONST.TABLE_RESULT_TYPES as typeof foundry.CONST.TABLE_RESULT_TYPES[Key]]: Titlecase<Key>;
       };
-      entityTypes: typeof foundry.CONST.COMPENDIUM_ENTITY_TYPES;
+      documentTypes: typeof foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
       compendiumPacks: string[];
     }
 

package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts

@@ -2,9 +2,7 @@ import type { ConfiguredDocumentClassForName, DocumentConstructor } from '../../
 
 declare global {
   /**
-   * The Application responsible for configuring a single Scene document.
-   * @see {@link Scene} The Scene Document which is being configured
-   *
+   * 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.
    */
@@ -20,8 +18,9 @@ declare global {
      *   id: "scene-config",
      *   classes: ["sheet", "scene-sheet"],
      *   template: "templates/scene/config.html",
-     *   width: 680,
+     *   width: 560,
      *   height: "auto",
+     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
      * });
      * ```
      */
@@ -32,13 +31,11 @@ declare global {
      */
     get title(): string;
 
-    /**
-     * @override
-     * @remarks This incorrectly overrides `Application#render` by potentially returning `void`, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6026.
-     */
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-expect-error
-    render(force?: boolean, options?: Application.RenderOptions<Options>): this | void;
+    /** @override */
+    close(options?: Application.CloseOptions | undefined): Promise<void>;
+
+    /** @override */
+    render(force?: boolean, options?: Application.RenderOptions<Options>): this;
 
     /**
      * @param options - (unused)
@@ -74,9 +71,28 @@ declare global {
      */
     protected _onCapturePosition(event: JQuery.ClickEvent): void;
 
+    /** @override */
+    protected _onChangeInput(event: JQuery.ChangeEvent): void;
+
+    /** @override */
+    protected _onChangeColorPicker(event: JQuery.ChangeEvent): void;
+
     /** @override */
     protected _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
@@ -93,10 +109,7 @@ declare global {
     /**
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: SceneConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Scene'>> | undefined>;
+    protected _updateObject(event: Event, formData: SceneConfig.FormData): Promise<unknown>;
   }
 
   namespace SceneConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts

@@ -29,10 +29,10 @@ declare global {
     static get defaultOptions(): TileConfig.Options;
 
     /** @override */
-    close(options: Application.CloseOptions): Promise<void>;
+    close(options?: Application.CloseOptions | undefined): Promise<void>;
 
     /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
 
     /** @override */
     protected _onChangeInput(event: JQuery.ChangeEvent): void;
@@ -41,10 +41,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: TileConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Tile'>> | undefined>;
+    protected _updateObject(event: Event, formData: TileConfig.FormData): Promise<unknown>;
   }
 
   namespace TileConfig {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/userConfig.d.ts

@@ -41,10 +41,7 @@ declare global {
     /**
      * @remarks This method not overridden in foundry but added to provide types when overriding the UserConfig.
      */
-    protected _updateObject(
-      event: Event,
-      formData: FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof User>> | undefined>;
+    protected _updateObject(event: Event, formData: FormData): Promise<unknown>;
   }
 
   namespace UserConfig {

package/src/foundry/foundry.js/applications/formApplications/drawingConfig.d.ts

@@ -1,16 +1,25 @@
 import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
+  interface DrawingConfigOptions extends FormApplicationOptions {
+    /**
+     * Configure the default drawing settings, instead of a specific Drawing
+     * @defaultValue `false`
+     */
+    configureDefault: boolean;
+  }
+
   /**
    * The Application responsible for configuring a single Drawing document within a parent Scene.
    * @typeParam Options - the type of the options object
    * @typeParam Data    - The data structure used to render the handlebars template.
    */
   class DrawingConfig<
-    Options extends DrawingConfig.Options = DrawingConfig.Options,
+    Options extends DrawingConfigOptions = DrawingConfigOptions,
     Data extends object = DrawingConfig.Data<Options>
   > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Drawing'>>> {
     /**
+     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -18,17 +27,20 @@ declare global {
      *   classes: ["sheet"],
      *   template: "templates/scene/drawing-config.html",
      *   width: 480,
-     *   height: 360,
+     *   height: "auto",
      *   configureDefault: false,
      *   tabs: [{ navSelector: ".tabs", contentSelector: "form", initial: "position" }],
      * });
      * ```
      */
-    static get defaultOptions(): DrawingConfig.Options;
+    static get defaultOptions(): DrawingConfigOptions;
 
     /** @override */
     get title(): string;
 
+    /** @override */
+    get id(): string;
+
     /** @override */
     getData(options?: Partial<Options>): Data | Promise<Data>;
 
@@ -39,10 +51,7 @@ declare global {
     protected static _getFillTypes(): DrawingConfig.FillTypes;
 
     /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: DrawingConfig.FormData
-    ): Promise<foundry.data.DrawingData['_source'] | ConfiguredDocumentClassForName<'Drawing'> | undefined>;
+    protected _updateObject(event: Event, formData: DrawingConfig.FormData): Promise<unknown>;
 
     /** @override */
     close(options?: FormApplication.CloseOptions): Promise<void>;
@@ -58,7 +67,7 @@ declare global {
   }
 
   namespace DrawingConfig {
-    interface Data<Options extends DrawingConfig.Options = DrawingConfig.Options> {
+    interface Data<Options extends DrawingConfigOptions = DrawingConfigOptions> {
       author: string;
       isDefault: boolean;
       fillTypes: DrawingConfig.FillTypes;
@@ -93,18 +102,5 @@ declare global {
       y: number | null;
       z: number | null;
     }
-
-    interface Options extends FormApplicationOptions {
-      /**
-       * Configure the default drawing settings, instead of a specific Drawing
-       * @defaultValue `false`
-       */
-      configureDefault: boolean;
-
-      /**
-       * Configure a preview version of the Drawing which is not yet saved
-       */
-      preview?: boolean;
-    }
   }
 }

package/src/foundry/foundry.js/applications/formApplications/gridConfig.d.ts

@@ -75,14 +75,14 @@ declare global {
     close(options?: FormApplication.CloseOptions): ReturnType<FormApplication['close']>;
 
     /**
-     * Handle resetting the form and re-drawing back to the original dimensions
+     * Handle keyboard events.
      * @param event - The original keydown event
      * @internal
      */
     protected _onKeyDown(event: KeyboardEvent): void;
 
     /**
-     * Handle resetting the form and re-drawing back to the original dimensions
+     * Handle mousewheel events.
      * @param event - The original wheel event
      * @internal
      */
@@ -145,7 +145,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(event: Event, formData: GridConfig.FormData): ReturnType<Scene['update']>;
+    protected _updateObject(event: Event, formData: GridConfig.FormData): Promise<unknown>;
   }
 
   namespace GridConfig {

package/src/foundry/foundry.js/applications/formApplications/imagePopout.d.ts

@@ -1,15 +1,32 @@
+interface ImagePopoutOptions extends FormApplicationOptions {
+  /**
+   * Can this image be shared with connected users?
+   * @defaultValue `false`
+   */
+  shareable: boolean;
+
+  /**
+   * The UUID of some related {@link Document}.
+   * @defaultValue `null`
+   */
+  uuid: string | null;
+}
+
 /**
  * An Image Popout Application which features a single image in a lightbox style frame.
  * This popout can also be used as a form, allowing the user to edit an image which is being used.
  * Furthermore, this application allows for sharing the display of an image with other connected players.
  *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ *
  * @example
  * ```typescript
  * // Construct the Application instance
  * const ip = new ImagePopout("path/to/image.jpg", {
  *   title: "My Featured Image",
  *   shareable: true,
- *   entity: game.actors.getName("My Hero")
+ *   uuid: game.actors.getName("My Hero").uuid
  * });
  *
  * // Display the image popout
@@ -19,7 +36,10 @@
  * ip.share();
  * ```
  */
-declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopout.Data, string> {
+declare class ImagePopout<
+  Options extends ImagePopoutOptions = ImagePopoutOptions,
+  Data extends object = ImagePopout.Data
+> extends FormApplication<Options, Data, string> {
   constructor(src: string, options?: Partial<ImagePopout.Options>);
 
   /**
@@ -27,14 +47,27 @@ declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopo
    */
   protected _related: foundry.abstract.Document<any, any> | null;
 
-  /** @override */
-  static get defaultOptions(): ImagePopout.Options;
+  /**
+   * @override
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   template: "templates/apps/image-popout.html",
+   *   classes: ["image-popout", "dark"],
+   *   editable: false,
+   *   resizable: true,
+   *   shareable: false,
+   *   uuid: null
+   * })
+   * ```
+   */
+  static get defaultOptions(): ImagePopoutOptions;
 
   /** @override */
   get title(): string;
 
   /** @override */
-  getData(options?: Partial<ImagePopout.Options>): Promise<ImagePopout.Data>;
+  getData(options?: Partial<Options> | undefined): Promise<Data>;
 
   /**
    * Test whether the title of the image popout should be visible to the user
@@ -42,12 +75,12 @@ declare class ImagePopout extends FormApplication<ImagePopout.Options, ImagePopo
   isTitleVisible(): boolean;
 
   /**
-   * Provide a reference to the Entity referenced by this popout, if one exists
+   * Provide a reference to the Document referenced by this popout, if one exists
    */
   getRelatedObject(): Promise<foundry.abstract.Document<any, any> | null>;
 
   /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<ImagePopout.Options>): Promise<void>;
+  protected _render(force?: boolean, options?: Application.RenderOptions<Options> | undefined): Promise<void>;
 
   /** @override */
   protected _getHeaderButtons(): Application.HeaderButton[];

package/src/foundry/foundry.js/applications/formApplications/index.d.ts

@@ -1,10 +1,9 @@
 import './avConfig';
 import './combatTrackerConfig';
-import './defaultTokenConfig';
 import './documentSheet';
+import './documentSheetConfig';
 import './documentSheets';
 import './drawingConfig';
-import './entitySheetConfig';
 import './gridConfig';
 import './imagePopout';
 import './keybindingsConfig';
@@ -12,5 +11,6 @@ import './moduleManagement';
 import './permissionConfig';
 import './settingsConfig';
 import './tokenConfig';
+import './tokenConfigs';
 import './wallConfig';
 import './worldConfig';