@rebasepro/client 0.7.0 → 0.9.0

package/dist/sdk_query_builder.d.ts

@@ -0,0 +1,63 @@
+import { FindResult, LogicalCondition, SDKCollectionClient, SDKQueryBuilderInterface, WhereFilterOp, WhereValue } from "@rebasepro/types";
+/**
+ * SDK Query Builder — returns flat rows (`FindResult<M>`) instead of
+ * Entity-wrapped results (`FindResponse<M>`).
+ *
+ * @example
+ * const { data } = await rebase.data.posts
+ *     .where("status", "==", "published")
+ *     .orderBy("created_at", "desc")
+ *     .limit(10)
+ *     .find();
+ *
+ * console.log(data[0].title); // flat access
+ */
+export declare class SDKQueryBuilder<M extends Record<string, unknown> = Record<string, unknown>> implements SDKQueryBuilderInterface<M> {
+    private collection;
+    private params;
+    constructor(collection: SDKCollectionClient<M>);
+    /**
+     * Add a filter condition to your query.
+     * @example
+     * client.data.users.where('age', '>=', 18).find()
+     */
+    where<K extends keyof M & string>(column: K, operator: WhereFilterOp, value: WhereValue<M[K]>): this;
+    where(logicalCondition: LogicalCondition): this;
+    /**
+     * Order the results by a specific column.
+     */
+    orderBy(column: keyof M & string, direction?: "asc" | "desc"): this;
+    /**
+     * Limit the number of results returned.
+     */
+    limit(count: number): this;
+    /**
+     * Skip the first N results.
+     */
+    offset(count: number): this;
+    /**
+     * Set a free-text search string if supported by the backend.
+     */
+    search(searchString: string): this;
+    /**
+     * Include related entities in the response.
+     * Relations will be populated with full data instead of just IDs.
+     *
+     * @param relations - Relation names to include, or "*" for all.
+     * @example
+     * client.data.posts.include("tags", "author").find()
+     */
+    include(...relations: string[]): this;
+    /**
+     * Execute the find query and return the results as flat rows.
+     */
+    find(): Promise<FindResult<M>>;
+    /**
+     * Count the records matching this query.
+     */
+    count(): Promise<number>;
+    /**
+     * Listen to realtime updates matching this query.
+     */
+    listen(onUpdate: (data: FindResult<M>) => void, onError?: (error: Error) => void): () => void;
+}

package/dist/storage-registry.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Client-side storage source registry.
+ *
+ * Manages multiple `StorageSource` instances keyed by
+ * `StorageSourceDefinition.key`. Collection properties reference
+ * a source by key via `StorageConfig.storageSource`.
+ *
+ * Typical bootstrap flow:
+ * 1. Fetch definitions from `GET /api/storage/sources`
+ * 2. Build server-backed sources automatically via `createStorage(transport, key)`
+ * 3. Register "direct" sources manually (e.g. Firebase Storage hook)
+ */
+import type { StorageSource, StorageSourceRegistry, StorageSourceDefinition } from "@rebasepro/types";
+import type { Transport } from "./transport";
+/**
+ * Default implementation of the client-side `StorageSourceRegistry`.
+ */
+export declare class ClientStorageSourceRegistry implements StorageSourceRegistry {
+    private sources;
+    /**
+     * Register a storage source.
+     * @param key - Unique key matching a `StorageSourceDefinition.key`
+     * @param source - The `StorageSource` instance
+     */
+    register(key: string, source: StorageSource): void;
+    getDefault(): StorageSource;
+    get(key: string | undefined | null): StorageSource | undefined;
+    getOrDefault(key: string | undefined | null): StorageSource;
+    has(key: string): boolean;
+    list(): string[];
+    /**
+     * Build a registry from `StorageSourceDefinition[]` and an HTTP transport.
+     *
+     * - Sources with `transport: "server"` are auto-wired via `createStorage(transport, key)`.
+     * - Sources with `transport: "direct"` are **not** auto-wired — they must
+     *   be registered manually after this call (e.g. via a Firebase hook).
+     *
+     * @param definitions - Array of storage source definitions
+     * @param transport - HTTP transport for server-backed sources
+     */
+    static fromDefinitions(definitions: StorageSourceDefinition[], transport: Transport): ClientStorageSourceRegistry;
+}

package/dist/storage.d.ts

@@ -1,3 +1,11 @@
 import { StorageSource } from "@rebasepro/types";
 import { Transport } from "./transport";
-export declare function createStorage(transport: Transport): StorageSource;
+/**
+ * Create a StorageSource that talks to the Rebase backend REST API.
+ *
+ * @param transport - HTTP transport instance
+ * @param storageId - Optional storage-source key for multi-backend routing.
+ *                    When set, it is forwarded to the server so the correct
+ *                    `StorageController` is resolved from the registry.
+ */
+export declare function createStorage(transport: Transport, storageId?: string): StorageSource;

package/dist/transport.d.ts

@@ -1,4 +1,6 @@
 import { FindParams as TypesFindParams, FindResponse as TypesFindResponse } from "@rebasepro/types";
+export { RebaseApiError } from "@rebasepro/types";
+export type { RebaseErrorInit } from "@rebasepro/types";
 export interface RebaseClientConfig {
     baseUrl?: string;
     token?: string;
@@ -12,12 +14,6 @@ export interface RebaseClientConfig {
  */
 export type FindParams = TypesFindParams;
 export type FindResponse<T> = TypesFindResponse<T extends Record<string, unknown> ? T : Record<string, unknown>>;
-export declare class RebaseApiError extends Error {
-    status: number;
-    code?: string;
-    details?: unknown;
-    constructor(status: number, message: string, code?: string, details?: unknown);
-}
 export declare function buildQueryString(params?: FindParams): string;
 export interface Transport {
     request: <T = unknown>(path: string, init?: RequestInit) => Promise<T>;

package/dist/websocket.d.ts

@@ -1,4 +1,4 @@
-import { DeleteEntityProps, Entity, EntityCollection, FetchCollectionProps, FetchEntityProps, SaveEntityProps, TableMetadata, BranchInfo } from "@rebasepro/types";
+import { DeleteProps, CollectionConfig, FetchCollectionProps, FetchOneProps, SaveProps, TableMetadata, BranchInfo } from "@rebasepro/types";
 export interface RebaseWebSocketConfig {
     websocketUrl: string;
     /** Optional auth token getter for WebSocket authentication */
@@ -8,11 +8,15 @@ export interface RebaseWebSocketConfig {
     /** Callback to handle unauthorized requests or token expiration (refreshes auth session) */
     onUnauthorized?: () => Promise<boolean>;
 }
-export declare class ApiError extends Error {
-    code?: string;
-    error?: string;
-    constructor(message: string, error?: string, code?: string);
-}
+/**
+ * Low-level realtime WebSocket client.
+ *
+ * @internal Not a stable app-facing API. `createRebaseClient()` constructs and
+ * manages this internally (exposed as `client.ws`, typed by the minimal
+ * `RebaseWebSocket` contract in `@rebasepro/types`). It is re-exported from the
+ * package root only because the `@rebasepro/client-postgresql` driver
+ * instantiates it directly; its surface may change without a major bump.
+ */
 export declare class RebaseWebSocketClient {
     private websocketUrl;
     private ws;
@@ -22,7 +26,7 @@ export declare class RebaseWebSocketClient {
     on(event: "connect" | "disconnect" | "reconnect" | "error", cb: (...args: unknown[]) => void): () => boolean;
     private emit;
     private collectionSubscriptions;
-    private entitySubscriptions;
+    private singleSubscriptions;
     private backendToCollectionKey;
     private backendToEntityKey;
     private pendingRequests;
@@ -53,7 +57,7 @@ export declare class RebaseWebSocketClient {
     private isAuthError;
     private handleAuthFailure;
     /**
-     * Shared logic for re-subscribing a collection or entity subscription
+     * Shared logic for re-subscribing a collection or row subscription
      * after an auth error is resolved by refreshing credentials.
      */
     private resubscribeAfterAuthRefresh;
@@ -62,10 +66,10 @@ export declare class RebaseWebSocketClient {
     reauthenticate(): Promise<void>;
     private sendMessage;
     private doSendMessage;
-    fetchCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<Entity<M>[]>;
-    fetchEntity<M extends Record<string, unknown>>(props: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
-    saveEntity<M extends Record<string, unknown>>(props: SaveEntityProps<M>): Promise<Entity<M>>;
-    deleteEntity<M extends Record<string, unknown>>(props: DeleteEntityProps<M>): Promise<void>;
+    fetchCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<Record<string, unknown>[]>;
+    fetchOne<M extends Record<string, unknown>>(props: FetchOneProps<M>): Promise<Record<string, unknown> | undefined>;
+    save<M extends Record<string, unknown>>(props: SaveProps<M>): Promise<Record<string, unknown>>;
+    delete<M extends Record<string, unknown>>(props: DeleteProps<M>): Promise<void>;
     executeSql(sql: string, options?: {
         database?: string;
         role?: string;
@@ -73,8 +77,8 @@ export declare class RebaseWebSocketClient {
     fetchAvailableDatabases(): Promise<string[]>;
     fetchAvailableRoles(): Promise<string[]>;
     fetchCurrentDatabase(): Promise<string | undefined>;
-    checkUniqueField(path: string, name: string, value: unknown, entityId?: string, collection?: EntityCollection): Promise<boolean>;
-    countEntities<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<number>;
+    checkUniqueField(path: string, name: string, value: unknown, id?: string, collection?: CollectionConfig): Promise<boolean>;
+    count<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<number>;
     fetchUnmappedTables(mappedPaths?: string[]): Promise<string[]>;
     fetchTableMetadata(tableName: string): Promise<TableMetadata>;
     createBranch(name: string, options?: {
@@ -89,14 +93,14 @@ export declare class RebaseWebSocketClient {
     private deepEqual;
     private normalizeForComparison;
     /**
-     * Merge incoming entities with cached data, preserving cached references
-     * for entities whose values haven't changed. This avoids unnecessary
-     * React re-renders when the server refetches all entities but most
+     * Merge incoming rows with cached data, preserving cached references
+     * for rows whose values haven't changed. This avoids unnecessary
+     * React re-renders when the server refetches all rows but most
      * haven't actually changed.
      */
-    private mergeEntities;
-    listenCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>, onUpdate: (entities: Entity[]) => void, onError?: (error: Error) => void): () => void;
-    listenEntity<M extends Record<string, unknown>>(props: FetchEntityProps<M>, onUpdate: (entity: Entity | null) => void, onError?: (error: Error) => void): () => void;
+    private mergeRows;
+    listenCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>, onUpdate: (rows: Record<string, unknown>[]) => void, onError?: (error: Error) => void): () => void;
+    listenOne<M extends Record<string, unknown>>(props: FetchOneProps<M>, onUpdate: (row: Record<string, unknown> | null) => void, onError?: (error: Error) => void): () => void;
     /**
      * Re-send all active subscriptions to the backend after a reconnect.
      * The server wipes subscription state when a client disconnects, so
@@ -104,5 +108,5 @@ export declare class RebaseWebSocketClient {
      */
     private resubscribeAll;
     private createCollectionSubscriptionKey;
-    private createEntitySubscriptionKey;
+    private createSingleSubscriptionKey;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/client",
   "type": "module",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "HTTP SDK client for the Rebase custom backend",
   "funding": {
     "url": "https://github.com/sponsors/rebaseco"
@@ -20,13 +20,6 @@
   "engines": {
     "node": ">=14"
   },
-  "scripts": {
-    "watch": "vite build --watch",
-    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
-    "test:lint": "eslint \"src/**\" --quiet",
-    "test": "jest --passWithNoTests --forceExit",
-    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
-  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -37,9 +30,9 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@rebasepro/common": "workspace:*",
-    "@rebasepro/types": "workspace:*",
-    "@rebasepro/utils": "workspace:*"
+    "@rebasepro/types": "0.9.0",
+    "@rebasepro/utils": "0.9.0",
+    "@rebasepro/common": "0.9.0"
   },
   "devDependencies": {
     "@jest/globals": "^30.4.1",
@@ -75,8 +68,16 @@
     ],
     "testEnvironment": "node",
     "moduleNameMapper": {
+      "^@rebasepro/common$": "<rootDir>/../common/src/index.ts",
       "^@rebasepro/types$": "<rootDir>/../types/src/index.ts",
       "^@rebasepro/utils$": "<rootDir>/../utils/src/index.ts"
     }
+  },
+  "scripts": {
+    "watch": "vite build --watch",
+    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
+    "test:lint": "eslint \"src/**\" --quiet",
+    "test": "jest --passWithNoTests --forceExit",
+    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
   }
-}
+}

package/src/api-keys.ts

@@ -15,6 +15,7 @@ export interface ApiKeyMasked {
     name: string;
     key_prefix: string;
     permissions: ApiKeyPermission[];
+    admin: boolean;
     rate_limit: number | null;
     created_by: string;
     created_at: string;