@cimulate/copilot-sdk 3.8.0 → 3.9.0

package/dist/types/model/ConversationEvents.d.ts

@@ -0,0 +1,8 @@
+interface ConversationEvents {
+    conversationId: string;
+    limit?: number;
+    since?: string;
+    includeEvents?: string[];
+    excludeEvents?: string[];
+}
+export { ConversationEvents };

package/dist/types/model/index.d.ts

@@ -7,6 +7,7 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
+export * from './ConversationEvents';
 export * from './ConversationReset';
 export * from './ConversationResetAck';
 export * from './CopilotApiAck';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "files": [
     "dist/**",

package/src/copilot.ts

@@ -9,7 +9,9 @@ import type {
   CopilotBrowse,
   CopilotBrowseAck,
   ConnectError,
+  ConversationEvents,
   CopilotAPIEvent,
+  CopilotEvent,
   CopilotEventName,
   CopilotSearch,
   CopilotSearchAck,
@@ -38,6 +40,7 @@ interface CommonOptions {
 }
 
 type CimulateCopilotOptions = (ApiKeyAuth | ApiTokenAuth) & CommonOptions;
+type CopilotEvents = CopilotEvent[]
 
 const socketDefaults: SocketIOOptions = {
   path: "/api/v1/socket.io",
@@ -328,6 +331,26 @@ export default class CimulateCopilot<
     });
   }
 
+  async getConversationEvents(
+    args: ConversationEvents
+  ): Promise<CopilotEvents>;
+  async getConversationEvents(
+    args: ConversationEvents,
+    callback?: (events: CopilotEvents) => void
+  ): Promise<void>;
+  async getConversationEvents(
+    args: ConversationEvents,
+    callback?: (events: CopilotEvents) => void
+  ): Promise<CopilotEvents | void> {
+    return new Promise((resolve) => {
+      this.socket.emit("conversation_events", args, (response: CopilotEvents) => {
+        if (callback) callback(response);
+        // TODO - error handling
+        resolve(response as CopilotEvents);
+      });
+    });
+  }
+
   on<E extends CopilotEventName>(
     name: E,
     handler: (event: Extract<CopilotAPIEvent<T>, { name: E }>) => void

package/src/model/ConversationEvents.ts

@@ -0,0 +1,9 @@
+
+interface ConversationEvents {
+  conversationId: string;
+  limit?: number;
+  since?: string;
+  includeEvents?: string[];
+  excludeEvents?: string[];
+}
+export { ConversationEvents };

package/src/model/index.ts

@@ -7,6 +7,7 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
+export * from './ConversationEvents';
 export * from './ConversationReset';
 export * from './ConversationResetAck';
 export * from './CopilotApiAck';