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

package/src/foundry/client-esm/data/client-backend.d.mts

@@ -1,4 +1,4 @@
-import type { ConstructorOf } from "../../../types/utils.d.mts";
+import type { FixedInstanceType, LoggingLevels } from "#utils";
 import type Document from "../../common/abstract/document.d.mts";
 import type {
   DatabaseGetOperation,
@@ -6,35 +6,34 @@ import type {
   DatabaseUpdateOperation,
   DatabaseDeleteOperation,
 } from "../../common/abstract/_types.d.mts";
-import type { LoggingLevels } from "../../../types/helperTypes.d.mts";
 
 /**
  * The client-side database backend implementation which handles Document modification operations.
  */
 declare class ClientDatabaseBackend extends foundry.abstract.DatabaseBackend {
-  protected override _getDocuments<T extends Document.Any>(
-    documentClass: ConstructorOf<T>,
+  protected override _getDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
     request: DatabaseGetOperation,
-    user: User.ConfiguredInstance,
-  ): Promise<T[]>;
-
-  protected override _createDocuments<T extends Document.Any>(
-    documentClass: ConstructorOf<T>,
-    request: DatabaseCreateOperation<T>,
-    user: User.ConfiguredInstance,
-  ): Promise<T[]>;
-
-  protected override _updateDocuments<T extends Document.Any>(
-    documentClass: ConstructorOf<T>,
-    request: DatabaseUpdateOperation<T>,
-    user: User.ConfiguredInstance,
-  ): Promise<T[]>;
-
-  protected override _deleteDocuments<T extends Document.Any>(
-    documentClass: ConstructorOf<T>,
+    user: User.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
+
+  protected override _createDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
+    request: DatabaseCreateOperation<FixedInstanceType<T>>,
+    user: User.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
+
+  protected override _updateDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
+    request: DatabaseUpdateOperation<FixedInstanceType<T>>,
+    user: User.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
+
+  protected override _deleteDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
     request: DatabaseDeleteOperation,
-    user: User.ConfiguredInstance,
-  ): Promise<T[]>;
+    user: User.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
 
   /**
    * Activate the Socket event listeners used to receive responses from events which modify database documents

package/src/foundry/client-esm/data/region-behaviors/_module.d.mts

@@ -1,17 +1,14 @@
 // 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 */
 
-// This `export {}` can be removed when something is exported.
-export {};
-
-// TODO: Implement these files.
-// export { default as RegionBehaviorType } from "./base.mjs";
-// export { default as AdjustDarknessLevelRegionBehaviorType } from "./adjust-darkness-level.mjs";
-// export { default as ExecuteMacroRegionBehaviorType } from "./execute-macro.mjs";
-// export { default as ExecuteScriptRegionBehaviorType } from "./execute-script.mjs";
-// export { default as PauseGameRegionBehaviorType } from "./pause-game.mjs";
-// export { default as SuppressWeatherRegionBehaviorType } from "./suppress-weather.mjs";
-// export { default as TeleportTokenRegionBehaviorType } from "./teleport-token.mjs";
-// export { default as ToggleBehaviorRegionBehaviorType } from "./toggle-behavior.mjs";
+export { default as RegionBehaviorType } from "./base.mjs";
+export { default as AdjustDarknessLevelRegionBehaviorType } from "./adjust-darkness-level.mjs";
+export { default as DisplayScrollingTextRegionBehaviorType } from "./display-scrolling-text.mjs";
+export { default as ExecuteMacroRegionBehaviorType } from "./execute-macro.mjs";
+export { default as ExecuteScriptRegionBehaviorType } from "./execute-script.mjs";
+export { default as PauseGameRegionBehaviorType } from "./pause-game.mjs";
+export { default as SuppressWeatherRegionBehaviorType } from "./suppress-weather.mjs";
+export { default as TeleportTokenRegionBehaviorType } from "./teleport-token.mjs";
+export { default as ToggleBehaviorRegionBehaviorType } from "./toggle-behavior.mjs";

package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts

@@ -0,0 +1,56 @@
+import type RegionBehaviorType from "./base.d.mts";
+import type { Brand } from "#utils";
+import fields = foundry.data.fields;
+import type { InvertObject } from "../../../common/utils/helpers.d.mts";
+
+declare namespace AdjustDarknessLevelRegionBehaviorType {
+  type MODES = Brand<number, "AdjustDarknessLevelRegionBehaviorType.MODES">;
+
+  interface Modes
+    extends Readonly<{
+      /**
+       * Override the darkness level with the modifier.
+       */
+      OVERRIDE: 0 & MODES;
+
+      /**
+       * Brighten the darkness level: `darknessLevel * (1 - modifier)`
+       */
+      BRIGHTEN: 1 & MODES;
+
+      /**
+       * Darken the darkness level: `1 - (1 - darknessLevel) * (1 - modifier)`.
+       */
+      DARKEN: 2 & MODES;
+    }> {}
+
+  interface Schema extends foundry.data.fields.DataSchema {
+    mode: fields.NumberField<{
+      required: true;
+      choices: InvertObject<Modes>;
+      initial: typeof AdjustDarknessLevelRegionBehaviorType.MODES.OVERRIDE;
+      validationError: string;
+    }>;
+    modifier: fields.AlphaField<{ initial: number; step: number }>;
+  }
+}
+
+/** The data model for a behavior that allows to suppress weather effects within the Region */
+declare class AdjustDarknessLevelRegionBehaviorType extends RegionBehaviorType<AdjustDarknessLevelRegionBehaviorType.Schema> {
+  #adjustDarknessLevelRegionBehaviorType: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.adjustDarknessLevel", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  /** Darkness level behavior modes. */
+  static get MODES(): AdjustDarknessLevelRegionBehaviorType.Modes;
+
+  static override defineSchema(): AdjustDarknessLevelRegionBehaviorType.Schema;
+
+  static override events: Record<string, RegionBehaviorType.EventBehaviorStaticHandler>;
+
+  // _onUpdate is overridden but without signature changes.
+  // For type simplicity it is left off. Methods like this historically have been the source of a large amount of computation from tsc.
+}
+
+export default AdjustDarknessLevelRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/base.d.mts

@@ -0,0 +1,59 @@
+import type TypeDataModel from "../../../common/abstract/type-data.d.mts";
+import type { AnyObject, EmptyObject } from "#utils";
+
+import fields = foundry.data.fields;
+
+declare namespace RegionBehaviorType {
+  type EventBehaviorStaticHandler = (event: RegionDocument.RegionEvent) => Promise<void>;
+
+  type EventsField = fields.SetField<
+    fields.StringField<{ required: true; choices: Record<CONST.REGION_EVENTS, string> }>,
+    { label: string; hint: string }
+  >;
+}
+
+/** The data model for a behavior that receives Region events. */
+declare class RegionBehaviorType<
+  Schema extends foundry.data.fields.DataSchema,
+  Parent extends RegionBehavior.Implementation = RegionBehavior.Implementation,
+  BaseData extends AnyObject = EmptyObject,
+  DerivedData extends AnyObject = EmptyObject,
+> extends TypeDataModel<Schema, Parent, BaseData, DerivedData> {
+  /** Create the events field. */
+  protected static _createEventsField(options?: {
+    /** The event names to restrict to. */
+    events?: string[];
+    /** The initial set of events that should be default for the field */
+    initial?: string[];
+  }): RegionBehaviorType.EventsField;
+
+  /**
+   * A RegionBehaviorType may register to always receive certain events by providing a record of handler functions.
+   * These handlers are called with the behavior instance as its bound scope.
+   */
+  static events: Record<string, RegionBehaviorType.EventBehaviorStaticHandler>;
+
+  /**
+   * The events that are handled by this behavior
+   * @defaultValue `new Set()`
+   */
+  events: Set<string>;
+
+  /** A convenience reference to the RegionBehavior which contains this behavior sub-type */
+  get behavior(): RegionBehavior.Implementation | null;
+
+  /** A convenience reference to the RegionDocument which contains this behavior sub-type.*/
+  get region(): RegionDocument.Implementation | null;
+
+  /** A convenience reference to the Scene which contains this behavior sub-type. */
+  get scene(): Scene.Implementation | null;
+
+  /**
+   * Handle the Region event.
+   * @param event     - The Region event
+   * @internal
+   */
+  protected _handleRegionEvent(event: RegionDocument.RegionEvent): Promise<void>;
+}
+
+export default RegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts

@@ -0,0 +1,64 @@
+import type RegionBehaviorType from "./base.d.mts";
+import type { Brand } from "#utils";
+import fields = foundry.data.fields;
+import type { InvertObject } from "../../../common/utils/helpers.d.mts";
+
+declare namespace DisplayScrollingTextRegionBehaviorType {
+  type VISIBILITY_MODES = Brand<number, "DisplayScrollingTextRegionBehaviorType.VISIBILITY_MODES">;
+
+  interface VisibilityModes
+    extends Readonly<{
+      /**
+       * Display only for gamemaster users
+       */
+      GAMEMASTER: 0;
+
+      /**
+       * Display only for users with observer permissions on the triggering token (and for the GM)
+       */
+      OBSERVER: 1;
+
+      /**
+       * Display for all users
+       */
+      ANYONE: 2;
+    }> {}
+
+  interface Schema extends foundry.data.fields.DataSchema {
+    events: RegionBehaviorType.EventsField;
+
+    /** The text to display */
+    text: fields.StringField<{ required: true }>;
+
+    /** Optional color setting for the text */
+    color: fields.ColorField<{ required: true; nullable: false; initial: string }>;
+
+    /** Which users the scrolling text will display for (see {@link VISIBILITY_MODES | `VISIBILITY_MODES`}) */
+    visibility: fields.NumberField<{
+      required: true;
+      choices: InvertObject<VisibilityModes>;
+      initial: typeof DisplayScrollingTextRegionBehaviorType.VISIBILITY_MODES.GAMEMASTER;
+      validationError: string;
+    }>;
+
+    /** Disable the behavior after it triggers once */
+    once: fields.BooleanField;
+  }
+}
+
+/** The data model for a behavior that displays scrolling text above a token when one of the subscribed events occurs. */
+declare class DisplayScrollingTextRegionBehaviorType extends RegionBehaviorType<DisplayScrollingTextRegionBehaviorType.Schema> {
+  #displayScrollingTextRegionBehaviorType: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.displayScrollingText", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  /** Darkness level behavior modes. */
+  static get VISIBILITY_MODES(): DisplayScrollingTextRegionBehaviorType.VisibilityModes;
+
+  static override defineSchema(): DisplayScrollingTextRegionBehaviorType.Schema;
+
+  protected override _handleRegionEvent(event: RegionDocument.RegionEvent): Promise<void>;
+}
+
+export default DisplayScrollingTextRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/execute-macro.d.mts

@@ -0,0 +1,27 @@
+import type RegionBehaviorType from "./base.d.mts";
+import fields = foundry.data.fields;
+
+declare namespace ExecuteMacroRegionBehaviorType {
+  interface Schema extends foundry.data.fields.DataSchema {
+    events: RegionBehaviorType.EventsField;
+
+    /** The Macro UUID */
+    uuid: fields.DocumentUUIDField<{ type: "Macro" }>;
+
+    everyone: fields.BooleanField;
+  }
+}
+
+/** The data model for a behavior that executes a Macro. */
+declare class ExecuteMacroRegionBehaviorType extends RegionBehaviorType<ExecuteMacroRegionBehaviorType.Schema> {
+  #executeMacroRegionBehaviorType: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.executeMacro", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): ExecuteMacroRegionBehaviorType.Schema;
+
+  protected override _handleRegionEvent(event: RegionDocument.RegionEvent): Promise<void>;
+}
+
+export default ExecuteMacroRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/execute-script.d.mts

@@ -0,0 +1,23 @@
+import type RegionBehaviorType from "./base.d.mts";
+import fields = foundry.data.fields;
+
+declare namespace ExecuteScriptRegionBehaviorType {
+  interface Schema extends foundry.data.fields.DataSchema {
+    events: RegionBehaviorType.EventsField;
+
+    /** The source code of the script */
+    source: fields.JavaScriptField<{ async: true; gmOnly: true }>;
+  }
+}
+
+/** The data model for a behavior that executes a script. */
+declare class ExecuteScriptRegionBehaviorType extends RegionBehaviorType<ExecuteScriptRegionBehaviorType.Schema> {
+  /** @defaultValue `["BEHAVIOR.TYPES.executeScript", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): ExecuteScriptRegionBehaviorType.Schema;
+
+  protected override _handleRegionEvent(event: RegionDocument.RegionEvent): Promise<void>;
+}
+
+export default ExecuteScriptRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/pause-game.d.mts

@@ -0,0 +1,23 @@
+import type RegionBehaviorType from "./base.d.mts";
+import fields = foundry.data.fields;
+
+declare namespace PauseGameRegionBehaviorType {
+  interface Schema extends foundry.data.fields.DataSchema {
+    /** Disable the behavior once a player-controlled Token enters the region? */
+    once: fields.BooleanField;
+  }
+}
+
+/** The data model for a behavior that pauses the game when a player-controlled Token enters the Region. */
+declare class PauseGameRegionBehaviorType extends RegionBehaviorType<PauseGameRegionBehaviorType.Schema> {
+  #pauseGameRegionBehaviorType: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.pauseGame", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): PauseGameRegionBehaviorType.Schema;
+
+  static override events: Record<string, RegionBehaviorType.EventBehaviorStaticHandler>;
+}
+
+export default PauseGameRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/suppress-weather.d.mts

@@ -0,0 +1,17 @@
+import type RegionBehaviorType from "./base.d.mts";
+
+declare namespace SuppressWeatherRegionBehaviorType {
+  interface Schema extends foundry.data.fields.DataSchema {}
+}
+
+/** The data model for a behavior that allows to suppress weather effects within the Region */
+declare class SuppressWeatherRegionBehaviorType extends RegionBehaviorType<SuppressWeatherRegionBehaviorType.Schema> {
+  #suppressWeatherRegionBehaviorType: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.suppressWeather", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override events: Record<string, RegionBehaviorType.EventBehaviorStaticHandler>;
+}
+
+export default SuppressWeatherRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/teleport-token.d.mts

@@ -0,0 +1,32 @@
+import type RegionBehaviorType from "./base.d.mts";
+import fields = foundry.data.fields;
+
+declare namespace TeleportTokenRegionBehaviorType {
+  interface Schema extends foundry.data.fields.DataSchema {
+    /** The destination Region the Token is teleported to. */
+    destination: fields.DocumentUUIDField<{ type: "Region" }>;
+
+    choice: fields.BooleanField;
+  }
+}
+
+/** The data model for a behavior that teleports Token that enter the Region to a preset destination Region. */
+declare class TeleportTokenRegionBehaviorType extends RegionBehaviorType<TeleportTokenRegionBehaviorType.Schema> {
+  #teleportTokenRegionBehavior: true;
+
+  /** @defaultValue `["BEHAVIOR.TYPES.teleportToken", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): TeleportTokenRegionBehaviorType.Schema;
+
+  static override events: Record<string, RegionBehaviorType.EventBehaviorStaticHandler>;
+
+  /**
+   * Activate the Socket event listeners.
+   * @param socket      - The active game socket
+   * @internal
+   */
+  protected static _activateSocketListeners(socket: WebSocket): void;
+}
+
+export default TeleportTokenRegionBehaviorType;

package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts

@@ -0,0 +1,31 @@
+import type RegionBehaviorType from "./base.d.mts";
+import fields = foundry.data.fields;
+
+declare namespace ToggleBehaviorRegionBehaviorType {
+  interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+  interface Schema extends foundry.data.fields.DataSchema {
+    events: RegionBehaviorType.EventsField;
+
+    /** The Region Behavior UUIDs that are enabled. */
+    enable: fields.SetField<fields.DocumentUUIDField<{ type: "RegionBehavior" }>>;
+
+    /** The Region Behavior UUIDs that are disabled. */
+    disable: fields.SetField<fields.DocumentUUIDField<{ type: "RegionBehavior" }>>;
+  }
+}
+
+/** The data model for a behavior that toggles Region Behaviors when one of the subscribed events occurs. */
+declare class ToggleBehaviorRegionBehaviorType extends RegionBehaviorType<ToggleBehaviorRegionBehaviorType.Schema> {
+  /** @defaultValue `["BEHAVIOR.TYPES.toggleBehavior", "BEHAVIOR.TYPES.base"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): ToggleBehaviorRegionBehaviorType.Schema;
+
+  /** @throws If there's any overlap between the `data.enable` and `data.disable` sets */
+  static override validateJoint(data: ToggleBehaviorRegionBehaviorType.Source): void;
+
+  protected override _handleRegionEvent(event: RegionDocument.RegionEvent): Promise<void>;
+}
+
+export default ToggleBehaviorRegionBehaviorType;

package/src/foundry/client-esm/dice/_module.d.mts

@@ -1,8 +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 */
-/* eslint-disable import/no-unresolved */ // TODO: Remove when the files are instantiated
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export * as types from "./_types.mjs";
 export * as terms from "./terms/_module.mjs";

package/src/foundry/client-esm/dice/parser.d.mts

@@ -1,3 +1,4 @@
+import type { Identity } from "../../../utils/index.d.mts";
 import type {
   DiceRollParseNode,
   FunctionRollParseNode,
@@ -44,8 +45,6 @@ declare class RollParser {
     error: (error: string) => void,
   ): RollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle a dice term.
    * @param number - The number of dice.
@@ -64,8 +63,6 @@ declare class RollParser {
     formula: string,
   ): DiceRollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle a numeric term.
    * @param number - The number.
@@ -74,8 +71,6 @@ declare class RollParser {
    */
   protected _onNumericTerm(number: number, flavor: string): NumericRollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle a math term.
    * @param fn - The Math function.
@@ -93,8 +88,6 @@ declare class RollParser {
     formula: string,
   ): FunctionRollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle a pool term.
    * @param head - The first term.
@@ -112,8 +105,6 @@ declare class RollParser {
     formula: string,
   ): PoolRollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle a parenthetical.
    * @param term - The inner term.
@@ -123,8 +114,6 @@ declare class RollParser {
    */
   protected _onParenthetical(term: RollParseNode, flavor: string | null, formula: string): ParentheticalRollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Handle some string that failed to be classified.
    * @param term - The term.
@@ -132,16 +121,12 @@ declare class RollParser {
    */
   protected _onStringTerm(term: string, flavor: string | null): StringParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Collapse multiple additive operators into a single one.
    * @param operators - A sequence of additive operators.
    */
   protected _collapseOperators(operators: string[]): string;
 
-  /* -------------------------------------------- */
-
   /**
    * Wrap a term with a leading minus.
    * @param term - The term to wrap.
@@ -157,8 +142,6 @@ declare class RollParser {
    */
   static flattenTree(root: RollParseNode): RollParseNode[];
 
-  /* -------------------------------------------- */
-
   /**
    * Use the Shunting Yard algorithm to convert a parse tree or list of terms into an AST with correct operator
    * precedence.
@@ -167,12 +150,10 @@ declare class RollParser {
    */
   static toAST(root: RollParseNode | RollTerm[]): RollParseNode;
 
-  /* -------------------------------------------- */
-
   /**
    * Determine if a given node is an operator term.
    */
-  static isOperatorTerm(node: RollParseNode | RollTerm): void;
+  static isOperatorTerm(node: RollParseNode | RollTerm): boolean;
 
   /* -------------------------------------------- */
   /*  Debug Formatting                            */
@@ -184,16 +165,12 @@ declare class RollParser {
    */
   static formatList(list: RollParseArg[]): string;
 
-  /* -------------------------------------------- */
-
   /**
    * Format a parser argument.
    * @param arg - The argument.
    */
   static formatArg(arg: RollParseArg): string;
 
-  /* -------------------------------------------- */
-
   /**
    * Format arguments for debugging.
    * @param method - The method name.
@@ -202,4 +179,13 @@ declare class RollParser {
   static formatDebug(method: string, ...args: RollParseArg[]): string;
 }
 
+declare namespace RollParser {
+  interface AnyConstructor extends Identity<typeof AnyRollParser> {}
+  interface Any extends AnyRollParser {}
+}
+
+declare abstract class AnyRollParser extends RollParser {
+  constructor(...args: never);
+}
+
 export default RollParser;