@ragable/sdk 0.6.13 → 0.6.14

package/dist/index.d.mts

@@ -943,6 +943,30 @@ declare class RagableBrowserDatabaseClient<Database extends RagableDatabase = De
     private toUrl;
     query: <Row extends Record<string, unknown> = Record<string, unknown>>(params: BrowserSqlQueryParams) => Promise<PostgrestResult<BrowserSqlQueryResult<Row>>>;
     private baseHeaders;
+    /**
+     * Postgres `LISTEN` / `NOTIFY` realtime via server-proxied SSE.
+     * Channels must be lowercase identifiers: `[a-z_][a-z0-9_]*` (max 63 chars).
+     */
+    realtime: {
+        subscribe: (params: BrowserRealtimeSubscribeParams) => Promise<{
+            unsubscribe: () => void;
+        }>;
+    };
+}
+interface BrowserRealtimeNotification {
+    channel: string;
+    payload: string | null;
+    processId: number;
+}
+interface BrowserRealtimeSubscribeParams {
+    databaseInstanceId?: string;
+    /** Channel names (normalized to lowercase on the server). */
+    channels: string[];
+    /** When aborted, the subscription stops (in addition to `unsubscribe()`). */
+    signal?: AbortSignal;
+    onNotify?: (msg: BrowserRealtimeNotification) => void;
+    onReady?: (channels: string[]) => void;
+    onError?: (message: string) => void;
 }
 declare class RagableBrowserAgentsClient {
     private readonly options;
@@ -1044,4 +1068,4 @@ declare function createClient(options: RagableClientOptions): Ragable;
 declare function createClient<Database extends RagableDatabase = DefaultRagableDatabase, AuthUser extends Record<string, unknown> = Record<string, unknown>>(options: RagableBrowserClientOptions): RagableBrowser<Database, AuthUser>;
 declare function createRagableServerClient(options: RagableClientOptions): Ragable;
 
-export { type AgentChatMessage, type AgentChatParams, type AgentChatResult, type AgentPublicChatParams, type AgentStreamEvent, type AgentSummary, AgentsClient, AuthBroadcastChannel, type AuthBroadcastMessage, type AuthChangeEvent, type AuthOptions, type AuthSession, type BrowserAuthSession, type BrowserAuthTokens, type BrowserDataAuthMode, type BrowserSqlExecParams, type BrowserSqlExecResult, type BrowserSqlQueryParams, type BrowserSqlQueryResult, type ColumnName, type ColumnValue, CookieStorageAdapter, DEFAULT_RAGABLE_API_BASE, type DefaultRagableDatabase, type FormatContextOptions, type HttpMethod, type Json, LocalStorageAdapter, MemoryStorageAdapter, type PostgRESTFetch, type PostgRESTFetchParams, PostgrestDeleteReturningBuilder, PostgrestDeleteRootBuilder, PostgrestInsertReturningBuilder, PostgrestInsertRootBuilder, PostgrestInsertSdkErrorReturning, PostgrestInsertSdkErrorRoot, type PostgrestResult, PostgrestSelectBuilder, PostgrestTableApi, PostgrestUpdateReturningBuilder, PostgrestUpdateRootBuilder, type PostgrestUpsertOptions, PostgrestUpsertReturningBuilder, PostgrestUpsertRootBuilder, type RagClientForPipeline, type RagPipeline, type RagPipelineOptions, Ragable, RagableAbortError, RagableAuth, type RagableAuthConfig, RagableBrowser, RagableBrowserAgentsClient, RagableBrowserAuthClient, type RagableBrowserClientOptions, RagableBrowserDatabaseClient, type RagableClientOptions, type RagableDatabase, RagableError, RagableNetworkError, RagableRequestClient, RagableSdkError, type RagableTableDefinition, type RagableTableNames, RagableTimeoutError, type RequestOptions, type RetrieveParams, type RetryOptions, type RunQuery, type SessionStorage, SessionStorageAdapter, type ShiftAddDocumentParams, ShiftClient, type ShiftCreateIndexParams, type ShiftEntry, type ShiftIndex, type ShiftIngestResponse, type ShiftListEntriesParams, type ShiftListEntriesResponse, type ShiftSearchParams, type ShiftSearchResult, type ShiftUpdateIndexParams, type ShiftUploadFileParams, type ShiftUploadableFile, type SseJsonEvent, type SupabaseCompatSession, type TableInsertRow, type TableRow, type TableUpdatePatch, type Tables, type TablesInsert, type TablesUpdate, Transport, type TransportOptions, type TransportRequest, asPostgrestResponse, bindFetch, createBrowserClient, createClient, createRagPipeline, createRagableBrowserClient, createRagableServerClient, detectStorage, effectiveDataAuth, extractErrorMessage, formatPostgrestError, formatRetrievalContext, formatSdkError, generateIdempotencyKey, normalizeBrowserApiBase, parseSseDataLine, parseTransportResponse, readSseStream };
+export { type AgentChatMessage, type AgentChatParams, type AgentChatResult, type AgentPublicChatParams, type AgentStreamEvent, type AgentSummary, AgentsClient, AuthBroadcastChannel, type AuthBroadcastMessage, type AuthChangeEvent, type AuthOptions, type AuthSession, type BrowserAuthSession, type BrowserAuthTokens, type BrowserDataAuthMode, type BrowserRealtimeNotification, type BrowserRealtimeSubscribeParams, type BrowserSqlExecParams, type BrowserSqlExecResult, type BrowserSqlQueryParams, type BrowserSqlQueryResult, type ColumnName, type ColumnValue, CookieStorageAdapter, DEFAULT_RAGABLE_API_BASE, type DefaultRagableDatabase, type FormatContextOptions, type HttpMethod, type Json, LocalStorageAdapter, MemoryStorageAdapter, type PostgRESTFetch, type PostgRESTFetchParams, PostgrestDeleteReturningBuilder, PostgrestDeleteRootBuilder, PostgrestInsertReturningBuilder, PostgrestInsertRootBuilder, PostgrestInsertSdkErrorReturning, PostgrestInsertSdkErrorRoot, type PostgrestResult, PostgrestSelectBuilder, PostgrestTableApi, PostgrestUpdateReturningBuilder, PostgrestUpdateRootBuilder, type PostgrestUpsertOptions, PostgrestUpsertReturningBuilder, PostgrestUpsertRootBuilder, type RagClientForPipeline, type RagPipeline, type RagPipelineOptions, Ragable, RagableAbortError, RagableAuth, type RagableAuthConfig, RagableBrowser, RagableBrowserAgentsClient, RagableBrowserAuthClient, type RagableBrowserClientOptions, RagableBrowserDatabaseClient, type RagableClientOptions, type RagableDatabase, RagableError, RagableNetworkError, RagableRequestClient, RagableSdkError, type RagableTableDefinition, type RagableTableNames, RagableTimeoutError, type RequestOptions, type RetrieveParams, type RetryOptions, type RunQuery, type SessionStorage, SessionStorageAdapter, type ShiftAddDocumentParams, ShiftClient, type ShiftCreateIndexParams, type ShiftEntry, type ShiftIndex, type ShiftIngestResponse, type ShiftListEntriesParams, type ShiftListEntriesResponse, type ShiftSearchParams, type ShiftSearchResult, type ShiftUpdateIndexParams, type ShiftUploadFileParams, type ShiftUploadableFile, type SseJsonEvent, type SupabaseCompatSession, type TableInsertRow, type TableRow, type TableUpdatePatch, type Tables, type TablesInsert, type TablesUpdate, Transport, type TransportOptions, type TransportRequest, asPostgrestResponse, bindFetch, createBrowserClient, createClient, createRagPipeline, createRagableBrowserClient, createRagableServerClient, detectStorage, effectiveDataAuth, extractErrorMessage, formatPostgrestError, formatRetrievalContext, formatSdkError, generateIdempotencyKey, normalizeBrowserApiBase, parseSseDataLine, parseTransportResponse, readSseStream };

package/dist/index.d.ts

@@ -943,6 +943,30 @@ declare class RagableBrowserDatabaseClient<Database extends RagableDatabase = De
     private toUrl;
     query: <Row extends Record<string, unknown> = Record<string, unknown>>(params: BrowserSqlQueryParams) => Promise<PostgrestResult<BrowserSqlQueryResult<Row>>>;
     private baseHeaders;
+    /**
+     * Postgres `LISTEN` / `NOTIFY` realtime via server-proxied SSE.
+     * Channels must be lowercase identifiers: `[a-z_][a-z0-9_]*` (max 63 chars).
+     */
+    realtime: {
+        subscribe: (params: BrowserRealtimeSubscribeParams) => Promise<{
+            unsubscribe: () => void;
+        }>;
+    };
+}
+interface BrowserRealtimeNotification {
+    channel: string;
+    payload: string | null;
+    processId: number;
+}
+interface BrowserRealtimeSubscribeParams {
+    databaseInstanceId?: string;
+    /** Channel names (normalized to lowercase on the server). */
+    channels: string[];
+    /** When aborted, the subscription stops (in addition to `unsubscribe()`). */
+    signal?: AbortSignal;
+    onNotify?: (msg: BrowserRealtimeNotification) => void;
+    onReady?: (channels: string[]) => void;
+    onError?: (message: string) => void;
 }
 declare class RagableBrowserAgentsClient {
     private readonly options;
@@ -1044,4 +1068,4 @@ declare function createClient(options: RagableClientOptions): Ragable;
 declare function createClient<Database extends RagableDatabase = DefaultRagableDatabase, AuthUser extends Record<string, unknown> = Record<string, unknown>>(options: RagableBrowserClientOptions): RagableBrowser<Database, AuthUser>;
 declare function createRagableServerClient(options: RagableClientOptions): Ragable;
 
-export { type AgentChatMessage, type AgentChatParams, type AgentChatResult, type AgentPublicChatParams, type AgentStreamEvent, type AgentSummary, AgentsClient, AuthBroadcastChannel, type AuthBroadcastMessage, type AuthChangeEvent, type AuthOptions, type AuthSession, type BrowserAuthSession, type BrowserAuthTokens, type BrowserDataAuthMode, type BrowserSqlExecParams, type BrowserSqlExecResult, type BrowserSqlQueryParams, type BrowserSqlQueryResult, type ColumnName, type ColumnValue, CookieStorageAdapter, DEFAULT_RAGABLE_API_BASE, type DefaultRagableDatabase, type FormatContextOptions, type HttpMethod, type Json, LocalStorageAdapter, MemoryStorageAdapter, type PostgRESTFetch, type PostgRESTFetchParams, PostgrestDeleteReturningBuilder, PostgrestDeleteRootBuilder, PostgrestInsertReturningBuilder, PostgrestInsertRootBuilder, PostgrestInsertSdkErrorReturning, PostgrestInsertSdkErrorRoot, type PostgrestResult, PostgrestSelectBuilder, PostgrestTableApi, PostgrestUpdateReturningBuilder, PostgrestUpdateRootBuilder, type PostgrestUpsertOptions, PostgrestUpsertReturningBuilder, PostgrestUpsertRootBuilder, type RagClientForPipeline, type RagPipeline, type RagPipelineOptions, Ragable, RagableAbortError, RagableAuth, type RagableAuthConfig, RagableBrowser, RagableBrowserAgentsClient, RagableBrowserAuthClient, type RagableBrowserClientOptions, RagableBrowserDatabaseClient, type RagableClientOptions, type RagableDatabase, RagableError, RagableNetworkError, RagableRequestClient, RagableSdkError, type RagableTableDefinition, type RagableTableNames, RagableTimeoutError, type RequestOptions, type RetrieveParams, type RetryOptions, type RunQuery, type SessionStorage, SessionStorageAdapter, type ShiftAddDocumentParams, ShiftClient, type ShiftCreateIndexParams, type ShiftEntry, type ShiftIndex, type ShiftIngestResponse, type ShiftListEntriesParams, type ShiftListEntriesResponse, type ShiftSearchParams, type ShiftSearchResult, type ShiftUpdateIndexParams, type ShiftUploadFileParams, type ShiftUploadableFile, type SseJsonEvent, type SupabaseCompatSession, type TableInsertRow, type TableRow, type TableUpdatePatch, type Tables, type TablesInsert, type TablesUpdate, Transport, type TransportOptions, type TransportRequest, asPostgrestResponse, bindFetch, createBrowserClient, createClient, createRagPipeline, createRagableBrowserClient, createRagableServerClient, detectStorage, effectiveDataAuth, extractErrorMessage, formatPostgrestError, formatRetrievalContext, formatSdkError, generateIdempotencyKey, normalizeBrowserApiBase, parseSseDataLine, parseTransportResponse, readSseStream };
+export { type AgentChatMessage, type AgentChatParams, type AgentChatResult, type AgentPublicChatParams, type AgentStreamEvent, type AgentSummary, AgentsClient, AuthBroadcastChannel, type AuthBroadcastMessage, type AuthChangeEvent, type AuthOptions, type AuthSession, type BrowserAuthSession, type BrowserAuthTokens, type BrowserDataAuthMode, type BrowserRealtimeNotification, type BrowserRealtimeSubscribeParams, type BrowserSqlExecParams, type BrowserSqlExecResult, type BrowserSqlQueryParams, type BrowserSqlQueryResult, type ColumnName, type ColumnValue, CookieStorageAdapter, DEFAULT_RAGABLE_API_BASE, type DefaultRagableDatabase, type FormatContextOptions, type HttpMethod, type Json, LocalStorageAdapter, MemoryStorageAdapter, type PostgRESTFetch, type PostgRESTFetchParams, PostgrestDeleteReturningBuilder, PostgrestDeleteRootBuilder, PostgrestInsertReturningBuilder, PostgrestInsertRootBuilder, PostgrestInsertSdkErrorReturning, PostgrestInsertSdkErrorRoot, type PostgrestResult, PostgrestSelectBuilder, PostgrestTableApi, PostgrestUpdateReturningBuilder, PostgrestUpdateRootBuilder, type PostgrestUpsertOptions, PostgrestUpsertReturningBuilder, PostgrestUpsertRootBuilder, type RagClientForPipeline, type RagPipeline, type RagPipelineOptions, Ragable, RagableAbortError, RagableAuth, type RagableAuthConfig, RagableBrowser, RagableBrowserAgentsClient, RagableBrowserAuthClient, type RagableBrowserClientOptions, RagableBrowserDatabaseClient, type RagableClientOptions, type RagableDatabase, RagableError, RagableNetworkError, RagableRequestClient, RagableSdkError, type RagableTableDefinition, type RagableTableNames, RagableTimeoutError, type RequestOptions, type RetrieveParams, type RetryOptions, type RunQuery, type SessionStorage, SessionStorageAdapter, type ShiftAddDocumentParams, ShiftClient, type ShiftCreateIndexParams, type ShiftEntry, type ShiftIndex, type ShiftIngestResponse, type ShiftListEntriesParams, type ShiftListEntriesResponse, type ShiftSearchParams, type ShiftSearchResult, type ShiftUpdateIndexParams, type ShiftUploadFileParams, type ShiftUploadableFile, type SseJsonEvent, type SupabaseCompatSession, type TableInsertRow, type TableRow, type TableUpdatePatch, type Tables, type TablesInsert, type TablesUpdate, Transport, type TransportOptions, type TransportRequest, asPostgrestResponse, bindFetch, createBrowserClient, createClient, createRagPipeline, createRagableBrowserClient, createRagableServerClient, detectStorage, effectiveDataAuth, extractErrorMessage, formatPostgrestError, formatRetrievalContext, formatSdkError, generateIdempotencyKey, normalizeBrowserApiBase, parseSseDataLine, parseTransportResponse, readSseStream };

package/dist/index.js

@@ -2368,6 +2368,18 @@ var RagableBrowserDatabaseClient = class {
         return payload;
       });
     });
+    /**
+     * Postgres `LISTEN` / `NOTIFY` realtime via server-proxied SSE.
+     * Channels must be lowercase identifiers: `[a-z_][a-z0-9_]*` (max 63 chars).
+     */
+    __publicField(this, "realtime", {
+      subscribe: (params) => subscribeBrowserRealtime(
+        this.options,
+        this.ragableAuth,
+        this.fetchImpl,
+        params
+      )
+    });
     this.fetchImpl = bindFetch(options.fetch);
   }
   /** @internal Called by RagableBrowser to share the Transport instance. */
@@ -2381,6 +2393,89 @@ var RagableBrowserDatabaseClient = class {
     return new Headers(this.options.headers);
   }
 };
+function followAbortSignal(parent, child) {
+  if (!parent) return;
+  if (parent.aborted) {
+    child.abort();
+    return;
+  }
+  parent.addEventListener("abort", () => child.abort(), { once: true });
+}
+async function subscribeBrowserRealtime(options, ragableAuth, fetchImpl, params) {
+  const gid = requireAuthGroupId(options);
+  const token = await resolveDatabaseAuthBearer(options, ragableAuth);
+  const databaseInstanceId = params.databaseInstanceId?.trim() || options.databaseInstanceId?.trim();
+  if (!databaseInstanceId) {
+    throw new RagableError(
+      "realtime.subscribe requires databaseInstanceId in params or on createBrowserClient({ databaseInstanceId })",
+      400,
+      { code: "SDK_MISSING_DATABASE_INSTANCE_ID" }
+    );
+  }
+  if (!Array.isArray(params.channels) || params.channels.length === 0) {
+    throw new RagableError(
+      "realtime.subscribe requires a non-empty channels array",
+      400,
+      { code: "SDK_REALTIME_CHANNELS_REQUIRED" }
+    );
+  }
+  const ac = new AbortController();
+  followAbortSignal(params.signal, ac);
+  const headers = new Headers(options.headers);
+  headers.set("Authorization", `Bearer ${token}`);
+  headers.set("Content-Type", "application/json");
+  const response = await fetchImpl(
+    `${normalizeBrowserApiBase()}/auth-groups/${gid}/data/realtime/stream`,
+    {
+      method: "POST",
+      headers,
+      body: JSON.stringify({
+        databaseInstanceId,
+        channels: params.channels
+      }),
+      signal: ac.signal
+    }
+  );
+  const payload = await parseMaybeJsonBody(response);
+  if (!response.ok) {
+    const message = extractErrorMessage(payload, response.statusText);
+    throw new RagableError(message, response.status, payload);
+  }
+  const streamBody = response.body;
+  if (!streamBody) {
+    throw new RagableError(
+      "Realtime stream has no body",
+      502,
+      { code: "SDK_REALTIME_NO_BODY" }
+    );
+  }
+  void (async () => {
+    try {
+      for await (const evt of readSseStream(streamBody)) {
+        if (evt.type === "realtime:ready") {
+          const ch = evt.channels;
+          params.onReady?.(
+            Array.isArray(ch) ? ch.map((c) => String(c)) : []
+          );
+        } else if (evt.type === "notify") {
+          params.onNotify?.({
+            channel: String(evt.channel ?? ""),
+            payload: evt.payload === void 0 || evt.payload === null ? null : String(evt.payload),
+            processId: Number(evt.processId ?? 0)
+          });
+        } else if (evt.type === "realtime:error") {
+          params.onError?.(String(evt.message ?? "Realtime error"));
+        }
+      }
+    } catch (e) {
+      if (e.name === "AbortError") return;
+      params.onError?.(e.message);
+    }
+  })();
+  return {
+    unsubscribe: () => ac.abort()
+  };
+}
 var RagableBrowserAgentsClient = class {
   constructor(options) {
     this.options = options;