@cimulate/copilot-sdk 3.11.0 → 3.13.0

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

@@ -2,6 +2,7 @@
  This not generated automatically by the generate model script.
  For any new event, manually create an entry here.
  */
+import { AskCimAck } from "./AskCimAck";
 import { CancelAck } from "./CancelAck";
 import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotBrowseAck } from "./CopilotBrowseAck";
@@ -9,5 +10,4 @@ import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
 import { ProductViewAck } from "./ProductViewAck";
-import { AskCimAck } from "./AskCimAck";
 export type CopilotAPIAck = AskCimAck | CancelAck | CopilotBrowseAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | ProductViewAck | CopilotError;

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

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { BrowseParams } from './BrowseParams';
 interface CopilotBrowse {
     browseParams: BrowseParams;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { CopilotBrowse };

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

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { SearchParams } from './SearchParams';
 interface CopilotSearch {
     searchParams: SearchParams;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { CopilotSearch };

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

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 interface ProductView {
     productId: string;
     pdpLink?: string;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { ProductView };

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

@@ -1,5 +1,6 @@
 export * from './AskCim';
 export * from './AskCimAck';
+export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
 export * from './CancelAck';

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.11.0",
+  "version": "3.13.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "files": [
     "dist/**",

package/src/model/AskCim.ts

@@ -1,5 +1,6 @@
-
+import { Attachments } from './Attachments';
 interface AskCim {
   userPrompt: string;
+  attachments?: Attachments;
 }
 export { AskCim };

package/src/model/Attachments.ts

@@ -0,0 +1,5 @@
+
+interface Attachments {
+  image?: string;
+}
+export { Attachments };

package/src/model/CopilotApiAck.ts

@@ -2,6 +2,7 @@
  This not generated automatically by the generate model script.
  For any new event, manually create an entry here.
  */
+import { AskCimAck } from "./AskCimAck";
 import { CancelAck } from "./CancelAck";
 import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotBrowseAck } from "./CopilotBrowseAck";
@@ -9,7 +10,6 @@ import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
 import { ProductViewAck } from "./ProductViewAck";
-import { AskCimAck } from "./AskCimAck";
 
 export type CopilotAPIAck =
   | AskCimAck

package/src/model/CopilotBrowse.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { BrowseParams } from './BrowseParams';
 interface CopilotBrowse {
   browseParams: BrowseParams;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { CopilotBrowse };

package/src/model/CopilotSearch.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { SearchParams } from './SearchParams';
 interface CopilotSearch {
   searchParams: SearchParams;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { CopilotSearch };

package/src/model/ProductView.ts

@@ -1,7 +1,8 @@
-
+import { Attachments } from './Attachments';
 interface ProductView {
   productId: string;
   pdpLink?: string;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { ProductView };

package/src/model/index.ts

@@ -1,5 +1,6 @@
 export * from './AskCim';
 export * from './AskCimAck';
+export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
 export * from './CancelAck';

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;
+    });
   }
 }