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

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

@@ -61,6 +61,11 @@ declare global {
      */
     get img(): this['data']['img'];
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['img'];
+
     /**
      * Provide an object which organizes all embedded Item instances by their type
      */
@@ -69,7 +74,7 @@ declare global {
       Array<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>>>
     >;
     /**
-     * Test whether an Actor entity is a synthetic representation of a Token (if true) or a full Entity (if false)
+     * Test whether an Actor document is a synthetic representation of a Token (if true) or a full Document (if false)
      */
     get isToken(): boolean;
 
@@ -83,11 +88,6 @@ declare global {
      */
     get token(): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
 
-    /**
-     * A convenience reference to the item type (data.type) of this Actor
-     */
-    get type(): this['data']['type'];
-
     /** @override */
     get uuid(): string;
 
@@ -122,9 +122,6 @@ declare global {
      */
     getRollData(): object;
 
-    /** @override */
-    protected _getSheetClass(): ConstructorOf<FormApplication> | null;
-
     /**
      * Create a new TokenData object which can be used to create a Token representation of the Actor.
      * @param data - Additional data, such as x, y, rotation, etc. for the created token data (default: `{}`)
@@ -149,15 +146,15 @@ declare global {
     modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
 
     /** @override */
-    prepareEmbeddedEntities(): void;
+    prepareEmbeddedDocuments(): void;
 
     /**
      * Roll initiative for all Combatants in the currently active Combat encounter which are associated with this Actor.
-     * If viewing a full Actor entity, all Tokens which map to that actor will be targeted for initiative rolls.
+     * If viewing a full Actor document, all Tokens which map to that actor will be targeted for initiative rolls.
      * If viewing a synthetic Token actor, only that particular Token will be targeted for an initiative roll.
      *
      * @param options - Configuration for how initiative for this Actor is rolled.
-     * @returns A promise which resolves to the Combat entity once rolls are complete.
+     * @returns A promise which resolves to the Combat document once rolls are complete.
      */
     rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
 
@@ -206,65 +203,11 @@ declare global {
     ): void;
 
     /**
-     * Refresh the display of active Tokens for this Actor if ActiveEffects were changed
-     */
-    protected _refreshTokens(): void;
-
-    /**
-     * You are referencing Actor#_data which has been deprecated in favor of Actor#data#_source. Support for this reference will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    get _data(): this['data']['_source'];
-
-    /**
-     * You are referencing Actor#getOwnedItem(itemId) which is deprecated in favor of Actor#items#get(itemId). Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    getOwnedItem(itemId: string): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>> | undefined;
-
-    /**
-     * You are referencing Actor#createOwnedItem which is deprecated in favor of Item.create or Actor#createEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    createOwnedItem(
-      itemData: Parameters<this['createEmbeddedDocuments']>[1][] | Parameters<this['createEmbeddedDocuments']>[1],
-      options: Parameters<this['createEmbeddedDocuments']>[2]
-    ): ReturnType<this['createEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor#updateOwnedItem which is deprecated in favor of Item#update or Actor#updateEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    updateOwnedItem(
-      itemData: Parameters<this['updateEmbeddedDocuments']>[1][] | Parameters<this['updateEmbeddedDocuments']>[1],
-      options: Parameters<this['updateEmbeddedDocuments']>[2]
-    ): ReturnType<this['updateEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor#deleteOwnedItem which is deprecated in favor of Item#delete or Actor#deleteEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    deleteOwnedItem(
-      itemId: Parameters<this['deleteEmbeddedDocuments']>[1][] | Parameters<this['deleteEmbeddedDocuments']>[1],
-      options: Parameters<this['deleteEmbeddedDocuments']>[2]
-    ): ReturnType<this['deleteEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor.fromToken which is deprecated in favor of TokenDocument#getActor. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    static fromToken(
-      token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>;
-
-    /**
-     * You are referencing Actor.createTokenActor which is deprecated in favor of TokenDocument#getActor. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
+     * Perform various actions on active tokens if embedded documents were changed.
+     * @param embeddedName - The type of embedded document that was modified.
+     * @internal
      */
-    static createTokenActor(
-      _baseActor: unknown,
-      token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>;
+    protected _onEmbeddedDocumentChange(embeddedName: string): void;
   }
   namespace Actor {
     interface RollInitiativeOptions {

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

@@ -1,6 +1,7 @@
 import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 import * as data from '../../../common/data/data.mjs';
+import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
 
 declare global {
   /**
@@ -30,8 +31,8 @@ declare global {
 
     /**
      * A lazily evaluated reference to the Actor this Token modifies.
-     * If actorLink is true, then the entity is the primary Actor document.
-     * Otherwise the Actor entity is a synthetic (ephemeral) document constructed using the Token's actorData.
+     * If actorLink is true, then the document is the primary Actor document.
+     * Otherwise the Actor document is a synthetic (ephemeral) document constructed using the Token's actorData.
      */
     get actor(): InstanceType<ConfiguredDocumentClass<typeof Actor>> | null;
 
@@ -55,6 +56,11 @@ declare global {
      */
     get inCombat(): boolean;
 
+    /**
+     * Is the Token currently hidden from player view?
+     */
+    get hidden(): boolean;
+
     /**
      * @param data    - (default: `{}`, unused)
      * @param options - (default: `{}`, unused)
@@ -67,7 +73,7 @@ declare global {
 
     /**
      * Create a synthetic Actor using a provided Token instance
-     * If the Token data is linked, return the true Actor entity
+     * If the Token data is linked, return the true Actor document
      * If the Token data is not linked, create a synthetic Actor using the Token's actorData override
      */
     getActor(): InstanceType<ConfiguredDocumentClass<typeof Actor>> | null;
@@ -83,6 +89,18 @@ declare global {
       { alternative }?: { alternative?: string }
     ): SingleAttributeBar | ObjectAttributeBar | null;
 
+    /**
+     * A helper function to toggle a status effect which includes an Active Effect template
+     * @param effectData - The Active Effect data, including statusId
+     * @param options    - Options to configure application of the Active Effect
+     *                     (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>;
+
     /**
      * Redirect updates to a synthetic Token Actor to instead update the tokenData override object.
      * Once an attribute in the Token has been overridden, it must always remain overridden.
@@ -138,10 +156,10 @@ declare global {
 
     /**
      * Redirect deletion of Documents within a synthetic Token Actor to instead update the tokenData override object.
-     * @param embeddedName - The named embedded Document type being modified
-     * @param ids          - The provided differential data with which to update the embedded Documents
-     * @param options      - Provided options which modify the update request
-     * @returns The updated Embedded Document instances
+     * @param embeddedName - The named embedded Document type being deleted
+     * @param ids          - The IDs of Documents to delete
+     * @param options      - Provided options which modify the deletion request
+     * @returns The deleted Embedded Document instances
      */
     deleteActorEmbeddedDocuments(
       embeddedName: 'Item',
@@ -163,6 +181,7 @@ declare global {
 
     /**
      * When the Actor data overrides change for an un-linked Token Actor, simulate the pre-update process.
+     * @internal
      */
     protected _preUpdateTokenActor(
       data: Parameters<foundry.documents.BaseActor['_preUpdate']>[0],
@@ -180,11 +199,16 @@ declare global {
     /**
      * When the base Actor for a TokenDocument changes, we may need to update its Actor instance
      * @param update - (default: `{}`)
+     * @internal
      */
-    protected _onUpdateBaseActor(update?: Parameters<foundry.documents.BaseActor['_onUpdate']>[0]): void;
+    protected _onUpdateBaseActor(
+      update?: Parameters<foundry.documents.BaseActor['_onUpdate']>[0],
+      options?: Parameters<foundry.data.ActorData['update']>[1]
+    ): void;
 
     /**
      * When the Actor data overrides change for an un-linked Token Actor, simulate the post-update process.
+     * @internal
      */
     protected _onUpdateTokenActor(
       data: Parameters<foundry.documents.BaseActor['_onUpdate']>[0],
@@ -228,4 +252,13 @@ interface TrackedAttributes {
   value: string[][];
 }
 
-export {};
+interface ToggleActiveEffectOptions {
+  /**
+   * Should the Active Effect icon be displayed as an overlay on the token?
+   * @defaultValue `false`
+   */
+  overlay?: boolean | undefined;
+
+  /** Force a certain active state for the effect. */
+  active?: boolean | undefined;
+}

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

@@ -72,7 +72,8 @@ declare global {
      * Pass an array of specific Card documents from this document to some other Cards stack.
      * @param to      - Some other Cards document that is the destination for the pass operation
      * @param ids     - The embedded Card ids which should be passed
-     * @param options - (default: `{}`)
+     * @param options - Additional options which modify the pass operation
+     *                  (default: `{}`)
      * @returns An array of the Card embedded documents created within the destination stack
      */
     pass(
@@ -223,7 +224,7 @@ declare global {
     resetDialog(): Promise<InstanceType<ConfiguredDocumentClassForName<'Cards'>> | false | null>;
 
     /** @override */
-    deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
+    deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
     /** @override */
@@ -235,7 +236,7 @@ declare global {
             | (ConstructorDataType<foundry.data.CardsData> & Record<string, unknown>)
           >
         | undefined,
-      context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<Dialog.Options>) | undefined
+      context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<DialogOptions>) | undefined
     ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
   }
 

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.
@@ -97,7 +97,7 @@ declare global {
      *                  (default: `{}`)
      * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
      */
-    exportDialog(pack: string, options?: Dialog.Options): Promise<void>;
+    exportDialog(pack: string, options?: DialogOptions): Promise<void>;
 
     /**
      * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
@@ -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/playlist.d.ts

@@ -22,13 +22,6 @@ declare global {
       context?: ConstructorParameters<typeof foundry.documents.BasePlaylist>[1]
     );
 
-    /**
-     * Each sound which is played within the Playlist has a created Sound instance.
-     * The keys of this object are the sound IDs and the values are the Sound instances.
-     * @remarks This seems to be unused and will always be the empty object, see https://gitlab.com/foundrynet/foundryvtt/-/issues/5970
-     */
-    audio: {};
-
     /**
      * Playlists may have a playback order which defines the sequence of Playlist Sounds
      * @defaultValue `undefined`
@@ -57,7 +50,7 @@ declare global {
 
     /**
      * Begin simultaneous playback for all sounds in the Playlist.
-     * @returns The updated Playlist entity
+     * @returns The updated Playlist document
      */
     playAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
 
@@ -94,7 +87,7 @@ declare global {
 
     /**
      * End playback for any/all currently playing sounds within the Playlist.
-     * @returns The updated Playlist entity
+     * @returns The updated Playlist document
      */
     stopAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
 
@@ -187,10 +180,10 @@ declare global {
     _onSoundStart(sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): Promise<void>;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.PlaylistData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.PlaylistData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.PlaylistData['_source']['permission'];
     };
   }

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.