@app-connect/core 1.7.24 → 1.7.26

package/mcp/tools/createCallLog.js

@@ -1,316 +1,327 @@
-const jwt = require('../../lib/jwt');
-const connectorRegistry = require('../../connector/registry');
-const logCore = require('../../handlers/log');
-const contactCore = require('../../handlers/contact');
-const util = require('../../lib/util');
-const { CallLogModel } = require('../../models/callLogModel');
-/**
- * MCP Tool: Create Call Log
- * 
- * This tool creates a call log in the CRM platform.
- */
-
-const toolDefinition = {
-    name: 'createCallLog',
-    description: '⚠️ REQUIRES CRM CONNECTION. | Create only one call log in the CRM platform. Returns the created log ID if successful. To use with `rcGetCallLogs`: pass a single item from the `records[]` array directly as `incomingData.logInfo`.',
-    inputSchema: {
-        type: 'object',
-        properties: {
-            incomingData: {
-                type: 'object',
-                description: 'Call log data to create',
-                properties: {
-                    logInfo: {
-                        type: 'object',
-                        description: 'A single record from `rcGetCallLogs` — pass the object exactly as returned, with no changes.',
-                        properties: {
-                            id: {
-                                type: 'string',
-                                description: 'Call log ID from RingCentral'
-                            },
-                            sessionId: {
-                                type: 'string',
-                                description: 'Unique session identifier for the call'
-                            },
-                            telephonySessionId: {
-                                type: 'string',
-                                description: 'Telephony session ID'
-                            },
-                            startTime: {
-                                type: 'string',
-                                description: 'Call start time in ISO 8601 format'
-                            },
-                            duration: {
-                                type: 'number',
-                                description: 'Call duration in seconds'
-                            },
-                            type: {
-                                type: 'string',
-                                description: 'Call type (e.g., Voice)'
-                            },
-                            direction: {
-                                type: 'string',
-                                description: 'Call direction: "Inbound" or "Outbound"'
-                            },
-                            action: {
-                                type: 'string',
-                                description: 'Call action (e.g., Phone Call)'
-                            },
-                            result: {
-                                type: 'string',
-                                description: 'Call result (e.g., Accepted, Missed, Voicemail)'
-                            },
-                            to: {
-                                type: 'object',
-                                description: 'Recipient information',
-                                properties: {
-                                    phoneNumber: {
-                                        type: 'string',
-                                        description: 'Recipient phone number in E.164 format'
-                                    },
-                                    name: {
-                                        type: 'string',
-                                        description: 'Recipient name'
-                                    }
-                                }
-                            },
-                            from: {
-                                type: 'object',
-                                description: 'Caller information',
-                                properties: {
-                                    phoneNumber: {
-                                        type: 'string',
-                                        description: 'Caller phone number in E.164 format'
-                                    },
-                                    name: {
-                                        type: 'string',
-                                        description: 'Caller name'
-                                    },
-                                    location: {
-                                        type: 'string',
-                                        description: 'Caller location'
-                                    }
-                                }
-                            },
-                            recording: {
-                                type: 'object',
-                                description: 'Recording information',
-                                properties: {
-                                    link: {
-                                        type: 'string',
-                                        description: 'Recording link URL'
-                                    }
-                                }
-                            },
-                            customSubject: {
-                                type: 'string',
-                                description: 'Custom subject for the call log'
-                            },
-                            legs: {
-                                type: 'array',
-                                description: 'Call legs information (for multi-party calls)',
-                                items: {
-                                    type: 'object'
-                                }
-                            },
-                            accountId: {
-                                type: 'string',
-                                description: 'RingCentral account ID'
-                            }
-                        },
-                        required: ['id', 'sessionId', 'direction', 'startTime', 'duration', 'to', 'from']
-                    },
-                    note: {
-                        type: 'string',
-                        description: 'User-entered call note/description'
-                    },
-                    aiNote: {
-                        type: 'string',
-                        description: 'AI-generated summary of the phone call'
-                    },
-                    transcript: {
-                        type: 'string',
-                        description: 'Call transcript text'
-                    },
-                    additionalSubmission: {
-                        type: 'object',
-                        description: 'Additional platform-specific custom fields (e.g., deals, matters, nonBillable flags, assigned users)',
-                        properties: {
-                            isAssignedToUser: {
-                                type: 'boolean',
-                                description: 'Whether to assign to a specific user'
-                            },
-                            adminAssignedUserToken: {
-                                type: 'string',
-                                description: 'JWT token of the assigned user'
-                            },
-                            adminAssignedUserRcId: {
-                                type: 'string',
-                                description: 'RingCentral extension ID of the assigned user'
-                            }
-                        }
-                    },
-                    contactName: {
-                        type: 'string',
-                        description: 'Contact name'
-                    },
-                    contactType: {
-                        type: 'string',
-                        description: 'Contact type'
-                    }
-                },
-                required: ['logInfo', 'contactName']
-            },
-            contactId: {
-                type: 'string',
-                description: 'OPTIONAL: CRM contact ID to associate with the call.'
-            }
-        },
-        required: ['incomingData']
-    },
-    annotations: {
-        readOnlyHint: false,
-        openWorldHint: true,
-        destructiveHint: false
-    }
-};
-
-/**
- * Execute the createCallLog tool
- * @param {Object} args - The tool arguments
- * @param {string} args.jwtToken - JWT token with user and platform info
- * @param {Object} args.incomingData - Call log data including logInfo (RingCentral call log schema), contactName, contactType, note, aiNote, transcript, and additionalSubmission
- * @param {Object} args.incomingData.logInfo - RingCentral call log information with sessionId, direction, startTime, duration, from, to, result, recording, customSubject, etc.
- * @param {string} [args.incomingData.contactName] - Contact name
- * @param {string} [args.incomingData.contactType] - Contact type in CRM
- * @param {string} [args.incomingData.note] - User-entered call note
- * @param {string} [args.incomingData.aiNote] - AI-generated call summary
- * @param {string} [args.incomingData.transcript] - Call transcript
- * @param {Object} [args.incomingData.additionalSubmission] - Platform-specific custom fields
- * @param {string} args.contactId - OPTIONAL: CRM contact ID to associate with the call
- * @returns {Object} Result object with created log ID
- */
-async function execute(args) {
-    try {
-        const { jwtToken, incomingData } = args;
-
-        if (!jwtToken) {
-            throw new Error('Please go to Settings and authorize CRM platform');
-        }
-
-        if (!incomingData) {
-            throw new Error('Incoming data must be provided');
-        }
-
-        // Validate logInfo exists
-        if (!incomingData.logInfo) {
-            throw new Error('incomingData.logInfo is required');
-        }
-
-        const { logInfo } = incomingData;
-
-        // Check in DB if the call log already exists
-        const existingCallLog = await CallLogModel.findOne({
-            where: {
-                sessionId: logInfo.sessionId
-            }
-        });
-        if (existingCallLog) {
-            throw new Error(`Call log already exists for session ${logInfo.sessionId}`);
-        }
-
-        // Decode JWT to get userId and platform
-        const decodedToken = jwt.decodeJwt(jwtToken);
-        if (!decodedToken) {
-            throw new Error('Invalid JWT token');
-        }
-        const { id: userId, platform } = decodedToken;
-
-        if (!userId) {
-            throw new Error('Invalid JWT token: userId not found');
-        }
-
-        // Get the platform connector module
-        const platformModule = connectorRegistry.getConnector(platform);
-
-        if (!platformModule) {
-            throw new Error(`Platform connector not found for: ${platform}`);
-        }
-
-        // Check if createCallLog is implemented
-        if (!platformModule.createCallLog) {
-            throw new Error(`createCallLog is not implemented for platform: ${platform}`);
-        }
-
-        // Calculate hashed account ID
-        const hashedAccountId = incomingData.logInfo?.accountId
-            ? util.getHashValue(incomingData.logInfo.accountId, process.env.HASH_KEY)
-            : undefined;
-
-        // Get contact Id from conversation
-        let contactId = args.contactId ?? null;
-        // Get contact Id from conversation if not provided
-        if (!contactId) {
-            const callDirection = logInfo.direction;
-            const contactNumber = callDirection === 'Inbound' ? logInfo.from.phoneNumber : logInfo.to.phoneNumber;
-            const contactInfo = await contactCore.findContact({
-                platform,
-                userId,
-                phoneNumber: contactNumber,
-                overridingFormat: '',
-                isExtension: false
-            });
-            const filteredContact = contactInfo.contact?.filter(c => !c.isNewContact);
-            if (contactInfo.successful && filteredContact?.length > 0) {
-                contactId = filteredContact[0].id;
-                incomingData.contactId = contactId;
-            }
-            else {
-                return {
-                    success: false,
-                    message: 'Cannot find the contact. Please create the contact first.',
-                    error: 'Failed to get contact with number ' + contactNumber
-                }
-            }
-        }
-        else {
-            incomingData.contactId = contactId;
-        }
-
-        // Call the createCallLog method
-        const { successful, logId, returnMessage } = await logCore.createCallLog({
-            platform,
-            userId,
-            incomingData,
-            hashedAccountId,
-            isFromSSCL: false
-        });
-
-        if (successful) {
-            return {
-                success: true,
-                data: {
-                    logId,
-                    message: returnMessage?.message || 'Call log created successfully'
-                }
-            };
-        }
-        else {
-            return {
-                success: false,
-                error: returnMessage?.message || 'Failed to create call log',
-            };
-        }
-    }
-    catch (error) {
-        return {
-            success: false,
-            error: error.message || 'Unknown error occurred',
-            errorDetails: error.stack
-        };
-    }
-}
-
-exports.definition = toolDefinition;
-exports.execute = execute;
-
+const jwt = require('../../lib/jwt');
+const connectorRegistry = require('../../connector/registry');
+const logCore = require('../../handlers/log');
+const contactCore = require('../../handlers/contact');
+const util = require('../../lib/util');
+const { CallLogModel } = require('../../models/callLogModel');
+const { buildCallLogSessionWhere, getCallLogExtensionNumber } = require('../../lib/callLogLookup');
+/**
+ * MCP Tool: Create Call Log
+ * 
+ * This tool creates a call log in the CRM platform.
+ */
+
+const toolDefinition = {
+    name: 'createCallLog',
+    description: '⚠️ REQUIRES CRM CONNECTION. | Create only one call log in the CRM platform. Returns the created log ID if successful. To use with `rcGetCallLogs`: pass a single item from the `records[]` array directly as `incomingData.logInfo`.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            incomingData: {
+                type: 'object',
+                description: 'Call log data to create',
+                properties: {
+                    logInfo: {
+                        type: 'object',
+                        description: 'A single record from `rcGetCallLogs` — pass the object exactly as returned, with no changes.',
+                        properties: {
+                            id: {
+                                type: 'string',
+                                description: 'Call log ID from RingCentral'
+                            },
+                            sessionId: {
+                                type: 'string',
+                                description: 'Unique session identifier for the call'
+                            },
+                            extensionNumber: {
+                                type: 'string',
+                                description: 'RingCentral extension number for this call log'
+                            },
+                            telephonySessionId: {
+                                type: 'string',
+                                description: 'Telephony session ID'
+                            },
+                            startTime: {
+                                type: 'string',
+                                description: 'Call start time in ISO 8601 format'
+                            },
+                            duration: {
+                                type: 'number',
+                                description: 'Call duration in seconds'
+                            },
+                            type: {
+                                type: 'string',
+                                description: 'Call type (e.g., Voice)'
+                            },
+                            direction: {
+                                type: 'string',
+                                description: 'Call direction: "Inbound" or "Outbound"'
+                            },
+                            action: {
+                                type: 'string',
+                                description: 'Call action (e.g., Phone Call)'
+                            },
+                            result: {
+                                type: 'string',
+                                description: 'Call result (e.g., Accepted, Missed, Voicemail)'
+                            },
+                            to: {
+                                type: 'object',
+                                description: 'Recipient information',
+                                properties: {
+                                    phoneNumber: {
+                                        type: 'string',
+                                        description: 'Recipient phone number in E.164 format'
+                                    },
+                                    name: {
+                                        type: 'string',
+                                        description: 'Recipient name'
+                                    }
+                                }
+                            },
+                            from: {
+                                type: 'object',
+                                description: 'Caller information',
+                                properties: {
+                                    phoneNumber: {
+                                        type: 'string',
+                                        description: 'Caller phone number in E.164 format'
+                                    },
+                                    name: {
+                                        type: 'string',
+                                        description: 'Caller name'
+                                    },
+                                    location: {
+                                        type: 'string',
+                                        description: 'Caller location'
+                                    }
+                                }
+                            },
+                            recording: {
+                                type: 'object',
+                                description: 'Recording information',
+                                properties: {
+                                    link: {
+                                        type: 'string',
+                                        description: 'Recording link URL'
+                                    }
+                                }
+                            },
+                            customSubject: {
+                                type: 'string',
+                                description: 'Custom subject for the call log'
+                            },
+                            legs: {
+                                type: 'array',
+                                description: 'Call legs information (for multi-party calls)',
+                                items: {
+                                    type: 'object'
+                                }
+                            },
+                            accountId: {
+                                type: 'string',
+                                description: 'RingCentral account ID'
+                            }
+                        },
+                        required: ['id', 'sessionId', 'direction', 'startTime', 'duration', 'to', 'from']
+                    },
+                    note: {
+                        type: 'string',
+                        description: 'User-entered call note/description'
+                    },
+                    aiNote: {
+                        type: 'string',
+                        description: 'AI-generated summary of the phone call'
+                    },
+                    transcript: {
+                        type: 'string',
+                        description: 'Call transcript text'
+                    },
+                    additionalSubmission: {
+                        type: 'object',
+                        description: 'Additional platform-specific custom fields (e.g., deals, matters, nonBillable flags, assigned users)',
+                        properties: {
+                            isAssignedToUser: {
+                                type: 'boolean',
+                                description: 'Whether to assign to a specific user'
+                            },
+                            adminAssignedUserToken: {
+                                type: 'string',
+                                description: 'JWT token of the assigned user'
+                            },
+                            adminAssignedUserRcId: {
+                                type: 'string',
+                                description: 'RingCentral extension ID of the assigned user'
+                            }
+                        }
+                    },
+                    contactName: {
+                        type: 'string',
+                        description: 'Contact name'
+                    },
+                    contactType: {
+                        type: 'string',
+                        description: 'Contact type'
+                    },
+                    extensionNumber: {
+                        type: 'string',
+                        description: 'RingCentral extension number for this call log'
+                    }
+                },
+                required: ['logInfo', 'contactName']
+            },
+            contactId: {
+                type: 'string',
+                description: 'OPTIONAL: CRM contact ID to associate with the call.'
+            }
+        },
+        required: ['incomingData']
+    },
+    annotations: {
+        readOnlyHint: false,
+        openWorldHint: true,
+        destructiveHint: false
+    }
+};
+
+/**
+ * Execute the createCallLog tool
+ * @param {Object} args - The tool arguments
+ * @param {string} args.jwtToken - JWT token with user and platform info
+ * @param {Object} args.incomingData - Call log data including logInfo (RingCentral call log schema), contactName, contactType, note, aiNote, transcript, and additionalSubmission
+ * @param {Object} args.incomingData.logInfo - RingCentral call log information with sessionId, direction, startTime, duration, from, to, result, recording, customSubject, etc.
+ * @param {string} [args.incomingData.contactName] - Contact name
+ * @param {string} [args.incomingData.contactType] - Contact type in CRM
+ * @param {string} [args.incomingData.note] - User-entered call note
+ * @param {string} [args.incomingData.aiNote] - AI-generated call summary
+ * @param {string} [args.incomingData.transcript] - Call transcript
+ * @param {Object} [args.incomingData.additionalSubmission] - Platform-specific custom fields
+ * @param {string} args.contactId - OPTIONAL: CRM contact ID to associate with the call
+ * @returns {Object} Result object with created log ID
+ */
+async function execute(args) {
+    try {
+        const { jwtToken, incomingData } = args;
+
+        if (!jwtToken) {
+            throw new Error('Please go to Settings and authorize CRM platform');
+        }
+
+        if (!incomingData) {
+            throw new Error('Incoming data must be provided');
+        }
+
+        // Validate logInfo exists
+        if (!incomingData.logInfo) {
+            throw new Error('incomingData.logInfo is required');
+        }
+
+        const { logInfo } = incomingData;
+        const extensionNumber = getCallLogExtensionNumber(incomingData);
+
+        // Check in DB if the call log already exists
+        const existingCallLog = await CallLogModel.findOne({
+            where: buildCallLogSessionWhere({
+                sessionId: logInfo.sessionId,
+                extensionNumber,
+            })
+        });
+        if (existingCallLog) {
+            throw new Error(`Call log already exists for session ${logInfo.sessionId}`);
+        }
+
+        // Decode JWT to get userId and platform
+        const decodedToken = jwt.decodeJwt(jwtToken);
+        if (!decodedToken) {
+            throw new Error('Invalid JWT token');
+        }
+        const { id: userId, platform } = decodedToken;
+
+        if (!userId) {
+            throw new Error('Invalid JWT token: userId not found');
+        }
+
+        // Get the platform connector module
+        const platformModule = connectorRegistry.getConnector(platform);
+
+        if (!platformModule) {
+            throw new Error(`Platform connector not found for: ${platform}`);
+        }
+
+        // Check if createCallLog is implemented
+        if (!platformModule.createCallLog) {
+            throw new Error(`createCallLog is not implemented for platform: ${platform}`);
+        }
+
+        // Calculate hashed account ID
+        const hashedAccountId = incomingData.logInfo?.accountId
+            ? util.getHashValue(incomingData.logInfo.accountId, process.env.HASH_KEY)
+            : undefined;
+
+        // Get contact Id from conversation
+        let contactId = args.contactId ?? null;
+        // Get contact Id from conversation if not provided
+        if (!contactId) {
+            const callDirection = logInfo.direction;
+            const contactNumber = callDirection === 'Inbound' ? logInfo.from.phoneNumber : logInfo.to.phoneNumber;
+            const contactInfo = await contactCore.findContact({
+                platform,
+                userId,
+                phoneNumber: contactNumber,
+                overridingFormat: '',
+                isExtension: false
+            });
+            const filteredContact = contactInfo.contact?.filter(c => !c.isNewContact);
+            if (contactInfo.successful && filteredContact?.length > 0) {
+                contactId = filteredContact[0].id;
+                incomingData.contactId = contactId;
+            }
+            else {
+                return {
+                    success: false,
+                    message: 'Cannot find the contact. Please create the contact first.',
+                    error: 'Failed to get contact with number ' + contactNumber
+                }
+            }
+        }
+        else {
+            incomingData.contactId = contactId;
+        }
+
+        // Call the createCallLog method
+        const { successful, logId, returnMessage } = await logCore.createCallLog({
+            platform,
+            userId,
+            incomingData,
+            hashedAccountId,
+            isFromSSCL: false
+        });
+
+        if (successful) {
+            return {
+                success: true,
+                data: {
+                    logId,
+                    message: returnMessage?.message || 'Call log created successfully'
+                }
+            };
+        }
+        else {
+            return {
+                success: false,
+                error: returnMessage?.message || 'Failed to create call log',
+            };
+        }
+    }
+    catch (error) {
+        return {
+            success: false,
+            error: error.message || 'Unknown error occurred',
+            errorDetails: error.stack
+        };
+    }
+}
+
+exports.definition = toolDefinition;
+exports.execute = execute;
+