@cobrowser/chatgpt 0.7.30 → 0.7.31-beta.1

package/dist/constants.d.ts

@@ -10,4 +10,4 @@ export declare const DEFAULT_PROMPT = "\n  You are a helpful assistant. Your rol
 export declare const DESTINATION_LANGUAGE = "English";
 export declare const LANGUAGE_DETECTION_SYSTEM_ROLE = "\n  You are a language detection assistant. Your task is to analyze short text input and determine \n  its language using ISO language code. Respond only in JSON format with two key-value pairs: \n  - 'languageCode': the detected language's ISO code (or undefined if detection fails).\n  - 'isError': a boolean value (true if detection fails, false otherwise).\n";
 export declare const WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = "\n  You are a language detection assistant. Your task is to analyze the most frequently occurring words in the given text \n  and determine the language based on those words. Respond only in JSON format with two key-value pairs: \n  - 'languageCode': the detected language's ISO code (or undefined if detection fails).\n  - 'isError': a boolean value (true if detection fails, false otherwise).\n";
-export declare const TRANSLATION_SYSTEM_ROLE = "\n  You are a translator that responds exclusively in JSON format. Your response must be a JSON object containing:\n  - 'data': it is an array of objects. Each object in the array must contain:\n    - 'translated_message': The original input message before translation.\n    - 'translation: The translated version of 'translated_message', ensuring it is natural, culturally appropriate, and commonly used by native speakers.\n  - 'isError': a boolean value (true if translation fails, false otherwise).\n\n  **You MUST return the JSON format even if you fail to translate the text. In this case, data field will be empty array and isError should be true.** \n\n  Ensure that 'translation' accurately represents the meaning of 'translated_message' while considering cultural nuances, usual expressions, and natural phrasing in the target language.\n\n  Your response must follow this structure strictly.\n";
+export declare const TRANSLATION_SYSTEM_ROLE = "\n  You are a translator that responds exclusively in JSON format. Your response must be a JSON object containing:\n  - 'translations': it is an array of objects. Each object in the array must contain:\n    - 'original': The original input message before translation.\n    - 'translation: The translated version of 'original', ensuring it is natural, culturally appropriate, and commonly used by native speakers.\n  - 'isError': a boolean value (true if translation fails, false otherwise).\n\n  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** \n\n  Ensure that 'translation' accurately represents the meaning of 'original' while considering cultural nuances, usual expressions, and natural phrasing in the target language.\n\n  Your response must follow this structure strictly.\n";

package/dist/constants.js

@@ -53,14 +53,14 @@ exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = `
 // Message translation system role
 exports.TRANSLATION_SYSTEM_ROLE = `
   You are a translator that responds exclusively in JSON format. Your response must be a JSON object containing:
-  - 'data': it is an array of objects. Each object in the array must contain:
-    - 'translated_message': The original input message before translation.
-    - 'translation: The translated version of 'translated_message', ensuring it is natural, culturally appropriate, and commonly used by native speakers.
+  - 'translations': it is an array of objects. Each object in the array must contain:
+    - 'original': The original input message before translation.
+    - 'translation: The translated version of 'original', ensuring it is natural, culturally appropriate, and commonly used by native speakers.
   - 'isError': a boolean value (true if translation fails, false otherwise).
 
-  **You MUST return the JSON format even if you fail to translate the text. In this case, data field will be empty array and isError should be true.** 
+  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** 
 
-  Ensure that 'translation' accurately represents the meaning of 'translated_message' while considering cultural nuances, usual expressions, and natural phrasing in the target language.
+  Ensure that 'translation' accurately represents the meaning of 'original' while considering cultural nuances, usual expressions, and natural phrasing in the target language.
 
   Your response must follow this structure strictly.
 `;

package/dist/models/ChatGPTResponse.d.ts

@@ -0,0 +1,8 @@
+import ChatGPTUsageTokens from './ChatGPTUsageTokens';
+interface ChatGPTResponse {
+    data?: string;
+    usageTokens?: ChatGPTUsageTokens;
+    threadId?: string;
+    requiredActions?: string;
+}
+export default ChatGPTResponse;

package/dist/models/ChatGPTResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/ChatGPTUsageTokens.d.ts

@@ -0,0 +1,6 @@
+interface ChatGPTUsageTokens {
+    prompt_tokens: Number;
+    completion_tokens: Number;
+    total_tokens: Number;
+}
+export default ChatGPTUsageTokens;

package/dist/models/ChatGPTUsageTokens.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/AssistantService/AssistantService.d.ts

@@ -1,5 +1,5 @@
 import { AssistantResponseFormatOption } from 'openai/resources/beta/threads/threads';
-import ChatGptResponse from '../../models/ChatGptResponse';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 import BaseService from '../BaseService/BaseService';
 export declare class AssistantService extends BaseService {
     assistantId: string | undefined;
@@ -22,5 +22,5 @@ export declare class AssistantService extends BaseService {
         tools?: any[];
         functionOutputs?: string;
         definedSchema?: AssistantResponseFormatOption;
-    }): Promise<ChatGptResponse | undefined>;
+    }): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/AssistantService/AssistantService.js

@@ -99,9 +99,9 @@ class AssistantService extends BaseService_1.default {
                 const messages = data.flatMap((message) => message === null || message === void 0 ? void 0 : message.content.map((content) => ((content.type === 'text' && message.role === 'assistant') ? content.text : '')));
                 const assistantMessages = messages.filter(message => typeof message === 'object' && 'value' in message && typeof message.value === 'string');
                 if (assistantMessages.length) {
-                    let answer = assistantMessages.map(message => this.output(message.value, true)).join('\n');
+                    let answer = assistantMessages.map(message => message.value).join('\n');
                     return {
-                        firstChoice: answer.replace(/【.*?】/g, ''),
+                        data: answer.replace(/【.*?】/g, ''),
                         threadId: run.thread_id,
                         usageTokens: run.usage,
                     };

package/dist/services/BaseService/BaseService.d.ts

@@ -1,20 +1,30 @@
 import { AxiosError, AxiosInstance, AxiosResponse } from 'axios';
-import ChatGptUsageTokens from '../../models/ChatGptUsageTokens';
+import ChatGPTUsageTokens from '../../models/ChatGPTUsageTokens';
+interface Response<Data = any> {
+    result: Data;
+}
 declare class BaseService {
-    request: AxiosInstance;
     readonly BASE_CHAT_COMPLETION_URL = "https://api.openai.com/v1/chat/completions";
+    request: AxiosInstance;
     openaiApiKey: string | undefined;
     chatGptModel: string;
     maxNumberOfChatCompletionResult: number;
     /**
-     *
      * @param apiKey
      * @param model the main chatGPT model to use
      * @param apiUrl Api url to be used to make API calls to openAI services
      * @param maxNumberOfChoices How many chat completion choices to generate for each request.
-     *
      */
     constructor(apiKey?: string | undefined, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
+    /**
+     * Automatically wraps all async methods to sanitize their return values
+     * This ensures ALL service methods are automatically sanitized without any developer intervention
+     */
+    private processAsyncMethods;
+    /**
+     * Recursively sanitizes any value
+     */
+    private clean;
     /**
      * Filter the response from chatGpt API and only get the first choice
      * @param response
@@ -24,17 +34,12 @@ declare class BaseService {
      * Filter the response from chatGpt API and get the usage tokens
      * @param response
      */
-    getResponseUsageTokens(response: AxiosResponse): ChatGptUsageTokens | undefined;
+    getResponseUsageTokens(response: AxiosResponse): ChatGPTUsageTokens | undefined;
     /**
      * function to handle requests errors
      * @param error
      */
     handleErrors(error: AxiosError): void;
-    /**
-     * Sanitize ChatGPT response with our XSS validation package
-     *
-     * @param data
-     */
-    output(data: any, shouldStringify?: boolean): any;
+    protected response<Data>(data: Data): Response<Data>;
 }
 export default BaseService;

package/dist/services/BaseService/BaseService.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,25 +17,23 @@ const xss_validation_1 = require("@cobrowser/xss-validation");
 const logger_1 = __importDefault(require("../logger"));
 class BaseService {
     /**
-     *
      * @param apiKey
      * @param model the main chatGPT model to use
      * @param apiUrl Api url to be used to make API calls to openAI services
      * @param maxNumberOfChoices How many chat completion choices to generate for each request.
-     *
      */
     constructor(apiKey = process.env.OPEN_AI_API_KEY, model = 'gpt-4o', apiUrl, maxNumberOfChoices = 1) {
-        Object.defineProperty(this, "request", {
+        Object.defineProperty(this, "BASE_CHAT_COMPLETION_URL", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: void 0
+            value: 'https://api.openai.com/v1/chat/completions'
         });
-        Object.defineProperty(this, "BASE_CHAT_COMPLETION_URL", {
+        Object.defineProperty(this, "request", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 'https://api.openai.com/v1/chat/completions'
+            value: void 0
         });
         Object.defineProperty(this, "openaiApiKey", {
             enumerable: true,
@@ -56,6 +63,64 @@ class BaseService {
         this.openaiApiKey = apiKey;
         this.chatGptModel = model;
         this.maxNumberOfChatCompletionResult = maxNumberOfChoices;
+        // Automatically wrap all async methods that return ChatGpt responses
+        this.processAsyncMethods();
+    }
+    /**
+     * Automatically wraps all async methods to sanitize their return values
+     * This ensures ALL service methods are automatically sanitized without any developer intervention
+     */
+    processAsyncMethods() {
+        const proto = Object.getPrototypeOf(this), methodNames = Object.getOwnPropertyNames(proto);
+        console.log('BASE SERVICE processAsyncMethods methodNames: ', methodNames);
+        for (const methodName of methodNames) {
+            const method = proto[methodName];
+            console.log('BASE SERVICE processAsyncMethods method: ', method);
+            // Skip constructor, non-functions, and utility methods
+            // But include service methods like getReply, getAssistant, etc.
+            if (methodName === 'constructor' ||
+                typeof method !== 'function' ||
+                (methodName.startsWith('get') && !methodName.startsWith('getReply') && !methodName.startsWith('getAssist')) ||
+                methodName.startsWith('handle') ||
+                methodName.includes('Sanitize') ||
+                methodName.includes('sanitize')) {
+                continue;
+            }
+            const originalMethod = method.bind(this);
+            // Replace the method with a sanitizing wrapper
+            this[methodName] = (...args) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const result = this.response(yield originalMethod(...args)), sanitizedResult = this.clean(result);
+                    console.log('BASE SERVICE processAsyncMethods sanitizedResult: ', sanitizedResult);
+                    return sanitizedResult;
+                }
+                catch (error) {
+                    throw error;
+                }
+            });
+        }
+    }
+    /**
+     * Recursively sanitizes any value
+     */
+    clean(value) {
+        console.log('BASE SERVICE clean value: ', value);
+        if (!value) {
+            return;
+        }
+        // Data could be plain string or JSON string. 
+        if (typeof value === 'string') {
+            try {
+                value = JSON.parse(value);
+            }
+            catch (error) { }
+        }
+        const sanitized = xss_validation_1.XSSProtector.sanitize(value), encoded = xss_validation_1.XSSProtector.encode(sanitized);
+        console.log('BASE SERVICE clean sanitized sssss: ', sanitized);
+        console.log('BASE SERVICE clean encoded: ', encoded);
+        console.log('BASE SERVICE clean encoded data: ', encoded.result.data);
+        logger_1.default.info({ value, sanitized, encoded }, ':: Sanitized Response ::');
+        return encoded;
     }
     /**
      * Filter the response from chatGpt API and only get the first choice
@@ -66,7 +131,7 @@ class BaseService {
         if ((_a = response.data.choices) === null || _a === void 0 ? void 0 : _a.length) {
             const firstChatGptResponseMessage = response.data.choices[0].message;
             logger_1.default.info(`First ChatGpt Message: ${firstChatGptResponseMessage.content}`);
-            return firstChatGptResponseMessage.content;
+            return JSON.parse(firstChatGptResponseMessage.content);
         }
         return undefined;
     }
@@ -100,25 +165,10 @@ class BaseService {
         }
         logger_1.default.error(`error message ${error.message}`);
     }
-    /**
-     * Sanitize ChatGPT response with our XSS validation package
-     *
-     * @param data
-     */
-    output(data, shouldStringify = false) {
-        if (!data) {
-            return;
-        }
-        // Data could be plain string or JSON string. 
-        if (typeof data === 'string') {
-            try {
-                data = JSON.parse(data);
-            }
-            catch (error) { }
-        }
-        const sanitized = xss_validation_1.XSSProtector.sanitize(data), encoded = xss_validation_1.XSSProtector.encode(sanitized);
-        logger_1.default.info({ data, sanitized, encoded }, ':: Sanitized Response ::');
-        return shouldStringify ? JSON.stringify(encoded) : encoded;
+    response(data) {
+        return {
+            result: data,
+        };
     }
 }
 exports.default = BaseService;

package/dist/services/ChatService/ChatService.js

@@ -48,7 +48,7 @@ class ChatService extends BaseService_1.default {
             logger_1.default.info(`:: ChatService.ask :: ${JSON.stringify(requestBody)}`);
             try {
                 const response = yield this.request.post('', requestBody);
-                return this.output(this.getResponseFirstChoice(response), true);
+                return this.getResponseFirstChoice(response);
             }
             catch (e) {
                 this.handleErrors(e);

package/dist/services/CopilotService/CopilotService.d.ts

@@ -1,7 +1,7 @@
 import ChatGptMessage from '../../models/ChatGptMessage';
 import Item from '../../models/Item';
 import BaseService from '../BaseService/BaseService';
-import ChatGptResponse from '../../models/ChatGptResponse';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 export declare class CopilotService extends BaseService {
     assistantId: string | undefined;
     threadId: string | undefined;
@@ -18,17 +18,17 @@ export declare class CopilotService extends BaseService {
      * this will make it easy to ask chatGpt for quick replies
      * @param conversation
      */
-    suggest(conversation: string): Promise<ChatGptResponse | undefined>;
+    suggest(conversation: string): Promise<ChatGPTResponse | undefined>;
     /**
      * this will request chatGPT to recommend product or item based on the whole conversation
      * @param conversation the whole chat conversation
      * @param items the items to recommend from
      */
-    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<any>;
+    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<string | undefined>;
     /**
      * Get the reply of the assistant if the assistant_id is available
      *
      * @param message
      */
-    getAssistantReply(message: string): Promise<ChatGptResponse | undefined>;
+    getAssistantReply(message: string): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/CopilotService/CopilotService.js

@@ -80,7 +80,7 @@ class CopilotService extends BaseService_1.default {
                     messages: [mainPromptMessage],
                 }, response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.output(this.getResponseFirstChoice(response), true),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }
@@ -114,7 +114,7 @@ class CopilotService extends BaseService_1.default {
                     model: this.chatGptModel,
                     messages: [firstMessage, ...conversation],
                 }, response = yield this.request.post('', requestBody);
-                return this.output(this.getResponseFirstChoice(response), true);
+                return this.getResponseFirstChoice(response);
             }
             catch (e) {
                 this.handleErrors(e);
@@ -158,7 +158,7 @@ class CopilotService extends BaseService_1.default {
                 if (assistantMessages.length) {
                     let answers = assistantMessages.map(message => message.value);
                     return {
-                        firstChoice: this.output((answers), true),
+                        data: JSON.stringify(answers),
                         threadId: run.thread_id,
                         usageTokens: run.usage,
                     };

package/dist/services/TranslationService/TranslationService.d.ts

@@ -1,5 +1,5 @@
 import BaseService from '../BaseService/BaseService';
-import ChatGptResponse from '../../models/ChatGptResponse';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 export declare class TranslationService extends BaseService {
     constructor(apiKey?: string, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
@@ -9,17 +9,17 @@ export declare class TranslationService extends BaseService {
      * @param toLanguage    the desired language to translate to ( English is the default )
      * @param fromLanguage  if we want to specify the language of the text, we can use this ( optional)
      */
-    translate(text: string, toLanguage?: string, fromLanguage?: string): Promise<ChatGptResponse | undefined>;
+    translate(text: string, toLanguage?: string, fromLanguage?: string): Promise<ChatGPTResponse | undefined>;
     /**
      * Detects the ISO language code of a text
      *
      * @param text text to detect
      */
-    findTextLanguage(text: string): Promise<ChatGptResponse | undefined>;
+    findTextLanguage(text: string): Promise<ChatGPTResponse | undefined>;
     /**
      * Detects the ISO language code of a text based on frequency of words
      *
      * @param text text to detect
      */
-    findTextLanguageBasedOnFrequency(text: string): Promise<ChatGptResponse | undefined>;
+    findTextLanguageBasedOnFrequency(text: string): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/TranslationService/TranslationService.js

@@ -55,9 +55,10 @@ class TranslationService extends BaseService_1.default {
                 logger_1.default.info({ requestBody }, ':: TranslationServicee.translate :: Translating ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.output(this.getResponseFirstChoice(response), true),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
+                // return response.data;
             }
             catch (e) {
                 this.handleErrors(e);
@@ -94,7 +95,7 @@ class TranslationService extends BaseService_1.default {
                 logger_1.default.info({ requestBody }, ':: TranslationServicee.findTextLanguage :: Finding text language ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.output(this.getResponseFirstChoice(response), true),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }
@@ -133,7 +134,7 @@ class TranslationService extends BaseService_1.default {
                 logger_1.default.info({ requestBody }, ':: TranslationServicee.findTextLanguageBasedOnFrequency :: Finding text language ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.output(this.getResponseFirstChoice(response), true),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.7.30",
+  "version": "0.7.31-beta.1",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -22,7 +22,6 @@
   },
   "dependencies": {
     "@cobrowser/logger": "^2.0.2",
-    "@cobrowser/xss-validation": "^2.0.1",
     "axios": "^1.6.1",
     "axios-mock-adapter": "^1.22.0",
     "openai": "^4.86.2"
@@ -40,5 +39,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "c8747e61dff13093fa0593dd4a3219ff11eb7b82"
+  "gitHead": "4f4def1cb16e7e16058f1a50902551b1b1d35d47"
 }