@revealui/db 0.2.0

package/dist/types/index.js

@@ -0,0 +1,19 @@
+/**
+ * @revealui/db/types - Database Type Exports
+ *
+ * Centralized type exports for NeonDB database.
+ * Provides feature parity with Supabase's Database type structure.
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import type { Database } from '@revealui/db/types'
+ *
+ * // Extract table types
+ * type User = Database['public']['Tables']['users']['Row']
+ * type NewUser = Database['public']['Tables']['users']['Insert']
+ * type UserUpdate = Database['public']['Tables']['users']['Update']
+ * ```
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG"}

package/dist/types/introspect.d.ts

@@ -0,0 +1,75 @@
+#!/usr/bin/env tsx
+/**
+ * Database Introspection System
+ *
+ * Validates Drizzle schemas against the actual database structure.
+ * Can optionally generate types from the database for validation.
+ *
+ * This provides:
+ * 1. Schema validation - ensures Drizzle schemas match database
+ * 2. Type generation from DB - generates types from actual database (for comparison)
+ * 3. Migration validation - ensures migrations are applied correctly
+ */
+interface IntrospectionOptions {
+    /** Database connection string */
+    connectionString?: string;
+    /** Whether to generate types from database */
+    generateTypes?: boolean;
+    /** Whether to validate schema matches */
+    validateSchema?: boolean;
+    /** Output file for generated types (if generateTypes is true) */
+    outputFile?: string;
+}
+interface IntrospectionResult {
+    success: boolean;
+    tables: string[];
+    mismatches?: Array<{
+        table: string;
+        issue: string;
+    }>;
+    errors?: string[];
+}
+/**
+ * Introspect the database and validate against Drizzle schemas
+ *
+ * Connects to the database and queries information_schema to validate
+ * that Drizzle schemas match the actual database structure.
+ */
+export declare function introspectDatabase(options?: IntrospectionOptions): Promise<IntrospectionResult>;
+/**
+ * Generate types from actual database structure
+ *
+ * Note: This is a placeholder for future enhancement. Currently, we use
+ * schema-based type generation (generate.ts) which automatically discovers
+ * tables and relationships from Drizzle schemas. This approach is preferred
+ * because:
+ * - It keeps types in sync with code
+ * - It's faster and doesn't require database connection
+ * - It provides better type safety with Drizzle's inference
+ *
+ * If database-first type generation is needed in the future, this would:
+ * 1. Connect to database using Drizzle Kit introspection API
+ * 2. Query information_schema for tables, columns, and relationships
+ * 3. Generate TypeScript types matching the Database type structure
+ * 4. Write to outputFile
+ *
+ * @param connectionString - Database connection string
+ * @param outputFile - Output file path
+ */
+export declare function generateTypesFromDatabase(connectionString: string, outputFile: string): Promise<void>;
+/**
+ * Validate that Drizzle schemas match the database
+ *
+ * Compares schema definitions with actual database structure.
+ *
+ * @param connectionString - Database connection string
+ */
+export declare function validateSchemaMatch(connectionString: string): Promise<{
+    success: boolean;
+    mismatches: Array<{
+        table: string;
+        issue: string;
+    }>;
+}>;
+export {};
+//# sourceMappingURL=introspect.d.ts.map

package/dist/types/introspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.d.ts","sourceRoot":"","sources":["../../src/types/introspect.ts"],"names":[],"mappings":";AACA;;;;;;;;;;GAUG;AAMH,UAAU,oBAAoB;IAC5B,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,yCAAyC;IACzC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,UAAU,mBAAmB;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,mBAAmB,CAAC,CAoF9B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,wBAAsB,yBAAyB,CAC7C,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3E,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACpD,CAAC,CAUD"}

package/dist/types/introspect.js

@@ -0,0 +1,187 @@
+#!/usr/bin/env tsx
+/**
+ * Database Introspection System
+ *
+ * Validates Drizzle schemas against the actual database structure.
+ * Can optionally generate types from the database for validation.
+ *
+ * This provides:
+ * 1. Schema validation - ensures Drizzle schemas match database
+ * 2. Type generation from DB - generates types from actual database (for comparison)
+ * 3. Migration validation - ensures migrations are applied correctly
+ */
+import { neon } from '@neondatabase/serverless';
+import { logger } from '@revealui/utils/logger';
+import { discoverTables } from './discover.js';
+/**
+ * Introspect the database and validate against Drizzle schemas
+ *
+ * Connects to the database and queries information_schema to validate
+ * that Drizzle schemas match the actual database structure.
+ */
+export async function introspectDatabase(options = {}) {
+    const { validateSchema = true } = options;
+    // Only use environment fallback if connectionString is not in options at all
+    // If explicitly set to undefined, treat as missing
+    const connectionString = 'connectionString' in options
+        ? options.connectionString
+        : process.env.POSTGRES_URL || process.env.DATABASE_URL;
+    if (!connectionString) {
+        return {
+            success: false,
+            tables: [],
+            errors: ['Database connection string not provided'],
+        };
+    }
+    try {
+        // Connect to database
+        const sql = neon(connectionString);
+        // Query information_schema for tables in public schema
+        const dbTables = (await sql `
+      SELECT table_name
+      FROM information_schema.tables
+      WHERE table_schema = 'public'
+        AND table_type = 'BASE TABLE'
+      ORDER BY table_name
+    `);
+        const tableNames = dbTables.map((row) => row.table_name);
+        // Discover tables from Drizzle schemas
+        const discoveryResult = discoverTables();
+        const { tables: schemaTables } = discoveryResult;
+        // Explicitly type the Set to ensure proper type inference
+        const schemaTableNames = new Set(schemaTables.map((t) => t.tableName));
+        const mismatches = [];
+        if (validateSchema) {
+            // Check for tables in database but not in schema
+            for (const dbTable of tableNames) {
+                if (!schemaTableNames.has(dbTable)) {
+                    mismatches.push({
+                        table: dbTable,
+                        issue: `Table exists in database but not in Drizzle schema`,
+                    });
+                }
+            }
+            // Check for tables in schema but not in database
+            // schemaTableNames is Set<string>, so iteration yields string directly
+            for (const schemaTable of schemaTableNames) {
+                // TypeScript now correctly infers schemaTable as string
+                if (!tableNames.includes(schemaTable)) {
+                    mismatches.push({
+                        table: schemaTable,
+                        issue: `Table defined in Drizzle schema but not in database`,
+                    });
+                }
+            }
+        }
+        const result = {
+            success: mismatches.length === 0,
+            tables: tableNames,
+        };
+        if (validateSchema) {
+            result.mismatches = mismatches;
+        }
+        return result;
+    }
+    catch (error) {
+        return {
+            success: false,
+            tables: [],
+            errors: [
+                `Database introspection failed: ${error instanceof Error ? error.message : String(error)}`,
+            ],
+        };
+    }
+}
+/**
+ * Generate types from actual database structure
+ *
+ * Note: This is a placeholder for future enhancement. Currently, we use
+ * schema-based type generation (generate.ts) which automatically discovers
+ * tables and relationships from Drizzle schemas. This approach is preferred
+ * because:
+ * - It keeps types in sync with code
+ * - It's faster and doesn't require database connection
+ * - It provides better type safety with Drizzle's inference
+ *
+ * If database-first type generation is needed in the future, this would:
+ * 1. Connect to database using Drizzle Kit introspection API
+ * 2. Query information_schema for tables, columns, and relationships
+ * 3. Generate TypeScript types matching the Database type structure
+ * 4. Write to outputFile
+ *
+ * @param connectionString - Database connection string
+ * @param outputFile - Output file path
+ */
+// eslint-disable-next-line @typescript-eslint/require-await
+export async function generateTypesFromDatabase(connectionString, outputFile) {
+    void connectionString;
+    void outputFile;
+    throw new Error('Database introspection type generation not yet implemented. ' +
+        'Use the schema-based type generator (generate.ts) instead. ' +
+        'Run: pnpm --filter @revealui/db generate:types');
+}
+/**
+ * Validate that Drizzle schemas match the database
+ *
+ * Compares schema definitions with actual database structure.
+ *
+ * @param connectionString - Database connection string
+ */
+export async function validateSchemaMatch(connectionString) {
+    const result = await introspectDatabase({
+        connectionString,
+        validateSchema: true,
+    });
+    return {
+        success: result.success,
+        mismatches: result.mismatches || [],
+    };
+}
+// CLI interface
+if (import.meta.url === `file://${process.argv[1]}`) {
+    const args = process.argv.slice(2);
+    const connectionString = process.env.POSTGRES_URL || process.env.DATABASE_URL;
+    if (!connectionString) {
+        logger.error('POSTGRES_URL or DATABASE_URL environment variable is required', new Error('Missing database connection string'));
+        process.exit(1);
+    }
+    if (args.includes('--validate')) {
+        introspectDatabase({ connectionString, validateSchema: true })
+            .then((result) => {
+            if (result.success) {
+                logger.info('Schema validation passed', {
+                    tablesFound: result.tables.length,
+                    mismatches: result.mismatches?.length || 0,
+                });
+                if (result.mismatches && result.mismatches.length > 0) {
+                    logger.warn(`${result.mismatches.length} mismatches found`, {
+                        mismatches: result.mismatches.map((m) => `${m.table}: ${m.issue}`),
+                    });
+                }
+            }
+            else {
+                logger.error('Schema validation failed', undefined, {
+                    errors: result.errors,
+                });
+                if (result.errors) {
+                    result.errors.forEach((error) => {
+                        logger.error('Validation error', undefined, { error });
+                    });
+                }
+                process.exit(1);
+            }
+        })
+            .catch((error) => {
+            logger.error('Error during introspection', error instanceof Error ? error : new Error(String(error)));
+            process.exit(1);
+        });
+    }
+    else {
+        logger.info('Database introspection system');
+        logger.info('Usage: tsx introspect.ts --validate');
+        logger.info('Options: --validate    Validate schemas against database');
+        logger.info('Note: Full introspection requires database connection.');
+        logger.info('Set POSTGRES_URL or DATABASE_URL environment variable.');
+    }
+}
+//# sourceMappingURL=introspect.js.map

package/dist/types/introspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.js","sourceRoot":"","sources":["../../src/types/introspect.ts"],"names":[],"mappings":";AACA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAuB9C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,UAAgC,EAAE;IAElC,MAAM,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;IAEzC,6EAA6E;IAC7E,mDAAmD;IACnD,MAAM,gBAAgB,GACpB,kBAAkB,IAAI,OAAO;QAC3B,CAAC,CAAC,OAAO,CAAC,gBAAgB;QAC1B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;IAE1D,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,CAAC,yCAAyC,CAAC;SACpD,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,sBAAsB;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAElC,uDAAuD;QACvD,MAAM,QAAQ,GAAG,CAAC,MAAM,GAAG,CAAA;;;;;;KAM1B,CAAkC,CAAA;QAEnC,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAExD,uCAAuC;QACvC,MAAM,eAAe,GAAG,cAAc,EAAE,CAAA;QACxC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,eAAe,CAAA;QAChD,0DAA0D;QAC1D,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAS,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;QAE9E,MAAM,UAAU,GAA4C,EAAE,CAAA;QAE9D,IAAI,cAAc,EAAE,CAAC;YACnB,iDAAiD;YACjD,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;gBACjC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACnC,UAAU,CAAC,IAAI,CAAC;wBACd,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,oDAAoD;qBAC5D,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAED,iDAAiD;YACjD,uEAAuE;YACvE,KAAK,MAAM,WAAW,IAAI,gBAAgB,EAAE,CAAC;gBAC3C,wDAAwD;gBACxD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;oBACtC,UAAU,CAAC,IAAI,CAAC;wBACd,KAAK,EAAE,WAAW;wBAClB,KAAK,EAAE,qDAAqD;qBAC7D,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAwB;YAClC,OAAO,EAAE,UAAU,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,EAAE,UAAU;SACnB,CAAA;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,UAAU,GAAG,UAAU,CAAA;QAChC,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,EAAE;YACV,MAAM,EAAE;gBACN,kCAAkC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;aAC3F;SACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,gBAAwB,EACxB,UAAkB;IAElB,KAAK,gBAAgB,CAAA;IACrB,KAAK,UAAU,CAAA;IACf,MAAM,IAAI,KAAK,CACb,8DAA8D;QAC5D,6DAA6D;QAC7D,gDAAgD,CACnD,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,gBAAwB;IAIhE,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC;QACtC,gBAAgB;QAChB,cAAc,EAAE,IAAI;KACrB,CAAC,CAAA;IAEF,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE;KACpC,CAAA;AACH,CAAC;AAED,gBAAgB;AAChB,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,UAAU,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClC,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;IAE7E,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CACV,+DAA+D,EAC/D,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAChD,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,kBAAkB,CAAC,EAAE,gBAAgB,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;aAC3D,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE;oBACtC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;oBACjC,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,IAAI,CAAC;iBAC3C,CAAC,CAAA;gBACF,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtD,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,mBAAmB,EAAE;wBAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;qBACnE,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,SAAS,EAAE;oBAClD,MAAM,EAAE,MAAM,CAAC,MAAM;iBACtB,CAAC,CAAA;gBACF,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBAClB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC9B,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;oBACxD,CAAC,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CAAC,KAAK,CACV,4BAA4B,EAC5B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;IACN,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC5C,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAA;QAClD,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAA;QACvE,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAA;QACrE,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAA;IACvE,CAAC;AACH,CAAC"}