@league-of-foundry-developers/foundry-vtt-types 0.8.9-6 → 9.238.0

package/src/foundry/common/data/data.mjs/tokenData.d.ts

@@ -1,33 +1,33 @@
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
 import DocumentData from '../../abstract/data.mjs';
-import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { CONST, documents } from '../../module.mjs';
+import { documents } from '../../module.mjs';
 import * as fields from '../fields.mjs';
-import { AnimationData, AnimationDataConstructorData } from './animationData';
-import { TokenBarData, TokenBarDataConstructorData } from './tokenBarData';
 import { ActorDataSource } from './actorData.js';
+import { LightData, LightDataConstructorData } from './lightData';
+import { TokenBarData, TokenBarDataConstructorData } from './tokenBarData';
 
-interface VisionFieldOptions {
-  validate: (d: number) => boolean;
-  validationError: 'Invalid {name} {field} distance which must be a number with absolute value less than 1000';
-}
-
-export interface TokenDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.STRING_FIELD;
-  displayName: DocumentField<CONST.TokenDisplayMode> & {
+interface TokenDataSchema extends DocumentSchema {
+  _id: fields.DocumentId;
+  name: fields.StringField;
+  displayName: DocumentField<foundry.CONST.TOKEN_DISPLAY_MODES> & {
     type: typeof Number;
     required: true;
-    default: typeof CONST.TOKEN_DISPLAY_MODES.NONE;
+    default: typeof foundry.CONST.TOKEN_DISPLAY_MODES.NONE;
     validate: (m: any) => boolean;
     validationError: 'Invalid {name} {field} which must be a value in CONST.TOKEN_DISPLAY_MODES';
   };
   actorId: fields.ForeignDocumentField<{ type: documents.BaseActor; required: true }>;
-  actorLink: typeof fields.BOOLEAN_FIELD;
-  actorData: typeof fields.OBJECT_FIELD;
-  img: FieldReturnType<typeof fields.VIDEO_FIELD, { default: () => string }>;
-  tint: typeof fields.COLOR_FIELD;
-  width: FieldReturnType<typeof fields.REQUIRED_POSITIVE_NUMBER, { default: number }>;
-  height: FieldReturnType<typeof fields.REQUIRED_POSITIVE_NUMBER, { default: number }>;
+  actorLink: fields.BooleanField;
+  actorData: fields.ObjectField;
+  img: FieldReturnType<fields.VideoField, { default: () => typeof TokenData.DEFAULT_ICON }>;
+  tint: fields.ColorField;
+  width: FieldReturnType<fields.RequiredPositiveNumber, { default: 1 }>;
+  height: FieldReturnType<fields.RequiredPositiveNumber, { default: 1 }>;
   scale: DocumentField<number> & {
     type: typeof Number;
     required: true;
@@ -35,50 +35,45 @@ export interface TokenDataSchema extends DocumentSchema {
     validate: (s: unknown) => boolean;
     validationError: 'Invalid {name} {field} which must be a number between 0.25 and 10';
   };
-  mirrorX: typeof fields.BOOLEAN_FIELD;
-  mirrorY: typeof fields.BOOLEAN_FIELD;
-  x: typeof fields.REQUIRED_NUMBER;
-  y: typeof fields.REQUIRED_NUMBER;
-  elevation: typeof fields.REQUIRED_NUMBER;
-  lockRotation: typeof fields.BOOLEAN_FIELD;
-  rotation: FieldReturnType<typeof fields.ANGLE_FIELD, { default: number }>;
+  mirrorX: fields.BooleanField;
+  mirrorY: fields.BooleanField;
+  x: fields.RequiredNumber;
+  y: fields.RequiredNumber;
+  elevation: fields.RequiredNumber;
+  lockRotation: fields.BooleanField;
+  rotation: FieldReturnType<fields.AngleField, { default: 0 }>;
   effects: DocumentField<string[]> & {
-    type: typeof String[];
+    type: [typeof String];
     required: true;
     default: string[];
   };
-  overlayEffect: typeof fields.STRING_FIELD;
-  alpha: typeof fields.ALPHA_FIELD;
-  hidden: typeof fields.BOOLEAN_FIELD;
+  overlayEffect: fields.StringField;
+  alpha: fields.AlphaField;
+  hidden: fields.BooleanField;
   vision: DocumentField<boolean> & {
     type: typeof Boolean;
     required: true;
     default: (data: { readonly dimSight?: number; readonly brightSight?: number }) => boolean;
   };
-  dimSight: FieldReturnType<typeof fields.REQUIRED_NUMBER, VisionFieldOptions>;
-  brightSight: FieldReturnType<typeof fields.REQUIRED_NUMBER, VisionFieldOptions>;
-  dimLight: FieldReturnType<typeof fields.REQUIRED_NUMBER, VisionFieldOptions>;
-  brightLight: FieldReturnType<typeof fields.REQUIRED_NUMBER, VisionFieldOptions>;
-  sightAngle: typeof fields.ANGLE_FIELD;
-  lightAngle: typeof fields.ANGLE_FIELD;
-  lightColor: typeof fields.COLOR_FIELD;
-  lightAlpha: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.25 }>;
-  lightAnimation: DocumentField<AnimationData> & {
-    type: typeof AnimationData;
+  dimSight: fields.NonnegativeNumberField;
+  brightSight: fields.NonnegativeNumberField;
+  sightAngle: fields.AngleField;
+  light: DocumentField<LightData> & {
+    type: typeof LightData;
     required: true;
-    default: {};
+    default: Record<string, never>;
   };
-  disposition: DocumentField<CONST.TokenDisposition> & {
+  disposition: DocumentField<foundry.CONST.TOKEN_DISPOSITIONS> & {
     type: typeof Number;
     required: true;
-    default: typeof CONST.TOKEN_DISPOSITIONS.HOSTILE;
+    default: typeof foundry.CONST.TOKEN_DISPOSITIONS.HOSTILE;
     validate: (n: any) => boolean;
     validationError: 'Invalid {name} {field} which must be a value in CONST.TOKEN_DISPOSITIONS';
   };
-  displayBars: DocumentField<CONST.TokenDisplayMode> & {
+  displayBars: DocumentField<foundry.CONST.TOKEN_DISPLAY_MODES> & {
     type: typeof Number;
     required: true;
-    default: typeof CONST.TOKEN_DISPLAY_MODES.NONE;
+    default: typeof foundry.CONST.TOKEN_DISPLAY_MODES.NONE;
     validate: (m: any) => boolean;
     validationError: 'Invalid {name} {field} which must be a value in CONST.TOKEN_DISPLAY_MODES';
   };
@@ -92,10 +87,10 @@ export interface TokenDataSchema extends DocumentSchema {
     required: true;
     default: () => { attribute: Game['system']['data']['secondaryTokenAttribute'] | null };
   };
-  flags: typeof fields.OBJECT_FIELD;
+  flags: fields.ObjectField;
 }
 
-export interface TokenDataProperties {
+interface TokenDataProperties {
   /**
    * The Token _id which uniquely identifies it within its parent Scene
    * @defaultValue `null`
@@ -105,13 +100,13 @@ export interface TokenDataProperties {
   /**
    * The name used to describe the Token
    */
-  name?: string;
+  name: string | undefined;
 
   /**
    * The display mode of the Token nameplate, from CONST.TOKEN_DISPLAY_MODES
    * @defaultValue `CONST.TOKEN_DISPLAY_MODES.NONE`
    */
-  displayName: CONST.TokenDisplayMode;
+  displayName: foundry.CONST.TOKEN_DISPLAY_MODES;
 
   /**
    * The _id of an Actor document which this Token represents
@@ -133,14 +128,14 @@ export interface TokenDataProperties {
 
   /**
    * A file path to an image or video file used to depict the Token
-   * @defaultValue `this.DEFAULT_ICON`
+   * @defaultValue `TokenData.DEFAULT_ICON`
    */
   img: string | null;
 
   /**
    * An optional color tint applied to the Token image
    */
-  tint?: string | null;
+  tint: string | null | undefined;
 
   /**
    * The width of the Token in grid units
@@ -211,7 +206,7 @@ export interface TokenDataProperties {
   /**
    * A single icon path which is displayed as an overlay on the Token
    */
-  overlayEffect?: string;
+  overlayEffect: string | undefined;
 
   /**
    * The opacity of the token image
@@ -243,18 +238,6 @@ export interface TokenDataProperties {
    */
   brightSight: number;
 
-  /**
-   * How far in distance units this Token emits dim light
-   * @defaultValue `0`
-   */
-  dimLight: number;
-
-  /**
-   * How far in distance units this Token emits bright light
-   * @defaultValue `0`
-   */
-  brightLight: number;
-
   /**
    * The angle at which this Token is able to see, if it has vision
    * @defaultValue `360`
@@ -262,49 +245,32 @@ export interface TokenDataProperties {
   sightAngle: number;
 
   /**
-   * The angle at which this Token is able to emit light
-   * @defaultValue `360`
-   */
-  lightAngle: number;
-
-  /**
-   * The color of the token's emitted light as an HTML hexadecimal color string
-   */
-  lightColor: string | undefined | null;
-
-  /**
-   * The intensity of any light emitted by the token
-   * @defaultValue `0.25`
-   */
-  lightAlpha: number;
-
-  /**
-   * A data object which configures token light animation settings
-   * @defaultValue `{}`
+   * Configuration of the light source that this Token emits, if any
+   * @defaultValue `new LightData({})`
    */
-  lightAnimation: AnimationData;
+  light: LightData;
 
   /**
    * A displayed Token disposition from CONST.TOKEN_DISPOSITIONS
    * @defaultValue `CONST.TOKEN_DISPOSITIONS.HOSTILE`
    */
-  disposition: CONST.TokenDisposition;
+  disposition: foundry.CONST.TOKEN_DISPOSITIONS;
 
   /**
    * The display mode of Token resource bars, from CONST.TOKEN_DISPLAY_MODES
    * @defaultValue `CONST.TOKEN_DISPLAY_MODES.NONE`
    */
-  displayBars: CONST.TokenDisplayMode;
+  displayBars: foundry.CONST.TOKEN_DISPLAY_MODES;
 
   /**
    * The configuration of the Token's primary resource bar
-   * @defaultValue `{ attribute: game?.system.data.primaryTokenAttribute || null }`
+   * @defaultValue `new TokenBarData({ attribute: game?.system.data.primaryTokenAttribute || null })`
    */
   bar1: TokenBarData;
 
   /**
    * The configuration of the Token's secondary resource bar
-   * @defaultValue `{ attribute: game?.system.data.secondaryTokenAttribute || null }`
+   * @defaultValue `new TokenBarData({ attribute: game?.system.data.secondaryTokenAttribute || null })`
    */
   bar2: TokenBarData;
 
@@ -315,29 +281,29 @@ export interface TokenDataProperties {
   flags: ConfiguredFlags<'Token'>;
 }
 
-export interface TokenDataConstructorData {
+interface TokenDataConstructorData {
   /**
    * The Token _id which uniquely identifies it within its parent Scene
    * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name used to describe the Token
    */
-  name?: string | null;
+  name?: string | null | undefined;
 
   /**
    * The display mode of the Token nameplate, from CONST.TOKEN_DISPLAY_MODES
    * @defaultValue `CONST.TOKEN_DISPLAY_MODES.NONE`
    */
-  displayName?: CONST.TokenDisplayMode | null;
+  displayName?: foundry.CONST.TOKEN_DISPLAY_MODES | null | undefined;
 
   /**
    * The _id of an Actor document which this Token represents
    * @defaultValue `null`
    */
-  actorId?: string | null;
+  actorId?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseActor>> | string | null | undefined;
 
   /**
    * Does this Token uniquely represent a singular Actor, or is it one of many?
@@ -349,190 +315,161 @@ export interface TokenDataConstructorData {
    * Token-level data which overrides the base data of the associated Actor
    * @defaultValue `{}`
    */
-  actorData?: Partial<ActorDataSource> | null;
+  actorData?: Partial<ActorDataSource> | null | undefined;
 
   /**
    * A file path to an image or video file used to depict the Token
-   * @defaultValue `this.DEFAULT_ICON`
+   * @defaultValue `TokenData.DEFAULT_ICON`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * An optional color tint applied to the Token image
    */
-  tint?: string | null;
+  tint?: string | null | undefined;
 
   /**
    * The width of the Token in grid units
    * @defaultValue `1`
    */
-  width?: number | null;
+  width?: number | null | undefined;
 
   /**
    * The height of the Token in grid units
    * @defaultValue `1`
    */
-  height?: number | null;
+  height?: number | null | undefined;
 
   /**
    * A scale factor applied to the Token image, between 0.25 and 3
    * @defaultValue `1`
    */
-  scale?: number | null;
+  scale?: number | null | undefined;
 
   /**
    * Flip the Token image horizontally?
    * @defaultValue `false`
    */
-  mirrorX?: boolean | null;
+  mirrorX?: boolean | null | undefined;
 
   /**
    * Flip the Token image vertically?
    * @defaultValue `false`
    */
-  mirrorY?: boolean | null;
+  mirrorY?: boolean | null | undefined;
 
   /**
    * The x-coordinate of the top-left corner of the Token
    * @defaultValue `0`
    */
-  x?: number | null;
+  x?: number | null | undefined;
 
   /**
    * The y-coordinate of the top-left corner of the Token
    * @defaultValue `0`
    */
-  y?: number | null;
+  y?: number | null | undefined;
 
   /**
    * The vertical elevation of the Token, in distance units
    * @defaultValue `0`
    */
-  elevation?: number | null;
+  elevation?: number | null | undefined;
 
   /**
    * Prevent the Token image from visually rotating?
    * @defaultValue `false`
    */
-  lockRotation?: boolean | null;
+  lockRotation?: boolean | null | undefined;
 
   /**
    * The rotation of the Token in degrees, from 0 to 360. A value of 0 represents a southward-facing Token.
    * @defaultValue `0`
    */
-  rotation?: number | null;
+  rotation?: number | null | undefined;
 
   /**
    * An array of effect icon paths which are displayed on the Token
    * @defaultValue `[]`
    */
-  effects?: string[] | null;
+  effects?: string[] | null | undefined;
 
   /**
    * A single icon path which is displayed as an overlay on the Token
    */
-  overlayEffect?: string | null;
+  overlayEffect?: string | null | undefined;
 
   /**
    * The opacity of the token image
    * @defaultValue `1`
    */
-  alpha?: number | null;
+  alpha?: number | null | undefined;
 
   /**
    * Is the Token currently hidden from player view?
    * @defaultValue `false`
    */
-  hidden?: boolean | null;
+  hidden?: boolean | null | undefined;
 
   /**
    * Is this Token a source of vision?
    * @defaultValue Whether dimSight or brightSight have a value greater 0.
    */
-  vision?: boolean | null;
+  vision?: boolean | null | undefined;
 
   /**
    * How far in distance units the Token can naturally see as if in dim light
    * @defaultValue `0`
    */
-  dimSight?: number | null;
+  dimSight?: number | null | undefined;
 
   /**
    * How far in distance units the Token can naturally see as if in bright light
    * @defaultValue `0`
    */
-  brightSight?: number | null;
-
-  /**
-   * How far in distance units this Token emits dim light
-   * @defaultValue `0`
-   */
-  dimLight?: number | null;
-
-  /**
-   * How far in distance units this Token emits bright light
-   * @defaultValue `0`
-   */
-  brightLight?: number | null;
+  brightSight?: number | null | undefined;
 
   /**
    * The angle at which this Token is able to see, if it has vision
    * @defaultValue `360`
    */
-  sightAngle?: number | null;
-
-  /**
-   * The angle at which this Token is able to emit light
-   * @defaultValue `360`
-   */
-  lightAngle?: number | null;
+  sightAngle?: number | null | undefined;
 
   /**
-   * The color of the token's emitted light as an HTML hexadecimal color string
+   * Configuration of the light source that this Token emits, if any
+   * @defaultValue `new LightData({})`
    */
-  lightColor?: string | null;
-
-  /**
-   * The intensity of any light emitted by the token
-   * @defaultValue `0.25`
-   */
-  lightAlpha?: number | null;
-
-  /**
-   * A data object which configures token light animation settings
-   * @defaultValue `{}`
-   */
-  lightAnimation?: AnimationDataConstructorData | null;
+  light?: LightDataConstructorData | null | undefined;
 
   /**
    * A displayed Token disposition from CONST.TOKEN_DISPOSITIONS
    * @defaultValue `CONST.TOKEN_DISPOSITIONS.HOSTILE`
    */
-  disposition?: CONST.TokenDisposition | null;
+  disposition?: foundry.CONST.TOKEN_DISPOSITIONS | null | undefined;
 
   /**
    * The display mode of Token resource bars, from CONST.TOKEN_DISPLAY_MODES
    * @defaultValue `CONST.TOKEN_DISPLAY_MODES.NONE`
    */
-  displayBars?: CONST.TokenDisplayMode | null;
+  displayBars?: foundry.CONST.TOKEN_DISPLAY_MODES | null | undefined;
 
   /**
    * The configuration of the Token's primary resource bar
-   * @defaultValue `{ attribute: game?.system.data.primaryTokenAttribute || null }`
+   * @defaultValue `new TokenBarData({ attribute: game?.system.data.primaryTokenAttribute || null })`
    */
-  bar1?: TokenBarDataConstructorData | null;
+  bar1?: TokenBarDataConstructorData | null | undefined;
 
   /**
    * The configuration of the Token's secondary resource bar
-   * @defaultValue `{ attribute: game?.system.data.secondaryTokenAttribute || null }`
+   * @defaultValue `new TokenBarData({ attribute: game?.system.data.secondaryTokenAttribute || null })`
    */
-  bar2?: TokenBarDataConstructorData | null;
+  bar2?: TokenBarDataConstructorData | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'Token'> | null;
+  flags?: ConfiguredFlags<'Token'> | null | undefined;
 }
 
 /**
@@ -545,14 +482,25 @@ export class TokenData extends DocumentData<
   TokenDataConstructorData,
   documents.BaseToken
 > {
+  /** @override */
   static defineSchema(): TokenDataSchema;
 
   /**
-   * The default icon used for newly created Item documents
+   * The default icon used for newly created Token documents
    * @defaultValue `CONST.DEFAULT_TOKEN`
    */
   static DEFAULT_ICON: string;
+
+  /**
+   * Migrate TokenData attributes to the new inner LightData structure.
+   * This can be safely removed after several major versions have passed. Maybe V12?
+   * @override
+   */
+  _initializeSource(data: TokenDataConstructorData): PropertiesToSource<TokenDataProperties>;
+
+  /** @override */
+  protected _initialize(): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface TokenData extends TokenDataProperties {}
+export interface TokenData extends TokenDataProperties {}