@rebasepro/types 0.8.0 → 0.9.1-canary.09aaf62

package/src/types/auth_adapter.ts

@@ -17,7 +17,7 @@
  *
  * @example Custom auth
  * ```ts
- * import { createCustomAuthAdapter } from "@rebasepro/server-core";
+ * import { createCustomAuthAdapter } from "@rebasepro/server";
  *
  * initializeRebaseBackend({
  *   auth: createCustomAuthAdapter({
@@ -85,8 +85,25 @@ export interface AuthAdapterCapabilities {
     emailPasswordLogin: boolean;
     /** Supports new user registration. */
     registration: boolean;
-    /** Supports password reset flow. */
+    /**
+     * Supports the end-user password reset flow (emailing a reset link).
+     *
+     * This is about *self-service* reset, so it is typically tied to whether an
+     * email service is configured. It says nothing about whether an admin can
+     * reset someone else's password — see `adminPasswordReset`.
+     */
     passwordReset: boolean;
+    /**
+     * Whether the adapter exposes `POST /admin/users/:userId/reset-password`,
+     * letting an admin reset another user's password.
+     *
+     * Independent of `passwordReset`: the built-in adapter supports this even
+     * with no email service configured (it returns a one-time temporary
+     * password instead of sending a link). Adapters that mount their own admin
+     * routes must set this to `true` only once that route actually exists —
+     * the admin UI hides the "Reset Password" action when it is `false`.
+     */
+    adminPasswordReset: boolean;
     /** Supports session listing/revocation. */
     sessionManagement: boolean;
     /** Supports profile updates (display name, photo). */
@@ -218,6 +235,11 @@ export interface UserCreationFinalizeResult {
     temporaryPassword?: string;
     /** Whether an invitation email was sent. */
     invitationSent: boolean;
+    /**
+     * Whether an email service was configured but delivery failed, causing the
+     * fallback to `temporaryPassword`. Absent when no email service is configured.
+     */
+    emailDeliveryFailed?: boolean;
 }
 
 // ─── Auth Response Transform ─────────────────────────────────────────────────
@@ -237,6 +259,9 @@ export interface AuthResponsePayload {
         email: string;
         displayName: string | null;
         photoURL: string | null;
+        providerId?: string;
+        isAnonymous?: boolean;
+        emailVerified?: boolean;
         roles: string[];
         metadata: Record<string, unknown>;
     };
@@ -295,7 +320,7 @@ export interface AuthAdapter {
     /**
      * Verify an incoming request and extract the authenticated user.
      *
-     * This replaces the hardcoded JWT verification in server-core's middleware.
+     * This replaces the hardcoded JWT verification in server's middleware.
      * Each adapter implements its own token verification strategy:
      * - Built-in: verify Rebase JWT
      * - Clerk: call Clerk's `verifyToken()`
@@ -393,7 +418,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>,

package/src/types/backend.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";
 
 // =============================================================================
 // DATABASE CONNECTION INTERFACES
@@ -52,7 +52,7 @@ export interface FetchCollectionOptions<M extends Record<string, unknown> = Reco
     startAfter?: unknown;
     searchString?: string;
     databaseId?: string;
-    collection?: EntityCollection;
+    collection?: CollectionConfig;
 }
 
 /**
@@ -64,7 +64,7 @@ export interface SearchOptions<M extends Record<string, unknown> = Record<string
     order?: "desc" | "asc";
     limit?: number;
     databaseId?: string;
-    collection?: EntityCollection;
+    collection?: CollectionConfig;
 }
 
 /**
@@ -150,15 +150,15 @@ 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>>(
+    fetchOne<M extends Record<string, unknown>>(
         collectionPath: string,
-        entityId: string | number,
+        id: string | number,
         databaseId?: string
-    ): Promise<Entity<M> | undefined>;
+    ): Promise<Record<string, unknown> | undefined>;
 
     /**
      * Fetch a collection of entities with optional filtering, ordering, and pagination
@@ -166,41 +166,41 @@ export interface EntityRepository {
     fetchCollection<M extends Record<string, unknown>>(
         collectionPath: string,
         options?: FetchCollectionOptions<M>
-    ): Promise<Entity<M>[]>;
+    ): Promise<Record<string, unknown>[]>;
 
     /**
      * Search entities by text
      */
-    searchEntities<M extends Record<string, unknown>>(
+    searchRows<M extends Record<string, unknown>>(
         collectionPath: string,
         searchString: string,
         options?: SearchOptions<M>
-    ): Promise<Entity<M>[]>;
+    ): Promise<Record<string, unknown>[]>;
 
     /**
      * Count entities in a collection
      */
-    countEntities<M extends Record<string, unknown>>(
+    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>>(
+    save<M extends Record<string, unknown>>(
         collectionPath: string,
         values: Partial<M>,
-        entityId?: string | number,
+        id?: string | number,
         databaseId?: string
-    ): Promise<Entity<M>>;
+    ): Promise<Record<string, unknown>>;
 
     /**
-     * Delete an entity by ID
+     * Delete a entity by ID
      */
-    deleteEntity(
+    delete(
         collectionPath: string,
-        entityId: string | number,
+        id: string | number,
         databaseId?: string
     ): Promise<void>;
 
@@ -239,10 +239,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;
 }
 
 /**
@@ -256,16 +256,16 @@ export interface RealtimeProvider {
     subscribeToCollection(
         subscriptionId: string,
         config: CollectionSubscriptionConfig,
-        callback?: (entities: Entity[]) => void
+        callback?: (rows: Record<string, unknown>[]) => void
     ): void;
 
     /**
      * Subscribe to single entity changes
      */
-    subscribeToEntity(
+    subscribeToOne(
         subscriptionId: string,
-        config: EntitySubscriptionConfig,
-        callback?: (entity: Entity | null) => void
+        config: SingleSubscriptionConfig,
+        callback?: (row: Record<string, unknown> | null) => void
     ): void;
 
     /**
@@ -274,12 +274,12 @@ export interface RealtimeProvider {
     unsubscribe(subscriptionId: string): void;
 
     /**
-     * Notify all relevant subscribers of an entity update
+     * Notify all relevant subscribers of a entity update
      */
-    notifyEntityUpdate(
+    notifyUpdate(
         path: string,
-        entityId: string,
-        entity: Entity | null,
+        id: string,
+        row: Record<string, unknown> | null,
         databaseId?: string
     ): Promise<void>;
 
@@ -314,17 +314,17 @@ 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.
@@ -346,7 +346,7 @@ export interface DataTransformer {
      */
     serializeToDatabase<M extends Record<string, unknown>>(
         entity: M,
-        collection: EntityCollection
+        collection: CollectionConfig
     ): Record<string, unknown>;
 
     /**
@@ -354,7 +354,7 @@ export interface DataTransformer {
      */
     deserializeFromDatabase<M extends Record<string, unknown>>(
         data: Record<string, unknown>,
-        collection: EntityCollection
+        collection: CollectionConfig
     ): Promise<M>;
 }
 
@@ -589,7 +589,7 @@ export interface BackendInstance extends BackendLifecycle {
     /**
      * Entity repository for CRUD operations
      */
-    entityRepository: EntityRepository;
+    entityRepository: DataRepository;
 
     /**
      * Realtime provider for subscriptions
@@ -697,7 +697,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<{ historyService: unknown } | undefined>;
+    initializeHistory?(config: HistoryConfig, driverResult: InitializedDriver): Promise<{ historyService: unknown } | undefined>;
 
     /**
      * Create a realtime provider for this driver.
@@ -736,6 +736,14 @@ export interface InitializedDriver {
     /** A collection registry to register schema / tables into. */
     collectionRegistry?: CollectionRegistryInterface;
 
+    /**
+     * Collections the driver derived from the live database schema.
+     *
+     * Set by drivers that introspect in `baas` mode; the server serves these
+     * instead of collections loaded from config files.
+     */
+    collections?: import("./collections").CollectionConfig[];
+
     /** The underlying database connection (for lifecycle management). */
     connection?: DatabaseConnection;
 

package/src/types/backup.ts

@@ -0,0 +1,26 @@
+/**
+ * Backup type definitions shared across server, client, and studio.
+ */
+
+/** Where a backup lives — a local path or an object-storage bucket. */
+export type BackupDestinationKind = "local" | "s3" | "gcs";
+
+/**
+ * A single backup as surfaced by the admin API / Studio Backups panel.
+ */
+export interface BackupInfo {
+    /** Storage key (object storage) or absolute file path (local). */
+    key: string;
+
+    /** Display name — the file's basename. */
+    name: string;
+
+    /** Size in bytes, when known. */
+    sizeBytes?: number;
+
+    /** ISO timestamp the backup was created, when recoverable. */
+    createdAt?: string;
+
+    /** The kind of destination this backup was read from. */
+    destinationKind: BackupDestinationKind;
+}

package/src/types/builders.ts

@@ -1,10 +1,10 @@
 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