Source data for the package
An availability code in PACKAGE_AVAILABILITY_CODES which defines whether this package can be used.
A flag which tracks whether this package is currently locked.
A flag which tracks whether this package is a free Exclusive pack
A flag which tracks whether this package is owned, if it is protected.
A set of Tags that indicate what kind of Package this is, provided by the Website
A flag which tracks if this package has files stored in the persistent storage folder
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
An immutable reverse-reference to a parent DataModel to which this model belongs.
Define the package type in CONST.PACKAGE_TYPES that this class represents. Each BasePackage subclass must define this attribute.
The type of this package instance. A value in CONST.PACKAGE_TYPES.
The canonical identifier for this package
A flag which defines whether this package is unavailable to be used.
Define the data schema for this document instance.
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
An array of validation failure instances which may have occurred when this instance was last validated.
The named collection to which this package type belongs
The Data Schema for all instances of this DataModel.
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
Clone a model, creating a new data model by combining current data with provided overrides.
The cloned Document instance
Validate the data contained in the document to check for type and content This function throws an error if data within the document is not valid
Optional parameters which customize how validation occurs.
An indicator for whether the document contains valid data
Update the DataModel locally by applying an object of changes to its source data. The provided changes are cleaned, validated, and stored to the source data object for this model. 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
An object containing the changed keys and values
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.
The extracted primitive object
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
Restrict the availability this package based on the version numbers of its dependencies. This method is implemented on the server side to provide authoritative availability data.
A value in CONST.PACKAGE_AVAILABILITY_CODES
Configure the data model instance before validation and initialization workflows are performed.
Initialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.
The candidate source data from which the model will be constructed
Migrated and cleaned source data which will be stored to the model instance
Initialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.
Clean a data source object to conform to a specific provided schema.
The cleaned source data
A 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
Migrate candidate source data for this DataModel which may require initial cleaning or transformations.
The candidate source data from which the model will be constructed
Migrated source data, if necessary
Retrieve the latest Package manifest from a provided remote location.
A remote manifest URL to load
Additional options which affect package construction
A Promise which resolves to a constructed ServerPackage instance
Get an array of validation errors from the provided error structure
Evaluate 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
Create a new instance of this DataModel from a source record. The source is presumed to be trustworthy and is not strictly validated.
Initial document data which comes from a trusted source.
Model construction context
Create a DataModel instance using a provided serialized JSON string.
Serialized document data in string format
A constructed data model instance
Wrap data migration in a try/catch which attempts it safely
The candidate source data from which the model will be constructed
Migrated source data, if necessary
Take 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
Additional shimming options
Data with added backwards-compatible properties
A generator that orders the DataFields in the DataSchema into an expected initialization order.
Validate that a Package ID is allowed.
The candidate ID
Validate a single compendium pack object
Candidate compendium packs data
The data schema used to define a Package manifest. Specific types of packages extend this schema with additional fields.