@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/combatantConfig.d.ts → client/apps/forms/combatant-config.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -23,19 +23,11 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): CombatantConfig.Options;
+    static override get defaultOptions(): CombatantConfig.Options;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(
-      event: Event,
-      formData: CombatantConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Combatant>> | undefined>;
+    protected override _updateObject(event: Event, formData: CombatantConfig.FormData): Promise<unknown>;
   }
 
   namespace CombatantConfig {

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/activeEffectConfig.d.ts → client/apps/forms/effect-config.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = ActiveEffectConfig.Data
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof ActiveEffect>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -24,21 +23,13 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): ActiveEffectConfig.Options;
+    static override get defaultOptions(): ActiveEffectConfig.Options;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @override
-     *
-     * @remarks The implementation doesn't return a `Promise` but the return type includes it to allow extending
-     * classes to do that.
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Provide centralized handling of mouse clicks on control buttons.
@@ -53,10 +44,9 @@ declare global {
     protected _addEffectChange(): Promise<this>;
 
     /**
-     * @override
      * @param updateData - (default: `{}`)
      */
-    _getSubmitData(updateData?: FormApplication.OnSubmitOptions['updateData']): Record<string, unknown>;
+    override _getSubmitData(updateData?: FormApplication.OnSubmitOptions['updateData']): Record<string, unknown>;
     // TODO: Can we type this better?
   }
 

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

@@ -0,0 +1,63 @@
+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;
+    }
+  }
+}

package/src/foundry/{foundry.js/applications/formApplications/gridConfig.d.ts → client/apps/forms/grid-config.d.ts}

@@ -43,7 +43,6 @@ declare global {
     protected _wheelHandler: ((event: WheelEvent) => void) | null;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -57,32 +56,25 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): typeof FormApplication['defaultOptions'];
+    static override get defaultOptions(): typeof FormApplication['defaultOptions'];
 
-    /** @override */
-    getData(options?: Partial<Options>): GridConfig.Data;
+    override getData(options?: Partial<Options>): GridConfig.Data;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
-    /** @override */
-    close(options?: FormApplication.CloseOptions): ReturnType<FormApplication['close']>;
+    override 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
      */
@@ -136,16 +128,9 @@ declare global {
      */
     protected _refresh({ background, grid }?: { background?: boolean; grid?: boolean }): void;
 
-    /**
-     * @override
-     */
-    protected _onChangeInput(event: JQuery.ChangeEvent): void;
+    protected override _onChangeInput(event: JQuery.ChangeEvent): void;
 
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _updateObject(event: Event, formData: GridConfig.FormData): ReturnType<Scene['update']>;
+    protected override _updateObject(event: Event, formData: GridConfig.FormData): Promise<unknown>;
   }
 
   namespace GridConfig {

package/src/foundry/client/apps/forms/image-popout.d.ts

@@ -0,0 +1,166 @@
+export {};
+
+declare global {
+  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,
+   *   uuid: game.actors.getName("My Hero").uuid
+   * });
+   *
+   * // Display the image popout
+   * ip.render(true);
+   *
+   * // Share the image with other connected players
+   * ip.share();
+   * ```
+   */
+  class ImagePopout<
+    Options extends ImagePopoutOptions = ImagePopoutOptions,
+    Data extends object = ImagePopout.Data
+  > extends FormApplication<Options, Data, string> {
+    constructor(src: string, options?: Partial<ImagePopout.Options>);
+
+    /**
+     * @defaultValue `null`
+     */
+    protected _related: foundry.abstract.Document<any, any> | null;
+
+    /**
+     * @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 override get defaultOptions(): ImagePopoutOptions;
+
+    override get title(): string;
+
+    override getData(options?: Partial<Options> | undefined): Promise<Data>;
+
+    /**
+     * Test whether the title of the image popout should be visible to the user
+     */
+    isTitleVisible(): boolean;
+
+    /**
+     * Provide a reference to the Document referenced by this popout, if one exists
+     */
+    getRelatedObject(): Promise<foundry.abstract.Document<any, any> | null>;
+
+    protected override _render(
+      force?: boolean,
+      options?: Application.RenderOptions<Options> | undefined
+    ): Promise<void>;
+
+    protected override _getHeaderButtons(): Application.HeaderButton[];
+
+    /**
+     * Determine the correct position and dimensions for the displayed image
+     * @returns The positioning object which should be used for rendering
+     */
+    protected static getPosition(
+      img: string
+    ): Promise<{ width: number; height: number } | { width: number; height: number; top: number; left: number }>;
+
+    /**
+     * Determine the Image dimensions given a certain path
+     */
+    static getImageSize(path: string): Promise<[width: number, height: number]>;
+
+    /**
+     * Share the displayed image with other connected Users
+     */
+    shareImage(): void;
+
+    /**
+     * Handle a received request to display an image.
+     */
+    protected static _handleShareImage({
+      image,
+      title,
+      uuid
+    }?: {
+      image: string;
+      title: string;
+      uuid: string;
+    }): ImagePopout;
+
+    /**
+     * @remarks Not implemented for ImagePopout
+     */
+    protected override _updateObject(event: Event, formData?: object): never;
+  }
+
+  namespace ImagePopout {
+    interface Options extends FormApplicationOptions {
+      /**
+       * @defaultValue `'templates/apps/image-popout.html'`
+       */
+      template: string;
+
+      /**
+       * @defaultValue `['image-popout', 'dark']`
+       */
+      classes: string[];
+
+      /**
+       * @defaultValue `false`
+       */
+      editable: boolean;
+
+      /**
+       * @defaultValue `true`
+       */
+      resizable: boolean;
+
+      /**
+       * @defaultValue `false`
+       */
+      shareable: boolean;
+
+      /**
+       * @defaultValue `null`
+       */
+      uuid: string | null;
+    }
+
+    interface Data {
+      image: string;
+      options: Options;
+      title: string;
+      showTitle: boolean;
+    }
+  }
+}

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

@@ -0,0 +1,20 @@
+import './actor';
+import './card-config';
+import './cards-config';
+import './combat-config';
+import './combatant-config';
+import './effect-config';
+import './folder-config';
+import './grid-config';
+import './image-popout';
+import './item';
+import './journal-sheet';
+import './macro-config';
+import './measure-template';
+import './permission';
+import './playlist-config';
+import './playlist-sound-config';
+import './roll-table-config';
+import './scene-config';
+import './sheet-config';
+import './user-config';

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts → client/apps/forms/item.d.ts}

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -26,18 +26,17 @@ declare global {
      *   resizable: true,
      *   baseApplication: "ItemSheet",
      *   id: "item"
+     * })
      * ```
      */
     static get defaultOptions(): ItemSheet.Options;
 
-    /** @override */
-    get id(): string;
+    override get id(): string;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
     /**
-     * A convenience reference to the Item entity
+     * A convenience reference to the Item document
      */
     get item(): this['object'];
 
@@ -47,29 +46,13 @@ declare global {
      */
     get actor(): this['item']['actor'];
 
-    /**
-     * @param options - (unused)
-     * @override
-     *
-     * @remarks The implementation in {@link ItemSheet} doesn't return a
-     * `Promise` but the return type includes it to allow extending classes to
-     * do that.
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    /** @override */
-    protected _getHeaderButtons(): Application.HeaderButton[];
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
-
-    /**
-     * Handle requests to configure the default sheet used by this Item
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle changing the item image
+     * @internal
      */
     protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
   }

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/journalSheet.d.ts → client/apps/forms/journal-sheet.d.ts}

@@ -1,13 +1,18 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+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> {
     /**
@@ -31,7 +36,6 @@ declare global {
     protected _textPos: Application.Position | null;
 
     /**
-     * @override
      * @defaultValue
      * ```ts
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -41,17 +45,15 @@ 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 override get defaultOptions(): JournalSheetOptions;
 
-    /** @override */
-    get template(): string;
+    override get template(): string;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
     /**
      * Guess the default view mode for the sheet based on the player's permissions to the Entry
@@ -59,23 +61,13 @@ declare global {
      */
     protected _inferDefaultMode(): JournalSheet.SheetMode | null;
 
-    /**@override */
-    protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _getHeaderButtons(): Application.HeaderButton[];
+    protected override _getHeaderButtons(): Application.HeaderButton[];
 
-    /** @override */
-    getData(options?: Partial<Options>): Promise<Data> | Data;
+    override getData(options?: Partial<Options>): Promise<Data> | Data;
 
-    /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: JournalSheet.FormData
-    ): ReturnType<DocumentSheet<Options, Data>['_updateObject']>;
+    protected override _updateObject(event: Event, formData: JournalSheet.FormData): Promise<unknown>;
 
     /**
      * Handle requests to switch the rendered mode of the Journal Entry sheet
@@ -96,11 +88,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 → client/apps/forms/macro-config.d.ts}

@@ -1,10 +1,9 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 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.
    */
@@ -13,7 +12,6 @@ declare global {
     Data extends object = MacroConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Macro>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -25,16 +23,15 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): MacroConfig.Options;
+    static override get defaultOptions(): MacroConfig.Options;
 
-    /** @override */
-    get id(): string;
+    override get id(): string;
 
-    /** @override */
-    getData(options?: Partial<Options>): Data;
+    override getData(options?: Partial<Options>): Data;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
+
+    protected override _disableFields(form: HTMLElement): void;
 
     /**
      * Handle changing the actor profile image by opening a FilePicker
@@ -49,11 +46,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 override _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
   }
 
   namespace MacroConfig {

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts → client/apps/forms/measure-template.d.ts}

@@ -1,9 +1,8 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 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.
    */
@@ -12,28 +11,22 @@ declare global {
     Data extends object = MeasuredTemplateConfig.Data
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * 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,
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    getData(): Data | Promise<Data>;
+    override getData(): Data | Promise<Data>;
 
-    /** @override */
-    protected _updateObject(
-      event: Event,
-      formData: MeasuredTemplateConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>> | undefined>;
+    protected override _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
   }
 
   namespace MeasuredTemplateConfig {