@rebasepro/core 0.0.1-canary.2 → 0.0.1-canary.3263433

package/README.md

@@ -69,9 +69,9 @@ Rebase has been meticulously crafted to make it incredibly easy for developers
 to build a CMS/admin tool while offering an excellent data editing experience
 and a user-friendly interface for marketers and content managers.
 
-### 🏓 Exceptional Spreadsheet View
+### 🏓 Exceptional Table View
 
-We've developed a highly efficient windowed **spreadsheet view** for
+We've developed a highly efficient windowed **table view** for
 collections, allowing inline editing for most common fields, as well as popup
 views for other cases and your custom field implementations.
 
@@ -138,7 +138,7 @@ You can replace the Firebase Storage implementation with your own.
 ## Included example
 
 You can access the code for the demo project under
-[`example`](https://github.com/Rebaseco/rebase/tree/master/example). It includes
+[`example`](https://github.com/rebasepro/rebase/tree/master/example). It includes
 every feature provided by this CMS.
 
 Keep in mind you need to update the dependencies in that project if you want to

package/dist/components/ErrorView.d.ts

@@ -10,7 +10,7 @@ export interface ErrorViewProps {
 }
 /**
  * Generic error view. Displayed for example when an unexpected value comes
- * from the datasource in a collection view.
+ * from the driver in a collection view.
  * @param title
  * @param error
  * @param tooltip

package/dist/components/LanguageToggle.d.ts

@@ -0,0 +1 @@
+export declare function LanguageToggle(): import("react/jsx-runtime").JSX.Element;

package/dist/components/LoginView/LoginView.d.ts

@@ -0,0 +1,68 @@
+import { ReactNode } from "react";
+import { AuthControllerExtended } from "@rebasepro/types";
+/**
+ * Props for the generic LoginView.
+ * Consumes {@link AuthControllerExtended} — works with any backend
+ * (Rebase custom backend, Firebase, Supabase, etc.)
+ */
+export interface LoginViewProps {
+    /**
+     * Auth controller — must implement AuthControllerExtended.
+     */
+    authController: AuthControllerExtended;
+    /**
+     * Path to the logo displayed in the login screen
+     */
+    logo?: string;
+    /**
+     * Enable the skip login button
+     */
+    allowSkipLogin?: boolean;
+    /**
+     * Disable the login buttons
+     */
+    disabled?: boolean;
+    /**
+     * Prevent users from creating new accounts.
+     * If not set, checks `authController.capabilities.registration`.
+     */
+    disableSignupScreen?: boolean;
+    /**
+     * Display this component when no user is found
+     */
+    noUserComponent?: ReactNode;
+    /**
+     * Display this component below the sign-in buttons
+     */
+    additionalComponent?: ReactNode;
+    /**
+     * Error message when user is not allowed access
+     */
+    notAllowedError?: string | Error;
+    /**
+     * Override: enable Google login button.
+     * If not set, checks `authController.capabilities.googleLogin`.
+     */
+    googleEnabled?: boolean;
+    /**
+     * Google client ID for Google OAuth.
+     * Required when Google login is enabled via ID token flow.
+     */
+    googleClientId?: string;
+    /**
+     * When true, shows bootstrap/setup UI (first-user creation).
+     * If not set, derived from `authController` if it exposes `needsSetup`.
+     */
+    needsSetup?: boolean;
+    /**
+     * Whether registration is enabled.
+     * If not set, derived from `authController.capabilities.registration`.
+     */
+    registrationEnabled?: boolean;
+}
+/**
+ * Generic login view component that works with any AuthControllerExtended.
+ * Feature-detects capabilities to show/hide login methods.
+ * @group Core
+ */
+export declare function LoginView({ logo, authController, noUserComponent, disableSignupScreen, disabled, notAllowedError, googleEnabled, googleClientId, needsSetup, registrationEnabled }: LoginViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/LoginView/index.d.ts

@@ -0,0 +1,2 @@
+export { LoginView } from "./LoginView";
+export type { LoginViewProps } from "./LoginView";

package/dist/components/RebaseAuth.d.ts

@@ -0,0 +1,10 @@
+import type { RebaseAuthConfig } from "@rebasepro/types";
+/**
+ * Declarative component to configure authentication in Rebase.
+ * Renders nothing — purely registers config into the RebaseRegistry.
+ *
+ * This is a framework-level component that lives in core since
+ * authentication is cross-cutting (CMS, Studio, any app area).
+ * @group Core
+ */
+export declare function RebaseAuth({ loginView }: RebaseAuthConfig): null;

package/dist/components/UserDisplay.d.ts

@@ -2,6 +2,6 @@ import { User } from "@rebasepro/types";
 /**
  * Component to render a single user with name and email
  */
-export declare function UserDisplay({ user, }: {
+export declare function UserDisplay({ user }: {
     user: User | null;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/components/UserSelectPopover.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Represents a selectable user item with optional role information.
+ */
+export interface SelectableUser {
+    uid: string;
+    displayName?: string | null;
+    email?: string | null;
+    photoURL?: string | null;
+    roles?: string[];
+}
+export interface UserSelectPopoverProps {
+    /**
+     * The currently selected user, or `null` for "self"/default.
+     */
+    selectedUser: SelectableUser | null;
+    /**
+     * Called when the user selection changes.
+     * `null` means "reset to self/default".
+     */
+    onUserSelected: (user: SelectableUser | null) => void;
+    /**
+     * Full list of users to display.
+     * The component handles client-side search/filter internally.
+     */
+    users: SelectableUser[];
+    /**
+     * Whether users are currently loading.
+     */
+    loading?: boolean;
+    /**
+     * The current user (displayed as the "self" option at the top).
+     */
+    currentUser?: SelectableUser | null;
+    /**
+     * Label to display when no user is selected.
+     * @default "Current user"
+     */
+    defaultLabel?: string;
+    /**
+     * Maximum number of users to render at a time (for performance).
+     * Users can still be found via search.
+     * @default 100
+     */
+    renderLimit?: number;
+    /**
+     * Additional class name for the trigger button.
+     */
+    className?: string;
+    /**
+     * Size variant.
+     * @default "small"
+     */
+    size?: "small" | "medium";
+}
+/**
+ * A reusable user picker popover with search support.
+ * Designed to handle very large user lists (100k+) by filtering
+ * client-side and limiting the rendered set.
+ *
+ * @group Components
+ */
+export declare function UserSelectPopover({ selectedUser, onUserSelected, users, loading, currentUser, defaultLabel, renderLimit, className, size }: UserSelectPopoverProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,6 +1,6 @@
 export * from "./types";
 export * from "./useDebouncedData";
 export * from "./useColumnsIds";
-export * from "./useDataSourceTableController";
-export * from "./useTableSearchHelper";
-export * from "./default_entity_actions";
+export * from "./useDataTableController";
+export * from "./useScrollRestoration";
+export * from "./table_height";

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

@@ -1,9 +1,14 @@
-import { CollectionSize, Property, SelectedCellProps } from "@rebasepro/types";
+import type { Property } from "@rebasepro/types";
+import { CollectionSize, SelectedCellProps } from "@rebasepro/types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
     /**
      * This cell is displayed as selected
      */
     selectedCell?: SelectedCellProps<any>;
+    /**
+     * Store used to sync selection state across cells efficiently.
+     */
+    selectionStore?: any;
     /**
      * Select a table cell
      * @param cell

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

@@ -1,6 +1,9 @@
-import { EntityCollection, Property } from "@rebasepro/types";
-import { PropertyColumnConfig } from "../EntityCollectionTable/EntityCollectionTableProps";
-export declare const COLLECTION_GROUP_PARENT_ID = "collectionGroupParent";
+import type { EntityCollection, Property } from "@rebasepro/types";
+export type PropertyColumnConfig = {
+    key: string;
+    disabled: boolean;
+};
+export declare function getSubcollectionColumnId(collection: EntityCollection<any>): string;
 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 → useDataTableController.d.ts}

@@ -1,7 +1,8 @@
-import { Entity, EntityCollection, EntityTableController, FilterValues, User } from "@rebasepro/types";
+import type { EntityCollection } from "@rebasepro/types";
+import { Entity, 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> = {
+export type DataTableControllerProps<M extends Record<string, any> = any> = {
     /**
      * Full path where the data of this table is located
      */
@@ -19,7 +20,7 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
     /**
      * Force filter to be applied to the table.
      */
-    forceFilter?: FilterValues<string>;
+    fixedFilter?: FilterValues<string>;
     scrollRestoration?: ScrollRestorationController;
     /**
      * When set to true the filters and sort will be updated in the URL
@@ -28,7 +29,7 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
 };
 /**
  * Use this hook to build a controller for the {@link EntityCollectionTable}.
- * This controller is bound to data in a path in your specified datasource.
+ * This controller is bound to data in a path in your specified driver.
  *
  * Note that you can build your own hook returning a {@link EntityTableController}
  * if you would like to display different data.
@@ -38,7 +39,7 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
  * @param scrollRestoration
  * @param entitiesDisplayedFirst
  * @param lastDeleteTimestamp
- * @param forceFilterFromProps
+ * @param fixedFilterFromProps
  * @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>;
+export declare function useDataTableController<M extends Record<string, any> = any, USER extends User = User>({ path, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp: _lastDeleteTimestamp, fixedFilter: fixedFilterFromProps, updateUrl }: DataTableControllerProps<M>): EntityTableController<M>;

package/dist/components/index.d.ts

@@ -1,35 +1,16 @@
 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 "./ErrorTooltip";
 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";
+export * from "./LanguageToggle";
+export * from "./UserSelectPopover";
+export * from "./UserDisplay";
+export * from "./LoginView";
+export * from "./RebaseAuth";

package/dist/contexts/CustomizationControllerContext.d.ts

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

package/dist/contexts/DataDriverContext.d.ts

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

package/dist/contexts/DatabaseAdminContext.d.ts

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

package/dist/contexts/DialogsProvider.d.ts

@@ -1,4 +1,4 @@
+import type { DialogsController } from "@rebasepro/types";
 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

@@ -1,4 +1,4 @@
+import type { EffectiveRoleController } from "@rebasepro/types";
 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/RebaseClientInstanceContext.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+/**
+ * Context that exposes the full RebaseClient instance (from `@rebasepro/client`).
+ * Used by the JS Editor to give developer scripts access to `client.data`, `client.auth`, etc.
+ */
+export declare const RebaseClientInstanceContext: React.Context<any>;

package/dist/contexts/RebaseDataContext.d.ts

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

package/dist/contexts/index.d.ts

@@ -3,13 +3,11 @@ 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 "./DataDriverContext";
 export * from "./AnalyticsContext";
 export * from "./StorageSourceContext";
 export * from "./UserConfigurationPersistenceContext";
 export * from "./DialogsProvider";
 export * from "./InternalUserManagementContext";
+export * from "./RebaseClientInstanceContext";
+export * from "./CustomizationControllerContext";

package/dist/core/PluginLifecycleManager.d.ts

@@ -0,0 +1,17 @@
+import type { RebasePlugin, RebaseContext } from "@rebasepro/types";
+/**
+ * Render-less component that manages plugin lifecycle hooks.
+ *
+ * - Calls `lifecycle.onMount(context)` when plugins mount.
+ * - Calls `lifecycle.onUnmount()` when plugins unmount.
+ * - Subscribes to auth state changes and calls `lifecycle.onAuthStateChange`.
+ *
+ * Mount this component inside the Rebase tree, below PluginProviderStack,
+ * so that the RebaseContext is fully available.
+ *
+ * @internal
+ */
+export declare function PluginLifecycleManager({ plugins, context }: {
+    plugins: RebasePlugin[];
+    context: RebaseContext;
+}): null;

package/dist/core/PluginProviderStack.d.ts

@@ -0,0 +1,21 @@
+import type { RebasePlugin } from "@rebasepro/types";
+import React from "react";
+/**
+ * Wraps children with all provider components from plugins that match the given scope.
+ *
+ * Replaces the 3 copy-pasted `plugins.forEach(plugin => { if (plugin.form?.provider) ... })` patterns
+ * in Rebase.tsx, EntityEditView.tsx, and PopupFormField.tsx.
+ *
+ * @param plugins - Array of plugins to extract providers from.
+ * @param scope - `"root"` or `"form"` — which providers to apply.
+ * @param scopeProps - Additional props passed to each provider component.
+ * @param children - The content to wrap.
+ *
+ * @group Core
+ */
+export declare function PluginProviderStack({ plugins, scope, scopeProps, children }: {
+    plugins: RebasePlugin[];
+    scope: "root" | "form";
+    scopeProps?: Record<string, unknown>;
+    children: React.ReactNode;
+}): React.ReactNode;

package/dist/core/Rebase.d.ts

@@ -1,4 +1,5 @@
-import { RebaseProps, User } from "@rebasepro/types";
+import type { RebaseProps } from "./RebaseProps";
+import { 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.

package/dist/core/RebaseProps.d.ts

@@ -0,0 +1,136 @@
+import React from "react";
+import { Locale, User, AuthController, AnalyticsEvent, DataDriver, StorageSource, UserConfigurationPersistence, DatabaseAdmin, RebaseData, RebaseClient, RebaseContext, UserManagementDelegate, EntityLinkBuilder, RebasePlugin, SlotContribution, PropertyConfig, EntityCustomView, EntityAction } from "@rebasepro/types";
+/**
+ * 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<any>[];
+    /**
+     * 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;
+};

package/dist/core/index.d.ts

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

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

@@ -1,4 +1,6 @@
-import { DataSource, DeleteEntityProps, Entity, EntityCallbacks, EntityCollection, RebaseContext, User } from "@rebasepro/types";
+import type { EntityCollection } from "@rebasepro/types";
+import { DeleteEntityProps, Entity, EntityCallbacks, RebaseContext, User } from "@rebasepro/types";
+import { RebaseData } from "@rebasepro/types";
 /**
  * @group Hooks and utilities
  */
@@ -8,16 +10,12 @@ export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, USER e
     onDeleteFailure?: (entity: Entity<M>, e: Error) => void;
 };
 /**
- * This function is in charge of deleting an entity in the datasource.
+ * 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.
  *
- * If you just want to delete any data without running the `beforeDelete`,
- * and `afterDelete` callbacks, you can use the `deleteEntity` method
- * in the datasource ({@link useDataSource}).
- *
- * @param dataSource
+ * @param data
  * @param entity
  * @param collection
  * @param callbacks
@@ -26,8 +24,8 @@ export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, USER e
  * @param context
  * @group Hooks and utilities
  */
-export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ dataSource, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, context }: DeleteEntityWithCallbacksProps<M> & {
+export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ data, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, context }: DeleteEntityWithCallbacksProps<M> & {
     collection: EntityCollection<M>;
-    dataSource: DataSource;
+    data: RebaseData;
     context: RebaseContext<USER>;
 }): Promise<boolean>;

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

@@ -1,4 +1,6 @@
-import { DataSource, Entity, EntityCollection, RebaseContext, SaveEntityProps } from "@rebasepro/types";
+import type { EntityCollection } from "@rebasepro/types";
+import { Entity, RebaseContext, SaveEntityProps } from "@rebasepro/types";
+import { RebaseData } from "@rebasepro/types";
 /**
  * @group Hooks and utilities
  */
@@ -7,15 +9,11 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEn
     afterSaveError?: (e: Error) => void;
 };
 /**
- * This function is in charge of saving an entity to the datasource.
+ * 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.
  *
- * If you just want to save the data without running the `afterSave`,
- * `afterSaveError` and `beforeSave` callbacks, you can use the `saveEntity` method
- * in the datasource ({@link useDataSource}).
- *
  * @param collection
  * @param path
  * @param entityId
@@ -23,15 +21,14 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEn
  * @param values
  * @param previousValues
  * @param status
- * @param dataSource
+ * @param data
  * @param context
  * @param afterSave
  * @param afterSaveError
- * @see useDataSource
  * @group Hooks and utilities
  */
-export declare function saveEntityWithCallbacks<M extends Record<string, any>>({ collection, path, entityId, values, previousValues, status, dataSource, context, afterSave, afterSaveError }: SaveEntityWithCallbacksProps<M> & {
+export declare function saveEntityWithCallbacks<M extends Record<string, any>>({ collection, path, entityId, values, previousValues, status, data, context, afterSave, afterSaveError }: SaveEntityWithCallbacksProps<M> & {
     collection: EntityCollection;
-    dataSource: DataSource;
+    data: RebaseData;
     context: RebaseContext;
 }): Promise<Entity<M>>;