@cimulate/copilot-sdk 1.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

package/README.md

@@ -0,0 +1,104 @@
+# Copilot Client SDK
+
+## Install
+* To install from NPM registry
+```sh
+npm install @cimulate/copilot-sdk
+```
+
+## Configuration Options
+
+| Option             | Type      | Default Value              | Description                                                                                                                                                        |
+|--------------------|-----------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `apiKey`           | `string`  | **Required**               | The API key used for authentication.                                                                                                                               |
+| `baseUrl`          | `string`  | **Required**               | The base URL of the Copilot API server.                                                                                                                            |
+| `namespace`        | `string`  | `'/copilot'`               | The Socket.IO namespace for the connection.                                                                                                                        |
+| `socketioPath`     | `string`  | `'/api/v1/socket.io'`      | The path for the Socket.IO server.                                                                                                                                 |
+| `transports`       | `array`   | `['polling', 'websocket']` | The transport methods used by Socket.IO. By default, <br/>it will establish connection using HTTP Long Polling <br/>and upgrade the connection to use Web Sockets. |
+| `upgradeTransport` | `boolean` | `true`                     | Whether to upgrade transport methods dynamically.                                                                                                                  |
+| `timeout`          | `number`  | `10000` (10 seconds)       | Connection timeout in milliseconds.                                                                                                                                |
+
+## Connection Modes
+### Default Mode
+```javascript
+const client = new CimulateCopilot({
+    apiKey: "your-api-key",
+    baseUrl: "https://your.copilot.url",
+    namespace: "/copilot",
+    socketioPath: "/api/v1/socket.io",
+    transports: ["polling", "websocket"],
+    upgradeTransport: true,
+    timeout: 10000
+});
+```
+
+### HTTP Long Polling Only Mode (No Websockets)
+```javascript
+const client = new CimulateCopilot({
+    apiKey: "your-api-key",
+    baseUrl: "https://your.copilot.url",
+    namespace: "/copilot",
+    socketioPath: "/api/v1/socket.io",
+    transports: ["polling"],
+    upgradeTransport: false,
+    timeout: 10000
+});
+```
+
+
+## Example Usage
+
+```javascript
+import { CimulateCopilot } from 'cimulate-copilot';
+
+// Establish Connection
+const client = new CimulateCopilot({
+    apiKey: "your-api-key",
+    baseUrl: "https://your.copilot.url",
+    namespace: "/copilot",
+    socketioPath: "/api/v1/socket.io",
+    transports: ["polling", "websocket"],
+    upgradeTransport: true,
+    timeout: 10000
+});
+
+// Handle connection acknowledgment
+client.onConnectAck((data) => {
+  console.log("Connected:", data);
+});
+
+// Handle errors
+client.onError((err) => {
+  console.error("Error:", err);
+});
+
+// Perform a search request and print search acknowledgment
+client.search(
+  { userPrompt: "What specifications should I consider for a budget gaming laptop?", searchParams: {"query": "gaming laptops"} },
+  (response) => {
+    console.log("Search response:", response);
+  }
+);
+
+// Handler for listening to an event
+const handleEvent = ({ eventReceived }) => {
+  console.log("Event Received:", eventReceived);
+};
+
+// Follow-up Example for listening to an event response
+client.onFollowUp(handleEvent)
+
+// Client side disconnect
+client.disconnect();
+
+// Handle disconnect event
+client.onDisconnect((reason) => {
+    console.log("Disconnected:", reason);
+});
+```
+
+## Notes
+- The `apiKey` is required to authenticate and establish the connection.
+- Ensure the `baseUrl` matches the appropriate Copilot API environment.
+- Set `upgradeTransport: false` if you want to restrict transport to the defined methods.
+- Adjust the `timeout` based on your network conditions.

package/dist/bundle.cimulate.copilot-sdk.0bb38412.esm.js

@@ -0,0 +1,2 @@
+import t from"socket.io-client";class e{constructor({apiKey:e,baseUrl:o,namespace:s="/copilot",socketioPath:i="/api/v1/socket.io",transports:c=["polling","websocket"],upgradeTransport:n=!0,timeout:a=1e4}){this.apiKey=e,this.baseUrl=o,this.timeout=a;const r=`${o}${s}`;this.socket=t(r,{path:i,withCredentials:!0,transports:c,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":e}}},upgrade:n})}search({userPrompt:t,searchParams:e},o=null){const s={user_prompt:t,search_params:e};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:t},e=null){const o={search_params:t};e?this.socket.emit("faceted_navigation",o,e):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:t,reason:e},o=null){const s={event_id:t,reason:e};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(t){this.socket.emit("session_info",t)}onConnectAck(t){this.socket.on("connect_ack",t)}onSearchAck(t){this.socket.on("search_ack",t)}onRefinedSearch(t){this.socket.on("refined_search",t)}onFollowUp(t){this.socket.on("follow_up",t)}onInquiry(t){this.socket.on("inquiry",t)}onPartialInquiry(t){this.socket.on("partial_inquiry",t)}onDisplayProducts(t){this.socket.on("display_products",t)}onDone(t){this.socket.on("done",t)}onError(t){this.socket.on("error",t)}disconnect(){this.socket.disconnect()}onDisconnect(t){this.socket.on("disconnect",t)}}export{e as CimulateCopilot};
+//# sourceMappingURL=bundle.cimulate.copilot-sdk.0bb38412.esm.js.map

package/dist/bundle.cimulate.copilot-sdk.0bb38412.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.cimulate.copilot-sdk.0bb38412.esm.js","sources":["../src/copilot.js"],"sourcesContent":["import io from 'socket.io-client';\n\nclass CimulateCopilot {\n    constructor({\n        apiKey,\n        baseUrl,\n        namespace = '/copilot',\n        socketioPath = '/api/v1/socket.io',\n        transports = ['polling', 'websocket'],\n        upgradeTransport = true,\n        timeout = 10000\n    }){\n        this.apiKey = apiKey;\n        this.baseUrl = baseUrl;\n        this.timeout = timeout;\n        const socketioEndpoint = `${baseUrl}${namespace}`;\n        this.socket = io(socketioEndpoint, { \n            path: socketioPath,\n            withCredentials: true, // enables cookies\n            transports: transports,\n            transportOptions: {\n                polling: {\n                    extraHeaders: {\n                        'x-cimulate-api-key': apiKey,\n                    },\n                },\n            },\n            upgrade: upgradeTransport\n        });\n    }\n\n    search({ userPrompt, searchParams }, callback = null){\n        const payload = {\n            user_prompt: userPrompt,\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('copilot_search', payload, callback);\n            return;\n        }\n        this.socket.emit('copilot_search', payload);\n    }\n\n    facetedNavigation({ searchParams }, callback = null){\n        const payload = {\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('faceted_navigation', payload, callback);\n            return;\n        }\n        this.socket.emit('faceted_navigation', payload);\n    }\n\n    cancelRequest({ eventId, reason }, callback = null){\n        const payload = {\n            event_id: eventId,\n            reason,\n        }\n        if (callback){\n            this.socket.emit('cancel', payload, callback);\n            return;\n        }\n        this.socket.emit('cancel', payload);\n    }\n\n    requestSessionData(callback){\n        this.socket.emit('session_info', callback);\n    }\n\n    onConnectAck(callback){\n        this.socket.on('connect_ack', callback);\n    }\n\n    onSearchAck(callback){\n        this.socket.on('search_ack', callback);\n    }\n\n    onRefinedSearch(callback){\n        this.socket.on('refined_search', callback);\n    }\n\n    onFollowUp(callback){\n        this.socket.on('follow_up', callback);\n    }\n\n    onInquiry(callback){\n        this.socket.on('inquiry', callback);\n    }\n\n    onPartialInquiry(callback){\n        this.socket.on('partial_inquiry', callback);\n    }\n\n    onDisplayProducts(callback){\n        this.socket.on('display_products', callback);\n    }\n\n    onDone(callback){\n        this.socket.on('done', callback);\n    }\n\n    onError(callback){\n        this.socket.on('error', callback);\n    }\n\n    disconnect(){\n        this.socket.disconnect();\n    }\n\n    onDisconnect(callback){\n        this.socket.on('disconnect', callback);\n    }\n}\n\nexport default CimulateCopilot;\n"],"names":["CimulateCopilot","constructor","apiKey","baseUrl","namespace","socketioPath","transports","upgradeTransport","timeout","this","socketioEndpoint","socket","io","path","withCredentials","transportOptions","polling","extraHeaders","upgrade","search","userPrompt","searchParams","callback","payload","user_prompt","search_params","emit","facetedNavigation","cancelRequest","eventId","reason","event_id","requestSessionData","onConnectAck","on","onSearchAck","onRefinedSearch","onFollowUp","onInquiry","onPartialInquiry","onDisplayProducts","onDone","onError","disconnect","onDisconnect"],"mappings":"gCAEA,MAAMA,EACF,WAAAC,EAAYC,OACRA,EAAMC,QACNA,EAAOC,UACPA,EAAY,WAAUC,aACtBA,EAAe,oBAAmBC,WAClCA,EAAa,CAAC,UAAW,aAAYC,iBACrCA,GAAmB,EAAIC,QACvBA,EAAU,MAEVC,KAAKP,OAASA,EACdO,KAAKN,QAAUA,EACfM,KAAKD,QAAUA,EACf,MAAME,EAAmB,GAAGP,IAAUC,IACtCK,KAAKE,OAASC,EAAGF,EAAkB,CAC/BG,KAAMR,EACNS,iBAAiB,EACjBR,WAAYA,EACZS,iBAAkB,CACdC,QAAS,CACLC,aAAc,CACV,qBAAsBf,KAIlCgB,QAASX,GAEhB,CAED,MAAAY,EAAOC,WAAEA,EAAUC,aAAEA,GAAgBC,EAAW,MAC5C,MAAMC,EAAU,CACZC,YAAaJ,EACbK,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,iBAAkBH,EAASD,GAGhDb,KAAKE,OAAOe,KAAK,iBAAkBH,EACtC,CAED,iBAAAI,EAAkBN,aAAEA,GAAgBC,EAAW,MAC3C,MAAMC,EAAU,CACZE,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,qBAAsBH,EAASD,GAGpDb,KAAKE,OAAOe,KAAK,qBAAsBH,EAC1C,CAED,aAAAK,EAAcC,QAAEA,EAAOC,OAAEA,GAAUR,EAAW,MAC1C,MAAMC,EAAU,CACZQ,SAAUF,EACVC,UAEAR,EACAb,KAAKE,OAAOe,KAAK,SAAUH,EAASD,GAGxCb,KAAKE,OAAOe,KAAK,SAAUH,EAC9B,CAED,kBAAAS,CAAmBV,GACfb,KAAKE,OAAOe,KAAK,eAAgBJ,EACpC,CAED,YAAAW,CAAaX,GACTb,KAAKE,OAAOuB,GAAG,cAAeZ,EACjC,CAED,WAAAa,CAAYb,GACRb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC,CAED,eAAAc,CAAgBd,GACZb,KAAKE,OAAOuB,GAAG,iBAAkBZ,EACpC,CAED,UAAAe,CAAWf,GACPb,KAAKE,OAAOuB,GAAG,YAAaZ,EAC/B,CAED,SAAAgB,CAAUhB,GACNb,KAAKE,OAAOuB,GAAG,UAAWZ,EAC7B,CAED,gBAAAiB,CAAiBjB,GACbb,KAAKE,OAAOuB,GAAG,kBAAmBZ,EACrC,CAED,iBAAAkB,CAAkBlB,GACdb,KAAKE,OAAOuB,GAAG,mBAAoBZ,EACtC,CAED,MAAAmB,CAAOnB,GACHb,KAAKE,OAAOuB,GAAG,OAAQZ,EAC1B,CAED,OAAAoB,CAAQpB,GACJb,KAAKE,OAAOuB,GAAG,QAASZ,EAC3B,CAED,UAAAqB,GACIlC,KAAKE,OAAOgC,YACf,CAED,YAAAC,CAAatB,GACTb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC"}

package/dist/bundle.cimulate.copilot-sdk.a100b7fd.umd.js

@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("socket.io-client")):"function"==typeof define&&define.amd?define(["exports","socket.io-client"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).CimulateCopilot={},e.io)}(this,(function(e,t){"use strict";function o(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var s=o(t);e.CimulateCopilot=class{constructor({apiKey:e,baseUrl:t,namespace:o="/copilot",socketioPath:i="/api/v1/socket.io",transports:n=["polling","websocket"],upgradeTransport:c=!0,timeout:a=1e4}){this.apiKey=e,this.baseUrl=t,this.timeout=a;const r=`${t}${o}`;this.socket=s.default(r,{path:i,withCredentials:!0,transports:n,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":e}}},upgrade:c})}search({userPrompt:e,searchParams:t},o=null){const s={user_prompt:e,search_params:t};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:e},t=null){const o={search_params:e};t?this.socket.emit("faceted_navigation",o,t):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:e,reason:t},o=null){const s={event_id:e,reason:t};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(e){this.socket.emit("session_info",e)}onConnectAck(e){this.socket.on("connect_ack",e)}onSearchAck(e){this.socket.on("search_ack",e)}onRefinedSearch(e){this.socket.on("refined_search",e)}onFollowUp(e){this.socket.on("follow_up",e)}onInquiry(e){this.socket.on("inquiry",e)}onPartialInquiry(e){this.socket.on("partial_inquiry",e)}onDisplayProducts(e){this.socket.on("display_products",e)}onDone(e){this.socket.on("done",e)}onError(e){this.socket.on("error",e)}disconnect(){this.socket.disconnect()}onDisconnect(e){this.socket.on("disconnect",e)}},Object.defineProperty(e,"__esModule",{value:!0})}));
+//# sourceMappingURL=bundle.cimulate.copilot-sdk.a100b7fd.umd.js.map

package/dist/bundle.cimulate.copilot-sdk.a100b7fd.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.cimulate.copilot-sdk.a100b7fd.umd.js","sources":["../src/copilot.js"],"sourcesContent":["import io from 'socket.io-client';\n\nclass CimulateCopilot {\n    constructor({\n        apiKey,\n        baseUrl,\n        namespace = '/copilot',\n        socketioPath = '/api/v1/socket.io',\n        transports = ['polling', 'websocket'],\n        upgradeTransport = true,\n        timeout = 10000\n    }){\n        this.apiKey = apiKey;\n        this.baseUrl = baseUrl;\n        this.timeout = timeout;\n        const socketioEndpoint = `${baseUrl}${namespace}`;\n        this.socket = io(socketioEndpoint, { \n            path: socketioPath,\n            withCredentials: true, // enables cookies\n            transports: transports,\n            transportOptions: {\n                polling: {\n                    extraHeaders: {\n                        'x-cimulate-api-key': apiKey,\n                    },\n                },\n            },\n            upgrade: upgradeTransport\n        });\n    }\n\n    search({ userPrompt, searchParams }, callback = null){\n        const payload = {\n            user_prompt: userPrompt,\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('copilot_search', payload, callback);\n            return;\n        }\n        this.socket.emit('copilot_search', payload);\n    }\n\n    facetedNavigation({ searchParams }, callback = null){\n        const payload = {\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('faceted_navigation', payload, callback);\n            return;\n        }\n        this.socket.emit('faceted_navigation', payload);\n    }\n\n    cancelRequest({ eventId, reason }, callback = null){\n        const payload = {\n            event_id: eventId,\n            reason,\n        }\n        if (callback){\n            this.socket.emit('cancel', payload, callback);\n            return;\n        }\n        this.socket.emit('cancel', payload);\n    }\n\n    requestSessionData(callback){\n        this.socket.emit('session_info', callback);\n    }\n\n    onConnectAck(callback){\n        this.socket.on('connect_ack', callback);\n    }\n\n    onSearchAck(callback){\n        this.socket.on('search_ack', callback);\n    }\n\n    onRefinedSearch(callback){\n        this.socket.on('refined_search', callback);\n    }\n\n    onFollowUp(callback){\n        this.socket.on('follow_up', callback);\n    }\n\n    onInquiry(callback){\n        this.socket.on('inquiry', callback);\n    }\n\n    onPartialInquiry(callback){\n        this.socket.on('partial_inquiry', callback);\n    }\n\n    onDisplayProducts(callback){\n        this.socket.on('display_products', callback);\n    }\n\n    onDone(callback){\n        this.socket.on('done', callback);\n    }\n\n    onError(callback){\n        this.socket.on('error', callback);\n    }\n\n    disconnect(){\n        this.socket.disconnect();\n    }\n\n    onDisconnect(callback){\n        this.socket.on('disconnect', callback);\n    }\n}\n\nexport default CimulateCopilot;\n"],"names":["constructor","apiKey","baseUrl","namespace","socketioPath","transports","upgradeTransport","timeout","this","socketioEndpoint","socket","io","path","withCredentials","transportOptions","polling","extraHeaders","upgrade","search","userPrompt","searchParams","callback","payload","user_prompt","search_params","emit","facetedNavigation","cancelRequest","eventId","reason","event_id","requestSessionData","onConnectAck","on","onSearchAck","onRefinedSearch","onFollowUp","onInquiry","onPartialInquiry","onDisplayProducts","onDone","onError","disconnect","onDisconnect"],"mappings":"kZAEA,MACI,WAAAA,EAAYC,OACRA,EAAMC,QACNA,EAAOC,UACPA,EAAY,WAAUC,aACtBA,EAAe,oBAAmBC,WAClCA,EAAa,CAAC,UAAW,aAAYC,iBACrCA,GAAmB,EAAIC,QACvBA,EAAU,MAEVC,KAAKP,OAASA,EACdO,KAAKN,QAAUA,EACfM,KAAKD,QAAUA,EACf,MAAME,EAAmB,GAAGP,IAAUC,IACtCK,KAAKE,OAASC,EAAE,QAACF,EAAkB,CAC/BG,KAAMR,EACNS,iBAAiB,EACjBR,WAAYA,EACZS,iBAAkB,CACdC,QAAS,CACLC,aAAc,CACV,qBAAsBf,KAIlCgB,QAASX,GAEhB,CAED,MAAAY,EAAOC,WAAEA,EAAUC,aAAEA,GAAgBC,EAAW,MAC5C,MAAMC,EAAU,CACZC,YAAaJ,EACbK,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,iBAAkBH,EAASD,GAGhDb,KAAKE,OAAOe,KAAK,iBAAkBH,EACtC,CAED,iBAAAI,EAAkBN,aAAEA,GAAgBC,EAAW,MAC3C,MAAMC,EAAU,CACZE,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,qBAAsBH,EAASD,GAGpDb,KAAKE,OAAOe,KAAK,qBAAsBH,EAC1C,CAED,aAAAK,EAAcC,QAAEA,EAAOC,OAAEA,GAAUR,EAAW,MAC1C,MAAMC,EAAU,CACZQ,SAAUF,EACVC,UAEAR,EACAb,KAAKE,OAAOe,KAAK,SAAUH,EAASD,GAGxCb,KAAKE,OAAOe,KAAK,SAAUH,EAC9B,CAED,kBAAAS,CAAmBV,GACfb,KAAKE,OAAOe,KAAK,eAAgBJ,EACpC,CAED,YAAAW,CAAaX,GACTb,KAAKE,OAAOuB,GAAG,cAAeZ,EACjC,CAED,WAAAa,CAAYb,GACRb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC,CAED,eAAAc,CAAgBd,GACZb,KAAKE,OAAOuB,GAAG,iBAAkBZ,EACpC,CAED,UAAAe,CAAWf,GACPb,KAAKE,OAAOuB,GAAG,YAAaZ,EAC/B,CAED,SAAAgB,CAAUhB,GACNb,KAAKE,OAAOuB,GAAG,UAAWZ,EAC7B,CAED,gBAAAiB,CAAiBjB,GACbb,KAAKE,OAAOuB,GAAG,kBAAmBZ,EACrC,CAED,iBAAAkB,CAAkBlB,GACdb,KAAKE,OAAOuB,GAAG,mBAAoBZ,EACtC,CAED,MAAAmB,CAAOnB,GACHb,KAAKE,OAAOuB,GAAG,OAAQZ,EAC1B,CAED,OAAAoB,CAAQpB,GACJb,KAAKE,OAAOuB,GAAG,QAASZ,EAC3B,CAED,UAAAqB,GACIlC,KAAKE,OAAOgC,YACf,CAED,YAAAC,CAAatB,GACTb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC"}

package/dist/bundle.cimulate.copilot-sdk.f5a7df44.cjs.js

@@ -0,0 +1,2 @@
+"use strict";function t(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}Object.defineProperty(exports,"__esModule",{value:!0});var e=t(require("socket.io-client"));exports.CimulateCopilot=class{constructor({apiKey:t,baseUrl:o,namespace:s="/copilot",socketioPath:i="/api/v1/socket.io",transports:n=["polling","websocket"],upgradeTransport:c=!0,timeout:a=1e4}){this.apiKey=t,this.baseUrl=o,this.timeout=a;const r=`${o}${s}`;this.socket=e.default(r,{path:i,withCredentials:!0,transports:n,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":t}}},upgrade:c})}search({userPrompt:t,searchParams:e},o=null){const s={user_prompt:t,search_params:e};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:t},e=null){const o={search_params:t};e?this.socket.emit("faceted_navigation",o,e):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:t,reason:e},o=null){const s={event_id:t,reason:e};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(t){this.socket.emit("session_info",t)}onConnectAck(t){this.socket.on("connect_ack",t)}onSearchAck(t){this.socket.on("search_ack",t)}onRefinedSearch(t){this.socket.on("refined_search",t)}onFollowUp(t){this.socket.on("follow_up",t)}onInquiry(t){this.socket.on("inquiry",t)}onPartialInquiry(t){this.socket.on("partial_inquiry",t)}onDisplayProducts(t){this.socket.on("display_products",t)}onDone(t){this.socket.on("done",t)}onError(t){this.socket.on("error",t)}disconnect(){this.socket.disconnect()}onDisconnect(t){this.socket.on("disconnect",t)}};
+//# sourceMappingURL=bundle.cimulate.copilot-sdk.f5a7df44.cjs.js.map

package/dist/bundle.cimulate.copilot-sdk.f5a7df44.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.cimulate.copilot-sdk.f5a7df44.cjs.js","sources":["../src/copilot.js"],"sourcesContent":["import io from 'socket.io-client';\n\nclass CimulateCopilot {\n    constructor({\n        apiKey,\n        baseUrl,\n        namespace = '/copilot',\n        socketioPath = '/api/v1/socket.io',\n        transports = ['polling', 'websocket'],\n        upgradeTransport = true,\n        timeout = 10000\n    }){\n        this.apiKey = apiKey;\n        this.baseUrl = baseUrl;\n        this.timeout = timeout;\n        const socketioEndpoint = `${baseUrl}${namespace}`;\n        this.socket = io(socketioEndpoint, { \n            path: socketioPath,\n            withCredentials: true, // enables cookies\n            transports: transports,\n            transportOptions: {\n                polling: {\n                    extraHeaders: {\n                        'x-cimulate-api-key': apiKey,\n                    },\n                },\n            },\n            upgrade: upgradeTransport\n        });\n    }\n\n    search({ userPrompt, searchParams }, callback = null){\n        const payload = {\n            user_prompt: userPrompt,\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('copilot_search', payload, callback);\n            return;\n        }\n        this.socket.emit('copilot_search', payload);\n    }\n\n    facetedNavigation({ searchParams }, callback = null){\n        const payload = {\n            search_params: searchParams,\n        }\n        if (callback){\n            this.socket.emit('faceted_navigation', payload, callback);\n            return;\n        }\n        this.socket.emit('faceted_navigation', payload);\n    }\n\n    cancelRequest({ eventId, reason }, callback = null){\n        const payload = {\n            event_id: eventId,\n            reason,\n        }\n        if (callback){\n            this.socket.emit('cancel', payload, callback);\n            return;\n        }\n        this.socket.emit('cancel', payload);\n    }\n\n    requestSessionData(callback){\n        this.socket.emit('session_info', callback);\n    }\n\n    onConnectAck(callback){\n        this.socket.on('connect_ack', callback);\n    }\n\n    onSearchAck(callback){\n        this.socket.on('search_ack', callback);\n    }\n\n    onRefinedSearch(callback){\n        this.socket.on('refined_search', callback);\n    }\n\n    onFollowUp(callback){\n        this.socket.on('follow_up', callback);\n    }\n\n    onInquiry(callback){\n        this.socket.on('inquiry', callback);\n    }\n\n    onPartialInquiry(callback){\n        this.socket.on('partial_inquiry', callback);\n    }\n\n    onDisplayProducts(callback){\n        this.socket.on('display_products', callback);\n    }\n\n    onDone(callback){\n        this.socket.on('done', callback);\n    }\n\n    onError(callback){\n        this.socket.on('error', callback);\n    }\n\n    disconnect(){\n        this.socket.disconnect();\n    }\n\n    onDisconnect(callback){\n        this.socket.on('disconnect', callback);\n    }\n}\n\nexport default CimulateCopilot;\n"],"names":["constructor","apiKey","baseUrl","namespace","socketioPath","transports","upgradeTransport","timeout","this","socketioEndpoint","socket","io","path","withCredentials","transportOptions","polling","extraHeaders","upgrade","search","userPrompt","searchParams","callback","payload","user_prompt","search_params","emit","facetedNavigation","cancelRequest","eventId","reason","event_id","requestSessionData","onConnectAck","on","onSearchAck","onRefinedSearch","onFollowUp","onInquiry","onPartialInquiry","onDisplayProducts","onDone","onError","disconnect","onDisconnect"],"mappings":"yMAEA,MACI,WAAAA,EAAYC,OACRA,EAAMC,QACNA,EAAOC,UACPA,EAAY,WAAUC,aACtBA,EAAe,oBAAmBC,WAClCA,EAAa,CAAC,UAAW,aAAYC,iBACrCA,GAAmB,EAAIC,QACvBA,EAAU,MAEVC,KAAKP,OAASA,EACdO,KAAKN,QAAUA,EACfM,KAAKD,QAAUA,EACf,MAAME,EAAmB,GAAGP,IAAUC,IACtCK,KAAKE,OAASC,EAAE,QAACF,EAAkB,CAC/BG,KAAMR,EACNS,iBAAiB,EACjBR,WAAYA,EACZS,iBAAkB,CACdC,QAAS,CACLC,aAAc,CACV,qBAAsBf,KAIlCgB,QAASX,GAEhB,CAED,MAAAY,EAAOC,WAAEA,EAAUC,aAAEA,GAAgBC,EAAW,MAC5C,MAAMC,EAAU,CACZC,YAAaJ,EACbK,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,iBAAkBH,EAASD,GAGhDb,KAAKE,OAAOe,KAAK,iBAAkBH,EACtC,CAED,iBAAAI,EAAkBN,aAAEA,GAAgBC,EAAW,MAC3C,MAAMC,EAAU,CACZE,cAAeJ,GAEfC,EACAb,KAAKE,OAAOe,KAAK,qBAAsBH,EAASD,GAGpDb,KAAKE,OAAOe,KAAK,qBAAsBH,EAC1C,CAED,aAAAK,EAAcC,QAAEA,EAAOC,OAAEA,GAAUR,EAAW,MAC1C,MAAMC,EAAU,CACZQ,SAAUF,EACVC,UAEAR,EACAb,KAAKE,OAAOe,KAAK,SAAUH,EAASD,GAGxCb,KAAKE,OAAOe,KAAK,SAAUH,EAC9B,CAED,kBAAAS,CAAmBV,GACfb,KAAKE,OAAOe,KAAK,eAAgBJ,EACpC,CAED,YAAAW,CAAaX,GACTb,KAAKE,OAAOuB,GAAG,cAAeZ,EACjC,CAED,WAAAa,CAAYb,GACRb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC,CAED,eAAAc,CAAgBd,GACZb,KAAKE,OAAOuB,GAAG,iBAAkBZ,EACpC,CAED,UAAAe,CAAWf,GACPb,KAAKE,OAAOuB,GAAG,YAAaZ,EAC/B,CAED,SAAAgB,CAAUhB,GACNb,KAAKE,OAAOuB,GAAG,UAAWZ,EAC7B,CAED,gBAAAiB,CAAiBjB,GACbb,KAAKE,OAAOuB,GAAG,kBAAmBZ,EACrC,CAED,iBAAAkB,CAAkBlB,GACdb,KAAKE,OAAOuB,GAAG,mBAAoBZ,EACtC,CAED,MAAAmB,CAAOnB,GACHb,KAAKE,OAAOuB,GAAG,OAAQZ,EAC1B,CAED,OAAAoB,CAAQpB,GACJb,KAAKE,OAAOuB,GAAG,QAASZ,EAC3B,CAED,UAAAqB,GACIlC,KAAKE,OAAOgC,YACf,CAED,YAAAC,CAAatB,GACTb,KAAKE,OAAOuB,GAAG,aAAcZ,EAChC"}

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"use strict";function t(t){return t&&"object"==typeof t&&"default"in t?t:{default:t}}Object.defineProperty(exports,"__esModule",{value:!0});var e=t(require("socket.io-client"));exports.CimulateCopilot=class{constructor({apiKey:t,baseUrl:o,namespace:s="/copilot",socketioPath:i="/api/v1/socket.io",transports:n=["polling","websocket"],upgradeTransport:c=!0,timeout:a=1e4}){this.apiKey=t,this.baseUrl=o,this.timeout=a;const r=`${o}${s}`;this.socket=e.default(r,{path:i,withCredentials:!0,transports:n,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":t}}},upgrade:c})}search({userPrompt:t,searchParams:e},o=null){const s={user_prompt:t,search_params:e};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:t},e=null){const o={search_params:t};e?this.socket.emit("faceted_navigation",o,e):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:t,reason:e},o=null){const s={event_id:t,reason:e};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(t){this.socket.emit("session_info",t)}onConnectAck(t){this.socket.on("connect_ack",t)}onSearchAck(t){this.socket.on("search_ack",t)}onRefinedSearch(t){this.socket.on("refined_search",t)}onFollowUp(t){this.socket.on("follow_up",t)}onInquiry(t){this.socket.on("inquiry",t)}onPartialInquiry(t){this.socket.on("partial_inquiry",t)}onDisplayProducts(t){this.socket.on("display_products",t)}onDone(t){this.socket.on("done",t)}onError(t){this.socket.on("error",t)}disconnect(){this.socket.disconnect()}onDisconnect(t){this.socket.on("disconnect",t)}};

package/dist/index.esm.js

@@ -0,0 +1 @@
+import t from"socket.io-client";class e{constructor({apiKey:e,baseUrl:o,namespace:s="/copilot",socketioPath:i="/api/v1/socket.io",transports:c=["polling","websocket"],upgradeTransport:n=!0,timeout:a=1e4}){this.apiKey=e,this.baseUrl=o,this.timeout=a;const r=`${o}${s}`;this.socket=t(r,{path:i,withCredentials:!0,transports:c,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":e}}},upgrade:n})}search({userPrompt:t,searchParams:e},o=null){const s={user_prompt:t,search_params:e};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:t},e=null){const o={search_params:t};e?this.socket.emit("faceted_navigation",o,e):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:t,reason:e},o=null){const s={event_id:t,reason:e};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(t){this.socket.emit("session_info",t)}onConnectAck(t){this.socket.on("connect_ack",t)}onSearchAck(t){this.socket.on("search_ack",t)}onRefinedSearch(t){this.socket.on("refined_search",t)}onFollowUp(t){this.socket.on("follow_up",t)}onInquiry(t){this.socket.on("inquiry",t)}onPartialInquiry(t){this.socket.on("partial_inquiry",t)}onDisplayProducts(t){this.socket.on("display_products",t)}onDone(t){this.socket.on("done",t)}onError(t){this.socket.on("error",t)}disconnect(){this.socket.disconnect()}onDisconnect(t){this.socket.on("disconnect",t)}}export{e as CimulateCopilot};

package/dist/index.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("socket.io-client")):"function"==typeof define&&define.amd?define(["exports","socket.io-client"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).CimulateCopilot={},e.io)}(this,(function(e,t){"use strict";function o(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var s=o(t);e.CimulateCopilot=class{constructor({apiKey:e,baseUrl:t,namespace:o="/copilot",socketioPath:i="/api/v1/socket.io",transports:n=["polling","websocket"],upgradeTransport:c=!0,timeout:a=1e4}){this.apiKey=e,this.baseUrl=t,this.timeout=a;const r=`${t}${o}`;this.socket=s.default(r,{path:i,withCredentials:!0,transports:n,transportOptions:{polling:{extraHeaders:{"x-cimulate-api-key":e}}},upgrade:c})}search({userPrompt:e,searchParams:t},o=null){const s={user_prompt:e,search_params:t};o?this.socket.emit("copilot_search",s,o):this.socket.emit("copilot_search",s)}facetedNavigation({searchParams:e},t=null){const o={search_params:e};t?this.socket.emit("faceted_navigation",o,t):this.socket.emit("faceted_navigation",o)}cancelRequest({eventId:e,reason:t},o=null){const s={event_id:e,reason:t};o?this.socket.emit("cancel",s,o):this.socket.emit("cancel",s)}requestSessionData(e){this.socket.emit("session_info",e)}onConnectAck(e){this.socket.on("connect_ack",e)}onSearchAck(e){this.socket.on("search_ack",e)}onRefinedSearch(e){this.socket.on("refined_search",e)}onFollowUp(e){this.socket.on("follow_up",e)}onInquiry(e){this.socket.on("inquiry",e)}onPartialInquiry(e){this.socket.on("partial_inquiry",e)}onDisplayProducts(e){this.socket.on("display_products",e)}onDone(e){this.socket.on("done",e)}onError(e){this.socket.on("error",e)}disconnect(){this.socket.disconnect()}onDisconnect(e){this.socket.on("disconnect",e)}},Object.defineProperty(e,"__esModule",{value:!0})}));

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@cimulate/copilot-sdk",
+  "version": "1.0.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",
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "keywords": [],
+  "author": "support@cimulate.ai",
+  "license": "MIT",
+  "dependencies": {
+    "socket.io-client": "^4.7.5"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.7",
+    "@babel/preset-env": "^7.26.7",
+    "@babel/preset-react": "^7.26.3",
+    "@rollup/plugin-commonjs": "^21.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.0",
+    "babel-loader": "^9.2.1",
+    "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",
+    "webpack": "^5.97.1",
+    "webpack-cli": "^6.0.1",
+    "webpack-node-externals": "^3.0.0"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,68 @@
+import { defineConfig } from 'rollup';
+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 polyfillNode from 'rollup-plugin-polyfill-node';
+
+export default defineConfig({
+  input: 'src/index.js',
+  output: [
+    {
+      dir: 'dist',
+      entryFileNames: `bundle.cimulate.copilot-sdk.[hash].esm.js`,
+      format: 'esm',
+      sourcemap: true,
+    },
+    {
+      dir: 'dist',
+      entryFileNames: `bundle.cimulate.copilot-sdk.[hash].cjs.js`,
+      format: 'cjs',
+      sourcemap: true,
+    },
+    {
+      dir: 'dist',        
+      entryFileNames: `bundle.cimulate.copilot-sdk.[hash].umd.js`,
+      format: 'umd',
+      name: 'CimulateCopilot',
+      sourcemap: true,
+      globals: {
+        'socket.io-client': 'io',
+      },      
+    },
+    {
+      dir: 'dist',
+      entryFileNames: `index.esm.js`,
+      format: 'esm',
+      sourcemap: false,
+    },
+    {
+      dir: 'dist',
+      entryFileNames: `index.cjs.js`,
+      format: 'cjs',
+      sourcemap: false,
+    },
+    {
+      dir: 'dist',
+      entryFileNames: `index.umd.js`,
+      format: 'umd',
+      name: 'CimulateCopilot',
+      sourcemap: false,
+      globals: {
+        'socket.io-client': 'io',
+      },
+    },
+  ],
+  plugins: [
+    resolve(),
+    commonjs(),
+    json(),
+    terser(),
+    outputHash({
+        hashLength: 8,
+        include: ['**/*.js'],
+    }),
+  ],
+  external: ['socket.io-client'],
+});

package/src/copilot.js

@@ -0,0 +1,116 @@
+import io from 'socket.io-client';
+
+class CimulateCopilot {
+    constructor({
+        apiKey,
+        baseUrl,
+        namespace = '/copilot',
+        socketioPath = '/api/v1/socket.io',
+        transports = ['polling', 'websocket'],
+        upgradeTransport = true,
+        timeout = 10000
+    }){
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+        this.timeout = timeout;
+        const socketioEndpoint = `${baseUrl}${namespace}`;
+        this.socket = io(socketioEndpoint, { 
+            path: socketioPath,
+            withCredentials: true, // enables cookies
+            transports: transports,
+            transportOptions: {
+                polling: {
+                    extraHeaders: {
+                        'x-cimulate-api-key': apiKey,
+                    },
+                },
+            },
+            upgrade: upgradeTransport
+        });
+    }
+
+    search({ userPrompt, searchParams }, callback = null){
+        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 }, callback = null){
+        const payload = {
+            search_params: searchParams,
+        }
+        if (callback){
+            this.socket.emit('faceted_navigation', payload, callback);
+            return;
+        }
+        this.socket.emit('faceted_navigation', payload);
+    }
+
+    cancelRequest({ eventId, reason }, callback = null){
+        const payload = {
+            event_id: eventId,
+            reason,
+        }
+        if (callback){
+            this.socket.emit('cancel', payload, callback);
+            return;
+        }
+        this.socket.emit('cancel', payload);
+    }
+
+    requestSessionData(callback){
+        this.socket.emit('session_info', callback);
+    }
+
+    onConnectAck(callback){
+        this.socket.on('connect_ack', callback);
+    }
+
+    onSearchAck(callback){
+        this.socket.on('search_ack', callback);
+    }
+
+    onRefinedSearch(callback){
+        this.socket.on('refined_search', callback);
+    }
+
+    onFollowUp(callback){
+        this.socket.on('follow_up', callback);
+    }
+
+    onInquiry(callback){
+        this.socket.on('inquiry', callback);
+    }
+
+    onPartialInquiry(callback){
+        this.socket.on('partial_inquiry', callback);
+    }
+
+    onDisplayProducts(callback){
+        this.socket.on('display_products', callback);
+    }
+
+    onDone(callback){
+        this.socket.on('done', callback);
+    }
+
+    onError(callback){
+        this.socket.on('error', callback);
+    }
+
+    disconnect(){
+        this.socket.disconnect();
+    }
+
+    onDisconnect(callback){
+        this.socket.on('disconnect', callback);
+    }
+}
+
+export default CimulateCopilot;

package/src/index.js

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