workers-qb 1.9.0 → 1.10.0

package/README.md

@@ -1,44 +1,69 @@
-# workers-qb
+<div align="center">
+  <h1>workers-qb</h1>
+  <p><em>Zero-dependency Query Builder for Cloudflare Workers</em></p>
 
-### [Read the documentation here!](https://workers-qb.massadas.com/)
+  <p>
+    <a href="https://workers-qb.massadas.com/" target="_blank">
+      <img src="https://img.shields.io/badge/docs-workers--qb-blue.svg" alt="Documentation">
+    </a>
+    <a href="https://www.npmjs.com/package/workers-qb" target="_blank">
+      <img src="https://img.shields.io/npm/v/workers-qb.svg" alt="npm version">
+    </a>
+    <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>
 
-Zero dependencies Query Builder for [Cloudflare Workers](https://developers.cloudflare.com/workers/)
+## Overview
 
-This module provides a simple standardized interface while keeping the benefits and speed of using raw queries over a
-traditional ORM.
+workers-qb is a lightweight query builder designed specifically for Cloudflare Workers. It provides a simple, standardized interface while maintaining the performance benefits of raw queries over traditional ORMs.
 
-`workers-qb` is not intended to provide ORM-like functionality, rather to make it easier to interact with the database
-from code for direct SQL access using convenient wrapper methods.
+📚 [Read the full documentation](https://workers-qb.massadas.com/)
 
-Currently, 3 databases are supported:
+### Key Differences from ORMs
 
-- [Cloudflare D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
-- [Cloudflare Durable Objects](https://workers-qb.massadas.com/databases/cloudflare-do/)
-- [PostgreSQL (using node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
-- [Bring your own Database](https://workers-qb.massadas.com/databases/bring-your-own-database/)
+- Focused on direct SQL access with convenient wrapper methods
+- Maintains raw query performance
+- Zero dependencies
+- Lightweight and Worker-optimized
+
+## Supported Databases
+
+- ☁️ [Cloudflare D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
+- 💾 [Cloudflare Durable Objects](https://workers-qb.massadas.com/databases/cloudflare-do/)
+- 🐘 [PostgreSQL (via node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
+- 🔌 [Bring Your Own Database](https://workers-qb.massadas.com/databases/bring-your-own-database/)
 
 ## Features
 
-- [x] Zero dependencies
-- [x] Fully typed/TypeScript support
-- [x] [Migrations](https://workers-qb.massadas.com/migrations/)
-- [x] [Type Checks for data read](https://workers-qb.massadas.com/type-check/)
-- [x] [Create/drop tables](https://workers-qb.massadas.com/basic-queries/#dropping-and-creating-tables)
-- [x] [Insert/Bulk Inserts/Update/Select/Delete/Join queries](https://workers-qb.massadas.com/basic-queries/)
-- [x] [Modular selects](https://workers-qb.massadas.com/modular-selects/) (qb.select(...).where(...).where(...).one())
-- [x] [On Conflict for Inserts and Updates](https://workers-qb.massadas.com/advanced-queries/onConflict/)
-- [x] [Upsert](https://workers-qb.massadas.com/advanced-queries/upsert/)
-- [x] Lazy Load Rows
+### Core Features
+- Zero dependencies
+- Full TypeScript support
+- Database schema migrations
+- Type checking for data reads
+- Lazy row loading
+
+### Query Operations
+- Table operations (create/drop)
+- CRUD operations (insert/update/select/delete)
+- Bulk inserts
+- JOIN queries
+- Modular SELECT queries
+- ON CONFLICT handling
+- UPSERT support
 
 ## Installation
 
-```
+```bash
 npm install workers-qb --save
 ```
 
-## Example for Cloudflare Workers D1
+## Usage Examples
+
+### Cloudflare D1
 
-```ts
+```typescript
 import { D1QB } from 'workers-qb'
 
 export interface Env {
@@ -55,7 +80,7 @@ export default {
       level: number
     }
 
-    // Generated query: SELECT * FROM employees WHERE active = ?1
+    // Using object syntax
     const employeeList = await qb
       .fetchAll<Employee>({
         tableName: 'employees',
@@ -66,11 +91,11 @@ export default {
       })
       .execute()
 
-    // Or in a modular approach
-    const employeeListModular = await qb.select<Employee>('employees').where('active = ?', true).execute()
-
-    // You get IDE type hints on each employee data, like:
-    // employeeList.results[0].name
+    // Using method chaining
+    const employeeListModular = await qb
+      .select<Employee>('employees')
+      .where('active = ?', true)
+      .execute()
 
     return Response.json({
       activeEmployees: employeeList.results?.length || 0,
@@ -79,41 +104,39 @@ export default {
 }
 ```
 
-## Example for Cloudflare Durable Objects
+### Cloudflare Durable Objects
 
-```ts
+```typescript
 import { DOQB } from 'workers-qb'
 
 export class DOSRS extends DurableObject {
   getEmployees() {
     const qb = new DOQB(this.ctx.storage.sql)
-
-    const fetched = qb
+    
+    return qb
       .fetchAll({
         tableName: 'employees',
       })
       .execute()
-
-    return fetched.results
+      .results
   }
 }
 ```
 
-## Example for Cloudflare Workers with PostgreSQL
-
-Remember to close the connection using `ctx.waitUntil(qb.close());` or `await qb.close();` at the end of your request.
-You may also reuse this connection to execute multiple queries, or share it between multiple requests if you are using
-a connection pool in front of your PostgreSQL.
-
-You must also enable `node_compat = true` in your `wrangler.toml`
-
-You need to install `node-postgres`:
+### PostgreSQL Integration
 
+First, install the required PostgreSQL client:
 ```bash
 npm install pg --save
 ```
 
-```ts
+Enable Node compatibility in `wrangler.toml`:
+```toml
+node_compat = true
+```
+
+Example usage:
+```typescript
 import { PGQB } from 'workers-qb'
 import { Client } from 'pg'
 
@@ -126,7 +149,6 @@ export default {
     const qb = new PGQB(new Client(env.DB_URL))
     await qb.connect()
 
-    // Generated query: SELECT count(*) as count FROM employees WHERE active = ?1 LIMIT 1
     const fetched = await qb
       .fetchOne({
         tableName: 'employees',
@@ -138,10 +160,30 @@ export default {
       })
       .execute()
 
+    // Important: Close the connection
     ctx.waitUntil(qb.close())
+    
     return Response.json({
       activeEmployees: fetched.results?.count || 0,
     })
   },
 }
 ```
+
+## Documentation
+
+Visit our [comprehensive documentation](https://workers-qb.massadas.com/) for detailed information about:
+
+- [Basic Queries](https://workers-qb.massadas.com/basic-queries/)
+- [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/)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/index.js

@@ -546,6 +546,11 @@ var QueryBuilder = class {
   }
   _update(params) {
     const whereParamsLength = typeof params.where === "object" && !Array.isArray(params.where) && params.where?.params ? Array.isArray(params.where?.params) ? Object.keys(params.where?.params).length : 1 : 0;
+    let whereString = this._where(params.where);
+    let parameterIndex = 1;
+    if (whereString && whereString.match(/(?<!\d)\?(?!\d)/)) {
+      whereString = whereString.replace(/\?/g, () => `?${parameterIndex++}`);
+    }
     const set = [];
     let index = 1;
     for (const [key, value] of Object.entries(params.data)) {
@@ -557,7 +562,7 @@ var QueryBuilder = class {
       }
     }
     return `UPDATE ${this._onConflict(params.onConflict)}${params.tableName}
-       SET ${set.join(", ")}` + this._where(params.where) + this._returning(params.returning);
+       SET ${set.join(", ")}` + whereString + this._returning(params.returning);
   }
   _delete(params) {
     return `DELETE

package/dist/index.mjs

@@ -504,6 +504,11 @@ var QueryBuilder = class {
   }
   _update(params) {
     const whereParamsLength = typeof params.where === "object" && !Array.isArray(params.where) && params.where?.params ? Array.isArray(params.where?.params) ? Object.keys(params.where?.params).length : 1 : 0;
+    let whereString = this._where(params.where);
+    let parameterIndex = 1;
+    if (whereString && whereString.match(/(?<!\d)\?(?!\d)/)) {
+      whereString = whereString.replace(/\?/g, () => `?${parameterIndex++}`);
+    }
     const set = [];
     let index = 1;
     for (const [key, value] of Object.entries(params.data)) {
@@ -515,7 +520,7 @@ var QueryBuilder = class {
       }
     }
     return `UPDATE ${this._onConflict(params.onConflict)}${params.tableName}
-       SET ${set.join(", ")}` + this._where(params.where) + this._returning(params.returning);
+       SET ${set.join(", ")}` + whereString + this._returning(params.returning);
   }
   _delete(params) {
     return `DELETE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workers-qb",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Zero dependencies Query Builder for Cloudflare Workers",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",