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

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

@@ -0,0 +1,142 @@
+import type { AnyObject, InexactPartial } 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 Document definition for an Item.
+ * Defines the DataSchema and common behaviors for an Item 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 BaseItem extends Document<"Item", BaseItem.Schema, any> {
+  /**
+   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   */
+  static get TYPES(): BaseItem.TypeNames[];
+  /**
+   * @param data    - Initial data from which to construct the Item
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is causing a circular error.
+  // constructor(data: BaseItem.ConstructorData, context?: Document.ConstructionContext<BaseItem.Parent>);
+
+  override parent: BaseItem.Parent;
+
+  override _source: BaseItem.Source;
+
+  static override metadata: BaseItem.Metadata;
+
+  static override defineSchema(): BaseItem.Schema;
+
+  /**
+   * The default icon used for newly created Item documents
+   * @defaultValue `"icons/svg/item-bag.svg"`
+   */
+  static DEFAULT_ICON: string;
+
+  /**
+   * Determine default artwork based on the provided item data.
+   * @param itemData - The source item data
+   * @returns Candidate item image
+   */
+  static getDefaultArtwork(itemData: BaseItem.ConstructorData): { img: string };
+
+  override canUserModify(user: documents.BaseUser, action: "create" | "delete" | "update", data?: AnyObject): boolean;
+
+  override testUserPermission(
+    user: documents.BaseUser,
+    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
+    options?: InexactPartial<{
+      /**
+       * Require the exact permission level requested?
+       * @defaultValue `false`
+       */
+      exact: boolean;
+    }>,
+  ): boolean;
+
+  static override migrateData(source: AnyObject): AnyObject;
+}
+
+export default BaseItem;
+
+declare namespace BaseItem {
+  type Parent = Actor.ConfiguredInstance | null;
+
+  type TypeNames = Game.Model.TypeNames<"Item">;
+
+  type Metadata = Document.MetadataFor<BaseItem>;
+
+  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 Item document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /** The name of this Item */
+    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+    /** An Item subtype which configures the system data model applied */
+    type: fields.DocumentTypeField<typeof BaseItem>;
+
+    /**
+     * An image file path which provides the artwork for this Item
+     * @defaultValue `null`
+     */
+    img: fields.FilePathField<{
+      categories: "IMAGE"[];
+      initial: (data: unknown) => string;
+    }>;
+
+    /**
+     * The system data object which is defined by the system template.json model
+     * @defaultValue `{}`
+     */
+    system: fields.TypeDataField<typeof BaseItem>;
+
+    /**
+     * A collection of ActiveEffect embedded Documents
+     * @defaultValue `[]`
+     */
+    effects: fields.EmbeddedCollectionField<typeof documents.BaseActiveEffect, Item.ConfiguredInstance>;
+
+    /**
+     * The _id of a Folder which contains this Item
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+    /**
+     * The numeric sort value which orders this Item relative to its siblings
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures ownership of this Item
+     * @defaultValue see {@link fields.DocumentOwnershipField}
+     */
+    ownership: fields.DocumentOwnershipField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Item">;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@link fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+}

package/src/foundry/common/documents/journal-entry-page.d.mts

@@ -0,0 +1,211 @@
+import type Document from "../abstract/document.mts";
+import type * as fields from "../data/fields.d.mts";
+import type * as documents from "./_module.mts";
+
+/**
+ * The JournalEntryPage Document.
+ * Defines the DataSchema and common behaviors for a JournalEntryPage which are shared between both client and server.
+ */
+declare class BaseJournalEntryPage extends Document<"JournalEntryPage", BaseJournalEntryPage.Schema, any> {
+  /**
+   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   */
+  static get TYPES(): BaseJournalEntryPage.TypeNames[];
+
+  /**
+   * @param data    - Initial data from which to construct the JournalEntryPage.
+   * @param context - Construction context options.
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(
+  //   data: BaseJournalEntryPage.ConstructorData,
+  //   context?: Document.ConstructionContext<BaseJournalEntryPage.Parent>,
+  // );
+
+  override parent: BaseJournalEntryPage.Parent;
+
+  _source: BaseJournalEntryPage.Source;
+
+  static override metadata: BaseJournalEntryPage.Metadata;
+
+  static override defineSchema(): BaseJournalEntryPage.Schema;
+
+  override getUserLevel(user: documents.BaseUser): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
+}
+
+export default BaseJournalEntryPage;
+
+declare namespace BaseJournalEntryPage {
+  type Parent = Scene.ConfiguredInstance | null;
+
+  type TypeNames = Game.Model.TypeNames<"JournalEntryPage">;
+
+  type Metadata = Document.MetadataFor<BaseJournalEntryPage>;
+
+  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 JournalEntryPage embedded document.
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The text name of this page.
+     */
+    name: fields.StringField<{ required: true; blank: false; label: "JOURNALENTRYPAGE.PageTitle"; textSearch: true }>;
+
+    /**
+     * The type of this page, in {@link BaseJournalEntryPage.TYPES}.
+     * @defaultValue `"text"`
+     */
+    type: fields.DocumentTypeField<
+      typeof BaseJournalEntryPage,
+      {
+        initial: "text";
+      }
+    >;
+
+    /**
+     * System-specific data.
+     * @defaultValue `{}`
+     */
+    system: fields.TypeDataField<typeof BaseJournalEntryPage>;
+
+    /**
+     * Data that control's the display of this page's title.
+     */
+    title: fields.SchemaField<{
+      /**
+       * Whether to render the page's title in the overall journal view.
+       * @defaultValue `true`
+       */
+      show: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * The heading level to render this page's title at in the overall journal view.
+       * @defaultValue `1`
+       */
+      level: fields.NumberField<{ required: true; initial: 1; min: 1; max: 6; integer: true; nullable: false }>;
+    }>;
+
+    /**
+     * Data particular to image journal entry pages.
+     */
+    image: fields.SchemaField<{
+      /**
+       * A caption for the image.
+       * @defaultValue `undefined`
+       */
+      caption: fields.StringField<{ required: false; initial: undefined }>;
+    }>;
+
+    /**
+     * Data particular to text journal entry pages.
+     */
+    text: fields.SchemaField<{
+      /**
+       * The content of the JournalEntryPage in a format appropriate for its type.
+       * @defaultValue `undefined`
+       */
+      content: fields.HTMLField<{ required: false; initial: undefined; textSearch: true }>;
+
+      /**
+       * The original markdown source, if applicable.
+       * @defaultValue `undefined`
+       */
+      markdown: fields.StringField<{ required: false; initial: undefined }>;
+
+      /**
+       * The format of the page's content, in {@link CONST.JOURNAL_ENTRY_PAGE_FORMATS}.
+       * @defaultValue `CONST.JOURNAL_ENTRY_PAGE_FORMATS.HTML`
+       */
+      format: fields.NumberField<{
+        label: "JOURNALENTRYPAGE.Format";
+        initial: typeof CONST.JOURNAL_ENTRY_PAGE_FORMATS.HTML;
+        choices: foundry.CONST.JOURNAL_ENTRY_PAGE_FORMATS[];
+      }>;
+    }>;
+
+    /**
+     * Data particular to video journal entry pages.
+     */
+    video: fields.SchemaField<{
+      controls: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * Automatically loop the video?
+       * @defaultValue `undefined`
+       */
+      loop: fields.BooleanField<{ required: false; initial: undefined }>;
+
+      /**
+       * Should the video play automatically?
+       * @defaultValue `undefined`
+       */
+      autoplay: fields.BooleanField<{ required: false; initial: undefined }>;
+
+      /**
+       * The volume level of any audio that the video file contains.
+       * @defaultValue `0.5`
+       */
+      volume: fields.AlphaField<{ required: true; step: 0.01; initial: 0.5 }>;
+
+      /**
+       * The starting point of the video, in seconds.
+       * @defaultValue `undefined`
+       */
+      timestamp: fields.NumberField<{ required: false; min: 0; initial: undefined }>;
+
+      /**
+       * The width of the video, otherwise it will fill the available container width.
+       * @defaultValue `undefined`
+       */
+      width: fields.NumberField<{ required: false; positive: true; integer: true; initial: undefined }>;
+
+      /**
+       * The height of the video, otherwise it will use the aspect ratio of the source video, or 16:9 if that aspect
+       * ratio is not available.
+       * @defaultValue `undefined`
+       */
+      height: fields.NumberField<{ required: false; positive: true; integer: true; initial: undefined }>;
+    }>;
+
+    /**
+     * The URI of the image or other external media to be used for this page.
+     * @defaultValue `null`
+     */
+    src: fields.StringField<{
+      required: false;
+      blank: false;
+      nullable: true;
+      initial: null;
+      label: "JOURNALENTRYPAGE.Source";
+    }>;
+
+    /**
+     * The numeric sort value which orders this page relative to its siblings.
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures the ownership of this page.
+     * @defaultValue `CONST.DOCUMENT_OWNERSHIP_LEVELS.INHERIT`
+     */
+    ownership: fields.DocumentOwnershipField<{ initial: { default: typeof CONST.DOCUMENT_OWNERSHIP_LEVELS.INHERIT } }>;
+
+    /**
+     * An object of optional key/value flags.
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"JournalEntryPage">;
+
+    _stats: fields.DocumentStatsField;
+  }
+}

package/src/foundry/common/documents/journal-entry.d.mts

@@ -0,0 +1,91 @@
+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 JournalEntry Document.
+ * Defines the DataSchema and common behaviors for a JournalEntry 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 BaseJournalEntry extends Document<"JournalEntry", BaseJournalEntry.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the JournalEntry
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data: BaseJournalEntry.ConstructorData, context?: Document.ConstructionContext<BaseJournalEntry.Parent>);
+
+  override parent: BaseJournalEntry.Parent;
+
+  static override metadata: BaseJournalEntry.Metadata;
+
+  static override defineSchema(): BaseJournalEntry.Schema;
+
+  static override migrateData(source: AnyObject): AnyObject;
+}
+
+export default BaseJournalEntry;
+
+declare namespace BaseJournalEntry {
+  type Parent = null;
+
+  type Metadata = Document.MetadataFor<BaseJournalEntry>;
+
+  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 JournalEntry document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The name of this JournalEntry
+     */
+    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+    /**
+     * The pages contained within this JournalEntry document
+     * @defaultValue `[]`
+     */
+    pages: fields.EmbeddedCollectionField<typeof documents.BaseJournalEntryPage, JournalEntry.ConfiguredInstance>;
+
+    /**
+     * The _id of a Folder which contains this JournalEntry
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+    /**
+     * The numeric sort value which orders this JournalEntry relative to its siblings
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures ownership of this JournalEntry
+     * @defaultValue see {@link fields.DocumentOwnershipField}
+     */
+    ownership: fields.DocumentOwnershipField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"JournalEntry">;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@link fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+}

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

@@ -0,0 +1,174 @@
+import type { AnyObject, InexactPartial } from "../../../types/utils.d.mts";
+import type Document from "../abstract/document.d.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 Macro Document.
+ * Defines the DataSchema and common behaviors for a Macro 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 BaseMacro extends Document<"Macro", BaseMacro.Schema, any> {
+  /**
+   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   */
+  static get TYPES(): BaseMacro.TypeNames[];
+
+  /**
+   * @param data    - Initial data from which to construct the Macro
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data: BaseMacro.ConstructorData, context?: Document.ConstructionContext<BaseMacro.Parent>);
+
+  override parent: BaseMacro.Parent;
+
+  static override metadata: BaseMacro.Metadata;
+
+  static override defineSchema(): BaseMacro.Schema;
+
+  /**
+   * The default icon used for newly created Macro documents.
+   */
+  static DEFAULT_ICON: "icons/svg/dice-target.svg";
+
+  static override migrateData(source: AnyObject): AnyObject;
+
+  static override validateJoint(data: Record<string, unknown>): void;
+
+  static override canUserCreate(user: foundry.documents.BaseUser): 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;
+
+  /**
+   * @privateRemarks _preCreate all overridden but with no signature changes.
+   * For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
+   */
+}
+export default BaseMacro;
+
+declare namespace BaseMacro {
+  type Parent = null;
+
+  type TypeNames = Game.Model.TypeNames<"Macro">;
+
+  type Metadata = Document.MetadataFor<BaseMacro>;
+
+  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 Macro document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The name of this Macro
+     * @defaultValue `""`
+     */
+    name: fields.StringField<{
+      required: true;
+      blank: false;
+      label: "Name";
+      textSearch: true;
+    }>;
+
+    /**
+     * A Macro subtype from CONST.MACRO_TYPES
+     * @defaultValue `CONST.MACRO_TYPES.CHAT`
+     */
+    type: fields.DocumentTypeField<
+      typeof BaseMacro,
+      {
+        initial: typeof CONST.MACRO_TYPES.CHAT;
+        label: "Type";
+      }
+    >;
+
+    /**
+     * The _id of a User document which created this Macro *
+     * @defaultValue `game?.user?.id`
+     */
+    author: fields.ForeignDocumentField<typeof documents.BaseUser, { initial: () => string }>;
+
+    /**
+     * An image file path which provides the thumbnail artwork for this Macro
+     * @defaultValue `BaseMacro.DEFAULT_ICON`
+     */
+    img: fields.FilePathField<{
+      categories: ["IMAGE"];
+      initial: () => typeof BaseMacro.DEFAULT_ICON;
+      label: "Image";
+    }>;
+
+    /**
+     * The scope of this Macro application from CONST.MACRO_SCOPES
+     * @defaultValue `"global"`
+     */
+    scope: fields.StringField<{
+      required: true;
+      choices: CONST.MACRO_SCOPES[];
+      initial: (typeof CONST.MACRO_SCOPES)[0];
+      validationError: "must be a value in CONST.MACRO_SCOPES";
+      label: "Scope";
+    }>;
+
+    /**
+     * The string content of the macro command
+     * @defaultValue `""`
+     */
+    command: fields.StringField<{
+      required: true;
+      blank: true;
+      label: "Command";
+    }>;
+
+    /**
+     * The _id of a Folder which contains this Macro
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+    /**
+     * The numeric sort value which orders this Macro relative to its siblings
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures ownership of this Macro
+     * @defaultValue see {@link fields.DocumentOwnershipField}
+     */
+    ownership: fields.DocumentOwnershipField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Macro">;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@link fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+}