@signalwire/sdk 2.0.5 → 3.6.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 (659) hide show
  1. package/CHANGELOG.md +821 -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 +510 -126
  6. package/dist/AgentBase.js +1581 -455
  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 +186 -45
  21. package/dist/DataMap.js +210 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +309 -83
  24. package/dist/FunctionResult.js +483 -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 +169 -59
  58. package/dist/SWMLService.js +456 -129
  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/SemanticGate.d.ts +183 -0
  67. package/dist/SemanticGate.js +533 -0
  68. package/dist/SemanticGate.js.map +1 -0
  69. package/dist/ServerlessAdapter.d.ts +156 -7
  70. package/dist/ServerlessAdapter.js +399 -42
  71. package/dist/ServerlessAdapter.js.map +1 -1
  72. package/dist/SessionManager.d.ts +11 -2
  73. package/dist/SessionManager.js +50 -18
  74. package/dist/SessionManager.js.map +1 -1
  75. package/dist/SslConfig.d.ts +2 -1
  76. package/dist/SslConfig.js +4 -1
  77. package/dist/SslConfig.js.map +1 -1
  78. package/dist/SwaigActions.generated.d.ts +23 -0
  79. package/dist/SwaigActions.generated.js +8 -0
  80. package/dist/SwaigActions.generated.js.map +1 -0
  81. package/dist/SwaigContracts.d.ts +15 -0
  82. package/dist/SwaigContracts.generated.d.ts +264 -0
  83. package/dist/SwaigContracts.generated.js +12 -0
  84. package/dist/SwaigContracts.generated.js.map +1 -0
  85. package/dist/SwaigContracts.js +2 -0
  86. package/dist/SwaigContracts.js.map +1 -0
  87. package/dist/SwaigFunction.d.ts +139 -7
  88. package/dist/SwaigFunction.js +170 -22
  89. package/dist/SwaigFunction.js.map +1 -1
  90. package/dist/SwmlBuilder.d.ts +68 -19
  91. package/dist/SwmlBuilder.js +74 -38
  92. package/dist/SwmlBuilder.js.map +1 -1
  93. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  94. package/dist/SwmlVerbMethods.generated.js +1 -1
  95. package/dist/TypeInference.d.ts +39 -3
  96. package/dist/TypeInference.js +256 -16
  97. package/dist/TypeInference.js.map +1 -1
  98. package/dist/WebService.d.ts +79 -11
  99. package/dist/WebService.js +320 -109
  100. package/dist/WebService.js.map +1 -1
  101. package/dist/WebhookMiddleware.d.ts +119 -0
  102. package/dist/WebhookMiddleware.js +271 -0
  103. package/dist/WebhookMiddleware.js.map +1 -0
  104. package/dist/WebhookValidator.d.ts +92 -0
  105. package/dist/WebhookValidator.js +409 -0
  106. package/dist/WebhookValidator.js.map +1 -0
  107. package/dist/agents/BedrockAgent.d.ts +162 -0
  108. package/dist/agents/BedrockAgent.js +323 -0
  109. package/dist/agents/BedrockAgent.js.map +1 -0
  110. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  111. package/dist/ai-chat/AIChatClient.js +535 -0
  112. package/dist/ai-chat/AIChatClient.js.map +1 -0
  113. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  114. package/dist/ai-chat/ChatGateway.js +747 -0
  115. package/dist/ai-chat/ChatGateway.js.map +1 -0
  116. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  117. package/dist/ai-chat/HandoffRouter.js +518 -0
  118. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  119. package/dist/ai-chat/index.d.ts +12 -0
  120. package/dist/ai-chat/index.js +10 -0
  121. package/dist/ai-chat/index.js.map +1 -0
  122. package/dist/capabilities.d.ts +64 -0
  123. package/dist/capabilities.js +95 -0
  124. package/dist/capabilities.js.map +1 -0
  125. package/dist/cli/agent-loader.d.ts +32 -6
  126. package/dist/cli/agent-loader.js +92 -33
  127. package/dist/cli/agent-loader.js.map +1 -1
  128. package/dist/cli/datamap-exec.d.ts +175 -0
  129. package/dist/cli/datamap-exec.js +1284 -0
  130. package/dist/cli/datamap-exec.js.map +1 -0
  131. package/dist/cli/function-args.d.ts +40 -0
  132. package/dist/cli/function-args.js +146 -0
  133. package/dist/cli/function-args.js.map +1 -0
  134. package/dist/cli/simulation.d.ts +99 -0
  135. package/dist/cli/simulation.js +490 -0
  136. package/dist/cli/simulation.js.map +1 -0
  137. package/dist/cli/swaig-test.d.ts +12 -25
  138. package/dist/cli/swaig-test.js +935 -371
  139. package/dist/cli/swaig-test.js.map +1 -1
  140. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  141. package/dist/cli/tsdocs/agentsNote.js +92 -0
  142. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  143. package/dist/cli/tsdocs/api-index.json +1 -0
  144. package/dist/cli/tsdocs/api.d.ts +91 -0
  145. package/dist/cli/tsdocs/api.js +372 -0
  146. package/dist/cli/tsdocs/api.js.map +1 -0
  147. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  148. package/dist/cli/tsdocs/apiTypes.js +7 -0
  149. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  150. package/dist/cli/tsdocs/bin.d.ts +6 -0
  151. package/dist/cli/tsdocs/bin.js +23 -0
  152. package/dist/cli/tsdocs/bin.js.map +1 -0
  153. package/dist/cli/tsdocs/files.d.ts +108 -0
  154. package/dist/cli/tsdocs/files.js +287 -0
  155. package/dist/cli/tsdocs/files.js.map +1 -0
  156. package/dist/cli/tsdocs/index.d.ts +28 -0
  157. package/dist/cli/tsdocs/index.js +307 -0
  158. package/dist/cli/tsdocs/index.js.map +1 -0
  159. package/dist/cli/tsdocs/live.d.ts +41 -0
  160. package/dist/cli/tsdocs/live.js +202 -0
  161. package/dist/cli/tsdocs/live.js.map +1 -0
  162. package/dist/cli/tsdocs/locate.d.ts +51 -0
  163. package/dist/cli/tsdocs/locate.js +75 -0
  164. package/dist/cli/tsdocs/locate.js.map +1 -0
  165. package/dist/cli/tsdocs/render.d.ts +75 -0
  166. package/dist/cli/tsdocs/render.js +323 -0
  167. package/dist/cli/tsdocs/render.js.map +1 -0
  168. package/dist/cli/tsdocs/topics.d.ts +43 -0
  169. package/dist/cli/tsdocs/topics.js +920 -0
  170. package/dist/cli/tsdocs/topics.js.map +1 -0
  171. package/dist/index.d.ts +49 -68
  172. package/dist/index.js +45 -73
  173. package/dist/index.js.map +1 -1
  174. package/dist/livewire/index.d.ts +229 -155
  175. package/dist/livewire/index.js +298 -195
  176. package/dist/livewire/index.js.map +1 -1
  177. package/dist/llms.txt +65 -0
  178. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  179. package/dist/prefabs/CallSessionStore.js +72 -0
  180. package/dist/prefabs/CallSessionStore.js.map +1 -0
  181. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  182. package/dist/prefabs/ConciergeAgent.js +36 -31
  183. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  184. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  185. package/dist/prefabs/FAQBotAgent.js +113 -47
  186. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  187. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  188. package/dist/prefabs/InfoGathererAgent.js +67 -58
  189. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  190. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  191. package/dist/prefabs/ReceptionistAgent.js +39 -31
  192. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  193. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  194. package/dist/prefabs/SurveyAgent.js +84 -68
  195. package/dist/prefabs/SurveyAgent.js.map +1 -1
  196. package/dist/relay/Action.d.ts +44 -21
  197. package/dist/relay/Action.js +75 -17
  198. package/dist/relay/Action.js.map +1 -1
  199. package/dist/relay/Call.d.ts +312 -47
  200. package/dist/relay/Call.js +369 -18
  201. package/dist/relay/Call.js.map +1 -1
  202. package/dist/relay/Deferred.js.map +1 -1
  203. package/dist/relay/Message.d.ts +26 -5
  204. package/dist/relay/Message.js +36 -6
  205. package/dist/relay/Message.js.map +1 -1
  206. package/dist/relay/RelayClient.d.ts +44 -17
  207. package/dist/relay/RelayClient.js +175 -65
  208. package/dist/relay/RelayClient.js.map +1 -1
  209. package/dist/relay/RelayError.d.ts +14 -0
  210. package/dist/relay/RelayError.js +15 -0
  211. package/dist/relay/RelayError.js.map +1 -1
  212. package/dist/relay/RelayEvent.d.ts +96 -65
  213. package/dist/relay/RelayEvent.js +85 -56
  214. package/dist/relay/RelayEvent.js.map +1 -1
  215. package/dist/relay/closedSets.d.ts +111 -0
  216. package/dist/relay/closedSets.js +83 -0
  217. package/dist/relay/closedSets.js.map +1 -0
  218. package/dist/relay/index.d.ts +3 -1
  219. package/dist/relay/index.js +1 -0
  220. package/dist/relay/index.js.map +1 -1
  221. package/dist/relay/normalize.js.map +1 -1
  222. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  223. package/dist/relay/protocol.types.generated.js +8 -0
  224. package/dist/relay/protocol.types.generated.js.map +1 -0
  225. package/dist/relay/types.d.ts +73 -42
  226. package/dist/rest/HttpClient.d.ts +36 -8
  227. package/dist/rest/HttpClient.js +233 -40
  228. package/dist/rest/HttpClient.js.map +1 -1
  229. package/dist/rest/RequestOptions.d.ts +110 -0
  230. package/dist/rest/RequestOptions.js +113 -0
  231. package/dist/rest/RequestOptions.js.map +1 -0
  232. package/dist/rest/RestError.d.ts +52 -6
  233. package/dist/rest/RestError.js +89 -5
  234. package/dist/rest/RestError.js.map +1 -1
  235. package/dist/rest/base/CrudResource.d.ts +16 -26
  236. package/dist/rest/base/CrudResource.js +19 -33
  237. package/dist/rest/base/CrudResource.js.map +1 -1
  238. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  239. package/dist/rest/base/CrudWithAddresses.js +2 -2
  240. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  241. package/dist/rest/base/FabricResource.d.ts +15 -0
  242. package/dist/rest/base/FabricResource.js +16 -0
  243. package/dist/rest/base/FabricResource.js.map +1 -0
  244. package/dist/rest/base/ReadResource.d.ts +62 -0
  245. package/dist/rest/base/ReadResource.js +69 -0
  246. package/dist/rest/base/ReadResource.js.map +1 -0
  247. package/dist/rest/callHandler.d.ts +5 -2
  248. package/dist/rest/callHandler.js +4 -1
  249. package/dist/rest/callHandler.js.map +1 -1
  250. package/dist/rest/index.d.ts +18 -77
  251. package/dist/rest/index.js +47 -120
  252. package/dist/rest/index.js.map +1 -1
  253. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  254. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  255. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  256. package/dist/rest/namespaces/addresses.d.ts +3 -42
  257. package/dist/rest/namespaces/addresses.js +3 -50
  258. package/dist/rest/namespaces/addresses.js.map +1 -1
  259. package/dist/rest/namespaces/calling.d.ts +6 -378
  260. package/dist/rest/namespaces/calling.js +6 -473
  261. package/dist/rest/namespaces/calling.js.map +1 -1
  262. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  263. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  264. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  265. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  266. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  267. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  268. package/dist/rest/namespaces/chat.d.ts +4 -18
  269. package/dist/rest/namespaces/chat.js +4 -21
  270. package/dist/rest/namespaces/chat.js.map +1 -1
  271. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  272. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  273. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  274. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  275. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  276. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  277. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  278. package/dist/rest/namespaces/datasphere.js +6 -72
  279. package/dist/rest/namespaces/datasphere.js.map +1 -1
  280. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  281. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  282. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  283. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  284. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  285. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  286. package/dist/rest/namespaces/fabric.d.ts +11 -327
  287. package/dist/rest/namespaces/fabric.js +14 -439
  288. package/dist/rest/namespaces/fabric.js.map +1 -1
  289. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  290. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  291. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  293. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  294. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  296. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  297. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  298. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  299. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  300. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  301. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  302. package/dist/rest/namespaces/imported-numbers.js +3 -21
  303. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  304. package/dist/rest/namespaces/logs.d.ts +10 -101
  305. package/dist/rest/namespaces/logs.js +10 -128
  306. package/dist/rest/namespaces/logs.js.map +1 -1
  307. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  308. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  309. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  310. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  311. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  312. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  313. package/dist/rest/namespaces/lookup.d.ts +3 -25
  314. package/dist/rest/namespaces/lookup.js +3 -27
  315. package/dist/rest/namespaces/lookup.js.map +1 -1
  316. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  317. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  318. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  319. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  320. package/dist/rest/namespaces/message.types.generated.js +8 -0
  321. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  323. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  324. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  325. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  326. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  327. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  328. package/dist/rest/namespaces/mfa.d.ts +3 -42
  329. package/dist/rest/namespaces/mfa.js +3 -49
  330. package/dist/rest/namespaces/mfa.js.map +1 -1
  331. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  332. package/dist/rest/namespaces/number-groups.js +3 -53
  333. package/dist/rest/namespaces/number-groups.js.map +1 -1
  334. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  335. package/dist/rest/namespaces/phone-numbers.js +8 -230
  336. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  337. package/dist/rest/namespaces/project.d.ts +6 -42
  338. package/dist/rest/namespaces/project.js +6 -51
  339. package/dist/rest/namespaces/project.js.map +1 -1
  340. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  341. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  342. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  343. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  344. package/dist/rest/namespaces/project.types.generated.js +8 -0
  345. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  347. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  348. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  349. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  350. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  351. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  352. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  353. package/dist/rest/namespaces/pubsub.js +4 -21
  354. package/dist/rest/namespaces/pubsub.js.map +1 -1
  355. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  356. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  357. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  358. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  359. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  360. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  361. package/dist/rest/namespaces/queues.d.ts +3 -38
  362. package/dist/rest/namespaces/queues.js +3 -44
  363. package/dist/rest/namespaces/queues.js.map +1 -1
  364. package/dist/rest/namespaces/recordings.d.ts +3 -34
  365. package/dist/rest/namespaces/recordings.js +3 -40
  366. package/dist/rest/namespaces/recordings.js.map +1 -1
  367. package/dist/rest/namespaces/registry.d.ts +6 -137
  368. package/dist/rest/namespaces/registry.js +6 -173
  369. package/dist/rest/namespaces/registry.js.map +1 -1
  370. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  371. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  372. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  373. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  374. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  375. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  376. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  377. package/dist/rest/namespaces/short-codes.js +3 -41
  378. package/dist/rest/namespaces/short-codes.js.map +1 -1
  379. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  380. package/dist/rest/namespaces/sip-profile.js +3 -29
  381. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  382. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  383. package/dist/rest/namespaces/verified-callers.js +3 -34
  384. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  385. package/dist/rest/namespaces/video.d.ts +10 -227
  386. package/dist/rest/namespaces/video.js +10 -288
  387. package/dist/rest/namespaces/video.js.map +1 -1
  388. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  389. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  390. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  391. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  392. package/dist/rest/namespaces/video.types.generated.js +8 -0
  393. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  395. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  396. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  397. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  398. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  399. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  400. package/dist/rest/pagination.d.ts +5 -1
  401. package/dist/rest/pagination.js +40 -20
  402. package/dist/rest/pagination.js.map +1 -1
  403. package/dist/rest/types.d.ts +21 -3
  404. package/dist/schema.json +299 -98
  405. package/dist/skills/SkillBase.d.ts +111 -21
  406. package/dist/skills/SkillBase.js +100 -17
  407. package/dist/skills/SkillBase.js.map +1 -1
  408. package/dist/skills/SkillManager.d.ts +66 -13
  409. package/dist/skills/SkillManager.js +101 -20
  410. package/dist/skills/SkillManager.js.map +1 -1
  411. package/dist/skills/SkillName.d.ts +44 -0
  412. package/dist/skills/SkillName.js +2 -0
  413. package/dist/skills/SkillName.js.map +1 -0
  414. package/dist/skills/SkillRegistry.d.ts +22 -11
  415. package/dist/skills/SkillRegistry.js +47 -17
  416. package/dist/skills/SkillRegistry.js.map +1 -1
  417. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  418. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  419. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  420. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  421. package/dist/skills/builtin/ask_claude.js +36 -14
  422. package/dist/skills/builtin/ask_claude.js.map +1 -1
  423. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  424. package/dist/skills/builtin/claude_skills.js +19 -15
  425. package/dist/skills/builtin/claude_skills.js.map +1 -1
  426. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  427. package/dist/skills/builtin/custom_skills.js +26 -9
  428. package/dist/skills/builtin/custom_skills.js.map +1 -1
  429. package/dist/skills/builtin/datasphere.d.ts +5 -3
  430. package/dist/skills/builtin/datasphere.js +21 -22
  431. package/dist/skills/builtin/datasphere.js.map +1 -1
  432. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  433. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  434. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  435. package/dist/skills/builtin/datetime.d.ts +3 -1
  436. package/dist/skills/builtin/datetime.js +11 -7
  437. package/dist/skills/builtin/datetime.js.map +1 -1
  438. package/dist/skills/builtin/google_maps.d.ts +29 -14
  439. package/dist/skills/builtin/google_maps.js +89 -269
  440. package/dist/skills/builtin/google_maps.js.map +1 -1
  441. package/dist/skills/builtin/index.d.ts +8 -6
  442. package/dist/skills/builtin/index.js +8 -6
  443. package/dist/skills/builtin/index.js.map +1 -1
  444. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  445. package/dist/skills/builtin/info_gatherer.js +20 -12
  446. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  447. package/dist/skills/builtin/joke.d.ts +16 -6
  448. package/dist/skills/builtin/joke.js +54 -37
  449. package/dist/skills/builtin/joke.js.map +1 -1
  450. package/dist/skills/builtin/math.d.ts +3 -1
  451. package/dist/skills/builtin/math.js +14 -9
  452. package/dist/skills/builtin/math.js.map +1 -1
  453. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  454. package/dist/skills/builtin/mcp_gateway.js +77 -46
  455. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  456. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  457. package/dist/skills/builtin/native_vector_search.js +179 -61
  458. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  459. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  460. package/dist/skills/builtin/play_background_file.js +43 -122
  461. package/dist/skills/builtin/play_background_file.js.map +1 -1
  462. package/dist/skills/builtin/spider.d.ts +42 -4
  463. package/dist/skills/builtin/spider.js +277 -104
  464. package/dist/skills/builtin/spider.js.map +1 -1
  465. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  466. package/dist/skills/builtin/swml_transfer.js +45 -24
  467. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  468. package/dist/skills/builtin/weather_api.d.ts +24 -13
  469. package/dist/skills/builtin/weather_api.js +38 -30
  470. package/dist/skills/builtin/weather_api.js.map +1 -1
  471. package/dist/skills/builtin/web_search.d.ts +48 -10
  472. package/dist/skills/builtin/web_search.js +294 -100
  473. package/dist/skills/builtin/web_search.js.map +1 -1
  474. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  475. package/dist/skills/builtin/wikipedia_search.js +14 -13
  476. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  477. package/dist/skills/index.d.ts +3 -2
  478. package/dist/skills/index.js +1 -1
  479. package/dist/skills/index.js.map +1 -1
  480. package/dist/swml_verbs_generated.d.ts +2824 -0
  481. package/dist/swml_verbs_generated.js +12 -0
  482. package/dist/swml_verbs_generated.js.map +1 -0
  483. package/dist/types.d.ts +59 -6
  484. package/dist/web.d.ts +27 -0
  485. package/dist/web.js +20 -0
  486. package/dist/web.js.map +1 -0
  487. package/docs/agent-guide.md +1034 -0
  488. package/docs/ai_chat.md +560 -0
  489. package/docs/api-reference.md +3641 -0
  490. package/docs/architecture.md +846 -0
  491. package/docs/bedrock_agent.md +411 -0
  492. package/docs/cli-guide.md +403 -0
  493. package/docs/cloud_functions_guide.md +399 -0
  494. package/docs/configuration.md +548 -0
  495. package/docs/contexts-guide.md +884 -0
  496. package/docs/datamap-guide.md +1207 -0
  497. package/docs/developer_pain_points.md +548 -0
  498. package/docs/llm_parameters.md +298 -0
  499. package/docs/mcp_gateway_reference.md +354 -0
  500. package/docs/mcp_integration.md +162 -0
  501. package/docs/pgi_agent_guide.md +1820 -0
  502. package/docs/prefabs-guide.md +815 -0
  503. package/docs/programmatically_governed_inference.md +301 -0
  504. package/docs/sdk_features.md +501 -0
  505. package/docs/security.md +559 -0
  506. package/docs/serverless-guide.md +520 -0
  507. package/docs/skills-guide.md +1223 -0
  508. package/docs/skills-system.md +405 -0
  509. package/docs/skills_parameter_schema.md +417 -0
  510. package/docs/swaig-reference.md +1986 -0
  511. package/docs/swml_service_guide.md +573 -0
  512. package/docs/third_party_skills.md +410 -0
  513. package/docs/web_service.md +666 -0
  514. package/examples/README.md +202 -0
  515. package/examples/advanced-datamap.ts +108 -0
  516. package/examples/advanced-dynamic-config.ts +70 -0
  517. package/examples/auto-vivified.ts +95 -0
  518. package/examples/call-flow.ts +65 -0
  519. package/examples/comprehensive-dynamic.ts +125 -0
  520. package/examples/contexts-steps.ts +65 -0
  521. package/examples/custom-path.ts +45 -0
  522. package/examples/datamap-tools.ts +51 -0
  523. package/examples/datasphere-multi-instance.ts +66 -0
  524. package/examples/datasphere-serverless-env.ts +87 -0
  525. package/examples/datasphere-webhook-env.ts +65 -0
  526. package/examples/datasphere.ts +56 -0
  527. package/examples/declarative.ts +100 -0
  528. package/examples/dynamic-config.ts +54 -0
  529. package/examples/dynamic-info-gatherer.ts +69 -0
  530. package/examples/dynamic-swml-service.ts +67 -0
  531. package/examples/gather-info.ts +95 -0
  532. package/examples/gather-per-question-functions-demo.ts +139 -0
  533. package/examples/joke-agent.ts +34 -0
  534. package/examples/kubernetes-agent.ts +45 -0
  535. package/examples/llm-params.ts +75 -0
  536. package/examples/mcp-agent.ts +89 -0
  537. package/examples/mcp-gateway.ts +81 -0
  538. package/examples/multi-agent.ts +80 -0
  539. package/examples/multi-endpoint.ts +79 -0
  540. package/examples/pgi/case-domain.ts +114 -0
  541. package/examples/pgi/serve.ts +16 -0
  542. package/examples/pgi/support-agent.ts +265 -0
  543. package/examples/pom-prompt.ts +70 -0
  544. package/examples/prefab-concierge.ts +42 -0
  545. package/examples/prefab-faq.ts +58 -0
  546. package/examples/prefab-info-gatherer.ts +33 -0
  547. package/examples/prefab-receptionist.ts +36 -0
  548. package/examples/prefab-survey.ts +69 -0
  549. package/examples/quickstart-agent.ts +29 -0
  550. package/examples/quickstart-relay.ts +25 -0
  551. package/examples/quickstart-rest.ts +25 -0
  552. package/examples/record-call.ts +65 -0
  553. package/examples/relay-demo.ts +33 -0
  554. package/examples/room-and-sip.ts +93 -0
  555. package/examples/serverless-lambda.ts +43 -0
  556. package/examples/session-state.ts +83 -0
  557. package/examples/simple-agent.ts +36 -0
  558. package/examples/simple-static.ts +29 -0
  559. package/examples/skills-demo.ts +41 -0
  560. package/examples/step-function-inheritance-demo.ts +124 -0
  561. package/examples/swaig-features.ts +193 -0
  562. package/examples/swml-service-routing.ts +66 -0
  563. package/examples/swml-service.ts +38 -0
  564. package/examples/swmlservice_ai_sidecar.ts +104 -0
  565. package/examples/swmlservice_swaig_standalone.ts +79 -0
  566. package/examples/tap.ts +67 -0
  567. package/examples/typed-tools.ts +68 -0
  568. package/examples/verb-methods.ts +45 -0
  569. package/examples/web-search-multi-instance.ts +75 -0
  570. package/examples/web-search.ts +38 -0
  571. package/examples/wikipedia.ts +36 -0
  572. package/livewire/README.md +164 -0
  573. package/livewire/docs/migration-guide.md +251 -0
  574. package/livewire/examples/livewire-basic-agent.ts +74 -0
  575. package/livewire/examples/livewire-handoff.ts +196 -0
  576. package/livewire/examples/livewire-multi-tool.ts +121 -0
  577. package/package.json +85 -13
  578. package/relay/README.md +101 -0
  579. package/relay/docs/call-methods.md +622 -0
  580. package/relay/docs/client-reference.md +281 -0
  581. package/relay/docs/events.md +193 -0
  582. package/relay/docs/getting-started.md +221 -0
  583. package/relay/docs/guide.md +386 -0
  584. package/relay/docs/messaging.md +246 -0
  585. package/relay/examples/relay-inbound.ts +66 -0
  586. package/relay/examples/relay-messaging.ts +74 -0
  587. package/relay/examples/relay-outbound.ts +76 -0
  588. package/rest/README.md +141 -0
  589. package/rest/docs/calling.md +313 -0
  590. package/rest/docs/client-reference.md +149 -0
  591. package/rest/docs/fabric.md +192 -0
  592. package/rest/docs/getting-started.md +138 -0
  593. package/rest/docs/guide.md +421 -0
  594. package/rest/docs/namespaces.md +367 -0
  595. package/rest/docs/phone-binding.md +116 -0
  596. package/rest/examples/rest-10dlc-registration.ts +177 -0
  597. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  598. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  599. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  600. package/rest/examples/rest-client.ts +59 -0
  601. package/rest/examples/rest-datasphere-search.ts +81 -0
  602. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  603. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  604. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  605. package/rest/examples/rest-manage-resources.ts +64 -0
  606. package/rest/examples/rest-phone-number-management.ts +200 -0
  607. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  608. package/rest/examples/rest-video-rooms.ts +186 -0
  609. package/tutorial/fred/fred.ts +218 -0
  610. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  611. package/tutorial/fred/tutorial/02-setup.md +304 -0
  612. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  613. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  614. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  615. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  616. package/tutorial/fred/tutorial/README.md +56 -0
  617. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  618. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  619. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  620. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  621. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  622. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  623. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  624. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  625. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  626. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  627. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  628. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  629. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  630. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  631. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  632. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  633. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  634. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  635. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  636. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  637. package/tutorial/multi_agents/README.md +175 -0
  638. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  639. package/tutorial/multi_agents/extending_agents.ts +641 -0
  640. package/tutorial/multi_agents/knowledge.ts +59 -0
  641. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  642. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  643. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  644. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  645. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  646. package/tutorial/multi_agents/pc_builder.ts +529 -0
  647. package/tutorial/multi_agents/sales_agent.ts +88 -0
  648. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  649. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  650. package/tutorial/multi_agents/support_knowledge.md +256 -0
  651. package/dist/cli/mock-data.d.ts +0 -37
  652. package/dist/cli/mock-data.js +0 -80
  653. package/dist/cli/mock-data.js.map +0 -1
  654. package/dist/generateVerbTypes.d.ts +0 -11
  655. package/dist/generateVerbTypes.js +0 -265
  656. package/dist/generateVerbTypes.js.map +0 -1
  657. package/dist/rest/namespaces/compat.d.ts +0 -585
  658. package/dist/rest/namespaces/compat.js +0 -735
  659. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,152 @@
1
+ /**
2
+ * RobotsTxt - robots.txt rules, read the way Python's `urllib.robotparser`
3
+ * reads them, so the spider skill allows and refuses the same pages in both
4
+ * SDKs.
5
+ *
6
+ * The rules, as in `urllib.robotparser`:
7
+ * - A group is one or more `User-agent` lines followed by `Allow`/`Disallow`
8
+ * lines. A blank line ends a group; `User-agent` lines followed by a blank
9
+ * line and no rules are dropped.
10
+ * - A group applies to a user agent when one of its names is `*` or appears
11
+ * in the user agent's product name (the part before the first `/`),
12
+ * compared without case. The first group that applies is used; the `*`
13
+ * group is used only when no other applies.
14
+ * - Within a group, the first rule whose path starts the URL's path decides.
15
+ * An empty `Disallow` allows everything. There are no wildcards except a
16
+ * path of exactly `*`.
17
+ * - Paths and URLs are compared percent-encoded, as `urllib.parse.quote`
18
+ * encodes them.
19
+ *
20
+ * Internal to the SDK.
21
+ */
22
+ /** Percent-encode as Python's `urllib.parse.quote(s)` does, keeping `/`. */
23
+ function quote(s) {
24
+ return encodeURIComponent(s)
25
+ .replace(/[!'()*]/g, (c) => '%' + c.charCodeAt(0).toString(16).toUpperCase())
26
+ .replace(/%2F/g, '/');
27
+ }
28
+ const UTF8 = new TextDecoder('utf-8');
29
+ /**
30
+ * Decode percent-escapes as Python's `urllib.parse.unquote` does: each run
31
+ * of escapes is UTF-8, and bytes that aren't valid UTF-8 become U+FFFD.
32
+ */
33
+ function unquote(s) {
34
+ return s.replace(/(%[0-9A-Fa-f]{2})+/g, (run) => {
35
+ const bytes = new Uint8Array(run.length / 3);
36
+ for (let i = 0; i < bytes.length; i++)
37
+ bytes[i] = parseInt(run.slice(i * 3 + 1, i * 3 + 3), 16);
38
+ return UTF8.decode(bytes);
39
+ });
40
+ }
41
+ function groupAppliesTo(group, userAgent) {
42
+ const product = (userAgent.split('/')[0] ?? '').toLowerCase();
43
+ return group.userAgents.some((agent) => agent === '*' || product.includes(agent.toLowerCase()));
44
+ }
45
+ function groupAllows(group, path) {
46
+ for (const rule of group.rules) {
47
+ if (rule.path === '*' || path.startsWith(rule.path))
48
+ return rule.allowance;
49
+ }
50
+ return true;
51
+ }
52
+ /** Parsed robots.txt rules for one site. */
53
+ export class _RobotsRules {
54
+ groups = [];
55
+ defaultGroup = null;
56
+ /**
57
+ * @param text - The robots.txt body; empty allows everything.
58
+ */
59
+ constructor(text) {
60
+ let group = { userAgents: [], rules: [] };
61
+ // 0: nothing yet; 1: saw User-agent lines; 2: saw rules
62
+ let state = 0;
63
+ const finish = () => {
64
+ if (group.userAgents.includes('*')) {
65
+ if (this.defaultGroup === null)
66
+ this.defaultGroup = group;
67
+ }
68
+ else {
69
+ this.groups.push(group);
70
+ }
71
+ };
72
+ for (const rawLine of text.split(/\r\n|\r|\n/)) {
73
+ if (!rawLine) {
74
+ if (state === 1) {
75
+ group = { userAgents: [], rules: [] };
76
+ state = 0;
77
+ }
78
+ else if (state === 2) {
79
+ finish();
80
+ group = { userAgents: [], rules: [] };
81
+ state = 0;
82
+ }
83
+ continue;
84
+ }
85
+ const hash = rawLine.indexOf('#');
86
+ const line = (hash >= 0 ? rawLine.slice(0, hash) : rawLine).trim();
87
+ if (!line)
88
+ continue;
89
+ const colon = line.indexOf(':');
90
+ if (colon < 0)
91
+ continue;
92
+ const key = line.slice(0, colon).trim().toLowerCase();
93
+ const value = unquote(line.slice(colon + 1).trim());
94
+ if (key === 'user-agent') {
95
+ if (state === 2) {
96
+ finish();
97
+ group = { userAgents: [], rules: [] };
98
+ }
99
+ group.userAgents.push(value);
100
+ state = 1;
101
+ }
102
+ else if (key === 'disallow' || key === 'allow') {
103
+ if (state !== 0) {
104
+ const allowance = key === 'allow' || value === '';
105
+ group.rules.push({ path: quote(value), allowance });
106
+ state = 2;
107
+ }
108
+ }
109
+ else if (key === 'crawl-delay' || key === 'request-rate') {
110
+ // Not used here, but they count as rules when a group ends.
111
+ if (state !== 0)
112
+ state = 2;
113
+ }
114
+ }
115
+ if (state === 2)
116
+ finish();
117
+ }
118
+ /** Rules that allow every page. */
119
+ static allowAll() {
120
+ return new _RobotsRules('');
121
+ }
122
+ /** Rules that refuse every page. */
123
+ static disallowAll() {
124
+ return new _RobotsRules('User-agent: *\nDisallow: /');
125
+ }
126
+ /**
127
+ * Whether `userAgent` may fetch `url`.
128
+ * @param userAgent - The user agent the fetch sends.
129
+ * @param url - The page's URL.
130
+ * @returns True when the rules allow it.
131
+ */
132
+ canFetch(userAgent, url) {
133
+ // Split as urllib.parse does, without re-encoding: drop the scheme and
134
+ // host, and an empty query or fragment.
135
+ let rest = unquote(url).replace(/^[a-zA-Z][a-zA-Z0-9+.-]*:\/\/[^/?#]*/, '');
136
+ const hash = rest.indexOf('#');
137
+ const fragment = hash >= 0 ? rest.slice(hash + 1) : '';
138
+ if (hash >= 0)
139
+ rest = rest.slice(0, hash);
140
+ const mark = rest.indexOf('?');
141
+ const query = mark >= 0 ? rest.slice(mark + 1) : '';
142
+ if (mark >= 0)
143
+ rest = rest.slice(0, mark);
144
+ const path = quote(`${rest}${query ? `?${query}` : ''}${fragment ? `#${fragment}` : ''}`) || '/';
145
+ for (const group of this.groups) {
146
+ if (groupAppliesTo(group, userAgent))
147
+ return groupAllows(group, path);
148
+ }
149
+ return this.defaultGroup ? groupAllows(this.defaultGroup, path) : true;
150
+ }
151
+ }
152
+ //# sourceMappingURL=RobotsTxt.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RobotsTxt.js","sourceRoot":"","sources":["../src/RobotsTxt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,4EAA4E;AAC5E,SAAS,KAAK,CAAC,CAAS;IACtB,OAAO,kBAAkB,CAAC,CAAC,CAAC;SACzB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;SAC5E,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;AAEtC;;;GAGG;AACH,SAAS,OAAO,CAAC,CAAS;IACxB,OAAO,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,GAAG,EAAE,EAAE;QAC9C,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAChG,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAYD,SAAS,cAAc,CAAC,KAAY,EAAE,SAAiB;IACrD,MAAM,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9D,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,WAAW,CAAC,KAAY,EAAE,IAAY;IAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC;IAC7E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,4CAA4C;AAC5C,MAAM,OAAO,YAAY;IACN,MAAM,GAAY,EAAE,CAAC;IAC9B,YAAY,GAAiB,IAAI,CAAC;IAE1C;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,KAAK,GAAU,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACjD,wDAAwD;QACxD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,MAAM,GAAG,GAAG,EAAE;YAClB,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI;oBAAE,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC;QAEF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,KAAK,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;oBACtC,KAAK,GAAG,CAAC,CAAC;gBACZ,CAAC;qBAAM,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBACvB,MAAM,EAAE,CAAC;oBACT,KAAK,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;oBACtC,KAAK,GAAG,CAAC,CAAC;gBACZ,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;YACnE,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,KAAK,GAAG,CAAC;gBAAE,SAAS;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACtD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAEpD,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;gBACzB,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,MAAM,EAAE,CAAC;oBACT,KAAK,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;gBACxC,CAAC;gBACD,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC7B,KAAK,GAAG,CAAC,CAAC;YACZ,CAAC;iBAAM,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;gBACjD,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,MAAM,SAAS,GAAG,GAAG,KAAK,OAAO,IAAI,KAAK,KAAK,EAAE,CAAC;oBAClD,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;oBACpD,KAAK,GAAG,CAAC,CAAC;gBACZ,CAAC;YACH,CAAC;iBAAM,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;gBAC3D,4DAA4D;gBAC5D,IAAI,KAAK,KAAK,CAAC;oBAAE,KAAK,GAAG,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC;YAAE,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,QAAQ;QACb,OAAO,IAAI,YAAY,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,oCAAoC;IACpC,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,SAAiB,EAAE,GAAW;QACrC,uEAAuE;QACvE,wCAAwC;QACxC,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,sCAAsC,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,IAAI,IAAI,IAAI,CAAC;YAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,IAAI,IAAI,IAAI,CAAC;YAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,IAAI,GACR,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC;QACtF,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC;gBAAE,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzE,CAAC;CACF"}
@@ -1 +1 @@
1
- {"version":3,"file":"SWMLHandler.js","sourceRoot":"","sources":["../src/SWMLHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAgB,eAAe;CAqBpC;AAoBD,sCAAsC;AACtC,MAAM,OAAO,aAAc,SAAQ,eAAe;IAChD;;;OAGG;IACH,WAAW;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,MAA+B;QAC5C,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,+BAA+B;QAC/B,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAC/C,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3E,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,GAAG,MAAiC,CAAC;QAE5C,+EAA+E;QAC/E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC;QAC1B,MAAM,WAAW,GAAG,UAAU,IAAI,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;QACjE,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;QACxF,CAAC;QAED,6DAA6D;QAC7D,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;YAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjF,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,sCAAsC;QACtC,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxE,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,OAA2B,EAAE;QACvC,MAAM,EACJ,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,aAAa,EACb,KAAK,EACL,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;QAET,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,iEAAiE;QACjE,MAAM,eAAe,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;QACtF,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;aAAM,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,uCAAuC;QACvC,MAAM,YAAY,GAA4B,EAAE,CAAC;QACjD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,YAAY,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;QACpC,CAAC;aAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YACnC,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAClC,CAAC;QAED,+DAA+D;QAC/D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,YAAY,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;QACtC,CAAC;QAED,MAAM,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC;QAEhC,8BAA8B;QAC9B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QAC/C,CAAC;QAED,kCAAkC;QAClC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC;QAC5C,CAAC;QAED,wBAAwB;QACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;QAED,gCAAgC;QAChC,uDAAuD;QACvD,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAA6B,CAAC;QACnD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QAC/F,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,0DAA0D;gBAC1D,MAAM,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,uBAAuB;gBACtB,MAAM,CAAC,QAAQ,CAA6B,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,mBAAmB;IACtB,QAAQ,GAAiC,IAAI,GAAG,EAAE,CAAC;IAE3D,qDAAqD;IACrD;QACE,wDAAwD;QACxD,IAAI,CAAC,eAAe,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,OAAwB;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF"}
1
+ {"version":3,"file":"SWMLHandler.js","sourceRoot":"","sources":["../src/SWMLHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAgB,eAAe;CAqBpC;AAoBD,sCAAsC;AACtC,MAAM,OAAO,aAAc,SAAQ,eAAe;IAChD;;;OAGG;IACH,WAAW;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,MAA+B;QAC5C,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,+BAA+B;QAC/B,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAC/C,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3E,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,CAAC,GAAG,MAAiC,CAAC;QAE5C,+EAA+E;QAC/E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC;QAC1B,MAAM,WAAW,GAAG,UAAU,IAAI,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;QACjE,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;QACxF,CAAC;QAED,6DAA6D;QAC7D,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;YAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjF,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,sCAAsC;QACtC,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxE,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,OAA2B,EAAE;QACvC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAE5F,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,iEAAiE;QACjE,MAAM,eAAe,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;QACtF,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;aAAM,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,uCAAuC;QACvC,MAAM,YAAY,GAA4B,EAAE,CAAC;QACjD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,YAAY,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;QACpC,CAAC;aAAM,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YACnC,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAClC,CAAC;QAED,+DAA+D;QAC/D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,YAAY,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;QACtC,CAAC;QAED,MAAM,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC;QAEhC,8BAA8B;QAC9B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QAC/C,CAAC;QAED,kCAAkC;QAClC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC;QAC5C,CAAC;QAED,wBAAwB;QACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;QAED,gCAAgC;QAChC,uDAAuD;QACvD,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAA6B,CAAC;QACnD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QAC/F,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,0DAA0D;gBAC1D,MAAM,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,uBAAuB;gBACtB,MAAM,CAAC,QAAQ,CAA6B,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,mBAAmB;IACtB,QAAQ,GAAiC,IAAI,GAAG,EAAE,CAAC;IAE3D,qDAAqD;IACrD;QACE,wDAAwD;QACxD,IAAI,CAAC,eAAe,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,OAAwB;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF"}
@@ -5,12 +5,17 @@
5
5
  * pure SWML call-flow documents: IVR menus, voicemail, call recording, etc.
6
6
  * Uses SwmlBuilder for verb methods and Hono for HTTP serving.
7
7
  */
8
+ import type { AgentBase } from './AgentBase.js';
8
9
  import { Hono } from 'hono';
10
+ import type { HostAppRouter } from './web.js';
9
11
  import { SwmlBuilder } from './SwmlBuilder.js';
10
12
  import { SchemaUtils } from './SchemaUtils.js';
11
13
  import { Logger } from './Logger.js';
12
14
  import { SwaigFunction, type SwaigFunctionOptions } from './SwaigFunction.js';
15
+ import type { ToolParameters, ToolArgs } from './ParameterSchema.js';
13
16
  import { FunctionResult } from './FunctionResult.js';
17
+ import type { SwmlRequestData } from './PlatformContracts.js';
18
+ import type { SwaigRequest } from './SwaigContracts.js';
14
19
  import type { Server } from 'node:http';
15
20
  /**
16
21
  * Interface for custom SWML verb handlers.
@@ -54,20 +59,80 @@ export declare class SecurityConfig {
54
59
  basicAuthUser: string | null;
55
60
  /** Basic auth password from config, or null. */
56
61
  basicAuthPassword: string | null;
62
+ /**
63
+ * Where {@link basicAuthPassword} came from: `'environment'`
64
+ * (`SWML_BASIC_AUTH_PASSWORD`), `'config file'` (which takes precedence), or
65
+ * `null` when neither set one.
66
+ */
67
+ basicAuthSource: 'environment' | 'config file' | null;
68
+ /** Allowed request hosts (`['*']` = allow all). */
69
+ allowedHosts: string[];
70
+ /** Allowed CORS origins. */
71
+ corsOrigins: string[];
72
+ /** Whether to emit an HSTS header on HTTPS responses. */
73
+ useHsts: boolean;
74
+ /** HSTS `max-age` in seconds. */
75
+ hstsMaxAge: number;
57
76
  private sslConfig;
58
77
  constructor(opts?: {
59
78
  configFile?: string;
60
79
  serviceName?: string;
61
80
  });
81
+ /** Split a comma-separated env value into a trimmed, non-empty list. */
82
+ private static parseList;
83
+ /**
84
+ * (Re)load host/CORS/HSTS settings from environment variables. Mirrors Python
85
+ * SDK's `SecurityConfig.load_from_env()`. SSL/auth are loaded in the constructor
86
+ * from their own env vars; this refreshes the network-policy fields.
87
+ */
88
+ loadFromEnv(): void;
62
89
  private loadFromConfigFile;
63
- /** Get basic auth credentials from security config, or null if not configured. */
90
+ /**
91
+ * Get basic auth credentials from the config file or environment, or null
92
+ * when no password is configured. The user defaults to `signalwire`.
93
+ */
64
94
  getBasicAuth(): [string, string] | null;
65
95
  /** Validate that SSL cert and key files are present when SSL is enabled. */
66
96
  validateSslConfig(): [boolean, string | null];
97
+ /**
98
+ * Build the SSL parameters for the HTTPS server, as a plain dictionary of
99
+ * primitive filesystem paths. Mirrors Python's
100
+ * `SecurityConfig.get_ssl_context_kwargs()` verbatim: the reference targets
101
+ * uvicorn's `ssl_certfile`/`ssl_keyfile` kwargs, and this returns the exact
102
+ * same primitive path pair (the TS HTTPS server passes them to
103
+ * `node:https.createServer` / `readFileSync`). Returns an empty object when
104
+ * SSL is disabled or the cert/key files fail validation.
105
+ * @returns `{ ssl_certfile, ssl_keyfile }` path strings, or `{}` when unavailable.
106
+ */
107
+ getSslContextKwargs(): Record<string, string>;
108
+ /** Get the URL scheme based on SSL configuration. Mirrors Python's `get_url_scheme()`. */
109
+ getUrlScheme(): string;
110
+ /**
111
+ * Check whether a host is allowed. Mirrors Python's `should_allow_host()`:
112
+ * a wildcard `*` in the allow-list permits any host.
113
+ */
114
+ shouldAllowHost(host: string): boolean;
115
+ /**
116
+ * Get CORS configuration. Mirrors Python's `get_cors_config()`.
117
+ * @returns An object of CORS settings (origins, credentials, methods, headers).
118
+ */
119
+ getCorsConfig(): Record<string, unknown>;
120
+ /**
121
+ * Get the security headers to add to responses. Mirrors Python's
122
+ * `get_security_headers()`; adds an HSTS header when the request is HTTPS and
123
+ * HSTS is enabled.
124
+ * @param isHttps - Whether the connection is over HTTPS.
125
+ */
126
+ getSecurityHeaders(isHttps?: boolean): Record<string, string>;
127
+ /**
128
+ * Log the current security configuration. Mirrors Python's `log_config()`.
129
+ * @param serviceName - The service name to tag the log line with.
130
+ */
131
+ logConfig(serviceName: string): void;
67
132
  }
68
133
  /** Callback invoked per-request to dynamically build SWML. */
69
- export type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: Record<string, unknown>, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>;
70
- type RoutingCallback = (requestBody: Record<string, unknown>) => string | null | undefined | Promise<string | null | undefined>;
134
+ export type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: SwmlRequestData, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>;
135
+ type RoutingCallback = (requestBody: SwmlRequestData, headers?: Record<string, string>) => string | null | undefined | Promise<string | null | undefined>;
71
136
  /** Configuration options for SWMLService. */
72
137
  export interface SWMLServiceOptions {
73
138
  /**
@@ -91,28 +156,11 @@ export interface SWMLServiceOptions {
91
156
  schemaValidation?: boolean;
92
157
  }
93
158
  /**
94
- * HTTP service that serves non-AI SWML documents built from verb methods.
95
- *
96
- * Use `SWMLService` when you need a SignalWire call flow but don't need AI —
97
- * plain call routing, IVR-style trees, recording workflows, static playback, etc.
98
- * For AI-powered voice agents, use {@link AgentBase} instead.
99
- *
100
- * @example Static greeting that plays a file and hangs up
101
- * ```ts
102
- * import { SWMLService } from '@signalwire/sdk';
103
- *
104
- * const service = new SWMLService({ name: 'greeter', route: '/', port: 3000 });
105
- * service.builder
106
- * .answer()
107
- * .play({ url: 'https://cdn.example.com/welcome.mp3' })
108
- * .hangup();
109
- *
110
- * await service.serve();
111
- * ```
112
- *
113
- * @see {@link SwmlBuilder} — the underlying SWML document builder
114
- * @see {@link AgentBase} — AI-powered alternative
159
+ * The services constructed since the last call, while swaig-test was
160
+ * importing a file, in construction order; clears the list. Internal to the
161
+ * CLI's loader.
115
162
  */
163
+ export declare function _takeCliLoadedServices(): SWMLService[];
116
164
  export declare class SWMLService {
117
165
  /** Service display name. */
118
166
  readonly name: string;
@@ -136,6 +184,11 @@ export declare class SWMLService {
136
184
  readonly sslKeyPath: string | undefined;
137
185
  /** Schema validation utilities. Mirrors Python's `self.schema_utils`. */
138
186
  readonly schemaUtils: SchemaUtils;
187
+ /** @internal The schema settings every SwmlBuilder this service creates uses. */
188
+ protected _builderSchemaOptions: {
189
+ enableValidation: boolean;
190
+ schemaPath?: string;
191
+ };
139
192
  /** Custom verb handler registry. Mirrors Python's `self.verb_registry`. */
140
193
  readonly verbRegistry: VerbHandlerRegistry;
141
194
  protected swmlBuilder: SwmlBuilder;
@@ -143,9 +196,9 @@ export declare class SWMLService {
143
196
  protected _server: Server | null;
144
197
  protected onRequestCallback?: OnRequestCallback;
145
198
  protected authCredentials?: [string, string];
146
- protected authSource: 'provided' | 'environment' | 'generated';
199
+ protected authSource: 'provided' | 'environment' | 'config file' | 'generated';
147
200
  /** Validate provided basic-auth credentials against the configured ones
148
- * using a constant-time comparison. (Python parity:
201
+ * using a constant-time comparison. (Python equivalent:
149
202
  * ``AuthMixin.validate_basic_auth(username, password)``.) */
150
203
  validateBasicAuth(username: string, password: string): boolean | Promise<boolean>;
151
204
  private timingSafeEqual;
@@ -161,12 +214,33 @@ export declare class SWMLService {
161
214
  * parameter descriptions are LLM-facing prompt engineering — see
162
215
  * PORTING_GUIDE for guidance on writing them.
163
216
  *
164
- * Accepts the full SwaigFunctionOptions surface so AgentBase's richer
165
- * call sites (fillers, secure tokens, wait files, extra fields) work
166
- * without overriding this method on the subclass.
217
+ * Generic over the `parameters` schema (`P`) and `required` list (`R`): when
218
+ * `parameters` is written as a FLAT inline map (`{ name: { type, … } }`), the
219
+ * `const` type parameters capture its literals and the handler's `args` is
220
+ * inferred precisely — `args.phone` typed `string`, an `enum` prop narrowed to
221
+ * its literal union, `required` keys present and the rest optional (see
222
+ * {@link ToolArgs}/{@link InferArgs}). The WRAPPED JSON-Schema object
223
+ * (`{ type:'object', properties }`) and a pre-built `Record` are still
224
+ * accepted and keep the prior open-record `args` behavior. The args type is a
225
+ * compile-time authoring convenience — at runtime args is the JSON the model
226
+ * extracted, so the handler is the ordinary {@link SwaigHandler}.
227
+ */
228
+ defineTool<const P extends ToolParameters = ToolParameters, const R extends readonly PropertyKey[] = []>(opts: Omit<SwaigFunctionOptions, 'parameters' | 'required' | 'handler'> & {
229
+ parameters?: P;
230
+ required?: R;
231
+ handler: (args: ToolArgs<P, R>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;
232
+ }): this;
233
+ /**
234
+ * Register a SwaigFunction instance or a raw function descriptor (DataMap).
235
+ *
236
+ * A raw descriptor with `gates` or `gate_fillers` is checked by the
237
+ * platform's rules, and a normalized copy is stored; the caller's object is
238
+ * left as it was.
239
+ * @param fn - The function, or its raw SWAIG definition.
240
+ * @returns This service, for chaining.
241
+ * @throws {Error} For gates the platform would refuse, or gate fillers
242
+ * without gates.
167
243
  */
168
- defineTool(opts: SwaigFunctionOptions): this;
169
- /** Register a SwaigFunction instance or a raw function descriptor (DataMap). */
170
244
  registerSwaigFunction(fn: SwaigFunction | Record<string, unknown>): this;
171
245
  /**
172
246
  * Dispatch a function call to the registered handler.
@@ -176,20 +250,20 @@ export declare class SWMLService {
176
250
  * to accommodate the agent override (which may also return void
177
251
  * shapes for fire-and-forget tool calls).
178
252
  */
179
- onFunctionCall(name: string, args: Record<string, unknown>, rawData: Record<string, unknown>): FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string | void> | void | null | undefined;
253
+ onFunctionCall(name: string, args: Record<string, unknown>, rawData: SwaigRequest): FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string | void> | void | null | undefined;
180
254
  /** Whether a tool with the given name is registered. */
181
255
  hasTool(name: string): boolean;
182
256
  /** Whether a SWAIG function with the given name is registered.
183
- * (Python parity: ``ToolRegistry.has_function``.) */
257
+ * (Python equivalent: ``ToolRegistry.has_function``.) */
184
258
  hasFunction(name: string): boolean;
185
259
  /** Get a registered SWAIG function entry, or undefined.
186
- * (Python parity: ``ToolRegistry.get_function``.) */
260
+ * (Python equivalent: ``ToolRegistry.get_function``.) */
187
261
  getFunction(name: string): SwaigFunction | Record<string, unknown> | undefined;
188
262
  /** Snapshot of all registered SWAIG functions keyed by name.
189
- * (Python parity: ``ToolRegistry.get_all_functions``.) */
263
+ * (Python equivalent: ``ToolRegistry.get_all_functions``.) */
190
264
  getAllFunctions(): Record<string, SwaigFunction | Record<string, unknown>>;
191
265
  /** Remove a registered SWAIG function. Returns true when removed,
192
- * false when not found. (Python parity:
266
+ * false when not found. (Python equivalent:
193
267
  * ``ToolRegistry.remove_function``.) */
194
268
  removeFunction(name: string): boolean;
195
269
  /** List registered tool names in insertion order (Map preserves it). */
@@ -222,7 +296,7 @@ export declare class SWMLService {
222
296
  * non-null, it's returned directly without dispatching. AgentBase may
223
297
  * override to add session-token validation or ephemeral dynamic-config.
224
298
  */
225
- protected swaigPreDispatch(_requestData: Record<string, unknown>, _funcName: string): [SWMLService, unknown];
299
+ protected swaigPreDispatch(_requestData: SwaigRequest, _funcName: string): [SWMLService, unknown];
226
300
  /**
227
301
  * Extension point: register additional Hono routes after SWMLService
228
302
  * mounts /health, /ready, /swaig, and the main route. AgentBase uses
@@ -281,8 +355,7 @@ export declare class SWMLService {
281
355
  */
282
356
  renderSwml(_callId?: string, _modifications?: Record<string, unknown>): Record<string, unknown> | string;
283
357
  /**
284
- * Get the SWML document as a dictionary.
285
- * Alias for `renderSwml()` that matches Python's `get_document()` name.
358
+ * Get the SWML document as a dictionary. Matches Python's `get_document()`.
286
359
  * @returns The SWML document.
287
360
  */
288
361
  getDocument(): Record<string, unknown>;
@@ -292,6 +365,39 @@ export declare class SWMLService {
292
365
  * @returns JSON-encoded SWML document.
293
366
  */
294
367
  renderDocument(): string;
368
+ /**
369
+ * Framework-free request-dispatch core.
370
+ *
371
+ * The primitive dispatch surface the SDK ports share (mirrors Python's
372
+ * `SWMLService.handle_request(method, url, headers, body)` and, e.g., the
373
+ * dotnet `(int, Dictionary, string) HandleRequest(...)`). It performs the
374
+ * routing-callback check, `on_request` modification, and basic-auth exactly as
375
+ * the Hono handler path does, but over plain primitives instead of Hono
376
+ * `Context`/`Response` objects — so both paths produce identical responses.
377
+ *
378
+ * @param method HTTP method, e.g. `"GET"` or `"POST"`.
379
+ * @param url The full request URL (used to derive the callback path).
380
+ * @param headers Request headers as a plain dict.
381
+ * @param body The already-parsed JSON body for POST requests, or `undefined`.
382
+ * @returns A `[status, responseHeaders, bodyString]` triple. For a routing
383
+ * redirect the status is 307 with a `Location` header and an empty body; an
384
+ * auth failure is 401 with `WWW-Authenticate: Basic`; otherwise 200 with the
385
+ * SWML document as the body string.
386
+ */
387
+ handleRequest(method: string, url: string, headers: Record<string, string>, body?: Record<string, unknown> | null): Promise<[number, Record<string, string>, string]>;
388
+ /**
389
+ * Derive the registered routing-callback path (if any) a URL targets. Mirrors
390
+ * Python's `_callback_path_for_url` — the primitive `handleRequest` recovers
391
+ * the equivalent of the router's `request.state.callback_path` by matching the
392
+ * URL's normalized path against the registered callbacks.
393
+ */
394
+ protected _callbackPathForUrl(url: string): string | null;
395
+ /**
396
+ * Validate HTTP basic-auth from a plain headers dict (the primitive analog of
397
+ * the Hono `basicAuth` middleware). Returns true when auth is not enforced or
398
+ * the provided credentials match.
399
+ */
400
+ protected _checkBasicAuthHeaders(headers: Record<string, string>): Promise<boolean>;
295
401
  /**
296
402
  * Register a custom verb handler.
297
403
  * Mirrors Python's `register_verb_handler()`.
@@ -309,13 +415,21 @@ export declare class SWMLService {
309
415
  * @param path - HTTP path for the callback (default '/sip').
310
416
  */
311
417
  registerRoutingCallback(callbackFn: RoutingCallback, path?: string): void;
418
+ /** The body (for a POST) and headers of a served request. */
419
+ private _readRequest;
420
+ /**
421
+ * The SWML document for a served request: buildSwmlForRequest(), then the
422
+ * setOnRequestCallback() callback, then the service's own document (as
423
+ * Python's _handle_request does).
424
+ */
425
+ private _documentForRequest;
312
426
  /**
313
427
  * Extract the SIP username from a request body's call.to field.
314
428
  * Mirrors Python's `@staticmethod extract_sip_username()`.
315
429
  * @param requestBody - The parsed request body containing call information.
316
430
  * @returns The extracted SIP username, or null if not found.
317
431
  */
318
- static extractSipUsername(requestBody: Record<string, unknown>): string | null;
432
+ static extractSipUsername(requestBody: SwmlRequestData): string | null;
319
433
  /**
320
434
  * Service-side SWML-builder hook. Subclasses return a `SwmlBuilder`
321
435
  * to fully replace the document for this request, or `null` to fall
@@ -353,7 +467,7 @@ export declare class SWMLService {
353
467
  * @returns A tuple of [username, password] or [username, password, source].
354
468
  */
355
469
  getBasicAuthCredentials(includeSource?: false): [string, string];
356
- getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'generated'];
470
+ getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'config file' | 'generated'];
357
471
  /**
358
472
  * Manually set the proxy base URL used for webhook URL generation.
359
473
  * Mirrors Python's `manual_set_proxy_url()`.
@@ -371,21 +485,26 @@ export declare class SWMLService {
371
485
  */
372
486
  getApp(): Hono;
373
487
  /**
374
- * Alias for `getApp()`. Provided for cross-SDK consistency with Python's
375
- * `as_router()` method — allows Python callers porting to TypeScript to use
376
- * the familiar name without changes.
377
- * @returns The configured Hono app.
488
+ * Get a router to embed this service's routes in a host web app.
489
+ *
490
+ * Returns the fully-wired Hono app as a mountable sub-app; the host mounts it
491
+ * with `hostApp.route(path, service.asRouter())`. This is the TypeScript
492
+ * realization of Python's `as_router()`; the named {@link HostAppRouter} type
493
+ * is the cross-port "embed my routes in a host app" contract.
494
+ *
495
+ * @returns A mountable Hono sub-app carrying this service's routes.
378
496
  */
379
- asRouter(): Hono;
497
+ asRouter(): HostAppRouter;
380
498
  /**
381
- * Start the HTTP server.
499
+ * Start the HTTP server. Canonical entrypoint, matching Python's
500
+ * `SWMLService.serve()`.
382
501
  *
383
502
  * Matches Python's `serve()` parameters including SSL options. When
384
503
  * `SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the
385
504
  * `swaig-test` CLI) the call is a no-op.
386
505
  *
387
- * @param host - Hostname. Defaults to `this.host` (constructor value) or
388
- * `'0.0.0.0'`.
506
+ * @param hostOrOpts - Hostname, or an options object. Defaults to `this.host`
507
+ * (constructor value) or `'0.0.0.0'`.
389
508
  * @param port - Port. Defaults to `this.port` (constructor value) or `3000`.
390
509
  * @param opts - Optional SSL/TLS configuration overrides.
391
510
  * @param opts.sslCert - Path to the PEM certificate file.
@@ -394,7 +513,7 @@ export declare class SWMLService {
394
513
  * @param opts.domain - Domain used for HSTS header configuration.
395
514
  * @returns Resolves once the server has begun listening.
396
515
  */
397
- run(hostOrOpts?: string | {
516
+ serve(hostOrOpts?: string | {
398
517
  host?: string;
399
518
  port?: number;
400
519
  sslCert?: string;
@@ -407,15 +526,6 @@ export declare class SWMLService {
407
526
  sslEnabled?: boolean;
408
527
  domain?: string;
409
528
  }): Promise<void>;
410
- /**
411
- * Start the HTTP server. Alias for {@link run} provided for cross-SDK
412
- * consistency with Python's `serve()` method — callers porting from
413
- * Python can use this name without changes.
414
- *
415
- * @param args - Forwarded unchanged to {@link run}.
416
- * @returns Resolves once the server has begun listening.
417
- */
418
- serve(...args: Parameters<SWMLService['run']>): Promise<void>;
419
529
  /**
420
530
  * Stop the HTTP server.
421
531
  * Mirrors Python's `stop()`.