@botpress/webchat 1.3.9 → 1.3.12

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @botpress/webchat@1.3.9 build /home/runner/work/echo/echo/packages/webchat-frontend
+> @botpress/webchat@1.3.12 build /home/runner/work/echo/echo/packages/webchat-frontend
 > vite build
 
 vite v4.4.11 building for production...
@@ -11,15 +11,15 @@ transforming...
 [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".
-✓ 2426 modules transformed.
+✓ 2428 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-[vite:dts] Declaration files built in 13751ms.
+[vite:dts] Declaration files built in 14689ms.
 
 dist/index.js               1.09 kB │ gzip:   0.52 kB
-dist/index-de8cc2d3.js    118.52 kB │ gzip:  31.78 kB
-dist/index-8e9a70c6.js  1,297.30 kB │ gzip: 318.23 kB
-dist/index.umd.cjs  987.65 kB │ gzip: 291.31 kB
-✓ built in 22.86s
+dist/index-d84f2e5e.js    118.52 kB │ gzip:  31.78 kB
+dist/index-aa13a347.js  1,298.84 kB │ gzip: 318.49 kB
+dist/index.umd.cjs  988.97 kB │ gzip: 291.50 kB
+✓ built in 23.76s

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

@@ -1,10 +1,11 @@
 import { type MessagingSocketOptions, type UserCredentials } from '@botpress/messaging-socket';
 import { EventEmitter } from '../../utils';
-import { Events, UserData, WebchatClient } from '../types';
+import { Events, UserData, WebchatClient, type User } from '../types';
 export type MessagingClientProps = MessagingSocketOptions;
 export declare class MessagingClient implements WebchatClient {
     private socket;
-    clientId: string | undefined;
+    clientId: string;
+    apiUrl: string;
     userId: string | undefined;
     conversationId: string | undefined;
     private userToken;
@@ -15,6 +16,8 @@ export declare class MessagingClient implements WebchatClient {
     readonly mode = "messaging";
     connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     disconnect(): Promise<void>;
+    getUser(): Promise<User>;
+    updateUser(): Promise<User>;
     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,5 @@
 import { EventEmitter } from '../../utils';
-import { Events, Message, UserCredentials, UserData, WebchatClient } from '../types';
+import { Events, Message, UserCredentials, UserData, WebchatClient, type User } from '../types';
 export type PushpinClientProps = {
     apiUrl: string;
     clientId: string;
@@ -7,11 +7,19 @@ export type PushpinClientProps = {
 export declare class PushpinClient extends EventEmitter<Events> implements WebchatClient {
     private _client;
     private _webhookId;
+    private _apiUrl;
     private _state;
     constructor(props: PushpinClientProps);
     readonly mode = "pushpin";
+    get apiUrl(): string;
     get clientId(): string;
     get userId(): string | undefined;
+    getUser(): Promise<{
+        data: {
+            [k: string]: any;
+        } | undefined;
+    }>;
+    updateUser(user: User): Promise<User>;
     get conversationId(): string | undefined;
     connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     private _initialConnect;

package/dist/client/types.d.ts

@@ -4,7 +4,10 @@ export type UserCredentials = {
     userId: string;
     userToken: string;
 };
-export type UserData = Record<string, string>;
+export type UserData = Record<string, unknown>;
+export type User = {
+    data?: UserData;
+};
 export type Message = {
     id: string;
     conversationId: string;
@@ -13,7 +16,7 @@ export type Message = {
     disableInput?: boolean;
     payload: BlockObject;
 };
-export type Events = {
+export type WebchatEvents = {
     conversation: string | undefined;
     message: Message;
     messageSent: string;
@@ -22,14 +25,27 @@ export type Events = {
     webchatConfig: Record<string, any>;
     customEvent: Record<string, any>;
 };
+type ValueOf<T> = T[keyof T];
+type AnyEvent = ValueOf<{
+    [K in keyof WebchatEvents]: {
+        type: K;
+        payload: WebchatEvents[K];
+    };
+}>;
+export type Events = WebchatEvents & {
+    '*': AnyEvent;
+};
 export type WebchatClient = {
     mode: 'messaging' | 'pushpin';
-    clientId: string | undefined;
+    clientId: string;
+    apiUrl: string;
     userId: string | undefined;
     conversationId: string | undefined;
     on: EventEmitter<Events>['on'];
     connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     disconnect(): Promise<void>;
+    getUser(): Promise<User>;
+    updateUser(user: User): Promise<User>;
     sendMessage(message: string): Promise<void>;
     sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
@@ -37,3 +53,4 @@ export type WebchatClient = {
     newConversation(): Promise<void>;
     listMessages(): Promise<Message[]>;
 };
+export {};

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

@@ -1,4 +1,5 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { AxiosInstance } from 'axios';
+import { toAxiosRequest } from './to-axios';
 import * as addParticipant from './operations/addParticipant';
 import * as createConversation from './operations/createConversation';
 import * as deleteConversation from './operations/deleteConversation';
@@ -38,9 +39,13 @@ 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 type ClientProps = {
+    toAxiosRequest: typeof toAxiosRequest;
+};
 export declare class Client {
     private axiosInstance;
-    constructor(axiosInstance: AxiosInstance);
+    private props;
+    constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps>);
     readonly addParticipant: (input: addParticipant.AddParticipantInput) => Promise<addParticipant.AddParticipantResponse>;
     readonly createConversation: (input: createConversation.CreateConversationInput) => Promise<createConversation.CreateConversationResponse>;
     readonly deleteConversation: (input: deleteConversation.DeleteConversationInput) => Promise<deleteConversation.DeleteConversationResponse>;
@@ -61,18 +66,3 @@ export declare class Client {
     readonly createEvent: (input: createEvent.CreateEventInput) => Promise<createEvent.CreateEventResponse>;
     readonly getEvent: (input: getEvent.GetEventInput) => Promise<getEvent.GetEventResponse>;
 }
-type Primitive = string | number | boolean;
-type Value<P extends Primitive> = P | P[] | Record<string, P>;
-type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
-type AnyQueryParams = Record<string, QueryValue>;
-type HeaderValue = string | undefined;
-type AnyHeaderParams = Record<string, HeaderValue>;
-type AnyBodyParams = Record<string, any>;
-type ParsedRequest = {
-    method: string;
-    path: string;
-    query: AnyQueryParams;
-    headers: AnyHeaderParams;
-    body: AnyBodyParams;
-};
-export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;

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

@@ -10,6 +10,12 @@ export interface User {
      * Picture url of the [User](#schema_user)
      */
     pictureUrl?: string;
+    /**
+     * User data
+     */
+    data?: {
+        [k: string]: any;
+    };
     /**
      * Id of the [User](#schema_user)
      */

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

@@ -35,6 +35,12 @@ export interface AddParticipantResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

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

@@ -43,6 +43,12 @@ export interface CreateUserResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

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

@@ -32,6 +32,12 @@ export interface GetParticipantResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

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

@@ -30,6 +30,12 @@ export interface GetUserResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

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

@@ -29,6 +29,12 @@ export interface ListParticipantsResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

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

@@ -19,7 +19,7 @@ export interface UpdateUserRequestBody {
      */
     userData?: {
         [k: string]: any;
-    };
+    } | null;
 }
 export type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
 export type UpdateUserRequest = {
@@ -44,6 +44,12 @@ export interface UpdateUserResponse {
          * Picture url of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * User data
+         */
+        data?: {
+            [k: string]: any;
+        };
         /**
          * Id of the [User](#schema_user)
          */

package/dist/gen/client/to-axios.d.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig } from "axios";
+export type Primitive = string | number | boolean;
+export type Value<P extends Primitive> = P | P[] | Record<string, P>;
+export type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
+export type AnyQueryParams = Record<string, QueryValue>;
+export type HeaderValue = string | undefined;
+export type AnyHeaderParams = Record<string, HeaderValue>;
+export type AnyBodyParams = Record<string, any>;
+export type ParsedRequest = {
+    method: string;
+    path: string;
+    query: AnyQueryParams;
+    headers: AnyHeaderParams;
+    body: AnyBodyParams;
+};
+export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;

package/dist/hooks/useClient.d.ts

@@ -1,8 +1,7 @@
-import { WebchatClient } from '../client';
 type UseClientOptions = {
     mode?: 'messaging' | 'pushpin';
     clientId: string;
     apiUrl?: string;
 };
-export declare const useClient: ({ clientId, apiUrl, mode, }: UseClientOptions) => WebchatClient | undefined;
+export declare const useClient: ({ clientId, apiUrl, mode, }: UseClientOptions) => import("..").WebchatClient;
 export {};