openbase-js 0.1.7 → 0.1.9

package/index.js

@@ -1,11 +1,13 @@
 // ─── Query Builder ────────────────────────────────────────────────────────────
 
 class QueryBuilder {
-  constructor(baseUrl, apiKey, dbName, table) {
+  constructor(baseUrl, apiKey, dbName, table, anonKey, sessionToken = null) {
     this._baseUrl = baseUrl;
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
+    this._anonKey = anonKey;
+    this._sessionToken = sessionToken;
     this._filters = [];
     this._columns = '*';
     this._limitVal = null;
@@ -27,7 +29,7 @@ class QueryBuilder {
   on(event, callback) {
     if (!this._realtimeSub) {
       this._realtimeSub = new RealtimeSubscription(
-        this._baseUrl, this._apiKey, this._dbName, this._table
+        this._baseUrl, this._apiKey, this._dbName, this._table, this._anonKey
       );
     }
     this._realtimeSub.on(event, callback);
@@ -37,7 +39,7 @@ class QueryBuilder {
   subscribe() {
     if (!this._realtimeSub) {
       this._realtimeSub = new RealtimeSubscription(
-        this._baseUrl, this._apiKey, this._dbName, this._table
+        this._baseUrl, this._apiKey, this._dbName, this._table, this._anonKey
       );
     }
     return this._realtimeSub.subscribe();
@@ -134,117 +136,154 @@ class QueryBuilder {
     return this;
   }
 
-  // ─── SQL Builder ───────────────────────────────────────────────────────────
-
-  _filterToSQL(f) {
-    const col = `"${f.col}"`;
-    switch (f.op) {
-      case 'eq': return typeof f.val === 'string' ? `${col} = '${f.val}'` : `${col} = ${f.val}`;
-      case 'gt': return `${col} > ${f.val}`;
-      case 'lt': return `${col} < ${f.val}`;
-      case 'gte': return `${col} >= ${f.val}`;
-      case 'lte': return `${col} <= ${f.val}`;
-      case 'like': return `${col} LIKE '${f.val}'`;
-      case 'ilike': return `${col} ILIKE '${f.val}'`;
-      case 'in': {
-        const list = f.val.map(v => typeof v === 'string' ? `'${v}'` : v).join(', ');
-        return `${col} IN (${list})`;
-      }
-      case 'is': {
-        if (f.val === null) return `${col} IS NULL`;
-        if (f.val === true) return `${col} IS TRUE`;
-        if (f.val === false) return `${col} IS FALSE`;
-        return `${col} IS NULL`;
-      }
-      default: return `${col} = '${f.val}'`;
-    }
+  upsert(data, onConflict = 'id') {
+    this._operation = 'upsert';
+    this._insertData = data;
+    this._upsertOnConflict = onConflict;
+    return this;
   }
 
-  _buildSQL() {
-    let sql = '';
+  // ─── Executor ──────────────────────────────────────────────────────────────
 
-    if (this._operation === 'select') {
-      sql = `SELECT ${this._columns} FROM "${this._table}"`;
-      if (this._filters.length) {
-        const where = this._filters.map(f => this._filterToSQL(f)).join(' AND ');
-        sql += ` WHERE ${where}`;
-      }
-      if (this._orderCol) {
-        sql += ` ORDER BY "${this._orderCol}" ${this._orderAsc ? 'ASC' : 'DESC'}`;
-      }
-      if (this._limitVal) sql += ` LIMIT ${this._limitVal}`;
-      if (this._offsetVal) sql += ` OFFSET ${this._offsetVal}`;
-
-    } else if (this._operation === 'insert') {
-      const cols = Object.keys(this._insertData).map(c => `"${c}"`).join(', ');
-      const vals = Object.values(this._insertData).map(v =>
-        typeof v === 'string' ? `'${v.replace(/'/g, "''")}'` : v
-      ).join(', ');
-      sql = `INSERT INTO "${this._table}" (${cols}) VALUES (${vals}) RETURNING *`;
-
-    } else if (this._operation === 'update') {
-      const setClauses = Object.entries(this._updateData).map(([col, val]) =>
-        typeof val === 'string' ? `"${col}" = '${val.replace(/'/g, "''")}'` : `"${col}" = ${val}`
-      ).join(', ');
-      sql = `UPDATE "${this._table}" SET ${setClauses}`;
-      if (this._filters.length) {
-        const where = this._filters.map(f => this._filterToSQL(f)).join(' AND ');
-        sql += ` WHERE ${where}`;
+  async _buildAndRun() {
+    try {
+      const headers = {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${this._apiKey}`,
+        'X-Anon-Key': this._anonKey,
+      };
+
+      // If we have an active end-user session, use its token instead of the anon key
+      if (this._sessionToken) {
+        headers['Authorization'] = `Bearer ${this._sessionToken}`;
       }
-      sql += ` RETURNING *`;
 
-    } else if (this._operation === 'delete') {
-      sql = `DELETE FROM "${this._table}"`;
-      if (this._filters.length) {
-        const where = this._filters.map(f => this._filterToSQL(f)).join(' AND ');
-        sql += ` WHERE ${where}`;
-      }
-      sql += ` RETURNING *`;
+      const body = {
+        db_name: this._dbName,
+        table: this._table,
+        operation: this._operation,
+        columns: this._columns,
+        filters: this._filters,
+        limit: this._limitVal,
+        offset: this._offsetVal,
+        order_col: this._orderCol,
+        order_asc: this._orderAsc,
+        data: (this._operation === 'insert' || this._operation === 'upsert') ? this._insertData : this._updateData,
+        upsert_on_conflict: this._upsertOnConflict
+      };
+
+      const res = await fetch(`${this._baseUrl}/sdk/query`, {
+        method: 'POST',
+        headers,
+        body: JSON.stringify(body),
+      });
+
+      const json = await res.json();
+      const { data, error } = json;
+      if (error) return { data: null, error };
+      if (this._single) return { data: data[0] || null, error: null };
+      return { data, error: null };
+    } catch (err) {
+      return { data: null, error: err.message };
     }
+  }
 
-    return sql;
+  then(resolve, reject) {
+    return this._buildAndRun().then(resolve, reject);
   }
+}
 
-  // ─── Executor ──────────────────────────────────────────────────────────────
+// ─── Auth Client ───────────────────────────────────────────────────────────────
 
-  async _buildAndRun() {
-    const sql = this._buildSQL();
+class AuthClient {
+  constructor(client) {
+    this._client = client;
+  }
+
+  async signUp(email, password) {
     try {
-      const res = await fetch(`${this._baseUrl}/query`, {
+      const res = await fetch(`${this._client._baseUrl}/sdk/auth/signup`, {
         method: 'POST',
         headers: {
           'Content-Type': 'application/json',
-          'Authorization': `Bearer ${this._apiKey}`,
+          'Authorization': `Bearer ${this._client._apiKey}`
         },
-        body: JSON.stringify({ sql, db_name: this._dbName }),
+        body: JSON.stringify({
+          db_name: this._client._dbName,
+          email,
+          password
+        }),
       });
+      const json = await res.json();
+      if (json.data && json.data.session) {
+        this._client._session = json.data.session;
+      }
+      return json;
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
 
+  async signIn(email, password) {
+    try {
+      const res = await fetch(`${this._client._baseUrl}/sdk/auth/signin`, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': `Bearer ${this._client._apiKey}`
+        },
+        body: JSON.stringify({
+          db_name: this._client._dbName,
+          email,
+          password
+        }),
+      });
       const json = await res.json();
-      const { data, error } = json;
-      if (error) return { data: null, error };
-      if (this._single) return { data: data[0] || null, error: null };
-      return { data, error: null };
+      if (json.data && json.data.session) {
+        this._client._session = json.data.session;
+      }
+      return json;
     } catch (err) {
       return { data: null, error: err.message };
     }
   }
 
-  then(resolve, reject) {
-    return this._buildAndRun().then(resolve, reject);
+  async getSession() {
+    if (!this._client._session) return { data: null, error: null };
+    try {
+      const res = await fetch(`${this._client._baseUrl}/sdk/auth/session`, {
+        headers: {
+          'Authorization': `Bearer ${this._client._session.access_token}`
+        }
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  signOut() {
+    this._client._session = null;
+    return { data: { ok: true }, error: null };
   }
 }
 
 // ─── Storage Client ───────────────────────────────────────────────────────────
 
 class StorageClient {
-  constructor(baseUrl, apiKey, dbName) {
-    this._baseUrl = baseUrl;
-    this._apiKey = apiKey;
-    this._dbName = dbName;
+  constructor(client) {
+    this._client = client;
   }
 
   _headers() {
-    return { 'Authorization': `Bearer ${this._apiKey}` };
+    const headers = { 
+      'Authorization': `Bearer ${this._client._apiKey}`,
+      'X-Anon-Key': this._client._anonKey
+    };
+    if (this._client._session) {
+      headers['Authorization'] = `Bearer ${this._client._session.access_token}`;
+    }
+    return headers;
   }
 
   // Detect if we're running in Node.js
@@ -253,8 +292,6 @@ class StorageClient {
   }
 
   // Build a FormData object that works in both browser and Node.js
-  // In browser: file = File or Blob object
-  // In Node.js: file = file path string, Buffer, or ReadStream
   async _buildFormData(file, filename) {
     if (this._isNode()) {
       // Node.js — use form-data package
@@ -273,14 +310,11 @@ class StorageClient {
       const formData = new FormDataNode();
 
       if (typeof file === 'string') {
-        // file path string — read from disk
         const resolvedName = filename || path.basename(file);
         formData.append('file', fs.createReadStream(file), resolvedName);
       } else if (Buffer.isBuffer(file)) {
-        // Buffer
         formData.append('file', file, filename || 'file');
       } else {
-        // ReadStream or anything else
         formData.append('file', file, filename || 'file');
       }
 
@@ -294,14 +328,10 @@ class StorageClient {
     }
   }
 
-  // Upload a file
-  // Browser: pass a File or Blob (from <input type="file"> or drag-and-drop)
-  // Node.js: pass a file path string, Buffer, or ReadStream
   async upload(file, filename) {
     try {
       const formData = await this._buildFormData(file, filename);
 
-      // In Node.js, form-data needs its own headers (includes boundary)
       const headers = this._isNode()
         ? { ...this._headers(), ...formData.getHeaders() }
         : this._headers();
@@ -317,7 +347,6 @@ class StorageClient {
     }
   }
 
-  // List all files in this project's bucket
   async list() {
     try {
       const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/list`, {
@@ -329,7 +358,6 @@ class StorageClient {
     }
   }
 
-  // Get a presigned URL valid for 7 days
   async getUrl(filename) {
     try {
       const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/url/${encodeURIComponent(filename)}`, {
@@ -341,7 +369,6 @@ class StorageClient {
     }
   }
 
-  // Delete a file
   async remove(filename) {
     try {
       const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/${encodeURIComponent(filename)}`, {
@@ -358,12 +385,13 @@ class StorageClient {
 // ─── Realtime Subscription ────────────────────────────────────────────────────
 
 class RealtimeSubscription {
-  constructor(baseUrl, apiKey, dbName, table) {
+  constructor(baseUrl, apiKey, dbName, table, anonKey) {
     this._baseUrl = baseUrl.replace('http://', 'ws://').replace('https://', 'wss://');
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
-    this._listeners = {}; // { INSERT: [fn], UPDATE: [fn], DELETE: [fn] }
+    this._anonKey = anonKey;
+    this._listeners = {}; 
     this._ws = null;
   }
 
@@ -374,7 +402,7 @@ class RealtimeSubscription {
   }
 
   subscribe() {
-    const url = `${this._baseUrl}/realtime/${this._dbName}/${this._table}?token=${this._apiKey}`;
+    const url = `${this._baseUrl}/realtime/${this._dbName}/${this._table}?token=${this._apiKey}&anon_key=${this._anonKey}`;
     this._ws = new WebSocket(url);
 
     this._ws.onmessage = (e) => {
@@ -404,25 +432,35 @@ class RealtimeSubscription {
 // ─── Client ───────────────────────────────────────────────────────────────────
 
 class OpenbaseClient {
-  constructor(baseUrl, apiKey, dbName) {
+  constructor(baseUrl, apiKey, dbName, options = {}) {
     this._baseUrl = baseUrl.replace(/\/$/, '');
     this._apiKey = apiKey;
     this._dbName = dbName;
-    this.storage = new StorageClient(this._baseUrl, this._apiKey, this._dbName);
+    this._anonKey = options.anonKey || apiKey; // Default to apiKey if anonKey not provided
+    this._session = null;
+    this.storage = new StorageClient(this);
+    this.auth = new AuthClient(this);
   }
 
   from(table) {
-    return new QueryBuilder(this._baseUrl, this._apiKey, this._dbName, table);
+    return new QueryBuilder(
+      this._baseUrl, 
+      this._apiKey, 
+      this._dbName, 
+      table, 
+      this._anonKey,
+      this._session ? this._session.access_token : null
+    );
   }
 }
 
 // ─── Factory ──────────────────────────────────────────────────────────────────
 
-function createClient(baseUrl, apiKey, dbName) {
-  if (!baseUrl) throw new Error('[openbase] Missing baseUrl. Pass your backend URL as the first argument.');
-  if (!apiKey) throw new Error('[openbase] Missing apiKey. Pass your anon or service key as the second argument.');
-  if (!dbName) throw new Error('[openbase] Missing dbName. Pass your database name as the third argument.');
-  return new OpenbaseClient(baseUrl, apiKey, dbName);
+function createClient(baseUrl, apiKey, dbName, options = {}) {
+  if (!baseUrl) throw new Error('[openbase] Missing baseUrl.');
+  if (!apiKey) throw new Error('[openbase] Missing apiKey.');
+  if (!dbName) throw new Error('[openbase] Missing dbName.');
+  return new OpenbaseClient(baseUrl, apiKey, dbName, options);
 }
 
 if (typeof module !== 'undefined') {
@@ -431,4 +469,4 @@ if (typeof module !== 'undefined') {
 
 if (typeof window !== 'undefined') {
   window.openbase = { createClient };
-}
+}

package/openbase_readme.md

@@ -0,0 +1,115 @@
+# OpenBase
+
+OpenBase is an open-source, lightweight alternative to Supabase, designed for rapid development with a focus on PostgreSQL and S3-compatible storage (MinIO). It provides a unified dashboard for managing projects, databases, storage, and monitoring.
+
+## 🚀 Key Features
+
+- **Project Management**: Easily create and manage multiple isolated projects.
+- **Dynamic Database API**: Auto-generated RESTful API for PostgreSQL databases using a custom FastAPI backend.
+- **Integrated S3 Storage**: Built-in file storage powered by MinIO, with project-level isolation.
+- **SQL Editor**: Execute SQL queries directly from the dashboard.
+- **Monitoring & Logs**: Real-time container monitoring and log streaming.
+- **OpenBase SDK**: A lightweight JavaScript/TypeScript SDK for seamless integration into your applications.
+
+## 🏗️ Architecture
+
+OpenBase is composed of several microservices coordinated via Docker Compose:
+
+```mermaid
+graph TD
+    User([User/Developer]) --> Dashboard[React Dashboard :3001]
+    Dashboard --> Backend[FastAPI Backend :3003]
+    Backend --> Postgres[PostgreSQL :5433]
+    Backend --> MinIO[MinIO Storage :9002/9003]
+    Backend --> Docker[Docker Socket]
+    
+    App[Your Application] --> SDK[OpenBase SDK]
+    SDK --> Backend
+```
+
+### Services Breakdown:
+- **Dashboard**: React-based UI for project management.
+- **Backend**: FastAPI service handling project creation, database queries, storage management, and log streaming.
+- **PostgreSQL**: Stores both metadata and project-specific data.
+- **MinIO**: S3-compatible object storage.
+
+## 🚦 Getting Started
+
+### Prerequisites
+- [Docker](https://www.docker.com/get-started) and [Docker Compose](https://docs.docker.com/compose/install/)
+
+### Local Setup with Docker (Recommended)
+
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/omkar1344patil/openbase.git
+   cd openbase
+   ```
+
+2. **Configure Environment**:
+   Copy the example environment file (if available) or create a `.env` in the root with your configuration.
+   ```bash
+   cp .env.example .env
+   ```
+
+3. **Start the services**:
+   ```bash
+   docker compose up --build
+   ```
+
+4. **Access the Dashboard**:
+   Open [http://localhost:3001](http://localhost:3001) in your browser.
+
+### Development Setup
+
+If you wish to run services individually:
+
+- **Backend**:
+  ```bash
+  cd dashboard-backend
+  pip install -r requirements.txt
+  python main.py
+  ```
+- **Dashboard**:
+  ```bash
+  cd dashboard
+  npm install
+  npm start
+  ```
+
+## ⚙️ Environment Variables
+
+Critical environment variables required for the project (defined in `.env`):
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `POSTGRES_USER` | Admin username for PostgreSQL | `postgres` |
+| `POSTGRES_PASSWORD` | Admin password for PostgreSQL | - |
+| `MINIO_ROOT_USER` | Admin username for MinIO | `minioadmin` |
+| `MINIO_ROOT_PASSWORD` | Admin password for MinIO | `minioadmin` |
+| `ANON_KEY` | Public API key for projects | - |
+| `SERVICE_KEY` | Admin service key | - |
+
+## 🧠 Context for AI Agents
+
+OpenBase is designed with a specific philosophy:
+- **PostgREST-like Patterns**: While not using PostgREST directly for all queries, the API follows similar conventions for database interaction.
+- **Project Isolation**: Each project created through the dashboard results in a dedicated PostgreSQL database and a MinIO bucket.
+- **Unified Gateway**: The FastAPI backend acts as the single point of entry for both the dashboard and external applications using the SDK.
+
+### Common Development Tasks:
+- **Adding SDK Operators**: Update the `openbase-js` client logic to support new SQL operators (e.g., `.gt()`, `.like()`).
+- **Extending Monitoring**: Modify `Monitoring.tsx` in the frontend and the corresponding `/monitoring` endpoints in the backend.
+- **Storage Fixes**: Ensure `MINIO_PUBLIC_HOST` is correctly handled for pre-signed URLs to work across both Docker and local environments.
+
+## 🛠️ Tech Stack
+
+- **Frontend**: React, TypeScript, Tailwind CSS, Lucide Icons, Recharts.
+- **Backend**: Python, FastAPI, Motor (PyMongo - if applicable), Miniopy-async, Psycopg2.
+- **Storage**: MinIO (S3-compatible).
+- **Database**: PostgreSQL 16.
+- **Orchestration**: Docker Compose.
+
+---
+
+Built with ❤️ by [Omkar Patil](https://github.com/omkar1344patil)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openbase-js",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "JavaScript client for Openbase — a self-hosted Supabase alternative",
   "main": "index.js",
   "types": "index.d.ts",