@asaidimu/anansi 1.2.1 → 1.2.3

package/index.d.cts

@@ -286,7 +286,7 @@ interface Migration<T> {
  * Defines the interface for a migration engine.
  * The migration engine is responsible for applying, rolling back, and tracking schema migrations.
  */
-interface MigrationEngine<T> {
+interface MigrationEngineInterface<T> {
     /**
      * Applies all pending migrations.
      * @returns A promise that resolves when all migrations are applied.
@@ -413,6 +413,98 @@ declare function createPatch(oldObj: any, newObj: any): PatchOperation[];
  */
 declare function schemaChangeToPatch(change: SchemaChange<any>, schema: SchemaDefinition): PatchOperation[];
 
+/**
+ * Schema event types.
+ */
+type SchemaEventType = SchemaEvent["type"];
+/**
+ * Represents a schema event.
+ */
+type SchemaEvent = {
+    type: "migration:started";
+    description: string;
+    currentVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:committed";
+    currentVersion: string;
+    previousVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:rollingBack";
+    currentVersion: string;
+    targetVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:rolledBack";
+    currentVersion: string;
+    previousVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:ended";
+    currentVersion: string;
+    status: "committed" | "rolledBack";
+};
+/**
+ * Schema interface for managing schema evolution.
+ * @template T The type of data associated with the schema.
+ */
+interface Schema<T = any> {
+    /**
+     * Subscribes to schema events. The listener will be called for each event.
+     * @param event The type of schema event to subscribe to.
+     * @param listener The listener function that receives the schema event.
+     * @returns A function that, when called, unsubscribes the listener.
+     */
+    subscribe(event: SchemaEventType, listener: (event: SchemaEvent) => void): () => void;
+    /**
+     * Returns a read-only copy of the schema definition.
+     * @returns A read-only version of the current schema definition.
+     */
+    definition(): Readonly<SchemaDefinition>;
+    /**
+     * Returns a promise that resolves to a read-only copy of the migration history.
+     * @returns A promise that resolves to a read-only array of migrations.
+     */
+    migrations(): Promise<Readonly<Migration<any>[]>>;
+    /**
+     * Exports the schema state (definition and migrations) as a JSON string.
+     * @returns A JSON string representation of the schema state.
+     */
+    export(): string;
+    /**
+     * Imports the schema state (definition and migrations) from a JSON string.
+     * @param json The JSON string representing the schema state to import.
+     * @throws Error if the imported state is invalid.
+     */
+    import(json: string): void;
+    /**
+     * Creates a migration from a list of changes.
+     * @param description A description of the migration.
+     * @param changes A list of schema changes to apply.
+     * @param dryRun Indicates whether the migration should actually be executed
+     * @throws Error if the changes are not valid.
+     * @returns A promise that resolves when the migration is complete.
+     */
+    migrate(description: string, changes: SchemaChange<T>[], dryRun?: boolean): Promise<void>;
+    /**
+     * Rolls back a migration.
+     * @param version The version to rollback from. If not specified, rolls back the last migration.
+     * @throws Error if the rollback cannot be performed.
+     * @returns A promise that resolves when the rollback is complete.
+     */
+    rollback(version?: string): Promise<void>;
+    /**
+     * Creates a migration helper to assist in creating a migration.
+     * @param description A description of the migration.
+     * @returns A `SchemaMigrationHelper` instance to build the migration.
+     */
+    migrationHelper(description: string): SchemaMigrationHelper;
+}
 /**
  * Helper for building schema migrations.
  * @template T The type of data associated with the schema.
@@ -765,6 +857,190 @@ declare enum MigrationErrorCode {
     ROLLBACK_ERROR = "ROLLBACK_ERROR",
     MISSING_TRANSFORM = "MISSING_TRANSFORM"
 }
+/**
+ * @class MigrationEngine
+ * @param {SchemaDefinition} currentSchema - The current schema definition
+ * @param {Array<Migration<any>>} [migrations] - Optional array of migrations
+ * @throws {MigrationError} If the initial schema or migrations are invalid
+ */
+declare class MigrationEngine {
+    private currentSchema;
+    private history;
+    private migrations;
+    private isProcessing;
+    /**
+     * @constructor
+     * @param {SchemaDefinition} currentSchema - The current schema definition
+     * @param {Array<Migration<any>>} [migrations] - Optional array of migrations
+     */
+    constructor(currentSchema: SchemaDefinition, migrations?: Array<Migration<any>>, history?: Array<SchemaDefinition>);
+    /**
+     * Gets the current state of the migration helper
+     * @returns {Object} Current state containing schema, history, and migrations
+     * @example
+     * ```javascript
+     * const state = migrationEngine.data();
+     * // state contains currentSchema, history, and migrations
+     * ```
+     */
+    data(): {
+        schema: SchemaDefinition;
+        history: SchemaDefinition[];
+        migrations: Migration<any>[];
+    };
+    /**
+     * Generates a SHA-256 checksum for a migration
+     * @private
+     * @param {Omit<Migration<any>, "checksum">} migration - The migration object
+     * @returns {Promise<string>} The generated checksum
+     * @throws {MigrationError} If checksum generation fails
+     */
+    private generateChecksum;
+    /**
+     * Adds a new migration to the engine
+     * @async
+     * @param {Object} opts - Options for the new migration
+     * @param {SchemaChange<any>[]} opts.changes - Array of schema changes
+     * @param {string} opts.description - Description of the migration
+     * @param {SchemaChange<any>[]} [opts.rollback] - Optional rollback changes
+     * @param {DataTransform<any, any>} [opts.transform] - Optional data transform
+     * @throws {MigrationError} If adding the migration fails
+     */
+    add(opts: {
+        changes: SchemaChange<any>[];
+        description: string;
+        rollback?: SchemaChange<any>[];
+        transform?: string | DataTransform<any, any>;
+    }): Promise<void>;
+    /**
+     * Performs a dry run of the migration
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @param {version} version - Version to rollback to
+     * @returns {Promise<Object>} Object containing newSchema and dataPreview
+     * @throws {MigrationError} If dry run fails
+     */
+    dryRun(input: ReadableStream<any>, direction: "forward" | "backward", version?: string): Promise<{
+        newSchema: SchemaDefinition;
+        dataPreview: ReadableStream<any>;
+    }>;
+    /**
+     * Gets relevant migrations based on direction
+     * @private
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Array<Migration<any>>} Relevant migrations
+     */
+    private getRelevantMigrations;
+    /**
+     * Applies schema changes to a given schema
+     * @private
+     * @param {SchemaDefinition} schema - The schema to modify
+     * @param {SchemaChange<any>[]} changes - Array of schema changes
+     * @param {string} [migrationId] - ID of the migration
+     * @returns {SchemaDefinition} Modified schema
+     * @throws {MigrationError} If applying changes fails
+     */
+    private applySchemaChanges;
+    /**
+     * Prepares the list of pending migrations for application
+     * @async
+     * @returns {Promise<Array<Migration<any>>} List of pending migrations
+     * @throws {MigrationError} If preparation fails
+     */
+    prepareMigration(): Promise<Array<Migration<any>>>;
+    /**
+     * Applies pending migrations
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {MigrationError} If migration fails
+     */
+    migrate(input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Validates migrations by checking their checksums
+     * @private
+     * @async
+     * @param {Array<Migration<any>>} migrations - Migrations to validate
+     * @throws {MigrationError} If validation fails
+     */
+    private validateMigrations;
+    /**
+     * Marks migrations as applied
+     * @private
+     * @param {Array<Migration<any>>} migrations - Migrations to mark as applied
+     */
+    private markMigrationsApplied;
+    /**
+     * Rolls back the last applied migration
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     */
+    rollback(input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Rolls back to a specific schema version
+     * @async
+     * @param {string} targetVersion - Target schema version
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {Error} If target version is not found
+     */
+    rollbackToVersion(targetVersion: string, input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Processes a list of migrations on a data stream, applying transformations
+     * in the specified direction (forward or backward).
+     *
+     * @static
+     * @async
+     * @param {ReadableStream<any>} input - The input data stream to process
+     * @param {"forward" | "backward"} direction - Direction of migration (either "forward" or "backward")
+     * @param {Array<Migration<any>>} migrations - Array of Migration objects to process
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {MigrationError} If any migration processing fails
+     */
+    static processMigrationList(input: ReadableStream<any>, direction: "forward" | "backward", migrations: Migration<any>[]): Promise<ReadableStream<any>>;
+    /**
+     * Resolves the transform function for a given migration in the specified direction.
+     *
+     * @private
+     * @async
+     * @param {Migration<any>} migration - The migration to resolve the transform for
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If transform resolution fails
+     */
+    private static resolveTransform;
+    /**
+     * Resolves a transform function from a remote URL.
+     *
+     * @private
+     * @async
+     * @param {string} url - URL of the transform module
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If resolution fails
+     */
+    private static resolveRemoteTransform;
+    /**
+     * Resolves a transform function from a local module path.
+     *
+     * @private
+     * @async
+     * @param {string} path - Local module path
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If resolution fails
+     */
+    private static resolveLocalTransform;
+    /**
+     * Transforms the schema either forward or backward
+     * @private
+     * @param {"forward" | "backward"} direction - Direction of transformation
+     * @throws {Error} If transformation fails
+     */
+    private transformSchema;
+}
 
 /**
  * Helper for building schema migrations with forward and rollback changes.
@@ -1600,4 +1876,8 @@ declare function compareSemanticVersions(a: string, b: string): number;
  */
 declare function sortSemanticVars(vars: string[]): string[];
 
-export { type Constraint, type ConstraintGroup, type ConstraintParameters, type ConstraintsMap, type DataTransform, type FieldDefinition, type FieldType, type FunctionMap, type IndexDefinition, type IndexType, JsonPatchError, type LogicalOperator, type Migration, type MigrationEngine, MigrationError, MigrationErrorCode, type MigrationMetadata, MigrationSchema, type PartialIndexCondition, type PatchOperation, type Persistence, type PersistenceCollection, type PersistenceEvent, type PersistenceEventType, type PersistenceTransaction, type Predicate, type PredicateMap, type PredicateName, type PredicateParameters, type RegistryLock, type RegistryMetadata, type SchemaChange, type SchemaConstraint, type SchemaDefinition, type SchemaIndex, type SchemaMetadata, type SchemaRegistry, type SchemaVersion, type TransformFunction, applyPatch, calculateNextVersion, compareSemanticVersions, createPatch, createSchemaMigrationHelper, createStandardSchemaValidator, deepMerge, generateSHA256Hash, normalizePath, schemaChangeToPatch, schemaToTypes, sortSemanticVars, validate, validateMigration, validateSchemaChange, validateSchemaDefinition };
+declare function docgen(schema: SchemaDefinition, options?: {
+    faker?: Faker;
+}): string;
+
+export { type Constraint, type ConstraintGroup, type ConstraintParameters, type ConstraintsMap, type DataTransform, type FieldDefinition, type FieldType, type FunctionMap, type IndexDefinition, type IndexType, JsonPatchError, type LogicalOperator, type Migration, MigrationEngine, type MigrationEngineInterface, MigrationError, MigrationErrorCode, type MigrationMetadata, MigrationSchema, type PartialIndexCondition, type PatchOperation, type Persistence, type PersistenceCollection, type PersistenceEvent, type PersistenceEventType, type PersistenceTransaction, type Predicate, type PredicateMap, type PredicateName, type PredicateParameters, type RegistryLock, type RegistryMetadata, type Schema, type SchemaChange, type SchemaConstraint, type SchemaDefinition, type SchemaEvent, type SchemaEventType, type SchemaIndex, type SchemaMetadata, type SchemaMigrationHelper, type SchemaRegistry, type SchemaVersion, type TransformFunction, applyPatch, calculateNextVersion, compareSemanticVersions, createPatch, createSchemaMigrationHelper, createStandardSchemaValidator, deepMerge, docgen, generateSHA256Hash, normalizePath, schemaChangeToPatch, schemaToTypes, sortSemanticVars, validate, validateMigration, validateSchemaChange, validateSchemaDefinition };

package/index.d.ts

@@ -286,7 +286,7 @@ interface Migration<T> {
  * Defines the interface for a migration engine.
  * The migration engine is responsible for applying, rolling back, and tracking schema migrations.
  */
-interface MigrationEngine<T> {
+interface MigrationEngineInterface<T> {
     /**
      * Applies all pending migrations.
      * @returns A promise that resolves when all migrations are applied.
@@ -413,6 +413,98 @@ declare function createPatch(oldObj: any, newObj: any): PatchOperation[];
  */
 declare function schemaChangeToPatch(change: SchemaChange<any>, schema: SchemaDefinition): PatchOperation[];
 
+/**
+ * Schema event types.
+ */
+type SchemaEventType = SchemaEvent["type"];
+/**
+ * Represents a schema event.
+ */
+type SchemaEvent = {
+    type: "migration:started";
+    description: string;
+    currentVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:committed";
+    currentVersion: string;
+    previousVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:rollingBack";
+    currentVersion: string;
+    targetVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:rolledBack";
+    currentVersion: string;
+    previousVersion: string;
+    changes: SchemaChange<any>[];
+    dryRun?: boolean;
+} | {
+    type: "migration:ended";
+    currentVersion: string;
+    status: "committed" | "rolledBack";
+};
+/**
+ * Schema interface for managing schema evolution.
+ * @template T The type of data associated with the schema.
+ */
+interface Schema<T = any> {
+    /**
+     * Subscribes to schema events. The listener will be called for each event.
+     * @param event The type of schema event to subscribe to.
+     * @param listener The listener function that receives the schema event.
+     * @returns A function that, when called, unsubscribes the listener.
+     */
+    subscribe(event: SchemaEventType, listener: (event: SchemaEvent) => void): () => void;
+    /**
+     * Returns a read-only copy of the schema definition.
+     * @returns A read-only version of the current schema definition.
+     */
+    definition(): Readonly<SchemaDefinition>;
+    /**
+     * Returns a promise that resolves to a read-only copy of the migration history.
+     * @returns A promise that resolves to a read-only array of migrations.
+     */
+    migrations(): Promise<Readonly<Migration<any>[]>>;
+    /**
+     * Exports the schema state (definition and migrations) as a JSON string.
+     * @returns A JSON string representation of the schema state.
+     */
+    export(): string;
+    /**
+     * Imports the schema state (definition and migrations) from a JSON string.
+     * @param json The JSON string representing the schema state to import.
+     * @throws Error if the imported state is invalid.
+     */
+    import(json: string): void;
+    /**
+     * Creates a migration from a list of changes.
+     * @param description A description of the migration.
+     * @param changes A list of schema changes to apply.
+     * @param dryRun Indicates whether the migration should actually be executed
+     * @throws Error if the changes are not valid.
+     * @returns A promise that resolves when the migration is complete.
+     */
+    migrate(description: string, changes: SchemaChange<T>[], dryRun?: boolean): Promise<void>;
+    /**
+     * Rolls back a migration.
+     * @param version The version to rollback from. If not specified, rolls back the last migration.
+     * @throws Error if the rollback cannot be performed.
+     * @returns A promise that resolves when the rollback is complete.
+     */
+    rollback(version?: string): Promise<void>;
+    /**
+     * Creates a migration helper to assist in creating a migration.
+     * @param description A description of the migration.
+     * @returns A `SchemaMigrationHelper` instance to build the migration.
+     */
+    migrationHelper(description: string): SchemaMigrationHelper;
+}
 /**
  * Helper for building schema migrations.
  * @template T The type of data associated with the schema.
@@ -765,6 +857,190 @@ declare enum MigrationErrorCode {
     ROLLBACK_ERROR = "ROLLBACK_ERROR",
     MISSING_TRANSFORM = "MISSING_TRANSFORM"
 }
+/**
+ * @class MigrationEngine
+ * @param {SchemaDefinition} currentSchema - The current schema definition
+ * @param {Array<Migration<any>>} [migrations] - Optional array of migrations
+ * @throws {MigrationError} If the initial schema or migrations are invalid
+ */
+declare class MigrationEngine {
+    private currentSchema;
+    private history;
+    private migrations;
+    private isProcessing;
+    /**
+     * @constructor
+     * @param {SchemaDefinition} currentSchema - The current schema definition
+     * @param {Array<Migration<any>>} [migrations] - Optional array of migrations
+     */
+    constructor(currentSchema: SchemaDefinition, migrations?: Array<Migration<any>>, history?: Array<SchemaDefinition>);
+    /**
+     * Gets the current state of the migration helper
+     * @returns {Object} Current state containing schema, history, and migrations
+     * @example
+     * ```javascript
+     * const state = migrationEngine.data();
+     * // state contains currentSchema, history, and migrations
+     * ```
+     */
+    data(): {
+        schema: SchemaDefinition;
+        history: SchemaDefinition[];
+        migrations: Migration<any>[];
+    };
+    /**
+     * Generates a SHA-256 checksum for a migration
+     * @private
+     * @param {Omit<Migration<any>, "checksum">} migration - The migration object
+     * @returns {Promise<string>} The generated checksum
+     * @throws {MigrationError} If checksum generation fails
+     */
+    private generateChecksum;
+    /**
+     * Adds a new migration to the engine
+     * @async
+     * @param {Object} opts - Options for the new migration
+     * @param {SchemaChange<any>[]} opts.changes - Array of schema changes
+     * @param {string} opts.description - Description of the migration
+     * @param {SchemaChange<any>[]} [opts.rollback] - Optional rollback changes
+     * @param {DataTransform<any, any>} [opts.transform] - Optional data transform
+     * @throws {MigrationError} If adding the migration fails
+     */
+    add(opts: {
+        changes: SchemaChange<any>[];
+        description: string;
+        rollback?: SchemaChange<any>[];
+        transform?: string | DataTransform<any, any>;
+    }): Promise<void>;
+    /**
+     * Performs a dry run of the migration
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @param {version} version - Version to rollback to
+     * @returns {Promise<Object>} Object containing newSchema and dataPreview
+     * @throws {MigrationError} If dry run fails
+     */
+    dryRun(input: ReadableStream<any>, direction: "forward" | "backward", version?: string): Promise<{
+        newSchema: SchemaDefinition;
+        dataPreview: ReadableStream<any>;
+    }>;
+    /**
+     * Gets relevant migrations based on direction
+     * @private
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Array<Migration<any>>} Relevant migrations
+     */
+    private getRelevantMigrations;
+    /**
+     * Applies schema changes to a given schema
+     * @private
+     * @param {SchemaDefinition} schema - The schema to modify
+     * @param {SchemaChange<any>[]} changes - Array of schema changes
+     * @param {string} [migrationId] - ID of the migration
+     * @returns {SchemaDefinition} Modified schema
+     * @throws {MigrationError} If applying changes fails
+     */
+    private applySchemaChanges;
+    /**
+     * Prepares the list of pending migrations for application
+     * @async
+     * @returns {Promise<Array<Migration<any>>} List of pending migrations
+     * @throws {MigrationError} If preparation fails
+     */
+    prepareMigration(): Promise<Array<Migration<any>>>;
+    /**
+     * Applies pending migrations
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {MigrationError} If migration fails
+     */
+    migrate(input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Validates migrations by checking their checksums
+     * @private
+     * @async
+     * @param {Array<Migration<any>>} migrations - Migrations to validate
+     * @throws {MigrationError} If validation fails
+     */
+    private validateMigrations;
+    /**
+     * Marks migrations as applied
+     * @private
+     * @param {Array<Migration<any>>} migrations - Migrations to mark as applied
+     */
+    private markMigrationsApplied;
+    /**
+     * Rolls back the last applied migration
+     * @async
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     */
+    rollback(input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Rolls back to a specific schema version
+     * @async
+     * @param {string} targetVersion - Target schema version
+     * @param {ReadableStream<any>} input - Input data stream
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {Error} If target version is not found
+     */
+    rollbackToVersion(targetVersion: string, input: ReadableStream<any>): Promise<ReadableStream<any>>;
+    /**
+     * Processes a list of migrations on a data stream, applying transformations
+     * in the specified direction (forward or backward).
+     *
+     * @static
+     * @async
+     * @param {ReadableStream<any>} input - The input data stream to process
+     * @param {"forward" | "backward"} direction - Direction of migration (either "forward" or "backward")
+     * @param {Array<Migration<any>>} migrations - Array of Migration objects to process
+     * @returns {Promise<ReadableStream<any>>} Transformed data stream
+     * @throws {MigrationError} If any migration processing fails
+     */
+    static processMigrationList(input: ReadableStream<any>, direction: "forward" | "backward", migrations: Migration<any>[]): Promise<ReadableStream<any>>;
+    /**
+     * Resolves the transform function for a given migration in the specified direction.
+     *
+     * @private
+     * @async
+     * @param {Migration<any>} migration - The migration to resolve the transform for
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If transform resolution fails
+     */
+    private static resolveTransform;
+    /**
+     * Resolves a transform function from a remote URL.
+     *
+     * @private
+     * @async
+     * @param {string} url - URL of the transform module
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If resolution fails
+     */
+    private static resolveRemoteTransform;
+    /**
+     * Resolves a transform function from a local module path.
+     *
+     * @private
+     * @async
+     * @param {string} path - Local module path
+     * @param {"forward" | "backward"} direction - Direction of migration
+     * @returns {Promise<TransformFunction<any, any>>} Resolved transform function
+     * @throws {MigrationError} If resolution fails
+     */
+    private static resolveLocalTransform;
+    /**
+     * Transforms the schema either forward or backward
+     * @private
+     * @param {"forward" | "backward"} direction - Direction of transformation
+     * @throws {Error} If transformation fails
+     */
+    private transformSchema;
+}
 
 /**
  * Helper for building schema migrations with forward and rollback changes.
@@ -1600,4 +1876,8 @@ declare function compareSemanticVersions(a: string, b: string): number;
  */
 declare function sortSemanticVars(vars: string[]): string[];
 
-export { type Constraint, type ConstraintGroup, type ConstraintParameters, type ConstraintsMap, type DataTransform, type FieldDefinition, type FieldType, type FunctionMap, type IndexDefinition, type IndexType, JsonPatchError, type LogicalOperator, type Migration, type MigrationEngine, MigrationError, MigrationErrorCode, type MigrationMetadata, MigrationSchema, type PartialIndexCondition, type PatchOperation, type Persistence, type PersistenceCollection, type PersistenceEvent, type PersistenceEventType, type PersistenceTransaction, type Predicate, type PredicateMap, type PredicateName, type PredicateParameters, type RegistryLock, type RegistryMetadata, type SchemaChange, type SchemaConstraint, type SchemaDefinition, type SchemaIndex, type SchemaMetadata, type SchemaRegistry, type SchemaVersion, type TransformFunction, applyPatch, calculateNextVersion, compareSemanticVersions, createPatch, createSchemaMigrationHelper, createStandardSchemaValidator, deepMerge, generateSHA256Hash, normalizePath, schemaChangeToPatch, schemaToTypes, sortSemanticVars, validate, validateMigration, validateSchemaChange, validateSchemaDefinition };
+declare function docgen(schema: SchemaDefinition, options?: {
+    faker?: Faker;
+}): string;
+
+export { type Constraint, type ConstraintGroup, type ConstraintParameters, type ConstraintsMap, type DataTransform, type FieldDefinition, type FieldType, type FunctionMap, type IndexDefinition, type IndexType, JsonPatchError, type LogicalOperator, type Migration, MigrationEngine, type MigrationEngineInterface, MigrationError, MigrationErrorCode, type MigrationMetadata, MigrationSchema, type PartialIndexCondition, type PatchOperation, type Persistence, type PersistenceCollection, type PersistenceEvent, type PersistenceEventType, type PersistenceTransaction, type Predicate, type PredicateMap, type PredicateName, type PredicateParameters, type RegistryLock, type RegistryMetadata, type Schema, type SchemaChange, type SchemaConstraint, type SchemaDefinition, type SchemaEvent, type SchemaEventType, type SchemaIndex, type SchemaMetadata, type SchemaMigrationHelper, type SchemaRegistry, type SchemaVersion, type TransformFunction, applyPatch, calculateNextVersion, compareSemanticVersions, createPatch, createSchemaMigrationHelper, createStandardSchemaValidator, deepMerge, docgen, generateSHA256Hash, normalizePath, schemaChangeToPatch, schemaToTypes, sortSemanticVars, validate, validateMigration, validateSchemaChange, validateSchemaDefinition };