@cimulate/copilot-sdk 3.9.0 → 3.10.0

package/README.md

@@ -189,6 +189,22 @@ const client = new CimulateCopilot<SearchReturnedFields[]>({
 });
 ```
 
+### Defining Browse Returned Fields Types
+```typescript
+interface BrowseReturnedFields {
+  id: string,
+  title: string,
+  image_url: string,
+  price: number,
+}
+```
+
+// Instantiate client object
+const client = new CimulateCopilot<BrowseReturnedFields[]>({
+  apiKey: "your-api-key",
+  baseUrl: "https://cimulate.copilot.url",
+});
+
 ### Handling Request Ack Failure
 ```typescript
 import { 

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

@@ -11,7 +11,8 @@ import { FollowUp } from "./FollowUp";
 import { Inquiry } from "./Inquiry";
 import { PartialInquiry } from "./PartialInquiry";
 import { Progress } from "./Progress";
+import { RefinedBrowse } from "./RefinedBrowse";
 import { RefinedSearch } from "./RefinedSearch";
 import { ReturnedFields } from "./ReturnedFields";
-export type CopilotAPIEvent<TReturnedFields extends ReturnedFields = ReturnedFields> = ConnectAck | ConnectError | DisplayProducts<TReturnedFields> | Done | CopilotError | FollowUp | Inquiry | PartialInquiry | Progress | RefinedSearch<TReturnedFields>;
+export type CopilotAPIEvent<TReturnedFields extends ReturnedFields = ReturnedFields> = ConnectAck | ConnectError | DisplayProducts<TReturnedFields> | Done | CopilotError | FollowUp | Inquiry | PartialInquiry | Progress | RefinedBrowse<TReturnedFields> | RefinedSearch<TReturnedFields>;
 export type CopilotEventName = CopilotAPIEvent["name"];

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

@@ -6,6 +6,7 @@ import { Done } from './Done';
 import { FollowUp } from './FollowUp';
 import { Inquiry } from './Inquiry';
 import { Progress } from './Progress';
+import { RefinedBrowse } from './RefinedBrowse';
 import { RefinedSearch } from './RefinedSearch';
 import { ReturnedFields } from "./ReturnedFields";
 interface CopilotEvent<TReturnedFields extends ReturnedFields = ReturnedFields> {
@@ -13,7 +14,7 @@ interface CopilotEvent<TReturnedFields extends ReturnedFields = ReturnedFields>
     sessionId: string;
     name: string;
     eventSourceId: string;
-    data: ConnectAck | FollowUp | Inquiry | DisplayProducts<TReturnedFields> | RefinedSearch<TReturnedFields> | Progress | Done | CopilotError;
+    data: ConnectAck | FollowUp | Inquiry | DisplayProducts<TReturnedFields> | RefinedBrowse<TReturnedFields> | RefinedSearch<TReturnedFields> | Progress | Done | CopilotError;
     createdAt: string;
     metadata: CommonMetadata;
 }

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

@@ -0,0 +1,16 @@
+import { BrowseParams } from './BrowseParams';
+import { Facet } from './Facet';
+import { ReturnedFields } from "./ReturnedFields";
+interface RefinedBrowse<TReturnedFields extends ReturnedFields = ReturnedFields> {
+    sessionId: string;
+    id: string;
+    createdAt: string;
+    eventSourceId: string;
+    message: string;
+    name: 'refined_browse';
+    browseParams: BrowseParams;
+    hits?: TReturnedFields;
+    totalHits?: number;
+    facets?: Facet[];
+}
+export { RefinedBrowse };

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

@@ -2,5 +2,6 @@
  * @generic
  * @overrides DisplayProducts.products
  * @overrides RefinedSearch.hits
+ * @overrides RefinedBrowse.hits
  */
 export type ReturnedFields = Record<string, any>[];

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

@@ -37,6 +37,7 @@ export * from './ProductViewAck';
 export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
+export * from './RefinedBrowse';
 export * from './RefinedSearch';
 export * from './ReturnedFields';
 export * from './SearchParams';

package/package.json

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

package/src/model/CopilotAPIEvent.ts

@@ -11,6 +11,7 @@ import { FollowUp } from "./FollowUp";
 import { Inquiry } from "./Inquiry";
 import { PartialInquiry } from "./PartialInquiry";
 import { Progress } from "./Progress";
+import { RefinedBrowse } from "./RefinedBrowse";
 import { RefinedSearch } from "./RefinedSearch";
 import { ReturnedFields } from "./ReturnedFields";
 
@@ -26,6 +27,7 @@ export type CopilotAPIEvent<
   | Inquiry
   | PartialInquiry
   | Progress
+  | RefinedBrowse<TReturnedFields>
   | RefinedSearch<TReturnedFields>;
 
 export type CopilotEventName = CopilotAPIEvent["name"];

package/src/model/CopilotEvent.ts

@@ -6,6 +6,7 @@ import { Done } from './Done';
 import { FollowUp } from './FollowUp';
 import { Inquiry } from './Inquiry';
 import { Progress } from './Progress';
+import { RefinedBrowse } from './RefinedBrowse';
 import { RefinedSearch } from './RefinedSearch';
 import { ReturnedFields } from "./ReturnedFields";
 
@@ -14,7 +15,7 @@ interface CopilotEvent<TReturnedFields extends ReturnedFields = ReturnedFields>
   sessionId: string;
   name: string;
   eventSourceId: string;
-  data: ConnectAck | FollowUp | Inquiry | DisplayProducts<TReturnedFields> | RefinedSearch<TReturnedFields> | Progress | Done | CopilotError;
+  data: ConnectAck | FollowUp | Inquiry | DisplayProducts<TReturnedFields> | RefinedBrowse<TReturnedFields> | RefinedSearch<TReturnedFields> | Progress | Done | CopilotError;
   createdAt: string;
   metadata: CommonMetadata;
 }

package/src/model/RefinedBrowse.ts

@@ -0,0 +1,17 @@
+import { BrowseParams } from './BrowseParams';
+import { Facet } from './Facet';
+import { ReturnedFields } from "./ReturnedFields";
+
+interface RefinedBrowse<TReturnedFields extends ReturnedFields = ReturnedFields> {
+  sessionId: string;
+  id: string;
+  createdAt: string;
+  eventSourceId: string;
+  message: string;
+  name: 'refined_browse';
+  browseParams: BrowseParams;
+  hits?: TReturnedFields;
+  totalHits?: number;
+  facets?: Facet[];
+}
+export { RefinedBrowse };

package/src/model/ReturnedFields.ts

@@ -2,5 +2,6 @@
  * @generic
  * @overrides DisplayProducts.products
  * @overrides RefinedSearch.hits
+ * @overrides RefinedBrowse.hits
  */
 export type ReturnedFields = Record<string, any>[];

package/src/model/index.ts

@@ -37,6 +37,7 @@ export * from './ProductViewAck';
 export * from './ProductViewSuggestion';
 export * from './Progress';
 export * from './ProgressToolKwargs';
+export * from './RefinedBrowse';
 export * from './RefinedSearch';
 export * from './ReturnedFields';
 export * from './SearchParams';