feat(types): add isNotNullable optional override to setof function

Author: avallete

src/select-query-parser/result.ts

@@ -328,7 +328,10 @@ type ProcessEmbeddedResourceResult<
   Schema extends GenericSchema,
   Resolved extends {
     referencedTable: Pick<GenericTable, 'Row' | 'Relationships'>
-    relation: GenericRelationship & { match: 'refrel' | 'col' | 'fkname' | 'func' }
+    relation: GenericRelationship & {
+      match: 'refrel' | 'col' | 'fkname' | 'func'
+      isNotNullable?: boolean
+    }
     direction: string
   },
   Field extends Ast.FieldNode,
@@ -351,7 +354,11 @@ type ProcessEmbeddedResourceResult<
             ? ProcessedChildren
             : ProcessedChildren[]
           : Resolved['relation']['isOneToOne'] extends true
-          ? ProcessedChildren | null
+          ? Resolved['relation']['match'] extends 'func'
+            ? Resolved['relation']['isNotNullable'] extends true
+              ? ProcessedChildren
+              : ProcessedChildren | null
+            : ProcessedChildren | null
           : ProcessedChildren[]
         : // If the relation is a self-reference it'll always be considered as reverse relationship
         Resolved['relation']['referencedRelation'] extends CurrentTableOrView

src/select-query-parser/utils.ts

@@ -469,7 +469,12 @@ export type ResolveForwardRelationship<
                   : false
                 referencedColumns: []
                 referencedRelation: FoundEmbededFunctionJoinTableRelation['to']
-              } & { match: 'func' }
+              } & {
+                match: 'func'
+                isNotNullable: FoundEmbededFunctionJoinTableRelation['isNotNullable'] extends true
+                  ? true
+                  : false
+              }
               direction: 'forward'
               from: CurrentTableOrView
               type: 'found-by-embeded-function'

src/types.ts

@@ -62,6 +62,7 @@ export type GenericView = GenericUpdatableView | GenericNonUpdatableView
 
 export type GenericSetofOption = {
   isOneToOne?: boolean | undefined
+  isNotNullable?: boolean | undefined
   to: string
   from: string
 }

test/db/00-schema.sql

@@ -173,6 +173,16 @@ AS $$
   SELECT * FROM public.user_profiles WHERE username = user_row.username;
 $$;
 
+-- Same definition, but will be used with a type override to pretend this can't ever return null
+CREATE OR REPLACE FUNCTION public.get_user_profile_non_nullable(user_row users)
+RETURNS SETOF user_profiles
+LANGUAGE SQL STABLE
+ROWS 1
+AS $$
+  SELECT * FROM public.user_profiles WHERE username = user_row.username;
+$$;
+
+
 CREATE OR REPLACE FUNCTION public.get_messages(channel_row channels)
 RETURNS SETOF messages
 LANGUAGE SQL STABLE

test/embeded_functions_join.test-d.ts

@@ -54,6 +54,15 @@ type Schema = Database['public']
   }>
   expectType<TypeEqual<typeof result, typeof expected>>(true)
 }
+{
+  const { data } = await selectQueries.embeded_setof_row_one_function_not_nullable
+  let result: Exclude<typeof data, null>
+  let expected: Array<{
+    username: string
+    user_called_profile_not_null: Schema['Tables']['user_profiles']['Row']
+  }>
+  expectType<TypeEqual<typeof result, typeof expected>>(true)
+}
 
 {
   const { data } = await selectQueries.embeded_setof_row_one_function_with_fields_selection
@@ -99,6 +108,6 @@ type Schema = Database['public']
 {
   const { data } = await rpcQueries['function returning a single row embeded table']
   let result: Exclude<typeof data, null>
-  let expected: Array<Schema['Tables']['user_profiles']['Row']>
+  let expected: Schema['Tables']['user_profiles']['Row']
   expectType<TypeEqual<typeof result, typeof expected>>(true)
 }

test/embeded_functions_join.ts

@@ -22,6 +22,10 @@ export const selectParams = {
     from: 'users',
     select: 'username, user_called_profile:get_user_profile(*)',
   },
+  embeded_setof_row_one_function_not_nullable: {
+    from: 'users',
+    select: 'username, user_called_profile_not_null:get_user_profile_non_nullable(*)',
+  },
   embeded_setof_row_one_function_with_fields_selection: {
     from: 'users',
     select: 'username, user_called_profile:get_user_profile(username)',
@@ -48,6 +52,9 @@ export const selectQueries = {
   embeded_setof_row_one_function: postgrest
     .from(selectParams.embeded_setof_row_one_function.from)
     .select(selectParams.embeded_setof_row_one_function.select),
+  embeded_setof_row_one_function_not_nullable: postgrest
+    .from(selectParams.embeded_setof_row_one_function_not_nullable.from)
+    .select(selectParams.embeded_setof_row_one_function_not_nullable.select),
   embeded_setof_row_one_function_with_fields_selection: postgrest
     .from(selectParams.embeded_setof_row_one_function_with_fields_selection.from)
     .select(selectParams.embeded_setof_row_one_function_with_fields_selection.select),

test/types.generated.ts

@@ -30,9 +30,7 @@ export type Database = {
     }
     Functions: {
       get_status: {
-        Args: {
-          name_param: string
-        }
+        Args: { name_param: string }
         Returns: Database['public']['Enums']['user_status']
       }
     }
@@ -480,61 +478,67 @@ export type Database = {
     }
     Functions: {
       function_with_array_param: {
-        Args: {
-          param: string[]
-        }
+        Args: { param: string[] }
         Returns: undefined
       }
       function_with_optional_param: {
-        Args: {
-          param?: string
-        }
+        Args: { param?: string }
         Returns: string
       }
       get_messages: {
         Args:
-          | {
-              channel_row: Database['public']['Tables']['channels']['Row']
-            }
-          | {
-              user_row: Database['public']['Tables']['users']['Row']
-            }
+          | { channel_row: Database['public']['Tables']['channels']['Row'] }
+          | { user_row: Database['public']['Tables']['users']['Row'] }
         Returns: {
           channel_id: number
           data: Json | null
           id: number
           message: string | null
           username: string
         }[]
+        SetofOptions: {
+          from: 'channels' | 'users'
+          to: 'messages'
+          isOneToOne: false
+        }
       }
       get_status: {
-        Args: {
-          name_param: string
-        }
+        Args: { name_param: string }
         Returns: Database['public']['Enums']['user_status']
       }
       get_user_profile: {
-        Args: {
-          user_row: Database['public']['Tables']['users']['Row']
+        Args: { user_row: Database['public']['Tables']['users']['Row'] }
+        Returns: {
+          id: number
+          username: string | null
         }
+        SetofOptions: {
+          from: 'users'
+          to: 'user_profiles'
+          isOneToOne: true
+        }
+      }
+      get_user_profile_non_nullable: {
+        Args: { user_row: Database['public']['Tables']['users']['Row'] }
         Returns: {
           id: number
           username: string | null
-        }[]
+        }
+        SetofOptions: {
+          from: 'users'
+          to: 'user_profiles'
+          isOneToOne: true
+        }
       }
       get_username_and_status: {
-        Args: {
-          name_param: string
-        }
+        Args: { name_param: string }
         Returns: {
           username: string
           status: Database['public']['Enums']['user_status']
         }[]
       }
       offline_user: {
-        Args: {
-          name_param: string
-        }
+        Args: { name_param: string }
         Returns: Database['public']['Enums']['user_status']
       }
       void_func: {

test/types.override.ts

@@ -44,17 +44,9 @@ export type Database = MergeDeep<
         }
       }
       Functions: {
-        get_messages: {
+        get_user_profile_non_nullable: {
           SetofOptions: {
-            to: 'messages'
-            from: 'channels' | 'users'
-          }
-        }
-        get_user_profile: {
-          SetofOptions: {
-            to: 'user_profiles'
-            from: 'users'
-            isOneToOne: true
+            isNotNullable: true
           }
         }
       }