@orq-ai/node 3.2.0-rc.9 → 3.2.1

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 (643) hide show
  1. package/README.md +117 -1
  2. package/bin/mcp-server.js +52509 -0
  3. package/bin/mcp-server.js.map +352 -0
  4. package/docs/sdks/datasets/README.md +934 -0
  5. package/docs/sdks/files/README.md +1 -1
  6. package/docs/sdks/prompts/README.md +110 -110
  7. package/funcs/datasetsClear.d.ts +16 -0
  8. package/funcs/datasetsClear.d.ts.map +1 -0
  9. package/funcs/datasetsClear.js +118 -0
  10. package/funcs/datasetsClear.js.map +1 -0
  11. package/funcs/datasetsCreate.d.ts +16 -0
  12. package/funcs/datasetsCreate.d.ts.map +1 -0
  13. package/funcs/datasetsCreate.js +114 -0
  14. package/funcs/datasetsCreate.js.map +1 -0
  15. package/funcs/datasetsCreateDatapoint.d.ts +16 -0
  16. package/funcs/datasetsCreateDatapoint.d.ts.map +1 -0
  17. package/funcs/datasetsCreateDatapoint.js +118 -0
  18. package/funcs/datasetsCreateDatapoint.js.map +1 -0
  19. package/funcs/datasetsCreateDatapoints.d.ts +16 -0
  20. package/funcs/datasetsCreateDatapoints.d.ts.map +1 -0
  21. package/funcs/datasetsCreateDatapoints.js +119 -0
  22. package/funcs/datasetsCreateDatapoints.js.map +1 -0
  23. package/funcs/datasetsDelete.d.ts +16 -0
  24. package/funcs/datasetsDelete.d.ts.map +1 -0
  25. package/funcs/datasetsDelete.js +118 -0
  26. package/funcs/datasetsDelete.js.map +1 -0
  27. package/funcs/datasetsDeleteDatapoint.d.ts +17 -0
  28. package/funcs/datasetsDeleteDatapoint.d.ts.map +1 -0
  29. package/funcs/datasetsDeleteDatapoint.js +126 -0
  30. package/funcs/datasetsDeleteDatapoint.js.map +1 -0
  31. package/funcs/datasetsList.d.ts +16 -0
  32. package/funcs/datasetsList.d.ts.map +1 -0
  33. package/funcs/datasetsList.js +118 -0
  34. package/funcs/datasetsList.js.map +1 -0
  35. package/funcs/datasetsListDatapoints.d.ts +16 -0
  36. package/funcs/datasetsListDatapoints.d.ts.map +1 -0
  37. package/funcs/datasetsListDatapoints.js +124 -0
  38. package/funcs/datasetsListDatapoints.js.map +1 -0
  39. package/funcs/datasetsRetrieve.d.ts +17 -0
  40. package/funcs/datasetsRetrieve.d.ts.map +1 -0
  41. package/funcs/datasetsRetrieve.js +121 -0
  42. package/funcs/datasetsRetrieve.js.map +1 -0
  43. package/funcs/datasetsRetrieveDatapoint.d.ts +17 -0
  44. package/funcs/datasetsRetrieveDatapoint.d.ts.map +1 -0
  45. package/funcs/datasetsRetrieveDatapoint.js +125 -0
  46. package/funcs/datasetsRetrieveDatapoint.js.map +1 -0
  47. package/funcs/datasetsUpdate.d.ts +17 -0
  48. package/funcs/datasetsUpdate.d.ts.map +1 -0
  49. package/funcs/datasetsUpdate.js +122 -0
  50. package/funcs/datasetsUpdate.js.map +1 -0
  51. package/funcs/datasetsUpdateDatapoint.d.ts +14 -0
  52. package/funcs/datasetsUpdateDatapoint.d.ts.map +1 -0
  53. package/funcs/datasetsUpdateDatapoint.js +123 -0
  54. package/funcs/datasetsUpdateDatapoint.js.map +1 -0
  55. package/funcs/deploymentsList.js +1 -0
  56. package/funcs/deploymentsList.js.map +1 -1
  57. package/funcs/filesCreate.d.ts +1 -1
  58. package/funcs/filesCreate.js +1 -1
  59. package/funcs/filesList.js +1 -0
  60. package/funcs/filesList.js.map +1 -1
  61. package/funcs/promptsList.js +2 -1
  62. package/funcs/promptsList.js.map +1 -1
  63. package/funcs/promptsListVersions.js +1 -0
  64. package/funcs/promptsListVersions.js.map +1 -1
  65. package/jsr.json +1 -1
  66. package/lib/config.d.ts +6 -6
  67. package/lib/config.d.ts.map +1 -1
  68. package/lib/config.js +3 -3
  69. package/lib/config.js.map +1 -1
  70. package/lib/files.js.map +1 -1
  71. package/lib/primitives.d.ts +3 -0
  72. package/lib/primitives.d.ts.map +1 -1
  73. package/lib/primitives.js +7 -0
  74. package/lib/primitives.js.map +1 -1
  75. package/lib/sdks.d.ts.map +1 -1
  76. package/lib/sdks.js +2 -8
  77. package/lib/sdks.js.map +1 -1
  78. package/lib/security.d.ts +4 -3
  79. package/lib/security.d.ts.map +1 -1
  80. package/lib/security.js +6 -1
  81. package/lib/security.js.map +1 -1
  82. package/mcp-server/build.d.mts.map +1 -0
  83. package/mcp-server/build.mjs +14 -0
  84. package/mcp-server/build.mjs.map +1 -0
  85. package/mcp-server/cli/start/command.d.ts +2 -0
  86. package/mcp-server/cli/start/command.d.ts.map +1 -0
  87. package/mcp-server/cli/start/command.js +154 -0
  88. package/mcp-server/cli/start/command.js.map +1 -0
  89. package/mcp-server/cli/start/impl.d.ts +20 -0
  90. package/mcp-server/cli/start/impl.d.ts.map +1 -0
  91. package/mcp-server/cli/start/impl.js +108 -0
  92. package/mcp-server/cli/start/impl.js.map +1 -0
  93. package/mcp-server/cli.d.ts +6 -0
  94. package/mcp-server/cli.d.ts.map +1 -0
  95. package/mcp-server/cli.js +10 -0
  96. package/mcp-server/cli.js.map +1 -0
  97. package/mcp-server/console-logger.d.ts +7 -0
  98. package/mcp-server/console-logger.d.ts.map +1 -0
  99. package/mcp-server/console-logger.js +59 -0
  100. package/mcp-server/console-logger.js.map +1 -0
  101. package/mcp-server/extensions.d.ts +11 -0
  102. package/mcp-server/extensions.d.ts.map +1 -0
  103. package/mcp-server/extensions.js +6 -0
  104. package/mcp-server/extensions.js.map +1 -0
  105. package/mcp-server/mcp-server.d.ts +2 -0
  106. package/mcp-server/mcp-server.d.ts.map +1 -0
  107. package/mcp-server/mcp-server.js +29 -0
  108. package/mcp-server/mcp-server.js.map +1 -0
  109. package/mcp-server/prompts.d.ts +26 -0
  110. package/mcp-server/prompts.d.ts.map +1 -0
  111. package/mcp-server/prompts.js +47 -0
  112. package/mcp-server/prompts.js.map +1 -0
  113. package/mcp-server/resources.d.ts +32 -0
  114. package/mcp-server/resources.d.ts.map +1 -0
  115. package/mcp-server/resources.js +79 -0
  116. package/mcp-server/resources.js.map +1 -0
  117. package/mcp-server/scopes.d.ts +3 -0
  118. package/mcp-server/scopes.d.ts.map +1 -0
  119. package/mcp-server/scopes.js +8 -0
  120. package/mcp-server/scopes.js.map +1 -0
  121. package/mcp-server/server.d.ts +15 -0
  122. package/mcp-server/server.d.ts.map +1 -0
  123. package/mcp-server/server.js +95 -0
  124. package/mcp-server/server.js.map +1 -0
  125. package/mcp-server/shared.d.ts +7 -0
  126. package/mcp-server/shared.d.ts.map +1 -0
  127. package/mcp-server/shared.js +98 -0
  128. package/mcp-server/shared.js.map +1 -0
  129. package/mcp-server/tools/contactsCreate.d.ts +8 -0
  130. package/mcp-server/tools/contactsCreate.d.ts.map +1 -0
  131. package/mcp-server/tools/contactsCreate.js +64 -0
  132. package/mcp-server/tools/contactsCreate.js.map +1 -0
  133. package/mcp-server/tools/datasetsClear.d.ts +8 -0
  134. package/mcp-server/tools/datasetsClear.d.ts.map +1 -0
  135. package/mcp-server/tools/datasetsClear.js +63 -0
  136. package/mcp-server/tools/datasetsClear.js.map +1 -0
  137. package/mcp-server/tools/datasetsCreate.d.ts +8 -0
  138. package/mcp-server/tools/datasetsCreate.d.ts.map +1 -0
  139. package/mcp-server/tools/datasetsCreate.js +64 -0
  140. package/mcp-server/tools/datasetsCreate.js.map +1 -0
  141. package/mcp-server/tools/datasetsCreateDatapoint.d.ts +8 -0
  142. package/mcp-server/tools/datasetsCreateDatapoint.d.ts.map +1 -0
  143. package/mcp-server/tools/datasetsCreateDatapoint.js +64 -0
  144. package/mcp-server/tools/datasetsCreateDatapoint.js.map +1 -0
  145. package/mcp-server/tools/datasetsCreateDatapoints.d.ts +8 -0
  146. package/mcp-server/tools/datasetsCreateDatapoints.d.ts.map +1 -0
  147. package/mcp-server/tools/datasetsCreateDatapoints.js +64 -0
  148. package/mcp-server/tools/datasetsCreateDatapoints.js.map +1 -0
  149. package/mcp-server/tools/datasetsDelete.d.ts +8 -0
  150. package/mcp-server/tools/datasetsDelete.d.ts.map +1 -0
  151. package/mcp-server/tools/datasetsDelete.js +63 -0
  152. package/mcp-server/tools/datasetsDelete.js.map +1 -0
  153. package/mcp-server/tools/datasetsDeleteDatapoint.d.ts +8 -0
  154. package/mcp-server/tools/datasetsDeleteDatapoint.d.ts.map +1 -0
  155. package/mcp-server/tools/datasetsDeleteDatapoint.js +63 -0
  156. package/mcp-server/tools/datasetsDeleteDatapoint.js.map +1 -0
  157. package/mcp-server/tools/datasetsList.d.ts +8 -0
  158. package/mcp-server/tools/datasetsList.d.ts.map +1 -0
  159. package/mcp-server/tools/datasetsList.js +64 -0
  160. package/mcp-server/tools/datasetsList.js.map +1 -0
  161. package/mcp-server/tools/datasetsListDatapoints.d.ts +8 -0
  162. package/mcp-server/tools/datasetsListDatapoints.d.ts.map +1 -0
  163. package/mcp-server/tools/datasetsListDatapoints.js +64 -0
  164. package/mcp-server/tools/datasetsListDatapoints.js.map +1 -0
  165. package/mcp-server/tools/datasetsRetrieve.d.ts +8 -0
  166. package/mcp-server/tools/datasetsRetrieve.d.ts.map +1 -0
  167. package/mcp-server/tools/datasetsRetrieve.js +64 -0
  168. package/mcp-server/tools/datasetsRetrieve.js.map +1 -0
  169. package/mcp-server/tools/datasetsRetrieveDatapoint.d.ts +8 -0
  170. package/mcp-server/tools/datasetsRetrieveDatapoint.d.ts.map +1 -0
  171. package/mcp-server/tools/datasetsRetrieveDatapoint.js +64 -0
  172. package/mcp-server/tools/datasetsRetrieveDatapoint.js.map +1 -0
  173. package/mcp-server/tools/datasetsUpdate.d.ts +8 -0
  174. package/mcp-server/tools/datasetsUpdate.d.ts.map +1 -0
  175. package/mcp-server/tools/datasetsUpdate.js +64 -0
  176. package/mcp-server/tools/datasetsUpdate.js.map +1 -0
  177. package/mcp-server/tools/datasetsUpdateDatapoint.d.ts +8 -0
  178. package/mcp-server/tools/datasetsUpdateDatapoint.d.ts.map +1 -0
  179. package/mcp-server/tools/datasetsUpdateDatapoint.js +62 -0
  180. package/mcp-server/tools/datasetsUpdateDatapoint.js.map +1 -0
  181. package/mcp-server/tools/deploymentsGetConfig.d.ts +8 -0
  182. package/mcp-server/tools/deploymentsGetConfig.d.ts.map +1 -0
  183. package/mcp-server/tools/deploymentsGetConfig.js +64 -0
  184. package/mcp-server/tools/deploymentsGetConfig.js.map +1 -0
  185. package/mcp-server/tools/deploymentsInvoke.d.ts +8 -0
  186. package/mcp-server/tools/deploymentsInvoke.d.ts.map +1 -0
  187. package/mcp-server/tools/deploymentsInvoke.js +64 -0
  188. package/mcp-server/tools/deploymentsInvoke.js.map +1 -0
  189. package/mcp-server/tools/deploymentsList.d.ts +8 -0
  190. package/mcp-server/tools/deploymentsList.d.ts.map +1 -0
  191. package/mcp-server/tools/deploymentsList.js +64 -0
  192. package/mcp-server/tools/deploymentsList.js.map +1 -0
  193. package/mcp-server/tools/deploymentsMetricsCreate.d.ts +8 -0
  194. package/mcp-server/tools/deploymentsMetricsCreate.d.ts.map +1 -0
  195. package/mcp-server/tools/deploymentsMetricsCreate.js +64 -0
  196. package/mcp-server/tools/deploymentsMetricsCreate.js.map +1 -0
  197. package/mcp-server/tools/feedbackCreate.d.ts +8 -0
  198. package/mcp-server/tools/feedbackCreate.d.ts.map +1 -0
  199. package/mcp-server/tools/feedbackCreate.js +64 -0
  200. package/mcp-server/tools/feedbackCreate.js.map +1 -0
  201. package/mcp-server/tools/filesCreate.d.ts +8 -0
  202. package/mcp-server/tools/filesCreate.d.ts.map +1 -0
  203. package/mcp-server/tools/filesCreate.js +64 -0
  204. package/mcp-server/tools/filesCreate.js.map +1 -0
  205. package/mcp-server/tools/filesDelete.d.ts +8 -0
  206. package/mcp-server/tools/filesDelete.d.ts.map +1 -0
  207. package/mcp-server/tools/filesDelete.js +61 -0
  208. package/mcp-server/tools/filesDelete.js.map +1 -0
  209. package/mcp-server/tools/filesGet.d.ts +8 -0
  210. package/mcp-server/tools/filesGet.d.ts.map +1 -0
  211. package/mcp-server/tools/filesGet.js +64 -0
  212. package/mcp-server/tools/filesGet.js.map +1 -0
  213. package/mcp-server/tools/filesList.d.ts +8 -0
  214. package/mcp-server/tools/filesList.d.ts.map +1 -0
  215. package/mcp-server/tools/filesList.js +64 -0
  216. package/mcp-server/tools/filesList.js.map +1 -0
  217. package/mcp-server/tools/promptsCreate.d.ts +8 -0
  218. package/mcp-server/tools/promptsCreate.d.ts.map +1 -0
  219. package/mcp-server/tools/promptsCreate.js +62 -0
  220. package/mcp-server/tools/promptsCreate.js.map +1 -0
  221. package/mcp-server/tools/promptsDelete.d.ts +8 -0
  222. package/mcp-server/tools/promptsDelete.d.ts.map +1 -0
  223. package/mcp-server/tools/promptsDelete.js +61 -0
  224. package/mcp-server/tools/promptsDelete.js.map +1 -0
  225. package/mcp-server/tools/promptsGetVersion.d.ts +8 -0
  226. package/mcp-server/tools/promptsGetVersion.d.ts.map +1 -0
  227. package/mcp-server/tools/promptsGetVersion.js +64 -0
  228. package/mcp-server/tools/promptsGetVersion.js.map +1 -0
  229. package/mcp-server/tools/promptsList.d.ts +8 -0
  230. package/mcp-server/tools/promptsList.d.ts.map +1 -0
  231. package/mcp-server/tools/promptsList.js +64 -0
  232. package/mcp-server/tools/promptsList.js.map +1 -0
  233. package/mcp-server/tools/promptsListVersions.d.ts +8 -0
  234. package/mcp-server/tools/promptsListVersions.d.ts.map +1 -0
  235. package/mcp-server/tools/promptsListVersions.js +64 -0
  236. package/mcp-server/tools/promptsListVersions.js.map +1 -0
  237. package/mcp-server/tools/promptsRetrieve.d.ts +8 -0
  238. package/mcp-server/tools/promptsRetrieve.d.ts.map +1 -0
  239. package/mcp-server/tools/promptsRetrieve.js +64 -0
  240. package/mcp-server/tools/promptsRetrieve.js.map +1 -0
  241. package/mcp-server/tools/promptsUpdate.d.ts +8 -0
  242. package/mcp-server/tools/promptsUpdate.d.ts.map +1 -0
  243. package/mcp-server/tools/promptsUpdate.js +62 -0
  244. package/mcp-server/tools/promptsUpdate.js.map +1 -0
  245. package/mcp-server/tools/remoteconfigsRetrieve.d.ts +8 -0
  246. package/mcp-server/tools/remoteconfigsRetrieve.d.ts.map +1 -0
  247. package/mcp-server/tools/remoteconfigsRetrieve.js +63 -0
  248. package/mcp-server/tools/remoteconfigsRetrieve.js.map +1 -0
  249. package/mcp-server/tools.d.ts +25 -0
  250. package/mcp-server/tools.d.ts.map +1 -0
  251. package/mcp-server/tools.js +81 -0
  252. package/mcp-server/tools.js.map +1 -0
  253. package/models/components/deployments.d.ts +1716 -400
  254. package/models/components/deployments.d.ts.map +1 -1
  255. package/models/components/deployments.js +1617 -357
  256. package/models/components/deployments.js.map +1 -1
  257. package/models/operations/bulkcreatedatapoints.d.ts +873 -0
  258. package/models/operations/bulkcreatedatapoints.d.ts.map +1 -0
  259. package/models/operations/bulkcreatedatapoints.js +933 -0
  260. package/models/operations/bulkcreatedatapoints.js.map +1 -0
  261. package/models/operations/cleardataset.d.ts +29 -0
  262. package/models/operations/cleardataset.d.ts.map +1 -0
  263. package/models/operations/cleardataset.js +78 -0
  264. package/models/operations/cleardataset.js.map +1 -0
  265. package/models/operations/createcontact.js +2 -2
  266. package/models/operations/createdataset.d.ts +132 -0
  267. package/models/operations/createdataset.d.ts.map +1 -0
  268. package/models/operations/createdataset.js +182 -0
  269. package/models/operations/createdataset.js.map +1 -0
  270. package/models/operations/createdatasetitem.d.ts +851 -0
  271. package/models/operations/createdatasetitem.d.ts.map +1 -0
  272. package/models/operations/createdatasetitem.js +904 -0
  273. package/models/operations/createdatasetitem.js.map +1 -0
  274. package/models/operations/createprompt.d.ts +347 -337
  275. package/models/operations/createprompt.d.ts.map +1 -1
  276. package/models/operations/createprompt.js +474 -473
  277. package/models/operations/createprompt.js.map +1 -1
  278. package/models/operations/deletedatapoint.d.ts +31 -0
  279. package/models/operations/deletedatapoint.d.ts.map +1 -0
  280. package/models/operations/deletedatapoint.js +82 -0
  281. package/models/operations/deletedatapoint.js.map +1 -0
  282. package/models/operations/deletedataset.d.ts +29 -0
  283. package/models/operations/deletedataset.d.ts.map +1 -0
  284. package/models/operations/deletedataset.js +78 -0
  285. package/models/operations/deletedataset.js.map +1 -0
  286. package/models/operations/deploymentcreatemetric.d.ts +1706 -418
  287. package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
  288. package/models/operations/deploymentcreatemetric.js +1713 -435
  289. package/models/operations/deploymentcreatemetric.js.map +1 -1
  290. package/models/operations/deploymentgetconfig.d.ts +1831 -510
  291. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  292. package/models/operations/deploymentgetconfig.js +1786 -519
  293. package/models/operations/deploymentgetconfig.js.map +1 -1
  294. package/models/operations/deploymentinvoke.d.ts +249 -177
  295. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  296. package/models/operations/deploymentinvoke.js +263 -201
  297. package/models/operations/deploymentinvoke.js.map +1 -1
  298. package/models/operations/deployments.d.ts +41 -0
  299. package/models/operations/deployments.d.ts.map +1 -1
  300. package/models/operations/deployments.js +29 -3
  301. package/models/operations/deployments.js.map +1 -1
  302. package/models/operations/fileget.d.ts +3 -0
  303. package/models/operations/fileget.d.ts.map +1 -1
  304. package/models/operations/fileget.js +3 -2
  305. package/models/operations/fileget.js.map +1 -1
  306. package/models/operations/filelist.d.ts +39 -0
  307. package/models/operations/filelist.d.ts.map +1 -1
  308. package/models/operations/filelist.js +28 -3
  309. package/models/operations/filelist.js.map +1 -1
  310. package/models/operations/fileupload.d.ts +6 -0
  311. package/models/operations/fileupload.d.ts.map +1 -1
  312. package/models/operations/fileupload.js +4 -2
  313. package/models/operations/fileupload.js.map +1 -1
  314. package/models/operations/getallprompts.d.ts +45 -4
  315. package/models/operations/getallprompts.d.ts.map +1 -1
  316. package/models/operations/getallprompts.js +33 -7
  317. package/models/operations/getallprompts.js.map +1 -1
  318. package/models/operations/getoneprompt.d.ts +9 -4
  319. package/models/operations/getoneprompt.d.ts.map +1 -1
  320. package/models/operations/getoneprompt.js +6 -4
  321. package/models/operations/getoneprompt.js.map +1 -1
  322. package/models/operations/getpromptversion.d.ts +9 -4
  323. package/models/operations/getpromptversion.d.ts.map +1 -1
  324. package/models/operations/getpromptversion.js +6 -4
  325. package/models/operations/getpromptversion.js.map +1 -1
  326. package/models/operations/index.d.ts +12 -0
  327. package/models/operations/index.d.ts.map +1 -1
  328. package/models/operations/index.js +12 -0
  329. package/models/operations/index.js.map +1 -1
  330. package/models/operations/listdatasetdatapoints.d.ts +563 -0
  331. package/models/operations/listdatasetdatapoints.d.ts.map +1 -0
  332. package/models/operations/listdatasetdatapoints.js +593 -0
  333. package/models/operations/listdatasetdatapoints.js.map +1 -0
  334. package/models/operations/listdatasets.d.ts +225 -0
  335. package/models/operations/listdatasets.d.ts.map +1 -0
  336. package/models/operations/listdatasets.js +267 -0
  337. package/models/operations/listdatasets.js.map +1 -0
  338. package/models/operations/listpromptversions.d.ts +45 -4
  339. package/models/operations/listpromptversions.d.ts.map +1 -1
  340. package/models/operations/listpromptversions.js +33 -7
  341. package/models/operations/listpromptversions.js.map +1 -1
  342. package/models/operations/retrievedatapoint.d.ts +463 -0
  343. package/models/operations/retrievedatapoint.d.ts.map +1 -0
  344. package/models/operations/retrievedatapoint.js +507 -0
  345. package/models/operations/retrievedatapoint.js.map +1 -0
  346. package/models/operations/retrievedataset.d.ts +124 -0
  347. package/models/operations/retrievedataset.d.ts.map +1 -0
  348. package/models/operations/retrievedataset.js +180 -0
  349. package/models/operations/retrievedataset.js.map +1 -0
  350. package/models/operations/updatedatapoint.d.ts +853 -0
  351. package/models/operations/updatedatapoint.d.ts.map +1 -0
  352. package/models/operations/updatedatapoint.js +909 -0
  353. package/models/operations/updatedatapoint.js.map +1 -0
  354. package/models/operations/updatedataset.d.ts +161 -0
  355. package/models/operations/updatedataset.d.ts.map +1 -0
  356. package/models/operations/updatedataset.js +225 -0
  357. package/models/operations/updatedataset.js.map +1 -0
  358. package/models/operations/updateprompt.d.ts +335 -325
  359. package/models/operations/updateprompt.d.ts.map +1 -1
  360. package/models/operations/updateprompt.js +456 -452
  361. package/models/operations/updateprompt.js.map +1 -1
  362. package/package.json +17 -4
  363. package/packages/orq-rc/FUNCTIONS.md +106 -0
  364. package/packages/orq-rc/README.md +622 -0
  365. package/packages/orq-rc/RUNTIMES.md +48 -0
  366. package/packages/orq-rc/docs/sdks/contacts/README.md +84 -0
  367. package/packages/orq-rc/docs/sdks/datasets/README.md +934 -0
  368. package/packages/orq-rc/docs/sdks/deployments/README.md +235 -0
  369. package/packages/orq-rc/docs/sdks/feedback/README.md +92 -0
  370. package/packages/orq-rc/docs/sdks/files/README.md +305 -0
  371. package/packages/orq-rc/docs/sdks/metrics/README.md +86 -0
  372. package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
  373. package/packages/orq-rc/docs/sdks/prompts/README.md +608 -0
  374. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +80 -0
  375. package/packages/orq-rc/jsr.json +27 -0
  376. package/packages/orq-rc/package-lock.json +3217 -0
  377. package/packages/orq-rc/package.json +45 -0
  378. package/packages/orq-rc/src/core.ts +13 -0
  379. package/packages/orq-rc/src/funcs/contactsCreate.ts +154 -0
  380. package/packages/orq-rc/src/funcs/datasetsClear.ts +161 -0
  381. package/packages/orq-rc/src/funcs/datasetsCreate.ts +159 -0
  382. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +161 -0
  383. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +165 -0
  384. package/packages/orq-rc/src/funcs/datasetsDelete.ts +161 -0
  385. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +176 -0
  386. package/packages/orq-rc/src/funcs/datasetsList.ts +162 -0
  387. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +169 -0
  388. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +169 -0
  389. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +175 -0
  390. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +170 -0
  391. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +173 -0
  392. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +162 -0
  393. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +170 -0
  394. package/packages/orq-rc/src/funcs/deploymentsList.ts +171 -0
  395. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +162 -0
  396. package/packages/orq-rc/src/funcs/feedbackCreate.ts +154 -0
  397. package/packages/orq-rc/src/funcs/filesCreate.ts +177 -0
  398. package/packages/orq-rc/src/funcs/filesDelete.ts +158 -0
  399. package/packages/orq-rc/src/funcs/filesGet.ts +160 -0
  400. package/packages/orq-rc/src/funcs/filesList.ts +162 -0
  401. package/packages/orq-rc/src/funcs/promptsCreate.ts +154 -0
  402. package/packages/orq-rc/src/funcs/promptsDelete.ts +158 -0
  403. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +175 -0
  404. package/packages/orq-rc/src/funcs/promptsList.ts +162 -0
  405. package/packages/orq-rc/src/funcs/promptsListVersions.ts +168 -0
  406. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +160 -0
  407. package/packages/orq-rc/src/funcs/promptsUpdate.ts +167 -0
  408. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +155 -0
  409. package/packages/orq-rc/src/hooks/global.ts +44 -0
  410. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  411. package/packages/orq-rc/src/hooks/index.ts +6 -0
  412. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  413. package/packages/orq-rc/src/hooks/types.ts +110 -0
  414. package/packages/orq-rc/src/index.ts +7 -0
  415. package/packages/orq-rc/src/lib/base64.ts +37 -0
  416. package/packages/orq-rc/src/lib/config.ts +70 -0
  417. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  418. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  419. package/packages/orq-rc/src/lib/env.ts +73 -0
  420. package/packages/orq-rc/src/lib/files.ts +40 -0
  421. package/packages/orq-rc/src/lib/http.ts +323 -0
  422. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  423. package/packages/orq-rc/src/lib/logger.ts +9 -0
  424. package/packages/orq-rc/src/lib/matchers.ts +322 -0
  425. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  426. package/packages/orq-rc/src/lib/retries.ts +218 -0
  427. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  428. package/packages/orq-rc/src/lib/sdks.ts +395 -0
  429. package/packages/orq-rc/src/lib/security.ts +253 -0
  430. package/packages/orq-rc/src/lib/url.ts +33 -0
  431. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +125 -0
  432. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +140 -0
  433. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  434. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  435. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  436. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  437. package/packages/orq-rc/src/mcp-server/prompts.ts +110 -0
  438. package/packages/orq-rc/src/mcp-server/resources.ts +158 -0
  439. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  440. package/packages/orq-rc/src/mcp-server/server.ts +123 -0
  441. package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
  442. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  443. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  444. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  445. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  446. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +37 -0
  447. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  448. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  449. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  450. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  451. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  452. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  453. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  454. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  455. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  456. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  457. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  458. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  459. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  460. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  461. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  462. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  463. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  464. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  465. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  466. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  467. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  468. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  469. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  470. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  471. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  472. package/packages/orq-rc/src/mcp-server/tools.ts +126 -0
  473. package/packages/orq-rc/src/models/components/deployments.ts +4164 -0
  474. package/packages/orq-rc/src/models/components/index.ts +6 -0
  475. package/packages/orq-rc/src/models/components/security.ts +71 -0
  476. package/packages/orq-rc/src/models/errors/apierror.ts +27 -0
  477. package/packages/orq-rc/src/models/errors/getpromptversion.ts +71 -0
  478. package/packages/orq-rc/src/models/errors/honoapierror.ts +82 -0
  479. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  480. package/packages/orq-rc/src/models/errors/index.ts +10 -0
  481. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +97 -0
  482. package/packages/orq-rc/src/models/errors/updateprompt.ts +71 -0
  483. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +1816 -0
  484. package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
  485. package/packages/orq-rc/src/models/operations/createcontact.ts +256 -0
  486. package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
  487. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +1740 -0
  488. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  489. package/packages/orq-rc/src/models/operations/createprompt.ts +3816 -0
  490. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
  491. package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
  492. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  493. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +4936 -0
  494. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +6090 -0
  495. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1199 -0
  496. package/packages/orq-rc/src/models/operations/deployments.ts +2194 -0
  497. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  498. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  499. package/packages/orq-rc/src/models/operations/filelist.ts +377 -0
  500. package/packages/orq-rc/src/models/operations/fileupload.ts +324 -0
  501. package/packages/orq-rc/src/models/operations/getallprompts.ts +2165 -0
  502. package/packages/orq-rc/src/models/operations/getoneprompt.ts +1989 -0
  503. package/packages/orq-rc/src/models/operations/getpromptversion.ts +1987 -0
  504. package/packages/orq-rc/src/models/operations/index.ts +34 -0
  505. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +1115 -0
  506. package/packages/orq-rc/src/models/operations/listdatasets.ts +448 -0
  507. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2163 -0
  508. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  509. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +924 -0
  510. package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
  511. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +1729 -0
  512. package/packages/orq-rc/src/models/operations/updatedataset.ts +374 -0
  513. package/packages/orq-rc/src/models/operations/updateprompt.ts +3831 -0
  514. package/packages/orq-rc/src/sdk/contacts.ts +27 -0
  515. package/packages/orq-rc/src/sdk/datasets.ts +222 -0
  516. package/packages/orq-rc/src/sdk/deployments.ts +70 -0
  517. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  518. package/packages/orq-rc/src/sdk/files.ts +78 -0
  519. package/packages/orq-rc/src/sdk/index.ts +5 -0
  520. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  521. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  522. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  523. package/packages/orq-rc/src/sdk/sdk.ts +49 -0
  524. package/packages/orq-rc/src/types/async.ts +68 -0
  525. package/packages/orq-rc/src/types/blobs.ts +31 -0
  526. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  527. package/packages/orq-rc/src/types/enums.ts +16 -0
  528. package/packages/orq-rc/src/types/fp.ts +50 -0
  529. package/packages/orq-rc/src/types/index.ts +11 -0
  530. package/packages/orq-rc/src/types/operations.ts +105 -0
  531. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  532. package/packages/orq-rc/src/types/streams.ts +21 -0
  533. package/packages/orq-rc/tsconfig.json +41 -0
  534. package/sdk/datasets.d.ts +86 -0
  535. package/sdk/datasets.d.ts.map +1 -0
  536. package/sdk/datasets.js +129 -0
  537. package/sdk/datasets.js.map +1 -0
  538. package/sdk/files.d.ts +1 -1
  539. package/sdk/files.js +1 -1
  540. package/sdk/prompts.d.ts +4 -4
  541. package/sdk/prompts.d.ts.map +1 -1
  542. package/sdk/prompts.js +6 -6
  543. package/sdk/prompts.js.map +1 -1
  544. package/sdk/sdk.d.ts +3 -0
  545. package/sdk/sdk.d.ts.map +1 -1
  546. package/sdk/sdk.js +4 -0
  547. package/sdk/sdk.js.map +1 -1
  548. package/src/funcs/datasetsClear.ts +161 -0
  549. package/src/funcs/datasetsCreate.ts +159 -0
  550. package/src/funcs/datasetsCreateDatapoint.ts +161 -0
  551. package/src/funcs/datasetsCreateDatapoints.ts +165 -0
  552. package/src/funcs/datasetsDelete.ts +161 -0
  553. package/src/funcs/datasetsDeleteDatapoint.ts +176 -0
  554. package/src/funcs/datasetsList.ts +162 -0
  555. package/src/funcs/datasetsListDatapoints.ts +169 -0
  556. package/src/funcs/datasetsRetrieve.ts +169 -0
  557. package/src/funcs/datasetsRetrieveDatapoint.ts +175 -0
  558. package/src/funcs/datasetsUpdate.ts +170 -0
  559. package/src/funcs/datasetsUpdateDatapoint.ts +173 -0
  560. package/src/funcs/deploymentsList.ts +1 -0
  561. package/src/funcs/filesCreate.ts +1 -1
  562. package/src/funcs/filesList.ts +1 -0
  563. package/src/funcs/promptsList.ts +2 -1
  564. package/src/funcs/promptsListVersions.ts +1 -0
  565. package/src/lib/config.ts +6 -6
  566. package/src/lib/files.ts +1 -1
  567. package/src/lib/primitives.ts +14 -0
  568. package/src/lib/sdks.ts +2 -7
  569. package/src/lib/security.ts +11 -3
  570. package/src/mcp-server/cli/start/command.ts +125 -0
  571. package/src/mcp-server/cli/start/impl.ts +140 -0
  572. package/src/mcp-server/cli.ts +13 -0
  573. package/src/mcp-server/console-logger.ts +71 -0
  574. package/src/mcp-server/extensions.ts +17 -0
  575. package/src/mcp-server/mcp-server.ts +26 -0
  576. package/src/mcp-server/prompts.ts +110 -0
  577. package/src/mcp-server/resources.ts +158 -0
  578. package/src/mcp-server/scopes.ts +7 -0
  579. package/src/mcp-server/server.ts +123 -0
  580. package/src/mcp-server/shared.ts +75 -0
  581. package/src/mcp-server/tools/contactsCreate.ts +37 -0
  582. package/src/mcp-server/tools/datasetsClear.ts +35 -0
  583. package/src/mcp-server/tools/datasetsCreate.ts +37 -0
  584. package/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  585. package/src/mcp-server/tools/datasetsCreateDatapoints.ts +37 -0
  586. package/src/mcp-server/tools/datasetsDelete.ts +35 -0
  587. package/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  588. package/src/mcp-server/tools/datasetsList.ts +37 -0
  589. package/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  590. package/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  591. package/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  592. package/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  593. package/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  594. package/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  595. package/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  596. package/src/mcp-server/tools/deploymentsList.ts +37 -0
  597. package/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  598. package/src/mcp-server/tools/feedbackCreate.ts +37 -0
  599. package/src/mcp-server/tools/filesCreate.ts +37 -0
  600. package/src/mcp-server/tools/filesDelete.ts +33 -0
  601. package/src/mcp-server/tools/filesGet.ts +37 -0
  602. package/src/mcp-server/tools/filesList.ts +37 -0
  603. package/src/mcp-server/tools/promptsCreate.ts +35 -0
  604. package/src/mcp-server/tools/promptsDelete.ts +33 -0
  605. package/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  606. package/src/mcp-server/tools/promptsList.ts +37 -0
  607. package/src/mcp-server/tools/promptsListVersions.ts +37 -0
  608. package/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  609. package/src/mcp-server/tools/promptsUpdate.ts +35 -0
  610. package/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  611. package/src/mcp-server/tools.ts +126 -0
  612. package/src/models/components/deployments.ts +3133 -635
  613. package/src/models/operations/bulkcreatedatapoints.ts +1816 -0
  614. package/src/models/operations/cleardataset.ts +75 -0
  615. package/src/models/operations/createcontact.ts +2 -2
  616. package/src/models/operations/createdataset.ts +296 -0
  617. package/src/models/operations/createdatasetitem.ts +1740 -0
  618. package/src/models/operations/createprompt.ts +736 -637
  619. package/src/models/operations/deletedatapoint.ts +81 -0
  620. package/src/models/operations/deletedataset.ts +75 -0
  621. package/src/models/operations/deploymentcreatemetric.ts +3983 -837
  622. package/src/models/operations/deploymentgetconfig.ts +3446 -883
  623. package/src/models/operations/deploymentinvoke.ts +434 -379
  624. package/src/models/operations/deployments.ts +46 -0
  625. package/src/models/operations/fileget.ts +3 -2
  626. package/src/models/operations/filelist.ts +43 -2
  627. package/src/models/operations/fileupload.ts +4 -2
  628. package/src/models/operations/getallprompts.ts +57 -8
  629. package/src/models/operations/getoneprompt.ts +15 -8
  630. package/src/models/operations/getpromptversion.ts +15 -8
  631. package/src/models/operations/index.ts +12 -0
  632. package/src/models/operations/listdatasetdatapoints.ts +1115 -0
  633. package/src/models/operations/listdatasets.ts +448 -0
  634. package/src/models/operations/listpromptversions.ts +57 -8
  635. package/src/models/operations/retrievedatapoint.ts +924 -0
  636. package/src/models/operations/retrievedataset.ts +288 -0
  637. package/src/models/operations/updatedatapoint.ts +1729 -0
  638. package/src/models/operations/updatedataset.ts +374 -0
  639. package/src/models/operations/updateprompt.ts +629 -698
  640. package/src/sdk/datasets.ts +222 -0
  641. package/src/sdk/files.ts +1 -1
  642. package/src/sdk/prompts.ts +14 -14
  643. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,622 @@
1
+ # @orq-ai/node
2
+
3
+ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@orq-ai/node* API.
4
+
5
+ <div align="left">
6
+ <a href="https://www.speakeasy.com/?utm_source=@orq-ai/node&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
7
+ <a href="https://opensource.org/licenses/MIT">
8
+ <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
9
+ </a>
10
+ </div>
11
+
12
+ <!-- Start Summary [summary] -->
13
+ ## Summary
14
+
15
+ [Dev] orq.ai API: orq.ai API documentation
16
+
17
+ For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
18
+ <!-- End Summary [summary] -->
19
+
20
+ <!-- Start Table of Contents [toc] -->
21
+ ## Table of Contents
22
+ <!-- $toc-max-depth=2 -->
23
+ * [@orq-ai/node](#orq-ainode)
24
+ * [SDK Installation](#sdk-installation)
25
+ * [Requirements](#requirements)
26
+ * [SDK Example Usage](#sdk-example-usage)
27
+ * [Authentication](#authentication)
28
+ * [Available Resources and Operations](#available-resources-and-operations)
29
+ * [Standalone functions](#standalone-functions)
30
+ * [File uploads](#file-uploads)
31
+ * [Retries](#retries)
32
+ * [Error Handling](#error-handling)
33
+ * [Server Selection](#server-selection)
34
+ * [Custom HTTP Client](#custom-http-client)
35
+ * [Debugging](#debugging)
36
+ * [Development](#development)
37
+ * [Maturity](#maturity)
38
+ * [Contributions](#contributions)
39
+
40
+ <!-- End Table of Contents [toc] -->
41
+
42
+ <!-- Start SDK Installation [installation] -->
43
+ ## SDK Installation
44
+
45
+ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
46
+
47
+ ### NPM
48
+
49
+ ```bash
50
+ npm add @orq-ai/node
51
+ ```
52
+
53
+ ### PNPM
54
+
55
+ ```bash
56
+ pnpm add @orq-ai/node
57
+ ```
58
+
59
+ ### Bun
60
+
61
+ ```bash
62
+ bun add @orq-ai/node
63
+ ```
64
+
65
+ ### Yarn
66
+
67
+ ```bash
68
+ yarn add @orq-ai/node zod
69
+
70
+ # Note that Yarn does not install peer dependencies automatically. You will need
71
+ # to install zod as shown above.
72
+ ```
73
+
74
+
75
+
76
+ ### Model Context Protocol (MCP) Server
77
+
78
+ This SDK is also an installable MCP server where the various SDK methods are
79
+ exposed as tools that can be invoked by AI applications.
80
+
81
+ > Node.js v20 or greater is required to run the MCP server from npm.
82
+
83
+ <details>
84
+ <summary>Claude installation steps</summary>
85
+
86
+ Add the following server definition to your `claude_desktop_config.json` file:
87
+
88
+ ```json
89
+ {
90
+ "mcpServers": {
91
+ "Orq": {
92
+ "command": "npx",
93
+ "args": [
94
+ "-y", "--package", "@orq-ai/node",
95
+ "--",
96
+ "mcp", "start",
97
+ "--api-key", "...",
98
+ "--contact-id", "...",
99
+ "--environment", "..."
100
+ ]
101
+ }
102
+ }
103
+ }
104
+ ```
105
+
106
+ </details>
107
+
108
+ <details>
109
+ <summary>Cursor installation steps</summary>
110
+
111
+ Create a `.cursor/mcp.json` file in your project root with the following content:
112
+
113
+ ```json
114
+ {
115
+ "mcpServers": {
116
+ "Orq": {
117
+ "command": "npx",
118
+ "args": [
119
+ "-y", "--package", "@orq-ai/node",
120
+ "--",
121
+ "mcp", "start",
122
+ "--api-key", "...",
123
+ "--contact-id", "...",
124
+ "--environment", "..."
125
+ ]
126
+ }
127
+ }
128
+ }
129
+ ```
130
+
131
+ </details>
132
+
133
+ You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
134
+
135
+ ```bash
136
+ curl -L -o mcp-server \
137
+ https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
138
+ chmod +x mcp-server
139
+ ```
140
+
141
+ If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
142
+
143
+
144
+ ```json
145
+ {
146
+ "mcpServers": {
147
+ "Todos": {
148
+ "command": "./DOWNLOAD/PATH/mcp-server",
149
+ "args": [
150
+ "start"
151
+ ]
152
+ }
153
+ }
154
+ }
155
+ ```
156
+
157
+ For a full list of server arguments, run:
158
+
159
+ ```sh
160
+ npx -y --package @orq-ai/node -- mcp start --help
161
+ ```
162
+ <!-- End SDK Installation [installation] -->
163
+
164
+ <!-- Start Requirements [requirements] -->
165
+ ## Requirements
166
+
167
+ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
168
+ <!-- End Requirements [requirements] -->
169
+
170
+ <!-- Start SDK Example Usage [usage] -->
171
+ ## SDK Example Usage
172
+
173
+ ### Example
174
+
175
+ ```typescript
176
+ import { Orq } from "@orq-ai/node";
177
+
178
+ const orq = new Orq({
179
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
180
+ });
181
+
182
+ async function run() {
183
+ const result = await orq.contacts.create({
184
+ externalId: "<id>",
185
+ });
186
+
187
+ // Handle the result
188
+ console.log(result);
189
+ }
190
+
191
+ run();
192
+
193
+ ```
194
+ <!-- End SDK Example Usage [usage] -->
195
+
196
+ <!-- Start Authentication [security] -->
197
+ ## Authentication
198
+
199
+ ### Per-Client Security Schemes
200
+
201
+ This SDK supports the following security scheme globally:
202
+
203
+ | Name | Type | Scheme | Environment Variable |
204
+ | -------- | ---- | ----------- | -------------------- |
205
+ | `apiKey` | http | HTTP Bearer | `ORQ_API_KEY` |
206
+
207
+ To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
208
+ ```typescript
209
+ import { Orq } from "@orq-ai/node";
210
+
211
+ const orq = new Orq({
212
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
213
+ });
214
+
215
+ async function run() {
216
+ const result = await orq.contacts.create({
217
+ externalId: "<id>",
218
+ });
219
+
220
+ // Handle the result
221
+ console.log(result);
222
+ }
223
+
224
+ run();
225
+
226
+ ```
227
+ <!-- End Authentication [security] -->
228
+
229
+ <!-- Start Available Resources and Operations [operations] -->
230
+ ## Available Resources and Operations
231
+
232
+ <details open>
233
+ <summary>Available methods</summary>
234
+
235
+ ### [contacts](docs/sdks/contacts/README.md)
236
+
237
+ * [create](docs/sdks/contacts/README.md#create) - Update user information
238
+
239
+ ### [datasets](docs/sdks/datasets/README.md)
240
+
241
+ * [list](docs/sdks/datasets/README.md#list) - List datasets
242
+ * [create](docs/sdks/datasets/README.md#create) - Create a dataset
243
+ * [retrieve](docs/sdks/datasets/README.md#retrieve) - Retrieve a dataset
244
+ * [update](docs/sdks/datasets/README.md#update) - Update a dataset
245
+ * [delete](docs/sdks/datasets/README.md#delete) - Delete a dataset
246
+ * [listDatapoints](docs/sdks/datasets/README.md#listdatapoints) - List datapoints
247
+ * [createDatapoint](docs/sdks/datasets/README.md#createdatapoint) - Create a datapoint
248
+ * [retrieveDatapoint](docs/sdks/datasets/README.md#retrievedatapoint) - Retrieve a datapoint
249
+ * [updateDatapoint](docs/sdks/datasets/README.md#updatedatapoint) - Update a datapoint
250
+ * [deleteDatapoint](docs/sdks/datasets/README.md#deletedatapoint) - Delete a datapoint
251
+ * [createDatapoints](docs/sdks/datasets/README.md#createdatapoints) - Create multiple datapoints
252
+ * [clear](docs/sdks/datasets/README.md#clear) - Delete all datapoints
253
+
254
+ ### [deployments](docs/sdks/deployments/README.md)
255
+
256
+ * [list](docs/sdks/deployments/README.md#list) - List all deployments
257
+ * [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
258
+ * [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
259
+
260
+ #### [deployments.metrics](docs/sdks/metrics/README.md)
261
+
262
+ * [create](docs/sdks/metrics/README.md#create) - Add metrics
263
+
264
+ ### [feedback](docs/sdks/feedback/README.md)
265
+
266
+ * [create](docs/sdks/feedback/README.md#create) - Submit feedback
267
+
268
+ ### [files](docs/sdks/files/README.md)
269
+
270
+ * [create](docs/sdks/files/README.md#create) - Create file
271
+ * [list](docs/sdks/files/README.md#list) - List all files
272
+ * [get](docs/sdks/files/README.md#get) - Retrieve a file
273
+ * [delete](docs/sdks/files/README.md#delete) - Delete file
274
+
275
+
276
+ ### [prompts](docs/sdks/prompts/README.md)
277
+
278
+ * [list](docs/sdks/prompts/README.md#list) - List all prompts
279
+ * [retrieve](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
280
+ * [update](docs/sdks/prompts/README.md#update) - Update a prompt
281
+ * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
282
+ * [create](docs/sdks/prompts/README.md#create) - Create a prompt
283
+ * [listVersions](docs/sdks/prompts/README.md#listversions) - List all prompt versions
284
+ * [getVersion](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
285
+
286
+ ### [remoteconfigs](docs/sdks/remoteconfigs/README.md)
287
+
288
+ * [retrieve](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
289
+
290
+ </details>
291
+ <!-- End Available Resources and Operations [operations] -->
292
+
293
+ <!-- Start Standalone functions [standalone-funcs] -->
294
+ ## Standalone functions
295
+
296
+ All the methods listed above are available as standalone functions. These
297
+ functions are ideal for use in applications running in the browser, serverless
298
+ runtimes or other environments where application bundle size is a primary
299
+ concern. When using a bundler to build your application, all unused
300
+ functionality will be either excluded from the final bundle or tree-shaken away.
301
+
302
+ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
303
+
304
+ <details>
305
+
306
+ <summary>Available standalone functions</summary>
307
+
308
+ - [`contactsCreate`](docs/sdks/contacts/README.md#create) - Update user information
309
+ - [`datasetsClear`](docs/sdks/datasets/README.md#clear) - Delete all datapoints
310
+ - [`datasetsCreate`](docs/sdks/datasets/README.md#create) - Create a dataset
311
+ - [`datasetsCreateDatapoint`](docs/sdks/datasets/README.md#createdatapoint) - Create a datapoint
312
+ - [`datasetsCreateDatapoints`](docs/sdks/datasets/README.md#createdatapoints) - Create multiple datapoints
313
+ - [`datasetsDelete`](docs/sdks/datasets/README.md#delete) - Delete a dataset
314
+ - [`datasetsDeleteDatapoint`](docs/sdks/datasets/README.md#deletedatapoint) - Delete a datapoint
315
+ - [`datasetsList`](docs/sdks/datasets/README.md#list) - List datasets
316
+ - [`datasetsListDatapoints`](docs/sdks/datasets/README.md#listdatapoints) - List datapoints
317
+ - [`datasetsRetrieve`](docs/sdks/datasets/README.md#retrieve) - Retrieve a dataset
318
+ - [`datasetsRetrieveDatapoint`](docs/sdks/datasets/README.md#retrievedatapoint) - Retrieve a datapoint
319
+ - [`datasetsUpdate`](docs/sdks/datasets/README.md#update) - Update a dataset
320
+ - [`datasetsUpdateDatapoint`](docs/sdks/datasets/README.md#updatedatapoint) - Update a datapoint
321
+ - [`deploymentsGetConfig`](docs/sdks/deployments/README.md#getconfig) - Get config
322
+ - [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
323
+ - [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
324
+ - [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
325
+ - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
326
+ - [`filesCreate`](docs/sdks/files/README.md#create) - Create file
327
+ - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
328
+ - [`filesGet`](docs/sdks/files/README.md#get) - Retrieve a file
329
+ - [`filesList`](docs/sdks/files/README.md#list) - List all files
330
+ - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
331
+ - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
332
+ - [`promptsGetVersion`](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
333
+ - [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
334
+ - [`promptsListVersions`](docs/sdks/prompts/README.md#listversions) - List all prompt versions
335
+ - [`promptsRetrieve`](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
336
+ - [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
337
+ - [`remoteconfigsRetrieve`](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
338
+
339
+ </details>
340
+ <!-- End Standalone functions [standalone-funcs] -->
341
+
342
+ <!-- Start File uploads [file-upload] -->
343
+ ## File uploads
344
+
345
+ Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
346
+
347
+ > [!TIP]
348
+ >
349
+ > Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
350
+ >
351
+ > - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
352
+ > - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
353
+ > - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
354
+ > - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
355
+
356
+ ```typescript
357
+ import { Orq } from "@orq-ai/node";
358
+
359
+ const orq = new Orq({
360
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
361
+ });
362
+
363
+ async function run() {
364
+ const result = await orq.files.create();
365
+
366
+ // Handle the result
367
+ console.log(result);
368
+ }
369
+
370
+ run();
371
+
372
+ ```
373
+ <!-- End File uploads [file-upload] -->
374
+
375
+ <!-- Start Retries [retries] -->
376
+ ## Retries
377
+
378
+ Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
379
+
380
+ To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
381
+ ```typescript
382
+ import { Orq } from "@orq-ai/node";
383
+
384
+ const orq = new Orq({
385
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
386
+ });
387
+
388
+ async function run() {
389
+ const result = await orq.contacts.create({
390
+ externalId: "<id>",
391
+ }, {
392
+ retries: {
393
+ strategy: "backoff",
394
+ backoff: {
395
+ initialInterval: 1,
396
+ maxInterval: 50,
397
+ exponent: 1.1,
398
+ maxElapsedTime: 100,
399
+ },
400
+ retryConnectionErrors: false,
401
+ },
402
+ });
403
+
404
+ // Handle the result
405
+ console.log(result);
406
+ }
407
+
408
+ run();
409
+
410
+ ```
411
+
412
+ If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
413
+ ```typescript
414
+ import { Orq } from "@orq-ai/node";
415
+
416
+ const orq = new Orq({
417
+ retryConfig: {
418
+ strategy: "backoff",
419
+ backoff: {
420
+ initialInterval: 1,
421
+ maxInterval: 50,
422
+ exponent: 1.1,
423
+ maxElapsedTime: 100,
424
+ },
425
+ retryConnectionErrors: false,
426
+ },
427
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
428
+ });
429
+
430
+ async function run() {
431
+ const result = await orq.contacts.create({
432
+ externalId: "<id>",
433
+ });
434
+
435
+ // Handle the result
436
+ console.log(result);
437
+ }
438
+
439
+ run();
440
+
441
+ ```
442
+ <!-- End Retries [retries] -->
443
+
444
+ <!-- Start Error Handling [errors] -->
445
+ ## Error Handling
446
+
447
+ Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
448
+
449
+ | Error Type | Status Code | Content Type |
450
+ | ------------------- | ----------- | ---------------- |
451
+ | errors.HonoApiError | 500 | application/json |
452
+ | errors.APIError | 4XX, 5XX | \*/\* |
453
+
454
+ If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
455
+
456
+ ```typescript
457
+ import { Orq } from "@orq-ai/node";
458
+ import { HonoApiError, SDKValidationError } from "@orq-ai/node/models/errors";
459
+
460
+ const orq = new Orq({
461
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
462
+ });
463
+
464
+ async function run() {
465
+ let result;
466
+ try {
467
+ result = await orq.deployments.list({});
468
+
469
+ // Handle the result
470
+ console.log(result);
471
+ } catch (err) {
472
+ switch (true) {
473
+ // The server response does not match the expected SDK schema
474
+ case (err instanceof SDKValidationError): {
475
+ // Pretty-print will provide a human-readable multi-line error message
476
+ console.error(err.pretty());
477
+ // Raw value may also be inspected
478
+ console.error(err.rawValue);
479
+ return;
480
+ }
481
+ case (err instanceof HonoApiError): {
482
+ // Handle err.data$: HonoApiErrorData
483
+ console.error(err);
484
+ return;
485
+ }
486
+ default: {
487
+ // Other errors such as network errors, see HTTPClientErrors for more details
488
+ throw err;
489
+ }
490
+ }
491
+ }
492
+ }
493
+
494
+ run();
495
+
496
+ ```
497
+
498
+ Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
499
+
500
+ In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
501
+
502
+ | HTTP Client Error | Description |
503
+ | ---------------------------------------------------- | ---------------------------------------------------- |
504
+ | RequestAbortedError | HTTP request was aborted by the client |
505
+ | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
506
+ | ConnectionError | HTTP client was unable to make a request to a server |
507
+ | InvalidRequestError | Any input used to create a request is invalid |
508
+ | UnexpectedClientError | Unrecognised or unexpected error |
509
+ <!-- End Error Handling [errors] -->
510
+
511
+ <!-- Start Server Selection [server] -->
512
+ ## Server Selection
513
+
514
+ ### Override Server URL Per-Client
515
+
516
+ The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
517
+ ```typescript
518
+ import { Orq } from "@orq-ai/node";
519
+
520
+ const orq = new Orq({
521
+ serverURL: "https://my.orq.ai",
522
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
523
+ });
524
+
525
+ async function run() {
526
+ const result = await orq.contacts.create({
527
+ externalId: "<id>",
528
+ });
529
+
530
+ // Handle the result
531
+ console.log(result);
532
+ }
533
+
534
+ run();
535
+
536
+ ```
537
+ <!-- End Server Selection [server] -->
538
+
539
+ <!-- Start Custom HTTP Client [http-client] -->
540
+ ## Custom HTTP Client
541
+
542
+ The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
543
+ [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
544
+ client is a thin wrapper around `fetch` and provides the ability to attach hooks
545
+ around the request lifecycle that can be used to modify the request or handle
546
+ errors and response.
547
+
548
+ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
549
+ used to integrate a third-party HTTP client or when writing tests to mock out
550
+ the HTTP client and feed in fixtures.
551
+
552
+ The following example shows how to use the `"beforeRequest"` hook to to add a
553
+ custom header and a timeout to requests and how to use the `"requestError"` hook
554
+ to log errors:
555
+
556
+ ```typescript
557
+ import { Orq } from "@orq-ai/node";
558
+ import { HTTPClient } from "@orq-ai/node/lib/http";
559
+
560
+ const httpClient = new HTTPClient({
561
+ // fetcher takes a function that has the same signature as native `fetch`.
562
+ fetcher: (request) => {
563
+ return fetch(request);
564
+ }
565
+ });
566
+
567
+ httpClient.addHook("beforeRequest", (request) => {
568
+ const nextRequest = new Request(request, {
569
+ signal: request.signal || AbortSignal.timeout(5000)
570
+ });
571
+
572
+ nextRequest.headers.set("x-custom-header", "custom value");
573
+
574
+ return nextRequest;
575
+ });
576
+
577
+ httpClient.addHook("requestError", (error, request) => {
578
+ console.group("Request Error");
579
+ console.log("Reason:", `${error}`);
580
+ console.log("Endpoint:", `${request.method} ${request.url}`);
581
+ console.groupEnd();
582
+ });
583
+
584
+ const sdk = new Orq({ httpClient });
585
+ ```
586
+ <!-- End Custom HTTP Client [http-client] -->
587
+
588
+ <!-- Start Debugging [debug] -->
589
+ ## Debugging
590
+
591
+ You can setup your SDK to emit debug logs for SDK requests and responses.
592
+
593
+ You can pass a logger that matches `console`'s interface as an SDK option.
594
+
595
+ > [!WARNING]
596
+ > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
597
+
598
+ ```typescript
599
+ import { Orq } from "@orq-ai/node";
600
+
601
+ const sdk = new Orq({ debugLogger: console });
602
+ ```
603
+
604
+ You can also enable a default debug logger by setting an environment variable `ORQ_DEBUG` to true.
605
+ <!-- End Debugging [debug] -->
606
+
607
+ <!-- Placeholder for Future Speakeasy SDK Sections -->
608
+
609
+ # Development
610
+
611
+ ## Maturity
612
+
613
+ This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
614
+ to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
615
+ looking for the latest version.
616
+
617
+ ## Contributions
618
+
619
+ While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
620
+ We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
621
+
622
+ ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@orq-ai/node&utm_campaign=typescript)
@@ -0,0 +1,48 @@
1
+ # Supported JavaScript runtimes
2
+
3
+ This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
4
+
5
+ * [Web Fetch API][web-fetch]
6
+ * [Web Streams API][web-streams] and in particular `ReadableStream`
7
+ * [Async iterables][async-iter] using `Symbol.asyncIterator`
8
+
9
+ [web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
10
+ [web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
11
+ [async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
12
+
13
+ Runtime environments that are explicitly supported are:
14
+
15
+ - Evergreen browsers which include: Chrome, Safari, Edge, Firefox
16
+ - Node.js active and maintenance LTS releases
17
+ - Currently, this is v18 and v20
18
+ - Bun v1 and above
19
+ - Deno v1.39
20
+ - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
21
+
22
+ [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
23
+
24
+ ## Recommended TypeScript compiler options
25
+
26
+ The following `tsconfig.json` options are recommended for projects using this
27
+ SDK in order to get static type support for features like async iterables,
28
+ streams and `fetch`-related APIs ([`for await...of`][for-await-of],
29
+ [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
30
+ so on):
31
+
32
+ [for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
33
+ [abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
34
+ [request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
35
+ [response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
36
+
37
+ ```jsonc
38
+ {
39
+ "compilerOptions": {
40
+ "target": "es2020", // or higher
41
+ "lib": ["es2020", "dom", "dom.iterable"],
42
+ }
43
+ }
44
+ ```
45
+
46
+ While `target` can be set to older ECMAScript versions, it may result in extra,
47
+ unnecessary compatibility code being generated if you are not targeting old
48
+ runtimes.