@geekmidas/testkit 0.0.10 → 0.0.11

package/dist/ObjectionFactory-CJCpvwts.d.mts

@@ -0,0 +1,213 @@
+import { FakerFactory } from "./faker-nN9Ki6fn.mjs";
+import { Factory, FactorySeed } from "./Factory-DiZSNxC0.mjs";
+import { Knex } from "knex";
+import { Model } from "objection";
+
+//#region src/ObjectionFactory.d.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' });
+ * ```
+ */
+declare class ObjectionFactory<Builders extends Record<string, any>, Seeds extends Record<string, any>> extends Factory<Builders, Seeds> {
+  private builders;
+  private seeds;
+  private db;
+  /**
+   * 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;
+  /**
+   * 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<TModel extends typeof Model, Attrs extends Partial<InstanceType<TModel>> = Partial<InstanceType<TModel>>, Factory = any, Result = InstanceType<TModel>>(ModelClass: TModel, item?: (attrs: Attrs, factory: Factory, db: Knex, faker: FakerFactory) => Partial<InstanceType<TModel>> | Promise<Partial<InstanceType<TModel>>>, autoInsert?: boolean): (attrs: Attrs, factory: Factory, db: Knex, faker: FakerFactory) => Promise<Result>;
+  /**
+   * 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(builders: Builders, seeds: Seeds, db: Knex);
+  /**
+   * Inserts a single record into the database using the specified builder.
+   * Uses Objection.js's insertGraph method to handle nested relations.
+   *
+   * @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
+   *
+   * @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<K extends keyof Builders>(builderName: K, attrs?: Parameters<Builders[K]>[0]): Promise<Awaited<ReturnType<Builders[K]>>>;
+  /**
+   * 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<K extends keyof Builders>(count: number, builderName: K, attrs?: Parameters<Builders[K]>[0]): Promise<Awaited<ReturnType<Builders[K]>>[]>;
+  insertMany<K extends keyof Builders>(count: number, builderName: K, attrs: (idx: number, faker: FakerFactory) => Parameters<Builders[K]>[0]): Promise<Awaited<ReturnType<Builders[K]>>[]>;
+  /**
+   * 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 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<K extends keyof Seeds>(seedName: K, attrs?: Parameters<Seeds[K]>[0]): ReturnType<Seeds[K]>;
+}
+//#endregion
+export { ObjectionFactory };

package/dist/{ObjectionFactory-C47B03Ot.cjs → ObjectionFactory-Wq80ypMM.cjs}

@@ -1,4 +1,5 @@
 const require_Factory = require('./Factory-WMhTNZ9S.cjs');
+const require_faker = require('./faker-SMN4ira4.cjs');
 
 //#region src/ObjectionFactory.ts
 /**
@@ -50,6 +51,71 @@ var ObjectionFactory = class extends require_Factory.Factory {
 		return require_Factory.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 require_Factory.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 require_Factory.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, require_faker.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, require_faker.faker) : attrs;
+			records.push(this.builders[builderName](newAttrs, this, this.db, require_faker.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 require_Factory.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 require_Factory.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-89p-FFEw.mjs → ObjectionFactory-aqM0dDW7.mjs}

@@ -1,4 +1,5 @@
 import { Factory } from "./Factory-z2m01hMj.mjs";
+import { faker } from "./faker-CxKkEeYi.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);
 	}
 };