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

package/src/foundry/common/documents/card.d.mts

@@ -0,0 +1,224 @@
+import type { InexactPartial } from "../../../types/utils.mts";
+import type Document from "../abstract/document.mts";
+import type * as CONST from "../constants.mts";
+import type * as fields from "../data/fields.d.mts";
+import type * as documents from "./_module.mts";
+
+/**
+ * The Card Document.
+ * Defines the DataSchema and common behaviors for a Card which are shared between both client and server.
+ */
+// Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
+// This pattern evolved from trying to avoid circular loops and even internal tsc errors.
+// See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
+declare class BaseCard extends Document<"Card", BaseCard.Schema, any> {
+  /**
+   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   */
+  static get TYPES(): BaseCard.TypeNames[];
+
+  /**
+   * @param data    - Initial data from which to construct the Card
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data: BaseCard.ConstructorData, context?: Document.ConstructionContext<BaseCard.Parent>);
+
+  override parent: BaseCard.Parent;
+
+  override _source: BaseCard.Source;
+
+  static override metadata: BaseCard.Metadata;
+
+  static override defineSchema(): BaseCard.Schema;
+
+  /**
+   * 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;
+
+  /**
+   * Is a User able to create a new Card within this parent?
+   */
+  static #canCreate(user: documents.BaseUser, doc: BaseCard, data: BaseCard.ConstructorData): boolean;
+
+  /**
+   * Is a user able to update an existing Card?
+   */
+  static #canUpdate(user: documents.BaseUser, doc: BaseCard, data: BaseCard.UpdateData): boolean;
+
+  override testUserPermission(
+    user: documents.BaseUser,
+    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
+    options?: InexactPartial<{
+      /**
+       * Require the exact permission level requested?
+       * @defaultValue `false`
+       */
+      exact: boolean;
+    }>,
+  ): boolean;
+}
+
+export default BaseCard;
+
+declare namespace BaseCard {
+  type Parent = Cards.ConfiguredInstance | null;
+
+  type TypeNames = Game.Model.TypeNames<"Card">;
+
+  type Metadata = Document.MetadataFor<BaseCard>;
+
+  type SchemaField = fields.SchemaField<Schema>;
+  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
+  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
+  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
+  type Source = fields.SchemaField.InnerPersistedType<Schema>;
+
+  interface Schema extends DataSchema {
+    /**
+     * The _id which uniquely identifies this Card document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /** The text name of this card */
+    name: fields.StringField<{ required: true; blank: false; label: "CARD.Name" }>;
+
+    /**
+     * A text description of this card which applies to all faces
+     * @defaultValue `""`
+     */
+    description: fields.HTMLField<{ label: "CARD.Description" }>;
+
+    /**
+     * A category of card (for example, a suit) to which this card belongs
+     * @defaultValue `BaseCard.TYPES[0]`
+     */
+    type: fields.DocumentTypeField<
+      typeof BaseCard,
+      {
+        initial: typeof foundry.CONST.BASE_DOCUMENT_TYPE;
+      }
+    >;
+
+    /**
+     * Game system data which is defined by the system template.json model
+     * @defaultValue `{}`
+     */
+    system: fields.TypeDataField<typeof BaseCard>;
+
+    /**
+     * An optional suit designation which is used by default sorting
+     * @defaultValue `""`
+     */
+    suit: fields.StringField<{ label: "CARD.Suit" }>;
+
+    /**
+     * An optional numeric value of the card which is used by default sorting
+     * @defaultValue `null`
+     */
+    value: fields.NumberField<{ label: "CARD.Value" }>;
+
+    /**
+     * An object of face data which describes the back of this card
+     * @defaultValue see properties
+     */
+    back: fields.SchemaField<{
+      /**
+       * A name for this card face
+       * @defaultValue `""`
+       */
+      name: fields.StringField<{ label: "CARD.BackName" }>;
+
+      /**
+       * Displayed text that belongs to this face
+       * @defaultValue `""`
+       */
+      text: fields.HTMLField<{ label: "CARD.BackText" }>;
+
+      /**
+       * A displayed image or video file which depicts the face
+       * @defaultValue `null`
+       */
+      img: fields.FilePathField<{ categories: ["IMAGE", "VIDEO"]; label: "CARD.BackImage" }>;
+    }>;
+
+    faces: fields.ArrayField<
+      fields.SchemaField<{
+        /**
+         * A name for this card face
+         * @defaultValue `""`
+         */
+        name: fields.StringField<{ label: "CARD.FaceName" }>;
+
+        /**
+         * Displayed text that belongs to this face
+         * @defaultValue `""`
+         */
+        text: fields.HTMLField<{ label: "CARD.FaceText" }>;
+
+        /**
+         * A displayed image or video file which depicts the face
+         * @defaultValue `BaseCard.DEFAULT_ICON`
+         */
+        img: fields.FilePathField<{
+          categories: ["IMAGE", "VIDEO"];
+          initial: () => typeof BaseCard.DEFAULT_ICON;
+          label: "CARD.FaceImage";
+        }>;
+      }>
+    >;
+
+    /**
+     * The index of the currently displayed face, or null if the card is face-down
+     * @defaultValue `null`
+     */
+    face: fields.NumberField<{ required: true; initial: null; integer: true; min: 0; label: "CARD.Face" }>;
+
+    /**
+     * Whether this card is currently drawn from its source deck
+     * @defaultValue `false`
+     */
+    drawn: fields.BooleanField<{ label: "CARD.Drawn" }>;
+
+    /**
+     * The document ID of the origin deck to which this card belongs
+     * @defaultValue `null`
+     */
+    origin: fields.ForeignDocumentField<typeof documents.BaseCards>;
+
+    /**
+     * The visible width of this card
+     * @defaultValue `null`
+     */
+    width: fields.NumberField<{ integer: true; positive: true; label: "Width" }>;
+
+    /**
+     * The visible height of this card
+     * @defaultValue `null`
+     */
+    height: fields.NumberField<{ integer: true; positive: true; label: "Height" }>;
+
+    /**
+     * The angle of rotation of this card
+     * @defaultValue `0`
+     */
+    rotation: fields.AngleField<{ label: "Rotation" }>;
+
+    /**
+     * The sort order of this card relative to others in the same stack
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Card">;
+
+    _stats: fields.DocumentStatsField;
+  }
+}

package/src/foundry/common/documents/cards.d.mts

@@ -0,0 +1,156 @@
+import type { AnyObject } from "../../../types/utils.mts";
+import type Document from "../abstract/document.mts";
+import type * as fields from "../data/fields.d.mts";
+import type * as documents from "./_module.mts";
+
+/**
+ * The Cards Document.
+ * Defines the DataSchema and common behaviors for a Cards Document which are shared between both client and server.
+ */
+// Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
+// This pattern evolved from trying to avoid circular loops and even internal tsc errors.
+// See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
+declare class BaseCards extends Document<"Cards", BaseCards.Schema, any> {
+  /**
+   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   */
+  static get TYPES(): BaseCards.TypeNames[];
+
+  /**
+   * @param data    - Initial data from which to construct the Cards
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data: BaseCards.ConstructorData, context?: Document.ConstructionContext<BaseCards.Parent>);
+
+  override parent: BaseCards.Parent;
+
+  override _source: BaseCards.Source;
+
+  static override metadata: BaseCards.Metadata;
+
+  static override defineSchema(): BaseCards.Schema;
+
+  /**
+   * The default icon used for a cards stack that does not have a custom image set
+   * @defaultValue `"icons/svg/card-hand.svg"`
+   */
+  static DEFAULT_ICON: string;
+
+  static override migrateData(source: AnyObject): AnyObject;
+}
+
+export default BaseCards;
+
+declare namespace BaseCards {
+  type Parent = null;
+
+  type TypeNames = Game.Model.TypeNames<"Cards">;
+
+  type Metadata = Document.MetadataFor<BaseCards>;
+
+  type SchemaField = fields.SchemaField<Schema>;
+  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
+  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
+  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
+  type Source = fields.SchemaField.InnerPersistedType<Schema>;
+
+  interface Schema extends DataSchema {
+    /**
+     * The _id which uniquely identifies this stack of Cards document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /** The text name of this stack */
+    name: fields.StringField<{ required: true; blank: false; label: "CARDS.Name"; textSearch: true }>;
+
+    /**
+     * The type of this stack, in BaseCards.metadata.types
+     * @defaultValue `BaseCards.TYPES[0]`
+     */
+    type: fields.DocumentTypeField<typeof BaseCards>;
+
+    /**
+     * A text description of this stack
+     * @defaultValue `""`
+     */
+    description: fields.HTMLField<{ label: "CARDS.Description"; textSearch: true }>;
+
+    /**
+     * An image or video which is used to represent the stack of cards
+     * @defaultValue `BaseCards.DEFAULT_ICON`
+     */
+    img: fields.FilePathField<{
+      categories: ["IMAGE", "VIDEO"];
+      initial: () => typeof BaseCards.DEFAULT_ICON;
+      label: "CARDS.Image";
+    }>;
+
+    /**
+     * Game system data which is defined by the system template.json model
+     * @defaultValue `{}`
+     */
+    system: fields.TypeDataField<typeof BaseCards>;
+
+    /**
+     * A collection of Card documents which currently belong to this stack
+     * @defaultValue `[]`
+     */
+    cards: fields.EmbeddedCollectionField<typeof documents.BaseCard, Cards.ConfiguredInstance>;
+
+    /**
+     * The visible width of this stack
+     * @defaultValue `null`
+     */
+    width: fields.NumberField<{ integer: true; positive: true; label: "Width" }>;
+
+    /**
+     * The visible height of this stack
+     * @defaultValue `null`
+     */
+    height: fields.NumberField<{ integer: true; positive: true; label: "Height" }>;
+
+    /**
+     * The angle of rotation of this stack
+     * @defaultValue `0`
+     */
+    rotation: fields.AngleField<{ label: "Rotation" }>;
+
+    /**
+     * Whether or not to publicly display the number of cards in this stack
+     * @defaultValue `false`
+     */
+    displayCount: fields.BooleanField;
+
+    /**
+     * The _id of a Folder which contains this document
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+    /**
+     * The sort order of this stack relative to others in its parent collection
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures ownership of this Cards
+     * @defaultValue see {@link fields.DocumentOwnershipField}
+     */
+    ownership: fields.DocumentOwnershipField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Cards">;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@link fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+}

package/src/foundry/common/documents/chat-message.d.mts

@@ -0,0 +1,207 @@
+import type { AnyObject, InexactPartial } from "../../../types/utils.mts";
+import type Document from "../abstract/document.mts";
+import type * as CONST from "../constants.mts";
+import type * as fields from "../data/fields.d.mts";
+import type * as documents from "./_module.mts";
+
+/**
+ * The ChatMessage Document.
+ * Defines the DataSchema and common behaviors for a ChatMessage which are shared between both client and server.
+ */
+// Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
+// This pattern evolved from trying to avoid circular loops and even internal tsc errors.
+// See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
+declare class BaseChatMessage extends Document<"ChatMessage", BaseChatMessage.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the ChatMessage
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data?: BaseChatMessage.ConstructorData, context?: Document.ConstructionContext<BaseChatMessage.Parent>);
+
+  override parent: BaseChatMessage.Parent;
+
+  static override metadata: BaseChatMessage.Metadata;
+
+  static override defineSchema(): BaseChatMessage.Schema;
+
+  /**
+   * Is a user able to create a new chat message?
+   * @internal
+   */
+  static #canCreate(user: documents.BaseUser, doc: BaseChatMessage): boolean;
+
+  /**
+   * Is a user able to update an existing chat message?
+   * @internal
+   */
+  static #canUpdate(user: documents.BaseUser, doc: BaseChatMessage, data: BaseChatMessage.UpdateData): boolean;
+
+  /**
+   * Validate that Rolls belonging to the ChatMessage document are valid
+   * @param rollJSON - The serialized Roll data
+   */
+  static #validateRoll(rollJSON: string): void;
+
+  override testUserPermission(
+    user: foundry.documents.BaseUser,
+    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
+    options?: InexactPartial<{ exact: boolean }>,
+  ): boolean;
+
+  static override migrateData(source: AnyObject): AnyObject;
+
+  static override shimData(
+    data: AnyObject,
+    options?: {
+      /**
+       * Apply shims to embedded models?
+       * @defaultValue `true`
+       */
+      embedded?: boolean;
+    },
+  ): AnyObject;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks Replaced by `author`
+   */
+  get user(): this["author"];
+}
+
+export default BaseChatMessage;
+
+declare namespace BaseChatMessage {
+  type Parent = null;
+
+  type TypeNames = Game.Model.TypeNames<"ChatMessage">;
+
+  type Metadata = Document.MetadataFor<BaseChatMessage>;
+
+  type SchemaField = fields.SchemaField<Schema>;
+  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
+  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
+  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
+  type Source = fields.SchemaField.InnerPersistedType<Schema>;
+
+  interface Schema extends DataSchema {
+    /**
+     * The _id which uniquely identifies this ChatMessage document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    type: fields.DocumentTypeField<typeof BaseChatMessage, { initial: typeof foundry.CONST.BASE_DOCUMENT_TYPE }>;
+
+    system: fields.TypeDataField<typeof BaseChatMessage>;
+
+    /**
+     * The message type from CONST.CHAT_MESSAGE_STYLES
+     * @defaultValue `CONST.CHAT_MESSAGE_STYLES.OTHER`
+     */
+    style: fields.NumberField<{
+      required: true;
+      choices: CONST.CHAT_MESSAGE_STYLES[];
+      initial: typeof CONST.CHAT_MESSAGE_STYLES.OTHER;
+      validationError: "must be a value in CONST.CHAT_MESSAGE_TYPES";
+    }>;
+
+    /**
+     * The _id of the User document who generated this message
+     * @defaultValue `game?.user?.id`
+     */
+    author: fields.ForeignDocumentField<typeof documents.BaseUser, { nullable: false; initial: () => string }>;
+
+    /**
+     * The timestamp at which point this message was generated
+     * @defaultValue `Date.now()`
+     */
+    timestamp: fields.NumberField<{ required: true; nullable: false; initial: typeof Date.now }>;
+
+    /**
+     * An optional flavor text message which summarizes this message
+     * @defaultValue `""`
+     */
+    flavor: fields.HTMLField;
+
+    /**
+     * The HTML content of this chat message
+     * @defaultValue `""`
+     */
+    content: fields.HTMLField<{ textSearch: true }>;
+
+    /**
+     * A ChatSpeakerData object which describes the origin of the ChatMessage
+     * @defaultValue see properties
+     */
+    speaker: fields.SchemaField<{
+      /**
+       * The _id of the Scene where this message was created
+       * @defaultValue `null`
+       */
+      scene: fields.ForeignDocumentField<typeof documents.BaseScene, { idOnly: true }>;
+
+      /**
+       * The _id of the Actor who generated this message
+       * @defaultValue `null`
+       */
+      actor: fields.ForeignDocumentField<typeof documents.BaseActor, { idOnly: true }>;
+
+      /**
+       * The _id of the Token who generated this message
+       * @defaultValue `null`
+       */
+      token: fields.ForeignDocumentField<typeof documents.BaseToken, { idOnly: true }>;
+
+      /**
+       * An overridden alias name used instead of the Actor or Token name
+       * @defaultValue `""`
+       */
+      alias: fields.StringField;
+    }>;
+
+    /**
+     * An array of User _id values to whom this message is privately whispered
+     * @defaultValue `[]`
+     */
+    whisper: fields.ArrayField<fields.ForeignDocumentField<typeof documents.BaseUser, { idOnly: true }>>;
+
+    /**
+     * Is this message sent blindly where the creating User cannot see it?
+     * @defaultValue `false`
+     */
+    blind: fields.BooleanField;
+
+    /**
+     * Serialized content of any Roll instances attached to the ChatMessage
+     * @defaultValue `[]`
+     */
+    rolls: fields.ArrayField<
+      fields.JSONField<
+        { validate: (rollJson: string) => void },
+        fields.JSONField.AssignmentType<{ validate: (rollJson: string) => void }>,
+        Roll // TODO: If initialization fails can this possibly be not-roll?
+      >
+    >;
+
+    /**
+     * The URL of an audio file which plays when this message is received
+     * @defaultValue `null`
+     */
+    sound: fields.FilePathField<{ categories: ["AUDIO"] }>;
+
+    /**
+     * Is this message styled as an emote?
+     * @defaultValue `false`
+     */
+    emote: fields.BooleanField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"ChatMessage">;
+
+    _stats: fields.DocumentStatsField;
+  }
+}