@rebasepro/types 0.0.1-canary.e259309 → 0.0.1-canary.eb08332

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Rebase
+Copyright (c) 2026 Rebase
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,174 +1,93 @@
-<p align="center">
-    <img src="https://rebase.pro/img/dark_mode.webp" alt="Intro video" style="max-width: 100%;"/>
-</p>
-
-<p align="center">
-  <a href="https://rebase.pro">
-    <img src="https://rebase.pro/img/logo_small.png" width="240px" alt="Rebase logo" />
-  </a>
-</p>
-
-<h1 align="center">Rebase</h1>
-<h3 align="center">Awesome Firebase/MongoDB-based headless CMS</h3>
-<p align="center"><a href="https://demo.rebase.pro">Live demo</a></p>
-
-<br />
-
-
-[![NPM](https://img.shields.io/npm/v/rebase.svg)](https://www.npmjs.com/package/rebase) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-Designed by developers for developers, Rebase is a headless CMS and admin panel
-that seamlessly integrates with **Firebase and Firestore** by default, but is
-also
-compatible with any backend.
-
-Effortlessly generate **CRUD views** based on your configuration. Rebase is
-simple
-to set up for standard cases and easy to extend and customize for more specific
-needs.
-
-Built to produce collection and form views that naturally align with the
-collection/document model, Rebase covers a wide range of basic and advanced use
-cases. With extensibility in mind, it's easy to create your own views or modify
-existing ones.
-
-Rebase does **not impose any data structure** restrictions, ensuring a smooth,
-out-of-the-box experience for any project.
-
-### Core technologies
-
-Rebase is based on this great technologies:
-
-- Typescript
-- Tailwind CSS
-- Firebase SDK 10
-- React + React Router 6
-
-### Quickstart
-
-The easiest way to get going is to check our quickstart guide! You will just
-need to follow some quick steps:
-
-https://rebase.pro/docs
-
-### Demo
-
-Check the demo with all the core functionalities.
-
-https://demo.rebase.pro
-
-> You can modify the data, but it gets periodically restored.
-
-### Changelog
-
-https://rebase.pro/docs/changelog
-
-## Features
-
-Rebase has been meticulously crafted to make it incredibly easy for developers
-to build a CMS/admin tool while offering an excellent data editing experience
-and a user-friendly interface for marketers and content managers.
-
-### 🏓 Exceptional Spreadsheet View
-
-We've developed a highly efficient windowed **spreadsheet view** for
-collections, allowing inline editing for most common fields, as well as popup
-views for other cases and your custom field implementations.
-
-Featuring **real-time** support, Rebase is perfect for apps that require
-constant updates. It also supports **text search** (through an external provider
-like Algolia, if using Firestore), **filtering and sorting**, and **exporting**
-data.
-
-### ✨ Robust Forms
-
-![fields](https://rebase.pro/img/form_editing.webp)
-
-When editing an entity, Rebase offers a nested system of side dialogs for
-navigating through **subcollections** and accessing custom views (such as custom
-forms or blog previews). This functionality can also be accessed
-programmatically using the `useSideEntityController` hook.
-
-Rebase includes **over 20 built-in fields** with numerous customization and
-validation options. The components have been carefully designed for an
-outstanding user experience, including advanced features like **references** to
-other collections, **markdown**, and **array reordering**.
-
-For unsupported use cases, create your own **custom field** as a React
-component.
-
-Rebase also supports **conditional fields** in forms, allowing you to define
-rules for active fields based on your logic.
-
-### 👮 Authentication, Permissions, and Role System
-
-Define which navigation views users can see and the operations (create, edit,
-delete) they can perform based on your role system. You can even configure this
-on a per-entity or collection level.
-
-By default, Rebase supports all Firebase authorization mechanisms, but you can
-implement your own.
-
-### 🏹 Relational Support
-
-Define references to entities in other collections and benefit from the
-integrated reference fields and shortcuts.
-
-You can also define subcollections at the entity level for nesting data in a
-collection/document/collection model.
-
-### 🆒 Real-Time Data
-
-Every view in the CMS supports real-time data, making it suitable for displaying
-constantly updated information.
-
-Forms also support this feature, with any modified value in the database being
-updated in any open form view as long as it hasn't been touched by the user.
-This enables advanced cases where a Cloud Function is triggered after saving an
-entity, modifying some values, and requiring real-time updates.
-
-### 🗂️ File Storage
-
-Rebase supports uploading files to Firebase Storage out of the box and provides
-specific fields for handling single and multiple file uploads, as well as
-reordering.
-
-You can replace the Firebase Storage implementation with your own.
-
-## Included example
-
-You can access the code for the demo project under
-[`example`](https://github.com/rebasepro/rebase/tree/master/example). It includes
-every feature provided by this CMS.
-
-Keep in mind you need to update the dependencies in that project if you want to
-use it as it is, without linking it to the library source code. More details in
-its README
-
-## Contact and support
-
-If you need general support, you can open a GitHub issue.
-
-Do you need consulting setting up your Firestore-based CMS in no time? We are
-happy to help!
-`hello@rebase.pro`
-
-## Development
-
-If you would like to make changes to the source, feel free to submit a PR!
-
-When developing, the core library can be found under `lib`.
-There is an example project in the folder `example`.
-
-In order to run the project, you need to create a file
-called `firebase_config.ts`
-in `example/src`.
-
-That file needs to export a valid Firebase config, that you can get
-from your Firebase console when creating a webapp for your project.
-
-Then simply run `yarn` and `yarn dev`
-
-## License
-
-MIT © [Rebase](https://github.com/Rebaseco)
+# @rebasepro/types
+
+Shared TypeScript type definitions and interfaces for the Rebase ecosystem.
+
+## Installation
+
+```bash
+pnpm add @rebasepro/types
+```
+
+## What This Package Does
+
+Provides the canonical type definitions used across all Rebase packages — both client-side and server-side. This is a **types-only** package with no runtime dependencies. Every other `@rebasepro/*` package depends on it.
+
+## Key Exports
+
+### Collection & Snapshot Types
+
+| Export | Description |
+|--------|-------------|
+| `CollectionConfig` | Full collection definition (name, slug, properties, callbacks, security rules, views) |
+| `Property` | Union type for all property configurations (text, number, date, reference, array, map, etc.) |
+| `Snapshot` | Generic snapshot record type |
+| `CollectionCallbacks` | Lifecycle hooks (`onPreSave`, `onSaveSuccess`, `onDelete`, etc.) |
+| `SnapshotValues` | Record of property values for a snapshot |
+| `SecurityRule` | RLS-style access control rule for a collection |
+
+### Backend & Driver Interfaces
+
+| Export | Description |
+|--------|-------------|
+| `DataDriver` | Abstract interface for database drivers (`fetchCollection`, `saveSnapshot`, `deleteSnapshot`, etc.) |
+| `DatabaseAdapter` | Pluggable database adapter interface (used by `server`) |
+| `BackendBootstrapper` | Lifecycle interface for initializing database drivers, auth, history, and realtime |
+| `DatabaseAdmin` | Admin operations interface (SQL execution, collection stats, table metadata) |
+| `RealtimeProvider` | Interface for realtime subscription providers |
+| `BackendConfig` / `BackendInstance` | Abstract backend configuration and instance types |
+| `HealthCheckResult` | Return type for health check operations |
+| `InitializedDriver` | Result of driver initialization (driver, realtime, registry, internals) |
+| `BootstrappedAuth` | Result of auth initialization (user service, role service, email service) |
+
+### Auth & User Types
+
+| Export | Description |
+|--------|-------------|
+| `AuthAdapter` | Pluggable auth adapter interface (for Clerk, Auth0, custom auth) |
+| `AuthController` | Client-side auth controller interface |
+| `RebaseUser` | User record type |
+| `Role` | Role definition type |
+
+### Controller Interfaces
+
+| Export | Description |
+|--------|-------------|
+| `RebaseClient` | Top-level client interface (data, auth, storage, email) |
+| `DataSourceDelegate` | Data operations interface for client-side data sources |
+| `StorageSource` | File storage interface |
+| `CollectionRegistryInterface` | Collection lookup and registration |
+| `NavigationController` | App navigation interface |
+
+### Other
+
+| Export | Description |
+|--------|-------------|
+| `CronJobDefinition` | Cron job configuration type |
+| `CollectionCallbacks` | Lifecycle callbacks for snapshot CRUD operations |
+| `PluginConfig` | Plugin system types |
+| `WebSocketMessage` | WebSocket protocol message types |
+| `Locale` | Localization types |
+
+## Quick Start
+
+```typescript
+import type {
+  CollectionConfig,
+  DataDriver,
+  DatabaseAdapter,
+  RebaseUser,
+  Property,
+} from "@rebasepro/types";
+```
+
+## Related Packages
+
+Every `@rebasepro/*` package depends on this one. Key consumers:
+
+| Package | Uses |
+|---------|------|
+| `@rebasepro/server` | `DataDriver`, `DatabaseAdapter`, `BackendBootstrapper`, `AuthAdapter` |
+| `@rebasepro/server-postgres` | `BackendBootstrapper`, `InitializedDriver`, `RealtimeProvider` |
+| `@rebasepro/server-mongo` | `BackendBootstrapper`, `DataDriver`, `CollectionConfig` |
+| `@rebasepro/client` | `RebaseClient`, `DataSourceDelegate`, `StorageSource` |
+| `@rebasepro/admin` | `CollectionConfig`, `Property`, `PluginConfig`, controller interfaces |

package/dist/controllers/auth.d.ts

@@ -1,6 +1,4 @@
-import { StorageSource } from "./storage";
-import { Role, User } from "../users";
-import { RebaseData } from "./data";
+import type { User } from "../users";
 /**
  * Capabilities advertised by an auth provider.
  * UI components use this to show/hide features dynamically
@@ -11,7 +9,13 @@ export interface AuthCapabilities {
     emailPasswordLogin?: boolean;
     googleLogin?: boolean;
     registration?: boolean;
+    /** Self-service password reset (emailing a reset link) is available. */
     passwordReset?: boolean;
+    /**
+     * An admin can reset another user's password. Gates the "Reset Password"
+     * entity action in the admin UI. See `AuthAdapterCapabilities`.
+     */
+    adminPasswordReset?: boolean;
     sessionManagement?: boolean;
     profileUpdate?: boolean;
     emailVerification?: boolean;
@@ -64,7 +68,7 @@ export type AuthController<USER extends User = User, ExtraData = unknown> = {
     extra: ExtraData;
     setExtra: (extra: ExtraData) => void;
     setUser?(user: USER | null): void;
-    setUserRoles?(roles: Role[]): void;
+    setUserRoles?(roles: string[]): void;
     /**
      * Capabilities advertised by the auth provider.
      * UI components use this to feature-detect what the backend supports.
@@ -73,15 +77,24 @@ export type AuthController<USER extends User = User, ExtraData = unknown> = {
 };
 /**
  * Extended auth controller with common optional auth methods.
- * Backend implementations (Rebase backend, Firebase, Supabase, etc.)
+ * Backend implementations (Rebase backend, Firebase, etc.)
  * extend this with their own backend-specific extras.
  * @group Hooks and utilities
  */
 export interface AuthControllerExtended<USER extends User = User, ExtraData = unknown> extends AuthController<USER, ExtraData> {
     /** Login with email and password */
     emailPasswordLogin?(email: string, password: string): Promise<void>;
-    /** Login with a Google ID token or trigger Google popup */
-    googleLogin?(idToken: string): Promise<void>;
+    /** Login with Google — accepts an ID token, access token, or authorization code payload */
+    googleLogin?: (payload: {
+        idToken: string;
+    } | {
+        accessToken: string;
+    } | {
+        code: string;
+        redirectUri: string;
+    }) => Promise<void>;
+    /** Generic OAuth login — works with any provider. Posts payload to /auth/{providerId}. */
+    oauthLogin?: (providerId: string, payload: Record<string, unknown>) => Promise<void>;
     /** Register a new user */
     register?(email: string, password: string, displayName?: string): Promise<void>;
     /** Skip login (for anonymous access if enabled) */
@@ -95,25 +108,3 @@ export interface AuthControllerExtended<USER extends User = User, ExtraData = un
     /** Update user profile */
     updateProfile?(displayName?: string, photoURL?: string): Promise<USER>;
 }
-/**
- * Implement this function to allow access to specific users.
- * @group Hooks and utilities
- */
-export type Authenticator<USER extends User = User> = (props: {
-    /**
-     * Logged-in user or null
-     */
-    user: USER | null;
-    /**
-     * AuthController
-     */
-    authController: AuthController<USER>;
-    /**
-     * Unified data access API
-     */
-    data: RebaseData;
-    /**
-     * Used storage implementation
-     */
-    storageSource: StorageSource;
-}) => boolean | Promise<boolean>;