feat(typegen): add postgrest_version parameter to typegen

Author: avallete

src/server/routes/generators/typescript.ts

@@ -11,6 +11,7 @@ export default async (fastify: FastifyInstance) => {
       excluded_schemas?: string
       included_schemas?: string
       detect_one_to_one_relationships?: string
+      postgrest_version?: string
     }
   }>('/', async (request, reply) => {
     const config = createConnectionConfig(request)
@@ -19,6 +20,7 @@ export default async (fastify: FastifyInstance) => {
     const includedSchemas =
       request.query.included_schemas?.split(',').map((schema) => schema.trim()) ?? []
     const detectOneToOneRelationships = request.query.detect_one_to_one_relationships === 'true'
+    const postgrestVersion = request.query.postgrest_version
 
     const pgMeta: PostgresMeta = new PostgresMeta(config)
     const { data: generatorMeta, error: generatorMetaError } = await getGeneratorMetadata(pgMeta, {
@@ -34,6 +36,7 @@ export default async (fastify: FastifyInstance) => {
     return applyTypescriptTemplate({
       ...generatorMeta,
       detectOneToOneRelationships,
+      postgrestVersion,
     })
   })
 }

src/server/templates/typescript.ts

@@ -21,8 +21,10 @@ export const apply = async ({
   functions,
   types,
   detectOneToOneRelationships,
+  postgrestVersion,
 }: GeneratorMetadata & {
   detectOneToOneRelationships: boolean
+  postgrestVersion?: string
 }): Promise<string> => {
   const columnsByTableId = Object.fromEntries<PostgresColumn[]>(
     [...tables, ...foreignTables, ...views, ...materializedViews].map((t) => [t.id, []])
@@ -32,6 +34,29 @@ export const apply = async ({
     .sort(({ name: a }, { name: b }) => a.localeCompare(b))
     .forEach((c) => columnsByTableId[c.table_id].push(c))
 
+  const internal_supabase_schema = postgrestVersion
+    ? `// Allows to automatically instanciate createClient with right options
+  // instead of createClient<Database, { postgrestVersion: 'XX' }>(URL, KEY)
+  __internal_supabase: {
+    postgrestVersion: '${postgrestVersion}'
+    Tables: {
+      [_ in never]: never
+    }
+    Views: {
+      [_ in never]: never
+    }
+    Functions: {
+      [_ in never]: never
+    }
+    Enums: {
+      [_ in never]: never
+    }
+    CompositeTypes: {
+      [_ in never]: never
+    }
+  }`
+    : ''
+
   let output = `
 export type Json = string | number | boolean | null | { [key: string]: Json | undefined } | Json[]
 
@@ -431,6 +456,7 @@ export type Database = {
           }
         }`
     })}
+  ${internal_supabase_schema}
 }
 
 type DefaultSchema = Database[Extract<keyof Database, ${JSON.stringify(GENERATE_TYPES_DEFAULT_SCHEMA)}>]