@signalwire/sdk 2.0.4 → 3.5.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 (656) hide show
  1. package/CHANGELOG.md +785 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +550 -163
  6. package/dist/AgentBase.js +1640 -514
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +28 -0
  42. package/dist/PomBuilder.js +81 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +29 -1
  48. package/dist/PromptManager.js +37 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +265 -66
  58. package/dist/SWMLService.js +652 -112
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +95 -34
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -367
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +102 -39
  169. package/dist/index.js +107 -30
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +81 -39
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +34 -25
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +57 -31
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +301 -84
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +32 -14
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +65 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +88 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"HttpClient.js","sourceRoot":"","sources":["../../src/rest/HttpClient.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,uDAAuD;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IACrB,oDAAoD;IAC3C,OAAO,CAAS;IACR,WAAW,CAAS;IACpB,MAAM,CAA0B;IAEjD;;;;;;;OAOG;IACH,YAAY,OAA0B;QACpC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,sFAAsF;QACtF,8EAA8E;QAC9E,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAQ,CAAC;QAC3E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACpG,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACtD,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAU,MAAc,EAAE,IAAY,EAAE,IAAU,EAAE,MAAoB;QAC5F,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAEpE,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;YACjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,SAAS;oBAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,KAAK;gBAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC5D,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;QAEjC,MAAM,OAAO,GAA2B;YACtC,eAAe,EAAE,IAAI,CAAC,WAAW;YACjC,QAAQ,EAAE,kBAAkB;YAC5B,YAAY,EAAE,0BAA0B;SACzC,CAAC;QACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YAClC,MAAM;YACN,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC5D,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,IAAI,OAAO,GAAqC,IAAI,CAAC;YACrD,IAAI,CAAC;gBACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAA4B,CAAC;YACxD,CAAC;YAAC,MAAM,CAAC;gBACP,sDAAsD;YACxD,CAAC;YACD,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO,EAAO,CAAC;QACjB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI;YAAE,OAAO,EAAO,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,MAAoB;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CAAU,IAAY,EAAE,IAAU,EAAE,MAAoB;QAChE,OAAO,IAAI,CAAC,QAAQ,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,IAAU;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAU,IAAY,EAAE,IAAU;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAU,IAAY;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAI,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF"}
1
+ {"version":3,"file":"HttpClient.js","sourceRoot":"","sources":["../../src/rest/HttpClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAG/D,OAAO,EACL,OAAO,EACP,iBAAiB,GAGlB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;;;;;;GAWG;AACH,SAAS,cAAc,CAAC,IAAY;IAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClF,OAAO,CACL,QAAQ,KAAK,WAAW;QACxB,QAAQ,KAAK,WAAW;QACxB,QAAQ,KAAK,KAAK;QAClB,QAAQ,KAAK,OAAO,CACrB,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,cAAc;IACrB,IAAI,OAAO,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,oBAAoB,CAAyB,CAAC;QAClE,IAAI,GAAG,CAAC,OAAO;YAAE,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,0EAA0E;IAC5E,CAAC;IACD,OAAO,yBAAyB,OAAO,EAAE,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,GAAG,cAAc,EAAE,CAAC;AAEpC,mFAAmF;AACnF,MAAM,UAAU,UAAU;IACxB,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,IAAI,iBAAmE,CAAC;AACxE,SAAS,gBAAgB;IACvB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACtD,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,IAAI,iBAAiB,EAAE,GAAG,KAAK,MAAM;QAAE,OAAO,iBAAiB,CAAC,UAAU,CAAC;IAC3E,IAAI,CAAC;QACH,4EAA4E;QAC5E,mCAAmC;QACnC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,QAAQ,CAA8C,CAAC;QACjF,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,SAAS,CAEzC,CAAC;QACF,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,IAAI,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,iBAAiB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QAChD,OAAO,UAAU,CAAC;IACpB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACtC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACxD,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,SAAS,KAAK,CAAC,OAAe;IAC5B,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,UAAU;IACrB,oDAAoD;IAC3C,OAAO,CAAS;IACR,WAAW,CAAS;IACpB,MAAM,CAA0B;IACjD,sEAAsE;IACrD,eAAe,CAAsB;IAEtD;;;;;;;;OAQG;IACH,YAAY,OAA0B;QACpC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,sFAAsF;QACtF,gFAAgF;QAChF,iFAAiF;QACjF,0EAA0E;QAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI;YACzB,CAAC,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,OAAO,CAAC,IAAI,EAAE;YACxE,CAAC,CAAC,OAAO,CAAC,OAAQ,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC,WAAW;YACd,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAChD,CAAC;IAED,+EAA+E;IACvE,kBAAkB,CAAC,IAAc;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAChC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,uCAAuC;IAC/E,CAAC;IAEO,KAAK,CAAC,QAAQ,CACpB,MAAc,EACd,IAAY,EACZ,IAAc,EACd,MAAoB,EACpB,cAAmC;QAEnC,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAEpE,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;YACjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,SAAS;oBAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,KAAK;gBAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC5D,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;QAEjC,MAAM,OAAO,GAA2B;YACtC,aAAa,EAAE,IAAI,CAAC,WAAW;YAC/B,MAAM,EAAE,kBAAkB;YAC1B,YAAY,EAAE,UAAU;SACzB,CAAC;QACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,0EAA0E;QAC1E,qEAAqE;QACrE,yEAAyE;QACzE,4CAA4C;QAC5C,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,SAAS,CAAC;YACR,OAAO,IAAI,CAAC,CAAC;YACb,IAAI,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;gBAC9B,wEAAwE;gBACxE,oDAAoD;gBACpD,MAAM,IAAI,kBAAkB,CAAC,kCAAkC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YAChF,CAAC;YAED,IAAI,IAAc,CAAC;YACnB,IAAI,CAAC;gBACH,yEAAyE;gBACzE,sEAAsE;gBACtE,MAAM,IAAI,GAA2C;oBACnD,MAAM;oBACN,OAAO;oBACP,IAAI,EAAE,WAAW;oBACjB,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;iBAClC,CAAC;gBACF,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;gBACtC,IAAI,UAAU,KAAK,SAAS;oBAAE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;gBAC3D,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAmB,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,wEAAwE;gBACxE,mEAAmE;gBACnE,qEAAqE;gBACrE,4CAA4C;gBAC5C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;oBACpD,kEAAkE;oBAClE,MAAM,IAAI,kBAAkB,CAAC,kCAAkC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAChF,CAAC;gBACD,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;oBACpD,SAAS;gBACX,CAAC;gBACD,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,MAAM,IAAI,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YACrD,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACb,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC5E,IAAI,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;oBAC1C,IAAI,KAAK,KAAK,IAAI;wBAAE,KAAK,GAAG,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;oBACnE,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;oBACnB,SAAS;gBACX,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC/B,IAAI,OAAO,GAAiC,IAAI,CAAC;gBACjD,IAAI,CAAC;oBACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAwB,CAAC;gBACpD,CAAC;gBAAC,MAAM,CAAC;oBACP,sDAAsD;gBACxD,CAAC;gBACD,yEAAyE;gBACzE,4EAA4E;gBAC5E,MAAM,WAAW,GAA2B,EAAE,CAAC;gBAC/C,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC5B,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACrB,CAAC,CAAC,CAAC;gBACH,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACtE,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACxB,OAAO,EAAO,CAAC;YACjB,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAO,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,cAAc,CAAC,IAAuB;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,IAAI,CAAC,WAAW,IAAI,aAAa,EAAE,CAAC;YACtC,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,IAAI,aAAa,CAAC;IAC3C,CAAC;IAED,kEAAkE;IAC1D,QAAQ,CAAC,GAAY;QAC3B,OAAO,GAAG,YAAY,KAAK,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,IAAI,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CACP,IAAY,EACZ,MAAoB,EACpB,cAAmC;QAEnC,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CACR,IAAY,EACZ,IAAc,EACd,MAAoB,EACpB,cAAmC;QAEnC,OAAO,IAAI,CAAC,QAAQ,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CACP,IAAY,EACZ,IAAc,EACd,cAAmC;QAEnC,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACT,IAAY,EACZ,IAAc,EACd,cAAmC;QAEnC,OAAO,IAAI,CAAC,QAAQ,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAc,IAAY,EAAE,cAAmC;QACzE,OAAO,IAAI,CAAC,QAAQ,CAAI,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAChF,CAAC;CACF"}
@@ -0,0 +1,110 @@
1
+ /**
2
+ * RequestOptions — the REST request-options envelope (plan 4.2).
3
+ *
4
+ * A single value object controlling per-request transport behavior: timeout,
5
+ * retries (with an idempotency-aware retry policy + exponential backoff), and
6
+ * cooperative cancellation. Supplied at two levels:
7
+ *
8
+ * - **Client default**: `new RestClient({ ..., requestOptions })` stored on the
9
+ * {@link HttpClient} and applied to every request.
10
+ * - **Per-request override**: each verb accepts an optional `requestOptions`
11
+ * that *shallow-overrides* the client default for that one call — an unset
12
+ * (`undefined`) field falls back to the client default, then the built-in
13
+ * default.
14
+ *
15
+ * The timeout + retry semantics are a wire-observable contract (the server sees
16
+ * N attempts and honors the backoff ordering). `abortSignal`
17
+ * fidelity is per-port idiom: the field exists in every port. In TypeScript the
18
+ * primitive is the native {@link AbortSignal}, which is passed straight to
19
+ * `fetch`, so cancellation is TRUE in-flight abort (an in-progress request is
20
+ * interrupted), not merely a between-attempt check — the strongest fidelity of
21
+ * any port. It is *also* checked before each attempt so an already-aborted
22
+ * signal raises before the send.
23
+ *
24
+ * Mirrors `signalwire-python`'s `signalwire/rest/_request_options.py`
25
+ * ``RequestOptions`` dataclass (a value object with a ``merge`` method).
26
+ */
27
+ /**
28
+ * Plain-object initializer for {@link RequestOptions}. All fields optional;
29
+ * `undefined` = inherit (fall back to the client default, then the built-in).
30
+ * Every REST verb accepts this directly, so a call site passes an object
31
+ * literal — `client.get(path, params, { retries: 1 })` — without constructing a
32
+ * class instance.
33
+ */
34
+ export interface RequestOptionsInit {
35
+ /**
36
+ * Max wall-clock seconds per attempt; on exceed the request raises the
37
+ * transport-error type ({@link RestTransportError}). Built-in default `30.0`.
38
+ */
39
+ timeout?: number;
40
+ /**
41
+ * Number of RETRY attempts (total attempts = `retries + 1`) on a retryable
42
+ * failure. Built-in default `0` (opt-in resilience — the no-retry behavior
43
+ * stays the default; a caller opts into retries).
44
+ */
45
+ retries?: number;
46
+ /**
47
+ * HTTP statuses that trigger a retry for an idempotent method. Built-in
48
+ * `{429, 500, 502, 503, 504}`.
49
+ */
50
+ retryOnStatus?: ReadonlySet<number>;
51
+ /**
52
+ * Base seconds for exponential backoff between retries
53
+ * (`backoff * 2 ** (attempt - 1)`), honoring `Retry-After` when present.
54
+ * Built-in `0.5`.
55
+ */
56
+ retryBackoff?: number;
57
+ /**
58
+ * Native cancellation primitive; passed straight to `fetch` for TRUE
59
+ * in-flight abort, and also checked before each attempt. Built-in none.
60
+ */
61
+ abortSignal?: AbortSignal;
62
+ }
63
+ export declare const DEFAULT_TIMEOUT = 30;
64
+ export declare const DEFAULT_RETRIES = 0;
65
+ export declare const DEFAULT_RETRY_ON_STATUS: ReadonlySet<number>;
66
+ export declare const DEFAULT_RETRY_BACKOFF = 0.5;
67
+ /**
68
+ * Per-request transport options value object. Mirrors the Python reference's
69
+ * ``RequestOptions`` dataclass: all fields optional (`undefined` = inherit),
70
+ * plus a {@link merge} method for the per-request-over-client-default shallow
71
+ * merge. A call site may pass either an instance or a plain
72
+ * {@link RequestOptionsInit} object literal — every verb normalizes both.
73
+ */
74
+ export declare class RequestOptions {
75
+ readonly timeout?: number;
76
+ readonly retries?: number;
77
+ readonly retryOnStatus?: ReadonlySet<number>;
78
+ readonly retryBackoff?: number;
79
+ readonly abortSignal?: AbortSignal;
80
+ constructor(init?: RequestOptionsInit);
81
+ /**
82
+ * Return a new RequestOptions with any set (non-`undefined`) field of
83
+ * `override` applied over this one. The per-request-over-client-default
84
+ * shallow merge: an unset field on `override` leaves this value intact.
85
+ */
86
+ merge(override: RequestOptionsInit | undefined): RequestOptions;
87
+ }
88
+ /** A RequestOptions with every field resolved to a concrete value. */
89
+ export interface _EffectiveOptions {
90
+ timeout: number;
91
+ retries: number;
92
+ retryOnStatus: ReadonlySet<number>;
93
+ retryBackoff: number;
94
+ abortSignal?: AbortSignal;
95
+ }
96
+ /**
97
+ * Resolve the effective options: per-request over client-default over built-in.
98
+ *
99
+ * `undefined` on any field inherits the next level down; the built-in defaults
100
+ * are the floor. The result has every field concrete.
101
+ */
102
+ export declare function resolve(clientDefault: RequestOptionsInit | undefined, perRequest: RequestOptionsInit | undefined): _EffectiveOptions;
103
+ /**
104
+ * Whether an HTTP `status` for `method` should trigger a retry.
105
+ *
106
+ * Idempotent methods (GET/PUT/DELETE) retry on the full `retryOnStatus` set.
107
+ * Non-idempotent methods (POST/PATCH) retry only on 429/503, never on
108
+ * 500/502/504, to avoid replaying a side effect that may have partially applied.
109
+ */
110
+ export declare function statusIsRetryable(method: string, status: number, opts: _EffectiveOptions): boolean;
@@ -0,0 +1,113 @@
1
+ /**
2
+ * RequestOptions — the REST request-options envelope (plan 4.2).
3
+ *
4
+ * A single value object controlling per-request transport behavior: timeout,
5
+ * retries (with an idempotency-aware retry policy + exponential backoff), and
6
+ * cooperative cancellation. Supplied at two levels:
7
+ *
8
+ * - **Client default**: `new RestClient({ ..., requestOptions })` stored on the
9
+ * {@link HttpClient} and applied to every request.
10
+ * - **Per-request override**: each verb accepts an optional `requestOptions`
11
+ * that *shallow-overrides* the client default for that one call — an unset
12
+ * (`undefined`) field falls back to the client default, then the built-in
13
+ * default.
14
+ *
15
+ * The timeout + retry semantics are a wire-observable contract (the server sees
16
+ * N attempts and honors the backoff ordering). `abortSignal`
17
+ * fidelity is per-port idiom: the field exists in every port. In TypeScript the
18
+ * primitive is the native {@link AbortSignal}, which is passed straight to
19
+ * `fetch`, so cancellation is TRUE in-flight abort (an in-progress request is
20
+ * interrupted), not merely a between-attempt check — the strongest fidelity of
21
+ * any port. It is *also* checked before each attempt so an already-aborted
22
+ * signal raises before the send.
23
+ *
24
+ * Mirrors `signalwire-python`'s `signalwire/rest/_request_options.py`
25
+ * ``RequestOptions`` dataclass (a value object with a ``merge`` method).
26
+ */
27
+ // The built-in defaults (the contract floor). `undefined` on a RequestOptions
28
+ // field means "inherit"; these are what an unset field resolves to at apply-time.
29
+ export const DEFAULT_TIMEOUT = 30.0;
30
+ export const DEFAULT_RETRIES = 0;
31
+ export const DEFAULT_RETRY_ON_STATUS = new Set([429, 500, 502, 503, 504]);
32
+ export const DEFAULT_RETRY_BACKOFF = 0.5;
33
+ /**
34
+ * Per-request transport options value object. Mirrors the Python reference's
35
+ * ``RequestOptions`` dataclass: all fields optional (`undefined` = inherit),
36
+ * plus a {@link merge} method for the per-request-over-client-default shallow
37
+ * merge. A call site may pass either an instance or a plain
38
+ * {@link RequestOptionsInit} object literal — every verb normalizes both.
39
+ */
40
+ export class RequestOptions {
41
+ timeout;
42
+ retries;
43
+ retryOnStatus;
44
+ retryBackoff;
45
+ abortSignal;
46
+ constructor(init = {}) {
47
+ this.timeout = init.timeout;
48
+ this.retries = init.retries;
49
+ this.retryOnStatus = init.retryOnStatus;
50
+ this.retryBackoff = init.retryBackoff;
51
+ this.abortSignal = init.abortSignal;
52
+ }
53
+ /**
54
+ * Return a new RequestOptions with any set (non-`undefined`) field of
55
+ * `override` applied over this one. The per-request-over-client-default
56
+ * shallow merge: an unset field on `override` leaves this value intact.
57
+ */
58
+ merge(override) {
59
+ if (!override)
60
+ return this;
61
+ return new RequestOptions({
62
+ timeout: override.timeout ?? this.timeout,
63
+ retries: override.retries ?? this.retries,
64
+ retryOnStatus: override.retryOnStatus ?? this.retryOnStatus,
65
+ retryBackoff: override.retryBackoff ?? this.retryBackoff,
66
+ abortSignal: override.abortSignal ?? this.abortSignal,
67
+ });
68
+ }
69
+ }
70
+ /**
71
+ * Resolve the effective options: per-request over client-default over built-in.
72
+ *
73
+ * `undefined` on any field inherits the next level down; the built-in defaults
74
+ * are the floor. The result has every field concrete.
75
+ */
76
+ export function resolve(clientDefault, perRequest) {
77
+ const base = new RequestOptions(clientDefault ?? {});
78
+ const m = base.merge(perRequest);
79
+ return {
80
+ timeout: m.timeout ?? DEFAULT_TIMEOUT,
81
+ retries: m.retries ?? DEFAULT_RETRIES,
82
+ retryOnStatus: m.retryOnStatus ?? DEFAULT_RETRY_ON_STATUS,
83
+ retryBackoff: m.retryBackoff ?? DEFAULT_RETRY_BACKOFF,
84
+ abortSignal: m.abortSignal,
85
+ };
86
+ }
87
+ // Methods with no server-side side effect — safe to retry on any retryable
88
+ // status. POST/PATCH are excluded: they may create/mutate, so they retry ONLY
89
+ // on a transport error or 429/503 (throttles that carry Retry-After and mean
90
+ // "the request was NOT processed"), never blindly on 500/502/504, to avoid
91
+ // duplicate side effects. This asymmetry is part of the pinned contract.
92
+ const IDEMPOTENT_METHODS = new Set([
93
+ 'GET',
94
+ 'PUT',
95
+ 'DELETE',
96
+ 'HEAD',
97
+ 'OPTIONS',
98
+ ]);
99
+ /**
100
+ * Whether an HTTP `status` for `method` should trigger a retry.
101
+ *
102
+ * Idempotent methods (GET/PUT/DELETE) retry on the full `retryOnStatus` set.
103
+ * Non-idempotent methods (POST/PATCH) retry only on 429/503, never on
104
+ * 500/502/504, to avoid replaying a side effect that may have partially applied.
105
+ */
106
+ export function statusIsRetryable(method, status, opts) {
107
+ if (!opts.retryOnStatus.has(status))
108
+ return false;
109
+ if (IDEMPOTENT_METHODS.has(method.toUpperCase()))
110
+ return true;
111
+ return status === 429 || status === 503;
112
+ }
113
+ //# sourceMappingURL=RequestOptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RequestOptions.js","sourceRoot":"","sources":["../../src/rest/RequestOptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAuCH,8EAA8E;AAC9E,kFAAkF;AAClF,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AACpC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC;AACjC,MAAM,CAAC,MAAM,uBAAuB,GAAwB,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/F,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IAChB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,aAAa,CAAuB;IACpC,YAAY,CAAU;IACtB,WAAW,CAAe;IAEnC,YAAY,OAA2B,EAAE;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAwC;QAC5C,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3B,OAAO,IAAI,cAAc,CAAC;YACxB,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;YACzC,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;YACzC,aAAa,EAAE,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa;YAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YACxD,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AAWD;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CACrB,aAA6C,EAC7C,UAA0C;IAE1C,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjC,OAAO;QACL,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,eAAe;QACrC,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,eAAe;QACrC,aAAa,EAAE,CAAC,CAAC,aAAa,IAAI,uBAAuB;QACzD,YAAY,EAAE,CAAC,CAAC,YAAY,IAAI,qBAAqB;QACrD,WAAW,EAAE,CAAC,CAAC,WAAW;KAC3B,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,6EAA6E;AAC7E,2EAA2E;AAC3E,yEAAyE;AACzE,MAAM,kBAAkB,GAAwB,IAAI,GAAG,CAAC;IACtD,KAAK;IACL,KAAK;IACL,QAAQ;IACR,MAAM;IACN,SAAS;CACV,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAc,EACd,MAAc,EACd,IAAuB;IAEvB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAClD,IAAI,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9D,OAAO,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,CAAC;AAC1C,CAAC"}
@@ -1,3 +1,4 @@
1
+ import type { SignalWireErrorBody } from '../PlatformContracts.js';
1
2
  /**
2
3
  * Custom error class for REST API errors.
3
4
  *
@@ -6,25 +7,70 @@
6
7
  * `SignalWireRestError` behavior.
7
8
  */
8
9
  export declare class RestError extends Error {
9
- /** HTTP status code returned by the server (e.g. `404`, `500`). */
10
- readonly statusCode: number;
10
+ /**
11
+ * HTTP status code returned by the server (e.g. `404`, `500`).
12
+ *
13
+ * `null` for a TRANSPORT failure — a {@link RestTransportError} — where the
14
+ * request never reached a response (connection refused, DNS failure,
15
+ * connection reset, TLS error), so there is no HTTP status to report.
16
+ * Callers catch this one family (`instanceof RestError`) for every REST
17
+ * failure, HTTP or transport.
18
+ */
19
+ readonly statusCode: number | null;
11
20
  /**
12
21
  * Parsed response body. An object when the server returned valid JSON,
13
- * otherwise the raw response text as a string.
22
+ * otherwise the raw response text as a string. For a transport failure it is
23
+ * the underlying transport error message.
14
24
  */
15
- readonly body: string | Record<string, unknown>;
25
+ readonly body: string | SignalWireErrorBody;
16
26
  /** Fully-qualified URL that produced the error. */
17
27
  readonly url: string;
18
28
  /** HTTP method that produced the error (`GET`, `POST`, etc.). */
19
29
  readonly method: string;
20
30
  /**
21
- * @param statusCode - HTTP status code returned by the server.
31
+ * Response header map captured from the failed HTTP response, or `null` for a
32
+ * transport failure that produced no response. Client-side observability with
33
+ * no wire-contract change — mirrors the python reference `SignalWireRestError.headers`.
34
+ */
35
+ readonly headers: Record<string, string> | null;
36
+ /**
37
+ * The platform request id pulled from {@link headers} (`x-request-id` /
38
+ * `x-signalwire-request-id` / `request-id` / `x-amzn-requestid`, case-insensitive,
39
+ * in that precedence), or `null` if absent. Log/correlate a failure against
40
+ * SignalWire's own request id — mirrors the python reference `request_id`.
41
+ */
42
+ readonly requestId: string | null;
43
+ /**
44
+ * @param statusCode - HTTP status code returned by the server, or `null` for
45
+ * a transport-level failure that never reached a response.
22
46
  * @param body - Response body — an object if JSON-parseable, otherwise the
23
47
  * raw response text.
24
48
  * @param url - Fully-qualified URL that produced the error.
25
49
  * @param method - HTTP method that produced the error. Defaults to `"GET"`.
50
+ * @param headers - Response header map (for request-id extraction), or `null`
51
+ * for a transport failure that produced no response.
26
52
  */
27
- constructor(statusCode: number, body: string | Record<string, unknown>, url: string, method?: string);
53
+ constructor(statusCode: number | null, body: string | SignalWireErrorBody, url: string, method?: string, headers?: Record<string, string> | null);
54
+ }
55
+ /**
56
+ * Raised when a REST request never reached a response — a transport-level
57
+ * failure (connection refused, DNS failure, connection reset, TLS error).
58
+ *
59
+ * A member of the {@link RestError} family (`statusCode` is `null`, `body` is
60
+ * the underlying transport error message) so a caller catching `RestError`
61
+ * (aka `SignalWireRestError`) handles both HTTP-error and transport-error
62
+ * responses with one `catch`, instead of a bare `fetch` `TypeError` leaking
63
+ * through. `headers` and `requestId` are `null` — no response was produced.
64
+ */
65
+ export declare class RestTransportError extends RestError {
66
+ /**
67
+ * @param body - The underlying transport error message.
68
+ * @param url - Fully-qualified URL that produced the error.
69
+ * @param method - HTTP method that produced the error. Defaults to `"GET"`.
70
+ */
71
+ constructor(body: string, url: string, method?: string);
28
72
  }
29
73
  /** Alias matching the Python SDK class name. */
30
74
  export { RestError as SignalWireRestError };
75
+ /** Alias matching the Python SDK class name. */
76
+ export { RestTransportError as SignalWireRestTransportError };
@@ -1,3 +1,32 @@
1
+ /**
2
+ * Header names SignalWire (and common proxies) use for the platform request id,
3
+ * in preference order. Matched case-insensitively. Mirrors the python reference
4
+ * `SignalWireRestError._REQUEST_ID_HEADERS`.
5
+ */
6
+ const REQUEST_ID_HEADERS = [
7
+ 'x-request-id',
8
+ 'x-signalwire-request-id',
9
+ 'request-id',
10
+ 'x-amzn-requestid',
11
+ ];
12
+ /**
13
+ * Extract the platform request id from a response header map (case-insensitive,
14
+ * first match wins in {@link REQUEST_ID_HEADERS} order). Returns `null` when no
15
+ * request-id header is present or no headers were captured (transport failure).
16
+ */
17
+ function extractRequestId(headers) {
18
+ if (!headers)
19
+ return null;
20
+ const lowered = {};
21
+ for (const [k, v] of Object.entries(headers)) {
22
+ lowered[k.toLowerCase()] = v;
23
+ }
24
+ for (const name of REQUEST_ID_HEADERS) {
25
+ if (name in lowered)
26
+ return lowered[name] ?? null;
27
+ }
28
+ return null;
29
+ }
1
30
  /**
2
31
  * Custom error class for REST API errors.
3
32
  *
@@ -6,11 +35,20 @@
6
35
  * `SignalWireRestError` behavior.
7
36
  */
8
37
  export class RestError extends Error {
9
- /** HTTP status code returned by the server (e.g. `404`, `500`). */
38
+ /**
39
+ * HTTP status code returned by the server (e.g. `404`, `500`).
40
+ *
41
+ * `null` for a TRANSPORT failure — a {@link RestTransportError} — where the
42
+ * request never reached a response (connection refused, DNS failure,
43
+ * connection reset, TLS error), so there is no HTTP status to report.
44
+ * Callers catch this one family (`instanceof RestError`) for every REST
45
+ * failure, HTTP or transport.
46
+ */
10
47
  statusCode;
11
48
  /**
12
49
  * Parsed response body. An object when the server returned valid JSON,
13
- * otherwise the raw response text as a string.
50
+ * otherwise the raw response text as a string. For a transport failure it is
51
+ * the underlying transport error message.
14
52
  */
15
53
  body;
16
54
  /** Fully-qualified URL that produced the error. */
@@ -18,22 +56,68 @@ export class RestError extends Error {
18
56
  /** HTTP method that produced the error (`GET`, `POST`, etc.). */
19
57
  method;
20
58
  /**
21
- * @param statusCode - HTTP status code returned by the server.
59
+ * Response header map captured from the failed HTTP response, or `null` for a
60
+ * transport failure that produced no response. Client-side observability with
61
+ * no wire-contract change — mirrors the python reference `SignalWireRestError.headers`.
62
+ */
63
+ headers;
64
+ /**
65
+ * The platform request id pulled from {@link headers} (`x-request-id` /
66
+ * `x-signalwire-request-id` / `request-id` / `x-amzn-requestid`, case-insensitive,
67
+ * in that precedence), or `null` if absent. Log/correlate a failure against
68
+ * SignalWire's own request id — mirrors the python reference `request_id`.
69
+ */
70
+ requestId;
71
+ /**
72
+ * @param statusCode - HTTP status code returned by the server, or `null` for
73
+ * a transport-level failure that never reached a response.
22
74
  * @param body - Response body — an object if JSON-parseable, otherwise the
23
75
  * raw response text.
24
76
  * @param url - Fully-qualified URL that produced the error.
25
77
  * @param method - HTTP method that produced the error. Defaults to `"GET"`.
78
+ * @param headers - Response header map (for request-id extraction), or `null`
79
+ * for a transport failure that produced no response.
26
80
  */
27
- constructor(statusCode, body, url, method = 'GET') {
81
+ constructor(statusCode, body, url, method = 'GET', headers = null) {
28
82
  const bodyStr = typeof body === 'string' ? body : JSON.stringify(body);
29
- super(`${method} ${url} returned ${statusCode}: ${bodyStr}`);
83
+ const reason = statusCode === null
84
+ ? `failed to reach the server: ${bodyStr}`
85
+ : `returned ${statusCode}: ${bodyStr}`;
86
+ const requestId = extractRequestId(headers);
87
+ const suffix = requestId ? ` (request-id: ${requestId})` : '';
88
+ super(`${method} ${url} ${reason}${suffix}`);
30
89
  this.name = 'RestError';
31
90
  this.statusCode = statusCode;
32
91
  this.body = body;
33
92
  this.url = url;
34
93
  this.method = method;
94
+ this.headers = headers;
95
+ this.requestId = requestId;
96
+ }
97
+ }
98
+ /**
99
+ * Raised when a REST request never reached a response — a transport-level
100
+ * failure (connection refused, DNS failure, connection reset, TLS error).
101
+ *
102
+ * A member of the {@link RestError} family (`statusCode` is `null`, `body` is
103
+ * the underlying transport error message) so a caller catching `RestError`
104
+ * (aka `SignalWireRestError`) handles both HTTP-error and transport-error
105
+ * responses with one `catch`, instead of a bare `fetch` `TypeError` leaking
106
+ * through. `headers` and `requestId` are `null` — no response was produced.
107
+ */
108
+ export class RestTransportError extends RestError {
109
+ /**
110
+ * @param body - The underlying transport error message.
111
+ * @param url - Fully-qualified URL that produced the error.
112
+ * @param method - HTTP method that produced the error. Defaults to `"GET"`.
113
+ */
114
+ constructor(body, url, method = 'GET') {
115
+ super(null, body, url, method);
116
+ this.name = 'RestTransportError';
35
117
  }
36
118
  }
37
119
  /** Alias matching the Python SDK class name. */
38
120
  export { RestError as SignalWireRestError };
121
+ /** Alias matching the Python SDK class name. */
122
+ export { RestTransportError as SignalWireRestTransportError };
39
123
  //# sourceMappingURL=RestError.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"RestError.js","sourceRoot":"","sources":["../../src/rest/RestError.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,mEAAmE;IAC1D,UAAU,CAAS;IAC5B;;;OAGG;IACM,IAAI,CAAmC;IAChD,mDAAmD;IAC1C,GAAG,CAAS;IACrB,iEAAiE;IACxD,MAAM,CAAS;IAExB;;;;;;OAMG;IACH,YACE,UAAkB,EAClB,IAAsC,EACtC,GAAW,EACX,SAAiB,KAAK;QAEtB,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvE,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,aAAa,UAAU,KAAK,OAAO,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,gDAAgD;AAChD,OAAO,EAAE,SAAS,IAAI,mBAAmB,EAAE,CAAC"}
1
+ {"version":3,"file":"RestError.js","sourceRoot":"","sources":["../../src/rest/RestError.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,kBAAkB,GAAG;IACzB,cAAc;IACd,yBAAyB;IACzB,YAAY;IACZ,kBAAkB;CACV,CAAC;AAEX;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,OAAsC;IAC9D,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;QACtC,IAAI,IAAI,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC;;;;;;;;OAQG;IACM,UAAU,CAAgB;IACnC;;;;OAIG;IACM,IAAI,CAA+B;IAC5C,mDAAmD;IAC1C,GAAG,CAAS;IACrB,iEAAiE;IACxD,MAAM,CAAS;IACxB;;;;OAIG;IACM,OAAO,CAAgC;IAChD;;;;;OAKG;IACM,SAAS,CAAgB;IAElC;;;;;;;;;OASG;IACH,YACE,UAAyB,EACzB,IAAkC,EAClC,GAAW,EACX,SAAiB,KAAK,EACtB,UAAyC,IAAI;QAE7C,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvE,MAAM,MAAM,GACV,UAAU,KAAK,IAAI;YACjB,CAAC,CAAC,+BAA+B,OAAO,EAAE;YAC1C,CAAC,CAAC,YAAY,UAAU,KAAK,OAAO,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,iBAAiB,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C;;;;OAIG;IACH,YAAY,IAAY,EAAE,GAAW,EAAE,SAAiB,KAAK;QAC3D,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,gDAAgD;AAChD,OAAO,EAAE,SAAS,IAAI,mBAAmB,EAAE,CAAC;AAC5C,gDAAgD;AAChD,OAAO,EAAE,kBAAkB,IAAI,4BAA4B,EAAE,CAAC"}
@@ -2,33 +2,31 @@
2
2
  * Generic CRUD resource with configurable update method.
3
3
  */
4
4
  import type { HttpClient } from '../HttpClient.js';
5
- import type { QueryParams } from '../types.js';
6
- import { BaseResource } from './BaseResource.js';
5
+ import type { RequestOptionsInit } from '../RequestOptions.js';
6
+ import { ReadResource } from './ReadResource.js';
7
7
  /**
8
8
  * Generic CRUD resource with configurable update method.
9
9
  *
10
- * Provides `list()`, `create()`, `get()`, `update()`, and `delete()` out of the
11
- * box — most namespace resources extend this and narrow the generic types.
12
- * `_updateMethod` may be overridden to `'PUT'` for APIs that replace instead
13
- * of patch.
10
+ * Provides `list()`, `paginate()`, `get()`, `create()`, `update()`, and
11
+ * `delete()` out of the box — most namespace resources extend this and narrow
12
+ * the generic types. `_updateMethod` may be overridden to `'PUT'` for APIs that
13
+ * replace instead of patch.
14
+ *
15
+ * Extends {@link ReadResource} (mirroring Python's `CrudResource(ReadResource)`)
16
+ * so every CRUD resource inherits the `list()`/`get()`/`paginate()` read surface
17
+ * — in particular the async-iterator `paginate()`. A prior version extended
18
+ * `BaseResource` directly and re-declared `list()`/`get()`, which silently left
19
+ * `paginate()` OFF every CRUD resource (a real runtime gap the hierarchy now closes).
14
20
  *
15
21
  * @typeParam TList - Type of the paginated list response.
16
22
  * @typeParam TItem - Type of a single resource item.
17
23
  * @typeParam TCreate - Request body type for `create()`.
18
24
  * @typeParam TUpdate - Request body type for `update()`.
19
25
  */
20
- export declare class CrudResource<TList = any, TItem = any, TCreate = any, TUpdate = any> extends BaseResource {
26
+ export declare class CrudResource<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends ReadResource<TList, TItem> {
21
27
  /** Override to 'PUT' for resources that use PUT instead of PATCH. */
22
28
  protected _updateMethod: 'PATCH' | 'PUT';
23
29
  constructor(http: HttpClient, basePath: string);
24
- /**
25
- * List resources with optional query parameters.
26
- *
27
- * @param params - Optional filter / pagination query parameters.
28
- * @returns The paginated list response.
29
- * @throws {RestError} On any non-2xx HTTP response.
30
- */
31
- list(params?: QueryParams): Promise<TList>;
32
30
  /**
33
31
  * Create a new resource.
34
32
  *
@@ -36,15 +34,7 @@ export declare class CrudResource<TList = any, TItem = any, TCreate = any, TUpda
36
34
  * @returns The newly-created resource.
37
35
  * @throws {RestError} On any non-2xx HTTP response.
38
36
  */
39
- create(body: TCreate): Promise<TItem>;
40
- /**
41
- * Fetch a single resource by ID.
42
- *
43
- * @param resourceId - Unique identifier of the resource.
44
- * @returns The resource record.
45
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
46
- */
47
- get(resourceId: string): Promise<TItem>;
37
+ create(body: TCreate, requestOptions?: RequestOptionsInit): Promise<TItem>;
48
38
  /**
49
39
  * Update a resource by ID.
50
40
  *
@@ -56,7 +46,7 @@ export declare class CrudResource<TList = any, TItem = any, TCreate = any, TUpda
56
46
  * @returns The updated resource.
57
47
  * @throws {RestError} On any non-2xx HTTP response.
58
48
  */
59
- update(resourceId: string, body: TUpdate): Promise<TItem>;
49
+ update(resourceId: string, body: TUpdate, requestOptions?: RequestOptionsInit): Promise<TItem>;
60
50
  /**
61
51
  * Delete a resource by ID.
62
52
  *
@@ -64,5 +54,5 @@ export declare class CrudResource<TList = any, TItem = any, TCreate = any, TUpda
64
54
  * @returns The platform's delete response (often an empty body on success).
65
55
  * @throws {RestError} On any non-2xx HTTP response.
66
56
  */
67
- delete(resourceId: string): Promise<any>;
57
+ delete(resourceId: string, requestOptions?: RequestOptionsInit): Promise<unknown>;
68
58
  }
@@ -1,36 +1,32 @@
1
1
  /**
2
2
  * Generic CRUD resource with configurable update method.
3
3
  */
4
- import { BaseResource } from './BaseResource.js';
4
+ import { ReadResource } from './ReadResource.js';
5
5
  /**
6
6
  * Generic CRUD resource with configurable update method.
7
7
  *
8
- * Provides `list()`, `create()`, `get()`, `update()`, and `delete()` out of the
9
- * box — most namespace resources extend this and narrow the generic types.
10
- * `_updateMethod` may be overridden to `'PUT'` for APIs that replace instead
11
- * of patch.
8
+ * Provides `list()`, `paginate()`, `get()`, `create()`, `update()`, and
9
+ * `delete()` out of the box — most namespace resources extend this and narrow
10
+ * the generic types. `_updateMethod` may be overridden to `'PUT'` for APIs that
11
+ * replace instead of patch.
12
+ *
13
+ * Extends {@link ReadResource} (mirroring Python's `CrudResource(ReadResource)`)
14
+ * so every CRUD resource inherits the `list()`/`get()`/`paginate()` read surface
15
+ * — in particular the async-iterator `paginate()`. A prior version extended
16
+ * `BaseResource` directly and re-declared `list()`/`get()`, which silently left
17
+ * `paginate()` OFF every CRUD resource (a real runtime gap the hierarchy now closes).
12
18
  *
13
19
  * @typeParam TList - Type of the paginated list response.
14
20
  * @typeParam TItem - Type of a single resource item.
15
21
  * @typeParam TCreate - Request body type for `create()`.
16
22
  * @typeParam TUpdate - Request body type for `update()`.
17
23
  */
18
- export class CrudResource extends BaseResource {
24
+ export class CrudResource extends ReadResource {
19
25
  /** Override to 'PUT' for resources that use PUT instead of PATCH. */
20
26
  _updateMethod = 'PATCH';
21
27
  constructor(http, basePath) {
22
28
  super(http, basePath);
23
29
  }
24
- /**
25
- * List resources with optional query parameters.
26
- *
27
- * @param params - Optional filter / pagination query parameters.
28
- * @returns The paginated list response.
29
- * @throws {RestError} On any non-2xx HTTP response.
30
- */
31
- async list(params) {
32
- return this._http.get(this._basePath, params);
33
- }
34
30
  /**
35
31
  * Create a new resource.
36
32
  *
@@ -38,18 +34,8 @@ export class CrudResource extends BaseResource {
38
34
  * @returns The newly-created resource.
39
35
  * @throws {RestError} On any non-2xx HTTP response.
40
36
  */
41
- async create(body) {
42
- return this._http.post(this._basePath, body);
43
- }
44
- /**
45
- * Fetch a single resource by ID.
46
- *
47
- * @param resourceId - Unique identifier of the resource.
48
- * @returns The resource record.
49
- * @throws {RestError} On any non-2xx HTTP response (including `404`).
50
- */
51
- async get(resourceId) {
52
- return this._http.get(this._path(resourceId));
37
+ async create(body, requestOptions) {
38
+ return this._http.post(this._basePath, body, undefined, requestOptions);
53
39
  }
54
40
  /**
55
41
  * Update a resource by ID.
@@ -62,11 +48,11 @@ export class CrudResource extends BaseResource {
62
48
  * @returns The updated resource.
63
49
  * @throws {RestError} On any non-2xx HTTP response.
64
50
  */
65
- async update(resourceId, body) {
51
+ async update(resourceId, body, requestOptions) {
66
52
  if (this._updateMethod === 'PUT') {
67
- return this._http.put(this._path(resourceId), body);
53
+ return this._http.put(this._path(resourceId), body, requestOptions);
68
54
  }
69
- return this._http.patch(this._path(resourceId), body);
55
+ return this._http.patch(this._path(resourceId), body, requestOptions);
70
56
  }
71
57
  /**
72
58
  * Delete a resource by ID.
@@ -75,8 +61,8 @@ export class CrudResource extends BaseResource {
75
61
  * @returns The platform's delete response (often an empty body on success).
76
62
  * @throws {RestError} On any non-2xx HTTP response.
77
63
  */
78
- async delete(resourceId) {
79
- return this._http.delete(this._path(resourceId));
64
+ async delete(resourceId, requestOptions) {
65
+ return this._http.delete(this._path(resourceId), requestOptions);
80
66
  }
81
67
  }
82
68
  //# sourceMappingURL=CrudResource.js.map