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

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

@@ -1,23 +1,545 @@
-import type { DeepPartial, InexactPartial, FixedInstanceType } from "fvtt-types/utils";
-import type { fields } from "../../../common/data/_module.d.mts";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseCards from "../../../common/documents/cards.d.mts";
+import type { ConfiguredCards } from "fvtt-types/configuration";
+import type { DeepPartial, InexactPartial, Merge } from "fvtt-types/utils";
+import type Document from "#common/abstract/document.d.mts";
+import type { DataSchema } from "#common/data/fields.d.mts";
+import type { fields } from "#common/data/_module.d.mts";
+import type BaseCards from "#common/documents/cards.d.mts";
+import type { documents } from "#client-esm/client.d.mts";
 
 declare global {
   namespace Cards {
-    type Metadata = Document.MetadataFor<Cards>;
+    /**
+     * The document's name.
+     */
+    type Name = "Cards";
+
+    /**
+     * The arguments to construct the document.
+     */
+    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
+
+    /**
+     * The documents embedded within `Cards`.
+     */
+    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
+
+    /**
+     * The implementation of the `Cards` document instance configured through `CONFIG.Cards.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredCards | `fvtt-types/configuration/ConfiguredCards`} in fvtt-types.
+     */
+    type Implementation = Document.ImplementationFor<Name>;
+
+    /**
+     * The implementation of the `Cards` document configured through `CONFIG.Cards.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: "Cards";
+          collection: "cards";
+          indexed: true;
+          compendiumIndexFields: ["_id", "name", "description", "img", "type", "sort", "folder"];
+          embedded: Metadata.Embedded;
+          hasTypeData: true;
+          label: string;
+          labelPlural: string;
+          coreTypes: ["deck", "hand", "pile"];
+          schemaVersion: string;
+        }>
+      > {}
+
+    namespace Metadata {
+      /**
+       * The embedded metadata
+       */
+      interface Embedded {
+        Card: "cards";
+      }
+    }
+
+    /**
+     * Allowed subtypes of `Cards`. This is configured through various methods. Modern Foundry
+     * recommends registering using [Data Models](https://foundryvtt.com/article/system-data-models/)
+     * under {@link CONFIG.Cards.dataModels | `CONFIG.Cards.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<"Cards">;
+
+    /**
+     * `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<"Cards">;
+
+    /**
+     * `Known` represents the types of `Cards` that a user explicitly registered.
+     *
+     * @see {@link ConfiguredSubTypes} for more information.
+     */
+    type Known = Cards.OfType<Cards.ConfiguredSubTypes>;
+
+    /**
+     * `OfType` returns an instance of `Cards` with the corresponding type. This works with both the
+     * builtin `Cards` class or a custom subclass if that is set up in
+     * {@link ConfiguredCards | `fvtt-types/configuration/ConfiguredCards`}.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-restricted-types
+    type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredCards<Type>, Cards<Type>>;
+
+    /**
+     * `SystemOfType` returns the system property for a specific `Cards` subtype.
+     */
+    type SystemOfType<Type extends SubType> = Document.Internal.SystemOfType<_SystemMap, Type>;
+
+    /**
+     * @internal
+     */
+    interface _SystemMap extends Document.Internal.SystemMap<"Cards"> {}
+
+    /**
+     * 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 = 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 = Card.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 = Card.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<"Cards">;
+
+    /**
+     * 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 `Cards`s. Will be `never` if none exists.
+     */
+    type CollectionClass = CardStacks.ConfiguredClass;
+
+    /**
+     * The world collection that contains `Cards`s. Will be `never` if none exists.
+     */
+    type Collection = CardStacks.Configured;
+
+    /**
+     * An instance of `Cards` that comes from the database but failed validation meaining that
+     * its `system` and `_source` could theoretically be anything.
+     */
+    interface Invalid<out SubType extends Cards.SubType = Cards.SubType> extends Document.Invalid<OfType<SubType>> {}
+
+    /**
+     * An instance of `Cards` that comes from the database.
+     */
+    interface Stored<out SubType extends Cards.SubType = Cards.SubType> extends Document.Stored<OfType<SubType>> {}
+
+    /**
+     * The data put in {@link Cards._source | `Cards#_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 Cards.Source | `Cards.Source`}
+     */
+    type PersistedData = Source;
+
+    /**
+     * The data necessary to create a document. Used in places like {@link Cards.create | `Cards.create`}
+     * and {@link Cards | `new Cards(...)`}.
+     *
+     * 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 Cards.name | `Cards#name`}.
+     *
+     * This is data transformed from {@link Cards.Source | `Cards.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> {}
 
-    type ConfiguredClass = Document.ConfiguredClassForName<"Cards">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Cards">;
+    /**
+     * The data used to update a document, for example {@link Cards.update | `Cards#update`}.
+     * It is a distinct type from {@link Cards.CreateData | `DeepPartial<Cards.CreateData>`} because
+     * it has different rules for `null` and `undefined`.
+     */
+    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
 
-    interface DatabaseOperations extends Document.Database.Operations<Cards> {}
+    /**
+     * The schema for {@link Cards | `Cards`}. This is the source of truth for how an Cards document
+     * must be structured.
+     *
+     * Foundry uses this schema to validate the structure of the {@link Cards | `Cards`}. 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 stack of Cards document
+       * @defaultValue `null`
+       */
+      _id: fields.DocumentIdField;
 
-    // Helpful aliases
-    type TypeNames = BaseCards.TypeNames;
-    type ConstructorData = BaseCards.ConstructorData;
-    type UpdateData = BaseCards.UpdateData;
-    type Schema = BaseCards.Schema;
-    type Source = BaseCards.Source;
+      /** The text name of this stack */
+      name: fields.StringField<{ required: true; blank: false; label: "CARDS.Name"; textSearch: true }>;
+
+      /**
+       * The type of this stack, in BaseCards.metadata.types
+       * @defaultValue `BaseCards.TYPES[0]`
+       */
+      type: fields.DocumentTypeField<typeof BaseCards>;
+
+      /**
+       * A text description of this stack
+       * @defaultValue `""`
+       */
+      description: fields.HTMLField<{ label: "CARDS.Description"; textSearch: true }>;
+
+      /**
+       * An image or video which is used to represent the stack of cards
+       * @defaultValue `BaseCards.DEFAULT_ICON`
+       */
+      img: fields.FilePathField<{
+        categories: ["IMAGE", "VIDEO"];
+        initial: () => typeof BaseCards.DEFAULT_ICON;
+        label: "CARDS.Image";
+      }>;
+
+      /**
+       * Game system data which is defined by the system template.json model
+       * @defaultValue `{}`
+       */
+      system: fields.TypeDataField<typeof BaseCards>;
+
+      /**
+       * A collection of Card documents which currently belong to this stack
+       * @defaultValue `[]`
+       */
+      cards: fields.EmbeddedCollectionField<typeof documents.BaseCard, Cards.Implementation>;
+
+      /**
+       * The visible width of this stack
+       * @defaultValue `null`
+       */
+      width: fields.NumberField<{ integer: true; positive: true; label: "Width" }>;
+
+      /**
+       * The visible height of this stack
+       * @defaultValue `null`
+       */
+      height: fields.NumberField<{ integer: true; positive: true; label: "Height" }>;
+
+      /**
+       * The angle of rotation of this stack
+       * @defaultValue `0`
+       */
+      rotation: fields.AngleField<{ label: "Rotation" }>;
+
+      /**
+       * Whether or not to publicly display the number of cards in this stack
+       * @defaultValue `false`
+       */
+      displayCount: fields.BooleanField;
+
+      /**
+       * The _id of a Folder which contains this document
+       * @defaultValue `null`
+       */
+      folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+      /**
+       * The sort order of this stack relative to others in its parent collection
+       * @defaultValue `0`
+       */
+      sort: fields.IntegerSortField;
+
+      /**
+       * An object which configures ownership of this Cards
+       * @defaultValue see {@link fields.DocumentOwnershipField | `fields.DocumentOwnershipField`}
+       */
+      ownership: fields.DocumentOwnershipField;
+
+      /**
+       * An object of optional key/value flags
+       * @defaultValue `{}`
+       */
+      flags: fields.ObjectField.FlagsField<Name>;
+
+      /**
+       * 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 Cards Documents */
+      interface Get extends foundry.abstract.types.DatabaseGetOperation<Cards.Parent> {}
+
+      /** Options passed along in Create operations for Cards Documents */
+      interface Create<Temporary extends boolean | undefined = boolean | undefined>
+        extends foundry.abstract.types.DatabaseCreateOperation<Cards.CreateData, Cards.Parent, Temporary> {
+        animate?: boolean;
+      }
+
+      /** Options passed along in Delete operations for Cards Documents */
+      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Cards.Parent> {
+        animate?: boolean;
+      }
+
+      /** Options passed along in Update operations for Cards Documents */
+      interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Cards.UpdateData, Cards.Parent> {
+        animate?: boolean;
+      }
+
+      /** Operation for {@link Cards.createDocuments | `Cards.createDocuments`} */
+      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Cards.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Cards.updateDocuments | `Cards.updateDocuments`} */
+      interface UpdateDocumentsOperation extends Document.Database.UpdateDocumentsOperation<Cards.Database.Update> {}
+
+      /** Operation for {@link Cards.deleteDocuments | `Cards.deleteDocuments`} */
+      interface DeleteDocumentsOperation extends Document.Database.DeleteDocumentsOperation<Cards.Database.Delete> {}
+
+      /** Operation for {@link Cards.create | `Cards.create`} */
+      interface CreateOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Cards.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Cards.update | `Cards#update`} */
+      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+      /** Options for {@link Cards.get | `Cards.get`} */
+      interface GetOptions extends Document.Database.GetOptions {}
+
+      /** Options for {@link Cards._preCreate | `Cards#_preCreate`} */
+      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+      /** Options for {@link Cards._onCreate | `Cards#_onCreate`} */
+      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+      /** Operation for {@link Cards._preCreateOperation | `Cards._preCreateOperation`} */
+      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Cards.Database.Create> {}
+
+      /** Operation for {@link Cards._onCreateOperation | `Cards#_onCreateOperation`} */
+      interface OnCreateOperation extends Cards.Database.Create {}
+
+      /** Options for {@link Cards._preUpdate | `Cards#_preUpdate`} */
+      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+      /** Options for {@link Cards._onUpdate | `Cards#_onUpdate`} */
+      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+      /** Operation for {@link Cards._preUpdateOperation | `Cards._preUpdateOperation`} */
+      interface PreUpdateOperation extends Cards.Database.Update {}
+
+      /** Operation for {@link Cards._onUpdateOperation | `Cards._preUpdateOperation`} */
+      interface OnUpdateOperation extends Cards.Database.Update {}
+
+      /** Options for {@link Cards._preDelete | `Cards#_preDelete`} */
+      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+      /** Options for {@link Cards._onDelete | `Cards#_onDelete`} */
+      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+      /** Options for {@link Cards._preDeleteOperation | `Cards#_preDeleteOperation`} */
+      interface PreDeleteOperation extends Cards.Database.Delete {}
+
+      /** Options for {@link Cards._onDeleteOperation | `Cards#_onDeleteOperation`} */
+      interface OnDeleteOperation extends Cards.Database.Delete {}
+
+      /** Context for {@link Cards._onDeleteOperation | `Cards._onDeleteOperation`} */
+      interface OnDeleteDocumentsContext extends Document.ModificationContext<Cards.Parent> {}
+
+      /** Context for {@link Cards._onCreateDocuments | `Cards._onCreateDocuments`} */
+      interface OnCreateDocumentsContext extends Document.ModificationContext<Cards.Parent> {}
+
+      /** Context for {@link Cards._onUpdateDocuments | `Cards._onUpdateDocuments`} */
+      interface OnUpdateDocumentsContext extends Document.ModificationContext<Cards.Parent> {}
+
+      /**
+       * Options for {@link Cards._preCreateDescendantDocuments | `Cards#_preCreateDescendantDocuments`}
+       * and {@link Cards._onCreateDescendantDocuments | `Cards#_onCreateDescendantDocuments`}
+       */
+      interface CreateOptions extends Document.Database.CreateOptions<Cards.Database.Create> {}
+
+      /**
+       * Options for {@link Cards._preUpdateDescendantDocuments | `Cards#_preUpdateDescendantDocuments`}
+       * and {@link Cards._onUpdateDescendantDocuments | `Cards#_onUpdateDescendantDocuments`}
+       */
+      interface UpdateOptions extends Document.Database.UpdateOptions<Cards.Database.Update> {}
+
+      /**
+       * Options for {@link Cards._preDeleteDescendantDocuments | `Cards#_preDeleteDescendantDocuments`}
+       * and {@link Cards._onDeleteDescendantDocuments | `Cards#_onDeleteDescendantDocuments`}
+       */
+      interface DeleteOptions extends Document.Database.DeleteOptions<Cards.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<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
+
+    type OnCreateDescendantDocumentsArgs = Document.OnCreateDescendantDocumentsArgs<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
+
+    type PreUpdateDescendantDocumentsArgs = Document.PreUpdateDescendantDocumentsArgs<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
+
+    type OnUpdateDescendantDocumentsArgs = Document.OnUpdateDescendantDocumentsArgs<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
+
+    type PreDeleteDescendantDocumentsArgs = Document.PreDeleteDescendantDocumentsArgs<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
+
+    type OnDeleteDescendantDocumentsArgs = Document.OnDeleteDescendantDocumentsArgs<
+      Cards.Stored,
+      Cards.DirectDescendant,
+      Cards.Metadata.Embedded
+    >;
 
     type CardsAction = "deal" | "pass";
 
@@ -41,7 +563,7 @@ declare global {
        * for example the displayed face
        * @defaultValue `{}`
        */
-      updateData: DeepPartial<Cards["_source"]>;
+      updateData: DeepPartial<Cards.Implementation["_source"]>;
 
       /**
        * The name of the action being performed, used as part of the dispatched Hook event
@@ -56,7 +578,7 @@ declare global {
       action: CardsAction;
 
       /** An array of Card creation operations to be performed in each destination Cards document */
-      toCreate: Card["_source"][][];
+      toCreate: Card.Implementation["_source"][][];
 
       /** Card update operations to be performed in the origin Cards document */
       fromUpdate: { _id: string; drawn: true }[];
@@ -71,7 +593,7 @@ declare global {
        * for example the displayed face
        * @defaultValue `{}`
        */
-      updateData: DeepPartial<Card["_source"]> | undefined;
+      updateData: DeepPartial<Card.Implementation["_source"]> | undefined;
 
       /**
        * The name of the action being performed, used as part of the dispatched Hook event
@@ -98,7 +620,7 @@ declare global {
        * for example the displayed face
        * @defaultValue `{}`
        */
-      updateData: DeepPartial<Card["_source"]>;
+      updateData: DeepPartial<Card.Implementation["_source"]>;
     }
 
     interface ShuffleOptions extends BaseOperationOptions {
@@ -107,7 +629,7 @@ declare global {
        * for example the displayed face
        * @defaultValue `{}`
        */
-      updateData: DeepPartial<Card["_source"]>;
+      updateData: DeepPartial<Card.Implementation["_source"]>;
 
       /** Create a ChatMessage which notifies that this action has occurred
        *  @defaultValue `true`
@@ -122,7 +644,7 @@ declare global {
        * for example the displayed face
        * @defaultValue `{}`
        */
-      updateData: DeepPartial<Card["_source"]>;
+      updateData: DeepPartial<Card.Implementation["_source"]>;
     }
 
     /** Additional context which describes the operation. */
@@ -131,7 +653,7 @@ declare global {
        * A mapping of Card deck IDs to the update operations that
        * will be performed on them.
        */
-      toUpdate: Record<string, DeepPartial<Card["_source"]>[]>;
+      toUpdate: Record<string, DeepPartial<Card.Implementation["_source"]>[]>;
 
       /**
        * Card deletion operations to be performed on the origin Cards
@@ -139,19 +661,49 @@ declare global {
        */
       fromDelete: string[];
     }
+
+    /**
+     * @deprecated {@link Cards.Database | `Cards.DatabaseOperation`}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    interface DatabaseOperations extends Document.Database.Operations<Cards.Implementation> {}
+
+    /**
+     * @deprecated {@link Cards.SubType | `Cards.SubType`}
+     */
+    type TypeNames = Cards.SubType;
+
+    /**
+     * @deprecated {@link Cards.CreateData | `Cards.CreateData`}
+     */
+    interface ConstructorData extends Cards.CreateData {}
+
+    /**
+     * @deprecated {@link Cards.implementation | `Cards.ImplementationClass`}
+     */
+    type ConfiguredClass = ImplementationClass;
+
+    /**
+     * @deprecated {@link Cards.Implementation | `Cards.Implementation`}
+     */
+    type ConfiguredInstance = Implementation;
   }
 
   /**
    * The client-side Cards document which extends the common BaseCards model.
    * Each Cards document contains CardsData which defines its data schema.
    *
-   * @see {@link CardStacks}                        The world-level collection of Cards documents
-   * @see {@link CardsConfig}                       The Cards configuration application
+   * @see {@link CardStacks | `CardStacks`}                        The world-level collection of Cards documents
+   * @see {@link CardsConfig | `CardsConfig`}                       The Cards configuration application
    */
-  class Cards extends ClientDocumentMixin(foundry.documents.BaseCards) {
-    static override metadata: Cards.Metadata;
-
-    static get implementation(): Cards.ConfiguredClass;
+  class Cards<out SubType extends Cards.SubType = Cards.SubType> extends ClientDocumentMixin(
+    foundry.documents.BaseCards,
+  )<SubType> {
+    /**
+     * @param data    - Initial data from which to construct the `Cards`
+     * @param context - Construction context options
+     */
+    constructor(...args: Cards.ConstructorArgs);
 
     /**
      * Provide a thumbnail image path used to represent this document.
@@ -161,12 +713,12 @@ declare global {
     /**
      * The Card documents within this stack which are able to be drawn.
      */
-    get availableCards(): Card.ConfiguredInstance[];
+    get availableCards(): Card.Implementation[];
 
     /**
      * The Card documents which belong to this stack but have already been drawn.
      */
-    get drawnCards(): Card.ConfiguredInstance[];
+    get drawnCards(): Card.Implementation[];
 
     /**
      * Returns the localized Label for the type of Card Stack this is
@@ -178,18 +730,6 @@ declare global {
      */
     get canClone(): boolean;
 
-    static createDocuments<T extends Document.AnyConstructor, Temporary extends boolean | undefined>(
-      this: T,
-      data: Array<
-        fields.SchemaField.AssignmentType<FixedInstanceType<NoInfer<T>>["schema"]["fields"]> & Record<string, unknown>
-      >,
-      operation?: InexactPartial<
-        Omit<Document.Database.OperationOf<NoInfer<T>["metadata"]["name"], "create">, "data">
-      > & {
-        temporary?: Temporary;
-      },
-    ): Promise<Document.ToStoredIf<T, Temporary>[] | undefined>;
-
     /**
      * Deal one or more cards from this Cards document to each of a provided array of Cards destinations.
      * Cards are allocated from the top of the deck in cyclical order until the required number of Cards have been dealt.
@@ -200,10 +740,10 @@ declare global {
      * @returns This Cards document after the deal operation has completed
      */
     deal(
-      to: Cards.ConfiguredInstance[],
+      to: Cards.Implementation[],
       number?: number,
       options?: InexactPartial<Cards.DealOptions>,
-    ): Promise<Cards.ConfiguredInstance>;
+    ): Promise<Cards.Implementation>;
 
     /**
      * Pass an array of specific Card documents from this document to some other Cards stack.
@@ -214,10 +754,10 @@ declare global {
      * @returns An array of the Card embedded documents created within the destination stack
      */
     pass(
-      to: Cards.ConfiguredInstance,
+      to: Cards.Implementation,
       ids: string[],
       options?: InexactPartial<Cards.PassOptions>,
-    ): Promise<Card.ConfiguredInstance[]>;
+    ): Promise<Card.Implementation[]>;
 
     /**
      * Draw one or more cards from some other Cards document.
@@ -228,17 +768,17 @@ declare global {
      * @returns An array of the Card documents which were drawn
      */
     draw(
-      from: Cards.ConfiguredInstance,
+      from: Cards.Implementation,
       number?: number,
       options?: InexactPartial<Cards.DrawOptions>,
-    ): Promise<Card.ConfiguredInstance[]>;
+    ): Promise<Card.Implementation[]>;
 
     /**
      * Shuffle this Cards stack, randomizing the sort order of all the cards it contains.
      * @param options - (default: `{}`)
      * @returns The Cards document after the shuffle operation has completed
      */
-    shuffle(options?: InexactPartial<Cards.ShuffleOptions>): Promise<Cards.ConfiguredInstance>;
+    shuffle(options?: InexactPartial<Cards.ShuffleOptions>): Promise<Cards.Implementation>;
 
     /**
      * Perform a reset operation for a deck, retrieving all original cards from other stacks where they may have been
@@ -248,7 +788,7 @@ declare global {
      * @returns The Cards document after the reset operation has completed.
      * @internal
      */
-    protected _resetDeck(options?: InexactPartial<Cards.ResetOptions>): Promise<Cards.ConfiguredInstance>;
+    protected _resetDeck(options?: InexactPartial<Cards.ResetOptions>): Promise<Cards.Implementation>;
 
     /**
      * Return all cards in this stack to their original decks.
@@ -257,21 +797,21 @@ declare global {
      * @returns The Cards document after the return operation has completed.
      * @internal
      */
-    protected _resetStack(options?: InexactPartial<Cards.ResetOptions>): Promise<Cards.ConfiguredInstance>;
+    protected _resetStack(options?: InexactPartial<Cards.ResetOptions>): Promise<Cards.Implementation>;
 
     /**
      * A sorting function that is used to determine the standard order of Card documents within an un-shuffled stack.
      * @param a - The card being sorted
      * @param b - Another card being sorted against
      */
-    protected sortStandard(a: Card, b: Card): number;
+    protected sortStandard(a: Card.Implementation, b: Card.Implementation): number;
 
     /**
      * A sorting function that is used to determine the order of Card documents within a shuffled stack.
      * @param a - The card being sorted
      * @param b - Another card being sorted against
      */
-    protected sortShuffled(a: Card, b: Card): number;
+    protected sortShuffled(a: Card.Implementation, b: Card.Implementation): number;
 
     /**
      * An internal helper method for drawing a certain number of Card documents from this Cards stack.
@@ -279,7 +819,7 @@ declare global {
      * @param how    - A draw mode from CONST.CARD_DRAW_MODES
      * @returns An array of drawn Card documents
      */
-    protected _drawCards(number: number, how: foundry.CONST.CARD_DRAW_MODES): Card.ConfiguredInstance[];
+    protected _drawCards(number: number, how: foundry.CONST.CARD_DRAW_MODES): Card.Implementation[];
 
     /**
      * Create a ChatMessage which provides a notification of the cards operation which was just performed.
@@ -291,59 +831,183 @@ declare global {
      * @internal
      */
     protected _postChatNotification(
-      source: Cards.ConfiguredInstance,
+      source: Cards.Implementation,
       action: string,
       context: Record<string, unknown>,
-    ): Promise<ChatMessage.ConfiguredInstance | undefined>;
+    ): Promise<ChatMessage.Implementation | undefined>;
 
     /**
-     * @privateRemarks _preCreate, _onUpdate, and _preDelete 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.
+     * @privateRemarks _preCreate, _onUpdate, and _preDelete are all overridden but with no signature changes from BaseCards.
      */
 
     /**
      * Display a dialog which prompts the user to deal cards to some number of hand-type Cards documents.
-     * @see {@link Cards#deal}
+     * @see {@link Cards.deal | `Cards#deal`}
      */
-    dealDialog(): Promise<Cards.ConfiguredInstance | null>;
+    dealDialog(): Promise<Cards.Implementation | null>;
 
     /**
      * Display a dialog which prompts the user to draw cards from some other deck-type Cards documents.
-     * @see {@link Cards#draw}
+     * @see {@link Cards.draw | `Cards#draw`}
      */
-    drawDialog(): Promise<Card.ConfiguredInstance[] | null>;
+    drawDialog(): Promise<Card.Implementation[] | null>;
 
     /**
      * Display a dialog which prompts the user to pass cards from this document to some other other Cards document.
-     * @see {@link Cards#deal}
+     * @see {@link Cards.deal | `Cards#deal`}
      */
-    passDialog(): Promise<Cards.ConfiguredInstance | null>;
+    passDialog(): Promise<Cards.Implementation | null>;
 
     /**
      * Display a dialog which prompts the user to play a specific Card to some other Cards document
-     * @see {@link Cards#pass}
+     * @see {@link Cards.pass | `Cards#pass`}
      * @param card - The specific card being played as part of this dialog
      */
-    playDialog(card: Card.ConfiguredInstance): Promise<Card.ConfiguredInstance[] | void | null>;
+    playDialog(card: Card.Implementation): Promise<Card.Implementation[] | void | null>;
 
     /**
      * Display a confirmation dialog for whether or not the user wishes to reset a Cards stack
-     * @see {@link Cards#reset}
+     * @see {@link Cards.reset | `Cards#reset`}
      */
-    resetDialog(): Promise<Cards.ConfiguredInstance | false | null>;
+    resetDialog(): Promise<Cards.Implementation | false | null>;
 
     override deleteDialog(options?: Partial<Dialog.Options>): Promise<this | false | null | undefined>;
 
-    static override createDialog<T extends Document.AnyConstructor>(
-      this: T,
-      data?: DeepPartial<Document.ConstructorDataFor<NoInfer<T>> & Record<string, unknown>>,
-      context?: Pick<Document.Database.OperationOf<Cards["documentName"], "create">, "parent" | "pack"> &
-        InexactPartial<
-          Dialog.Options & {
-            /** A restriction the selectable sub-types of the Dialog. */
-            types: string[];
-          }
-        >,
-    ): Promise<Document.ToConfiguredInstance<T> | null | undefined>;
+    /*
+     * 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.
+     */
+
+    // ClientDocument overrides
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class SwadeCards extends Cards {
+     *   protected override _preCreateDescendantDocuments(...args: Cards.PreCreateDescendantDocumentsArgs) {
+     *     super._preCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, data, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preCreateDescendantDocuments(...args: Cards.PreCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class GurpsCards extends Cards {
+     *   protected override _onCreateDescendantDocuments(...args: Cards.OnCreateDescendantDocumentsArgs) {
+     *     super._onCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, data, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onCreateDescendantDocuments(...args: Cards.OnCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class LancerCards extends Cards {
+     *   protected override _preUpdateDescendantDocuments(...args: Cards.OnUpdateDescendantDocuments) {
+     *     super._preUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, changes, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preUpdateDescendantDocuments(...args: Cards.PreUpdateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class Ptr2eCards extends Cards {
+     *   protected override _onUpdateDescendantDocuments(...args: Cards.OnUpdateDescendantDocumentsArgs) {
+     *     super._onUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, changes, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onUpdateDescendantDocuments(...args: Cards.OnUpdateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class KultCards extends Cards {
+     *   protected override _preDeleteDescendantDocuments(...args: Cards.PreDeleteDescendantDocumentsArgs) {
+     *     super._preDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, ids, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preDeleteDescendantDocuments(...args: Cards.PreDeleteDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class BladesCards extends Cards {
+     *   protected override _onDeleteDescendantDocuments(...args: Cards.OnUpdateDescendantDocuments) {
+     *     super._onDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, ids, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onDeleteDescendantDocuments(...args: Cards.OnDeleteDescendantDocumentsArgs): void;
+
+    static override defaultName(context?: Document.DefaultNameContext<Cards.SubType, Cards.Parent>): string;
+
+    static override createDialog(
+      data?: Document.CreateDialogData<Cards.CreateData>,
+      context?: Document.CreateDialogContext<Cards.SubType, Cards.Parent>,
+    ): Promise<Cards.Stored | null | undefined>;
+
+    static override fromDropData(
+      data: Document.DropData<Cards.Implementation>,
+      options?: Document.FromDropDataOptions,
+    ): Promise<Cards.Implementation | undefined>;
+
+    static override fromImport(
+      source: Cards.Source,
+      context?: Document.FromImportContext<Cards.Parent>,
+    ): Promise<Cards.Implementation>;
   }
 }