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

package/src/foundry/common/documents/measured-template.d.mts

@@ -0,0 +1,168 @@
+import type { 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 a MeasuredTemplate.
+ * Defines the DataSchema and common behaviors for a MeasuredTemplate 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 BaseMeasuredTemplate extends Document<"MeasuredTemplate", BaseMeasuredTemplate.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the MeasuredTemplate
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(
+  //   data?: BaseMeasuredTemplate.ConstructorData,
+  //   context?: Document.ConstructionContext<BaseMeasuredTemplate.Parent>,
+  // );
+
+  override parent: BaseMeasuredTemplate.Parent;
+
+  static override metadata: BaseMeasuredTemplate.Metadata;
+
+  static override defineSchema(): BaseMeasuredTemplate.Schema;
+
+  /**
+   * Is a user able to create a new MeasuredTemplate?
+   * @param user - The user attempting the creation operation.
+   * @param doc  - The MeasuredTemplate being created.
+   * @internal
+   */
+  static #canCreate(user: documents.BaseUser, doc: BaseMeasuredTemplate): boolean;
+
+  /**
+   * Is a user able to modify an existing MeasuredTemplate?
+   * @param user - The user attempting the modification.
+   * @param doc  - The MeasuredTemplate being modified.
+   * @param data - Data being changed.
+   * @internal
+   */
+  static #canModify(
+    user: documents.BaseUser,
+    doc: BaseMeasuredTemplate,
+    data?: BaseMeasuredTemplate.UpdateData,
+  ): boolean;
+
+  override testUserPermission(
+    user: foundry.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;
+}
+
+export default BaseMeasuredTemplate;
+
+declare namespace BaseMeasuredTemplate {
+  type Parent = Scene.ConfiguredInstance | null;
+
+  type Metadata = Document.MetadataFor<BaseMeasuredTemplate>;
+
+  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 BaseMeasuredTemplate embedded document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The _id of the user who created this measured template
+     * @defaultValue `game?.user?.id`
+     */
+    user: fields.ForeignDocumentField<typeof documents.BaseUser, { initial: () => string }>;
+
+    /**
+     * The value in CONST.MEASURED_TEMPLATE_TYPES which defines the geometry type of this template
+     * @defaultValue `CONST.MEASURED_TEMPLATE_TYPES.CIRCLE`
+     */
+    t: fields.StringField<{
+      required: true;
+      choices: foundry.CONST.MEASURED_TEMPLATE_TYPES[];
+      label: "Type";
+      initial: typeof CONST.MEASURED_TEMPLATE_TYPES.CIRCLE;
+      validationError: "must be a value in CONST.MEASURED_TEMPLATE_TYPES";
+    }>;
+
+    /**
+     * The x-coordinate position of the origin of the template effect
+     * @defaultValue `0`
+     */
+    x: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "XCoord" }>;
+
+    /**
+     * The y-coordinate position of the origin of the template effect
+     * @defaultValue `0`
+     */
+    y: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "YCoord" }>;
+
+    /**
+     * The distance of the template effect
+     * @defaultValue `1`
+     */
+    distance: fields.NumberField<{ required: true; positive: true; initial: 1; label: "Distance" }>;
+
+    /**
+     * The angle of rotation for the measured template
+     * @defaultValue `0`
+     */
+    direction: fields.AngleField<{ label: "Direction" }>;
+
+    /**
+     * The angle of effect of the measured template, applies to cone types
+     * @defaultValue `0`
+     */
+    angle: fields.AngleField<{ label: "Angle" }>;
+
+    /**
+     * The width of the measured template, applies to ray types
+     * @defaultValue `null`
+     */
+    width: fields.NumberField<{ integer: true; positive: true; label: "Width" }>;
+
+    /**
+     * A color string used to tint the border of the template shape
+     * @defaultValue `#000000`
+     */
+    borderColor: fields.ColorField<{ initial: "#000000" }>;
+
+    /**
+     * A color string used to tint the fill of the template shape
+     * @defaultValue `#FF0000`
+     */
+    fillColor: fields.ColorField<{ initial: "#FF0000" }>;
+
+    /**
+     * A repeatable tiling texture used to add a texture fill to the template shape
+     * @defaultValue `null`
+     */
+    texture: fields.FilePathField<{ categories: ["IMAGE", "VIDEO"] }>;
+
+    /**
+     * Is the template currently hidden?
+     * @defaultValue `false`
+     */
+    hidden: fields.BooleanField<{ label: "Hidden" }>;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"MeasuredTemplate">;
+  }
+}

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

@@ -0,0 +1,35 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved from erroring `.mjs` is used.
+/* eslint-disable import/extensions */
+
+export { default as BaseActiveEffect } from "./active-effect.mjs";
+export { default as BaseActorDelta } from "./actor-delta.mjs";
+export { default as BaseActor } from "./actor.mjs";
+export { default as BaseAdventure } from "./adventure.mjs";
+export { default as BaseAmbientLight } from "./ambient-light.mjs";
+export { default as BaseAmbientSound } from "./ambient-sound.mjs";
+export { default as BaseCard } from "./card.mjs";
+export { default as BaseCards } from "./cards.mjs";
+export { default as BaseChatMessage } from "./chat-message.mjs";
+export { default as BaseCombat } from "./combat.mjs";
+export { default as BaseCombatant } from "./combatant.mjs";
+export { default as BaseDrawing } from "./drawing.mjs";
+export { default as BaseFogExploratidn } from "./fog-exploration.mjs";
+export { default as BaseFolder } from "./folder.mjs";
+export { default as BaseItem } from "./item.mjs";
+export { default as BaseJournalEntry } from "./journal-entry.mjs";
+export { default as BaseJournalEntryPage } from "./journal-entry-page.mjs";
+export { default as BaseMacro } from "./macro.mjs";
+export { default as BaseMeasuredTemplate } from "./measured-template.mjs";
+export { default as BaseNote } from "./note.mjs";
+export { default as BasePlaylist } from "./playlist.mjs";
+export { default as BasePlaylistSound } from "./playlist-sound.mjs";
+export { default as BaseRollTable } from "./roll-table.mjs";
+export { default as BaseScene } from "./scene.mjs";
+export { default as BaseSetting } from "./setting.mjs";
+export { default as BaseTableResult } from "./table-result.mjs";
+export { default as BaseTile } from "./tile.mjs";
+export { default as BaseToken } from "./token.mjs";
+export { default as BaseUser } from "./user.mjs";
+export { default as BaseWall } from "./wall.mjs";

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

@@ -0,0 +1,183 @@
+import type { AnyObject, InexactPartial } from "../../../types/utils.mts";
+import type Document from "../abstract/document.mts";
+import type { TextureData } from "../data/data.mts";
+import type * as fields from "../data/fields.d.mts";
+import type * as documents from "./_module.mts";
+
+/**
+ * The Document definition for a Note.
+ * Defines the DataSchema and common behaviors for a Note 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 BaseNote extends Document<"Note", BaseNote.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the Note
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data?: BaseNote.ConstructorData, context?: Document.ConstructionContext<BaseNote.Parent>);
+
+  override parent: BaseNote.Parent;
+
+  static override metadata: BaseNote.Metadata;
+
+  static override defineSchema(): BaseNote.Schema;
+
+  /**
+   * The default icon used for newly created Note documents.
+   * @defaultValue `"icons/svg/book.svg"`
+   */
+  static DEFAULT_ICON: string;
+
+  override testUserPermission(
+    user: foundry.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;
+
+  static override shimData(
+    data: AnyObject,
+    options?: {
+      /**
+       * Apply shims to embedded models?
+       * @defaultValue `true`
+       */
+      embedded?: boolean;
+    },
+  ): AnyObject;
+}
+
+export default BaseNote;
+
+declare namespace BaseNote {
+  type Parent = Scene.ConfiguredInstance | null;
+
+  type Metadata = Document.MetadataFor<BaseNote>;
+
+  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 BaseNote embedded document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The _id of a JournalEntry document which this Note represents
+     * @defaultValue `null`
+     */
+    entryId: fields.ForeignDocumentField<typeof documents.BaseJournalEntry, { idOnly: true }>;
+
+    /**
+     * The _id of a specific JournalEntryPage document which this Note represents
+     * @defaultValue `null`
+     */
+    pageId: fields.ForeignDocumentField<typeof documents.BaseJournalEntryPage, { idOnly: true }>;
+
+    /**
+     * The x-coordinate position of the center of the note icon
+     * @defaultValue `0`
+     */
+    x: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "XCoord" }>;
+
+    /**
+     * The y-coordinate position of the center of the note icon
+     * @defaultValue `0`
+     */
+    y: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "YCoord" }>;
+
+    /**
+     * An image icon used to represent this note
+     * @defaultValue `BaseNote.DEFAULT_ICON`
+     */
+    texture: TextureData<{
+      categories: ["IMAGE"];
+      initial: () => typeof BaseNote.DEFAULT_ICON;
+      label: "NOTE.EntryIcon";
+    }>;
+
+    /**
+     * The pixel size of the map note icon
+     * @defaultValue `40`
+     */
+    iconSize: fields.NumberField<{
+      required: true;
+      integer: true;
+      min: 32;
+      initial: 40;
+      validationError: "must be an integer greater than 32";
+      label: "NOTE.IconSize";
+    }>;
+
+    /**
+     * Optional text which overrides the title of the linked Journal Entry
+     * @defaultValue `""`
+     */
+    text: fields.StringField<{ label: "NOTE.TextLabel"; textSearch: true }>;
+
+    /**
+     * The font family used to display the text label on this note, defaults to CONFIG.defaultFontFamily
+     * @defaultValue `globalThis.CONFIG?.defaultFontFamily || "Signika"`
+     */
+    fontFamily: fields.StringField<{ required: true; label: "NOTE.FontFamily"; initial: () => string }>;
+
+    /**
+     * The font size used to display the text label on this note
+     * @defaultValue `32`
+     */
+    fontSize: fields.NumberField<{
+      required: true;
+      integer: true;
+      min: 8;
+      max: 128;
+      initial: 32;
+      validationError: "must be an integer between 8 and 128";
+      label: "NOTE.FontSize";
+    }>;
+
+    /**
+     * A value in CONST.TEXT_ANCHOR_POINTS which defines where the text label anchors to the note icon.
+     * @defaultValue `CONST.TEXT_ANCHOR_POINTS.BOTTOM`
+     */
+    textAnchor: fields.NumberField<{
+      required: true;
+      choices: foundry.CONST.TEXT_ANCHOR_POINTS[];
+      initial: typeof CONST.TEXT_ANCHOR_POINTS.BOTTOM;
+      label: "NOTE.AnchorPoint";
+      validationError: "must be a value in CONST.TEXT_ANCHOR_POINTS";
+    }>;
+
+    /**
+     * The string that defines the color with which the note text is rendered
+     * @defaultValue `#FFFFFF`
+     */
+    textColor: fields.ColorField<{ initial: "#FFFFFF"; label: "NOTE.TextColor" }>;
+
+    /**
+     * Whether this map pin is globally visible or requires LoS to see.
+     * @defaultValue `false`
+     */
+    global: fields.BooleanField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Note">;
+  }
+}

package/src/foundry/common/documents/playlist-sound.d.mts

@@ -0,0 +1,127 @@
+import type { InexactPartial } from "../../../types/utils.mts";
+import type Document from "../abstract/document.mts";
+import type * as fields from "../data/fields.d.mts";
+
+/**
+ * The PlaylistSound Document.
+ * Defines the DataSchema and common behaviors for a PlaylistSound 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 BasePlaylistSound extends Document<"PlaylistSound", BasePlaylistSound.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the PlaylistSound
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(
+  //   data: BasePlaylistSound.ConstructorData,
+  //   context?: Document.ConstructionContext<BasePlaylistSound.Parent>,
+  // );
+
+  override parent: BasePlaylistSound.Parent;
+
+  static override metadata: BasePlaylistSound.Metadata;
+
+  static override defineSchema(): BasePlaylistSound.Schema;
+
+  override testUserPermission(
+    user: foundry.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;
+}
+
+export default BasePlaylistSound;
+
+declare namespace BasePlaylistSound {
+  type Parent = Playlist.ConfiguredInstance | null;
+
+  type Metadata = Document.MetadataFor<BasePlaylistSound>;
+
+  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 PlaylistSound document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The name of this sound
+     */
+    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+    /**
+     * The description of this sound
+     * @defaultValue `""`
+     */
+    description: fields.StringField;
+
+    /**
+     * The audio file path that is played by this sound
+     * @defaultValue `null`
+     */
+    path: fields.FilePathField<{ categories: ["AUDIO"] }>;
+
+    /**
+     * A channel in CONST.AUDIO_CHANNELS where this sound is are played
+     * @defaultValue `"music"`
+     */
+    channel: fields.StringField<{ choices: typeof foundry.CONST.AUDIO_CHANNELS; initial: string; blank: false }>;
+
+    /**
+     * Is this sound currently playing?
+     * @defaultValue `false`
+     */
+    playing: fields.BooleanField;
+
+    /**
+     * The time in seconds at which playback was paused
+     * @defaultValue `null`
+     */
+    pausedTime: fields.NumberField<{ min: 0 }>;
+
+    /**
+     * Does this sound loop?
+     * @defaultValue `false`
+     */
+    repeat: fields.BooleanField;
+
+    /**
+     * The audio volume of the sound, from 0 to 1
+     * @defaultValue `1`
+     */
+    volume: fields.AlphaField<{ initial: 0.5; step: 0.01 }>;
+
+    /**
+     * A duration in milliseconds to fade volume transition
+     * @defaultValue `null`
+     */
+    fade: fields.NumberField<{ integer: true; min: 0 }>;
+
+    /**
+     * The sort order of the PlaylistSound relative to others in the same collection
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"PlaylistSound">;
+  }
+}

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

@@ -0,0 +1,154 @@
+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 Playlist Document.
+ * Defines the DataSchema and common behaviors for a Playlist 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 BasePlaylist extends Document<"Playlist", BasePlaylist.Schema, any> {
+  /**
+   * @param data    - Initial data from which to construct the Playlist
+   * @param context - Construction context options
+   */
+  // TODO(LukeAbby): This constructor is a symptom of a circular error.
+  // constructor(data: BasePlaylist.ConstructorData, context?: Document.ConstructionContext<BasePlaylist.Parent>);
+
+  override parent: BasePlaylist.Parent;
+
+  static override metadata: BasePlaylist.Metadata;
+
+  static override defineSchema(): BasePlaylist.Schema;
+
+  static override migrateData(source: AnyObject): AnyObject;
+
+  static override shimData(
+    data: AnyObject,
+    options?: {
+      /**
+       * Apply shims to embedded models?
+       * @defaultValue `true`
+       */
+      embedded?: boolean;
+    },
+  ): AnyObject;
+}
+
+export default BasePlaylist;
+
+declare namespace BasePlaylist {
+  type Parent = null;
+
+  type Metadata = Document.MetadataFor<BasePlaylist>;
+
+  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 Playlist document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /**
+     * The name of this playlist
+     */
+    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+    /**
+     * The description of this playlist
+     * @defaultValue `""`
+     */
+    description: fields.StringField<{ textSearch: true }>;
+
+    /**
+     * A Collection of PlaylistSounds embedded documents which belong to this playlist
+     * @defaultValue `[]`
+     */
+    sounds: fields.EmbeddedCollectionField<typeof documents.BasePlaylistSound, Playlist.ConfiguredInstance>;
+
+    /**
+     * A channel in CONST.AUDIO_CHANNELS where all sounds in this playlist are played
+     * @defaultValue `"music"`
+     */
+    channel: fields.StringField<{ choices: typeof foundry.CONST.AUDIO_CHANNELS; initial: string; blank: false }>;
+
+    /**
+     * The playback mode for sounds in this playlist
+     * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
+     */
+    mode: fields.NumberField<{
+      required: true;
+      choices: foundry.CONST.PLAYLIST_MODES[];
+      initial: typeof CONST.PLAYLIST_MODES.SEQUENTIAL;
+      validationError: "must be a value in CONST.PLAYLIST_MODES";
+    }>;
+
+    /**
+     * Is this playlist currently playing?
+     * @defaultValue `false`
+     */
+    playing: fields.BooleanField;
+
+    /**
+     * A duration in milliseconds to fade volume transition
+     * @defaultValue `null`
+     */
+    fade: fields.NumberField<{ positive: true }>;
+
+    /**
+     * The _id of a Folder which contains this playlist
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+    /**
+     * The sorting mode used for this playlist.
+     * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
+     */
+    sorting: fields.StringField<{
+      required: true;
+      choices: foundry.CONST.PLAYLIST_SORT_MODES[];
+      initial: typeof CONST.PLAYLIST_SORT_MODES.ALPHABETICAL;
+      validationError: "must be a value in CONST.PLAYLIST_SORTING_MODES";
+    }>;
+
+    /**
+     * A seed used for playlist randomization to guarantee that all clients generate the same random order.
+     * @defaultValue `null`
+     */
+    seed: fields.NumberField<{ integer: true; min: 0 }>;
+
+    /**
+     * The numeric sort value which orders this playlist relative to its siblings
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * An object which configures ownership of this Playlist
+     * @defaultValue see {@link fields.DocumentOwnershipField}
+     */
+    ownership: fields.DocumentOwnershipField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.ObjectField.FlagsField<"Playlist">;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@link fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+}