@botpress/webchat 2.5.0 → 2.6.0

package/dist/gen/signals/typingStarted.t.d.ts

@@ -1,6 +0,0 @@
-export interface TypingStarted {
-    type: "typing_started";
-    data: {
-        timeout?: number;
-    };
-}

package/dist/gen/signals/typingStarted.z.d.ts

@@ -1,22 +0,0 @@
-import { z } from "zod";
-declare const _default: z.ZodObject<{
-    type: z.ZodLiteral<"typing_started">;
-    data: z.ZodObject<{
-        timeout: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        timeout?: number | undefined;
-    }, {
-        timeout?: number | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "typing_started";
-    data: {
-        timeout?: number | undefined;
-    };
-}, {
-    type: "typing_started";
-    data: {
-        timeout?: number | undefined;
-    };
-}>;
-export default _default;

package/dist/gen/signals/typingStopped.t.d.ts

@@ -1,4 +0,0 @@
-export interface TypingStopped {
-    type: "typing_stopped";
-    data: {};
-}

package/dist/gen/signals/typingStopped.z.d.ts

@@ -1,12 +0,0 @@
-import { z } from "zod";
-declare const _default: z.ZodObject<{
-    type: z.ZodLiteral<"typing_stopped">;
-    data: z.ZodRecord<z.ZodString, z.ZodNever>;
-}, "strip", z.ZodTypeAny, {
-    type: "typing_stopped";
-    data: Record<string, never>;
-}, {
-    type: "typing_stopped";
-    data: Record<string, never>;
-}>;
-export default _default;

package/dist/gen/signals/webchatConfig.t.d.ts

@@ -1,8 +0,0 @@
-export interface WebchatConfig {
-    type: "webchat_config";
-    data: {
-        config: {
-            [k: string]: any;
-        };
-    };
-}

package/dist/gen/signals/webchatConfig.z.d.ts

@@ -1,22 +0,0 @@
-import { z } from "zod";
-declare const _default: z.ZodObject<{
-    type: z.ZodLiteral<"webchat_config">;
-    data: z.ZodObject<{
-        config: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodAny, z.ZodNull]>>;
-    }, "strip", z.ZodTypeAny, {
-        config: Record<string, any>;
-    }, {
-        config: Record<string, any>;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "webchat_config";
-    data: {
-        config: Record<string, any>;
-    };
-}, {
-    type: "webchat_config";
-    data: {
-        config: Record<string, any>;
-    };
-}>;
-export default _default;

package/dist/gen/signals/webchatVisibility.t.d.ts

@@ -1,6 +0,0 @@
-export interface WebchatVisibility {
-    type: "webchat_visibility";
-    data: {
-        visibility: "show" | "hide" | "toggle";
-    };
-}

package/dist/gen/signals/webchatVisibility.z.d.ts

@@ -1,22 +0,0 @@
-import { z } from "zod";
-declare const _default: z.ZodObject<{
-    type: z.ZodLiteral<"webchat_visibility">;
-    data: z.ZodObject<{
-        visibility: z.ZodUnion<[z.ZodLiteral<"show">, z.ZodLiteral<"hide">, z.ZodLiteral<"toggle">]>;
-    }, "strip", z.ZodTypeAny, {
-        visibility: "toggle" | "show" | "hide";
-    }, {
-        visibility: "toggle" | "show" | "hide";
-    }>;
-}, "strip", z.ZodTypeAny, {
-    type: "webchat_visibility";
-    data: {
-        visibility: "toggle" | "show" | "hide";
-    };
-}, {
-    type: "webchat_visibility";
-    data: {
-        visibility: "toggle" | "show" | "hide";
-    };
-}>;
-export default _default;

package/dist/get-client.d.ts

@@ -1,7 +0,0 @@
-import { WebchatClient } from './client';
-type GetClientOptions = {
-    clientId: string;
-    apiUrl?: string;
-};
-export declare const getClient: ({ clientId, apiUrl }: GetClientOptions) => WebchatClient;
-export {};

package/dist/hooks/index.d.ts

@@ -1,5 +0,0 @@
-export * from './useClient';
-export * from './useImageSize';
-export * from './useIsTyping';
-export * from './useRefresh';
-export * from './useWebchatClient';

package/dist/hooks/useClient.d.ts

@@ -1,6 +0,0 @@
-type UseClientOptions = {
-    clientId: string;
-    apiUrl?: string;
-};
-export declare const useClient: ({ clientId, apiUrl }: UseClientOptions) => import("..").WebchatClient;
-export {};

package/dist/hooks/useImageSize.d.ts

@@ -1,2 +0,0 @@
-import { Options, UseImageSizeResult } from '../types';
-export declare const useImageSize: (url: string, options?: Options) => UseImageSizeResult;

package/dist/hooks/useIsTyping.d.ts

@@ -1,4 +0,0 @@
-export declare function useIsTyping(): {
-    isTyping: boolean;
-    setIsTyping: (isTyping: boolean, timeout?: number) => () => void;
-};

package/dist/hooks/useRefresh.d.ts

@@ -1,10 +0,0 @@
-export declare const defaultGetRefreshTime: (expiresAt: Date) => number;
-/**
- * Utility hooks to force a state fresh based on a date
- * @example
- * const [onRefresh, setDate] = useDateRefresh()
- * useEffect(() => {}, [onRefresh])
- * setDate(futureDate) // The refresh function will trigger when the date passes
- * @returns value to observe for refreshing and a function that set the refresh date
- */
-export declare const useRefresh: (getRefreshTimeInMs?: (expiresAt: Date) => number) => [number, (date: Date) => void];

package/dist/hooks/useWebchatClient.d.ts

@@ -1,50 +0,0 @@
-import type { Events, User } from '../client/types';
-import { type FileType, type MessageObject } from '../types';
-import { EventEmitter } from '../utils';
-import type { Message as WebchatMessage } from '../adapters/webchat';
-import { getClient } from '../client';
-import { getUseUserStore } from '../stores';
-type UserResponse = Awaited<ReturnType<Awaited<ReturnType<typeof getClient>['getUser']>>>['user'];
-type Props = {
-    userKey?: string;
-    conversationId?: string;
-    clientId: string;
-    apiUrl?: string;
-    sseTimeout?: number;
-    storageKey?: string;
-    storageLocation?: Parameters<typeof getUseUserStore>[1];
-};
-type ScopedClient = {
-    sendMessage: (payload: WebchatMessage) => Promise<void>;
-    updateUser: (user: User) => Promise<User>;
-    sendEvent: (event: Record<string, any>) => Promise<void>;
-    uploadFile: (file: File) => Promise<{
-        fileUrl: string;
-        name: string;
-        type: FileType;
-    }>;
-    getUser: () => Promise<UserResponse>;
-};
-export type UseWebchatClientReturn = {
-    clientState: 'connected' | 'disconnected' | 'error';
-    on: EventEmitter<Events>['on'];
-    client: ScopedClient;
-    messages: MessageObject[];
-    conversationId: string;
-    newConversation: () => void;
-    isFetchingMessages: boolean;
-    user?: UserResponse;
-    isTyping: boolean;
-} | {
-    clientState: 'connecting';
-    on: EventEmitter<Events>['on'];
-    client: undefined;
-    messages: MessageObject[];
-    conversationId: undefined;
-    newConversation: () => void;
-    isFetchingMessages: boolean;
-    user: undefined;
-    isTyping: undefined;
-};
-export declare function useWebchatClient({ apiUrl, clientId, storageKey, storageLocation, ...props }: Props): UseWebchatClientReturn;
-export {};

package/dist/providers/ModalProvider.d.ts

@@ -1,8 +0,0 @@
-import { PropsWithChildren, ReactNode } from 'react';
-export type ModalProps = {
-    title: string | null;
-    content: ReactNode | null;
-};
-type Props = PropsWithChildren;
-export declare const ModalProvider: ({ children }: Props) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/providers/StylesheetProvider.d.ts

@@ -1,4 +0,0 @@
-import type { Configuration } from '../types';
-type Props = Partial<Pick<Configuration, 'color' | 'fontFamily' | 'radius' | 'themeMode' | 'variant'>>;
-export declare const StylesheetProvider: ({ color, fontFamily, radius, themeMode, variant }: Props) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/providers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ModalProvider';
-export * from './StylesheetProvider';

package/dist/schemas/configuration.d.ts

@@ -1,157 +0,0 @@
-import { z } from 'zod';
-export declare const descriptionItemSchema: z.ZodObject<{
-    title: z.ZodOptional<z.ZodString>;
-    link: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    title?: string | undefined;
-    link?: string | undefined;
-}, {
-    title?: string | undefined;
-    link?: string | undefined;
-}>;
-export declare const WebchatThemeSchema: z.ZodObject<{
-    color: z.ZodOptional<z.ZodString>;
-    variant: z.ZodOptional<z.ZodEnum<["soft", "solid"]>>;
-    themeMode: z.ZodOptional<z.ZodEnum<["light", "dark"]>>;
-    fontFamily: z.ZodOptional<z.ZodEnum<["rubik", "inter", "ibm", "fira"]>>;
-    radius: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    color?: string | undefined;
-    variant?: "soft" | "solid" | undefined;
-    themeMode?: "light" | "dark" | undefined;
-    fontFamily?: "rubik" | "inter" | "ibm" | "fira" | undefined;
-    radius?: number | undefined;
-}, {
-    color?: string | undefined;
-    variant?: "soft" | "solid" | undefined;
-    themeMode?: "light" | "dark" | undefined;
-    fontFamily?: "rubik" | "inter" | "ibm" | "fira" | undefined;
-    radius?: number | undefined;
-}>;
-export declare const configurationSchema: z.ZodObject<{
-    composerPlaceholder: z.ZodOptional<z.ZodString>;
-    botName: z.ZodOptional<z.ZodString>;
-    botAvatar: z.ZodOptional<z.ZodString>;
-    botDescription: z.ZodOptional<z.ZodString>;
-    website: z.ZodOptional<z.ZodObject<{
-        title: z.ZodOptional<z.ZodString>;
-        link: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }>>;
-    email: z.ZodOptional<z.ZodObject<{
-        title: z.ZodOptional<z.ZodString>;
-        link: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }>>;
-    phone: z.ZodOptional<z.ZodObject<{
-        title: z.ZodOptional<z.ZodString>;
-        link: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }>>;
-    privacyPolicy: z.ZodOptional<z.ZodObject<{
-        title: z.ZodOptional<z.ZodString>;
-        link: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }>>;
-    termsOfService: z.ZodOptional<z.ZodObject<{
-        title: z.ZodOptional<z.ZodString>;
-        link: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }, {
-        title?: string | undefined;
-        link?: string | undefined;
-    }>>;
-    showPoweredBy: z.ZodOptional<z.ZodBoolean>;
-    storageLocation: z.ZodOptional<z.ZodEnum<["localStorage", "sessionStorage"]>>;
-    color: z.ZodOptional<z.ZodString>;
-    variant: z.ZodOptional<z.ZodEnum<["soft", "solid"]>>;
-    themeMode: z.ZodOptional<z.ZodEnum<["light", "dark"]>>;
-    fontFamily: z.ZodOptional<z.ZodEnum<["rubik", "inter", "ibm", "fira"]>>;
-    radius: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    composerPlaceholder?: string | undefined;
-    botName?: string | undefined;
-    botAvatar?: string | undefined;
-    botDescription?: string | undefined;
-    website?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    email?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    phone?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    privacyPolicy?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    termsOfService?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    showPoweredBy?: boolean | undefined;
-    storageLocation?: "localStorage" | "sessionStorage" | undefined;
-    color?: string | undefined;
-    variant?: "soft" | "solid" | undefined;
-    themeMode?: "light" | "dark" | undefined;
-    fontFamily?: "rubik" | "inter" | "ibm" | "fira" | undefined;
-    radius?: number | undefined;
-}, {
-    composerPlaceholder?: string | undefined;
-    botName?: string | undefined;
-    botAvatar?: string | undefined;
-    botDescription?: string | undefined;
-    website?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    email?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    phone?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    privacyPolicy?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    termsOfService?: {
-        title?: string | undefined;
-        link?: string | undefined;
-    } | undefined;
-    showPoweredBy?: boolean | undefined;
-    storageLocation?: "localStorage" | "sessionStorage" | undefined;
-    color?: string | undefined;
-    variant?: "soft" | "solid" | undefined;
-    themeMode?: "light" | "dark" | undefined;
-    fontFamily?: "rubik" | "inter" | "ibm" | "fira" | undefined;
-    radius?: number | undefined;
-}>;

package/dist/schemas/index.d.ts

@@ -1,3 +0,0 @@
-export * from './configuration';
-export * from './theme';
-export * from './init';