@rebasepro/types 0.0.1-canary.f81da60 → 0.1.2

package/src/controllers/client.ts

@@ -130,4 +130,19 @@ export interface RebaseClient<DB = unknown> {
 
     /** Admin API for user and role management */
     admin?: AdminAPI;
+
+    /**
+     * The base HTTP URL of the backend server.
+     * Exposed by the SDK client (`@rebasepro/client`) and used to auto-derive
+     * the `ApiConfigProvider` URL.
+     */
+    baseUrl?: string;
+
+    /**
+     * WebSocket client for realtime subscriptions and admin capabilities.
+     * Exposed by the SDK client (`@rebasepro/client`). The shape is intentionally
+     * left as `unknown` in the base interface — callers should narrow via feature
+     * detection (e.g. `typeof ws.executeSql === "function"`).
+     */
+    ws?: unknown;
 }

package/src/controllers/navigation.ts

@@ -172,17 +172,18 @@ export interface AppView {
     hideFromNavigation?: boolean;
 
     /**
-     * Component to be rendered. This can be any React component, and can use
-     * any of the provided hooks
+     * Navigation group for this view.
+     * Views sharing the same group name will be visually grouped
+     * together in the drawer and home page. If not set, the view
+     * falls into the default "Views" group.
      */
-    view: React.ReactNode;
+    group?: string;
 
     /**
-     * Optional field used to group top level navigation entries under a
-     * navigation view.
-     * This prop is ignored for admin views.
+     * Component to be rendered. This can be any React component, and can use
+     * any of the provided hooks
      */
-    group?: string;
+    view: React.ReactNode;
 
     /**
      * If true, a wildcard route (slug/*) is automatically registered
@@ -227,6 +228,17 @@ export interface NavigationGroupMapping {
      * List of collection ids or view paths that belong to this group.
      */
     entries: string[];
+    /**
+     * Configure which groups start collapsed.
+     * Set to `true` to collapse in both drawer and home page,
+     * or use an object to control each independently.
+     *
+     * @defaultValue false (expanded)
+     */
+    collapsedByDefault?: boolean | {
+        drawer?: boolean;
+        home?: boolean;
+    };
 }
 
 export interface NavigationEntry {

package/src/controllers/registry.ts

@@ -3,7 +3,7 @@ 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";
+import type { AppView, NavigationGroupMapping } from "./navigation";
 
 /**
  * Options to enable the built-in collection editor.
@@ -28,6 +28,15 @@ export interface RebaseCMSConfig<EC extends EntityCollection = any> {
     entityActions?: EntityAction[];
     plugins?: any[];
 
+    /**
+     * Centralized configuration for how collections and views are grouped
+     * in the navigation sidebar and home page.
+     * Each mapping defines a named group and the collection/view slugs
+     * that belong to it. The array order determines group display order.
+     * Entry order within each group determines card order.
+     */
+    navigationGroupMappings?: NavigationGroupMapping[];
+
     /**
      * Enable the built-in visual collection/schema editor.
      * Pass `true` for zero-config, or an options object for fine-grained control.

package/src/controllers/side_entity_controller.tsx

@@ -73,6 +73,14 @@ export interface EntitySidePanelProps<M extends Record<string, unknown> = Record
      * Allow the user to open the entity fullscreen
      */
     allowFullScreen?: boolean;
+
+    /**
+     * Pre-populate the form with these values when creating a new entity.
+     * Only applied when `entityId` is not set (i.e. the form is in "new" mode).
+     * Useful for actions that fetch data from an external source (e.g. a URL)
+     * and want to pre-fill the document before the user saves.
+     */
+    defaultValues?: Partial<M>;
 }
 
 /**

package/src/rebase_context.tsx

@@ -3,6 +3,7 @@ import type { AuthController } from "./controllers/auth";
 import type { StorageSource } from "./controllers/storage";
 import type { UserConfigurationPersistence } from "./controllers/local_config_persistence";
 import type { DatabaseAdmin } from "./types/backend";
+import type { RebaseClient } from "./controllers/client";
 
 import type { RebaseData } from "./controllers/data";
 import type { User } from "./users";
@@ -16,6 +17,23 @@ import type { UserManagementDelegate } from "./types/user_management_delegate";
  */
 export type RebaseCallContext<USER extends User = User> = {
 
+    /**
+     * The Rebase client instance.
+     * Available in all entity callbacks (beforeSave, afterSave, afterRead,
+     * beforeDelete, afterDelete) and in CollectionActionsProps via context.
+     * Use it to call backend functions, access data, storage, etc.
+     *
+     * @example
+     * // In a beforeSave callback:
+     * const result = await context.client.functions.invoke('my-function', { ... });
+     *
+     * @example
+     * // In a CollectionAction component:
+     * const { client } = props.context;
+     * const result = await client.functions.invoke('extract-job', { url });
+     */
+    client: RebaseClient<any>;
+
     /**
      * Unified data access — `context.data.products.create(...)`.
      * Access any collection as a dynamic property.

package/src/types/collections.ts

@@ -10,6 +10,7 @@ import type { RebaseContext } from "../rebase_context";
 import type { Relation } from "./relations";
 import type { EntityCustomView } from "./entity_views";
 import type { EntityAction } from "./entity_actions";
+import type { ComponentRef } from "./component_ref";
 
 /**
  * Base interface containing all driver-agnostic collection properties.
@@ -99,6 +100,9 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
 
     /**
      * Navigation group for this collection.
+     * Collections sharing the same group name will be visually grouped
+     * together in the drawer and home page. If not set, the collection
+     * falls into the default "Views" group.
      */
     group?: string;
 
@@ -351,7 +355,7 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
     /**
      * Builder for the collection actions rendered in the toolbar
      */
-    Actions?: React.ComponentType<any>[];
+    Actions?: ComponentRef<CollectionActionsProps>[];
 
 
 }
@@ -584,6 +588,22 @@ export interface CollectionActionsProps<M extends Record<string, unknown> = Reco
      */
     collectionEntitiesCount?: number;
 
+    /**
+     * Programmatically open the new-document form for this collection,
+     * optionally pre-populating it with initial field values.
+     * The form opens in the same mode configured for the collection
+     * (side panel, full screen, or split).
+     *
+     * This is the primary hook for workflows that need to create a document
+     * from external data — e.g. fetching content from a URL, importing from
+     * a third-party API, or duplicating from another system.
+     *
+     * @example
+     * // Inside a custom CollectionAction component:
+     * openNewDocument({ title: "Fetched title", body: "..." });
+     */
+    openNewDocument: (defaultValues?: Record<string, unknown>) => void;
+
 }
 
 /**

package/src/types/component_ref.ts

@@ -0,0 +1,57 @@
+import type React from "react";
+
+/**
+ * Internal marker for a lazily-loaded component reference.
+ * Created by the Vite transform plugin when converting string paths
+ * to deferred `import()` calls. Users should NOT create these manually.
+ *
+ * @internal
+ */
+export interface LazyComponentRef<P = unknown> {
+    readonly __rebaseLazy: true;
+    readonly load: () => Promise<{ default: React.ComponentType<P> }>;
+}
+
+/**
+ * A reference to a React component that can be provided in three forms:
+ *
+ * 1. **String path** (recommended for collection configs):
+ *    ```ts
+ *    Field: "../../frontend/src/components/MyField"
+ *    ```
+ *    The Vite plugin transforms this into a `LazyComponentRef` at build time.
+ *    On the backend, the string stays inert and is never evaluated.
+ *
+ * 2. **Lazy import function**:
+ *    ```ts
+ *    Field: () => import("../../frontend/src/components/MyField")
+ *    ```
+ *    Standard ES dynamic import. Backend never calls the function.
+ *
+ * 3. **Direct component reference** (use only in frontend-only code):
+ *    ```ts
+ *    Field: MyFieldComponent
+ *    ```
+ *    Importing a component at the top level will pull React into the
+ *    backend runtime — only safe in code that the backend never imports.
+ *
+ * @group Types
+ */
+export type ComponentRef<P = unknown> =
+    | React.ComponentType<P>
+    | LazyComponentRef<P>
+    | (() => Promise<{ default: React.ComponentType<P> }>)
+    | string;
+
+/**
+ * Type guard: checks if a value is a `LazyComponentRef` produced by the
+ * Vite transform plugin.
+ */
+export function isLazyComponentRef<P = unknown>(ref: unknown): ref is LazyComponentRef<P> {
+    return (
+        typeof ref === "object" &&
+        ref !== null &&
+        "__rebaseLazy" in ref &&
+        (ref as Record<string, unknown>).__rebaseLazy === true
+    );
+}

package/src/types/entity_views.tsx

@@ -2,6 +2,7 @@ import React from "react";
 import type { Entity, EntityValues } from "./entities";
 import type { EntityCollection } from "./collections";
 import type { FormexController } from "./formex";
+import type { ComponentRef } from "./component_ref";
 
 /**
  * Context passed to custom fields and entity views.
@@ -61,7 +62,7 @@ export type EntityCustomView<M extends Record<string, unknown> = Record<string,
     name: string;
     tabComponent?: React.ReactNode;
     includeActions?: boolean | "bottom";
-    Builder?: React.ComponentType<EntityCustomViewParams<M>>;
+    Builder?: ComponentRef<EntityCustomViewParams<M>>;
     position?: "start" | "end";
 };
 

package/src/types/index.ts

@@ -25,3 +25,4 @@ export * from "./entity_views";
 export * from "./data_source";
 export * from "./cron";
 export * from "./backend_hooks";
+export * from "./component_ref";

package/src/types/properties.ts

@@ -1,5 +1,7 @@
 import React from "react";
 
+import type { ComponentRef } from "./component_ref";
+
 import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity } from "./entities";
 import type { Relation, JoinStep, OnAction } from "./relations";
 import type { EntityCollection, FilterValues } from "./collections";
@@ -144,8 +146,8 @@ export interface BaseUIConfig<CustomProps = unknown> {
     disabled?: boolean | PropertyDisabledConfig;
     widthPercentage?: number;
     customProps?: CustomProps;
-    Field?: React.ComponentType<any>;
-    Preview?: React.ComponentType<any>;
+    Field?: ComponentRef<any>;
+    Preview?: ComponentRef<any>;
 }
 
 export interface BaseProperty<CustomProps = unknown> {
@@ -168,6 +170,19 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     propertyConfig?: string;
 
+    /**
+     * Explicit database column name. When set, this value is used as-is
+     * for the SQL column name, bypassing any snake_case conversion of
+     * the property key.
+     *
+     * This is automatically populated by `rebase schema introspect`
+     * to guarantee an exact match with the live database schema.
+     *
+     * For manually-authored collections you can omit this — the framework
+     * will derive the column name from the property key via `toSnakeCase()`.
+     */
+    columnName?: string;
+
 
 
     /**

package/src/types/translations.ts

@@ -61,6 +61,8 @@ export interface RebaseTranslations {
     all_entries_loaded: string;
     create_your_first_entry: string;
     no_results_filter_sort: string;
+    /** Shown when a text search yields no results. Supports `{{search}}` interpolation. */
+    no_results_search?: string;
     add: string;
     remove: string;
     copy_id: string;