@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,595 @@
1
+ # DataMap Guide
2
+
3
+ Comprehensive guide to the `DataMap` class in the SignalWire AI Agents TypeScript SDK.
4
+
5
+ ---
6
+
7
+ ## Table of Contents
8
+
9
+ - [Overview](#overview)
10
+ - [Creating a DataMap](#creating-a-datamap)
11
+ - [Configuration](#configuration)
12
+ - [purpose / description](#purpose--description)
13
+ - [parameter](#parameter)
14
+ - [Webhooks](#webhooks)
15
+ - [webhook](#webhook)
16
+ - [body](#body)
17
+ - [params](#params)
18
+ - [Webhook Headers](#webhook-headers)
19
+ - [Expressions](#expressions)
20
+ - [expression](#expression)
21
+ - [Response Processing](#response-processing)
22
+ - [output](#output)
23
+ - [webhookExpressions](#webhookexpressions)
24
+ - [Error Handling](#error-handling)
25
+ - [fallbackOutput](#fallbackoutput)
26
+ - [errorKeys](#errorkeys)
27
+ - [globalErrorKeys](#globalerrorkeys)
28
+ - [Iteration](#iteration)
29
+ - [foreach](#foreach)
30
+ - [Environment Variables](#environment-variables)
31
+ - [enableEnvExpansion](#enableenvexpansion)
32
+ - [Registration](#registration)
33
+ - [registerWithAgent](#registerwithagent)
34
+ - [toSwaigFunction](#toswaigfunction)
35
+ - [Helper Functions](#helper-functions)
36
+ - [createSimpleApiTool](#createsimpleapitool)
37
+ - [createExpressionTool](#createexpressiontool)
38
+ - [Template Variables Reference](#template-variables-reference)
39
+ - [Complete Examples](#complete-examples)
40
+
41
+ ---
42
+
43
+ ## Overview
44
+
45
+ `DataMap` creates server-side tool definitions that execute entirely on the SignalWire platform without requiring your own webhook endpoints for the tool handler. Instead of writing a handler function that runs on your server, you describe what HTTP call to make (or what expression to evaluate), how to process the response, and what to return to the AI -- all as configuration.
46
+
47
+ ### When to use DataMap vs. defineTool
48
+
49
+ | Feature | `defineTool()` | `DataMap` |
50
+ |--------------------|--------------------------------------------|-------------------------------------------------|
51
+ | Execution location | Your server | SignalWire platform |
52
+ | Custom logic | Full TypeScript/JavaScript | Template variables and pattern matching |
53
+ | External API calls | You make them in your handler | SignalWire makes them for you |
54
+ | Webhook required | Yes (your agent server must be reachable) | No (the data_map config is embedded in SWML) |
55
+ | Best for | Complex logic, database access, auth flows | Simple API lookups, pattern matching, transforms |
56
+
57
+ ### How it works
58
+
59
+ 1. You define a `DataMap` with a name, parameters, and either webhooks or expressions.
60
+ 2. You register it with an agent via `registerWithAgent()` or `toSwaigFunction()`.
61
+ 3. When the AI decides to call this tool, SignalWire executes the data_map configuration directly:
62
+ - For **webhooks**: SignalWire makes the HTTP request, processes the response through your output template, and returns the result to the AI.
63
+ - For **expressions**: SignalWire evaluates the test value against the regex pattern and returns the matching output.
64
+
65
+ ### Architecture
66
+
67
+ ```
68
+ Caller <-> SignalWire AI <-> DataMap (runs on SignalWire)
69
+ |
70
+ +--> External API (optional webhook call)
71
+ ```
72
+
73
+ No traffic flows to your server for DataMap tool invocations. Your server only serves the initial SWML document that contains the data_map configuration.
74
+
75
+ ---
76
+
77
+ ## Creating a DataMap
78
+
79
+ The `DataMap` constructor takes a single argument: the function name.
80
+
81
+ ```typescript
82
+ import { DataMap, FunctionResult } from '@signalwire/sdk';
83
+
84
+ const tool = new DataMap('get_weather');
85
+ ```
86
+
87
+ All subsequent configuration is done via fluent method chaining:
88
+
89
+ ```typescript
90
+ const tool = new DataMap('get_weather')
91
+ .purpose('Get current weather for a city')
92
+ .parameter('city', 'string', 'The city name', { required: true })
93
+ .webhook('GET', 'https://wttr.in/${lc:args.city}?format=j1')
94
+ .output(new FunctionResult('Temperature: ${response.temp_F}F'))
95
+ .fallbackOutput(new FunctionResult('Weather data unavailable.'));
96
+ ```
97
+
98
+ ---
99
+
100
+ ## Configuration
101
+
102
+ ### purpose / description
103
+
104
+ Set the tool description shown to the AI. Both methods are aliases.
105
+
106
+ ```typescript
107
+ purpose(desc: string): this
108
+ description(desc: string): this
109
+ ```
110
+
111
+ ```typescript
112
+ const tool = new DataMap('get_weather')
113
+ .purpose('Look up current weather conditions for a location');
114
+ ```
115
+
116
+ ---
117
+
118
+ ### parameter
119
+
120
+ Add a parameter the AI should extract from the conversation.
121
+
122
+ ```typescript
123
+ parameter(
124
+ name: string,
125
+ type: string,
126
+ description: string,
127
+ opts?: { required?: boolean; enum?: string[] },
128
+ ): this
129
+ ```
130
+
131
+ | Argument | Type | Description |
132
+ |----------|------|-------------|
133
+ | `name` | `string` | Parameter name. |
134
+ | `type` | `string` | JSON Schema type (`string`, `number`, `boolean`, etc.). |
135
+ | `description` | `string` | Description shown to the AI. |
136
+ | `opts.required` | `boolean` | Whether the parameter is required. |
137
+ | `opts.enum` | `string[]` | Allowed values. |
138
+
139
+ ```typescript
140
+ const tool = new DataMap('classify_ticket')
141
+ .parameter('description', 'string', 'Ticket description', { required: true })
142
+ .parameter('priority', 'string', 'Priority level', {
143
+ enum: ['low', 'medium', 'high', 'critical'],
144
+ });
145
+ ```
146
+
147
+ ---
148
+
149
+ ## Webhooks
150
+
151
+ ### webhook
152
+
153
+ Configure an HTTP request that SignalWire will make when the tool is invoked.
154
+
155
+ ```typescript
156
+ webhook(
157
+ method: string,
158
+ url: string,
159
+ opts?: { headers?: Record<string, string> },
160
+ ): this
161
+ ```
162
+
163
+ | Argument | Type | Description |
164
+ |----------|------|-------------|
165
+ | `method` | `string` | HTTP method (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`). |
166
+ | `url` | `string` | URL with template variable expansion. |
167
+ | `opts.headers` | `Record<string, string>` | Request headers. |
168
+
169
+ ```typescript
170
+ // Simple GET
171
+ const tool = new DataMap('lookup_order')
172
+ .webhook('GET', 'https://api.example.com/orders/${args.order_id}');
173
+
174
+ // POST with headers
175
+ const tool2 = new DataMap('create_ticket')
176
+ .webhook('POST', 'https://api.example.com/tickets', {
177
+ headers: {
178
+ 'Content-Type': 'application/json',
179
+ 'Authorization': 'Bearer ${ENV.API_TOKEN}',
180
+ },
181
+ });
182
+ ```
183
+
184
+ ---
185
+
186
+ ### body
187
+
188
+ Set the request body for POST/PUT/PATCH webhooks.
189
+
190
+ ```typescript
191
+ body(body: Record<string, unknown>): this
192
+ ```
193
+
194
+ ```typescript
195
+ const tool = new DataMap('create_ticket')
196
+ .webhook('POST', 'https://api.example.com/tickets')
197
+ .body({
198
+ title: '${args.title}',
199
+ description: '${args.description}',
200
+ priority: '${args.priority}',
201
+ });
202
+ ```
203
+
204
+ ---
205
+
206
+ ### params
207
+
208
+ Set query parameters appended to the webhook URL.
209
+
210
+ ```typescript
211
+ params(params: Record<string, string>): this
212
+ ```
213
+
214
+ ```typescript
215
+ const tool = new DataMap('search')
216
+ .webhook('GET', 'https://api.example.com/search')
217
+ .params({
218
+ q: '${args.query}',
219
+ limit: '10',
220
+ });
221
+ ```
222
+
223
+ ---
224
+
225
+ ### Webhook Headers
226
+
227
+ Headers can include template variables:
228
+
229
+ ```typescript
230
+ const tool = new DataMap('secure_lookup')
231
+ .webhook('GET', 'https://api.example.com/data/${args.id}', {
232
+ headers: {
233
+ 'Authorization': 'Bearer ${ENV.API_KEY}',
234
+ 'X-Request-ID': '${meta_data.call_id}',
235
+ },
236
+ })
237
+ .enableEnvExpansion();
238
+ ```
239
+
240
+ ---
241
+
242
+ ## Expressions
243
+
244
+ ### expression
245
+
246
+ Add a pattern-matching expression evaluated against template variables. Expressions are evaluated in order; the first match wins.
247
+
248
+ ```typescript
249
+ expression(testValue: string, pattern: string, output: FunctionResult): this
250
+ ```
251
+
252
+ | Argument | Type | Description |
253
+ |----------|------|-------------|
254
+ | `testValue` | `string` | Template string to evaluate (e.g., `${args.input}`). |
255
+ | `pattern` | `string` | Regular expression pattern to match against. |
256
+ | `output` | `FunctionResult` | Result to return when the pattern matches. |
257
+
258
+ ```typescript
259
+ const tool = new DataMap('classify')
260
+ .parameter('sentiment', 'string', 'User sentiment')
261
+ .expression('${args.sentiment}', '(happy|satisfied|great)', new FunctionResult('Positive sentiment detected.'))
262
+ .expression('${args.sentiment}', '(angry|upset|frustrated)', new FunctionResult('Negative sentiment detected.'))
263
+ .expression('${args.sentiment}', '.*', new FunctionResult('Neutral sentiment.'));
264
+ ```
265
+
266
+ ---
267
+
268
+ ## Response Processing
269
+
270
+ ### output
271
+
272
+ Set the output template for successful webhook responses. Template variables like `${response.field}` are expanded from the webhook response JSON.
273
+
274
+ ```typescript
275
+ output(result: FunctionResult): this
276
+ ```
277
+
278
+ ```typescript
279
+ const tool = new DataMap('get_weather')
280
+ .webhook('GET', 'https://api.weather.com/current?q=${args.city}')
281
+ .output(new FunctionResult(
282
+ 'The weather in ${args.city} is ${response.temp}F and ${response.condition}.',
283
+ ));
284
+ ```
285
+
286
+ ---
287
+
288
+ ### webhookExpressions
289
+
290
+ Add pattern-matching expressions evaluated against the webhook response.
291
+
292
+ ```typescript
293
+ webhookExpressions(
294
+ expressions: Array<{ pattern: string; output: FunctionResult }>,
295
+ ): this
296
+ ```
297
+
298
+ ```typescript
299
+ const tool = new DataMap('check_status')
300
+ .webhook('GET', 'https://api.example.com/status/${args.id}')
301
+ .webhookExpressions([
302
+ {
303
+ pattern: 'shipped',
304
+ output: new FunctionResult('Your order has been shipped!'),
305
+ },
306
+ {
307
+ pattern: 'processing',
308
+ output: new FunctionResult('Your order is still being processed.'),
309
+ },
310
+ ]);
311
+ ```
312
+
313
+ ---
314
+
315
+ ## Error Handling
316
+
317
+ ### fallbackOutput
318
+
319
+ Set the output to return when all webhooks fail or return errors.
320
+
321
+ ```typescript
322
+ fallbackOutput(result: FunctionResult): this
323
+ ```
324
+
325
+ ```typescript
326
+ const tool = new DataMap('lookup')
327
+ .webhook('GET', 'https://api.example.com/data/${args.id}')
328
+ .output(new FunctionResult('Result: ${response.value}'))
329
+ .fallbackOutput(new FunctionResult('Sorry, I could not look that up right now.'));
330
+ ```
331
+
332
+ ---
333
+
334
+ ### errorKeys
335
+
336
+ Specify keys in the response that indicate an error condition. If any of these keys are present and truthy, the fallback output is used.
337
+
338
+ ```typescript
339
+ errorKeys(keys: string[]): this
340
+ ```
341
+
342
+ ```typescript
343
+ const tool = new DataMap('api_call')
344
+ .webhook('GET', 'https://api.example.com/data')
345
+ .errorKeys(['error', 'err_msg'])
346
+ .output(new FunctionResult('${response.data}'))
347
+ .fallbackOutput(new FunctionResult('API returned an error.'));
348
+ ```
349
+
350
+ ---
351
+
352
+ ### globalErrorKeys
353
+
354
+ Specify global error keys checked across all webhook responses.
355
+
356
+ ```typescript
357
+ globalErrorKeys(keys: string[]): this
358
+ ```
359
+
360
+ ---
361
+
362
+ ## Iteration
363
+
364
+ ### foreach
365
+
366
+ Iterate over an array in the webhook response and format each element.
367
+
368
+ ```typescript
369
+ foreach(arrayPath: string, template: string): this
370
+ ```
371
+
372
+ | Argument | Type | Description |
373
+ |----------|------|-------------|
374
+ | `arrayPath` | `string` | Dot-path to the array in the response (e.g., `response.items`). |
375
+ | `template` | `string` | Template string applied to each element. |
376
+
377
+ ```typescript
378
+ const tool = new DataMap('list_orders')
379
+ .webhook('GET', 'https://api.example.com/orders?customer=${args.customer_id}')
380
+ .foreach('response.orders', 'Order ${this.id}: ${this.status} - $${this.total}')
381
+ .output(new FunctionResult('Your orders: ${foreach_output}'));
382
+ ```
383
+
384
+ ---
385
+
386
+ ## Environment Variables
387
+
388
+ ### enableEnvExpansion
389
+
390
+ Enable `${ENV.VAR_NAME}` expansion in template strings. This allows webhook URLs, headers, and body templates to reference server-side environment variables that are expanded at SWML rendering time.
391
+
392
+ ```typescript
393
+ enableEnvExpansion(): this
394
+ ```
395
+
396
+ ```typescript
397
+ const tool = new DataMap('secure_api')
398
+ .webhook('GET', 'https://api.example.com/data', {
399
+ headers: { 'Authorization': 'Bearer ${ENV.API_KEY}' },
400
+ })
401
+ .enableEnvExpansion();
402
+ ```
403
+
404
+ **Security:** Use `setAllowedEnvPrefixes()` to restrict which environment variable prefixes can be expanded:
405
+
406
+ ```typescript
407
+ import { setAllowedEnvPrefixes } from '@signalwire/sdk';
408
+
409
+ // Only allow env vars starting with MY_APP_ or API_
410
+ setAllowedEnvPrefixes(['MY_APP_', 'API_']);
411
+ ```
412
+
413
+ ---
414
+
415
+ ## Registration
416
+
417
+ ### registerWithAgent
418
+
419
+ Register this DataMap tool with an `AgentBase` instance. The tool is serialized as a raw dictionary in the agent's tool registry.
420
+
421
+ ```typescript
422
+ registerWithAgent(agent: AgentBase): void
423
+ ```
424
+
425
+ ```typescript
426
+ const tool = new DataMap('get_weather')
427
+ .purpose('Look up weather')
428
+ .parameter('city', 'string', 'City name')
429
+ .webhook('GET', 'https://api.weather.com/current?q=${args.city}')
430
+ .output(new FunctionResult('${response.temp}F'));
431
+
432
+ tool.registerWithAgent(agent);
433
+ ```
434
+
435
+ ---
436
+
437
+ ### toSwaigFunction
438
+
439
+ Serialize the DataMap to the SWAIG wire format as a plain object. This is called internally by `registerWithAgent()` but can be used directly for custom registration.
440
+
441
+ ```typescript
442
+ toSwaigFunction(): Record<string, unknown>
443
+ ```
444
+
445
+ ```typescript
446
+ const rawDef = tool.toSwaigFunction();
447
+ agent.registerSwaigFunction(rawDef);
448
+ ```
449
+
450
+ ---
451
+
452
+ ## Helper Functions
453
+
454
+ ### createSimpleApiTool
455
+
456
+ Create a DataMap tool that makes a single GET request and formats the response.
457
+
458
+ ```typescript
459
+ import { createSimpleApiTool } from '@signalwire/sdk';
460
+
461
+ const tool = createSimpleApiTool({
462
+ name: 'get_joke',
463
+ description: 'Get a random joke',
464
+ url: 'https://api.example.com/joke',
465
+ responseTemplate: 'Here is a joke: ${joke}',
466
+ fallbackTemplate: 'Sorry, I could not find a joke.',
467
+ parameters: {
468
+ category: { type: 'string', description: 'Joke category' },
469
+ },
470
+ });
471
+ tool.registerWithAgent(agent);
472
+ ```
473
+
474
+ ---
475
+
476
+ ### createExpressionTool
477
+
478
+ Create a DataMap tool that evaluates expressions without making any HTTP calls.
479
+
480
+ ```typescript
481
+ import { createExpressionTool, FunctionResult } from '@signalwire/sdk';
482
+
483
+ const tool = createExpressionTool({
484
+ name: 'classify_priority',
485
+ description: 'Classify ticket priority',
486
+ testValue: '${args.description}',
487
+ parameters: {
488
+ description: { type: 'string', description: 'Issue description' },
489
+ },
490
+ expressions: [
491
+ {
492
+ pattern: '(crash|down|outage|emergency)',
493
+ output: new FunctionResult('Critical priority. Escalating immediately.'),
494
+ },
495
+ {
496
+ pattern: '(slow|delay|lag)',
497
+ output: new FunctionResult('Medium priority.'),
498
+ },
499
+ {
500
+ pattern: '.*',
501
+ output: new FunctionResult('Low priority.'),
502
+ },
503
+ ],
504
+ });
505
+ tool.registerWithAgent(agent);
506
+ ```
507
+
508
+ ---
509
+
510
+ ## Template Variables Reference
511
+
512
+ Template variables use `${...}` syntax and are expanded by the SignalWire platform at execution time.
513
+
514
+ | Variable | Description | Example |
515
+ |----------|-------------|---------|
516
+ | `${args.name}` | Tool argument value | `${args.city}` |
517
+ | `${lc:args.name}` | Lowercase argument | `${lc:args.city}` |
518
+ | `${uc:args.name}` | Uppercase argument | `${uc:args.city}` |
519
+ | `${response.field}` | Webhook response field | `${response.temp}` |
520
+ | `${response.array[0].field}` | Array element access | `${response.results[0].name}` |
521
+ | `${meta_data.field}` | Call metadata | `${meta_data.call_id}` |
522
+ | `${ENV.VAR}` | Environment variable (requires `enableEnvExpansion()`) | `${ENV.API_KEY}` |
523
+ | `${foreach_output}` | Concatenated foreach results | `${foreach_output}` |
524
+ | `${this.field}` | Current element in foreach | `${this.name}` |
525
+
526
+ ---
527
+
528
+ ## Complete Examples
529
+
530
+ ### Weather Lookup API
531
+
532
+ ```typescript
533
+ import { DataMap, FunctionResult } from '@signalwire/sdk';
534
+
535
+ const weather = new DataMap('get_weather')
536
+ .purpose('Get the current weather for any city')
537
+ .parameter('city', 'string', 'The city to look up', { required: true })
538
+ .parameter('units', 'string', 'Temperature units', { enum: ['fahrenheit', 'celsius'] })
539
+ .webhook('GET', 'https://api.weatherapi.com/v1/current.json?key=${ENV.WEATHER_API_KEY}&q=${args.city}')
540
+ .output(new FunctionResult(
541
+ 'The weather in ${args.city} is ${response.current.temp_f}F (${response.current.condition.text}).',
542
+ ))
543
+ .fallbackOutput(new FunctionResult('Sorry, I could not retrieve the weather data.'))
544
+ .enableEnvExpansion();
545
+
546
+ weather.registerWithAgent(agent);
547
+ ```
548
+
549
+ ### Order Status Checker
550
+
551
+ ```typescript
552
+ const orderStatus = new DataMap('check_order')
553
+ .purpose('Check the status of a customer order')
554
+ .parameter('order_id', 'string', 'Order number', { required: true })
555
+ .webhook('GET', 'https://api.example.com/orders/${args.order_id}', {
556
+ headers: { 'Authorization': 'Bearer ${ENV.ORDERS_API_KEY}' },
557
+ })
558
+ .errorKeys(['error', 'not_found'])
559
+ .output(new FunctionResult(
560
+ 'Order ${args.order_id}: Status is ${response.status}. ' +
561
+ 'Estimated delivery: ${response.delivery_date}.',
562
+ ))
563
+ .fallbackOutput(new FunctionResult('I could not find that order. Please verify the order number.'))
564
+ .enableEnvExpansion();
565
+
566
+ orderStatus.registerWithAgent(agent);
567
+ ```
568
+
569
+ ### Expression-Based Routing
570
+
571
+ ```typescript
572
+ const router = new DataMap('route_department')
573
+ .purpose('Determine which department to route to')
574
+ .parameter('issue', 'string', 'Description of the issue', { required: true })
575
+ .expression('${args.issue}', '(bill|charge|payment|invoice)', new FunctionResult('Route to billing department.'))
576
+ .expression('${args.issue}', '(bug|error|crash|broken)', new FunctionResult('Route to technical support.'))
577
+ .expression('${args.issue}', '(cancel|return|refund)', new FunctionResult('Route to customer retention.'))
578
+ .expression('${args.issue}', '.*', new FunctionResult('Route to general support.'));
579
+
580
+ router.registerWithAgent(agent);
581
+ ```
582
+
583
+ ### List Processing with Foreach
584
+
585
+ ```typescript
586
+ const listOrders = new DataMap('list_recent_orders')
587
+ .purpose('List recent orders for a customer')
588
+ .parameter('customer_id', 'string', 'Customer ID', { required: true })
589
+ .webhook('GET', 'https://api.example.com/customers/${args.customer_id}/orders?limit=5')
590
+ .foreach('response.orders', '- Order #${this.id}: ${this.status} ($${this.total})')
591
+ .output(new FunctionResult('Recent orders:\n${foreach_output}'))
592
+ .fallbackOutput(new FunctionResult('No orders found for this customer.'));
593
+
594
+ listOrders.registerWithAgent(agent);
595
+ ```