@rebasepro/core 0.3.0 → 0.5.0

package/README.md

@@ -1,242 +1,174 @@
-<p align="center">
-  <a href="https://rebase.pro">
-    <img src="https://rebase.pro/img/logo_small.png" width="240px" alt="Rebase logo" />
-  </a>
-</p>
+# @rebasepro/core
 
-<h1 align="center">Rebase</h1>
-<h3 align="center">The Open-Source Headless CMS & Admin Panel for Postgres</h3>
-<p align="center">
-  <strong>Ship production-ready backends and radically extensible back-office apps in minutes.</strong><br/>
-  Own your data, own your code. The absolute easiest way to build on PostgreSQL.
-</p>
+Framework-agnostic runtime for data-driven admin panels — React hooks, providers, contexts, and shared components used by `@rebasepro/admin` and `@rebasepro/studio`.
 
-<p align="center">
-  <a href="https://demo.rebase.pro">Live Demo</a> •
-  <a href="https://rebase.pro/docs">Documentation</a> •
-  <a href="https://rebase.pro/features">Features</a> •
-  <a href="https://github.com/rebasepro/rebase">GitHub</a> •
-  <a href="https://discord.gg/fxy7xsQm3m">Discord</a>
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/@rebasepro/core"><img src="https://img.shields.io/npm/v/@rebasepro/core.svg?style=flat-square&color=orange" alt="NPM Version" /></a>
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-purple.svg?style=flat-square" alt="License: MIT" /></a>
-  <a href="https://www.npmjs.com/package/@rebasepro/core"><img src="https://img.shields.io/npm/dw/@rebasepro/core?style=flat-square&color=blue" alt="NPM Downloads" /></a>
-  <a href="https://discord.gg/fxy7xsQm3m"><img src="https://img.shields.io/discord/1013768502458470442?style=flat-square&logo=discord&logoColor=white&label=Discord" alt="Discord" /></a>
-</p>
-
-<br/>
-
-<p align="center">
-  <img src="https://rebase.pro/img/demo_products.png" width="800px" alt="Rebase Dashboard" />
-</p>
-
----
-
-## What is Rebase?
-
-Rebase is a **developer-first**, open-source headless CMS and admin panel framework built with **React** and **TypeScript**. It gives you a complete backend-as-a-service layer on top of PostgreSQL — including authentication, S3-compatible storage, a full admin UI, and auto-generated APIs — while letting you extend every layer with custom React components, serverless functions, and scripts.
-
-### ✨ Key Highlights
-
-- 🔓 **No Vendor Lock-in** — Self-host anywhere. Full control over your infrastructure, code, and database.
-- ⚡ **Instant Setup** — `npx @rebasepro/cli init` scaffolds a production-ready project in seconds.
-- 🗄️ **PostgreSQL First** — First-class Postgres support with Drizzle ORM, schema introspection, and automatic migrations.
-- 🧩 **Radical Extensibility** — Not constrained to pre-built widgets. If you can build it in React, you can build it in Rebase.
-- 🎨 **Premium UI** — Fast, accessible design system built on Tailwind CSS v4 and Radix UI.
-- 🤖 **AI-Ready** — MCP server for AI-assisted database management, plus data enhancement and insights plugins.
-
----
-
-## ⚡ Quick Start
-
-Scaffold a complete, self-hosted Rebase application connected to your database:
-
-```bash
-npx @rebasepro/cli init my-rebase-app
-```
-
-Configure your database in `.env`, then start everything:
+## Installation
 
 ```bash
-cd my-rebase-app
-npm run dev
+pnpm add @rebasepro/core
 ```
 
-Your admin panel is running at `http://localhost:5173` and the API at `http://localhost:3001`.
+**Peer dependencies:** `react >= 19`, `react-dom >= 19`, `react-router ^7`, `react-router-dom ^7`
 
----
+## What This Package Does
 
-## Features
+`@rebasepro/core` is the shared runtime layer that powers the Rebase CMS. It provides:
 
-### 🏓 Full Admin Panel & CMS
+- **App bootstrapping** — `Rebase`, `RebaseRouter`, `RebaseRoutes`, `PluginProviderStack`
+- **React contexts** — auth, data driver, storage, snackbar, dialogs, mode, admin mode, role, analytics, customization
+- **Hooks** — data fetching (`useData`, `useCollectionFetch`, `useEntityFetch`), data mutation (`save`, `delete`), auth (`useAuthController`), storage, permissions, i18n, and more
+- **UI components** — `LoginView`, `RebaseAuth`, `ConfirmationDialog`, `ErrorView`, `UserSettingsView`, `BootstrapAdminBanner`, etc.
+- **Utilities** — icon system, entity caching, storage upload controller, enums, constants
+- **i18n** — built-in English and Spanish locales via `react-i18next`
+- **Studio Bridge** — shared context for optional CMS↔Studio integration
 
-An incredibly fast, windowed spreadsheet view to manage your database with inline editing, real-time updates, filtering, sorting, and text search. Switch between multiple view modes:
+This package is **framework-agnostic** in the sense that it doesn't depend on any specific data backend — it works with any `DataDriver` implementation (PostgreSQL, Firebase, MongoDB, etc.).
 
-- **Spreadsheet table** — Inline editing, column reordering, drag-and-drop
-- **Card grid** — Visual overview with image previews
-- **List view** — Compact, scannable layout
-- **Custom views** — Build any React component as a collection view
+## Key Exports
 
-### 🔒 Typed Schema & Database Migrations
+### App Bootstrapping
 
-Define your data models using pure TypeScript collections. Rebase automatically generates your Drizzle ORM schema, handles PostgreSQL migrations, and keeps your live database perfectly in sync using built-in tooling like `rebase doctor`.
-
-### 🔐 Authentication & Access Control
-
-Built-in authentication with multiple providers:
-
-- **Email/Password** — With password reset flow
-- **Google OAuth** — One-click sign-in
-- **Anonymous** — For guest access
-
-Granular **role-based access control (RBAC)** with customizable permissions per collection, field, and action.
-
-### 📦 S3-Compatible Storage
-
-Native S3-compatible file storage with:
-
-- Drag-and-drop uploads with progress tracking
-- Automatic image resizing and optimization
-- File metadata management
-- Storage browser in Studio
-
-### 🛠️ Studio — Developer Toolbox
-
-A full developer environment built into the admin panel:
-
-| Tool | Description |
+| Export | Description |
 |---|---|
-| **SQL Editor** | Write and execute SQL queries directly against your database with schema-aware autocomplete |
-| **RLS Policy Editor** | Visual editor for PostgreSQL Row-Level Security policies |
-| **Schema Visualizer** | Interactive ER diagram of your database with relationship mapping |
-| **JS/TS Editor** | In-browser code editor for scripts and functions |
-| **API Explorer** | Browse and test your auto-generated REST API endpoints |
-| **Cron Jobs** | Schedule and monitor recurring tasks |
-| **Storage Browser** | Browse and manage files in your S3-compatible storage |
-
-### ⚡ Extensible API & Edge Functions
-
-Drop custom Hono routes or scheduled tasks into the `functions/` and `crons/` directories. Rebase auto-loads them with database access and JWT authentication middleware injected automatically.
+| `Rebase` | Root component — accepts collections, auth, data source config and renders the app |
+| `RebaseRouter` | Router wrapper for react-router integration |
+| `RebaseRoutes` | Route definitions |
+| `PluginProviderStack` | Wraps children with plugin-provided context providers |
 
-### 🧬 SDK Generator
+### Hooks — Data
 
-Auto-generate fully typed **TypeScript SDKs** from your collection definitions. Use them in any frontend, script, or service to interact with your Rebase backend with complete type safety.
-
-```bash
-npx @rebasepro/cli generate-sdk
-```
-
-### 🤖 MCP Server
-
-A built-in **Model Context Protocol** server that enables AI assistants to:
-
-- Query and manage your database schema
-- Create, read, update, and delete documents
-- Manage users and roles
-- Introspect your data model
-
-### 🔍 Schema Inference & Introspection
-
-Point Rebase at an existing PostgreSQL database and automatically generate collection definitions from your tables — including types, relations, validation constraints, and more.
-
-### 📥📤 Import & Export
-
-Import data from **CSV, JSON, and Excel** with an intuitive field mapper. Export your data in multiple formats with configurable column selection.
-
-### 🧩 Plugins
-
-Extend the admin experience with first-party plugins:
-
-- **Data Enhancement** — AI-powered field suggestions and auto-fill
-- **Insights** — Analytics dashboards and usage metrics
-
-### 📜 Standalone Scripting
-
-Write standalone data manipulation scripts that connect directly to your running backend using the `@rebasepro/client` SDK. The CLI persists the dev server URL to `.rebase-dev-url` for zero-config local development.
-
-### 🧩 Custom Views & React Extensibility
-
-Build entirely custom views — dashboards, previews, charts — and drop them into the main navigation or as entity-level tabs. Use built-in hooks to interact with Rebase's internal state.
-
----
-
-## 🛠️ Core Technologies
-
-Built entirely on modern, battle-tested web standards:
-
-| Technology | What we use it for |
+| Export | Description |
 |---|---|
-| 💙 **TypeScript 5.x** | End-to-end type safety |
-| ⚛️ **React 19** | Component-driven UI |
-| 🌊 **Tailwind CSS v4** | Utility-first styling |
-| 🔌 **WebSockets** | Real-time synchronization |
-| 🗄️ **Drizzle ORM** | Type-safe SQL migrations and queries |
-| 🧱 **Radix UI** | Accessible UI primitives |
-| 📝 **TipTap v3** | Rich text editing |
-| 🌐 **Hono** | Ultrafast HTTP server framework |
+| `useData` | Access the data driver from context |
+| `useCollectionFetch` | Fetch a collection with filters, pagination, and realtime |
+| `useEntityFetch` | Fetch a single entity by ID |
+| `useRelationSelector` | Relation field selector state |
+| `useUserSelector` | User selector state |
+| `save` utilities | Entity save helpers |
+| `delete` utilities | Entity delete helpers |
 
----
+### Hooks — Auth & Permissions
 
-## 📦 Packages
+| Export | Description |
+|---|---|
+| `useAuthController` | Access the current auth controller from context |
+| `useAuthSubscription` | Subscribe to auth state changes |
+| `usePermissions` | Check permissions for collections/actions |
+| `useAdminModeController` / `useBuildAdminModeController` | Admin mode toggle |
+| `useEffectiveRoleController` / `useBuildEffectiveRoleController` | Current user's effective role |
 
-Rebase is structured as a modular monorepo — install only the layers you need:
+### Hooks — UI & State
 
-| Package | Description |
+| Export | Description |
 |---|---|
-| `@rebasepro/types` | Core TypeScript type definitions |
-| `@rebasepro/utils` | Shared utility functions |
-| `@rebasepro/common` | Common modules shared across packages |
-| `@rebasepro/formex` | Lightweight form management library |
-| `@rebasepro/ui` | Standalone React component library (Tailwind + Radix) |
-| `@rebasepro/core` | Core CMS logic and controllers |
-| `@rebasepro/client` | Client-side data access layer |
-| `@rebasepro/client-postgresql` | PostgreSQL client adapter |
-| `@rebasepro/client-firebase` | Firebase/Firestore client adapter |
-| `@rebasepro/server-core` | Server framework and middleware (Hono) |
-| `@rebasepro/server-postgresql` | PostgreSQL server adapter with Drizzle |
-| `@rebasepro/server-mongodb` | MongoDB server adapter |
-| `@rebasepro/auth` | Authentication controllers and login views |
-| `@rebasepro/admin` | Full admin panel interface |
-| `@rebasepro/studio` | SQL editor, RLS editor, schema visualizer, API explorer |
-| `@rebasepro/cli` | CLI for project scaffolding and management |
-| `@rebasepro/sdk-generator` | TypeScript SDK code generation |
-| `@rebasepro/mcp-server` | MCP server for AI integrations |
-| `@rebasepro/schema-inference` | Database schema introspection and inference |
-| `@rebasepro/plugin-data-enhancement` | AI-powered data enhancement plugin |
-| `@rebasepro/plugin-insights` | Analytics and insights plugin |
-
----
-
-## 🎨 Standalone UI Library
-
-Rebase exposes its design system as a completely independent library. Fully typed, accessible, and customizable via Tailwind CSS v4:
-
-```bash
-npm install @rebasepro/ui
-```
+| `useRebaseContext` | Access the top-level Rebase context |
+| `useDialogsController` | Programmatic dialog management |
+| `useSnackbarController` | Show snackbar notifications |
+| `useModeController` / `useBuildModeController` | Light/dark mode |
+| `useStorageSource` / `useBackendStorageSource` | Storage source from context |
+| `useRebaseClient` | Access the `RebaseClient` instance |
+| `useLargeLayout` | Responsive layout breakpoint hook |
+| `useClipboard` | Copy-to-clipboard |
+| `useUnsavedChangesDialog` | Prompt user about unsaved changes |
+| `useCustomizationController` | UI customization overrides |
+| `useRebaseRegistry` | Access the collection/plugin registry |
+| `useTranslation` | i18n translation hook |
+| `useAnalyticsController` | Analytics event tracking |
+
+### Hooks — Studio Bridge
+
+| Export | Description |
+|---|---|
+| `useStudioBridge` | Access bridge context for CMS↔Studio communication |
+| `useBridgeRegistration` | Register bridge callbacks (self-assembling) |
 
----
+### Components
 
-## Demo
+| Export | Description |
+|---|---|
+| `LoginView` | Pre-built login/register form UI |
+| `RebaseAuth` | Auth gate component — handles login flow rendering |
+| `ErrorView` | Error display component |
+| `ConfirmationDialog` | Configurable confirmation dialog |
+| `UnsavedChangesDialog` | "Discard changes?" dialog |
+| `NotFoundPage` | 404 page |
+| `UserSettingsView` | User profile settings page |
+| `UserSelectPopover` / `UserDisplay` | User avatar/name display |
+| `LanguageToggle` | i18n language switcher |
+| `BootstrapAdminBanner` | First-user setup banner |
+| `RebaseLogo` | Rebase branding logo |
+| `UIStyleGuide` / `UIReferenceView` | Debug/reference components |
+
+### Contexts
+
+| Export | Description |
+|---|---|
+| `SnackbarProvider` | Snackbar notification context |
+| `ModeController` | Light/dark mode context |
+| `AdminModeController` | Admin mode context |
+| `EffectiveRoleController` | User role context |
+| `AuthControllerContext` | Auth controller context |
+| `DataDriverContext` | Data driver context |
+| `StorageSourceContext` | Storage source context |
+| `DialogsProvider` | Dialog management context |
+| `RebaseClientInstanceContext` | Client instance context |
+| `CustomizationControllerContext` | UI customization context |
+| `AnalyticsContext` | Analytics context |
+
+### Utilities
+
+| Export | Description |
+|---|---|
+| `iconList` / icon helpers | Full icon set and lookup |
+| `createFormexStub` | Create a form stub for testing |
+| `entityCache` | Entity LRU cache |
+| `useStorageUploadController` | File upload progress controller |
+| `previews` | Preview rendering utilities |
+| `enums` / `constants` | Shared enums and constant values |
 
-Explore a live interactive sandbox with all features — data resets periodically:
+### i18n
 
-**👉 [demo.rebase.pro](https://demo.rebase.pro)**
+| Export | Description |
+|---|---|
+| `RebaseI18nProvider` | i18n context provider |
+| `en` locale | English translations |
+| `es` locale | Spanish translations |
 
----
+### Vite Plugin
 
-## Support & Community
+Available as a separate entry point:
 
-- 📖 [Documentation](https://rebase.pro/docs)
-- 💬 [Discord Community](https://discord.gg/fxy7xsQm3m)
-- 🐛 [GitHub Issues](https://github.com/rebasepro/rebase/issues)
-- 📝 [Changelog](./CHANGELOG.md)
+```ts
+import { rebaseVitePlugin } from "@rebasepro/core/vitePlugin";
+```
 
----
+## Quick Start
+
+```tsx
+import { Rebase, useAuthController, useCollectionFetch } from "@rebasepro/core";
+
+function App() {
+    return (
+        <Rebase
+            collections={collections}
+            authController={authController}
+            dataSource={dataSource}
+        />
+    );
+}
+
+// Inside any child component:
+function ProductList() {
+    const { data, loading } = useCollectionFetch("products", { limit: 20 });
+    // ...
+}
+```
 
-## License
+## Related Packages
 
-Rebase is open-source and licensed under the **MIT License**.
-See the full [License](https://github.com/rebasepro/rebase/blob/main/LICENSE) for details.
+- [`@rebasepro/admin`](../admin) — CMS views, forms, and routing (built on top of core)
+- [`@rebasepro/ui`](../ui) — Design system components
+- [`@rebasepro/common`](../common) — Shared utilities and collection registry
+- [`@rebasepro/types`](../types) — TypeScript type definitions
+- [`@rebasepro/formex`](../formex) — Form state management
+- [`@rebasepro/client`](../client) — HTTP client SDK

package/dist/components/LoginView/LoginView.d.ts

@@ -92,10 +92,18 @@ export interface LoginViewProps {
      * If not set, derived from `authController.capabilities.registration`.
      */
     registrationEnabled?: boolean;
+    /**
+     * Pre-fill the email field (e.g. for demo or testing environments).
+     */
+    defaultEmail?: string;
+    /**
+     * Pre-fill the password field (e.g. for demo or testing environments).
+     */
+    defaultPassword?: string;
 }
 /**
  * Generic login view component that works with any AuthControllerExtended.
  * Feature-detects capabilities to show/hide login methods.
  * @group Core
  */
-export declare function LoginView({ logo, authController, noUserComponent, disableSignupScreen, disabled, notAllowedError, googleClientId, githubClientId, linkedinClientId, title, subtitle, needsSetup, registrationEnabled, additionalComponent }: LoginViewProps): import("react/jsx-runtime").JSX.Element;
+export declare function LoginView({ logo, authController, noUserComponent, disableSignupScreen, disabled, notAllowedError, googleClientId, githubClientId, linkedinClientId, title, subtitle, needsSetup, registrationEnabled, additionalComponent, defaultEmail, defaultPassword }: LoginViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/common/types.d.ts

@@ -1,4 +1,4 @@
-import type { Property } from "@rebasepro/types";
+import type { Property, Entity } from "@rebasepro/types";
 import { CollectionSize, SelectedCellProps } from "@rebasepro/types";
 export type EntityCollectionTableController<M extends Record<string, unknown>> = {
     /**
@@ -26,7 +26,7 @@ export type EntityCollectionTableController<M extends Record<string, unknown>> =
      * Callback used when the value of a cell has changed.
      * @param params
      */
-    onValueChange?: (params: OnCellValueChangeParams<unknown, M>) => void;
+    onValueChange?: (params: OnCellValueChangeParams<unknown, Entity<M>>) => void;
     /**
      * Size of the elements in the collection
      */
@@ -56,7 +56,7 @@ export type UniqueFieldValidator = (props: {
  * Callback when a cell has changed in a table
  * @group Collection components
  */
-export type OnCellValueChange<T, M extends Record<string, unknown>> = (params: OnCellValueChangeParams<T, M>) => Promise<void> | void;
+export type OnCellValueChange<T, M extends Record<string, unknown>> = (params: OnCellValueChangeParams<T, Entity<M>>) => Promise<void> | void;
 /**
  * @group Collection components
  */

package/dist/hooks/data/useCollectionFetch.d.ts

@@ -16,6 +16,14 @@ export interface CollectionFetchProps<M extends Record<string, any>> {
      * Number of entities to fetch
      */
     itemCount?: number;
+    /**
+     * Number of items to skip
+     */
+    offset?: number;
+    /**
+     * Page number (1-indexed), alternative to offset
+     */
+    page?: number;
     /**
      * Filter the fetched data by the property
      */
@@ -37,6 +45,7 @@ export interface CollectionFetchResult<M extends Record<string, any>> {
     dataLoading: boolean;
     noMoreToLoad: boolean;
     dataLoadingError?: Error;
+    totalCount?: number;
 }
 /**
  * This hook is used to fetch collections using a given collection
@@ -45,7 +54,9 @@ export interface CollectionFetchResult<M extends Record<string, any>> {
  * @param filterValues
  * @param sortBy
  * @param itemCount
+ * @param offset
+ * @param page
  * @param searchString
  * @group Hooks and utilities
  */
-export declare function useCollectionFetch<M extends Record<string, any>, USER extends User>({ path, collection, filterValues, sortBy, itemCount, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;
+export declare function useCollectionFetch<M extends Record<string, any>, USER extends User>({ path, collection, filterValues, sortBy, itemCount, offset, page, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;