@rebasepro/types 0.6.1 → 0.7.0

package/src/types/collections.ts

@@ -58,34 +58,44 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
 
 
     /**
-     * Which driver handles this collection.
-     * Use this to route collections to different backends:
-     * - `"postgres"` - Route to PostgreSQL backend
-     * - `"firestore"` - Route to Firestore (client-side)
-     * - `"mongodb"` - Route to MongoDB backend
-     * - Custom IDs for your own driver implementations
+     * The data source this collection belongs to — the routing key shared by
+     * the frontend router and the backend driver registry. It points at a
+     * {@link DataSourceDefinition} registered on `<Rebase dataSources>` (front)
+     * and `initRebase({ dataSources })` (back).
      *
-     * If not specified, the default driver `"(default)"` is used.
+     * If not specified, the default data source `"(default)"` is used, which
+     * for a standard Rebase app is the server-mediated Postgres backend.
      *
      * @example
-     * // Simple - no driver needed for default
+     * // Default data source (server-mediated Postgres)
      * { slug: "products" }
      *
-     * // Firestore collection (client-side real-time)
-     * { slug: "analytics", driver: "firestore" }
+     * // A direct-transport Firestore data source registered as "analytics"
+     * { slug: "events", dataSource: "analytics" }
+     */
+    dataSource?: string;
+
+    /**
+     * The engine backing this collection (`"postgres"`, `"firestore"`,
+     * `"mongodb"`, or a custom id). Drives editor capabilities (relations vs
+     * subcollections, RLS, column types).
+     *
+     * @deprecated Prefer {@link dataSource} for routing. `driver` is retained
+     * as an engine hint and for backward compatibility: when `dataSource` is
+     * omitted it also acts as the data-source key.
      *
-     * // Multiple databases within a driver
-     * { slug: "orders", driver: "postgres", databaseId: "orders_db" }
+     * If not specified, `"postgres"` is assumed.
      */
     driver?: string;
 
     /**
-     * Which database within the driver.
+     * Which database within the engine.
      * - For Firestore: The Firestore database ID (e.g., for multi-database projects)
      * - For PostgreSQL: Schema or database name
      * - For MongoDB: Database name
      *
-     * If not specified, the default database of the driver is used.
+     * If not specified, the default database of the engine is used. Resolved
+     * from the collection's {@link DataSourceDefinition} when omitted here.
      */
     databaseId?: string;
 
@@ -165,6 +175,26 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      */
     auth?: boolean | AuthCollectionConfig;
 
+    /**
+     * Opt out of the framework's default Row Level Security policies for
+     * authentication collections.
+     *
+     * When a collection has `auth` enabled, the schema generator automatically
+     * injects an admin-only write policy (INSERT/UPDATE/DELETE require the
+     * `admin` role, or the trusted server context) for any write operation that
+     * the collection does not already cover with an explicit `securityRules`
+     * entry. This makes privileged columns such as `roles` safe by default — a
+     * non-admin cannot modify the user row through the data API regardless of
+     * which code path issues the write.
+     *
+     * Defining your own write rule for an operation overrides the default for
+     * that operation. Set this flag to `true` to remove the default policies
+     * entirely and take full responsibility for the collection's RLS.
+     *
+     * @default false
+     */
+    disableDefaultAuthPolicies?: boolean;
+
 
     /**
      * Order in which the properties are displayed.
@@ -321,6 +351,13 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      */
     ownerId?: string;
 
+    /**
+     * Arbitrary key-value metadata for external consumers.
+     * Not interpreted by Rebase — passed through serialization unchanged.
+     * Used by domain apps to store custom per-collection config.
+     */
+    metadata?: Record<string, unknown>;
+
     /**
      * Overrides for the entity view, like the data source or the storage source.
      */
@@ -375,7 +412,7 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      * Possible values: "table", "cards", "kanban".
      * Defaults to all three: ["table", "cards", "kanban"].
      * Note: "kanban" will only be available if the collection has at least
-     * one string property with enumValues defined, regardless of this setting.
+     * one string property with `enum` defined, regardless of this setting.
      */
     enabledViews?: ViewMode[];
 
@@ -619,9 +656,9 @@ export function isMongoDBCollection<M extends Record<string, unknown> = Record<s
 export interface KanbanConfig<M extends Record<string, unknown> = Record<string, unknown>> {
     /**
      * Property key to use for Kanban board columns.
-     * Must reference a string property with enumValues defined.
+     * Must reference a string property with `enum` values defined.
      * Entities will be grouped into columns based on this property's value.
-     * The column order is determined by the order of enumValues in the property.
+     * The column order is determined by the order of `enum` values in the property.
      */
     columnProperty: Extract<keyof M, string> | (string & {});
 }

package/src/types/data_source.ts

@@ -53,6 +53,90 @@ export interface DataSourceCapabilities {
  */
 export type DataSourceFeatures = Omit<DataSourceCapabilities, "key" | "label">;
 
+/**
+ * The default data-source key, used when a collection does not name a
+ * `dataSource`. Shared by the frontend router and the backend driver
+ * registry so both agree on "the default database".
+ * @group Models
+ */
+export const DEFAULT_DATA_SOURCE_KEY = "(default)";
+
+/**
+ * How the *frontend* reaches a data source.
+ *
+ * - `"server"` — through the Rebase backend (the `RebaseClient`). The backend
+ *   holds the actual database adapter and routes by data-source key. This is
+ *   the default and covers Postgres, MongoDB, and any other server-mediated
+ *   engine.
+ * - `"direct"` — straight from the client to the external backend via its own
+ *   SDK driver (e.g. Firestore). The Rebase backend is not in the data path.
+ * - `"custom"` — a developer-supplied {@link DataDriver}, transport unspecified.
+ *
+ * @group Models
+ */
+export type DataSourceTransport = "server" | "direct" | "custom";
+
+/**
+ * Declarative definition of a data source — a named place data lives.
+ *
+ * Declared once and shared front and back: the frontend uses it to decide
+ * transport (client vs direct driver), the backend uses the same `key` to
+ * resolve a database adapter, and the editor derives capabilities from
+ * `engine`. Collections reference a definition by its `key` via
+ * `collection.dataSource`.
+ *
+ * @group Models
+ */
+export interface DataSourceDefinition {
+    /**
+     * Unique identifier for this data source. Collections point at it via
+     * `dataSource`. Defaults to {@link DEFAULT_DATA_SOURCE_KEY}.
+     */
+    key: string;
+
+    /**
+     * The engine backing this data source (e.g. `"postgres"`, `"mongodb"`,
+     * `"firestore"`, or a custom id). Determines the
+     * {@link DataSourceCapabilities} surfaced in the editor.
+     */
+    engine: string;
+
+    /**
+     * How the frontend reaches this source. Defaults to `"server"`.
+     */
+    transport: DataSourceTransport;
+
+    /**
+     * The physical database/schema/Firestore-database within the engine.
+     * Threaded to drivers/adapters as the existing `databaseId` runtime
+     * parameter. Defaults to the engine's own default.
+     */
+    databaseId?: string;
+
+    /** Human-readable label for the UI. */
+    label?: string;
+}
+
+/**
+ * The resolved data source for a collection: the single source of truth that
+ * the frontend router, backend registry, and editor all derive from.
+ * Produced by `resolveDataSource(collection, registry)`.
+ *
+ * @group Models
+ */
+export interface ResolvedDataSource {
+    /** Data-source key (routing key, shared front + back). */
+    key: string;
+    /** Engine backing the source (drives capabilities). */
+    engine: string;
+    /** Frontend transport. */
+    transport: DataSourceTransport;
+    /** Within-engine instance, if any (the `databaseId` runtime param). */
+    databaseId?: string;
+    /** Capabilities derived from {@link engine}. */
+    capabilities: DataSourceCapabilities;
+}
+
 // ── Built-in driver capabilities ─────────────────────────────────────
 
 /** @group Models */

package/src/types/entity_actions.tsx

@@ -69,7 +69,7 @@ export interface EntityAction<M extends Record<string, unknown> = Record<string,
 
 export type EntityActionClickProps<M extends Record<string, unknown>, USER extends User = User> = {
     entity?: Entity<M>;
-    context: RebaseContext<USER>;
+    context?: RebaseContext<USER>;
 
     path?: string;
     collection?: EntityCollection<M>;
@@ -93,7 +93,7 @@ export type EntityActionClickProps<M extends Record<string, unknown>, USER exten
     /**
      * If the action is rendered in the form, is it open in a side panel or full screen?
      */
-    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
+    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
 
     /**
      * Optional selection controller, present if the action is being called from a collection view

package/src/types/entity_views.tsx

@@ -55,7 +55,7 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
 
     savingError?: Error;
 
-    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
+    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
 
     /**
      * The underlying formex controller that powers the form.

package/src/types/index.ts

@@ -30,3 +30,5 @@ export * from "./auth_adapter";
 export * from "./database_adapter";
 export * from "./breadcrumbs";
 export * from "./component_overrides";
+export * from "./api_keys";
+

package/src/types/plugins.tsx

@@ -311,7 +311,7 @@ export interface PluginFormActionProps<USER extends User = User, EC extends Enti
     disabled: boolean;
     formContext?: FormContext;
     context: RebaseContext<USER>;
-    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
+    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
 }
 
 /**

package/src/types/properties.ts

@@ -221,6 +221,14 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     callbacks?: PropertyCallbacks;
 
+    /**
+     * Arbitrary key-value metadata for external consumers.
+     * Not interpreted by Rebase — passed through serialization unchanged.
+     * Used by domain apps to store custom per-property config
+     * (e.g. CRM visibility flags, display hints).
+     */
+    metadata?: Record<string, unknown>;
+
 }
 
 /**
@@ -1244,7 +1252,7 @@ export interface PropertyConditions {
     defaultValue?: JsonLogicRule;
 
     // ═══════════════════════════════════════════════════════════════════════
-    // ENUM CONDITIONS (for string/number properties with enumValues)
+    // ENUM CONDITIONS (for string/number properties with enum values)
     // ═══════════════════════════════════════════════════════════════════════
 
     /**

package/src/types/translations.ts

@@ -47,6 +47,12 @@ export interface RebaseTranslations {
     unsaved_changes_body: string;
     discard_changes: string;
     keep_editing: string;
+    /** Dialog title when clearing a new/copy form */
+    clear_form?: string;
+    /** Confirmation body when discarding changes on an existing entity */
+    discard_changes_confirmation?: string;
+    /** Confirmation body when clearing a new/copy form */
+    clear_form_confirmation?: string;
 
     // ─── Collection table / toolbar ──────────────────────────────
     search: string;
@@ -175,6 +181,8 @@ export interface RebaseTranslations {
     form_modified: string;
     /** Tooltip when the form is in sync with the database */
     form_in_sync: string;
+    /** Tooltip/alert shown when form has validation errors */
+    fix_errors_before_saving?: string;
 
     admin: string;
     home: string;