@rebasepro/types 0.3.0 → 0.5.0

package/src/types/backend.ts

@@ -1,5 +1,6 @@
 import type { Entity } from "./entities";
 import type { EntityCollection, FilterValues, WhereFilterOp } from "./collections";
+import type { AuthAdapter } from "./auth_adapter";
 
 // =============================================================================
 // DATABASE CONNECTION INTERFACES
@@ -281,6 +282,24 @@ export interface RealtimeProvider {
         entity: Entity | null,
         databaseId?: string
     ): Promise<void>;
+
+    /**
+     * Called when the HTTP server is ready and listening.
+     * Useful for providers that need the server address for callbacks.
+     */
+    onServerReady?(serverInfo: { port: number; hostname?: string }): void;
+
+    /**
+     * Gracefully shut down the realtime provider.
+     * Called during server shutdown to clean up resources.
+     */
+    destroy?(): Promise<void>;
+
+    /**
+     * Stop the internal LISTEN client (e.g., PostgreSQL LISTEN/NOTIFY).
+     * Called during graceful shutdown before closing database connections.
+     */
+    stopListening?(): Promise<void>;
 }
 
 // =============================================================================
@@ -638,6 +657,25 @@ export interface BackendBootstrapper {
      */
     type: string;
 
+    /**
+     * Unique identifier for this bootstrapper instance.
+     * Used to register the driver in the driver registry.
+     * Defaults to `type` if not set.
+     */
+    id?: string;
+
+    /**
+     * Whether this bootstrapper provides the default driver.
+     * When true, the coordinator uses this driver as the primary one.
+     */
+    isDefault?: boolean;
+
+    /**
+     * Run database migrations for this driver.
+     * Called by the coordinator after all drivers are initialized.
+     */
+    runMigrations?(config: unknown, driverResult: InitializedDriver): Promise<void>;
+
     /**
      * Create a DataDriver from the given config.
      * This is the only **required** method.
@@ -676,7 +714,7 @@ export interface BackendBootstrapper {
     /**
      * Initialize WebSocket server for realtime operations.
      */
-    initializeWebsockets?(server: unknown, realtimeService: RealtimeProvider, driver: import("../controllers/data_driver").DataDriver, config?: unknown): Promise<void> | void;
+    initializeWebsockets?(server: unknown, realtimeService: RealtimeProvider, driver: import("../controllers/data_driver").DataDriver, config?: unknown, authAdapter?: AuthAdapter): Promise<void> | void;
 }
 
 /**
@@ -711,8 +749,8 @@ export interface InitializedDriver {
 export interface BootstrappedAuth {
     /** User management service. */
     userService: unknown;
-    /** Role management service. */
-    roleService: unknown;
+    /** Role management service (optional, roles are now simple strings). */
+    roleService?: unknown;
     /** Email service (optional). */
     emailService?: unknown;
     /** Combined Auth Repository for unified token and user management. */

package/src/types/backend_hooks.ts

@@ -1,4 +1,4 @@
-import type { AdminUser, AdminRole } from "../controllers/client";
+import type { AdminUser } from "../controllers/client";
 
 /**
  * Context passed to every backend hook.
@@ -56,20 +56,6 @@ export interface UserHooks {
     afterDelete?(userId: string, context: BackendHookContext): void | Promise<void>;
 }
 
-/**
- * Hooks for intercepting Admin Role data at the API boundary.
- * @group Backend Hooks
- */
-export interface RoleHooks {
-    /**
-     * Transform a role record after it's read from the database,
-     * before it's returned to the client.
-     *
-     * Return the modified role, or `null` to filter it out entirely.
-     */
-    afterRead?(role: AdminRole, context: BackendHookContext): AdminRole | null | Promise<AdminRole | null>;
-}
-
 /**
  * Hooks for intercepting collection entity data at the REST API boundary.
  *
@@ -144,7 +130,7 @@ export interface DataHooks {
  * These hooks run server-side after database operations complete and before
  * API responses are sent.
  *
- * - `users` / `roles` — intercept admin user and role management endpoints
+ * - `users` — intercept admin user management endpoints
  * - `data` — intercept ALL collection entity data flowing through the REST API
  *
  * `data` hooks complement per-collection `EntityCallbacks`. Entity callbacks
@@ -178,8 +164,6 @@ export interface DataHooks {
 export interface BackendHooks {
     /** Hooks for intercepting user management data */
     users?: UserHooks;
-    /** Hooks for intercepting role management data */
-    roles?: RoleHooks;
     /** Hooks for intercepting ALL collection entity data via the REST API */
     data?: DataHooks;
 }

package/src/types/collections.ts

@@ -8,7 +8,7 @@ import type { EntityOverrides } from "./entity_overrides";
 import type { User } from "../users";
 import type { RebaseContext } from "../rebase_context";
 import type { Relation } from "./relations";
-import type { EntityCustomView, EntityDetailViewConfig } from "./entity_views";
+import type { EntityCustomView, FormViewConfig } from "./entity_views";
 import type { EntityAction } from "./entity_actions";
 import type { ComponentRef } from "./component_ref";
 
@@ -144,10 +144,14 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
     defaultEntityAction?: "view" | "edit";
 
     /**
-     * Customization options for the read-only detail view.
-     * Only used when `defaultEntityAction` is `"view"`.
+     * Replace the default entity form with a custom component.
+     * The Builder receives the same props as entity view tabs
+     * (entity, formContext, collection, etc.) and has full control over the UI.
+     *
+     * Works in both edit mode and read-only mode (when `defaultEntityAction`
+     * is `"view"`). In read-only mode, `formContext.readOnly` will be `true`.
      */
-    detailView?: EntityDetailViewConfig;
+    formView?: FormViewConfig;
 
     /**
      * Prevent default actions from being displayed or executed on this collection.
@@ -395,7 +399,25 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      */
     Actions?: ComponentRef<CollectionActionsProps>[];
 
+    /**
+     * The database table name for this collection.
+     * Automatically set for PostgreSQL collections.
+     * For non-SQL backends, this may be undefined.
+     */
+    table?: string;
+
+    /**
+     * Relations defined for this collection.
+     * Populated at normalization time from inline relation properties
+     * or explicit relation definitions.
+     */
+    relations?: Relation[];
 
+    /**
+     * Security rules for this collection (Row Level Security).
+     * When defined, the backend enforces access control policies.
+     */
+    securityRules?: SecurityRule[];
 }
 
 // ── Driver-specific collection types ──────────────────────────────────
@@ -513,7 +535,10 @@ export type EntityCollection<M extends Record<string, unknown> = Record<string,
 // Use these after a `getDataSourceCapabilities()` guard to safely access
 // driver-specific fields without coupling to a concrete driver type.
 
-/** An EntityCollection that supports SQL-style relations (e.g. Postgres). */
+/**
+ * An EntityCollection that supports SQL-style relations (e.g. Postgres).
+ * @deprecated Use `EntityCollection` directly — `table`, `relations`, and `securityRules` are now on `BaseEntityCollection`.
+ */
 export type CollectionWithRelations<M extends Record<string, unknown> = Record<string, unknown>> =
     EntityCollection<M> & { table?: string; relations?: Relation[]; securityRules?: SecurityRule[] };
 
@@ -689,7 +714,7 @@ export type WhereFilterOp =
  * @group Models
  */
 export type FilterValues<Key extends string> =
-    Partial<Record<Key, [WhereFilterOp, unknown]>>;
+    Partial<Record<Key, [WhereFilterOp, unknown] | [WhereFilterOp, unknown][]>>;
 
 /**
  * A pre-defined filter preset for quick access in the collection toolbar.

package/src/types/entity_views.tsx

@@ -73,43 +73,33 @@ export type EntityCustomView<M extends Record<string, unknown> = Record<string,
     position?: "start" | "end";
 };
 
-export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
-    collection: EntityCollection<M>;
-    entity?: Entity<M>;
-    modifiedValues?: EntityValues<M>;
-    formContext: FormContext<M>;
-    parentCollectionSlugs?: string[];
-    parentEntityIds?: string[];
-}
-
 /**
- * Configuration for customizing the read-only detail view of an entity.
- * Only used when `defaultEntityAction` is set to `"view"` on the collection.
+ * Configuration to replace the default entity form with a custom component.
+ * The Builder receives the same props as entity view tabs (entity, formContext, etc.)
+ * and has full control over the UI.
+ *
+ * The form tab still appears in the tab bar but renders your Builder
+ * instead of the auto-generated field form.
+ *
  * @group Models
  */
-export type EntityDetailViewConfig<M extends Record<string, unknown> = Record<string, unknown>> = {
-    /**
-     * Custom component rendered above the property display in the detail view.
-     */
-    Header?: ComponentRef<EntityDetailViewParams<M>>;
+export type FormViewConfig<M extends Record<string, unknown> = Record<string, unknown>> = {
     /**
-     * Custom component rendered below the property display in the detail view.
+     * Custom component that replaces the default form.
      */
-    Footer?: ComponentRef<EntityDetailViewParams<M>>;
+    Builder: ComponentRef<EntityCustomViewParams<M>>;
     /**
-     * Completely replace the default detail view with a custom component.
-     * When set, Header and Footer are ignored.
+     * If true, the save/delete action bar is rendered alongside the custom view.
+     * Defaults to true.
      */
-    Builder?: ComponentRef<EntityDetailViewParams<M>>;
+    includeActions?: boolean;
 };
 
-/**
- * Props passed to detail view customization components (Header, Footer, Builder).
- * @group Models
- */
-export interface EntityDetailViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
+export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
     collection: EntityCollection<M>;
-    entity: Entity<M>;
-    path: string;
-    onEditClick: () => void;
+    entity?: Entity<M>;
+    modifiedValues?: EntityValues<M>;
+    formContext: FormContext<M>;
+    parentCollectionSlugs?: string[];
+    parentEntityIds?: string[];
 }

package/src/types/properties.ts

@@ -1,15 +1,12 @@
-import React from "react";
-
 import type { ComponentRef } from "./component_ref";
 
-import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity, Vector } from "./entities";
-import type { Relation, JoinStep, OnAction } from "./relations";
+import type { Entity, EntityReference, EntityRelation, EntityValues, GeoPoint, Vector } from "./entities";
+import type { JoinStep, OnAction, Relation } from "./relations";
 import type { EntityCollection, FilterValues } from "./collections";
 import type { ColorKey, ColorScheme } from "./chips";
 import type { AuthController } from "../controllers/auth";
 import type { EntityAfterReadProps, EntityBeforeSaveProps } from "./entity_callbacks";
 import type { User } from "../users";
-import type { RebaseContext } from "../rebase_context";
 
 /**
  * Callbacks/Hooks for individual property fields
@@ -24,7 +21,6 @@ export type PropertyCallbacks<T = unknown, M extends Record<string, unknown> = R
         entity: Entity<M> | undefined;
     }): Promise<T> | T;
 
-
     /**
      * Callback used before saving, after validation.
      * You can modify the value before it's saved.
@@ -85,17 +81,17 @@ export type FirebaseProperties = {
  */
 export type InferPropertyType<P extends Property> =
     P extends StringProperty ? string :
-    P extends NumberProperty ? number :
-    P extends BooleanProperty ? boolean :
-    P extends DateProperty ? Date :
-    P extends GeopointProperty ? GeoPoint :
-    P extends ReferenceProperty ? EntityReference :
-    P extends RelationProperty ? EntityRelation | EntityRelation[] :
-    P extends ArrayProperty ? (P["of"] extends Property ? InferPropertyType<P["of"]>[] : unknown[]) :
-    P extends MapProperty ? (P["properties"] extends Properties ? InferEntityType<P["properties"]> : Record<string, unknown>) :
-    P extends VectorProperty ? Vector :
-    P extends BinaryProperty ? string :
-    never;
+        P extends NumberProperty ? number :
+            P extends BooleanProperty ? boolean :
+                P extends DateProperty ? Date :
+                    P extends GeopointProperty ? GeoPoint :
+                        P extends ReferenceProperty ? EntityReference :
+                            P extends RelationProperty ? EntityRelation | EntityRelation[] :
+                                P extends ArrayProperty ? (P["of"] extends Property ? InferPropertyType<P["of"]>[] : unknown[]) :
+                                    P extends MapProperty ? (P["properties"] extends Properties ? InferEntityType<P["properties"]> : Record<string, unknown>) :
+                                        P extends VectorProperty ? Vector :
+                                            P extends BinaryProperty ? string :
+                                                never;
 
 /**
  * Helper type that determines whether a property is required.
@@ -152,8 +148,8 @@ export interface BaseUIConfig<CustomProps = unknown> {
     disabled?: boolean | PropertyDisabledConfig;
     widthPercentage?: number;
     customProps?: CustomProps;
-    Field?: ComponentRef;
-    Preview?: ComponentRef;
+    Field?: ComponentRef<any>;
+    Preview?: ComponentRef<any>;
 }
 
 export interface BaseProperty<CustomProps = unknown> {
@@ -189,10 +185,6 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     columnName?: string;
 
-
-
-
-
     /**
      * Rules for validating this property
      */
@@ -203,9 +195,6 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     defaultValue?: unknown;
 
-
-
-
     /**
      * Use this to define dynamic properties that change based on certain conditions
      * or on the entity's values. For example, you can make a field read-only if
@@ -232,7 +221,6 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     callbacks?: PropertyCallbacks;
 
-
 }
 
 /**
@@ -253,7 +241,7 @@ export interface StringProperty extends BaseProperty {
      * Optional database column type. If not set, it defaults to `varchar` or `uuid` depending on `isId` configuration.
      * Use `text` for strings with unbound length, `char` for fixed-length strings, or `varchar` for variable-length strings with a limit.
      */
-    columnType?: "varchar" | "text" | "char";
+    columnType?: "varchar" | "text" | "char" | "uuid";
     /**
      * Rules for validating this property
      */
@@ -325,7 +313,6 @@ export interface StringProperty extends BaseProperty {
      */
     previewAsTag?: boolean;
 
-
     /**
      * You can use this property (a string) to behave as a reference to another
      * collection. The stored value is the ID of the entity in the
@@ -655,9 +642,11 @@ export interface ArrayProperty extends BaseProperty {
     ui?: ArrayUIConfig;
     type: "array";
     /**
-     * Optional database column type. Defaults to `jsonb`.
+     * Optional database column type. By default, maps to a native Postgres array
+     * (e.g. `text[]`, `integer[]`/`numeric[]`, `boolean[]`) if the element type
+     * is a primitive, otherwise defaults to `jsonb`.
      */
-    columnType?: "json" | "jsonb";
+    columnType?: "json" | "jsonb" | "text[]" | "integer[]" | "boolean[]" | "numeric[]";
     /**
      * The property of this array.
      * You can specify any property (except another Array property)
@@ -756,15 +745,6 @@ export interface MapProperty extends BaseProperty {
      * Properties that are displayed when rendered as a preview
      */
     previewProperties?: string[];
-    /**
-     * Allow the user to add only some keys in this map.
-     * By default, all properties of the map have the corresponding field in
-     * the form view. Setting this flag to true allows to pick only some.
-     * Useful for map that can have a lot of sub-properties that may not be
-     * needed
-     */
-    pickOnlySomeKeys?: boolean;
-
     /**
      * Render this map as a key-value table that allows to use
      * arbitrary keys. You don't need to define the properties in this case.

package/src/types/user_management_delegate.ts

@@ -1,4 +1,4 @@
-import { Role, User } from "../users";
+import type { User } from "../users";
 
 /**
  * Result of creating a new user via admin flow.
@@ -18,60 +18,45 @@ export interface UserCreationResult<USER extends User = User> {
 
 
 /**
- * Delegate to manage users, roles, and their permissions.
- * This interface allows the CMS to be completely agnostic of the underlying
- * authentication provider or backend.
+ * Delegate to manage auth-specific user operations.
+ *
+ * This interface allows the CMS to be agnostic of the underlying
+ * authentication provider or backend. User/role CRUD is now handled
+ * by the collection system; this delegate only exposes auth-specific
+ * operations (password hashing, invitations, bootstrap).
  *
  * @group Models
  */
 export interface UserManagementDelegate<USER extends User = User> {
 
     /**
-     * Are the users and roles currently being fetched?
+     * Are auth-related operations currently loading?
      */
     loading: boolean;
 
     /**
-     * List of users managed by the CMS.
+     * In-memory list of users (used for client-side filtering fallback).
      */
-    users: USER[];
+    users?: USER[];
 
     /**
-     * Optional error if users failed to load.
+     * Error from fetching the users list, if any.
      */
     usersError?: Error;
 
     /**
-     * Function to get a user by its uid. This is used to show
-     * user information when assigning ownership of an entity.
-     * @param uid
-     */
-    getUser: (uid: string) => USER | null;
-
-    /**
-     * Search users with server-side pagination.
-     * When provided, the CMS will use this for the users table
-     * instead of loading all users into memory.
+     * Look up a single user by UID from the in-memory cache.
      */
-    searchUsers?: (options: {
-        search?: string;
-        limit?: number;
-        offset?: number;
-        orderBy?: string;
-        orderDir?: "asc" | "desc";
-        roleId?: string;
-    }) => Promise<{ users: USER[]; total: number }>;
+    getUser?: (uid: string) => USER | null;
 
     /**
-     * Save a user (create or update)
-     * @param user
+     * Server-side user search with pagination.
      */
-    saveUser?: (user: USER) => Promise<USER>;
+    searchUsers?: (params: { search?: string; limit?: number; offset?: number }) => Promise<{ users: USER[]; total: number }>;
 
     /**
      * Create a new user with invitation/password generation support.
      * Returns additional info about how the credentials were delivered.
-     * Falls back to saveUser if not provided.
      */
     createUser?: (user: USER) => Promise<UserCreationResult<USER>>;
 
@@ -82,52 +67,16 @@ export interface UserManagementDelegate<USER extends User = User> {
      */
     resetPassword?: (user: USER) => Promise<UserCreationResult<USER>>;
 
-    /**
-     * Delete a user
-     * @param user
-     */
-    deleteUser?: (user: USER) => Promise<void>;
-
-    /**
-     * List of roles defined in the CMS.
-     */
-    roles?: Role[];
-
-    /**
-     * Optional error if roles failed to load.
-     */
-    rolesError?: Error;
-
-    /**
-     * Save a role (create or update)
-     * @param role
-     */
-    saveRole?: (role: Role) => Promise<void>;
-
-    /**
-     * Delete a role
-     * @param role
-     */
-    deleteRole?: (role: Role) => Promise<void>;
-
     /**
      * Is the currently logged in user an admin?
      */
     isAdmin?: boolean;
 
-    /**
-     * If true, the UI will allow the user to create the default roles (admin, editor, viewer).
-     */
-    allowDefaultRolesCreation?: boolean;
-
-
-
-
     /**
      * Optionally define roles for a given user. This is useful when the roles
      * are coming from a separate provider than the one issuing the tokens.
      */
-    defineRolesFor?: (user: USER) => Promise<Role[] | undefined> | Role[] | undefined;
+    defineRolesFor?: (user: USER) => Promise<string[] | undefined> | string[] | undefined;
 
     /**
      * Whether any admin users exist. Used by the bootstrap banner to decide

package/src/users/index.ts

@@ -1,2 +1,2 @@
 export * from "./user";
-export * from "./roles";
+

package/src/users/user.ts

@@ -37,7 +37,6 @@ export type User = {
 
     /**
      * Role IDs assigned to this user (e.g. ["admin", "editor"]).
-     * These are plain string IDs — use the UserManagementDelegate to look up full Role objects.
      */
     roles?: string[];
 

package/dist/users/roles.d.ts

@@ -1,14 +0,0 @@
-export type Role = {
-    /**
-     * ID of the role
-     */
-    id: string;
-    /**
-     * Name of the role
-     */
-    name: string;
-    /**
-     * If this flag is true, the user can perform any action
-     */
-    isAdmin?: boolean;
-};

package/src/users/roles.ts

@@ -1,22 +0,0 @@
-
-
-export type Role = {
-
-    /**
-     * ID of the role
-     */
-    id: string;
-
-    /**
-     * Name of the role
-     */
-    name: string;
-
-    /**
-     * If this flag is true, the user can perform any action
-     */
-    isAdmin?: boolean;
-
-
-
-}