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

package/src/foundry/client-esm/canvas/tokens/ring.d.mts

@@ -1,28 +1,39 @@
-import type { MaybeInitialized } from "../../../client/game.d.mts";
+import type { Brand, FixedInstanceType, Identity, InitializedOn } from "fvtt-types/utils";
+import type DynamicRingData from "./ring-data.d.mts";
 
 /**
  * Dynamic Token Ring Manager.
  */
 declare class TokenRing {
-  #TokenRing: true;
-
   /** A `TokenRing` is constructed by providing a reference to a `Token` object. */
-  constructor(token: Token.ConfiguredInstance);
+  constructor(token: Token.Implementation);
 
   /** The effects which could be applied to a token ring (using bitwise operations) */
   static effects: TokenRing.Effects;
 
-  /** Is the token rings framework enabled? Will be `null` if the system hasn't initialized yet. */
-  static get initialized(): MaybeInitialized<boolean, "init">;
+  /**
+   * Is the token rings framework enabled? Will be `null` if the system hasn't initialized yet.
+   * @remarks {@link TokenRing.initialize | `CONFIG.Token.ring.ringClass.initialize`} is called inside {@link Canvas.initialize | `Canvas.initialize`}, which is called between the `setup` and `ready` hooks.
+   */
+  static get initialized(): InitializedOn<true, "ready", null>;
 
-  /** Token Rings sprite sheet base texture. */
-  static baseTexture: PIXI.BaseTexture;
+  /**
+   * Token Rings sprite sheet base texture.
+   * @remarks Only `undefined` prior to first canvas draw; set in {@link createAssetsUVs | `createAssetsUVs`}
+   */
+  static baseTexture: PIXI.BaseTexture | undefined;
 
-  /** Rings and background textures UVs and center offset. */
-  static texturesData: Record<string, { UVs: Float32Array; center: { x: number; y: number } }>;
+  /**
+   * Rings and background textures UVs and center offset.
+   * @remarks Only `undefined` prior to first canvas draw; set in {@link createAssetsUVs | `createAssetsUVs`}
+   */
+  static texturesData: Record<string, TokenRing.TextureData> | undefined;
 
-  /** The token ring shader class definition. */
-  static tokenRingSamplerShader: TokenRing.SampleShaderClass;
+  /**
+   * The token ring shader class definition.
+   * @remarks Set in {@link TokenRing.initialize | `initialize`}
+   */
+  static tokenRingSamplerShader: InitializedOn<DynamicRingData["framework"]["shaderClass"], "ready", undefined>;
 
   /** Initialize the Token Rings system, registering the batch plugin and patching `PrimaryCanvasGroup#addToken`. */
   static initialize(): void;
@@ -33,25 +44,35 @@ declare class TokenRing {
   /**
    * Get the UVs array for a given texture name and scale correction.
    * @param name              - Name of the texture we want to get UVs.
-   * @param scaleCorrection   - The scale correction applied to UVs. @defaultValue `1`
-   * @remarks scaleCorrection accepts undefined due to default value,
-   * but scaleCorrection is not checked against null in function body.
+   * @param scaleCorrection   - The scale correction applied to UVs. (default: `1`)
    */
+  // scaleCorrection: not null (parameter default only, casting to 0 produces nonsense)
   static getTextureUVs(name: string, scaleCorrection?: number): Float32Array;
 
   /**
    * Get ring and background names for a given size.
    * @param size  - The size to match (grid size dimension)
+   * @remarks `size` is in units of grid _spaces_, the core rings provide spritesheet frames for `0.5`, `1`, `2`, `3`, and `4`,
+   * and the value core passes in its only call is `Math.min(this.token.document.width ?? 1, this.token.document.height ?? 1)`.
+   * Values between provided sizes will use the closest available size provided.
    */
-  static getRingDataBySize(size: number): TokenRing.RingDataBySizeReturnType;
+  static getRingDataBySize(size: number): TokenRing.RingData;
 
-  ringName: string;
+  /**
+   * @remarks Not initialized to a value, this gets set in {@link TokenRing.configureSize | TokenRing.configureSize`}.
+   * After initialization (`ready`), this will only be `undefined` if the current spritesheet provides no frames
+   */
+  ringName: TokenRing.RingData["ringName"];
 
-  bkgName: string;
+  /**
+   * @remarks Not initialized to a value, this gets set in {@link TokenRing.configureSize | `TokenRing.configureSize`}.
+   * After initialization (`ready`), this will only be `undefined` if the current spritesheet provides no frames
+   */
+  bkgName: TokenRing.RingData["bkgName"];
 
-  ringUVs: Float32Array;
+  ringUVs: InitializedOn<Float32Array, "ready", undefined>;
 
-  bkgUVs: Float32Array;
+  bkgUVs: InitializedOn<Float32Array, "ready", undefined>;
 
   /**
    * Little endian format =\> BBGGRR
@@ -66,19 +87,20 @@ declare class TokenRing {
   bkgColorLittleEndian: number;
 
   /**
-   * Cannot be undefined as core explicitly checks for null.
    * @defaultValue `null`
+   * @remarks Cannot be `undefined` as core explicitly checks for `null`.
    */
-  defaultRingColorLittleEndian: number | null;
+  defaultRingColorLittleEndian: TokenRing.RingData["defaultRingColorLittleEndian"];
 
   /**
-   * Cannot be undefined as core explicitly checks for null.
    * @defaultValue `null`
+   * @remarks Cannot be `undefined` as core explicitly checks for `null`.
    */
-  defaultBackgroundColorLittleEndian: number | null;
+  defaultBackgroundColorLittleEndian: TokenRing.RingData["defaultBackgroundColorLittleEndian"];
 
   /**
    * @defaultValue `0`
+   * @remarks A bitmask of {@link TokenRing.Effects | `effects`}
    */
   effects: number;
 
@@ -100,23 +122,31 @@ declare class TokenRing {
   /**
    * @defaultValue `1`
    */
-  subjectScaleAdjustment: number;
+  subjectScaleAdjustment: TokenRing.RingData["subjectScaleAdjustment"];
 
   /**
    * @defaultValue `1`
    */
   textureScaleAdjustment: number;
 
-  colorBand: TokenRing.RingColorBand;
+  /**
+   * @remarks Not initialized to a value, this gets set in {@link TokenRing.configureSize | `configureSize`}.
+   * After initialization (`ready`), this will only be `undefined` if the current spritesheet provides no frames
+   */
+  colorBand: TokenRing.RingData["colorBand"];
 
-  /** Reference to the token that should be animated */
-  get token(): MaybeInitialized<Token.ConfiguredInstance, "init">;
+  /**
+   * Reference to the token that should be animated
+   * @remarks This getter is the return of calling {@link WeakRef.deref | `deref`} on the stored {@link WeakRef | `WeakRef`}
+   * of the Token passed at construction; If the Token has been garbage collected, will return undefined.
+   */
+  get token(): Token.Implementation | undefined;
 
   /**
    * Configure the sprite mesh.
    * @param mesh  - The mesh to which TokenRing functionality is configured.
    */
-  configure(mesh?: PrimarySpriteMesh): void;
+  configure(mesh: PrimarySpriteMesh): void;
 
   /** Clear configuration pertaining to token ring from the mesh. */
   clear(): void;
@@ -129,16 +159,18 @@ declare class TokenRing {
 
   /**
    * Flash the ring briefly with a certain color.
-   * @param color             - Color to flash.
-   * @param animationOptions  - Options to customize the animation. @defaultValue `{}`
+   * @param color            - Color to flash.
+   * @param animationOptions - Options to customize the animation. (default: `{}`)
+   * @remarks Only returns `Promise<void>` if `color` is `NaN`ish
    */
-  flashColor(Color: Color, animationOptions: CanvasAnimationOptions): Promise<boolean | void>;
+  flashColor(Color: Color, animationOptions?: TokenRing.FlashColorOptions | null): Promise<boolean | void>;
 
   /**
    * Create an easing function that spikes in the center. Ideal duration is around 1600ms.
-   * @param spikePct  - Position on [0,1] where the spike occurs. @defaultValue `0.5`
+   * @param spikePct  - Position on [0,1] where the spike occurs. (default: `0.5`)
    */
-  static createSpikeEasing(spikePct?: number): (t: number) => number;
+  // spikePct: not null (used as divisor)
+  static createSpikeEasing(spikePct?: number): CanvasAnimation.EasingFunction;
 
   /**
    * Easing function that produces two peaks before returning to the original value. Ideal duration is around 500ms.
@@ -150,43 +182,106 @@ declare class TokenRing {
   /**
    * To avoid breaking dnd5e.
    * @deprecated since v12
+   * @remarks No deprecation warning or end of deprecation period provided, method body completely empty
    */
   configureMesh(): void;
 
   /**
    * To avoid breaking dnd5e.
    * @deprecated since v12
+   * @remarks No deprecation warning or end of deprecation period provided, method body completely empty
    */
   configureNames(): void;
 }
 
 declare namespace TokenRing {
-  type SampleShaderClass = CONFIG["Token"]["ring"]["shaderClass"];
+  interface Any extends AnyTokenRing {}
+  interface AnyConstructor extends Identity<typeof AnyTokenRing> {}
+
+  interface ConfiguredClass extends Identity<CONFIG["Token"]["ring"]["ringClass"]> {}
+  interface ConfiguredInstance extends FixedInstanceType<ConfiguredClass> {}
+
+  /** @remarks Overrides for default values */
+  interface FlashColorOptions extends CanvasAnimation.AnimateOptions {
+    /**
+     * @defaultValue `1600`
+     * @remarks Can't be `null` because it only has a parameter default, and is used as a divisor in `CanvasAnimation.#animateFrame`
+     */
+    duration?: number;
 
-  interface RingDataBySizeReturnType {
-    bkgName: string;
-    ringName: string;
-    colorBand: TokenRing.RingColorBand;
+    /** @defaultValue `PIXI.UPDATE_PRIORITY.HIGH` */
+    priority?: PIXI.UPDATE_PRIORITY | null | undefined;
+
+    /** @defaultValue `TokenRing.createSpikeEasing(0.15)` */
+    easing?: CanvasAnimation.EasingFunction | null | undefined;
+  }
+
+  interface TextureData {
+    UVs: Float32Array;
+    center: { x: number; y: number };
+  }
+
+  /**
+   * @remarks {@link TokenRing.configureSize | `configureSize`} effectively calls `Object.assign(this, RingData)`
+   */
+  interface RingData {
+    ringName: string | undefined;
+
+    bkgName: string | undefined;
+
+    colorBand: ColorBand | undefined;
+
+    /**
+     * @remarks This property comes from the spritesheet JSON and is included with the frame entries in the `##ringData`
+     * private array, but is stripped out of the return of {@link TokenRing.getRingDataBySize | `getRingDataBySize`},
+     * and thus never gets assigned as a property to the `TokenRing` instance in {@link TokenRing.configureSize | `configureSize`}
+     */
+    gridTarget?: number;
+
+    defaultRingColorLittleEndian: number | null;
+
+    defaultBackgroundColorLittleEndian: number | null;
+
+    subjectScaleAdjustment: number | null;
   }
 
   /** The start and end radii of the token ring color band. */
-  interface RingColorBand {
-    /** The starting normalized radius of the token ring color band. */
+  interface ColorBand {
+    /**
+     * The starting normalized radius of the token ring color band.
+     * @defaultValue `0.59`
+     * @remarks Default only applies if spritesheet frame omits `colorBand` entirely
+     */
     startRadius: number;
 
-    /** The ending normalized radius of the token ring color band. */
+    /**
+     * The ending normalized radius of the token ring color band.
+     * @defaultValue `0.7225`
+     * @remarks Default only applies if spritesheet frame omits `colorBand` entirely
+     */
     endRadius: number;
   }
 
-  interface Effects
-    extends Readonly<{
-      DISABLED: 0x00;
-      ENABLED: 0x01;
-      RING_PULSE: 0x02;
-      RING_GRADIENT: 0x04;
-      BKG_WAVE: 0x08;
-      INVISIBILITY: 0x10; // or spectral pulse effect
-    }> {}
+  type EFFECTS = Brand<number, "TokenRing.effects">;
+
+  interface Effects {
+    readonly DISABLED: 0x00 & EFFECTS;
+
+    readonly ENABLED: 0x01 & EFFECTS;
+
+    readonly RING_PULSE: 0x02 & EFFECTS;
+
+    readonly RING_GRADIENT: 0x04 & EFFECTS;
+
+    readonly BKG_WAVE: 0x08 & EFFECTS;
+
+    /** @remarks Foundry comments "or spectral pulse effect" */
+    readonly INVISIBILITY: 0x10 & EFFECTS;
+  }
+}
+
+declare abstract class AnyTokenRing extends TokenRing {
+  constructor(...args: never);
 }
 
 export default TokenRing;

package/src/foundry/client-esm/client.d.mts

@@ -3,15 +3,15 @@
 // While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
 /* eslint-disable import-x/extensions */
 
-import "../common/primitives/_module.mjs";
-import * as _CONST from "../common/constants.mjs";
-import * as _abstract from "../common/abstract/_module.mjs";
-import * as _documents from "../common/documents/_module.mjs";
-import * as _packages from "../common/packages/_module.mjs";
+import "#common/primitives/_module.mjs";
+import * as _CONST from "#common/constants.mjs";
+import * as _abstract from "#common/abstract/_module.mjs";
+import * as _documents from "#common/documents/_module.mjs";
+import * as _packages from "#common/packages/_module.mjs";
 // utils is exported here in the foundry file
-import * as _config from "../common/config.mjs";
-import * as _prosemirror from "../common/prosemirror/_module.mjs";
-import * as _grid from "../common/grid/_module.mjs";
+import * as _config from "#common/config.mjs";
+import * as _prosemirror from "#common/prosemirror/_module.mjs";
+import * as _grid from "#common/grid/_module.mjs";
 
 // client
 import * as _applications from "./applications/_module.mjs";
@@ -25,42 +25,42 @@ import * as _utils from "./utils/_module.mjs"; // moved here to match other clie
 /**
  * Constant definitions used throughout the Foundry Virtual Tabletop framework.
  */
-export * as CONST from "../common/constants.mjs";
+export * as CONST from "#common/constants.mjs";
 
 /**
  * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
  */
-export * as abstract from "../common/abstract/_module.mjs";
+export * as abstract from "#common/abstract/_module.mjs";
 
 /**
  * Application configuration options
  */
-export * as config from "../common/config.mjs";
+export * as config from "#common/config.mjs";
 
 /**
  * Document definitions used throughout the Foundry Virtual Tabletop framework.
  */
-export * as documents from "../common/documents/_module.mjs";
+export * as documents from "#common/documents/_module.mjs";
 
 /**
  * Package data definitions, validations, and schema.
  */
-export * as packages from "../common/packages/_module.mjs";
+export * as packages from "#common/packages/_module.mjs";
 
 /**
  * Utility functions providing helpful functionality.
  */
-export * as utils from "../common/utils/_module.mjs";
+export * as utils from "#common/utils/_module.mjs";
 
 /**
  * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
  */
-export * as prosemirror from "../common/prosemirror/_module.mjs";
+export * as prosemirror from "#common/prosemirror/_module.mjs";
 
 /**
  * Grid classes.
  */
-export * as grid from "../common/grid/_module.mjs";
+export * as grid from "#common/grid/_module.mjs";
 
 /**
  * A library for rendering and managing HTML user interface elements within the Foundry Virtual Tabletop game client.

package/src/foundry/client-esm/data/_module.d.mts

@@ -4,7 +4,7 @@
 /* eslint-disable import-x/extensions */
 
 // export * as types from "./_types.mjs";
-export * from "../../common/data/_module.mjs";
+export * from "#common/data/_module.mjs";
 export * as regionBehaviors from "./region-behaviors/_module.mjs";
 // export * as regionShapes from "./region-shapes/_module.mjs";
 export * from "./terrain-data.mjs";

package/src/foundry/client-esm/data/calendar.d.mts

@@ -1,28 +1,31 @@
-import type DataModel from "@common/abstract/data.d.mts";
-import type * as fields from "@common/data/fields.mjs";
+import type DataModel from "#common/abstract/data.d.mts";
+import type * as fields from "#common/data/fields.mjs";
 
 declare namespace CalendarData {
   interface Schema extends fields.DataSchema {
     /** The name of the calendar being used. */
     name: fields.StringField<{ required: true; blank: false }>;
+
     /** A text description of the calendar configuration. */
     description: fields.StringField;
+
     /** Configuration of years. */
     years: fields.SchemaField<ConfigYears.Schema, { required: true; nullable: true; initial: null }>;
+
     /** Configuration of months. */
     months: fields.SchemaField<ConfigMonths.Schema, { required: true; nullable: true; initial: null }>;
+
     /** Configuration of days. */
     days: fields.SchemaField<ConfigDays.Schema>;
+
     /** Configuration of seasons. */
     seasons: fields.SchemaField<ConfigSeasons.Schema, { required: true; nullable: true; initial: null }>;
   }
 
   /**
    * The data put in {@link CalendarData._source | `CalendarData._source`}.
-   *
-   * Both `Source` and `PersistedData` are equivalent.
    */
-  interface Source extends PersistedData {}
+  interface Source extends fields.SchemaField.SourceData<Schema> {}
 
   /**
    * The data necessary to create a document. Used in places like {@link WallDocument.create | `WallDocument.create`}
@@ -32,16 +35,8 @@ declare namespace CalendarData {
    * with the right values. This means you can pass a `Set` instance, an array of values,
    * a generator, or any other iterable.
    * @remarks Equivalent to how Foundry uses CalendarConfig, this is the type of `CONFIG.calendar`
-   * TODO: Replace with CreateData and convert to interface
-   */
-  type CreateData = fields.SchemaField.AssignmentType<Schema>;
-
-  /**
-   * The data put in {@link CalendarData._source | `CalendarData._source`}.
-   *
-   * Both `Source` and `PersistedData` are equivalent.
    */
-  interface PersistedData extends fields.SchemaField.PersistedType<Schema> {}
+  interface CreateData extends fields.SchemaField.CreateData<Schema> {}
 
   /**
    * The data after a {@link DataModel | `DataModel`} has been initialized, for example
@@ -51,7 +46,7 @@ declare namespace CalendarData {
    * convenient runtime data structures. For example a source value of `undefined` will be replaced
    * by the `initial` value of the field instance.
    */
-  interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+  interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
   /** A definition of a year within a calendar. */
   namespace ConfigYears {
@@ -64,10 +59,9 @@ declare namespace CalendarData {
       leapYear: fields.SchemaField<ConfigLeapYear.Schema, { required: true; nullable: true; initial: null }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** A definition of how leap years work within a calendar. */
@@ -79,10 +73,9 @@ declare namespace CalendarData {
       leapInterval: fields.NumberField<{ required: true; nullable: false; min: 1; integer: true }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** Month related configuration for a calendar. */
@@ -92,10 +85,9 @@ declare namespace CalendarData {
       values: fields.ArrayField<fields.SchemaField<ConfigMonth.Schema>>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** A definition of a month within a calendar year. */
@@ -122,10 +114,9 @@ declare namespace CalendarData {
       startingWeekday: fields.NumberField<{ required: false; nullable: true }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** Day related configuration for a calendar. */
@@ -141,10 +132,9 @@ declare namespace CalendarData {
       secondsPerMinute: fields.NumberField<{ required: true; nullable: false; positive: true }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** A definition of the days of the week within a calendar. */
@@ -160,10 +150,9 @@ declare namespace CalendarData {
       isRestDay: fields.BooleanField<{ required: false; nullable: false; initial: false }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** Season related configuration for a calendar. */
@@ -173,10 +162,9 @@ declare namespace CalendarData {
       values: fields.ArrayField<fields.SchemaField<ConfigSeason.Schema>>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 
   /** A definition of a season within a calendar year. */
@@ -196,10 +184,9 @@ declare namespace CalendarData {
       endDay: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
     }
 
-    interface InitializedData extends fields.SchemaField.InitializedType<Schema> {}
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
 
-    // TODO: Replace with CreateData and convert to interface
-    type CreateData = fields.SchemaField.AssignmentType<Schema>;
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
   }
 }
 

package/src/foundry/client-esm/data/client-backend.d.mts

@@ -1,11 +1,11 @@
 import type { FixedInstanceType, LoggingLevels } from "fvtt-types/utils";
-import type Document from "@common/abstract/document.d.mts";
+import type Document from "#common/abstract/document.d.mts";
 import type {
   DatabaseGetOperation,
   DatabaseCreateOperation,
   DatabaseUpdateOperation,
   DatabaseDeleteOperation,
-} from "@common/abstract/_types.d.mts";
+} from "#common/abstract/_types.d.mts";
 
 /**
  * The client-side database backend implementation which handles Document modification operations.
@@ -14,25 +14,25 @@ declare class ClientDatabaseBackend extends foundry.abstract.DatabaseBackend {
   protected override _getDocuments<T extends Document.AnyConstructor>(
     documentClass: T,
     request: DatabaseGetOperation,
-    user: User.ConfiguredInstance,
+    user: User.Implementation,
   ): Promise<FixedInstanceType<T>[]>;
 
   protected override _createDocuments<T extends Document.AnyConstructor>(
     documentClass: T,
     request: DatabaseCreateOperation<FixedInstanceType<T>>,
-    user: User.ConfiguredInstance,
+    user: User.Implementation,
   ): Promise<FixedInstanceType<T>[]>;
 
   protected override _updateDocuments<T extends Document.AnyConstructor>(
     documentClass: T,
     request: DatabaseUpdateOperation<FixedInstanceType<T>>,
-    user: User.ConfiguredInstance,
+    user: User.Implementation,
   ): Promise<FixedInstanceType<T>[]>;
 
   protected override _deleteDocuments<T extends Document.AnyConstructor>(
     documentClass: T,
     request: DatabaseDeleteOperation,
-    user: User.ConfiguredInstance,
+    user: User.Implementation,
   ): Promise<FixedInstanceType<T>[]>;
 
   /**

package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts

@@ -1,7 +1,7 @@
 import type RegionBehaviorType from "./base.d.mts";
 import type { Brand } from "fvtt-types/utils";
 import fields = foundry.data.fields;
-import type { InvertObject } from "@common/utils/helpers.d.mts";
+import type { InvertObject } from "#common/utils/helpers.d.mts";
 
 declare namespace AdjustDarknessLevelRegionBehaviorType {
   type MODES = Brand<number, "AdjustDarknessLevelRegionBehaviorType.MODES">;

package/src/foundry/client-esm/data/region-behaviors/base.d.mts

@@ -1,4 +1,4 @@
-import type TypeDataModel from "@common/abstract/type-data.d.mts";
+import type TypeDataModel from "#common/abstract/type-data.d.mts";
 import type { AnyObject, EmptyObject } from "fvtt-types/utils";
 
 import fields = foundry.data.fields;
@@ -15,7 +15,7 @@ declare namespace RegionBehaviorType {
 /** The data model for a behavior that receives Region events. */
 declare class RegionBehaviorType<
   Schema extends foundry.data.fields.DataSchema,
-  Parent extends RegionBehavior.ConfiguredInstance = RegionBehavior.ConfiguredInstance,
+  Parent extends RegionBehavior.Implementation = RegionBehavior.Implementation,
   BaseData extends AnyObject = EmptyObject,
   DerivedData extends AnyObject = EmptyObject,
 > extends TypeDataModel<Schema, Parent, BaseData, DerivedData> {
@@ -40,13 +40,13 @@ declare class RegionBehaviorType<
   events: Set<string>;
 
   /** A convenience reference to the RegionBehavior which contains this behavior sub-type */
-  get behavior(): RegionBehavior.ConfiguredInstance | null;
+  get behavior(): RegionBehavior.Implementation | null;
 
   /** A convenience reference to the RegionDocument which contains this behavior sub-type.*/
-  get region(): RegionDocument.ConfiguredInstance | null;
+  get region(): RegionDocument.Implementation | null;
 
   /** A convenience reference to the Scene which contains this behavior sub-type. */
-  get scene(): Scene.ConfiguredInstance | null;
+  get scene(): Scene.Implementation | null;
 
   /**
    * Handle the Region event.

package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts

@@ -1,7 +1,7 @@
 import type RegionBehaviorType from "./base.d.mts";
 import type { Brand } from "fvtt-types/utils";
 import fields = foundry.data.fields;
-import type { InvertObject } from "@common/utils/helpers.d.mts";
+import type { InvertObject } from "#common/utils/helpers.d.mts";
 
 declare namespace DisplayScrollingTextRegionBehaviorType {
   type VISIBILITY_MODES = Brand<number, "DisplayScrollingTextRegionBehaviorType.VISIBILITY_MODES">;
@@ -33,7 +33,7 @@ declare namespace DisplayScrollingTextRegionBehaviorType {
     /** Optional color setting for the text */
     color: fields.ColorField<{ required: true; nullable: false; initial: string }>;
 
-    /** Which users the scrolling text will display for (see {@link VISIBILITY_MODES}) */
+    /** Which users the scrolling text will display for (see {@link VISIBILITY_MODES | `VISIBILITY_MODES`}) */
     visibility: fields.NumberField<{
       required: true;
       choices: InvertObject<VisibilityModes>;