@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,632 @@
1
+ # Appendix A: Complete Code and Management Script
2
+
3
+ This appendix has the complete `fred.ts`, the complete management script, the project files, and a quick start that puts them together. The code here is the same as the files in `tutorial/fred/`.
4
+
5
+ ## Table of Contents
6
+
7
+ 1. [Complete fred.ts](#complete-fredts)
8
+ 2. [Management Script (fred.sh)](#management-script-fredsh)
9
+ 3. [Project Files](#project-files)
10
+ 4. [Quick Start Guide](#quick-start-guide)
11
+ 5. [Directory Structure](#directory-structure)
12
+ 6. [Deployment Tips](#deployment-tips)
13
+
14
+ ---
15
+
16
+ ## Complete fred.ts
17
+
18
+ This is the agent, with the Wikipedia skill, the fun fact function, and the code that serves it. The `// region:` comments mark the parts the lessons quote, and don't affect the code.
19
+
20
+ <!-- include: tutorial/fred/fred.ts#fred -->
21
+ ```typescript
22
+ /**
23
+ * Fred: a Wikipedia knowledge bot
24
+ *
25
+ * An agent that searches Wikipedia and shares facts about Wikipedia itself,
26
+ * with a friendly, curious persona.
27
+ *
28
+ * Run: npx tsx fred.ts
29
+ */
30
+
31
+ // region: imports
32
+ import { pathToFileURL } from 'node:url';
33
+
34
+ import { AgentBase, FunctionResult, WikipediaSearchSkill } from '@signalwire/sdk';
35
+ // endregion: imports
36
+
37
+ // region: facts
38
+ /** Facts about Wikipedia, by category, for the share_fun_fact tool. */
39
+ const FACTS = {
40
+ statistics: [
41
+ 'Wikipedia has over 6 million articles in English alone!',
42
+ 'Wikipedia is available in more than 300 languages!',
43
+ 'Wikipedia receives over 18 billion page views per month!',
44
+ 'There are over 100,000 active Wikipedia contributors!',
45
+ ],
46
+ history: [
47
+ 'Wikipedia was launched on January 15, 2001!',
48
+ 'Wikipedia started as a side project of Nupedia, an encyclopedia written by experts!',
49
+ "Wikipedia's name comes from 'wiki' (Hawaiian for 'quick') and 'encyclopedia'!",
50
+ 'Jimmy Wales and Larry Sanger founded Wikipedia!',
51
+ ],
52
+ records: [
53
+ "English Wikipedia's one billionth edit was made on January 13, 2021!",
54
+ 'Steven Pruitt has made more edits to English Wikipedia than anyone else, over three million!',
55
+ 'Wikipedia is one of the most visited websites in the world!',
56
+ ],
57
+ };
58
+ // endregion: facts
59
+
60
+ /** Fred, a Wikipedia assistant with a friendly persona. */
61
+ export class FredTheWikiBot extends AgentBase {
62
+ constructor() {
63
+ super({ name: 'Fred', route: '/fred' });
64
+
65
+ // region: personality
66
+ // Set up Fred's personality with the Prompt Object Model
67
+ this.promptAddSection('Personality', {
68
+ body:
69
+ 'You are Fred, a friendly and knowledgeable assistant who loves learning and ' +
70
+ "sharing information from Wikipedia. You're enthusiastic about facts and always " +
71
+ 'eager to help people discover new things.',
72
+ });
73
+ // endregion: personality
74
+
75
+ // region: goal
76
+ this.promptAddSection('Goal', {
77
+ body:
78
+ 'Help users find reliable factual information by searching Wikipedia. ' +
79
+ 'Make learning fun and engaging.',
80
+ });
81
+
82
+ this.promptAddSection('Instructions', {
83
+ bullets: [
84
+ 'Introduce yourself as Fred when greeting users',
85
+ 'Use the search_wiki function whenever users ask about factual topics',
86
+ 'Be enthusiastic about sharing knowledge',
87
+ 'Search before you say Wikipedia has nothing on a topic, even one that sounds made up',
88
+ "If Wikipedia doesn't have information, suggest alternative search terms",
89
+ 'Make learning conversational and enjoyable',
90
+ 'Add interesting context or follow-up questions to engage users',
91
+ ],
92
+ });
93
+ // endregion: goal
94
+
95
+ // region: voice
96
+ // Configure Fred's voice
97
+ this.addLanguage({
98
+ name: 'English',
99
+ code: 'en-US',
100
+ voice: 'rime.bolt', // A friendly, energetic voice for Fred
101
+ speechFillers: [
102
+ 'Hmm, let me think...',
103
+ "Oh, that's interesting...",
104
+ 'Great question!',
105
+ 'Let me see...',
106
+ ],
107
+ });
108
+ // endregion: voice
109
+
110
+ // region: hints
111
+ // Add hints for better speech recognition
112
+ this.addHints([
113
+ 'Wikipedia',
114
+ 'Fred',
115
+ 'tell me about',
116
+ 'what is',
117
+ 'who is',
118
+ 'search for',
119
+ 'look up',
120
+ ]);
121
+ // endregion: hints
122
+
123
+ // region: params
124
+ // Set conversation parameters
125
+ this.setParams({
126
+ ai_model: 'gpt-4.1-nano', // The model that runs the conversation
127
+ wait_for_user: true, // The caller speaks first
128
+ end_of_speech_timeout: 1000, // Milliseconds of silence that end the caller's turn
129
+ ai_volume: 7, // Voice volume adjustment (-50 to 50, default 0)
130
+ local_tz: 'America/New_York', // Time zone for time-related functions
131
+ });
132
+ // endregion: params
133
+
134
+ // region: global-data
135
+ // Add some context about Fred
136
+ this.setGlobalData({
137
+ assistant_name: 'Fred',
138
+ specialty: 'Wikipedia knowledge',
139
+ personality_traits: ['friendly', 'curious', 'enthusiastic', 'helpful'],
140
+ });
141
+ // endregion: global-data
142
+ }
143
+
144
+ // region: fun-fact
145
+ /** Register Fred's own tool. The SDK calls this once, the first time it needs the tools. */
146
+ protected override defineTools(): void {
147
+ this.defineTool({
148
+ name: 'share_fun_fact',
149
+ description: 'Share an interesting fact about Wikipedia itself',
150
+ parameters: {
151
+ category: {
152
+ type: 'string',
153
+ description: 'Type of fact to share',
154
+ enum: ['statistics', 'history', 'records', 'random'],
155
+ },
156
+ },
157
+ handler: (args) => {
158
+ // The model may leave the category out, so default to random
159
+ const category = args.category ?? 'random';
160
+
161
+ // The enum guides the model but doesn't bind it: random, or any
162
+ // category Fred doesn't have, draws from every fact
163
+ const known = category !== 'random' && Object.hasOwn(FACTS, category);
164
+ const factList = known ? FACTS[category] : Object.values(FACTS).flat();
165
+ const fact = factList[Math.floor(Math.random() * factList.length)];
166
+
167
+ // Say what kind of fact it is, so the model can introduce it
168
+ if (known) {
169
+ return new FunctionResult(`Here's a ${category} fact about Wikipedia: ${fact}`);
170
+ }
171
+ return new FunctionResult(`Here's a fun Wikipedia fact: ${fact}`);
172
+ },
173
+ });
174
+ }
175
+ // endregion: fun-fact
176
+ }
177
+
178
+ // region: create
179
+ /** Build Fred, then add the Wikipedia search skill, which loads asynchronously. */
180
+ export async function createFred(): Promise<FredTheWikiBot> {
181
+ const fred = new FredTheWikiBot();
182
+
183
+ // Add the Wikipedia search skill with custom configuration
184
+ await fred.addSkill(
185
+ new WikipediaSearchSkill({
186
+ num_results: 2, // Get up to 2 articles for broader coverage
187
+ no_results_message:
188
+ "Oh, I couldn't find anything about '{query}' on Wikipedia. " +
189
+ 'Maybe try different keywords or let me know if you meant something else!',
190
+ swaig_fields: {
191
+ fillers: {
192
+ 'en-US': [
193
+ 'Let me look that up on Wikipedia for you...',
194
+ 'Searching Wikipedia for that information...',
195
+ 'One moment, checking Wikipedia...',
196
+ 'Let me find that in the encyclopedia...',
197
+ ],
198
+ },
199
+ },
200
+ }),
201
+ );
202
+
203
+ return fred;
204
+ }
205
+ // endregion: create
206
+
207
+ // region: main
208
+ // swaig-test imports this file, and finds Fred through this export
209
+ export const fred = await createFred();
210
+
211
+ // Print the banner and start the server only when this file is the program
212
+ // that runs, not when another program imports it
213
+ if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
214
+ const [username, password] = fred.getBasicAuthCredentials();
215
+
216
+ console.log('='.repeat(60));
217
+ console.log('Fred: a Wikipedia knowledge bot');
218
+ console.log('='.repeat(60));
219
+ console.log();
220
+ console.log('Fred searches Wikipedia and shares facts about Wikipedia itself.');
221
+ console.log();
222
+ console.log('Questions to try:');
223
+ console.log(' - Tell me about Albert Einstein');
224
+ console.log(' - What is quantum physics?');
225
+ console.log(' - Who was Marie Curie?');
226
+ console.log(' - Search for information about the solar system');
227
+ console.log(' - Can you share a fun fact?');
228
+ console.log();
229
+ console.log(`Fred is available at: http://localhost:${fred.port}/fred`);
230
+ console.log(`Basic Auth: ${username}:${password}`);
231
+ console.log();
232
+ console.log('Starting Fred. Press Ctrl+C to stop.');
233
+ console.log('='.repeat(60));
234
+
235
+ await fred.run();
236
+ }
237
+ // endregion: main
238
+ ```
239
+
240
+ ## Management Script (fred.sh)
241
+
242
+ The complete script starts Fred in the background, stops it, reports its status, and follows its log. `stop` waits up to five seconds for Fred to exit, then forces it.
243
+
244
+ <!-- copy of: tutorial/fred/fred.sh -->
245
+ ```bash
246
+ #!/bin/bash
247
+ # Start, stop and check Fred, the Wikipedia bot
248
+
249
+ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
250
+ PID_FILE="fred.pid"
251
+ LOG_FILE="fred.log"
252
+ FRED_SCRIPT="$SCRIPT_DIR/fred.ts"
253
+
254
+ # Colors for output
255
+ GREEN='\033[0;32m'
256
+ RED='\033[0;31m'
257
+ YELLOW='\033[1;33m'
258
+ NC='\033[0m' # No Color
259
+
260
+ # Function to check if Fred is running
261
+ is_running() {
262
+ if [ -f "$PID_FILE" ]; then
263
+ PID=$(cat "$PID_FILE")
264
+ if ps -p "$PID" > /dev/null 2>&1; then
265
+ return 0
266
+ else
267
+ # PID file exists but process is dead
268
+ rm -f "$PID_FILE"
269
+ return 1
270
+ fi
271
+ fi
272
+ return 1
273
+ }
274
+
275
+ # Start Fred
276
+ start_fred() {
277
+ if is_running; then
278
+ echo -e "${YELLOW}Fred is already running with PID: $(cat "$PID_FILE")${NC}"
279
+ return 1
280
+ fi
281
+
282
+ echo -e "${GREEN}Starting Fred...${NC}"
283
+
284
+ # Check that fred.ts exists
285
+ if [ ! -f "$FRED_SCRIPT" ]; then
286
+ echo -e "${RED}Error: $FRED_SCRIPT not found!${NC}"
287
+ return 1
288
+ fi
289
+
290
+ # Start Fred in the background, with its output in the log file. node --import tsx
291
+ # runs fred.ts in one process, so the PID saved here is Fred's own.
292
+ nohup node --import tsx "$FRED_SCRIPT" > "$LOG_FILE" 2>&1 &
293
+ PID=$!
294
+
295
+ # Save PID to file
296
+ echo $PID > "$PID_FILE"
297
+
298
+ # Wait a moment to check if it started successfully
299
+ sleep 2
300
+
301
+ if is_running; then
302
+ echo -e "${GREEN}Fred started${NC}"
303
+ echo -e " PID: $PID"
304
+ echo -e " Log: $LOG_FILE"
305
+ echo -e " URL: http://localhost:${PORT:-3000}/fred"
306
+
307
+ # Try to extract auth credentials from log
308
+ if [ -f "$LOG_FILE" ]; then
309
+ AUTH=$(grep "Basic Auth:" "$LOG_FILE" | head -1)
310
+ if [ ! -z "$AUTH" ]; then
311
+ echo -e " $AUTH"
312
+ fi
313
+ fi
314
+ else
315
+ echo -e "${RED}Fred failed to start${NC}"
316
+ echo -e " Check $LOG_FILE for errors"
317
+ return 1
318
+ fi
319
+ }
320
+
321
+ # Stop Fred
322
+ stop_fred() {
323
+ if ! is_running; then
324
+ echo -e "${YELLOW}Fred is not running${NC}"
325
+ return 1
326
+ fi
327
+
328
+ PID=$(cat "$PID_FILE")
329
+ echo -e "${GREEN}Stopping Fred (PID: $PID)...${NC}"
330
+
331
+ # Send SIGTERM for graceful shutdown
332
+ kill -TERM "$PID" 2>/dev/null
333
+
334
+ # Wait up to 5 seconds for process to stop
335
+ for i in {1..5}; do
336
+ if ! ps -p "$PID" > /dev/null 2>&1; then
337
+ break
338
+ fi
339
+ sleep 1
340
+ done
341
+
342
+ # If still running, force kill
343
+ if ps -p "$PID" > /dev/null 2>&1; then
344
+ echo -e "${YELLOW}Fred didn't stop gracefully, forcing shutdown...${NC}"
345
+ kill -9 "$PID" 2>/dev/null
346
+ fi
347
+
348
+ # Clean up PID file
349
+ rm -f "$PID_FILE"
350
+
351
+ echo -e "${GREEN}Fred stopped${NC}"
352
+ }
353
+
354
+ # Check Fred's status
355
+ status_fred() {
356
+ if is_running; then
357
+ PID=$(cat "$PID_FILE")
358
+ echo -e "${GREEN}Fred is running${NC}"
359
+ echo -e " PID: $PID"
360
+ echo -e " URL: http://localhost:${PORT:-3000}/fred"
361
+
362
+ # Show process info
363
+ ps -p "$PID" -o pid,vsz,rss,comm
364
+
365
+ # Show last few log lines
366
+ if [ -f "$LOG_FILE" ]; then
367
+ echo -e "\n${YELLOW}Recent log entries:${NC}"
368
+ tail -5 "$LOG_FILE"
369
+ fi
370
+ else
371
+ echo -e "${RED}Fred is not running${NC}"
372
+ fi
373
+ }
374
+
375
+ # Show logs
376
+ show_logs() {
377
+ if [ -f "$LOG_FILE" ]; then
378
+ echo -e "${YELLOW}Fred's logs (press Ctrl+C to exit):${NC}"
379
+ tail -f "$LOG_FILE"
380
+ else
381
+ echo -e "${RED}No log file found${NC}"
382
+ fi
383
+ }
384
+
385
+ # Main script logic
386
+ case "$1" in
387
+ start)
388
+ start_fred
389
+ ;;
390
+ stop)
391
+ stop_fred
392
+ ;;
393
+ restart)
394
+ stop_fred
395
+ sleep 1
396
+ start_fred
397
+ ;;
398
+ status)
399
+ status_fred
400
+ ;;
401
+ logs)
402
+ show_logs
403
+ ;;
404
+ *)
405
+ echo "Fred manager"
406
+ echo ""
407
+ echo "Usage: $0 {start|stop|restart|status|logs}"
408
+ echo ""
409
+ echo "Commands:"
410
+ echo " start - Start Fred in the background"
411
+ echo " stop - Stop Fred gracefully"
412
+ echo " restart - Restart Fred"
413
+ echo " status - Check if Fred is running"
414
+ echo " logs - Follow Fred's logs"
415
+ echo ""
416
+ echo "Example:"
417
+ echo " $0 start # Start Fred"
418
+ echo " $0 status # Check status"
419
+ echo " $0 stop # Stop Fred"
420
+ ;;
421
+ esac
422
+ ```
423
+
424
+ The script keeps `fred.pid` and `fred.log` in the directory you run it from, so run it from the project directory. It runs Fred with `node --import tsx`, for the reason [Lesson 6](06-running-testing.md#step-5-create-management-script) gives.
425
+
426
+ ## Project Files
427
+
428
+ Two files describe the project. `package.json` lists the dependencies and the scripts:
429
+
430
+ <!-- copy of: tutorial/fred/package.json -->
431
+ ```json
432
+ {
433
+ "name": "fred-bot",
434
+ "version": "1.0.0",
435
+ "private": true,
436
+ "description": "Fred, a voice agent that answers questions from Wikipedia",
437
+ "type": "module",
438
+ "scripts": {
439
+ "start": "tsx fred.ts",
440
+ "build": "tsc",
441
+ "typecheck": "tsc --noEmit"
442
+ },
443
+ "engines": {
444
+ "node": ">=22.18.0"
445
+ },
446
+ "dependencies": {
447
+ "@signalwire/sdk": "^3.5.0"
448
+ },
449
+ "devDependencies": {
450
+ "@types/node": "^22.20.4",
451
+ "tsx": "^4.23.15",
452
+ "typescript": "^7.0.2"
453
+ }
454
+ }
455
+ ```
456
+
457
+ `tsconfig.json` holds the TypeScript settings that `npm run typecheck` and `npm run build` use:
458
+
459
+ <!-- copy of: tutorial/fred/tsconfig.json -->
460
+ ```json
461
+ {
462
+ "compilerOptions": {
463
+ "target": "ES2022",
464
+ "module": "NodeNext",
465
+ "moduleResolution": "NodeNext",
466
+ "strict": true,
467
+ "skipLibCheck": true,
468
+ "types": ["node"],
469
+ "outDir": "dist"
470
+ },
471
+ "files": ["fred.ts"]
472
+ }
473
+ ```
474
+
475
+ [Lesson 2](02-setup.md#installing-the-sdk) explains both.
476
+
477
+ ## Quick Start Guide
478
+
479
+ These steps take you from an empty directory to a running Fred.
480
+
481
+ ### 1. Setup
482
+
483
+ Create the project and install the dependencies:
484
+
485
+ ```bash
486
+ # Create project directory
487
+ mkdir fred-bot
488
+ cd fred-bot
489
+
490
+ # Create the project, as ES modules
491
+ npm init -y
492
+ npm pkg set type=module
493
+
494
+ # Install dependencies
495
+ npm install @signalwire/sdk
496
+ npm install --save-dev tsx typescript @types/node
497
+ ```
498
+
499
+ ### 2. Create Files
500
+
501
+ Save the code in this appendix as four files:
502
+
503
+ - `fred.ts`: the agent
504
+ - `fred.sh`: the management script
505
+ - `package.json`: the project, replacing the one `npm init` wrote
506
+ - `tsconfig.json`: the TypeScript settings
507
+
508
+ Then make the script executable, and check the types:
509
+
510
+ ```bash
511
+ chmod +x fred.sh
512
+ npm run typecheck
513
+ ```
514
+
515
+ ### 3. Run Fred
516
+
517
+ Run Fred directly, or with the management script:
518
+
519
+ ```bash
520
+ # Direct method
521
+ npx tsx fred.ts
522
+
523
+ # Or using management script
524
+ ./fred.sh start
525
+ ./fred.sh status
526
+ ./fred.sh stop
527
+ ```
528
+
529
+ ### 4. Test Fred
530
+
531
+ Take the credentials from Fred's output, then test it:
532
+
533
+ ```bash
534
+ # Test SWML endpoint
535
+ curl -u username:password http://localhost:3000/fred
536
+
537
+ # Test Wikipedia search
538
+ npx swaig-test fred.ts --exec search_wiki --query "Python programming"
539
+
540
+ # Test fun fact
541
+ npx swaig-test fred.ts --exec share_fun_fact --category history
542
+ ```
543
+
544
+ To call a function over HTTP instead, use the URL from Fred's SWML, which carries the function's token. [Lesson 6, Step 3](06-running-testing.md#step-3-test-wikipedia-search) shows how.
545
+
546
+ ### 5. Environment Variables (Optional)
547
+
548
+ Fixed credentials stay the same across restarts:
549
+
550
+ ```bash
551
+ # Set fixed credentials
552
+ export SWML_BASIC_AUTH_USER="fred"
553
+ export SWML_BASIC_AUTH_PASSWORD="a-long-random-password"
554
+
555
+ # Run Fred with fixed auth
556
+ npx tsx fred.ts
557
+ ```
558
+
559
+ ## Directory Structure
560
+
561
+ A complete Fred project looks like this. `fred.pid` and `fred.log` appear when the management script runs Fred, and `dist/` when you run `npm run build`:
562
+
563
+ ```text
564
+ fred-bot/
565
+ ├── fred.ts # The agent
566
+ ├── fred.sh # Management script
567
+ ├── package.json # The project and its dependencies
568
+ ├── package-lock.json # The exact versions npm installed
569
+ ├── tsconfig.json # TypeScript settings
570
+ ├── node_modules/ # The installed packages
571
+ ├── dist/fred.js # Compiled JavaScript (created by npm run build)
572
+ ├── fred.pid # Process ID (created by fred.sh)
573
+ └── fred.log # Log file (created by fred.sh)
574
+ ```
575
+
576
+ ## Deployment Tips
577
+
578
+ A production deployment needs more than a running process.
579
+
580
+ ### For Production
581
+
582
+ Five practices cover most deployments:
583
+
584
+ 1. **Set secrets in environment variables**: the credentials, `SIGNALWIRE_SIGNING_KEY` and `SIGNALWIRE_SWAIG_SECRET` ([Lesson 6](06-running-testing.md#production-considerations) explains each)
585
+ 2. **Serve Fred over HTTPS**, behind a reverse proxy or with the SDK's TLS support
586
+ 3. **Run Fred under a process manager**, such as systemd or Docker, so it restarts after a crash or a reboot
587
+ 4. **Rotate the logs**
588
+ 5. **Monitor health and uptime**, for example with the `/fred/health` endpoint
589
+
590
+ ### Example systemd Service
591
+
592
+ In production, run the compiled JavaScript rather than `tsx`. Build it once in the project directory:
593
+
594
+ ```bash
595
+ npm run build
596
+ ```
597
+
598
+ This unit runs the compiled Fred from `/opt/fred-bot`, and restarts it if it stops. Node.js finds the SDK in `/opt/fred-bot/node_modules`:
599
+
600
+ ```ini
601
+ [Unit]
602
+ Description=Fred Wikipedia Bot
603
+ After=network.target
604
+
605
+ [Service]
606
+ Type=simple
607
+ User=fredbot
608
+ WorkingDirectory=/opt/fred-bot
609
+ ExecStart=/usr/bin/node /opt/fred-bot/dist/fred.js
610
+ Restart=always
611
+ EnvironmentFile=/opt/fred-bot/fred.env
612
+
613
+ [Install]
614
+ WantedBy=multi-user.target
615
+ ```
616
+
617
+ Set `ExecStart` to the path `which node` prints, if Node.js isn't in `/usr/bin`. Keep the secrets in `/opt/fred-bot/fred.env`, readable only by the `fredbot` user, rather than in the unit file:
618
+
619
+ ```bash
620
+ SWML_BASIC_AUTH_USER=fred
621
+ SWML_BASIC_AUTH_PASSWORD=a-long-random-password
622
+ SIGNALWIRE_SIGNING_KEY=your-signing-key
623
+ SIGNALWIRE_SWAIG_SECRET=another-long-random-string
624
+ ```
625
+
626
+ ## Next Steps
627
+
628
+ To run Fred in a container, continue with [Appendix B: Docker Deployment](appendix-docker-deployment.md).
629
+
630
+ ---
631
+
632
+ [Previous: Running and Testing](06-running-testing.md) | [Overview](README.md) | [Next: Docker Deployment](appendix-docker-deployment.md)