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

package/dist/controllers/navigation.d.ts

@@ -1,225 +0,0 @@
-import React from "react";
-import type { CollectionConfig } from "../types/collections";
-/**
- * Controller that handles URL path building and resolution.
- * @group Models
- */
-export type UrlController = {
-    /**
-     * Default path under the navigation routes of the CMS will be created.
-     * Defaults to '/'. You may want to change this `basepath` to 'admin' for example.
-     */
-    basePath: string;
-    /**
-     * Default path under the collection routes of the CMS will be created.
-     * It defaults to '/c'
-     */
-    baseCollectionPath: string;
-    /**
-     * Convert a URL path to a collection or entity path
-     * `/c/products` => `products`
-     * `/my_cms/c/products/B34SAP8Z` => `products/B34SAP8Z`
-     * `/my_cms/my_view` => `my_view`
-     * @param cmsPath
-     */
-    urlPathToDataPath: (cmsPath: string) => string;
-    /**
-     * Base url path for the home screen
-     */
-    homeUrl: string;
-    /**
-     * Check if a url path belongs to a collection
-     * @param path
-     */
-    isUrlCollectionPath: (urlPath: string) => boolean;
-    /**
-     * Build a URL collection path from a data path
-     * `products` => `/c/products`
-     * `products/B34SAP8Z` => `/c/products/B34SAP8Z`
-     * @param path
-     */
-    buildUrlCollectionPath: (path: string) => string;
-    /**
-     * Build a URL path for the CMS (e.g. for custom views)
-     * @param path
-     */
-    buildAppUrlPath: (path: string) => string;
-    /**
-     * Turn a path with collection ids into a resolved path.
-     * The ids (typically used in urls) will be replaced with relative paths (typically used in database paths)
-     * @param path
-     */
-    resolveDatabasePathsFrom: (path: string) => string;
-    /**
-     * A function to navigate to a specified route or URL.
-     *
-     * @param {string} to - The target route or URL to navigate to.
-     * @param {NavigateOptions} [options] - Optional configuration settings for navigation, such as replace behavior or state data.
-     */
-    navigate: (to: string, options?: NavigateOptions) => void;
-};
-/**
- * Controller that manages the state of the navigation menu,
- * including resolved views and top-level grouping.
- * @group Models
- */
-export type NavigationStateController = {
-    /**
-     * Custom additional views created by the developer, added to the main
-     * navigation
-     */
-    views?: AppView[];
-    /**
-     * Custom additional views created by the developer, added to the admin
-     * navigation
-     */
-    adminViews?: AppView[];
-    /**
-     * Configuration for the views that should be displayed at the top
-     * level of the navigation (e.g. in the home page or the navigation
-     * drawer)
-     */
-    topLevelNavigation?: NavigationResult;
-    /**
-     * Is the navigation loading (the configuration persistence has not
-     * loaded yet, or a specified navigation builder has not completed)
-     */
-    loading: boolean;
-    /**
-     * Was there an error while loading the navigation data
-     */
-    navigationLoadingError?: Error;
-    /**
-     * Call this method to recalculate the navigation
-     */
-    refreshNavigation: () => void;
-};
-export interface NavigateOptions {
-    replace?: boolean;
-    state?: unknown;
-    preventScrollReset?: boolean;
-    relative?: "route" | "path";
-    flushSync?: boolean;
-    viewTransition?: boolean;
-}
-/**
- * Custom additional views created by the developer, added to the main
- * navigation.
- * @group Models
- */
-export interface AppView {
-    /**
-     * CMS Path you can reach this view from.
-     */
-    slug: string;
-    /**
-     * Name of this view
-     */
-    name: string;
-    /**
-     * Optional description of this view. You can use Markdown
-     */
-    description?: string;
-    /**
-     * Icon key to use in this view.
-     * You can use any of the icons in the Lucide specs:
-     * https://lucide.dev/icons/
-     * e.g. 'ShoppingCart' or 'User'
-     * Find all the icons in https://rebase.pro/docs/icons
-     */
-    icon?: string | React.ReactNode;
-    /**
-     * Should this view be hidden from the main navigation panel.
-     * It will still be accessible if you reach the specified path
-     */
-    hideFromNavigation?: boolean;
-    /**
-     * Navigation group for this view.
-     * Views sharing the same group name will be visually grouped
-     * together in the drawer and home page. If not set, the view
-     * falls into the default "Views" group.
-     */
-    group?: string;
-    /**
-     * Component to be rendered. This can be any React component, and can use
-     * any of the provided hooks.
-     *
-     * Pass a `ComponentType` to enable lazy rendering — the component will
-     * only be instantiated when the route is visited. This is recommended
-     * for dynamic views generated from database data.
-     */
-    view: React.ReactNode | React.ComponentType;
-    /**
-     * If true, a wildcard route (slug/*) is automatically registered
-     * alongside the base route, enabling nested navigation within this view.
-     */
-    nestedRoutes?: boolean;
-    /**
-     * Restrict this view to users with at least one of the listed roles.
-     * When omitted or empty, the view is visible to all authenticated users.
-     * Applied during view resolution — the view is filtered out entirely
-     * (not just hidden from nav) if the user lacks a matching role.
-     */
-    roles?: string[];
-}
-/**
- * A composable section that can be rendered on the home page.
- * Use this to add custom content alongside the auto-generated
- * navigation groups.
- * @group Models
- */
-export interface HomePageSection {
-    /**
-     * Unique key for this section.
-     */
-    key: string;
-    /**
-     * Title displayed as the section header.
-     */
-    title: string;
-    /**
-     * Arbitrary React content rendered inside the section.
-     */
-    children: React.ReactNode;
-}
-/**
- * Used to group navigation entries in the main navigation.
- */
-export interface NavigationGroupMapping {
-    /**
-     * Name of the group, used to display the group header in the UI
-     */
-    name: string;
-    /**
-     * List of collection ids or view paths that belong to this group.
-     */
-    entries: string[];
-    /**
-     * Configure which groups start collapsed.
-     * Set to `true` to collapse in both drawer and home page,
-     * or use an object to control each independently.
-     *
-     * @defaultValue false (expanded)
-     */
-    collapsedByDefault?: boolean | {
-        drawer?: boolean;
-        home?: boolean;
-    };
-}
-export interface NavigationEntry {
-    id: string;
-    url: string;
-    name: string;
-    slug: string;
-    type: "collection" | "view" | "admin";
-    collection?: CollectionConfig;
-    view?: AppView;
-    description?: string;
-    group: string;
-}
-export type NavigationResult = {
-    allowDragAndDrop: boolean;
-    navigationEntries: NavigationEntry[];
-    groups: string[];
-    onNavigationEntriesUpdate: (entries: NavigationGroupMapping[]) => void;
-};

package/dist/controllers/registry.d.ts

@@ -1,80 +0,0 @@
-import { ReactNode } from "react";
-import type { CollectionConfig } from "../types/collections";
-import type { CollectionConfigsBuilder, AppViewsBuilder } from "../types/builders";
-import type { EntityCustomView } from "../types/entity_views";
-import type { EntityAction } from "../types/entity_actions";
-import type { AppView, NavigationGroupMapping } from "./navigation";
-/**
- * Options to enable the built-in collection editor.
- * When provided to `<RebaseAdmin>`, the editor is auto-wired as a native feature.
- */
-export interface CollectionEditorOptions {
-    /**
-     * Function that returns an auth token for schema-editor API calls.
-     * Falls back to `authController.getAuthToken` when omitted.
-     */
-    getAuthToken?: () => Promise<string | null>;
-    /** Mark the editor as read-only (disable mutations). */
-    readOnly?: boolean;
-    /** Suggested base paths shown when creating new collections. */
-    pathSuggestions?: string[];
-}
-export interface RebaseAdminConfig<EC extends CollectionConfig = CollectionConfig> {
-    collections?: EC[] | CollectionConfigsBuilder<EC>;
-    /**
-     * Custom top-level views added to the main navigation.
-     * Accepts a static array of views or an async builder function
-     * that receives the current user/auth context for role-based views.
-     */
-    views?: AppView[] | AppViewsBuilder;
-    homePage?: ReactNode;
-    entityViews?: EntityCustomView[];
-    entityActions?: EntityAction[];
-    /**
-     * Centralized configuration for how collections and views are grouped
-     * in the navigation sidebar and home page.
-     * Each mapping defines a named group and the collection/view slugs
-     * that belong to it. The array order determines group display order.
-     * Entry order within each group determines card order.
-     */
-    navigationGroupMappings?: NavigationGroupMapping[];
-    /**
-     * Enable the built-in visual collection/schema editor.
-     * Pass `true` for zero-config, or an options object for fine-grained control.
-     * When enabled, the editor slots, provider, and Studio schema view
-     * are all auto-wired — no plugin or manual view injection needed.
-     */
-    collectionEditor?: boolean | CollectionEditorOptions;
-    /**
-     * URL path prefix the admin is mounted under, when it does not live at the
-     * site root. Set this when the admin is rendered inside a path-prefixed
-     * route (e.g. `<Route path="/admin/*">`) so URL⇄collection resolution
-     * accounts for the prefix — otherwise the current path won't be recognized
-     * as a collection path and views hang on a spinner with no data fetch.
-     *
-     * Do NOT set this when mounting via a react-router `basename` — react-router
-     * already strips the prefix from the location, so the default (`/`) is correct.
-     *
-     * @default "/"
-     */
-    basePath?: string;
-}
-export interface RebaseStudioConfig {
-    tools?: ("sql" | "js" | "rls" | "schema" | "storage" | "cron" | "schema-visualizer" | "branches" | "backups" | "api" | "logs" | "api-keys")[];
-    homePage?: ReactNode;
-    devViews?: AppView[];
-}
-export interface RebaseAuthConfig {
-    loginView?: ReactNode;
-}
-export interface RebaseRegistryController {
-    cmsConfig: RebaseAdminConfig | null;
-    studioConfig: RebaseStudioConfig | null;
-    authConfig: RebaseAuthConfig | null;
-    registerCMS: (config: RebaseAdminConfig) => void;
-    unregisterCMS: () => void;
-    registerStudio: (config: RebaseStudioConfig) => void;
-    unregisterStudio: () => void;
-    registerAuth: (config: RebaseAuthConfig) => void;
-    unregisterAuth: () => void;
-}

package/dist/controllers/side_dialogs_controller.d.ts

@@ -1,67 +0,0 @@
-import React from "react";
-/**
- * Controller to open the side dialog
- * @group Hooks and utilities
- */
-export interface SideDialogsController {
-    /**
-     * Close the last panel
-     */
-    close: () => void;
-    /**
-     * List of side panels currently open
-     */
-    sidePanels: SideDialogPanelProps[];
-    /**
-     * Override the current side panels
-     * @param panels
-     */
-    setSidePanels: (panels: SideDialogPanelProps[]) => void;
-    /**
-     * Open one or multiple side panels
-     * @param props
-     */
-    open: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
-    /**
-     * Replace the last open panel with the given one
-     * @param props
-     */
-    replace: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
-}
-/**
- * Props used to open a side dialog
- * @group Hooks and utilities
- */
-export interface SideDialogPanelProps {
-    /**
-     * A key that identifies this panel
-     */
-    key: string;
-    /**
-     * The component type that will be rendered
-     */
-    component: React.ReactNode;
-    /**
-     * Optional width of the panel
-     */
-    width?: string;
-    /**
-     * When open, change the URL to this path.
-     * Note that if you want to restore state from a URL you need to add the
-     * logic yourself by listening to URL updates, and probably call `open`.
-     */
-    urlPath?: string;
-    /**
-     * If the navigation stack is empty (you landed in the `urlPath` url), what
-     * url path to change to when the panel gets closed.
-     */
-    parentUrlPath?: string;
-    /**
-     * Callback when the panel is closed
-     */
-    onClose?: () => void;
-    /**
-     * Use this prop to store additional data in the panel
-     */
-    additional?: unknown;
-}

package/dist/controllers/side_panel_controller.d.ts

@@ -1,97 +0,0 @@
-import type { Entity } from "../types/entities";
-import type { CollectionConfig } from "../types/collections";
-/**
- * Props used to open a side dialog
- * @group Hooks and utilities
- */
-export interface SidePanelBindingProps<M extends Record<string, unknown> = Record<string, unknown>> {
-    /**
-     * Absolute path of the entity
-     */
-    path: string;
-    /**
-     * ID of the entity, if not set, it means we are creating a new entity
-     */
-    entityId?: string | number;
-    /**
-     * Set this flag to true if you want to make a copy of an existing entity
-     */
-    copy?: boolean;
-    /**
-     * Open the entity with a selected sub-collection view. If the panel for this
-     * entity was already open, it is replaced.
-     */
-    selectedTab?: string;
-    /**
-     * Use this prop to override the width of the form view.
-     * e.g. "600px"
-     */
-    width?: number | string;
-    /**
-     * Collection representing the entities of this view.
-     * If you leave it blank it will be induced by your navigation
-     */
-    collection?: CollectionConfig<M>;
-    /**
-     * Should update the URL when opening the dialog.
-     * Consider that if the collection that you provide is not defined in the base
-     * config of your `Rebase` component, you will not be able to recreate
-     * the state if copying the URL to a different window.
-     */
-    updateUrl?: boolean;
-    /**
-     * Callback when the entity is updated
-     * @param params
-     */
-    onUpdate?: (params: {
-        entity: Entity<M>;
-    }) => void;
-    /**
-     * Callback when the dialog is closed
-     */
-    onClose?: () => void;
-    /**
-     * Should this panel close when saving
-     */
-    closeOnSave?: boolean;
-    /**
-     * Override some form properties
-     */
-    formProps?: Record<string, unknown>;
-    /**
-     * Allow the user to open the entity fullscreen
-     */
-    allowFullScreen?: boolean;
-    /**
-     * Pre-populate the form with these values when creating a new entity.
-     * Only applied when `entityId` is not set (i.e. the form is in "new" mode).
-     * Useful for actions that fetch data from an external source (e.g. a URL)
-     * and want to pre-fill the document before the user saves.
-     */
-    defaultValues?: Partial<M>;
-}
-/**
- * Controller to open the side dialog displaying entity forms
- * @group Hooks and utilities
- */
-export interface SidePanelController {
-    /**
-     * Close the last panel
-     */
-    close: () => void;
-    /**
-     * Open a new entity sideDialog. By default, the collection and configuration
-     * of the view is fetched from the collections you have specified in the
-     * navigation.
-     * At least you need to pass the path of the entity you would like
-     * to edit. You can set a entityId if you would like to edit and existing one
-     * (or a new one with that id).
-     * @param props
-     */
-    open: <M extends Record<string, unknown> = Record<string, unknown>>(props: SidePanelBindingProps<M>) => void;
-    /**
-     * Replace the last open entity panel with the given one.
-     * @param props
-     */
-    replace: <M extends Record<string, unknown> = Record<string, unknown>>(props: SidePanelBindingProps<M>) => void;
-}

package/dist/controllers/snackbar.d.ts

@@ -1,24 +0,0 @@
-/**
- * Possible snackbar types
- * @group Hooks and utilities
- */
-export type SnackbarMessageType = "success" | "info" | "warning" | "error";
-/**
- * Controller to display snackbars
- * @group Hooks and utilities
- */
-export interface SnackbarController {
-    /**
-     * Close the currently open snackbar
-     */
-    close: () => void;
-    /**
-     * Display a new snackbar. You need to specify the type and message.
-     * You can optionally specify a title
-     */
-    open: (props: {
-        type: SnackbarMessageType;
-        message: React.ReactNode;
-        autoHideDuration?: number;
-    }) => void;
-}

package/dist/rebase_context.d.ts

@@ -1,110 +0,0 @@
-import type { AnalyticsController } from "./controllers/analytics_controller";
-import type { AuthController } from "./controllers/auth";
-import type { StorageSource } from "./controllers/storage";
-import type { UserConfigurationPersistence } from "./controllers/local_config_persistence";
-import type { DatabaseAdmin } from "./types/backend";
-import type { RebaseClient } from "./controllers/client";
-import type { RebaseSdkData } from "./controllers/data";
-import type { User } from "./users";
-/**
- * Context that is provided to entity callbacks (hooks).
- * It contains only the dependencies that are available in both the frontend and the backend.
- * @group Hooks and utilities
- */
-export type RebaseCallContext<USER extends User = User> = {
-    /**
-     * The Rebase client instance.
-     * Available in all entity callbacks (beforeSave, afterSave, afterRead,
-     * beforeDelete, afterDelete) and in CollectionActionsProps via context.
-     * Use it to call backend functions, access data, storage, etc.
-     *
-     * @example
-     * // In a beforeSave callback:
-     * const result = await context.client.functions.invoke('my-function', { ... });
-     *
-     * @example
-     * // In a CollectionAction component:
-     * const { client } = props.context;
-     * const result = await client.functions.invoke('extract-job', { url });
-     */
-    client: RebaseClient;
-    /**
-     * Unified data access — `context.data.products.create(...)`.
-     * Access any collection as a dynamic property.
-     *
-     * Returns flat rows (`{ id, ...columns }`), identical to the frontend SDK
-     * client — so `context.data` in a backend callback and `client.data` in the
-     * frontend behave the same way (`row.title`, never `row.values.title`).
-     */
-    data: RebaseSdkData;
-    /**
-     * Used storage implementation
-     */
-    storageSource: StorageSource;
-    /**
-     * Set by the backend when callbacks are executed on the server.
-     */
-    user?: USER;
-};
-/**
- * Context that includes the internal controllers and contexts used by the app.
- * Some controllers and context included in this context can be accessed
- * directly from their respective hooks.
- * @group Hooks and utilities
- * @see useRebaseContext
- */
-export type RebaseContext<USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>> = RebaseCallContext<USER> & {
-    authController: AuthControllerType;
-    /**
-     * Controller mapping strings to collections
-     */
-    collectionRegistryController?: import("./controllers/collection_registry").CollectionRegistryController;
-    /**
-     * Controller for navigation state
-     */
-    navigationStateController?: import("./controllers/navigation").NavigationStateController;
-    /**
-     * Controller for side dialogs (side sheets)
-     */
-    sideDialogsController?: import("./controllers/side_dialogs_controller").SideDialogsController;
-    /**
-     * Controller to open the side panel displaying entity forms
-     */
-    sidePanelController?: import("./controllers/side_panel_controller").SidePanelController;
-    /**
-     * Controller resolving URLs in the CMS
-     */
-    urlController?: import("./controllers/navigation").UrlController;
-    /**
-     * Controller to handle simple confirmation and alert dialogs
-     */
-    dialogsController?: import("./controllers/dialogs_controller").DialogsController;
-    /**
-     * Controller for CMS customization
-     */
-    customizationController?: import("./controllers/customization_controller").CustomizationController;
-    /**
-     * Controller for effective role
-     */
-    effectiveRoleController?: {
-        effectiveRole: string | null;
-        setEffectiveRole: (role: string | null) => void;
-    };
-    /**
-     * Use this controller to access data stored in the browser for the user
-     */
-    userConfigPersistence?: UserConfigurationPersistence;
-    /**
-     * Callback to send analytics events
-     */
-    analyticsController?: AnalyticsController;
-    /**
-     * Administrative database operations (SQL, schema discovery).
-     * Only available in developer/admin contexts.
-     */
-    databaseAdmin?: DatabaseAdmin;
-    /**
-     * Controller for snackbars
-     */
-    snackbarController?: import("./controllers/snackbar").SnackbarController;
-};

package/dist/types/breadcrumbs.d.ts

@@ -1,26 +0,0 @@
-export interface BreadcrumbEntry {
-    title: string;
-    url: string;
-    /**
-     * Optional entity count for collection breadcrumbs.
-     * - undefined: not applicable (e.g., entity breadcrumb, custom view)
-     * - null: loading
-     * - number: loaded count
-     */
-    count?: number | null;
-    /**
-     * Unique identifier for this breadcrumb (e.g., collection path).
-     * Used to update count without replacing entire breadcrumb array.
-     */
-    id?: string;
-}
-export interface BreadcrumbsController {
-    breadcrumbs: BreadcrumbEntry[];
-    set: (props: {
-        breadcrumbs: BreadcrumbEntry[];
-    }) => void;
-    /**
-     * Update the count for a specific breadcrumb by ID.
-     */
-    updateCount: (id: string, count: number | null | undefined) => void;
-}

package/dist/types/builders.d.ts

@@ -1,15 +0,0 @@
-import type { AuthController } from "../controllers/auth";
-import type { RebaseData } from "../controllers/data";
-import type { User } from "../users";
-import type { CollectionConfig } from "./collections";
-import type { AppView } from "../controllers/navigation";
-export type CollectionConfigsBuilder<EC extends CollectionConfig = CollectionConfig> = (params: {
-    user: User | null;
-    authController: AuthController;
-    data: RebaseData;
-}) => EC[] | Promise<EC[]>;
-export type AppViewsBuilder = (params: {
-    user: User | null;
-    authController: AuthController;
-    data: RebaseData;
-}) => AppView[] | Promise<AppView[]>;