@cimulate/copilot-sdk 2.2.1 → 3.0.0

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

@@ -1,11 +1,11 @@
 interface Error {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     eventSourceId: string;
     message: string;
     status: number;
     error: string;
-    eventName: 'error';
+    name: 'error';
 }
 export { Error };

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

@@ -1,10 +1,10 @@
 import { FacetedNavigation } from './FacetedNavigation';
 interface FacetedNavigationAck {
-    eventName: 'faceted_navigation';
+    name: 'faceted_navigation';
     request: FacetedNavigation;
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     status: string;
 }
 export { FacetedNavigationAck };

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

@@ -2,11 +2,11 @@ import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
 interface FollowUp {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     eventSourceId: string;
     message: string;
     suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
-    eventName: 'follow_up';
+    name: 'follow_up';
 }
 export { FollowUp };

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

@@ -1,9 +1,10 @@
 interface Inquiry {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     eventSourceId: string;
     message: string;
-    eventName: 'inquiry';
+    name: 'inquiry';
+    inquiryLinkId: string;
 }
 export { Inquiry };

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

@@ -1,8 +1,8 @@
 interface OperationAck {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
-    eventName: string;
+    id: string;
+    createdAt: string;
+    name: string;
     status: string;
     request: any;
 }

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

@@ -1,11 +1,11 @@
 interface PartialInquiry {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     eventSourceId: string;
     message: string;
-    inquiryEventId: string;
+    inquiryLinkId: string;
     index: number;
-    eventName: 'partial_inquiry';
+    name: 'partial_inquiry';
 }
 export { PartialInquiry };

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

@@ -3,11 +3,11 @@ import { ReturnedFields } from "./ReturnedFields";
 import { SearchParams } from './SearchParams';
 interface RefinedSearch<TReturnedFields extends ReturnedFields = ReturnedFields> {
     sessionId: string;
-    eventId: string;
-    timestamp: string;
+    id: string;
+    createdAt: string;
     eventSourceId: string;
     message: string;
-    eventName: 'refined_search';
+    name: 'refined_search';
     searchParams: SearchParams;
     hits?: TReturnedFields;
     totalHits?: number;

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

@@ -1,7 +1,4 @@
-import { CopilotEvent } from './CopilotEvent';
-import { ReturnedFields } from "./ReturnedFields";
-interface SessionData<TReturnedFields extends ReturnedFields = ReturnedFields> {
-    events?: Record<string, CopilotEvent<TReturnedFields>>;
+interface SessionData {
     eventSourceMap?: Record<string, string[]>;
 }
 export { SessionData };

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

@@ -1,10 +1,12 @@
-import { ReturnedFields } from "./ReturnedFields";
+import { CommonMetadata } from './CommonMetadata';
 import { SessionData } from './SessionData';
-interface SessionInformation<TReturnedFields extends ReturnedFields = ReturnedFields> {
-    sessionId?: string;
+interface SessionInformation {
+    id?: string;
     createdAt?: string;
-    lastActiveAt?: string;
+    lastUpdatedAt?: string;
     status?: string;
-    data?: SessionData<TReturnedFields>;
+    ttlInMinutes?: number;
+    data?: SessionData;
+    metadata?: CommonMetadata;
 }
 export { SessionInformation };

package/examples/callbacks.ts

@@ -15,15 +15,16 @@ async function main() {
   });
 
   const followUp = copilot.on("follow_up", function followup(event) {
-    if (event.eventSourceId == search.result.eventId) {
+    if (event.eventSourceId == search.result.id) {
       event.suggestions.forEach((s) => console.log(s.displayText));
     }
   });
 
   copilot.on("done", function done(event) {
-    if (event.eventSourceId == search.result.eventId) {
+    if (event.eventSourceId == search.result.id) {
       copilot.off("follow_up", followUp);
       copilot.off("done", done);
+      console.log("De-registered event listeners!");
     }
   });
 }

package/examples/generator.ts

@@ -13,7 +13,7 @@ async function main() {
   });
 
   for await (const event of search.events) {
-    switch (event.eventName) {
+    switch (event.name) {
       case "follow_up":
         event.suggestions.forEach((event) => console.log(event.displayText));
         break;

package/package.json

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

package/src/copilot.ts

@@ -161,43 +161,43 @@ export default class CimulateCopilot<
   }
 
   async requestSessionInformation(): Promise<
-    CopilotResult<T, SessionInformation<T>>
+    CopilotResult<T, SessionInformation>
   >;
   async requestSessionInformation(
-    callback?: (sessionInformation: SessionInformation<T>) => void
+    callback?: (sessionInformation: SessionInformation) => void
   ): Promise<void>;
   async requestSessionInformation(
-    callback?: (sessionInformation: SessionInformation<T>) => void
-  ): Promise<CopilotResult<T, SessionInformation<T>> | void> {
+    callback?: (sessionInformation: SessionInformation) => void
+  ): Promise<CopilotResult<T, SessionInformation> | void> {
     return new Promise((resolve) => {
-      this.socket.emit("session_info", (response: SessionInformation<T>) => {
+      this.socket.emit("session_info", (response: SessionInformation) => {
         if (callback) callback(response);
         // TODO - error handling
-        resolve(response as CopilotResult<T, SessionInformation<T>>);
+        resolve(response as CopilotResult<T, SessionInformation>);
       });
     });
   }
 
   on<E extends CopilotEventName>(
-    eventName: E,
-    handler: (event: Extract<CopilotAPIEvent<T>, { eventName: E }>) => void
+    name: E,
+    handler: (event: Extract<CopilotAPIEvent<T>, { name: E }>) => void
   ) {
-    this.socket.on<CopilotEventName>(eventName, handler);
+    this.socket.on<CopilotEventName>(name, handler);
     return handler;
   }
 
   once<E extends CopilotEventName>(
-    eventName: E,
-    handler: (event: Extract<CopilotAPIEvent<T>, { eventName: E }>) => void
+    name: E,
+    handler: (event: Extract<CopilotAPIEvent<T>, { name: E }>) => void
   ) {
-    this.socket.once<CopilotEventName>(eventName, handler);
+    this.socket.once<CopilotEventName>(name, handler);
   }
 
   off<E extends CopilotEventName>(
-    eventName?: E,
-    handler?: (event: Extract<CopilotAPIEvent<T>, { eventName: E }>) => void
+    name?: E,
+    handler?: (event: Extract<CopilotAPIEvent<T>, { name: E }>) => void
   ) {
-    this.socket.off(eventName, handler as any);
+    this.socket.off(name, handler as any);
   }
 
   disconnect() {
@@ -225,7 +225,7 @@ export default class CimulateCopilot<
         event: string,
         payload: Exclude<CopilotAPIEvent<T>, ConnectAck>
       ) => {
-        if (payload.eventName == "done") cancel();
+        if (payload.name == "done") cancel();
         if (payload.eventSourceId == eventSourceId) emit(payload);
       };
 
@@ -239,7 +239,7 @@ export default class CimulateCopilot<
     const result: A = await new Promise((resolve) =>
       // TODO - error handling
       this.socket.emit(operation, payload, (ack: A) => {
-        eventSourceId = ack?.eventId;
+        eventSourceId = ack?.id;
         resolve(ack);
       })
     );

package/src/model/CancelAck.ts

@@ -1,10 +1,10 @@
 import { Cancel } from './Cancel';
 interface CancelAck {
-  eventName: 'cancel';
+  name: 'cancel';
   request: Cancel;
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   status: string;
 }
 export { CancelAck };

package/src/model/CommonFields.ts

@@ -1,8 +1,8 @@
 
 interface CommonFields {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
 }

package/src/model/CommonRequiredFields.ts

@@ -1,7 +1,7 @@
 
 interface CommonRequiredFields {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
 }
 export { CommonRequiredFields };

package/src/model/ConnectAck.ts

@@ -1,11 +1,11 @@
 import { ConnectAckMetadata } from './ConnectAckMetadata';
 interface ConnectAck {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   status: number;
   message: string;
   metadata: ConnectAckMetadata;
-  eventName: 'connect_ack';
+  name: 'connect_ack';
 }
 export { ConnectAck };

package/src/model/CopilotAPIEvent.ts

@@ -20,4 +20,4 @@ export type CopilotAPIEvent<
   | PartialInquiry
   | RefinedSearch<TReturnedFields>;
 
-export type CopilotEventName = CopilotAPIEvent["eventName"];
+export type CopilotEventName = CopilotAPIEvent["name"];

package/src/model/CopilotSearchAck.ts

@@ -1,10 +1,10 @@
 import { CopilotSearch } from './CopilotSearch';
 interface CopilotSearchAck {
-  eventName: 'copilot_search';
+  name: 'copilot_search';
   request: CopilotSearch;
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   status: string;
 }
 export { CopilotSearchAck };

package/src/model/DisplayProducts.ts

@@ -2,11 +2,11 @@ import { ReturnedFields } from "./ReturnedFields";
 
 interface DisplayProducts<TReturnedFields extends ReturnedFields = ReturnedFields> {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
-  eventName: 'display_products';
+  name: 'display_products';
   products: TReturnedFields;
 }
 export { DisplayProducts };

package/src/model/Done.ts

@@ -1,10 +1,10 @@
 
 interface Done {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
-  eventName: 'done';
+  name: 'done';
 }
 export { Done };

package/src/model/Error.ts

@@ -1,12 +1,12 @@
 
 interface Error {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
   status: number;
   error: string;
-  eventName: 'error';
+  name: 'error';
 }
 export { Error };

package/src/model/FacetedNavigationAck.ts

@@ -1,10 +1,10 @@
 import { FacetedNavigation } from './FacetedNavigation';
 interface FacetedNavigationAck {
-  eventName: 'faceted_navigation';
+  name: 'faceted_navigation';
   request: FacetedNavigation;
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   status: string;
 }
 export { FacetedNavigationAck };

package/src/model/FollowUp.ts

@@ -2,11 +2,11 @@ import { CopilotSearchSuggestion } from './CopilotSearchSuggestion';
 import { FacetedNavigationSuggestion } from './FacetedNavigationSuggestion';
 interface FollowUp {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
   suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
-  eventName: 'follow_up';
+  name: 'follow_up';
 }
 export { FollowUp };

package/src/model/Inquiry.ts

@@ -1,10 +1,11 @@
 
 interface Inquiry {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
-  eventName: 'inquiry';
+  name: 'inquiry';
+  inquiryLinkId: string;
 }
 export { Inquiry };

package/src/model/OperationAck.ts

@@ -1,9 +1,9 @@
 
 interface OperationAck {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
-  eventName: string;
+  id: string;
+  createdAt: string;
+  name: string;
   status: string;
   request: any;
 }

package/src/model/PartialInquiry.ts

@@ -1,12 +1,12 @@
 
 interface PartialInquiry {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
-  inquiryEventId: string;
+  inquiryLinkId: string;
   index: number;
-  eventName: 'partial_inquiry';
+  name: 'partial_inquiry';
 }
 export { PartialInquiry };

package/src/model/RefinedSearch.ts

@@ -4,11 +4,11 @@ import { SearchParams } from './SearchParams';
 
 interface RefinedSearch<TReturnedFields extends ReturnedFields = ReturnedFields> {
   sessionId: string;
-  eventId: string;
-  timestamp: string;
+  id: string;
+  createdAt: string;
   eventSourceId: string;
   message: string;
-  eventName: 'refined_search';
+  name: 'refined_search';
   searchParams: SearchParams;
   hits?: TReturnedFields;
   totalHits?: number;

package/src/model/SessionData.ts

@@ -1,8 +1,5 @@
-import { CopilotEvent } from './CopilotEvent';
-import { ReturnedFields } from "./ReturnedFields";
 
-interface SessionData<TReturnedFields extends ReturnedFields = ReturnedFields> {
-  events?: Record<string, CopilotEvent<TReturnedFields>>;
+interface SessionData {
   eventSourceMap?: Record<string, string[]>;
 }
 export { SessionData };

package/src/model/SessionInformation.ts

@@ -1,11 +1,12 @@
-import { ReturnedFields } from "./ReturnedFields";
+import { CommonMetadata } from './CommonMetadata';
 import { SessionData } from './SessionData';
-
-interface SessionInformation<TReturnedFields extends ReturnedFields = ReturnedFields> {
-  sessionId?: string;
+interface SessionInformation {
+  id?: string;
   createdAt?: string;
-  lastActiveAt?: string;
+  lastUpdatedAt?: string;
   status?: string;
-  data?: SessionData<TReturnedFields>;
+  ttlInMinutes?: number;
+  data?: SessionData;
+  metadata?: CommonMetadata;
 }
 export { SessionInformation };