@geekmidas/testkit 0.0.10 → 0.0.12

package/dist/{ObjectionFactory-89p-FFEw.mjs → ObjectionFactory-qIICOph3.mjs}

@@ -1,4 +1,5 @@
 import { Factory } from "./Factory-z2m01hMj.mjs";
+import { faker } from "./faker-BGKYFoCT.mjs";
 
 //#region src/ObjectionFactory.ts
 /**
@@ -50,6 +51,71 @@ var ObjectionFactory = class extends Factory {
 		return Factory.createSeed(seedFn);
 	}
 	/**
+	* Creates a typed builder function for Objection.js models.
+	* This is a utility method that helps create builders with proper type inference.
+	*
+	* @template TModel - The Objection.js Model class type
+	* @template Attrs - The attributes type for the builder (defaults to Partial of model)
+	* @template Factory - The factory instance type
+	* @template Result - The result type (defaults to the model instance)
+	*
+	* @param ModelClass - The Objection.js Model class
+	* @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 = ObjectionFactory.createBuilder(User,
+	*   (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 = ObjectionFactory.createBuilder(Address,
+	*   (attrs) => ({
+	*     street: '123 Main St',
+	*     city: 'Anytown',
+	*     ...attrs
+	*   }),
+	*   false // Don't auto-insert
+	* );
+	*
+	* // Use with relations
+	* const postBuilder = ObjectionFactory.createBuilder(Post,
+	*   async (attrs, factory) => ({
+	*     title: faker.lorem.sentence(),
+	*     content: faker.lorem.paragraphs(),
+	*     authorId: attrs.authorId || (await factory.insert('user')).id,
+	*     ...attrs
+	*   })
+	* );
+	* ```
+	*/
+	static createBuilder(ModelClass, item, autoInsert) {
+		return async (attrs, factory, db, faker$1) => {
+			let data = { ...attrs };
+			if (item) {
+				const defaults = await item(attrs, factory, db, faker$1);
+				data = {
+					...defaults,
+					...data
+				};
+			}
+			const model = ModelClass.fromJson(data);
+			if (autoInsert !== false) {
+				const result = await model.$query(db).insertGraph(model).execute();
+				return result;
+			} else return model;
+		};
+	}
+	/**
 	* Creates a new ObjectionFactory instance.
 	*
 	* @param builders - Record of builder functions for creating individual entities
@@ -66,7 +132,8 @@ var ObjectionFactory = class extends Factory {
 	* 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
+	* @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 with all relations
 	* @throws Error if the specified builder doesn't exist
@@ -92,47 +159,21 @@ var ObjectionFactory = class extends Factory {
 	* });
 	* ```
 	*/
-	insert(factory, attrs = {}) {
-		if (!(factory in this.builders)) throw new Error(`Factory "${factory}" does not exist. Make sure it is correct and registered in src/test/setup.ts`);
-		return this.builders[factory](attrs, {}, this.db).then((record) => {
-			return record.$query(this.db).insertGraph(record).execute();
-		});
+	async insert(builderName, attrs) {
+		if (!(builderName in this.builders)) throw new Error(`Factory "${builderName}" does not exist. Make sure it is correct and registered in src/test/setup.ts`);
+		const result = await this.builders[builderName](attrs || {}, this, this.db, faker);
+		if (result && typeof result.$query === "function") return await result.$query(this.db).insertGraph(result).execute();
+		return result;
 	}
-	/**
-	* 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, builderName, attrs = {}) {
+	async insertMany(count, builderName, attrs) {
 		if (!(builderName in this.builders)) throw new Error(`Builder "${builderName}" is not registered in this factory. Make sure it is correct and registered in src/test/setup.ts`);
 		const records = [];
 		for (let i = 0; i < count; i++) {
-			const newAttrs = typeof attrs === "function" ? attrs(i) : attrs;
-			records.push(this.builders[builderName](newAttrs, {}, this.db).then((record) => record.$query(this.db).insertGraph(record).execute()));
+			const newAttrs = typeof attrs === "function" ? attrs(i, faker) : attrs;
+			records.push(this.builders[builderName](newAttrs, this, this.db, faker).then((record) => {
+				if (record && typeof record.$query === "function") return record.$query(this.db).insertGraph(record).execute();
+				return record;
+			}));
 		}
 		return Promise.all(records);
 	}
@@ -140,6 +181,7 @@ var ObjectionFactory = class extends Factory {
 	* 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)
@@ -168,9 +210,9 @@ var ObjectionFactory = class extends Factory {
 	*   .withGraphFetched('[departments.employees]');
 	* ```
 	*/
-	seed(seedName, attrs = {}) {
+	seed(seedName, attrs) {
 		if (!(seedName in this.seeds)) throw new Error(`Seed "${seedName}" is not registered in this factory. Make sure it is correct and registered in src/test/setup.ts`);
-		return this.seeds[seedName](attrs, this, this.db);
+		return this.seeds[seedName](attrs || {}, this, this.db);
 	}
 };
 

package/dist/ObjectionFactory.cjs

@@ -1,4 +1,5 @@
 require('./Factory-WMhTNZ9S.cjs');
-const require_ObjectionFactory = require('./ObjectionFactory-C47B03Ot.cjs');
+require('./faker-B14IEMIN.cjs');
+const require_ObjectionFactory = require('./ObjectionFactory-DxIxJagq.cjs');
 
 exports.ObjectionFactory = require_ObjectionFactory.ObjectionFactory;

package/dist/ObjectionFactory.d.cts

@@ -0,0 +1,4 @@
+import "./faker-km9UhOS6.cjs";
+import "./Factory-Bm44VKa-.cjs";
+import { ObjectionFactory } from "./ObjectionFactory-BWMTXsxH.cjs";
+export { ObjectionFactory };

package/dist/ObjectionFactory.d.mts

@@ -0,0 +1,4 @@
+import "./faker-ChuHaYMR.mjs";
+import "./Factory-tjCDNgUK.mjs";
+import { ObjectionFactory } from "./ObjectionFactory-CEG5qUrm.mjs";
+export { ObjectionFactory };

package/dist/ObjectionFactory.mjs

@@ -1,4 +1,5 @@
 import "./Factory-z2m01hMj.mjs";
-import { ObjectionFactory } from "./ObjectionFactory-89p-FFEw.mjs";
+import "./faker-BGKYFoCT.mjs";
+import { ObjectionFactory } from "./ObjectionFactory-qIICOph3.mjs";
 
 export { ObjectionFactory };

package/dist/PostgresKyselyMigrator-CQ3aUoy_.d.cts

@@ -0,0 +1,67 @@
+import { PostgresMigrator } from "./PostgresMigrator-D5UkK1_K.cjs";
+import { Kysely, MigrationProvider } from "kysely";
+
+//#region src/PostgresKyselyMigrator.d.ts
+
+/**
+ * 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();
+ * ```
+ */
+declare class PostgresKyselyMigrator extends PostgresMigrator {
+  private options;
+  /**
+   * 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(options: {
+    uri: string;
+    db: Kysely<any>;
+    provider: MigrationProvider;
+  });
+  /**
+   * 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
+   */
+  migrate(): Promise<void>;
+}
+//#endregion
+export { PostgresKyselyMigrator };

package/dist/PostgresKyselyMigrator-_6yHZigp.d.mts

@@ -0,0 +1,67 @@
+import { PostgresMigrator } from "./PostgresMigrator-BlvuQl7d.mjs";
+import { Kysely, MigrationProvider } from "kysely";
+
+//#region src/PostgresKyselyMigrator.d.ts
+
+/**
+ * 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();
+ * ```
+ */
+declare class PostgresKyselyMigrator extends PostgresMigrator {
+  private options;
+  /**
+   * 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(options: {
+    uri: string;
+    db: Kysely<any>;
+    provider: MigrationProvider;
+  });
+  /**
+   * 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
+   */
+  migrate(): Promise<void>;
+}
+//#endregion
+export { PostgresKyselyMigrator };

package/dist/PostgresKyselyMigrator.d.cts

@@ -0,0 +1,3 @@
+import "./PostgresMigrator-D5UkK1_K.cjs";
+import { PostgresKyselyMigrator } from "./PostgresKyselyMigrator-CQ3aUoy_.cjs";
+export { PostgresKyselyMigrator };

package/dist/PostgresKyselyMigrator.d.mts

@@ -0,0 +1,3 @@
+import "./PostgresMigrator-BlvuQl7d.mjs";
+import { PostgresKyselyMigrator } from "./PostgresKyselyMigrator-_6yHZigp.mjs";
+export { PostgresKyselyMigrator };

package/dist/PostgresMigrator-BlvuQl7d.d.mts

@@ -0,0 +1,84 @@
+//#region src/PostgresMigrator.d.ts
+/**
+ * Abstract base class for PostgreSQL database migration utilities.
+ * Provides database creation, migration, and cleanup functionality for testing.
+ * Subclasses must implement the migrate() method to define migration logic.
+ *
+ * @example
+ * ```typescript
+ * class MyMigrator extends PostgresMigrator {
+ *   async migrate(): Promise<void> {
+ *     // Run your migrations here
+ *     await this.runMigrations();
+ *   }
+ * }
+ *
+ * // Use in tests
+ * const migrator = new MyMigrator('postgresql://localhost:5432/test_db');
+ * const cleanup = await migrator.start();
+ *
+ * // Run tests...
+ *
+ * // Clean up
+ * await cleanup();
+ * ```
+ */
+declare abstract class PostgresMigrator {
+  private uri;
+  /**
+   * Creates a new PostgresMigrator instance.
+   *
+   * @param uri - PostgreSQL connection URI
+   */
+  constructor(uri: string);
+  /**
+   * Abstract method to be implemented by subclasses.
+   * Should contain the migration logic for setting up database schema.
+   *
+   * @returns Promise that resolves when migrations are complete
+   */
+  abstract migrate(): Promise<void>;
+  /**
+   * Creates a PostgreSQL database if it doesn't already exist.
+   * Connects to the 'postgres' database to check and create the target database.
+   *
+   * @param uri - PostgreSQL connection URI
+   * @returns Object indicating whether the database already existed
+   * @private
+   */
+  private static create;
+  /**
+   * Drops a PostgreSQL database.
+   * Used for cleanup after tests are complete.
+   *
+   * @param uri - PostgreSQL connection URI
+   * @throws Error if database cannot be dropped
+   * @private
+   */
+  private static drop;
+  /**
+   * Starts the migration process by creating the database and running migrations.
+   * Returns a cleanup function that will drop the database when called.
+   *
+   * @returns Async cleanup function that drops the created database
+   *
+   * @example
+   * ```typescript
+   * const migrator = new MyMigrator('postgresql://localhost:5432/test_db');
+   *
+   * // Start migrations and get cleanup function
+   * const cleanup = await migrator.start();
+   *
+   * try {
+   *   // Run your tests here
+   *   await runTests();
+   * } finally {
+   *   // Always clean up
+   *   await cleanup();
+   * }
+   * ```
+   */
+  start(): Promise<() => Promise<void>>;
+}
+//#endregion
+export { PostgresMigrator };

package/dist/PostgresMigrator-D5UkK1_K.d.cts

@@ -0,0 +1,84 @@
+//#region src/PostgresMigrator.d.ts
+/**
+ * Abstract base class for PostgreSQL database migration utilities.
+ * Provides database creation, migration, and cleanup functionality for testing.
+ * Subclasses must implement the migrate() method to define migration logic.
+ *
+ * @example
+ * ```typescript
+ * class MyMigrator extends PostgresMigrator {
+ *   async migrate(): Promise<void> {
+ *     // Run your migrations here
+ *     await this.runMigrations();
+ *   }
+ * }
+ *
+ * // Use in tests
+ * const migrator = new MyMigrator('postgresql://localhost:5432/test_db');
+ * const cleanup = await migrator.start();
+ *
+ * // Run tests...
+ *
+ * // Clean up
+ * await cleanup();
+ * ```
+ */
+declare abstract class PostgresMigrator {
+  private uri;
+  /**
+   * Creates a new PostgresMigrator instance.
+   *
+   * @param uri - PostgreSQL connection URI
+   */
+  constructor(uri: string);
+  /**
+   * Abstract method to be implemented by subclasses.
+   * Should contain the migration logic for setting up database schema.
+   *
+   * @returns Promise that resolves when migrations are complete
+   */
+  abstract migrate(): Promise<void>;
+  /**
+   * Creates a PostgreSQL database if it doesn't already exist.
+   * Connects to the 'postgres' database to check and create the target database.
+   *
+   * @param uri - PostgreSQL connection URI
+   * @returns Object indicating whether the database already existed
+   * @private
+   */
+  private static create;
+  /**
+   * Drops a PostgreSQL database.
+   * Used for cleanup after tests are complete.
+   *
+   * @param uri - PostgreSQL connection URI
+   * @throws Error if database cannot be dropped
+   * @private
+   */
+  private static drop;
+  /**
+   * Starts the migration process by creating the database and running migrations.
+   * Returns a cleanup function that will drop the database when called.
+   *
+   * @returns Async cleanup function that drops the created database
+   *
+   * @example
+   * ```typescript
+   * const migrator = new MyMigrator('postgresql://localhost:5432/test_db');
+   *
+   * // Start migrations and get cleanup function
+   * const cleanup = await migrator.start();
+   *
+   * try {
+   *   // Run your tests here
+   *   await runTests();
+   * } finally {
+   *   // Always clean up
+   *   await cleanup();
+   * }
+   * ```
+   */
+  start(): Promise<() => Promise<void>>;
+}
+//#endregion
+export { PostgresMigrator };

package/dist/PostgresMigrator.d.cts

@@ -0,0 +1,2 @@
+import { PostgresMigrator } from "./PostgresMigrator-D5UkK1_K.cjs";
+export { PostgresMigrator };

package/dist/PostgresMigrator.d.mts

@@ -0,0 +1,2 @@
+import { PostgresMigrator } from "./PostgresMigrator-BlvuQl7d.mjs";
+export { PostgresMigrator };

package/dist/PostgresObjectionMigrator-C69n7vzr.d.mts

@@ -0,0 +1,77 @@
+import { PostgresMigrator } from "./PostgresMigrator-BlvuQl7d.mjs";
+import { Knex } from "knex";
+
+//#region src/PostgresObjectionMigrator.d.ts
+
+/**
+ * PostgreSQL migrator implementation for Objection.js ORM with Knex.
+ * Extends PostgresMigrator to provide Knex-specific migration functionality.
+ * Automatically creates test databases and applies migrations for testing environments.
+ *
+ * @example
+ * ```typescript
+ * import knex from 'knex';
+ * import { PostgresObjectionMigrator } from '@geekmidas/testkit';
+ *
+ * // Create Knex instance
+ * const db = knex({
+ *   client: 'pg',
+ *   connection: uri,
+ *   migrations: {
+ *     directory: path.join(__dirname, 'migrations'),
+ *     extension: 'ts'
+ *   }
+ * });
+ *
+ * // Create and use migrator
+ * const migrator = new PostgresObjectionMigrator({
+ *   uri: 'postgresql://localhost:5432/test_db',
+ *   knex: db
+ * });
+ *
+ * const cleanup = await migrator.start();
+ * // Run tests...
+ * await cleanup();
+ * ```
+ */
+declare class PostgresObjectionMigrator extends PostgresMigrator {
+  private options;
+  /**
+   * Creates a new PostgresObjectionMigrator instance.
+   *
+   * @param options - Configuration options
+   * @param options.uri - PostgreSQL connection URI
+   * @param options.knex - Knex database instance configured with migrations
+   */
+  constructor(options: {
+    uri: string;
+    knex: Knex;
+  });
+  /**
+   * Executes Knex 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
+   */
+  migrate(): Promise<void>;
+  /**
+   * Rolls back the last batch of migrations.
+   * Useful for testing migration rollback scenarios.
+   *
+   * @returns Promise that resolves when rollback is complete
+   */
+  rollback(): Promise<void>;
+  /**
+   * Gets the current migration status.
+   * Returns information about completed and pending migrations.
+   *
+   * @returns Promise with migration status information
+   */
+  status(): Promise<{
+    completed: string[];
+    pending: string[];
+  }>;
+}
+//#endregion
+export { PostgresObjectionMigrator };

package/dist/PostgresObjectionMigrator-CZHHcCOv.d.cts

@@ -0,0 +1,77 @@
+import { PostgresMigrator } from "./PostgresMigrator-D5UkK1_K.cjs";
+import { Knex } from "knex";
+
+//#region src/PostgresObjectionMigrator.d.ts
+
+/**
+ * PostgreSQL migrator implementation for Objection.js ORM with Knex.
+ * Extends PostgresMigrator to provide Knex-specific migration functionality.
+ * Automatically creates test databases and applies migrations for testing environments.
+ *
+ * @example
+ * ```typescript
+ * import knex from 'knex';
+ * import { PostgresObjectionMigrator } from '@geekmidas/testkit';
+ *
+ * // Create Knex instance
+ * const db = knex({
+ *   client: 'pg',
+ *   connection: uri,
+ *   migrations: {
+ *     directory: path.join(__dirname, 'migrations'),
+ *     extension: 'ts'
+ *   }
+ * });
+ *
+ * // Create and use migrator
+ * const migrator = new PostgresObjectionMigrator({
+ *   uri: 'postgresql://localhost:5432/test_db',
+ *   knex: db
+ * });
+ *
+ * const cleanup = await migrator.start();
+ * // Run tests...
+ * await cleanup();
+ * ```
+ */
+declare class PostgresObjectionMigrator extends PostgresMigrator {
+  private options;
+  /**
+   * Creates a new PostgresObjectionMigrator instance.
+   *
+   * @param options - Configuration options
+   * @param options.uri - PostgreSQL connection URI
+   * @param options.knex - Knex database instance configured with migrations
+   */
+  constructor(options: {
+    uri: string;
+    knex: Knex;
+  });
+  /**
+   * Executes Knex 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
+   */
+  migrate(): Promise<void>;
+  /**
+   * Rolls back the last batch of migrations.
+   * Useful for testing migration rollback scenarios.
+   *
+   * @returns Promise that resolves when rollback is complete
+   */
+  rollback(): Promise<void>;
+  /**
+   * Gets the current migration status.
+   * Returns information about completed and pending migrations.
+   *
+   * @returns Promise with migration status information
+   */
+  status(): Promise<{
+    completed: string[];
+    pending: string[];
+  }>;
+}
+//#endregion
+export { PostgresObjectionMigrator };

package/dist/PostgresObjectionMigrator.d.cts

@@ -0,0 +1,3 @@
+import "./PostgresMigrator-D5UkK1_K.cjs";
+import { PostgresObjectionMigrator } from "./PostgresObjectionMigrator-CZHHcCOv.cjs";
+export { PostgresObjectionMigrator };

package/dist/PostgresObjectionMigrator.d.mts

@@ -0,0 +1,3 @@
+import "./PostgresMigrator-BlvuQl7d.mjs";
+import { PostgresObjectionMigrator } from "./PostgresObjectionMigrator-C69n7vzr.mjs";
+export { PostgresObjectionMigrator };