@rebasepro/sdk-generator 0.0.1-canary.4d4fb3e

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

@@ -0,0 +1,58 @@
+import { User } from "../users";
+import { RebaseData } from "./data";
+/**
+ * Event type for authentication state changes
+ */
+export type AuthChangeEvent = 'SIGNED_IN' | 'SIGNED_OUT' | 'TOKEN_REFRESHED' | 'USER_UPDATED';
+/**
+ * Standard session interface representing an authenticated state
+ */
+export interface RebaseSession {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: number;
+    user: User;
+}
+import { StorageSource } from "./storage";
+/**
+ * Unified Authentication Client Interface
+ * Pure functional SDK interface, decoupled from UI and React hooks
+ */
+export interface AuthClient {
+    /**
+     * Get the current user from the server or cache
+     */
+    getUser(): Promise<User | null>;
+    /**
+     * Get the currently active session
+     */
+    getSession(): RebaseSession | null;
+    /**
+     * Sign out the current user and clear local session
+     */
+    signOut(): Promise<void>;
+    /**
+     * Subscribe to authentication state changes
+     */
+    onAuthStateChange(callback: (event: AuthChangeEvent, session: RebaseSession | null) => void): () => void;
+    /**
+     * Manually refresh the session token
+     */
+    refreshSession(): Promise<RebaseSession>;
+    [key: string]: any;
+}
+/**
+ * Overarching abstraction that unites Data, Auth, and Storage.
+ * Adapters for Supabase or Firebase simply need to implement this interface.
+ */
+export interface RebaseClient<DB = any> {
+    /** Unified Data access layer */
+    data: RebaseData;
+    /** Unified Authentication layer */
+    auth: AuthClient;
+    /** Unified Storage layer */
+    storage?: StorageSource;
+    /** Optional admin panel specific tasks */
+    admin?: any;
+    [key: string]: any;
+}

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

@@ -0,0 +1,44 @@
+import { EntityCollection, EntityReference } from "../types";
+/**
+ * Controller that provides access to the registered entity collections.
+ * @group Models
+ */
+export type CollectionRegistryController<EC extends EntityCollection = EntityCollection<any>> = {
+    /**
+     * List of the mapped collections in the CMS.
+     * Each entry relates to a collection in the root database.
+     * Each of the navigation entries in this field
+     * generates an entry in the main menu.
+     */
+    collections?: EntityCollection[];
+    /**
+     * Is the registry ready to be used
+     */
+    initialised: boolean;
+    /**
+     * Get the collection configuration for a given path.
+     * The collection is resolved from the given path or alias.
+     */
+    getCollection: (slugOrPath: string, includeUserOverride?: boolean) => EC | undefined;
+    /**
+     * Get the raw, un-normalized collection configuration.
+     * This bypasses the `CollectionRegistry` normalization (such as injecting `relation` instances).
+     * This is strictly for the Visual Editor to manipulate AST code without persisting runtime state.
+     */
+    getRawCollection: (slugOrPath: string) => EC | undefined;
+    /**
+     * Retrieve all the related parent references for a given path
+     * @param path
+     */
+    getParentReferencesFromPath: (path: string) => EntityReference[];
+    /**
+     * Retrieve all the related parent collection ids for a given path
+     * @param path
+     */
+    getParentCollectionIds: (path: string) => string[];
+    /**
+     * Resolve paths from a list of ids
+     * @param ids
+     */
+    convertIdsToPaths: (ids: string[]) => string[];
+};

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

@@ -0,0 +1,54 @@
+import React from "react";
+import { EntityLinkBuilder, Locale, EntityAction, EntityCustomView, RebasePlugin, PropertyConfig, SlotContribution } from "../types";
+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 an 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>;
+    components?: {
+        /**
+         * Component to render when a reference is missing
+         */
+        missingReference?: React.ComponentType<{
+            path: string;
+        }>;
+    };
+};

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

@@ -0,0 +1,141 @@
+import { Entity, EntityValues } from "../types/entities";
+/**
+ * Parameters for querying a collection.
+ * Uses PostgREST-style filter syntax for consistency between
+ * the SDK (HTTP) and framework (in-process) contexts.
+ *
+ * @group Data
+ */
+export interface FindParams {
+    /** Maximum number of items to return (default: 20) */
+    limit?: number;
+    /** Number of items to skip */
+    offset?: number;
+    /** Page number (1-indexed), alternative to offset */
+    page?: number;
+    /**
+     * PostgREST-style filter object.
+     * Keys are field names, values use "operator.value" format.
+     * Operators: eq, neq, gt, gte, lt, lte, in, nin, cs (array-contains), csa (array-contains-any)
+     *
+     * @example
+     * { status: "eq.published" }
+     * { age: "gte.18" }
+     * { role: "in.(admin,editor)" }
+     */
+    where?: Record<string, string>;
+    /**
+     * Sort order. Format: "field:direction".
+     * @example "created_at:desc", "name:asc"
+     */
+    orderBy?: string;
+    /** Relations to include in the response */
+    include?: string[];
+    /** Full-text search string */
+    searchString?: string;
+}
+/**
+ * Paginated response from a collection query.
+ * @group Data
+ */
+export interface FindResponse<M extends Record<string, any> = any> {
+    /** Array of entities matching the query */
+    data: Entity<M>[];
+    /** Pagination metadata */
+    meta: {
+        total: number;
+        limit: number;
+        offset: number;
+        hasMore: boolean;
+    };
+}
+/**
+ * A single collection's CRUD accessor.
+ *
+ * This is the unified API surface used in both:
+ * - The generated SDK (`client.data.products.create(...)`)
+ * - Framework callbacks (`context.data.products.create(...)`)
+ *
+ * @group Data
+ */
+export interface CollectionAccessor<M extends Record<string, any> = any> {
+    /**
+     * Find multiple records with optional filtering, pagination, and sorting.
+     */
+    find(params?: FindParams): Promise<FindResponse<M>>;
+    /**
+     * Find a single record by its ID.
+     */
+    findById(id: string | number): Promise<Entity<M> | undefined>;
+    /**
+     * Create a new record.
+     * @param data The entity data to create.
+     * @param id Optional specific ID to use for the new record.
+     * @returns The created entity
+     */
+    create(data: Partial<EntityValues<M>>, id?: string | number): Promise<Entity<M>>;
+    /**
+     * Update an existing record by ID.
+     * @returns The updated entity
+     */
+    update(id: string | number, data: Partial<EntityValues<M>>): Promise<Entity<M>>;
+    /**
+     * Delete a record by ID.
+     */
+    delete(id: string | number): Promise<void>;
+    /**
+     * Subscribe to a collection for real-time updates.
+     * Optional method, may not be supported by all implementations (like stateless HTTP clients).
+     */
+    listen?(params: FindParams | undefined, onUpdate: (response: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Subscribe to a single record for real-time updates.
+     * Optional method.
+     */
+    listenById?(id: string | number, onUpdate: (entity: Entity<M> | undefined) => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Count the number of records matching the given filter.
+     */
+    count?(params?: FindParams): Promise<number>;
+}
+/**
+ * The unified data access object.
+ *
+ * Access collections as dynamic properties: `data.products.find(...)`.
+ * In the SDK this is backed by HTTP transport (typed, generated per-project).
+ * In the framework this is backed by a Proxy + in-process database driver (dynamic).
+ *
+ * @example
+ * // SDK
+ * const client = createRebaseClient({ baseUrl: "..." });
+ * await client.data.products.create({ name: "Camera", price: 299 });
+ *
+ * // Framework callback
+ * callbacks: {
+ *   afterSave({ context }) {
+ *     await context.data.logs.create({ action: "saved", timestamp: new Date() });
+ *   }
+ * }
+ *
+ * @group Data
+ */
+export interface RebaseData {
+    /**
+     * Get a collection accessor by slug.
+     * Alternative to dynamic property access for cases where
+     * the collection name is a variable.
+     *
+     * @example
+     * const accessor = data.collection("products");
+     * await accessor.find({ limit: 10 });
+     */
+    collection(slug: string): CollectionAccessor;
+    /**
+     * Dynamic collection accessor.
+     * Access any collection by its slug as a property.
+     *
+     * @example
+     * data.products.find({ where: { status: "eq.published" } })
+     */
+    [collectionSlug: string]: CollectionAccessor | ((slug: string) => CollectionAccessor);
+}

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

@@ -0,0 +1,168 @@
+import { Entity, EntityCollection, EntityStatus, EntityValues, FilterValues } from "../types";
+import { RebaseContext } from "../rebase_context";
+import { TableMetadata } from "../types/websockets";
+/**
+ * @internal
+ */
+export interface FetchEntityProps<M extends Record<string, any> = any> {
+    path: string;
+    entityId: string | number;
+    databaseId?: string;
+    collection?: EntityCollection<M, any>;
+}
+/**
+ * @internal
+ */
+export type ListenEntityProps<M extends Record<string, any> = any> = FetchEntityProps<M> & {
+    onUpdate: (entity: Entity<M> | null) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @internal
+ */
+export interface FetchCollectionProps<M extends Record<string, any> = any> {
+    path: string;
+    collection?: EntityCollection<M>;
+    filter?: FilterValues<Extract<keyof M, string>>;
+    limit?: number;
+    startAfter?: unknown;
+    orderBy?: string;
+    searchString?: string;
+    order?: "desc" | "asc";
+}
+/**
+ * @internal
+ */
+export type ListenCollectionProps<M extends Record<string, any> = any> = FetchCollectionProps<M> & {
+    onUpdate: (entities: Entity<M>[]) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @internal
+ */
+export interface SaveEntityProps<M extends Record<string, any> = any> {
+    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, any> = any> {
+    entity: Entity<M>;
+    collection?: EntityCollection<M>;
+}
+export type FilterCombinationValidProps = {
+    path: string;
+    databaseId?: string;
+    collection: EntityCollection<any>;
+    filterValues: FilterValues<any>;
+    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, any> = any>(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, any> = any>(props: ListenCollectionProps<M>): () => void;
+    /**
+     * Retrieve an entity given a path and a collection
+     * @param props
+     */
+    fetchEntity<M extends Record<string, any> = any>(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, any> = any>(props: ListenEntityProps<M>): () => void;
+    /**
+     * Save entity to the specified path
+     * @param props
+     */
+    saveEntity<M extends Record<string, any> = any>(props: SaveEntityProps<M>): Promise<Entity<M>>;
+    /**
+     * Delete an entity
+     * @param props
+     * @return was the whole deletion flow successful
+     */
+    deleteEntity<M extends Record<string, any> = any>(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, any> = any>(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;
+    executeSql?(sql: string, options?: {
+        database?: string;
+        role?: string;
+    }): Promise<Record<string, unknown>[]>;
+    fetchAvailableDatabases?(): Promise<string[]>;
+    fetchAvailableRoles?(): Promise<string[]>;
+    fetchCurrentDatabase?(): Promise<string | undefined>;
+    fetchUnmappedTables?(mappedPaths?: string[]): Promise<string[]>;
+    fetchTableMetadata?(tableName: string): Promise<TableMetadata>;
+}

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/index.d.ts

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