Merge pull request #19 from noxify/adapter-kysely

add kysely adapter

Author: noxify

.changeset/funny-cobras-sneeze.md

@@ -0,0 +1,44 @@
+---
+"@vorsteh-queue/adapter-kysely": minor
+---
+
+Add Kysely ORM adapter for PostgreSQL with type-safe database operations
+
+**Features:**
+
+- `PostgresQueueAdapter`: PostgreSQL support using Kysely ORM
+- Raw SQL with `SKIP LOCKED` for race condition prevention
+- UTC-first design with proper timezone handling
+- Database schema uses UTC defaults: `timezone('utc', now())` for PostgreSQL
+- All timestamps explicitly stored as UTC for consistent behavior
+
+**Usage:**
+
+```typescript
+import { Kysely, PostgresDialect } from "kysely"
+import { Pool } from "pg"
+
+import { PostgresQueueAdapter } from "@vorsteh-queue/adapter-kysely"
+import { Queue } from "@vorsteh-queue/core"
+
+const db = new Kysely({
+  dialect: new PostgresDialect({
+    pool: new Pool({ connectionString: "postgresql://..." }),
+  }),
+})
+
+const adapter = new PostgresQueueAdapter(db)
+const queue = new Queue(adapter, { name: "my-queue" })
+
+// Register job handlers
+queue.register("send-email", async (payload: { to: string }) => {
+  // Send email logic
+  return { sent: true }
+})
+
+// Add jobs
+await queue.add("send-email", { to: "[email protected]" })
+
+// Start processing
+queue.start()
+```

.changeset/loose-parrots-glow copy 2.md

@@ -0,0 +1,5 @@
+---
+"@vorsteh-queue/adapter-drizzle": patch
+---
+
+Add `PostgresQueueAdapter` as alias to `PostgresDrizzleQueueAdapter`

.changeset/loose-parrots-glow copy.md

@@ -0,0 +1,5 @@
+---
+"@vorsteh-queue/adapter-prisma": patch
+---
+
+Add `PostgresQueueAdapter` as alias to `PostgresPrismaQueueAdapter`

.changeset/loose-parrots-glow.md

@@ -0,0 +1,8 @@
+---
+"create-vorsteh-queue": patch
+"@vorsteh-queue/adapter-drizzle": patch
+"@vorsteh-queue/adapter-prisma": patch
+"@vorsteh-queue/core": patch
+---
+
+update dependencies

README.md

@@ -311,19 +311,20 @@ This project was developed with AI assistance, combining human expertise with AI
 # Install dependencies
 pnpm install
 
-# Run all tests
-pnpm test
+# Autofix format issues
+pnpm format:fix
+
+# Fix issues in the `package.json` ( order, version mismatch )
+pnpm lint:ws -f
 
-# Run specific test suites
-pnpm test:core                # Core package tests
-pnpm test:drizzle-postgres    # PostgreSQL adapter tests
-pnpm test:drizzle-mariadb     # MariaDB adapter tests
+# Lint
+pnpm lint
 
 # Type check
 pnpm typecheck
 
-# Lint
-pnpm lint
+# Run all tests
+pnpm test
 
 # Build packages
 pnpm build

apps/docs/content/docs/01.getting-started/01.introduction.mdx

@@ -8,7 +8,7 @@ Vorsteh Queue is a powerful, type-safe queue engine designed for PostgreSQL 12+.
 ## Key Features
 
 - **Type-safe**: Full TypeScript support with generic job payloads
-- **Multiple adapters**: Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), and in-memory implementations
+- **Multiple adapters**: Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), Kysely (PostgreSQL) and in-memory implementations
 - **Priority queues**: Numeric priority system (lower = higher priority)
 - **Delayed jobs**: Schedule jobs for future execution
 - **Recurring jobs**: Cron expressions and interval-based repetition

apps/docs/content/docs/01.getting-started/02.installation.mdx

@@ -53,12 +53,20 @@ If you prefer to add Vorsteh Queue to an existing project:
   className={{ container: "not-prose", code: "not-prose" }}
 />
 
+### Prisma ORM (PostgreSQL)
+
+<PackageInstall
+  packages={["@vorsteh-queue/core", "@vorsteh-queue/adapter-kysely"]}
+  className={{ container: "not-prose", code: "not-prose" }}
+/>
+
 ## Database Setup
 
 After installation, you'll need to set up the required database tables. Each adapter provides migration scripts or schema definitions:
 
 - **Drizzle**: Use the provided schema and run migrations
 - **Prisma**: Add the schema to your `schema.prisma` and run `prisma migrate`
+- **Kysely**: Use the provided schema and run migrations
 
 Refer to the specific adapter documentation for detailed setup instructions.
 

apps/docs/content/docs/02.packages/adapter-drizzle.mdx

@@ -55,18 +55,9 @@ If you don't want to use the pre-defined schema, you can create your own schema
 
 ### Migration
 
-Push the schema to your database:
+To run the migrations, we recommend to use [`drizzle-kit`](https://orm.drizzle.team/docs/kit-overview).
 
-```bash
-npx drizzle-kit push
-```
-
-Or generate and run migrations:
-
-```bash
-npx drizzle-kit generate
-npx drizzle-kit migrate
-```
+> Drizzle Kit is a CLI tool for managing SQL database migrations with Drizzle.
 
 ## References
 

apps/docs/content/docs/02.packages/adapter-kysely.mdx

@@ -0,0 +1,85 @@
+---
+title: Kysely Adapter
+navTitle: "@vorsteh-queue/adapter-kysely"
+description: Kysely adapter for PostgreSQL providing type-safe database operations with excellent performance.
+---
+
+The Kysely adapter provides PostgreSQL support using Kysely, offering excellent TypeScript integration and performance.
+
+## Installation
+
+<PackageInstall packages={["@vorsteh-queue/core", "@vorsteh-queue/adapter-kysely"]} />
+
+## Quick Start
+
+```typescript
+import { Kysely } from "kysely"
+import { PostgresJSDialect } from "kysely-postgres-js"
+import postgres from "postgres"
+
+import type { QueueJobTableDefinition } from "@vorsteh-queue/adapter-kysely/types"
+import { PostgresQueueAdapter } from "@vorsteh-queue/adapter-kysely"
+import { Queue } from "@vorsteh-queue/core"
+
+interface DB {
+  queue_jobs: QueueJobTableDefinition
+  other_table: {
+    name: string
+  }
+}
+
+// Shared database connection
+const client = postgres(
+  process.env.DATABASE_URL || "postgresql://postgres:password@localhost:5432/queue_db",
+  { max: 10 }, // Connection pool
+)
+
+const db = new Kysely<DB>({
+  dialect: new PostgresJSDialect({
+    postgres: client,
+  }),
+})
+
+const adapter = new PostgresQueueAdapter(db)
+const queue = new Queue(adapter)
+```
+
+## Supported providers
+
+- PGlite
+- Postgres.JS
+- Node Progress
+
+## Database Setup
+
+### Schema
+
+The adapter includes a pre-defined migration:
+
+```typescript
+// migrations/queue-jobs.ts
+import { down, up } from "@vorsteh-queue/adapter-kysely/migrations"
+
+// Use in your schema file
+export { up, down }
+```
+
+If you don't want to use the pre-defined schema, you can create your own migration.
+
+<RemoteCodeBlock
+  source="./packages/adapter-kysely/src/migrations/queue_table.ts"
+  language="ts"
+  showToolbar={true}
+  path="queue-jobs.ts"
+/>
+
+### Migration
+
+To run the migrations, we recommend to use [`kysely-ctl`](https://github.com/kysely-org/kysely-ctl).
+
+> `kysely-ctl` is the command-line tool for Kysely.
+
+## References
+
+- Sources: https://github.com/noxify/vorsteh-queue/tree/main/packages/adapter-kysely
+- NPM: https://www.npmjs.com/package/@vorsteh-queue/adapter-kysely

apps/docs/content/docs/02.packages/adapter-prisma.mdx

@@ -39,25 +39,9 @@ Add the queue job model to your `schema.prisma`:
 
 ### Migration
 
-Push the schema to your database:
+To run the migrations, we recommend to use the [`prisma cli`](https://www.prisma.io/docs/orm/tools/prisma-cli).
 
-```bash
-npx prisma db push
-```
-
-Or generate and apply the migration:
-
-```bash
-npx prisma migrate dev --name add-queue-jobs
-```
-
-### Generate Client
-
-Generate the Prisma client:
-
-```bash
-npx prisma generate
-```
+> The Prisma command line interface (CLI) is the primary way to interact with your Prisma project from the command line.
 
 ## References