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

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

@@ -1,33 +0,0 @@
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseTile from "../../../common/documents/tile.d.mts";
-
-declare global {
-  namespace TileDocument {
-    type Metadata = Document.MetadataFor<TileDocument>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Tile">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Tile">;
-
-    interface DatabaseOperations extends Document.Database.Operations<TileDocument> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseTile.ConstructorData;
-    type UpdateData = BaseTile.UpdateData;
-    type Schema = BaseTile.Schema;
-    type Source = BaseTile.Source;
-  }
-
-  /**
-   * The client-side Tile document which extends the common BaseTile model.
-   *
-   * @see {@link Scene}            The Scene document type which contains Tile embedded documents
-   * @see {@link TileConfig}       The Tile configuration application
-   */
-  class TileDocument extends CanvasDocumentMixin(foundry.documents.BaseTile) {
-    static override metadata: TileDocument.Metadata;
-
-    static get implementation(): TileDocument.ConfiguredClass;
-
-    override prepareDerivedData(): void;
-  }
-}

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

@@ -1,347 +0,0 @@
-import type { DeepPartial, InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type { SchemaField } from "../../../common/data/fields.d.mts";
-import type BaseToken from "../../../common/documents/token.d.mts";
-
-declare global {
-  namespace TokenDocument {
-    type Metadata = Document.MetadataFor<TokenDocument>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Token">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Token">;
-
-    type ObjectClass = Document.ConfiguredObjectClassForName<"Token">;
-    type ObjectInstance = Document.ConfiguredObjectInstanceForName<"Token">;
-
-    /* eslint-disable @typescript-eslint/no-empty-object-type */
-    interface DatabaseOperations
-      extends Document.Database.Operations<
-        TokenDocument,
-        {},
-        {
-          previousActorId: string | null;
-          animate: boolean;
-          _priorRegions: Record<string, string[]>;
-          _priorPosition: Record<string, { x: number; y: number; elevation: number }>;
-          teleport: boolean;
-          forced: boolean;
-        },
-        {}
-      > {}
-    /* eslint-enable @typescript-eslint/no-empty-object-type */
-
-    // Helpful aliases
-    type ConstructorData = BaseToken.ConstructorData;
-    type UpdateData = BaseToken.UpdateData;
-    type Schema = BaseToken.Schema;
-    type Source = BaseToken.Source;
-  }
-
-  /**
-   * The client-side Token document which extends the common BaseToken model.
-   *
-   * @see {@link Scene}               The Scene document type which contains Token embedded documents
-   * @see {@link TokenConfig}      The Token configuration application
-   */
-  class TokenDocument extends CanvasDocumentMixin(foundry.documents.BaseToken) {
-    static override metadata: TokenDocument.Metadata;
-
-    static get implementation(): TokenDocument.ConfiguredClass;
-
-    /**
-     * A singleton collection which holds a reference to the synthetic token actor by its base actor's ID.
-     */
-    actors(): Collection<Actor.ConfiguredInstance>;
-
-    /**
-     * A lazily evaluated reference to the Actor this Token modifies.
-     * 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 ActorDelta.
-     */
-    get actor(): Actor.ConfiguredInstance | null;
-
-    /**
-     * A reference to the base, World-level Actor this token represents.
-     */
-    get baseActor(): Actor | undefined;
-
-    /**
-     * An indicator for whether or not the current User has full control over this Token document.
-     */
-    get isOwner(): boolean;
-
-    /**
-     * A convenient reference for whether this TokenDocument is linked to the Actor it represents, or is a synthetic copy
-     */
-    get isLinked(): boolean;
-
-    /**
-     * Does this TokenDocument have the SECRET disposition and is the current user lacking the necessary permissions
-     * that would reveal this secret?
-     */
-    get isSecret(): boolean;
-
-    /**
-     * Return a reference to a Combatant that represents this Token, if one is present in the current encounter.
-     */
-    get combatant(): Combatant.ConfiguredInstance | null;
-
-    /**
-     * An indicator for whether or not this Token is currently involved in the active combat encounter.
-     */
-    get inCombat(): boolean;
-
-    /**
-     * The Regions this Token is currently in.
-     */
-    regions: Set<RegionDocument.ConfiguredInstance> | null;
-
-    // TODO: Same as `DataModel._initialize`
-    protected override _initialize(options?: any): void;
-
-    override prepareBaseData(): void;
-
-    override prepareEmbeddedDocuments(): void;
-
-    override prepareDerivedData(): void;
-
-    /**
-     * Infer the subject texture path to use for a token ring.
-     */
-    protected _inferRingSubjectTexture(): string;
-
-    /**
-     * Prepare detection modes which are available to the Token.
-     * Ensure that every Token has the basic sight detection mode configured.
-     */
-    protected _prepareDetectionModes(): void;
-
-    /**
-     * A helper method to retrieve the underlying data behind one of the Token's attribute bars
-     * @param barName     - The named bar to retrieve the attribute for
-     * @returns The attribute displayed on the Token bar, if any
-     */
-    getBarAttribute(
-      barName: string,
-      options?: InexactPartial<{
-        /**
-         * An alternative attribute path to get instead of the default one
-         */
-        alternative: string;
-      }>,
-    ): SingleAttributeBar | ObjectAttributeBar | null;
-
-    /**
-     * Test whether a Token has a specific status effect.
-     * @param statusId - The status effect ID as defined in CONFIG.statusEffects
-     * @returns Does the Actor of the Token have this status effect?
-     */
-    hasStatusEffect(statusId: string): boolean;
-
-    /**
-     * Add or remove this Token from a Combat encounter.
-     * @param options - Additional options passed to TokenDocument.createCombatants or
-     *                  TokenDocument.deleteCombatants
-     *                  Default: `{}`
-     *  @returns Is this Token now an active Combatant?
-     */
-    toggleCombatant({
-      active,
-      ...options
-    }?: InexactPartial<
-      CreateCombatantOptions & {
-        /**
-         * Require this token to be an active Combatant or to be removed.
-         * Otherwise, the current combat state of the Token is toggled.
-         */
-        active: boolean;
-      }
-    >): Promise<boolean>;
-
-    /**
-     * Create or remove Combatants for an array of provided Token objects.
-     * @param tokens  - The tokens which should be added to the Combat
-     * @param options - Options which modify the toggle operation
-     *                  Default: `{}`
-     * @returns An array of created Combatant documents
-     */
-    static createCombatants(tokens: TokenDocument[], options?: CreateCombatantOptions): Promise<Combatant[]>;
-
-    /**
-     * Remove Combatants for the array of provided Tokens.
-     * @param tokens  - The tokens which should removed from the Combat
-     * @param options - Options which modify the operation
-     *                  Default: `{}`
-     * @returns An array of deleted Combatant documents
-     */
-    static deleteCombatants(tokens: TokenDocument[], options?: CreateCombatantOptions): Promise<Combatant[]>;
-
-    /**
-     * Convenience method to change a token vision mode.
-     * @param visionMode - The vision mode to apply to this token.
-     * @param defaults   - If the vision mode should be updated with its defaults.
-     *                     Default = `true`
-     */
-    updateVisionMode(
-      visionMode: typeof CONFIG.Canvas.visionModes,
-      defaults?: boolean,
-    ): Promise<ReturnType<this["update"]>>;
-
-    override getEmbeddedCollection<DocType extends Document.Type>(
-      embeddedName: DocType,
-    ): Collection<Document.ConfiguredInstanceForName<DocType>>;
-
-    /**
-     * @privateRemarks _onCreate, _preUpdate, _onUpdate, _onDelete, preCreateOperation, _preUpdateOperation, _onCreateOperation,
-     * _onUpdateOperation, _onDeleteOperation, _preCreateDescendantDocuments, _preUpdateDescendantDocuments, _preDeleteDescendantDocuments,
-     * _onUpdateDescendantDocuments, and _onDeleteDescendantDocuments 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.
-     */
-
-    /**
-     * Is to Token document updated such that the Regions the Token is contained in may change?
-     * Called as part of the preUpdate workflow.
-     * @param changes - The changes.
-     * @returns Could this Token update change Region containment?
-     */
-
-    protected _couldRegionsChange(
-      changes: SchemaField.InnerAssignmentType<foundry.documents.BaseToken.Schema>,
-    ): boolean;
-
-    /**
-     * When the base Actor for a TokenDocument changes, we may need to update its Actor instance
-     */
-    protected _onUpdateBaseActor(
-      update?: DeepPartial<Actor.ConfiguredInstance["_source"]>,
-      options?: Document.OnUpdateOptions<"Actor">,
-    ): void;
-
-    /**
-     * Whenever the token's actor delta changes, or the base actor changes, perform associated refreshes.
-     * @param update  - The update delta.
-     * @param options - The options provided to the update.
-     */
-    protected _onRelatedUpdate(
-      update?: DeepPartial<Actor.ConfiguredInstance["_source"]>,
-      /** @privateRemarks foundry calls this field operation
-       * but it's being passed options (and then ignores them)
-       */
-      operation?: Document.OnUpdateOptions<"Actor">,
-    ): void;
-
-    /**
-     * Get an Array of attribute choices which could be tracked for Actors in the Combat Tracker
-     * @param _path - (default: `[]`)
-     */
-    // TODO: There's some very complex handling for non-datamodel Actor system implementations if we want
-    static getTrackedAttributes(
-      data?: Actor.ConfiguredInstance["system"],
-      _path?: string[],
-    ): TrackedAttributesDescription;
-
-    /**
-     * Retrieve an Array of attribute choices from a plain object.
-     * @param schema - The schema to explore for attributes.
-     */
-    protected static _getTrackedAttributesFromObject(data: object, _path?: string[]): TrackedAttributesDescription;
-
-    /**
-     * Retrieve an Array of attribute choices from a SchemaField.
-     * @param schema - The schema to explore for attributes.
-     */
-    protected static _getTrackedAttributesFromSchema(
-      schema: foundry.data.fields.SchemaField.Any,
-      _path?: string[],
-    ): TrackedAttributesDescription;
-
-    /**
-     * Retrieve any configured attributes for a given Actor type.
-     * @param type - The Actor type.
-     */
-    static _getConfiguredTrackedAttributes(type: string): TrackedAttributesDescription | void;
-
-    /**
-     * Inspect the Actor data model and identify the set of attributes which could be used for a Token Bar
-     * @param attributes - The tracked attributes which can be chosen from
-     * @returns A nested object of attribute choices to display
-     */
-    static getTrackedAttributeChoices(attributes?: TrackedAttributesDescription): Record<string, string[]>;
-
-    /**
-     * @deprecated since v11
-     * @remarks `"TokenDocument#getActor has been deprecated. Please use the`
-     * `TokenDocument#actor getter to retrieve the Actor instance that the TokenDocument represents, or use`
-     * `TokenDocument#delta#apply to generate a new synthetic Actor instance."`
-     */
-    getActor(): Actor.ConfiguredInstance;
-
-    /**
-     * @deprecated since v11
-     */
-    get actorData(): this["delta"]["_source"];
-
-    /**
-     * @deprecated since v11
-     */
-    set actorData(actorData: this["delta"]["_source"]);
-
-    /**
-     * 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
-     * @deprecated since v12
-     * @remarks `TokenDocument#toggleActiveEffect is deprecated in favor of Actor#toggleStatusEffect"`
-     */
-    toggleActiveEffect(
-      effectData: CONFIG.StatusEffect,
-      options?: InexactPartial<ToggleActiveEffectOptions>,
-    ): Promise<boolean>;
-  }
-
-  // The getBarAttribute monkeypatch is simply inside the data model definition at `src\foundry\common\data\data.d.mts`
-
-  interface TrackedAttributesDescription {
-    /** A list of property path arrays to attributes with both a value and a max property. */
-    bar: string[][];
-    /** A list of property path arrays to attributes that have only a value property. */
-    value: string[][];
-  }
-
-  interface CreateCombatantOptions {
-    /**
-     * A specific Combat instance which should be modified. If undefined,
-     * the current active combat will be modified if one exists. Otherwise, a new
-     * Combat encounter will be created if the requesting user is a Gamemaster.
-     */
-    combat?: Combat | undefined;
-  }
-}
-
-interface SingleAttributeBar {
-  type: "value";
-  attribute: string;
-  value: number;
-  editable: boolean;
-}
-
-interface ObjectAttributeBar {
-  type: "bar";
-  attribute: string;
-  value: number;
-  max: number;
-  editable: boolean;
-}
-
-interface ToggleActiveEffectOptions {
-  /**
-   * Should the Active Effect icon be displayed as an overlay on the token?
-   * @defaultValue `false`
-   */
-  overlay: boolean;
-
-  /** Force a certain active state for the effect. */
-  active: boolean;
-}

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

@@ -1,165 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseUser from "../../../common/documents/user.d.mts";
-
-declare global {
-  namespace User {
-    type Metadata = Document.MetadataFor<User>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"User">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"User">;
-
-    interface DatabaseOperations extends Document.Database.Operations<User> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseUser.ConstructorData;
-    type UpdateData = BaseUser.UpdateData;
-    type Schema = BaseUser.Schema;
-    type Source = BaseUser.Source;
-
-    interface PingData {
-      /**
-       * Pulls all connected clients' views to the pinged co-ordinates.
-       */
-      pull?: false | undefined;
-
-      /**
-       * The ping style, see CONFIG.Canvas.pings.
-       */
-      style: string;
-
-      /**
-       * The ID of the scene that was pinged.
-       */
-      scene: string;
-
-      /**
-       * The zoom level at which the ping was made.
-       */
-      zoom: number;
-    }
-
-    interface ActivityData {
-      /** The ID of the scene that the user is viewing. */
-      sceneId: string | null;
-
-      /** The position of the user's cursor. */
-      cursor: { x: number; y: number } | null;
-
-      /** The state of the user's ruler, if they are currently using one. */
-      ruler: Ruler.MeasurementData | null;
-
-      /** The IDs of the tokens the user has targeted in the currently viewed */
-      targets: string[];
-
-      /** Whether the user has an open WS connection to the server or not. */
-      active: boolean;
-
-      /** Is the user emitting a ping at the cursor coordinates? */
-      ping: PingData;
-
-      /** The state of the user's AV settings. */
-      av: AVSettingsData;
-    }
-  }
-
-  /**
-   * The client-side User document which extends the common BaseUser model.
-   * Each User document contains UserData which defines its data schema.
-   *
-   * @see {@link Users}             The world-level collection of User documents
-   * @see {@link UserConfig}     The User configuration application
-   */
-  class User extends ClientDocumentMixin(foundry.documents.BaseUser) {
-    static override metadata: User.Metadata;
-
-    static get implementation(): User.ConfiguredClass;
-
-    /**
-     * Track whether the user is currently active in the game
-     * @defaultValue `false`
-     */
-    active: boolean;
-
-    /**
-     * Track references to the current set of Tokens which are targeted by the User
-     */
-    targets: UserTargets;
-
-    /**
-     * Track the ID of the Scene that is currently being viewed by the User
-     * @defaultValue `null`
-     */
-    viewedScene: string | null;
-
-    /**
-     * A flag for whether the current User is a Trusted Player
-     */
-    get isTrusted(): boolean;
-
-    /**
-     * A flag for whether this User is the connected client
-     */
-    get isSelf(): boolean;
-
-    override prepareDerivedData(): void;
-
-    /**
-     * Assign a Macro to a numbered hotbar slot between 1 and 50
-     * @param macro    - The Macro document to assign
-     * @param slot     - A specific numbered hotbar slot to fill
-     * @param fromSlot - An optional origin slot from which the Macro is being shifted
-     * @returns A Promise which resolves once the User update is complete
-     */
-    assignHotbarMacro(
-      macro: Macro.ConfiguredInstance | null,
-      slot: string | number,
-      { fromSlot }?: InexactPartial<{ fromSlot: number }>,
-    ): Promise<this>;
-
-    /**
-     * Assign a specific boolean permission to this user.
-     * Modifies the user permissions to grant or restrict access to a feature.
-     *
-     * @param permission - The permission name from USER_PERMISSIONS
-     * @param allowed    - Whether to allow or restrict the permission
-     */
-    assignPermission(permission: keyof typeof CONST.USER_PERMISSIONS, allowed: boolean): Promise<this>;
-
-    /**
-     * Submit User activity data to the server for broadcast to other players.
-     * This type of data is transient, persisting only for the duration of the session and not saved to any database.
-     * Activity data uses a volatile event to prevent unnecessary buffering if the client temporarily loses connection.
-     * @param activityData - An object of User activity data to submit to the server for broadcast.
-     *                       (default: `{}`)
-     */
-    broadcastActivity(
-      activityData?: InexactPartial<User.ActivityData>,
-      options?: InexactPartial<{
-        /**
-         * If undefined, volatile is inferred from the activity data
-         */
-        volatile: boolean;
-      }>,
-    ): void;
-
-    /**
-     * Get an Array of Macro Documents on this User's Hotbar by page
-     * @param page - The hotbar page number
-     *               (default: `1`)
-     */
-    getHotbarMacros(page?: number): Array<{ slot: number; macro: Macro.ConfiguredInstance | null }>;
-
-    /**
-     * Update the set of Token targets for the user given an array of provided Token ids.
-     * @param targetIds - An array of Token ids which represents the new target set
-     *                    (default: `[]`)
-     */
-    updateTokenTargets(targetIds?: string[]): void;
-
-    /**
-     * @privateRemarks _onUpdate and _onDelete are 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/wall.d.mts

@@ -1,31 +0,0 @@
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseWall from "../../../common/documents/wall.d.mts";
-
-declare global {
-  namespace WallDocument {
-    type Metadata = Document.MetadataFor<WallDocument>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Wall">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Wall">;
-
-    interface DatabaseOperations extends Document.Database.Operations<WallDocument> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseWall.ConstructorData;
-    type UpdateData = BaseWall.UpdateData;
-    type Schema = BaseWall.Schema;
-    type Source = BaseWall.Source;
-  }
-
-  /**
-   * The client-side Wall document which extends the common BaseWall model.
-   *
-   * @see {@link Scene}            The Scene document type which contains Wall embedded documents
-   * @see {@link WallConfig}       The Wall configuration application
-   */
-  class WallDocument extends CanvasDocumentMixin(foundry.documents.BaseWall) {
-    static override metadata: WallDocument.Metadata;
-
-    static get implementation(): WallDocument.ConfiguredClass;
-  }
-}

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

@@ -1,3 +0,0 @@
-import "./abstract/index.d.mts";
-import "./collections/index.d.mts";
-import "./documents/index.d.mts";