@7h3laughingman/foundry-types 13.351.0

package/src/client/documents/combatant.d.mts

@@ -0,0 +1,125 @@
+import Roll, { Rolled } from "../dice/roll.mjs";
+import { DatabaseCreateOperation, DatabaseDeleteOperation, DatabaseUpdateOperation } from "./../../common/abstract/_types.mjs";
+import Document from "./../../common/abstract/document.mjs";
+import { DocumentOwnershipLevel } from "./../../common/constants.mjs";
+import CombatantConfig from "./../applications/sheets/combatant-config.mjs";
+import { BaseCombatant, BaseUser, Combat, TokenDocument, User } from "./_module.mjs";
+import { ClientDocument, ClientDocumentStatic } from "./abstract/client-document.mjs";
+
+interface ClientBaseCombatantStatic extends Omit<typeof BaseCombatant, "new">, ClientDocumentStatic {}
+
+declare const ClientBaseCombatant: {
+    new <TParent extends Combat | null>(...args: any): BaseCombatant<TParent> & ClientDocument<TParent>;
+} & ClientBaseCombatantStatic;
+
+declare interface ClientBaseCombatant<TParent extends Combat | null> extends InstanceType<typeof ClientBaseCombatant<TParent>> {}
+
+/**
+ * The client-side Combatant document which extends the common BaseCombatant model.
+ *
+ * @see {@link Combat}                  The Combat document which contains Combatant embedded documents
+ * @see {@link CombatantConfig}         The application which configures a Combatant.
+ */
+export default class Combatant<
+    TParent extends Combat | null = Combat | null,
+    TTokenDocument extends TokenDocument | null = TokenDocument | null,
+> extends ClientBaseCombatant<TParent> {
+    /**
+     * The token video source image (if any)
+     */
+    _videoSrc: string | null;
+
+    /** The current value of the special tracked resource which pertains to this Combatant */
+    resource: { value: number } | null;
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * A convenience alias of Combatant#parent which is more semantically intuitive
+     */
+    get combat(): TParent;
+
+    /**
+     * This is treated as a non-player combatant if it has no associated actor and no player users who can control
+     * it
+     */
+    get isNPC(): boolean;
+
+    /**
+     * Eschew `ClientDocument`'s redirection to `Combat#permission` in favor of special ownership determination.
+     */
+    override get permission(): DocumentOwnershipLevel;
+
+    /** Is this Combatant entry currently visible in the Combat Tracker? */
+    get isVisible(): boolean;
+
+    /** A reference to the Actor document which this Combatant represents, if any */
+    get actor(): NonNullable<TTokenDocument>["actor"];
+
+    /** A reference to the Token document which this Combatant represents, if any */
+    get token(): TTokenDocument;
+
+    /** An array of User documents who have ownership of this Document */
+    get players(): User[];
+
+    /** Has this combatant been marked as defeated? */
+    get isDefeated(): boolean;
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    /**
+     * Get a Roll object which represents the initiative roll for this Combatant.
+     * @param formula An explicit Roll formula to use for the combatant.
+     * @return The Roll instance to use for the combatant.
+     */
+    getInitiativeRoll(formula: string): Roll;
+
+    /**
+     * Roll initiative for this particular combatant.
+     * @param [formula] A dice formula which overrides the default for this Combatant.
+     * @return The Roll instance to use for the combatant.
+     */
+    rollInitiative(formula: string): Rolled<Roll>;
+
+    override prepareDerivedData(): void;
+
+    /** Update the value of the tracked resource for this Combatant. */
+    updateResource(): { value: number } | null;
+
+    /**
+     * Acquire the default dice formula which should be used to roll initiative for this combatant.
+     * Modules or systems could choose to override or extend this to accommodate special situations.
+     * @return The initiative formula to use for this combatant.
+     */
+    protected _getInitiativeFormula(): string;
+
+    /**
+     * Prepare derived data based on group membership.
+     */
+    protected _prepareGroup(): void;
+
+    /**
+     * Clear the movement history of the Combatant's Token.
+     */
+    clearMovementHistory(): Promise<void>;
+
+    /* -------------------------------------------- */
+    /*  Database Lifecycle Events                   */
+    /* -------------------------------------------- */
+
+    static override _preCreateOperation(documents: Document[], operation: DatabaseCreateOperation<Document | null>, user: BaseUser): Promise<boolean | void>;
+
+    static override _preUpdateOperation(documents: Document[], operation: DatabaseUpdateOperation<Document | null>, user: BaseUser): Promise<boolean | void>;
+
+    static override _preDeleteOperation(documents: Document[], operation: DatabaseDeleteOperation<Document | null>, user: BaseUser): Promise<boolean | void>;
+}
+
+export default interface Combatant<TParent extends Combat | null> extends ClientBaseCombatant<TParent> {
+    get sheet(): CombatantConfig;
+}
+
+export {};

package/src/client/documents/drawing.d.mts

@@ -0,0 +1,27 @@
+import Drawing from "../canvas/placeables/drawing.mjs";
+import { BaseDrawing, Scene } from "./_module.mjs";
+import { CanvasDocument } from "./abstract/canvas-document.mjs";
+
+declare const CanvasBaseDrawing: new <TParent extends Scene | null>(...args: any) => BaseDrawing<TParent> & CanvasDocument<TParent>;
+
+interface CanvasBaseDrawing<TParent extends Scene | null> extends InstanceType<typeof CanvasBaseDrawing<TParent>> {}
+
+/**
+ * The client-side Drawing document which extends the common BaseDrawing model.
+ *
+ * @see {@link Scene}               The Scene document type which contains Drawing embedded documents
+ * @see {@link DrawingConfig}       The Drawing configuration application
+ */
+export default class DrawingDocument<TParent extends Scene | null = Scene | null> extends CanvasBaseDrawing<TParent> {
+    /** Define an elevation property on the Drawing Document which in the future will become a part of its data schema. */
+    accessor elevation: number;
+
+    /** A flag for whether the current User has full ownership over the Drawing document. */
+    override get isOwner(): boolean;
+}
+
+export default interface DrawingDocument<TParent extends Scene | null = Scene | null> extends CanvasBaseDrawing<TParent> {
+    readonly _object: Drawing<this> | null;
+}
+
+export {};

package/src/client/documents/fog-exploration.d.mts

@@ -0,0 +1,30 @@
+import { DatabaseCreateCallbackOptions, DatabaseDeleteCallbackOptions, DatabaseUpdateCallbackOptions } from "./../../common/abstract/_types.mjs";
+import { BaseFogExploration } from "./_module.mjs";
+import ClientDocumentMixin from "./abstract/client-document.mjs";
+
+/**
+ * The client-side FogExploration document which extends the common BaseFogExploration model.
+ */
+export default class FogExploration extends ClientDocumentMixin(BaseFogExploration) {
+    /**
+     * Obtain the fog of war exploration progress for a specific Scene and User.
+     * @param query       Parameters for which FogExploration document is retrieved
+     * @param query.scene A certain Scene ID
+     * @param query.user  A certain User ID
+     * @param options Additional options passed to DatabaseBackend#get
+     */
+    static load(query?: { scene?: string; user?: string }, options?: object): Promise<FogExploration | null>;
+
+    /**
+     * Transform the explored base64 data into a PIXI.Texture object
+     */
+    getTexture(): PIXI.Texture | null;
+
+    protected override _onCreate(data: this["_source"], options: DatabaseCreateCallbackOptions, userId: string): void;
+
+    protected override _onUpdate(data: DeepPartial<this["_source"]>, options: DatabaseUpdateCallbackOptions, userId: string): void;
+
+    protected override _onDelete(options: DatabaseDeleteCallbackOptions, userId: string): void;
+}
+
+export {};

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

@@ -0,0 +1,124 @@
+import { DatabaseCreateCallbackOptions, DatabaseCreateOperation, DatabaseDeleteCallbackOptions } from "./../../common/abstract/_types.mjs";
+import Document from "./../../common/abstract/document.mjs";
+import { Actor, BaseFolder, BaseUser, Item, JournalEntry, Macro, RollTable, Scene } from "./_module.mjs";
+import { ClientDocument, ClientDocumentStatic } from "./abstract/client-document.mjs";
+import WorldCollection from "./abstract/world-collection.mjs";
+import CompendiumCollection from "./collections/compendium-collection.mjs";
+
+type BaseFolderStatic = typeof BaseFolder;
+interface ClientBaseFolderStatic extends BaseFolderStatic, ClientDocumentStatic {}
+
+declare const ClientBaseFolder: {
+    new (...args: any): BaseFolder & ClientDocument<null>;
+} & ClientBaseFolderStatic;
+
+interface ClientBaseFolder extends InstanceType<typeof ClientBaseFolder> {}
+
+/**
+ * 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
+ */
+export default class Folder<TDocument extends EnfolderableDocument = EnfolderableDocument> extends ClientBaseFolder {
+    /** The depth of this folder in its sidebar tree */
+    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<TDocument>[];
+
+    /** Return whether the folder is displayed in the sidebar to the current User. */
+    displayed: boolean;
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * 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.
+     */
+    get contents(): TDocument[];
+
+    set contents(value: TDocument[]);
+
+    /** Return a reference to the Document type which is contained within this Folder. */
+    get documentClass(): ConstructorOf<TDocument>;
+
+    /** Return a reference to the WorldCollection instance which provides Documents to this Folder. */
+    get documentCollection(): WorldCollection<TDocument>;
+
+    /** 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<TDocument>[];
+
+    /** A reference to the parent Folder if one is set, otherwise null. */
+    get parentFolder(): this | null;
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    override _preCreate(data: DeepPartial<this["_source"]>, options: DatabaseCreateCallbackOptions, user: BaseUser): Promise<boolean | void>;
+
+    /**
+     * Create a new Folder by rendering a dialog window to provide basic creation details
+     * @param data Initial data with which to populate the creation form
+     * @param options Initial positioning and sizing options for the dialog form
+     * @return An active FolderConfig instance for creating the new Folder entity
+     */
+    static override createDialog<T extends ClientDocument>(
+        this: ConstructorOf<T>,
+        data?: object,
+        createOptions?: Partial<DatabaseCreateOperation<Document | null>>,
+        options?: {
+            folders?: { id: string; name: string }[];
+            types?: string[];
+            template?: string;
+            context?: object;
+        },
+    ): Promise<T | null>;
+
+    /**
+     * 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
+     * @return The updated Compendium Collection instance
+     */
+    exportToCompendium(pack: CompendiumCollection<TDocument>, { updateByName }?: { updateByName?: boolean }): Promise<CompendiumCollection<TDocument>>;
+
+    /**
+     * 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
+     * @return A Promise which resolves or rejects once the dialog has been submitted or closed
+     */
+    exportDialog(pack: string, options?: Record<string, unknown>): Promise<void>;
+
+    protected override _onDelete(options: DatabaseDeleteCallbackOptions, userId: string): void;
+
+    /**
+     * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
+     * @param [recursive=false] Identify child folders recursively, if false only direct children are returned
+     * @returns An array of Folder documents which are subfolders of this one
+     */
+    getSubfolders(recursive?: boolean): Folder<TDocument>[];
+
+    /**
+     * 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<TDocument>[];
+}
+
+export type EnfolderableDocument = Actor<null> | Item<null> | Macro | Scene | JournalEntry | RollTable;
+
+export {};

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

@@ -0,0 +1,73 @@
+import { DocumentSheetV1Options } from "../appv1/api/document-sheet-v1.mjs";
+import ItemSheet from "../appv1/sheets/item-sheet.mjs";
+import { DatabaseCreateCallbackOptions, DatabaseCreateOperation, DatabaseDeleteOperation } from "./../../common/abstract/_types.mjs";
+import Document from "./../../common/abstract/document.mjs";
+import { Actor, BaseItem, BaseUser, ItemSource, ItemUUID } from "./_module.mjs";
+import { ClientDocument, ClientDocumentStatic } from "./abstract/client-document.mjs";
+
+interface ClientBaseItemStatic extends Omit<typeof BaseItem, "new">, ClientDocumentStatic {}
+
+declare const ClientBaseItem: {
+    new <TParent extends Actor | null>(...args: any): BaseItem<TParent> & ClientDocument<TParent>;
+} & ClientBaseItemStatic;
+
+declare interface ClientBaseItem<TParent extends Actor | null> extends InstanceType<typeof ClientBaseItem<TParent>> {}
+
+/**
+ * The client-side Item document which extends the common BaseItem model.
+ *
+ * @see {@link foundry.documents.collections.Items} The world-level collection of Item documents
+ * @see {@link foundry.applications.sheets.ItemSheetV2} The Item configuration application
+ */
+declare class Item<TParent extends Actor | null = Actor | null> extends ClientBaseItem<TParent> {
+    /** A convenience alias of Item#parent which is more semantically intuitive */
+    get actor(): TParent;
+
+    /** 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(): boolean;
+
+    /**
+     * 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(): CollectionValue<this["effects"]>[];
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    /** Prepare a data object which defines the data schema used by dice roll commands against this Item */
+    getRollData(): object;
+
+    /* -------------------------------------------- */
+    /*  Event Handlers                              */
+    /* -------------------------------------------- */
+
+    protected override _preCreate(data: DeepPartial<this["_source"]>, options: DatabaseCreateCallbackOptions, user: BaseUser): Promise<boolean | void>;
+
+    static override _onCreateOperation<TDocument extends Document>(
+        this: ConstructorOf<TDocument>,
+        items: TDocument[],
+        context: DatabaseCreateOperation<TDocument["parent"]>,
+    ): Promise<void>;
+
+    static override _onDeleteOperation(documents: Document[], operation: DatabaseDeleteOperation<Document | null>, user: BaseUser): Promise<void>;
+}
+
+declare interface Item<TParent extends Actor | null = Actor | null> extends ClientBaseItem<TParent> {
+    readonly _source: ItemSource;
+
+    get uuid(): ItemUUID;
+    get sheet(): ItemSheet<this, DocumentSheetV1Options>;
+}
+
+declare namespace Item {
+    const implementation: typeof Item;
+}
+
+export default Item;
+
+export {};

package/src/client/documents/journal-entry-category.d.mts

@@ -0,0 +1,15 @@
+import { BaseJournalEntryCategory } from "./_module.mjs";
+import { ClientDocument } from "./abstract/_module.mjs";
+import JournalEntry from "./journal-entry.mjs";
+
+declare const ClientBaseJournalEntryCategory: new <TParent extends JournalEntry | null>(
+    ...args: any
+) => BaseJournalEntryCategory<TParent> & ClientDocument<TParent>;
+
+interface ClientBaseJournalEntryCategory<TParent extends JournalEntry | null> extends InstanceType<typeof ClientBaseJournalEntryCategory<TParent>> {}
+
+export default class JournalEntryCategory<TParent extends JournalEntry | null = JournalEntry | null> extends ClientBaseJournalEntryCategory<TParent> {}
+
+export default interface JournalEntryCategory<TParent extends JournalEntry | null = JournalEntry | null> extends ClientBaseJournalEntryCategory<TParent> {
+    get documentName(): "JournalEntryCategory";
+}

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

@@ -0,0 +1,77 @@
+import { JournalEntryPageHeading } from "#client/_types.mjs";
+import { JournalPageSheet } from "../appv1/sheets/journal-page-sheet.mjs";
+import { DatabaseUpdateCallbackOptions } from "./../../common/abstract/_types.mjs";
+import { DocumentOwnershipLevel } from "./../../common/constants.mjs";
+import Note from "./../canvas/placeables/note.mjs";
+import { BaseJournalEntryPage } from "./_module.mjs";
+import { ClientDocument } from "./abstract/client-document.mjs";
+import JournalEntry from "./journal-entry.mjs";
+
+declare const ClientBaseJournalEntryPage: new <TParent extends JournalEntry | null>(...args: any) => BaseJournalEntryPage<TParent> & ClientDocument<TParent>;
+
+interface ClientBaseJournalEntryPage<TParent extends JournalEntry | null> extends InstanceType<typeof ClientBaseJournalEntryPage<TParent>> {}
+
+/**
+ * The client-side JournalEntryPage document which extends the common BaseJournalEntryPage document model.
+ *
+ * @see {@link JournalEntry}  The JournalEntry document type which contains JournalEntryPage embedded documents.
+ */
+export default class JournalEntryPage<TParent extends JournalEntry | null = JournalEntry | null> extends ClientBaseJournalEntryPage<TParent> {
+    /** The table of contents for this JournalEntryPage. */
+    get toc(): JournalEntryPageHeading;
+
+    override get permission(): DocumentOwnershipLevel;
+
+    /**
+     * 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;
+
+    /* -------------------------------------------- */
+    /*  Table of Contents                           */
+    /* -------------------------------------------- */
+
+    /**
+     * 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.
+     * @param [options.includeElement=true] Include references to the heading DOM elements in the returned ToC.
+     */
+    static buildTOC(html: HTMLElement, options?: { includeElement?: boolean }): 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: JournalEntryPageHeading[]): 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.
+     * @param [options.includeElement=true] Whether to include the DOM element in the returned ToC node.
+     */
+    protected static _makeHeadingNode(heading: HTMLHeadElement, options?: { includeElement?: boolean }): JournalEntryPageHeading;
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    protected override _onClickDocumentLink(event: PointerEvent): this["sheet"] | Promise<this["sheet"]>;
+
+    protected override _onUpdate(data: DeepPartial<this["_source"]>, options: DatabaseUpdateCallbackOptions, userId: string): void;
+}
+
+export default interface JournalEntryPage<TParent extends JournalEntry | null = JournalEntry | null> extends ClientBaseJournalEntryPage<TParent> {
+    get documentName(): "JournalEntryPage";
+    get sheet(): JournalPageSheet<this>;
+}
+
+export {};

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

@@ -0,0 +1,78 @@
+import JournalSheet from "../appv1/sheets/journal-sheet.mjs";
+import { DatabaseDeleteCallbackOptions, DatabaseUpdateCallbackOptions } from "./../../common/abstract/_types.mjs";
+import EmbeddedCollection from "./../../common/abstract/embedded-collection.mjs";
+import Note from "./../canvas/placeables/note.mjs";
+import { BaseJournalEntry, JournalEntryPage, JournalEntrySource } from "./_module.mjs";
+import { ClientDocument, ClientDocumentStatic } from "./abstract/client-document.mjs";
+
+type BaseJournalEntryStatic = typeof BaseJournalEntry;
+interface ClientBaseJournalEntryStatic extends BaseJournalEntryStatic, ClientDocumentStatic {}
+
+declare const ClientBaseJournalEntry: {
+    new (...args: any): BaseJournalEntry & ClientDocument<null>;
+} & ClientBaseJournalEntryStatic;
+
+interface ClientBaseJournalEntry extends InstanceType<typeof ClientBaseJournalEntry> {}
+
+/**
+ * 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
+ */
+export default class JournalEntry extends ClientBaseJournalEntry {
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /** A boolean indicator for whether or not the JournalEntry is visible to the current user in the directory sidebar */
+    override get visible(): boolean;
+
+    /**
+     * 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;
+
+    /* -------------------------------------------- */
+    /*  Methods                                     */
+    /* -------------------------------------------- */
+
+    /**
+     * 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 mode  Which JournalEntry mode to display? Default is text.
+     * @param force Display the entry to all players regardless of normal permissions
+     * @return A Promise that resolves back to the shown entry once the request is processed
+     */
+    show(mode?: string, force?: boolean): Promise<JournalEntry>;
+
+    /**
+     * 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
+     * @param [scale=1.5] The resulting zoom level
+     * @param [duration=250] The speed of the pan animation in milliseconds
+     * @return A Promise which resolves once the pan animation has concluded
+     */
+    panToNote({ scale, duration }?: { scale?: number; duration?: number }): Promise<void>;
+
+    /* -------------------------------------------- */
+    /*  Event Handlers                              */
+    /* -------------------------------------------- */
+
+    protected override _onUpdate(changed: DeepPartial<this["_source"]>, options: DatabaseUpdateCallbackOptions, userId: string): void;
+
+    protected override _onDelete(options: DatabaseDeleteCallbackOptions, userId: string): void;
+}
+
+export default interface JournalEntry extends ClientBaseJournalEntry {
+    readonly _source: JournalEntrySource;
+    readonly pages: EmbeddedCollection<JournalEntryPage<this>>;
+
+    get sheet(): JournalSheet<this>;
+}
+
+export {};

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

@@ -0,0 +1,56 @@
+import Token from "../canvas/placeables/token.mjs";
+import { ImageFilePath } from "./../../common/constants.mjs";
+import DocumentSheetV2 from "./../applications/api/document-sheet.mjs";
+import { BaseMacro, MacroSource } from "./_module.mjs";
+import { ClientDocument, ClientDocumentStatic } from "./abstract/client-document.mjs";
+import Actor from "./actor.mjs";
+
+type BaseMacroStatic = typeof BaseMacro;
+interface ClientBaseMacroStatic extends BaseMacroStatic, ClientDocumentStatic {}
+
+declare const ClientBaseMacro: {
+    new (...args: any): BaseMacro & ClientDocument<null>;
+} & ClientBaseMacroStatic;
+
+interface ClientBaseMacro extends InstanceType<typeof ClientBaseMacro> {}
+
+/**
+ * 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
+ */
+export default class Macro extends ClientBaseMacro {
+    /* -------------------------------------------- */
+    /*  Model Properties                            */
+    /* -------------------------------------------- */
+
+    /** 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(): ImageFilePath;
+
+    /* -------------------------------------------- */
+    /*  Model Methods                               */
+    /* -------------------------------------------- */
+
+    /**
+     * Execute the Macro command.
+     * @param [scope={}]    Macro execution scope which is passed to script macros
+     * @param [scope.actor] An Actor who is the protagonist of the executed action
+     * @param [scope.token] A Token which is the protagonist of the executed action
+     * @returns A created ChatMessage from chat macros or returned value from script macros
+     */
+    execute(scope?: { actor?: Actor; token?: Token; [k: string]: unknown }): unknown;
+}
+
+export default interface Macro extends ClientBaseMacro {
+    readonly _source: MacroSource;
+    get sheet(): DocumentSheetV2;
+}
+
+export {};

package/src/client/documents/measured-template.d.mts

@@ -0,0 +1,41 @@
+import MeasuredTemplate from "../canvas/placeables/template.mjs";
+import MeasuredTemplateConfig from "./../applications/sheets/template-config.mjs";
+import { BaseMeasuredTemplate, Scene } from "./_module.mjs";
+import { CanvasDocument, CanvasDocumentStatic } from "./abstract/canvas-document.mjs";
+
+interface CanvasBaseMeasuredTemplateStatic extends Omit<typeof BaseMeasuredTemplate, "new">, CanvasDocumentStatic {}
+
+declare const CanvasBaseMeasuredTemplate: {
+    new <TParent extends Scene | null>(...args: any): BaseMeasuredTemplate<TParent> & CanvasDocument<TParent>;
+} & CanvasBaseMeasuredTemplateStatic;
+
+interface CanvasBaseMeasuredTemplate<TParent extends Scene | null> extends InstanceType<typeof CanvasBaseMeasuredTemplate<TParent>> {}
+
+/**
+ * The client-side MeasuredTemplate document which extends the common BaseMeasuredTemplate document model.
+ *
+ * @see {@link Scene}                     The Scene document type which contains MeasuredTemplate documents
+ * @see {@link MeasuredTemplateConfig}    The MeasuredTemplate configuration application
+ */
+export default class MeasuredTemplateDocument<TParent extends Scene | null = Scene | null> extends CanvasBaseMeasuredTemplate<TParent> {
+    /* -------------------------------------------- */
+    /*  Model Properties                            */
+    /* -------------------------------------------- */
+
+    /**
+     * Rotation is an alias for direction
+     */
+    get rotation(): number;
+
+    /**
+     * Is the current User the author of this template?
+     */
+    get isAuthor(): boolean;
+}
+
+export default interface MeasuredTemplateDocument<TParent extends Scene | null = Scene | null> extends CanvasBaseMeasuredTemplate<TParent> {
+    get sheet(): MeasuredTemplateConfig | null;
+    get object(): MeasuredTemplate<this> | null;
+}
+
+export {};