@rebasepro/server-postgresql 0.5.0 → 0.6.0

package/dist/types/src/types/entity_callbacks.d.ts

@@ -1,173 +0,0 @@
-import type { EntityCollection } from "./collections";
-import type { Entity, EntityStatus, EntityValues } from "./entities";
-import type { User } from "../users";
-import type { RebaseCallContext } from "../rebase_context";
-/**
- * This interface defines all the callbacks that can be used when an entity
- * is being created, updated or deleted.
- * Useful for adding your own logic or blocking the execution of the operation.
- * @group Models
- */
-export type EntityCallbacks<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> = {
-    /**
-     * Callback used after fetching data
-     * @param props
-     */
-    afterRead?(props: EntityAfterReadProps<M, USER>): Promise<Entity<M>> | Entity<M>;
-    /**
-     * Callback used before saving, you need to return the values that will get
-     * saved. If you throw an error in this method the process stops, and an
-     * error snackbar gets displayed.
-     * This runs after schema validation.
-     * @param props
-     */
-    beforeSave?(props: EntityBeforeSaveProps<M, USER>): Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
-    /**
-     * Callback used when save is successful
-     * @param props
-     */
-    afterSave?(props: EntityAfterSaveProps<M, USER>): Promise<void> | void;
-    /**
-     * Callback used when saving fails
-     * @param props
-     */
-    afterSaveError?(props: EntityAfterSaveErrorProps<M, USER>): Promise<void> | void;
-    /**
-     * Callback used before the entity is deleted.
-     * If you throw an error in this method the process stops, and an
-     * error snackbar gets displayed.
-     *
-     * @param props
-     */
-    beforeDelete?(props: EntityBeforeDeleteProps<M, USER>): Promise<boolean | void> | boolean | void;
-    /**
-     * Callback used after the entity is deleted.
-     *
-     * @param props
-     */
-    afterDelete?(props: EntityAfterDeleteProps<M, USER>): void;
-};
-/**
- * Parameters passed to hooks when an entity is fetched
- * @group Models
- */
-export interface EntityAfterReadProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
-    /**
-     * Collection of the entity
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Full path of the CMS where this collection is being fetched.
-     * Might contain unresolved aliases.
-     */
-    path: string;
-    /**
-     * Fetched entity
-     */
-    entity: Entity<M>;
-    /**
-     * Context of the app status
-     */
-    context: RebaseCallContext<USER>;
-}
-/**
- * Parameters passed to hooks before an entity is saved
- * @group Models
- */
-export type EntityBeforeSaveProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> = Omit<EntityAfterSaveProps<M, USER>, "entityId"> & {
-    entityId?: string | number;
-};
-/**
- * Parameters passed to hooks before an entity is saved
- * @group Models
- */
-export type EntityAfterSaveErrorProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> = Omit<EntityAfterSaveProps<M, USER>, "entityId"> & {
-    entityId?: string | number;
-};
-/**
- * Parameters passed to hooks when an entity is saved
- * @group Models
- */
-export interface EntityAfterSaveProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
-    /**
-     * Resolved collection of the entity
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Full path of the CMS where this entity is being saved.
-     * Might contain unresolved aliases.
-     */
-    path: string;
-    /**
-     * ID of the entity
-     */
-    entityId: string | number;
-    /**
-     * Values being saved
-     */
-    values: Partial<EntityValues<M>>;
-    /**
-     * Previous values
-     */
-    previousValues?: Partial<EntityValues<M>>;
-    /**
-     * New or existing entity
-     */
-    status: EntityStatus;
-    /**
-     * Context of the app status
-     */
-    context: RebaseCallContext<USER>;
-}
-/**
- * Parameters passed to hooks when an entity is deleted
- * @group Models
- */
-export interface EntityBeforeDeleteProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
-    /**
-     * collection of the entity being deleted
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Path of the parent collection
-     */
-    path: string;
-    /**
-     * Deleted entity id
-     */
-    entityId: string | number;
-    /**
-     * Deleted entity
-     */
-    entity: Entity<M>;
-    /**
-     * Context of the app status
-     */
-    context: RebaseCallContext<USER>;
-}
-/**
- * Parameters passed to hooks after an entity is deleted
- * @group Models
- */
-export interface EntityAfterDeleteProps<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
-    /**
-     * collection of the entity being deleted
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Path of the parent collection
-     */
-    path: string;
-    /**
-     * Deleted entity id
-     */
-    entityId: string | number;
-    /**
-     * Deleted entity
-     */
-    entity: Entity<M>;
-    /**
-     * Context of the app status
-     */
-    context: RebaseCallContext<USER>;
-}

package/dist/types/src/types/entity_link_builder.d.ts

@@ -1,7 +0,0 @@
-import { Entity } from "./entities";
-/**
- * @group Models
- */
-export type EntityLinkBuilder<M extends Record<string, unknown> = Record<string, unknown>> = ({ entity }: {
-    entity: Entity<M>;
-}) => string;

package/dist/types/src/types/entity_overrides.d.ts

@@ -1,10 +0,0 @@
-import type { DataDriver } from "../controllers/data_driver";
-import type { StorageSource } from "../controllers/storage";
-export type EntityOverrides = {
-    /**
-     * Internal driver override for this collection.
-     * Used by the CMS engine to route data operations.
-     */
-    driver?: DataDriver;
-    storageSource?: StorageSource;
-};

package/dist/types/src/types/entity_views.d.ts

@@ -1,87 +0,0 @@
-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.
- * @group Form custom fields
- */
-export interface FormContext<M extends Record<string, unknown> = Record<string, unknown>> {
-    /**
-     * Current values of the entity
-     */
-    values: M;
-    /**
-     * Update the value of a field
-     */
-    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
-    /**
-     * Save the entity.
-     */
-    save: (values: M) => void;
-    /**
-     * Collection of the entity being modified
-     */
-    collection?: EntityCollection<M>;
-    /**
-     * Entity id, it can be undefined if it's a new entity
-     */
-    entityId?: string | number;
-    /**
-     * Path this entity is located at
-     */
-    path?: string;
-    status: "new" | "existing" | "copy";
-    entity?: Entity<M>;
-    savingError?: Error;
-    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
-    /**
-     * The underlying formex controller that powers the form.
-     */
-    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;
-}
-export type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
-    key: string;
-    name: string;
-    icon?: string | React.ReactNode;
-    tabComponent?: React.ReactNode;
-    includeActions?: boolean | "bottom";
-    Builder?: ComponentRef<EntityCustomViewParams<M>>;
-    position?: "start" | "end";
-};
-/**
- * Configuration to replace the default entity form with a custom component.
- * The Builder receives the same props as entity view tabs (entity, formContext, etc.)
- * and has full control over the UI.
- *
- * The form tab still appears in the tab bar but renders your Builder
- * instead of the auto-generated field form.
- *
- * @group Models
- */
-export type FormViewConfig<M extends Record<string, unknown> = Record<string, unknown>> = {
-    /**
-     * Custom component that replaces the default form.
-     */
-    Builder: ComponentRef<EntityCustomViewParams<M>>;
-    /**
-     * If true, the save/delete action bar is rendered alongside the custom view.
-     * Defaults to true.
-     */
-    includeActions?: boolean;
-};
-export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
-    collection: EntityCollection<M>;
-    entity?: Entity<M>;
-    modifiedValues?: EntityValues<M>;
-    formContext: FormContext<M>;
-    parentCollectionSlugs?: string[];
-    parentEntityIds?: string[];
-}

package/dist/types/src/types/export_import.d.ts

@@ -1,21 +0,0 @@
-import type { Entity } from "./entities";
-import type { User } from "../users";
-import type { RebaseContext } from "../rebase_context";
-/**
- * You can use this configuration to add additional fields to the data
- * exports
- * @group Models
- */
-export interface ExportConfig<USER extends User = User> {
-    additionalFields: ExportMappingFunction<USER>[];
-}
-/**
- * @group Models
- */
-export interface ExportMappingFunction<USER extends User = User> {
-    key: string;
-    builder: ({ entity, context }: {
-        entity: Entity;
-        context: RebaseContext<USER>;
-    }) => Promise<string> | string;
-}

package/dist/types/src/types/formex.d.ts

@@ -1,40 +0,0 @@
-import React, { FormEvent } from "react";
-export type FormexController<T = unknown> = {
-    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 = unknown> = {
-    values?: T;
-    submitCount?: number;
-    errors?: Record<string, string>;
-    touched?: Record<string, boolean>;
-};

package/dist/types/src/types/index.d.ts

@@ -1,28 +0,0 @@
-export * from "./entities";
-export * from "./chips";
-export * from "./properties";
-export * from "./collections";
-export * from "./relations";
-export * from "./locales";
-export * from "./entity_link_builder";
-export * from "./user_management_delegate";
-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";
-export * from "./plugins";
-export * from "./builders";
-export * from "./slots";
-export * from "./entity_actions";
-export * from "./property_config";
-export * from "./entity_views";
-export * from "./data_source";
-export * from "./cron";
-export * from "./backend_hooks";
-export * from "./component_ref";
-export * from "./auth_adapter";
-export * from "./database_adapter";

package/dist/types/src/types/locales.d.ts

@@ -1,4 +0,0 @@
-/**
- * @group Models
- */
-export type Locale = "af" | "ar" | "arDZ" | "arMA" | "arSA" | "az" | "be" | "bg" | "bn" | "ca" | "cs" | "cy" | "da" | "de" | "el" | "enAU" | "enCA" | "enGB" | "enIN" | "enNZ" | "enUS" | "eo" | "es" | "et" | "eu" | "faIR" | "fi" | "fil" | "fr" | "frCA" | "frCH" | "gd" | "gl" | "gu" | "he" | "hi" | "hr" | "hu" | "hy" | "id" | "is" | "it" | "ja" | "ka" | "kk" | "kn" | "ko" | "lb" | "lt" | "lv" | "mk" | "ms" | "mt" | "nb" | "nl" | "nlBE" | "nn" | "pl" | "pt" | "ptBR" | "ro" | "ru" | "sk" | "sl" | "sr" | "srLatn" | "sv" | "ta" | "te" | "th" | "tr" | "ug" | "uk" | "uz" | "vi" | "zhCN" | "zhTW";

package/dist/types/src/types/modify_collections.d.ts

@@ -1,5 +0,0 @@
-import { EntityCollection } from "./collections";
-export type ModifyCollectionProps = {
-    collection: EntityCollection;
-    parentPaths: string[];
-};

package/dist/types/src/types/plugins.d.ts

@@ -1,282 +0,0 @@
-import React, { PropsWithChildren } from "react";
-import type { EntityCollection } from "./collections";
-import type { EntityStatus } from "./entities";
-import type { InferPropertyType, Property } from "./properties";
-import type { FormContext } from "./entity_views";
-import type { RebaseContext } from "../rebase_context";
-import type { NavigationGroupMapping, AppView } from "../controllers/navigation";
-import type { UserManagementDelegate } from "./user_management_delegate";
-import type { User } from "../users";
-import type { SlotContribution } from "./slots";
-/**
- * Props interface for custom field components.
- *
- * The `@rebasepro/admin` package re-exports a narrower version of this
- * interface that adds `formex` and layout-specific fields. This base
- * definition captures the core contract that every field renderer must
- * satisfy, regardless of where it is rendered.
- *
- * @typeParam P - The property type this field is bound to
- * @typeParam CustomProps - Extra props injected via the property's `customProps`
- * @typeParam M - The entity model type
- * @group Form custom fields
- */
-export interface FieldProps<P extends Property = Property, CustomProps = unknown, M extends Record<string, unknown> = Record<string, unknown>> {
-    /** Key of the property (e.g. "user.name" for a nested path) */
-    propertyKey: string;
-    /** Current value of this field */
-    value: InferPropertyType<P> | null;
-    /** Set value of field directly */
-    setValue: (value: InferPropertyType<P> | null, shouldValidate?: boolean) => void;
-    /** Set value of a different field directly */
-    setFieldValue: (propertyKey: string, value: unknown, shouldValidate?: boolean) => void;
-    /** Is the form currently submitting */
-    isSubmitting?: boolean;
-    /** Should this field show the error indicator */
-    showError?: boolean;
-    /** Error message for this field, or undefined if valid */
-    error?: string;
-    /** Has this field been touched */
-    touched?: boolean;
-    /** Property related to this field */
-    property: P;
-    /** Should this field include a description */
-    includeDescription?: boolean;
-    /** Flag to indicate that the underlying value has been updated in the driver */
-    underlyingValueHasChanged?: boolean;
-    /** Is this field part of an array */
-    partOfArray?: boolean;
-    /** Is this field part of a block */
-    partOfBlock?: boolean;
-    /** Display the child properties directly, without being wrapped in an extendable panel */
-    minimalistView?: boolean;
-    /** Should this field autofocus on mount */
-    autoFocus?: boolean;
-    /** Additional properties set by the developer */
-    customProps?: CustomProps;
-    /** Additional values related to the state of the form or the entity */
-    context: FormContext<M>;
-    /** Flag to indicate if this field should be disabled */
-    disabled?: boolean;
-    /** Size of the field */
-    size?: "small" | "medium" | "large";
-    /** Callback when internal property state changes (e.g. panel expansion) */
-    onPropertyChange?: (property: Partial<Property>) => void;
-}
-/**
- * Interface used to define plugins for Rebase.
- * Plugins contribute UI via **slots**, wrap subtrees with **providers**,
- * and inject behavioral logic via **hooks**.
- * @group Core
- */
-export interface RebasePlugin {
-    /**
-     * Unique key identifying this plugin.
-     */
-    key: string;
-    /**
-     * If true, no CMS content is shown until this plugin finishes loading.
-     */
-    loading?: boolean;
-    /**
-     * UI slot contributions rendered at the matching extension points.
-     */
-    slots?: SlotContribution[];
-    /**
-     * HOC providers wrapping root or form content.
-     * Providers with `scope: "root"` wrap the entire CMS below RebaseContext.
-     * Providers with `scope: "form"` wrap each entity form/edit view.
-     */
-    providers?: PluginProvider[];
-    /**
-     * Behavioral hooks (non-UI) — collection modification, search blocking,
-     * column reordering, navigation entries, etc.
-     */
-    hooks?: PluginHooks;
-    /**
-     * Field wrapping for custom field rendering (e.g. data enhancement).
-     */
-    fieldBuilder?: FieldBuilderConfig;
-    /**
-     * Views to be automatically added to the navigation.
-     */
-    views?: AppView[];
-    /**
-     * User management delegate from this plugin.
-     */
-    userManagement?: UserManagementDelegate;
-    /**
-     * Optional lifecycle hooks. Called by the Rebase runtime
-     * at appropriate points in the app lifecycle.
-     */
-    lifecycle?: PluginLifecycle;
-}
-/**
- * A HOC provider that wraps a subtree of the CMS.
- * @group Plugins
- */
-export interface PluginProvider {
-    /**
-     * `"root"` — wraps the entire CMS below RebaseContext.
-     * `"form"` — wraps each entity form / edit view.
-     */
-    scope: "root" | "form";
-    /**
-     * The provider component. Must accept `children`.
-     * Typed loosely because extra props are passed via the `props` field;
-     * strict signatures cause contravariance issues.
-     */
-    Component: React.ComponentType<PropsWithChildren<Record<string, unknown>>>;
-    /**
-     * Additional props passed to the Component.
-     */
-    props?: Record<string, unknown>;
-}
-/**
- * Behavioral hooks that a plugin can provide.
- * These are non-UI extension points for modifying CMS behavior.
- * @group Plugins
- */
-export interface PluginHooks {
-    /**
-     * Modify a single collection before it is rendered (synchronous).
-     */
-    modifyCollection?: (collection: EntityCollection) => EntityCollection;
-    /**
-     * Async version of modifyCollection — supports fetching remote config.
-     * Runs during navigation resolution. If provided alongside `modifyCollection`,
-     * the sync version runs first, then the async version.
-     */
-    modifyCollectionAsync?: (collection: EntityCollection) => Promise<EntityCollection>;
-    /**
-     * Modify, add or remove collections.
-     */
-    injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
-    /**
-     * Callback called when columns are reordered via drag and drop.
-     */
-    onColumnsReorder?: (props: {
-        fullPath: string;
-        parentCollectionSlugs: string[];
-        parentEntityIds: string[];
-        collection: EntityCollection;
-        newPropertiesOrder: string[];
-    }) => void;
-    /**
-     * Callback called when Kanban board columns are reordered.
-     */
-    onKanbanColumnsReorder?: (props: {
-        fullPath: string;
-        parentCollectionSlugs: string[];
-        parentEntityIds: string[];
-        collection: EntityCollection;
-        kanbanColumnProperty: string;
-        newColumnsOrder: string[];
-    }) => void;
-    /**
-     * Navigation entries contributed by this plugin.
-     */
-    navigationEntries?: NavigationGroupMapping[];
-    /**
-     * Callback when navigation entry order changes (e.g. drag-and-drop).
-     */
-    onNavigationEntriesUpdate?: (entries: NavigationGroupMapping[]) => void;
-    /**
-     * Allow reordering collections in the home page via drag and drop.
-     */
-    allowDragAndDrop?: boolean;
-}
-/**
- * Lifecycle hooks for plugins. Called by the Rebase runtime
- * at appropriate points in the app lifecycle.
- * @group Plugins
- */
-export interface PluginLifecycle {
-    /**
-     * Called once when the plugin is mounted in the Rebase tree.
-     * Can return a Promise for async initialization.
-     */
-    onMount?: (context: RebaseContext) => void | Promise<void>;
-    /**
-     * Called when the plugin is unmounted from the Rebase tree.
-     * Use this for cleanup (subscriptions, timers, etc.).
-     */
-    onUnmount?: () => void;
-    /**
-     * Called whenever the authentication state changes.
-     * Receives the new user (or null on sign-out).
-     */
-    onAuthStateChange?: (user: User | null) => void;
-    /**
-     * Called when a collection's visible entities change.
-     * Useful for analytics, caching, or cross-plugin coordination.
-     */
-    onCollectionChange?: (slug: string, entities: unknown[]) => void;
-}
-/**
- * Configuration for wrapping form field components.
- * @group Plugins
- */
-export interface FieldBuilderConfig {
-    /**
-     * Returns a wrapped field component, or null to skip wrapping.
-     */
-    wrap: <T>(params: PluginFieldBuilderParams) => React.ComponentType<FieldProps<Property>> | null;
-    /**
-     * Optional guard — return false to skip wrapping for this field.
-     */
-    enabled?: (params: PluginFieldBuilderParams) => boolean;
-}
-/**
- * Props passed to home page collection card action components.
- * @group Models
- */
-export interface PluginHomePageActionsProps<EP extends object = object, M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User, EC extends EntityCollection<M> = EntityCollection<M>> {
-    slug: string;
-    collection: EC;
-    context: RebaseContext<USER>;
-}
-/**
- * Props passed to form action components in entity edit/form views.
- * @group Models
- */
-export interface PluginFormActionProps<USER extends User = User, EC extends EntityCollection = EntityCollection> {
-    entityId?: string | number;
-    path: string;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    status: EntityStatus;
-    collection: EC;
-    disabled: boolean;
-    formContext?: FormContext;
-    context: RebaseContext<USER>;
-    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
-}
-/**
- * Parameters passed to the field builder wrap function.
- * @group Models
- */
-export type PluginFieldBuilderParams<M extends Record<string, unknown> = Record<string, unknown>, EC extends EntityCollection<M> = EntityCollection<M>> = {
-    fieldConfigId: string;
-    propertyKey: string;
-    property: Property;
-    Field: React.ComponentType<FieldProps<Property, unknown, M>>;
-    plugin: RebasePlugin;
-    path?: string;
-    collection?: EC;
-};
-/**
- * Generic props passed to plugin components that just need CMS context.
- * @group Models
- */
-export interface PluginGenericProps<USER extends User = User> {
-    context: RebaseContext<USER>;
-}
-/**
- * Props for additional card components in the home page.
- * @group Models
- */
-export interface PluginHomePageAdditionalCardsProps<USER extends User = User> {
-    group?: string;
-    context: RebaseContext<USER>;
-}