openbase-js 0.1.7 → 0.1.8

package/README.md

@@ -0,0 +1,182 @@
+# OpenBase JS SDK
+
+The OpenBase JS SDK provides a lightweight, expressive interface for interacting with your OpenBase projects. It handles database queries (PostgreSQL), file storage (S3/MinIO), and realtime subscriptions via a simple, Supabase-like API.
+
+## 📦 Installation
+
+```bash
+npm install openbase-js
+# or
+yarn add openbase-js
+```
+
+> [!NOTE]  
+> If you are using Node.js for file uploads, you will also need `form-data`:  
+> `npm install form-data`
+
+## 🚀 Quick Start
+
+Initialize the client with your project URL, API key, and database name.
+
+```javascript
+const { createClient } = require('openbase-js');
+
+const openbase = createClient(
+  'http://localhost:3003', // The URL where your OpenBase backend is running
+  'your-anon-key',
+  'your-db-name'
+);
+
+// Fetch data
+async function getLeads() {
+  const { data, error } = await openbase
+    .from('leads')
+    .select('*')
+    .eq('status', 'active');
+  
+  if (error) console.error(error);
+  else console.log(data);
+}
+```
+
+---
+
+## 📊 Database Operations
+
+OpenBase uses a chainable query builder for database operations.
+
+### Basic CRUD
+
+#### Select
+```javascript
+const { data } = await openbase.from('users').select('id, username');
+```
+
+#### Insert
+```javascript
+const { data } = await openbase.from('users').insert({
+  username: 'jdoe',
+  email: 'john@example.com'
+});
+```
+
+#### Update
+```javascript
+const { data } = await openbase.from('users')
+  .update({ email: 'newemail@example.com' })
+  .eq('id', 1);
+```
+
+#### Delete
+```javascript
+const { data } = await openbase.from('users')
+  .delete()
+  .eq('id', 1);
+```
+
+### 🔍 Detailed Operator Guide
+
+Filtering is done using chainable operator methods.
+
+| Operator | Method | Description | Example |
+| :--- | :--- | :--- | :--- |
+| `==` | `.eq(col, val)` | Equal to | `.eq('name', 'Alice')` |
+| `>` | `.gt(col, val)` | Greater than | `.gt('age', 21)` |
+| `<` | `.lt(col, val)` | Less than | `.lt('score', 50)` |
+| `>=` | `.gte(col, val)` | Greater than or equal to | `.gte('price', 100)` |
+| `<=` | `.lte(col, val)` | Less than or equal to | `.lte('stock', 5)` |
+| `LIKE` | `.like(col, pattern)` | Case-sensitive pattern match | `.like('name', '%son%')` |
+| `ILIKE` | `.ilike(col, pattern)`| Case-insensitive pattern match | `.ilike('name', '%SON%')` |
+| `IN` | `.in(col, array)` | Contained in array | `.in('role', ['admin', 'mod'])` |
+| `IS` | `.is(col, value)` | Check for `null` or `boolean` | `.is('deleted_at', null)` |
+
+### 🛠️ Modifiers
+
+*   **`.order(column, { ascending: boolean })`**: Sort the results.
+*   **`.limit(count)`**: Limit the number of rows returned.
+*   **`.range(from, to)`**: Pagination (0-indexed, inclusive).
+*   **`.single()`**: Returns a single object instead of an array.
+
+```javascript
+const { data } = await openbase
+  .from('posts')
+  .select('*')
+  .gt('likes', 10)
+  .order('created_at', { ascending: false })
+  .range(0, 9) // First 10 items
+```
+
+---
+
+## 📁 Storage
+
+OpenBase provides built-in S3-compatible storage.
+
+### Uploading Files
+
+In the browser, you can pass a `File` or `Blob`. In Node.js, you can pass a file path, `Buffer`, or `ReadStream`.
+
+```javascript
+// Browser
+const file = event.target.files[0];
+const { data, error } = await openbase.storage.upload(file, 'profile.jpg');
+
+// Node.js (requires form-data)
+const { data, error } = await openbase.storage.upload('./local-image.png', 'remote-name.png');
+```
+
+### Listing & Managing Files
+
+```javascript
+// List all files in bucket
+const { data: files } = await openbase.storage.list();
+
+// Get a public presigned URL (valid for 7 days)
+const { data: { url } } = await openbase.storage.getUrl('profile.jpg');
+
+// Remove a file
+await openbase.storage.remove('profile.jpg');
+```
+
+---
+
+## 🔄 Realtime
+
+Subscribe to database changes using WebSockets.
+
+```javascript
+const subscription = openbase
+  .from('messages')
+  .on('INSERT', (payload) => {
+    console.log('New message:', payload.record);
+  })
+  .subscribe();
+
+// To stop listening
+// subscription.unsubscribe();
+```
+
+---
+
+## ⌨️ TypeScript Support
+
+The SDK is written with full TypeScript support. Types are automatically included.
+
+```typescript
+interface Lead {
+  id: number;
+  company_name: string;
+}
+
+const { data } = await openbase.from<Lead>('leads').select('*');
+// data is typed as Lead[] | null
+```
+
+---
+
+## 🧪 Testing
+
+To run the local tests:
+1. Ensure the OpenBase backend is running.
+2. Update the credentials in `test.js`.
+3. Run: `node test.js`

package/index.cjs

@@ -1,11 +1,12 @@
 // ─── Query Builder ────────────────────────────────────────────────────────────
 
 class QueryBuilder {
-  constructor(baseUrl, apiKey, dbName, table) {
+  constructor(baseUrl, apiKey, dbName, table, anonKey) {
     this._baseUrl = baseUrl;
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
+    this._anonKey = anonKey;
     this._filters = [];
     this._columns = '*';
     this._limitVal = null;
@@ -27,7 +28,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 +38,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();
@@ -215,6 +216,7 @@ class QueryBuilder {
         headers: {
           'Content-Type': 'application/json',
           'Authorization': `Bearer ${this._apiKey}`,
+          'X-Anon-Key': this._anonKey,
         },
         body: JSON.stringify({ sql, db_name: this._dbName }),
       });
@@ -237,14 +239,18 @@ class QueryBuilder {
 // ─── Storage Client ───────────────────────────────────────────────────────────
 
 class StorageClient {
-  constructor(baseUrl, apiKey, dbName) {
+  constructor(baseUrl, apiKey, dbName, anonKey) {
     this._baseUrl = baseUrl;
     this._apiKey = apiKey;
     this._dbName = dbName;
+    this._anonKey = anonKey;
   }
 
   _headers() {
-    return { 'Authorization': `Bearer ${this._apiKey}` };
+    return { 
+      'Authorization': `Bearer ${this._apiKey}`,
+      'X-Anon-Key': this._anonKey
+    };
   }
 
   // Detect if we're running in Node.js
@@ -253,8 +259,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 +277,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 +295,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 +314,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 +325,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 +336,6 @@ class StorageClient {
     }
   }
 
-  // Delete a file
   async remove(filename) {
     try {
       const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/${encodeURIComponent(filename)}`, {
@@ -358,12 +352,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 +369,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 +399,26 @@ 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;
+    this.storage = new StorageClient(this._baseUrl, this._apiKey, this._dbName, this._anonKey);
   }
 
   from(table) {
-    return new QueryBuilder(this._baseUrl, this._apiKey, this._dbName, table);
+    return new QueryBuilder(this._baseUrl, this._apiKey, this._dbName, table, this._anonKey);
   }
 }
 
 // ─── 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') {

package/index.d.ts

@@ -6,6 +6,14 @@ export interface OpenbaseResponse<T> {
   error: string | null;
 }
 
+export interface OpenbaseClientOptions {
+  /**
+   * The public Anon Key for your project. 
+   * If not provided, the 'apiKey' argument will be used as the project identifier.
+   */
+  anonKey?: string;
+}
+
 export declare class QueryBuilder<T = Record<string, unknown>> {
   // Column selection
   select(columns?: string): this;
@@ -98,7 +106,8 @@ export declare class OpenbaseClient {
 export declare function createClient(
   baseUrl: string,
   apiKey: string,
-  dbName: string
+  dbName: string,
+  options?: OpenbaseClientOptions
 ): OpenbaseClient;
 
 export declare class RealtimeSubscription {

package/index.js

@@ -1,11 +1,12 @@
 // ─── Query Builder ────────────────────────────────────────────────────────────
 
 class QueryBuilder {
-  constructor(baseUrl, apiKey, dbName, table) {
+  constructor(baseUrl, apiKey, dbName, table, anonKey) {
     this._baseUrl = baseUrl;
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
+    this._anonKey = anonKey;
     this._filters = [];
     this._columns = '*';
     this._limitVal = null;
@@ -27,7 +28,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 +38,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();
@@ -196,7 +197,7 @@ class QueryBuilder {
     } 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 ');
+        const where = this._filters.map(f => this._filters.map(f => this._filterToSQL(f)).join(' AND '));
         sql += ` WHERE ${where}`;
       }
       sql += ` RETURNING *`;
@@ -215,6 +216,7 @@ class QueryBuilder {
         headers: {
           'Content-Type': 'application/json',
           'Authorization': `Bearer ${this._apiKey}`,
+          'X-Anon-Key': this._anonKey,
         },
         body: JSON.stringify({ sql, db_name: this._dbName }),
       });
@@ -237,14 +239,18 @@ class QueryBuilder {
 // ─── Storage Client ───────────────────────────────────────────────────────────
 
 class StorageClient {
-  constructor(baseUrl, apiKey, dbName) {
+  constructor(baseUrl, apiKey, dbName, anonKey) {
     this._baseUrl = baseUrl;
     this._apiKey = apiKey;
     this._dbName = dbName;
+    this._anonKey = anonKey;
   }
 
   _headers() {
-    return { 'Authorization': `Bearer ${this._apiKey}` };
+    return { 
+      'Authorization': `Bearer ${this._apiKey}`,
+      'X-Anon-Key': this._anonKey
+    };
   }
 
   // Detect if we're running in Node.js
@@ -253,8 +259,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 +277,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 +295,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 +314,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 +325,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 +336,6 @@ class StorageClient {
     }
   }
 
-  // Delete a file
   async remove(filename) {
     try {
       const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/${encodeURIComponent(filename)}`, {
@@ -358,12 +352,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 +369,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 +399,26 @@ 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.storage = new StorageClient(this._baseUrl, this._apiKey, this._dbName, this._anonKey);
   }
 
   from(table) {
-    return new QueryBuilder(this._baseUrl, this._apiKey, this._dbName, table);
+    return new QueryBuilder(this._baseUrl, this._apiKey, this._dbName, table, this._anonKey);
   }
 }
 
 // ─── 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 +427,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.8",
   "description": "JavaScript client for Openbase — a self-hosted Supabase alternative",
   "main": "index.js",
   "types": "index.d.ts",

package/test.js

@@ -1,97 +1,115 @@
 const { createClient } = require('./index');
 
+/**
+ * Openbase Dual-Key Test
+ * 
+ * 1. Authorization Key (JWT or Service Key): Pass as 2nd argument.
+ * 2. Identity Key (Anon Key): Pass in the options object.
+ */
 const client = createClient(
-  'http://localhost:3002',
-  'Yur7U6O5DHzC7Sjtyx_tI7EYM6lpMBO_I9vWWrN4YdQ',  // replace with your actual anon key
-  'mydb'
+  'http://localhost:3003',
+  // In production, this would be your secret JWT
+  'eHUJV8pFtbCh76xiUALc1YMWslyN8QxZgYG5RKySsgE', 
+  'mydb',
+  { 
+    // This identifies your project to the backend
+    anonKey: 'Yur7U6O5DHzC7Sjtyx_tI7EYM6lpMBO_I9vWWrN4YdQ' 
+  }
 );
 
+// Existing employees: IDs 101–104, salaries 55000–80000
+
 async function test() {
   console.log('\n── SELECT all ──────────────────────');
-  const { data, error } = await client.from('leads').select('*');
+  const { data, error } = await client.from('employees').select('*');
   console.log('data:', data);
   console.log('error:', error);
 
   console.log('\n── SELECT with .eq ─────────────────');
   const { data: single } = await client
-    .from('leads')
-    .select('company_name, slug')
-    .eq('slug', 'google')
+    .from('employees')
+    .select('firstname, lastname')
+    .eq('employeeid', 101)
     .single();
   console.log('single:', single);
 
   console.log('\n── INSERT ──────────────────────────');
-  const { data: inserted } = await client.from('leads').insert({
-    company_name: 'Test Co',
-    slug: 'test-co',
-    custom_pitch: 'Hello from SDK',
+  const { data: inserted, error: insertErr } = await client.from('employees').insert({
+    employeeid: 999,
+    firstname: 'Test',
+    lastname: 'User',
+    hiredate: '2024-01-01',
+    salary: 50000,
   });
   console.log('inserted:', inserted);
+  console.log('insertErr:', insertErr);
 
   console.log('\n── UPDATE ──────────────────────────');
   const { data: updated } = await client
-    .from('leads')
-    .update({ custom_pitch: 'Updated via SDK' })
-    .eq('slug', 'test-co');
+    .from('employees')
+    .update({ salary: 60000 })
+    .eq('employeeid', 999);
   console.log('updated:', updated);
 
   console.log('\n── DELETE ──────────────────────────');
   const { data: deleted } = await client
-    .from('leads')
+    .from('employees')
     .delete()
-    .eq('slug', 'test-co');
+    .eq('employeeid', 999);
   console.log('deleted:', deleted);
 }
 
 async function testOperators() {
   console.log('\n── GT / LT ─────────────────────────');
-  const { data: gt } = await client.from('leads').select('*').gt('id', 2);
-  console.log('gt id > 2:', gt);
+  const { data: gt } = await client.from('employees').select('*').gt('salary', 60000);
+  console.log('gt salary > 60000:', gt?.map(r => `${r.firstname} (${r.salary})`));
 
   console.log('\n── GTE / LTE ───────────────────────');
-  const { data: lte } = await client.from('leads').select('*').lte('id', 3);
-  console.log('lte id <= 3:', lte);
+  const { data: lte } = await client.from('employees').select('*').lte('salary', 65000);
+  console.log('lte salary <= 65000:', lte?.map(r => `${r.firstname} (${r.salary})`));
 
   console.log('\n── LIKE ────────────────────────────');
-  const { data: like } = await client.from('leads').select('*').like('company_name', '%oo%');
-  console.log('like company_name %oo%:', like);
+  const { data: like } = await client.from('employees').select('*').like('firstname', '%a%');
+  console.log('like firstname %a%:', like?.map(r => r.firstname));
 
   console.log('\n── ILIKE (case insensitive) ────────');
-  const { data: ilike } = await client.from('leads').select('*').ilike('company_name', '%google%');
-  console.log('ilike company_name %google%:', ilike);
+  const { data: ilike } = await client.from('employees').select('*').ilike('lastname', '%s%');
+  console.log('ilike lastname %s%:', ilike?.map(r => r.lastname));
 
   console.log('\n── IN ──────────────────────────────');
-  const { data: inResult } = await client.from('leads').select('*').in('slug', ['google', 'meta']);
-  console.log('in slug [google, meta]:', inResult);
+  const { data: inResult } = await client.from('employees').select('*').in('employeeid', [101, 102]);
+  console.log('in employeeid [101, 102]:', inResult?.map(r => r.firstname));
 
   console.log('\n── IS NULL ─────────────────────────');
-  const { data: isNull } = await client.from('leads').select('*').is('custom_pitch', null);
-  console.log('is custom_pitch null:', isNull);
+  const { data: isNull } = await client.from('employees').select('*').is('hiredate', null);
+  console.log('is hiredate null:', isNull);
 
   console.log('\n── ORDER ASC ───────────────────────');
-  const { data: asc } = await client.from('leads').select('*').order('id', { ascending: true });
-  console.log('order id asc:', asc?.map(r => r.id));
+  const { data: asc } = await client.from('employees').select('*').order('salary', { ascending: true });
+  console.log('order salary asc:', asc?.map(r => r.salary));
 
   console.log('\n── ORDER DESC ──────────────────────');
-  const { data: desc } = await client.from('leads').select('*').order('id', { ascending: false });
-  console.log('order id desc:', desc?.map(r => r.id));
+  const { data: desc } = await client.from('employees').select('*').order('salary', { ascending: false });
+  console.log('order salary desc:', desc?.map(r => r.salary));
 
   console.log('\n── LIMIT ───────────────────────────');
-  const { data: limited } = await client.from('leads').select('*').limit(2);
+  const { data: limited } = await client.from('employees').select('*').limit(2);
   console.log('limit 2:', limited?.length, 'rows');
 
   console.log('\n── RANGE (pagination) ──────────────');
-  const { data: page } = await client.from('leads').select('*').range(0, 1);
+  const { data: page } = await client.from('employees').select('*').range(0, 1);
   console.log('range 0-1:', page?.length, 'rows');
 
   console.log('\n── CHAINED (gt + order + limit) ────');
   const { data: chained } = await client
-    .from('leads')
+    .from('employees')
     .select('*')
-    .gt('id', 1)
-    .order('id', { ascending: false })
+    .gt('salary', 55000)
+    .order('salary', { ascending: false })
     .limit(3);
-  console.log('chained:', chained);
+  console.log('chained:', chained?.map(r => `${r.firstname} (${r.salary})`));
 }
 
-testOperators().catch(console.error);
+test()
+  .then(() => testOperators())
+  .catch(console.error);