Merge pull request #3 from noxify/ai-notice

Updates

Author: noxify

.github/workflows/ci.yml

@@ -3,17 +3,13 @@ name: CI
 on:
   pull_request:
     branches: ["*"]
-    types: [opened, synchronize, reopened, ready_for_review]
-  pull_request_target:
-    branches: ["*"]
-    types: [opened, synchronize, reopened, ready_for_review]
   push:
     branches: ["main"]
   merge_group:
   workflow_dispatch:
     inputs:
       pr_number:
-        description: 'PR number to run CI for'
+        description: "PR number to run CI for"
         required: false
         type: string
 
@@ -68,11 +64,29 @@ jobs:
 
   unittest:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22]
+    name: Test (Node.js ${{ matrix.node-version }})
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup
-        uses: ./.github/setup
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.13.1
+          run_install: false
+
+      - shell: bash
+        run: pnpm install
+
+      - name: Build packages
+        run: pnpm --filter "./packages/*" build
 
       - name: Test Core Package
         run: pnpm test:core

README.md

@@ -35,6 +35,11 @@
 
 ## Quick Start
 
+### Requirements
+
+- **Node.js 20+**
+- **ESM only** - This package is ESM-only and cannot be imported with `require()`
+
 ### Installation
 
 ```bash
@@ -43,6 +48,8 @@ npm install @vorsteh-queue/core @vorsteh-queue/adapter-drizzle
 pnpm add @vorsteh-queue/core @vorsteh-queue/adapter-drizzle
 ```
 
+> **Note**: Make sure your project has `"type": "module"` in package.json or use `.mjs` file extensions.
+
 ### Basic Usage
 
 ```typescript
@@ -251,6 +258,8 @@ queue.on("queue:resumed", () => {
 
 ## Development
 
+This project was developed with AI assistance, combining human expertise with AI-powered code generation to accelerate development while maintaining high code quality standards.
+
 ```bash
 # Install dependencies
 pnpm install

apps/docs/package.json

@@ -26,7 +26,7 @@
     "class-variance-authority": "0.7.1",
     "clsx": "2.1.1",
     "cmdk": "1.1.1",
-    "date-fns": "4.1.0",
+    "date-fns": "^4.1.0",
     "lucide-react": "0.525.0",
     "next": "15.4.2",
     "next-themes": "latest",
@@ -50,14 +50,14 @@
     "@vorsteh-queue/eslint-config": "workspace:*",
     "@vorsteh-queue/prettier-config": "workspace:*",
     "@vorsteh-queue/tsconfig": "workspace:*",
-    "eslint": "9.31.0",
+    "eslint": "^9.31.0",
     "next-validate-link": "1.5.2",
     "pagefind": "1.3.0",
     "postcss": "8.5.6",
-    "prettier": "3.6.2",
+    "prettier": "^3.6.2",
     "tailwind-merge": "3.3.1",
     "tailwindcss": "4.1.11",
     "tailwindcss-animate": "1.0.7",
-    "typescript": "5.8.3"
+    "typescript": "^5.8.3"
   }
 }

examples/drizzle-pg/README.md

@@ -5,22 +5,26 @@ Minimal example showing how to use vorsteh-queue with Drizzle ORM and node-postg
 ## Setup
 
 1. Install dependencies:
+
 ```bash
 pnpm install
 ```
 
 2. Set up PostgreSQL database and copy environment variables:
+
 ```bash
 cp .env.example .env
 # Edit .env with your database URL
 ```
 
 3. Push database schema:
+
 ```bash
 pnpm db:push
 ```
 
 4. Run the example:
+
 ```bash
 pnpm dev
 ```
@@ -30,4 +34,4 @@ pnpm dev
 - Basic job registration and processing
 - Priority-based job execution
 - Delayed job scheduling
-- Graceful shutdown handling
+- Graceful shutdown handling

examples/drizzle-pg/package.json

@@ -11,13 +11,13 @@
   "dependencies": {
     "@vorsteh-queue/adapter-drizzle": "workspace:*",
     "@vorsteh-queue/core": "workspace:*",
-    "drizzle-orm": "0.44.3",
+    "drizzle-orm": "^0.44.3",
     "pg": "8.16.3"
   },
   "devDependencies": {
     "@types/pg": "8.15.4",
-    "drizzle-kit": "0.31.4",
+    "drizzle-kit": "^0.31.4",
     "tsx": "4.20.3",
-    "typescript": "5.8.3"
+    "typescript": "^5.8.3"
   }
 }

examples/drizzle-pglite/README.md

@@ -14,25 +14,37 @@ A complete example using Vorsteh Queue with Drizzle ORM and PGlite (embedded Pos
 - ✅ **Queue statistics** - Monitor queue health
 - ✅ **Graceful shutdown** - Clean termination
 
-## Quick Start
+## Setup
+
+1. Install dependencies:
 
 ```bash
-# Install dependencies
 pnpm install
+```
+
+2. Push database schema:
 
-# Run the example
+```bash
+pnpm db:push
+```
+
+3. Run the example:
+
+```bash
 pnpm dev
 ```
 
+> **Note**: PGlite creates an embedded PostgreSQL database automatically, but the schema still needs to be initialized.
+
 ## What It Does
 
 1. **Creates embedded database** - PGlite starts with empty database
-2. **Sets up schema** - Creates queue tables automatically
-3. **Registers job handlers** - Email and data processing jobs
-4. **Adds various jobs** - Immediate, delayed, priority, and recurring
+2. **Initializes schema** - Uses drizzle-kit pushSchema to create tables
+3. **Registers job handlers** - Email and data processing jobs with TypeScript types
+4. **Adds sample jobs** - Immediate, delayed, and priority jobs
 5. **Processes jobs** - Shows real-time progress and events
-6. **Displays stats** - Queue statistics every 5 seconds
-7. **Graceful shutdown** - Stops after 30 seconds
+6. **Displays stats** - Queue statistics every 10 seconds
+7. **Graceful shutdown** - Press Ctrl+C to stop cleanly
 
 ## Perfect for Bug Reports
 
@@ -47,38 +59,51 @@ This example is ideal for reproducing bugs because:
 ## Example Output
 
 ```
-🚀 Starting PGlite Queue Example
-
-📝 Adding jobs to queue...
+🚀 Starting PGlite Queue Example (Embedded PostgreSQL)
+📋 Initializing database schema...
+✅ Database schema initialized
 ✅ Job added: send-email (abc123...)
-✅ Job added: send-email (def456...)
-✅ Job added: process-data (ghi789...)
-
-🔄 Starting queue processing...
+✅ Job added: process-data (def456...)
+✅ Job added: send-email (ghi789...)
+🔄 Queue processing started. Press Ctrl+C to stop.
 ⚡ Processing: send-email (abc123...)
-📧 Sending email to user@example.com
-   Subject: Welcome to Vorsteh Queue!
+📧 Sending email to user@example.com: Welcome!
 🎉 Completed: send-email (abc123...)
-
-📊 Queue Stats: { pending: 2, processing: 0, completed: 1, failed: 0, delayed: 1 }
+⚡ Processing: process-data (def456...)
+📊 Processing 20 items in batches of 5
+📈 Progress: process-data - 25%
+📈 Progress: process-data - 50%
+📊 Queue Stats: { pending: 1, processing: 1, completed: 1, failed: 0, delayed: 1 }
 ```
 
 ## Job Types
 
 ### Email Job
+
 ```typescript
 interface EmailJob {
   to: string
-  subject: string  
-  body: string
+  subject: string
+  body?: string
+}
+
+interface EmailResult {
+  sent: boolean
+  messageId: string
 }
 ```
 
 ### Data Processing Job
+
 ```typescript
 interface DataProcessingJob {
-  items: string[]
-  batchSize: number
+  data: unknown[]
+  batchSize?: number
+}
+
+interface DataProcessingResult {
+  processed: number
+  results: unknown[]
 }
 ```
 
@@ -95,4 +120,4 @@ interface DataProcessingJob {
 - **Bug reproduction** - Minimal setup for issue reports
 - **Feature testing** - Quick way to test new features
 - **Learning** - Understand how Vorsteh Queue works
-- **Prototyping** - Rapid development without database setup
+- **Prototyping** - Rapid development without database setup

examples/drizzle-pglite/package.json

@@ -6,18 +6,17 @@
   "type": "module",
   "scripts": {
     "dev": "tsx src/index.ts",
-    "build": "tsc",
-    "start": "node dist/index.js"
+    "db:push": "drizzle-kit push"
   },
   "dependencies": {
-    "@electric-sql/pglite": "0.3.5",
+    "@electric-sql/pglite": "^0.3.5",
     "@vorsteh-queue/adapter-drizzle": "workspace:*",
     "@vorsteh-queue/core": "workspace:*",
-    "drizzle-orm": "0.44.3"
+    "drizzle-orm": "^0.44.3"
   },
   "devDependencies": {
     "@types/node": "22.16.5",
     "tsx": "4.20.3",
-    "typescript": "5.8.3"
+    "typescript": "^5.8.3"
   }
 }