Class SchemaField

A special class of foundry.data.fields.DataField which defines a data schema.

Hierarchy (View Summary)

DataField
- SchemaField

Constructors

constructor

new SchemaField(
    fields: DataSchema,
    options?: DataFieldOptions,
    context?: DataFieldContext,
): SchemaField
Parameters
- fields: DataSchema
  The contained field definitions
- Optionaloptions: DataFieldOptions
  Options which configure the behavior of the field
- Optionalcontext: DataFieldContext = {}
  Additional context which describes the field
Returns SchemaField
Overrides DataField.constructor

Properties

fields

fields: DataSchema

The contained field definitions.

`Internal`name

name: string | undefined

The field name of this DataField instance. This is assigned by SchemaField#initialize.

options

options: DataFieldOptions

The initially provided options which configure the data field

`Internal`parent

parent: any

A reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.

persisted

persisted: boolean = true

Is a value of this field written to source data? A Non-persisted value is initialized (with its initial value), and ActiveEffects can use the field for change application.

`Static`hierarchical

hierarchical: boolean = false

Whether this field defines part of a Document/Embedded Document hierarchy.

`Static`recursive

recursive: boolean = true

Accessors

fieldPath

get fieldPath(): string
A dot-separated string representation of the field path within the parent schema.

Returns string
Inherited from DataField.fieldPath

`Static`_defaults

get _defaults(): DataFieldOptions & { nullable: boolean; required: boolean }
Default parameters for this field type

Returns DataFieldOptions & { nullable: boolean; required: boolean }
Overrides DataField._defaults

`Static`hasFormSupport

get hasFormSupport(): boolean
Does this form field class have defined form support?

Returns boolean
Inherited from DataField.hasFormSupport

Methods

_applyChangeAdd

_applyChangeAdd(value: any, delta: any, model: any, change: any): any
Parameters
- value: any
- delta: any
- model: any
- change: any
Returns any
Overrides DataField._applyChangeAdd

_cast

_cast(value: any): any
Parameters
- value: any
Returns any
Overrides DataField._cast

_cleanType

_cleanType(data: any, options: any, _state: any): any
Apply any cleaning logic specific to this DataField type.
Parameters
- data: any
  A candidate value that has been cast to the appropriate type
- options: any
  Options for how the field is cleaned
- _state: any
  Internal state variables which are used during recursion
Returns any
The cleaned value

Overrides DataField._cleanType

_getField

_getField(
parts: any,
__namedParameters?: {},
): DataField | SchemaField | undefined
Parameters
- parts: any
- __namedParameters: {} = {}
Returns DataField | SchemaField | undefined
Overrides DataField._getField

_updateCommit

_updateCommit(source: any, key: any, value: any, diff: any, options: any): void
Parameters
- source: any
- key: any
- value: any
- diff: any
- options: any
Returns void
Overrides DataField._updateCommit

_updateDiff

_updateDiff(key: any, value: any, options: any, state: any): void
Internal
Update the source data for a DataModel which includes this DataField. Updates are performed depth-first; validated and recorded from leaf-nodes upwards.

This method is responsible for preparing and validating the requested update. If the update is valid, it is responsible for updating the pending source copy and recording the diff. If the update is invalid it must avoid recording a diff or staging an update to the source copy. If validation fails, this workflow may optionally permit fallback to a valid initial value.
```
                                 a partial node of source data, relative to which this field belongs.
```
Parameters
- key: any
  The name of this field within the context of the source data.
- value: any
  The candidate value that should be applied as an update.
- options: any
  Options which modify how this update workflow is performed.
- state: any
  Stateful data that is transacted throughout the model hierarchy during an update operation.
Returns void
Throws
An error if the requested update cannot be performed.

Overrides DataField._updateDiff

_validateModel

_validateModel(changes: any, options?: {}): void
Parameters
- changes: any
- options: {} = {}
Returns void
Overrides DataField._validateModel

_validateRecursive

_validateRecursive(data: any, options: any): void
Parameters
- data: any
- options: any
Returns void
Overrides DataField._validateRecursive

_validateType

_validateType(data: any, options?: {}): void
Parameters
- data: any
- options: {} = {}
Returns void
Overrides DataField._validateType

[iterator]

"[iterator]"(): Generator<any, void, unknown>
Iterate over a SchemaField by iterating over its fields.

Returns Generator<any, void, unknown>
Yields

apply

apply(fn: any, data?: {}, options?: {}): {}
Parameters
- fn: any
- data: {} = {}
- options: {} = {}
Returns {}
Overrides DataField.apply

applyChange

applyChange<T>(
    value: T,
    model: DataModel,
    change: ActiveEffectChangeData,
    options?: { replacementData?: Record<string, unknown> },
): T
Apply an ActiveEffectChange to this field.
Type Parameters
- T
Parameters
- value: T
  The field's current value.
- model: DataModel
  The model instance.
- change: ActiveEffectChangeData
  The change to apply.
- options: { replacementData?: Record<string, unknown> } = {}
  Additional options to configure the change application.
  - OptionalreplacementData?: Record<string, unknown>
    Data used to resolve "@" expressions.
Returns T
The updated value.

Inherited from DataField.applyChange

clean

clean(
    value: any,
    options?: Readonly<DataModelCleaningOptions>,
    _state?: data.types.DataModelUpdateState,
): any
Preprocess and clean source data to ensure that it conforms to the correct data type for this field and is ready to be used by data model construction or update operations. Data cleaning is synchronous and automatically applied as the first step of construction and update operations.
Parameters
- value: any
  An initial requested value
- Optionaloptions: Readonly<DataModelCleaningOptions> = {}
  Additional options for how the field is cleaned
- Optional_state: data.types.DataModelUpdateState = {}
  Internal state variables which are used during recursion
Returns any
The cleaned value

Inherited from DataField.clean

entries

entries(): [string, DataField][]
An array of [name, DataField] tuples which define the schema.

Returns [string, DataField][]

extendFields

extendFields(fields: DataSchema): void
Extend this schema definition with additional fields.
Parameters
- fields: DataSchema
  The additional fields.
Returns void

get

get(fieldName: string): void | DataField
Get a DataField instance from the schema by name.
Parameters
- fieldName: string
  The field name
Returns void | DataField
The DataField instance or undefined

getField

getField(
pathOrKey: string | string[],
options?: { source?: object },
): DataField | undefined
Traverse the schema, obtaining the DataField definition for a particular field.
Parameters
- pathOrKey: string | string[]
  A field path or property key if options.source is given. Examples: ["abilities", "strength"] or "abilities.strength".
- Optionaloptions: { source?: object } = {}
  Additional options
  - Optionalsource?: object
    The (partial) source data of the field
Returns DataField | undefined
The corresponding DataField definition for that field, or undefined

getInitialValue

getInitialValue(source: any): any
Parameters
- source: any
Returns any
Overrides DataField.getInitialValue

has

has(fieldName: string): boolean
Test whether a certain field name belongs to this schema definition.
Parameters
- fieldName: string
  The field name
Returns boolean
Does the named field exist in this schema?

initialize

initialize(value: any, model: any, options?: {}): any
Parameters
- value: any
- model: any
- options: {} = {}
Returns any
Overrides DataField.initialize

keys

keys(): string[]
An array of field names which are present in the schema.

Returns string[]

removeFields

removeFields(fields: string[]): void
Remove fields from this schema definition.
Parameters
- fields: string[]
  The fields to remove.
Returns void

toFormGroup

toFormGroup(
groupConfig?: FormGroupConfig,
inputConfig?: FormInputConfig,
): HTMLDivElement
Render this DataField as a standardized form-group element.
Parameters
- groupConfig: FormGroupConfig = {}
  Configuration options passed to the wrapping form-group
- inputConfig: FormInputConfig = {}
  Input element configuration options passed to DataField#toInput
Returns HTMLDivElement
The rendered form group element

Inherited from DataField.toFormGroup

toInput

toInput(config?: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Render this DataField as an HTML element.
Parameters
- config: FormInputConfig = {}
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from DataField.toInput

toObject

toObject(value: any): any
Parameters
- value: any
Returns any
Overrides DataField.toObject

validate

validate(
value: any,
options?: DataFieldValidationOptions,
): void | DataModelValidationFailure
Validate candidate input for this field, ensuring it meets the field requirements.

This public method validates recursively, testing both the immediate value of this field as well as the validity of any child values for fields with hierarchical data types.
Parameters
- value: any
  The candidate value to validate
- Optionaloptions: DataFieldValidationOptions = {}
  Options which affect validation behavior
Returns void | DataModelValidationFailure
A failure that occurred if validation is non-strict. The failure may have been resolved by fallback or dropping invalid elements.

Throws
A failure error type including details of the failure if validation is performed strictly.

Inherited from DataField.validate

validators

validators(
options?: Pick<DataFieldValidationOptions, "recursive" | "phase">,
): Generator<DataFieldValidator, void, unknown>
Iterate over validation functions applied to this field. Validation happens in a depth-first way, for example consider an outerSchema with an innerField:
Parameters
- options: Pick<DataFieldValidationOptions, "recursive" | "phase"> = {}
Returns Generator<DataFieldValidator, void, unknown>
Example: Validator Invocation Order
```
outerSchema
  _validateSpecial
  _validateType
  _validateRecursive
  outerSchema.options.validate
    innerField
      _validateSpecial
      _validateType
      innerField.options.validate
      _validateModel
  _validateModel
```
Yields
Inherited from DataField.validators

values

values(): DataField[]
An array of DataField instances which are present in the schema.

Returns DataField[]

`Protected`_applyChangeCustom

_applyChangeCustom(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a custom change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeCustom

`Protected`_applyChangeDowngrade

_applyChangeDowngrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "downgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeDowngrade

`Protected`_applyChangeMultiply

_applyChangeMultiply(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "multiply" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeMultiply

`Protected`_applyChangeOverride

_applyChangeOverride(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "override" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeOverride

`Protected`_applyChangeSubtract

_applyChangeSubtract(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "subtract" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeSubtract

`Protected`_applyChangeUpgrade

_applyChangeUpgrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "upgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeUpgrade

`Protected`_castChangeDelta

_castChangeDelta(delta: any, replacementData?: object): any
Protected
Cast a change delta into an appropriate type to be applied to this field.
Parameters
- delta: any
  The change delta.
- replacementData: object = {}
  Data used to resolve "@" expressions.
Returns any
Inherited from DataField._castChangeDelta

`Protected`_initialize

_initialize(fields: DataSchema): DataSchema
Protected
Initialize and validate the structure of the provided field definitions.
Parameters
- fields: DataSchema
  The provided field definitions
Returns DataSchema
The validated schema

`Protected`_migrate

_migrate(
    value: any,
    options?: Readonly<DataModelCleaningOptions>,
    _state?: data.types.DataModelUpdateState,
): any
Protected
Migrate this field's candidate source data. This workflow occurs as a component step of DataField#clean.
Parameters
- value: any
  Candidate source value for the field
- Optionaloptions: Readonly<DataModelCleaningOptions>
  Options for how the field is cleaned
- Optional_state: data.types.DataModelUpdateState
  Internal state variables transacted during cleaning recursion.
Returns any
A migrated value suitable for cleaning

Inherited from DataField._migrate

`Protected`_replaceDataRefs

_replaceDataRefs(
    raw: string,
    data: Record<string, unknown>,
    options?: { strict?: boolean },
): string
Protected
Recursively replace data references in a string change value.
Parameters
- raw: string
- data: Record<string, unknown>
  An object providing replacements
- Optionaloptions: { strict?: boolean } = {}
  Additional options to configure the data replacement
  - Optionalstrict?: boolean
    Throw an Error if data replacement fails
Returns string
The expression with data references resolved

Inherited from DataField._replaceDataRefs

`Protected`_toInput

_toInput(config: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Protected
Render this DataField as an HTML element. Subclasses should implement this method rather than the public toInput method which wraps it.
Parameters
- config: FormInputConfig
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from DataField._toInput

`Protected`_validateSpecial

_validateSpecial(value: any): boolean | void
Protected
Special validation rules which supersede regular field validation. This validator screens for certain values which are otherwise incompatible with this field like null or undefined.
Parameters
- value: any
  The candidate value
Returns boolean | void
A boolean to indicate with certainty whether the value is valid

Throws
An error with a specific reason the value is invalid

Inherited from DataField._validateSpecial

`Static`_handleValidationFailure

_handleValidationFailure(
    field: DataField,
    data: object,
    key: string,
    parentFailure: DataModelValidationFailure,
    fieldFailure: DataModelValidationFailure,
    options: DataModelValidationOptions,
): void
Internal
An internal helper function that attempts fallback to a valid initial value in the case of validation failure.
Parameters
- field: DataField
  The child data field being handled
- data: object
  Data attempted for validation at the parent level
- key: string
  The key of this field being validated
- parentFailure: DataModelValidationFailure
  The validation failure at the parent level
- fieldFailure: DataModelValidationFailure
  The validation failure at this field level
- options: DataModelValidationOptions
  Handling options
Returns void

`Static`expandObject

expandObject(
    data: object,
    options: DataModelCleaningOptions,
    _state: data.types.DataModelUpdateState,
): void
Expand a transacted object.
Parameters
- data: object
  The object.
- options: DataModelCleaningOptions
  Cleaning operation options.
- _state: data.types.DataModelUpdateState
  Cleaning operation state.
Returns void

`Static`reconstructOperator

reconstructOperator(data: object, k: string, v: any): void
When iterating over the keys and values of an object, reconstruct serialized DataFieldOperator values.
Parameters
- data: object
- k: string
- v: any
Returns void

Class SchemaField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SchemaField

Properties

fields

Internalname

options

Internalparent

persisted

Statichierarchical

Staticrecursive

Accessors

fieldPath

Returns string

Static_defaults

Returns DataFieldOptions & { nullable: boolean; required: boolean }

StatichasFormSupport

Returns boolean

Methods

_applyChangeAdd

Parameters

Returns any

_cast

Parameters

Returns any

_cleanType

Parameters

Returns any

_getField

Parameters

Returns DataField | SchemaField | undefined

_updateCommit

Parameters

Returns void

_updateDiff

Parameters

Returns void

Throws

_validateModel

Parameters

Returns void

_validateRecursive

Parameters

Returns void

_validateType

Parameters

Returns void

[iterator]

Returns Generator<any, void, unknown>

Yields

apply

Parameters

Returns {}

applyChange

Type Parameters

Parameters

OptionalreplacementData?: Record<string, unknown>

Returns T

clean

Parameters

Returns any

entries

Returns [string, DataField][]

extendFields

Parameters

Returns void

get

Parameters

Returns void | DataField

getField

Parameters

Optionalsource?: object

`Internal`name

`Internal`parent

`Static`hierarchical

`Static`recursive

`Static`_defaults

`Static`hasFormSupport

`Optional`replacementData?: Record<string, unknown>

`Optional`source?: object

`Protected`_applyChangeCustom

`Protected`_applyChangeDowngrade

`Protected`_applyChangeMultiply

`Protected`_applyChangeOverride

`Protected`_applyChangeSubtract

`Protected`_applyChangeUpgrade

`Protected`_castChangeDelta

`Protected`_initialize

`Protected`_migrate

`Protected`_replaceDataRefs

`Optional`strict?: boolean

`Protected`_toInput