feat(typegen): views

Author: soedirgo

src/server/app.ts

@@ -65,6 +65,7 @@ if (EXPORT_DOCS) {
     })
     const { data: schemas, error: schemasError } = await pgMeta.schemas.list()
     const { data: tables, error: tablesError } = await pgMeta.tables.list()
+    const { data: views, error: viewsError } = await pgMeta.views.list()
     const { data: functions, error: functionsError } = await pgMeta.functions.list()
     const { data: types, error: typesError } = await pgMeta.types.list({
       includeSystemSchemas: true,
@@ -77,6 +78,9 @@ if (EXPORT_DOCS) {
     if (tablesError) {
       throw new Error(tablesError.message)
     }
+    if (viewsError) {
+      throw new Error(viewsError.message)
+    }
     if (functionsError) {
       throw new Error(functionsError.message)
     }
@@ -92,6 +96,7 @@ if (EXPORT_DOCS) {
             GENERATE_TYPES_INCLUDED_SCHEMAS.includes(name)
         ),
         tables,
+        views,
         functions: functions.filter(
           ({ return_type }) => !['trigger', 'event_trigger'].includes(return_type)
         ),

src/server/routes/generators/typescript.ts

@@ -21,6 +21,7 @@ export default async (fastify: FastifyInstance) => {
     const pgMeta: PostgresMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
     const { data: schemas, error: schemasError } = await pgMeta.schemas.list()
     const { data: tables, error: tablesError } = await pgMeta.tables.list()
+    const { data: views, error: viewsError } = await pgMeta.views.list()
     const { data: functions, error: functionsError } = await pgMeta.functions.list()
     const { data: types, error: typesError } = await pgMeta.types.list({
       includeSystemSchemas: true,
@@ -37,6 +38,11 @@ export default async (fastify: FastifyInstance) => {
       reply.code(500)
       return { error: tablesError.message }
     }
+    if (viewsError) {
+      request.log.error({ error: viewsError, request: extractRequestForLogging(request) })
+      reply.code(500)
+      return { error: viewsError.message }
+    }
     if (functionsError) {
       request.log.error({ error: functionsError, request: extractRequestForLogging(request) })
       reply.code(500)
@@ -55,6 +61,7 @@ export default async (fastify: FastifyInstance) => {
           (includedSchemas.length === 0 || includedSchemas.includes(name))
       ),
       tables,
+      views,
       functions: functions.filter(
         ({ return_type }) => !['trigger', 'event_trigger'].includes(return_type)
       ),

src/server/templates/typescript.ts

@@ -1,14 +1,22 @@
 import prettier from 'prettier'
-import type { PostgresFunction, PostgresSchema, PostgresTable, PostgresType } from '../../lib'
+import type {
+  PostgresFunction,
+  PostgresSchema,
+  PostgresTable,
+  PostgresType,
+  PostgresView,
+} from '../../lib'
 
 export const apply = ({
   schemas,
   tables,
+  views,
   functions,
   types,
 }: {
   schemas: PostgresSchema[]
   tables: PostgresTable[]
+  views: PostgresView[]
   functions: PostgresFunction[]
   types: PostgresType[]
 }): string => {
@@ -18,6 +26,7 @@ export type Json = string | number | boolean | null | { [key: string]: Json } |
 export interface Database {
   ${schemas.map((schema) => {
     const schemaTables = tables.filter((table) => table.schema === schema.name)
+    const schemaViews = views.filter((view) => view.schema === schema.name)
     const schemaFunctions = functions.filter((func) => func.schema === schema.name)
     return `${JSON.stringify(schema.name)}: {
           Tables: {
@@ -82,6 +91,59 @@ export interface Database {
                   )
             }
           }
+          Views: {
+            ${
+              schemaViews.length === 0
+                ? '[_ in never]: never'
+                : schemaViews.map(
+                    (view) => `${JSON.stringify(view.name)}: {
+                  Row: {
+                    ${view.columns.map(
+                      (column) =>
+                        `${JSON.stringify(column.name)}: ${pgTypeToTsType(
+                          column.format,
+                          types
+                        )} | null`
+                    )}
+                  }
+                  ${
+                    view.is_updatable
+                      ? `Insert: {
+                    ${view.columns.map((column) => {
+                      let output = JSON.stringify(column.name)
+
+                      if (!column.is_updatable) {
+                        return `${output}?: never`
+                      }
+
+                      output += `?: ${pgTypeToTsType(column.format, types)} | null`
+
+                      return output
+                    })}
+                  }`
+                      : ''
+                  }
+                  ${
+                    view.is_updatable
+                      ? `Update: {
+                    ${view.columns.map((column) => {
+                      let output = JSON.stringify(column.name)
+
+                      if (!column.is_updatable) {
+                        return `${output}?: never`
+                      }
+
+                      output += `?: ${pgTypeToTsType(column.format, types)} | null`
+
+                      return output
+                    })}
+                  }`
+                      : ''
+                  }
+                }`
+                  )
+            }
+          }
           Functions: {
             ${
               schemaFunctions.length === 0