@league-of-foundry-developers/foundry-vtt-types 0.8.9-8 → 9.242.0

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

@@ -1,34 +1,41 @@
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
 import type { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
-import type EmbeddedCollection from '../../abstract/embedded-collection.mjs';
 import type DocumentData from '../../abstract/data.mjs';
+import type EmbeddedCollection from '../../abstract/embedded-collection.mjs';
+import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
 
 interface PlaylistDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  description: typeof fields.BLANK_STRING;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  description: fields.BlankString;
   sounds: fields.EmbeddedCollectionField<typeof documents.BasePlaylistSound>;
-  mode: DocumentField<foundry.CONST.PlaylistMode> & {
+  mode: DocumentField<foundry.CONST.PLAYLIST_MODES> & {
     type: typeof Number;
     required: true;
-    default: typeof CONST.PLAYLIST_MODES.SEQUENTIAL;
-    validate: (m: unknown) => m is foundry.CONST.PlaylistMode;
+    default: typeof foundry.CONST.PLAYLIST_MODES.SEQUENTIAL;
+    validate: (m: unknown) => m is foundry.CONST.PLAYLIST_MODES;
     validationError: 'Invalid {name} {field} provided which must be a value from CONST.PLAYLIST_MODES';
   };
-  playing: typeof fields.BOOLEAN_FIELD;
-  fade: typeof fields.INTEGER_FIELD;
+  playing: fields.BooleanField;
+  fade: fields.IntegerField;
   folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: typeof fields.INTEGER_SORT_FIELD;
-  seed: typeof fields.NONNEGATIVE_INTEGER_FIELD;
-  permission: typeof fields.DOCUMENT_PERMISSIONS;
-  flags: typeof fields.OBJECT_FIELD;
+  sorting: DocumentField<foundry.CONST.PLAYLIST_SORT_MODES> & {
+    type: foundry.CONST.PLAYLIST_SORT_MODES;
+    required: true;
+    default: typeof foundry.CONST.PLAYLIST_SORT_MODES.ALPHABETICAL;
+    validate: (m: unknown) => m is foundry.CONST.PLAYLIST_SORT_MODES;
+    validationError: 'Invalid Playlist sorting mode';
+  };
+  sort: fields.IntegerSortField;
+  seed: fields.NonnegativeIntegerField;
+  permission: fields.DocumentPermissions;
+  flags: fields.ObjectField;
 }
 
 interface PlaylistDataProperties {
   /**
    * The _id which uniquely identifies this Playlist document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -38,12 +45,14 @@ interface PlaylistDataProperties {
   name: string;
 
   /**
-   * @defaultValue `''`
+   * The description of this playlist
+   * @defaultValue `""`
    */
   description: string;
 
   /**
    * A Collection of PlaylistSounds embedded documents which belong to this playlist
+   * @defaultValue `new EmbeddedCollection(PlaylistSoundData, [], BasePlaylistSound.implementation)`
    */
   sounds: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>;
 
@@ -51,7 +60,7 @@ interface PlaylistDataProperties {
    * The playback mode for sounds in this playlist
    * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
    */
-  mode: foundry.CONST.PlaylistMode;
+  mode: foundry.CONST.PLAYLIST_MODES;
 
   /**
    * Is this playlist currently playing?
@@ -59,6 +68,7 @@ interface PlaylistDataProperties {
    */
   playing: boolean;
 
+  /** A duration in milliseconds to fade volume transition */
   fade: number | undefined;
 
   /**
@@ -67,19 +77,26 @@ interface PlaylistDataProperties {
    */
   folder: string | null;
 
+  /**
+   * The sorting mode used for this playlist.
+   * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
+   */
+  sorting: foundry.CONST.PLAYLIST_SORT_MODES;
+
   /**
    * The numeric sort value which orders this playlist relative to its siblings
    * @defaultValue `0`
    */
   sort: number;
 
+  /** A seed used for playlist randomization to guarantee that all clients generate the same random order. */
   seed: number | undefined;
 
   /**
    * An object which configures user permissions to this playlist
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission: Record<string, foundry.CONST.EntityPermission>;
+  permission: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>;
 
   /**
    * An object of optional key/value flags
@@ -91,6 +108,7 @@ interface PlaylistDataProperties {
 interface PlaylistDataConstructorData {
   /**
    * The _id which uniquely identifies this Playlist document
+   * @defaultValue `null`
    */
   _id?: string | null | undefined;
 
@@ -100,12 +118,14 @@ interface PlaylistDataConstructorData {
   name: string;
 
   /**
-   * @defaultValue `''`
+   * The description of this playlist
+   * @defaultValue `""`
    */
   description?: string | null | undefined;
 
   /**
    * A Collection of PlaylistSounds embedded documents which belong to this playlist
+   * @defaultValue `new EmbeddedCollection(PlaylistSoundData, [], BasePlaylistSound.implementation)`
    */
   sounds?:
     | EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>
@@ -116,7 +136,7 @@ interface PlaylistDataConstructorData {
    * The playback mode for sounds in this playlist
    * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
    */
-  mode?: foundry.CONST.PlaylistMode | null | undefined;
+  mode?: foundry.CONST.PLAYLIST_MODES | null | undefined;
 
   /**
    * Is this playlist currently playing?
@@ -124,13 +144,20 @@ interface PlaylistDataConstructorData {
    */
   playing?: boolean | null | undefined;
 
-  fade?: number | undefined | null;
+  /** A duration in milliseconds to fade volume transition */
+  fade?: number | null | undefined;
 
   /**
    * The _id of a Folder which contains this playlist
    * @defaultValue `null`
    */
-  folder?: string | null | undefined;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
+
+  /**
+   * The sorting mode used for this playlist.
+   * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
+   */
+  sorting?: foundry.CONST.PLAYLIST_SORT_MODES | null | undefined;
 
   /**
    * The numeric sort value which orders this playlist relative to its siblings
@@ -138,13 +165,14 @@ interface PlaylistDataConstructorData {
    */
   sort?: number | null | undefined;
 
-  seed?: number | undefined | null;
+  /** A seed used for playlist randomization to guarantee that all clients generate the same random order. */
+  seed?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this playlist
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission?: Record<string, foundry.CONST.EntityPermission> | undefined | null;
+  permission?: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS> | null | undefined;
 
   /**
    * An object of optional key/value flags
@@ -157,13 +185,14 @@ interface PlaylistDataConstructorData {
  * The data schema for a Playlist document.
  * @see BasePlaylist
  */
-export declare class PlaylistData extends DocumentData<
+export class PlaylistData extends DocumentData<
   PlaylistDataSchema,
   PlaylistDataProperties,
   PropertiesToSource<PlaylistDataProperties>,
   PlaylistDataConstructorData,
   documents.BasePlaylist
 > {
+  /** @override */
   static defineSchema(): PlaylistDataSchema;
 }
 

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

@@ -1,24 +1,26 @@
-import * as fields from '../fields.mjs';
 import type { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
 import type DocumentData from '../../abstract/data.mjs';
 import type { documents } from '../../module.mjs';
+import * as fields from '../fields.mjs';
 
 interface PlaylistSoundDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  description: typeof fields.BLANK_STRING;
-  path: typeof fields.AUDIO_FIELD;
-  playing: typeof fields.BOOLEAN_FIELD;
-  pausedTime: FieldReturnType<typeof fields.NUMERIC_FIELD, { default: null }>;
-  repeat: typeof fields.BOOLEAN_FIELD;
-  volume: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.5 }>;
-  fade: typeof fields.INTEGER_FIELD;
-  flags: typeof fields.OBJECT_FIELD;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  description: fields.BlankString;
+  path: fields.AudioField;
+  playing: fields.BooleanField;
+  pausedTime: FieldReturnType<fields.NumericField, { default: null }>;
+  repeat: fields.BooleanField;
+  volume: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
+  fade: fields.IntegerField;
+  sort: fields.IntegerSortField;
+  flags: fields.ObjectField;
 }
 
 interface PlaylistSoundDataProperties {
   /**
    * The _id which uniquely identifies this PlaylistSound document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -28,14 +30,15 @@ interface PlaylistSoundDataProperties {
   name: string;
 
   /**
-   * @defaultValue `''`
+   * The description of this sound track
+   * @defaultValue `""`
    */
   description: string;
 
   /**
    * The audio file path that is played by this sound
    */
-  path: string | undefined | null;
+  path: string | null | undefined;
 
   /**
    * Is this sound currently playing?
@@ -44,6 +47,7 @@ interface PlaylistSoundDataProperties {
   playing: boolean;
 
   /**
+   * The time in seconds at which playback was paused
    * @defaultValue `null`
    */
   pausedTime: number | null;
@@ -60,8 +64,12 @@ interface PlaylistSoundDataProperties {
    */
   volume: number;
 
+  /** A duration in milliseconds to fade volume transition */
   fade: number | undefined;
 
+  /** @defaultValue `0` */
+  sort: number;
+
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
@@ -72,6 +80,7 @@ interface PlaylistSoundDataProperties {
 interface PlaylistSoundDataConstructorData {
   /**
    * The _id which uniquely identifies this PlaylistSound document
+   * @defaultValue `null`
    */
   _id?: string | null | undefined;
 
@@ -81,14 +90,15 @@ interface PlaylistSoundDataConstructorData {
   name: string;
 
   /**
-   * @defaultValue `''`
+   * The description of this sound track
+   * @defaultValue `""`
    */
   description?: string | null | undefined;
 
   /**
    * The audio file path that is played by this sound
    */
-  path?: string | undefined | null;
+  path?: string | null | undefined;
 
   /**
    * Is this sound currently playing?
@@ -97,6 +107,7 @@ interface PlaylistSoundDataConstructorData {
   playing?: boolean | null | undefined;
 
   /**
+   * The time in seconds at which playback was paused
    * @defaultValue `null`
    */
   pausedTime?: number | null | undefined;
@@ -113,8 +124,12 @@ interface PlaylistSoundDataConstructorData {
    */
   volume?: number | null | undefined;
 
+  /** A duration in milliseconds to fade volume transition */
   fade?: number | null | undefined;
 
+  /** @defaultValue `0` */
+  sort: number | null | undefined;
+
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
@@ -126,13 +141,14 @@ interface PlaylistSoundDataConstructorData {
  * The data schema for a PlaylistSound embedded document.
  * @see BasePlaylistSound
  */
-export declare class PlaylistSoundData extends DocumentData<
+export class PlaylistSoundData extends DocumentData<
   PlaylistSoundDataSchema,
   PlaylistSoundDataProperties,
   PropertiesToSource<PlaylistSoundDataProperties>,
   PlaylistSoundDataConstructorData,
   documents.BasePlaylistSound
 > {
+  /** @override */
   static defineSchema(): PlaylistSoundDataSchema;
 
   /** @override */

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

@@ -17,9 +17,9 @@ type FieldExclusions =
   | 'hidden';
 
 interface PrototypeTokenDataSchema extends Omit<TokenDataSchema, FieldExclusions> {
-  randomImg: typeof fields.BOOLEAN_FIELD;
+  randomImg: fields.BooleanField;
   img: FieldReturnType<
-    typeof fields.VIDEO_FIELD,
+    fields.VideoField,
     { default: typeof foundry.CONST.DEFAULT_TOKEN; validate: (src: unknown) => boolean }
   >;
 }
@@ -38,18 +38,18 @@ interface PrototypeTokenDataProperties extends Omit<TokenDataProperties, FieldEx
   img: string | null;
 }
 
-export interface PrototypeTokenDataConstructorData extends Omit<TokenDataConstructorData, FieldExclusions> {
+interface PrototypeTokenDataConstructorData extends Omit<TokenDataConstructorData, FieldExclusions> {
   /**
    * Uses a random "wildcard" image path which is resolved with a Token is created
    * @defaultValue `false`
    */
-  randomImg?: boolean | null;
+  randomImg?: boolean | null | undefined;
 
   /**
    * A file path to an image or video file used to depict the Token
    * @defaultValue `CONST.DEFAULT_TOKEN`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 }
 
 export class PrototypeTokenData extends DocumentData<
@@ -59,14 +59,10 @@ export class PrototypeTokenData extends DocumentData<
   PrototypeTokenDataConstructorData,
   documents.BaseActor
 > {
-  /**
-   * @override
-   */
+  /** @override */
   _initialize(): void;
 
-  /**
-   * @override
-   */
+  /** @override */
   toObject(source?: true): ReturnType<this['toJSON']> & { actorId: documents.BaseActor['id'] };
   toObject(source: false): {
     [Key in keyof PrototypeTokenDataSchema as string extends Key ? never : Key]: Key extends keyof this

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

@@ -10,23 +10,24 @@ import * as documents from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface RollTableDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  img: FieldReturnType<typeof fields.IMAGE_FIELD, { default: () => string }>;
-  description: typeof fields.STRING_FIELD;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  img: FieldReturnType<fields.ImageField, { default: () => typeof RollTableData.DEFAULT_ICON }>;
+  description: fields.StringField;
   results: fields.EmbeddedCollectionField<typeof documents.BaseTableResult>;
-  formula: typeof fields.STRING_FIELD;
-  replacement: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
-  displayRoll: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
+  formula: fields.StringField;
+  replacement: FieldReturnType<fields.BooleanField, { default: true }>;
+  displayRoll: FieldReturnType<fields.BooleanField, { default: true }>;
   folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: typeof fields.INTEGER_SORT_FIELD;
-  permission: typeof fields.DOCUMENT_PERMISSIONS;
-  flags: typeof fields.OBJECT_FIELD;
+  sort: fields.IntegerSortField;
+  permission: fields.DocumentPermissions;
+  flags: fields.ObjectField;
 }
 
 interface RollTableDataProperties {
   /**
    * The _id which uniquely identifies this RollTable document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -37,6 +38,7 @@ interface RollTableDataProperties {
 
   /**
    * An image file path which provides the thumbnail artwork for this RollTable
+   * @defaultValue `RollTableData.DEFAULT_ICON`
    */
   img: string;
 
@@ -47,6 +49,7 @@ interface RollTableDataProperties {
 
   /**
    * A Collection of TableResult embedded documents which belong to this RollTable
+   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
    */
   results: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseTableResult>, RollTableData>;
 
@@ -82,7 +85,7 @@ interface RollTableDataProperties {
    * An object which configures user permissions to this RollTable
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission: Partial<Record<string, foundry.CONST.EntityPermission>>;
+  permission: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>>;
 
   /**
    * An object of optional key/value flags
@@ -95,7 +98,7 @@ interface RollTableDataConstructorData {
   /**
    * The _id which uniquely identifies this RollTable document
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this RollTable
@@ -104,70 +107,73 @@ interface RollTableDataConstructorData {
 
   /**
    * An image file path which provides the thumbnail artwork for this RollTable
+   * @defaultValue `RollTableData.DEFAULT_ICON`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * The HTML text description for this RollTable document
    */
-  description?: string | null;
+  description?: string | null | undefined;
 
   /**
    * A Collection of TableResult embedded documents which belong to this RollTable
+   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
    */
-  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null;
+  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null | undefined;
 
   /**
    * The Roll formula which determines the results chosen from the table
    */
-  formula?: string | null;
+  formula?: string | null | undefined;
 
   /**
    * Are results from this table drawn with replacement?
    * @defaultValue `true`
    */
-  replacement?: boolean | null;
+  replacement?: boolean | null | undefined;
 
   /**
    * Is the Roll result used to draw from this RollTable displayed in chat?
    * @defaultValue `true`
    */
-  displayRoll?: boolean | null;
+  displayRoll?: boolean | null | undefined;
 
   /**
    * The _id of a Folder which contains this RollTable
    */
-  folder?: string | null;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The numeric sort value which orders this RollTable relative to its siblings
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this RollTable
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission?: Partial<Record<string, foundry.CONST.EntityPermission>> | null;
+  permission?: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>> | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'RollTable'> | null;
+  flags?: ConfiguredFlags<'RollTable'> | null | undefined;
 }
 
 /**
  * The data schema for an RollTable document.
  * @see BaseRollTable
  */
-export declare class RollTableData extends DocumentData<
+export class RollTableData extends DocumentData<
   RollTableDataSchema,
   RollTableDataProperties,
   PropertiesToSource<RollTableDataProperties>,
   RollTableDataConstructorData,
   documents.BaseRollTable
 > {
+  /** @override */
   static defineSchema(): RollTableDataSchema;
 
   /**
@@ -179,4 +185,4 @@ export declare class RollTableData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface RollTableData extends RollTableDataProperties {}
+export interface RollTableData extends RollTableDataProperties {}