@signalwire/sdk 2.0.5 → 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 +481 -126
  6. package/dist/AgentBase.js +1502 -438
  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 +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  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 +18 -0
  42. package/dist/PomBuilder.js +53 -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 +22 -1
  48. package/dist/PromptManager.js +28 -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 +158 -58
  58. package/dist/SWMLService.js +435 -127
  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 +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  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 +92 -33
  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 -371
  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 +47 -68
  169. package/dist/index.js +44 -73
  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 +44 -17
  204. package/dist/relay/RelayClient.js +175 -65
  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 +73 -42
  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 +5 -2
  245. package/dist/rest/callHandler.js +4 -1
  246. package/dist/rest/callHandler.js.map +1 -1
  247. package/dist/rest/index.d.ts +18 -77
  248. package/dist/rest/index.js +47 -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 -327
  284. package/dist/rest/namespaces/fabric.js +14 -439
  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 +8 -196
  332. package/dist/rest/namespaces/phone-numbers.js +8 -230
  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 +22 -11
  412. package/dist/skills/SkillRegistry.js +47 -17
  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 +18 -6
  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 +21 -22
  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 +42 -4
  460. package/dist/skills/builtin/spider.js +277 -104
  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 +38 -30
  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 +294 -100
  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 +14 -13
  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 +59 -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 +85 -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
@@ -0,0 +1,520 @@
1
+ # Serverless Deployment Guide
2
+
3
+ <!-- snippet-setup -->
4
+ ```ts
5
+ export {}; // treat each example as a module (top-level await)
6
+ declare global {
7
+ const ServerlessAdapter: typeof import('@signalwire/sdk').ServerlessAdapter;
8
+ const AgentBase: typeof import('@signalwire/sdk').AgentBase;
9
+ }
10
+ ```
11
+
12
+ This guide shows how to run an agent on AWS Lambda, Google Cloud Functions, Azure Functions or as a CGI script. It also covers how the agent builds its webhook URLs and checks signatures on each platform.
13
+
14
+ ## Table of Contents
15
+
16
+ - [Overview](#overview)
17
+ - [ServerlessAdapter](#serverlessadapter)
18
+ - [AWS Lambda](#aws-lambda)
19
+ - [Google Cloud Functions](#google-cloud-functions)
20
+ - [Azure Functions](#azure-functions)
21
+ - [CGI Mode](#cgi-mode)
22
+ - [Webhook URLs and Signatures](#webhook-urls-and-signatures)
23
+ - [Platform Detection](#platform-detection)
24
+ - [URL Generation](#url-generation)
25
+ - [CLI Testing](#cli-testing)
26
+
27
+ ---
28
+
29
+ ## Overview
30
+
31
+ `ServerlessAdapter` (`src/ServerlessAdapter.ts`) turns a platform's request into a standard `Request`, routes it through the agent's Hono app, and turns the `Response` back into the platform's format. The agent's routes, basic auth, signature check and other protections work as they do on a server.
32
+
33
+ Each platform has a factory method that returns a handler in that platform's shape:
34
+
35
+ | Platform | Identifier | Factory Method |
36
+ |---|---|---|
37
+ | AWS Lambda | `lambda` | `ServerlessAdapter.createLambdaHandler(app)` |
38
+ | Google Cloud Functions | `gcf` | `ServerlessAdapter.createGcfHandler(app)` |
39
+ | Azure Functions | `azure` | `ServerlessAdapter.createAzureHandler(app)` |
40
+ | CGI | `cgi` | `ServerlessAdapter.createCgiHandler(app)`, or `agent.run()` |
41
+
42
+ `app` is the agent's `getApp()`. `agent.runServerless(event, context, platform)` routes one Lambda-style event, and `agent.run()` calls it when it detects a serverless environment.
43
+
44
+ Build the agent once, at module scope, so each warm invocation reuses it. Set `basicAuth` or `SWML_BASIC_AUTH_PASSWORD`: a generated password changes with every cold start, and SignalWire can't use it.
45
+
46
+ ---
47
+
48
+ ## ServerlessAdapter
49
+
50
+ ### Constructor
51
+
52
+ The constructor takes the platform, or `'auto'` to detect it from the environment:
53
+
54
+ ```typescript
55
+ import { ServerlessAdapter } from '@signalwire/sdk';
56
+
57
+ // Detect the platform from environment variables
58
+ const adapter = new ServerlessAdapter();
59
+ // or: new ServerlessAdapter('auto')
60
+
61
+ // Choose the platform
62
+ const lambdaAdapter = new ServerlessAdapter('lambda');
63
+ const gcfAdapter = new ServerlessAdapter('gcf');
64
+ const azureAdapter = new ServerlessAdapter('azure');
65
+ const cgiAdapter = new ServerlessAdapter('cgi');
66
+ ```
67
+
68
+ The `platform` parameter accepts `'lambda' | 'gcf' | 'azure' | 'cgi' | 'auto'`. [Platform Detection](#platform-detection) lists the variables `'auto'` checks.
69
+
70
+ ### Core Types
71
+
72
+ `ServerlessEvent` is the Lambda-style event that `handleRequest()` accepts:
73
+
74
+ ```typescript
75
+ interface ServerlessEvent {
76
+ httpMethod?: string; // HTTP method (API Gateway REST)
77
+ method?: string; // HTTP method (other callers)
78
+ headers?: Record<string, string>; // Request headers
79
+ body?: string | Record<string, unknown>; // Raw or parsed request body
80
+ isBase64Encoded?: boolean; // body is base64-encoded
81
+ path?: string; // Request path
82
+ rawPath?: string; // Raw path (HTTP API and function URLs)
83
+ queryStringParameters?: Record<string, string>; // Decoded query parameters
84
+ multiValueQueryStringParameters?: Record<string, string[]>; // Repeated parameters (REST)
85
+ rawQueryString?: string; // Raw query (HTTP API and function URLs)
86
+ pathParameters?: Record<string, string>; // `proxy` holds the path below a {proxy+} resource
87
+ requestContext?: Record<string, unknown>; // Platform context: domainName, stage, http.method
88
+ }
89
+ ```
90
+
91
+ `ServerlessResponse` is what every handler produces:
92
+
93
+ ```typescript
94
+ interface ServerlessResponse {
95
+ statusCode: number; // HTTP status code
96
+ headers: Record<string, string>; // Response headers
97
+ body: string; // Response body as string
98
+ }
99
+ ```
100
+
101
+ ### handleRequest()
102
+
103
+ `handleRequest(app, event)` routes one Lambda-style event through a Hono app:
104
+
105
+ <!-- snippet: no-run illustrative fragment: references the assumed `ServerlessAdapter` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
106
+ ```typescript
107
+ const adapter = new ServerlessAdapter('lambda');
108
+ const agent = new AgentBase({ name: 'my-agent' });
109
+ const app = agent.getApp();
110
+
111
+ const event: any = {}; // the platform-specific event passed to your handler
112
+ const response = await adapter.handleRequest(app, event);
113
+ // response: { statusCode: 200, headers: {...}, body: '...' }
114
+ ```
115
+
116
+ It reads the event in these steps:
117
+
118
+ 1. The method comes from `httpMethod`, `method` or `requestContext.http.method`. Without one, it's `POST` when the event has a body and `GET` otherwise.
119
+ 2. The path comes from `rawPath` (with a non-default stage removed), then `pathParameters.proxy`, then `path`, then `/`.
120
+ 3. The query is `rawQueryString` when present. Otherwise it's built from `multiValueQueryStringParameters` or `queryStringParameters`.
121
+ 4. A base64-encoded body is decoded, and a parsed body is serialized to JSON.
122
+ 5. The request is routed through `app.fetch()`, which also receives the URL the platform was called on, for the signature check.
123
+ 6. The `Response` becomes a `ServerlessResponse`.
124
+
125
+ ---
126
+
127
+ ## AWS Lambda
128
+
129
+ `ServerlessAdapter.createLambdaHandler(app)` returns a Lambda handler, `(event) => Promise<ServerlessResponse>`. It accepts events from a Lambda function URL, an API Gateway HTTP API and an API Gateway REST API.
130
+
131
+ ### Example: Lambda Handler
132
+
133
+ This handler file builds the agent once and exports the Lambda handler:
134
+
135
+ ```typescript
136
+ // handler.ts
137
+ import { AgentBase, FunctionResult, ServerlessAdapter } from '@signalwire/sdk';
138
+
139
+ export const agent = new AgentBase({
140
+ name: 'lambda-agent',
141
+ basicAuth: ['admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
142
+ signingKey: process.env.SIGNALWIRE_SIGNING_KEY,
143
+ swaigSecret: process.env.SIGNALWIRE_SWAIG_SECRET,
144
+ });
145
+
146
+ agent.setPromptText('You are a helpful assistant deployed on AWS Lambda.');
147
+
148
+ agent.defineTool({
149
+ name: 'get_status',
150
+ description: 'Get the current system status',
151
+ parameters: {
152
+ type: 'object',
153
+ properties: {
154
+ system: { type: 'string', description: 'System name' },
155
+ },
156
+ },
157
+ handler: async (args) => new FunctionResult(`System ${args.system} is operational.`),
158
+ });
159
+
160
+ export const handler = ServerlessAdapter.createLambdaHandler(agent.getApp());
161
+ ```
162
+
163
+ Every instance of the function must sign tool tokens with the same secret, so the example sets `swaigSecret`. Without it, each cold start generates a new secret, and a tool call that reaches another instance is refused. [Security](security.md#the-signing-secret) explains the token secret.
164
+
165
+ ### API Gateway REST APIs
166
+
167
+ An API Gateway REST API (payload version 1.0) passes the query parameters to Lambda decoded, so the adapter can't always rebuild the exact URL SignalWire signed. It tries the two common encodings, but a URL with several query parameters may still fail the signature check. To check signatures on Lambda, serve the agent from a Lambda function URL or an HTTP API (payload version 2.0), which pass the raw query string.
168
+
169
+ ### Deployment
170
+
171
+ These commands package the compiled code and create the function. The SDK needs Node.js 22 or later:
172
+
173
+ ```bash
174
+ # Build and package
175
+ npm run build
176
+ zip -r function.zip dist/ node_modules/ package.json
177
+
178
+ # Create the function
179
+ aws lambda create-function \
180
+ --function-name my-agent \
181
+ --runtime nodejs22.x \
182
+ --handler dist/handler.handler \
183
+ --zip-file fileb://function.zip \
184
+ --role arn:aws:iam::123456789012:role/my-agent-role \
185
+ --environment "Variables={AGENT_PASSWORD=a-long-random-password,SIGNALWIRE_SWAIG_SECRET=a-long-random-secret}"
186
+ ```
187
+
188
+ ---
189
+
190
+ ## Google Cloud Functions
191
+
192
+ `ServerlessAdapter.createGcfHandler(app)` returns an HTTP function for the Functions Framework, `(req, res) => Promise<void>`.
193
+
194
+ ### Example: Cloud Function Handler
195
+
196
+ This file exports the handler as the function's entry point:
197
+
198
+ ```typescript
199
+ // index.ts
200
+ import { AgentBase, ServerlessAdapter } from '@signalwire/sdk';
201
+
202
+ const agent = new AgentBase({
203
+ name: 'gcf-agent',
204
+ basicAuth: ['admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
205
+ });
206
+
207
+ agent.setPromptText('You are a helpful assistant on Google Cloud Functions.');
208
+
209
+ export const agentHandler = ServerlessAdapter.createGcfHandler(agent.getApp());
210
+ ```
211
+
212
+ ### How It Works
213
+
214
+ The handler reads the Express-style request the Functions Framework passes:
215
+
216
+ 1. `req.method` and `req.headers` give the method and headers.
217
+ 2. `req.rawBody`, the body as it arrived, is used when present, so the signature check sees the signed bytes. Otherwise `req.body` is used, serialized to JSON when it's parsed.
218
+ 3. `req.originalUrl` (or `req.url`, or `req.path`) gives the path and query.
219
+ 4. The response is written with `res.status()`, `res.set()` and `res.send()`.
220
+
221
+ ### Deployment
222
+
223
+ This command deploys the handler with the Node.js 22 runtime:
224
+
225
+ ```bash
226
+ gcloud functions deploy agentHandler \
227
+ --runtime nodejs22 \
228
+ --trigger-http \
229
+ --entry-point agentHandler \
230
+ --set-env-vars AGENT_PASSWORD=a-long-random-password \
231
+ --allow-unauthenticated
232
+ ```
233
+
234
+ `--allow-unauthenticated` lets SignalWire reach the function without Google credentials. The agent's basic auth still applies.
235
+
236
+ ---
237
+
238
+ ## Azure Functions
239
+
240
+ `ServerlessAdapter.createAzureHandler(app)` returns a handler with the Azure Functions programming model v3 signature, `(context, req) => Promise<void>`. It sets `context.res` with the status, headers and body.
241
+
242
+ The v4 model's `app.http()` calls a handler with `(request, context)` and expects a returned response, so this handler doesn't fit it. Use the v3 model, with a `function.json` file.
243
+
244
+ ### Example: Azure Function Handler
245
+
246
+ This file exports the handler as the function's entry point:
247
+
248
+ ```typescript
249
+ // index.ts
250
+ import { AgentBase, ServerlessAdapter } from '@signalwire/sdk';
251
+
252
+ const agent = new AgentBase({
253
+ name: 'azure-agent',
254
+ basicAuth: ['admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
255
+ });
256
+
257
+ agent.setPromptText('You are a helpful assistant on Azure Functions.');
258
+
259
+ export default ServerlessAdapter.createAzureHandler(agent.getApp());
260
+ ```
261
+
262
+ ### How It Works
263
+
264
+ The handler reads the v3 request object:
265
+
266
+ 1. `req.method` and `req.headers` give the method and headers.
267
+ 2. `req.rawBody` is used when present, so the signature check sees the signed bytes. Otherwise `req.body` is used.
268
+ 3. `req.url` is the absolute URL, such as `https://my-app.azurewebsites.net/api/agent/swaig?code=...`. The path below `/api/<function>` is routed, and the whole URL is what the signature covers.
269
+
270
+ ### function.json
271
+
272
+ The function's `function.json` binds an HTTP trigger for GET and POST:
273
+
274
+ ```json
275
+ {
276
+ "bindings": [
277
+ {
278
+ "authLevel": "anonymous",
279
+ "type": "httpTrigger",
280
+ "direction": "in",
281
+ "name": "req",
282
+ "methods": ["get", "post"],
283
+ "route": "agent/{*path}"
284
+ },
285
+ {
286
+ "type": "http",
287
+ "direction": "out",
288
+ "name": "res"
289
+ }
290
+ ]
291
+ }
292
+ ```
293
+
294
+ The `route` with a catch-all segment lets the one function receive `/api/agent`, `/api/agent/swaig` and `/api/agent/post_prompt`.
295
+
296
+ ### Deployment
297
+
298
+ This command publishes the function app:
299
+
300
+ ```bash
301
+ func azure functionapp publish my-agent-app
302
+ ```
303
+
304
+ ---
305
+
306
+ ## CGI Mode
307
+
308
+ In a CGI environment, `agent.run()` handles the request. It detects CGI from `GATEWAY_INTERFACE`, and reads the request from the CGI variables: `REQUEST_METHOD`, `PATH_INFO`, `QUERY_STRING`, `CONTENT_TYPE` and the `HTTP_*` headers. It reads the body from stdin, up to `CONTENT_LENGTH` bytes. It writes a `Status:` line, the headers, a blank line and the body to stdout.
309
+
310
+ This script is a complete CGI program:
311
+
312
+ <!-- snippet: no-run a CGI program: reads the request from the CGI environment and stdin -->
313
+ ```typescript
314
+ // agent.cgi.ts
315
+ import { AgentBase } from '@signalwire/sdk';
316
+
317
+ const agent = new AgentBase({
318
+ name: 'cgi-agent',
319
+ basicAuth: ['admin', process.env.AGENT_PASSWORD ?? 'a-long-random-password'],
320
+ });
321
+ agent.setPromptText('You are a CGI-deployed assistant.');
322
+
323
+ await agent.run();
324
+ ```
325
+
326
+ `ServerlessAdapter.createCgiHandler(app)` returns a function that does the same for any Hono app. The adapter refuses a body over 10 MB (`ServerlessAdapter.MAX_CGI_BODY_SIZE`) and handles the request without it.
327
+
328
+ In CGI mode the SDK turns logging off by default, since stdout carries the response. The agent's credentials arrive in the `Authorization` header, which some web servers don't pass to CGI scripts by default. Apache passes it with `CGIPassAuth On`.
329
+
330
+ ---
331
+
332
+ ## Webhook URLs and Signatures
333
+
334
+ The SWML the agent serves tells SignalWire where to send tool calls and the post-prompt summary. On a serverless platform, the agent builds those URLs from the platform, and checks signatures against the URL the platform received the request on.
335
+
336
+ ### Webhook URLs
337
+
338
+ `SWML_PROXY_URL_BASE`, or a URL set with `manualSetProxyUrl()`, always wins. Without one, each platform's base URL comes from these sources:
339
+
340
+ | Platform | Base URL |
341
+ |---|---|
342
+ | Lambda | `AWS_LAMBDA_FUNCTION_URL`. Without it, `https://<AWS_LAMBDA_FUNCTION_NAME>.lambda-url.<AWS_REGION>.on.aws`, which has the function name where a real function URL has its URL ID. Set `AWS_LAMBDA_FUNCTION_URL`, or behind API Gateway set `SWML_PROXY_URL_BASE`. |
343
+ | Google Cloud Functions | `FUNCTION_URL` when set. Otherwise the request's host: a `cloudfunctions.net` host gets `/<K_SERVICE>` (or `/<FUNCTION_TARGET>`) added, and any other host, such as Cloud Run's, is used as it is. |
344
+ | Azure Functions | The request's URL up to `/api/<function>`. Before the first request, `AZURE_FUNCTION_URL`, or `https://<WEBSITE_SITE_NAME>.azurewebsites.net/api/<AZURE_FUNCTION_NAME>`. |
345
+ | CGI | `http://` (or `https://` when `HTTPS=on`) plus `HTTP_HOST` (or `SERVER_NAME`) plus `SCRIPT_NAME`. |
346
+
347
+ The agent adds its route when it isn't `/`, then `/swaig` or `/post_prompt`, and puts its basic auth credentials in the URL. This is the default webhook URL `swaig-test` prints for `examples/simple-agent.ts` with `--simulate-serverless cgi --cgi-host example.com --cgi-https`:
348
+
349
+ ```text
350
+ https://dev:w00t@example.com/cgi-bin/agent.cgi/swaig
351
+ ```
352
+
353
+ ### Signatures
354
+
355
+ With a signing key set, the agent checks each POST's signature against the URL the platform received it on:
356
+
357
+ - **Lambda**: `https://` plus `requestContext.domainName` (or the function URL's host), the path as called (with any API Gateway stage), and the query. [API Gateway REST APIs](#api-gateway-rest-apis) explains the limit on decoded queries.
358
+ - **Google Cloud Functions**: the webhook base URL from the preceding table (`FUNCTION_URL`, or the host with `/<K_SERVICE>` on `cloudfunctions.net`), plus `req.originalUrl`. The platform strips the function's name before the request arrives; the request's own URL isn't accepted, since it would also match a signature made for another function on the same host.
359
+ - **Azure Functions**: `req.url`.
360
+ - **CGI**: the scheme, `HTTP_HOST` (or `SERVER_NAME`), and `REQUEST_URI` (or `SCRIPT_NAME`, `PATH_INFO` and `QUERY_STRING`).
361
+
362
+ When `SWML_PROXY_URL_BASE` is set, the check uses it instead, joined with the path below the function and the query. If SignalWire's requests are refused with `403`, set `SWML_PROXY_URL_BASE` to the function's public base URL, including any stage or function path. [Security](security.md#webhook-signature-validation) describes the signature scheme.
363
+
364
+ ---
365
+
366
+ ## Platform Detection
367
+
368
+ `new ServerlessAdapter('auto')` (the default) checks for these environment variables, in order:
369
+
370
+ | Order | Environment Variables Checked | Detected Platform |
371
+ |---|---|---|
372
+ | 1 | `AWS_LAMBDA_FUNCTION_NAME` or `_HANDLER` | `lambda` |
373
+ | 2 | `FUNCTION_TARGET` or `K_SERVICE` | `gcf` |
374
+ | 3 | `FUNCTIONS_WORKER_RUNTIME` or `AZURE_FUNCTIONS_ENVIRONMENT` | `azure` |
375
+ | 4 | `GATEWAY_INTERFACE` | `cgi` |
376
+ | 5 | *(none matched)* | `lambda` (default fallback) |
377
+
378
+ `getPlatform()` returns the platform the adapter uses:
379
+
380
+ ```typescript
381
+ const adapter = new ServerlessAdapter('auto');
382
+ console.log(adapter.getPlatform()); // 'lambda', 'gcf', 'azure', or 'cgi'
383
+ ```
384
+
385
+ `agent.run()` treats the same variables (except `AZURE_FUNCTIONS_ENVIRONMENT`, and `K_SERVICE` without `FUNCTION_TARGET`) as a serverless environment, and calls `runServerless()` instead of starting a server. Cloud Run sets `K_SERVICE` but not `FUNCTION_TARGET`, so `run()` starts a server there.
386
+
387
+ ---
388
+
389
+ ## URL Generation
390
+
391
+ `generateUrl()` returns the usual invocation URL of a function on the adapter's platform. It's a convenience for your own scripts; the agent doesn't use it for webhook URLs. This example builds an API Gateway URL:
392
+
393
+ ```typescript
394
+ const adapter = new ServerlessAdapter('lambda');
395
+ const url = adapter.generateUrl({
396
+ region: 'us-west-2',
397
+ apiId: 'abc123xyz',
398
+ stage: 'prod',
399
+ });
400
+ console.log(url); // https://abc123xyz.execute-api.us-west-2.amazonaws.com/prod
401
+ ```
402
+
403
+ The other platforms use these options:
404
+
405
+ ```typescript
406
+ new ServerlessAdapter('gcf').generateUrl({ projectId: 'my-project', region: 'us-central1', functionName: 'agent' });
407
+ // https://us-central1-my-project.cloudfunctions.net/agent
408
+
409
+ new ServerlessAdapter('azure').generateUrl({ functionName: 'my-agent' });
410
+ // https://my-agent.azurewebsites.net/api/my-agent
411
+
412
+ new ServerlessAdapter('cgi').generateUrl({ functionName: 'my-agent' });
413
+ // http://localhost/cgi-bin/my-agent
414
+ ```
415
+
416
+ ### generateUrl() Options
417
+
418
+ | Option | Type | Default | Description |
419
+ |---|---|---|---|
420
+ | `region` | `string` | `AWS_REGION` or `us-east-1` (Lambda); `FUNCTION_REGION` or `us-central1` (GCF) | Cloud region. |
421
+ | `projectId` | `string` | `GCLOUD_PROJECT` or `PROJECT` | GCP project ID (GCF only). |
422
+ | `functionName` | `string` | `AWS_LAMBDA_FUNCTION_NAME` or `agent` | Function name. Azure uses it for the app name too. |
423
+ | `stage` | `string` | `prod` | API Gateway stage (Lambda only). |
424
+ | `apiId` | `string` | `API_ID` | API Gateway ID (Lambda only). |
425
+
426
+ ---
427
+
428
+ ## CLI Testing
429
+
430
+ `swaig-test` runs an agent file with a serverless platform's environment when you pass `--simulate-serverless lambda|cgi|gcf|azure`, so the SWML's webhook URLs are the platform's. It clears `SWML_PROXY_URL_BASE` for the run. Put its options before `--exec`, since everything after the function name is an argument to the function.
431
+
432
+ ### Simulating a Platform
433
+
434
+ These commands print the SWML, or call a function, with each platform's environment:
435
+
436
+ ```bash
437
+ # Lambda, with your function URL
438
+ npx tsx src/cli/swaig-test.ts handler.ts --simulate-serverless lambda \
439
+ --aws-function-url https://abc123.lambda-url.us-west-2.on.aws/ --dump-swml
440
+
441
+ # CGI (--cgi-host is required)
442
+ npx tsx src/cli/swaig-test.ts agent.cgi.ts --simulate-serverless cgi \
443
+ --cgi-host example.com --cgi-https --cgi-script-name /cgi-bin/agent.cgi --dump-swml
444
+
445
+ # Google Cloud Functions
446
+ npx tsx src/cli/swaig-test.ts index.ts --simulate-serverless gcf \
447
+ --gcp-project my-project --gcp-function-url https://us-central1-my-project.cloudfunctions.net/agent \
448
+ --exec get_status --system production
449
+
450
+ # Azure Functions
451
+ npx tsx src/cli/swaig-test.ts index.ts --simulate-serverless azure \
452
+ --azure-function-url https://my-app.azurewebsites.net/api/agent --dump-swml
453
+ ```
454
+
455
+ The platform options are:
456
+
457
+ | Platform | Options |
458
+ |---|---|
459
+ | `lambda` | `--aws-function-name`, `--aws-function-url`, `--aws-region`, `--aws-api-gateway-id`, `--aws-stage` |
460
+ | `cgi` | `--cgi-host` (required), `--cgi-script-name`, `--cgi-https`, `--cgi-path-info` |
461
+ | `gcf` | `--gcp-project`, `--gcp-function-url`, `--gcp-region`, `--gcp-service` |
462
+ | `azure` | `--azure-env`, `--azure-function-url` |
463
+
464
+ Each simulated platform starts from a preset environment. The Lambda preset includes a function URL, which wins over `--aws-function-name` and `--aws-region`, so pass `--aws-function-url` or `--aws-api-gateway-id` to set the URL. For the details, see the [CLI guide](cli-guide.md#serverless-simulation).
465
+
466
+ ### Testing Tools Locally
467
+
468
+ Without a simulated platform, `swaig-test` checks the agent's tools before you deploy:
469
+
470
+ ```bash
471
+ # List all registered tools
472
+ npx tsx src/cli/swaig-test.ts handler.ts --list-tools
473
+
474
+ # Print the SWML document the agent generates
475
+ npx tsx src/cli/swaig-test.ts handler.ts --dump-swml
476
+
477
+ # Call a tool with an argument
478
+ npx tsx src/cli/swaig-test.ts handler.ts --exec get_status --system production
479
+ ```
480
+
481
+ ### Running as a Server
482
+
483
+ For development, you can also serve the same agent over HTTP. Export it from the handler module, and call `agent.serve()` from a separate script that imports it. Keep `serve()` out of the handler module itself, since a Lambda, Cloud Functions or Azure handler must not start a server.
484
+
485
+ ### Simulating Serverless Events
486
+
487
+ You can also pass a hand-built event to the adapter. This example requests the SWML with a Lambda-style event:
488
+
489
+ ```typescript
490
+ import { AgentBase, ServerlessAdapter } from '@signalwire/sdk';
491
+
492
+ const agent = new AgentBase({ name: 'test-agent', basicAuth: ['admin', 'test'] });
493
+ agent.setPromptText('Hello!');
494
+
495
+ const adapter = new ServerlessAdapter('lambda');
496
+ const app = agent.getApp();
497
+
498
+ const event = {
499
+ httpMethod: 'POST',
500
+ path: '/',
501
+ headers: {
502
+ 'content-type': 'application/json',
503
+ authorization: 'Basic ' + Buffer.from('admin:test').toString('base64'),
504
+ },
505
+ body: JSON.stringify({ call_id: 'test-call-123' }),
506
+ };
507
+
508
+ const response = await adapter.handleRequest(app, event);
509
+ console.log('Status:', response.statusCode);
510
+ console.log('Body:', response.body);
511
+ ```
512
+
513
+ It prints:
514
+
515
+ ```text
516
+ Status: 200
517
+ Body: {"version":"1.0.0","sections":{"main":[{"answer":{}},{"ai":{"prompt":{"text":"Hello!"}}}]}}
518
+ ```
519
+
520
+ For the platform-specific steps on Google Cloud and Azure, see the [Cloud Functions Deployment Guide](cloud_functions_guide.md).