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

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

@@ -1,12 +1,24 @@
 /**
  * Audio/Video Conferencing Configuration Sheet
+ *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data, AVMaster> {
+declare class AVConfig<
+  Options extends FormApplicationOptions = FormApplicationOptions,
+  Data extends object = AVConfig.Data
+> extends FormApplication<Options, Data, AVMaster> {
+  /**
+   * @param object  - The {@link AVMaster} instance being configured.
+   * @param options - Application configuration options.
+   */
+  constructor(object?: AVMaster | undefined, options?: Partial<Options> | undefined);
+
   /** @override */
-  static get defaultOptions(): AVConfig.Options;
+  static get defaultOptions(): FormApplicationOptions;
 
   /** @override */
-  getData(options: Partial<AVConfig.Options>): Promise<AVConfig.Data>;
+  getData(options: Partial<Options>): Promise<Data>;
 
   /** @override */
   activateListeners(html: JQuery): void;
@@ -16,6 +28,7 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * @param selector - Selector for the section to enable or disable
    * @param enabled  - Whether to enable or disable this section
    *                   (default: true)
+   * @internal
    */
   protected _setConfigSectionEnabled(selector: string, enabled?: boolean): void;
 
@@ -24,75 +37,23 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * unavailable since the last time it was set.
    * @param sources - The available devices
    * @param source  - The selected device
+   * @internal
    */
   protected _isSourceUnavailable(sources: Record<string, string>, source: string): boolean;
 
-  /**
-   * Callback when the server type changes
-   * Will enable or disable the server section based on whether the user selected a custom server or not
-   * @param event - The event that triggered the server type change
-   */
-  protected _onServerTypeChanged(event: JQuery.ChangeEvent): void;
-
   /**
    * Callback when the turn server type changes
    * Will enable or disable the turn section based on whether the user selected a custom turn or not
    * @param event - The event that triggered the turn server type change
+   * @internal
    */
   protected _onTurnTypeChanged(event: JQuery.ChangeEvent): void;
 
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute key
-   */
-  protected _onPTTKeyDown(event: JQuery.KeyDownEvent): void;
-
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute mouse key
-   */
-  protected _onPTTMouseDown(event: JQuery.MouseDownEvent): void;
-
   /** @override */
-  protected _updateObject(event: Event, formData?: object): Promise<void>;
+  protected _updateObject(event: Event, formData?: object): Promise<unknown>;
 }
 
 declare namespace AVConfig {
-  interface Options extends FormApplicationOptions {
-    /**
-     * @defaultValue `game.i18n.localize('WEBRTC.Title')`
-     */
-    title: string;
-
-    /**
-     * @defaultValue `'av-config'`
-     */
-    id: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/apps/av-config.html'`
-     */
-    template: string;
-
-    /**
-     * @defaultValue `true`
-     */
-    popOut: boolean;
-
-    /**
-     * @defaultValue `480`
-     */
-    width: number;
-
-    /**
-     * @defaultValue `'auto'`
-     */
-    height: number | 'auto';
-
-    /**
-     * @defaultValue `[{navSelector: '.tabs', contentSelector: 'form', initial: 'general'}]`
-     */
-    tabs: (TabsConfiguration & { contentSelector: string; initial: string })[];
-  }
-
   interface Data {
     user: Game['user'];
     modes: {

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

@@ -8,6 +8,7 @@ declare class CombatTrackerConfig<
   Data extends object = CombatTrackerConfig.Data
 > extends FormApplication<Options, Data, undefined> {
   /**
+   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -25,10 +26,7 @@ declare class CombatTrackerConfig<
   getData(options?: Partial<Options>): Data | Promise<Data>;
 
   /** @override */
-  protected _updateObject(
-    event: Event,
-    formData: ClientSettings.Values['core.combatTrackerConfig']
-  ): Promise<ClientSettings.Values['core.combatTrackerConfig']>;
+  protected _updateObject(event: Event, formData: ClientSettings.Values['core.combatTrackerConfig']): Promise<unknown>;
 }
 
 declare namespace CombatTrackerConfig {

package/src/foundry/foundry.js/applications/formApplications/{entitySheetConfig.d.ts → documentSheetConfig.d.ts}

@@ -1,16 +1,16 @@
-import type { DocumentConstructor } from '../../../../types/helperTypes';
+import type { DocumentConstructor, DocumentType } from '../../../../types/helperTypes';
 
 declare global {
   /**
-   * Entity Sheet Configuration Application
+   * 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 EntitySheetConfig<
+  class DocumentSheetConfig<
     Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = EntitySheetConfig.Data<foundry.abstract.Document<any, any>, Options>,
-    ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends EntitySheetConfig.Data<infer T>
+    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> {
@@ -18,9 +18,9 @@ declare global {
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "sheet-config",
+     *   classes: ["form", "sheet-config"],
      *   template: "templates/sheets/sheet-config.html",
-     *   width: 400,
+     *   width: 400
      * })
      * ```
      */
@@ -30,7 +30,7 @@ declare global {
      * An array of pending sheet assignments which are submitted before other elements of the framework are ready.
      * @internal
      */
-    static _pending: Array<EntitySheetConfig.SheetAssignment>;
+    protected static _pending: Array<DocumentSheetConfig.SheetAssignment>;
 
     /** @override */
     get title(): string;
@@ -39,11 +39,11 @@ declare global {
     getData(options?: Partial<Options>): Data | Promise<Data>;
 
     /** @override */
-    protected _updateObject(event: Event, formData: EntitySheetConfig.FormData): Promise<void>;
+    protected _updateObject(event: Event, formData: DocumentSheetConfig.FormData): Promise<unknown>;
 
     /**
-     * Initialize the configured Sheet preferences for Entities which support dynamic Sheet assignment
-     * Create the configuration structure for supported entities
+     * 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
      */
@@ -55,7 +55,7 @@ declare global {
     protected static _getDocumentTypes(cls: DocumentConstructor, types?: string[]): string[];
 
     /**
-     * Register a sheet class as a candidate which can be used to display entities of a given type
+     * 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
@@ -65,7 +65,7 @@ declare global {
       documentClass: DocumentConstructor,
       scope: string,
       sheetClass: ConstructorOf<FormApplication<FormApplicationOptions, any, any>>,
-      { label, types, makeDefault }?: EntitySheetConfig.RegisterSheetOptions
+      { label, types, makeDefault }?: DocumentSheetConfig.RegisterSheetOptions | undefined
     ): void;
 
     /**
@@ -79,7 +79,7 @@ declare global {
       sheetClass,
       types,
       makeDefault
-    }: Omit<EntitySheetConfig.SheetRegistration, 'action'>): void;
+    }: Omit<DocumentSheetConfig.SheetRegistration, 'action'>): void;
 
     /**
      * Unregister a sheet class, removing it from the list of available Applications to use for a Document type
@@ -103,15 +103,21 @@ declare global {
       documentClass,
       id,
       types
-    }: Omit<EntitySheetConfig.SheetUnregistration, 'action'>): void;
+    }: Omit<DocumentSheetConfig.SheetUnregistration, 'action'>): void;
 
     /**
      * Update the currently default Sheets using a new core world setting
      */
-    static updateDefaultSheets(setting?: Record<'Actor' | 'Item', Record<string, string>>): void;
+    static updateDefaultSheets(setting?: Record<DocumentType, Record<string, string>>): void;
+
+    /**
+     * Initialize default sheet configurations for all document types.
+     * @internal
+     */
+    protected static _registerDefaultSheets(): void;
   }
 
-  namespace EntitySheetConfig {
+  namespace DocumentSheetConfig {
     type SheetRegistration = {
       action: 'register';
       documentClass: DocumentConstructor;
@@ -140,7 +146,7 @@ declare global {
       Options extends FormApplicationOptions = FormApplicationOptions
     > {
       isGM: boolean;
-      object: foundry.utils.Duplicated<ConcreteDocument['data']>;
+      object: ConcreteDocument['data']['_source'];
       options: Options;
       sheetClass: string;
       sheetClasses: Record<string, string>;
@@ -157,7 +163,7 @@ declare global {
       /** A human readable label for the sheet name, which will be localized */
       label?: string;
 
-      /** An array of entity types for which this sheet should be used */
+      /** An array of document types for which this sheet should be used */
       types?: string[];
 
       /**
@@ -167,4 +173,15 @@ declare global {
       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/foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts

@@ -58,10 +58,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: AmbientLightConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>> | undefined>;
+    protected _updateObject(event: Event, formData: AmbientLightConfig.FormData): Promise<unknown>;
 
     /**
      * Refresh the display of the AmbientLight object

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

@@ -34,10 +34,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: AmbientSoundConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>>;
+    protected _updateObject(event: Event, formData: AmbientSoundConfig.FormData): Promise<unknown>;
 
     /** @override */
     close(options?: Application.CloseOptions): Promise<void>;
@@ -47,6 +44,7 @@ declare global {
     interface Data<Options extends DocumentSheetOptions>
       extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>, Options> {
       submitText: string;
+      gridUnits: string;
     }
 
     type FormData = Pick<foundry.data.AmbientSoundData, 'easing' | 'path' | 'volume'> &

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

@@ -0,0 +1,51 @@
+import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../../types/helperTypes.js';
+import type { CardFaceData } from '../../../../common/data/module.mjs.js';
+
+declare global {
+  /**
+   * A DocumentSheet application responsible for displaying and editing a single embedded Card document.
+   *
+   * @typeParam Options - The type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
+   */
+  class CardConfig<
+    Options extends DocumentSheetOptions = DocumentSheetOptions,
+    Data extends CardConfig.Data<Options> = CardConfig.Data<Options>
+  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Card'>>> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   classes: ["sheet", "card-config"],
+     *   template: "templates/cards/card-config.html",
+     *   width: 480,
+     *   height: "auto",
+     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "details"}]
+     * })
+     * ```
+     */
+    static override get defaultOptions(): DocumentSheetOptions;
+
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
+
+    override activateListeners(html: JQuery): void;
+
+    protected override _getSubmitData(
+      updateData?: object | null
+    ): Record<string, unknown> & { faces: ConstructorDataType<CardFaceData>[] };
+
+    /**
+     * Handle card face control actions which modify single cards on the sheet.
+     * @param event - The originating click event
+     * @returns A Promise which resolves once the handler has completed
+     */
+    protected _onFaceControl(event: JQuery.ClickEvent): Promise<void>;
+  }
+
+  namespace CardConfig {
+    interface Data<Options extends DocumentSheetOptions>
+      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Card'>>, Options> {
+      types: Record<string, string>;
+    }
+  }
+}

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

@@ -0,0 +1,88 @@
+import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes.js';
+
+declare global {
+  /**
+   * A DocumentSheet application responsible for displaying and editing a single Cards stack.
+   *
+   * @typeParam Options - The type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
+   */
+  class CardsConfig<
+    Options extends DocumentSheetOptions = DocumentSheetOptions,
+    Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
+  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Cards'>>> {
+    constructor(object: ConfiguredDocumentClassForName<'Cards'>, options: Options);
+
+    /**
+     * The sorting mode used to display the sheet, "standard" if true, otherwise "shuffled"
+     * @internal
+     * @defaultValue `false`
+     */
+    protected _sortStandard: boolean;
+
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   classes: ["sheet", "cards-config"],
+     *   template: "templates/cards/cards-deck.html",
+     *   width: 620,
+     *   height: "auto",
+     *   closeOnSubmit: false,
+     *   viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.OBSERVER,
+     *   dragDrop: [{dragSelector: "ol.cards li.card", dropSelector: "ol.cards"}],
+     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "cards"}],
+     *   scrollY: ["ol.cards"]
+     * })
+     * ```
+     */
+    static override get defaultOptions(): DocumentSheetOptions;
+
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
+
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * Handle card control actions which modify single cards on the sheet.
+     * @param event - The originating click event
+     * @returns A Promise which resolves once the handler has completed
+     */
+    protected _onCardControl(event: JQuery.ClickEvent): Promise<void>;
+
+    /**
+     * Handle lazy-loading card face images.
+     * See {@link SidebarTab#_onLazyLoadImage}
+     */
+    protected _onLazyLoadImage(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void;
+
+    /** @param selector - (unused) */
+    protected override _canDragStart(selector: string): boolean;
+
+    protected override _onDragStart(event: DragEvent): void;
+
+    /** @param selector - (unused) */
+    protected override _canDragDrop(selector: string): boolean;
+
+    protected override _onDrop(event: DragEvent): void;
+
+    /**
+     * Handle sorting a Card relative to other siblings within this document
+     * @param event - The drag drop event
+     * @param card  - The card being dragged
+     * @internal
+     */
+    protected _onSortCard(
+      event: DragEvent,
+      card: InstanceType<ConfiguredDocumentClassForName<'Card'>>
+    ): ReturnType<InstanceType<ConfiguredDocumentClassForName<'Cards'>>['updateEmbeddedDocuments']>;
+  }
+
+  namespace CardsConfig {
+    interface Data<Options extends DocumentSheetOptions>
+      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Cards'>>, Options> {
+      cards: InstanceType<ConfiguredDocumentClassForName<'Card'>>[];
+      types: Record<string, string>;
+      inCompendium: boolean;
+    }
+  }
+}

package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsHand.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "hand" type.
+ *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ */
+declare class CardsHand<
+  Options extends DocumentSheetOptions = DocumentSheetOptions,
+  Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
+> extends CardsConfig<Options, Data> {
+  /**
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   template: "templates/cards/cards-hand.html"
+   * })
+   * ```
+   */
+  static override get defaultOptions(): DocumentSheetOptions;
+}

package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsPile.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "pile" type.
+ *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
+ */
+declare class CardsPile<
+  Options extends DocumentSheetOptions = DocumentSheetOptions,
+  Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
+> extends CardsConfig<Options, Data> {
+  /**
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   template: "templates/cards/cards-pile.html"
+   * })
+   * ```
+   */
+  static override get defaultOptions(): DocumentSheetOptions;
+}

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

@@ -0,0 +1,2 @@
+import './cardsHand';
+import './cardsPile';

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

@@ -12,6 +12,7 @@ declare global {
     Data extends CombatantConfig.Data<Options> = CombatantConfig.Data<Options>
   > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Combatant>>> {
     /**
+     * @override
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -32,10 +33,7 @@ declare global {
      * @param event - (unused)
      * @override
      */
-    protected _updateObject(
-      event: Event,
-      formData: CombatantConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Combatant>> | undefined>;
+    protected _updateObject(event: Event, formData: CombatantConfig.FormData): Promise<unknown>;
   }
 
   namespace CombatantConfig {

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

@@ -4,12 +4,14 @@ 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 extends DocumentSheet<
-    DocumentSheetOptions,
-    FolderConfig.Data,
-    InstanceType<ConfiguredDocumentClass<typeof Folder>>
-  > {
+  class FolderConfig<
+    Options extends FolderConfig.Options = FolderConfig.Options,
+    Data extends object = FolderConfig.Data
+  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Folder>>> {
     /**
      * @override
      * @defaultValue
@@ -21,7 +23,7 @@ declare global {
      * })
      * ```
      */
-    static get defaultOptions(): typeof DocumentSheet['defaultOptions'];
+    static get defaultOptions(): DocumentSheetOptions;
 
     /** @override */
     get id(): string;
@@ -29,24 +31,28 @@ declare global {
     /** @override */
     get title(): string;
 
+    /** @override */
+    close(options?: Application.CloseOptions | undefined): Promise<void>;
+
     /**
      * @param options - (unused)
      * @override
      */
-    getData(options?: Partial<FormApplicationOptions>): Promise<FolderConfig.Data>;
+    getData(options?: Partial<Options>): Promise<Data>;
 
     /**
      * @param event - (unused)
      * @override
      * @internal
      */
-    protected _updateObject(
-      event: Event,
-      formData: FolderConfig.FormData
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Folder>> | undefined>;
+    protected _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;

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

@@ -2,6 +2,9 @@ import './activeEffectConfig';
 import './actorSheet';
 import './ambientLightConfig';
 import './ambientSoundConfig';
+import './cardConfig';
+import './cardsConfig';
+import './cardsConfigs';
 import './combatantConfig';
 import './folderConfig';
 import './itemSheet';

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

@@ -26,6 +26,7 @@ declare global {
      *   resizable: true,
      *   baseApplication: "ItemSheet",
      *   id: "item"
+     * })
      * ```
      */
     static get defaultOptions(): ItemSheet.Options;
@@ -37,7 +38,7 @@ declare global {
     get title(): string;
 
     /**
-     * A convenience reference to the Item entity
+     * A convenience reference to the Item document
      */
     get item(): this['object'];
 
@@ -57,19 +58,12 @@ declare global {
      */
     getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    protected _getHeaderButtons(): Application.HeaderButton[];
-
     /** @override */
     activateListeners(html: JQuery): void;
 
-    /**
-     * Handle requests to configure the default sheet used by this Item
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
     /**
      * Handle changing the item image
+     * @internal
      */
     protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
   }