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

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

@@ -1,18 +1,18 @@
+import { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
 import DocumentData from '../../abstract/data.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import { ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
+import * as fields from '../fields.mjs';
 
 interface FolderDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  type: DocumentField<foundry.CONST.FolderEntityTypes> & {
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  type: DocumentField<foundry.CONST.FOLDER_DOCUMENT_TYPES> & {
     type: String;
     required: true;
-    validate: (t: unknown) => t is foundry.CONST.FolderEntityTypes;
+    validate: (t: unknown) => t is foundry.CONST.FOLDER_DOCUMENT_TYPES;
     validationError: 'Invalid Folder type provided';
   };
-  description: typeof fields.STRING_FIELD;
+  description: fields.StringField;
   parent: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
   sorting: DocumentField<SortingModes> & {
     type: String;
@@ -21,14 +21,15 @@ interface FolderDataSchema extends DocumentSchema {
     validate: (mode: unknown) => mode is SortingModes;
     validationError: 'Invalid Folder sorting mode';
   };
-  sort: typeof fields.INTEGER_SORT_FIELD;
-  color: typeof fields.COLOR_FIELD;
-  flags: typeof fields.OBJECT_FIELD;
+  sort: fields.IntegerSortField;
+  color: fields.ColorField;
+  flags: fields.ObjectField;
 }
 
 interface FolderDataProperties {
   /**
    * The _id which uniquely identifies this Folder document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -38,14 +39,14 @@ interface FolderDataProperties {
   name: string;
 
   /**
-   * The document type which this Folder contains, from CONST.FOLDER_ENTITY_TYPES
+   * The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES
    */
-  type: foundry.CONST.FolderEntityTypes;
+  type: foundry.CONST.FOLDER_DOCUMENT_TYPES;
 
   /**
    * An HTML description of the contents of this folder
    */
-  description?: string;
+  description?: string | undefined;
 
   /**
    * The _id of a parent Folder which contains this Folder
@@ -68,7 +69,7 @@ interface FolderDataProperties {
   /**
    * A color string used for the background color of this Folder
    */
-  color?: string | null;
+  color: string | null | undefined;
 
   /**
    * An object of optional key/value flags
@@ -80,8 +81,9 @@ interface FolderDataProperties {
 interface FolderDataConstructorData {
   /**
    * The _id which uniquely identifies this Folder document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this Folder
@@ -89,49 +91,49 @@ interface FolderDataConstructorData {
   name: string;
 
   /**
-   * The document type which this Folder contains, from CONST.FOLDER_ENTITY_TYPES
+   * The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES
    */
-  type: foundry.CONST.FolderEntityTypes;
+  type: foundry.CONST.FOLDER_DOCUMENT_TYPES;
 
   /**
    * An HTML description of the contents of this folder
    */
-  description?: string | null;
+  description?: string | null | undefined;
 
   /**
    * The _id of a parent Folder which contains this Folder
    * @defaultValue `null`
    */
-  parent?: string | null;
+  parent?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The sorting mode used to organize documents within this Folder, in ["a", "m"]
    * @defaultValue `'a'`
    */
-  sorting?: SortingModes | null;
+  sorting?: SortingModes | null | undefined;
 
   /**
    * The numeric sort value which orders this Folder relative to its siblings
    * @defaultValue `0`
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * A color string used for the background color of this Folder
    */
-  color?: string | null;
+  color?: string | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'Folder'> | null;
+  flags?: ConfiguredFlags<'Folder'> | null | undefined;
 }
 
 /**
  * The data schema for a Folder document.
  */
-export declare class FolderData extends DocumentData<
+export class FolderData extends DocumentData<
   FolderDataSchema,
   FolderDataProperties,
   PropertiesToSource<FolderDataProperties>,
@@ -140,6 +142,7 @@ export declare class FolderData extends DocumentData<
 > {
   constructor(data: FolderDataConstructorData, document?: documents.BaseFolder | null);
 
+  /** @override */
   static defineSchema(): FolderDataSchema;
 
   static SORTING_MODES: ['a', 'm'];
@@ -148,4 +151,4 @@ export declare class FolderData extends DocumentData<
 export type SortingModes = ValueOf<typeof FolderData.SORTING_MODES>;
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface FolderData extends FolderDataProperties {}
+export interface FolderData extends FolderDataProperties {}

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

@@ -1,8 +1,12 @@
 export { ActiveEffectData } from './activeEffectData';
 export { ActorData } from './actorData';
+export { AdventureData } from './adventureData';
 export { AmbientLightData } from './ambientLightData';
 export { AmbientSoundData } from './ambientSoundData';
 export { ChatMessageData } from './chatMessageData';
+export { CardData } from './cardData';
+export { CardFaceData } from './cardFaceData';
+export { CardsData } from './cardsData';
 export { CombatantData } from './combatantData';
 export { CombatData } from './combatData';
 export { DrawingData } from './drawingData';
@@ -10,6 +14,7 @@ export { FogExplorationData } from './fogExplorationData';
 export { FolderData } from './folderData';
 export { ItemData } from './itemData';
 export { JournalEntryData } from './journalEntryData';
+export { LightData } from './lightData';
 export { MacroData } from './macroData';
 export { MeasuredTemplateData } from './measuredTemplateData';
 export { NoteData } from './noteData';

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

@@ -1,4 +1,3 @@
-import EmbeddedCollection from '../../abstract/embedded-collection.mjs';
 import {
   ConfiguredData,
   ConfiguredDocumentClass,
@@ -7,31 +6,33 @@ import {
   FieldReturnType,
   PropertiesToSource
 } from '../../../../types/helperTypes';
+import EmbeddedCollection from '../../abstract/embedded-collection.mjs';
 import { DocumentData } from '../../abstract/module.mjs';
 import * as documents from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface ItemDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
   type: DocumentField<string> & {
     type: typeof String;
     required: true;
     validate: (t: unknown) => boolean;
     validationError: 'The provided Item type must be in the array of types defined by the game system';
   };
-  img: FieldReturnType<typeof fields.IMAGE_FIELD, { default: () => string }>;
-  data: FieldReturnType<typeof fields.OBJECT_FIELD, { default: (data: { type: string }) => any }>; // TODO
+  img: FieldReturnType<fields.ImageField, { default: () => typeof ItemData.DEFAULT_ICON }>;
+  data: fields.SystemDataField;
   effects: fields.EmbeddedCollectionField<typeof documents.BaseActiveEffect>;
   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 ItemDataBaseProperties {
   /**
    * The _id which uniquely identifies this Item document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -53,11 +54,13 @@ interface ItemDataBaseProperties {
 
   /**
    * The system data object which is defined by the system template.json model
+   * @defaultValue template from template.json for type or `{}`
    */
   data: object;
 
   /**
    * A collection of ActiveEffect embedded Documents
+   * @defaultValue `new EmbeddedCollection(ActiveEffectData, [], BaseActiveEffect.implementation)`
    */
   effects: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseActiveEffect>, ItemData>;
 
@@ -77,7 +80,7 @@ interface ItemDataBaseProperties {
    * An object which configures user permissions to this Item
    * @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
@@ -89,8 +92,9 @@ interface ItemDataBaseProperties {
 interface ItemDataConstructorData {
   /**
    * The _id which uniquely identifies this Item document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this Item
@@ -106,41 +110,43 @@ interface ItemDataConstructorData {
    * An image file path which provides the artwork for this Item
    * @defaultValue `ItemData.DEFAULT_ICON`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * The system data object which is defined by the system template.json model
+   * @defaultValue template from template.json for type or `{}`
    */
-  data?: DeepPartial<ItemDataSource['data']> | null;
+  data?: DeepPartial<ItemDataSource['data']> | null | undefined;
 
   /**
    * A collection of ActiveEffect embedded Documents
+   * @defaultValue `new EmbeddedCollection(ActiveEffectData, [], BaseActiveEffect.implementation)`
    */
-  effects?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseActiveEffect>>[0][] | null;
+  effects?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseActiveEffect>>[0][] | null | undefined;
 
   /**
    * The _id of a Folder which contains this Item
    * @defaultValue `null`
    */
-  folder?: string | null;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The numeric sort value which orders this Item relative to its siblings
    * @defaultValue `0`
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this Item
    * @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<'Item'> | null;
+  flags?: ConfiguredFlags<'Item'> | null | undefined;
 }
 
 type ItemDataBaseSource = PropertiesToSource<ItemDataBaseProperties>;
@@ -152,6 +158,7 @@ type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentDa
 interface ItemDataConstructor extends DocumentDataConstructor {
   new (data: ItemDataConstructorData, document?: documents.BaseItem | null): ItemData;
 
+  /** @override */
   defineSchema(): ItemDataSchema;
 
   /**
@@ -173,6 +180,7 @@ export type ItemData = DocumentData<
   documents.BaseItem
 > &
   ItemDataProperties & {
+    /** @override */
     _initializeSource(data: ItemDataConstructorData): ItemDataSource;
   };
-export declare const ItemData: ItemDataConstructor;
+export const ItemData: ItemDataConstructor;

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

@@ -1,17 +1,17 @@
+import { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
 import { DocumentData } from '../../abstract/module.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import { ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
+import * as fields from '../fields.mjs';
 
 interface JournalEntryDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  content: typeof fields.BLANK_STRING;
-  img: typeof fields.IMAGE_FIELD;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  content: fields.BlankString;
+  img: fields.ImageField;
   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 JournalEntryDataProperties {
@@ -28,7 +28,7 @@ interface JournalEntryDataProperties {
 
   /**
    * The HTML content of the JournalEntry
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   content: string;
 
@@ -53,7 +53,7 @@ interface JournalEntryDataProperties {
    * An object which configures user permissions to this JournalEntry
    * @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
@@ -67,7 +67,7 @@ interface JournalEntryConstructorData {
    * The _id which uniquely identifies this JournalEntry document
    * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this JournalEntry
@@ -76,45 +76,45 @@ interface JournalEntryConstructorData {
 
   /**
    * The HTML content of the JournalEntry
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
-  content?: string | null;
+  content?: string | null | undefined;
 
   /**
    * An image file path which provides the artwork for this JournalEntry
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * The _id of a Folder which contains this JournalEntry
    * @defaultValue `null`
    */
-  folder?: string | null;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The numeric sort value which orders this JournalEntry relative to its siblings
    * @defaultValue `0`
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this JournalEntry
    * @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<'JournalEntry'> | null;
+  flags?: ConfiguredFlags<'JournalEntry'> | null | undefined;
 }
 
 /**
  * The data schema for a JournalEntry document.
  * @see BaseJournalEntry
  */
-export declare class JournalEntryData extends DocumentData<
+export class JournalEntryData extends DocumentData<
   JournalEntryDataSchema,
   JournalEntryDataProperties,
   PropertiesToSource<JournalEntryDataProperties>,
@@ -123,6 +123,7 @@ export declare class JournalEntryData extends DocumentData<
 > {
   constructor(data: JournalEntryConstructorData, document?: documents.BaseJournalEntry | null);
 
+  /** @override */
   static defineSchema(): JournalEntryDataSchema;
 }
 

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

@@ -0,0 +1,228 @@
+import type { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes.js';
+import { DocumentData } from '../../abstract/module.mjs';
+import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
+import type { AnimationData, AnimationDataConstructorData } from './animationData.js';
+import type { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation.js';
+
+interface LightDataSchema extends DocumentSchema {
+  alpha: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
+  angle: fields.AngleField;
+  bright: fields.NonnegativeNumberField;
+  color: fields.ColorField;
+  coloration: FieldReturnType<fields.NonnegativeIntegerField, { default: 1 }>;
+  dim: fields.NonnegativeNumberField;
+  gradual: FieldReturnType<fields.BooleanField, { default: true }>;
+  luminosity: FieldReturnType<LightData.LightUniformField, { default: 0.5 }>;
+  saturation: LightData.LightUniformField;
+  contrast: LightData.LightUniformField;
+  shadows: LightData.LightUniformField;
+  animation: DocumentField<AnimationData> & {
+    type: typeof AnimationData;
+    required: true;
+    default: Record<string, never>;
+  };
+  darkness: DocumentField<DarknessActivation> & {
+    type: typeof DarknessActivation;
+    required: true;
+    default: Record<string, never>;
+  };
+}
+
+interface LightDataProperties {
+  /**
+   * An opacity for the emitted light, if any
+   * @defaultValue `0.5`
+   */
+  alpha: number;
+
+  /**
+   * The angle of emission for this point source
+   * @defaultValue `360`
+   */
+  angle: number;
+
+  /**
+   * The allowed radius of bright vision or illumination
+   * @defaultValue `0`
+   */
+  bright: number;
+
+  /** A tint color for the emitted light, if any */
+  color: string | null | undefined;
+
+  /**
+   * The coloration technique applied in the shader
+   * @defaultValue `1`
+   */
+  coloration: number;
+
+  /**
+   * The allowed radius of dim vision or illumination
+   * @defaultValue `0`
+   */
+  dim: number;
+
+  /**
+   * Fade the difference between bright, dim, and dark gradually?
+   * @defaultValue `true`
+   */
+  gradual: boolean;
+
+  /**
+   * The luminosity applied in the shader
+   * @defaultValue `0.5`
+   */
+  luminosity: number;
+
+  /**
+   * The amount of color saturation this light applies to the background texture
+   * @defaultValue `0`
+   */
+  saturation: number;
+
+  /**
+   * The amount of contrast this light applies to the background texture
+   * @defaultValue `0`
+   */
+  contrast: number;
+
+  /**
+   * The depth of shadows this light applies to the background texture
+   * @defaultValue `0`
+   */
+  shadows: number;
+
+  /**
+   * An animation configuration for the source
+   * @defaultValue `new AnimationData({})`
+   */
+  animation: AnimationData;
+
+  /**
+   * A darkness range (min and max) for which the source should be active
+   * @defaultValue `new DarknessActivation({})`
+   */
+  darkness: DarknessActivation;
+}
+
+interface LightDataConstructorData {
+  /**
+   * An opacity for the emitted light, if any
+   * @defaultValue `0.5`
+   */
+  alpha?: number | null | undefined;
+
+  /**
+   * The angle of emission for this point source
+   * @defaultValue `360`
+   */
+  angle?: number | null | undefined;
+
+  /**
+   * The allowed radius of bright vision or illumination
+   * @defaultValue `0`
+   */
+  bright?: number | null | undefined;
+
+  /** A tint color for the emitted light, if any */
+  color?: string | null | undefined;
+
+  /**
+   * The coloration technique applied in the shader
+   * @defaultValue `1`
+   */
+  coloration?: number | null | undefined;
+
+  /**
+   * The allowed radius of dim vision or illumination
+   * @defaultValue `0`
+   */
+  dim?: number | null | undefined;
+
+  /**
+   * Fade the difference between bright, dim, and dark gradually?
+   * @defaultValue `true`
+   */
+  gradual?: boolean | null | undefined;
+
+  /**
+   * The luminosity applied in the shader
+   * @defaultValue `0.5`
+   */
+  luminosity?: number | null | undefined;
+
+  /**
+   * The amount of color saturation this light applies to the background texture
+   * @defaultValue `0`
+   */
+  saturation?: number | null | undefined;
+
+  /**
+   * The amount of contrast this light applies to the background texture
+   * @defaultValue `0`
+   */
+  contrast?: number | null | undefined;
+
+  /**
+   * The depth of shadows this light applies to the background texture
+   * @defaultValue `0`
+   */
+  shadows?: number | null | undefined;
+
+  /**
+   * An animation configuration for the source
+   * @defaultValue `new AnimationData({})`
+   */
+  animation?: AnimationDataConstructorData | null | undefined;
+
+  /**
+   * A darkness range (min and max) for which the source should be active
+   * @defaultValue `new DarknessActivation({})`
+   */
+  darkness?: DarknessActivationConstructorData | null | undefined;
+}
+
+/**
+ * A reusable document structure for the internal data used to render the appearance of a light source.
+ * This is re-used by both the AmbientLightData and TokenData classes.
+ */
+export class LightData extends DocumentData<
+  LightDataSchema,
+  LightDataProperties,
+  PropertiesToSource<LightDataProperties>,
+  LightDataConstructorData,
+  documents.BaseAmbientLight | documents.BaseToken
+> {
+  /** @override */
+  static defineSchema(): LightDataSchema;
+
+  /**
+   * A reusable field definition for uniform fields used by LightData
+   */
+  static LIGHT_UNIFORM_FIELD: LightData.LightUniformField;
+
+  /** @override */
+  _initializeSource(data: LightDataConstructorData): PropertiesToSource<LightDataProperties>;
+
+  /** @override */
+  protected _initialize(): void;
+}
+
+declare namespace LightData {
+  /**
+   * Property type: `number`
+   * Constructor type: `number | null | undefined`
+   * Default: `0`
+   */
+  interface LightUniformField {
+    type: typeof Number;
+    required: true;
+    default: 0;
+    validate: (n: number) => boolean;
+    validationError: '{name} {field} "{value}" is not a number between -1 and 1';
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LightData extends LightDataProperties {}