Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

mixes

ClientPackageMixin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Module(data: any, options?: {}): Module

Properties

availability

availability: number

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

unavailable

unavailable: boolean

A flag which defines whether this package is unavailable to be used.

locked

locked: boolean

A flag which tracks whether this package is currently locked.

exclusive

exclusive: boolean

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

owned

owned: boolean

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

tags

tags: string[]

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

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

Static type

type: string = "module"
override

Accessors

type

  • get type(): string

  • The type of this package instance. A value in CONST.PACKAGE_TYPES.

    Returns string

name

  • get name(): string

  • The canonical identifier for this package

    deprecated

    Returns string

data

  • get data(): this
  • deprecated

    Returns this

schema

  • Define the data schema for this document instance.

    Returns SchemaField

invalid

  • get invalid(): boolean

  • Is the current state of this DataModel invalid?

    Returns boolean

Static collection

  • get collection(): string

  • The named collection to which this package type belongs

    Returns string

Static schema

  • Define the data schema for documents of this type.

    Returns SchemaField

Methods

_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

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

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

    Protected _validateModel

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

    Static defineSchema

    Static migrateData

    • migrateData(data: any): any

    • 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

      Returns any

      Migrated source data, if necessary

    Static _migrateNameToId

    • _migrateNameToId(data: any, __namedParameters: Object): void

    Static _migrateCompendiumEntityToType

    • _migrateCompendiumEntityToType(data: any, __namedParameters: Object): void

    Static _migrateAuthorToAuthors

    • _migrateAuthorToAuthors(data: any, __namedParameters: Object): void

    Static _migrateDependenciesNameToId

    • _migrateDependenciesNameToId(data: any, __namedParameters: Object): void

    Static _migrateToRelationships

    • _migrateToRelationships(data: any, __namedParameters: Object): void

    Static _migrateStringAuthors

    • _migrateStringAuthors(data: any, __namedParameters: Object): void

    Static _migrateCompatibility

    • _migrateCompatibility(data: any, __namedParameters: Object): void

    Static fromRemoteManifest

    • fromRemoteManifest(manifestUrl: string, options?: { strict: boolean }): Promise<ServerPackage>

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

      throws

      An error if the retrieved manifest data is invalid

      Parameters

      • manifestUrl: string

        A remote manifest URL to load

      • options: { strict: boolean } = {}

        Additional options which affect package construction

        • strict: boolean

      Returns Promise<ServerPackage>

      A Promise which resolves to a constructed ServerPackage instance

    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 fromSource

    • 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

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