@cimulate/copilot-sdk 1.0.0 → 1.1.0

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

@@ -0,0 +1,54 @@
+import { CommonRequiredFields } from './CommonRequiredFields';
+import { CommonFields } from './CommonFields';
+import { ConnectAckMetadata } from './ConnectAckMetadata';
+import { ConnectAck } from './ConnectAck';
+import { SearchParameters } from './SearchParameters';
+import { FacetValue } from './FacetValue';
+import { Facet } from './Facet';
+import { CopilotSearch } from './CopilotSearch';
+import { FacetedNavigation } from './FacetedNavigation';
+import { EventAck } from './EventAck';
+import { RefinedSearch } from './RefinedSearch';
+import { DisplayProducts } from './DisplayProducts';
+import { Suggestion } from './Suggestion';
+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 { SessionData } from './SessionData';
+import { SessionInformation } from './SessionInformation';
+import { SessionEventInformationReply } from './SessionEventInformationReply';
+import { SessionEventStatusReply } from './SessionEventStatusReply';
+import { Cancel } from './Cancel';
+interface Root {
+    commonFields?: CommonRequiredFields;
+    commonEventFields?: CommonFields;
+    connectAckMetadata?: ConnectAckMetadata;
+    connectAck?: ConnectAck;
+    searchParams?: SearchParameters;
+    facetValue?: FacetValue;
+    facets?: Facet[];
+    copilotSearch?: CopilotSearch;
+    facetedNavigation?: FacetedNavigation;
+    eventAck?: EventAck;
+    refinedSearch?: RefinedSearch;
+    displayProducts?: DisplayProducts;
+    suggestions?: Suggestion[];
+    followUp?: FollowUp;
+    partialInquiry?: 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;
+    cancel?: Cancel;
+}
+export { Root };

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

@@ -0,0 +1,5 @@
+interface SearchParameters {
+    query: string;
+    facetFilters?: Map<string, string[]>;
+}
+export { SearchParameters };

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

@@ -0,0 +1,6 @@
+import { ReservedEvent } from './ReservedEvent';
+interface SessionData {
+    events?: Map<string, ReservedEvent>;
+    eventSourceMap?: Map<string, string[]>;
+}
+export { SessionData };

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

@@ -0,0 +1,5 @@
+interface SessionEventInformationReply {
+    reservedType?: any;
+    additionalProperties?: Map<string, any>;
+}
+export { SessionEventInformationReply };

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

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

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

@@ -0,0 +1,10 @@
+import { SessionData } from './SessionData';
+interface SessionInformation {
+    sessionId?: string;
+    createdAt?: string;
+    lastActiveAt?: string;
+    reservedStatus?: string;
+    data?: SessionData;
+    metadata?: Map<string, any>;
+}
+export { SessionInformation };

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

@@ -0,0 +1,6 @@
+interface Suggestion {
+    displayText?: string;
+    action?: string;
+    params?: Map<string, any>;
+}
+export { Suggestion };

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

@@ -0,0 +1,33 @@
+export * from './Root';
+export * from './CommonRequiredFields';
+export * from './CommonFields';
+export * from './CommonEventFields';
+export * from './ConnectAckMetadata';
+export * from './ConnectAck';
+export * from './ConnectionAcknowledgmentMessageFields';
+export * from './SearchParameters';
+export * from './FacetValue';
+export * from './Facet';
+export * from './CopilotSearch';
+export * from './FacetedNavigation';
+export * from './EventAck';
+export * from './EventAcknowledgmentMessageFields';
+export * from './RefinedSearch';
+export * from './RefinedSearchMessageFields';
+export * from './DisplayProducts';
+export * from './DisplayProductsMessageFields';
+export * from './Suggestion';
+export * from './FollowUp';
+export * from './FollowMinusUpMessageFields';
+export * from './PartialInquiry';
+export * from './PartialInquiryMessageFields';
+export * from './Inquiry';
+export * from './Done';
+export * from './Error';
+export * from './ErrorMessageFields';
+export * from './ReservedEvent';
+export * from './SessionData';
+export * from './SessionInformation';
+export * from './SessionEventInformationReply';
+export * from './SessionEventStatusReply';
+export * from './Cancel';

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "browser": "dist/index.umd.js",
+  "types": "src/model/index.ts",
   "scripts": {
+    "generate-models": "tsx scripts/generate-model.ts ../../python/cimulate-copilot-api/asyncapi.yaml src/model",
     "build": "rollup -c"
   },
   "keywords": [],
   "author": "support@cimulate.ai",
   "license": "MIT",
   "dependencies": {
-    "socket.io-client": "^4.7.5"
+    "socket.io-client": "^4.7.5",
+    "ts-deepmerge": "^7.0.2"
   },
   "peerDependencies": {
     "react": "^18.2.0",
@@ -26,12 +29,17 @@
     "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
+    "@rollup/plugin-typescript": "^9.0.0",
+    "@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",
     "webpack": "^5.97.1",
     "webpack-cli": "^6.0.1",
     "webpack-node-externals": "^3.0.0"

package/rollup.config.js

@@ -4,10 +4,11 @@ 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 typescript from "@rollup/plugin-typescript";
 // import polyfillNode from 'rollup-plugin-polyfill-node';
 
 export default defineConfig({
-  input: 'src/index.js',
+  input: 'src/index.ts',
   output: [
     {
       dir: 'dist',
@@ -35,20 +36,20 @@ export default defineConfig({
       dir: 'dist',
       entryFileNames: `index.esm.js`,
       format: 'esm',
-      sourcemap: false,
+      sourcemap: true,
     },
     {
       dir: 'dist',
       entryFileNames: `index.cjs.js`,
       format: 'cjs',
-      sourcemap: false,
+      sourcemap: true,
     },
     {
       dir: 'dist',
       entryFileNames: `index.umd.js`,
       format: 'umd',
       name: 'CimulateCopilot',
-      sourcemap: false,
+      sourcemap: true,
       globals: {
         'socket.io-client': 'io',
       },
@@ -59,9 +60,10 @@ export default defineConfig({
     commonjs(),
     json(),
     terser(),
+    typescript({ tsconfig: "./tsconfig.json" }),
     outputHash({
         hashLength: 8,
-        include: ['**/*.js'],
+        include: ['**/*.ts'],
     }),
   ],
   external: ['socket.io-client'],

package/src/copilot.ts

@@ -0,0 +1,154 @@
+import io, { ManagerOptions, Socket, SocketOptions } from "socket.io-client";
+import { merge } from "ts-deepmerge";
+
+import type * as Event from "./model/index"
+
+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,
+};
+
+class CimulateCopilot {
+  private socket: Socket;
+
+  constructor({
+    apiKey,
+    baseUrl,
+    namespace = "/copilot",
+    socketOptions = {},
+  }: CimulateCopilotOptions) {
+    const socketioEndpoint = `${baseUrl}${namespace}`;
+
+    this.socket = io(
+      socketioEndpoint,
+      merge(socketDefaults, socketOptions, {
+        withCredentials: true, // enables cookies
+        transportOptions: {
+          polling: {
+            extraHeaders: {
+              "x-cimulate-api-key": apiKey,
+            },
+          },
+        },
+      })
+    );
+  }
+
+  connect() {
+    this.socket.connect();
+  }
+
+  search(
+    { userPrompt, searchParams }: { userPrompt: string; searchParams: SearchParams },
+    callback?: (searchAck: Event.EventAck) => 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?: (facetedNavigation: Event.FacetedNavigation) => 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: Event.EventAck) => void
+  ) {
+    const payload = {
+      event_id: eventId,
+      reason,
+    };
+    if (callback) {
+      this.socket.emit("cancel", payload, callback);
+      return;
+    }
+    this.socket.emit("cancel", payload);
+  }
+
+  requestSessionData(callback: (sessionData: Event.SessionData) => void) {
+    this.socket.emit("session_info", callback);
+  }
+
+  onConnectAck(callback: (connectAck: Event.ConnectAck) => void) {
+    this.socket.on("connect_ack", callback);
+  }
+
+  onSearchAck(callback: (searchAck: Event.EventAck) => void) {
+    this.socket.on("search_ack", callback);
+  }
+
+  onRefinedSearch(callback: (refinedSearch: Event.RefinedSearch) => void) {
+    this.socket.on("refined_search", callback);
+  }
+
+  onFollowUp(callback: (followUp: Event.FollowUp) => void) {
+    this.socket.on("follow_up", callback);
+  }
+
+  onInquiry(callback: (inquiry: Event.Inquiry) => void) {
+    this.socket.on("inquiry", callback);
+  }
+
+  onPartialInquiry(callback: (partialInquiry: Event.PartialInquiry) => void) {
+    this.socket.on("partial_inquiry", callback);
+  }
+
+  onDisplayProducts(callback: (displayProducts: Event.DisplayProducts) => void) {
+    this.socket.on("display_products", callback);
+  }
+
+  onDone(callback: (done: Event.Done) => void) {
+    this.socket.on("done", callback);
+  }
+
+  onError(callback: (error: Event.Error) => void) {
+    this.socket.on("error", callback);
+  }
+
+  disconnect() {
+    this.socket.disconnect();
+  }
+
+  onDisconnect(callback: (reason: string) => void) {
+    this.socket.on("disconnect", callback);
+  }
+
+}
+
+export default CimulateCopilot;

package/src/index.ts

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

package/src/model/Cancel.ts

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

package/src/model/CommonEventFields.ts

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

package/src/model/CommonFields.ts

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

package/src/model/CommonRequiredFields.ts

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

package/src/model/ConnectAck.ts

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

package/src/model/ConnectAckMetadata.ts

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

package/src/model/ConnectionAcknowledgmentMessageFields.ts

@@ -0,0 +1,7 @@
+import {ConnectAckMetadata} from './ConnectAckMetadata';
+interface ConnectionAcknowledgmentMessageFields {
+  reservedStatus: number;
+  message: string;
+  metadata: ConnectAckMetadata;
+}
+export { ConnectionAcknowledgmentMessageFields };

package/src/model/CopilotSearch.ts

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

package/src/model/DisplayProducts.ts

@@ -0,0 +1,11 @@
+
+interface DisplayProducts {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  products: Map<string, any>[];
+}
+export { DisplayProducts };

package/src/model/DisplayProductsMessageFields.ts

@@ -0,0 +1,5 @@
+
+interface DisplayProductsMessageFields {
+  products: Map<string, any>[];
+}
+export { DisplayProductsMessageFields };

package/src/model/Done.ts

@@ -0,0 +1,10 @@
+
+interface Done {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+}
+export { Done };

package/src/model/Error.ts

@@ -0,0 +1,12 @@
+
+interface Error {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  reservedStatus: number;
+  error: string;
+}
+export { Error };

package/src/model/ErrorMessageFields.ts

@@ -0,0 +1,6 @@
+
+interface ErrorMessageFields {
+  reservedStatus: number;
+  error: string;
+}
+export { ErrorMessageFields };

package/src/model/EventAck.ts

@@ -0,0 +1,12 @@
+import {CopilotSearch} from './CopilotSearch';
+interface EventAck {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  reservedStatus: string;
+  request: CopilotSearch;
+}
+export { EventAck };

package/src/model/EventAcknowledgmentMessageFields.ts

@@ -0,0 +1,6 @@
+import {CopilotSearch} from './CopilotSearch';
+interface EventAcknowledgmentMessageFields {
+  reservedStatus: string;
+  request: CopilotSearch;
+}
+export { EventAcknowledgmentMessageFields };

package/src/model/Facet.ts

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

package/src/model/FacetValue.ts

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

package/src/model/FacetedNavigation.ts

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

package/src/model/FollowMinusUpMessageFields.ts

@@ -0,0 +1,5 @@
+import {Suggestion} from './Suggestion';
+interface FollowMinusUpMessageFields {
+  suggestions: Suggestion[];
+}
+export { FollowMinusUpMessageFields };

package/src/model/FollowUp.ts

@@ -0,0 +1,11 @@
+import {Suggestion} from './Suggestion';
+interface FollowUp {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  suggestions: Suggestion[];
+}
+export { FollowUp };

package/src/model/Inquiry.ts

@@ -0,0 +1,10 @@
+
+interface Inquiry {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+}
+export { Inquiry };

package/src/model/PartialInquiry.ts

@@ -0,0 +1,12 @@
+
+interface PartialInquiry {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  inquiryEventId: string;
+  index: number;
+}
+export { PartialInquiry };

package/src/model/PartialInquiryMessageFields.ts

@@ -0,0 +1,6 @@
+
+interface PartialInquiryMessageFields {
+  inquiryEventId: string;
+  index: number;
+}
+export { PartialInquiryMessageFields };

package/src/model/RefinedSearch.ts

@@ -0,0 +1,15 @@
+import {SearchParameters} from './SearchParameters';
+import {Facet} from './Facet';
+interface RefinedSearch {
+  sessionId: string;
+  eventId: string;
+  eventName: string;
+  timestamp: string;
+  eventSourceId: string;
+  message: string;
+  searchParams: SearchParameters;
+  hits?: Map<string, any>[];
+  totalHits?: number;
+  facets?: Facet[];
+}
+export { RefinedSearch };

package/src/model/RefinedSearchMessageFields.ts

@@ -0,0 +1,9 @@
+import {SearchParameters} from './SearchParameters';
+import {Facet} from './Facet';
+interface RefinedSearchMessageFields {
+  searchParams: SearchParameters;
+  hits?: Map<string, any>[];
+  totalHits?: number;
+  facets?: Facet[];
+}
+export { RefinedSearchMessageFields };

package/src/model/ReservedEvent.ts

@@ -0,0 +1,11 @@
+
+interface ReservedEvent {
+  id?: string;
+  sessionId?: string;
+  reservedName?: string;
+  eventSourceId?: string;
+  data?: any;
+  createdAt?: string;
+  metadata?: Map<string, any>;
+}
+export { ReservedEvent };