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

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

@@ -1,8 +1,8 @@
-import type { AnyObject } from "../../../types/utils.mts";
+import type { AnyMutableObject } from "#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,21 +11,44 @@ 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`
+   * @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`.
    */
-  static get TYPES(): BaseActor.TypeNames[];
+  constructor(...args: Actor.ConstructorArgs);
 
   /**
-   * @param data    - Initial data from which to construct the Actor
-   * @param context - Construction context options
+   * @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: "12.324"
+   * })
+   * ```
    */
-  // TODO(LukeAbby): This constructor is causing a circular error.
-  // constructor(data: BaseActor.ConstructorData, context?: Document.ConstructionContext<BaseActor.Parent>);
-
-  override parent: BaseActor.Parent;
-
   static override metadata: BaseActor.Metadata;
 
   static override defineSchema(): BaseActor.Schema;
@@ -39,130 +62,349 @@ declare class BaseActor extends Document<"Actor", BaseActor.Schema, any> {
   /**
    * 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.ConstructorData): {
-    img: string;
-    texture: { src: string };
-  };
+  static getDefaultArtwork(actorData?: BaseActor.CreateData): BaseActor.GetDefaultArtworkReturn;
 
+  // options: not null (parameter default only)
   protected override _initializeSource(
-    data: BaseActor.ConstructorData | this,
-    options?: Omit<foundry.abstract.DataModel.DataValidationOptions, "parent">,
+    data: BaseActor.CreateData | this,
+    options?: Document.InitializeSourceOptions,
   ): BaseActor.Source;
 
-  static override canUserCreate(user: documents.BaseUser): boolean;
+  /** @remarks Returns `user.hasPermission("ACTOR_CREATE")` */
+  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
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
    */
-  static #canCreate(user: documents.BaseUser, doc: BaseActor): boolean;
+  static override migrateData(source: AnyMutableObject): 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.
+   * 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.
+   */
+
+  /* Document overrides */
+
+  static " fvtt_types_internal_document_name_static": "Actor";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: Actor.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): Actor.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseActor;
+
+  static override get collectionName(): Actor.ParentCollectionName;
+
+  static override get documentName(): Actor.Name;
+
+  static override get TYPES(): BaseActor.SubType[];
+
+  static override get hasTypeData(): true;
+
+  static override get hierarchy(): Actor.Hierarchy;
+
+  override system: Actor.SystemOfType<SubType>;
+
+  override parent: BaseActor.Parent;
+
+  static override 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 override updateDocuments(
+    updates: Actor.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Actor.Database.Update>,
+  ): Promise<Actor.Implementation[]>;
+
+  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>(
+    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 override _preCreate(
+    data: Actor.CreateData,
+    options: Actor.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(data: Actor.CreateData, options: Actor.Database.OnCreateOperation, userId: string): void;
+
+  protected static override _preCreateOperation(
+    documents: Actor.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Actor.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: Actor.UpdateData,
+    options: Actor.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: Actor.UpdateData,
+    options: Actor.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: Actor.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: Actor.Implementation[],
+    operation: Actor.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  static override 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.
+
+  // 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: AnyMutableObject) => unknown) | null,
+  ): boolean;
+
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
+  /**
+   * @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>;
 
   /**
-   * 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
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
    */
-  static #canUpdate(user: documents.BaseUser, doc: BaseActor, data: BaseActor.UpdateData): boolean;
+  protected static override _onUpdateDocuments(
+    documents: Actor.Implementation[],
+    context: Document.ModificationContext<Actor.Parent>,
+  ): Promise<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.
+   * @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>;
 
-  static override migrateData(source: AnyObject): AnyObject;
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<Actor.Schema>;
+
+  static override get schema(): SchemaField<Actor.Schema>;
+
+  static override validateJoint(data: Actor.Source): void;
+
+  // 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;
+
+  static #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;
+  export import GetDefaultArtworkReturn = Actor.GetDefaultArtworkReturn;
+  export import GetDefaultArtworkTextureReturn = Actor.GetDefaultArtworkTextureReturn;
+
+  // 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;