fix: nullable relation types (#1130)

Author: adamcikado

src/types/model.ts

@@ -689,8 +689,8 @@ export interface LucidRow {
   loadAggregate: <
     Self extends this,
     Name extends ExtractModelRelations<Self>,
-    RelatedBuilder = Self[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Self[Name]['subQuery']
+    RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Self[Name]>['subQuery']
       : never,
   >(
     name: Name,
@@ -703,8 +703,8 @@ export interface LucidRow {
   loadCount: <
     Self extends this,
     Name extends ExtractModelRelations<Self>,
-    RelatedBuilder = Self[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Self[Name]['subQuery']
+    RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Self[Name]>['subQuery']
       : never,
   >(
     name: Name,
@@ -758,7 +758,9 @@ export interface LucidRow {
    */
   related<Name extends ExtractModelRelations<this>>(
     relation: Name
-  ): this[Name] extends ModelRelations<LucidModel, LucidModel> ? this[Name]['client'] : never
+  ): NonNullable<this[Name]> extends ModelRelations<LucidModel, LucidModel>
+    ? NonNullable<this[Name]>['client']
+    : never
 }
 
 /**
@@ -908,8 +910,8 @@ export interface LucidModel {
   $getRelation<Model extends LucidModel, Name extends ExtractModelRelations<InstanceType<Model>>>(
     this: Model,
     name: Name
-  ): InstanceType<Model>[Name] extends ModelRelations<LucidModel, LucidModel>
-    ? InstanceType<Model>[Name]['client']['relation']
+  ): NonNullable<InstanceType<Model>[Name]> extends ModelRelations<LucidModel, LucidModel>
+    ? NonNullable<InstanceType<Model>[Name]>['client']['relation']
     : RelationshipsContract
   $getRelation<Model extends LucidModel>(this: Model, name: string): RelationshipsContract
 

src/types/relations.ts

@@ -992,8 +992,8 @@ export interface ManyToManySubQueryBuilderContract<Related extends LucidModel>
 export interface WithCount<Model extends LucidRow, Builder> {
   <
     Name extends ExtractModelRelations<Model>,
-    RelatedBuilder = Model[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Model[Name]['subQuery']
+    RelatedBuilder = NonNullable<Model[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Model[Name]>['subQuery']
       : never,
   >(
     relation: Name,
@@ -1007,8 +1007,8 @@ export interface WithCount<Model extends LucidRow, Builder> {
 export interface WithAggregate<Model extends LucidRow, Builder> {
   <
     Name extends ExtractModelRelations<Model>,
-    RelatedBuilder = Model[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Model[Name]['subQuery']
+    RelatedBuilder = NonNullable<Model[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Model[Name]>['subQuery']
       : never,
   >(
     relation: Name,
@@ -1033,8 +1033,8 @@ export interface Has<Model extends LucidRow, Builder> {
 export interface WhereHas<Model extends LucidRow, Builder> {
   <
     Name extends ExtractModelRelations<Model>,
-    RelatedBuilder = Model[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Model[Name]['subQuery']
+    RelatedBuilder = NonNullable<Model[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Model[Name]>['subQuery']
       : never,
   >(
     relation: Name,
@@ -1056,8 +1056,8 @@ export interface WhereHas<Model extends LucidRow, Builder> {
 export interface Preload<Model extends LucidRow, Builder> {
   <
     Name extends ExtractModelRelations<Model>,
-    RelatedBuilder = Model[Name] extends ModelRelations<LucidModel, LucidModel>
-      ? Model[Name]['builder']
+    RelatedBuilder = NonNullable<Model[Name]> extends ModelRelations<LucidModel, LucidModel>
+      ? NonNullable<Model[Name]>['builder']
       : never,
   >(
     relation: Name,

src/types/test.ts

@@ -0,0 +1,13 @@
+/*
+ * @adonisjs/lucid
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export type ExtractRelationCallback<
+  T extends (...args: any[]) => any,
+  Callback = NonNullable<Parameters<T>[1]>,
+> = Callback extends (...args: any[]) => any ? Parameters<Callback>[0] : never

test/orm/model_belongs_to.spec.ts

@@ -22,6 +22,7 @@ import {
   getDb,
 } from '../../test-helpers/index.js'
 import { AppFactory } from '@adonisjs/core/factories/app'
+import { ExtractRelationCallback } from '../../src/types/test.js'
 
 test.group('Model | BelongsTo | Options', (group) => {
   group.setup(async () => {
@@ -238,11 +239,25 @@ test.group('Model | BelongsTo | Options', (group) => {
     }
 
     class Profile extends BaseModel {
+      @column()
+      declare userId: number
+
       @belongsTo(() => User)
       declare user?: BelongsTo<typeof User> | null
     }
 
+    const preload = Profile.query().preload<'user'>
+    const withCount = Profile.query().withCount<'user'>
+    const withAggregate = Profile.query().withAggregate<'user'>
+    const whereHas = Profile.query().whereHas<'user'>
+    const related = new Profile().related('user')
+
     expectTypeOf<ExtractModelRelations<Profile>>().toEqualTypeOf<'user' | undefined>()
+    expectTypeOf<ExtractRelationCallback<typeof preload>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof withCount>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof withAggregate>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof whereHas>>().not.toBeNever()
+    expectTypeOf<typeof related>().not.toBeNever()
   })
 })
 

test/orm/model_has_one.spec.ts

@@ -23,6 +23,7 @@ import {
   resetTables,
 } from '../../test-helpers/index.js'
 import { AppFactory } from '@adonisjs/core/factories/app'
+import { ExtractRelationCallback } from '../../src/types/test.js'
 
 test.group('Model | HasOne | Options', (group) => {
   group.setup(async () => {
@@ -252,7 +253,18 @@ test.group('Model | HasOne | Options', (group) => {
       declare profile?: HasOne<typeof Profile> | null
     }
 
+    const preload = User.query().preload<'profile'>
+    const withCount = User.query().withCount<'profile'>
+    const withAggregate = User.query().withAggregate<'profile'>
+    const whereHas = User.query().whereHas<'profile'>
+    const related = new User().related('profile')
+
     expectTypeOf<ExtractModelRelations<User>>().toEqualTypeOf<'profile' | undefined>()
+    expectTypeOf<ExtractRelationCallback<typeof preload>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof withCount>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof withAggregate>>().not.toBeNever()
+    expectTypeOf<ExtractRelationCallback<typeof whereHas>>().not.toBeNever()
+    expectTypeOf<typeof related>().not.toBeNever()
   })
 })