@convex-dev/agent 0.1.1 → 0.1.2-alpha.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 (109) hide show
  1. package/README.md +9 -3
  2. package/dist/commonjs/client/createTool.d.ts +49 -0
  3. package/dist/commonjs/client/createTool.d.ts.map +1 -0
  4. package/dist/commonjs/client/createTool.js +45 -0
  5. package/dist/commonjs/client/createTool.js.map +1 -0
  6. package/dist/commonjs/client/index.d.ts +101 -322
  7. package/dist/commonjs/client/index.d.ts.map +1 -1
  8. package/dist/commonjs/client/index.js +142 -194
  9. package/dist/commonjs/client/index.js.map +1 -1
  10. package/dist/commonjs/client/streaming.d.ts +54 -0
  11. package/dist/commonjs/client/streaming.d.ts.map +1 -0
  12. package/dist/commonjs/client/streaming.js +121 -0
  13. package/dist/commonjs/client/streaming.js.map +1 -0
  14. package/dist/commonjs/client/types.d.ts +290 -2
  15. package/dist/commonjs/client/types.d.ts.map +1 -1
  16. package/dist/commonjs/component/messages.d.ts +104 -138
  17. package/dist/commonjs/component/messages.d.ts.map +1 -1
  18. package/dist/commonjs/component/messages.js +15 -14
  19. package/dist/commonjs/component/messages.js.map +1 -1
  20. package/dist/commonjs/component/schema.d.ts +873 -3
  21. package/dist/commonjs/component/schema.d.ts.map +1 -1
  22. package/dist/commonjs/component/schema.js +39 -1
  23. package/dist/commonjs/component/schema.js.map +1 -1
  24. package/dist/commonjs/component/streams.d.ts +191 -0
  25. package/dist/commonjs/component/streams.d.ts.map +1 -0
  26. package/dist/commonjs/component/streams.js +169 -0
  27. package/dist/commonjs/component/streams.js.map +1 -0
  28. package/dist/commonjs/component/threads.d.ts +1 -1
  29. package/dist/commonjs/component/threads.js +3 -3
  30. package/dist/commonjs/component/threads.js.map +1 -1
  31. package/dist/commonjs/component/users.js +2 -2
  32. package/dist/commonjs/component/users.js.map +1 -1
  33. package/dist/commonjs/mapping.d.ts.map +1 -1
  34. package/dist/commonjs/mapping.js +3 -1
  35. package/dist/commonjs/mapping.js.map +1 -1
  36. package/dist/commonjs/react/index.d.ts +99 -0
  37. package/dist/commonjs/react/index.d.ts.map +1 -1
  38. package/dist/commonjs/react/index.js +505 -1
  39. package/dist/commonjs/react/index.js.map +1 -1
  40. package/dist/commonjs/react/toUIMessages.d.ts +8 -0
  41. package/dist/commonjs/react/toUIMessages.d.ts.map +1 -0
  42. package/dist/commonjs/react/toUIMessages.js +134 -0
  43. package/dist/commonjs/react/toUIMessages.js.map +1 -0
  44. package/dist/commonjs/validators.d.ts +506 -4
  45. package/dist/commonjs/validators.d.ts.map +1 -1
  46. package/dist/commonjs/validators.js +49 -2
  47. package/dist/commonjs/validators.js.map +1 -1
  48. package/dist/esm/client/createTool.d.ts +49 -0
  49. package/dist/esm/client/createTool.d.ts.map +1 -0
  50. package/dist/esm/client/createTool.js +45 -0
  51. package/dist/esm/client/createTool.js.map +1 -0
  52. package/dist/esm/client/index.d.ts +101 -322
  53. package/dist/esm/client/index.d.ts.map +1 -1
  54. package/dist/esm/client/index.js +142 -194
  55. package/dist/esm/client/index.js.map +1 -1
  56. package/dist/esm/client/streaming.d.ts +54 -0
  57. package/dist/esm/client/streaming.d.ts.map +1 -0
  58. package/dist/esm/client/streaming.js +121 -0
  59. package/dist/esm/client/streaming.js.map +1 -0
  60. package/dist/esm/client/types.d.ts +290 -2
  61. package/dist/esm/client/types.d.ts.map +1 -1
  62. package/dist/esm/component/messages.d.ts +104 -138
  63. package/dist/esm/component/messages.d.ts.map +1 -1
  64. package/dist/esm/component/messages.js +15 -14
  65. package/dist/esm/component/messages.js.map +1 -1
  66. package/dist/esm/component/schema.d.ts +873 -3
  67. package/dist/esm/component/schema.d.ts.map +1 -1
  68. package/dist/esm/component/schema.js +39 -1
  69. package/dist/esm/component/schema.js.map +1 -1
  70. package/dist/esm/component/streams.d.ts +191 -0
  71. package/dist/esm/component/streams.d.ts.map +1 -0
  72. package/dist/esm/component/streams.js +169 -0
  73. package/dist/esm/component/streams.js.map +1 -0
  74. package/dist/esm/component/threads.d.ts +1 -1
  75. package/dist/esm/component/threads.js +3 -3
  76. package/dist/esm/component/threads.js.map +1 -1
  77. package/dist/esm/component/users.js +2 -2
  78. package/dist/esm/component/users.js.map +1 -1
  79. package/dist/esm/mapping.d.ts.map +1 -1
  80. package/dist/esm/mapping.js +3 -1
  81. package/dist/esm/mapping.js.map +1 -1
  82. package/dist/esm/react/index.d.ts +99 -0
  83. package/dist/esm/react/index.d.ts.map +1 -1
  84. package/dist/esm/react/index.js +505 -1
  85. package/dist/esm/react/index.js.map +1 -1
  86. package/dist/esm/react/toUIMessages.d.ts +8 -0
  87. package/dist/esm/react/toUIMessages.d.ts.map +1 -0
  88. package/dist/esm/react/toUIMessages.js +134 -0
  89. package/dist/esm/react/toUIMessages.js.map +1 -0
  90. package/dist/esm/validators.d.ts +506 -4
  91. package/dist/esm/validators.d.ts.map +1 -1
  92. package/dist/esm/validators.js +49 -2
  93. package/dist/esm/validators.js.map +1 -1
  94. package/package.json +5 -1
  95. package/src/client/createTool.ts +108 -0
  96. package/src/client/index.ts +270 -689
  97. package/src/client/streaming.ts +166 -0
  98. package/src/client/types.ts +430 -5
  99. package/src/component/_generated/api.d.ts +339 -188
  100. package/src/component/messages.ts +15 -14
  101. package/src/component/schema.ts +46 -0
  102. package/src/component/streams.ts +206 -0
  103. package/src/component/threads.ts +3 -3
  104. package/src/component/users.ts +2 -2
  105. package/src/mapping.ts +3 -1
  106. package/src/react/index.ts +687 -1
  107. package/src/react/toUIMessages.ts +153 -0
  108. package/src/validators.test.ts +18 -0
  109. package/src/validators.ts +72 -2
@@ -1 +1 @@
1
- {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../src/mapping.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,iBAAiB,GAUlB,MAAM,IAAI,CAAC;AAEZ,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAyBxC,MAAM,UAAU,gBAAgB,CAC9B,aAA4C;IAE5C,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,6BAA6B,EAAE,GAAG,OAAO,EAAE,GAAG,aAAa,CAAC;IAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,OAAO;QACL,8BAA8B;QAC9B,eAAe,EAAE,6BAA6B;QAC9C,GAAG,OAAO;QACV,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;KACd,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,aAA4C;IAE5C,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA0B;IAC3D,OAAO;QACL,GAAG,OAAO;QACV,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC;KAC9B,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,IAAuB;IAEvB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACtD,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC;IACrD,MAAM,QAAQ,GAAG;QACf,GAAG,IAAI,CAAC,QAAQ;QAChB,QAAQ,EAAE,OAAO;QACjB,SAAS;QACT,OAAO,EAAE,EAAE,EAAE,gCAAgC;KAC9C,CAAC;IACF,OAAO;QACL,GAAG,IAAI;QACP,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,IAAuB,EACvB,QAA6C;IAE7C,2EAA2E;IAC3E,qGAAqG;IACrG,MAAM,eAAe,GAAG;QACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,YAAY,EAAE,IAAI,CAAC,YAAY;KAChC,CAAC;IACF,MAAM,UAAU,GAAG;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO;KACtB,CAAC;IACF,MAAM,QAAQ,GAA0B,CACtC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;QACzB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACrC,CAAC,GAAG,CACH,CAAC,OAAO,EAAuB,EAAE,CAAC,CAAC;QACjC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;QAClC,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC;QAC3D,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,0BAA0B;QAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC;YACxD,8DAA8D;SAC/D,CAAC,CAAC;KACJ,CAAC,CACH,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,MAAqC,EACrC,QAA6C;IAE7C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAO;QACL,QAAQ,EAAE;YACR;gBACE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAoB,EAAE,OAAO,EAAE,IAAI,EAAE;gBACtD,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;gBACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;gBACzC,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,IAAI;gBACJ,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B;SACF;QACD,IAAI,EAAE;YACJ,IAAI;YACJ,WAAW,EAAE,KAAK;YAClB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,EAAE;YACf,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE;gBACR,GAAG,MAAM,CAAC,QAAQ;gBAClB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE;gBAC9C,QAAQ,EAAE;oBACR,sBAAsB,CAAC;wBACrB,IAAI,EAAE,WAAoB;wBAC1B,OAAO,EAAE,IAAI;wBACb,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;qBACvB,CAAC;iBACH;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAC5B,CAAC,EAAE,6BAA6B,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;QAC7C,MAAM,IAAI,GAAG,EAAE,eAAe,EAAE,6BAA6B,EAAE,GAAG,IAAI,EAAE,CAAC;QACzE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,KAAK,MAAM;gBACT,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D;gBACE,OAAO,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CACF,CAAC;IACF,OAAO,UAA+B,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA0B;IAC3D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,KAAK,MAAM;gBACT,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD;gBACE,OAAO,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CAAY,CAAC;AAChB,CAAC;AAED,0CAA0C;AAC1C,SAAS,kBAAkB,CACzB,SAA4B;IAE5B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,SAAS,YAAY,WAAW,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC,CAAC,yBAAyB;IAC7C,CAAC;IACD,IAAI,SAAS,YAAY,GAAG,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAC3B,SAAS,CAAC,UAAU,EACpB,SAAS,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAC7B,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CAAC,WAAiC;IACvD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,IACE,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC;YACjC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAClC,CAAC;YACD,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAI5B;IACC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EACF,IAAI,CAAC,IAAI,YAAY,WAAW;YAC9B,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACzB,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE;QACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAiB;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,IAG9C;IACC,MAAM,QAAQ,GAAkB,EAAE,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,gCAAgC,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,IACE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,CAAC,CAAC,EAAE,EAAE,CACJ,OAAO,CAAC,KAAK,QAAQ;YACrB,CAAC,KAAK,IAAI;YACV,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe;gBACnC,iBAAiB,IAAI,CAAC,IAAI,oBAAoB;gBAC9C,OAAO,IAAI,CAAC,IAAI,oBAAoB;gBACpC,0BAA0B,IAAI,CAAC,CAAC,CACrC,EACD,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAuB,CAAC,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,4CAA4C,CAAC,CAAC;IAC1E,OAAO,QAAQ,CAAC;AAClB,CAAC"}
1
+ {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../src/mapping.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,iBAAiB,GAUlB,MAAM,IAAI,CAAC;AAEZ,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAyBxC,MAAM,UAAU,gBAAgB,CAC9B,aAA4C;IAE5C,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,6BAA6B,EAAE,GAAG,OAAO,EAAE,GAAG,aAAa,CAAC;IAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,OAAO;QACL,8BAA8B;QAC9B,eAAe,EAAE,6BAA6B;QAC9C,GAAG,OAAO;QACV,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;KACd,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,aAA4C;IAE5C,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA0B;IAC3D,OAAO;QACL,GAAG,OAAO;QACV,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC;KAC9B,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,IAAuB;IAEvB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACtD,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC;IACrD,MAAM,QAAQ,GAAG;QACf,GAAG,IAAI,CAAC,QAAQ;QAChB,QAAQ,EAAE,OAAO;QACjB,SAAS;QACT,OAAO,EAAE,EAAE,EAAE,gCAAgC;KAC9C,CAAC;IACF,OAAO;QACL,GAAG,IAAI;QACP,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,IAAuB,EACvB,QAA6C;IAE7C,2EAA2E;IAC3E,qGAAqG;IACrG,MAAM,eAAe,GAAG;QACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,YAAY,EAAE,IAAI,CAAC,YAAY;KAChC,CAAC;IACF,MAAM,UAAU,GAAG;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO;KACtB,CAAC;IACF,MAAM,QAAQ,GAA0B,CACtC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;QACzB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACrC,CAAC,GAAG,CACH,CAAC,OAAO,EAAuB,EAAE,CAAC,CAAC;QACjC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;QAClC,0EAA0E;QAC1E,gDAAgD;QAChD,kBAAkB;QAClB,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC;QAC3D,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,0BAA0B;QAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC;YACxD,8DAA8D;SAC/D,CAAC,CAAC;KACJ,CAAC,CACH,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,MAAqC,EACrC,QAA6C;IAE7C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAO;QACL,QAAQ,EAAE;YACR;gBACE,OAAO,EAAE,EAAE,IAAI,EAAE,WAAoB,EAAE,OAAO,EAAE,IAAI,EAAE;gBACtD,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;gBACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;gBACzC,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,IAAI;gBACJ,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B;SACF;QACD,IAAI,EAAE;YACJ,IAAI;YACJ,WAAW,EAAE,KAAK;YAClB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,EAAE;YACf,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE;gBACR,GAAG,MAAM,CAAC,QAAQ;gBAClB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE;gBAC9C,QAAQ,EAAE;oBACR,sBAAsB,CAAC;wBACrB,IAAI,EAAE,WAAoB;wBAC1B,OAAO,EAAE,IAAI;wBACb,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;qBACvB,CAAC;iBACH;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAC5B,CAAC,EAAE,6BAA6B,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;QAC7C,MAAM,IAAI,GAAG,EAAE,eAAe,EAAE,6BAA6B,EAAE,GAAG,IAAI,EAAE,CAAC;QACzE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,KAAK,MAAM;gBACT,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D;gBACE,OAAO,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CACF,CAAC;IACF,OAAO,UAA+B,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA0B;IAC3D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,KAAK,MAAM;gBACT,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD;gBACE,OAAO,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CAAY,CAAC;AAChB,CAAC;AAED,0CAA0C;AAC1C,SAAS,kBAAkB,CACzB,SAA4B;IAE5B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,SAAS,YAAY,WAAW,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC,CAAC,yBAAyB;IAC7C,CAAC;IACD,IAAI,SAAS,YAAY,GAAG,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAC3B,SAAS,CAAC,UAAU,EACpB,SAAS,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAC7B,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CAAC,WAAiC;IACvD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,IACE,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC;YACjC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAClC,CAAC;YACD,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAI5B;IACC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,IAAI,EACF,IAAI,CAAC,IAAI,YAAY,WAAW;YAC9B,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACzB,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE;QACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAiB;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,IAG9C;IACC,MAAM,QAAQ,GAAkB,EAAE,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,gCAAgC,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,IACE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,CAAC,CAAC,EAAE,EAAE,CACJ,OAAO,CAAC,KAAK,QAAQ;YACrB,CAAC,KAAK,IAAI;YACV,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe;gBACnC,iBAAiB,IAAI,CAAC,IAAI,oBAAoB;gBAC9C,OAAO,IAAI,CAAC,IAAI,oBAAoB;gBACpC,0BAA0B,IAAI,CAAC,CAAC,CACrC,EACD,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAuB,CAAC,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,4CAA4C,CAAC,CAAC;IAC1E,OAAO,QAAQ,CAAC;AAClB,CAAC"}
@@ -1,4 +1,103 @@
1
+ import type { BetterOmit, ErrorMessage, Expand } from "convex-helpers";
2
+ import { type UsePaginatedQueryResult } from "convex/react";
3
+ import type { FunctionArgs, FunctionReference, PaginationOptions, PaginationResult } from "convex/server";
4
+ import type { MessageDoc } from "../client";
5
+ import type { SyncStreamsReturnValue } from "../client/types";
6
+ import type { StreamArgs } from "../validators";
7
+ import type { UIMessageOrdered } from "./toUIMessages";
8
+ import { toUIMessages } from "./toUIMessages";
9
+ export { toUIMessages, type UIMessageOrdered };
1
10
  /**
11
+ * A hook that fetches messages from a thread.
12
+ *
13
+ * This hook is a wrapper around `usePaginatedQuery` and `useStreamingThreadMessages`.
14
+ * It will fetch both full messages and streaming messages, and merge them together.
15
+ *
16
+ * The query must take as arguments `{ threadId, paginationOpts }` and return a
17
+ * pagination result of objects that extend `MessageDoc`.
18
+ *
19
+ * For streaming, it should look like this:
20
+ * ```ts
21
+ * export const listThreadMessages = query({
22
+ * args: {
23
+ * threadId: v.string(),
24
+ * paginationOpts: paginationOptsValidator,
25
+ * streamArgs: vStreamArgs,
26
+ * ... other arguments you want
27
+ * },
28
+ * handler: async (ctx, { threadId, paginationOpts, streamArgs }) => {
29
+ * // await authorizeThreadAccess(ctx, threadId);
30
+ * const paginated = await agent.listMessages(ctx, { threadId, paginationOpts });
31
+ * const streams = await agent.syncStreams(ctx, { threadId, streamArgs });
32
+ * // Here you could filter out / modify the documents & stream deltas.
33
+ * return { ...paginated, streams };
34
+ * },
35
+ * });
36
+ * ```
37
+ *
38
+ * Then the hook can be used like this:
39
+ * ```ts
40
+ * const messages = useThreadMessages(
41
+ * api.myModule.listThreadMessages,
42
+ * { threadId },
43
+ * { initialNumItems: 10, stream: true }
44
+ * );
45
+ * ```
46
+ *
47
+ * @param query The query to use to fetch messages.
48
+ * It must take as arguments `{ threadId, paginationOpts }` and return a
49
+ * pagination result of objects that extend `MessageDoc`.
50
+ * To support streaming, it must also take in `streamArgs: vStreamArgs` and
51
+ * return a `streams` object returned from `agent.syncStreams`.
52
+ * @param args The arguments to pass to the query other than `paginationOpts`
53
+ * and `streamArgs`. So `{ threadId }` at minimum, plus any other arguments that
54
+ * you want to pass to the query.
55
+ * @param options The options for the query. Similar to usePaginatedQuery.
56
+ * To enable streaming, pass `stream: true`.
57
+ * @returns The messages. If stream is true, it will return a list of messages
58
+ * that includes both full messages and streaming messages.
59
+ */
60
+ export declare function useThreadMessages<Query extends ThreadQuery<any, any>>(query: Query, args: ThreadMessagesArgs<Query> | "skip", options: {
61
+ initialNumItems: number;
62
+ stream?: Query extends ThreadStreamQuery ? boolean : ErrorMessage<"To enable streaming, your query must take in streamArgs: vStreamArgs and return a streams object returned from agent.syncStreams. See docs.">;
63
+ }): UsePaginatedQueryResult<ThreadMessagesResult<Query> & {
64
+ streaming?: boolean;
65
+ }>;
66
+ /**
67
+ * A hook that fetches streaming messages from a thread.
68
+ * This ONLY returns streaming messages. To get both, use `useThreadMessages`.
69
+ *
70
+ * @param query The query to use to fetch messages.
71
+ * It must take as arguments `{ threadId, paginationOpts, streamArgs }` and
72
+ * return a `streams` object returned from `agent.syncStreams`.
73
+ * @param args The arguments to pass to the query other than `paginationOpts`
74
+ * and `streamArgs`. So `{ threadId }` at minimum, plus any other arguments that
75
+ * you want to pass to the query.
76
+ * @returns The streaming messages.
77
+ */
78
+ export declare function useStreamingThreadMessages<Query extends ThreadStreamQuery<any, any>>(query: Query, args: ThreadMessagesArgs<Query> | "skip"): Array<ThreadMessagesResult<Query>> | undefined;
79
+ type ThreadQuery<Args = unknown, M extends MessageDoc = MessageDoc> = FunctionReference<"query", "public", {
80
+ threadId: string;
81
+ paginationOpts: PaginationOptions;
82
+ /**
83
+ * If { stream: true } is passed, it will also query for stream deltas.
84
+ * In order for this to work, the query must take as an argument streamArgs.
85
+ */
86
+ streamArgs?: StreamArgs;
87
+ } & Args, PaginationResult<M> & {
88
+ streams?: SyncStreamsReturnValue;
89
+ }>;
90
+ type ThreadStreamQuery<Args = Record<string, unknown>, M extends MessageDoc = MessageDoc> = FunctionReference<"query", "public", {
91
+ threadId: string;
92
+ paginationOpts: PaginationOptions;
93
+ streamArgs?: StreamArgs;
94
+ } & Args, PaginationResult<M> & {
95
+ streams: SyncStreamsReturnValue;
96
+ }>;
97
+ type ThreadMessagesArgs<Query extends ThreadQuery<unknown, MessageDoc>> = Query extends ThreadQuery<unknown, MessageDoc> ? Expand<BetterOmit<FunctionArgs<Query>, "paginationOpts" | "streamArgs">> : never;
98
+ type ThreadMessagesResult<Query extends ThreadQuery<unknown, MessageDoc>> = Query extends ThreadQuery<unknown, infer M> ? M : never;
99
+ /**
100
+ * @deprecated use useThreadMessages or useStreamingThreadMessages instead
2
101
  * Use this hook to stream text from a server action, using the
3
102
  * toTextStreamResponse or equivalent HTTP streaming endpoint returning text.
4
103
  * @param url The URL of the server action to stream text from.
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,CAAC,EAAE,MAAM;;;;YAOS,MAAM,oBA2C9B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAGL,KAAK,uBAAuB,EAE7B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,KAAK,EACV,UAAU,EAIX,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,EAEnC,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,MAAM,EACxC,OAAO,EAAE;IACP,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,KAAK,SAAS,iBAAiB,GACpC,OAAO,GACP,YAAY,CAAC,6IAA6I,CAAC,CAAC;CACjK,GACA,uBAAuB,CACxB,oBAAoB,CAAC,KAAK,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,CACtD,CAwCA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CAExC,KAAK,SAAS,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,EAEzC,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,GAAG,MAAM,GACvC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAoEhD;AAqTD,KAAK,WAAW,CACd,IAAI,GAAG,OAAO,EACd,CAAC,SAAS,UAAU,GAAG,UAAU,IAC/B,iBAAiB,CACnB,OAAO,EACP,QAAQ,EACR;IACE,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,iBAAiB,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,GAAG,IAAI,EACR,gBAAgB,CAAC,CAAC,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,sBAAsB,CAAA;CAAE,CAC3D,CAAC;AAEF,KAAK,iBAAiB,CACpB,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,CAAC,SAAS,UAAU,GAAG,UAAU,IAC/B,iBAAiB,CACnB,OAAO,EACP,QAAQ,EACR;IACE,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,iBAAiB,CAAC;IAClC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,GAAG,IAAI,EACR,gBAAgB,CAAC,CAAC,CAAC,GAAG;IAAE,OAAO,EAAE,sBAAsB,CAAA;CAAE,CAC1D,CAAC;AAEF,KAAK,kBAAkB,CAAC,KAAK,SAAS,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,IACpE,KAAK,SAAS,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,GAC1C,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,YAAY,CAAC,CAAC,GACxE,KAAK,CAAC;AAEZ,KAAK,oBAAoB,CAAC,KAAK,SAAS,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,IACtE,KAAK,SAAS,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AA2H1D;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,CAAC,EAAE,MAAM;;;;YAOS,MAAM,oBA2C9B"}
@@ -1,8 +1,512 @@
1
- import { useState, useMemo } from "react";
1
+ import { usePaginatedQuery, useQuery, } from "convex/react";
2
+ import { useMemo, useState } from "react";
3
+ import { toUIMessages } from "./toUIMessages";
4
+ export { toUIMessages };
5
+ /**
6
+ * A hook that fetches messages from a thread.
7
+ *
8
+ * This hook is a wrapper around `usePaginatedQuery` and `useStreamingThreadMessages`.
9
+ * It will fetch both full messages and streaming messages, and merge them together.
10
+ *
11
+ * The query must take as arguments `{ threadId, paginationOpts }` and return a
12
+ * pagination result of objects that extend `MessageDoc`.
13
+ *
14
+ * For streaming, it should look like this:
15
+ * ```ts
16
+ * export const listThreadMessages = query({
17
+ * args: {
18
+ * threadId: v.string(),
19
+ * paginationOpts: paginationOptsValidator,
20
+ * streamArgs: vStreamArgs,
21
+ * ... other arguments you want
22
+ * },
23
+ * handler: async (ctx, { threadId, paginationOpts, streamArgs }) => {
24
+ * // await authorizeThreadAccess(ctx, threadId);
25
+ * const paginated = await agent.listMessages(ctx, { threadId, paginationOpts });
26
+ * const streams = await agent.syncStreams(ctx, { threadId, streamArgs });
27
+ * // Here you could filter out / modify the documents & stream deltas.
28
+ * return { ...paginated, streams };
29
+ * },
30
+ * });
31
+ * ```
32
+ *
33
+ * Then the hook can be used like this:
34
+ * ```ts
35
+ * const messages = useThreadMessages(
36
+ * api.myModule.listThreadMessages,
37
+ * { threadId },
38
+ * { initialNumItems: 10, stream: true }
39
+ * );
40
+ * ```
41
+ *
42
+ * @param query The query to use to fetch messages.
43
+ * It must take as arguments `{ threadId, paginationOpts }` and return a
44
+ * pagination result of objects that extend `MessageDoc`.
45
+ * To support streaming, it must also take in `streamArgs: vStreamArgs` and
46
+ * return a `streams` object returned from `agent.syncStreams`.
47
+ * @param args The arguments to pass to the query other than `paginationOpts`
48
+ * and `streamArgs`. So `{ threadId }` at minimum, plus any other arguments that
49
+ * you want to pass to the query.
50
+ * @param options The options for the query. Similar to usePaginatedQuery.
51
+ * To enable streaming, pass `stream: true`.
52
+ * @returns The messages. If stream is true, it will return a list of messages
53
+ * that includes both full messages and streaming messages.
54
+ */
55
+ export function useThreadMessages(query, args, options) {
56
+ // These are full messages
57
+ const paginated = usePaginatedQuery(query, args, { initialNumItems: options.initialNumItems });
58
+ // These are streaming messages that will not include full messages.
59
+ const streamMessages = useStreamingThreadMessages(
60
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
61
+ query, !options.stream ? "skip" : args);
62
+ const merged = useMemo(() => {
63
+ const streamListMessages = streamMessages?.map((m) => ({
64
+ ...m,
65
+ streaming: true,
66
+ })) ?? [];
67
+ return {
68
+ ...paginated,
69
+ results: paginated.results
70
+ .map((m) => ({ ...m, streaming: false }))
71
+ .concat(streamListMessages)
72
+ .sort((a, b) => a.order === b.order ? a.stepOrder - b.stepOrder : a.order - b.order)
73
+ // They shouldn't overlap, but check for duplicates just in case.
74
+ .filter((m, i, arr) => !arr[i - 1] ||
75
+ m.order !== arr[i - 1].order ||
76
+ m.stepOrder !== arr[i - 1].stepOrder),
77
+ };
78
+ }, [paginated, streamMessages]);
79
+ return merged;
80
+ }
81
+ /**
82
+ * A hook that fetches streaming messages from a thread.
83
+ * This ONLY returns streaming messages. To get both, use `useThreadMessages`.
84
+ *
85
+ * @param query The query to use to fetch messages.
86
+ * It must take as arguments `{ threadId, paginationOpts, streamArgs }` and
87
+ * return a `streams` object returned from `agent.syncStreams`.
88
+ * @param args The arguments to pass to the query other than `paginationOpts`
89
+ * and `streamArgs`. So `{ threadId }` at minimum, plus any other arguments that
90
+ * you want to pass to the query.
91
+ * @returns The streaming messages.
92
+ */
93
+ export function useStreamingThreadMessages(query, args) {
94
+ // Invariant: streamMessages[streamId] is comprised of all deltas up to the
95
+ // cursor. There can be multiple messages in the same stream, e.g. for tool
96
+ // calls.
97
+ const [streams, setStreams] = useState([]);
98
+ // Get all the active streams
99
+ const streamList = useQuery(query, args === "skip"
100
+ ? args
101
+ : {
102
+ ...args,
103
+ paginationOpts: { cursor: null, numItems: 0 },
104
+ streamArgs: { kind: "list" },
105
+ });
106
+ // Get the cursors for all the active streams
107
+ const cursors = useMemo(() => {
108
+ if (!streamList?.streams)
109
+ return [];
110
+ if (streamList.streams.kind !== "list") {
111
+ throw new Error("Expected list streams");
112
+ }
113
+ return streamList.streams.messages.map(({ streamId }) => {
114
+ const stream = streams.find((s) => s.stream.streamId === streamId);
115
+ // Because of the invariant, we can just take the last chunk's end.
116
+ const cursor = stream?.cursor ?? 0;
117
+ return { streamId, cursor };
118
+ });
119
+ }, [streamList, streams]);
120
+ // Get the deltas for all the active streams, if any.
121
+ const cursorQuery = useQuery(query, args === "skip" || !streamList
122
+ ? "skip"
123
+ : {
124
+ ...args,
125
+ paginationOpts: { cursor: null, numItems: 0 },
126
+ streamArgs: { kind: "deltas", cursors },
127
+ });
128
+ // Merge any deltas into the streamChunks, keeping it unmodified if unchanged.
129
+ const [messages, newStreams, changed] = useMemo(() => {
130
+ if (args === "skip")
131
+ return [undefined, streams, false];
132
+ if (!streamList)
133
+ return [undefined, streams, false];
134
+ if (cursorQuery && cursorQuery.streams?.kind !== "deltas") {
135
+ throw new Error("Expected deltas streams");
136
+ }
137
+ return mergeDeltas(args.threadId, streamList.streams.messages, streams, cursorQuery?.streams?.deltas ?? []);
138
+ }, [cursorQuery, streams, streamList]);
139
+ // Now assemble the chunks into messages
140
+ if (args === "skip") {
141
+ return undefined;
142
+ }
143
+ if (changed) {
144
+ setStreams(newStreams);
145
+ }
146
+ return messages;
147
+ }
148
+ function mergeDeltas(threadId, streamMessages, existingStreams, allDeltas) {
149
+ const newStreams = [];
150
+ // Seed the existing chunks
151
+ let changed = false;
152
+ for (const streamMessage of streamMessages) {
153
+ const deltas = allDeltas
154
+ .filter((d) => d.streamId === streamMessage.streamId)
155
+ .sort((a, b) => a.start - b.start);
156
+ const existing = existingStreams.find((s) => s.stream.streamId === streamMessage.streamId);
157
+ const [newStream, messageChanged] = applyDeltasToStreamMessages(threadId, streamMessage, existing, deltas);
158
+ newStreams.push(newStream);
159
+ if (messageChanged)
160
+ changed = true;
161
+ }
162
+ for (const { stream } of existingStreams) {
163
+ if (!newStreams.find((s) => s.stream.streamId === stream.streamId)) {
164
+ // There's a stream that's no longer active.
165
+ changed = true;
166
+ }
167
+ }
168
+ const messages = newStreams
169
+ .sort((a, b) => a.stream.order - b.stream.order ||
170
+ a.stream.stepOrder - b.stream.stepOrder)
171
+ .map((s) => s.messages)
172
+ .flat();
173
+ return [messages, newStreams, changed];
174
+ }
175
+ function applyDeltasToStreamMessages(threadId, streamMessage, existing, deltas) {
176
+ let changed = false;
177
+ const newStream = {
178
+ stream: streamMessage,
179
+ cursor: existing?.cursor ?? 0,
180
+ messages: existing?.messages ?? [],
181
+ };
182
+ let parts = [];
183
+ for (const delta of deltas) {
184
+ if (delta.parts.length === 0) {
185
+ console.warn(`Got delta for stream ${delta.streamId} with no parts`);
186
+ continue;
187
+ }
188
+ if (newStream.cursor !== delta.start) {
189
+ if (newStream.cursor >= delta.end) {
190
+ console.debug(`Got duplicate delta for stream ${delta.streamId} at ${delta.start}`);
191
+ continue;
192
+ }
193
+ else if (newStream.cursor < delta.start) {
194
+ console.warn(`Got delta for stream ${delta.streamId} that has a gap ${newStream.cursor} -> ${delta.start}`);
195
+ continue;
196
+ }
197
+ else {
198
+ throw new Error(`Got unexpected delta for stream ${delta.streamId}: delta: ${delta.start} -> ${delta.end} existing cursor: ${newStream.cursor}`);
199
+ }
200
+ }
201
+ changed = true;
202
+ newStream.cursor = delta.end;
203
+ parts.push(...delta.parts);
204
+ }
205
+ if (!changed) {
206
+ return [existing ?? newStream, false];
207
+ }
208
+ if (!newStream.messages.at(-1)) {
209
+ newStream.messages.push(createStreamingMessage(threadId, streamMessage, parts[0], newStream.messages.length));
210
+ parts = parts.slice(1);
211
+ }
212
+ let currentMessage = newStream.messages.at(-1);
213
+ let lastContent = getLastContent(currentMessage);
214
+ for (const part of parts) {
215
+ let contentToAdd;
216
+ const isToolRole = part.type === "source" || part.type === "tool-result";
217
+ if (isToolRole !== (currentMessage.message.role === "tool")) {
218
+ currentMessage = createStreamingMessage(threadId, streamMessage, part, newStream.messages.length);
219
+ lastContent = getLastContent(currentMessage);
220
+ newStream.messages.push(currentMessage);
221
+ }
222
+ switch (part.type) {
223
+ case "text-delta":
224
+ currentMessage.text += part.textDelta;
225
+ if (lastContent?.type === "text") {
226
+ lastContent.text += part.textDelta;
227
+ }
228
+ else {
229
+ contentToAdd = {
230
+ type: "text",
231
+ text: part.textDelta,
232
+ };
233
+ }
234
+ break;
235
+ case "tool-call-streaming-start":
236
+ currentMessage.tool = true;
237
+ contentToAdd = {
238
+ type: "tool-call",
239
+ toolCallId: part.toolCallId,
240
+ toolName: part.toolName,
241
+ args: "",
242
+ };
243
+ break;
244
+ case "tool-call-delta":
245
+ {
246
+ currentMessage.tool = true;
247
+ if (lastContent?.type !== "tool-call") {
248
+ throw new Error("Expected last content to be a tool call");
249
+ }
250
+ if (typeof lastContent.args !== "string") {
251
+ throw new Error("Expected args to be a string");
252
+ }
253
+ lastContent.args += part.argsTextDelta;
254
+ }
255
+ break;
256
+ case "tool-call":
257
+ currentMessage.tool = true;
258
+ contentToAdd = part;
259
+ break;
260
+ case "reasoning":
261
+ if (lastContent?.type === "reasoning") {
262
+ lastContent.text += part.textDelta;
263
+ }
264
+ else {
265
+ contentToAdd = {
266
+ type: "reasoning",
267
+ text: part.textDelta,
268
+ };
269
+ }
270
+ break;
271
+ case "source":
272
+ if (!currentMessage.sources) {
273
+ currentMessage.sources = [];
274
+ }
275
+ currentMessage.sources.push(part.source);
276
+ break;
277
+ case "tool-result":
278
+ contentToAdd = part;
279
+ break;
280
+ default:
281
+ console.warn(`Received unexpected part: ${JSON.stringify(part)}`);
282
+ break;
283
+ }
284
+ if (contentToAdd) {
285
+ if (!currentMessage.message.content) {
286
+ currentMessage.message.content = [];
287
+ }
288
+ if (!Array.isArray(currentMessage.message?.content)) {
289
+ throw new Error("Expected message content to be an array");
290
+ }
291
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
292
+ currentMessage.message.content.push(contentToAdd);
293
+ lastContent = contentToAdd;
294
+ }
295
+ }
296
+ return [newStream, true];
297
+ }
298
+ function getLastContent(message) {
299
+ if (Array.isArray(message.message?.content)) {
300
+ return message.message.content.at(-1);
301
+ }
302
+ return undefined;
303
+ }
304
+ function createStreamingMessage(threadId, message, part, index) {
305
+ const { streamId, ...rest } = message;
306
+ const metadata = {
307
+ _id: `${streamId}-${index}`,
308
+ _creationTime: Date.now(),
309
+ status: "pending",
310
+ threadId,
311
+ tool: false,
312
+ ...rest,
313
+ };
314
+ switch (part.type) {
315
+ case "text-delta":
316
+ return {
317
+ ...metadata,
318
+ message: {
319
+ role: "assistant",
320
+ content: [{ type: "text", text: part.textDelta }],
321
+ },
322
+ text: part.textDelta,
323
+ };
324
+ case "tool-call-streaming-start":
325
+ return {
326
+ ...metadata,
327
+ tool: true,
328
+ message: {
329
+ role: "assistant",
330
+ content: [
331
+ {
332
+ type: "tool-call",
333
+ toolName: part.toolName,
334
+ toolCallId: part.toolCallId,
335
+ args: "", // when it's a string, it's a partial call
336
+ },
337
+ ],
338
+ },
339
+ };
340
+ case "reasoning":
341
+ return {
342
+ ...metadata,
343
+ message: {
344
+ role: "assistant",
345
+ content: [{ type: "reasoning", text: part.textDelta }],
346
+ },
347
+ reasoning: part.textDelta,
348
+ };
349
+ case "source":
350
+ console.warn("Received source part first??");
351
+ return {
352
+ ...metadata,
353
+ tool: true,
354
+ message: { role: "tool", content: [] },
355
+ sources: [part.source],
356
+ };
357
+ case "tool-call":
358
+ return {
359
+ ...metadata,
360
+ tool: true,
361
+ message: { role: "assistant", content: [part] },
362
+ };
363
+ case "tool-call-delta":
364
+ console.warn("Received tool call delta part first??");
365
+ return {
366
+ ...metadata,
367
+ tool: true,
368
+ message: {
369
+ role: "assistant",
370
+ content: [
371
+ {
372
+ type: "tool-call",
373
+ toolCallId: part.toolCallId,
374
+ toolName: part.toolName,
375
+ args: part.argsTextDelta,
376
+ },
377
+ ],
378
+ },
379
+ };
380
+ case "tool-result":
381
+ return {
382
+ ...metadata,
383
+ tool: true,
384
+ message: { role: "tool", content: [part] },
385
+ };
386
+ default:
387
+ throw new Error(`Unexpected part type: ${JSON.stringify(part)}`);
388
+ }
389
+ }
390
+ // TODO: pass in the messages we need to watch? that way it can be consistent..
391
+ // export function streamMessagesToUIMessages(
392
+ // messages: StreamsChunk[],
393
+ // keyOrder: string[]
394
+ // ): UIMessageOrdered[] {
395
+ // const uiMessagesByMessageId: Record<string, UIMessageOrdered[]> = {};
396
+ // for (const message of messages) {
397
+ // if (message.deltas.length === 0) {
398
+ // continue;
399
+ // }
400
+ // if (!uiMessagesByMessageId[message.key]) {
401
+ // uiMessagesByMessageId[message.key] = [];
402
+ // }
403
+ // if (uiMessagesByMessageId[message.key].length === 0) {
404
+ // uiMessagesByMessageId[message.key] = [
405
+ // createUIMessageFromPart(message.deltas[0], {
406
+ // id: message.key,
407
+ // createdAt: new Date(),
408
+ // }),
409
+ // ];
410
+ // }
411
+ // const currentMessage = uiMessagesByMessageId[message.key].at(-1)!;
412
+ // const lastPart = currentMessage.parts.at(-1);
413
+ // for (const delta of message.deltas) {
414
+ // switch (delta.type) {
415
+ // case "text-delta":
416
+ // currentMessage.content += delta.textDelta;
417
+ // if (lastPart?.type === "text") {
418
+ // lastPart.text += delta.textDelta;
419
+ // } else {
420
+ // currentMessage.parts.push({
421
+ // type: "text",
422
+ // text: delta.textDelta,
423
+ // });
424
+ // }
425
+ // break;
426
+ // case "tool-call-delta": {
427
+ // let lastToolInvocation: ToolInvocationUIPart | undefined;
428
+ // for (let i = currentMessage.parts.length - 1; i >= 0; i--) {
429
+ // const part = currentMessage.parts[i];
430
+ // if (
431
+ // part.type === "tool-invocation" &&
432
+ // part.toolInvocation.state === "partial-call"
433
+ // ) {
434
+ // lastToolInvocation = part;
435
+ // break;
436
+ // }
437
+ // }
438
+ // if (lastToolInvocation) {
439
+ // lastToolInvocation.toolInvocation = {
440
+ // ...lastToolInvocation.toolInvocation,
441
+ // state: "call",
442
+ // };
443
+ // break;
444
+ // }
445
+ // console.error(
446
+ // `Received a tool call delta without a previous tool invocation: ${JSON.stringify(currentMessage.parts)}, creating one anyways...`
447
+ // );
448
+ // }
449
+ // // fallthrough
450
+ // case "tool-call-streaming-start":
451
+ // currentMessage.parts.push({
452
+ // type: "tool-invocation",
453
+ // toolInvocation: {
454
+ // toolCallId: delta.toolCallId,
455
+ // toolName: delta.toolName,
456
+ // args: {},
457
+ // state: "partial-call",
458
+ // step:
459
+ // currentMessage.parts.filter(
460
+ // (part) => part.type === "tool-invocation"
461
+ // ).length + 1,
462
+ // },
463
+ // });
464
+ // break;
465
+ // case "tool-call":
466
+ // currentMessage.parts.push({
467
+ // type: "tool-invocation",
468
+ // toolInvocation: {
469
+ // toolCallId: delta.toolCallId,
470
+ // toolName: delta.toolName,
471
+ // args: delta.args,
472
+ // state: "call",
473
+ // step:
474
+ // currentMessage.parts.filter(
475
+ // (part) => part.type === "tool-invocation"
476
+ // ).length + 1,
477
+ // },
478
+ // });
479
+ // break;
480
+ // case "reasoning":
481
+ // if (lastPart?.type === "reasoning") {
482
+ // lastPart.reasoning += delta.textDelta;
483
+ // } else {
484
+ // currentMessage.parts.push({
485
+ // type: "reasoning",
486
+ // reasoning: delta.textDelta,
487
+ // details: [],
488
+ // });
489
+ // }
490
+ // break;
491
+ // case "source":
492
+ // currentMessage.parts.push({
493
+ // type: "source",
494
+ // source: delta.source,
495
+ // });
496
+ // break;
497
+ // default:
498
+ // console.warn(`Received unexpected part: ${JSON.stringify(delta)}`);
499
+ // break;
500
+ // }
501
+ // }
502
+ // }
503
+ // return keyOrder.map((key) => uiMessagesByMessageId[key]).flat();
504
+ // }
2
505
  if (typeof window === "undefined") {
3
506
  throw new Error("this is frontend code, but it's running somewhere else!");
4
507
  }
5
508
  /**
509
+ * @deprecated use useThreadMessages or useStreamingThreadMessages instead
6
510
  * Use this hook to stream text from a server action, using the
7
511
  * toTextStreamResponse or equivalent HTTP streaming endpoint returning text.
8
512
  * @param url The URL of the server action to stream text from.