@botpress/webchat-client 0.3.0 → 0.4.0

package/src/client/client.ts

@@ -39,6 +39,10 @@ type Event =
       data: any
     }
 
+type EventMap = {
+  [E in Event as E['type']]: E['data']
+}
+
 const MAX_RETRIES = 10
 const RETRY_INTERVAL = 3000 // ms
 const TIMEOUT = '60000' // ms
@@ -60,13 +64,12 @@ export type Client = {
   getMessage: (params: MessageIdParam) => Promise<ClientTypes.GetMessageResponse>
   deleteMessage: (params: MessageIdParam) => Promise<ClientTypes.DeleteMessageResponse>
   createFile: (params: ClientTypes.CreateFileBody) => Promise<ClientTypes.CreateFileResponse>
-  createUser: (params: ClientTypes.CreateUserBody) => Promise<ClientTypes.CreateUserResponse>
   getUser: () => Promise<ClientTypes.GetUserResponse>
   updateUser: (params: ClientTypes.CreateUserBody) => Promise<ClientTypes.UpdateUserResponse>
   deleteUser: (params: UserIdParam) => Promise<ClientTypes.DeleteUserResponse>
   createEvent: (params: ClientTypes.CreateEventBody) => Promise<ClientTypes.CreateEventResponse>
   getEvent: (params: EventIdParam) => Promise<ClientTypes.GetEventResponse>
-  listenConversation: (params: ConversationIdParam) => EventEmitter<Record<Event['type'], Event['data']>>['on']
+  listenConversation: (params: ConversationIdParam) => EventEmitter<EventMap>['on']
   addMessageFeedback: (
     params: MessageIdParam & ClientTypes.AddMessageFeedbackBody
   ) => Promise<ClientTypes.AddMessageFeedbackResponse>
@@ -84,11 +87,14 @@ export const createUser = async ({
   clientId,
   apiUrl,
   adminSecret,
+  customHeaders,
+  ...body
 }: {
   clientId: string
   apiUrl?: string
   adminSecret?: string
-}) => {
+  customHeaders?: Record<string, string>
+} & ClientTypes.CreateUserBody) => {
   const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
 
   // @ts-expect-error - this is a private property
@@ -101,11 +107,16 @@ export const createUser = async ({
     baseUrl,
   }
 
+  const headers = {
+    ...(adminSecret ? { 'x-admin-secret': adminSecret } : {}),
+    ...customHeaders,
+  }
+
   return sdk
     .createUser({
       ...configs,
-      body: {},
-      headers: adminSecret ? { 'x-admin-secret': adminSecret } : undefined,
+      headers: Object.keys(headers).length > 0 ? headers : undefined,
+      body,
     })
     .then(extractData)
 }
@@ -115,15 +126,17 @@ export const initialize = ({
   userToken,
   clientId,
   apiUrl,
+  adminSecret,
 }: {
   conversationId?: string
   userToken?: string
   apiUrl?: string
   clientId: string
+  adminSecret?: string
 }) => {
   let retryCount = 0
   let eventSource: EventSource | null = null
-  const eventEmitter = createEventEmitter<Record<Event['type'], Event['data']>>()
+  const eventEmitter = createEventEmitter<EventMap>()
 
   const connect = () => {
     if (eventSource) {
@@ -133,7 +146,12 @@ export const initialize = ({
     const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
     const url = `${baseUrl}/initialize${conversationId ? `?conversationId=${conversationId}` : ''}`
 
-    eventSource = createNewEventSource(url, userToken ? { 'x-user-token': userToken } : {})
+    const headers = {
+      ...(adminSecret ? { 'x-admin-secret': adminSecret } : {}),
+      ...(userToken ? { 'x-user-key': userToken } : {}),
+    }
+
+    eventSource = createNewEventSource(url, headers)
 
     eventSource.onopen = () => eventEmitter.emit('open')
     eventSource.onerror = (err) => {
@@ -176,17 +194,34 @@ export const generateUserKey = async ({
   return sdk.generateUserKey({ ...configs, headers, body: { id: userId, expiresAt } }).then(extractData)
 }
 
+export const sendPerfMetrics = async (
+  clientId: string,
+  body: ClientTypes.SendPerfMetricsBody,
+  apiUrl?: string,
+  customHeaders?: Record<string, string>
+) => {
+  const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
+  const configs = {
+    ...baseConfigs,
+    baseUrl,
+  }
+  return sdk.sendPerfMetrics({ ...configs, body, headers: customHeaders }).then(extractData)
+}
+
 export const createClient = ({
   userKey,
   clientId,
   apiUrl,
+  customHeaders,
 }: {
   userKey: string
   clientId: string
   apiUrl?: string
+  customHeaders?: Record<string, string>
 }): Client => {
   const headers = {
     'x-user-key': userKey,
+    ...customHeaders,
   }
 
   const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
@@ -234,7 +269,6 @@ export const createClient = ({
     deleteMessage: ({ messageId }) =>
       sdk.deleteMessage({ ...configs, headers, path: { id: messageId } }).then(extractData),
     createFile: (body) => sdk.createFile({ ...configs, headers, body }).then(extractData),
-    createUser: (body) => sdk.createUser({ ...configs, headers, body }).then(extractData),
     getUser: () => sdk.getUser({ ...configs, headers }).then(extractData),
     updateUser: (body) => sdk.updateUser({ ...configs, headers, body }).then(extractData),
     deleteUser: () => sdk.deleteUser({ ...configs, headers }).then(extractData),
@@ -249,7 +283,7 @@ export const createClient = ({
     listenConversation: ({ conversationId }) => {
       let retryCount = 0
       let eventSource: EventSource | null = null
-      const eventEmitter = createEventEmitter<Record<Event['type'], Event['data']>>()
+      const eventEmitter = createEventEmitter<EventMap>()
 
       const connect = () => {
         if (eventSource) {

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

@@ -12,7 +12,7 @@ export type Initialize = {
     messages: ListConversationMessagesResponse['messages']
     participants: ListParticipantsResponse['participants']
     user: GetUserResponse['user'] & {
-      userKey?: string
+      userKey: string
     }
   }
 }

package/src/index.ts

@@ -2,6 +2,7 @@ export {
   createClient,
   createUser,
   generateUserKey,
+  sendPerfMetrics,
   initialize,
   type Client,
   type UserCredentials,

package/.eslintrc.cjs

@@ -1,11 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-  root: true,
-  extends: ["@repo/eslint-config/react-internal.js"],
-  parser: "@typescript-eslint/parser",
-  ignorePatterns: ["dist", "node_modules", "storybook-static", ".turbo", "turbo/*"],
-  parserOptions: {
-    project: "./tsconfig.json",
-    tsconfigRootDir: __dirname,
-  },
-};