@league-of-foundry-developers/foundry-vtt-types 9.268.2 → 9.280.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.268.2",
+  "version": "9.280.0",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {
@@ -76,7 +76,7 @@
     "lint-staged": "^12.1.2",
     "prettier": "^2.5.1",
     "tsd": "^0.20.0",
-    "typescript": "~4.6.2"
+    "typescript": "~4.7.2"
   },
   "husky": {
     "hooks": {

package/src/foundry/client/apps/sidebar/tabs/settings.d.ts

@@ -59,8 +59,11 @@ declare global {
 
   /**
    * A simple window application which shows the built documentation pages within an iframe
+   * @typeParam Options - the type of the options object
    */
-  class FrameViewer extends Application {
+  class FrameViewer<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
+    constructor(url: string, options?: Partial<Options>);
+
     url: string;
 
     /**
@@ -78,7 +81,7 @@ declare global {
      */
     static override get defaultOptions(): typeof Application['defaultOptions'];
 
-    override getData(options?: Partial<ApplicationOptions>): Promise<{ src: string }>;
+    override getData(options?: Partial<Options>): Promise<{ src: string }>;
 
     override close(options?: Application.CloseOptions): ReturnType<Application['close']>;
   }

package/src/foundry/client/av/settings.d.ts

@@ -221,7 +221,7 @@ declare namespace AVSettings {
   type ClientSettings = typeof AVSettings.DEFAULT_CLIENT_SETTINGS;
   type WorldSettings = typeof AVSettings.DEFAULT_WORLD_SETTINGS;
   type StoredUserSettings = typeof AVSettings.DEFAULT_USER_SETTINGS;
-  type UserSettings = StoredUserSettings & { canBroadCastAudio: boolean; canBroadcastVideo: boolean };
+  type UserSettings = StoredUserSettings & { canBroadcastAudio: boolean; canBroadcastVideo: boolean };
   type Settings = { client: ClientSettings; world: WorldSettings };
   interface DefaultVoiceModes {
     ALWAYS: 'always';

package/src/foundry/client/config.d.ts

@@ -1,4 +1,5 @@
 import { DocumentConstructor, PlaceableObjectConstructor } from '../../types/helperTypes';
+import type { StatusEffect } from './data/documents/token';
 
 declare global {
   /**
@@ -93,31 +94,24 @@ declare global {
       /** @defaultValue `"fas fa-id-badge"` */
       sidebarIcon: string;
 
-      presets: {
-        /**
-         * @defaultValue
-         * ```javascript
-         * {
-         *   type: "deck",
-         *   label: "CARDS.DeckPresetPokerDark",
-         *   src: "cards/poker-deck-dark.json"
-         * }
-         * ```
-         */
-        pokerDark: CONFIG.Cards.Preset;
-
-        /**
-         * @defaultValue
-         * ```javascript
-         * {
-         *   type: "deck",
-         *   label: "CARDS.DeckPresetPokerLight",
-         *   src: "cards/poker-deck-light.json"
-         * }
-         * ```
-         */
-        pokerLight: CONFIG.Cards.Preset;
-      } & Record<string, CONFIG.Cards.Preset>;
+      /**
+       * @defaultValue
+       * ```typescript
+       * {
+       *    pokerDark: {
+       *      type: "deck",
+       *      label: "CARDS.DeckPresetPokerDark",
+       *      src: "cards/poker-deck-dark.json"
+       *    },
+       *    pokerLight: {
+       *      type: "deck",
+       *      label: "CARDS.DeckPresetPokerLight",
+       *      src: "cards/poker-deck-light.json"
+       *    }
+       * }
+       * ```
+       */
+      presets: Record<string, CONFIG.Cards.Preset>;
     };
 
     /**
@@ -998,7 +992,7 @@ declare global {
      * ]
      * ```
      */
-    statusEffects: { id: string; label: string; icon: string }[];
+    statusEffects: StatusEffect[];
 
     /**
      * A mapping of core audio effects used which can be replaced by systems or mods

package/src/foundry/client/data/documents/token.d.ts

@@ -1,8 +1,7 @@
 import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../common/abstract/document.mjs.js';
-import * as data from '../../../common/data/data.mjs/index.js';
-
 import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
+import * as data from '../../../common/data/data.mjs/index.js';
 import type { PrototypeTokenDataConstructorData } from '../../../common/data/data.mjs/prototypeTokenData';
 
 declare global {
@@ -97,10 +96,7 @@ declare global {
      *                     (default: `{}`)
      * @returns Whether the Active Effect is now on or off
      */
-    toggleActiveEffect(
-      effectData: ActiveEffectDataConstructorData & { id: string; label: string; icon: string },
-      options?: ToggleActiveEffectOptions | undefined
-    ): Promise<boolean>;
+    toggleActiveEffect(effectData: StatusEffect, options?: ToggleActiveEffectOptions | undefined): Promise<boolean>;
 
     /**
      * Redirect updates to a synthetic Token Actor to instead update the tokenData override object.
@@ -281,3 +277,5 @@ interface ToggleActiveEffectOptions {
   /** Force a certain active state for the effect. */
   active?: boolean | undefined;
 }
+
+export type StatusEffect = ActiveEffectDataConstructorData & { id: string };

package/src/foundry/client/pixi/core/loader.d.ts

@@ -2,14 +2,9 @@ import type { ConfiguredDocumentClassForName } from '../../../../types/helperTyp
 
 declare global {
   /**
-   * A Loader class which helps with loading video and image textures
+   * A Loader class which helps with loading video and image textures.
    */
   class TextureLoader {
-    /**
-     * The cached mapping of textures
-     */
-    cache: Map<string, { tex: PIXI.BaseTexture; time: number }>;
-
     /**
      * The duration in milliseconds for which a texture will remain cached
      * @defaultValue `1000 * 60 * 15`
@@ -43,51 +38,26 @@ declare global {
     loadTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
-     * Log texture loading progress in the console and in the Scene loading bar
-     * @internal
+     * Load an image texture from a provided source url.
+     * @param src - The source image URL
+     * @returns The loaded BaseTexture
      */
-    protected _onProgress(src: string, progress: TextureLoader.Progress): void;
-
-    /**
-     * Log failed texture loading
-     * @internal
-     */
-    protected _onError(src: string, progress: TextureLoader.Progress, error: Error): void;
+    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
-     * Load an image texture from a provided source url
+     * @param src - The source video URL
+     * @returns The loaded BaseTexture
      */
-    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
+    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
 
     /**
      * Use the Fetch API to retrieve a resource and return a Blob instance for it.
+     * @param src     -
      * @param options - Options to configure the loading behaviour.
      *                  (default: `{}`)
-     * @internal
-     */
-    protected _fetchResource(
-      src: string,
-      options?: {
-        /**
-         * Append a cache-busting query parameter to the request.
-         * @defaultValue `false`
-         */
-        bustCache?: boolean | undefined;
-      }
-    ): Promise<Blob>;
-
-    /**
-     * Return a URL with a cache-busting query parameter appended.
-     * @param src - The source URL being attempted
-     * @returns The new URL, or false on a failure.
-     * @internal
+     * @returns A Blob containing the loaded data
      */
-    protected _getCacheBustURL(src: string): string | false;
-
-    /**
-     * Load a video texture from a provided source url
-     */
-    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
+    static fetchResource(src: string, options?: TextureLoader.FetchResourceOptions): Promise<Blob>;
 
     /**
      * Add an image url to the texture cache
@@ -107,6 +77,13 @@ declare global {
      */
     expireCache(): void;
 
+    /**
+     * Return a URL with a cache-busting query parameter appended.
+     * @param  src - The source URL being attempted
+     * @returns The new URL, or false on a failure.
+     */
+    static getCacheBustURL(src: string): string | false;
+
     /**
      * A global reference to the singleton texture loader
      */
@@ -142,6 +119,14 @@ declare global {
       total: number;
       pct: number;
     }
+
+    interface FetchResourceOptions {
+      /**
+       * Append a cache-busting query parameter to the request.
+       * @defaultValue `false`
+       */
+      bustCache?: boolean;
+    }
   }
 
   /**
@@ -160,11 +145,12 @@ declare global {
    * Load a single texture and return a Promise which resolves once the texture is ready to use
    * @param src      - The requested texture source
    * @param options  - Additional options which modify texture loading
+   * @returns The loaded Texture, or null if loading failed with no fallback
    */
   function loadTexture(
     src: string,
     options?: {
-      /** A fallback texture to use if the requested source is unavailable or invalid */
+      /** A fallback texture URL to use if the requested source is unavailable */
       fallback?: string | undefined;
     }
   ): Promise<PIXI.Texture | null>;

package/src/foundry/client/ui/dialog.d.ts

@@ -187,7 +187,7 @@ declare namespace Dialog {
     /**
      * The name of the default button which should be triggered on Enter
      */
-    default: string;
+    default?: string | undefined;
   }
 }
 

package/src/types/helperTypes.d.ts

@@ -1,5 +1,4 @@
-import DocumentData from '../foundry/common/abstract/data.mjs';
-import { AnyDocumentData } from '../foundry/common/abstract/data.mjs';
+import DocumentData, { AnyDocumentData } from '../foundry/common/abstract/data.mjs';
 import Document from '../foundry/common/abstract/document.mjs';
 import EmbeddedCollection from '../foundry/common/abstract/embedded-collection.mjs';
 

package/src/types/utils.d.ts

@@ -125,7 +125,7 @@ type Merge<T, U> = T extends object
  */
 type PromisedType<T> = T extends Promise<infer TResult> ? TResult : T;
 
-type StoredDocument<D extends foundry.abstract.Document<any, any>> = D & {
+type StoredDocument<D extends { data: { _source: unknown } }> = D & {
   id: string;
   data: D['data'] & {
     _id: string;