@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/core/document-index.d.mts

@@ -1,6 +1,5 @@
-import type { DOCUMENT_OWNERSHIP_LEVELS } from "../../common/constants.d.mts";
-
-export {};
+import type Document from "#common/abstract/document.d.mts";
+import type { DOCUMENT_OWNERSHIP_LEVELS } from "#common/constants.d.mts";
 
 declare global {
   /**
@@ -19,7 +18,7 @@ declare global {
      * A reverse-lookup of a document's UUID to its parent node in the word tree.
      * @defaultValue `{}`
      */
-    uuids: Record<string, foundry.utils.StringTree.StringTreeNode>;
+    uuids: Record<string, foundry.utils.StringTree.StringTreeNode<DocumentIndex.Leaf>>;
 
     /**
      * Returns a Promise that resolves when the indexing process is complete.
@@ -115,4 +114,13 @@ declare global {
      */
     protected _indexWorldCollection(documentName: string): void;
   }
+
+  namespace DocumentIndex {
+    interface Leaf {
+      // TODO(LukeAbby): This appears to be possible to be a compendium index entry.
+      doc: Document.Any;
+      documentName: string;
+      uuid: string;
+    }
+  }
 }

package/src/foundry/client/core/hooks.d.mts

@@ -1,7 +1,5 @@
 import type { AnyFunction } from "fvtt-types/utils";
 
-export {};
-
 declare global {
   /**
    * A simple event framework used throughout Foundry Virtual Tabletop.

package/src/foundry/client/core/image.d.mts

@@ -8,13 +8,13 @@ declare global {
     /**
      * Create thumbnail preview for a provided image path.
      * @param src     - The string URL or DisplayObject of the texture to render to a thumbnail
-     * @param options - Additional named options passed to the {@link ImageHelper.compositeCanvasTexture} method
+     * @param options - Additional named options passed to the {@link ImageHelper.compositeCanvasTexture | `ImageHelper.compositeCanvasTexture`} method
      *                  (default: `{}`)
      * @returns The parsed and converted thumbnail data
      */
     static createThumbnail(
       src: string | PIXI.DisplayObject,
-      options?: ImageHelper.CompositeOptions & ImageHelper.TextureToImageOptions,
+      options?: ImageHelper.CreateThumbnailOptions,
     ): Promise<ImageHelper.ThumbnailReturn> | null;
 
     /**
@@ -80,7 +80,7 @@ declare global {
       fileName: string,
       filePath: string,
       options?: ImageHelper.UploadBase64Options,
-    ): Promise<ReturnType<(typeof FilePicker)["upload"]>>;
+    ): Promise<ReturnType<typeof FilePicker.upload>>;
 
     /**
      * Create a canvas element containing the pixel data.
@@ -112,7 +112,7 @@ declare global {
 
       /**
        * The desired height of the output texture
-       * @defaultValue The height of the object passed to {@link ImageHelper.compositeCanvasTexture}
+       * @defaultValue The height of the object passed to {@link ImageHelper.compositeCanvasTexture | `ImageHelper.compositeCanvasTexture`}
        */
       height: number;
 
@@ -130,17 +130,19 @@ declare global {
 
       /**
        * The desired width of the output texture
-       * @defaultValue The width of the object passed to {@link ImageHelper.compositeCanvasTexture}
+       * @defaultValue The width of the object passed to {@link ImageHelper.compositeCanvasTexture | `ImageHelper.compositeCanvasTexture`}
        */
       width: number;
     }>;
 
     /**
-     * An interface for options for the {@link ImageHelper.createThumbnail} and {@link ImageHelper.compositeCanvasTexture}
+     * An interface for options for the {@link ImageHelper.createThumbnail | `ImageHelper.createThumbnail`} and {@link ImageHelper.compositeCanvasTexture | `ImageHelper.compositeCanvasTexture`}
      * methods.
      */
     interface CompositeOptions extends _CompositeOptions {}
 
+    interface CreateThumbnailOptions extends ImageHelper.CompositeOptions, ImageHelper.TextureToImageOptions {}
+
     type Format = "image/png" | "image/jpeg" | "image/webp";
 
     /**
@@ -190,11 +192,11 @@ declare global {
     interface UploadBase64Options extends _UploadBase64Options {}
 
     /**
-     * An interface for return values of the {@link ImageHelper.createThumbnail} method.
+     * An interface for return values of the {@link ImageHelper.createThumbnail | `ImageHelper.createThumbnail`} method.
      */
     interface ThumbnailReturn {
       /**
-       * The height of the {@link PIXI.Sprite}, created by {@link ImageHelper.createThumbnail}
+       * The height of the {@link PIXI.Sprite | `PIXI.Sprite`}, created by {@link ImageHelper.createThumbnail | `ImageHelper.createThumbnail`}
        */
       height: number;
 
@@ -204,17 +206,17 @@ declare global {
       src: string | PIXI.DisplayObject;
 
       /**
-       * The Texture, returned from {@link ImageHelper.compositeCanvasTexture}, with `destroy(true)` already called on it.
+       * The Texture, returned from {@link ImageHelper.compositeCanvasTexture | `ImageHelper.compositeCanvasTexture`}, with `destroy(true)` already called on it.
        */
       texture: PIXI.Texture;
 
       /**
-       * The base64 encoded image data, returned from {@link ImageHelper.textureToImage}
+       * The base64 encoded image data, returned from {@link ImageHelper.textureToImage | `ImageHelper.textureToImage`}
        */
       thumb: string;
 
       /**
-       * The width of the {@link PIXI.Sprite}, created by {@link ImageHelper.createThumbnail}
+       * The width of the {@link PIXI.Sprite | `PIXI.Sprite`}, created by {@link ImageHelper.createThumbnail | `ImageHelper.createThumbnail`}
        */
       width: number;
     }

package/src/foundry/client/core/issues.d.mts

@@ -1,11 +1,11 @@
-import type Document from "../../common/abstract/document.d.mts";
-import type { DataModelValidationError } from "../../common/data/validation-failure.d.mts";
+import type Document from "#common/abstract/document.d.mts";
+import type { DataModelValidationError } from "#common/data/validation-failure.d.mts";
 
 declare global {
   /**
-   * An object structure of document types at the top level, with a count of different sub-types for that document type.
+   * @deprecated {@link ClientIssues.ModuleSubTypeCounts | `ClientIssues.ModuleSubTypeCounts`}
    */
-  interface ModuleSubTypeCounts extends Record<Document.Type, Record<string, number>> {}
+  type ModuleSubTypeCounts = ClientIssues.ModuleSubTypeCounts;
 
   /**
    * A class responsible for tracking issues in the current world.
@@ -64,12 +64,12 @@ declare global {
      * Get the Document sub-type counts for a given module.
      * @param module - The module or its ID.
      */
-    getSubTypeCountsFor(module: Module | string): ModuleSubTypeCounts | undefined;
+    getSubTypeCountsFor(module: Module | string): ClientIssues.ModuleSubTypeCounts | undefined;
 
     /**
      * Retrieve all sub-type counts in the world.
      */
-    getAllSubtypeCounts(): IterableIterator<[string, ModuleSubTypeCounts]>;
+    getAllSubtypeCounts(): IterableIterator<[string, ClientIssues.ModuleSubTypeCounts]>;
 
     /**
      * Retrieve the tracked validation failures.
@@ -98,5 +98,10 @@ declare global {
       /** Parameters to supply to the localization. */
       params?: Record<string, object> | undefined;
     }
+
+    /**
+     * An object structure of document types at the top level, with a count of different sub-types for that document type.
+     */
+    interface ModuleSubTypeCounts extends Record<Document.Type, Record<string, number>> {}
   }
 }

package/src/foundry/client/core/keybindings.d.mts

@@ -8,9 +8,9 @@ declare global {
    * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
    * Game object as as game.keybindings.
    *
-   * @see {@link Game.keybindings}
-   * @see {@link SettingKeybindingConfig}
-   * @see {@link KeybindingsConfig}
+   * @see {@link Game.keybindings | `Game.keybindings`}
+   * @see {@link SettingKeybindingConfig | `SettingKeybindingConfig`}
+   * @see {@link KeybindingsConfig | `KeybindingsConfig`}
    */
   class ClientKeybindings {
     constructor();

package/src/foundry/client/core/nue.d.mts

@@ -19,7 +19,7 @@ declare global {
      * @param html - The HTML content of the message.
      * @internal
      */
-    protected _activateListeners(msg: ChatMessage, html: JQuery): void;
+    protected _activateListeners(msg: ChatMessage.Implementation, html: JQuery): void;
 
     /**
      * Perform some special action triggered by clicking on a link in a NUE chat card.