@iblai/web-utils 0.2.0

package/dist/data-layer/src/services/StorageService.d.ts

@@ -0,0 +1,5 @@
+export interface StorageService {
+    getItem<T>(key: string): Promise<T | null>;
+    setItem<T>(key: string, item: T): Promise<void>;
+    removeItem<T>(key: string): Promise<void>;
+}

package/dist/data-layer/src/utils/index.d.ts

@@ -0,0 +1,2 @@
+import { StorageService } from "@data-layer/services/StorageService";
+export declare const initializeDataLayer: (dmUrl: string, lmsUrl: string, storageService: StorageService, httpErrorHandler?: Record<number, () => void>) => void;

package/dist/features/chat/slice.d.ts

@@ -0,0 +1,59 @@
+import type { AdvancedTab } from "../../utils";
+import type { Message } from "../../hooks/chat/use-chat-v2";
+export type ChatState = Record<AdvancedTab, Message[]>;
+export interface SessionIds extends Record<AdvancedTab, string> {
+}
+export type StreamingMessage = {
+    id: string;
+    content: string;
+};
+export declare const defaultSessionIds: SessionIds;
+type ChatSliceState = {
+    chats: ChatState;
+    isTyping: boolean;
+    streaming: boolean;
+    currentStreamingMessage: StreamingMessage;
+    activeTab: AdvancedTab;
+    sessionId: string;
+    sessionIds: SessionIds;
+    iframeContext: {
+        hostInfo: {
+            title: string;
+            href: string;
+        };
+        pageContent: string;
+    };
+};
+export declare const chatActions: import("@reduxjs/toolkit").CaseReducerActions<import("@reduxjs/toolkit").SliceCaseReducers<ChatSliceState>, string>;
+export declare const chatSliceReducerShared: import("@reduxjs/toolkit").Reducer<ChatSliceState>;
+export declare const selectChats: (state: {
+    chatSliceShared: ChatSliceState;
+}) => ChatState;
+export declare const selectIsTyping: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+export declare const selectStreaming: (state: {
+    chatSliceShared: ChatSliceState;
+}) => boolean;
+export declare const selectCurrentStreamingMessage: (state: {
+    chatSliceShared: ChatSliceState;
+}) => StreamingMessage;
+export declare const selectActiveTab: (state: {
+    chatSliceShared: ChatSliceState;
+}) => "chat" | "summarize" | "translate" | "expand";
+export declare const selectSessionId: (state: {
+    chatSliceShared: ChatSliceState;
+}) => string;
+export declare const selectSessionIds: (state: {
+    chatSliceShared: ChatSliceState;
+}) => SessionIds;
+export declare const selectIframeContext: (state: {
+    chatSliceShared: ChatSliceState;
+}) => {
+    hostInfo: {
+        title: string;
+        href: string;
+    };
+    pageContent: string;
+};
+export {};

package/dist/features/index.d.ts

@@ -0,0 +1 @@
+export * from "./chat/slice";

package/dist/hooks/chat/use-advanced-chat.d.ts

@@ -0,0 +1,41 @@
+import React from "react";
+import type { ChatMode } from "../../types";
+import { type AdvancedTab } from "../../utils";
+import { Message } from "./use-chat-v2";
+type Props = {
+    mode: ChatMode;
+    tenantKey: string;
+    mentorId: string;
+    username: string;
+    token: string;
+    wsUrl: string;
+    redirectToAuthSpa: () => void;
+    stopGenerationWsUrl: string;
+    sendMessageToParentWebsite?: (payload: unknown) => void;
+    errorHandler?: (error: string) => void;
+    isPreviewMode?: boolean;
+};
+export declare function useAdvancedChat({ mode, tenantKey, mentorId, username, token, wsUrl, stopGenerationWsUrl, redirectToAuthSpa, errorHandler, sendMessageToParentWebsite, isPreviewMode, }: Props): {
+    messages: Message[];
+    isStreaming: boolean;
+    currentStreamingMessage: import("../../features/chat/slice").StreamingMessage;
+    activeTab: "chat" | "summarize" | "translate" | "expand";
+    uniqueMentorId: string;
+    mentorName: string;
+    profileImage: string;
+    enabledGuidedPrompts: boolean;
+    sendMessage: (tab: AdvancedTab, text: string, options?: import("./use-chat-v2").SendMessageOptions) => Promise<void>;
+    stopGenerating: () => void;
+    setMessages: (messages: Message[]) => void;
+    changeTab: (tab: AdvancedTab) => Promise<void>;
+    sessionId: string;
+    startNewChat: () => Promise<void>;
+    isLoadingSessionIds: boolean;
+    ws: React.MutableRefObject<WebSocket | null>;
+    isConnected: React.MutableRefObject<boolean>;
+    messageQueue: React.MutableRefObject<any[]>;
+    enableWebBrowsing: boolean;
+    sessionIds: import("../../features/chat/slice").SessionIds;
+    enableSafetyDisclaimer: any;
+};
+export {};

package/dist/hooks/chat/use-chat-v2.d.ts

@@ -0,0 +1,53 @@
+import type { AdvancedTab } from "../../utils/data/advanced-tab";
+export interface Message {
+    id: string;
+    role: "user" | "assistant" | "system";
+    content: string;
+    timestamp: string;
+    url?: string;
+    fileType?: string;
+    contentType?: string;
+    visible: boolean;
+}
+export type SendMessageOptions = {
+    visible?: boolean;
+} | undefined;
+export 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?: (error: string) => void;
+    onStreamingChange: (streaming: boolean) => void;
+    onStreamingMessageUpdate: (message: {
+        id: string | null;
+        content: string;
+    }) => void;
+    onAddUserMessage?: (activeTab: AdvancedTab, message: Message) => void;
+    sendMessageToParentWebsite?: (payload: unknown) => void;
+}
+export 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;
+}
+export declare const useChat: ({ wsUrl, wsToken, flowConfig, sessionId, stopGenerationWsUrl, activeTab, enableHaptics, hapticFeedback, store, errorHandler, onStreamingChange, onStreamingMessageUpdate, onAddUserMessage, WebSocketImpl, redirectToAuthSpa, sendMessageToParentWebsite, }: UseChatProps) => UseChatReturn;

package/dist/hooks/chat/use-chat.d.ts

@@ -0,0 +1,52 @@
+import type { AdvancedTab } from "../../utils/data/advanced-tab";
+export interface Message {
+    id: string;
+    role: "user" | "assistant" | "system";
+    content: string;
+    timestamp: string;
+    url?: string;
+    fileType?: string;
+    contentType?: string;
+    visible?: boolean;
+}
+export type SendMessageOptions = {
+    visible?: boolean;
+};
+export 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>;
+    };
+    store?: {
+        sendMessage?: (text: string) => Promise<void>;
+    };
+    WebSocketImpl?: typeof WebSocket;
+    errorHandler?: (error: string) => void;
+}
+export interface UseChatReturn {
+    messages: Message[];
+    isTyping: boolean;
+    sendMessage: (text: string, options?: SendMessageOptions) => Promise<void>;
+    currentStreamingMessage: {
+        id: string | null;
+        content: string;
+    };
+    ws: React.MutableRefObject<WebSocket | null>;
+    isConnected: React.MutableRefObject<boolean>;
+    messageQueue: React.MutableRefObject<any[]>;
+    stopGenerating: () => void;
+    streaming: boolean;
+    setMessages: (messages: Message[]) => void;
+}
+export declare const useChat: ({ wsUrl, wsToken, flowConfig, sessionId, stopGenerationWsUrl, activeTab, enableHaptics, hapticFeedback, store, errorHandler, WebSocketImpl, }: UseChatProps) => UseChatReturn;

package/dist/hooks/chat/use-get-chat-details.d.ts

@@ -0,0 +1,13 @@
+import type { ChatMode } from "../../types";
+type Props = {
+    mode: ChatMode;
+    tenantKey: string;
+    mentorId: string;
+    username: string;
+    errorHandler?: (error: string) => void;
+};
+export declare function useGetChatDetails({ mode, tenantKey, mentorId, username, errorHandler, }: Props): {
+    isLoadingSessionIds: boolean;
+    refetchSessionIds: () => Promise<void>;
+};
+export {};

package/dist/hooks/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./subscription/use-subscription-handler";
+export * from "./subscription/constants";
+export * from "./subscription/class-subscription-flow";
+export * from "./subscription-v2/use-subscription-handler";
+export * from "./subscription-v2/class-subscription-flow";
+export * from "./subscription-v2/use-external-pricing-plan";
+export * from "./subscription-v2/constants";
+export * from "./use-day-js";
+export * from "./chat/use-chat";
+export * from "./chat/use-advanced-chat";

package/dist/hooks/subscription/class-subscription-flow.d.ts

@@ -0,0 +1,70 @@
+import { FreeUsageCount } from "@iblai/iblai-api";
+interface Tenant {
+    key: string;
+    is_admin: boolean;
+    org: string;
+}
+export interface SubscriptionFlowConfig {
+    platformName: string;
+    currentTenantKey: string;
+    username: string;
+    currentTenantOrg: string;
+    userTenants: Tenant[];
+    isAdmin: boolean;
+    mainTenantKey: string;
+}
+/**
+ * SubscriptionFlow class manages all subscription-related flows and user interactions
+ * Handles free trial, usage limits, and subscription management
+ */
+export declare class SubscriptionFlow {
+    protected platformName: string;
+    protected currentTenantKey: string;
+    protected username: string;
+    protected currentTenantOrg: string;
+    protected userTenants: Tenant[];
+    protected isAdmin: boolean;
+    protected mainTenantKey: string;
+    constructor(config: SubscriptionFlowConfig);
+    getPlatformName(): string;
+    getCurrentTenantKey(): string;
+    getUsername(): string;
+    getCurrentTenantOrg(): string;
+    getUserTenants(): Tenant[];
+    isUserAdmin(): boolean;
+    /**
+     * Handles the flow when user reaches their free usage limit
+     * Updates banner with appropriate message based on remaining usage count
+     */
+    handleFreeUsageCountFlow(freeUsageCount: FreeUsageCount): void;
+    /**
+     * Handles the flow when user's free trial period has ended
+     * Updates banner and clears any existing trial interval
+     */
+    handleTrialEndedFlow(freeTrialIntervalID?: number): void;
+    /**
+     * Handles the flow for ongoing subscription period
+     * Updates banner with remaining trial time and subscription options
+     */
+    handleSubscriptionOnGoingFlow(timeRemainingInString: string): void;
+    /**
+     * Handles redirection to external URLs with optional toast notification
+     */
+    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
+     */
+    handleSuccessfullySubscribedFlow(message?: string): void;
+    getMainTenantKey(): string;
+}
+export {};

package/dist/hooks/subscription/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const SUBSCRIPTION_TRIGGERS: {
+    PRICING_MODAL: string;
+    SUBSCRIBE_USER: string;
+};

package/dist/hooks/subscription/use-subscription-handler.d.ts

@@ -0,0 +1,11 @@
+import { SubscriptionFlow } from "./class-subscription-flow";
+/**
+ * Hook to handle subscription logic
+ * @param subscriptionFlow Instance of SubscriptionFlow that manages different subscription states and actions
+ */
+export declare const useSubscriptionHandler: (subscriptionFlow: SubscriptionFlow) => {
+    handleSubscriptionCheck: () => Promise<void>;
+    handleIntervalSubscriptionCheck: () => (() => void) | undefined;
+    trialCounterStarted: boolean;
+    bannerButtonTriggerCallback: (trigger: string) => () => void;
+};

package/dist/hooks/subscription-v2/class-subscription-flow.d.ts

@@ -0,0 +1,62 @@
+import { StripeContextResponse } from "@iblai/data-layer";
+interface Tenant {
+    key: string;
+    is_admin: boolean;
+    org: string;
+}
+export interface SubscriptionFlowConfigV2 {
+    platformName: string;
+    currentTenantKey: string;
+    username: string;
+    currentTenantOrg: string;
+    userTenants: Tenant[];
+    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
+ */
+export declare class SubscriptionFlowV2 {
+    protected platformName: string;
+    protected currentTenantKey: string;
+    protected username: string;
+    protected currentTenantOrg: string;
+    protected userTenants: Tenant[];
+    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[];
+    isUserAdmin(): boolean;
+    getUserEmail(): string;
+    getMainTenantKey(): string;
+    getMentorUrl(): string;
+    handleRedirectToBillingPageFlow(billingUrl: string): void;
+    handleBeforeTopUpCreditTriggerFlow(): void;
+    /**
+     * Handles the flow when user reaches their free usage limit
+     * Updates banner with appropriate message based on remaining usage count
+     */
+    handleFreeUsageCountFlow(hasCredits: boolean, appExists: boolean): void;
+    /**
+     * Displays the pricing modal for subscription options
+     */
+    handlePricingPageDisplayFlow(stripeContext: StripeContextResponse): void;
+    /**
+     * Displays error notification when payment flow fails
+     */
+    handleFailureOnPaymentFlow(): void;
+    handleBeforePricingPageDisplayFlow(): void;
+    handleFailureOnTopUpCreditTriggerFlow(): void;
+    handleCreditExhaustedFlow(isTenantOwnerAdmin: boolean): void;
+    handleOpenContactAdminFlow(adminEmail: string): void;
+}
+export {};

package/dist/hooks/subscription-v2/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const SUBSCRIPTION_V2_TRIGGERS: {
+    PRICING_MODAL: string;
+    TOP_UP_CREDIT: string;
+    CONTACT_ADMIN: string;
+};

package/dist/hooks/subscription-v2/use-external-pricing-plan.d.ts

@@ -0,0 +1,7 @@
+import { PricingModalData } from "@web-utils/types/subscription";
+export declare const useExternalPricingPlan: ({ pricingModalData, userEmail }: {
+    pricingModalData: PricingModalData;
+    userEmail: string;
+}) => {
+    pricingBoxIframeRef: import("react").RefObject<null>;
+};

package/dist/hooks/subscription-v2/use-subscription-handler.d.ts

@@ -0,0 +1,12 @@
+import { SubscriptionFlowV2 } from "./class-subscription-flow";
+/**
+ * Hook to handle subscription logic
+ * @param subscriptionFlow Instance of SubscriptionFlow that manages different subscription states and actions
+ */
+export declare const useSubscriptionHandlerV2: (subscriptionFlow: SubscriptionFlowV2) => {
+    handleSubscriptionCheck: () => Promise<void>;
+    bannerButtonTriggerCallback: (trigger: string) => () => void;
+    CREDIT_INTERVAL_CHECK_COUNTER: number;
+    getBillingURL: (returnURL?: string) => Promise<string | null | undefined>;
+    getTopUpURL: () => Promise<string | null>;
+};

package/dist/hooks/use-day-js.d.ts

@@ -0,0 +1,7 @@
+import type { OpUnitType } from "dayjs";
+import duration from "dayjs/plugin/duration";
+export declare const useDayJs: () => {
+    getTimeDifferenceBetweenTwoDates: (futureDate: string, pastDate: string, format?: OpUnitType) => number;
+    getDayJSDurationObjFromSeconds: (seconds: number) => duration.Duration;
+    generateFutureDateForNMinutes: (minute?: number) => string;
+};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./hooks";
+export * from "./providers";
+export * from "./utils";
+export * from "./types";
+export * from "./features";