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

package/src/foundry/common/documents/token.d.mts

@@ -1,4 +1,4 @@
-import type { AnyMutableObject, AnyObject, InexactPartial } from "fvtt-types/utils";
+import type { AnyMutableObject, DeepReadonly, InexactPartial } from "#utils";
 import type { DataModel } from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type * as CONST from "../constants.mts";
@@ -17,14 +17,15 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
    * @param data    - Initial data from which to construct the `BaseToken`
    * @param context - Construction context options
    *
-   * @deprecated Constructing `BaseToken` directly is not advised. The base document classes exist in
+   * @remarks Constructing `BaseToken` directly is not advised. The base document classes exist in
    * order to use documents on both the client (i.e. where all your code runs) and behind the scenes
    * on the server to manage document validation and storage.
    *
    * You should use {@link TokenDocument.implementation | `new TokenDocument.implementation(...)`} instead which will give you
    * a system specific implementation of `TokenDocument`.
    */
-  constructor(...args: TokenDocument.ConstructorArgs);
+  // Note(LukeAbby): Optional as there are currently no required properties on `CreateData`.
+  constructor(data?: TokenDocument.CreateData, context?: TokenDocument.ConstructionContext);
 
   /**
    * @defaultValue
@@ -43,7 +44,7 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
    *     update: this.#canUpdate,
    *     delete: "TOKEN_DELETE"
    *   },
-   *   schemaVersion: "12.324"
+   *   schemaVersion: "13.341"
    * })
    * ```
    */
@@ -51,51 +52,155 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
 
   static override defineSchema(): BaseToken.Schema;
 
+  /** @defaultValue `["DOCUMENT", "TOKEN"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  /** @defaultValue `["x", "y", "elevation", "width", "height", "shape"]` */
+  static MOVEMENT_FIELDS: Readonly<string[]>;
+
+  /**
+   * Are the given positions equal?
+   */
+  static arePositionsEqual(position1: TokenDocument.Position, position2: TokenDocument.Position): boolean;
+
   /**
    * The default icon used for newly created Token documents
-   * @defaultValue `CONST.DEFAULT_TOKEN` (`"icons/svg/mystery-man.svg"`)
+   * @defaultValue `CONST.DEFAULT_TOKEN`
    */
   static DEFAULT_ICON: string;
 
-  // options: not null (destructured)
-  override testUserPermission(
-    user: User.Implementation,
-    permission: Document.TestableOwnershipLevel,
-    options?: Document.TestUserPermissionOptions,
-  ): boolean;
+  /**
+   * Prepare changes to a descendent delta collection.
+   * @param changes - Candidate source changes.
+   * @param options - Options which determine how the new data is merged.
+   */
+  protected _prepareDeltaUpdate(changes?: TokenDocument.UpdateData, options?: DataModel.UpdateOptions): void;
+
+  // changes, options: not null (parameter default only)
+  override updateSource(
+    changes?: TokenDocument.UpdateData,
+    options?: DataModel.UpdateOptions,
+  ): TokenDocument.UpdateData;
+
+  override clone<Save extends boolean | null | undefined = false>(
+    data?: BaseToken.CreateData,
+    context?: Document.CloneContext<Save>,
+  ): Document.Clone<this, Save>;
+
+  /**
+   * Get the snapped position of the Token.
+   * @param data - The position and dimensions
+   * @returns The snapped position
+   */
+  getSnappedPosition(data?: TokenDocument.Dimensions3D): foundry.canvas.Canvas.ElevatedPoint;
+
+  /**
+   * Get the top-left offset of the Token
+   * @param data - The position and dimensions
+   * @returns The top-left grid offset
+   */
+  protected _positionToGridOffset(data?: TokenDocument.Dimensions3D): foundry.grid.BaseGrid.Offset3D;
+
+  /**
+   * Get the position of the Token from the top-left grid offset.
+   * @param offset - The top-left grid offset
+   * @param data   - The dimensions that override the current dimensions
+   * @returns The snapped position
+   */
+  protected _gridOffsetToPosition(
+    offset: foundry.grid.BaseGrid.Offset3D,
+    data?: TokenDocument.PartialDimensions,
+  ): foundry.canvas.Canvas.ElevatedPoint;
+
+  /**
+   * Get the width and height of the Token in pixels.
+   * @param data - The width and/or height in grid units (must be positive)
+   * @returns The width and height in pixels
+   */
+  getSize(data?: InexactPartial<TokenDocument.ShapelessDimensions>): TokenDocument.ShapelessDimensions;
+
+  /**
+   * Get the center point of the Token.
+   * @param data - The position and dimensions
+   * @returns The center point
+   */
+  getCenterPoint(data?: TokenDocument.Dimensions3D): foundry.canvas.Canvas.ElevatedPoint;
+
+  /**
+   * Get the grid space polygon of the Token.
+   * Returns undefined in gridless grids because there are no grid spaces.
+   * @param data - The dimensions
+   * @returns The grid space polygon or undefined if gridless
+   */
+  getGridSpacePolygon(data?: TokenDocument.PartialDimensions): foundry.canvas.Canvas.Point[] | void;
+
+  /**
+   * Get the offsets of grid spaces that are occupied by this Token at the current or given position.
+   * The grid spaces the Token occupies are those that are covered by the Token's shape in the snapped position.
+   * Returns an empty array in gridless grids.
+   * @param data - The position and dimensions
+   * @returns The offsets of occupied grid spaces
+   */
+  getOccupiedGridSpaceOffsets(data?: TokenDocument.Dimensions2D): foundry.grid.BaseGrid.Offset2D[];
+
+  /**
+   * Get the hexagonal offsets given the type, width, and height.
+   * @param width   - The width of the Token (positive)
+   * @param height  - The height of the Token (positive)
+   * @param shape   - The shape (one of {@link CONST.TOKEN_SHAPES})
+   * @param columns - Column-based instead of row-based hexagonal grid?
+   * @returns The hexagonal offsets
+   */
+  protected static _getHexagonalOffsets(
+    width: number,
+    height: number,
+    shape: CONST.TOKEN_SHAPES,
+    columns: boolean,
+  ): DeepReadonly<TokenDocument.HexagonalOffsetsData>;
 
-  updateSource(changes?: TokenDocument.UpdateData, options?: DataModel.UpdateSourceOptions): TokenDocument.UpdateData;
+  override getUserLevel(user?: User.Internal.Implementation): CONST.DOCUMENT_OWNERSHIP_LEVELS;
 
   // TODO: Update with the Delta conditionality
-  toObject(source: true): this["_source"];
-  toObject(source?: boolean): ReturnType<this["schema"]["toObject"]>;
+  override toObject(source?: boolean): TokenDocument.Source;
 
   /**
-   * @remarks Migrates:
-   * - `actorData` to `delta`
+   * @remarks
+   * Migrations:
+   * - `hexagonalShape` to `shape` (since v13, no specified end)
    */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
-   * @remarks Shims:
-   * - `actorData` to `delta` since v11, until v13
-   * - `effects` to nothing since v12, until v14 ("TokenDocument#effects is deprecated in favor of using ActiveEffect documents on the associated Actor")
-   * - `overlayEffect` to nothing since v12, until v14 ("TokenDocument#overlayEffect is deprecated in favor of using ActiveEffect documents on the associated Actor")
+   * @remarks
+   * Shims:
+   * - `effects` to nothing (since v12, until v14)
+   *   - "`TokenDocument#effects` is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated `Actor`")
+   * - `overlayEffect` to nothing (since v12, until v14)
+   *   - "`TokenDocument#overlayEffect` is deprecated in favor of using `ActiveEffect` documents on the associated `Actor`")
+   * - `hexagonalShape` to `shape` (since v13, until v15)
+   *   - "`TokenDocument#hexagonalShape` is deprecated in favor of `TokenDocument#shape`."
    */
+  // options: not null (destructured)
   static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
   /**
    * @deprecated since v12, until v14
-   * @remarks "TokenDocument#overlayEffect is deprecated in favor of using ActiveEffect documents on the associated Actor"
+   * @remarks "TokenDocument#overlayEffect is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated Actor"
    */
   get effects(): [];
 
   /**
    * @deprecated since v12, until v14
-   * @remarks "TokenDocument# is deprecated in favor of using ActiveEffect documents on the associated Actor"
+   * @remarks "TokenDocument# is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated Actor"
    */
   get overlayEffect(): "";
 
+  /**
+   * @deprecated since v13, until v15
+   * @remarks "TokenDocument#hexagonalShape is deprecated in favor of {@linkcode TokenDocument#shape}"
+   */
+  get hexagonalShape(): CONST.TOKEN_SHAPES;
+
   /*
    * After this point these are not really overridden methods.
    * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -108,47 +213,45 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
 
   /* Document overrides */
 
-  static " fvtt_types_internal_document_name_static": "Token";
-
   // Same as Document for now
-  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+  protected static override _initializationOrder(): Generator<[string, DataField.Any], void, undefined>;
 
-  readonly parentCollection: TokenDocument.ParentCollectionName | null;
+  override readonly parentCollection: TokenDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): TokenDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseToken;
+  static override get baseDocument(): typeof BaseToken;
 
-  static get collectionName(): TokenDocument.ParentCollectionName;
+  static override get collectionName(): TokenDocument.ParentCollectionName;
 
-  static get documentName(): TokenDocument.Name;
+  static override get documentName(): TokenDocument.Name;
 
-  static get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
 
-  static get hasTypeData(): undefined;
+  static override get hasTypeData(): undefined;
 
-  static get hierarchy(): TokenDocument.Hierarchy;
+  static override get hierarchy(): TokenDocument.Hierarchy;
 
   override parent: TokenDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = undefined>(
     data: Array<TokenDocument.Implementation | TokenDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<TokenDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<TokenDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: TokenDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<TokenDocument.Database.Update>,
   ): Promise<TokenDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<TokenDocument.Database.Delete>,
   ): Promise<TokenDocument.Implementation[]>;
 
-  static override create<Temporary extends boolean | undefined = false>(
+  static override create<Temporary extends boolean | undefined = undefined>(
     data: TokenDocument.CreateData | TokenDocument.CreateData[],
     operation?: TokenDocument.Database.CreateOperation<Temporary>,
   ): Promise<Document.TemporaryIf<TokenDocument.Implementation, Temporary> | undefined>;
@@ -174,7 +277,7 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
    * runtime, namely returning a `EmbeddedCollection` corresponding to a field in `BaseToken`'s
    * schema. However {@link TokenDocument.getEmbeddedCollection | `TokenDocument#getEmbeddedCollection`}
    * is overridden to add new cases and since `BaseToken` is a superclass it had to be widened to
-   * accomodate that.
+   * accommodate that.
    */
   override getEmbeddedCollection(embeddedName: TokenDocument.Embedded.CollectionName): Collection.Any;
 
@@ -191,22 +294,24 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
     // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
     // However this causes a number of errors.
     operation?: object,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
 
   override updateEmbeddedDocuments<EmbeddedName extends TokenDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends TokenDocument.Embedded.Name>(
     embeddedName: EmbeddedName,
     ids: Array<string>,
     operation?: Document.Database.DeleteOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>>>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   // Same as Document for now
-  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+  override traverseEmbeddedDocuments(
+    _parentPath?: string,
+  ): Generator<[string, Document.AnyChild<this>], void, undefined>;
 
   override getFlag<Scope extends TokenDocument.Flags.Scope, Key extends TokenDocument.Flags.Key<Scope>>(
     scope: Scope,
@@ -224,68 +329,68 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: TokenDocument.CreateData,
     options: TokenDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: TokenDocument.CreateData,
     options: TokenDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: TokenDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<TokenDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: TokenDocument.UpdateData,
     options: TokenDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: TokenDocument.UpdateData,
     options: TokenDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: TokenDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: TokenDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: TokenDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Delete,
     user: User.Implementation,
@@ -293,63 +398,94 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
 
   // These data field things have been ticketed but will probably go into backlog hell for a while.
   // We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
-  protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
 
-  protected static _addDataFieldMigration(
-    data: AnyObject,
+  // options: not null (parameter default only in _addDataFieldShim)
+  protected static override _addDataFieldShims(
+    data: AnyMutableObject,
+    shims: Record<string, string>,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  // options: not null (parameter default only)
+  protected static override _addDataFieldShim(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  protected static override _addDataFieldMigration(
+    data: AnyMutableObject,
     oldKey: string,
     newKey: string,
-    apply?: (data: AnyObject) => unknown,
-  ): unknown;
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
 
-  protected static _logDataFieldMigration(
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
     oldKey: string,
     newKey: string,
     options?: LogCompatibilityWarningOptions,
   ): void;
 
-  protected static _onCreateDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
+   */
+  protected static override _onCreateDocuments(
     documents: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.Parent>,
   ): Promise<void>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
+   */
+  protected static override _onUpdateDocuments(
     documents: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.Parent>,
   ): Promise<void>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
+   */
+  protected static override _onDeleteDocuments(
     documents: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<TokenDocument.Schema>;
+  protected static override _schema: SchemaField<TokenDocument.Schema>;
 
-  static get schema(): SchemaField<TokenDocument.Schema>;
+  static override get schema(): SchemaField<TokenDocument.Schema>;
 
-  static validateJoint(data: TokenDocument.Source): void;
+  static override validateJoint(data: TokenDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: TokenDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): TokenDocument.Implementation;
 
   static override fromJSON(json: string): TokenDocument.Implementation;
+
+  static #BaseToken: true;
 }
 
 /**
  * A special subclass of EmbeddedDocumentField which allows construction of the ActorDelta to be lazily evaluated.
  */
 export class ActorDeltaField<
-  DocumentType extends Document.AnyConstructor,
+  DocumentType extends foundry.documents.BaseActorDelta.AnyConstructor,
   Options extends fields.EmbeddedDocumentField.Options<DocumentType> = fields.EmbeddedDocumentField.DefaultOptions,
 > extends fields.EmbeddedDocumentField<DocumentType, Options> {
+  // options: not null (parameter default only)
   override initialize(
     value: fields.EmbeddedDocumentField.PersistedType<DocumentType, Options>,
     model: DataModel.Any,
-    options?: InexactPartial<DataModel.DataValidationOptions>,
+    options?: DataField.InitializeOptions,
   ):
     | fields.EmbeddedDocumentField.InitializedType<DocumentType, Options>
     | (() => fields.EmbeddedDocumentField.InitializedType<DocumentType, Options> | null);
@@ -359,6 +495,7 @@ export default BaseToken;
 
 declare namespace BaseToken {
   export import Name = TokenDocument.Name;
+  export import ConstructionContext = TokenDocument.ConstructionContext;
   export import ConstructorArgs = TokenDocument.ConstructorArgs;
   export import Hierarchy = TokenDocument.Hierarchy;
   export import Metadata = TokenDocument.Metadata;
@@ -373,7 +510,6 @@ declare namespace BaseToken {
   export import Invalid = TokenDocument.Invalid;
   export import Stored = TokenDocument.Stored;
   export import Source = TokenDocument.Source;
-  export import PersistedData = TokenDocument.PersistedData;
   export import CreateData = TokenDocument.CreateData;
   export import InitializedData = TokenDocument.InitializedData;
   export import UpdateData = TokenDocument.UpdateData;
@@ -382,22 +518,12 @@ declare namespace BaseToken {
   export import Flags = TokenDocument.Flags;
   export import CoreFlags = TokenDocument.CoreFlags;
 
-  /**
-   * @deprecated This type is used by Foundry too vaguely.
-   * In one context the most correct type is after initialization whereas in another one it should be
-   * before but Foundry uses it interchangeably.
-   */
-  type Properties = SchemaField.InitializedData<Schema>;
-
-  /**
-   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BaseToken.Schema>`}
-   */
-  type SchemaField = foundry.data.fields.SchemaField<Schema>;
-
-  /**
-   * @deprecated {@link BaseToken.CreateData | `BaseToken.CreateData`}
-   */
-  type ConstructorData = BaseToken.CreateData;
+  namespace Internal {
+    // Note(LukeAbby): The point of this is to give the base class of `TokenDocument` a name.
+    // The expression `CanvasDocumentMixin(BaseToken)` is more intuitive but it has worse
+    // caching, likely due to the majority of tsc's caching working off of names.
+    // See https://gist.github.com/LukeAbby/18a928fdc35c5d54dc121ed5dbf412fd.
+    interface CanvasDocument extends foundry.documents.abstract.CanvasDocumentMixin.Mix<typeof BaseToken> {}
+    const CanvasDocument: CanvasDocument;
+  }
 }
-
-declare namespace ActorDeltaField {}