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

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

@@ -1,237 +0,0 @@
-import {
-  ConfiguredData,
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  ConfiguredSource,
-  FieldReturnType,
-  PropertiesToSource
-} from '../../../../types/helperTypes';
-import type 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 CardsDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  type: FieldReturnType<
-    fields.RequiredString,
-    {
-      default: () => string;
-      validate: (t: unknown) => boolean;
-      validationError: '{name} {field} "{value}" is not a valid type';
-    }
-  >;
-  description: fields.BlankString;
-  img: FieldReturnType<fields.VideoField, { default: () => string }>;
-  data: fields.SystemDataField;
-  cards: fields.EmbeddedCollectionField<typeof documents.BaseCard>;
-  width: fields.PositiveIntegerField;
-  heigth: fields.PositiveIntegerField;
-  rotation: fields.AngleField;
-  displayCount: fields.BooleanField;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: fields.IntegerSortField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface CardsDataBaseProperties {
-  /**
-   * The _id which uniquely identifies this stack of Cards document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /** The text name of this stack */
-  name: string;
-
-  /**
-   * The type of this stack, in BaseCards.metadata.types
-   * @defaultValue `game.system.documentTypes.Cards[0]`
-   */
-  type: string;
-
-  /**
-   * A text description of this stack
-   * @defaultValue `""`
-   */
-  description: string;
-
-  /**
-   * An image or video which is used to represent the stack of cards
-   * @defaultValue `CardsData.DEFAULT_ICON`
-   */
-  img: string | null;
-
-  /**
-   * Game system data which is defined by the system template.json model
-   * @defaultValue template from template.json for type or `{}`
-   */
-  data: object;
-
-  /**
-   * A collection of Card documents which currently belong to this stack
-   * @defaultValue `new EmbeddedCollection(CardData, [], BaseCard.implementation)`
-   */
-  cards: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseCard>, CardsData>;
-
-  /** The visible width of this stack */
-  width: number | undefined;
-
-  /** The visible height of this stack */
-  height: number | undefined;
-
-  /**
-   * The angle of rotation of this stack
-   * @defaultValue `360`
-   */
-  rotation: number;
-
-  /**
-   * Whether or not to publicly display the number of cards in this stack
-   * @defaultValue `false`
-   */
-  displayCount: boolean;
-
-  /**
-   * The _id of a Folder which contains this document
-   * @defaultValue `null`
-   */
-  folder: string | null;
-
-  /**
-   * The sort order of this stack relative to others in its parent collection
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object which configures user permissions to this stack
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Cards'>;
-}
-
-interface CardsDataConstructorData {
-  /**
-   * The _id which uniquely identifies this stack of Cards document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /** The text name of this stack */
-  name: string;
-
-  /**
-   * The type of this stack, in BaseCards.metadata.types
-   * @defaultValue `game.system.documentTypes.Cards[0]`
-   */
-  type?: CardsDataSource['type'] | null | undefined;
-
-  /**
-   * A text description of this stack
-   * @defaultValue `""`
-   */
-  description?: string | null | undefined;
-
-  /**
-   * An image or video which is used to represent the stack of cards
-   * @defaultValue `CardsData.DEFAULT_ICON`
-   */
-  img?: string | null | undefined;
-
-  /**
-   * Game system data which is defined by the system template.json model
-   * @defaultValue template from template.json for type or `{}`
-   */
-  data?: DeepPartial<CardsDataSource['data']> | null | undefined;
-
-  /**
-   * A collection of Card documents which currently belong to this stack
-   * @defaultValue `new EmbeddedCollection(CardData, [], BaseCard.implementation)`
-   */
-  cards?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseCard>>[0][] | null | undefined;
-
-  /** The visible width of this stack */
-  width?: number | null | undefined;
-
-  /** The visible height of this stack */
-  height?: number | null | undefined;
-
-  /**
-   * The angle of rotation of this stack
-   * @defaultValue `360`
-   */
-  rotation?: number | null | undefined;
-
-  /**
-   * Whether or not to publicly display the number of cards in this stack
-   * @defaultValue `false`
-   */
-  displayCount?: boolean | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this document
-   * @defaultValue `null`
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The sort order of this stack relative to others in its parent collection
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this stack
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission?: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS> | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Cards'> | null | undefined;
-}
-
-type CardsDataBaseSource = PropertiesToSource<CardsDataBaseProperties>;
-type CardsDataProperties = CardsDataBaseProperties & ConfiguredData<'Cards'>;
-type CardsDataSource = CardsDataBaseSource & ConfiguredSource<'Cards'>;
-
-type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentData>;
-
-interface CardsDataConstructor extends DocumentDataConstructor {
-  new (data: CardsDataConstructorData, document?: documents.BaseCards | null | undefined): CardsData;
-
-  defineSchema(): CardsDataSchema;
-
-  /**
-   * The default icon used for a cards stack that does not have a custom image set
-   * @defaultValue `"icons/svg/card-hand.svg"`
-   */
-  DEFAULT_ICON: string;
-}
-
-/**
- * The data schema of a stack of multiple Cards.
- * Each stack can represent a Deck, a Hand, or a Pile.
- * @see BaseCards
- */
-export type CardsData = DocumentData<
-  CardsDataSchema,
-  CardsDataProperties,
-  CardsDataSource,
-  CardsDataConstructorData,
-  documents.BaseCards
-> &
-  CardsDataProperties;
-
-export const CardsData: CardsDataConstructor;

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

@@ -1,220 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  FieldReturnType,
-  PropertiesToSource
-} from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import { documents } from '../../module.mjs';
-import * as fields from '../fields.mjs';
-import { ChatSpeakerData, ChatSpeakerDataConstructorData } from './chatSpeakerData';
-
-interface ChatMessageDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  type: DocumentField<foundry.CONST.CHAT_MESSAGE_TYPES> & {
-    type: typeof Number;
-    required: true;
-    default: typeof foundry.CONST.CHAT_MESSAGE_TYPES.OTHER;
-    validate: typeof _validateChatMessageType;
-    validationError: 'The provided ChatMessage type must be in CONST.CHAT_MESSAGE_TYPES';
-  };
-  user: fields.ForeignDocumentField<{ type: typeof documents.BaseUser; required: true }>;
-  timestamp: FieldReturnType<fields.TimestampField, { required: true }>;
-  flavor: fields.StringField;
-  content: fields.BlankString;
-  speaker: DocumentField<ChatSpeakerData> & {
-    type: typeof ChatSpeakerData;
-    required: true;
-    default: Record<string, never>;
-  };
-  whisper: DocumentField<string[]> & {
-    type: [typeof String];
-    clean: (users: Array<{ id: string } | string>) => string[];
-    required: true;
-    default: string[];
-  };
-  blind: fields.BooleanField;
-  roll: fields.JsonField;
-  sound: fields.AudioField;
-  emote: fields.BooleanField;
-  flags: fields.ObjectField;
-}
-
-interface ChatMessageDataProperties {
-  /**
-   * The _id which uniquely identifies this ChatMessage document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The message type from CONST.CHAT_MESSAGE_TYPES
-   * @defaultValue `CONST.CHAT_MESSAGE_TYPES.OTHER`
-   */
-  type: foundry.CONST.CHAT_MESSAGE_TYPES;
-
-  /**
-   * The _id of the User document who generated this message
-   * @defaultValue `null`
-   */
-  user: string | null;
-
-  /**
-   * The timestamp at which point this message was generated
-   * @defaultValue `Date.now()`
-   */
-  timestamp: number;
-
-  /**
-   * An optional flavor text message which summarizes this message
-   */
-  flavor: string | undefined;
-
-  /**
-   * The HTML content of this chat message
-   * @defaultValue `""`
-   */
-  content: string;
-
-  /**
-   * A ChatSpeakerData object which describes the origin of the ChatMessage
-   * @defaultValue `new ChatSpeakerData({})`
-   */
-  speaker: ChatSpeakerData;
-
-  /**
-   * An array of User _id values to whom this message is privately whispered
-   * @defaultValue `[]`
-   */
-  whisper: string[];
-
-  /**
-   * Is this message sent blindly where the creating User cannot see it?
-   * @defaultValue `false`
-   */
-  blind: boolean;
-
-  /**
-   * The serialized content of a Roll instance which belongs to the ChatMessage
-   */
-  roll: string | undefined;
-
-  /**
-   * The URL of an audio file which plays when this message is received
-   */
-  sound: string | null | undefined;
-
-  /**
-   * Is this message styled as an emote?
-   * @defaultValue `false`
-   */
-  emote: boolean;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'ChatMessage'>;
-}
-
-interface ChatMessageDataConstructorData {
-  /**
-   * The _id which uniquely identifies this ChatMessage document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The message type from CONST.CHAT_MESSAGE_TYPES
-   * @defaultValue `CONST.CHAT_MESSAGE_TYPES.OTHER`
-   */
-  type?: foundry.CONST.CHAT_MESSAGE_TYPES | null | undefined;
-
-  /**
-   * The _id of the User document who generated this message
-   * @defaultValue `null`
-   */
-  user?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseUser>> | string | null | undefined;
-
-  /**
-   * The timestamp at which point this message was generated
-   * @defaultValue `Date.now()`
-   */
-  timestamp?: number | null | undefined;
-
-  /**
-   * An optional flavor text message which summarizes this message
-   */
-  flavor?: string | null | undefined;
-
-  /**
-   * The HTML content of this chat message
-   * @defaultValue `""`
-   */
-  content?: string | null | undefined;
-
-  /**
-   * A ChatSpeakerData object which describes the origin of the ChatMessage
-   * @defaultValue `new ChatSpeakerData({})`
-   */
-  speaker?: ChatSpeakerDataConstructorData | null | undefined;
-
-  /**
-   * An array of User _id values to whom this message is privately whispered
-   * @defaultValue `[]`
-   */
-  whisper?: Array<{ id: string } | string> | null | undefined;
-
-  /**
-   * Is this message sent blindly where the creating User cannot see it?
-   * @defaultValue `false`
-   */
-  blind?: boolean | null | undefined;
-
-  /**
-   * The serialized content of a Roll instance which belongs to the ChatMessage
-   */
-  roll?: string | object | null | undefined;
-
-  /**
-   * The URL of an audio file which plays when this message is received
-   */
-  sound?: string | null | undefined;
-
-  /**
-   * Is this message styled as an emote?
-   * @defaultValue `false`
-   */
-  emote?: boolean | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'ChatMessage'> | null | undefined;
-}
-
-type ChatMessageDataSource = PropertiesToSource<ChatMessageDataProperties>;
-
-/**
- * An embedded data object which defines the properties of a light source animation
- */
-export class ChatMessageData extends DocumentData<
-  ChatMessageDataSchema,
-  ChatMessageDataProperties,
-  ChatMessageDataSource,
-  ChatMessageDataConstructorData,
-  documents.BaseChatMessage
-> {
-  static override defineSchema(): ChatMessageDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ChatMessageData extends ChatMessageDataProperties {}
-
-/**
- * Validate that a ChatMessage has a valid type
- * @param type - The assigned message type
- * @returns Is it valid?
- */
-declare function _validateChatMessageType(type: number): boolean;

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

@@ -1,80 +0,0 @@
-import { ConfiguredDocumentClass, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import { BaseActor, BaseChatMessage, BaseScene } from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-import { ForeignDocumentField } from '../fields.mjs';
-
-interface ChatSpeakerDataSchema extends DocumentSchema {
-  scene: ForeignDocumentField<{ type: typeof BaseScene; required: false }>;
-  actor: ForeignDocumentField<{ type: typeof BaseActor; required: false }>;
-  token: FieldReturnType<fields.DocumentId, { required: false }>;
-  alias: fields.StringField;
-}
-
-interface ChatSpeakerDataProperties {
-  /**
-   * The _id of the Scene where this message was created
-   * @defaultValue `null`
-   */
-  scene: string | null;
-
-  /**
-   * The _id of the Actor who generated this message
-   * @defaultValue `null`
-   */
-  actor: string | null;
-
-  /**
-   * The _id of the Token who generated this message
-   * @defaultValue `null`
-   */
-  token: string | null;
-
-  /**
-   * An overridden alias name used instead of the Actor or Token name
-   */
-  alias: string | undefined;
-}
-
-interface ChatSpeakerDataConstructorData {
-  /**
-   * The _id of the Scene where this message was created
-   * @defaultValue `null`
-   */
-  scene?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>> | string | null | undefined;
-
-  /**
-   * The _id of the Actor who generated this message
-   * @defaultValue `null`
-   */
-  actor?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>> | string | null | undefined;
-
-  /**
-   * The _id of the Token who generated this message
-   * @defaultValue `null`
-   */
-  token?: string | null | undefined;
-
-  /**
-   * An overridden alias name used instead of the Actor or Token name
-   */
-  alias?: string | null | undefined;
-}
-
-type ChatSpeakerDataSource = PropertiesToSource<ChatSpeakerDataProperties>;
-
-/**
- * An embedded data object which defines the properties of a light source animation
- */
-export class ChatSpeakerData extends DocumentData<
-  ChatSpeakerDataSchema,
-  ChatSpeakerDataProperties,
-  ChatSpeakerDataSource,
-  ChatSpeakerDataConstructorData,
-  BaseChatMessage
-> {
-  static override defineSchema(): ChatSpeakerDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ChatSpeakerData extends ChatSpeakerDataProperties {}

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

@@ -1,149 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  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';
-import { CombatantDataConstructorData } from './combatantData';
-
-interface CombatDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  scene: fields.ForeignDocumentField<{ type: typeof documents.BaseScene }>;
-  combatants: fields.EmbeddedCollectionField<typeof documents.BaseCombatant>;
-  active: fields.BooleanField;
-  round: FieldReturnType<fields.NonnegativeIntegerField, { default: 0; required: true }>;
-  turn: FieldReturnType<
-    fields.NonnegativeIntegerField,
-    {
-      default: 0;
-      required: true;
-      nullable: true;
-      validate: (n: unknown) => boolean;
-    }
-  >;
-  sort: fields.IntegerSortField;
-  flags: fields.ObjectField;
-}
-
-interface CombatDataProperties {
-  /**
-   * The _id which uniquely identifies this Combat document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The _id of a Scene within which this Combat occurs
-   * @defaultValue `null`
-   */
-  scene: string | null;
-
-  /**
-   * A Collection of Combatant embedded Documents
-   * @defaultValue `new EmbeddedCollection(CombatantData, [], BaseCombatant.implementation)`
-   */
-  combatants: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseCombatant>, CombatData>;
-
-  /**
-   * Is the Combat encounter currently active?
-   * @defaultValue `false`
-   */
-  active: boolean;
-
-  /**
-   * The current round of the Combat encounter
-   * @defaultValue `0`
-   */
-  round: number;
-
-  /**
-   * The current turn in the Combat round
-   * @defaultValue `0`
-   */
-  turn: number | null;
-
-  /**
-   * The current sort order of this Combat relative to others in the same Scene
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Combat'>;
-}
-
-interface CombatDataConstructorData {
-  /**
-   * The _id which uniquely identifies this Combat document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The _id of a Scene within which this Combat occurs
-   * @defaultValue `null`
-   */
-  scene?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseScene>> | string | null | undefined;
-
-  /**
-   * A Collection of Combatant embedded Documents
-   * @defaultValue `new EmbeddedCollection(CombatantData, [], BaseCombatant.implementation)`
-   */
-  combatants?: CombatantDataConstructorData[] | null | undefined;
-
-  /**
-   * Is the Combat encounter currently active?
-   * @defaultValue `false`
-   */
-  active?: boolean | null | undefined;
-
-  /**
-   * The current round of the Combat encounter
-   * @defaultValue `0`
-   */
-  round?: number | null | undefined;
-
-  /**
-   * The current turn in the Combat round
-   * @defaultValue `0`
-   */
-  turn?: number | null | undefined;
-
-  /**
-   * The current sort order of this Combat relative to others in the same Scene
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Combat'> | null | undefined;
-}
-
-type CombatDataSource = PropertiesToSource<CombatDataProperties>;
-
-/**
- * The data schema for an Combat document.
- * @see BaseCombat
- */
-export class CombatData extends DocumentData<
-  CombatDataSchema,
-  CombatDataProperties,
-  CombatDataSource,
-  CombatDataConstructorData,
-  documents.BaseCombat
-> {
-  static override defineSchema(): CombatDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface CombatData extends CombatDataProperties {}