@rebasepro/types 0.7.0 → 0.9.0

package/src/users/user.ts

@@ -1,11 +1,18 @@
 
 /**
- * This interface represents a user.
- * It has some of the same fields as a Firebase User.
- * Note that in the default implementation, we simply take the Firebase user
- * and use it as a Rebase user, so that means that even if they are not mapped
- * in this interface, it contains all the methods of the former, such as `delete`,
- * `getIdToken`, etc.
+ * The canonical representation of an authenticated user in the Rebase ecosystem.
+ *
+ * Used by {@link AuthController}, collections, callbacks, and both the
+ * `@rebasepro/client` and `@rebasepro/auth` packages. All other user types
+ * (`RebaseUser`, `UserInfo`) are deprecated aliases of this type.
+ *
+ * **Backend-managed fields** (`uid`, `email`, `roles`, `metadata`, `createdAt`)
+ * are populated by the server. **Client-visible fields** (`displayName`,
+ * `photoURL`, `providerId`, `isAnonymous`, `emailVerified`) may be set during
+ * authentication or profile updates.
+ *
+ * @see AdminUser — the admin-API DTO, which adds audit fields (`createdAt`,
+ * `updatedAt`) and required `roles`.
  *
  * @group Models
  */
@@ -27,16 +34,22 @@ export type User = {
      */
     readonly photoURL: string | null;
     /**
-     * The provider used to authenticate the user.
+     * The provider used to authenticate the user (e.g. `"password"`,
+     * `"google"`, `"github"`).
      */
     readonly providerId: string;
     /**
-     *
+     * Whether the user is anonymous (created via anonymous sign-in).
      */
     readonly isAnonymous: boolean;
 
     /**
-     * Role IDs assigned to this user (e.g. ["admin", "editor"]).
+     * Whether the user's email address has been verified.
+     */
+    readonly emailVerified?: boolean;
+
+    /**
+     * Role IDs assigned to this user (e.g. `["admin", "editor"]`).
      */
     roles?: string[];
 

package/dist/types/backend_hooks.d.ts

@@ -1,109 +0,0 @@
-/**
- * Context passed to every backend hook.
- * Provides information about the request that triggered the hook.
- * @group Backend Hooks
- */
-export interface BackendHookContext {
-    /** The currently authenticated user making the request (if any) */
-    requestUser?: {
-        userId: string;
-        roles: string[];
-    };
-    /** The HTTP method of the request */
-    method: "GET" | "POST" | "PUT" | "DELETE";
-}
-/**
- * Hooks for intercepting collection entity data at the REST API boundary.
- *
- * These run **after** per-collection `EntityCallbacks` (which execute inside
- * the DataDriver) and provide a single cross-cutting interception point for
- * ALL collections flowing through the REST API.
- *
- * Every callback receives the collection `slug` so you can target specific
- * collections or apply logic globally.
- *
- * @group Backend Hooks
- */
-export interface DataHooks {
-    /**
-     * Transform an entity after it's read from the database,
-     * before it's returned to the client.
-     *
-     * Runs for both list (GET /:slug) and single (GET /:slug/:id) fetches.
-     * Return the modified entity, or `null` to filter it out.
-     *
-     * @param slug - The collection slug (e.g. "orders", "products")
-     * @param entity - The flattened entity object (id + values merged)
-     * @param context - Request context (authenticated user, HTTP method)
-     */
-    afterRead?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): Record<string, unknown> | null | Promise<Record<string, unknown> | null>;
-    /**
-     * Transform entity values before they are written to the database.
-     * Runs on POST (create) and PUT (update).
-     *
-     * Return the (possibly modified) values. Throw to abort the save.
-     *
-     * @param slug - The collection slug
-     * @param values - The raw request body values
-     * @param entityId - The entity ID (only present on updates)
-     * @param context - Request context
-     */
-    beforeSave?(slug: string, values: Record<string, unknown>, entityId: string | undefined, context: BackendHookContext): Record<string, unknown> | Promise<Record<string, unknown>>;
-    /**
-     * Called after an entity is successfully saved (created or updated).
-     * Useful for side-effects like syncing to external systems.
-     *
-     * @param slug - The collection slug
-     * @param entity - The saved entity (flattened)
-     * @param context - Request context
-     */
-    afterSave?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): void | Promise<void>;
-    /**
-     * Called before an entity is deleted. Throw to prevent deletion.
-     *
-     * @param slug - The collection slug
-     * @param entityId - The entity ID being deleted
-     * @param context - Request context
-     */
-    beforeDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
-    /**
-     * Called after an entity is successfully deleted.
-     *
-     * @param slug - The collection slug
-     * @param entityId - The deleted entity ID
-     * @param context - Request context
-     */
-    afterDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
-}
-/**
- * Backend-level hooks for intercepting data at the API boundary.
- *
- * These hooks run server-side after database operations complete and before
- * API responses are sent.
- *
- * `data` hooks complement per-collection `EntityCallbacks`. Entity callbacks
- * run inside the DataDriver (close to the DB); data hooks run at the HTTP
- * boundary (close to the client). Use data hooks for cross-cutting concerns
- * like audit logging, response enrichment, or field masking.
- *
- * @example
- * ```typescript
- * const hooks: BackendHooks = {
- *     data: {
- *         afterRead(slug, entity, ctx) {
- *             // Mask PII for non-admin users across all collections
- *             if (!ctx.requestUser?.roles.includes("admin") && entity.email) {
- *                 return { ...entity, email: "***" };
- *             }
- *             return entity;
- *         }
- *     }
- * };
- * ```
- *
- * @group Backend Hooks
- */
-export interface BackendHooks {
-    /** Hooks for intercepting ALL collection entity data via the REST API */
-    data?: DataHooks;
-}

package/dist/types/entity_overrides.d.ts

@@ -1,10 +0,0 @@
-import type { DataDriver } from "../controllers/data_driver";
-import type { StorageSource } from "../controllers/storage";
-export type EntityOverrides = {
-    /**
-     * Internal driver override for this collection.
-     * Used by the CMS engine to route data operations.
-     */
-    driver?: DataDriver;
-    storageSource?: StorageSource;
-};

package/src/types/backend_hooks.ts

@@ -1,114 +0,0 @@
-
-/**
- * Context passed to every backend hook.
- * Provides information about the request that triggered the hook.
- * @group Backend Hooks
- */
-export interface BackendHookContext {
-    /** The currently authenticated user making the request (if any) */
-    requestUser?: { userId: string; roles: string[] };
-    /** The HTTP method of the request */
-    method: "GET" | "POST" | "PUT" | "DELETE";
-}
-
-
-/**
- * Hooks for intercepting collection entity data at the REST API boundary.
- *
- * These run **after** per-collection `EntityCallbacks` (which execute inside
- * the DataDriver) and provide a single cross-cutting interception point for
- * ALL collections flowing through the REST API.
- *
- * Every callback receives the collection `slug` so you can target specific
- * collections or apply logic globally.
- *
- * @group Backend Hooks
- */
-export interface DataHooks {
-    /**
-     * Transform an entity after it's read from the database,
-     * before it's returned to the client.
-     *
-     * Runs for both list (GET /:slug) and single (GET /:slug/:id) fetches.
-     * Return the modified entity, or `null` to filter it out.
-     *
-     * @param slug - The collection slug (e.g. "orders", "products")
-     * @param entity - The flattened entity object (id + values merged)
-     * @param context - Request context (authenticated user, HTTP method)
-     */
-    afterRead?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): Record<string, unknown> | null | Promise<Record<string, unknown> | null>;
-
-    /**
-     * Transform entity values before they are written to the database.
-     * Runs on POST (create) and PUT (update).
-     *
-     * Return the (possibly modified) values. Throw to abort the save.
-     *
-     * @param slug - The collection slug
-     * @param values - The raw request body values
-     * @param entityId - The entity ID (only present on updates)
-     * @param context - Request context
-     */
-    beforeSave?(slug: string, values: Record<string, unknown>, entityId: string | undefined, context: BackendHookContext): Record<string, unknown> | Promise<Record<string, unknown>>;
-
-    /**
-     * Called after an entity is successfully saved (created or updated).
-     * Useful for side-effects like syncing to external systems.
-     *
-     * @param slug - The collection slug
-     * @param entity - The saved entity (flattened)
-     * @param context - Request context
-     */
-    afterSave?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): void | Promise<void>;
-
-    /**
-     * Called before an entity is deleted. Throw to prevent deletion.
-     *
-     * @param slug - The collection slug
-     * @param entityId - The entity ID being deleted
-     * @param context - Request context
-     */
-    beforeDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
-
-    /**
-     * Called after an entity is successfully deleted.
-     *
-     * @param slug - The collection slug
-     * @param entityId - The deleted entity ID
-     * @param context - Request context
-     */
-    afterDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
-}
-
-/**
- * Backend-level hooks for intercepting data at the API boundary.
- *
- * These hooks run server-side after database operations complete and before
- * API responses are sent.
- *
- * `data` hooks complement per-collection `EntityCallbacks`. Entity callbacks
- * run inside the DataDriver (close to the DB); data hooks run at the HTTP
- * boundary (close to the client). Use data hooks for cross-cutting concerns
- * like audit logging, response enrichment, or field masking.
- *
- * @example
- * ```typescript
- * const hooks: BackendHooks = {
- *     data: {
- *         afterRead(slug, entity, ctx) {
- *             // Mask PII for non-admin users across all collections
- *             if (!ctx.requestUser?.roles.includes("admin") && entity.email) {
- *                 return { ...entity, email: "***" };
- *             }
- *             return entity;
- *         }
- *     }
- * };
- * ```
- *
- * @group Backend Hooks
- */
-export interface BackendHooks {
-    /** Hooks for intercepting ALL collection entity data via the REST API */
-    data?: DataHooks;
-}

package/src/types/entity_overrides.tsx

@@ -1,11 +0,0 @@
-import type { DataDriver } from "../controllers/data_driver";
-import type { StorageSource } from "../controllers/storage";
-
-export type EntityOverrides = {
-    /**
-     * Internal driver override for this collection.
-     * Used by the CMS engine to route data operations.
-     */
-    driver?: DataDriver;
-    storageSource?: StorageSource;
-};