@rebasepro/types 0.7.0 → 0.9.0

package/dist/types/auth_adapter.d.ts

@@ -4,8 +4,8 @@
  * Pluggable authentication abstraction for Rebase.
  *
  * An `AuthAdapter` decouples authentication from the database layer,
- * allowing users to bring their own auth system (Clerk, Auth0, Firebase Auth,
- * custom JWT, etc.) while keeping the Rebase admin frontend fully functional.
+ * allowing users to bring their own auth system (Clerk, Auth0, or other
+ * external providers) while keeping the Rebase admin frontend fully functional.
  *
  * @example Built-in auth (default — zero config change)
  * ```ts
@@ -212,6 +212,9 @@ export interface AuthResponsePayload {
         email: string;
         displayName: string | null;
         photoURL: string | null;
+        providerId?: string;
+        isAnonymous?: boolean;
+        emailVerified?: boolean;
         roles: string[];
         metadata: Record<string, unknown>;
     };
@@ -248,7 +251,7 @@ export interface TransformAuthResponseContext {
  * 4. Advertise its capabilities so the frontend can adapt
  *
  * The built-in Rebase auth implements this interface internally.
- * External providers (Clerk, Auth0, Firebase Auth) provide their own adapters.
+ * External providers (Clerk, Auth0, or others) provide their own adapters.
  * Users with custom auth can use `createCustomAuthAdapter()` for a minimal setup.
  *
  * @group Auth
@@ -257,7 +260,7 @@ export interface AuthAdapter {
     /**
      * Unique identifier for this auth adapter.
      *
-     * @example "rebase-builtin", "clerk", "auth0", "firebase", "custom"
+     * @example "rebase-builtin", "clerk", "auth0", "external-provider", "custom"
      */
     readonly id: string;
     /**
@@ -343,7 +346,7 @@ export interface AuthAdapter {
      *
      * @param values - Raw request body from the client.
      * @param collectionAuth - The parsed `AuthCollectionConfig` from the collection (if `auth` is an object).
-     * @returns Processed values ready for `driver.saveEntity()`, plus metadata for the post-save step.
+     * @returns Processed values ready for `driver.save()`, plus metadata for the post-save step.
      */
     prepareUserCreation?(values: Record<string, unknown>, collectionAuth?: unknown): Promise<UserCreationPrepareResult>;
     /**
@@ -375,7 +378,7 @@ export interface AuthAdapter {
      * response and returns a (potentially enriched) response.
      *
      * Use cases:
-     * - Inject tokens from external auth systems (Firebase Custom Tokens, etc.)
+     * - Inject tokens from external auth systems (custom provider tokens, etc.)
      * - Add project-specific metadata to the response
      * - Enrich the user object with data from external sources
      *

package/dist/types/backend.d.ts

@@ -1,6 +1,6 @@
-import type { Entity } from "./entities";
-import type { EntityCollection, FilterValues, WhereFilterOp } from "./collections";
+import type { CollectionConfig, FilterValues, WhereFilterOp } from "./collections";
 import type { AuthAdapter } from "./auth_adapter";
+import type { HistoryConfig } from "../controllers/client";
 /**
  * Abstract database connection interface.
  * Represents a connection to any database system.
@@ -39,7 +39,7 @@ export interface FetchCollectionOptions<M extends Record<string, unknown> = Reco
     startAfter?: unknown;
     searchString?: string;
     databaseId?: string;
-    collection?: EntityCollection;
+    collection?: CollectionConfig;
 }
 /**
  * Options for searching entities
@@ -50,7 +50,7 @@ export interface SearchOptions<M extends Record<string, unknown> = Record<string
     order?: "desc" | "asc";
     limit?: number;
     databaseId?: string;
-    collection?: EntityCollection;
+    collection?: CollectionConfig;
 }
 /**
  * Options for counting entities
@@ -110,31 +110,31 @@ export type ConditionBuilderStatic<T = unknown> = {
  * - Relation resolution
  * - ID generation and conversion
  */
-export interface EntityRepository {
+export interface DataRepository {
     /**
      * Fetch a single entity by ID
      */
-    fetchEntity<M extends Record<string, unknown>>(collectionPath: string, entityId: string | number, databaseId?: string): Promise<Entity<M> | undefined>;
+    fetchOne<M extends Record<string, unknown>>(collectionPath: string, id: string | number, databaseId?: string): Promise<Record<string, unknown> | undefined>;
     /**
      * Fetch a collection of entities with optional filtering, ordering, and pagination
      */
-    fetchCollection<M extends Record<string, unknown>>(collectionPath: string, options?: FetchCollectionOptions<M>): Promise<Entity<M>[]>;
+    fetchCollection<M extends Record<string, unknown>>(collectionPath: string, options?: FetchCollectionOptions<M>): Promise<Record<string, unknown>[]>;
     /**
      * Search entities by text
      */
-    searchEntities<M extends Record<string, unknown>>(collectionPath: string, searchString: string, options?: SearchOptions<M>): Promise<Entity<M>[]>;
+    searchRows<M extends Record<string, unknown>>(collectionPath: string, searchString: string, options?: SearchOptions<M>): Promise<Record<string, unknown>[]>;
     /**
      * Count entities in a collection
      */
-    countEntities<M extends Record<string, unknown>>(collectionPath: string, options?: CountOptions<M>): Promise<number>;
+    count<M extends Record<string, unknown>>(collectionPath: string, options?: CountOptions<M>): Promise<number>;
     /**
-     * Save an entity (create or update)
+     * Save a entity (create or update)
      */
-    saveEntity<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, entityId?: string | number, databaseId?: string): Promise<Entity<M>>;
+    save<M extends Record<string, unknown>>(collectionPath: string, values: Partial<M>, id?: string | number, databaseId?: string): Promise<Record<string, unknown>>;
     /**
-     * Delete an entity by ID
+     * Delete a entity by ID
      */
-    deleteEntity(collectionPath: string, entityId: string | number, databaseId?: string): Promise<void>;
+    delete(collectionPath: string, id: string | number, databaseId?: string): Promise<void>;
     /**
      * Check if a field value is unique in a collection
      */
@@ -157,10 +157,10 @@ export interface CollectionSubscriptionConfig {
 /**
  * Configuration for subscribing to a single entity
  */
-export interface EntitySubscriptionConfig {
+export interface SingleSubscriptionConfig {
     clientId: string;
     path: string;
-    entityId: string | number;
+    id: string | number;
 }
 /**
  * Abstract realtime provider interface.
@@ -170,19 +170,19 @@ export interface RealtimeProvider {
     /**
      * Subscribe to collection changes
      */
-    subscribeToCollection(subscriptionId: string, config: CollectionSubscriptionConfig, callback?: (entities: Entity[]) => void): void;
+    subscribeToCollection(subscriptionId: string, config: CollectionSubscriptionConfig, callback?: (rows: Record<string, unknown>[]) => void): void;
     /**
      * Subscribe to single entity changes
      */
-    subscribeToEntity(subscriptionId: string, config: EntitySubscriptionConfig, callback?: (entity: Entity | null) => void): void;
+    subscribeToOne(subscriptionId: string, config: SingleSubscriptionConfig, callback?: (row: Record<string, unknown> | null) => void): void;
     /**
      * Unsubscribe from a subscription
      */
     unsubscribe(subscriptionId: string): void;
     /**
-     * Notify all relevant subscribers of an entity update
+     * Notify all relevant subscribers of a entity update
      */
-    notifyEntityUpdate(path: string, entityId: string, entity: Entity | null, databaseId?: string): Promise<void>;
+    notifyUpdate(path: string, id: string, row: Record<string, unknown> | null, databaseId?: string): Promise<void>;
     /**
      * Called when the HTTP server is ready and listening.
      * Useful for providers that need the server address for callbacks.
@@ -210,15 +210,19 @@ export interface CollectionRegistryInterface {
     /**
      * Register a collection
      */
-    register(collection: EntityCollection): void;
+    register(collection: CollectionConfig): void;
     /**
      * Get a collection by its path
      */
-    getCollectionByPath(path: string): EntityCollection | undefined;
+    getCollectionByPath(path: string): CollectionConfig | undefined;
     /**
      * Get all registered collections
      */
-    getCollections(): EntityCollection[];
+    getCollections(): CollectionConfig[];
+    /**
+     * Get the currently registered global callbacks, if any.
+     */
+    getGlobalCallbacks(): any | undefined;
 }
 /**
  * Abstract data transformer interface.
@@ -228,11 +232,11 @@ export interface DataTransformer {
     /**
      * Transform entity data for storage in the database
      */
-    serializeToDatabase<M extends Record<string, unknown>>(entity: M, collection: EntityCollection): Record<string, unknown>;
+    serializeToDatabase<M extends Record<string, unknown>>(entity: M, collection: CollectionConfig): Record<string, unknown>;
     /**
      * Transform database data back to entity format
      */
-    deserializeFromDatabase<M extends Record<string, unknown>>(data: Record<string, unknown>, collection: EntityCollection): Promise<M>;
+    deserializeFromDatabase<M extends Record<string, unknown>>(data: Record<string, unknown>, collection: CollectionConfig): Promise<M>;
 }
 /**
  * Administrative operations for SQL-based databases (PostgreSQL, MySQL, etc.).
@@ -423,7 +427,7 @@ export interface BackendInstance extends BackendLifecycle {
     /**
      * Entity repository for CRUD operations
      */
-    entityRepository: EntityRepository;
+    entityRepository: DataRepository;
     /**
      * Realtime provider for subscriptions
      */
@@ -514,7 +518,7 @@ export interface BackendBootstrapper {
      * Initialize history tables / services if this driver supports them.
      * Return undefined if history is not supported by this backend.
      */
-    initializeHistory?(config: unknown, driverResult: InitializedDriver): Promise<{
+    initializeHistory?(config: HistoryConfig, driverResult: InitializedDriver): Promise<{
         historyService: unknown;
     } | undefined>;
     /**

package/dist/types/builders.d.ts

@@ -1,9 +1,9 @@
 import type { AuthController } from "../controllers/auth";
 import type { RebaseData } from "../controllers/data";
 import type { User } from "../users";
-import type { EntityCollection } from "./collections";
+import type { CollectionConfig } from "./collections";
 import type { AppView } from "../controllers/navigation";
-export type EntityCollectionsBuilder<EC extends EntityCollection = EntityCollection> = (params: {
+export type CollectionConfigsBuilder<EC extends CollectionConfig = CollectionConfig> = (params: {
     user: User | null;
     authController: AuthController;
     data: RebaseData;