supatool 0.3.1 → 0.3.3

package/README.md

@@ -285,41 +285,17 @@ supatool extract --all -c "postgresql://..." -o supabase/schemas
 
 ## Changelog
 
-## Database Comments
+### v0.3.3
 
-Supatool automatically extracts and includes PostgreSQL comments in all generated files. Comments enhance documentation and AI understanding of your schema.
+- **ENHANCED**: Improved SQL comment placement (moved to end of each SQL statement)
+- **ENHANCED**: Unified comment format for tables, views, functions, and custom types
+- **FIXED**: Preserved view `security_invoker` settings
 
-### Adding Comments to Your Database
+### v0.3.2
 
-```sql
--- Table comments
-COMMENT ON TABLE users IS 'User account information and authentication data';
-
--- View comments
-COMMENT ON VIEW user_profiles IS 'Combined user data with profile information';
-
--- Function comments
-COMMENT ON FUNCTION update_timestamp() IS 'Automatically updates the updated_at column';
-
--- Custom type comments
-COMMENT ON TYPE user_status IS 'Enumeration of possible user account statuses';
-```
-
-### Comment Integration
-
-Comments appear in:
-- **index.md**: Human-readable file listings with descriptions (tables/views only)
-- **llms.txt**: AI-friendly format (`type:name:path:comment`)
-- **Generated SQL**: As `COMMENT ON` statements for full schema recreation
-
-**Example output:**
-```markdown
-## Tables
-- [users](tables/users.sql) - User account information and authentication data
-- [posts](tables/posts.sql) - User-generated content and blog posts
-```
-
-## Changelog
+- **ENHANCED**: Adjust for extensions(vector, geometry etc.)
+- **FIXED**: USER-DEFINED column types are now rendered with full type definitions (e.g. `vector(1536)`, `geometry(Point,4326)`).
+- **ADDED**: `FOREIGN KEY` constraints are now included as `CONSTRAINT ... FOREIGN KEY ... REFERENCES ...` inside generated `CREATE TABLE` statements.
 
 ### v0.3.0
 
@@ -350,4 +326,38 @@ Comments appear in:
 ### v0.2.0
 - Added `gen:` commands for code and schema generation
 - Enhanced `create` command  
-- Introduced model schema support (`schemas/supatool-data.schema.ts`)
+- Introduced model schema support (`schemas/supatool-data.schema.ts`)
+
+## Database Comments
+
+Supatool automatically extracts and includes PostgreSQL comments in all generated files. Comments enhance documentation and AI understanding of your schema.
+
+### Adding Comments to Your Database
+
+```sql
+-- Table comments
+COMMENT ON TABLE users IS 'User account information and authentication data';
+
+-- View comments
+COMMENT ON VIEW user_profiles IS 'Combined user data with profile information';
+
+-- Function comments
+COMMENT ON FUNCTION update_timestamp() IS 'Automatically updates the updated_at column';
+
+-- Custom type comments
+COMMENT ON TYPE user_status IS 'Enumeration of possible user account statuses';
+```
+
+### Comment Integration
+
+Comments appear in:
+- **index.md**: Human-readable file listings with descriptions (tables/views only)
+- **llms.txt**: AI-friendly format (`type:name:path:comment`)
+- **Generated SQL**: As `COMMENT ON` statements for full schema recreation
+
+**Example output:**
+```markdown
+## Tables
+- [users](tables/users.sql) - User account information and authentication data
+- [posts](tables/posts.sql) - User-generated content and blog posts
+```

package/dist/generator/sqlGenerator.js

@@ -49,6 +49,7 @@ function generateSqlFromModel(model, outPath) {
         let userIdCount = userIdFields.length;
         sql += `CREATE TABLE ${tableName} (\n`;
         const colDefs = [];
+        const tableConstraints = [];
         for (const [colName, col] of Object.entries(t.fields || {})) {
             const c = col;
             let actualColName = colName;
@@ -66,18 +67,23 @@ function generateSqlFromModel(model, outPath) {
             let def = `  ${actualColName} ${toSqlType(c.type, actualColName)}`;
             if (c.primary)
                 def += ' PRIMARY KEY';
+            if (c.unique)
+                def += ' UNIQUE';
             if (c.notNull)
                 def += ' NOT NULL';
             if (c.default)
                 def += ` DEFAULT ${c.default}`;
-            // 外部キー制約はREFERENCESで付与
+            // 外部キー制約はテーブル末尾に付与するため保留
+            colDefs.push(def);
+            // 外部キー制約をテーブル末尾に格納
             if (c.ref) {
                 const refTable = c.ref.split('.')[0];
-                def += ` REFERENCES ${refTable}(id)`;
+                tableConstraints.push(`  FOREIGN KEY (${actualColName}) REFERENCES ${refTable}(id)`);
             }
-            colDefs.push(def);
         }
-        sql += colDefs.join(',\n') + '\n);\n\n';
+        // 列定義 + テーブルレベル制約を結合
+        const defs = [...colDefs, ...tableConstraints];
+        sql += defs.join(',\n') + '\n);\n\n';
         // ALTER TABLEによる外部キー制約は出力しない
         sql += '\n';
     }
@@ -89,12 +95,20 @@ function toSqlType(type, colName) {
     // 時刻列は必ずtimestamptz
     if (type === 'timestamp' || type === 'timestamptz' || colName.endsWith('_at'))
         return 'timestamptz';
+    // vector型サポート
+    if (/^vector(\(\d+\))?$/i.test(type))
+        return type;
+    // extensions.vector → vector へ変換
+    const extVectorMatch = type.match(/^extensions\.vector(\(\d+\))?$/i);
+    if (extVectorMatch) {
+        return `vector${extVectorMatch[1] || ''}`;
+    }
     switch (type) {
         case 'uuid': return 'uuid';
         case 'text': return 'text';
         case 'int':
         case 'integer': return 'integer';
         case 'boolean': return 'boolean';
-        default: return 'text';
+        default: return type; // 指定が未知の場合はそのまま返す
     }
 }

package/dist/sync/definitionExtractor.js

@@ -230,14 +230,19 @@ async function fetchFunctions(client, spinner, progress, schemas = ['public']) {
         let ddl = '';
         if (!row.comment) {
             ddl += `-- Function: ${functionSignature}\n`;
-            ddl += `-- COMMENT ON FUNCTION ${functionSignature} IS '_your_comment_here_';\n\n`;
         }
         else {
             ddl += `-- ${row.comment}\n`;
-            ddl += `COMMENT ON FUNCTION ${functionSignature} IS '${row.comment}';\n\n`;
         }
         // 関数定義を追加
-        ddl += row.definition;
+        ddl += row.definition + '\n\n';
+        // COMMENT ON文を追加
+        if (!row.comment) {
+            ddl += `-- COMMENT ON FUNCTION ${functionSignature} IS '_your_comment_here_';\n\n`;
+        }
+        else {
+            ddl += `COMMENT ON FUNCTION ${functionSignature} IS '${row.comment}';\n\n`;
+        }
         functions.push({
             name: row.name,
             type: 'function',
@@ -469,17 +474,23 @@ async function fetchCustomTypes(client, spinner, progress, schemas = ['public'])
             }
         }
         if (ddl) {
-            // 型コメントを先頭に追加（スキーマ名を含む）
+            // 型コメントを先頭に追加
             let finalDdl = '';
             if (!row.comment) {
                 finalDdl += `-- Type: ${row.type_name}\n`;
-                finalDdl += `-- COMMENT ON TYPE ${row.schema_name}.${row.type_name} IS '_your_comment_here_';\n\n`;
             }
             else {
                 finalDdl += `-- ${row.comment}\n`;
+            }
+            // 型定義を追加
+            finalDdl += ddl + '\n\n';
+            // COMMENT ON文を追加
+            if (!row.comment) {
+                finalDdl += `-- COMMENT ON TYPE ${row.schema_name}.${row.type_name} IS '_your_comment_here_';\n\n`;
+            }
+            else {
                 finalDdl += `COMMENT ON TYPE ${row.schema_name}.${row.type_name} IS '${row.comment}';\n\n`;
             }
-            finalDdl += ddl;
             types.push({
                 name: `${row.schema_name}_${row.type_name}`,
                 type: 'type',
@@ -608,12 +619,11 @@ async function fetchTableDefinitions(client, spinner, progress, schemas = ['publ
                     if (viewCommentResult.rows.length > 0 && viewCommentResult.rows[0].view_comment) {
                         comment = viewCommentResult.rows[0].view_comment;
                         ddl = `-- ${comment}\n`;
-                        ddl += `COMMENT ON VIEW ${schemaName}.${name} IS '${comment}';\n\n`;
                     }
                     else {
                         ddl = `-- View: ${name}\n`;
-                        ddl += `-- COMMENT ON VIEW ${schemaName}.${name} IS '_your_comment_here_';\n\n`;
                     }
+                    // ビュー定義を追加
                     let ddlStart = `CREATE OR REPLACE VIEW ${name}`;
                     // security_invoker設定をチェック
                     if (view.reloptions) {
@@ -630,7 +640,14 @@ async function fetchTableDefinitions(client, spinner, progress, schemas = ['publ
                             }
                         }
                     }
-                    ddl += `${ddlStart} AS\n${view.definition}`;
+                    ddl += ddlStart + ' AS\n' + view.definition + ';\n\n';
+                    // COMMENT ON文を追加
+                    if (viewCommentResult.rows.length > 0 && viewCommentResult.rows[0].view_comment) {
+                        ddl += `COMMENT ON VIEW ${schemaName}.${name} IS '${comment}';\n\n`;
+                    }
+                    else {
+                        ddl += `-- COMMENT ON VIEW ${schemaName}.${name} IS '_your_comment_here_';\n\n`;
+                    }
                     // ビューの作成時刻を取得（可能であれば）
                     try {
                         const viewStatsResult = await client.query(`
@@ -652,8 +669,7 @@ async function fetchTableDefinitions(client, spinner, progress, schemas = ['publ
                 }
             }
             catch (error) {
-                console.error(`Failed to fetch view definition: ${name}`, error);
-                return null;
+                // エラーの場合はコメントなし
             }
         }
         return {
@@ -717,19 +733,24 @@ async function fetchTableDefinitions(client, spinner, progress, schemas = ['publ
  */
 async function generateCreateTableDDL(client, tableName, schemaName = 'public') {
     // 全てのクエリを並行実行
-    const [columnsResult, primaryKeyResult, tableCommentResult, columnCommentsResult, uniqueConstraintResult] = await Promise.all([
+    const [columnsResult, primaryKeyResult, tableCommentResult, columnCommentsResult, uniqueConstraintResult, foreignKeyResult] = await Promise.all([
         // カラム情報を取得
         client.query(`
       SELECT 
-        column_name,
-        data_type,
-        character_maximum_length,
-        is_nullable,
-        column_default
-      FROM information_schema.columns 
-      WHERE table_schema = $1 
-        AND table_name = $2
-      ORDER BY ordinal_position
+        c.column_name,
+        c.data_type,
+        c.udt_name,
+        c.character_maximum_length,
+        c.is_nullable,
+        c.column_default,
+        pg_catalog.format_type(a.atttypid, a.atttypmod) AS full_type
+      FROM information_schema.columns c
+      JOIN pg_class cl ON cl.relname = c.table_name
+      JOIN pg_namespace ns ON ns.nspname = c.table_schema AND ns.oid = cl.relnamespace
+      JOIN pg_attribute a ON a.attrelid = cl.oid AND a.attname = c.column_name
+      WHERE c.table_schema = $1 
+        AND c.table_name = $2
+      ORDER BY c.ordinal_position
     `, [schemaName, tableName]),
         // 主キー情報を取得
         client.query(`
@@ -776,6 +797,25 @@ async function generateCreateTableDDL(client, tableName, schemaName = 'public')
         AND tc.constraint_type = 'UNIQUE'
       GROUP BY tc.constraint_name
       ORDER BY tc.constraint_name
+    `, [schemaName, tableName]),
+        // FOREIGN KEY制約を取得
+        client.query(`
+      SELECT 
+        tc.constraint_name,
+        string_agg(kcu.column_name, ', ' ORDER BY kcu.ordinal_position) as columns,
+        ccu.table_schema AS foreign_table_schema,
+        ccu.table_name AS foreign_table_name,
+        string_agg(ccu.column_name, ', ' ORDER BY kcu.ordinal_position) as foreign_columns
+      FROM information_schema.table_constraints tc
+      JOIN information_schema.key_column_usage kcu 
+        ON tc.constraint_name = kcu.constraint_name AND tc.table_schema = kcu.table_schema
+      JOIN information_schema.constraint_column_usage ccu 
+        ON tc.constraint_name = ccu.constraint_name AND tc.table_schema = ccu.table_schema
+      WHERE tc.table_schema = $1
+        AND tc.table_name = $2
+        AND tc.constraint_type = 'FOREIGN KEY'
+      GROUP BY tc.constraint_name, ccu.table_schema, ccu.table_name
+      ORDER BY tc.constraint_name
     `, [schemaName, tableName])
     ]);
     const columnComments = new Map();
@@ -786,19 +826,20 @@ async function generateCreateTableDDL(client, tableName, schemaName = 'public')
     });
     // テーブルコメントを先頭に追加（スキーマ名を含む）
     let ddl = '';
+    // テーブルコメントを先頭に追加
     if (tableCommentResult.rows.length > 0 && tableCommentResult.rows[0].table_comment) {
         ddl += `-- ${tableCommentResult.rows[0].table_comment}\n`;
-        ddl += `COMMENT ON TABLE ${schemaName}.${tableName} IS '${tableCommentResult.rows[0].table_comment}';\n\n`;
     }
     else {
         ddl += `-- Table: ${tableName}\n`;
-        ddl += `-- COMMENT ON TABLE ${schemaName}.${tableName} IS '_your_comment_here_';\n\n`;
     }
     // CREATE TABLE文を生成
     ddl += `CREATE TABLE IF NOT EXISTS ${tableName} (\n`;
     const columnDefs = [];
     for (const col of columnsResult.rows) {
-        let colDef = `  ${col.column_name} ${col.data_type.toUpperCase()}`;
+        const rawType = col.full_type ||
+            ((col.data_type === 'USER-DEFINED' && col.udt_name) ? col.udt_name : col.data_type);
+        let colDef = `  ${col.column_name} ${rawType}`;
         // 長さ指定
         if (col.character_maximum_length) {
             colDef += `(${col.character_maximum_length})`;
@@ -823,8 +864,18 @@ async function generateCreateTableDDL(client, tableName, schemaName = 'public')
     for (const unique of uniqueConstraintResult.rows) {
         ddl += `,\n  CONSTRAINT ${unique.constraint_name} UNIQUE (${unique.columns})`;
     }
-    ddl += '\n);\n';
-    ddl += '\n';
+    // FOREIGN KEY制約をCREATE TABLE内に追加
+    for (const fk of foreignKeyResult.rows) {
+        ddl += `,\n  CONSTRAINT ${fk.constraint_name} FOREIGN KEY (${fk.columns}) REFERENCES ${fk.foreign_table_schema}.${fk.foreign_table_name} (${fk.foreign_columns})`;
+    }
+    ddl += '\n);\n\n';
+    // COMMENT ON文を追加
+    if (tableCommentResult.rows.length > 0 && tableCommentResult.rows[0].table_comment) {
+        ddl += `COMMENT ON TABLE ${schemaName}.${tableName} IS '${tableCommentResult.rows[0].table_comment}';\n\n`;
+    }
+    else {
+        ddl += `-- COMMENT ON TABLE ${schemaName}.${tableName} IS '_your_comment_here_';\n\n`;
+    }
     // カラムコメントを追加（スキーマ名を含む）
     if (columnComments.size > 0) {
         ddl += '\n-- カラムコメント\n';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supatool",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "A CLI tool for Supabase schema extraction and TypeScript CRUD generation with declarative database schema support.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",