@geekmidas/testkit 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/dist/{Factory-DE3hE0WO.d.mts → Factory-Cmr3s3-s.d.mts} +2 -2
  2. package/dist/{Factory-pNV7ZQ7-.d.cts → Factory-D7oHtI2D.d.cts} +2 -2
  3. package/dist/Factory.d.cts +2 -2
  4. package/dist/Factory.d.mts +2 -2
  5. package/dist/{KyselyFactory-CPZTUuMB.d.cts → KyselyFactory-BTdygZ-i.d.mts} +3 -3
  6. package/dist/{KyselyFactory-RAyvZ8Cj.d.mts → KyselyFactory-dYdviox2.d.cts} +3 -3
  7. package/dist/KyselyFactory.d.cts +3 -3
  8. package/dist/KyselyFactory.d.mts +3 -3
  9. package/dist/{ObjectionFactory-BlBicEia.d.mts → ObjectionFactory-0gUdx8bB.d.cts} +3 -3
  10. package/dist/{ObjectionFactory-BwpN4gMX.d.cts → ObjectionFactory-BagGjikT.d.mts} +3 -3
  11. package/dist/ObjectionFactory.d.cts +3 -3
  12. package/dist/ObjectionFactory.d.mts +3 -3
  13. package/dist/{VitestKyselyTransactionIsolator-XDL3ngs_.mjs → VitestKyselyTransactionIsolator-CNURW8y6.mjs} +2 -2
  14. package/dist/{VitestKyselyTransactionIsolator-XDL3ngs_.mjs.map → VitestKyselyTransactionIsolator-CNURW8y6.mjs.map} +1 -1
  15. package/dist/{VitestKyselyTransactionIsolator-BqrZDeaT.d.cts → VitestKyselyTransactionIsolator-D3EZZhjZ.d.cts} +2 -2
  16. package/dist/{VitestKyselyTransactionIsolator-DiskaURs.d.mts → VitestKyselyTransactionIsolator-Dxlp1u0f.d.mts} +2 -2
  17. package/dist/{VitestKyselyTransactionIsolator-DX_VPKS-.cjs → VitestKyselyTransactionIsolator-EvDLk5zg.cjs} +2 -2
  18. package/dist/{VitestKyselyTransactionIsolator-DX_VPKS-.cjs.map → VitestKyselyTransactionIsolator-EvDLk5zg.cjs.map} +1 -1
  19. package/dist/VitestKyselyTransactionIsolator.cjs +2 -2
  20. package/dist/VitestKyselyTransactionIsolator.d.cts +2 -2
  21. package/dist/VitestKyselyTransactionIsolator.d.mts +2 -2
  22. package/dist/VitestKyselyTransactionIsolator.mjs +2 -2
  23. package/dist/{VitestObjectionTransactionIsolator-CD2ucJpH.d.cts → VitestObjectionTransactionIsolator-1TpsPqfG.d.cts} +2 -2
  24. package/dist/{VitestObjectionTransactionIsolator-D_tlOtq8.cjs → VitestObjectionTransactionIsolator-CM5KTAFA.cjs} +2 -2
  25. package/dist/{VitestObjectionTransactionIsolator-D_tlOtq8.cjs.map → VitestObjectionTransactionIsolator-CM5KTAFA.cjs.map} +1 -1
  26. package/dist/{VitestObjectionTransactionIsolator-DhQ8XGva.d.mts → VitestObjectionTransactionIsolator-i9jIgU8Q.d.mts} +2 -2
  27. package/dist/{VitestObjectionTransactionIsolator-_EhJKu_O.mjs → VitestObjectionTransactionIsolator-jQFaCz0u.mjs} +2 -2
  28. package/dist/{VitestObjectionTransactionIsolator-_EhJKu_O.mjs.map → VitestObjectionTransactionIsolator-jQFaCz0u.mjs.map} +1 -1
  29. package/dist/VitestObjectionTransactionIsolator.cjs +2 -2
  30. package/dist/VitestObjectionTransactionIsolator.d.cts +2 -2
  31. package/dist/VitestObjectionTransactionIsolator.d.mts +2 -2
  32. package/dist/VitestObjectionTransactionIsolator.mjs +2 -2
  33. package/dist/{VitestTransactionIsolator-DLdQlfZ5.d.mts → VitestTransactionIsolator-BvR19bYn.d.mts} +31 -14
  34. package/dist/{VitestTransactionIsolator-BKIrj3Uy.cjs → VitestTransactionIsolator-CMfJXZP8.cjs} +52 -36
  35. package/dist/VitestTransactionIsolator-CMfJXZP8.cjs.map +1 -0
  36. package/dist/{VitestTransactionIsolator-DfA80g2M.d.cts → VitestTransactionIsolator-CwQaxZLP.d.cts} +31 -14
  37. package/dist/{VitestTransactionIsolator-BIaMs4c2.mjs → VitestTransactionIsolator-DQ7tLqgV.mjs} +52 -36
  38. package/dist/VitestTransactionIsolator-DQ7tLqgV.mjs.map +1 -0
  39. package/dist/VitestTransactionIsolator.cjs +1 -1
  40. package/dist/VitestTransactionIsolator.d.cts +2 -2
  41. package/dist/VitestTransactionIsolator.d.mts +2 -2
  42. package/dist/VitestTransactionIsolator.mjs +1 -1
  43. package/dist/better-auth.d.cts +2 -2
  44. package/dist/better-auth.d.mts +2 -2
  45. package/dist/{directory-Mi7tdOuD.d.cts → directory-BUcnztHI.d.cts} +3 -3
  46. package/dist/{directory-Q178x53k.d.mts → directory-BXavAeJZ.d.mts} +3 -3
  47. package/dist/{faker-D9gz7KjY.d.mts → faker-DHh7xs4u.d.mts} +3 -3
  48. package/dist/{faker-BSH1EMtg.d.cts → faker-Dg3trU4a.d.cts} +3 -3
  49. package/dist/faker.d.cts +1 -1
  50. package/dist/faker.d.mts +1 -1
  51. package/dist/kysely.cjs +23 -29
  52. package/dist/kysely.cjs.map +1 -1
  53. package/dist/kysely.d.cts +39 -34
  54. package/dist/kysely.d.mts +39 -34
  55. package/dist/kysely.mjs +23 -29
  56. package/dist/kysely.mjs.map +1 -1
  57. package/dist/objection.cjs +23 -47
  58. package/dist/objection.cjs.map +1 -1
  59. package/dist/objection.d.cts +39 -52
  60. package/dist/objection.d.mts +39 -52
  61. package/dist/objection.mjs +23 -47
  62. package/dist/objection.mjs.map +1 -1
  63. package/dist/os/directory.d.cts +1 -1
  64. package/dist/os/directory.d.mts +1 -1
  65. package/dist/os/index.d.cts +1 -1
  66. package/dist/os/index.d.mts +1 -1
  67. package/package.json +1 -1
  68. package/src/VitestTransactionIsolator.ts +67 -16
  69. package/src/__tests__/KyselyFactory.spec.ts +4 -5
  70. package/src/__tests__/ObjectionFactory.spec.ts +4 -5
  71. package/src/__tests__/VitestObjectionTransactionIsolator.spec.ts +6 -3
  72. package/src/__tests__/integration.spec.ts +8 -10
  73. package/src/kysely.ts +43 -33
  74. package/src/objection.ts +41 -51
  75. package/dist/VitestTransactionIsolator-BIaMs4c2.mjs.map +0 -1
  76. package/dist/VitestTransactionIsolator-BKIrj3Uy.cjs.map +0 -1
@@ -1,24 +1,36 @@
1
- import { FakerFactory, faker } from "./faker-D9gz7KjY.mjs";
2
- import "./Factory-DE3hE0WO.mjs";
3
- import { ObjectionFactory } from "./ObjectionFactory-BlBicEia.mjs";
1
+ import { FakerFactory, faker } from "./faker-DHh7xs4u.mjs";
2
+ import "./Factory-Cmr3s3-s.mjs";
3
+ import { ObjectionFactory } from "./ObjectionFactory-BagGjikT.mjs";
4
4
  import "./PostgresMigrator-DQaRxoaY.mjs";
5
5
  import { PostgresObjectionMigrator } from "./PostgresObjectionMigrator-D_hCcrQu.mjs";
6
- import { DatabaseConnection, DatabaseFixtures, ExtendedDatabaseFixtures, FixtureCreators, IsolationLevel, TestWithExtendedFixtures } from "./VitestTransactionIsolator-DLdQlfZ5.mjs";
7
- import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransactionIsolator-DhQ8XGva.mjs";
6
+ import { DatabaseConnection, DatabaseFixtures, ExtendedDatabaseFixtures, FixtureCreators, IsolationLevel, TestWithExtendedFixtures, TransactionWrapperOptions } from "./VitestTransactionIsolator-BvR19bYn.mjs";
7
+ import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransactionIsolator-i9jIgU8Q.mjs";
8
8
  import { TestAPI } from "vitest";
9
9
  import { Knex } from "knex";
10
10
 
11
11
  //#region src/objection.d.ts
12
12
 
13
+ /**
14
+ * Objection.js-specific options for transaction wrapping.
15
+ */
16
+ interface ObjectionTransactionOptions<Extended extends Record<string, unknown> = {}> {
17
+ /** Function that creates or returns a Knex database connection */
18
+ connection: DatabaseConnection<Knex>;
19
+ /** Optional setup function to run within the transaction before each test */
20
+ setup?: (trx: Knex.Transaction) => Promise<void>;
21
+ /** Transaction isolation level (defaults to REPEATABLE_READ) */
22
+ isolationLevel?: IsolationLevel;
23
+ /** Additional fixtures that depend on the transaction */
24
+ fixtures?: FixtureCreators<Knex.Transaction, Extended>;
25
+ }
13
26
  /**
14
27
  * Creates a wrapped Vitest test API with automatic transaction rollback for Objection.js.
15
28
  * Each test runs in an isolated database transaction that is rolled back after completion.
16
29
  * This ensures tests don't affect each other's data and run faster than truncating tables.
17
30
  *
31
+ * @template Extended - Additional fixtures to provide
18
32
  * @param api - The Vitest test API (usually `test` from vitest)
19
- * @param conn - The Knex database connection instance
20
- * @param setup - Optional setup function to run before each test in the transaction
21
- * @param level - Transaction isolation level (defaults to REPEATABLE_READ)
33
+ * @param options - Configuration options for transaction wrapping
22
34
  * @returns A wrapped test API that provides transaction isolation
23
35
  *
24
36
  * @example
@@ -26,10 +38,12 @@ import { Knex } from "knex";
26
38
  * import { test } from 'vitest';
27
39
  * import { wrapVitestObjectionTransaction } from '@geekmidas/testkit/objection';
28
40
  * import { knex } from './database';
29
- * import { User, Post } from './models';
41
+ * import { User } from './models';
30
42
  *
31
43
  * // Create isolated test with automatic rollback
32
- * const isolatedTest = wrapVitestObjectionTransaction(test, knex);
44
+ * const isolatedTest = wrapVitestObjectionTransaction(test, {
45
+ * connection: knex,
46
+ * });
33
47
  *
34
48
  * // Use in tests - each test gets its own transaction
35
49
  * isolatedTest('should create user', async ({ trx }) => {
@@ -37,53 +51,23 @@ import { Knex } from "knex";
37
51
  * .insert({ name: 'Test User', email: 'test@example.com' });
38
52
  *
39
53
  * expect(user).toBeDefined();
40
- * // User is automatically rolled back after test
41
54
  * });
42
55
  *
43
- * // With setup function for common test data
44
- * const testWithSetup = wrapVitestObjectionTransaction(
45
- * test,
46
- * knex,
47
- * async (trx) => {
48
- * // Create common test data
49
- * await knex('settings')
50
- * .transacting(trx)
51
- * .insert({ key: 'test_mode', value: 'true' });
52
- * }
53
- * );
54
- *
55
- * testWithSetup('should have test settings', async ({ trx }) => {
56
- * const setting = await knex('settings')
57
- * .transacting(trx)
58
- * .where('key', 'test_mode')
59
- * .first();
60
- *
61
- * expect(setting?.value).toBe('true');
56
+ * // With fixtures for factories
57
+ * const it = wrapVitestObjectionTransaction<{ factory: Factory }>(test, {
58
+ * connection: knex,
59
+ * fixtures: {
60
+ * factory: (trx) => new Factory(trx),
61
+ * },
62
62
  * });
63
63
  *
64
- * // Example with factory and transaction
65
- * const isolatedTest = wrapVitestObjectionTransaction(test, knex);
66
- * const factory = new ObjectionFactory(builders, seeds, knex);
67
- *
68
- * isolatedTest('creates related data', async ({ trx }) => {
69
- * // Factory can use the transaction
70
- * const user = await User.query(trx).insert({ name: 'Author' });
71
- * const posts = await Post.query(trx).insert([
72
- * { title: 'Post 1', userId: user.id },
73
- * { title: 'Post 2', userId: user.id }
74
- * ]);
75
- *
76
- * const userWithPosts = await User.query(trx)
77
- * .findById(user.id)
78
- * .withGraphFetched('posts');
79
- *
80
- * expect(userWithPosts.posts).toHaveLength(2);
64
+ * it('should create user with factory', async ({ trx, factory }) => {
65
+ * const user = await factory.insert('user', { name: 'Test' });
66
+ * expect(user.id).toBeDefined();
81
67
  * });
82
68
  * ```
83
69
  */
84
- declare function wrapVitestObjectionTransaction(api: TestAPI, conn: DatabaseConnection<Knex>, setup?: (trx: Knex.Transaction) => Promise<void>, level?: IsolationLevel): TestAPI<{
85
- trx: Knex.Transaction<any, any[]>;
86
- }>;
70
+ declare function wrapVitestObjectionTransaction<Extended extends Record<string, unknown> = {}>(api: TestAPI, options: ObjectionTransactionOptions<Extended>): TestAPI<DatabaseFixtures<Knex.Transaction<any, any[]>, object> & Extended>;
87
71
  /**
88
72
  * Extends an Objection.js transaction-wrapped test with additional fixtures.
89
73
  * Each fixture receives the transaction and can create dependencies like factories or repositories.
@@ -108,7 +92,10 @@ declare function wrapVitestObjectionTransaction(api: TestAPI, conn: DatabaseConn
108
92
  * };
109
93
  *
110
94
  * // Create base wrapped test
111
- * const baseTest = wrapVitestObjectionTransaction(test, knex, createTestTables);
95
+ * const baseTest = wrapVitestObjectionTransaction(test, {
96
+ * connection: knex,
97
+ * setup: createTestTables,
98
+ * });
112
99
  *
113
100
  * // Extend with fixtures - each fixture receives the transaction
114
101
  * const it = extendWithFixtures<{ factory: ObjectionFactory<typeof builders, {}> }>(
@@ -131,5 +118,5 @@ declare function wrapVitestObjectionTransaction(api: TestAPI, conn: DatabaseConn
131
118
  */
132
119
  declare function extendWithFixtures<Extended extends Record<string, unknown>, T extends ReturnType<TestAPI['extend']> = ReturnType<TestAPI['extend']>>(wrappedTest: T, fixtures: FixtureCreators<Knex.Transaction, Extended>): TestWithExtendedFixtures<Knex.Transaction<any, any[]>, Extended, T>;
133
120
  //#endregion
134
- export { DatabaseFixtures, ExtendedDatabaseFixtures, FakerFactory, FixtureCreators, IsolationLevel, ObjectionFactory, PostgresObjectionMigrator, TestWithExtendedFixtures, VitestObjectionTransactionIsolator, extendWithFixtures, faker, wrapVitestObjectionTransaction };
121
+ export { DatabaseFixtures, ExtendedDatabaseFixtures, FakerFactory, FixtureCreators, IsolationLevel, ObjectionFactory, ObjectionTransactionOptions, PostgresObjectionMigrator, TestWithExtendedFixtures, TransactionWrapperOptions, VitestObjectionTransactionIsolator, extendWithFixtures, faker, wrapVitestObjectionTransaction };
135
122
  //# sourceMappingURL=objection.d.mts.map
@@ -3,8 +3,8 @@ import { faker } from "./faker-BGKYFoCT.mjs";
3
3
  import { ObjectionFactory } from "./ObjectionFactory-zf2fLKrL.mjs";
4
4
  import "./PostgresMigrator-DbuJGAVy.mjs";
5
5
  import { PostgresObjectionMigrator } from "./PostgresObjectionMigrator-DPj2pOpX.mjs";
6
- import { IsolationLevel, extendWithFixtures } from "./VitestTransactionIsolator-BIaMs4c2.mjs";
7
- import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransactionIsolator-_EhJKu_O.mjs";
6
+ import { IsolationLevel, extendWithFixtures } from "./VitestTransactionIsolator-DQ7tLqgV.mjs";
7
+ import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransactionIsolator-jQFaCz0u.mjs";
8
8
 
9
9
  //#region src/objection.ts
10
10
  /**
@@ -12,10 +12,9 @@ import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransaction
12
12
  * Each test runs in an isolated database transaction that is rolled back after completion.
13
13
  * This ensures tests don't affect each other's data and run faster than truncating tables.
14
14
  *
15
+ * @template Extended - Additional fixtures to provide
15
16
  * @param api - The Vitest test API (usually `test` from vitest)
16
- * @param conn - The Knex database connection instance
17
- * @param setup - Optional setup function to run before each test in the transaction
18
- * @param level - Transaction isolation level (defaults to REPEATABLE_READ)
17
+ * @param options - Configuration options for transaction wrapping
19
18
  * @returns A wrapped test API that provides transaction isolation
20
19
  *
21
20
  * @example
@@ -23,10 +22,12 @@ import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransaction
23
22
  * import { test } from 'vitest';
24
23
  * import { wrapVitestObjectionTransaction } from '@geekmidas/testkit/objection';
25
24
  * import { knex } from './database';
26
- * import { User, Post } from './models';
25
+ * import { User } from './models';
27
26
  *
28
27
  * // Create isolated test with automatic rollback
29
- * const isolatedTest = wrapVitestObjectionTransaction(test, knex);
28
+ * const isolatedTest = wrapVitestObjectionTransaction(test, {
29
+ * connection: knex,
30
+ * });
30
31
  *
31
32
  * // Use in tests - each test gets its own transaction
32
33
  * isolatedTest('should create user', async ({ trx }) => {
@@ -34,53 +35,25 @@ import { VitestObjectionTransactionIsolator } from "./VitestObjectionTransaction
34
35
  * .insert({ name: 'Test User', email: 'test@example.com' });
35
36
  *
36
37
  * expect(user).toBeDefined();
37
- * // User is automatically rolled back after test
38
38
  * });
39
39
  *
40
- * // With setup function for common test data
41
- * const testWithSetup = wrapVitestObjectionTransaction(
42
- * test,
43
- * knex,
44
- * async (trx) => {
45
- * // Create common test data
46
- * await knex('settings')
47
- * .transacting(trx)
48
- * .insert({ key: 'test_mode', value: 'true' });
49
- * }
50
- * );
51
- *
52
- * testWithSetup('should have test settings', async ({ trx }) => {
53
- * const setting = await knex('settings')
54
- * .transacting(trx)
55
- * .where('key', 'test_mode')
56
- * .first();
57
- *
58
- * expect(setting?.value).toBe('true');
40
+ * // With fixtures for factories
41
+ * const it = wrapVitestObjectionTransaction<{ factory: Factory }>(test, {
42
+ * connection: knex,
43
+ * fixtures: {
44
+ * factory: (trx) => new Factory(trx),
45
+ * },
59
46
  * });
60
47
  *
61
- * // Example with factory and transaction
62
- * const isolatedTest = wrapVitestObjectionTransaction(test, knex);
63
- * const factory = new ObjectionFactory(builders, seeds, knex);
64
- *
65
- * isolatedTest('creates related data', async ({ trx }) => {
66
- * // Factory can use the transaction
67
- * const user = await User.query(trx).insert({ name: 'Author' });
68
- * const posts = await Post.query(trx).insert([
69
- * { title: 'Post 1', userId: user.id },
70
- * { title: 'Post 2', userId: user.id }
71
- * ]);
72
- *
73
- * const userWithPosts = await User.query(trx)
74
- * .findById(user.id)
75
- * .withGraphFetched('posts');
76
- *
77
- * expect(userWithPosts.posts).toHaveLength(2);
48
+ * it('should create user with factory', async ({ trx, factory }) => {
49
+ * const user = await factory.insert('user', { name: 'Test' });
50
+ * expect(user.id).toBeDefined();
78
51
  * });
79
52
  * ```
80
53
  */
81
- function wrapVitestObjectionTransaction(api, conn, setup, level = IsolationLevel.REPEATABLE_READ) {
54
+ function wrapVitestObjectionTransaction(api, options) {
82
55
  const wrapper = new VitestObjectionTransactionIsolator(api);
83
- return wrapper.wrapVitestWithTransaction(conn, setup, level);
56
+ return wrapper.wrapVitestWithTransaction(options);
84
57
  }
85
58
  /**
86
59
  * Extends an Objection.js transaction-wrapped test with additional fixtures.
@@ -106,7 +79,10 @@ function wrapVitestObjectionTransaction(api, conn, setup, level = IsolationLevel
106
79
  * };
107
80
  *
108
81
  * // Create base wrapped test
109
- * const baseTest = wrapVitestObjectionTransaction(test, knex, createTestTables);
82
+ * const baseTest = wrapVitestObjectionTransaction(test, {
83
+ * connection: knex,
84
+ * setup: createTestTables,
85
+ * });
110
86
  *
111
87
  * // Extend with fixtures - each fixture receives the transaction
112
88
  * const it = extendWithFixtures<{ factory: ObjectionFactory<typeof builders, {}> }>(
@@ -1 +1 @@
1
- {"version":3,"file":"objection.mjs","names":["api: TestAPI","conn: DatabaseConnection<Knex>","setup?: (trx: Knex.Transaction) => Promise<void>","level: IsolationLevel","extendWithFixtures","wrappedTest: T","fixtures: FixtureCreators<Knex.Transaction, Extended>"],"sources":["../src/objection.ts"],"sourcesContent":["import type { Knex } from 'knex';\nimport type { TestAPI } from 'vitest';\nimport { VitestObjectionTransactionIsolator } from './VitestObjectionTransactionIsolator';\nimport {\n type DatabaseConnection,\n type FixtureCreators,\n IsolationLevel,\n extendWithFixtures as baseExtendWithFixtures,\n} from './VitestTransactionIsolator';\n\n/**\n * Objection.js-specific exports for test utilities.\n * Provides factory implementation for creating test data with Objection.js ORM\n * and transaction isolation for test suites.\n */\n\nexport { ObjectionFactory } from './ObjectionFactory';\nexport { VitestObjectionTransactionIsolator } from './VitestObjectionTransactionIsolator';\nexport { IsolationLevel } from './VitestTransactionIsolator';\nexport { PostgresObjectionMigrator } from './PostgresObjectionMigrator';\nexport type {\n DatabaseFixtures,\n ExtendedDatabaseFixtures,\n FixtureCreators,\n TestWithExtendedFixtures,\n} from './VitestTransactionIsolator';\n\n// Re-export faker and FakerFactory for type portability in declaration files\nexport { faker, type FakerFactory } from './faker';\n\n/**\n * Creates a wrapped Vitest test API with automatic transaction rollback for Objection.js.\n * Each test runs in an isolated database transaction that is rolled back after completion.\n * This ensures tests don't affect each other's data and run faster than truncating tables.\n *\n * @param api - The Vitest test API (usually `test` from vitest)\n * @param conn - The Knex database connection instance\n * @param setup - Optional setup function to run before each test in the transaction\n * @param level - Transaction isolation level (defaults to REPEATABLE_READ)\n * @returns A wrapped test API that provides transaction isolation\n *\n * @example\n * ```typescript\n * import { test } from 'vitest';\n * import { wrapVitestObjectionTransaction } from '@geekmidas/testkit/objection';\n * import { knex } from './database';\n * import { User, Post } from './models';\n *\n * // Create isolated test with automatic rollback\n * const isolatedTest = wrapVitestObjectionTransaction(test, knex);\n *\n * // Use in tests - each test gets its own transaction\n * isolatedTest('should create user', async ({ trx }) => {\n * const user = await User.query(trx)\n * .insert({ name: 'Test User', email: 'test@example.com' });\n *\n * expect(user).toBeDefined();\n * // User is automatically rolled back after test\n * });\n *\n * // With setup function for common test data\n * const testWithSetup = wrapVitestObjectionTransaction(\n * test,\n * knex,\n * async (trx) => {\n * // Create common test data\n * await knex('settings')\n * .transacting(trx)\n * .insert({ key: 'test_mode', value: 'true' });\n * }\n * );\n *\n * testWithSetup('should have test settings', async ({ trx }) => {\n * const setting = await knex('settings')\n * .transacting(trx)\n * .where('key', 'test_mode')\n * .first();\n *\n * expect(setting?.value).toBe('true');\n * });\n *\n * // Example with factory and transaction\n * const isolatedTest = wrapVitestObjectionTransaction(test, knex);\n * const factory = new ObjectionFactory(builders, seeds, knex);\n *\n * isolatedTest('creates related data', async ({ trx }) => {\n * // Factory can use the transaction\n * const user = await User.query(trx).insert({ name: 'Author' });\n * const posts = await Post.query(trx).insert([\n * { title: 'Post 1', userId: user.id },\n * { title: 'Post 2', userId: user.id }\n * ]);\n *\n * const userWithPosts = await User.query(trx)\n * .findById(user.id)\n * .withGraphFetched('posts');\n *\n * expect(userWithPosts.posts).toHaveLength(2);\n * });\n * ```\n */\nexport function wrapVitestObjectionTransaction(\n api: TestAPI,\n conn: DatabaseConnection<Knex>,\n setup?: (trx: Knex.Transaction) => Promise<void>,\n level: IsolationLevel = IsolationLevel.REPEATABLE_READ,\n) {\n const wrapper = new VitestObjectionTransactionIsolator(api);\n\n return wrapper.wrapVitestWithTransaction(conn, setup, level);\n}\n\n/**\n * Extends an Objection.js transaction-wrapped test with additional fixtures.\n * Each fixture receives the transaction and can create dependencies like factories or repositories.\n *\n * @template Extended - The type of additional fixtures to provide\n * @param wrappedTest - The base wrapped test from wrapVitestObjectionTransaction\n * @param fixtures - Object mapping fixture names to creator functions\n * @returns An extended test API with both trx and the additional fixtures\n *\n * @example\n * ```typescript\n * import { test } from 'vitest';\n * import { wrapVitestObjectionTransaction, extendWithFixtures, ObjectionFactory } from '@geekmidas/testkit/objection';\n * import { User } from './models';\n *\n * // Define your builders\n * const builders = {\n * user: ObjectionFactory.createBuilder(User, ({ faker }) => ({\n * name: faker.person.fullName(),\n * email: faker.internet.email(),\n * })),\n * };\n *\n * // Create base wrapped test\n * const baseTest = wrapVitestObjectionTransaction(test, knex, createTestTables);\n *\n * // Extend with fixtures - each fixture receives the transaction\n * const it = extendWithFixtures<{ factory: ObjectionFactory<typeof builders, {}> }>(\n * baseTest,\n * {\n * factory: (trx) => new ObjectionFactory(builders, {}, trx),\n * }\n * );\n *\n * // Use in tests - both trx and factory are available\n * it('should create user with factory', async ({ trx, factory }) => {\n * const user = await factory.insert('user', { name: 'Test User' });\n * expect(user.id).toBeDefined();\n *\n * // Verify in database\n * const found = await User.query(trx).findById(user.id);\n * expect(found?.name).toBe('Test User');\n * });\n * ```\n */\nexport function extendWithFixtures<\n Extended extends Record<string, unknown>,\n T extends ReturnType<TestAPI['extend']> = ReturnType<TestAPI['extend']>,\n>(wrappedTest: T, fixtures: FixtureCreators<Knex.Transaction, Extended>) {\n return baseExtendWithFixtures<Knex.Transaction, Extended, T>(\n wrappedTest,\n fixtures,\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqGA,SAAgB,+BACdA,KACAC,MACAC,OACAC,QAAwB,eAAe,iBACvC;CACA,MAAM,UAAU,IAAI,mCAAmC;AAEvD,QAAO,QAAQ,0BAA0B,MAAM,OAAO,MAAM;AAC7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CD,SAAgBC,qBAGdC,aAAgBC,UAAuD;AACvE,QAAO,mBACL,aACA,SACD;AACF"}
1
+ {"version":3,"file":"objection.mjs","names":["api: TestAPI","options: ObjectionTransactionOptions<Extended>","extendWithFixtures","wrappedTest: T","fixtures: FixtureCreators<Knex.Transaction, Extended>"],"sources":["../src/objection.ts"],"sourcesContent":["import type { Knex } from 'knex';\nimport type { TestAPI } from 'vitest';\nimport { VitestObjectionTransactionIsolator } from './VitestObjectionTransactionIsolator';\nimport {\n type DatabaseConnection,\n type FixtureCreators,\n type IsolationLevel,\n extendWithFixtures as baseExtendWithFixtures,\n} from './VitestTransactionIsolator';\n\n/**\n * Objection.js-specific exports for test utilities.\n * Provides factory implementation for creating test data with Objection.js ORM\n * and transaction isolation for test suites.\n */\n\nexport { ObjectionFactory } from './ObjectionFactory';\nexport { VitestObjectionTransactionIsolator } from './VitestObjectionTransactionIsolator';\nexport { IsolationLevel } from './VitestTransactionIsolator';\nexport { PostgresObjectionMigrator } from './PostgresObjectionMigrator';\nexport type {\n DatabaseFixtures,\n ExtendedDatabaseFixtures,\n FixtureCreators,\n TestWithExtendedFixtures,\n TransactionWrapperOptions,\n} from './VitestTransactionIsolator';\n\n/**\n * Objection.js-specific options for transaction wrapping.\n */\nexport interface ObjectionTransactionOptions<\n Extended extends Record<string, unknown> = {},\n> {\n /** Function that creates or returns a Knex database connection */\n connection: DatabaseConnection<Knex>;\n /** Optional setup function to run within the transaction before each test */\n setup?: (trx: Knex.Transaction) => Promise<void>;\n /** Transaction isolation level (defaults to REPEATABLE_READ) */\n isolationLevel?: IsolationLevel;\n /** Additional fixtures that depend on the transaction */\n fixtures?: FixtureCreators<Knex.Transaction, Extended>;\n}\n\n// Re-export faker and FakerFactory for type portability in declaration files\nexport { faker, type FakerFactory } from './faker';\n\n/**\n * Creates a wrapped Vitest test API with automatic transaction rollback for Objection.js.\n * Each test runs in an isolated database transaction that is rolled back after completion.\n * This ensures tests don't affect each other's data and run faster than truncating tables.\n *\n * @template Extended - Additional fixtures to provide\n * @param api - The Vitest test API (usually `test` from vitest)\n * @param options - Configuration options for transaction wrapping\n * @returns A wrapped test API that provides transaction isolation\n *\n * @example\n * ```typescript\n * import { test } from 'vitest';\n * import { wrapVitestObjectionTransaction } from '@geekmidas/testkit/objection';\n * import { knex } from './database';\n * import { User } from './models';\n *\n * // Create isolated test with automatic rollback\n * const isolatedTest = wrapVitestObjectionTransaction(test, {\n * connection: knex,\n * });\n *\n * // Use in tests - each test gets its own transaction\n * isolatedTest('should create user', async ({ trx }) => {\n * const user = await User.query(trx)\n * .insert({ name: 'Test User', email: 'test@example.com' });\n *\n * expect(user).toBeDefined();\n * });\n *\n * // With fixtures for factories\n * const it = wrapVitestObjectionTransaction<{ factory: Factory }>(test, {\n * connection: knex,\n * fixtures: {\n * factory: (trx) => new Factory(trx),\n * },\n * });\n *\n * it('should create user with factory', async ({ trx, factory }) => {\n * const user = await factory.insert('user', { name: 'Test' });\n * expect(user.id).toBeDefined();\n * });\n * ```\n */\nexport function wrapVitestObjectionTransaction<\n Extended extends Record<string, unknown> = {},\n>(api: TestAPI, options: ObjectionTransactionOptions<Extended>) {\n const wrapper = new VitestObjectionTransactionIsolator(api);\n\n return wrapper.wrapVitestWithTransaction(options);\n}\n\n/**\n * Extends an Objection.js transaction-wrapped test with additional fixtures.\n * Each fixture receives the transaction and can create dependencies like factories or repositories.\n *\n * @template Extended - The type of additional fixtures to provide\n * @param wrappedTest - The base wrapped test from wrapVitestObjectionTransaction\n * @param fixtures - Object mapping fixture names to creator functions\n * @returns An extended test API with both trx and the additional fixtures\n *\n * @example\n * ```typescript\n * import { test } from 'vitest';\n * import { wrapVitestObjectionTransaction, extendWithFixtures, ObjectionFactory } from '@geekmidas/testkit/objection';\n * import { User } from './models';\n *\n * // Define your builders\n * const builders = {\n * user: ObjectionFactory.createBuilder(User, ({ faker }) => ({\n * name: faker.person.fullName(),\n * email: faker.internet.email(),\n * })),\n * };\n *\n * // Create base wrapped test\n * const baseTest = wrapVitestObjectionTransaction(test, {\n * connection: knex,\n * setup: createTestTables,\n * });\n *\n * // Extend with fixtures - each fixture receives the transaction\n * const it = extendWithFixtures<{ factory: ObjectionFactory<typeof builders, {}> }>(\n * baseTest,\n * {\n * factory: (trx) => new ObjectionFactory(builders, {}, trx),\n * }\n * );\n *\n * // Use in tests - both trx and factory are available\n * it('should create user with factory', async ({ trx, factory }) => {\n * const user = await factory.insert('user', { name: 'Test User' });\n * expect(user.id).toBeDefined();\n *\n * // Verify in database\n * const found = await User.query(trx).findById(user.id);\n * expect(found?.name).toBe('Test User');\n * });\n * ```\n */\nexport function extendWithFixtures<\n Extended extends Record<string, unknown>,\n T extends ReturnType<TestAPI['extend']> = ReturnType<TestAPI['extend']>,\n>(wrappedTest: T, fixtures: FixtureCreators<Knex.Transaction, Extended>) {\n return baseExtendWithFixtures<Knex.Transaction, Extended, T>(\n wrappedTest,\n fixtures,\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2FA,SAAgB,+BAEdA,KAAcC,SAAgD;CAC9D,MAAM,UAAU,IAAI,mCAAmC;AAEvD,QAAO,QAAQ,0BAA0B,QAAQ;AAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDD,SAAgBC,qBAGdC,aAAgBC,UAAuD;AACvE,QAAO,mBACL,aACA,SACD;AACF"}
@@ -1,2 +1,2 @@
1
- import { DirectoryFixtures, itWithDir } from "../directory-Mi7tdOuD.cjs";
1
+ import { DirectoryFixtures, itWithDir } from "../directory-BUcnztHI.cjs";
2
2
  export { DirectoryFixtures, itWithDir };
@@ -1,2 +1,2 @@
1
- import { DirectoryFixtures, itWithDir } from "../directory-Q178x53k.mjs";
1
+ import { DirectoryFixtures, itWithDir } from "../directory-BXavAeJZ.mjs";
2
2
  export { DirectoryFixtures, itWithDir };
@@ -1,2 +1,2 @@
1
- import { itWithDir } from "../directory-Mi7tdOuD.cjs";
1
+ import { itWithDir } from "../directory-BUcnztHI.cjs";
2
2
  export { itWithDir };
@@ -1,2 +1,2 @@
1
- import { itWithDir } from "../directory-Q178x53k.mjs";
1
+ import { itWithDir } from "../directory-BXavAeJZ.mjs";
2
2
  export { itWithDir };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geekmidas/testkit",
3
- "version": "0.1.1",
3
+ "version": "0.2.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "exports": {
@@ -124,30 +124,59 @@ export abstract class VitestPostgresTransactionIsolator<TConn, Transaction> {
124
124
  * Creates a wrapped version of Vitest's test API that provides transaction isolation.
125
125
  * Each test will run within a database transaction that is automatically rolled back.
126
126
  *
127
- * @param conn - The database connection to use
128
- * @param setup - Optional setup function to run within the transaction before each test
129
- * @param level - The transaction isolation level (defaults to REPEATABLE_READ)
127
+ * @param options - Configuration options for transaction wrapping
130
128
  * @returns A wrapped test API with transaction support
131
129
  *
132
130
  * @example
133
131
  * ```typescript
134
- * const isolatedTest = isolator.wrapVitestWithTransaction(db, async (trx) => {
135
- * // Optional setup: create common test data
136
- * await trx.insert('settings', { key: 'test', value: 'true' });
132
+ * const isolatedTest = isolator.wrapVitestWithTransaction({
133
+ * connection: db,
134
+ * setup: async (trx) => {
135
+ * await trx.insert('settings', { key: 'test', value: 'true' });
136
+ * },
137
+ * fixtures: {
138
+ * factory: (trx) => new Factory(trx),
139
+ * },
137
140
  * });
138
141
  *
139
- * isolatedTest('test with transaction', async ({ trx }) => {
140
- * const user = await trx.insert('users', { name: 'Test' });
142
+ * isolatedTest('test with transaction', async ({ trx, factory }) => {
143
+ * const user = await factory.insert('user', { name: 'Test' });
141
144
  * expect(user).toBeDefined();
142
145
  * });
143
146
  * ```
144
147
  */
145
- wrapVitestWithTransaction(
146
- createConnection: DatabaseConnection<TConn>,
147
- setup?: (trx: Transaction) => Promise<void>,
148
- level: IsolationLevel = IsolationLevel.REPEATABLE_READ,
148
+ wrapVitestWithTransaction<Extended extends Record<string, unknown> = {}>(
149
+ options: TransactionWrapperOptions<TConn, Transaction, Extended>,
149
150
  ) {
150
- return this.api.extend<DatabaseFixtures<Transaction>>({
151
+ const {
152
+ connection,
153
+ setup,
154
+ isolationLevel = IsolationLevel.REPEATABLE_READ,
155
+ fixtures,
156
+ } = options;
157
+
158
+ // Build fixture definitions for additional fixtures that depend on trx
159
+ const additionalFixtures: Record<string, unknown> = {};
160
+ if (fixtures) {
161
+ for (const [key, creator] of Object.entries(fixtures)) {
162
+ additionalFixtures[key] = async (
163
+ { trx }: { trx: Transaction },
164
+ use: (value: unknown) => Promise<void>,
165
+ ) => {
166
+ const value = await (creator as (trx: Transaction) => unknown)(trx);
167
+ await use(value);
168
+ };
169
+ }
170
+ }
171
+
172
+ type CombinedFixtures = DatabaseFixtures<Transaction> & Extended;
173
+
174
+ // Cast to bypass Vitest's strict fixture typing which can't infer
175
+ // dynamically built fixture objects
176
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
177
+ const extendFn = this.api.extend as <T>(fixtures: any) => TestAPI<T>;
178
+
179
+ return extendFn<CombinedFixtures>({
151
180
  // This fixture automatically provides a transaction to each test
152
181
  trx: async ({}, use: (value: Transaction) => Promise<void>) => {
153
182
  // Create a custom error class for rollback
@@ -159,9 +188,9 @@ export abstract class VitestPostgresTransactionIsolator<TConn, Transaction> {
159
188
  }
160
189
 
161
190
  let testError: Error | undefined;
162
- const conn = await createConnection();
191
+ const conn = await connection();
163
192
  try {
164
- await this.transact(conn, level, async (transaction) => {
193
+ await this.transact(conn, isolationLevel, async (transaction) => {
165
194
  try {
166
195
  // Provide the transaction to the test
167
196
  await setup?.(transaction);
@@ -188,6 +217,7 @@ export abstract class VitestPostgresTransactionIsolator<TConn, Transaction> {
188
217
  await this.destroy(conn);
189
218
  }
190
219
  },
220
+ ...additionalFixtures,
191
221
  });
192
222
  }
193
223
  }
@@ -195,6 +225,24 @@ export abstract class VitestPostgresTransactionIsolator<TConn, Transaction> {
195
225
  export type DatabaseConnectionFn<Conn> = () => Conn | Promise<Conn>;
196
226
  export type DatabaseConnection<Conn> = DatabaseConnectionFn<Conn>;
197
227
 
228
+ /**
229
+ * Options for wrapping Vitest tests with database transaction isolation.
230
+ */
231
+ export interface TransactionWrapperOptions<
232
+ TConn,
233
+ Transaction,
234
+ Extended extends Record<string, unknown> = {},
235
+ > {
236
+ /** Function that creates or returns a database connection */
237
+ connection: DatabaseConnection<TConn>;
238
+ /** Optional setup function to run within the transaction before each test */
239
+ setup?: (trx: Transaction) => Promise<void>;
240
+ /** Transaction isolation level (defaults to REPEATABLE_READ) */
241
+ isolationLevel?: IsolationLevel;
242
+ /** Additional fixtures that depend on the transaction */
243
+ fixtures?: FixtureCreators<Transaction, Extended>;
244
+ }
245
+
198
246
  /**
199
247
  * Type for fixture creator functions that depend on the transaction.
200
248
  * Each function receives the transaction and returns the fixture value.
@@ -253,7 +301,10 @@ export type TestWithExtendedFixtures<
253
301
  * import { wrapVitestKyselyTransaction, extendWithFixtures } from '@geekmidas/testkit/kysely';
254
302
  *
255
303
  * // Create base wrapped test
256
- * const baseTest = wrapVitestKyselyTransaction(test, db, createTestTables);
304
+ * const baseTest = wrapVitestKyselyTransaction(test, {
305
+ * connection: db,
306
+ * setup: createTestTables,
307
+ * });
257
308
  *
258
309
  * // Extend with fixtures
259
310
  * const it = extendWithFixtures(baseTest, {
@@ -7,11 +7,10 @@ import { createKyselyDb } from '../helpers';
7
7
  import { wrapVitestKyselyTransaction } from '../kysely';
8
8
 
9
9
  const db = () => createKyselyDb<TestDatabase>(TEST_DATABASE_CONFIG);
10
- const itWithTransaction = wrapVitestKyselyTransaction<TestDatabase>(
11
- it,
12
- db,
13
- createTestTables,
14
- );
10
+ const itWithTransaction = wrapVitestKyselyTransaction<TestDatabase>(it, {
11
+ connection: db,
12
+ setup: createTestTables,
13
+ });
15
14
 
16
15
  const int8TypeId = 20;
17
16
  pg.types.setTypeParser(int8TypeId, (val) => {
@@ -37,11 +37,10 @@ class Comment extends Model {
37
37
  user_id!: string;
38
38
  }
39
39
 
40
- const it = wrapVitestObjectionTransaction(
41
- test,
42
- createKnexDb,
43
- createTestTablesKnex,
44
- );
40
+ const it = wrapVitestObjectionTransaction(test, {
41
+ connection: createKnexDb,
42
+ setup: createTestTablesKnex,
43
+ });
45
44
  describe('ObjectionFactory', () => {
46
45
  it('should create an ObjectionFactory instance', ({ trx }) => {
47
46
  const builders = {};
@@ -108,9 +108,12 @@ class Comment extends Model {
108
108
  // Create database connection
109
109
 
110
110
  // Create wrapped test with transaction isolation
111
- const it = wrapVitestObjectionTransaction(base, createKnexDb, async (trx) => {
112
- // Create tables in the transaction
113
- await createTestTablesKnex(trx);
111
+ const it = wrapVitestObjectionTransaction(base, {
112
+ connection: createKnexDb,
113
+ setup: async (trx) => {
114
+ // Create tables in the transaction
115
+ await createTestTablesKnex(trx);
116
+ },
114
117
  });
115
118
 
116
119
  describe('VitestObjectionTransactionIsolator', () => {
@@ -6,11 +6,10 @@ import { createKyselyDb } from '../helpers';
6
6
  import { extendWithFixtures, wrapVitestKyselyTransaction } from '../kysely';
7
7
 
8
8
  const db = () => createKyselyDb<TestDatabase>(TEST_DATABASE_CONFIG);
9
- const it = wrapVitestKyselyTransaction<TestDatabase>(
10
- base,
11
- db,
12
- createTestTables,
13
- );
9
+ const it = wrapVitestKyselyTransaction<TestDatabase>(base, {
10
+ connection: db,
11
+ setup: createTestTables,
12
+ });
14
13
  describe('Testkit Integration Tests', () => {
15
14
  beforeAll(async () => {});
16
15
  describe('Complex Factory Scenarios', () => {
@@ -481,11 +480,10 @@ describe('extendWithFixtures', () => {
481
480
  };
482
481
 
483
482
  // Create base test with transaction
484
- const baseTest = wrapVitestKyselyTransaction<TestDatabase>(
485
- base,
486
- db,
487
- createTestTables,
488
- );
483
+ const baseTest = wrapVitestKyselyTransaction<TestDatabase>(base, {
484
+ connection: db,
485
+ setup: createTestTables,
486
+ });
489
487
 
490
488
  // Extend with factory fixture
491
489
  const itWithFactory = extendWithFixtures<