bun-query-builder 0.2.43 → 0.2.45

package/dist/types.d.ts

@@ -134,25 +134,25 @@ export declare interface SqlConfig {
   sharedLockSyntax?: 'FOR SHARE' | 'LOCK IN SHARE MODE'
   jsonContainsMode?: 'operator' | 'function'
 }
-/**
- * # `QueryHooks`
- *
- * Optional lifecycle hooks around query execution. These are invoked for any
- * statement executed through the builder (select/insert/update/delete/raw).
- */
+/** Common fields on every query lifecycle event. */
+export declare interface QueryEvent {
+  sql: string
+  params?: QueryParam[]
+  kind?: QueryKind
+}
 export declare interface QueryHooks {
-  onQueryStart?: (event: { sql: string, params?: any[], kind?: 'select' | 'insert' | 'update' | 'delete' | 'raw' }) => void
-  onQueryEnd?: (event: { sql: string, params?: any[], durationMs: number, rowCount?: number, kind?: 'select' | 'insert' | 'update' | 'delete' | 'raw' }) => void
-  onQueryError?: (event: { sql: string, params?: any[], error: any, durationMs: number, kind?: 'select' | 'insert' | 'update' | 'delete' | 'raw' }) => void
-  startSpan?: (event: { sql: string, params?: any[], kind?: 'select' | 'insert' | 'update' | 'delete' | 'raw' }) => { end: (error?: any) => void }
+  onQueryStart?: (event: QueryEvent) => void
+  onQueryEnd?: (event: QueryEvent & { durationMs: number, rowCount?: number }) => void
+  onQueryError?: (event: QueryEvent & { error: unknown, durationMs: number }) => void
+  startSpan?: (event: QueryEvent) => { end: (error?: unknown) => void }
   slowQueryThresholdMs?: number
-  onSlowQuery?: (event: { sql: string, params?: any[], durationMs: number, kind?: 'select' | 'insert' | 'update' | 'delete' | 'raw' }) => void
-  beforeCreate?: (event: { table: string, data: any }) => void | Promise<void>
-  afterCreate?: (event: { table: string, data: any, result: any }) => void | Promise<void>
-  beforeUpdate?: (event: { table: string, data: any, where?: any }) => void | Promise<void>
-  afterUpdate?: (event: { table: string, data: any, where?: any, result: any }) => void | Promise<void>
-  beforeDelete?: (event: { table: string, where?: any }) => void | Promise<void>
-  afterDelete?: (event: { table: string, where?: any, result: any }) => void | Promise<void>
+  onSlowQuery?: (event: QueryEvent & { durationMs: number }) => void
+  beforeCreate?: (event: { table: string, data: QueryRecord }) => void | Promise<void>
+  afterCreate?: (event: { table: string, data: QueryRecord, result: unknown }) => void | Promise<void>
+  beforeUpdate?: (event: { table: string, data: QueryRecord, where?: QueryWhere }) => void | Promise<void>
+  afterUpdate?: (event: { table: string, data: QueryRecord, where?: QueryWhere, result: unknown }) => void | Promise<void>
+  beforeDelete?: (event: { table: string, where?: QueryWhere }) => void | Promise<void>
+  afterDelete?: (event: { table: string, where?: QueryWhere, result: unknown }) => void | Promise<void>
 }
 /**
  * # `FeatureToggles`
@@ -208,7 +208,7 @@ export declare interface BrowserConfig {
   onUnauthorized?: () => void
   headers?: Record<string, string>
   timeout?: number
-  transformResponse?: <T>(response: any) => T
+  transformResponse?: <T>(response: unknown) => T
   transformRequest?: <T>(data: T) => any
 }
 /**
@@ -284,7 +284,7 @@ export declare interface GenerateMigrationResult {
   sql: string
   sqlStatements: string[]
   hasChanges: boolean
-  plan: any
+  plan: import('./migrations').MigrationPlan
   operations?: import('./migrations').MigrationOperation[]
 }
 export declare interface UnsafeOptions {
@@ -309,6 +309,20 @@ export declare interface UnsafeOptions {
  * - 'browser': Browser-compatible mode that uses fetch() API calls instead of direct database connections
  */
 export type SupportedDialect = 'postgres' | 'mysql' | 'singlestore' | 'vitess' | 'sqlite' | 'browser';
+/**
+ * # `QueryHooks`
+ *
+ * Optional lifecycle hooks around query execution. These are invoked for any
+ * statement executed through the builder (select/insert/update/delete/raw).
+ */
+/** A bound statement parameter: whatever a driver will accept as a value. */
+export type QueryParam = string | number | bigint | boolean | Date | Uint8Array | null;
+/** The kind of statement a hook is reporting on. */
+export type QueryKind = 'select' | 'insert' | 'update' | 'delete' | 'raw';
+/** The row shape a hook sees. Columns are unknown until the caller narrows. */
+export type QueryRecord = Record<string, unknown>;
+/** A `where` description as the mutation hooks receive it. */
+export type QueryWhere = Record<string, unknown>;
 /**
  * # `DeepPartial`
  *
@@ -340,7 +354,7 @@ export type SupportedDialect = 'postgres' | 'mysql' | 'singlestore' | 'vitess' |
  *     signature is not a property. `keyof (() => void)` is `never`, so the
  *     hook collapses to an empty object type: no longer callable, and loose
  *     enough to accept `42`. It also erases type parameters, which would turn
- *     `BrowserConfig.transformResponse` (`<T>(response: any) => T`) into a
+ *     `BrowserConfig.transformResponse` (`<T>(response: unknown) => T`) into a
  *     shape with no signature at all. A hook or a token getter is a leaf.
  *
  *  2. ARRAYS SECOND, because the merge replaces them rather than merging them.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-query-builder",
   "type": "module",
-  "version": "0.2.43",
+  "version": "0.2.45",
   "description": "A simple yet performant query builder for TypeScript. Built with Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",