Does the system template request strict type checking of data compared to template.json inferred types.
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.
Static typeDefine the package type in CONST.PACKAGE_TYPES that this class represents. Each BasePackage subclass must define this attribute.
Static iconThe default icon used for this type of Package.
Static migratedStatic LOCALIZATION_A set of localization prefix paths which are used by this DataModel.
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.
Is this Package incompatible with the currently installed core Foundry VTT software version?
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.
Static collectionThe named collection to which this package type belongs
Static schemaThe Data Schema for all instances of this DataModel.
Internal Test 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?
Internal Test 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.
Optional data: any = {}Additional data which overrides current document data at the time of creation
Optional context: any = {}Context options passed to the data model constructor
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.
A specific set of proposed changes to validate, rather than the full source data of the model.
If changes are provided, attempt to clean the changes before validating them?
Allow replacement of invalid values with valid defaults?
If true, invalid embedded documents will emit a warning and be placed in the invalidDocuments collection rather than causing the parent to be considered invalid.
Throw if an invalid value is encountered, otherwise log a warning?
Perform validation on individual fields?
Perform joint validation on the full data model? Joint validation will be performed by default if no changes are passed. Joint validation will be disabled by default if changes are passed. Joint validation can be performed on a complete set of changes (for example testing a complete data model) by explicitly passing true.
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
Optional options: any = {}Options which determine how the new data is merged
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.
Optional source: boolean = trueDraw values from the underlying data source rather than transformed values
The extracted primitive object
Protected _initializeProtected 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
Optional options: any = {}Options provided to the model constructor
Migrated and cleaned source data which will be stored to the model instance
Protected _initializeProtected 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.
Optional options: any = {}Options provided to the model constructor
Static defineDefine the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.
Static migrateStatic shimTake 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
Static isStatic testCheck the given compatibility data against the current installation state and determine its availability.
The compatibility data to test.
Optional options: { A specific software release for which to test availability. Tests against the current release by default.
Static testDetermine 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?
Static cleanClean a data source object to conform to a specific provided schema.
The source data object
Additional options which are passed to field cleaning methods
The cleaned source data
Static validateStatic _logInternal 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
Is the package installed?
Static _migrateStatic _migrateStatic _migrateStatic _migrateStatic _migrateStatic _migrateStatic _migrateStatic _migrateStatic fromRetrieve the latest Package manifest from a provided remote location.
A remote manifest URL to load
Additional options which affect package construction
Whether to construct the remote package strictly
A Promise which resolves to a constructed ServerPackage instance
An error if the retrieved manifest data is invalid
Static validateEvaluate 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
An error if a validation failure is detected
Static fromCreate 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.
Optional context: any = {}Model construction context
Static fromJSONStatic migrateStatic Protected _initialization
Mixes
ClientPackageMixin