feat: add meta to all relations (#1042)

adonisjs · Nov 18, 2024 · ade635f · ade635f
1 parent d5354ae
commit ade635f
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 0 deletions.
diff --git a/src/orm/relations/belongs_to/index.ts b/src/orm/relations/belongs_to/index.ts
@@ -59,6 +59,8 @@ export class BelongsTo implements BelongsToRelationContract<LucidModel, LucidMod
    */
   onQueryHook
 
+  declare meta?: any
+
   constructor(
     public relationName: string,
     public relatedModel: () => LucidModel,
@@ -68,6 +70,7 @@ export class BelongsTo implements BelongsToRelationContract<LucidModel, LucidMod
     this.onQueryHook = this.options.onQuery
     this.serializeAs =
       this.options.serializeAs === undefined ? this.relationName : this.options.serializeAs
+    this.meta = this.options.meta
   }
 
   /**

diff --git a/src/orm/relations/has_many/index.ts b/src/orm/relations/has_many/index.ts
@@ -61,6 +61,8 @@ export class HasMany implements HasManyRelationContract<LucidModel, LucidModel>
    */
   onQueryHook
 
+  declare meta?: any
+
   constructor(
     public relationName: string,
     public relatedModel: () => LucidModel,
@@ -70,6 +72,7 @@ export class HasMany implements HasManyRelationContract<LucidModel, LucidModel>
     this.serializeAs =
       this.options.serializeAs === undefined ? this.relationName : this.options.serializeAs
     this.onQueryHook = this.options.onQuery
+    this.meta = this.options.meta
   }
 
   /**

diff --git a/src/orm/relations/has_many_through/index.ts b/src/orm/relations/has_many_through/index.ts
@@ -59,6 +59,8 @@ export class HasManyThrough implements HasManyThroughRelationContract<LucidModel
   declare throughForeignKey: string
   declare throughForeignKeyColumnName: string
 
+  declare meta?: any
+
   constructor(
     public relationName: string,
     public relatedModel: () => LucidModel,
@@ -75,6 +77,7 @@ export class HasManyThrough implements HasManyThroughRelationContract<LucidModel
     this.throughModel = this.options.throughModel
     this.serializeAs =
       this.options.serializeAs === undefined ? this.relationName : this.options.serializeAs
+    this.meta = this.options.meta
   }
 
   /**

diff --git a/src/orm/relations/has_one/index.ts b/src/orm/relations/has_one/index.ts
@@ -48,6 +48,8 @@ export class HasOne implements HasOneRelationContract<LucidModel, LucidModel> {
    */
   onQueryHook
 
+  declare meta?: any
+
   constructor(
     public relationName: string,
     public relatedModel: () => LucidModel,
@@ -57,6 +59,7 @@ export class HasOne implements HasOneRelationContract<LucidModel, LucidModel> {
     this.onQueryHook = this.options.onQuery
     this.serializeAs =
       this.options.serializeAs === undefined ? this.relationName : this.options.serializeAs
+    this.meta = this.options.meta
   }
 
   /**

diff --git a/src/orm/relations/many_to_many/index.ts b/src/orm/relations/many_to_many/index.ts
@@ -62,6 +62,8 @@ export class ManyToMany implements ManyToManyRelationContract<LucidModel, LucidM
    */
   onQueryHook
 
+  declare meta?: any
+
   /**
    * Computes the created at timestamps column name
    * for the pivot table
@@ -114,6 +116,7 @@ export class ManyToMany implements ManyToManyRelationContract<LucidModel, LucidM
       this.options.serializeAs === undefined ? this.relationName : this.options.serializeAs
     this.pivotColumns = this.options.pivotColumns || []
     this.onQueryHook = this.options.onQuery
+    this.meta = this.options.meta
   }
 
   /**

diff --git a/src/types/relations.ts b/src/types/relations.ts
@@ -67,6 +67,7 @@ export type RelationOptions<
   foreignKey?: string
   serializeAs?: string | null
   onQuery?(query: Related['builder'] | Related['subQuery']): void
+  meta?: any
 }
 
 /**
@@ -87,6 +88,7 @@ export type ManyToManyRelationOptions<Related extends ModelRelations<LucidModel,
       }
   serializeAs?: string | null
   onQuery?(query: Related['builder'] | Related['subQuery']): void
+  meta?: any
 }
 
 /**
@@ -100,6 +102,7 @@ export type ThroughRelationOptions<
   throughLocalKey?: string
   throughForeignKey?: string
   throughModel: () => LucidModel
+  meta?: any
 }
 
 /**