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

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

@@ -1,526 +0,0 @@
-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.
- */
-export const BOOLEAN_FIELD: BooleanField;
-/**
- * Property type: `boolean`
- * Constructor type: `boolean | null | undefined`
- * Default: `false`
- */
-interface BooleanField extends DocumentField<boolean> {
-  type: typeof Boolean;
-  required: true;
-  default: false;
-}
-
-/**
- * A standard string color field which may be used in a Document.
- */
-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;
-  nullable: true;
-  validate: typeof isColorString;
-  validationError: '{name} {field} "{value}" is not a valid hexadecimal color string';
-}
-
-/**
- * A standard string field for an image file path which may be used in a Document.
- */
-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;
-  nullable: true;
-  validate: typeof hasImageExtension;
-  validationError: '{name} {field} "{value}" does not have a valid image file extension';
-}
-
-/**
- * A standard string field for a video or image file path may be used in a Document.
- */
-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;
-  nullable: true;
-  validate: (src: string | null) => boolean;
-  validationError: '{name} {field} "{value}" does not have a valid image or video file extension';
-}
-
-/**
- * A standard string field for an audio file path which may be used in a Document.
- */
-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;
-  nullable: true;
-  validate: (src: string | null) => boolean;
-  validationError: '{name} {field} "{value}" does not have a valid audio file extension';
-}
-
-/**
- * A standard integer field which may be used in a Document.
- */
-export const INTEGER_FIELD: IntegerField;
-/**
- * Property type: `number | undefined`
- * Constructor type: `number | null | undefined`
- */
-interface IntegerField extends DocumentField<number> {
-  type: typeof Number;
-  required: false;
-  validate: typeof Number.isInteger;
-  validationError: '{name} {field} "{value}" does not have an integer value';
-}
-
-/**
- * A string field which contains serialized JSON data that may be used in a Document.
- */
-export const JSON_FIELD: JsonField;
-/**
- * Property type: `string | undefined`
- * Constructor type: `string | object | null | undefined`
- */
-interface JsonField extends DocumentField<string> {
-  type: typeof String;
-  required: false;
-  clean: (s: unknown) => string;
-  validate: typeof isJSON;
-  validationError: '{name} {field} "{value}" is not a valid JSON string';
-}
-
-/**
- * A non-negative integer field which may be used in a Document.
- */
-export const NONNEGATIVE_INTEGER_FIELD: NonnegativeIntegerField;
-/**
- * Property type: `number | undefined`
- * Constructor type: `number | null | undefined`
- */
-interface NonnegativeIntegerField extends DocumentField<number> {
-  type: typeof Number;
-  required: false;
-  validate: (n: unknown) => boolean;
-  validationError: '{name} {field} "{value}" does not have an non-negative integer value';
-}
-
-/**
- * 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.
- */
-export const POSITIVE_INTEGER_FIELD: PositiveIntegerField;
-/**
- * Property type: `number | undefined`
- * Constructor type: `number | null | undefined`
- */
-interface PositiveIntegerField extends DocumentField<number> {
-  type: typeof Number;
-  required: false;
-  validate: (n: unknown) => boolean;
-  validationError: '{name} {field} "{value}" does not have an non-negative integer value';
-}
-
-/**
- * A template for a required inner-object field which may be used in a Document.
- */
-export const OBJECT_FIELD: ObjectField;
-/**
- * Property type: `object`
- * Constructor type: `object | null | undefined`
- * Default `{}`
- */
-interface ObjectField extends DocumentField<object> {
-  type: typeof Object;
-  default: Record<string, never>;
-  required: true;
-}
-
-/**
- * An optional string field which may be included by a Document.
- */
-export const STRING_FIELD: StringField;
-/**
- * Property type: `string | undefined`
- * Constructor type: `string | null | undefined`
- */
-interface StringField extends DocumentField<string> {
-  type: typeof String;
-  required: false;
-  nullable: false;
-}
-
-/**
- * An optional numeric field which may be included in a Document.
- */
-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;
-  nullable: true;
-}
-
-/**
- * A required numeric field which may be included in a Document and may not be null.
- */
-export const REQUIRED_NUMBER: RequiredNumber;
-/**
- * Property type: `number`
- * Constructor type: `number | null | undefined`
- * Default: `0`
- */
-interface RequiredNumber extends DocumentField<number> {
-  type: typeof Number;
-  required: true;
-  nullable: false;
-  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.
- */
-export const REQUIRED_POSITIVE_NUMBER: RequiredPositiveNumber;
-/**
- * Property type: `number`
- * Constructor type: `number`
- */
-interface RequiredPositiveNumber extends DocumentField<number> {
-  type: typeof Number;
-  required: true;
-  nullable: false;
-  validate: (n: unknown) => boolean;
-  validationError: '{name} {field} "{value}" is not a positive number';
-}
-
-/**
- * A required numeric field which represents an angle of rotation in degrees between 0 and 360.
- */
-export const ANGLE_FIELD: AngleField;
-/**
- * Property type: `number`
- * Constructor type: `number | null | undefined`
- * Default: `360`
- */
-interface AngleField extends DocumentField<number> {
-  type: typeof Number;
-  required: true;
-  nullable: false;
-  default: 360;
-  clean: (n: unknown) => number;
-  validate: (n: number) => boolean;
-  validationError: '{name} {field} "{value}" is not a number between 0 and 360';
-}
-
-/**
- * A required numeric field which represents a uniform number between 0 and 1.
- */
-export const ALPHA_FIELD: AlphaField;
-/**
- * Property type: `number`
- * Constructor type: `number | null | undefined`
- * Default: `1`
- */
-interface AlphaField extends DocumentField<number> {
-  type: typeof Number;
-  required: true;
-  nullable: false;
-  default: 1;
-  validate: (n: number) => boolean;
-  validationError: '{name} {field} "{value}" is not a number between 0 and 1';
-}
-
-/**
- * A string field which requires a non-blank value and may not be null.
- */
-export const REQUIRED_STRING: RequiredString;
-/**
- * Property type: `string`
- * Constructor type: `string`
- */
-interface RequiredString extends DocumentField<string> {
-  type: typeof String;
-  required: true;
-  nullable: false;
-  clean: <T>(v: T) => T extends undefined ? undefined : string;
-}
-
-/**
- * A string field which is required, but may be left blank as an empty string.
- */
-export const BLANK_STRING: BlankString;
-/**
- * Property type: `string`
- * Constructor type: `string | null | undefined`
- * Default: `""`
- */
-interface BlankString extends DocumentField<string> {
-  type: typeof String;
-  required: true;
-  nullable: false;
-  clean: (v: unknown) => string;
-  default: '';
-}
-
-/**
- * A field used for integer sorting of a Document relative to its siblings
- */
-export const INTEGER_SORT_FIELD: IntegerSortField;
-/**
- * Property type: `number`
- * Constructor type: `number | null | undefined`
- * Default: `0`
- */
-interface IntegerSortField extends DocumentField<number> {
-  type: typeof Number;
-  required: true;
-  default: 0;
-  validate: typeof Number.isInteger;
-  validationError: '{name} {field} "{value}" is not an integer';
-}
-
-/**
- * A numeric timestamp field which may be used in a Document.
- */
-export const TIMESTAMP_FIELD: TimestampField;
-/**
- * Property type: `number | undefined`
- * Constructor type: `number | null | undefined`
- * Default: `Date.now()`
- */
-interface TimestampField extends DocumentField<number> {
-  type: typeof Number;
-  required: false;
-  default: typeof Date.now;
-  nullable: false;
-}
-
-/**
- * Validate that the ID of a Document object is either null (not yet saved) or a valid string.
- * @param id - The _id to test
- * @returns Is it valid?
- */
-declare function _validateId(id: string | null): boolean;
-
-/**
- * The standard identifier for a Document.
- */
-export const DOCUMENT_ID: DocumentId;
-/**
- * Property type: `string | null`
- * Constructor type: `string | null | undefined`
- * Default: `null`
- */
-interface DocumentId extends DocumentField<string | null> {
-  type: typeof String;
-  required: true;
-  default: null;
-  nullable: false;
-  validate: typeof _validateId;
-  validationError: '{name} {field} "{value}" is not a valid document ID string';
-}
-
-/**
- * The standard permissions object which may be included by a Document.
- */
-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 DOCUMENT_PERMISSION_LEVELS.NONE };
-  validate: typeof _validatePermissions;
-  validationError: '{name} {field} "{value}" is not a mapping of user IDs and document permission levels';
-}
-
-/**
- * Validate the structure of the permissions object: all keys are valid IDs and all values are permission levels
- * @param perms - The provided permissions object
- * @returns Is the object valid?
- */
-declare function _validatePermissions(perms: object): boolean;
-
-interface ForeignDocumentFieldOptions {
-  type: {
-    readonly documentName: string;
-  };
-  required?: boolean;
-  nullable?: boolean;
-  default?: any;
-}
-
-/**
- * Create a foreign key field which references a primary Document id
- */
-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 {
-    required: true;
-  }
-    ? true
-    : false;
-  nullable: T extends {
-    nullable?: true;
-  }
-    ? true
-    : T extends {
-        nullable: false;
-      }
-    ? false
-    : boolean;
-  default: T extends {
-    default: infer U;
-  }
-    ? U
-    : null;
-  clean: (d: unknown) => string | null;
-  validate: typeof _validateId;
-  validationError: `{name} {field} "{value}" is not a valid ${T['type']['documentName']} id`;
-}
-
-interface EmbeddedCollectionFieldOptions {
-  required?: boolean;
-  default?: any[];
-}
-
-/**
- * Create a special field which contains a Collection of embedded Documents
- * @param document - The Document class definition
- * @param options  - Additional field options
- *                   (default: `{}`)
- */
-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>>,
-  Options extends EmbeddedCollectionFieldOptions = {}
-> extends DocumentField<any> {
-  type: Partial<Record<string, ConcreteDocumentConstructor>>;
-  required: Options extends { required?: true } ? true : Options extends { required: false } ? false : boolean;
-  default: Options extends { default?: Array<infer U> } ? Array<U> : unknown[];
-  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 function field<T extends DocumentField<any>, U extends Partial<DocumentField<any>>>(
-  field: T,
-  options?: U
-): FieldReturnType<T, U>;

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

@@ -1,3 +0,0 @@
-export * as validators from './validators.mjs';
-export * as fields from './fields.mjs';
-export * from './data.mjs';

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

@@ -1,56 +0,0 @@
-/**
- * Test whether a string is a valid 16 character UID
- */
-export declare function isValidId(id: string | null): boolean;
-
-/**
- * Test whether a file path has an extension in a list of provided extensions
- */
-export declare function _hasFileExtension(path: string | null, extensions: string[]): boolean;
-
-/**
- * Test whether a file path has a valid image file extension or is base64 PNG data
- * @param path - The image path to test
- * @returns Is the path valid?
- */
-export function hasImageExtension(path: string | null): boolean;
-/**
- * Test whether a data blob represents a base64 image
- * @param data - A base64 data string
- * @returns Is it a base64 image?
- */
-export declare function isBase64Image(data: string): boolean;
-
-/**
- * Test whether an input represents a valid 6-character color string
- * @param color - The input string to test
- * @returns Is the string a valid color?
- */
-export declare function isColorString(color: string): boolean;
-/**
- * Test whether a file path has a valid audio file extension
- * @param path - The image path to test
- * @returns Is the path valid?
- */
-export declare function hasVideoExtension(path: string | null): boolean;
-
-/**
- * Test whether a file path has a valid video file extension
- * @param path - The image path to test
- * @returns Is the path valid?
- */
-export declare function hasAudioExtension(path: string | null): boolean;
-/**
- * Assert that the given value is in an array of allowed options
- * @param val   - The value to test
- * @param array - The set of allowed options
- * @returns Is the valid included?
- */
-export declare function valueInArray<T>(val: T, array: T[]): boolean;
-
-/**
- * Assert that the given value parses as a valid JSON string
- * @param val - The value to test
- * @returns Is the String valid JSON?
- */
-export declare function isJSON(val: string): boolean;

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

@@ -1,44 +0,0 @@
-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 { ActiveEffectDataConstructorData } from '../data/data.mjs/activeEffectData';
-import { BaseActor } from './baseActor';
-import { BaseItem } from './baseItem';
-import { BaseUser } from './baseUser';
-
-type ActiveEffectMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'ActiveEffect';
-    collection: 'effects';
-    label: 'DOCUMENT.ActiveEffect';
-    labelPlural: 'DOCUMENT.ActiveEffects';
-    isEmbedded: true;
-  }
->;
-
-/**
- * The base ActiveEffect model definition which defines common behavior of an ActiveEffect document between both client and server.
- */
-export declare class BaseActiveEffect extends Document<
-  data.ActiveEffectData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseActor>> | InstanceType<ConfiguredDocumentClass<typeof BaseItem>>,
-  ActiveEffectMetadata
-> {
-  static override get schema(): ConstructorOf<data.ActiveEffectData>;
-
-  static override get metadata(): ActiveEffectMetadata;
-
-  protected override _preCreate(
-    data: ActiveEffectDataConstructorData,
-    options: DocumentModificationOptions,
-    user: BaseUser
-  ): Promise<void>;
-
-  override testUserPermission(
-    user: BaseUser,
-    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,68 +0,0 @@
-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';
-import { BaseActiveEffect } from './baseActiveEffect';
-import { BaseItem } from './baseItem';
-import { BaseToken } from './baseToken';
-import { BaseUser } from './baseUser';
-
-type ActorMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Actor';
-    collection: 'actors';
-    label: 'DOCUMENT.Actor';
-    labelPlural: 'DOCUMENT.Actors';
-    embedded: {
-      ActiveEffect: typeof BaseActiveEffect;
-      Item: typeof BaseItem;
-    };
-    isPrimary: true;
-    hasSystemData: true;
-    permissions: {
-      create: 'ACTOR_CREATE';
-    };
-    types: string[];
-  }
->;
-
-/**
- * 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,
-  InstanceType<ConfiguredDocumentClass<typeof BaseToken>>,
-  ActorMetadata
-> {
-  static override get schema(): typeof data.ActorData;
-
-  static override get metadata(): ActorMetadata;
-  /*
-   * A reference to the Collection of embedded ActiveEffect instances in the Actor document, indexed by _id.
-   */
-  get effects(): this['data']['effects'];
-
-  /**
-   * A reference to the Collection of embedded Item instances in the Actor document, indexed by _id.
-   */
-  get items(): this['data']['items'];
-
-  /**
-   * The sub-type of Actor.
-   */
-  get type(): data.ActorData['type'];
-
-  protected override _preCreate(
-    data: ActorDataConstructorData,
-    options: DocumentModificationOptions,
-    user: BaseUser
-  ): Promise<void>;
-
-  protected override _preUpdate(
-    changed: DeepPartial<ActorDataConstructorData>,
-    options: DocumentModificationOptions,
-    user: BaseUser
-  ): Promise<void>;
-}