@rebasepro/types 0.10.0 → 0.10.1-canary.0a881d4

package/dist/types/plugins.d.ts

@@ -1,277 +0,0 @@
-import React, { PropsWithChildren } from "react";
-import type { CollectionConfig } 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 { 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[];
-    /**
-     * 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: CollectionConfig) => CollectionConfig;
-    /**
-     * 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: CollectionConfig) => Promise<CollectionConfig>;
-    /**
-     * Modify, add or remove collections.
-     */
-    injectCollections?: (collections: CollectionConfig[]) => CollectionConfig[];
-    /**
-     * Callback called when columns are reordered via drag and drop.
-     */
-    onColumnsReorder?: (props: {
-        fullPath: string;
-        parentCollectionSlugs: string[];
-        parentEntityIds: string[];
-        collection: CollectionConfig;
-        newPropertiesOrder: string[];
-    }) => void;
-    /**
-     * Callback called when Kanban board columns are reordered.
-     */
-    onKanbanColumnsReorder?: (props: {
-        fullPath: string;
-        parentCollectionSlugs: string[];
-        parentEntityIds: string[];
-        collection: CollectionConfig;
-        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 CollectionConfig<M> = CollectionConfig<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 CollectionConfig = CollectionConfig> {
-    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 CollectionConfig<M> = CollectionConfig<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>;
-}

package/dist/types/property_config.d.ts

@@ -1,74 +0,0 @@
-import React from "react";
-import { ArrayProperty, MapProperty, StringProperty, NumberProperty, BooleanProperty, DateProperty, GeopointProperty, ReferenceProperty, RelationProperty, VectorProperty, BinaryProperty } from "./properties";
-import { BaseProperty } from "./properties";
-type CMSBasePropertyNoName = Omit<BaseProperty, "name">;
-export type ConfigProperty = (Omit<StringProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<NumberProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<BooleanProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<DateProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<GeopointProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<ReferenceProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<RelationProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<ArrayProperty, "name" | "of" | "oneOf"> & {
-    name?: string;
-    of?: ConfigProperty | ConfigProperty[];
-    oneOf?: {
-        properties: Record<string, ConfigProperty>;
-        typeField?: string;
-        valueField?: string;
-        propertiesOrder?: string[];
-    };
-} & CMSBasePropertyNoName) | (Omit<MapProperty, "name" | "properties"> & {
-    name?: string;
-    properties?: Record<string, ConfigProperty>;
-} & CMSBasePropertyNoName) | (Omit<VectorProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName) | (Omit<BinaryProperty, "name"> & {
-    name?: string;
-} & CMSBasePropertyNoName);
-/**
- * This is the configuration object for a property.
- * These configs are generated by default for the properties defined in your
- * collections' configuration, but you can define your own to be used.
- */
-export type PropertyConfig = {
-    /**
-     * Key used to identify this property config.
-     */
-    key: PropertyConfigId | string;
-    /**
-     * Name of this field type.
-     * This is not the name of the property.
-     */
-    name: string;
-    /**
-     * Default config for the property.
-     * This property or builder will be used as the base values for the resulting property.
-     * You can also use a builder function to generate the base property.
-     */
-    property: ConfigProperty;
-    /**
-     * Optional icon to be used in the field selector.
-     * Use a 24x24 component, in order not to break the layout.
-     * Any Rebase icon can be used.
-     */
-    Icon?: React.ComponentType;
-    /**
-     * CSS color, used only in some plugins like the field selector.
-     * e.g. "#2d7ff9"
-     */
-    color?: string;
-    /**
-     * Description of this field type.
-     */
-    description?: string;
-};
-export type PropertyConfigId = "text_field" | "multiline" | "markdown" | "url" | "email" | "user_select" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference" | "multi_references" | "relation" | "switch" | "date_time" | "repeat" | "custom_array" | "block" | "vector_input";
-export {};

package/dist/types/slots.d.ts

@@ -1,262 +0,0 @@
-import React from "react";
-import type { CollectionActionsProps, EntityTableController, SelectionController, CollectionConfig } from "./collections";
-import type { Entity } from "./entities";
-import type { PluginFormActionProps, PluginGenericProps, PluginHomePageActionsProps, PluginHomePageAdditionalCardsProps } from "./plugins";
-import type { Property } from "./properties";
-import type { RebaseContext } from "../rebase_context";
-/**
- * Registry mapping slot names to their component prop types.
- * Each key represents a UI extension point in the CMS.
- * @group Plugins
- */
-export interface SlotRegistry {
-    "home.actions": PluginGenericProps;
-    "home.cards": PluginHomePageAdditionalCardsProps;
-    "home.children.start": PluginGenericProps;
-    "home.children.end": PluginGenericProps;
-    /** Compact insight widget rendered inline in a home page collection card. */
-    "home.card.insight": HomeCardInsightSlotProps;
-    "home.collection.actions": PluginHomePageActionsProps;
-    /** Rendered below the logo in the sidebar drawer. */
-    "navigation.header": NavigationSlotProps;
-    /** Rendered above the collapse toggle at the bottom of the drawer. */
-    "navigation.footer": NavigationSlotProps;
-    "collection.actions": CollectionActionsProps;
-    "collection.actions.start": CollectionActionsProps;
-    "collection.header.action": CollectionHeaderActionProps;
-    "collection.add-column": CollectionAddColumnProps;
-    "collection.error": CollectionErrorProps;
-    /** Extra widgets rendered inside the collection toolbar row. */
-    "collection.toolbar": CollectionToolbarProps;
-    /** Custom empty-state component when a collection has no data. */
-    "collection.empty-state": CollectionEmptyStateProps;
-    /** Insight widgets rendered above the collection table. */
-    "collection.insights": CollectionInsightsSlotProps;
-    "form.actions": PluginFormActionProps;
-    "form.actions.top": PluginFormActionProps;
-    /** Rendered before the form title / field list. */
-    "form.before": PluginFormActionProps;
-    /** Rendered after the form field list. */
-    "form.after": PluginFormActionProps;
-    /** Per-row actions in entity tables (e.g. bulk actions, row context menus). */
-    "entity.row.actions": EntityRowActionsProps;
-    /** Inject UI before an individual form field. */
-    "entity.field.before": EntityFieldSlotProps;
-    /** Inject UI after an individual form field. */
-    "entity.field.after": EntityFieldSlotProps;
-    /** Custom filter sidebar for a collection. */
-    "collection.filter-panel": CollectionFilterPanelProps;
-    /** Widget rendered on the dashboard / home page. */
-    "dashboard.widget": DashboardWidgetProps;
-    /** Cross-collection search bar component. */
-    "global.search": GlobalSearchProps;
-    /** Top-level toolbar actions rendered in the shell toolbar area. */
-    "shell.toolbar": ShellToolbarProps;
-    "kanban.setup": KanbanSetupProps;
-    "kanban.add-column": KanbanAddColumnProps;
-}
-/**
- * Valid slot names for UI extension points.
- * @group Plugins
- */
-export type SlotName = keyof SlotRegistry;
-/**
- * A single UI component contribution to a named slot.
- * @group Plugins
- */
-export interface SlotContribution<K extends SlotName = SlotName> {
-    /**
-     * Which slot to contribute to.
-     */
-    slot: K;
-    /**
-     * The component to render in the slot.
-     * Typed loosely so mixed-slot arrays work.
-     * Type safety is provided at the `useSlot` call site.
-     */
-    Component: React.ComponentType<any>;
-    /**
-     * Additional props to merge into the slot props before rendering.
-     */
-    props?: Record<string, unknown>;
-    /**
-     * Ordering hint. Lower values render first. Defaults to 50.
-     */
-    order?: number;
-}
-/**
- * Props for `navigation.header` and `navigation.footer` slots.
- * @group Plugins
- */
-export interface NavigationSlotProps {
-    drawerOpen: boolean;
-    drawerHovered: boolean;
-    context: RebaseContext;
-}
-/**
- * Props for the `collection.toolbar` slot.
- * @group Plugins
- */
-export interface CollectionToolbarProps {
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    tableController: EntityTableController;
-    selectionController: SelectionController;
-}
-/**
- * Props for the `collection.empty-state` slot.
- * @group Plugins
- */
-export interface CollectionEmptyStateProps {
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    canCreate: boolean;
-    onNewClick?: () => void;
-}
-/**
- * Props for the `collection.header.action` slot.
- * @group Plugins
- */
-export interface CollectionHeaderActionProps {
-    property: Property;
-    propertyKey: string;
-    path: string;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    onHover: boolean;
-    collection: CollectionConfig;
-    tableController: EntityTableController;
-}
-/**
- * Props for the `collection.add-column` slot.
- * @group Plugins
- */
-export interface CollectionAddColumnProps {
-    path: string;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    collection: CollectionConfig;
-    tableController: EntityTableController;
-}
-/**
- * Props for the `collection.error` slot.
- * @group Plugins
- */
-export interface CollectionErrorProps {
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs?: string[];
-    parentEntityIds?: string[];
-    error: Error;
-}
-/**
- * Props for the `kanban.setup` slot.
- * @group Plugins
- */
-export interface KanbanSetupProps {
-    collection: CollectionConfig;
-    fullPath: string;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-}
-/**
- * Props for the `kanban.add-column` slot.
- * @group Plugins
- */
-export interface KanbanAddColumnProps {
-    collection: CollectionConfig;
-    fullPath: string;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    columnProperty: string;
-}
-/**
- * Props for `entity.row.actions` slot.
- * Rendered for each row in a entity collection table.
- * @group Plugins
- */
-export interface EntityRowActionsProps {
-    entity: Entity;
-    entityId: string;
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    selectionController: SelectionController;
-    context: RebaseContext;
-}
-/**
- * Props for `entity.field.before` and `entity.field.after` slots.
- * Rendered around individual form fields in the entity edit view.
- * @group Plugins
- */
-export interface EntityFieldSlotProps {
-    propertyKey: string;
-    property: Property;
-    path: string;
-    entityId?: string | number;
-    collection: CollectionConfig;
-    context: RebaseContext;
-}
-/**
- * Props for `collection.filter-panel` slot.
- * Custom filter sidebar rendered alongside the collection table.
- * @group Plugins
- */
-export interface CollectionFilterPanelProps {
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-    tableController: EntityTableController;
-    context: RebaseContext;
-}
-/**
- * Props for `dashboard.widget` slot.
- * Widgets rendered on the home / dashboard page.
- * @group Plugins
- */
-export interface DashboardWidgetProps {
-    context: RebaseContext;
-}
-/**
- * Props for `global.search` slot.
- * Cross-collection search bar rendered in the app shell.
- * @group Plugins
- */
-export interface GlobalSearchProps {
-    context: RebaseContext;
-}
-/**
- * Props for `shell.toolbar` slot.
- * Actions rendered in the top-level toolbar / app bar area.
- * @group Plugins
- */
-export interface ShellToolbarProps {
-    context: RebaseContext;
-}
-/**
- * Props for `collection.insights` slot.
- * Insight widgets rendered above the collection table.
- * @group Plugins
- */
-export interface CollectionInsightsSlotProps {
-    path: string;
-    collection: CollectionConfig;
-    parentCollectionSlugs: string[];
-    parentEntityIds: string[];
-}
-/**
- * Props for `home.card.insight` slot.
- * Compact insight rendered inline in a home page collection card.
- * @group Plugins
- */
-export interface HomeCardInsightSlotProps {
-    slug: string;
-    collection: CollectionConfig;
-    context: RebaseContext;
-}