@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/apps/placeables/token-config.d.mts

@@ -1,5 +1,4 @@
-import type { InterfaceToObject, AnyObject } from "fvtt-types/utils";
-import type StringTerm from "../../../client-esm/dice/terms/string.d.mts";
+import type { InterfaceToObject, AnyObject, Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -7,24 +6,24 @@ declare global {
    */
   class TokenConfig<
     Options extends
-      DocumentSheetOptions<TokenDocument.ConfiguredInstance> = DocumentSheetOptions<TokenDocument.ConfiguredInstance>,
-  > extends DocumentSheet<Options, TokenDocument.ConfiguredInstance | Actor.ConfiguredInstance> {
-    constructor(object: TokenDocument.ConfiguredInstance | Actor.ConfiguredInstance, options?: Partial<Options>);
+      DocumentSheet.Options<TokenDocument.Implementation> = DocumentSheet.Options<TokenDocument.Implementation>,
+  > extends DocumentSheet<TokenDocument.Implementation | Actor.Implementation, Options> {
+    constructor(object: TokenDocument.Implementation | Actor.Implementation, options?: Partial<Options>);
 
     /**
      * The placed Token object in the Scene
      */
-    token: TokenDocument.ConfiguredInstance | foundry.data.PrototypeToken;
+    token: TokenDocument.Implementation | foundry.data.PrototypeToken;
 
     /**
      * A reference to the Actor which the token depicts
      */
-    actor: Actor.ConfiguredInstance;
+    actor: Actor.Implementation;
 
     /**
      * Maintain a copy of the original to show a real-time preview of changes.
      */
-    preview: TokenDocument.ConfiguredInstance | foundry.data.PrototypeToken;
+    preview: TokenDocument.Implementation | foundry.data.PrototypeToken;
 
     /**
      * @defaultValue
@@ -44,7 +43,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): DocumentSheetOptions<TokenDocument.ConfiguredInstance>;
+    static override get defaultOptions(): DocumentSheet.Options<TokenDocument.Implementation>;
 
     /**
      * A convenience accessor to test whether we are configuring the prototype Token for an Actor.
@@ -64,7 +63,7 @@ declare global {
      */
     protected _handleTokenPreview(force: boolean, options?: Options): Promise<void>;
 
-    protected override _canUserView(user: User): boolean;
+    protected override _canUserView(user: User.Implementation): boolean;
 
     override getData(options?: Partial<Options>): Promise<object>; // TODO: Implement GetDataReturnType
 
@@ -120,14 +119,14 @@ declare global {
      * Handle adding a detection mode.
      * @param modes - The existing detection modes
      */
-    protected _onAddDetectionMode(modes: TokenDocument["detectionModes"]): void;
+    protected _onAddDetectionMode(modes: TokenDocument.Implementation["detectionModes"]): void;
 
     /**
      * Handle removing a detection mode.
      * @param index - The index of the detection mode to remove.
      * @param modes - The existing detection modes.
      */
-    protected _onRemoveDetectionMode(index: number, modes: TokenDocument["detectionModes"]): void;
+    protected _onRemoveDetectionMode(index: number, modes: TokenDocument.Implementation["detectionModes"]): void;
 
     /**
      * Disable the user's ability to edit the token image field if wildcard images are enabled and that user does not have
@@ -138,45 +137,64 @@ declare global {
   }
 
   namespace TokenConfig {
-    type Any = AnyTokenConfig;
-    type AnyConstructor = typeof AnyTokenConfig;
-
-    interface FormData {
-      // TODO: Update
-      actorId: string;
-      actorLink: boolean;
-      alternateImages?: string;
-      alpha: number;
-      "bar1.attribute": string;
-      "bar2.attribute": string;
-      brightLight: number | null;
-      brightSight: number | null;
-      dimLight: number | null;
-      dimSight: number | null;
-      displayBars: foundry.CONST.TOKEN_DISPLAY_MODES;
-      displayName: foundry.CONST.TOKEN_DISPLAY_MODES;
-      disposition: foundry.CONST.TOKEN_DISPOSITIONS;
-      elevation: number | null;
-      height: number | null;
-      img: string;
-      lightAlpha: number;
-      lightAngle: number | null;
-      "lightAnimation.intensity": number;
-      "lightAnimation.speed": number;
-      "lightAnimation.type": string;
-      lightColor: string;
-      lockRotation: boolean;
-      mirrorX: boolean;
-      mirrorY: boolean;
-      name: StringTerm;
-      rotation: number | null;
-      scale: number;
-      sightAngle: number | null;
-      tint: string;
-      vision: boolean;
-      width: number | null;
-      x: number | null;
-      y: number | null;
+    interface Any extends AnyTokenConfig {}
+    interface AnyConstructor extends Identity<typeof AnyTokenConfig> {}
+
+    /** @internal */
+    type _FormData = Pick<
+      TokenDocument.Implementation,
+      | "actorId"
+      | "actorLink"
+      | "alpha"
+      | "detectionModes"
+      | "displayBars"
+      | "displayName"
+      | "disposition"
+      | "elevation"
+      | "lockRotation"
+      | "name"
+      | "rotation"
+      | "sort"
+      | "x"
+      | "y"
+    >;
+
+    interface FormData extends _FormData {
+      "bar1.attribute": TokenDocument.Implementation["bar1"]["attribute"];
+      "bar2.attribute": TokenDocument.Implementation["bar2"]["attribute"];
+      "light.alpha": TokenDocument.Implementation["light"]["alpha"];
+      "light.angle": TokenDocument.Implementation["light"]["angle"];
+      "light.animation.intensity": TokenDocument.Implementation["light"]["animation"]["intensity"];
+      "light.animation.reverse": TokenDocument.Implementation["light"]["animation"]["reverse"];
+      "light.animation.speed": TokenDocument.Implementation["light"]["animation"]["speed"];
+      "light.animation.type": TokenDocument.Implementation["light"]["animation"]["type"];
+      "light.attenuation": TokenDocument.Implementation["light"]["attenuation"];
+      "light.bright": TokenDocument.Implementation["light"]["bright"];
+      "light.color": TokenDocument.Implementation["light"]["color"];
+      "light.coloration": TokenDocument.Implementation["light"]["coloration"];
+      "light.contrast": TokenDocument.Implementation["light"]["contrast"];
+      "light.dim": TokenDocument.Implementation["light"]["dim"];
+      "light.luminosity": TokenDocument.Implementation["light"]["luminosity"];
+      "light.saturation": TokenDocument.Implementation["light"]["saturation"];
+      "light.shadows": TokenDocument.Implementation["light"]["shadows"];
+      "occludable.radius": TokenDocument.Implementation["occludable"]["radius"];
+      "ring.colors.background": TokenDocument.Implementation["ring"]["colors"]["background"];
+      "ring.colors.ring": TokenDocument.Implementation["ring"]["colors"]["ring"];
+      "ring.effects": TokenDocument.Implementation["ring"]["effects"];
+      "ring.enabled": TokenDocument.Implementation["ring"]["enabled"];
+      "ring.subject.scale": TokenDocument.Implementation["ring"]["subject"]["scale"];
+      "ring.subject.texture": TokenDocument.Implementation["ring"]["subject"]["texture"];
+      "sight.attenuation": TokenDocument.Implementation["sight"]["attenuation"];
+      "sight.color": TokenDocument.Implementation["sight"]["color"];
+      "sight.contrast": TokenDocument.Implementation["sight"]["contrast"];
+      "sight.enabled": TokenDocument.Implementation["sight"]["enabled"];
+      "texture.anchorX": TokenDocument.Implementation["texture"]["anchorX"];
+      "texture.anchorY": TokenDocument.Implementation["texture"]["anchorY"];
+      "texture.fit": TokenDocument.Implementation["texture"]["fit"];
+      "texture.scaleX": TokenDocument.Implementation["texture"]["scaleX"];
+      "texture.scaleY": TokenDocument.Implementation["texture"]["scaleY"];
+      "texture.src": TokenDocument.Implementation["texture"]["src"];
+      "texture.tint": TokenDocument.Implementation["texture"]["tint"];
     }
   }
 
@@ -185,11 +203,11 @@ declare global {
    */
   class DefaultTokenConfig<
     Options extends
-      DocumentSheetOptions<TokenDocument.ConfiguredInstance> = DocumentSheetOptions<TokenDocument.ConfiguredInstance>,
+      DocumentSheet.Options<TokenDocument.Implementation> = DocumentSheet.Options<TokenDocument.Implementation>,
   > extends TokenConfig<Options> {
     constructor(object?: unknown, options?: Partial<Options>);
 
-    object: TokenDocument.ConfiguredInstance;
+    object: TokenDocument.Implementation;
 
     /**
      * The named world setting that stores the default Token configuration
@@ -206,7 +224,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): DocumentSheetOptions<TokenDocument.ConfiguredInstance>;
+    static override get defaultOptions(): DocumentSheet.Options<TokenDocument.Implementation>;
 
     override get id(): string;
 
@@ -214,7 +232,7 @@ declare global {
 
     override get isEditable(): boolean;
 
-    protected override _canUserView(user: User): boolean;
+    protected override _canUserView(user: User.Implementation): boolean;
 
     override getData(options: unknown): Promise<object>; // TODO: Implement GetDataReturnType
 
@@ -234,23 +252,26 @@ declare global {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     protected override _onBarChange(): Promise<void>;
 
-    protected override _onAddDetectionMode(modes: TokenDocument["detectionModes"]): void;
+    protected override _onAddDetectionMode(modes: TokenDocument.Implementation["detectionModes"]): void;
 
-    protected override _onRemoveDetectionMode(index: number, modes: TokenDocument["detectionModes"]): void;
+    protected override _onRemoveDetectionMode(
+      index: number,
+      modes: TokenDocument.Implementation["detectionModes"],
+    ): void;
   }
 
   namespace DefaultTokenConfig {
-    type Any = AnyDefaultTokenConfig;
-    type AnyConstructor = typeof AnyDefaultTokenConfig;
+    interface Any extends AnyDefaultTokenConfig {}
+    interface AnyConstructor extends Identity<typeof AnyDefaultTokenConfig> {}
   }
 }
 
-declare abstract class AnyTokenConfig extends TokenConfig<DocumentSheetOptions<TokenDocument.ConfiguredInstance>> {
-  constructor(arg0: never, ...args: never[]);
+declare abstract class AnyTokenConfig extends TokenConfig<DocumentSheet.Options<TokenDocument.Implementation>> {
+  constructor(...args: never);
 }
 
 declare abstract class AnyDefaultTokenConfig extends DefaultTokenConfig<
-  DocumentSheetOptions<TokenDocument.ConfiguredInstance>
+  DocumentSheet.Options<TokenDocument.Implementation>
 > {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/apps/placeables/token-hud.d.mts

@@ -1,4 +1,4 @@
-import type { MaybePromise } from "fvtt-types/utils";
+import type { MaybePromise, Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -6,8 +6,8 @@ declare global {
    * This interface provides controls for visibility, attribute bars, elevation, status effects, and more.
    * @typeParam Options - the type of the options object
    */
-  class TokenHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    Token.ConfiguredInstance,
+  class TokenHUD<Options extends Application.Options = Application.Options> extends BasePlaceableHUD<
+    Token.Implementation,
     Options
   > {
     /**
@@ -26,9 +26,9 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
-    override bind(object: Token.ConfiguredInstance): void;
+    override bind(object: Token.Implementation): void;
 
     /**
      * Refresh the currently active state of all status effect icons in the Token HUD selector.
@@ -37,7 +37,7 @@ declare global {
 
     override setPosition(_position?: Partial<Application.Position>): void;
 
-    override getData(options?: Partial<ApplicationOptions>): MaybePromise<object>; // TODO: Implement GetDataReturnType
+    override getData(options?: Partial<Application.Options>): MaybePromise<object>; // TODO: Implement GetDataReturnType
 
     /**
      * Get an array of icon paths which represent valid status effect choices
@@ -129,11 +129,11 @@ declare global {
   }
 
   namespace TokenHUD {
-    type Any = AnyTokenHUD;
-    type AnyConstructor = typeof AnyTokenHUD;
+    interface Any extends AnyTokenHUD {}
+    interface AnyConstructor extends Identity<typeof AnyTokenHUD> {}
   }
 }
 
-declare abstract class AnyTokenHUD extends TokenHUD<ApplicationOptions> {
-  constructor(arg0: never, ...args: never[]);
+declare abstract class AnyTokenHUD extends TokenHUD<Application.Options> {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/placeables/wall-config.d.mts

@@ -1,4 +1,4 @@
-import type { MaybePromise } from "fvtt-types/utils";
+import type { AnyObject, InterfaceToObject, MaybePromise } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -7,8 +7,8 @@ declare global {
    */
   class WallConfig<
     Options extends
-      DocumentSheetOptions<WallDocument.ConfiguredInstance> = DocumentSheetOptions<WallDocument.ConfiguredInstance>,
-  > extends DocumentSheet<Options, WallDocument.ConfiguredInstance> {
+      DocumentSheet.Options<WallDocument.Implementation> = DocumentSheet.Options<WallDocument.Implementation>,
+  > extends DocumentSheet<WallDocument.Implementation, Options> {
     /**
      * @defaultValue
      * ```typescript
@@ -20,7 +20,7 @@ declare global {
      * return options;
      * ```
      */
-    static get defaultOptions(): DocumentSheetOptions<WallDocument.ConfiguredInstance>;
+    static get defaultOptions(): DocumentSheet.Options<WallDocument.Implementation>;
 
     /**
      * An array of Wall ids that should all be edited when changes to this config form are submitted
@@ -33,7 +33,7 @@ declare global {
     override render(
       force?: boolean,
       options?: Application.RenderOptions<Options> & {
-        walls?: Wall.ConfiguredInstance[] | undefined;
+        walls?: Wall.Implementation[] | undefined;
       },
     ): this;
 
@@ -43,22 +43,25 @@ declare global {
 
     protected _onChangeInput(event: JQuery.ChangeEvent<any, any, any, any>): Promise<void | object>;
 
-    protected _getSubmitData(updateData?: object | null): WallConfig.FormData;
+    protected _getSubmitData(updateData?: AnyObject | null): InterfaceToObject<WallConfig.FormData>;
 
     protected override _updateObject(event: Event, formData: WallConfig.FormData): Promise<unknown>;
   }
 
   namespace WallConfig {
-    type Any = WallConfig<any>;
+    interface Any extends WallConfig<any> {}
 
-    type FormData = Pick<
-      WallDocument["_source"],
-      "move" | "light" | "sight" | "sound" | "dir" | "door" | "ds" | "doorSound"
-    > & {
-      "threshold.light": WallDocument["_source"]["threshold"]["light"];
-      "threshold.sight": WallDocument["_source"]["threshold"]["sight"];
-      "threshold.sound": WallDocument["_source"]["threshold"]["sound"];
-      "threshold.attenuation": WallDocument["_source"]["threshold"]["attenuation"];
-    };
+    /** @internal */
+    type _FormData = Pick<
+      WallDocument.Implementation,
+      "dir" | "door" | "doorSound" | "ds" | "light" | "move" | "sight" | "sound"
+    >;
+
+    interface FormData extends _FormData {
+      "threshold.light": WallDocument.Implementation["threshold"]["light"];
+      "threshold.sight": WallDocument.Implementation["threshold"]["sight"];
+      "threshold.sound": WallDocument.Implementation["threshold"]["sound"];
+      "threshold.attenuation": WallDocument.Implementation["threshold"]["attenuation"];
+    }
   }
 }

package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts

@@ -5,13 +5,13 @@ declare global {
    * A simple application which supports popping a ChatMessage out to a separate UI window.
    * @typeParam Options - the type of the options object
    */
-  class ChatPopout<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    constructor(message: ChatMessage.ConfiguredInstance, options?: Partial<Options>);
+  class ChatPopout<Options extends Application.Options = Application.Options> extends Application<Options> {
+    constructor(message: ChatMessage.Implementation, options?: Partial<Options>);
 
     /**
      * The displayed Chat Message document
      */
-    message: ChatMessage.ConfiguredInstance;
+    message: ChatMessage.Implementation;
 
     /**
      * @defaultValue
@@ -23,7 +23,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override get id(): string;
 
@@ -34,6 +34,6 @@ declare global {
   }
 
   namespace ChatPopout {
-    type Any = ChatPopout<any>;
+    interface Any extends ChatPopout<any> {}
   }
 }

package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts

@@ -7,7 +7,7 @@ declare global {
    * @typeParam Options - The type of the options object
    */
   class SettingsConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
+    Options extends FormApplication.Options = FormApplication.Options,
   > extends PackageConfiguration<Options> {
     /**
      * @defaultValue
@@ -65,7 +65,7 @@ declare global {
   }
 
   namespace SettingsConfig {
-    type Any = SettingsConfig<any>;
+    interface Any extends SettingsConfig<any> {}
 
     interface Category extends PackageConfiguration.Category {
       menus: ClientSettings.SettingSubmenuConfig[];

package/src/foundry/client/apps/sidebar/apps/compendium.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type Document from "#common/abstract/document.d.mts";
 
 declare global {
   /**
@@ -11,7 +11,7 @@ declare global {
     Options extends Compendium.Options<Metadata> = Compendium.Options<Metadata>,
   > extends DocumentDirectory<"Compendium", Options> {
     /**
-     * @param options    - Compendium configuration options.
+     * @param options - Compendium configuration options.
      */
     constructor(options: Partial<Options>);
 
@@ -51,14 +51,17 @@ declare global {
 
     override initialize(): void;
 
-    override render(force?: boolean, options?: Application.RenderOptions<ApplicationOptions>): unknown;
+    override render(force?: boolean, options?: Application.RenderOptions<Application.Options>): this;
 
     // TODO: Implement GetDataReturnType
     override getData(options?: Partial<Options>): Promise<object>;
 
-    protected override _entryAlreadyExists(entry: DirectoryMixinEntry): boolean;
+    protected override _entryAlreadyExists(entry: DirectoryApplicationMixin.Entry): boolean;
 
-    protected override _createDroppedEntry(entry: DirectoryMixinEntry, folderId?: string): Promise<DirectoryMixinEntry>;
+    protected override _createDroppedEntry(
+      entry: DirectoryApplicationMixin.Entry,
+      folderId?: string,
+    ): Promise<DirectoryApplicationMixin.Entry>;
 
     protected override _getEntryDragData(entryId: string): { type: string; uuid: string };
 
@@ -81,12 +84,12 @@ declare global {
   }
 
   namespace Compendium {
-    type Any = Compendium<any, any>;
+    interface Any extends Compendium<any, any> {}
 
-    interface Options<_Metadata extends CompendiumCollection.Metadata = CompendiumCollection.Metadata>
-      extends DocumentDirectoryOptions {
-      // Note(LukeAbby): Replacing `any` with `Metadata` causes an OOM within TypeScript.
-      collection: CompendiumCollection<any>;
+    interface Options<Metadata extends CompendiumCollection.Metadata = CompendiumCollection.Metadata>
+      extends DocumentDirectory.Options<Document.ImplementationClassFor<Metadata["type"]>> {
+      // TODO(LukeAbby): Replace with `CompendiumCollection<Metadata>` when possible.
+      collection: any;
     }
   }
 }

package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts

@@ -6,7 +6,7 @@ declare global {
    *
    * @typeParam Options - the type of the options object
    */
-  class InvitationLinks<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class InvitationLinks<Options extends Application.Options = Application.Options> extends Application<Options> {
     /**
      * @defaultValue
      * ```typescript
@@ -18,7 +18,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     // TODO: Implement GetDataReturnType
     override getData(options?: Partial<Options>): Promise<object>;
@@ -27,6 +27,6 @@ declare global {
   }
 
   namespace InvitationLinks {
-    type Any = InvitationLinks<any>;
+    interface Any extends InvitationLinks<any> {}
   }
 }

package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts

@@ -145,7 +145,7 @@ declare global {
   }
 
   namespace KeybindingsConfig {
-    type Any = KeybindingsConfig<any>;
+    interface Any extends KeybindingsConfig<any> {}
 
     interface Category extends PackageConfiguration.Category {
       actions: ActionData[];

package/src/foundry/client/apps/sidebar/apps/module-management.d.mts

@@ -7,9 +7,9 @@ declare global {
    * set of modules which are active within the World.
    * @typeParam Options - The type of the options object
    */
-  class ModuleManagement<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
-    Options,
-    undefined
+  class ModuleManagement<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
+    FormApplication.NoObject,
+    Options
   > {
     /**
      * @param options - Module Management application options.
@@ -46,7 +46,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplication.Options;
 
     override get isEditable(): boolean;
 
@@ -120,11 +120,11 @@ declare global {
      * @param counts   - An object of sub-type counts.
      * @param isActive - Whether the module is active.
      */
-    protected _formatDocumentSummary(counts: ModuleSubTypeCounts, isActive: boolean): string;
+    protected _formatDocumentSummary(counts: ClientIssues.ModuleSubTypeCounts, isActive: boolean): string;
   }
 
   namespace ModuleManagement {
-    type Any = ModuleManagement<any>;
+    interface Any extends ModuleManagement<any> {}
 
     type FilterName = "all" | "active" | "inactive";
 

package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts

@@ -4,9 +4,9 @@ declare global {
   /**
    * An application for configuring the permissions which are available to each User role.
    */
-  class PermissionConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
-    Options,
-    undefined
+  class PermissionConfig<Options extends FormApplication.Options = FormApplication.Options> extends FormApplication<
+    FormApplication.NoObject,
+    Options
   > {
     /**
      * @defaultValue
@@ -22,10 +22,10 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): FormApplicationOptions;
+    static override get defaultOptions(): FormApplication.Options;
 
     // TODO: Implement GetDataReturnType
-    override getData(options?: Partial<FormApplicationOptions>): Promise<object>;
+    override getData(options?: Partial<FormApplication.Options>): Promise<object>;
 
     /**
      * Prepare the permissions object used to render the configuration template
@@ -52,7 +52,7 @@ declare global {
   }
 
   namespace PermissionConfig {
-    type Any = PermissionConfig<any>;
+    interface Any extends PermissionConfig<any> {}
 
     type FormData = Record<string, boolean>;