@rebasepro/types 0.1.2 → 0.2.3

package/src/types/collections.ts

@@ -8,7 +8,7 @@ import type { EntityOverrides } from "./entity_overrides";
 import type { User } from "../users";
 import type { RebaseContext } from "../rebase_context";
 import type { Relation } from "./relations";
-import type { EntityCustomView } from "./entity_views";
+import type { EntityCustomView, EntityDetailViewConfig } from "./entity_views";
 import type { EntityAction } from "./entity_actions";
 import type { ComponentRef } from "./component_ref";
 
@@ -134,7 +134,26 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      * When editing an entity, you can choose to open the entity in a side dialog
      * or in a full screen dialog. Defaults to `full_screen`.
      */
-    openEntityMode?: "side_panel" | "full_screen" | "split";
+    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
+
+    /**
+     * Controls what happens when a user clicks on an entity in the collection view.
+     * - `"edit"` (default): Opens the entity in the edit form.
+     * - `"view"`: Opens a read-only detail view with an "Edit" button.
+     */
+    defaultEntityAction?: "view" | "edit";
+
+    /**
+     * Customization options for the read-only detail view.
+     * Only used when `defaultEntityAction` is `"view"`.
+     */
+    detailView?: EntityDetailViewConfig;
+
+    /**
+     * Prevent default actions from being displayed or executed on this collection.
+     */
+    disableDefaultActions?: ("edit" | "copy" | "delete")[];
+
 
 
     /**
@@ -200,6 +219,25 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
      */
     readonly defaultFilter?: FilterValues<Extract<keyof M, string> | (string & {})>; // setting FilterValues<M> can break defining collections by code
 
+    /**
+     * Pre-defined filter presets that appear as quick-access options in the
+     * collection toolbar. Each preset applies a set of filters (and
+     * optionally a sort order) with a single click.
+     *
+     * ```ts
+     * filterPresets: [
+     *   {
+     *     label: "Shipped this month",
+     *     filterValues: {
+     *       status: ["==", "shipped"],
+     *       order_date: [">=", new Date(Date.now() - 30 * 86400000)]
+     *     }
+     *   }
+     * ]
+     * ```
+     */
+    readonly filterPresets?: FilterPreset<Extract<keyof M, string> | (string & {})>[];
+
     /**
      * Default sort applied to this collection.
      * When setting this prop, entities will have a default order
@@ -386,6 +424,13 @@ export interface PostgresCollection<M extends Record<string, unknown> = Record<s
      */
     table: string;
 
+    /**
+     * The PostgreSQL schema name for this table.
+     * E.g. "public", "rebase", "auth".
+     * If not specified, "public" is used (or the default search path).
+     */
+    schema?: string;
+
     /**
      * For SQL databases, you can define the relations between collections here.
      * Relations describe JOINs, foreign keys, and junction tables.
@@ -646,6 +691,36 @@ export type WhereFilterOp =
 export type FilterValues<Key extends string> =
     Partial<Record<Key, [WhereFilterOp, unknown]>>;
 
+/**
+ * A pre-defined filter preset for quick access in the collection toolbar.
+ * Users can select a preset to instantly apply a set of filters and
+ * optionally a sort order.
+ *
+ * @group Models
+ */
+export interface FilterPreset<Key extends string = string> {
+    /**
+     * Display label shown in the preset menu.
+     * If omitted, a summary is auto-generated from the filter keys.
+     */
+    label?: string;
+
+    /**
+     * The filter values to apply when this preset is selected.
+     */
+    filterValues: FilterValues<Key>;
+
+    /**
+     * Optional sort override to apply alongside the filter values.
+     */
+    sort?: [Key, "asc" | "desc"];
+}
+
+/**
+ * @deprecated Use {@link FilterPreset} instead.
+ */
+export type QuickFilter<Key extends string = string> = FilterPreset<Key>;
+
 /**
  * Used to indicate valid filter combinations (e.g. created in Firestore)
  * If the user selects a specific filter/sort combination, the CMS checks if it's

package/src/types/database_adapter.ts

@@ -0,0 +1,120 @@
+/**
+ * @module DatabaseAdapter
+ *
+ * Pluggable database abstraction for Rebase.
+ *
+ *
+ * A `DatabaseAdapter` focuses purely on data persistence and related concerns (realtime, history).
+ * It does NOT handle authentication — auth is managed separately by an `AuthAdapter`.
+ *
+ * @example
+ * ```ts
+ * import { createPostgresAdapter } from "@rebasepro/server-postgresql";
+ *
+ * initializeRebaseBackend({
+ *   database: createPostgresAdapter({ connection: db, schema }),
+ *   auth: { jwtSecret: "..." },
+ * });
+ * ```
+ *
+ * @group Backend
+ */
+
+import type { DataDriver } from "../controllers/data_driver";
+import type { EntityCollection } from "./collections";
+import type {
+    CollectionRegistryInterface,
+    DatabaseAdmin,
+    InitializedDriver,
+    RealtimeProvider,
+    BootstrappedAuth,
+} from "./backend";
+
+/**
+ * A `DatabaseAdapter` provides data persistence for Rebase.
+ *
+ * @group Backend
+ */
+export interface DatabaseAdapter {
+    /**
+     * Which database engine this adapter handles.
+     *
+     * @example "postgres", "mysql", "mongodb", "sqlite"
+     */
+    readonly type: string;
+
+    /**
+     * Create the DataDriver for CRUD operations.
+     *
+     * This is the only **required** method.
+     *
+     * @param config - Coordinator-provided config containing registered
+     *                 collections and the collection registry.
+     */
+    initializeDriver(config: DatabaseAdapterInitConfig): Promise<InitializedDriver>;
+
+    /**
+     * Create a realtime provider for this database.
+     *
+     * Return `undefined` if the database does not support realtime
+     * change notifications.
+     */
+    initializeRealtime?(driverResult: InitializedDriver): Promise<RealtimeProvider | undefined>;
+
+    /**
+     * Initialize auth tables / services if this driver supports them.
+     */
+    initializeAuth?(
+        config: unknown,
+        driverResult: InitializedDriver,
+    ): Promise<BootstrappedAuth | undefined>;
+
+    /**
+     * Initialize entity history tracking.
+     *
+     * Return `undefined` if the database does not support history.
+     */
+    initializeHistory?(
+        config: unknown,
+        driverResult: InitializedDriver,
+    ): Promise<{ historyService: unknown } | undefined>;
+
+    /**
+     * Initialize WebSocket server for realtime operations.
+     */
+    initializeWebsockets?(
+        server: unknown,
+        realtimeService: RealtimeProvider,
+        driver: DataDriver,
+        config?: unknown,
+    ): Promise<void> | void;
+
+    /**
+     * Return admin capabilities for this database (SQL editor, schema browser, branching).
+     */
+    getAdmin?(driverResult: InitializedDriver): DatabaseAdmin | undefined;
+
+    /**
+     * Mount any database-specific HTTP routes (e.g., custom admin endpoints).
+     *
+     * Called after all adapters are initialized.
+     */
+    mountRoutes?(app: unknown, basePath: string, driverResult: InitializedDriver): void;
+
+    /**
+     * Graceful shutdown: close connections, release resources.
+     */
+    destroy?(): Promise<void>;
+}
+
+/**
+ * Configuration passed by the coordinator to `DatabaseAdapter.initializeDriver()`.
+ *
+ * @group Backend
+ */
+export interface DatabaseAdapterInitConfig {
+    /** Registered collection definitions. */
+    collections: EntityCollection[];
+    /** The shared collection registry to register into. */
+    collectionRegistry: CollectionRegistryInterface;
+}

package/src/types/entity_actions.tsx

@@ -46,6 +46,13 @@ export interface EntityAction<M extends Record<string, unknown> = Record<string,
      */
     isEnabled?(props: EntityActionClickProps<M, USER>): boolean;
 
+    /**
+     * When true, this action is rendered inline on each row in the list view.
+     * By default, entity actions only appear in the table view and entity form.
+     * Use this for actions that should be easily accessible regardless of view mode.
+     */
+    showActionsInListView?: boolean;
+
     /**
      * Show this action collapsed in the menu of the collection view.
      * Defaults to true
@@ -86,7 +93,7 @@ export type EntityActionClickProps<M extends Record<string, unknown>, USER exten
     /**
      * If the action is rendered in the form, is it open in a side panel or full screen?
      */
-    openEntityMode: "side_panel" | "full_screen" | "split";
+    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
 
     /**
      * Optional selection controller, present if the action is being called from a collection view

package/src/types/entity_callbacks.ts

@@ -50,7 +50,7 @@ export type EntityCallbacks<M extends Record<string, unknown> = Record<string, u
      *
      * @param props
      */
-    beforeDelete?(props: EntityBeforeDeleteProps<M, USER>): void;
+    beforeDelete?(props: EntityBeforeDeleteProps<M, USER>): Promise<boolean | void> | boolean | void;
 
     /**
      * Callback used after the entity is deleted.

package/src/types/entity_views.tsx

@@ -46,7 +46,7 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
 
     savingError?: Error;
 
-    openEntityMode: "side_panel" | "full_screen" | "split";
+    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
 
     /**
      * The underlying formex controller that powers the form.
@@ -54,6 +54,12 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
     formex: FormexController<M>;
 
     disabled: boolean;
+
+    /**
+     * Whether the form context is in read-only detail view mode.
+     * Custom entity views can use this to adjust their rendering.
+     */
+    readOnly?: boolean;
 }
 
 
@@ -74,3 +80,35 @@ export interface EntityCustomViewParams<M extends Record<string, unknown> = Reco
     parentCollectionSlugs?: string[];
     parentEntityIds?: string[];
 }
+
+/**
+ * Configuration for customizing the read-only detail view of an entity.
+ * Only used when `defaultEntityAction` is set to `"view"` on the collection.
+ * @group Models
+ */
+export type EntityDetailViewConfig<M extends Record<string, unknown> = Record<string, unknown>> = {
+    /**
+     * Custom component rendered above the property display in the detail view.
+     */
+    Header?: ComponentRef<EntityDetailViewParams<M>>;
+    /**
+     * Custom component rendered below the property display in the detail view.
+     */
+    Footer?: ComponentRef<EntityDetailViewParams<M>>;
+    /**
+     * Completely replace the default detail view with a custom component.
+     * When set, Header and Footer are ignored.
+     */
+    Builder?: ComponentRef<EntityDetailViewParams<M>>;
+};
+
+/**
+ * Props passed to detail view customization components (Header, Footer, Builder).
+ * @group Models
+ */
+export interface EntityDetailViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
+    collection: EntityCollection<M>;
+    entity: Entity<M>;
+    path: string;
+    onEditClick: () => void;
+}

package/src/types/index.ts

@@ -26,3 +26,5 @@ export * from "./data_source";
 export * from "./cron";
 export * from "./backend_hooks";
 export * from "./component_ref";
+export * from "./auth_adapter";
+export * from "./database_adapter";

package/src/types/plugins.tsx

@@ -315,7 +315,7 @@ export interface PluginFormActionProps<USER extends User = User, EC extends Enti
     disabled: boolean;
     formContext?: FormContext;
     context: RebaseContext<USER>;
-    openEntityMode: "side_panel" | "full_screen" | "split";
+    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
 }
 
 /**

package/src/types/properties.ts

@@ -2,7 +2,7 @@ import React from "react";
 
 import type { ComponentRef } from "./component_ref";
 
-import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity } from "./entities";
+import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity, Vector } from "./entities";
 import type { Relation, JoinStep, OnAction } from "./relations";
 import type { EntityCollection, FilterValues } from "./collections";
 import type { ColorKey, ColorScheme } from "./chips";
@@ -48,7 +48,9 @@ export type DataType =
     | "reference"
     | "relation"
     | "array"
-    | "map";
+    | "map"
+    | "vector"
+    | "binary";
 
 export type Property =
     | StringProperty
@@ -59,7 +61,9 @@ export type Property =
     | ReferenceProperty
     | RelationProperty
     | ArrayProperty
-    | MapProperty;
+    | MapProperty
+    | VectorProperty
+    | BinaryProperty;
 
 export type Properties = {
     [key: string]: Property;
@@ -89,6 +93,8 @@ export type InferPropertyType<P extends Property> =
     P extends RelationProperty ? EntityRelation | EntityRelation[] :
     P extends ArrayProperty ? (P["of"] extends Property ? InferPropertyType<P["of"]>[] : unknown[]) :
     P extends MapProperty ? (P["properties"] extends Properties ? InferEntityType<P["properties"]> : Record<string, unknown>) :
+    P extends VectorProperty ? Vector :
+    P extends BinaryProperty ? string :
     never;
 
 /**
@@ -185,6 +191,8 @@ export interface BaseProperty<CustomProps = unknown> {
 
 
 
+
+
     /**
      * Rules for validating this property
      */
@@ -378,6 +386,28 @@ export interface BooleanProperty extends BaseProperty {
     validation?: PropertyValidationSchema;
 }
 
+/**
+ * @group Entity properties
+ */
+export interface VectorUIConfig extends BaseUIConfig {
+    clearable?: boolean;
+}
+
+export interface VectorProperty extends BaseProperty {
+    ui?: VectorUIConfig;
+    type: "vector";
+    dimensions: number;
+    validation?: PropertyValidationSchema;
+}
+
+/**
+ * @group Entity properties
+ */
+export interface BinaryProperty extends BaseProperty {
+    type: "binary";
+    validation?: PropertyValidationSchema;
+}
+
 /**
  * @group Entity properties
  */
@@ -503,7 +533,7 @@ export interface RelationProperty extends BaseProperty {
      * When set, the framework treats this property as a self-contained relation
      * definition and no separate `relations[]` entry is needed.
      */
-    target?: () => EntityCollection;
+    target?: string | (() => EntityCollection | string);
 
     /**
      * Whether this property references one or many records.

package/src/types/property_config.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import { ArrayProperty, MapProperty, Property, StringProperty, NumberProperty, BooleanProperty, DateProperty, GeopointProperty, ReferenceProperty, RelationProperty } from "./properties";import { BaseProperty } from "./properties";
+import { ArrayProperty, MapProperty, Property, StringProperty, NumberProperty, BooleanProperty, DateProperty, GeopointProperty, ReferenceProperty, RelationProperty, VectorProperty, BinaryProperty } from "./properties";import { BaseProperty } from "./properties";
 
 type CMSBasePropertyNoName = Omit<BaseProperty, "name">;
 
@@ -19,7 +19,9 @@ export type ConfigProperty =
     | (Omit<MapProperty, "name" | "properties"> & {
         name?: string;
         properties?: Record<string, ConfigProperty>
-    } & CMSBasePropertyNoName);
+    } & CMSBasePropertyNoName)
+    | (Omit<VectorProperty, "name"> & { name?: string } & CMSBasePropertyNoName)
+    | (Omit<BinaryProperty, "name"> & { name?: string } & CMSBasePropertyNoName);
 
 /**
  * This is the configuration object for a property.
@@ -90,4 +92,5 @@ export type PropertyConfigId =
     "date_time" |
     "repeat" |
     "custom_array" |
-    "block";
+    "block" |
+    "vector_input";

package/src/types/relations.ts

@@ -20,7 +20,7 @@ export interface Relation {
     /**
      * The final collection you want to retrieve records from.
      */
-    target: () => EntityCollection;
+    target: (() => EntityCollection) | any;
 
     /**
      * The nature of the relationship, determining if one or many records are returned.

package/src/types/translations.ts

@@ -34,6 +34,8 @@ export interface RebaseTranslations {
     copy: string;
     delete: string;
     delete_not_allowed: string;
+    edit_entity?: string;
+    back_to_detail?: string;
 
     // ─── Delete dialog ───────────────────────────────────────────
     delete_confirmation_title: string;
@@ -446,6 +448,15 @@ export interface RebaseTranslations {
 
     no_filterable_properties: string;
     apply_filters: string;
+
+    // ─── Filter Presets ──────────────────────────────────────────
+    /** Label shown on the filter presets dropdown trigger */
+    filter_presets?: string;
+    /** Tooltip shown when hovering over a preset entry */
+    filter_preset_apply?: string;
+    /** Shown when a preset is active, with {{label}} interpolation */
+    filter_preset_active?: string;
+
     list: string;
     table_view_mode: string;
     cards: string;

package/src/users/user.ts

@@ -46,6 +46,12 @@ export type User = {
      */
     createdAt?: Date | string | null;
 
+    /**
+     * Additional metadata/custom claims associated with the user.
+     * Accessible by the frontend, but only writable by the backend.
+     */
+    readonly metadata?: Record<string, any>;
+
     getIdToken?: (forceRefresh?: boolean) => Promise<string>;
 
 };