@rebasepro/types 0.0.1-canary.0 → 0.0.1-canary.0e2f892

package/dist/controllers/effective_role.d.ts

@@ -0,0 +1,4 @@
+export interface EffectiveRoleController {
+    effectiveRole: string | null;
+    setEffectiveRole: (role: string | null) => void;
+}

package/dist/controllers/email.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Email service types — portable interface shared by RebaseClient and server-core.
+ *
+ * The concrete SMTP implementation lives in `@rebasepro/server-core/email`.
+ * This file provides only the consumer-facing contract so that it can be
+ * referenced from `RebaseClient` without dragging in nodemailer.
+ */
+/**
+ * Options for sending an email via the Rebase email service.
+ */
+export interface EmailSendOptions {
+    /** Recipient email address(es). */
+    to: string | string[];
+    /** Email subject line. */
+    subject: string;
+    /** HTML body content. */
+    html: string;
+    /** Optional plain-text fallback. */
+    text?: string;
+    /** Optional reply-to address. */
+    replyTo?: string;
+}
+/**
+ * Abstraction over an email delivery backend.
+ *
+ * Implementations may use SMTP, AWS SES, Resend, Postmark, or any other
+ * provider — consumers only interact through this interface.
+ */
+export interface EmailService {
+    /** Send a single email. */
+    send(options: EmailSendOptions): Promise<void>;
+    /** Returns `true` when the service has valid credentials / is ready to send. */
+    isConfigured(): boolean;
+}

package/dist/controllers/index.d.ts

@@ -1,11 +1,18 @@
+export * from "./collection_registry";
 export * from "./analytics_controller";
 export * from "./auth";
-export * from "./customization_controller";
-export * from "./datasource";
-export * from "./dialogs_controller";
+export * from "./data";
+export * from "./database_admin";
+export * from "./data_driver";
 export * from "./local_config_persistence";
 export * from "./navigation";
-export * from "./side_dialogs_controller";
+export * from "./effective_role";
+export * from "./storage";
+export * from "./email";
+export * from "./client";
+export * from "./customization_controller";
 export * from "./side_entity_controller";
+export * from "./side_dialogs_controller";
+export * from "./dialogs_controller";
 export * from "./snackbar";
-export * from "./storage";
+export * from "./registry";

package/dist/controllers/local_config_persistence.d.ts

@@ -1,16 +1,16 @@
-import { EntityCollection } from "../types";
+import type { EntityCollection } from "../types/collections";
 /**
  * @group Models
  */
-export type PartialEntityCollection<M extends Record<string, any> = any> = Partial<EntityCollection<M>>;
+export type PartialEntityCollection<M extends Record<string, unknown> = Record<string, unknown>> = Partial<EntityCollection<M>>;
 /**
  * This interface is in charge of defining the controller that persists
  * modifications to a collection or collection, and retrieves them back from
  * a data source, such as local storage or Firestore.
  */
 export interface UserConfigurationPersistence {
-    onCollectionModified: <M extends Record<string, any> = any>(path: string, partialCollection: PartialEntityCollection<M>) => void;
-    getCollectionConfig: <M extends Record<string, any> = any>(path: string) => PartialEntityCollection<M>;
+    onCollectionModified: <M extends Record<string, unknown> = Record<string, unknown>>(path: string, partialCollection: PartialEntityCollection<M>) => void;
+    getCollectionConfig: <M extends Record<string, unknown> = Record<string, unknown>>(path: string) => PartialEntityCollection<M>;
     recentlyVisitedPaths: string[];
     setRecentlyVisitedPaths: (paths: string[]) => void;
     favouritePaths: string[];

package/dist/controllers/navigation.d.ts

@@ -1,10 +1,11 @@
 import React from "react";
-import { EntityCollection, EntityReference, RebasePlugin } from "../types";
+import type { EntityCollection } from "../types/collections";
+import type { RebasePlugin } from "../types/plugins";
 /**
  * Controller that handles URL path building and resolution.
  * @group Models
  */
-export type CMSUrlController = {
+export type UrlController = {
     /**
      * Default path under the navigation routes of the CMS will be created.
      * Defaults to '/'. You may want to change this `basepath` to 'admin' for example.
@@ -43,7 +44,7 @@ export type CMSUrlController = {
      * Build a URL path for the CMS (e.g. for custom views)
      * @param path
      */
-    buildCMSUrlPath: (path: string) => string;
+    buildAppUrlPath: (path: string) => string;
     /**
      * Turn a path with collection ids into a resolved path.
      * The ids (typically used in urls) will be replaced with relative paths (typically used in database paths)
@@ -68,12 +69,12 @@ export type NavigationStateController = {
      * Custom additional views created by the developer, added to the main
      * navigation
      */
-    views?: CMSView[];
+    views?: AppView[];
     /**
      * Custom additional views created by the developer, added to the admin
      * navigation
      */
-    adminViews?: CMSView[];
+    adminViews?: AppView[];
     /**
      * Configuration for the views that should be displayed at the top
      * level of the navigation (e.g. in the home page or the navigation
@@ -96,58 +97,8 @@ export type NavigationStateController = {
     /**
      * Plugin system allowing to extend the CMS functionality.
      */
-    plugins?: RebasePlugin<any, any, any>[];
+    plugins?: RebasePlugin[];
 };
-/**
- * Controller that provides access to the registered entity collections.
- * @group Models
- */
-export type CollectionRegistryController<EC extends EntityCollection = EntityCollection<any>> = {
-    /**
-     * List of the mapped collections in the CMS.
-     * Each entry relates to a collection in the root database.
-     * Each of the navigation entries in this field
-     * generates an entry in the main menu.
-     */
-    collections?: EntityCollection[];
-    /**
-     * Is the registry ready to be used
-     */
-    initialised: boolean;
-    /**
-     * Get the collection configuration for a given path.
-     * The collection is resolved from the given path or alias.
-     */
-    getCollection: (slugOrPath: string, includeUserOverride?: boolean) => EC | undefined;
-    /**
-     * Get the raw, un-normalized collection configuration.
-     * This bypasses the `CollectionRegistry` normalization (such as injecting `relation` instances).
-     * This is strictly for the Visual Editor to manipulate AST code without persisting runtime state.
-     */
-    getRawCollection: (slugOrPath: string) => EC | undefined;
-    /**
-     * Retrieve all the related parent references for a given path
-     * @param path
-     */
-    getParentReferencesFromPath: (path: string) => EntityReference[];
-    /**
-     * Retrieve all the related parent collection ids for a given path
-     * @param path
-     */
-    getParentCollectionIds: (path: string) => string[];
-    /**
-     * Resolve paths from a list of ids
-     * @param ids
-     */
-    convertIdsToPaths: (ids: string[]) => string[];
-};
-/**
- * Legacy monolithic controller that includes the resolved navigation and utility methods and attributes.
- * It is a combination of CMSUrlController, NavigationStateController, and CollectionRegistryController.
- * @group Models
- * @deprecated Use the specific controllers instead.
- */
-export type NavigationController<EC extends EntityCollection = EntityCollection<any>> = CMSUrlController & NavigationStateController & CollectionRegistryController<EC>;
 export interface NavigateOptions {
     replace?: boolean;
     state?: unknown;
@@ -167,7 +118,7 @@ export type NavigationBlocker = {
  * navigation.
  * @group Models
  */
-export interface CMSView {
+export interface AppView {
     /**
      * CMS Path you can reach this view from.
      */
@@ -182,9 +133,9 @@ export interface CMSView {
     description?: string;
     /**
      * Icon key to use in this view.
-     * You can use any of the icons in the Material specs:
-     * https://fonts.google.com/icons
-     * e.g. 'account_tree' or 'person'
+     * You can use any of the icons in the Lucide specs:
+     * https://lucide.dev/icons/
+     * e.g. 'ShoppingCart' or 'User'
      * Find all the icons in https://rebase.pro/docs/icons
      */
     icon?: string | React.ReactNode;
@@ -250,7 +201,7 @@ export interface NavigationEntry {
     slug: string;
     type: "collection" | "view" | "admin";
     collection?: EntityCollection;
-    view?: CMSView;
+    view?: AppView;
     description?: string;
     group: string;
 }

package/dist/controllers/registry.d.ts

@@ -0,0 +1,54 @@
+import { ReactNode } from "react";
+import type { EntityCollection } from "../types/collections";
+import type { EntityCollectionsBuilder } from "../types/builders";
+import type { EntityCustomView } from "../types/entity_views";
+import type { EntityAction } from "../types/entity_actions";
+import type { AppView } from "./navigation";
+/**
+ * Options to enable the built-in collection editor.
+ * When provided to `<RebaseCMS>`, the editor is auto-wired as a native feature.
+ */
+export interface CollectionEditorOptions {
+    /**
+     * Function that returns an auth token for schema-editor API calls.
+     * Falls back to `authController.getAuthToken` when omitted.
+     */
+    getAuthToken?: () => Promise<string | null>;
+    /** Mark the editor as read-only (disable mutations). */
+    readOnly?: boolean;
+    /** Suggested base paths shown when creating new collections. */
+    pathSuggestions?: string[];
+}
+export interface RebaseCMSConfig<EC extends EntityCollection = any> {
+    collections?: EC[] | EntityCollectionsBuilder<EC>;
+    homePage?: ReactNode;
+    entityViews?: EntityCustomView<any>[];
+    entityActions?: EntityAction[];
+    plugins?: any[];
+    /**
+     * Enable the built-in visual collection/schema editor.
+     * Pass `true` for zero-config, or an options object for fine-grained control.
+     * When enabled, the editor slots, provider, and Studio schema view
+     * are all auto-wired — no plugin or manual view injection needed.
+     */
+    collectionEditor?: boolean | CollectionEditorOptions;
+}
+export interface RebaseStudioConfig {
+    tools?: ("sql" | "js" | "rls" | "schema" | "storage" | "cron" | "schema-visualizer" | "branches" | "api")[];
+    homePage?: ReactNode;
+    devViews?: AppView[];
+}
+export interface RebaseAuthConfig {
+    loginView?: ReactNode;
+}
+export interface RebaseRegistryController {
+    cmsConfig: RebaseCMSConfig | null;
+    studioConfig: RebaseStudioConfig | null;
+    authConfig: RebaseAuthConfig | null;
+    registerCMS: (config: RebaseCMSConfig) => void;
+    unregisterCMS: () => void;
+    registerStudio: (config: RebaseStudioConfig) => void;
+    unregisterStudio: () => void;
+    registerAuth: (config: RebaseAuthConfig) => void;
+    unregisterAuth: () => void;
+}

package/dist/controllers/side_entity_controller.d.ts

@@ -1,10 +1,10 @@
-import { Entity, EntityCollection } from "../types";
-import { EntityFormProps } from "../components";
+import type { Entity } from "../types/entities";
+import type { EntityCollection } from "../types/collections";
 /**
  * Props used to open a side dialog
  * @group Hooks and utilities
  */
-export interface EntitySidePanelProps<M extends Record<string, any> = any> {
+export interface EntitySidePanelProps<M extends Record<string, unknown> = Record<string, unknown>> {
     /**
      * Absolute path of the entity
      */
@@ -44,7 +44,7 @@ export interface EntitySidePanelProps<M extends Record<string, any> = any> {
      * @param params
      */
     onUpdate?: (params: {
-        entity: Entity<any>;
+        entity: Entity<M>;
     }) => void;
     /**
      * Callback when the dialog is closed
@@ -57,7 +57,7 @@ export interface EntitySidePanelProps<M extends Record<string, any> = any> {
     /**
      * Override some form properties
      */
-    formProps?: Partial<EntityFormProps<M>>;
+    formProps?: Record<string, unknown>;
     /**
      * Allow the user to open the entity fullscreen
      */
@@ -81,10 +81,10 @@ export interface SideEntityController {
      * (or a new one with that id).
      * @param props
      */
-    open: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+    open: <M extends Record<string, unknown> = Record<string, unknown>>(props: EntitySidePanelProps<M>) => void;
     /**
      * Replace the last open entity panel with the given one.
      * @param props
      */
-    replace: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+    replace: <M extends Record<string, unknown> = Record<string, unknown>>(props: EntitySidePanelProps<M>) => void;
 }

package/dist/controllers/storage.d.ts

@@ -3,8 +3,7 @@
  */
 export interface UploadFileProps {
     file: File;
-    fileName?: string;
-    path?: string;
+    key: string;
     metadata?: Record<string, unknown>;
     bucket?: string;
 }
@@ -13,9 +12,9 @@ export interface UploadFileProps {
  */
 export interface UploadFileResult {
     /**
-     * Storage path including the file name where the file was uploaded.
+     * Storage key including the file name where the file was uploaded.
      */
-    path: string;
+    key: string;
     /**
      * Bucket where the file was uploaded
      */
@@ -23,7 +22,7 @@ export interface UploadFileResult {
     /**
      * Fully qualified storage URL for the uploaded file.
      *
-     * For example: `gs://my-bucket/path/to/file.png`.
+     * For example: `s3://my-bucket/path/to/file.png`.
      *
      * This is optional for backwards compatibility.
      */
@@ -74,39 +73,38 @@ export declare interface DownloadMetadata {
  */
 export interface StorageSource {
     /**
-     * Upload a file, specifying a name and a path
+     * Upload an object, specifying a key
      * @param file
-     * @param fileName
-     * @param path
+     * @param key
      * @param metadata
      * @param bucket
      */
-    uploadFile: ({ file, fileName, path, metadata, bucket }: UploadFileProps) => Promise<UploadFileResult>;
+    putObject: ({ file, key, metadata, bucket }: UploadFileProps) => Promise<UploadFileResult>;
     /**
-     * Convert a storage path or URL into a download configuration
-     * @param path
+     * Convert a storage key or URL into a download configuration (signed URL equivalent)
+     * @param keyOrUrl
      * @param bucket
      */
-    getDownloadURL: (pathOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
+    getSignedUrl: (keyOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
     /**
-     * Get a file from a storage path.
-     * It returns null if the file does not exist.
-     * @param props
+     * Get an object from a storage key.
+     * It returns null if the object does not exist.
+     * @param key
      * @param bucket
      */
-    getFile: (path: string, bucket?: string) => Promise<File | null>;
+    getObject: (key: string, bucket?: string) => Promise<File | null>;
     /**
-     * Delete a file.
-     * @param path
+     * Delete an object.
+     * @param key
      * @param bucket
      */
-    deleteFile: (path: string, bucket?: string) => Promise<void>;
+    deleteObject: (key: string, bucket?: string) => Promise<void>;
     /**
-     * List the contents of a path.
-     * @param path
+     * List the contents of a prefix.
+     * @param prefix
      * @param options
      */
-    list: (path: string, options?: {
+    listObjects: (prefix: string, options?: {
         bucket?: string;
         maxResults?: number;
         pageToken?: string;
@@ -137,15 +135,15 @@ export declare interface StorageListResult {
     nextPageToken?: string;
 }
 /**
- * Represents a reference to a Google Cloud Storage object. Developers can
+ * Represents a reference to an S3-compatible storage object. Developers can
  * upload, download, and delete objects, as well as get/set object metadata.
  * @public
  */
 export declare interface StorageReference {
     /**
-     * Returns a gs:// URL for this object in the form
-     *   `gs://<bucket>/<path>/<to>/<object>`
-     * @returns The gs:// URL.
+     * Returns a s3:// URL for this object in the form
+     *   `s3://<bucket>/<path>/<to>/<object>`
+     * @returns The s3:// URL.
      */
     toString(): string;
     /**

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./rebase_context";
 export * from "./types";
-export * from "./components";
 export * from "./controllers";
 export * from "./users";

package/dist/index.es.js

@@ -10,42 +10,42 @@ class EntityReference {
    */
   path;
   /**
-   * Which datasource (e.g., 'postgres', 'firestore').
+   * Which driver (e.g., 'postgres', 'firestore').
    * Defaults to "(default)" if not specified.
    */
-  datasource;
+  driver;
   /**
-   * Which database within the datasource.
+   * Which database within the driver.
    * Defaults to "(default)" if not specified.
    */
   databaseId;
   /**
    * Create a reference to an entity.
-   * 
+   *
    * @example
    * // Simple reference (most common case)
    * new EntityReference({ id: "123", path: "users" })
-   * 
-   * // With datasource
-   * new EntityReference({ id: "123", path: "analytics", datasource: "firestore" })
+   *
+   * // With driver
+   * new EntityReference({ id: "123", path: "analytics", driver: "firestore" })
    */
   constructor(props) {
     this.id = props.id;
     this.path = props.path;
-    this.datasource = props.datasource;
+    this.driver = props.driver;
     this.databaseId = props.databaseId;
   }
   get pathWithId() {
     return `${this.path}/${this.id}`;
   }
   /**
-   * Get the full path including datasource and database prefixes if specified.
-   * For the common case (single datasource, single db), this just returns pathWithId.
+   * Get the full path including driver and database prefixes if specified.
+   * For the common case (single driver, single db), this just returns pathWithId.
    */
   get fullPath() {
     const parts = [];
-    if (this.datasource && this.datasource !== "(default)") {
-      parts.push(this.datasource);
+    if (this.driver && this.driver !== "(default)") {
+      parts.push(this.driver);
     }
     if (this.databaseId && this.databaseId !== "(default)") {
       parts.push(this.databaseId);
@@ -70,9 +70,15 @@ class EntityRelation {
    * to the root of the database).
    */
   path;
-  constructor(id, path) {
+  /**
+   * Pre-fetched data payload to eliminate N+1 queries.
+   * When present, clients can use this directly instead of fetching.
+   */
+  data;
+  constructor(id, path, data) {
     this.id = id;
     this.path = path;
+    this.data = data;
   }
   get pathWithId() {
     return `${this.path}/${this.id}`;
@@ -104,10 +110,109 @@ class Vector {
     this.value = value;
   }
 }
+function isPostgresCollection(collection) {
+  return !collection.driver || collection.driver === "postgres";
+}
+function isFirebaseCollection(collection) {
+  return collection.driver === "firestore";
+}
+function isMongoDBCollection(collection) {
+  return collection.driver === "mongodb";
+}
+function isSQLAdmin(admin) {
+  return !!admin && typeof admin.executeSql === "function";
+}
+function isDocumentAdmin(admin) {
+  return !!admin && (typeof admin.executeAggregate === "function" || typeof admin.fetchCollectionStats === "function");
+}
+function isSchemaAdmin(admin) {
+  return !!admin && (typeof admin.fetchUnmappedTables === "function" || typeof admin.fetchTableMetadata === "function");
+}
+function isBranchAdmin(admin) {
+  return !!admin && typeof admin.createBranch === "function";
+}
+const POSTGRES_CAPABILITIES = {
+  key: "postgres",
+  label: "PostgreSQL",
+  supportsRelations: true,
+  supportsSubcollections: false,
+  supportsRLS: true,
+  supportsReferences: false,
+  supportsColumnTypes: true,
+  supportsRealtime: true,
+  supportsSQLAdmin: true,
+  supportsDocumentAdmin: false,
+  supportsSchemaAdmin: true
+};
+const FIREBASE_CAPABILITIES = {
+  key: "firestore",
+  label: "Firebase / Firestore",
+  supportsRelations: false,
+  supportsSubcollections: true,
+  supportsRLS: false,
+  supportsReferences: true,
+  supportsColumnTypes: false,
+  supportsRealtime: true,
+  supportsSQLAdmin: false,
+  supportsDocumentAdmin: false,
+  supportsSchemaAdmin: false
+};
+const MONGODB_CAPABILITIES = {
+  key: "mongodb",
+  label: "MongoDB",
+  supportsRelations: false,
+  supportsSubcollections: true,
+  supportsRLS: false,
+  supportsReferences: true,
+  supportsColumnTypes: false,
+  supportsRealtime: false,
+  supportsSQLAdmin: false,
+  supportsDocumentAdmin: true,
+  supportsSchemaAdmin: true
+};
+const DEFAULT_CAPABILITIES = {
+  key: "(default)",
+  label: "Default",
+  supportsRelations: true,
+  supportsSubcollections: true,
+  supportsRLS: true,
+  supportsReferences: true,
+  supportsColumnTypes: true,
+  supportsRealtime: true,
+  supportsSQLAdmin: true,
+  supportsDocumentAdmin: true,
+  supportsSchemaAdmin: true
+};
+const CAPABILITIES_REGISTRY = {
+  postgres: POSTGRES_CAPABILITIES,
+  firestore: FIREBASE_CAPABILITIES,
+  mongodb: MONGODB_CAPABILITIES,
+  "(default)": DEFAULT_CAPABILITIES
+};
+function getDataSourceCapabilities(driver) {
+  if (!driver) return POSTGRES_CAPABILITIES;
+  return CAPABILITIES_REGISTRY[driver] ?? DEFAULT_CAPABILITIES;
+}
+function registerDataSourceCapabilities(capabilities) {
+  CAPABILITIES_REGISTRY[capabilities.key] = capabilities;
+}
 export {
+  DEFAULT_CAPABILITIES,
   EntityReference,
   EntityRelation,
+  FIREBASE_CAPABILITIES,
   GeoPoint,
-  Vector
+  MONGODB_CAPABILITIES,
+  POSTGRES_CAPABILITIES,
+  Vector,
+  getDataSourceCapabilities,
+  isBranchAdmin,
+  isDocumentAdmin,
+  isFirebaseCollection,
+  isMongoDBCollection,
+  isPostgresCollection,
+  isSQLAdmin,
+  isSchemaAdmin,
+  registerDataSourceCapabilities
 };
 //# sourceMappingURL=index.es.js.map