@cimulate/copilot-sdk 3.6.0 → 3.7.0

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

@@ -3,8 +3,9 @@
  For any new event, manually create an entry here.
  */
 import { CancelAck } from "./CancelAck";
+import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
-import { ConversationResetAck } from "./ConversationResetAck";
-export type CopilotAPIAck = CancelAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | CopilotError;
+import { ProductViewAck } from "./ProductViewAck";
+export type CopilotAPIAck = CancelAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | ProductViewAck | CopilotError;

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

@@ -1,12 +1,13 @@
 import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
+import { ProductViewSuggestion } from './ProductViewSuggestion';
 interface FollowUp {
     sessionId: string;
     id: string;
     createdAt: string;
     eventSourceId: string;
     message: string;
-    suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+    suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion | ProductViewSuggestion)[];
     name: 'follow_up';
 }
 export { FollowUp };

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

@@ -0,0 +1,6 @@
+interface ProductView {
+    productId: string;
+    pdpLink?: string;
+    userPrompt?: string;
+}
+export { ProductView };

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

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

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

@@ -0,0 +1,7 @@
+import { ProductView } from './ProductView';
+interface ProductViewSuggestion {
+    displayText: string;
+    action: 'product_view';
+    params: ProductView;
+}
+export { ProductViewSuggestion };

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

@@ -27,6 +27,9 @@ export * from './FollowUp';
 export * from './Inquiry';
 export * from './OperationAck';
 export * from './PartialInquiry';
+export * from './ProductView';
+export * from './ProductViewAck';
+export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedSearch';

package/examples/conversationReset.ts

@@ -26,11 +26,11 @@ async function main() {
     copilot.connect();
     
     console.log("Reset conversaton with empty payload");
-    const response = await copilot.conversationResetRequest({});
+    const response = await copilot.conversationReset({});
     console.log("Conversation reset response: ", response);
 
     console.log("Reset conversaton with empty payload");
-    const responseWithUserReason = await copilot.conversationResetRequest({
+    const responseWithUserReason = await copilot.conversationReset({
         reason: "Clear the copilot context."
     });
     console.log("Conversation reset response: ", responseWithUserReason);

package/package.json

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

package/src/copilot.ts

@@ -13,6 +13,8 @@ import type {
   CopilotSearchAck,
   FacetedNavigation,
   FacetedNavigationAck,
+  ProductView,
+  ProductViewAck,
   ReturnedFields,
   SessionInformation,
   ConversationReset,
@@ -253,12 +255,12 @@ export default class CimulateCopilot<
     );
   }
 
-  async conversationResetRequest(args: ConversationReset): Promise<CopilotResult<T, ConversationResetAck>>;
-  async conversationResetRequest(
+  async conversationReset(args: ConversationReset): Promise<CopilotResult<T, ConversationResetAck>>;
+  async conversationReset(
     args: ConversationReset,
     callback?: (event: ConversationResetAck) => void
   ): Promise<void>;
-  conversationResetRequest(
+  conversationReset(
     args: ConversationReset,
     callback?: (event: ConversationResetAck) => void
   ): Promise<CopilotResult<T, ConversationResetAck> | void> {
@@ -269,6 +271,24 @@ export default class CimulateCopilot<
     );
   }
 
+  async productView(
+    args: ProductView
+  ): Promise<CopilotResult<T, ProductViewAck>>;
+  async productView(
+    args: ProductView,
+    callback?: (event: ProductViewAck) => void
+  ): Promise<void>;
+  async productView(
+    args: ProductView,
+    callback?: (event: ProductViewAck) => void
+  ): Promise<CopilotResult<T, ProductViewAck> | void> {
+    return this.asyncResponse<ProductView, ProductViewAck>(
+      "product_view",
+      args,
+      callback
+    );
+  }
+
   async requestSessionInformation(): Promise<
     CopilotResult<T, SessionInformation>
   >;

package/src/model/CopilotApiAck.ts

@@ -3,14 +3,16 @@
  For any new event, manually create an entry here.
  */
 import { CancelAck } from "./CancelAck";
+import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
-import { ConversationResetAck } from "./ConversationResetAck";
+import { ProductViewAck } from "./ProductViewAck"
 
 export type CopilotAPIAck =
   | CancelAck
   | CopilotSearchAck
   | ConversationResetAck
   | FacetedNavigationAck
+  | ProductViewAck
   | CopilotError;

package/src/model/FollowUp.ts

@@ -1,12 +1,13 @@
 import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
+import { ProductViewSuggestion } from './ProductViewSuggestion';
 interface FollowUp {
   sessionId: string;
   id: string;
   createdAt: string;
   eventSourceId: string;
   message: string;
-  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion | ProductViewSuggestion)[];
   name: 'follow_up';
 }
 export { FollowUp };

package/src/model/ProductView.ts

@@ -0,0 +1,7 @@
+
+interface ProductView {
+  productId: string;
+  pdpLink?: string;
+  userPrompt?: string;
+}
+export { ProductView };

package/src/model/ProductViewAck.ts

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

package/src/model/ProductViewSuggestion.ts

@@ -0,0 +1,7 @@
+import { ProductView } from './ProductView';
+interface ProductViewSuggestion {
+  displayText: string;
+  action: 'product_view';
+  params: ProductView;
+}
+export { ProductViewSuggestion };

package/src/model/index.ts

@@ -27,6 +27,9 @@ export * from './FollowUp';
 export * from './Inquiry';
 export * from './OperationAck';
 export * from './PartialInquiry';
+export * from './ProductView';
+export * from './ProductViewAck';
+export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
 export * from './RefinedSearch';