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

package/src/foundry/client/apps/sidebar/apps/support-details.d.mts

@@ -1,11 +1,11 @@
-import type { MaybePromise } from "../../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
   /**
    * Support Info and Report
    * @typeParam Options - the type of the options object
    */
-  class SupportDetails<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class SupportDetails<Options extends Application.Options = Application.Options> extends Application<Options> {
     /**
      * @defaultValue
      * ```typescript
@@ -21,7 +21,7 @@ declare global {
      * return options;
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * Returns the support report data
@@ -80,7 +80,7 @@ declare global {
     /**
      * Collects a number of metrics that is useful for Support
      */
-    static generateSupportReport(): SupportReportData;
+    static generateSupportReport(): SupportDetails.ReportData;
 
     /**
      * Get a WebGL renderer information string
@@ -91,31 +91,36 @@ declare global {
   }
 
   namespace SupportDetails {
-    type Any = SupportDetails<any>;
-  }
+    interface Any extends SupportDetails<any> {}
 
-  interface SupportReportData {
-    coreVersion: number;
-    systemVersion: string;
-    activeModuleCount: number;
-    os: string;
-    client: string;
-    gpu: string;
-    maxTextureSize: number | string;
-    sceneDimensions: string;
-    grid: number;
-    padding: number; // note: float in actual code
-    walls: number;
-    lights: number;
-    sounds: number;
-    tiles: number;
-    tokens: number;
-    actors: number;
-    items: number;
-    journals: number;
-    tables: number;
-    playlists: number;
-    packs: number;
-    messages: number;
+    interface ReportData {
+      coreVersion: number;
+      systemVersion: string;
+      activeModuleCount: number;
+      os: string;
+      client: string;
+      gpu: string;
+      maxTextureSize: number | string;
+      sceneDimensions: string;
+      grid: number;
+      padding: number; // note: float in actual code
+      walls: number;
+      lights: number;
+      sounds: number;
+      tiles: number;
+      tokens: number;
+      actors: number;
+      items: number;
+      journals: number;
+      tables: number;
+      playlists: number;
+      packs: number;
+      messages: number;
+    }
   }
+
+  /**
+   * @deprecated {@link SupportDetails.ReportData | `SupportDetails.ReportData`}
+   */
+  type SupportReportData = SupportDetails.ReportData;
 }

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

@@ -1,9 +1,9 @@
-import type { MaybePromise } from "../../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
   /** A management app for configuring which Tours are available or have been completed. */
   class ToursManagement extends PackageConfiguration {
-    /** @remarks This is not implemented in {@link ToursManagement} and will throw. */
+    /** @remarks This is not implemented in {@link ToursManagement | `ToursManagement`} and will throw. */
     protected override _updateObject(event: Event, formData?: object): Promise<never>;
 
     /**

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

@@ -1,19 +1,14 @@
-import type { MaybePromise } from "../../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
-  interface WorldConfigOptions extends FormApplicationOptions {
-    /**
-     * Whether the world is being created or updated.
-     * @defaultValue `false`
-     */
-    create: boolean;
-  }
+  /** @deprecated {@link WorldConfig.Options | `WorldConfig.Options`} */
+  type WorldConfigOptions = WorldConfig.Options;
 
   /**
    * The World Management setup application
    * @typeParam Options - The type of the options object
    */
-  class WorldConfig<Options extends WorldConfigOptions = WorldConfigOptions> extends FormApplication<Options, World> {
+  class WorldConfig<Options extends WorldConfig.Options = WorldConfig.Options> extends FormApplication<Options, World> {
     /**
      * @defaultValue
      * ```typescript
@@ -26,7 +21,7 @@ declare global {
      * })
      * ```
      */
-    static override get defaultOptions(): WorldConfigOptions;
+    static override get defaultOptions(): WorldConfig.Options;
 
     /**
      * A semantic alias for the World object which is being configured by this form.
@@ -53,5 +48,13 @@ declare global {
 
   namespace WorldConfig {
     type FormData = Partial<World["_source"]>;
+
+    interface Options extends FormApplication.Options {
+      /**
+       * Whether the world is being created or updated.
+       * @defaultValue `false`
+       */
+      create: boolean;
+    }
   }
 }

package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts

@@ -1,4 +1,4 @@
-import type { Mixin } from "../../../../types/utils.d.mts";
+import type { FixedInstanceType, Mixin } from "#utils";
 
 declare class DirectoryApplication {
   /** @privateRemarks All mixin classses should accept anything for its constructor. */
@@ -14,7 +14,7 @@ declare class DirectoryApplication {
    */
   static folderPartial: string;
 
-  static get defaultOptions(): DocumentDirectoryOptions;
+  static get defaultOptions(): DocumentDirectory.Options;
 
   /**
    * The type of Entry that is contained in this DirectoryTab.
@@ -46,7 +46,7 @@ declare class DirectoryApplication {
    */
   protected _matchSearchFolders(
     query: RegExp,
-    includeFolder: (folder: Folder.ConfiguredInstance, autoExpand?: boolean) => boolean,
+    /** @immediate */ includeFolder: (folder: Folder.Implementation, autoExpand?: boolean) => boolean,
   ): void;
 
   /**
@@ -61,7 +61,7 @@ declare class DirectoryApplication {
     query: RegExp,
     entryIds: Set<string>,
     folderIds: Set<string>,
-    includeFolder: (folder: Folder.ConfiguredInstance, autoExpand?: boolean) => boolean,
+    /** @immediate */ includeFolder: (folder: Folder.Implementation, autoExpand?: boolean) => boolean,
   ): void;
 
   /**
@@ -78,9 +78,9 @@ declare class DirectoryApplication {
    */
   protected _getEntryId(entry: object): string;
 
-  getData(options?: Partial<ApplicationOptions>): Promise<object>; // TODO: Implement GetDataReturnType
+  getData(options?: Partial<Application.Options>): Promise<object>; // TODO: Implement GetDataReturnType
 
-  protected _render(force?: boolean, options?: Application.RenderOptions<ApplicationOptions>): Promise<void>;
+  protected _render(force?: boolean, options?: Application.RenderOptions<Application.Options>): Promise<void>;
 
   activateListeners(html: JQuery): void;
 
@@ -152,7 +152,7 @@ declare class DirectoryApplication {
    * @param sortData        - The sort data for the Folder
    */
   protected _handleDroppedForeignFolder(
-    folder: Folder,
+    folder: Folder.Implementation,
     closestFolderId: string,
     sortData: {
       /**
@@ -164,7 +164,7 @@ declare class DirectoryApplication {
        */
       sortBefore: boolean;
     },
-  ): Promise<{ folder: Folder.ConfiguredInstance; sortNeeded: boolean } | null>;
+  ): Promise<{ folder: Folder.Implementation; sortNeeded: boolean } | null>;
 
   /**
    * Handle Entry data being dropped into the directory.
@@ -179,7 +179,7 @@ declare class DirectoryApplication {
    * @param otherEntry - The other Entry
    * @returns Is the Entry being compared to itself?
    */
-  protected _entryIsSelf(entry: DirectoryMixinEntry, otherEntry: DirectoryMixinEntry): boolean;
+  protected _entryIsSelf(entry: DirectoryApplicationMixin.Entry, otherEntry: DirectoryApplicationMixin.Entry): boolean;
 
   /**
    * Determine whether an Entry belongs to the target folder
@@ -187,21 +187,21 @@ declare class DirectoryApplication {
    * @param folder - The target Folder
    * @returns Is the Entry a sibling?
    */
-  protected _entryBelongsToFolder(entry: DirectoryMixinEntry, folder: Folder.ConfiguredInstance): boolean;
+  protected _entryBelongsToFolder(entry: DirectoryApplicationMixin.Entry, folder: Folder.Implementation): boolean;
 
   /**
    * Check if an Entry is already present in the Collection
    * @param entry - The entry being dropped
    * @returns Is the Entry already present?
    */
-  protected _entryAlreadyExists(entry: DirectoryMixinEntry): boolean;
+  protected _entryAlreadyExists(entry: DirectoryApplicationMixin.Entry): boolean;
 
   /**
    * Get the dropped Entry from the drop data
    * @param data - The data being dropped
    * @returns The dropped Entry
    */
-  protected _getDroppedEntryFromData(data: object): Promise<DirectoryMixinEntry>;
+  protected _getDroppedEntryFromData(data: object): Promise<DirectoryApplicationMixin.Entry>;
 
   /**
    * Create a dropped Entry in this Collection
@@ -209,7 +209,10 @@ declare class DirectoryApplication {
    * @param folderId - The ID of the Folder to which the Entry should be added
    * @returns THe created Entry
    */
-  protected _createDroppedEntry(entry: DirectoryMixinEntry, folderId?: string): Promise<DirectoryMixinEntry>;
+  protected _createDroppedEntry(
+    entry: DirectoryApplicationMixin.Entry,
+    folderId?: string,
+  ): Promise<DirectoryApplicationMixin.Entry>;
 
   /**
    * Sort a relative entry within a collection
@@ -218,7 +221,7 @@ declare class DirectoryApplication {
    * @returns The sorted entry
    */
   protected _sortRelative(
-    entry: DirectoryMixinEntry,
+    entry: DirectoryApplicationMixin.Entry,
     sortData: {
       /**
        * The sort key to use for sorting
@@ -241,36 +244,48 @@ declare class DirectoryApplication {
    * Get the set of ContextMenu options which should be used for Folders in a SidebarDirectory
    * @returns The Array of context options passed to the ContextMenu instance
    */
-  protected _getFolderContextOptions(): ContextMenuEntry[];
+  protected _getFolderContextOptions(): ContextMenu.Entry[];
 
   /**
    * Get the set of ContextMenu options which should be used for Entries in a SidebarDirectory
    * @returns The array of context options passed to the ContextMenu instance
    */
-  protected _getEntryContextOptions(): ContextMenuEntry[];
+  protected _getEntryContextOptions(): ContextMenu.Entry[];
 }
 
 declare global {
-  interface DirectoryMixinEntry {
-    /**
-     * The unique id of the entry
-     */
-    id: string;
-    /**
-     * The folder id or folder object to which this entry belongs
-     */
-    folder: Folder.ConfiguredInstance | string;
-    /**
-     * An image path to display for the entry
-     */
-    img?: string;
-    /**
-     * A numeric sort value which orders this entry relative to others
-     */
-    sort?: string;
-  }
+  /**
+   * @deprecated {@link DirectoryApplicationMixin.Entry | `DirectoryApplicationMixin.Entry`}
+   */
+  type DirectoryMixinEntry = DirectoryApplicationMixin.Entry;
 
-  function DirectoryApplicationMixin<BaseApplication extends Application.AnyConstructor>(
+  function DirectoryApplicationMixin<BaseApplication extends DirectoryApplicationMixin.BaseClass>(
     Base: BaseApplication,
   ): Mixin<typeof DirectoryApplication, BaseApplication>;
+
+  namespace DirectoryApplicationMixin {
+    interface AnyMixedConstructor extends ReturnType<typeof DirectoryApplicationMixin<BaseClass>> {}
+    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
+
+    type BaseClass = Application.AnyConstructor;
+
+    interface Entry {
+      /**
+       * The unique id of the entry
+       */
+      id: string;
+      /**
+       * The folder id or folder object to which this entry belongs
+       */
+      folder: Folder.Implementation | string;
+      /**
+       * An image path to display for the entry
+       */
+      img?: string;
+      /**
+       * A numeric sort value which orders this entry relative to others
+       */
+      sort?: string;
+    }
+  }
 }

package/src/foundry/client/apps/sidebar/document-directory.d.mts

@@ -1,39 +1,25 @@
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
-  interface DocumentDirectoryOptions extends ApplicationOptions {
-    /**
-     * A list of data property keys that will trigger a rerender of the tab if
-     * they are updated on a Document that this tab is responsible for.
-     */
-    renderUpdateKeys?: string[];
-
-    /**
-     * The CSS selector that activates the context menu for displayed Documents.
-     */
-    contextMenuSelector?: string;
-
-    /**
-     * The CSS selector for the clickable area of an entry in the tab.
-     */
-    entryClickSelector?: string;
-  }
+  /** @deprecated {@link DocumentDirectory.Options | `DocumentDirectory.Options`} */
+  type DocumentDirectoryOptions<T extends Document.AnyConstructor = Document.AnyConstructor> =
+    DocumentDirectory.Options<T>;
 
-  class DocumentDirectory<
+  abstract class DocumentDirectory<
     FolderType extends foundry.CONST.FOLDER_DOCUMENT_TYPES,
-    Options extends DocumentDirectoryOptions = DocumentDirectoryOptions,
-  > extends DirectoryApplicationMixin(SidebarTab) {
+    Options extends DocumentDirectory.Options = DocumentDirectory.Options,
+  > extends DirectoryApplicationMixin(SidebarTab)<Options> {
     constructor(options: Options);
 
     /**
      * References to the set of Documents which are displayed in the Sidebar
      */
-    documents: FolderType extends Document.Type ? Document.ConfiguredInstanceForName<FolderType>[] : undefined;
+    documents: FolderType extends Document.Type ? Document.ImplementationFor<FolderType>[] : undefined;
 
     /**
      * Reference the set of Folders which exist in this Sidebar
      */
-    folders: (Folder.ConfiguredInstance & { type: FolderType })[] | null;
+    folders: (Folder.Implementation & { type: FolderType })[] | null;
 
     /**
      * A reference to the named Document type that this Sidebar Directory instance displays
@@ -54,7 +40,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): DocumentDirectoryOptions;
+    static override get defaultOptions(): DocumentDirectory.Options;
 
     override get title(): string;
 
@@ -64,6 +50,11 @@ declare global {
 
     static get collection(): WorldCollection<Document.AnyConstructor, string>;
 
+    /**
+     * The collection of Documents which are displayed in this Sidebar Directory
+     */
+    get collection(): Options["collection"];
+
     /**
      * Initialize the content of the directory by categorizing folders and documents into a hierarchical tree structure.
      */
@@ -87,20 +78,23 @@ declare global {
 
     protected override _handleDroppedEntry(target: HTMLElement, data: object): Promise<void>;
 
-    protected override _getDroppedEntryFromData(data: object): Promise<DirectoryMixinEntry>;
+    protected override _getDroppedEntryFromData(data: object): Promise<DirectoryApplicationMixin.Entry>;
 
     protected override _sortRelative(
-      entry: DirectoryMixinEntry,
+      entry: DirectoryApplicationMixin.Entry,
       sortData: { sortKey: string; sortBefore: boolean; updateData: object },
     ): Promise<object>;
 
-    protected override _createDroppedEntry(entry: DirectoryMixinEntry, folderId?: string): Promise<DirectoryMixinEntry>;
+    protected override _createDroppedEntry(
+      entry: DirectoryApplicationMixin.Entry,
+      folderId?: string,
+    ): Promise<DirectoryApplicationMixin.Entry>;
 
     protected override _handleDroppedForeignFolder(
-      folder: Folder.ConfiguredInstance,
+      folder: Folder.Implementation,
       closestFolderId: string,
       sortData: { sortKey: string; sortBefore: boolean },
-    ): Promise<{ folder: Folder; sortNeeded: boolean } | null>;
+    ): Promise<{ folder: Folder.Implementation; sortNeeded: boolean } | null>;
 
     /**
      * Create a dropped Folder and its children in this Collection, if they do not already exist
@@ -109,9 +103,9 @@ declare global {
      * @returns The created Folders
      */
     protected _createDroppedFolderContent(
-      folder: Folder.ConfiguredInstance,
-      targetFolder: Folder.ConfiguredInstance,
-    ): Promise<Array<Folder.ConfiguredInstance>>;
+      folder: Folder.Implementation,
+      targetFolder: Folder.Implementation,
+    ): Promise<Array<Folder.Implementation>>;
 
     /**
      * Organize a dropped Folder and its children into a list of folders to create and documents to create
@@ -119,10 +113,10 @@ declare global {
      * @param targetFolder - The Folder to which the Folder should be added
      */
     protected _organizeDroppedFoldersAndDocuments(
-      folder: Folder.ConfiguredInstance,
-      targetFolder: Folder.ConfiguredInstance,
+      folder: Folder.Implementation,
+      targetFolder: Folder.Implementation,
     ): Promise<{
-      foldersToCreate: Array<Folder.ConfiguredInstance>;
+      foldersToCreate: Array<Folder.Implementation>;
       documentsToCreate: Array<foundry.abstract.Document.Any>;
     }>;
 
@@ -132,17 +126,17 @@ declare global {
      * @param documentsToCreate - The documents to create
      */
     protected _createDroppedFolderDocuments(
-      folder: Folder.ConfiguredInstance,
+      folder: Folder.Implementation,
       documentsToCreate: Array<foundry.abstract.Document.Any>,
     ): Promise<void>;
 
-    protected override _getFolderContextOptions(): ContextMenuEntry[];
+    protected override _getFolderContextOptions(): ContextMenu.Entry[];
 
     /**
      * Get the set of ContextMenu options which should be used for Documents in a SidebarDirectory
      * @returns The Array of context options passed to the ContextMenu instance
      */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
+    protected _getEntryContextOptions(): ContextMenu.Entry[];
 
     /**
      * @deprecated since v11, will be removed in v13
@@ -158,6 +152,26 @@ declare global {
   }
 
   namespace DocumentDirectory {
-    type Any = DocumentDirectory<any, any>;
+    interface Any extends DocumentDirectory<any, any> {}
+
+    interface Options<T extends Document.AnyConstructor = Document.AnyConstructor> extends Application.Options {
+      /**
+       * A list of data property keys that will trigger a rerender of the tab if
+       * they are updated on a Document that this tab is responsible for.
+       */
+      renderUpdateKeys?: string[];
+
+      /**
+       * The CSS selector that activates the context menu for displayed Documents.
+       */
+      contextMenuSelector?: string;
+
+      /**
+       * The CSS selector for the clickable area of an entry in the tab.
+       */
+      entryClickSelector?: string;
+
+      collection: DocumentCollection<T, string>;
+    }
   }
 }

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

@@ -1,10 +1,10 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
+import type { MaybePromise } from "#utils";
 
 declare global {
   /** An application for configuring data across all installed and active packages. */
   abstract class PackageConfiguration<
     Options extends PackageConfiguration.Options = PackageConfiguration.Options,
-  > extends FormApplication<Options, object> {
+  > extends FormApplication<Options, FormApplication.NoObject> {
     /** @returns `["all", "core", "system", "module", "unmapped"]` */
     static get categoryOrder(): string[];
 
@@ -66,9 +66,9 @@ declare global {
   }
 
   namespace PackageConfiguration {
-    type Any = PackageConfiguration<any>;
+    interface Any extends PackageConfiguration<any> {}
 
-    interface Options extends FormApplicationOptions {
+    interface Options extends FormApplication.Options {
       categoryTemplate?: string;
       submitButton?: boolean;
     }

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

@@ -5,7 +5,7 @@ declare global {
    * An abstract pattern followed by the different tabs of the sidebar
    * @typeParam Options - The type of the options object
    */
-  abstract class SidebarTab<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  abstract class SidebarTab<Options extends Application.Options = Application.Options> extends Application<Options> {
     constructor(...args: ConstructorParameters<typeof Application>);
 
     /**
@@ -33,7 +33,7 @@ declare global {
      * });
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     override get id(): string;
 
@@ -75,6 +75,6 @@ declare global {
   }
 
   namespace SidebarTab {
-    type Any = SidebarTab<any>;
+    interface Any extends SidebarTab<any> {}
   }
 }

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

@@ -1,11 +1,11 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
+import type { MaybePromise, Identity } from "#utils";
 
 declare global {
   /**
    * Render the Sidebar container, and after rendering insert Sidebar tabs.
    * @typeParam Options - the type of the options object
    */
-  class Sidebar<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+  class Sidebar<Options extends Application.Options = Application.Options> extends Application<Options> {
     /**
      * Singleton application instances for each sidebar tab
      * @defaultValue `{}`
@@ -30,7 +30,7 @@ declare global {
      * }
      * ```
      */
-    static override get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): Application.Options;
 
     /**
      * Return the name of the active Sidebar tab
@@ -90,6 +90,11 @@ declare global {
   }
 
   namespace Sidebar {
-    type Any = Sidebar<any>;
+    interface Any extends AnySidebar {}
+    interface AnyConstructor extends Identity<typeof AnySidebar> {}
   }
 }
+
+declare abstract class AnySidebar extends Sidebar<Application.Options> {
+  constructor(...args: never);
+}

package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "#utils";
 
 declare global {
   /**
@@ -15,6 +15,15 @@ declare global {
 
     protected override _canDragDrop(selector: string): boolean;
 
-    protected override _getEntryContextOptions(): ContextMenuEntry[];
+    protected override _getEntryContextOptions(): ContextMenu.Entry[];
   }
+
+  namespace ActorDirectory {
+    interface Any extends AnyActorDirectory {}
+    interface AnyConstructor extends Identity<typeof AnyActorDirectory> {}
+  }
+}
+
+declare abstract class AnyActorDirectory extends ActorDirectory {
+  constructor(...args: never);
 }

package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "#utils";
 
 declare global {
   /**
@@ -7,6 +7,15 @@ declare global {
   class CardsDirectory extends DocumentDirectory<"Cards"> {
     static override documentName: "Cards";
 
-    protected override _getEntryContextOptions(): ContextMenuEntry[];
+    protected override _getEntryContextOptions(): ContextMenu.Entry[];
   }
+
+  namespace CardsDirectory {
+    interface Any extends AnyCardsDirectory {}
+    interface AnyConstructor extends Identity<typeof AnyCardsDirectory> {}
+  }
+}
+
+declare abstract class AnyCardsDirectory extends CardsDirectory {
+  constructor(...args: never);
 }