@league-of-foundry-developers/foundry-vtt-types 0.8.9-7 → 9.238.1

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

@@ -1,31 +1,31 @@
-import DocumentData from '../../abstract/data.mjs';
-import { BaseUser } from '../../documents.mjs';
-import { ForeignDocumentField } from '../fields.mjs';
-import * as fields from '../fields.mjs';
-import * as documents from '../../documents.mjs';
 import {
   ConfiguredDocumentClass,
   ConfiguredFlags,
   FieldReturnType,
   PropertiesToSource
 } from '../../../../types/helperTypes';
+import DocumentData from '../../abstract/data.mjs';
+import * as documents from '../../documents.mjs';
+import { BaseUser } from '../../documents.mjs';
+import * as fields from '../fields.mjs';
+import { ForeignDocumentField } from '../fields.mjs';
 
 interface DrawingDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
+  _id: fields.DocumentId;
   author: ForeignDocumentField<{ type: typeof documents.BaseUser; required: true }>;
-  type: DocumentField<foundry.CONST.DrawingType> & {
+  type: DocumentField<foundry.CONST.DRAWING_TYPES> & {
     type: typeof String;
     required: true;
-    default: typeof CONST.DRAWING_TYPES.POLYGON;
-    validate: (t: unknown) => t is foundry.CONST.DrawingType;
+    default: typeof foundry.CONST.DRAWING_TYPES.POLYGON;
+    validate: (t: unknown) => t is foundry.CONST.DRAWING_TYPES;
     validationError: 'Invalid {name} {field} which must be a value in CONST.DRAWING_TYPES';
   };
-  x: typeof fields.REQUIRED_NUMBER;
-  y: typeof fields.REQUIRED_NUMBER;
-  width: typeof fields.REQUIRED_NUMBER;
-  height: typeof fields.REQUIRED_NUMBER;
-  rotation: FieldReturnType<typeof fields.ANGLE_FIELD, { default: 0 }>;
-  z: typeof fields.REQUIRED_NUMBER;
+  x: fields.RequiredNumber;
+  y: fields.RequiredNumber;
+  width: fields.RequiredNumber;
+  height: fields.RequiredNumber;
+  rotation: FieldReturnType<fields.AngleField, { default: 0 }>;
+  z: fields.RequiredNumber;
   points: DocumentField<Array<[x: number, y: number]>> & {
     type: [typeof Array];
     required: true;
@@ -33,36 +33,36 @@ interface DrawingDataSchema extends DocumentSchema {
     validate: typeof _validateDrawingPoints;
     validationError: 'Invalid {name} {field} which must be an array of points [x,y]';
   };
-  bezierFactor: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0 }>;
+  bezierFactor: FieldReturnType<fields.AlphaField, { default: 0 }>;
   fillType: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.DRAWING_FILL_TYPES.NONE;
-      validate: (v: unknown) => v is foundry.CONST.DrawingFillType;
+      default: typeof foundry.CONST.DRAWING_FILL_TYPES.NONE;
+      validate: (v: unknown) => v is foundry.CONST.DRAWING_FILL_TYPES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.DRAWING_FILL_TYPES';
     }
   >;
-  fillColor: typeof fields.COLOR_FIELD;
-  fillAlpha: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.5 }>;
-  strokeWidth: FieldReturnType<typeof fields.NONNEGATIVE_INTEGER_FIELD, { default: 8 }>;
-  strokeColor: typeof fields.COLOR_FIELD;
-  strokeAlpha: typeof fields.ALPHA_FIELD;
-  texture: typeof fields.IMAGE_FIELD;
-  text: typeof fields.STRING_FIELD;
-  fontFamily: FieldReturnType<typeof fields.REQUIRED_STRING, { default: 'Signika' }>;
+  fillColor: fields.ColorField;
+  fillAlpha: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
+  strokeWidth: FieldReturnType<fields.NonnegativeIntegerField, { default: 8 }>;
+  strokeColor: fields.ColorField;
+  strokeAlpha: fields.AlphaField;
+  texture: fields.ImageField;
+  text: fields.StringField;
+  fontFamily: FieldReturnType<fields.RequiredString, { default: 'Signika' }>;
   fontSize: FieldReturnType<
-    typeof fields.POSITIVE_INTEGER_FIELD,
+    fields.PositiveIntegerField,
     {
       default: 48;
       validate: (n: unknown) => boolean;
       validationError: 'Invalid {name} {field} which must be an integer between 8 and 256';
     }
   >;
-  textColor: FieldReturnType<typeof fields.COLOR_FIELD, { default: '#FFFFFF' }>;
-  textAlpha: typeof fields.ALPHA_FIELD;
-  hidden: typeof fields.BOOLEAN_FIELD;
-  locked: typeof fields.BOOLEAN_FIELD;
-  flags: typeof fields.OBJECT_FIELD;
+  textColor: FieldReturnType<fields.ColorField, { default: '#FFFFFF' }>;
+  textAlpha: fields.AlphaField;
+  hidden: fields.BooleanField;
+  locked: fields.BooleanField;
+  flags: fields.ObjectField;
 }
 
 interface DrawingDataProperties {
@@ -82,7 +82,7 @@ interface DrawingDataProperties {
    * The value in CONST.DRAWING_TYPES which defines the geometry type of this drawing
    * @defaultValue `CONST.DRAWING_TYPES.POLYGON`
    */
-  type: foundry.CONST.DrawingType;
+  type: foundry.CONST.DRAWING_TYPES;
 
   /**
    * The x-coordinate position of the top-left corner of the drawn shape
@@ -136,12 +136,12 @@ interface DrawingDataProperties {
    * The fill type of the drawing shape, a value from CONST.DRAWING_FILL_TYPES
    * @defaultValue `CONST.DRAWING_FILL_TYPES.NONE`
    */
-  fillType: foundry.CONST.DrawingFillType;
+  fillType: foundry.CONST.DRAWING_FILL_TYPES;
 
   /**
    * An optional color string with which to fill the drawing geometry
    */
-  fillColor?: string | null;
+  fillColor: string | null | undefined;
 
   /**
    * The opacity of the fill applied to the drawing geometry
@@ -158,7 +158,7 @@ interface DrawingDataProperties {
   /**
    * The color of the boundary lines of the drawing geometry
    */
-  strokeColor?: string | null;
+  strokeColor: string | null | undefined;
 
   /**
    * The opacity of the boundary lines of the drawing geometry
@@ -169,12 +169,12 @@ interface DrawingDataProperties {
   /**
    * The path to a tiling image texture used to fill the drawing geometry
    */
-  texture?: string | null;
+  texture: string | null | undefined;
 
   /**
    * Optional text which is displayed overtop of the drawing
    */
-  text?: string;
+  text: string | undefined;
 
   /**
    * The font family used to display text within this drawing
@@ -224,153 +224,153 @@ interface DrawingDataConstructorData {
    * The _id which uniquely identifies this BaseDrawing embedded document
    * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The _id of the user who created the drawing
    * @defaultValue `null`
    */
-  author?: InstanceType<ConfiguredDocumentClass<typeof BaseUser>> | string | null;
+  author?: InstanceType<ConfiguredDocumentClass<typeof BaseUser>> | string | null | undefined;
 
   /**
    * The value in CONST.DRAWING_TYPES which defines the geometry type of this drawing
    * @defaultValue `CONST.DRAWING_TYPES.POLYGON`
    */
-  type?: foundry.CONST.DrawingType | null;
+  type?: foundry.CONST.DRAWING_TYPES | null | undefined;
 
   /**
    * The x-coordinate position of the top-left corner of the drawn shape
    * @defaultValue `0`
    */
-  x?: number | null;
+  x?: number | null | undefined;
 
   /**
    * The y-coordinate position of the top-left corner of the drawn shape
    * @defaultValue `0`
    */
-  y?: number | null;
+  y?: number | null | undefined;
 
   /**
    * The pixel width of the drawing figure
    * @defaultValue `0`
    */
-  width?: number | null;
+  width?: number | null | undefined;
 
   /**
    * The pixel height of the drawing figure
    * @defaultValue `0`
    */
-  height?: number | null;
+  height?: number | null | undefined;
 
   /**
    * The angle of rotation for the drawing figure
    * @defaultValue `0`
    */
-  rotation?: number | null;
+  rotation?: number | null | undefined;
 
   /**
    * The z-index of this drawing relative to other siblings
    * @defaultValue `0`
    */
-  z?: number | null;
+  z?: number | null | undefined;
 
   /**
    * An array of points [x,y] which define polygon vertices
    * @defaultValue `[]`
    */
-  points?: Array<[x: number, y: number]> | null;
+  points?: Array<[x: number, y: number]> | null | undefined;
 
   /**
    * An amount of bezier smoothing applied, between 0 and 1
    * @defaultValue `0`
    */
-  bezierFactor?: number | null;
+  bezierFactor?: number | null | undefined;
 
   /**
    * The fill type of the drawing shape, a value from CONST.DRAWING_FILL_TYPES
    * @defaultValue `CONST.DRAWING_FILL_TYPES.NONE`
    */
-  fillType?: foundry.CONST.DrawingFillType | null;
+  fillType?: foundry.CONST.DRAWING_FILL_TYPES | null | undefined;
 
   /**
    * An optional color string with which to fill the drawing geometry
    */
-  fillColor?: string | null;
+  fillColor?: string | null | undefined;
 
   /**
    * The opacity of the fill applied to the drawing geometry
    * @defaultValue `0.5`
    */
-  fillAlpha?: number | null;
+  fillAlpha?: number | null | undefined;
 
   /**
    * The width in pixels of the boundary lines of the drawing geometry
    * @defaultValue `8`
    */
-  strokeWidth?: number | null;
+  strokeWidth?: number | null | undefined;
 
   /**
    * The color of the boundary lines of the drawing geometry
    */
-  strokeColor?: string | null;
+  strokeColor?: string | null | undefined;
 
   /**
    * The opacity of the boundary lines of the drawing geometry
    * @defaultValue `1`
    */
-  strokeAlpha?: number | null;
+  strokeAlpha?: number | null | undefined;
 
   /**
    * The path to a tiling image texture used to fill the drawing geometry
    */
-  texture?: string | null;
+  texture?: string | null | undefined;
 
   /**
    * Optional text which is displayed overtop of the drawing
    */
-  text?: string | null;
+  text?: string | null | undefined;
 
   /**
    * The font family used to display text within this drawing
    * @defaultValue `'Signika'`
    */
-  fontFamily?: string | null;
+  fontFamily?: string | null | undefined;
 
   /**
    * The font size used to display text within this drawing
    * @defaultValue `48`
    */
-  fontSize?: number | null;
+  fontSize?: number | null | undefined;
 
   /**
    * The color of text displayed within this drawing
    * @defaultValue `'#FFFFFF'`
    */
-  textColor?: string | null;
+  textColor?: string | null | undefined;
 
   /**
    * The opacity of text displayed within this drawing
    * @defaultValue `1`
    */
-  textAlpha?: number | null;
+  textAlpha?: number | null | undefined;
 
   /**
    * Is the drawing currently hidden?
    * @defaultValue `false`
    */
-  hidden?: boolean | null;
+  hidden?: boolean | null | undefined;
 
   /**
    * Is the drawing currently locked?
    * @defaultValue `false`
    */
-  locked?: boolean | null;
+  locked?: boolean | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'Drawing'> | null;
+  flags?: ConfiguredFlags<'Drawing'> | null | undefined;
 }
 
 /**
@@ -380,13 +380,14 @@ interface DrawingDataConstructorData {
  * @param data     - Initial data used to construct the data object
  * @param document - The embedded document to which this data object belongs
  */
-export declare class DrawingData extends DocumentData<
+export class DrawingData extends DocumentData<
   DrawingDataSchema,
   DrawingDataProperties,
   PropertiesToSource<DrawingDataProperties>,
   DrawingDataConstructorData,
   documents.BaseFolder
 > {
+  /** @override */
   static defineSchema(): DrawingDataSchema;
 
   /** @override */
@@ -397,7 +398,7 @@ export declare class DrawingData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface DrawingData extends DrawingDataProperties {}
+export interface DrawingData extends DrawingDataProperties {}
 
 /**
  * Validate the array of points which comprises a polygon drawing

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

@@ -1,83 +1,79 @@
+import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
 import { DocumentData } from '../../abstract/module.mjs';
 import { BaseActiveEffect } from '../../documents.mjs';
 import * as fields from '../fields.mjs';
-import * as CONST from '../../constants.mjs';
-import { PropertiesToSource } from '../../../../types/helperTypes';
 
 interface EffectChangeDataSchema extends DocumentSchema {
-  key: typeof fields.BLANK_STRING;
-  value: typeof fields.BLANK_STRING;
-  mode: DocumentField<number> & {
-    type: typeof Number;
-    required: true;
-    default: typeof CONST.ACTIVE_EFFECT_MODES.ADD;
-    validate: (m: unknown) => boolean;
-    validationError: 'Invalid mode specified for change in ActiveEffectData';
-  };
-  priority: typeof fields.NUMERIC_FIELD;
+  key: fields.BlankString;
+  value: fields.BlankString;
+  mode: FieldReturnType<fields.NonnegativeNumberField, { default: typeof foundry.CONST.ACTIVE_EFFECT_MODES.ADD }>;
+  priority: fields.NumericField;
 }
 
 interface EffectChangeDataProperties {
   /**
    * The attribute path in the Actor or Item data which the change modifies
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   key: string;
 
   /**
    * The value of the change effect
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   value: string;
 
   /**
    * The modification mode with which the change is applied
+   * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
    */
-  mode: CONST.ActiveEffectMode;
+  mode: foundry.CONST.ACTIVE_EFFECT_MODES;
 
   /**
    * The priority level with which this change is applied
    */
-  priority?: number | null;
+  priority: number | null | undefined;
 }
 
-export interface EffectChangeDataConstructorData {
+interface EffectChangeDataConstructorData {
   /**
    * The attribute path in the Actor or Item data which the change modifies
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
-  key?: string | null;
+  key?: string | null | undefined;
 
   /**
    * The value of the change effect
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
-  value?: string | null;
+  value?: string | null | undefined;
 
   /**
    * The modification mode with which the change is applied
+   * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
    */
-  mode?: CONST.ActiveEffectMode | null;
+  mode?: foundry.CONST.ACTIVE_EFFECT_MODES | null | undefined;
 
   /**
    * The priority level with which this change is applied
    */
-  priority?: number | null;
+  priority?: number | null | undefined;
 }
 
 /**
  * An embedded data structure which defines the structure of a change applied by an ActiveEffect.
  * @see ActiveEffectData
  */
-export declare class EffectChangeData extends DocumentData<
+export class EffectChangeData extends DocumentData<
   EffectChangeDataSchema,
   EffectChangeDataProperties,
   PropertiesToSource<EffectChangeDataProperties>,
   EffectChangeDataConstructorData,
   BaseActiveEffect
 > {
+  /** @override */
   static defineSchema(): EffectChangeDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface EffectChangeData extends EffectChangeDataProperties {}
+export interface EffectChangeData extends EffectChangeDataProperties {}

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

@@ -4,13 +4,13 @@ import { BaseActiveEffect } from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface EffectDurationDataSchema extends DocumentSchema {
-  startTime: FieldReturnType<typeof fields.NUMERIC_FIELD, { default: null }>;
-  seconds: typeof fields.NONNEGATIVE_INTEGER_FIELD;
-  combat: typeof fields.STRING_FIELD;
-  rounds: typeof fields.NONNEGATIVE_INTEGER_FIELD;
-  turns: typeof fields.NONNEGATIVE_INTEGER_FIELD;
-  startRound: typeof fields.NONNEGATIVE_INTEGER_FIELD;
-  startTurn: typeof fields.NONNEGATIVE_INTEGER_FIELD;
+  startTime: FieldReturnType<fields.NumericField, { default: null }>;
+  seconds: fields.NonnegativeIntegerField;
+  combat: fields.StringField;
+  rounds: fields.NonnegativeIntegerField;
+  turns: fields.NonnegativeIntegerField;
+  startRound: fields.NonnegativeIntegerField;
+  startTurn: fields.NonnegativeIntegerField;
 }
 
 interface EffectDurationDataProperties {
@@ -23,85 +23,86 @@ interface EffectDurationDataProperties {
   /**
    * The maximum duration of the effect, in seconds
    */
-  seconds?: number;
+  seconds: number | undefined;
 
   /**
    * The _id of the CombatEncounter in which the effect first started
    */
-  combat?: string;
+  combat: string | undefined;
 
   /**
    * The maximum duration of the effect, in combat rounds
    */
-  rounds?: number;
+  rounds: number | undefined;
 
   /**
    * The maximum duration of the effect, in combat turns
    */
-  turns?: number;
+  turns: number | undefined;
 
   /**
    * The round of the CombatEncounter in which the effect first started
    */
-  startRound?: number;
+  startRound: number | undefined;
 
   /**
    * The turn of the CombatEncounter in which the effect first started
    */
-  startTurn?: number;
+  startTurn: number | undefined;
 }
 
-export interface EffectDurationDataConstructorData {
+interface EffectDurationDataConstructorData {
   /**
    * The world time when the active effect first started
    * @defaultValue `null`
    */
-  startTime?: number | null;
+  startTime?: number | null | undefined;
 
   /**
    * The maximum duration of the effect, in seconds
    */
-  seconds?: number | null;
+  seconds?: number | null | undefined;
 
   /**
    * The _id of the CombatEncounter in which the effect first started
    */
-  combat?: string | null;
+  combat?: string | null | undefined;
 
   /**
    * The maximum duration of the effect, in combat rounds
    */
-  rounds?: number | null;
+  rounds?: number | null | undefined;
 
   /**
    * The maximum duration of the effect, in combat turns
    */
-  turns?: number | null;
+  turns?: number | null | undefined;
 
   /**
    * The round of the CombatEncounter in which the effect first started
    */
-  startRound?: number | null;
+  startRound?: number | null | undefined;
 
   /**
    * The turn of the CombatEncounter in which the effect first started
    */
-  startTurn?: number | null;
+  startTurn?: number | null | undefined;
 }
 
 /**
  * An embedded data structure which tracks the duration of an ActiveEffect.
  * @see ActiveEffectData
  */
-export declare class EffectDurationData extends DocumentData<
+export class EffectDurationData extends DocumentData<
   EffectDurationDataSchema,
   EffectDurationDataProperties,
   PropertiesToSource<EffectDurationDataProperties>,
   EffectDurationDataConstructorData,
   BaseActiveEffect
 > {
+  /** @override */
   static defineSchema(): EffectDurationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface EffectDurationData extends EffectDurationDataProperties {}
+export interface EffectDurationData extends EffectDurationDataProperties {}

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

@@ -1,12 +1,12 @@
+import { ConfiguredDocumentClass, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
 import DocumentData from '../../abstract/data.mjs';
-import { ForeignDocumentField } from '../fields.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import { ConfiguredDocumentClass, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import * as fields from '../fields.mjs';
+import { ForeignDocumentField } from '../fields.mjs';
 import { isBase64Image } from '../validators.mjs';
 
 interface FogExplorationDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
+  _id: fields.DocumentId;
   scene: ForeignDocumentField<{ type: typeof documents.BaseScene }>;
   user: ForeignDocumentField<{ type: typeof documents.BaseUser }>;
   explored: DocumentField<string> & {
@@ -17,8 +17,8 @@ interface FogExplorationDataSchema extends DocumentSchema {
     validate: typeof isBase64Image;
     validationError: 'The provided FogExploration explored image is not a valid base64 image string';
   };
-  positions: typeof fields.OBJECT_FIELD;
-  timestamp: FieldReturnType<typeof fields.TIMESTAMP_FIELD, { required: true }>;
+  positions: fields.ObjectField;
+  timestamp: FieldReturnType<fields.TimestampField, { required: true }>;
 }
 
 interface FogExplorationDataProperties {
@@ -52,7 +52,10 @@ interface FogExplorationDataProperties {
    */
   positions: Record<string, { radius: number; limit: boolean }>;
 
-  /** The timestamp at which this fog exploration was last updated */
+  /**
+   * The timestamp at which this fog exploration was last updated
+   * @defaultValue `Date.now()`
+   */
   timestamp: number;
 }
 
@@ -61,47 +64,51 @@ interface FogExplorationDataConstructorData {
    * The _id which uniquely identifies this FogExploration document
    * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The _id of the Scene document to which this fog applies
    * @defaultValue `null`
    */
-  scene?: string | null | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>;
+  scene?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>> | string | null | undefined;
 
   /**
    * The _id of the User document to which this fog applies
    * @defaultValue `null`
    */
-  user?: string | null;
+  user?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>> | string | null | undefined;
 
   /**
    * The base64 png image of the explored fog polygon
    * @defaultValue `null`
    */
-  explored?: string | null;
+  explored?: string | null | undefined;
 
   /**
    * The object of scene positions which have been explored at a certain vision radius
    * @defaultValue `{}`
    */
-  positions?: Record<string, { radius: number; limit: boolean }> | null;
+  positions?: Record<string, { radius: number; limit: boolean }> | null | undefined;
 
-  /** The timestamp at which this fog exploration was last updated */
-  timestamp?: number | null;
+  /**
+   * The timestamp at which this fog exploration was last updated
+   * @defaultValue `Date.now()`
+   */
+  timestamp?: number | null | undefined;
 }
 
 /**
  * The data schema for a FogExploration document.
  */
-export declare class FogExplorationData extends DocumentData<
+export class FogExplorationData extends DocumentData<
   FogExplorationDataSchema,
   FogExplorationDataProperties,
   PropertiesToSource<FogExplorationDataProperties>,
   FogExplorationDataConstructorData
 > {
+  /** @override */
   static defineSchema(): FogExplorationDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface FogExplorationData extends FogExplorationDataProperties {}
+export interface FogExplorationData extends FogExplorationDataProperties {}