bun-query-builder 0.1.5 → 0.1.6

package/dist/types.d.ts

@@ -1,127 +1,49 @@
-/**
- * # `TransactionBackoffConfig`
- *
- * Controls exponential backoff between transaction retry attempts.
- *
- * - `baseMs`: Initial delay in milliseconds used for the first retry.
- * - `factor`: Multiplicative growth factor applied per attempt (e.g., 2 = doubles).
- * - `maxMs`: Maximum delay cap in milliseconds; backoff never exceeds this value.
- * - `jitter`: When true, adds a small randomization to the delay to reduce thundering herds.
- *
- * The delay for attempt n (1-indexed) is roughly: min(maxMs, baseMs * factor^(n-1)),
- * optionally adjusted by jitter.
- */
-export declare interface TransactionBackoffConfig {
+export declare type SupportedDialect = 'postgres' | 'mysql' | 'sqlite'
+
+export interface TransactionBackoffConfig {
   baseMs: number
   factor: number
   maxMs: number
   jitter: boolean
 }
-/**
- * # `TransactionDefaultsConfig`
- *
- * Default settings applied to transactional operations.
- *
- * - `retries`: Number of times a transaction may be retried on retriable errors
- *   (e.g., deadlocks, serialization failures).
- * - `isolation`: Transaction isolation level.
- *   - 'read committed': Prevents dirty reads; non-repeatable reads possible.
- *   - 'repeatable read': Ensures stable snapshot for a transaction; phantom reads may vary by DB.
- *   - 'serializable': Highest isolation; transactions appear to run one-by-one.
- * - `sqlStates`: Additional vendor error codes considered retriable.
- * - `backoff`: Backoff configuration applied between retries.
- */
-export declare interface TransactionDefaultsConfig {
+
+export interface TransactionDefaultsConfig {
   retries: number
   isolation?: 'read committed' | 'repeatable read' | 'serializable'
   sqlStates: string[]
   backoff: TransactionBackoffConfig
 }
-/**
- * # `TimestampConfig`
- *
- * Column naming conventions for timestamp fields used by helpers.
- *
- * - `createdAt`: Column name for row creation time (e.g., 'created_at').
- * - `updatedAt`: Column name for last update time (e.g., 'updated_at').
- * - `defaultOrderColumn`: Column used by helpers like `latest()`/`oldest()`.
- */
-export declare interface TimestampConfig {
+
+export interface TimestampConfig {
   createdAt: string
   updatedAt: string
   defaultOrderColumn: string
 }
-/**
- * # `PaginationConfig`
- *
- * Defaults for result pagination helpers.
- *
- * - `defaultPerPage`: Default LIMIT used by paginate helpers when not specified.
- * - `cursorColumn`: Default column used for cursor-based pagination (e.g., 'id').
- */
-export declare interface PaginationConfig {
+
+export interface PaginationConfig {
   defaultPerPage: number
   cursorColumn: string
 }
-/**
- * # `AliasingConfig`
- *
- * Controls how selected columns from joined relations are aliased.
- *
- * - `relationColumnAliasFormat`:
- *   - 'table_column': Aliases as `${table}_${column}` (e.g., `posts_title`).
- *   - 'table.dot.column': Aliases with dot notation (e.g., `posts.title`).
- *   - 'camelCase': Aliases as camelCase from `${table}_${column}` (e.g., `postsTitle`).
- */
-export declare interface AliasingConfig {
+
+export interface AliasingConfig {
   relationColumnAliasFormat: 'table_column' | 'table.dot.column' | 'camelCase'
 }
-/**
- * # `RelationsConfig`
- *
- * Conventions for inferring foreign key names and singularization.
- *
- * - `foreignKeyFormat`:
- *   - 'singularParent_id': Uses `${singular(parent)}_id` (e.g., `user_id`).
- *   - 'parentId': Uses camelCase `parentId` (e.g., `userId`).
- * - `singularizeStrategy`:
- *   - 'stripTrailingS': Naively remove trailing 's' when singularizing (default behavior when enabled elsewhere).
- *   - 'none': Do not singularize relation/table names.
- */
-export declare interface RelationsConfig {
+
+export interface RelationsConfig {
   foreignKeyFormat: 'singularParent_id' | 'parentId'
   singularizeStrategy?: 'stripTrailingS' | 'none'
   maxDepth?: number
   maxEagerLoad?: number
   detectCycles?: boolean
 }
-/**
- * # `SqlConfig`
- *
- * Dialect-specific SQL toggles.
- *
- * - `randomFunction`:
- *   - 'RANDOM()': PostgreSQL/SQLite style function for random ordering.
- *   - 'RAND()': MySQL style function for random ordering.
- * - `sharedLockSyntax`:
- *   - 'FOR SHARE': PostgreSQL style shared lock.
- *   - 'LOCK IN SHARE MODE': MySQL style shared lock.
- * - `jsonContainsMode`:
- *   - 'operator': Use native operators when available (e.g., Postgres `@>`).
- *   - 'function': Use a function-based approach (e.g., `json_contains`) when operators are not available.
- */
-export declare interface SqlConfig {
+
+export interface SqlConfig {
   randomFunction?: 'RANDOM()' | 'RAND()'
   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).
- */
-export declare interface QueryHooks {
+
+export 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
@@ -133,17 +55,12 @@ export declare interface QueryHooks {
   beforeDelete?: (event: { table: string, where?: any }) => void | Promise<void>
   afterDelete?: (event: { table: string, where?: any, result: any }) => void | Promise<void>
 }
-/**
- * # `FeatureToggles`
- *
- * Optional features that may be enabled per instance.
- *
- * - `distinctOn`: Enables PostgreSQL-like `DISTINCT ON (...)` behavior in builders.
- */
-export declare interface FeatureToggles {
+
+export interface FeatureToggles {
   distinctOn: boolean
 }
-export declare interface DatabaseConfig {
+
+export interface DatabaseConfig {
   database: string
   username: string
   password: string
@@ -151,26 +68,13 @@ export declare interface DatabaseConfig {
   url?: string
   port: number
 }
-/**
- * # `QueryBuilderConfig`
- *
- * Global configuration for the query builder.
- *
- * - `verbose`: Enables extra logging/diagnostics from the builder.
- * - `dialect`: Target SQL dialect. See `SupportedDialect` for details.
- * - `timestamps`: Timestamp column naming conventions.
- * - `pagination`: Defaults for pagination helpers.
- * - `aliasing`: How relation columns are aliased in SELECT lists.
- * - `relations`: Foreign key naming and singularization conventions.
- * - `transactionDefaults`: Default retry/backoff/isolation behavior for transactions.
- * - `sql`: Dialect-specific SQL toggles.
- * - `features`: Optional feature flags.
- * - `debug.captureText`: When true, the builder exposes a `toText()` method to capture SQL text in memory for debugging.
- */
-export declare interface QueryBuilderConfig {
+
+export interface QueryBuilderConfig {
   verbose: boolean
   dialect: SupportedDialect
+
   database: DatabaseConfig
+
   timestamps: TimestampConfig
   pagination: PaginationConfig
   aliasing: AliasingConfig
@@ -179,56 +83,51 @@ export declare interface QueryBuilderConfig {
   sql: SqlConfig
   features: FeatureToggles
   debug?: {
-    /** When true, capture query text for debugging via `toText()`. */
     captureText: boolean
   }
   hooks?: QueryHooks
   softDeletes?: {
-    /** When true, apply a default `WHERE deleted_at IS NULL` filter. */
     enabled: boolean
-    /** Column name used for soft delete flag/timestamp. */
     column: string
-    /** When true, default filter is applied unless `.withTrashed()` is called. */
     defaultFilter: boolean
   }
 }
-export declare interface CliOption {
+
+export interface CliOption {
   verbose: boolean
 }
-export declare interface SqlOptions {
+
+export interface SqlOptions {
   limit?: number
 }
-export declare interface WaitReadyOptions {
+
+export interface WaitReadyOptions {
   attempts?: number
   delay?: number
 }
-export declare interface FileOptions {
+
+export interface FileOptions {
   params?: string
 }
-export declare interface IntrospectOptions {
+
+export interface IntrospectOptions {
   verbose?: boolean
 }
-export declare interface MigrateOptions {
+
+export interface MigrateOptions {
   dialect?: SupportedDialect
   state?: string
   apply?: boolean
   full?: boolean
 }
-export declare interface GenerateMigrationResult {
+
+export interface GenerateMigrationResult {
   sql: string
   sqlStatements: string[]
   hasChanges: boolean
   plan: any
 }
-export declare interface UnsafeOptions {
+
+export interface UnsafeOptions {
   params?: string
-}
-/**
- * # `SupportedDialect`
- *
- * The SQL dialect used to tailor generated SQL and certain features.
- * - 'postgres': Uses `RANDOM()`, supports JSON operators (e.g. `@>`), `FOR SHARE`, `FOR UPDATE`, CTEs
- * - 'mysql': Uses `RAND()`, shared locks via `LOCK IN SHARE MODE`
- * - 'sqlite': Lightweight engine; some features are limited or emulated
- */
-export type SupportedDialect = 'postgres' | 'mysql' | 'sqlite'
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-query-builder",
   "type": "module",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A simple yet performant query builder for TypeScript. Built with Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",
@@ -62,15 +62,16 @@
     "lint:fix": "bunx --bun eslint . --fix",
     "changelog": "bunx logsmith --verbose",
     "changelog:generate": "bunx logsmith --output CHANGELOG.md",
-    "release": "bun run changelog:generate && bunx bumpx prompt --recursive",
+    "release": "bun --bun run changelog:generate && bunx --bun bumpx prompt --recursive",
     "dev:docs": "bun --bun vitepress dev docs",
     "build:docs": "bun --bun vitepress build docs",
     "preview:docs": "bun --bun vitepress preview docs",
     "typecheck": "bun --bun tsc"
   },
   "dependencies": {
+    "@stacksjs/clapp": "^0.2.0",
     "@stacksjs/ts-validation": "^0.4.7",
-    "ts-mocker": "^0.1.3"
+    "ts-mocker": "^0.1.5"
   },
   "devDependencies": {
     "bunfig": "^0.15.0"