@robylon/web-react-sdk 1.1.41 → 1.1.43-staging.1
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 +108 -0
- package/dist/cjs/index.js +3 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types/components/ChatbotIframe.d.ts +2 -0
- package/dist/cjs/types/components/RobylonChatbot.d.ts +10 -0
- package/dist/cjs/types/core/config.d.ts +7 -0
- package/dist/cjs/types/types.d.ts +30 -1
- package/dist/cjs/types/utils/fetchData.d.ts +1 -1
- package/dist/cjs/types/utils/launcherInfo.d.ts +2 -0
- package/dist/cjs/types/utils/proactive.d.ts +16 -1
- package/dist/cjs/types/utils/sanitize.d.ts +4 -0
- package/dist/cjs/types/utils/systemInfo.d.ts +1 -2
- package/dist/cjs/types/utils/url.d.ts +8 -0
- package/dist/cjs/types/vanilla/components/ChatbotFloatingButton.d.ts +8 -0
- package/dist/cjs/types/vanilla/components/ChatbotIframe.d.ts +11 -0
- package/dist/cjs/types/vanilla/index.d.ts +5 -0
- package/dist/esm/index.js +3 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types/components/ChatbotIframe.d.ts +2 -0
- package/dist/esm/types/components/RobylonChatbot.d.ts +10 -0
- package/dist/esm/types/core/config.d.ts +7 -0
- package/dist/esm/types/types.d.ts +30 -1
- package/dist/esm/types/utils/fetchData.d.ts +1 -1
- package/dist/esm/types/utils/launcherInfo.d.ts +2 -0
- package/dist/esm/types/utils/proactive.d.ts +16 -1
- package/dist/esm/types/utils/sanitize.d.ts +4 -0
- package/dist/esm/types/utils/systemInfo.d.ts +1 -2
- package/dist/esm/types/utils/url.d.ts +8 -0
- package/dist/esm/types/vanilla/components/ChatbotFloatingButton.d.ts +8 -0
- package/dist/esm/types/vanilla/components/ChatbotIframe.d.ts +11 -0
- package/dist/esm/types/vanilla/index.d.ts +5 -0
- package/dist/index.d.ts +46 -2
- package/dist/umd/robylon-chatbot.js +1 -1
- package/dist/umd/robylon-chatbot.js.map +1 -1
- package/dist/umd/types/components/ChatbotIframe.d.ts +2 -0
- package/dist/umd/types/components/RobylonChatbot.d.ts +10 -0
- package/dist/umd/types/core/config.d.ts +7 -0
- package/dist/umd/types/types.d.ts +30 -1
- package/dist/umd/types/utils/fetchData.d.ts +1 -1
- package/dist/umd/types/utils/launcherInfo.d.ts +2 -0
- package/dist/umd/types/utils/proactive.d.ts +16 -1
- package/dist/umd/types/utils/sanitize.d.ts +4 -0
- package/dist/umd/types/utils/systemInfo.d.ts +1 -2
- package/dist/umd/types/utils/url.d.ts +8 -0
- package/dist/umd/types/vanilla/components/ChatbotFloatingButton.d.ts +8 -0
- package/dist/umd/types/vanilla/components/ChatbotIframe.d.ts +11 -0
- package/dist/umd/types/vanilla/index.d.ts +5 -0
- package/package.json +5 -3
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { ChatbotConfig } from "../types";
|
|
3
3
|
import { ChatbotEventHandler, AllEventTypes } from "../types/events";
|
|
4
|
+
import { Overrides } from "src/components/RobylonChatbot";
|
|
4
5
|
interface ChatbotIframeProps {
|
|
5
6
|
config: ChatbotConfig;
|
|
6
7
|
isVisible: boolean;
|
|
@@ -9,6 +10,7 @@ interface ChatbotIframeProps {
|
|
|
9
10
|
onInternalEvent: (eventType: AllEventTypes, additionalData?: Record<string, any>) => void;
|
|
10
11
|
position?: "Left" | "Right";
|
|
11
12
|
bottomSpacing?: number;
|
|
13
|
+
overrides?: Overrides;
|
|
12
14
|
}
|
|
13
15
|
declare const _default: React.NamedExoticComponent<ChatbotIframeProps>;
|
|
14
16
|
export default _default;
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { ChatbotEventHandler, ChatbotRef } from "../types/events";
|
|
3
|
+
export interface Overrides {
|
|
4
|
+
header_avatar?: string | null;
|
|
5
|
+
agent_avatar?: string | null;
|
|
6
|
+
header_title?: string | null;
|
|
7
|
+
header_subtitle?: string | null;
|
|
8
|
+
header_title_text_color?: string | null;
|
|
9
|
+
header_subtitle_text_color?: string | null;
|
|
10
|
+
header_bg?: string | null;
|
|
11
|
+
}
|
|
3
12
|
interface ChatbotProps {
|
|
4
13
|
api_key: string;
|
|
5
14
|
user_id?: string | null | number;
|
|
@@ -12,6 +21,7 @@ interface ChatbotProps {
|
|
|
12
21
|
show_launcher?: boolean | null;
|
|
13
22
|
launcher_type?: "TEXT" | "IMAGE" | "TEXTUAL_IMAGE";
|
|
14
23
|
launcher_properties_text?: string;
|
|
24
|
+
overrides?: Overrides;
|
|
15
25
|
}
|
|
16
26
|
declare const MemoizedRobylonChatbot: React.MemoExoticComponent<React.ForwardRefExoticComponent<ChatbotProps & React.RefAttributes<ChatbotRef>>>;
|
|
17
27
|
export { MemoizedRobylonChatbot as Chatbot };
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ChatbotConfig } from "../types";
|
|
2
|
+
import { ProactiveMessage } from "src/types";
|
|
2
3
|
/**
|
|
3
4
|
* Normalizes the configuration properties
|
|
4
5
|
* @param props The configuration properties
|
|
@@ -32,3 +33,9 @@ export declare const initializeChatbotConfig: (props: {
|
|
|
32
33
|
user_token?: string;
|
|
33
34
|
user_profile?: Record<string, any>;
|
|
34
35
|
}) => Promise<ChatbotConfig>;
|
|
36
|
+
/**
|
|
37
|
+
* Normalizes proactive messages from backend to an array form, preserving order.
|
|
38
|
+
* - Accepts undefined, single object, or array of objects
|
|
39
|
+
* - Migrates legacy `content` to `content_multiple`
|
|
40
|
+
*/
|
|
41
|
+
export declare const normalizeProactiveMessages: (input: any) => ProactiveMessage[] | undefined;
|
|
@@ -44,7 +44,7 @@ export interface ChatbotConfig {
|
|
|
44
44
|
url: string;
|
|
45
45
|
};
|
|
46
46
|
};
|
|
47
|
-
proactive_message_obj?: ProactiveMessage | undefined;
|
|
47
|
+
proactive_message_obj?: ProactiveMessage[] | undefined;
|
|
48
48
|
launcher_delay: {
|
|
49
49
|
enabled: boolean;
|
|
50
50
|
delay: number;
|
|
@@ -78,6 +78,29 @@ export declare enum ProactiveSendTimeType {
|
|
|
78
78
|
WORKING_HOURS = "WORKING_HOURS",
|
|
79
79
|
ALWAYS = "ALWAYS"
|
|
80
80
|
}
|
|
81
|
+
export declare enum DisplayAttributesType {
|
|
82
|
+
"URL" = "URL"
|
|
83
|
+
}
|
|
84
|
+
export declare enum LogicalConditionType {
|
|
85
|
+
AND = "AND",
|
|
86
|
+
OR = "OR"
|
|
87
|
+
}
|
|
88
|
+
export declare enum ConditionType {
|
|
89
|
+
IS = "IS",
|
|
90
|
+
IS_NOT = "IS_NOT",
|
|
91
|
+
CONTAINS = "CONTAINS",
|
|
92
|
+
DOES_NOT_CONTAIN = "DOES_NOT_CONTAIN",
|
|
93
|
+
STARTS_WITH = "STARTS_WITH",
|
|
94
|
+
ENDS_WITH = "ENDS_WITH"
|
|
95
|
+
}
|
|
96
|
+
export interface ContentDisplayAttribute {
|
|
97
|
+
type: DisplayAttributesType;
|
|
98
|
+
value: string;
|
|
99
|
+
condition: ConditionType;
|
|
100
|
+
}
|
|
101
|
+
export interface LogicalConditionAttribute {
|
|
102
|
+
logical_condition: LogicalConditionType;
|
|
103
|
+
}
|
|
81
104
|
export interface ProactiveMessage {
|
|
82
105
|
message_id: string;
|
|
83
106
|
org_id: string;
|
|
@@ -88,5 +111,11 @@ export interface ProactiveMessage {
|
|
|
88
111
|
updated_by_name?: string;
|
|
89
112
|
updated_at?: string;
|
|
90
113
|
created_at?: string;
|
|
114
|
+
delay?: number;
|
|
115
|
+
content_multiple?: {
|
|
116
|
+
message: string;
|
|
117
|
+
content_id?: string;
|
|
118
|
+
message_display_attributes: (ContentDisplayAttribute | LogicalConditionAttribute)[];
|
|
119
|
+
}[];
|
|
91
120
|
}
|
|
92
121
|
export {};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { SystemInfo } from "./systemInfo";
|
|
1
2
|
interface LauncherInfo {
|
|
2
3
|
current_page_url: string;
|
|
3
4
|
browser_language: string;
|
|
4
5
|
browser_version: string;
|
|
5
6
|
os: string;
|
|
6
7
|
referral_url: string;
|
|
8
|
+
system_info?: SystemInfo;
|
|
7
9
|
}
|
|
8
10
|
export declare const getLauncherInfo: () => LauncherInfo;
|
|
9
11
|
export {};
|
|
@@ -1,4 +1,19 @@
|
|
|
1
1
|
import { ProactiveMessage } from "src/types";
|
|
2
2
|
export declare const hideProactiveForThisPage: () => void;
|
|
3
3
|
export declare const isProactiveHiddenThisPage: () => boolean;
|
|
4
|
-
export declare const
|
|
4
|
+
export declare const setLastClickedProactive: (params: {
|
|
5
|
+
content_string: string | null;
|
|
6
|
+
message_id: string | null;
|
|
7
|
+
}) => void;
|
|
8
|
+
export declare const getAndClearLastClickedProactive: () => {
|
|
9
|
+
input_id: null;
|
|
10
|
+
content_string: string | null;
|
|
11
|
+
message_id: string | null;
|
|
12
|
+
} | null;
|
|
13
|
+
export interface VisibleContent {
|
|
14
|
+
messageId: string;
|
|
15
|
+
contentIndex: number;
|
|
16
|
+
html: string;
|
|
17
|
+
delayMs: number;
|
|
18
|
+
}
|
|
19
|
+
export declare const evaluateProactiveMessages: (messages?: ProactiveMessage[]) => VisibleContent[];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ConditionType, DisplayAttributesType } from "src/types";
|
|
2
|
+
type UrlChangeListener = (href: string) => void;
|
|
3
|
+
export declare const getCurrentHref: () => string;
|
|
4
|
+
export declare const buildLocationKey: () => string;
|
|
5
|
+
export declare const subscribeToUrlChanges: (cb: UrlChangeListener) => (() => void);
|
|
6
|
+
export declare const initUrlObserver: () => void;
|
|
7
|
+
export declare const matchCondition: (type: DisplayAttributesType, value: string, condition: ConditionType, href: string) => boolean;
|
|
8
|
+
export {};
|
|
@@ -26,6 +26,8 @@ export declare class ChatbotFloatingButton {
|
|
|
26
26
|
private resizeObserver;
|
|
27
27
|
private handleResizeFunction;
|
|
28
28
|
private proactiveElement;
|
|
29
|
+
private urlUnsubscribe;
|
|
30
|
+
private delayTimers;
|
|
29
31
|
/**
|
|
30
32
|
* Creates a new ChatbotFloatingButton
|
|
31
33
|
* @param config The button configuration
|
|
@@ -69,6 +71,12 @@ export declare class ChatbotFloatingButton {
|
|
|
69
71
|
* Unmounts and destroys the button
|
|
70
72
|
*/
|
|
71
73
|
destroy(): void;
|
|
74
|
+
private clearProactiveDelays;
|
|
75
|
+
/**
|
|
76
|
+
* Hides proactive messages with animation
|
|
77
|
+
*/
|
|
78
|
+
private hideProactiveMessages;
|
|
79
|
+
private injectAnimationStyles;
|
|
72
80
|
private renderProactiveIfNeeded;
|
|
73
81
|
}
|
|
74
82
|
export {};
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import { ChatbotConfig } from "../../types";
|
|
2
2
|
import { ChatbotEventType, AllEventTypes } from "../../types/events";
|
|
3
|
+
interface Overrides {
|
|
4
|
+
header_avatar?: string | null;
|
|
5
|
+
agent_avatar?: string | null;
|
|
6
|
+
header_title?: string | null;
|
|
7
|
+
header_subtitle?: string | null;
|
|
8
|
+
header_title_text_color?: string | null;
|
|
9
|
+
header_subtitle_text_color?: string | null;
|
|
10
|
+
header_bg?: string | null;
|
|
11
|
+
}
|
|
3
12
|
/**
|
|
4
13
|
* Interface for the ChatbotIframe configuration
|
|
5
14
|
*/
|
|
@@ -15,6 +24,7 @@ interface ChatbotIframeConfig {
|
|
|
15
24
|
onInternalEvent: (eventType: AllEventTypes, additionalData?: Record<string, any>) => void;
|
|
16
25
|
position?: "Left" | "Right";
|
|
17
26
|
bottomSpacing?: number;
|
|
27
|
+
overrides?: Overrides;
|
|
18
28
|
}
|
|
19
29
|
/**
|
|
20
30
|
* Class representing the ChatbotIframe component
|
|
@@ -25,6 +35,7 @@ export declare class ChatbotIframe {
|
|
|
25
35
|
private isInitialized;
|
|
26
36
|
private hasRegistered;
|
|
27
37
|
private resizeHandler;
|
|
38
|
+
private overridesPayloadCache;
|
|
28
39
|
/**
|
|
29
40
|
* Creates a new ChatbotIframe
|
|
30
41
|
* @param config The iframe configuration
|
|
@@ -12,6 +12,11 @@ export interface RobylonChatbotConfig {
|
|
|
12
12
|
sideSpacing?: number | string;
|
|
13
13
|
bottomSpacing?: number | string;
|
|
14
14
|
show_launcher?: boolean | null;
|
|
15
|
+
overrides?: {
|
|
16
|
+
header_avatar?: string | null;
|
|
17
|
+
agent_avatar?: string | null;
|
|
18
|
+
header_title?: string | null;
|
|
19
|
+
};
|
|
15
20
|
}
|
|
16
21
|
/**
|
|
17
22
|
* RobylonChatbot instance interface
|