@skippr/live-agent-sdk 0.124.0 → 0.126.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/esm/lib-exports.js +109 -37
- package/dist/skippr-sdk.css +1 -1
- package/dist/skippr-sdk.js +90 -90
- package/dist/types/components/DomCapture.d.ts +2 -1
- package/dist/types/components/LiveAgent.d.ts +1 -0
- package/dist/types/components/SplashPrimary.d.ts +2 -1
- package/dist/types/context/LiveAgentContext.d.ts +2 -0
- package/dist/types/hooks/useSessionHold.d.ts +1 -1
- package/dist/types/lib/agentSender.d.ts +2 -0
- package/dist/types/lib/constants.d.ts +3 -0
- package/dist/types/lib/hostStart.d.ts +6 -0
- package/dist/types/lib/splashStyles.d.ts +1 -0
- package/package.json +1 -1
|
@@ -4,6 +4,7 @@ export declare function shouldIncludeInFirstFrame(element: Element): boolean;
|
|
|
4
4
|
interface DomCaptureProps {
|
|
5
5
|
pushOrTapMicMode?: boolean;
|
|
6
6
|
startMuted?: boolean;
|
|
7
|
+
suppressVideoPublish?: boolean;
|
|
7
8
|
}
|
|
8
|
-
export declare function DomCapture({ pushOrTapMicMode, startMuted }: DomCaptureProps): null;
|
|
9
|
+
export declare function DomCapture({ pushOrTapMicMode, startMuted, suppressVideoPublish, }: DomCaptureProps): null;
|
|
9
10
|
export {};
|
|
@@ -14,6 +14,7 @@ export interface SplashViewProps {
|
|
|
14
14
|
presentation: SplashPresentation;
|
|
15
15
|
headerIconUrl: string | null;
|
|
16
16
|
sections: SplashSectionView[];
|
|
17
|
+
greetingText: string;
|
|
17
18
|
attributionVisible: boolean;
|
|
18
19
|
skipButtonVisible: boolean;
|
|
19
20
|
optOutVisible: boolean;
|
|
@@ -32,4 +33,4 @@ export interface SplashViewProps {
|
|
|
32
33
|
toggleOptOut: () => void;
|
|
33
34
|
ctaRef?: Ref<HTMLButtonElement>;
|
|
34
35
|
}
|
|
35
|
-
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;
|
|
36
|
+
export declare function SplashPrimary({ agentName, presentation, headerIconUrl, sections, greetingText, attributionVisible, skipButtonVisible, optOutVisible, intent, lastCompletedPhase, upcomingPhases, micEnabled, startMuted, screenEnabled, enableMic, toggleStartMuted, enableScreen, start, dismiss, optOutChecked, toggleOptOut, ctaRef, }: SplashViewProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -63,6 +63,8 @@ export interface SplashAppearance {
|
|
|
63
63
|
copy?: SplashCopy;
|
|
64
64
|
sections?: SplashSection[];
|
|
65
65
|
attributionVisible?: boolean;
|
|
66
|
+
startGreetingVisible?: boolean;
|
|
67
|
+
continueGreetingVisible?: boolean;
|
|
66
68
|
startSkipButtonVisible?: boolean;
|
|
67
69
|
continueSkipButtonVisible?: boolean;
|
|
68
70
|
overlayOptOutVisible?: boolean;
|
|
@@ -12,6 +12,6 @@ export interface UseSessionHoldValue {
|
|
|
12
12
|
toggle: () => void;
|
|
13
13
|
clearPausedCaptureRef: MutableRefObject<(() => void) | null>;
|
|
14
14
|
}
|
|
15
|
-
/** Owns the user's in-session pause/resume: mutes the mic, signals the
|
|
15
|
+
/** Owns the user's in-session pause/resume: mutes the mic, signals the agent to stop listening,
|
|
16
16
|
* and ends the session if the hold outlasts the countdown. */
|
|
17
17
|
export declare function useSessionHold({ pauseSession, pauseTimeoutSeconds, captureMode, }: UseSessionHoldOptions): UseSessionHoldValue;
|
|
@@ -111,6 +111,8 @@ export declare const CONSENT_NOTICE_SESSION_START = "By starting a session, you
|
|
|
111
111
|
export declare const CONSENT_NOTICE_CONTINUING = "By continuing, you agree to the {terms} & {privacy}";
|
|
112
112
|
export declare const CONSENT_NOTICE_AGENT_SESSION_START = "By starting the AI agent session, you agree to Skippr's {terms} & {privacy}";
|
|
113
113
|
export declare const SPLASH_COPY_DEFAULTS: {
|
|
114
|
+
readonly startGreeting: "Hello! Skippr here. I'll show you around and help you get everything set up.";
|
|
115
|
+
readonly continueGreeting: "Welcome back. Let's pick up where we left off — your progress is saved.";
|
|
114
116
|
readonly howItWorksHeading: "How it works";
|
|
115
117
|
readonly lastAccomplishmentHeading: "Last accomplishment";
|
|
116
118
|
readonly upNextHeading: "Up next";
|
|
@@ -181,6 +183,7 @@ export declare const SPLASH_MAX_HEIGHT_MAX_VH = 95;
|
|
|
181
183
|
export declare const DEFAULT_SPLASH_MAX_HEIGHT_VH = 90;
|
|
182
184
|
export declare const DEFAULT_SPLASH_ATTRIBUTION_VISIBLE = true;
|
|
183
185
|
export declare const DEFAULT_SPLASH_SKIP_BUTTON_VISIBLE = true;
|
|
186
|
+
export declare const DEFAULT_SPLASH_GREETING_VISIBLE = true;
|
|
184
187
|
export declare const DEFAULT_SPLASH_OVERLAY_OPT_OUT_VISIBLE = true;
|
|
185
188
|
export declare const SPLASH_INTENT: {
|
|
186
189
|
readonly Start: "start";
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
type StartSession = () => void;
|
|
2
|
+
export declare function setHostSessionLive(isLive: boolean): void;
|
|
3
|
+
export declare function provideStartSession(fn: StartSession | null): void;
|
|
4
|
+
export declare function resetHostStart(): void;
|
|
5
|
+
export declare function requestStartSession(): void;
|
|
6
|
+
export {};
|
|
@@ -5,6 +5,7 @@ export declare const ICON_TILE_BRAND = "skippr:flex skippr:size-[38px] skippr:sh
|
|
|
5
5
|
export declare const ROW_TEXT = "skippr:flex skippr:min-w-0 skippr:flex-col skippr:gap-px";
|
|
6
6
|
export declare const ROW_TITLE = "skippr:text-[14px] skippr:font-medium skippr:text-[#2D2D3F]";
|
|
7
7
|
export declare const ROW_SUBTEXT = "skippr:text-[12px] skippr:text-[#6b6875]";
|
|
8
|
+
export declare const GREETING_TEXT = "skippr:text-[14px] skippr:leading-[1.45] skippr:text-[#6b6875] skippr:whitespace-pre-line";
|
|
8
9
|
export declare const ROW_ICON = "skippr:size-[17px]";
|
|
9
10
|
export declare const ROW_ICON_STROKE = 1.8;
|
|
10
11
|
export declare const FOCUS_RING = "skippr:focus-visible:outline-2 skippr:focus-visible:outline-offset-2 skippr:focus-visible:outline-[var(--skippr-brand)]";
|