workers-qb 1.11.2 → 1.13.0

package/README.md

@@ -33,6 +33,17 @@ workers-qb is a lightweight query builder designed specifically for Cloudflare W
 - Zero dependencies
 - Lightweight and Worker-optimized
 
+## AI Skills
+
+workers-qb provides AI coding assistant skills to help you write queries faster. Install them using [npx skills](https://www.npmjs.com/package/skills):
+
+```bash
+npx skills install G4brym/workers-qb
+```
+
+Available skills:
+- **write-sql-queries** - Comprehensive guide for writing SELECT, INSERT, UPDATE, DELETE queries
+
 ## Supported Databases
 
 - ☁️ [Cloudflare D1](https://workers-qb.massadas.com/databases/d1/)
@@ -45,8 +56,8 @@ workers-qb is a lightweight query builder designed specifically for Cloudflare W
 ### Core Features
 - Zero dependencies
 - Full TypeScript support
+- Schema-aware type inference with autocomplete
 - Database schema migrations
-- Type checking for data reads
 - Lazy row loading
 
 ### Query Operations
@@ -72,24 +83,30 @@ npm install workers-qb --save
 ```typescript
 import { D1QB } from 'workers-qb'
 
+// Define your database schema for full type safety
+type Schema = {
+  employees: {
+    id: number
+    name: string
+    role: string
+    level: number
+    active: boolean
+  }
+}
+
 export interface Env {
   DB: D1Database
 }
 
 export default {
   async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
-    const qb = new D1QB(env.DB)
+    const qb = new D1QB<Schema>(env.DB)
 
-    type Employee = {
-      name: string
-      role: string
-      level: number
-    }
-
-    // Using object syntax
+    // Using object syntax - table names and fields autocomplete!
     const employeeList = await qb
-      .fetchAll<Employee>({
-        tableName: 'employees',
+      .fetchAll({
+        tableName: 'employees',  // ✓ Autocomplete
+        fields: ['name', 'role', 'level'],  // ✓ Autocomplete
         where: {
           conditions: 'active = ?1',
           params: [true],
@@ -99,10 +116,11 @@ export default {
 
     // Using method chaining
     const employeeListModular = await qb
-      .select<Employee>('employees')
+      .select('employees')
       .where('active = ?', true)
-      .execute()
+      .all()
 
+    // Result type is automatically inferred!
     return Response.json({
       activeEmployees: employeeList.results?.length || 0,
     })
@@ -115,13 +133,27 @@ export default {
 ```typescript
 import { DOQB } from 'workers-qb'
 
-export class DOSRS extends DurableObject {
+type Schema = {
+  employees: {
+    id: number
+    name: string
+    role: string
+  }
+}
+
+export class MyDurableObject extends DurableObject {
+  #qb: DOQB<Schema>
+
+  constructor(ctx: DurableObjectState, env: Env) {
+    super(ctx, env)
+    this.#qb = new DOQB<Schema>(ctx.storage.sql)
+  }
+
   getEmployees() {
-    const qb = new DOQB(this.ctx.storage.sql)
-    
-    return qb
+    // DOQB operations are synchronous - no await needed!
+    return this.#qb
       .fetchAll({
-        tableName: 'employees',
+        tableName: 'employees',  // ✓ Autocomplete
       })
       .execute()
       .results
@@ -146,18 +178,26 @@ Example usage:
 import { PGQB } from 'workers-qb'
 import { Client } from 'pg'
 
+type Schema = {
+  employees: {
+    id: number
+    name: string
+    active: boolean
+  }
+}
+
 export interface Env {
   DB_URL: string
 }
 
 export default {
   async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
-    const qb = new PGQB(new Client(env.DB_URL))
+    const qb = new PGQB<Schema>(new Client(env.DB_URL))
     await qb.connect()
 
     const fetched = await qb
       .fetchOne({
-        tableName: 'employees',
+        tableName: 'employees',  // ✓ Autocomplete
         fields: 'count(*) as count',
         where: {
           conditions: 'active = ?1',
@@ -168,7 +208,7 @@ export default {
 
     // Important: Close the connection
     ctx.waitUntil(qb.close())
-    
+
     return Response.json({
       activeEmployees: fetched.results?.count || 0,
     })