@geekmidas/testkit 0.3.0 → 0.3.1

package/README.md

@@ -513,28 +513,113 @@ describe('User Service', () => {
 
 ## Seeds
 
-Seeds are functions that create complex test scenarios:
+Seeds are functions that create complex test scenarios. Use `createSeed` to define type-safe seed functions that receive `{ attrs, factory, db }` as a single context object:
+
+### Defining Seeds with Kysely
 
 ```typescript
-const blogSeed = async (factory: Factory) => {
-  const author = await factory.insert('user', {
-    name: 'Blog Author',
-    role: 'author',
-  });
+import { KyselyFactory } from '@geekmidas/testkit/kysely';
+
+// Define seeds using createSeed for type safety
+const seeds = {
+  // Simple seed with typed attrs
+  adminUser: KyselyFactory.createSeed(
+    async ({ attrs, factory }: {
+      attrs: { name?: string };
+      factory: KyselyFactory<Database, typeof builders, {}>;
+      db: Kysely<Database>
+    }) => {
+      return factory.insert('user', {
+        name: attrs.name || 'Admin User',
+        role: 'admin',
+      });
+    }
+  ),
+
+  // Complex seed creating related records
+  blogWithPosts: KyselyFactory.createSeed(
+    async ({ attrs, factory }) => {
+      const author = await factory.insert('user', {
+        name: attrs.authorName || 'Blog Author',
+        role: 'author',
+      });
 
-  const categories = await factory.insertMany(3, 'category');
+      const categories = await factory.insertMany(3, 'category');
 
-  const posts = await factory.insertMany(5, 'post', (index) => ({
-    title: `Post ${index + 1}`,
-    authorId: author.id,
-    categoryId: categories[index % categories.length].id,
-  }));
+      const posts = await factory.insertMany(attrs.postCount || 5, 'post', (index) => ({
+        title: `Post ${index + 1}`,
+        authorId: author.id,
+        categoryId: categories[index % categories.length].id,
+      }));
 
-  return { author, categories, posts };
+      return { author, categories, posts };
+    }
+  ),
 };
 
-// Use in tests
-const data = await factory.seed('blog');
+// Create factory with seeds
+const factory = new KyselyFactory(builders, seeds, db);
+
+// Use in tests - attrs are type-safe
+const admin = await factory.seed('adminUser', { name: 'Super Admin' });
+const blog = await factory.seed('blogWithPosts', {
+  authorName: 'Jane Doe',
+  postCount: 10
+});
+```
+
+### Defining Seeds with Objection.js
+
+```typescript
+import { ObjectionFactory } from '@geekmidas/testkit/objection';
+import type { Knex } from 'knex';
+
+const seeds = {
+  userWithProfile: ObjectionFactory.createSeed(
+    async ({ attrs, factory, db }: {
+      attrs: { email?: string };
+      factory: ObjectionFactory<typeof builders, {}>;
+      db: Knex
+    }) => {
+      const user = await factory.insert('user', {
+        email: attrs.email || 'user@example.com',
+      });
+
+      await factory.insert('profile', { userId: user.id });
+
+      return user;
+    }
+  ),
+};
+
+const factory = new ObjectionFactory(builders, seeds, knex);
+const user = await factory.seed('userWithProfile', { email: 'custom@example.com' });
+```
+
+### Seed Context Object
+
+All seed functions receive a single context object with three properties:
+
+| Property | Description |
+|----------|-------------|
+| `attrs` | Configuration attributes passed to `factory.seed()` |
+| `factory` | The factory instance for creating records |
+| `db` | The database connection (Kysely or Knex transaction) |
+
+This pattern allows you to destructure only what you need:
+
+```typescript
+// Use all three
+KyselyFactory.createSeed(async ({ attrs, factory, db }) => {
+  // Direct db access for complex queries
+  const existing = await db.selectFrom('users').where('role', '=', 'admin').execute();
+  // ...
+});
+
+// Or just what you need
+KyselyFactory.createSeed(async ({ factory }) => {
+  return factory.insert('user');
+});
 ```
 
 ## API Reference
@@ -549,6 +634,7 @@ class KyselyFactory<DB, Builders, Seeds> {
     db: Kysely<DB> | ControlledTransaction<DB>
   );
 
+  // Create a type-safe builder for a specific table
   static createBuilder<DB, TableName extends keyof DB & string>(
     table: TableName,
     defaults?: (context: {
@@ -560,20 +646,28 @@ class KyselyFactory<DB, Builders, Seeds> {
     autoInsert?: boolean
   ): BuilderFunction;
 
+  // Create a type-safe seed function
+  static createSeed<Seed extends FactorySeed>(
+    seedFn: (context: { attrs: Attrs; factory: Factory; db: DB }) => Promise<Result>
+  ): Seed;
+
+  // Insert a single record
   insert<K extends keyof Builders>(
     builderName: K,
     attrs?: Partial<BuilderAttrs>
   ): Promise<BuilderResult>;
 
+  // Insert multiple records
   insertMany<K extends keyof Builders>(
     count: number,
     builderName: K,
     attrs?: Partial<BuilderAttrs> | ((idx: number, faker: FakerFactory) => Partial<BuilderAttrs>)
   ): Promise<BuilderResult[]>;
 
+  // Execute a seed function
   seed<K extends keyof Seeds>(
     seedName: K,
-    attrs?: SeedAttrs
+    attrs?: ExtractSeedAttrs<Seeds[K]>  // Attrs type is extracted from seed function
   ): Promise<SeedResult>;
 }
 ```

package/dist/{Factory-IdfEkOeT.d.cts → Factory-BK06XuDA.d.cts}

@@ -1,4 +1,4 @@
-import { FakerFactory } from "./faker-CbYiF-8_.cjs";
+import { FakerFactory } from "./faker-Cg76aFNO.cjs";
 
 //#region src/Factory.d.ts
 
@@ -143,4 +143,4 @@ type ExtractSeedAttrs<T> = T extends ((context: {
 }) => any) ? A : never;
 //#endregion
 export { ExtractSeedAttrs, Factory, FactorySeed, MixedFactoryBuilder };
-//# sourceMappingURL=Factory-IdfEkOeT.d.cts.map
+//# sourceMappingURL=Factory-BK06XuDA.d.cts.map

package/dist/Factory.d.cts

@@ -1,3 +1,3 @@
-import "./faker-CbYiF-8_.cjs";
-import { ExtractSeedAttrs, Factory, FactorySeed, MixedFactoryBuilder } from "./Factory-IdfEkOeT.cjs";
+import "./faker-Cg76aFNO.cjs";
+import { ExtractSeedAttrs, Factory, FactorySeed, MixedFactoryBuilder } from "./Factory-BK06XuDA.cjs";
 export { ExtractSeedAttrs, Factory, FactorySeed, MixedFactoryBuilder };

package/dist/{KyselyFactory-Dxhi_ZkA.d.cts → KyselyFactory-Bu9ssWZP.d.cts}

@@ -1,5 +1,5 @@
-import { FakerFactory } from "./faker-CbYiF-8_.cjs";
-import { ExtractSeedAttrs, Factory, FactorySeed } from "./Factory-IdfEkOeT.cjs";
+import { FakerFactory } from "./faker-Cg76aFNO.cjs";
+import { ExtractSeedAttrs, Factory, FactorySeed } from "./Factory-BK06XuDA.cjs";
 import { ControlledTransaction, Insertable, Kysely, Selectable } from "kysely";
 
 //#region src/KyselyFactory.d.ts
@@ -224,4 +224,4 @@ declare class KyselyFactory<DB, Builders extends Record<string, any>, Seeds exte
 }
 //#endregion
 export { KyselyFactory };
-//# sourceMappingURL=KyselyFactory-Dxhi_ZkA.d.cts.map
+//# sourceMappingURL=KyselyFactory-Bu9ssWZP.d.cts.map

package/dist/KyselyFactory.d.cts

@@ -1,4 +1,4 @@
-import "./faker-CbYiF-8_.cjs";
-import "./Factory-IdfEkOeT.cjs";
-import { KyselyFactory } from "./KyselyFactory-Dxhi_ZkA.cjs";
+import "./faker-Cg76aFNO.cjs";
+import "./Factory-BK06XuDA.cjs";
+import { KyselyFactory } from "./KyselyFactory-Bu9ssWZP.cjs";
 export { KyselyFactory };

package/dist/{ObjectionFactory-BRAkAByP.d.cts → ObjectionFactory-tKWZOiYO.d.cts}

@@ -1,5 +1,5 @@
-import { FakerFactory } from "./faker-CbYiF-8_.cjs";
-import { ExtractSeedAttrs, Factory, FactorySeed } from "./Factory-IdfEkOeT.cjs";
+import { FakerFactory } from "./faker-Cg76aFNO.cjs";
+import { ExtractSeedAttrs, Factory, FactorySeed } from "./Factory-BK06XuDA.cjs";
 import { Knex } from "knex";
 import { Model } from "objection";
 
@@ -237,4 +237,4 @@ declare class ObjectionFactory<Builders extends Record<string, any>, Seeds exten
 }
 //#endregion
 export { ObjectionFactory };
-//# sourceMappingURL=ObjectionFactory-BRAkAByP.d.cts.map
+//# sourceMappingURL=ObjectionFactory-tKWZOiYO.d.cts.map

package/dist/ObjectionFactory.d.cts

@@ -1,4 +1,4 @@
-import "./faker-CbYiF-8_.cjs";
-import "./Factory-IdfEkOeT.cjs";
-import { ObjectionFactory } from "./ObjectionFactory-BRAkAByP.cjs";
+import "./faker-Cg76aFNO.cjs";
+import "./Factory-BK06XuDA.cjs";
+import { ObjectionFactory } from "./ObjectionFactory-tKWZOiYO.cjs";
 export { ObjectionFactory };

package/dist/{directory-Mi7tdOuD.d.cts → directory-BPf1LgNX.d.mts}

@@ -9,4 +9,4 @@ interface DirectoryFixtures {
 }
 //#endregion
 export { DirectoryFixtures, itWithDir };
-//# sourceMappingURL=directory-Mi7tdOuD.d.cts.map
+//# sourceMappingURL=directory-BPf1LgNX.d.mts.map

package/dist/{directory-BXavAeJZ.d.mts → directory-DlkPEzL4.d.cts}

@@ -9,4 +9,4 @@ interface DirectoryFixtures {
 }
 //#endregion
 export { DirectoryFixtures, itWithDir };
-//# sourceMappingURL=directory-BXavAeJZ.d.mts.map
+//# sourceMappingURL=directory-DlkPEzL4.d.cts.map

package/dist/{faker-CbYiF-8_.d.cts → faker-Cg76aFNO.d.cts}

@@ -1,4 +1,4 @@
-import * as _faker_js_faker3 from "@faker-js/faker";
+import * as _faker_js_faker1 from "@faker-js/faker";
 
 //#region src/faker.d.ts
 
@@ -134,7 +134,7 @@ declare function coordinateOutsideRadius(center: Coordinate, minRadiusMeters: nu
  * const productPrice = faker.price();
  * ```
  */
-declare const faker: Readonly<_faker_js_faker3.Faker & {
+declare const faker: Readonly<_faker_js_faker1.Faker & {
   timestamps: typeof timestamps;
   identifier: typeof identifier;
   sequence: typeof sequence;
@@ -163,4 +163,4 @@ type Timestamps = {
 type FakerFactory = typeof faker;
 //#endregion
 export { FakerFactory, Timestamps, coordinateInRadius, faker, identifier, resetAllSequences, resetSequence, sequence, timestamps };
-//# sourceMappingURL=faker-CbYiF-8_.d.cts.map
+//# sourceMappingURL=faker-Cg76aFNO.d.cts.map

package/dist/faker.d.cts

@@ -1,2 +1,2 @@
-import { FakerFactory, Timestamps, coordinateInRadius, faker, identifier, resetAllSequences, resetSequence, sequence, timestamps } from "./faker-CbYiF-8_.cjs";
+import { FakerFactory, Timestamps, coordinateInRadius, faker, identifier, resetAllSequences, resetSequence, sequence, timestamps } from "./faker-Cg76aFNO.cjs";
 export { FakerFactory, Timestamps, coordinateInRadius, faker, identifier, resetAllSequences, resetSequence, sequence, timestamps };

package/dist/kysely.d.cts

@@ -1,6 +1,6 @@
-import { FakerFactory, faker } from "./faker-CbYiF-8_.cjs";
-import { ExtractSeedAttrs, FactorySeed } from "./Factory-IdfEkOeT.cjs";
-import { KyselyFactory } from "./KyselyFactory-Dxhi_ZkA.cjs";
+import { FakerFactory, faker } from "./faker-Cg76aFNO.cjs";
+import { ExtractSeedAttrs, FactorySeed } from "./Factory-BK06XuDA.cjs";
+import { KyselyFactory } from "./KyselyFactory-Bu9ssWZP.cjs";
 import "./PostgresMigrator-D5UkK1_K.cjs";
 import { PostgresKyselyMigrator } from "./PostgresKyselyMigrator-CQ3aUoy_.cjs";
 import { DatabaseConnection, DatabaseFixtures, ExtendedDatabaseFixtures, FixtureCreators, IsolationLevel, TestWithExtendedFixtures, TransactionWrapperOptions } from "./VitestTransactionIsolator-CwQaxZLP.cjs";

package/dist/objection.d.cts

@@ -1,6 +1,6 @@
-import { FakerFactory, faker } from "./faker-CbYiF-8_.cjs";
-import { ExtractSeedAttrs, FactorySeed } from "./Factory-IdfEkOeT.cjs";
-import { ObjectionFactory } from "./ObjectionFactory-BRAkAByP.cjs";
+import { FakerFactory, faker } from "./faker-Cg76aFNO.cjs";
+import { ExtractSeedAttrs, FactorySeed } from "./Factory-BK06XuDA.cjs";
+import { ObjectionFactory } from "./ObjectionFactory-tKWZOiYO.cjs";
 import "./PostgresMigrator-D5UkK1_K.cjs";
 import { PostgresObjectionMigrator } from "./PostgresObjectionMigrator-CZHHcCOv.cjs";
 import { DatabaseConnection, DatabaseFixtures, ExtendedDatabaseFixtures, FixtureCreators, IsolationLevel, TestWithExtendedFixtures, TransactionWrapperOptions } from "./VitestTransactionIsolator-CwQaxZLP.cjs";

package/dist/os/directory.d.cts

@@ -1,2 +1,2 @@
-import { DirectoryFixtures, itWithDir } from "../directory-Mi7tdOuD.cjs";
+import { DirectoryFixtures, itWithDir } from "../directory-DlkPEzL4.cjs";
 export { DirectoryFixtures, itWithDir };

package/dist/os/directory.d.mts

@@ -1,2 +1,2 @@
-import { DirectoryFixtures, itWithDir } from "../directory-BXavAeJZ.mjs";
+import { DirectoryFixtures, itWithDir } from "../directory-BPf1LgNX.mjs";
 export { DirectoryFixtures, itWithDir };

package/dist/os/index.d.cts

@@ -1,2 +1,2 @@
-import { itWithDir } from "../directory-Mi7tdOuD.cjs";
+import { itWithDir } from "../directory-DlkPEzL4.cjs";
 export { itWithDir };

package/dist/os/index.d.mts

@@ -1,2 +1,2 @@
-import { itWithDir } from "../directory-BXavAeJZ.mjs";
+import { itWithDir } from "../directory-BPf1LgNX.mjs";
 export { itWithDir };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/testkit",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": false,
   "type": "module",
   "exports": {