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

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

@@ -1,69 +1,146 @@
-import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
 import DocumentData from '../../abstract/data.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
 
 interface UserDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  avatar: typeof fields.IMAGE_FIELD;
+  _id: fields.DocumentId;
+  avatar: fields.ImageField;
   character: fields.ForeignDocumentField<{ type: typeof documents.BaseActor; required: false }>;
-  color: FieldReturnType<typeof fields.COLOR_FIELD, { required: true }>;
-  hotbar: DocumentField<Record<number | string, string>> & {
+  color: FieldReturnType<fields.ColorField, { required: true }>;
+  hotbar: DocumentField<Record<number | `${number}`, string>> & {
     required: true;
-    default: Record<never, never>;
+    default: Record<number | `${number}`, never>;
     validate: typeof _validateHotbar;
     validationError: 'Invalid User hotbar data structure';
   };
-  name: typeof fields.REQUIRED_STRING;
-  password: typeof fields.BLANK_STRING;
-  passwordSalt: typeof fields.STRING_FIELD;
+  name: fields.RequiredString;
+  password: fields.BlankString;
+  passwordSalt: fields.StringField;
   permissions: FieldReturnType<
-    typeof fields.DOCUMENT_PERMISSIONS,
+    fields.DocumentPermissions,
     {
-      default: Record<never, never>;
+      default: Record<string, never>;
       validate: typeof _validatePermissions;
     }
   >;
-  role: DocumentField<number> & {
+  role: DocumentField<foundry.CONST.USER_ROLES> & {
     required: true;
     nullable: false;
-    default: typeof CONST.USER_ROLES.PLAYER;
+    default: typeof foundry.CONST.USER_ROLES.PLAYER;
   };
-  flags: typeof fields.OBJECT_FIELD;
+  flags: fields.ObjectField;
 }
 
 interface UserDataProperties {
+  /**
+   * The _id which uniquely identifies this User document.
+   * @defaultValue `null`
+   */
   _id: string | null;
-  avatar?: string | null;
+
+  /** The user's avatar image. */
+  avatar: string | null | undefined;
+
+  /** A linked Actor document that is this user's impersonated character. */
   character: string | null;
-  color: string | null;
-  hotbar: Record<number | string, string>;
+
+  /** A color to represent this user. */
+  color: string | null | undefined;
+
+  /**
+   * A mapping of hotbar slot number to Macro id that represents this user's hotbar
+   * configuration.
+   * @defaultValue `{}`
+   */
+  hotbar: Record<number | `${number}`, string>;
+
+  /** The user's name. */
   name: string;
+
+  /** @defaultValue `""` */
   password: string;
-  passwordSalt?: string;
-  permissions: Partial<Record<keyof typeof CONST.USER_PERMISSIONS, boolean>>;
-  role: foundry.CONST.UserRole;
+
+  passwordSalt: string | undefined;
+
+  /**
+   * The user's individual permission configuration, see CONST.USER_PERMISSIONS.
+   * @defaultValue `{}`
+   */
+  permissions: Partial<Record<keyof typeof foundry.CONST.USER_PERMISSIONS, boolean>>;
+
+  /**
+   * The user's role, see CONST.USER_ROLES.
+   * @defaultValue `foundry.CONST.USER_ROLES.PLAYER`
+   */
+  role: foundry.CONST.USER_ROLES;
+
+  /**
+   * An object of optional key/value flags.
+   * @defaultValue `{}`
+   */
   flags: ConfiguredFlags<'User'>;
 }
 
 interface UserDataConstructorData {
-  _id?: string | null;
-  avatar?: string | null;
-  character?: string | null;
-  color?: string | null;
-  hotbar?: Record<number | string, string> | null;
+  /**
+   * The _id which uniquely identifies this User document.
+   * @defaultValue `null`
+   */
+  _id?: string | null | undefined;
+
+  /** The user's avatar image. */
+  avatar?: string | null | undefined;
+
+  /** A linked Actor document that is this user's impersonated character. */
+  character?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseActor>> | string | null | undefined;
+
+  /** A color to represent this user. */
+  color?: string | null | undefined;
+
+  /**
+   * A mapping of hotbar slot number to Macro id that represents this user's hotbar
+   * configuration.
+   * @defaultValue `{}`
+   */
+  hotbar?: Record<number | `${number}`, string> | null | undefined;
+
+  /** The user's name. */
   name: string;
-  password?: string | null;
-  passwordSalt?: string | null;
-  permissions?: Partial<Record<keyof typeof CONST.USER_PERMISSIONS, boolean>> | null;
-  role?: foundry.CONST.UserRole | null;
-  flags?: ConfiguredFlags<'User'> | null;
+
+  /** @defaultValue `""` */
+  password?: string | null | undefined;
+
+  passwordSalt?: string | null | undefined;
+
+  /**
+   * The user's individual permission configuration, see CONST.USER_PERMISSIONS.
+   * @defaultValue `{}`
+   */
+  permissions?: Partial<Record<keyof typeof foundry.CONST.USER_PERMISSIONS, boolean>> | null | undefined;
+
+  /**
+   * The user's role, see CONST.USER_ROLES.
+   * @defaultValue `foundry.CONST.USER_ROLES.PLAYER`
+   */
+  role?: foundry.CONST.USER_ROLES | null | undefined;
+
+  /**
+   * An object of optional key/value flags.
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'User'> | null | undefined;
 }
 
 /**
  * The data schema for a User document
  */
-export declare class UserData extends DocumentData<
+export class UserData extends DocumentData<
   UserDataSchema,
   UserDataProperties,
   PropertiesToSource<UserDataProperties>,
@@ -72,11 +149,12 @@ export declare class UserData extends DocumentData<
 > {
   constructor(data: UserDataConstructorData, document?: documents.BaseUser | null);
 
+  /** @override */
   static defineSchema(): UserDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface UserData extends UserDataProperties {}
+export interface UserData extends UserDataProperties {}
 
 /**
  * Validate the structure of the User hotbar object

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

@@ -4,9 +4,9 @@ import { documents } from '../../module.mjs';
 import * as fields from '../fields.mjs';
 
 interface VideoDataSchema extends DocumentSchema {
-  loop: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
-  autoplay: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
-  volume: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0 }>;
+  loop: FieldReturnType<fields.BooleanField, { default: true }>;
+  autoplay: FieldReturnType<fields.BooleanField, { default: true }>;
+  volume: FieldReturnType<fields.AlphaField, { default: 0 }>;
 }
 
 interface VideoDataProperties {
@@ -29,36 +29,37 @@ interface VideoDataProperties {
   volume: number;
 }
 
-export interface VideoDataConstructorData {
+interface VideoDataConstructorData {
   /**
    * Automatically loop the video?
    * @defaultValue `true`
    */
-  loop?: boolean | null;
+  loop?: boolean | null | undefined;
 
   /**
    * Should the video play automatically?
    * @defaultValue `true`
    */
-  autoplay?: boolean | null;
+  autoplay?: boolean | null | undefined;
 
   /**
    * The volume level of any audio that the video file contains
    * @defaultValue `0`
    */
-  volume?: number | null;
+  volume?: number | null | undefined;
 }
 
 /**
  * An inner-object which defines the schema for how Tile video backgrounds are managed
  */
-export declare class VideoData extends DocumentData<
+export class VideoData extends DocumentData<
   VideoDataSchema,
   VideoDataProperties,
   PropertiesToSource<VideoDataProperties>,
   VideoDataConstructorData,
   documents.BaseTile
 > {
+  /** @override */
   static defineSchema(): VideoDataSchema;
 
   /** @override */

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

@@ -4,67 +4,76 @@ import * as documents from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface WallDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
+  _id: fields.DocumentId;
   c: DocumentField<[x0: number, y0: number, x1: number, y1: number]> & {
     type: [typeof Number];
     required: true;
     validate: (c: unknown) => c is [x0: number, y0: number, x1: number, y1: number];
     validationError: 'Invalid {name} coordinates provided which must be a length-4 array of finite numbers';
   };
+  light: FieldReturnType<
+    fields.RequiredNumber,
+    {
+      default: typeof foundry.CONST.WALL_SENSE_TYPES.NORMAL;
+      validate: (v: unknown) => v is foundry.CONST.WALL_SENSE_TYPES;
+      validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_SENSE_TYPES';
+    }
+  >;
   move: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_MOVEMENT_TYPES.NORMAL;
-      validate: (v: unknown) => v is foundry.CONST.WallMovementType;
+      default: typeof foundry.CONST.WALL_MOVEMENT_TYPES.NORMAL;
+      validate: (v: unknown) => v is foundry.CONST.WALL_MOVEMENT_TYPES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_MOVEMENT_TYPES';
     }
   >;
-  sense: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+  sight: FieldReturnType<
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_SENSE_TYPES.NORMAL;
-      validate: (v: unknown) => v is foundry.CONST.WallSenseType;
+      default: typeof foundry.CONST.WALL_SENSE_TYPES.NORMAL;
+      validate: (v: unknown) => v is foundry.CONST.WALL_SENSE_TYPES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_SENSE_TYPES';
     }
   >;
   sound: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_SENSE_TYPES.NORMAL;
-      validate: (v: unknown) => v is foundry.CONST.WallSenseType;
+      default: typeof foundry.CONST.WALL_SENSE_TYPES.NORMAL;
+      validate: (v: unknown) => v is foundry.CONST.WALL_SENSE_TYPES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_SENSE_TYPES';
     }
   >;
   dir: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_DIRECTIONS.BOTH;
-      validate: (v: unknown) => v is foundry.CONST.WallDirection;
+      default: typeof foundry.CONST.WALL_DIRECTIONS.BOTH;
+      validate: (v: unknown) => v is foundry.CONST.WALL_DIRECTIONS;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_DIRECTIONS';
     }
   >;
   door: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_DOOR_TYPES.NONE;
-      validate: (v: unknown) => v is foundry.CONST.WallDoorType;
+      default: typeof foundry.CONST.WALL_DOOR_TYPES.NONE;
+      validate: (v: unknown) => v is foundry.CONST.WALL_DOOR_TYPES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_DOOR_TYPES';
     }
   >;
   ds: FieldReturnType<
-    typeof fields.REQUIRED_NUMBER,
+    fields.RequiredNumber,
     {
-      default: typeof CONST.WALL_DOOR_STATES.CLOSED;
-      validate: (v: unknown) => v is foundry.CONST.WallDoorState;
+      default: typeof foundry.CONST.WALL_DOOR_STATES.CLOSED;
+      validate: (v: unknown) => v is foundry.CONST.WALL_DOOR_STATES;
       validationError: 'Invalid {name} {field} which must be a value in CONST.WALL_DOOR_STATES';
     }
   >;
-  flags: typeof fields.OBJECT_FIELD;
+  flags: fields.ObjectField;
 }
 
 interface WallDataProperties {
   /**
    * The _id which uniquely identifies the embedded Wall document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -73,40 +82,47 @@ interface WallDataProperties {
    */
   c: [x0: number, y0: number, x1: number, y1: number];
 
+  /**
+   * The illumination restriction type of this wall
+   * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
+   */
+  light: foundry.CONST.WALL_SENSE_TYPES;
+
   /**
    * The movement restriction type of this wall
    * @defaultValue `CONST.WALL_MOVEMENT_TYPES.NORMAL`
    */
-  move: foundry.CONST.WallMovementType;
+  move: foundry.CONST.WALL_MOVEMENT_TYPES;
 
   /**
-   * The sensory restriction type of this wall
+   * The visual restriction type of this wall
    * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
    */
-  sense: foundry.CONST.WallSenseType;
+  sight: foundry.CONST.WALL_SENSE_TYPES;
 
   /**
+   * The auditory restriction type of this wall
    * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
    */
-  sound: foundry.CONST.WallSenseType;
+  sound: foundry.CONST.WALL_SENSE_TYPES;
 
   /**
    * The direction of effect imposed by this wall
    * @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
    */
-  dir: foundry.CONST.WallDirection;
+  dir: foundry.CONST.WALL_DIRECTIONS;
 
   /**
    * The type of door which this wall contains, if any
    * @defaultValue `CONST.WALL_DOOR_TYPES.NONE`
    */
-  door: foundry.CONST.WallDoorType;
+  door: foundry.CONST.WALL_DOOR_TYPES;
 
   /**
    * The state of the door this wall contains, if any
    * @defaultValue `CONST.WALL_DOOR_STATES.CLOSED`
    */
-  ds: foundry.CONST.WallDoorState;
+  ds: foundry.CONST.WALL_DOOR_STATES;
 
   /**
    * An object of optional key/value flags
@@ -118,61 +134,69 @@ interface WallDataProperties {
 interface WallDataConstructorData {
   /**
    * The _id which uniquely identifies the embedded Wall document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The wall coordinates, a length-4 array of finite numbers [x0,y0,x1,y1]
    */
   c: [x0: number, y0: number, x1: number, y1: number];
 
+  /**
+   * The illumination restriction type of this wall
+   * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
+   */
+  light?: foundry.CONST.WALL_SENSE_TYPES | null | undefined;
+
   /**
    * The movement restriction type of this wall
    * @defaultValue `CONST.WALL_MOVEMENT_TYPES.NORMAL`
    */
-  move?: foundry.CONST.WallMovementType | null;
+  move?: foundry.CONST.WALL_MOVEMENT_TYPES | null | undefined;
 
   /**
-   * The sensory restriction type of this wall
+   * The visual restriction type of this wall
    * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
    */
-  sense?: foundry.CONST.WallSenseType | null;
+  sight?: foundry.CONST.WALL_SENSE_TYPES | null | undefined;
 
   /**
+   * The auditory restriction type of this wall
    * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
    */
-  sound?: foundry.CONST.WallSenseType | null;
+  sound?: foundry.CONST.WALL_SENSE_TYPES | null | undefined;
 
   /**
    * The direction of effect imposed by this wall
    * @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
    */
-  dir?: foundry.CONST.WallDirection | null;
+  dir?: foundry.CONST.WALL_DIRECTIONS | null | undefined;
 
   /**
    * The type of door which this wall contains, if any
    * @defaultValue `CONST.WALL_DOOR_TYPES.NONE`
    */
-  door?: foundry.CONST.WallDoorType | null;
+  door?: foundry.CONST.WALL_DOOR_TYPES | null | undefined;
 
   /**
    * The state of the door this wall contains, if any
    * @defaultValue `CONST.WALL_DOOR_STATES.CLOSED`
    */
-  ds?: foundry.CONST.WallDoorState | null;
+  ds?: foundry.CONST.WALL_DOOR_STATES | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'Wall'> | null;
+  flags?: ConfiguredFlags<'Wall'> | null | undefined;
 }
 
 /**
  * The data schema for a Wall document.
  * @see BaseWall
  */
-export declare class WallData extends DocumentData<
+export class WallData extends DocumentData<
   WallDataSchema,
   WallDataProperties,
   PropertiesToSource<WallDataProperties>,
@@ -181,6 +205,7 @@ export declare class WallData extends DocumentData<
 > {
   /**
    * The data schema for a WallData object
+   * @override
    */
   static defineSchema(): WallDataSchema;
 
@@ -188,7 +213,10 @@ export declare class WallData extends DocumentData<
    * @remarks This override does not exist in foundry but is added here to prepend runtime errors.
    */
   constructor(data: WallDataConstructorData, document?: documents.BaseWall | null);
+
+  /** @override */
+  _initializeSource(data?: WallDataConstructorData): PropertiesToSource<WallDataProperties>;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface WallData extends WallDataProperties {}
+export interface WallData extends WallDataProperties {}