chore(tests): add automatic typegen for testing according to database schema

Author: avallete

package.json

@@ -39,10 +39,12 @@
     "docs:json": "typedoc --json docs/v2/spec.json --excludeExternals src/index.ts",
     "test": "run-s format:check test:types db:clean db:run test:run db:clean && node test/smoke.cjs && node test/smoke.mjs",
     "test:run": "jest --runInBand --coverage",
-    "test:update": "run-s db:clean db:run && jest --runInBand --updateSnapshot && run-s db:clean",
+    "test:update": "run-s db:clean db:run db:generate-test-types && jest --runInBand --updateSnapshot && run-s db:clean",
     "test:types": "run-s build && tsd --files 'test/**/*.test-d.ts'",
+    "test:types:watch": "run-s build && tsd --files 'test/**/*.test-d.ts' --watch",
     "db:clean": "cd test/db && docker compose down --volumes",
-    "db:run": "cd test/db && docker compose up --detach && wait-for-localhost 3000"
+    "db:run": "cd test/db && docker compose up --detach && wait-for-localhost 3000",
+    "db:generate-test-types": "cd test/db && docker compose up --detach && wait-for-localhost 8080 &&  curl --location 'http://0.0.0.0:8080/generators/typescript?included_schemas=public,personal&detect_one_to_one_relationships=true' > ../types.generated.ts"
   },
   "dependencies": {
     "@supabase/node-fetch": "^2.6.14"

test/db/docker-compose.yml

@@ -28,3 +28,9 @@ services:
       POSTGRES_PASSWORD: postgres
       POSTGRES_HOST: /var/run/postgresql
       POSTGRES_PORT: 5432
+  pgmeta:
+    image: supabase/postgres-meta:v0.87.1
+    ports:
+      - '8080:8080'
+    environment:
+      - PG_META_DB_URL=postgresql://postgres:postgres@db:5432/postgres

test/relationships.ts

@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 
 const REST_URL = 'http://localhost:3000'
 export const postgrest = new PostgrestClient<Database>(REST_URL)

test/returns.test-d.ts

@@ -1,6 +1,6 @@
 import { expectType } from 'tsd'
 import { PostgrestBuilder, PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 import { TypeEqual } from 'ts-expect'
 
 const REST_URL = 'http://localhost:3000'

test/rpc.ts

@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 
 const REST_URL = 'http://localhost:3000'
 export const postgrest = new PostgrestClient<Database>(REST_URL)

test/select-query-parser/result.test-d.ts

@@ -1,4 +1,4 @@
-import { Database, Json } from '../types'
+import { Database, Json } from '../types.override'
 import { selectParams } from '../relationships'
 import { GetResult } from '../../src/select-query-parser/result'
 import { expectType } from 'tsd'

test/select-query-parser/select.test-d.ts

@@ -3,7 +3,7 @@ import { TypeEqual } from 'ts-expect'
 import { Json } from '../../src/select-query-parser/types'
 import { SelectQueryError } from '../../src/select-query-parser/utils'
 import { Prettify } from '../../src/types'
-import { CustomUserDataType, Database } from '../types'
+import { CustomUserDataType, Database } from '../types.override'
 import { selectQueries } from '../relationships'
 
 // This test file is here to ensure that for a query against a specfic datatabase
@@ -622,6 +622,7 @@ type Schema = Database['public']
       username: string
     }
   }
+  //@ts-expect-error this should work once we use unknown instead of Json type definition
   expectType<TypeEqual<typeof result, typeof expected>>(true)
 }