@cimulate/copilot-sdk 1.1.2 → 1.2.0

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

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

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

@@ -1,11 +1,11 @@
 interface Error {
     session_id: string;
     event_id: string;
-    event_name: string;
     timestamp: string;
     event_source_id: string;
     message: string;
     status: number;
     error: string;
+    event_name: 'error';
 }
 export { Error };

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

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

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

@@ -1,12 +1,18 @@
 import { CopilotSearch } from './CopilotSearch';
-interface EventAck {
+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;
-    event_name: string;
     timestamp: string;
-    event_source_id: string;
-    message: string;
     status: string;
-    request: CopilotSearch;
+    request: EventRequestMap[T];
+    event_name: T;
 }
 export { EventAck };

package/dist/types/model/EventAckMessageFields.d.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/dist/types/model/EventAckNames.d.ts

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

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

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

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

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

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

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

package/dist/types/model/FollowUpMessageFields.d.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/dist/types/model/Inquiry.d.ts

@@ -1,9 +1,9 @@
 interface Inquiry {
     session_id: string;
     event_id: string;
-    event_name: string;
     timestamp: string;
     event_source_id: string;
     message: string;
+    event_name: 'inquiry';
 }
 export { Inquiry };

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

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

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

@@ -1,11 +1,11 @@
 interface PartialInquiry {
     session_id: string;
     event_id: string;
-    event_name: string;
     timestamp: string;
     event_source_id: string;
     message: string;
     inquiry_event_id: string;
     index: number;
+    event_name: 'partial_inquiry';
 }
 export { PartialInquiry };

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

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

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

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

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

@@ -1,8 +1,10 @@
-import { SearchParameters } from './SearchParameters';
+import { SearchParams } from './SearchParams';
 import { Facet } from './Facet';
-interface RefinedSearchMessageFields {
-    search_params: SearchParameters;
-    hits?: Map<string, any>[];
+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[];
 }

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

@@ -0,0 +1,2 @@
+type ReturnedFields<T = unknown> = Record<string, T>;
+export type { ReturnedFields };

package/dist/types/model/Root.d.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 {
     common_fields?: CommonRequiredFields;
     common_event_fields?: CommonFields;
+    common_metadata?: CommonMetadata;
     connect_ack_metadata?: ConnectAckMetadata;
     connect_ack?: ConnectAck;
-    search_params?: SearchParameters;
+    search_params?: SearchParams;
     facet_value?: FacetValue;
     facets?: Facet[];
     copilot_search?: CopilotSearch;
     faceted_navigation?: FacetedNavigation;
+    event_ack_names?: EventAckNames;
     event_ack?: EventAck;
     refined_search?: RefinedSearch;
     display_products?: DisplayProducts;
-    suggestions?: Suggestion[];
+    copilot_search_suggestion?: CopilotSearchSuggestion;
+    faceted_navigation_suggestion?: FacetedNavigationSuggestion;
+    suggestions?: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
     follow_up?: FollowUp;
     partial_inquiry?: PartialInquiry;
     inquiry?: Inquiry;
     done?: Done;
     error?: Error;
-    event?: ReservedEvent;
+    event?: CopilotEvent;
     session_data?: SessionData;
     session_info_reply?: SessionInformation;
-    session_events_reply?: Map<string, any>[];
+    session_events_reply?: CopilotEvent[];
     session_event_info?: string;
-    session_event_info_reply?: SessionEventInformationReply;
+    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 };

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

@@ -0,0 +1,5 @@
+interface SearchParams {
+    query: string;
+    facet_filters?: Record<string, string[]>;
+}
+export { SearchParams };

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

@@ -1,6 +1,7 @@
-import { ReservedEvent } from './ReservedEvent';
-interface SessionData {
-    events?: Map<string, ReservedEvent>;
-    event_source_map?: Map<string, string[]>;
+import { CopilotEvent } from './CopilotEvent';
+import type { RefinedSearch } from './RefinedSearch';
+interface SessionData<T extends object = RefinedSearch> {
+    events?: Record<string, CopilotEvent<T>>;
+    event_source_map?: Record<string, string[]>;
 }
 export { SessionData };

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

@@ -1,5 +1,4 @@
 interface SessionEventStatusReply {
     status?: string;
-    additionalProperties?: Map<string, any>;
 }
 export { SessionEventStatusReply };

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

@@ -1,10 +1,10 @@
 import { SessionData } from './SessionData';
-interface SessionInformation {
+import type { RefinedSearch } from './RefinedSearch';
+interface SessionInformation<T extends object = RefinedSearch> {
     session_id?: string;
     created_at?: string;
     last_active_at?: string;
     status?: string;
-    data?: SessionData;
-    metadata?: Map<string, any>;
+    data?: SessionData<T>;
 }
 export { SessionInformation };

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

@@ -0,0 +1,5 @@
+interface WorkflowMetadata {
+    session_id?: string;
+    task_id?: string;
+}
+export { WorkflowMetadata };

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

@@ -2,32 +2,38 @@ export * from './Root';
 export * from './CommonRequiredFields';
 export * from './CommonFields';
 export * from './CommonEventFields';
+export * from './CommonMetadata';
+export * from './WorkflowMetadata';
 export * from './ConnectAckMetadata';
 export * from './ConnectAck';
-export * from './ConnectionAcknowledgmentMessageFields';
-export * from './SearchParameters';
+export * from './ConnectAckMessageFields';
+export * from './SearchParams';
 export * from './FacetValue';
 export * from './Facet';
 export * from './CopilotSearch';
 export * from './FacetedNavigation';
+export * from './EventAckNames';
 export * from './EventAck';
-export * from './EventAcknowledgmentMessageFields';
+export * from './Cancel';
+export * from './EventAckMessageFields';
 export * from './RefinedSearch';
 export * from './RefinedSearchMessageFields';
 export * from './DisplayProducts';
 export * from './DisplayProductsMessageFields';
-export * from './Suggestion';
+export * from './CopilotSearchSuggestion';
+export * from './FacetedNavigationSuggestion';
 export * from './FollowUp';
-export * from './FollowMinusUpMessageFields';
+export * from './FollowUpMessageFields';
 export * from './PartialInquiry';
 export * from './PartialInquiryMessageFields';
 export * from './Inquiry';
+export * from './InquiryMessageFields';
 export * from './Done';
+export * from './DoneMessageFields';
 export * from './Error';
 export * from './ErrorMessageFields';
-export * from './ReservedEvent';
+export * from './CopilotEvent';
 export * from './SessionData';
 export * from './SessionInformation';
-export * from './SessionEventInformationReply';
 export * from './SessionEventStatusReply';
-export * from './Cancel';
+export * from './ReturnedFields';

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
+  "type": "module",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "browser": "dist/index.umd.js",
@@ -14,8 +15,9 @@
   "author": "support@cimulate.ai",
   "license": "MIT",
   "dependencies": {
+    "deepmerge": "^4.3.1",
     "socket.io-client": "^4.7.5",
-    "ts-deepmerge": "^7.0.2"
+    "ts-case-convert": "^2.1.0"
   },
   "peerDependencies": {
     "react": "^18.2.0",
@@ -29,16 +31,16 @@
     "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^9.0.0",
-    "@types/js-yaml": "^4.0.9",
     "@types/eslint": "^9.6.1",
     "@types/estree": "^1.0.6",
+    "@types/js-yaml": "^4.0.9",
     "babel-loader": "^9.2.1",
     "js-yaml": "^4.1.0",
     "rollup": "^2.42.0",
     "rollup-plugin-hash": "^1.3.0",
     "rollup-plugin-output": "^1.0.1",
-    "rollup-plugin-terser": "^7.0.2",
     "source-map-explorer": "^2.5.3",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3",

package/rollup.config.js

@@ -3,7 +3,7 @@ import resolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
 import json from '@rollup/plugin-json';
 import outputHash from 'rollup-plugin-output';
-import { terser } from 'rollup-plugin-terser';
+import terser from '@rollup/plugin-terser';
 import typescript from "@rollup/plugin-typescript";
 // import polyfillNode from 'rollup-plugin-polyfill-node';
 

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?: (facetedNavigationAck: Event.EventAck) => 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);
   }
 
-  requestSessionInformation(callback: (sessionInformation: Event.SessionInformation) => 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/CommonFields.ts

@@ -2,7 +2,6 @@
 interface CommonFields {
   session_id: string;
   event_id: string;
-  event_name: string;
   timestamp: string;
   event_source_id: string;
   message: string;

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

@@ -2,7 +2,6 @@
 interface CommonRequiredFields {
   session_id: string;
   event_id: string;
-  event_name: string;
   timestamp: string;
 }
 export { CommonRequiredFields };

package/src/model/ConnectAck.ts

@@ -2,10 +2,10 @@ import {ConnectAckMetadata} from './ConnectAckMetadata';
 interface ConnectAck {
   session_id: string;
   event_id: string;
-  event_name: string;
   timestamp: string;
   status: number;
   message: string;
   metadata: ConnectAckMetadata;
+  event_name: 'connect_ack';
 }
 export { ConnectAck };

package/src/model/{ConnectionAcknowledgmentMessageFields.ts → ConnectAckMessageFields.ts}

@@ -1,7 +1,8 @@
 import {ConnectAckMetadata} from './ConnectAckMetadata';
-interface ConnectionAcknowledgmentMessageFields {
+interface ConnectAckMessageFields {
   status: number;
   message: string;
   metadata: ConnectAckMetadata;
+  event_name: 'connect_ack';
 }
-export { ConnectionAcknowledgmentMessageFields };
+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 };