feat: generate types for views and materialized views

aldis-ameriks · Aug 23, 2024 · 9710d2d · 9710d2d
1 parent e34d23e
commit 9710d2d
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 3 deletions.
diff --git a/cjs/src/postgres.js b/cjs/src/postgres.js
@@ -20,6 +20,7 @@ function getTableDefinitions (sql, schema) {
       SELECT c.table_name AS name,
              obj_description(('"' || c.table_name || '"')::regclass) AS comment,
              t.table_type = 'VIEW' AS "isView",
+             FALSE AS "isMaterializedView",
              jsonb_agg(
                      DISTINCT jsonb_build_object(
                      'name', column_name,
@@ -75,6 +76,7 @@ async function getMaterializedViewDefinitions (sql, schema) {
       )
       SELECT pc.relname AS name,
              TRUE AS "isView",
+             TRUE AS "isMaterializedView",
              jsonb_agg(
                      DISTINCT jsonb_build_object(
                      'name', pa.attname,

diff --git a/cjs/src/typescript.js b/cjs/src/typescript.js
@@ -211,11 +211,17 @@ function typescript (opts, schema) {
   }
 
   if (opts.viewNames) {
-    const views = tables.filter(table => table.isView)
+    const views = tables.filter(table => table.isView && !table.isMaterializedView)
     if (views.length > 0) {
       result += `export type Views = ${views.sort(sortByField('name')).map(table => `'${table.name}'`).join(' | ')}${semicolon(opts)}`
       result += '\n\n'
     }
+
+    const materializedViews = tables.filter(table => table.isMaterializedView)
+    if (materializedViews.length > 0) {
+      result += `export type MaterializedViews = ${materializedViews.sort(sortByField('name')).map(table => `'${table.name}'`).join(' | ')}${semicolon(opts)}`
+      result += '\n\n'
+    }
   }
 
   const enumTypes = generateEnumTypes(opts, enums)

diff --git a/src/postgres.js b/src/postgres.js
@@ -20,6 +20,7 @@ function getTableDefinitions (sql, schema) {
       SELECT c.table_name AS name,
              obj_description(('"' || c.table_name || '"')::regclass) AS comment,
              t.table_type = 'VIEW' AS "isView",
+             FALSE AS "isMaterializedView",
              jsonb_agg(
                      DISTINCT jsonb_build_object(
                      'name', column_name,
@@ -75,6 +76,7 @@ async function getMaterializedViewDefinitions (sql, schema) {
       )
       SELECT pc.relname AS name,
              TRUE AS "isView",
+             TRUE AS "isMaterializedView",
              jsonb_agg(
                      DISTINCT jsonb_build_object(
                      'name', pa.attname,

diff --git a/src/typescript.js b/src/typescript.js
@@ -211,11 +211,17 @@ function typescript (opts, schema) {
   }
 
   if (opts.viewNames) {
-    const views = tables.filter(table => table.isView)
+    const views = tables.filter(table => table.isView && !table.isMaterializedView)
     if (views.length > 0) {
       result += `export type Views = ${views.sort(sortByField('name')).map(table => `'${table.name}'`).join(' | ')}${semicolon(opts)}`
       result += '\n\n'
     }
+
+    const materializedViews = tables.filter(table => table.isMaterializedView)
+    if (materializedViews.length > 0) {
+      result += `export type MaterializedViews = ${materializedViews.sort(sortByField('name')).map(table => `'${table.name}'`).join(' | ')}${semicolon(opts)}`
+      result += '\n\n'
+    }
   }
 
   const enumTypes = generateEnumTypes(opts, enums)

diff --git a/tap-snapshots/test/cli.js.test.cjs b/tap-snapshots/test/cli.js.test.cjs
@@ -2231,7 +2231,9 @@ export type UserEntity = {
 `
 
 exports['test/cli.js > TAP > generates view names > must match snapshot 1'] = `
-export type Views = 'materialized_items' | 'materialized_other_items' | 'some_view'
+export type Views = 'some_view'
+
+export type MaterializedViews = 'materialized_items' | 'materialized_other_items'
 
 export enum DeliciousKebab {
   'big-mix' = 'big-mix',

diff --git a/tap-snapshots/test/pg-typegen.js.test.cjs b/tap-snapshots/test/pg-typegen.js.test.cjs
@@ -53,6 +53,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "address",
     },
@@ -69,6 +70,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "histories",
     },
@@ -85,6 +87,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "kebab-test",
     },
@@ -123,6 +126,7 @@ Object {
           "type": "timestamptz",
         },
       ],
+      "isMaterializedView": true,
       "isView": true,
       "name": "materialized_items",
     },
@@ -145,6 +149,7 @@ Object {
           "type": "text",
         },
       ],
+      "isMaterializedView": true,
       "isView": true,
       "name": "materialized_other_items",
     },
@@ -170,6 +175,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "PascalTableName",
     },
@@ -191,6 +197,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "snake_test",
     },
@@ -216,6 +223,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": true,
       "name": "some_view",
     },
@@ -1186,6 +1194,7 @@ Object {
         },
       ],
       "comment": null,
+      "isMaterializedView": false,
       "isView": false,
       "name": "types",
     },
@@ -1252,6 +1261,7 @@ Object {
         },
       ],
       "comment": "this is the users table",
+      "isMaterializedView": false,
       "isView": false,
       "name": "users",
     },