@league-of-foundry-developers/foundry-vtt-types 0.8.9-6 → 9.238.0

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

@@ -10,23 +10,24 @@ import * as documents from '../../documents.mjs';
 import * as fields from '../fields.mjs';
 
 interface RollTableDataSchema extends DocumentSchema {
-  _id: typeof fields.DOCUMENT_ID;
-  name: typeof fields.REQUIRED_STRING;
-  img: FieldReturnType<typeof fields.IMAGE_FIELD, { default: () => string }>;
-  description: typeof fields.STRING_FIELD;
+  _id: fields.DocumentId;
+  name: fields.RequiredString;
+  img: FieldReturnType<fields.ImageField, { default: () => typeof RollTableData.DEFAULT_ICON }>;
+  description: fields.StringField;
   results: fields.EmbeddedCollectionField<typeof documents.BaseTableResult>;
-  formula: typeof fields.STRING_FIELD;
-  replacement: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
-  displayRoll: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
+  formula: fields.StringField;
+  replacement: FieldReturnType<fields.BooleanField, { default: true }>;
+  displayRoll: FieldReturnType<fields.BooleanField, { default: true }>;
   folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: typeof fields.INTEGER_SORT_FIELD;
-  permission: typeof fields.DOCUMENT_PERMISSIONS;
-  flags: typeof fields.OBJECT_FIELD;
+  sort: fields.IntegerSortField;
+  permission: fields.DocumentPermissions;
+  flags: fields.ObjectField;
 }
 
 interface RollTableDataProperties {
   /**
    * The _id which uniquely identifies this RollTable document
+   * @defaultValue `null`
    */
   _id: string | null;
 
@@ -37,6 +38,7 @@ interface RollTableDataProperties {
 
   /**
    * An image file path which provides the thumbnail artwork for this RollTable
+   * @defaultValue `RollTableData.DEFAULT_ICON`
    */
   img: string;
 
@@ -47,6 +49,7 @@ interface RollTableDataProperties {
 
   /**
    * A Collection of TableResult embedded documents which belong to this RollTable
+   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
    */
   results: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseTableResult>, RollTableData>;
 
@@ -82,7 +85,7 @@ interface RollTableDataProperties {
    * An object which configures user permissions to this RollTable
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission: Partial<Record<string, foundry.CONST.EntityPermission>>;
+  permission: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>>;
 
   /**
    * An object of optional key/value flags
@@ -95,7 +98,7 @@ interface RollTableDataConstructorData {
   /**
    * The _id which uniquely identifies this RollTable document
    */
-  _id?: string | null;
+  _id?: string | null | undefined;
 
   /**
    * The name of this RollTable
@@ -104,70 +107,73 @@ interface RollTableDataConstructorData {
 
   /**
    * An image file path which provides the thumbnail artwork for this RollTable
+   * @defaultValue `RollTableData.DEFAULT_ICON`
    */
-  img?: string | null;
+  img?: string | null | undefined;
 
   /**
    * The HTML text description for this RollTable document
    */
-  description?: string | null;
+  description?: string | null | undefined;
 
   /**
    * A Collection of TableResult embedded documents which belong to this RollTable
+   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
    */
-  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null;
+  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null | undefined;
 
   /**
    * The Roll formula which determines the results chosen from the table
    */
-  formula?: string | null;
+  formula?: string | null | undefined;
 
   /**
    * Are results from this table drawn with replacement?
    * @defaultValue `true`
    */
-  replacement?: boolean | null;
+  replacement?: boolean | null | undefined;
 
   /**
    * Is the Roll result used to draw from this RollTable displayed in chat?
    * @defaultValue `true`
    */
-  displayRoll?: boolean | null;
+  displayRoll?: boolean | null | undefined;
 
   /**
    * The _id of a Folder which contains this RollTable
    */
-  folder?: string | null;
+  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
 
   /**
    * The numeric sort value which orders this RollTable relative to its siblings
    */
-  sort?: number | null;
+  sort?: number | null | undefined;
 
   /**
    * An object which configures user permissions to this RollTable
    * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
    */
-  permission?: Partial<Record<string, foundry.CONST.EntityPermission>> | null;
+  permission?: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>> | null | undefined;
 
   /**
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'RollTable'> | null;
+  flags?: ConfiguredFlags<'RollTable'> | null | undefined;
 }
 
 /**
  * The data schema for an RollTable document.
  * @see BaseRollTable
  */
-export declare class RollTableData extends DocumentData<
+export class RollTableData extends DocumentData<
   RollTableDataSchema,
   RollTableDataProperties,
   PropertiesToSource<RollTableDataProperties>,
   RollTableDataConstructorData,
   documents.BaseRollTable
 > {
+  /** @override */
   static defineSchema(): RollTableDataSchema;
 
   /**
@@ -179,4 +185,4 @@ export declare class RollTableData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface RollTableData extends RollTableDataProperties {}
+export interface RollTableData extends RollTableDataProperties {}