@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/pixi/layers/grid/layer.d.mts

@@ -1,4 +1,4 @@
-import type { HandleEmptyObject, InexactPartial, NullishProps } from "fvtt-types/utils";
+import type { EmptyObject, HandleEmptyObject, Identity, NullishProps, RemoveIndexSignatures } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -15,12 +15,14 @@ declare global {
     /**
      * The grid mesh.
      * @defaultValue `undefined`
+     * @remarks Only `undefined` prior to first draw
      */
     mesh: GridMesh | undefined;
 
     /**
      * The Grid Highlight container
      * @defaultValue `undefined`
+     * @remarks Only `undefined` prior to first draw
      */
     highlight: PIXI.Container | undefined;
 
@@ -40,38 +42,18 @@ declare global {
 
     override options: GridLayer.LayerOptions;
 
-    /**
-     * Draw the grid
-     * @param options - Override settings used in place of those saved to the Scene data
-     */
-    _draw(options: HandleEmptyObject<GridLayer.DrawOptions>): Promise<void>;
+    protected override _draw(options: HandleEmptyObject<GridLayer.DrawOptions>): Promise<void>;
 
     /**
      * Creates the grid mesh.
      */
-    protected _drawMesh(): Promise<ReturnType<GridMesh["initialize"]>>;
+    protected _drawMesh(): GridMesh;
 
     /**
      * Initialize the grid mesh appearance and configure the grid shader.
+     * @remarks All the properties of `options` are optional, but it lacks an `={}` default so an object must be passed, even if empty
      */
-    initializeMesh(
-      /**
-       * @remarks Can't be NullishProps because ultimately `GridMesh#_initialize` does `!== undefined` checks
-       */
-      options?: InexactPartial<{
-        /** The grid style */
-        style: string; //TODO: Update as part of #2572 to keyof CONFIG["Canvas"]["gridStyles"];
-
-        /** The grid thickness */
-        thickness: number;
-
-        /** The grid color */
-        color: string;
-
-        /** The grid alpha */
-        alpha: number;
-      }>,
-    ): void;
+    initializeMesh(options: GridLayer.InitializeMeshOptions): void;
 
     /**
      * Define a new Highlight graphic
@@ -101,99 +83,96 @@ declare global {
      * Add highlighting for a specific grid position to a named highlight graphic
      * @param name    - The name for the referenced highlight layer
      * @param options - Options for the grid position that should be highlighted
+     * @remarks Despite being an `={}` parameter, `options` is required, as not providing `x` or `y` produces `NaN`s
+     * or puts garbage data into the associated `GridHightlightLayer`, depending on the current grid type
      */
     highlightPosition(name: string, options: GridLayer.HighlightPositionOptions): void;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#type is deprecated. Use canvas.grid.type instead."`
+     * @remarks "GridLayer#type is deprecated. Use canvas.grid.type instead."
      */
     get type(): foundry.CONST.GRID_TYPES;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#size is deprecated. Use canvas.grid.size instead.`
+     * @remarks "GridLayer#size is deprecated. Use canvas.grid.size instead.
      */
     get size(): number;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * `"GridLayer#grid is deprecated. Use canvas.grid instead."`
+     * @remarks "GridLayer#grid is deprecated. Use canvas.grid instead."
      */
-    grid: Canvas["grid"];
+    get grid(): Canvas["grid"];
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#isNeighbor is deprecated. Use canvas.grid.testAdjacency instead."`
+     * @remarks "GridLayer#isNeighbor is deprecated. Use canvas.grid.testAdjacency instead."
      */
     isNeighbor(r0: number, c0: number, r1: number, c1: number): boolean;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#w is deprecated in favor of canvas.grid.sizeX."`
+     * @remarks "GridLayer#w is deprecated in favor of canvas.grid.sizeX."
      */
     get w(): number;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#h is deprecated in favor of canvas.grid.sizeY."`
+     * @remarks "GridLayer#h is deprecated in favor of canvas.grid.sizeY."
      */
     get h(): number;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#isHex is deprecated. Use canvas.grid.isHexagonal instead."`
+     * @remarks "GridLayer#isHex is deprecated. Use canvas.grid.isHexagonal instead."
      */
     get isHex(): boolean;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#getTopLeft is deprecated. Use canvas.grid.getTopLeftPoint instead."`
+     * @remarks "GridLayer#getTopLeft is deprecated. Use canvas.grid.getTopLeftPoint instead."
      */
     getTopLeft(x: number, y: number): Canvas.PointTuple;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#getCenter is deprecated. Use canvas.grid.getCenterPoint instead."`
+     * @remarks "GridLayer#getCenter is deprecated. Use canvas.grid.getCenterPoint instead."
      */
     getCenter(x: number, y: number): Canvas.PointTuple;
 
     /**
      * @deprecated since v12, will be removed in v14
-     * @remarks `"GridLayer#getSnappedPosition is deprecated. Use canvas.grid.getCenterPoint instead."`
+     * @remarks "GridLayer#getSnappedPosition is deprecated. Use canvas.grid.getCenterPoint instead."
      */
     getSnappedPosition(
       x: number,
       y: number,
+      /**
+       * @defaultValue `1`
+       * @remarks Can't be `null` due to being used directly as a divisor
+       */
       interval?: number,
-      options?: NullishProps<{
-        /**
-         * The token
-         */
-        token: Token;
-      }>,
-    ): { x: number; y: number };
+      /** @remarks Unused */
+      options?: EmptyObject | null,
+    ): PIXI.IPointData;
 
     /**
      * @deprecated since v12, will be removed in v14
      * @remarks `"GridLayer#measureDistance is deprecated. "Use canvas.grid.measurePath instead for non-Euclidean measurements."`
      */
     measureDistance(
-      origin: {
-        x: number;
-        y: number;
-      },
-      target: {
-        x: number;
-        y: number;
-      },
-      // eslint-disable-next-line @typescript-eslint/no-deprecated
-      options?: GridLayer.MeasureDistancesOptions,
+      origin: Canvas.Point,
+      target: Canvas.Point,
+      /** @remarks Unused */
+      options?: EmptyObject | null,
     ): number;
   }
 
   namespace GridLayer {
-    type AnyConstructor = typeof AnyGridLayer;
+    interface Any extends AnyGridLayer {}
+    interface AnyConstructor extends Identity<typeof AnyGridLayer> {}
 
     interface DrawOptions extends CanvasLayer.DrawOptions {}
 
@@ -203,65 +182,88 @@ declare global {
       name: "grid";
     }
 
-    interface HighlightPositionOptions {
-      /**
-       * The x-coordinate of the highlighted position
-       * @remarks Required if `canvas.grid !== CONST.GRID_TYPES.GRIDLESS`
-       */
-      x?: number | undefined | null;
+    /** @internal */
+    type _InitializeMeshOptions = NullishProps<{
+      /** The grid style */
+      style: ConfiguredGridStyles;
+    }>;
 
-      /**
-       * The y-coordinate of the highlighted position
-       * @remarks Required if `canvas.grid !== CONST.GRID_TYPES.GRIDLESS`
-       */
-      y?: number | undefined | null;
+    interface InitializeMeshOptions
+      extends _InitializeMeshOptions,
+        Pick<GridMesh.InitializationMeshData, "thickness" | "color" | "alpha"> {}
 
+    /** @internal */
+    type _HighlightPositionOptions = NullishProps<{
       /**
-       * The fill color of the highlight
        * @defaultValue `0x33BBFF`
-       * @privateRemarks `null` is a problem because it's forwarded to a PIXI.Graphics#beginFill call which has a default value set
+       * @remarks This value eventually ends up at `PIXI.Graphics#normalizeColor()`, which handles `null` as `0` (black)
        */
-      color?: PIXI.ColorSource | undefined;
+      color: PIXI.ColorSource | Color;
 
       /**
        * The border color of the highlight
        * @defaultValue `null`
+       * @remarks If `null`, no border will be drawn.
        */
-      border?: PIXI.ColorSource | undefined | null;
+      border: PIXI.ColorSource | Color;
 
       /**
        * The opacity of the highlight
        * @defaultValue `0.25`
+       * @remarks The above is only a parameter default; `PIXI.Graphics#normalizeColor()` will replace `null` with `1`
        */
-      alpha?: number | undefined;
+      alpha: number;
 
       /**
        * A predefined shape to highlight
        * @defaultValue `null`
+       * @remarks Must be provided on gridless scenes or highlighting will fail quietly
        */
-      shape?: PIXI.Polygon | undefined | null;
-    }
+      shape: PIXI.IShape;
+    }>;
 
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks Used by {@link foundry.grid.BaseGrid#measureDistances}
-     */
-    interface Segment {
-      ray: Ray;
-      label?: Ruler["labels"]["children"][number];
+    interface HighlightPositionOptions extends _HighlightPositionOptions {
+      /**
+       * The x-coordinate of the highlighted position
+       * @remarks Required despite Foundry marking it optional. If omitted on gridless will produce `NaN`s,
+       * and on other grid types will insert garbage data into the associated `GridHighlightLayer`
+       */
+      x: number;
+
+      /**
+       * The y-coordinate of the highlighted position
+       * @remarks Required despite Foundry marking it optional. If omitted on gridless will produce `NaN`s,
+       * and on other grid types will insert garbage data into the associated `GridHighlightLayer`
+       */
+      y: number;
     }
 
-    /**
-     * @deprecated since v12, will be removed in v14
-     * @remarks Used by {@link foundry.grid.BaseGrid#measureDistances}
-     */
-    type MeasureDistancesOptions = NullishProps<{
-      /** Return the distance in grid increments rather than the co-ordinate distance. */
-      gridSpaces?: boolean;
+    /** @internal */
+    type _GridStyle = NullishProps<{
+      /** @defaultValue `GridShader` */
+      shaderClass: GridShader.AnyConstructor;
+
+      /** @defaultValue `{}` */
+      shaderOptions: NullishProps<{
+        /**
+         * @defaultValue `0`
+         * @remarks Gets applied to the constructed shaderClass instance's `uniforms`.
+         *
+         * @privateRemarks It's unclear if this is actually repesenting an enum value or not, so it's been left as `number`.
+         */
+        style: number;
+      }>;
     }>;
+
+    interface GridStyle extends _GridStyle {
+      /** @remarks A localization key to display in the Configure Scene sheet */
+      label: string;
+    }
+
+    type ConfiguredGridStyles = keyof RemoveIndexSignatures<CONFIG["Canvas"]["gridStyles"]>;
   }
 }
 
 declare abstract class AnyGridLayer extends GridLayer {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/pixi/layers/grid/mesh.d.mts

@@ -2,7 +2,7 @@ import type { InexactPartial } from "fvtt-types/utils";
 
 declare global {
   /**
-   * The grid mesh, which uses the {@link GridShader} to render the grid.
+   * The grid mesh, which uses the {@link GridShader | `GridShader`} to render the grid.
    */
   class GridMesh extends QuadMesh {
     /**
@@ -26,48 +26,69 @@ declare global {
      * }
      * ```
      */
-    data: GridMesh.Data;
+    data: GridMesh.MeshData;
 
     /**
      * Initialize and update the mesh given the (partial) data.
      * @param data - The (partial) data
-     * @remarks InexactPartial is more correct as null has different behavior in _initialize
      */
-    initialize(data: InexactPartial<GridMesh.Data>): this;
+    initialize(data: GridMesh.InitializationMeshData): this;
 
     /**
      * Initialize the data of this mesh given the (partial) data.
      * @param data - The (partial) data.
-     * @remarks Can't be NullishProps because of `!== undefined` tests
      */
-    protected _initialize(data: InexactPartial<GridMesh.Data>): void;
+    protected _initialize(data: GridMesh.InitializationMeshData): void;
   }
 
   namespace GridMesh {
     /**
      * The grid mesh data.
      */
-    interface Data {
-      /** The type of the grid (see {@link CONST.GRID_TYPES}) */
-      type: number;
+    interface MeshData {
+      /**
+       * The type of the grid (see {@link CONST.GRID_TYPES | `CONST.GRID_TYPES`})
+       * @defaultValue `CONST.GRID_TYPES.GRIDLESS`
+       */
+      type: foundry.CONST.GRID_TYPES;
 
-      /** The width of the grid in pixels */
+      /**
+       * The width of the grid in pixels
+       * @defaultValue `0`
+       */
       width: number;
 
-      /** The height of the grid in pixels */
+      /**
+       * The height of the grid in pixels
+       * @defaultValue `0`
+       */
       height: number;
 
-      /** The size of a grid space in pixels */
+      /**
+       * The size of a grid space in pixels
+       * @defaultValue `0`
+       */
       size: number;
 
-      /** The thickness of the grid lines in pixels */
+      /**
+       * The thickness of the grid lines in pixels
+       * @defaultValue `1`
+       */
       thickness: number;
 
-      /** The color of the grid */
+      /**
+       * The color of the grid
+       * @defaultValue `0`
+       */
       color: number;
 
-      /** The alpha of the grid */
+      /**
+       * The alpha of the grid
+       * @defaultValue `1`
+       */
       alpha: number;
     }
+
+    interface InitializationMeshData extends InexactPartial<MeshData> {}
   }
 }

package/src/foundry/client/pixi/layers/masks/depth.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -58,10 +58,10 @@ declare global {
 
   namespace CanvasDepthMask {
     interface Any extends AnyCanvasDepthMask {}
-    type AnyConstructor = typeof AnyCanvasDepthMask;
+    interface AnyConstructor extends Identity<typeof AnyCanvasDepthMask> {}
   }
 }
 
 declare abstract class AnyCanvasDepthMask extends CanvasDepthMask {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/pixi/layers/masks/occlusion.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -78,7 +78,7 @@ declare global {
      * @param tokens - The set of currently controlled Token objects
      * @returns The PCO objects which should be currently occluded
      */
-    protected _identifyOccludedObjects(tokens: Token.ConfiguredInstance[]): Set<PrimaryCanvasObjectMixin.AnyMixed>;
+    protected _identifyOccludedObjects(tokens: Token.Implementation[]): Set<PrimaryCanvasObjectMixin.AnyMixed>;
 
     /**
      * @deprecated since v11, will be removed in v13
@@ -89,10 +89,10 @@ declare global {
 
   namespace CanvasOcclusionMask {
     interface Any extends AnyCanvasOcclusionMask {}
-    type AnyConstructor = typeof AnyCanvasOcclusionMask;
+    interface AnyConstructor extends Identity<typeof AnyCanvasOcclusionMask> {}
   }
 }
 
 declare abstract class AnyCanvasOcclusionMask extends CanvasOcclusionMask {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/pixi/layers/masks/vision.d.mts

@@ -1,4 +1,4 @@
-export {};
+import type { Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -68,10 +68,10 @@ declare global {
 
   namespace CanvasVisionMask {
     interface Any extends AnyCanvasVisionMask {}
-    type AnyConstructor = typeof AnyCanvasVisionMask;
+    interface AnyConstructor extends Identity<typeof AnyCanvasVisionMask> {}
 
     /**
-     * The sight part of {@link CanvasVisionContainer}.
+     * The sight part of {@link CanvasVisionContainer | `CanvasVisionContainer`}.
      * The blend mode is MAX_COLOR.
      */
     interface CanvasVisionContainerSight extends PIXI.LegacyGraphics {
@@ -94,7 +94,7 @@ declare global {
     }
 
     /**
-     * The light part of {@link CanvasVisionContainer}.
+     * The light part of {@link CanvasVisionContainer | `CanvasVisionContainer`}.
      * The blend mode is MAX_COLOR.
      */
     interface CanvasVisionContainerLight extends PIXI.LegacyGraphics {
@@ -144,7 +144,7 @@ declare global {
     }
 
     /**
-     * The sight part of {@link CanvasVisionContainer}.
+     * The sight part of {@link CanvasVisionContainer | `CanvasVisionContainer`}.
      * The blend mode is ERASE.
      */
     interface CanvasVisionContainerDarkness extends PIXI.LegacyGraphics {
@@ -198,5 +198,5 @@ declare global {
 }
 
 declare abstract class AnyCanvasVisionMask extends CanvasVisionMask {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/pixi/layers/placeables/drawings.d.mts

@@ -1,4 +1,4 @@
-import type { HandleEmptyObject } from "../../../../../utils/index.d.mts";
+import type { HandleEmptyObject, Identity } from "fvtt-types/utils";
 
 declare global {
   /**
@@ -35,11 +35,14 @@ declare global {
      */
     static DEFAULT_CONFIG_SETTING: "defaultDrawingConfig";
 
-    graphics: Collection<Drawing>;
+    /**
+     * The collection of drawing objects which are rendered in the interface.
+     */
+    graphics: Collection<Drawing.Implementation>;
 
-    override get hud(): Exclude<Canvas["hud"], undefined>["drawing"];
+    override get hud(): NonNullable<Canvas["hud"]>["drawing"];
 
-    override get hookName(): string;
+    override get hookName(): "DrawingsLayer";
 
     override getSnappedPoint(point: Canvas.Point): Canvas.Point;
 
@@ -48,18 +51,18 @@ declare global {
      */
     configureDefault(): void;
 
-    override _deactivate(): void;
+    protected override _deactivate(): void;
 
-    override _draw(options: HandleEmptyObject<DrawingsLayer.DrawOptions>): Promise<void>;
+    protected override _draw(options: HandleEmptyObject<DrawingsLayer.DrawOptions>): Promise<void>;
 
     /**
      * Get initial data for a new drawing.
      * Start with some global defaults, apply user default config, then apply mandatory overrides per tool.
      * @param origin - The initial coordinate
      * @returns The new drawing data
-     * @remarks This is used from DrawingConfig and hence public on purpose.
+     * @privateRemarks This isn't called externally (anymore?) but seems too useful to make protected without any indication on Foundry's side of such intent
      */
-    _getNewDrawingData(origin: Canvas.Point): foundry.documents.BaseDrawing.ConstructorData;
+    _getNewDrawingData(origin: Canvas.Point): DrawingDocument.CreateData;
 
     protected override _onClickLeft(event: PIXI.FederatedEvent): void;
 
@@ -90,11 +93,12 @@ declare global {
   }
 
   namespace DrawingsLayer {
-    type AnyConstructor = typeof AnyDrawingsLayer;
+    interface Any extends AnyDrawingsLayer {}
+    interface AnyConstructor extends Identity<typeof AnyDrawingsLayer> {}
 
     interface DrawOptions extends CanvasLayer.DrawOptions {}
 
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"Drawing"> {
+    interface LayerOptions extends PlaceablesLayer.LayerOptions<Drawing.ImplementationClass> {
       name: "drawings";
       controllableObjects: true;
       rotatableObjects: true;
@@ -104,5 +108,5 @@ declare global {
 }
 
 declare abstract class AnyDrawingsLayer extends DrawingsLayer {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }

package/src/foundry/client/pixi/layers/placeables/lighting.d.mts

@@ -1,4 +1,4 @@
-import type { HandleEmptyObject } from "../../../../../utils/index.d.mts";
+import type { HandleEmptyObject, Identity } from "fvtt-types/utils";
 
 /**
  * The Lighting Layer which ambient light sources as part of the CanvasEffectsGroup.
@@ -29,20 +29,20 @@ declare global {
      */
     static override get layerOptions(): LightingLayer.LayerOptions;
 
-    override get hookName(): string;
+    override get hookName(): "LightingLayer";
 
-    override _draw(options: HandleEmptyObject<LightingLayer.DrawOptions>): Promise<void>;
+    protected override _draw(options: HandleEmptyObject<LightingLayer.DrawOptions>): Promise<void>;
 
-    override _tearDown(options: HandleEmptyObject<LightingLayer.TearDownOptions>): Promise<void>;
+    protected override _tearDown(options: HandleEmptyObject<LightingLayer.TearDownOptions>): Promise<void>;
 
     /**
      * Refresh the fields of all the ambient lights on this scene.
      */
     refreshFields(): void;
 
-    override _activate(): void;
+    protected override _activate(): void;
 
-    protected override _canDragLeftStart(user: User.ConfiguredInstance, event: PIXI.FederatedEvent): boolean;
+    protected override _canDragLeftStart(user: User.Implementation, event: PIXI.FederatedEvent): boolean;
 
     protected override _onDragLeftStart(event: PIXI.FederatedEvent): void;
 
@@ -51,7 +51,7 @@ declare global {
     protected override _onDragLeftCancel(event: PointerEvent): void;
 
     // @ts-expect-error Foundry is changing the return type here from Promise<PlaceableObject[]> to just Promise<AmbientLight>
-    protected _onMouseWheel(event: WheelEvent): ReturnType<AmbientLight.ConfiguredInstance["rotate"]>;
+    protected _onMouseWheel(event: WheelEvent): Promise<AmbientLight.Implementation>;
 
     /**
      * Actions to take when the darkness level of the Scene is changed
@@ -61,13 +61,14 @@ declare global {
   }
 
   namespace LightingLayer {
-    type AnyConstructor = typeof AnyLightingLayer;
+    interface Any extends AnyLightingLayer {}
+    interface AnyConstructor extends Identity<typeof AnyLightingLayer> {}
 
     interface DrawOptions extends PlaceablesLayer.DrawOptions {}
 
     interface TearDownOptions extends PlaceablesLayer.TearDownOptions {}
 
-    interface LayerOptions extends PlaceablesLayer.LayerOptions<"AmbientLight"> {
+    interface LayerOptions extends PlaceablesLayer.LayerOptions<AmbientLight.ImplementationClass> {
       name: "lighting";
       rotatableObjects: true;
       zIndex: 900;
@@ -76,5 +77,5 @@ declare global {
 }
 
 declare abstract class AnyLightingLayer extends LightingLayer {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }