workers-qb 1.10.0 → 1.10.2

package/README.md

@@ -1,8 +1,14 @@
 <div align="center">
-  <h1>workers-qb</h1>
-  <p><em>Zero-dependency Query Builder for Cloudflare Workers</em></p>
+  <a href="https://workers-qb.massadas.com/">
+    <img src="https://raw.githubusercontent.com/G4brym/workers-qb/refs/heads/main/docs/assets/logo.png" width="500" height="auto" alt="workers-qb"/>
+  </a>
+</div>
+
+<p align="center">
+    <em>Zero-dependency Query Builder for Cloudflare Workers</em>
+</p>
 
-  <p>
+<p align="center">
     <a href="https://workers-qb.massadas.com/" target="_blank">
       <img src="https://img.shields.io/badge/docs-workers--qb-blue.svg" alt="Documentation">
     </a>
@@ -12,8 +18,7 @@
     <a href="https://github.com/G4brym/workers-qb/blob/main/LICENSE" target="_blank">
       <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="Software License">
     </a>
-  </p>
-</div>
+</p>
 
 ## Overview
 
@@ -178,7 +183,7 @@ Visit our [comprehensive documentation](https://workers-qb.massadas.com/) for de
 - [Advanced Queries](https://workers-qb.massadas.com/advanced-queries/)
 - [Migrations](https://workers-qb.massadas.com/migrations/)
 - [Type Checking](https://workers-qb.massadas.com/type-check/)
-- [Database-specific guides](https://workers-qb.massadas.com/databases/)
+- [Database-specific guides](https://workers-qb.massadas.com/databases/d1)
 
 ## Contributing
 

package/dist/index.d.mts

@@ -95,9 +95,9 @@ type RawQueryFetchAll = Omit<RawQuery, 'fetchType'> & {
     fetchType: FetchTypes.ALL;
 };
 type RawQueryWithoutFetching = Omit<RawQuery, 'fetchType'>;
-type SelectAll<IsLazy extends true | undefined = undefined> = SelectOne & {
+type SelectAll = SelectOne & {
     limit?: number;
-    lazy?: IsLazy;
+    lazy?: boolean;
 };
 type ConflictUpsert = {
     column: string | Array<string>;
@@ -166,17 +166,17 @@ type PGResult = {
     lastRowId?: string | number;
     rowCount: number;
 };
-type IterableResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IsLazy extends true ? IsAsync extends true ? Promise<Merge<ResultWrapper, {
+type IterableResult<ResultWrapper, Result, IsAsync extends boolean> = IsAsync extends true ? Promise<Merge<ResultWrapper, {
     results?: AsyncIterable<Result>;
 }>> : Merge<ResultWrapper, {
     results?: Iterable<Result>;
-}> : never;
-type FullArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IsLazy extends undefined ? IsAsync extends true ? Promise<Merge<ResultWrapper, {
+}>;
+type FullArrayResult<ResultWrapper, Result, IsAsync extends boolean> = IsAsync extends true ? Promise<Merge<ResultWrapper, {
     results?: Array<Result>;
 }>> : Merge<ResultWrapper, {
     results?: Array<Result>;
-}> : never;
-type ArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IterableResult<ResultWrapper, Result, IsAsync, IsLazy> | FullArrayResult<ResultWrapper, Result, IsAsync, IsLazy>;
+}>;
+type ArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends boolean = false> = IsLazy extends true ? IterableResult<ResultWrapper, Result, IsAsync> : FullArrayResult<ResultWrapper, Result, IsAsync>;
 type OneResult<ResultWrapper, Result> = Merge<ResultWrapper, {
     results?: Result;
 }>;
@@ -191,8 +191,8 @@ declare function defaultLogger(query: RawQuery, meta: QueryLoggerMeta): any;
 declare function asyncLoggerWrapper<Async extends boolean = true>(query: Query<any, Async> | Query<any, Async>[], loggerFunction: CallableFunction | undefined, innerFunction: () => any): Promise<any>;
 declare function syncLoggerWrapper<Async extends boolean = false>(query: Query<any, Async> | Query<any, Async>[], loggerFunction: CallableFunction | undefined, innerFunction: () => any): any;
 
-interface SelectExecuteOptions<IsLazy extends true | undefined> {
-    lazy?: IsLazy;
+interface SelectExecuteOptions {
+    lazy?: boolean;
 }
 declare class SelectBuilder<GenericResultWrapper, GenericResult = DefaultReturnObject, IsAsync extends boolean = true> {
     _debugger: boolean;
@@ -212,10 +212,16 @@ declare class SelectBuilder<GenericResultWrapper, GenericResult = DefaultReturnO
     offset(offset: SelectAll['offset']): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     limit(limit: SelectAll['limit']): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     _parseArray(fieldName: string, option: any, value: any): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
-    getQueryAll<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>, IsAsync>;
+    getQueryAll<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>, IsAsync>;
     getQueryOne(): Query<OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
-    execute<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>;
-    all<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>;
+    execute<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>;
+    all<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>;
     one(): MaybeAsync<IsAsync, OneResult<GenericResultWrapper, GenericResult>>;
     count(): MaybeAsync<IsAsync, CountResult<GenericResultWrapper>>;
 }
@@ -239,7 +245,9 @@ declare class QueryBuilder<GenericResultWrapper, IsAsync extends boolean = true>
     }): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync>, IsAsync>;
     select<GenericResult = DefaultReturnObject>(tableName: string): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     fetchOne<GenericResult = DefaultReturnObject>(params: SelectOne): QueryWithExtra<GenericResultWrapper, OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
-    fetchAll<GenericResult = DefaultReturnObject, IsLazy extends true | undefined = undefined>(params: SelectAll<IsLazy>): QueryWithExtra<GenericResultWrapper, ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>, IsAsync>;
+    fetchAll<GenericResult = DefaultReturnObject, P extends SelectAll = SelectAll>(params: P): QueryWithExtra<GenericResultWrapper, ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryFetchOne): Query<OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryFetchAll): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryWithoutFetching): Query<GenericResultWrapper, IsAsync>;

package/dist/index.d.ts

@@ -95,9 +95,9 @@ type RawQueryFetchAll = Omit<RawQuery, 'fetchType'> & {
     fetchType: FetchTypes.ALL;
 };
 type RawQueryWithoutFetching = Omit<RawQuery, 'fetchType'>;
-type SelectAll<IsLazy extends true | undefined = undefined> = SelectOne & {
+type SelectAll = SelectOne & {
     limit?: number;
-    lazy?: IsLazy;
+    lazy?: boolean;
 };
 type ConflictUpsert = {
     column: string | Array<string>;
@@ -166,17 +166,17 @@ type PGResult = {
     lastRowId?: string | number;
     rowCount: number;
 };
-type IterableResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IsLazy extends true ? IsAsync extends true ? Promise<Merge<ResultWrapper, {
+type IterableResult<ResultWrapper, Result, IsAsync extends boolean> = IsAsync extends true ? Promise<Merge<ResultWrapper, {
     results?: AsyncIterable<Result>;
 }>> : Merge<ResultWrapper, {
     results?: Iterable<Result>;
-}> : never;
-type FullArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IsLazy extends undefined ? IsAsync extends true ? Promise<Merge<ResultWrapper, {
+}>;
+type FullArrayResult<ResultWrapper, Result, IsAsync extends boolean> = IsAsync extends true ? Promise<Merge<ResultWrapper, {
     results?: Array<Result>;
 }>> : Merge<ResultWrapper, {
     results?: Array<Result>;
-}> : never;
-type ArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends true | undefined = undefined> = IterableResult<ResultWrapper, Result, IsAsync, IsLazy> | FullArrayResult<ResultWrapper, Result, IsAsync, IsLazy>;
+}>;
+type ArrayResult<ResultWrapper, Result, IsAsync extends boolean, IsLazy extends boolean = false> = IsLazy extends true ? IterableResult<ResultWrapper, Result, IsAsync> : FullArrayResult<ResultWrapper, Result, IsAsync>;
 type OneResult<ResultWrapper, Result> = Merge<ResultWrapper, {
     results?: Result;
 }>;
@@ -191,8 +191,8 @@ declare function defaultLogger(query: RawQuery, meta: QueryLoggerMeta): any;
 declare function asyncLoggerWrapper<Async extends boolean = true>(query: Query<any, Async> | Query<any, Async>[], loggerFunction: CallableFunction | undefined, innerFunction: () => any): Promise<any>;
 declare function syncLoggerWrapper<Async extends boolean = false>(query: Query<any, Async> | Query<any, Async>[], loggerFunction: CallableFunction | undefined, innerFunction: () => any): any;
 
-interface SelectExecuteOptions<IsLazy extends true | undefined> {
-    lazy?: IsLazy;
+interface SelectExecuteOptions {
+    lazy?: boolean;
 }
 declare class SelectBuilder<GenericResultWrapper, GenericResult = DefaultReturnObject, IsAsync extends boolean = true> {
     _debugger: boolean;
@@ -212,10 +212,16 @@ declare class SelectBuilder<GenericResultWrapper, GenericResult = DefaultReturnO
     offset(offset: SelectAll['offset']): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     limit(limit: SelectAll['limit']): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     _parseArray(fieldName: string, option: any, value: any): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
-    getQueryAll<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>, IsAsync>;
+    getQueryAll<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>, IsAsync>;
     getQueryOne(): Query<OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
-    execute<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>;
-    all<IsLazy extends true | undefined = undefined>(options?: SelectExecuteOptions<IsLazy>): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>;
+    execute<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>;
+    all<P extends SelectExecuteOptions = SelectExecuteOptions>(options?: P): ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>;
     one(): MaybeAsync<IsAsync, OneResult<GenericResultWrapper, GenericResult>>;
     count(): MaybeAsync<IsAsync, CountResult<GenericResultWrapper>>;
 }
@@ -239,7 +245,9 @@ declare class QueryBuilder<GenericResultWrapper, IsAsync extends boolean = true>
     }): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync>, IsAsync>;
     select<GenericResult = DefaultReturnObject>(tableName: string): SelectBuilder<GenericResultWrapper, GenericResult, IsAsync>;
     fetchOne<GenericResult = DefaultReturnObject>(params: SelectOne): QueryWithExtra<GenericResultWrapper, OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
-    fetchAll<GenericResult = DefaultReturnObject, IsLazy extends true | undefined = undefined>(params: SelectAll<IsLazy>): QueryWithExtra<GenericResultWrapper, ArrayResult<GenericResultWrapper, GenericResult, IsAsync, IsLazy>, IsAsync>;
+    fetchAll<GenericResult = DefaultReturnObject, P extends SelectAll = SelectAll>(params: P): QueryWithExtra<GenericResultWrapper, ArrayResult<GenericResultWrapper, GenericResult, IsAsync, P extends {
+        lazy: true;
+    } ? true : false>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryFetchOne): Query<OneResult<GenericResultWrapper, GenericResult>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryFetchAll): Query<ArrayResult<GenericResultWrapper, GenericResult, IsAsync>, IsAsync>;
     raw<GenericResult = DefaultReturnObject>(params: RawQueryWithoutFetching): Query<GenericResultWrapper, IsAsync>;

package/dist/index.js

@@ -258,16 +258,25 @@ var SelectBuilder = class _SelectBuilder {
     );
   }
   getQueryAll(options) {
-    return this._fetchAll(this._options);
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    });
   }
   getQueryOne() {
     return this._fetchOne(this._options);
   }
   execute(options) {
-    return this._fetchAll(this._options).execute();
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    }).execute();
   }
   all(options) {
-    return this._fetchAll(this._options).execute();
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    }).execute();
   }
   one() {
     return this._fetchOne(this._options).execute();

package/dist/index.mjs

@@ -216,16 +216,25 @@ var SelectBuilder = class _SelectBuilder {
     );
   }
   getQueryAll(options) {
-    return this._fetchAll(this._options);
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    });
   }
   getQueryOne() {
     return this._fetchOne(this._options);
   }
   execute(options) {
-    return this._fetchAll(this._options).execute();
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    }).execute();
   }
   all(options) {
-    return this._fetchAll(this._options).execute();
+    return this._fetchAll({
+      ...this._options,
+      ...options
+    }).execute();
   }
   one() {
     return this._fetchOne(this._options).execute();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workers-qb",
-  "version": "1.10.0",
+  "version": "1.10.2",
   "description": "Zero dependencies Query Builder for Cloudflare Workers",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -14,7 +14,11 @@
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "lint": "npx @biomejs/biome check src/ tests/ || (npx @biomejs/biome check --write src/ tests/; exit 1)",
     "test": "vitest run --root tests",
-    "prepare": "husky"
+    "prepare": "husky",
+    "build-docs": "npm run docs:build && cp docs/_redirects docs/.vitepress/dist/_redirects",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
   "publishConfig": {
     "access": "public"
@@ -62,6 +66,7 @@
     "husky": "^9.1.6",
     "tsup": "^8.3.5",
     "typescript": "^5.6.3",
+    "vitepress": "^1.6.3",
     "vitest": "2.1.8",
     "wrangler": "^3.86.0"
   }