@league-of-foundry-developers/foundry-vtt-types 12.331.4-beta → 12.331.5

package/src/foundry/client/data/collections/macros.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/messages.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/playlists.d.mts

@@ -1,4 +1,4 @@
-import type { DeepPartial, Identity } from "fvtt-types/utils";
+import type { DeepPartial, Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/scenes.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/settings.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/tables.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {

package/src/foundry/client/data/collections/users.d.mts

@@ -1,4 +1,4 @@
-import type { Identity, InexactPartial } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 
 declare global {
@@ -42,10 +42,10 @@ declare global {
     /**
      * Handle receipt of activity data from another User connected to the Game session
      * @param userId       - The User id who generated the activity data
-     * @param activityData - The object of activity data
-     *                       (default: `{}`)
+     * @param activityData - The object of activity data (default: `{}`)
      */
-    protected static _handleUserActivity(userId: string, activityData?: InexactPartial<User.ActivityData>): void;
+    // activityData: not null (parameter default only)
+    protected static _handleUserActivity(userId: string, activityData?: User.ActivityData): void;
   }
 
   namespace Users {

package/src/foundry/client/data/documents/active-effect.d.mts

@@ -1,5 +1,13 @@
 import type { ConfiguredActiveEffect } from "../../../../configuration/index.d.mts";
-import type { AnyObject, InterfaceToObject, Merge } from "fvtt-types/utils";
+import type {
+  AnyMutableObject,
+  AnyObject,
+  IntentionalPartial,
+  InterfaceToObject,
+  JSONValue,
+  Merge,
+  RequiredProps,
+} from "#utils";
 import type { DataModel } from "../../../common/abstract/data.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataField, DataSchema } from "../../../common/data/fields.d.mts";
@@ -151,7 +159,7 @@ declare global {
     type Collection = never;
 
     /**
-     * An instance of `ActiveEffect` that comes from the database but failed validation meaining that
+     * An instance of `ActiveEffect` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid<out SubType extends ActiveEffect.SubType = ActiveEffect.SubType>
@@ -225,13 +233,15 @@ declare global {
        * The name of the ActiveEffect
        * @defaultValue `""`
        */
-      name: fields.StringField<{ required: true; label: "EFFECT.Label" }>;
+      // TODO(LukeAbby): fix this when redoing DataField
+      // FIXME: This field is `required` with no `initial`, so actually required for construction; Currently an AssignmentType override is required to enforce this
+      name: fields.StringField<{ required: true; blank: false; label: "EFFECT.Name"; textSearch: true }, string>;
 
       /**
        * An image path used to depict the ActiveEffect as an icon
        * @defaultValue `null`
        */
-      img: fields.FilePathField<{ categories: "IMAGE"[]; label: "EFFECT.Image" }>;
+      img: fields.FilePathField<{ categories: ["IMAGE"]; label: "EFFECT.Image" }>;
 
       type: fields.DocumentTypeField<typeof BaseActiveEffect, { initial: typeof foundry.CONST.BASE_DOCUMENT_TYPE }>;
 
@@ -259,11 +269,18 @@ declare global {
            * The modification mode with which the change is applied
            * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
            */
-          mode: fields.NumberField<{
-            integer: true;
-            initial: typeof CONST.ACTIVE_EFFECT_MODES.ADD;
-            label: "EFFECT.ChangeMode";
-          }>;
+          mode: fields.NumberField<
+            {
+              integer: true;
+              initial: typeof CONST.ACTIVE_EFFECT_MODES.ADD;
+              label: "EFFECT.ChangeMode";
+            },
+            // TODO: (LukeAbby): fix this when redoing DataField
+            // FIXME: Overrides required to enforce the branded type
+            CONST.ACTIVE_EFFECT_MODES | null | undefined,
+            CONST.ACTIVE_EFFECT_MODES,
+            CONST.ACTIVE_EFFECT_MODES
+          >;
 
           /**
            * The priority level with which this change is applied
@@ -533,10 +550,12 @@ declare global {
       startTurn?: number | null | undefined;
     }
 
+    type DurationType = "seconds" | "turns" | "none";
+
     // Must be kept in sync with
     interface Duration extends DurationData {
       /** The duration type, either "seconds", "turns", or "none" */
-      type: "seconds" | "turns" | "none";
+      type: DurationType;
 
       /** The total effect duration, in seconds of world time or as a decimal number with the format \{rounds\}.\{turns\} */
       duration: number;
@@ -554,6 +573,23 @@ declare global {
       _combatTime?: number;
     }
 
+    interface PrepareDurationReturn extends RequiredProps<IntentionalPartial<Duration>, "type"> {}
+
+    interface InitialDurationData {
+      /** @defaultValue `game.time.worldTime` */
+      startTime: number;
+
+      /** @remarks Only exists `if (game.combat)` */
+      startRound?: number;
+
+      /** @remarks Only exists `if (game.combat)` */
+      startTurn?: number;
+    }
+
+    interface GetInitialDurationReturn {
+      duration: InitialDurationData;
+    }
+
     interface EffectChangeData {
       /**
        * The attribute path in the Actor or Item data which the change modifies
@@ -574,7 +610,7 @@ declare global {
        * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
        * @privateRemarks `undefined` is not actually a possible value, included here due to fvtt-types handling of `initial` values
        */
-      mode: number | null | undefined;
+      mode: CONST.ACTIVE_EFFECT_MODES | null | undefined;
 
       /**
        * The priority level with which this change is applied
@@ -584,6 +620,10 @@ declare global {
       priority: number | null | undefined;
     }
 
+    type ApplyFieldReturn<Field extends DataField.Any | null | undefined> = Field extends DataField.Any
+      ? DataField.InitializedTypeFor<Field>
+      : unknown;
+
     /**
      * @deprecated {@link ActiveEffect.Database | `ActiveEffect.DatabaseOperation`}
      */
@@ -646,9 +686,10 @@ declare global {
      * @throws An error if there is no status effect in `CONFIG.statusEffects` with the given status ID and if
      * the status has implicit statuses but doesn't have a static _id.
      */
+    // options: not null (parameter default only)
     static fromStatusEffect(
       statusId: string,
-      options?: Document.ConstructionContext<Document.Any | null>,
+      options?: Document.ConstructionContext<ActiveEffect.Parent>,
     ): Promise<ActiveEffect.Implementation>;
 
     /**
@@ -658,16 +699,19 @@ declare global {
      * @param effectData - The status effect data.
      * @param options    - Additional options to pass to the ActiveEffect constructor.
      * @returns The created ActiveEffect instance.
+     *
+     * @remarks Core's implementation doesn't use `statusId`, simply returning `new this(effectData, options)`
      */
+    // options: not null (destructured where forwarded)
     protected static _fromStatusEffect(
       statusId: string,
       effectData: ActiveEffect.CreateData,
-      options?: Document.ConstructionContext<Document.Any | null>,
+      options?: Document.ConstructionContext<ActiveEffect.Parent>,
     ): Promise<ActiveEffect.Implementation>;
 
     /**
      * Is there some system logic that makes this active effect ineligible for application?
-     * @defaultValue `false`
+     * @remarks Core's implementation always returns `false`
      */
     get isSuppressed(): boolean;
 
@@ -686,14 +730,15 @@ declare global {
      */
     get modifiesActor(): boolean;
 
-    prepareBaseData(): void;
+    override prepareBaseData(): void;
 
-    prepareDerivedData(): void;
+    override prepareDerivedData(): void;
 
     /**
      * Update derived Active Effect duration data.
      * Configure the remaining and label properties to be getters which lazily recompute only when necessary.
      */
+    // TODO: This adds two getter properties (`remaining` and `label`) to `this.duration` (a SchemaField property on the document)
     updateDuration(): ActiveEffect.Duration;
 
     /**
@@ -703,7 +748,8 @@ declare global {
      */
     protected _requiresDurationUpdate(): boolean;
 
-    protected _prepareDuration(): Omit<ActiveEffect.Duration, keyof ActiveEffect.DurationData>;
+    /** @internal */
+    protected _prepareDuration(): ActiveEffect.PrepareDurationReturn;
 
     /**
      * Format a round+turn combination as a decimal
@@ -711,7 +757,9 @@ declare global {
      * @param turn   - The turn number
      * @param nTurns - The maximum number of turns in the encounter
      * @returns The decimal representation
+     * @private
      */
+    // nTurns: not null (`!== undefined` check)
     protected _getCombatTime(round: number, turn: number, nTurns?: number): number;
 
     /**
@@ -719,6 +767,7 @@ declare global {
      * @param rounds - The number of rounds
      * @param turns  - The number of turns
      * @returns The formatted label
+     * @private
      */
     protected _getDurationLabel(rounds: number, turns: number): string;
 
@@ -740,8 +789,14 @@ declare global {
      * @param change - The change to apply.
      * @param field  - The field. If not supplied, it will be retrieved from the supplied model.
      * @returns The updated value.
+     *
+     * @remarks `field` default provided by `??= model.schema.getField(change.key)`
      */
-    static applyField(model: DataModel.Any, change: ActiveEffect.EffectChangeData, field?: DataField.Any): unknown;
+    static applyField<Field extends DataField.Any | null | undefined = undefined>(
+      model: DataModel.Any,
+      change: ActiveEffect.EffectChangeData,
+      field?: Field,
+    ): ActiveEffect.ApplyFieldReturn<Field>;
 
     /**
      * Apply this ActiveEffect to a provided Actor.
@@ -749,9 +804,9 @@ declare global {
      * TODO: When we revisit this in Active Effects V2 this should become an Actor method, or a static method
      * @param actor  - The Actor to whom this effect should be applied
      * @param change - The change data being applied
-     * @returns The resulting applied value
+     * @returns An object of property paths and their updated values.
      */
-    apply(actor: Actor.Implementation, change: ActiveEffect.EffectChangeData): unknown;
+    apply(actor: Actor.Implementation, change: ActiveEffect.EffectChangeData): AnyMutableObject;
 
     /**
      * Apply this ActiveEffect to a provided Actor using a heuristic to infer the value types based on the current value
@@ -760,15 +815,21 @@ declare global {
      * @param change  - The change data being applied.
      * @param changes - The aggregate update paths and their updated values.
      */
-    protected _applyLegacy(actor: Actor.Implementation, change: ActiveEffect.DurationData, changes: AnyObject): void;
+    protected _applyLegacy(
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      changes: AnyMutableObject,
+    ): void;
 
     /**
      * Cast a raw ActiveEffect.EffectChangeData change string to the desired data type.
      * @param raw - The raw string value
      * @param type - The target data type that the raw value should be cast to match
      * @returns The parsed delta cast to the target data type
+     * @private
+     * @remarks Core's implementation returns `boolean | number | string` or the return of {@link ActiveEffect._parseOrString | `ActiveEffect#_parseOrString`}
      */
-    protected _castDelta(raw: string, type: string): boolean | number | string | object;
+    protected _castDelta(raw: string, type: string): JSONValue;
 
     /**
      * Cast a raw ActiveEffect.EffectChangeData change string to an Array of an inner type.
@@ -776,14 +837,15 @@ declare global {
      * @param type - The target data type of inner array elements
      * @returns The parsed delta cast as a typed array
      */
-    protected _castArray(raw: string, type: string): Array<boolean | string | number | object>;
+    protected _castArray(raw: string, type: string): JSONValue[];
 
     /**
      * Parse serialized JSON, or retain the raw string.
      * @param raw - A raw serialized string
      * @returns The parsed value, or the original value if parsing failed
+     * @remarks Tries to `JSON.parse(raw)`, simply returns `raw` if error
      */
-    protected _parseOrString(raw: string): string | object;
+    protected _parseOrString(raw: string): JSONValue;
 
     /**
      * Apply an ActiveEffect that uses an ADD application mode.
@@ -800,13 +862,15 @@ declare global {
      * @param delta   - The parsed value of the change object
      * @param changes - An object which accumulates changes to be applied
      * @returns The resulting applied value
+     * @private
+     * @remarks Core's implementation does not use `actor`
      */
     protected _applyAdd(
       actor: Actor.Implementation,
       change: ActiveEffect.EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      current: unknown,
+      delta: unknown,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -818,13 +882,15 @@ declare global {
      * @param delta   - The parsed value of the change object
      * @param changes - An object which accumulates changes to be applied
      * @returns The resulting applied value
+     * @private
+     * @remarks Core's implementation does not use `actor`
      */
     protected _applyMultiply(
       actor: Actor.Implementation,
       change: ActiveEffect.EffectChangeData,
       current: unknown,
       delta: unknown,
-      changes: AnyObject,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -836,13 +902,15 @@ declare global {
      * @param delta   - The parsed value of the change object
      * @param changes - An object which accumulates changes to be applied
      * @returns The resulting applied value
+     * @private
+     * @remarks Core's implementation does not use `actor` or `current`
      */
     protected _applyOverride(
       actor: Actor.Implementation,
       change: ActiveEffect.EffectChangeData,
       current: unknown,
       delta: unknown,
-      changes: AnyObject,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -854,13 +922,15 @@ declare global {
      * @param delta   - The parsed value of the change object
      * @param changes - An object which accumulates changes to be applied
      * @returns The resulting applied value
+     * @private
+     * @remarks Core's implementation does not use `actor`
      */
     protected _applyUpgrade(
       actor: Actor.Implementation,
       change: ActiveEffect.EffectChangeData,
       current: unknown,
       delta: unknown,
-      changes: AnyObject,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -871,32 +941,33 @@ declare global {
      * @param delta   - The parsed value of the change object
      * @param changes - An object which accumulates changes to be applied
      * @returns The resulting applied value
+     * @private
      */
     protected _applyCustom(
       actor: Actor.Implementation,
       change: ActiveEffect.EffectChangeData,
       current: unknown,
       delta: unknown,
-      changes: AnyObject,
+      changes: AnyMutableObject,
     ): void;
 
     /**
      * Retrieve the initial duration configuration.
      */
-    static getInitialDuration(): {
-      duration: {
-        startTime: number;
-        startRound?: number | undefined;
-        startTurn?: number | undefined;
-      };
-    };
-
-    // TODO: This is a minor override and doing the extension is complicated
-    // getFlag(scope: string, key: string): unknown;
+    static getInitialDuration(): ActiveEffect.GetInitialDurationReturn;
 
     /**
-     * @privateRemarks _preCreate, _onCreate, _onUpdate, _preUpdate, and _onDelete are all overridden but with no signature changes from BaseActiveEffect.
+     * @remarks If attempting to set `core.statusId`, logs a compatibility warning:
+     *
+     * "You are setting flags.core.statusId on an Active Effect. This flag is deprecated
+     * in favor of the {@link ActiveEffect.statuses | `statuses`} set."
      */
+    override getFlag<Scope extends ActiveEffect.Flags.Scope, Key extends ActiveEffect.Flags.Key<Scope>>(
+      scope: Scope,
+      key: Key,
+    ): Document.GetFlag<ActiveEffect.Name, Scope, Key>;
+
+    // _preCreate, _onCreate, _preUpdate, _onUpdate, and _onDelete are all overridden but with no signature changes from BaseActiveEffect.
 
     /**
      * Display changes to active effects as scrolling Token status text.
@@ -907,7 +978,7 @@ declare global {
     /**
      * Get the name of the source of the Active Effect
      * @deprecated since v11, will be removed in v13
-     * @remarks `"You are accessing ActiveEffect._getSourceName which is deprecated."`
+     * @remarks "You are accessing `ActiveEffect._getSourceName` which is deprecated."
      */
     _getSourceName(): Promise<string>;
 
@@ -925,24 +996,29 @@ declare global {
 
     // Descendant Document operations have been left out because ActiveEffect does not have any descendant documents.
 
+    // context: not null (destructured)
     static override defaultName(
-      context: Document.DefaultNameContext<ActiveEffect.SubType, NonNullable<ActiveEffect.Parent>>,
+      context?: Document.DefaultNameContext<"ActiveEffect", NonNullable<ActiveEffect.Parent>>,
     ): string;
 
+    /** @remarks `context.parent` is required as creation requires one */
     static override createDialog(
-      data: Document.CreateDialogData<ActiveEffect.CreateData>,
-      context: Document.CreateDialogContext<ActiveEffect.SubType, NonNullable<ActiveEffect.Parent>>,
+      data: Document.CreateDialogData<ActiveEffect.CreateData> | undefined,
+      context: Document.CreateDialogContext<"ActiveEffect", NonNullable<ActiveEffect.Parent>>,
     ): Promise<ActiveEffect.Stored | null | undefined>;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<ActiveEffect.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<ActiveEffect.Implementation | undefined>;
 
     static override fromImport(
       source: ActiveEffect.Source,
-      context?: Document.FromImportContext<ActiveEffect.Parent>,
+      context?: Document.FromImportContext<ActiveEffect.Parent> | null,
     ): Promise<ActiveEffect.Implementation>;
+
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
   }
 
   /**