@rebasepro/types 0.0.1-canary.eae7889 → 0.1.0

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/cron.ts

@@ -1,3 +1,5 @@
+import type { RebaseClient } from "../controllers/client";
+
 /**
  * Cron Job type definitions for Rebase.
  *
@@ -44,7 +46,6 @@ export interface CronJobDefinition {
     handler: (ctx: CronJobContext) => Promise<unknown> | unknown;
 }
 
-import type { RebaseClient } from "../controllers/client";
 
 /**
  * Context passed to each cron handler invocation.

package/src/types/entity_views.tsx

@@ -1,11 +1,11 @@
 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.
- * This is the base definition — `@rebasepro/admin` re-exports a
- * fully-typed version that narrows the `formex` field.
  * @group Form custom fields
  */
 export interface FormContext<M extends Record<string, unknown> = Record<string, unknown>> {
@@ -50,10 +50,8 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
 
     /**
      * The underlying formex controller that powers the form.
-     * Prefer importing `FormContext` from `@rebasepro/admin` for the
-     * fully-typed `FormexController<M>` version.
      */
-    formex: Record<string, unknown>;
+    formex: FormexController<M>;
 
     disabled: boolean;
 }
@@ -64,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";
 };
 
@@ -73,5 +71,6 @@ export interface EntityCustomViewParams<M extends Record<string, unknown> = Reco
     entity?: Entity<M>;
     modifiedValues?: EntityValues<M>;
     formContext: FormContext<M>;
-    parentCollectionIds?: string[];
+    parentCollectionSlugs?: string[];
+    parentEntityIds?: string[];
 }

package/src/types/formex.ts

@@ -0,0 +1,45 @@
+import React, { FormEvent } from "react";
+
+export type FormexController<T = any> = {
+    values: T;
+    initialValues: T;
+    setValues: (values: T) => void;
+    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
+    touched: Record<string, boolean>;
+    setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
+    setTouched: (touched: Record<string, boolean>) => void;
+    dirty: boolean;
+    setDirty: (dirty: boolean) => void;
+    setSubmitCount: (submitCount: number) => void;
+    errors: Record<string, string>;
+    setFieldError: (key: string, error?: string) => void;
+    handleChange: (event: React.SyntheticEvent) => void,
+    handleBlur: (event: React.FocusEvent) => void,
+    handleSubmit: (event?: FormEvent<HTMLFormElement>) => void;
+    validate: () => void;
+    resetForm: (props?: FormexResetProps<T>) => void;
+    submitCount: number;
+    isSubmitting: boolean;
+    setSubmitting: (isSubmitting: boolean) => void;
+    isValidating: boolean;
+    /**
+     * The version of the form. This is incremented every time the form is reset
+     * or the form is submitted.
+     */
+    version: number;
+
+    debugId?: string;
+
+    undo: () => void;
+    redo: () => void;
+
+    canUndo: boolean;
+    canRedo: boolean;
+}
+
+export type FormexResetProps<T = any> = {
+    values?: T;
+    submitCount?: number;
+    errors?: Record<string, string>;
+    touched?: Record<string, boolean>;
+};

package/src/types/index.ts

@@ -12,6 +12,7 @@ export * from "./entity_callbacks";
 export * from "./entity_overrides";
 export * from "./export_import";
 export * from "./modify_collections";
+export * from "./formex";
 export * from "./websockets";
 export * from "./backend";
 export * from "./translations";
@@ -23,3 +24,5 @@ export * from "./property_config";
 export * from "./entity_views";
 export * from "./data_source";
 export * from "./cron";
+export * from "./backend_hooks";
+export * from "./component_ref";

package/src/types/plugins.tsx

@@ -204,7 +204,8 @@ export interface PluginHooks {
      */
     onColumnsReorder?: (props: {
         fullPath: string;
-        parentCollectionIds: string[];
+        parentCollectionSlugs: string[];
+        parentEntityIds: string[];
         collection: EntityCollection;
         newPropertiesOrder: string[];
     }) => void;
@@ -214,7 +215,8 @@ export interface PluginHooks {
      */
     onKanbanColumnsReorder?: (props: {
         fullPath: string;
-        parentCollectionIds: string[];
+        parentCollectionSlugs: string[];
+        parentEntityIds: string[];
         collection: EntityCollection;
         kanbanColumnProperty: string;
         newColumnsOrder: string[];
@@ -306,7 +308,8 @@ export interface PluginHomePageActionsProps<EP extends object = object, M extend
 export interface PluginFormActionProps<USER extends User = User, EC extends EntityCollection = EntityCollection> {
     entityId?: string | number;
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     status: EntityStatus;
     collection: EC;
     disabled: boolean;

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";
@@ -63,6 +65,16 @@ export type Properties = {
     [key: string]: Property;
 };
 
+export type PostgresProperty = Exclude<Property, ReferenceProperty>;
+export type PostgresProperties = {
+    [key: string]: PostgresProperty;
+};
+
+export type FirebaseProperty = Exclude<Property, RelationProperty>;
+export type FirebaseProperties = {
+    [key: string]: FirebaseProperty;
+};
+
 /**
  * A helper type to infer the underlying data type from a Property definition.
  * This is the core of the type inference system.
@@ -127,7 +139,19 @@ export type InferEntityType<P extends Properties> = {
  * Interface including all common properties of a CMS property.
  * @group Entity properties
  */
+export interface BaseUIConfig<CustomProps = unknown> {
+    columnWidth?: number;
+    hideFromCollection?: boolean;
+    readOnly?: boolean;
+    disabled?: boolean | PropertyDisabledConfig;
+    widthPercentage?: number;
+    customProps?: CustomProps;
+    Field?: ComponentRef<any>;
+    Preview?: ComponentRef<any>;
+}
+
 export interface BaseProperty<CustomProps = unknown> {
+    ui?: BaseUIConfig<CustomProps>;
     /**
      * Property name (e.g. Product)
      */
@@ -147,30 +171,19 @@ export interface BaseProperty<CustomProps = unknown> {
     propertyConfig?: string;
 
     /**
-     * Width in pixels of this column in the collection view. If not set
-     * the width is inferred based on the other configurations
-     */
-    columnWidth?: number;
-
-    /**
-     * Do not show this property in the collection view
+     * 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()`.
      */
-    hideFromCollection?: boolean;
+    columnName?: string;
 
-    /**
-     * Is this a read only property. When set to true, it gets rendered as a
-     * preview.
-     */
-    readOnly?: boolean;
 
-    /**
-     * Is this field disabled.
-     * When set to true, it gets rendered as a
-     * disabled field. You can also specify a configuration for defining the
-     * behaviour of disabled properties (including custom messages, clear value on
-     * disabled or hide the field completely)
-     */
-    disabled?: boolean | PropertyDisabledConfig;
 
     /**
      * Rules for validating this property
@@ -182,17 +195,7 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     defaultValue?: unknown;
 
-    /**
-     * A number between 0 and 100 that indicates the width of the field in the form view.
-     * It defaults to 100, but you can set it to 50 to have two fields in the same row.
-     */
-    widthPercentage?: number;
 
-    /**
-     * Additional props that are passed to the components defined in `field`
-     * or in `preview`.
-     */
-    customProps?: CustomProps;
 
 
     /**
@@ -221,23 +224,22 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     callbacks?: PropertyCallbacks;
 
-    /**
-     * Custom field component to render this property in forms.
-     * Used by the CMS layer.
-     */
-    Field?: React.ComponentType<any>;
 
-    /**
-     * Custom preview component to render this property in previews/tables.
-     * Used by the CMS layer.
-     */
-    Preview?: React.ComponentType<any>;
 }
 
 /**
  * @group Entity properties
  */
+export interface StringUIConfig extends BaseUIConfig {
+    multiline?: boolean;
+    markdown?: boolean;
+    previewAsTag?: boolean;
+    clearable?: boolean;
+    url?: boolean | PreviewType;
+}
+
 export interface StringProperty extends BaseProperty {
+    ui?: StringUIConfig;
     type: "string";
     /**
      * Optional database column type. If not set, it defaults to `varchar` or `uuid` depending on `isId` configuration.
@@ -314,10 +316,7 @@ export interface StringProperty extends BaseProperty {
      * Should this string be rendered as a tag instead of just text.
      */
     previewAsTag?: boolean;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
+
 
     /**
      * You can use this property (a string) to behave as a reference to another
@@ -331,7 +330,12 @@ export interface StringProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface NumberUIConfig extends BaseUIConfig {
+    clearable?: boolean;
+}
+
 export interface NumberProperty extends BaseProperty {
+    ui?: NumberUIConfig;
     type: "number";
     /**
      * Optional database column type. Allows specifying exact database numeric types.
@@ -359,16 +363,14 @@ export interface NumberProperty extends BaseProperty {
      * displayed in the dropdown.
      */
     enum?: EnumValues;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
+
 }
 
 /**
  * @group Entity properties
  */
 export interface BooleanProperty extends BaseProperty {
+    ui?: BaseUIConfig;
     type: "boolean";
     /**
      * Rules for validating this property
@@ -379,7 +381,12 @@ export interface BooleanProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface DateUIConfig extends BaseUIConfig {
+    clearable?: boolean;
+}
+
 export interface DateProperty extends BaseProperty {
+    ui?: DateUIConfig;
     type: "date";
     /**
      * Optional database column type. If not set, defaults to `timestamp` with timezone.
@@ -416,6 +423,7 @@ export interface DateProperty extends BaseProperty {
  * @group Entity properties
  */
 export interface GeopointProperty extends BaseProperty {
+    ui?: BaseUIConfig;
     type: "geopoint";
     /**
      * Rules for validating this property
@@ -426,7 +434,12 @@ export interface GeopointProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface ReferenceUIConfig extends BaseUIConfig {
+    previewProperties?: string[];
+}
+
 export interface ReferenceProperty extends BaseProperty {
+    ui?: ReferenceUIConfig;
     type: "reference";
     /**
      * Marks this field as a Primary Key / Unique Identifier.
@@ -447,15 +460,10 @@ export interface ReferenceProperty extends BaseProperty {
     path?: string;
     /**
      * Allow selection of entities that pass the given filter only.
-     * e.g. `forceFilter: { age: [">=", 18] }`
+     * e.g. `fixedFilter: { age: [">=", 18] }`
      */
-    forceFilter?: FilterValues<string>;
-    /**
-     * Properties that need to be rendered when displaying a preview of this
-     * reference. If not specified the first 3 are used. Only the first 3
-     * specified values are considered.
-     */
-    previewProperties?: string[];
+    fixedFilter?: FilterValues<string>;
+
     /**
      * Should the reference include the ID of the entity. Defaults to `true`
      */
@@ -469,7 +477,13 @@ export interface ReferenceProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface RelationUIConfig extends BaseUIConfig {
+    previewProperties?: string[];
+    widget?: "select" | "dialog";
+}
+
 export interface RelationProperty extends BaseProperty {
+    ui?: RelationUIConfig;
     type: "relation";
     /**
      * Marks this field as a Primary Key / Unique Identifier.
@@ -579,15 +593,10 @@ export interface RelationProperty extends BaseProperty {
 
     /**
      * Allow selection of entities that pass the given filter only.
-     * e.g. `forceFilter: { age: [">=", 18] }`
-     */
-    forceFilter?: FilterValues<string>;
-    /**
-     * Properties that need to be rendered when displaying a preview of this
-     * reference. If not specified the first 3 are used. Only the first 3
-     * specified values are considered.
+     * e.g. `fixedFilter: { age: [">=", 18] }`
      */
-    previewProperties?: string[];
+    fixedFilter?: FilterValues<string>;
+
     /**
      * Should the reference include the ID of the entity. Defaults to `true`
      */
@@ -607,7 +616,13 @@ export interface RelationProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface ArrayUIConfig extends BaseUIConfig {
+    expanded?: boolean;
+    minimalistView?: boolean;
+}
+
 export interface ArrayProperty extends BaseProperty {
+    ui?: ArrayUIConfig;
     type: "array";
     /**
      * Optional database column type. Defaults to `jsonb`.
@@ -662,15 +677,7 @@ export interface ArrayProperty extends BaseProperty {
      * Rules for validating this property
      */
     validation?: ArrayPropertyValidationSchema;
-    /**
-     * Should the field be initially expanded. Defaults to `true`
-     */
-    expanded?: boolean;
-    /**
-     * Display the child properties directly, without being wrapped in an
-     * extendable panel.
-     */
-    minimalistView?: boolean;
+
     /**
      * Can the elements in this array be reordered. Defaults to `true`.
      * This prop has no effect if `disabled` is set to true.
@@ -686,7 +693,14 @@ export interface ArrayProperty extends BaseProperty {
 /**
  * @group Entity properties
  */
+export interface MapUIConfig extends BaseUIConfig {
+    expanded?: boolean;
+    minimalistView?: boolean;
+    spreadChildren?: boolean;
+}
+
 export interface MapProperty extends BaseProperty {
+    ui?: MapUIConfig;
     type: "map";
     /**
      * Optional database column type. Defaults to `jsonb`.
@@ -720,20 +734,7 @@ export interface MapProperty extends BaseProperty {
      * needed
      */
     pickOnlySomeKeys?: boolean;
-    /**
-     * Display the child properties as independent columns in the collection
-     * view
-     */
-    spreadChildren?: boolean;
-    /**
-     * Display the child properties directly, without being wrapped in an
-     * extendable panel. Note that this will also hide the title of this property.
-     */
-    minimalistView?: boolean;
-    /**
-     * Should the field be initially expanded. Defaults to `true`
-     */
-    expanded?: 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/slots.tsx

@@ -129,7 +129,8 @@ export interface NavigationSlotProps {
 export interface CollectionToolbarProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     tableController: EntityTableController;
     selectionController: SelectionController;
 }
@@ -141,7 +142,8 @@ export interface CollectionToolbarProps {
 export interface CollectionEmptyStateProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     canCreate: boolean;
     onNewClick?: () => void;
 }
@@ -154,7 +156,8 @@ export interface CollectionHeaderActionProps {
     property: Property;
     propertyKey: string;
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     onHover: boolean;
     collection: EntityCollection;
     tableController: EntityTableController;
@@ -166,7 +169,8 @@ export interface CollectionHeaderActionProps {
  */
 export interface CollectionAddColumnProps {
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     collection: EntityCollection;
     tableController: EntityTableController;
 }
@@ -178,7 +182,8 @@ export interface CollectionAddColumnProps {
 export interface CollectionErrorProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds?: string[];
+    parentCollectionSlugs?: string[];
+    parentEntityIds?: string[];
     error: Error;
 }
 
@@ -189,7 +194,8 @@ export interface CollectionErrorProps {
 export interface KanbanSetupProps {
     collection: EntityCollection;
     fullPath: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
 }
 
 /**
@@ -199,7 +205,8 @@ export interface KanbanSetupProps {
 export interface KanbanAddColumnProps {
     collection: EntityCollection;
     fullPath: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     columnProperty: string;
 }
 
@@ -215,7 +222,8 @@ export interface EntityRowActionsProps {
     entityId: string;
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     selectionController: SelectionController;
     context: RebaseContext;
 }
@@ -242,7 +250,8 @@ export interface EntityFieldSlotProps {
 export interface CollectionFilterPanelProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     tableController: EntityTableController;
     context: RebaseContext;
 }
@@ -282,7 +291,8 @@ export interface ShellToolbarProps {
 export interface CollectionInsightsSlotProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: 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;
@@ -522,6 +524,11 @@ export interface RebaseTranslations {
     reset_password_confirmation?: string;
     error_resetting_password?: string;
 
+    /** Permission-denied empty states */
+    no_permission_to_view_users?: string;
+    no_permission_to_view_roles?: string;
+    no_permission_description?: string;
+
     /** Editor table-bubble */
     add_row_before: string;
     add_row_after: string;