@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

package/src/foundry/client/apps/form.d.mts

@@ -1,46 +1,12 @@
 import type { EditorView } from "prosemirror-view";
 import type { Editor } from "tinymce";
-import type { AnyObject, GetDataReturnType, InexactPartial, MaybePromise } from "../../../types/utils.d.mts";
+import type { AnyObject, GetDataReturnType, MaybePromise, Identity } from "#utils";
 import type { ProseMirrorKeyMaps, ProseMirrorMenu } from "../../common/prosemirror/_module.d.mts";
 import type Document from "../../common/abstract/document.d.mts";
 
 declare global {
-  interface FormApplicationOptions extends ApplicationOptions {
-    /**
-     * Whether to automatically close the application when it's contained
-     * form is submitted.
-     * @defaultValue `true`
-     */
-    closeOnSubmit: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when an input
-     * or select element is changed.
-     * @defaultValue `false`
-     */
-    submitOnChange: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when the
-     * application window is manually closed.
-     * @defaultValue `false`
-     */
-    submitOnClose: boolean;
-
-    /**
-     * Whether the application form is editable - if true, it's fields will
-     * be unlocked and the form can be submitted. If false, all form fields
-     * will be disabled and the form cannot be submitted.
-     * @defaultValue `true`
-     */
-    editable: boolean;
-
-    /**
-     * Support configuration of the sheet type used for this application.
-     * @defaultValue `false`
-     */
-    sheetConfig: boolean;
-  }
+  /** @deprecated {@link FormApplication.Options | `FormApplication.Options`} */
+  type FormApplicationOptions = FormApplication.Options;
 
   /**
    * An abstract pattern for defining an Application responsible for updating some object using an HTML form
@@ -51,24 +17,24 @@ declare global {
    * 3) This abstract layer has no knowledge of what is being updated, so the implementation must define _updateObject
    *
    * @typeParam Options        - the type of the options object
-   * @typeParam ConcreteObject - the type of the object or {@link foundry.abstract.Document} which is modified by this form
+   * @typeParam ConcreteObject - while this is called object this can actually be any arbitrary value.
+   * For example `ImagePopout` sets this to a string. This is still typically a
+   * {@link Document | `Document`} instance or an object in general which is modified by this form
    */
   abstract class FormApplication<
-    Options extends FormApplicationOptions = FormApplicationOptions,
+    // TODO(LukeAbby): The generic parameters here will be swapped.
+    Options extends FormApplication.Options = FormApplication.Options,
     ConcreteObject = unknown,
   > extends Application<Options> {
     /**
      * @param object  - Some object or entity which is the target to be updated.
+     *                  (default: `{}`)
+     *
      * @param options - Additional options which modify the rendering of the sheet.
      *                  (default: `{}`)
      * @remarks Foundry allows passing no value to the constructor at all.
      */
-    constructor(object: ConcreteObject, options?: Partial<Options>);
-    constructor(
-      ...args: ConcreteObject extends undefined
-        ? [ConcreteObject?, Partial<Options>?]
-        : [ConcreteObject, Partial<Options>?]
-    );
+    constructor(...args: FormApplication.ConstructorArguments<ConcreteObject, Options>);
 
     /**
      * The object target which we are using this form to modify
@@ -96,7 +62,7 @@ declare global {
     /**
      * Assign the default options which are supported by the entity edit sheet.
      * @returns The default options for this FormApplication class
-     * @see {@link Application.defaultOptions}
+     * @see {@link Application.defaultOptions | `Application.defaultOptions`}
      * @defaultValue
      * ```typescript
      * foundry.utils.mergeObject(super.defaultOptions, {
@@ -109,7 +75,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplication.Options;
 
     /**
      * Is the Form Application currently editable?
@@ -194,7 +160,7 @@ declare global {
     /**
      * Activate a named TinyMCE text editor
      * @param name           - The named data field which the editor modifies.
-     * @param options        - Editor initialization options passed to {@link TextEditor.create}.
+     * @param options        - Editor initialization options passed to {@link TextEditor.create | `TextEditor.create`}.
      *                         (default: `{}`)
      * @param initialContent - Initial text content for the editor area.
      *                         (default: `""`)
@@ -209,21 +175,7 @@ declare global {
      * Handle saving the content of a specific editor by name
      * @param name - The named editor to save
      */
-    saveEditor(
-      name: string,
-      options?: InexactPartial<{
-        /**
-         * Remove the editor after saving its content
-         * @defaultValue `true`
-         */
-        remove: boolean;
-
-        /**
-         * Prevent normal re-rendering of the sheet after saving.
-         */
-        preventRender: boolean;
-      }>,
-    ): Promise<void>;
+    saveEditor(name: string, options?: FormApplication.SaveEditorOptions): Promise<void>;
 
     /**
      * Activate an editor instance present within the form
@@ -273,7 +225,7 @@ declare global {
     /**
      * @deprecated since v12, will be removed in v14
      */
-    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
+    protected _getFilePickerOptions(event: PointerEvent): FilePicker.Options;
 
     /**
      * @deprecated since v12, will be removed in v14
@@ -282,9 +234,60 @@ declare global {
   }
 
   namespace FormApplication {
-    type Any = FormApplication<any, any>;
+    interface Any extends AnyFormApplication {}
+    interface AnyConstructor extends Identity<typeof AnyFormApplication> {}
+
+    type ConstructorArguments<ConcreteObject, Options extends FormApplication.Options> =
+      // Note(LukeAbby): Uses a strict equality test to avoid `object` and `{}` counting as the same.
+      // See {@link HandleEmptyObject | `HandleEmptyObject`} for more information.
+      (<T>() => T extends FormApplication.NoObject ? 1 : 0) extends <T>() => T extends ConcreteObject ? 1 : 0
+        ? [object?: ConcreteObject, options?: Partial<Options>]
+        : [ConcreteObject] extends [undefined]
+          ? [object?: ConcreteObject, options?: Partial<Options>]
+          : [object: ConcreteObject, options?: Partial<Options>];
+
+    /**
+     * The type for when a form application has no object. Equivalent to `{}` but more semantically appropriate.
+     */
+    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-object-type
+    type NoObject = {};
+
+    interface Options extends Application.Options {
+      /**
+       * Whether to automatically close the application when it's contained
+       * form is submitted.
+       * @defaultValue `true`
+       */
+      closeOnSubmit: boolean;
+
+      /**
+       * Whether to automatically submit the contained HTML form when an input
+       * or select element is changed.
+       * @defaultValue `false`
+       */
+      submitOnChange: boolean;
+
+      /**
+       * Whether to automatically submit the contained HTML form when the
+       * application window is manually closed.
+       * @defaultValue `false`
+       */
+      submitOnClose: boolean;
+
+      /**
+       * Whether the application form is editable - if true, it's fields will
+       * be unlocked and the form can be submitted. If false, all form fields
+       * will be disabled and the form cannot be submitted.
+       * @defaultValue `true`
+       */
+      editable: boolean;
 
-    type AnyConstructor = typeof AnyFormApplication;
+      /**
+       * Support configuration of the sheet type used for this application.
+       * @defaultValue `false`
+       */
+      sheetConfig: boolean;
+    }
 
     interface CloseOptions extends Application.CloseOptions {
       submit?: boolean;
@@ -325,28 +328,34 @@ declare global {
     }
 
     interface FormApplicationData<
-      Options extends FormApplicationOptions = FormApplicationOptions,
+      Options extends FormApplication.Options = FormApplication.Options,
       ConcreteObject = unknown,
     > {
       object: ConcreteObject;
       options: Options;
       title: string;
     }
-  }
 
-  interface DocumentSheetOptions<
-    ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
-  > extends FormApplicationOptions {
-    /**
-     * The default permissions required to view this Document sheet.
-     * @defaultValue {@link CONST.DOCUMENT_OWNERSHIP_LEVELS.LIMITED}
-     */
-    viewPermission: foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
+    interface SaveEditorOptions {
+      /**
+       * Remove the editor after saving its content
+       * @defaultValue `true`
+       */
+      remove?: boolean | undefined;
 
-    /** An array of {@link HTMLSecret} configuration objects. */
-    secrets: HTMLSecretConfiguration<ConcreteDocument>[];
+      /**
+       * Prevent normal re-rendering of the sheet after saving.
+       */
+      preventRender?: boolean | undefined;
+    }
   }
 
+  /**
+   * @deprecated {@link DocumentSheet.Options | `DocumentSheet.Options`}
+   */
+  type DocumentSheetOptions<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any> =
+    DocumentSheet.Options<ConcreteDocument>;
+
   /**
    * Extend the FormApplication pattern to incorporate specific logic for viewing or editing Document instances.
    * See the FormApplication documentation for more complete description of this interface.
@@ -355,16 +364,15 @@ declare global {
    * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
    */
   abstract class DocumentSheet<
-    Options extends DocumentSheetOptions<ConcreteDocument>,
+    Options extends DocumentSheet.Options<ConcreteDocument>,
     ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
   > extends FormApplication<Options, ConcreteDocument> {
     /**
      * @param object  - A Document instance which should be managed by this form.
-     *                  (default: `{}`)
      * @param options - Optional configuration parameters for how the form behaves.
      *                  (default: `{}`)
      */
-    constructor(object?: ConcreteDocument, options?: Partial<Options>);
+    constructor(object: ConcreteDocument, options?: Partial<Options>);
 
     /** The list of handlers for secret block functionality. */
     protected _secrets: HTMLSecret<ConcreteDocument>[];
@@ -381,7 +389,7 @@ declare global {
      * });
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions;
+    static get defaultOptions(): DocumentSheet.Options;
 
     /**
      * A semantic convenience reference to the Document instance which is the target object for this form.
@@ -422,7 +430,7 @@ declare global {
      * @param user - The user requesting to render the sheet
      * @returns Does the User have permission to view this sheet?
      */
-    protected _canUserView(user: User): boolean;
+    protected _canUserView(user: User.Implementation): boolean;
 
     /**
      * Create objects for managing the functionality of secret blocks within this Document's content.
@@ -461,10 +469,11 @@ declare global {
   }
 
   namespace DocumentSheet {
-    type Any = DocumentSheet<any, any>;
+    interface Any extends AnyDocumentSheet {}
+    interface AnyConstructor extends Identity<typeof AnyDocumentSheet> {}
 
     interface DocumentSheetData<
-      Options extends DocumentSheetOptions<ConcreteDocument>,
+      Options extends DocumentSheet.Options<ConcreteDocument>,
       ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
     > extends FormApplication.FormApplicationData {
       cssClass: string;
@@ -476,9 +485,28 @@ declare global {
       title: DocumentSheet<Options, ConcreteDocument>["title"];
       document: DocumentSheet<Options, ConcreteDocument>["document"];
     }
+
+    interface Options<ConcreteDocument extends Document.Internal.Instance.Any = Document.Internal.Instance.Any>
+      extends FormApplication.Options {
+      /**
+       * The default permissions required to view this Document sheet.
+       * @defaultValue {@link CONST.DOCUMENT_OWNERSHIP_LEVELS.LIMITED | `CONST.DOCUMENT_OWNERSHIP_LEVELS.LIMITED`}
+       */
+      viewPermission: foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
+
+      /** An array of {@link HTMLSecret | `HTMLSecret`} configuration objects. */
+      secrets: HTMLSecret.Configuration<ConcreteDocument>[];
+    }
   }
 }
 
 declare abstract class AnyFormApplication extends FormApplication<any, any> {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
+}
+
+declare abstract class AnyDocumentSheet extends DocumentSheet<
+  DocumentSheet.Options<foundry.abstract.Document.Any>,
+  foundry.abstract.Document.Any
+> {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/forms/actor.d.mts

@@ -1,5 +1,5 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
-import type { DropData as ClientDocumentMixinDropData } from "../../data/abstract/client-document.d.mts";
+import type { GetDataReturnType, MaybePromise, Identity } from "#utils";
+import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
   /**
@@ -12,7 +12,7 @@ declare global {
    */
   class ActorSheet<Options extends ActorSheet.Options = ActorSheet.Options> extends DocumentSheet<
     Options,
-    Actor.ConfiguredInstance
+    Actor.Implementation
   > {
     /**
      * @defaultValue
@@ -114,12 +114,17 @@ declare global {
      * This method is factored out to allow downstream classes the opportunity to override item creation behavior.
      * @param itemData - The item data requested for creation
      */
-    protected _onDropItemCreate(itemData: Item["_source"][] | Item["_source"]): Promise<Item.ConfiguredInstance[]>;
+    protected _onDropItemCreate(
+      itemData: Item.Implementation["_source"][] | Item.Implementation["_source"],
+    ): Promise<Item.Implementation[]>;
 
     /**
      * Handle a drop event for an existing embedded Item to sort that Item relative to its siblings
      */
-    protected _onSortItem(event: DragEvent, itemData: Item["_source"]): undefined | Promise<Item.ConfiguredInstance[]>;
+    protected _onSortItem(
+      event: DragEvent,
+      itemData: Item.Implementation["_source"],
+    ): undefined | Promise<Item.Implementation[]>;
 
     /**
      * Is the drop data coming from the same actor?
@@ -130,7 +135,8 @@ declare global {
   }
 
   namespace ActorSheet {
-    type Any = ActorSheet<any>;
+    interface Any extends AnyActorSheet {}
+    interface AnyConstructor extends Identity<typeof AnyActorSheet> {}
 
     type DropData =
       | DropData.ActiveEffect
@@ -151,9 +157,9 @@ declare global {
         type: "Actor";
       }
 
-      type Item = ClientDocumentMixinDropData<Item.ConfiguredInstance> & {
+      interface Item extends Document.DropData<Item.Implementation> {
         type: "Item";
-      };
+      }
 
       interface Folder {
         type: "Folder";
@@ -162,15 +168,19 @@ declare global {
       }
     }
 
-    interface Options extends DocumentSheetOptions<Actor> {
-      token?: TokenDocument.ConfiguredInstance | null;
+    interface Options extends DocumentSheet.Options<Actor.Implementation> {
+      token?: TokenDocument.Implementation | null;
     }
 
     interface ActorSheetData<Options extends ActorSheet.Options = ActorSheet.Options>
-      extends DocumentSheet.DocumentSheetData<Options, Actor.ConfiguredInstance> {
+      extends DocumentSheet.DocumentSheetData<Options, Actor.Implementation> {
       actor: ActorSheet["actor"];
       items: this["data"]["items"];
       effects: this["data"]["effects"];
     }
   }
 }
+
+declare abstract class AnyActorSheet extends ActorSheet<ActorSheet.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/forms/adventure-exporter.d.mts

@@ -1,6 +1,6 @@
 import type { EditorView } from "prosemirror-view";
 import type { Editor } from "tinymce";
-import type { GetDataReturnType } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, Identity } from "#utils";
 
 declare global {
   /**
@@ -8,9 +8,9 @@ declare global {
    */
   class AdventureExporter<Options extends AdventureExporter.Options = AdventureExporter.Options> extends DocumentSheet<
     Options,
-    Adventure.ConfiguredInstance
+    Adventure.Implementation
   > {
-    constructor(object?: Adventure.ConfiguredInstance & { pack: string }, options?: Partial<Options>);
+    constructor(object?: Adventure.Implementation & { pack: string }, options?: Partial<Options>);
 
     /**
      * @defaultValue
@@ -73,9 +73,10 @@ declare global {
   }
 
   namespace AdventureExporter {
-    type Any = AdventureExporter<any>;
+    interface Any extends AnyAdventureExporter {}
+    interface AnyConstructor extends Identity<typeof AnyAdventureExporter> {}
 
-    interface Options extends DocumentSheetOptions<Adventure.ConfiguredInstance> {}
+    interface Options extends DocumentSheet.Options<Adventure.Implementation> {}
 
     interface AdventureContentTreeNode {
       /** An alias for folder.id */
@@ -85,7 +86,7 @@ declare global {
       name: string;
 
       /** The Folder at this node level */
-      folder: Folder;
+      folder: Folder.Implementation;
 
       /** The modification state of the Folder */
       state: string;
@@ -124,9 +125,13 @@ declare global {
     }
 
     interface AdventureExporterData {
-      adventure: Adventure.ConfiguredInstance;
+      adventure: Adventure.Implementation;
 
       contentTree: AdventureExporter["contentTree"];
     }
   }
 }
+
+declare abstract class AnyAdventureExporter extends AdventureExporter<AdventureExporter.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/forms/adventure-importer.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, Identity } from "#utils";
 
 declare global {
   /**
@@ -6,7 +6,7 @@ declare global {
    */
   class AdventureImporter<Options extends AdventureImporter.Options = AdventureImporter.Options> extends DocumentSheet<
     Options,
-    Adventure.ConfiguredInstance
+    Adventure.Implementation
   > {
     /**
      * An alias for the Adventure document
@@ -48,7 +48,10 @@ declare global {
 
     protected override _getHeaderButtons(): Application.HeaderButton[];
 
-    protected override _updateObject(event: Event, formData: object): Promise<void | ReturnType<Adventure["import"]>>;
+    protected override _updateObject(
+      event: Event,
+      formData: object,
+    ): Promise<void | ReturnType<Adventure.Implementation["import"]>>;
 
     /**
      * Mirror Adventure#import but call AdventureImporter#_importContent and AdventureImport#_prepareImportData
@@ -70,12 +73,13 @@ declare global {
   }
 
   namespace AdventureImporter {
-    type Any = AdventureImporter<any>;
+    interface Any extends AnyAdventureImporter {}
+    interface AnyConstructor extends Identity<typeof AnyAdventureImporter> {}
 
-    interface Options extends DocumentSheetOptions<Adventure.ConfiguredInstance> {}
+    interface Options extends DocumentSheet.Options<Adventure.Implementation> {}
 
     interface AdventureImporterData {
-      adventure: Adventure.ConfiguredInstance;
+      adventure: Adventure.Implementation;
 
       contents: ReturnType<AdventureImporter["_getContentList"]>;
 
@@ -83,3 +87,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyAdventureImporter extends AdventureImporter<AdventureImporter.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/forms/base-sheet.d.mts

@@ -1,12 +1,14 @@
 import type { EditorView } from "prosemirror-view";
 import type { Editor } from "tinymce";
-import type { GetDataReturnType } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, Identity } from "#utils";
+
+import Document = foundry.abstract.Document;
 
 declare global {
-  class BaseSheet<Options extends BaseSheet.Options = BaseSheet.Options> extends DocumentSheet<
-    Options,
-    foundry.abstract.Document.Any
-  > {
+  class BaseSheet<
+    ConcreteDocument extends Document.Any = Document.Any,
+    Options extends BaseSheet.Options<ConcreteDocument> = BaseSheet.Options<ConcreteDocument>,
+  > extends DocumentSheet<Options, ConcreteDocument> {
     /**
      * @defaultValue
      * ```typescript
@@ -31,11 +33,13 @@ declare global {
   }
 
   namespace BaseSheet {
-    type Any = BaseSheet<any>;
+    interface Any extends AnyBaseSheet {}
+    interface AnyConstructor extends Identity<typeof AnyBaseSheet> {}
 
-    interface Options extends DocumentSheetOptions<Adventure.ConfiguredInstance> {}
+    interface Options<ConcreteDocument extends Document.Any = Document.Any>
+      extends DocumentSheet.Options<ConcreteDocument> {}
 
-    interface BaseSheetData extends DocumentSheet.DocumentSheetData<Options, foundry.abstract.Document.Any> {
+    interface BaseSheetData extends DocumentSheet.DocumentSheetData<Options, Document.Any> {
       hasName: boolean;
       hasImage: boolean;
       hasDescription: boolean;
@@ -43,3 +47,7 @@ declare global {
     }
   }
 }
+
+declare abstract class AnyBaseSheet extends BaseSheet<Document.Any, BaseSheet.Options<Document.Any>> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/forms/card-config.d.mts

@@ -1,4 +1,4 @@
-import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+import type { GetDataReturnType, MaybePromise, Identity } from "#utils";
 
 declare global {
   /**
@@ -6,9 +6,9 @@ declare global {
    *
    * @typeParam Options - The type of the options object
    */
-  class CardConfig<Options extends DocumentSheetOptions<Card> = DocumentSheetOptions<Card>> extends DocumentSheet<
+  class CardConfig<Options extends CardConfig.Options = CardConfig.Options> extends DocumentSheet<
     Options,
-    Card.ConfiguredInstance
+    Card.Implementation
   > {
     /**
      * @defaultValue
@@ -22,7 +22,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): DocumentSheetOptions<Card>;
+    static override get defaultOptions(): CardConfig.Options;
 
     override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<CardConfig.CardConfigData>>;
 
@@ -37,12 +37,20 @@ declare global {
   }
 
   namespace CardConfig {
-    type Any = CardConfig<any>;
+    interface Any extends AnyCardConfig {}
+    interface AnyConstructor extends Identity<typeof AnyCardConfig> {}
 
-    interface CardConfigData<Options extends DocumentSheetOptions<Card> = DocumentSheetOptions<Card>>
-      extends DocumentSheet.DocumentSheetData<Options, Card.ConfiguredInstance> {
-      //TODO: Find if we can better type this
+    interface Options extends DocumentSheet.Options<Card.Implementation> {}
+
+    interface CardConfigData<
+      Options extends DocumentSheet.Options<Card.Implementation> = DocumentSheet.Options<Card.Implementation>,
+    > extends DocumentSheet.DocumentSheetData<Options, Card.Implementation> {
+      // TODO: Find if we can better type this
       types: Record<string, string>;
     }
   }
 }
+
+declare abstract class AnyCardConfig extends CardConfig<CardConfig.Options> {
+  constructor(...args: never);
+}