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

package/src/foundry/client-esm/applications/api/handlebars-application.d.mts

@@ -1,210 +0,0 @@
-import type { DeepPartial, FixedInstanceType, Mixin } from "fvtt-types/utils";
-import type ApplicationV2 from "./application.d.mts";
-import type DocumentSheetV2 from "./document-sheet.d.mts";
-
-/**
- * Augment an Application class with [Handlebars](https://handlebarsjs.com) template rendering behavior.
- */
-declare function HandlebarsApplicationMixin<BaseClass extends HandlebarsApplicationMixin.BaseClass>(
-  BaseApplication: BaseClass,
-): Mixin<typeof HandlebarsApplicationMixin.HandlebarsApplication, BaseClass>;
-
-declare namespace HandlebarsApplicationMixin {
-  type AnyMixedConstructor = ReturnType<typeof HandlebarsApplicationMixin<BaseClass>>;
-  interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
-
-  type BaseClass = ApplicationV2.Internal.Constructor;
-
-  interface PartState {
-    scrollPositions: Array<[el1: HTMLElement, scrollTop: number, scrollLeft: number]>;
-    focus?: string | undefined;
-  }
-
-  interface RenderOptions {
-    parts: string[];
-  }
-  interface ApplicationV2RenderOptions extends RenderOptions, ApplicationV2.RenderOptions {}
-  interface DocumentSheetV2RenderOptions extends RenderOptions, DocumentSheetV2.RenderOptions {}
-
-  interface HandlebarsTemplatePart {
-    /**
-     * The template entry-point for the part
-     */
-    template: string;
-
-    /**
-     * A CSS id to assign to the top-level element of the rendered part.
-     * This id string is automatically prefixed by the application id.
-     */
-    id?: string | null | undefined;
-
-    /**
-     * Does this rendered contents of this template part replace the children of the root element?
-     */
-    root?: boolean | null | undefined;
-
-    /**
-     * An array of CSS classes to apply to the top-level element of the
-     * rendered part.
-     */
-    classes?: string[] | null | undefined;
-
-    /**
-     * An array of additional templates that are required to render the part.
-     * If omitted, only the entry-point is inferred as required.
-     */
-    templates?: string[] | null | undefined;
-
-    /**
-     * An array of selectors within this part whose scroll positions should
-     * be persisted during a re-render operation. A blank string is used
-     * to denote that the root level of the part is scrollable.
-     */
-    scrollable?: string[] | null | undefined;
-
-    /**
-     * A registry of forms selectors and submission handlers.
-     */
-    forms?: Record<string, ApplicationV2.FormConfiguration> | null | undefined;
-  }
-
-  namespace HandlebarsApplication {
-    // Note(LukeAbby): `unknown` is returned in the false case instead of `never` because otherwise errors will crop up at usage sites like "any cannot be assigned to `never`".
-    type ConfigurationFor<Instance extends HandlebarsApplication> =
-      Instance extends ApplicationV2.Internal.Instance<infer Configuration, infer _1, infer _2>
-        ? Configuration
-        : unknown;
-
-    type RenderOptionsFor<Instance extends HandlebarsApplication> =
-      Instance extends ApplicationV2.Internal.Instance<infer _1, infer RenderOptions, infer _2>
-        ? RenderOptions
-        : object;
-
-    type RenderContextFor<Instance extends HandlebarsApplication> =
-      Instance extends ApplicationV2.Internal.Instance<infer _1, infer _2, infer RenderContext>
-        ? RenderContext
-        : object;
-  }
-
-  /**
-   * The mixed application class augmented with [Handlebars](https://handlebarsjs.com) template rendering behavior.
-   *
-   * @remarks This does NOT exist at runtime. This is only here to be used as a type when relevant as well as to avoid
-   * issues with anonymous mixin classes.
-   */
-  class HandlebarsApplication {
-    /** @privateRemarks All mixin classses should accept anything for its constructor. */
-    constructor(...args: any[]);
-
-    /**
-     * Configure a registry of template parts which are supported for this application for partial rendering.
-     * @defaultValue `{}`
-     */
-    static PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
-
-    /**
-     * A record of all rendered template parts.
-     * @defaultValue `{}`
-     */
-    get parts(): Record<string, HTMLElement>;
-
-    protected _configureRenderOptions(options: DeepPartial<HandlebarsApplicationMixin.RenderOptions>): void;
-
-    /**
-     * Allow subclasses to dynamically configure render parts.
-     */
-    protected _configureRenderParts(
-      options: HandlebarsApplicationMixin.RenderOptions,
-    ): Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
-
-    protected _preFirstRender(
-      context: DeepPartial<HandlebarsApplication.RenderContextFor<this>>,
-      options: DeepPartial<HandlebarsApplication.RenderOptionsFor<this>>,
-    ): Promise<void>;
-
-    /**
-     * Render each configured application part using Handlebars templates.
-     * @param context - Context data for the render operation
-     * @param options - Options which configure application rendering behavior
-     * @returns A single rendered HTMLElement for each requested part
-     */
-    protected _renderHTML(
-      context: HandlebarsApplication.RenderContextFor<this>,
-      options: DeepPartial<HandlebarsApplication.RenderOptionsFor<this>>,
-    ): Promise<Record<string, HTMLElement>>;
-
-    /**
-     * Prepare context that is specific to only a single rendered part.
-     *
-     * It is recommended to augment or mutate the shared context so that downstream methods like _onRender have
-     * visibility into the data that was used for rendering. It is acceptable to return a different context object
-     * rather than mutating the shared context at the expense of this transparency.
-     *
-     * @param partId  - The part being rendered
-     * @param context - Shared context provided by _prepareContext
-     * @param options - Options which configure application rendering behavior
-     * @returns Context data for a specific part
-     */
-    protected _preparePartContext(
-      partId: string,
-      context: HandlebarsApplication.RenderContextFor<this>,
-      options: DeepPartial<HandlebarsApplicationMixin.RenderOptions>,
-    ): Promise<HandlebarsApplication.RenderContextFor<this>>;
-
-    /**
-     * Replace the HTML of the application with the result provided by Handlebars rendering.
-     * @param result  - The result from Handlebars template rendering
-     * @param content - The content element into which the rendered result must be inserted
-     * @param options - Options which configure application rendering behavior
-     */
-    protected _replaceHTML(
-      result: Record<string, HTMLElement>,
-      content: HTMLElement,
-      options: DeepPartial<HandlebarsApplication.RenderOptionsFor<this>>,
-    ): void;
-
-    /**
-     * Prepare data used to synchronize the state of a template part.
-     * @param partId       - The id of the part being rendered
-     * @param newElement   - The new rendered HTML element for the part
-     * @param priorElement - The prior rendered HTML element for the part
-     * @param state        - A state object which is used to synchronize after replacement
-     */
-    protected _preSyncPartState(
-      partId: string,
-      newElement: HTMLElement,
-      priorElement: HTMLElement,
-      state: HandlebarsApplicationMixin.PartState,
-    ): void;
-
-    /**
-     * Synchronize the state of a template part after it has been rendered and replaced in the DOM.
-     * @param partId       - The id of the part being rendered
-     * @param newElement   - The new rendered HTML element for the part
-     * @param priorElement - The prior rendered HTML element for the part
-     * @param state        - A state object which is used to synchronize after replacement
-     */
-    protected _syncPartState(
-      partId: string,
-      newElement: HTMLElement,
-      priorElement: HTMLElement,
-      state: HandlebarsApplicationMixin.PartState,
-    ): void;
-
-    protected _tearDown(options: DeepPartial<ApplicationV2.ClosingOptions>): void;
-
-    /**
-     * Attach event listeners to rendered template parts.
-     * @param partId      - The id of the part being rendered
-     * @param htmlElement - The rendered HTML element for the part
-     * @param options     - Rendering options passed to the render method
-     */
-    protected _attachPartListeners(
-      partId: string,
-      htmlElement: HTMLElement,
-      options: DeepPartial<HandlebarsApplicationMixin.RenderOptions>,
-    ): void;
-  }
-}
-
-export default HandlebarsApplicationMixin;

package/src/foundry/client-esm/applications/apps/av/camera-popout.d.mts

@@ -1,23 +0,0 @@
-import type ApplicationV2 from "../../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
-
-/**
- * An application for a single popped-out camera.
- * @remarks TODO: Stub
- */
-declare class CameraPopout<
-  RenderContext extends CameraPopout.RenderContext = CameraPopout.RenderContext,
-  Configuration extends CameraPopout.Configuration = CameraPopout.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
-
-declare namespace CameraPopout {
-  interface Configuration extends ApplicationV2.Configuration {
-    user: User.ConfiguredInstance;
-  }
-
-  interface RenderContext extends ApplicationV2.RenderContext {}
-}
-
-export default CameraPopout;

package/src/foundry/client-esm/applications/apps/av/cameras.d.mts

@@ -1,95 +0,0 @@
-import type ApplicationV2 from "../../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../../api/handlebars-application.d.mts";
-
-/**
- * An application that shows docked camera views.
- * @remarks TODO: Stub
- */
-declare class CameraViews<
-  RenderContext extends CameraViews.RenderContext = CameraViews.RenderContext,
-  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
-
-declare namespace CameraViews {
-  interface RenderContext extends ApplicationV2.RenderContext {}
-
-  interface ControlContext {
-    icon: string;
-    label: string;
-    display: boolean;
-  }
-
-  interface UserContext {
-    /** The User instance. */
-    user: User;
-
-    /** The user's AV settings. */
-    settings: AVSettingsData;
-
-    /** Whether the user's AV stream is local. */
-    local: boolean;
-
-    /** The user's character name. */
-    charname: string;
-
-    /** The CSS class of the user's camera dock. */
-    css: string;
-
-    /** Whether the user is broadcasting video. */
-    hasVideo: boolean;
-
-    /** Whether the user is broadcasting audio. */
-    hasAudio: boolean;
-
-    /** Whether the main camera dock is hidden. */
-    hidden: boolean;
-
-    nameplates: Nameplates;
-
-    video: Video;
-
-    volume: Volume;
-
-    controls: Record<string, ControlContext>;
-  }
-
-  interface Nameplates {
-    /** Whether camera nameplates are entirely hidden. */
-    hidden: boolean;
-
-    /** Nameplate CSS classes. */
-    css: string;
-
-    /** Whether to show player names on nameplates. */
-    playerName: string;
-
-    /** Whether to show character names on nameplates. */
-    charname: string;
-  }
-
-  interface Video {
-    /** The video stream's volume. */
-    volume: number;
-
-    /** Whether to mute the video stream's audio. */
-    muted: boolean;
-
-    /** Whether to show this user's camera. */
-    show: boolean;
-  }
-
-  interface Volume {
-    /** The user's configured volume level. */
-    value: number;
-
-    /** The volume range field. */
-    field: foundry.data.fields.DataField.Any;
-
-    /** Whether to show a volume bar for this user. */
-    show: boolean;
-  }
-}
-
-export default CameraViews;

package/src/foundry/client-esm/applications/apps/combat-tracker-config.d.mts

@@ -1,21 +0,0 @@
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-/**
- * The Application responsible for configuring the CombatTracker and its contents.
- * @remarks TODO: Stub
- */
-declare class CombatTrackerConfig<
-  RenderContext extends CombatTrackerConfig.RenderContext = CombatTrackerConfig.RenderContext,
-  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
-
-declare namespace CombatTrackerConfig {
-  interface RenderContext {
-    rootId: string;
-  }
-}
-
-export default CombatTrackerConfig;

package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts

@@ -1,54 +0,0 @@
-import type { ConformRecord, InterfaceToObject, MustConform, DeepPartial } from "fvtt-types/utils";
-import type { CompendiumArtDescriptor } from "../../helpers/_types.d.mts";
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-type CompendiumArtConfigRenderContext = InterfaceToObject<CompendiumArtConfig.RenderContext>;
-
-type CompendiumArtConfigParts = ConformRecord<
-  CompendiumArtConfig.Parts,
-  HandlebarsApplicationMixin.HandlebarsTemplatePart
->;
-
-/**
- * An application for configuring compendium art priorities.
- */
-declare class CompendiumArtConfig<
-  RenderContext extends CompendiumArtConfigRenderContext = CompendiumArtConfigRenderContext,
-  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  // placeholder private member to help subclassing
-  #compendiumArtConfig: true;
-
-  static override DEFAULT_OPTIONS: Partial<ApplicationV2.Configuration>;
-  static override PARTS: CompendiumArtConfigParts;
-
-  /* -------------------------------------------- */
-  /*  Rendering                                   */
-  /* -------------------------------------------- */
-
-  override _prepareContext(
-    _options: DeepPartial<HandlebarsApplicationMixin.ApplicationV2RenderOptions>,
-  ): Promise<RenderContext>;
-}
-
-declare namespace CompendiumArtConfig {
-  interface RenderContext {
-    config: CompendiumArtDescriptor[];
-    buttons: ApplicationV2.FormFooterButton[];
-  }
-
-  interface Parts {
-    priorities: HandlebarsApplicationMixin.HandlebarsTemplatePart;
-    footer: HandlebarsApplicationMixin.HandlebarsTemplatePart;
-  }
-}
-
-type _PartsMustBeValid = MustConform<
-  InterfaceToObject<CompendiumArtConfig.Parts>,
-  Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>
->;
-
-export default CompendiumArtConfig;

package/src/foundry/client-esm/applications/apps/document-ownership.d.mts

@@ -1,21 +0,0 @@
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-import type DocumentSheetV2 from "../api/document-sheet.d.mts";
-
-/**
- * A generic application for configuring permissions for various Document types.
- * @remarks TODO: Stub
- */
-declare class DocumentOwnershipConfig<
-  Document extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-  RenderContext extends object = DocumentOwnershipConfig.RenderContext<Document>,
-  Configuration extends DocumentSheetV2.Configuration<Document> = DocumentSheetV2.Configuration<Document>,
-  RenderOptions extends
-    HandlebarsApplicationMixin.DocumentSheetV2RenderOptions = HandlebarsApplicationMixin.DocumentSheetV2RenderOptions,
-> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {}
-
-declare namespace DocumentOwnershipConfig {
-  interface RenderContext<Document extends foundry.abstract.Document.Any = foundry.abstract.Document.Any>
-    extends DocumentSheetV2.RenderContext<Document> {}
-}
-
-export default DocumentOwnershipConfig;

package/src/foundry/client-esm/applications/apps/document-sheet-config.d.mts

@@ -1,24 +0,0 @@
-import type DocumentSheetV2 from "../api/document-sheet.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-/**
- * An Application for configuring Document sheet settings.
- * @remarks TODO: Stub
- */
-declare class DocumentSheetConfig<
-  Document extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
-  RenderContext extends DocumentSheetConfig.RenderContext<Document> = DocumentSheetConfig.RenderContext<Document>,
-  Configuration extends DocumentSheetConfig.Configuration<Document> = DocumentSheetConfig.Configuration<Document>,
-  RenderOptions extends
-    HandlebarsApplicationMixin.DocumentSheetV2RenderOptions = HandlebarsApplicationMixin.DocumentSheetV2RenderOptions,
-> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {}
-
-declare namespace DocumentSheetConfig {
-  interface RenderContext<Document extends foundry.abstract.Document.Any>
-    extends DocumentSheetV2.RenderContext<Document> {}
-
-  interface Configuration<Document extends foundry.abstract.Document.Any>
-    extends DocumentSheetV2.Configuration<Document> {}
-}
-
-export default DocumentSheetConfig;