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

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

@@ -1,32 +1,660 @@
-import type { AnyObject } from "../../../../types/utils.d.mts";
+import type { ConfiguredActiveEffect } from "../../../../configuration/index.d.mts";
+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 { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
-import type { DataField } from "../../../common/data/fields.d.mts";
-import type { ActiveEffectData, EffectChangeData, EffectDurationData } from "../../../common/documents/_types.d.mts";
+import type { DataField, DataSchema } from "../../../common/data/fields.d.mts";
+import type { fields } from "../../../common/data/module.d.mts";
 import type BaseActiveEffect from "../../../common/documents/active-effect.d.mts";
 
 declare global {
   namespace ActiveEffect {
-    type Metadata = Document.MetadataFor<ActiveEffect>;
+    /**
+     * The document's name.
+     */
+    type Name = "ActiveEffect";
+
+    /**
+     * The arguments to construct the document.
+     */
+    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
+
+    /**
+     * The documents embedded within `ActiveEffect`.
+     */
+    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
+
+    /**
+     * The implementation of the `ActiveEffect` document instance configured through `CONFIG.ActiveEffect.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredActiveEffect | `fvtt-types/configuration/ConfiguredActiveEffect`} in fvtt-types.
+     */
+    type Implementation = Document.ImplementationFor<Name>;
+
+    /**
+     * The implementation of the `ActiveEffect` document configured through `CONFIG.ActiveEffect.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
+     */
+    type ImplementationClass = Document.ImplementationClassFor<Name>;
+
+    /**
+     * A document's metadata is special information about the document ranging anywhere from its name,
+     * whether it's indexed, or to the permissions a user has over it.
+     */
+    interface Metadata
+      extends Merge<
+        Document.Metadata.Default,
+        Readonly<{
+          name: "ActiveEffect";
+          collection: "effects";
+          hasTypeData: true;
+          label: string;
+          labelPlural: string;
+          schemaVersion: string;
+        }>
+      > {}
+
+    // No need for Metadata namespace
+
+    /**
+     * Allowed subtypes of `ActiveEffect`. This is configured through various methods. Modern Foundry
+     * recommends registering using [Data Models](https://foundryvtt.com/article/system-data-models/)
+     * under {@link CONFIG.ActiveEffect.dataModels | `CONFIG.ActiveEffect.dataModels`}. This corresponds to
+     * fvtt-type's {@link DataModelConfig | `DataModelConfig`}.
+     *
+     * Subtypes can also be registered through a `template.json` though this is discouraged.
+     * The corresponding fvtt-type configs are {@link SourceConfig | `SourceConfig`} and
+     * {@link DataConfig | `DataConfig`}.
+     */
+    type SubType = Game.Model.TypeNames<"ActiveEffect">;
+
+    /**
+     * `ConfiguredSubTypes` represents the subtypes a user explicitly registered. This excludes
+     * subtypes like the Foundry builtin subtype `"base"` and the catch-all subtype for arbitrary
+     * module subtypes `${string}.${string}`.
+     *
+     * @see {@link SubType} for more information.
+     */
+    type ConfiguredSubTypes = Document.ConfiguredSubTypesOf<"ActiveEffect">;
+
+    /**
+     * `Known` represents the types of `ActiveEffect` that a user explicitly registered.
+     *
+     * @see {@link ConfiguredSubTypes} for more information.
+     */
+    type Known = ActiveEffect.OfType<ActiveEffect.ConfiguredSubTypes>;
+
+    /**
+     * `OfType` returns an instance of `ActiveEffect` with the corresponding type. This works with both the
+     * builtin `ActiveEffect` class or a custom subclass if that is set up in
+     * {@link ConfiguredActiveEffect | `fvtt-types/configuration/ConfiguredActiveEffect`}.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-restricted-types
+    type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredActiveEffect<Type>, ActiveEffect<Type>>;
+
+    /**
+     * `SystemOfType` returns the system property for a specific `ActiveEffect` subtype.
+     */
+    type SystemOfType<Type extends SubType> = Document.Internal.SystemOfType<_SystemMap, Type>;
+
+    /**
+     * @internal
+     */
+    interface _SystemMap extends Document.Internal.SystemMap<"ActiveEffect"> {}
+
+    /**
+     * A document's parent is something that can contain it.
+     * For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
+     */
+    type Parent = Actor.Implementation | Item.Implementation | null;
+
+    /**
+     * A document's descendants are any child documents, grandchild documents, etc.
+     * This is a union of all instances, or never if the document doesn't have any descendants.
+     */
+    type Descendant = never;
+
+    /**
+     * A document's descendants are any child documents, grandchild documents, etc.
+     * This is a union of all classes, or never if the document doesn't have any descendants.
+     */
+    type DescendantClass = never;
+
+    /**
+     * Types of `CompendiumCollection` this document might be contained in.
+     * Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
+     */
+    // Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
+    type Pack = CompendiumCollection.ForDocument<"Actor" | "Item">;
+
+    /**
+     * An embedded document is a document contained in another.
+     * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
+     *
+     * If this is `never` it is because there are no embeddable documents (or there's a bug!).
+     */
+    type Embedded = never;
+
+    /**
+     * The name of the world or embedded collection this document can find itself in.
+     * For example an `Item` is always going to be inside a collection with a key of `items`.
+     * This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
+     */
+    type ParentCollectionName = Metadata["collection"];
+
+    /**
+     * The world collection that contains this document type. Will be `never` if none exists.
+     */
+    type CollectionClass = never;
+
+    /**
+     * The world collection that contains this document type. Will be `never` if none exists.
+     */
+    type Collection = never;
+
+    /**
+     * 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>
+      extends Document.Invalid<OfType<SubType>> {}
+
+    /**
+     * An instance of `ActiveEffect` that comes from the database.
+     */
+    interface Stored<out SubType extends ActiveEffect.SubType = ActiveEffect.SubType>
+      extends Document.Stored<OfType<SubType>> {}
+
+    /**
+     * The data put in {@link ActiveEffect._source | `ActiveEffect#_source`}. This data is what was
+     * persisted to the database and therefore it must be valid JSON.
+     *
+     * For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
+     * but initialized as a {@link Set | `Set`}.
+     */
+    interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+    /**
+     * @deprecated {@link ActiveEffect.Source | `ActiveEffect.Source`}
+     */
+    type PersistedData = Source;
+
+    /**
+     * The data necessary to create a document. Used in places like {@link ActiveEffect.create | `ActiveEffect.create`}
+     * and {@link ActiveEffect | `new ActiveEffect(...)`}.
+     *
+     * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
+     * with the right values. This means you can pass a `Set` instance, an array of values,
+     * a generator, or any other iterable.
+     */
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+
+    /**
+     * The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
+     * {@link ActiveEffect.name | `ActiveEffect#name`}.
+     *
+     * This is data transformed from {@link ActiveEffect.Source | `ActiveEffect.Source`} and turned into more
+     * convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
+     * persisted to the database as an array of values but at runtime it is a `Set` instance.
+     */
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    /**
+     * The data used to update a document, for example {@link ActiveEffect.update | `ActiveEffect#update`}.
+     * It is a distinct type from {@link ActiveEffect.CreateData | `DeepPartial<ActiveEffect.CreateData>`} because
+     * it has different rules for `null` and `undefined`.
+     */
+    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+    /**
+     * The schema for {@link ActiveEffect | `ActiveEffect`}. This is the source of truth for how an ActiveEffect document
+     * must be structured.
+     *
+     * Foundry uses this schema to validate the structure of the {@link ActiveEffect | `ActiveEffect`}. For example
+     * a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
+     * complex fields like {@link fields.SetField | `SetField`} goes through various conversions
+     * starting as an array in the database, initialized as a set, and allows updates with any
+     * iterable.
+     */
+    interface Schema extends DataSchema {
+      /**
+       * The _id which uniquely identifies the ActiveEffect within a parent Actor or Item
+       * @defaultValue `null`
+       */
+      _id: fields.DocumentIdField;
+
+      /**
+       * The name of the ActiveEffect
+       * @defaultValue `""`
+       */
+      // 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" }>;
+
+      type: fields.DocumentTypeField<typeof BaseActiveEffect, { initial: typeof foundry.CONST.BASE_DOCUMENT_TYPE }>;
+
+      system: fields.TypeDataField<typeof BaseActiveEffect>;
+
+      /**
+       * The array of EffectChangeData objects which the ActiveEffect applies
+       * @defaultValue `[]`
+       */
+      changes: fields.ArrayField<
+        fields.SchemaField<{
+          /**
+           * The attribute path in the Actor or Item data which the change modifies
+           * @defaultValue `""`
+           */
+          key: fields.StringField<{ required: true; label: "EFFECT.ChangeKey" }>;
+
+          /**
+           * The value of the change effect
+           * @defaultValue `""`
+           */
+          value: fields.StringField<{ required: true; label: "EFFECT.ChangeValue" }>;
+
+          /**
+           * 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";
+            },
+            // 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
+           * @defaultValue `null`
+           */
+          priority: fields.NumberField;
+        }>
+      >;
+
+      /**
+       * Is this ActiveEffect currently disabled?
+       * @defaultValue `false`
+       */
+      disabled: fields.BooleanField;
+
+      /**
+       * An ActiveEffect.DurationData object which describes the duration of the ActiveEffect
+       * @defaultValue see properties
+       */
+      duration: fields.SchemaField<{
+        /**
+         * The world time when the active effect first started
+         * @defaultValue `null`
+         */
+        startTime: fields.NumberField<{ initial: null; label: "EFFECT.StartTime" }>;
+
+        /**
+         * The maximum duration of the effect, in seconds
+         * @defaultValue `null`
+         */
+        seconds: fields.NumberField<{ integer: true; min: 0; label: "EFFECT.DurationSecs" }>;
+
+        /**
+         * The _id of the CombatEncounter in which the effect first started
+         * @defaultValue `null`
+         */
+        combat: fields.ForeignDocumentField<typeof foundry.documents.BaseCombat, { label: "EFFECT.Combat" }>;
+
+        /**
+         * The maximum duration of the effect, in combat rounds
+         * @defaultValue `null`
+         */
+        rounds: fields.NumberField<{ integer: true; min: 0 }>;
+
+        /**
+         * The maximum duration of the effect, in combat turns
+         * @defaultValue `null`
+         */
+        turns: fields.NumberField<{ integer: true; min: 0; label: "EFFECT.DurationTurns" }>;
+
+        /**
+         * The round of the CombatEncounter in which the effect first started
+         * @defaultValue `null`
+         */
+        startRound: fields.NumberField<{ integer: true; min: 0 }>;
+
+        /**
+         * The turn of the CombatEncounter in which the effect first started
+         * @defaultValue `null`
+         */
+        startTurn: fields.NumberField<{ integer: true; min: 0; label: "EFFECT.StartTurns" }>;
+      }>;
+
+      /**
+       * The HTML text description for this ActiveEffect document.
+       * @defaultValue `""`
+       */
+      description: fields.HTMLField<{ label: "EFFECT.Description"; textSearch: true }>;
 
-    type ConfiguredClass = Document.ConfiguredClassForName<"ActiveEffect">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"ActiveEffect">;
+      /**
+       * A UUID reference to the document from which this ActiveEffect originated
+       * @defaultValue `null`
+       */
+      origin: fields.StringField<{ nullable: true; blank: false; initial: null; label: "EFFECT.Origin" }>;
 
+      /**
+       * A color string which applies a tint to the ActiveEffect icon
+       * @defaultValue `"#ffffff"`
+       */
+      tint: fields.ColorField<{ nullable: false; initial: "#ffffff"; label: "EFFECT.IconTint" }>;
+
+      /**
+       * Does this ActiveEffect automatically transfer from an Item to an Actor?
+       * @defaultValue `false`
+       */
+      transfer: fields.BooleanField<{ initial: true; label: "EFFECT.Transfer" }>;
+
+      /**
+       * Special status IDs that pertain to this effect
+       * @defaultValue `[]`
+       */
+      statuses: fields.SetField<fields.StringField<{ required: true; blank: false }>>;
+
+      sort: fields.IntegerSortField;
+
+      /**
+       * An object of optional key/value flags
+       * @defaultValue `{}`
+       */
+      flags: fields.ObjectField.FlagsField<Name, InterfaceToObject<CoreFlags>>;
+
+      _stats: fields.DocumentStatsField;
+    }
+
+    namespace Database {
+      /** Options passed along in Get operations for ActiveEffects */
+      interface Get extends foundry.abstract.types.DatabaseGetOperation<ActiveEffect.Parent> {}
+
+      /** Options passed along in Create operations for ActiveEffects */
+      interface Create<Temporary extends boolean | undefined = boolean | undefined>
+        extends foundry.abstract.types.DatabaseCreateOperation<
+          ActiveEffect.CreateData,
+          ActiveEffect.Parent,
+          Temporary
+        > {
+        animate?: boolean;
+      }
+
+      /** Options passed along in Delete operations for ActiveEffects */
+      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<ActiveEffect.Parent> {
+        animate?: boolean;
+      }
+
+      /** Options passed along in Update operations for ActiveEffects */
+      interface Update
+        extends foundry.abstract.types.DatabaseUpdateOperation<ActiveEffect.UpdateData, ActiveEffect.Parent> {
+        animate?: boolean;
+      }
+
+      /** Operation for {@link ActiveEffect.createDocuments | `ActiveEffect.createDocuments`} */
+      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<ActiveEffect.Database.Create<Temporary>> {}
+
+      /** Operation for {@link ActiveEffect.updateDocuments | `ActiveEffect.updateDocuments`} */
+      interface UpdateDocumentsOperation
+        extends Document.Database.UpdateDocumentsOperation<ActiveEffect.Database.Update> {}
+
+      /** Operation for {@link ActiveEffect.deleteDocuments | `ActiveEffect.deleteDocuments`} */
+      interface DeleteDocumentsOperation
+        extends Document.Database.DeleteDocumentsOperation<ActiveEffect.Database.Delete> {}
+
+      /** Operation for {@link ActiveEffect.create | `ActiveEffect.create`} */
+      interface CreateOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<ActiveEffect.Database.Create<Temporary>> {}
+
+      /** Operation for {@link ActiveEffect.update | `ActiveEffect#update`} */
+      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+      /** Options for {@link ActiveEffect.get | `ActiveEffect.get`} */
+      interface GetOptions extends Document.Database.GetOptions {}
+
+      /** Options for {@link ActiveEffect._preCreate | `ActiveEffect#_preCreate`} */
+      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+      /** Options for {@link ActiveEffect._onCreate | `ActiveEffect#_onCreate`} */
+      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+      /** Operation for {@link ActiveEffect._preCreateOperation | `ActiveEffect._preCreateOperation`} */
+      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<ActiveEffect.Database.Create> {}
+
+      /** Operation for {@link ActiveEffect._onCreateOperation | `ActiveEffect#_onCreateOperation`} */
+      interface OnCreateOperation extends ActiveEffect.Database.Create {}
+
+      /** Options for {@link ActiveEffect._preUpdate | `ActiveEffect#_preUpdate`} */
+      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+      /** Options for {@link ActiveEffect._onUpdate | `ActiveEffect#_onUpdate`} */
+      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+      /** Operation for {@link ActiveEffect._preUpdateOperation | `ActiveEffect._preUpdateOperation`} */
+      interface PreUpdateOperation extends ActiveEffect.Database.Update {}
+
+      /** Operation for {@link ActiveEffect._onUpdateOperation | `ActiveEffect._preUpdateOperation`} */
+      interface OnUpdateOperation extends ActiveEffect.Database.Update {}
+
+      /** Options for {@link ActiveEffect._preDelete | `ActiveEffect#_preDelete`} */
+      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+      /** Options for {@link ActiveEffect._onDelete | `ActiveEffect#_onDelete`} */
+      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+      /** Options for {@link ActiveEffect._preDeleteOperation | `ActiveEffect#_preDeleteOperation`} */
+      interface PreDeleteOperation extends ActiveEffect.Database.Delete {}
+
+      /** Options for {@link ActiveEffect._onDeleteOperation | `ActiveEffect#_onDeleteOperation`} */
+      interface OnDeleteOperation extends ActiveEffect.Database.Delete {}
+
+      /** Context for {@link ActiveEffect._onDeleteOperation | `ActiveEffect._onDeleteOperation`} */
+      interface OnDeleteDocumentsContext extends Document.ModificationContext<ActiveEffect.Parent> {}
+
+      /** Context for {@link ActiveEffect._onCreateDocuments | `ActiveEffect._onCreateDocuments`} */
+      interface OnCreateDocumentsContext extends Document.ModificationContext<ActiveEffect.Parent> {}
+
+      /** Context for {@link ActiveEffect._onUpdateDocuments | `ActiveEffect._onUpdateDocuments`} */
+      interface OnUpdateDocumentsContext extends Document.ModificationContext<ActiveEffect.Parent> {}
+
+      /**
+       * Options for {@link ActiveEffect._preCreateDescendantDocuments | `ActiveEffect#_preCreateDescendantDocuments`}
+       * and {@link ActiveEffect._onCreateDescendantDocuments | `ActiveEffect#_onCreateDescendantDocuments`}
+       */
+      interface CreateOptions extends Document.Database.CreateOptions<ActiveEffect.Database.Create> {}
+
+      /**
+       * Options for {@link ActiveEffect._preUpdateDescendantDocuments | `ActiveEffect#_preUpdateDescendantDocuments`}
+       * and {@link ActiveEffect._onUpdateDescendantDocuments | `ActiveEffect#_onUpdateDescendantDocuments`}
+       */
+      interface UpdateOptions extends Document.Database.UpdateOptions<ActiveEffect.Database.Update> {}
+
+      /**
+       * Options for {@link ActiveEffect._preDeleteDescendantDocuments | `ActiveEffect#_preDeleteDescendantDocuments`}
+       * and {@link ActiveEffect._onDeleteDescendantDocuments | `ActiveEffect#_onDeleteDescendantDocuments`}
+       */
+      interface DeleteOptions extends Document.Database.DeleteOptions<ActiveEffect.Database.Delete> {}
+    }
+
+    /**
+     * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
+     */
+    interface Flags extends Document.ConfiguredFlagsForName<Name> {}
+
+    namespace Flags {
+      /**
+       * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
+       */
+      type Scope = Document.FlagKeyOf<Flags>;
+
+      /**
+       * The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
+       */
+      type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
+
+      /**
+       * Gets the type of a particular flag given a `Scope` and a `Key`.
+       */
+      type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
+    }
+
+    /**
+     * The flags provided by Foundry itself for this document.
+     */
+    interface CoreFlags {
+      core?: { overlay?: boolean };
+    }
+
+    interface DurationData {
+      /** The world time when the active effect first started */
+      startTime?: number | null | undefined;
+
+      /** The maximum duration of the effect, in seconds */
+      seconds?: number | null | undefined;
+
+      /** The _id of the CombatEncounter in which the effect first started */
+      combat?: string | null | undefined;
+
+      /** The maximum duration of the effect, in combat rounds */
+      rounds?: number | null | undefined;
+
+      /** The maximum duration of the effect, in combat turns */
+      turns?: number | null | undefined;
+
+      /** The round of the CombatEncounter in which the effect first started */
+      startRound?: number | null | undefined;
+
+      /** The turn of the CombatEncounter in which the effect first started */
+      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: DurationType;
+
+      /** The total effect duration, in seconds of world time or as a decimal number with the format \{rounds\}.\{turns\} */
+      duration: number;
+
+      /** The remaining effect duration, in seconds of world time or as a decimal number with the format \{rounds\}.\{turns\} */
+      remaining: number;
+
+      /** A formatted string label that represents the remaining duration */
+      label: string;
+
+      /** An internal flag used determine when to recompute seconds-based duration */
+      _worldTime?: number;
+
+      /** An internal flag used determine when to recompute turns-based duration */
+      _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
+       * @defaultValue `""`
+       */
+      key: string;
+
+      /**
+       * The value of the change effect
+       * @defaultValue `""`
+       */
+      value: string;
+
+      // TODO (@LukeAbby): `undefined` is not valid. We can't pull directly from the schema because this interface is used inside of field methods.
+
+      /**
+       * The modification mode with which the change is applied
+       * @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: CONST.ACTIVE_EFFECT_MODES | null | undefined;
+
+      /**
+       * The priority level with which this change is applied
+       * @defaultValue `null`
+       * @privateRemarks `undefined` is not actually a possible value, included here due to fvtt-types handling of `initial` values
+       */
+      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`}
+     */
     interface DatabaseOperations
-      extends DocumentDatabaseOperations<
-        ActiveEffect,
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
+      extends Document.Database.Operations<
+        ActiveEffect.Implementation,
         { animate: boolean },
         { animate: boolean },
         { animate: boolean }
       > {}
 
-    // Helpful aliases
-    type TypeNames = BaseActiveEffect.TypeNames;
-    type ConstructorData = BaseActiveEffect.ConstructorData;
-    type UpdateData = BaseActiveEffect.UpdateData;
-    type Schema = BaseActiveEffect.Schema;
-    type Source = BaseActiveEffect.Source;
+    /**
+     * @deprecated {@link ActiveEffect.SubType | `ActiveEffect.SubType`}
+     */
+    type TypeNames = ActiveEffect.SubType;
+
+    /**
+     * @deprecated {@link ActiveEffect.CreateData | `ActiveEffect.CreateData`}
+     */
+    interface ConstructorData extends ActiveEffect.CreateData {}
+
+    /**
+     * @deprecated {@link ActiveEffect.implementation | `ActiveEffect.ImplementationClass`}
+     */
+    type ConfiguredClass = ImplementationClass;
+
+    /**
+     * @deprecated {@link ActiveEffect.Implementation | `ActiveEffect.Implementation`}
+     */
+    type ConfiguredInstance = Implementation;
   }
 
   /**
@@ -34,16 +662,22 @@ declare global {
    * Each ActiveEffect belongs to the effects collection of its parent Document.
    * Each ActiveEffect contains a ActiveEffectData object which provides its source data.
    *
-   * @see {@link ActiveEffectData}          The ActiveEffect data schema
-   * @see {@link Actor}                     The Actor document which contains ActiveEffect embedded documents
-   * @see {@link Item}                      The Item document which contains ActiveEffect embedded documents
+   * @see {@link ActiveEffectData | `ActiveEffectData`}          The ActiveEffect data schema
+   * @see {@link Actor | `Actor`}                     The Actor document which contains ActiveEffect embedded documents
+   * @see {@link Item | `Item`}                      The Item document which contains ActiveEffect embedded documents
    */
-  class ActiveEffect extends ClientDocumentMixin(foundry.documents.BaseActiveEffect) {
-    static override metadata: ActiveEffect.Metadata;
+  class ActiveEffect<out SubType extends ActiveEffect.SubType = ActiveEffect.SubType> extends ClientDocumentMixin(
+    foundry.documents.BaseActiveEffect,
+  )<SubType> {
+    /**
+     * @param data    - Initial data from which to construct the `ActiveEffect`
+     * @param context - Construction context options
+     */
+    constructor(...args: ActiveEffect.ConstructorArgs);
 
     /**
      * Create an ActiveEffect instance from some status effect ID.
-     * Delegates to {@link ActiveEffect._fromStatusEffect} to create the ActiveEffect instance
+     * Delegates to {@link ActiveEffect._fromStatusEffect | `ActiveEffect._fromStatusEffect`} to create the ActiveEffect instance
      * after creating the ActiveEffect data from the status effect data if `CONFIG.statusEffects`.
      * @param statusId - The status effect ID.
      * @param options  - Additional options to pass to the ActiveEffect constructor.
@@ -52,28 +686,32 @@ 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>,
-    ): Promise<ActiveEffect.ConfiguredInstance>;
+      options?: Document.ConstructionContext<ActiveEffect.Parent>,
+    ): Promise<ActiveEffect.Implementation>;
 
     /**
      * Create an ActiveEffect instance from status effect data.
-     * Called by {@link ActiveEffect.fromStatusEffect}.
+     * Called by {@link ActiveEffect.fromStatusEffect | `ActiveEffect.fromStatusEffect`}.
      * @param statusId   - The status effect ID.
      * @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: ActiveEffectData,
-      options?: Document.ConstructionContext<Document.Any | null>,
-    ): Promise<ActiveEffect.ConfiguredInstance>;
+      effectData: ActiveEffect.CreateData,
+      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;
 
@@ -92,15 +730,16 @@ 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.
      */
-    updateDuration(): ActiveEffectDuration;
+    // TODO: This adds two getter properties (`remaining` and `label`) to `this.duration` (a SchemaField property on the document)
+    updateDuration(): ActiveEffect.Duration;
 
     /**
      * Determine whether the ActiveEffect requires a duration update.
@@ -109,7 +748,8 @@ declare global {
      */
     protected _requiresDurationUpdate(): boolean;
 
-    protected _prepareDuration(): Omit<ActiveEffectDuration, keyof EffectDurationData>;
+    /** @internal */
+    protected _prepareDuration(): ActiveEffect.PrepareDurationReturn;
 
     /**
      * Format a round+turn combination as a decimal
@@ -117,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;
 
     /**
@@ -125,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;
 
@@ -141,13 +784,19 @@ declare global {
     get sourceName(): string;
 
     /**
-     * Apply EffectChangeData to a field within a DataModel.
+     * Apply ActiveEffect.EffectChangeData to a field within a DataModel.
      * @param model  - The model instance.
      * @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: 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.
@@ -155,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.ConfiguredInstance, change: 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
@@ -166,30 +815,37 @@ declare global {
      * @param change  - The change data being applied.
      * @param changes - The aggregate update paths and their updated values.
      */
-    protected _applyLegacy(actor: Actor.ConfiguredInstance, change: EffectDurationData, changes: AnyObject): void;
+    protected _applyLegacy(
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      changes: AnyMutableObject,
+    ): void;
 
     /**
-     * Cast a raw EffectChangeData change string to the desired data type.
+     * 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 EffectChangeData change string to an Array of an inner type.
+     * Cast a raw ActiveEffect.EffectChangeData change string to an Array of an inner type.
      * @param raw  - The raw string value
      * @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.
@@ -206,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.ConfiguredInstance,
-      change: EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      current: unknown,
+      delta: unknown,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -224,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.ConfiguredInstance,
-      change: EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      current: unknown,
+      delta: unknown,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -242,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.ConfiguredInstance,
-      change: EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      current: unknown,
+      delta: unknown,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -260,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.ConfiguredInstance,
-      change: EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      current: unknown,
+      delta: unknown,
+      changes: AnyMutableObject,
     ): void;
 
     /**
@@ -277,33 +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.ConfiguredInstance,
-      change: EffectChangeData,
-      current: any,
-      delta: any,
-      changes: AnyObject,
+      actor: Actor.Implementation,
+      change: ActiveEffect.EffectChangeData,
+      current: unknown,
+      delta: unknown,
+      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.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
+     * @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.
@@ -311,50 +975,54 @@ declare global {
      */
     protected _displayScrollingStatus(enabled: boolean): void;
 
-    /* -------------------------------------------- */
-    /*  Deprecations and Compatibility              */
-    /* -------------------------------------------- */
-
     /**
      * 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>;
-  }
 
-  interface ActiveEffect {
-    duration: ActiveEffectDuration;
-  }
-
-  interface ActiveEffectDuration extends EffectDurationData {
-    /**
-     * The duration type, either "seconds", "turns", or "none"
+    /*
+     * After this point these are not really overridden methods.
+     * They are here because Foundry's documents are complex and have lots of edge cases.
+     * There are DRY ways of representing this but this ends up being harder to understand
+     * for end users extending these functions, especially for static methods. There are also a
+     * number of methods that don't make sense to call directly on `Document` like `createDocuments`,
+     * as there is no data that can safely construct every possible document. Finally keeping definitions
+     * separate like this helps against circularities.
      */
-    type: "seconds" | "turns" | "none";
 
-    /**
-     * The total effect duration, in seconds of world time or as a decimal
-     * number with the format `{rounds}.{turns}`
-     */
-    duration: number | null;
+    // ClientDocument overrides
 
-    /**
-     * The remaining effect duration, in seconds of world time or as a decimal
-     * number with the format `{rounds}.{turns}`
-     */
-    remaining: number | null;
+    // Descendant Document operations have been left out because ActiveEffect does not have any descendant documents.
 
-    label: string;
+    // context: not null (destructured)
+    static override defaultName(
+      context?: Document.DefaultNameContext<"ActiveEffect", NonNullable<ActiveEffect.Parent>>,
+    ): string;
 
-    /**
-     * An internal flag used determine when to recompute seconds-based duration
-     */
-    _worldTime: number;
+    /** @remarks `context.parent` is required as creation requires one */
+    static override createDialog(
+      data: Document.CreateDialogData<ActiveEffect.CreateData> | undefined,
+      context: Document.CreateDialogContext<"ActiveEffect", NonNullable<ActiveEffect.Parent>>,
+    ): Promise<ActiveEffect.Stored | null | undefined>;
 
-    /**
-     * An internal flag used determine when to recompute turns-based duration
-     */
-    _combatTime: number;
+    // options: not null (parameter default only)
+    static override fromDropData(
+      data: Document.DropData<ActiveEffect.Implementation>,
+      options?: AnyObject,
+    ): Promise<ActiveEffect.Implementation | undefined>;
+
+    static override fromImport(
+      source: ActiveEffect.Source,
+      context?: Document.FromImportContext<ActiveEffect.Parent> | null,
+    ): Promise<ActiveEffect.Implementation>;
+
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
   }
+
+  /**
+   * @deprecated {@link ActiveEffect.Duration | `ActiveEffect.Duration`}
+   */
+  type ActiveEffectDuration = ActiveEffect.Duration;
 }