@rebasepro/studio 0.4.0 → 0.6.0

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

@@ -1,168 +0,0 @@
-import type { User } from "../users";
-import type { RebaseData } from "./data";
-import type { EmailService } from "./email";
-/**
- * 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 type { 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>;
-}
-/**
- * User record as returned by the Admin API.
- * @group Admin
- */
-export interface AdminUser {
-    uid: string;
-    email: string;
-    displayName: string | null;
-    photoURL: string | null;
-    provider: string;
-    roles: string[];
-    metadata?: Record<string, any>;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Client-side Admin API interface.
- * Provides user management operations.
- * @group Admin
- */
-export interface AdminAPI {
-    listUsers(): Promise<{
-        users: AdminUser[];
-    }>;
-    listUsersPaginated(options?: {
-        search?: string;
-        limit?: number;
-        offset?: number;
-        orderBy?: string;
-        orderDir?: "asc" | "desc";
-    }): Promise<{
-        users: AdminUser[];
-        total: number;
-        limit: number;
-        offset: number;
-    }>;
-    getUser(userId: string): Promise<{
-        user: AdminUser;
-    }>;
-    createUser(data: {
-        email: string;
-        displayName?: string;
-        password?: string;
-        roles?: string[];
-        metadata?: Record<string, any>;
-    }): Promise<{
-        user: AdminUser;
-    }>;
-    updateUser(userId: string, data: {
-        email?: string;
-        displayName?: string;
-        password?: string;
-        roles?: string[];
-        metadata?: Record<string, any>;
-    }): Promise<{
-        user: AdminUser;
-    }>;
-    deleteUser(userId: string): Promise<{
-        success: boolean;
-    }>;
-    bootstrap(): Promise<{
-        success: boolean;
-        message: string;
-        user: {
-            uid: string;
-            roles: string[];
-        };
-    }>;
-}
-/**
- * Overarching abstraction that unites Data, Auth, Storage, and Email.
- * Adapters for Supabase or Firebase simply need to implement this interface.
- */
-export interface RebaseClient<DB = unknown> {
-    /** Unified Data access layer */
-    data: RebaseData;
-    /** Unified Authentication layer */
-    auth: AuthClient;
-    /** Unified Storage layer */
-    storage?: StorageSource;
-    /**
-     * Server-side email service.
-     *
-     * Available when SMTP (or a custom `sendEmail` function) is configured
-     * in the backend auth config. `undefined` when email is not configured.
-     *
-     * > **Note:** This is only available on the server-side `rebase` singleton.
-     * > The client-side SDK does not include an email service.
-     */
-    email?: EmailService;
-    /** Admin API for user management */
-    admin?: AdminAPI;
-    /**
-     * The base HTTP URL of the backend server.
-     * Exposed by the SDK client (`@rebasepro/client`) and used to auto-derive
-     * the `ApiConfigProvider` URL.
-     */
-    baseUrl?: string;
-    /**
-     * WebSocket client for realtime subscriptions and admin capabilities.
-     * Exposed by the SDK client (`@rebasepro/client`). The shape is intentionally
-     * left as `unknown` in the base interface — callers should narrow via feature
-     * detection (e.g. `typeof ws.executeSql === "function"`).
-     */
-    ws?: unknown;
-    /**
-     * Execute raw SQL against the database.
-     *
-     * Only available server-side when the backend uses a SQL database
-     * (PostgreSQL, MySQL, etc.). `undefined` for document databases
-     * (MongoDB, Firestore) and on the client-side SDK.
-     *
-     * @example
-     * ```typescript
-     * // In a cron job or custom function:
-     * if (ctx.client.sql) {
-     *     const rows = await ctx.client.sql("SELECT count(*) FROM orders");
-     * }
-     * ```
-     */
-    sql?(query: string, options?: {
-        database?: string;
-        role?: string;
-    }): Promise<Record<string, unknown>[]>;
-}

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

@@ -1,46 +0,0 @@
-import type { EntityCollection } from "../types/collections";
-import type { EntityReference } from "../types/entities";
-/**
- * Controller that provides access to the registered entity collections.
- * @group Models
- */
-export type CollectionRegistryController<DB = Record<string, unknown>, EC extends EntityCollection = EntityCollection> = {
-    /**
-     * 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: <K extends keyof DB>(slugOrPath: Extract<K, 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
-     */
-    getParentCollectionSlugs: (path: string) => string[];
-    getParentEntityIds: (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

@@ -1,60 +0,0 @@
-import React from "react";
-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";
-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

@@ -1,207 +0,0 @@
-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
- */
-/**
- * A where-clause value for a single field.
- *
- * Supports three syntaxes:
- *  1. **Equality shorthand**: raw JS values — `null`, `"active"`, `42`, `true`
- *  2. **Tuple syntax**: `[operator, value]` — `[">", 18]`, `["in", ["a","b"]]`
- *  3. **PostgREST string**: `"eq.published"`, `"gte.18"`, `"in.(a,b)"`
- *
- * @group Data
- */
-export type WhereFieldValue = string | number | boolean | null | [WhereFilterOpShort, any] | [WhereFilterOpShort, any][];
-export type WhereValue<T> = T | T[] | null;
-export interface LogicalCondition {
-    type: "and" | "or";
-    conditions: (FilterCondition | LogicalCondition)[];
-}
-export interface FilterCondition {
-    column: string;
-    operator: FilterOperator;
-    value: unknown;
-}
-/** Short operator strings accepted in the tuple syntax. */
-export type WhereFilterOpShort = "==" | "!=" | ">" | ">=" | "<" | "<=" | "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "nin" | "not-in" | "array-contains" | "array-contains-any" | "cs" | "csa";
-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;
-    /**
-     * Filter object. Supports multiple syntaxes per field:
-     *
-     * **Equality shorthand** — raw JS values (null, string, number, boolean):
-     * ```ts
-     * { company_profile_id: null }
-     * { status: "active" }
-     * { age: 18 }
-     * ```
-     *
-     * **Tuple syntax** — `[operator, value]`:
-     * ```ts
-     * { age: [">=", 18] }
-     * { role: ["in", ["admin", "editor"]] }
-     * { deleted_at: ["!=", null] }
-     * ```
-     *
-     * **PostgREST string syntax** (original format):
-     * ```ts
-     * { status: "eq.published" }
-     * { age: "gte.18" }
-     * { role: "in.(admin,editor)" }
-     * ```
-     */
-    where?: Record<string, WhereFieldValue>;
-    /** Logical grouping conditions (AND/OR) */
-    logical?: LogicalCondition;
-    /**
-     * 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, unknown> = Record<string, unknown>> {
-    /** Array of entities matching the query */
-    data: Entity<M>[];
-    /** Pagination metadata */
-    meta: {
-        total: number;
-        limit: number;
-        offset: number;
-        hasMore: boolean;
-    };
-}
-export type FilterOperator = WhereFilterOpShort;
-/**
- * Fluent Query Builder Interface supported on both client and server accessors.
- * @group Data
- */
-export interface QueryBuilderInterface<M extends Record<string, unknown> = Record<string, unknown>> {
-    where<K extends keyof M & string>(column: K, operator: FilterOperator, value: WhereValue<M[K]>): this;
-    where(logicalCondition: LogicalCondition): this;
-    orderBy(column: keyof M & string, ascending?: "asc" | "desc"): this;
-    limit(count: number): this;
-    offset(count: number): this;
-    search(searchString: string): this;
-    include(...relations: string[]): this;
-    find(): Promise<FindResponse<M>>;
-    listen(onUpdate: (data: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
-}
-/**
- * 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, unknown> = Record<string, unknown>> {
-    /**
-     * 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>;
-    /**
-     * Delete all records in this collection.
-     */
-    deleteAll?(): 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>;
-    where<K extends keyof M & string>(column: K, operator: FilterOperator, value: WhereValue<M[K]>): QueryBuilderInterface<M>;
-    where(logicalCondition: LogicalCondition): QueryBuilderInterface<M>;
-    orderBy(column: keyof M & string, ascending?: "asc" | "desc"): QueryBuilderInterface<M>;
-    limit(count: number): QueryBuilderInterface<M>;
-    offset(count: number): QueryBuilderInterface<M>;
-    search(searchString: string): QueryBuilderInterface<M>;
-    include(...relations: string[]): QueryBuilderInterface<M>;
-}
-/**
- * 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

@@ -1,218 +0,0 @@
-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;
-};
-/**
- * Configuration for vector similarity search queries.
- * Vector search applies an ORDER BY distance expression and optionally
- * filters results by a distance threshold.
- */
-export interface VectorSearchParams {
-    /** Property name containing the vector column */
-    property: string;
-    /** Query vector to compare against */
-    vector: number[];
-    /** Distance function (default: "cosine") */
-    distance?: "cosine" | "l2" | "inner_product";
-    /** Only return results within this distance threshold */
-    threshold?: number;
-}
-/**
- * @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";
-    /** Vector similarity search configuration */
-    vectorSearch?: VectorSearchParams;
-}
-/**
- * @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>;
-    /**
-     * Delete all entities from a collection.
-     * @param path Collection path
-     */
-    deleteAll?(path: string): 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;
-        parentCollectionSlugs?: string[];
-        parentEntityIds?: string[];
-    }) => Promise<boolean>;
-    /**
-     * Flag to indicate if the driver has requested the initialization of the text search index
-     */
-    needsInitTextSearch?: boolean;
-    /**
-     * Optional REST-optimised fetch service. When present, the REST API
-     * generator uses these methods instead of the generic `fetchEntity` /
-     * `fetchCollection` pipeline, enabling include-aware eager-loading.
-     */
-    restFetchService?: RestFetchService;
-    /**
-     * Return the admin capabilities of this driver.
-     * @see SQLAdmin
-     * @see DocumentAdmin
-     * @see SchemaAdmin
-     */
-    admin?: import("../types/backend").DatabaseAdmin;
-}
-/**
- * REST-optimised fetch service exposed by drivers that support
- * eager-loading of relations via `include`.
- *
- * The methods return flattened rows (`{ id, ...columns }`) rather
- * than the `Entity<M>` wrapper used by the generic DataDriver API.
- *
- * @group DataDriver
- */
-export interface RestFetchService {
-    /**
-     * Fetch a collection of flattened entities with optional relation includes.
-     */
-    fetchCollectionForRest(collectionPath: string, options?: {
-        filter?: FilterValues<string>;
-        orderBy?: string;
-        order?: "desc" | "asc";
-        limit?: number;
-        offset?: number;
-        startAfter?: Record<string, unknown>;
-        searchString?: string;
-        databaseId?: string;
-        vectorSearch?: VectorSearchParams;
-    }, include?: string[]): Promise<Record<string, unknown>[]>;
-    /**
-     * Fetch a single flattened entity with optional relation includes.
-     */
-    fetchEntityForRest(collectionPath: string, entityId: string | number, include?: string[], databaseId?: string): Promise<Record<string, unknown> | null>;
-}