openbase-js 0.1.4 → 0.1.6

package/index.cjs

@@ -6,12 +6,12 @@ class QueryBuilder {
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
-    this._filters = [];         // changed: was {} now array of {col, op, val}
+    this._filters = [];
     this._columns = '*';
     this._limitVal = null;
-    this._offsetVal = null;     // new
-    this._orderCol = null;      // new
-    this._orderAsc = true;      // new
+    this._offsetVal = null;
+    this._orderCol = null;
+    this._orderAsc = true;
     this._single = false;
     this._operation = 'select';
     this._insertData = null;
@@ -67,7 +67,6 @@ class QueryBuilder {
   }
 
   is(column, value) {
-    // value should be null, true, or false
     this._filters.push({ col: column, op: 'is', val: value });
     return this;
   }
@@ -86,7 +85,6 @@ class QueryBuilder {
   }
 
   range(from, to) {
-    // e.g. range(0, 9) => LIMIT 10 OFFSET 0
     this._limitVal = to - from + 1;
     this._offsetVal = from;
     return this;
@@ -148,7 +146,6 @@ class QueryBuilder {
 
     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}`;
@@ -218,6 +215,127 @@ class QueryBuilder {
   }
 }
 
+// ─── Storage Client ───────────────────────────────────────────────────────────
+
+class StorageClient {
+  constructor(baseUrl, apiKey, dbName) {
+    this._baseUrl = baseUrl;
+    this._apiKey = apiKey;
+    this._dbName = dbName;
+  }
+
+  _headers() {
+    return { 'Authorization': `Bearer ${this._apiKey}` };
+  }
+
+  // Detect if we're running in Node.js
+  _isNode() {
+    return typeof window === 'undefined' && typeof process !== 'undefined';
+  }
+
+  // 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
+      let FormDataNode;
+      try {
+        FormDataNode = require('form-data');
+      } catch {
+        throw new Error(
+          '[openbase] In Node.js, storage.upload() requires the "form-data" package.\n' +
+          'Install it with: npm install form-data'
+        );
+      }
+
+      const fs = require('fs');
+      const path = require('path');
+      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');
+      }
+
+      return formData;
+
+    } else {
+      // Browser — use native FormData
+      const formData = new FormData();
+      formData.append('file', file, filename || file.name);
+      return formData;
+    }
+  }
+
+  // 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();
+
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/upload`, {
+        method: 'POST',
+        headers,
+        body: formData,
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // List all files in this project's bucket
+  async list() {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/list`, {
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // Get a presigned URL valid for 7 days
+  async getUrl(filename) {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/url/${encodeURIComponent(filename)}`, {
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // Delete a file
+  async remove(filename) {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/${encodeURIComponent(filename)}`, {
+        method: 'DELETE',
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+}
+
 // ─── Client ───────────────────────────────────────────────────────────────────
 
 class OpenbaseClient {
@@ -225,6 +343,7 @@ class OpenbaseClient {
     this._baseUrl = baseUrl.replace(/\/$/, '');
     this._apiKey = apiKey;
     this._dbName = dbName;
+    this.storage = new StorageClient(this._baseUrl, this._apiKey, this._dbName);
   }
 
   from(table) {

package/index.d.ts

@@ -1,10 +1,16 @@
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+
 export interface OpenbaseResponse<T> {
   data: T | null;
   error: string | null;
 }
 
 export declare class QueryBuilder<T = Record<string, unknown>> {
+  // Column selection
   select(columns?: string): this;
+
+  // Filter operators
   eq(column: string, value: unknown): this;
   gt(column: string, value: number): this;
   lt(column: string, value: number): this;
@@ -14,20 +20,78 @@ export declare class QueryBuilder<T = Record<string, unknown>> {
   ilike(column: string, pattern: string): this;
   in(column: string, values: unknown[]): this;
   is(column: string, value: null | boolean): this;
+
+  // Modifiers
   order(column: string, options?: { ascending?: boolean }): this;
-  range(from: number, to: number): this;
   limit(n: number): this;
+  range(from: number, to: number): this;
   single(): this;
+
+  // Mutations
   insert(data: Partial<T>): this;
   update(data: Partial<T>): this;
   delete(): this;
+
   then<R>(
     resolve: (value: OpenbaseResponse<T[]>) => R,
     reject?: (reason: unknown) => R
   ): Promise<R>;
+
+  on(event: 'INSERT' | 'UPDATE' | 'DELETE', callback: (payload: {
+    event: string;
+    table: string;
+    record: Record<string, unknown>;
+  }) => void): this;
+  subscribe(): RealtimeSubscription;
+
+}
+
+export interface StorageFileInfo {
+  name: string;
+  size: number;
+  content_type: string;
+}
+
+export interface StorageListItem {
+  name: string;
+  size: number;
+  last_modified: string;
+}
+
+export declare class StorageClient {
+  /**
+   * Upload a file to this project's storage bucket.
+   *
+   * Browser: pass a File or Blob (e.g. from <input type="file">)
+   * Node.js: pass a file path string, Buffer, or ReadStream
+   *          Requires the "form-data" package: npm install form-data
+   */
+  upload(
+    file: File | Blob | string | Buffer | ReadStream,
+    filename?: string
+  ): Promise<OpenbaseResponse<StorageFileInfo>>;
+
+  /**
+   * List all files in this project's storage bucket.
+   */
+  list(): Promise<OpenbaseResponse<StorageListItem[]>>;
+
+  /**
+   * Get a presigned URL for a file, valid for 7 days.
+   */
+  getUrl(filename: string): Promise<OpenbaseResponse<{ url: string }>>;
+
+  /**
+   * Delete a file from this project's storage bucket.
+   */
+  remove(filename: string): Promise<OpenbaseResponse<{ name: string }>>;
 }
 
 export declare class OpenbaseClient {
+  /** Storage client for file upload, listing, URLs, and deletion */
+  storage: StorageClient;
+
+  /** Query builder for database operations */
   from<T = Record<string, unknown>>(table: string): QueryBuilder<T>;
 }
 
@@ -35,4 +99,14 @@ export declare function createClient(
   baseUrl: string,
   apiKey: string,
   dbName: string
-): OpenbaseClient;
+): OpenbaseClient;
+
+export declare class RealtimeSubscription {
+  on(event: 'INSERT' | 'UPDATE' | 'DELETE', callback: (payload: {
+    event: string;
+    table: string;
+    record: Record<string, unknown>;
+  }) => void): this;
+  subscribe(): this;
+  unsubscribe(): void;
+}

package/index.js

@@ -6,12 +6,12 @@ class QueryBuilder {
     this._apiKey = apiKey;
     this._dbName = dbName;
     this._table = table;
-    this._filters = [];         // changed: was {} now array of {col, op, val}
+    this._filters = [];
     this._columns = '*';
     this._limitVal = null;
-    this._offsetVal = null;     // new
-    this._orderCol = null;      // new
-    this._orderAsc = true;      // new
+    this._offsetVal = null;
+    this._orderCol = null;
+    this._orderAsc = true;
     this._single = false;
     this._operation = 'select';
     this._insertData = null;
@@ -24,6 +24,25 @@ class QueryBuilder {
     return this;
   }
 
+  on(event, callback) {
+    if (!this._realtimeSub) {
+      this._realtimeSub = new RealtimeSubscription(
+        this._baseUrl, this._apiKey, this._dbName, this._table
+      );
+    }
+    this._realtimeSub.on(event, callback);
+    return this;
+  }
+
+  subscribe() {
+    if (!this._realtimeSub) {
+      this._realtimeSub = new RealtimeSubscription(
+        this._baseUrl, this._apiKey, this._dbName, this._table
+      );
+    }
+    return this._realtimeSub.subscribe();
+  }
+
   // ─── Filter operators ──────────────────────────────────────────────────────
 
   eq(column, value) {
@@ -67,7 +86,6 @@ class QueryBuilder {
   }
 
   is(column, value) {
-    // value should be null, true, or false
     this._filters.push({ col: column, op: 'is', val: value });
     return this;
   }
@@ -86,7 +104,6 @@ class QueryBuilder {
   }
 
   range(from, to) {
-    // e.g. range(0, 9) => LIMIT 10 OFFSET 0
     this._limitVal = to - from + 1;
     this._offsetVal = from;
     return this;
@@ -148,7 +165,6 @@ class QueryBuilder {
 
     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}`;
@@ -218,6 +234,173 @@ class QueryBuilder {
   }
 }
 
+// ─── Storage Client ───────────────────────────────────────────────────────────
+
+class StorageClient {
+  constructor(baseUrl, apiKey, dbName) {
+    this._baseUrl = baseUrl;
+    this._apiKey = apiKey;
+    this._dbName = dbName;
+  }
+
+  _headers() {
+    return { 'Authorization': `Bearer ${this._apiKey}` };
+  }
+
+  // Detect if we're running in Node.js
+  _isNode() {
+    return typeof window === 'undefined' && typeof process !== 'undefined';
+  }
+
+  // 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
+      let FormDataNode;
+      try {
+        FormDataNode = require('form-data');
+      } catch {
+        throw new Error(
+          '[openbase] In Node.js, storage.upload() requires the "form-data" package.\n' +
+          'Install it with: npm install form-data'
+        );
+      }
+
+      const fs = require('fs');
+      const path = require('path');
+      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');
+      }
+
+      return formData;
+
+    } else {
+      // Browser — use native FormData
+      const formData = new FormData();
+      formData.append('file', file, filename || file.name);
+      return formData;
+    }
+  }
+
+  // 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();
+
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/upload`, {
+        method: 'POST',
+        headers,
+        body: formData,
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // List all files in this project's bucket
+  async list() {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/list`, {
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // Get a presigned URL valid for 7 days
+  async getUrl(filename) {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/url/${encodeURIComponent(filename)}`, {
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+
+  // Delete a file
+  async remove(filename) {
+    try {
+      const res = await fetch(`${this._baseUrl}/storage/${this._dbName}/${encodeURIComponent(filename)}`, {
+        method: 'DELETE',
+        headers: this._headers(),
+      });
+      return await res.json();
+    } catch (err) {
+      return { data: null, error: err.message };
+    }
+  }
+}
+
+// ─── Realtime Subscription ────────────────────────────────────────────────────
+
+class RealtimeSubscription {
+  constructor(baseUrl, apiKey, dbName, table) {
+    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._ws = null;
+  }
+
+  on(event, callback) {
+    if (!this._listeners[event]) this._listeners[event] = [];
+    this._listeners[event].push(callback);
+    return this;
+  }
+
+  subscribe() {
+    const url = `${this._baseUrl}/realtime/${this._dbName}/${this._table}?token=${this._apiKey}`;
+    this._ws = new WebSocket(url);
+
+    this._ws.onmessage = (e) => {
+      try {
+        const payload = JSON.parse(e.data);
+        if (payload.event === 'PING') return;
+        const handlers = this._listeners[payload.event] || [];
+        handlers.forEach(fn => fn(payload));
+      } catch { }
+    };
+
+    this._ws.onerror = (err) => {
+      console.error('[openbase] Realtime error:', err);
+    };
+
+    return this;
+  }
+
+  unsubscribe() {
+    if (this._ws) {
+      this._ws.close();
+      this._ws = null;
+    }
+  }
+}
+
 // ─── Client ───────────────────────────────────────────────────────────────────
 
 class OpenbaseClient {
@@ -225,6 +408,7 @@ class OpenbaseClient {
     this._baseUrl = baseUrl.replace(/\/$/, '');
     this._apiKey = apiKey;
     this._dbName = dbName;
+    this.storage = new StorageClient(this._baseUrl, this._apiKey, this._dbName);
   }
 
   from(table) {

package/package.json

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

package/test.js

@@ -43,4 +43,55 @@ async function test() {
   console.log('deleted:', deleted);
 }
 
-test().catch(console.error);
+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);
+
+  console.log('\n── GTE / LTE ───────────────────────');
+  const { data: lte } = await client.from('leads').select('*').lte('id', 3);
+  console.log('lte id <= 3:', lte);
+
+  console.log('\n── LIKE ────────────────────────────');
+  const { data: like } = await client.from('leads').select('*').like('company_name', '%oo%');
+  console.log('like company_name %oo%:', like);
+
+  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);
+
+  console.log('\n── IN ──────────────────────────────');
+  const { data: inResult } = await client.from('leads').select('*').in('slug', ['google', 'meta']);
+  console.log('in slug [google, meta]:', inResult);
+
+  console.log('\n── IS NULL ─────────────────────────');
+  const { data: isNull } = await client.from('leads').select('*').is('custom_pitch', null);
+  console.log('is custom_pitch 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));
+
+  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));
+
+  console.log('\n── LIMIT ───────────────────────────');
+  const { data: limited } = await client.from('leads').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);
+  console.log('range 0-1:', page?.length, 'rows');
+
+  console.log('\n── CHAINED (gt + order + limit) ────');
+  const { data: chained } = await client
+    .from('leads')
+    .select('*')
+    .gt('id', 1)
+    .order('id', { ascending: false })
+    .limit(3);
+  console.log('chained:', chained);
+}
+
+testOperators().catch(console.error);