@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/applications/sheets/user-config.d.mts

@@ -0,0 +1,65 @@
+import type { DeepPartial, Identity } from "#utils";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type { CustomFormGroup } from "../forms/fields.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      UserConfig: UserConfig.Any;
+    }
+  }
+}
+
+/**
+ * The User configuration application.
+ */
+declare class UserConfig<
+  RenderContext extends object = UserConfig.RenderContext,
+  Configuration extends UserConfig.Configuration = UserConfig.Configuration,
+  RenderOptions extends UserConfig.RenderOptions = UserConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<
+  User.Implementation,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {
+  static override DEFAULT_OPTIONS: DocumentSheetV2.DefaultOptions;
+
+  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
+
+  get title(): string;
+
+  protected override _prepareContext(options: DeepPartial<RenderOptions>): Promise<RenderContext>;
+
+  /**
+   * @privateRemarks Prevents duck typing
+   */
+  #private: true;
+}
+
+declare namespace UserConfig {
+  interface Any extends AnyUserConfig {}
+  interface AnyConstructor extends Identity<typeof AnyUserConfig> {}
+
+  interface RenderContext
+    extends HandlebarsApplicationMixin.RenderContext,
+      DocumentSheetV2.RenderContext<User.Implementation> {
+    user: User.Implementation;
+    source: foundry.documents.BaseUser.Source;
+    fields: foundry.documents.BaseUser.Schema;
+    characterWidget: CustomFormGroup;
+  }
+
+  interface Configuration
+    extends HandlebarsApplicationMixin.Configuration,
+      DocumentSheetV2.Configuration<User.Implementation> {}
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, DocumentSheetV2.RenderOptions {}
+}
+
+declare abstract class AnyUserConfig extends UserConfig<object, UserConfig.Configuration, UserConfig.RenderOptions> {
+  constructor(...args: never);
+}
+
+export default UserConfig;

package/src/foundry/client/applications/sheets/wall-config.d.mts

@@ -0,0 +1,51 @@
+import type { Identity } from "#utils";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      WallConfig: WallConfig.Any;
+    }
+  }
+}
+
+/**
+ * The Application responsible for configuring a single Wall document within a parent Scene.
+ * @remarks TODO: Stub
+ */
+declare class WallConfig<
+  RenderContext extends WallConfig.RenderContext = WallConfig.RenderContext,
+  Configuration extends WallConfig.Configuration = WallConfig.Configuration,
+  RenderOptions extends WallConfig.RenderOptions = WallConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<
+  WallDocument.Implementation,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}
+
+declare namespace WallConfig {
+  interface Any extends AnyWallConfig {}
+  interface AnyConstructor extends Identity<typeof AnyWallConfig> {}
+
+  interface RenderContext
+    extends HandlebarsApplicationMixin.RenderContext,
+      DocumentSheetV2.RenderContext<WallDocument.Implementation> {}
+
+  interface Configuration
+    extends HandlebarsApplicationMixin.Configuration,
+      DocumentSheetV2.Configuration<WallDocument.Implementation> {}
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, DocumentSheetV2.RenderOptions {}
+}
+
+declare abstract class AnyWallConfig extends WallConfig<
+  WallConfig.RenderContext,
+  WallConfig.Configuration,
+  WallConfig.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default WallConfig;

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

@@ -0,0 +1,44 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.mjs";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      ChatPopout: ChatPopout.Any;
+    }
+  }
+}
+
+/**
+ * A simple application for rendering a single chat message in its own frame.
+ * @remarks TODO: Stub
+ */
+declare class ChatPopout<
+  RenderContext extends ChatPopout.RenderContext = ChatPopout.RenderContext,
+  Configuration extends ChatPopout.Configuration = ChatPopout.Configuration,
+  RenderOptions extends ChatPopout.RenderOptions = ChatPopout.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ChatPopout {
+  interface Any extends AnyChatPopout {}
+  interface AnyConstructor extends Identity<typeof AnyChatPopout> {}
+
+  interface RenderContext extends ApplicationV2.RenderContext {}
+
+  interface Configuration extends ApplicationV2.Configuration {
+    /** The message being rendered. */
+    message: ChatMessage.Implementation;
+  }
+
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyChatPopout extends ChatPopout<
+  ChatPopout.RenderContext,
+  ChatPopout.Configuration,
+  ChatPopout.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ChatPopout;

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

@@ -0,0 +1,44 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type DocumentDirectory from "../document-directory.d.mts";
+
+import Document = foundry.abstract.Document;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      Compendium: Compendium.Any;
+    }
+  }
+}
+
+/**
+ * An Application that displays the indexed contents of a Compendium pack.
+ * @remarks TODO: Stub
+ */
+declare class Compendium<
+  DocumentClass extends Document.AnyConstructor = Document.AnyConstructor,
+  RenderContext extends Compendium.RenderContext = Compendium.RenderContext,
+  Configuration extends Compendium.Configuration = Compendium.Configuration,
+  RenderOptions extends Compendium.RenderOptions = ApplicationV2.RenderOptions,
+> extends DocumentDirectory<DocumentClass, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace Compendium {
+  interface Any extends AnyCompendium {}
+  interface AnyConstructor extends Identity<typeof AnyCompendium> {}
+
+  interface RenderContext extends DocumentDirectory.RenderContext {}
+  interface Configuration extends DocumentDirectory.Configuration {}
+  interface RenderOptions extends DocumentDirectory.RenderOptions {}
+}
+
+declare abstract class AnyCompendium extends Compendium<
+  Document.AnyConstructor,
+  Compendium.RenderContext,
+  Compendium.Configuration,
+  Compendium.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default Compendium;

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

@@ -0,0 +1,49 @@
+import type { Identity } from "#utils";
+import type CategoryBrowser from "../../api/category-browser.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      ControlsConfig: ControlsConfig.Any;
+    }
+  }
+}
+
+/**
+ * View and edit keybinding and (readonly) mouse actions.
+ * @remarks TODO: Stub
+ */
+declare class ControlsConfig<
+  Entry extends ControlsConfig.Entry = ControlsConfig.Entry,
+  RenderContext extends ControlsConfig.RenderContext<Entry> = ControlsConfig.RenderContext<Entry>,
+  Configuration extends ControlsConfig.Configuration = ControlsConfig.Configuration,
+  RenderOptions extends ControlsConfig.RenderOptions = ControlsConfig.RenderOptions,
+> extends CategoryBrowser<Entry, RenderContext, Configuration, RenderOptions> {
+  protected _prepareCategoryData(): Promise<Record<string, CategoryBrowser.CategoryData<Entry>>>;
+}
+
+declare namespace ControlsConfig {
+  interface Any extends AnyControlsConfig {}
+  interface AnyConstructor extends Identity<typeof AnyControlsConfig> {}
+
+  // TODO: Interface is a stub
+  interface Entry {
+    id: string;
+  }
+
+  interface RenderContext<Entry> extends CategoryBrowser.RenderContext<Entry> {}
+
+  interface Configuration extends CategoryBrowser.Configuration {}
+  interface RenderOptions extends CategoryBrowser.RenderOptions {}
+}
+
+declare abstract class AnyControlsConfig extends ControlsConfig<
+  ControlsConfig.Entry,
+  ControlsConfig.RenderContext<ControlsConfig.Entry>,
+  ControlsConfig.Configuration,
+  ControlsConfig.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ControlsConfig;

package/src/foundry/client/applications/sidebar/apps/folder-export.d.mts

@@ -0,0 +1,40 @@
+import type { Identity } from "#utils";
+import type DialogV2 from "../../api/dialog.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      FolderExport: FolderExport.Any;
+    }
+  }
+}
+
+/**
+ * A Dialog subclass that allows the user to configure export options for a Folder
+ */
+declare class FolderExport<
+  RenderContext extends FolderExport.RenderContext = FolderExport.RenderContext,
+  Configuration extends FolderExport.Configuration = FolderExport.Configuration,
+  RenderOptions extends FolderExport.RenderOptions = FolderExport.RenderOptions,
+> extends DialogV2<RenderContext, Configuration, RenderOptions> {
+  #FolderExport: true;
+}
+
+declare namespace FolderExport {
+  interface Any extends AnyFolderExport {}
+  interface AnyConstructor extends Identity<typeof AnyFolderExport> {}
+
+  interface RenderContext extends DialogV2.RenderContext {}
+  interface Configuration extends DialogV2.Configuration {}
+  interface RenderOptions extends DialogV2.RenderOptions {}
+}
+
+declare abstract class AnyFolderExport extends FolderExport<
+  FolderExport.RenderContext,
+  FolderExport.Configuration,
+  FolderExport.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default FolderExport;

package/src/foundry/client/applications/sidebar/apps/frame-viewer.d.mts

@@ -0,0 +1,44 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.mjs";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      FrameViewer: FrameViewer.Any;
+    }
+  }
+}
+
+/**
+ * A simple window application which shows the built documentation pages within an iframe
+ * @remarks TODO: Stub
+ */
+declare class FrameViewer<
+  RenderContext extends FrameViewer.RenderContext = FrameViewer.RenderContext,
+  Configuration extends FrameViewer.Configuration = FrameViewer.Configuration,
+  RenderOptions extends FrameViewer.RenderOptions = FrameViewer.RenderOptions,
+> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace FrameViewer {
+  interface Any extends AnyFrameViewer {}
+  interface AnyConstructor extends Identity<typeof AnyFrameViewer> {}
+
+  interface RenderContext extends ApplicationV2.RenderContext {}
+
+  interface Configuration extends ApplicationV2.Configuration {
+    /** The initial URL to navigate to */
+    url: string;
+  }
+
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyFrameViewer extends FrameViewer<
+  FrameViewer.RenderContext,
+  FrameViewer.Configuration,
+  FrameViewer.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default FrameViewer;

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

@@ -0,0 +1,39 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      InvitationLinks: InvitationLinks.Any;
+    }
+  }
+}
+
+/**
+ * @remarks TODO: Stub
+ */
+declare class InvitationLinks<
+  RenderContext extends InvitationLinks.RenderContext = InvitationLinks.RenderContext,
+  Configuration extends InvitationLinks.Configuration = InvitationLinks.Configuration,
+  RenderOptions extends InvitationLinks.RenderOptions = InvitationLinks.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace InvitationLinks {
+  interface Any extends AnyInvitationLinks {}
+  interface AnyConstructor extends Identity<typeof AnyInvitationLinks> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, ApplicationV2.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyInvitationLinks extends InvitationLinks<
+  InvitationLinks.RenderContext,
+  InvitationLinks.Configuration,
+  InvitationLinks.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default InvitationLinks;

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

@@ -0,0 +1,42 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      ModuleManagement: ModuleManagement.Any;
+    }
+  }
+}
+
+/**
+ * The Module Management Application.
+ * This application provides a view of which modules are available to be used and allows for configuration of the
+ * set of modules which are active within the World.
+ * @remarks TODO: Stub
+ */
+declare class ModuleManagement<
+  RenderContext extends ModuleManagement.RenderContext = ModuleManagement.RenderContext,
+  Configuration extends ModuleManagement.Configuration = ModuleManagement.Configuration,
+  RenderOptions extends ModuleManagement.RenderOptions = ModuleManagement.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace ModuleManagement {
+  interface Any extends AnyModuleManagement {}
+  interface AnyConstructor extends Identity<typeof AnyModuleManagement> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, ApplicationV2.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyModuleManagement extends ModuleManagement<
+  ModuleManagement.RenderContext,
+  ModuleManagement.Configuration,
+  ModuleManagement.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ModuleManagement;

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

@@ -0,0 +1,39 @@
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+import type { Identity } from "#utils";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      SupportDetails: SupportDetails.Any;
+    }
+  }
+}
+
+/**
+ * @remarks TODO: Stub
+ */
+declare class SupportDetails<
+  RenderContext extends SupportDetails.RenderContext = SupportDetails.RenderContext,
+  Configuration extends SupportDetails.Configuration = SupportDetails.Configuration,
+  RenderOptions extends SupportDetails.RenderOptions = SupportDetails.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace SupportDetails {
+  interface Any extends AnySupportDetails {}
+  interface AnyConstructor extends Identity<typeof AnySupportDetails> {}
+
+  interface RenderContext extends ApplicationV2.RenderContext {}
+  interface Configuration extends ApplicationV2.Configuration {}
+  interface RenderOptions extends ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnySupportDetails extends SupportDetails<
+  SupportDetails.RenderContext,
+  SupportDetails.Configuration,
+  SupportDetails.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default SupportDetails;

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

@@ -0,0 +1,61 @@
+import type { Identity } from "#utils";
+import type CategoryBrowser from "../../api/category-browser.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      ToursManagement: ToursManagement.Any;
+    }
+  }
+}
+
+/**
+ * A management app for configuring which Tours are available or have been completed.
+ */
+declare class ToursManagement<
+  Entry extends ToursManagement.Entry = ToursManagement.Entry,
+  RenderContext extends ToursManagement.RenderContext<Entry> = ToursManagement.RenderContext<Entry>,
+  Configuration extends ToursManagement.Configuration = ToursManagement.Configuration,
+  RenderOptions extends ToursManagement.RenderOptions = ToursManagement.RenderOptions,
+> extends CategoryBrowser<Entry, RenderContext, Configuration, RenderOptions> {
+  static override DEFAULT_OPTIONS: Partial<CategoryBrowser.Configuration>;
+  protected override _prepareCategoryData(): Promise<Record<string, CategoryBrowser.CategoryData<Entry>>>;
+  protected override _sortCategories(
+    a: CategoryBrowser.CategoryData<Entry>,
+    b: CategoryBrowser.CategoryData<Entry>,
+  ): number;
+
+  #toursManagement: true;
+}
+
+declare namespace ToursManagement {
+  interface Any extends AnyToursManagement {}
+  interface AnyConstructor extends Identity<typeof AnyToursManagement> {}
+
+  interface Entry {
+    id: string;
+    label: string;
+    completed: boolean;
+    hint: string;
+    status: string;
+    canPlay?: boolean | undefined;
+    startOrResume?: string | undefined;
+    canReset?: boolean | undefined;
+  }
+
+  interface RenderContext<Entry> extends CategoryBrowser.RenderContext<Entry> {}
+
+  interface Configuration extends CategoryBrowser.Configuration {}
+  interface RenderOptions extends CategoryBrowser.RenderOptions {}
+}
+
+declare abstract class AnyToursManagement extends ToursManagement<
+  ToursManagement.Entry,
+  ToursManagement.RenderContext<ToursManagement.Entry>,
+  ToursManagement.Configuration,
+  ToursManagement.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default ToursManagement;

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

@@ -0,0 +1,40 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      WorldConfig: WorldConfig.Any;
+    }
+  }
+}
+
+/**
+ * The World Management setup application
+ * @remarks TODO: Stub
+ */
+declare class WorldConfig<
+  RenderContext extends WorldConfig.RenderContext = WorldConfig.RenderContext,
+  Configuration extends WorldConfig.Configuration = WorldConfig.Configuration,
+  RenderOptions extends WorldConfig.RenderOptions = WorldConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
+
+declare namespace WorldConfig {
+  interface Any extends AnyWorldConfig {}
+  interface AnyConstructor extends Identity<typeof AnyWorldConfig> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, ApplicationV2.RenderContext {}
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyWorldConfig extends WorldConfig<
+  WorldConfig.RenderContext,
+  WorldConfig.Configuration,
+  WorldConfig.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default WorldConfig;

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

@@ -0,0 +1,55 @@
+import type { Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type AbstractSidebarTab from "./sidebar-tab.d.mts";
+
+import Document = foundry.abstract.Document;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      DocumentDirectory: DocumentDirectory.Any;
+    }
+  }
+}
+
+/**
+ * An abstract class for rendering a foldered directory of Documents.
+ * @remarks TODO: Stub
+ */
+declare class DocumentDirectory<
+  DocumentClass extends Document.AnyConstructor = Document.AnyConstructor,
+  RenderContext extends DocumentDirectory.RenderContext = DocumentDirectory.RenderContext,
+  Configuration extends DocumentDirectory.Configuration = DocumentDirectory.Configuration,
+  RenderOptions extends DocumentDirectory.RenderOptions = DocumentDirectory.RenderOptions,
+> extends HandlebarsApplicationMixin(AbstractSidebarTab)<RenderContext, Configuration, RenderOptions> {
+  get documentClass(): DocumentClass;
+}
+
+declare namespace DocumentDirectory {
+  interface Any extends AnyDocumentDirectory {}
+  interface AnyConstructor extends Identity<typeof AnyDocumentDirectory> {}
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, AbstractSidebarTab.RenderContext {}
+
+  interface Configuration extends HandlebarsApplicationMixin.RenderContext, ApplicationV2.Configuration {
+    /** The Document collection that this directory represents. */
+    collection: foundry.documents.abstract.DirectoryCollectionMixin.AnyMixed;
+
+    /** Updating one of these properties of a displayed Document will trigger a re-render of the tab. */
+    renderUpdateKeys: string[];
+  }
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+}
+
+declare abstract class AnyDocumentDirectory extends DocumentDirectory<
+  Document.AnyConstructor,
+  DocumentDirectory.RenderContext,
+  DocumentDirectory.Configuration,
+  DocumentDirectory.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default DocumentDirectory;