@skippr/live-agent-sdk 0.115.0 → 0.117.0

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

@@ -1,4 +1,5 @@
 import type { LauncherDropTarget } from '../hooks/useLauncherDrag';
+import type { PhaseLabels } from '../hooks/usePhaseLabels';
 import type { PhaseStatus } from '../hooks/usePhaseUpdates';
 import type { SplashMedia } from '../hooks/useSplashMedia';
 import type { AgentMode } from '../lib/agentMode';
@@ -197,6 +198,7 @@ export interface LiveAgentContextValue extends LiveAgentPublicValue {
     idleHistory: IdleSessionHistory;
     phasesSnapshot: unknown[];
     setPhasesSnapshot: (phases: unknown[]) => void;
+    phaseLabels: PhaseLabels;
     hasResolvedModules: boolean;
     appearance: WidgetAppearance | null;
     adoptionGoals: AdoptionGoalMatch[];

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

@@ -0,0 +1,2 @@
+import { type ChromeCopy } from '../lib/chromeCopy';
+export declare function useChromeCopy(): ChromeCopy;

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

@@ -0,0 +1,14 @@
+import { type TranslatedLocale } from '../lib/localeCopy';
+import type { PhaseStatus } from './usePhaseUpdates';
+export interface PhaseLabelRead {
+    agentId: string | null;
+    agentName?: string;
+    nameTranslations?: Partial<Record<TranslatedLocale, string>>;
+    phases: PhaseStatus[];
+}
+export interface PhaseLabels {
+    agentId: string | null;
+    agentName?: string | undefined;
+    byPhaseName: Record<string, string>;
+}
+export declare function usePhaseLabels(session: PhaseLabelRead | null, { agentId: idleAgentId, phases: idlePhases }: PhaseLabelRead, locale: string | undefined): PhaseLabels;

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

@@ -1,5 +1,11 @@
+import type { TranslatedLocale } from '../lib/localeCopy';
 export interface PhaseStatus {
     name: string;
+    displayName?: string;
+    translations?: Partial<Record<TranslatedLocale, {
+        name?: string;
+        description?: string;
+    }>>;
     description: string;
     highlights: string[];
     status: 'pending' | 'active' | 'completed';

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

@@ -1,5 +1,6 @@
 import type { AgentControls, CaptureMode, UserContext } from '../context/LiveAgentContext';
 import type { Message } from '../types';
+import type { PhaseLabelRead } from './usePhaseLabels';
 export type AuthedFetch = (input: string, init?: RequestInit) => Promise<Response>;
 interface LiveKitConnection {
     livekitUrl: string;
@@ -40,6 +41,7 @@ export declare function useSession({ captureMode, locale, authToken, appKey, get
     isPaused: boolean;
     isPausing: boolean;
     pauseTimeoutSeconds: number | null;
+    sessionAgenda: PhaseLabelRead | null;
     historyMessages: Message[];
     pendingScreenStream: MediaStream | null;
     armScreenStream: (stream: MediaStream | null) => void;

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

@@ -10,6 +10,7 @@ interface UseSessionHistoryParams {
     agentId: string | undefined;
     enabled: boolean;
     authedFetch: AuthedFetch;
+    locale: string | undefined;
 }
-export declare function useSessionHistory({ agentId, enabled, authedFetch, }: UseSessionHistoryParams): SessionHistory;
+export declare function useSessionHistory({ agentId, enabled, authedFetch, locale, }: UseSessionHistoryParams): SessionHistory;
 export {};

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

@@ -0,0 +1,137 @@
+export interface ChromeCopy {
+    agendaTitle: string;
+    agendaLoading: string;
+    agendaProgress: string;
+    agendaProgressLabel: string;
+    agendaNowBadge: string;
+    micHoldToTalk: string;
+    micReleaseToSend: string;
+    micTapToTalk: string;
+    micTapToSend: string;
+    micShortcutHint: string;
+    voiceBarThinking: string;
+    voiceBarTalking: string;
+    voiceBarListening: string;
+    voiceBarPushToTalk: string;
+    voiceBarTapToTalk: string;
+    voiceBarWorking: string;
+    voiceBarNoActivity: string;
+    voiceBarLoading: string;
+    voiceBarShortcutTalk: string;
+    voiceBarShortcutEnd: string;
+    voiceBarTalkToAgent: string;
+    openChatLabel: string;
+    closeChatLabel: string;
+    openAgentLabel: string;
+    showNotificationsLabel: string;
+    askLabel: string;
+    wakeLabel: string;
+    dismissLabel: string;
+    loading: string;
+    endingSession: string;
+    loadingConversation: string;
+    statusStandingBy: string;
+    statusObserving: string;
+    statusConnected: string;
+    statusTalking: string;
+    statusThinking: string;
+    statusPaused: string;
+    statusAriaStandingBy: string;
+    statusAriaPaused: string;
+    statusAriaClickToOpenChat: string;
+    closeLabel: string;
+    muteLabel: string;
+    unmuteLabel: string;
+    resumeLabel: string;
+    stopLabel: string;
+    pauseLabel: string;
+    endSessionLabel: string;
+    shareScreenLabel: string;
+    stopSharingScreenLabel: string;
+    stopActionsLabel: string;
+    chatMessagePlaceholder: string;
+    chatMessageLabel: string;
+    chatSendMessageLabel: string;
+    chatSendLabel: string;
+    chatEmptyConversation: string;
+    chatWaitingToBegin: string;
+    chatJumpToLatest: string;
+    chatSwitchToVoice: string;
+    chatSwitchToText: string;
+    chatToggleVoice: string;
+    chatToggleText: string;
+    chatPanelLabel: string;
+    chatAnalyzingScreen: string;
+    cardDismissLink: string;
+    cardCopyLink: string;
+    cardCopied: string;
+    cardDismissPlan: string;
+    cardDismissSignIn: string;
+    controlBarIdle: string;
+    controlBarListening: string;
+    controlBarThinking: string;
+    controlBarTalking: string;
+    controlBarWorking: string;
+    controlBarStandingBy: string;
+    controlBarAriaActing: string;
+    controlBarAriaIdle: string;
+    controlBarAriaListening: string;
+    controlBarAriaThinking: string;
+    controlBarAriaTalking: string;
+    controlBarAriaState: string;
+    controlBarOpenAgenda: string;
+    controlBarClosePanel: string;
+    pausedClosingIn: string;
+    pausedClosingInAria: string;
+    loginTitle: string;
+    loginSubtitle: string;
+    loginEmailLabel: string;
+    loginEmailPlaceholder: string;
+    loginContinue: string;
+    loginOtpTitle: string;
+    loginOtpSubtitle: string;
+    loginOtpDigitLabel: string;
+    loginVerify: string;
+    loginChangeEmail: string;
+    loginResendCode: string;
+    loginResendCooldown: string;
+    loginConsent: string;
+    actionClicking: string;
+    actionTyping: string;
+    actionSelecting: string;
+    actionScrolling: string;
+    actionHovering: string;
+    highlightDefaultLabel: string;
+    planTitle: string;
+    planApprove: string;
+    planApproving: string;
+    planCancel: string;
+    voiceBarPlanIntro: string;
+    voiceBarPlanStepsHint: string;
+    voiceBarPlanApprove: string;
+    voiceBarPlanApproving: string;
+    voiceBarPlanCancel: string;
+    voiceBarPlanApproved: string;
+    cardOpenLink: string;
+    voiceBarCardOpen: string;
+    voiceBarCardCopy: string;
+    voiceBarCardCopied: string;
+    chatTabChat: string;
+    chatTabAgenda: string;
+    chatPanelTitle: string;
+    voiceBarSignInTitle: string;
+    voiceBarTextMode: string;
+    sessionEndingSoon: string;
+    controlBarTranscriptListening: string;
+    tipStartLabel: string;
+    tipNextLabel: string;
+    voiceBarTipStart: string;
+    buddyWakeGreeting: string;
+    buddyHoldHint: string;
+    buddyAutoOffNotice: string;
+    attributionPrefix: string;
+    consentSessionStart: string;
+    consentContinuing: string;
+    consentAgentSessionStart: string;
+}
+export declare const resolveChromeCopy: (tag: string | undefined) => ChromeCopy;

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

@@ -0,0 +1,5 @@
+export type TranslatedLocale = 'fr' | 'de' | 'it' | 'es' | 'pt-PT' | 'pt-BR';
+export declare function matchTranslatedLocale(tag: string | undefined): TranslatedLocale | undefined;
+export declare function createLocaleCopyResolver<T>(defaults: T, translations: Record<TranslatedLocale, T>): (tag: string | undefined) => T;
+export declare function fillPlaceholders(template: string, values: Record<string, string | number>): string;
+export declare function splitOnPlaceholder(template: string, name: string): [string, string];

package/package.json

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