@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

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

@@ -1,136 +0,0 @@
-import { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface CombatantDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  actorId: fields.ForeignDocumentField<{ type: typeof documents.BaseActor }>;
-  tokenId: fields.ForeignDocumentField<{ type: typeof documents.BaseToken }>;
-  sceneId: fields.ForeignDocumentField<{ type: typeof documents.BaseScene }>;
-  name: fields.StringField;
-  img: fields.ImageField;
-  initiative: fields.NumericField;
-  hidden: fields.BooleanField;
-  defeated: fields.BooleanField;
-  flags: fields.ObjectField;
-}
-
-interface CombatantDataProperties {
-  /**
-   * The _id which uniquely identifies this Combatant embedded document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The _id of an Actor associated with this Combatant
-   * @defaultValue `null`
-   */
-  actorId: string | null;
-
-  /**
-   * The _id of a Token associated with this Combatant
-   * @defaultValue `null`
-   */
-  tokenId: string | null;
-
-  /** @defaultValue `null` */
-  sceneId: string | null;
-
-  /** A customized name which replaces the name of the Token in the tracker */
-  name: string | undefined;
-
-  /** A customized image which replaces the Token image in the tracker */
-  img: string | null | undefined;
-
-  /** The initiative score for the Combatant which determines its turn order */
-  initiative: number | null | undefined;
-
-  /**
-   * Is this Combatant currently hidden?
-   * @defaultValue `false`
-   */
-  hidden: boolean;
-
-  /**
-   * Has this Combatant been defeated?
-   * @defaultValue `false`
-   */
-  defeated: boolean;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Combatant'>;
-}
-
-interface CombatantDataConstructorData {
-  /**
-   * The _id which uniquely identifies this Combatant embedded document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The _id of an Actor associated with this Combatant
-   * @defaultValue `null`
-   */
-  actorId?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseActor>> | string | null | undefined;
-
-  /**
-   * The _id of a Token associated with this Combatant
-   * @defaultValue `null`
-   */
-  tokenId?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseToken>> | string | null | undefined;
-
-  /** @defaultValue `null` */
-  sceneId?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseScene>> | string | null | undefined;
-
-  /** A customized name which replaces the name of the Token in the tracker */
-  name?: string | null | undefined;
-
-  /** A customized image which replaces the Token image in the tracker */
-  img?: string | null | undefined;
-
-  /** The initiative score for the Combatant which determines its turn order */
-  initiative?: number | null | undefined;
-
-  /**
-   * Is this Combatant currently hidden?
-   * @defaultValue `false`
-   */
-  hidden?: boolean | null | undefined;
-
-  /**
-   * Has this Combatant been defeated?
-   * @defaultValue `false`
-   */
-  defeated?: boolean | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Combatant'> | null | undefined;
-}
-
-type CombatantDataSource = PropertiesToSource<CombatantDataProperties>;
-
-/**
- * The data schema for a Combatant embedded document within a CombatEncounter document.
- * @see CombatantData
- */
-export class CombatantData extends DocumentData<
-  CombatantDataSchema,
-  CombatantDataProperties,
-  CombatantDataSource,
-  CombatantDataConstructorData,
-  documents.BaseCombatant
-> {
-  static override defineSchema(): CombatantDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface CombatantData extends CombatantDataProperties {}

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

@@ -1,55 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import { BaseAmbientLight } from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface DarknessActivationSchema extends DocumentSchema {
-  min: FieldReturnType<fields.AlphaField, { default: 0 }>;
-  max: fields.AlphaField;
-}
-
-interface DarknessActivationProperties {
-  /**
-   * The minimum darkness level for which activation occurs
-   * @defaultValue `0`
-   */
-  min: number;
-
-  /**
-   * The maximum darkness level for which activation occurs
-   * @defaultValue `1`
-   */
-  max: number;
-}
-
-interface DarknessActivationConstructorData {
-  /**
-   * The minimum darkness level for which activation occurs
-   * @defaultValue `0`
-   */
-  min?: number | null | undefined;
-
-  /**
-   * The maximum darkness level for which activation occurs
-   * @defaultValue `1`
-   */
-  max?: number | null | undefined;
-}
-
-type DarknessActivationSource = PropertiesToSource<DarknessActivationProperties>;
-
-/**
- * An embedded data object which defines the darkness range during which some attribute is active
- */
-export class DarknessActivation extends DocumentData<
-  DarknessActivationSchema,
-  DarknessActivationProperties,
-  DarknessActivationSource,
-  DarknessActivationConstructorData,
-  BaseAmbientLight
-> {
-  static override defineSchema(): DarknessActivationSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface DarknessActivation extends DarknessActivationProperties {}

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

@@ -1,407 +0,0 @@
-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: fields.DocumentId;
-  author: ForeignDocumentField<{ type: typeof documents.BaseUser; required: true }>;
-  type: DocumentField<foundry.CONST.DRAWING_TYPES> & {
-    type: typeof String;
-    required: true;
-    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: 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;
-    default: [];
-    validate: typeof _validateDrawingPoints;
-    validationError: 'Invalid {name} {field} which must be an array of points [x,y]';
-  };
-  bezierFactor: FieldReturnType<fields.AlphaField, { default: 0 }>;
-  fillType: FieldReturnType<
-    fields.RequiredNumber,
-    {
-      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: 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<
-    fields.PositiveIntegerField,
-    {
-      default: 48;
-      validate: (n: unknown) => boolean;
-      validationError: 'Invalid {name} {field} which must be an integer between 8 and 256';
-    }
-  >;
-  textColor: FieldReturnType<fields.ColorField, { default: '#FFFFFF' }>;
-  textAlpha: fields.AlphaField;
-  hidden: fields.BooleanField;
-  locked: fields.BooleanField;
-  flags: fields.ObjectField;
-}
-
-interface DrawingDataProperties {
-  /**
-   * The _id which uniquely identifies this BaseDrawing embedded document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The _id of the user who created the drawing
-   * @defaultValue `null`
-   */
-  author: string | null;
-
-  /**
-   * The value in CONST.DRAWING_TYPES which defines the geometry type of this drawing
-   * @defaultValue `CONST.DRAWING_TYPES.POLYGON`
-   */
-  type: foundry.CONST.DRAWING_TYPES;
-
-  /**
-   * The x-coordinate position of the top-left corner of the drawn shape
-   * @defaultValue `0`
-   */
-  x: number;
-
-  /**
-   * The y-coordinate position of the top-left corner of the drawn shape
-   * @defaultValue `0`
-   */
-  y: number;
-
-  /**
-   * The pixel width of the drawing figure
-   * @defaultValue `0`
-   */
-  width: number;
-
-  /**
-   * The pixel height of the drawing figure
-   * @defaultValue `0`
-   */
-  height: number;
-
-  /**
-   * The angle of rotation for the drawing figure
-   * @defaultValue `0`
-   */
-  rotation: number;
-
-  /**
-   * The z-index of this drawing relative to other siblings
-   * @defaultValue `0`
-   */
-  z: number;
-
-  /**
-   * An array of points [x,y] which define polygon vertices
-   * @defaultValue `[]`
-   */
-  points: Array<[x: number, y: number]>;
-
-  /**
-   * An amount of bezier smoothing applied, between 0 and 1
-   * @defaultValue `0`
-   */
-  bezierFactor: number;
-
-  /**
-   * The fill type of the drawing shape, a value from CONST.DRAWING_FILL_TYPES
-   * @defaultValue `CONST.DRAWING_FILL_TYPES.NONE`
-   */
-  fillType: foundry.CONST.DRAWING_FILL_TYPES;
-
-  /**
-   * An optional color string with which to fill the drawing geometry
-   */
-  fillColor: string | null | undefined;
-
-  /**
-   * The opacity of the fill applied to the drawing geometry
-   * @defaultValue `0.5`
-   */
-  fillAlpha: number;
-
-  /**
-   * The width in pixels of the boundary lines of the drawing geometry
-   * @defaultValue `8`
-   */
-  strokeWidth: number;
-
-  /**
-   * The color of the boundary lines of the drawing geometry
-   */
-  strokeColor: string | null | undefined;
-
-  /**
-   * The opacity of the boundary lines of the drawing geometry
-   * @defaultValue `1`
-   */
-  strokeAlpha: number;
-
-  /**
-   * The path to a tiling image texture used to fill the drawing geometry
-   */
-  texture: string | null | undefined;
-
-  /**
-   * Optional text which is displayed overtop of the drawing
-   */
-  text: string | undefined;
-
-  /**
-   * The font family used to display text within this drawing
-   * @defaultValue `'Signika'`
-   */
-  fontFamily: string;
-
-  /**
-   * The font size used to display text within this drawing
-   * @defaultValue `48`
-   */
-  fontSize: number;
-
-  /**
-   * The color of text displayed within this drawing
-   * @defaultValue `'#FFFFFF'`
-   */
-  textColor: string | null;
-
-  /**
-   * The opacity of text displayed within this drawing
-   * @defaultValue `1`
-   */
-  textAlpha: number;
-
-  /**
-   * Is the drawing currently hidden?
-   * @defaultValue `false`
-   */
-  hidden: boolean;
-
-  /**
-   * Is the drawing currently locked?
-   * @defaultValue `false`
-   */
-  locked: boolean;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Drawing'>;
-}
-
-interface DrawingDataConstructorData {
-  /**
-   * The _id which uniquely identifies this BaseDrawing embedded document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The _id of the user who created the drawing
-   * @defaultValue `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.DRAWING_TYPES | null | undefined;
-
-  /**
-   * The x-coordinate position of the top-left corner of the drawn shape
-   * @defaultValue `0`
-   */
-  x?: number | null | undefined;
-
-  /**
-   * The y-coordinate position of the top-left corner of the drawn shape
-   * @defaultValue `0`
-   */
-  y?: number | null | undefined;
-
-  /**
-   * The pixel width of the drawing figure
-   * @defaultValue `0`
-   */
-  width?: number | null | undefined;
-
-  /**
-   * The pixel height of the drawing figure
-   * @defaultValue `0`
-   */
-  height?: number | null | undefined;
-
-  /**
-   * The angle of rotation for the drawing figure
-   * @defaultValue `0`
-   */
-  rotation?: number | null | undefined;
-
-  /**
-   * The z-index of this drawing relative to other siblings
-   * @defaultValue `0`
-   */
-  z?: number | null | undefined;
-
-  /**
-   * An array of points [x,y] which define polygon vertices
-   * @defaultValue `[]`
-   */
-  points?: Array<[x: number, y: number]> | null | undefined;
-
-  /**
-   * An amount of bezier smoothing applied, between 0 and 1
-   * @defaultValue `0`
-   */
-  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.DRAWING_FILL_TYPES | null | undefined;
-
-  /**
-   * An optional color string with which to fill the drawing geometry
-   */
-  fillColor?: string | null | undefined;
-
-  /**
-   * The opacity of the fill applied to the drawing geometry
-   * @defaultValue `0.5`
-   */
-  fillAlpha?: number | null | undefined;
-
-  /**
-   * The width in pixels of the boundary lines of the drawing geometry
-   * @defaultValue `8`
-   */
-  strokeWidth?: number | null | undefined;
-
-  /**
-   * The color of the boundary lines of the drawing geometry
-   */
-  strokeColor?: string | null | undefined;
-
-  /**
-   * The opacity of the boundary lines of the drawing geometry
-   * @defaultValue `1`
-   */
-  strokeAlpha?: number | null | undefined;
-
-  /**
-   * The path to a tiling image texture used to fill the drawing geometry
-   */
-  texture?: string | null | undefined;
-
-  /**
-   * Optional text which is displayed overtop of the drawing
-   */
-  text?: string | null | undefined;
-
-  /**
-   * The font family used to display text within this drawing
-   * @defaultValue `'Signika'`
-   */
-  fontFamily?: string | null | undefined;
-
-  /**
-   * The font size used to display text within this drawing
-   * @defaultValue `48`
-   */
-  fontSize?: number | null | undefined;
-
-  /**
-   * The color of text displayed within this drawing
-   * @defaultValue `'#FFFFFF'`
-   */
-  textColor?: string | null | undefined;
-
-  /**
-   * The opacity of text displayed within this drawing
-   * @defaultValue `1`
-   */
-  textAlpha?: number | null | undefined;
-
-  /**
-   * Is the drawing currently hidden?
-   * @defaultValue `false`
-   */
-  hidden?: boolean | null | undefined;
-
-  /**
-   * Is the drawing currently locked?
-   * @defaultValue `false`
-   */
-  locked?: boolean | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Drawing'> | null | undefined;
-}
-
-type DrawingDataSource = PropertiesToSource<DrawingDataProperties>;
-
-/**
- * The data schema for a Drawing embedded document.
- * @see BaseDrawing
- *
- * @param data     - Initial data used to construct the data object
- * @param document - The embedded document to which this data object belongs
- */
-export class DrawingData extends DocumentData<
-  DrawingDataSchema,
-  DrawingDataProperties,
-  DrawingDataSource,
-  DrawingDataConstructorData,
-  documents.BaseFolder
-> {
-  static override defineSchema(): DrawingDataSchema;
-
-  protected override _initialize(): void;
-
-  protected override _validateDocument(): void;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface DrawingData extends DrawingDataProperties {}
-
-/**
- * Validate the array of points which comprises a polygon drawing
- * @param points - The candidate points
- * @returns Is the array valid?
- */
-declare function _validateDrawingPoints(points: number[][]): boolean;

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

@@ -1,80 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import { BaseActiveEffect } from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface EffectChangeDataSchema extends DocumentSchema {
-  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 `""`
-   */
-  key: string;
-
-  /**
-   * The value of the change effect
-   * @defaultValue `""`
-   */
-  value: string;
-
-  /**
-   * The modification mode with which the change is applied
-   * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
-   */
-  mode: number;
-
-  /**
-   * The priority level with which this change is applied
-   */
-  priority: number | null | undefined;
-}
-
-interface EffectChangeDataConstructorData {
-  /**
-   * The attribute path in the Actor or Item data which the change modifies
-   * @defaultValue `""`
-   */
-  key?: string | null | undefined;
-
-  /**
-   * The value of the change effect
-   * @defaultValue `""`
-   */
-  value?: string | null | undefined;
-
-  /**
-   * The modification mode with which the change is applied
-   * @defaultValue `CONST.ACTIVE_EFFECT_MODES.ADD`
-   */
-  mode?: number | null | undefined;
-
-  /**
-   * The priority level with which this change is applied
-   */
-  priority?: number | null | undefined;
-}
-
-type EffectChangeDataSource = PropertiesToSource<EffectChangeDataProperties>;
-
-/**
- * An embedded data structure which defines the structure of a change applied by an ActiveEffect.
- * @see ActiveEffectData
- */
-export class EffectChangeData extends DocumentData<
-  EffectChangeDataSchema,
-  EffectChangeDataProperties,
-  EffectChangeDataSource,
-  EffectChangeDataConstructorData,
-  BaseActiveEffect
-> {
-  static override defineSchema(): EffectChangeDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface EffectChangeData extends EffectChangeDataProperties {}