@pubflow/react 0.4.6 → 0.4.8

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as _pubflow_core from '@pubflow/core';
-import { EntityData, BridgeApiService, EntityConfig, FilterOperator, FilterDefinition, PubflowInstanceConfig, ApiClient, AuthService, User, QueryParams, SearchParams, StorageAdapter } from '@pubflow/core';
+import { EntityData, BridgeApiService, EntityConfig, FilterOperator, FilterDefinition, PubflowInstanceConfig, ApiClient, AuthService, TwoFactorService, User, TwoFactorMethod, TwoFactorVerifyResult, TwoFactorStartResult, QueryParams, SearchParams, TwoFactorSetupResult, TwoFactorToggleResult, StorageAdapter } from '@pubflow/core';
 export * from '@pubflow/core';
+export { AddOrganizationMemberRequest, Address, AddressType, BridgePaymentClient, BridgePaymentConfig, CancelSubscriptionRequest, ConvertGuestToUserRequest, ConvertGuestToUserResponse, CreateAddressRequest, CreateCustomerRequest, CreateOrganizationRequest, CreatePaymentIntentRequest, CreateSubscriptionRequest, Customer, ListResponse, Organization, OrganizationMember, OrganizationRole, PaginationParams, Payment, PaymentIntent, PaymentMethod, PaymentMethodType, PaymentRequestOptions, Subscription, SubscriptionStatus, UpdateAddressRequest, UpdateCustomerRequest, UpdateOrganizationMemberRoleRequest, UpdateOrganizationRequest, UpdatePaymentMethodRequest } from '@pubflow/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { CSSProperties, ReactNode } from 'react';
 import { z } from 'zod';
@@ -403,7 +404,7 @@ interface BridgeTableProps<T extends EntityData> extends UseBridgeCrudOptions<T>
 /**
  * Component for displaying data in a table with sorting, filtering, and pagination
  */
-declare function BridgeTable<T extends EntityData>({ columns, showPagination, showSearch, showFilters, rowKey, onRowClick, className, loadingComponent, emptyComponent, errorComponent, paginationComponent, searchComponent, filterComponent, searchPlaceholder, actions, ...crudOptions }: BridgeTableProps<T>): string | number | true | Iterable<React.ReactNode> | react_jsx_runtime.JSX.Element;
+declare function BridgeTable<T extends EntityData>({ columns, showPagination, showSearch, showFilters, rowKey, onRowClick, className, loadingComponent, emptyComponent, errorComponent, paginationComponent, searchComponent, filterComponent, searchPlaceholder, actions, ...crudOptions }: BridgeTableProps<T>): string | number | bigint | true | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element;
 
 /**
  * Types for BridgeForm component
@@ -1284,6 +1285,7 @@ declare function createStyles(theme: ThemeConfig): {
 interface PubflowContextValue {
     instances: Record<string, PubflowInstance>;
     defaultInstance: string;
+    isReady: boolean;
 }
 /**
  * Pubflow instance
@@ -1292,9 +1294,12 @@ interface PubflowInstance {
     config: PubflowInstanceConfig;
     apiClient: ApiClient;
     authService: AuthService;
+    twoFactorService: TwoFactorService;
     user: User | null | undefined;
     isAuthenticated: boolean;
     isLoading: boolean;
+    twoFactorPending: boolean;
+    twoFactorMethods: TwoFactorMethod[];
     login: (credentials: {
         email?: string;
         userName?: string;
@@ -1306,28 +1311,13 @@ interface PubflowInstance {
         expiresAt?: string;
         user?: User;
     }>;
+    verifyTwoFactor: (methodId: string, code: string) => Promise<TwoFactorVerifyResult>;
+    startTwoFactor: (methodId: string, method: string) => Promise<TwoFactorStartResult>;
 }
 /**
  * Create Pubflow context
  */
 declare const PubflowContext: React.Context<PubflowContextValue>;
-/**
- * Persistent cache configuration
- */
-interface PersistentCacheConfig {
-    /**
-     * Whether to enable persistent cache
-     */
-    enabled: boolean;
-    /**
-     * Cache provider function
-     */
-    provider?: () => Map<any, any>;
-    /**
-     * Cache options
-     */
-    options?: any;
-}
 /**
  * Pubflow provider props
  */
@@ -1336,41 +1326,25 @@ interface PubflowProviderProps {
     config?: PubflowInstanceConfig;
     instances?: PubflowInstanceConfig[];
     defaultInstance?: string;
-    onSessionExpired?: () => void;
-    onSessionRefreshed?: () => void;
-    showSessionAlerts?: boolean;
-    /**
-     * Persistent cache configuration
-     */
-    persistentCache?: PersistentCacheConfig;
-    /**
-     * Login redirect path (for automatic redirects)
-     */
-    loginRedirectPath?: string;
-    /**
-     * Public paths that don't require authentication
-     */
-    publicPaths?: string[];
-    /**
-     * Enable debug tools
-     * When enabled, debug utilities will be available
-     * Default: false
-     */
     enableDebugTools?: boolean;
-    /**
-     * Theme configuration
-     */
+    showSessionAlerts?: boolean;
+    persistentCache?: {
+        enabled: boolean;
+        maxAge?: number;
+    };
     theme?: {
         primaryColor?: string;
         secondaryColor?: string;
         appName?: string;
-        logo?: string | React.ReactNode;
+        logo?: string;
     };
+    loginRedirectPath?: string;
+    publicPaths?: string[];
 }
 /**
- * Pubflow provider for React
+ * Pubflow Provider Component
  */
-declare function PubflowProvider({ children, config, instances, defaultInstance, onSessionExpired, onSessionRefreshed, showSessionAlerts, persistentCache, loginRedirectPath, publicPaths, enableDebugTools, theme }: PubflowProviderProps): react_jsx_runtime.JSX.Element | null;
+declare function PubflowProvider({ children, config, instances, defaultInstance, enableDebugTools, showSessionAlerts, persistentCache, theme, loginRedirectPath, publicPaths }: PubflowProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Authentication Hook for React
@@ -1385,6 +1359,10 @@ interface UseAuthResult {
     user: User | null;
     isAuthenticated: boolean;
     isLoading: boolean;
+    /** Whether the user is in the 2FA pending step (session is partial) */
+    twoFactorPending: boolean;
+    /** Available 2FA methods for the pending step */
+    twoFactorMethods: TwoFactorMethod[];
     login: (credentials: {
         email?: string;
         userName?: string;
@@ -1395,7 +1373,10 @@ interface UseAuthResult {
         isValid: boolean;
         expiresAt?: string;
     }>;
-    refreshUser: () => Promise<User | null>;
+    /** Submit a 2FA verification code to complete a pending login */
+    verifyTwoFactor: (methodId: string, code: string) => Promise<TwoFactorVerifyResult>;
+    /** (Re-)send a 2FA code for the given method */
+    startTwoFactor: (methodId: string, method: string) => Promise<TwoFactorStartResult>;
 }
 /**
  * Hook for accessing authentication functionality
@@ -1405,6 +1386,84 @@ interface UseAuthResult {
  */
 declare function useAuth(instanceId?: string): UseAuthResult;
 
+/**
+ * Authentication Guard Hook for React
+ *
+ * Framework-agnostic hook for handling authentication validation and redirects
+ */
+/**
+ * Authentication guard options
+ */
+interface UseAuthGuardOptions {
+    /**
+     * Whether to validate the session on mount
+     */
+    validateOnMount?: boolean;
+    /**
+     * User types allowed to access the page
+     */
+    allowedTypes?: string[];
+    /**
+     * Pubflow instance ID
+     */
+    instanceId?: string;
+    /**
+     * Custom redirect function (framework-specific)
+     */
+    onRedirect?: (path: string, reason: 'unauthenticated' | 'unauthorized' | 'session-expired') => void;
+    /**
+     * Custom session expired handler
+     */
+    onSessionExpired?: () => void;
+    /**
+     * Login redirect path
+     */
+    loginRedirectPath?: string;
+    /**
+     * Access denied redirect path
+     */
+    accessDeniedPath?: string;
+    /**
+     * Whether to show console warnings
+     */
+    enableLogging?: boolean;
+}
+/**
+ * Authentication guard result
+ */
+interface UseAuthGuardResult {
+    user: any;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    isAuthorized: boolean;
+    validateSession: () => Promise<{
+        isValid: boolean;
+        expiresAt?: string;
+        user?: any;
+    }>;
+    redirectReason: 'unauthenticated' | 'unauthorized' | 'session-expired' | null;
+}
+/**
+ * Hook for handling authentication validation and redirects
+ *
+ * This hook is framework-agnostic and requires the user to provide
+ * their own redirect function (e.g., Next.js router, React Router, etc.)
+ *
+ * @param options Hook options
+ * @returns Authentication guard result
+ */
+declare function useAuthGuard({ validateOnMount, allowedTypes, instanceId, onRedirect, onSessionExpired, loginRedirectPath, accessDeniedPath, enableLogging }?: UseAuthGuardOptions): UseAuthGuardResult;
+/**
+ * Simple authentication guard hook with automatic redirects
+ *
+ * This is a simplified version that uses window.location for redirects
+ * Suitable for simple React apps without complex routing
+ *
+ * @param options Hook options
+ * @returns Authentication guard result
+ */
+declare function useSimpleAuthGuard(options?: Omit<UseAuthGuardOptions, 'onRedirect'>): UseAuthGuardResult;
+
 /**
  * Bridge API Hook for React
  *
@@ -1556,50 +1615,55 @@ interface UseBridgeQueryResult<T extends EntityData, Q extends QueryType> {
 declare function useBridgeQuery<T extends EntityData, Q extends QueryType>(service: BridgeApiService<T>, type: Q, params: BridgeQueryParams<Q>, config?: SWRConfiguration): UseBridgeQueryResult<T, Q>;
 
 /**
- * Server Authentication Hook for React
+ * useTwoFactor Hook for React
  *
- * Provides a hook for handling authentication with automatic redirects
- */
-/**
- * Server authentication hook options
+ * Convenience hook for managing 2FA settings (setup, toggle, remove).
+ * For the LOGIN-TIME 2FA flow use useAuth() which surfaces
+ * twoFactorPending / verifyTwoFactor / startTwoFactor.
  */
-interface UseServerAuthOptions {
+
+interface UseTwoFactorResult {
+    /** Whether the 2FA system is globally enabled on this server */
+    systemEnabled: boolean;
+    /** Available methods on the server (e.g. ['email']) */
+    availableMethods: string[];
+    /** User's configured 2FA methods (status = active only) */
+    methods: TwoFactorMethod[];
+    isLoading: boolean;
+    error: string | null;
+    /** Load system info and user methods */
+    refresh: () => Promise<void>;
     /**
-     * Path to redirect to when not authenticated
+     * Step 1 of setup: register method + send verification code.
+     * Returns { success, method_id, status: 'pending_setup', ... }
      */
-    loginRedirectPath?: string;
+    setup: (method: string, identifier: string) => Promise<TwoFactorSetupResult>;
     /**
-     * User types allowed to access the page
+     * Step 2 of setup: confirm the code received → activates the method.
      */
-    allowedTypes?: string[];
+    confirmSetup: (methodId: string, method: string, code: string) => Promise<TwoFactorVerifyResult>;
     /**
-     * Whether to validate the session on mount
-     */
-    validateOnMount?: boolean;
-    /**
-     * Pubflow instance ID
+     * Enable or disable 2FA for the user.
+     * When disabling with existing methods a verification code is required.
      */
-    instanceId?: string;
+    toggle: (enabled: boolean, verificationCode?: string, verificationMethodId?: string) => Promise<TwoFactorToggleResult>;
     /**
-     * Custom redirect function
+     * Remove a 2FA method. Requires a verification code from another active method.
      */
-    onRedirect?: (path: string) => void;
+    removeMethod: (methodId: string, verificationCode: string, verificationMethodId: string) => Promise<{
+        success: boolean;
+        message?: string;
+        error?: string;
+    }>;
 }
 /**
- * Hook for handling authentication with automatic redirects
+ * Hook for managing 2FA settings.
  *
- * @param options Hook options
- * @returns Authentication hook result
+ * Must be used inside a PubflowProvider.
+ *
+ * @param instanceId Optional Pubflow instance ID
  */
-declare function useServerAuth({ loginRedirectPath, allowedTypes, validateOnMount, instanceId, onRedirect }?: UseServerAuthOptions): {
-    user: _pubflow_core.User | null;
-    isAuthenticated: boolean;
-    isLoading: boolean;
-    validateSession: () => Promise<{
-        isValid: boolean;
-        expiresAt?: string;
-    }>;
-};
+declare function useTwoFactor(instanceId?: string): UseTwoFactorResult;
 
 /**
  * Search Query Builder Hook for React
@@ -1905,4 +1969,4 @@ declare function useRequireAuth(options?: UseRequireAuthOptions): {
     isLoading: boolean;
 };
 
-export { AccountCreationForm, AccountCreationFormConfig, AccountCreationFormProps, AdvancedFilter, AdvancedFilterColors, AdvancedFilterProps, AdvancedFilterTexts, BridgeForm, BridgeFormProps, BridgeList, BridgeListColors, BridgeListLayout, BridgeListProps, BridgeListRenderItemProps, BridgeListTexts, BridgeTable, BridgeTableProps, BridgeView, BridgeViewProps, BrowserStorageAdapter, BrowserStorageOptions, ColumnDef, FieldConfig, FieldRenderProps, FilterField, LoginForm, LoginFormConfig, LoginFormProps, MutationOptions, OfflineIndicator, OfflineIndicatorProps, PasswordResetForm, PasswordResetFormConfig, PasswordResetFormProps, PersistentCacheConfig, PubflowContext, PubflowContextValue, PubflowInstance, PubflowProvider, PubflowProviderProps, RawApiRequestOptions, RawApiResponse, SearchField, SearchQueryState, ThemeConfig, ThemeProvider, ThemeProviderProps, UseAuthResult, UseBridgeApiRawResult, UseBridgeMutationResult, UseBridgeQueryResult, UseRequireAuthOptions, UseSearchQueryBuilderResult, UseServerAuthOptions, createStyles, generateCSSVariables, useAuth, useBridgeApi, useBridgeApiRaw, useBridgeCrud, useBridgeMutation, useBridgeQuery, useNetworkStatus, useRequireAuth, useSearchQueryBuilder, useServerAuth, useTheme };
+export { AccountCreationForm, AccountCreationFormConfig, AccountCreationFormProps, AdvancedFilter, AdvancedFilterColors, AdvancedFilterProps, AdvancedFilterTexts, BridgeForm, BridgeFormProps, BridgeList, BridgeListColors, BridgeListLayout, BridgeListProps, BridgeListRenderItemProps, BridgeListTexts, BridgeTable, BridgeTableProps, BridgeView, BridgeViewProps, BrowserStorageAdapter, BrowserStorageOptions, ColumnDef, FieldConfig, FieldRenderProps, FilterField, LoginForm, LoginFormConfig, LoginFormProps, MutationOptions, OfflineIndicator, OfflineIndicatorProps, PasswordResetForm, PasswordResetFormConfig, PasswordResetFormProps, PubflowContext, PubflowContextValue, PubflowInstance, PubflowProvider, PubflowProviderProps, RawApiRequestOptions, RawApiResponse, SearchField, SearchQueryState, ThemeConfig, ThemeProvider, ThemeProviderProps, UseAuthGuardOptions, UseAuthGuardResult, UseAuthResult, UseBridgeApiRawResult, UseBridgeMutationResult, UseBridgeQueryResult, UseRequireAuthOptions, UseSearchQueryBuilderResult, UseTwoFactorResult, createStyles, generateCSSVariables, useAuth, useAuthGuard, useBridgeApi, useBridgeApiRaw, useBridgeCrud, useBridgeMutation, useBridgeQuery, useNetworkStatus, useRequireAuth, useSearchQueryBuilder, useSimpleAuthGuard, useTheme, useTwoFactor };

package/dist/index.esm.js

@@ -10142,6 +10142,27 @@ function useTwoFactor(instanceId) {
             setIsLoading(false);
         }
     }, [instance, refresh]);
+    const confirmSetup = useCallback(async (methodId, method, code) => {
+        if (!instance)
+            return { success: false, verified: false, error: 'Pubflow not initialized' };
+        setIsLoading(true);
+        setError(null);
+        try {
+            // action='setup' activates a pending_setup method in the DB
+            const result = await instance.twoFactorService.verify(methodId, code, 'setup');
+            if (result.verified)
+                await refresh();
+            return result;
+        }
+        catch (e) {
+            const msg = (e === null || e === void 0 ? void 0 : e.message) || 'Confirmation failed';
+            setError(msg);
+            return { success: false, verified: false, error: msg };
+        }
+        finally {
+            setIsLoading(false);
+        }
+    }, [instance, refresh]);
     return {
         systemEnabled,
         availableMethods,
@@ -10150,6 +10171,7 @@ function useTwoFactor(instanceId) {
         error,
         refresh,
         setup,
+        confirmSetup,
         toggle,
         removeMethod,
     };