@cimulate/copilot-sdk 3.12.0 → 3.14.0

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

@@ -0,0 +1,5 @@
+import { BrowseParams } from './BrowseParams';
+interface CopilotBrowseSuggestions {
+    browseParams: BrowseParams;
+}
+export { CopilotBrowseSuggestions };

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

@@ -4,5 +4,6 @@ interface CopilotSearch {
     searchParams: SearchParams;
     userPrompt?: string;
     attachments?: Attachments;
+    clientContext?: Record<string, string | number>;
 }
 export { CopilotSearch };

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

@@ -0,0 +1,5 @@
+import { SearchParams } from './SearchParams';
+interface CopilotSearchSuggestions {
+    searchParams: SearchParams;
+}
+export { CopilotSearchSuggestions };

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

@@ -4,5 +4,6 @@ interface ProductView {
     pdpLink?: string;
     userPrompt?: string;
     attachments?: Attachments;
+    clientContext?: Record<string, string | number>;
 }
 export { ProductView };

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

@@ -0,0 +1,4 @@
+interface ProductViewSuggestions {
+    productId: string;
+}
+export { ProductViewSuggestions };

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

@@ -1,5 +1,6 @@
 export * from './AskCim';
 export * from './AskCimAck';
+export * from './AskCimSuggestions';
 export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
@@ -18,11 +19,13 @@ export * from './CopilotAPIEvent';
 export * from './CopilotBrowse';
 export * from './CopilotBrowseAck';
 export * from './CopilotBrowseSuggestion';
+export * from './CopilotBrowseSuggestions';
 export * from './CopilotError';
 export * from './CopilotEvent';
 export * from './CopilotSearch';
 export * from './CopilotSearchAck';
 export * from './CopilotSearchSuggestion';
+export * from './CopilotSearchSuggestions';
 export * from './customization';
 export * from './DisplayProducts';
 export * from './Done';
@@ -38,6 +41,7 @@ export * from './PartialInquiry';
 export * from './ProductView';
 export * from './ProductViewAck';
 export * from './ProductViewSuggestion';
+export * from './ProductViewSuggestions';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedBrowse';

package/examples/getConversations.ts

@@ -0,0 +1,58 @@
+import { CimulateCopilot } from "@cimulate/copilot-sdk";
+
+
+async function main() {
+    const sessionId = "EXISTING_SESSION_ID";
+    const customerId = "CustomerId";
+    const copilot = new CimulateCopilot({
+        apiKey: "API_KEY",
+        // Alternatively, a JWT token of the form `Bearer {token}` can be used for authentication.
+        // apiToken: "token123",
+        baseUrl: "https://qa.copilot.search.cimulate.ai",
+        // Optionally provide a session ID to reuse an existing session
+        socketOptions: {
+            auth: {
+                ["x-cimulate-copilot-session-id"]: sessionId
+            }
+        }
+    });
+
+    // Register handlers.
+    const connectAckHandler = copilot.on("connect_ack", function connectAck(event) {
+        console.log("Connect Ack: ", event);
+    });
+
+    const errorHandler = copilot.on("error", function errorEvent(event) {
+        console.error("Error received: ", event);
+    });
+
+    const connectErrorHandler = copilot.on("connect_error", function errorEvent(error) {
+        console.error("Error message received: ", error.message);
+    });
+
+    console.log("Establish a new connection");
+    // copilot.connect();
+    copilot.reconnect();
+    
+    const conversations = await copilot.getConversationEvents({
+        conversationId: `conversation:${customerId}:${sessionId}:0`
+    });
+    // console.log("Conversations: ", conversations);
+
+    console.log("Disconnect");
+    copilot.disconnect();
+
+    console.log("De-register handler");
+    copilot.off("connect_ack", connectAckHandler);
+    copilot.off("error", errorHandler);
+    copilot.off("connect_error", connectErrorHandler);
+
+    console.log("Refined Search and Display Products events: ");
+    // Iterate over the events and print the event name and the data
+    for (const event of conversations.filter((event) => event.name === "refined_search" || event.name === "display_products")) {
+        console.log(JSON.stringify(event, null, 2));
+    }
+
+}
+
+main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "3.12.0",
+  "version": "3.14.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "files": [
     "dist/**",
@@ -53,5 +53,8 @@
     "webpack": "^5.97.1",
     "webpack-cli": "^6.0.1",
     "webpack-node-externals": "^3.0.0"
+  },
+  "overrides": {
+    "brace-expansion": "~2.0.2"
   }
 }

package/src/model/AskCim.ts

@@ -2,5 +2,6 @@ import { Attachments } from './Attachments';
 interface AskCim {
   userPrompt: string;
   attachments?: Attachments;
+  clientContext?: Record<string, string | number>;
 }
 export { AskCim };

package/src/model/AskCimSuggestions.ts

@@ -0,0 +1,5 @@
+
+interface AskCimSuggestions {
+  
+}
+export { AskCimSuggestions };

package/src/model/CopilotBrowse.ts

@@ -4,5 +4,6 @@ interface CopilotBrowse {
   browseParams: BrowseParams;
   userPrompt?: string;
   attachments?: Attachments;
+  clientContext?: Record<string, string | number>;
 }
 export { CopilotBrowse };

package/src/model/CopilotBrowseSuggestions.ts

@@ -0,0 +1,5 @@
+import { BrowseParams } from './BrowseParams';
+interface CopilotBrowseSuggestions {
+  browseParams: BrowseParams;
+}
+export { CopilotBrowseSuggestions };

package/src/model/CopilotSearch.ts

@@ -4,5 +4,6 @@ interface CopilotSearch {
   searchParams: SearchParams;
   userPrompt?: string;
   attachments?: Attachments;
+  clientContext?: Record<string, string | number>;
 }
 export { CopilotSearch };

package/src/model/CopilotSearchSuggestions.ts

@@ -0,0 +1,5 @@
+import { SearchParams } from './SearchParams';
+interface CopilotSearchSuggestions {
+  searchParams: SearchParams;
+}
+export { CopilotSearchSuggestions };

package/src/model/ProductView.ts

@@ -4,5 +4,6 @@ interface ProductView {
   pdpLink?: string;
   userPrompt?: string;
   attachments?: Attachments;
+  clientContext?: Record<string, string | number>;
 }
 export { ProductView };

package/src/model/ProductViewSuggestions.ts

@@ -0,0 +1,5 @@
+
+interface ProductViewSuggestions {
+  productId: string;
+}
+export { ProductViewSuggestions };

package/src/model/index.ts

@@ -1,5 +1,6 @@
 export * from './AskCim';
 export * from './AskCimAck';
+export * from './AskCimSuggestions';
 export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
@@ -18,11 +19,13 @@ export * from './CopilotAPIEvent';
 export * from './CopilotBrowse';
 export * from './CopilotBrowseAck';
 export * from './CopilotBrowseSuggestion';
+export * from './CopilotBrowseSuggestions';
 export * from './CopilotError';
 export * from './CopilotEvent';
 export * from './CopilotSearch';
 export * from './CopilotSearchAck';
 export * from './CopilotSearchSuggestion';
+export * from './CopilotSearchSuggestions';
 export * from './customization';
 export * from './DisplayProducts';
 export * from './Done';
@@ -38,6 +41,7 @@ export * from './PartialInquiry';
 export * from './ProductView';
 export * from './ProductViewAck';
 export * from './ProductViewSuggestion';
+export * from './ProductViewSuggestions';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedBrowse';

package/src/parser.ts

@@ -18,13 +18,23 @@ class SnakeCaseEncoder extends Encoder {
 
 class SnakeCaseDecoder extends Decoder {
   constructor() {
-    super((key, value) =>
-      key == "" && Array.isArray(value)
-        ? value.map((value) =>
-            value instanceof Object ? decode(value) : value
-          )
-        : value
-    );
+    super((key, value) => {
+      // Handle top-level arrays (key == "" means root level)
+      if (key == "" && Array.isArray(value)) {
+        return value.map((item) => {
+          // If item is an array (nested array case like [[{...}]])
+          if (Array.isArray(item)) {
+            // Process each event in the inner array
+            return item.map((event) =>
+              event instanceof Object ? decode(event) : event
+            );
+          }
+          // If item is an object (single array case like [{...}])
+          return item instanceof Object ? decode(item) : item;
+        });
+      }
+      return value;
+    });
   }
 }