@league-of-foundry-developers/foundry-vtt-types 0.8.9-8 → 9.242.0

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

@@ -0,0 +1,265 @@
+import type {
+  ConfiguredData,
+  ConfiguredFlags,
+  ConfiguredSource,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes.js';
+import type DocumentData from '../../abstract/data.mjs.js';
+import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
+import type { CardFaceData, CardFaceDataConstructorData } from './cardFaceData.js';
+
+interface CardDataSchema extends DocumentSchema {
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  description: fields.BlankString;
+  type: FieldReturnType<
+    fields.RequiredString,
+    {
+      default: () => string;
+      validate: (t: unknown) => boolean;
+      validationError: '{name} {field} "{value}" is not a valid type';
+    }
+  >;
+  data: fields.SystemDataField;
+  suit: fields.BlankString;
+  value: fields.NumericField;
+  back: DocumentField<CardFaceData> & {
+    type: typeof CardFaceData;
+    required: true;
+    default: Record<string, never>;
+  };
+  faces: DocumentField<CardFaceData[]> & {
+    type: [typeof CardFaceData];
+    required: true;
+    default: [];
+  };
+  face: DocumentField<number> & {
+    type: typeof Number;
+    required: true;
+    default: null;
+    nullable: true;
+    validate: (f: unknown) => boolean;
+    validationError: '{name} {field} "{value}" must have a non-negative integer value or null';
+  };
+  drawn: fields.BooleanField;
+  origin: fields.DocumentId;
+  width: fields.PositiveIntegerField;
+  height: fields.PositiveIntegerField;
+  rotation: fields.AngleField;
+  sort: fields.IntegerSortField;
+  flags: fields.ObjectField;
+}
+
+interface CardDataBaseProperties {
+  /**
+   * The _id which uniquely identifies this Card document
+   * @defaultValue `null`
+   */
+  _id: string | null;
+
+  /** The text name of this card */
+  name: string;
+
+  /**
+   * A text description of this card which applies to all faces
+   * @defaultValue `""`
+   */
+  description: string;
+
+  /**
+   * A category of card (for example, a suit) to which this card belongs
+   * @defaultValue `game.system.documentTypes.Card[0]`
+   */
+  type: string;
+
+  /**
+   * Game system data which is defined by the system template.json model
+   * @defaultValue template from template.json for type or `{}`
+   */
+  data: object;
+
+  /**
+   * An optional suit designation which is used by default sorting
+   * @defaultValue `""`
+   */
+  suit: string;
+
+  /** An optional numeric value of the card which is used by default sorting */
+  value: number | null | undefined;
+
+  /**
+   * An object of face data which describes the back of this card
+   * @defaultValue `new CardFaceData({})`
+   */
+  back: CardFaceData;
+
+  /**
+   * An array of face data which represent displayable faces of this card
+   * @defaultValue `[]`
+   */
+  faces: CardFaceData[];
+
+  /**
+   * The index of the currently displayed face
+   * @defaultValue `null`
+   */
+  face: number | null;
+
+  /**
+   * Whether this card is currently drawn from its source deck
+   * @defaultValue `false`
+   */
+  drawn: boolean;
+
+  /**
+   * The document ID of the origin deck to which this card belongs
+   * @defaultValue `null`
+   */
+  origin: string | null;
+
+  /** The visible width of this card */
+  width: number | undefined;
+
+  /** The visible height of this card */
+  height: number | undefined;
+
+  /**
+   * The angle of rotation of this card
+   * @defaultValue `360`
+   */
+  rotation: number;
+
+  /**
+   * The sort order of this card relative to others in the same stack
+   * @defaultValue `0`
+   */
+  sort: number;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags: ConfiguredFlags<'Card'>;
+}
+
+interface CardDataConstructorData {
+  /**
+   * The _id which uniquely identifies this Card document
+   * @defaultValue `null`
+   */
+  _id?: string | null | undefined;
+
+  /** The text name of this card */
+  name: string;
+
+  /**
+   * A text description of this card which applies to all faces
+   * @defaultValue `""`
+   */
+  description?: string | null | undefined;
+
+  /**
+   * A category of card (for example, a suit) to which this card belongs
+   * @defaultValue `game.system.documentTypes.Card[0]`
+   */
+  type?: CardDataSource['type'] | null | undefined;
+
+  /**
+   * Game system data which is defined by the system template.json model
+   * @defaultValue template from template.json for type or `{}`
+   */
+  data?: DeepPartial<CardDataSource['data']> | null | undefined;
+
+  /**
+   * An optional suit designation which is used by default sorting
+   * @defaultValue `""`
+   */
+  suit?: string | null | undefined;
+
+  /** An optional numeric value of the card which is used by default sorting */
+  value?: number | null | undefined;
+
+  /**
+   * An object of face data which describes the back of this card
+   * @defaultValue `new CardFaceData({})`
+   */
+  back?: CardFaceDataConstructorData | null | undefined;
+
+  /**
+   * An array of face data which represent displayable faces of this card
+   * @defaultValue `[]`
+   */
+  faces?: CardFaceDataConstructorData[] | null | undefined;
+
+  /**
+   * The index of the currently displayed face
+   * @defaultValue `null`
+   */
+  face?: number | null | undefined;
+
+  /**
+   * Whether this card is currently drawn from its source deck
+   * @defaultValue `false`
+   */
+  drawn?: boolean | null | undefined;
+
+  /**
+   * The document ID of the origin deck to which this card belongs
+   * @defaultValue `null`
+   */
+  origin?: string | null | undefined;
+
+  /** The visible width of this card */
+  width?: number | null | undefined;
+
+  /** The visible height of this card */
+  height?: number | null | undefined;
+
+  /**
+   * The angle of rotation of this card
+   * @defaultValue `360`
+   */
+  rotation?: number | null | undefined;
+
+  /**
+   * The sort order of this card relative to others in the same stack
+   * @defaultValue `0`
+   */
+  sort?: number | null | undefined;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'Card'> | null | undefined;
+}
+
+type CardDataBaseSource = PropertiesToSource<CardDataBaseProperties>;
+type CardDataProperties = CardDataBaseProperties & ConfiguredData<'Card'>;
+type CardDataSource = CardDataBaseSource & ConfiguredSource<'Card'>;
+
+type DocumentDataConstructor = Pick<typeof DocumentData, keyof typeof DocumentData>;
+
+interface CardDataConstructor extends DocumentDataConstructor {
+  new (data: CardDataConstructorData, document?: documents.BaseCard | null | undefined): CardData;
+
+  /** @override */
+  defineSchema(): CardDataSchema;
+}
+
+/**
+ * The data schema of a single Card document.
+ * @see BaseCard
+ */
+export type CardData = DocumentData<
+  CardDataSchema,
+  CardDataProperties,
+  CardDataSource,
+  CardDataConstructorData,
+  documents.BaseCard
+> &
+  CardDataProperties;
+
+export const CardData: CardDataConstructor;

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

@@ -0,0 +1,66 @@
+import type { PropertiesToSource } from '../../../../types/helperTypes.js';
+import type DocumentData from '../../abstract/data.mjs.js';
+import * as fields from '../fields.mjs';
+
+interface CardFaceDataSchema extends DocumentSchema {
+  name: fields.BlankString;
+  text: fields.BlankString;
+  img: fields.VideoField;
+}
+
+interface CardFaceDataProperties {
+  /**
+   * A name for this card face
+   * @defaultValue `""`
+   */
+  name: string;
+
+  /**
+   * Displayed text that belongs to this face
+   * @defaultValue `""`
+   */
+  text: string;
+
+  /** A displayed image or video file which depicts the face */
+  img: string | null | undefined;
+}
+
+interface CardFaceDataConstructorData {
+  /**
+   * A name for this card face
+   * @defaultValue `""`
+   */
+  name?: string | null | undefined;
+
+  /**
+   * Displayed text that belongs to this face
+   * @defaultValue `""`
+   */
+  text?: string | null | undefined;
+
+  /** A displayed image or video file which depicts the face */
+  img?: string | null | undefined;
+}
+
+/**
+ * The data schema of a single card face which belongs to a specific Card.
+ * @see CardData
+ */
+export class CardFaceData extends DocumentData<
+  CardFaceDataSchema,
+  CardFaceDataProperties,
+  PropertiesToSource<CardFaceDataProperties>,
+  CardFaceDataConstructorData
+> {
+  /** @override */
+  static defineSchema(): CardFaceDataSchema;
+
+  /**
+   * The default icon used for a card face that does not have a custom image set
+   * @defaultValue `"icons/svg/card-joker.svg"`
+   */
+  static DEFAULT_ICON: string;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface CardFaceData extends CardFaceDataProperties {}

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

@@ -0,0 +1,238 @@
+import {
+  ConfiguredData,
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  ConfiguredSource,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes.js';
+import type EmbeddedCollection from '../../abstract/embedded-collection.mjs.js';
+import { DocumentData } from '../../abstract/module.mjs.js';
+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;
+
+  /** @override */
+  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;