Source data for the package
Optionaloptions: object = {}Options which affect DataModel construction
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
Internal_An array of top-level manifest keys that were provided which are not supported by the schema.
An availability code in PACKAGE_AVAILABILITY_CODES which defines whether this package can be used.
A flag which tracks whether this package is a free Exclusive pack
A flag which tracks if this package has files stored in the persistent storage folder
A flag which tracks whether this package is currently locked.
A flag which tracks whether this package is owned, if it is protected.
An immutable reverse-reference to a parent DataModel to which this model belongs.
A set of Tags that indicate what kind of Package this is, provided by the Website
Static Internal_The defined and cached Data Schema for all instances of this DataModel.
StaticiconThe default icon used for this type of Package.
StaticLOCALIZATION_StatictypeIs this Package incompatible with the currently installed core Foundry VTT software version?
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
Define the data schema for this document instance.
The type of this package instance. A value in CONST.PACKAGE_TYPES.
A flag which defines whether this package is unavailable to be used.
An array of validation failure instances which may have occurred when this instance was last validated.
StaticcollectionThe named collection to which this package type belongs
StaticschemaThe Data Schema for all instances of this DataModel.
InternalTest that the dependencies of a package are satisfied as compatible. This method assumes that all packages in modulesCollection have already had their own availability tested.
A collection which defines the set of available modules
Are all required dependencies satisfied?
InternalTest compatibility of a package's supported systems.
A collection which defines the set of available systems.
True if all supported systems which are currently installed are compatible or if the package has no supported systems. Returns false otherwise, or if no supported systems are installed.
Clone a model, creating a new data model by combining current data with provided overrides.
Optionaldata: object = {}Additional data which overrides current document data at the time of creation
Optionalcontext: DataModelConstructionContext = {}Context options passed to the data model constructor
The cloned instance
Traverse the data model instance, obtaining the DataField definition for a field of a particular property.
A property key like ["abilities", "strength"] or "abilities.strength"
The corresponding DataField definition for that field, or undefined
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
Extract the source data for the DataModel into a simple object format that can be serialized.
The document source data expressed as a plain object
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
Optionalsource: boolean = trueDraw values from the underlying data source rather than transformed values
The extracted primitive object
Update the DataModel locally by applying an object of changes to its source data. The provided changes are expanded, cleaned, validated, and stored to the source data object for this model. The provided changes argument is mutated in this process. The source data is then re-initialized to apply those changes to the prepared data. The method returns an object of differential changes which modified the original data.
New values which should be applied to the data model
Options which determine how the new data is merged
An object containing differential keys and values that were changed
Validate the data contained in the document to check for type and content. This method is intended to validate complete model records, verifying both individual field validation as well as joint model validity.
For validating sets of partial model changes, it is preferred to call DataModel#updateSource as a dryRun. This
method provides a convenience alias for such a workflow if changes are provided.
Warning: if fallback handling is allowed, this process will mutate provided changes or model source data.
Options which modify how the model is validated
Whether the data source or proposed change is reported as valid. A boolean is always returned if validation is non-strict.
Protected_ProtectedConfigure the data model instance before validation and initialization workflows are performed.
Optionaloptions: object = {}Additional options modifying the configuration
Protected_ProtectedA generator that orders the DataFields in the DataSchema into an expected initialization order.
Protected_ProtectedInitialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Optionaloptions: object = {}Options provided to the model constructor
Protected_ProtectedPrepare the state object that is transacted through an updateSource operation.
New values which should be applied to the data model
Options which determine how the new data is merged
Data model update state
Protected_ProtectedPerform the second step of the DataModel#_updateSource workflow which applies the prepared diff to the model.
The prepared copy of source data with changes applied
The differential changes that were applied to source
Options which determine how the new data is merged
Data cleaning state which might include instructions for final commit
Protected_ProtectedPerform the first step of the DataModel#_updateSource workflow which applies changes to a copy of model source data and records the resulting diff.
A mutable copy of model source data
New values which should be applied to the data model
Options which determine how the new data is merged
Data cleaning state
The resulting difference applied to source data
Static_Static_InternalA wrapper around the default compatibility warning logger which handles some package-specific interactions.
The package ID being logged
The warning or error being logged
Logging options passed to foundry.utils.logCompatibilityWarning
Optionalinstalled?: objectIs the package installed?
Static_InternalMigrate to v13-schema styles array from string array
StaticcleanClean a data source object to conform to a specific provided schema.
Optionaldata: object = {}Provided model data that requires cleaning
Optionaloptions: DataModelCleaningOptions = {}Options that configure how data cleaning is performed
Optional_state: Partial<data.types.DataModelUpdateState> = {}Internal options used during cleaning recursion
Cleaned data which is suitable for validation and usage
StaticdefineDefine the data schema for models of this type. The schema is populated the first time it is accessed and cached for future reuse.
The schema, through its fields, provide the essential cleaning, validation, and initialization methods to turn the _source values into direct properties of the data model. The schema is a static property of the model and is reused by all instances to perform validation.
The schemas defined by the core software in classes like foundry.documents.BaseActor are validated by the
server, where user code does not run. However, almost all documents have a flags field to store data, and many
have a system field that can be configured to be a foundry.abstract.TypeDataModel instance. Those models
are not constructed on the server and rely purely on client-side code, which means certain extra-sensitive fields
must be also be registered through your package manifest. foundry.packages.types.ServerSanitizationFields
class SomeModel extends foundry.abstract.DataModel {
static defineSchema() {
return {
foo: new foundry.data.fields.StringField()
}
}
}
class AnotherModel extends SomeModel {
static defineSchema() {
// Inheritance and object oriented principles apply to schema definition
const schema = super.defineSchema()
schema.bar = new foundry.data.fields.NumberField()
return schema;
}
}
StaticfromCreate a DataModel instance using a provided serialized JSON string.
Serialized document data in string format
A constructed data model instance
StaticfromRetrieve the latest Package manifest from a provided remote location.
A remote manifest URL to load
Additional options which affect package construction
Optionalstrict?: booleanWhether to construct the remote package strictly
A Promise which resolves to a constructed ServerPackage instance
StaticfromCreate a new instance of this DataModel from a source record. The source data is presumed trustworthy and is not strictly validated unless explicitly requested.
Initial document data which comes from a trusted source.
Optionalcontext: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions = {}Model construction context
StaticisTest if a given availability is incompatible with the core version.
The availability value to test.
StaticmigrateMigrate candidate source data for this DataModel which may require initial cleaning or transformations.
Candidate source data for the module, before further cleaning
Additional options for how the field is cleaned
Migrated source data, ready for further cleaning
StaticmigrateWrap data migration in a try/catch which attempts it safely.
Candidate source data for the module, before further cleaning
Optionaloptions: Readonly<DataModelCleaningOptions> = {}Additional options for how the field is cleaned
Migrated source data, ready for further cleaning
StaticshimTake data which conforms to the current data schema and add backwards-compatible accessors to it in order to support older code which uses this data.
Data which matches the current schema
Optionaloptions: { embedded?: boolean } = {}Additional shimming options
Optionalembedded?: booleanApply shims to embedded models?
Data with added backwards-compatible properties, which is the same object as
the data argument
StatictestCheck the given compatibility data against the current installation state and determine its availability.
The compatibility data to test.
Optionaloptions: { release?: any } = {}Optionalrelease?: anyA specific software release for which to test availability. Tests against the current release by default.
StatictestDetermine if a dependency is within the given compatibility range.
The compatibility range declared for the dependency, if any
The known dependency package
Is the dependency compatible with the required range?
StaticvalidateStaticvalidateEvaluate joint validation rules which apply validation conditions across multiple fields of the model. Field-specific validation rules should be defined as part of the DataSchema for the model. This method allows for testing aggregate rules which impose requirements on the overall model.
Candidate data for the model
StaticvalidateProtected Static_ProtectedApply preliminary model-specific cleaning rules or alter cleaning options or initial state. Subclass models may implement this function to configure the cleaning workflow. Any mutations to data, options, or _state parameters are performed inplace.
The provided input data for cleaning
Options which define how cleaning should be performed
The data cleaning state
The data schema used to define Module manifest files. Extends the basic PackageData schema with some additional module-specific fields.