@botpress/webchat 1.0.31 → 1.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.
Files changed (43) hide show
  1. package/dist/client/ChatClient/index.d.ts +0 -1
  2. package/dist/client/MessagingClient/adapters/Trigger.d.ts +33 -0
  3. package/dist/client/MessagingClient/client.d.ts +4 -9
  4. package/dist/components/Block.d.ts +1 -1
  5. package/dist/components/renderers/Audio.d.ts +2 -2
  6. package/dist/components/renderers/Carousel.d.ts +2 -2
  7. package/dist/components/renderers/File.d.ts +2 -2
  8. package/dist/components/renderers/Image.d.ts +2 -2
  9. package/dist/components/renderers/Location.d.ts +2 -2
  10. package/dist/components/renderers/Video.d.ts +2 -2
  11. package/dist/hooks/useClient.d.ts +2 -2
  12. package/dist/index.js +58443 -50603
  13. package/dist/index.umd.cjs +117 -395
  14. package/dist/schemas/theme.d.ts +8 -8
  15. package/dist/themes/base.d.ts +1 -1
  16. package/dist/themes/baseColors.d.ts +736 -0
  17. package/dist/themes/dawn.d.ts +3 -1
  18. package/dist/themes/eggplant.d.ts +3 -1
  19. package/dist/themes/index.d.ts +0 -3
  20. package/dist/themes/prism.d.ts +3 -1
  21. package/dist/themes/themeBuilder.d.ts +27 -0
  22. package/dist/types/block-type.d.ts +14 -68
  23. package/dist/utils/index.d.ts +0 -1
  24. package/dist/utils/withBaseTheme.d.ts +1 -1
  25. package/package.json +11 -8
  26. package/dist/client/MessagingClient/adapters/Audio.d.ts +0 -19
  27. package/dist/client/MessagingClient/adapters/Card.d.ts +0 -188
  28. package/dist/client/MessagingClient/adapters/Carousel.d.ts +0 -147
  29. package/dist/client/MessagingClient/adapters/Choice.d.ts +0 -45
  30. package/dist/client/MessagingClient/adapters/Dropdown.d.ts +0 -46
  31. package/dist/client/MessagingClient/adapters/File.d.ts +0 -19
  32. package/dist/client/MessagingClient/adapters/Image.d.ts +0 -19
  33. package/dist/client/MessagingClient/adapters/Location.d.ts +0 -27
  34. package/dist/client/MessagingClient/adapters/Message.d.ts +0 -433
  35. package/dist/client/MessagingClient/adapters/Text.d.ts +0 -20
  36. package/dist/client/MessagingClient/adapters/Utils.d.ts +0 -5
  37. package/dist/client/MessagingClient/adapters/Video.d.ts +0 -19
  38. package/dist/client/MessagingClient/adapters/Voice.d.ts +0 -15
  39. package/dist/client/MessagingClient/adapters/index.d.ts +0 -12
  40. package/dist/themes/dusk.d.ts +0 -2
  41. package/dist/themes/galaxy.d.ts +0 -2
  42. package/dist/themes/midnight.d.ts +0 -2
  43. package/dist/utils/colors.d.ts +0 -18
@@ -25,5 +25,4 @@ export declare class ChatClient extends EventEmitter<Events> implements WebChatC
25
25
  listMessages(): Promise<Message[]>;
26
26
  private _connectConversation;
27
27
  private _mapMessage;
28
- private _mapPayload;
29
28
  }
@@ -0,0 +1,33 @@
1
+ import { z } from 'zod';
2
+ export declare const TriggerSchema: z.ZodObject<{
3
+ trigger: z.ZodUnion<[z.ZodObject<{
4
+ type: z.ZodLiteral<"webchat-visibility">;
5
+ visibility: z.ZodUnion<[z.ZodLiteral<"show">, z.ZodLiteral<"hide">, z.ZodLiteral<"toggle">]>;
6
+ }, "strip", z.ZodTypeAny, {
7
+ type: "webchat-visibility";
8
+ visibility: "hide" | "show" | "toggle";
9
+ }, {
10
+ type: "webchat-visibility";
11
+ visibility: "hide" | "show" | "toggle";
12
+ }>, z.ZodObject<{
13
+ type: z.ZodLiteral<"custom-event">;
14
+ }, "strip", z.ZodTypeAny, {
15
+ type: "custom-event";
16
+ }, {
17
+ type: "custom-event";
18
+ }>]>;
19
+ }, "strip", z.ZodTypeAny, {
20
+ trigger: {
21
+ type: "webchat-visibility";
22
+ visibility: "hide" | "show" | "toggle";
23
+ } | {
24
+ type: "custom-event";
25
+ };
26
+ }, {
27
+ trigger: {
28
+ type: "webchat-visibility";
29
+ visibility: "hide" | "show" | "toggle";
30
+ } | {
31
+ type: "custom-event";
32
+ };
33
+ }>;
@@ -1,6 +1,8 @@
1
1
  import { type MessagingSocketOptions, type UserCredentials } from '@botpress/messaging-socket';
2
2
  import { EventEmitter } from '../../utils';
3
3
  import { Message, WebChatClient } from '../types';
4
+ import { TriggerSchema } from './adapters/Trigger';
5
+ import { z } from 'zod';
4
6
  type Events = {
5
7
  connect: UserCredentials;
6
8
  disconnect: undefined;
@@ -10,6 +12,7 @@ type Events = {
10
12
  messageSent: string;
11
13
  startTyping: undefined;
12
14
  stopTyping: undefined;
15
+ trigger: z.infer<typeof TriggerSchema>['trigger'];
13
16
  };
14
17
  export declare class MessagingClient implements WebChatClient {
15
18
  private socket;
@@ -28,15 +31,7 @@ export declare class MessagingClient implements WebChatClient {
28
31
  conversationExists(id: string): Promise<boolean>;
29
32
  newConversation(): Promise<void>;
30
33
  listMessages(limit?: number): Promise<{
31
- payload: import("../..").ImageBlock | import("../..").AudioBlock | import("../..").VideoBlock | import("../..").FileBlock | import("../..").LocationBlock | import("./adapters").WithBubble<import("../..").TextBlock> | import("./adapters").WithBubble<import("./adapters").CardBlockType> | ({
32
- blocks: import("./adapters").CardBlockType[];
33
- } & Omit<import("../..").CarouselBlock, "blocks">) | import("./adapters").WithBubble<{
34
- blocks: (import("../..").TextBlock | ({
35
- blocks: import("../..").ButtonBlock[];
36
- } & Omit<import("../..").RowBlock, "blocks">))[];
37
- } & Omit<import("../..").ColumnBlock, "blocks">> | import("./adapters").WithBubble<{
38
- blocks: (import("../..").DropdownBlock | import("../..").TextBlock)[];
39
- } & Omit<import("../..").ColumnBlock, "blocks">>;
34
+ payload: import("message-adapters/src/target").Message;
40
35
  id: string;
41
36
  conversationId: string;
42
37
  authorId: string | undefined;
@@ -1,4 +1,4 @@
1
1
  import { BlockMap, CommonBlockProps } from '../types';
2
- export declare const Block: <T extends "button" | "text" | "image" | "audio" | "video" | "file" | "location" | "column" | "row" | "bubble" | "carousel" | "dropdown">({ block, styles, ...props }: {
2
+ export declare const Block: <T extends "audio" | "carousel" | "text" | "dropdown" | "file" | "image" | "location" | "video" | "button" | "bubble" | "column" | "row">({ block, styles, ...props }: {
3
3
  block: BlockMap[T];
4
4
  } & CommonBlockProps) => JSX.Element;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CommonBlockProps, AudioBlock } from '../../types';
3
- export declare const Audio: import("react").ForwardRefExoticComponent<CommonBlockProps & AudioBlock & import("react").RefAttributes<HTMLAudioElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const Audio: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").AudioMessage & import("react").RefAttributes<HTMLAudioElement>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CarouselBlock, CommonBlockProps } from '../../types';
3
- export declare const Carousel: import("react").ForwardRefExoticComponent<CommonBlockProps & CarouselBlock & import("react").RefAttributes<HTMLDivElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const Carousel: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").CarouselMessage & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CommonBlockProps, FileBlock } from '../../types';
3
- export declare const File: import("react").ForwardRefExoticComponent<CommonBlockProps & FileBlock & import("react").RefAttributes<HTMLAnchorElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const File: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").FileMessage & import("react").RefAttributes<HTMLAnchorElement>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CommonBlockProps, ImageBlock } from '../../types';
3
- export declare const Image: import("react").ForwardRefExoticComponent<CommonBlockProps & ImageBlock & import("react").RefAttributes<HTMLImageElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const Image: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").ImageMessage & import("react").RefAttributes<HTMLImageElement>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CommonBlockProps, LocationBlock } from '../../types';
3
- export declare const Location: import("react").ForwardRefExoticComponent<CommonBlockProps & LocationBlock & import("react").RefAttributes<HTMLAnchorElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const Location: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").LocationMessage & import("react").RefAttributes<HTMLAnchorElement>>;
@@ -1,3 +1,3 @@
1
1
  /// <reference types="react" />
2
- import { CommonBlockProps, VideoBlock } from '../../types';
3
- export declare const Video: import("react").ForwardRefExoticComponent<CommonBlockProps & VideoBlock & import("react").RefAttributes<HTMLVideoElement>>;
2
+ import { CommonBlockProps } from '../../types';
3
+ export declare const Video: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").VideoMessage & import("react").RefAttributes<HTMLVideoElement>>;
@@ -1,8 +1,8 @@
1
- import { WebChatClient } from '../client';
1
+ import { MessagingClient, WebChatClient } from '../client';
2
2
  type UseClientOptions = {
3
3
  mode: 'messaging' | 'chat';
4
4
  clientId: string;
5
5
  apiUrl: string;
6
6
  };
7
- export declare const useClient: ({ clientId, apiUrl, mode }: UseClientOptions) => WebChatClient | undefined;
7
+ export declare const useClient: ({ clientId, apiUrl, mode }: UseClientOptions) => WebChatClient | MessagingClient | undefined;
8
8
  export {};