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

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

@@ -1,4 +1,4 @@
-import type { AnyObject } from "../../../utils/index.d.mts";
+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";
@@ -29,20 +29,34 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
    */
   constructor(...args: Combat.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Combat",
+   *   collection: "combats",
+   *   label: "DOCUMENT.Combat",
+   *   labelPlural: "DOCUMENT.Combats",
+   *   embedded: {
+   *     Combatant: "combatants"
+   *   },
+   *   hasTypeData: true,
+   *   permissions: {
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseCombat.Metadata;
 
   static override defineSchema(): BaseCombat.Schema;
 
-  /**
-   * Is a user able to update an existing Combat?
-   * @internal
-   */
-  static #canUpdate(user: User.Implementation, doc: BaseCombat, data: BaseCombat.UpdateData): boolean;
-
   /**
    * Can a certain User change the Combat round?
    * @param user - The user attempting to change the round
    * @returns Is the user allowed to change the round?
+   * @remarks Foundry's implementation always returns `true`
    */
   protected _canChangeRound(user: User.Implementation): boolean;
 
@@ -50,6 +64,7 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
    * Can a certain User change the Combat turn?
    * @param user - The user attempting to change the turn
    * @returns Is the user allowed to change the turn?
+   * @remarks Foundry's implementation always returns `true`
    */
   protected _canChangeTurn(user: User.Implementation): boolean;
 
@@ -70,39 +85,39 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Combat.ParentCollectionName | null;
+  override readonly parentCollection: Combat.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): Combat.ImplementationClass;
+  static override get implementation(): Combat.ImplementationClass;
 
-  static get baseDocument(): typeof BaseCombat;
+  static override get baseDocument(): typeof BaseCombat;
 
-  static get collectionName(): Combat.ParentCollectionName;
+  static override get collectionName(): Combat.ParentCollectionName;
 
-  static get documentName(): Combat.Name;
+  static override get documentName(): Combat.Name;
 
-  static get TYPES(): BaseCombat.SubType[];
+  static override get TYPES(): BaseCombat.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Combat.Hierarchy;
+  static override get hierarchy(): Combat.Hierarchy;
 
   override system: Combat.SystemOfType<SubType>;
 
   override parent: BaseCombat.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Combat.Implementation | Combat.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Combat.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Combat.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Combat.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Combat.Database.Update>,
   ): Promise<Combat.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Combat.Database.Delete>,
   ): Promise<Combat.Implementation[]>;
@@ -175,110 +190,148 @@ declare abstract class BaseCombat<out SubType extends BaseCombat.SubType = BaseC
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Combat.CreateData,
     options: Combat.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Combat.CreateData, options: Combat.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(
+    data: Combat.CreateData,
+    options: Combat.Database.OnCreateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Combat.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Combat.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Combat.Implementation[],
     operation: Combat.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Combat.UpdateData,
     options: Combat.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Combat.UpdateData, options: Combat.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Combat.UpdateData,
+    options: Combat.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Combat.Implementation[],
     operation: Combat.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Combat.Implementation[],
     operation: Combat.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Combat.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Combat.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Combat.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Combat.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Combat.Implementation[],
     operation: Combat.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Combat.Implementation[],
     operation: Combat.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): true;
+  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.
-  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: Combat.Implementation[],
     context: Document.ModificationContext<Combat.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: Combat.Implementation[],
     context: Document.ModificationContext<Combat.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: Combat.Implementation[],
     context: Document.ModificationContext<Combat.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Combat.Schema>;
+  protected static override _schema: SchemaField<Combat.Schema>;
 
-  static get schema(): SchemaField<Combat.Schema>;
+  static override get schema(): SchemaField<Combat.Schema>;
 
-  static validateJoint(data: Combat.Source): void;
+  static override validateJoint(data: Combat.Source): void;
 
-  static override fromSource(
-    source: Combat.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Combat.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Combat.CreateData, context?: DataModel.FromSourceOptions): Combat.Implementation;
 
   static override fromJSON(json: string): Combat.Implementation;
+
+  static #BaseCombat: true;
 }
 
 export default BaseCombat;

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

@@ -1,4 +1,4 @@
-import type { AnyObject } from "../../../utils/index.d.mts";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DOCUMENT_OWNERSHIP_LEVELS } from "../constants.d.mts";
@@ -28,23 +28,35 @@ declare abstract class BaseCombatant<
    */
   constructor(...args: Combatant.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Combatant",
+   *   collection: "combatants",
+   *   label: "DOCUMENT.Combatant",
+   *   labelPlural: "DOCUMENT.Combatants",
+   *   isEmbedded: true,
+   *   hasTypeData: true,
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseCombatant.Metadata;
 
   static override defineSchema(): BaseCombatant.Schema;
 
   /**
-   * Is a user able to update an existing Combatant?
-   * @internal
-   */
-  static #canUpdate(user: User.Implementation, doc: BaseCombatant, data: BaseCombatant.UpdateData): boolean;
-
-  /**
-   * Is a user able to create this Combatant?
-   * @internal
+   * @remarks Uses `game.user` if `user` is falsey.
+   *
+   * Returns {@link DOCUMENT_OWNERSHIP_LEVELS.OWNER | `OWNER`} if `user.isGM`, otherwise forwards to `this.actor?.getUserLevel(user)`.
+   * If thats nullish, returns {@link DOCUMENT_OWNERSHIP_LEVELS.NONE | `NONE`}
    */
-  static #canCreate(user: User.Implementation, doc: BaseCombatant, data: BaseCombatant.CreateData): boolean;
-
-  override getUserLevel(user?: User.Implementation): DOCUMENT_OWNERSHIP_LEVELS | null;
+  override getUserLevel(user?: User.Implementation | null): DOCUMENT_OWNERSHIP_LEVELS;
 
   /*
    * After this point these are not really overridden methods.
@@ -63,39 +75,39 @@ declare abstract class BaseCombatant<
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Combatant.ParentCollectionName | null;
+  override readonly parentCollection: Combatant.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): Combatant.ImplementationClass;
 
-  static get baseDocument(): typeof BaseCombatant;
+  static override get baseDocument(): typeof BaseCombatant;
 
-  static get collectionName(): Combatant.ParentCollectionName;
+  static override get collectionName(): Combatant.ParentCollectionName;
 
-  static get documentName(): Combatant.Name;
+  static override get documentName(): Combatant.Name;
 
-  static get TYPES(): BaseCombatant.SubType[];
+  static override get TYPES(): BaseCombatant.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Combatant.Hierarchy;
+  static override get hierarchy(): Combatant.Hierarchy;
 
   override system: Combatant.SystemOfType<SubType>;
 
   override parent: BaseCombatant.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Combatant.Implementation | Combatant.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Combatant.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Combatant.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Combatant.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Combatant.Database.Update>,
   ): Promise<Combatant.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Combatant.Database.Delete>,
   ): Promise<Combatant.Implementation[]>;
@@ -135,119 +147,151 @@ declare abstract class BaseCombatant<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Combatant.CreateData,
     options: Combatant.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Combatant.CreateData, options: Combatant.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(
+    data: Combatant.CreateData,
+    options: Combatant.Database.OnCreateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Combatant.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Combatant.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Combatant.Implementation[],
     operation: Combatant.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Combatant.UpdateData,
     options: Combatant.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: Combatant.UpdateData,
     options: Combatant.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Combatant.Implementation[],
     operation: Combatant.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Combatant.Implementation[],
     operation: Combatant.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: Combatant.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: Combatant.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Combatant.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Combatant.Implementation[],
     operation: Combatant.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Combatant.Implementation[],
     operation: Combatant.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): true;
+  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.
-  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: Combatant.Implementation[],
     context: Document.ModificationContext<Combatant.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: Combatant.Implementation[],
     context: Document.ModificationContext<Combatant.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: Combatant.Implementation[],
     context: Document.ModificationContext<Combatant.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Combatant.Schema>;
+  protected static override _schema: SchemaField<Combatant.Schema>;
 
-  static get schema(): SchemaField<Combatant.Schema>;
+  static override get schema(): SchemaField<Combatant.Schema>;
 
-  static validateJoint(data: Combatant.Source): void;
+  static override validateJoint(data: Combatant.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: Combatant.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): Combatant.Implementation;
 
   static override fromJSON(json: string): Combatant.Implementation;
 
-  #baseCombatant: true;
+  static #BaseCombatant: true;
 }
 
 export default BaseCombatant;