@orq-ai/node 3.10.4 → 3.11.0-rc.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 (487) hide show
  1. package/bin/mcp-server.js +105 -123
  2. package/bin/mcp-server.js.map +30 -30
  3. package/examples/package-lock.json +5 -6
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +2 -2
  6. package/lib/config.js +2 -2
  7. package/lib/config.js.map +1 -1
  8. package/mcp-server/mcp-server.js +1 -1
  9. package/mcp-server/mcp-server.js.map +1 -1
  10. package/mcp-server/server.js +1 -1
  11. package/mcp-server/server.js.map +1 -1
  12. package/models/operations/createcontact.js +2 -2
  13. package/models/operations/createdataset.js +2 -2
  14. package/models/operations/createdatasetitem.js +2 -2
  15. package/models/operations/createdatasource.js +2 -2
  16. package/models/operations/createeval.js +16 -16
  17. package/models/operations/fileget.js +2 -2
  18. package/models/operations/filelist.js +2 -2
  19. package/models/operations/fileupload.js +2 -2
  20. package/models/operations/getevals.js +28 -28
  21. package/models/operations/listcontacts.js +2 -2
  22. package/models/operations/listdatasetdatapoints.js +2 -2
  23. package/models/operations/listdatasets.js +2 -2
  24. package/models/operations/listdatasources.js +2 -2
  25. package/models/operations/retrievecontact.js +2 -2
  26. package/models/operations/retrievedatapoint.js +2 -2
  27. package/models/operations/retrievedataset.js +2 -2
  28. package/models/operations/retrievedatasource.js +2 -2
  29. package/models/operations/searchknowledge.d.ts +0 -40
  30. package/models/operations/searchknowledge.d.ts.map +1 -1
  31. package/models/operations/searchknowledge.js +4 -32
  32. package/models/operations/searchknowledge.js.map +1 -1
  33. package/models/operations/updatecontact.js +2 -2
  34. package/models/operations/updatedatapoint.js +2 -2
  35. package/models/operations/updatedataset.js +2 -2
  36. package/models/operations/updatedatasource.js +2 -2
  37. package/models/operations/updateeval.js +16 -16
  38. package/package.json +4 -4
  39. package/src/lib/config.ts +2 -2
  40. package/src/mcp-server/mcp-server.ts +1 -1
  41. package/src/mcp-server/server.ts +1 -1
  42. package/src/models/operations/createcontact.ts +2 -2
  43. package/src/models/operations/createdataset.ts +2 -2
  44. package/src/models/operations/createdatasetitem.ts +2 -2
  45. package/src/models/operations/createdatasource.ts +2 -2
  46. package/src/models/operations/createeval.ts +16 -16
  47. package/src/models/operations/fileget.ts +2 -2
  48. package/src/models/operations/filelist.ts +2 -2
  49. package/src/models/operations/fileupload.ts +2 -2
  50. package/src/models/operations/getevals.ts +28 -28
  51. package/src/models/operations/listcontacts.ts +2 -2
  52. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  53. package/src/models/operations/listdatasets.ts +2 -2
  54. package/src/models/operations/listdatasources.ts +2 -2
  55. package/src/models/operations/retrievecontact.ts +2 -2
  56. package/src/models/operations/retrievedatapoint.ts +2 -2
  57. package/src/models/operations/retrievedataset.ts +2 -2
  58. package/src/models/operations/retrievedatasource.ts +2 -2
  59. package/src/models/operations/searchknowledge.ts +0 -42
  60. package/src/models/operations/updatecontact.ts +2 -2
  61. package/src/models/operations/updatedatapoint.ts +2 -2
  62. package/src/models/operations/updatedataset.ts +2 -2
  63. package/src/models/operations/updatedatasource.ts +2 -2
  64. package/src/models/operations/updateeval.ts +16 -16
  65. package/packages/orq-rc/FUNCTIONS.md +0 -103
  66. package/packages/orq-rc/README.md +0 -960
  67. package/packages/orq-rc/RUNTIMES.md +0 -48
  68. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  69. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
  70. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  71. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -314
  72. package/packages/orq-rc/docs/sdks/evals/README.md +0 -3077
  73. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  74. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  75. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1243
  76. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  77. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  78. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  79. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -557
  80. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  81. package/packages/orq-rc/examples/README.md +0 -31
  82. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  83. package/packages/orq-rc/examples/package-lock.json +0 -627
  84. package/packages/orq-rc/examples/package.json +0 -18
  85. package/packages/orq-rc/jsr.json +0 -28
  86. package/packages/orq-rc/package-lock.json +0 -3018
  87. package/packages/orq-rc/package.json +0 -43
  88. package/packages/orq-rc/src/core.ts +0 -13
  89. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  90. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  91. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  92. package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
  93. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  94. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  95. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  96. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  97. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -167
  98. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  99. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  100. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  101. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  102. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  103. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  104. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  105. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  106. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  107. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  108. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  109. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  110. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  111. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +0 -175
  112. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  113. package/packages/orq-rc/src/funcs/evalsBertScore.ts +0 -175
  114. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +0 -175
  115. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +0 -175
  116. package/packages/orq-rc/src/funcs/evalsContains.ts +0 -175
  117. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +0 -175
  118. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +0 -175
  119. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +0 -175
  120. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +0 -175
  121. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +0 -175
  122. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +0 -177
  123. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  124. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  125. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +0 -175
  126. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +0 -175
  127. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +0 -183
  128. package/packages/orq-rc/src/funcs/evalsGrammar.ts +0 -173
  129. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -177
  130. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +0 -175
  131. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +0 -177
  132. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +0 -175
  133. package/packages/orq-rc/src/funcs/evalsLocalization.ts +0 -175
  134. package/packages/orq-rc/src/funcs/evalsPii.ts +0 -173
  135. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +0 -175
  136. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +0 -174
  137. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +0 -183
  138. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +0 -180
  139. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +0 -177
  140. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +0 -174
  141. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +0 -177
  142. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +0 -174
  143. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +0 -177
  144. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +0 -180
  145. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +0 -183
  146. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +0 -177
  147. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +0 -183
  148. package/packages/orq-rc/src/funcs/evalsSummarization.ts +0 -175
  149. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +0 -175
  150. package/packages/orq-rc/src/funcs/evalsTranslation.ts +0 -175
  151. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  152. package/packages/orq-rc/src/funcs/evalsValidJson.ts +0 -175
  153. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  154. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  155. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  156. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  157. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  158. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  159. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  160. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  161. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  162. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  163. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  164. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  165. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  166. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  167. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  168. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  169. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  170. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  171. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  172. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  173. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  174. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  175. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  176. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
  177. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  178. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  179. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  180. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  181. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  182. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  183. package/packages/orq-rc/src/hooks/global.ts +0 -44
  184. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  185. package/packages/orq-rc/src/hooks/index.ts +0 -6
  186. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  187. package/packages/orq-rc/src/hooks/types.ts +0 -112
  188. package/packages/orq-rc/src/index.ts +0 -9
  189. package/packages/orq-rc/src/lib/base64.ts +0 -37
  190. package/packages/orq-rc/src/lib/config.ts +0 -74
  191. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  192. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  193. package/packages/orq-rc/src/lib/env.ts +0 -73
  194. package/packages/orq-rc/src/lib/event-streams.ts +0 -137
  195. package/packages/orq-rc/src/lib/files.ts +0 -82
  196. package/packages/orq-rc/src/lib/http.ts +0 -323
  197. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  198. package/packages/orq-rc/src/lib/logger.ts +0 -9
  199. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  200. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  201. package/packages/orq-rc/src/lib/retries.ts +0 -218
  202. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  203. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  204. package/packages/orq-rc/src/lib/security.ts +0 -261
  205. package/packages/orq-rc/src/lib/url.ts +0 -33
  206. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -112
  207. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  208. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  209. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  210. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  211. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  212. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  213. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  214. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  215. package/packages/orq-rc/src/mcp-server/server.ts +0 -251
  216. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  217. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  218. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  219. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  220. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  221. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  222. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  223. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  224. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  225. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  226. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  227. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  228. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  229. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  230. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  231. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  232. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  233. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  234. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  235. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  236. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  237. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  238. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  239. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +0 -35
  240. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  241. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +0 -35
  242. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +0 -35
  243. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +0 -35
  244. package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +0 -35
  245. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +0 -35
  246. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +0 -35
  247. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +0 -35
  248. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +0 -35
  249. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +0 -35
  250. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +0 -36
  251. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  252. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  253. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +0 -35
  254. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +0 -35
  255. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +0 -37
  256. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +0 -35
  257. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +0 -35
  258. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +0 -35
  259. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +0 -36
  260. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +0 -35
  261. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +0 -35
  262. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +0 -35
  263. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +0 -35
  264. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +0 -35
  265. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +0 -37
  266. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +0 -36
  267. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +0 -36
  268. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +0 -36
  270. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +0 -35
  271. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +0 -36
  272. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +0 -36
  273. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +0 -36
  274. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +0 -36
  275. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +0 -36
  276. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +0 -35
  277. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +0 -35
  278. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +0 -35
  279. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  280. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +0 -35
  281. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  282. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  283. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  284. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  285. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  286. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  287. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  288. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  289. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  290. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  298. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  299. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  301. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  302. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  303. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  304. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  305. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  306. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  307. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  308. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  309. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  310. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  311. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  312. package/packages/orq-rc/src/models/components/deployments.ts +0 -7246
  313. package/packages/orq-rc/src/models/components/index.ts +0 -6
  314. package/packages/orq-rc/src/models/components/security.ts +0 -71
  315. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  316. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  317. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  318. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  319. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +0 -156
  320. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +0 -154
  321. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +0 -154
  322. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +0 -155
  323. package/packages/orq-rc/src/models/errors/evalscontains.ts +0 -154
  324. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +0 -155
  325. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +0 -155
  326. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +0 -156
  327. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +0 -155
  328. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +0 -155
  329. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +0 -157
  330. package/packages/orq-rc/src/models/errors/evalsendswith.ts +0 -154
  331. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +0 -154
  332. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +0 -160
  333. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +0 -154
  334. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +0 -156
  335. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +0 -157
  336. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +0 -156
  337. package/packages/orq-rc/src/models/errors/evalslocalization.ts +0 -155
  338. package/packages/orq-rc/src/models/errors/evalspii.ts +0 -154
  339. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +0 -156
  340. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +0 -157
  341. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +0 -163
  342. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +0 -160
  343. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +0 -158
  344. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +0 -157
  345. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +0 -157
  346. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +0 -157
  347. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +0 -158
  348. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +0 -160
  349. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +0 -160
  350. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +0 -158
  351. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +0 -160
  352. package/packages/orq-rc/src/models/errors/evalssummarization.ts +0 -156
  353. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +0 -155
  354. package/packages/orq-rc/src/models/errors/evalstranslation.ts +0 -155
  355. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +0 -154
  356. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  357. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  358. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  359. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  360. package/packages/orq-rc/src/models/errors/index.ts +0 -56
  361. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -154
  362. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  363. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  364. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  365. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  366. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  367. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  368. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  369. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  370. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -428
  371. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  372. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  373. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -5222
  374. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  375. package/packages/orq-rc/src/models/operations/createeval.ts +0 -3830
  376. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  377. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  378. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4087
  379. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  380. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  381. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  382. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  383. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  384. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  385. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  386. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  387. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5439
  388. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9336
  389. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1258
  390. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2330
  391. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9449
  392. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +0 -253
  393. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +0 -197
  394. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +0 -131
  395. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +0 -249
  396. package/packages/orq-rc/src/models/operations/evalscontains.ts +0 -250
  397. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +0 -248
  398. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +0 -254
  399. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +0 -181
  400. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +0 -254
  401. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +0 -181
  402. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +0 -186
  403. package/packages/orq-rc/src/models/operations/evalsendswith.ts +0 -250
  404. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +0 -183
  405. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +0 -299
  406. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +0 -243
  407. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +0 -268
  408. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +0 -266
  409. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +0 -259
  410. package/packages/orq-rc/src/models/operations/evalslocalization.ts +0 -253
  411. package/packages/orq-rc/src/models/operations/evalspii.ts +0 -243
  412. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +0 -152
  413. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +0 -153
  414. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +0 -164
  415. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +0 -166
  416. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +0 -164
  417. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +0 -153
  418. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +0 -155
  419. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +0 -146
  420. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +0 -157
  421. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +0 -166
  422. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +0 -165
  423. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +0 -150
  424. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +0 -285
  425. package/packages/orq-rc/src/models/operations/evalssummarization.ts +0 -253
  426. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +0 -251
  427. package/packages/orq-rc/src/models/operations/evalstranslation.ts +0 -251
  428. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +0 -177
  429. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  430. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  431. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  432. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  433. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2298
  434. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7290
  435. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  436. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  437. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2159
  438. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2164
  439. package/packages/orq-rc/src/models/operations/index.ts +0 -98
  440. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -2520
  441. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  442. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -490
  443. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -2784
  444. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  445. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  446. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  447. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  448. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2296
  449. package/packages/orq-rc/src/models/operations/parse.ts +0 -1610
  450. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  451. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  452. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -2586
  453. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  454. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  455. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3367
  456. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  457. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  458. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -5155
  459. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  460. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  461. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -4131
  462. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  463. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4224
  464. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  465. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  466. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  467. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  468. package/packages/orq-rc/src/sdk/evals.ts +0 -639
  469. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  470. package/packages/orq-rc/src/sdk/files.ts +0 -78
  471. package/packages/orq-rc/src/sdk/index.ts +0 -5
  472. package/packages/orq-rc/src/sdk/knowledge.ts +0 -264
  473. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  474. package/packages/orq-rc/src/sdk/models.ts +0 -25
  475. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  476. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  477. package/packages/orq-rc/src/sdk/sdk.ts +0 -73
  478. package/packages/orq-rc/src/types/async.ts +0 -68
  479. package/packages/orq-rc/src/types/blobs.ts +0 -31
  480. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  481. package/packages/orq-rc/src/types/enums.ts +0 -16
  482. package/packages/orq-rc/src/types/fp.ts +0 -50
  483. package/packages/orq-rc/src/types/index.ts +0 -11
  484. package/packages/orq-rc/src/types/operations.ts +0 -105
  485. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  486. package/packages/orq-rc/src/types/streams.ts +0 -21
  487. package/packages/orq-rc/tsconfig.json +0 -41
@@ -2674,8 +2674,8 @@ export const UpdateEvalResponseBodyPython$inboundSchema: z.ZodType<
2674
2674
  > = z.object({
2675
2675
  _id: z.string(),
2676
2676
  description: z.string(),
2677
- created: z.string().default("2025-08-07T10:16:37.349Z"),
2678
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
2677
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
2678
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
2679
2679
  guardrail_config: z.union([
2680
2680
  z.lazy(() =>
2681
2681
  UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$inboundSchema
@@ -2717,8 +2717,8 @@ export const UpdateEvalResponseBodyPython$outboundSchema: z.ZodType<
2717
2717
  > = z.object({
2718
2718
  id: z.string(),
2719
2719
  description: z.string(),
2720
- created: z.string().default("2025-08-07T10:16:37.349Z"),
2721
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
2720
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
2721
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
2722
2722
  guardrailConfig: z.union([
2723
2723
  z.lazy(() =>
2724
2724
  UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$outboundSchema
@@ -3139,8 +3139,8 @@ export const UpdateEvalResponseBodyHTTP$inboundSchema: z.ZodType<
3139
3139
  > = z.object({
3140
3140
  _id: z.string(),
3141
3141
  description: z.string(),
3142
- created: z.string().default("2025-08-07T10:16:37.349Z"),
3143
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
3142
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
3143
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
3144
3144
  guardrail_config: z.union([
3145
3145
  z.lazy(() =>
3146
3146
  UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$inboundSchema
@@ -3188,8 +3188,8 @@ export const UpdateEvalResponseBodyHTTP$outboundSchema: z.ZodType<
3188
3188
  > = z.object({
3189
3189
  id: z.string(),
3190
3190
  description: z.string(),
3191
- created: z.string().default("2025-08-07T10:16:37.349Z"),
3192
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
3191
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
3192
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
3193
3193
  guardrailConfig: z.union([
3194
3194
  z.lazy(() =>
3195
3195
  UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$outboundSchema
@@ -3579,8 +3579,8 @@ export const UpdateEvalResponseBodyJSON$inboundSchema: z.ZodType<
3579
3579
  > = z.object({
3580
3580
  _id: z.string(),
3581
3581
  description: z.string(),
3582
- created: z.string().default("2025-08-07T10:16:37.349Z"),
3583
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
3582
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
3583
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
3584
3584
  guardrail_config: z.union([
3585
3585
  z.lazy(() => UpdateEvalGuardrailConfigEvalsResponse200Number$inboundSchema),
3586
3586
  z.lazy(() =>
@@ -3620,8 +3620,8 @@ export const UpdateEvalResponseBodyJSON$outboundSchema: z.ZodType<
3620
3620
  > = z.object({
3621
3621
  id: z.string(),
3622
3622
  description: z.string(),
3623
- created: z.string().default("2025-08-07T10:16:37.349Z"),
3624
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
3623
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
3624
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
3625
3625
  guardrailConfig: z.union([
3626
3626
  z.lazy(() =>
3627
3627
  UpdateEvalGuardrailConfigEvalsResponse200Number$outboundSchema
@@ -3979,8 +3979,8 @@ export const UpdateEvalResponseBodyLLM$inboundSchema: z.ZodType<
3979
3979
  > = z.object({
3980
3980
  _id: z.string(),
3981
3981
  description: z.string(),
3982
- created: z.string().default("2025-08-07T10:16:37.349Z"),
3983
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
3982
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
3983
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
3984
3984
  guardrail_config: z.union([
3985
3985
  z.lazy(() => UpdateEvalGuardrailConfigEvalsResponseNumber$inboundSchema),
3986
3986
  z.lazy(() => UpdateEvalGuardrailConfigEvalsResponseBoolean$inboundSchema),
@@ -4020,8 +4020,8 @@ export const UpdateEvalResponseBodyLLM$outboundSchema: z.ZodType<
4020
4020
  > = z.object({
4021
4021
  id: z.string(),
4022
4022
  description: z.string(),
4023
- created: z.string().default("2025-08-07T10:16:37.349Z"),
4024
- updated: z.string().default("2025-08-07T10:16:37.349Z"),
4023
+ created: z.string().default("2025-08-07T12:04:07.542Z"),
4024
+ updated: z.string().default("2025-08-07T12:04:07.542Z"),
4025
4025
  guardrailConfig: z.union([
4026
4026
  z.lazy(() => UpdateEvalGuardrailConfigEvalsResponseNumber$outboundSchema),
4027
4027
  z.lazy(() => UpdateEvalGuardrailConfigEvalsResponseBoolean$outboundSchema),
@@ -1,103 +0,0 @@
1
- # Standalone Functions
2
-
3
- > [!NOTE]
4
- > This section is useful if you are using a bundler and targetting browsers and
5
- > runtimes where the size of an application affects performance and load times.
6
-
7
- Every method in this SDK is also available as a standalone function. This
8
- alternative API is suitable when targetting the browser or serverless runtimes
9
- and using a bundler to build your application since all unused functionality
10
- will be tree-shaken away. This includes code for unused methods, Zod schemas,
11
- encoding helpers and response handlers. The result is dramatically smaller
12
- impact on the application's final bundle size which grows very slowly as you use
13
- more and more functionality from this SDK.
14
-
15
- Calling methods through the main SDK class remains a valid and generally more
16
- more ergonomic option. Standalone functions represent an optimisation for a
17
- specific category of applications.
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { OrqCore } from "@orq-ai/node/core.js";
23
- import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
24
-
25
- // Use `OrqCore` for best tree-shaking performance.
26
- // You can create one instance of it to use across an application.
27
- const orq = new OrqCore({
28
- apiKey: process.env["ORQ_API_KEY"] ?? "",
29
- });
30
-
31
- async function run() {
32
- const res = await contactsCreate(orq, {
33
- externalId: "user_12345",
34
- displayName: "Jane Smith",
35
- email: "jane.smith@example.com",
36
- avatarUrl: "https://example.com/avatars/jane-smith.jpg",
37
- tags: [
38
- "premium",
39
- "beta-user",
40
- "enterprise",
41
- ],
42
- metadata: {
43
- "department": "Engineering",
44
- "role": "Senior Developer",
45
- "subscription_tier": "premium",
46
- "last_login": "2024-01-15T10:30:00Z",
47
- },
48
- });
49
- if (res.ok) {
50
- const { value: result } = res;
51
- console.log(result);
52
- } else {
53
- console.log("contactsCreate failed:", res.error);
54
- }
55
- }
56
-
57
- run();
58
- ```
59
-
60
- ## Result types
61
-
62
- Standalone functions differ from SDK methods in that they return a
63
- `Result<Value, Error>` type to capture _known errors_ and document them using
64
- the type system. By avoiding throwing errors, application code maintains clear
65
- control flow and error-handling become part of the regular flow of application
66
- code.
67
-
68
- > We use the term "known errors" because standalone functions, and JavaScript
69
- > code in general, can still throw unexpected errors such as `TypeError`s,
70
- > `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
71
- > something this SDK addresses in the future. Nevertheless, there is still a lot
72
- > of benefit from capturing most errors and turning them into values.
73
-
74
- The second reason for this style of programming is because these functions will
75
- typically be used in front-end applications where exception throwing is
76
- sometimes discouraged or considered unidiomatic. React and similar ecosystems
77
- and libraries tend to promote this style of programming so that components
78
- render useful content under all states (loading, success, error and so on).
79
-
80
- The general pattern when calling standalone functions looks like this:
81
-
82
- ```typescript
83
- import { Core } from "<sdk-package-name>";
84
- import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
85
-
86
- const client = new Core();
87
-
88
- async function run() {
89
- const result = await fetchSomething(client, { id: "123" });
90
- if (!result.ok) {
91
- // You can throw the error or handle it. It's your choice now.
92
- throw result.error;
93
- }
94
-
95
- console.log(result.value);
96
- }
97
-
98
- run();
99
- ```
100
-
101
- Notably, `result.error` above will have an explicit type compared to a try-catch
102
- variation where the error in the catch block can only be of type `unknown` (or
103
- `any` depending on your TypeScript settings).