flashorm 2.0.8 → 2.1.0

package/README.md

@@ -17,14 +17,14 @@ A powerful, database-agnostic migration CLI tool built in Go with multi-database
 
 ## 📊 Performance
 
-| Operation | FlashORM | Drizzle | Prisma |
-|-----------|-------|---------|--------|
-| Insert 1000 Users | **158ms** | 224ms | 230ms |
-| Insert 10 Cat + 5K Posts + 15K Comments | **2410ms** | 3028ms | 3977ms |
-| Complex Query x500 | **4071ms** | 12500ms | 56322ms |
-| Mixed Workload x1000 (75% read, 25% write) | **186ms** | 1174ms | 10863ms |
-| Stress Test Simple Query x2000 | **122ms** | 160ms | 223ms |
-| **TOTAL** | **6947ms** | **17149ms** | **71551ms** |
+| Operation                                  | FlashORM   | Drizzle     | Prisma      |
+| ------------------------------------------ | ---------- | ----------- | ----------- |
+| Insert 1000 Users                          | **149ms**  | 224ms       | 230ms       |
+| Insert 10 Cat + 5K Posts + 15K Comments    | **2410ms** | 3028ms      | 3977ms      |
+| Complex Query x500                         | **3156ms** | 12500ms     | 56322ms     |
+| Mixed Workload x1000 (75% read, 25% write) | **186ms**  | 1174ms      | 10863ms     |
+| Stress Test Simple Query x2000             | **79ms**   | 160ms       | 118ms       |
+| **TOTAL**                                  | **5980ms** | **17149ms** | **71510ms** |
 
 ## 🚀 Installation
 
@@ -41,6 +41,7 @@ bun pm trust flashorm
 ```
 
 Or add to your `package.json`:
+
 ```json
 {
   "trustedDependencies": ["flashorm"]
@@ -56,6 +57,7 @@ flash init --postgresql  # or --mysql, --sqlite
 ```
 
 This creates:
+
 ```
 your-project/
 ├── flash.config.json
@@ -77,6 +79,7 @@ DATABASE_URL=postgresql://user:password@localhost:5432/mydb
 ### 3. Define Schema
 
 **db/schema/schema.sql**
+
 ```sql
 CREATE TABLE users (
     id SERIAL PRIMARY KEY,
@@ -90,6 +93,7 @@ CREATE TABLE users (
 ### 4. Write Queries
 
 **db/queries/users.sql**
+
 ```sql
 -- name: GetUser :one
 SELECT id, name, email, created_at, updated_at FROM users
@@ -133,6 +137,7 @@ flash gen
 ```
 
 **Generated Types (flash_gen/index.d.ts)**
+
 ```typescript
 // Code generated by FlashORM. DO NOT EDIT.
 
@@ -168,41 +173,48 @@ export function New(db: any): Queries;
 ### 8. Use in Your Code
 
 **index.ts**
+
 ```typescript
-import { Pool } from 'pg';
-import { New } from './flash_gen/database';
+import { Pool } from "pg";
+import { New } from "./flash_gen/database";
 
-const DATABASE_URL = process.env.DATABASE_URL || 'postgresql://postgres:postgres@localhost:5432/mydb';
+const DATABASE_URL =
+  process.env.DATABASE_URL ||
+  "postgresql://postgres:postgres@localhost:5432/mydb";
 
 async function main() {
-    const pool = new Pool({
-        connectionString: DATABASE_URL,
-    });
-    
-    const db = New(pool);
-    
-    // Create user - fully type-safe!
-    const newUser = await db.createUser('Alice', 'alice@example.com');
-    console.log('New user:', newUser);
-    
-    // Get user by ID
-    const user = await db.getUser(newUser.id);
-    console.log('Found user:', user);
-    
-    // List all users
-    const users = await db.listUsers();
-    console.log('All users:', users);
-    
-    // Update user
-    const updated = await db.updateUser(newUser.id, 'Alice Smith', 'alice.smith@example.com');
-    console.log('Updated user:', updated);
-    
-    await pool.end();
+  const pool = new Pool({
+    connectionString: DATABASE_URL,
+  });
+
+  const db = New(pool);
+
+  // Create user - fully type-safe!
+  const newUser = await db.createUser("Alice", "alice@example.com");
+  console.log("New user:", newUser);
+
+  // Get user by ID
+  const user = await db.getUser(newUser.id);
+  console.log("Found user:", user);
+
+  // List all users
+  const users = await db.listUsers();
+  console.log("All users:", users);
+
+  // Update user
+  const updated = await db.updateUser(
+    newUser.id,
+    "Alice Smith",
+    "alice.smith@example.com"
+  );
+  console.log("Updated user:", updated);
+
+  await pool.end();
 }
 
 main().catch((err) => {
-    console.error('Error:', err);
-    process.exit(1);
+  console.error("Error:", err);
+  process.exit(1);
 });
 ```
 
@@ -225,6 +237,7 @@ flash studio --browser=false
 ```
 
 **Studio Features:**
+
 - 📊 **Data Browser**: View and edit table data with inline editing
 - 💻 **SQL Editor**: Execute queries with CodeMirror syntax highlighting
 - 🎨 **Schema Visualization**: Interactive database diagram with React + ReactFlow
@@ -333,6 +346,7 @@ flash <command> --help
 ## ⚙️ Configuration
 
 **flash.config.json**
+
 ```json
 {
   "version": "2",
@@ -346,7 +360,7 @@ flash <command> --help
   },
   "gen": {
     "js": {
-      "enabled": true,
+      "enabled": true
     }
   }
 }
@@ -355,6 +369,7 @@ flash <command> --help
 ## 🎨 PostgreSQL ENUM Support
 
 **Schema with ENUMs**
+
 ```sql
 CREATE TYPE user_role AS ENUM ('admin', 'user', 'guest');
 
@@ -366,6 +381,7 @@ CREATE TABLE users (
 ```
 
 **Query with ENUM**
+
 ```sql
 -- name: GetUsersByRole :many
 SELECT id, name, role FROM users
@@ -373,8 +389,9 @@ WHERE role = $1;
 ```
 
 **Generated TypeScript**
+
 ```typescript
-export type UserRole = 'admin' | 'user' | 'guest';
+export type UserRole = "admin" | "user" | "guest";
 
 export interface Users {
   id: number | null;
@@ -398,6 +415,7 @@ $ flash apply
 ```
 
 If a migration fails:
+
 ```bash
 ❌ Failed at migration: 20251103_bad_migration
    Error: syntax error at or near "INVALID"
@@ -423,31 +441,35 @@ Create export before applying? (y/n): y
 ## 📤 Export Formats
 
 ### JSON Export
+
 ```bash
 flash export --json
 ```
+
 ```json
 {
   "timestamp": "2025-11-03 16:30:00",
   "version": "1.0",
   "tables": {
-    "users": [
-      {"id": 1, "name": "Alice", "email": "alice@example.com"}
-    ]
+    "users": [{ "id": 1, "name": "Alice", "email": "alice@example.com" }]
   }
 }
 ```
 
 ### CSV Export
+
 ```bash
 flash export --csv
 ```
+
 Creates directory with individual CSV files per table.
 
 ### SQLite Export
+
 ```bash
 flash export --sqlite
 ```
+
 Creates portable `.db` file.
 
 ## 🎨 FlashORM Studio
@@ -463,6 +485,7 @@ Open http://localhost:5555 (or your custom port)
 **Features:**
 
 ### 1. Data Browser (`/`)
+
 - View all tables in sidebar
 - Click any table to view/edit data
 - Double-click cells for inline editing
@@ -472,6 +495,7 @@ Open http://localhost:5555 (or your custom port)
 - Foreign key hints
 
 ### 2. SQL Editor (`/sql`)
+
 - Execute custom SQL queries
 - CodeMirror editor with syntax highlighting
 - Press Ctrl+Enter to run queries
@@ -480,6 +504,7 @@ Open http://localhost:5555 (or your custom port)
 - Query history
 
 ### 3. Schema Visualization (`/schema`)
+
 - Interactive database diagram
 - React + ReactFlow rendering
 - Automatic layout with Dagre algorithm
@@ -489,6 +514,7 @@ Open http://localhost:5555 (or your custom port)
 - MiniMap for navigation
 
 **Tech Stack:**
+
 - Backend: Go Fiber v2.52.9
 - Frontend: React 18.2.0, ReactFlow 12.8.4, CodeMirror 5.65.2
 - All assets embedded in single binary
@@ -509,6 +535,7 @@ flash raw "SELECT COUNT(*) FROM orders"
 ```
 
 **Features:**
+
 - ✅ Beautiful table output for SELECT queries
 - ✅ Multi-statement execution
 - ✅ Transaction support
@@ -516,6 +543,7 @@ flash raw "SELECT COUNT(*) FROM orders"
 - ✅ Formatted error messages
 
 **Example Output:**
+
 ```bash
 $ flash raw -q "SELECT id, name, email FROM users LIMIT 3"
 
@@ -537,13 +565,13 @@ $ flash raw -q "SELECT id, name, email FROM users LIMIT 3"
 ## 🔧 Programmatic API
 
 ```javascript
-const flash = require('flashorm');
+const flash = require("flashorm");
 
 // Execute commands
-flash.exec('status');
+flash.exec("status");
 flash.exec('migrate "add users"');
-flash.exec('apply');
-flash.exec('studio'); // Launch Studio
+flash.exec("apply");
+flash.exec("studio"); // Launch Studio
 
 // Get binary path
 const binaryPath = flash.getBinaryPath();
@@ -552,6 +580,7 @@ const binaryPath = flash.getBinaryPath();
 ## 📚 Examples
 
 Check out complete examples:
+
 - [TypeScript Example](https://github.com/Lumos-Labs-HQ/flash/tree/main/example/ts)
 - [Go Example](https://github.com/Lumos-Labs-HQ/flash/tree/main/example/go)
 
@@ -576,6 +605,7 @@ Check your `DATABASE_URL` in `.env` file.
 ### Studio Not Loading
 
 Make sure port 5555 is not in use, or specify a different port:
+
 ```bash
 flash studio --port 3000
 ```
@@ -600,4 +630,4 @@ flash studio --port 3000
 
 MIT License - see [LICENSE](https://github.com/Lumos-Labs-HQ/flash/blob/main/LICENSE)
 
----
+---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flashorm",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "A powerful, database-agnostic migration CLI tool with multi-database support and type-safe code generation",
   "main": "index.js",
   "bin": {

package/scripts/install.js

@@ -4,7 +4,7 @@ const https = require('https');
 const fs = require('fs');
 const path = require('path');
 
-const VERSION = '2.0.8';
+const VERSION = '2.1.0';
 const REPO = 'Lumos-Labs-HQ/flash';
 
 const platform = process.platform;