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

package/src/foundry/common/grid/_types.d.mts

@@ -1,5 +1,8 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
+import type BaseGrid from "./base.d.mts";
+import type HexagonalGrid from "./hexagonal.d.mts";
+
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?
 //
@@ -10,39 +13,39 @@
 // TODO: Stubs
 export {};
 
-type GridOffset2D = unknown;
+type GridOffset2D = BaseGrid.Offset2D;
 
-type GridOffset3D = unknown;
+type GridOffset3D = BaseGrid.Offset3D;
 
-type HexagonalGridCube2D = unknown;
+type HexagonalGridCube2D = HexagonalGrid.Cube2D;
 
-type HexagonalGridCube3D = unknown;
+type HexagonalGridCube3D = HexagonalGrid.Cube3D;
 
-type GridCoordinates2D = unknown;
+type GridCoordinates2D = BaseGrid.Coordinates2D;
 
-type GridCoordinates3D = unknown;
+type GridCoordinates3D = BaseGrid.Coordinates3D;
 
-type HexagonalGridCoordinates2D = unknown;
+type HexagonalGridCoordinates2D = HexagonalGrid.Coordinates2D;
 
-type HexagonalGridCoordinates3D = unknown;
+type HexagonalGridCoordinates3D = HexagonalGrid.Coordinates3D;
 
-type GridSnappingBehavior = unknown;
+type GridSnappingBehavior = BaseGrid.SnappingBehavior;
 
-type GridMeasurePathWaypointData2D = unknown;
+type GridMeasurePathWaypointData2D = foundry.grid.BaseGrid.MeasurePathWaypoint2D;
 
-type GridMeasurePathWaypointData3D = unknown;
+type GridMeasurePathWaypointData3D = foundry.grid.BaseGrid.MeasurePathWaypoint3D;
 
-type GridMeasurePathResultWaypoint = unknown;
+type GridMeasurePathResultWaypoint = foundry.grid.BaseGrid.MeasurePathResultWaypoint;
 
-type GridMeasurePathResultSegment = unknown;
+type GridMeasurePathResultSegment = foundry.grid.BaseGrid.MeasurePathResultSegment;
 
-type GridMeasurePathResult = unknown;
+type GridMeasurePathResult = foundry.grid.BaseGrid.MeasurePathResult;
 
-type GridMeasurePathCostFunction2D = unknown;
+type GridMeasurePathCostFunction2D = BaseGrid.MeasurePathCostFunction2D;
 
-type GridMeasurePathCostFunction3D = unknown;
+type GridMeasurePathCostFunction3D = BaseGrid.MeasurePathCostFunction3D;
 
-type GridConfiguration = unknown;
+type GridConfiguration = BaseGrid.Configuration;
 
 type SquareGridConfiguration = unknown;
 

package/src/foundry/common/grid/base.d.mts

@@ -1,4 +1,8 @@
-import type { AnyObject, EmptyObject, InexactPartial, Identity } from "fvtt-types/utils";
+import type { AnyObject, EmptyObject, InexactPartial, Identity } from "#utils";
+import type { Canvas } from "#client/canvas/_module.d.mts";
+import type { GridHighlight } from "#client/canvas/containers/_module.mjs";
+import type { Ray } from "#client/canvas/geometry/_module.d.mts";
+import type { Token } from "#client/canvas/placeables/_module.d.mts";
 
 /**
  * The base grid class.
@@ -26,7 +30,7 @@ declare abstract class BaseGrid {
   alpha: number;
 
   /**
-   * The grid type (see {@link CONST.GRID_TYPES | `CONST.GRID_TYPES`}).
+   * The grid type (see {@linkcode CONST.GRID_TYPES}).
    */
   type: CONST.GRID_TYPES;
 
@@ -93,7 +97,7 @@ declare abstract class BaseGrid {
    * In square grids with illegal diagonals the offset of the given coordinates is returned
    * if the direction is diagonal.
    * @param coords    - The coordinates
-   * @param direction - The direction (see {@link CONST.MOVEMENT_DIRECTIONS | `CONST.MOVEMENT_DIRECTIONS`})
+   * @param direction - The direction (see {@linkcode CONST.MOVEMENT_DIRECTIONS})
    * @returns The offset
    */
   abstract getShiftedOffset(coords: BaseGrid.Coordinates, direction: number): BaseGrid.Offset;
@@ -104,7 +108,7 @@ declare abstract class BaseGrid {
    * In square grids with illegal diagonals the point is not shifted if the direction is diagonal.
    * In gridless grids the point coordinates are shifted by the grid size.
    * @param point     - The point that is to be shifted
-   * @param direction - The direction (see {@link CONST.MOVEMENT_DIRECTIONS | `CONST.MOVEMENT_DIRECTIONS`})
+   * @param direction - The direction (see {@linkcode CONST.MOVEMENT_DIRECTIONS})
    * @returns The shifted point
    */
   abstract getShiftedPoint(point: Canvas.Point, direction: number): Canvas.Point;
@@ -167,7 +171,7 @@ declare abstract class BaseGrid {
        * The function that returns the cost for a given move between
        * grid spaces (default is the distance traveled along the direct path)
        */
-      cost: BaseGrid.MeasurePathCostFunction;
+      cost: BaseGrid.MeasurePathCostFunction2D | BaseGrid.MeasurePathCostFunction3D;
     }>,
   ): BaseGrid.MeasurePathResult;
 
@@ -185,7 +189,7 @@ declare abstract class BaseGrid {
        * The function that returns the cost for a given move between
        * grid spaces (default is the distance traveled along the direct path)
        */
-      cost: BaseGrid.MeasurePathCostFunction;
+      cost: BaseGrid.MeasurePathCostFunction2D | BaseGrid.MeasurePathCostFunction3D;
     }>,
     result: BaseGrid.MeasurePathResult,
   ): void;
@@ -369,9 +373,11 @@ declare abstract class BaseGrid {
   measureDistances(
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     segments: BaseGrid.Segment[],
+
     /**
      * @defaultValue `{}`
-     * @remarks Unused */
+     * @remarks Unused
+     */
     options?: EmptyObject,
   ): number[];
 
@@ -396,6 +402,7 @@ declare abstract class BaseGrid {
     x: number,
     y: number,
     interval?: number | null,
+
     /**
      * @defaultValue `{}`
      * @remarks Unused
@@ -536,20 +543,39 @@ declare namespace BaseGrid {
     thickness?: number | undefined;
   }
 
-  interface Offset {
-    /** The row coordinate */
+  type Offset = Offset2D | Offset3D;
+
+  /**
+   * 2D offset coordinates of a grid space.
+   */
+  interface Offset2D {
+    /** The row coordinate (an integer) */
     i: number;
 
-    /** The column coordinate */
+    /** The column coordinate (an integer) */
     j: number;
   }
 
+  /**
+   * 3D offset coordinates of a grid space.
+   */
+  interface Offset3D extends Offset2D {
+    /**
+     * The vertical coordinate (an integer)
+     */
+    k: number;
+  }
+
   type OffsetRange = [i0: number, j0: number, i1: number, j1: number];
 
-  type Coordinates = Offset | Canvas.Point;
+  type Coordinates = Coordinates2D | Coordinates3D;
+
+  type Coordinates2D = Offset2D | Canvas.Point;
+
+  type Coordinates3D = Offset3D | Canvas.ElevatedPoint;
 
   interface SnappingBehavior {
-    /** The snapping mode (a union of {@link CONST.GRID_SNAPPING_MODES | `CONST.GRID_SNAPPING_MODES`}) */
+    /** The snapping mode (a union of {@linkcode CONST.GRID_SNAPPING_MODES}) */
     mode: number;
 
     /**
@@ -559,7 +585,40 @@ declare namespace BaseGrid {
     resolution?: number | undefined;
   }
 
-  type MeasurePathWaypoint = Coordinates | (Configuration & { teleport: boolean });
+  interface _MeasurePathWaypointData {
+    /**
+     * Teleport to this waypoint?
+     * @defaultValue `false`
+     */
+    teleport?: boolean;
+
+    /**
+     * Measure of the segment from the previous to this waypoint? The distance, cost, spaces,
+     * diagonals, and Euclidean length of a segment that is not measured are always 0.
+     * @defaultValue `true`
+     */
+    measure?: boolean;
+  }
+
+  interface MeasurePathWaypointData2D extends _MeasurePathWaypointData {
+    /**
+     * A predetermined cost (nonnegative) or a cost function to be used instead of `options.cost`.
+     */
+    cost?: number | MeasurePathCostFunction2D;
+  }
+
+  interface MeasurePathWaypointData3D extends _MeasurePathWaypointData {
+    /**
+     * A predetermined cost (nonnegative) or a cost function to be used instead of `options.cost`.
+     */
+    cost?: number | MeasurePathCostFunction3D;
+  }
+
+  type MeasurePathWaypoint2D = InexactPartial<Coordinates2D & MeasurePathWaypointData2D>;
+
+  type MeasurePathWaypoint3D = InexactPartial<Coordinates3D & MeasurePathWaypointData3D>;
+
+  type MeasurePathWaypoint = MeasurePathWaypoint2D | MeasurePathWaypoint3D;
 
   /** The measurements of a waypoint. */
   interface MeasurePathResultWaypoint {
@@ -623,15 +682,45 @@ declare namespace BaseGrid {
   }
 
   /**
-   * A function that returns the cost for a given move between grid spaces.
-   * In square and hexagonal grids the grid spaces are always adjacent unless teleported.
-   * The distance is 0 if and only if teleported. The function is never called with the same offsets.
-   * @param from     - The offset that is moved from.
-   * @param to       - The offset that is moved to.
-   * @param distance - The distance between the grid spaces, or 0 if teleported.
-   * @returns The cost of the move between the grid spaces.
+   * @deprecated in favor of {@linkcode MeasurePathCostFunction2D}
    */
-  type MeasurePathCostFunction = (from: Offset, to: Offset, distance: number) => number;
+  type MeasurePathCostFunction = MeasurePathCostFunction2D;
+
+  /**
+   * A function that returns the cost for a given move between grid spaces in 2D.
+   * In square and hexagonal grids the grid spaces are always adjacent unless teleported.
+   * The function is never called with the same offsets.
+   * @param from     - The offset that is moved from
+   * @param to       - The offset that is moved to
+   * @param distance - The distance between the grid spaces
+   * @param segment  - The properties of the segment
+   * @returns The cost of the move between the grid spaces (nonnegative)
+   * @remarks foundry marks `from`, `to`, and `segment` as readonly
+   */
+  type MeasurePathCostFunction2D = (
+    from: Offset2D,
+    to: Offset2D,
+    distance: number,
+    segment: foundry.grid.BaseGrid.MeasurePathWaypoint2D,
+  ) => number;
+
+  /**
+   * A function that returns the cost for a given move between grid spaces in 3D.
+   * In square and hexagonal grids the grid spaces are always adjacent unless teleported.
+   * The function is never called with the same offsets.
+   * @param from     - The offset that is moved from
+   * @param to       - The offset that is moved to
+   * @param distance - The distance between the grid spaces
+   * @param segment  - The properties of the segment
+   * @returns The cost of the move between the grid spaces (nonnegative)
+   * @remarks foundry marks `from`, `to`, and `segment` as readonly
+   */
+  type MeasurePathCostFunction3D = (
+    from: Offset3D,
+    to: Offset3D,
+    distance: number,
+    segment: foundry.grid.BaseGrid.MeasurePathWaypoint3D,
+  ) => number;
 
   interface Dimensions {
     width: number;

package/src/foundry/common/grid/grid-hex.d.mts

@@ -1,4 +1,5 @@
 import type HexagonalGrid from "./hexagonal.mjs";
+import type { Canvas } from "#client/canvas/_module.d.mts";
 
 /**
  * A helper class which represents a single hexagon as part of a HexagonalGrid.

package/src/foundry/common/grid/gridless.d.mts

@@ -1,6 +1,7 @@
 import type BaseGrid from "./base.d.mts";
+import type { Canvas } from "#client/canvas/_module.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class Gridless extends BaseGrid {
   override type: typeof CONST.GRID_TYPES.GRIDLESS;
@@ -47,7 +48,7 @@ declare class Gridless extends BaseGrid {
 declare namespace Gridless {
   interface Configuration extends BaseGrid.Configuration {}
 
-  interface Offset extends BaseGrid.Offset {}
+  type Offset = BaseGrid.Offset;
 
   interface OffsetRange extends BaseGrid.OffsetRange {}
 
@@ -63,7 +64,7 @@ declare namespace Gridless {
 
   interface MeasurePathResult extends BaseGrid.MeasurePathResult {}
 
-  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction;
+  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction2D | BaseGrid.MeasurePathCostFunction3D;
 
   interface Dimensions extends BaseGrid.Dimensions {}
 }

package/src/foundry/common/grid/hexagonal.d.mts

@@ -1,6 +1,8 @@
 import type BaseGrid from "./base.d.mts";
+import type { Canvas } from "#client/canvas/_module.d.mts";
+import type { Token } from "#client/canvas/placeables/_module.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class HexagonalGrid extends BaseGrid {
   /**
@@ -51,7 +53,7 @@ declare class HexagonalGrid extends BaseGrid {
    * Returns the cube coordinates of the grid space corresponding to the given coordinates
    * shifted by one grid space in the given direction.
    * @param coords    - The coordinates
-   * @param direction - The direction (see {@link CONST.MOVEMENT_DIRECTIONS | `CONST.MOVEMENT_DIRECTIONS`})
+   * @param direction - The direction (see {@linkcode CONST.MOVEMENT_DIRECTIONS})
    * @returns The cube coordinates
    */
   getShiftedCube(coords: HexagonalGrid.Coordinates, direction: number): HexagonalGrid.Cube;
@@ -359,8 +361,12 @@ declare namespace HexagonalGrid {
     even: boolean;
   }
 
-  /** Cube coordinates in a hexagonal grid. q + r + s = 0. */
-  interface Cube {
+  type Cube = Cube2D | Cube3D;
+
+  /**
+   * 2D cube coordinates in a hexagonal grid. q + r + s = 0.
+   */
+  interface Cube2D {
     /**
      * The coordinate along the E-W (columns) or SW-NE (rows) axis.
      * Equal to the offset column coordinate if column orientation.
@@ -377,13 +383,33 @@ declare namespace HexagonalGrid {
     s: number;
   }
 
-  interface Offset extends BaseGrid.Offset {}
+  /**
+   * 3D cube coordinates in a hexagonal grid. q + r + s = 0.
+   */
+  interface Cube3D extends Cube2D {
+    /**
+     * The vertical coordinate.
+     */
+    k: number;
+  }
+
+  type Offset = BaseGrid.Offset;
 
   interface OffsetRange extends BaseGrid.OffsetRange {}
 
   /** Cube coordinates in a hexagonal grid. q + r + s = 0. */
   type Coordinates = BaseGrid.Coordinates | Cube;
 
+  /**
+   * 2D hexagonal cube coordinates, a 2D offset of a grid space, or a 2D point with pixel coordinates.
+   */
+  type Coordinates2D = BaseGrid.Coordinates2D | Cube2D;
+
+  /**
+   * 3D hexagonal cube coordinates, a 3D offset of a grid space, or a 3D point with pixel coordinates.
+   */
+  type Coordinates3D = BaseGrid.Coordinates3D | Cube3D;
+
   interface SnappingBehavior extends BaseGrid.SnappingBehavior {}
 
   type MeasurePathWaypoint = BaseGrid.MeasurePathWaypoint;
@@ -394,7 +420,7 @@ declare namespace HexagonalGrid {
 
   interface MeasurePathResult extends BaseGrid.MeasurePathResult {}
 
-  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction;
+  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction2D | BaseGrid.MeasurePathCostFunction3D;
 
   interface Dimensions extends BaseGrid.Dimensions {}
 }

package/src/foundry/common/grid/square.d.mts

@@ -1,6 +1,7 @@
 import type BaseGrid from "./base.d.mts";
+import type { Canvas } from "#client/canvas/_module.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class SquareGrid extends BaseGrid {
   /**
@@ -61,13 +62,13 @@ declare class SquareGrid extends BaseGrid {
 declare namespace SquareGrid {
   interface Configuration extends BaseGrid.Configuration {
     /**
-     * The rule for diagonal measurement (see {@link CONST.GRID_DIAGONALS | `CONST.GRID_DIAGONALS`})
+     * The rule for diagonal measurement (see {@linkcode CONST.GRID_DIAGONALS})
      * Default: `CONST.GRID_DIAGONALS.EQUIDISTANT`,
      */
     diagonals: number;
   }
 
-  interface Offset extends BaseGrid.Offset {}
+  type Offset = BaseGrid.Offset;
 
   interface OffsetRange extends BaseGrid.OffsetRange {}
 
@@ -92,7 +93,7 @@ declare namespace SquareGrid {
     diagonals: number;
   }
 
-  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction;
+  type MeasurePathCostFunction = BaseGrid.MeasurePathCostFunction2D | BaseGrid.MeasurePathCostFunction3D;
 
   interface Dimensions extends BaseGrid.Dimensions {}
 }

package/src/foundry/common/packages/base-module.d.mts

@@ -2,7 +2,6 @@ import type BasePackage from "./base-package.d.mts";
 
 declare namespace BaseModule {
   export import Source = Module.Source;
-  export import PersistedData = Module.Source;
   export import CreateData = Module.CreateData;
   export import InitializedData = Module.InitializedData;
   export import UpdateData = Module.UpdateData;

package/src/foundry/common/packages/base-package.d.mts

@@ -1,4 +1,4 @@
-import type { GetKey, AnyObject, InexactPartial, AnyMutableObject, Identity, AnyArray } from "fvtt-types/utils";
+import type { GetKey, AnyObject, InexactPartial, AnyMutableObject, Identity, AnyArray, NullishProps } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type { ReleaseData } from "../config.d.mts";
 import type * as fields from "../data/fields.d.mts";
@@ -305,6 +305,7 @@ declare namespace BasePackage {
     media: fields.SetField<fields.SchemaField<PackageMediaSchema>>;
 
     // Moved to base-module and base-system to avoid conflict with base-world
+
     /**
      * The current package version
      */
@@ -381,9 +382,22 @@ declare namespace BasePackage {
     hasStorage: boolean;
   }
 
-  interface LogOptions extends InexactPartial<LogCompatibilityWarningOptions> {
+  /** @internal */
+  type _Installed = NullishProps<{
     /** Is the package installed? */
-    installed?: unknown;
+    installed: boolean;
+  }>;
+
+  interface LogOptions extends _Installed, InexactPartial<LogCompatibilityWarningOptions> {}
+
+  interface MigrateDataOptions extends _Installed {}
+
+  interface CleanDataOptions extends fields.DataField.CleanOptions {
+    /**
+     * Is the package installed?
+     * @remarks Only used to pass on to {@link BasePackage._logWarning | `BasePackage#_logWarning`}
+     */
+    installed?: boolean | null | undefined;
   }
 }
 
@@ -401,7 +415,7 @@ export class PackageRelationships extends fields.SchemaField<BasePackage.Package
   constructor(options: fields.SchemaField.Options<BasePackage.PackageRelationshipsSchema>);
 }
 
-// ommitted private class PackageRelationshipField
+// omitted private class PackageRelationshipField
 
 /**
  * A custom SchemaField for defining a related Package.
@@ -448,15 +462,17 @@ export class CompendiumOwnershipField extends fields.ObjectField<
   static override get _defaults(): {
     /** @defaultValue `{PLAYER: "OBSERVER", ASSISTANT: "OWNER"}` */
     initial: BasePackage.OwnershipRecord;
+
     /**
      * @defaultValue `"is not a mapping of USER_ROLES to DOCUMENT_OWNERSHIP_LEVELS"`
      */
     validationError: string;
   };
 
+  /** @remarks `options` is unused in `CompendiumOwnershipField` */
   protected override _validateType(
     value: Record<keyof typeof foundry.CONST.USER_ROLES, keyof typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS>,
-    options?: any,
+    options?: fields.DataField.ValidateOptions<this> | null,
   ): boolean | void;
 }
 
@@ -471,23 +487,25 @@ export class PackageCompendiumPacks<
     options?: fields.DataField.CleanOptions,
   ): Set<fields.ArrayField.InitializedElementType<ElementFieldType>>;
 
+  // options: not null (parameter default only)
   override initialize(
     value: fields.ArrayField.PersistedElementType<ElementFieldType>[],
     // In Foundry itself, this field is only used in `BasePackage`, however it should be able to accept any model.
     // NOTE(LukeAbby): This also has been seen in a circularity `Type of property 'packs' circularly references itself in mapped type ...`.
     model: DataModel.Any,
+    options?: fields.DataField.InitializeOptions,
   ):
     | Set<fields.ArrayField.InitializedElementType<ElementFieldType>>
     | (() => Set<fields.ArrayField.InitializedElementType<ElementFieldType>> | null);
 
   protected override _validateElements(
     value: AnyArray,
-    options?: fields.DataField.ValidationOptions<fields.DataField.Any>,
+    options?: fields.DataField.ValidateOptions<fields.DataField.Any>,
   ): void | DataModelValidationFailure;
 
   protected override _validateElement(
     value: unknown,
-    options: fields.DataField.ValidationOptions<fields.DataField.Any>,
+    options: fields.DataField.ValidateOptions<fields.DataField.Any>,
   ): void | DataModelValidationFailure;
 }
 
@@ -535,7 +553,7 @@ declare class BasePackage<
   /**
    * Define the package type in CONST.PACKAGE_TYPES that this class represents.
    * Each BasePackage subclass must define this attribute.
-   * @virtual
+   * @abstract
    */
   static type: foundry.CONST.PACKAGE_TYPES;
 
@@ -586,7 +604,7 @@ declare class BasePackage<
    * @param modulesCollection - A collection which defines the set of available modules
    * @returns Are all required dependencies satisfied?
    */
-  _testRequiredDependencies(modulesCollection: Collection<Module>): Promise<boolean>;
+  _testRequiredDependencies(modulesCollection: Collection<foundry.packages.Module>): Promise<boolean>;
 
   /**
    * Test compatibility of a package's supported systems.
@@ -595,7 +613,7 @@ declare class BasePackage<
    *          are compatible or if the package has no supported systems.
    *          Returns false otherwise, or if no supported systems are installed.
    */
-  _testSupportedSystems(systemCollection: Collection<System>): Promise<boolean>;
+  _testSupportedSystems(systemCollection: Collection<foundry.packages.System>): Promise<boolean>;
 
   /**
    * Determine if a dependency is within the given compatibility range.
@@ -605,7 +623,7 @@ declare class BasePackage<
    */
   static testDependencyCompatibility(compatibility: PackageCompatibility, dependency: BasePackage): boolean;
 
-  static cleanData(source?: AnyObject, options?: fields.DataField.CleanOptions): AnyObject;
+  static cleanData(source?: AnyObject, options?: BasePackage.CleanDataOptions): AnyMutableObject;
 
   /**
    * Validate that a Package ID is allowed.
@@ -627,12 +645,19 @@ declare class BasePackage<
    */
   static migratedKeys: Set<string>;
 
-  static migrateData(
-    data: AnyMutableObject,
-    logOptions?: InexactPartial<{
-      installed: boolean;
-    }>,
-  ): AnyMutableObject;
+  /**
+   * @remarks
+   * Migrations:
+   * - `name` to `id`, both at root and for any `dependencies` (since v10 until v13)
+   * - `dependencies` to `relationships` (structural change) (since v10 until v13)
+   * - `minimumCoreVersion` and `compatibleCoreVersion` to `compatibility.minimum` and `.verified`, respectively (since v10 until v13)
+   * - Inside `media` entries, `link` to `url` (since v11 until v13)
+   * - Inside `packs` entries:
+   *   - `private` to an `ownership` object with `{PLAYER: "LIMITED", ASSISTANT: "OWNER"}` (since v11 until v13)
+   *   - Slugifies the `name` if not already a valid slug (since v12, until v14)
+   *   - `entity` to `type` (since v9, no specified end)
+   */
+  static override migrateData(data: AnyMutableObject, options?: BasePackage.MigrateDataOptions): AnyMutableObject;
 
   protected static _migrateNameToId(data: AnyObject, logOptions: BasePackage.LogOptions): void;
 

package/src/foundry/common/packages/base-system.d.mts

@@ -1,8 +1,9 @@
+import type { AnyMutableObject } from "../../../utils/index.d.mts";
+import type DataModel from "../abstract/data.d.mts";
 import type BasePackage from "./base-package.d.mts";
 
 declare namespace BaseSystem {
   export import Source = System.Source;
-  export import PersistedData = System.Source;
   export import CreateData = System.CreateData;
   export import InitializedData = System.InitializedData;
   export import UpdateData = System.UpdateData;
@@ -28,6 +29,43 @@ declare class BaseSystem extends BasePackage<BaseSystem.Schema> {
    * Does the system template request strict type checking of data compared to template.json inferred types.
    */
   strictDataCleaning: boolean;
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `BaseSystem#gridDistance` which has been migrated to {@link BaseSystem.grid | `BaseSystem#grid`}`#distance`"
+   */
+  get gridDistance(): number;
+
+  set gridDistance(number);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `BaseSystem#gridUnits` which has been migrated to {@link BaseSystem.grid | `BaseSystem#grid`}`#units`"
+   */
+  get gridUnits(): number;
+
+  set gridUnits(number);
+
+  /** @remarks Adds `gridDistance` and `gridUnits` to super's */
+  static override migratedKeys: Set<string>;
+
+  /**
+   * @remarks
+   * Migrations:
+   * - {@link BasePackage.migrateData | `BasePackage`}'s
+   * - `gridDistance` to `grid.distance` (since v12, until v14)
+   * - `gridUnits` to `grid.units` (since v12, until v14)
+   */
+  static override migrateData(data: AnyMutableObject, options?: BasePackage.MigrateDataOptions): AnyMutableObject;
+
+  /**
+   * @remarks
+   * Shims:
+   * - `gridDistance` to `grid.distance` (since v12, until v14)
+   * - `gridUnits` to `grid.units` (since v12, until v14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 }
 
 export default BaseSystem;