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

package/src/foundry/client/data/abstract/canvas-document.d.mts

@@ -1,24 +1,28 @@
-import type { Mixin } from "../../../../types/utils.d.mts";
+import type { FixedInstanceType, Mixin } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
-import type { ClientDocument } from "./client-document.d.mts";
+import type { InternalClientDocument } from "./client-document.d.mts";
 
 declare class CanvasDocument<
-  BaseDocument extends Document<any, any, Scene.ConfiguredInstance | null>,
-> extends ClientDocument<BaseDocument> {
+  BaseDocument extends Document.Internal.Instance.Any,
+  PlaceableType extends Document.PlaceableType = Extract<
+    Document.Internal.DocumentNameFor<BaseDocument>,
+    Document.PlaceableType
+  >,
+> extends InternalClientDocument<BaseDocument> {
   /** @privateRemarks All mixin classses should accept anything for its constructor. */
   constructor(...args: any[]);
 
   /**
    * A lazily constructed PlaceableObject instance which can represent this Document on the game canvas.
    */
-  get object(): Document.ConfiguredObjectInstanceForName<BaseDocument["documentName"]> | null;
+  get object(): Document.ObjectFor<PlaceableType> | null;
 
   /**
    * A reference to the PlaceableObject instance which represents this Embedded Document.
    * @internal
    * @defaultValue `null`
    */
-  protected _object: Document.ConfiguredObjectInstanceForName<BaseDocument["documentName"]> | null;
+  protected _object: Document.ObjectFor<PlaceableType> | null;
 
   /**
    * Has this object been deliberately destroyed as part of the deletion workflow?
@@ -30,40 +34,30 @@ declare class CanvasDocument<
   /**
    * A reference to the CanvasLayer which contains Document objects of this type.
    */
-  get layer(): InstanceType<PlaceablesLayer.ConfiguredClassForName<BaseDocument["documentName"]>>;
+  get layer(): PlaceablesLayer.ImplementationFor<PlaceableType>;
 
   /**
    * An indicator for whether this document is currently rendered on the game canvas.
    */
   get rendered(): boolean;
 
-  /**
-   * @privateRemarks _preCreate, _onCreate, _onUpdate, 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.
-   */
-}
-
-declare namespace CanvasDocument {
-  type Any = CanvasDocument<any>;
+  // _preCreate, _onCreate, _onUpdate, 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.
 }
 
 declare global {
-  /**
-   * @deprecated {@link CanvasDocument.Any | `CanvasDocument.Any`}
-   */
-  type CanvasDocument = ReturnType<typeof CanvasDocumentMixin>;
-
   /**
    * A specialized sub-class of the ClientDocumentMixin which is used for document types that are intended to be represented upon the game Canvas.
    */
-  function CanvasDocumentMixin<BaseClass extends Document.Internal.Constructor>(
+  // TODO(LukeAbby): The constraint here should ideally be something like `Document<Document.PlaceableType, any, Scene.Implementation | null>` but this causes circularities.
+  function CanvasDocumentMixin<BaseClass extends CanvasDocumentMixin.BaseClass>(
     Base: BaseClass,
-  ): typeof AnyDocument & Mixin<typeof CanvasDocument<InstanceType<BaseClass>>, BaseClass>;
-}
+  ): Mixin<typeof CanvasDocument<FixedInstanceType<BaseClass>>, BaseClass>;
 
-// This is yet another `AnyDocument` type.
-// It exists specifically because the `Document.AnyConstructor` type is too safe to be merged in with a mixin.
-// The `arg0: never, ...args: never[]` trick trips up the base constructor check and so this one with an actual `...args: any[]` one is used instead.
-declare class AnyDocument extends Document<any, any, any> {
-  constructor(...args: any[]);
+  namespace CanvasDocumentMixin {
+    interface AnyMixedConstructor extends ReturnType<typeof ClientDocumentMixin<BaseClass>> {}
+    interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
+
+    type BaseClass = Document.Internal.Constructor;
+  }
 }