@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 13.340.0

package/src/foundry/client-esm/applications/ux/context-menu.d.mts

@@ -0,0 +1,359 @@
+import type { InexactPartial } from "../../../../utils/index.d.mts";
+import type ApplicationV2 from "../api/application.d.mts";
+
+declare global {
+  /**
+   * @deprecated Use {@link foundry.applications.ux.ContextMenu.Entry | `foundry.applications.ux.ContextMenu.Entry`}
+   */
+  type ContextMenuEntry = ContextMenu.Entry<JQuery>;
+}
+
+/**
+ * Display a right-click activated Context Menu which provides a dropdown menu of options.
+ * A ContextMenu is constructed by designating a parent HTML container and a target selector.
+ * An Array of menuItems defines the entries of the menu which is displayed.
+ * TODO: Rework again; this was written for 13.337
+ */
+declare class ContextMenu<UsesJQuery extends boolean = true> {
+  /**
+   * @param element   - The containing HTML element within which the menu is positioned
+   * @param selector  - A CSS selector which activates the context menu.
+   * @param menuItems - An Array of entries to display in the menu
+   * @param options   - Additional options to configure the context menu.
+   */
+  constructor(
+    element: JQuery | HTMLElement,
+    selector: string | null | undefined,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options: ContextMenu.ConstructorOptions<UsesJQuery>,
+  );
+
+  /**
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects.
+   * You may temporarily pass the jQuery option to nominate a behavior.
+   * In v14 the default will become false."
+   */
+  constructor(
+    element: JQuery | HTMLElement,
+    selector: string | null | undefined,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options?: InexactPartial<ContextMenu.ConstructorOptions<UsesJQuery>, "jQuery">,
+  );
+
+  /**
+   * Create a ContextMenu for this Application and dispatch hooks.
+   * @param app       - The Application this ContextMenu belongs to.
+   * @param html      - The Application's rendered HTML.
+   * @param selector  - The target CSS selector which activates the menu.
+   * @param menuItems - The array of menu items being rendered.
+   * @param options   - Additional options to configure context menu initialization.
+   *                    (default: `"EntryContext"`)
+   */
+  static create<UsesJQuery extends boolean = true>(
+    app: Application.Any,
+    html: JQuery | HTMLElement,
+    selector: string,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options: ContextMenu.CreateOptions<UsesJQuery>,
+  ): ContextMenu<UsesJQuery>;
+
+  /**
+   * @deprecated "ContextMenu is changing to no longer transact jQuery objects.
+   * You may temporarily pass the jQuery option to nominate a behavior.
+   * In v14 the default will become false."
+   */
+  static create(
+    app: Application.Any,
+    html: JQuery | HTMLElement,
+    selector: string,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<true>>[],
+    options?: InexactPartial<ContextMenu.CreateOptions<true>, "jQuery">,
+  ): ContextMenu<true>;
+
+  /**
+   * @deprecated - `ContextMenu.create` no longer accepts the menuItems argument for ApplicationV2 applications.
+   * Instead it calls the `_get${hookName}Options` function, which defaults to `_getEntryContextOptions`
+   *
+   * @deprecated - "ContextMenu is changing to no longer transact jQuery objects.
+   * You may temporarily pass the jQuery option to nominate a behavior.
+   * In v14 the default will become false."
+   */
+  static create<UsesJQuery extends boolean = true>(
+    app: ApplicationV2.Any,
+    html: JQuery | HTMLElement,
+    selector: string,
+    menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[],
+    options?: InexactPartial<ContextMenu.CreateOptions<UsesJQuery>, "jQuery">,
+  ): ContextMenu<UsesJQuery>;
+
+  /**
+   * @deprecated - "ContextMenu is changing to no longer transact jQuery objects.
+   * You may temporarily pass the jQuery option to nominate a behavior.
+   * In v14 the default will become false."
+   */
+  static create(
+    app: ApplicationV2.Any,
+    html: JQuery | HTMLElement,
+    selector: string,
+    options?: InexactPartial<ContextMenu.CreateOptions<true>, "jQuery">,
+  ): ContextMenu<true>;
+
+  static create<UsesJQuery extends boolean = true>(
+    app: ApplicationV2.Any,
+    html: JQuery | HTMLElement,
+    selector: string,
+    options: ContextMenu.CreateOptions<UsesJQuery>,
+  ): ContextMenu<UsesJQuery>;
+
+  /**
+   * The menu element.
+   */
+  get element(): HTMLElement;
+
+  /**
+   * A CSS selector to identify context menu targets.
+   */
+  get selector(): string;
+
+  /**
+   * The event name to listen for.
+   */
+  get eventName(): string;
+
+  /**
+   * The array of menu items to render.
+   */
+  menuItems: ContextMenu.Entry<ContextMenu.JQueryOrHTML<UsesJQuery>>[];
+
+  /**
+   * A function to call when the context menu is opened.
+   */
+  onOpen: ContextMenu.ContextMenuCallback | null | undefined;
+
+  /**
+   * A function to call when the context menu is closed.
+   */
+  onClose: ContextMenu.ContextMenuCallback | null | undefined;
+
+  /**
+   * Check which direction the menu is expanded in.
+   * @defaultValue `false`
+   */
+  get expandUp(): boolean;
+
+  /**
+   * Whether to position the context menu as a fixed element, or inject it into the target.
+   */
+  get fixed(): boolean;
+
+  /**
+   * The parent HTML element to which the context menu is attached
+   */
+  get target(): HTMLElement;
+
+  /**
+   * Animate the context menu's height when opening or closing.
+   * @param open - Whether the menu is opening or closing.
+   * @returns A Promise that resolves when the animation completes.
+   */
+  protected _animate(open?: boolean): Promise<void>;
+
+  /**
+   * Closes the menu and removes it from the DOM.
+   * @param options - Options to configure the closing behavior.
+   */
+  close(options?: ContextMenu.CloseOptions): Promise<void>;
+
+  /**
+   * Close the menu and remove it from the DOM.
+   */
+  protected _close(): void;
+
+  /**
+   * Called before the context menu begins rendering.
+   * @param target - The context target
+   * @param options - (default: `{}`)
+   */
+  protected _preRender(target: HTMLElement, options?: ContextMenu.RenderOptions): Promise<void>;
+
+  /**
+   * Render the Context Menu by iterating over the menuItems it contains
+   * Check the visibility of each menu item, and only render ones which are allowed by the item's logical condition
+   * Attach a click handler to each item which is rendered
+   * @param target  - The target element to which the context menu is attached
+   * @param options - (default: `{}`)
+   */
+  render(target: HTMLElement, options?: ContextMenu.RenderOptions): Promise<void>;
+
+  /**
+   * Called after the context menu has finished rendering and animating open.
+   * @param options - (default: `{}`)
+   */
+  protected _onRender(options?: ContextMenu.RenderOptions): Promise<void>;
+
+  /**
+   * Set the position of the context menu, taking into consideration whether the menu should expand upward or downward
+   * @param html    - The context menu element.
+   * @param target  - The element that the context menu was spawned on.
+   * @param options - (default: `{}`)
+   */
+  protected _setPosition(html: HTMLElement, target: HTMLElement, options?: ContextMenu.RenderOptions): void;
+
+  /**
+   * Inject the menu inside the target.
+   * @param menu   - The menu element.
+   * @param target - The context target.
+   */
+  protected _injectMenu(menu: HTMLElement, target: HTMLElement): void;
+
+  /**
+   * Set the context menu at a fixed position in the viewport.
+   * @param html    - The menu element.
+   * @param target  - The context target.
+   * @param options - (default: `{}`)
+   */
+  protected _setFixedPosition(menu: HTMLElement, target: HTMLElement, options?: ContextMenu.RenderOptions): void;
+
+  /**
+   * Local listeners which apply to each ContextMenu instance which is created.
+   * @param html - The context menu element.
+   */
+  activateListeners(html: HTMLElement): void;
+
+  /**
+   * Handle context menu activation.
+   * @param event - The triggering event.
+   */
+  protected _onActivate(event: PointerEvent): Promise<void>;
+
+  /**
+   * Global listeners which apply once only to the document.
+   */
+  static eventListeners(): void;
+
+  /**
+   * @deprecated since v13 until v15
+   * @remarks "ContextMenu#menu is deprecated. Please use ContextMenu#element instead."
+   */
+  get menu(): JQuery;
+
+  /**
+   * @deprecated since v13 until v15
+   * @remarks ""ContextMenu#_expandUp is deprecated. Please use ContextMenu#expandUp instead."
+   */
+  get _expandUp(): boolean;
+
+  #private: true;
+}
+
+declare namespace ContextMenu {
+  interface Entry<ElementType extends JQuery | HTMLElement> {
+    /**
+     * The context menu label. Can be localized.
+     */
+    name: string;
+
+    /**
+     * A string containing an HTML icon element for the menu item
+     */
+    icon?: string;
+
+    /**
+     * An identifier for a group this entry belongs to.
+     * @defaultValue `_none`
+     */
+    group?: string | null | undefined;
+
+    /**
+     * The element that the context menu has been triggered for. Will
+     * either be a jQuery object or an HTMLElement instance, depending
+     * on how the ContextMenu was configured.
+     */
+    callback: (target: ElementType) => void;
+
+    /**
+     * A function to call or boolean value to determine if this entry
+     * appears in the menu.
+     * @remarks `null` equivalent to `false`
+     */
+    condition?: boolean | Condition<ElementType> | null | undefined;
+  }
+
+  /**
+   * @param html - The element of the context menu entry.
+   * @returns Whether the entry should be rendered in the context menu.
+   * @remarks `null` equivalent to `false`
+   */
+  type Condition<ElementType extends JQuery | HTMLElement> = (target: ElementType) => boolean | null;
+
+  interface RenderOptions {
+    /**
+     * The event that triggered the context menu opening.
+     */
+    event?: PointerEvent | undefined | null;
+
+    /**
+     * Animate the context menu opening
+     * @defaultValue `true`
+     * @remarks No null because an explicit check for `options.animate !== false` would treat null as truthy
+     */
+    animate?: boolean | undefined;
+  }
+
+  interface CloseOptions {
+    /**
+     * Animate the context menu closing.
+     * @defaultValue `true`
+     * @remarks `null` equivalent to `false`
+     */
+    animate?: boolean | null;
+  }
+
+  type ContextMenuCallback =
+    /**
+     * @param target - The element that the context menu has been triggered for.
+     */
+    (target: HTMLElement) => void;
+
+  interface ConstructorOptions<IsJQuery extends boolean = true> {
+    /**
+     * Optionally override the triggering event which can spawn the menu. If the menu is using a fixed position, this event must be a MouseEvent
+     * @defaultValue `"contextmenu"`
+     */
+    eventName?: string;
+
+    /**
+     * A function to call when the context menu is opened.
+     */
+    onOpen?: ContextMenuCallback | null | undefined;
+
+    /**
+     * A function to call when the context menu is closed.
+     */
+    onClose?: ContextMenuCallback | null | undefined;
+
+    /**
+     * If true, callbacks will be passed jQuery objects instead of HTMLElement instances
+     * @defaultValue `true`
+     */
+    jQuery: IsJQuery;
+
+    /**
+     * If true, the context menu is given a fixed position rather than being injected into the target.
+     * @defaultValue `false`
+     */
+    fixed?: boolean | undefined;
+  }
+
+  interface CreateOptions<IsJQuery extends boolean = true> extends ConstructorOptions<IsJQuery> {
+    /**
+     * The name of the hook to call
+     * @defaultValue `EntryContext`
+     */
+    hookName?: string;
+  }
+
+  type JQueryOrHTML<IsJQuery extends boolean | undefined> = IsJQuery extends false ? HTMLElement : JQuery;
+}
+
+export default ContextMenu;

package/src/foundry/client-esm/applications/ux/drag-drop.d.mts

@@ -0,0 +1,21 @@
+/**
+ * A controller class for managing drag and drop workflows within an Application instance.
+ * The controller manages the following actions: dragstart, dragover, drop.
+ *
+ * @example Activate drag-and-drop handling for a certain set of elements
+ * ```js
+ * const dragDrop = new DragDrop({
+ *   dragSelector: ".item",
+ *   dropSelector: ".items",
+ *   permissions: { dragstart: this._canDragStart.bind(this), drop: this._canDragDrop.bind(this) },
+ *   callbacks: { dragstart: this._onDragStart.bind(this), drop: this._onDragDrop.bind(this) }
+ * });
+ * dragDrop.bind(html);
+ * ```
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class DragDrop {}
+
+declare namespace DragDrop {}
+
+export default DragDrop;

package/src/foundry/client-esm/applications/ux/draggable.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A UI utility to make an element draggable.
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class Draggable {}
+
+declare namespace Draggable {}
+
+export default Draggable;

package/src/foundry/client-esm/applications/ux/form-data-extended.d.mts

@@ -0,0 +1,17 @@
+/**
+ * An extension of the native FormData implementation.
+ *
+ * This class functions the same way that the default FormData does, but it is more opinionated about how
+ * input fields of certain types should be evaluated and handled.
+ *
+ * It also adds support for certain Foundry VTT specific concepts including:
+ *  Support for defined data types and type conversion
+ *  Support for TinyMCE editors
+ *  Support for editable HTML elements
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class FormDataExtended extends FormData {}
+
+declare namespace FormDataExtended {}
+
+export default FormDataExtended;

package/src/foundry/client-esm/applications/ux/html-secret.d.mts

@@ -0,0 +1,21 @@
+/**
+ * A composable class for managing functionality for secret blocks within DocumentSheets.
+ * @see {@link foundry.applications.api.DocumentSheet}
+ * @example Activate secret revealing functionality within a certain block of content.
+ * ```js
+ * const secrets = new HTMLSecret({
+ *   selector: "section.secret[id]",
+ *   callbacks: {
+ *     content: this._getSecretContent.bind(this),
+ *     update: this._updateSecret.bind(this)
+ *   }
+ * });
+ * secrets.bind(html);
+ * ```
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class HTMLSecret {}
+
+declare namespace HTMLSecret {}
+
+export default HTMLSecret;

package/src/foundry/client-esm/applications/ux/prosemirror-editor.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A class responsible for managing state and collaborative editing of a single ProseMirror instance.
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class ProseMirrorEditor {}
+
+declare namespace ProseMirrorEditor {}
+
+export default ProseMirrorEditor;

package/src/foundry/client-esm/applications/ux/search-filter.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A controller class for managing a text input widget that filters the contents of some other UI element.
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class SearchFilter {}
+
+declare namespace SearchFilter {}
+
+export default SearchFilter;

package/src/foundry/client-esm/applications/ux/tabs.d.mts

@@ -0,0 +1,29 @@
+/**
+ * A controller class for managing tabbed navigation within an Application instance.
+ * @see {@link foundry.applications.api.ApplicationV2}
+ *
+ * @example Configure tab-control for a set of HTML elements
+ * ```html
+ * <!-- Example HTML -->
+ * <nav class="tabs" data-group="primary-tabs">
+ *   <a class="item" data-tab="tab1" data-group="primary-tabs">Tab 1</li>
+ *   <a class="item" data-tab="tab2" data-group="primary-tabs">Tab 2</li>
+ * </nav>
+ *
+ * <section class="content">
+ *   <div class="tab" data-tab="tab1" data-group="primary-tabs">Content 1</div>
+ *   <div class="tab" data-tab="tab2" data-group="primary-tabs">Content 2</div>
+ * </section>
+ * ```
+ * Activate tab control in JavaScript
+ * ```js
+ * const tabs = new foundry.applications.ux.Tabs({navSelector: ".tabs", contentSelector: ".content", initial: "tab1"});
+ * tabs.bind(html);
+ * ```
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class Tabs {}
+
+declare namespace Tabs {}
+
+export default Tabs;

package/src/foundry/client-esm/applications/ux/text-editor.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A collection of helper functions and utility methods related to the rich text editor.
+ * @remarks TODO: Stub, copy from v12 implementation & update
+ */
+declare class TextEditor {}
+
+declare namespace TextEditor {}
+
+export default TextEditor;

package/src/foundry/client-esm/appv1/_module.d.mts

@@ -0,0 +1,7 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export * as api from "./api/_module.mjs";
+export * as sheets from "./sheets/_module.mjs";

package/src/foundry/client-esm/appv1/api/_module.d.mts

@@ -0,0 +1,9 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as Application } from "./application-v1.mjs";
+export { default as Dialog } from "./dialog-v1.mjs";
+export { default as DocumentSheet } from "./document-sheet-v1.mjs";
+export { default as FormApplication } from "./form-application-v1.mjs";

package/src/foundry/client-esm/appv1/api/application-v1.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate Application
+
+declare class Application {}
+
+export default Application;

package/src/foundry/client-esm/appv1/api/dialog-v1.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate Dialog
+
+declare class Dialog {}
+
+export default Dialog;

package/src/foundry/client-esm/appv1/api/document-sheet-v1.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate DocumentSheet
+
+declare class DocumentSheet {}
+
+export default DocumentSheet;

package/src/foundry/client-esm/appv1/api/form-application-v1.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate FormApplication
+
+declare class FormApplication {}
+
+export default FormApplication;

package/src/foundry/client-esm/appv1/sheets/_module.d.mts

@@ -0,0 +1,10 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as ActorSheet } from "./actor-sheet.mjs";
+export { default as AdventureImporter } from "./adventure-importer.mjs";
+export { default as ItemSheet } from "./item-sheet.mjs";
+export { default as JournalSheet } from "./journal-sheet.mjs";
+export { JournalPageSheet, JournalTextPageSheet, JournalTextTinyMCESheet } from "./journal-page-sheet.mjs";

package/src/foundry/client-esm/appv1/sheets/actor-sheet.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate ActorSheet
+
+declare class ActorSheet {}
+
+export default ActorSheet;

package/src/foundry/client-esm/appv1/sheets/adventure-importer.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate AdventureImporter
+
+declare class AdventureImporter {}
+
+export default AdventureImporter;

package/src/foundry/client-esm/appv1/sheets/item-sheet.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate ItemSheet
+
+declare class ItemSheet {}
+
+export default ItemSheet;

package/src/foundry/client-esm/appv1/sheets/journal-page-sheet.d.mts

@@ -0,0 +1,7 @@
+// TODO: JournalPageSheet, JournalTextPageSheet, JournalTextTinyMCESheet
+
+declare class JournalPageSheet {}
+declare class JournalTextPageSheet extends JournalPageSheet {}
+declare class JournalTextTinyMCESheet extends JournalPageSheet {}
+
+export { JournalPageSheet, JournalTextPageSheet, JournalTextTinyMCESheet };

package/src/foundry/client-esm/appv1/sheets/journal-sheet.d.mts

@@ -0,0 +1,5 @@
+// TODO: Migrate JournalSheet
+
+declare class JournalSheet {}
+
+export default JournalSheet;

package/src/foundry/client-esm/audio/_module.d.mts

@@ -1,8 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
-/* eslint-disable import/no-unresolved */ // TODO: Remove when the files are instantiated
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export * as types from "./_types.mjs";
 export { default as AudioBufferCache } from "./cache.mjs";

package/src/foundry/client-esm/audio/_types.d.mts

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?

package/src/foundry/client-esm/audio/biquad.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 /**
  * A sound effect which applies a biquad filter.

package/src/foundry/client-esm/audio/convolver.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 declare namespace ConvolverEffect {}
 

package/src/foundry/client-esm/audio/helper.d.mts

@@ -1,6 +1,6 @@
 import type Sound from "./sound.d.mts";
 import type AudioBufferCache from "./cache.d.mts";
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 /**
  * A helper class to provide common functionality for working with the Web Audio API.
@@ -108,10 +108,11 @@ declare class AudioHelper {
    */
   play(
     src: string,
-    options?: Sound.PlaybackOptions & InexactPartial<{
-      /** A specific AudioContext within which to play */
-      context: AudioContext;
-    }>,
+    options?: Sound.PlaybackOptions &
+      InexactPartial<{
+        /** A specific AudioContext within which to play */
+        context: AudioContext;
+      }>,
   ): Promise<Sound>;
 
   /**

package/src/foundry/client-esm/audio/sound.d.mts

@@ -1,5 +1,5 @@
-import type { AnyObject, InexactPartial, ValueOf } from "../../../types/utils.d.mts";
-import type EventEmitterMixin from "../../common/utils/event-emitter.d.mts";
+import type { AnyObject, InexactPartial, ValueOf } from "fvtt-types/utils";
+import type EventEmitterMixin from "@common/utils/event-emitter.d.mts";
 
 declare namespace Sound {
   interface PlaybackOptions extends _PlaybackOptions {}