Merge pull request #613 from supabase/chore/add-auto-types-gen-and-override-for-testing

avallete · web-flow · commit e1d95013bfcd · 2025-04-04T13:48:11.000+02:00
chore(tests): add auto types gen and override for testing
diff --git a/package.json b/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 && sed -i 's/export type Json = .*/export type Json = unknown;/' ../types.generated.ts"
   },
   "dependencies": {
     "@supabase/node-fetch": "^2.6.14"
diff --git a/test/basic.ts b/test/basic.ts
@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { CustomUserDataType, Database } from './types'
+import { CustomUserDataType, Database } from './types.override'
 
 const REST_URL = 'http://localhost:3000'
 const postgrest = new PostgrestClient<Database>(REST_URL)
diff --git a/test/db/docker-compose.yml b/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
diff --git a/test/filters.ts b/test/filters.ts
@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 
 const postgrest = new PostgrestClient<Database>('http://localhost:3000')
 
diff --git a/test/index.test-d.ts b/test/index.test-d.ts
@@ -2,7 +2,8 @@ import { TypeEqual } from 'ts-expect'
 import { expectError, expectType } from 'tsd'
 import { PostgrestClient, PostgrestError } from '../src/index'
 import { Prettify } from '../src/types'
-import { Database, Json } from './types'
+import { Json } from '../src/select-query-parser/types'
+import { Database } from './types.override'
 
 const REST_URL = 'http://localhost:3000'
 const postgrest = new PostgrestClient<Database>(REST_URL)
@@ -189,8 +190,6 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
   if (result.error) {
     throw new Error(result.error.message)
   }
-  // getting this w/o the cast, not sure why:
-  // Parameter type Json is declared too wide for argument type Json
   expectType<Json>(result.data.bar)
   expectType<string>(result.data.baz)
 }
diff --git a/test/override-types.test-d.ts b/test/override-types.test-d.ts
@@ -1,7 +1,8 @@
 import { expectType } from 'tsd'
 import { TypeEqual } from 'ts-expect'
 import { PostgrestClient } from '../src'
-import { CustomUserDataType, Database, Json } from './types'
+import { CustomUserDataType, Database } from './types.override'
+import { Json } from './types.generated'
 
 const REST_URL = 'http://localhost:54321'
 const postgrest = new PostgrestClient<Database>(REST_URL)
diff --git a/test/relationships.ts b/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)
diff --git a/test/resource-embedding.ts b/test/resource-embedding.ts
@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 
 const postgrest = new PostgrestClient<Database>('http://localhost:3000')
 
diff --git a/test/returns.test-d.ts b/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'
diff --git a/test/rpc.ts b/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)
diff --git a/test/select-query-parser/result.test-d.ts b/test/select-query-parser/result.test-d.ts
@@ -1,9 +1,11 @@
-import { Database, Json } from '../types'
+import { Database } from '../types.override'
 import { selectParams } from '../relationships'
 import { GetResult } from '../../src/select-query-parser/result'
 import { expectType } from 'tsd'
 import { TypeEqual } from 'ts-expect'
 import { SelectQueryError } from '../../src/select-query-parser/utils'
+// TODO: should change this type in favor of unknown instead of the current one
+import type { Json } from '../../src/select-query-parser/types'
 
 type SelectQueryFromTableResult<
   TableName extends keyof Database['public']['Tables'],
diff --git a/test/select-query-parser/rpc.test-d.ts b/test/select-query-parser/rpc.test-d.ts
@@ -1,5 +1,5 @@
 import { postgrest, selectParams, RPC_NAME } from '../rpc'
-import { Database } from '../types'
+import { Database } from '../types.override'
 import { expectType } from 'tsd'
 import { TypeEqual } from 'ts-expect'
 
diff --git a/test/select-query-parser/select.test-d.ts b/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
diff --git a/test/transforms.ts b/test/transforms.ts
@@ -1,5 +1,5 @@
 import { PostgrestClient } from '../src/index'
-import { Database } from './types'
+import { Database } from './types.override'
 
 import { AbortController } from 'node-abort-controller'
 
diff --git a/test/types.generated.ts b/test/types.generated.ts
diff --git a/test/types.override.ts b/test/types.override.ts
