Class BasePackage

The data schema used to define a Package manifest. Specific types of packages extend this schema with additional fields.

Hierarchy (View Summary)

DataModel
- BasePackage

Constructors

constructor

new BasePackage(data: PackageManifestData, options?: object): BasePackage
Parameters
- data: PackageManifestData
  Source data for the package
- Optionaloptions: object = {}
  Options which affect DataModel construction
Returns BasePackage
Overrides DataModel.constructor

Properties

_source

_source: object

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

availability

availability: number

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

exclusive

exclusive: boolean

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

hasStorage

hasStorage: boolean

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

locked

locked: boolean

A flag which tracks whether this package is currently locked.

owned

owned: null | boolean

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

parent

parent: null | DataModel<object, DataModelConstructionContext>

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

`Static` `Internal`_schema

_schema: SchemaField

The defined and cached Data Schema for all instances of this DataModel.

`Static`LOCALIZATION_PREFIXES

LOCALIZATION_PREFIXES: string[] = ...

`Static` `Abstract`type

type: string = "package"

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

Accessors

incompatibleWithCoreVersion

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

Returns boolean

invalid

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

Returns boolean
Inherited from DataModel.invalid

schema

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

Returns SchemaField
Inherited from DataModel.schema

type

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

Returns string

unavailable

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

Returns boolean

validationFailures

get validationFailures(): {
    fields: null
    | DataModelValidationFailure;
    joint: null | DataModelValidationFailure;
}
An array of validation failure instances which may have occurred when this instance was last validated.

Returns {
    fields: null | DataModelValidationFailure;
    joint: null | DataModelValidationFailure;
}
Inherited from DataModel.validationFailures

`Static`collection

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

Returns string

`Static`schema

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

Returns SchemaField
Inherited from DataModel.schema

Methods

_testRequiredDependencies

_testRequiredDependencies(
modulesCollection: Collection<string, Module>,
): Promise<boolean>
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?

_testSupportedSystems

_testSupportedSystems(
systemCollection: Collection<string, System>,
): Promise<boolean>
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.

clone

clone(
data?: object,
context?: DataModelConstructionContext,
): DataModel<object, DataModelConstructionContext>
Clone a model, creating a new data model by combining current data with provided overrides.
Parameters
- Optionaldata: object = {}
  Additional data which overrides current document data at the time of creation
- Optionalcontext: DataModelConstructionContext = {}
  Context options passed to the data model constructor
Returns DataModel<object, DataModelConstructionContext>
The cloned instance

Inherited from DataModel.clone

reset

reset(): void
Reset the state of this data instance back to mirror the contained source data, erasing any changes.

Returns void
Inherited from DataModel.reset

toJSON

toJSON(): object
Extract the source data for the DataModel into a simple object format that can be serialized.

Returns object
The document source data expressed as a plain object

Inherited from DataModel.toJSON

toObject

toObject(source?: boolean): 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.
Parameters
- Optionalsource: boolean = true
  Draw values from the underlying data source rather than transformed values
Returns object
The extracted primitive object

Inherited from DataModel.toObject

updateSource

updateSource(changes?: object, options?: DataModelUpdateOptions): 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.
Parameters
- changes: object = {}
  New values which should be applied to the data model
- options: DataModelUpdateOptions = {}
  Options which determine how the new data is merged
Returns object
An object containing differential keys and values that were changed

Throws
An error if the requested data model changes were invalid

Inherited from DataModel.updateSource

validate

validate(options?: DataModelValidationOptions): boolean
Validate the data contained in the document to check for type and content. If changes are provided, missing types are added to it before cleaning and validation. This mutates the provided changes. This function throws an error if data within the document is not valid.
Parameters
- options: DataModelValidationOptions = {}
  Options which modify how the model is validated
Returns boolean
Whether the data source or proposed change is reported as valid. A boolean is always returned if validation is non-strict.

Throws
An error thrown if validation is strict and a failure occurs.

Inherited from DataModel.validate

`Protected`_configure

_configure(options?: object): void
Protected
Configure the data model instance before validation and initialization workflows are performed.
Parameters
- Optionaloptions: object = {}
  Additional options modifying the configuration
Returns void
Inherited from DataModel._configure

`Protected`_initialize

_initialize(options?: object): void
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
- Optionaloptions: object = {}
  Options provided to the model constructor
Returns void
Inherited from DataModel._initialize

`Protected`_initializeSource

_initializeSource(
data: object | DataModel<object, DataModelConstructionContext>,
options?: object,
): object
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: object | DataModel<object, DataModelConstructionContext>
  The candidate source data from which the model will be constructed
- Optionaloptions: object = {}
  Options provided to the model constructor
Returns object
Migrated and cleaned source data which will be stored to the model instance, which is the same object as the data argument

Inherited from DataModel._initializeSource

`Static`_logWarning

_logWarning(
    packageId: string,
    message: string,
    options?: { installed?: object },
): void
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?: object } = {}
  Logging options passed to foundry.utils.logCompatibilityWarning
  - Optionalinstalled?: object
    Is the package installed?
Returns void

`Static`_migratePackIDs

_migratePackIDs(data: any, logOptions: any): void
Internal
Parameters
- data: any
- logOptions: any
Returns void

`Static`_migrateStyles

_migrateStyles(data: any): void
Internal
Parameters
- data: any
Returns void

`Static`cleanData

cleanData(source?: {}, __namedParameters?: {}): object
Clean a data source object to conform to a specific provided schema.
Parameters
- source: {} = {}
  The source data object
- __namedParameters: {} = {}
  Additional options which are passed to field cleaning methods
Returns object
The cleaned source data, which is the same object as the source argument

Overrides DataModel.cleanData

`Static`defineSchema

defineSchema(): {
    authors: SetField;
    bugs: StringField;
    changelog: StringField;
    compatibility: PackageCompatibility;
    description: HTMLField;
    download: StringField;
    esmodules: SetField;
    exclusive: BooleanField;
    flags: ObjectField;
    id: StringField;
    languages: SetField;
    license: StringField;
    manifest: StringField;
    media: SetField;
    packFolders: SetField;
    packs: PackageCompendiumPacks;
    persistentStorage: BooleanField;
    protected: BooleanField;
    readme: StringField;
    relationships: PackageRelationships;
    scripts: SetField;
    socket: BooleanField;
    styles: ArrayField<SchemaField>;
    title: StringField;
    url: StringField;
    version: StringField;
}
Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

Returns {
    authors: SetField;
    bugs: StringField;
    changelog: StringField;
    compatibility: PackageCompatibility;
    description: HTMLField;
    download: StringField;
    esmodules: SetField;
    exclusive: BooleanField;
    flags: ObjectField;
    id: StringField;
    languages: SetField;
    license: StringField;
    manifest: StringField;
    media: SetField;
    packFolders: SetField;
    packs: PackageCompendiumPacks;
    persistentStorage: BooleanField;
    protected: BooleanField;
    readme: StringField;
    relationships: PackageRelationships;
    scripts: SetField;
    socket: BooleanField;
    styles: ArrayField<SchemaField>;
    title: StringField;
    url: StringField;
    version: StringField;
}
Overrides DataModel.defineSchema

`Static`fromJSON

fromJSON(json: string): DataModel<object, DataModelConstructionContext>
Create a DataModel instance using a provided serialized JSON string.
Parameters
- json: string
  Serialized document data in string format
Returns DataModel<object, DataModelConstructionContext>
A constructed data model instance

Inherited from DataModel.fromJSON

`Static`fromRemoteManifest

fromRemoteManifest(
manifestUrl: string,
options?: { strict?: boolean },
): Promise<ServerPackage>
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
  - Optionalstrict?: 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

`Static`fromSource

fromSource(
source: object,
context?: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions,
): DataModel<object, DataModelConstructionContext>
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: object
  Initial document data which comes from a trusted source.
- Optionalcontext: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions = {}
  Model construction context
Returns DataModel<object, DataModelConstructionContext>
Inherited from DataModel.fromSource

`Static`isIncompatibleWithCoreVersion

isIncompatibleWithCoreVersion(availability: number): boolean
Test if a given availability is incompatible with the core version.
Parameters
- availability: number
  The availability value to test.
Returns boolean

`Static`migrateData

migrateData(data: any, __namedParameters?: {}): object
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
- __namedParameters: {} = {}
Returns object
Migrated source data, which is the same object as the source argument

Overrides DataModel.migrateData

`Static`migrateDataSafe

migrateDataSafe(source: object): object
Wrap data migration in a try/catch which attempts it safely
Parameters
- source: object
  The candidate source data from which the model will be constructed
Returns object
Migrated source data, which is the same object as the source argument

Inherited from DataModel.migrateDataSafe

`Static`shimData

shimData(data: object, options?: { embedded?: boolean }): object
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: object
  Data which matches the current schema
- Optionaloptions: { embedded?: boolean } = {}
  Additional shimming options
  - Optionalembedded?: boolean
    Apply shims to embedded models?
Returns object
Data with added backwards-compatible properties, which is the same object as the data argument

Inherited from DataModel.shimData

`Static`testAvailability

testAvailability(
data: Partial<PackageManifestData>,
options?: { release?: any },
): number
Check the given compatibility data against the current installation state and determine its availability.
Parameters
- data: Partial<PackageManifestData>
  The compatibility data to test.
- Optionaloptions: { release?: any } = {}
  - Optionalrelease?: any
    A specific software release for which to test availability. Tests against the current release by default.
Returns number

`Static`testDependencyCompatibility

testDependencyCompatibility(
compatibility: PackageCompatibility,
dependency: BasePackage,
): boolean
Determine if a dependency is within the given compatibility range.
Parameters
- compatibility: PackageCompatibility
  The compatibility range declared for the dependency, if any
- dependency: BasePackage
  The known dependency package
Returns boolean
Is the dependency compatible with the required range?

`Static`validateId

validateId(id: string): void
Validate that a Package ID is allowed.
Parameters
- id: string
  The candidate ID
Returns void
Throws
An error if the candidate ID is invalid

`Static`validateJoint

validateJoint(data: object): void
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: object
  Candidate data for the model
Returns void
Throws
An error if a validation failure is detected

Inherited from DataModel.validateJoint

`Static`validateVersion

validateVersion(version: string): void
Validate that a version is allowed.
Parameters
- version: string
  The candidate version
Returns void
Throws
An error if the version is invalid

`Protected` `Static`_initializationOrder

_initializationOrder(): Generator<[string, DataField], any, any>
Protected
A generator that orders the DataFields in the DataSchema into an expected initialization order.

Returns Generator<[string, DataField], any, any>
Yields
Inherited from DataModel._initializationOrder

Class BasePackage

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BasePackage

Properties

_source

availability

exclusive

hasStorage

locked

owned

parent

tags

Static Internal_schema

StaticLOCALIZATION_PREFIXES

Static Abstracttype

Accessors

incompatibleWithCoreVersion

Returns boolean

invalid

Returns boolean

schema

Returns SchemaField

type

Returns string

unavailable

Returns boolean

validationFailures

Returns { fields: null | DataModelValidationFailure; joint: null | DataModelValidationFailure;}

Staticcollection

Returns string

Staticschema

Returns SchemaField

Methods

_testRequiredDependencies

Parameters

Returns Promise<boolean>

_testSupportedSystems

Parameters

Returns Promise<boolean>

clone

Parameters

Returns DataModel<object, DataModelConstructionContext>

reset

Returns void

toJSON

Returns object

toObject

Parameters

Returns object

updateSource

Parameters

Returns object

Throws

validate

Parameters

Returns boolean

Throws

Protected_configure

Parameters

Returns void

Protected_initialize

Parameters

Returns void

Protected_initializeSource

Parameters

Returns object

Static_logWarning

Parameters

Optionalinstalled?: object

Returns void

Static_migratePackIDs

Parameters

`Static` `Internal`_schema

`Static`LOCALIZATION_PREFIXES

`Static` `Abstract`type

Returns {
fields: null | DataModelValidationFailure;
joint: null | DataModelValidationFailure;
}

`Static`collection

`Static`schema

`Protected`_configure

`Protected`_initialize

`Protected`_initializeSource

`Static`_logWarning

`Optional`installed?: object

`Static`_migratePackIDs

`Static`_migrateStyles

`Static`cleanData

`Static`defineSchema

`Static`fromJSON

`Static`fromRemoteManifest

`Optional`strict?: boolean

`Static`fromSource

`Static`isIncompatibleWithCoreVersion

`Static`migrateData

`Static`migrateDataSafe

`Static`shimData

`Optional`embedded?: boolean

`Static`testAvailability

`Optional`release?: any

`Static`testDependencyCompatibility

`Static`validateId

`Static`validateJoint

`Static`validateVersion

`Protected` `Static`_initializationOrder