Options
All
  • Public
  • Public/Protected
  • All
Menu

The abstract base class which defines the data schema contained within a Document.

param [data={}]

Initial data used to construct the data object. The provided object will be owned by the constructed model instance and may be mutated.

param [options={}]

Options which affect DataModel construction

param [options.parent]

A parent DataModel instance to which this DataModel belongs

param [options.strict=true]

Control the strictness of validation for initially provided data

abstract

Hierarchy

Index

Constructors

  • new DataModel(data?: {}, __namedParameters?: { parent: any; strict: boolean }): DataModel
  • Parameters

    • data: {} = {}
      • __namedParameters: { parent: any; strict: boolean } = {}
        • parent: any
        • strict: boolean

      Returns DataModel

    Properties

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

    #valid: boolean

    Is the current state of the DataModel valid?

    _schema: SchemaField

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

    Accessors

    • Define the data schema for this document instance.

      Returns SchemaField

    • get invalid(): boolean
    • Is the current state of this DataModel invalid?

      Returns boolean

    • Define the data schema for documents of this type.

      Returns SchemaField

    Methods

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

      Returns void

    • 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(options?: { changes: any; clean: boolean; fallback: 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; strict: boolean; fields: boolean; joint: boolean } = {}

        Optional parameters which customize how validation occurs.

        • changes: any
        • clean: boolean
        • fallback: boolean
        • strict: boolean
        • fields: boolean
        • joint: boolean

      Returns boolean

      An indicator for whether the document contains valid data

    • 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(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(): 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

    • _configure(options?: {}): void
    • Configure the data model instance before validation and initialization workflows are performed.

      Parameters

      • options: {} = {}

        Returns void

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

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

      • _validateModel(data: any): void
      • Jointly validate the overall data model after each field has been individually validated.

        throws

        An error if a validation failure is detected

        Parameters

        • data: any

          The candidate data object to validate

        Returns void

      • 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

      • 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

      • 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

      • fromSource(source: any, [context]?: { strict: boolean }): DataModel
      • 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]: { strict: boolean } = {}

          Model construction context

          • strict: boolean

        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

      • 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

      • 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

      • 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

      • #updateData(schema: SchemaField, source: any, changes: any, options: any): any
      • Update the source data for a specific DataSchema.

        throws

        An error if the update operation was unsuccessful

        Parameters

        • schema: SchemaField

          The data schema to update

        • source: any

          Source data to be updated

        • changes: any

          Changes to apply to the source data

        • options: any

        Returns any

        The updated source data

      • #updateField(name: string, field: DataField, source: any, value: any, options: any): any
      • Update the source data for a specific DataField.

        throws

        An error if the new candidate value is invalid

        Parameters

        • name: string

          The field name being updated

        • field: DataField

          The field definition being updated

        • source: any

          The source object being updated

        • value: any

          The new value for the field

        • options: any

          Options which modify the update workflow

        Returns any