@league-of-foundry-developers/foundry-vtt-types 0.8.9-9 → 9.245.0

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

@@ -1,16 +1,17 @@
-import * as CONST from '../constants.mjs';
+import { DOCUMENT_PERMISSION_LEVELS } from '../constants.mjs';
 import { hasImageExtension, isColorString, isJSON } from './validators.mjs';
 import { Document } from '../abstract/module.mjs';
 import { FieldReturnType } from '../../../types/helperTypes';
 
 /**
  * A required boolean field which may be used in a Document.
- * @remarks
+ */
+export const BOOLEAN_FIELD: BooleanField;
+/**
  * Property type: `boolean`
- * Constructor type: `boolean | undefined | null`
+ * Constructor type: `boolean | null | undefined`
  * Default: `false`
  */
-export declare const BOOLEAN_FIELD: BooleanField;
 interface BooleanField extends DocumentField<boolean> {
   type: typeof Boolean;
   required: true;
@@ -19,11 +20,12 @@ interface BooleanField extends DocumentField<boolean> {
 
 /**
  * A standard string color field which may be used in a Document.
- * @remarks
- * Property type: `string | undefined | null`
- * Constructor type: `string | undefined | null`
  */
-export declare const COLOR_FIELD: ColorField;
+export const COLOR_FIELD: ColorField;
+/**
+ * Property type: `string | null | undefined`
+ * Constructor type: `string | null | undefined`
+ */
 interface ColorField extends DocumentField<string> {
   type: typeof String;
   required: false;
@@ -34,11 +36,12 @@ interface ColorField extends DocumentField<string> {
 
 /**
  * A standard string field for an image file path which may be used in a Document.
- * @remarks
- * Property type: `string | undefined | null`
- * Constructor type: `string | undefined | null`
  */
-export declare const IMAGE_FIELD: ImageField;
+export const IMAGE_FIELD: ImageField;
+/**
+ * Property type: `string | null | undefined`
+ * Constructor type: `string | null | undefined`
+ */
 interface ImageField extends DocumentField<string> {
   type: typeof String;
   required: false;
@@ -49,11 +52,12 @@ interface ImageField extends DocumentField<string> {
 
 /**
  * A standard string field for a video or image file path may be used in a Document.
- * @remarks
- * Property type: `string | undefined | null`
- * Constructor type: `string | undefined | null`
  */
-export declare const VIDEO_FIELD: VideoField;
+export const VIDEO_FIELD: VideoField;
+/**
+ * Property type: `string | null | undefined`
+ * Constructor type: `string | null | undefined`
+ */
 interface VideoField extends DocumentField<string> {
   type: typeof String;
   required: false;
@@ -64,11 +68,12 @@ interface VideoField extends DocumentField<string> {
 
 /**
  * A standard string field for an audio file path which may be used in a Document.
- * @remarks
- * Property type: `string | undefined | null`
- * Constructor type: `string | undefined | null`
  */
-export declare const AUDIO_FIELD: AudioField;
+export const AUDIO_FIELD: AudioField;
+/**
+ * Property type: `string | null | undefined`
+ * Constructor type: `string | null | undefined`
+ */
 interface AudioField extends DocumentField<string> {
   type: typeof String;
   required: false;
@@ -79,11 +84,12 @@ interface AudioField extends DocumentField<string> {
 
 /**
  * A standard integer field which may be used in a Document.
- * @remarks
+ */
+export const INTEGER_FIELD: IntegerField;
+/**
  * Property type: `number | undefined`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  */
-export declare const INTEGER_FIELD: IntegerField;
 interface IntegerField extends DocumentField<number> {
   type: typeof Number;
   required: false;
@@ -93,12 +99,13 @@ interface IntegerField extends DocumentField<number> {
 
 /**
  * A string field which contains serialized JSON data that may be used in a Document.
- * @remarks
+ */
+export const JSON_FIELD: JsonField;
+/**
  * Property type: `string | undefined`
- * Constructor type: `string | object | undefined | null`
+ * Constructor type: `string | object | null | undefined`
  */
-export declare const JSON_FIELD: JSONField;
-interface JSONField extends DocumentField<string> {
+interface JsonField extends DocumentField<string> {
   type: typeof String;
   required: false;
   clean: (s: unknown) => string;
@@ -108,11 +115,12 @@ interface JSONField extends DocumentField<string> {
 
 /**
  * A non-negative integer field which may be used in a Document.
- * @remarks
+ */
+export const NONNEGATIVE_INTEGER_FIELD: NonnegativeIntegerField;
+/**
  * Property type: `number | undefined`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  */
-export declare const NONNEGATIVE_INTEGER_FIELD: NonnegativeIntegerField;
 interface NonnegativeIntegerField extends DocumentField<number> {
   type: typeof Number;
   required: false;
@@ -124,11 +132,12 @@ interface NonnegativeIntegerField extends DocumentField<number> {
  * A non-negative integer field which may be used in a Document.
  *
  * @remarks The validation actually checks for `> 0`, the JSDoc is incorrect in foundry.
- * @remarks
+ */
+export const POSITIVE_INTEGER_FIELD: PositiveIntegerField;
+/**
  * Property type: `number | undefined`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  */
-export declare const POSITIVE_INTEGER_FIELD: PositiveIntegerField;
 interface PositiveIntegerField extends DocumentField<number> {
   type: typeof Number;
   required: false;
@@ -138,25 +147,27 @@ interface PositiveIntegerField extends DocumentField<number> {
 
 /**
  * A template for a required inner-object field which may be used in a Document.
- * @remarks
+ */
+export const OBJECT_FIELD: ObjectField;
+/**
  * Property type: `object`
- * Constructor type: `object | undefined | null`
+ * Constructor type: `object | null | undefined`
  * Default `{}`
  */
-export declare const OBJECT_FIELD: ObjectField;
 interface ObjectField extends DocumentField<object> {
   type: typeof Object;
-  default: {};
+  default: Record<string, never>;
   required: true;
 }
 
 /**
  * An optional string field which may be included by a Document.
- * @remarks
+ */
+export const STRING_FIELD: StringField;
+/**
  * Property type: `string | undefined`
- * Constructor type: `string | undefined | null`
+ * Constructor type: `string | null | undefined`
  */
-export declare const STRING_FIELD: StringField;
 interface StringField extends DocumentField<string> {
   type: typeof String;
   required: false;
@@ -165,11 +176,12 @@ interface StringField extends DocumentField<string> {
 
 /**
  * An optional numeric field which may be included in a Document.
- * @remarks
- * Property type: `number | undefined | null`
- * Constructor type: `number | undefined | null`
  */
-export declare const NUMERIC_FIELD: NumericField;
+export const NUMERIC_FIELD: NumericField;
+/**
+ * Property type: `number | null | undefined`
+ * Constructor type: `number | null | undefined`
+ */
 interface NumericField extends DocumentField<number> {
   type: typeof Number;
   required: false;
@@ -178,12 +190,13 @@ interface NumericField extends DocumentField<number> {
 
 /**
  * A required numeric field which may be included in a Document and may not be null.
- * @remarks
+ */
+export const REQUIRED_NUMBER: RequiredNumber;
+/**
  * Property type: `number`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  * Default: `0`
  */
-export declare const REQUIRED_NUMBER: RequiredNumber;
 interface RequiredNumber extends DocumentField<number> {
   type: typeof Number;
   required: true;
@@ -191,13 +204,32 @@ interface RequiredNumber extends DocumentField<number> {
   default: 0;
 }
 
+/**
+ * A field used to designate a non-negative number
+ */
+export const NONNEGATIVE_NUMBER_FIELD: NonnegativeNumberField;
+/**
+ * Property type: `number`
+ * Constructor type: `number | null | undefined`
+ * Default: `0`
+ */
+interface NonnegativeNumberField extends DocumentField<number> {
+  type: typeof Number;
+  required: true;
+  nullable: false;
+  default: 0;
+  validate: (n: unknown) => boolean;
+  validationError: '{name} {field} "{value}" must be a non-negative number';
+}
+
 /**
  * A required numeric field which must be a positive finite value that may be included in a Document.
- * @remarks
+ */
+export const REQUIRED_POSITIVE_NUMBER: RequiredPositiveNumber;
+/**
  * Property type: `number`
  * Constructor type: `number`
  */
-export declare const REQUIRED_POSITIVE_NUMBER: RequiredPositiveNumber;
 interface RequiredPositiveNumber extends DocumentField<number> {
   type: typeof Number;
   required: true;
@@ -208,12 +240,13 @@ interface RequiredPositiveNumber extends DocumentField<number> {
 
 /**
  * A required numeric field which represents an angle of rotation in degrees between 0 and 360.
- * @remarks
+ */
+export const ANGLE_FIELD: AngleField;
+/**
  * Property type: `number`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  * Default: `360`
  */
-export declare const ANGLE_FIELD: AngleField;
 interface AngleField extends DocumentField<number> {
   type: typeof Number;
   required: true;
@@ -226,12 +259,13 @@ interface AngleField extends DocumentField<number> {
 
 /**
  * A required numeric field which represents a uniform number between 0 and 1.
- * @remarks
+ */
+export const ALPHA_FIELD: AlphaField;
+/**
  * Property type: `number`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  * Default: `1`
  */
-export declare const ALPHA_FIELD: AlphaField;
 interface AlphaField extends DocumentField<number> {
   type: typeof Number;
   required: true;
@@ -243,11 +277,12 @@ interface AlphaField extends DocumentField<number> {
 
 /**
  * A string field which requires a non-blank value and may not be null.
- * @remarks
+ */
+export const REQUIRED_STRING: RequiredString;
+/**
  * Property type: `string`
  * Constructor type: `string`
  */
-export declare const REQUIRED_STRING: RequiredString;
 interface RequiredString extends DocumentField<string> {
   type: typeof String;
   required: true;
@@ -257,12 +292,13 @@ interface RequiredString extends DocumentField<string> {
 
 /**
  * A string field which is required, but may be left blank as an empty string.
- * @remarks
+ */
+export const BLANK_STRING: BlankString;
+/**
  * Property type: `string`
- * Constructor type: `string | undefined | null`
- * Default: `''`
+ * Constructor type: `string | null | undefined`
+ * Default: `""`
  */
-export declare const BLANK_STRING: BlankString;
 interface BlankString extends DocumentField<string> {
   type: typeof String;
   required: true;
@@ -273,12 +309,13 @@ interface BlankString extends DocumentField<string> {
 
 /**
  * A field used for integer sorting of a Document relative to its siblings
- * @remarks
+ */
+export const INTEGER_SORT_FIELD: IntegerSortField;
+/**
  * Property type: `number`
- * Constructor type: `number | undefined | null`
+ * Constructor type: `number | null | undefined`
  * Default: `0`
  */
-export declare const INTEGER_SORT_FIELD: IntegerSortField;
 interface IntegerSortField extends DocumentField<number> {
   type: typeof Number;
   required: true;
@@ -289,12 +326,13 @@ interface IntegerSortField extends DocumentField<number> {
 
 /**
  * A numeric timestamp field which may be used in a Document.
- * @remarks
+ */
+export const TIMESTAMP_FIELD: TimestampField;
+/**
  * Property type: `number | undefined`
- * Constructor type: `number | undefined | null`
- * Default: `Date.now`
+ * Constructor type: `number | null | undefined`
+ * Default: `Date.now()`
  */
-export declare const TIMESTAMP_FIELD: TimestampField;
 interface TimestampField extends DocumentField<number> {
   type: typeof Number;
   required: false;
@@ -311,12 +349,13 @@ declare function _validateId(id: string | null): boolean;
 
 /**
  * The standard identifier for a Document.
- * @remarks
+ */
+export const DOCUMENT_ID: DocumentId;
+/**
  * Property type: `string | null`
- * Constructor type: `string | undefined | null`
+ * Constructor type: `string | null | undefined`
  * Default: `null`
  */
-export declare const DOCUMENT_ID: DocumentId;
 interface DocumentId extends DocumentField<string | null> {
   type: typeof String;
   required: true;
@@ -328,17 +367,18 @@ interface DocumentId extends DocumentField<string | null> {
 
 /**
  * The standard permissions object which may be included by a Document.
- * @remarks
- * Property type: `Partial<Record<string, foundry.CONST.EntityPermission>>`
- * Constructor type: `Partial<Record<string, foundry.CONST.EntityPermission>> | undefined | null`
- * Default: `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
  */
-export declare const DOCUMENT_PERMISSIONS: DocumentPermissions;
-interface DocumentPermissions extends DocumentField<Partial<Record<string, foundry.CONST.EntityPermission>>> {
+export const DOCUMENT_PERMISSIONS: DocumentPermissions;
+/**
+ * Property type: `Partial<Record<string, DOCUMENT_PERMISSION_LEVELS>>`
+ * Constructor type: `Partial<Record<string, DOCUMENT_PERMISSION_LEVELS>> | null | undefined`
+ * Default: `{ default: DOCUMENT_PERMISSION_LEVELS.NONE }`
+ */
+interface DocumentPermissions extends DocumentField<Partial<Record<string, DOCUMENT_PERMISSION_LEVELS>>> {
   type: typeof Object;
   required: true;
   nullable: false;
-  default: { default: typeof CONST.ENTITY_PERMISSIONS.NONE };
+  default: { default: typeof DOCUMENT_PERMISSION_LEVELS.NONE };
   validate: typeof _validatePermissions;
   validationError: '{name} {field} "{value}" is not a mapping of user IDs and document permission levels';
 }
@@ -362,9 +402,22 @@ interface ForeignDocumentFieldOptions {
 /**
  * Create a foreign key field which references a primary Document id
  */
-export declare function foreignDocumentField<T extends ForeignDocumentFieldOptions>(
-  options: T
-): ForeignDocumentField<T>;
+export function foreignDocumentField<T extends ForeignDocumentFieldOptions>(options: T): ForeignDocumentField<T>;
+/**
+ * Default config:
+ * ```
+ * {
+ *   type: String,
+ *   required: false,
+ *   nullable: true,
+ *   default: null
+ * }
+ * ```
+ * With default config:
+ * Property type: `string | null`
+ * Constructor type: `ForeignDocument | string | null | undefined`
+ * Default: `null`
+ */
 interface ForeignDocumentField<T extends ForeignDocumentFieldOptions> extends DocumentField<string | null> {
   type: typeof String;
   required: T extends {
@@ -402,13 +455,30 @@ interface EmbeddedCollectionFieldOptions {
  * @param options  - Additional field options
  *                   (default: `{}`)
  */
-export declare function embeddedCollectionField<
+export function embeddedCollectionField<
   ConcreteDocumentConstructor extends { readonly documentName: string } & ConstructorOf<Document<any, any>>,
   Options extends EmbeddedCollectionFieldOptions
 >(
   document: ConcreteDocumentConstructor,
   options?: Options
 ): EmbeddedCollectionField<ConcreteDocumentConstructor, Options>;
+/**
+ * Default config:
+ * ```
+ * {
+ *   type: {
+ *     [documentName]: DocumentConstructor
+ *   },
+ *   required: true,
+ *   default: [],
+ *   isCollection: true
+ * }
+ * ```
+ * With default config:
+ * Property type: `EmbeddedCollection<DocumentConstructor, ParentDocumentData>`
+ * Constructor type: `DocumentConstructorData[] | null | undefined`
+ * Default: `new EmbeddedCollection(DocumentData, [], DocumentConstructor)`
+ */
 // TODO: Improve
 interface EmbeddedCollectionField<
   ConcreteDocumentConstructor extends ConstructorOf<Document<any, any>>,
@@ -420,10 +490,37 @@ interface EmbeddedCollectionField<
   isCollection: true;
 }
 
+/**
+ * A special field which contains a data object defined from the game System model.
+ * @param document - The Document class definition
+ */
+export function systemDataField<
+  DocumentSpecifier extends { readonly documentName: keyof Game.SystemData<any>['model'] }
+>(document: DocumentSpecifier): SystemDataField;
+/**
+ * Default config:
+ * ```
+ * {
+ *   type: Object,
+ *   required: true,
+ *   default: object // template object of object type from template.json
+ * }
+ * ```
+ * Property type: `object`
+ * Constructor type: `object | null | undefined`
+ * Default: `{}`
+ */
+// TODO: Improve
+interface SystemDataField extends DocumentField<any> {
+  type: typeof Object;
+  default: (data: { type?: string }) => Record<string, Record<string, unknown>>;
+  required: true;
+}
+
 /**
  * Return a document field which is a modification of a static field type
  */
-export declare function field<T extends DocumentField<any>, U extends Partial<DocumentField<any>>>(
+export function field<T extends DocumentField<any>, U extends Partial<DocumentField<any>>>(
   field: T,
   options?: U
 ): FieldReturnType<T, U>;

package/src/foundry/common/documents.mjs/baseActiveEffect.d.ts

@@ -1,7 +1,8 @@
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
 import { Document } from '../abstract/module.mjs';
 import * as data from '../data/data.mjs';
+import type { ActiveEffectDataConstructorData } from '../data/data.mjs/activeEffectData.js';
 import { BaseActor } from './baseActor';
 import { BaseItem } from './baseItem';
 import { BaseUser } from './baseUser';
@@ -13,27 +14,32 @@ export declare class BaseActiveEffect extends Document<
   data.ActiveEffectData,
   InstanceType<ConfiguredDocumentClass<typeof BaseActor>> | InstanceType<ConfiguredDocumentClass<typeof BaseItem>>
 > {
+  /** @override */
   static get schema(): ConstructorOf<data.ActiveEffectData>;
 
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
       name: 'ActiveEffect';
       collection: 'effects';
       label: 'DOCUMENT.ActiveEffect';
+      labelPlural: 'DOCUMENT.ActiveEffects';
       isEmbedded: true;
     }
   >;
 
+  /** @override */
   protected _preCreate(
-    data: ConstructorDataType<data.ActiveEffectData>,
+    data: ActiveEffectDataConstructorData,
     options: DocumentModificationOptions,
     user: BaseUser
   ): Promise<void>;
 
+  /** @override */
   testUserPermission(
     user: BaseUser,
-    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
+    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
     { exact }: { exact?: boolean }
   ): boolean;
 }

package/src/foundry/common/documents.mjs/baseActor.d.ts

@@ -1,24 +1,31 @@
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
 import { Document } from '../abstract/module.mjs';
+import * as data from '../data/data.mjs';
+import type { ActorDataConstructorData } from '../data/data.mjs/actorData.js';
 import { BaseActiveEffect } from './baseActiveEffect';
 import { BaseItem } from './baseItem';
-import * as data from '../data/data.mjs';
+import { BaseToken } from './baseToken';
 import { BaseUser } from './baseUser';
-import { ConstructorDataType } from '../../../types/helperTypes';
 
-//TODO Add Token as parent class once it is available
 /**
  * The base Actor model definition which defines common behavior of an Actor document between both client and server.
  */
-export declare class BaseActor extends Document<data.ActorData, Document<any, any>> {
+export declare class BaseActor extends Document<
+  data.ActorData,
+  InstanceType<ConfiguredDocumentClass<typeof BaseToken>>
+> {
+  /** @override */
   static get schema(): typeof data.ActorData;
 
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
       name: 'Actor';
       collection: 'actors';
       label: 'DOCUMENT.Actor';
+      labelPlural: 'DOCUMENT.Actors';
       embedded: {
         ActiveEffect: typeof BaseActiveEffect;
         Item: typeof BaseItem;
@@ -42,56 +49,21 @@ export declare class BaseActor extends Document<data.ActorData, Document<any, an
   get items(): this['data']['items'];
 
   /**
-   * Migrate the system data object to conform to data model defined by the current system version.
-   * @see mergeObject
-   * @param options - Options which customize how the system data is migrated.
-   * @returns The migrated system data object, not yet saved to the database
+   * The sub-type of Actor.
    */
-  migrateSystemData(options?: MigrateSystemDataOptions): object;
+  get type(): data.ActorData['type'];
 
-  /**
-   * Perform preliminary operations before a Document of this type is created.
-   * Pre-creation operations only occur for the client which requested the operation.
-   * @param data    - The initial data used to create the document
-   * @param options - Additional options which modify the creation request
-   * @param user    - The User requesting the document creation
-   */
+  /** @override */
   protected _preCreate(
-    data: ConstructorDataType<data.ActorData>,
+    data: ActorDataConstructorData,
     options: DocumentModificationOptions,
     user: BaseUser
   ): Promise<void>;
 
-  /**
-   * Perform preliminary operations before a Document of this type is updated.
-   * Pre-update operations only occur for the client which requested the operation.
-   * @param changed - The differential data that is changed relative to the documents prior values
-   * @param options - Additional options which modify the update request
-   * @param user    - The User requesting the document update
-   */
+  /** @override */
   protected _preUpdate(
-    changed: DeepPartial<ConstructorDataType<data.ActorData>>,
+    changed: DeepPartial<ActorDataConstructorData>,
     options: DocumentModificationOptions,
     user: BaseUser
   ): Promise<void>;
 }
-
-interface MigrateSystemDataOptions {
-  /**
-   * Retain keys which exist in the current data, but not the model
-   * @defaultValue `false`
-   */
-  insertKeys?: boolean;
-
-  /**
-   * Retain inner-object values which exist in the current data, but not the model
-   * @defaultValue `true`
-   */
-  insertValues?: boolean;
-
-  /**
-   * Require that data types match the model exactly to be retained
-   * @defaultValue `false`
-   */
-  enforceTypes?: boolean;
-}

package/src/foundry/common/documents.mjs/baseAdventure.d.ts

@@ -0,0 +1,38 @@
+import { DocumentMetadata } from '../abstract/document.mjs';
+import { Document } from '../abstract/module.mjs';
+import * as data from '../data/data.mjs';
+
+/**
+ * The base Adventure model definition which defines common behavior of an Adventure document between both client and server.
+ *
+ * WARNING: This document is an early prototype which will be fully implemented in V10.
+ * Until then it is for internal use only. Use this at your own risk.
+ * @internal
+ */
+export class BaseAdventure extends Document<data.AdventureData> {
+  /** @override */
+  static get schema(): typeof data.AdventureData;
+
+  /** @override */
+  static get metadata(): Merge<
+    DocumentMetadata,
+    {
+      name: 'Adventure';
+      collection: 'adventures';
+      label: 'DOCUMENT.Adventure';
+      labelPlural: 'DOCUMENT.Adventures';
+      isPrimary: false;
+      isEmbedded: false;
+    }
+  >;
+
+  /**
+   * A convenient reference to the file path of the Adventure's profile image.
+   */
+  get img(): string | null | undefined;
+
+  /**
+   * Provide a thumbnail image path used to represent the Adventure document.
+   */
+  get thumbnail(): string | null | undefined;
+}

package/src/foundry/common/documents.mjs/baseAmbientLight.d.ts

@@ -11,14 +11,17 @@ export declare class BaseAmbientLight extends Document<
   data.AmbientLightData,
   InstanceType<ConfiguredDocumentClass<typeof BaseScene>>
 > {
+  /** @override */
   static get schema(): typeof data.AmbientLightData;
 
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
       name: 'AmbientLight';
       collection: 'lights';
       label: 'DOCUMENT.AmbientLight';
+      labelPlural: 'DOCUMENT.AmbientLights';
       isEmbedded: true;
     }
   >;