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

package/src/foundry/foundry.js/handlebarsHelpers.d.ts

@@ -1,392 +0,0 @@
-/**
- * A collection of Handlebars template helpers which can be used within HTML templates.
- */
-declare 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;
-}
-
-declare 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/foundry.js/pixi/containers/baseGrids/index.d.ts

@@ -1,2 +0,0 @@
-import './hexagonalGrid';
-import './squareGrid';

package/src/foundry/foundry.js/pixi/containers/cachedContainers/index.d.ts

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

package/src/foundry/foundry.js/pixi/containers/canvasLayers/index.d.ts

@@ -1,6 +0,0 @@
-import './controlsLayer';
-import './gridLayer';
-import './placeablesLayer';
-import './placeablesLayers';
-import './sightLayer';
-import './weatherLayer';

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/index.d.ts

@@ -1,10 +0,0 @@
-import './drawingsLayer';
-import './lightingLayer';
-import './mapLayer';
-import './mapLayers';
-import './notesLayer';
-import './soundsLayer';
-import './templateLayer';
-import './tilesLayer';
-import './tokenLayer';
-import './wallsLayer';

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayer.d.ts

@@ -1,136 +0,0 @@
-import { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A PlaceablesLayer designed for rendering the visual Scene for a specific vertical cross-section.
-   * Each MapLayer contains a single background image as well as an arbitrary number of Tile objects.
-   */
-  class MapLayer<Options extends MapLayer.LayerOptions = MapLayer.LayerOptions<'background'>> extends PlaceablesLayer<
-    'Tile',
-    Options
-  > {
-    /**
-     * @param data - (default: `{}`)
-     */
-    constructor(data?: MapLayerConstructorData);
-
-    /**
-     * The numeric Scene level to which this layer belongs
-     */
-    level: number;
-
-    /**
-     * The background source path
-     */
-    bgPath: string | undefined;
-
-    /**
-     * The layer background image
-     */
-    bg: PIXI.Sprite | undefined;
-
-    static documentName: 'Tile';
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     * It returns the BackgroundLayer but ForegroundLayer has been added for subclasses.
-     */
-    static get instance(): Canvas['background'] | Canvas['foreground'];
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *   name: 'background',
-     *   zIndex: 0,
-     *   controllableObjects: true,
-     *   rotatableObjects: true
-     * })
-     * ```
-     */
-    static get layerOptions(): MapLayer.LayerOptions;
-
-    /**
-     * Return the base HTML image or video element which is used to generate the background Sprite.
-     */
-    get bgSource(): HTMLImageElement | HTMLVideoElement | null;
-
-    get hud(): TileHUD;
-
-    /**
-     * Is the background texture used in this layer a video?
-     */
-    get isVideo(): boolean;
-
-    /**
-     * An array of Tile objects which are rendered within the objects container
-     */
-    get tiles(): InstanceType<ConfiguredObjectClassForName<'Tile'>>[];
-
-    deactivate(): this;
-
-    tearDown(): Promise<this>;
-
-    /**
-     * @override
-     * @remarks It returns Promise<this> but is overridden by a subclass in this way.
-     */
-    draw(): Promise<this | undefined>;
-
-    /**
-     * Draw the background Sprite for the layer, aligning its dimensions with those configured for the canvas.
-     * @returns The rendered Sprite, or undefined if no background is present
-     */
-    protected _drawBackground(): PIXI.Sprite | undefined;
-
-    protected _onDragLeftStart(event: PIXI.InteractionEvent): Promise<void>;
-
-    protected _onDragLeftMove(event: PIXI.InteractionEvent): void;
-
-    protected _onDragLeftDrop(event: PIXI.InteractionEvent): void;
-
-    protected _onDragLeftCancel(event: PointerEvent): void;
-
-    /**
-     * Handle drop events for Tile data on the Tiles Layer
-     * @param event - The concluding drag event
-     * @param data - The extracted Tile data
-     */
-    protected _onDropData(
-      event: DragEvent,
-      data:
-        | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-        | ({ type: string } & Partial<Record<string, unknown>>)
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Tile'>> | undefined>;
-
-    /**
-     * Prepare the data object when a new Tile is dropped onto the canvas
-     * @param event - The concluding drag event
-     * @param data  - The extracted Tile data
-     * @returns The prepared data to create
-     */
-    protected _getDropData(
-      event: DragEvent,
-      data: MapLayer.DropData
-    ): Promise<ConstructorParameters<typeof foundry.documents.BaseTile>[0]>;
-  }
-
-  namespace MapLayer {
-    interface LayerOptions<Name extends 'background' | 'foreground' = 'background' | 'foreground'>
-      extends PlaceablesLayer.LayerOptions<'Tile'> {
-      name: Name;
-    }
-
-    type DropData =
-      | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-      | ({ type: string } & Partial<Record<string, unknown>>);
-  }
-}
-
-interface MapLayerConstructorData {
-  bgPath?: string;
-  /**
-   * @defaultValue `1`
-   */
-  level?: number;
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/backgroundLayer.d.ts

@@ -1,43 +0,0 @@
-import {
-  ConfiguredDocumentClassForName,
-  ConfiguredObjectClassForName,
-  DataSourceForPlaceable
-} from '../../../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * An extension of the MapLayer that displays underfoot in the background of the Scene.
-   */
-  class BackgroundLayer extends MapLayer {
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas['background'];
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get layerOptions(): MapLayer.LayerOptions<'background'>;
-
-    /**
-     * The outline of the scene.
-     * Not rendered within the BackgroundLayer, but rather beneath it so it does not impact the PrimaryMesh texture.
-     */
-    outline: PIXI.Graphics | undefined;
-
-    /**
-     * Draw a background outline which emphasizes what portion of the canvas is playable space and what is buffer.
-     * @param outline - The outline graphics to use
-     */
-    drawOutline(outline: PIXI.Graphics): void;
-
-    getDocuments(): Exclude<this['documentCollection'], null> | InstanceType<ConfiguredDocumentClassForName<'Tile'>>[];
-
-    getZIndex(): number;
-
-    storeHistory(
-      type: PlaceablesLayer.HistoryEventType,
-      data: DataSourceForPlaceable<InstanceType<ConfiguredObjectClassForName<'Tile'>>>
-    ): void;
-  }
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/foregroundLayer.d.ts

@@ -1,92 +0,0 @@
-import { ConfiguredDocumentClassForName, ConfiguredObjectClassForName } from '../../../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * An extension of the MapLayer that displays overhead in the foreground of the Scene.
-   */
-  class ForegroundLayer extends MapLayer<MapLayer.LayerOptions<'foreground'>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.layerOptions, {
-     *   name: "foreground"
-     * })
-     * ```
-     */
-    static get layerOptions(): MapLayer.LayerOptions<'foreground'>;
-
-    /**
-     * @remarks This is not overridden in foundry but reflects the real behavior.
-     */
-    static get instance(): Canvas['foreground'];
-
-    /**
-     * Get an array of overhead Tile objects which are roofs
-     */
-    get roofs(): InstanceType<ConfiguredObjectClassForName<'Tile'>>[];
-
-    /**
-     * Determine whether to display roofs
-     */
-    get displayRoofs(): boolean;
-
-    draw(): Promise<undefined>;
-
-    /**
-     * Draw the container used to cache the position of Token occlusion shapes to a RenderTexture
-     */
-    protected _drawOcclusionMask(): CachedContainer;
-
-    /**
-     * Perform one-time initialization actions which affect the foreground layer.
-     * These actions presume and require that the layer has already been drawn.
-     */
-    initialize(): void;
-
-    /** @override */
-    activate(): this;
-
-    deactivate(): this;
-
-    tearDown(): Promise<this>;
-
-    getZIndex(): number;
-
-    getDocuments(): Exclude<this['documentCollection'], null> | InstanceType<ConfiguredDocumentClassForName<'Tile'>>[];
-
-    /**
-     * Refresh the display of tiles on the Foreground Layer depending on Token occlusion.
-     */
-    refresh(): void;
-
-    /**
-     * Add a roof sprite to the occlusion roof mask container
-     * @param tile - The roof tile being added
-     */
-    addRoofSprite(tile: InstanceType<ConfiguredObjectClassForName<'Tile'>>): void;
-
-    /**
-     * Remove a roof sprite from occlusion roof mask container
-     * @param tile - The roof tile being removed
-     */
-    removeRoofSprite(tile: InstanceType<ConfiguredObjectClassForName<'Tile'>>): void;
-
-    /**
-     * Update occlusion for all tiles on the foreground layer
-     */
-    updateOcclusion(): void;
-
-    /**
-     * Draw the container which caches token-based occlusion shapes
-     * @param tokens - The set of currently observed tokens
-     */
-    protected _drawOcclusionShapes(tokens: ConfiguredObjectClassForName<'Token'>[]): void;
-
-    protected _getDropData(
-      event: DragEvent,
-      data:
-        | { type: 'Tile'; img: string; tileSize?: number; x: number; y: number }
-        | ({ type: string } & Partial<Record<string, unknown>>)
-    ): Promise<ConstructorParameters<typeof foundry.documents.BaseTile>[0]>;
-  }
-}

package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/index.d.ts

@@ -1,2 +0,0 @@
-import './backgroundLayer';
-import './foregroundLayer';