@botpress/webchat 2.5.0 → 2.5.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.
Files changed (168) hide show
  1. package/.storybook/main.ts +6 -1
  2. package/.turbo/turbo-build.log +12 -9
  3. package/dist/index.d.ts +14197 -15
  4. package/dist/index.js +11301 -10261
  5. package/dist/index.umd.cjs +72 -68
  6. package/dist/style.css +1 -1
  7. package/package.json +4 -2
  8. package/dist/adapters/index.d.ts +0 -2
  9. package/dist/adapters/target.d.ts +0 -83
  10. package/dist/adapters/typings.d.ts +0 -7
  11. package/dist/adapters/webchat-to-target.d.ts +0 -8
  12. package/dist/adapters/webchat.d.ts +0 -5
  13. package/dist/client/client.d.ts +0 -37
  14. package/dist/client/index.d.ts +0 -4
  15. package/dist/client/legacyClient.d.ts +0 -55
  16. package/dist/client/state-machine.d.ts +0 -40
  17. package/dist/client/types.d.ts +0 -35
  18. package/dist/components/Avatar.d.ts +0 -8
  19. package/dist/components/Block.d.ts +0 -9
  20. package/dist/components/Chat.d.ts +0 -30
  21. package/dist/components/CloseWindowButton.d.ts +0 -7
  22. package/dist/components/Composer/Composer.d.ts +0 -18
  23. package/dist/components/Composer/index.d.ts +0 -1
  24. package/dist/components/Composer/parts/FileAttachment.d.ts +0 -11
  25. package/dist/components/Composer/parts/FileInputButton.d.ts +0 -7
  26. package/dist/components/Composer/parts/SpeechRecognition.d.ts +0 -6
  27. package/dist/components/Composer/parts/TextInput.d.ts +0 -13
  28. package/dist/components/Composer/parts/index.d.ts +0 -4
  29. package/dist/components/Container/Container.d.ts +0 -16
  30. package/dist/components/Container/index.d.ts +0 -1
  31. package/dist/components/Fab/Fab.d.ts +0 -1
  32. package/dist/components/Fab/index.d.ts +0 -1
  33. package/dist/components/Header/Header.d.ts +0 -12
  34. package/dist/components/Header/index.d.ts +0 -1
  35. package/dist/components/Loader/Loader.d.ts +0 -5
  36. package/dist/components/Loader/index.d.ts +0 -1
  37. package/dist/components/Marquee/Marquee.d.ts +0 -7
  38. package/dist/components/Marquee/index.d.ts +0 -1
  39. package/dist/components/Message/Message.d.ts +0 -12
  40. package/dist/components/Message/index.d.ts +0 -1
  41. package/dist/components/MessageList/MessageList.d.ts +0 -16
  42. package/dist/components/MessageList/index.d.ts +0 -1
  43. package/dist/components/Modal/Modal.d.ts +0 -17
  44. package/dist/components/Modal/index.d.ts +0 -1
  45. package/dist/components/RestartConversationButton.d.ts +0 -7
  46. package/dist/components/TypingIndicator/TypingIndicator.d.ts +0 -2
  47. package/dist/components/TypingIndicator/index.d.ts +0 -1
  48. package/dist/components/Webchat.d.ts +0 -13
  49. package/dist/components/index.d.ts +0 -14
  50. package/dist/components/renderers/Audio/Audio.d.ts +0 -6
  51. package/dist/components/renderers/Audio/index.d.ts +0 -1
  52. package/dist/components/renderers/Bubble/Bubble.d.ts +0 -5
  53. package/dist/components/renderers/Bubble/index.d.ts +0 -1
  54. package/dist/components/renderers/Button/Button.d.ts +0 -4
  55. package/dist/components/renderers/Button/index.d.ts +0 -1
  56. package/dist/components/renderers/Carousel/Carousel.d.ts +0 -6
  57. package/dist/components/renderers/Carousel/index.d.ts +0 -1
  58. package/dist/components/renderers/Column/Column.d.ts +0 -5
  59. package/dist/components/renderers/Column/index.d.ts +0 -1
  60. package/dist/components/renderers/Custom/Custom.d.ts +0 -14
  61. package/dist/components/renderers/Custom/index.d.ts +0 -1
  62. package/dist/components/renderers/Dropdown/Dropdown.d.ts +0 -5
  63. package/dist/components/renderers/Dropdown/index.d.ts +0 -1
  64. package/dist/components/renderers/File/File.d.ts +0 -6
  65. package/dist/components/renderers/File/index.d.ts +0 -1
  66. package/dist/components/renderers/Image/Image.d.ts +0 -6
  67. package/dist/components/renderers/Image/index.d.ts +0 -1
  68. package/dist/components/renderers/Location/Location.d.ts +0 -6
  69. package/dist/components/renderers/Location/index.d.ts +0 -1
  70. package/dist/components/renderers/Row/Row.d.ts +0 -5
  71. package/dist/components/renderers/Row/index.d.ts +0 -1
  72. package/dist/components/renderers/Text/Text.d.ts +0 -4
  73. package/dist/components/renderers/Text/index.d.ts +0 -1
  74. package/dist/components/renderers/Video/Video.d.ts +0 -6
  75. package/dist/components/renderers/Video/index.d.ts +0 -1
  76. package/dist/components/renderers/index.d.ts +0 -2
  77. package/dist/contexts/MessageContext.d.ts +0 -8
  78. package/dist/contexts/ModalContext.d.ts +0 -14
  79. package/dist/contexts/index.d.ts +0 -2
  80. package/dist/gen/client/errors.d.ts +0 -211
  81. package/dist/gen/client/index.d.ts +0 -71
  82. package/dist/gen/client/models.d.ts +0 -259
  83. package/dist/gen/client/operations/addParticipant.d.ts +0 -57
  84. package/dist/gen/client/operations/createConversation.d.ts +0 -39
  85. package/dist/gen/client/operations/createEvent.d.ts +0 -79
  86. package/dist/gen/client/operations/createFile.d.ts +0 -65
  87. package/dist/gen/client/operations/createMessage.d.ts +0 -324
  88. package/dist/gen/client/operations/createUser.d.ts +0 -66
  89. package/dist/gen/client/operations/deleteConversation.d.ts +0 -22
  90. package/dist/gen/client/operations/deleteMessage.d.ts +0 -22
  91. package/dist/gen/client/operations/deleteUser.d.ts +0 -21
  92. package/dist/gen/client/operations/getConversation.d.ts +0 -36
  93. package/dist/gen/client/operations/getEvent.d.ts +0 -58
  94. package/dist/gen/client/operations/getMessage.d.ts +0 -182
  95. package/dist/gen/client/operations/getParticipant.d.ts +0 -54
  96. package/dist/gen/client/operations/getUser.d.ts +0 -52
  97. package/dist/gen/client/operations/listConversationMessages.d.ts +0 -186
  98. package/dist/gen/client/operations/listConversations.d.ts +0 -42
  99. package/dist/gen/client/operations/listParticipants.d.ts +0 -57
  100. package/dist/gen/client/operations/listenConversation.d.ts +0 -22
  101. package/dist/gen/client/operations/removeParticipant.d.ts +0 -23
  102. package/dist/gen/client/operations/updateUser.d.ts +0 -66
  103. package/dist/gen/client/to-axios.d.ts +0 -16
  104. package/dist/gen/signals/custom.t.d.ts +0 -8
  105. package/dist/gen/signals/custom.z.d.ts +0 -22
  106. package/dist/gen/signals/index.d.ts +0 -1035
  107. package/dist/gen/signals/messageCreated.t.d.ts +0 -163
  108. package/dist/gen/signals/messageCreated.z.d.ts +0 -930
  109. package/dist/gen/signals/typingStarted.t.d.ts +0 -6
  110. package/dist/gen/signals/typingStarted.z.d.ts +0 -22
  111. package/dist/gen/signals/typingStopped.t.d.ts +0 -4
  112. package/dist/gen/signals/typingStopped.z.d.ts +0 -12
  113. package/dist/gen/signals/webchatConfig.t.d.ts +0 -8
  114. package/dist/gen/signals/webchatConfig.z.d.ts +0 -22
  115. package/dist/gen/signals/webchatVisibility.t.d.ts +0 -6
  116. package/dist/gen/signals/webchatVisibility.z.d.ts +0 -22
  117. package/dist/get-client.d.ts +0 -7
  118. package/dist/hooks/index.d.ts +0 -5
  119. package/dist/hooks/useClient.d.ts +0 -6
  120. package/dist/hooks/useImageSize.d.ts +0 -2
  121. package/dist/hooks/useIsTyping.d.ts +0 -4
  122. package/dist/hooks/useRefresh.d.ts +0 -10
  123. package/dist/hooks/useWebchatClient.d.ts +0 -50
  124. package/dist/providers/ModalProvider.d.ts +0 -8
  125. package/dist/providers/StylesheetProvider.d.ts +0 -4
  126. package/dist/providers/index.d.ts +0 -2
  127. package/dist/schemas/configuration.d.ts +0 -157
  128. package/dist/schemas/index.d.ts +0 -3
  129. package/dist/schemas/init.d.ts +0 -8487
  130. package/dist/schemas/theme.d.ts +0 -4358
  131. package/dist/stores/composerFileStore.d.ts +0 -21
  132. package/dist/stores/customComponentsStore.d.ts +0 -9
  133. package/dist/stores/index.d.ts +0 -5
  134. package/dist/stores/messageHistoryStore.d.ts +0 -20
  135. package/dist/stores/messagesStore.d.ts +0 -21
  136. package/dist/stores/userStore.d.ts +0 -32
  137. package/dist/stores/webchatStore.d.ts +0 -13
  138. package/dist/stories/Messages/Audio.stories.d.ts +0 -6
  139. package/dist/stories/Messages/Bloc.stories.d.ts +0 -6
  140. package/dist/stories/Messages/Card.stories.d.ts +0 -6
  141. package/dist/stories/Messages/Carousel.stories.d.ts +0 -6
  142. package/dist/stories/Messages/Choice.stories.d.ts +0 -6
  143. package/dist/stories/Messages/Custom.stories.d.ts +0 -12
  144. package/dist/stories/Messages/Dropdown.stories.d.ts +0 -6
  145. package/dist/stories/Messages/File.stories.d.ts +0 -6
  146. package/dist/stories/Messages/FileAttachmentCard.stories.d.ts +0 -6
  147. package/dist/stories/Messages/Image.stories.d.ts +0 -6
  148. package/dist/stories/Messages/Location.stories.d.ts +0 -6
  149. package/dist/stories/Messages/Text.stories.d.ts +0 -6
  150. package/dist/stories/Messages/Video.stories.d.ts +0 -6
  151. package/dist/styles/classes.d.ts +0 -410
  152. package/dist/styles/index.d.ts +0 -1
  153. package/dist/types/block-type.d.ts +0 -58
  154. package/dist/types/configuration.d.ts +0 -5
  155. package/dist/types/image.d.ts +0 -11
  156. package/dist/types/index.d.ts +0 -5
  157. package/dist/types/init.d.ts +0 -6
  158. package/dist/types/theme.d.ts +0 -7
  159. package/dist/utils/colors.d.ts +0 -21
  160. package/dist/utils/colors.test.d.ts +0 -1
  161. package/dist/utils/eventEmitter.d.ts +0 -12
  162. package/dist/utils/generateCSS.d.ts +0 -1
  163. package/dist/utils/hashStringToInt.d.ts +0 -1
  164. package/dist/utils/images.d.ts +0 -2
  165. package/dist/utils/index.d.ts +0 -7
  166. package/dist/utils/message.d.ts +0 -8
  167. package/dist/utils/message.test.d.ts +0 -1
  168. package/dist/utils/theme.d.ts +0 -2
@@ -1,58 +0,0 @@
1
- import { Theme } from './theme';
2
- import { target } from '../adapters';
3
- import type { Message } from '../adapters/webchat';
4
- import type { CSSProperties, FC } from 'react';
5
- export type BlockStyles = NonNullable<Theme['message']>['blocks'];
6
- export type CommonBlockProps = Pick<RichMessageObject, 'direction' | 'timestamp' | 'sender'> & {
7
- messageId: string;
8
- sendMessage?: (payload: Message) => void;
9
- metadata?: Record<string, any>;
10
- isReadOnly?: boolean;
11
- };
12
- export type StyleOptions = {
13
- className?: string;
14
- style?: CSSProperties;
15
- };
16
- export type AudioBlock = target.AudioMessage;
17
- export type BubbleBlock = target.BubbleMessage;
18
- export type ButtonBlock = target.ButtonMessage;
19
- export type CarouselBlock = target.CarouselMessage;
20
- export type ColumnBlock = target.ColumnMessage;
21
- export type DropdownBlock = target.DropdownMessage;
22
- export type FileBlock = target.FileMessage;
23
- export type ImageBlock = target.ImageMessage;
24
- export type LocationBlock = target.LocationMessage;
25
- export type RowBlock = target.RowMessage;
26
- export type TextBlock = target.TextMessage;
27
- export type VideoBlock = target.VideoMessage;
28
- export type BlockObject = target.Message;
29
- export type BlockType = BlockObject['type'];
30
- export type Sender = {
31
- name: string;
32
- avatar?: string;
33
- };
34
- export type MessageDirection = 'incoming' | 'outgoing' | 'system';
35
- export type MessageObject<T = BlockObject> = {
36
- id: string;
37
- conversationId?: string;
38
- authorId?: string;
39
- disableInput?: boolean;
40
- timestamp: Date;
41
- metadata?: Record<string, any>;
42
- block: T;
43
- };
44
- export type RichMessageObject<T = BlockObject> = MessageObject<T> & {
45
- direction: MessageDirection;
46
- sender: Sender;
47
- };
48
- export type Renderers = {
49
- [T in BlockType]: FC<BlockObjects[T]>;
50
- };
51
- export type BlockObjects = {
52
- [T in BlockType]: Extract<BlockObject, {
53
- type: T;
54
- }> & CommonBlockProps;
55
- };
56
- export declare const fileTypes: readonly ["audio", "file", "image", "video"];
57
- export type FileType = (typeof fileTypes)[number];
58
- export declare const isFileType: (type: string) => type is FileType;
@@ -1,5 +0,0 @@
1
- import { z } from 'zod';
2
- import * as schemas from '../schemas';
3
- export type DescriptionItem = z.infer<typeof schemas.descriptionItemSchema>;
4
- export type Configuration = z.infer<typeof schemas.configurationSchema>;
5
- export type WebchatTheme = z.infer<typeof schemas.WebchatThemeSchema>;
@@ -1,11 +0,0 @@
1
- export type Options = {
2
- timeout?: number;
3
- };
4
- export type Dimensions = {
5
- width: number;
6
- height: number;
7
- };
8
- export type UseImageSizeResult = [Dimensions | null, {
9
- loading: boolean;
10
- error: string | null;
11
- }];
@@ -1,5 +0,0 @@
1
- export * from './block-type';
2
- export * from './image';
3
- export * from './configuration';
4
- export * from './theme';
5
- export * from './init';
@@ -1,6 +0,0 @@
1
- import { z } from 'zod';
2
- import * as schemas from '../schemas';
3
- export type StateProps = z.infer<typeof schemas.statePropsSchema>;
4
- export type UserProps = z.infer<typeof schemas.userPropsSchema>;
5
- export type ConfigProps = z.infer<typeof schemas.configPropsSchema>;
6
- export type InitProps = z.infer<typeof schemas.initPropsSchema>;
@@ -1,7 +0,0 @@
1
- import { z } from 'zod';
2
- import * as schemas from '../schemas';
3
- export type MarkdownType = z.infer<typeof schemas.markdownTypeSchema>;
4
- export type StyleOption = z.infer<typeof schemas.styleOptionSchema>;
5
- export type AvatarTheme = z.infer<typeof schemas.avatarThemeSchema>;
6
- export type BlocksTheme = z.infer<typeof schemas.blockThemeSchema>;
7
- export type Theme = z.infer<typeof schemas.themeSchema>;
@@ -1,21 +0,0 @@
1
- export declare function hexToRgb(hex: string): {
2
- r: number;
3
- g: number;
4
- b: number;
5
- };
6
- export declare function rgbToHex(rgb: {
7
- r: number;
8
- g: number;
9
- b: number;
10
- }): string;
11
- export declare const colorToGray: (color: {
12
- r: number;
13
- g: number;
14
- b: number;
15
- }, saturation?: number) => {
16
- r: number;
17
- g: number;
18
- b: number;
19
- };
20
- export declare function reversePalette(colors: Record<string, string>): Record<string, string>;
21
- export declare function apcaContrast(foreground: string | undefined, background: string | undefined): number;
@@ -1 +0,0 @@
1
- export {};
@@ -1,12 +0,0 @@
1
- type CallbackFn<T> = (args: T) => void;
2
- export declare class EventEmitter<T extends Record<string, any>> {
3
- private readonly eventMap;
4
- constructor();
5
- on<U extends keyof T>(event: U, callback: CallbackFn<T[U]>): () => void;
6
- emit<U extends keyof T>(event: U, arg?: T[U]): void;
7
- }
8
- export type Events = {
9
- [key: string]: undefined;
10
- };
11
- export declare const eventEmitter: EventEmitter<Events>;
12
- export {};
@@ -1 +0,0 @@
1
- export declare function generateCssString(selector: string, styles: Record<string, string>): string;
@@ -1 +0,0 @@
1
- export declare function hashStringToInt(str: string, max: number): number;
@@ -1,2 +0,0 @@
1
- import { Dimensions, Options } from '../types';
2
- export declare const getImageSize: (url: string, options?: Options) => Promise<Dimensions>;
@@ -1,7 +0,0 @@
1
- export * from './colors';
2
- export * from './eventEmitter';
3
- export * from './generateCSS';
4
- export * from './hashStringToInt';
5
- export * from './message';
6
- export * from './theme';
7
- export * from './images';
@@ -1,8 +0,0 @@
1
- import { OpUnitType } from 'dayjs';
2
- import { type RichMessageObject } from '../types';
3
- /**
4
- * @param interval - The interval to check for date differences (default is 'day')
5
- * @returns Array of message objects with system date messages inserted at every change of date more than the `interval`
6
- * */
7
- export declare function withDateSystemMessages(messages: RichMessageObject[], interval?: OpUnitType): RichMessageObject[];
8
- export declare function humanizeTimestamp(timestamp: Date, long?: boolean): string;
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- import type { WebchatTheme } from '../types';
2
- export declare function generateThemeStylesheet(theme: WebchatTheme): string;