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

package/src/foundry/foundry.js/avSettings.d.ts

@@ -12,9 +12,11 @@ interface AVSettingsData {
 declare class AVSettings {
   constructor();
 
-  protected _set<T>(key: string, value: T): void;
+  /** @internal */
+  protected _set: <T>(key: string, value: T) => void;
 
-  protected _change(): void;
+  /** @internal */
+  protected _change: () => void;
 
   client: AVSettings.ClientSettings;
 
@@ -74,15 +76,7 @@ declare class AVSettings {
       /**
        * @defaultValue `'AVSettings.VOICE_MODES.PTT'`
        */
-      mode: AVSettings.VoiceMode;
-
-      /**
-       * @defaultValue
-       * ```
-       * "`"
-       * ```
-       */
-      pttKey: string;
+      mode: AVSettings.VOICE_MODES;
 
       /**
        * @defaultValue
@@ -92,11 +86,6 @@ declare class AVSettings {
        */
       pttName: string;
 
-      /**
-       * @defaultValue `false`
-       */
-      pttMouse: boolean;
-
       /**
        * @defaultValue `100`
        */
@@ -111,41 +100,14 @@ declare class AVSettings {
     /**
      * @defaultValue `{}`
      */
-    users: Partial<Record<string, AVSettings.StoredUserSettings>>;
+    users: Record<string, AVSettings.StoredUserSettings>;
   };
 
   static DEFAULT_WORLD_SETTINGS: {
     /**
      * @defaultValue `AVSettings.AV_MODES.DISABLED`
      */
-    mode: AVSettings.VoiceMode;
-
-    server: {
-      /**
-       * @defaultValue `'FVTT'`
-       */
-      type: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      url: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      room: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      username: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      password: string;
-    };
+    mode: AVSettings.AV_MODES;
 
     turn: {
       /**
@@ -217,6 +179,11 @@ declare class AVSettings {
     blocked: boolean;
   };
 
+  /**
+   * Stores the transient AV activity data received from other users.
+   */
+  activity: Record<string, AVSettingsData>;
+
   initialize(): void;
 
   changed(): void;
@@ -243,6 +210,11 @@ declare class AVSettings {
    * @internal
    */
   protected _onSettingsChanged(): void;
+
+  /**
+   * Handle another connected user changing their AV settings.
+   */
+  handleUserActivity(userId: string, settings: AVSettingsData): void;
 }
 
 declare namespace AVSettings {
@@ -259,5 +231,6 @@ declare namespace AVSettings {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface Overrides {}
   type VoiceModes = PropertyTypeOrFallback<AVSettings.Overrides, 'VoiceModes', DefaultVoiceModes>;
-  type VoiceMode = ValueOf<VoiceModes>;
+  type VOICE_MODES = ValueOf<VoiceModes>;
+  type AV_MODES = ValueOf<typeof AVSettings.AV_MODES>;
 }

package/src/foundry/foundry.js/clientDocumentMixin.d.ts

@@ -377,8 +377,8 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * @returns A data object of cleaned data suitable for compendium import
    */
   toCompendium(
-    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-    options?: ClientDocumentMixin.CompendiumExportOptions
+    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+    options?: ClientDocumentMixin.CompendiumExportOptions | undefined
   ): Omit<T['data']['_source'], '_id' | 'folder' | 'permission'> & {
     permission?: T['data']['_source']['permission'];
   };

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

@@ -31,6 +31,11 @@ declare global {
      */
     protected _sheet: FormApplication | null; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixins _sheet, this should actually be inferred from the CONFIG
 
+    /**
+     * Is there some system logic that makes this active effect ineligible for application?
+     */
+    get isSuppressed(): boolean;
+
     /**
      * Summarize the active effect duration
      */
@@ -63,12 +68,6 @@ declare global {
      */
     get sourceName(): string;
 
-    /**
-     * An instance of the ActiveEffectConfig sheet to use for this ActiveEffect instance.
-     * The reference to the sheet is cached so the same sheet instance is reused.
-     */
-    get sheet(): FormApplication; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixin's sheet, this should actually be inferred from the CONFIG
-
     /**
      * Apply this ActiveEffect to a provided Actor.
      * @param actor  - The Actor to whom this effect should be applied
@@ -138,6 +137,29 @@ declare global {
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
+
+    /** @override */
+    protected _onCreate(
+      data: foundry.data.ActiveEffectData['_source'],
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onUpdate(
+      data: DeepPartial<foundry.data.ActiveEffectData['_source']>,
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+
+    /**
+     * Display changes to active effects as scrolling Token status text.
+     * @internal
+     */
+    protected _displayScrollingStatus(enabled: boolean): void;
   }
 }
 

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/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>;
+  }
 }