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

package/src/foundry/common/documents/actor.d.mts

@@ -1,4 +1,4 @@
-import type { AnyMutableObject, AnyObject } from "fvtt-types/utils";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
@@ -20,15 +20,35 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
    * @param data    - Initial data from which to construct the `BaseActor`
    * @param context - Construction context options
    *
-   * @deprecated Constructing `BaseActor` directly is not advised. The base document classes exist in
+   * @remarks Constructing `BaseActor` directly is not advised. The base document classes exist in
    * order to use documents on both the client (i.e. where all your code runs) and behind the scenes
    * on the server to manage document validation and storage.
    *
    * You should use {@link Actor.implementation | `new Actor.implementation(...)`} instead which will give you
    * a system specific implementation of `Actor`.
    */
-  constructor(...args: Actor.ConstructorArgs);
+  constructor(data: Actor.CreateData, context?: Actor.ConstructionContext);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Actor",
+   *   collection: "actors",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "img", "type", "sort", "folder"],
+   *   embedded: {ActiveEffect: "effects", Item: "items"},
+   *   hasTypeData: true,
+   *   label: "DOCUMENT.Actor",
+   *   labelPlural: "DOCUMENT.Actors",
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "13.341"
+   * })
+   * ```
+   */
   static override metadata: BaseActor.Metadata;
 
   static override defineSchema(): BaseActor.Schema;
@@ -42,26 +62,44 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
   /**
    * Determine default artwork based on the provided actor data
    * @param actorData - The source actor data
+   * @remarks Core's implementation does not use `actorData`
    */
-  static getDefaultArtwork(actorData: BaseActor.CreateData): {
-    img: string;
-    texture: { src: string };
-  };
+  static getDefaultArtwork(actorData?: BaseActor.CreateData): BaseActor.GetDefaultArtworkReturn;
 
+  // options: not null (parameter default only)
   protected override _initializeSource(
     data: BaseActor.CreateData | this,
-    options?: Omit<foundry.abstract.DataModel.DataValidationOptions, "parent">,
+    options?: Document.InitializeSourceOptions,
   ): BaseActor.Source;
 
+  /** @remarks calls `DocumentStatsField._shimDocument(this)` */
+  protected override _initialize(options?: Document.InitializeOptions): void;
+
+  /** @remarks Returns `user.hasPermission("ACTOR_CREATE")` */
   static override canUserCreate(user: User.Implementation): boolean;
 
+  protected override _preCreate(
+    data: Actor.CreateData,
+    options: Actor.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _preUpdate(
+    changed: Actor.UpdateData,
+    options: Actor.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
   /**
-   * @privateRemarks _preCreate and _preUpdate are 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
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
    */
-
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
+  /** @remarks `source` instead of the parent's `data` here */
+  static override shimData(source: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
+
   /*
    * After this point these are not really overridden methods.
    * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -74,49 +112,47 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
 
   /* Document overrides */
 
-  static " fvtt_types_internal_document_name_static": "Actor";
-
   // Same as Document for now
-  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+  protected static override _initializationOrder(): Generator<[string, DataField.Any], void, undefined>;
 
-  readonly parentCollection: Actor.ParentCollectionName | null;
+  override readonly parentCollection: Actor.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): Actor.ImplementationClass;
+  static override get implementation(): Actor.ImplementationClass;
 
-  static get baseDocument(): typeof BaseActor;
+  static override get baseDocument(): typeof BaseActor;
 
-  static get collectionName(): Actor.ParentCollectionName;
+  static override get collectionName(): Actor.ParentCollectionName;
 
-  static get documentName(): Actor.Name;
+  static override get documentName(): Actor.Name;
 
-  static get TYPES(): BaseActor.SubType[];
+  static override get TYPES(): BaseActor.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Actor.Hierarchy;
+  static override get hierarchy(): Actor.Hierarchy;
 
   override system: Actor.SystemOfType<SubType>;
 
   override parent: BaseActor.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = undefined>(
     data: Array<Actor.Implementation | Actor.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Actor.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Actor.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Actor.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Actor.Database.Update>,
   ): Promise<Actor.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Actor.Database.Delete>,
   ): Promise<Actor.Implementation[]>;
 
-  static override create<Temporary extends boolean | undefined = false>(
+  static override create<Temporary extends boolean | undefined = undefined>(
     data: Actor.CreateData | Actor.CreateData[],
     operation?: Actor.Database.CreateOperation<Temporary>,
   ): Promise<Document.TemporaryIf<Actor.Implementation, Temporary> | undefined>;
@@ -151,22 +187,24 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
     // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
     // However this causes a number of errors.
     operation?: object,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
 
   override updateEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
     embeddedName: EmbeddedName,
     updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
     operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>> | undefined>;
 
   override deleteEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
     embeddedName: EmbeddedName,
     ids: Array<string>,
     operation?: Document.Database.DeleteOperationForName<EmbeddedName>,
-  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>>>;
+  ): Promise<Array<Document.StoredForName<EmbeddedName>>>;
 
   // Same as Document for now
-  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+  override traverseEmbeddedDocuments(
+    _parentPath?: string,
+  ): Generator<[string, Document.AnyChild<this>], void, undefined>;
 
   override getFlag<Scope extends Actor.Flags.Scope, Key extends Actor.Flags.Key<Scope>>(
     scope: Scope,
@@ -184,116 +222,135 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
-    data: Actor.CreateData,
-    options: Actor.Database.PreCreateOptions,
-    user: User.Implementation,
-  ): Promise<boolean | void>;
-
-  protected _onCreate(data: Actor.CreateData, options: Actor.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(data: Actor.CreateData, options: Actor.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Actor.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Actor.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Actor.Implementation[],
     operation: Actor.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _onUpdate(
     changed: Actor.UpdateData,
-    options: Actor.Database.PreUpdateOptions,
-    user: User.Implementation,
-  ): Promise<boolean | void>;
-
-  protected _onUpdate(changed: Actor.UpdateData, options: Actor.Database.OnUpdateOperation, userId: string): void;
+    options: Actor.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Actor.Implementation[],
     operation: Actor.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Actor.Implementation[],
     operation: Actor.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Actor.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Actor.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Actor.Implementation[],
     operation: Actor.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Actor.Implementation[],
     operation: Actor.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): true;
-
   // These data field things have been ticketed but will probably go into backlog hell for a while.
   // We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
-  protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
 
-  protected static _addDataFieldMigration(
-    data: AnyObject,
+  // options: not null (parameter default only in _addDataFieldShim)
+  protected static override _addDataFieldShims(
+    data: AnyMutableObject,
+    shims: Record<string, string>,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  // options: not null (parameter default only)
+  protected static override _addDataFieldShim(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  protected static override _addDataFieldMigration(
+    data: AnyMutableObject,
     oldKey: string,
     newKey: string,
-    apply?: (data: AnyObject) => unknown,
-  ): unknown;
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
 
-  protected static _logDataFieldMigration(
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
     oldKey: string,
     newKey: string,
     options?: LogCompatibilityWarningOptions,
   ): void;
 
-  protected static _onCreateDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
+   */
+  protected static override _onCreateDocuments(
     documents: Actor.Implementation[],
     context: Document.ModificationContext<Actor.Parent>,
   ): Promise<void>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
+   */
+  protected static override _onUpdateDocuments(
     documents: Actor.Implementation[],
     context: Document.ModificationContext<Actor.Parent>,
   ): Promise<void>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
+   */
+  protected static override _onDeleteDocuments(
     documents: Actor.Implementation[],
     context: Document.ModificationContext<Actor.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Actor.Schema>;
+  protected static override _schema: SchemaField<Actor.Schema>;
 
-  static get schema(): SchemaField<Actor.Schema>;
+  static override get schema(): SchemaField<Actor.Schema>;
 
-  static validateJoint(data: Actor.Source): void;
+  static override validateJoint(data: Actor.Source): void;
 
-  static override fromSource(
-    source: Actor.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Actor.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Actor.CreateData, context?: DataModel.FromSourceOptions): Actor.Implementation;
 
   static override fromJSON(json: string): Actor.Implementation;
 
-  #baseActor: true;
+  static #BaseActor: true;
 }
 
 declare namespace BaseActor {
   export import Name = Actor.Name;
+  export import ConstructionContext = Actor.ConstructionContext;
   export import ConstructorArgs = Actor.ConstructorArgs;
   export import Hierarchy = Actor.Hierarchy;
   export import Metadata = Actor.Metadata;
@@ -313,44 +370,33 @@ declare namespace BaseActor {
   export import Invalid = Actor.Invalid;
   export import Stored = Actor.Stored;
   export import Source = Actor.Source;
-  export import PersistedData = Actor.PersistedData;
   export import CreateData = Actor.CreateData;
   export import InitializedData = Actor.InitializedData;
   export import UpdateData = Actor.UpdateData;
   export import Schema = Actor.Schema;
   export import DatabaseOperation = Actor.Database;
   export import Flags = Actor.Flags;
+  export import GetDefaultArtworkReturn = Actor.GetDefaultArtworkReturn;
+  export import GetDefaultArtworkTextureReturn = Actor.GetDefaultArtworkTextureReturn;
+
+  namespace Internal {
+    // Note(LukeAbby): The point of this is to give the base class of `Actor` a name.
+    // The expression `ClientDocumentMixin(BaseActor)` is more intuitive but it has worse
+    // caching, likely due to the majority of tsc's caching working off of names.
+    // See https://gist.github.com/LukeAbby/18a928fdc35c5d54dc121ed5dbf412fd.
+    interface ClientDocument extends foundry.documents.abstract.ClientDocumentMixin.Mix<typeof BaseActor> {}
+    const ClientDocument: ClientDocument;
+  }
 
   // The document subclasses override `system` anyways.
   // There's no point in doing expensive computation work comparing the base class system.
+
   /** @internal */
   interface _Schema extends Actor.Schema {
     // For performance reasons don't bother calculating the `system` field.
     // This is overridden anyways.
     system: any;
   }
-
-  /**
-   * @deprecated This type is used by Foundry too vaguely.
-   * In one context the most correct type is after initialization whereas in another one it should be
-   * before but Foundry uses it interchangeably.
-   */
-  interface Properties extends SchemaField.InitializedData<Schema> {}
-
-  /**
-   * @deprecated {@link BaseActor.SubType | `BaseActor.SubType`}
-   */
-  type TypeNames = Game.Model.TypeNames<"Actor">;
-
-  /**
-   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BaseActor.Schema>`}
-   */
-  interface SchemaField extends foundry.data.fields.SchemaField<Schema> {}
-
-  /**
-   * @deprecated {@link BaseActor.CreateData | `BaseActor.CreateData`}
-   */
-  interface ConstructorData extends SchemaField.CreateData<Schema> {}
 }
 
 export default BaseActor;