@rebasepro/types 0.2.1 → 0.2.4

package/dist/users/roles.d.ts

@@ -11,12 +11,4 @@ export type Role = {
      * If this flag is true, the user can perform any action
      */
     isAdmin?: boolean;
-    /**
-     * Permissions related to editing the collections
-     */
-    config?: {
-        createCollections?: boolean;
-        editCollections?: boolean | "own";
-        deleteCollections?: boolean | "own";
-    };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/types",
   "type": "module",
-  "version": "0.2.1",
+  "version": "0.2.4",
   "description": "Rebase type definitions — shared interfaces and controller types",
   "funding": {
     "url": "https://github.com/sponsors/rebaseco"

package/src/controllers/auth.tsx

@@ -1,6 +1,4 @@
-import { StorageSource } from "./storage";
 import { Role, User } from "../users";
-import { RebaseData } from "./data";
 
 /**
  * Capabilities advertised by an auth provider.
@@ -100,6 +98,8 @@ export interface AuthControllerExtended<USER extends User = User, ExtraData = un
     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) */
@@ -113,31 +113,3 @@ export interface AuthControllerExtended<USER extends User = User, ExtraData = un
     /** Update user profile */
     updateProfile?(displayName?: string, photoURL?: string): Promise<USER>;
 }
-
-/**
- * Implement this function to allow access to specific users.
- * @group Hooks and utilities
- */
-export type Authenticator<USER extends User = User> = (props: {
-
-    /**
-     * Logged-in user or null
-     */
-    user: USER | null;
-
-    /**
-     * AuthController
-     */
-    authController: AuthController<USER>;
-
-    /**
-     * Unified data access API
-     */
-    data: RebaseData;
-
-    /**
-     * Used storage implementation
-     */
-    storageSource: StorageSource;
-
-}) => boolean | Promise<boolean>;

package/src/controllers/client.ts

@@ -75,7 +75,6 @@ export interface AdminRole {
     name: string;
     isAdmin: boolean;
     defaultPermissions: Record<string, unknown> | null;
-    config: Record<string, unknown> | null;
 }
 
 /**
@@ -98,8 +97,8 @@ export interface AdminAPI {
     deleteUser(userId: string): Promise<{ success: boolean }>;
     listRoles(): Promise<{ roles: AdminRole[] }>;
     getRole(roleId: string): Promise<{ role: AdminRole }>;
-    createRole(data: { id: string; name: string; isAdmin?: boolean; defaultPermissions?: Record<string, unknown>; config?: Record<string, unknown> }): Promise<{ role: AdminRole }>;
-    updateRole(roleId: string, data: { name?: string; isAdmin?: boolean; defaultPermissions?: Record<string, unknown>; config?: Record<string, unknown> }): Promise<{ role: AdminRole }>;
+    createRole(data: { id: string; name: string; isAdmin?: boolean; defaultPermissions?: Record<string, unknown> }): Promise<{ role: AdminRole }>;
+    updateRole(roleId: string, data: { name?: string; isAdmin?: boolean; defaultPermissions?: Record<string, unknown> }): Promise<{ role: AdminRole }>;
     deleteRole(roleId: string): Promise<{ success: boolean }>;
     bootstrap(): Promise<{ success: boolean; message: string; user: { uid: string; roles: string[] } }>;
 }

package/src/controllers/collection_registry.ts

@@ -7,7 +7,7 @@ import type { EntityReference } from "../types/entities";
  */
 export type CollectionRegistryController<
     DB = Record<string, unknown>,
-    EC extends EntityCollection = EntityCollection<any>
+    EC extends EntityCollection = EntityCollection
 > = {
 
     /**

package/src/controllers/data.ts

@@ -90,6 +90,23 @@ export interface FindResponse<M extends Record<string, unknown> = Record<string,
     };
 }
 
+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(column: keyof M & string, operator: FilterOperator, value: unknown): 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.
  *
@@ -145,6 +162,14 @@ export interface CollectionAccessor<M extends Record<string, unknown> = Record<s
      * Count the number of records matching the given filter.
      */
     count?(params?: FindParams): Promise<number>;
+
+    // Fluent Query Builder
+    where(column: keyof M & string, operator: FilterOperator, value: unknown): 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>;
 }
 
 /**

package/src/controllers/data_driver.ts

@@ -24,6 +24,22 @@ export type ListenEntityProps<M extends Record<string, unknown> = Record<string,
         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
  */
@@ -37,6 +53,8 @@ export interface FetchCollectionProps<M extends Record<string, unknown> = Record
     orderBy?: string;
     searchString?: string;
     order?: "desc" | "asc";
+    /** Vector similarity search configuration */
+    vectorSearch?: VectorSearchParams;
 }
 
 /**
@@ -240,6 +258,7 @@ export interface RestFetchService {
             startAfter?: Record<string, unknown>;
             searchString?: string;
             databaseId?: string;
+            vectorSearch?: VectorSearchParams;
         },
         include?: string[]
     ): Promise<Record<string, unknown>[]>;

package/src/controllers/registry.ts

@@ -4,6 +4,7 @@ import type { EntityCollectionsBuilder } from "../types/builders";
 import type { EntityCustomView } from "../types/entity_views";
 import type { EntityAction } from "../types/entity_actions";
 import type { AppView, NavigationGroupMapping } from "./navigation";
+import type { RebasePlugin } from "../types/plugins";
 
 /**
  * Options to enable the built-in collection editor.
@@ -21,12 +22,12 @@ export interface CollectionEditorOptions {
     pathSuggestions?: string[];
 }
 
-export interface RebaseCMSConfig<EC extends EntityCollection = any> {
+export interface RebaseCMSConfig<EC extends EntityCollection = EntityCollection> {
     collections?: EC[] | EntityCollectionsBuilder<EC>;
     homePage?: ReactNode;
-    entityViews?: EntityCustomView<any>[];
+    entityViews?: EntityCustomView[];
     entityActions?: EntityAction[];
-    plugins?: any[];
+    plugins?: RebasePlugin[];
 
     /**
      * Centralized configuration for how collections and views are grouped
@@ -47,7 +48,7 @@ export interface RebaseCMSConfig<EC extends EntityCollection = any> {
 }
 
 export interface RebaseStudioConfig {
-    tools?: ("sql" | "js" | "rls" | "schema" | "storage" | "cron" | "schema-visualizer" | "branches" | "api")[];
+    tools?: ("sql" | "js" | "rls" | "schema" | "storage" | "cron" | "schema-visualizer" | "branches" | "api" | "logs")[];
     homePage?: ReactNode;
     devViews?: AppView[];
 }

package/src/rebase_context.tsx

@@ -32,7 +32,7 @@ export type RebaseCallContext<USER extends User = User> = {
      * const { client } = props.context;
      * const result = await client.functions.invoke('extract-job', { url });
      */
-    client: RebaseClient<any>;
+    client: RebaseClient;
 
     /**
      * Unified data access — `context.data.products.create(...)`.

package/src/types/auth_adapter.ts

@@ -149,7 +149,7 @@ export interface AuthUserData {
     displayName?: string | null;
     photoUrl?: string | null;
     emailVerified?: boolean;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
     createdAt?: Date;
     updatedAt?: Date;
 }
@@ -163,7 +163,7 @@ export interface AuthCreateUserData {
     password?: string;
     displayName?: string;
     photoUrl?: string;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 }
 
 /**
@@ -186,7 +186,6 @@ export interface AuthRoleData {
         edit?: boolean;
         delete?: boolean;
     }> | null;
-    config?: Record<string, unknown> | null;
 }
 
 /**
@@ -199,7 +198,6 @@ export interface AuthCreateRoleData {
     isAdmin?: boolean;
     defaultPermissions?: AuthRoleData["defaultPermissions"];
     collectionPermissions?: AuthRoleData["collectionPermissions"];
-    config?: AuthRoleData["config"];
 }
 
 /**

package/src/types/collections.ts

@@ -716,10 +716,7 @@ export interface FilterPreset<Key extends string = string> {
     sort?: [Key, "asc" | "desc"];
 }
 
-/**
- * @deprecated Use {@link FilterPreset} instead.
- */
-export type QuickFilter<Key extends string = string> = FilterPreset<Key>;
+
 
 /**
  * Used to indicate valid filter combinations (e.g. created in Firestore)

package/src/types/component_ref.ts

@@ -37,7 +37,7 @@ export interface LazyComponentRef<P = unknown> {
  *
  * @group Types
  */
-export type ComponentRef<P = unknown> =
+export type ComponentRef<P = any> =
     | React.ComponentType<P>
     | LazyComponentRef<P>
     | (() => Promise<{ default: React.ComponentType<P> }>)

package/src/types/cron.ts

@@ -61,7 +61,7 @@ export interface CronJobContext {
     log: (...args: unknown[]) => void;
 
     /** The RebaseClient instance to interact with the database. */
-    client: RebaseClient<any>;
+    client: RebaseClient;
 }
 
 // =============================================================================

package/src/types/entity_views.tsx

@@ -66,6 +66,7 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
 export type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
     key: string;
     name: string;
+    icon?: string | React.ReactNode;
     tabComponent?: React.ReactNode;
     includeActions?: boolean | "bottom";
     Builder?: ComponentRef<EntityCustomViewParams<M>>;

package/src/types/export_import.ts

@@ -20,7 +20,7 @@ export interface ExportMappingFunction<USER extends User = User> {
         entity,
         context
     }: {
-        entity: Entity<any>,
+        entity: Entity,
         context: RebaseContext<USER>
     }) => Promise<string> | string;
 }

package/src/types/formex.ts

@@ -1,6 +1,6 @@
 import React, { FormEvent } from "react";
 
-export type FormexController<T = any> = {
+export type FormexController<T = unknown> = {
     values: T;
     initialValues: T;
     setValues: (values: T) => void;
@@ -37,7 +37,7 @@ export type FormexController<T = any> = {
     canRedo: boolean;
 }
 
-export type FormexResetProps<T = any> = {
+export type FormexResetProps<T = unknown> = {
     values?: T;
     submitCount?: number;
     errors?: Record<string, string>;

package/src/types/properties.ts

@@ -152,8 +152,8 @@ export interface BaseUIConfig<CustomProps = unknown> {
     disabled?: boolean | PropertyDisabledConfig;
     widthPercentage?: number;
     customProps?: CustomProps;
-    Field?: ComponentRef<any>;
-    Preview?: ComponentRef<any>;
+    Field?: ComponentRef;
+    Preview?: ComponentRef;
 }
 
 export interface BaseProperty<CustomProps = unknown> {

package/src/types/translations.ts

@@ -121,6 +121,12 @@ export interface RebaseTranslations {
     navigation_drawer: string;
     collapse: string;
     expand: string;
+    /** Tooltip for the language switcher in the drawer footer */
+    change_language?: string;
+    /** Tooltip for the theme toggle in the drawer footer */
+    toggle_theme?: string;
+    /** Aria label for the user menu trigger in the drawer footer */
+    user_menu?: string;
 
     // ─── Error states ─────────────────────────────────────────────
     error: string;
@@ -486,18 +492,28 @@ export interface RebaseTranslations {
 
     select_reference: string;
     select_references: string;
-    account_settings: string;
-    profile: string;
-    sessions: string;
-    display_name: string;
-    photo_url: string;
-    save_profile: string;
-    saving: string;
-    no_active_sessions: string;
-    revoking: string;
-    revoke_all_sessions: string;
-    unknown_device: string;
-    current: string;
+    account_settings?: string;
+    profile?: string;
+    sessions?: string;
+    security?: string;
+    change_password?: string;
+    current_password?: string;
+    new_password?: string;
+    confirm_password?: string;
+    password_changed?: string;
+    passwords_dont_match?: string;
+    password_too_short?: string;
+    password_change_not_available?: string;
+    changing_password?: string;
+    display_name?: string;
+    photo_url?: string;
+    save_profile?: string;
+    saving?: string;
+    no_active_sessions?: string;
+    revoking?: string;
+    revoke_all_sessions?: string;
+    unknown_device?: string;
+    current?: string;
     role_id: string;
     role_name: string;
     add_reference: string;

package/src/types/user_management_delegate.ts

@@ -120,10 +120,7 @@ export interface UserManagementDelegate<USER extends User = User> {
      */
     allowDefaultRolesCreation?: boolean;
 
-    /**
-     * Should collection config permissions be included?
-     */
-    includeCollectionConfigPermissions?: boolean;
+
 
 
     /**
@@ -132,6 +129,13 @@ export interface UserManagementDelegate<USER extends User = User> {
      */
     defineRolesFor?: (user: USER) => Promise<Role[] | undefined> | Role[] | undefined;
 
+    /**
+     * Whether any admin users exist. Used by the bootstrap banner to decide
+     * whether to prompt.  Populated via a lightweight check (e.g. `limit=1`
+     * query) instead of loading all users.
+     */
+    hasAdminUsers?: boolean;
+
     /**
      * Optional function to bootstrap an admin user.
      * Often used when the database is empty.

package/src/users/roles.ts

@@ -18,15 +18,5 @@ export type Role = {
     isAdmin?: boolean;
 
 
-    /**
-     * Permissions related to editing the collections
-     */
-    config?: {
-
-        createCollections?: boolean;
-
-        editCollections?: boolean | "own";
 
-        deleteCollections?: boolean | "own";
-    }
 }

package/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/src/controllers/auth.d.ts

@@ -1,125 +0,0 @@
-import { StorageSource } from "./storage";
-import { Role, User } from "../users";
-import { RebaseData } from "./data";
-/**
- * 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: Role[]): 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 a Google token or authorization code */
-    googleLogin?: {
-        (token: string, tokenType?: "idToken" | "accessToken"): Promise<void>;
-        (payload: {
-            code: string;
-            redirectUri: string;
-        }): 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>;
-}
-/**
- * Implement this function to allow access to specific users.
- * @group Hooks and utilities
- */
-export type Authenticator<USER extends User = User> = (props: {
-    /**
-     * Logged-in user or null
-     */
-    user: USER | null;
-    /**
-     * AuthController
-     */
-    authController: AuthController<USER>;
-    /**
-     * Unified data access API
-     */
-    data: RebaseData;
-    /**
-     * Used storage implementation
-     */
-    storageSource: StorageSource;
-}) => boolean | Promise<boolean>;