@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

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

@@ -1,279 +0,0 @@
-// 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 */
-
-import "#common/primitives/_module.mjs";
-import * as _CONST from "#common/constants.mjs";
-import * as _abstract from "#common/abstract/_module.mjs";
-import * as _documents from "#common/documents/_module.mjs";
-import * as _packages from "#common/packages/_module.mjs";
-// utils is exported here in the foundry file
-import * as _config from "#common/config.mjs";
-import * as _prosemirror from "#common/prosemirror/_module.mjs";
-import * as _grid from "#common/grid/_module.mjs";
-
-// client
-import * as _applications from "./applications/_module.mjs";
-import * as _audio from "./audio/_module.mjs";
-import * as _canvas from "./canvas/_module.mjs";
-import * as _helpers from "./helpers/_module.mjs";
-import * as _data from "./data/_module.mjs";
-import * as _dice from "./dice/_module.mjs";
-import * as _utils from "./utils/_module.mjs"; // moved here to match other client-esm exports
-
-/**
- * Constant definitions used throughout the Foundry Virtual Tabletop framework.
- */
-export * as CONST from "#common/constants.mjs";
-
-/**
- * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
- */
-export * as abstract from "#common/abstract/_module.mjs";
-
-/**
- * Application configuration options
- */
-export * as config from "#common/config.mjs";
-
-/**
- * Document definitions used throughout the Foundry Virtual Tabletop framework.
- */
-export * as documents from "#common/documents/_module.mjs";
-
-/**
- * Package data definitions, validations, and schema.
- */
-export * as packages from "#common/packages/_module.mjs";
-
-/**
- * Utility functions providing helpful functionality.
- */
-export * as utils from "#common/utils/_module.mjs";
-
-/**
- * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
- */
-export * as prosemirror from "#common/prosemirror/_module.mjs";
-
-/**
- * Grid classes.
- */
-export * as grid from "#common/grid/_module.mjs";
-
-/**
- * A library for rendering and managing HTML user interface elements within the Foundry Virtual Tabletop game client.
- */
-export * as applications from "./applications/_module.mjs";
-
-/**
- * A library for controlling audio playback within the Foundry Virtual Tabletop game client.
- */
-export * as audio from "./audio/_module.mjs";
-
-/**
- * A submodule defining concepts related to canvas rendering.
- */
-export * as canvas from "./canvas/_module.mjs";
-
-/**
- * A submodule containing core helper classes.
- */
-export * as helpers from "./helpers/_module.mjs";
-
-/**
- * A module which defines data architecture components.
- */
-export * as data from "./data/_module.mjs";
-
-/**
- * A module for parsing and executing dice roll syntax.
- */
-export * as dice from "./dice/_module.mjs";
-
-/**
- * Shared importable types.
- */
-// export * as types from "./types.mjs";
-
-declare global {
-  namespace foundry {
-    /**
-     * Constant definitions used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import CONST = _CONST;
-
-    /**
-     * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import abstract = _abstract;
-
-    /**
-     * Application configuration options
-     */
-    export import config = _config;
-
-    /**
-     * Document definitions used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import documents = _documents;
-
-    /**
-     * Package data definitions, validations, and schema.
-     */
-    export import packages = _packages;
-
-    /**
-     * Utility functions providing helpful functionality.
-     */
-    export import utils = _utils;
-
-    /**
-     * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
-     */
-    export import prosemirror = _prosemirror;
-
-    /**
-     * Grid classes.
-     */
-    export import grid = _grid;
-
-    /**
-     * A library for rendering and managing HTML user interface elements within the Foundry Virtual Tabletop game client.
-     */
-    export import applications = _applications;
-
-    /**
-     * A library for controlling audio playback within the Foundry Virtual Tabletop game client.
-     */
-    export import audio = _audio;
-
-    /**
-     * A submodule defining concepts related to canvas rendering.
-     */
-    export import canvas = _canvas;
-
-    /**
-     * A submodule containing core helper classes.
-     */
-    export import helpers = _helpers;
-
-    /**
-     * A module which defines data architecture components.
-     */
-    export import data = _data;
-
-    /**
-     * A module for parsing and executing dice roll syntax.
-     */
-    export import dice = _dice;
-  }
-
-  /**
-   * Constant definitions used throughout the Foundry Virtual Tabletop framework.
-   */
-  export import CONST = _CONST;
-
-  // Color is currently handled in src/foundry/client/head.d.mts
-
-  export import Collection = _utils.Collection;
-
-  export import Roll = _dice.Roll;
-
-  // Deprecated global namespace dump; done programmatically by fvtt
-  /** @deprecated since v12 will be removed in v14 */
-  export import Semaphore = _utils.Semaphore;
-
-  /** @deprecated since v12 will be removed in v14 */
-  export import IterableWeakMap = _utils.IterableWeakMap;
-
-  /** @deprecated since v12 will be removed in v14 */
-  export import IterableWeakSet = _utils.IterableWeakSet;
-
-  /* --- geometry --- */
-  /** @deprecated since v12 will be removed in v14 */
-  export import orient2dFast = _utils.orient2dFast;
-  /** @deprecated since v12 will be removed in v14 */
-  export import lineSegmentIntersects = _utils.lineSegmentIntersects;
-  /** @deprecated since v12 will be removed in v14 */
-  export import lineLineIntersection = _utils.lineLineIntersection;
-  /** @deprecated since v12 will be removed in v14 */
-  export import lineSegmentIntersection = _utils.lineSegmentIntersection;
-  /** @deprecated since v12 will be removed in v14 */
-  export import lineCircleIntersection = _utils.lineCircleIntersection;
-  /** @deprecated since v12 will be removed in v14 */
-  export import closestPointToSegment = _utils.closestPointToSegment;
-  /** @deprecated since v12 will be removed in v14 */
-  export import quadraticIntersection = _utils.quadraticIntersection;
-
-  /* --- helpers --- */
-  /** @deprecated since v12 will be removed in v14 */
-  export import benchmark = _utils.benchmark;
-  /** @deprecated since v12 will be removed in v14 */
-  export import threadLock = _utils.threadLock;
-  /** @deprecated since v12 will be removed in v14 */
-  export import debounce = _utils.debounce;
-  /** @deprecated since v12 will be removed in v14 */
-  export import debouncedReload = _utils.debouncedReload;
-  /** @deprecated since v12 will be removed in v14 */
-  export import deepClone = _utils.deepClone;
-  /** @deprecated since v12 will be removed in v14 */
-  export import diffObject = _utils.diffObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import objectsEqual = _utils.objectsEqual;
-  /** @deprecated since v12 will be removed in v14 */
-  export import duplicate = _utils.duplicate;
-  /** @deprecated since v12 will be removed in v14 */
-  export import isSubclass = _utils.isSubclass;
-  /** @deprecated since v12 will be removed in v14 */
-  export import getDefiningClass = _utils.getDefiningClass;
-  /** @deprecated since v12 will be removed in v14 */
-  export import encodeURL = _utils.encodeURL;
-  /** @deprecated since v12 will be removed in v14 */
-  export import expandObject = _utils.expandObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import filterObject = _utils.filterObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import flattenObject = _utils.flattenObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import getParentClasses = _utils.getParentClasses;
-  /** @deprecated since v12 will be removed in v14 */
-  export import getRoute = _utils.getRoute;
-  /** @deprecated since v12 will be removed in v14 */
-  export import getType = _utils.getType;
-  /** @deprecated since v12 will be removed in v14 */
-  export import hasProperty = _utils.hasProperty;
-  /** @deprecated since v12 will be removed in v14 */
-  export import getProperty = _utils.getProperty;
-  /** @deprecated since v12 will be removed in v14 */
-  export import setProperty = _utils.setProperty;
-  /** @deprecated since v12 will be removed in v14 */
-  export import invertObject = _utils.invertObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import isEmpty = _utils.isEmpty;
-  /** @deprecated since v12 will be removed in v14 */
-  export import mergeObject = _utils.mergeObject;
-  /** @deprecated since v12 will be removed in v14 */
-  export import parseS3URL = _utils.parseS3URL;
-  /** @deprecated since v12 will be removed in v14 */
-  export import randomID = _utils.randomID;
-  /** @deprecated since v12 will be removed in v14 */
-  export import timeSince = _utils.timeSince;
-  /** @deprecated since v12 will be removed in v14 */
-  export import formatFileSize = _utils.formatFileSize;
-  /** @deprecated since v12 will be removed in v14 */
-  export import parseUuid = _utils.parseUuid;
-
-  /* --- http --- */
-
-  /** @deprecated since v12 will be removed in v14 */
-  export import fetchWithTimeout = _utils.fetchWithTimeout;
-  /** @deprecated since v12 will be removed in v14 */
-  export import fetchJsonWithTimeout = _utils.fetchJsonWithTimeout;
-
-  /* --- logging --- */
-
-  /** @deprecated since v12 will be removed in v14 */
-  export import logCompatibilityWarning = _utils.logCompatibilityWarning;
-}

package/src/foundry/client-esm/config.d.mts

@@ -1 +0,0 @@
-// TODO: Move & Rework the CONFIG object

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

@@ -1,13 +0,0 @@
-// 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-esm/data/calendar.d.mts

@@ -1,200 +0,0 @@
-import type DataModel from "#common/abstract/data.d.mts";
-import type * as fields from "#common/data/fields.mjs";
-
-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 {@link CalendarData._source | `CalendarData._source`}.
-   */
-  interface Source extends fields.SchemaField.SourceData<Schema> {}
-
-  /**
-   * The data necessary to create a document. Used in places like {@link WallDocument.create | `WallDocument.create`}
-   * and {@link WallDocument | `new WallDocument(...)`}.
-   *
-   * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `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 {@link DataModel | `DataModel`} has been initialized, for example
-   * {@link CalendarData.name | `CalenderData#name`}.
-   *
-   * This is data transformed from {@link CalendarData.Source | `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 day of the week that the first day of year zero falls on. */
-      firstWeekday: fields.NumberField<{ required: true; nullable: false; min: 1; 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 }>;
-      /** The amount to offset day numbers for this month. */
-      dayOffset: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
-      /** If this month is an intercalary month. */
-      intercalary: fields.BooleanField<{ initial: false }>;
-      /**
-       * The day of the week this month should always start on.
-       * If the value is null the month will start on the next weekday after the previous month.
-       */
-      startingWeekday: 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 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 }>;
-      /** Is this weekday considered a rest day (weekend)? */
-      isRestDay: fields.BooleanField<{ required: false; nullable: false; initial: false }>;
-    }
-
-    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. */
-      startMonth: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
-      /** The day of the month on which the season starts. */
-      startDay: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
-      /** The ordinal month in which the season ends. */
-      endMonth: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
-      /** The day of the month on which the season ends. */
-      endDay: fields.NumberField<{ required: true; nullable: true; min: 0; integer: true }>;
-    }
-
-    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
-
-    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
-  }
-}
-
-/**
- * Game Time Calendar configuration data model.
- */
-declare class CalendarData extends DataModel<CalendarData.Schema> {}
-
-export const SIMPLIFIED_GREGORIAN_CALENDAR_CONFIG: CalendarData.CreateData;
-
-export default CalendarData;

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

@@ -1,51 +0,0 @@
-import type { FixedInstanceType, LoggingLevels } from "fvtt-types/utils";
-import type Document from "#common/abstract/document.d.mts";
-import type {
-  DatabaseGetOperation,
-  DatabaseCreateOperation,
-  DatabaseUpdateOperation,
-  DatabaseDeleteOperation,
-} from "#common/abstract/_types.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.AnyConstructor>(
-    documentClass: T,
-    request: DatabaseGetOperation,
-    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.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-esm/data/region-behaviors/adjust-darkness-level.d.mts

@@ -1,57 +0,0 @@
-import type RegionBehaviorType from "./base.d.mts";
-import type { Brand } from "fvtt-types/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>;
-
-  /**
-   * @privateRemarks _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

@@ -1,59 +0,0 @@
-import type TypeDataModel from "#common/abstract/type-data.d.mts";
-import type { AnyObject, EmptyObject } from "fvtt-types/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;