@league-of-foundry-developers/foundry-vtt-types 12.331.4-beta → 13.340.1

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/cache.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "../../../utils/index.d.mts";
+import type { Identity } from "fvtt-types/utils";
 
 /**
  * A specialized cache used for audio buffers.

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

@@ -1,12 +1,175 @@
-import type { Brand, Identity, InexactPartial, MaybePromise, NullishProps } from "fvtt-types/utils";
-import EventEmitterMixin = foundry.utils.EventEmitterMixin;
+import type { Brand, InexactPartial, MaybePromise, NullishProps, Identity } from "fvtt-types/utils";
+import type EventEmitterMixin from "#common/utils/event-emitter.d.mts";
+
+declare namespace Sound {
+  interface Any extends AnySound {}
+  interface AnyConstructor extends Identity<typeof AnySound> {}
+
+  /** @internal */
+  type _ConstructorOptions = NullishProps<{
+    /**
+     * Force use of an AudioBufferSourceNode even if the audio duration is long
+     * @defaultValue `false`
+     */
+    forceBuffer: boolean;
+
+    /**
+     * A non-default audio context within which the sound should play
+     * @defaultValue `game.audio.music`
+     */
+    context: AudioContext;
+  }>;
+
+  interface ConstructorOptions extends _ConstructorOptions {}
+
+  type STATES = Brand<number, "Sound.STATES">;
+
+  interface States {
+    readonly FAILED: -1 & STATES;
+    readonly NONE: 0 & STATES;
+    readonly LOADING: 1 & STATES;
+    readonly LOADED: 2 & STATES;
+    readonly STARTING: 3 & STATES;
+    readonly PLAYING: 4 & STATES;
+    readonly PAUSED: 5 & STATES;
+    readonly STOPPING: 6 & STATES;
+    readonly STOPPED: 7 & STATES;
+  }
+
+  /** @internal */
+  type _LoadOptions = NullishProps<{
+    /**
+     * Automatically begin playback of the sound once loaded
+     * @defaultValue `false`
+     */
+    autoplay: boolean;
+  }> &
+    InexactPartial<{
+      /**
+       * Playback options passed to Sound#play, if autoplay
+       * @defaultValue `{}`
+       * @remarks Can't be `null` as it only has a parameter default
+       */
+      autoplayOptions: Sound.PlaybackOptions;
+    }>;
+
+  interface LoadOptions extends _LoadOptions {}
+
+  /**
+   * @internal
+   * Since `Sound##playback` isn't exposed, this interface can *just* be accurate to what's allowable to pass
+   * to {@link Sound.play | `Sound#play`} or {@link Sound.stop | `#stop`}, which in reality is what's allowed
+   * by `Sound##configurePlayback`
+   */
+  type _PlaybackOptions = NullishProps<{
+    /**
+     * A delay in seconds by which to delay playback
+     * @defaultValue `0`
+     * @remarks Unlike other properties of this interface, the above default is static.
+     */
+    delay: number;
+
+    /**
+     * A limited duration in seconds for which to play
+     * @defaultValue `undefined`
+     */
+    duration: number;
+
+    /**
+     * A duration in milliseconds over which to fade in playback
+     * @defaultValue `0`
+     * @remarks Unlike other properties of this interface, the above default is static.
+     */
+    fade: number;
+
+    /**
+     * Should sound playback loop?
+     * @defaultValue `false`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value is
+     */
+    loop: boolean;
+
+    /**
+     * Seconds of the AudioBuffer when looped playback should start. Only works for AudioBufferSourceNode.
+     * @defaultValue `0`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value is
+     */
+    loopStart: number;
+
+    /**
+     * Seconds of the Audio buffer when looped playback should restart. Only works for AudioBufferSourceNode.
+     * @defaultValue `undefined`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value is
+     */
+    loopEnd: number;
+
+    /**
+     * An offset in seconds at which to start playback
+     * @defaultValue `0`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value of
+     * `loopStart` is
+     */
+    offset: number;
+
+    /**
+     * A callback function attached to the source node
+     * @defaultValue `null`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value is
+     */
+    onended: ScheduleCallback | null;
+
+    /**
+     * The volume at which to play the sound
+     * @defaultValue `1.0`
+     * @remarks The above default is true for initial calls, but the actual default
+     * value, if this is passed nullish or omitted, is whatever the current value is
+     */
+    volume: number;
+  }>;
+
+  /** @remarks Default values here are what `Sound##configurePlayback` would use if passed an empty object with no prior calls */
+  interface PlaybackOptions extends _PlaybackOptions {}
+
+  /** @internal */
+  type _FadeOptions = InexactPartial<{
+    /**
+     * The duration of the fade effect in milliseconds
+     * @defaultValue `1000`
+     * @remarks Can't be `null` as it only has a parameter default
+     */
+    duration: number;
+
+    /**
+     * The type of fade easing, "linear" or "exponential"
+     * @defaultValue `"linear"`
+     * @remarks Can't be `null` as it only has a parameter default
+     */
+    type: "linear" | "exponential";
+  }> &
+    NullishProps<{
+      /**
+       * A volume level to start from, the current volume by default
+       * @defaultValue `this.gain.value`
+       */
+      from: number;
+    }>;
+
+  interface FadeOptions extends _FadeOptions {}
+
+  type ScheduleCallback = (sound: Sound) => MaybePromise<unknown>;
+}
 
 /**
  * A container around an AudioNode which manages sound playback in Foundry Virtual Tabletop.
  * Each Sound is either an AudioBufferSourceNode (for short sources) or a MediaElementAudioSourceNode (for long ones).
  * This class provides an interface around both types which allows standardized control over playback.
  */
-declare class Sound extends EventEmitterMixin(Object) {
+declare class Sound extends EventEmitterMixin() {
   /**
    * Construct a Sound by providing the source URL and other options.
    * @param src     - The audio source path, either a relative path or a remote URL
@@ -166,7 +329,7 @@ declare class Sound extends EventEmitterMixin(Object) {
    *
    * @privateRemarks Foundry types this as `Object|null` but the only place in Core this gets set is in `AmbientSound`, to `this`
    */
-  _manager: AmbientSound.Object | null;
+  _manager: AmbientSound.Implementation | null;
 
   /**
    * Load the audio source and prepare it for playback, either using an AudioBuffer or a streamed HTMLAudioElement.
@@ -336,168 +499,6 @@ declare class Sound extends EventEmitterMixin(Object) {
   emit(eventName: string): void;
 }
 
-declare namespace Sound {
-  interface Any extends AnySound {}
-  interface AnyConstructor extends Identity<typeof AnySound> {}
-
-  /** @internal */
-  type _ConstructorOptions = NullishProps<{
-    /**
-     * Force use of an AudioBufferSourceNode even if the audio duration is long
-     * @defaultValue `false`
-     */
-    forceBuffer: boolean;
-
-    /**
-     * A non-default audio context within which the sound should play
-     * @defaultValue `game.audio.music`
-     */
-    context: AudioContext;
-  }>;
-
-  interface ConstructorOptions extends _ConstructorOptions {}
-
-  type STATES = Brand<number, "Sound.STATES">;
-
-  interface States {
-    readonly FAILED: -1 & STATES;
-    readonly NONE: 0 & STATES;
-    readonly LOADING: 1 & STATES;
-    readonly LOADED: 2 & STATES;
-    readonly STARTING: 3 & STATES;
-    readonly PLAYING: 4 & STATES;
-    readonly PAUSED: 5 & STATES;
-    readonly STOPPING: 6 & STATES;
-    readonly STOPPED: 7 & STATES;
-  }
-
-  /** @internal */
-  type _LoadOptions = NullishProps<{
-    /**
-     * Automatically begin playback of the sound once loaded
-     * @defaultValue `false`
-     */
-    autoplay: boolean;
-  }> &
-    InexactPartial<{
-      /**
-       * Playback options passed to Sound#play, if autoplay
-       * @defaultValue `{}`
-       * @remarks Can't be `null` as it only has a parameter default
-       */
-      autoplayOptions: Sound.PlaybackOptions;
-    }>;
-
-  interface LoadOptions extends _LoadOptions {}
-
-  /**
-   * @internal
-   * Since `Sound##playback` isn't exposed, this interface can *just* be accurate to what's allowable to pass
-   * to {@link Sound.play | `Sound#play`} or {@link Sound.stop | `#stop`}, which in reality is what's allowed
-   * by `Sound##configurePlayback`
-   */
-  type _PlaybackOptions = NullishProps<{
-    /**
-     * A delay in seconds by which to delay playback
-     * @defaultValue `0`
-     * @remarks Unlike other properties of this interface, the above default is static.
-     */
-    delay: number;
-
-    /**
-     * A limited duration in seconds for which to play
-     * @defaultValue `undefined`
-     */
-    duration: number;
-
-    /**
-     * A duration in milliseconds over which to fade in playback
-     * @defaultValue `0`
-     * @remarks Unlike other properties of this interface, the above default is static.
-     */
-    fade: number;
-
-    /**
-     * Should sound playback loop?
-     * @defaultValue `false`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value is
-     */
-    loop: boolean;
-
-    /**
-     * Seconds of the AudioBuffer when looped playback should start. Only works for AudioBufferSourceNode.
-     * @defaultValue `0`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value is
-     */
-    loopStart: number;
-
-    /**
-     * Seconds of the Audio buffer when looped playback should restart. Only works for AudioBufferSourceNode.
-     * @defaultValue `undefined`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value is
-     */
-    loopEnd: number;
-
-    /**
-     * An offset in seconds at which to start playback
-     * @defaultValue `0`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value of
-     * `loopStart` is
-     */
-    offset: number;
-
-    /**
-     * A callback function attached to the source node
-     * @defaultValue `null`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value is
-     */
-    onended: ScheduleCallback | null;
-
-    /**
-     * The volume at which to play the sound
-     * @defaultValue `1.0`
-     * @remarks The above default is true for initial calls, but the actual default
-     * value, if this is passed nullish or omitted, is whatever the current value is
-     */
-    volume: number;
-  }>;
-
-  /** @remarks Default values here are what `Sound##configurePlayback` would use if passed an empty object with no prior calls */
-  interface PlaybackOptions extends _PlaybackOptions {}
-
-  /** @internal */
-  type _FadeOptions = InexactPartial<{
-    /**
-     * The duration of the fade effect in milliseconds
-     * @defaultValue `1000`
-     * @remarks Can't be `null` as it only has a parameter default
-     */
-    duration: number;
-
-    /**
-     * The type of fade easing, "linear" or "exponential"
-     * @defaultValue `"linear"`
-     * @remarks Can't be `null` as it only has a parameter default
-     */
-    type: "linear" | "exponential";
-  }> &
-    NullishProps<{
-      /**
-       * A volume level to start from, the current volume by default
-       * @defaultValue `this.gain.value`
-       */
-      from: number;
-    }>;
-
-  interface FadeOptions extends _FadeOptions {}
-
-  type ScheduleCallback = (sound: Sound) => MaybePromise<unknown>;
-}
 export default Sound;
 
 declare abstract class AnySound extends Sound {

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

@@ -1,4 +1,4 @@
-import type { Identity, NullishProps } from "../../../utils/index.d.mts";
+import type { Identity, NullishProps } from "fvtt-types/utils";
 
 /**
  * A special error class used for cancellation.

package/src/foundry/client-esm/av/_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 * as clients from "./clients/_module.mjs";
+
+export { default as AVClient } from "./client.mjs";
+export { default as AVMaster } from "./master.mjs";
+export { default as AVSettings } from "./settings.mjs";

package/src/foundry/client-esm/av/client.d.mts

@@ -0,0 +1,18 @@
+import type AVMaster from "./master.d.mts";
+import type AVSettings from "./settings.d.mts";
+
+/**
+ * An interface for an Audio/Video client which is extended to provide broadcasting functionality.
+ * @remarks TODO: Stub
+ */
+declare class AVClient {
+  /**
+   * @param master   - The master orchestration instance
+   * @param settings - The audio/video settings being used
+   */
+  constructor(master: AVMaster, settings: AVSettings);
+}
+
+declare namespace AVClient {}
+
+export default AVClient;

package/src/foundry/client-esm/av/clients/_module.d.mts

@@ -0,0 +1,6 @@
+// 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 SimplePeerAVClient } from "./simplepeer.mjs";

package/src/foundry/client-esm/av/clients/simplepeer.d.mts

@@ -0,0 +1,11 @@
+import type AVClient from "../client.d.mts";
+
+/**
+ * An implementation of the AVClient which uses the simple-peer library and the Foundry socket server for signaling.
+ * Credit to bekit#4213 for identifying simple-peer as a viable technology and providing a POC implementation.
+ */
+declare class SimplePeerAVClient extends AVClient {}
+
+declare namespace SimplePeerAVClient {}
+
+export default SimplePeerAVClient;

package/src/foundry/client-esm/av/master.d.mts

@@ -0,0 +1,12 @@
+/**
+ * The master Audio/Video controller instance.
+ * This is available as the singleton game.webrtc
+ * @remarks TODO: Stub
+ */
+declare class AVMaster {
+  constructor();
+}
+
+declare namespace AVMaster {}
+
+export default AVMaster;