@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/data/documents/folder.d.mts

@@ -1,153 +0,0 @@
-import type { DeepPartial, InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseFolder from "../../../common/documents/folder.d.mts";
-
-declare global {
-  namespace Folder {
-    type Metadata = Document.MetadataFor<Folder>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Folder">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Folder">;
-    type Stored = Document.Stored<ConfiguredInstance>;
-
-    interface DatabaseOperations extends Document.Database.Operations<Folder> {}
-
-    // Helpful aliases
-    type TypeNames = BaseFolder.TypeNames;
-    type ConstructorData = BaseFolder.ConstructorData;
-    type UpdateData = BaseFolder.UpdateData;
-    type Schema = BaseFolder.Schema;
-    type Source = BaseFolder.Source;
-
-    /**
-     * Actual document types that go in folders
-     */
-    type DocumentType = Exclude<foundry.CONST.FOLDER_DOCUMENT_TYPES, "Compendium">;
-
-    interface ExportToCompendiumOptions {
-      /** Update existing entries in the Compendium pack, matching by name */
-      updateByName?: boolean | undefined;
-    }
-  }
-
-  /**
-   * The client-side Folder document which extends the common BaseFolder model.
-   *
-   * @see {@link Folders}            The world-level collection of Folder documents
-   * @see {@link FolderConfig}       The Folder configuration application
-   */
-  class Folder<Type extends BaseFolder.TypeNames = BaseFolder.TypeNames> extends ClientDocumentMixin(
-    foundry.documents.BaseFolder,
-  )<Type> {
-    static override metadata: Folder.Metadata;
-
-    static get implementation(): Folder.ConfiguredClass;
-
-    // TODO(LukeAbby): This random override is a symptom of a greater issue.
-    // Namely that `ClientDocumentMixin` incidentally erases some properties and breaks configuration.
-    documentName: "Folder";
-
-    /**
-     * The depth of this folder in its sidebar tree
-     *
-     * @remarks For folders that have been populated by the {@link SidebarDirectory}, this is always be defined
-     */
-    depth?: number;
-
-    /**
-     * An array of other Folders which are the displayed children of this one. This differs from the results of
-     * {@link Folder.getSubfolders} because reports the subset of child folders which  are displayed to the current User
-     * in the UI.
-     */
-    children: Folder.ConfiguredInstance[];
-
-    /**
-     * Return whether the folder is displayed in the sidebar to the current User.
-     */
-    displayed: boolean;
-
-    /**
-     * The array of the Document instances which are contained within this Folder,
-     * unless it's a Folder inside a Compendium pack, in which case it's the array
-     * of objects inside the index of the pack that are contained in this Folder.
-     */
-    // TODO: Handle compendium. This requires the index to be configured.
-    get contents(): Document.ConfiguredInstanceForName<Extract<Type, Document.Type>>[];
-
-    set contents(value);
-
-    /**
-     * The reference to the Document type which is contained within this Folder.
-     */
-    // TODO: Compendium Pack index
-    get documentClass(): Document.ConfiguredClassForName<Extract<Type, Document.Type>>;
-
-    /**
-     * The reference to the WorldCollection instance which provides Documents to this Folder,
-     * unless it's a Folder inside a Compendium pack, in which case it's the index of the pack.
-     * A world Folder containing CompendiumCollections will have neither.
-     */
-    // TODO: Compendium Pack index
-    get documentCollection(): this["pack"] extends string ? unknown : undefined;
-
-    /**
-     * Return whether the folder is currently expanded within the sidebar interface.
-     */
-    get expanded(): boolean;
-
-    /**
-     * Return the list of ancestors of this folder, starting with the parent.
-     */
-    get ancestors(): Folder.ConfiguredInstance[];
-
-    /**
-     * @privateRemarks _preCreate overridden but with no signature changes.
-     * For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    static createDialog<T extends Document.AnyConstructor>(
-      this: T,
-      data?: DeepPartial<Document.ConstructorDataFor<NoInfer<T>>>,
-      context?: InexactPartial<Omit<FolderConfig.Options, "resolve">>,
-    ): Promise<Document.ToConfiguredInstance<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 documents will be exported
-     * @param options - Additional options which customize how content is exported. See {@link ClientDocument#toCompendium}
-     *                  (default: `{}`)
-     * @returns The updated Compendium Collection instance
-     */
-    exportToCompendium<Metadata extends CompendiumCollection.Metadata>(
-      pack: CompendiumCollection<Metadata>,
-      options?: Folder.ExportToCompendiumOptions,
-    ): Promise<CompendiumCollection<Metadata>>;
-
-    /**
-     * Provide a dialog form that allows for exporting the contents of a Folder into an eligible Compendium pack.
-     * @param pack    - A pack ID to set as the default choice in the select input
-     * @param options - Additional options passed to the Dialog.prompt method
-     *                  (default: `{}`)
-     * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
-     *
-     * @remarks - Foundry documents `pack` as just being a `string` but it is unused and Foundry itself
-     * calls `exportDialog` with `null`.
-     */
-    exportDialog(pack: string | null, options?: Dialog.Options): Promise<void>;
-
-    /**
-     * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
-     * @param recursive - Identify child folders recursively, if false only direct children are returned
-     *                    (default: `false`)
-     * @returns An array of Folder documents which are subfolders of this one
-     */
-    getSubfolders(recursive?: boolean): Folder.ConfiguredInstance[];
-
-    /**
-     * Get the Folder documents which are parent folders of the current folder or any if its parents.
-     * @returns An array of Folder documents which are parent folders of this one
-     */
-    getParentFolders(): Folder.ConfiguredInstance[];
-  }
-}

package/src/foundry/client/data/documents/index.d.mts

@@ -1,32 +0,0 @@
-import "./active-effect.d.mts";
-import "./actor-delta.d.mts";
-import "./actor.d.mts";
-import "./adventure.d.mts";
-import "./ambient-light.d.mts";
-import "./ambient-sound.d.mts";
-import "./card.d.mts";
-import "./cards.d.mts";
-import "./chat-message.d.mts";
-import "./combat.d.mts";
-import "./combatant.d.mts";
-import "./drawing.d.mts";
-import "./fog-exploration.d.mts";
-import "./folder.d.mts";
-import "./item.d.mts";
-import "./journal-entry.d.mts";
-import "./journal-entry-page.d.mts";
-import "./macro.d.mts";
-import "./measured-template.d.mts";
-import "./note.d.mts";
-import "./playlist-sound.d.mts";
-import "./playlist.d.mts";
-import "./region-behavior.d.mts";
-import "./region.d.mts";
-import "./scene.d.mts";
-import "./setting.d.mts";
-import "./table-result.d.mts";
-import "./table.d.mts";
-import "./tile.d.mts";
-import "./token.d.mts";
-import "./user.d.mts";
-import "./wall.d.mts";

package/src/foundry/client/data/documents/item.d.mts

@@ -1,71 +0,0 @@
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseItem from "../../../common/documents/item.d.mts";
-
-declare global {
-  namespace Item {
-    type Metadata = Document.MetadataFor<Item>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Item">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Item">;
-
-    interface DatabaseOperations extends Document.Database.Operations<Item> {}
-
-    // Helpful aliases
-    type TypeNames = BaseItem.TypeNames;
-    type ConstructorData = BaseItem.ConstructorData;
-    type UpdateData = BaseItem.UpdateData;
-    type Schema = BaseItem.Schema;
-    type Source = BaseItem.Source;
-  }
-
-  /**
-   * The client-side Item document which extends the common BaseItem abstraction.
-   * Each Item document contains ItemData which defines its data schema.
-   *
-   * @see {@link Items}            The world-level collection of Item documents
-   * @see {@link ItemSheet}     The Item configuration application
-   *
-   * @param data    - Initial data provided to construct the Item document
-   * @param context - The document context, see {@link foundry.abstract.Document}
-   */
-  class Item extends ClientDocumentMixin(foundry.documents.BaseItem) {
-    // Note(LukeAbby): Temporary fix, look into solving this at the root of the issue.
-    documentName: "Item";
-
-    static override metadata: Item.Metadata;
-
-    static get implementation(): Item.ConfiguredClass;
-
-    /**
-     * A convenience alias of Item#parent which is more semantically intuitive
-     */
-    get actor(): this["parent"];
-
-    /**
-     * Provide a thumbnail image path used to represent this document.
-     */
-    get thumbnail(): this["img"];
-
-    /**
-     * A convenience alias of Item#isEmbedded which is preserves legacy support
-     */
-    get isOwned(): this["isEmbedded"];
-
-    /**
-     * Return an array of the Active Effect instances which originated from this Item.
-     * The returned instances are the ActiveEffect instances which exist on the Item itself.
-     */
-    get transferredEffects(): ReturnType<this["effects"]["filter"]>;
-
-    /**
-     * Prepare a data object which defines the data schema used by dice roll commands against this Item
-     * @remarks defaults to this.system, but provided as object for flexible overrides
-     */
-    getRollData(): Record<string, unknown>;
-
-    /**
-     * @privateRemarks _preCreate, _onCreateDocuments and _onDeleteDocuments are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-  }
-}

package/src/foundry/client/data/documents/journal-entry-page.d.mts

@@ -1,232 +0,0 @@
-import type { InexactPartial, LazyUnknown } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseJournalEntryPage from "../../../common/documents/journal-entry-page.d.mts";
-
-declare global {
-  namespace JournalEntryPage {
-    type Metadata = Document.MetadataFor<JournalEntryPage>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"JournalEntryPage">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"JournalEntryPage">;
-
-    interface DatabaseOperations extends Document.Database.Operations<JournalEntryPage> {}
-
-    // Helpful aliases
-    type TypeNames = BaseJournalEntryPage.TypeNames;
-    type ConstructorData = BaseJournalEntryPage.ConstructorData;
-    type UpdateData = BaseJournalEntryPage.UpdateData;
-    type Schema = BaseJournalEntryPage.Schema;
-    type Source = BaseJournalEntryPage.Source;
-
-    interface JournalEntryPageHeading {
-      /** The heading level, 1-6. */
-      level: number;
-
-      /** The raw heading text with any internal tags omitted. */
-      text: string;
-
-      /** The generated slug for this heading. */
-      slug: string;
-
-      /** The currently rendered element for this heading, if it exists. */
-      element?: HTMLHeadingElement;
-
-      /** Any child headings of this one. */
-      children: string[];
-
-      /** The linear ordering of the heading in the table of contents. */
-      order: number;
-    }
-  }
-
-  /**
-   * The client-side JournalEntryPage document which extends the common BaseJournalEntryPage document model.
-   *
-   * @see {@link JournalEntry}  The JournalEntry document type which contains JournalEntryPage embedded documents.
-   */
-  class JournalEntryPage extends ClientDocumentMixin(foundry.documents.BaseJournalEntryPage) {
-    static override metadata: JournalEntryPage.Metadata;
-
-    static get implementation(): JournalEntryPage.ConfiguredClass;
-
-    /**
-     * The cached table of contents for this JournalEntryPage.
-     */
-    protected _toc: Record<string, JournalEntryPage.JournalEntryPageHeading>;
-
-    /**
-     * The table of contents for this JournalEntryPage.
-     */
-    get toc(): Record<string, JournalEntryPage.JournalEntryPageHeading>;
-
-    override get permission(): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
-
-    /**
-     * Return a reference to the Note instance for this Journal Entry Page in the current Scene, if any.
-     * If multiple notes are placed for this Journal Entry, only the first will be returned.
-     */
-    get sceneNote(): Note | null;
-
-    /**
-     * Convert a heading into slug suitable for use as an identifier.
-     * @param heading - The heading element or some text content.
-     */
-    static slugifyHeading(heading: HTMLHeadingElement | string): string;
-
-    /**
-     * Build a table of contents for the given HTML content.
-     * @param html    - The HTML content to generate a ToC outline for.
-     * @param options - Additional options to configure ToC generation.
-     */
-    static buildTOC(
-      html: HTMLElement[],
-      options: InexactPartial<{
-        /**
-         * Include references to the heading DOM elements in the returned ToC.
-         * @defaultValue `true`
-         */
-        includeElement: boolean;
-      }>,
-    ): Record<string, JournalEntryPage.JournalEntryPageHeading>;
-
-    /**
-     * Flatten the tree structure into a single object with each node's slug as the key.
-     * @param nodes - The root ToC nodes.
-     */
-    protected static _flattenTOC(
-      nodes: JournalEntryPage.JournalEntryPageHeading[],
-    ): Record<string, JournalEntryPage.JournalEntryPageHeading>;
-
-    /**
-     * Construct a table of contents node from a heading element.
-     * @param heading - The heading element.
-     * @param options - Additional options to configure the returned node.
-     */
-    protected static _makeHeadingNode(
-      heading: HTMLHeadingElement,
-      options: InexactPartial<{
-        /**
-         * Whether to include the DOM element in the returned ToC node.
-         * @defaultValue `true`
-         */
-        includeElement: boolean;
-      }>,
-    ): JournalEntryPage.JournalEntryPageHeading;
-
-    protected override _createDocumentLink(
-      eventData: unknown,
-      options?: InexactPartial<{
-        /**
-         * A document to generate a link relative to.
-         */
-        relativeTo: ClientDocument;
-        /**
-         * A custom label to use instead of the document's name.
-         */
-        label: string;
-      }>,
-    ): string;
-
-    override _onClickDocumentLink(event: MouseEvent): this;
-
-    /**
-     * @privateRemarks _onUpdate is overridden but with no signature changes.
-     * For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    protected override _buildEmbedHTML(
-      config: TextEditor.DocumentHTMLEmbedConfig,
-    ): Promise<HTMLCollection | HTMLElement | null>;
-
-    protected override _createFigureEmbed(
-      content: HTMLElement | HTMLCollection,
-      config: TextEditor.DocumentHTMLEmbedConfig,
-      options?: TextEditor.EnrichmentOptions,
-    ): Promise<HTMLElement | null>;
-
-    /**
-     * Embed text page content.
-     * @param config        - Configuration for embedding behavior. This can include
-     *                        enrichment options to override those passed as part of
-     *                        the root enrichment process.
-     * @param options       - The original enrichment options to propagate to the embedded text page's
-     *                        enrichment.
-     * @returns
-     *
-     * @example Embed the content of the Journal Entry Page as a figure.
-     * ```
-     * @Embed[.yDbDF1ThSfeinh3Y classes="small right"]{Special caption}
-     * ```
-     * becomes
-     * ```html
-     * <figure class="content-embed small right" data-content-embed
-     *         data-uuid="JournalEntry.ekAeXsvXvNL8rKFZ.JournalEntryPage.yDbDF1ThSfeinh3Y">
-     *   <p>The contents of the page</p>
-     *   <figcaption>
-     *     <strong class="embed-caption">Special caption</strong>
-     *     <cite>
-     *       <a class="content-link" draggable="true" data-link
-     *          data-uuid="JournalEntry.ekAeXsvXvNL8rKFZ.JournalEntryPage.yDbDF1ThSfeinh3Y"
-     *          data-id="yDbDF1ThSfeinh3Y" data-type="JournalEntryPage" data-tooltip="Text Page">
-     *         <i class="fas fa-file-lines"></i> Text Page
-     *       </a>
-     *     </cite>
-     *   <figcaption>
-     * </figure>
-     * ```
-     *
-     * @example Embed the content of the Journal Entry Page into the main content flow.
-     * ```
-     * @Embed[.yDbDF1ThSfeinh3Y inline]
-     * ```
-     * becomes
-     * ```html
-     * <section class="content-embed" data-content-embed
-     *          data-uuid="JournalEntry.ekAeXsvXvNL8rKFZ.JournalEntryPage.yDbDF1ThSfeinh3Y">
-     *   <p>The contents of the page</p>
-     * </section>
-     * ```
-     */
-    protected _embedTextPage(
-      config: TextEditor.DocumentHTMLEmbedConfig & TextEditor.EnrichmentOptions,
-      options?: TextEditor.EnrichmentOptions,
-    ): Promise<HTMLCollection>;
-
-    /**
-     * Embed image page content.
-     * @param config            - Configuration for embedding behavior.
-     * @param options           - The original enrichment options for cases where the Document embed content
-     *                            also contains text that must be enriched.
-     * @returns
-     *
-     * @example Create an embedded image from a sibling journal entry page.
-     * ```
-     * @Embed[.QnH8yGIHy4pmFBHR classes="small right"]{Special caption}
-     * ```
-     * becomes
-     * ```html
-     * <figure class="content-embed small right" data-content-embed
-     *         data-uuid="JournalEntry.xFNPjbSEDbWjILNj.JournalEntryPage.QnH8yGIHy4pmFBHR">
-     *   <img src="path/to/image.webp" alt="Special caption">
-     *   <figcaption>
-     *     <strong class="embed-caption">Special caption</strong>
-     *     <cite>
-     *       <a class="content-link" draggable="true" data-link
-     *          data-uuid="JournalEntry.xFNPjbSEDbWjILNj.JournalEntryPage.QnH8yGIHy4pmFBHR"
-     *          data-id="QnH8yGIHy4pmFBHR" data-type="JournalEntryPage" data-tooltip="Image Page">
-     *         <i class="fas fa-file-image"></i> Image Page
-     *       </a>
-     *     </cite>
-     *   </figcaption>
-     * </figure>
-     * ```
-     */
-    protected _embedImagePage(
-      config: TextEditor.DocumentHTMLEmbedConfig & {
-        /** Alt text for the image, otherwise the caption will be used. **/
-        alt?: string | LazyUnknown;
-      },
-      options?: InexactPartial<TextEditor.EnrichmentOptions>,
-    ): Promise<HTMLElement | HTMLCollection | null>;
-  }
-}

package/src/foundry/client/data/documents/journal-entry.d.mts

@@ -1,82 +0,0 @@
-import type { BaseJournalEntry } from "../../../common/documents/_module.d.mts";
-import type Document from "../../../common/abstract/document.d.mts";
-
-declare global {
-  namespace JournalEntry {
-    type Metadata = Document.MetadataFor<JournalEntry>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"JournalEntry">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"JournalEntry">;
-
-    interface DatabaseOperations extends Document.Database.Operations<JournalEntry> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseJournalEntry.ConstructorData;
-    type UpdateData = BaseJournalEntry.UpdateData;
-    type Schema = BaseJournalEntry.Schema;
-    type Source = BaseJournalEntry.Source;
-  }
-
-  /**
-   * The client-side JournalEntry document which extends the common BaseJournalEntry model.
-   *
-   * @see {@link Journal}                  The world-level collection of JournalEntry documents
-   * @see {@link JournalSheet}          The JournalEntry configuration application
-   */
-  class JournalEntry extends ClientDocumentMixin(foundry.documents.BaseJournalEntry) {
-    static override metadata: JournalEntry.Metadata;
-
-    static get implementation(): JournalEntry.ConfiguredClass;
-
-    /**
-     * A boolean indicator for whether or not the JournalEntry is visible to the current user in the directory sidebar
-     */
-    get visible(): boolean;
-
-    override getUserLevel(user?: User): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
-
-    /**
-     * Return a reference to the Note instance for this Journal Entry in the current Scene, if any.
-     * If multiple notes are placed for this Journal Entry, only the first will be returned.
-     */
-    get sceneNote(): Note | null;
-
-    /**
-     * Show the JournalEntry to connected players.
-     * By default the entry will only be shown to players who have permission to observe it.
-     * If the parameter force is passed, the entry will be shown to all players regardless of normal permission.
-     *
-     * @param force - Display the entry to all players regardless of normal permissions
-     *                (default: `false`)
-     * @returns A Promise that resolves back to the shown entry once the request is processed
-     */
-    show(force?: boolean): Promise<this>;
-
-    /**
-     * If the JournalEntry has a pinned note on the canvas, this method will animate to that note
-     * The note will also be highlighted as if hovered upon by the mouse
-     * @param options - Options which modify the pan operation
-     * @returns A Promise which resolves once the pan animation has concluded
-     */
-    panToNote(options?: PanToNoteOptions): Promise<void>;
-
-    /**
-     * @privateRemarks _onUpdate and _onDelete are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-  }
-}
-
-interface PanToNoteOptions {
-  /**
-   * The speed of the pan animation in milliseconds
-   * @defaultValue `250`
-   */
-  duration?: number;
-
-  /**
-   * The resulting zoom level
-   * @defaultValue `1.5`
-   */
-  scale?: number;
-}

package/src/foundry/client/data/documents/macro.d.mts

@@ -1,86 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseMacro from "../../../common/documents/macro.d.mts";
-
-declare global {
-  namespace Macro {
-    type Metadata = Document.MetadataFor<Macro>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Macro">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Macro">;
-
-    interface DatabaseOperations extends Document.Database.Operations<Macro> {}
-
-    // Helpful aliases
-    type TypeNames = BaseMacro.TypeNames;
-    type ConstructorData = BaseMacro.ConstructorData;
-    type UpdateData = BaseMacro.UpdateData;
-    type Schema = BaseMacro.Schema;
-    type Source = BaseMacro.Source;
-
-    interface Scope {
-      /** An Actor who is the protagonist of the executed action. */
-      actor: Actor;
-
-      /**  A Token which is the protagonist of the executed action. */
-      token: Token;
-
-      /** An optional event passed to the executed macro. */
-      event: Event | RegionDocument.RegionEvent;
-
-      /**
-       * @remarks Additional arguments passed as part of the scope
-       */
-      [arg: string]: unknown;
-    }
-  }
-
-  /**
-   * The client-side Macro document which extends the common BaseMacro model.
-   *
-   * @see {@link Macros}            The world-level collection of Macro documents
-   * @see {@link MacroConfig}       The Macro configuration application
-   *
-   * @param data - Initial data provided to construct the Macro document
-   */
-  class Macro extends ClientDocumentMixin(foundry.documents.BaseMacro) {
-    static override metadata: Macro.Metadata;
-
-    static get implementation(): Macro.ConfiguredClass;
-
-    /**
-     * Is the current User the author of this macro?
-     */
-    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;
-
-    /**
-     * Test whether the given User is capable of executing this Macro.
-     * @param user - The User to test.
-     * @returns Can this User execute this Macro?
-     */
-    canUserExecute(user: User): boolean;
-
-    /**
-     * Execute the Macro command.
-     * @param scope - Macro execution scope which is passed to script macros
-     * @returns A promising containing a created {@link ChatMessage} (or `undefined`) if a chat
-     *          macro or the return value if a script macro. A void return is possible if the user
-     *          is not permitted to execute macros or a script macro execution fails.
-     */
-    execute(scope?: InexactPartial<Macro.Scope>): Promise<ChatMessage | void> | Promise<unknown> | void;
-
-    #executeScript();
-
-    _onClickDocumentLink(event: MouseEvent): ReturnType<this["execute"]>;
-  }
-}