@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
package/src/DataMap.ts ADDED
@@ -0,0 +1,449 @@
1
+ /**
2
+ * DataMap - Fluent builder for SWAIG data_map configurations.
3
+ *
4
+ * Creates server-side tool definitions that execute on SignalWire
5
+ * without requiring webhook endpoints.
6
+ */
7
+
8
+ import { FunctionResult } from './FunctionResult.js';
9
+
10
+ const ENV_PATTERN = /\$\{ENV\.([^}]+)\}/g;
11
+
12
+ /** Default allowed env var prefixes for expansion. */
13
+ let globalAllowedEnvPrefixes: string[] = ['SIGNALWIRE_', 'SWML_', 'SW_'];
14
+
15
+ /**
16
+ * Set the global allowed env var prefixes for `${ENV.*}` expansion.
17
+ *
18
+ * Only environment variables whose names start with one of these prefixes
19
+ * will be expanded. An empty array allows all variables (escape hatch).
20
+ *
21
+ * @param prefixes - Array of prefix strings to allow.
22
+ */
23
+ export function setAllowedEnvPrefixes(prefixes: string[]): void {
24
+ globalAllowedEnvPrefixes = prefixes;
25
+ }
26
+
27
+ /**
28
+ * Get the current global allowed env var prefixes.
29
+ * @returns A copy of the current prefix list.
30
+ */
31
+ export function getAllowedEnvPrefixes(): string[] {
32
+ return [...globalAllowedEnvPrefixes];
33
+ }
34
+
35
+ function isEnvVarAllowed(varName: string, allowedPrefixes: string[]): boolean {
36
+ if (allowedPrefixes.length === 0) return true;
37
+ return allowedPrefixes.some((prefix) => varName.startsWith(prefix));
38
+ }
39
+
40
+ function expandEnvVars(value: string, allowedPrefixes: string[]): string {
41
+ return value.replace(ENV_PATTERN, (_match, varName: string) => {
42
+ if (!isEnvVarAllowed(varName, allowedPrefixes)) return '';
43
+ return process.env[varName] ?? '';
44
+ });
45
+ }
46
+
47
+ function expandEnvInObject(obj: unknown, allowedPrefixes: string[]): unknown {
48
+ if (typeof obj === 'string') return expandEnvVars(obj, allowedPrefixes);
49
+ if (Array.isArray(obj)) return obj.map((item) => expandEnvInObject(item, allowedPrefixes));
50
+ if (obj && typeof obj === 'object') {
51
+ const result: Record<string, unknown> = {};
52
+ for (const [k, v] of Object.entries(obj as Record<string, unknown>)) {
53
+ result[k] = expandEnvInObject(v, allowedPrefixes);
54
+ }
55
+ return result;
56
+ }
57
+ return obj;
58
+ }
59
+
60
+ /**
61
+ * Fluent builder for SWAIG data_map configurations.
62
+ *
63
+ * Creates server-side tool definitions that execute on SignalWire
64
+ * without requiring webhook endpoints.
65
+ */
66
+ export class DataMap {
67
+ /** The name of the SWAIG function this data map defines. */
68
+ functionName: string;
69
+ private _purpose = '';
70
+ private _parameters: Record<string, unknown> = {};
71
+ private _expressions: Record<string, unknown>[] = [];
72
+ private _webhooks: Record<string, unknown>[] = [];
73
+ private _output: Record<string, unknown> | null = null;
74
+ private _errorKeys: string[] = [];
75
+ private _expandEnv = false;
76
+ private _allowedEnvPrefixes: string[] | null = null;
77
+
78
+ /**
79
+ * @param functionName - The unique name for this data map tool.
80
+ */
81
+ constructor(functionName: string) {
82
+ this.functionName = functionName;
83
+ }
84
+
85
+ /**
86
+ * Enable `${ENV.*}` variable expansion in URLs, bodies, and outputs.
87
+ * @param enabled - Whether to enable expansion (defaults to true).
88
+ * @returns This instance for chaining.
89
+ */
90
+ enableEnvExpansion(enabled = true): this {
91
+ this._expandEnv = enabled;
92
+ return this;
93
+ }
94
+
95
+ /**
96
+ * Set the allowed env var prefixes for this DataMap instance.
97
+ *
98
+ * Overrides the global defaults. Only env vars whose names start with
99
+ * one of these prefixes will be expanded. An empty array allows all.
100
+ *
101
+ * @param prefixes - Array of prefix strings to allow.
102
+ * @returns This instance for chaining.
103
+ */
104
+ setAllowedEnvPrefixes(prefixes: string[]): this {
105
+ this._allowedEnvPrefixes = prefixes;
106
+ return this;
107
+ }
108
+
109
+ /**
110
+ * Set the purpose (description) for this data-map tool — READ BY THE LLM.
111
+ *
112
+ * This string is rendered into the OpenAI tool schema `description`
113
+ * field and sent to the model on every turn. The model uses it to
114
+ * decide WHEN to call this tool. It is **prompt engineering**, not
115
+ * developer documentation.
116
+ *
117
+ * A vague `purpose()` is the #1 cause of "the model has the right tool
118
+ * but doesn't call it" failures with data-map tools.
119
+ *
120
+ * ### Bad vs good
121
+ *
122
+ * ```text
123
+ * BAD : .purpose('weather api')
124
+ * GOOD: .purpose('Get the current weather conditions and forecast for
125
+ * a specific city. Use this whenever the user asks about weather,
126
+ * temperature, rain, or similar conditions in a named location.')
127
+ * ```
128
+ *
129
+ * @param description - Prompt-engineering description of when to call this tool.
130
+ * @returns This instance for chaining.
131
+ */
132
+ purpose(description: string): this {
133
+ this._purpose = description;
134
+ return this;
135
+ }
136
+
137
+ /**
138
+ * Alias for {@link purpose}; sets the LLM-facing tool description.
139
+ *
140
+ * This string is read by the model to decide WHEN to call this tool.
141
+ * See {@link purpose} for bad-vs-good examples.
142
+ *
143
+ * @param description - Prompt-engineering description of when to call this tool.
144
+ * @returns This instance for chaining.
145
+ */
146
+ description(description: string): this {
147
+ return this.purpose(description);
148
+ }
149
+
150
+ /**
151
+ * Define a parameter for this data-map tool — `description` is READ BY THE LLM.
152
+ *
153
+ * Each parameter `description` is rendered into the OpenAI tool schema
154
+ * under `parameters.properties.<name>.description` and sent to the
155
+ * model. The model uses it to decide HOW to fill in the argument from
156
+ * user speech. It is **prompt engineering**, not developer FYI.
157
+ *
158
+ * ### Bad vs good
159
+ *
160
+ * ```text
161
+ * BAD : .parameter('city', 'string', 'the city')
162
+ * GOOD: .parameter('city', 'string',
163
+ * 'The name of the city to get weather for, e.g. "San Francisco".
164
+ * Ask the user if they did not provide one. Include the state
165
+ * or country if the city name is ambiguous.')
166
+ * ```
167
+ *
168
+ * @param name - The parameter name (JSON object key).
169
+ * @param paramType - The JSON Schema type (e.g., "string", "number").
170
+ * @param description - Prompt-engineering description telling the model
171
+ * how to extract this value from the user's utterance. Read by the LLM.
172
+ * @param opts - Optional flags for required and enum constraints.
173
+ * @returns This instance for chaining.
174
+ */
175
+ parameter(
176
+ name: string,
177
+ paramType: string,
178
+ description: string,
179
+ opts?: { required?: boolean; enum?: string[] },
180
+ ): this {
181
+ const paramDef: Record<string, unknown> = { type: paramType, description };
182
+ if (opts?.enum) paramDef['enum'] = opts.enum;
183
+ this._parameters[name] = paramDef;
184
+
185
+ if (opts?.required) {
186
+ if (!this._parameters['_required']) {
187
+ this._parameters['_required'] = [];
188
+ }
189
+ const req = this._parameters['_required'] as string[];
190
+ if (!req.includes(name)) req.push(name);
191
+ }
192
+ return this;
193
+ }
194
+
195
+ /**
196
+ * Add a pattern-matching expression that evaluates a test value against a regex.
197
+ * @param testValue - The string or template variable to test.
198
+ * @param pattern - A regex pattern (string or RegExp) to match against.
199
+ * @param output - The result to return when the pattern matches.
200
+ * @param nomatchOutput - Optional result to return when the pattern does not match.
201
+ * @returns This instance for chaining.
202
+ */
203
+ expression(
204
+ testValue: string,
205
+ pattern: string | RegExp,
206
+ output: FunctionResult,
207
+ nomatchOutput?: FunctionResult,
208
+ ): this {
209
+ const patternStr = typeof pattern === 'string' ? pattern : pattern.source;
210
+ const expr: Record<string, unknown> = {
211
+ string: testValue,
212
+ pattern: patternStr,
213
+ output: output.toDict(),
214
+ };
215
+ if (nomatchOutput) {
216
+ expr['nomatch-output'] = nomatchOutput.toDict();
217
+ }
218
+ this._expressions.push(expr);
219
+ return this;
220
+ }
221
+
222
+ /**
223
+ * Add a webhook that is called when this data map tool is invoked.
224
+ * @param method - HTTP method (e.g., "GET", "POST").
225
+ * @param url - The webhook URL to call.
226
+ * @param opts - Optional headers, form parameter name, and argument settings.
227
+ * @returns This instance for chaining.
228
+ */
229
+ webhook(
230
+ method: string,
231
+ url: string,
232
+ opts?: {
233
+ headers?: Record<string, string>;
234
+ formParam?: string;
235
+ inputArgsAsParams?: boolean;
236
+ requireArgs?: string[];
237
+ },
238
+ ): this {
239
+ const def: Record<string, unknown> = { url, method: method.toUpperCase() };
240
+ if (opts?.headers) def['headers'] = opts.headers;
241
+ if (opts?.formParam) def['form_param'] = opts.formParam;
242
+ if (opts?.inputArgsAsParams) def['input_args_as_params'] = true;
243
+ if (opts?.requireArgs) def['require_args'] = opts.requireArgs;
244
+ this._webhooks.push(def);
245
+ return this;
246
+ }
247
+
248
+ /**
249
+ * Set pattern-matching expressions on the most recently added webhook.
250
+ * @param expressions - Array of expression objects to evaluate against the webhook response.
251
+ * @returns This instance for chaining.
252
+ */
253
+ webhookExpressions(expressions: Record<string, unknown>[]): this {
254
+ if (!this._webhooks.length) throw new Error('Must add webhook before setting webhook expressions');
255
+ this._webhooks[this._webhooks.length - 1]['expressions'] = expressions;
256
+ return this;
257
+ }
258
+
259
+ /**
260
+ * Set the JSON body for the most recently added webhook.
261
+ * @param data - The request body object.
262
+ * @returns This instance for chaining.
263
+ */
264
+ body(data: Record<string, unknown>): this {
265
+ if (!this._webhooks.length) throw new Error('Must add webhook before setting body');
266
+ this._webhooks[this._webhooks.length - 1]['body'] = data;
267
+ return this;
268
+ }
269
+
270
+ /**
271
+ * Set query or form parameters for the most recently added webhook.
272
+ * @param data - The parameters object.
273
+ * @returns This instance for chaining.
274
+ */
275
+ params(data: Record<string, unknown>): this {
276
+ if (!this._webhooks.length) throw new Error('Must add webhook before setting params');
277
+ this._webhooks[this._webhooks.length - 1]['params'] = data;
278
+ return this;
279
+ }
280
+
281
+ /**
282
+ * Configure iteration over an array in the webhook response.
283
+ * @param config - Foreach configuration with input/output keys, append template, and optional max.
284
+ * @returns This instance for chaining.
285
+ */
286
+ foreach(config: {
287
+ input_key: string;
288
+ output_key: string;
289
+ append: string;
290
+ max?: number;
291
+ }): this {
292
+ if (!this._webhooks.length) throw new Error('Must add webhook before setting foreach');
293
+ this._webhooks[this._webhooks.length - 1]['foreach'] = config;
294
+ return this;
295
+ }
296
+
297
+ /**
298
+ * Set the output template for the most recently added webhook.
299
+ * @param result - The FunctionResult to use as the output template.
300
+ * @returns This instance for chaining.
301
+ */
302
+ output(result: FunctionResult): this {
303
+ if (!this._webhooks.length) throw new Error('Must add webhook before setting output');
304
+ this._webhooks[this._webhooks.length - 1]['output'] = result.toDict();
305
+ return this;
306
+ }
307
+
308
+ /**
309
+ * Set a fallback output used when no webhook or expression matches.
310
+ * @param result - The FunctionResult to use as the fallback.
311
+ * @returns This instance for chaining.
312
+ */
313
+ fallbackOutput(result: FunctionResult): this {
314
+ this._output = result.toDict();
315
+ return this;
316
+ }
317
+
318
+ /**
319
+ * Set error keys on the most recently added webhook, or globally if no webhook exists.
320
+ * @param keys - Response keys that indicate an error occurred.
321
+ * @returns This instance for chaining.
322
+ */
323
+ errorKeys(keys: string[]): this {
324
+ if (this._webhooks.length) {
325
+ this._webhooks[this._webhooks.length - 1]['error_keys'] = keys;
326
+ } else {
327
+ this._errorKeys = keys;
328
+ }
329
+ return this;
330
+ }
331
+
332
+ /**
333
+ * Set error keys at the top-level data map scope, regardless of webhook context.
334
+ * @param keys - Response keys that indicate an error occurred.
335
+ * @returns This instance for chaining.
336
+ */
337
+ globalErrorKeys(keys: string[]): this {
338
+ this._errorKeys = keys;
339
+ return this;
340
+ }
341
+
342
+ /**
343
+ * Register this DataMap tool with an AgentBase instance.
344
+ * @param agent - An object with a registerSwaigFunction method (typically an AgentBase).
345
+ * @returns This instance for chaining.
346
+ */
347
+ registerWithAgent(agent: { registerSwaigFunction(fn: Record<string, unknown>): unknown }): this {
348
+ agent.registerSwaigFunction(this.toSwaigFunction());
349
+ return this;
350
+ }
351
+
352
+ /**
353
+ * Serialize this data map to a SWAIG function definition object.
354
+ * @returns A plain object suitable for inclusion in the SWML SWAIG array.
355
+ */
356
+ toSwaigFunction(): Record<string, unknown> {
357
+ // Build parameter schema
358
+ let paramSchema: Record<string, unknown>;
359
+ const paramKeys = Object.keys(this._parameters).filter((k) => k !== '_required');
360
+ if (paramKeys.length) {
361
+ const properties: Record<string, unknown> = {};
362
+ for (const k of paramKeys) {
363
+ properties[k] = this._parameters[k];
364
+ }
365
+ paramSchema = { type: 'object', properties };
366
+ const required = this._parameters['_required'] as string[] | undefined;
367
+ if (required?.length) paramSchema['required'] = required;
368
+ } else {
369
+ paramSchema = { type: 'object', properties: {} };
370
+ }
371
+
372
+ // Build data_map
373
+ const dataMap: Record<string, unknown> = {};
374
+ if (this._expressions.length) dataMap['expressions'] = this._expressions;
375
+ if (this._webhooks.length) dataMap['webhooks'] = this._webhooks;
376
+ if (this._output) dataMap['output'] = this._output;
377
+ if (this._errorKeys.length) dataMap['error_keys'] = this._errorKeys;
378
+
379
+ let result: Record<string, unknown> = {
380
+ function: this.functionName,
381
+ description: this._purpose || `Execute ${this.functionName}`,
382
+ parameters: paramSchema,
383
+ data_map: dataMap,
384
+ };
385
+
386
+ if (this._expandEnv) {
387
+ const prefixes = this._allowedEnvPrefixes ?? globalAllowedEnvPrefixes;
388
+ result = expandEnvInObject(result, prefixes) as Record<string, unknown>;
389
+ }
390
+
391
+ return result;
392
+ }
393
+ }
394
+
395
+ // ── Helper functions ────────────────────────────────────────────────────
396
+
397
+ /**
398
+ * Create a DataMap tool that calls a single API endpoint and formats the response.
399
+ * @param opts - Configuration including name, URL, response template, and optional parameters.
400
+ * @returns A configured DataMap instance ready for registration.
401
+ */
402
+ export function createSimpleApiTool(opts: {
403
+ name: string;
404
+ url: string;
405
+ responseTemplate: string;
406
+ parameters?: Record<string, { type?: string; description?: string; required?: boolean }>;
407
+ method?: string;
408
+ headers?: Record<string, string>;
409
+ body?: Record<string, unknown>;
410
+ errorKeys?: string[];
411
+ }): DataMap {
412
+ const dm = new DataMap(opts.name);
413
+ if (opts.parameters) {
414
+ for (const [name, def] of Object.entries(opts.parameters)) {
415
+ dm.parameter(name, def.type ?? 'string', def.description ?? `${name} parameter`, {
416
+ required: def.required,
417
+ });
418
+ }
419
+ }
420
+ dm.webhook(opts.method ?? 'GET', opts.url, { headers: opts.headers });
421
+ if (opts.body) dm.body(opts.body);
422
+ if (opts.errorKeys) dm.errorKeys(opts.errorKeys);
423
+ dm.output(new FunctionResult(opts.responseTemplate));
424
+ return dm;
425
+ }
426
+
427
+ /**
428
+ * Create a DataMap tool that evaluates expressions against patterns without making HTTP calls.
429
+ * @param opts - Configuration including name, pattern-result pairs, and optional parameters.
430
+ * @returns A configured DataMap instance ready for registration.
431
+ */
432
+ export function createExpressionTool(opts: {
433
+ name: string;
434
+ patterns: Record<string, [string, FunctionResult]>;
435
+ parameters?: Record<string, { type?: string; description?: string; required?: boolean }>;
436
+ }): DataMap {
437
+ const dm = new DataMap(opts.name);
438
+ if (opts.parameters) {
439
+ for (const [name, def] of Object.entries(opts.parameters)) {
440
+ dm.parameter(name, def.type ?? 'string', def.description ?? `${name} parameter`, {
441
+ required: def.required,
442
+ });
443
+ }
444
+ }
445
+ for (const [testValue, [pattern, result]] of Object.entries(opts.patterns)) {
446
+ dm.expression(testValue, pattern, result);
447
+ }
448
+ return dm;
449
+ }