@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.1-beta

package/src/foundry/client/apps/hud/pause.d.ts

@@ -1,20 +0,0 @@
-/**
- * Pause notification in the HUD
- *
- * @typeParam Options - the type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class Pause<
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = Pause.Data
-> extends Application<Options> {
-  static get defaultOptions(): ApplicationOptions;
-
-  override getData(options?: Partial<Options>): Data | Promise<Data>;
-}
-
-declare namespace Pause {
-  interface Data {
-    paused: boolean;
-  }
-}

package/src/foundry/client/apps/hud/players.d.ts

@@ -1,55 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The UI element which displays the list of Users who are currently playing within the active World.
-   *
-   * @typeParam Options - the type of the options object
-   */
-  class PlayerList<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * An internal toggle for whether or not to show offline players or hide them
-     * @defaultValue `false`
-     */
-    protected _showOffline: boolean;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * mergeObject(super.defaultOptions, {
-     *   id: "players",
-     *   template: "templates/user/players.html",
-     *   popOut: false
-     * })
-     * ```
-     */
-    static get defaultOptions(): ApplicationOptions;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    override getData(options?: Partial<Options>): PlayerList.Data | Promise<PlayerList.Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Return the default context options available for the Players application
-     */
-    protected _getUserContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Toggle display of the Players hud setting for whether or not to display offline players
-     * @param event - The originating click event
-     */
-    protected _onToggleOfflinePlayers(event: JQuery.ClickEvent): void;
-  }
-
-  namespace PlayerList {
-    interface Data {
-      users: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof User>>>[];
-      showOffline: boolean;
-      hide: boolean;
-    }
-  }
-}

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

@@ -1,136 +0,0 @@
-import { ModuleData, SystemData } from '../../common/packages.mjs';
-
-declare global {
-  /**
-   * A helper class which assists with localization and string translation
-   */
-  class Localization {
-    /**
-     * @param serverLanguage - The default language configuration setting for the server
-     */
-    constructor(serverLanguage?: string);
-
-    /**
-     * The target language for localization
-     * @defaultValue `'en'`
-     */
-    lang: string;
-
-    /**
-     * The package authorized to provide default language configurations
-     * @defaultValue `'core'`
-     */
-    defaultModule: string;
-
-    /**
-     * The translation dictionary for the target language
-     * @defaultValue `{}`
-     */
-    translations: Translations;
-
-    /**
-     * Fallback translations if the target keys are not found
-     * @defaultValue `{}`
-     */
-    protected _fallback: Translations;
-
-    /**
-     * Initialize the Localization module
-     * Discover available language translations and apply the current language setting
-     * @returns A Promise which resolves once languages are initialized
-     */
-    initialize(): Promise<void>;
-
-    /**
-     * Set a language as the active translation source for the session
-     * @param lang - A language string in CONFIG.supportedLanguages
-     * @returns A Promise which resolves once the translations for the requested language are ready
-     */
-    setLanguage(lang: string): Promise<void>;
-
-    /**
-     * Discover the available supported languages from the set of packages which are provided
-     */
-    protected _discoverSupportedLanguages(): Record<string, string>;
-
-    /**
-     * Prepare the dictionary of translation strings for the requested language
-     * @param lang - The language for which to load translations
-     * @returns The retrieved translations object
-     */
-    protected _getTranslations(lang: string): Promise<Translations>;
-
-    /**
-     * Reduce the languages array provided by a package to an array of file paths of translations to load
-     * @param pkg  - The package data
-     * @param lang - The target language to filter on
-     * @returns An array of translation file paths
-     */
-    protected _filterLanguagePaths(pkg: ModuleData | SystemData, lang: string): string[];
-
-    /**
-     * Load a single translation file and return its contents as processed JSON
-     * @param src - The translation file path to load
-     * @returns The loaded translation dictionary
-     */
-    protected _loadTranslationFile(src: string): Promise<Translations>;
-
-    /**
-     * Return whether a certain string has a known translation defined.
-     * @param stringId - The string key being translated
-     * @param fallback - Allow fallback translations to count?
-     */
-    has(stringId: string, fallback?: boolean): boolean;
-
-    /**
-     * Localize a string by drawing a translation from the available translations dictionary, if available
-     * If a translation is not available, the original string is returned
-     * @param stringId - The string ID to translate
-     * @returns The translated string
-     *
-     * @example <caption>Localizing a simple string in JavaScript</caption>
-     * ```typescript
-     * {
-     *   "MYMODULE.MYSTRING": "Hello, this is my module!"
-     * }
-     * game.i18n.localize("MYMODULE.MYSTRING"); // Hello, this is my module!
-     * ```
-     *
-     * @example <caption>Localizing a simple string in Handlebars</caption>
-     * ```handlebars
-     * {{localize "MYMODULE.MYSTRING"}} <!-- Hello, this is my module! -->
-     * ```
-     */
-    localize(stringId: string): string;
-
-    /**
-     * Localize a string including variable formatting for input arguments.
-     * Provide a string ID which defines the localized template.
-     * Variables can be included in the template enclosed in braces and will be substituted using those named keys.
-     *
-     * @param stringId - The string ID to translate
-     * @param data     - Provided input data
-     *                   (defaultValue: `{}`)
-     * @returns The translated and formatted string
-     *
-
-     * @example <caption>Localizing a formatted string in JavaScript</caption>
-     * ```typescript
-     * {
-     *   "MYMODULE.GREETING": "Hello {name}, this is my module!"
-     * }
-     * game.i18n.format("MYMODULE.GREETING" {name: "Andrew"}); // Hello Andrew, this is my module!
-     * ```
-     *
-     * @example <caption>Localizing a formatted string in Handlebars</caption>
-     * ```handlebars
-     * {{localize "MYMODULE.GREETING" name="Andrew"}} <!-- Hello, this is my module! -->
-     * ```
-     */
-    format(stringId: string, data?: Record<string, unknown>): string;
-  }
-}
-
-type Translations = {
-  [K: string]: string | Translations;
-};

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

@@ -1,9 +0,0 @@
-import './app';
-import './av';
-import './form';
-import './forms';
-import './hud';
-import './i18n';
-import './placeables';
-import './sidebar';
-import './templates';

package/src/foundry/client/apps/placeables/drawing-config.d.ts

@@ -1,99 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  interface DrawingConfigOptions extends FormApplicationOptions {
-    /**
-     * Configure the default drawing settings, instead of a specific Drawing
-     * @defaultValue `false`
-     */
-    configureDefault: boolean;
-  }
-
-  /**
-   * The Application responsible for configuring a single Drawing document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class DrawingConfig<
-    Options extends DrawingConfigOptions = DrawingConfigOptions,
-    Data extends object = DrawingConfig.Data<Options>
-  > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Drawing'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "drawing-config",
-     *   classes: ["sheet"],
-     *   template: "templates/scene/drawing-config.html",
-     *   width: 480,
-     *   height: "auto",
-     *   configureDefault: false,
-     *   tabs: [{ navSelector: ".tabs", contentSelector: "form", initial: "position" }],
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DrawingConfigOptions;
-
-    override get title(): string;
-
-    override get id(): string;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    /**
-     * Get the names and labels of fill type choices which can be applied
-     * @internal
-     */
-    protected static _getFillTypes(): DrawingConfig.FillTypes;
-
-    protected override _updateObject(event: Event, formData: DrawingConfig.FormData): Promise<unknown>;
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Reset the user Drawing configuration settings to their default values
-     * @param event - The originating mouse-click event
-     */
-    protected _onResetDefaults(event: JQuery.ClickEvent): void;
-  }
-
-  namespace DrawingConfig {
-    interface Data<Options extends DrawingConfigOptions = DrawingConfigOptions> {
-      author: string;
-      isDefault: boolean;
-      fillTypes: DrawingConfig.FillTypes;
-      fontFamilies: Record<string, string>;
-      object: foundry.data.DrawingData['_source'];
-      options: Options;
-      submitText: string;
-    }
-
-    type FillTypes = {
-      [Key in keyof typeof foundry.CONST['DRAWING_FILL_TYPES'] as typeof foundry.CONST['DRAWING_FILL_TYPES'][Key]]: `DRAWING.FillType${Titlecase<Key>}`;
-    };
-
-    interface FormData {
-      bezierFactor: number;
-      fillAlpha: number;
-      fillColor: string;
-      fillType: foundry.CONST.DRAWING_FILL_TYPES;
-      fontFamily: string;
-      fontSize: number | null;
-      height: number | null;
-      rotation: number | null;
-      strokeAlpha: number;
-      strokeColor: string;
-      strokeWidth: number | null;
-      text: string;
-      textAlpha: number;
-      textColor: string;
-      texture: string;
-      width: number | null;
-      x: number | null;
-      y: number | null;
-      z: number | null;
-    }
-  }
-}

package/src/foundry/client/apps/placeables/drawing-hud.d.ts

@@ -1,32 +0,0 @@
-import { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Drawing objects.
-   * @typeParam Options - the type of the options object
-   */
-  class DrawingHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    ConcreteDrawing,
-    Options
-  > {
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "drawing-hud",
-     *   template: "templates/hud/drawing-hud.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteDrawing>['getData']> & {
-      lockedClass: string;
-      visibilityClass: string;
-    };
-
-    override setPosition(options?: Partial<Application.Position>): void;
-  }
-}
-
-type ConcreteDrawing = InstanceType<ConfiguredObjectClassForName<'Drawing'>>;

package/src/foundry/client/apps/placeables/index.d.ts

@@ -1,10 +0,0 @@
-import './drawing-config';
-import './drawing-hud';
-import './light-config';
-import './note-config';
-import './sound-config';
-import './tile-config';
-import './tile-hud';
-import './token-config';
-import './token-hud';
-import './wall-config';

package/src/foundry/client/apps/placeables/light-config.d.ts

@@ -1,95 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { AmbientLightDataConstructorData } from '../../../common/data/data.mjs/ambientLightData';
-import type { AnimationDataConstructorData } from '../../../common/data/data.mjs/animationData';
-import type { DarknessActivationConstructorData } from '../../../common/data/data.mjs/darknessActivation';
-import type { LightDataConstructorData } from '../../../common/data/data.mjs/lightData';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single AmbientLight document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class AmbientLightConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = AmbientLightConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "ambient-light-config",
-     *   classes: ["sheet", "ambient-light-config"],
-     *   title: "LIGHT.ConfigTitle",
-     *   template: "templates/scene/ambient-light-config.html",
-     *   width: 480,
-     *   height: "auto",
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Preview the change caused by a change on the form by refreshing the display of the light source
-     */
-    protected _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
-
-    protected _onResetForm(event: PointerEvent): void;
-
-    protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
-
-    protected override _updateObject(event: Event, formData: AmbientLightConfig.FormData): Promise<unknown>;
-
-    /**
-     * Refresh the display of the AmbientLight object
-     * @internal
-     */
-    protected _refresh(): void;
-  }
-
-  namespace AmbientLightConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>, Options> {
-      isAdvanced: boolean;
-      colorationTechniques: typeof AdaptiveLightingShader.COLORATION_TECHNIQUES;
-      lightAnimations: Record<string, string> & {
-        '': 'None';
-      };
-      submitText: string;
-    }
-
-    interface FormData extends Pick<AmbientLightDataConstructorData, 'x' | 'y' | 'rotation' | 'walls' | 'vision'> {
-      'config.dim': LightDataConstructorData['dim'];
-      'config.bright': LightDataConstructorData['bright'];
-      'config.angle': LightDataConstructorData['angle'];
-      'config.color': LightDataConstructorData['color'];
-      'config.alpha': LightDataConstructorData['alpha'];
-      'config.darkness.min': DarknessActivationConstructorData['min'];
-      'config.darkness.max': DarknessActivationConstructorData['max'];
-      'config.animation.type': AnimationDataConstructorData['type'];
-      'config.animation.speed': AnimationDataConstructorData['speed'];
-      'config.animation.reverse': AnimationDataConstructorData['reverse'];
-      'config.animation.intensity': AnimationDataConstructorData['intensity'];
-      'config.coloration': LightDataConstructorData['coloration'];
-      'config.luminosity': LightDataConstructorData['luminosity'];
-      'config.gradual': LightDataConstructorData['gradual'];
-      'config.saturation': LightDataConstructorData['saturation'];
-      'config.contrast': LightDataConstructorData['contrast'];
-      'config.shadows': LightDataConstructorData['shadows'];
-    }
-  }
-
-  /**
-   * @deprecated since v9
-   */
-  class LightConfig extends AmbientLightConfig {
-    constructor(...args: ConstructorParameters<typeof AmbientLightConfig>);
-  }
-}

package/src/foundry/client/apps/placeables/note-config.d.ts

@@ -1,57 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Note document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class NoteConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = NoteConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Note'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: game.i18n.localize("NOTE.ConfigTitle"),
-     *   template: "templates/scene/note-config.html",
-     *   width: 400,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    protected override _updateObject(event: Event, formData: NoteConfig.FormData): Promise<unknown>;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-  }
-
-  namespace NoteConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Note'>>, Options> {
-      entry: ConfiguredDocumentClassForName<'JournalEntry'> | {};
-      entries: Journal['contents'];
-      icons: CONFIG['JournalEntry']['noteIcons'];
-      fontFamilies: Record<string, string>;
-      textAnchors: Record<foundry.CONST.TEXT_ANCHOR_POINTS, string>;
-      submitText: string;
-    }
-
-    interface FormData {
-      entryId: string;
-      fontFamily: string;
-      fontSize: number | null;
-      icon: string;
-      iconSize: number | null;
-      iconTint: string;
-      text: string;
-      textAnchor: foundry.CONST.TEXT_ANCHOR_POINTS;
-      textColor: string;
-      x: number | null;
-      y: number | null;
-    }
-  }
-}

package/src/foundry/client/apps/placeables/sound-config.d.ts

@@ -1,47 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { AmbientSoundDataConstructorData } from '../../../common/data/data.mjs/ambientSoundData';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single AmbientSound document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class AmbientSoundConfig<
-    Options extends DocumentSheetOptions = AmbientSoundConfig.Options,
-    Data extends object = AmbientSoundConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: "SOUND.ConfigTitle",
-     *   template: "templates/scene/sound-config.html",
-     *   width: 480
-     * });
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): Promise<Data> | Data;
-
-    protected override _updateObject(event: Event, formData: AmbientSoundConfig.FormData): Promise<unknown>;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-  }
-
-  namespace AmbientSoundConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>, Options> {
-      submitText: string;
-      gridUnits: string;
-    }
-
-    type FormData = Pick<foundry.data.AmbientSoundData, 'easing' | 'path' | 'volume'> &
-      Pick<AmbientSoundDataConstructorData, 'radius' | 'x' | 'y'>;
-
-    type Options = DocumentSheetOptions;
-  }
-}

package/src/foundry/client/apps/placeables/tile-config.d.ts

@@ -1,55 +0,0 @@
-import { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { TileDataConstructorData } from '../../../common/data/data.mjs/tileData';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single Tile document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class TileConfig<
-    Options extends TileConfig.Options = TileConfig.Options,
-    Data extends object = TileConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Tile'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * mergeObject(super.defaultOptions, {
-     *   id: "tile-config",
-     *   title: game.i18n.localize("TILE.ConfigTitle"),
-     *   template: "templates/scene/tile-config.html",
-     *   width: 420,
-     *   height: "auto",
-     *   submitOnChange: true,
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
-     * });
-     * ```
-     */
-    static override get defaultOptions(): TileConfig.Options;
-
-    override close(options?: Application.CloseOptions | undefined): Promise<void>;
-
-    override getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): void;
-
-    protected override _updateObject(event: Event, formData: TileConfig.FormData): Promise<unknown>;
-  }
-
-  namespace TileConfig {
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Tile'>>, Options> {
-      submitText: string;
-      occlusionModes: Record<foundry.CONST.TILE_OCCLUSION_MODES, string>;
-    }
-
-    type FormData = Pick<TileDataConstructorData, 'height' | 'img' | 'rotation' | 'width' | 'x' | 'y'>;
-
-    interface Options extends DocumentSheetOptions {
-      /**
-       * Configure a preview version of a tile which is not yet saved
-       */
-      preview?: boolean;
-    }
-  }
-}

package/src/foundry/client/apps/placeables/tile-hud.d.ts

@@ -1,37 +0,0 @@
-import { ConfiguredObjectClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects.
-   * @typeParam Options - the type of the options object
-   */
-  class TileHUD<Options extends ApplicationOptions = ApplicationOptions> extends BasePlaceableHUD<
-    ConcreteTile,
-    Options
-  > {
-    /**
-     * @defaultValue
-     * ```
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "tile-hud",
-     *   template: "templates/hud/tile-hud.html"
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override getData(options?: Partial<Options>): ReturnType<BasePlaceableHUD<ConcreteTile>['getData']> & {
-      isVideo: boolean;
-      lockedClass: string;
-      visibilityClass: string;
-      overheadClass: string;
-      underfootClass: string;
-      videoIcon: string;
-      videoTitle: string;
-    };
-
-    override setPosition(options?: Partial<Application.Position>): void;
-  }
-}
-
-type ConcreteTile = InstanceType<ConfiguredObjectClassForName<'Tile'>>;