feat!: Change relationship API

Relationship factory callback is now accepted as a second argument. The Relationship meta { foreignKey, localKey } is optional and accepted as a third argument. This makes the API less verbeous

packages/core/src/contracts.ts

@@ -94,6 +94,6 @@ export interface RelationshipMeta {
 }
 
 export type RelationshipMetaOptions = Optional<
-  Omit<RelationshipMeta, 'type'>,
+  Omit<RelationshipMeta, 'type' | 'factory'>,
   'foreignKey' | 'localKey'
 >

packages/core/src/model.ts

@@ -33,10 +33,16 @@ export class FactoryModel<Model extends Record<string, any>, States extends stri
     this.callback = callback
   }
 
-  private addRelation(name: string, type: RelationType, meta: RelationshipMetaOptions) {
+  private addRelation(
+    name: string,
+    factory: RelationshipMeta['factory'],
+    type: RelationType,
+    meta?: RelationshipMetaOptions
+  ) {
     this.relations[name] = {
       foreignKey: `${this.tableName}_id`,
       localKey: 'id',
+      factory,
       ...meta,
       type,
     }
@@ -58,22 +64,22 @@ export class FactoryModel<Model extends Record<string, any>, States extends stri
   /**
    * Add hasOne relationship
    */
-  public hasOne(name: string, meta: RelationshipMetaOptions) {
-    return this.addRelation(name, RelationType.HasOne, meta)
+  public hasOne(name: string, cb: RelationshipMeta['factory'], meta?: RelationshipMetaOptions) {
+    return this.addRelation(name, cb, RelationType.HasOne, meta)
   }
 
   /**
    * Add hasMany relationship
    */
-  public hasMany(name: string, meta: RelationshipMetaOptions) {
-    return this.addRelation(name, RelationType.HasMany, meta)
+  public hasMany(name: string, cb: RelationshipMeta['factory'], meta?: RelationshipMetaOptions) {
+    return this.addRelation(name, cb, RelationType.HasMany, meta)
   }
 
   /**
    * Add belongsTo relationship
    */
-  public belongsTo(name: string, meta: RelationshipMetaOptions) {
-    return this.addRelation(name, RelationType.BelongsTo, meta)
+  public belongsTo(name: string, cb: RelationshipMeta['factory'], meta?: RelationshipMetaOptions) {
+    return this.addRelation(name, cb, RelationType.BelongsTo, meta)
   }
 
   /**

tests-helpers/setup.ts

@@ -19,8 +19,8 @@ export const UserFactory = defineFactory<any>('user', ({ faker }) => ({
 }))
   .state('easyPassword', () => ({ password: 'easy' }))
   .state('easyEmail', () => ({ email: 'easy@easy.com' }))
-  .hasOne('profile', { foreignKey: 'user_id', localKey: 'id', factory: () => ProfileFactory })
-  .hasMany('posts', { foreignKey: 'user_id', localKey: 'id', factory: () => PostFactory })
+  .hasOne('profile', () => ProfileFactory, { foreignKey: 'user_id', localKey: 'id' })
+  .hasMany('posts', () => PostFactory, { foreignKey: 'user_id', localKey: 'id' })
   .build()
 
 export const AdminFactory = defineFactory('admin', ({ faker }) => ({
@@ -30,6 +30,6 @@ export const AdminFactory = defineFactory('admin', ({ faker }) => ({
 export const AccountFactory = defineFactory('account', ({ faker }) => ({
   name: faker.commerce.productName(),
 }))
-  .belongsTo('user', { foreignKey: 'user_id', localKey: 'id', factory: () => UserFactory })
-  .belongsTo('admin', { foreignKey: 'admin_id', localKey: 'id', factory: () => AdminFactory })
+  .belongsTo('user', () => UserFactory, { foreignKey: 'user_id', localKey: 'id' })
+  .belongsTo('admin', () => AdminFactory, { foreignKey: 'admin_id', localKey: 'id' })
   .build()

tests/has_many.spec.ts

@@ -89,7 +89,7 @@ test.group('HasMany', (group) => {
       email: faker.internet.email(),
       password: faker.random.alphaNumeric(6),
     }))
-      .hasMany('post', { factory: () => postFactory })
+      .hasMany('post', () => postFactory)
       .build()
 
     const user = await userFactory.with('post', 5).create()