@buildbase/sdk 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -2,6 +2,113 @@ import * as react from 'react';
 import react__default, { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+interface IDocument {
+    _id: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deleted: boolean;
+}
+interface IUser extends IDocument {
+    _id: string;
+    name: string;
+    email: string;
+    image: string;
+    role: string;
+    country: string;
+    timezone: string;
+    language: string;
+    currency: string;
+}
+
+interface IWorkspace {
+    _id: string;
+    name: string;
+    image?: string;
+    workspaceId: string;
+    users: IUser[];
+    roles: string[];
+    createdBy: string | IUser;
+    features: Record<string, boolean>;
+}
+interface IWorkspaceFeature {
+    _id: string;
+    name: string;
+    description: string;
+    userManaged: boolean;
+    defaultValue: boolean;
+    slug: string;
+    category: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface IWorkspaceUser {
+    _id: string;
+    workspace: string | IWorkspace;
+    user: string | IUser;
+    role: string;
+}
+
+/**
+ * Event types for all SDK events
+ */
+type EventType = 'user:created' | 'user:updated' | 'workspace:changed' | 'workspace:updated' | 'workspace:user-added' | 'workspace:user-removed' | 'workspace:user-role-changed' | 'workspace:created' | 'workspace:deleted';
+/**
+ * Event data types for each event
+ */
+interface UserCreatedEventData {
+    user: IUser;
+}
+interface UserUpdatedEventData {
+    user: IUser;
+    previousUser?: IUser;
+}
+interface WorkspaceChangedEventData {
+    workspace: IWorkspace;
+    previousWorkspace?: IWorkspace | null;
+}
+interface WorkspaceUpdatedEventData {
+    workspace: IWorkspace;
+}
+interface WorkspaceUserAddedEventData {
+    userId: string;
+    workspace: IWorkspace;
+    role: string;
+}
+interface WorkspaceUserRemovedEventData {
+    userId: string;
+    workspace: IWorkspace;
+    role: string;
+}
+interface WorkspaceUserRoleChangedEventData {
+    userId: string;
+    workspace: IWorkspace;
+    previousRole: string;
+    newRole: string;
+}
+interface WorkspaceCreatedEventData {
+    workspace: IWorkspace;
+}
+interface WorkspaceDeletedEventData {
+    workspace: IWorkspace;
+}
+/**
+ * Union type for all event data
+ */
+type EventData = UserCreatedEventData | UserUpdatedEventData | WorkspaceChangedEventData | WorkspaceUpdatedEventData | WorkspaceUserAddedEventData | WorkspaceUserRemovedEventData | WorkspaceUserRoleChangedEventData | WorkspaceCreatedEventData | WorkspaceDeletedEventData;
+/**
+ * Single event callback function
+ * Handles all events with conditional logic based on event type
+ */
+interface IEventCallbacks {
+    /**
+     * Called when any event occurs
+     * @param eventType - The type of event that occurred
+     * @param data - The event data (type varies based on eventType)
+     */
+    handleEvent?: (eventType: EventType, data: EventData) => void | Promise<void>;
+}
+
 declare enum AuthStatus {
     loading = "loading",
     authenticated = "authenticated",
@@ -20,7 +127,7 @@ interface AuthUser {
 }
 interface AuthSession {
     user: AuthUser;
-    accessToken: string;
+    sessionId: string;
     expires: string;
 }
 interface IAuthConfig {
@@ -29,17 +136,42 @@ interface IAuthConfig {
     callbacks?: IAuthCallbacks;
 }
 interface IAuthCallbacks {
-    handleAuthentication: (token: string) => Promise<void>;
-    verifyToken: (token: string) => Promise<boolean>;
+    handleAuthentication: (code: string) => Promise<{
+        sessionId: string;
+    }>;
+    onSignOut: () => Promise<void>;
+    /**
+     * Event handler for User and Workspace events
+     * @param eventType - The type of event that occurred
+     * @param data - The event data (type varies based on eventType)
+     */
+    handleEvent?: (eventType: EventType, data: EventData) => void | Promise<void>;
+}
+
+interface ISettings {
+    workspace: {
+        roles: string[];
+        defaultRole: string;
+        maxWorkspaces: number;
+        maxWorkspaceUsers: number;
+    };
+    [key: string]: any;
 }
 
+/**
+ * Supported API versions
+ */
+declare enum ApiVersion {
+    V1 = "v1"
+}
 interface IOsConfig {
     serverUrl: string;
-    version: string;
+    version: ApiVersion;
     orgId: string;
 }
 interface IOsState extends IOsConfig {
     auth?: IAuthConfig;
+    settings?: ISettings | null;
 }
 
 interface SaaSOSProviderProps extends IOsState {
@@ -92,7 +224,7 @@ declare const WhenWorkspaceFeatureEnabled: (props: IProps) => react.ReactNode;
 declare const WhenWorkspaceFeatureDisabled: (props: IProps) => react.ReactNode;
 
 declare function useSaaSAuth(): {
-    user: AuthUser | null;
+    user: AuthUser | undefined;
     session: AuthSession | null;
     isLoading: boolean;
     isAuthenticated: boolean;
@@ -102,52 +234,10 @@ declare function useSaaSAuth(): {
     signOut: () => Promise<void>;
 };
 
-interface IDocument {
-    _id: string;
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    deleted: boolean;
-}
-interface IUser extends IDocument {
-    _id: string;
-    name: string;
-    email: string;
-    image: string;
-    role: string;
-    country: string;
-    timezone: string;
-    language: string;
-    currency: string;
-}
-
-interface IWorkspace {
-    _id: string;
-    name: string;
-    image?: string;
-    workspaceId: string;
-    users: IUser[];
-    roles: string[];
-    createdBy: string | IUser;
-    features: Record<string, boolean>;
-}
-interface IWorkspaceFeature {
-    _id: string;
-    name: string;
-    description: string;
-    userManaged: boolean;
-    defaultValue: boolean;
-    slug: string;
-    category: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface IWorkspaceUser {
-    _id: string;
-    workspace: string | IWorkspace;
-    user: string | IUser;
-    role: string;
-}
+declare function useSaaSSettings(): {
+    settings: ISettings | null | undefined;
+    getSettings: () => Promise<ISettings | null>;
+};
 
 declare function WorkspaceSwitcher(props: {
     trigger: (isLoading: boolean, currentWorkspace: IWorkspace | null) => ReactNode;
@@ -173,13 +263,106 @@ declare const useSaaSWorkspaces: () => {
     switching: boolean;
     updateWorkspace: (ws: IWorkspace, _data: Partial<IWorkspace>) => Promise<void>;
     getUsers: (workspaceId: string) => Promise<IWorkspaceUser[]>;
-    addUser: (workspaceId: string, email: string, role: string) => Promise<IWorkspaceUser>;
+    addUser: (workspaceId: string, email: string, role: string) => Promise<{
+        userId: string;
+        workspace: IWorkspace;
+        message: string;
+    }>;
     removeUser: (workspaceId: string, userId: string) => Promise<{
-        success: boolean;
+        userId: string;
+        workspace: IWorkspace;
+        message: string;
+    }>;
+    updateUser: (workspaceId: string, userId: string, config: Partial<IWorkspaceUser>) => Promise<{
+        userId: string;
+        workspace: IWorkspace;
+        message: string;
     }>;
-    updateUser: (workspaceId: string, userId: string, config: Partial<IWorkspaceUser>) => Promise<IWorkspaceUser>;
     getProfile: () => Promise<IUser>;
     updateUserProfile: (config: Partial<IUser>) => Promise<IUser>;
+    deleteWorkspace: (workspaceId: string) => Promise<{
+        success: boolean;
+    }>;
 };
 
-export { BetaForm, SaaSOSProvider, WhenAuthenticated, WhenRoles, WhenUnauthenticated, WhenWorkspaceFeatureDisabled, WhenWorkspaceFeatureEnabled, WhenWorkspaceRoles, WorkspaceSwitcher, useSaaSAuth, useSaaSWorkspaces };
+/**
+ * EventEmitter class to handle and trigger event callbacks
+ * This class manages all event listeners and provides methods to trigger events
+ */
+declare class EventEmitter {
+    private callbacks;
+    /**
+     * Set the event callbacks
+     * @param callbacks - The event callbacks to register
+     */
+    setCallbacks(callbacks: IEventCallbacks | null): void;
+    /**
+     * Get the current event callbacks
+     * @returns The current event callbacks or null
+     */
+    getCallbacks(): IEventCallbacks | null;
+    /**
+     * Emit an event
+     * @param eventType - The type of event
+     * @param data - The event data
+     */
+    private emit;
+    /**
+     * Trigger user created event
+     * @param user - The newly created user
+     */
+    emitUserCreated(user: IUser): Promise<void>;
+    /**
+     * Trigger user updated event
+     * @param user - The updated user
+     * @param previousUser - The user data before the update (optional)
+     */
+    emitUserUpdated(user: IUser, previousUser?: IUser): Promise<void>;
+    /**
+     * Trigger workspace changed event
+     * @param workspace - The newly selected workspace
+     * @param previousWorkspace - The previously selected workspace (optional)
+     */
+    emitWorkspaceChanged(workspace: IWorkspace, previousWorkspace?: IWorkspace | null): Promise<void>;
+    /**
+     * Trigger workspace updated event
+     * @param workspace - The updated workspace
+     */
+    emitWorkspaceUpdated(workspace: IWorkspace): Promise<void>;
+    /**
+     * Trigger workspace user added event
+     * @param userId - The ID of the user that was added
+     * @param workspace - The workspace the user was added to
+     * @param role - The role assigned to the user
+     */
+    emitWorkspaceUserAdded(userId: string, workspace: IWorkspace, role: string): Promise<void>;
+    /**
+     * Trigger workspace user removed event
+     * @param userId - The ID of the user that was removed
+     * @param workspace - The workspace the user was removed from
+     * @param role - The role the user had in the workspace
+     */
+    emitWorkspaceUserRemoved(userId: string, workspace: IWorkspace, role: string): Promise<void>;
+    /**
+     * Trigger workspace user role changed event
+     * @param userId - The ID of the user whose role was changed
+     * @param workspace - The workspace where the role was changed
+     * @param previousRole - The previous role of the user
+     * @param newRole - The new role of the user
+     */
+    emitWorkspaceUserRoleChanged(userId: string, workspace: IWorkspace, previousRole: string, newRole: string): Promise<void>;
+    /**
+     * Trigger workspace created event
+     * @param workspace - The newly created workspace
+     */
+    emitWorkspaceCreated(workspace: IWorkspace): Promise<void>;
+    /**
+     * Trigger workspace deleted event
+     * @param workspace - The deleted workspace
+     */
+    emitWorkspaceDeleted(workspace: IWorkspace): Promise<void>;
+}
+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 };