@opencx/widget-core 4.0.29 → 4.0.32
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/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +8 -8
- package/dist/index.js.map +1 -1
- package/dist/src/index.d.ts +1 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/translation/index.d.ts +7 -7
- package/dist/src/types/widget-config.d.ts +29 -15
- package/dist/src/types/widget-config.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -7,6 +7,7 @@ import { SessionCtx } from '../context/session.ctx';
|
|
|
7
7
|
import { MessageCtx } from '../context/message.ctx';
|
|
8
8
|
import { Language, TranslationInterface } from '../translation';
|
|
9
9
|
import { WidgetMessageU } from './messages';
|
|
10
|
+
import { ScreenU } from '../context/router.ctx';
|
|
10
11
|
type UserBaseConfig = {
|
|
11
12
|
token: string;
|
|
12
13
|
data?: never;
|
|
@@ -157,8 +158,18 @@ export type HeaderButtonU = (HeaderButtonBase & {
|
|
|
157
158
|
*/
|
|
158
159
|
behaviorIfSessionIsResolved?: 'disabled' | 'reset-chat' | 'close-widget' | 'reset-chat-and-close-widget';
|
|
159
160
|
});
|
|
160
|
-
export type
|
|
161
|
+
export type ComponentContext = {
|
|
161
162
|
react: typeof React;
|
|
163
|
+
org: {
|
|
164
|
+
id: string;
|
|
165
|
+
name: string;
|
|
166
|
+
};
|
|
167
|
+
config: WidgetConfig;
|
|
168
|
+
session: SessionDto | null;
|
|
169
|
+
messages: WidgetMessageU[];
|
|
170
|
+
currentScreen: ScreenU;
|
|
171
|
+
};
|
|
172
|
+
export type ModeComponentProps = ComponentContext & {
|
|
162
173
|
mode: ModeDto;
|
|
163
174
|
createStateCheckpoint: SessionCtx['createStateCheckpoint'];
|
|
164
175
|
sendMessage: MessageCtx['sendMessage'];
|
|
@@ -169,17 +180,8 @@ export type ModeComponent = {
|
|
|
169
180
|
key: string;
|
|
170
181
|
component: (props: ModeComponentProps) => ReturnType<typeof React.createElement>;
|
|
171
182
|
};
|
|
172
|
-
export type
|
|
173
|
-
|
|
174
|
-
org: {
|
|
175
|
-
id: string;
|
|
176
|
-
name: string;
|
|
177
|
-
};
|
|
178
|
-
config: WidgetConfig;
|
|
179
|
-
session: SessionDto | null;
|
|
180
|
-
messages: WidgetMessageU[];
|
|
181
|
-
};
|
|
182
|
-
export type SpecialComponent = (props: SpecialComponentProps) => ReturnType<typeof React.createElement> | null;
|
|
183
|
+
export type CustomComponentProps = ComponentContext & {};
|
|
184
|
+
export type CustomComponent = (props: CustomComponentProps) => ReturnType<typeof React.createElement> | null;
|
|
183
185
|
export interface WidgetConfig {
|
|
184
186
|
/**
|
|
185
187
|
* Your organization's widget token.
|
|
@@ -360,13 +362,25 @@ export interface WidgetConfig {
|
|
|
360
362
|
/**
|
|
361
363
|
* Custom components to be shown in certain sc
|
|
362
364
|
*/
|
|
363
|
-
|
|
365
|
+
customComponents?: {
|
|
364
366
|
/**
|
|
365
367
|
* A component that shows at the bottom of the chat when the session is resolved and no longer open
|
|
366
368
|
* Useful for CSAT surveys
|
|
367
369
|
* @default undefined
|
|
368
370
|
*/
|
|
369
|
-
onSessionResolved?:
|
|
371
|
+
onSessionResolved?: CustomComponent;
|
|
372
|
+
/**
|
|
373
|
+
* A component that replaces the header title.
|
|
374
|
+
* Overrides `textContent.sessionsScreen.headerTitle` and `textContent.chatScreen.headerTitle`
|
|
375
|
+
*
|
|
376
|
+
* @default undefined
|
|
377
|
+
*/
|
|
378
|
+
headerTitle?: CustomComponent;
|
|
379
|
+
/**
|
|
380
|
+
* A component that shows in the chat header below the title
|
|
381
|
+
* @default undefined
|
|
382
|
+
*/
|
|
383
|
+
headerBottom?: CustomComponent;
|
|
370
384
|
/**
|
|
371
385
|
* Custom components to be shown in the chat bottom section
|
|
372
386
|
* @default undefined
|
|
@@ -374,7 +388,7 @@ export interface WidgetConfig {
|
|
|
374
388
|
chatBottomComponents?: Array<{
|
|
375
389
|
/** Unique key per component */
|
|
376
390
|
key: string;
|
|
377
|
-
component:
|
|
391
|
+
component: CustomComponent;
|
|
378
392
|
}>;
|
|
379
393
|
};
|
|
380
394
|
/**
|
|
@@ -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;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,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;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,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,gBAAgB,GAAG;IAC7B,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;IAC3B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,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,oBAAoB,GAAG,gBAAgB,GAAG,EAAE,CAAC;AACzD,MAAM,MAAM,eAAe,GAAG,CAC5B,KAAK,EAAE,oBAAoB,KACxB,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,gBAAgB,CAAC,EAAE;QACjB;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,eAAe,CAAC;QAEpC;;;;;WAKG;QACH,WAAW,CAAC,EAAE,eAAe,CAAC;QAC9B;;;WAGG;QACH,YAAY,CAAC,EAAE,eAAe,CAAC;QAE/B;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC;YAC3B,+BAA+B;YAC/B,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,EAAE,eAAe,CAAC;SAC5B,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,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAE9D;;;;;;;;;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"}
|