@league-of-foundry-developers/foundry-vtt-types 9.249.3 → 9.255.1

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

@@ -52,22 +52,19 @@ declare global {
     get parentFolder(): Folder | null;
 
     /**
-     * Return the named Entity type for elements in this folder.
-     */
-    get type(): this['data']['type'];
-
-    /**
-     * Create a new Folder by rendering a dialog window to provide basic creation details
+     * Present a Dialog form to create a new Folder.
+     * @see {@link ClientDocumentMixin.createDialog}
      * @param data    - Initial data with which to populate the creation form
-     * @param options - Initial positioning and sizing options for the dialog form
      *                  (default: `{}`)
-     * @returns An active FolderConfig instance for creating the new Folder entity
+     * @param context - Additional context options or dialog positioning options
+     *                  (default: `{}`)
+     * @returns A Promise which resolves to the created Folder, or null if the dialog was closed.
      *
      * @remarks
-     * The documented return type is incorrect. It now returns a promise that resolves to the
-     * created folder as intended. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6619
-     *
      * For weird reasons, we need to make this generic.
+     *
+     * The type of `context` is actually `{options?: DocumentSheetOptions} | undefined` but that's incompatible with the
+     * base implementation. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6863.
      */
     static createDialog<T extends DocumentConstructor>(
       this: T,
@@ -77,18 +74,21 @@ declare global {
             | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
           >
         | undefined,
-      options?: Partial<DocumentSheetOptions> | undefined
+      context?: any
     ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
     /**
      * Export all Documents contained in this Folder to a given Compendium pack.
      * Optionally update existing Documents within the Pack by name, otherwise append all new entries.
-     * @param  pack         - A Compendium pack to which the entities will be exported
-     * @param  updateByName - Update existing entries in the Compendium pack, matching by name
-     *                        (default: `false`)
+     * @param pack    - A Compendium pack to which the documents will be exported
+     * @param options - Additional options which customize how content is exported. See {@link ClientDocumentMixin#toCompendium}
+     *                  (default: `{}`)
      * @returns The updated Compendium Collection instance
      */
-    exportToCompendium(pack: any, { updateByName }?: { updateByName?: boolean }): Promise<any>; // TODO: CompendiumCollection
+    exportToCompendium<Metadata extends CompendiumCollection.Metadata>(
+      pack: CompendiumCollection<Metadata>,
+      options?: Folder.ExportToCompendiumOptions | undefined
+    ): Promise<CompendiumCollection<Metadata>>;
 
     /**
      * Provide a dialog form that allows for exporting the contents of a Folder into an eligible Compendium pack.
@@ -108,10 +108,12 @@ declare global {
     getSubfolders(recursive?: boolean): InstanceType<ConfiguredDocumentClass<typeof Folder>>[];
 
     protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+  }
 
-    /**
-     * @deprecated since 0.8.0
-     */
-    get entities(): this['contents'];
+  namespace Folder {
+    interface ExportToCompendiumOptions {
+      /** Update existing entries in the Compendium pack, matching by name */
+      updateByName?: boolean | undefined;
+    }
   }
 }

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

@@ -1,5 +1,4 @@
 import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import type { ItemDataConstructorData } from '../../common/data/data.mjs/itemData';
 
 declare global {
   /**
@@ -24,6 +23,11 @@ declare global {
      */
     get img(): this['data']['img'];
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['img'];
+
     /**
      * A convenience alias of Item#isEmbedded which is preserves legacy support
      */
@@ -35,19 +39,11 @@ declare global {
      */
     get transferredEffects(): ReturnType<this['effects']['filter']>;
 
-    /**
-     * A convenience reference to the item type (data.type) of this Item
-     */
-    get type(): this['data']['type'];
-
     /**
      * Prepare a data object which defines the data schema used by dice roll commands against this Item
      */
     getRollData(): object;
 
-    /** @override */
-    protected _getSheetClass(): typeof ItemSheet | null;
-
     /** @override */
     protected static _onCreateDocuments(
       items: Array<InstanceType<ConfiguredDocumentClass<typeof Item>>>,
@@ -59,19 +55,5 @@ declare global {
       items: Array<InstanceType<ConfiguredDocumentClass<typeof Item>>>,
       context: DocumentModificationContext
     ): Promise<unknown>;
-
-    /**
-     * You are referencing Item#_data which has been deprecated in favor of Item#data#_source. Support for this reference will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    get _data(): this['data']['_source'];
-
-    /**
-     * @deprecated since 0.8.1
-     */
-    static createOwned(
-      itemData: ItemDataConstructorData | (ItemDataConstructorData & Record<string, unknown>),
-      actor: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>>;
   }
 }

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

@@ -15,6 +15,16 @@ declare global {
      */
     get isAuthor(): boolean;
 
+    /**
+     * Test whether the current user is capable of executing a Macro script
+     */
+    get canExecute(): boolean;
+
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): string | null;
+
     /**
      * Execute the Macro command.
      * @param scope - Provide some additional scope configuration for the Macro

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

@@ -4,7 +4,7 @@ import type { DocumentModificationOptions } from '../../common/abstract/document
 declare global {
   /**
    * The client-side PlaylistSound document which extends the common BasePlaylistSound model.
-   * Each PlaylistSound belongs to the sounds collection of a Playlist entity.
+   * Each PlaylistSound belongs to the sounds collection of a Playlist document.
    * Each PlaylistSound contains a PlaylistSoundData object which provides its source data.
    *
    * @see {@link foundry.data.PlaylistSoundData} The PlaylistSound data schema

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

@@ -1,15 +1,25 @@
-/**
- * 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
-declare class PrototypeTokenDocument extends TokenDocument {
-  static get schema(): typeof foundry.data.PrototypeTokenData;
+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/clientDocuments/rollTable.d.ts

@@ -20,6 +20,11 @@ declare global {
       context?: ConstructorParameters<typeof foundry.documents.BaseRollTable>[1]
     );
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['img'];
+
     /**
      * Display a result drawn from a RollTable in the Chat Log along.
      * Optionally also display the Roll which produced the result and configure aspects of the displayed messages.
@@ -65,6 +70,9 @@ declare global {
      * Note that this function only performs the roll and identifies the result, the RollTable#draw function should be
      * called to formalize the draw from the table.
      *
+     * @param options - (default: `{}`)
+     * @returns The Roll and results drawn by that Roll
+     *
      * @example
      * ```typescript
      * // Draw results using the default table formula
@@ -75,7 +83,7 @@ declare global {
      * const customResults = await table.roll({roll});
      * ```
      */
-    roll(options?: RollTable.RollOptions): Promise<RollTableDraw>;
+    roll(options?: RollTable.RollOptions | undefined): Promise<RollTableDraw>;
 
     /**
      * Get an Array of valid results for a given rolled total
@@ -103,28 +111,22 @@ declare global {
     ): void;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.RollTableData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.RollTableData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.RollTableData extends { toObject(): infer U } ? U : never;
     };
 
     /**
-     * Create a new RollTable entity using all of the Entities from a specific Folder as new results.
-     * @param folder  - The Folder entity from which to create a roll table
+     * Create a new RollTable document using all of the Documents from a specific Folder as new results.
+     * @param folder  - The Folder document from which to create a roll table
      * @param options - Additional options passed to the RollTable.create method
      */
     static fromFolder(
       folder: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseFolder>>,
       options?: DocumentModificationOptions
     ): Promise<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseRollTable>> | undefined>;
-
-    /**
-     * The RollTable#getTableResult method is deprecated in favor of RollTable#results#get and will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    getTableResult(id: string): ReturnType<this['results']['get']>;
   }
 
   namespace RollTable {
@@ -190,7 +192,7 @@ declare global {
       roll?: Roll;
 
       /**
-       * If a RollTable entity is drawn as a result, recursively roll it
+       * If a RollTable document is drawn as a result, recursively roll it
        * @defaultValue `true`
        */
       recursive?: boolean;

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

@@ -68,18 +68,23 @@ declare global {
      */
     get img(): this['data']['img'];
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['thumb'];
+
     /**
      * A convenience accessor for whether the Scene is currently viewed
      */
     get isView(): boolean;
 
     /**
-     * A reference to the JournalEntry entity associated with this Scene, or null
+     * A reference to the JournalEntry document associated with this Scene, or null
      */
     get journal(): InstanceType<ConfiguredDocumentClass<typeof JournalEntry>> | null;
 
     /**
-     * A reference to the Playlist entity for this Scene, or null
+     * A reference to the Playlist document for this Scene, or null
      */
     get playlist(): InstanceType<ConfiguredDocumentClass<typeof Playlist>> | null;
 
@@ -435,10 +440,10 @@ declare global {
     ): void;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.SceneData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.SceneData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.SceneData extends { toObject(): infer U } ? U : never;
     };
 
@@ -451,7 +456,7 @@ declare global {
   }
 }
 
-interface ThumbnailCreationData {
+interface ThumbnailCreationData extends ImageHelper.TextureToImageOptions {
   /**
    * A background image to use for thumbnail creation, otherwise the current scene
    * background is used.

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

@@ -90,7 +90,7 @@ declare global {
 
     /**
      * Assign a Macro to a numbered hotbar slot between 1 and 50
-     * @param macro    - The Macro entity to assign
+     * @param macro    - The Macro document to assign
      * @param slot     - A specific numbered hotbar slot to fill
      * @param fromSlot - An optional origin slot from which the Macro is being shifted
      * @returns A Promise which resolves once the User update is complete
@@ -120,7 +120,7 @@ declare global {
     broadcastActivity(activityData?: ActivityData): void;
 
     /**
-     * Get an Array of Macro Entities on this User's Hotbar by page
+     * Get an Array of Macro Documents on this User's Hotbar by page
      * @param page - The hotbar page number
      *               (default: `1`)
      */
@@ -145,16 +145,6 @@ declare global {
     /** @override  */
     _onDelete(options: DocumentModificationOptions, userId: string): void;
 
-    /**
-     * @deprecated since 0.8.0
-     */
-    isRole(role: Parameters<User['hasRole']>[0]): boolean;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    setPermission(permission: keyof typeof CONST.USER_PERMISSIONS, allowed: boolean): Promise<this>;
-
     /** @remarks This property is set by PlayerList.getData() */
     charname?: string;