@cimulate/copilot-sdk 1.2.0 → 2.0.0

package/src/copilot.ts

@@ -1,178 +0,0 @@
-import io, { ManagerOptions, Socket, SocketOptions } from "socket.io-client";
-
-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>;
-
-interface CimulateCopilotOptions {
-  apiKey: string;
-  baseUrl: string;
-  namespace?: string;
-  socketOptions?: Omit<SocketIOOptions, "withCredentials">;
-}
-
-interface SearchParams {
-  query: string;
-  facet_filters?: Record<string, string[]>;
-  page_size?: bigint;
-  page?: bigint;
-}
-
-const socketDefaults: SocketIOOptions = {
-  path: "/api/v1/socket.io",
-  autoConnect: false,
-  transports: ["polling", "websocket"],
-  upgrade: true,
-  timeout: 10000,
-};
-
-export default class CimulateCopilot<
-  T extends ReturnedFields = ReturnedFields
-> {
-  private socket: Socket;
-
-  constructor({
-    apiKey,
-    baseUrl,
-    namespace = "/copilot",
-    socketOptions = {},
-  }: CimulateCopilotOptions) {
-    const socketioEndpoint = `${baseUrl}${namespace}`;
-
-    const options: SocketIOOptions[] = [
-      socketDefaults,
-      socketOptions,
-      {
-        withCredentials: true, // enables cookies
-        transportOptions: {
-          polling: {
-            extraHeaders: {
-              "x-cimulate-api-key": apiKey,
-            },
-          },
-        },
-      },
-    ];
-
-    this.socket = io(socketioEndpoint, deepmerge.all(options));
-  }
-
-  connect() {
-    this.socket.connect();
-  }
-
-  search(
-    {
-      userPrompt,
-      searchParams,
-    }: { userPrompt?: string; searchParams: SearchParams },
-    callback?: (searchAck: EventAck<EventAckNames.COPILOT_SEARCH_ACK>) => void
-  ) {
-    const payload = {
-      user_prompt: userPrompt,
-      search_params: searchParams,
-    };
-    if (callback) {
-      this.socket.emit("copilot_search", payload, callback);
-      return;
-    }
-    this.socket.emit("copilot_search", payload);
-  }
-
-  facetedNavigation(
-    { searchParams }: { searchParams: SearchParams },
-    callback?: (
-      facetedNavigationAck: EventAck<EventAckNames.FACETED_NAVIGATION_ACK>
-    ) => void
-  ) {
-    const payload = {
-      search_params: searchParams,
-    };
-    if (callback) {
-      this.socket.emit("faceted_navigation", payload, callback);
-      return;
-    }
-    this.socket.emit("faceted_navigation", payload);
-  }
-
-  cancelRequest(
-    { eventId, reason }: { eventId: string; reason: string },
-    callback?: (cancelAck: EventAck<EventAckNames.CANCEL_ACK>) => void
-  ) {
-    const payload = {
-      event_id: eventId,
-      reason,
-    };
-    if (callback) {
-      this.socket.emit("cancel", payload, callback);
-      return;
-    }
-    this.socket.emit("cancel", payload);
-  }
-
-  requestSessionInformation(
-    callback: (sessionInformation: SessionInformation<T>) => void
-  ) {
-    this.socket.emit("session_info", callback);
-  }
-
-  onConnectAck(callback: (connectAck: ConnectAck) => void) {
-    this.socket.on("connect_ack", callback);
-  }
-
-  onSearchAck(
-    callback: (searchAck: EventAck<EventAckNames.COPILOT_SEARCH_ACK>) => void
-  ) {
-    this.socket.on("search_ack", callback);
-  }
-
-  onRefinedSearch(callback: (refinedSearch: RefinedSearch<T>) => void) {
-    this.socket.on("refined_search", callback);
-  }
-
-  onFollowUp(callback: (followUp: FollowUp) => void) {
-    this.socket.on("follow_up", callback);
-  }
-
-  onInquiry(callback: (inquiry: Inquiry) => void) {
-    this.socket.on("inquiry", callback);
-  }
-
-  onPartialInquiry(callback: (partialInquiry: PartialInquiry) => void) {
-    this.socket.on("partial_inquiry", callback);
-  }
-
-  onDisplayProducts(callback: (displayProducts: DisplayProducts<T>) => void) {
-    this.socket.on("display_products", callback);
-  }
-
-  onDone(callback: (done: Done) => void) {
-    this.socket.on("done", callback);
-  }
-
-  onError(callback: (error: Error) => void) {
-    this.socket.on("error", callback);
-  }
-
-  disconnect() {
-    this.socket.disconnect();
-  }
-
-  onDisconnect(callback: (reason: string) => void) {
-    this.socket.on("disconnect", callback);
-  }
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-import CimulateCopilot from './copilot';
-export { CimulateCopilot };

package/src/model/Cancel.ts

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

package/src/model/CommonEventFields.ts

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

package/src/model/CommonFields.ts

@@ -1,9 +0,0 @@
-
-interface CommonFields {
-  session_id: string;
-  event_id: string;
-  timestamp: string;
-  event_source_id: string;
-  message: string;
-}
-export { CommonFields };

package/src/model/CommonMetadata.ts

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

package/src/model/CommonRequiredFields.ts

@@ -1,7 +0,0 @@
-
-interface CommonRequiredFields {
-  session_id: string;
-  event_id: string;
-  timestamp: string;
-}
-export { CommonRequiredFields };

package/src/model/ConnectAck.ts

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

package/src/model/ConnectAckMessageFields.ts

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

package/src/model/ConnectAckMetadata.ts

@@ -1,6 +0,0 @@
-
-interface ConnectAckMetadata {
-  version: string;
-  server: string;
-}
-export { ConnectAckMetadata };

package/src/model/CopilotEvent.ts

@@ -1,20 +0,0 @@
-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 +0,0 @@
-import {SearchParams} from './SearchParams';
-interface CopilotSearch {
-  search_params: SearchParams;
-  user_prompt?: string;
-}
-export { CopilotSearch };

package/src/model/CopilotSearchSuggestion.ts

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

package/src/model/DisplayProducts.ts

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

package/src/model/DisplayProductsMessageFields.ts

@@ -1,6 +0,0 @@
-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 +0,0 @@
-
-interface Done {
-  session_id: string;
-  event_id: string;
-  timestamp: string;
-  event_source_id: string;
-  message: string;
-  event_name: 'done';
-}
-export { Done };

package/src/model/DoneMessageFields.ts

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

package/src/model/Error.ts

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

package/src/model/ErrorMessageFields.ts

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

package/src/model/EventAck.ts

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

package/src/model/EventAckMessageFields.ts

@@ -1,10 +0,0 @@
-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

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

package/src/model/Facet.ts

@@ -1,7 +0,0 @@
-import {FacetValue} from './FacetValue';
-interface Facet {
-  field?: string;
-  label?: string;
-  values?: FacetValue[];
-}
-export { Facet };

package/src/model/FacetValue.ts

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

package/src/model/FacetedNavigation.ts

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

package/src/model/FacetedNavigationSuggestion.ts

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

package/src/model/FollowUp.ts

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

package/src/model/FollowUpMessageFields.ts

@@ -1,7 +0,0 @@
-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 +0,0 @@
-
-interface Inquiry {
-  session_id: string;
-  event_id: string;
-  timestamp: string;
-  event_source_id: string;
-  message: string;
-  event_name: 'inquiry';
-}
-export { Inquiry };

package/src/model/InquiryMessageFields.ts

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

package/src/model/PartialInquiry.ts

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

package/src/model/PartialInquiryMessageFields.ts

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

package/src/model/RefinedSearch.ts

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

package/src/model/RefinedSearchMessageFields.ts

@@ -1,11 +0,0 @@
-import {SearchParams} from './SearchParams';
-import {Facet} from './Facet';
-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

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

package/src/model/Root.ts

@@ -1,62 +0,0 @@
-import {CommonRequiredFields} from './CommonRequiredFields';
-import {CommonFields} from './CommonFields';
-import {CommonMetadata} from './CommonMetadata';
-import {ConnectAckMetadata} from './ConnectAckMetadata';
-import {ConnectAck} from './ConnectAck';
-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 {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 {CopilotEvent} from './CopilotEvent';
-import {SessionData} from './SessionData';
-import {SessionInformation} from './SessionInformation';
-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?: 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;
-  copilot_search_suggestion?: CopilotSearchSuggestion;
-  faceted_navigation_suggestion?: FacetedNavigationSuggestion;
-  suggestions?: (CopilotSearchSuggestion | FacetedNavigationSuggestion)[];
-  follow_up?: FollowUp;
-  partial_inquiry?: PartialInquiry;
-  inquiry?: Inquiry;
-  done?: Done;
-  error?: Error;
-  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 };

package/src/model/SearchParams.ts

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

package/src/model/SessionData.ts

@@ -1,7 +0,0 @@
-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/src/model/SessionEventStatusReply.ts

@@ -1,5 +0,0 @@
-
-interface SessionEventStatusReply {
-  status?: string;
-}
-export { SessionEventStatusReply };

package/src/model/SessionInformation.ts

@@ -1,10 +0,0 @@
-import {SessionData} from './SessionData';
-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<T>;
-}
-export { SessionInformation };

package/src/model/WorkflowMetadata.ts

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