@cimulate/copilot-sdk 3.4.0 → 3.6.0

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

@@ -0,0 +1,10 @@
+import { ConversationReset } from './ConversationReset';
+interface ConversationResetAck {
+    name: 'conversation_reset';
+    request: ConversationReset;
+    sessionId: string;
+    id: string;
+    createdAt: string;
+    status: number;
+}
+export { ConversationResetAck };

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

@@ -6,4 +6,5 @@ import { CancelAck } from "./CancelAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
-export type CopilotAPIAck = CancelAck | CopilotSearchAck | FacetedNavigationAck | CopilotError;
+import { ConversationResetAck } from "./ConversationResetAck";
+export type CopilotAPIAck = CancelAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | CopilotError;

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

@@ -4,5 +4,7 @@ interface SearchParams {
     pageSize?: number;
     page?: number;
     includeFacets?: boolean;
+    catalogSegment?: string;
+    pricebooks?: string[];
 }
 export { SearchParams };

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

@@ -1,4 +1,6 @@
 interface SessionData {
     eventSourceMap?: Record<string, string[]>;
+    conversationIds?: string[];
+    activeConversationId?: string;
 }
 export { SessionData };

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

@@ -6,8 +6,10 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
-export * from './CopilotAPIEvent';
+export * from './ConversationReset';
+export * from './ConversationResetAck';
 export * from './CopilotApiAck';
+export * from './CopilotAPIEvent';
 export * from './CopilotError';
 export * from './CopilotEvent';
 export * from './CopilotSearch';

package/examples/callbacks.ts

@@ -16,7 +16,7 @@ async function main() {
 
   try {
     const search = await copilot.search({
-      searchParams: { query: "laptops" },
+      searchParams: { query: "starlink Mini", catalogSegment: "WestMarine", pricebooks: ["wm-regular", "wm-sale-retail"] },
     });
     console.log("Search request ack:", search.result);
 

package/examples/conversationReset.ts

@@ -0,0 +1,52 @@
+import { CimulateCopilot } from "@cimulate/copilot-sdk";
+
+
+async function main() {
+    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",
+    });
+
+    // 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();
+    
+    console.log("Reset conversaton with empty payload");
+    const response = await copilot.conversationResetRequest({});
+    console.log("Conversation reset response: ", response);
+
+    console.log("Reset conversaton with empty payload");
+    const responseWithUserReason = await copilot.conversationResetRequest({
+        reason: "Clear the copilot context."
+    });
+    console.log("Conversation reset response: ", responseWithUserReason);
+
+    const sessionData = await copilot.requestSessionInformation();
+    console.log("Conversations related to this session: ", sessionData.data.conversationIds);
+    console.log("Current active conversation in this session: ", sessionData.data.activeConversationId);
+
+    console.log("Disconnect");
+    copilot.disconnect();
+
+    console.log("De-register handler");
+    copilot.off("connect_ack", connectAckHandler);
+    copilot.off("error", errorHandler);
+    copilot.off("connect_error", connectErrorHandler);
+
+}
+
+main();

package/package.json

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

package/src/copilot.ts

@@ -15,6 +15,8 @@ import type {
   FacetedNavigationAck,
   ReturnedFields,
   SessionInformation,
+  ConversationReset,
+  ConversationResetAck,
 } from "./model";
 import CimulateCopilotException from "./exceptions";
 import { SnakeCaseParser } from "./parser";
@@ -251,6 +253,22 @@ export default class CimulateCopilot<
     );
   }
 
+  async conversationResetRequest(args: ConversationReset): Promise<CopilotResult<T, ConversationResetAck>>;
+  async conversationResetRequest(
+    args: ConversationReset,
+    callback?: (event: ConversationResetAck) => void
+  ): Promise<void>;
+  conversationResetRequest(
+    args: ConversationReset,
+    callback?: (event: ConversationResetAck) => void
+  ): Promise<CopilotResult<T, ConversationResetAck> | void> {
+    return this.asyncResponse<ConversationReset, ConversationResetAck>(
+      "conversation_reset",
+      args,
+      callback
+    );
+  }
+
   async requestSessionInformation(): Promise<
     CopilotResult<T, SessionInformation>
   >;

package/src/model/ConversationReset.ts

@@ -0,0 +1,6 @@
+
+interface ConversationReset {
+  conversationId?: string;
+  reason?: string;
+}
+export { ConversationReset };

package/src/model/ConversationResetAck.ts

@@ -0,0 +1,10 @@
+import { ConversationReset } from './ConversationReset';
+interface ConversationResetAck {
+  name: 'conversation_reset';
+  request: ConversationReset;
+  sessionId: string;
+  id: string;
+  createdAt: string;
+  status: number;
+}
+export { ConversationResetAck };

package/src/model/CopilotApiAck.ts

@@ -6,9 +6,11 @@ import { CancelAck } from "./CancelAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
+import { ConversationResetAck } from "./ConversationResetAck";
 
 export type CopilotAPIAck =
   | CancelAck
   | CopilotSearchAck
+  | ConversationResetAck
   | FacetedNavigationAck
   | CopilotError;

package/src/model/SearchParams.ts

@@ -5,5 +5,7 @@ interface SearchParams {
   pageSize?: number;
   page?: number;
   includeFacets?: boolean;
+  catalogSegment?: string;
+  pricebooks?: string[];
 }
 export { SearchParams };

package/src/model/SessionData.ts

@@ -1,5 +1,7 @@
 
 interface SessionData {
   eventSourceMap?: Record<string, string[]>;
+  conversationIds?: string[];
+  activeConversationId?: string;
 }
 export { SessionData };

package/src/model/index.ts

@@ -6,8 +6,10 @@ export * from './CommonRequiredFields';
 export * from './ConnectAck';
 export * from './ConnectAckMetadata';
 export * from './ConnectError';
-export * from './CopilotAPIEvent';
+export * from './ConversationReset';
+export * from './ConversationResetAck';
 export * from './CopilotApiAck';
+export * from './CopilotAPIEvent';
 export * from './CopilotError';
 export * from './CopilotEvent';
 export * from './CopilotSearch';