@giaeulate/baas-sdk 1.0.0

package/src/realtime.ts

@@ -0,0 +1,157 @@
+import { RealtimeAction, RealtimeCallback, RealtimePayload } from './types';
+
+/**
+ * RealtimeService handles WebSocket connections to the BaaS Realtime engine.
+ * It allows subscribing to database changes in real-time.
+ */
+export class RealtimeService {
+  private socket: WebSocket | null = null;
+  private subscribers: Map<string, Set<{ action: RealtimeAction; callback: RealtimeCallback }>> = new Map();
+  private reconnectAttempts = 0;
+  private maxReconnectAttempts = 5;
+  private reconnectInterval = 3000;
+
+  constructor(
+    private url: string,
+    private projectId: string | null,
+    private tokenProvider: () => string | null,
+    private wsConstructor: any = typeof WebSocket !== 'undefined' ? WebSocket : null
+  ) {}
+
+  /**
+   * Initialize the WebSocket connection
+   */
+  private connect(): Promise<void> {
+    if (this.socket?.readyState === WebSocket.OPEN) return Promise.resolve();
+    
+    return new Promise((resolve, reject) => {
+      const token = this.tokenProvider();
+      if (!this.projectId || !token) {
+        reject(new Error('Missing project ID or authentication token for Realtime connection'));
+        return;
+      }
+
+      // Convert http/https to ws/wss
+      const wsUrl = this.url.replace(/^http/, 'ws') + '/ws';
+      const fullUrl = `${wsUrl}?project_id=${this.projectId}&token=${token}`;
+
+      if (!this.wsConstructor) {
+        reject(new Error('WebSocket constructor not provided or available in this environment'));
+        return;
+      }
+
+      const socket = new this.wsConstructor(fullUrl);
+      this.socket = socket;
+
+      socket.onopen = () => {
+        console.log('BaaS Realtime: Connected');
+        this.reconnectAttempts = 0;
+        resolve();
+      };
+
+      socket.onmessage = (event: any) => {
+        try {
+          const payload: RealtimePayload = JSON.parse(event.data);
+          this.handleEvent(payload);
+        } catch (err) {
+          console.error('BaaS Realtime: Failed to parse message', err);
+        }
+      };
+
+      socket.onerror = (error: any) => {
+        console.error('BaaS Realtime: WebSocket Error', error);
+        reject(error);
+      };
+
+      socket.onclose = () => {
+        console.log('BaaS Realtime: Disconnected');
+        this.socket = null;
+        this.attemptReconnect();
+      };
+    });
+  }
+
+  /**
+   * Subscribe to changes on a specific table
+   */
+  public async subscribe<T = any>(
+    table: string,
+    action: RealtimeAction,
+    callback: RealtimeCallback<T>
+  ): Promise<{ unsubscribe: () => void }> {
+    await this.connect();
+
+    if (!this.subscribers.has(table)) {
+      this.subscribers.set(table, new Set());
+    }
+
+    const sub = { action, callback };
+    this.subscribers.get(table)!.add(sub);
+
+    return {
+      unsubscribe: () => {
+        const tableSubs = this.subscribers.get(table);
+        if (tableSubs) {
+          tableSubs.delete(sub);
+          if (tableSubs.size === 0) {
+            this.subscribers.delete(table);
+          }
+        }
+      }
+    };
+  }
+
+  /**
+   * Handle incoming CDC events from the server
+   */
+  private handleEvent(payload: RealtimePayload) {
+    // Notify specific table subscribers
+    const tableSubs = this.subscribers.get(payload.table);
+    if (tableSubs) {
+      for (const sub of tableSubs) {
+        if (sub.action === '*' || sub.action.toLowerCase() === payload.action.toLowerCase()) {
+          sub.callback(payload);
+        }
+      }
+    }
+
+    // Notify wildcard ('*') subscribers
+    const wildcardSubs = this.subscribers.get('*');
+    if (wildcardSubs) {
+      for (const sub of wildcardSubs) {
+        if (sub.action === '*' || sub.action.toLowerCase() === payload.action.toLowerCase()) {
+          sub.callback(payload);
+        }
+      }
+    }
+  }
+
+  /**
+   * Attempt to reconnect on connection loss
+   */
+  private attemptReconnect() {
+    if (this.reconnectAttempts < this.maxReconnectAttempts) {
+      this.reconnectAttempts++;
+      console.log(`BaaS Realtime: Attempting reconnect ${this.reconnectAttempts}/${this.maxReconnectAttempts}...`);
+      setTimeout(() => this.connect(), this.reconnectInterval);
+    } else {
+      console.error('BaaS Realtime: Max reconnect attempts reached');
+    }
+  }
+
+  /**
+   * Close the connection
+   */
+  public disconnect() {
+    if (this.socket) {
+      this.socket.onclose = null; // Prevent reconnect
+      this.socket.close();
+      this.socket = null;
+    }
+  }
+
+  /** @internal - For testing only */
+  public get _socket(): WebSocket | null {
+    return this.socket;
+  }
+}

package/src/types.ts

@@ -0,0 +1,49 @@
+/**
+ * SDK Shared Types
+ */
+
+/** HTTP method types */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+
+/** Request options for the HTTP client */
+export interface RequestOptions {
+  method?: HttpMethod;
+  body?: unknown;
+  headers?: Record<string, string>;
+  skipAuth?: boolean;
+}
+
+/** Query filter for data operations */
+export type QueryFilter = {
+  column: string;
+  operator: string;
+  value: any;
+};
+
+/** Pagination options */
+export interface PaginationOptions {
+  limit?: number;
+  offset?: number;
+}
+
+/** Generic API response with error */
+export interface ApiResponse<T = any> {
+  data?: T;
+  error?: string;
+  success?: boolean;
+}
+
+/** Realtime Event types */
+export type RealtimeAction = 'INSERT' | 'UPDATE' | 'DELETE' | '*';
+
+/** Structure of a Realtime event payload */
+export interface RealtimePayload<T = any> {
+  table: string;
+  action: 'insert' | 'update' | 'delete';
+  record: T;
+  old_record?: T;
+  timestamp: string;
+}
+
+/** Callback function for realtime subscriptions */
+export type RealtimeCallback<T = any> = (payload: RealtimePayload<T>) => void;

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "isolatedModules": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/vitest.config.ts

@@ -0,0 +1,14 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'jsdom',
+    globals: true,
+    setupFiles: [],
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+    },
+  },
+});