The data schema used to define System manifest files. Extends the basic PackageData schema with some additional system-specific fields.

Hierarchy (view full)

Constructors

  • Parameters

    • data: PackageManifestData

      Source data for the package

    • Optional options: any = {}

      Options which affect DataModel construction

    Returns BaseSystem

Properties

strictDataCleaning: boolean = false

Does the system template request strict type checking of data compared to template.json inferred types.

availability: number

An availability code in PACKAGE_AVAILABILITY_CODES which defines whether this package can be used.

locked: boolean

A flag which tracks whether this package is currently locked.

exclusive: boolean

A flag which tracks whether this package is a free Exclusive pack

owned: boolean

A flag which tracks whether this package is owned, if it is protected.

tags: string[]

A set of Tags that indicate what kind of Package this is, provided by the Website

hasStorage: boolean

A flag which tracks if this package has files stored in the persistent storage folder

_source: any

The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.

parent: DataModel

An immutable reverse-reference to a parent DataModel to which this model belongs.

type: string = "system"

Define the package type in CONST.PACKAGE_TYPES that this class represents. Each BasePackage subclass must define this attribute.

icon: string = "fa-dice"

The default icon used for this type of Package.

migratedKeys: any = ...
LOCALIZATION_PREFIXES: string[] = []

A set of localization prefix paths which are used by this DataModel.

Accessors

  • get type(): string
  • The type of this package instance. A value in CONST.PACKAGE_TYPES.

    Returns string

  • get name(): string
  • The canonical identifier for this package

    Returns string

    Deprecated

  • get unavailable(): boolean
  • A flag which defines whether this package is unavailable to be used.

    Returns boolean

  • get incompatibleWithCoreVersion(): boolean
  • Is this Package incompatible with the currently installed core Foundry VTT software version?

    Returns boolean

  • get schema(): SchemaField
  • Define the data schema for this document instance.

    Returns SchemaField

  • get invalid(): boolean
  • Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.

    Returns boolean

  • get collection(): string
  • The named collection to which this package type belongs

    Returns string

  • get schema(): SchemaField
  • The Data Schema for all instances of this DataModel.

    Returns SchemaField

Methods

  • 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.

    Parameters

    • modulesCollection: Collection<string, Module>

      A collection which defines the set of available modules

    Returns Promise<boolean>

    Are all required dependencies satisfied?

  • Internal

    Test compatibility of a package's supported systems.

    Parameters

    • systemCollection: Collection<string, System>

      A collection which defines the set of available systems.

    Returns Promise<boolean>

    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.

  • Reset the state of this data instance back to mirror the contained source data, erasing any changes.

    Returns void

  • Clone a model, creating a new data model by combining current data with provided overrides.

    Parameters

    • 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

    Returns Document | Promise<Document>

    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

    Parameters

    • options: {
          changes: any;
          clean: boolean;
          fallback: boolean;
          dropInvalidEmbedded: boolean;
          strict: boolean;
          fields: boolean;
          joint: boolean;
      } = {}

      Optional parameters which customize how validation occurs.

      • changes: any

        A specific set of proposed changes to validate, rather than the full source data of the model.

      • clean: boolean

        If changes are provided, attempt to clean the changes before validating them?

      • fallback: boolean

        Allow replacement of invalid values with valid defaults?

      • dropInvalidEmbedded: boolean

        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.

      • strict: boolean

        Throw if an invalid value is encountered, otherwise log a warning?

      • fields: boolean

        Perform validation on individual fields?

      • joint: boolean

        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.

    Returns boolean

    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.

    Parameters

    • changes: any = {}

      New values which should be applied to the data model

    • Optional options: any = {}

      Options which determine how the new data is merged

    Returns any

    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.

    Parameters

    • Optional source: boolean = true

      Draw values from the underlying data source rather than transformed values

    Returns any

    The extracted primitive object

  • Extract the source data for the DataModel into a simple object format that can be serialized.

    Returns any

    The document source data expressed as a plain object

  • Protected

    Configure the data model instance before validation and initialization workflows are performed.

    Parameters

    • options: {} = {}

      Returns void

    • Protected

      Initialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.

      Parameters

      • data: any

        The candidate source data from which the model will be constructed

      • Optional options: any = {}

        Options provided to the model constructor

      Returns any

      Migrated and cleaned source data which will be stored to the model instance

    • Protected

      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.

      Parameters

      • Optional options: any = {}

        Options provided to the model constructor

      Returns void

    • Migrate candidate source data for this DataModel which may require initial cleaning or transformations.

      Parameters

      • data: any

        The candidate source data from which the model will be constructed

      • options: any

      Returns any

      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.

      Parameters

      • data: any

        Data which matches the current schema

      • options: any

        Additional shimming options

      Returns any

      Data with added backwards-compatible properties

    • Test if a given availability is incompatible with the core version.

      Parameters

      • availability: number

        The availability value to test.

      Returns boolean

    • Check the given compatibility data against the current installation state and determine its availability.

      Parameters

      • data: PackageManifestData

        The compatibility data to test.

      • Optional options: {
            release: ReleaseData;
        } = {}
        • release: ReleaseData

          A specific software release for which to test availability. Tests against the current release by default.

      Returns number

    • Determine if a dependency is within the given compatibility range.

      Parameters

      Returns boolean

      Is the dependency compatible with the required range?

    • Clean a data source object to conform to a specific provided schema.

      Parameters

      • source: {} = {}

        The source data object

        • __namedParameters: {
              installed: any;
          } = {}

          Additional options which are passed to field cleaning methods

          • installed: any

        Returns any

        The cleaned source data

      • Validate that a Package ID is allowed.

        Parameters

        • id: string

          The candidate ID

        Returns void

        Throws

        An error if the candidate ID is invalid

      • Internal

        A wrapper around the default compatibility warning logger which handles some package-specific interactions.

        Parameters

        • packageId: string

          The package ID being logged

        • message: string

          The warning or error being logged

        • options: {
              installed: any;
          } = {}

          Logging options passed to foundry.utils.logCompatibilityWarning

          • installed: any

            Is the package installed?

        Returns void

      • Internal

        Parameters

        • data: any
        • logOptions: any

        Returns void

      • Internal

        Parameters

        • data: any
        • logOptions: any

        Returns void

      • Internal

        Parameters

        • data: any
        • logOptions: any

        Returns void

      • Retrieve the latest Package manifest from a provided remote location.

        Parameters

        • manifestUrl: string

          A remote manifest URL to load

        • options: {
              strict: boolean;
          } = {}

          Additional options which affect package construction

          • strict: boolean

            Whether to construct the remote package strictly

        Returns Promise<ServerPackage>

        A Promise which resolves to a constructed ServerPackage instance

        Throws

        An error if the retrieved manifest data is invalid

      • 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.

        Parameters

        • data: any

          Candidate data for the model

        Returns any

        Throws

        An error if a validation failure is detected

      • Create a new instance of this DataModel from a source record. The source is presumed to be trustworthy and is not strictly validated.

        Parameters

        • source: any

          Initial document data which comes from a trusted source.

        • Optional context: any = {}

          Model construction context

        Returns DataModel

      • Create a DataModel instance using a provided serialized JSON string.

        Parameters

        • json: string

          Serialized document data in string format

        Returns DataModel

        A constructed data model instance

      • Wrap data migration in a try/catch which attempts it safely

        Parameters

        • source: any

          The candidate source data from which the model will be constructed

        Returns any

        Migrated source data, if necessary

      • Protected

        A generator that orders the DataFields in the DataSchema into an expected initialization order.

        Returns Generator<[string, DataField], any, any>