@skippr/live-agent-sdk 0.109.0 → 0.111.0

package/dist/types/components/ConsentBubble.d.ts

@@ -1,9 +1,9 @@
 interface ConsentBubbleProps {
     className?: string;
     style?: React.CSSProperties;
-    leadIn: string;
+    template: string;
     onPointerEnter?: React.PointerEventHandler<HTMLDivElement>;
     onPointerLeave?: React.PointerEventHandler<HTMLDivElement>;
 }
-export declare function ConsentBubble({ className, style, leadIn, onPointerEnter, onPointerLeave, }: ConsentBubbleProps): import("react/jsx-runtime").JSX.Element;
+export declare function ConsentBubble({ className, style, template, onPointerEnter, onPointerLeave, }: ConsentBubbleProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/ConsentNotice.d.ts

@@ -1,7 +1,6 @@
 interface ConsentNoticeProps {
     className?: string;
-    leadIn: string;
-    determiner?: string;
+    template: string;
 }
-export declare function ConsentNotice({ className, leadIn, determiner }: ConsentNoticeProps): import("react/jsx-runtime").JSX.Element;
+export declare function ConsentNotice({ className, template }: ConsentNoticeProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/LiveAgent.d.ts

@@ -9,6 +9,7 @@ interface LiveAgentBaseProps {
     getUserToken?: (() => Promise<string>) | undefined;
     userToken?: string | undefined;
     userContext?: UserContext | undefined;
+    locale?: string | undefined;
     verticalAlign?: VerticalAlign | undefined;
     variant?: 'floating' | 'sidebar' | undefined;
     minimizable?: boolean | undefined;

package/dist/types/components/Sidebar.d.ts

@@ -3,5 +3,5 @@ interface SidebarProps {
     hideHeader?: boolean;
     startSessionLabel?: string;
 }
-export declare function Sidebar({ hideControls, hideHeader, startSessionLabel, }: SidebarProps): import("react/jsx-runtime").JSX.Element;
+export declare function Sidebar({ hideControls, hideHeader, startSessionLabel, }: SidebarProps): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/types/components/SplashAlwaysOn.d.ts

@@ -1,3 +1,4 @@
+import type { Ref } from 'react';
 import type { AdoptionGoalMatch } from '../context/LiveAgentContext';
 import type { SplashPresentation } from '../lib/splashPresentation';
 export interface SplashAlwaysOnViewProps {
@@ -5,6 +6,7 @@ export interface SplashAlwaysOnViewProps {
     presentation: SplashPresentation;
     headerIconUrl: string | null;
     attributionVisible: boolean;
+    optOutVisible: boolean;
     tips: AdoptionGoalMatch[];
     micEnabled: boolean;
     startMuted: boolean;
@@ -15,5 +17,8 @@ export interface SplashAlwaysOnViewProps {
     startTip: (goal: AdoptionGoalMatch) => void;
     start: () => void;
     dismiss: () => void;
+    optOutChecked: boolean;
+    toggleOptOut: () => void;
+    ctaRef?: Ref<HTMLButtonElement>;
 }
-export declare function SplashAlwaysOn({ agentName, presentation, headerIconUrl, attributionVisible, tips, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, startTip, start, dismiss, }: SplashAlwaysOnViewProps): import("react/jsx-runtime").JSX.Element;
+export declare function SplashAlwaysOn({ agentName, presentation, headerIconUrl, attributionVisible, optOutVisible, tips, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, startTip, start, dismiss, optOutChecked, toggleOptOut, ctaRef, }: SplashAlwaysOnViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/SplashOptOut.d.ts

@@ -0,0 +1,5 @@
+export declare function SplashOptOut({ label, checked, onToggle, }: {
+    label: string;
+    checked: boolean;
+    onToggle: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/SplashOverlay.d.ts

@@ -1,5 +1,3 @@
-export interface SplashOverlayProps {
-    width?: number | undefined;
-    maxHeight?: number | undefined;
-}
-export declare function SplashOverlay({ width, maxHeight }: SplashOverlayProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const SPLASH_DIALOG_ATTRIBUTE = "data-skippr-splash";
+export declare const BACKDROP_RESET_STYLE_ID = "skippr-splash-backdrop";
+export declare function SplashOverlay(): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/SplashPanel.d.ts

@@ -0,0 +1 @@
+export declare function SplashPanel(): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/SplashPrimary.d.ts

@@ -1,3 +1,4 @@
+import type { Ref } from 'react';
 import type { PhaseStatus } from '../hooks/usePhaseUpdates';
 import { type SplashIntent, type SplashSectionGlyph } from '../lib/constants';
 import type { SplashPresentation } from '../lib/splashPresentation';
@@ -15,6 +16,7 @@ export interface SplashViewProps {
     sections: SplashSectionView[];
     attributionVisible: boolean;
     skipButtonVisible: boolean;
+    optOutVisible: boolean;
     intent: SplashIntent;
     lastCompletedPhase: PhaseStatus | null;
     upcomingPhases: PhaseStatus[];
@@ -26,5 +28,8 @@ export interface SplashViewProps {
     enableScreen: () => void;
     start: () => void;
     dismiss: () => void;
+    optOutChecked: boolean;
+    toggleOptOut: () => void;
+    ctaRef?: Ref<HTMLButtonElement>;
 }
-export declare function SplashPrimary({ agentName, presentation, headerIconUrl, sections, attributionVisible, skipButtonVisible, intent, lastCompletedPhase, upcomingPhases, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, start, dismiss, }: SplashViewProps): import("react/jsx-runtime").JSX.Element;
+export declare function SplashPrimary({ agentName, presentation, headerIconUrl, sections, attributionVisible, skipButtonVisible, optOutVisible, intent, lastCompletedPhase, upcomingPhases, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, start, dismiss, optOutChecked, toggleOptOut, ctaRef, }: SplashViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/SplashScreen.d.ts

@@ -2,4 +2,4 @@ export interface SplashScreenProps {
     className?: string | undefined;
     onDismiss?: (() => void) | undefined;
 }
-export declare function SplashScreen({ className, onDismiss }: SplashScreenProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function SplashScreen({ className, onDismiss }: SplashScreenProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/context/LiveAgentContext.d.ts

@@ -1,9 +1,11 @@
 import type { LauncherDropTarget } from '../hooks/useLauncherDrag';
 import type { PhaseStatus } from '../hooks/usePhaseUpdates';
+import type { SplashMedia } from '../hooks/useSplashMedia';
 import type { AgentMode } from '../lib/agentMode';
-import { type ActionPlanMode, type BuddyShape, CAPTURE_MODE, type CaptureMode, type ChatSurface, DEFAULT_CAPTURE_MODE, type LauncherMode, MIC_MODE, type MicMode, type PENDING_START_KIND, type SplashCopy, type SplashSection } from '../lib/constants';
+import { type ActionPlanMode, type BuddyShape, CAPTURE_MODE, type CaptureMode, type ChatSurface, DEFAULT_CAPTURE_MODE, type LauncherMode, MIC_MODE, type MicMode, type PENDING_START_KIND, type SplashCopy, type SplashOverlayMode, type SplashSection, type SplashSurface } from '../lib/constants';
 import type { SessionStatus } from '../lib/sessionStatus';
-import type { BarPos } from '../lib/voiceBar';
+import type { SplashSurfaces } from '../lib/splashSurfaces';
+import type { BarDock, BarPos } from '../lib/voiceBar';
 import type { Message } from '../types';
 export type SidebarTab = 'chat' | 'agenda';
 export { CAPTURE_MODE, type CaptureMode, DEFAULT_CAPTURE_MODE, MIC_MODE, type MicMode };
@@ -13,6 +15,7 @@ export interface AgentControls {
     actionPlanMode?: ActionPlanMode;
     micMode?: MicMode;
     chat?: ChatSurface;
+    showSplash?: boolean;
 }
 export type UserContext = Record<string, string | number | boolean>;
 export interface UiPreferences {
@@ -52,11 +55,16 @@ export interface BuddyAppearance {
 export interface SplashAppearance {
     enabled: boolean;
     variant: 'primary';
+    overlayMode?: SplashOverlayMode;
+    panelEnabled?: boolean;
+    launcherVisible?: boolean;
+    locale?: string;
     copy?: SplashCopy;
     sections?: SplashSection[];
     attributionVisible?: boolean;
     startSkipButtonVisible?: boolean;
     continueSkipButtonVisible?: boolean;
+    overlayOptOutVisible?: boolean;
     width?: number;
     maxHeight?: number;
 }
@@ -130,6 +138,7 @@ export interface LiveAgentPublicValue {
     minimizable: boolean;
     isMinimized: boolean;
     expandPanel: () => void;
+    expandPanelForChat: () => void;
     minimizePanel: () => void;
     revealBar: () => void;
     isAuthenticated: boolean;
@@ -157,13 +166,16 @@ export interface LiveAgentPublicValue {
     reopenSplash: () => void;
 }
 export interface LiveAgentContextValue extends LiveAgentPublicValue {
+    splashSurfaces: SplashSurfaces;
+    isSplashDismissed: boolean;
+    isLauncherHiddenBySplash: boolean;
     operatingModule: Module | null;
     armScreenStream: (stream: MediaStream | null) => void;
     startMuted: boolean;
     setStartMuted: (muted: boolean) => void;
-    notifySplashMount: () => () => void;
-    splashDismissed: boolean;
-    dismissSplash: () => void;
+    splashMedia: SplashMedia;
+    dismissSplash: (surface: SplashSurface) => void;
+    optOutOfSplashOverlay: () => void;
     defaultAgentId: string | null;
     startDefaultSession: () => void;
     startPrimarySession: () => void;
@@ -196,6 +208,8 @@ export interface LiveAgentContextValue extends LiveAgentPublicValue {
     popsDown: boolean;
     barPos: BarPos | null;
     setBarPos: (next: BarPos) => void;
+    launcherDock: BarDock;
+    setLauncherDock: (next: BarDock) => void;
     panelExpanded: boolean;
     togglePanelExpanded: () => void;
     panelRef: React.RefObject<HTMLDivElement | null>;

package/dist/types/hooks/useAvailableModules.d.ts

@@ -5,15 +5,17 @@ interface UseAvailableModulesParams {
     bearerToken: string | null;
     authedFetch: AuthedFetch;
     agentId?: string | undefined;
+    locale?: string | undefined;
 }
 interface UseAvailableModulesResult {
     modules: Module[];
     defaultSelection: ModuleDefault;
     appearance: WidgetAppearance | null;
+    splashOverlayOptedOut: boolean;
     isLoading: boolean;
     hasResolved: boolean;
     error: string | null;
     refetch: () => Promise<void>;
 }
-export declare function useAvailableModules({ enabled, bearerToken, authedFetch, agentId, }: UseAvailableModulesParams): UseAvailableModulesResult;
+export declare function useAvailableModules({ enabled, bearerToken, authedFetch, agentId, locale, }: UseAvailableModulesParams): UseAvailableModulesResult;
 export {};

package/dist/types/hooks/useSplash.d.ts

@@ -1,9 +1,9 @@
 import type { SplashAlwaysOnViewProps } from '../components/SplashAlwaysOn';
 import type { SplashViewProps } from '../components/SplashPrimary';
-import { SPLASH_LAYOUT } from '../lib/constants';
+import { SPLASH_LAYOUT, type SplashSurface } from '../lib/constants';
 export type ResolvedSplash = ({
     layout: typeof SPLASH_LAYOUT.Primary;
 } & SplashViewProps) | ({
     layout: typeof SPLASH_LAYOUT.AlwaysOn;
 } & SplashAlwaysOnViewProps);
-export declare function useSplash(onDismiss?: (() => void) | undefined): ResolvedSplash | null;
+export declare function useSplash(surface: SplashSurface, onDismiss?: (() => void) | undefined): ResolvedSplash | null;

package/dist/types/hooks/useSplashMedia.d.ts

@@ -0,0 +1,14 @@
+export interface SplashMedia {
+    micEnabled: boolean;
+    screenEnabled: boolean;
+    enableMic: () => void;
+    enableScreen: () => void;
+    releaseScreen: () => void;
+}
+interface SplashMediaInputs {
+    armScreenStream: (stream: MediaStream | null) => void;
+    isSplashVisible: boolean;
+    isSessionLive: boolean;
+}
+export declare function useSplashMedia({ armScreenStream, isSplashVisible, isSessionLive, }: SplashMediaInputs): SplashMedia;
+export {};

package/dist/types/hooks/useSplashOverlayOptOut.d.ts

@@ -0,0 +1,7 @@
+import type { AuthedFetch } from './useSession';
+interface SplashOverlayOptOut {
+    optedOut: boolean;
+    optOut: () => void;
+}
+export declare function useSplashOverlayOptOut(authedFetch: AuthedFetch, recordedForUser: boolean): SplashOverlayOptOut;
+export {};

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

@@ -63,6 +63,11 @@ export declare const CHAT_SURFACE: {
 };
 export type ChatSurface = (typeof CHAT_SURFACE)[keyof typeof CHAT_SURFACE];
 export declare const DEFAULT_CHAT_SURFACE: ChatSurface;
+export declare const PANEL_ENTRY: {
+    readonly Launcher: "launcher";
+    readonly Chat: "chat";
+};
+export type PanelEntry = (typeof PANEL_ENTRY)[keyof typeof PANEL_ENTRY];
 export declare const ACTION_PLAN_MODE: {
     readonly Always: "always";
     readonly Auto: "auto";
@@ -75,7 +80,6 @@ export declare const LAUNCHER_MODE: {
     readonly Strip: "strip";
     readonly None: "none";
     readonly Custom: "custom";
-    readonly Template: "template";
 };
 export type LauncherMode = (typeof LAUNCHER_MODE)[keyof typeof LAUNCHER_MODE];
 export declare const DEFAULT_LAUNCHER_MODE: LauncherMode;
@@ -84,6 +88,28 @@ export declare const SPLASH_LAYOUT: {
     readonly AlwaysOn: "always_on";
 };
 export type SplashLayout = (typeof SPLASH_LAYOUT)[keyof typeof SPLASH_LAYOUT];
+export declare const SPLASH_OVERLAY_MODE: {
+    readonly Always: "always";
+    readonly UntilFirstSession: "until_first_session";
+    readonly Never: "never";
+};
+export type SplashOverlayMode = (typeof SPLASH_OVERLAY_MODE)[keyof typeof SPLASH_OVERLAY_MODE];
+export declare const DEFAULT_SPLASH_OVERLAY_MODE: SplashOverlayMode;
+export declare const DEFAULT_SPLASH_PANEL_ENABLED = false;
+export declare const DEFAULT_SPLASH_LAUNCHER_VISIBLE = true;
+export declare const DEFAULT_AGENT_SHOW_SPLASH = true;
+export declare const SPLASH_SURFACE: {
+    readonly Overlay: "overlay";
+    readonly Panel: "panel";
+    readonly Host: "host";
+};
+export type SplashSurface = (typeof SPLASH_SURFACE)[keyof typeof SPLASH_SURFACE];
+export declare const SKIPPR_OPEN_EVENT = "skippr:open";
+export declare const CONSENT_TERMS_PLACEHOLDER = "{terms}";
+export declare const CONSENT_PRIVACY_PLACEHOLDER = "{privacy}";
+export declare const CONSENT_NOTICE_SESSION_START = "By starting a session, you agree to Skippr's {terms} & {privacy}";
+export declare const CONSENT_NOTICE_CONTINUING = "By continuing, you agree to the {terms} & {privacy}";
+export declare const CONSENT_NOTICE_AGENT_SESSION_START = "By starting the AI agent session, you agree to Skippr's {terms} & {privacy}";
 export declare const SPLASH_COPY_DEFAULTS: {
     readonly howItWorksHeading: "How it works";
     readonly lastAccomplishmentHeading: "Last accomplishment";
@@ -96,10 +122,25 @@ export declare const SPLASH_COPY_DEFAULTS: {
     readonly startCta: "Start with Skippr";
     readonly continueCta: "Continue session";
     readonly dismissLabel: "Skip for now";
+    readonly optOutLabel: "Don't show this again";
     readonly tipsHeading: "Tips";
     readonly tipsCta: "Need help with something else?";
     readonly tipsEmptyTitle: "Ask about this page";
     readonly tipsEmptyDescription: "Get instant answers about anything you see here";
+    readonly attributionPrefix: "AI Agent Powered by";
+    readonly closeLabel: "Close";
+    readonly mediaEnableAction: "Enable";
+    readonly mediaEnabledStatus: "Enabled";
+    readonly micMutedStatus: "Muted";
+    readonly screenRequiredStatus: "Required";
+    readonly muteMicAction: "Mute microphone";
+    readonly consentNotice: "By starting a session, you agree to Skippr's {terms} & {privacy}";
+    readonly sectionRouteTitle: "Guides you step by step";
+    readonly sectionRouteDescription: "Walks you through each step, start to finish";
+    readonly sectionMessagesTitle: "Talk or type";
+    readonly sectionMessagesDescription: "Ask by voice or in chat";
+    readonly sectionPointerTitle: "Ask it to click through for you";
+    readonly sectionPointerDescription: "Controls the environment for you";
 };
 export type SplashCopyKey = keyof typeof SPLASH_COPY_DEFAULTS;
 export type SplashCopy = Partial<Record<SplashCopyKey, string>>;
@@ -140,6 +181,7 @@ export declare const SPLASH_MAX_HEIGHT_MAX_VH = 95;
 export declare const DEFAULT_SPLASH_MAX_HEIGHT_VH = 90;
 export declare const DEFAULT_SPLASH_ATTRIBUTION_VISIBLE = true;
 export declare const DEFAULT_SPLASH_SKIP_BUTTON_VISIBLE = true;
+export declare const DEFAULT_SPLASH_OVERLAY_OPT_OUT_VISIBLE = true;
 export declare const SPLASH_INTENT: {
     readonly Start: "start";
     readonly Continue: "continue";

package/dist/types/lib/locale.d.ts

@@ -0,0 +1,2 @@
+export declare function detectLocale(configLocale: string | undefined): string | undefined;
+export declare function useDetectedLocale(configLocale: string | undefined): string | undefined;

package/dist/types/lib/panelAnchor.d.ts

@@ -0,0 +1,14 @@
+import type { CSSProperties } from 'react';
+import { type BarDock, type BarPos } from './voiceBar';
+export declare const PANEL_GAP_PX = 12;
+export declare const PANEL_VIEWPORT_MARGIN_PX = 24;
+export declare const PANEL_MAX_HEIGHT_PX = 460;
+export interface PanelAnchor {
+    style: CSSProperties;
+    availableHeight: string;
+    popsDown: boolean;
+    isLeftAligned: boolean;
+}
+export declare function resolvePanelAnchor(barPos: BarPos | null, widthPx: number): PanelAnchor;
+export declare function resolveLauncherAnchor(dock: BarDock, widthPx: number): PanelAnchor;
+export declare function panelTransformOrigin(popsDown: boolean, isLeftAligned: boolean): string;

package/dist/types/lib/splashPresentation.d.ts

@@ -1,6 +1,7 @@
 import type { SplashAppearance } from '../context/LiveAgentContext';
 import { type SplashCopyKey, type SplashSection, type SplashSectionGlyph } from './constants';
 export interface SplashPresentation {
+    locale: string;
     copy: Record<SplashCopyKey, string>;
     card: {
         width: number;

package/dist/types/lib/splashStyles.d.ts

@@ -8,3 +8,6 @@ export declare const ROW_SUBTEXT = "skippr:text-[12px] skippr:text-[#6b6875]";
 export declare const ROW_ICON = "skippr:size-[17px]";
 export declare const ROW_ICON_STROKE = 1.8;
 export declare const FOCUS_RING = "skippr:focus-visible:outline-2 skippr:focus-visible:outline-offset-2 skippr:focus-visible:outline-[var(--skippr-brand)]";
+export declare const FOOTER_LINK = "skippr:text-[12px] skippr:text-[#6b6875] skippr:focus-visible:outline-2 skippr:focus-visible:outline-offset-2 skippr:focus-visible:outline-[var(--skippr-brand)] skippr:mt-2 skippr:block skippr:w-full skippr:cursor-pointer skippr:py-1 skippr:text-center skippr:transition-colors skippr:hover:text-[#2D2D3F]";
+export declare const CARD_SHELL = "skippr:flex skippr:w-full skippr:flex-col skippr:overflow-hidden";
+export declare const CARD_FRAME = "skippr:rounded-[16px] skippr:bg-white skippr:shadow-[0_0_0_1px_rgba(45,45,63,0.10),0_1px_2px_rgba(45,45,63,0.04)]";

package/dist/types/lib/splashSurfaces.d.ts

@@ -0,0 +1,22 @@
+import type { AgentControls, SplashAppearance } from '../context/LiveAgentContext';
+import { type PanelEntry } from './constants';
+export interface SplashSurfaces {
+    applies: boolean;
+    overlay: boolean;
+    panel: boolean;
+}
+export interface SplashSurfaceInputs {
+    splash: SplashAppearance | null;
+    defaultAgentControls: AgentControls | null;
+    isRoomChat: boolean;
+    hasStartedSession: boolean;
+    isAuthenticated: boolean;
+    isLive: boolean;
+    overlayOptedOut: boolean;
+}
+export declare const NO_SPLASH_SURFACES: SplashSurfaces;
+export declare function resolveSplashSurfaces({ splash, defaultAgentControls, isRoomChat, hasStartedSession, isAuthenticated, isLive, overlayOptedOut, }: SplashSurfaceInputs): SplashSurfaces;
+export declare function visibleSplashSurfaces(configured: SplashSurfaces, { pageDismissed, panelEntry }: {
+    pageDismissed: boolean;
+    panelEntry: PanelEntry;
+}): SplashSurfaces;

package/dist/types/lib/voiceBar.d.ts

@@ -2,6 +2,7 @@ export type BarEdge = 'left' | 'right' | 'top' | 'bottom';
 export declare const VOICE_BAR_EDGE_MARGIN_PX = 16;
 export declare const VOICE_BAR_HEIGHT_PX = 46;
 export declare const VOICE_BAR_WIDTH_PX = 255;
+export declare const LAUNCHER_DOCK_THICKNESS_PX = 56;
 export interface BarDock {
     edge: BarEdge;
     offsetPx: number;

package/dist/types/lib-exports.d.ts

@@ -1,5 +1,4 @@
 export * from './components/LiveAgent';
-export * from './components/SplashOverlay';
 export * from './components/SplashScreen';
 export type { Module, UserContext } from './context/LiveAgentContext';
 export * from './hooks/useAgentVoiceState';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skippr/live-agent-sdk",
-  "version": "0.109.0",
+  "version": "0.111.0",
   "type": "module",
   "main": "dist/esm/lib-exports.js",
   "module": "dist/esm/lib-exports.js",