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

package/src/controllers/side_dialogs_controller.tsx

@@ -1,82 +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/src/controllers/side_panel_controller.tsx

@@ -1,112 +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/src/controllers/snackbar.ts

@@ -1,29 +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/src/rebase_context.tsx

@@ -1,130 +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/src/types/breadcrumbs.ts

@@ -1,27 +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/src/types/builders.ts

@@ -1,17 +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[]>;

package/src/types/component_overrides.ts

@@ -1,244 +0,0 @@
-import type React from "react";
-import type { Property } from "./properties";
-import type { WhereFilterOp } from "./filter-operators";
-
-// ── Scoped component name unions ──────────────────────────────────────
-
-/**
- * Components that can only be overridden at the **app level** via the
- * `components` prop on `<Rebase>`.
- *
- * These are shell-level / global components that exist outside of any
- * specific collection context.
- *
- * @group Component Overrides
- */
-export type AppComponentName =
-    // ── Shell / Layout ──
-    | "Shell.AppBar"
-    | "Shell.Drawer"
-    | "Shell.DrawerNavigationItem"
-    | "Shell.DrawerNavigationGroup"
-
-    // ── Home Page ──
-    | "HomePage"
-    | "HomePage.CollectionCard"
-
-    // ── Auth ──
-    | "Auth.LoginView";
-
-/**
- * Components that can be overridden at the **collection level**
- * (on an individual collection definition) or at the **app level**
- * (as a default for all collections).
- *
- * When set at the app level, these act as defaults. When set on a
- * specific collection, they override the app-level default for that
- * collection only.
- *
- * @group Component Overrides
- */
-export type CollectionComponentName =
-    // ── Collection View ──
-    | "Collection.View"
-    | "Collection.Table"
-    | "Collection.Card"
-    | "Collection.EmptyState"
-    | "Collection.Actions"
-    | "Collection.FilterField"
-
-    // ── Entity / Form ──
-    | "Entity.Form"
-    | "EditView.FormActions"
-    | "DetailView"
-    | "Entity.SidePanel"
-    | "EntityPreview"
-    | "Entity.MissingReference";
-
-/**
- * All overridable component names across all scopes.
- * @group Component Overrides
- */
-export type OverridableComponentName = AppComponentName | CollectionComponentName;
-
-/**
- * Props received by a filter field component — whether it is a built-in
- * per-type field, a property-level replacement (`property.ui.Filter`), or a
- * `"Collection.FilterField"` override.
- *
- * The `operators` list is **already resolved**: it is the intersection of the
- * engine's {@link DataSourceCapabilities.filterOperators}, the property-type
- * defaults, and any `property.ui.filterOperators` narrowing. A custom field
- * should only offer operators from this list — anything else may throw at
- * query time on engines that cannot execute it.
- *
- * @example
- * ```tsx
- * function MyStatusFilter({ value, setValue, operators }: FilterFieldBindingProps) {
- *     return (
- *         <select
- *             value={value?.[1] as string ?? ""}
- *             onChange={e => setValue(e.target.value ? ["==", e.target.value] : undefined)}>
- *             <option value="">Any</option>
- *             <option value="active">Active</option>
- *             <option value="archived">Archived</option>
- *         </select>
- *     );
- * }
- * ```
- *
- * @group Component Overrides
- */
-export interface FilterFieldBindingProps {
-    /** Key of the property being filtered (the column id). */
-    propertyKey: string;
-
-    /**
-     * The resolved property. For array properties this is the **item**
-     * property (`property.of`), with `isArray` set to true.
-     */
-    property: Property;
-
-    /** True when the underlying property is an array of `property`. */
-    isArray: boolean;
-
-    /**
-     * Operators this field may offer, already narrowed by engine
-     * capabilities, property-type defaults, and `property.ui.filterOperators`.
-     */
-    operators: readonly WhereFilterOp[];
-
-    /** Current filter condition for this property, if any. */
-    value?: [WhereFilterOp, unknown];
-
-    /** Set (or clear, with `undefined`) the filter condition. */
-    setValue: (value?: [WhereFilterOp, unknown]) => void;
-
-    /** Display title for the field (usually the property name). */
-    title?: string;
-
-    /**
-     * Coordination flags used by fields that open their own dialogs
-     * (e.g. the reference picker hides the parent filters dialog).
-     */
-    hidden?: boolean;
-    setHidden?: (hidden: boolean) => void;
-}
-
-// ── Override entry ────────────────────────────────────────────────────
-
-/**
- * A single component override entry.
- *
- * - **Eject mode** (default): Your component fully replaces the built-in one.
- *   It receives the same props as the original.
- *
- * - **Wrap mode** (`wrap: true`): Your component wraps the original. The
- *   built-in component is passed as `OriginalComponent` in props, so you can
- *   render it inside your custom layout/logic.
- *
- * @example
- * ```tsx
- * // Eject — full replacement
- * { Component: MyCustomAppBar }
- *
- * // Wrap — augment the original
- * {
- *     Component: ({ OriginalComponent, ...props }) => (
- *         <div>
- *             <MyBanner />
- *             <OriginalComponent {...props} />
- *         </div>
- *     ),
- *     wrap: true
- * }
- * ```
- *
- * @group Component Overrides
- */
-export interface ComponentOverride<P = Record<string, unknown>> {
-    /**
-     * The replacement component. Receives the same props as the built-in
-     * component it replaces.
-     *
-     * When `wrap` is true, an additional `OriginalComponent` prop is injected
-     * containing the default component, allowing you to render it within
-     * your custom wrapper.
-     */
-    Component: React.ComponentType<P>;
-
-    /**
-     * When true, the original default component is injected as the
-     * `OriginalComponent` prop into your Component, enabling the
-     * wrapping pattern (similar to Docusaurus's `--wrap` swizzle mode).
-     *
-     * When false or omitted, your component fully replaces the default
-     * (similar to Docusaurus's `--eject` swizzle mode).
-     *
-     * @default false
-     */
-    wrap?: boolean;
-}
-
-// ── Override maps by scope ────────────────────────────────────────────
-
-/**
- * Collection-scoped overrides. Only collection-level components
- * can be overridden here.
- *
- * Set on a collection's `components` field to customize
- * components for that specific collection.
- *
- * @example
- * ```tsx
- * const productsCollection = {
- *     name: "Products",
- *     slug: "products",
- *     components: {
- *         "Entity.Form": { Component: ProductForm },
- *         "Collection.EmptyState": { Component: ProductsEmptyState },
- *         "Collection.Card": { Component: ProductCard },
- *     }
- * };
- * ```
- *
- * @group Component Overrides
- */
-export type CollectionComponentOverrideMap = {
-    [K in CollectionComponentName]?: ComponentOverride;
-};
-
-/**
- * App-level overrides. Includes both app-only components (Shell, HomePage, Auth)
- * and collection-level components (as defaults for all collections).
- *
- * Pass this to the `components` prop on `<Rebase>`.
- *
- * Collection-level components set here act as **defaults** — they apply to all
- * collections unless a specific collection overrides them in its own
- * `components`.
- *
- * @example
- * ```tsx
- * <Rebase
- *     client={client}
- *     components={{
- *         // App-level: only available here
- *         "Shell.AppBar": { Component: MyAppBar },
- *         "HomePage": { Component: MyDashboard },
- *
- *         // Collection defaults: apply to ALL collections
- *         "EditView.FormActions": {
- *             Component: MyFormActions,
- *             wrap: true
- *         },
- *         "Collection.EmptyState": { Component: MyEmptyState },
- *     }}
- * />
- * ```
- *
- * @group Component Overrides
- */
-export type ComponentOverrideMap = {
-    [K in OverridableComponentName]?: ComponentOverride;
-};