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

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 {}

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

@@ -1,41 +1,46 @@
-import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
 import { DocumentData } from '../../abstract/module.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import * as CONST from '../../constants.mjs';
+import * as fields from '../fields.mjs';
 
 interface MacroDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  type: DocumentField<string> & {
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  type: DocumentField<foundry.CONST.MACRO_TYPES> & {
     type: String;
     required: true;
-    default: typeof CONST.MACRO_TYPES.CHAT;
-    validate: (t: unknown) => boolean;
+    default: typeof foundry.CONST.MACRO_TYPES.CHAT;
+    validate: (t: unknown) => t is foundry.CONST.MACRO_TYPES;
     validationError: 'The provided Macro type must be in CONST.MACRO_TYPES';
   };
   author: fields.ForeignDocumentField<{
     type: typeof documents.BaseUser;
     default: () => Game['user'];
   }>;
-  img: FieldReturnType<typeof fields.IMAGE_FIELD, { required: true; default: typeof CONST.DEFAULT_MACRO_ICON }>;
-  scope: DocumentField<string> & {
+  img: FieldReturnType<fields.ImageField, { required: true; default: typeof MacroData.DEFAULT_ICON }>;
+  scope: DocumentField<foundry.CONST.MACRO_SCOPES> & {
     type: String;
     required: true;
-    default: typeof CONST.MACRO_SCOPES[0];
-    validate: (t: unknown) => boolean;
+    default: typeof foundry.CONST.MACRO_SCOPES[0];
+    validate: (t: unknown) => t is foundry.CONST.MACRO_SCOPES;
     validationError: 'The provided Macro scope must be in CONST.MACRO_SCOPES';
   };
-  command: typeof fields.BLANK_STRING;
+  command: fields.BlankString;
   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 MacroDataProperties {
   /**
    * The _id which uniquely identifies this Macro document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -46,11 +51,13 @@ interface MacroDataProperties {
 
   /**
    * A Macro subtype from CONST.MACRO_TYPES
+   * @defaultValue `foundry.CONST.MACRO_TYPES.CHAT`
    */
-  type: foundry.CONST.MacroTypes;
+  type: foundry.CONST.MACRO_TYPES;
 
   /**
    * The _id of a User document which created this Macro *
+   * @defaultValue `game?.user`
    */
   author: string;
 
@@ -62,13 +69,13 @@ interface MacroDataProperties {
 
   /**
    * The scope of this Macro application from CONST.MACRO_SCOPES
-   * @defaultValue `'global'`
+   * @defaultValue `CONST.MACRO_SCOPES[0]` ("global")
    */
-  scope: foundry.CONST.MacroScopes;
+  scope: foundry.CONST.MACRO_SCOPES;
 
   /**
    * The string content of the macro command
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   command: string;
 
@@ -88,7 +95,7 @@ interface MacroDataProperties {
    * An object which configures user permissions to this Macro
    * @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
@@ -100,8 +107,9 @@ interface MacroDataProperties {
 interface MacroDataConstructorData {
   /**
    * The _id which uniquely identifies this Macro document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this Macro
@@ -110,62 +118,64 @@ interface MacroDataConstructorData {
 
   /**
    * A Macro subtype from CONST.MACRO_TYPES
+   * @defaultValue `foundry.CONST.MACRO_TYPES.CHAT`
    */
-  type?: foundry.CONST.MacroTypes | null;
+  type?: foundry.CONST.MACRO_TYPES | null | undefined;
 
   /**
    * The _id of a User document which created this Macro *
+   * @defaultValue `game?.user`
    */
-  author?: string | null;
+  author?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseUser>> | string | null | undefined;
 
   /**
    * An image file path which provides the thumbnail artwork for this Macro
    * @defaultValue `CONST.DEFAULT_MACRO_ICON`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * The scope of this Macro application from CONST.MACRO_SCOPES
-   * @defaultValue `'global'`
+   * @defaultValue `CONST.MACRO_SCOPES[0]` ("global")
    */
-  scope?: foundry.CONST.MacroScopes | null;
+  scope?: foundry.CONST.MACRO_SCOPES | null | undefined;
 
   /**
    * The string content of the macro command
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
-  command?: string | null;
+  command?: string | null | undefined;
 
   /**
    * The _id of a Folder which contains this Macro
    * @defaultValue `null`
    */
-  folder?: string | null;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The numeric sort value which orders this Macro relative to its siblings
    * @defaultValue `0`
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this Macro
    * @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<'Macro'> | null;
+  flags?: ConfiguredFlags<'Macro'> | null | undefined;
 }
 
 /**
  * The data schema for a Macro document.
  * @see BaseMacro
  */
-export declare class MacroData extends DocumentData<
+export class MacroData extends DocumentData<
   MacroDataSchema,
   MacroDataProperties,
   PropertiesToSource<MacroDataProperties>,
@@ -174,8 +184,15 @@ export declare class MacroData extends DocumentData<
 > {
   constructor(data: MacroDataConstructorData, document?: documents.BaseMacro | null);
 
+  /** @override */
   static defineSchema(): MacroDataSchema;
+
+  /**
+   * The default icon used for newly created Macro documents.
+   * @defaultValue `"icons/svg/dice-target.svg"`
+   */
+  static DEFAULT_ICON: string;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface MacroData extends MacroDataProperties {}
+export interface MacroData extends MacroDataProperties {}

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

@@ -5,34 +5,35 @@ import {
   PropertiesToSource
 } from '../../../../types/helperTypes';
 import { DocumentData } from '../../abstract/module.mjs';
-import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
 
 interface MeasuredTemplateDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
+  _id: fields.DocumentId;
   user: fields.ForeignDocumentField<{ type: typeof documents.BaseUser; required: true }>;
-  t: {
+  t: DocumentField<typeof foundry.CONST.MEASURED_TEMPLATE_TYPES> & {
     type: typeof String;
     required: true;
-    default: typeof CONST.MEASURED_TEMPLATE_TYPES.CIRCLE;
-    validate: (t: unknown) => boolean;
+    default: typeof foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE;
+    validate: (t: unknown) => t is typeof foundry.CONST.MEASURED_TEMPLATE_TYPES;
     validationError: 'Invalid {name} {field} which must be a value in CONST.MEASURED_TEMPLATE_TYPES';
   };
-  x: typeof fields.REQUIRED_NUMBER;
-  y: typeof fields.REQUIRED_NUMBER;
-  distance: FieldReturnType<typeof fields.REQUIRED_POSITIVE_NUMBER, { default: 1 }>;
-  direction: FieldReturnType<typeof fields.ANGLE_FIELD, { default: 0 }>;
-  angle: typeof fields.ANGLE_FIELD;
-  width: FieldReturnType<typeof fields.REQUIRED_POSITIVE_NUMBER, { default: 1 }>;
-  borderColor: FieldReturnType<typeof fields.COLOR_FIELD, { required: true; default: '#000000' }>;
-  fillColor: FieldReturnType<typeof fields.COLOR_FIELD, { required: true; default: '#FF0000' }>;
-  texture: typeof fields.VIDEO_FIELD;
-  flags: typeof fields.OBJECT_FIELD;
+  x: fields.RequiredNumber;
+  y: fields.RequiredNumber;
+  distance: FieldReturnType<fields.RequiredPositiveNumber, { default: 1; validate: (n: number) => boolean }>;
+  direction: FieldReturnType<fields.AngleField, { default: 0 }>;
+  angle: fields.AngleField;
+  width: FieldReturnType<fields.RequiredPositiveNumber, { default: 1 }>;
+  borderColor: FieldReturnType<fields.ColorField, { required: true; default: '#000000' }>;
+  fillColor: FieldReturnType<fields.ColorField, { required: true; default: '#FF0000' }>;
+  texture: fields.VideoField;
+  flags: fields.ObjectField;
 }
 
 interface MeasuredTemplateDataProperties {
   /**
-   The _id which uniquely identifies this BaseMeasuredTemplate embedded document
+   * The _id which uniquely identifies this BaseMeasuredTemplate embedded document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -40,9 +41,9 @@ interface MeasuredTemplateDataProperties {
 
   /**
    * The value in CONST.MEASURED_TEMPLATE_TYPES which defines the geometry type of this template
-   * @defaultValue `'circle'`
+   * @defaultValue `foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE`
    */
-  t: ValueOf<foundry.CONST.MeasuredTemplateTypes>;
+  t: foundry.CONST.MEASURED_TEMPLATE_TYPES;
 
   /**
    * The x-coordinate position of the origin of the template effect
@@ -70,7 +71,7 @@ interface MeasuredTemplateDataProperties {
 
   /**
    * The angle of effect of the measured template, applies to cone types
-   * @defaultValue `0`
+   * @defaultValue `360`
    */
   angle: number;
 
@@ -95,7 +96,7 @@ interface MeasuredTemplateDataProperties {
   /**
    * A repeatable tiling texture used to add a texture fill to the template shape
    */
-  texture: string | undefined | null;
+  texture: string | null | undefined;
 
   /**
    * An object of optional key/value flags
@@ -106,83 +107,84 @@ interface MeasuredTemplateDataProperties {
 
 interface MeasuredTemplateDataConstructorData {
   /**
-   The _id which uniquely identifies this BaseMeasuredTemplate embedded document
+   * The _id which uniquely identifies this BaseMeasuredTemplate embedded document
+   * @defaultValue `null`
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
-  user?: string | null;
+  user?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseUser>> | string | null | undefined;
 
   /**
    * The value in CONST.MEASURED_TEMPLATE_TYPES which defines the geometry type of this template
-   * @defaultValue `'circle'`
+   * @defaultValue `foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE`
    */
-  t?: ValueOf<foundry.CONST.MeasuredTemplateTypes> | null;
+  t?: foundry.CONST.MEASURED_TEMPLATE_TYPES | null | undefined;
 
   /**
    * The x-coordinate position of the origin of the template effect
    * @defaultValue `0`
    */
-  x?: number | null;
+  x?: number | null | undefined;
 
   /**
    * The y-coordinate position of the origin of the template effect
    * @defaultValue `0`
    */
-  y?: number | null;
+  y?: number | null | undefined;
 
   /**
    * The distance of the template effect
    * @defaultValue `1`
    */
-  distance?: number | null;
+  distance?: number | null | undefined;
 
   /**
    * The angle of rotation for the measured template
    * @defaultValue `0`
    */
-  direction?: number | null;
+  direction?: number | null | undefined;
 
   /**
    * The angle of effect of the measured template, applies to cone types
-   * @defaultValue `0`
+   * @defaultValue `360`
    */
-  angle?: number | null;
+  angle?: number | null | undefined;
 
   /**
    * The width of the measured template, applies to ray types
    * @defaultValue `1`
    */
-  width?: number | null;
+  width?: number | null | undefined;
 
   /**
    * A color string used to tint the border of the template shape
    * @defaultValue `'#000000'`
    */
-  borderColor?: string | null;
+  borderColor?: string | null | undefined;
 
   /**
    * A color string used to tint the fill of the template shape
    * @defaultValue `'#FF0000'`
    */
-  fillColor?: string | null;
+  fillColor?: string | null | undefined;
 
   /**
    * A repeatable tiling texture used to add a texture fill to the template shape
    */
-  texture?: string | null;
+  texture?: string | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'MeasuredTemplate'> | null;
+  flags?: ConfiguredFlags<'MeasuredTemplate'> | null | undefined;
 }
 
 /**
  * The data schema for a MeasuredTemplate embedded document.
  * @see BaseMeasuredTemplate
  */
-export declare class MeasuredTemplateData extends DocumentData<
+export class MeasuredTemplateData extends DocumentData<
   MeasuredTemplateDataSchema,
   MeasuredTemplateDataProperties,
   PropertiesToSource<MeasuredTemplateDataProperties>,
@@ -197,6 +199,7 @@ export declare class MeasuredTemplateData extends DocumentData<
     document: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
   );
 
+  /** @override */
   static defineSchema(): MeasuredTemplateDataSchema;
 
   /** @override */
@@ -207,4 +210,4 @@ export declare class MeasuredTemplateData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface MeasuredTemplateData extends MeasuredTemplateDataProperties {}
+export interface MeasuredTemplateData extends MeasuredTemplateDataProperties {}