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

package/dist/types/user_management_delegate.d.ts

@@ -1,22 +0,0 @@
-import type { User } from "../users";
-/**
- * Result of creating a new user via admin flow.
- * Contains the created user plus information about how credentials were delivered.
- */
-export interface UserCreationResult<USER extends User = User> {
-    /** The created user */
-    user: USER;
-    /** Whether an invitation email was sent to the user */
-    invitationSent: boolean;
-    /**
-     * Temporary password, present when no invitation email could be delivered —
-     * either because no email service is configured, or because delivery failed
-     * (see `emailDeliveryFailed`). Returned one-time, to be shared manually.
-     */
-    temporaryPassword?: string;
-    /**
-     * Whether an email service was configured but delivery failed, causing the
-     * fallback to `temporaryPassword`. Absent when no email service is configured.
-     */
-    emailDeliveryFailed?: boolean;
-}

package/src/controllers/analytics_controller.tsx

@@ -1,57 +0,0 @@
-export type AnalyticsController = {
-
-    /**
-     * Callback used to get analytics events from the CMS
-     */
-    onAnalyticsEvent?: (event: AnalyticsEvent, data?: object) => void;
-
-}
-
-export type AnalyticsEvent =
-    | "entity_click"
-    | "entity_click_from_reference"
-
-    | "reference_selection_clear"
-    | "reference_selection_toggle"
-    | "reference_selected_single"
-    | "reference_selection_new_entity"
-
-    | "edit_entity_clicked"
-    | "entity_edited"
-    | "new_entity_click"
-    | "new_entity_saved"
-    | "copy_entity_click"
-    | "entity_copied"
-
-    | "single_delete_dialog_open"
-    | "multiple_delete_dialog_open"
-    | "single_entity_deleted"
-    | "multiple_entities_deleted"
-
-    | "drawer_navigate_to_home"
-    | "drawer_navigate_to_collection"
-    | "drawer_navigate_to_view"
-
-    | "home_navigate_to_collection"
-    | "home_favorite_navigate_to_collection"
-    | "home_navigate_to_view"
-    | "home_navigate_to_admin_view"
-    | "home_favorite_navigate_to_view"
-    | "home_move_card"
-    | "home_move_group"
-    | "home_drop_new_group"
-
-    | "collection_inline_editing"
-
-    | "view_mode_changed"
-
-    | "kanban_card_moved"
-    | "kanban_column_reorder"
-    | "kanban_property_changed"
-    | "kanban_new_entity_in_column"
-    | "kanban_backfill_order"
-
-    | "card_view_entity_click"
-
-    | "unmapped_event"
-    ;

package/src/controllers/auth.tsx

@@ -1,121 +0,0 @@
-import type { User } from "../users";
-
-/**
- * Capabilities advertised by an auth provider.
- * UI components use this to show/hide features dynamically
- * (e.g. password reset, registration, session management).
- * @group Hooks and utilities
- */
-export interface AuthCapabilities {
-    emailPasswordLogin?: boolean;
-    googleLogin?: boolean;
-    registration?: boolean;
-    /** Self-service password reset (emailing a reset link) is available. */
-    passwordReset?: boolean;
-    /**
-     * An admin can reset another user's password. Gates the "Reset Password"
-     * entity action in the admin UI. See `AuthAdapterCapabilities`.
-     */
-    adminPasswordReset?: boolean;
-    sessionManagement?: boolean;
-    profileUpdate?: boolean;
-    emailVerification?: boolean;
-    /** List of enabled OAuth provider IDs (e.g. ["google", "github", "discord"]) */
-    enabledProviders?: string[];
-}
-
-/**
- * Controller for retrieving the logged user or performing auth related operations.
- * Note that if you are implementing your AuthController, you probably will want
- * to do it as the result of a hook.
- * @group Hooks and utilities
- */
-export type AuthController<USER extends User = User, ExtraData = unknown> = {
-
-    /**
-     * The user currently logged in
-     * The values can be: the user object, null if they skipped login
-     */
-    user: USER | null;
-
-    /**
-     * Initial loading flag. It is used not to display the login screen
-     * when the app first loads, and it has not been checked whether the user
-     * is logged in or not.
-     */
-    initialLoading?: boolean;
-
-    /**
-     * Loading flag. It is used to display a loading screen when the user is
-     * logging in or out.
-     */
-    authLoading: boolean;
-
-    /**
-     * Sign out
-     */
-    signOut: () => Promise<void>;
-
-    /**
-     * Error initializing the authentication
-     */
-    authError?: unknown;
-
-    /**
-     * Error dispatched by the auth provider
-     */
-    authProviderError?: unknown;
-
-    /**
-     * You can use this method to retrieve the auth token for the current user.
-     */
-    getAuthToken: () => Promise<string>;
-
-    /**
-     * Has the user skipped the login process
-     */
-    loginSkipped: boolean;
-
-    extra: ExtraData;
-
-    setExtra: (extra: ExtraData) => void;
-
-
-    setUser?(user: USER | null): void;
-
-    setUserRoles?(roles: string[]): void;
-
-    /**
-     * Capabilities advertised by the auth provider.
-     * UI components use this to feature-detect what the backend supports.
-     */
-    capabilities?: AuthCapabilities;
-
-};
-
-/**
- * Extended auth controller with common optional auth methods.
- * Backend implementations (Rebase backend, Firebase, etc.)
- * extend this with their own backend-specific extras.
- * @group Hooks and utilities
- */
-export interface AuthControllerExtended<USER extends User = User, ExtraData = unknown> extends AuthController<USER, ExtraData> {
-    /** Login with email and password */
-    emailPasswordLogin?(email: string, password: string): Promise<void>;
-    /** Login with Google — accepts an ID token, access token, or authorization code payload */
-    googleLogin?: (payload: { idToken: string } | { accessToken: string } | { code: string; redirectUri: string }) => Promise<void>;
-    /** Generic OAuth login — works with any provider. Posts payload to /auth/{providerId}. */
-    oauthLogin?: (providerId: string, payload: Record<string, unknown>) => Promise<void>;
-    /** Register a new user */
-    register?(email: string, password: string, displayName?: string): Promise<void>;
-    /** Skip login (for anonymous access if enabled) */
-    skipLogin?(): void;
-    /** Request password reset email */
-    forgotPassword?(email: string): Promise<void>;
-    /** Reset password using a token */
-    resetPassword?(token: string, password: string): Promise<void>;
-    /** Change password for the authenticated user */
-    changePassword?(oldPassword: string, newPassword: string): Promise<void>;
-    /** Update user profile */
-    updateProfile?(displayName?: string, photoURL?: string): Promise<USER>;
-}

package/src/controllers/customization_controller.tsx

@@ -1,72 +0,0 @@
-
-import type { EntityLinkBuilder } from "../types/entity_link_builder";
-import type { Locale } from "../types/locales";
-import type { EntityAction } from "../types/entity_actions";
-import type { EntityCustomView } from "../types/entity_views";
-import type { RebasePlugin } from "../types/plugins";
-import type { PropertyConfig } from "../types/property_config";
-import type { SlotContribution } from "../types/slots";
-import type { ComponentOverrideMap } from "../types/component_overrides";
-
-export type CustomizationController = {
-
-    /**
-     * Builder for generating utility links for entities
-     */
-    entityLinkBuilder?: EntityLinkBuilder;
-
-    /**
-     * Use plugins to modify the behaviour of the CMS.
-     */
-    plugins?: RebasePlugin[];
-
-    /**
-     * Pre-merged slots from plugins + direct slot contributions.
-     */
-    resolvedSlots: SlotContribution[];
-
-    /**
-     * List of additional custom views for entities.
-     * You can use the key to reference the custom view in
-     * the `entityViews` prop of a collection.
-     *
-     * You can also define a entity view from the UI.
-     */
-    entityViews?: EntityCustomView[];
-
-    /**
-     * List of actions that can be performed on entities.
-     * These actions are displayed in the entity view and in the collection view.
-     * You can later reuse these actions in the `entityActions` prop of a collection,
-     * by specifying the `key` of the action.
-     */
-    entityActions?: EntityAction[];
-
-    /**
-     * 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;
-
-    /**
-     * Record of custom form fields to be used in the CMS.
-     * You can use the key to reference the custom field in
-     * the `propertyConfig` prop of a property in a collection.
-     */
-    propertyConfigs: Record<string, PropertyConfig>;
-
-    /**
-     * Global component overrides. Keys are component names from
-     * {@link OverridableComponentName}. Values replace the default
-     * implementation everywhere in the app.
-     *
-     * Collection-scoped overrides (set on individual collections)
-     * take precedence over global overrides.
-     */
-    components?: ComponentOverrideMap;
-}

package/src/controllers/dialogs_controller.tsx

@@ -1,37 +0,0 @@
-import React from "react";
-
-/**
- * Controller to open the side dialog
- * @group Hooks and utilities
- */
-export interface DialogsController {
-
-    /**
-     * Close the last dialog
-     */
-    close: () => void;
-
-    /**
-     * Open a dialog
-     * @param props
-     */
-    open: <T extends object = object>(props: DialogControllerEntryProps<T>) => { closeDialog: () => void };
-}
-
-/**
- * Props used to open a side dialog
- * @group Hooks and utilities
- */
-export interface DialogControllerEntryProps<T extends object = object> {
-
-    key: string;
-    /**
-     * The component type that will be rendered
-     */
-    Component: React.ComponentType<{ open: boolean, closeDialog: () => void } & T>;
-    /**
-     * Props to pass to the dialog component
-     */
-    props?: T;
-
-}

package/src/controllers/local_config_persistence.tsx

@@ -1,22 +0,0 @@
-import type { CollectionConfig } from "../types/collections";
-
-/**
- * @group Models
- */
-export type PartialCollectionConfig<M extends Record<string, unknown> = Record<string, unknown>> = Partial<CollectionConfig<M>>;
-
-/**
- * This interface is in charge of defining the controller that persists
- * modifications to a collection or collection, and retrieves them back from
- * a data source, such as local storage or Firestore.
- */
-export interface UserConfigurationPersistence {
-    onCollectionModified: <M extends Record<string, unknown> = Record<string, unknown>>(path: string, partialCollection: PartialCollectionConfig<M>) => void;
-    getCollectionConfig: <M extends Record<string, unknown> = Record<string, unknown>>(path: string) => PartialCollectionConfig<M>;
-    recentlyVisitedPaths: string[];
-    setRecentlyVisitedPaths: (paths: string[]) => void;
-    favouritePaths: string[];
-    setFavouritePaths: (paths: string[]) => void;
-    collapsedGroups: string[];
-    setCollapsedGroups: (paths: string[]) => void;
-}

package/src/controllers/navigation.ts

@@ -1,267 +0,0 @@
-import React from "react";
-import type { EntityReference } from "../types/entities";
-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/src/controllers/registry.ts

@@ -1,95 +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 {
-    // Current state
-    cmsConfig: RebaseAdminConfig | null;
-    studioConfig: RebaseStudioConfig | null;
-    authConfig: RebaseAuthConfig | null;
-
-    // Registration functions
-    registerCMS: (config: RebaseAdminConfig) => void;
-    unregisterCMS: () => void;
-
-    registerStudio: (config: RebaseStudioConfig) => void;
-    unregisterStudio: () => void;
-
-    registerAuth: (config: RebaseAuthConfig) => void;
-    unregisterAuth: () => void;
-}