@rebasepro/core 0.0.1-canary.0

package/dist/components/common/types.d.ts

@@ -0,0 +1,58 @@
+import { CollectionSize, Property, SelectedCellProps } from "@rebasepro/types";
+export type EntityCollectionTableController<M extends Record<string, any>> = {
+    /**
+     * This cell is displayed as selected
+     */
+    selectedCell?: SelectedCellProps<any>;
+    /**
+     * Select a table cell
+     * @param cell
+     */
+    select: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * The cell that is displayed as a popup view.
+     * @param cell
+     */
+    setPopupCell?: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * Callback used when the value of a cell has changed.
+     * @param params
+     */
+    onValueChange?: (params: OnCellValueChangeParams<any, M>) => void;
+    /**
+     * Size of the elements in the collection
+     */
+    size: CollectionSize;
+};
+/**
+ * Props passed in a callback when the content of a cell in a table has been edited
+ * @group Collection components
+ */
+export interface OnCellValueChangeParams<T = any, D = any> {
+    value: T;
+    propertyKey: string;
+    data?: D;
+    onValueUpdated: () => void;
+    setError: (e: Error | undefined) => void;
+}
+/**
+ * @group Collection components
+ */
+export type UniqueFieldValidator = (props: {
+    name: string;
+    value: any;
+    property: Property;
+    entityId?: string | number;
+}) => Promise<boolean>;
+/**
+ * Callback when a cell has changed in a table
+ * @group Collection components
+ */
+export type OnCellValueChange<T, M extends Record<string, any>> = (params: OnCellValueChangeParams<T, M>) => Promise<void> | void;
+/**
+ * @group Collection components
+ */
+export type OnColumnResizeParams = {
+    width: number;
+    key: string;
+};

package/dist/components/common/useColumnsIds.d.ts

@@ -0,0 +1,6 @@
+import { EntityCollection, Property } from "@rebasepro/types";
+import { PropertyColumnConfig } from "../EntityCollectionTable/EntityCollectionTableProps";
+export declare const COLLECTION_GROUP_PARENT_ID = "collectionGroupParent";
+export declare function useColumnIds<M extends Record<string, any>>(collection: EntityCollection<M>, includeSubcollections: boolean): PropertyColumnConfig[];
+export declare function getColumnKeysForProperty(property: Property, key: string, disabled?: boolean): PropertyColumnConfig[];
+export declare function getFormFieldKeys(collection: EntityCollection): string[];

package/dist/components/common/useDataSourceTableController.d.ts

@@ -0,0 +1,44 @@
+import { Entity, EntityCollection, EntityTableController, FilterValues, User } from "@rebasepro/types";
+import { ScrollRestorationController } from "./useScrollRestoration";
+export declare const DEFAULT_PAGE_SIZE = 50;
+export type DataSourceTableControllerProps<M extends Record<string, any> = any> = {
+    /**
+     * Full path where the data of this table is located
+     */
+    path: string;
+    /**
+     * The collection that is represented by this config.
+     */
+    collection: EntityCollection<M>;
+    /**
+     * List of entities that will be displayed on top, no matter the ordering.
+     * This is used for reference fields selection
+     */
+    entitiesDisplayedFirst?: Entity<M>[];
+    lastDeleteTimestamp?: number;
+    /**
+     * Force filter to be applied to the table.
+     */
+    forceFilter?: FilterValues<string>;
+    scrollRestoration?: ScrollRestorationController;
+    /**
+     * When set to true the filters and sort will be updated in the URL
+     */
+    updateUrl?: boolean;
+};
+/**
+ * Use this hook to build a controller for the {@link EntityCollectionTable}.
+ * This controller is bound to data in a path in your specified datasource.
+ *
+ * Note that you can build your own hook returning a {@link EntityTableController}
+ * if you would like to display different data.
+ *
+ * @param path
+ * @param collection
+ * @param scrollRestoration
+ * @param entitiesDisplayedFirst
+ * @param lastDeleteTimestamp
+ * @param forceFilterFromProps
+ * @param updateUrl
+ */
+export declare function useDataSourceTableController<M extends Record<string, any> = any, USER extends User = User>({ path, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp: _lastDeleteTimestamp, forceFilter: forceFilterFromProps, updateUrl }: DataSourceTableControllerProps<M>): EntityTableController<M>;

package/dist/components/common/useDebouncedCallback.d.ts

@@ -0,0 +1 @@
+export declare function useDebounceCallback<T extends (...args: any[]) => any>(callback?: T, delay?: number): T;

package/dist/components/common/useDebouncedData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hack to prevent data updates for incomplete callbacks from Firestore
+ * triggers.
+ * If any deps change, the update is immediate
+ * @param data
+ * @param deps
+ * @param timeoutMs
+ */
+export declare function useDebouncedData<T>(data: T[], deps: any, timeoutMs?: number): T[];

package/dist/components/common/useScrollRestoration.d.ts

@@ -0,0 +1,14 @@
+import { Entity, FilterValues } from "@rebasepro/types";
+export type ScrollRestorationController = {
+    getCollectionScroll: (path: string, filters?: FilterValues<any>) => {
+        scrollOffset: number;
+        data: Entity<any>[];
+    } | undefined;
+    updateCollectionScroll: (props: {
+        path: string;
+        scrollOffset: number;
+        filters?: FilterValues<any>;
+        data: Entity<any>[];
+    }) => void;
+};
+export declare function useScrollRestoration(): ScrollRestorationController;

package/dist/components/common/useTableSearchHelper.d.ts

@@ -0,0 +1,11 @@
+import { EntityCollection } from "@rebasepro/types";
+export interface UseTableSearchHelperParams<M extends Record<string, any>> {
+    collection: EntityCollection<M>;
+    path: string;
+    parentCollectionIds?: string[];
+}
+export declare function useTableSearchHelper<M extends Record<string, any>>({ collection, path, parentCollectionIds }: UseTableSearchHelperParams<M>): {
+    textSearchLoading: boolean;
+    textSearchInitialised: boolean;
+    onTextSearchClick: (() => void) | undefined;
+};

package/dist/components/index.d.ts

@@ -0,0 +1,35 @@
+export type { ErrorViewProps } from "./ErrorView";
+export { ErrorView } from "./ErrorView";
+export type { EntityViewProps } from "./EntityView";
+export { EntityView } from "./EntityView";
+export type { EntitySelectionProps } from "./ReferenceTable/EntitySelectionTable";
+export { EntitySelectionTable } from "./ReferenceTable/EntitySelectionTable";
+export { CircularProgressCenter } from "./CircularProgressCenter";
+export * from "./common";
+export * from "./HomePage";
+export * from "./SelectableTable/SelectableTable";
+export * from "./SelectableTable/SelectableTableContext";
+export * from "./EntityCollectionView/EntityCollectionView";
+export * from "./EntityCollectionView/EntityCollectionViewActions";
+export * from "./EntityCollectionView/EntityCollectionCardView";
+export * from "./EntityCollectionView/EntityCard";
+export * from "./EntityCollectionView/useSelectionController";
+export * from "./PropertyConfigBadge";
+export * from "./PropertyIdCopyTooltip";
+export * from "./EntityCollectionTable";
+export * from "./NotFoundPage";
+export * from "./VirtualTable";
+export * from "./ErrorBoundary";
+export * from "./ConfirmationDialog";
+export * from "./RebaseLogo";
+export * from "../core/DefaultAppBar";
+export * from "./ArrayContainer";
+export * from "./ReferenceWidget";
+export * from "./SearchIconsView";
+export * from "./FieldCaption";
+export * from "./EntityPreview";
+export * from "./AIIcon";
+export * from "./Debug/UIStyleGuide";
+export * from "./Debug/UIReferenceView";
+export * from "./AdminModeSyncer";
+export * from "./UserSettingsView";

package/dist/contexts/AdminModeController.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { AdminModeController } from "../hooks";
+export declare const AdminModeControllerContext: React.Context<AdminModeController>;
+export declare const AdminModeControllerProvider: React.Provider<AdminModeController>;

package/dist/contexts/AnalyticsContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { AnalyticsController } from "@rebasepro/types";
+export declare const AnalyticsContext: React.Context<AnalyticsController>;

package/dist/contexts/AuthControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { AuthController } from "@rebasepro/types";
+export declare const AuthControllerContext: React.Context<AuthController<any, any>>;

package/dist/contexts/BreacrumbsContext.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { BreadcrumbsController } from "../hooks/useBreadcrumbsController";
+export declare const BreadcrumbContext: React.Context<BreadcrumbsController>;
+interface BreadcrumbsProviderProps {
+    children: React.ReactNode;
+}
+export declare const BreadcrumbsProvider: React.FC<BreadcrumbsProviderProps>;
+export {};

package/dist/contexts/CustomizationControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { CustomizationController } from "@rebasepro/types";
+export declare const CustomizationControllerContext: React.Context<CustomizationController>;

package/dist/contexts/DataSourceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { DataSource } from "@rebasepro/types";
+export declare const DataSourceContext: React.Context<DataSource>;

package/dist/contexts/DialogsProvider.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from "react";
+import { DialogsController } from "@rebasepro/types";
+export declare const DialogsControllerContext: React.Context<DialogsController>;
+export declare const DialogsProvider: React.FC<PropsWithChildren>;

package/dist/contexts/EffectiveRoleController.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { EffectiveRoleController } from "@rebasepro/types";
+export declare const EffectiveRoleControllerContext: React.Context<EffectiveRoleController>;
+export declare const EffectiveRoleControllerProvider: React.Provider<EffectiveRoleController>;

package/dist/contexts/InternalUserManagementContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { UserManagementDelegate } from "@rebasepro/types";
+export declare const InternalUserManagementContext: React.Context<UserManagementDelegate<any> | undefined>;

package/dist/contexts/ModeController.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { ModeController } from "../hooks";
+export declare const ModeControllerContext: React.Context<ModeController>;
+export declare const ModeControllerProvider: React.Provider<ModeController>;

package/dist/contexts/NavigationContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { NavigationController } from "@rebasepro/types";
+export declare const NavigationContext: React.Context<NavigationController>;

package/dist/contexts/SideDialogsControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SideDialogsController } from "@rebasepro/types";
+export declare const SideDialogsControllerContext: React.Context<SideDialogsController>;

package/dist/contexts/SideEntityControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SideEntityController } from "@rebasepro/types";
+export declare const SideEntityControllerContext: React.Context<SideEntityController>;

package/dist/contexts/SnackbarProvider.d.ts

@@ -0,0 +1,2 @@
+import React, { PropsWithChildren } from "react";
+export declare const SnackbarProvider: React.FC<PropsWithChildren<{}>>;

package/dist/contexts/StorageSourceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { StorageSource } from "@rebasepro/types";
+export declare const StorageSourceContext: React.Context<StorageSource>;

package/dist/contexts/UserConfigurationPersistenceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { UserConfigurationPersistence } from "@rebasepro/types";
+export declare const UserConfigurationPersistenceContext: React.Context<UserConfigurationPersistence | undefined>;

package/dist/contexts/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./SnackbarProvider";
+export * from "./ModeController";
+export * from "./AdminModeController";
+export * from "./EffectiveRoleController";
+export * from "./AuthControllerContext";
+export * from "./DataSourceContext";
+export * from "./NavigationContext";
+export * from "./CustomizationControllerContext";
+export * from "./SideEntityControllerContext";
+export * from "./SideDialogsControllerContext";
+export * from "./AnalyticsContext";
+export * from "./StorageSourceContext";
+export * from "./UserConfigurationPersistenceContext";
+export * from "./DialogsProvider";
+export * from "./InternalUserManagementContext";

package/dist/core/DefaultAppBar.d.ts

@@ -0,0 +1,29 @@
+import React from "react";
+import { User } from "@rebasepro/types";
+export type DefaultAppBarProps<ADDITIONAL_PROPS = object> = {
+    /**
+     * The content of the app bar, usually a title or logo. This includes a link to the home page.
+     */
+    title?: React.ReactNode;
+    /**
+     * A component that gets rendered on the upper side to the end of the main toolbar
+     */
+    endAdornment?: React.ReactNode;
+    /**
+     * A component that gets rendered on the upper side to the start of the main toolbar
+     */
+    startAdornment?: React.ReactNode;
+    dropDownActions?: React.ReactNode;
+    includeModeToggle?: boolean;
+    className?: string;
+    style?: React.CSSProperties;
+    logo?: string;
+    user?: User;
+} & ADDITIONAL_PROPS;
+/**
+ * This component renders the main app bar of Rebase.
+ * You will likely not need to use this component directly.
+ *
+
+ */
+export declare const DefaultAppBar: ({ title, endAdornment, startAdornment, dropDownActions, includeModeToggle, className, style, user: userProp, logo: logoProp, }: DefaultAppBarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/core/DefaultDrawer.d.ts

@@ -0,0 +1,29 @@
+import React from "react";
+/**
+ * Default drawer used in the CMS
+ * @group Core
+ */
+export declare function DefaultDrawer({ title, logo, logoDestination, className, style, }: {
+    title?: React.ReactNode;
+    logo?: string;
+    logoDestination?: string;
+    className?: string;
+    style?: React.CSSProperties;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function DrawerLogo({ logo, title, logoDestination, drawerOpen, drawerHovered, }: {
+    logo?: string;
+    title?: React.ReactNode;
+    logoDestination?: string;
+    drawerOpen: boolean;
+    drawerHovered: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Toggle button at the bottom of the drawer.
+ * Uses double-chevron icons to indicate collapse/expand direction.
+ */
+export declare function DrawerToggle({ drawerOpen, drawerHovered, openDrawer, closeDrawer, }: {
+    drawerOpen: boolean;
+    drawerHovered: boolean;
+    openDrawer: () => void;
+    closeDrawer: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/DrawerNavigationGroup.d.ts

@@ -0,0 +1,45 @@
+import React from "react";
+import { NavigationEntry } from "@rebasepro/types";
+export interface DrawerNavigationGroupProps {
+    /**
+     * Group name to display in header
+     */
+    group: string;
+    /**
+     * Navigation entries in this group
+     */
+    entries: NavigationEntry[];
+    /**
+     * Whether the group is collapsed
+     */
+    collapsed: boolean;
+    /**
+     * Callback when collapse state should toggle
+     */
+    onToggleCollapsed: () => void;
+    /**
+     * Whether the drawer is in open (expanded) state
+     */
+    drawerOpen: boolean;
+    /**
+     * Whether tooltips should be shown (drawer closed + hovered)
+     */
+    tooltipsOpen: boolean;
+    /**
+     * Whether admin menu is open (used to control tooltip visibility)
+     */
+    adminMenuOpen?: boolean;
+    /**
+     * Optional actions to render in the group header (e.g., "Add collection" button)
+     */
+    headerActions?: React.ReactNode;
+    /**
+     * Optional callback when a navigation item is clicked
+     */
+    onItemClick?: (entry: NavigationEntry) => void;
+}
+/**
+ * Shared drawer navigation group component used by both DefaultDrawer and RebaseCloudDrawer.
+ * Renders a collapsible group with header and navigation items.
+ */
+export declare function DrawerNavigationGroup({ group, entries, collapsed, onToggleCollapsed, drawerOpen, tooltipsOpen, adminMenuOpen, headerActions, onItemClick }: DrawerNavigationGroupProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/DrawerNavigationItem.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+export declare function DrawerNavigationItem({ name, icon, drawerOpen, adminMenuOpen, tooltipsOpen, url, onClick }: {
+    icon: React.ReactElement;
+    name: string;
+    tooltipsOpen: boolean;
+    drawerOpen: boolean;
+    adminMenuOpen?: boolean;
+    url: string;
+    onClick?: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/EntityEditView.d.ts

@@ -0,0 +1,47 @@
+import { Entity, EntityCollection, EntityStatus, User } from "@rebasepro/types";
+import { EntityFormProps, OnUpdateParams } from "@rebasepro/types";
+export declare const MAIN_TAB_VALUE = "__main_##Q$SC^#S6";
+export declare const JSON_TAB_VALUE = "__json";
+export type BarActionsParams = {
+    values: object;
+    status: EntityStatus;
+    path: string;
+    entityId?: string | number;
+};
+export type OnTabChangeParams<M extends Record<string, any>> = {
+    path: string;
+    entityId?: string | number;
+    selectedTab?: string;
+    collection: EntityCollection<M>;
+};
+export interface EntityEditViewProps<M extends Record<string, any> = any> {
+    /**
+     * The CMS path of the entity, e.g. "users" or "products".
+     */
+    path: string;
+    collection: EntityCollection<M>;
+    entityId?: string | number;
+    databaseId?: string;
+    copy?: boolean;
+    selectedTab?: string;
+    parentCollectionIds: string[];
+    onValuesModified?: (modified: boolean, values: M) => void;
+    onSaved?: (params: OnUpdateParams) => void;
+    onTabChange?: (props: OnTabChangeParams<M>) => void;
+    layout?: "side_panel" | "full_screen";
+    barActions?: (params: BarActionsParams) => any;
+    formProps?: Partial<EntityFormProps<M>>;
+}
+/**
+ * This is the default view that is used as the content of a side panel when
+ * an entity is opened.
+ */
+export declare function EntityEditView<M extends Record<string, any>, USER extends User>({ entityId, ...props }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function EntityEditViewInner<M extends Record<string, any>>({ path, entityId, selectedTab: selectedTabProp, collection, parentCollectionIds, onValuesModified, onSaved, onTabChange, entity, initialDirtyValues, dataLoading, layout, barActions, status, setStatus, formProps, canEdit }: EntityEditViewProps<M> & {
+    entity?: Entity<M>;
+    initialDirtyValues?: Partial<M>;
+    dataLoading: boolean;
+    status: EntityStatus;
+    setStatus: (status: EntityStatus) => void;
+    canEdit?: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/EntityEditViewFormActions.d.ts

@@ -0,0 +1,2 @@
+import { EntityFormActionsProps } from "@rebasepro/types";
+export declare function EntityEditViewFormActions({ collection, path, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode, showDefaultActions, navigateBack, formContext }: EntityFormActionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/EntitySidePanel.d.ts

@@ -0,0 +1,10 @@
+import { EntitySidePanelProps } from "@rebasepro/types";
+/**
+ * This is the component in charge of rendering the side dialog used
+ * for editing entities. Use the {@link useSideEntityController} to open
+ * and control the dialogs.
+ * This component needs a parent {@link Rebase}
+ * {@link useSideEntityController}
+ * @group Components
+ */
+export declare function EntitySidePanel(props: EntitySidePanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/Rebase.d.ts

@@ -0,0 +1,13 @@
+import { RebaseProps, User } from "@rebasepro/types";
+/**
+ * If you are using independent components of the CMS
+ * you need to wrap them with this main component, so the internal hooks work.
+ *
+ * This is the main component of Rebase. It acts as the provider of all the
+ * internal contexts and hooks.
+ *
+ * You only need to use this component if you are building a custom app.
+ *
+ * @group Core
+ */
+export declare function Rebase<USER extends User>(props: RebaseProps<USER>): import("react/jsx-runtime").JSX.Element;

package/dist/core/RebaseRouter.d.ts

@@ -0,0 +1,4 @@
+export declare function RebaseRouter({ children, basePath }: {
+    children: any;
+    basePath?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/RebaseRoutes.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+/**
+ * A drop-in replacement for react-router's `<Routes>` that preserves the
+ * underlying view when a side dialog navigates the URL to a different path.
+ *
+ * When opening a side dialog from e.g. `/posts` to `authors/123#side`,
+ * the `base_location` stored in router state is used so the route tree
+ * keeps rendering the original `/posts` view underneath the dialog overlay.
+ *
+ * Additionally, registered views from `useNavigationStateController()` are
+ * automatically routed — no need to manually map them to `<Route>` elements.
+ * Views with `nestedRoutes: true` get a wildcard route (slug/*) as well.
+ * Explicitly declared `children` routes take priority.
+ */
+export declare function RebaseRoutes({ children }: {
+    children?: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/SideDialogs.d.ts

@@ -0,0 +1,25 @@
+import React from "react";
+export type SideDialogController = {
+    blocked: boolean;
+    setBlocked: (blocked: boolean) => void;
+    setBlockedNavigationMessage: (message?: React.ReactNode) => void;
+    width?: string;
+    close: (force?: boolean) => void;
+    pendingClose: boolean;
+    setPendingClose: (pendingClose: boolean) => void;
+};
+/**
+ * This hook is used to access the properties of a particular side dialog,
+ * in contrast with {@link useSideDialogsController} which handles the
+ * state of all the dialogs.
+ */
+export declare const useSideDialogContext: () => SideDialogController;
+/**
+ * This is the component in charge of rendering the side dialogs used
+ * for editing entities. Use the {@link useSideEntityController} to open
+ * and control the dialogs.
+ * This component needs a parent {@link Rebase}
+ * {@link useSideDialogsController}
+ * @group Components
+ */
+export declare function SideDialogs(): import("react/jsx-runtime").JSX.Element;

package/dist/core/field_configs.d.ts

@@ -0,0 +1,6 @@
+import { DefaultFieldConfig, Property, PropertyConfig } from "@rebasepro/types";
+export declare const DEFAULT_FIELD_CONFIGS: Record<DefaultFieldConfig, PropertyConfig>;
+export declare function getDefaultFieldConfig(property: Property): PropertyConfig | undefined;
+export declare function getFieldConfig(property: Property, propertyConfigs: Record<string, PropertyConfig>): PropertyConfig | undefined;
+export declare function getDefaultFieldId(property: Property): "reference" | "relation" | "block" | "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_as_string" | "multi_references" | "switch" | "date_time" | "repeat" | "custom_array" | undefined;
+export declare function getFieldId(property: Property): string | undefined;

package/dist/core/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./Rebase";
+export * from "./DefaultDrawer";
+export * from "./DrawerNavigationItem";
+export * from "./DrawerNavigationGroup";
+export * from "./field_configs";
+export * from "./SideDialogs";
+export * from "./RebaseRouter";
+export * from "./RebaseRoutes";
+export * from "../app";

package/dist/form/EntityForm.d.ts

@@ -0,0 +1,7 @@
+import { AuthController, Entity, EntityCollection, EntityValues, PropertyConfig, EntityFormProps } from "@rebasepro/types";
+import { ValidationError } from "yup";
+export declare function extractTouchedValues(values: any, touched: Record<string, boolean>): Record<string, any>;
+export declare function getChanges<T extends object>(source: Partial<T>, comparison: Partial<T>): Partial<T>;
+export declare function EntityForm<M extends Record<string, any>>({ path, entityId: entityIdProp, collection, onValuesModified, onIdChange, onSaved, entity, initialDirtyValues, onFormContextReady, forceActionsAtTheBottom, initialStatus, className, onStatusChange, onEntityChange, openEntityMode, formex: formexProp, disabled: disabledProp, Builder, EntityFormActionsComponent, showDefaultActions, showEntityPath, children }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function getInitialEntityValues<M extends object>(authController: AuthController, collection: EntityCollection, path: string, status: "new" | "existing" | "copy", entity: Entity<M> | undefined, propertyConfigs?: Record<string, PropertyConfig>): Partial<EntityValues<M>>;
+export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;

package/dist/form/EntityFormActions.d.ts

@@ -0,0 +1,2 @@
+import { EntityFormActionsProps } from "@rebasepro/types";
+export declare function EntityFormActions({ path, collection, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode, navigateBack, formContext }: EntityFormActionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/form/PropertyFieldBinding.d.ts

@@ -0,0 +1,30 @@
+import { ReactElement } from "react";
+import { PropertyFieldBindingProps } from "@rebasepro/types";
+/**
+ * This component renders a form field creating the corresponding configuration
+ * from a property. For example if bound to a string property, it will generate
+ * a text field.
+ *
+ * You can use it when you are creating a custom field, and need to
+ * render additional fields mapped to properties. This is useful if you
+ * need to build a complex property mapping, like an array where each index
+ * is a different property.
+ *
+ * Please note that if you build a custom field in a component, the
+ * **validation** passed in the property will have no effect. You need to set
+ * the validation in the `EntityCollection` definition.
+ *
+ * @param propertyKey You can use nested names such as `address.street` or `friends[2]`
+ * @param property
+ * @param context
+ * @param includeDescription
+ * @param underlyingValueHasChanged
+ * @param disabled
+ * @param tableMode
+ * @param partOfArray
+ * @param autoFocus
+ * @group Form custom fields
+ */
+export declare const PropertyFieldBinding: typeof PropertyFieldBindingInternal;
+declare function PropertyFieldBindingInternal<M extends Record<string, any> = any>({ propertyKey, property, context, includeDescription, underlyingValueHasChanged, disabled: disabledProp, partOfArray, partOfBlock, minimalistView, autoFocus, index, size, onPropertyChange, }: PropertyFieldBindingProps<M>): ReactElement<PropertyFieldBindingProps<M>>;
+export {};

package/dist/form/components/ErrorFocus.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export declare const ErrorFocus: ({ containerRef }: {
+    containerRef?: React.RefObject<HTMLDivElement | null>;
+}) => null;

package/dist/form/components/FieldHelperText.d.ts

@@ -0,0 +1,12 @@
+import { Property } from "@rebasepro/types";
+/**
+ * Component in charge of rendering the description of a field
+ * as well as the error message if any.
+ */
+export declare function FieldHelperText<T>({ error, showError, property, includeDescription, disabled }: {
+    error?: string;
+    showError?: boolean;
+    property: Property | Property;
+    includeDescription?: boolean;
+    disabled?: boolean;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/form/components/FormEntry.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export declare function FormEntry({ propertyKey, widthPercentage, children }: {
+    propertyKey: string;
+    widthPercentage?: number;
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;