kinetic-sql 1.0.2 → 1.0.4

package/README.md

@@ -19,14 +19,14 @@ Kinetic SQL is a next-gen Node.js client that wraps **PostgreSQL** and **MySQL**
 ### 1. Install
 
 ```bash
-
-# For PostgreSQL
-
+# For PostgreSQL:
 npm install kinetic-sql drizzle-orm postgres
 
-# For MySQL
-
+# For MySQL:
 npm install kinetic-sql drizzle-orm mysql2 @rodrigogs/mysql-events
+
+# For SQLite (Local Dev / Edge):
+npm install kinetic-sql better-sqlite3
 ```
 
 ### 2. Initialize
@@ -34,12 +34,19 @@ npm install kinetic-sql drizzle-orm mysql2 @rodrigogs/mysql-events
 ```typescript
 import { KineticClient } from 'kinetic-sql';
 
-// Connects using your DATABASE_URL env var by default
+/* PostgreSQL/MySQL Example */
+/* Connects using your DATABASE_URL env var by default */
 const db = await KineticClient.create({
 type: 'pg', // or 'mysql'
 connectionString: process.env.DATABASE_URL,
 realtimeEnabled: true
 });
+
+/* SQLite Example */
+const db = await KineticClient.create({
+  type: 'sqlite',
+  filename: './dev.db'
+});
 ```
 
 ### 3. Generate Types (The Magic)
@@ -47,14 +54,16 @@ realtimeEnabled: true
 Run this command in your terminal. It reads your DB and patches the library automatically.
 
 ```bash
-
 # PostgreSQL (Default)
-
 npx k-sql gen --connection "postgres://..."
+OR
+npx k-sql gen --type pg --host localhost --user postgres --db mydb
 
 # MySQL
-
 npx k-sql gen --type mysql --host localhost --user root --db mydb
+
+# SQLite
+npx k-sql gen --type sqlite --db ./dev.db
 ```
 
 ---
@@ -66,7 +75,7 @@ npx k-sql gen --type mysql --host localhost --user root --db mydb
 #### Listen to database events without setting up WebSockets.
 
 ```typescript
-// 'tasks' is auto-completed!
+/* 'tasks' is auto-completed! */
 const sub = await db.subscribe('tasks', (event) => {
 console.log(event.action); // 'INSERT' | 'UPDATE'
 console.log(event.data.title); // Typed!
@@ -81,11 +90,12 @@ await sub.unsubscribe();
 #### Call stored procedures as native JS methods.
 
 ```typescript
-// 'add_todo' is auto-completed!
-const { data, error } = await db.rpc('add_todo', {
-p_title: "Build cool app", // Param names are checked!
-p_user_id: 123
-});
+/* 'add_todo' is auto-completed! */
+const { data, error } = await db.rpc(
+    'add_todo',
+    /* Param names are checked! */
+    { p_title: "Build cool app",  p_user_id: 123 }
+);
 ```
 
 ### Standard Queries (via Drizzle) ✨
@@ -106,7 +116,6 @@ const users = await db.orm
 ## ⚙️ Configuration
 
 ### PostgreSQL
-
 ```typescript
 const db = await KineticClient.create({
 type: 'pg',
@@ -120,7 +129,6 @@ realtimeEnabled: true
 ```
 
 ### MySQL
-
 ```typescript
 const db = await KineticClient.create({
 type: 'mysql',
@@ -133,12 +141,20 @@ realtimeEnabled: true // Requires Binary Logging enabled on server
 });
 ```
 
+### SQLite
+```typescript
+const db = await KineticClient.create({
+  type: 'sqlite',
+  filename: './prisma/dev.db' // Path to your file
+});
+```
+
 ## ⚠️ Requirements
 
 - **Node.js:** 18+
 - **PostgreSQL:** 12+ (Native `LISTEN/NOTIFY` used)
-- **MySQL:** 5.7+
-    - *Note:* For Realtime features, your MySQL server must have **Binary Logging** enabled (`log_bin = ON`).
+- **MySQL:** 5.7+ (Requires Binary Logging Enabled i.e. ` log_bin = ON ` for Realtime features)
+- **SQLite:** 3+ (Bundled with `better-sqlite3`)
 
 ## 📄 License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kinetic-sql",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Zero-config, type-safe Postgres & MySQL client with Realtime subscriptions.",
   "type": "module",
   "main": "./dist/index.js",
@@ -9,7 +9,8 @@
     "build": "tsup",
     "prepublishOnly": "npm run build",
     "dev": "tsup --watch",
-    "gen": "node dist/cli/generate.cjs"
+    "gen": "node dist/cli/generate.cjs",
+    "postinstall": "node scripts/postinstall.js"
   },
   "exports": {
     ".": {
@@ -23,6 +24,7 @@
   },
   "files": [
     "dist",
+    "scripts",
     "README.md",
     "LICENSE"
   ],

package/scripts/postinstall.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+// ANSI Color Codes for the "Bling"
+const RESET = "\x1b[0m";
+const BRIGHT = "\x1b[1m";
+const DIM = "\x1b[2m";
+const CYAN = "\x1b[36m";
+const GREEN = "\x1b[32m";
+const YELLOW = "\x1b[33m";
+const MAGENTA = "\x1b[35m";
+const WHITE = "\x1b[37m";
+
+const banner = `
+${ CYAN }${ BRIGHT }
+  _  __ _            _   _        ${ MAGENTA } ____   ___  _     
+${ CYAN } | |/ /(_)          | | (_)       ${ MAGENTA }/ ___| / _ \\| |    
+${ CYAN } | ' /  _ _ __   ___| |_ _  ___   ${ MAGENTA }\\___ \\| | | | |    
+${ CYAN } |  <  | | '_ \\ / _ \\ __| |/ __|   ${ MAGENTA }___) | |_| | |___ 
+${ CYAN } | . \\ | | | | |  __/ |_| | (__   ${ MAGENTA }|____/ \\__\\_\\_____|
+${ CYAN } |_|\\_\\|_|_| |_|\\___|\\__|_|\\___|  ${ RESET }
+`;
+
+console.log(banner);
+console.log(`${ GREEN }${ BRIGHT } Package successfully Installed ✨${ RESET }\n`);
+
+console.log(`${ WHITE }Please auto generate the schema using the following commands:${ RESET }\n`);
+
+console.log(`${ YELLOW }# PostgreSQL (Default)${ RESET }`);
+console.log(`  ${ DIM }npx k-sql gen --connection "{CONNECTION_URL}"${ RESET }`);
+console.log(`  ${ DIM }OR${ RESET }`);
+console.log(`  ${ DIM }npx k-sql gen --type pg --host localhost --user postgres --db mydb${ RESET }\n`);
+
+console.log(`${ YELLOW }# MySQL${ RESET }`);
+console.log(`  ${ DIM }npx k-sql gen --type mysql --host localhost --user root --db mydb${ RESET }\n`);
+
+console.log(`${ YELLOW }# SQLite${ RESET }`);
+console.log(`  ${ DIM }npx k-sql gen --type sqlite --db ./dev.db${ RESET }\n`);
+
+console.log(`${ DIM }-----------------------------------------------------------${ RESET }`);
+console.log(`${ CYAN }Thanks for installing Kinetic-SQL 🙏${ RESET }`);
+console.log(`${ WHITE }Please consider donating to our open collective to help me`);
+console.log(`maintain this package and others that I am working on constantly.${ RESET }`);
+console.log(`${ MAGENTA }🍻 Donate: https://opencollective.com/kinetic-ai ${ RESET }`);
+console.log(`${ DIM }-----------------------------------------------------------${ RESET }\n`);