test: allow overriding result types

Author: soedirgo

test/basic.ts

@@ -178,11 +178,6 @@ describe('basic insert, update, delete', () => {
   })
 })
 
-test('table invalid type', async () => {
-  // @ts-expect-error table invalid type
-  postgrest.from(42)
-})
-
 test('throwOnError throws errors instead of returning them', async () => {
   let isErrorCaught = false
 
@@ -275,18 +270,6 @@ test('maybeSingle w/ throwOnError', async () => {
   expect(passes).toEqual(true)
 })
 
-test('custom type', async () => {
-  const { data: users, error } = await postgrest.from('users').select().eq('username', 'supabot')
-
-  if (error) {
-    throw new Error(error.message)
-  }
-
-  const user = users[0]
-  // Autocomplete should show properties of user after '.'
-  user?.username
-})
-
 test("don't mutate PostgrestClient.headers", async () => {
   await postgrest.from('users').select().limit(1).single()
   const { error } = await postgrest.from('users').select()
@@ -440,13 +423,3 @@ test('select with no match', async () => {
     }
   `)
 })
-
-test('cannot update non-updatable views', () => {
-  // @ts-expect-error TS2345
-  postgrest.from('non_updatable_view').update({})
-})
-
-test('cannot update non-updatable columns', () => {
-  // @ts-expect-error TS2322
-  postgrest.from('updatable_view').update({ non_updatable_column: 0 })
-})

test/index.test-d.ts

@@ -0,0 +1,44 @@
+import { expectError, expectType } from 'tsd'
+import { PostgrestClient } from '../src/index'
+import { Database } from './types'
+
+const REST_URL = 'http://localhost:3000'
+const postgrest = new PostgrestClient<Database>(REST_URL)
+
+// table invalid type
+{
+  expectError(postgrest.from(42))
+}
+
+// can override result type
+{
+  const { data, error } = await postgrest
+    .from('users')
+    .select('*, messages(*)')
+    .returns<{ messages: { foo: 'bar' }[] }>()
+  if (error) {
+    throw new Error(error.message)
+  }
+  expectType<{ foo: 'bar' }[]>(data[0].messages)
+}
+{
+  const { data, error } = await postgrest
+    .from('users')
+    .insert({ username: 'foo' })
+    .select('*, messages(*)')
+    .returns<{ messages: { foo: 'bar' }[] }>()
+  if (error) {
+    throw new Error(error.message)
+  }
+  expectType<{ foo: 'bar' }[]>(data[0].messages)
+}
+
+// cannot update non-updatable views
+{
+  expectError(postgrest.from('updatable_view').update({ non_updatable_column: 0 }))
+}
+
+// cannot update non-updatable columns
+{
+  expectError(postgrest.from('updatable_view').update({ non_updatable_column: 0 }))
+}

tsconfig.json

@@ -5,7 +5,6 @@
     "declarationMap": true,
     "module": "CommonJS",
     "outDir": "dist/main",
-    "rootDir": "src",
     "sourceMap": true,
     "target": "ES2015",