@buildbase/sdk 0.0.23 → 0.0.25

package/dist/types/providers/constants.d.ts

@@ -1,3 +0,0 @@
-export declare const AUTH_TOKEN_PARAM = "code";
-export declare const AUTH_SESSION_ID_KEY = "saas-session-id";
-export declare const WORKSPACE_STORAGE_KEY = "saas-workspace-current";

package/dist/types/providers/events/EventEmitter.d.ts

@@ -1,81 +0,0 @@
-import type { IUser } from '../../api/types';
-import type { IWorkspace } from '../workspace/types';
-import type { IEventCallbacks } from './types';
-/**
- * EventEmitter class to handle and trigger event callbacks
- * This class manages all event listeners and provides methods to trigger events
- */
-export 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>;
-}
-export declare const eventEmitter: EventEmitter;

package/dist/types/providers/events/index.d.ts

@@ -1,2 +0,0 @@
-export { EventEmitter, eventEmitter } from './EventEmitter';
-export type { EventData, EventType, IEventCallbacks, UserCreatedEventData, UserUpdatedEventData, WorkspaceChangedEventData, WorkspaceCreatedEventData, WorkspaceDeletedEventData, WorkspaceUpdatedEventData, WorkspaceUserAddedEventData, WorkspaceUserRemovedEventData, WorkspaceUserRoleChangedEventData, } from './types';

package/dist/types/providers/events/types.d.ts

@@ -1,61 +0,0 @@
-import type { IUser } from '../../api/types';
-import type { IWorkspace } from '../workspace/types';
-/**
- * Event types for all SDK events
- */
-export 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
- */
-export interface UserCreatedEventData {
-    user: IUser;
-}
-export interface UserUpdatedEventData {
-    user: IUser;
-    previousUser?: IUser;
-}
-export interface WorkspaceChangedEventData {
-    workspace: IWorkspace;
-    previousWorkspace?: IWorkspace | null;
-}
-export interface WorkspaceUpdatedEventData {
-    workspace: IWorkspace;
-}
-export interface WorkspaceUserAddedEventData {
-    userId: string;
-    workspace: IWorkspace;
-    role: string;
-}
-export interface WorkspaceUserRemovedEventData {
-    userId: string;
-    workspace: IWorkspace;
-    role: string;
-}
-export interface WorkspaceUserRoleChangedEventData {
-    userId: string;
-    workspace: IWorkspace;
-    previousRole: string;
-    newRole: string;
-}
-export interface WorkspaceCreatedEventData {
-    workspace: IWorkspace;
-}
-export interface WorkspaceDeletedEventData {
-    workspace: IWorkspace;
-}
-/**
- * Union type for all event data
- */
-export 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
- */
-export 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>;
-}

package/dist/types/providers/os/api.d.ts

@@ -1,11 +0,0 @@
-/**
- * Centralized API client for organization (OS) settings.
- * Extends BaseApi for shared URL/auth/request handling.
- */
-import { BaseApi } from '../../lib/api-base';
-import type { ISettings } from '../types';
-import type { IOsConfig } from './types';
-export declare class SettingsApi extends BaseApi {
-    constructor(config: IOsConfig);
-    getSettings(signal?: AbortSignal): Promise<ISettings>;
-}

package/dist/types/providers/os/hooks.d.ts

@@ -1,50 +0,0 @@
-import type { ISettings } from '../types';
-import { type IOsState } from './types';
-/**
- * Hook to access OS (organization) state (serverUrl, version, orgId, auth, settings).
- * Prefer useSaaSSettings() when you only need settings.
- */
-export declare function useSaaSOs(): IOsState;
-/**
- * Hook to access organization settings from the OS context.
- * Automatically fetches settings when OS config is ready.
- *
- * @returns An object containing:
- * - `settings`: Organization settings object (null if not loaded)
- * - `getSettings(signal?)`: Function to manually fetch settings (supports AbortSignal)
- *
- * @example
- * ```tsx
- * function SettingsDisplay() {
- *   const { settings } = useSaaSSettings();
- *
- *   if (!settings) return <Loading />;
- *
- *   return (
- *     <div>
- *       <p>Organization: {settings.name}</p>
- *       <p>Theme: {settings.theme}</p>
- *     </div>
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Manual fetch with abort signal
- * function SettingsLoader() {
- *   const { getSettings } = useSaaSSettings();
- *
- *   useEffect(() => {
- *     const controller = new AbortController();
- *     getSettings(controller.signal);
- *
- *     return () => controller.abort();
- *   }, [getSettings]);
- * }
- * ```
- */
-export declare function useSaaSSettings(): {
-    settings: ISettings | null | undefined;
-    getSettings: (signal?: AbortSignal) => Promise<ISettings | null>;
-};

package/dist/types/providers/os/types.d.ts

@@ -1,19 +0,0 @@
-import { IAuthConfig } from '../auth/types';
-import type { ISettings } from '../types';
-/**
- * Supported API versions
- */
-export declare enum ApiVersion {
-    V1 = "v1"
-}
-export interface IOsConfig {
-    serverUrl: string;
-    version: ApiVersion;
-    orgId: string;
-}
-/** True when OS config has serverUrl, version, and orgId (ready for API calls). */
-export declare function isOsConfigReady(config: Pick<IOsConfig, 'serverUrl' | 'version' | 'orgId'> | null | undefined): boolean;
-export interface IOsState extends IOsConfig {
-    auth?: IAuthConfig;
-    settings?: ISettings | null;
-}

package/dist/types/providers/types.d.ts

@@ -1,9 +0,0 @@
-export interface ISettings {
-    workspace: {
-        roles: string[];
-        defaultRole: string;
-        maxWorkspaces: number;
-        maxWorkspaceUsers: number;
-    };
-    [key: string]: any;
-}

package/dist/types/providers/user/api.d.ts

@@ -1,16 +0,0 @@
-import { IUser } from '../../api/types';
-import { BaseApi } from '../../lib/api-base';
-import type { IOsConfig } from '../os/types';
-/**
- * Centralized API client for user attributes and features.
- * Extends BaseApi for shared URL/auth/request handling.
- */
-export declare class UserApi extends BaseApi {
-    constructor(config: Pick<IOsConfig, 'serverUrl' | 'version'>);
-    getAttributes(signal?: AbortSignal): Promise<Record<string, string | number | boolean>>;
-    updateAttributes(updates: Record<string, string | number | boolean>): Promise<IUser>;
-    updateAttribute(attributeKey: string, value: string | number | boolean): Promise<IUser>;
-    getFeatures(signal?: AbortSignal): Promise<Record<string, boolean>>;
-}
-/** Memoized UserApi instance. Recreates only when serverUrl or version change. BaseApi.ensureReady() throws if config is not set. */
-export declare function useUserApi(): UserApi;

package/dist/types/providers/user/hooks.d.ts

@@ -1,80 +0,0 @@
-export { useUserApi } from './api';
-/**
- * Hook to access user attributes from the UserProvider.
- * Must be used within a UserProvider component.
- *
- * @returns User context object containing:
- * - `attributes`: Record of user attribute key-value pairs
- * - `isLoading`: Boolean indicating if attributes are being loaded
- * - `error`: Error message string (null if no error)
- * - `refreshAttributes()`: Function to manually refresh attributes
- *
- * @throws {Error} If used outside of UserProvider
- *
- * @example
- * ```tsx
- * function UserProfile() {
- *   const { attributes, isLoading } = useUserAttributes();
- *
- *   if (isLoading) return <Loading />;
- *
- *   return (
- *     <div>
- *       <p>Plan: {attributes?.plan}</p>
- *       <p>Company: {attributes?.company}</p>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function useUserAttributes(): import("./provider").UserContextValue;
-/**
- * Hook to access user feature flags from the UserProvider.
- * Must be used within a UserProvider component.
- *
- * @returns An object containing:
- * - `features`: Record of feature flag key-value pairs (boolean values)
- * - `isLoading`: Boolean indicating if features are being loaded
- * - `error`: Error message string (null if no error)
- * - `refreshFeatures()`: Function to manually refresh features
- * - `isFeatureEnabled(featureId)`: Function to check if a specific feature is enabled
- *
- * @throws {Error} If used outside of UserProvider
- *
- * @example
- * ```tsx
- * function FeatureContent() {
- *   const { isFeatureEnabled, isLoading } = useUserFeatures();
- *
- *   if (isLoading) return <Loading />;
- *
- *   if (isFeatureEnabled('premium-feature')) {
- *     return <PremiumFeature />;
- *   }
- *
- *   return <BasicFeature />;
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Check multiple features
- * function Dashboard() {
- *   const { isFeatureEnabled } = useUserFeatures();
- *
- *   return (
- *     <div>
- *       {isFeatureEnabled('analytics') && <Analytics />}
- *       {isFeatureEnabled('reports') && <Reports />}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function useUserFeatures(): {
-    features: Record<string, boolean>;
-    isLoading: boolean;
-    error: Error | null;
-    refreshFeatures: () => Promise<void>;
-    isFeatureEnabled: (featureId: string) => boolean;
-};

package/dist/types/providers/user/provider.d.ts

@@ -1,17 +0,0 @@
-import React from 'react';
-import { IUser } from '../../api/types';
-export 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 const UserContext: React.Context<UserContextValue | undefined>;
-export declare const UserProvider: React.FC<{
-    children: React.ReactNode;
-}>;
-export { UserContext };

package/dist/types/providers/workspace/WorkspaceSettingsProvider.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-/**
- * WorkspaceSettingsProvider
- * Renders the settings dialog and manages its state internally
- * Users can call openWorkspaceSettings() from useWorkspaceSettings hook
- */
-export declare const WorkspaceSettingsProvider: React.FC<{
-    children: React.ReactNode;
-}>;

package/dist/types/providers/workspace/api.d.ts

@@ -1,155 +0,0 @@
-import { IAllQuotaUsageResponse, CheckoutResult, ICheckoutSessionRequest, ICheckoutSessionResponse, IInvoiceListResponse, IInvoiceResponse, IPlanGroupResponse, IPlanGroupVersion, IPlanGroupVersionsResponse, IPublicPlansResponse, IQuotaUsageStatusResponse, IRecordUsageRequest, IRecordUsageResponse, ISubscriptionResponse, ISubscriptionUpdateRequest, ISubscriptionUpdateResponse, IUsageLogsQuery, IUsageLogsResponse, IUser } from '../../api/types';
-import { BaseApi } from '../../lib/api-base';
-import { IOsConfig } from '../os/types';
-import type { IWorkspace, IWorkspaceFeature, IWorkspaceUser } from './types';
-export declare class WorkspaceApi extends BaseApi {
-    constructor(config: IOsConfig);
-    getWorkspaces(): Promise<IWorkspace[]>;
-    createWorkspace(data: {
-        name: string;
-        image?: string;
-    }): Promise<IWorkspace>;
-    updateWorkspace(id: string, data: Partial<IWorkspace>): Promise<IWorkspace>;
-    deleteWorkspace(id: string): Promise<{
-        success: boolean;
-    }>;
-    getWorkspaceUsers(workspaceId: string): Promise<IWorkspaceUser[]>;
-    addUser(workspaceId: string, config: {
-        email: string;
-        role: string;
-    }): Promise<{
-        userId: string;
-        workspace: IWorkspace;
-        message: string;
-    }>;
-    removeUser(workspaceId: string, userId: string): Promise<{
-        userId: string;
-        workspace: IWorkspace;
-        message: string;
-    }>;
-    updateUser(workspaceId: string, userId: string, data: Partial<IWorkspaceUser>): Promise<{
-        userId: string;
-        workspace: IWorkspace;
-        message: string;
-    }>;
-    getFeatures(): Promise<IWorkspaceFeature[]>;
-    updateFeature(workspaceId: string, key: string, value: boolean): Promise<IWorkspace>;
-    getWorkspace(workspaceId: string): Promise<IWorkspace>;
-    getProfile(): Promise<IUser>;
-    updateUserProfile(config: Partial<IUser>): Promise<IUser>;
-    /**
-     * Get current subscription for a workspace
-     * Returns subscription details including plan, plan version, and group information
-     */
-    getCurrentSubscription(workspaceId: string): Promise<ISubscriptionResponse>;
-    /**
-     * Get plan group for a workspace
-     * Returns the plan group containing the current plan if subscription exists,
-     * otherwise returns the latest published group
-     */
-    getPlanGroup(workspaceId: string): Promise<IPlanGroupResponse>;
-    /**
-     * Get plan group for a workspace with a specific version
-     * @param workspaceId - The workspace ID
-     * @param groupVersionId - The plan group version ID to fetch
-     * @returns Plan group response with the specified version
-     */
-    getPlanGroupByVersion(workspaceId: string, groupVersionId: string): Promise<IPlanGroupResponse>;
-    /**
-     * Get current group version and available newer versions of the same group
-     * - If user has active subscription: returns their current group version + newer versions
-     * - If no subscription: returns the latest published group version
-     * Shows what's new in newer versions to help users upgrade
-     * Example: User on Group v1 (Basic Plan) can see Group v2 (Basic + Pro Plan)
-     * @param workspaceId - The workspace ID
-     * @returns Plan group versions response with currentVersion and availableVersions
-     */
-    getPlanGroupVersions(workspaceId: string): Promise<IPlanGroupVersionsResponse>;
-    /**
-     * Get plan group versions by slug (public, no auth required).
-     * Returns the latest published plan group versions for the given plan group slug.
-     * Use this for public pricing pages when you want to show a specific plan group.
-     *
-     * @param slug - Plan group slug (e.g. 'default', 'enterprise')
-     * @returns Plan group versions response with currentVersion and availableVersions
-     */
-    getPublicPlans(slug: string): Promise<IPublicPlansResponse>;
-    /**
-     * Get plan group version details by ID (public, no auth required).
-     * Returns the full plan group version with populated plan versions.
-     * Use this for public pricing pages when you have the groupVersionId (e.g. from config or URL).
-     *
-     * @param groupVersionId - The plan group version ID to fetch
-     * @returns Plan group version with populated plan versions
-     */
-    getPlanGroupVersion(groupVersionId: string): Promise<IPlanGroupVersion>;
-    /**
-     * Create checkout session for new subscription
-     * @param workspaceId - The workspace ID
-     * @param request - Checkout session request with planVersionId and optional billing interval/URLs
-     * @returns Checkout session response with checkoutUrl to redirect user
-     */
-    createCheckoutSession(workspaceId: string, request: ICheckoutSessionRequest): Promise<CheckoutResult>;
-    /**
-     * Update subscription (upgrade/downgrade)
-     * Only allows plan changes within the same plan group
-     * Returns checkout session if payment is required, otherwise returns subscription update response
-     */
-    updateSubscription(workspaceId: string, request: ISubscriptionUpdateRequest): Promise<ISubscriptionUpdateResponse | ICheckoutSessionResponse>;
-    /**
-     * List invoices for a workspace subscription
-     * @param workspaceId - The workspace ID
-     * @param limit - Number of invoices to return (default: 10)
-     * @param startingAfter - Invoice ID to start after (for pagination)
-     * @returns List of invoices with pagination info
-     */
-    listInvoices(workspaceId: string, limit?: number, startingAfter?: string): Promise<IInvoiceListResponse>;
-    /**
-     * Get a single invoice by ID
-     * @param workspaceId - The workspace ID
-     * @param invoiceId - The invoice ID
-     * @returns Invoice details
-     */
-    getInvoice(workspaceId: string, invoiceId: string): Promise<IInvoiceResponse>;
-    /**
-     * Cancel subscription at the end of the current billing period
-     * Sets cancelAtPeriodEnd: true - subscription remains active until period ends
-     * @param workspaceId - The workspace ID
-     * @returns Updated subscription with cancelAtPeriodEnd and stripeCurrentPeriodEnd
-     */
-    cancelSubscriptionAtPeriodEnd(workspaceId: string): Promise<ISubscriptionResponse>;
-    /**
-     * Resume a subscription that was scheduled for cancellation
-     * Sets cancelAtPeriodEnd: false - subscription will continue after period ends
-     * @param workspaceId - The workspace ID
-     * @returns Updated subscription with cancelAtPeriodEnd set to false
-     */
-    resumeSubscription(workspaceId: string): Promise<ISubscriptionResponse>;
-    /**
-     * Record quota usage for a workspace
-     * @param workspaceId - The workspace ID
-     * @param request - Usage request with quotaSlug, quantity, and optional metadata/source
-     * @returns Usage result with consumed/included/available/overage
-     */
-    recordUsage(workspaceId: string, request: IRecordUsageRequest): Promise<IRecordUsageResponse>;
-    /**
-     * Get usage status for a single quota
-     * @param workspaceId - The workspace ID
-     * @param quotaSlug - The quota slug to check
-     * @returns Quota usage status with consumed/included/available/overage/hasOverage
-     */
-    getQuotaUsageStatus(workspaceId: string, quotaSlug: string): Promise<IQuotaUsageStatusResponse>;
-    /**
-     * Get usage status for all quotas in the workspace's current plan
-     * @param workspaceId - The workspace ID
-     * @returns All quota usage statuses keyed by quota slug
-     */
-    getAllQuotaUsage(workspaceId: string): Promise<IAllQuotaUsageResponse>;
-    /**
-     * Get paginated usage logs for a workspace
-     * @param workspaceId - The workspace ID
-     * @param query - Optional filters: quotaSlug, from, to, source, page, limit
-     * @returns Paginated usage log entries
-     */
-    getUsageLogs(workspaceId: string, query?: IUsageLogsQuery): Promise<IUsageLogsResponse>;
-}