@skippr/live-agent-sdk 0.104.0 → 0.106.0

package/dist/types/capture/a11yUtils.d.ts

@@ -1,3 +1,4 @@
+export declare function hasFrameworkPointerHandler(element: Element): boolean;
 export declare function inferRole(element: Element): string | null;
 interface AccessibleNameOptions {
     quick?: boolean;

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

@@ -1,6 +1,7 @@
 interface AutoStartMediaProps {
     pendingScreenStream: MediaStream | null;
     pushOrTapMicMode?: boolean;
+    startMuted?: boolean;
 }
-export declare function AutoStartMedia({ pendingScreenStream, pushOrTapMicMode, }: AutoStartMediaProps): null;
+export declare function AutoStartMedia({ pendingScreenStream, pushOrTapMicMode, startMuted, }: AutoStartMediaProps): null;
 export {};

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

@@ -3,6 +3,7 @@ export declare function shouldIncludeInSnapshot(element: Element): boolean;
 export declare function shouldIncludeInFirstFrame(element: Element): boolean;
 interface DomCaptureProps {
     pushOrTapMicMode?: boolean;
+    startMuted?: boolean;
 }
-export declare function DomCapture({ pushOrTapMicMode }: DomCaptureProps): null;
+export declare function DomCapture({ pushOrTapMicMode, startMuted }: DomCaptureProps): null;
 export {};

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

@@ -1,5 +1,6 @@
 interface LogoProps {
     className?: string;
+    decorative?: boolean;
 }
-export declare function Logo({ className }: LogoProps): import("react/jsx-runtime").JSX.Element;
+export declare function Logo({ className, decorative }: LogoProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,6 +1,7 @@
 import { type ReactNode } from 'react';
 export declare const PROPERTIES_STYLE_ID = "skippr-tw-properties";
-export declare function ShadowHost({ children, accentColor, }: {
+export declare function ShadowHost({ children, accentColor, className, }: {
     children: ReactNode;
     accentColor?: string | null;
+    className?: string | undefined;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,30 @@
+import type { PhaseStatus } from '../hooks/usePhaseUpdates';
+import { type SplashIntent, type SplashSectionGlyph } from '../lib/constants';
+import type { SplashPresentation } from '../lib/splashPresentation';
+export interface SplashSectionView {
+    id: string;
+    title: string;
+    description: string;
+    iconUrl: string | null;
+    glyph: SplashSectionGlyph | null;
+}
+export interface SplashViewProps {
+    agentName: string;
+    presentation: SplashPresentation;
+    headerIconUrl: string | null;
+    sections: SplashSectionView[];
+    attributionVisible: boolean;
+    skipButtonVisible: boolean;
+    intent: SplashIntent;
+    lastCompletedPhase: PhaseStatus | null;
+    upcomingPhases: PhaseStatus[];
+    micEnabled: boolean;
+    startMuted: boolean;
+    screenEnabled: boolean | null;
+    enableMic: () => void;
+    toggleStartMuted: () => void;
+    enableScreen: () => void;
+    start: () => void;
+    dismiss: () => void;
+}
+export declare function SplashDefault({ agentName, presentation, headerIconUrl, sections, attributionVisible, skipButtonVisible, intent, lastCompletedPhase, upcomingPhases, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, start, dismiss, }: SplashViewProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,5 @@
+export interface SplashOverlayProps {
+    width?: number | undefined;
+    maxHeight?: number | undefined;
+}
+export declare function SplashOverlay({ width, maxHeight }: SplashOverlayProps): import("react/jsx-runtime").JSX.Element | null;

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

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

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

@@ -1,7 +1,7 @@
 import type { LauncherDropTarget } from '../hooks/useLauncherDrag';
 import type { PhaseStatus } from '../hooks/usePhaseUpdates';
 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 } 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 SplashSection, type SplashVariant } from '../lib/constants';
 import type { SessionStatus } from '../lib/sessionStatus';
 import type { BarPos } from '../lib/voiceBar';
 import type { Message } from '../types';
@@ -49,6 +49,16 @@ export interface BuddyAppearance {
     enabled: boolean;
     shape: BuddyShape;
 }
+export interface SplashAppearance {
+    enabled: boolean;
+    variant: SplashVariant;
+    copy?: SplashCopy;
+    sections?: SplashSection[];
+    attributionVisible?: boolean;
+    skipButtonVisible?: boolean;
+    width?: number;
+    maxHeight?: number;
+}
 export interface WidgetAppearance {
     accentColor: string | null;
     logoUrl: string | null;
@@ -56,6 +66,8 @@ export interface WidgetAppearance {
     verticalAlign: 'top' | 'middle' | 'bottom' | null;
     launcherMode: LauncherMode | null;
     buddy: BuddyAppearance | null;
+    splash: SplashAppearance | null;
+    splashIconUrls: Record<string, string> | null;
 }
 export interface IdleSessionHistory {
     messages: Message[];
@@ -140,8 +152,17 @@ export interface LiveAgentPublicValue {
     refetchModules: () => Promise<void>;
     selectModule: (id: string) => Promise<void>;
     textMode: boolean;
+    isSplashConfigured: boolean;
+    reopenSplash: () => void;
 }
 export interface LiveAgentContextValue extends LiveAgentPublicValue {
+    operatingModule: Module | null;
+    armScreenStream: (stream: MediaStream | null) => void;
+    startMuted: boolean;
+    setStartMuted: (muted: boolean) => void;
+    notifySplashMount: () => () => void;
+    splashDismissed: boolean;
+    dismissSplash: () => void;
     defaultAgentId: string | null;
     startDefaultSession: () => void;
     startPrimarySession: () => void;

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

@@ -23,6 +23,7 @@ export interface StartSessionOptions {
     adoptionGoalId?: string | undefined;
     autoStarted?: boolean | undefined;
 }
+export declare function requestScreenShare(): Promise<MediaStream | null>;
 export declare function useSession({ captureMode, authToken, appKey, getUserToken, userToken, userContext, onStart, onStartError, onDisconnect, }: UseSessionParams): {
     connection: LiveKitConnection | null;
     shouldConnect: boolean;
@@ -38,6 +39,7 @@ export declare function useSession({ captureMode, authToken, appKey, getUserToke
     pauseTimeoutSeconds: number | null;
     historyMessages: Message[];
     pendingScreenStream: MediaStream | null;
+    armScreenStream: (stream: MediaStream | null) => void;
     bearerToken: string | null;
     authedFetch: AuthedFetch;
     authFailed: boolean;

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

@@ -0,0 +1,2 @@
+import type { SplashViewProps } from '../components/SplashDefault';
+export declare function useSplash(onDismiss?: (() => void) | undefined): SplashViewProps | null;

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

@@ -1,2 +1,3 @@
 export declare function isHexColor(value: string): boolean;
 export declare function brandForeground(accentColor: string): string;
+export declare function brandOnWhite(accentColor: string): string;

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

@@ -75,9 +75,68 @@ 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;
+export type SplashVariant = 'default';
+export declare const SPLASH_COPY_DEFAULTS: {
+    readonly howItWorksHeading: "How it works";
+    readonly lastAccomplishmentHeading: "Last accomplishment";
+    readonly upNextHeading: "Up next";
+    readonly mediaHeading: "Enable access to use";
+    readonly micLabel: "Microphone";
+    readonly micSubtext: "Talk to Skippr hands-free";
+    readonly screenLabel: "Screen access";
+    readonly screenSubtext: "Skippr sees your screen while the session runs";
+    readonly startCta: "Start with Skippr";
+    readonly continueCta: "Continue session";
+    readonly dismissLabel: "Skip for now";
+};
+export type SplashCopyKey = keyof typeof SPLASH_COPY_DEFAULTS;
+export type SplashCopy = Partial<Record<SplashCopyKey, string>>;
+export declare const SPLASH_SECTION_GLYPH: {
+    readonly Route: "route";
+    readonly Messages: "messages";
+    readonly Pointer: "pointer";
+};
+export type SplashSectionGlyph = (typeof SPLASH_SECTION_GLYPH)[keyof typeof SPLASH_SECTION_GLYPH];
+export interface SplashSection {
+    id: string;
+    title?: string;
+    description?: string;
+    glyph?: SplashSectionGlyph;
+}
+export declare const DEFAULT_SPLASH_SECTIONS: readonly [{
+    readonly id: "9f2b1c4a-5d6e-4f70-8a91-b2c3d4e5f601";
+    readonly title: "Guides you step by step";
+    readonly description: "Walks you through each step, start to finish";
+    readonly glyph: "route";
+}, {
+    readonly id: "9f2b1c4a-5d6e-4f70-8a91-b2c3d4e5f602";
+    readonly title: "Talk or type";
+    readonly description: "Ask by voice or in chat";
+    readonly glyph: "messages";
+}, {
+    readonly id: "9f2b1c4a-5d6e-4f70-8a91-b2c3d4e5f603";
+    readonly title: "Ask it to click through for you";
+    readonly description: "Controls the environment for you";
+    readonly glyph: "pointer";
+}];
+export declare const SPLASH_HEADER_ICON_SLOT = "header";
+export declare const SPLASH_WIDTH_MIN_PX = 320;
+export declare const SPLASH_WIDTH_MAX_PX = 560;
+export declare const DEFAULT_SPLASH_WIDTH_PX = 420;
+export declare const SPLASH_MAX_HEIGHT_MIN_VH = 50;
+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 SPLASH_INTENT: {
+    readonly Start: "start";
+    readonly Continue: "continue";
+};
+export type SplashIntent = (typeof SPLASH_INTENT)[keyof typeof SPLASH_INTENT];
 export declare const PUSH_TO_TALK_KEY = "Backquote";
 export declare const PUSH_TO_TALK_KEY_LABEL = "`";
 export declare const STOP_AGENT_KEY = "KeyX";

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

@@ -0,0 +1,20 @@
+import type { SplashAppearance } from '../context/LiveAgentContext';
+import { type SplashCopyKey, type SplashSection, type SplashSectionGlyph } from './constants';
+export interface SplashPresentation {
+    copy: Record<SplashCopyKey, string>;
+    card: {
+        width: number;
+        maxHeight: number;
+    };
+}
+export interface ResolvedSplashSection {
+    id: string;
+    title: string;
+    description: string;
+    iconUrl: string | null;
+    glyph: SplashSectionGlyph | null;
+}
+export declare function resolveSplashSections(sections: SplashSection[] | null, iconUrls: Record<string, string> | null): ResolvedSplashSection[];
+export declare function clampSplashWidth(width: number): number;
+export declare function clampSplashMaxHeight(maxHeight: number): number;
+export declare function resolveSplashPresentation(splash: SplashAppearance | null): SplashPresentation;

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

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

package/package.json

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