@league-of-foundry-developers/foundry-vtt-types 9.268.0 → 9.268.1

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts → client/apps/sidebar/tabs/playlists-directory.d.ts}

@@ -45,17 +45,14 @@ declare global {
      */
     protected _playingSoundsData?: PlaylistDirectory.Data.Sound[] | undefined;
 
-    /** @override */
-    static documentName: 'Playlist';
+    static override documentName: 'Playlist';
 
     /**
-     * @override
      * @defaultValue `'templates/sidebar/playlist-partial.html'`
      */
-    static documentPartial: string;
+    static override documentPartial: string;
 
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * const options = super.defaultOptions;
@@ -66,7 +63,7 @@ declare global {
      * return options;
      * ```
      */
-    static get defaultOptions(): SidebarDirectory.Options;
+    static override get defaultOptions(): SidebarDirectory.Options;
 
     /**
      * Initialize the set of Playlists which should be displayed in an expanded form
@@ -85,8 +82,7 @@ declare global {
      */
     protected get _playingLocation(): 'top' | 'bottom';
 
-    /** @override */
-    getData(options?: Partial<Options>): PlaylistDirectory.Data | Promise<PlaylistDirectory.Data>;
+    override getData(options?: Partial<Options>): PlaylistDirectory.Data | Promise<PlaylistDirectory.Data>;
 
     /**
      * Augment the tree directory structure with playlist-level data objects for rendering
@@ -135,8 +131,7 @@ declare global {
      */
     protected _getModeTooltip(mode: foundry.CONST.PLAYLIST_MODES): string;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Handle global volume change for the playlist sidebar
@@ -145,8 +140,7 @@ declare global {
      */
     protected _onGlobalVolume(event: JQuery.ChangeEvent): unknown;
 
-    /** @override */
-    collapseAll(): void;
+    override collapseAll(): void;
 
     /**
      * Handle Playlist collapse toggle
@@ -224,8 +218,7 @@ declare global {
     /** @internal */
     protected _onPlayingPin(): void;
 
-    /** @override */
-    protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
 
     /**
      * Update the displayed timestamps for all currently playing audio sources.
@@ -242,14 +235,11 @@ declare global {
      */
     protected _formatTimestamp(seconds: number): string;
 
-    /** @override */
-    protected _contextMenu(html: JQuery): void;
+    protected override _contextMenu(html: JQuery): void;
 
-    /** @override */
-    protected _getFolderContextOptions(): ContextMenuEntry[];
+    protected override _getFolderContextOptions(): ContextMenuEntry[];
 
-    /** @override */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
+    protected override _getEntryContextOptions(): ContextMenuEntry[];
 
     /**
      * Get context menu options for individual sound effects
@@ -258,11 +248,9 @@ declare global {
      */
     protected _getSoundContextOptions(): ContextMenuEntry[];
 
-    /** @override */
-    protected _onDragStart(event: DragEvent): void;
+    protected override _onDragStart(event: DragEvent): void;
 
-    /** @override */
-    protected _onDrop(event: DragEvent): void;
+    protected override _onDrop(event: DragEvent): void;
   }
 
   namespace PlaylistDirectory {

package/src/foundry/{foundry.js/applications/sidebarTabs/sidebarDirectories/rollTableDirectory.d.ts → client/apps/sidebar/tabs/roll-table-directory.d.ts}

@@ -5,6 +5,5 @@
 declare class RollTableDirectory<
   Options extends SidebarDirectory.Options = SidebarDirectory.Options
 > extends SidebarDirectory<'RollTable', Options> {
-  /** @override */
-  static documentName: 'RollTable';
+  static override documentName: 'RollTable';
 }

package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A directory listing of active game scenes
+ */
+declare class SceneDirectory extends SidebarDirectory<'Scene'> {
+  static override documentName: 'Scene';
+
+  /**
+   * @defaultValue `"templates/sidebar/scene-partial.html"`
+   */
+  static override documentPartial: string;
+
+  protected override _render(
+    force?: boolean,
+    options?: Application.RenderOptions<SidebarDirectory.Options>
+  ): Promise<void>;
+
+  protected override _getEntryContextOptions(): ContextMenuEntry[];
+}

package/src/foundry/{foundry.js/applications/sidebarTabs → client/apps/sidebar/tabs}/settings.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
 
 declare global {
   /**
@@ -12,7 +12,6 @@ declare global {
     Data extends object = Settings.Data
   > extends SidebarTab<Options> {
     /**
-     * @override
      * @defaultValue
      * ```typescript
      * const options = super.defaultOptions;
@@ -21,13 +20,11 @@ declare global {
      * options.title = "Settings";
      * ```
      */
-    static get defaultOptions(): ApplicationOptions;
+    static override get defaultOptions(): ApplicationOptions;
 
-    /** @override */
-    getData(options?: Partial<Options>): Data | Promise<Data>;
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
 
-    /** @override */
-    activateListeners(html: JQuery): void;
+    override activateListeners(html: JQuery): void;
 
     /**
      * Delegate different actions for different settings buttons
@@ -59,4 +56,30 @@ declare global {
       modules: number;
     }
   }
+
+  /**
+   * A simple window application which shows the built documentation pages within an iframe
+   */
+  class FrameViewer extends Application {
+    url: string;
+
+    /**
+     * @defaultValue
+     * ```
+     * mergeObject(super.defaultOptions, {
+     *   height: window.innerHeight * 0.9,
+     *   width: Math.min(window.innerWidth * 0.9, 1200),
+     *   top: (window.innerHeight - height) / 2,
+     *   left: (window.innerWidth - width) / 2,
+     *   id: "documentation",
+     *   template: "templates/apps/documentation.html",
+     * })
+     * ```
+     */
+    static override get defaultOptions(): typeof Application['defaultOptions'];
+
+    override getData(options?: Partial<ApplicationOptions>): Promise<{ src: string }>;
+
+    override close(options?: Application.CloseOptions): ReturnType<Application['close']>;
+  }
 }

package/src/foundry/client/apps/templates.d.ts

@@ -0,0 +1,425 @@
+export {};
+
+declare global {
+  let _templateCache: Record<string, Handlebars.TemplateDelegate>;
+
+  /**
+   * Get a template from the server by fetch request and caching the retrieved result
+   * @param path - The web-accessible HTML template URL
+   * @returns A Promise which resolves to the compiled Handlebars template
+   */
+  function getTemplate(path: string): Promise<Handlebars.TemplateDelegate>;
+
+  /**
+   * Load and cache a set of templates by providing an Array of paths
+   * @param paths - An array of template file paths to load
+   */
+  function loadTemplates(paths: string[]): Promise<Handlebars.TemplateDelegate[]>;
+
+  /**
+   * Get and render a template using provided data and handle the returned HTML
+   * Support asynchronous file template file loading with a client-side caching layer
+   *
+   * Allow resolution of prototype methods and properties since this all occurs within the safety of the client.
+   * @see {@link https://handlebarsjs.com/api-reference/runtime-options.html#options-to-control-prototype-access}
+   *
+   * @param path - The file path to the target HTML template
+   * @param data - A data object against which to compile the template
+   *
+   * @returns Returns the rendered HTML
+   */
+  function renderTemplate(path: string, data: object): Promise<string>;
+
+  /**
+   * A collection of Handlebars template helpers which can be used within HTML templates.
+   */
+  class HandlebarsHelpers {
+    /**
+     * For checkboxes, if the value of the checkbox is true, add the "checked" property, otherwise add nothing.
+     */
+    static checked(value: unknown): string;
+
+    /**
+     * For use in form inputs. If the supplied value is truthy, add the "disabled" property, otherwise add nothing.
+     */
+    static disabled(value: unknown): string;
+
+    /**
+     * Concatenate a number of string terms into a single string.
+     * This is useful for passing arguments with variable names.
+     * @param values - The values to concatenate
+     *
+     * @example <caption>Concatenate several string parts to create a dynamic variable</caption>
+     * ```handlebars
+     * {{filePicker target=(concat "faces." i ".img") type="image"}}
+     * ```
+     */
+    static concat(...values: string[]): Handlebars.SafeString;
+
+    /**
+     * Render a pair of inputs for selecting a color.
+     * @param options - Helper options
+     */
+    static colorPicker(options: HandlebarsHelpers.ColorPickerOptions): Handlebars.SafeString;
+
+    /**
+     * Construct an editor element for rich text editing with TinyMCE
+     * @param options - Helper options
+     */
+    static editor(options: HandlebarsHelpers.EditorOptions): Handlebars.SafeString;
+
+    /**
+     * Render a file-picker button linked to an `<input>` field
+     * @param options - Helper options
+     */
+    static filePicker(options: HandlebarsHelpers.FilePickerOptions): Handlebars.SafeString | string;
+
+    /**
+     * Translate a provided string key by using the loaded dictionary of localization strings.
+     *
+     * @example <caption>Translate a provided localization string, optionally including formatting parameters</caption>
+     * ```handlebars
+     * <label>{{localize "ACTOR.Create"}}</label> <!-- "Create Actor" -->
+     * <label>{{localize "CHAT.InvalidCommand" command=foo}}</label> <!-- "foo is not a valid chat message command." -->
+     * ```
+     */
+    static localize(value: string, options: HandlebarsHelpers.LocalizeOptions): string;
+
+    /**
+     * @param value   - A numeric value to format
+     * @param options - Additional options which customize the resulting format
+     * @returns The formatted string to be included in a template
+     * A string formatting helper to display a number with a certain fixed number of decimals and an explicit sign.
+     */
+    static numberFormat(value: string, options: HandlebarsHelpers.NumberFormatOptions): string;
+
+    /**
+     * Render a form input field of type number with value appropriately rounded to step size.
+     */
+    static numberInput(value: string, options: HandlebarsHelpers.NumberInputOptions): Handlebars.SafeString;
+
+    /**
+     * A helper to create a set of radio checkbox input elements in a named set.
+     * The provided keys are the possible radio values while the provided values are human readable labels.
+     *
+     * @param name     - The radio checkbox field name
+     * @param choices  - A mapping of radio checkbox values to human readable labels
+     * @param options  - Options which customize the radio boxes creation
+     *
+     * @example <caption>The provided input data</caption>
+     * ```typescript
+     * let groupName = "importantChoice";
+     * let choices = {a: "Choice A", b: "Choice B"};
+     * let chosen = "a";
+     * ```
+     *
+     * @example <caption>The template HTML structure</caption>
+     * ```handlebars
+     * <div class="form-group">
+     *   <label>Radio Group Label</label>
+     *   <div class="form-fields">
+     *     {{radioBoxes groupName choices checked=chosen localize=true}}
+     *   </div>
+     * </div>
+     * ```
+     */
+    static radioBoxes(
+      name: string,
+      choices: Record<string, string>,
+      options: HandlebarsHelpers.RadioBoxesOptions
+    ): Handlebars.SafeString;
+
+    /**
+     * Render a pair of inputs for selecting a value in a range.
+     * @param options - Helper options
+     */
+    static rangePicker(options: HandlebarsHelpers.RangePickerOptions): Handlebars.SafeString;
+
+    /**
+     * A helper to assign an `<option>` within a `<select>` block as selected based on its value
+     * Escape the string as handlebars would, then escape any regexp characters in it
+     */
+    static select(selected: string, options: HandlebarsHelpers.SelectOptions): string;
+
+    /**
+     * A helper to create a set of `<option>` elements in a `<select>` block based on a provided dictionary.
+     * The provided keys are the option values while the provided values are human readable labels.
+     * This helper supports both single-select as well as multi-select input fields.
+     *
+     * @param choices - A mapping of radio checkbox values to human readable labels
+     * @param options - Helper options
+     *
+     * @example <caption>The provided input data</caption>
+     * ```typescript
+     * let choices = {a: "Choice A", b: "Choice B"};
+     * let value = "a";
+     * ```
+     *
+     * @example <caption>The template HTML structure</caption>
+     * ```handlebars
+     * <select name="importantChoice">
+     *   {{selectOptions choices selected=value localize=true}}
+     * </select>
+     * ```
+     *
+     * @example <caption>The resulting HTML</caption>
+     * ```handlebars
+     * <select name="importantChoice">
+     *   <option value="a" selected>Choice A</option>
+     *   <option value="b">Choice B</option>
+     * </select>
+     * ```
+     *
+     * @example <caption>Using inverted</caption>
+     * ```typescript
+     * let choices = {"Choice A": "a", "Choice B": "b"};
+     * let value = "a";
+     * ```
+     *
+     * @example <caption>The template HTML structure</caption>
+     * ```handlebars
+     * <select name="importantChoice">
+     *   {{selectOptions choices selected=value inverted=true}}
+     * </select>
+     * ```
+     *
+     * @example <caption>Using nameAttr and labelAttr with objects</caption>
+     * ```typescript
+     * let choices = {foo: {key: "a", label: "Choice A"}, bar: {key: "b", label: "Choice B"}};
+     * let value = "b";
+     * ```
+     *
+     * @example <caption>The template HTML structure</caption>
+     * ```handlebars
+     * <select name="importantChoice">
+     *   {{selectOptions choices selected=value nameAttr="key" labelAttr="label"}}
+     * </select>
+     * ```
+     *
+     * @example <caption>Using nameAttr and labelAttr with arrays</caption>
+     * ```typescript
+     * let choices = [{key: "a", label: "Choice A"}, {key: "b", label: "Choice B"}];
+     * let value = "b";
+     * ```
+     *
+     * @example <caption>The template HTML structure</caption>
+     * ```handlebars
+     * <select name="importantChoice">
+     *   {{selectOptions choices selected=value nameAttr="key" labelAttr="label"}}
+     * </select>
+     * ```
+     */
+    static selectOptions(
+      choices: Record<string, string>,
+      options: HandlebarsHelpers.SelectOptionsOptions
+    ): Handlebars.SafeString;
+  }
+
+  namespace HandlebarsHelpers {
+    interface ColorPickerOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * The name of the field to create
+         */
+        name?: string;
+
+        /**
+         * The current color value
+         */
+        value?: string;
+
+        /**
+         * A default color string if a value is not provided
+         */
+        default?: string;
+      };
+    }
+
+    interface EditorOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * The named target data element
+         */
+        target: string;
+
+        /**
+         * Is the current user an owner of the data?
+         */
+        owner?: boolean;
+
+        /**
+         * Include a button used to activate the editor later?
+         */
+        button?: boolean;
+
+        /**
+         * Is the text editor area currently editable?
+         */
+        editable?: boolean;
+
+        /**
+         * Replace dynamic document links?
+         * @defaultValue `true`
+         */
+        documents?: boolean;
+
+        /**
+         * The data object providing context for inline rolls
+         */
+        rollData?: object | (() => object);
+
+        /**
+         * The original HTML content as a string
+         * @defaultValue `""`
+         */
+        content?: string;
+      };
+    }
+
+    interface FilePickerOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * The type of FilePicker instance to display
+         */
+        type?: FilePicker.Type;
+
+        /**
+         * The field name in the target data
+         */
+        target: string;
+      };
+    }
+
+    interface LocalizeOptions extends Handlebars.HelperOptions {
+      hash: Record<string, unknown>;
+    }
+
+    interface NumberFormatOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * The number of decimal places to include in the resulting string
+         * @defaultValue `0`
+         */
+        decimals?: number;
+
+        /**
+         * Whether to include an explicit "+" sign for positive numbers
+         * @defaultValue `false`
+         */
+        sign?: boolean;
+      };
+    }
+
+    interface NumberInputOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * @defaultValue `""`
+         */
+        name?: string;
+
+        step?: number;
+
+        /**
+         * @defaultValue `false`
+         */
+        disabled?: boolean;
+
+        /**
+         * @defaultValue `""`
+         */
+        placeholder?: string;
+
+        /**
+         * @defaultValue `""`
+         */
+        class?: string;
+
+        min?: number;
+
+        max?: number;
+      };
+    }
+
+    interface RadioBoxesOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * Which key is currently checked?
+         * @defaultValue `null`
+         */
+        checked?: string;
+
+        /**
+         * Pass each label through string localization?
+         * @defaultValue `false`
+         */
+        localize?: boolean;
+      };
+    }
+
+    interface RangePickerOptions extends Handlebars.HelperOptions {
+      /**
+       * The name of the field to create
+       * @defaultValue `'range'`
+       */
+      name?: string;
+
+      /**
+       * The current range value
+       */
+      value?: number;
+
+      /**
+       * The minimum allowed value
+       */
+      min?: number;
+
+      /**
+       * The maximum allowed value
+       */
+      max?: number;
+
+      /**
+       * The allowed step size
+       */
+      step?: number;
+    }
+
+    type SelectOptions = Handlebars.HelperOptions;
+
+    interface SelectOptionsOptions extends Handlebars.HelperOptions {
+      hash: {
+        /**
+         * Which key or array of keys that are currently selected?
+         */
+        selected?: string | string[];
+
+        /**
+         * Pass each label through string localization?
+         * @defaultValue `false`
+         */
+        localize?: boolean;
+
+        /**
+         * Add a blank option as the first option with this label
+         */
+        blank?: string;
+
+        /**
+         * Look up a property in the choice object values to use as the option value
+         */
+        nameAttr?: string;
+
+        /**
+         * Look up a property in the choice object values to use as the option label
+         */
+        labelAttr?: string;
+
+        /**
+         * Use the choice object value as the option value, and the key as the label
+         * instead of vice-versa
+         */
+        inverted?: boolean;
+      };
+    }
+  }
+}

package/src/foundry/client/audio/index.d.ts

@@ -0,0 +1,3 @@
+import './audio';
+import './container';
+import './sound';

package/src/foundry/client/av/clients/index.d.ts

@@ -0,0 +1 @@
+import './simplepeer';