@hashgraph/solo/dist/src/data/schema/migration/api/schema-definition.d.ts

An opinionated CLI tool to deploy and manage private Hedera Networks.

import { type ClassConstructor } from '../../../../business/utils/class-constructor.type.js';
import { type SchemaMigration } from './schema-migration.js';
import { type SemanticVersion } from '../../../../business/utils/semantic-version.js';
/**
 * Defines a schema which can be used to convert input data into a model instance.
 */
export interface SchemaDefinition<T> {
    /**
     * The name of the schema. Schema name are unique and should be related to the specific configuration model which
     * the schema represents.
     */
    readonly name: string;
    /**
     * The current version of the schema. This is used to determine if the input data needs to be migrated before being
     * applied to a model.
     */
    readonly version: SemanticVersion<number>;
    /**
     * The class constructor for the model. This is used to create instances of the model from the input data.
     */
    readonly classConstructor: ClassConstructor<T>;
    /**
     * The list of migrations which can be applied to the model data. Migrations are applied in order to bring the input data
     * up to the current schema version.
     */
    readonly migrations: SchemaMigration[];
    /**
     * Transforms the plain javascript object into an instance of the model class. Applies any necessary migrations to the
     * input data before creating the model instance.
     *
     * @param data - The plain javascript object to be transformed.
     * @param sourceVersion - The version of the input data. If not provided, the version is introspected from or
     *                        otherwise assumed based on the provided plain javascript object.
     * @returns an instance of the model class.
     */
    transform(data: object, sourceVersion?: SemanticVersion<number>): Promise<T>;
    /**
     * Validates the migrations for the schema. This method should be called during the application startup to ensure that
     * the migrations are correctly defined.
     *
     * Due to the risk imposed by performing migrations on production data, we cannot afford to allow production code to
     * ever perform a partial migration. A partial migration is defined as a series of migrations which result in the final
     * migrated data being a version that is less than the current schema version. Executing a partial migration may
     * leave the data in a state in which future modifications result in a corrupted object.
     *
     * Therefore, we should always ensure the migrations are correctly defined and that the migration sequence is unbroken.
     * All actual migrations of data should validate the resulting object has reached the current schema version.
     *
     * The intent of this method is to ensure that the migrations are correctly defined during application startup and
     * unit testing.
     */
    validateMigrations(): Promise<void>;
}