@iblai/web-utils 1.10.12 → 1.11.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/web-utils",
-  "version": "1.10.11",
+  "version": "1.10.13",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",

package/dist/web-utils/src/hooks/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./use-tenant-switch-sync";
 export * from "./subscription/use-subscription-handler";
 export * from "./subscription/constants";
 export * from "./subscription/class-subscription-flow";

package/dist/web-utils/src/hooks/use-tenant-switch-sync.d.ts

@@ -0,0 +1,13 @@
+export interface UseTenantSwitchSyncOptions {
+    /** Called when ANOTHER tab broadcasts a tenant switch (self-echo filtered out). */
+    onRemoteSwitch?: (tenant: string) => void;
+}
+/**
+ * Subscribe to cross-tab tenant-switch broadcasts. Ignores this tab's own echo
+ * (BroadcastChannel delivers to sibling instances in the same tab) and refreshes
+ * the shared switch lock so this tab won't auto-revert during the switch window.
+ *
+ * @example
+ * useTenantSwitchSync();
+ */
+export declare function useTenantSwitchSync(options?: UseTenantSwitchSyncOptions): void;

package/dist/web-utils/src/index.web.d.ts

@@ -3,7 +3,8 @@ import { useAdvancedChat as _useAdvancedChat } from "./hooks/chat/use-advanced-c
 import { useTimeTracker as _useTimeTracker } from "./features/tracking/use-time-tracker";
 import { useMentorSettings as _useMentorSettings } from "./hooks/use-mentor-settings";
 import { getTimeAgo as _getTimeAgo } from "./utils";
-import { isInIframe as _isInIframe, sendMessageToParentWebsite as _sendMessageToParentWebsite, deleteCookie as _deleteCookie, getDomainParts as _getDomainParts, deleteCookieOnAllDomains as _deleteCookieOnAllDomains, getParentDomain as _getParentDomain, setCookieForAuth as _setCookieForAuth, clearCookies as _clearCookies, isLoggedIn as _isLoggedIn, getPlatformKey as _getPlatformKey, redirectToAuthSpa as _redirectToAuthSpa, getAuthSpaJoinUrl as _getAuthSpaJoinUrl, redirectToAuthSpaJoinTenant as _redirectToAuthSpaJoinTenant, handleLogout as _handleLogout } from "./utils/auth";
+import { isInIframe as _isInIframe, sendMessageToParentWebsite as _sendMessageToParentWebsite, deleteCookie as _deleteCookie, getDomainParts as _getDomainParts, deleteCookieOnAllDomains as _deleteCookieOnAllDomains, getParentDomain as _getParentDomain, setCookieForAuth as _setCookieForAuth, clearCookies as _clearCookies, isLoggedIn as _isLoggedIn, getPlatformKey as _getPlatformKey, redirectToAuthSpa as _redirectToAuthSpa, getAuthSpaJoinUrl as _getAuthSpaJoinUrl, redirectToAuthSpaJoinTenant as _redirectToAuthSpaJoinTenant, handleLogout as _handleLogout, handleTenantSwitch as _handleTenantSwitch, getTabId as _getTabId, readTenantSwitchLock as _readTenantSwitchLock, writeTenantSwitchLock as _writeTenantSwitchLock, refreshTenantSwitchLock as _refreshTenantSwitchLock, clearTenantSwitchLock as _clearTenantSwitchLock, isTenantSwitchInProgress as _isTenantSwitchInProgress } from "./utils/auth";
+import { useTenantSwitchSync as _useTenantSwitchSync } from "./hooks/use-tenant-switch-sync";
 import { AuthProvider as _AuthProvider, TenantProvider as _TenantProvider, MentorProvider as _MentorProvider } from "./providers";
 import { useSearchParams as _useSearchParams, useParams as _useParams, useRouter as _useRouter, usePathname as _usePathname } from "next/navigation";
 export declare const useGetChatDetails: typeof _useGetChatDetails;
@@ -87,6 +88,14 @@ export declare const redirectToAuthSpa: typeof _redirectToAuthSpa;
 export declare const getAuthSpaJoinUrl: typeof _getAuthSpaJoinUrl;
 export declare const redirectToAuthSpaJoinTenant: typeof _redirectToAuthSpaJoinTenant;
 export declare const handleLogout: typeof _handleLogout;
+export declare const handleTenantSwitch: typeof _handleTenantSwitch;
+export declare const getTabId: typeof _getTabId;
+export declare const readTenantSwitchLock: typeof _readTenantSwitchLock;
+export declare const writeTenantSwitchLock: typeof _writeTenantSwitchLock;
+export declare const refreshTenantSwitchLock: typeof _refreshTenantSwitchLock;
+export declare const clearTenantSwitchLock: typeof _clearTenantSwitchLock;
+export declare const isTenantSwitchInProgress: typeof _isTenantSwitchInProgress;
+export declare const useTenantSwitchSync: typeof _useTenantSwitchSync;
 export declare const chatActions: import("@reduxjs/toolkit").CaseReducerActions<import("@reduxjs/toolkit").SliceCaseReducers<import("./features/chat/slice").ChatSliceState>, string>;
 export declare const selectSessionId: (state: {
     chatSliceShared: import("./features/chat/slice").ChatSliceState;
@@ -121,4 +130,5 @@ export declare const useRouter: typeof _useRouter;
 export declare const usePathname: typeof _usePathname;
 export type { ChatMode } from "./types";
 export type { OAuthRequiredData, OAuthResolvedData, } from "./hooks/chat/use-chat-v2";
-export type { RedirectToAuthSpaOptions, HandleLogoutOptions, } from "./utils/auth";
+export type { RedirectToAuthSpaOptions, HandleLogoutOptions, TenantSwitchLock, HandleTenantSwitchOptions, } from "./utils/auth";
+export type { UseTenantSwitchSyncOptions } from "./hooks/use-tenant-switch-sync";

package/dist/web-utils/src/utils/__tests__/tenant-switch.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/web-utils/src/utils/auth.d.ts

@@ -198,3 +198,65 @@ export interface HandleLogoutOptions {
  * ```
  */
 export declare function handleLogout(options: HandleLogoutOptions): void;
+export declare const TENANT_SWITCH_CHANNEL = "ibl-tenant-switch";
+export declare const TENANT_SWITCH_LOCK_KEY = "ibl_tenant_switch_lock";
+export declare const DEFAULT_TENANT_SWITCH_LOCK_TTL_MS = 8000;
+export interface TenantSwitchLock {
+    tenant: string;
+    /** `${ts}-${tabId}` — monotonic; newer wins. */
+    token: string;
+    ts: number;
+    senderId: string;
+}
+/**
+ * Stable per-tab id. Uses sessionStorage so it survives same-tab reloads while
+ * staying unique per tab/window.
+ */
+export declare function getTabId(): string;
+/** The active (non-expired) tenant-switch lock, or null. */
+export declare function readTenantSwitchLock(ttlMs?: number): TenantSwitchLock | null;
+/** Write a fresh lock for `tenant` (newest intent). Returns the lock written. */
+export declare function writeTenantSwitchLock(tenant: string): TenantSwitchLock;
+/** Extend an existing lock's window from "now" (no-op when no active lock). */
+export declare function refreshTenantSwitchLock(): void;
+export declare function clearTenantSwitchLock(): void;
+/** True while a tenant switch is in flight — gate automatic reverts on this. */
+export declare function isTenantSwitchInProgress(ttlMs?: number): boolean;
+export interface HandleTenantSwitchOptions {
+    /** Auth SPA base URL (e.g. config.authUrl()). */
+    authUrl: string;
+    /** localStorage key for the saved redirect path (default "redirect-to"). */
+    redirectPathStorageKey?: string;
+    /** localStorage key for a JWT to forward through the switch (default "edx_jwt_token"). */
+    preserveTokenKey?: string;
+    /** localStorage key holding the tenant (default "tenant"). */
+    tenantStorageKey?: string;
+    /** Cookie name signalling a switch is in progress (default "ibl_tenant_switching"). */
+    tenantSwitchingCookie?: string;
+    /** Query-param names for the auth URL. */
+    queryParams?: {
+        tenant?: string;
+        redirectTo?: string;
+    };
+    /** Persist the current path so the app returns to it post-switch. */
+    saveRedirect?: boolean;
+    /** Explicit redirect target (defaults to window.location.origin). */
+    redirectUrl?: string;
+    /** Broadcast to other tabs + clear storage (true for user-initiated; default true). */
+    broadcast?: boolean;
+    /** Lock TTL override. */
+    lockTtlMs?: number;
+    /** Injected so this util stays React-free (mentorai passes the SDK's). */
+    clearCurrentTenantCookie?: () => void;
+}
+/**
+ * Switch the active tenant. Coordinates across tabs (TTL lock + BroadcastChannel),
+ * clears storage, then redirects through the auth SPA's `/login/complete`.
+ *
+ * @example
+ * await handleTenantSwitch("acme", {
+ *   authUrl: config.authUrl(),
+ *   clearCurrentTenantCookie,
+ * });
+ */
+export declare function handleTenantSwitch(tenant: string, options: HandleTenantSwitchOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/web-utils",
-  "version": "1.10.12",
+  "version": "1.11.0",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
   "types": "./dist/index.d.ts",