@rebasepro/client-postgresql 0.5.0 → 0.6.0

package/dist/client/src/transport.d.ts

@@ -1,33 +0,0 @@
-import { FindParams as TypesFindParams, FindResponse as TypesFindResponse } from "@rebasepro/types";
-export interface RebaseClientConfig {
-    baseUrl?: string;
-    token?: string;
-    apiPath?: string;
-    fetch?: typeof globalThis.fetch;
-    onUnauthorized?: () => Promise<boolean>;
-    websocketUrl?: string;
-}
-/**
- * Re-export from `@rebasepro/types` for backward compatibility.
- */
-export type FindParams = TypesFindParams;
-export type FindResponse<T> = TypesFindResponse<T extends Record<string, unknown> ? T : Record<string, unknown>>;
-export declare class RebaseApiError extends Error {
-    status: number;
-    code?: string;
-    details?: unknown;
-    constructor(status: number, message: string, code?: string, details?: unknown);
-}
-export declare function buildQueryString(params?: FindParams): string;
-export interface Transport {
-    request: <T = unknown>(path: string, init?: RequestInit) => Promise<T>;
-    setToken: (newToken: string | null) => void;
-    setAuthTokenGetter: (getter: () => Promise<string | null>) => void;
-    setOnUnauthorized: (handler: () => Promise<boolean>) => void;
-    readonly baseUrl: string;
-    readonly apiPath: string;
-    readonly fetchFn: typeof globalThis.fetch;
-    getHeaders: (init?: RequestInit) => Record<string, string>;
-    resolveToken: () => Promise<string | null>;
-}
-export declare function createTransport(config: RebaseClientConfig): Transport;

package/dist/client/src/websocket.d.ts

@@ -1,105 +0,0 @@
-import { DeleteEntityProps, Entity, EntityCollection, FetchCollectionProps, FetchEntityProps, SaveEntityProps, TableMetadata, BranchInfo } from "@rebasepro/types";
-export interface RebaseWebSocketConfig {
-    websocketUrl: string;
-    /** Optional auth token getter for WebSocket authentication */
-    getAuthToken?: () => Promise<string>;
-    /** Optional WebSocket constructor to override globalThis.WebSocket (e.g. for Node environments) */
-    WebSocket?: typeof WebSocket;
-    /** Callback to handle unauthorized requests or token expiration (refreshes auth session) */
-    onUnauthorized?: () => Promise<boolean>;
-}
-export declare class ApiError extends Error {
-    code?: string;
-    error?: string;
-    constructor(message: string, error?: string, code?: string);
-}
-export declare class RebaseWebSocketClient {
-    private websocketUrl;
-    private ws;
-    getAuthToken?: () => Promise<string>;
-    private subscriptions;
-    private listeners;
-    on(event: "connect" | "disconnect" | "reconnect" | "error", cb: (...args: unknown[]) => void): () => boolean;
-    private emit;
-    private collectionSubscriptions;
-    private entitySubscriptions;
-    private backendToCollectionKey;
-    private backendToEntityKey;
-    private pendingRequests;
-    private reconnectAttempts;
-    private maxReconnectAttempts;
-    private isConnected;
-    private messageQueue;
-    private reconnectTimeout;
-    private isAuthenticated;
-    private authPromise;
-    private WebSocketConstructor;
-    onUnauthorized?: () => Promise<boolean>;
-    private refreshInProgress;
-    constructor(config: RebaseWebSocketConfig);
-    /**
-     * Authenticate the WebSocket connection
-     */
-    authenticate(token: string): Promise<void>;
-    /**
-     * Set the auth token getter function
-     */
-    setAuthTokenGetter(getAuthToken: () => Promise<string>): void;
-    disconnect(): void;
-    private initWebSocket;
-    private processMessageQueue;
-    private attemptReconnect;
-    private isAuthError;
-    private handleAuthFailure;
-    private handleWebSocketMessage;
-    private ensureAuthenticated;
-    /**
-     * Force re-authentication (call after token refresh)
-     */
-    reauthenticate(): Promise<void>;
-    private sendMessage;
-    private doSendMessage;
-    fetchCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<Entity<M>[]>;
-    fetchEntity<M extends Record<string, unknown>>(props: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
-    saveEntity<M extends Record<string, unknown>>(props: SaveEntityProps<M>): Promise<Entity<M>>;
-    deleteEntity<M extends Record<string, unknown>>(props: DeleteEntityProps<M>): Promise<void>;
-    executeSql(sql: string, options?: {
-        database?: string;
-        role?: string;
-    }): Promise<Record<string, unknown>[]>;
-    fetchAvailableDatabases(): Promise<string[]>;
-    fetchAvailableRoles(): Promise<string[]>;
-    fetchCurrentDatabase(): Promise<string | undefined>;
-    checkUniqueField(path: string, name: string, value: unknown, entityId?: string, collection?: EntityCollection): Promise<boolean>;
-    countEntities<M extends Record<string, unknown>>(props: FetchCollectionProps<M>): Promise<number>;
-    fetchUnmappedTables(mappedPaths?: string[]): Promise<string[]>;
-    fetchTableMetadata(tableName: string): Promise<TableMetadata>;
-    createBranch(name: string, options?: {
-        source?: string;
-    }): Promise<BranchInfo>;
-    deleteBranch(name: string): Promise<void>;
-    listBranches(): Promise<BranchInfo[]>;
-    /**
-     * Recursively compare two values for structural equality.
-     * Handles primitives, null, undefined, Date, RegExp, arrays, and plain objects.
-     */
-    private deepEqual;
-    private normalizeForComparison;
-    /**
-     * Merge incoming entities with cached data, preserving cached references
-     * for entities whose values haven't changed. This avoids unnecessary
-     * React re-renders when the server refetches all entities but most
-     * haven't actually changed.
-     */
-    private mergeEntities;
-    listenCollection<M extends Record<string, unknown>>(props: FetchCollectionProps<M>, onUpdate: (entities: Entity[]) => void, onError?: (error: Error) => void): () => void;
-    listenEntity<M extends Record<string, unknown>>(props: FetchEntityProps<M>, onUpdate: (entity: Entity | null) => void, onError?: (error: Error) => void): () => void;
-    /**
-     * Re-send all active subscriptions to the backend after a reconnect.
-     * The server wipes subscription state when a client disconnects, so
-     * we need to re-register everything to resume receiving updates.
-     */
-    private resubscribeAll;
-    private createCollectionSubscriptionKey;
-    private createEntitySubscriptionKey;
-}

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

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

@@ -1,104 +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;
-    passwordReset?: 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, Supabase, 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/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;
-        }>;
-    };
-};