@orq-ai/node 3.3.2 → 3.4.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (239) hide show
  1. package/bin/mcp-server.js +6 -9
  2. package/bin/mcp-server.js.map +7 -7
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +2 -2
  5. package/lib/config.js +2 -2
  6. package/lib/config.js.map +1 -1
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/mcp-server.js.map +1 -1
  9. package/mcp-server/server.js +1 -1
  10. package/mcp-server/server.js.map +1 -1
  11. package/package.json +3 -2
  12. package/src/lib/config.ts +2 -2
  13. package/src/mcp-server/mcp-server.ts +1 -1
  14. package/src/mcp-server/server.ts +1 -1
  15. package/packages/orq-rc/FUNCTIONS.md +0 -106
  16. package/packages/orq-rc/README.md +0 -698
  17. package/packages/orq-rc/RUNTIMES.md +0 -48
  18. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  19. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -940
  20. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -316
  21. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  22. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  23. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1279
  24. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  25. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  26. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -614
  27. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  28. package/packages/orq-rc/jsr.json +0 -28
  29. package/packages/orq-rc/package-lock.json +0 -3217
  30. package/packages/orq-rc/package.json +0 -45
  31. package/packages/orq-rc/src/core.ts +0 -13
  32. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  33. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  34. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  35. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  36. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  37. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  38. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  39. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  40. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  41. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  42. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  43. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  44. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  45. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  46. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  47. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  48. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  49. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  50. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  51. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  52. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  53. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  54. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  55. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  56. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  57. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  58. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  59. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  60. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  61. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  62. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  63. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  64. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  65. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  66. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  67. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -158
  68. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
  69. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  70. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  71. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  72. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  73. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  74. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  75. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  76. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  77. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  78. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  79. package/packages/orq-rc/src/hooks/global.ts +0 -44
  80. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  81. package/packages/orq-rc/src/hooks/index.ts +0 -6
  82. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  83. package/packages/orq-rc/src/hooks/types.ts +0 -110
  84. package/packages/orq-rc/src/index.ts +0 -7
  85. package/packages/orq-rc/src/lib/base64.ts +0 -37
  86. package/packages/orq-rc/src/lib/config.ts +0 -70
  87. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  88. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  89. package/packages/orq-rc/src/lib/env.ts +0 -73
  90. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  91. package/packages/orq-rc/src/lib/files.ts +0 -40
  92. package/packages/orq-rc/src/lib/http.ts +0 -323
  93. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  94. package/packages/orq-rc/src/lib/logger.ts +0 -9
  95. package/packages/orq-rc/src/lib/matchers.ts +0 -325
  96. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  97. package/packages/orq-rc/src/lib/retries.ts +0 -218
  98. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  99. package/packages/orq-rc/src/lib/sdks.ts +0 -395
  100. package/packages/orq-rc/src/lib/security.ts +0 -261
  101. package/packages/orq-rc/src/lib/url.ts +0 -33
  102. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  103. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  104. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  105. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  106. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  107. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  108. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -110
  109. package/packages/orq-rc/src/mcp-server/resources.ts +0 -158
  110. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  111. package/packages/orq-rc/src/mcp-server/server.ts +0 -157
  112. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  113. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  114. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  115. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  116. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  117. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  118. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  119. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  120. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  121. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  122. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  123. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  124. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  125. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  126. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  127. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  128. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  129. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  130. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  131. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  132. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  133. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  134. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  135. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  136. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  137. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  138. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  139. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  140. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  141. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  142. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  143. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  144. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  145. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  146. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  147. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  148. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -35
  149. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  150. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  151. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  152. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  153. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  154. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  155. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  156. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  157. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  158. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  159. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  160. package/packages/orq-rc/src/mcp-server/tools.ts +0 -126
  161. package/packages/orq-rc/src/models/components/deployments.ts +0 -4164
  162. package/packages/orq-rc/src/models/components/index.ts +0 -6
  163. package/packages/orq-rc/src/models/components/security.ts +0 -71
  164. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  165. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  166. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  167. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  168. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  169. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  170. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  171. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -1816
  172. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  173. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -680
  174. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  175. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  176. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -1740
  177. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  178. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  179. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -676
  180. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3743
  181. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  182. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  183. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  184. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  185. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  186. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  187. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -4936
  188. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -6090
  189. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1199
  190. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2155
  191. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -5960
  192. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  193. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  194. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  195. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -324
  196. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2127
  197. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -265
  198. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -444
  199. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1993
  200. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1991
  201. package/packages/orq-rc/src/models/operations/index.ts +0 -51
  202. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -444
  203. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1071
  204. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  205. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  206. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -568
  207. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2125
  208. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  209. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -924
  210. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  211. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  212. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1673
  213. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -418
  214. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -1729
  215. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  216. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  217. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -790
  218. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3929
  219. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  220. package/packages/orq-rc/src/sdk/datasets.ts +0 -222
  221. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  222. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  223. package/packages/orq-rc/src/sdk/files.ts +0 -78
  224. package/packages/orq-rc/src/sdk/index.ts +0 -5
  225. package/packages/orq-rc/src/sdk/knowledge.ts +0 -261
  226. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  227. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  228. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  229. package/packages/orq-rc/src/sdk/sdk.ts +0 -55
  230. package/packages/orq-rc/src/types/async.ts +0 -68
  231. package/packages/orq-rc/src/types/blobs.ts +0 -31
  232. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  233. package/packages/orq-rc/src/types/enums.ts +0 -16
  234. package/packages/orq-rc/src/types/fp.ts +0 -50
  235. package/packages/orq-rc/src/types/index.ts +0 -11
  236. package/packages/orq-rc/src/types/operations.ts +0 -105
  237. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  238. package/packages/orq-rc/src/types/streams.ts +0 -21
  239. package/packages/orq-rc/tsconfig.json +0 -41
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@orq-ai/node",
5
- "version": "3.3.2",
5
+ "version": "3.4.0-rc.0",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/lib/config.d.ts CHANGED
@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
35
35
  export declare const SDK_METADATA: {
36
36
  readonly language: "typescript";
37
37
  readonly openapiDocVersion: "2.0";
38
- readonly sdkVersion: "3.3.2";
38
+ readonly sdkVersion: "3.4.0-rc.0";
39
39
  readonly genVersion: "2.565.1";
40
- readonly userAgent: "speakeasy-sdk/typescript 3.3.2 2.565.1 2.0 @orq-ai/node";
40
+ readonly userAgent: "speakeasy-sdk/typescript 3.4.0-rc.0 2.565.1 2.0 @orq-ai/node";
41
41
  };
42
42
  //# sourceMappingURL=config.d.ts.map
package/lib/config.js CHANGED
@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
28
28
  exports.SDK_METADATA = {
29
29
  language: "typescript",
30
30
  openapiDocVersion: "2.0",
31
- sdkVersion: "3.3.2",
31
+ sdkVersion: "3.4.0-rc.0",
32
32
  genVersion: "2.565.1",
33
- userAgent: "speakeasy-sdk/typescript 3.3.2 2.565.1 2.0 @orq-ai/node",
33
+ userAgent: "speakeasy-sdk/typescript 3.4.0-rc.0 2.565.1 2.0 @orq-ai/node",
34
34
  };
35
35
  //# sourceMappingURL=config.js.map
package/lib/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA4CH,oDAeC;AAtDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,mBAAmB;CACX,CAAC;AAgCX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,KAAK;IACxB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,yDAAyD;CAC5D,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA4CH,oDAeC;AAtDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,mBAAmB;CACX,CAAC;AAgCX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,KAAK;IACxB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,8DAA8D;CACjE,CAAC"}
@@ -22,7 +22,7 @@ const routes = (0, core_1.buildRouteMap)({
22
22
  exports.app = (0, core_1.buildApplication)(routes, {
23
23
  name: "mcp",
24
24
  versionInfo: {
25
- currentVersion: "3.3.2",
25
+ currentVersion: "3.4.0-rc.0",
26
26
  },
27
27
  });
28
28
  (0, core_1.run)(exports.app, node_process_1.default.argv.slice(2), (0, cli_js_1.buildContext)(node_process_1.default));
@@ -1 +1 @@
1
- {"version":3,"file":"mcp-server.js","sourceRoot":"","sources":["../src/mcp-server/mcp-server.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,wCAAqE;AACrE,gEAAmC;AACnC,qCAAwC;AACxC,uDAAsD;AAEtD,MAAM,MAAM,GAAG,IAAA,oBAAa,EAAC;IAC3B,MAAM,EAAE;QACN,KAAK,EAAE,yBAAY;KACpB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,gBAAgB;KACxB;CACF,CAAC,CAAC;AAEU,QAAA,GAAG,GAAG,IAAA,uBAAgB,EAAC,MAAM,EAAE;IAC1C,IAAI,EAAE,KAAK;IACX,WAAW,EAAE;QACX,cAAc,EAAE,OAAO;KACxB;CACF,CAAC,CAAC;AAEH,IAAA,UAAG,EAAC,WAAG,EAAE,sBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAA,qBAAY,EAAC,sBAAO,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"mcp-server.js","sourceRoot":"","sources":["../src/mcp-server/mcp-server.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,wCAAqE;AACrE,gEAAmC;AACnC,qCAAwC;AACxC,uDAAsD;AAEtD,MAAM,MAAM,GAAG,IAAA,oBAAa,EAAC;IAC3B,MAAM,EAAE;QACN,KAAK,EAAE,yBAAY;KACpB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,gBAAgB;KACxB;CACF,CAAC,CAAC;AAEU,QAAA,GAAG,GAAG,IAAA,uBAAgB,EAAC,MAAM,EAAE;IAC1C,IAAI,EAAE,KAAK;IACX,WAAW,EAAE;QACX,cAAc,EAAE,YAAY;KAC7B;CACF,CAAC,CAAC;AAEH,IAAA,UAAG,EAAC,WAAG,EAAE,sBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAA,qBAAY,EAAC,sBAAO,CAAC,CAAC,CAAC"}
@@ -60,7 +60,7 @@ const remoteconfigsRetrieve_js_1 = require("./tools/remoteconfigsRetrieve.js");
60
60
  function createMCPServer(deps) {
61
61
  const server = new mcp_js_1.McpServer({
62
62
  name: "Orq",
63
- version: "3.3.2",
63
+ version: "3.4.0-rc.0",
64
64
  });
65
65
  const client = new core_js_1.OrqCore({
66
66
  apiKey: deps.apiKey,
@@ -1 +1 @@
1
- {"version":3,"file":"server.js","sourceRoot":"","sources":["../src/mcp-server/server.ts"],"names":[],"mappings":";AAAA;;GAEG;;AA6DH,0CA6FC;AAxJD,oEAAoE;AACpE,wCAAqC;AAGrC,6CAAoD;AACpD,iDAGwB;AACxB,2CAAkD;AAClD,yCAAgD;AAChD,iEAAgE;AAChE,+DAA8D;AAC9D,iEAAgE;AAChE,mFAAkF;AAClF,qFAAoF;AACpF,iEAAgE;AAChE,mFAAkF;AAClF,6DAA4D;AAC5D,iFAAgF;AAChF,qEAAoE;AACpE,uFAAsF;AACtF,iEAAgE;AAChE,mFAAkF;AAClF,6EAA4E;AAC5E,uEAAsE;AACtE,mEAAkE;AAClE,qFAAoF;AACpF,uEAAsE;AACtE,iEAAgE;AAChE,2DAA0D;AAC1D,2DAA0D;AAC1D,qDAAoD;AACpD,uDAAsD;AACtD,mEAAkE;AAClE,+EAA8E;AAC9E,uFAAsF;AACtF,mEAAkE;AAClE,6EAA4E;AAC5E,uFAAsF;AACtF,+DAA8D;AAC9D,2EAA0E;AAC1E,qFAAoF;AACpF,uEAAsE;AACtE,iFAAgF;AAChF,2FAA0F;AAC1F,mEAAkE;AAClE,mEAAkE;AAClE,6EAA4E;AAC5E,uFAAsF;AACtF,+DAA8D;AAC9D,+DAA8D;AAC9D,uEAAsE;AACtE,2DAA0D;AAC1D,2EAA0E;AAC1E,mEAAkE;AAClE,+DAA8D;AAC9D,+EAA8E;AAE9E,SAAgB,eAAe,CAAC,IAS/B;IACC,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,iBAAO,CAAC;QACzB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,qBAAS,CAAC,CAAC;IAEjD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,IAAA,6BAAkB,EAC7B,IAAI,CAAC,MAAM,EACX,MAAM,EACN,MAAM,EACN,MAAM,EACN,YAAY,CACb,CAAC;IACF,MAAM,QAAQ,GAAG,IAAA,qCAAsB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7E,MAAM,gBAAgB,GAAG,IAAA,6CAA8B,EACrD,IAAI,CAAC,MAAM,EACX,MAAM,EACN,MAAM,EACN,MAAM,CACP,CAAC;IACF,MAAM,MAAM,GAAG,IAAA,iCAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC9D,KAAK,QAAQ,CAAC,CAAC,2BAA2B;IAE1C,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,6BAAc,CAAC,CAAC;IACrB,IAAI,CAAC,2BAAa,CAAC,CAAC;IACpB,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,iDAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,qDAA0B,CAAC,CAAC;IACjC,IAAI,CAAC,mCAAiB,CAAC,CAAC;IACxB,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,2CAAqB,CAAC,CAAC;IAC5B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uDAA2B,CAAC,CAAC;IAClC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,2DAA6B,CAAC,CAAC;IACpC,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,2DAA6B,CAAC,CAAC;IACpC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,iEAAgC,CAAC,CAAC;IACvC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,qDAA0B,CAAC,CAAC;IACjC,IAAI,CAAC,iDAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,uDAA2B,CAAC,CAAC;IAClC,IAAI,CAAC,2DAA6B,CAAC,CAAC;IAEpC,OAAO,MAAM,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../src/mcp-server/server.ts"],"names":[],"mappings":";AAAA;;GAEG;;AA6DH,0CA6FC;AAxJD,oEAAoE;AACpE,wCAAqC;AAGrC,6CAAoD;AACpD,iDAGwB;AACxB,2CAAkD;AAClD,yCAAgD;AAChD,iEAAgE;AAChE,+DAA8D;AAC9D,iEAAgE;AAChE,mFAAkF;AAClF,qFAAoF;AACpF,iEAAgE;AAChE,mFAAkF;AAClF,6DAA4D;AAC5D,iFAAgF;AAChF,qEAAoE;AACpE,uFAAsF;AACtF,iEAAgE;AAChE,mFAAkF;AAClF,6EAA4E;AAC5E,uEAAsE;AACtE,mEAAkE;AAClE,qFAAoF;AACpF,uEAAsE;AACtE,iEAAgE;AAChE,2DAA0D;AAC1D,2DAA0D;AAC1D,qDAAoD;AACpD,uDAAsD;AACtD,mEAAkE;AAClE,+EAA8E;AAC9E,uFAAsF;AACtF,mEAAkE;AAClE,6EAA4E;AAC5E,uFAAsF;AACtF,+DAA8D;AAC9D,2EAA0E;AAC1E,qFAAoF;AACpF,uEAAsE;AACtE,iFAAgF;AAChF,2FAA0F;AAC1F,mEAAkE;AAClE,mEAAkE;AAClE,6EAA4E;AAC5E,uFAAsF;AACtF,+DAA8D;AAC9D,+DAA8D;AAC9D,uEAAsE;AACtE,2DAA0D;AAC1D,2EAA0E;AAC1E,mEAAkE;AAClE,+DAA8D;AAC9D,+EAA8E;AAE9E,SAAgB,eAAe,CAAC,IAS/B;IACC,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,YAAY;KACtB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,iBAAO,CAAC;QACzB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,qBAAS,CAAC,CAAC;IAEjD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,IAAA,6BAAkB,EAC7B,IAAI,CAAC,MAAM,EACX,MAAM,EACN,MAAM,EACN,MAAM,EACN,YAAY,CACb,CAAC;IACF,MAAM,QAAQ,GAAG,IAAA,qCAAsB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7E,MAAM,gBAAgB,GAAG,IAAA,6CAA8B,EACrD,IAAI,CAAC,MAAM,EACX,MAAM,EACN,MAAM,EACN,MAAM,CACP,CAAC;IACF,MAAM,MAAM,GAAG,IAAA,iCAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC9D,KAAK,QAAQ,CAAC,CAAC,2BAA2B;IAE1C,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,6BAAc,CAAC,CAAC;IACrB,IAAI,CAAC,2BAAa,CAAC,CAAC;IACpB,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,iCAAgB,CAAC,CAAC;IACvB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,iDAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,qDAA0B,CAAC,CAAC;IACjC,IAAI,CAAC,mCAAiB,CAAC,CAAC;IACxB,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,2CAAqB,CAAC,CAAC;IAC5B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uCAAmB,CAAC,CAAC;IAC1B,IAAI,CAAC,uDAA2B,CAAC,CAAC;IAClC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,yDAA4B,CAAC,CAAC;IACnC,IAAI,CAAC,2DAA6B,CAAC,CAAC;IACpC,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,qCAAkB,CAAC,CAAC;IACzB,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,6CAAsB,CAAC,CAAC;IAC7B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,yCAAoB,CAAC,CAAC;IAC3B,IAAI,CAAC,2DAA6B,CAAC,CAAC;IACpC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,iEAAgC,CAAC,CAAC;IACvC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,6DAA8B,CAAC,CAAC;IACrC,IAAI,CAAC,qDAA0B,CAAC,CAAC;IACjC,IAAI,CAAC,iDAAwB,CAAC,CAAC;IAC/B,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,mDAAyB,CAAC,CAAC;IAChC,IAAI,CAAC,uDAA2B,CAAC,CAAC;IAClC,IAAI,CAAC,2DAA6B,CAAC,CAAC;IAEpC,OAAO,MAAM,CAAC;AAChB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.3.2",
3
+ "version": "3.4.0-rc.0",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -9,7 +9,8 @@
9
9
  "sideEffects": false,
10
10
  "repository": {
11
11
  "type": "git",
12
- "url": "https://github.com/orq-ai/orq-node.git"
12
+ "url": "https://github.com/orq-ai/orq-node.git",
13
+ "directory": "packages/orq-rc"
13
14
  },
14
15
  "scripts": {
15
16
  "lint": "eslint --cache --max-warnings=0 src",
package/src/lib/config.ts CHANGED
@@ -64,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
64
64
  export const SDK_METADATA = {
65
65
  language: "typescript",
66
66
  openapiDocVersion: "2.0",
67
- sdkVersion: "3.3.2",
67
+ sdkVersion: "3.4.0-rc.0",
68
68
  genVersion: "2.565.1",
69
- userAgent: "speakeasy-sdk/typescript 3.3.2 2.565.1 2.0 @orq-ai/node",
69
+ userAgent: "speakeasy-sdk/typescript 3.4.0-rc.0 2.565.1 2.0 @orq-ai/node",
70
70
  } as const;
@@ -19,7 +19,7 @@ const routes = buildRouteMap({
19
19
  export const app = buildApplication(routes, {
20
20
  name: "mcp",
21
21
  versionInfo: {
22
- currentVersion: "3.3.2",
22
+ currentVersion: "3.4.0-rc.0",
23
23
  },
24
24
  });
25
25
 
@@ -73,7 +73,7 @@ export function createMCPServer(deps: {
73
73
  }) {
74
74
  const server = new McpServer({
75
75
  name: "Orq",
76
- version: "3.3.2",
76
+ version: "3.4.0-rc.0",
77
77
  });
78
78
 
79
79
  const client = new OrqCore({
@@ -1,106 +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
- import { SDKValidationError } from "@orq-ai/node/models/errors/sdkvalidationerror.js";
25
-
26
- // Use `OrqCore` for best tree-shaking performance.
27
- // You can create one instance of it to use across an application.
28
- const orq = new OrqCore({
29
- apiKey: process.env["ORQ_API_KEY"] ?? "",
30
- });
31
-
32
- async function run() {
33
- const res = await contactsCreate(orq, {
34
- externalId: "<id>",
35
- });
36
-
37
- switch (true) {
38
- case res.ok:
39
- // The success case will be handled outside of the switch block
40
- break;
41
- case res.error instanceof SDKValidationError:
42
- // Pretty-print validation errors.
43
- return console.log(res.error.pretty());
44
- case res.error instanceof Error:
45
- return console.log(res.error);
46
- default:
47
- // TypeScript's type checking will fail on the following line if the above
48
- // cases were not exhaustive.
49
- res.error satisfies never;
50
- throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
51
- }
52
-
53
-
54
- const { value: result } = res;
55
-
56
- // Handle the result
57
- console.log(result);
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ## Result types
64
-
65
- Standalone functions differ from SDK methods in that they return a
66
- `Result<Value, Error>` type to capture _known errors_ and document them using
67
- the type system. By avoiding throwing errors, application code maintains clear
68
- control flow and error-handling become part of the regular flow of application
69
- code.
70
-
71
- > We use the term "known errors" because standalone functions, and JavaScript
72
- > code in general, can still throw unexpected errors such as `TypeError`s,
73
- > `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
74
- > something this SDK addresses in the future. Nevertheless, there is still a lot
75
- > of benefit from capturing most errors and turning them into values.
76
-
77
- The second reason for this style of programming is because these functions will
78
- typically be used in front-end applications where exception throwing is
79
- sometimes discouraged or considered unidiomatic. React and similar ecosystems
80
- and libraries tend to promote this style of programming so that components
81
- render useful content under all states (loading, success, error and so on).
82
-
83
- The general pattern when calling standalone functions looks like this:
84
-
85
- ```typescript
86
- import { Core } from "<sdk-package-name>";
87
- import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
88
-
89
- const client = new Core();
90
-
91
- async function run() {
92
- const result = await fetchSomething(client, { id: "123" });
93
- if (!result.ok) {
94
- // You can throw the error or handle it. It's your choice now.
95
- throw result.error;
96
- }
97
-
98
- console.log(result.value);
99
- }
100
-
101
- run();
102
- ```
103
-
104
- Notably, `result.error` above will have an explicit type compared to a try-catch
105
- variation where the error in the catch block can only be of type `unknown` (or
106
- `any` depending on your TypeScript settings).