/**
 * @copyright Sister Software
 * @license AGPL-3.0
 * @author Teffen Ellis, et al.
 */

import type { DatabaseSync } from "node:sqlite"

import type { DatabaseConnection } from "kysely"

/**
 * Config for the SQLite dialect.
 */
export interface SqliteDialectConfig {
	/**
	 * A node:sqlite DatabaseSync instance or a function that returns one.
	 *
	 * If a function is provided, it's called once when the first query is executed.
	 *
	 * https://nodejs.org/api/sqlite.html#class-databasesync
	 */
	database: InstanceType<typeof DatabaseSync> | (() => Promise<InstanceType<typeof DatabaseSync>>)

	/**
	 * Called once when the first query is executed.
	 *
	 * This is a Kysely specific feature and does not come from the `node:sqlite` module.
	 */
	onCreateConnection?: (connection: DatabaseConnection) => Promise<void>
}