@rebasepro/sdk-generator 0.0.1-canary.09e5ec5

package/dist/types/src/controllers/data_driver.d.ts

@@ -0,0 +1,160 @@
+import type { Entity, EntityStatus, EntityValues } from "../types/entities";
+import type { EntityCollection, FilterValues } from "../types/collections";
+import type { RebaseContext } from "../rebase_context";
+/**
+ * @internal
+ */
+export interface FetchEntityProps<M extends Record<string, unknown> = Record<string, unknown>> {
+    path: string;
+    entityId: string | number;
+    databaseId?: string;
+    collection?: EntityCollection<M>;
+}
+/**
+ * @internal
+ */
+export type ListenEntityProps<M extends Record<string, unknown> = Record<string, unknown>> = FetchEntityProps<M> & {
+    onUpdate: (entity: Entity<M> | null) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @internal
+ */
+export interface FetchCollectionProps<M extends Record<string, unknown> = Record<string, unknown>> {
+    path: string;
+    collection?: EntityCollection<M>;
+    filter?: FilterValues<Extract<keyof M, string>>;
+    limit?: number;
+    offset?: number;
+    startAfter?: unknown;
+    orderBy?: string;
+    searchString?: string;
+    order?: "desc" | "asc";
+}
+/**
+ * @internal
+ */
+export type ListenCollectionProps<M extends Record<string, unknown> = Record<string, unknown>> = FetchCollectionProps<M> & {
+    onUpdate: (entities: Entity<M>[]) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @internal
+ */
+export interface SaveEntityProps<M extends Record<string, unknown> = Record<string, unknown>> {
+    path: string;
+    values: Partial<EntityValues<M>>;
+    entityId?: string | number;
+    previousValues?: Partial<EntityValues<M>>;
+    collection?: EntityCollection<M>;
+    status: EntityStatus;
+}
+/**
+ * @internal
+ */
+export interface DeleteEntityProps<M extends Record<string, unknown> = Record<string, unknown>> {
+    entity: Entity<M>;
+    collection?: EntityCollection<M>;
+}
+export type FilterCombinationValidProps = {
+    path: string;
+    databaseId?: string;
+    collection: EntityCollection;
+    filterValues: FilterValues<string>;
+    sortBy?: [string, "asc" | "desc"];
+};
+/**
+ * Internal driver interface for communicating with the data layer.
+ * This is NOT the public API — use `RebaseData` / `context.data` instead.
+ * @internal
+ */
+export interface DataDriver {
+    /**
+     * Key that identifies this driver
+     */
+    key?: string;
+    /**
+     * If the driver has been initialised
+     */
+    initialised?: boolean;
+    /**
+     * Fetch data from a collection
+     * @param props
+     * @return Promise of entities
+     */
+    fetchCollection<M extends Record<string, unknown> = Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<Entity<M>[]>;
+    /**
+     * Listen to a collection in a given path. If you don't implement this method
+     * `fetchCollection` will be used instead, with no real time updates.
+     * @param props
+     * @return Function to cancel subscription
+     */
+    listenCollection?<M extends Record<string, unknown> = Record<string, unknown>>(props: ListenCollectionProps<M>): () => void;
+    /**
+     * Retrieve an entity given a path and a collection
+     * @param props
+     */
+    fetchEntity<M extends Record<string, unknown> = Record<string, unknown>>(props: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
+    /**
+     * Get realtime updates on one entity.
+     * @param props
+     * @return Function to cancel subscription
+     */
+    listenEntity?<M extends Record<string, unknown> = Record<string, unknown>>(props: ListenEntityProps<M>): () => void;
+    /**
+     * Save entity to the specified path
+     * @param props
+     */
+    saveEntity<M extends Record<string, unknown> = Record<string, unknown>>(props: SaveEntityProps<M>): Promise<Entity<M>>;
+    /**
+     * Delete an entity
+     * @param props
+     * @return was the whole deletion flow successful
+     */
+    deleteEntity<M extends Record<string, unknown> = Record<string, unknown>>(props: DeleteEntityProps<M>): Promise<void>;
+    /**
+     * Check if the given property is unique in the given collection
+     * @param path Collection path
+     * @param name of the property
+     * @param value
+     * @param entityId
+     * @param collection
+     * @return `true` if there are no other fields besides the given entity
+     */
+    checkUniqueField(path: string, name: string, value: unknown, entityId?: string | number, collection?: EntityCollection): Promise<boolean>;
+    /**
+     * Count the number of entities in a collection
+     */
+    countEntities?<M extends Record<string, unknown> = Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<number>;
+    /**
+     * Check if the given filter combination is valid
+     * @param props
+     */
+    isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection"> & {
+        databaseId?: string;
+    }): boolean;
+    /**
+     * Get the object to generate the current time in the driver
+     */
+    currentTime?: () => unknown;
+    delegateToCMSModel?: (data: unknown) => unknown;
+    cmsToDelegateModel?: (data: unknown) => unknown;
+    initTextSearch?: (props: {
+        context: RebaseContext;
+        path: string;
+        databaseId?: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
+    /**
+     * Flag to indicate if the driver has requested the initialization of the text search index
+     */
+    needsInitTextSearch?: boolean;
+    /**
+     * Return the admin capabilities of this driver.
+     * @see SQLAdmin
+     * @see DocumentAdmin
+     * @see SchemaAdmin
+     */
+    admin?: import("../types/backend").DatabaseAdmin;
+}

package/dist/types/src/controllers/database_admin.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module database_admin
+ *
+ * Re-exports the capability-specific admin interfaces from `@rebasepro/types/backend`.
+ * This file is kept for backwards compatibility — new code should import from
+ * `@rebasepro/types` directly.
+ *
+ * @group Admin
+ */
+export type { SQLAdmin, DocumentAdmin, SchemaAdmin, DatabaseAdmin, HealthCheckResult } from "../types/backend";
+export { isSQLAdmin, isDocumentAdmin, isSchemaAdmin } from "../types/backend";

package/dist/types/src/controllers/dialogs_controller.d.ts

@@ -0,0 +1,36 @@
+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/dist/types/src/controllers/effective_role.d.ts

@@ -0,0 +1,4 @@
+export interface EffectiveRoleController {
+    effectiveRole: string | null;
+    setEffectiveRole: (role: string | null) => void;
+}

package/dist/types/src/controllers/email.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Email service types — portable interface shared by RebaseClient and server-core.
+ *
+ * The concrete SMTP implementation lives in `@rebasepro/server-core/email`.
+ * This file provides only the consumer-facing contract so that it can be
+ * referenced from `RebaseClient` without dragging in nodemailer.
+ */
+/**
+ * Options for sending an email via the Rebase email service.
+ */
+export interface EmailSendOptions {
+    /** Recipient email address(es). */
+    to: string | string[];
+    /** Email subject line. */
+    subject: string;
+    /** HTML body content. */
+    html: string;
+    /** Optional plain-text fallback. */
+    text?: string;
+    /** Optional reply-to address. */
+    replyTo?: string;
+}
+/**
+ * Abstraction over an email delivery backend.
+ *
+ * Implementations may use SMTP, AWS SES, Resend, Postmark, or any other
+ * provider — consumers only interact through this interface.
+ */
+export interface EmailService {
+    /** Send a single email. */
+    send(options: EmailSendOptions): Promise<void>;
+    /** Returns `true` when the service has valid credentials / is ready to send. */
+    isConfigured(): boolean;
+}

package/dist/types/src/controllers/index.d.ts

@@ -0,0 +1,18 @@
+export * from "./collection_registry";
+export * from "./analytics_controller";
+export * from "./auth";
+export * from "./data";
+export * from "./database_admin";
+export * from "./data_driver";
+export * from "./local_config_persistence";
+export * from "./navigation";
+export * from "./effective_role";
+export * from "./storage";
+export * from "./email";
+export * from "./client";
+export * from "./customization_controller";
+export * from "./side_entity_controller";
+export * from "./side_dialogs_controller";
+export * from "./dialogs_controller";
+export * from "./snackbar";
+export * from "./registry";

package/dist/types/src/controllers/local_config_persistence.d.ts

@@ -0,0 +1,20 @@
+import type { EntityCollection } from "../types/collections";
+/**
+ * @group Models
+ */
+export type PartialEntityCollection<M extends Record<string, unknown> = Record<string, unknown>> = Partial<EntityCollection<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: PartialEntityCollection<M>) => void;
+    getCollectionConfig: <M extends Record<string, unknown> = Record<string, unknown>>(path: string) => PartialEntityCollection<M>;
+    recentlyVisitedPaths: string[];
+    setRecentlyVisitedPaths: (paths: string[]) => void;
+    favouritePaths: string[];
+    setFavouritePaths: (paths: string[]) => void;
+    collapsedGroups: string[];
+    setCollapsedGroups: (paths: string[]) => void;
+}

package/dist/types/src/controllers/navigation.d.ts

@@ -0,0 +1,213 @@
+import React from "react";
+import type { EntityCollection } from "../types/collections";
+import type { RebasePlugin } from "../types/plugins";
+/**
+ * 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?: unknown;
+    /**
+     * Call this method to recalculate the navigation
+     */
+    refreshNavigation: () => void;
+    /**
+     * Plugin system allowing to extend the CMS functionality.
+     */
+    plugins?: RebasePlugin[];
+};
+export interface NavigateOptions {
+    replace?: boolean;
+    state?: unknown;
+    preventScrollReset?: boolean;
+    relative?: "route" | "path";
+    flushSync?: boolean;
+    viewTransition?: boolean;
+}
+export type NavigationBlocker = {
+    updateBlockListener: (path: string, block: boolean, basePath?: string) => () => void;
+    isBlocked: (path: string) => boolean;
+    proceed?: () => void;
+    reset?: () => void;
+};
+/**
+ * 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;
+    /**
+     * Component to be rendered. This can be any React component, and can use
+     * any of the provided hooks
+     */
+    view: React.ReactNode;
+    /**
+     * Optional field used to group top level navigation entries under a
+     * navigation view.
+     * This prop is ignored for admin views.
+     */
+    group?: string;
+    /**
+     * If true, a wildcard route (slug/*) is automatically registered
+     * alongside the base route, enabling nested navigation within this view.
+     */
+    nestedRoutes?: boolean;
+}
+/**
+ * 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[];
+}
+export interface NavigationEntry {
+    id: string;
+    url: string;
+    name: string;
+    slug: string;
+    type: "collection" | "view" | "admin";
+    collection?: EntityCollection;
+    view?: AppView;
+    description?: string;
+    group: string;
+}
+export type NavigationResult = {
+    allowDragAndDrop: boolean;
+    navigationEntries: NavigationEntry[];
+    groups: string[];
+    onNavigationEntriesUpdate: (entries: NavigationGroupMapping[]) => void;
+};

package/dist/types/src/controllers/registry.d.ts

@@ -0,0 +1,54 @@
+import { ReactNode } from "react";
+import type { EntityCollection } from "../types/collections";
+import type { EntityCollectionsBuilder } from "../types/builders";
+import type { EntityCustomView } from "../types/entity_views";
+import type { EntityAction } from "../types/entity_actions";
+import type { AppView } from "./navigation";
+/**
+ * Options to enable the built-in collection editor.
+ * When provided to `<RebaseCMS>`, 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 RebaseCMSConfig<EC extends EntityCollection = any> {
+    collections?: EC[] | EntityCollectionsBuilder<EC>;
+    homePage?: ReactNode;
+    entityViews?: EntityCustomView<any>[];
+    entityActions?: EntityAction[];
+    plugins?: any[];
+    /**
+     * 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;
+}
+export interface RebaseStudioConfig {
+    tools?: ("sql" | "js" | "rls" | "schema" | "storage" | "cron" | "schema-visualizer" | "branches" | "api")[];
+    homePage?: ReactNode;
+    devViews?: AppView[];
+}
+export interface RebaseAuthConfig {
+    loginView?: ReactNode;
+}
+export interface RebaseRegistryController {
+    cmsConfig: RebaseCMSConfig | null;
+    studioConfig: RebaseStudioConfig | null;
+    authConfig: RebaseAuthConfig | null;
+    registerCMS: (config: RebaseCMSConfig) => void;
+    unregisterCMS: () => void;
+    registerStudio: (config: RebaseStudioConfig) => void;
+    unregisterStudio: () => void;
+    registerAuth: (config: RebaseAuthConfig) => void;
+    unregisterAuth: () => void;
+}

package/dist/types/src/controllers/side_dialogs_controller.d.ts

@@ -0,0 +1,67 @@
+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;
+}