@fluxbase/sdk 0.0.1-rc.17 → 0.0.1-rc.19

package/dist/index.d.ts

@@ -1,13 +1,11 @@
 /**
  * Core types for the Fluxbase SDK
  */
+/**
+ * Client configuration options (Supabase-compatible)
+ * These options are passed as the third parameter to createClient()
+ */
 interface FluxbaseClientOptions {
-    /**
-     * Base URL of your Fluxbase instance
-     * @example 'https://api.myapp.com'
-     * @example 'http://localhost:8080'
-     */
-    url: string;
     /**
      * Authentication options
      */
@@ -1089,6 +1087,58 @@ interface EdgeFunctionExecution {
     executed_at: string;
     completed_at?: string;
 }
+/**
+ * Base Fluxbase response type (Supabase-compatible)
+ * Returns either `{ data, error: null }` on success or `{ data: null, error }` on failure
+ */
+type FluxbaseResponse<T> = {
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: Error;
+};
+/**
+ * Response type for operations that don't return data (void operations)
+ */
+type VoidResponse = {
+    error: Error | null;
+};
+/**
+ * Auth response with user and session
+ */
+type AuthResponseData = {
+    user: User;
+    session: AuthSession;
+};
+/**
+ * Fluxbase auth response
+ */
+type FluxbaseAuthResponse = FluxbaseResponse<AuthResponseData>;
+/**
+ * User response
+ */
+type UserResponse = FluxbaseResponse<{
+    user: User;
+}>;
+/**
+ * Session response
+ */
+type SessionResponse = FluxbaseResponse<{
+    session: AuthSession;
+}>;
+/**
+ * Generic data response
+ */
+type DataResponse<T> = FluxbaseResponse<T>;
+/**
+ * @deprecated Use FluxbaseResponse instead
+ */
+type SupabaseResponse<T> = FluxbaseResponse<T>;
+/**
+ * @deprecated Use FluxbaseAuthResponse instead
+ */
+type SupabaseAuthResponse = FluxbaseAuthResponse;
 
 /**
  * Realtime subscriptions using WebSockets
@@ -1309,33 +1359,33 @@ declare class FluxbaseAuth {
      * Sign in with email and password
      * Returns AuthSession if successful, or SignInWith2FAResponse if 2FA is required
      */
-    signIn(credentials: SignInCredentials): Promise<AuthSession | SignInWith2FAResponse>;
+    signIn(credentials: SignInCredentials): Promise<FluxbaseResponse<AuthSession | SignInWith2FAResponse>>;
     /**
      * Sign in with email and password
      * Alias for signIn() to maintain compatibility with common authentication patterns
      * Returns AuthSession if successful, or SignInWith2FAResponse if 2FA is required
      */
-    signInWithPassword(credentials: SignInCredentials): Promise<AuthSession | SignInWith2FAResponse>;
+    signInWithPassword(credentials: SignInCredentials): Promise<FluxbaseResponse<AuthSession | SignInWith2FAResponse>>;
     /**
      * Sign up with email and password
      */
-    signUp(credentials: SignUpCredentials): Promise<AuthSession>;
+    signUp(credentials: SignUpCredentials): Promise<FluxbaseAuthResponse>;
     /**
      * Sign out the current user
      */
-    signOut(): Promise<void>;
+    signOut(): Promise<VoidResponse>;
     /**
      * Refresh the access token
      */
-    refreshToken(): Promise<AuthSession>;
+    refreshToken(): Promise<SessionResponse>;
     /**
      * Get the current user from the server
      */
-    getCurrentUser(): Promise<User>;
+    getCurrentUser(): Promise<UserResponse>;
     /**
      * Update the current user
      */
-    updateUser(data: Partial<Pick<User, "email" | "metadata">>): Promise<User>;
+    updateUser(data: Partial<Pick<User, "email" | "metadata">>): Promise<UserResponse>;
     /**
      * Set the auth token manually
      */
@@ -1344,87 +1394,98 @@ declare class FluxbaseAuth {
      * Setup 2FA for the current user
      * Returns TOTP secret and QR code URL
      */
-    setup2FA(): Promise<TwoFactorSetupResponse>;
+    setup2FA(): Promise<DataResponse<TwoFactorSetupResponse>>;
     /**
      * Enable 2FA after verifying the TOTP code
      * Returns backup codes that should be saved by the user
      */
-    enable2FA(code: string): Promise<TwoFactorEnableResponse>;
+    enable2FA(code: string): Promise<DataResponse<TwoFactorEnableResponse>>;
     /**
      * Disable 2FA for the current user
      * Requires password confirmation
      */
-    disable2FA(password: string): Promise<{
+    disable2FA(password: string): Promise<DataResponse<{
         success: boolean;
         message: string;
-    }>;
+    }>>;
     /**
      * Check 2FA status for the current user
      */
-    get2FAStatus(): Promise<TwoFactorStatusResponse>;
+    get2FAStatus(): Promise<DataResponse<TwoFactorStatusResponse>>;
     /**
      * Verify 2FA code during login
      * Call this after signIn returns requires_2fa: true
      */
-    verify2FA(request: TwoFactorVerifyRequest): Promise<AuthSession>;
+    verify2FA(request: TwoFactorVerifyRequest): Promise<FluxbaseAuthResponse>;
     /**
      * Send password reset email
      * Sends a password reset link to the provided email address
      * @param email - Email address to send reset link to
      */
-    sendPasswordReset(email: string): Promise<PasswordResetResponse>;
+    sendPasswordReset(email: string): Promise<DataResponse<PasswordResetResponse>>;
+    /**
+     * Supabase-compatible alias for sendPasswordReset()
+     * @param email - Email address to send reset link to
+     * @param _options - Optional redirect configuration (currently not used)
+     */
+    resetPasswordForEmail(email: string, _options?: {
+        redirectTo?: string;
+    }): Promise<DataResponse<PasswordResetResponse>>;
     /**
      * Verify password reset token
      * Check if a password reset token is valid before allowing password reset
      * @param token - Password reset token to verify
      */
-    verifyResetToken(token: string): Promise<VerifyResetTokenResponse>;
+    verifyResetToken(token: string): Promise<DataResponse<VerifyResetTokenResponse>>;
     /**
      * Reset password with token
      * Complete the password reset process with a valid token
      * @param token - Password reset token
      * @param newPassword - New password to set
      */
-    resetPassword(token: string, newPassword: string): Promise<ResetPasswordResponse>;
+    resetPassword(token: string, newPassword: string): Promise<DataResponse<ResetPasswordResponse>>;
     /**
      * Send magic link for passwordless authentication
      * @param email - Email address to send magic link to
      * @param options - Optional configuration for magic link
      */
-    sendMagicLink(email: string, options?: MagicLinkOptions): Promise<MagicLinkResponse>;
+    sendMagicLink(email: string, options?: MagicLinkOptions): Promise<DataResponse<MagicLinkResponse>>;
     /**
      * Verify magic link token and sign in
      * @param token - Magic link token from email
      */
-    verifyMagicLink(token: string): Promise<AuthSession>;
+    verifyMagicLink(token: string): Promise<FluxbaseAuthResponse>;
     /**
      * Sign in anonymously
      * Creates a temporary anonymous user session
      */
-    signInAnonymously(): Promise<AuthSession>;
+    signInAnonymously(): Promise<FluxbaseAuthResponse>;
     /**
      * Get list of enabled OAuth providers
      */
-    getOAuthProviders(): Promise<OAuthProvidersResponse>;
+    getOAuthProviders(): Promise<DataResponse<OAuthProvidersResponse>>;
     /**
      * Get OAuth authorization URL for a provider
      * @param provider - OAuth provider name (e.g., 'google', 'github')
      * @param options - Optional OAuth configuration
      */
-    getOAuthUrl(provider: string, options?: OAuthOptions): Promise<OAuthUrlResponse>;
+    getOAuthUrl(provider: string, options?: OAuthOptions): Promise<DataResponse<OAuthUrlResponse>>;
     /**
      * Exchange OAuth authorization code for session
      * This is typically called in your OAuth callback handler
      * @param code - Authorization code from OAuth callback
      */
-    exchangeCodeForSession(code: string): Promise<AuthSession>;
+    exchangeCodeForSession(code: string): Promise<FluxbaseAuthResponse>;
     /**
      * Convenience method to initiate OAuth sign-in
      * Redirects the user to the OAuth provider's authorization page
      * @param provider - OAuth provider name (e.g., 'google', 'github')
      * @param options - Optional OAuth configuration
      */
-    signInWithOAuth(provider: string, options?: OAuthOptions): Promise<void>;
+    signInWithOAuth(provider: string, options?: OAuthOptions): Promise<DataResponse<{
+        provider: string;
+        url: string;
+    }>>;
     /**
      * Internal: Set the session and persist it
      */
@@ -3620,7 +3681,7 @@ declare class FluxbaseAdmin {
      * }
      * ```
      */
-    getSetupStatus(): Promise<AdminSetupStatusResponse>;
+    getSetupStatus(): Promise<DataResponse<AdminSetupStatusResponse>>;
     /**
      * Perform initial admin setup
      *
@@ -3644,7 +3705,7 @@ declare class FluxbaseAdmin {
      * localStorage.setItem('admin_token', response.access_token);
      * ```
      */
-    setup(request: AdminSetupRequest): Promise<AdminAuthResponse>;
+    setup(request: AdminSetupRequest): Promise<DataResponse<AdminAuthResponse>>;
     /**
      * Admin login
      *
@@ -3665,7 +3726,7 @@ declare class FluxbaseAdmin {
      * console.log('Logged in as:', response.user.email);
      * ```
      */
-    login(request: AdminLoginRequest): Promise<AdminAuthResponse>;
+    login(request: AdminLoginRequest): Promise<DataResponse<AdminAuthResponse>>;
     /**
      * Refresh admin access token
      *
@@ -3682,7 +3743,7 @@ declare class FluxbaseAdmin {
      * localStorage.setItem('admin_refresh_token', response.refresh_token);
      * ```
      */
-    refreshToken(request: AdminRefreshRequest): Promise<AdminRefreshResponse>;
+    refreshToken(request: AdminRefreshRequest): Promise<DataResponse<AdminRefreshResponse>>;
     /**
      * Admin logout
      *
@@ -3694,7 +3755,7 @@ declare class FluxbaseAdmin {
      * localStorage.removeItem('admin_token');
      * ```
      */
-    logout(): Promise<void>;
+    logout(): Promise<VoidResponse>;
     /**
      * Get current admin user information
      *
@@ -3707,7 +3768,7 @@ declare class FluxbaseAdmin {
      * console.log('Role:', user.role);
      * ```
      */
-    me(): Promise<AdminMeResponse>;
+    me(): Promise<DataResponse<AdminMeResponse>>;
     /**
      * List all users
      *
@@ -3728,7 +3789,7 @@ declare class FluxbaseAdmin {
      * });
      * ```
      */
-    listUsers(options?: ListUsersOptions): Promise<ListUsersResponse>;
+    listUsers(options?: ListUsersOptions): Promise<DataResponse<ListUsersResponse>>;
     /**
      * Get a user by ID
      *
@@ -3749,7 +3810,7 @@ declare class FluxbaseAdmin {
      * console.log('Last login:', dashboardUser.last_login_at);
      * ```
      */
-    getUserById(userId: string, type?: "app" | "dashboard"): Promise<EnrichedUser>;
+    getUserById(userId: string, type?: "app" | "dashboard"): Promise<DataResponse<EnrichedUser>>;
     /**
      * Invite a new user
      *
@@ -3771,7 +3832,7 @@ declare class FluxbaseAdmin {
      * console.log('Invitation link:', response.invitation_link);
      * ```
      */
-    inviteUser(request: InviteUserRequest, type?: "app" | "dashboard"): Promise<InviteUserResponse>;
+    inviteUser(request: InviteUserRequest, type?: "app" | "dashboard"): Promise<DataResponse<InviteUserResponse>>;
     /**
      * Delete a user
      *
@@ -3787,7 +3848,7 @@ declare class FluxbaseAdmin {
      * console.log('User deleted');
      * ```
      */
-    deleteUser(userId: string, type?: "app" | "dashboard"): Promise<DeleteUserResponse>;
+    deleteUser(userId: string, type?: "app" | "dashboard"): Promise<DataResponse<DeleteUserResponse>>;
     /**
      * Update user role
      *
@@ -3804,7 +3865,7 @@ declare class FluxbaseAdmin {
      * console.log('User role updated:', user.role);
      * ```
      */
-    updateUserRole(userId: string, role: string, type?: "app" | "dashboard"): Promise<EnrichedUser>;
+    updateUserRole(userId: string, role: string, type?: "app" | "dashboard"): Promise<DataResponse<EnrichedUser>>;
     /**
      * Reset user password
      *
@@ -3820,7 +3881,7 @@ declare class FluxbaseAdmin {
      * console.log(response.message);
      * ```
      */
-    resetUserPassword(userId: string, type?: "app" | "dashboard"): Promise<ResetUserPasswordResponse>;
+    resetUserPassword(userId: string, type?: "app" | "dashboard"): Promise<DataResponse<ResetUserPasswordResponse>>;
 }
 
 /**
@@ -4173,7 +4234,9 @@ declare class QueryBuilder<T = unknown> implements PromiseLike<PostgrestResponse
  * Main Fluxbase client class
  * @category Client
  */
-declare class FluxbaseClient {
+declare class FluxbaseClient<Database = any, _SchemaName extends string & keyof Database = any> {
+    protected fluxbaseUrl: string;
+    protected fluxbaseKey: string;
     /** Internal HTTP client for making requests */
     private fetch;
     /** Authentication module for user management */
@@ -4190,9 +4253,21 @@ declare class FluxbaseClient {
     management: FluxbaseManagement;
     /**
      * Create a new Fluxbase client instance
-     * @param options - Client configuration options
+     *
+     * @param fluxbaseUrl - The URL of your Fluxbase instance
+     * @param fluxbaseKey - The anon key (JWT token with "anon" role). Generate using scripts/generate-keys.sh
+     * @param options - Additional client configuration options
+     *
+     * @example
+     * ```typescript
+     * const client = new FluxbaseClient(
+     *   'http://localhost:8080',
+     *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',  // Anon JWT token
+     *   { timeout: 30000 }
+     * )
+     * ```
      */
-    constructor(options: FluxbaseClientOptions);
+    constructor(fluxbaseUrl: string, fluxbaseKey: string, options?: FluxbaseClientOptions);
     /**
      * Create a query builder for a database table
      *
@@ -4312,31 +4387,41 @@ declare class FluxbaseClient {
     get http(): FluxbaseFetch;
 }
 /**
- * Create a new Fluxbase client instance
+ * Create a new Fluxbase client instance (Supabase-compatible)
  *
- * This is the recommended way to initialize the Fluxbase SDK.
+ * This function signature is identical to Supabase's createClient, making migration seamless.
  *
- * @param options - Client configuration options
- * @returns A configured Fluxbase client instance
+ * @param fluxbaseUrl - The URL of your Fluxbase instance
+ * @param fluxbaseKey - The anon key (JWT token with "anon" role). Generate using: `./scripts/generate-keys.sh` (option 3)
+ * @param options - Optional client configuration
+ * @returns A configured Fluxbase client instance with full TypeScript support
  *
  * @example
  * ```typescript
  * import { createClient } from '@fluxbase/sdk'
  *
- * const client = createClient({
- *   url: 'http://localhost:8080',
- *   auth: {
- *     token: 'your-jwt-token',
- *     autoRefresh: true,
- *     persist: true
- *   },
- *   timeout: 30000,
- *   debug: false
- * })
+ * // Initialize with anon key (identical to Supabase)
+ * const client = createClient(
+ *   'http://localhost:8080',
+ *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'  // Anon JWT token
+ * )
+ *
+ * // With additional options
+ * const client = createClient(
+ *   'http://localhost:8080',
+ *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+ *   { timeout: 30000, debug: true }
+ * )
+ *
+ * // With TypeScript database types
+ * const client = createClient<Database>(
+ *   'http://localhost:8080',
+ *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+ * )
  * ```
  *
  * @category Client
  */
-declare function createClient(options: FluxbaseClientOptions): FluxbaseClient;
+declare function createClient<Database = any, SchemaName extends string & keyof Database = any>(fluxbaseUrl: string, fluxbaseKey: string, options?: FluxbaseClientOptions): FluxbaseClient<Database, SchemaName>;
 
-export { type APIKey, APIKeysManager, type AcceptInvitationRequest, type AcceptInvitationResponse, type AdminAuthResponse, type AdminLoginRequest, type AdminMeResponse, type AdminRefreshRequest, type AdminRefreshResponse, type AdminSetupRequest, type AdminSetupStatusResponse, type AdminUser, type AppSettings, AppSettingsManager, type AuthResponse, type AuthSession, type AuthSettings, AuthSettingsManager, type AuthenticationSettings, type Column, type CreateAPIKeyRequest, type CreateAPIKeyResponse, type CreateColumnRequest, type CreateFunctionRequest, type CreateInvitationRequest, type CreateInvitationResponse, type CreateOAuthProviderRequest, type CreateOAuthProviderResponse, type CreateSchemaRequest, type CreateSchemaResponse, type CreateTableRequest, type CreateTableResponse, type CreateWebhookRequest, DDLManager, type DeleteAPIKeyResponse, type DeleteOAuthProviderResponse, type DeleteTableResponse, type DeleteUserResponse, type DeleteWebhookResponse, type EdgeFunction, type EdgeFunctionExecution, type EmailSettings, type EmailTemplate, EmailTemplateManager, type EmailTemplateType, type EnrichedUser, type FeatureSettings, type FileObject, type FilterOperator, FluxbaseAdmin, FluxbaseAuth, FluxbaseClient, type FluxbaseClientOptions, type FluxbaseError, FluxbaseFetch, FluxbaseFunctions, FluxbaseManagement, FluxbaseOAuth, FluxbaseRealtime, FluxbaseSettings, FluxbaseStorage, type FunctionInvokeOptions, type GetImpersonationResponse, type HttpMethod, type ImpersonateAnonRequest, type ImpersonateServiceRequest, type ImpersonateUserRequest, ImpersonationManager, type ImpersonationSession, type ImpersonationTargetUser, type ImpersonationType, type Invitation, InvitationsManager, type InviteUserRequest, type InviteUserResponse, type ListAPIKeysResponse, type ListEmailTemplatesResponse, type ListImpersonationSessionsOptions, type ListImpersonationSessionsResponse, type ListInvitationsOptions, type ListInvitationsResponse, type ListOAuthProvidersResponse, type ListOptions, type ListSchemasResponse, type ListSystemSettingsResponse, type ListTablesResponse, type ListUsersOptions, type ListUsersResponse, type ListWebhookDeliveriesResponse, type ListWebhooksResponse, type MailgunSettings, type OAuthProvider, OAuthProviderManager, type OrderBy, type OrderDirection, type PostgresChangesConfig, type PostgrestError, type PostgrestResponse, QueryBuilder, type QueryFilter, type RealtimeCallback, type RealtimeChangePayload, RealtimeChannel, type RealtimeMessage, type RealtimePostgresChangesPayload, type RequestOptions, type ResetUserPasswordResponse, type RevokeAPIKeyResponse, type RevokeInvitationResponse, type SESSettings, type SMTPSettings, type Schema, type SecuritySettings, type SendGridSettings, type SignInCredentials, type SignInWith2FAResponse, type SignUpCredentials, type SignedUrlOptions, type StartImpersonationResponse, type StopImpersonationResponse, StorageBucket, type StorageObject, type SystemSetting, SystemSettingsManager, type Table, type TestEmailTemplateRequest, type TestWebhookResponse, type TwoFactorEnableResponse, type TwoFactorSetupResponse, type TwoFactorStatusResponse, type TwoFactorVerifyRequest, type UpdateAPIKeyRequest, type UpdateAppSettingsRequest, type UpdateAuthSettingsRequest, type UpdateAuthSettingsResponse, type UpdateEmailTemplateRequest, type UpdateFunctionRequest, type UpdateOAuthProviderRequest, type UpdateOAuthProviderResponse, type UpdateSystemSettingRequest, type UpdateUserRoleRequest, type UpdateWebhookRequest, type UploadOptions, type User, type ValidateInvitationResponse, type Webhook, type WebhookDelivery, WebhooksManager, createClient };
+export { type APIKey, APIKeysManager, type AcceptInvitationRequest, type AcceptInvitationResponse, type AdminAuthResponse, type AdminLoginRequest, type AdminMeResponse, type AdminRefreshRequest, type AdminRefreshResponse, type AdminSetupRequest, type AdminSetupStatusResponse, type AdminUser, type AppSettings, AppSettingsManager, type AuthResponse, type AuthSession, type AuthSettings, AuthSettingsManager, type AuthenticationSettings, type Column, type CreateAPIKeyRequest, type CreateAPIKeyResponse, type CreateColumnRequest, type CreateFunctionRequest, type CreateInvitationRequest, type CreateInvitationResponse, type CreateOAuthProviderRequest, type CreateOAuthProviderResponse, type CreateSchemaRequest, type CreateSchemaResponse, type CreateTableRequest, type CreateTableResponse, type CreateWebhookRequest, DDLManager, type DataResponse, type DeleteAPIKeyResponse, type DeleteOAuthProviderResponse, type DeleteTableResponse, type DeleteUserResponse, type DeleteWebhookResponse, type EdgeFunction, type EdgeFunctionExecution, type EmailSettings, type EmailTemplate, EmailTemplateManager, type EmailTemplateType, type EnrichedUser, type FeatureSettings, type FileObject, type FilterOperator, FluxbaseAdmin, FluxbaseAuth, type FluxbaseAuthResponse, FluxbaseClient, type FluxbaseClientOptions, type FluxbaseError, FluxbaseFetch, FluxbaseFunctions, FluxbaseManagement, FluxbaseOAuth, FluxbaseRealtime, type FluxbaseResponse, FluxbaseSettings, FluxbaseStorage, type FunctionInvokeOptions, type GetImpersonationResponse, type HttpMethod, type ImpersonateAnonRequest, type ImpersonateServiceRequest, type ImpersonateUserRequest, ImpersonationManager, type ImpersonationSession, type ImpersonationTargetUser, type ImpersonationType, type Invitation, InvitationsManager, type InviteUserRequest, type InviteUserResponse, type ListAPIKeysResponse, type ListEmailTemplatesResponse, type ListImpersonationSessionsOptions, type ListImpersonationSessionsResponse, type ListInvitationsOptions, type ListInvitationsResponse, type ListOAuthProvidersResponse, type ListOptions, type ListSchemasResponse, type ListSystemSettingsResponse, type ListTablesResponse, type ListUsersOptions, type ListUsersResponse, type ListWebhookDeliveriesResponse, type ListWebhooksResponse, type MailgunSettings, type OAuthProvider, OAuthProviderManager, type OrderBy, type OrderDirection, type PostgresChangesConfig, type PostgrestError, type PostgrestResponse, QueryBuilder, type QueryFilter, type RealtimeCallback, type RealtimeChangePayload, RealtimeChannel, type RealtimeMessage, type RealtimePostgresChangesPayload, type RequestOptions, type ResetUserPasswordResponse, type RevokeAPIKeyResponse, type RevokeInvitationResponse, type SESSettings, type SMTPSettings, type Schema, type SecuritySettings, type SendGridSettings, type SessionResponse, type SignInCredentials, type SignInWith2FAResponse, type SignUpCredentials, type SignedUrlOptions, type StartImpersonationResponse, type StopImpersonationResponse, StorageBucket, type StorageObject, type SupabaseAuthResponse, type SupabaseResponse, type SystemSetting, SystemSettingsManager, type Table, type TestEmailTemplateRequest, type TestWebhookResponse, type TwoFactorEnableResponse, type TwoFactorSetupResponse, type TwoFactorStatusResponse, type TwoFactorVerifyRequest, type UpdateAPIKeyRequest, type UpdateAppSettingsRequest, type UpdateAuthSettingsRequest, type UpdateAuthSettingsResponse, type UpdateEmailTemplateRequest, type UpdateFunctionRequest, type UpdateOAuthProviderRequest, type UpdateOAuthProviderResponse, type UpdateSystemSettingRequest, type UpdateUserRoleRequest, type UpdateWebhookRequest, type UploadOptions, type User, type UserResponse, type ValidateInvitationResponse, type VoidResponse, type Webhook, type WebhookDelivery, WebhooksManager, createClient };