@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,361 @@
1
+ /**
2
+ * SchemaUtils - JSON Schema validation for SWML documents.
3
+ *
4
+ * Provides basic structural validation of rendered SWML and
5
+ * schema-driven verb extraction/validation.
6
+ * Set SWML_SKIP_SCHEMA_VALIDATION=true to disable.
7
+ */
8
+
9
+ import { createRequire } from 'module';
10
+
11
+ /** Result of validating a SWML document. */
12
+ export interface ValidationResult {
13
+ /** Whether the document passed all validation checks. */
14
+ valid: boolean;
15
+ /** List of human-readable error messages; empty when valid. */
16
+ errors: string[];
17
+ }
18
+
19
+ /** A verb definition extracted from the schema. */
20
+ export interface VerbDefinition {
21
+ /** The verb name as used in SWML (e.g. "answer", "hangup", "sip_refer"). */
22
+ name: string;
23
+ /** The PascalCase schema definition name (e.g. "Answer", "Hangup", "SIPRefer"). */
24
+ schemaName: string;
25
+ /** The raw JSON Schema definition object for this verb. */
26
+ definition: Record<string, unknown>;
27
+ }
28
+
29
+ // Basic SWML structure expectations
30
+ const REQUIRED_TOP_LEVEL = ['version', 'sections'];
31
+ const VALID_VERSIONS = ['1.0.0'];
32
+
33
+ /** Validates SWML documents against structural rules with an LRU-style result cache. */
34
+ export class SchemaUtils {
35
+ private skipValidation: boolean;
36
+ private cache: Map<string, ValidationResult> = new Map();
37
+ private maxCacheSize: number;
38
+ private schema: Record<string, unknown> | null = null;
39
+ private verbs: Map<string, VerbDefinition> = new Map();
40
+ /** Path to the schema file, or null to use the bundled schema. */
41
+ private schemaPath: string | null;
42
+
43
+ /**
44
+ * Create a SchemaUtils instance.
45
+ * @param opts - Optional settings for skipping validation, limiting cache size, or overriding the schema file path.
46
+ */
47
+ constructor(opts?: { skipValidation?: boolean; maxCacheSize?: number; schemaPath?: string }) {
48
+ this.skipValidation = opts?.skipValidation ?? (process.env['SWML_SKIP_SCHEMA_VALIDATION'] === 'true');
49
+ this.maxCacheSize = opts?.maxCacheSize ?? 100;
50
+ this.schemaPath = opts?.schemaPath ?? null;
51
+ this.loadSchema();
52
+ }
53
+
54
+ /**
55
+ * Load the schema from the path specified in opts.schemaPath (if given) or fall back
56
+ * to the bundled schema.json. Mirrors Python's SchemaUtils which accepts an explicit
57
+ * schema_path and falls back to _get_default_schema_path() when None is supplied.
58
+ */
59
+ private loadSchema(): void {
60
+ // Try custom schema path first (mirrors Python's schema_path parameter)
61
+ if (this.schemaPath) {
62
+ try {
63
+ const require = createRequire(import.meta.url);
64
+ this.schema = require(this.schemaPath) as Record<string, unknown>;
65
+ this.verbs = this.extractVerbDefinitions();
66
+ return;
67
+ } catch {
68
+ // Fall through to bundled schema on load failure
69
+ }
70
+ }
71
+ // Fall back to bundled schema.json
72
+ try {
73
+ const require = createRequire(import.meta.url);
74
+ this.schema = require('./schema.json') as Record<string, unknown>;
75
+ this.verbs = this.extractVerbDefinitions();
76
+ } catch {
77
+ // Schema loading is optional — validation still works structurally
78
+ this.schema = null;
79
+ }
80
+ }
81
+
82
+ /**
83
+ * Extract verb definitions from `$defs/SWMLMethod.anyOf` in the schema.
84
+ * Mirrors Python SDK's `_extract_verb_definitions()`.
85
+ */
86
+ private extractVerbDefinitions(): Map<string, VerbDefinition> {
87
+ const verbs = new Map<string, VerbDefinition>();
88
+ if (!this.schema) return verbs;
89
+
90
+ const defs = this.schema['$defs'] as Record<string, unknown> | undefined;
91
+ if (!defs) return verbs;
92
+
93
+ const swmlMethod = defs['SWMLMethod'] as Record<string, unknown> | undefined;
94
+ if (!swmlMethod || !Array.isArray(swmlMethod['anyOf'])) return verbs;
95
+
96
+ for (const ref of swmlMethod['anyOf'] as Record<string, unknown>[]) {
97
+ const refPath = ref['$ref'] as string | undefined;
98
+ if (!refPath) continue;
99
+
100
+ // Extract the PascalCase name from "#/$defs/Answer"
101
+ const schemaName = refPath.split('/').pop()!;
102
+ const verbDef = defs[schemaName] as Record<string, unknown> | undefined;
103
+ if (!verbDef || !verbDef['properties']) continue;
104
+
105
+ // The actual verb name is the first (and only) property key
106
+ const propNames = Object.keys(verbDef['properties'] as Record<string, unknown>);
107
+ if (propNames.length === 0) continue;
108
+
109
+ const verbName = propNames[0];
110
+ verbs.set(verbName, {
111
+ name: verbName,
112
+ schemaName,
113
+ definition: verbDef,
114
+ });
115
+ }
116
+
117
+ return verbs;
118
+ }
119
+
120
+ /**
121
+ * Get all verb names defined in the schema.
122
+ * @returns Array of verb names (e.g. ["answer", "ai", "hangup", ...]).
123
+ */
124
+ getVerbNames(): string[] {
125
+ return Array.from(this.verbs.keys());
126
+ }
127
+
128
+ /**
129
+ * Get the inner properties schema for a specific verb.
130
+ * For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`.
131
+ * @param verbName - The verb name (e.g. "answer", "tap").
132
+ * @returns The inner schema definition or an empty object if not found.
133
+ */
134
+ getVerbProperties(verbName: string): Record<string, unknown> {
135
+ const verb = this.verbs.get(verbName);
136
+ if (!verb) return {};
137
+ const outerProps = verb.definition['properties'] as Record<string, unknown> | undefined;
138
+ if (!outerProps || !outerProps[verbName]) return {};
139
+ return outerProps[verbName] as Record<string, unknown>;
140
+ }
141
+
142
+ /**
143
+ * Get the required properties for a verb's inner config.
144
+ * @param verbName - The verb name.
145
+ * @returns Array of required property names.
146
+ */
147
+ getVerbRequiredProperties(verbName: string): string[] {
148
+ const innerSchema = this.getVerbProperties(verbName);
149
+ if (!innerSchema || !Array.isArray(innerSchema['required'])) return [];
150
+ return innerSchema['required'] as string[];
151
+ }
152
+
153
+ /**
154
+ * Get the description text for a verb.
155
+ * @param verbName - The verb name.
156
+ * @returns The description string or empty string.
157
+ */
158
+ getVerbDescription(verbName: string): string {
159
+ const innerSchema = this.getVerbProperties(verbName);
160
+ return (innerSchema['description'] as string) ?? '';
161
+ }
162
+
163
+ /**
164
+ * Check if a verb name is defined in the schema.
165
+ * @param verbName - The verb name.
166
+ * @returns True if the verb exists.
167
+ */
168
+ hasVerb(verbName: string): boolean {
169
+ return this.verbs.has(verbName);
170
+ }
171
+
172
+ /**
173
+ * Lightweight validation of a verb config against the schema.
174
+ * Checks that the verb exists and required properties are present.
175
+ * Mirrors Python SDK's `_validate_verb_lightweight()`.
176
+ *
177
+ * @param verbName - The verb name.
178
+ * @param config - The verb configuration to validate.
179
+ * @returns Validation result.
180
+ */
181
+ validateVerb(verbName: string, config: unknown): ValidationResult {
182
+ if (this.skipValidation) {
183
+ return { valid: true, errors: [] };
184
+ }
185
+
186
+ const errors: string[] = [];
187
+
188
+ // Check verb exists
189
+ if (!this.verbs.has(verbName)) {
190
+ errors.push(`Unknown verb: '${verbName}'`);
191
+ return { valid: false, errors };
192
+ }
193
+
194
+ const innerSchema = this.getVerbProperties(verbName);
195
+
196
+ // If the inner schema is not an object type (e.g. "label" takes a string,
197
+ // "sleep" takes anyOf int/object), skip property checks
198
+ const innerType = innerSchema['type'];
199
+ if (innerType !== 'object') {
200
+ return { valid: true, errors: [] };
201
+ }
202
+
203
+ // Config must be an object for object-typed verbs
204
+ if (typeof config !== 'object' || config === null || Array.isArray(config)) {
205
+ // Allow empty config for verbs with no required props
206
+ const required = this.getVerbRequiredProperties(verbName);
207
+ if (required.length > 0) {
208
+ errors.push(`Verb '${verbName}' expects an object config`);
209
+ return { valid: false, errors };
210
+ }
211
+ return { valid: true, errors: [] };
212
+ }
213
+
214
+ // Check required properties
215
+ const required = this.getVerbRequiredProperties(verbName);
216
+ const configObj = config as Record<string, unknown>;
217
+ for (const prop of required) {
218
+ if (!(prop in configObj)) {
219
+ errors.push(`Missing required property '${prop}' for verb '${verbName}'`);
220
+ }
221
+ }
222
+
223
+ return { valid: errors.length === 0, errors };
224
+ }
225
+
226
+ /**
227
+ * Validate a SWML document against structural rules.
228
+ * @param swml - The SWML document as a JSON string or parsed object.
229
+ * @returns The validation result indicating success or a list of errors.
230
+ */
231
+ validate(swml: string | Record<string, unknown>): ValidationResult {
232
+ if (this.skipValidation) {
233
+ return { valid: true, errors: [] };
234
+ }
235
+
236
+ const swmlStr = typeof swml === 'string' ? swml : JSON.stringify(swml);
237
+
238
+ // Check cache
239
+ const cached = this.cache.get(swmlStr);
240
+ if (cached) return cached;
241
+
242
+ const errors: string[] = [];
243
+ let doc: Record<string, unknown>;
244
+
245
+ try {
246
+ doc = typeof swml === 'string' ? JSON.parse(swml) : swml;
247
+ } catch {
248
+ const result: ValidationResult = { valid: false, errors: ['Invalid JSON'] };
249
+ this.cacheResult(swmlStr, result);
250
+ return result;
251
+ }
252
+
253
+ // Check top-level required keys
254
+ for (const key of REQUIRED_TOP_LEVEL) {
255
+ if (!(key in doc)) {
256
+ errors.push(`Missing required top-level key: ${key}`);
257
+ }
258
+ }
259
+
260
+ // Check version
261
+ if (doc['version'] && !VALID_VERSIONS.includes(doc['version'] as string)) {
262
+ errors.push(`Invalid version: ${doc['version']}. Expected one of: ${VALID_VERSIONS.join(', ')}`);
263
+ }
264
+
265
+ // Check sections
266
+ if (doc['sections']) {
267
+ if (typeof doc['sections'] !== 'object' || Array.isArray(doc['sections'])) {
268
+ errors.push('sections must be an object');
269
+ } else {
270
+ const sections = doc['sections'] as Record<string, unknown>;
271
+ if (!('main' in sections)) {
272
+ errors.push('sections must contain a "main" section');
273
+ }
274
+ // Validate each section is an array
275
+ for (const [name, section] of Object.entries(sections)) {
276
+ if (!Array.isArray(section)) {
277
+ errors.push(`Section "${name}" must be an array`);
278
+ }
279
+ }
280
+ }
281
+ }
282
+
283
+ // Validate AI verb structure if present
284
+ if (doc['sections'] && typeof doc['sections'] === 'object') {
285
+ const sections = doc['sections'] as Record<string, unknown[]>;
286
+ const main = sections['main'];
287
+ if (Array.isArray(main)) {
288
+ for (const verb of main) {
289
+ if (typeof verb === 'object' && verb !== null && 'ai' in verb) {
290
+ this.validateAiVerb((verb as Record<string, unknown>)['ai'] as Record<string, unknown>, errors);
291
+ }
292
+ }
293
+ }
294
+ }
295
+
296
+ const result: ValidationResult = {
297
+ valid: errors.length === 0,
298
+ errors,
299
+ };
300
+ this.cacheResult(swmlStr, result);
301
+ return result;
302
+ }
303
+
304
+ private validateAiVerb(ai: Record<string, unknown>, errors: string[]): void {
305
+ if (!ai) return;
306
+
307
+ // Prompt must have text
308
+ if (ai['prompt']) {
309
+ const prompt = ai['prompt'] as Record<string, unknown>;
310
+ if (typeof prompt === 'object' && !prompt['text']) {
311
+ errors.push('AI prompt must have a "text" field');
312
+ }
313
+ }
314
+
315
+ // SWAIG validation
316
+ if (ai['SWAIG']) {
317
+ const swaig = ai['SWAIG'] as Record<string, unknown>;
318
+ if (swaig['functions'] && !Array.isArray(swaig['functions'])) {
319
+ errors.push('SWAIG functions must be an array');
320
+ }
321
+ if (Array.isArray(swaig['functions'])) {
322
+ for (let i = 0; i < (swaig['functions'] as unknown[]).length; i++) {
323
+ const fn = (swaig['functions'] as Record<string, unknown>[])[i];
324
+ if (!fn['function']) {
325
+ errors.push(`SWAIG function at index ${i} missing "function" name`);
326
+ }
327
+ }
328
+ }
329
+ }
330
+
331
+ // Post-prompt validation
332
+ if (ai['post_prompt']) {
333
+ const pp = ai['post_prompt'] as Record<string, unknown>;
334
+ if (typeof pp === 'object' && !pp['text']) {
335
+ errors.push('AI post_prompt must have a "text" field');
336
+ }
337
+ }
338
+ }
339
+
340
+ /** Clear the validation cache */
341
+ clearCache(): void {
342
+ this.cache.clear();
343
+ }
344
+
345
+ /**
346
+ * Get the number of cached validation results.
347
+ * @returns The current cache entry count.
348
+ */
349
+ getCacheSize(): number {
350
+ return this.cache.size;
351
+ }
352
+
353
+ private cacheResult(key: string, result: ValidationResult): void {
354
+ if (this.cache.size >= this.maxCacheSize) {
355
+ // Remove oldest entry
356
+ const firstKey = this.cache.keys().next().value;
357
+ if (firstKey) this.cache.delete(firstKey);
358
+ }
359
+ this.cache.set(key, result);
360
+ }
361
+ }
@@ -0,0 +1,153 @@
1
+ /**
2
+ * SecurityUtils - Shared security utility functions.
3
+ *
4
+ * Provides prototype pollution protection, SSRF guards, header filtering,
5
+ * URL credential redaction, hostname validation, and input length limits.
6
+ */
7
+
8
+ import { lookup } from 'node:dns/promises';
9
+
10
+ /** Maximum allowed input length for skill handler arguments (characters). */
11
+ export const MAX_SKILL_INPUT_LENGTH = 1000;
12
+
13
+ /** Keys that must never be copied via object spread or assign. */
14
+ const DANGEROUS_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
15
+
16
+ /**
17
+ * Copy properties from `source` to `target`, filtering out prototype-pollution keys.
18
+ * Drop-in replacement for `Object.assign(target, source)` where `source` is untrusted.
19
+ * @param target - The object to assign into.
20
+ * @param source - The object to copy properties from.
21
+ * @returns The target object.
22
+ */
23
+ export function safeAssign<T extends Record<string, unknown>>(target: T, source: Record<string, unknown>): T {
24
+ for (const key of Object.keys(source)) {
25
+ if (!DANGEROUS_KEYS.has(key)) {
26
+ (target as Record<string, unknown>)[key] = source[key];
27
+ }
28
+ }
29
+ return target;
30
+ }
31
+
32
+ /** Headers that must be stripped before passing to user callbacks. */
33
+ const SENSITIVE_HEADERS = new Set([
34
+ 'authorization',
35
+ 'cookie',
36
+ 'x-api-key',
37
+ 'proxy-authorization',
38
+ 'set-cookie',
39
+ ]);
40
+
41
+ /**
42
+ * Return a copy of `headers` with sensitive entries (authorization, cookie, etc.) removed.
43
+ * @param headers - Original header record.
44
+ * @returns A new record with sensitive headers removed.
45
+ */
46
+ export function filterSensitiveHeaders(headers: Record<string, string>): Record<string, string> {
47
+ const result: Record<string, string> = {};
48
+ for (const [k, v] of Object.entries(headers)) {
49
+ if (!SENSITIVE_HEADERS.has(k.toLowerCase())) {
50
+ result[k] = v;
51
+ }
52
+ }
53
+ return result;
54
+ }
55
+
56
+ /**
57
+ * Redact credentials embedded in a URL (e.g. `https://user:secret@host` -> `https://user:****@host`).
58
+ * Returns the URL unchanged if no credentials are present.
59
+ * @param url - The URL string to redact.
60
+ * @returns The URL with the password portion replaced by `****`.
61
+ */
62
+ export function redactUrl(url: string): string {
63
+ return url.replace(/:\/\/([^:@]+):([^@]+)@/, '://$1:****@');
64
+ }
65
+
66
+ /**
67
+ * Validate that a hostname string does not contain whitespace, slashes, or control characters.
68
+ * @param host - Hostname to validate.
69
+ * @returns True if the hostname is valid.
70
+ */
71
+ export function isValidHostname(host: string): boolean {
72
+ if (!host || host.length === 0) return false;
73
+ // Reject whitespace, slashes, control chars
74
+ return !/[\s/\\]/.test(host) && !/[\x00-\x1f\x7f]/.test(host);
75
+ }
76
+
77
+ /**
78
+ * Check whether an IP address belongs to a private/reserved range.
79
+ * Covers RFC1918, loopback, link-local, IPv6 private (fc/fd, ::1, fe80).
80
+ * @param ip - The IP address string to check.
81
+ * @returns True if the IP is private/reserved.
82
+ */
83
+ export function isPrivateIp(ip: string): boolean {
84
+ // IPv4
85
+ if (/^127\./.test(ip)) return true;
86
+ if (/^10\./.test(ip)) return true;
87
+ if (/^172\.(1[6-9]|2\d|3[01])\./.test(ip)) return true;
88
+ if (/^192\.168\./.test(ip)) return true;
89
+ if (/^169\.254\./.test(ip)) return true;
90
+ if (ip === '0.0.0.0') return true;
91
+
92
+ // IPv6
93
+ if (ip === '::1') return true;
94
+ if (/^f[cd]/i.test(ip)) return true;
95
+ if (/^fe80/i.test(ip)) return true;
96
+
97
+ return false;
98
+ }
99
+
100
+ /**
101
+ * DNS-resolve a URL's hostname and reject it if it points to a private IP.
102
+ * @param url - The full URL to validate.
103
+ * @param allowPrivate - When true, skip the private-IP check (default false).
104
+ * @throws If the resolved IP is private and `allowPrivate` is false.
105
+ */
106
+ export async function resolveAndValidateUrl(url: string, allowPrivate = false): Promise<void> {
107
+ if (allowPrivate) return;
108
+
109
+ let hostname: string;
110
+ try {
111
+ hostname = new URL(url).hostname;
112
+ } catch {
113
+ throw new Error(`Invalid URL: ${url}`);
114
+ }
115
+
116
+ // Direct IP check first
117
+ if (isPrivateIp(hostname)) {
118
+ throw new Error(`URL resolves to a private IP address: ${hostname}`);
119
+ }
120
+
121
+ // DNS resolution
122
+ try {
123
+ const result = await lookup(hostname);
124
+ if (isPrivateIp(result.address)) {
125
+ throw new Error(`URL hostname '${hostname}' resolves to private IP: ${result.address}`);
126
+ }
127
+ } catch (err) {
128
+ // Re-throw our own errors; DNS failures are allowed (host may not resolve in test)
129
+ if (err instanceof Error && err.message.includes('private IP')) {
130
+ throw err;
131
+ }
132
+ // DNS lookup failure - let the actual HTTP request handle it
133
+ }
134
+ }
135
+
136
+ /**
137
+ * Validate that a URL is safe to fetch (not pointing to private/internal resources).
138
+ *
139
+ * Matches Python's `validate_url(url, allow_private=False) -> bool` — returns `true`
140
+ * if the URL is safe, `false` otherwise (never throws).
141
+ *
142
+ * @param url - The URL to validate.
143
+ * @param allowPrivate - When true, allow private IP ranges (default false).
144
+ * @returns `true` if the URL is safe to fetch, `false` otherwise.
145
+ */
146
+ export async function validateUrl(url: string, allowPrivate = false): Promise<boolean> {
147
+ try {
148
+ await resolveAndValidateUrl(url, allowPrivate);
149
+ return true;
150
+ } catch {
151
+ return false;
152
+ }
153
+ }