@rebasepro/types 0.8.0 → 0.9.0

package/src/controllers/client.ts

@@ -1,5 +1,5 @@
 import type { User } from "../users";
-import type { RebaseData } from "./data";
+import type { RebaseSdkData } from "./data";
 import type { EmailService } from "./email";
 import type { StorageSource } from "./storage";
 import type { CronJobStatus, CronJobLogEntry } from "../types/cron";
@@ -13,7 +13,10 @@ import type { StorageSourceDefinition } from "../types/storage_source";
 export type AuthChangeEvent = "SIGNED_IN" | "SIGNED_OUT" | "TOKEN_REFRESHED" | "USER_UPDATED";
 
 /**
- * Standard session interface representing an authenticated state
+ * Standard session interface representing an authenticated state.
+ *
+ * There is exactly one canonical definition of this type (here in
+ * `@rebasepro/types`). The `@rebasepro/client` package re-exports it.
  */
 export interface RebaseSession {
     accessToken: string;
@@ -22,6 +25,38 @@ export interface RebaseSession {
     user: User;
 }
 
+/**
+ * Access and refresh token pair returned by authentication endpoints.
+ *
+ * Replaces the former `RebaseTokens` (client) and `AuthTokens` (auth) types,
+ * which had identical shapes.
+ *
+ * @group Auth
+ */
+export interface AuthTokens {
+    accessToken: string;
+    refreshToken: string;
+    /** Unix timestamp (ms) when the access token expires. */
+    accessTokenExpiresAt: number;
+}
+
+/**
+ * A device-level session entry as returned by `GET /auth/sessions`.
+ *
+ * Represents one refresh-token / device pair. Not to be confused with
+ * {@link RebaseSession}, which is the client-side representation of the
+ * *current* authenticated state (user + tokens).
+ *
+ * @group Auth
+ */
+export interface DeviceSession {
+    id: string;
+    userAgent?: string;
+    ipAddress?: string;
+    createdAt: string;
+    isCurrentSession?: boolean;
+}
+
 /**
  * Unified Authentication Client Interface
  * Pure functional SDK interface, decoupled from UI and React hooks
@@ -37,6 +72,13 @@ export interface AuthClient {
      */
     getSession(): RebaseSession | null;
 
+    /**
+     * Get the current user's active sessions
+     */
+    getSessions?: () => Promise<DeviceSession[]>;
+    revokeSession?: (sessionId: string) => Promise<void>;
+    revokeAllSessions?: () => Promise<void>;
+
     /**
      * Sign out the current user and clear local session
      */
@@ -56,7 +98,14 @@ export interface AuthClient {
 // ─── Admin API ───────────────────────────────────────────────────────────────
 
 /**
- * User record as returned by the Admin API.
+ * User record as returned by the Admin API (`GET /admin/users`, etc.).
+ *
+ * This is a dedicated DTO for admin operations and differs from {@link User}:
+ * - `roles` is required (always an array), vs optional on `User`
+ * - Includes audit timestamps (`createdAt`, `updatedAt`) as ISO strings
+ * - `email` is non-nullable (admin users always have an email)
+ *
+ * @see User — the canonical client-facing user type
  * @group Admin
  */
 export interface AdminUser {
@@ -64,7 +113,11 @@ export interface AdminUser {
     email: string;
     displayName: string | null;
     photoURL: string | null;
-    provider: string;
+    /**
+     * The provider used to authenticate the user (e.g. `"password"`,
+     * `"google"`). Named to match the canonical {@link User.providerId}.
+     */
+    providerId: string;
     roles: string[];
     metadata?: Record<string, any>;
     createdAt: string;
@@ -139,6 +192,35 @@ export interface FunctionsAPI {
     invoke<T = unknown>(name: string, payload?: unknown, options?: FunctionInvokeOptions): Promise<T>;
 }
 
+// ─── HistoryConfig ───────────────────────────────────────────────────────────
+
+/**
+ * Configuration for entity history / audit-log tracking.
+ *
+ * - `true` — enable history with default settings
+ * - `{ retention?: number }` — enable with optional retention period in days
+ */
+export type HistoryConfig = boolean | { retention?: number };
+
+// ─── RebaseWebSocket ─────────────────────────────────────────────────────────
+
+/**
+ * Minimal WebSocket client contract exposed on {@link RebaseClient}.
+ *
+ * The full implementation (`RebaseWebSocketClient` in `@rebasepro/client`)
+ * adds subscription helpers, CRUD-over-WS, SQL execution, etc.
+ */
+export interface RebaseWebSocket {
+    /** Disconnect the WebSocket and stop reconnecting. */
+    disconnect(): void;
+    /** Send an authentication token to the server. */
+    authenticate(token: string): Promise<void>;
+    /** Set a function that lazily resolves the auth token for auto-authentication. */
+    setAuthTokenGetter(getter: () => Promise<string | null>): void;
+    /** Listen for connection lifecycle events. */
+    on(event: "connect" | "disconnect" | "reconnect" | "error", cb: (...args: unknown[]) => void): () => void;
+}
+
 // ─── RebaseClient ────────────────────────────────────────────────────────────
 
 /**
@@ -153,7 +235,25 @@ export interface FunctionsAPI {
  */
 export interface RebaseClient<DB = unknown> {
     /** Unified Data access layer */
-    data: RebaseData;
+    data: RebaseSdkData<DB>;
+
+    /**
+     * Admin-scoped, **RLS-bypassing** data accessor.
+     *
+     * Present on the **server** singleton only (see {@link RebaseServerClient}).
+     * It runs with `{ uid: "service", roles: ["admin"] }` — every read and write
+     * bypasses row-level-security policies. This is the correct tool for trusted
+     * background work (cron jobs, migrations, service-to-service tasks).
+     *
+     * ⚠️ **Do NOT use it to serve user-facing data.** Inside a request handler,
+     * user-scoped queries must go through the request-scoped driver
+     * (`c.var.driver`), which carries the caller's identity so RLS applies.
+     * Reaching for `dataAsAdmin` (or its alias {@link data}) in a request handler
+     * silently exposes every row to every caller.
+     *
+     * Undefined in the browser SDK.
+     */
+    dataAsAdmin?: RebaseSdkData<DB>;
 
     /** Unified Authentication layer */
     auth: AuthClient;
@@ -205,7 +305,7 @@ export interface RebaseClient<DB = unknown> {
     baseUrl?: string;
 
     /** WebSocket client for realtime subscriptions */
-    ws?: unknown;
+    ws?: RebaseWebSocket;
 
     /** Set the auth token for subsequent requests */
     setToken?(token: string | null): void;
@@ -229,6 +329,114 @@ export interface RebaseClient<DB = unknown> {
     sql?(query: string, options?: { database?: string; role?: string }): Promise<Record<string, unknown>[]>;
 }
 
+// ─── RebaseServerClient ──────────────────────────────────────────────────────
+
+/**
+ * The server-side Rebase surface — the shape of the `rebase` singleton exported
+ * from `@rebasepro/server-core`.
+ *
+ * Narrows {@link RebaseClient} to the guarantees that always hold on the server:
+ * the admin-scoped {@link dataAsAdmin} accessor, raw {@link sql}, and the
+ * {@link email} service are all present (non-optional).
+ *
+ * **Trust levels.** Both {@link dataAsAdmin} and the deprecated {@link data}
+ * alias point at the same admin-scoped, **RLS-bypassing** driver. Prefer
+ * `dataAsAdmin` so the privilege is explicit at every call site. For user-scoped
+ * queries inside a request handler use the request-scoped driver
+ * (`c.var.driver`) instead — never `dataAsAdmin`/`data`.
+ */
+export interface RebaseServerClient<DB = unknown> extends RebaseClient<DB> {
+    /**
+     * @deprecated On the server, prefer {@link dataAsAdmin} for admin scope or
+     * the request-scoped driver (`c.var.driver`) for user scope. This alias
+     * points at the same admin-scoped, RLS-bypassing accessor as `dataAsAdmin`.
+     */
+    data: RebaseSdkData<DB>;
+
+    /**
+     * Admin-scoped, **RLS-bypassing** data accessor. Always present server-side.
+     * See {@link RebaseClient.dataAsAdmin} for the full safety contract.
+     */
+    dataAsAdmin: RebaseSdkData<DB>;
+
+    /**
+     * Server-side email service. Always present server-side (a no-op sender is
+     * wired when SMTP is not configured).
+     */
+    email: EmailService;
+
+    /**
+     * Execute raw SQL against the database. Always present server-side for SQL
+     * engines.
+     */
+    sql(query: string, options?: { database?: string; role?: string }): Promise<Record<string, unknown>[]>;
+}
+
+// ─── RebaseBrowserClient ─────────────────────────────────────────────────────
+
+/**
+ * The browser-side Rebase surface — the shape produced by
+ * `createRebaseClient()` in `@rebasepro/client`.
+ *
+ * Its {@link data} accessor is **user-scoped**: every call carries the signed-in
+ * user's token, so backend RLS policies apply. It deliberately omits the
+ * server-only members — there is no `sql`, no `email`, and no
+ * `dataAsAdmin`, so the RLS-bypassing accessor can never be reached from
+ * browser code.
+ */
+export interface RebaseBrowserClient<DB = unknown> {
+    /** User-scoped data access layer (carries the signed-in user's token). */
+    data: RebaseSdkData<DB>;
+
+    /** Unified Authentication layer */
+    auth: AuthClient;
+
+    /** Unified Storage layer (default storage source, backward-compatible) */
+    storage?: StorageSource;
+
+    /** Registry of all named storage sources for multi-backend support */
+    storageRegistry?: StorageSourceRegistry;
+
+    /** Build a server-backed {@link StorageSource} for a named storage source. */
+    createStorageSource?(storageId: string): StorageSource;
+
+    /** Discover the storage sources declared on the backend. */
+    fetchStorageSources?(): Promise<StorageSourceDefinition[]>;
+
+    /** Admin API for user management */
+    admin?: AdminAPI;
+
+    /** Cron job management API */
+    cron?: CronAPI;
+
+    /** Custom backend functions API */
+    functions?: FunctionsAPI;
+
+    /** Service API keys management API */
+    apiKeys?: ApiKeysAPI;
+
+    /** Base HTTP URL of the backend server */
+    baseUrl?: string;
+
+    /** WebSocket client for realtime subscriptions */
+    ws?: RebaseWebSocket;
+
+    /** Set the auth token for subsequent requests */
+    setToken?(token: string | null): void;
+
+    /** Set a function that lazily resolves the auth token */
+    setAuthTokenGetter?(getter: () => Promise<string | null>): void;
+
+    /** Set handler called when a request returns 401 */
+    setOnUnauthorized?(handler: () => Promise<boolean>): void;
+
+    /** Resolve the current auth token */
+    resolveToken?(): Promise<string | null>;
+
+    /** Make a raw HTTP call to the backend */
+    call?<T = unknown>(endpoint: string, payload?: unknown): Promise<T>;
+}
+
 /**
  * Client-side registry for managing multiple storage sources.
  *

package/src/controllers/collection_registry.ts

@@ -1,4 +1,4 @@
-import type { EntityCollection } from "../types/collections";
+import type { CollectionConfig } from "../types/collections";
 import type { EntityReference } from "../types/entities";
 
 /**
@@ -7,7 +7,7 @@ import type { EntityReference } from "../types/entities";
  */
 export type CollectionRegistryController<
     DB = Record<string, unknown>,
-    EC extends EntityCollection = EntityCollection
+    EC extends CollectionConfig = CollectionConfig
 > = {
 
     /**
@@ -16,7 +16,7 @@ export type CollectionRegistryController<
      * Each of the navigation entries in this field
      * generates an entry in the main menu.
      */
-    collections?: EntityCollection[];
+    collections?: CollectionConfig[];
 
     /**
      * Is the registry ready to be used

package/src/controllers/customization_controller.tsx

@@ -30,7 +30,7 @@ export type CustomizationController = {
      * You can use the key to reference the custom view in
      * the `entityViews` prop of a collection.
      *
-     * You can also define an entity view from the UI.
+     * You can also define a entity view from the UI.
      */
     entityViews?: EntityCustomView[];