feat: extend sideload (#1099)

Author: adamcikado

src/orm/query_builder/index.ts

@@ -73,11 +73,6 @@ export class ModelQueryBuilder
   extends Chainable
   implements ModelQueryBuilderContract<LucidModel, LucidRow>
 {
-  /**
-   * Side-loaded attributes that will be passed to the model instances
-   */
-  protected sideloaded: ModelObject = {}
-
   /**
    * A copy of defined preloads on the model instance
    */
@@ -134,6 +129,11 @@ export class ModelQueryBuilder
    */
   isChildQuery = false
 
+  /**
+   * Side-loaded attributes that will be passed to the model instances
+   */
+  sideloaded: ModelObject = {}
+
   constructor(
     builder: Knex.QueryBuilder,
     public model: LucidModel,
@@ -448,8 +448,13 @@ export class ModelQueryBuilder
   /**
    * Set side-loaded properties to be passed to the model instance
    */
-  sideload(value: ModelObject) {
-    this.sideloaded = value
+  sideload(value: ModelObject, merge = false) {
+    if (merge) {
+      Object.assign(this.sideloaded, value)
+    } else {
+      this.sideloaded = value
+    }
+
     return this
   }
 

src/types/model.ts

@@ -402,12 +402,17 @@ export interface ModelQueryBuilderContract<Model extends LucidModel, Result = In
    */
   clone<ClonedResult = Result>(): ModelQueryBuilderContract<Model, ClonedResult>
 
+  sideloaded: InstanceType<Model>['$sideloaded']
+
   /**
    * A custom set of sideloaded properties defined on the query
    * builder, this will be passed to the model instance created
    * by the query builder
    */
-  sideload(value: ModelObject): this
+  sideload<Sideloaded extends InstanceType<Model>['$sideloaded'], Merge extends boolean = false>(
+    value: Merge extends true ? Partial<Sideloaded> : Sideloaded,
+    merge?: Merge
+  ): this
 
   /**
    * Execute and get first result

test/orm/model_query_builder.spec.ts

@@ -22,6 +22,7 @@ import {
   getBaseModel,
 } from '../../test-helpers/index.js'
 import type { HasMany } from '../../src/types/relations.js'
+import { ModelQueryBuilderContract } from '../../src/types/model.js'
 
 test.group('Model query builder', (group) => {
   group.setup(async () => {
@@ -578,4 +579,28 @@ test.group('Model query builder', (group) => {
 
     assert.lengthOf(posts, 1)
   })
+
+  test('define custom type for sideloaded', async ({ fs, expectTypeOf }) => {
+    const app = new AppFactory().create(fs.baseUrl, () => {})
+    await app.init()
+    const db = getDb()
+    const adapter = ormAdapter(db)
+    const BaseModel = getBaseModel(adapter)
+
+    type Sideload = { test: boolean }
+
+    class User extends BaseModel {
+      declare $sideloaded: Sideload
+
+      @column({ isPrimary: true })
+      declare id: number
+
+      @column()
+      declare username: string
+    }
+
+    type Query = ModelQueryBuilderContract<typeof User>
+
+    expectTypeOf<Query['sideloaded']>().toEqualTypeOf<Sideload>()
+  })
 })