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

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

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import type { SortingModes } from '../../../../common/data/data.mjs/folderData';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { SortingModes } from '../../../common/data/data.mjs/folderData';
 
 declare global {
   /**
@@ -13,7 +13,6 @@ declare global {
     Data extends object = FolderConfig.Data
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Folder>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -23,29 +22,17 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get id(): string;
+    override get id(): string;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    close(options?: Application.CloseOptions | undefined): Promise<void>;
+    override close(options?: Application.CloseOptions | undefined): Promise<void>;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    getData(options?: Partial<Options>): Promise<Data>;
+    override getData(options?: Partial<Options>): Promise<Data>;
 
-    /**
-     * @param event - (unused)
-     * @override
-     * @internal
-     */
-    protected _updateObject(event: Event, formData: FolderConfig.FormData): Promise<unknown>;
+    protected override _updateObject(event: Event, formData: FolderConfig.FormData): Promise<unknown>;
   }
 
   namespace FolderConfig {

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,22 +56,15 @@ 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 keyboard events.
@@ -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): Promise<unknown>;
+    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 {
   /**
@@ -31,11 +31,9 @@ declare global {
      */
     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 document
@@ -48,18 +46,9 @@ 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 getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle changing the item image

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   interface JournalSheetOptions extends DocumentSheetOptions {
@@ -36,7 +36,6 @@ declare global {
     protected _textPos: Application.Position | null;
 
     /**
-     * @override
      * @defaultValue
      * ```ts
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -50,13 +49,11 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): JournalSheetOptions;
+    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
@@ -64,20 +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): Promise<unknown>;
+    protected override _updateObject(event: Event, formData: JournalSheet.FormData): Promise<unknown>;
 
     /**
      * Handle requests to switch the rendered mode of the Journal Entry sheet

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -12,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, {
@@ -24,19 +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;
 
-    /** @override */
-    protected _disableFields(form: HTMLElement): void;
+    protected override _disableFields(form: HTMLElement): void;
 
     /**
      * Handle changing the actor profile image by opening a FilePicker
@@ -51,8 +46,7 @@ declare global {
      */
     protected _onExecute(event: JQuery.ClickEvent): Promise<void>;
 
-    /** @override */
-    protected _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
+    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,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -11,7 +11,6 @@ declare global {
     Data extends object = MeasuredTemplateConfig.Data
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -23,13 +22,11 @@ declare global {
      * })
      * ```
      */
-    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<unknown>;
+    protected override _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
   }
 
   namespace MeasuredTemplateConfig {

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -15,7 +15,6 @@ declare global {
       : foundry.abstract.Document<any, any>
   > extends DocumentSheet<Options, PermissionControl.Data, ConcreteDocument> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -25,16 +24,13 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /** @override */
-    getData(options?: Partial<Options> | undefined): PermissionControl.Data | Promise<PermissionControl.Data>;
+    override getData(options?: Partial<Options> | undefined): PermissionControl.Data | Promise<PermissionControl.Data>;
 
-    /** @override */
-    protected _updateObject(event: Event, formData: PermissionControl.FormData): Promise<unknown>;
+    protected override _updateObject(event: Event, formData: PermissionControl.FormData): Promise<unknown>;
   }
 
   namespace PermissionControl {

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

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -21,23 +21,16 @@ declare global {
      */
     static get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @override
-     * @param options - (unused)
-     */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
+    protected override _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
 
     /**
-     * @override
      * @remarks The return type could be given more concretely but it is not supposed to be used.
      */
-    protected _onSelectFile(selection: string, filePicker: FilePicker): unknown;
+    protected override _onSelectFile(selection: string, filePicker: FilePicker): unknown;
   }
 
   namespace PlaylistConfig {

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts → client/apps/forms/playlist-sound-config.d.ts}

@@ -1,4 +1,4 @@
-import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -14,7 +14,6 @@ declare global {
     Data extends object = PlaylistSoundConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -24,19 +23,13 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /** @override */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @override
-     * @param options - (unused)
-     */
-    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;
 
     /**
      * Auto-populate the track name using the provided filename, if a name is not already set
@@ -44,11 +37,7 @@ declare global {
      */
     protected _onSourceChange(event: JQuery.ChangeEvent): void;
 
-    /**
-     * @override
-     * @param event - (unused)
-     */
-    protected _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<unknown>;
+    protected override _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<unknown>;
   }
 
   namespace PlaylistSoundConfig {

package/src/foundry/{foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts → client/apps/forms/roll-table-config.d.ts}

@@ -1,5 +1,5 @@
-import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../../../types/helperTypes';
-import type { TableResultDataConstructorData } from '../../../../common/data/data.mjs/tableResultData';
+import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../../types/helperTypes';
+import type { TableResultDataConstructorData } from '../../../common/data/data.mjs/tableResultData';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = RollTableConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'RollTable'>>> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -27,23 +26,13 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static override get defaultOptions(): DocumentSheetOptions;
 
-    /**
-     * @override
-     */
-    get title(): string;
+    override get title(): string;
 
-    /**
-     * @param options - (unused)
-     * @override
-     */
-    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;
 
     /**
      * Handle creating a TableResult in the RollTable document
@@ -72,11 +61,7 @@ declare global {
       event: JQuery.ClickEvent
     ): Promise<InstanceType<ConfiguredDocumentClassForName<'TableResult'>> | undefined>;
 
-    /**
-     * @override
-     * @internal
-     */
-    protected _onDrop(event: DragEvent): void;
+    protected override _onDrop(event: DragEvent): void;
 
     /**
      * Handle changing the actor profile image by opening a FilePicker