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

package/src/foundry/client/data/documents/actor.d.mts

@@ -1,71 +1,639 @@
-import type { DeepPartial, InexactPartial } from "../../../../types/utils.d.mts";
+import type { AnyObject, InexactPartial, NullishProps, Merge } from "#utils";
+import type { documents } from "../../../client-esm/client.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
-import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
 import type BaseActor from "../../../common/documents/actor.d.mts";
+import type { fields, PrototypeToken } from "../../../common/data/module.d.mts";
+import type { ConfiguredActor } from "../../../../configuration/index.d.mts";
+import type { DataSchema } from "../../../common/data/fields.d.mts";
 
 declare global {
   namespace Actor {
-    type Metadata = Document.MetadataFor<Actor>;
+    /**
+     * The document's name.
+     */
+    type Name = "Actor";
+
+    /**
+     * The arguments to construct the document.
+     */
+    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
 
-    type ConfiguredClass = Document.ConfiguredClassForName<"Actor">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Actor">;
+    /**
+     * The documents embedded within `Actor`.
+     */
+    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
 
-    interface DatabaseOperations extends DocumentDatabaseOperations<Actor> {}
+    /**
+     * The implementation of the `Actor` document instance configured through `CONFIG.Actor.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredActor | `fvtt-types/configuration/ConfiguredActor`} in fvtt-types.
+     */
+    type Implementation = Document.ImplementationFor<"Actor">;
 
-    type ItemTypes = {
-      [K in Game.Model.TypeNames<"Item">]: Array<
-        // TODO(LukeAbby): Looks like a `Item.OfType` helper would be useful.
-        Item.ConfiguredInstance & {
-          type: K;
-        } & (DataModelConfig extends { Item: { readonly [_ in K]?: infer SystemData } }
-            ? {
-                // For backwards compatability both instances and classes are supported for the time being.
-                // Only constructors are valid however.
-                system: SystemData extends abstract new (arg0: never, ...args: never[]) => infer Instance
-                  ? Instance
-                  : SystemData;
-              }
-            : // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-              {})
+    /**
+     * The implementation of the `Actor` document configured through `CONFIG.Actor.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
+     */
+    type ImplementationClass = Document.ImplementationClassFor<"Actor">;
+
+    /**
+     * 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: "Actor";
+          collection: "actors";
+          indexed: true;
+          compendiumIndexFields: ["_id", "name", "img", "type", "sort", "folder"];
+          embedded: Metadata.Embedded;
+          hasTypeData: true;
+          label: string;
+          labelPlural: string;
+          permissions: Metadata.Permissions;
+          schemaVersion: string;
+        }>
+      > {}
+
+    namespace Metadata {
+      /**
+       * The embedded metadata
+       */
+      interface Embedded {
+        ActiveEffect: "effects";
+        Item: "items";
+      }
+
+      /**
+       * The permissions for whether a certain user can create, update, or delete this document.
+       */
+      interface Permissions {
+        create(user: User.Internal.Implementation, doc: Implementation): boolean;
+        update(user: User.Internal.Implementation, doc: Implementation, data: UpdateData): boolean;
+      }
+    }
+
+    /**
+     * Allowed subtypes of `Actor`. This is configured through various methods. Modern Foundry
+     * recommends registering using [Data Models](https://foundryvtt.com/article/system-data-models/)
+     * under {@link CONFIG.Actor.dataModels | `CONFIG.Actor.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<"Actor">;
+
+    /**
+     * `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<"Actor">;
+
+    /**
+     * `Known` represents the types of `Actor` that a user explicitly registered.
+     *
+     * @see {@link ConfiguredSubTypes} for more information.
+     */
+    type Known = Actor.OfType<Actor.ConfiguredSubTypes>;
+
+    /**
+     * `OfType` returns an instance of `Actor` with the corresponding type. This works with both the
+     * builtin `Actor` class or a custom subclass if that is set up in
+     * {@link ConfiguredActor | `fvtt-types/configuration/ConfiguredActor`}.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-restricted-types
+    type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredActor<Type>, Actor<Type>>;
+
+    /**
+     * `SystemOfType` returns the system property for a specific `Actor` subtype.
+     */
+    type SystemOfType<Type extends SubType> = Document.Internal.SystemOfType<_SystemMap, Type>;
+
+    /**
+     * @internal
+     */
+    interface _SystemMap extends Document.Internal.SystemMap<"Actor"> {}
+
+    /**
+     * 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 = TokenDocument.Implementation | null;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendant = Item.Stored | ActiveEffect.Stored;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such classes, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendantClass = Item.ImplementationClass | ActiveEffect.ImplementationClass;
+
+    /**
+     * A document's descendants are any documents that are contained within, either within its schema
+     * or its descendant's schemas.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type Descendant = DirectDescendant;
+
+    /**
+     * 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 = DirectDescendantClass;
+
+    /**
+     * 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">;
+
+    /**
+     * 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 = Document.ImplementationFor<Embedded.Name>;
+
+    namespace Embedded {
+      /**
+       * 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 Name = keyof Metadata.Embedded;
+
+      /**
+       * Gets the collection name for an embedded document.
+       */
+      type CollectionNameOf<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionNameFor<
+        Metadata.Embedded,
+        CollectionName
       >;
+
+      /**
+       * Gets the collection document for an embedded document.
+       */
+      // TODO(LukeAbby): There's a circularity. Should be `Document.Embedded.CollectionDocumentFor<Metadata.Embedded, CollectionName>`
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      type DocumentFor<CollectionName extends Embedded.CollectionName> = Document.Any;
+
+      /**
+       * Gets the collection for an embedded document.
+       */
+      type CollectionFor<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionFor<
+        // TODO(LukeAbby): This should be `TokenDocument.Implementation` but this causes a circularity.
+        Document.Any,
+        Metadata.Embedded,
+        CollectionName
+      >;
+
+      /**
+       * A valid name to refer to a collection embedded in this document. For example an `Actor`
+       * has the key `"items"` which contains `Item` instance which would make both `"Item" | "Items"`
+       * valid keys (amongst others).
+       */
+      type CollectionName = Document.Embedded.CollectionName<Metadata.Embedded>;
+    }
+
+    /**
+     * 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 `Actor`s. Will be `never` if none exists.
+     */
+    type CollectionClass = Actors.ConfiguredClass;
+
+    /**
+     * The world collection that contains `Actor`s. Will be `never` if none exists.
+     */
+    type Collection = Actors.Configured;
+
+    /**
+     * An instance of `Actor` that comes from the database but failed validation meaning that
+     * its `system` and `_source` could theoretically be anything.
+     */
+    interface Invalid<out SubType extends Actor.SubType = Actor.SubType> extends Document.Invalid<OfType<SubType>> {}
+
+    /**
+     * An instance of `Actor` that comes from the database.
+     */
+    interface Stored<out SubType extends Actor.SubType = Actor.SubType> extends Document.Stored<OfType<SubType>> {}
+
+    /**
+     * The data put in {@link Actor._source | `Actor#_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 Actor.Source | `Actor.Source`}
+     */
+    type PersistedData = Source;
+
+    /**
+     * The data necessary to create a document. Used in places like {@link Actor.create | `Actor.create`}
+     * and {@link Actor | `new Actor(...)`}.
+     *
+     * 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 Actor.name | `Actor#name`}.
+     *
+     * This is data transformed from {@link Actor.Source | `Actor.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 Actor.update | `Actor#update`}.
+     * It is a distinct type from {@link Actor.CreateData | `DeepPartial<Actor.CreateData>`} because
+     * it has different rules for `null` and `undefined`.
+     */
+    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+    /**
+     * The schema for {@link Actor | `Actor`}. This is the source of truth for how an Actor document
+     * must be structured.
+     *
+     * Foundry uses this schema to validate the structure of the {@link Actor | `Actor`}. 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 this Actor document
+       * @defaultValue `null`
+       */
+      _id: fields.DocumentIdField;
+
+      /** The name of this Actor */
+      // FIXME: required with no initial, assignment type override required
+      name: fields.StringField<{ required: true; blank: false; textSearch: true }, string>;
+
+      /** An Actor subtype which configures the system data model applied */
+      // TODO: required with no initial, needs assignment type override
+      type: fields.DocumentTypeField<typeof BaseActor>;
+
+      /**
+       * An image file path which provides the artwork for this Actor
+       * @defaultValue `Actor.DEFAULT_ICON`
+       */
+      img: fields.FilePathField<{ categories: ["IMAGE"]; initial: (data: unknown) => string }>;
+
+      /**
+       * The system data object which is defined by the system template.json model
+       * @defaultValue `{}`
+       */
+      system: fields.TypeDataField<typeof BaseActor>;
+
+      /**
+       * Default Token settings which are used for Tokens created from this Actor
+       * @defaultValue see {@linkcode PrototypeToken.Schema}
+       */
+      prototypeToken: fields.EmbeddedDataField<typeof PrototypeToken>;
+
+      /**
+       * A Collection of Item embedded Documents
+       * @defaultValue `[]`
+       */
+      items: fields.EmbeddedCollectionField<typeof documents.BaseItem, Actor.Implementation>;
+
+      /**
+       * A Collection of ActiveEffect embedded Documents
+       * @defaultValue `[]`
+       */
+      effects: fields.EmbeddedCollectionField<typeof documents.BaseActiveEffect, Actor.Implementation>;
+
+      /**
+       * The _id of a Folder which contains this Actor
+       * @defaultValue `null`
+       */
+      folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+      /**
+       * The numeric sort value which orders this Actor relative to its siblings
+       * @defaultValue `0`
+       */
+      sort: fields.IntegerSortField;
+
+      /**
+       * An object which configures ownership of this Actor
+       * @defaultValue `{ default: DOCUMENT_OWNERSHIP_LEVELS.NONE }`
+       */
+      ownership: fields.DocumentOwnershipField;
+
+      /**
+       * An object of optional key/value flags
+       * @defaultValue `{}`
+       */
+      flags: fields.ObjectField.FlagsField<"Actor">;
+
+      /**
+       * An object of creation and access information
+       * @defaultValue see {@link fields.DocumentStatsField | `fields.DocumentStatsField`}
+       */
+      _stats: fields.DocumentStatsField;
+    }
+
+    namespace Database {
+      /** Options passed along in Get operations for Actors */
+      interface Get extends foundry.abstract.types.DatabaseGetOperation<Actor.Parent> {}
+
+      /** Options passed along in Create operations for Actors */
+      interface Create<Temporary extends boolean | undefined = boolean | undefined>
+        extends foundry.abstract.types.DatabaseCreateOperation<Actor.CreateData, Actor.Parent, Temporary> {}
+
+      /** Options passed along in Delete operations for Actors */
+      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Actor.Parent> {}
+
+      /** Options passed along in Update operations for Actors */
+      interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Actor.UpdateData, Actor.Parent> {}
+
+      /** Operation for {@link Actor.createDocuments | `Actor.createDocuments`} */
+      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Actor.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Actor.updateDocuments | `Actor.updateDocuments`} */
+      interface UpdateDocumentsOperation extends Document.Database.UpdateDocumentsOperation<Actor.Database.Update> {}
+
+      /** Operation for {@link Actor.deleteDocuments | `Actor.deleteDocuments`} */
+      interface DeleteDocumentsOperation extends Document.Database.DeleteDocumentsOperation<Actor.Database.Delete> {}
+
+      /** Operation for {@link Actor.create | `Actor.create`} */
+      interface CreateOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Actor.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Actor.update | `Actor#update`} */
+      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+      /** Options for {@link Actor.get | `Actor.get`} */
+      interface GetOptions extends Document.Database.GetOptions {}
+
+      /** Options for {@link Actor._preCreate | `Actor#_preCreate`} */
+      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+      /** Options for {@link Actor._onCreate | `Actor#_onCreate`} */
+      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+      /** Operation for {@link Actor._preCreateOperation | `Actor._preCreateOperation`} */
+      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Actor.Database.Create> {}
+
+      /** Operation for {@link Actor._onCreateOperation | `Actor#_onCreateOperation`} */
+      interface OnCreateOperation extends Actor.Database.Create {}
+
+      /** Options for {@link Actor._preUpdate | `Actor#_preUpdate`} */
+      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+      /** Options for {@link Actor._onUpdate | `Actor#_onUpdate`} */
+      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+      /** Operation for {@link Actor._preUpdateOperation | `Actor._preUpdateOperation`} */
+      interface PreUpdateOperation extends Actor.Database.Update {}
+
+      /** Operation for {@link Actor._onUpdateOperation | `Actor._preUpdateOperation`} */
+      interface OnUpdateOperation extends Actor.Database.Update {}
+
+      /** Options for {@link Actor._preDelete | `Actor#_preDelete`} */
+      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+      /** Options for {@link Actor._onDelete | `Actor#_onDelete`} */
+      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+      /** Options for {@link Actor._preDeleteOperation | `Actor#_preDeleteOperation`} */
+      interface PreDeleteOperation extends Actor.Database.Delete {}
+
+      /** Options for {@link Actor._onDeleteOperation | `Actor#_onDeleteOperation`} */
+      interface OnDeleteOperation extends Actor.Database.Delete {}
+
+      /** Context for {@link Actor._onDeleteOperation | `Actor._onDeleteOperation`} */
+      interface OnDeleteDocumentsContext extends Document.ModificationContext<Actor.Parent> {}
+
+      /** Context for {@link Actor._onCreateDocuments | `Actor._onCreateDocuments`} */
+      interface OnCreateDocumentsContext extends Document.ModificationContext<Actor.Parent> {}
+
+      /** Context for {@link Actor._onUpdateDocuments | `Actor._onUpdateDocuments`} */
+      interface OnUpdateDocumentsContext extends Document.ModificationContext<Actor.Parent> {}
+
+      /**
+       * Options for {@link Actor._preCreateDescendantDocuments | `Actor#_preCreateDescendantDocuments`}
+       * and {@link Actor._onCreateDescendantDocuments | `Actor#_onCreateDescendantDocuments`}
+       */
+      interface CreateOptions extends Document.Database.CreateOptions<Actor.Database.Create> {}
+
+      /**
+       * Options for {@link Actor._preUpdateDescendantDocuments | `Actor#_preUpdateDescendantDocuments`}
+       * and {@link Actor._onUpdateDescendantDocuments | `Actor#_onUpdateDescendantDocuments`}
+       */
+      interface UpdateOptions extends Document.Database.UpdateOptions<Actor.Database.Update> {}
+
+      /**
+       * Options for {@link Actor._preDeleteDescendantDocuments | `Actor#_preDeleteDescendantDocuments`}
+       * and {@link Actor._onDeleteDescendantDocuments | `Actor#_onDeleteDescendantDocuments`}
+       */
+      interface DeleteOptions extends Document.Database.DeleteOptions<Actor.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>;
+    }
+
+    type PreCreateDescendantDocumentsArgs =
+      | Document.PreCreateDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.PreCreateDescendantDocumentsArgs;
+
+    type OnCreateDescendantDocumentsArgs =
+      | Document.OnCreateDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.OnCreateDescendantDocumentsArgs;
+
+    type PreUpdateDescendantDocumentsArgs =
+      | Document.PreUpdateDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.PreUpdateDescendantDocumentsArgs;
+
+    type OnUpdateDescendantDocumentsArgs =
+      | Document.OnUpdateDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.OnUpdateDescendantDocumentsArgs;
+
+    type PreDeleteDescendantDocumentsArgs =
+      | Document.PreDeleteDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.PreDeleteDescendantDocumentsArgs;
+
+    type OnDeleteDescendantDocumentsArgs =
+      | Document.OnDeleteDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
+      | Item.OnDeleteDescendantDocumentsArgs;
+
+    interface GetDefaultArtworkReturn {
+      img: string;
+      texture: GetDefaultArtworkTextureReturn;
+    }
+
+    interface GetDefaultArtworkTextureReturn {
+      src: string;
+    }
+
+    type ItemTypes = {
+      [SubType in Item.SubType]: Array<Item.OfType<SubType>>;
     };
 
-    // Helpful aliases
-    type TypeNames = BaseActor.TypeNames;
-    type ConstructorData = BaseActor.ConstructorData;
-    type UpdateData = BaseActor.UpdateData;
-    type Schema = BaseActor.Schema;
-    type Source = BaseActor.Source;
+    type GetActiveTokensReturn<Document extends boolean | null | undefined> = Document extends true
+      ? TokenDocument.Implementation[]
+      : Token.Object[];
 
-    interface RollInitiativeOptions {
+    /** @internal */
+    type _RollInitiativeOptions = NullishProps<{
       /**
        * Create new Combatant entries for Tokens associated with this actor.
        * @defaultValue `false`
        */
-      createCombatants?: boolean;
+      createCombatants: boolean;
 
       /**
        * Re-roll the initiative for this Actor if it has already been rolled.
        * @defaultValue `false`
        */
-      rerollInitiative?: boolean;
+      rerollInitiative: boolean;
+    }> &
+      InexactPartial<{
+        /**
+         * Additional options passed to the Combat#rollInitiative method.
+         * @defaultValue `{}`
+         * @remarks Can't be `null` as it only has a parameter default
+         */
+        initiativeOptions: Combat.InitiativeOptions;
+      }>;
 
+    interface RollInitiativeOptions extends _RollInitiativeOptions {}
+
+    /** @internal */
+    type _ToggleStatusEffectOptions = NullishProps<{
       /**
-       * Additional options passed to the Combat#rollInitiative method.
-       * @defaultValue `{}`
+       * Force a certain active state for the effect
+       * @defaultValue `undefined`
+       * @remarks `null` is treated as `false`, `undefined` or omitted is treated as `true` *if no status
+       * with the given ID already exists*, otherwise also as `false`
        */
-      initiativeOptions?: Combat.InitiativeOptions;
-    }
+      active: boolean;
+
+      /**
+       * Whether to set the effect as the overlay effect?
+       * @defaultValue `false`
+       */
+      overlay: boolean;
+    }>;
+
+    interface ToggleStatusEffectOptions extends _ToggleStatusEffectOptions {}
+
+    /** @internal */
+    type _RequestTokenImagesOptions = NullishProps<{
+      /**
+       * The name of the compendium the actor is in.
+       * @defaultValue `null`
+       * @remarks The default comes from the `"requestTokenImages"` socket handler in `dist/database/documents/actor.mjs` where it's the parameter default
+       */
+      pack: string;
+    }>;
+
+    interface RequestTokenImagesOptions extends _RequestTokenImagesOptions {}
+
+    /** @internal */
+    type _GetDependentTokensOptions = NullishProps<{
+      /**
+       * A single Scene, or list of Scenes to filter by.
+       * @defaultValue `Array.from(this._dependentTokens.keys())`
+       */
+      scenes: Scene.Implementation | Scene.Implementation[];
+
+      /**
+       * Limit the results to tokens that are linked to the actor.
+       * @defaultValue `false`
+       */
+      linked: boolean;
+    }>;
+
+    interface GetDependentTokensOptions extends _GetDependentTokensOptions {}
+
+    /**
+     * @deprecated {@link Actor.Database | `Actor.DatabaseOperation`}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    interface DatabaseOperations extends Document.Database.Operations<Actor.Implementation> {}
+
+    /**
+     * @deprecated {@link Actor.SubType | `Actor.SubType`}
+     */
+    type TypeNames = Actor.SubType;
+
+    /**
+     * @deprecated {@link Actor.CreateData | `Actor.CreateData`}
+     */
+    interface ConstructorData extends Actor.CreateData {}
+
+    /**
+     * @deprecated {@link Actor.implementation | `Actor.ImplementationClass`}
+     */
+    type ConfiguredClass = ImplementationClass;
+
+    /**
+     * @deprecated {@link Actor.Implementation | `Actor.Implementation`}
+     */
+    type ConfiguredInstance = Implementation;
   }
 
   /**
    * The client-side Actor document which extends the common BaseActor model.
    *
    *  ### Hook Events
-   * {@link hookEvents.applyCompendiumArt}
+   * {@link hookEvents.applyCompendiumArt | `hookEvents.applyCompendiumArt`}
    *
-   * @see {@link Actors}            The world-level collection of Actor documents
-   * @see {@link ActorSheet}     The Actor configuration application
+   * @see {@link Actors | `Actors`}            The world-level collection of Actor documents
+   * @see {@link ActorSheet | `ActorSheet`}     The Actor configuration application
    *
    * @example <caption>Create a new Actor</caption>
    * ```typescript
@@ -81,25 +649,32 @@ declare global {
    * let actor = game.actors.get(actorId);
    * ```
    */
-  class Actor extends ClientDocumentMixin(foundry.documents.BaseActor) {
-    static override metadata: Actor.Metadata;
-
-    // NOTE(LukeAbby): Helps stymy circularity.
-    // get documentName(): "Actor";
+  class Actor<out SubType extends Actor.SubType = Actor.SubType> extends ClientDocumentMixin(
+    foundry.documents.BaseActor,
+  )<SubType> {
+    /**
+     * @param data    - Initial data from which to construct the `Actor`
+     * @param context - Construction context options
+     */
+    constructor(...args: Actor.ConstructorArgs);
 
-    protected override _configure(options?: { pack?: string | null }): void;
+    // options: not null (parameter default only, destructured in super)
+    protected override _configure(options?: Document.ConfigureOptions): void;
 
     /**
      * Maintain a list of Token Documents that represent this Actor, stored by Scene.
+     * @remarks Doesn't exist prior to being `defineProperty`'d in {@link Actor._configure | `Actor#_configure`}
      */
-    protected _dependentTokens: foundry.utils.IterableWeakMap<
-      Scene.ConfiguredInstance,
-      TokenDocument.ConfiguredInstance
+    protected _dependentTokens?: foundry.utils.IterableWeakMap<
+      Scene.Implementation,
+      foundry.utils.IterableWeakSet<TokenDocument.Implementation>
     >;
 
+    /** @remarks `||=`s the `prototypeToken`'s `name` and `texture.src` fields with the main actor's values */
+    // options: not null (parameter default only)
     protected override _initializeSource(
-      data: this | Actor.ConstructorData,
-      options?: Omit<foundry.abstract.DataModel.DataValidationOptions, "parent">,
+      data: this | Actor.CreateData,
+      options?: Document.InitializeSourceOptions,
     ): Actor.Source;
 
     /**
@@ -117,6 +692,7 @@ declare global {
      * A cached array of image paths which can be used for this Actor's token.
      * Null if the list has not yet been populated.
      * @defaultValue `null`
+     * @private
      */
     protected _tokenImages: string[] | null;
 
@@ -129,12 +705,13 @@ declare global {
     /**
      * Provide a thumbnail image path used to represent this document.
      */
-    get thumbnail(): this["img"];
+    get thumbnail(): string;
 
     /**
      * Provide an object which organizes all embedded Item instances by their type
      */
     get itemTypes(): Actor.ItemTypes;
+
     /**
      * Test whether an Actor document is a synthetic representation of a Token (if true) or a full Document (if false)
      */
@@ -143,17 +720,17 @@ declare global {
     /**
      * Retrieve the list of ActiveEffects that are currently applied to this Actor.
      */
-    get appliedEffects(): ActiveEffect.ConfiguredInstance[];
+    get appliedEffects(): ActiveEffect.Implementation[];
 
     /**
      * An array of ActiveEffect instances which are present on the Actor which have a limited duration.
      */
-    get temporaryEffects(): ReturnType<this["effects"]["filter"]>;
+    get temporaryEffects(): ActiveEffect.Implementation[];
 
     /**
      * Return a reference to the TokenDocument which owns this Actor as a synthetic override
      */
-    get token(): TokenDocument.ConfiguredInstance | null;
+    get token(): TokenDocument.Implementation | null;
 
     /**
      * Whether the Actor has at least one Combatant in the active Combat that represents it.
@@ -172,13 +749,14 @@ declare global {
      *
      * @param linked   - Limit results to Tokens which are linked to the Actor. Otherwise return all
      *                   Tokens even those which are not linked. (default: `false`)
-     * @param document - Return the Document instance rather than the PlaceableObject (default: `false`)
+     * @param document - Return the Document instance rather than the PlaceableObject
+     *                   (default: `false`)
      * @returns An array of Token instances in the current Scene which reference this Actor.
      */
-    getActiveTokens<ReturnDocument extends boolean = false>(
-      linked?: boolean,
+    getActiveTokens<ReturnDocument extends boolean | null | undefined = false>(
+      linked?: boolean | null,
       document?: ReturnDocument,
-    ): ReturnDocument extends true ? TokenDocument.ConfiguredInstance[] : Token.ConfiguredInstance[];
+    ): Actor.GetActiveTokensReturn<ReturnDocument>;
 
     /**
      * Get all ActiveEffects that may apply to this Actor.
@@ -186,20 +764,24 @@ declare global {
      * If CONFIG.ActiveEffect.legacyTransferral is false, this will also return all the transferred ActiveEffects on any
      * of the Actor's owned Items.
      */
-    allApplicableEffects(): Generator<ActiveEffect.ConfiguredInstance>;
+    allApplicableEffects(): Generator<ActiveEffect.Implementation>;
 
     /**
      * Prepare a data object which defines the data schema used by dice roll commands against this Actor
      * @remarks defaults to this.system, but provided as object for flexible overrides
      */
-    getRollData(): object;
+    getRollData(): AnyObject;
 
     /**
      * Create a new TokenData object which can be used to create a Token representation of the Actor.
      * @param data - Additional data, such as x, y, rotation, etc. for the created token data (default: `{}`)
      * @returns The created TokenData instance
      */
-    getTokenDocument(data?: foundry.documents.BaseToken.ConstructorData): Promise<TokenDocument.ConfiguredInstance>;
+    // data, options: not null (parameter defaults only)
+    getTokenDocument(
+      data?: TokenDocument.CreateData,
+      options?: Document.ConstructionContext<TokenDocument.Parent>,
+    ): Promise<TokenDocument.Implementation>;
 
     /**
      * Get an Array of Token images which could represent this Actor
@@ -215,7 +797,13 @@ declare global {
      * @param isBar     - Whether the new value is part of an attribute bar, or just a direct value (default: `true`)
      * @returns The updated Actor document
      */
-    modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
+    modifyTokenAttribute(
+      attribute: string,
+      // TODO: tighten Combatant.Resource with the justification of this being simply `number`
+      value: number,
+      isDelta?: boolean,
+      isBar?: boolean,
+    ): Promise<this | undefined>;
 
     override prepareData(): void;
 
@@ -229,6 +817,7 @@ declare global {
      * @param options - Configuration for how initiative for this Actor is rolled.
      * @returns A promise which resolves to the Combat document once rolls are complete.
      */
+    // options: not null (destructured)
     rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
 
     /**
@@ -241,73 +830,106 @@ declare global {
      *            - false if an existing effect needed to be removed
      *            - undefined if no changes need to be made
      */
+    // options: not null (destructured)
     toggleStatusEffect(
       statusId: string,
-      options?: InexactPartial<{
-        /** Force the effect to be active or inactive regardless of its current state. */
-        active: boolean;
-        /** Display the toggled effect as an overlay. Default `false`. */
-        overlay: boolean;
-      }>,
-    ): Promise<ActiveEffect.ConfiguredInstance | boolean | undefined>;
+      options?: Actor.ToggleStatusEffectOptions,
+    ): Promise<ActiveEffect.Implementation | boolean | undefined>;
 
     /**
      * Request wildcard token images from the server and return them.
      * @param actorId - The actor whose prototype token contains the wildcard image path.
-     * @internal
+     * @private
      */
-    protected static _requestTokenImages(
-      actorId: string,
-      options?: {
-        /** The name of the compendium the actor is in. */
-        pack: string;
-      },
-    ): Promise<string[]>;
+    // options: not null (parameter default only)
+    protected static _requestTokenImages(actorId: string, options?: Actor.RequestTokenImagesOptions): Promise<string[]>;
 
     /**
      * Get this actor's dependent tokens.
      * If the actor is a synthetic token actor, only the exact Token which it represents will be returned.
      */
-    getDependentTokens(
-      options?: InexactPartial<{
-        /**
-         * A single Scene, or list of Scenes to filter by.
-         */
-        scenes: Scene | Scene[];
-        /**
-         * Limit the results to tokens that are linked to the actor.
-         * @defaultValue `false`
-         */
-        linked: boolean;
-      }>,
-    ): TokenDocument.ConfiguredInstance[];
+    // options: not null (destructured)
+    getDependentTokens(options?: Actor.GetDependentTokensOptions): TokenDocument.Implementation[];
 
     /**
      * Register a token as a dependent of this actor.
      * @param token - The Token
+     * @internal
      */
-    protected _registerDependantToken(token: TokenDocument): void;
+    protected _registerDependantToken(token: TokenDocument.Implementation): void;
 
     /**
      * Remove a token from this actor's dependents.
      * @param token - The Token
+     * @internal
      */
-    protected _unregisterDependentToken(token: TokenDocument): void;
+    protected _unregisterDependentToken(token: TokenDocument.Implementation): void;
 
     /**
      * Prune a whole scene from this actor's dependent tokens.
      * @param scene - The scene
+     * @internal
      */
-    protected _unregisterDependentScene(scene: Scene): void;
+    protected _unregisterDependentScene(scene: Scene.Implementation): void;
+
+    // _onUpdate is overridden but with no signature changes from BaseActor.
 
     /**
-     * @privateRemarks _preCreate, _onUpdate, onCreateDescendantDocuments, onUpdateDescendantDocuments, and _onDeleteDescendentDocuments 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 To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class GurpsActor extends Actor {
+     *   protected override _onCreateDescendantDocuments(...args: Actor.OnCreateDescendantDocumentsArgs) {
+     *     super._onCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, data, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
      */
+    protected override _onCreateDescendantDocuments(...args: Actor.OnCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class Ptr2eActor extends Actor {
+     *   protected override _onUpdateDescendantDocuments(...args: Actor.OnUpdateDescendantDocumentsArgs) {
+     *     super._onUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, changes, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onUpdateDescendantDocuments(...args: Actor.OnUpdateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class BladesActor extends Actor {
+     *   protected override _onDeleteDescendantDocuments(...args: Actor.OnUpdateDescendantDocuments) {
+     *     super._onDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, ids, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onDeleteDescendantDocuments(...args: Actor.OnDeleteDescendantDocumentsArgs): void;
 
     /**
      * Additional workflows to perform when any descendant document within this Actor changes.
-     * @internal
      */
     protected _onEmbeddedDocumentChange(): void;
 
@@ -315,10 +937,96 @@ declare global {
      * Update the active TokenDocument instances which represent this Actor.
      * @param update  - The update delta.
      * @param options - The update context.
+     * @remarks Forwards to {@link Token._onUpdateBaseActor | `Token#_onUpdateBaseActor`}
+     */
+    protected _updateDependentTokens(update: Actor.UpdateData, options: Actor.Database.UpdateOperation): void;
+
+    /*
+     * 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.
      */
-    protected _updateDependentTokens(
-      update: DeepPartial<TokenDocument["_source"]>,
-      options: Document.OnUpdateOptions<"Token">,
-    ): void;
+
+    // ClientDocument overrides
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class SwadeActor extends Actor {
+     *   protected override _preCreateDescendantDocuments(...args: Actor.PreCreateDescendantDocumentsArgs) {
+     *     super._preCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, data, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preCreateDescendantDocuments(...args: Actor.PreCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class LancerActor extends Actor {
+     *   protected override _preUpdateDescendantDocuments(...args: Actor.OnUpdateDescendantDocuments) {
+     *     super._preUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, changes, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preUpdateDescendantDocuments(...args: Actor.PreUpdateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overridden like so:
+     * ```typescript
+     * class KultActor extends Actor {
+     *   protected override _preDeleteDescendantDocuments(...args: Actor.PreDeleteDescendantDocumentsArgs) {
+     *     super._preDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, ids, options, userId] = args;
+     *     if (collection === "effects") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preDeleteDescendantDocuments(...args: Actor.PreDeleteDescendantDocumentsArgs): void;
+
+    // context: not null (destructured)
+    static override defaultName(context?: Document.DefaultNameContext<"Actor", Actor.Parent>): string;
+
+    // data: not null (parameter default only), context: not null (destructured)
+    static override createDialog(
+      data?: Document.CreateDialogData<Actor.CreateData>,
+      context?: Document.CreateDialogContext<"Actor", Actor.Parent>,
+    ): Promise<Actor.Stored | null | undefined>;
+
+    // options: not null (parameter default only)
+    static override fromDropData(
+      data: Document.DropData<Actor.Implementation>,
+      options?: AnyObject,
+    ): Promise<Actor.Implementation | undefined>;
+
+    static override fromImport(
+      source: Actor.Source,
+      context?: Document.FromImportContext<Actor.Parent> | null,
+    ): Promise<Actor.Implementation>;
+
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
   }
 }