bun-query-builder 0.2.58 → 0.2.60

package/dist/client.d.ts

@@ -128,6 +128,24 @@ declare interface RawExpression {
 export declare interface WhereRaw {
   raw: SqlFragment
 }
+/**
+ * # `PaginateOptions`
+ *
+ * The unambiguous spelling of a paginate() call.
+ *
+ * `db.selectFrom(t).paginate(perPage, page)` and `Model.query().paginate(page,
+ * perPage)` take the same two numbers in opposite orders, and both parameters
+ * are `number` — so transposing them is not a type error, it just returns a
+ * different page. Passing this object instead says which is which.
+ *
+ * Both APIs accept it and both keep their positional forms, so this adds a
+ * safe spelling without moving anyone's existing call. See #1092.
+ */
+export declare interface PaginateOptions {
+  perPage?: number
+  page?: number
+  tx?: { unsafe: (sql: string, params?: unknown[]) => unknown }
+}
 export declare interface BaseSelectQueryBuilder<DB extends AnyDatabaseSchema, TTable extends keyof DB & string, TSelected, TJoined extends string = TTable,> {
   distinct: () => SelectQueryBuilder<DB, TTable, TSelected, TJoined>
   distinctOn: (...columns: (keyof DB[TTable]['columns'] & string | string)[]) => SelectQueryBuilder<DB, TTable, TSelected, TJoined>
@@ -279,7 +297,7 @@ export declare interface BaseSelectQueryBuilder<DB extends AnyDatabaseSchema, TT
   explain: () => Promise<Record<string, unknown>[]>
   simple: () => unknown
   toText?: () => string
-  paginate: (perPage: number, page?: number, opts?: { tx?: { unsafe: (sql: string, params?: unknown[]) => unknown } }) => Promise<{ data: SelectedRow<DB, TTable, TSelected>[], meta: { perPage: number, page: number, total: number, lastPage: number } }>
+  paginate: ((perPage: number, page?: number, opts?: { tx?: { unsafe: (sql: string, params?: unknown[]) => unknown } }) => Promise<{ data: SelectedRow<DB, TTable, TSelected>[], meta: { perPage: number, page: number, total: number, lastPage: number } }>) & ((options: PaginateOptions) => Promise<{ data: SelectedRow<DB, TTable, TSelected>[], meta: { perPage: number, page: number, total: number, lastPage: number } }>)
   simplePaginate: (perPage: number, page?: number) => Promise<{ data: SelectedRow<DB, TTable, TSelected>[], meta: { perPage: number, page: number, hasMore: boolean } }>
   toSQL: () => string
   execute: () => Promise<SelectedRow<DB, TTable, TSelected>[]>

package/dist/orm.d.ts

@@ -1,5 +1,6 @@
 import { Database, type SQLQueryBindings } from 'bun:sqlite';
 import type { FactoryFaker } from './faker-compat';
+import type { PaginateOptions } from './client';
 import type { RelationCardinality } from './type-inference';
 import type { SupportedDialect } from './types';
 export type {
@@ -508,7 +509,7 @@ export type ModelStatic<TDef extends ModelDefinition> = StaticWhereOverloads<TDe
   count: () => Promise<number>
   exists: () => Promise<boolean>
   doesntExist: () => Promise<boolean>
-  paginate: (page?: number, perPage?: number) => Promise<{
+  paginate: (page?: number | PaginateOptions, perPage?: number) => Promise<{
     data: ModelRecord<TDef>[]
     total: number
     page: number
@@ -680,7 +681,7 @@ declare class ModelQueryBuilder<TDef extends ModelDefinition, TSelected extends
   increment<K extends NumericColumns<TDef>>(column: K, amount?: number): Promise<number>;
   decrement<K extends NumericColumns<TDef>>(column: K, amount?: number): Promise<number>;
   chunk(size: number, callback: (items: ModelInstance<TDef, TSelected>[]) => void | false | Promise<void | false>): Promise<void>;
-  paginate(page?: number, perPage?: number): Promise<{
+  paginate(page?: number | PaginateOptions, perPage?: number): Promise<{
     data: ModelInstance<TDef, TSelected>[]
     total: number
     page: number
@@ -690,6 +691,7 @@ declare class ModelQueryBuilder<TDef extends ModelDefinition, TSelected extends
     isEmpty: boolean
     from: number | null
     to: number | null
+    meta: { perPage: number, page: number, total: number, lastPage: number }
   }>;
   pluck<K extends ColumnName<TDef>>(column: K): Promise<(K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : unknown)[]>;
   max<K extends ColumnName<TDef>>(column: K): Promise<(K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : number) | null>;

package/dist/sql-fragments.d.ts

@@ -52,6 +52,28 @@ export declare function renderInPredicate(column: string, values: readonly unkno
  * to apply unconditionally.
  */
 export declare function toDialectPlaceholders(sql: string, dialect: SupportedDialect): string;
+/* … *\/` block comments, which nest
+ *  - `$$…$$` / `$tag$…$tag$` dollar-quoted strings, without mistaking a `$1`
+ *    placeholder for the start of one
+ *
+ * Backslash escapes inside a literal are deliberately NOT honoured. Whether
+ * `'a\'` ends the string depends on the dialect and, on Postgres, on a server
+ * setting — so this matches the standard (and what the previous literal-aware
+ * scanner did) rather than inventing a rule that would be wrong somewhere.
+ *
+ * A keyword must be preceded by a non-word character, and never matches at
+ * index 0: a statement that opens with a clause keyword has nothing before it
+ * for the clause to attach to.
+ *
+ * @param sql the statement to scan
+ * @param keywords patterns to look for. Each MUST carry the sticky (`y`) flag;
+ *   they are matched at a position rather than against a slice, and are tried
+ *   in the order given — so longer keywords must come before any single-word
+ *   prefix of them (`ORDER BY` before a hypothetical `ORDER`).
+ * @param limit stop after this many hits. Callers that only want the first
+ *   clause boundary pass 1 rather than scanning the rest of the statement.
+ */
+export declare function scanTopLevelKeywords(sql: string, keywords: ReadonlyArray<{ key: string, pattern: RegExp }>, limit?: unknown): TopLevelKeyword[];
 /**
  * Constant predicates, for the cases where a collection is empty.
  *
@@ -87,3 +109,11 @@ export declare interface WhereTerm {
   conn: 'AND' | 'OR'
   sql: string
 }
+/**
+ * A top-level keyword found by {@link scanTopLevelKeywords}.
+ */
+export declare interface TopLevelKeyword {
+  key: string
+  start: number
+  length: number
+}

package/dist/src/browser.js

@@ -1,2 +1,2 @@
 // @bun
-import{Mb as a,Nb as b,Ob as c,Pb as d,Qb as e,Rb as f,Sb as g,Tb as h,Ub as i,Vb as j,Wb as k}from"../chunk-asdkg5va.js";import"../chunk-739qq8wk.js";k();export{c as isBrowser,b as getBrowserConfig,j as default,h as createBrowserModel,g as createBrowserDb,a as configureBrowser,f as browserQuery,i as browserAuth,d as BrowserQueryError,e as BrowserQueryBuilder};
+import{Mb as a,Nb as b,Ob as c,Pb as d,Qb as e,Rb as f,Sb as g,Tb as h,Ub as i,Vb as j,Wb as k}from"../chunk-mvk2rcqm.js";import"../chunk-fn0m2c0v.js";k();export{e as BrowserQueryBuilder,d as BrowserQueryError,i as browserAuth,f as browserQuery,a as configureBrowser,g as createBrowserDb,h as createBrowserModel,j as default,b as getBrowserConfig,c as isBrowser};

package/dist/src/dynamodb/index.js

@@ -1,2 +1,2 @@
 // @bun
-import{$b as c,Zb as a,_b as b,ac as d,bc as e,cc as f,dc as g,ec as h,fc as i,gc as j,hc as k,ic as l,jc as m,kc as n,lc as o,mc as p,nc as q,oc as r}from"../../chunk-j9778t8e.js";import"../../chunk-739qq8wk.js";export{o as migrateModels,j as isDefinitionEqual,e as hashTableDefinition,f as extractTableDefinition,g as extractModelSchema,q as dynamo,n as createMigrationDriver,r as createDynamo,b as createClient,h as convertSchemaToDefinition,c as configureModels,i as buildDynamoDBMigrationPlan,d as Model,k as MIGRATIONS_TABLE,p as EntityQueryBuilder,l as DynamoDBMigrationTracker,m as DynamoDBMigrationDriver,a as DynamoDBClient};
+import{$b as c,Zb as a,_b as b,ac as d,bc as e,cc as f,dc as g,ec as h,fc as i,gc as j,hc as k,ic as l,jc as m,kc as n,lc as o,mc as p,nc as q,oc as r}from"../../chunk-mjedm810.js";import"../../chunk-fn0m2c0v.js";export{a as DynamoDBClient,m as DynamoDBMigrationDriver,l as DynamoDBMigrationTracker,p as EntityQueryBuilder,k as MIGRATIONS_TABLE,d as Model,i as buildDynamoDBMigrationPlan,c as configureModels,h as convertSchemaToDefinition,b as createClient,r as createDynamo,n as createMigrationDriver,q as dynamo,g as extractModelSchema,f as extractTableDefinition,e as hashTableDefinition,j as isDefinitionEqual,o as migrateModels};

package/dist/src/index.js

@@ -1,2 +1,2 @@
 // @bun
-import{$,$a as hb,A,Aa as za,Ab as _b,B,Ba as Ja,Bb as $b,C,Ca as Ka,Cb as ac,D,Da as La,Db as bc,E,Ea as Ma,Eb as cc,F,Fa as Na,Fb as dc,G,Ga as Oa,Gb as ec,H,Ha as Pa,Hb as fc,I,Ia as Qa,Ib as gc,J,Ja as Ra,Jb as hc,K,Ka as Sa,Kb as ic,L,La as Ta,Lb as jc,M,Ma as Ua,N,Na as Va,O,Oa as Wa,P,Pa as Xa,Q,Qa as Ya,R,Ra as Za,S,Sa as _a,T,Ta as $a,U,Ua as ab,V,Va as bb,W,Wa as cb,X,Xa as db,Y,Ya as eb,Z,Za as fb,_,_a as gb,a,aa,ab as ib,b,ba,bb as jb,c,ca as ea,cb as kb,d,da as fa,db as lb,e,ea as ga,eb as mb,f,fa as ha,fb as nb,g,ga as ia,gb as ob,h,hb as pb,i,ib as qb,j,jb as rb,k,ka as ja,kb as sb,l,la as ka,lb as tb,m,ma as la,mb as Mb,n,na as ma,nb as Nb,o,oa as na,ob as Ob,p,pa as oa,pb as Pb,q,qa as pa,qb as Qb,r,ra as qa,rb as Rb,s,sa as ra,sb as Sb,t,ta as sa,tb as Tb,u,ua as ta,ub as Ub,v,va as ua,vb as Vb,w,wa as va,wb as Wb,x,xa as wa,xb as Xb,y,ya as xa,yb as Yb,z,za as ya,zb as Zb}from"../chunk-1mmf5p5n.js";import{Mb as Aa,Nb as Ba,Ob as Ca,Pb as Da,Qb as Ea,Rb as Fa,Sb as Ga,Tb as Ha,Ub as Ia}from"../chunk-asdkg5va.js";import{$b as wb,Xb as ca,Yb as da,Zb as ub,_b as vb,ac as xb,bc as yb,cc as zb,dc as Ab,ec as Bb,fc as Cb,gc as Db,hc as Eb,ic as Fb,jc as Gb,kc as Hb,lc as Ib,mc as Jb,nc as Kb,oc as Lb}from"../chunk-j9778t8e.js";import"../chunk-739qq8wk.js";export{O as wipeDatabase,za as waitReady,xa as validateSchema,wa as unsafe,pb as unmarshallItem,o as toTableName,nb as toModelInstance,mb as toDynamoDBItem,v as toDialectPlaceholders,H as tinker,y as temporalLiteral,p as tableNameFor,S as tableInfo,q as stripTrailingS,G as startConsole,tb as stacksModelToEntity,U as sqlTypeToAttr,va as sql,s as singularizerFor,na as showModel,C as setQueryCacheMaxSize,h as setConfig,Sa as seedModel,fa as saveMigrationSnapshot,hc as satisfies,ra as runSeeders,sa as runSeeder,n as runBenchmark,k as resolveSqlitePragmas,t as resolvePivot,kb as resolveKeyPattern,d as resolveDialect,ia as resetDatabase,m as resetConnection,qa as relationDiagram,Ya as registerModel,_a as registerBrowserModels,w as raw,x as quoteColumnForDialect,pa as queryExplainAll,oa as ping,lb as parseStacksModels,N as optimizeDatabase,na as modelShow,V as modelNameForTable,Sb as migrationBody,la as migrateStatus,ka as migrateRollback,Ib as migrateModels,ma as migrateList,ja as migrateGenerate,ob as marshallObject,ta as makeSeeder,Y as makeModel,Nb as loadModels,Pb as lastCreatedMigrationFiles,u as iterateAllPivots,a as isMysqlLike,Tb as isLosslessTypeChange,Rb as isGeneratedMigrationSql,Db as isDefinitionEqual,Ca as isBrowser,X as introspectDatabase,T as introspect,R as inspectTable,r as inflectSingular,J as importData,yb as hashTableDefinition,Yb as hashMigrationPlan,Wa as hasModel,f as getPlaceholders,e as getPlaceholder,Va as getModelRegistry,Ta as getModel,ea as getDialectDriver,Oa as getDatabase,g as getConfig,Ba as getBrowserConfig,Ua as getAllModels,Wb as generateSqlString,Vb as generateSql,W as generateModelSource,ga as generateMigration,Xb as generateDiffSqlString,bc as generateDiffSql,ac as generateDiffOperations,qa as generateDiagram,sb as generateAccessPatterns,ua as freshDatabase,jc as formatSchemaDrift,Q as file,gc as familyOfSqlType,fc as familyOfDeclared,zb as extractTableDefinition,Ab as extractModelSchema,Ma as extractInsertId,La as extractChanges,I as exportData,pa as explainAllQueries,P as explain,ha as executeMigration,z as escapeStringLiteral,Kb as dynamo,K as dumpDatabase,ec as defineSeeder,cc as defineModels,Za as defineModel,i as defineConfig,b as defaultConfig,O as dbWipe,M as dbStats,N as dbOptimize,L as dbInfo,Ra as createTableFromModel,hb as createSingleTableManager,ib as createRepository,A as createQueryBuilder,Qa as createModel,Hb as createMigrationDriver,Ja as createFakerCompatLayer,rb as createDynamoDBToolingAdapter,bb as createDynamoDBQueryBuilder,cb as createDynamoDBItemBuilder,da as createDynamoDBDriver,db as createDynamoDBClient,Lb as createDynamo,vb as createClient,Ha as createBrowserModel,Ga as createBrowserDb,Bb as convertSchemaToDefinition,Na as configureOrm,wb as configureModels,Aa as configureBrowser,c as config,B as clearQueryCache,Xa as clearModelRegistry,Ka as clearLocalModels,ya as checkSchema,$b as canonicalizeDefault,Zb as canonicalStorageType,E as cacheStats,F as cacheConfig,D as cacheClear,Ob as buildSchemaMeta,Ub as buildMigrationPlan,Cb as buildDynamoDBMigrationPlan,Mb as buildDatabaseSchema,Fa as browserQuery,Ia as browserAuth,ic as auditSchemaDrift,l as applySqliteBootstrapPragmas,aa as VitessDriver,_b as UTC_CLOCK_DEFAULT,fb as SingleTableRepository,gb as SingleTableQueryBuilder,jb as SingleTablePatterns,eb as SingleTableManager,$ as SingleStoreDriver,dc as Seeder,ba as SQLiteDriver,_ as PostgresDriver,Z as MySQLDriver,xb as Model,Eb as MIGRATIONS_TABLE,Qb as GENERATED_MARKER,Jb as EntityQueryBuilder,qb as DynamoDBToolingAdapter,$a as DynamoDBQueryBuilder,Fb as DynamoDBMigrationTracker,Gb as DynamoDBMigrationDriver,ab as DynamoDBItemBuilder,ca as DynamoDBDriverImpl,ub as DynamoDBClient,j as DEFAULT_SQLITE_PRAGMAS,Da as BrowserQueryError,Ea as BrowserQueryBuilder,Pa as BelongsToManyRelationBuilder};
+import{$ as aa,$a as ib,A,Aa,Ab as $b,B,Ba as Ka,Bb as ac,C,Ca as La,Cb as bc,D,Da as Ma,Db as cc,E,Ea as Na,Eb as dc,F,Fa as Oa,Fb as ec,G,Ga as Pa,Gb as fc,H,Ha as Qa,Hb as gc,I,Ia as Ra,Ib as hc,J,Ja as Sa,Jb as ic,K,Ka as Ta,Kb as jc,L,La as Ua,Lb as kc,M,Ma as Va,N,Na as Wa,O,Oa as Xa,P,Pa as Ya,Q,Qa as Za,R,Ra as _a,S,Sa as $a,T,Ta as ab,U,Ua as bb,V,Va as cb,W,Wa as db,X,Xa as eb,Y,Ya as fb,Z,Za as gb,_,_a as hb,a,aa as ba,ab as jb,b,ba as ca,bb as kb,c,ca as fa,cb as lb,d,da as ga,db as mb,e,ea as ha,eb as nb,f,fa as ia,fb as ob,g,ga as ja,gb as pb,h,hb as qb,i,ib as rb,j,jb as sb,k,ka,kb as tb,l,la,lb as ub,m,ma,mb as Nb,n,na,nb as Ob,o,oa,ob as Pb,p,pa,pb as Qb,q,qa,qb as Rb,r,ra,rb as Sb,s,sa,sb as Tb,t,ta,tb as Ub,u,ua,ub as Vb,v,va,vb as Wb,w,wa,wb as Xb,x,xa,xb as Yb,y,ya,yb as Zb,z,za,zb as _b}from"../chunk-vw813qrt.js";import{Mb as Ba,Nb as Ca,Ob as Da,Pb as Ea,Qb as Fa,Rb as Ga,Sb as Ha,Tb as Ia,Ub as Ja}from"../chunk-mvk2rcqm.js";import{$b as xb,Xb as da,Yb as ea,Zb as vb,_b as wb,ac as yb,bc as zb,cc as Ab,dc as Bb,ec as Cb,fc as Db,gc as Eb,hc as Fb,ic as Gb,jc as Hb,kc as Ib,lc as Jb,mc as Kb,nc as Lb,oc as Mb}from"../chunk-mjedm810.js";import"../chunk-fn0m2c0v.js";export{Qa as BelongsToManyRelationBuilder,Fa as BrowserQueryBuilder,Ea as BrowserQueryError,j as DEFAULT_SQLITE_PRAGMAS,vb as DynamoDBClient,da as DynamoDBDriverImpl,bb as DynamoDBItemBuilder,Hb as DynamoDBMigrationDriver,Gb as DynamoDBMigrationTracker,ab as DynamoDBQueryBuilder,rb as DynamoDBToolingAdapter,Kb as EntityQueryBuilder,Rb as GENERATED_MARKER,Fb as MIGRATIONS_TABLE,yb as Model,Z as MySQLDriver,_ as PostgresDriver,ca as SQLiteDriver,ec as Seeder,aa as SingleStoreDriver,fb as SingleTableManager,kb as SingleTablePatterns,hb as SingleTableQueryBuilder,gb as SingleTableRepository,$b as UTC_CLOCK_DEFAULT,ba as VitessDriver,l as applySqliteBootstrapPragmas,jc as auditSchemaDrift,Ja as browserAuth,Ga as browserQuery,Nb as buildDatabaseSchema,Db as buildDynamoDBMigrationPlan,Vb as buildMigrationPlan,Pb as buildSchemaMeta,D as cacheClear,F as cacheConfig,E as cacheStats,_b as canonicalStorageType,ac as canonicalizeDefault,za as checkSchema,La as clearLocalModels,Ya as clearModelRegistry,B as clearQueryCache,c as config,Ba as configureBrowser,xb as configureModels,Oa as configureOrm,Cb as convertSchemaToDefinition,Ha as createBrowserDb,Ia as createBrowserModel,wb as createClient,Mb as createDynamo,eb as createDynamoDBClient,ea as createDynamoDBDriver,db as createDynamoDBItemBuilder,cb as createDynamoDBQueryBuilder,sb as createDynamoDBToolingAdapter,Ka as createFakerCompatLayer,Ib as createMigrationDriver,Ra as createModel,A as createQueryBuilder,jb as createRepository,ib as createSingleTableManager,Sa as createTableFromModel,L as dbInfo,N as dbOptimize,M as dbStats,O as dbWipe,b as defaultConfig,i as defineConfig,_a as defineModel,dc as defineModels,fc as defineSeeder,K as dumpDatabase,Lb as dynamo,z as escapeStringLiteral,ia as executeMigration,P as explain,qa as explainAllQueries,I as exportData,Ma as extractChanges,Na as extractInsertId,Bb as extractModelSchema,Ab as extractTableDefinition,gc as familyOfDeclared,hc as familyOfSqlType,Q as file,kc as formatSchemaDrift,va as freshDatabase,tb as generateAccessPatterns,ra as generateDiagram,bc as generateDiffOperations,cc as generateDiffSql,Yb as generateDiffSqlString,ha as generateMigration,W as generateModelSource,Wb as generateSql,Xb as generateSqlString,Va as getAllModels,Ca as getBrowserConfig,g as getConfig,Pa as getDatabase,fa as getDialectDriver,Ua as getModel,Wa as getModelRegistry,e as getPlaceholder,f as getPlaceholders,Xa as hasModel,Zb as hashMigrationPlan,zb as hashTableDefinition,J as importData,r as inflectSingular,R as inspectTable,T as introspect,X as introspectDatabase,Da as isBrowser,Eb as isDefinitionEqual,Sb as isGeneratedMigrationSql,Ub as isLosslessTypeChange,a as isMysqlLike,u as iterateAllPivots,Qb as lastCreatedMigrationFiles,Ob as loadModels,Y as makeModel,ua as makeSeeder,pb as marshallObject,ka as migrateGenerate,na as migrateList,Jb as migrateModels,la as migrateRollback,ma as migrateStatus,Tb as migrationBody,V as modelNameForTable,oa as modelShow,N as optimizeDatabase,mb as parseStacksModels,pa as ping,qa as queryExplainAll,x as quoteColumnForDialect,w as raw,$a as registerBrowserModels,Za as registerModel,ra as relationDiagram,m as resetConnection,ja as resetDatabase,d as resolveDialect,lb as resolveKeyPattern,t as resolvePivot,k as resolveSqlitePragmas,n as runBenchmark,ta as runSeeder,sa as runSeeders,ic as satisfies,ga as saveMigrationSnapshot,Ta as seedModel,h as setConfig,C as setQueryCacheMaxSize,oa as showModel,s as singularizerFor,wa as sql,U as sqlTypeToAttr,ub as stacksModelToEntity,G as startConsole,q as stripTrailingS,S as tableInfo,p as tableNameFor,y as temporalLiteral,H as tinker,v as toDialectPlaceholders,nb as toDynamoDBItem,ob as toModelInstance,o as toTableName,qb as unmarshallItem,xa as unsafe,ya as validateSchema,Aa as waitReady,O as wipeDatabase};

package/package.json

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