fix(knex)!: scope KnexQueueSchemaService to the driver module (#27)

* fix(knex)!: move QueueSchemaService to the driver module

The root barrel re-exported QueueSchemaService, whose constructor takes a
Knex instance. That single export made build/index.d.ts import 'knex', so
every consumer type checking with skipLibCheck disabled had to install the
optional peer, even when using the Kysely, Redis or Sync adapter.

Export it from src/drivers/knex_adapter.ts instead, the way the Kysely
module already exports KyselyQueueSchemaService, so the type stays reachable
only from the subpath that owns the dependency.

BREAKING CHANGE: QueueSchemaService is no longer exported from the package
root. Import it from '@boringnode/queue/drivers/knex_adapter'.

* refactor(knex)!: rename QueueSchemaService to KnexQueueSchemaService

Now that the schema service is exported from the Knex driver module, the
name mirrors KyselyQueueSchemaService and src/services/knex_queue_schema.ts
mirrors src/services/kysely_queue_schema.ts, so neither module carries the
unqualified name.

BREAKING CHANGE: QueueSchemaService is now named KnexQueueSchemaService.

---------

Co-authored-by: Gerardo PG <168353+gerardp@users.noreply.github.com>

Author: gerardp

README.md

@@ -389,16 +389,16 @@ const adapter = knex(config, 'custom_jobs_table')
 </details>
 
 <details>
-<summary><strong>Database setup with QueueSchemaService</strong></summary>
+<summary><strong>Database setup with KnexQueueSchemaService</strong></summary>
 
-The Knex adapter requires tables to be created before use. Use `QueueSchemaService` to create them:
+The Knex adapter requires tables to be created before use. Use `KnexQueueSchemaService` to create them:
 
 ```typescript
-import { QueueSchemaService } from '@boringnode/queue'
+import { KnexQueueSchemaService } from '@boringnode/queue/drivers/knex_adapter'
 import Knex from 'knex'
 
 const connection = Knex({ client: 'pg', connection: '...' })
-const schemaService = new QueueSchemaService(connection)
+const schemaService = new KnexQueueSchemaService(connection)
 
 // Create tables with default names
 await schemaService.createJobsTable()
@@ -414,17 +414,17 @@ await schemaService.createJobsTable('queue_jobs', (table) => {
 
 ```typescript
 import { BaseSchema } from '@adonisjs/lucid/schema'
-import { QueueSchemaService } from '@boringnode/queue'
+import { KnexQueueSchemaService } from '@boringnode/queue/drivers/knex_adapter'
 
 export default class extends BaseSchema {
   async up() {
-    const schemaService = new QueueSchemaService(this.db.connection().getWriteClient())
+    const schemaService = new KnexQueueSchemaService(this.db.connection().getWriteClient())
     await schemaService.createJobsTable()
     await schemaService.createSchedulesTable()
   }
 
   async down() {
-    const schemaService = new QueueSchemaService(this.db.connection().getWriteClient())
+    const schemaService = new KnexQueueSchemaService(this.db.connection().getWriteClient())
     await schemaService.dropSchedulesTable()
     await schemaService.dropJobsTable()
   }

index.ts

@@ -5,7 +5,6 @@ export { Locator } from './src/locator.js'
 export { Schedule } from './src/schedule.js'
 export { ScheduleBuilder } from './src/schedule_builder.js'
 export { JobBatchDispatcher } from './src/job_batch_dispatcher.js'
-export { QueueSchemaService } from './src/services/queue_schema.js'
 export {
   customBackoff,
   linearBackoff,

src/drivers/knex_adapter.ts

@@ -15,6 +15,8 @@ import type {
 import { DEFAULT_PRIORITY } from '../constants.js'
 import { calculateScore, resolveRetention, resolveSchedulePayload } from '../utils.js'
 
+export { KnexQueueSchemaService } from '../services/knex_queue_schema.js'
+
 export interface KnexAdapterOptions {
   connection: Knex
   tableName?: string
@@ -419,7 +421,7 @@ export class KnexAdapter implements Adapter {
     } catch (err) {
       if (this.#isMissingDedupColumn(err)) {
         throw new Error(
-          `Dedup columns missing on "${this.#jobsTable}". Run QueueSchemaService.addDedupColumns() on your jobs table before dispatching jobs with .dedup().`,
+          `Dedup columns missing on "${this.#jobsTable}". Run KnexQueueSchemaService.addDedupColumns() on your jobs table before dispatching jobs with .dedup().`,
           { cause: err }
         )
       }

src/services/queue_schema.ts src/services/knex_queue_schema.tssrc/services/queue_schema.ts renamed to src/services/knex_queue_schema.ts

@@ -1,6 +1,6 @@
 import type { Knex } from 'knex'
 
-export class QueueSchemaService {
+export class KnexQueueSchemaService {
   #connection: Knex
 
   constructor(connection: Knex) {

tests/adapter.spec.ts

@@ -4,7 +4,7 @@ import { Redis } from 'ioredis'
 import { MemoryAdapter } from './_mocks/memory_adapter.js'
 import { redis, RedisAdapter } from '../src/drivers/redis_adapter.js'
 import { KnexAdapter } from '../src/drivers/knex_adapter.js'
-import { QueueSchemaService } from '../src/services/queue_schema.js'
+import { KnexQueueSchemaService } from '../src/services/knex_queue_schema.js'
 import { registerDriverTestSuite } from './_utils/register_driver_test_suite.js'
 import { withRedisWriteSpy } from './_utils/with_redis_write_spy.js'
 import { withKnexQuerySpy } from './_utils/with_knex_query_spy.js'
@@ -1672,8 +1672,8 @@ test.group('Adapter | Knex (SQLite)', (group) => {
       useNullAsDefault: true,
     })
 
-    // Create tables via QueueSchemaService
-    const schemaService = new QueueSchemaService(connection)
+    // Create tables via KnexQueueSchemaService
+    const schemaService = new KnexQueueSchemaService(connection)
     await schemaService.createJobsTable()
     await schemaService.createSchedulesTable()
 
@@ -1756,7 +1756,7 @@ test.group('Adapter | Knex (SQLite)', (group) => {
 test.group('Adapter | Knex (PostgreSQL)', (group) => {
   let connection: ReturnType<typeof Knex>
   let adapter: KnexAdapter
-  let schemaService: QueueSchemaService
+  let schemaService: KnexQueueSchemaService
   const tableName = 'queue_jobs_test'
   const schedulesTableName = 'queue_schedules_test'
 
@@ -1772,7 +1772,7 @@ test.group('Adapter | Knex (PostgreSQL)', (group) => {
       },
     })
 
-    schemaService = new QueueSchemaService(connection)
+    schemaService = new KnexQueueSchemaService(connection)
 
     // Clean up tables before each test
     await schemaService.dropJobsTable(tableName)

tests/worker_adapter.spec.ts

@@ -4,7 +4,7 @@ import { Redis } from 'ioredis'
 import { MemoryAdapter } from './_mocks/memory_adapter.js'
 import { RedisAdapter } from '../src/drivers/redis_adapter.js'
 import { KnexAdapter } from '../src/drivers/knex_adapter.js'
-import { QueueSchemaService } from '../src/services/queue_schema.js'
+import { KnexQueueSchemaService } from '../src/services/knex_queue_schema.js'
 import { registerWorkerRetryTestSuite } from './_utils/register_worker_retry_suite.js'
 
 const KEY_PREFIX = 'boringnode::queue::worker-test::'
@@ -62,7 +62,7 @@ test.group('Worker Adapter | Knex (SQLite)', (group) => {
       useNullAsDefault: true,
     })
 
-    const schemaService = new QueueSchemaService(connection)
+    const schemaService = new KnexQueueSchemaService(connection)
     await schemaService.createJobsTable()
     await schemaService.createSchedulesTable()
 
@@ -84,7 +84,7 @@ test.group('Worker Adapter | Knex (SQLite)', (group) => {
 test.group('Worker Adapter | Knex (PostgreSQL)', (group) => {
   let connection: ReturnType<typeof Knex>
   let adapter: KnexAdapter
-  let schemaService: QueueSchemaService
+  let schemaService: KnexQueueSchemaService
   const tableName = 'queue_jobs_worker_test'
   const schedulesTableName = 'queue_schedules_worker_test'
 
@@ -100,7 +100,7 @@ test.group('Worker Adapter | Knex (PostgreSQL)', (group) => {
       },
     })
 
-    schemaService = new QueueSchemaService(connection)
+    schemaService = new KnexQueueSchemaService(connection)
     await schemaService.dropJobsTable(tableName)
     await schemaService.dropSchedulesTable(schedulesTableName)
     await schemaService.createJobsTable(tableName)

tests/worker_concurrency.spec.ts

@@ -3,7 +3,7 @@ import { test } from '@japa/runner'
 import { Redis } from 'ioredis'
 import { RedisAdapter } from '../src/drivers/redis_adapter.js'
 import { KnexAdapter } from '../src/drivers/knex_adapter.js'
-import { QueueSchemaService } from '../src/services/queue_schema.js'
+import { KnexQueueSchemaService } from '../src/services/knex_queue_schema.js'
 import { registerWorkerConcurrencyTestSuite } from './_utils/register_worker_concurrency_suite.js'
 
 const KEY_PREFIX = 'boringnode::queue::concurrency-test::'
@@ -38,7 +38,7 @@ test.group('Worker Concurrency | Redis', (group) => {
 test.group('Worker Concurrency | Knex (PostgreSQL)', (group) => {
   let connection: ReturnType<typeof Knex>
   let adapter: KnexAdapter
-  let schemaService: QueueSchemaService
+  let schemaService: KnexQueueSchemaService
   const tableName = 'queue_jobs_concurrency_test'
   const schedulesTableName = 'queue_schedules_concurrency_test'
 
@@ -54,7 +54,7 @@ test.group('Worker Concurrency | Knex (PostgreSQL)', (group) => {
       },
     })
 
-    schemaService = new QueueSchemaService(connection)
+    schemaService = new KnexQueueSchemaService(connection)
 
     // Drop both tables to ensure clean state
     await schemaService.dropJobsTable(tableName)