@app-connect/core 1.7.25 → 1.7.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/.env.test +5 -5
  2. package/README.md +441 -441
  3. package/connector/developerPortal.js +31 -31
  4. package/connector/mock.js +84 -77
  5. package/connector/proxy/engine.js +164 -164
  6. package/connector/proxy/index.js +500 -500
  7. package/connector/registry.js +252 -252
  8. package/docs/README.md +50 -50
  9. package/docs/architecture.md +93 -93
  10. package/docs/connectors.md +116 -116
  11. package/docs/handlers.md +125 -125
  12. package/docs/libraries.md +101 -101
  13. package/docs/models.md +144 -144
  14. package/docs/routes.md +115 -115
  15. package/docs/tests.md +73 -73
  16. package/handlers/admin.js +523 -523
  17. package/handlers/appointment.js +193 -0
  18. package/handlers/auth.js +320 -296
  19. package/handlers/calldown.js +99 -99
  20. package/handlers/contact.js +280 -280
  21. package/handlers/disposition.js +82 -80
  22. package/handlers/log.js +990 -973
  23. package/handlers/managedAuth.js +446 -446
  24. package/handlers/managedOAuth.js +247 -0
  25. package/handlers/plugin.js +208 -208
  26. package/handlers/user.js +142 -142
  27. package/index.js +3162 -2652
  28. package/jest.config.js +56 -56
  29. package/lib/analytics.js +54 -54
  30. package/lib/authSession.js +109 -109
  31. package/lib/cacheCleanup.js +21 -0
  32. package/lib/callLogComposer.js +898 -898
  33. package/lib/callLogLookup.js +34 -0
  34. package/lib/constants.js +8 -8
  35. package/lib/debugTracer.js +177 -177
  36. package/lib/encode.js +30 -30
  37. package/lib/errorHandler.js +218 -206
  38. package/lib/generalErrorMessage.js +41 -41
  39. package/lib/jwt.js +18 -18
  40. package/lib/logger.js +190 -190
  41. package/lib/migrateCallLogsSchema.js +116 -0
  42. package/lib/ringcentral.js +266 -266
  43. package/lib/s3ErrorLogReport.js +65 -65
  44. package/lib/sharedSMSComposer.js +471 -471
  45. package/lib/util.js +67 -67
  46. package/mcp/README.md +412 -395
  47. package/mcp/lib/validator.js +91 -91
  48. package/mcp/mcpHandler.js +425 -425
  49. package/mcp/tools/cancelAppointment.js +101 -0
  50. package/mcp/tools/checkAuthStatus.js +105 -105
  51. package/mcp/tools/confirmAppointment.js +101 -0
  52. package/mcp/tools/createAppointment.js +157 -0
  53. package/mcp/tools/createCallLog.js +327 -316
  54. package/mcp/tools/createContact.js +117 -117
  55. package/mcp/tools/createMessageLog.js +287 -287
  56. package/mcp/tools/doAuth.js +60 -60
  57. package/mcp/tools/findContactByName.js +93 -93
  58. package/mcp/tools/findContactByPhone.js +101 -101
  59. package/mcp/tools/getCallLog.js +111 -102
  60. package/mcp/tools/getGoogleFilePicker.js +99 -99
  61. package/mcp/tools/getHelp.js +43 -43
  62. package/mcp/tools/getPublicConnectors.js +94 -94
  63. package/mcp/tools/getSessionInfo.js +90 -90
  64. package/mcp/tools/index.js +51 -41
  65. package/mcp/tools/listAppointments.js +163 -0
  66. package/mcp/tools/logout.js +99 -96
  67. package/mcp/tools/rcGetCallLogs.js +65 -65
  68. package/mcp/tools/updateAppointment.js +154 -0
  69. package/mcp/tools/updateCallLog.js +130 -126
  70. package/mcp/ui/App/App.tsx +358 -358
  71. package/mcp/ui/App/components/AuthInfoForm.tsx +113 -113
  72. package/mcp/ui/App/components/AuthSuccess.tsx +22 -22
  73. package/mcp/ui/App/components/ConnectorList.tsx +82 -82
  74. package/mcp/ui/App/components/DebugPanel.tsx +43 -43
  75. package/mcp/ui/App/components/OAuthConnect.tsx +270 -270
  76. package/mcp/ui/App/lib/callTool.ts +130 -130
  77. package/mcp/ui/App/lib/debugLog.ts +41 -41
  78. package/mcp/ui/App/lib/developerPortal.ts +111 -111
  79. package/mcp/ui/App/main.css +5 -5
  80. package/mcp/ui/App/root.tsx +13 -13
  81. package/mcp/ui/index.html +13 -13
  82. package/mcp/ui/package-lock.json +6356 -6356
  83. package/mcp/ui/package.json +25 -25
  84. package/mcp/ui/tsconfig.json +26 -26
  85. package/mcp/ui/vite.config.ts +16 -16
  86. package/models/accountDataModel.js +33 -33
  87. package/models/adminConfigModel.js +35 -35
  88. package/models/cacheModel.js +30 -26
  89. package/models/callDownListModel.js +34 -34
  90. package/models/callLogModel.js +33 -27
  91. package/models/dynamo/connectorSchema.js +146 -146
  92. package/models/dynamo/lockSchema.js +24 -24
  93. package/models/dynamo/noteCacheSchema.js +29 -29
  94. package/models/llmSessionModel.js +17 -17
  95. package/models/messageLogModel.js +25 -25
  96. package/models/sequelize.js +16 -16
  97. package/models/userModel.js +45 -45
  98. package/package.json +1 -1
  99. package/releaseNotes.json +1101 -1081
  100. package/test/connector/proxy/engine.test.js +126 -126
  101. package/test/connector/proxy/index.test.js +279 -279
  102. package/test/connector/proxy/sample.json +161 -161
  103. package/test/connector/registry.test.js +415 -415
  104. package/test/handlers/admin.test.js +616 -616
  105. package/test/handlers/auth.test.js +1092 -1018
  106. package/test/handlers/contact.test.js +1014 -1014
  107. package/test/handlers/log.test.js +1298 -1160
  108. package/test/handlers/managedAuth.test.js +457 -457
  109. package/test/handlers/plugin.test.js +380 -380
  110. package/test/index.test.js +105 -105
  111. package/test/lib/cacheCleanup.test.js +42 -0
  112. package/test/lib/callLogComposer.test.js +1231 -1231
  113. package/test/lib/debugTracer.test.js +328 -328
  114. package/test/lib/jwt.test.js +176 -176
  115. package/test/lib/logger.test.js +206 -206
  116. package/test/lib/oauth.test.js +359 -359
  117. package/test/lib/ringcentral.test.js +467 -467
  118. package/test/lib/sharedSMSComposer.test.js +1084 -1084
  119. package/test/lib/util.test.js +329 -329
  120. package/test/mcp/tools/checkAuthStatus.test.js +83 -83
  121. package/test/mcp/tools/createCallLog.test.js +436 -436
  122. package/test/mcp/tools/createContact.test.js +58 -58
  123. package/test/mcp/tools/createMessageLog.test.js +595 -595
  124. package/test/mcp/tools/doAuth.test.js +113 -113
  125. package/test/mcp/tools/findContactByName.test.js +275 -275
  126. package/test/mcp/tools/findContactByPhone.test.js +296 -296
  127. package/test/mcp/tools/getCallLog.test.js +298 -298
  128. package/test/mcp/tools/getGoogleFilePicker.test.js +281 -281
  129. package/test/mcp/tools/getPublicConnectors.test.js +107 -107
  130. package/test/mcp/tools/getSessionInfo.test.js +127 -127
  131. package/test/mcp/tools/logout.test.js +233 -233
  132. package/test/mcp/tools/rcGetCallLogs.test.js +56 -56
  133. package/test/mcp/tools/updateCallLog.test.js +360 -360
  134. package/test/models/accountDataModel.test.js +98 -98
  135. package/test/models/dynamo/connectorSchema.test.js +189 -189
  136. package/test/models/models.test.js +568 -539
  137. package/test/routes/managedAuthRoutes.test.js +235 -104
  138. package/test/setup.js +178 -178
@@ -1,102 +1,111 @@
1
- const jwt = require('../../lib/jwt');
2
- const connectorRegistry = require('../../connector/registry');
3
- const logCore = require('../../handlers/log');
4
-
5
- /**
6
- * MCP Tool: Get Call Log
7
- *
8
- * This tool retrieves call logs from the CRM platform by session IDs.
9
- */
10
-
11
- const toolDefinition = {
12
- name: 'getCallLog',
13
- description: '⚠️ REQUIRES AUTHENTICATION: User must first authenticate using the "auth" tool to obtain a JWT token before using this tool. | Get call logs from the CRM platform by session IDs. Returns log details if found.',
14
- inputSchema: {
15
- type: 'object',
16
- properties: {
17
- jwtToken: {
18
- type: 'string',
19
- description: 'JWT token containing userId and platform information. If user does not have this, direct them to use the "auth" tool first.'
20
- },
21
- sessionIds: {
22
- type: 'string',
23
- description: 'Session IDs to retrieve, seprated by commas'
24
- },
25
- requireDetails: {
26
- type: 'boolean',
27
- description: 'Whether to require detailed log information. If true, will call CRM API. Otherwise will just query in our own database',
28
- default: false
29
- }
30
- },
31
- required: ['jwtToken', 'sessionIds']
32
- }
33
- };
34
-
35
- /**
36
- * Execute the getCallLog tool
37
- * @param {Object} args - The tool arguments
38
- * @param {string} args.jwtToken - JWT token with user and platform info
39
- * @param {string} args.sessionIds - Session IDs to retrieve, seprated by commas
40
- * @param {boolean} [args.requireDetails] - Whether to require detailed log information. If true, will call CRM API. Otherwise will just query in our own database.
41
- * @returns {Object} Result object with call log information
42
- */
43
- async function execute(args) {
44
- try {
45
- const { jwtToken, sessionIds, requireDetails = false } = args;
46
-
47
- // Decode JWT to get userId and platform
48
- const decodedToken = jwt.decodeJwt(jwtToken);
49
- if (!decodedToken) {
50
- throw new Error('Invalid JWT token');
51
- }
52
- const { id: userId, platform } = decodedToken;
53
-
54
- if (!userId) {
55
- throw new Error('Invalid JWT token: userId not found');
56
- }
57
-
58
- // Get the platform connector module
59
- const platformModule = connectorRegistry.getConnector(platform);
60
-
61
- if (!platformModule) {
62
- throw new Error(`Platform connector not found for: ${platform}`);
63
- }
64
-
65
- // Check if getCallLog is implemented
66
- if (!platformModule.getCallLog) {
67
- throw new Error(`getCallLog is not implemented for platform: ${platform}`);
68
- }
69
-
70
- // Call the getCallLog method
71
- const { successful, logs, returnMessage } = await logCore.getCallLog({
72
- userId,
73
- sessionIds,
74
- platform,
75
- requireDetails
76
- });
77
-
78
- if (successful) {
79
- return {
80
- success: true,
81
- data: logs,
82
- };
83
- }
84
- else {
85
- return {
86
- success: false,
87
- error: returnMessage.message,
88
- };
89
- }
90
- }
91
- catch (error) {
92
- return {
93
- success: false,
94
- error: error.message || 'Unknown error occurred',
95
- errorDetails: error.stack
96
- };
97
- }
98
- }
99
-
100
- exports.definition = toolDefinition;
101
- exports.execute = execute;
102
-
1
+ const jwt = require('../../lib/jwt');
2
+ const connectorRegistry = require('../../connector/registry');
3
+ const logCore = require('../../handlers/log');
4
+
5
+ /**
6
+ * MCP Tool: Get Call Log
7
+ *
8
+ * This tool retrieves call logs from the CRM platform by session IDs.
9
+ */
10
+
11
+ const toolDefinition = {
12
+ name: 'getCallLog',
13
+ description: '⚠️ REQUIRES AUTHENTICATION: User must first authenticate using the "auth" tool to obtain a JWT token before using this tool. | Get call logs from the CRM platform by session IDs. Returns log details if found.',
14
+ inputSchema: {
15
+ type: 'object',
16
+ properties: {
17
+ jwtToken: {
18
+ type: 'string',
19
+ description: 'JWT token containing userId and platform information. If user does not have this, direct them to use the "auth" tool first.'
20
+ },
21
+ sessionIds: {
22
+ type: 'string',
23
+ description: 'Session IDs to retrieve, seprated by commas'
24
+ },
25
+ extensionNumber: {
26
+ type: 'string',
27
+ description: 'RingCentral extension number to match with each session ID'
28
+ },
29
+ requireDetails: {
30
+ type: 'boolean',
31
+ description: 'Whether to require detailed log information. If true, will call CRM API. Otherwise will just query in our own database',
32
+ default: false
33
+ }
34
+ },
35
+ required: ['jwtToken', 'sessionIds']
36
+ }
37
+ };
38
+
39
+ /**
40
+ * Execute the getCallLog tool
41
+ * @param {Object} args - The tool arguments
42
+ * @param {string} args.jwtToken - JWT token with user and platform info
43
+ * @param {string} args.sessionIds - Session IDs to retrieve, seprated by commas
44
+ * @param {string} [args.extensionNumber] - RingCentral extension number used to scope the lookup.
45
+ * @param {boolean} [args.requireDetails] - Whether to require detailed log information. If true, will call CRM API. Otherwise will just query in our own database.
46
+ * @returns {Object} Result object with call log information
47
+ */
48
+ async function execute(args) {
49
+ try {
50
+ const { jwtToken, sessionIds, extensionNumber, requireDetails = false } = args;
51
+
52
+ // Decode JWT to get userId and platform
53
+ const decodedToken = jwt.decodeJwt(jwtToken);
54
+ if (!decodedToken) {
55
+ throw new Error('Invalid JWT token');
56
+ }
57
+ const { id: userId, platform } = decodedToken;
58
+
59
+ if (!userId) {
60
+ throw new Error('Invalid JWT token: userId not found');
61
+ }
62
+
63
+ // Get the platform connector module
64
+ const platformModule = connectorRegistry.getConnector(platform);
65
+
66
+ if (!platformModule) {
67
+ throw new Error(`Platform connector not found for: ${platform}`);
68
+ }
69
+
70
+ // Check if getCallLog is implemented
71
+ if (!platformModule.getCallLog) {
72
+ throw new Error(`getCallLog is not implemented for platform: ${platform}`);
73
+ }
74
+
75
+ // Call the getCallLog method
76
+ const getCallLogParams = {
77
+ userId,
78
+ sessionIds,
79
+ platform,
80
+ requireDetails
81
+ };
82
+ if (extensionNumber) {
83
+ getCallLogParams.extensionNumber = extensionNumber;
84
+ }
85
+ const { successful, logs, returnMessage } = await logCore.getCallLog(getCallLogParams);
86
+
87
+ if (successful) {
88
+ return {
89
+ success: true,
90
+ data: logs,
91
+ };
92
+ }
93
+ else {
94
+ return {
95
+ success: false,
96
+ error: returnMessage.message,
97
+ };
98
+ }
99
+ }
100
+ catch (error) {
101
+ return {
102
+ success: false,
103
+ error: error.message || 'Unknown error occurred',
104
+ errorDetails: error.stack
105
+ };
106
+ }
107
+ }
108
+
109
+ exports.definition = toolDefinition;
110
+ exports.execute = execute;
111
+
@@ -1,99 +1,99 @@
1
- const jwt = require('../../lib/jwt');
2
- const { UserModel } = require('../../models/userModel');
3
- const axios = require('axios');
4
-
5
- /**
6
- * MCP Tool: Get Google File Picker
7
- *
8
- * Returns the URL for the Google Sheets file picker.
9
- * The user must visit this URL in a browser to select a Google Sheet.
10
- */
11
-
12
- const toolDefinition = {
13
- name: 'getGoogleFilePicker',
14
- description: '⚠️ REQUIRES CRM CONNECTION. | Returns a URL for the Google Sheets file picker (1st preference) OR create a new sheet with input sheet name (2nd preference). The user should open this URL in their browser to select a Google Sheet for logging.',
15
- inputSchema: {
16
- type: 'object',
17
- properties: {
18
- sheetName: {
19
- type: 'string',
20
- description: 'OPTIONAL. Name of the new sheet to create.'
21
- }
22
- },
23
- required: []
24
- },
25
- annotations: {
26
- readOnlyHint: false,
27
- openWorldHint: true,
28
- destructiveHint: false
29
- }
30
- };
31
-
32
- /**
33
- * Execute the getGoogleFilePicker tool
34
- * @param {Object} args - The tool arguments
35
- * @param {string} args.jwtToken - JWT token containing userId
36
- * @param {string} args.sheetName - Name of the new sheet to create
37
- * @returns {Object} Result object with file picker URL
38
- */
39
- async function execute(args) {
40
- try {
41
- const { jwtToken, sheetName } = args;
42
-
43
- if (!jwtToken) {
44
- return {
45
- success: false,
46
- error: 'JWT token is required. Please connect to the CRM first using getPublicConnectors.'
47
- };
48
- }
49
-
50
- // Decode JWT to get userId
51
- const unAuthData = jwt.decodeJwt(jwtToken);
52
-
53
- if (!unAuthData?.id) {
54
- return {
55
- success: false,
56
- error: 'Invalid JWT token: userId not found'
57
- };
58
- }
59
-
60
- // Find the user
61
- const user = await UserModel.findByPk(unAuthData.id);
62
-
63
- if (!user) {
64
- return {
65
- success: false,
66
- error: 'User not found. Please connect to the CRM first using getPublicConnectors.'
67
- };
68
- }
69
-
70
-
71
- if (sheetName) {
72
- const createSheetResponse = await axios.post(`${process.env.APP_SERVER}/googleSheets/sheet?jwtToken=${jwtToken}`, { name: sheetName });
73
- return createSheetResponse.data;
74
- }
75
- else {
76
- // Generate the file picker URL
77
- const filePickerUrl = `${process.env.APP_SERVER}/googleSheets/filePicker?token=${jwtToken}`;
78
-
79
- return {
80
- success: true,
81
- data: {
82
- filePickerUrl,
83
- message: 'Please open this URL in a browser to select a Google Sheet. After selecting a sheet, it will be configured for logging your calls and messages.'
84
- }
85
- };
86
- }
87
- }
88
- catch (error) {
89
- return {
90
- success: false,
91
- error: error.message || 'Unknown error occurred',
92
- errorDetails: error.stack
93
- };
94
- }
95
- }
96
-
97
- exports.definition = toolDefinition;
98
- exports.execute = execute;
99
-
1
+ const jwt = require('../../lib/jwt');
2
+ const { UserModel } = require('../../models/userModel');
3
+ const axios = require('axios');
4
+
5
+ /**
6
+ * MCP Tool: Get Google File Picker
7
+ *
8
+ * Returns the URL for the Google Sheets file picker.
9
+ * The user must visit this URL in a browser to select a Google Sheet.
10
+ */
11
+
12
+ const toolDefinition = {
13
+ name: 'getGoogleFilePicker',
14
+ description: '⚠️ REQUIRES CRM CONNECTION. | Returns a URL for the Google Sheets file picker (1st preference) OR create a new sheet with input sheet name (2nd preference). The user should open this URL in their browser to select a Google Sheet for logging.',
15
+ inputSchema: {
16
+ type: 'object',
17
+ properties: {
18
+ sheetName: {
19
+ type: 'string',
20
+ description: 'OPTIONAL. Name of the new sheet to create.'
21
+ }
22
+ },
23
+ required: []
24
+ },
25
+ annotations: {
26
+ readOnlyHint: false,
27
+ openWorldHint: true,
28
+ destructiveHint: false
29
+ }
30
+ };
31
+
32
+ /**
33
+ * Execute the getGoogleFilePicker tool
34
+ * @param {Object} args - The tool arguments
35
+ * @param {string} args.jwtToken - JWT token containing userId
36
+ * @param {string} args.sheetName - Name of the new sheet to create
37
+ * @returns {Object} Result object with file picker URL
38
+ */
39
+ async function execute(args) {
40
+ try {
41
+ const { jwtToken, sheetName } = args;
42
+
43
+ if (!jwtToken) {
44
+ return {
45
+ success: false,
46
+ error: 'JWT token is required. Please connect to the CRM first using getPublicConnectors.'
47
+ };
48
+ }
49
+
50
+ // Decode JWT to get userId
51
+ const unAuthData = jwt.decodeJwt(jwtToken);
52
+
53
+ if (!unAuthData?.id) {
54
+ return {
55
+ success: false,
56
+ error: 'Invalid JWT token: userId not found'
57
+ };
58
+ }
59
+
60
+ // Find the user
61
+ const user = await UserModel.findByPk(unAuthData.id);
62
+
63
+ if (!user) {
64
+ return {
65
+ success: false,
66
+ error: 'User not found. Please connect to the CRM first using getPublicConnectors.'
67
+ };
68
+ }
69
+
70
+
71
+ if (sheetName) {
72
+ const createSheetResponse = await axios.post(`${process.env.APP_SERVER}/googleSheets/sheet?jwtToken=${jwtToken}`, { name: sheetName });
73
+ return createSheetResponse.data;
74
+ }
75
+ else {
76
+ // Generate the file picker URL
77
+ const filePickerUrl = `${process.env.APP_SERVER}/googleSheets/filePicker?token=${jwtToken}`;
78
+
79
+ return {
80
+ success: true,
81
+ data: {
82
+ filePickerUrl,
83
+ message: 'Please open this URL in a browser to select a Google Sheet. After selecting a sheet, it will be configured for logging your calls and messages.'
84
+ }
85
+ };
86
+ }
87
+ }
88
+ catch (error) {
89
+ return {
90
+ success: false,
91
+ error: error.message || 'Unknown error occurred',
92
+ errorDetails: error.stack
93
+ };
94
+ }
95
+ }
96
+
97
+ exports.definition = toolDefinition;
98
+ exports.execute = execute;
99
+
@@ -1,43 +1,43 @@
1
- /**
2
- * MCP Tool: Get Help
3
- *
4
- * This tool provides users with a friendly guide to available capabilities
5
- * and how to get started with the RingCentral CRM integration.
6
- */
7
-
8
- const toolDefinition = {
9
- name: 'getHelp',
10
- description: 'Get a quick guide on what this integration can do and how to get started.',
11
- inputSchema: {
12
- type: 'object',
13
- properties: {},
14
- required: []
15
- },
16
- annotations: {
17
- readOnlyHint: true,
18
- openWorldHint: false,
19
- destructiveHint: false
20
- }
21
- };
22
-
23
- /**
24
- * Execute the getHelp tool
25
- * @returns {Object} Result object with help information
26
- */
27
- async function execute() {
28
- return {
29
- success: true,
30
- data: {
31
- overview: "I help you connect RingCentral with your CRM to log calls.",
32
- steps: [
33
- '1. Tell me to show all connectors and let me connect you to your CRM',
34
- '2. Follow authorization flow to authorize your CRM',
35
- '3. Once authorized, I can help find contacts and log your calls'
36
- ]
37
- }
38
- };
39
- }
40
-
41
- exports.definition = toolDefinition;
42
- exports.execute = execute;
43
-
1
+ /**
2
+ * MCP Tool: Get Help
3
+ *
4
+ * This tool provides users with a friendly guide to available capabilities
5
+ * and how to get started with the RingCentral CRM integration.
6
+ */
7
+
8
+ const toolDefinition = {
9
+ name: 'getHelp',
10
+ description: 'Get a quick guide on what this integration can do and how to get started.',
11
+ inputSchema: {
12
+ type: 'object',
13
+ properties: {},
14
+ required: []
15
+ },
16
+ annotations: {
17
+ readOnlyHint: true,
18
+ openWorldHint: false,
19
+ destructiveHint: false
20
+ }
21
+ };
22
+
23
+ /**
24
+ * Execute the getHelp tool
25
+ * @returns {Object} Result object with help information
26
+ */
27
+ async function execute() {
28
+ return {
29
+ success: true,
30
+ data: {
31
+ overview: "I help you connect RingCentral with your CRM to log calls.",
32
+ steps: [
33
+ '1. Tell me to show all connectors and let me connect you to your CRM',
34
+ '2. Follow authorization flow to authorize your CRM',
35
+ '3. Once authorized, I can help find contacts and log your calls'
36
+ ]
37
+ }
38
+ };
39
+ }
40
+
41
+ exports.definition = toolDefinition;
42
+ exports.execute = execute;
43
+