@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

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

@@ -1,168 +0,0 @@
-import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-import { EffectChangeData, EffectChangeDataConstructorData } from './effectChangeData';
-import { EffectDurationData, EffectDurationDataConstructorData } from './effectDurationData';
-
-interface ActiveEffectDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  changes: DocumentField<EffectChangeData[]> & {
-    type: [typeof EffectChangeData];
-    required: true;
-    default: [];
-  };
-  disabled: fields.BooleanField;
-  duration: DocumentField<EffectDurationData> & {
-    type: typeof EffectDurationData;
-    required: true;
-    default: Record<string, never>;
-  };
-  icon: fields.ImageField;
-  label: fields.BlankString;
-  origin: fields.StringField;
-  tint: fields.ColorField;
-  transfer: FieldReturnType<fields.BooleanField, { default: true }>;
-  flags: fields.ObjectField;
-}
-
-interface CoreFlags {
-  core?: { statusId?: string; overlay?: boolean };
-}
-
-interface ActiveEffectDataProperties {
-  /**
-   * The _id which uniquely identifies the ActiveEffect within a parent Actor or Item
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The array of EffectChangeData objects which the ActiveEffect applies
-   * @defaultValue `[]`
-   */
-  changes: EffectChangeData[];
-
-  /**
-   * Is this ActiveEffect currently disabled?
-   * @defaultValue `false`
-   */
-  disabled: boolean;
-
-  /**
-   * An EffectDurationData object which describes the duration of the ActiveEffect
-   * @defaultValue `new EffectDurationData({})`
-   */
-  duration: EffectDurationData;
-
-  /**
-   * An icon image path used to depict the ActiveEffect
-   */
-  icon: string | null | undefined;
-
-  /**
-   * A text label which describes the name of the ActiveEffect
-   * @defaultValue `""`
-   */
-  label: string;
-
-  /**
-   * A UUID reference to the document from which this ActiveEffect originated
-   */
-  origin: string | undefined;
-
-  /**
-   * A color string which applies a tint to the ActiveEffect icon
-   */
-  tint: string | null | undefined;
-
-  /**
-   * Does this ActiveEffect automatically transfer from an Item to an Actor?
-   * @defaultValue `true`
-   */
-  transfer: boolean;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'ActiveEffect'> & CoreFlags;
-}
-
-interface ActiveEffectDataConstructorData {
-  /**
-   * The _id which uniquely identifies the ActiveEffect within a parent Actor or Item
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The array of EffectChangeData objects which the ActiveEffect applies
-   * @defaultValue `[]`
-   */
-  changes?: EffectChangeDataConstructorData[] | null | undefined;
-
-  /**
-   * Is this ActiveEffect currently disabled?
-   * @defaultValue `false`
-   */
-  disabled?: boolean | null | undefined;
-
-  /**
-   * An EffectDurationData object which describes the duration of the ActiveEffect
-   * @defaultValue `new EffectDurationData({})`
-   */
-  duration?: EffectDurationDataConstructorData | null | undefined;
-
-  /**
-   * An icon image path used to depict the ActiveEffect
-   */
-  icon?: string | null | undefined;
-
-  /**
-   * A text label which describes the name of the ActiveEffect
-   * @defaultValue `""`
-   */
-  label?: string | null | undefined;
-
-  /**
-   * A UUID reference to the document from which this ActiveEffect originated
-   */
-  origin?: string | null | undefined;
-
-  /**
-   * A color string which applies a tint to the ActiveEffect icon
-   */
-  tint?: string | null | undefined;
-
-  /**
-   * Does this ActiveEffect automatically transfer from an Item to an Actor?
-   * @defaultValue `true`
-   */
-  transfer?: boolean | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: (ConfiguredFlags<'ActiveEffect'> & CoreFlags) | null | undefined;
-}
-
-type ActiveEffectDataSource = PropertiesToSource<ActiveEffectDataProperties>;
-
-/**
- * The data schema for an ActiveEffect document.
- * @see BaseActiveEffect
- */
-export class ActiveEffectData extends DocumentData<
-  ActiveEffectDataSchema,
-  ActiveEffectDataProperties,
-  ActiveEffectDataSource,
-  ActiveEffectDataConstructorData,
-  documents.BaseActiveEffect
-> {
-  static override defineSchema(): ActiveEffectDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ActiveEffectData extends ActiveEffectDataProperties {}

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

@@ -1,219 +0,0 @@
-import {
-  ConfiguredData,
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  ConfiguredSource,
-  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 { PrototypeTokenData } from '../data.mjs';
-import * as fields from '../fields.mjs';
-import { PrototypeTokenDataConstructorData } from './prototypeTokenData';
-
-interface ActorDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  type: DocumentField<string> & {
-    type: typeof String;
-    required: true;
-    validate: (t: unknown) => boolean;
-    validationError: 'The provided Actor type must be in the array of types defined by the game system';
-  };
-  img: FieldReturnType<fields.ImageField, { default: () => string }>;
-  data: fields.SystemDataField;
-  token: DocumentField<PrototypeTokenData> & {
-    type: typeof PrototypeTokenData;
-    required: true;
-    default: (data: unknown) => { name: string; img: string };
-  };
-  items: fields.EmbeddedCollectionField<typeof documents.BaseItem>;
-  effects: fields.EmbeddedCollectionField<typeof documents.BaseActiveEffect>;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: fields.IntegerSortField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface ActorDataBaseProperties {
-  /**
-   * The _id which uniquely identifies this Actor document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this Actor
-   */
-  name: string;
-
-  /**
-   * An Actor subtype which configures the system data model applied
-   */
-  type: string;
-
-  /**
-   * An image file path which provides the artwork for this Actor
-   * @defaultValue `ActorDataConstructor.DEFAULT_ICON`
-   */
-  img: string | null;
-
-  /**
-   * The system data object which is defined by the system template.json model
-   * @defaultValue template from template.json for type or `{}`
-   */
-  data: object;
-
-  /**
-   * Default Token settings which are used for Tokens created from this Actor
-   * @defaultValue `new PrototypeTokenData({ this.data.name, this.data.img })`
-   */
-  token: PrototypeTokenData;
-
-  /**
-   * A Collection of Item embedded Documents
-   * @defaultValue `new EmbeddedCollection(ItemData, [], BaseItem.implementation)`
-   */
-  items: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseItem>, ActorData>;
-
-  /**
-   * A collection of ActiveEffect embedded Documents
-   * @defaultValue `new EmbeddedCollection(ActiveEffectData, [], BaseActiveEffect.implementation)`
-   */
-  effects: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseActiveEffect>, ActorData>;
-
-  /**
-   * The _id of a Folder which contains this Actor
-   * @defaultValue `null`
-   */
-  folder: string | null;
-
-  /**
-   * The numeric sort value which orders this Actor relative to its siblings
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object which configures user permissions to this Actor
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>>;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Actor'>;
-}
-
-interface ActorDataConstructorData {
-  /**
-   * The _id which uniquely identifies this Actor document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this Actor
-   */
-  name: string;
-
-  /**
-   * An Actor subtype which configures the system data model applied
-   */
-  type: ActorDataSource['type'];
-
-  /**
-   * An image file path which provides the artwork for this Actor
-   * @defaultValue `ActorDataConstructor.DEFAULT_ICON`
-   */
-  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<ActorDataSource['data']> | null | undefined;
-
-  /**
-   * Default Token settings which are used for Tokens created from this Actor
-   * @defaultValue `new PrototypeTokenData({ this.data.name, this.data.img })`
-   */
-  token?: PrototypeTokenDataConstructorData | null | undefined;
-
-  /**
-   * A Collection of Item embedded Documents
-   * @defaultValue `new EmbeddedCollection(ItemData, [], BaseItem.implementation)`
-   */
-  items?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseItem>>[0][] | null | undefined;
-
-  /**
-   * A collection of ActiveEffect embedded Documents
-   * @defaultValue `new EmbeddedCollection(ActiveEffectData, [], BaseActiveEffect.implementation)`
-   */
-  effects?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseActiveEffect>>[0][] | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this Actor
-   * @defaultValue `null`
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The numeric sort value which orders this Actor relative to its siblings
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this Actor
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission?: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>> | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Actor'> | null | undefined;
-}
-
-type ActorDataBaseSource = PropertiesToSource<ActorDataBaseProperties>;
-type ActorDataProperties = ActorDataBaseProperties & ConfiguredData<'Actor'>;
-type ActorDataSource = ActorDataBaseSource & ConfiguredSource<'Actor'>;
-
-type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentData>;
-
-interface ActorDataConstructor extends DocumentDataConstructor {
-  new (data: ActorDataConstructorData, document?: documents.BaseActor | null): ActorData;
-
-  defineSchema(): ActorDataSchema;
-
-  /**
-   * The default icon used for newly created Actor documents
-   * @defaultValue `CONST.DEFAULT_TOKEN`
-   */
-  DEFAULT_ICON: string;
-}
-
-/**
- * The data schema for an Actor document.
- * @see BaseActor
- */
-export type ActorData = DocumentData<
-  ActorDataSchema,
-  ActorDataProperties,
-  ActorDataSource,
-  ActorDataConstructorData,
-  documents.BaseActor
-> &
-  ActorDataProperties & {
-    _initializeSource(data: ActorDataConstructorData): ActorDataSource;
-
-    _initialize(): void;
-  };
-
-export const ActorData: ActorDataConstructor;

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

@@ -1,166 +0,0 @@
-import type { PropertiesToSource } from '../../../../types/helperTypes';
-import type DocumentData from '../../abstract/data.mjs';
-import { AnyDocumentData } from '../../abstract/data.mjs';
-import * as fields from '../fields.mjs';
-import type { ActorData, ActorDataConstructorData } from './actorData';
-import type { CardsData, CardsDataConstructorData } from './cardsData';
-import type { CombatData, CombatDataConstructorData } from './combatData';
-import type { FolderData, FolderDataConstructorData } from './folderData';
-import type { ItemData, ItemDataConstructorData } from './itemData';
-import type { JournalEntryData, JournalEntryDataConstructorData } from './journalEntryData';
-import type { MacroData, MacroDataConstructorData } from './macroData';
-import type { PlaylistData, PlaylistDataConstructorData } from './playlistData';
-import type { RollTableData, RollTableDataConstructorData } from './rollTableData';
-import type { SceneData, SceneDataConstructorData } from './sceneData';
-
-interface AdventureDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  img: fields.ImageField;
-  description: fields.BlankString;
-  actors: AdventureDocumentsField<typeof ActorData>;
-  combats: AdventureDocumentsField<typeof CombatData>;
-  items: AdventureDocumentsField<typeof ItemData>;
-  scenes: AdventureDocumentsField<typeof SceneData>;
-  journal: AdventureDocumentsField<typeof JournalEntryData>;
-  tables: AdventureDocumentsField<typeof RollTableData>;
-  macros: AdventureDocumentsField<typeof MacroData>;
-  cards: AdventureDocumentsField<typeof CardsData>;
-  playlists: AdventureDocumentsField<typeof PlaylistData>;
-  folders: AdventureDocumentsField<typeof FolderData>;
-  sort: fields.IntegerSortField;
-  flags: fields.ObjectField;
-}
-
-interface AdventureDataProperties {
-  /** @defaultValue `null` */
-  _id: string | null;
-
-  name: string;
-
-  img: string | null | undefined;
-
-  /** @defaultValue `""` */
-  description: string;
-
-  /** @defaultValue `[]` */
-  actors: ActorData[];
-
-  /** @defaultValue `[]` */
-  combats: CombatData[];
-
-  /** @defaultValue `[]` */
-  items: ItemData[];
-
-  /** @defaultValue `[]` */
-  scenes: SceneData[];
-
-  /** @defaultValue `[]` */
-  journal: JournalEntryData[];
-
-  /** @defaultValue `[]` */
-  tables: RollTableData[];
-
-  /** @defaultValue `[]` */
-  macros: MacroData[];
-
-  /** @defaultValue `[]` */
-  cards: CardsData[];
-
-  /** @defaultValue `[]` */
-  playlists: PlaylistData[];
-
-  /** @defaultValue `[]` */
-  folders: FolderData[];
-
-  /** @defaultValue `0` */
-  sort: number;
-
-  /** @defaultValue `{}` */
-  flags: Record<string, unknown>;
-}
-
-interface AdventureDataConstructorData {
-  /** @defaultValue `null` */
-  _id?: string | null | undefined;
-
-  name: string;
-
-  img?: string | null | undefined;
-
-  /** @defaultValue `""` */
-  description?: string | null | undefined;
-
-  /** @defaultValue `[]` */
-  actors?: ActorDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  combats?: CombatDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  items?: ItemDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  scenes?: SceneDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  journal?: JournalEntryDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  tables?: RollTableDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  macros?: MacroDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  cards?: CardsDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  playlists?: PlaylistDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `[]` */
-  folders?: FolderDataConstructorData[] | null | undefined;
-
-  /** @defaultValue `0` */
-  sort?: number | null | undefined;
-
-  /** @defaultValue `{}` */
-  flags?: Record<string, unknown> | null | undefined;
-}
-
-type AdventureDataSource = PropertiesToSource<AdventureDataProperties>;
-
-/**
- * A data schema which encompasses a collection of base Documents which comprise an adventure module.
- *
- * WARNING: This data schema is an early prototype which will be fully implemented in V10.
- * Until then it is for internal use only. Use this at your own risk.
- * @internal
- *
- * @see BaseAdventure
- */
-export class AdventureData extends DocumentData<
-  AdventureDataSchema,
-  AdventureDataProperties,
-  AdventureDataSource,
-  AdventureDataConstructorData
-> {
-  static override defineSchema(): AdventureDataSchema;
-
-  /**
-   * A type of data field which stores a collection of document data objects
-   * @typeParam D - the type of the DocumentData constructor
-   */
-  static ADVENTURE_DOCUMENTS_FIELD<D extends ConstructorOf<AnyDocumentData>>(dataCls: D): AdventureDocumentsField<D>;
-}
-
-/**
- * Property type: `D[]`
- * Constructor type: `ConstructorDataType<D>[] | null | undefined`
- * Default: `[]`
- */
-type AdventureDocumentsField<D extends ConstructorOf<AnyDocumentData>> = DocumentField<D> & {
-  type: [D];
-  required: true;
-  default: [];
-};

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

@@ -1,154 +0,0 @@
-import { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import { BaseAmbientLight } from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-import type { LightData, LightDataConstructorData } from './lightData';
-
-interface AmbientLightDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  x: fields.RequiredNumber;
-  y: fields.RequiredNumber;
-  rotation: FieldReturnType<fields.AngleField, { default: 0 }>;
-  walls: FieldReturnType<fields.BooleanField, { default: true }>;
-  vision: fields.BooleanField;
-  config: DocumentField<LightData> & {
-    type: typeof LightData;
-    required: true;
-    default: Record<string, never>;
-  };
-  hidden: fields.BooleanField;
-  flags: fields.ObjectField;
-}
-
-interface AmbientLightDataProperties {
-  /**
-   * The _id which uniquely identifies this BaseAmbientLight embedded document
-   */
-  _id: string | null;
-
-  /**
-   * The x-coordinate position of the origin of the light
-   * @defaultValue `0`
-   */
-  x: number;
-
-  /**
-   * The y-coordinate position of the origin of the light
-   * @defaultValue `0`
-   */
-  y: number;
-
-  /**
-   * The angle of rotation for the tile between 0 and 360
-   * @defaultValue `0`
-   */
-  rotation: number;
-
-  /**
-   * Whether or not this light source is constrained by Walls
-   * @defaultValue `true`
-   */
-  walls: boolean;
-
-  /**
-   * Whether or not this light source provides a source of vision
-   * @defaultValue `false`
-   */
-  vision: boolean;
-
-  /**
-   * Light configuration data
-   * @defaultValue `new LightData({})`
-   */
-  config: LightData;
-
-  /**
-   * Is the light source currently hidden?
-   * @defaultValue `false`
-   */
-  hidden: boolean;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'AmbientLight'>;
-}
-
-interface AmbientLightDataConstructorData {
-  /**
-   * The _id which uniquely identifies this BaseAmbientLight embedded document
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The x-coordinate position of the origin of the light
-   * @defaultValue `0`
-   */
-  x?: number | null | undefined;
-
-  /**
-   * The y-coordinate position of the origin of the light
-   * @defaultValue `0`
-   */
-  y?: number | null | undefined;
-
-  /**
-   * The angle of rotation for the tile between 0 and 360
-   * @defaultValue `0`
-   */
-  rotation?: number | null | undefined;
-
-  /**
-   * Whether or not this light source is constrained by Walls
-   * @defaultValue `true`
-   */
-  walls?: boolean | null | undefined;
-
-  /**
-   * Whether or not this light source provides a source of vision
-   * @defaultValue `false`
-   */
-  vision?: boolean | null | undefined;
-
-  /**
-   * Light configuration data
-   * @defaultValue `new LightData({})`
-   */
-  config?: LightDataConstructorData | null | undefined;
-
-  /**
-   * Is the light source currently hidden?
-   * @defaultValue `false`
-   */
-  hidden?: boolean | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'AmbientLight'> | null | undefined;
-}
-
-type AmbientLightDataSource = PropertiesToSource<AmbientLightDataProperties>;
-
-/**
- * The data schema for a AmbientLight embedded document.
- * @see BaseAmbientLight
- */
-export class AmbientLightData extends DocumentData<
-  AmbientLightDataSchema,
-  AmbientLightDataProperties,
-  AmbientLightDataSource,
-  AmbientLightDataConstructorData,
-  BaseAmbientLight
-> {
-  static override defineSchema(): AmbientLightDataSchema;
-
-  override _initializeSource(data: AmbientLightDataConstructorData): AmbientLightDataSource;
-
-  protected override _initialize(): void;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface AmbientLightData extends AmbientLightDataProperties {}