@botpress/webchat-client 0.2.0 → 0.3.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @botpress/webchat-client@0.2.0 build /home/runner/work/genisys/genisys/packages/webchat-client
+> @botpress/webchat-client@0.3.1 build /home/runner/work/genisys/genisys/packages/webchat-client
 > openapi-ts && vite build
 
 ⏳ Generating from raw OpenAPI specification
@@ -11,19 +11,19 @@ rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/webchat-client.js     0.17 kB │ gzip: 0.13 kB
 dist/webchat-client8.js    0.19 kB │ gzip: 0.16 kB
+dist/webchat-client.js     0.25 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.31 kB
+dist/webchat-client3.js    3.50 kB │ gzip: 0.60 kB
+dist/webchat-client2.js    5.66 kB │ gzip: 1.60 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 5323ms.
+[vite:dts] Declaration files built in 4664ms.
 
-✓ built in 5.65s
+✓ built in 4.95s

package/dist/index.d.ts

@@ -186,17 +186,16 @@ export declare type Client = {
     getMessage: (params: MessageIdParam) => Promise<ClientTypes_2.GetMessageResponse>;
     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: () => 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'];
+    listenConversation: (params: ConversationIdParam) => EventEmitter<EventMap>['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;
+        adminSecret: string;
     }) => Promise<ClientTypes_2.GenerateUserKeyResponse>;
 };
 
@@ -220,6 +219,7 @@ declare namespace ClientTypes_2 {
         Message,
         Event_2 as Event,
         File_2 as File,
+        Perf,
         CreateConversationBody,
         AddParticipantBody,
         CreateMessageBody,
@@ -231,6 +231,7 @@ declare namespace ClientTypes_2 {
         UpdateUserBody,
         CreateEventBody,
         CreateFileBody,
+        SendPerfMetricsBody,
         DeleteConversationData,
         DeleteConversationErrors,
         DeleteConversationError,
@@ -356,6 +357,16 @@ declare namespace ClientTypes_2 {
         CreateFileError,
         CreateFileResponses,
         CreateFileResponse,
+        InitializeConversationData,
+        InitializeConversationErrors,
+        InitializeConversationError,
+        InitializeConversationResponses,
+        InitializeConversationResponse,
+        SendPerfMetricsData,
+        SendPerfMetricsErrors,
+        SendPerfMetricsError,
+        SendPerfMetricsResponses,
+        SendPerfMetricsResponse,
         ClientOptions,
         Options,
         deleteConversation,
@@ -382,7 +393,9 @@ declare namespace ClientTypes_2 {
         generateUserKey_2 as generateUserKey,
         getEvent,
         createEvent,
-        createFile
+        createFile,
+        initializeConversation,
+        sendPerfMetrics_2 as sendPerfMetrics
     }
 }
 
@@ -489,10 +502,11 @@ declare type ConversationIdParam = {
     conversationId: string;
 };
 
-export declare const createClient: ({ userKey, clientId, apiUrl, }: {
+export declare const createClient: ({ userKey, clientId, apiUrl, customHeaders, }: {
     userKey: string;
     clientId: string;
     apiUrl?: string;
+    customHeaders?: Record<string, string>;
 }) => Client;
 
 /**
@@ -888,11 +902,12 @@ export declare type CreateMessageResponses = {
     };
 };
 
-export declare const createUser: ({ clientId, apiUrl, adminKey, }: {
+export declare const createUser: ({ clientId, apiUrl, adminSecret, customHeaders, ...body }: {
     clientId: string;
     apiUrl?: string;
-    adminKey?: string;
-}) => Promise<{
+    adminSecret?: string;
+    customHeaders?: Record<string, string>;
+} & ClientTypes_2.CreateUserBody) => Promise<{
     user: ClientTypes_2.User;
     key: string;
 }>;
@@ -935,7 +950,7 @@ export declare type CreateUserData = {
         /**
          * Admin Key for managing users
          */
-        'x-admin-key'?: string;
+        'x-admin-secret'?: string;
     };
     path?: never;
     query?: never;
@@ -1166,6 +1181,10 @@ declare type EventIdParam = {
     eventId: string;
 };
 
+declare type EventMap = {
+    [E in Event_3 as E['type']]: E['data'];
+};
+
 declare type File_2 = {
     id: string;
     botId: string;
@@ -1186,8 +1205,8 @@ declare type File_2 = {
 };
 export { File_2 as File }
 
-export declare const generateUserKey: ({ adminKey, expiresAt, userId, apiUrl, clientId, }: {
-    adminKey: string;
+export declare const generateUserKey: ({ adminSecret, expiresAt, userId, apiUrl, clientId, }: {
+    adminSecret: string;
     expiresAt: number;
     userId: string;
     apiUrl?: string;
@@ -1228,7 +1247,7 @@ export declare type GenerateUserKeyData = {
         /**
          * Admin Key for managing users
          */
-        'x-admin-key'?: string;
+        'x-admin-secret'?: string;
     };
     path?: never;
     query?: never;
@@ -1501,6 +1520,79 @@ export declare type GetUserResponses = {
     };
 };
 
+declare type Initialize = {
+    type: 'init';
+    data: {
+        conversation: GetConversationResponse['conversation'];
+        messages: ListConversationMessagesResponse['messages'];
+        participants: ListParticipantsResponse['participants'];
+        user: GetUserResponse['user'] & {
+            userKey: string;
+        };
+    };
+};
+
+export declare const initialize: ({ conversationId, userToken, clientId, apiUrl, adminSecret, }: {
+    conversationId?: string;
+    userToken?: string;
+    apiUrl?: string;
+    clientId: string;
+    adminSecret?: string;
+}) => <U extends "custom" | "error" | "message_created" | "message_updated" | "typing_started" | "typing_stopped" | "webchat_config" | "webchat_visibility" | "participant_added" | "participant_removed" | "message_status_changed" | "init" | "open">(event: U, callback: (args: EventMap[U]) => void) => () => void;
+
+/**
+ * Creates a SSE stream to receive messages and events. The first event will be a payload containing the conversation details.
+ */
+declare const initializeConversation: <ThrowOnError extends boolean = false>(options?: Options<InitializeConversationData, ThrowOnError>) => RequestResult<{
+    [key: string]: never;
+}, {
+    [key: string]: never;
+}, ThrowOnError>;
+
+export declare type InitializeConversationData = {
+    body?: never;
+    headers?: {
+        /**
+         * Authentication Key
+         */
+        'x-user-key'?: string;
+    };
+    path?: never;
+    query?: {
+        /**
+         * User id (if not provided with a user key a new user will be created)
+         */
+        userId?: string;
+        /**
+         * Conversation id
+         */
+        conversationId?: string;
+    };
+    url: '/initialize';
+};
+
+export declare type InitializeConversationError = InitializeConversationErrors[keyof InitializeConversationErrors];
+
+export declare type InitializeConversationErrors = {
+    /**
+     * Returns nothing but a stream
+     */
+    default: {
+        [key: string]: never;
+    };
+};
+
+export declare type InitializeConversationResponse = InitializeConversationResponses[keyof InitializeConversationResponses];
+
+export declare type InitializeConversationResponses = {
+    /**
+     * Returns nothing but a stream
+     */
+    200: {
+        [key: string]: never;
+    };
+};
+
 export declare type IntegrationError = {
     id: string;
     code: number;
@@ -2611,6 +2703,12 @@ declare type ParticipantRemoved = {
     };
 };
 
+export declare type Perf = {
+    duration: number;
+    event: string;
+    properties: {};
+};
+
 declare type QuerySerializer = (query: Record<string, unknown>) => string;
 
 declare interface QuerySerializerOptions {
@@ -2819,6 +2917,60 @@ export declare type SelectMessageResponses = {
     };
 };
 
+export declare const sendPerfMetrics: (clientId: string, body: ClientTypes_2.SendPerfMetricsBody, apiUrl?: string, customHeaders?: Record<string, string>) => Promise<{
+    [key: string]: never;
+}>;
+
+/**
+ * Sends performance metrics to the server.
+ */
+declare const sendPerfMetrics_2: <ThrowOnError extends boolean = false>(options?: Options<SendPerfMetricsData, ThrowOnError>) => RequestResult<{
+    [key: string]: never;
+}, {
+    [key: string]: never;
+}, ThrowOnError>;
+
+/**
+ * Performance metrics
+ */
+export declare type SendPerfMetricsBody = {
+    duration: number;
+    event: string;
+    properties: {};
+};
+
+export declare type SendPerfMetricsData = {
+    /**
+     * Performance metrics
+     */
+    body?: SendPerfMetricsBody;
+    path?: never;
+    query?: never;
+    url: '/p';
+};
+
+export declare type SendPerfMetricsError = SendPerfMetricsErrors[keyof SendPerfMetricsErrors];
+
+export declare type SendPerfMetricsErrors = {
+    /**
+     * Returns nothing
+     */
+    default: {
+        [key: string]: never;
+    };
+};
+
+export declare type SendPerfMetricsResponse = SendPerfMetricsResponses[keyof SendPerfMetricsResponses];
+
+export declare type SendPerfMetricsResponses = {
+    /**
+     * Returns nothing
+     */
+    200: {
+        [key: string]: never;
+    };
+};
+
 declare interface SerializerOptions<T> {
     /**
      * @default true
@@ -2827,7 +2979,7 @@ declare interface SerializerOptions<T> {
     style: T;
 }
 
-declare type Signal = MessageCreated | MessageUpdated | WebchatVisibility | WebchatConfig | Custom | TypingStarted | TypingStopped | ParticipantAdded | ParticipantRemoved | MessageStatusChanged;
+declare type Signal = MessageCreated | MessageUpdated | WebchatVisibility | WebchatConfig | Custom | TypingStarted | TypingStopped | ParticipantAdded | ParticipantRemoved | MessageStatusChanged | Initialize;
 
 declare interface TDataShape {
     body?: unknown;

package/dist/webchat-client.js

@@ -1,6 +1,8 @@
-import { createClient as t, createUser as a, generateUserKey as c } from "./webchat-client2.js";
+import { createClient as t, createUser as i, generateUserKey as a, initialize as n, sendPerfMetrics as s } from "./webchat-client2.js";
 export {
   t as createClient,
-  a as createUser,
-  c as generateUserKey
+  i as createUser,
+  a as generateUserKey,
+  n as initialize,
+  s as sendPerfMetrics
 };

package/dist/webchat-client2.js

@@ -1,111 +1,147 @@
-import { createUser as U, generateUserKey as y, removeMessageFeedback as M, addMessageFeedback as b, getEvent as $, createEvent as R, deleteUser as P, updateUser as k, getUser as T, createFile as _, deleteMessage as x, getMessage as F, updateMessage as I, createMessage as S, listParticipants as A, getParticipant as q, removeParticipant as w, addParticipant as K, listConversationMessages as N, listConversations as J, deleteConversation as L, getConversation as O, createConversation as V } from "./webchat-client3.js";
-import { client as i } from "./webchat-client4.js";
-import { EventSource as X } from "./webchat-client5.js";
-import { throwErrorInterceptor as E } from "./webchat-client6.js";
-import { createEventEmitter as Y } from "./webchat-client7.js";
-const n = (a) => a.data, v = {
+import { createUser as x, generateUserKey as y, sendPerfMetrics as k, removeMessageFeedback as F, addMessageFeedback as T, getEvent as R, createEvent as w, deleteUser as I, updateUser as K, getUser as O, createFile as S, deleteMessage as _, getMessage as q, updateMessage as N, createMessage as z, listParticipants as A, getParticipant as J, removeParticipant as j, addParticipant as D, listConversationMessages as L, listConversations as V, deleteConversation as X, getConversation as Y, createConversation as B } from "./webchat-client3.js";
+import { client as l } from "./webchat-client4.js";
+import { EventSource as G } from "./webchat-client5.js";
+import { throwErrorInterceptor as b } from "./webchat-client6.js";
+import { createEventEmitter as C } from "./webchat-client7.js";
+const n = (a) => a.data, $ = 10, M = 3e3, H = "60000", v = {
   throwOnError: !0
-}, W = async ({
+}, se = async ({
   clientId: a,
-  apiUrl: p,
-  adminKey: c
+  apiUrl: c,
+  adminSecret: i,
+  customHeaders: o,
+  ...s
 }) => {
-  const t = `${p || i.getConfig().baseUrl}/${a}`;
-  i.interceptors.response._fns.length === 0 && i.interceptors.response.use(E);
-  const d = {
+  const d = `${c || l.getConfig().baseUrl}/${a}`;
+  l.interceptors.response._fns.length === 0 && l.interceptors.response.use(b);
+  const t = {
     ...v,
-    baseUrl: t
+    baseUrl: d
+  }, h = {
+    ...i ? { "x-admin-secret": i } : {},
+    ...o
   };
-  return U({
-    ...d,
-    body: {},
-    headers: c ? { "x-admin-key": c } : void 0
+  return x({
+    ...t,
+    headers: Object.keys(h).length > 0 ? h : void 0,
+    body: s
   }).then(n);
-}, Z = async ({
-  adminKey: a,
-  expiresAt: p,
-  userId: c,
-  apiUrl: t,
-  clientId: d
+}, ne = ({
+  conversationId: a,
+  userToken: c,
+  clientId: i,
+  apiUrl: o,
+  adminSecret: s
 }) => {
-  const s = { "x-admin-key": a }, m = `${t || i.getConfig().baseUrl}/${d}`, e = {
+  let d = 0, t = null;
+  const h = C(), e = () => {
+    t && t.close();
+    const g = `${`${o || l.getConfig().baseUrl}/${i}`}/initialize${a ? `?conversationId=${a}` : ""}`, p = {
+      ...s ? { "x-admin-secret": s } : {},
+      ...c ? { "x-user-key": c } : {}
+    };
+    t = P(g, p), t.onopen = () => h.emit("open"), t.onerror = (u) => {
+      d < $ ? (d++, setTimeout(() => e(), M)) : h.emit("error", u);
+    }, t.onmessage = (u) => {
+      const m = E(u.data);
+      h.emit(m.type, m.data);
+    };
+  };
+  return e(), h.on;
+}, re = async ({
+  adminSecret: a,
+  expiresAt: c,
+  userId: i,
+  apiUrl: o,
+  clientId: s
+}) => {
+  const d = { "x-admin-secret": a }, t = `${o || l.getConfig().baseUrl}/${s}`, h = {
     ...v,
-    baseUrl: m
+    baseUrl: t
   };
-  return y({ ...e, headers: s, body: { id: c, expiresAt: p } }).then(n);
-}, ee = ({
+  return y({ ...h, headers: d, body: { id: i, expiresAt: c } }).then(n);
+}, ae = async (a, c, i, o) => {
+  const s = `${i || l.getConfig().baseUrl}/${a}`, d = {
+    ...v,
+    baseUrl: s
+  };
+  return k({ ...d, body: c, headers: o }).then(n);
+}, oe = ({
   userKey: a,
-  clientId: p,
-  apiUrl: c
+  clientId: c,
+  apiUrl: i,
+  customHeaders: o
 }) => {
-  const t = {
-    "x-user-key": a
-  }, d = `${c || i.getConfig().baseUrl}/${p}`, s = {
+  const s = {
+    "x-user-key": a,
+    ...o
+  }, d = `${i || l.getConfig().baseUrl}/${c}`, t = {
     ...v,
     baseUrl: d
   };
-  return i.interceptors.response._fns.length === 0 && i.interceptors.response.use(E), {
-    createConversation: () => V({ ...s, headers: t, body: {} }).then(n),
-    getConversation: ({ conversationId: e }) => O({ ...s, headers: t, path: { id: e } }).then(n),
-    deleteConversation: ({ conversationId: e }) => L({ ...s, headers: t, path: { id: e } }).then(n),
-    listConversations: ({ nextToken: e }) => J({ ...s, headers: t, query: { nextToken: e } }).then(n),
-    listConversationMessages: ({ conversationId: e, nextToken: r }) => N({
-      ...s,
-      headers: t,
+  return l.interceptors.response._fns.length === 0 && l.interceptors.response.use(b), {
+    createConversation: () => B({ ...t, headers: s, body: {} }).then(n),
+    getConversation: ({ conversationId: e }) => Y({ ...t, headers: s, path: { id: e } }).then(n),
+    deleteConversation: ({ conversationId: e }) => X({ ...t, headers: s, path: { id: e } }).then(n),
+    listConversations: ({ nextToken: e }) => V({ ...t, headers: s, query: { nextToken: e } }).then(n),
+    listConversationMessages: ({ conversationId: e, nextToken: r }) => L({
+      ...t,
+      headers: s,
       path: { id: e },
       query: { nextToken: r }
     }).then(n),
-    addParticipant: ({ conversationId: e, userId: r }) => K({ ...s, headers: t, path: { id: e }, body: { userId: r } }).then(n),
-    removeParticipant: ({ conversationId: e, userId: r }) => w({ ...s, headers: t, path: { id: e, userId: r } }).then(n),
-    getParticipant: ({ conversationId: e, userId: r }) => q({ ...s, headers: t, path: { id: e, userId: r } }).then(n),
-    listParticipants: ({ conversationId: e, nextToken: r }) => A({ ...s, headers: t, path: { id: e }, query: { nextToken: r } }).then(n),
-    createMessage: (e) => S({ ...s, headers: t, body: e }).then(n),
-    updateMessage: ({ messageId: e, ...r }) => I({ ...s, headers: t, path: { id: e }, body: r }).then(n),
-    getMessage: ({ messageId: e }) => F({ ...s, headers: t, path: { id: e } }).then(n),
-    deleteMessage: ({ messageId: e }) => x({ ...s, headers: t, path: { id: e } }).then(n),
-    createFile: (e) => _({ ...s, headers: t, body: e }).then(n),
-    createUser: (e) => U({ ...s, headers: t, body: e }).then(n),
-    getUser: () => T({ ...s, headers: t }).then(n),
-    updateUser: (e) => k({ ...s, headers: t, body: e }).then(n),
-    deleteUser: () => P({ ...s, headers: t }).then(n),
-    createEvent: (e) => R({ ...s, headers: t, body: e }).then(n),
-    getEvent: ({ eventId: e }) => $({ ...s, headers: t, path: { id: e } }).then(n),
-    addMessageFeedback: ({ messageId: e, ...r }) => b({ ...s, headers: t, path: { id: e }, body: r }).then(n),
-    removeMessageFeedback: ({ messageId: e }) => M({ ...s, headers: t, path: { id: e } }).then(n),
-    generateUserKey: ({ adminKey: e, ...r }) => y({ ...s, headers: { "x-admin-key": e }, body: r }).then(n),
+    addParticipant: ({ conversationId: e, userId: r }) => D({ ...t, headers: s, path: { id: e }, body: { userId: r } }).then(n),
+    removeParticipant: ({ conversationId: e, userId: r }) => j({ ...t, headers: s, path: { id: e, userId: r } }).then(n),
+    getParticipant: ({ conversationId: e, userId: r }) => J({ ...t, headers: s, path: { id: e, userId: r } }).then(n),
+    listParticipants: ({ conversationId: e, nextToken: r }) => A({ ...t, headers: s, path: { id: e }, query: { nextToken: r } }).then(n),
+    createMessage: (e) => z({ ...t, headers: s, body: e }).then(n),
+    updateMessage: ({ messageId: e, ...r }) => N({ ...t, headers: s, path: { id: e }, body: r }).then(n),
+    getMessage: ({ messageId: e }) => q({ ...t, headers: s, path: { id: e } }).then(n),
+    deleteMessage: ({ messageId: e }) => _({ ...t, headers: s, path: { id: e } }).then(n),
+    createFile: (e) => S({ ...t, headers: s, body: e }).then(n),
+    getUser: () => O({ ...t, headers: s }).then(n),
+    updateUser: (e) => K({ ...t, headers: s, body: e }).then(n),
+    deleteUser: () => I({ ...t, headers: s }).then(n),
+    createEvent: (e) => w({ ...t, headers: s, body: e }).then(n),
+    getEvent: ({ eventId: e }) => R({ ...t, headers: s, path: { id: e } }).then(n),
+    addMessageFeedback: ({ messageId: e, ...r }) => T({ ...t, headers: s, path: { id: e }, body: r }).then(n),
+    removeMessageFeedback: ({ messageId: e }) => F({ ...t, headers: s, path: { id: e } }).then(n),
+    generateUserKey: ({ adminSecret: e, ...r }) => y({ ...t, headers: { "x-admin-secret": e }, body: r }).then(n),
     listenConversation: ({ conversationId: e }) => {
-      let u = 0, h = null;
-      const l = Y(), f = () => {
-        h && h.close();
-        const C = `${d}/conversations/${e}/listen`;
-        h = new X(C, {
-          fetch: (g, o) => fetch(g, {
-            ...o,
-            headers: {
-              ...o == null ? void 0 : o.headers,
-              ...t,
-              timeout: "60_000"
-            }
-          })
-        }), h.onopen = () => l.emit("open"), h.onerror = (g) => {
-          u < 10 ? (u++, setTimeout(() => f(), 3e3)) : l.emit("error", g);
-        }, h.onmessage = (g) => {
-          const o = D(g.data);
-          l.emit(o.type, o.data);
+      let r = 0, g = null;
+      const p = C(), u = () => {
+        g && g.close();
+        const m = `${d}/conversations/${e}/listen`;
+        g = P(m, s), g.onopen = () => p.emit("open"), g.onerror = (f) => {
+          r < $ ? (r++, setTimeout(() => u(), M)) : p.emit("error", f);
+        }, g.onmessage = (f) => {
+          const U = E(f.data);
+          p.emit(U.type, U.data);
         };
       };
-      return f(), l.on;
+      return u(), p.on;
     }
   };
-}, D = (a) => {
+}, E = (a) => {
   try {
     return JSON.parse(a);
   } catch {
     return a;
   }
-};
+}, P = (a, c) => new G(a, {
+  fetch: (i, o) => fetch(i, {
+    ...o,
+    headers: {
+      ...o == null ? void 0 : o.headers,
+      ...c,
+      timeout: H
+    }
+  })
+});
 export {
-  ee as createClient,
-  W as createUser,
-  Z as generateUserKey
+  oe as createClient,
+  se as createUser,
+  re as generateUserKey,
+  ne as initialize,
+  ae as sendPerfMetrics
 };

package/dist/webchat-client3.js

@@ -47,54 +47,54 @@ const t = (e) => (e.client ?? r).delete({
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), i = (e) => (e.client ?? r).post({
+}), y = (e) => (e.client ?? r).post({
   url: "/messages",
   ...e,
   headers: {
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), y = (e) => (e.client ?? r).delete({
+}), j = (e) => (e.client ?? r).delete({
   url: "/messages/{id}/feedback",
   ...e
-}), j = (e) => (e.client ?? r).put({
+}), T = (e) => (e.client ?? r).put({
   url: "/messages/{id}/feedback",
   ...e,
   headers: {
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), T = (e) => (e.client ?? r).delete({
+}), M = (e) => (e.client ?? r).delete({
   url: "/users/me",
   ...e
-}), M = (e) => (e.client ?? r).get({
+}), i = (e) => (e.client ?? r).get({
   url: "/users/me",
   ...e
-}), k = (e) => (e.client ?? r).put({
+}), f = (e) => (e.client ?? r).put({
   url: "/users/me",
   ...e,
   headers: {
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), U = (e) => ((e == null ? void 0 : e.client) ?? r).post({
+}), k = (e) => ((e == null ? void 0 : e.client) ?? r).post({
   url: "/users",
   ...e,
   headers: {
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), b = (e) => ((e == null ? void 0 : e.client) ?? r).post({
+}), P = (e) => ((e == null ? void 0 : e.client) ?? r).post({
   url: "/users/key",
   ...e,
   headers: {
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
-}), f = (e) => (e.client ?? r).get({
+}), U = (e) => (e.client ?? r).get({
   url: "/events/{id}",
   ...e
-}), P = (e) => (e.client ?? r).post({
+}), b = (e) => (e.client ?? r).post({
   url: "/events",
   ...e,
   headers: {
@@ -108,29 +108,37 @@ const t = (e) => (e.client ?? r).delete({
     "Content-Type": "application/json",
     ...e == null ? void 0 : e.headers
   }
+}), E = (e) => ((e == null ? void 0 : e.client) ?? r).post({
+  url: "/p",
+  ...e,
+  headers: {
+    "Content-Type": "application/json",
+    ...e == null ? void 0 : e.headers
+  }
 });
 export {
-  j as addMessageFeedback,
+  T as addMessageFeedback,
   d as addParticipant,
   n as createConversation,
-  P as createEvent,
+  b as createEvent,
   F as createFile,
-  i as createMessage,
-  U as createUser,
+  y as createMessage,
+  k as createUser,
   t as deleteConversation,
   v as deleteMessage,
-  T as deleteUser,
-  b as generateUserKey,
+  M as deleteUser,
+  P as generateUserKey,
   c as getConversation,
-  f as getEvent,
+  U as getEvent,
   C as getMessage,
   h as getParticipant,
-  M as getUser,
+  i as getUser,
   s as listConversationMessages,
   l as listConversations,
   u as listParticipants,
-  y as removeMessageFeedback,
+  j as removeMessageFeedback,
   g as removeParticipant,
+  E as sendPerfMetrics,
   m as updateMessage,
-  k as updateUser
+  f as updateUser
 };

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@botpress/webchat-client",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "",
   "main": "src/index.ts",
   "type": "module",
   "sideEffects": false,
+  "repository": {
+    "url": "https://github.com/botpress/genisys"
+  },
   "scripts": {
     "build": "openapi-ts && vite build",
     "check:lint": "eslint .",
     "fix:lint": "eslint --fix .",
-    "check:type": "tsc --noEmit"
+    "check:type": "openapi-ts && tsc --noEmit"
   },
   "types": "./dist/index.d.ts",
   "module": "./dist/webchat-client.js",
@@ -26,7 +29,7 @@
     "eventsource": "^3.0.6"
   },
   "devDependencies": {
-    "@bpinternal/webchat-http-client": "0.4.1",
+    "@bpinternal/webchat-http-client": "0.6.0",
     "@hey-api/client-fetch": "^0.10.0",
     "@hey-api/openapi-ts": "^0.66.4",
     "@repo/eslint-config": "workspace:*",

package/src/client/client.ts

@@ -39,6 +39,14 @@ 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
+
 export type Client = {
   createConversation: () => Promise<ClientTypes.CreateConversationResponse>
   getConversation: (params: ConversationIdParam) => Promise<ClientTypes.GetConversationResponse>
@@ -56,19 +64,18 @@ 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>
   removeMessageFeedback: (params: MessageIdParam) => Promise<ClientTypes.RemoveMessageFeedbackResponse>
   generateUserKey: (
-    params: ClientTypes.GenerateUserKeyBody & { adminKey: string }
+    params: ClientTypes.GenerateUserKeyBody & { adminSecret: string }
   ) => Promise<ClientTypes.GenerateUserKeyResponse>
 }
 
@@ -79,12 +86,15 @@ const baseConfigs = {
 export const createUser = async ({
   clientId,
   apiUrl,
-  adminKey,
+  adminSecret,
+  customHeaders,
+  ...body
 }: {
   clientId: string
   apiUrl?: string
-  adminKey?: string
-}) => {
+  adminSecret?: string
+  customHeaders?: Record<string, string>
+} & ClientTypes.CreateUserBody) => {
   const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
 
   // @ts-expect-error - this is a private property
@@ -97,29 +107,84 @@ export const createUser = async ({
     baseUrl,
   }
 
+  const headers = {
+    ...(adminSecret ? { 'x-admin-secret': adminSecret } : {}),
+    ...customHeaders,
+  }
+
   return sdk
     .createUser({
       ...configs,
-      body: {},
-      headers: adminKey ? { 'x-admin-key': adminKey } : undefined,
+      headers: Object.keys(headers).length > 0 ? headers : undefined,
+      body,
     })
     .then(extractData)
 }
 
+export const initialize = ({
+  conversationId,
+  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<EventMap>()
+
+  const connect = () => {
+    if (eventSource) {
+      eventSource.close()
+    }
+
+    const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
+    const url = `${baseUrl}/initialize${conversationId ? `?conversationId=${conversationId}` : ''}`
+
+    const headers = {
+      ...(adminSecret ? { 'x-admin-secret': adminSecret } : {}),
+      ...(userToken ? { 'x-user-key': userToken } : {}),
+    }
+
+    eventSource = createNewEventSource(url, headers)
+
+    eventSource.onopen = () => eventEmitter.emit('open')
+    eventSource.onerror = (err) => {
+      if (retryCount < MAX_RETRIES) {
+        retryCount++
+        setTimeout(() => connect(), RETRY_INTERVAL)
+      } else {
+        eventEmitter.emit('error', err)
+      }
+    }
+    eventSource.onmessage = (ev) => {
+      const event = safeJsonParse(ev.data) as Signal
+      eventEmitter.emit(event.type, event.data)
+    }
+  }
+  connect()
+  return eventEmitter.on
+}
+
 export const generateUserKey = async ({
-  adminKey,
+  adminSecret,
   expiresAt,
   userId,
   apiUrl,
   clientId,
 }: {
-  adminKey: string
+  adminSecret: string
   expiresAt: number
   userId: string
   apiUrl?: string
   clientId: string
 }) => {
-  const headers = { 'x-admin-key': adminKey }
+  const headers = { 'x-admin-secret': adminSecret }
 
   const baseUrl = `${apiUrl || baseClient.getConfig().baseUrl}/${clientId}`
   const configs = {
@@ -129,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}`
@@ -187,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),
@@ -197,14 +278,12 @@ export const createClient = ({
       sdk.addMessageFeedback({ ...configs, headers, path: { id: messageId }, body }).then(extractData),
     removeMessageFeedback: ({ messageId }) =>
       sdk.removeMessageFeedback({ ...configs, headers, path: { id: messageId } }).then(extractData),
-    generateUserKey: ({ adminKey, ...body }) =>
-      sdk.generateUserKey({ ...configs, headers: { 'x-admin-key': adminKey }, body }).then(extractData),
+    generateUserKey: ({ adminSecret, ...body }) =>
+      sdk.generateUserKey({ ...configs, headers: { 'x-admin-secret': adminSecret }, body }).then(extractData),
     listenConversation: ({ conversationId }) => {
-      const MAX_RETRIES = 10
-      const RETRY_INTERVAL = 3000 // ms
       let retryCount = 0
       let eventSource: EventSource | null = null
-      const eventEmitter = createEventEmitter<Record<Event['type'], Event['data']>>()
+      const eventEmitter = createEventEmitter<EventMap>()
 
       const connect = () => {
         if (eventSource) {
@@ -213,17 +292,7 @@ export const createClient = ({
 
         const url = `${baseUrl}/conversations/${conversationId}/listen`
 
-        eventSource = new EventSource(url, {
-          fetch: (input, init) =>
-            fetch(input, {
-              ...init,
-              headers: {
-                ...init?.headers,
-                ...headers,
-                timeout: '60_000',
-              },
-            }),
-        })
+        eventSource = createNewEventSource(url, headers)
 
         eventSource.onopen = () => eventEmitter.emit('open')
         eventSource.onerror = (err) => {
@@ -254,3 +323,17 @@ const safeJsonParse = (data: any) => {
     return data
   }
 }
+
+const createNewEventSource = (url: string, headers: Record<string, string>) => {
+  return new EventSource(url, {
+    fetch: (input, init) =>
+      fetch(input, {
+        ...init,
+        headers: {
+          ...init?.headers,
+          ...headers,
+          timeout: TIMEOUT,
+        },
+      }),
+  })
+}

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

@@ -8,6 +8,7 @@ import type { WebchatVisibility } from './webchatVisibility'
 import type { ParticipantAdded } from './participantAdded'
 import type { ParticipantRemoved } from './participantRemoved'
 import type { MessageStatusChanged } from './messageStatusChanged'
+import type { Initialize } from './initialize'
 
 export type Signal =
   | MessageCreated
@@ -20,3 +21,4 @@ export type Signal =
   | ParticipantAdded
   | ParticipantRemoved
   | MessageStatusChanged
+  | Initialize

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

@@ -0,0 +1,18 @@
+import type {
+  GetConversationResponse,
+  GetUserResponse,
+  ListConversationMessagesResponse,
+  ListParticipantsResponse,
+} from '../../../gen/client'
+
+export type Initialize = {
+  type: 'init'
+  data: {
+    conversation: GetConversationResponse['conversation']
+    messages: ListConversationMessagesResponse['messages']
+    participants: ListParticipantsResponse['participants']
+    user: GetUserResponse['user'] & {
+      userKey: string
+    }
+  }
+}

package/src/index.ts

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