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

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

@@ -101,8 +101,6 @@ export type SceneData = BaseScene.Properties;
 
 export type GridData = BaseScene.Properties["grid"];
 
-// TODO: Remove when BaseScene's schema is updated.
-// @ts-expect-error This still has to be typed
 export type EnvironmentData = BaseScene.Properties["environment"]["base"];
 
 export interface _GlobalLightData {
@@ -110,12 +108,8 @@ export interface _GlobalLightData {
   bright: boolean;
 }
 
-// TODO: Remove when BaseScene's schema is updated.
-// @ts-expect-error This still has to be typed
 export type GlobalLightData = BaseScene.Properties["environment"]["globalLight"];
 
-// TODO: Remove when BaseScene's schema is updated.
-// @ts-expect-error This still has to be typed
 export type SceneEnvironmentData = BaseScene.Properties["environment"];
 
 export type RegionData = BaseRegion.Properties;

package/src/foundry/common/documents/active-effect.d.mts

@@ -1,7 +1,6 @@
-import type { AnyObject, AnyMutableObject, InexactPartial } 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 * as CONST from "../constants.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
@@ -27,31 +26,67 @@ declare abstract class BaseActiveEffect<
    */
   constructor(...args: ActiveEffect.ConstructorArgs);
 
-  override canUserModify(user: User.Implementation, action: "create" | "update" | "delete", data?: AnyObject): boolean;
-
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "ActiveEffect",
+   *   collection: "effects",
+   *   hasTypeData: true,
+   *   label: "DOCUMENT.ActiveEffect",
+   *   labelPlural: "DOCUMENT.ActiveEffects",
+   *   schemaVersion: "12.324"
+   * });
+   * ```
+   */
   static override metadata: BaseActiveEffect.Metadata;
 
   static override defineSchema(): BaseActiveEffect.Schema;
 
-  override testUserPermission(
+  /**
+   * @remarks If `this.isEmbedded`, uses `this.parent.canUserModify(user, "update")`, dropping `data` and forcing `action`,
+   * otherwise `super`'s (with all arguments forwarded). Core's `Actor` implementation doesn't override this method, and while
+   * core's `Item` does, it only mirrors this functionality, so without further extension all roads lead to {@link Document.canUserModify | `Document#canUserModify`}
+   */
+  // data: not null (parameter default only)
+  override canUserModify<Action extends "create" | "update" | "delete">(
     user: User.Implementation,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    action: Action,
+    data?: Document.CanUserModifyData<ActiveEffect.Schema, Action>,
   ): boolean;
 
   /**
-   * @privateRemarks _preCreate overridden but with no signature changes.
-   * For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
+   * @remarks If `this.isEmbedded`, uses `this.parent.testUserPermission`, otherwise `super`'s. Core's `Actor` implementation
+   * doesn't override this method, and `Item` only optionally forwards to `Actor`, so without further extension all roads
+   * lead to {@link Document.testUserPermission | `Document#testUserPermission`}
    */
+  // options: not null (destructured)
+  override testUserPermission(
+    user: User.Implementation,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
+  ): boolean;
+
+  // _preCreate overridden but with no signature changes.
+  // For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `label` to `name` (since v11, no specified end)
+   * - `icon` to `img` (since v12, no specified end)
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
+  /**
+   * @remarks
+   * Shims:
+   * - `label` to `name` (since v11, until v13)
+   * - `icon` to `img` (since v12, until v14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
+
   /**
    * @deprecated since v11, will be removed in v13
    * @remarks Replaced by `name`
@@ -85,39 +120,39 @@ declare abstract class BaseActiveEffect<
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: ActiveEffect.ParentCollectionName | null;
+  override readonly parentCollection: ActiveEffect.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): ActiveEffect.ImplementationClass;
+  static override get implementation(): ActiveEffect.ImplementationClass;
 
-  static get baseDocument(): typeof BaseActiveEffect;
+  static override get baseDocument(): typeof BaseActiveEffect;
 
-  static get collectionName(): ActiveEffect.ParentCollectionName;
+  static override get collectionName(): ActiveEffect.ParentCollectionName;
 
-  static get documentName(): ActiveEffect.Name;
+  static override get documentName(): ActiveEffect.Name;
 
-  static get TYPES(): BaseActiveEffect.SubType[];
+  static override get TYPES(): BaseActiveEffect.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): ActiveEffect.Hierarchy;
+  static override get hierarchy(): ActiveEffect.Hierarchy;
 
   override system: ActiveEffect.SystemOfType<SubType>;
 
   override parent: BaseActiveEffect.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<ActiveEffect.Implementation | ActiveEffect.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<ActiveEffect.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<ActiveEffect.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: ActiveEffect.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<ActiveEffect.Database.Update>,
   ): Promise<ActiveEffect.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<ActiveEffect.Database.Delete>,
   ): Promise<ActiveEffect.Implementation[]>;
@@ -160,118 +195,146 @@ declare abstract class BaseActiveEffect<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: ActiveEffect.CreateData,
     options: ActiveEffect.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: ActiveEffect.CreateData,
     options: ActiveEffect.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: ActiveEffect.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<ActiveEffect.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: ActiveEffect.Implementation[],
     operation: ActiveEffect.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: ActiveEffect.UpdateData,
     options: ActiveEffect.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: ActiveEffect.UpdateData,
     options: ActiveEffect.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: ActiveEffect.Implementation[],
     operation: ActiveEffect.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: ActiveEffect.Implementation[],
     operation: ActiveEffect.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: ActiveEffect.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: ActiveEffect.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: ActiveEffect.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: ActiveEffect.Implementation[],
     operation: ActiveEffect.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: ActiveEffect.Implementation[],
     operation: ActiveEffect.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: ActiveEffect.Implementation[],
     context: Document.ModificationContext<ActiveEffect.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: ActiveEffect.Implementation[],
     context: Document.ModificationContext<ActiveEffect.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: ActiveEffect.Implementation[],
     context: Document.ModificationContext<ActiveEffect.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<ActiveEffect.Schema>;
+  protected static override _schema: SchemaField<ActiveEffect.Schema>;
 
-  static get schema(): SchemaField<ActiveEffect.Schema>;
+  static override get schema(): SchemaField<ActiveEffect.Schema>;
 
-  static validateJoint(data: ActiveEffect.Source): void;
+  static override validateJoint(data: ActiveEffect.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: ActiveEffect.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): ActiveEffect.Implementation;
 
   static override fromJSON(json: string): ActiveEffect.Implementation;