Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeDataModel

A specialized subclass of DataModel, intended to represent a Document's type-specific data. Systems or Modules that provide DataModel implementations for sub-types of Documents (such as Actors or Items) should subclass this class instead of the base DataModel class.

see

Document

abstract
example

Registering a custom sub-type for a Module.

module.json

{
  "id": "my-module",
  "esmodules": ["main.mjs"],
  "documentTypes": {
    "Actor": {
      "sidekick": {},
      "villain": {}
    },
    "JournalEntryPage": {
      "dossier": {},
      "quest": {
        "htmlFields": ["description"]
      }
    }
  }
}

main.mjs

Hooks.on("init", () => {
  Object.assign(CONFIG.Actor.dataModels, {
    "my-module.sidekick": SidekickModel,
    "my-module.villain": VillainModel
  });
  Object.assign(CONFIG.JournalEntryPage.dataModels, {
    "my-module.dossier": DossierModel,
    "my-module.quest": QuestModel
  });
});

class QuestModel extends foundry.abstract.TypeDataModel {
  static defineSchema() {
    const fields = foundry.data.fields;
    return {
      description: new fields.HTMLField({required: false, blank: true, initial: ""}),
      steps: new fields.ArrayField(new fields.StringField())
    };
  }

  prepareDerivedData() {
    this.totalSteps = this.steps.length;
  }
}

Hierarchy

Index

Constructors

Methods

Properties

Accessors

Constructors

constructor

Methods

prepareBaseData

  • prepareBaseData(): void

  • Prepare data related to this DataModel itself, before any derived data is computed.

    Returns void

prepareDerivedData

  • prepareDerivedData(): void

  • Apply transformations of derivations to the values of the source data object. Compute data fields whose values are not stored to the database.

    Returns void

reset

  • reset(): void

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

    Returns void

clone

  • clone(data?: any, context?: any): Document | Promise<Document>

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

    Parameters

    • data: any = {}
    • context: any = {}

    Returns Document | Promise<Document>

    The cloned Document instance

validate

  • validate(options?: { changes: any; clean: boolean; fallback: boolean; dropInvalidEmbedded: boolean; strict: boolean; fields: boolean; joint: boolean }): boolean

  • 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
      • clean: boolean
      • fallback: boolean
      • dropInvalidEmbedded: boolean
      • strict: boolean
      • fields: boolean
      • joint: boolean

    Returns boolean

    An indicator for whether the document contains valid data

updateSource

  • updateSource(changes?: any, options?: any): any

  • 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

    • options: any = {}

    Returns any

    An object containing the changed keys and values

toObject

  • toObject(source?: boolean): any

  • 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

    • source: boolean = true

    Returns any

    The extracted primitive object

toJSON

  • toJSON(): any

  • 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

  • _configure(options?: {}): void

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

    Parameters

    • options: {} = {}

      Returns void

    Protected _initializeSource

    • _initializeSource(data: any, options?: any): any

    • 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

      • options: any = {}

      Returns any

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

    Protected _initialize

    • _initialize(options?: any): void

    • 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

      • options: any = {}

      Returns void

    Static defineSchema

    • defineSchema(): any

    • Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

      virtual

      Returns any

    Static cleanData

    • cleanData(source?: any, options?: any): any

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

      Parameters

      • source: any = {}
      • options: any = {}

      Returns any

      The cleaned source data

    Static formatValidationErrors

    • formatValidationErrors(errors: any, [options={}]?: { label: string; namespace: string }): string

    • Get an array of validation errors from the provided error structure

      Parameters

      • errors: any
      • [options={}]: { label: string; namespace: string } = {}
        • label: string
        • namespace: string

      Returns string

    Static validateJoint

    • validateJoint(data: any): any

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

      throws

      An error if a validation failure is detected

      Parameters

      • data: any

        Candidate data for the model

      Returns any

    Static fromSource

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

      • [context]: DataValidationOptions = {}

        Model construction context

      Returns DataModel

    Static fromJSON

    • 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

    Static migrateData

    • migrateData(source: any): any

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

      Parameters

      • source: any

        The candidate source data from which the model will be constructed

      Returns any

      Migrated source data, if necessary

    Static migrateDataSafe

    • migrateDataSafe(source: any): any

    • 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

    Static shimData

    • shimData(data: any, [options={}]?: { embedded: boolean }): any

    • 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={}]: { embedded: boolean } = {}

        Additional shimming options

        • embedded: boolean

      Returns any

      Data with added backwards-compatible properties

    Static Protected _initializationOrder

    • _initializationOrder(): Generator<[string, DataField], any, any>

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

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

    Properties

    _source

    _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

    parent: DataModel

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

    Private #validationFailures

    #validationFailures: { fields: any; joint: any } = ...

    Type declaration

    • fields: any
    • joint: any

    Accessors

    schema

    • Define the data schema for this document instance.

      Returns SchemaField

    invalid

    • get invalid(): boolean

    • Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.

      Returns boolean

    validationFailures

    Static schema

    • The Data Schema for all instances of this DataModel.

      Returns SchemaField