@rebasepro/plugin-data-enhancement 0.4.0 → 0.6.0

package/dist/core/src/core/RebaseProps.d.ts

@@ -1,147 +0,0 @@
-import React from "react";
-import { Locale, User, AuthController, AnalyticsEvent, DataDriver, StorageSource, UserConfigurationPersistence, DatabaseAdmin, RebaseData, RebaseClient, RebaseContext, UserManagementDelegate, EntityLinkBuilder, RebasePlugin, SlotContribution, PropertyConfig, EntityCustomView, EntityAction, RebaseTranslations } from "@rebasepro/types";
-/** DeepPartial helper — allows partial overrides at any nesting level */
-type DeepPartial<T> = T extends object ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : T;
-/**
- * Controller to simulate different roles when dev mode is active.
- * @group Models
- */
-export interface EffectiveRoleController {
-    effectiveRole: string | null;
-    setEffectiveRole: (role: string | null) => void;
-}
-/**
- * @group Models
- */
-export type RebaseProps<USER extends User> = {
-    /**
-     * The root components of your application. Use RebaseCMS, RebaseStudio, and RebaseShell.
-     * Alternatively, pass a render function that receives { context, loading }.
-     */
-    children: React.ReactNode | ((props: {
-        context: RebaseContext;
-        loading: boolean;
-    }) => React.ReactNode);
-    /**
-     * Optional base path for the entire Rebase app.
-     * Defaults to "/"
-     */
-    basePath?: string;
-    /**
-     * Optional base path for the CMS collections.
-     * Defaults to "/c"
-     */
-    baseCollectionPath?: string;
-    /**
-     * If you have a custom API key, you can use it here.
-     */
-    apiKey?: string;
-    /**
-     * Base URL for the backend API (e.g. "http://localhost:3001").
-     * When provided, this is available via `useApiConfig()` to any hook
-     * in the tree, reducing repetitive `apiUrl` threading.
-     */
-    apiUrl?: string;
-    /**
-     * Format of the dates in the CMS.
-     * Defaults to 'MMMM dd, yyyy, HH:mm:ss'
-     */
-    dateTimeFormat?: string;
-    /**
-     * Locale of the CMS, currently only affecting dates
-     */
-    locale?: Locale;
-    /**
-     * Unified RebaseClient for data, auth, and storage.
-     */
-    client?: RebaseClient;
-    /**
-     * Optional override for RebaseData if not using `client`
-     */
-    data?: RebaseData;
-    /**
-     * Optional override for DataDriver if not using `client`
-     */
-    driver?: DataDriver;
-    /**
-     * Optional override for AuthController if not using `client`
-     */
-    authController?: AuthController<USER>;
-    /**
-     * Optional override for StorageSource if not using `client`
-     */
-    storageSource?: StorageSource;
-    /**
-     * Administrative database operations (SQL, schema discovery).
-     * Only needed when the studio/admin features are enabled.
-     */
-    databaseAdmin?: DatabaseAdmin;
-    /**
-     * Use this controller to access the configuration that is stored locally,
-     * and not defined in code
-     */
-    userConfigPersistence?: UserConfigurationPersistence;
-    /**
-     * Callback used to get analytics events from the CMS
-     */
-    onAnalyticsEvent?: (event: AnalyticsEvent, data?: object) => void;
-    /**
-     * Optional link builder you can add to generate a button in your entity forms.
-     * The function must return a URL that gets opened when the button is clicked
-     */
-    entityLinkBuilder?: EntityLinkBuilder;
-    /**
-     * You can use this props to provide your own user management implementation.
-     * Note that this will not affect the UI, but it will be used to show user information
-     * in various places of the CMS, for example, to show who created or modified an entity,
-     * or to assign ownership of an entity.
-     *
-     * You can also use this data to be retrieved in your custom properties,
-     * for example, to show a list of users in a dropdown.
-     *
-     * If you are using the Rebase user management plugin, this
-     * prop will be implemented automatically.
-     */
-    userManagement?: UserManagementDelegate<USER>;
-    /**
-     * Plugins loaded in the CMS
-     */
-    plugins?: RebasePlugin[];
-    /**
-     * Extra slots for the CMS
-     */
-    slots?: SlotContribution[];
-    /**
-     * Property configs (widgets)
-     */
-    propertyConfigs?: Record<string, PropertyConfig>;
-    /**
-     * Entity Views
-     */
-    entityViews?: EntityCustomView[];
-    /**
-     * Entity Actions
-     */
-    entityActions?: EntityAction[];
-    components?: {
-        /**
-         * Component to render when a reference is missing
-         */
-        missingReference?: React.ComponentType<{
-            path: string;
-        }>;
-    };
-    /**
-     * Controller to simulate different roles when dev mode is active.
-     */
-    effectiveRoleController?: EffectiveRoleController;
-    /**
-     * Override or extend any Rebase UI string, keyed by locale.
-     */
-    translations?: {
-        [locale: string]: DeepPartial<RebaseTranslations>;
-    };
-};
-export {};

package/dist/core/src/core/RebaseRouter.d.ts

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

package/dist/core/src/core/RebaseRoutes.d.ts

@@ -1,17 +0,0 @@
-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/src/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Rebase";
-export * from "./PluginProviderStack";
-export * from "./RebaseRouter";
-export * from "./RebaseRoutes";

package/dist/core/src/hooks/ApiConfigContext.d.ts

@@ -1,24 +0,0 @@
-import React from "react";
-/**
- * Configuration for API connectivity. Passed once at the top level
- * and available to any hook that needs `apiUrl` or `getAuthToken`.
- *
- * Individual hooks can still accept explicit overrides — this context
- * serves as a fallback to eliminate repetitive threading.
- */
-export interface ApiConfig {
-    apiUrl: string;
-    getAuthToken?: () => Promise<string | null>;
-}
-/**
- * Read the API config from context. Returns `undefined` if no provider is present,
- * allowing hooks to fall back to their own props.
- */
-export declare function useApiConfig(): ApiConfig | undefined;
-/**
- * Provide API configuration (apiUrl, getAuthToken) to the entire subtree.
- * Typically rendered inside `<Rebase>` or at the app root.
- */
-export declare function ApiConfigProvider({ apiUrl, getAuthToken, children }: ApiConfig & {
-    children: React.ReactNode;
-}): import("react/jsx-runtime").JSX.Element;

package/dist/core/src/hooks/data/delete.d.ts

@@ -1,31 +0,0 @@
-import type { EntityCollection } from "@rebasepro/types";
-import { DeleteEntityProps, Entity, EntityCallbacks, RebaseContext, User } from "@rebasepro/types";
-import { RebaseData } from "@rebasepro/types";
-/**
- * @group Hooks and utilities
- */
-export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, USER extends User = User> = DeleteEntityProps<M> & {
-    callbacks?: EntityCallbacks<M, USER>;
-    onDeleteSuccess?: (entity: Entity<M>) => void;
-    onDeleteFailure?: (entity: Entity<M>, e: Error) => void;
-};
-/**
- * This function is in charge of deleting an entity.
- * It will run all the delete callbacks specified in the collection.
- * It is also possible to attach callbacks on save success or error, and callback
- * errors.
- *
- * @param data
- * @param entity
- * @param collection
- * @param callbacks
- * @param onDeleteSuccess
- * @param onDeleteFailure
- * @param context
- * @group Hooks and utilities
- */
-export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ data, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, context }: DeleteEntityWithCallbacksProps<M> & {
-    collection: EntityCollection<M>;
-    data: RebaseData;
-    context: RebaseContext<USER>;
-}): Promise<boolean>;

package/dist/core/src/hooks/data/save.d.ts

@@ -1,34 +0,0 @@
-import type { EntityCollection } from "@rebasepro/types";
-import { Entity, RebaseContext, SaveEntityProps } from "@rebasepro/types";
-import { RebaseData } from "@rebasepro/types";
-/**
- * @group Hooks and utilities
- */
-export type SaveEntityWithCallbacksProps<M extends Record<string, unknown>> = SaveEntityProps<M> & {
-    afterSave?: (updatedEntity: Entity<M>) => void;
-    afterSaveError?: (e: Error) => void;
-};
-/**
- * This function is in charge of saving an entity.
- * It will run all the save callbacks specified in the collection.
- * It is also possible to attach callbacks on save success or error, and callback
- * errors.
- *
- * @param collection
- * @param path
- * @param entityId
- * @param callbacks
- * @param values
- * @param previousValues
- * @param status
- * @param data
- * @param context
- * @param afterSave
- * @param afterSaveError
- * @group Hooks and utilities
- */
-export declare function saveEntityWithCallbacks<M extends Record<string, unknown>>({ collection, path, entityId, values, previousValues, status, data, context, afterSave, afterSaveError }: SaveEntityWithCallbacksProps<M> & {
-    collection: EntityCollection;
-    data: RebaseData;
-    context: RebaseContext;
-}): Promise<Entity<M>>;

package/dist/core/src/hooks/data/useCollectionFetch.d.ts

@@ -1,62 +0,0 @@
-import type { EntityCollection } from "@rebasepro/types";
-import { Entity, FilterValues, User } from "@rebasepro/types";
-/**
- * @group Hooks and utilities
- */
-export interface CollectionFetchProps<M extends Record<string, any>> {
-    /**
-     * Absolute collection path
-     */
-    path: string;
-    /**
-     * collection of the entity displayed by this collection
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Number of entities to fetch
-     */
-    itemCount?: number;
-    /**
-     * Number of items to skip
-     */
-    offset?: number;
-    /**
-     * Page number (1-indexed), alternative to offset
-     */
-    page?: number;
-    /**
-     * Filter the fetched data by the property
-     */
-    filterValues?: FilterValues<Extract<keyof M, string>>;
-    /**
-     * Sort the results by
-     */
-    sortBy?: [Extract<keyof M, string>, "asc" | "desc"];
-    /**
-     * Search string
-     */
-    searchString?: string;
-}
-/**
- * @group Hooks and utilities
- */
-export interface CollectionFetchResult<M extends Record<string, any>> {
-    data: Entity<M>[];
-    dataLoading: boolean;
-    noMoreToLoad: boolean;
-    dataLoadingError?: Error;
-    totalCount?: number;
-}
-/**
- * This hook is used to fetch collections using a given collection
- * @param path
- * @param collection
- * @param filterValues
- * @param sortBy
- * @param itemCount
- * @param offset
- * @param page
- * @param searchString
- * @group Hooks and utilities
- */
-export declare function useCollectionFetch<M extends Record<string, any>, USER extends User>({ path, collection, filterValues, sortBy, itemCount, offset, page, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;

package/dist/core/src/hooks/data/useData.d.ts

@@ -1,13 +0,0 @@
-import { RebaseData } from "@rebasepro/types";
-/**
- * Use this hook to access the unified data API.
- *
- * ```ts
- * const data = useData();
- * const { data: products } = await data.products.find({ where: { status: "eq.published" } });
- * await data.products.create({ name: "Camera", price: 299 });
- * ```
- *
- * @group Hooks and utilities
- */
-export declare const useData: () => RebaseData;

package/dist/core/src/hooks/data/useDataOrder.d.ts

@@ -1,12 +0,0 @@
-import { Entity } from "@rebasepro/types";
-export interface DataOrderProps<M extends Record<string, any>> {
-    data: Entity<M>[];
-    entitiesDisplayedFirst?: Entity<M>[];
-}
-/**
- * This hook is used to have some entities at the beginning of data.
- * @param path
- * @param entitiesDisplayedFirst
- * @group Hooks and utilities
- */
-export declare function useDataOrder<M extends Record<string, any>>({ data, entitiesDisplayedFirst }: DataOrderProps<M>): Entity<M>[];

package/dist/core/src/hooks/data/useEntityFetch.d.ts

@@ -1,43 +0,0 @@
-import type { EntityCollection } from "@rebasepro/types";
-import { Entity, User } from "@rebasepro/types";
-/**
- * @group Hooks and utilities
- */
-export interface EntityFetchProps<M extends Record<string, any>, USER extends User = User> {
-    path: string;
-    entityId?: string | number;
-    databaseId?: string;
-    collection: EntityCollection<M, USER>;
-    useCache?: boolean;
-}
-/**
- * @group Hooks and utilities
- */
-export interface EntityFetchResult<M extends Record<string, any>> {
-    entity?: Entity<M>;
-    dataLoading: boolean;
-    dataLoadingError?: Error;
-}
-/**
- * Pre-populate the entity fetch cache with entities loaded from a collection.
- * This allows entity detail views to render instantly using cached data,
- * while the background fetch/listener brings in fresh data.
- * @param path - The collection path (e.g. "products")
- * @param entities - Array of entities to cache
- */
-export declare function populateEntityFetchCache<M extends Record<string, any>>(path: string, entities: Entity<M>[]): void;
-/**
- * Clear the entity fetch cache. Call this on auth state changes (e.g. logout)
- * to prevent stale data from a previous session leaking into the next.
- */
-export declare function clearEntityFetchCache(): void;
-/**
- * This hook is used to fetch an entity.
- * It gives real time updates if the driver supports it.
- * @param path
- * @param collection
- * @param entityId
- * @param useCache
- * @group Hooks and utilities
- */
-export declare function useEntityFetch<M extends Record<string, any>, USER extends User = User>({ path, entityId, collection, databaseId, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;

package/dist/core/src/hooks/data/useRelationSelector.d.ts

@@ -1,52 +0,0 @@
-import type { EntityCollection } from "@rebasepro/types";
-import { Entity, EntityRelation, FilterValues } from "@rebasepro/types";
-export interface RelationItem {
-    id: string | number;
-    label: string;
-    description?: string;
-    data: Entity<any>;
-    relation: EntityRelation;
-}
-export interface UseRelationSelectorProps<M extends Record<string, any> = any> {
-    /**
-     * Full path where the relation data is located
-     */
-    path: string;
-    /**
-     * The collection that represents the relation entities
-     */
-    collection: EntityCollection<M>;
-    /**
-     * Force filter to be applied to the relation search
-     */
-    fixedFilter?: FilterValues<string>;
-    /**
-     * Page size for pagination
-     */
-    pageSize?: number;
-    /**
-     * Function to extract the label from an entity
-     */
-    getLabelFromEntity?: (entity: Entity<M>) => string;
-    /**
-     * Function to extract the description from an entity
-     */
-    getDescriptionFromEntity?: (entity: Entity<M>) => string | undefined;
-    /**
-     * Property name to use as the secondary display field
-     */
-    descriptionProperty?: keyof M;
-}
-export interface RelationSelectorController {
-    items: RelationItem[];
-    isLoading: boolean;
-    error: Error | undefined;
-    search: (searchString: string) => void;
-    loadMore: () => void;
-    hasMore: boolean;
-    entityToRelationItem: (entity: Entity<any>, relation: EntityRelation) => RelationItem;
-}
-/**
- * Hook to manage relation selection with data fetching from Rebase data source
- */
-export declare function useRelationSelector<M extends Record<string, any> = any>({ path, collection, fixedFilter, pageSize, getLabelFromEntity, getDescriptionFromEntity, descriptionProperty }: UseRelationSelectorProps<M>): RelationSelectorController;

package/dist/core/src/hooks/data/useUserSelector.d.ts

@@ -1,31 +0,0 @@
-import { User } from "@rebasepro/types";
-export interface UserSelectorItem {
-    uid: string;
-    label: string;
-    description?: string;
-    user: User;
-}
-export interface UseUserSelectorProps {
-    /**
-     * Page size for pagination. Defaults to 10.
-     */
-    pageSize?: number;
-}
-export interface UserSelectorController {
-    items: UserSelectorItem[];
-    isLoading: boolean;
-    error: Error | undefined;
-    search: (searchString: string) => void;
-    loadMore: () => void;
-    hasMore: boolean;
-    getUser: (uid: string) => User | null;
-}
-/**
- * Hook to manage user selection with server-side search and pagination.
- * Similar to useRelationSelector but for the UserManagementDelegate.
- *
- * If the delegate provides `searchUsers`, this hook uses server-side
- * search/pagination. Otherwise it falls back to client-side filtering
- * over the in-memory `users` array.
- */
-export declare function useUserSelector({ pageSize }?: UseUserSelectorProps): UserSelectorController;

package/dist/core/src/hooks/index.d.ts

@@ -1,37 +0,0 @@
-export * from "./data/useData";
-export * from "./data/useCollectionFetch";
-export * from "./data/useEntityFetch";
-export * from "./data/useRelationSelector";
-export * from "./data/useUserSelector";
-export * from "./data/save";
-export * from "./data/delete";
-export * from "./useUnsavedChangesDialog";
-export * from "./useStorageSource";
-export * from "./useAuthController";
-export * from "./useAuthSubscription";
-export * from "./useDialogsController";
-export * from "./useAdminModeController";
-export * from "./useBuildAdminModeController";
-export * from "./useEffectiveRoleController";
-export * from "./useBuildEffectiveRoleController";
-export * from "./useRebaseContext";
-export * from "./useSnackbarController";
-export * from "./useModeController";
-export * from "./useClipboard";
-export * from "./useLargeLayout";
-export * from "./useCollapsedGroups";
-export * from "./useInternalUserManagementController";
-export * from "./useBrowserTitleAndIcon";
-export * from "./useSlot";
-export * from "./useCustomizationController";
-export * from "./useBuildLocalConfigurationPersistence";
-export * from "./useBuildModeController";
-export * from "./useRebaseRegistry";
-export * from "./useBackendStorageSource";
-export * from "./usePermissions";
-export * from "./ApiConfigContext";
-export * from "./useTranslation";
-export * from "./useRebaseClient";
-export * from "./useAnalyticsController";
-export * from "./useUserConfigurationPersistence";
-export * from "./useResolvedComponent";

package/dist/core/src/hooks/useAdminModeController.d.ts

@@ -1,19 +0,0 @@
-/**
- * Use this controller to change the admin mode (developer vs editor)
- * @group Hooks and utilities
- */
-export interface AdminModeController {
-    mode: "content" | "studio" | "settings";
-    setMode: (mode: "content" | "studio" | "settings") => void;
-}
-/**
- * Hook to retrieve the current admin mode ("developer" | "editor"), and `setMode`
- * to change it.
- *
- * Consider that in order to use this hook you need to have a parent
- * `Rebase`
- *
- * @see AdminModeController
- * @group Hooks and utilities
- */
-export declare const useAdminModeController: () => AdminModeController;

package/dist/core/src/hooks/useAnalyticsController.d.ts

@@ -1,5 +0,0 @@
-import { AnalyticsController } from "@rebasepro/types";
-/**
- * @group Hooks and utilities
- */
-export declare const useAnalyticsController: () => AnalyticsController;

package/dist/core/src/hooks/useAuthController.d.ts

@@ -1,11 +0,0 @@
-import { AuthController, User } from "@rebasepro/types";
-/**
- * Hook to retrieve the AuthContext.
- *
- * Consider that in order to use this hook you need to have a parent
- * `Rebase`
- *
- * @see AuthController
- * @group Hooks and utilities
- */
-export declare const useAuthController: <USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>>() => AuthControllerType;

package/dist/core/src/hooks/useAuthSubscription.d.ts

@@ -1,2 +0,0 @@
-import { AuthClient, AuthController } from "@rebasepro/types";
-export declare function useAuthSubscription(authClient?: AuthClient): AuthController;

package/dist/core/src/hooks/useBackendStorageSource.d.ts

@@ -1,30 +0,0 @@
-/**
- * React hook for using backend storage API as a StorageSource
- */
-import { StorageSource } from "@rebasepro/types";
-export interface BackendStorageSourceProps {
-    /**
-     * Backend API URL (e.g., 'http://localhost:3001')
-     */
-    apiUrl: string;
-    /**
-     * Function to get the current auth token
-     */
-    getAuthToken: () => Promise<string>;
-}
-/**
- * Hook to create a StorageSource that uses the backend storage REST API.
- * Use this for self-hosted Rebase with local or S3 storage.
- *
- * @example
- * ```tsx
- * const storageSource = useBackendStorageSource({
- *     apiUrl: 'http://localhost:3001',
- *     getAuthToken: authController.getAuthToken
- * });
- *
- * // Then pass to Rebase:
- * <Rebase storageSource={storageSource} ... />
- * ```
- */
-export declare function useBackendStorageSource({ apiUrl, getAuthToken }: BackendStorageSourceProps): StorageSource;

package/dist/core/src/hooks/useBridgeRegistration.d.ts

@@ -1,18 +0,0 @@
-import type { StudioBridge } from "./useStudioBridge";
-/**
- * Registers a value into the self-assembling Studio bridge.
- *
- * Each controller (collectionRegistry, sideEntity, url, navigation, breadcrumbs)
- * calls this hook on mount to inject its real implementation into the bridge.
- * On unmount the slice is automatically removed, reverting to the noop default.
- *
- * Usage:
- * ```tsx
- * function SomeProvider({ children }) {
- *     const controller = useBuildSomeController();
- *     useBridgeRegistration("sideEntityController", controller);
- *     return <SomeContext.Provider value={controller}>{children}</SomeContext.Provider>;
- * }
- * ```
- */
-export declare function useBridgeRegistration<K extends keyof StudioBridge>(key: K, value: StudioBridge[K]): void;

package/dist/core/src/hooks/useBrowserTitleAndIcon.d.ts

@@ -1,6 +0,0 @@
-/**
- * Internal hook to handle the browser title and icon
- * @param name
- * @param logo
- */
-export declare function useBrowserTitleAndIcon(name: string, logo?: string): void;

package/dist/core/src/hooks/useBuildAdminModeController.d.ts

@@ -1,6 +0,0 @@
-import { AdminModeController } from "./index";
-/**
- * Use this hook to build an admin mode controller that determines
- * whether the UI shows Developer or Editor tools.
- */
-export declare function useBuildAdminModeController(): AdminModeController;

package/dist/core/src/hooks/useBuildEffectiveRoleController.d.ts

@@ -1,8 +0,0 @@
-import type { EffectiveRoleController } from "@rebasepro/types";
-/**
- * Use this hook to build an effective role controller that determines
- * what role is simulated in Editor mode when Dev mode is active.
- *
- * It uses localStorage to persist the simulated role across reloads.
- */
-export declare function useBuildEffectiveRoleController(): EffectiveRoleController;

package/dist/core/src/hooks/useBuildLocalConfigurationPersistence.d.ts

@@ -1,2 +0,0 @@
-import { UserConfigurationPersistence } from "@rebasepro/types";
-export declare function useBuildLocalConfigurationPersistence(): UserConfigurationPersistence;

package/dist/core/src/hooks/useBuildModeController.d.ts

@@ -1,6 +0,0 @@
-import { ModeController } from "./index";
-/**
- * Use this hook to build a color mode controller that determines
- * the theme of the CMS
- */
-export declare function useBuildModeController(): ModeController;