@botpress/webchat 2.0.0 → 2.1.1

package/.turbo/turbo-build.log

@@ -1,25 +1,25 @@
 
-> @botpress/webchat@2.0.0 build /home/runner/work/echo/echo/packages/webchat-frontend
+> @botpress/webchat@2.1.1 build /home/runner/work/echo/echo/packages/webchat-frontend
 > vite build
 
 vite v4.4.11 building for production...
 transforming...
 [plugin:vite:resolve] Module "crypto" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/packages/webchat-frontend/src/gen/client/errors.ts". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
-[plugin:vite:resolve] Module "node:http" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.5/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
-[plugin:vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.5/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "node:http" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.29_react@18.2.0/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
+[plugin:vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@botpress+sdk@0.8.29_react@18.2.0/node_modules/@botpress/sdk/dist/index.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
 [plugin:vite:resolve] Module "path" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@apidevtools+json-schema-ref-parser@11.6.1/node_modules/@apidevtools/json-schema-ref-parser/dist/lib/util/url.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
 [plugin:vite:resolve] Module "path" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@apidevtools+json-schema-ref-parser@11.6.1/node_modules/@apidevtools/json-schema-ref-parser/dist/lib/util/convert-path-to-posix.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
 [plugin:vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/home/runner/work/echo/echo/node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js". See http://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
 ../../node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js (1:9) "inspect" is not exported by "__vite-browser-external", imported by "../../node_modules/.pnpm/@jsdevtools+ono@7.1.3/node_modules/@jsdevtools/ono/esm/types.js".
-✓ 2428 modules transformed.
+✓ 2436 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-[vite:dts] Declaration files built in 14905ms.
+[vite:dts] Declaration files built in 14756ms.
 
-dist/index.js               1.09 kB │ gzip:   0.52 kB
-dist/index-773597b6.js    118.52 kB │ gzip:  31.78 kB
-dist/index-c3cb8119.js  1,298.88 kB │ gzip: 318.51 kB
-dist/index.umd.cjs  989.01 kB │ gzip: 291.51 kB
-✓ built in 24.05s
+dist/index.js               1.17 kB │ gzip:   0.56 kB
+dist/index-71c4fbd6.js    118.52 kB │ gzip:  31.78 kB
+dist/index-37291b06.js  1,449.27 kB │ gzip: 360.65 kB
+dist/index.umd.cjs  1,082.64 kB │ gzip: 327.96 kB
+✓ built in 24.49s

package/dist/client/MessagingClient/client.d.ts

@@ -18,6 +18,7 @@ export declare class MessagingClient implements WebchatClient {
     disconnect(): Promise<void>;
     getUser(): Promise<User>;
     updateUser(): Promise<User>;
+    sendFile(_file: File): Promise<any>;
     sendMessage(message: string): Promise<void>;
     sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;

package/dist/client/PushpinClient/index.d.ts

@@ -1,5 +1,6 @@
 import { EventEmitter } from '../../utils';
 import { Events, Message, UserCredentials, UserData, WebchatClient, type User } from '../types';
+import { type FileType } from '../../types';
 export type PushpinClientProps = {
     apiUrl: string;
     clientId: string;
@@ -25,6 +26,11 @@ export declare class PushpinClient extends EventEmitter<Events> implements Webch
     private _initialConnect;
     private _reConnect;
     disconnect(): Promise<void>;
+    sendFile(file: File): Promise<{
+        fileUrl: string;
+        name: string;
+        type: FileType;
+    }>;
     sendMessage(message: string): Promise<void>;
     sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;

package/dist/client/PushpinClient/inner-client/index.d.ts

@@ -31,6 +31,7 @@ export declare class Client implements IClient {
     readonly createMessage: IAutoClient['createMessage'];
     readonly getMessage: IAutoClient['getMessage'];
     readonly deleteMessage: IAutoClient['deleteMessage'];
+    readonly createFile: IAutoClient['createFile'];
     readonly createUser: IAutoClient['createUser'];
     readonly getUser: IAutoClient['getUser'];
     readonly updateUser: IAutoClient['updateUser'];

package/dist/client/types.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from '../utils';
-import { BlockObject } from '../types/block-type';
+import { BlockObject, type FileType } from '../types/block-type';
 export type UserCredentials = {
     userId: string;
     userToken: string;
@@ -47,6 +47,11 @@ export type WebchatClient = {
     getUser(): Promise<User>;
     updateUser(user: User): Promise<User>;
     sendMessage(message: string): Promise<void>;
+    sendFile(file: File): Promise<{
+        fileUrl: string;
+        name: string;
+        type: FileType;
+    }>;
     sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
     conversationExists(id: string): Promise<boolean>;

package/dist/components/Composer.d.ts

@@ -3,10 +3,16 @@ import { ComponentProps, FC } from 'react';
 import { type StyleOptions } from '../contexts';
 declare const Composer: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;
 declare const ComposerInput: import("react").MemoExoticComponent<(props: ComponentProps<'textarea'>) => import("react/jsx-runtime").JSX.Element>;
+type UploadButtonStyle = NonNullable<Theme['composer']>['uploadButton'];
+type UploadButtonProps = {
+    icon?: FC<StyleOptions>;
+    styles?: UploadButtonStyle;
+} & ComponentProps<'button'>;
+declare const UploadButton: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<UploadButtonProps, "ref"> & import("react").RefAttributes<HTMLButtonElement>>>;
 type ComposerButtonStyle = NonNullable<Theme['composer']>['button'];
 type ComposerButtonProps = {
     icon?: FC<StyleOptions>;
     styles?: ComposerButtonStyle;
 } & ComponentProps<'button'>;
 declare const ComposerButton: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<ComposerButtonProps, "ref"> & import("react").RefAttributes<HTMLButtonElement>>>;
-export { Composer, ComposerInput, ComposerButton };
+export { Composer, ComposerInput, ComposerButton, UploadButton };

package/dist/contexts/WebchatContext.d.ts

@@ -34,10 +34,9 @@ export type ContextVaue = {
         on: WebchatClient['on'];
         sendMessage: WebchatClient['sendMessage'];
         restartConversation: () => void;
-    } & Pick<WebchatClient, 'userId' | 'conversationId' | 'clientId'>;
+    } & Pick<WebchatClient, 'userId' | 'conversationId' | 'clientId' | 'sendFile'>;
     closeWindow?: () => void;
     setState: (state: Partial<ContextVaue['state']>) => void;
     setTheme: (styles: Partial<Theme>) => void;
 };
 export declare const WebchatContext: import("react").Context<ContextVaue | null>;
-export declare function useWebchatContext(): ContextVaue;

package/dist/gen/client/errors.d.ts

@@ -135,6 +135,13 @@ type ReferenceConstraintType = 'ReferenceConstraint';
 export declare class ReferenceConstraintError extends BaseApiError<409, ReferenceConstraintType, 'The resource cannot be deleted because it\'s referenced by another resource'> {
     constructor(message: string, error?: Error, id?: string);
 }
+type ResourceLockedConflictType = 'ResourceLockedConflict';
+/**
+ *  The resource is current locked and cannot be operated on until the lock is released.
+ */
+export declare class ResourceLockedConflictError extends BaseApiError<409, ResourceLockedConflictType, 'The resource is current locked and cannot be operated on until the lock is released.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
 type ReferenceNotFoundType = 'ReferenceNotFound';
 /**
  *  The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
@@ -198,7 +205,7 @@ type BreakingChangesType = 'BreakingChanges';
 export declare class BreakingChangesError extends BaseApiError<400, BreakingChangesType, 'Request payload contains breaking changes which is not allowed for this resource without a version increment.'> {
     constructor(message: string, error?: Error, id?: string);
 }
-export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
-export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
+export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ResourceLockedConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
+export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ResourceLockedConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
 export declare const errorFrom: (err: unknown) => ApiError;
 export {};

package/dist/gen/client/index.d.ts

@@ -19,6 +19,7 @@ import * as getUser from './operations/getUser';
 import * as updateUser from './operations/updateUser';
 import * as createEvent from './operations/createEvent';
 import * as getEvent from './operations/getEvent';
+import * as createFile from './operations/createFile';
 export * from './models';
 export * as addParticipant from './operations/addParticipant';
 export * as createConversation from './operations/createConversation';
@@ -39,6 +40,7 @@ export * as getUser from './operations/getUser';
 export * as updateUser from './operations/updateUser';
 export * as createEvent from './operations/createEvent';
 export * as getEvent from './operations/getEvent';
+export * as createFile from './operations/createFile';
 export type ClientProps = {
     toAxiosRequest: typeof toAxiosRequest;
 };
@@ -65,4 +67,5 @@ export declare class Client {
     readonly updateUser: (input: updateUser.UpdateUserInput) => Promise<updateUser.UpdateUserResponse>;
     readonly createEvent: (input: createEvent.CreateEventInput) => Promise<createEvent.CreateEventResponse>;
     readonly getEvent: (input: getEvent.GetEventInput) => Promise<getEvent.GetEventResponse>;
+    readonly createFile: (input: createFile.CreateFileInput) => Promise<createFile.CreateFileResponse>;
 }

package/dist/gen/client/models.d.ts

@@ -214,3 +214,21 @@ export interface Event {
      */
     userId: string;
 }
+export interface File {
+    id: string;
+    botId: string;
+    key: string;
+    size: number | null;
+    contentType: string;
+    tags: {
+        [k: string]: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+    accessPolicies: ("integrations" | "public_content")[];
+    index: boolean;
+    url: string;
+    status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
+    failedStatusReason?: string;
+    uploadUrl: string;
+}

package/dist/gen/client/operations/createFile.d.ts

@@ -0,0 +1,65 @@
+export interface CreateFileRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateFileRequestQuery {
+}
+export interface CreateFileRequestParams {
+}
+export interface CreateFileRequestBody {
+    /**
+     * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
+     */
+    key: string;
+    /**
+     * File size in bytes. This will count against your File Storage quota. If the index parameter is set to true, this will also count against your Vector DB Storage quota.
+     */
+    size: number;
+    /**
+     * File access policies. Add "public_content" to allow public access to the file content. Add "integrations" to allow read, search and list operations for any integration installed in the bot.
+     */
+    accessPolicies?: ("integrations" | "public_content")[];
+    /**
+     * Whether the file should be indexed. If true, the file content will be searchable in the Vector DB. This will count against your Vector DB Storage quota.
+     */
+    index?: boolean;
+    /**
+     * File content type. If omitted, the content type will be inferred from the file extension (if any) specified in key. If a content type cannot be inferred, the default is "application/octet-stream".
+     */
+    contentType?: string;
+    /**
+     * File tags. These are used for search and filtering operations.
+     */
+    tags?: {
+        [k: string]: string;
+    };
+}
+export type CreateFileInput = CreateFileRequestBody & CreateFileRequestHeaders & CreateFileRequestQuery & CreateFileRequestParams;
+export type CreateFileRequest = {
+    headers: CreateFileRequestHeaders;
+    query: CreateFileRequestQuery;
+    params: CreateFileRequestParams;
+    body: CreateFileRequestBody;
+};
+export declare const parseReq: (input: CreateFileInput) => CreateFileRequest & {
+    path: string;
+};
+export interface CreateFileResponse {
+    file: {
+        id: string;
+        botId: string;
+        key: string;
+        size: number | null;
+        contentType: string;
+        tags: {
+            [k: string]: string;
+        };
+        createdAt: string;
+        updatedAt: string;
+        accessPolicies: ("integrations" | "public_content")[];
+        index: boolean;
+        url: string;
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
+        failedStatusReason?: string;
+        uploadUrl: string;
+    };
+}

package/dist/hooks/index.d.ts

@@ -1,5 +1,5 @@
+export * from './useAutosizeTextArea';
+export * from './useClient';
 export * from './useImageSize';
+export * from './useRefresh';
 export * from './useWebchatStore';
-export * from './useRefresh.ts';
-export * from './useClient.ts';
-export * from './useAutosizeTextArea.ts';

package/dist/hooks/useWebchatStore.d.ts

@@ -1,33 +1,2 @@
-import { UserCredentials } from '@botpress/messaging-socket';
-type WebchatState = {
-    messageHistory: {
-        [key: string]: string[];
-    };
-    user?: UserCredentials;
-    conversationId?: string;
-    clientMode: string;
-    addMessageToHistory: (props: {
-        userId: string;
-        message: string;
-    }) => void;
-    setClientMode: (clientMode: string) => void;
-    setUser: (userId?: UserCredentials) => void;
-    setConversationId: (conversationId?: string) => void;
-    clearAll: () => void;
-};
-export declare const useWebchatStore: import("zustand").UseBoundStore<Omit<Omit<import("zustand").StoreApi<WebchatState>, "setState"> & {
-    setState<A extends string | {
-        type: unknown;
-    }>(partial: WebchatState | Partial<WebchatState> | ((state: WebchatState) => WebchatState | Partial<WebchatState>), replace?: boolean | undefined, action?: A | undefined): void;
-}, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<WebchatState, WebchatState>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => void | Promise<void>;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: WebchatState) => void) => () => void;
-        onFinishHydration: (fn: (state: WebchatState) => void) => () => void;
-        getOptions: () => Partial<import("zustand/middleware").PersistOptions<WebchatState, WebchatState>>;
-    };
-}>;
-export {};
+import { type WebchatState } from '../stores';
+export declare function useWebchatStore<T>(selector: (state: WebchatState) => T): T;