fix: return SelectQueryError when referencing missing columns (#436)

* Returns 'never' if a column that does not exist in the schema * fix: return SelectQueryError when referencing missing columns --------- Co-authored-by: Bobbie Soedirgo <bobbie@soedirgo.dev>
supabase · Jun 14, 2023 · aeb2ce9 · aeb2ce9
1 parent 56376c0
commit aeb2ce9
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 16 deletions.
diff --git a/src/select-query-parser.ts b/src/select-query-parser.ts
@@ -55,6 +55,7 @@ type Json = string | number | boolean | null | { [key: string]: Json } | Json[]
  */
 type ParserError<Message extends string> = { error: true } & Message
 type GenericStringError = ParserError<'Received a generic string'>
+export type SelectQueryError<Message extends string> = { error: true } & Message
 
 /**
  * Trims whitespace from the left of the input.
@@ -136,7 +137,9 @@ type ConstructFieldDefinition<
         : never
     }
   : Field extends { name: string; original: string }
-  ? { [K in Field['name']]: Row[Field['original']] }
+  ? Field['original'] extends keyof Row
+    ? { [K in Field['name']]: Row[Field['original']] }
+    : SelectQueryError<`Referencing missing column \`${Field['original']}\``>
   : Field extends { name: string; type: infer T }
   ? { [K in Field['name']]: T }
   : Record<string, unknown>
@@ -415,21 +418,25 @@ type GetResultHelper<
   Fields extends unknown[],
   Acc
 > = Fields extends [infer R]
-  ? GetResultHelper<
-      Schema,
-      Row,
-      Relationships,
-      [],
-      ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
-    >
+  ? ConstructFieldDefinition<Schema, Row, Relationships, R> extends SelectQueryError<infer E>
+    ? SelectQueryError<E>
+    : GetResultHelper<
+        Schema,
+        Row,
+        Relationships,
+        [],
+        ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
+      >
   : Fields extends [infer R, ...infer Rest]
-  ? GetResultHelper<
-      Schema,
-      Row,
-      Relationships,
-      Rest,
-      ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
-    >
+  ? ConstructFieldDefinition<Schema, Row, Relationships, R> extends SelectQueryError<infer E>
+    ? SelectQueryError<E>
+    : GetResultHelper<
+        Schema,
+        Row,
+        Relationships,
+        Rest,
+        ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
+      >
   : Prettify<Acc>
 
 /**

diff --git a/test/index.test-d.ts b/test/index.test-d.ts
@@ -1,5 +1,6 @@
 import { expectError, expectType } from 'tsd'
-import { PostgrestClient } from '../src/index'
+import { PostgrestClient, PostgrestSingleResponse } from '../src/index'
+import { SelectQueryError } from '../src/select-query-parser'
 import { Database, Json } from './types'
 
 const REST_URL = 'http://localhost:3000'
@@ -81,3 +82,9 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
   }
   expectType<Database['public']['Tables']['messages']['Row'][]>(user.messages)
 }
+
+// referencing missing column
+{
+  const res = await postgrest.from('users').select('username, dat')
+  expectType<PostgrestSingleResponse<SelectQueryError<`Referencing missing column \`dat\``>[]>>(res)
+}