Class DataModel<ModelData, ModelContext>Abstract

constructor

• new DataModel<
      ModelData extends object = object,
      ModelContext extends
          DataModelConstructionContext = DataModelConstructionContext,
  >(
      data?: Partial<ModelData>,
      options?: ModelContext,
  ): DataModel<ModelData, ModelContext>

  Type Parameters

  • ModelData extends object = object
  • ModelContext extends DataModelConstructionContext = DataModelConstructionContext

  Parameters

  • Optionaldata: Partial<ModelData> = {}

    Initial data used to construct the data object. The provided object will be owned by the constructed model instance and may be mutated.
  • Optionaloptions: ModelContext = {}

    Context and data validation options which affects initial model construction.

  Returns DataModel<ModelData, ModelContext>

_source

parent

StaticLOCALIZATION_PREFIXES

invalid

• get invalid(): boolean

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

  Returns boolean

schema

• get schema(): SchemaField

  Define the data schema for this document instance.

  Returns SchemaField

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;
  }

Staticschema

• get schema(): SchemaField

  The Data Schema for all instances of this DataModel.

  Returns SchemaField

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

reset

• reset(): void

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

  Returns void

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

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

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

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.

StaticcleanData

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

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

  Parameters

  • Optionalsource: object = {}

    The source data object
  • Optionaloptions: object = {}

    Additional options which are passed to field cleaning methods

  Returns object

  The cleaned source data, which is the same object as the source argument

Static AbstractdefineSchema

• defineSchema(): DataSchema

  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 DataSchema

StaticfromJSON

• 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

StaticfromSource

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

StaticmigrateData

• migrateData(source: object): object

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

  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

StaticmigrateDataSafe

• 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

StaticshimData

• 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

StaticvalidateJoint

• 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