@iblai/web-utils 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,5 +1,1021 @@
-export * from "./hooks";
-export * from "./providers";
-export * from "./utils";
-export * from "./types";
-export * from "./features";
+import { FreeUsageCount, StripeCustomerPortalRequest } from '@iblai/iblai-api';
+import { StripeContextResponse, UploadProfileImageResponse, RemoveProfileImageResponse, StorageService, TokenResponse } from '@iblai/data-layer';
+import * as React$1 from 'react';
+import React__default from 'react';
+import { PricingModalData as PricingModalData$1 } from '@web-utils/types/subscription';
+import { OpUnitType } from 'dayjs';
+import duration from 'dayjs/plugin/duration';
+import { ChatStatus as ChatStatus$1 } from '@web-utils/features';
+import * as _reduxjs_toolkit from '@reduxjs/toolkit';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Tenant as Tenant$3 } from '@web-utils/types';
+import { z } from 'zod';
+
+interface Tenant$2 {
+    key: string;
+    is_admin: boolean;
+    org: string;
+}
+interface SubscriptionFlowConfig {
+    platformName: string;
+    currentTenantKey: string;
+    username: string;
+    currentTenantOrg: string;
+    userTenants: Tenant$2[];
+    isAdmin: boolean;
+    mainTenantKey: string;
+}
+/**
+ * SubscriptionFlow class manages all subscription-related flows and user interactions
+ * Handles free trial, usage limits, and subscription management
+ */
+declare abstract class SubscriptionFlow {
+    protected platformName: string;
+    protected currentTenantKey: string;
+    protected username: string;
+    protected currentTenantOrg: string;
+    protected userTenants: Tenant$2[];
+    protected isAdmin: boolean;
+    protected mainTenantKey: string;
+    constructor(config: SubscriptionFlowConfig);
+    getPlatformName(): string;
+    getCurrentTenantKey(): string;
+    getUsername(): string;
+    getCurrentTenantOrg(): string;
+    getUserTenants(): Tenant$2[];
+    isUserAdmin(): boolean;
+    /**
+     * Handles the flow when user reaches their free usage limit
+     * Updates banner with appropriate message based on remaining usage count
+     */
+    abstract handleFreeUsageCountFlow(freeUsageCount: FreeUsageCount): void;
+    /**
+     * Handles the flow when user's free trial period has ended
+     * Updates banner and clears any existing trial interval
+     */
+    abstract handleTrialEndedFlow(freeTrialIntervalID?: number): void;
+    /**
+     * Handles the flow for ongoing subscription period
+     * Updates banner with remaining trial time and subscription options
+     */
+    abstract handleSubscriptionOnGoingFlow(timeRemainingInString: string): void;
+    /**
+     * Handles redirection to external URLs with optional toast notification
+     */
+    abstract handleRedirectToURLFlow(redirectUrl: string, toastMessage?: string): void;
+    /**
+     * Displays the pricing modal for subscription options
+     */
+    handlePricingPageDisplayFlow(): void;
+    /**
+     * Handles the pre-subscription state
+     * Updates banner to show loading state
+     */
+    handleBeforeSubscribeUserTriggerFlow(): void;
+    /**
+     * Handles successful subscription completion
+     * Shows success message and disables subscription banner
+     */
+    abstract handleSuccessfullySubscribedFlow(message?: string): void;
+    getMainTenantKey(): string;
+}
+
+/**
+ * Hook to handle subscription logic
+ * @param subscriptionFlow Instance of SubscriptionFlow that manages different subscription states and actions
+ */
+declare const useSubscriptionHandler: (subscriptionFlow: SubscriptionFlow) => {
+    handleSubscriptionCheck: () => Promise<void>;
+    handleIntervalSubscriptionCheck: () => (() => void) | undefined;
+    trialCounterStarted: boolean;
+    bannerButtonTriggerCallback: (trigger: string) => () => void;
+};
+
+declare const SUBSCRIPTION_TRIGGERS: {
+    PRICING_MODAL: string;
+    SUBSCRIBE_USER: string;
+};
+
+interface Tenant$1 {
+    key: string;
+    is_admin: boolean;
+    org: string;
+    is_advertising?: boolean;
+}
+interface SubscriptionFlowConfigV2 {
+    platformName: string;
+    currentTenantKey: string;
+    username: string;
+    currentTenantOrg: string;
+    userTenants: Tenant$1[];
+    isAdmin: boolean;
+    mainTenantKey: string;
+    userEmail: string;
+    mentorUrl: string;
+}
+/**
+ * SubscriptionFlow class manages all subscription-related flows and user interactions
+ * Handles free trial, usage limits, and subscription management
+ */
+declare abstract class SubscriptionFlowV2 {
+    protected platformName: string;
+    protected currentTenantKey: string;
+    protected username: string;
+    protected currentTenantOrg: string;
+    protected userTenants: Tenant$1[];
+    protected isAdmin: boolean;
+    protected mainTenantKey: string;
+    protected userEmail: string;
+    protected mentorUrl: string;
+    constructor(config: SubscriptionFlowConfigV2);
+    getPlatformName(): string;
+    getCurrentTenantKey(): string;
+    getUsername(): string;
+    getCurrentTenantOrg(): string;
+    getUserTenants(): Tenant$1[];
+    isUserAdmin(): boolean;
+    getUserEmail(): string;
+    getMainTenantKey(): string;
+    getMentorUrl(): string;
+    abstract handleRedirectToBillingPageFlow(billingUrl: string): void;
+    handleBeforeTopUpCreditTriggerFlow(): void;
+    handleBeforeBillingPageTriggerFlow(): void;
+    /**
+     * Handles the flow when user reaches their free usage limit
+     * Updates banner with appropriate message based on remaining usage count
+     */
+    abstract handleFreeUsageCountFlow(hasCredits: boolean, appExists: boolean): void;
+    /**
+     * Displays the pricing modal for subscription options
+     */
+    abstract handlePricingPageDisplayFlow(stripeContext: StripeContextResponse, creditExhausted: boolean): void;
+    /**
+     * Displays error notification when payment flow fails
+     */
+    handleFailureOnPaymentFlow(): void;
+    handleBeforePricingPageDisplayFlow(): void;
+    handleFailureOnTopUpCreditTriggerFlow(): void;
+    handlePaidPlanCreditExhaustedFlow(): void;
+    handleProPlanCreditExhaustedFlow(): void;
+    handleStudentOnPaidPlanCreditExhaustedFlow(): void;
+    abstract handleOpenContactAdminFlow(adminEmail: string): void;
+    abstract handleCreditExhaustedWithUserOnFreePackageFlow({ subscriptionId, expiryDate, }: {
+        subscriptionId: string;
+        expiryDate: string;
+    }): void;
+    abstract handleCreditExhaustedWithUserOnStarterPackageFlow({ subscriptionId, expiryDate, }: {
+        subscriptionId: string;
+        expiryDate: string;
+    }): void;
+    abstract handleCreditExhaustedWithUserOnProPackageFlow({ expiryDate, }: {
+        expiryDate: string;
+    }): void;
+    handleFailureOnBillingPageTriggerFlow(): void;
+}
+
+/**
+ * Hook to handle subscription logic
+ * @param subscriptionFlow Instance of SubscriptionFlow that manages different subscription states and actions
+ */
+declare const useSubscriptionHandlerV2: (subscriptionFlow: SubscriptionFlowV2) => {
+    handleSubscriptionCheck: () => Promise<void>;
+    bannerButtonTriggerCallback: (trigger: string) => ((returnURL?: string) => Promise<void>) | (() => void);
+    CREDIT_INTERVAL_CHECK_COUNTER: number;
+    getBillingURL: ({ returnURL, includeSubscriptionIdIfNeeded, }: {
+        returnURL: string;
+        includeSubscriptionIdIfNeeded?: boolean;
+    }) => Promise<string | null | undefined>;
+    getTopUpURL: (obtainBillingPageURLIfNeeded?: boolean) => Promise<string | null | undefined>;
+    getUserSubscriptionPackage: () => Promise<string | null>;
+};
+
+declare const useExternalPricingPlan: ({ pricingModalData, userEmail, }: {
+    pricingModalData: PricingModalData$1;
+    userEmail: string;
+}) => {
+    pricingBoxIframeRef: React$1.RefObject<null>;
+};
+
+declare const SUBSCRIPTION_V2_TRIGGERS: {
+    PRICING_MODAL: string;
+    TOP_UP_CREDIT: string;
+    CONTACT_ADMIN: string;
+    BILLING_PAGE: string;
+};
+declare const SUBSCRIPTION_MESSAGES: {
+    CREDIT_EXHAUSTED: {
+        FREE_PACKAGE: ({ expiryDate }: {
+            expiryDate: string;
+        }) => string;
+        STARTER_PACKAGE: ({ expiryDate }: {
+            expiryDate: string;
+        }) => string;
+        PRO_PACKAGE: ({ expiryDate }: {
+            expiryDate: string;
+        }) => string;
+        STUDENT_UNDER_PAID_PACKAGE_EMAIL_BODY: ({ currentTenantOrg, userEmail, }: {
+            currentTenantOrg: string;
+            userEmail: string;
+        }) => string;
+        STUDENT_UNDER_PAID_PACKAGE_EMAIL_SUBJECT: ({ currentTenantOrg, }: {
+            currentTenantOrg: string;
+        }) => string;
+        ADMIN: string;
+        STUDENT: string;
+        FREE_TRIAL_LIMIT: string;
+        NO_APP: string;
+    };
+    ACTION_BUTTONS: {
+        FREE_PACKAGE: string;
+        STARTER_PACKAGE: string;
+        PRO_PACKAGE: string;
+        UPGRADE: string;
+        TOP_UP: string;
+        CONTACT_ADMIN: string;
+        ADD_CREDITS: string;
+    };
+    TOAST_MESSAGES: {
+        PRICING_PAGE_LOAD_ERROR: string;
+        TOP_UP_CREDIT_TRIGGER_LOAD_ERROR: string;
+        REDIRECTING_BILLING_PAGE: string;
+        BILLING_PAGE_TRIGGER_LOAD_ERROR: string;
+    };
+};
+declare const SUBSCRIPTION_PACKAGES: {
+    PRE_FREE_PACKAGE: string;
+    FREE_PACKAGE: (productName: string) => string;
+    STARTER_PACKAGE: (productName: string) => string;
+    PRO_PACKAGE: (productName: string) => string;
+};
+
+declare const useDayJs: () => {
+    getTimeDifferenceBetweenTwoDates: (futureDate: string, pastDate: string, format?: OpUnitType) => number;
+    getDayJSDurationObjFromSeconds: (seconds: number) => duration.Duration;
+    generateFutureDateForNMinutes: (minute?: number) => string;
+};
+
+declare const advancedTabsProperties: {
+    chat: {
+        display: string;
+        name: string;
+        tag: string;
+        showHeader: boolean;
+        prompts: {
+            type: string;
+            icon: string;
+            summary: string;
+            content: string;
+        }[];
+    };
+    summarize: {
+        display: string;
+        showHeader: boolean;
+        name: string;
+        tag: string;
+        prompts: {
+            type: string;
+            proactive: boolean;
+            hide: boolean;
+            content: string;
+        }[];
+    };
+    translate: {
+        display: string;
+        showHeader: boolean;
+        name: string;
+        tag: string;
+        description: string;
+        metaDescription: string;
+        prompts: ({
+            type: string;
+            hide: boolean;
+            tag: string;
+            summary: string;
+            content: string;
+        } | {
+            type: string;
+            summary: string;
+            content: string;
+            hide?: undefined;
+            tag?: undefined;
+        })[];
+    };
+    expand: {
+        display: string;
+        showHeader: boolean;
+        name: string;
+        tag: string;
+        prompts: {
+            type: string;
+            proactive: boolean;
+            hide: boolean;
+            content: string;
+        }[];
+    };
+};
+declare const advancedTabs: ("chat" | "summarize" | "translate" | "expand")[];
+type AdvancedTab = keyof typeof advancedTabsProperties;
+declare const translatePrompt: (language: string) => string;
+
+type MessageActionTypes = "redirectToAuthSpaJoinTenant";
+interface MessageAction {
+    text: string;
+    type: "primary" | "danger";
+    actionType: MessageActionTypes;
+}
+interface Message {
+    id: string;
+    role: "user" | "assistant" | "system";
+    content: string;
+    timestamp: string;
+    url?: string;
+    fileType?: string;
+    contentType?: string;
+    visible: boolean;
+    actions?: MessageAction[];
+}
+type SendMessageOptions = {
+    visible?: boolean;
+} | undefined;
+interface UseChatProps {
+    wsUrl: string;
+    wsToken: string;
+    flowConfig: {
+        name: string;
+        tenant: string;
+        username: string;
+        pathway: string;
+    };
+    sessionId: string;
+    stopGenerationWsUrl: string;
+    activeTab: AdvancedTab;
+    enableHaptics?: boolean;
+    hapticFeedback?: {
+        impactAsync: (style: any) => Promise<void>;
+    };
+    redirectToAuthSpa: () => void;
+    store?: {
+        sendMessage?: (text: string) => Promise<void>;
+    };
+    WebSocketImpl?: typeof WebSocket;
+    errorHandler?: (message: string, error?: any) => void;
+    onStatusChange: (status: ChatStatus$1) => void;
+    onStreamingChange: (streaming: boolean) => void;
+    onStreamingMessageUpdate: (message: {
+        id: string | null;
+        content: string;
+    }) => void;
+    onAddUserMessage?: (activeTab: AdvancedTab, message: Message) => void;
+    sendMessageToParentWebsite?: (payload: unknown) => void;
+    on402Error?: (message: Record<string, unknown>) => void;
+}
+interface UseChatReturn {
+    sendMessage: (tab: AdvancedTab, text: string, options?: SendMessageOptions) => Promise<void>;
+    ws: React.MutableRefObject<WebSocket | null>;
+    isConnected: React.MutableRefObject<boolean>;
+    messageQueue: React.MutableRefObject<any[]>;
+    stopGenerating: () => void;
+    resetConnection: () => void;
+}
+declare const useChat: ({ wsUrl, wsToken, flowConfig, sessionId, stopGenerationWsUrl, enableHaptics, hapticFeedback, store, errorHandler, onStatusChange, onStreamingChange, onStreamingMessageUpdate, WebSocketImpl, redirectToAuthSpa, sendMessageToParentWebsite, on402Error, }: UseChatProps) => UseChatReturn;
+
+declare const MENTOR_CHAT_DOCUMENTS_EXTENSIONS: string[];
+declare const ANONYMOUS_USERNAME = "anonymous";
+declare const MAX_INITIAL_WEBSOCKET_CONNECTION_ATTEMPTS = 3;
+declare const LOCAL_STORAGE_KEYS: {
+    CURRENT_TENANT: string;
+    TENANTS: string;
+    REDIRECT_TO: string;
+    AUTH_TOKEN: string;
+    TOKEN_EXPIRY: string;
+    USER_DATA: string;
+    USER_TENANTS: string;
+    EDX_TOKEN_KEY: string;
+    DM_TOKEN_KEY: string;
+    DM_TOKEN_EXPIRES: string;
+};
+declare const TOOLS: {
+    readonly WEB_SEARCH: "web-search";
+    readonly WIKIPEDIA_SEARCH: "wikipedia-search";
+    readonly COURSE_CREATION: "course-creation";
+    readonly MCP: "mcp";
+    readonly IMAGE_GENERATION: "image-generation";
+    readonly IBL_PATHWAY_DOCUMENTS_RETRIEVER: "ibl-pathway-documents-retriever";
+    readonly TRAINED_DOCUMENTS: "trained-documents";
+    readonly IBL_SESSION_DOCUMENTS_RETRIEVER: "ibl-session-documents-retriever";
+    readonly PLAYWRIGHT_BROWSER: "playwright-browser";
+    readonly HUMAN_SUPPORT: "human-support";
+    readonly CODE_INTERPRETER: "code-interpreter";
+    readonly DEEP_RESEARCH: "deep-research";
+    readonly MEMORY: "memory";
+    readonly SCREEN_SHARE: "screen-share";
+    readonly POWERPOINT: "powerpoint";
+    readonly PROMPT: "prompt";
+    readonly QUIZ: "quiz";
+    readonly RUBRIC: "rubric";
+    readonly RESOURCE: "resource";
+    readonly LESSON_PLAN: "lesson-plan";
+    readonly SYLLABUS: "syllabus";
+    readonly CANVAS: "canvas";
+    readonly GOOGLE_SLIDES: "google-slides";
+    readonly GOOGLE_DOCUMENT: "google-docs";
+};
+
+declare const isJSON: (text: string) => boolean;
+declare const getInitials: (fullName: string) => string;
+declare const ALPHANUMERIC_32_REGEX: RegExp;
+declare const isAlphaNumeric32: (text: string) => boolean;
+declare const addProtocolToUrl: (url: string) => string;
+declare function getTimeAgo(createdAt: string): string;
+declare const formatRelativeTime: (timestamp: string) => string;
+
+type ChatState = Record<AdvancedTab, Message[]>;
+interface SessionIds extends Record<AdvancedTab, string> {
+}
+type StreamingMessage = {
+    id: string;
+    content: string;
+};
+declare const defaultSessionIds: SessionIds;
+type ChatStatus = "idle" | "pending" | "streaming" | "stopped" | "error";
+type ChatSliceState = {
+    chats: ChatState;
+    isTyping: boolean;
+    streaming: boolean;
+    currentStreamingMessage: StreamingMessage;
+    activeTab: AdvancedTab;
+    sessionId: string;
+    sessionIds: SessionIds;
+    status: ChatStatus;
+    tools: string[];
+    token: string | null;
+    tokenEnabled: boolean;
+    iframeContext: {
+        hostInfo: {
+            title: string;
+            href: string;
+        };
+        pageContent: string;
+    };
+    documentFilter: Record<string, unknown> | null;
+    shouldStartNewChat: boolean;
+    showingSharedChat: boolean;
+};
+declare const chatActions: _reduxjs_toolkit.CaseReducerActions<_reduxjs_toolkit.SliceCaseReducers<ChatSliceState>, string>;
+declare const chatSliceReducerShared: Reducer<State>;
+declare const selectChats: (state: {
+    chatSliceShared: ChatSliceState;
+}) => ChatState;
+declare const selectIsTyping: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectStreaming: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectStatus: (state: {
+    chatSliceShared: ChatSliceState;
+}) => ChatStatus;
+declare const selectIsPending: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectIsStopped: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectIsError: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectCurrentStreamingMessage: (state: {
+    chatSliceShared: ChatSliceState;
+}) => StreamingMessage;
+declare const selectActiveTab: (state: {
+    chatSliceShared: ChatSliceState;
+}) => "chat" | "summarize" | "translate" | "expand";
+declare const selectSessionId: (state: {
+    chatSliceShared: ChatSliceState;
+}) => string;
+declare const selectSessionIds: (state: {
+    chatSliceShared: ChatSliceState;
+}) => SessionIds;
+declare const selectIframeContext: (state: {
+    chatSliceShared: ChatSliceState;
+}) => {
+    hostInfo: {
+        title: string;
+        href: string;
+    };
+    pageContent: string;
+};
+declare const selectDocumentFilter: (state: {
+    chatSliceShared: ChatSliceState;
+}) => Record<string, unknown> | null;
+declare const selectTools: (state: {
+    chatSliceShared: ChatSliceState;
+}) => string[];
+declare const selectToken: (state: {
+    chatSliceShared: ChatSliceState;
+}) => string | null;
+declare const selectTokenEnabled: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectActiveChatMessages: (state: {
+    chatSliceShared: ChatSliceState;
+}) => Message[];
+declare const selectNumberOfActiveChatMessages: (state: {
+    chatSliceShared: ChatSliceState;
+}) => number;
+declare const selectShouldStartNewChat: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+declare const selectShowingSharedChat: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+
+type ChatMode = "advanced" | "default";
+
+interface UseExternalPricingProps {
+    referenceId: string;
+    customerEmail: string;
+    publishableKey: string;
+    pricingId?: string;
+}
+interface PricingModalData {
+    referenceId: string;
+    customerEmail: string;
+    publishableKey: string;
+    pricingTableId: string;
+}
+interface CreateStripeCustomerPortalRequest {
+    org: string;
+    userId: string;
+    requestBody: StripeCustomerPortalRequest;
+}
+
+declare const userDataSchema: z.ZodObject<{
+    user_display_name: z.ZodString;
+    user_email: z.ZodString;
+    user_fullname: z.ZodString;
+    user_id: z.ZodNumber;
+    user_nicename: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    user_display_name: string;
+    user_email: string;
+    user_fullname: string;
+    user_id: number;
+    user_nicename: string;
+}, {
+    user_display_name: string;
+    user_email: string;
+    user_fullname: string;
+    user_id: number;
+    user_nicename: string;
+}>;
+declare const tenantSchema: z.ZodObject<{
+    key: z.ZodString;
+    is_admin: z.ZodBoolean;
+    org: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    is_admin: boolean;
+    org: string;
+}, {
+    key: string;
+    is_admin: boolean;
+    org: string;
+}>;
+declare const tenantKeySchema: z.ZodString;
+type TenantKeyMentorIdParams = {
+    tenantKey: string;
+    mentorId: string;
+};
+interface TopTrialBannerProps {
+    parentContainer: string;
+    bannerText?: string;
+    onUpgrade?: string;
+    loading?: boolean;
+    tooltipText?: string;
+}
+interface Prompt {
+    type: "static" | "human" | "ai";
+    icon?: string;
+    summary?: string;
+    content?: string;
+    proactive?: boolean;
+    hide?: boolean;
+    tag?: string;
+}
+interface Tenant {
+    key: string;
+    is_admin: boolean;
+    org: string;
+    name?: string;
+    platform_name: string;
+    is_advertising?: boolean;
+}
+
+type Props$5 = {
+    mode?: ChatMode;
+    tenantKey: string;
+    mentorId: string;
+    username: string;
+    token: string;
+    wsUrl: string;
+    redirectToAuthSpa: () => void;
+    stopGenerationWsUrl: string;
+    sendMessageToParentWebsite?: (payload: unknown) => void;
+    errorHandler?: (message: string, error?: any) => void;
+    isPreviewMode?: boolean;
+    mentorShareableToken?: string | null;
+    on402Error?: (message: Record<string, unknown>) => void;
+};
+declare function useAdvancedChat({ tenantKey, mentorId, username, token, wsUrl, stopGenerationWsUrl, redirectToAuthSpa, errorHandler, sendMessageToParentWebsite, isPreviewMode, mentorShareableToken, on402Error, }: Props$5): {
+    messages: Message[];
+    isStreaming: boolean;
+    status: ChatStatus;
+    isPending: boolean;
+    isStopped: boolean;
+    isError: boolean;
+    currentStreamingMessage: StreamingMessage;
+    activeTab: "chat" | "summarize" | "translate" | "expand";
+    uniqueMentorId: string;
+    mentorName: string;
+    profileImage: string;
+    enabledGuidedPrompts: boolean;
+    sendMessage: (tab: AdvancedTab, text: string, options?: SendMessageOptions) => Promise<void>;
+    stopGenerating: () => void;
+    setMessage: (message: Message) => void;
+    changeTab: (tab: AdvancedTab) => Promise<void>;
+    sessionId: string;
+    startNewChat: () => Promise<void>;
+    isLoadingSessionIds: boolean;
+    ws: React__default.MutableRefObject<WebSocket | null>;
+    isConnected: React__default.MutableRefObject<boolean>;
+    messageQueue: React__default.MutableRefObject<any[]>;
+    sessionIds: SessionIds;
+    enableSafetyDisclaimer: any;
+    resetConnection: () => void;
+};
+
+type Props$4 = {
+    tenantKey: string;
+    mentorId: string;
+    username: string;
+    errorHandler?: (message: string, error?: any) => void;
+};
+declare function useMentorTools({ tenantKey, mentorId, username, errorHandler, }: Props$4): {
+    tools: any;
+    activeTools: string[];
+    updateSessionTools: (tool: string) => Promise<void>;
+    setSessionTools: (tools: string[]) => Promise<void>;
+    enableWebBrowsing: boolean;
+    screenSharing: boolean;
+    deepResearch: boolean;
+    imageGeneration: boolean;
+    codeInterpreter: boolean;
+    promptsIsEnabled: boolean;
+    googleSlidesIsEnabled: boolean;
+    googleDocumentIsEnabled: boolean;
+};
+
+interface UserProfileUpdateData {
+    name?: string;
+    title?: string;
+    about?: string;
+    social_links?: {
+        platform: string;
+        social_link: string;
+    }[];
+    public_metadata?: {
+        bio?: string;
+        name?: string;
+        about?: string;
+        language?: string;
+        social_links?: {
+            platform: string;
+            social_link: string;
+        }[];
+        [key: string]: any;
+    };
+    enable_sidebar_ai_mentor_display?: boolean;
+    enable_skills_leaderboard_display?: boolean;
+}
+interface UseUserProfileUpdateResult {
+    updateProfile: (data: UserProfileUpdateData) => Promise<void>;
+    isLoading: boolean;
+    error: any;
+}
+declare function useUserProfileUpdate(username: string): UseUserProfileUpdateResult;
+
+interface UseProfileImageUploadOptions {
+    onSuccess?: (imageUrl: string) => void;
+    onError?: (error: any) => void;
+}
+interface UseProfileImageUploadReturn {
+    uploadImage: (file: File, username: string) => Promise<UploadProfileImageResponse>;
+    removeImage: (username: string) => Promise<RemoveProfileImageResponse>;
+    isLoading: boolean;
+    isRemoving: boolean;
+    error: any;
+}
+declare function useProfileImageUpload(options?: UseProfileImageUploadOptions): UseProfileImageUploadReturn;
+
+declare const useTenantMetadata: ({ org, spa, }: {
+    org: string;
+    spa?: string;
+}) => {
+    metadata: any;
+    platformName: string | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    isSkillsAssignmentsFeatureHidden: () => boolean;
+    isSkillsResumeFeatureHidden: () => boolean;
+    isMentorAIEnabled: () => boolean;
+    isSkillsLeaderBoardEnabled: () => boolean;
+    getEmbeddedMentorToUse: () => any;
+    metadataLoaded: any;
+    getAllMetadatas: () => {
+        value: any;
+        slug: string;
+        label: string;
+        defaultValue: any;
+        SPA?: string;
+        description?: string;
+        type?: "boolean" | "string" | "number";
+    }[];
+    getSupportEmail: () => any;
+};
+
+interface TenantMetadata$1 {
+    slug: string;
+    label: string;
+    defaultValue: any;
+    SPA?: string;
+    value?: any;
+    description?: string;
+    type?: "boolean" | "string" | "number";
+}
+
+/**
+ * Loads all metadata configurations for a given SPA
+ * @param spa - The SPA identifier (e.g., 'mentorAI', 'skillsAI', 'mentor', 'skills'). If not provided, returns all SPAs
+ * @returns Array of TenantMetadata objects
+ */
+declare function loadMetadataConfig(spa?: string): TenantMetadata$1[];
+
+interface TenantMetadata {
+    slug: string;
+    label: string;
+    defaultValue: any;
+    SPA?: string;
+    value?: any;
+}
+declare const METADATAS: TenantMetadata$1[];
+
+type Props$3 = {
+    mentorId: string;
+    tenantKey: string;
+    username: string;
+};
+declare function useMentorSettings({ mentorId, tenantKey, username }: Props$3): {
+    data: {
+        profileImage: string | null | undefined;
+        greetingMethod: string | undefined;
+        proactiveResponse: string | undefined;
+        llmProvider: any;
+        llmName: string | undefined;
+        mentorUniqueId: string | undefined;
+        mentorName: string | undefined;
+        enableGuidedPrompts: boolean | undefined;
+        mentorSlug: string | undefined;
+        safetyDisclaimer: any;
+        mentorTools: any;
+        allowAnonymous: boolean | undefined;
+    };
+};
+
+/**
+ * Sync authentication state to cookies (web only)
+ * Should be called on login, logout, and tenant switch
+ * On React Native, this is a no-op
+ */
+declare function syncAuthToCookies(storageService: StorageService): Promise<void>;
+/**
+ * Clear all authentication cookies (web only)
+ * Should be called on logout
+ * On React Native, this is a no-op
+ */
+declare function clearAuthCookies(): void;
+declare function getUserName(storageService: StorageService): Promise<any>;
+declare function useAuthProvider({ middleware, onAuthSuccess, onAuthFailure, redirectToAuthSpa, hasNonExpiredAuthToken, username, pathname, storageService, skipAuthCheck, token, }: Props$2): {
+    isAuthenticating: boolean;
+    userIsAccessingPublicRoute: boolean;
+    setUserIsAccessingPublicRoute: React__default.Dispatch<React__default.SetStateAction<boolean>>;
+};
+/**
+ * Type definition for the authentication context
+ * Tracks whether the user is accessing a public route and provides a setter
+ */
+type AuthContextType = {
+    userIsAccessingPublicRoute: boolean;
+    setUserIsAccessingPublicRoute: (iuserIsAccessingPublicRoute: boolean) => void;
+};
+declare const AuthContext: React__default.Context<AuthContextType | undefined>;
+/**
+ * Hook to access the auth context
+ * @throws Error if used outside of AuthContextProvider
+ */
+declare const useAuthContext: () => AuthContextType;
+/**
+ * Context Provider component that wraps children with auth context
+ */
+declare const AuthContextProvider: ({ value, children, }: {
+    value: AuthContextType;
+    children: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+/**
+ * Props for the AuthProvider component
+ */
+type Props$2 = {
+    children?: React__default.ReactNode;
+    fallback?: React__default.ReactNode;
+    middleware?: Map<string | RegExp, () => Promise<boolean>>;
+    onAuthSuccess?: () => void;
+    onAuthFailure?: (reason: string) => void;
+    redirectToAuthSpa: (redirectTo?: string, platformKey?: string, logout?: boolean) => void;
+    hasNonExpiredAuthToken: () => boolean;
+    username: string;
+    pathname: string;
+    skipAuthCheck?: boolean;
+    storageService?: StorageService;
+    token?: string;
+};
+/**
+ * AuthProvider Component
+ *
+ * Main authentication provider that:
+ * 1. Checks if the current route requires authentication
+ * 2. Validates the auth token
+ * 3. Fetches user metadata to verify authentication
+ * 4. Handles redirects to auth SPA when needed
+ * 5. Manages public route access state
+ */
+declare function AuthProvider({ children, fallback, middleware, onAuthSuccess, onAuthFailure, redirectToAuthSpa, hasNonExpiredAuthToken, username, pathname, skipAuthCheck, storageService, token, }: Props$2): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+
+/**
+ * MentorProvider Component
+ *
+ * Provider that manages AI mentor selection and redirection logic.
+ * It handles:
+ * - Mentor selection based on user preferences and history
+ * - Mentor seeding for new tenants
+ * - Redirection to appropriate mentor or creation flow
+ * - Integration with tenant context for access control
+ */
+
+/**
+ * Props for the MentorProvider component
+ */
+type Props$1 = {
+    children?: React__default.ReactNode;
+    fallback?: React__default.ReactNode;
+    onAuthSuccess?: () => void;
+    onAuthFailure?: (reason: string) => void;
+    redirectToAuthSpa: () => void;
+    redirectToMentor: (tenantKey: string, mentorId: string) => void;
+    onLoadMentorsPermissions?: (rbacPermissions: Record<string, unknown> | undefined) => void;
+    redirectToNoMentorsPage: () => void;
+    redirectToCreateMentor: () => void;
+    username: string;
+    isAdmin: boolean;
+    mainTenantKey: string;
+    requestedMentorId?: string;
+    handleMentorNotFound?: () => Promise<void>;
+    forceDetermineMentor?: boolean;
+};
+/**
+ * MentorProvider Component
+ *
+ * Main mentor provider that:
+ * 1. Determines the most appropriate mentor for the user
+ * 2. Handles mentor seeding for new tenants
+ * 3. Manages redirection based on mentor availability
+ * 4. Integrates with tenant context for access control
+ */
+declare function MentorProvider({ children, fallback, onAuthSuccess, onAuthFailure, redirectToAuthSpa, redirectToMentor, onLoadMentorsPermissions, redirectToNoMentorsPage, redirectToCreateMentor, username, isAdmin, mainTenantKey, requestedMentorId, handleMentorNotFound, forceDetermineMentor, }: Props$1): React__default.ReactNode;
+
+/**
+ * Type definition for the tenant context
+ * Tracks whether the user's path needs to be determined and provides a setter
+ */
+type TenantContextType = {
+    determineUserPath: boolean;
+    setDetermineUserPath: (value: boolean) => void;
+    tenantKey: string;
+    metadata: Record<string, any>;
+    setMetadata: (metadata: Record<string, any>) => void;
+};
+declare const TenantContext: React__default.Context<TenantContextType | undefined>;
+/**
+ * Context Provider component that wraps children with tenant context
+ */
+declare const TenantContextProvider: React__default.FC<{
+    value: TenantContextType;
+    children: React__default.ReactNode;
+}>;
+/**
+ * Hook to access the tenant context
+ * @returns TenantContextType
+ */
+declare const useTenantContext: () => TenantContextType;
+/**
+ * Props for the TenantProvider component
+ */
+type Props = {
+    children?: React__default.ReactNode;
+    fallback?: React__default.ReactNode;
+    onAuthSuccess?: () => void;
+    onAuthFailure?: (reason: string) => void;
+    currentTenant: string;
+    requestedTenant: string;
+    handleTenantSwitch: (tenant: string, saveRedirect: boolean) => Promise<void>;
+    saveCurrentTenant: (tenant: Tenant$3) => void;
+    saveUserTenants: (tenants: Tenant$3[]) => void;
+    saveVisitingTenant?: (tenant: Tenant$3) => void;
+    removeVisitingTenant?: () => void;
+    saveUserTokens?: (tokens: TokenResponse) => void;
+    saveTenant?: (tenant: string) => void;
+    onAutoJoinUserToTenant?: (platformName: string) => void;
+};
+/**
+ * TenantProvider Component
+ *
+ * Main tenant provider that:
+ * 1. Validates user's access to requested tenant
+ * 2. Manages tenant switching
+ * 3. Retrieves and validates tenant metadata
+ * 4. Handles tenant-specific domain redirects
+ * 5. Maintains tenant access state
+ */
+declare function TenantProvider({ children, fallback, onAuthSuccess, onAuthFailure, currentTenant, requestedTenant, saveCurrentTenant, saveUserTenants, handleTenantSwitch, saveVisitingTenant, removeVisitingTenant, saveUserTokens, saveTenant, onAutoJoinUserToTenant, }: Props): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+
+interface TimeTrackerConfig {
+    intervalSeconds: number;
+    onTimeUpdate: (url: string, timeSpent: number) => void;
+    getCurrentUrl: () => string;
+    onRouteChange?: (callback: () => void) => () => void;
+}
+interface TimeTrackerState {
+    currentUrl: string;
+    startTime: number;
+    intervalId: number | null;
+    routeUnsubscribe: (() => void) | null;
+}
+declare class TimeTracker {
+    private state;
+    private config;
+    constructor(config: TimeTrackerConfig);
+    private initialize;
+    private startTracking;
+    private clearInterval;
+    private resetTimer;
+    private getTimeSpent;
+    private sendTimeUpdate;
+    private handleRouteChange;
+    pause(): void;
+    resume(): void;
+    destroy(): void;
+    getCurrentUrl(): string;
+    getTimeSpentSinceLastReset(): number;
+}
+
+interface UseTimeTrackerConfig {
+    intervalSeconds: number;
+    onTimeUpdate: (url: string, timeSpent: number) => void;
+    enabled?: boolean;
+    getCurrentUrl?: () => string;
+    onRouteChange?: (callback: () => void) => () => void;
+}
+interface UseTimeTrackerReturn {
+    pause: () => void;
+    resume: () => void;
+    getCurrentUrl: () => string;
+    getTimeSpentSinceLastReset: () => number;
+}
+declare function useTimeTracker(config: UseTimeTrackerConfig): UseTimeTrackerReturn;
+
+interface UseTimeTrackerNativeConfig {
+    intervalSeconds: number;
+    onTimeUpdate: (url: string, timeSpent: number) => void;
+    getCurrentRoute: () => string;
+    onRouteChange?: (callback: () => void) => () => void;
+    enabled?: boolean;
+}
+interface UseTimeTrackerNativeReturn {
+    pause: () => void;
+    resume: () => void;
+    getCurrentUrl: () => string;
+    getTimeSpentSinceLastReset: () => number;
+}
+declare function useTimeTrackerNative(config: UseTimeTrackerNativeConfig): UseTimeTrackerNativeReturn;
+
+export { ALPHANUMERIC_32_REGEX, ANONYMOUS_USERNAME, AuthContext, AuthContextProvider, AuthProvider, LOCAL_STORAGE_KEYS, MAX_INITIAL_WEBSOCKET_CONNECTION_ATTEMPTS, MENTOR_CHAT_DOCUMENTS_EXTENSIONS, METADATAS, MentorProvider, SUBSCRIPTION_MESSAGES, SUBSCRIPTION_PACKAGES, SUBSCRIPTION_TRIGGERS, SUBSCRIPTION_V2_TRIGGERS, SubscriptionFlow, SubscriptionFlowV2, TOOLS, TenantContext, TenantContextProvider, TenantProvider, TimeTracker, addProtocolToUrl, advancedTabs, advancedTabsProperties, chatActions, chatSliceReducerShared, clearAuthCookies, defaultSessionIds, formatRelativeTime, getInitials, getTimeAgo, getUserName, isAlphaNumeric32, isJSON, loadMetadataConfig, selectActiveChatMessages, selectActiveTab, selectChats, selectCurrentStreamingMessage, selectDocumentFilter, selectIframeContext, selectIsError, selectIsPending, selectIsStopped, selectIsTyping, selectNumberOfActiveChatMessages, selectSessionId, selectSessionIds, selectShouldStartNewChat, selectShowingSharedChat, selectStatus, selectStreaming, selectToken, selectTokenEnabled, selectTools, syncAuthToCookies, tenantKeySchema, tenantSchema, translatePrompt, useAdvancedChat, useAuthContext, useAuthProvider, useChat, useDayJs, useExternalPricingPlan, useMentorSettings, useMentorTools, useProfileImageUpload, useSubscriptionHandler, useSubscriptionHandlerV2, useTenantContext, useTenantMetadata, useTimeTracker, useTimeTrackerNative, useUserProfileUpdate, userDataSchema };
+export type { AdvancedTab, AuthContextType, ChatMode, ChatState, ChatStatus, CreateStripeCustomerPortalRequest, Message, MessageAction, PricingModalData, Prompt, SendMessageOptions, SessionIds, StreamingMessage, SubscriptionFlowConfig, SubscriptionFlowConfigV2, Tenant, TenantContextType, TenantKeyMentorIdParams, TenantMetadata, TimeTrackerConfig, TimeTrackerState, TopTrialBannerProps, UseChatProps, UseChatReturn, UseExternalPricingProps, UseProfileImageUploadOptions, UseProfileImageUploadReturn, UseTimeTrackerConfig, UseTimeTrackerNativeConfig, UseTimeTrackerNativeReturn, UseTimeTrackerReturn, UseUserProfileUpdateResult, UserProfileUpdateData };