@signalwire/sdk 2.0.1 → 2.0.3

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 (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -0,0 +1,303 @@
1
+ /**
2
+ * ReceptionistAgent - Prefab agent that greets callers, collects basic info,
3
+ * and transfers them to the appropriate department.
4
+ *
5
+ * Ported from the Python SDK `signalwire.prefabs.receptionist.ReceptionistAgent`.
6
+ * Preserves TS-specific enhancements (`companyName`, visitor check-in) as
7
+ * additive features.
8
+ */
9
+ import { AgentBase } from '../AgentBase.js';
10
+ import { FunctionResult } from '../FunctionResult.js';
11
+ // ── Agent ───────────────────────────────────────────────────────────────────
12
+ /**
13
+ * Prefab agent that greets callers, collects basic information, and transfers them to the correct department.
14
+ *
15
+ * Optionally supports visitor check-in — when enabled, the agent can collect a visitor's name
16
+ * and purpose-of-visit and invoke a callback (e.g., notify reception via Slack, write to a
17
+ * database). If not transferring, the call ends after check-in.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * import { ReceptionistAgent } from '@signalwire/sdk';
22
+ *
23
+ * const agent = new ReceptionistAgent({
24
+ * companyName: 'Acme Co',
25
+ * greeting: 'Thanks for calling Acme! How can I direct your call?',
26
+ * departments: [
27
+ * { name: 'sales', description: 'New customer inquiries', number: '+15551112222' },
28
+ * { name: 'support', description: 'Existing customer help', number: '+15553334444' },
29
+ * { name: 'billing', description: 'Billing and payments', number: '+15555556666' },
30
+ * ],
31
+ * checkInEnabled: true,
32
+ * onVisitorCheckIn: async (visitor) => {
33
+ * await notifyFrontDesk(visitor);
34
+ * },
35
+ * });
36
+ *
37
+ * await agent.serve({ port: 3000 });
38
+ * ```
39
+ */
40
+ export class ReceptionistAgent extends AgentBase {
41
+ greeting;
42
+ departments;
43
+ companyName;
44
+ checkInEnabled;
45
+ onVisitorCheckInCallback;
46
+ sessions = new Map();
47
+ /**
48
+ * Create a ReceptionistAgent with the specified departments.
49
+ * @param config - Configuration including departments (name/description/number), greeting, and voice.
50
+ */
51
+ constructor(config) {
52
+ const agentName = config.name ?? 'receptionist';
53
+ super({
54
+ name: agentName,
55
+ route: config.route ?? '/receptionist',
56
+ usePom: true,
57
+ ...config.agentOptions,
58
+ });
59
+ // Validate departments (Python _validate_departments parity)
60
+ ReceptionistAgent.validateDepartments(config.departments);
61
+ this.greeting = config.greeting ?? 'Thank you for calling. How can I help you today?';
62
+ this.departments = config.departments;
63
+ this.companyName = config.companyName;
64
+ this.checkInEnabled = config.checkInEnabled ?? false;
65
+ this.onVisitorCheckInCallback = config.onVisitorCheckIn;
66
+ // Initial global data: departments + empty caller_info bucket
67
+ this.setGlobalData({
68
+ departments: this.departments,
69
+ caller_info: {},
70
+ });
71
+ this.buildPrompt();
72
+ this.configureAgentSettings(config.voice ?? 'rime.spore');
73
+ // Register tools after all fields are initialized
74
+ this.defineTools();
75
+ }
76
+ static validateDepartments(departments) {
77
+ if (!Array.isArray(departments) || departments.length === 0) {
78
+ throw new Error('At least one department is required');
79
+ }
80
+ for (let i = 0; i < departments.length; i++) {
81
+ const d = departments[i];
82
+ if (!d || typeof d !== 'object') {
83
+ throw new Error(`Department ${i + 1} must be an object`);
84
+ }
85
+ if (typeof d['name'] !== 'string' || !d['name']) {
86
+ throw new Error(`Department ${i + 1} is missing 'name' field`);
87
+ }
88
+ if (typeof d['description'] !== 'string' || !d['description']) {
89
+ throw new Error(`Department ${i + 1} is missing 'description' field`);
90
+ }
91
+ if (typeof d['number'] !== 'string' || !d['number']) {
92
+ throw new Error(`Department ${i + 1} is missing 'number' field`);
93
+ }
94
+ }
95
+ }
96
+ buildPrompt() {
97
+ // Personality
98
+ this.promptAddSection('Personality', {
99
+ body: 'You are a friendly and professional receptionist. You speak clearly and efficiently while maintaining a warm, helpful tone.',
100
+ });
101
+ // Goal
102
+ this.promptAddSection('Goal', {
103
+ body: 'Your goal is to greet callers, collect their basic information, and transfer them to the appropriate department.',
104
+ });
105
+ // Greeting instruction honors optional companyName branding
106
+ const branded = this.companyName
107
+ ? `${this.greeting.trimEnd()} Welcome to ${this.companyName}.`
108
+ : this.greeting;
109
+ // Instructions
110
+ const instructions = [
111
+ `Begin by greeting the caller with: '${branded}'`,
112
+ 'Collect their name and a brief description of their needs.',
113
+ 'Based on their needs, determine which department would be most appropriate.',
114
+ 'Use the collect_caller_info function when you have their name and reason for calling.',
115
+ 'Use the transfer_call function to transfer them to the appropriate department.',
116
+ "Before transferring, always confirm with the caller that they're being transferred to the right department.",
117
+ 'If a caller\'s request does not clearly match a department, ask follow-up questions to clarify.',
118
+ ];
119
+ if (this.checkInEnabled) {
120
+ instructions.push('If a caller wants to check in as a visitor, collect their full name, purpose of visit, and who they are visiting, then use the check_in_visitor tool.');
121
+ }
122
+ this.promptAddSection('Instructions', { bullets: instructions });
123
+ // Departments list as a bulleted section
124
+ const deptBullets = this.departments.map((dept) => `${dept.name}: ${dept.description}`);
125
+ this.promptAddSection('Available Departments', { bullets: deptBullets });
126
+ // Post-prompt JSON summary template (Python parity)
127
+ this.setPostPrompt(`
128
+ Return a JSON summary of the conversation:
129
+ {
130
+ "caller_name": "CALLER'S NAME",
131
+ "reason": "REASON FOR CALLING",
132
+ "department": "DEPARTMENT TRANSFERRED TO",
133
+ "satisfaction": "high/medium/low (estimated caller satisfaction)"
134
+ }
135
+ `);
136
+ }
137
+ configureAgentSettings(voice) {
138
+ this.setParams({
139
+ end_of_speech_timeout: 700,
140
+ speech_event_timeout: 1000,
141
+ transfer_summary: true,
142
+ });
143
+ this.addLanguage({ name: 'English', code: 'en-US', voice });
144
+ // Speech recognition hints derived from company + department names
145
+ const hints = [];
146
+ if (this.companyName)
147
+ hints.push(this.companyName);
148
+ hints.push(...this.departments.map((d) => d.name));
149
+ if (hints.length)
150
+ this.addHints(hints);
151
+ }
152
+ // ── Session helpers ───────────────────────────────────────────────────
153
+ getSession(rawData) {
154
+ const callId = rawData['call_id'] ?? 'default';
155
+ let session = this.sessions.get(callId);
156
+ if (!session) {
157
+ session = { visitors: [] };
158
+ this.sessions.set(callId, session);
159
+ }
160
+ return session;
161
+ }
162
+ // ── Tool registration ─────────────────────────────────────────────────
163
+ /**
164
+ * Register the `collect_caller_info` and `transfer_call` SWAIG tools
165
+ * (Python parity). When `checkInEnabled` is `true`, also registers the
166
+ * TS-specific `check_in_visitor` tool.
167
+ */
168
+ defineTools() {
169
+ // Tool: collect_caller_info (Python parity)
170
+ this.defineTool({
171
+ name: 'collect_caller_info',
172
+ description: "Collect the caller's information for routing",
173
+ parameters: {
174
+ type: 'object',
175
+ properties: {
176
+ name: {
177
+ type: 'string',
178
+ description: "The caller's name",
179
+ },
180
+ reason: {
181
+ type: 'string',
182
+ description: 'The reason for the call',
183
+ },
184
+ },
185
+ },
186
+ handler: (args) => {
187
+ const name = args['name'] ?? '';
188
+ const reason = args['reason'] ?? '';
189
+ const result = new FunctionResult(`Thank you, ${name}. I've noted that you're calling about ${reason}.`);
190
+ result.addActions([
191
+ {
192
+ set_global_data: {
193
+ caller_info: { name, reason },
194
+ },
195
+ },
196
+ ]);
197
+ return result;
198
+ },
199
+ });
200
+ // Tool: transfer_call (Python parity with enum on department)
201
+ const departmentNames = this.departments.map((d) => d.name);
202
+ this.defineTool({
203
+ name: 'transfer_call',
204
+ description: 'Transfer the caller to the appropriate department',
205
+ parameters: {
206
+ type: 'object',
207
+ properties: {
208
+ department: {
209
+ type: 'string',
210
+ description: 'The department to transfer to',
211
+ enum: departmentNames,
212
+ },
213
+ },
214
+ },
215
+ handler: (args, rawData) => {
216
+ const departmentName = (args['department'] ?? '').trim();
217
+ const globalData = rawData['global_data'] ?? {};
218
+ const callerInfo = globalData['caller_info'] ?? {};
219
+ const name = callerInfo['name'] ?? 'the caller';
220
+ const dept = this.departments.find((d) => d.name === departmentName);
221
+ if (!dept) {
222
+ return new FunctionResult(`Sorry, I couldn't find the ${departmentName} department.`);
223
+ }
224
+ // Python uses post_process=True and final=True so the AI speaks
225
+ // before executing the transfer.
226
+ const result = new FunctionResult(`I'll transfer you to our ${departmentName} department now. Thank you for calling, ${name}!`, true);
227
+ result.connect(dept.number, true);
228
+ return result;
229
+ },
230
+ });
231
+ // Tool: check_in_visitor (TS-specific; only if checkInEnabled)
232
+ if (this.checkInEnabled) {
233
+ this.defineTool({
234
+ name: 'check_in_visitor',
235
+ description: 'Check in a visitor by recording their name, purpose of visit, and who they are visiting.',
236
+ parameters: {
237
+ type: 'object',
238
+ properties: {
239
+ visitor_name: {
240
+ type: 'string',
241
+ description: 'Full name of the visitor.',
242
+ },
243
+ purpose: {
244
+ type: 'string',
245
+ description: 'Purpose of the visit.',
246
+ },
247
+ visiting: {
248
+ type: 'string',
249
+ description: 'Name of the person or department the visitor is here to see.',
250
+ },
251
+ },
252
+ required: ['visitor_name', 'purpose', 'visiting'],
253
+ },
254
+ handler: async (args, rawData) => {
255
+ const visitorName = args['visitor_name'];
256
+ const purpose = args['purpose'];
257
+ const visiting = args['visiting'];
258
+ if (!visitorName || !purpose || !visiting) {
259
+ return new FunctionResult("Please provide the visitor's name, purpose of visit, and who they are visiting.");
260
+ }
261
+ const visitorRecord = {
262
+ visitor_name: visitorName,
263
+ purpose,
264
+ visiting,
265
+ checked_in_at: new Date().toISOString(),
266
+ };
267
+ const session = this.getSession(rawData);
268
+ session.visitors.push(visitorRecord);
269
+ if (this.onVisitorCheckInCallback) {
270
+ try {
271
+ await this.onVisitorCheckInCallback(visitorRecord);
272
+ }
273
+ catch (err) {
274
+ this.log.error(`onVisitorCheckIn callback error: ${err}`);
275
+ }
276
+ }
277
+ const companyPart = this.companyName ? ` Welcome to ${this.companyName}!` : '';
278
+ return new FunctionResult(`Visitor checked in successfully! Name: ${visitorName}, Purpose: ${purpose}, Visiting: ${visiting}.${companyPart}`);
279
+ },
280
+ });
281
+ }
282
+ }
283
+ // ── Lifecycle hooks ───────────────────────────────────────────────────
284
+ /**
285
+ * Python-style receptionist summary hook. Default is a no-op; subclasses
286
+ * may override to persist the summary. Mirrors Python `on_summary`
287
+ * (receptionist.py lines 278–287).
288
+ */
289
+ onSummary(_summary, _rawData) {
290
+ // Intentional no-op pass-through; subclasses override to handle the summary.
291
+ }
292
+ }
293
+ // ── Factory function ────────────────────────────────────────────────────────
294
+ /**
295
+ * Factory function that creates and returns a new ReceptionistAgent.
296
+ * @param config - Configuration for the receptionist agent.
297
+ * @returns A configured ReceptionistAgent instance.
298
+ */
299
+ export function createReceptionistAgent(config) {
300
+ return new ReceptionistAgent(config);
301
+ }
302
+ export default ReceptionistAgent;
303
+ //# sourceMappingURL=ReceptionistAgent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ReceptionistAgent.js","sourceRoot":"","sources":["../../src/prefabs/ReceptionistAgent.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AA2CtD,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC7B,QAAQ,CAAS;IACjB,WAAW,CAA2B;IACtC,WAAW,CAAqB;IAChC,cAAc,CAAU;IACxB,wBAAwB,CAA6D;IACrF,QAAQ,GAAgC,IAAI,GAAG,EAAE,CAAC;IAEnE;;;OAGG;IACH,YAAY,MAA0B;QACpC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,IAAI,cAAc,CAAC;QAChD,KAAK,CAAC;YACJ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,eAAe;YACtC,MAAM,EAAE,IAAI;YACZ,GAAG,MAAM,CAAC,YAAY;SACvB,CAAC,CAAC;QAEH,6DAA6D;QAC7D,iBAAiB,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAE1D,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,kDAAkD,CAAC;QACtF,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,KAAK,CAAC;QACrD,IAAI,CAAC,wBAAwB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAExD,8DAA8D;QAC9D,IAAI,CAAC,aAAa,CAAC;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,EAAE;SAChB,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC,CAAC;QAE1D,kDAAkD;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAoB;QACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAA4B,CAAC;YACpD,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACjE,CAAC;YACD,IAAI,OAAO,CAAC,CAAC,aAAa,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;IACH,CAAC;IAEO,WAAW;QACjB,cAAc;QACd,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE;YACnC,IAAI,EAAE,6HAA6H;SACpI,CAAC,CAAC;QAEH,OAAO;QACP,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC5B,IAAI,EAAE,kHAAkH;SACzH,CAAC,CAAC;QAEH,4DAA4D;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW;YAC9B,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,IAAI,CAAC,WAAW,GAAG;YAC9D,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAElB,eAAe;QACf,MAAM,YAAY,GAAG;YACnB,uCAAuC,OAAO,GAAG;YACjD,4DAA4D;YAC5D,6EAA6E;YAC7E,uFAAuF;YACvF,gFAAgF;YAChF,6GAA6G;YAC7G,iGAAiG;SAClG,CAAC;QACF,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,YAAY,CAAC,IAAI,CACf,uJAAuJ,CACxJ,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QAEjE,yCAAyC;QACzC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CACtC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,CAC9C,CAAC;QACF,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;QAEzE,oDAAoD;QACpD,IAAI,CAAC,aAAa,CAAC;;;;;;;;SAQd,CAAC,CAAC;IACT,CAAC;IAEO,sBAAsB,CAAC,KAAa;QAC1C,IAAI,CAAC,SAAS,CAAC;YACb,qBAAqB,EAAE,GAAG;YAC1B,oBAAoB,EAAE,IAAI;YAC1B,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5D,mEAAmE;QACnE,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,WAAW;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,MAAM;YAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,yEAAyE;IAEjE,UAAU,CAAC,OAAgC;QACjD,MAAM,MAAM,GAAI,OAAO,CAAC,SAAS,CAAY,IAAI,SAAS,CAAC;QAC3D,IAAI,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yEAAyE;IAEzE;;;;OAIG;IACgB,WAAW;QAC5B,4CAA4C;QAC5C,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,qBAAqB;YAC3B,WAAW,EAAE,8CAA8C;YAC3D,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,mBAAmB;qBACjC;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,yBAAyB;qBACvC;iBACF;aACF;YACD,OAAO,EAAE,CAAC,IAA6B,EAAE,EAAE;gBACzC,MAAM,IAAI,GAAI,IAAI,CAAC,MAAM,CAAY,IAAI,EAAE,CAAC;gBAC5C,MAAM,MAAM,GAAI,IAAI,CAAC,QAAQ,CAAY,IAAI,EAAE,CAAC;gBAChD,MAAM,MAAM,GAAG,IAAI,cAAc,CAC/B,cAAc,IAAI,0CAA0C,MAAM,GAAG,CACtE,CAAC;gBACF,MAAM,CAAC,UAAU,CAAC;oBAChB;wBACE,eAAe,EAAE;4BACf,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;yBAC9B;qBACF;iBACF,CAAC,CAAC;gBACH,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC,CAAC;QAEH,8DAA8D;QAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,mDAAmD;YAChE,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+BAA+B;wBAC5C,IAAI,EAAE,eAAe;qBACtB;iBACF;aACF;YACD,OAAO,EAAE,CAAC,IAA6B,EAAE,OAAgC,EAAE,EAAE;gBAC3E,MAAM,cAAc,GAAG,CAAE,IAAI,CAAC,YAAY,CAAY,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACrE,MAAM,UAAU,GAAI,OAAO,CAAC,aAAa,CAA6B,IAAI,EAAE,CAAC;gBAC7E,MAAM,UAAU,GAAI,UAAU,CAAC,aAAa,CAA6B,IAAI,EAAE,CAAC;gBAChF,MAAM,IAAI,GAAI,UAAU,CAAC,MAAM,CAAY,IAAI,YAAY,CAAC;gBAE5D,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;gBACrE,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,OAAO,IAAI,cAAc,CACvB,8BAA8B,cAAc,cAAc,CAC3D,CAAC;gBACJ,CAAC;gBAED,gEAAgE;gBAChE,iCAAiC;gBACjC,MAAM,MAAM,GAAG,IAAI,cAAc,CAC/B,4BAA4B,cAAc,2CAA2C,IAAI,GAAG,EAC5F,IAAI,CACL,CAAC;gBACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAClC,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC,CAAC;QAEH,+DAA+D;QAC/D,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC;gBACd,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EAAE,0FAA0F;gBACvG,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,YAAY,EAAE;4BACZ,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,2BAA2B;yBACzC;wBACD,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,uBAAuB;yBACrC;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,8DAA8D;yBAC5E;qBACF;oBACD,QAAQ,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,UAAU,CAAC;iBAClD;gBACD,OAAO,EAAE,KAAK,EAAE,IAA6B,EAAE,OAAgC,EAAE,EAAE;oBACjF,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAW,CAAC;oBACnD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAW,CAAC;oBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAW,CAAC;oBAE5C,IAAI,CAAC,WAAW,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAC1C,OAAO,IAAI,cAAc,CACvB,iFAAiF,CAClF,CAAC;oBACJ,CAAC;oBAED,MAAM,aAAa,GAA2B;wBAC5C,YAAY,EAAE,WAAW;wBACzB,OAAO;wBACP,QAAQ;wBACR,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;qBACxC,CAAC;oBAEF,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;oBACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBAErC,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;wBAClC,IAAI,CAAC;4BACH,MAAM,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;wBACrD,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;wBAC5D,CAAC;oBACH,CAAC;oBAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC/E,OAAO,IAAI,cAAc,CACvB,0CAA0C,WAAW,cAAc,OAAO,eAAe,QAAQ,IAAI,WAAW,EAAE,CACnH,CAAC;gBACJ,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,yEAAyE;IAEzE;;;;OAIG;IACM,SAAS,CAChB,QAAwC,EACxC,QAAiC;QAEjC,6EAA6E;IAC/E,CAAC;CACF;AAED,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAA0B;IAChE,OAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,eAAe,iBAAiB,CAAC"}
@@ -0,0 +1,148 @@
1
+ /**
2
+ * SurveyAgent - A prefab agent that conducts surveys with branching logic,
3
+ * scoring, and conditional question flow.
4
+ *
5
+ * Ported from the Python SDK `signalwire.prefabs.survey.SurveyAgent`. Keeps
6
+ * TS-specific enhancements (per-call session state, branching via
7
+ * `nextQuestion`, answer scoring via `points`) alongside the Python surface.
8
+ */
9
+ import { AgentBase } from '../AgentBase.js';
10
+ import type { AgentOptions } from '../types.js';
11
+ /** A single survey question consumed by {@link SurveyAgent}. */
12
+ export interface SurveyQuestion {
13
+ /** Unique question identifier. */
14
+ id: string;
15
+ /** The question text to ask the caller. */
16
+ text: string;
17
+ /** Question type determines validation and display. */
18
+ type: 'multiple_choice' | 'open_ended' | 'rating' | 'yes_no';
19
+ /** Options for multiple_choice questions. */
20
+ options?: string[];
21
+ /**
22
+ * For `rating` questions, the upper bound of the scale (1..scale).
23
+ * Defaults to 5 (matching the Python prefab) when unspecified.
24
+ */
25
+ scale?: number;
26
+ /**
27
+ * Whether the question requires an answer. Defaults to `true`.
28
+ * Mirrors the Python `required` flag on each question dict.
29
+ */
30
+ required?: boolean;
31
+ /**
32
+ * Next question ID after this one.
33
+ * - string: always go to that question
34
+ * - Record<string, string>: map from answer value to next question ID
35
+ * - undefined: proceed to next question in array order
36
+ */
37
+ nextQuestion?: string | Record<string, string>;
38
+ /**
39
+ * Points awarded for answers.
40
+ * - number: fixed points for any answer
41
+ * - Record<string, number>: points per specific answer value
42
+ */
43
+ points?: number | Record<string, number>;
44
+ }
45
+ /** Configuration for the {@link SurveyAgent}. */
46
+ export interface SurveyConfig {
47
+ /** Human-readable survey name, used in prompts and global data. */
48
+ surveyName: string;
49
+ /** Ordered list of survey questions. */
50
+ questions: SurveyQuestion[];
51
+ /** Opening message before the first question (matches Python `introduction`). */
52
+ introduction?: string;
53
+ /** Message after the survey is complete (matches Python `conclusion`). */
54
+ conclusion?: string;
55
+ /** Brand or company name the agent represents (matches Python `brand_name`). */
56
+ brandName?: string;
57
+ /** Maximum number of times to retry invalid answers. Defaults to 2. */
58
+ maxRetries?: number;
59
+ /** Agent display name (defaults to `"survey"`). */
60
+ name?: string;
61
+ /** HTTP route for this agent (defaults to `"/survey"`). */
62
+ route?: string;
63
+ /** Callback fired when the survey is finished. */
64
+ onComplete?: (responses: Record<string, unknown>, score: number) => void | Promise<void>;
65
+ /** Additional AgentBase options forwarded to super(). */
66
+ agentOptions?: Partial<AgentOptions>;
67
+ }
68
+ /**
69
+ * Prefab agent that conducts surveys with branching logic, answer scoring, and conditional question flow.
70
+ *
71
+ * Each survey question declares its response type (rating, yes/no, open text, etc.), an optional
72
+ * set of conditional follow-ups, and a scoring map. The agent walks the question tree, tallies a
73
+ * total score, and exposes the full response map at call end via `onSummary()`.
74
+ *
75
+ * @example Customer satisfaction survey
76
+ * ```ts
77
+ * import { SurveyAgent } from '@signalwire/sdk';
78
+ *
79
+ * const agent = new SurveyAgent({
80
+ * surveyName: 'CSAT',
81
+ * brandName: 'Acme Co',
82
+ * questions: [
83
+ * { id: 'q1', text: 'How satisfied were you with our service?', type: 'rating', scale: 5 },
84
+ * { id: 'q2', text: 'Would you recommend us to a friend?', type: 'yesno' },
85
+ * { id: 'q3', text: 'Anything else you want to share?', type: 'open' },
86
+ * ],
87
+ * });
88
+ *
89
+ * await agent.serve({ port: 3000 });
90
+ * ```
91
+ */
92
+ export declare class SurveyAgent extends AgentBase {
93
+ /** Human-readable survey name. */
94
+ surveyName: string;
95
+ /** The configured survey questions (public, matching Python). */
96
+ questions: SurveyQuestion[];
97
+ /** Brand/company name used in prompts. */
98
+ brandName: string;
99
+ /** Maximum number of times to retry invalid answers. */
100
+ maxRetries: number;
101
+ /** Opening message before the first question. */
102
+ introduction: string;
103
+ /** Closing message shown when the survey completes. */
104
+ conclusion: string;
105
+ private questionMap;
106
+ private onCompleteCallback?;
107
+ private sessions;
108
+ /**
109
+ * Create a SurveyAgent with the specified questions and callbacks.
110
+ * @param config - Configuration including questions, messages, and completion callback.
111
+ */
112
+ constructor(config: SurveyConfig);
113
+ private validateQuestions;
114
+ private setupSurveyAgent;
115
+ private getSession;
116
+ private resolveNextQuestion;
117
+ private calculatePoints;
118
+ /**
119
+ * Validate an answer against the question's type and constraints.
120
+ * Mirrors the Python `validate_response` tool body.
121
+ * @returns error message string if invalid, or `null` if valid.
122
+ */
123
+ private validateAnswer;
124
+ private normalizeAnswer;
125
+ /**
126
+ * Register SWAIG tools:
127
+ * - Python-parity tools: `validate_response`, `log_response`
128
+ * - TS-specific session tools: `answer_question`, `get_current_question`, `get_survey_progress`
129
+ */
130
+ protected defineTools(): void;
131
+ /**
132
+ * Process the survey results summary returned at the end of a call.
133
+ * Mirrors Python `on_summary`: structured (dict-like) summaries are logged
134
+ * as JSON; unstructured summaries are logged verbatim.
135
+ *
136
+ * The parameter type widens the base `AgentBase.onSummary` signature to
137
+ * accept string payloads as well, matching Python's `isinstance(summary, dict)`
138
+ * branch even though the current framework only surfaces object summaries.
139
+ */
140
+ onSummary(summary: Record<string, unknown> | string | null, _rawData: Record<string, unknown>): void | Promise<void>;
141
+ }
142
+ /**
143
+ * Factory function that creates and returns a new SurveyAgent.
144
+ * @param config - Configuration for the survey agent.
145
+ * @returns A configured SurveyAgent instance.
146
+ */
147
+ export declare function createSurveyAgent(config: SurveyConfig): SurveyAgent;
148
+ export default SurveyAgent;