@studious-lms/server 1.13.0 → 1.15.0

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 (375) hide show
  1. package/.dockerignore +28 -0
  2. package/.env.example +5 -0
  3. package/.github/workflows/deploy.yml +123 -0
  4. package/Dockerfile +54 -0
  5. package/dist/index.js +5 -2
  6. package/dist/index.js.map +1 -1
  7. package/dist/instrument.js +3 -3
  8. package/dist/instrument.js.map +1 -1
  9. package/dist/lib/config/cors.d.ts.map +1 -1
  10. package/dist/lib/config/cors.js +31 -11
  11. package/dist/lib/config/cors.js.map +1 -1
  12. package/dist/lib/config/env.d.ts +17 -0
  13. package/dist/lib/config/env.d.ts.map +1 -1
  14. package/dist/lib/config/env.js +8 -2
  15. package/dist/lib/config/env.js.map +1 -1
  16. package/dist/lib/googleCloudStorage.d.ts +10 -0
  17. package/dist/lib/googleCloudStorage.d.ts.map +1 -1
  18. package/dist/lib/googleCloudStorage.js +22 -2
  19. package/dist/lib/googleCloudStorage.js.map +1 -1
  20. package/dist/lib/inferDocumentFormat.d.ts +10 -0
  21. package/dist/lib/inferDocumentFormat.d.ts.map +1 -0
  22. package/dist/lib/inferDocumentFormat.js +48 -0
  23. package/dist/lib/inferDocumentFormat.js.map +1 -0
  24. package/dist/lib/legal.d.ts +3 -0
  25. package/dist/lib/legal.d.ts.map +1 -0
  26. package/dist/lib/legal.js +6 -0
  27. package/dist/lib/legal.js.map +1 -0
  28. package/dist/lib/prisma.d.ts +104 -5
  29. package/dist/lib/prisma.d.ts.map +1 -1
  30. package/dist/lib/prisma.js +33 -2
  31. package/dist/lib/prisma.js.map +1 -1
  32. package/dist/models/agenda.d.ts +20 -20
  33. package/dist/models/announcement.d.ts +211 -101
  34. package/dist/models/announcement.d.ts.map +1 -1
  35. package/dist/models/assignment.d.ts +560 -362
  36. package/dist/models/assignment.d.ts.map +1 -1
  37. package/dist/models/attendance.d.ts +197 -71
  38. package/dist/models/attendance.d.ts.map +1 -1
  39. package/dist/models/auth.d.ts +356 -114
  40. package/dist/models/auth.d.ts.map +1 -1
  41. package/dist/models/auth.js +4 -2
  42. package/dist/models/auth.js.map +1 -1
  43. package/dist/models/class.d.ts +327 -201
  44. package/dist/models/class.d.ts.map +1 -1
  45. package/dist/models/class.js +2 -2
  46. package/dist/models/class.js.map +1 -1
  47. package/dist/models/cloudStorage.d.ts +146 -56
  48. package/dist/models/cloudStorage.d.ts.map +1 -1
  49. package/dist/models/comment.d.ts +262 -110
  50. package/dist/models/comment.d.ts.map +1 -1
  51. package/dist/models/conversation.d.ts +206 -80
  52. package/dist/models/conversation.d.ts.map +1 -1
  53. package/dist/models/department.d.ts +196 -70
  54. package/dist/models/department.d.ts.map +1 -1
  55. package/dist/models/event.d.ts +305 -141
  56. package/dist/models/event.d.ts.map +1 -1
  57. package/dist/models/file.d.ts +422 -272
  58. package/dist/models/file.d.ts.map +1 -1
  59. package/dist/models/folder.d.ts +433 -181
  60. package/dist/models/folder.d.ts.map +1 -1
  61. package/dist/models/labChat.d.ts +205 -79
  62. package/dist/models/labChat.d.ts.map +1 -1
  63. package/dist/models/marketing.d.ts +79 -38
  64. package/dist/models/marketing.d.ts.map +1 -1
  65. package/dist/models/marketing.js +12 -4
  66. package/dist/models/marketing.js.map +1 -1
  67. package/dist/models/message.d.ts +97 -43
  68. package/dist/models/message.d.ts.map +1 -1
  69. package/dist/models/newtonChat.d.ts +84 -30
  70. package/dist/models/newtonChat.d.ts.map +1 -1
  71. package/dist/models/notification.d.ts +57 -21
  72. package/dist/models/notification.d.ts.map +1 -1
  73. package/dist/models/school.d.ts +349 -133
  74. package/dist/models/school.d.ts.map +1 -1
  75. package/dist/models/section.d.ts +216 -72
  76. package/dist/models/section.d.ts.map +1 -1
  77. package/dist/models/tag.d.ts +156 -48
  78. package/dist/models/tag.d.ts.map +1 -1
  79. package/dist/models/user.d.ts +82 -28
  80. package/dist/models/user.d.ts.map +1 -1
  81. package/dist/models/worksheet.d.ts +1032 -423
  82. package/dist/models/worksheet.d.ts.map +1 -1
  83. package/dist/models/worksheet.js +8 -2
  84. package/dist/models/worksheet.js.map +1 -1
  85. package/dist/pipelines/aiLabChat.d.ts +7 -9
  86. package/dist/pipelines/aiLabChat.d.ts.map +1 -1
  87. package/dist/pipelines/aiLabChat.js +194 -125
  88. package/dist/pipelines/aiLabChat.js.map +1 -1
  89. package/dist/pipelines/aiLabChatContract.d.ts +233 -389
  90. package/dist/pipelines/aiLabChatContract.d.ts.map +1 -1
  91. package/dist/pipelines/aiLabChatContract.js +54 -70
  92. package/dist/pipelines/aiLabChatContract.js.map +1 -1
  93. package/dist/pipelines/aiNewtonChat.d.ts.map +1 -1
  94. package/dist/pipelines/aiNewtonChat.js +41 -41
  95. package/dist/pipelines/aiNewtonChat.js.map +1 -1
  96. package/dist/pipelines/gradeWorksheet.d.ts +8 -8
  97. package/dist/pipelines/labChatPrompt.d.ts +18 -11
  98. package/dist/pipelines/labChatPrompt.d.ts.map +1 -1
  99. package/dist/pipelines/labChatPrompt.js +93 -75
  100. package/dist/pipelines/labChatPrompt.js.map +1 -1
  101. package/dist/pipelines/pdfToWorksheet.d.ts +1 -1
  102. package/dist/routers/_app.d.ts +2601 -2151
  103. package/dist/routers/_app.d.ts.map +1 -1
  104. package/dist/routers/_app.js +4 -2
  105. package/dist/routers/_app.js.map +1 -1
  106. package/dist/routers/admin.d.ts +13 -13
  107. package/dist/routers/agenda.d.ts +18 -18
  108. package/dist/routers/announcement.d.ts +60 -60
  109. package/dist/routers/assignment.d.ts +393 -383
  110. package/dist/routers/assignment.d.ts.map +1 -1
  111. package/dist/routers/attendance.d.ts +10 -10
  112. package/dist/routers/auth.d.ts +4 -2
  113. package/dist/routers/auth.d.ts.map +1 -1
  114. package/dist/routers/auth.js +15 -2
  115. package/dist/routers/auth.js.map +1 -1
  116. package/dist/routers/class.d.ts +157 -153
  117. package/dist/routers/class.d.ts.map +1 -1
  118. package/dist/routers/comment.d.ts +18 -18
  119. package/dist/routers/conversation.d.ts +11 -11
  120. package/dist/routers/department.d.ts +34 -34
  121. package/dist/routers/discussion.d.ts +68 -56
  122. package/dist/routers/discussion.d.ts.map +1 -1
  123. package/dist/routers/discussion.js +6 -2
  124. package/dist/routers/discussion.js.map +1 -1
  125. package/dist/routers/embedding.d.ts +73 -0
  126. package/dist/routers/embedding.d.ts.map +1 -0
  127. package/dist/routers/embedding.js +151 -0
  128. package/dist/routers/embedding.js.map +1 -0
  129. package/dist/routers/event.d.ts +57 -55
  130. package/dist/routers/event.d.ts.map +1 -1
  131. package/dist/routers/file.d.ts +14 -14
  132. package/dist/routers/folder.d.ts +38 -38
  133. package/dist/routers/labChat.d.ts +16 -16
  134. package/dist/routers/marketing.d.ts +1 -14
  135. package/dist/routers/marketing.d.ts.map +1 -1
  136. package/dist/routers/message.d.ts +13 -13
  137. package/dist/routers/newtonChat.d.ts +4 -4
  138. package/dist/routers/notifications.d.ts +5 -5
  139. package/dist/routers/permissions.d.ts +14 -14
  140. package/dist/routers/school.d.ts +59 -55
  141. package/dist/routers/school.d.ts.map +1 -1
  142. package/dist/routers/search.d.ts +22 -1
  143. package/dist/routers/search.d.ts.map +1 -1
  144. package/dist/routers/search.js +9 -3
  145. package/dist/routers/search.js.map +1 -1
  146. package/dist/routers/section.d.ts +4 -4
  147. package/dist/routers/studentProgress.d.ts +1 -1
  148. package/dist/routers/tag.d.ts +7 -7
  149. package/dist/routers/user.d.ts +99 -10
  150. package/dist/routers/user.d.ts.map +1 -1
  151. package/dist/routers/user.js +19 -2
  152. package/dist/routers/user.js.map +1 -1
  153. package/dist/routers/worksheet.d.ts +93 -55
  154. package/dist/routers/worksheet.d.ts.map +1 -1
  155. package/dist/routers/worksheet.js +26 -2
  156. package/dist/routers/worksheet.js.map +1 -1
  157. package/dist/routes/aiStream.d.ts +2 -0
  158. package/dist/routes/aiStream.d.ts.map +1 -0
  159. package/dist/routes/aiStream.js +726 -0
  160. package/dist/routes/aiStream.js.map +1 -0
  161. package/dist/seedDatabase.d.ts +3 -1
  162. package/dist/seedDatabase.d.ts.map +1 -1
  163. package/dist/seedDatabase.js +6 -6
  164. package/dist/seedDatabase.js.map +1 -1
  165. package/dist/services/adminInstitution.d.ts +8 -8
  166. package/dist/services/adminRunJob.d.ts +4 -4
  167. package/dist/services/agenda.d.ts +18 -18
  168. package/dist/services/aiChatStream.d.ts +88 -0
  169. package/dist/services/aiChatStream.d.ts.map +1 -0
  170. package/dist/services/aiChatStream.js +254 -0
  171. package/dist/services/aiChatStream.js.map +1 -0
  172. package/dist/services/aiModifierTools.d.ts +16 -0
  173. package/dist/services/aiModifierTools.d.ts.map +1 -0
  174. package/dist/services/aiModifierTools.js +274 -0
  175. package/dist/services/aiModifierTools.js.map +1 -0
  176. package/dist/services/aiProposalTools.d.ts +32 -0
  177. package/dist/services/aiProposalTools.d.ts.map +1 -0
  178. package/dist/services/aiProposalTools.js +207 -0
  179. package/dist/services/aiProposalTools.js.map +1 -0
  180. package/dist/services/aiStream.d.ts +22 -0
  181. package/dist/services/aiStream.d.ts.map +1 -0
  182. package/dist/services/aiStream.js +142 -0
  183. package/dist/services/aiStream.js.map +1 -0
  184. package/dist/services/aiTools.d.ts +16 -0
  185. package/dist/services/aiTools.d.ts.map +1 -0
  186. package/dist/services/aiTools.js +271 -0
  187. package/dist/services/aiTools.js.map +1 -0
  188. package/dist/services/announcement.d.ts +42 -42
  189. package/dist/services/announcement.d.ts.map +1 -1
  190. package/dist/services/announcement.js +7 -2
  191. package/dist/services/announcement.js.map +1 -1
  192. package/dist/services/assignment.d.ts +355 -345
  193. package/dist/services/assignment.d.ts.map +1 -1
  194. package/dist/services/assignment.js +30 -9
  195. package/dist/services/assignment.js.map +1 -1
  196. package/dist/services/attendance.d.ts +10 -10
  197. package/dist/services/auth.d.ts +4 -2
  198. package/dist/services/auth.d.ts.map +1 -1
  199. package/dist/services/auth.js +13 -4
  200. package/dist/services/auth.js.map +1 -1
  201. package/dist/services/class.d.ts +146 -142
  202. package/dist/services/class.d.ts.map +1 -1
  203. package/dist/services/class.js +24 -4
  204. package/dist/services/class.js.map +1 -1
  205. package/dist/services/comment.d.ts +18 -18
  206. package/dist/services/conversation.d.ts +11 -11
  207. package/dist/services/department.d.ts +33 -33
  208. package/dist/services/discussion.d.ts +58 -58
  209. package/dist/services/discussion.d.ts.map +1 -1
  210. package/dist/services/discussion.js +15 -8
  211. package/dist/services/discussion.js.map +1 -1
  212. package/dist/services/discussionSummary.d.ts +21 -0
  213. package/dist/services/discussionSummary.d.ts.map +1 -0
  214. package/dist/services/discussionSummary.js +179 -0
  215. package/dist/services/discussionSummary.js.map +1 -0
  216. package/dist/services/embedding.d.ts +85 -0
  217. package/dist/services/embedding.d.ts.map +1 -0
  218. package/dist/services/embedding.js +372 -0
  219. package/dist/services/embedding.js.map +1 -0
  220. package/dist/services/event.d.ts +55 -53
  221. package/dist/services/event.d.ts.map +1 -1
  222. package/dist/services/file.d.ts +28 -28
  223. package/dist/services/folder.d.ts +36 -36
  224. package/dist/services/folder.d.ts.map +1 -1
  225. package/dist/services/folder.js +32 -2
  226. package/dist/services/folder.js.map +1 -1
  227. package/dist/services/labChat.d.ts +16 -16
  228. package/dist/services/marketing.d.ts +2 -15
  229. package/dist/services/marketing.d.ts.map +1 -1
  230. package/dist/services/marketing.js +5 -5
  231. package/dist/services/marketing.js.map +1 -1
  232. package/dist/services/message.d.ts +11 -11
  233. package/dist/services/message.d.ts.map +1 -1
  234. package/dist/services/message.js +2 -2
  235. package/dist/services/message.js.map +1 -1
  236. package/dist/services/newtonChat.d.ts +4 -4
  237. package/dist/services/notification.d.ts +5 -5
  238. package/dist/services/notification.d.ts.map +1 -1
  239. package/dist/services/openaiDocumentGen.d.ts +37 -0
  240. package/dist/services/openaiDocumentGen.d.ts.map +1 -0
  241. package/dist/services/openaiDocumentGen.js +262 -0
  242. package/dist/services/openaiDocumentGen.js.map +1 -0
  243. package/dist/services/permissions.d.ts +14 -14
  244. package/dist/services/school.d.ts +54 -50
  245. package/dist/services/school.d.ts.map +1 -1
  246. package/dist/services/search.d.ts +13 -1
  247. package/dist/services/search.d.ts.map +1 -1
  248. package/dist/services/search.js +145 -2
  249. package/dist/services/search.js.map +1 -1
  250. package/dist/services/section.d.ts +3 -3
  251. package/dist/services/tag.d.ts +4 -4
  252. package/dist/services/user.d.ts +4 -4
  253. package/dist/services/user.d.ts.map +1 -1
  254. package/dist/services/user.js +10 -15
  255. package/dist/services/user.js.map +1 -1
  256. package/dist/services/userPrivacy.d.ts +86 -0
  257. package/dist/services/userPrivacy.d.ts.map +1 -0
  258. package/dist/services/userPrivacy.js +184 -0
  259. package/dist/services/userPrivacy.js.map +1 -0
  260. package/dist/services/worksheet.d.ts +86 -57
  261. package/dist/services/worksheet.d.ts.map +1 -1
  262. package/dist/services/worksheet.js +57 -5
  263. package/dist/services/worksheet.js.map +1 -1
  264. package/dist/utils/email.d.ts.map +1 -1
  265. package/dist/utils/email.js +7 -3
  266. package/dist/utils/email.js.map +1 -1
  267. package/dist/utils/streamBroadcast.d.ts +11 -0
  268. package/dist/utils/streamBroadcast.d.ts.map +1 -0
  269. package/dist/utils/streamBroadcast.js +32 -0
  270. package/dist/utils/streamBroadcast.js.map +1 -0
  271. package/dist/workers/connection.d.ts +15 -0
  272. package/dist/workers/connection.d.ts.map +1 -1
  273. package/dist/workers/connection.js +20 -2
  274. package/dist/workers/connection.js.map +1 -1
  275. package/dist/workers/index.js +4 -2
  276. package/dist/workers/index.js.map +1 -1
  277. package/dist/workers/processors/createRunJobWorker.d.ts.map +1 -1
  278. package/dist/workers/processors/createRunJobWorker.js +31 -8
  279. package/dist/workers/processors/createRunJobWorker.js.map +1 -1
  280. package/dist/workers/processors/embedContent.d.ts +8 -0
  281. package/dist/workers/processors/embedContent.d.ts.map +1 -0
  282. package/dist/workers/processors/embedContent.js +67 -0
  283. package/dist/workers/processors/embedContent.js.map +1 -0
  284. package/dist/workers/queues.d.ts +6 -0
  285. package/dist/workers/queues.d.ts.map +1 -1
  286. package/dist/workers/queues.js +5 -3
  287. package/dist/workers/queues.js.map +1 -1
  288. package/package.json +5 -1
  289. package/prisma/migrations/20260609215135_init/migration.sql +1412 -0
  290. package/prisma/migrations/20260610130000_add_worksheet_tags/migration.sql +13 -0
  291. package/prisma/migrations/20260610140000_expand_embedding_source_types/migration.sql +4 -0
  292. package/prisma/migrations/20260611120000_add_user_terms_acceptance/migration.sql +3 -0
  293. package/prisma/schema.prisma +44 -7
  294. package/src/index.ts +4 -0
  295. package/src/instrument.ts +1 -1
  296. package/src/lib/config/cors.ts +32 -9
  297. package/src/lib/config/env.ts +6 -0
  298. package/src/lib/googleCloudStorage.ts +21 -0
  299. package/src/lib/inferDocumentFormat.ts +58 -0
  300. package/src/lib/legal.ts +2 -0
  301. package/src/lib/prisma.ts +40 -1
  302. package/src/models/auth.ts +4 -0
  303. package/src/models/class.ts +3 -2
  304. package/src/models/marketing.ts +10 -2
  305. package/src/models/worksheet.ts +5 -2
  306. package/src/pipelines/aiLabChat.ts +245 -146
  307. package/src/pipelines/aiLabChatContract.ts +59 -69
  308. package/src/pipelines/aiNewtonChat.ts +46 -43
  309. package/src/pipelines/labChatPrompt.ts +115 -90
  310. package/src/routers/_app.ts +2 -0
  311. package/src/routers/auth.ts +13 -0
  312. package/src/routers/discussion.ts +7 -0
  313. package/src/routers/embedding.ts +164 -0
  314. package/src/routers/search.ts +10 -1
  315. package/src/routers/user.ts +26 -0
  316. package/src/routers/worksheet.ts +27 -0
  317. package/src/routes/aiStream.ts +827 -0
  318. package/src/seedDatabase.ts +4 -4
  319. package/src/services/aiChatStream.ts +341 -0
  320. package/src/services/aiModifierTools.ts +341 -0
  321. package/src/services/aiProposalTools.ts +274 -0
  322. package/src/services/aiStream.ts +175 -0
  323. package/src/services/aiTools.ts +290 -0
  324. package/src/services/announcement.ts +7 -0
  325. package/src/services/assignment.ts +31 -7
  326. package/src/services/auth.ts +14 -2
  327. package/src/services/class.ts +27 -2
  328. package/src/services/discussion.ts +22 -8
  329. package/src/services/discussionSummary.ts +226 -0
  330. package/src/services/embedding.ts +446 -0
  331. package/src/services/folder.ts +31 -0
  332. package/src/services/marketing.ts +3 -3
  333. package/src/services/message.ts +2 -2
  334. package/src/services/openaiDocumentGen.ts +319 -0
  335. package/src/services/search.ts +163 -1
  336. package/src/services/user.ts +9 -17
  337. package/src/services/userPrivacy.ts +196 -0
  338. package/src/services/worksheet.ts +77 -3
  339. package/src/utils/email.ts +5 -1
  340. package/src/utils/streamBroadcast.ts +48 -0
  341. package/src/workers/connection.ts +19 -0
  342. package/src/workers/index.ts +2 -0
  343. package/src/workers/processors/createRunJobWorker.ts +32 -6
  344. package/src/workers/processors/embedContent.ts +86 -0
  345. package/src/workers/queues.ts +5 -1
  346. package/tests/helpers/registerInput.ts +20 -0
  347. package/tests/integration/globalSetup.ts +10 -18
  348. package/tests/integration/routers/auth.test.ts +13 -18
  349. package/tests/unit/lib/inferDocumentFormat.test.ts +33 -0
  350. package/tests/unit/pipelines/aiLabChatContract.test.ts +38 -21
  351. package/tests/unit/pipelines/labChatPrompt.test.ts +23 -36
  352. package/tests/unit/services/aiChatStream.test.ts +92 -0
  353. package/tests/unit/services/openaiDocumentGen.test.ts +65 -0
  354. package/prisma/migrations/20250807062924_init/migration.sql +0 -436
  355. package/prisma/migrations/20250919063704_init2/migration.sql +0 -24
  356. package/prisma/migrations/20250920143543_add_profile_fields/migration.sql +0 -15
  357. package/prisma/migrations/20250922165147_add_chat_models/migration.sql +0 -68
  358. package/prisma/migrations/20250922165314_add_chat_roles/migration.sql +0 -5
  359. package/prisma/migrations/20250922171242_refactor_notification_system/migration.sql +0 -20
  360. package/prisma/migrations/20250922172208_add_mentions_system/migration.sql +0 -21
  361. package/prisma/migrations/20250925072732_add_lab_chat_system/migration.sql +0 -25
  362. package/prisma/migrations/20251020151505_add_upload_tracking_fields/migration.sql +0 -57
  363. package/prisma/migrations/20251109122857_annuoncements_comments/migration.sql +0 -30
  364. package/prisma/migrations/20251109135555_reactions_announcements_comments/migration.sql +0 -35
  365. package/prisma/migrations/20260410124000_add_submission_recommendation_state/migration.sql +0 -14
  366. package/prisma/migrations/20260415103500_add_session_type/migration.sql +0 -33
  367. package/prisma/migrations/20260415133000_add_ai_usage_logs/migration.sql +0 -19
  368. package/prisma/migrations/20260417083000_add_conversation_member_hidden_at/migration.sql +0 -2
  369. package/prisma/migrations/20260502230500_assignment_submission_comments/migration.sql +0 -60
  370. package/prisma/migrations/20260504071500_school_memberships/migration.sql +0 -81
  371. package/prisma/migrations/20260506162500_consolidate_run_job_and_unify_job_status/migration.sql +0 -166
  372. package/prisma/migrations/20260509220000_institution_overhaul/migration.sql +0 -184
  373. package/prisma/migrations/20260510170000_add_folder_permissions/migration.sql +0 -93
  374. package/prisma/migrations/20260510183000_add_discussions/migration.sql +0 -151
  375. /package/.github/workflows/{npm.yml → npm-publish.yml} +0 -0
@@ -42,7 +42,7 @@ export async function clearDatabase() {
42
42
  // Discussion tree.
43
43
  await prisma.discussionReply.deleteMany();
44
44
  await prisma.discussion.deleteMany();
45
- await prisma.discussionTag.deleteMany();
45
+ await prisma.classTag.deleteMany();
46
46
 
47
47
  // Comments after their reactions are gone.
48
48
  await prisma.comment.deleteMany();
@@ -1425,13 +1425,13 @@ export const seedDatabase = async () => {
1425
1425
  // ---------------------------------------------------------------------
1426
1426
  // 15. Discussions (with replies, tags, reads, reactions)
1427
1427
  // ---------------------------------------------------------------------
1428
- const bioTag = await prisma.discussionTag.create({
1428
+ const bioTag = await prisma.classTag.create({
1429
1429
  data: { classId: biologyClass.id, name: "Lab", color: "#10B981" },
1430
1430
  });
1431
- const bioTagHomework = await prisma.discussionTag.create({
1431
+ const bioTagHomework = await prisma.classTag.create({
1432
1432
  data: { classId: biologyClass.id, name: "Homework Help", color: "#F59E0B" },
1433
1433
  });
1434
- const mathTagAP = await prisma.discussionTag.create({
1434
+ const mathTagAP = await prisma.classTag.create({
1435
1435
  data: { classId: mathClass.id, name: "AP Prep", color: "#DC2626" },
1436
1436
  });
1437
1437
 
@@ -0,0 +1,341 @@
1
+ /**
2
+ * Shared AI chat streaming helper.
3
+ *
4
+ * Runs a genuine token-by-token stream via the Vercel AI SDK (`streamText`)
5
+ * against OpenAI — the same provider the rest of the app's inference uses
6
+ * (`OPENAI_API_KEY`). Real text tokens are broadcast over Pusher as they are
7
+ * produced, and real tool calls are broadcast inline (in the order the model
8
+ * invokes them) instead of being derived after the fact from a JSON blob.
9
+ *
10
+ * Callers own persistence: this helper returns the accumulated text and the
11
+ * ordered tool calls so the pipeline can write `content`/`meta` and emit the
12
+ * terminal `message-stream-complete` / `message-updated` events.
13
+ */
14
+ import { streamText, stepCountIs, type ModelMessage, type ToolSet } from 'ai';
15
+ import { openai } from '@ai-sdk/openai';
16
+ import { getRedis } from '../lib/redis.js';
17
+ import { pusher, chatChannel } from '../lib/pusher.js';
18
+ import { logger } from '../utils/logger.js';
19
+
20
+ const STREAM_REDIS_TTL = 600; // 10 minutes
21
+ const STREAM_KEY_PREFIX = 'stream:';
22
+
23
+ /** Default streaming model — matches the existing streamAIResponse path. */
24
+ export const DEFAULT_STREAM_MODEL = 'gpt-4o-mini';
25
+
26
+ export interface StreamedToolCall {
27
+ toolName: string;
28
+ /** Args the model passed to the tool. */
29
+ input: unknown;
30
+ /** Value the tool returned (undefined for client-side / no-result tools). */
31
+ output?: unknown;
32
+ status: 'completed' | 'failed';
33
+ }
34
+
35
+ /**
36
+ * An ordered fragment of an AI message. The message is a sequence of these
37
+ * parts in the exact order the model produced them, so a tool call rendered
38
+ * "between paragraph 1 and 2" is represented as
39
+ * `[{text}, {tool}, {text}]` — enabling true inline rendering (and reload
40
+ * persistence) instead of text and tool calls living in separate buckets.
41
+ */
42
+ export type StreamPart =
43
+ | { type: 'text'; text: string }
44
+ | {
45
+ type: 'tool';
46
+ toolCallId: string;
47
+ toolName: string;
48
+ /** Concrete entity label (e.g. assignment title / search query), if any. */
49
+ title?: string;
50
+ /** Requested output type from the tool args (pdf, pptx, xlsx, …). */
51
+ format?: string;
52
+ /** Set after generated files are persisted on the message. */
53
+ fileId?: string;
54
+ fileName?: string;
55
+ status: 'executing' | 'completed' | 'failed';
56
+ };
57
+
58
+ export interface GeneratedDocFileLink {
59
+ title: string;
60
+ fileId: string;
61
+ fileName: string;
62
+ format?: string;
63
+ }
64
+
65
+ /** Apply pipeline-resolved formats onto generate_document tool parts. */
66
+ export function applyResolvedFormatsToStreamParts(
67
+ parts: StreamPart[],
68
+ docs: Array<{ title: string; format: string }>,
69
+ ): StreamPart[] {
70
+ if (docs.length === 0) return parts;
71
+
72
+ const pending = [...docs];
73
+ const takeDoc = (title?: string) => {
74
+ if (title) {
75
+ const idx = pending.findIndex(
76
+ (d) => d.title.trim().toLowerCase() === title.trim().toLowerCase(),
77
+ );
78
+ if (idx >= 0) return pending.splice(idx, 1)[0];
79
+ }
80
+ return pending.shift();
81
+ };
82
+
83
+ return parts.map((part) => {
84
+ if (part.type !== 'tool' || part.toolName !== 'generate_document') return part;
85
+ const doc = takeDoc(part.title);
86
+ return doc ? { ...part, format: doc.format } : part;
87
+ });
88
+ }
89
+
90
+ /** Tools that queue async work after the model stream; UI stays loading until the pipeline finishes. */
91
+ const DEFERRED_COMPLETION_TOOLS = new Set(['generate_document']);
92
+
93
+ function isDeferredCompletionTool(toolName: string): boolean {
94
+ return DEFERRED_COMPLETION_TOOLS.has(toolName);
95
+ }
96
+
97
+ /** Attach file IDs to `generate_document` tool parts for inline download chips. */
98
+ export function enrichStreamPartsWithGeneratedFiles(
99
+ parts: StreamPart[],
100
+ files: GeneratedDocFileLink[],
101
+ ): StreamPart[] {
102
+ if (files.length === 0) return parts;
103
+
104
+ const docToolIndices = parts
105
+ .map((part, index) => ({ part, index }))
106
+ .filter(
107
+ ({ part }) =>
108
+ part.type === 'tool' && part.toolName === 'generate_document',
109
+ );
110
+
111
+ const unmatched = [...files];
112
+ const fileForTool = (toolTitle?: string): GeneratedDocFileLink | undefined => {
113
+ if (toolTitle) {
114
+ const idx = unmatched.findIndex(
115
+ (f) => f.title.trim().toLowerCase() === toolTitle.trim().toLowerCase(),
116
+ );
117
+ if (idx >= 0) return unmatched.splice(idx, 1)[0];
118
+ }
119
+ return unmatched.shift();
120
+ };
121
+
122
+ const fileByIndex = new Map<number, GeneratedDocFileLink>();
123
+ for (const { part, index } of docToolIndices) {
124
+ if (part.type !== 'tool') continue;
125
+ const file = fileForTool(part.title);
126
+ if (file) fileByIndex.set(index, file);
127
+ }
128
+
129
+ return parts.map((part, index) => {
130
+ const file = fileByIndex.get(index);
131
+ if (!file || part.type !== 'tool') return part;
132
+ return {
133
+ ...part,
134
+ fileId: file.fileId,
135
+ fileName: file.fileName,
136
+ status: 'completed',
137
+ ...(file.format ? { format: file.format } : {}),
138
+ };
139
+ });
140
+ }
141
+
142
+ /** Mark deferred tools completed (file linked) or failed (generation did not produce a file). */
143
+ export function finalizeDeferredToolParts(parts: StreamPart[]): StreamPart[] {
144
+ return parts.map((part) => {
145
+ if (part.type !== 'tool' || !isDeferredCompletionTool(part.toolName)) {
146
+ return part;
147
+ }
148
+ if (part.fileId) return { ...part, status: 'completed' };
149
+ if (part.status === 'executing') return { ...part, status: 'failed' };
150
+ return part;
151
+ });
152
+ }
153
+
154
+ function toolFieldFromInput(input: unknown, key: string): string | undefined {
155
+ if (input && typeof input === 'object') {
156
+ const val = (input as Record<string, unknown>)[key];
157
+ if (typeof val === 'string' && val.trim()) return val.trim();
158
+ }
159
+ return undefined;
160
+ }
161
+
162
+ /** Pull a human-meaningful label out of a tool's input args, if present. */
163
+ function toolTitleFromInput(input: unknown): string | undefined {
164
+ for (const key of ['title', 'name', 'query'] as const) {
165
+ const val = toolFieldFromInput(input, key);
166
+ if (val) return val;
167
+ }
168
+ return undefined;
169
+ }
170
+
171
+ export interface StreamChatOptions {
172
+ conversationId: string;
173
+ aiMessageId: string;
174
+ system: string;
175
+ messages: ModelMessage[];
176
+ tools?: ToolSet;
177
+ model?: string;
178
+ temperature?: number;
179
+ maxOutputTokens?: number;
180
+ /** Max agent steps (tool round-trips). Defaults to 6. */
181
+ maxSteps?: number;
182
+ }
183
+
184
+ export interface StreamChatResult {
185
+ text: string;
186
+ toolCalls: StreamedToolCall[];
187
+ /** Ordered text/tool parts, in the exact order the model produced them. */
188
+ parts: StreamPart[];
189
+ }
190
+
191
+ /**
192
+ * Stream a chat completion, broadcasting real text chunks and tool-call
193
+ * events over Pusher. Does NOT persist the message or emit the terminal
194
+ * stream-complete event — the caller does that once it has assembled the
195
+ * final `content`/`meta` (e.g. PDF attachments, structured proposals).
196
+ */
197
+ export async function streamChatResponse(
198
+ options: StreamChatOptions,
199
+ ): Promise<StreamChatResult> {
200
+ const {
201
+ conversationId,
202
+ aiMessageId,
203
+ system,
204
+ messages,
205
+ tools,
206
+ model = DEFAULT_STREAM_MODEL,
207
+ temperature = 0.7,
208
+ maxOutputTokens = 4096,
209
+ maxSteps = 6,
210
+ } = options;
211
+
212
+ const redis = getRedis();
213
+ const streamKey = `${STREAM_KEY_PREFIX}${aiMessageId}`;
214
+ if (redis) {
215
+ await redis.set(streamKey, '', 'EX', STREAM_REDIS_TTL);
216
+ }
217
+
218
+ let fullText = '';
219
+ const parts: StreamPart[] = [];
220
+ const toolCalls: StreamedToolCall[] = [];
221
+ // Map AI SDK toolCallId -> index in `parts` so the executing indicator can
222
+ // be flipped to completed/failed in place (preserving its position).
223
+ const toolPartIndexById = new Map<string, number>();
224
+
225
+ const appendText = (text: string) => {
226
+ fullText += text;
227
+ const last = parts[parts.length - 1];
228
+ if (last && last.type === 'text') {
229
+ last.text += text;
230
+ } else {
231
+ parts.push({ type: 'text', text });
232
+ }
233
+ };
234
+
235
+ const broadcast = async (event: string, payload: Record<string, unknown>) => {
236
+ try {
237
+ await pusher.trigger(chatChannel(conversationId), event, payload);
238
+ } catch (err) {
239
+ logger.warn(`Failed to broadcast ${event}`, { err, aiMessageId });
240
+ }
241
+ };
242
+
243
+ try {
244
+ const result = streamText({
245
+ model: openai(model),
246
+ system,
247
+ messages,
248
+ ...(tools ? { tools } : {}),
249
+ temperature,
250
+ maxOutputTokens,
251
+ stopWhen: stepCountIs(maxSteps),
252
+ });
253
+
254
+ // `fullStream` yields text deltas AND tool events in a single, correctly
255
+ // ordered sequence — this is what makes inline tool calls possible. We
256
+ // build an ordered `parts` list and broadcast each event as it happens.
257
+ for await (const part of result.fullStream) {
258
+ switch (part.type) {
259
+ case 'text-delta': {
260
+ appendText(part.text);
261
+ if (redis) {
262
+ await redis.append(streamKey, part.text).catch(() => {});
263
+ }
264
+ await broadcast('message-stream-chunk', {
265
+ messageId: aiMessageId,
266
+ chunk: part.text,
267
+ });
268
+ break;
269
+ }
270
+ case 'tool-call': {
271
+ const title = toolTitleFromInput(part.input);
272
+ const format = toolFieldFromInput(part.input, 'format');
273
+ toolPartIndexById.set(part.toolCallId, parts.length);
274
+ parts.push({
275
+ type: 'tool',
276
+ toolCallId: part.toolCallId,
277
+ toolName: part.toolName,
278
+ ...(title ? { title } : {}),
279
+ ...(format ? { format } : {}),
280
+ status: 'executing',
281
+ });
282
+ await broadcast('message-tool-call', {
283
+ messageId: aiMessageId,
284
+ toolCallId: part.toolCallId,
285
+ toolName: part.toolName,
286
+ ...(title ? { title } : {}),
287
+ ...(format ? { format } : {}),
288
+ status: 'executing',
289
+ });
290
+ break;
291
+ }
292
+ case 'tool-result':
293
+ case 'tool-error': {
294
+ const failed = part.type === 'tool-error';
295
+ const deferred = isDeferredCompletionTool(part.toolName);
296
+ // Deferred tools (e.g. generate_document) only queue work during the
297
+ // stream — keep the spinner until the pipeline attaches a file.
298
+ const status: 'executing' | 'completed' | 'failed' = failed
299
+ ? 'failed'
300
+ : deferred
301
+ ? 'executing'
302
+ : 'completed';
303
+ const title = toolTitleFromInput(part.input);
304
+ const format = toolFieldFromInput(part.input, 'format');
305
+ const idx = toolPartIndexById.get(part.toolCallId);
306
+ if (idx !== undefined) {
307
+ const existing = parts[idx];
308
+ if (existing && existing.type === 'tool') {
309
+ existing.status = status;
310
+ if (format) existing.format = format;
311
+ }
312
+ }
313
+ toolCalls.push({
314
+ toolName: part.toolName,
315
+ input: part.input,
316
+ output: part.type === 'tool-result' ? part.output : undefined,
317
+ status: failed ? 'failed' : 'completed',
318
+ });
319
+ await broadcast('message-tool-call', {
320
+ messageId: aiMessageId,
321
+ toolCallId: part.toolCallId,
322
+ toolName: part.toolName,
323
+ ...(title ? { title } : {}),
324
+ ...(format ? { format } : {}),
325
+ status,
326
+ });
327
+ break;
328
+ }
329
+ default:
330
+ // ignore reasoning/source/step/finish/raw parts
331
+ break;
332
+ }
333
+ }
334
+
335
+ return { text: fullText, toolCalls, parts };
336
+ } finally {
337
+ if (redis) {
338
+ await redis.del(streamKey).catch(() => {});
339
+ }
340
+ }
341
+ }