feat(typegen): include table relationships

Author: soedirgo

src/server/routes/generators/typescript.ts

@@ -24,6 +24,7 @@ export default async (fastify: FastifyInstance) => {
     const { data: views, error: viewsError } = await pgMeta.views.list()
     const { data: materializedViews, error: materializedViewsError } =
       await pgMeta.materializedViews.list({ includeColumns: true })
+    const { data: relationships, error: relationshipsError } = await pgMeta.relationships.list()
     const { data: functions, error: functionsError } = await pgMeta.functions.list()
     const { data: types, error: typesError } = await pgMeta.types.list({
       includeArrayTypes: true,
@@ -54,6 +55,11 @@ export default async (fastify: FastifyInstance) => {
       reply.code(500)
       return { error: materializedViewsError.message }
     }
+    if (relationshipsError) {
+      request.log.error({ error: relationshipsError, request: extractRequestForLogging(request) })
+      reply.code(500)
+      return { error: relationshipsError.message }
+    }
     if (functionsError) {
       request.log.error({ error: functionsError, request: extractRequestForLogging(request) })
       reply.code(500)
@@ -74,6 +80,7 @@ export default async (fastify: FastifyInstance) => {
       tables,
       views,
       materializedViews,
+      relationships,
       functions: functions.filter(
         ({ return_type }) => !['trigger', 'event_trigger'].includes(return_type)
       ),

src/server/server.ts

@@ -41,6 +41,7 @@ if (EXPORT_DOCS) {
   const { data: views, error: viewsError } = await pgMeta.views.list()
   const { data: materializedViews, error: materializedViewsError } =
     await pgMeta.materializedViews.list({ includeColumns: true })
+  const { data: relationships, error: relationshipsError } = await pgMeta.relationships.list()
   const { data: functions, error: functionsError } = await pgMeta.functions.list()
   const { data: types, error: typesError } = await pgMeta.types.list({
     includeArrayTypes: true,
@@ -60,6 +61,9 @@ if (EXPORT_DOCS) {
   if (materializedViewsError) {
     throw new Error(materializedViewsError.message)
   }
+  if (relationshipsError) {
+    throw new Error(relationshipsError.message)
+  }
   if (functionsError) {
     throw new Error(functionsError.message)
   }
@@ -77,6 +81,7 @@ if (EXPORT_DOCS) {
       tables,
       views,
       materializedViews,
+      relationships,
       functions: functions.filter(
         ({ return_type }) => !['trigger', 'event_trigger'].includes(return_type)
       ),

src/server/templates/typescript.ts

@@ -2,6 +2,7 @@ import prettier from 'prettier'
 import type {
   PostgresFunction,
   PostgresMaterializedView,
+  PostgresRelationship,
   PostgresSchema,
   PostgresTable,
   PostgresType,
@@ -13,6 +14,7 @@ export const apply = ({
   tables,
   views,
   materializedViews,
+  relationships,
   functions,
   types,
   arrayTypes,
@@ -21,6 +23,7 @@ export const apply = ({
   tables: (PostgresTable & { columns: unknown[] })[]
   views: (PostgresView & { columns: unknown[] })[]
   materializedViews: (PostgresMaterializedView & { columns: unknown[] })[]
+  relationships: PostgresRelationship[]
   functions: PostgresFunction[]
   types: PostgresType[]
   arrayTypes: PostgresType[]
@@ -145,6 +148,18 @@ export interface Database {
                         return output
                       })}
                   }
+                  Relationships: [
+                    ${relationships
+                      .filter((relationship) => relationship.schema === table.schema && relationship.relation === table.name)
+                      .map((relationship) => `{
+                        foreignKeyName: ${JSON.stringify(relationship.foreign_key_name)}
+                        columns: ${JSON.stringify(relationship.columns)}
+                        referencedSchema: ${JSON.stringify(relationship.referenced_schema)}
+                        referencedRelation: ${JSON.stringify(relationship.referenced_relation)}
+                        referencedColumns: ${JSON.stringify(relationship.referenced_columns)}
+                      }`)
+                    }
+                  ]
                 }`
                   )
             }

test/server/typegen.ts

@@ -30,6 +30,7 @@ test('typegen', async () => {
               id?: number
               name?: string
             }
+            Relationships: []
           }
           memes: {
             Row: {
@@ -56,6 +57,15 @@ test('typegen', async () => {
               name?: string
               status?: Database["public"]["Enums"]["meme_status"] | null
             }
+            Relationships: [
+              {
+                foreignKeyName: "memes_category_fkey"
+                columns: ["category"]
+                referencedSchema: "public"
+                referencedRelation: "category"
+                referencedColumns: ["id"]
+              }
+            ]
           }
           todos: {
             Row: {
@@ -74,6 +84,15 @@ test('typegen', async () => {
               id?: number
               "user-id"?: number
             }
+            Relationships: [
+              {
+                foreignKeyName: "todos_user-id_fkey"
+                columns: ["user-id"]
+                referencedSchema: "public"
+                referencedRelation: "users"
+                referencedColumns: ["id"]
+              }
+            ]
           }
           users: {
             Row: {
@@ -91,6 +110,7 @@ test('typegen', async () => {
               name?: string | null
               status?: Database["public"]["Enums"]["user_status"] | null
             }
+            Relationships: []
           }
           users_audit: {
             Row: {
@@ -111,6 +131,7 @@ test('typegen', async () => {
               previous_value?: Json | null
               user_id?: number | null
             }
+            Relationships: []
           }
         }
         Views: {