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

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

@@ -1,45 +0,0 @@
-/**
- * Abstraction of the Application interface to be used with the Draggable class as a substitute for the app
- * This class will represent one popout feed window and handle its positioning and draggability
- */
-declare class CameraPopoutAppWrapper {
-  /**
-   * @param view    - The CameraViews application that this popout belongs to
-   * @param userId  - ID of the user this popout belongs to
-   * @param element - The div element of this specific popout window
-   */
-  constructor(view: CameraViews, userId: string, element: JQuery);
-
-  /**
-   * The CameraViews application that this popout belongs to
-   */
-  view: CameraViews;
-
-  /**
-   * The div element of this specific popout window
-   */
-  element: JQuery;
-
-  /**
-   * ID of the user this popout belongs to
-   */
-  userId: string;
-
-  /** @defaultValue `true` */
-  popOut: boolean;
-
-  /** @defaultValue `{}` */
-  options: Record<string, unknown>;
-
-  /**
-   * Get the current position of this popout window
-   */
-  get position(): Application.Position;
-
-  setPosition(options?: Partial<Application.Position>): (Application.Position & { height: number }) | void;
-
-  /** @internal */
-  protected _onResize(event: Event): void;
-
-  bringToTop(): void;
-}

package/src/foundry/foundry.js/clientDocuments/canvasDocuments/index.d.ts

@@ -1,8 +0,0 @@
-import './ambientLightDocument';
-import './ambientSoundDocument';
-import './drawingDocument';
-import './measuredTemplateDocument';
-import './noteDocument';
-import './tileDocument';
-import './tokenDocument';
-import './wallDocument';

package/src/foundry/foundry.js/clientDocuments/index.d.ts

@@ -1,21 +0,0 @@
-import './activeEffect';
-import './actor';
-import './canvasDocuments';
-import './card';
-import './cards';
-import './chatMessage';
-import './combat';
-import './combatant';
-import './fogExploration';
-import './folder';
-import './item';
-import './journalEntry';
-import './macro';
-import './playlist';
-import './playlistSound';
-import './prototypeToken';
-import './rollTable';
-import './scene';
-import './setting';
-import './tableResult';
-import './user';

package/src/foundry/foundry.js/clientDocuments/prototypeToken.d.ts

@@ -1,25 +0,0 @@
-import type { PrototypeTokenDataConstructorData } from '../../common/data/data.mjs/prototypeTokenData';
-
-declare global {
-  /**
-   * An extended Document definition used specifically
-   * This ensures that the PrototypeTokenData schema is used instead of the standard TokenData.
-   * This exists specifically for prototype Token configuration in the TokenConfig app and should not be used otherwise.
-   * @internal
-   * @remarks The types for this are incorrect, in particular everything related to the data should use
-   * {@link foundry.data.PrototypeTokenData} instead of {@link foundry.data.TokenData}. However, with the current approach
-   * to type documents, we don't see a way to do this. This class is just added for reference. As the documentation above
-   * says, don't use it (there really shouldn't be a need to do so).
-   */
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  class PrototypeTokenDocument extends TokenDocument {
-    static get schema(): typeof foundry.data.PrototypeTokenData;
-
-    /** @override */
-    update(
-      data?: DeepPartial<PrototypeTokenDataConstructorData> | undefined,
-      context?: (DocumentModificationContext & foundry.utils.MergeObjectOptions) | undefined
-    ): Promise<this | undefined>;
-  }
-}

package/src/foundry/foundry.js/collections/documentCollections/index.d.ts

@@ -1,3 +0,0 @@
-import './compendiumCollection';
-import './worldCollection';
-import './worldCollections';

package/src/foundry/foundry.js/collections/index.d.ts

@@ -1,2 +0,0 @@
-import './documentCollection';
-import './documentCollections';

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

@@ -1,60 +0,0 @@
-/**
- * An object containing the result of a collision test.
- * @internal
- */
-declare class CollisionResult {
-  constructor(values?: {
-    target?: PolygonVertex | null;
-    collisions?: PolygonVertex[];
-    cwEdges?: EdgeSet;
-    ccwEdges?: EdgeSet;
-    isBehind?: boolean;
-    isLimited?: boolean;
-    isRequired?: boolean;
-    wasLimited?: boolean;
-  });
-
-  /**
-   * The vertex that was the target of this result
-   * @defaultValue `null`
-   */
-  target: PolygonVertex | null;
-
-  /**
-   * The array of collision points which apply to this result
-   * @defaultValue `[]`
-   */
-  collisions: PolygonVertex[];
-
-  /**
-   * The set of edges connected to the target vertex that continue clockwise
-   * @defaultValue `new Set()`
-   */
-  cwEdges: EdgeSet;
-
-  /**
-   * The set of edges connected to the target vertex that continue counter-clockwise
-   * @defaultValue `new Set()`
-   */
-  ccwEdges: EdgeSet;
-
-  /**
-   * Is the target vertex for this result behind some closer active edge?
-   */
-  isBehind: boolean | undefined;
-
-  /**
-   * Does the target vertex for this result impose a limited collision?
-   */
-  isLimited: boolean | undefined;
-
-  /**
-   * Is this result required due to a limited angle?
-   */
-  isRequired: boolean | undefined;
-
-  /**
-   * Has the set of collisions for this result encountered a limited edge?
-   */
-  wasLimited: boolean | undefined;
-}

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

@@ -1,103 +0,0 @@
-declare global {
-  /**
-   * Some global variables (such as {@link game}) are only initialized after certain events have happened during the
-   * initialization of Foundry VTT. For that reason, the correct types for these variables include the types for the
-   * uninitialized state.
-   *
-   * While this is correct from a type checking perspective, it can be inconvenient to have to type guard these global
-   * variables everywhere. Some users might prefer the convenience over the 100% correctness in type checking.
-   *
-   * For this reason, this interface provides a way for users to configure certain global variables to be typed more
-   * leniently, i.e., as the types of their initialized state. This is done via declaration merging. To configure a
-   * specific global variable to be typed leniently, the user simply needs to merge a property with the name of the
-   * variable into this interface (the type doesn't matter).
-   *
-   * The currently supported variables are:
-   * - {@link game}
-   * - {@link socket}
-   * - {@link ui}
-   * - {@link canvas}
-   *
-   * @example
-   * ```typescript
-   * declare global {
-   *   interface LenientGlobalVariableTypes {
-   *     game: never; // the type doesn't matter
-   *   }
-   * }
-   *
-   * const referenceToGame: Game = game; // ok! :)
-   * ```
-   */
-  // eslint-disable-next-line @typescript-eslint/no-empty-interface
-  interface LenientGlobalVariableTypes {}
-
-  let vtt: 'Foundry VTT';
-
-  /**
-   * @defaultValue `{}`
-   * @remarks
-   * Initialized between the `'DOMContentLoaded'` event and the `'init'` hook event.
-   */
-  let game: 'game' extends keyof LenientGlobalVariableTypes ? Game : Game | {};
-
-  /**
-   * @defaultValue `null`
-   * @remarks
-   * Initialized between the `'DOMContentLoaded'` event and the `'init'` hook event.
-   */
-  let socket: 'socket' extends keyof LenientGlobalVariableTypes ? io.Socket : io.Socket | null;
-
-  /**
-   * A collection of application instances
-   * @remarks
-   * - All of the elements of {@link ui} except for `context` and `window` are initialized between the `'setup'` and `'ready'` hook events.
-   * - In the `/stream` view, only `chat` is initialized but none of the other {@link Application}s.
-   */
-  let ui: {
-    /**
-     * @remarks
-     * Initialized whenever a {@link ContextMenu} is opened, deleted when it's closed again.
-     */
-    context?: ContextMenu;
-
-    /**
-     * @defaultValue `{}`
-     */
-    windows: Record<number, Application>;
-  } & ('ui' extends keyof LenientGlobalVariableTypes ? UiApplications : Partial<UiApplications>);
-
-  /** The client-side console is the default logger  */
-  let logger: typeof console;
-
-  /**
-   * @defaultValue `undefined`
-   * Initialized between the `'DOMContentLoaded'` event and the `'init'` hook event.
-   */
-  let canvas: 'canvas' extends keyof LenientGlobalVariableTypes ? Canvas : Canvas | undefined;
-
-  /**
-   * A "secret" global to help debug attributes of the currently controlled Token.
-   * This is only for debugging, and may be removed in the future, so it's not safe to use.
-   */
-  let _token: InstanceType<CONFIG['Token']['objectClass']> | null;
-
-  /*
-   * Global Variables
-   * The following variables are declared directly in foundry's HTML file (or more concretely, in `main.hbs`)
-   */
-
-  const SIGNED_EULA: boolean;
-
-  const ROUTE_PREFIX: string;
-
-  const MESSAGES:
-    | { type: Notifications.Notification['type']; message: string; options: Notifications.Options }[]
-    | null;
-}
-
-type UiApplications = {
-  [Key in keyof CONFIG['ui']]: InstanceType<CONFIG['ui'][Key]>;
-};
-
-export {};

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';