@cimulate/copilot-sdk 1.1.1 → 1.2.0

package/src/copilot.ts

@@ -1,7 +1,20 @@
 import io, { ManagerOptions, Socket, SocketOptions } from "socket.io-client";
-import { merge } from "ts-deepmerge";
 
-import type * as Event from "./model/index"
+import type {
+  ConnectAck,
+  DisplayProducts,
+  Done,
+  Error,
+  EventAck,
+  EventAckNames,
+  FollowUp,
+  Inquiry,
+  PartialInquiry,
+  RefinedSearch,
+  ReturnedFields,
+  SessionInformation,
+} from "./model";
+import deepmerge from "deepmerge";
 
 type SocketIOOptions = Partial<ManagerOptions & SocketOptions>;
 
@@ -27,7 +40,9 @@ const socketDefaults: SocketIOOptions = {
   timeout: 10000,
 };
 
-class CimulateCopilot {
+export default class CimulateCopilot<
+  T extends ReturnedFields = ReturnedFields
+> {
   private socket: Socket;
 
   constructor({
@@ -38,9 +53,10 @@ class CimulateCopilot {
   }: CimulateCopilotOptions) {
     const socketioEndpoint = `${baseUrl}${namespace}`;
 
-    this.socket = io(
-      socketioEndpoint,
-      merge(socketDefaults, socketOptions, {
+    const options: SocketIOOptions[] = [
+      socketDefaults,
+      socketOptions,
+      {
         withCredentials: true, // enables cookies
         transportOptions: {
           polling: {
@@ -49,8 +65,10 @@ class CimulateCopilot {
             },
           },
         },
-      })
-    );
+      },
+    ];
+
+    this.socket = io(socketioEndpoint, deepmerge.all(options));
   }
 
   connect() {
@@ -58,8 +76,11 @@ class CimulateCopilot {
   }
 
   search(
-    { userPrompt, searchParams }: { userPrompt?: string; searchParams: SearchParams },
-    callback?: (searchAck: Event.EventAck) => void
+    {
+      userPrompt,
+      searchParams,
+    }: { userPrompt?: string; searchParams: SearchParams },
+    callback?: (searchAck: EventAck<EventAckNames.COPILOT_SEARCH_ACK>) => void
   ) {
     const payload = {
       user_prompt: userPrompt,
@@ -74,7 +95,9 @@ class CimulateCopilot {
 
   facetedNavigation(
     { searchParams }: { searchParams: SearchParams },
-    callback?: (facetedNavigation: Event.FacetedNavigation) => void
+    callback?: (
+      facetedNavigationAck: EventAck<EventAckNames.FACETED_NAVIGATION_ACK>
+    ) => void
   ) {
     const payload = {
       search_params: searchParams,
@@ -88,7 +111,7 @@ class CimulateCopilot {
 
   cancelRequest(
     { eventId, reason }: { eventId: string; reason: string },
-    callback?: (cancelAck: Event.EventAck) => void
+    callback?: (cancelAck: EventAck<EventAckNames.CANCEL_ACK>) => void
   ) {
     const payload = {
       event_id: eventId,
@@ -101,43 +124,47 @@ class CimulateCopilot {
     this.socket.emit("cancel", payload);
   }
 
-  requestSessionData(callback: (sessionData: Event.SessionData) => void) {
+  requestSessionInformation(
+    callback: (sessionInformation: SessionInformation<T>) => void
+  ) {
     this.socket.emit("session_info", callback);
   }
 
-  onConnectAck(callback: (connectAck: Event.ConnectAck) => void) {
+  onConnectAck(callback: (connectAck: ConnectAck) => void) {
     this.socket.on("connect_ack", callback);
   }
 
-  onSearchAck(callback: (searchAck: Event.EventAck) => void) {
+  onSearchAck(
+    callback: (searchAck: EventAck<EventAckNames.COPILOT_SEARCH_ACK>) => void
+  ) {
     this.socket.on("search_ack", callback);
   }
 
-  onRefinedSearch(callback: (refinedSearch: Event.RefinedSearch) => void) {
+  onRefinedSearch(callback: (refinedSearch: RefinedSearch<T>) => void) {
     this.socket.on("refined_search", callback);
   }
 
-  onFollowUp(callback: (followUp: Event.FollowUp) => void) {
+  onFollowUp(callback: (followUp: FollowUp) => void) {
     this.socket.on("follow_up", callback);
   }
 
-  onInquiry(callback: (inquiry: Event.Inquiry) => void) {
+  onInquiry(callback: (inquiry: Inquiry) => void) {
     this.socket.on("inquiry", callback);
   }
 
-  onPartialInquiry(callback: (partialInquiry: Event.PartialInquiry) => void) {
+  onPartialInquiry(callback: (partialInquiry: PartialInquiry) => void) {
     this.socket.on("partial_inquiry", callback);
   }
 
-  onDisplayProducts(callback: (displayProducts: Event.DisplayProducts) => void) {
+  onDisplayProducts(callback: (displayProducts: DisplayProducts<T>) => void) {
     this.socket.on("display_products", callback);
   }
 
-  onDone(callback: (done: Event.Done) => void) {
+  onDone(callback: (done: Done) => void) {
     this.socket.on("done", callback);
   }
 
-  onError(callback: (error: Event.Error) => void) {
+  onError(callback: (error: Error) => void) {
     this.socket.on("error", callback);
   }
 
@@ -148,7 +175,4 @@ class CimulateCopilot {
   onDisconnect(callback: (reason: string) => void) {
     this.socket.on("disconnect", callback);
   }
-
 }
-
-export default CimulateCopilot;

package/src/model/Cancel.ts

@@ -1,6 +1,6 @@
 
 interface Cancel {
-  eventId: string;
+  event_id: string;
   reason?: string;
 }
 export { Cancel };

package/src/model/CommonEventFields.ts

@@ -1,6 +1,6 @@
 
 interface CommonEventFields {
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
 }
 export { CommonEventFields };

package/src/model/CommonFields.ts

@@ -1,10 +1,9 @@
 
 interface CommonFields {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
 }
 export { CommonFields };

package/src/model/CommonMetadata.ts

@@ -0,0 +1,7 @@
+import {WorkflowMetadata} from './WorkflowMetadata';
+interface CommonMetadata {
+  sio_session_id?: string;
+  session_id?: string;
+  workflow?: WorkflowMetadata;
+}
+export { CommonMetadata };

package/src/model/CommonRequiredFields.ts

@@ -1,8 +1,7 @@
 
 interface CommonRequiredFields {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
 }
 export { CommonRequiredFields };

package/src/model/ConnectAck.ts

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

package/src/model/ConnectAckMessageFields.ts

@@ -0,0 +1,8 @@
+import {ConnectAckMetadata} from './ConnectAckMetadata';
+interface ConnectAckMessageFields {
+  status: number;
+  message: string;
+  metadata: ConnectAckMetadata;
+  event_name: 'connect_ack';
+}
+export { ConnectAckMessageFields };

package/src/model/CopilotEvent.ts

@@ -0,0 +1,20 @@
+import {ConnectAck} from './ConnectAck';
+import {EventAck} from './EventAck';
+import {FollowUp} from './FollowUp';
+import {Inquiry} from './Inquiry';
+import {DisplayProducts} from './DisplayProducts';
+import {RefinedSearch} from './RefinedSearch';
+import {Done} from './Done';
+import {Error} from './Error';
+import {CommonMetadata} from './CommonMetadata';
+import type { ReturnedFields } from './ReturnedFields';
+interface CopilotEvent<T extends object = ReturnedFields> {
+  id: string;
+  session_id: string;
+  name: string;
+  event_source_id: string;
+  data: ConnectAck | EventAck | FollowUp | Inquiry | DisplayProducts<T> | RefinedSearch<T> | Done | Error;
+  created_at: string;
+  metadata: CommonMetadata;
+}
+export { CopilotEvent };

package/src/model/CopilotSearch.ts

@@ -1,6 +1,6 @@
-import {SearchParameters} from './SearchParameters';
+import {SearchParams} from './SearchParams';
 interface CopilotSearch {
-  searchParams: SearchParameters;
-  userPrompt?: string;
+  search_params: SearchParams;
+  user_prompt?: string;
 }
 export { CopilotSearch };

package/src/model/CopilotSearchSuggestion.ts

@@ -0,0 +1,7 @@
+import {CopilotSearch} from './CopilotSearch';
+interface CopilotSearchSuggestion {
+  display_text: string;
+  action: 'copilot_search';
+  params: CopilotSearch;
+}
+export { CopilotSearchSuggestion };

package/src/model/DisplayProducts.ts

@@ -1,11 +1,11 @@
-
-interface DisplayProducts {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+import type {ReturnedFields} from './ReturnedFields';
+interface DisplayProducts<T extends object = ReturnedFields> {
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
-  products: Map<string, any>[];
+  event_name: 'display_products';
+  products: T[];
 }
 export { DisplayProducts };

package/src/model/DisplayProductsMessageFields.ts

@@ -1,5 +1,6 @@
-
-interface DisplayProductsMessageFields {
-  products: Map<string, any>[];
+import type {ReturnedFields} from './ReturnedFields';
+interface DisplayProductsMessageFields<T extends object = ReturnedFields> {
+  event_name: 'display_products';
+  products: T[];
 }
 export { DisplayProductsMessageFields };

package/src/model/Done.ts

@@ -1,10 +1,10 @@
 
 interface Done {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
+  event_name: 'done';
 }
 export { Done };

package/src/model/DoneMessageFields.ts

@@ -0,0 +1,5 @@
+
+interface DoneMessageFields {
+  event_name: 'done';
+}
+export { DoneMessageFields };

package/src/model/Error.ts

@@ -1,12 +1,12 @@
 
 interface Error {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
-  reservedStatus: number;
+  status: number;
   error: string;
+  event_name: 'error';
 }
 export { Error };

package/src/model/ErrorMessageFields.ts

@@ -1,6 +1,7 @@
 
 interface ErrorMessageFields {
-  reservedStatus: number;
+  status: number;
   error: string;
+  event_name: 'error';
 }
 export { ErrorMessageFields };

package/src/model/EventAck.ts

@@ -1,12 +1,20 @@
 import {CopilotSearch} from './CopilotSearch';
-interface EventAck {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+import {FacetedNavigation} from './FacetedNavigation';
+import {Cancel} from './Cancel';
+import {EventAckNames} from './EventAckNames';
+
+type EventRequestMap = {
+  copilot_search_ack: CopilotSearch;
+  faceted_navigation_ack: FacetedNavigation;
+  cancel_ack: Cancel;
+}
+
+interface EventAck<T extends EventAckNames = EventAckNames> {
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
-  message: string;
-  reservedStatus: string;
-  request: CopilotSearch;
+  status: string;
+  request: EventRequestMap[T];
+  event_name: T;
 }
 export { EventAck };

package/src/model/EventAckMessageFields.ts

@@ -0,0 +1,10 @@
+import {CopilotSearch} from './CopilotSearch';
+import {FacetedNavigation} from './FacetedNavigation';
+import {Cancel} from './Cancel';
+import {EventAckNames} from './EventAckNames';
+interface EventAckMessageFields {
+  status: string;
+  request: CopilotSearch | FacetedNavigation | Cancel;
+  event_name: EventAckNames;
+}
+export { EventAckMessageFields };

package/src/model/EventAckNames.ts

@@ -0,0 +1,7 @@
+
+enum EventAckNames {
+  COPILOT_SEARCH_ACK = "copilot_search_ack",
+  FACETED_NAVIGATION_ACK = "faceted_navigation_ack",
+  CANCEL_ACK = "cancel_ack",
+}
+export { EventAckNames };

package/src/model/FacetValue.ts

@@ -1,6 +1,6 @@
 
 interface FacetValue {
-  reservedName?: string;
+  name?: string;
   count?: number;
 }
 export { FacetValue };

package/src/model/FacetedNavigation.ts

@@ -1,5 +1,5 @@
-import {SearchParameters} from './SearchParameters';
+import {SearchParams} from './SearchParams';
 interface FacetedNavigation {
-  searchParams: SearchParameters;
+  search_params: SearchParams;
 }
 export { FacetedNavigation };

package/src/model/FacetedNavigationSuggestion.ts

@@ -0,0 +1,7 @@
+import {FacetedNavigation} from './FacetedNavigation';
+interface FacetedNavigationSuggestion {
+  display_text: string;
+  action: 'faceted_navigation';
+  params: FacetedNavigation;
+}
+export { FacetedNavigationSuggestion };

package/src/model/FollowUp.ts

@@ -1,11 +1,12 @@
-import {Suggestion} from './Suggestion';
+import {CopilotSearchSuggestion} from './CopilotSearchSuggestion';
+import {FacetedNavigationSuggestion} from './FacetedNavigationSuggestion';
 interface FollowUp {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
-  suggestions: Suggestion[];
+  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+  event_name: 'follow_up';
 }
 export { FollowUp };

package/src/model/FollowUpMessageFields.ts

@@ -0,0 +1,7 @@
+import {CopilotSearchSuggestion} from './CopilotSearchSuggestion';
+import {FacetedNavigationSuggestion} from './FacetedNavigationSuggestion';
+interface FollowUpMessageFields {
+  suggestions: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+  event_name: 'follow_up';
+}
+export { FollowUpMessageFields };

package/src/model/Inquiry.ts

@@ -1,10 +1,10 @@
 
 interface Inquiry {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
+  event_name: 'inquiry';
 }
 export { Inquiry };

package/src/model/InquiryMessageFields.ts

@@ -0,0 +1,5 @@
+
+interface InquiryMessageFields {
+  event_name: 'inquiry';
+}
+export { InquiryMessageFields };

package/src/model/PartialInquiry.ts

@@ -1,12 +1,12 @@
 
 interface PartialInquiry {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
-  inquiryEventId: string;
+  inquiry_event_id: string;
   index: number;
+  event_name: 'partial_inquiry';
 }
 export { PartialInquiry };

package/src/model/PartialInquiryMessageFields.ts

@@ -1,6 +1,7 @@
 
 interface PartialInquiryMessageFields {
-  inquiryEventId: string;
+  inquiry_event_id: string;
   index: number;
+  event_name: 'partial_inquiry';
 }
 export { PartialInquiryMessageFields };

package/src/model/RefinedSearch.ts

@@ -1,15 +1,16 @@
-import {SearchParameters} from './SearchParameters';
+import {SearchParams} from './SearchParams';
 import {Facet} from './Facet';
-interface RefinedSearch {
-  sessionId: string;
-  eventId: string;
-  eventName: string;
+import type {ReturnedFields} from './ReturnedFields';
+interface RefinedSearch<T extends object = ReturnedFields> {
+  session_id: string;
+  event_id: string;
   timestamp: string;
-  eventSourceId: string;
+  event_source_id: string;
   message: string;
-  searchParams: SearchParameters;
-  hits?: Map<string, any>[];
-  totalHits?: number;
+  event_name: 'refined_search';
+  search_params: SearchParams;
+  hits?: T[];
+  total_hits?: number;
   facets?: Facet[];
 }
 export { RefinedSearch };

package/src/model/RefinedSearchMessageFields.ts

@@ -1,9 +1,11 @@
-import {SearchParameters} from './SearchParameters';
+import {SearchParams} from './SearchParams';
 import {Facet} from './Facet';
-interface RefinedSearchMessageFields {
-  searchParams: SearchParameters;
-  hits?: Map<string, any>[];
-  totalHits?: number;
+import type {ReturnedFields} from './ReturnedFields';
+interface RefinedSearchMessageFields<T extends object = ReturnedFields> {
+  event_name: 'refined_search';
+  search_params: SearchParams;
+  hits?: T[];
+  total_hits?: number;
   facets?: Facet[];
 }
 export { RefinedSearchMessageFields };

package/src/model/ReturnedFields.ts

@@ -0,0 +1,4 @@
+// This is added manually
+type ReturnedFields<T = unknown> = Record<string, T>;
+
+export type { ReturnedFields };

package/src/model/Root.ts

@@ -1,54 +1,62 @@
 import {CommonRequiredFields} from './CommonRequiredFields';
 import {CommonFields} from './CommonFields';
+import {CommonMetadata} from './CommonMetadata';
 import {ConnectAckMetadata} from './ConnectAckMetadata';
 import {ConnectAck} from './ConnectAck';
-import {SearchParameters} from './SearchParameters';
+import {SearchParams} from './SearchParams';
 import {FacetValue} from './FacetValue';
 import {Facet} from './Facet';
 import {CopilotSearch} from './CopilotSearch';
 import {FacetedNavigation} from './FacetedNavigation';
+import {EventAckNames} from './EventAckNames';
 import {EventAck} from './EventAck';
 import {RefinedSearch} from './RefinedSearch';
 import {DisplayProducts} from './DisplayProducts';
-import {Suggestion} from './Suggestion';
+import {CopilotSearchSuggestion} from './CopilotSearchSuggestion';
+import {FacetedNavigationSuggestion} from './FacetedNavigationSuggestion';
 import {FollowUp} from './FollowUp';
 import {PartialInquiry} from './PartialInquiry';
 import {Inquiry} from './Inquiry';
 import {Done} from './Done';
 import {Error} from './Error';
-import {ReservedEvent} from './ReservedEvent';
+import {CopilotEvent} from './CopilotEvent';
 import {SessionData} from './SessionData';
 import {SessionInformation} from './SessionInformation';
-import {SessionEventInformationReply} from './SessionEventInformationReply';
 import {SessionEventStatusReply} from './SessionEventStatusReply';
 import {Cancel} from './Cancel';
+import type {ReturnedFields} from './ReturnedFields';
 interface Root {
-  commonFields?: CommonRequiredFields;
-  commonEventFields?: CommonFields;
-  connectAckMetadata?: ConnectAckMetadata;
-  connectAck?: ConnectAck;
-  searchParams?: SearchParameters;
-  facetValue?: FacetValue;
+  common_fields?: CommonRequiredFields;
+  common_event_fields?: CommonFields;
+  common_metadata?: CommonMetadata;
+  connect_ack_metadata?: ConnectAckMetadata;
+  connect_ack?: ConnectAck;
+  search_params?: SearchParams;
+  facet_value?: FacetValue;
   facets?: Facet[];
-  copilotSearch?: CopilotSearch;
-  facetedNavigation?: FacetedNavigation;
-  eventAck?: EventAck;
-  refinedSearch?: RefinedSearch;
-  displayProducts?: DisplayProducts;
-  suggestions?: Suggestion[];
-  followUp?: FollowUp;
-  partialInquiry?: PartialInquiry;
+  copilot_search?: CopilotSearch;
+  faceted_navigation?: FacetedNavigation;
+  event_ack_names?: EventAckNames;
+  event_ack?: EventAck;
+  refined_search?: RefinedSearch;
+  display_products?: DisplayProducts;
+  copilot_search_suggestion?: CopilotSearchSuggestion;
+  faceted_navigation_suggestion?: FacetedNavigationSuggestion;
+  suggestions?: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
+  follow_up?: FollowUp;
+  partial_inquiry?: PartialInquiry;
   inquiry?: Inquiry;
   done?: Done;
   error?: Error;
-  reservedEvent?: ReservedEvent;
-  sessionData?: SessionData;
-  sessionInfoReply?: SessionInformation;
-  sessionEventsReply?: Map<string, any>[];
-  sessionEventInfo?: string;
-  sessionEventInfoReply?: SessionEventInformationReply;
-  sessionEventStatus?: string;
-  sessionEventStatusReply?: SessionEventStatusReply;
+  event?: CopilotEvent;
+  session_data?: SessionData;
+  session_info_reply?: SessionInformation;
+  session_events_reply?: CopilotEvent[];
+  session_event_info?: string;
+  session_event_info_reply?: ConnectAck | EventAck | FollowUp | Inquiry | DisplayProducts | RefinedSearch | Done | Error;
+  session_event_status?: string;
+  session_event_status_reply?: SessionEventStatusReply;
   cancel?: Cancel;
+  return_fields?: ReturnedFields;
 }
 export { Root };