@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 12.331.4-beta

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

@@ -1,8 +1,8 @@
-import type { AnyObject } from "../../../types/utils.mts";
+import type { AnyMutableObject, AnyObject } from "fvtt-types/utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
-import type { PrototypeToken } from "../data/data.mts";
-import type * as fields from "../data/fields.d.mts";
-import type * as documents from "./_module.d.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Actor Document.
@@ -11,20 +11,23 @@ import type * as documents from "./_module.d.mts";
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare class BaseActor extends Document<"Actor", BaseActor.Schema, any> {
+declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubType> extends Document<
+  "Actor",
+  BaseActor._Schema,
+  any
+> {
   /**
-   * @privateRemarks Manual override of the return due to TS limitations with static `this`
-   */
-  static get TYPES(): BaseActor.TypeNames[];
-
-  /**
-   * @param data    - Initial data from which to construct the Actor
+   * @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
+   * 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`.
    */
-  // TODO(LukeAbby): This constructor is causing a circular error.
-  // constructor(data: BaseActor.ConstructorData, context?: Document.ConstructionContext<BaseActor.Parent>);
-
-  override parent: BaseActor.Parent;
+  constructor(...args: Actor.ConstructorArgs);
 
   static override metadata: BaseActor.Metadata;
 
@@ -40,129 +43,314 @@ declare class BaseActor extends Document<"Actor", BaseActor.Schema, any> {
    * Determine default artwork based on the provided actor data
    * @param actorData - The source actor data
    */
-  static getDefaultArtwork(actorData: BaseActor.ConstructorData): {
+  static getDefaultArtwork(actorData: BaseActor.CreateData): {
     img: string;
     texture: { src: string };
   };
 
   protected override _initializeSource(
-    data: BaseActor.ConstructorData | this,
+    data: BaseActor.CreateData | this,
     options?: Omit<foundry.abstract.DataModel.DataValidationOptions, "parent">,
   ): BaseActor.Source;
 
-  static override canUserCreate(user: documents.BaseUser): boolean;
+  static override canUserCreate(user: User.Implementation): boolean;
 
   /**
-   * Is a user able to create this actor?
-   * @param user - The user attempting the creation operation.
-   * @param doc  - The Actor being created.
-   * @internal
+   * @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.
    */
-  static #canCreate(user: documents.BaseUser, doc: BaseActor): boolean;
 
-  /**
-   * Is a user able to update an existing actor?
-   * @param user - The user attempting the update operation.
-   * @param doc  - The Actor being updated.
-   * @param data - The update delta being applied.
-   * @internal
-   */
-  static #canUpdate(user: documents.BaseUser, doc: BaseActor, data: BaseActor.UpdateData): boolean;
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
-  /**
-   * @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.
+  /*
+   * 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.
    */
 
-  static override migrateData(source: AnyObject): AnyObject;
+  /* Document overrides */
+
+  static " fvtt_types_internal_document_name_static": "Actor";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  readonly parentCollection: Actor.ParentCollectionName | null;
+
+  readonly pack: string | null;
+
+  static get implementation(): Actor.ImplementationClass;
+
+  static get baseDocument(): typeof BaseActor;
+
+  static get collectionName(): Actor.ParentCollectionName;
+
+  static get documentName(): Actor.Name;
+
+  static get TYPES(): BaseActor.SubType[];
+
+  static get hasTypeData(): true;
+
+  static get hierarchy(): Actor.Hierarchy;
+
+  override system: Actor.SystemOfType<SubType>;
+
+  override parent: BaseActor.Parent;
+
+  static createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<Actor.Implementation | Actor.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<Actor.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<Actor.Implementation, Temporary>>>;
+
+  static updateDocuments(
+    updates: Actor.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Actor.Database.Update>,
+  ): Promise<Actor.Implementation[]>;
+
+  static deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<Actor.Database.Delete>,
+  ): Promise<Actor.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: Actor.CreateData | Actor.CreateData[],
+    operation?: Actor.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<Actor.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: Actor.UpdateData | undefined,
+    operation?: Actor.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: Actor.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: Actor.Database.GetOptions): Actor.Implementation | null;
+
+  static override getCollectionName<CollectionName extends Actor.Embedded.Name>(
+    name: CollectionName,
+  ): Actor.Embedded.CollectionNameOf<CollectionName> | null;
+
+  override getEmbeddedCollection<EmbeddedName extends Actor.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+  ): Actor.Embedded.CollectionFor<EmbeddedName>;
+
+  override getEmbeddedDocument<EmbeddedName extends Actor.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+    id: string,
+    options: Document.GetEmbeddedDocumentOptions,
+  ): Actor.Embedded.DocumentFor<EmbeddedName> | undefined;
+
+  override createEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    data: Document.CreateDataForName<EmbeddedName>[] | undefined,
+    // TODO(LukeAbby): The correct signature would be:
+    // 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>;
+
+  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>;
+
+  override deleteEmbeddedDocuments<EmbeddedName extends Actor.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    ids: Array<string>,
+    operation?: Document.Database.DeleteOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>>>;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends Actor.Flags.Scope, Key extends Actor.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<Actor.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends Actor.Flags.Scope,
+    Key extends Actor.Flags.Key<Scope>,
+    Value extends Document.GetFlag<Actor.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends Actor.Flags.Scope, Key extends Actor.Flags.Key<Scope>>(
+    scope: Scope,
+    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 static _preCreateOperation(
+    documents: Actor.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Actor.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _onCreateOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected _preUpdate(
+    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;
+
+  protected static _preUpdateOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _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 _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
+
+  protected static _preDeleteOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _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,
+    oldKey: string,
+    newKey: string,
+    apply?: (data: AnyObject) => unknown,
+  ): unknown;
+
+  protected static _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
+  protected static _onCreateDocuments(
+    documents: Actor.Implementation[],
+    context: Document.ModificationContext<Actor.Parent>,
+  ): Promise<void>;
+
+  protected static _onUpdateDocuments(
+    documents: Actor.Implementation[],
+    context: Document.ModificationContext<Actor.Parent>,
+  ): Promise<void>;
+
+  protected static _onDeleteDocuments(
+    documents: Actor.Implementation[],
+    context: Document.ModificationContext<Actor.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static _schema: SchemaField<Actor.Schema>;
+
+  static get schema(): SchemaField<Actor.Schema>;
+
+  static validateJoint(data: Actor.Source): void;
+
+  static override fromSource(
+    source: Actor.CreateData,
+    { strict, ...context }?: DataModel.FromSourceOptions,
+  ): Actor.Implementation;
+
+  static override fromJSON(json: string): Actor.Implementation;
+
+  #baseActor: true;
 }
 
 declare namespace BaseActor {
-  type Parent = null;
+  export import Name = Actor.Name;
+  export import ConstructorArgs = Actor.ConstructorArgs;
+  export import Hierarchy = Actor.Hierarchy;
+  export import Metadata = Actor.Metadata;
+  export import SubType = Actor.SubType;
+  export import ConfiguredSubTypes = Actor.ConfiguredSubTypes;
+  export import Known = Actor.Known;
+  export import OfType = Actor.OfType;
+  export import SystemOfType = Actor.SystemOfType;
+  export import Parent = Actor.Parent;
+  export import Descendant = Actor.Descendant;
+  export import DescendantClass = Actor.DescendantClass;
+  export import Pack = Actor.Pack;
+  export import Embedded = Actor.Embedded;
+  export import ParentCollectionName = Actor.ParentCollectionName;
+  export import CollectionClass = Actor.CollectionClass;
+  export import Collection = Actor.Collection;
+  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;
+
+  // 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">;
 
-  type Metadata = Document.MetadataFor<BaseActor>;
-
-  type SchemaField = fields.SchemaField<Schema>;
-  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
-  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
-  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
-  type Source = fields.SchemaField.InnerPersistedType<Schema>;
-
-  interface Schema extends DataSchema {
-    /**
-     * The _id which uniquely identifies this Actor document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /** The name of this Actor */
-    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
-
-    /** An Actor subtype which configures the system data model applied */
-    type: fields.DocumentTypeField<typeof BaseActor>;
-
-    /**
-     * An image file path which provides the artwork for this Actor
-     * @defaultValue `null`
-     */
-    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 {@link PrototypeToken}
-     */
-    prototypeToken: fields.EmbeddedDataField<typeof PrototypeToken>;
-
-    /**
-     * A Collection of Item embedded Documents
-     * @defaultValue `[]`
-     */
-    items: fields.EmbeddedCollectionField<typeof documents.BaseItem, Actor.ConfiguredInstance>;
-
-    /**
-     * A Collection of ActiveEffect embedded Documents
-     * @defaultValue `[]`
-     */
-    effects: fields.EmbeddedCollectionField<typeof documents.BaseActiveEffect, Actor.ConfiguredInstance>;
-
-    /**
-     * 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}
-     */
-    _stats: fields.DocumentStatsField;
-  }
+  /**
+   * @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;