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

package/src/foundry/client/data/_module.d.mts

@@ -0,0 +1,13 @@
+// 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-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+// export * as types from "./_types.mjs";
+export * from "#common/data/_module.mjs";
+export * as regionBehaviors from "./region-behaviors/_module.mjs";
+export * as regionShapes from "./region-shapes/_module.mjs";
+export * from "./terrain-data.mjs";
+export { default as CombatConfiguration } from "./combat-config.mjs";
+export { default as ClientDatabaseBackend } from "./client-backend.mjs";
+export { default as CalendarData, SIMPLIFIED_GREGORIAN_CALENDAR_CONFIG } from "./calendar.mjs";

package/src/foundry/client/data/calendar.d.mts

@@ -0,0 +1,341 @@
+import type DataModel from "#common/abstract/data.d.mts";
+import type * as fields from "#common/data/fields.mjs";
+import type { AnyObject, IntentionalPartial } from "#utils";
+
+declare namespace CalendarData {
+  interface Schema extends fields.DataSchema {
+    /** The name of the calendar being used. */
+    name: fields.StringField<{ required: true; blank: false }>;
+
+    /** A text description of the calendar configuration. */
+    description: fields.StringField;
+
+    /** Configuration of years. */
+    years: fields.SchemaField<ConfigYears.Schema, { required: true; nullable: true; initial: null }>;
+
+    /** Configuration of months. */
+    months: fields.SchemaField<ConfigMonths.Schema, { required: true; nullable: true; initial: null }>;
+
+    /** Configuration of days. */
+    days: fields.SchemaField<ConfigDays.Schema>;
+
+    /** Configuration of seasons. */
+    seasons: fields.SchemaField<ConfigSeasons.Schema, { required: true; nullable: true; initial: null }>;
+  }
+
+  /**
+   * The data put in {@linkcode CalendarData._source}.
+   */
+  interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+  /**
+   * The data necessary to create a document. Used in places like {@linkcode WallDocument.create}
+   * and {@link WallDocument | `new WallDocument(...)`}.
+   *
+   * For example a {@link fields.SetField | `SetField`} can accept any {@linkcode Iterable}
+   * with the right values. This means you can pass a `Set` instance, an array of values,
+   * a generator, or any other iterable.
+   * @remarks Equivalent to how Foundry uses CalendarConfig, this is the type of `CONFIG.calendar`
+   */
+  interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+
+  /**
+   * The data after a {@linkcode DataModel} has been initialized, for example
+   * {@link CalendarData.name | `CalenderData#name`}.
+   *
+   * This is data transformed from {@linkcode CalendarData.Source} and turned into more
+   * convenient runtime data structures. For example a source value of `undefined` will be replaced
+   * by the `initial` value of the field instance.
+   */
+  interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+  /** A definition of a year within a calendar. */
+  namespace ConfigYears {
+    interface Schema extends fields.DataSchema {
+      /** The year which is considered year 0 in the calendar. */
+      yearZero: fields.NumberField<{ required: true; nullable: false; integer: true }>;
+
+      /** The index of days.values that is the first weekday at time=0 */
+      firstWeekday: fields.NumberField<{ required: true; nullable: false; min: 0; integer: true }>;
+
+      /** A definition of how leap years work within a calendar. */
+      leapYear: fields.SchemaField<ConfigLeapYear.Schema, { required: true; nullable: true; initial: null }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** A definition of how leap years work within a calendar. */
+  namespace ConfigLeapYear {
+    interface Schema extends fields.DataSchema {
+      /** The year number of the first leap year. On or after yearZero. */
+      leapStart: fields.NumberField<{ required: true; nullable: false; integer: true }>;
+
+      /** The number of years between leap years. */
+      leapInterval: fields.NumberField<{ required: true; nullable: false; min: 1; integer: true }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** Month related configuration for a calendar. */
+  namespace ConfigMonths {
+    interface Schema extends fields.DataSchema {
+      /** An array of months in the calendar year. */
+      values: fields.ArrayField<fields.SchemaField<ConfigMonth.Schema>>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** A definition of a month within a calendar year. */
+  namespace ConfigMonth {
+    interface Schema extends fields.DataSchema {
+      /** The full name of the month. */
+      name: fields.StringField<{ required: true; blank: false }>;
+
+      /** The abbreviated name of the month. */
+      abbreviation: fields.StringField;
+
+      /** The ordinal position of this month in the year. */
+      ordinal: fields.NumberField<{ required: true; nullable: false; min: 1; integer: true }>;
+
+      /** The number of days in the month. */
+      days: fields.NumberField<{ required: true; nullable: false }>;
+
+      /** The number of days in the month during a leap year. If not defined the value of days is used. */
+      leapDays: fields.NumberField<{ required: false; nullable: true }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** Day related configuration for a calendar. */
+  namespace ConfigDays {
+    interface Schema extends fields.DataSchema {
+      /** The configuration of the days of the week. */
+      values: fields.ArrayField<fields.SchemaField<ConfigDay.Schema>, { required: true; nullable: false }>;
+
+      /** The number of days in a year. */
+      daysPerYear: fields.NumberField<{ required: true; nullable: false; positive: true }>;
+
+      /** The number of hours in a day. */
+      hoursPerDay: fields.NumberField<{ required: true; nullable: false; positive: true }>;
+
+      /** The number of minutes in an hour. */
+      minutesPerHour: fields.NumberField<{ required: true; nullable: false; positive: true }>;
+
+      /** The number of seconds in a minute. */
+      secondsPerMinute: fields.NumberField<{ required: true; nullable: false; positive: true }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** A definition of the days of the week within a calendar. */
+  namespace ConfigDay {
+    interface Schema extends fields.DataSchema {
+      /** The full name of the weekday. */
+      name: fields.StringField<{ required: true; blank: false }>;
+
+      /** The abbreviated name of the weekday. */
+      abbreviation: fields.StringField;
+
+      /** The ordinal position of this weekday in the week. */
+      ordinal: fields.NumberField<{ required: true; nullable: false; min: 1; integer: true }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** Season related configuration for a calendar. */
+  namespace ConfigSeasons {
+    interface Schema extends fields.DataSchema {
+      /** An array of seasons in the calendar year. */
+      values: fields.ArrayField<fields.SchemaField<ConfigSeason.Schema>>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /** A definition of a season within a calendar year. */
+  namespace ConfigSeason {
+    interface Schema extends fields.DataSchema {
+      /** The full name of the season. */
+      name: fields.StringField<{ required: true; blank: false }>;
+
+      /** The abbreviated name of the season. */
+      abbreviation: fields.StringField;
+
+      /** The ordinal month in which the season starts. */
+      monthStart: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
+
+      /** The day of the month on which the season starts. */
+      dayStart: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
+
+      /** The ordinal month in which the season ends. */
+      monthEnd: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
+
+      /** The day of the month on which the season ends. */
+      dayEnd: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
+    }
+
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  }
+
+  /**
+   * A decomposition of the integer world time in seconds into component parts.
+   * Each component expresses the number of that temporal unit since the time=0 epoch.
+   */
+  interface TimeComponents {
+    /** The number of years completed since zero. */
+    year: number;
+
+    /** The number of days completed within the year. */
+    day: number;
+
+    /**
+     * The number of hours completed within the year.
+     * @remarks This should say "completed within the _day_"
+     */
+    hour: number;
+
+    /** The number of minutes completed within the hour. */
+    minute: number;
+
+    /** The number of seconds completed within the minute. */
+    second: number;
+
+    /** The month, an index of the months.values array. */
+    month: number;
+
+    /** The day of the month, starting from zero. */
+    dayOfMonth: number;
+
+    /** The weekday, an index of the days.values array. */
+    dayOfWeek: number;
+
+    /** The season, an index of the seasons.values array. */
+    season: number;
+
+    /** Is it a leap year? */
+    leapYear: boolean;
+  }
+
+  interface PartialTimeComponents extends IntentionalPartial<TimeComponents> {}
+
+  /** @returns The returned string format */
+  type TimeFormatter = (
+    /** The configured calendar */
+    calendar: CalendarData<TimeComponents>,
+
+    /** Time components to format */
+    components: TimeComponents,
+
+    /** Additional formatting options */
+    options: AnyObject,
+  ) => string;
+
+  type FormatterName = keyof typeof CONFIG.time.formatters;
+  type Formatter = FormatterName | TimeFormatter;
+  type FormatterOptions<Formatter extends CalendarData.Formatter> = Parameters<
+    Formatter extends FormatterName ? (typeof CONFIG.time.formatters)[Formatter] : Formatter
+  >[1];
+
+  interface FormatAgoOptions {
+    /** @defaultValue `false` */
+    short?: boolean | undefined;
+
+    maxTerms?: number | undefined;
+  }
+}
+
+/**
+ * Game Time Calendar configuration data model.
+ */
+declare class CalendarData<Components extends CalendarData.TimeComponents> extends DataModel<CalendarData.Schema> {
+  /**
+   * Expand a world time integer into an object containing the relevant time components.
+   * @param components - An amount of time expressed as components
+   * @returns The cumulative time in seconds
+   */
+  componentsToTime(components: Partial<Components>): number;
+
+  /**
+   * Modify some start time by adding a number of seconds or components to it. The delta components may be negative.
+   * @param startTime - The initial time
+   * @param deltaTime - Differential components to add
+   * @returns The resulting time
+   */
+  add(startTime: number | Components, deltaTime: number | Components): Components;
+
+  /**
+   * Compute the difference between some new time and some other time.
+   * @param endTime   - A time to difference relative to the start time.
+   * @param startTime - The starting time. If not provided the current world time is used.
+   * @returns The time difference expressed as components
+   */
+  difference(endTime: number | Components, startTime?: number | Components): Components;
+
+  /**
+   * Format a time using one of several supported display formats.
+   * @param time      - The time components to format, by default the current world time.
+   * @param formatter - The formatter function applied to the time. If a string is provided, it must be a function configured in {@linkcode CONFIG.time.formatters}. (default: `"timestamp"`)
+   * @param options   - Options passed to the formatter function (default: `{}`)
+   * @returns The formatted date and time string
+   * @remarks Throws an error if `formatter` is a string and the formatter by that name is not found
+   */
+  format<Formatter extends CalendarData.Formatter>(
+    time?: number | Components,
+    formatter?: Formatter,
+    options?: CalendarData.FormatterOptions<Formatter>,
+  ): string;
+
+  /**
+   * Test whether a year is a leap year.
+   * @param year - The year to test
+   * @returns Is it a leap year?
+   */
+  isLeapYear(year: number): boolean;
+
+  /**
+   * Expand a world time integer into an object containing the relevant time components.
+   * @param time - A time in seconds (default: `0`)
+   * @returns The time expressed as components
+   */
+  timeToComponents(time: number): Components;
+
+  /** Format time components as a YYYY-MM-DD HH:MM:SS timestamp. */
+  static formatTimestamp(
+    calendar: CalendarData<CalendarData.TimeComponents>,
+    components: CalendarData.TimeComponents,
+    _options?: AnyObject,
+  ): string;
+
+  /** Format time components as "\{years\}, \{days\}, \{hours\}, \{minutes\}, \{seconds\} ago". */
+  static formatAgo(
+    calendar: CalendarData<CalendarData.TimeComponents>,
+    components: CalendarData.TimeComponents,
+    options?: CalendarData.FormatAgoOptions,
+  ): string;
+}
+
+export const SIMPLIFIED_GREGORIAN_CALENDAR_CONFIG: CalendarData.CreateData;
+
+export default CalendarData;

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

@@ -0,0 +1,52 @@
+import type { FixedInstanceType, LoggingLevels } from "#utils";
+import type Document from "#common/abstract/document.d.mts";
+import type {
+  DatabaseGetOperation,
+  DatabaseUpdateOperation,
+  DatabaseDeleteOperation,
+} from "#common/abstract/_types.d.mts";
+
+import Game = foundry.Game;
+
+/**
+ * The client-side database backend implementation which handles Document modification operations.
+ */
+declare class ClientDatabaseBackend extends foundry.abstract.DatabaseBackend {
+  protected override _getDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
+    request: DatabaseGetOperation,
+    user: User.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
+
+  protected override _createDocuments<T extends Document.AnyConstructor>(
+    documentClass: T,
+    operation: Document.Database.CreateOperationForName<T["documentName"], boolean | undefined>,
+    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.Implementation,
+  ): Promise<FixedInstanceType<T>[]>;
+
+  /**
+   * Activate the Socket event listeners used to receive responses from events which modify database documents
+   * @param socket - The active game socket
+   */
+  activateSocketListeners(socket: Game["socket"]): void;
+
+  override getFlagScopes(): string[];
+
+  override getCompendiumScopes(): string[];
+
+  protected override _log(level: LoggingLevels, message: string): void;
+}
+
+export default ClientDatabaseBackend;

package/src/foundry/client/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/data/region-behaviors/base.d.mts

@@ -0,0 +1,60 @@
+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/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 {@linkcode 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/data/region-behaviors/teleport-token.d.mts

@@ -0,0 +1,31 @@
+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>;
+
+  /**
+   * The query handler for teleporation confirmation.
+   * @internal
+   */
+  static _confirmQuery(queryData: { behaviorUuid: string; token: string }): Promise<boolean>;
+}
+
+export default TeleportTokenRegionBehaviorType;

package/src/foundry/client/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/data/region-shapes/_module.d.mts

@@ -0,0 +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-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export * from "./polygon-tree.mjs";
+export * from "./shape.mjs";