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

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

@@ -1,10 +1,9 @@
-import type { AnyMutableObject, AnyObject, InexactPartial } from "fvtt-types/utils";
+import type { AnyMutableObject, Identity } from "#utils";
 import type Document from "../abstract/document.mts";
-import type { fields } from "../data/_module.d.mts";
-import type { CONST, documents } from "#client-esm/client.d.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
 import type DataModel from "../abstract/data.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
+import type EmbeddedCollection from "../abstract/embedded-collection.d.mts";
 
 /**
  * The ActorDelta Document.
@@ -21,54 +20,87 @@ declare abstract class BaseActorDelta<
    * @param data    - Initial data from which to construct the `BaseActorDelta`
    * @param context - Construction context options
    *
-   * @deprecated Constructing `BaseActorDelta` directly is not advised. The base document classes exist in
+   * @remarks Constructing `BaseActorDelta` 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 ActorDelta.implementation | `new ActorDelta.implementation(...)`} instead which will give you
    * a system specific implementation of `ActorDelta`.
    */
-  constructor(...args: ActorDelta.ConstructorArgs);
+  // Note(LukeAbby): `data` is not actually required but `context.parent` is.
+  constructor(data: ActorDelta.CreateData | undefined, context: ActorDelta.ConstructionContext);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "ActorDelta",
+   *   collection: "delta",
+   *   label: "DOCUMENT.ActorDelta",
+   *   labelPlural: "DOCUMENT.ActorDeltas",
+   *   isEmbedded: true,
+   *   embedded: {
+   *     Item: "items",
+   *     ActiveEffect: "effects"
+   *   },
+   *   permissions: {
+   *     create: "OWNER",
+   *     delete: "OWNER"
+   *   }
+   *   schemaVersion: "13.341"
+   * });
+   * ```
+   */
   static override metadata: BaseActorDelta.Metadata;
 
   static override defineSchema(): BaseActorDelta.Schema;
 
-  override canUserModify(
-    user: User.Internal.Implementation,
-    action: "create" | "update" | "delete",
-    data?: AnyObject,
-  ): boolean;
-
-  override testUserPermission(
-    user: User.Internal.Implementation,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
-  ): boolean;
+  override getUserLevel(user: User.Implementation): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
 
   /**
    * Retrieve the base actor's collection, if it exists.
    * @param collectionName - The collection name.
+   * @remarks Passes `collectionName` to the token's `baseActor`'s {@link Actor.getEmbeddedCollection | `#getEmbeddedCollection`}
    */
-  getBaseCollection(collectionName: string): Collection<Actor.Implementation> | undefined;
+  getBaseCollection<DocType extends Actor.Embedded.Name>(
+    collectionName: DocType,
+  ): EmbeddedCollection<Document.ImplementationFor<DocType>, Actor.Implementation> | undefined;
 
+  /**
+   * Apply an ActorDelta to an Actor and return the resultant synthetic Actor.
+   * @param delta     - The ActorDelta.
+   * @param baseActor - The base Actor.
+   * @param context   - Context to supply to synthetic Actor instantiation.
+   * @remarks `baseActor` is documented as being a `BaseActor` but in practice can only ever be `Actor.Implementation`
+   */
   static applyDelta(
     delta: BaseActorDelta,
-    baseActor: documents.BaseActor,
-    context: unknown,
-  ): Document.ImplementationClassFor<"Actor"> | null;
+    baseActor: Actor.Implementation,
+    context?: BaseActorDelta.ApplyDeltaContext,
+  ): Actor.Implementation | null;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - {@link foundry.documents.BaseActor.migrateData | `BaseActor`}'s
+   *
+   * Simply forwards to `BaseActor`
+   */
   static migrateData(source: AnyMutableObject): AnyMutableObject;
 
-  // TODO: Figure out if this override still applies
-  toObject(source: true): this["_source"];
-  toObject(source?: boolean): ReturnType<this["schema"]["toObject"]>;
+  /**
+   * Prepare changes to a descendent delta collection.
+   * @param changes - Candidate source changes. (default: `{}`)
+   * @param options - Options which determine how the new data is merged. (default: `{}`)
+   */
+  protected _prepareDeltaUpdate(changes: ActorDelta.UpdateData, options: DataModel.UpdateOptions): void;
+
+  /** @remarks passes to {@linkcode _prepareDeltaUpdate} prior to calling super */
+  override updateSource(changes?: ActorDelta.UpdateData, options?: DataModel.UpdateOptions): ActorDelta.UpdateData;
+
+  /** @remarks Strips optional (`required: false`) fields from the object before returning */
+  // TODO: Properly type this override
+  override toObject(source?: boolean): SchemaField.SourceData<ActorDelta.Schema>;
 
   /*
    * After this point these are not really overridden methods.
@@ -82,49 +114,47 @@ declare abstract class BaseActorDelta<
 
   /* Document overrides */
 
-  static " fvtt_types_internal_document_name_static": "ActorDelta";
-
   // 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: ActorDelta.ParentCollectionName | null;
+  override readonly parentCollection: ActorDelta.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): ActorDelta.ImplementationClass;
 
-  static get baseDocument(): typeof BaseActorDelta;
+  static override get baseDocument(): typeof BaseActorDelta;
 
-  static get collectionName(): ActorDelta.ParentCollectionName;
+  static override get collectionName(): ActorDelta.ParentCollectionName;
 
-  static get documentName(): ActorDelta.Name;
+  static override get documentName(): ActorDelta.Name;
 
-  static get TYPES(): BaseActorDelta.SubType[];
+  static override get TYPES(): BaseActorDelta.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): ActorDelta.Hierarchy;
+  static override get hierarchy(): ActorDelta.Hierarchy;
 
   override system: ActorDelta.SystemOfType<SubType>;
 
   override parent: BaseActorDelta.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = undefined>(
     data: Array<ActorDelta.Implementation | ActorDelta.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<ActorDelta.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<ActorDelta.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: ActorDelta.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<ActorDelta.Database.Update>,
   ): Promise<ActorDelta.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<ActorDelta.Database.Delete>,
   ): Promise<ActorDelta.Implementation[]>;
 
-  static override create<Temporary extends boolean | undefined = false>(
+  static override create<Temporary extends boolean | undefined = undefined>(
     data: ActorDelta.CreateData | ActorDelta.CreateData[],
     operation?: ActorDelta.Database.CreateOperation<Temporary>,
   ): Promise<Document.TemporaryIf<ActorDelta.Implementation, Temporary> | undefined>;
@@ -159,22 +189,24 @@ declare abstract class BaseActorDelta<
     // 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 ActorDelta.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 ActorDelta.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 ActorDelta.Flags.Scope, Key extends ActorDelta.Flags.Key<Scope>>(
     scope: Scope,
@@ -192,127 +224,159 @@ declare abstract class BaseActorDelta<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: ActorDelta.CreateData,
     options: ActorDelta.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: ActorDelta.CreateData,
     options: ActorDelta.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: ActorDelta.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<ActorDelta.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: ActorDelta.Implementation[],
     operation: ActorDelta.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: ActorDelta.UpdateData,
     options: ActorDelta.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: ActorDelta.UpdateData,
     options: ActorDelta.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: ActorDelta.Implementation[],
     operation: ActorDelta.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: ActorDelta.Implementation[],
     operation: ActorDelta.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: ActorDelta.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: ActorDelta.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: ActorDelta.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: ActorDelta.Implementation[],
     operation: ActorDelta.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: ActorDelta.Implementation[],
     operation: ActorDelta.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: ActorDelta.Implementation[],
     context: Document.ModificationContext<ActorDelta.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: ActorDelta.Implementation[],
     context: Document.ModificationContext<ActorDelta.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: ActorDelta.Implementation[],
     context: Document.ModificationContext<ActorDelta.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<ActorDelta.Schema>;
+  protected static override _schema: SchemaField<ActorDelta.Schema>;
 
-  static get schema(): SchemaField<ActorDelta.Schema>;
+  static override get schema(): SchemaField<ActorDelta.Schema>;
 
-  static validateJoint(data: ActorDelta.Source): void;
+  static override validateJoint(data: ActorDelta.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: ActorDelta.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): ActorDelta.Implementation;
 
   static override fromJSON(json: string): ActorDelta.Implementation;
+
+  static #BaseActorDelta: true;
 }
 
 export default BaseActorDelta;
 
 declare namespace BaseActorDelta {
+  interface Any extends AnyBaseActorDelta {}
+  interface AnyConstructor extends Identity<typeof AnyBaseActorDelta> {}
+
   export import Name = ActorDelta.Name;
+  export import ConstructionContext = ActorDelta.ConstructionContext;
   export import ConstructorArgs = ActorDelta.ConstructorArgs;
   export import Hierarchy = ActorDelta.Hierarchy;
   export import Metadata = ActorDelta.Metadata;
@@ -332,7 +396,6 @@ declare namespace BaseActorDelta {
   export import Invalid = ActorDelta.Invalid;
   export import Stored = ActorDelta.Stored;
   export import Source = ActorDelta.Source;
-  export import PersistedData = ActorDelta.PersistedData;
   export import CreateData = ActorDelta.CreateData;
   export import InitializedData = ActorDelta.InitializedData;
   export import UpdateData = ActorDelta.UpdateData;
@@ -340,30 +403,40 @@ declare namespace BaseActorDelta {
   export import DatabaseOperation = ActorDelta.Database;
   export import Flags = ActorDelta.Flags;
 
+  /**
+   * This interface is spread into an object that already has `parent` defined, and as this is ActorDelta logic,
+   * let's assume that overwriting the parent is contraindicated.
+   *
+   * @internal
+   */
+  type _ApplyDeltaContext = Omit<Document.ConstructionContext<TokenDocument.Implementation>, "parent">;
+
+  interface ApplyDeltaContext extends _ApplyDeltaContext {
+    /**
+     * @deprecated This context is spread into an `Actor` creation context for the synthetic actor,
+     * overriding the provided default of `parent: delta.parent` is nonsensical
+     */
+    parent?: never;
+  }
+
+  namespace Internal {
+    // Note(LukeAbby): The point of this is to give the base class of `ActorDelta` a name.
+    // The expression `ClientDocumentMixin(BaseActorDelta)` 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 BaseActorDelta> {}
+    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 ActorDelta.Schema {
     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.
-   */
-  type Properties = fields.SchemaField.InitializedData<Schema>;
-
-  /** @deprecated {@link BaseActorDelta.SubType | `BaseActorDelta.SubType`} */
-  type TypeNames = Game.Model.TypeNames<"Actor">;
-
-  /**
-   * @deprecated {@link fields.SchemaField | `SchemaField<BaseActorDelta.Schema>`}
-   */
-  type SchemaField = fields.SchemaField<Schema>;
-
-  /**
-   * @deprecated {@link BaseActorDelta.CreateData | `BaseActorDelta.CreateData`}
-   */
-  type ConstructorData = fields.SchemaField.CreateData<Schema>;
+declare abstract class AnyBaseActorDelta extends BaseActorDelta<BaseActorDelta.SubType> {
+  constructor(...args: never);
 }