@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,88 @@
1
+ /**
2
+ * Built-in skills registry for SignalWire AI Agents.
3
+ *
4
+ * Import this module to register all built-in skills with the global SkillRegistry.
5
+ */
6
+
7
+ export { DateTimeSkill, createSkill as createDateTimeSkill } from './datetime.js';
8
+ export { MathSkill, createSkill as createMathSkill } from './math.js';
9
+ export { JokeSkill, createSkill as createJokeSkill } from './joke.js';
10
+ export { WeatherApiSkill, createSkill as createWeatherApiSkill } from './weather_api.js';
11
+ export { PlayBackgroundFileSkill, createSkill as createPlayBackgroundFileSkill } from './play_background_file.js';
12
+ export { SwmlTransferSkill, createSkill as createSwmlTransferSkill } from './swml_transfer.js';
13
+ export { ApiNinjasTriviaSkill, createSkill as createApiNinjasTriviaSkill } from './api_ninjas_trivia.js';
14
+ export { InfoGathererSkill, createSkill as createInfoGathererSkill } from './info_gatherer.js';
15
+ export { CustomSkillsSkill, createSkill as createCustomSkillsSkill } from './custom_skills.js';
16
+ export { WebSearchSkill, createSkill as createWebSearchSkill } from './web_search.js';
17
+ export { WikipediaSearchSkill, createSkill as createWikipediaSearchSkill } from './wikipedia_search.js';
18
+ export { GoogleMapsSkill, createSkill as createGoogleMapsSkill } from './google_maps.js';
19
+ export { DataSphereSkill, createSkill as createDataSphereSkill } from './datasphere.js';
20
+ export { DataSphereServerlessSkill, createSkill as createDataSphereServerlessSkill } from './datasphere_serverless.js';
21
+ export { NativeVectorSearchSkill, createSkill as createNativeVectorSearchSkill } from './native_vector_search.js';
22
+ export { SpiderSkill, createSkill as createSpiderSkill } from './spider.js';
23
+ export { ClaudeSkillsSkill, createSkill as createClaudeSkillsSkill } from './claude_skills.js';
24
+ export { AskClaudeSkill, createSkill as createAskClaudeSkill } from './ask_claude.js';
25
+ export { McpGatewaySkill, createSkill as createMcpGatewaySkill } from './mcp_gateway.js';
26
+
27
+ import { SkillRegistry } from '../SkillRegistry.js';
28
+ import type { SkillBase } from '../SkillBase.js';
29
+ import { DateTimeSkill } from './datetime.js';
30
+ import { MathSkill } from './math.js';
31
+ import { JokeSkill } from './joke.js';
32
+ import { WeatherApiSkill } from './weather_api.js';
33
+ import { PlayBackgroundFileSkill } from './play_background_file.js';
34
+ import { SwmlTransferSkill } from './swml_transfer.js';
35
+ import { ApiNinjasTriviaSkill } from './api_ninjas_trivia.js';
36
+ import { InfoGathererSkill } from './info_gatherer.js';
37
+ import { CustomSkillsSkill } from './custom_skills.js';
38
+ import { WebSearchSkill } from './web_search.js';
39
+ import { WikipediaSearchSkill } from './wikipedia_search.js';
40
+ import { GoogleMapsSkill } from './google_maps.js';
41
+ import { DataSphereSkill } from './datasphere.js';
42
+ import { DataSphereServerlessSkill } from './datasphere_serverless.js';
43
+ import { NativeVectorSearchSkill } from './native_vector_search.js';
44
+ import { SpiderSkill } from './spider.js';
45
+ import { ClaudeSkillsSkill } from './claude_skills.js';
46
+ import { AskClaudeSkill } from './ask_claude.js';
47
+ import { McpGatewaySkill } from './mcp_gateway.js';
48
+
49
+ /**
50
+ * Register all 19 built-in skills with the global SkillRegistry singleton.
51
+ * Matches Python's auto-discovery pattern (`skills/registry.py`) which finds
52
+ * SkillBase subclasses in the skills directory and registers them by class
53
+ * reference. Skips registration for any skill name already present.
54
+ */
55
+ export function registerBuiltinSkills(): void {
56
+ const registry = SkillRegistry.getInstance();
57
+
58
+ const skillClasses: Array<typeof SkillBase> = [
59
+ DateTimeSkill,
60
+ MathSkill,
61
+ JokeSkill,
62
+ WeatherApiSkill,
63
+ PlayBackgroundFileSkill,
64
+ SwmlTransferSkill,
65
+ ApiNinjasTriviaSkill,
66
+ InfoGathererSkill,
67
+ CustomSkillsSkill,
68
+ WebSearchSkill,
69
+ WikipediaSearchSkill,
70
+ GoogleMapsSkill,
71
+ DataSphereSkill,
72
+ DataSphereServerlessSkill,
73
+ NativeVectorSearchSkill,
74
+ SpiderSkill,
75
+ ClaudeSkillsSkill,
76
+ AskClaudeSkill,
77
+ McpGatewaySkill,
78
+ ];
79
+
80
+ for (const SkillClass of skillClasses) {
81
+ if (!registry.has(SkillClass.SKILL_NAME)) {
82
+ registry.register(SkillClass);
83
+ }
84
+ }
85
+
86
+ // Lock all built-in skills to prevent override
87
+ registry.lock();
88
+ }
@@ -0,0 +1,405 @@
1
+ /**
2
+ * Info Gatherer Skill - Guides an AI agent through a sequence of questions,
3
+ * collecting and storing answers in namespaced SWAIG `global_data`.
4
+ *
5
+ * Tier 2 built-in skill with no external dependencies. Direct port of
6
+ * Python's `signalwire.skills.info_gatherer.skill.InfoGathererSkill`
7
+ * (core/skill_base.py usage; skill.py:16-312). Supports multiple instances
8
+ * with different `prefix` values so several question sets can coexist on a
9
+ * single agent (e.g. "intake" and "medical" questionnaires running side by
10
+ * side).
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('InfoGathererSkill');
24
+
25
+ const DEFAULT_COMPLETION_MESSAGE =
26
+ "Thank you! All questions have been answered. You can now summarize the " +
27
+ "information collected or ask if there's anything else the user would like " +
28
+ 'to discuss.';
29
+
30
+ /** Definition of a single question in the sequential question flow. */
31
+ interface QuestionDefinition {
32
+ /** Key name used to store the answer. */
33
+ key_name: string;
34
+ /** Question text read to the user. */
35
+ question_text: string;
36
+ /** When true, the agent must confirm the answer with the user before submitting. */
37
+ confirm?: boolean;
38
+ /** Optional extra instruction appended to the question prompt. */
39
+ prompt_add?: string;
40
+ }
41
+
42
+ /**
43
+ * Collects answers to a configurable list of questions, one at a time.
44
+ *
45
+ * Mirrors Python `InfoGathererSkill` exactly: the same required
46
+ * `questions` config, the same `prefix` / `completion_message` options,
47
+ * the same two tools (`start_questions`, `submit_answer`), and the same
48
+ * state shape in `global_data`.
49
+ */
50
+ export class InfoGathererSkill extends SkillBase {
51
+ // Python ground truth: skills/info_gatherer/skill.py:26-31
52
+ static override SKILL_NAME = 'info_gatherer';
53
+ static override SKILL_DESCRIPTION = 'Gather answers to a configurable list of questions';
54
+ static override SKILL_VERSION = '1.0.0';
55
+ static override REQUIRED_PACKAGES: readonly string[] = [];
56
+ static override REQUIRED_ENV_VARS: readonly string[] = [];
57
+ static override SUPPORTS_MULTIPLE_INSTANCES = true;
58
+
59
+ /** List of question definitions populated in `setup()`. */
60
+ private questions: QuestionDefinition[] = [];
61
+ /** Derived tool name for the start tool (prefix-aware). */
62
+ private startToolName: string = 'start_questions';
63
+ /** Derived tool name for the submit tool (prefix-aware). */
64
+ private submitToolName: string = 'submit_answer';
65
+ /** Message returned once all questions are answered. */
66
+ private completionMessage: string = DEFAULT_COMPLETION_MESSAGE;
67
+
68
+ static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
69
+ return {
70
+ ...super.getParameterSchema(),
71
+ questions: {
72
+ type: 'array',
73
+ description:
74
+ "List of question objects. Each must have 'key_name' (str) and 'question_text' (str). Optional 'confirm' (bool) asks the agent to confirm the answer before proceeding.",
75
+ required: true,
76
+ items: {
77
+ type: 'object',
78
+ properties: {
79
+ key_name: { type: 'string' },
80
+ question_text: { type: 'string' },
81
+ confirm: { type: 'boolean' },
82
+ prompt_add: { type: 'string' },
83
+ },
84
+ },
85
+ },
86
+ prefix: {
87
+ type: 'string',
88
+ description:
89
+ "Optional prefix for tool names and namespace. When set, tools are named <prefix>_start_questions / <prefix>_submit_answer and state is stored under 'skill:<prefix>' in global_data.",
90
+ required: false,
91
+ },
92
+ completion_message: {
93
+ type: 'string',
94
+ description: 'Message returned after all questions are answered',
95
+ default: DEFAULT_COMPLETION_MESSAGE,
96
+ required: false,
97
+ },
98
+ };
99
+ }
100
+
101
+ /**
102
+ * Instance key for the SkillManager. When `prefix` is configured, returns
103
+ * `info_gatherer_<prefix>` to support multi-instance use. Matches Python's
104
+ * `get_instance_key()` (skill.py:81-85).
105
+ */
106
+ override getInstanceKey(): string {
107
+ const prefix = this.getConfig<string>('prefix', '');
108
+ return prefix ? `info_gatherer_${prefix}` : 'info_gatherer';
109
+ }
110
+
111
+ /**
112
+ * Validate the `questions` config, derive tool names (with optional prefix),
113
+ * and cache the completion message.
114
+ *
115
+ * Python parity: skill.py:91-121. Returns `false` (logging an error) when
116
+ * `questions` is missing or fails validation; setup must produce a
117
+ * functional skill or fail closed.
118
+ */
119
+ override async setup(): Promise<boolean> {
120
+ const questions = this.getConfig<unknown>('questions', undefined);
121
+ if (questions === undefined || questions === null) {
122
+ log.error("'questions' parameter is required");
123
+ return false;
124
+ }
125
+
126
+ try {
127
+ InfoGathererSkill._validateQuestions(questions);
128
+ } catch (err) {
129
+ log.error(err instanceof Error ? err.message : String(err));
130
+ return false;
131
+ }
132
+
133
+ this.questions = questions as QuestionDefinition[];
134
+
135
+ const prefix = this.getConfig<string>('prefix', '');
136
+ if (prefix) {
137
+ this.startToolName = `${prefix}_start_questions`;
138
+ this.submitToolName = `${prefix}_submit_answer`;
139
+ } else {
140
+ this.startToolName = 'start_questions';
141
+ this.submitToolName = 'submit_answer';
142
+ }
143
+
144
+ this.completionMessage = this.getConfig<string>(
145
+ 'completion_message',
146
+ DEFAULT_COMPLETION_MESSAGE,
147
+ );
148
+ return true;
149
+ }
150
+
151
+ /**
152
+ * Seed SWAIG `global_data` with the initial question state under this
153
+ * skill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135).
154
+ *
155
+ * Defensive no-op when the skill was not successfully set up (empty
156
+ * `questions`). Python relies on the SkillManager to skip unloaded skills;
157
+ * TS adds this guard so `getGlobalData()` called without a successful
158
+ * `setup()` returns `{}` instead of a malformed state payload.
159
+ */
160
+ override getGlobalData(): Record<string, unknown> {
161
+ if (this.questions.length === 0) {
162
+ return {};
163
+ }
164
+ return {
165
+ [this.getSkillNamespace()]: {
166
+ questions: this.questions,
167
+ question_index: 0,
168
+ answers: [],
169
+ },
170
+ };
171
+ }
172
+
173
+ /**
174
+ * Register the two sequential-flow tools. Mirrors Python
175
+ * `register_tools()` (skill.py:162-184). Returns an empty array when
176
+ * `setup()` did not complete (no questions) so the skill never exposes
177
+ * half-initialized tools.
178
+ */
179
+ override getTools(): SkillToolDefinition[] {
180
+ if (this.questions.length === 0) {
181
+ return [];
182
+ }
183
+ return [
184
+ {
185
+ name: this.startToolName,
186
+ description: 'Start the question sequence with the first question',
187
+ parameters: {},
188
+ handler: (args, rawData) => this._handleStartQuestions(args, rawData),
189
+ },
190
+ {
191
+ name: this.submitToolName,
192
+ description:
193
+ 'Submit an answer to the current question and move to the next one',
194
+ parameters: {
195
+ answer: {
196
+ type: 'string',
197
+ description: "The user's answer to the current question",
198
+ },
199
+ confirmed_by_user: {
200
+ type: 'boolean',
201
+ description:
202
+ "Only set to true when the user has explicitly said 'yes' or confirmed the answer is correct in their own words in their most recent response. Never set this to true on your own.",
203
+ },
204
+ },
205
+ handler: (args, rawData) => this._handleSubmitAnswer(args, rawData),
206
+ },
207
+ ];
208
+ }
209
+
210
+ /**
211
+ * Handle the `start_questions` tool: read state from global_data and return
212
+ * an instruction for the first question. Mirrors Python
213
+ * `_handle_start_questions` (skill.py:190-208).
214
+ */
215
+ private _handleStartQuestions(
216
+ _args: Record<string, unknown>,
217
+ rawData: Record<string, unknown>,
218
+ ): FunctionResult {
219
+ const state = this.getSkillData(rawData);
220
+ const questions = (state['questions'] as QuestionDefinition[] | undefined) ?? [];
221
+ const questionIndex = (state['question_index'] as number | undefined) ?? 0;
222
+
223
+ if (questions.length === 0 || questionIndex >= questions.length) {
224
+ return new FunctionResult("I don't have any questions to ask.");
225
+ }
226
+
227
+ const current = questions[questionIndex];
228
+ const instruction = InfoGathererSkill._generateQuestionInstruction(
229
+ current.question_text ?? '',
230
+ current.confirm ?? false,
231
+ true,
232
+ current.prompt_add ?? '',
233
+ this.submitToolName,
234
+ questionIndex + 1,
235
+ questions.length,
236
+ );
237
+ return new FunctionResult(instruction);
238
+ }
239
+
240
+ /**
241
+ * Handle the `submit_answer` tool: validate confirmation, record the answer,
242
+ * advance the index, and either return the next question or the completion
243
+ * message (disabling both tools on completion). Mirrors Python
244
+ * `_handle_submit_answer` (skill.py:210-262).
245
+ */
246
+ private _handleSubmitAnswer(
247
+ args: Record<string, unknown>,
248
+ rawData: Record<string, unknown>,
249
+ ): FunctionResult {
250
+ const answer = (args['answer'] as string | undefined) ?? '';
251
+ const confirmed = (args['confirmed_by_user'] as boolean | undefined) ?? false;
252
+ const state = this.getSkillData(rawData);
253
+
254
+ const questions = (state['questions'] as QuestionDefinition[] | undefined) ?? [];
255
+ const questionIndex = (state['question_index'] as number | undefined) ?? 0;
256
+ const answers = (state['answers'] as Array<{ key_name: string; answer: string }> | undefined) ?? [];
257
+
258
+ if (questionIndex >= questions.length) {
259
+ return new FunctionResult('All questions have already been answered.');
260
+ }
261
+
262
+ const current = questions[questionIndex];
263
+ const keyName = current.key_name ?? '';
264
+
265
+ // Enforce confirmation: reject the submission if the question requires
266
+ // confirmation but the confirmed flag was not set to true.
267
+ if ((current.confirm ?? false) && !confirmed) {
268
+ return new FunctionResult(
269
+ `Before submitting, you must read the answer "${answer}" back to the user ` +
270
+ `and ask them to confirm it is correct. Then call this function again with ` +
271
+ `confirmed set to true. If the user says it is wrong, ask the question again.`,
272
+ );
273
+ }
274
+
275
+ const newAnswers = [...answers, { key_name: keyName, answer }];
276
+ const newIndex = questionIndex + 1;
277
+
278
+ let result: FunctionResult;
279
+
280
+ if (newIndex < questions.length) {
281
+ const nextQ = questions[newIndex];
282
+ const instruction = InfoGathererSkill._generateQuestionInstruction(
283
+ nextQ.question_text ?? '',
284
+ nextQ.confirm ?? false,
285
+ false,
286
+ nextQ.prompt_add ?? '',
287
+ this.submitToolName,
288
+ newIndex + 1,
289
+ questions.length,
290
+ );
291
+ result = new FunctionResult(instruction);
292
+ } else {
293
+ result = new FunctionResult(this.completionMessage);
294
+ result.toggleFunctions([
295
+ { function: this.startToolName, active: false },
296
+ { function: this.submitToolName, active: false },
297
+ ]);
298
+ }
299
+
300
+ const newState = {
301
+ questions,
302
+ question_index: newIndex,
303
+ answers: newAnswers,
304
+ };
305
+ this.updateSkillData(result, newState);
306
+ return result;
307
+ }
308
+
309
+ /**
310
+ * Generate the per-question instruction returned to the agent. Mirrors
311
+ * Python `_generate_question_instruction` (skill.py:268-297).
312
+ */
313
+ private static _generateQuestionInstruction(
314
+ questionText: string,
315
+ needsConfirmation: boolean,
316
+ isFirstQuestion: boolean,
317
+ promptAdd: string,
318
+ submitToolName: string,
319
+ questionNumber: number,
320
+ totalQuestions: number,
321
+ ): string {
322
+ let instruction: string;
323
+ if (isFirstQuestion) {
324
+ instruction =
325
+ `Ask each question one at a time, wait for the user's answer, ` +
326
+ `then call ${submitToolName} with their answer. Do not reuse previous answers.\n\n` +
327
+ `[Question ${questionNumber} of ${totalQuestions}]: "${questionText}"`;
328
+ } else {
329
+ instruction = `Previous answer saved. [Question ${questionNumber} of ${totalQuestions}]: "${questionText}"`;
330
+ }
331
+
332
+ if (promptAdd) {
333
+ instruction += `\nNote: ${promptAdd}`;
334
+ }
335
+
336
+ if (needsConfirmation) {
337
+ instruction +=
338
+ `\nThis question requires confirmation. Read the answer back to the user ` +
339
+ `and ask them to confirm it is correct before calling ${submitToolName}. ` +
340
+ `If they say it is wrong, ask the question again.`;
341
+ }
342
+
343
+ return instruction;
344
+ }
345
+
346
+ /**
347
+ * Validate that `questions` is a non-empty array of objects each having
348
+ * `key_name` and `question_text`. Throws on invalid input. Mirrors Python
349
+ * `_validate_questions` (skill.py:299-311).
350
+ */
351
+ private static _validateQuestions(questions: unknown): void {
352
+ // Python order (skill.py:301-304): emptiness / falsy check BEFORE type
353
+ // check. JS `!questions` is true for null/undefined/0/""/false but NOT
354
+ // for `[]`, so we also handle the empty-array case explicitly.
355
+ if (!questions || (Array.isArray(questions) && questions.length === 0)) {
356
+ throw new Error('At least one question is required');
357
+ }
358
+ if (!Array.isArray(questions)) {
359
+ throw new Error('Questions must be a list');
360
+ }
361
+ for (let i = 0; i < questions.length; i++) {
362
+ const q = questions[i];
363
+ if (!q || typeof q !== 'object' || Array.isArray(q)) {
364
+ throw new Error(`Question ${i + 1} must be a dictionary`);
365
+ }
366
+ const obj = q as Record<string, unknown>;
367
+ if (!('key_name' in obj)) {
368
+ throw new Error(`Question ${i + 1} is missing 'key_name' field`);
369
+ }
370
+ if (!('question_text' in obj)) {
371
+ throw new Error(`Question ${i + 1} is missing 'question_text' field`);
372
+ }
373
+ }
374
+ }
375
+
376
+ /**
377
+ * Prompt section describing the question flow to the agent. Mirrors Python
378
+ * `_get_prompt_sections` (skill.py:141-156).
379
+ */
380
+ protected override _getPromptSections(): SkillPromptSection[] {
381
+ return [
382
+ {
383
+ title: `Info Gatherer (${this.getInstanceKey()})`,
384
+ body:
385
+ `You need to gather answers to a series of questions from the user. ` +
386
+ `Start by introducing yourself and asking the user if they are ready ` +
387
+ `to answer some questions. Once the user confirms they are ready, ` +
388
+ `call the ${this.startToolName} function to get the first question. ` +
389
+ `Ask the user that question, wait for their response, then call ` +
390
+ `${this.submitToolName} with the answer they gave you. ` +
391
+ `Each call to ${this.submitToolName} will return the next question ` +
392
+ `to ask. Repeat this process until all questions are complete.`,
393
+ },
394
+ ];
395
+ }
396
+ }
397
+
398
+ /**
399
+ * Factory function for creating InfoGathererSkill instances.
400
+ * @param config - Optional skill configuration.
401
+ * @returns A new InfoGathererSkill instance.
402
+ */
403
+ export function createSkill(config?: SkillConfig): InfoGathererSkill {
404
+ return new InfoGathererSkill(config);
405
+ }
@@ -0,0 +1,191 @@
1
+ /**
2
+ * Joke Skill - Tells random jokes from a built-in collection.
3
+ *
4
+ * Tier 1 built-in skill: no external dependencies required.
5
+ * Contains a curated set of jokes across multiple categories.
6
+ */
7
+
8
+ import { SkillBase } from '../SkillBase.js';
9
+ import type {
10
+ SkillToolDefinition,
11
+ SkillPromptSection,
12
+ SkillConfig,
13
+ ParameterSchemaEntry,
14
+ } from '../SkillBase.js';
15
+ import { FunctionResult } from '../../FunctionResult.js';
16
+
17
+ /** Internal representation of a joke with setup and punchline. */
18
+ interface Joke {
19
+ /** Joke category (e.g., "general", "programming", "dad"). */
20
+ category: string;
21
+ /** The joke setup line. */
22
+ setup: string;
23
+ /** The joke punchline. */
24
+ punchline: string;
25
+ }
26
+
27
+ const JOKES: Joke[] = [
28
+ // General
29
+ {
30
+ category: 'general',
31
+ setup: 'Why did the scarecrow win an award?',
32
+ punchline: 'Because he was outstanding in his field.',
33
+ },
34
+ {
35
+ category: 'general',
36
+ setup: 'What do you call a fake noodle?',
37
+ punchline: 'An impasta.',
38
+ },
39
+ {
40
+ category: 'general',
41
+ setup: 'Why did the bicycle fall over?',
42
+ punchline: 'Because it was two-tired.',
43
+ },
44
+ // Programming
45
+ {
46
+ category: 'programming',
47
+ setup: 'Why do programmers prefer dark mode?',
48
+ punchline: 'Because light attracts bugs.',
49
+ },
50
+ {
51
+ category: 'programming',
52
+ setup: 'What is a programmer\'s favorite hangout place?',
53
+ punchline: 'Foo Bar.',
54
+ },
55
+ {
56
+ category: 'programming',
57
+ setup: 'Why do Java developers wear glasses?',
58
+ punchline: 'Because they can\'t C#.',
59
+ },
60
+ {
61
+ category: 'programming',
62
+ setup: 'How many programmers does it take to change a light bulb?',
63
+ punchline: 'None. That\'s a hardware problem.',
64
+ },
65
+ // Dad jokes
66
+ {
67
+ category: 'dad',
68
+ setup: 'I\'m reading a book about anti-gravity.',
69
+ punchline: 'It\'s impossible to put down.',
70
+ },
71
+ {
72
+ category: 'dad',
73
+ setup: 'What did the ocean say to the beach?',
74
+ punchline: 'Nothing, it just waved.',
75
+ },
76
+ {
77
+ category: 'dad',
78
+ setup: 'Why don\'t skeletons fight each other?',
79
+ punchline: 'They don\'t have the guts.',
80
+ },
81
+ ];
82
+
83
+ const VALID_CATEGORIES = ['general', 'programming', 'dad'];
84
+
85
+ /**
86
+ * Tells random jokes from a curated built-in collection.
87
+ *
88
+ * Tier 1 built-in skill with no external dependencies. Includes general,
89
+ * programming, and dad joke categories.
90
+ */
91
+ export class JokeSkill extends SkillBase {
92
+ // Python ground truth: skills/joke/skill.py
93
+ static override SKILL_NAME = 'joke';
94
+ static override SKILL_DESCRIPTION = 'Tell jokes using the API Ninjas joke API';
95
+ static override SKILL_VERSION = '1.0.0';
96
+ static override REQUIRED_PACKAGES: readonly string[] = [];
97
+ static override REQUIRED_ENV_VARS: readonly string[] = [];
98
+
99
+ static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
100
+ return {
101
+ ...super.getParameterSchema(),
102
+ tool_name: {
103
+ type: 'string',
104
+ description: 'Custom name for the joke tool',
105
+ default: 'tell_joke',
106
+ },
107
+ };
108
+ }
109
+
110
+ /**
111
+ * Signal to the agent prompt that the joke skill is active. Python
112
+ * parity: `get_global_data` returns `{"joke_skill_enabled": true}`.
113
+ */
114
+ override getGlobalData(): Record<string, unknown> {
115
+ return { joke_skill_enabled: true };
116
+ }
117
+
118
+ /** @returns A single joke tool (configurable name) that returns a random joke with optional category filter. */
119
+ getTools(): SkillToolDefinition[] {
120
+ const toolName = this.getConfig<string>('tool_name', 'tell_joke');
121
+
122
+ return [
123
+ {
124
+ name: toolName,
125
+ description:
126
+ 'Tell a random joke. Optionally specify a category to get a joke from that category.',
127
+ parameters: {
128
+ category: {
129
+ type: 'string',
130
+ description:
131
+ 'Joke category: "general", "programming", or "dad". If not specified, a random joke from any category is returned.',
132
+ },
133
+ },
134
+ handler: (args: Record<string, unknown>) => {
135
+ const category = args.category as string | undefined;
136
+
137
+ let pool = JOKES;
138
+
139
+ if (category && typeof category === 'string') {
140
+ const normalized = category.toLowerCase().trim();
141
+
142
+ if (!VALID_CATEGORIES.includes(normalized)) {
143
+ return new FunctionResult(
144
+ `Unknown joke category "${category}". Available categories are: ${VALID_CATEGORIES.join(', ')}.`,
145
+ );
146
+ }
147
+
148
+ pool = JOKES.filter((j) => j.category === normalized);
149
+ }
150
+
151
+ if (pool.length === 0) {
152
+ return new FunctionResult(
153
+ 'Sorry, I could not find any jokes for that category.',
154
+ );
155
+ }
156
+
157
+ const joke = pool[Math.floor(Math.random() * pool.length)]!;
158
+
159
+ return new FunctionResult(
160
+ `${joke.setup} ... ${joke.punchline}`,
161
+ );
162
+ },
163
+ },
164
+ ];
165
+ }
166
+
167
+ protected override _getPromptSections(): SkillPromptSection[] {
168
+ const toolName = this.getConfig<string>('tool_name', 'tell_joke');
169
+ return [
170
+ {
171
+ title: 'Jokes',
172
+ body: 'You have the ability to tell jokes to lighten the mood.',
173
+ bullets: [
174
+ `Use the ${toolName} tool when a user asks for a joke or when humor is appropriate.`,
175
+ 'Available joke categories: general, programming, and dad jokes.',
176
+ 'If the user asks for a specific type of joke, pass the category parameter.',
177
+ 'Deliver the joke naturally: say the setup, pause briefly, then deliver the punchline.',
178
+ ],
179
+ },
180
+ ];
181
+ }
182
+ }
183
+
184
+ /**
185
+ * Factory function for creating JokeSkill instances.
186
+ * @param config - Optional skill configuration.
187
+ * @returns A new JokeSkill instance.
188
+ */
189
+ export function createSkill(config?: SkillConfig): JokeSkill {
190
+ return new JokeSkill(config);
191
+ }