@geekmidas/testkit 0.0.5 → 0.0.7

package/dist/objection.mjs

@@ -1,4 +1,84 @@
-import "./Factory-DlzMkMzb.mjs";
-import { ObjectionFactory } from "./ObjectionFactory-ChuX8sZN.mjs";
+import "./Factory-z2m01hMj.mjs";
+import { ObjectionFactory } from "./ObjectionFactory-89p-FFEw.mjs";
+import { IsolationLevel } from "./VitestTransactionIsolator-kFL36T8x.mjs";
+import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransactionIsolator-BZRYy8iW.mjs";
 
-export { ObjectionFactory };
+//#region src/objection.ts
+/**
+* Creates a wrapped Vitest test API with automatic transaction rollback for Objection.js.
+* Each test runs in an isolated database transaction that is rolled back after completion.
+* This ensures tests don't affect each other's data and run faster than truncating tables.
+*
+* @param api - The Vitest test API (usually `test` from vitest)
+* @param knex - The Knex database connection instance
+* @param setup - Optional setup function to run before each test in the transaction
+* @param level - Transaction isolation level (defaults to REPEATABLE_READ)
+* @returns A wrapped test API that provides transaction isolation
+*
+* @example
+* ```typescript
+* import { test } from 'vitest';
+* import { wrapVitestObjectionTransaction } from '@geekmidas/testkit/objection';
+* import { knex } from './database';
+* import { User, Post } from './models';
+*
+* // Create isolated test with automatic rollback
+* const isolatedTest = wrapVitestObjectionTransaction(test, knex);
+*
+* // Use in tests - each test gets its own transaction
+* isolatedTest('should create user', async ({ trx }) => {
+*   const user = await User.query(trx)
+*     .insert({ name: 'Test User', email: 'test@example.com' });
+*
+*   expect(user).toBeDefined();
+*   // User is automatically rolled back after test
+* });
+*
+* // With setup function for common test data
+* const testWithSetup = wrapVitestObjectionTransaction(
+*   test,
+*   knex,
+*   async (trx) => {
+*     // Create common test data
+*     await knex('settings')
+*       .transacting(trx)
+*       .insert({ key: 'test_mode', value: 'true' });
+*   }
+* );
+*
+* testWithSetup('should have test settings', async ({ trx }) => {
+*   const setting = await knex('settings')
+*     .transacting(trx)
+*     .where('key', 'test_mode')
+*     .first();
+*
+*   expect(setting?.value).toBe('true');
+* });
+*
+* // Example with factory and transaction
+* const isolatedTest = wrapVitestObjectionTransaction(test, knex);
+* const factory = new ObjectionFactory(builders, seeds, knex);
+*
+* isolatedTest('creates related data', async ({ trx }) => {
+*   // Factory can use the transaction
+*   const user = await User.query(trx).insert({ name: 'Author' });
+*   const posts = await Post.query(trx).insert([
+*     { title: 'Post 1', userId: user.id },
+*     { title: 'Post 2', userId: user.id }
+*   ]);
+*
+*   const userWithPosts = await User.query(trx)
+*     .findById(user.id)
+*     .withGraphFetched('posts');
+*
+*   expect(userWithPosts.posts).toHaveLength(2);
+* });
+* ```
+*/
+function wrapVitestObjectionTransaction(api, knex, setup, level = IsolationLevel.REPEATABLE_READ) {
+	const wrapper = new VitestObjectionTransactionIsolator(api);
+	return wrapper.wrapVitestWithTransaction(knex, setup, level);
+}
+
+//#endregion
+export { IsolationLevel, ObjectionFactory, VitestObjectionTransactionIsolator, wrapVitestObjectionTransaction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/testkit",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "private": false,
   "type": "module",
   "exports": {
@@ -37,6 +37,6 @@
     "objection": "~3.1.5",
     "db-errors": "~0.2.3",
     "vitest": "~3.2.4",
-    "@geekmidas/envkit": "0.0.3"
+    "@geekmidas/envkit": "0.0.4"
   }
 }

package/src/Factory.ts

@@ -1,9 +1,50 @@
 import type { FakerFactory } from './faker';
 
+/**
+ * Abstract base class for database factories used in testing.
+ * Provides a standardized interface for creating test data using builder and seed patterns.
+ *
+ * @template Builders - Record of builder functions for creating individual entities
+ * @template Seeds - Record of seed functions for creating complex test scenarios
+ *
+ * @example
+ * ```typescript
+ * // Define builders for creating individual records
+ * const builders = {
+ *   user: (attrs) => ({ name: 'Test User', email: 'test@example.com', ...attrs }),
+ *   post: (attrs) => ({ title: 'Test Post', content: 'Content', ...attrs })
+ * };
+ *
+ * // Define seeds for complex scenarios
+ * const seeds = {
+ *   userWithPosts: async (attrs, factory) => {
+ *     const user = await factory.insert('user', attrs);
+ *     await factory.insertMany(3, 'post', { userId: user.id });
+ *     return user;
+ *   }
+ * };
+ * ```
+ */
 export abstract class Factory<
   Builders extends Record<string, any>,
   Seeds extends Record<string, any>,
 > {
+  /**
+   * Creates a typed seed function with proper type inference.
+   * This is a utility method to help with TypeScript type checking when defining seeds.
+   *
+   * @template Seed - The seed function type
+   * @param seedFn - The seed function to wrap
+   * @returns The same seed function with proper typing
+   *
+   * @example
+   * ```typescript
+   * const userWithPostsSeed = Factory.createSeed(async (attrs, factory, db) => {
+   *   const user = await factory.insert('user', attrs);
+   *   return user;
+   * });
+   * ```
+   */
   static createSeed<Seed extends FactorySeed>(seedFn: Seed): Seed {
     return seedFn;
   }
@@ -46,6 +87,33 @@ export abstract class Factory<
   ): ReturnType<Seeds[K]>;
 }
 
+/**
+ * Type definition for a factory builder function that can work with different database types.
+ * Builders are responsible for creating individual database records with default values and relationships.
+ *
+ * @template Attrs - The attributes/input type for the builder
+ * @template Factory - The factory instance type
+ * @template Result - The type of object returned by the builder
+ * @template DB - The database connection type (Kysely, Knex, etc.)
+ *
+ * @param attrs - Partial attributes to override defaults
+ * @param factory - The factory instance for creating related records
+ * @param db - The database connection
+ * @returns The created record or a promise resolving to it
+ *
+ * @example
+ * ```typescript
+ * const userBuilder: MixedFactoryBuilder<UserAttrs, Factory, User, Kysely<DB>> =
+ *   async (attrs, factory, db) => {
+ *     return {
+ *       id: faker.string.uuid(),
+ *       name: faker.person.fullName(),
+ *       email: faker.internet.email(),
+ *       ...attrs
+ *     };
+ *   };
+ * ```
+ */
 export type MixedFactoryBuilder<
   Attrs = any,
   Factory = any,
@@ -53,6 +121,35 @@ export type MixedFactoryBuilder<
   DB = any,
 > = (attrs: Attrs, factory: Factory, db: DB) => Result | Promise<Result>;
 
+/**
+ * Type definition for a factory seed function used to create complex test scenarios.
+ * Seeds typically create multiple related records to set up a complete test environment.
+ *
+ * @template Attrs - The attributes/input type for the seed
+ * @template Factory - The factory instance type
+ * @template Result - The type of object returned by the seed
+ * @template DB - The database connection type (Kysely, Knex, etc.)
+ *
+ * @param attrs - Configuration attributes for the seed
+ * @param factory - The factory instance for creating records
+ * @param db - The database connection
+ * @returns A promise resolving to the seed result
+ *
+ * @example
+ * ```typescript
+ * const userWithPostsSeed: FactorySeed<{ postCount?: number }, Factory, User, DB> =
+ *   async (attrs, factory, db) => {
+ *     const user = await factory.insert('user', attrs);
+ *     const postCount = attrs.postCount || 3;
+ *
+ *     for (let i = 0; i < postCount; i++) {
+ *       await factory.insert('post', { userId: user.id });
+ *     }
+ *
+ *     return user;
+ *   };
+ * ```
+ */
 export type FactorySeed<Attrs = any, Factory = any, Result = any, DB = any> = (
   attrs: Attrs,
   factory: Factory,

package/src/KyselyFactory.ts

@@ -7,15 +7,68 @@ import type {
 import { Factory, type FactorySeed } from './Factory.ts';
 import { type FakerFactory, faker } from './faker.ts';
 
+/**
+ * Factory implementation for Kysely ORM, providing test data creation utilities.
+ * Extends the base Factory class with Kysely-specific database operations.
+ *
+ * @template DB - The database schema type
+ * @template Builders - Record of builder functions for creating entities
+ * @template Seeds - Record of seed functions for complex test scenarios
+ *
+ * @example
+ * ```typescript
+ * // Define your database schema
+ * interface Database {
+ *   users: UsersTable;
+ *   posts: PostsTable;
+ * }
+ *
+ * // Create builders
+ * const builders = {
+ *   user: KyselyFactory.createBuilder<Database, 'users'>('users', (attrs, factory, db, faker) => ({
+ *     id: faker.string.uuid(),
+ *     name: faker.person.fullName(),
+ *     email: faker.internet.email(),
+ *     ...attrs
+ *   })),
+ *   post: KyselyFactory.createBuilder<Database, 'posts'>('posts', (attrs) => ({
+ *     title: 'Test Post',
+ *     content: 'Test content',
+ *     ...attrs
+ *   }))
+ * };
+ *
+ * // Create factory instance
+ * const factory = new KyselyFactory(builders, seeds, db);
+ *
+ * // Use in tests
+ * const user = await factory.insert('user', { name: 'John Doe' });
+ * ```
+ */
 export class KyselyFactory<
   DB,
   Builders extends Record<string, any>,
   Seeds extends Record<string, any>,
 > extends Factory<Builders, Seeds> {
+  /**
+   * Creates a typed seed function with proper type inference.
+   * Inherits from the base Factory class implementation.
+   *
+   * @template Seed - The seed function type
+   * @param seedFn - The seed function to wrap
+   * @returns The same seed function with proper typing
+   */
   static createSeed<Seed extends FactorySeed>(seedFn: Seed): Seed {
     return Factory.createSeed(seedFn);
   }
 
+  /**
+   * Creates a new KyselyFactory instance.
+   *
+   * @param builders - Record of builder functions for creating individual entities
+   * @param seeds - Record of seed functions for creating complex test scenarios
+   * @param db - Kysely database instance or controlled transaction
+   */
   constructor(
     private builders: Builders,
     private seeds: Seeds,
@@ -24,6 +77,45 @@ export class KyselyFactory<
     super();
   }
 
+  /**
+   * Creates a typed builder function for a specific database table.
+   * This is a utility method that helps create builders with proper type inference for Kysely.
+   *
+   * @template DB - The database schema type
+   * @template TableName - The name of the table (must be a key of DB)
+   * @template Attrs - The attributes type for the builder (defaults to Partial<Insertable>)
+   * @template Factory - The factory instance type
+   * @template Result - The result type (defaults to Selectable of the table)
+   *
+   * @param table - The name of the database table
+   * @param item - Optional function to provide default values and transformations
+   * @param autoInsert - Whether to automatically insert the record (default: true)
+   * @returns A builder function that creates and optionally inserts records
+   *
+   * @example
+   * ```typescript
+   * // Create a simple builder with defaults
+   * const userBuilder = KyselyFactory.createBuilder<DB, 'users'>('users',
+   *   (attrs, factory, db, faker) => ({
+   *     id: faker.string.uuid(),
+   *     name: faker.person.fullName(),
+   *     email: faker.internet.email(),
+   *     createdAt: new Date(),
+   *     ...attrs
+   *   })
+   * );
+   *
+   * // Create a builder that doesn't auto-insert (useful for nested inserts)
+   * const addressBuilder = KyselyFactory.createBuilder<DB, 'addresses'>('addresses',
+   *   (attrs) => ({
+   *     street: '123 Main St',
+   *     city: 'Anytown',
+   *     ...attrs
+   *   }),
+   *   false // Don't auto-insert
+   * );
+   * ```
+   */
   static createBuilder<
     DB,
     TableName extends keyof DB & string,
@@ -85,6 +177,35 @@ export class KyselyFactory<
     };
   }
 
+  /**
+   * Inserts a single record into the database using the specified builder.
+   * The builder function is responsible for generating the record data with defaults
+   * and the factory handles the actual database insertion.
+   *
+   * @template K - The builder name (must be a key of Builders)
+   * @param builderName - The name of the builder to use
+   * @param attrs - Optional attributes to override builder defaults
+   * @returns A promise resolving to the inserted record
+   * @throws Error if the specified builder doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Insert with defaults
+   * const user = await factory.insert('user');
+   *
+   * // Insert with overrides
+   * const adminUser = await factory.insert('user', {
+   *   email: 'admin@example.com',
+   *   role: 'admin'
+   * });
+   *
+   * // Use the inserted record
+   * const post = await factory.insert('post', {
+   *   userId: user.id,
+   *   title: 'My First Post'
+   * });
+   * ```
+   */
   async insert<K extends keyof Builders>(
     builderName: K,
     attrs?: Parameters<Builders[K]>[0],
@@ -126,6 +247,36 @@ export class KyselyFactory<
     return result;
   }
 
+  /**
+   * Inserts multiple records into the database using the specified builder.
+   * Supports both static attributes and dynamic attribute generation via a function.
+   *
+   * @template K - The builder name (must be a key of Builders)
+   * @param count - The number of records to insert
+   * @param builderName - The name of the builder to use
+   * @param attrs - Static attributes or a function that generates attributes for each record
+   * @returns A promise resolving to an array of inserted records
+   * @throws Error if the specified builder doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Insert multiple with same attributes
+   * const users = await factory.insertMany(5, 'user', { role: 'member' });
+   *
+   * // Insert multiple with dynamic attributes
+   * const posts = await factory.insertMany(10, 'post', (idx, faker) => ({
+   *   title: `Post ${idx + 1}`,
+   *   content: faker.lorem.paragraph(),
+   *   publishedAt: faker.date.past()
+   * }));
+   *
+   * // Create users with sequential emails
+   * const admins = await factory.insertMany(3, 'user', (idx) => ({
+   *   email: `admin${idx + 1}@example.com`,
+   *   role: 'admin'
+   * }));
+   * ```
+   */
   // Method overloads for better type inference
   async insertMany<K extends keyof Builders>(
     count: number,
@@ -160,6 +311,35 @@ export class KyselyFactory<
     return Promise.all(promises);
   }
 
+  /**
+   * Executes a seed function to create complex test scenarios with multiple related records.
+   * Seeds are useful for setting up complete test environments with realistic data relationships.
+   *
+   * @template K - The seed name (must be a key of Seeds)
+   * @param seedName - The name of the seed to execute
+   * @param attrs - Optional configuration attributes for the seed
+   * @returns The result of the seed function (typically the primary record created)
+   * @throws Error if the specified seed doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Execute a simple seed
+   * const user = await factory.seed('userWithProfile');
+   *
+   * // Execute a seed with configuration
+   * const author = await factory.seed('authorWithBooks', {
+   *   bookCount: 5,
+   *   includeReviews: true
+   * });
+   *
+   * // Use seed result in tests
+   * const company = await factory.seed('companyWithDepartments', {
+   *   departmentCount: 3,
+   *   employeesPerDepartment: 10
+   * });
+   * expect(company.departments).toHaveLength(3);
+   * ```
+   */
   seed<K extends keyof Seeds>(
     seedName: K,
     attrs?: Parameters<Seeds[K]>[0],

package/src/ObjectionFactory.ts

@@ -1,14 +1,65 @@
 import type { Knex } from 'knex';
 import { Factory, type FactorySeed } from './Factory.ts';
 
+/**
+ * Factory implementation for Objection.js ORM, providing test data creation utilities.
+ * Extends the base Factory class with Objection.js-specific database operations.
+ *
+ * @template Builders - Record of builder functions for creating entities
+ * @template Seeds - Record of seed functions for complex test scenarios
+ *
+ * @example
+ * ```typescript
+ * // Define your models with Objection.js
+ * class User extends Model {
+ *   static tableName = 'users';
+ * }
+ *
+ * // Create builders
+ * const builders = {
+ *   user: (attrs) => User.fromJson({
+ *     id: faker.string.uuid(),
+ *     name: faker.person.fullName(),
+ *     email: faker.internet.email(),
+ *     ...attrs
+ *   }),
+ *   post: (attrs) => Post.fromJson({
+ *     title: 'Test Post',
+ *     content: 'Test content',
+ *     ...attrs
+ *   })
+ * };
+ *
+ * // Create factory instance
+ * const factory = new ObjectionFactory(builders, seeds, knex);
+ *
+ * // Use in tests
+ * const user = await factory.insert('user', { name: 'John Doe' });
+ * ```
+ */
 export class ObjectionFactory<
   Builders extends Record<string, any>,
   Seeds extends Record<string, any>,
 > extends Factory<Builders, Seeds> {
+  /**
+   * Creates a typed seed function with proper type inference.
+   * Inherits from the base Factory class implementation.
+   *
+   * @template Seed - The seed function type
+   * @param seedFn - The seed function to wrap
+   * @returns The same seed function with proper typing
+   */
   static createSeed<Seed extends FactorySeed>(seedFn: Seed): Seed {
     return Factory.createSeed(seedFn);
   }
 
+  /**
+   * Creates a new ObjectionFactory instance.
+   *
+   * @param builders - Record of builder functions for creating individual entities
+   * @param seeds - Record of seed functions for creating complex test scenarios
+   * @param db - Knex database connection instance
+   */
   constructor(
     private builders: Builders,
     private seeds: Seeds,
@@ -17,7 +68,37 @@ export class ObjectionFactory<
     super();
   }
 
-  insert(factory, attrs = {}) {
+  /**
+   * Inserts a single record into the database using the specified builder.
+   * Uses Objection.js's insertGraph method to handle nested relations.
+   *
+   * @param factory - The name of the builder to use
+   * @param attrs - Optional attributes to override builder defaults
+   * @returns A promise resolving to the inserted record with all relations
+   * @throws Error if the specified builder doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Insert with defaults
+   * const user = await factory.insert('user');
+   *
+   * // Insert with overrides
+   * const adminUser = await factory.insert('user', {
+   *   email: 'admin@example.com',
+   *   role: 'admin'
+   * });
+   *
+   * // Insert with nested relations
+   * const userWithProfile = await factory.insert('user', {
+   *   name: 'John Doe',
+   *   profile: {
+   *     bio: 'Software Developer',
+   *     avatar: 'avatar.jpg'
+   *   }
+   * });
+   * ```
+   */
+  insert(factory: keyof Builders, attrs: any = {}) {
     if (!(factory in this.builders)) {
       throw new Error(
         `Factory "${
@@ -30,7 +111,36 @@ export class ObjectionFactory<
       return record.$query(this.db).insertGraph(record).execute();
     }) as any;
   }
-  insertMany(count, builderName, attrs = {}) {
+  /**
+   * Inserts multiple records into the database using the specified builder.
+   * Supports both static attributes and dynamic attribute generation via a function.
+   *
+   * @param count - The number of records to insert
+   * @param builderName - The name of the builder to use
+   * @param attrs - Static attributes or a function that generates attributes for each record
+   * @returns A promise resolving to an array of inserted records
+   * @throws Error if the specified builder doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Insert multiple with same attributes
+   * const users = await factory.insertMany(5, 'user', { role: 'member' });
+   *
+   * // Insert multiple with dynamic attributes
+   * const posts = await factory.insertMany(10, 'post', (idx) => ({
+   *   title: `Post ${idx + 1}`,
+   *   content: `Content for post ${idx + 1}`,
+   *   publishedAt: new Date()
+   * }));
+   *
+   * // Create users with sequential emails
+   * const admins = await factory.insertMany(3, 'user', (idx) => ({
+   *   email: `admin${idx + 1}@example.com`,
+   *   role: 'admin'
+   * }));
+   * ```
+   */
+  insertMany(count: number, builderName: keyof Builders, attrs: any = {}) {
     if (!(builderName in this.builders)) {
       throw new Error(
         `Builder "${
@@ -52,7 +162,39 @@ export class ObjectionFactory<
 
     return Promise.all(records);
   }
-  seed(seedName, attrs = {}) {
+  /**
+   * Executes a seed function to create complex test scenarios with multiple related records.
+   * Seeds are useful for setting up complete test environments with realistic data relationships.
+   *
+   * @param seedName - The name of the seed to execute
+   * @param attrs - Optional configuration attributes for the seed
+   * @returns The result of the seed function (typically the primary record created)
+   * @throws Error if the specified seed doesn't exist
+   *
+   * @example
+   * ```typescript
+   * // Execute a simple seed
+   * const user = await factory.seed('userWithProfile');
+   *
+   * // Execute a seed with configuration
+   * const author = await factory.seed('authorWithBooks', {
+   *   bookCount: 5,
+   *   includeReviews: true
+   * });
+   *
+   * // Use seed result in tests with Objection.js relations
+   * const company = await factory.seed('companyWithDepartments', {
+   *   departmentCount: 3,
+   *   employeesPerDepartment: 10
+   * });
+   *
+   * // Access eager loaded relations
+   * const companyWithRelations = await Company.query()
+   *   .findById(company.id)
+   *   .withGraphFetched('[departments.employees]');
+   * ```
+   */
+  seed(seedName: keyof Seeds, attrs: any = {}) {
     if (!(seedName in this.seeds)) {
       throw new Error(
         `Seed "${

package/src/PostgresKyselyMigrator.ts

@@ -1,9 +1,56 @@
 import { type Kysely, type MigrationProvider, Migrator } from 'kysely';
 import { PostgresMigrator } from './PostgresMigrator';
 
+/**
+ * Default logger instance for migration operations.
+ */
 const logger = console;
 
+/**
+ * PostgreSQL migrator implementation for Kysely ORM.
+ * Extends PostgresMigrator to provide Kysely-specific migration functionality.
+ * Automatically creates test databases and applies migrations for testing environments.
+ *
+ * @example
+ * ```typescript
+ * import { FileMigrationProvider } from 'kysely';
+ * import { PostgresKyselyMigrator } from '@geekmidas/testkit';
+ *
+ * // Create migration provider
+ * const provider = new FileMigrationProvider({
+ *   fs: require('fs'),
+ *   path: require('path'),
+ *   migrationFolder: path.join(__dirname, 'migrations')
+ * });
+ *
+ * // Create Kysely instance
+ * const db = new Kysely<Database>({
+ *   dialect: new PostgresDialect({
+ *     pool: new Pool({ connectionString: uri })
+ *   })
+ * });
+ *
+ * // Create and use migrator
+ * const migrator = new PostgresKyselyMigrator({
+ *   uri: 'postgresql://localhost:5432/test_db',
+ *   db,
+ *   provider
+ * });
+ *
+ * const cleanup = await migrator.start();
+ * // Run tests...
+ * await cleanup();
+ * ```
+ */
 export class PostgresKyselyMigrator extends PostgresMigrator {
+  /**
+   * Creates a new PostgresKyselyMigrator instance.
+   *
+   * @param options - Configuration options
+   * @param options.uri - PostgreSQL connection URI
+   * @param options.db - Kysely database instance
+   * @param options.provider - Migration provider for locating migration files
+   */
   constructor(
     private options: {
       uri: string;
@@ -14,6 +61,13 @@ export class PostgresKyselyMigrator extends PostgresMigrator {
     super(options.uri);
   }
 
+  /**
+   * Executes Kysely migrations to the latest version.
+   * Implements the abstract migrate() method from PostgresMigrator.
+   *
+   * @throws Error if migrations fail to apply
+   * @returns Promise that resolves when all migrations are applied
+   */
   async migrate(): Promise<void> {
     const migrator = new Migrator({
       db: this.options.db,