@botpress/webchat-client 0.1.1 → 0.2.0-beta.2

package/.turbo/turbo-build.log

@@ -1,28 +1,29 @@
 
-> @botpress/webchat-client@0.1.1 build /home/runner/work/genisys/genisys/packages/webchat-client
+> @botpress/webchat-client@0.2.0-beta.2 build /home/runner/work/genisys/genisys/packages/webchat-client
 > openapi-ts && vite build
 
 ⏳ Generating from raw OpenAPI specification
 🚀 Done! Your output is in ./src/gen/client
 vite v5.4.10 building for production...
 transforming...
-✓ 13 modules transformed.
+✓ 17 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/webchat-client.js    0.13 kB │ gzip: 0.11 kB
-dist/webchat-client7.js   0.19 kB │ gzip: 0.16 kB
-dist/webchat-client4.js   0.28 kB │ gzip: 0.18 kB
-dist/webchat-client6.js   0.53 kB │ gzip: 0.26 kB
-dist/webchat-client8.js   2.63 kB │ gzip: 1.15 kB
-dist/webchat-client3.js   2.78 kB │ gzip: 0.52 kB
-dist/webchat-client2.js   3.74 kB │ gzip: 1.06 kB
-dist/webchat-client9.js   8.58 kB │ gzip: 2.91 kB
-dist/webchat-client5.js  10.93 kB │ gzip: 3.47 kB
+dist/webchat-client.js     0.17 kB │ gzip: 0.13 kB
+dist/webchat-client8.js    0.19 kB │ gzip: 0.16 kB
+dist/webchat-client4.js    0.29 kB │ gzip: 0.18 kB
+dist/webchat-client6.js    0.30 kB │ gzip: 0.22 kB
+dist/webchat-client7.js    0.45 kB │ gzip: 0.26 kB
+dist/webchat-client9.js    2.63 kB │ gzip: 1.15 kB
+dist/webchat-client3.js    3.30 kB │ gzip: 0.58 kB
+dist/webchat-client2.js    4.75 kB │ gzip: 1.30 kB
+dist/webchat-client10.js   8.58 kB │ gzip: 2.91 kB
+dist/webchat-client5.js   10.93 kB │ gzip: 3.47 kB
 [vite:dts] Start rollup declaration files...
 Analysis will use the bundled TypeScript version 5.4.2
 *** The target project appears to use TypeScript 5.6.2 which is newer than the bundled compiler engine; consider upgrading API Extractor.
-[vite:dts] Declaration files built in 5765ms.
+[vite:dts] Declaration files built in 5038ms.
 
-✓ built in 6.16s
+✓ built in 5.45s

package/dist/index.d.ts

@@ -1,3 +1,63 @@
+/**
+ * Adds feedback to a [Message](#schema_message).
+ */
+declare const addMessageFeedback: <ThrowOnError extends boolean = false>(options: Options<AddMessageFeedbackData, ThrowOnError>) => RequestResult<{
+    [key: string]: never;
+}, {
+    [key: string]: never;
+}, ThrowOnError>;
+
+/**
+ * Message data
+ */
+export declare type AddMessageFeedbackBody = {
+    value: 'positive' | 'negative';
+    comment?: string;
+};
+
+export declare type AddMessageFeedbackData = {
+    /**
+     * Message data
+     */
+    body?: AddMessageFeedbackBody;
+    headers: {
+        /**
+         * Authentication Key
+         */
+        'x-user-key': string;
+    };
+    path: {
+        /**
+         * Message id
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/messages/{id}/feedback';
+};
+
+export declare type AddMessageFeedbackError = AddMessageFeedbackErrors[keyof AddMessageFeedbackErrors];
+
+export declare type AddMessageFeedbackErrors = {
+    /**
+     * Empty object
+     */
+    default: {
+        [key: string]: never;
+    };
+};
+
+export declare type AddMessageFeedbackResponse = AddMessageFeedbackResponses[keyof AddMessageFeedbackResponses];
+
+export declare type AddMessageFeedbackResponses = {
+    /**
+     * Empty object
+     */
+    200: {
+        [key: string]: never;
+    };
+};
+
 /**
  * Add a [Participant](#schema_user) to a [Conversation](#schema_conversation).
  */
@@ -127,12 +187,17 @@ export declare type Client = {
     deleteMessage: (params: MessageIdParam) => Promise<ClientTypes_2.DeleteMessageResponse>;
     createFile: (params: ClientTypes_2.CreateFileBody) => Promise<ClientTypes_2.CreateFileResponse>;
     createUser: (params: ClientTypes_2.CreateUserBody) => Promise<ClientTypes_2.CreateUserResponse>;
-    getUser: (params: UserIdParam) => Promise<ClientTypes_2.GetUserResponse>;
+    getUser: () => Promise<ClientTypes_2.GetUserResponse>;
     updateUser: (params: ClientTypes_2.CreateUserBody) => Promise<ClientTypes_2.UpdateUserResponse>;
     deleteUser: (params: UserIdParam) => Promise<ClientTypes_2.DeleteUserResponse>;
     createEvent: (params: ClientTypes_2.CreateEventBody) => Promise<ClientTypes_2.CreateEventResponse>;
     getEvent: (params: EventIdParam) => Promise<ClientTypes_2.GetEventResponse>;
     listenConversation: (params: ConversationIdParam) => EventEmitter<Record<Event_3['type'], Event_3['data']>>['on'];
+    addMessageFeedback: (params: MessageIdParam & ClientTypes_2.AddMessageFeedbackBody) => Promise<ClientTypes_2.AddMessageFeedbackResponse>;
+    removeMessageFeedback: (params: MessageIdParam) => Promise<ClientTypes_2.RemoveMessageFeedbackResponse>;
+    generateUserKey: (params: ClientTypes_2.GenerateUserKeyBody & {
+        adminKey: string;
+    }) => Promise<ClientTypes_2.GenerateUserKeyResponse>;
 };
 
 declare type Client_2 = Client$1<RequestFn, Config, MethodFn, BuildUrlFn> & {
@@ -160,7 +225,9 @@ declare namespace ClientTypes_2 {
         CreateMessageBody,
         UpdateMessageBody,
         SelectMessageBody,
+        AddMessageFeedbackBody,
         CreateUserBody,
+        GenerateUserKeyBody,
         UpdateUserBody,
         CreateEventBody,
         CreateFileBody,
@@ -239,6 +306,16 @@ declare namespace ClientTypes_2 {
         SelectMessageError,
         SelectMessageResponses,
         SelectMessageResponse,
+        RemoveMessageFeedbackData,
+        RemoveMessageFeedbackErrors,
+        RemoveMessageFeedbackError,
+        RemoveMessageFeedbackResponses,
+        RemoveMessageFeedbackResponse,
+        AddMessageFeedbackData,
+        AddMessageFeedbackErrors,
+        AddMessageFeedbackError,
+        AddMessageFeedbackResponses,
+        AddMessageFeedbackResponse,
         DeleteUserData,
         DeleteUserErrors,
         DeleteUserError,
@@ -259,6 +336,11 @@ declare namespace ClientTypes_2 {
         CreateUserError,
         CreateUserResponses,
         CreateUserResponse,
+        GenerateUserKeyData,
+        GenerateUserKeyErrors,
+        GenerateUserKeyError,
+        GenerateUserKeyResponses,
+        GenerateUserKeyResponse,
         GetEventData,
         GetEventErrors,
         GetEventError,
@@ -291,10 +373,13 @@ declare namespace ClientTypes_2 {
         updateMessage,
         createMessage,
         selectMessage,
+        removeMessageFeedback,
+        addMessageFeedback,
         deleteUser,
         getUser,
         updateUser,
         createUser_2 as createUser,
+        generateUserKey_2 as generateUserKey,
         getEvent,
         createEvent,
         createFile
@@ -750,9 +835,6 @@ export declare type CreateMessageBody = {
         name: string;
         data?: unknown;
         type: 'custom';
-    } | {
-        reaction: string;
-        type: 'reaction';
     };
     /**
      * ID of the [Conversation](#schema_conversation)
@@ -806,9 +888,10 @@ export declare type CreateMessageResponses = {
     };
 };
 
-export declare const createUser: ({ clientId, apiUrl }: {
+export declare const createUser: ({ clientId, apiUrl, adminKey, }: {
     clientId: string;
     apiUrl?: string;
+    adminKey?: string;
 }) => Promise<{
     user: ClientTypes_2.User;
     key: string;
@@ -848,6 +931,12 @@ export declare type CreateUserData = {
      * User data
      */
     body?: CreateUserBody;
+    headers?: {
+        /**
+         * Admin Key for managing users
+         */
+        'x-admin-key'?: string;
+    };
     path?: never;
     query?: never;
     url: '/users';
@@ -966,7 +1055,7 @@ export declare type DeleteMessageError = DeleteMessageErrors[keyof DeleteMessage
 
 export declare type DeleteMessageErrors = {
     /**
-     * Returns the [Message](#schema_message) object that was deleted
+     * Empty object
      */
     default: {
         [key: string]: never;
@@ -977,7 +1066,7 @@ export declare type DeleteMessageResponse = DeleteMessageResponses[keyof DeleteM
 
 export declare type DeleteMessageResponses = {
     /**
-     * Returns the [Message](#schema_message) object that was deleted
+     * Empty object
      */
     200: {
         [key: string]: never;
@@ -1068,12 +1157,10 @@ declare type Event_3 = Signal | {
     data: any;
 };
 
-declare class EventEmitter<T extends Record<string, any>> {
-    private readonly eventMap;
-    constructor();
-    on<U extends keyof T>(event: U, callback: CallbackFn<T[U]>): () => void;
-    emit<U extends keyof T>(event: U, arg?: T[U]): void;
-}
+declare type EventEmitter<T extends Record<string, unknown>> = {
+    on: <U extends keyof T>(event: U, callback: CallbackFn<T[U]>) => () => void;
+    emit: <U extends keyof T>(event: U, arg?: T[U]) => void;
+};
 
 declare type EventIdParam = {
     eventId: string;
@@ -1099,6 +1186,77 @@ declare type File_2 = {
 };
 export { File_2 as File }
 
+export declare const generateUserKey: ({ adminKey, expiresAt, userId, apiUrl, clientId, }: {
+    adminKey: string;
+    expiresAt: number;
+    userId: string;
+    apiUrl?: string;
+    clientId: string;
+}) => Promise<{
+    key: string;
+}>;
+
+/**
+ * Generates a new user authentication key. Can only be called by an administrator and when an admin key is configured.
+ */
+declare const generateUserKey_2: <ThrowOnError extends boolean = false>(options?: Options<GenerateUserKeyData, ThrowOnError>) => RequestResult<{
+    key: string;
+}, {
+    key: string;
+}, ThrowOnError>;
+
+/**
+ * User Key Data
+ */
+export declare type GenerateUserKeyBody = {
+    /**
+     * The ID of the user to generate a key for
+     */
+    id: string;
+    /**
+     * The expiration date of the key in milliseconds since midnight, January 1, 1970 UTC. If not provided, the key will never expire.
+     */
+    expiresAt?: number;
+};
+
+export declare type GenerateUserKeyData = {
+    /**
+     * User Key Data
+     */
+    body?: GenerateUserKeyBody;
+    headers?: {
+        /**
+         * Admin Key for managing users
+         */
+        'x-admin-key'?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/users/key';
+};
+
+export declare type GenerateUserKeyError = GenerateUserKeyErrors[keyof GenerateUserKeyErrors];
+
+export declare type GenerateUserKeyErrors = {
+    /**
+     * Returns a user key
+     */
+    default: {
+        key: string;
+    };
+};
+
+export declare type GenerateUserKeyResponse = GenerateUserKeyResponses[keyof GenerateUserKeyResponses];
+
+export declare type GenerateUserKeyResponses = {
+    /**
+     * Returns a user key
+     */
+    200: {
+        key: string;
+    };
+};
+
 /**
  * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
  */
@@ -1343,6 +1501,13 @@ export declare type GetUserResponses = {
     };
 };
 
+export declare type IntegrationError = {
+    id: string;
+    code: number;
+    type: string;
+    message: string;
+};
+
 declare class Interceptors<Interceptor> {
     _fns: Interceptor[];
     constructor();
@@ -1773,9 +1938,6 @@ export declare type Message = {
         name: string;
         data?: unknown;
         type: 'custom';
-    } | {
-        reaction: string;
-        type: 'reaction';
     };
     /**
      * ID of the [User](#schema_user)
@@ -1797,6 +1959,13 @@ export declare type Message = {
      * ID of the user who selected this message. Undefined if not selected.
      */
     selectedBy?: string;
+    /**
+     * Feedback of the message
+     */
+    feedback?: {
+        value: 'positive' | 'negative';
+        comment?: string;
+    };
 };
 
 declare type MessageCreated = {
@@ -1984,6 +2153,205 @@ declare type MessageIdParam = {
     messageId: string;
 };
 
+declare type MessageStatusChanged = {
+    type: 'message_status_changed';
+    data: {
+        /**
+         * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
+         */
+        message: {
+            /**
+             * Id of the [Message](#schema_message)
+             */
+            id: string;
+            /**
+             * Creation date of the [Message](#schema_message) in ISO 8601 format
+             */
+            createdAt: string;
+            /**
+             * Payload is the content of the message.
+             */
+            payload: {
+                audioUrl: string;
+                type: 'audio';
+                [k: string]: any;
+            } | {
+                title: string;
+                subtitle?: string;
+                imageUrl?: string;
+                actions: {
+                    action: 'postback' | 'url' | 'say';
+                    label: string;
+                    value: string;
+                    [k: string]: any;
+                }[];
+                type: 'card';
+                [k: string]: any;
+            } | {
+                items: {
+                    title: string;
+                    subtitle?: string;
+                    imageUrl?: string;
+                    actions: {
+                        action: 'postback' | 'url' | 'say';
+                        label: string;
+                        value: string;
+                        [k: string]: any;
+                    }[];
+                    [k: string]: any;
+                }[];
+                type: 'carousel';
+                [k: string]: any;
+            } | {
+                text: string;
+                options: {
+                    label: string;
+                    value: string;
+                    [k: string]: any;
+                }[];
+                disableFreeText?: boolean;
+                type: 'choice';
+                [k: string]: any;
+            } | {
+                text: string;
+                options: {
+                    label: string;
+                    value: string;
+                    [k: string]: any;
+                }[];
+                disableFreeText?: boolean;
+                type: 'dropdown';
+                [k: string]: any;
+            } | {
+                fileUrl: string;
+                title?: string;
+                type: 'file';
+                [k: string]: any;
+            } | {
+                imageUrl: string;
+                type: 'image';
+                [k: string]: any;
+            } | {
+                latitude: number;
+                longitude: number;
+                address?: string;
+                title?: string;
+                type: 'location';
+                [k: string]: any;
+            } | {
+                text: string;
+                value?: string;
+                type: 'text';
+                [k: string]: any;
+            } | {
+                videoUrl: string;
+                type: 'video';
+                [k: string]: any;
+            } | {
+                items: ({
+                    type: 'text';
+                    payload: {
+                        text: string;
+                        value?: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'markdown';
+                    payload: {
+                        markdown: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'image';
+                    payload: {
+                        imageUrl: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'audio';
+                    payload: {
+                        audioUrl: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'video';
+                    payload: {
+                        videoUrl: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'file';
+                    payload: {
+                        fileUrl: string;
+                        title?: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                } | {
+                    type: 'location';
+                    payload: {
+                        latitude: number;
+                        longitude: number;
+                        address?: string;
+                        title?: string;
+                        [k: string]: any;
+                    };
+                    [k: string]: any;
+                })[];
+                type: 'bloc';
+                [k: string]: any;
+            } | {
+                markdown: string;
+                type: 'markdown';
+                [k: string]: any;
+            } | {
+                url: string;
+                name: string;
+                data?: any;
+                type: 'custom';
+                [k: string]: any;
+            };
+            /**
+             * ID of the [User](#schema_user)
+             */
+            userId: string;
+            /**
+             * ID of the [Conversation](#schema_conversation)
+             */
+            conversationId: string;
+            /**
+             * Metadata of the message
+             */
+            metadata?: {
+                [k: string]: any;
+            };
+            /**
+             * ID of the message this message is replying to
+             */
+            replyTo?: string;
+            /**
+             * ID of the user who selected this message. Undefined if not selected.
+             */
+            selectedBy?: string;
+            /**
+             * Feedback of the message
+             */
+            feedback?: {
+                value: 'positive' | 'negative';
+                comment?: string;
+            };
+        };
+        oldStatus?: 'scheduled' | 'pending' | 'processing' | 'processed' | 'failed' | 'skipped';
+        newStatus: 'scheduled' | 'pending' | 'processing' | 'processed' | 'failed' | 'skipped';
+        failureReason?: string;
+    };
+};
+
 declare type MessageUpdated = {
     type: 'message_updated';
     /**
@@ -2197,6 +2565,52 @@ declare type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
 
 declare type Options_2<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
 
+declare type ParticipantAdded = {
+    type: 'participant_added';
+    data: {
+        conversationId: string;
+        /**
+         * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+         */
+        participant: {
+            /**
+             * Name of the [User](#schema_user)
+             */
+            name?: string;
+            /**
+             * Picture url of the [User](#schema_user)
+             */
+            pictureUrl?: string;
+            /**
+             * User data
+             */
+            data?: {
+                [k: string]: any;
+            };
+            /**
+             * Id of the [User](#schema_user)
+             */
+            id: string;
+            /**
+             * Creation date of the [User](#schema_user) in ISO 8601 format
+             */
+            createdAt: string;
+            /**
+             * Updating date of the [User](#schema_user) in ISO 8601 format
+             */
+            updatedAt: string;
+        };
+    };
+};
+
+declare type ParticipantRemoved = {
+    type: 'participant_removed';
+    data: {
+        conversationId: string;
+        participantId: string;
+    };
+};
+
 declare type QuerySerializer = (query: Record<string, unknown>) => string;
 
 declare interface QuerySerializerOptions {
@@ -2205,6 +2619,55 @@ declare interface QuerySerializerOptions {
     object?: SerializerOptions<ObjectStyle>;
 }
 
+/**
+ * Removes feedback from a [Message](#schema_message).
+ */
+declare const removeMessageFeedback: <ThrowOnError extends boolean = false>(options: Options<RemoveMessageFeedbackData, ThrowOnError>) => RequestResult<{
+    [key: string]: never;
+}, {
+    [key: string]: never;
+}, ThrowOnError>;
+
+export declare type RemoveMessageFeedbackData = {
+    body?: never;
+    headers: {
+        /**
+         * Authentication Key
+         */
+        'x-user-key': string;
+    };
+    path: {
+        /**
+         * Message id
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/messages/{id}/feedback';
+};
+
+export declare type RemoveMessageFeedbackError = RemoveMessageFeedbackErrors[keyof RemoveMessageFeedbackErrors];
+
+export declare type RemoveMessageFeedbackErrors = {
+    /**
+     * Empty object
+     */
+    default: {
+        [key: string]: never;
+    };
+};
+
+export declare type RemoveMessageFeedbackResponse = RemoveMessageFeedbackResponses[keyof RemoveMessageFeedbackResponses];
+
+export declare type RemoveMessageFeedbackResponses = {
+    /**
+     * Empty object
+     */
+    200: {
+        [key: string]: never;
+    };
+};
+
 /**
  * Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation).
  */
@@ -2364,7 +2827,7 @@ declare interface SerializerOptions<T> {
     style: T;
 }
 
-declare type Signal = MessageCreated | MessageUpdated | WebchatVisibility | WebchatConfig | Custom | TypingStarted | TypingStopped;
+declare type Signal = MessageCreated | MessageUpdated | WebchatVisibility | WebchatConfig | Custom | TypingStarted | TypingStopped | ParticipantAdded | ParticipantRemoved | MessageStatusChanged;
 
 declare interface TDataShape {
     body?: unknown;
@@ -2514,9 +2977,6 @@ export declare type UpdateMessageBody = {
         name: string;
         data?: unknown;
         type: 'custom';
-    } | {
-        reaction: string;
-        type: 'reaction';
     };
     /**
      * Metadata of the message
@@ -2662,6 +3122,11 @@ export declare type User = {
     updatedAt: string;
 };
 
+export declare type UserCredentials = {
+    userId: string;
+    userToken: string;
+};
+
 declare type UserIdParam = {
     userId: string;
 };