@signalwire/sdk 2.0.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 (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,635 @@
1
+ /**
2
+ * SWML Transfer Skill - Transfer calls between agents using SWML with pattern matching.
3
+ *
4
+ * Port of the Python `SWMLTransferSkill`. Supports the Python `transfers`
5
+ * config (regex-keyed dict of per-destination configs with url/address,
6
+ * message, return_message, post_process, final, from_addr) as well as the
7
+ * TypeScript-native `patterns` array of friendly-named destinations.
8
+ *
9
+ * Either configuration shape works; when both are provided `transfers`
10
+ * takes precedence (matching the Python API).
11
+ */
12
+
13
+ import { SkillBase } from '../SkillBase.js';
14
+ import type {
15
+ SkillToolDefinition,
16
+ SkillPromptSection,
17
+ SkillConfig,
18
+ ParameterSchemaEntry,
19
+ } from '../SkillBase.js';
20
+ import { FunctionResult } from '../../FunctionResult.js';
21
+ import { getLogger } from '../../Logger.js';
22
+
23
+ const log = getLogger('SwmlTransferSkill');
24
+
25
+ /** A named transfer destination pattern (TS-style). */
26
+ interface TransferPattern {
27
+ /** Friendly name for the destination. */
28
+ name: string;
29
+ /** SIP URI, phone number, or agent URL to transfer to. */
30
+ destination: string;
31
+ /** Optional description. */
32
+ description?: string;
33
+ /** Optional pre-transfer message override. */
34
+ message?: string;
35
+ /** Optional message shown when returning from the transfer. */
36
+ returnMessage?: string;
37
+ /** Whether to AI-process the message. */
38
+ postProcess?: boolean;
39
+ /** Whether the transfer is permanent (default) or temporary. */
40
+ final?: boolean;
41
+ /** Optional caller-ID override for connect actions. */
42
+ fromAddr?: string;
43
+ }
44
+
45
+ /** Per-destination entry in the Python-style `transfers` map. */
46
+ interface TransferConfig {
47
+ url?: string;
48
+ address?: string;
49
+ message?: string;
50
+ return_message?: string;
51
+ post_process?: boolean;
52
+ final?: boolean;
53
+ from_addr?: string;
54
+ }
55
+
56
+ /**
57
+ * Transfer calls between agents based on pattern matching.
58
+ *
59
+ * Multi-instance capable (distinguished by `tool_name`).
60
+ * Accepts either Python-style `transfers` config (regex → per-entry config)
61
+ * or TypeScript-style `patterns` array of named destinations.
62
+ */
63
+ export class SwmlTransferSkill extends SkillBase {
64
+ // Python ground truth: skills/swml_transfer/skill.py:~60-67
65
+ static override SKILL_NAME = 'swml_transfer';
66
+ static override SKILL_DESCRIPTION = 'Transfer calls between agents based on pattern matching';
67
+ static override SKILL_VERSION = '1.0.0';
68
+ static override REQUIRED_PACKAGES: readonly string[] = [];
69
+ static override REQUIRED_ENV_VARS: readonly string[] = [];
70
+ static override SUPPORTS_MULTIPLE_INSTANCES = true;
71
+
72
+ static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
73
+ return {
74
+ ...super.getParameterSchema(),
75
+ transfers: {
76
+ type: 'object',
77
+ description:
78
+ 'Transfer configurations mapping patterns (regex or name) to destination configs. Each value has either url or address, plus optional message/return_message/post_process/final/from_addr.',
79
+ required: true,
80
+ },
81
+ patterns: {
82
+ type: 'array',
83
+ description:
84
+ 'Array of named transfer patterns: { name, destination, description?, message?, returnMessage?, postProcess?, final?, fromAddr? }.',
85
+ required: false,
86
+ items: { type: 'object' },
87
+ },
88
+ allow_arbitrary: {
89
+ type: 'boolean',
90
+ description:
91
+ 'Whether to allow transfers to arbitrary destinations not in patterns list.',
92
+ required: false,
93
+ },
94
+ tool_name: {
95
+ type: 'string',
96
+ description: 'Name of the transfer tool exposed to the AI.',
97
+ default: 'transfer_call',
98
+ required: false,
99
+ },
100
+ description: {
101
+ type: 'string',
102
+ description: 'Description for the transfer tool',
103
+ default: 'Transfer call based on pattern matching',
104
+ required: false,
105
+ },
106
+ parameter_name: {
107
+ type: 'string',
108
+ description: 'Name of the parameter that accepts the transfer type',
109
+ default: 'transfer_type',
110
+ required: false,
111
+ },
112
+ parameter_description: {
113
+ type: 'string',
114
+ description: 'Description for the transfer type parameter',
115
+ default: 'The type of transfer to perform',
116
+ required: false,
117
+ },
118
+ default_message: {
119
+ type: 'string',
120
+ description: 'Message when no pattern matches',
121
+ default: 'Please specify a valid transfer type.',
122
+ required: false,
123
+ },
124
+ default_post_process: {
125
+ type: 'boolean',
126
+ description: 'Whether to process default message with AI',
127
+ default: false,
128
+ required: false,
129
+ },
130
+ required_fields: {
131
+ type: 'object',
132
+ description:
133
+ 'Additional required fields to collect before transfer (name -> description).',
134
+ default: {},
135
+ required: false,
136
+ },
137
+ };
138
+ }
139
+
140
+ // Runtime state
141
+ private transfers: Record<string, TransferConfig> = {};
142
+ private patterns: TransferPattern[] = [];
143
+ private toolName = 'transfer_call';
144
+ private toolDescription = 'Transfer call based on pattern matching';
145
+ private parameterName = 'transfer_type';
146
+ private parameterDescription = 'The type of transfer to perform';
147
+ private defaultMessage = 'Please specify a valid transfer type.';
148
+ private defaultPostProcess = false;
149
+ private requiredFields: Record<string, string> = {};
150
+ private allowArbitraryOverride: boolean | undefined;
151
+
152
+ override getInstanceKey(): string {
153
+ const toolName = this.getConfig<string>('tool_name', 'transfer_call');
154
+ return `${this.skillName}_${toolName}`;
155
+ }
156
+
157
+ override async setup(): Promise<boolean> {
158
+ this.toolName = this.getConfig<string>('tool_name', 'transfer_call');
159
+ this.toolDescription = this.getConfig<string>(
160
+ 'description',
161
+ 'Transfer call based on pattern matching',
162
+ );
163
+ this.parameterName = this.getConfig<string>('parameter_name', 'transfer_type');
164
+ this.parameterDescription = this.getConfig<string>(
165
+ 'parameter_description',
166
+ 'The type of transfer to perform',
167
+ );
168
+ this.defaultMessage = this.getConfig<string>(
169
+ 'default_message',
170
+ 'Please specify a valid transfer type.',
171
+ );
172
+ this.defaultPostProcess = this.getConfig<boolean>('default_post_process', false);
173
+ this.requiredFields =
174
+ this.getConfig<Record<string, string>>('required_fields', {}) ?? {};
175
+ this.allowArbitraryOverride = this.getConfig<boolean | undefined>(
176
+ 'allow_arbitrary',
177
+ undefined,
178
+ );
179
+
180
+ // Python-style `transfers` config
181
+ const transfers =
182
+ this.getConfig<Record<string, TransferConfig>>('transfers', {}) ?? {};
183
+ this.transfers = {};
184
+ for (const [pattern, rawConfig] of Object.entries(transfers)) {
185
+ if (!rawConfig || typeof rawConfig !== 'object') {
186
+ log.error('swml_transfer: transfer config is not an object', { pattern });
187
+ continue;
188
+ }
189
+ const config = { ...rawConfig };
190
+ if (!('url' in config) && !('address' in config)) {
191
+ log.error(
192
+ 'swml_transfer: transfer config must include either url or address',
193
+ { pattern },
194
+ );
195
+ continue;
196
+ }
197
+ if ('url' in config && 'address' in config) {
198
+ log.error(
199
+ 'swml_transfer: transfer config cannot have both url and address',
200
+ { pattern },
201
+ );
202
+ continue;
203
+ }
204
+ if (config.message === undefined) config.message = 'Transferring you now...';
205
+ if (config.return_message === undefined)
206
+ config.return_message = 'The transfer is complete. How else can I help you?';
207
+ if (config.post_process === undefined) config.post_process = true;
208
+ if (config.final === undefined) config.final = true;
209
+ this.transfers[pattern] = config;
210
+ }
211
+
212
+ // TS-style patterns array
213
+ this.patterns = this.getConfig<TransferPattern[]>('patterns', []) ?? [];
214
+
215
+ // Python parity (skills/swml_transfer/skill.py:132-136): setup() returns
216
+ // false when `transfers` is absent. TS additionally supports a `patterns`
217
+ // config shape, so accept either — but not neither, otherwise the skill
218
+ // registers a transfer tool that matches nothing and always falls back.
219
+ if (
220
+ Object.keys(this.transfers).length === 0 &&
221
+ this.patterns.length === 0
222
+ ) {
223
+ log.error(
224
+ 'swml_transfer: at least one of "transfers" or "patterns" must be configured',
225
+ );
226
+ return false;
227
+ }
228
+ return true;
229
+ }
230
+
231
+ override getHints(): string[] {
232
+ const hints: string[] = [];
233
+
234
+ // Extract words from regex patterns (Python-style)
235
+ for (const pattern of Object.keys(this.transfers)) {
236
+ let clean = pattern;
237
+ if (clean.startsWith('/')) clean = clean.slice(1);
238
+ if (clean.endsWith('/')) clean = clean.slice(0, -1);
239
+ else if (clean.endsWith('/i')) clean = clean.slice(0, -2);
240
+
241
+ if (clean && !clean.startsWith('.')) {
242
+ if (clean.includes('|')) {
243
+ for (const part of clean.split('|')) {
244
+ hints.push(part.trim().toLowerCase());
245
+ }
246
+ } else {
247
+ hints.push(clean.toLowerCase());
248
+ }
249
+ }
250
+ }
251
+
252
+ // Extract friendly names from patterns
253
+ for (const p of this.patterns) {
254
+ if (p && p.name) hints.push(p.name.toLowerCase());
255
+ }
256
+
257
+ hints.push('transfer', 'connect', 'speak to', 'talk to');
258
+ return hints;
259
+ }
260
+
261
+ /** @returns A `transfer_call` tool, plus `list_transfer_destinations` when patterns are configured. */
262
+ getTools(): SkillToolDefinition[] {
263
+ // Rehydrate config for cases where getTools is called without setup()
264
+ const toolName = this.toolName !== 'transfer_call'
265
+ ? this.toolName
266
+ : this.getConfig<string>('tool_name', 'transfer_call');
267
+ const toolDescription = this.getConfig<string>(
268
+ 'description',
269
+ this.toolDescription,
270
+ );
271
+ const parameterName = this.getConfig<string>(
272
+ 'parameter_name',
273
+ this.parameterName,
274
+ );
275
+ const parameterDescription = this.getConfig<string>(
276
+ 'parameter_description',
277
+ this.parameterDescription,
278
+ );
279
+ const defaultMessage = this.getConfig<string>(
280
+ 'default_message',
281
+ this.defaultMessage,
282
+ );
283
+ const defaultPostProcess = this.getConfig<boolean>(
284
+ 'default_post_process',
285
+ this.defaultPostProcess,
286
+ );
287
+ const requiredFields =
288
+ this.getConfig<Record<string, string>>('required_fields', this.requiredFields) ?? {};
289
+ const transfers =
290
+ Object.keys(this.transfers).length > 0
291
+ ? this.transfers
292
+ : this.getConfig<Record<string, TransferConfig>>('transfers', {}) ?? {};
293
+ const patterns =
294
+ this.patterns.length > 0
295
+ ? this.patterns
296
+ : this.getConfig<TransferPattern[]>('patterns', []) ?? [];
297
+ const allowArbitrary = this.getConfig<boolean | undefined>(
298
+ 'allow_arbitrary',
299
+ this.allowArbitraryOverride,
300
+ );
301
+ const canUseArbitrary =
302
+ allowArbitrary !== undefined
303
+ ? allowArbitrary
304
+ : patterns.length === 0 && Object.keys(transfers).length === 0;
305
+
306
+ // Build tool parameters — include required_fields + primary destination param.
307
+ // Python's DataMap does NOT expose a `message` param to the AI
308
+ // (skill.py:227-236). Match that: the pre-transfer message is driven
309
+ // entirely by per-config defaults, not by AI override at call time.
310
+ const parameters: Record<string, unknown> = {
311
+ [parameterName]: {
312
+ type: 'string',
313
+ description: parameterDescription,
314
+ },
315
+ };
316
+ const required = [parameterName];
317
+ for (const [fieldName, fieldDescription] of Object.entries(requiredFields)) {
318
+ parameters[fieldName] = {
319
+ type: 'string',
320
+ description: fieldDescription,
321
+ };
322
+ required.push(fieldName);
323
+ }
324
+
325
+ // Pattern map for TS-style destinations (friendly-name lookup)
326
+ const patternMap = new Map<string, TransferPattern>();
327
+ for (const p of patterns) {
328
+ patternMap.set(p.name.toLowerCase(), p);
329
+ }
330
+
331
+ // Compile regex entries from Python-style transfers config.
332
+ // Flag semantics match the platform regex engine (skill.py:245-258):
333
+ // - /pattern/i → case-insensitive
334
+ // - /pattern/ → case-sensitive (bare closing delimiter)
335
+ // - pattern → case-sensitive (no delimiters)
336
+ // Previously TS defaulted to 'i' regardless, silently changing routing
337
+ // semantics for configs ported from Python.
338
+ const compiledTransfers: Array<{ regex: RegExp; raw: string; config: TransferConfig }> = [];
339
+ for (const [patternKey, config] of Object.entries(transfers)) {
340
+ let body = patternKey;
341
+ let flags = '';
342
+ if (body.startsWith('/')) body = body.slice(1);
343
+ if (body.endsWith('/i')) {
344
+ flags = 'i';
345
+ body = body.slice(0, -2);
346
+ } else if (body.endsWith('/')) {
347
+ // bare closing delimiter — Python matches case-sensitively
348
+ body = body.slice(0, -1);
349
+ }
350
+ try {
351
+ compiledTransfers.push({
352
+ regex: new RegExp(body, flags),
353
+ raw: patternKey,
354
+ config,
355
+ });
356
+ } catch (err) {
357
+ log.error('swml_transfer: invalid transfer pattern', {
358
+ pattern: patternKey,
359
+ error: err instanceof Error ? err.message : String(err),
360
+ });
361
+ }
362
+ }
363
+
364
+ const description = this._buildTransferDescription(
365
+ toolDescription,
366
+ patterns,
367
+ transfers,
368
+ canUseArbitrary,
369
+ );
370
+
371
+ const tools: SkillToolDefinition[] = [
372
+ {
373
+ name: toolName,
374
+ description,
375
+ parameters,
376
+ required,
377
+ handler: (args: Record<string, unknown>, _rawData: Record<string, unknown>) => {
378
+ const rawDest = args[parameterName];
379
+
380
+ if (typeof rawDest !== 'string' || rawDest.trim().length === 0) {
381
+ return new FunctionResult('Please specify a destination for the transfer.');
382
+ }
383
+ const destination = rawDest.trim();
384
+
385
+ // Build call_data for required fields. Python's DataMap template
386
+ // always emits every required_fields key (platform fills missing
387
+ // with empty string). Match that: include the key even when the
388
+ // AI didn't supply it, using the empty string as the fallback.
389
+ const callData: Record<string, unknown> = {};
390
+ for (const fieldName of Object.keys(requiredFields)) {
391
+ callData[fieldName] = fieldName in args ? args[fieldName] : '';
392
+ }
393
+
394
+ // 1. Try Python-style transfers (regex match)
395
+ for (const entry of compiledTransfers) {
396
+ if (entry.regex.test(destination)) {
397
+ return this._buildTransferResult(
398
+ entry.config,
399
+ undefined,
400
+ callData,
401
+ );
402
+ }
403
+ }
404
+
405
+ // 2. Try TS-style named patterns
406
+ const matchedPattern = patternMap.get(destination.toLowerCase());
407
+ if (matchedPattern) {
408
+ return this._buildPatternResult(
409
+ matchedPattern,
410
+ 'Transferring you now...',
411
+ callData,
412
+ );
413
+ }
414
+
415
+ // 3. Arbitrary destinations
416
+ if (canUseArbitrary) {
417
+ const msg = 'Transferring you now...';
418
+ const result = new FunctionResult(msg);
419
+ result.swmlTransfer(destination, msg, true);
420
+ if (Object.keys(callData).length > 0) {
421
+ result.updateGlobalData({ call_data: callData });
422
+ }
423
+ return result;
424
+ }
425
+
426
+ // 4. No match — return fallback message
427
+ const fallback = new FunctionResult(defaultMessage);
428
+ fallback.postProcess = defaultPostProcess;
429
+ if (Object.keys(callData).length > 0) {
430
+ fallback.updateGlobalData({ call_data: callData });
431
+ }
432
+ return fallback;
433
+ },
434
+ },
435
+ ];
436
+
437
+ if (patterns.length > 0) {
438
+ tools.push({
439
+ name: 'list_transfer_destinations',
440
+ description:
441
+ 'List all available named transfer destinations that calls can be routed to.',
442
+ parameters: {},
443
+ handler: () => {
444
+ const lines = patterns.map((p) => {
445
+ const desc = p.description ? ` - ${p.description}` : '';
446
+ return `${p.name}${desc}`;
447
+ });
448
+ return new FunctionResult(
449
+ `Available transfer destinations:\n${lines.join('\n')}`,
450
+ );
451
+ },
452
+ });
453
+ }
454
+
455
+ return tools;
456
+ }
457
+
458
+ protected override _getPromptSections(): SkillPromptSection[] {
459
+ const toolName = this.getConfig<string>('tool_name', this.toolName);
460
+ const parameterName = this.getConfig<string>(
461
+ 'parameter_name',
462
+ this.parameterName,
463
+ );
464
+ const transfers =
465
+ Object.keys(this.transfers).length > 0
466
+ ? this.transfers
467
+ : this.getConfig<Record<string, TransferConfig>>('transfers', {}) ?? {};
468
+ const patterns =
469
+ this.patterns.length > 0
470
+ ? this.patterns
471
+ : this.getConfig<TransferPattern[]>('patterns', []) ?? [];
472
+ const requiredFields =
473
+ this.getConfig<Record<string, string>>('required_fields', this.requiredFields) ?? {};
474
+ const allowArbitrary = this.getConfig<boolean | undefined>(
475
+ 'allow_arbitrary',
476
+ this.allowArbitraryOverride,
477
+ );
478
+ const canUseArbitrary =
479
+ allowArbitrary !== undefined
480
+ ? allowArbitrary
481
+ : patterns.length === 0 && Object.keys(transfers).length === 0;
482
+
483
+ const sections: SkillPromptSection[] = [];
484
+
485
+ // Build "Transferring" section with destinations
486
+ const transferBullets: string[] = [];
487
+
488
+ for (const [patternKey, config] of Object.entries(transfers)) {
489
+ let clean = patternKey;
490
+ if (clean.startsWith('/')) clean = clean.slice(1);
491
+ if (clean.endsWith('/')) clean = clean.slice(0, -1);
492
+ else if (clean.endsWith('/i')) clean = clean.slice(0, -2);
493
+
494
+ if (clean && !clean.startsWith('.')) {
495
+ const destination = config.url ?? config.address ?? '';
496
+ transferBullets.push(`"${clean}" - transfers to ${destination}`);
497
+ }
498
+ }
499
+
500
+ for (const p of patterns) {
501
+ const desc = p.description ? ` - ${p.description}` : ` - transfers to ${p.destination}`;
502
+ transferBullets.push(`"${p.name}"${desc}`);
503
+ }
504
+
505
+ if (transferBullets.length > 0) {
506
+ sections.push({
507
+ title: 'Transferring',
508
+ body: `You can transfer calls using the ${toolName} function with the following destinations:`,
509
+ bullets: transferBullets,
510
+ });
511
+
512
+ const instructionBullets: string[] = [
513
+ `Use the ${toolName} function when a transfer is needed`,
514
+ `Pass the destination type to the '${parameterName}' parameter`,
515
+ ];
516
+
517
+ if (Object.keys(requiredFields).length > 0) {
518
+ instructionBullets.push(
519
+ 'You must provide the following information before transferring:',
520
+ );
521
+ for (const [fieldName, description] of Object.entries(requiredFields)) {
522
+ instructionBullets.push(` - ${fieldName}: ${description}`);
523
+ }
524
+ instructionBullets.push(
525
+ "All required information will be saved under 'call_data' for the next agent",
526
+ );
527
+ }
528
+
529
+ if (canUseArbitrary) {
530
+ instructionBullets.push(
531
+ 'You can also transfer to arbitrary phone numbers or SIP URIs.',
532
+ );
533
+ }
534
+
535
+ instructionBullets.push(
536
+ 'The system will match patterns and handle the transfer automatically',
537
+ "After transfer completes, you'll regain control of the conversation",
538
+ );
539
+
540
+ sections.push({
541
+ title: 'Transfer Instructions',
542
+ body: 'How to use the transfer capability:',
543
+ bullets: instructionBullets,
544
+ });
545
+ }
546
+ // Python skills/swml_transfer/skill.py:297-358 returns [] when there are
547
+ // no transfers — no prompt injection for an unconfigured skill. Previously
548
+ // TS emitted a generic "Call Transfer" section here that Python would
549
+ // suppress, creating AI prompt drift for identical configs.
550
+
551
+ return sections;
552
+ }
553
+
554
+ // ---------------------------------------------------------------------------
555
+ // Internal helpers
556
+ // ---------------------------------------------------------------------------
557
+
558
+ /** Build a FunctionResult for a Python-style TransferConfig. */
559
+ private _buildTransferResult(
560
+ config: TransferConfig,
561
+ messageOverride: string | undefined,
562
+ callData: Record<string, unknown>,
563
+ ): FunctionResult {
564
+ const message = messageOverride ?? config.message ?? 'Transferring you now...';
565
+ const returnMessage =
566
+ config.return_message ?? 'The transfer is complete. How else can I help you?';
567
+ const postProcess = config.post_process ?? true;
568
+ const final = config.final ?? true;
569
+
570
+ const result = new FunctionResult(message, postProcess);
571
+ if (Object.keys(callData).length > 0) {
572
+ result.updateGlobalData({ call_data: callData });
573
+ }
574
+
575
+ if (config.url) {
576
+ result.swmlTransfer(config.url, returnMessage, final);
577
+ } else if (config.address) {
578
+ result.connect(config.address, final, config.from_addr);
579
+ }
580
+ return result;
581
+ }
582
+
583
+ /** Build a FunctionResult for a TS-style named TransferPattern. */
584
+ private _buildPatternResult(
585
+ pattern: TransferPattern,
586
+ message: string,
587
+ callData: Record<string, unknown>,
588
+ ): FunctionResult {
589
+ const returnMessage =
590
+ pattern.returnMessage ?? 'The transfer is complete. How else can I help you?';
591
+ const postProcess = pattern.postProcess ?? true;
592
+ const final = pattern.final ?? true;
593
+
594
+ const result = new FunctionResult(message, postProcess);
595
+ if (Object.keys(callData).length > 0) {
596
+ result.updateGlobalData({ call_data: callData });
597
+ }
598
+
599
+ // If destination looks like a URL, use swmlTransfer; otherwise use connect
600
+ if (/^https?:\/\//i.test(pattern.destination)) {
601
+ result.swmlTransfer(pattern.destination, returnMessage, final);
602
+ } else {
603
+ result.connect(pattern.destination, final, pattern.fromAddr);
604
+ }
605
+ return result;
606
+ }
607
+
608
+ private _buildTransferDescription(
609
+ baseDescription: string,
610
+ patterns: TransferPattern[],
611
+ transfers: Record<string, TransferConfig>,
612
+ canUseArbitrary: boolean,
613
+ ): string {
614
+ const names = [
615
+ ...Object.keys(transfers).map((k) => `"${k}"`),
616
+ ...patterns.map((p) => `"${p.name}"`),
617
+ ];
618
+ if (names.length === 0) {
619
+ return baseDescription;
620
+ }
621
+ const base = `${baseDescription}. Named destinations: ${names.join(', ')}.`;
622
+ return canUseArbitrary
623
+ ? `${base} You may also use arbitrary phone numbers or SIP URIs.`
624
+ : base;
625
+ }
626
+ }
627
+
628
+ /**
629
+ * Factory function for creating SwmlTransferSkill instances.
630
+ * @param config - Optional skill configuration.
631
+ * @returns A new SwmlTransferSkill instance.
632
+ */
633
+ export function createSkill(config?: SkillConfig): SwmlTransferSkill {
634
+ return new SwmlTransferSkill(config);
635
+ }