@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,367 @@
1
+ /**
2
+ * SkillRegistry - Global singleton registry for discovering and loading skills.
3
+ *
4
+ * Matches Python's `skills/registry.py:SkillRegistry`: the registry stores
5
+ * **class references** keyed by each class's static `SKILL_NAME`, and reads
6
+ * metadata (description, version, required packages/env vars,
7
+ * multi-instance support) by direct static-attribute access.
8
+ *
9
+ * Registration via `register(SkillClass)` validates that the class defines
10
+ * `SKILL_NAME`, that `getParameterSchema()` is callable and returns a
11
+ * non-empty object (Python `register_skill` at `registry.py:132-194`).
12
+ *
13
+ * Supports the `SIGNALWIRE_SKILL_PATHS` environment variable for custom
14
+ * skill directories, matching Python's discovery search path.
15
+ */
16
+
17
+ import { SkillBase, type SkillConfig, type ParameterSchemaEntry } from './SkillBase.js';
18
+ import { getLogger } from '../Logger.js';
19
+
20
+ const log = getLogger('SkillRegistry');
21
+
22
+ /**
23
+ * Metadata exposed for a registered skill. Shape matches Python's
24
+ * `SkillRegistry.list_skills()` / `get_all_skills_schema()` return values
25
+ * (`skills/registry.py:205-227`, `229-296`).
26
+ */
27
+ export interface SkillSchemaInfo {
28
+ /** The skill's registered name (from `SkillBase.SKILL_NAME`). */
29
+ name: string;
30
+ /** Human-readable description (from `SkillBase.SKILL_DESCRIPTION`). */
31
+ description: string;
32
+ /** Semantic version string (from `SkillBase.SKILL_VERSION`). */
33
+ version: string;
34
+ /** Whether this skill supports multiple simultaneous instances. */
35
+ supportsMultipleInstances: boolean;
36
+ /** Environment variables required by the skill. */
37
+ requiredEnvVars: string[];
38
+ /** NPM packages required by the skill. */
39
+ requiredPackages: string[];
40
+ /** Full parameter schema with types, defaults, and constraints. */
41
+ parameters: Record<string, ParameterSchemaEntry>;
42
+ /** Optional source category for grouping (e.g., "builtin", "external"). */
43
+ source?: string;
44
+ }
45
+
46
+ let _instance: SkillRegistry | null = null;
47
+
48
+ /**
49
+ * Global singleton registry for registering and instantiating skills.
50
+ *
51
+ * Skills can be registered programmatically via `register(SkillClass)`.
52
+ * Matches Python's `skill_registry` global (`skills/registry.py:481`).
53
+ */
54
+ export class SkillRegistry {
55
+ /**
56
+ * Map from `SKILL_NAME` to class reference. Matches Python's
57
+ * `self._skills: Dict[str, Type[SkillBase]]` (`registry.py:26`).
58
+ */
59
+ private registry: Map<string, typeof SkillBase> = new Map();
60
+ private lockedNames: Set<string> = new Set();
61
+ private searchPaths: string[];
62
+
63
+ constructor() {
64
+ const envPaths = process.env['SIGNALWIRE_SKILL_PATHS'];
65
+ this.searchPaths = envPaths ? envPaths.split(':').filter(Boolean) : [];
66
+ }
67
+
68
+ /**
69
+ * Get the global singleton instance, creating it on first access.
70
+ * @returns The shared SkillRegistry instance.
71
+ */
72
+ static getInstance(): SkillRegistry {
73
+ if (!_instance) {
74
+ _instance = new SkillRegistry();
75
+ }
76
+ return _instance;
77
+ }
78
+
79
+ /**
80
+ * Reset the global singleton (for testing).
81
+ */
82
+ static resetInstance(): void {
83
+ _instance = null;
84
+ }
85
+
86
+ /**
87
+ * Register a skill class. The skill name is read from the class's static
88
+ * `SKILL_NAME`. Mirrors Python's `register_skill(skill_class)`
89
+ * (`skills/registry.py:132-194`) — including the schema-non-empty check
90
+ * and the protection against overwriting locked skills.
91
+ *
92
+ * @param SkillClass - A concrete subclass of `SkillBase` with a
93
+ * non-empty `SKILL_NAME`.
94
+ */
95
+ register(SkillClass: typeof SkillBase): void {
96
+ const name = SkillClass.SKILL_NAME;
97
+ if (!name) {
98
+ throw new Error(
99
+ `${SkillClass.name} must define static SKILL_NAME before registration ` +
100
+ `(Python equivalent: registry.py:150 SKILL_NAME validation).`,
101
+ );
102
+ }
103
+ if (this.lockedNames.has(name)) {
104
+ log.warn(`Cannot overwrite locked skill: ${name}`);
105
+ return;
106
+ }
107
+ // Schema non-emptiness check — Python registry.py:163-166.
108
+ try {
109
+ const schema = SkillClass.getParameterSchema();
110
+ if (!schema || typeof schema !== 'object' || Object.keys(schema).length === 0) {
111
+ throw new Error(
112
+ `${SkillClass.name}.getParameterSchema() must return a non-empty object`,
113
+ );
114
+ }
115
+ } catch (err) {
116
+ throw new Error(
117
+ `${SkillClass.name}.getParameterSchema() failed: ${err instanceof Error ? err.message : String(err)}`,
118
+ );
119
+ }
120
+ if (this.registry.has(name)) {
121
+ log.warn(`Overwriting skill registration: ${name}`);
122
+ }
123
+ this.registry.set(name, SkillClass);
124
+ log.debug(`Registered skill: ${name}`);
125
+ }
126
+
127
+ /**
128
+ * Lock one or more skill names to prevent overwriting.
129
+ * If called with no arguments, locks all currently registered skills.
130
+ * @param names - Skill names to lock; if omitted, all current names are locked.
131
+ */
132
+ lock(names?: string[]): void {
133
+ const toLock = names ?? Array.from(this.registry.keys());
134
+ for (const name of toLock) {
135
+ this.lockedNames.add(name);
136
+ }
137
+ }
138
+
139
+ /**
140
+ * Unregister a skill by name, removing it from the registry.
141
+ * @param name - The skill name to unregister.
142
+ * @returns True if the skill was found and removed.
143
+ */
144
+ unregister(name: string): boolean {
145
+ return this.registry.delete(name);
146
+ }
147
+
148
+ /**
149
+ * Create a new skill instance by looking up its class in the registry.
150
+ * Matches Python's `skill_manager.load_skill(name)` class-lookup + instantiate
151
+ * flow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`).
152
+ *
153
+ * @param name - The registered skill name.
154
+ * @param config - Optional configuration to pass to the skill constructor.
155
+ * @returns A new skill instance, or null if the name is not registered.
156
+ */
157
+ create(name: string, config?: SkillConfig): SkillBase | null {
158
+ const SkillClass = this.registry.get(name);
159
+ if (!SkillClass) {
160
+ log.warn(`Skill not found in registry: ${name}`);
161
+ return null;
162
+ }
163
+ // typeof SkillBase is abstract at the type level; concrete subclasses
164
+ // are what's actually stored. Cast through unknown to allow `new`.
165
+ const Ctor = SkillClass as unknown as new (config?: SkillConfig) => SkillBase;
166
+ return new Ctor(config);
167
+ }
168
+
169
+ /**
170
+ * Get the registered skill class by name. Matches Python's
171
+ * `get_skill_class(skill_name)` (`registry.py:196-203`).
172
+ * @param name - The registered skill name.
173
+ * @returns The skill class reference, or undefined if not registered.
174
+ */
175
+ getSkillClass(name: string): typeof SkillBase | undefined {
176
+ return this.registry.get(name);
177
+ }
178
+
179
+ /**
180
+ * Check if a skill name is registered.
181
+ * @param name - The skill name to check.
182
+ * @returns True if the skill is registered.
183
+ */
184
+ has(name: string): boolean {
185
+ return this.registry.has(name);
186
+ }
187
+
188
+ /**
189
+ * List all registered skill names.
190
+ * @returns Array of registered skill name strings.
191
+ */
192
+ listRegistered(): string[] {
193
+ return Array.from(this.registry.keys());
194
+ }
195
+
196
+ /**
197
+ * List all registered skills with their full metadata. Matches Python's
198
+ * `list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic
199
+ * camelCase keys.
200
+ * @returns Array of skill metadata objects.
201
+ */
202
+ listSkills(): SkillSchemaInfo[] {
203
+ return Array.from(this.registry.values()).map((SkillClass) => ({
204
+ name: SkillClass.SKILL_NAME,
205
+ description: SkillClass.SKILL_DESCRIPTION,
206
+ version: SkillClass.SKILL_VERSION,
207
+ supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
208
+ requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
209
+ requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
210
+ parameters: SkillClass.getParameterSchema(),
211
+ }));
212
+ }
213
+
214
+ /**
215
+ * Add a directory path to search during skill discovery.
216
+ * @param path - Absolute path to a directory containing skill files.
217
+ */
218
+ addSearchPath(path: string): void {
219
+ if (!this.searchPaths.includes(path)) {
220
+ this.searchPaths.push(path);
221
+ }
222
+ }
223
+
224
+ /**
225
+ * Get all configured search paths for skill discovery.
226
+ * @returns Copy of the search paths array.
227
+ */
228
+ getSearchPaths(): string[] {
229
+ return [...this.searchPaths];
230
+ }
231
+
232
+ /**
233
+ * Discover and register skills from a directory by importing each file.
234
+ * Looks for SkillBase subclass exports and registers them.
235
+ * @param dirPath - Absolute path to the directory to scan.
236
+ * @returns Array of newly discovered skill names.
237
+ */
238
+ async discoverFromDirectory(dirPath: string): Promise<string[]> {
239
+ if (process.env['SWML_SKILL_DISCOVERY_ENABLED'] !== 'true') {
240
+ log.warn('Skill directory discovery is disabled. Set SWML_SKILL_DISCOVERY_ENABLED=true to enable.');
241
+ return [];
242
+ }
243
+ const { readdir } = await import('node:fs/promises');
244
+ const { join } = await import('node:path');
245
+ const { pathToFileURL } = await import('node:url');
246
+
247
+ const discovered: string[] = [];
248
+ let entries: string[];
249
+
250
+ try {
251
+ const dirEntries = await readdir(dirPath, { withFileTypes: true });
252
+ entries = dirEntries
253
+ .filter(e => (e.isFile() && (e.name.endsWith('.ts') || e.name.endsWith('.js'))) || e.isDirectory())
254
+ .map(e => e.name);
255
+ } catch {
256
+ log.warn(`Cannot read skill directory: ${dirPath}`);
257
+ return discovered;
258
+ }
259
+
260
+ for (const entry of entries) {
261
+ const fullPath = join(dirPath, entry);
262
+ try {
263
+ const fileUrl = pathToFileURL(
264
+ entry.endsWith('.ts') || entry.endsWith('.js') ? fullPath : join(fullPath, 'skill.ts'),
265
+ ).href;
266
+ const mod: Record<string, unknown> = await import(fileUrl);
267
+
268
+ // Find any SkillBase subclass exported from the module. Matches
269
+ // Python `registry.py:104-113` which inspects loaded modules for
270
+ // `issubclass(obj, SkillBase)`.
271
+ for (const value of Object.values(mod)) {
272
+ if (
273
+ typeof value === 'function' &&
274
+ (value as { prototype?: unknown }).prototype instanceof SkillBase &&
275
+ (value as typeof SkillBase).SKILL_NAME
276
+ ) {
277
+ const SkillClass = value as typeof SkillBase;
278
+ this.register(SkillClass);
279
+ discovered.push(SkillClass.SKILL_NAME);
280
+ }
281
+ }
282
+ } catch (err) {
283
+ log.debug(`Could not load skill from ${fullPath}: ${err}`);
284
+ }
285
+ }
286
+
287
+ return discovered;
288
+ }
289
+
290
+ /**
291
+ * Discover and register skills from all configured search paths.
292
+ * @returns Array of all newly discovered skill names.
293
+ */
294
+ async discoverAll(): Promise<string[]> {
295
+ const all: string[] = [];
296
+ for (const path of this.searchPaths) {
297
+ const found = await this.discoverFromDirectory(path);
298
+ all.push(...found);
299
+ }
300
+ return all;
301
+ }
302
+
303
+ /**
304
+ * Get the combined schema info for a registered skill.
305
+ * Matches Python `get_all_skills_schema` per-skill shape
306
+ * (`registry.py:287-295`).
307
+ * @param name - The registered skill name to query.
308
+ * @returns The skill's schema info, or undefined if not found.
309
+ */
310
+ getSkillSchema(name: string): SkillSchemaInfo | undefined {
311
+ const SkillClass = this.registry.get(name);
312
+ if (!SkillClass) return undefined;
313
+ return {
314
+ name: SkillClass.SKILL_NAME,
315
+ description: SkillClass.SKILL_DESCRIPTION,
316
+ version: SkillClass.SKILL_VERSION,
317
+ supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
318
+ requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
319
+ requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
320
+ parameters: SkillClass.getParameterSchema(),
321
+ };
322
+ }
323
+
324
+ /**
325
+ * Get combined schema info for all registered skills.
326
+ * @returns Record mapping skill names to their schema info.
327
+ */
328
+ getAllSkillsSchema(): Record<string, SkillSchemaInfo> {
329
+ const result: Record<string, SkillSchemaInfo> = {};
330
+ for (const name of this.registry.keys()) {
331
+ const schema = this.getSkillSchema(name);
332
+ if (schema) result[name] = schema;
333
+ }
334
+ return result;
335
+ }
336
+
337
+ /**
338
+ * Group registered skill names by source category. Matches Python's
339
+ * `list_all_skill_sources` (`skills/registry.py:436-478`).
340
+ *
341
+ * Current TS implementation treats every registered skill as "registered"
342
+ * (the only category that fits — filesystem-based discovery is optional
343
+ * and entry-points don't apply to Node the way they do to Python).
344
+ *
345
+ * @returns Record mapping source categories to arrays of skill names.
346
+ */
347
+ listAllSkillSources(): Record<string, string[]> {
348
+ return {
349
+ registered: Array.from(this.registry.keys()),
350
+ };
351
+ }
352
+
353
+ /**
354
+ * Get the number of registered skills.
355
+ * @returns The count of registered skills.
356
+ */
357
+ get size(): number {
358
+ return this.registry.size;
359
+ }
360
+
361
+ /**
362
+ * Clear all registrations.
363
+ */
364
+ clear(): void {
365
+ this.registry.clear();
366
+ }
367
+ }
@@ -0,0 +1,280 @@
1
+ /**
2
+ * API Ninjas Trivia Skill - Fetches trivia questions from the API Ninjas service.
3
+ *
4
+ * Tier 2 built-in skill: requires API_NINJAS_KEY environment variable.
5
+ * Uses the API Ninjas Trivia endpoint to retrieve random trivia questions
6
+ * with optional category filtering.
7
+ */
8
+
9
+ import { SkillBase } from '../SkillBase.js';
10
+ import type {
11
+ SkillToolDefinition,
12
+ SkillPromptSection,
13
+ SkillConfig,
14
+ ParameterSchemaEntry,
15
+ } from '../SkillBase.js';
16
+ import { FunctionResult } from '../../FunctionResult.js';
17
+ import { getLogger } from '../../Logger.js';
18
+
19
+ const log = getLogger('ApiNinjasTriviaSkill');
20
+
21
+ /** Response shape from the API Ninjas trivia endpoint. */
22
+ interface TriviaResponse {
23
+ /** Trivia category name. */
24
+ category: string;
25
+ /** The trivia question text. */
26
+ question: string;
27
+ /** The correct answer. */
28
+ answer: string;
29
+ }
30
+
31
+ const VALID_CATEGORIES = [
32
+ 'artliterature',
33
+ 'language',
34
+ 'sciencenature',
35
+ 'general',
36
+ 'fooddrink',
37
+ 'peopleplaces',
38
+ 'geography',
39
+ 'historyholidays',
40
+ 'entertainment',
41
+ 'toysgames',
42
+ 'music',
43
+ 'mathematics',
44
+ 'religionmythology',
45
+ 'sportsleisure',
46
+ ] as const;
47
+
48
+ /**
49
+ * Fetches trivia questions from the API Ninjas service.
50
+ *
51
+ * Tier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable.
52
+ * Supports optional `default_category` and `reveal_answer` config options.
53
+ */
54
+ export class ApiNinjasTriviaSkill extends SkillBase {
55
+ static override SKILL_NAME = 'api_ninjas_trivia';
56
+ static override SKILL_DESCRIPTION = 'Get trivia questions from API Ninjas';
57
+ // Python skill.py:61 — `REQUIRED_ENV_VARS = []` because the api_key can
58
+ // be supplied via params. The handler still falls back to `API_NINJAS_KEY`
59
+ // so env-based configuration keeps working.
60
+ static override REQUIRED_ENV_VARS: readonly string[] = [];
61
+ static override SUPPORTS_MULTIPLE_INSTANCES = true;
62
+
63
+ static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
64
+ return {
65
+ ...super.getParameterSchema(),
66
+ tool_name: {
67
+ type: 'string',
68
+ description:
69
+ 'Custom name for the SWAIG trivia tool (enables multiple instances).',
70
+ default: 'get_trivia',
71
+ },
72
+ api_key: {
73
+ type: 'string',
74
+ description: 'API Ninjas API key.',
75
+ hidden: true,
76
+ env_var: 'API_NINJAS_KEY',
77
+ required: true,
78
+ },
79
+ categories: {
80
+ type: 'array',
81
+ description:
82
+ 'Subset of trivia categories to enable. Defaults to all categories.',
83
+ required: false,
84
+ default: [...VALID_CATEGORIES],
85
+ items: {
86
+ type: 'string',
87
+ enum: [...VALID_CATEGORIES],
88
+ },
89
+ },
90
+ default_category: {
91
+ type: 'string',
92
+ description: 'Default trivia category if none is specified.',
93
+ },
94
+ reveal_answer: {
95
+ type: 'boolean',
96
+ description: 'Whether to include the answer in the response.',
97
+ default: false,
98
+ },
99
+ };
100
+ }
101
+
102
+ /**
103
+ * Produce a compound instance key matching Python `get_instance_key`
104
+ * (skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with
105
+ * `tool_name` defaulting to `'get_trivia'` (skill.py:95). The base
106
+ * `SkillBase.getInstanceKey` uses `this.skillName` as the fallback,
107
+ * so we override to match Python's `'get_trivia'` default.
108
+ */
109
+ override getInstanceKey(): string {
110
+ const toolName = this.getConfig<string>('tool_name', 'get_trivia');
111
+ return `${this.skillName}_${toolName}`;
112
+ }
113
+
114
+ /** @returns A single trivia tool (configurable name) that fetches a random trivia question with optional category. */
115
+ getTools(): SkillToolDefinition[] {
116
+ const toolName = this.getConfig<string>('tool_name', 'get_trivia');
117
+ const defaultCategory = this.getConfig<string | undefined>(
118
+ 'default_category',
119
+ undefined,
120
+ );
121
+ const revealAnswer = this.getConfig<boolean>('reveal_answer', false);
122
+ const configuredCategories = this.getConfig<string[] | undefined>(
123
+ 'categories',
124
+ undefined,
125
+ );
126
+ const enabledCategories =
127
+ Array.isArray(configuredCategories) && configuredCategories.length > 0
128
+ ? configuredCategories.filter((c): c is string =>
129
+ (VALID_CATEGORIES as readonly string[]).includes(c),
130
+ )
131
+ : [...VALID_CATEGORIES];
132
+
133
+ return [
134
+ {
135
+ name: toolName,
136
+ description:
137
+ 'Get a random trivia question. Optionally specify a category to narrow the topic.',
138
+ parameters: {
139
+ category: {
140
+ type: 'string',
141
+ description:
142
+ 'Trivia category. Available categories: ' +
143
+ enabledCategories.join(', ') +
144
+ '. If not specified, a random category is used.',
145
+ enum: enabledCategories,
146
+ },
147
+ },
148
+ handler: async (args: Record<string, unknown>) => {
149
+ const apiKey =
150
+ this.getConfig<string | undefined>('api_key', undefined) ??
151
+ process.env['API_NINJAS_KEY'];
152
+ if (!apiKey) {
153
+ return new FunctionResult(
154
+ 'Trivia service is not configured. The API_NINJAS_KEY environment variable is missing.',
155
+ );
156
+ }
157
+
158
+ let category = (args.category as string | undefined) ?? defaultCategory;
159
+
160
+ // Validate category if provided
161
+ if (category && typeof category === 'string') {
162
+ const normalized = category.toLowerCase().trim().replace(/[\s_-]/g, '');
163
+ if (
164
+ !enabledCategories.includes(normalized)
165
+ ) {
166
+ return new FunctionResult(
167
+ `Unknown trivia category "${category}". Available categories: ${enabledCategories.join(', ')}.`,
168
+ );
169
+ }
170
+ category = normalized;
171
+ }
172
+
173
+ try {
174
+ const url = category
175
+ ? `https://api.api-ninjas.com/v1/trivia?category=${encodeURIComponent(category)}`
176
+ : 'https://api.api-ninjas.com/v1/trivia';
177
+
178
+ const controller = new AbortController();
179
+ const timeout = setTimeout(() => controller.abort(), 30_000);
180
+ let response: Response;
181
+ try {
182
+ response = await fetch(url, {
183
+ headers: {
184
+ 'X-Api-Key': apiKey,
185
+ },
186
+ signal: controller.signal,
187
+ });
188
+ } finally {
189
+ clearTimeout(timeout);
190
+ }
191
+
192
+ if (!response.ok) {
193
+ log.error('trivia_api_error', { status: response.status });
194
+ return new FunctionResult(
195
+ 'The trivia service encountered an error. Please try again later.',
196
+ );
197
+ }
198
+
199
+ const data = (await response.json()) as TriviaResponse[];
200
+
201
+ if (!Array.isArray(data) || data.length === 0) {
202
+ return new FunctionResult(
203
+ 'No trivia questions were returned. Please try again or try a different category.',
204
+ );
205
+ }
206
+
207
+ const trivia = data[0]!;
208
+
209
+ if (revealAnswer) {
210
+ return new FunctionResult(
211
+ `Trivia (${trivia.category}): ${trivia.question} Answer: ${trivia.answer}`,
212
+ );
213
+ }
214
+
215
+ // When not revealing the answer, provide it in a structured way
216
+ // so the AI knows the answer but can quiz the user
217
+ return new FunctionResult(
218
+ `Here is a trivia question from the "${trivia.category}" category. ` +
219
+ `Question: ${trivia.question} ` +
220
+ `[The correct answer is: ${trivia.answer}. Do not reveal this unless the user attempts an answer or asks for it.]`,
221
+ );
222
+ } catch (err) {
223
+ log.error('get_trivia_failed', { error: err instanceof Error ? err.message : String(err) });
224
+ return new FunctionResult(
225
+ 'The request could not be completed. Please try again.',
226
+ );
227
+ }
228
+ },
229
+ },
230
+ ];
231
+ }
232
+
233
+ /** @returns Prompt section describing trivia capabilities and quiz behavior. */
234
+ protected override _getPromptSections(): SkillPromptSection[] {
235
+ const revealAnswer = this.getConfig<boolean>('reveal_answer', false);
236
+
237
+ const bullets: string[] = [
238
+ 'Use the get_trivia tool to fetch a random trivia question.',
239
+ `Available categories: ${VALID_CATEGORIES.join(', ')}.`,
240
+ 'If no category is specified, a random category will be selected.',
241
+ ];
242
+
243
+ if (!revealAnswer) {
244
+ bullets.push(
245
+ 'When you receive a trivia question, ask it to the user and let them try to answer before revealing the correct answer.',
246
+ 'If the user gets it wrong, give them a hint or tell them the correct answer.',
247
+ );
248
+ } else {
249
+ bullets.push(
250
+ 'Trivia answers are included in the response. Share the question and answer with the user.',
251
+ );
252
+ }
253
+
254
+ bullets.push(
255
+ 'Keep trivia fun and engaging. Encourage the user to try more questions.',
256
+ );
257
+
258
+ return [
259
+ {
260
+ title: 'Trivia Questions',
261
+ body: 'You can fetch and ask trivia questions from a wide range of categories.',
262
+ bullets,
263
+ },
264
+ ];
265
+ }
266
+
267
+ /** @returns Speech recognition hints for trivia-related keywords. */
268
+ getHints(): string[] {
269
+ return ['trivia', 'quiz', 'question', 'fun fact'];
270
+ }
271
+ }
272
+
273
+ /**
274
+ * Factory function for creating ApiNinjasTriviaSkill instances.
275
+ * @param config - Optional skill configuration.
276
+ * @returns A new ApiNinjasTriviaSkill instance.
277
+ */
278
+ export function createSkill(config?: SkillConfig): ApiNinjasTriviaSkill {
279
+ return new ApiNinjasTriviaSkill(config);
280
+ }