@buildbase/sdk 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import react__default, { ReactNode } from 'react';
+import react__default, { ReactNode, Component } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 interface IDocument {
@@ -19,6 +19,7 @@ interface IUser extends IDocument {
     timezone: string;
     language: string;
     currency: string;
+    attributes?: Record<string, string | number | boolean>;
 }
 
 interface IWorkspace {
@@ -222,6 +223,8 @@ interface IProps {
 }
 declare const WhenWorkspaceFeatureEnabled: (props: IProps) => react.ReactNode;
 declare const WhenWorkspaceFeatureDisabled: (props: IProps) => react.ReactNode;
+declare const WhenUserFeatureEnabled: (props: IProps) => react.ReactNode;
+declare const WhenUserFeatureDisabled: (props: IProps) => react.ReactNode;
 
 declare function useSaaSAuth(): {
     user: AuthUser | undefined;
@@ -232,6 +235,7 @@ declare function useSaaSAuth(): {
     status: AuthStatus;
     signIn: () => Promise<void>;
     signOut: () => Promise<void>;
+    openWorkspaceSettings: (section?: "profile" | "general" | "users" | "features" | "danger") => void;
 };
 
 declare function useSaaSSettings(): {
@@ -239,6 +243,31 @@ declare function useSaaSSettings(): {
     getSettings: () => Promise<ISettings | null>;
 };
 
+interface UserContextValue {
+    attributes: Record<string, string | number | boolean>;
+    features: Record<string, boolean>;
+    isLoading: boolean;
+    error: Error | null;
+    updateAttributes: (updates: Record<string, string | number | boolean>) => Promise<IUser>;
+    updateAttribute: (attributeKey: string, value: string | number | boolean) => Promise<IUser>;
+    refreshAttributes: () => Promise<void>;
+    refreshFeatures: () => Promise<void>;
+}
+
+declare function useUserAttributes(): UserContextValue;
+declare function useUserFeatures(): {
+    features: Record<string, boolean>;
+    isLoading: boolean;
+    error: Error | null;
+    refreshFeatures: () => Promise<void>;
+    isFeatureEnabled: (featureId: string) => boolean;
+};
+
+declare function WorkspaceSwitcher(props: {
+    trigger: (isLoading: boolean, currentWorkspace: IWorkspace | null) => ReactNode;
+    onWorkspaceChange: (workspace: IWorkspace) => Promise<void>;
+}): react_jsx_runtime.JSX.Element;
+
 declare const useSaaSWorkspaces: () => {
     workspaces: IWorkspace[];
     loading: boolean;
@@ -246,6 +275,7 @@ declare const useSaaSWorkspaces: () => {
     fetchWorkspaces: () => Promise<void>;
     refreshWorkspaces: () => Promise<void>;
     refreshing: boolean;
+    WorkspaceSwitcher: typeof WorkspaceSwitcher;
     currentWorkspace: IWorkspace | null;
     setCurrentWorkspace: (ws: IWorkspace) => void;
     resetCurrentWorkspace: () => void;
@@ -279,11 +309,6 @@ declare const useSaaSWorkspaces: () => {
     }>;
 };
 
-declare function WorkspaceSwitcher(props: {
-    trigger: (isLoading: boolean, currentWorkspace: IWorkspace | null) => ReactNode;
-    onWorkspaceChange: (workspace: IWorkspace) => Promise<void>;
-}): react_jsx_runtime.JSX.Element;
-
 /**
  * EventEmitter class to handle and trigger event callbacks
  * This class manages all event listeners and provides methods to trigger events
@@ -363,5 +388,98 @@ declare class EventEmitter {
 }
 declare const eventEmitter: EventEmitter;
 
-export { ApiVersion, BetaForm, SaaSOSProvider, WhenAuthenticated, WhenRoles, WhenUnauthenticated, WhenWorkspaceFeatureDisabled, WhenWorkspaceFeatureEnabled, WhenWorkspaceRoles, WorkspaceSwitcher, eventEmitter, useSaaSAuth, useSaaSSettings, useSaaSWorkspaces };
-export type { EventData, EventType, IEventCallbacks, UserCreatedEventData, UserUpdatedEventData, WorkspaceChangedEventData, WorkspaceCreatedEventData, WorkspaceDeletedEventData, WorkspaceUpdatedEventData, WorkspaceUserAddedEventData, WorkspaceUserRemovedEventData, WorkspaceUserRoleChangedEventData };
+interface ErrorBoundaryProps {
+    children: ReactNode;
+    /**
+     * Fallback UI to render when an error occurs
+     */
+    fallback?: ReactNode | ((error: Error, resetError: () => void) => ReactNode);
+    /**
+     * Called when an error is caught
+     */
+    onError?: (error: Error, errorInfo: react__default.ErrorInfo) => void;
+    /**
+     * Whether to reset error state when children change
+     * @default true
+     */
+    resetOnPropsChange?: boolean;
+}
+interface ErrorBoundaryState {
+    hasError: boolean;
+    error: Error | null;
+}
+/**
+ * Error Boundary component for catching React component errors
+ * Wraps SDK components to prevent crashes from propagating
+ */
+declare class SDKErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: react__default.ErrorInfo): void;
+    componentDidUpdate(prevProps: ErrorBoundaryProps): void;
+    resetError: () => void;
+    render(): ReactNode;
+}
+
+/**
+ * Centralized Error Handler for SDK
+ * Provides consistent error handling, logging, and user-facing error management
+ */
+interface SDKErrorContext {
+    component?: string;
+    action?: string;
+    metadata?: Record<string, unknown>;
+}
+declare class SDKError extends Error {
+    readonly code?: string | undefined;
+    readonly context?: SDKErrorContext | undefined;
+    readonly originalError?: Error | undefined;
+    constructor(message: string, code?: string | undefined, context?: SDKErrorContext | undefined, originalError?: Error | undefined);
+}
+interface ErrorHandlerConfig {
+    /**
+     * Custom error callback for handling errors
+     * @param error - The error that occurred
+     * @param context - Additional context about where the error occurred
+     */
+    onError?: (error: Error, context: SDKErrorContext) => void;
+    /**
+     * Whether to log errors to console in development
+     * @default true
+     */
+    enableConsoleLogging?: boolean;
+    /**
+     * Whether to show user-facing error notifications
+     * @default false
+     */
+    showUserNotifications?: boolean;
+}
+declare class ErrorHandler {
+    private config;
+    /**
+     * Configure the error handler
+     */
+    configure(config: Partial<ErrorHandlerConfig>): void;
+    /**
+     * Handle an error with context
+     */
+    handleError(error: Error | unknown, context?: SDKErrorContext): void;
+    /**
+     * Notify user of error (placeholder for notification system)
+     */
+    private notifyUser;
+    /**
+     * Create a safe error handler wrapper for async functions
+     */
+    wrapAsync<T extends (...args: any[]) => Promise<any>>(fn: T, context: SDKErrorContext): T;
+    /**
+     * Create a safe error handler wrapper for sync functions
+     */
+    wrapSync<T extends (...args: any[]) => any>(fn: T, context: SDKErrorContext): T;
+}
+declare const errorHandler: ErrorHandler;
+declare function handleError(error: Error | unknown, context?: SDKErrorContext): void;
+declare function createSDKError(message: string, code?: string, context?: SDKErrorContext, originalError?: Error): SDKError;
+
+export { ApiVersion, BetaForm, SDKErrorBoundary as ErrorBoundary, SDKError, SDKErrorBoundary, SaaSOSProvider, WhenAuthenticated, WhenRoles, WhenUnauthenticated, WhenUserFeatureDisabled, WhenUserFeatureEnabled, WhenWorkspaceFeatureDisabled, WhenWorkspaceFeatureEnabled, WhenWorkspaceRoles, WorkspaceSwitcher, createSDKError, errorHandler, eventEmitter, handleError, useSaaSAuth, useSaaSSettings, useSaaSWorkspaces, useUserAttributes, useUserFeatures };
+export type { ErrorHandlerConfig, EventData, EventType, IEventCallbacks, SDKErrorContext, UserCreatedEventData, UserUpdatedEventData, WorkspaceChangedEventData, WorkspaceCreatedEventData, WorkspaceDeletedEventData, WorkspaceUpdatedEventData, WorkspaceUserAddedEventData, WorkspaceUserRemovedEventData, WorkspaceUserRoleChangedEventData };