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

package/src/client/types/signals/messageStatusChanged.ts

@@ -0,0 +1,219 @@
+export 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
+  }
+}

package/src/client/types/signals/participantAdded.ts

@@ -0,0 +1,37 @@
+export 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
+    }
+  }
+}

package/src/client/types/signals/participantRemoved.ts

@@ -0,0 +1,7 @@
+export type ParticipantRemoved = {
+  type: 'participant_removed'
+  data: {
+    conversationId: string
+    participantId: string
+  }
+}

package/src/client/types/user.ts

@@ -0,0 +1,4 @@
+export type UserCredentials = {
+  userId: string
+  userToken: string
+}

package/src/index.ts

@@ -1,2 +1,9 @@
-export { createClient, createUser, type Client } from './client'
+export {
+  createClient,
+  createUser,
+  generateUserKey,
+  type Client,
+  type UserCredentials,
+  type IntegrationError,
+} from './client'
 export * from './gen/client/types.gen'

package/src/client/eventEmitter.ts

@@ -1,36 +0,0 @@
-type CallbackFn<T> = (args: T) => void
-
-export class EventEmitter<T extends Record<string, any>> {
-  private readonly eventMap: Partial<Record<keyof T, Set<CallbackFn<any>>>>
-
-  constructor() {
-    this.eventMap = {}
-  }
-
-  on<U extends keyof T>(event: U, callback: CallbackFn<T[U]>): () => void {
-    if (!this.eventMap[event]) {
-      this.eventMap[event] = new Set<CallbackFn<T[U]>>()
-    }
-    this.eventMap[event]?.add(callback)
-
-    return () => {
-      this.eventMap[event]?.delete(callback)
-    }
-  }
-
-  emit<U extends keyof T>(event: U, arg?: T[U]): void {
-    this.eventMap[event]?.forEach((callback) => {
-      callback(arg)
-    })
-
-    this.eventMap['*']?.forEach((callback) => {
-      callback({ type: event, payload: arg })
-    })
-  }
-}
-
-export type Events = {
-  [key: string]: undefined
-}
-
-export const eventEmitter = new EventEmitter<Events>()