Merge branch 'feat/CW-6153' of github.com:chatwoot/chatwoot into feat/CW-6153

app/javascript/dashboard/api/integrations/openapi.js

@@ -0,0 +1,83 @@
+/* global axios */
+
+import ApiClient from '../ApiClient';
+
+/**
+ * Represents the data object for a OpenAI hook.
+ * @typedef {Object} ConversationMessageData
+ * @property {string} [tone] - The tone of the message.
+ * @property {string} [content] - The content of the message.
+ * @property {string} [conversation_display_id] - The display ID of the conversation (optional).
+ */
+
+/**
+ * A client for the OpenAI API.
+ * @extends ApiClient
+ */
+class OpenAIAPI extends ApiClient {
+  /**
+   * Creates a new OpenAIAPI instance.
+   */
+  constructor() {
+    super('integrations', { accountScoped: true });
+
+    /**
+     * The conversation events supported by the API.
+     * @type {string[]}
+     */
+    this.conversation_events = [
+      'summarize',
+      'reply_suggestion',
+      'label_suggestion',
+    ];
+  }
+
+  /**
+   * Processes an event using the OpenAI API.
+   * @param {Object} options - The options for the event.
+   * @param {string} [options.type='improve'] - The type of event to process.
+   * @param {string} [options.content] - The content of the event.
+   * @param {string} [options.tone] - The tone of the event.
+   * @param {string} [options.conversationId] - The ID of the conversation to process the event for.
+   * @param {string} options.hookId - The ID of the hook to use for processing the event.
+   * @param {AbortSignal} [signal] - AbortSignal to cancel the request.
+   * @returns {Promise} A promise that resolves with the result of the event processing.
+   */
+  processEvent(
+    { type = 'improve', content, tone, conversationId, hookId },
+    signal
+  ) {
+    /**
+     * @type {ConversationMessageData}
+     */
+    let data = {
+      tone,
+      content,
+    };
+
+    // Always include conversation_display_id when available for session tracking
+    if (conversationId) {
+      data.conversation_display_id = conversationId;
+    }
+
+    // For conversation-level events, only send conversation_display_id
+    if (this.conversation_events.includes(type)) {
+      data = {
+        conversation_display_id: conversationId,
+      };
+    }
+
+    return axios.post(
+      `${this.url}/hooks/${hookId}/process_event`,
+      {
+        event: {
+          name: type,
+          data,
+        },
+      },
+      { signal }
+    );
+  }
+}
+
+export default new OpenAIAPI();

app/javascript/dashboard/components/widgets/AIAssistanceModal.vue

@@ -48,7 +48,7 @@ export default {
       this.$emit('close');
     },
 
-    async generateAIContent(type = 'rephrase') {
+    async generateAIContent(type = 'improve') {
       this.isGenerating = true;
       this.generatedContent = await this.processEvent(type);
       this.isGenerating = false;

app/javascript/dashboard/components/widgets/WootWriter/CopilotMenuBar.vue

@@ -163,10 +163,7 @@ const handleMenuItemClick = item => {
 };
 
 const handleSubMenuItemClick = (parentItem, subItem) => {
-  emit('executeCopilotAction', subItem.key, {
-    parentKey: parentItem.key,
-    tone: subItem.label.toLowerCase(),
-  });
+  emit('executeCopilotAction', subItem.key);
 };
 </script>
 

app/javascript/dashboard/components/widgets/WootWriter/Editor.vue

@@ -191,12 +191,12 @@ const imageUpload = useTemplateRef('imageUpload');
 const editor = useTemplateRef('editor');
 
 const handleCopilotAction = actionKey => {
-  if (actionKey === 'rephrase_selection' && editorView?.state) {
+  if (actionKey === 'improve_selection' && editorView?.state) {
     const { from, to } = editorView.state.selection;
     const selectedText = editorView.state.doc.textBetween(from, to).trim();
 
     if (from !== to && selectedText) {
-      emit('executeCopilotAction', 'rephrase', selectedText);
+      emit('executeCopilotAction', 'improve', selectedText);
     }
   } else {
     emit('executeCopilotAction', actionKey);

app/javascript/dashboard/composables/useAI.js

@@ -149,18 +149,14 @@ export function useAI() {
   };
 
   /**
-   * Processes an AI event, such as rephrasing content.
-   * @param {string} [type='rephrase'] - The type of AI event to process.
+   * Processes an AI event, such as improving content.
+   * @param {string} [type='improve'] - The type of AI event to process.
    * @param {string} [content=''] - The content to process (for full message) or selected text (for selection-based).
    * @param {Object} [options={}] - Additional options.
    * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
    * @returns {Promise<string>} The generated message or an empty string if an error occurs.
    */
-  const processEvent = async (
-    type = 'rephrase',
-    content = '',
-    options = {}
-  ) => {
+  const processEvent = async (type = 'improve', content = '', options = {}) => {
     try {
       const result = await EditorAPI.processEvent(
         {

app/javascript/dashboard/composables/useCopilotReply.js

@@ -55,7 +55,7 @@ export function useCopilotReply() {
   }
 
   /**
-   * Executes a copilot action (e.g., rephrase, fix grammar).
+   * Executes a copilot action (e.g., improve, fix grammar).
    * @param {string} action - The action type
    * @param {string} data - The content to process
    */

app/javascript/dashboard/helper/AnalyticsHelper/events.js

@@ -88,6 +88,7 @@ export const OPEN_AI_EVENTS = Object.freeze({
   SUMMARIZE: 'OpenAI: Used summarize',
   REPLY_SUGGESTION: 'OpenAI: Used reply suggestion',
   REPHRASE: 'OpenAI: Used rephrase',
+  IMPROVE: 'OpenAI: Used improve',
   FIX_SPELLING_AND_GRAMMAR: 'OpenAI: Used fix spelling and grammar',
   SHORTEN: 'OpenAI: Used shorten',
   EXPAND: 'OpenAI: Used expand',