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

package/src/foundry/common/data/module.d.mts

@@ -1,7 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export * as validators from "./validators.mjs";
 export * as validation from "./validation-failure.mjs";

package/src/foundry/common/data/validation-failure.d.mts

@@ -1,8 +1,8 @@
 /**
  * A class responsible for recording information about a validation failure.
  */
-export class DataModelValidationFailure {
-  constructor(options: DataModelValidationFailure.ConstructorArgs);
+declare class DataModelValidationFailure {
+  constructor(options?: DataModelValidationFailure.ConstructorOptions);
 
   /**
    * The value that failed validation for this field.
@@ -68,7 +68,7 @@ export class DataModelValidationFailure {
 /**
  * A specialised Error to indicate a model validation failure.
  */
-export class DataModelValidationError extends Error {
+declare class DataModelValidationError extends Error {
   /**
    * @param failure - The failure that triggered this error or an error message
    * @param params  - Additional Error constructor parameters
@@ -129,14 +129,15 @@ export class DataModelValidationError extends Error {
 }
 
 declare namespace DataModelValidationFailure {
-  interface ConstructorArgs {
-    // The `| undefined` is redundant with `unknown` but it's provided anyways for easy auditing.
+  /** @deprecated {@link ConstructorOptions | `ConstructorOptions`} */
+  type ConstructorArgs = ConstructorOptions;
 
+  interface ConstructorOptions {
     /** The value that failed validation for this field. */
-    invalidValue?: unknown | undefined;
+    invalidValue?: unknown;
 
     /**  The value it was replaced by, if any. */
-    fallback?: unknown | undefined;
+    fallback?: unknown;
 
     /**
      * Whether the value was dropped from some parent collection.
@@ -166,9 +167,11 @@ declare namespace DataModelValidationFailure {
   }
 
   interface ToObject {
-    invalidValue?: unknown | undefined;
-    fallback?: unknown | undefined;
+    invalidValue?: unknown;
+    fallback?: unknown;
     dropped?: boolean | undefined;
     message?: string | undefined;
   }
 }
+
+export { DataModelValidationFailure, DataModelValidationError };

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

@@ -1,7 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export { default as BaseActiveEffect } from "./active-effect.mjs";
 export { default as BaseActorDelta } from "./actor-delta.mjs";
@@ -25,6 +25,8 @@ export { default as BaseMeasuredTemplate } from "./measured-template.mjs";
 export { default as BaseNote } from "./note.mjs";
 export { default as BasePlaylist } from "./playlist.mjs";
 export { default as BasePlaylistSound } from "./playlist-sound.mjs";
+export { default as BaseRegionBehavior } from "./region-behavior.mjs";
+export { default as BaseRegion } from "./region.mjs";
 export { default as BaseRollTable } from "./roll-table.mjs";
 export { default as BaseScene } from "./scene.mjs";
 export { default as BaseSetting } from "./setting.mjs";

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

@@ -1,9 +1,4 @@
 import type BaseActiveEffect from "./active-effect.d.mts";
-import type BaseActorDelta from "./actor-delta.d.mts";
-import type BaseActor from "./actor.d.mts";
-import type BaseAdventure from "./adventure.d.mts";
-import type BaseAmbientLight from "./ambient-light.d.mts";
-import type BaseAmbientSound from "./ambient-sound.d.mts";
 import type BaseCard from "./card.d.mts";
 import type BaseCards from "./cards.d.mts";
 import type BaseChatMessage from "./chat-message.d.mts";
@@ -20,6 +15,8 @@ import type BaseMeasuredTemplate from "./measured-template.d.mts";
 import type BaseNote from "./note.d.mts";
 import type BasePlaylistSound from "./playlist-sound.d.mts";
 import type BasePlaylist from "./playlist.d.mts";
+import type BaseRegionBehavior from "./region-behavior.d.mts";
+import type BaseRegion from "./region.d.mts";
 import type BaseRollTable from "./roll-table.d.mts";
 import type BaseScene from "./scene.d.mts";
 import type BaseSetting from "./setting.d.mts";
@@ -29,55 +26,30 @@ import type BaseToken from "./token.d.mts";
 import type BaseUser from "./user.d.mts";
 import type BaseWall from "./wall.d.mts";
 
+/**
+ * @deprecated This does not specify whether this is for source, initialized, or update data and
+ * is used interchangeably with all of those.
+ */
 export type ActiveEffectData = BaseActiveEffect.Properties;
 
-export type EffectDurationData = BaseActiveEffect.Properties["duration"];
+/**
+ * @deprecated {@link ActiveEffect.DurationData | `ActiveEffect.DurationData`}
+ */
+export type EffectDurationData = ActiveEffect.DurationData;
 
-// TODO(LukeAbby): This understandably adds a circular loop because `DataField` depends on `EffectChangeData`.
-// export type EffectChangeData = BaseActiveEffect.Properties["changes"][number];
-
-// TODO(LukeAbby): Audit. This is used both as an assignment, constructor, and initialized type. It's likely this isn't
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type EffectChangeData = {
-  /**
-   * The attribute path in the Actor or Item data which the change modifies
-   * @defaultValue `""`
-   */
-  key: string;
-
-  /**
-   * The value of the change effect
-   * @defaultValue `""`
-   */
-  value: string;
-
-  /**
-   * The modification mode with which the change is applied
-   * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
-   */
-  mode: number | null;
+/**
+ * @deprecated {@link ActiveEffect.EffectChangeData | `ActiveEffect.EffectChangeData`}
+ */
+export type EffectChangeData = ActiveEffect.EffectChangeData;
+export interface AmbientSoundEffect {
+  type: keyof CONFIG["soundEffects"];
 
   /**
-   * The priority level with which this change is applied
-   * @defaultValue `null`
+   * @defaultValue `5`
+   * @remarks Can't be `null` as {@link BiquadFilterNode} and {@link ConvolverNode} constructors both only have parameter defaults
    */
-  priority: number | null;
-};
-
-export type ActorData = BaseActor.Properties;
-
-export type ActorDeltaData = BaseActorDelta.Properties;
-
-export type AdventureData = BaseAdventure.Properties;
-
-export type AmbientLightData = BaseAmbientLight.Properties;
-
-export type AmbientSoundData = BaseAmbientSound.Properties;
-
-export interface AmbientSoundEffect {
-  type: string;
-  intensity: number;
-} // TODO: Audit and maybe move when BaseAmbientSound's schema is updated.
+  intensity?: number | undefined;
+} // TODO: Maybe move when BaseAmbientSound's schema is updated.
 
 export type CardData = BaseCard.Properties;
 
@@ -129,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 {
@@ -138,17 +108,13 @@ 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 = unknown; // TODO: Add when BaseRegion's schema is added.
+export type RegionData = BaseRegion.Properties;
 
-export type RegionBehaviorData = unknown; // TODO: Add when BaseRegionBehavior's schema is added.
+export type RegionBehaviorData = BaseRegionBehavior.Properties;
 
 export type SettingData = BaseSetting.Properties;