feat(utils): improve pragma type

Author: subframe7536

packages/sqlite-utils/README.md

@@ -12,23 +12,23 @@ function createKyselyLogger(options: LoggerOptions): (event: LogEvent) => void
 function savePoint(db: Kysely<any> | Transaction<any>, name?: string): Promise<SavePoint>
 
 // run with savepoint, auto release or rollback
-function runWithSavePoint< DB extends Kysely<any> | Transaction<any>, O,>(
+function runWithSavePoint<DB extends Kysely<any> | Transaction<any>, O>(
   db: Kysely<any> | Transaction<any>,
   fn: (db: DB) => Promise<O>,
   name?: string
 ): Promise<O>
 
 // check integrity (`integrity_check` pragma)
-function checkIntegrity(db: Kysely<any>): Promise<boolean>
+function checkIntegrity(db: DatabaseConnection | Kysely<any> | Transaction<any>): Promise<boolean>
 
 // get or set db version (`user_version` pragma)
-function getOrSetDBVersion(db: Kysely<any>, version?: number): Promise<number>
+function getOrSetDBVersion(db: DatabaseConnection | Kysely<any> | Transaction<any>, version?: number): Promise<number>
 
 // optimize pragma (typesafe `journal_mode`, `synchoronous`...)
-function optimzePragma(conn: DatabaseConnection, options?: OptimizePragmaOptions): Promise<void>
+function optimzePragma(conn: DatabaseConnection | Kysely<any> | Transaction<any>, options?: OptimizePragmaOptions): Promise<void>
 
 // control whether to enable foreign keys, **no param check**
-export async function foreignKeys(db: Kysely<any>, enable: boolean): Promise<void>
+export async function foreignKeys(db: DatabaseConnection | Kysely<any> | Transaction<any>, enable: boolean): Promise<void>
 
 // precompile querys for performance
 function precompileQuery<O>(

packages/sqlite-utils/src/pragma.ts

@@ -1,10 +1,12 @@
 import { CompiledQuery } from 'kysely'
 import type { DatabaseConnection, Kysely, Transaction } from 'kysely'
 
+type Executor = DatabaseConnection | Kysely<any> | Transaction<any>
+
 /**
- * check integrity_check pragma, **no param check**
+ * check integrity_check pragma
  */
-export async function checkIntegrity(db: Kysely<any>): Promise<boolean> {
+export async function checkIntegrity(db: Executor): Promise<boolean> {
   const { rows } = await db.executeQuery(CompiledQuery.raw('PRAGMA integrity_check'))
   if (!rows.length) {
     throw new Error('fail to check integrity')
@@ -16,15 +18,15 @@ export async function checkIntegrity(db: Kysely<any>): Promise<boolean> {
 /**
  * control whether to enable foreign keys, **no param check**
  */
-export async function foreignKeys(db: Kysely<any>, enable: boolean): Promise<void> {
+export async function foreignKeys(db: Executor, enable: boolean): Promise<void> {
   await db.executeQuery(CompiledQuery.raw(`PRAGMA foreign_keys = ${enable}`))
 }
 
 /**
  * get or set user_version pragma, **no param check**
  */
 export async function getOrSetDBVersion(
-  db: Kysely<any>,
+  db: Executor,
   version?: number,
 ): Promise<number> {
   if (version) {
@@ -84,7 +86,7 @@ export type OptimizePragmaOptions = {
  * @param options pragma options, {@link OptimizePragmaOptions details}
  */
 export async function optimizePragma(
-  db: DatabaseConnection | Kysely<any> | Transaction<any>,
+  db: Executor,
   options: OptimizePragmaOptions = {},
 ) {
   const entries = Object.entries({