@opencx/widget-core 4.0.18 → 4.0.20
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.
|
@@ -6,6 +6,7 @@ import { ModeDto, SessionDto } from './dtos';
|
|
|
6
6
|
import { SessionCtx } from '../context/session.ctx';
|
|
7
7
|
import { MessageCtx } from '../context/message.ctx';
|
|
8
8
|
import { Language, TranslationInterface } from '../translation';
|
|
9
|
+
import { WidgetMessageU } from './messages';
|
|
9
10
|
type UserBaseConfig = {
|
|
10
11
|
token: string;
|
|
11
12
|
data?: never;
|
|
@@ -170,14 +171,15 @@ export type ModeComponent = {
|
|
|
170
171
|
};
|
|
171
172
|
export type SpecialComponentProps = {
|
|
172
173
|
react: typeof React;
|
|
173
|
-
session: SessionDto | null;
|
|
174
174
|
org: {
|
|
175
175
|
id: string;
|
|
176
176
|
name: string;
|
|
177
177
|
};
|
|
178
178
|
config: WidgetConfig;
|
|
179
|
+
session: SessionDto | null;
|
|
180
|
+
messages: WidgetMessageU[];
|
|
179
181
|
};
|
|
180
|
-
export type SpecialComponent = (props: SpecialComponentProps) => ReturnType<typeof React.createElement
|
|
182
|
+
export type SpecialComponent = (props: SpecialComponentProps) => ReturnType<typeof React.createElement> | null;
|
|
181
183
|
export interface WidgetConfig {
|
|
182
184
|
/**
|
|
183
185
|
* Your organization's widget token.
|
|
@@ -286,6 +288,24 @@ export interface WidgetConfig {
|
|
|
286
288
|
* @default 'above-chat-input'
|
|
287
289
|
*/
|
|
288
290
|
initialQuestionsPosition?: 'above-chat-input' | 'below-initial-messages';
|
|
291
|
+
/**
|
|
292
|
+
* Disclaimers or simple components to be shown at the bottom of the chat below the input box.
|
|
293
|
+
* @default undefined
|
|
294
|
+
*/
|
|
295
|
+
chatFooterItems?: Array<{
|
|
296
|
+
/** Text or html as a string */
|
|
297
|
+
message: string;
|
|
298
|
+
/**
|
|
299
|
+
* Whether to show the item when the session is open.
|
|
300
|
+
* @default true
|
|
301
|
+
*/
|
|
302
|
+
showWhenSessionIsOpen?: boolean;
|
|
303
|
+
/**
|
|
304
|
+
* Whether to show the item when the session is resolved.
|
|
305
|
+
* @default true
|
|
306
|
+
*/
|
|
307
|
+
showWhenSessionIsResolved?: boolean;
|
|
308
|
+
}>;
|
|
289
309
|
/**
|
|
290
310
|
* If turned on, the widget will have a login-like screen to collect user's name and email.
|
|
291
311
|
* A non-verified contact will be created based on the provided information.
|
|
@@ -341,7 +361,21 @@ export interface WidgetConfig {
|
|
|
341
361
|
* Custom components to be shown in certain sc
|
|
342
362
|
*/
|
|
343
363
|
specialComponents?: {
|
|
364
|
+
/**
|
|
365
|
+
* A component that shows at the bottom of the chat when the session is resolved and no longer open
|
|
366
|
+
* Useful for CSAT surveys
|
|
367
|
+
* @default undefined
|
|
368
|
+
*/
|
|
344
369
|
onSessionResolved?: SpecialComponent;
|
|
370
|
+
/**
|
|
371
|
+
* Custom components to be shown in the chat bottom section
|
|
372
|
+
* @default undefined
|
|
373
|
+
*/
|
|
374
|
+
chatBottomComponents?: Array<{
|
|
375
|
+
/** Unique key per component */
|
|
376
|
+
key: string;
|
|
377
|
+
component: SpecialComponent;
|
|
378
|
+
}>;
|
|
345
379
|
};
|
|
346
380
|
/**
|
|
347
381
|
* Customize the router behavior.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"widget-config.d.ts","sourceRoot":"","sources":["../../../src/types/widget-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAKrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"widget-config.d.ts","sourceRoot":"","sources":["../../../src/types/widget-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAKrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,KAAK,cAAc,GACf;IACE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACE,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC,CAAC;CACH,CAAC;AAEN,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG;IACxC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE;YACP;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;SAC3B,CAAC;QACF,IAAI,CAAC,EAAE;YACL,uBAAuB;YACvB,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB,uBAAuB;YACvB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,sBAAsB,CAAC,EAAE;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE;YACP,uBAAuB;YACvB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,uBAAuB;YACvB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE;YACR;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,IAAI,CAAC,EAAE;YACL,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,8BAA8B;YAC9B,UAAU,CAAC,EAAE;gBACX,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,wBAAwB,CAAC,EAAE,MAAM,CAAC;gBAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;aAC7B,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,aAAa,CAAC,EAAE;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,cAAc,CAAC,EAAE;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,UAAU,CAAC,EAAE;QACX,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IAGjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GACrB,CAAC,gBAAgB,GAAG;IAClB,aAAa,EAAE,eAAe,CAAC;IAE/B,0EAA0E;IAC1E,UAAU,CAAC,EAAE,SAAS,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB,CAAC,GACF,CAAC,gBAAgB,GAAG;IAClB,aAAa,EAAE,cAAc,CAAC;IAE9B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B,CAAC,GACF,CAAC,gBAAgB,GAAG;IAClB,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EACP,cAAc,GACd,YAAY,GACZ,cAAc,GACd,6BAA6B,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,IAAI,EAAE,OAAO,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF;;;OAGG;IACH,6BAA6B,CAAC,EAAE,UAAU,GAAG,cAAc,CAAC;IAE5D;;;OAGG;IACH,2BAA2B,CAAC,EACxB,UAAU,GACV,YAAY,GACZ,cAAc,GACd,6BAA6B,CAAC;CACnC,CAAC,CAAC;AAEP,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,qBAAqB,EAAE,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAC3D,WAAW,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IACvC,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AACF,MAAM,MAAM,aAAa,GAAG;IAC1B,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,CACT,KAAK,EAAE,kBAAkB,KACtB,UAAU,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,GAAG,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAClC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,UAAU,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,CAC7B,KAAK,EAAE,qBAAqB,KACzB,UAAU,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;AAEnD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,oBAAoB,CAAC,EAAE;SACpB,GAAG,IAAI,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC;KAClD,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,aAAa,CAAC,EAAE;YACd,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;KACH,CAAC;IAEF;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC;QACtB,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAEhB,oFAAoF;QACpF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC,CAAC;IAEH;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC;QAC9B,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC,CAAC;IAEH;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,CAAC;IAEzE;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC;QACtB,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;QAEhC;;;WAGG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;KACrC,CAAC,CAAC;IAEH;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF;;;;;;;;;OASG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;;;OAIG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IAEjC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE;QACd,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QACtC,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;KACnC,CAAC;IAEF;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEvC;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAClB;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;QAErC;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC;YAC3B,+BAA+B;YAC/B,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,EAAE,gBAAgB,CAAC;SAC7B,CAAC,CAAC;KACJ,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAE/B;;;;;;;WAOG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;IAEF;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAE3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,mBAAmB,CAAC,EAAE;QACpB,oBAAoB;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IAEF,UAAU,CAAC,EAAE;QACX,eAAe,CAAC,EAAE;YAChB,qBAAqB;YACrB,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;KACH,CAAC;IAEF;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opencx/widget-core",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "4.0.
|
|
4
|
+
"version": "4.0.20",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
"@types/lodash.isequal": "^4.5.8",
|
|
27
27
|
"lucide": "^0.525.0",
|
|
28
28
|
"openapi-typescript": "^7.5.2",
|
|
29
|
-
"@opencx/
|
|
30
|
-
"@opencx/
|
|
29
|
+
"@opencx/eslint-config": "0.0.0",
|
|
30
|
+
"@opencx/tsconfig": "0.0.1"
|
|
31
31
|
},
|
|
32
32
|
"peerDependencies": {
|
|
33
33
|
"@types/react": ">=18 <20",
|