@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.
- package/.github/workflows/publish.yml +27 -0
- package/.github/workflows/test.yml +17 -0
- package/CLAUDE.md +112 -0
- package/README.md +254 -0
- package/docs/MIGRATION-2.0.md +81 -0
- package/docs/agent-guide.md +869 -0
- package/docs/agent_guide.md +1026 -0
- package/docs/api-reference.md +2420 -0
- package/docs/api_reference.md +1301 -0
- package/docs/architecture.md +843 -0
- package/docs/cli-guide.md +579 -0
- package/docs/cli_guide.md +448 -0
- package/docs/cloud_functions_guide.md +474 -0
- package/docs/configuration.md +422 -0
- package/docs/contexts-guide.md +787 -0
- package/docs/contexts_guide.md +511 -0
- package/docs/datamap-guide.md +1141 -0
- package/docs/datamap_guide.md +595 -0
- package/docs/llm_parameters.md +239 -0
- package/docs/mcp_gateway_reference.md +648 -0
- package/docs/mcp_integration.md +108 -0
- package/docs/prefabs-guide.md +800 -0
- package/docs/sdk_features.md +477 -0
- package/docs/security.md +436 -0
- package/docs/serverless-guide.md +513 -0
- package/docs/skills-guide.md +857 -0
- package/docs/skills-system.md +301 -0
- package/docs/skills_parameter_schema.md +392 -0
- package/docs/skills_system.md +467 -0
- package/docs/swaig-reference.md +1627 -0
- package/docs/swaig_reference.md +910 -0
- package/docs/swml_service_guide.md +600 -0
- package/docs/third_party_skills.md +533 -0
- package/docs/web_service.md +677 -0
- package/examples/README.md +131 -0
- package/examples/advanced-datamap.ts +100 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +94 -0
- package/examples/call-flow.ts +63 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +55 -0
- package/examples/datasphere-multi-instance.ts +63 -0
- package/examples/datasphere-serverless-env.ts +68 -0
- package/examples/datasphere-webhook-env.ts +66 -0
- package/examples/datasphere.ts +37 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +71 -0
- package/examples/gather-per-question-functions-demo.ts +140 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +69 -0
- package/examples/mcp-agent.ts +84 -0
- package/examples/mcp-gateway.ts +35 -0
- package/examples/multi-agent.ts +73 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pom-prompt.ts +71 -0
- package/examples/prefab-concierge.ts +47 -0
- package/examples/prefab-faq.ts +54 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +68 -0
- package/examples/record-call.ts +67 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +94 -0
- package/examples/serverless-lambda.ts +35 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +38 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +187 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/tap.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +72 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +140 -0
- package/livewire/docs/migration-guide.md +228 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +197 -0
- package/livewire/examples/livewire-multi-tool.ts +117 -0
- package/package.json +38 -0
- package/relay/README.md +70 -0
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
- package/relay/docs/call-methods.md +474 -0
- package/relay/docs/client-reference.md +142 -0
- package/relay/docs/events.md +134 -0
- package/relay/docs/getting-started.md +134 -0
- package/relay/docs/guide.md +306 -0
- package/relay/docs/messaging.md +182 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +71 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +95 -0
- package/rest/docs/calling.md +273 -0
- package/rest/docs/client-reference.md +107 -0
- package/rest/docs/compat.md +204 -0
- package/rest/docs/fabric.md +183 -0
- package/rest/docs/getting-started.md +110 -0
- package/rest/docs/guide.md +351 -0
- package/rest/docs/namespaces.md +285 -0
- package/rest/examples/rest-10dlc-registration.ts +161 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
- package/rest/examples/rest-calling-play-and-record.ts +91 -0
- package/rest/examples/rest-client.ts +65 -0
- package/rest/examples/rest-compat-laml.ts +210 -0
- package/rest/examples/rest-datasphere-search.ts +82 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
- package/rest/examples/rest-manage-resources.ts +65 -0
- package/rest/examples/rest-phone-number-management.ts +197 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/src/AgentBase.ts +2489 -0
- package/src/AgentServer.ts +415 -0
- package/src/AuthHandler.ts +256 -0
- package/src/ConfigLoader.ts +447 -0
- package/src/ContextBuilder.ts +1150 -0
- package/src/DataMap.ts +449 -0
- package/src/FunctionResult.ts +866 -0
- package/src/Logger.ts +337 -0
- package/src/PomBuilder.ts +439 -0
- package/src/PromptManager.ts +133 -0
- package/src/SWMLHandler.ts +298 -0
- package/src/SWMLService.ts +717 -0
- package/src/SchemaUtils.ts +361 -0
- package/src/SecurityUtils.ts +153 -0
- package/src/ServerlessAdapter.ts +221 -0
- package/src/SessionManager.ts +311 -0
- package/src/SslConfig.ts +118 -0
- package/src/SwaigFunction.ts +276 -0
- package/src/SwmlBuilder.ts +258 -0
- package/src/SwmlVerbMethods.generated.ts +234 -0
- package/src/TypeInference.ts +181 -0
- package/src/WebService.ts +619 -0
- package/src/cli/agent-loader.ts +166 -0
- package/src/cli/mock-data.ts +111 -0
- package/src/cli/swaig-test.ts +452 -0
- package/src/generateVerbTypes.ts +322 -0
- package/src/index.ts +167 -0
- package/src/livewire/index.ts +950 -0
- package/src/prefabs/ConciergeAgent.ts +287 -0
- package/src/prefabs/FAQBotAgent.ts +384 -0
- package/src/prefabs/InfoGathererAgent.ts +339 -0
- package/src/prefabs/ReceptionistAgent.ts +366 -0
- package/src/prefabs/SurveyAgent.ts +646 -0
- package/src/prefabs/index.ts +27 -0
- package/src/relay/Action.ts +314 -0
- package/src/relay/Call.ts +854 -0
- package/src/relay/Deferred.ts +71 -0
- package/src/relay/Message.ts +148 -0
- package/src/relay/RelayClient.ts +1036 -0
- package/src/relay/RelayError.ts +14 -0
- package/src/relay/RelayEvent.ts +892 -0
- package/src/relay/constants.ts +132 -0
- package/src/relay/index.ts +123 -0
- package/src/relay/types.ts +149 -0
- package/src/rest/HttpClient.ts +103 -0
- package/src/rest/RestError.ts +31 -0
- package/src/rest/base/BaseResource.ts +19 -0
- package/src/rest/base/CrudResource.ts +51 -0
- package/src/rest/base/CrudWithAddresses.ts +26 -0
- package/src/rest/index.ts +200 -0
- package/src/rest/namespaces/addresses.ts +32 -0
- package/src/rest/namespaces/calling.ts +187 -0
- package/src/rest/namespaces/chat.ts +20 -0
- package/src/rest/namespaces/compat.ts +352 -0
- package/src/rest/namespaces/datasphere.ts +45 -0
- package/src/rest/namespaces/fabric.ts +222 -0
- package/src/rest/namespaces/imported-numbers.ts +20 -0
- package/src/rest/namespaces/logs.ts +84 -0
- package/src/rest/namespaces/lookup.ts +21 -0
- package/src/rest/namespaces/mfa.ts +30 -0
- package/src/rest/namespaces/number-groups.ts +38 -0
- package/src/rest/namespaces/phone-numbers.ts +44 -0
- package/src/rest/namespaces/project.ts +36 -0
- package/src/rest/namespaces/pubsub.ts +20 -0
- package/src/rest/namespaces/queues.ts +33 -0
- package/src/rest/namespaces/recordings.ts +28 -0
- package/src/rest/namespaces/registry.ts +101 -0
- package/src/rest/namespaces/short-codes.ts +28 -0
- package/src/rest/namespaces/sip-profile.ts +25 -0
- package/src/rest/namespaces/verified-callers.ts +27 -0
- package/src/rest/namespaces/video.ts +165 -0
- package/src/rest/pagination.ts +84 -0
- package/src/rest/types.ts +61 -0
- package/src/schema.json +12250 -0
- package/src/skills/SkillBase.ts +547 -0
- package/src/skills/SkillManager.ts +415 -0
- package/src/skills/SkillRegistry.ts +367 -0
- package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
- package/src/skills/builtin/ask_claude.ts +241 -0
- package/src/skills/builtin/claude_skills.ts +978 -0
- package/src/skills/builtin/custom_skills.ts +312 -0
- package/src/skills/builtin/datasphere.ts +438 -0
- package/src/skills/builtin/datasphere_serverless.ts +339 -0
- package/src/skills/builtin/datetime.ts +130 -0
- package/src/skills/builtin/google_maps.ts +651 -0
- package/src/skills/builtin/index.ts +88 -0
- package/src/skills/builtin/info_gatherer.ts +405 -0
- package/src/skills/builtin/joke.ts +191 -0
- package/src/skills/builtin/math.ts +142 -0
- package/src/skills/builtin/mcp_gateway.ts +677 -0
- package/src/skills/builtin/native_vector_search.ts +901 -0
- package/src/skills/builtin/play_background_file.ts +358 -0
- package/src/skills/builtin/spider.ts +869 -0
- package/src/skills/builtin/swml_transfer.ts +635 -0
- package/src/skills/builtin/weather_api.ts +248 -0
- package/src/skills/builtin/web_search.ts +1074 -0
- package/src/skills/builtin/wikipedia_search.ts +299 -0
- package/src/skills/index.ts +12 -0
- package/src/types.ts +132 -0
- package/tests/AgentBase.test.ts +1093 -0
- package/tests/AgentServer.test.ts +126 -0
- package/tests/AuthHandler.test.ts +133 -0
- package/tests/ConfigLoader.test.ts +151 -0
- package/tests/ContextBuilder.test.ts +108 -0
- package/tests/DataMap.test.ts +367 -0
- package/tests/EphemeralSkillCopy.test.ts +107 -0
- package/tests/FunctionResult.test.ts +298 -0
- package/tests/GracefulShutdown.test.ts +46 -0
- package/tests/Logger.test.ts +420 -0
- package/tests/PomBuilder.test.ts +228 -0
- package/tests/ProxyDetection.test.ts +228 -0
- package/tests/SWMLService.test.ts +320 -0
- package/tests/SWMLVerbHandler.test.ts +523 -0
- package/tests/SchemaUtils.test.ts +106 -0
- package/tests/SchemaUtils.verb.test.ts +206 -0
- package/tests/SecurityUtils.test.ts +192 -0
- package/tests/ServerlessAdapter.test.ts +222 -0
- package/tests/SessionManager.test.ts +257 -0
- package/tests/SkillBaseFeatures.test.ts +130 -0
- package/tests/SkillMultiInstance.test.ts +102 -0
- package/tests/SkillParameterSchemas.test.ts +134 -0
- package/tests/SkillRegistrySchema.test.ts +84 -0
- package/tests/SslConfig.test.ts +97 -0
- package/tests/SwmlBuilder.test.ts +400 -0
- package/tests/TypeInference.test.ts +165 -0
- package/tests/VerbHandlerRegistry.test.ts +128 -0
- package/tests/cli/mock-data.test.ts +113 -0
- package/tests/cli/swaig-test.test.ts +108 -0
- package/tests/examples.test.ts +194 -0
- package/tests/fixtures/scrape-parity/README.md +53 -0
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
- package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
- package/tests/fixtures/scrape-parity/python_extract.py +109 -0
- package/tests/livewire/livewire.test.ts +780 -0
- package/tests/mcp.test.ts +221 -0
- package/tests/prefabs/prefabs.test.ts +1093 -0
- package/tests/relay/Action.test.ts +392 -0
- package/tests/relay/Call.test.ts +535 -0
- package/tests/relay/Deferred.test.ts +71 -0
- package/tests/relay/Message.test.ts +164 -0
- package/tests/relay/RelayClient.test.ts +779 -0
- package/tests/relay/RelayEvent.test.ts +463 -0
- package/tests/relay/helpers.ts +79 -0
- package/tests/rest/HttpClient.test.ts +274 -0
- package/tests/rest/RestError.test.ts +53 -0
- package/tests/rest/calling.test.ts +156 -0
- package/tests/rest/client.test.ts +197 -0
- package/tests/rest/compat.test.ts +335 -0
- package/tests/rest/datasphere.test.ts +71 -0
- package/tests/rest/fabric.test.ts +186 -0
- package/tests/rest/helpers.ts +95 -0
- package/tests/rest/logs.test.ts +68 -0
- package/tests/rest/pagination.test.ts +133 -0
- package/tests/rest/registry.test.ts +94 -0
- package/tests/rest/relay-rest.test.ts +290 -0
- package/tests/rest/video.test.ts +173 -0
- package/tests/setup.ts +6 -0
- package/tests/skills/SkillBase.test.ts +108 -0
- package/tests/skills/SkillManager.test.ts +268 -0
- package/tests/skills/SkillRegistry.test.ts +176 -0
- package/tests/skills/builtin.test.ts +1472 -0
- package/tests/skills/claude-skills.test.ts +54 -0
- package/tests/skills/custom-skills.test.ts +53 -0
- package/tests/skills/datasphere-serverless.test.ts +70 -0
- package/tests/skills/datasphere.test.ts +107 -0
- package/tests/skills/datetime.test.ts +101 -0
- package/tests/skills/google-maps.test.ts +78 -0
- package/tests/skills/info-gatherer.test.ts +411 -0
- package/tests/skills/joke.test.ts +81 -0
- package/tests/skills/math.test.ts +68 -0
- package/tests/skills/mcp-gateway.test.ts +101 -0
- package/tests/skills/play-background.test.ts +54 -0
- package/tests/skills/spider.test.ts +108 -0
- package/tests/skills/swml-transfer.test.ts +178 -0
- package/tests/skills/trivia.test.ts +54 -0
- package/tests/skills/vector-search.test.ts +135 -0
- package/tests/skills/weather-api.test.ts +77 -0
- package/tests/skills/web-search-parity.test.ts +59 -0
- package/tests/skills/web-search.test.ts +103 -0
- package/tests/skills/wikipedia.test.ts +63 -0
- package/tsconfig.json +18 -0
- package/vitest.config.ts +9 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
|
2
|
+
import { AgentBase } from '../src/AgentBase.js';
|
|
3
|
+
|
|
4
|
+
describe('ProxyDetection', () => {
|
|
5
|
+
let agent: AgentBase;
|
|
6
|
+
|
|
7
|
+
beforeEach(() => {
|
|
8
|
+
// Clear env vars that could interfere
|
|
9
|
+
delete process.env['SWML_PROXY_URL_BASE'];
|
|
10
|
+
delete process.env['SWML_PROXY_DEBUG'];
|
|
11
|
+
// Enable proxy header trust for tests that rely on header-based detection
|
|
12
|
+
process.env['SWML_TRUST_PROXY_HEADERS'] = 'true';
|
|
13
|
+
agent = new AgentBase({ name: 'proxy-test', route: '/', basicAuth: ['user', 'pass'] });
|
|
14
|
+
agent.setPromptText('test prompt');
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it('getFullUrl returns localhost by default', () => {
|
|
18
|
+
const url = agent.getFullUrl();
|
|
19
|
+
expect(url).toContain('localhost');
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it('manualSetProxyUrl overrides getFullUrl', () => {
|
|
23
|
+
agent.manualSetProxyUrl('https://tunnel.example.com');
|
|
24
|
+
const url = agent.getFullUrl();
|
|
25
|
+
expect(url).toBe('https://tunnel.example.com');
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('manualSetProxyUrl strips trailing slashes', () => {
|
|
29
|
+
agent.manualSetProxyUrl('https://tunnel.example.com///');
|
|
30
|
+
const url = agent.getFullUrl();
|
|
31
|
+
expect(url).toBe('https://tunnel.example.com');
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('manualSetProxyUrl with auth', () => {
|
|
35
|
+
agent.manualSetProxyUrl('https://tunnel.example.com');
|
|
36
|
+
const url = agent.getFullUrl(true);
|
|
37
|
+
expect(url).toBe('https://user:pass@tunnel.example.com');
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
it('detects proxy from X-Forwarded-Host in SWML request', async () => {
|
|
41
|
+
const app = agent.getApp();
|
|
42
|
+
const res = await app.request('http://localhost/', {
|
|
43
|
+
method: 'POST',
|
|
44
|
+
headers: {
|
|
45
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
46
|
+
'Content-Type': 'application/json',
|
|
47
|
+
'X-Forwarded-Host': 'ngrok.example.com',
|
|
48
|
+
'X-Forwarded-Proto': 'https',
|
|
49
|
+
},
|
|
50
|
+
body: JSON.stringify({}),
|
|
51
|
+
});
|
|
52
|
+
expect(res.status).toBe(200);
|
|
53
|
+
// After request, the agent should have detected the proxy
|
|
54
|
+
expect(agent.getFullUrl()).toBe('https://ngrok.example.com');
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('detects proxy from X-Forwarded-Host defaults to https', async () => {
|
|
58
|
+
const app = agent.getApp();
|
|
59
|
+
await app.request('http://localhost/', {
|
|
60
|
+
method: 'POST',
|
|
61
|
+
headers: {
|
|
62
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
63
|
+
'Content-Type': 'application/json',
|
|
64
|
+
'X-Forwarded-Host': 'tunnel.io',
|
|
65
|
+
},
|
|
66
|
+
body: JSON.stringify({}),
|
|
67
|
+
});
|
|
68
|
+
expect(agent.getFullUrl()).toBe('https://tunnel.io');
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('detects proxy from Forwarded header (RFC 7239)', async () => {
|
|
72
|
+
const app = agent.getApp();
|
|
73
|
+
await app.request('http://localhost/', {
|
|
74
|
+
method: 'POST',
|
|
75
|
+
headers: {
|
|
76
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
77
|
+
'Content-Type': 'application/json',
|
|
78
|
+
'Forwarded': 'host=proxy.example.com;proto=https',
|
|
79
|
+
},
|
|
80
|
+
body: JSON.stringify({}),
|
|
81
|
+
});
|
|
82
|
+
expect(agent.getFullUrl()).toBe('https://proxy.example.com');
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('detects proxy from Forwarded header with default proto', async () => {
|
|
86
|
+
const app = agent.getApp();
|
|
87
|
+
await app.request('http://localhost/', {
|
|
88
|
+
method: 'POST',
|
|
89
|
+
headers: {
|
|
90
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
91
|
+
'Content-Type': 'application/json',
|
|
92
|
+
'Forwarded': 'host=proxy.example.com',
|
|
93
|
+
},
|
|
94
|
+
body: JSON.stringify({}),
|
|
95
|
+
});
|
|
96
|
+
expect(agent.getFullUrl()).toBe('https://proxy.example.com');
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
it('detects proxy from X-Original-Host', async () => {
|
|
100
|
+
const app = agent.getApp();
|
|
101
|
+
await app.request('http://localhost/', {
|
|
102
|
+
method: 'POST',
|
|
103
|
+
headers: {
|
|
104
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
105
|
+
'Content-Type': 'application/json',
|
|
106
|
+
'X-Original-Host': 'original.example.com',
|
|
107
|
+
},
|
|
108
|
+
body: JSON.stringify({}),
|
|
109
|
+
});
|
|
110
|
+
expect(agent.getFullUrl()).toBe('https://original.example.com');
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
it('X-Forwarded-Host takes priority over Forwarded header', async () => {
|
|
114
|
+
const app = agent.getApp();
|
|
115
|
+
await app.request('http://localhost/', {
|
|
116
|
+
method: 'POST',
|
|
117
|
+
headers: {
|
|
118
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
119
|
+
'Content-Type': 'application/json',
|
|
120
|
+
'X-Forwarded-Host': 'xfh.example.com',
|
|
121
|
+
'X-Forwarded-Proto': 'https',
|
|
122
|
+
'Forwarded': 'host=fwd.example.com;proto=https',
|
|
123
|
+
},
|
|
124
|
+
body: JSON.stringify({}),
|
|
125
|
+
});
|
|
126
|
+
expect(agent.getFullUrl()).toBe('https://xfh.example.com');
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it('env var SWML_PROXY_URL_BASE takes priority and is never overridden', async () => {
|
|
130
|
+
process.env['SWML_PROXY_URL_BASE'] = 'https://env-proxy.example.com';
|
|
131
|
+
process.env['SWML_TRUST_PROXY_HEADERS'] = 'true';
|
|
132
|
+
const envAgent = new AgentBase({ name: 'env-test', route: '/', basicAuth: ['user', 'pass'] });
|
|
133
|
+
envAgent.setPromptText('test');
|
|
134
|
+
const app = envAgent.getApp();
|
|
135
|
+
await app.request('http://localhost/', {
|
|
136
|
+
method: 'POST',
|
|
137
|
+
headers: {
|
|
138
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
139
|
+
'Content-Type': 'application/json',
|
|
140
|
+
'X-Forwarded-Host': 'ngrok.example.com',
|
|
141
|
+
'X-Forwarded-Proto': 'https',
|
|
142
|
+
},
|
|
143
|
+
body: JSON.stringify({}),
|
|
144
|
+
});
|
|
145
|
+
// Should still use env var, not detected proxy
|
|
146
|
+
expect(envAgent.getFullUrl()).toBe('https://env-proxy.example.com');
|
|
147
|
+
delete process.env['SWML_PROXY_URL_BASE'];
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
it('proxy URL is used in rendered SWML webhook URLs', async () => {
|
|
151
|
+
agent.defineTool({
|
|
152
|
+
name: 'test_fn',
|
|
153
|
+
description: 'Test',
|
|
154
|
+
parameters: {},
|
|
155
|
+
handler: () => ({ response: 'ok' }),
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
const app = agent.getApp();
|
|
159
|
+
const res = await app.request('http://localhost/', {
|
|
160
|
+
method: 'POST',
|
|
161
|
+
headers: {
|
|
162
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
163
|
+
'Content-Type': 'application/json',
|
|
164
|
+
'X-Forwarded-Host': 'webhook.example.com',
|
|
165
|
+
'X-Forwarded-Proto': 'https',
|
|
166
|
+
},
|
|
167
|
+
body: JSON.stringify({}),
|
|
168
|
+
});
|
|
169
|
+
const swml = await res.json();
|
|
170
|
+
const webhookUrl = swml.sections.main[1].ai.SWAIG.defaults.web_hook_url;
|
|
171
|
+
expect(webhookUrl).toContain('webhook.example.com');
|
|
172
|
+
expect(webhookUrl).toContain('https://');
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
it('no proxy headers leaves getFullUrl unchanged', async () => {
|
|
176
|
+
const beforeUrl = agent.getFullUrl();
|
|
177
|
+
const app = agent.getApp();
|
|
178
|
+
await app.request('http://localhost/', {
|
|
179
|
+
method: 'POST',
|
|
180
|
+
headers: {
|
|
181
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
182
|
+
'Content-Type': 'application/json',
|
|
183
|
+
},
|
|
184
|
+
body: JSON.stringify({}),
|
|
185
|
+
});
|
|
186
|
+
expect(agent.getFullUrl()).toBe(beforeUrl);
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
it('proxy detection disabled by default when SWML_TRUST_PROXY_HEADERS is not set', async () => {
|
|
190
|
+
delete process.env['SWML_TRUST_PROXY_HEADERS'];
|
|
191
|
+
const noTrustAgent = new AgentBase({ name: 'no-trust', route: '/', basicAuth: ['user', 'pass'] });
|
|
192
|
+
noTrustAgent.setPromptText('test');
|
|
193
|
+
const beforeUrl = noTrustAgent.getFullUrl();
|
|
194
|
+
const app = noTrustAgent.getApp();
|
|
195
|
+
await app.request('http://localhost/', {
|
|
196
|
+
method: 'POST',
|
|
197
|
+
headers: {
|
|
198
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
199
|
+
'Content-Type': 'application/json',
|
|
200
|
+
'X-Forwarded-Host': 'should-be-ignored.com',
|
|
201
|
+
'X-Forwarded-Proto': 'https',
|
|
202
|
+
},
|
|
203
|
+
body: JSON.stringify({}),
|
|
204
|
+
});
|
|
205
|
+
expect(noTrustAgent.getFullUrl()).toBe(beforeUrl);
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
it('invalid hostname in Forwarded header is rejected', async () => {
|
|
209
|
+
const app = agent.getApp();
|
|
210
|
+
const beforeUrl = agent.getFullUrl();
|
|
211
|
+
// Use a hostname with a slash which will fail isValidHostname
|
|
212
|
+
await app.request('http://localhost/', {
|
|
213
|
+
method: 'POST',
|
|
214
|
+
headers: {
|
|
215
|
+
'Authorization': 'Basic ' + btoa('user:pass'),
|
|
216
|
+
'Content-Type': 'application/json',
|
|
217
|
+
'Forwarded': 'host=evil/path;proto=https',
|
|
218
|
+
},
|
|
219
|
+
body: JSON.stringify({}),
|
|
220
|
+
});
|
|
221
|
+
// Should not have set proxy because hostname contains a slash
|
|
222
|
+
expect(agent.getFullUrl()).toBe(beforeUrl);
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
afterEach(() => {
|
|
226
|
+
delete process.env['SWML_TRUST_PROXY_HEADERS'];
|
|
227
|
+
});
|
|
228
|
+
});
|
|
@@ -0,0 +1,320 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tests for SWMLService — non-AI SWML service.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { SWMLService } from '../src/SWMLService.js';
|
|
6
|
+
import { SwmlBuilder } from '../src/SwmlBuilder.js';
|
|
7
|
+
|
|
8
|
+
describe('SWMLService', () => {
|
|
9
|
+
describe('constructor', () => {
|
|
10
|
+
it('uses default name and route', () => {
|
|
11
|
+
const svc = new SWMLService();
|
|
12
|
+
expect(svc.name).toBe('swml-service');
|
|
13
|
+
expect(svc.route).toBe('/');
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it('accepts custom name, route, and basicAuth', () => {
|
|
17
|
+
const svc = new SWMLService({
|
|
18
|
+
name: 'ivr',
|
|
19
|
+
route: '/ivr',
|
|
20
|
+
basicAuth: ['admin', 'secret'],
|
|
21
|
+
});
|
|
22
|
+
expect(svc.name).toBe('ivr');
|
|
23
|
+
expect(svc.route).toBe('/ivr');
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
describe('addVerb', () => {
|
|
28
|
+
it('adds verbs to the SWML document', () => {
|
|
29
|
+
const svc = new SWMLService();
|
|
30
|
+
svc.addVerb('answer', { max_duration: 300 });
|
|
31
|
+
svc.addVerb('play', { url: 'say:Hello' });
|
|
32
|
+
svc.addVerb('hangup', {});
|
|
33
|
+
|
|
34
|
+
const doc = svc.renderSwml();
|
|
35
|
+
expect(doc).toHaveProperty('version', '1.0.0');
|
|
36
|
+
const main = (doc['sections'] as Record<string, unknown>)['main'] as unknown[];
|
|
37
|
+
expect(main).toHaveLength(3);
|
|
38
|
+
expect(main[0]).toEqual({ answer: { max_duration: 300 } });
|
|
39
|
+
expect(main[1]).toEqual({ play: { url: 'say:Hello' } });
|
|
40
|
+
expect(main[2]).toEqual({ hangup: {} });
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it('returns this for chaining', () => {
|
|
44
|
+
const svc = new SWMLService();
|
|
45
|
+
const result = svc.addVerb('answer', {}).addVerb('hangup', {});
|
|
46
|
+
expect(result).toBe(svc);
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
describe('renderSwml', () => {
|
|
51
|
+
it('returns valid SWML with no AI block', () => {
|
|
52
|
+
const svc = new SWMLService();
|
|
53
|
+
svc.addVerb('answer', {});
|
|
54
|
+
const doc = svc.renderSwml();
|
|
55
|
+
expect(doc).toHaveProperty('version', '1.0.0');
|
|
56
|
+
expect(doc).toHaveProperty('sections');
|
|
57
|
+
// No AI block
|
|
58
|
+
const main = (doc['sections'] as Record<string, unknown>)['main'] as unknown[];
|
|
59
|
+
for (const verb of main) {
|
|
60
|
+
expect(verb).not.toHaveProperty('ai');
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
it('returns empty main section when no verbs added', () => {
|
|
65
|
+
const svc = new SWMLService();
|
|
66
|
+
const doc = svc.renderSwml();
|
|
67
|
+
const main = (doc['sections'] as Record<string, unknown>)['main'] as unknown[];
|
|
68
|
+
expect(main).toEqual([]);
|
|
69
|
+
});
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
describe('getBuilder', () => {
|
|
73
|
+
it('returns the SwmlBuilder instance', () => {
|
|
74
|
+
const svc = new SWMLService();
|
|
75
|
+
const builder = svc.getBuilder();
|
|
76
|
+
expect(builder).toBeInstanceOf(SwmlBuilder);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
it('builder matches renderSwml output', () => {
|
|
80
|
+
const svc = new SWMLService();
|
|
81
|
+
svc.addVerb('answer', {});
|
|
82
|
+
expect(svc.getBuilder().getDocument()).toEqual(svc.renderSwml());
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
describe('setOnRequestCallback', () => {
|
|
87
|
+
it('returns this for chaining', () => {
|
|
88
|
+
const svc = new SWMLService();
|
|
89
|
+
const result = svc.setOnRequestCallback(() => new SwmlBuilder());
|
|
90
|
+
expect(result).toBe(svc);
|
|
91
|
+
});
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
describe('getApp', () => {
|
|
95
|
+
it('returns a Hono app', () => {
|
|
96
|
+
const svc = new SWMLService();
|
|
97
|
+
const app = svc.getApp();
|
|
98
|
+
expect(app).toBeDefined();
|
|
99
|
+
expect(typeof app.fetch).toBe('function');
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
it('GET / returns SWML JSON', async () => {
|
|
103
|
+
const svc = new SWMLService();
|
|
104
|
+
svc.addVerb('answer', {});
|
|
105
|
+
svc.addVerb('hangup', {});
|
|
106
|
+
|
|
107
|
+
const app = svc.getApp();
|
|
108
|
+
const res = await app.request('/', { method: 'GET' });
|
|
109
|
+
expect(res.status).toBe(200);
|
|
110
|
+
const json = await res.json();
|
|
111
|
+
expect(json).toHaveProperty('version', '1.0.0');
|
|
112
|
+
const main = json['sections']['main'];
|
|
113
|
+
expect(main).toHaveLength(2);
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it('POST / returns SWML JSON', async () => {
|
|
117
|
+
const svc = new SWMLService();
|
|
118
|
+
svc.addVerb('play', { url: 'say:Hi' });
|
|
119
|
+
|
|
120
|
+
const app = svc.getApp();
|
|
121
|
+
const res = await app.request('/', {
|
|
122
|
+
method: 'POST',
|
|
123
|
+
headers: { 'Content-Type': 'application/json' },
|
|
124
|
+
body: JSON.stringify({}),
|
|
125
|
+
});
|
|
126
|
+
expect(res.status).toBe(200);
|
|
127
|
+
const json = await res.json();
|
|
128
|
+
expect(json['sections']['main']).toHaveLength(1);
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
it('GET /health returns ok', async () => {
|
|
132
|
+
const svc = new SWMLService();
|
|
133
|
+
const app = svc.getApp();
|
|
134
|
+
const res = await app.request('/health', { method: 'GET' });
|
|
135
|
+
expect(res.status).toBe(200);
|
|
136
|
+
expect(await res.json()).toEqual({ status: 'ok' });
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
it('GET /ready returns ready', async () => {
|
|
140
|
+
const svc = new SWMLService();
|
|
141
|
+
const app = svc.getApp();
|
|
142
|
+
const res = await app.request('/ready', { method: 'GET' });
|
|
143
|
+
expect(res.status).toBe(200);
|
|
144
|
+
expect(await res.json()).toEqual({ status: 'ready' });
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it('enforces basic auth when configured', async () => {
|
|
148
|
+
const svc = new SWMLService({
|
|
149
|
+
basicAuth: ['admin', 'secret'],
|
|
150
|
+
});
|
|
151
|
+
svc.addVerb('answer', {});
|
|
152
|
+
|
|
153
|
+
const app = svc.getApp();
|
|
154
|
+
|
|
155
|
+
// Unauthorized
|
|
156
|
+
const res1 = await app.request('/', { method: 'GET' });
|
|
157
|
+
expect(res1.status).toBe(401);
|
|
158
|
+
|
|
159
|
+
// Authorized
|
|
160
|
+
const creds = Buffer.from('admin:secret').toString('base64');
|
|
161
|
+
const res2 = await app.request('/', {
|
|
162
|
+
method: 'GET',
|
|
163
|
+
headers: { Authorization: `Basic ${creds}` },
|
|
164
|
+
});
|
|
165
|
+
expect(res2.status).toBe(200);
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it('sets security headers', async () => {
|
|
169
|
+
const svc = new SWMLService();
|
|
170
|
+
svc.addVerb('answer', {});
|
|
171
|
+
const app = svc.getApp();
|
|
172
|
+
const res = await app.request('/', { method: 'GET' });
|
|
173
|
+
expect(res.headers.get('X-Content-Type-Options')).toBe('nosniff');
|
|
174
|
+
expect(res.headers.get('X-Frame-Options')).toBe('DENY');
|
|
175
|
+
});
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
describe('onRequest callback', () => {
|
|
179
|
+
it('uses callback builder instead of static builder', async () => {
|
|
180
|
+
const svc = new SWMLService();
|
|
181
|
+
// Static verbs — should be ignored when callback is set
|
|
182
|
+
svc.addVerb('answer', {});
|
|
183
|
+
|
|
184
|
+
svc.setOnRequestCallback((_query, _body, _headers) => {
|
|
185
|
+
const b = new SwmlBuilder();
|
|
186
|
+
b.addVerb('play', { url: 'say:Dynamic!' });
|
|
187
|
+
b.addVerb('hangup', {});
|
|
188
|
+
return b;
|
|
189
|
+
});
|
|
190
|
+
|
|
191
|
+
const app = svc.getApp();
|
|
192
|
+
const res = await app.request('/', { method: 'GET' });
|
|
193
|
+
const json = await res.json();
|
|
194
|
+
const main = json['sections']['main'];
|
|
195
|
+
expect(main).toHaveLength(2);
|
|
196
|
+
expect(main[0]).toEqual({ play: { url: 'say:Dynamic!' } });
|
|
197
|
+
expect(main[1]).toEqual({ hangup: {} });
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
it('receives query params from URL', async () => {
|
|
201
|
+
let receivedQuery: Record<string, string> = {};
|
|
202
|
+
const svc = new SWMLService();
|
|
203
|
+
svc.setOnRequestCallback((query) => {
|
|
204
|
+
receivedQuery = query;
|
|
205
|
+
return new SwmlBuilder();
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
const app = svc.getApp();
|
|
209
|
+
await app.request('/?action=voicemail&lang=en', { method: 'GET' });
|
|
210
|
+
expect(receivedQuery['action']).toBe('voicemail');
|
|
211
|
+
expect(receivedQuery['lang']).toBe('en');
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
it('receives body params from POST', async () => {
|
|
215
|
+
let receivedBody: Record<string, unknown> = {};
|
|
216
|
+
const svc = new SWMLService();
|
|
217
|
+
svc.setOnRequestCallback((_query, body) => {
|
|
218
|
+
receivedBody = body;
|
|
219
|
+
return new SwmlBuilder();
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
const app = svc.getApp();
|
|
223
|
+
await app.request('/', {
|
|
224
|
+
method: 'POST',
|
|
225
|
+
headers: { 'Content-Type': 'application/json' },
|
|
226
|
+
body: JSON.stringify({ foo: 'bar' }),
|
|
227
|
+
});
|
|
228
|
+
expect(receivedBody['foo']).toBe('bar');
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
it('supports async callbacks', async () => {
|
|
232
|
+
const svc = new SWMLService();
|
|
233
|
+
svc.setOnRequestCallback(async () => {
|
|
234
|
+
await new Promise((r) => setTimeout(r, 10));
|
|
235
|
+
const b = new SwmlBuilder();
|
|
236
|
+
b.addVerb('answer', {});
|
|
237
|
+
return b;
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
const app = svc.getApp();
|
|
241
|
+
const res = await app.request('/', { method: 'GET' });
|
|
242
|
+
const json = await res.json();
|
|
243
|
+
expect(json['sections']['main']).toHaveLength(1);
|
|
244
|
+
});
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
describe('run', () => {
|
|
248
|
+
it('skips server startup in SWAIG_CLI_MODE', async () => {
|
|
249
|
+
process.env['SWAIG_CLI_MODE'] = 'true';
|
|
250
|
+
const svc = new SWMLService();
|
|
251
|
+
// Should not throw or hang
|
|
252
|
+
await svc.run();
|
|
253
|
+
delete process.env['SWAIG_CLI_MODE'];
|
|
254
|
+
});
|
|
255
|
+
});
|
|
256
|
+
|
|
257
|
+
// ── Security remediation round 2 ────────────────────────────────
|
|
258
|
+
|
|
259
|
+
describe('CORS credentials with wildcard origin', () => {
|
|
260
|
+
it('does not set credentials: true with wildcard origin', async () => {
|
|
261
|
+
const saved = process.env['SWML_CORS_ORIGINS'];
|
|
262
|
+
delete process.env['SWML_CORS_ORIGINS'];
|
|
263
|
+
try {
|
|
264
|
+
const svc = new SWMLService();
|
|
265
|
+
svc.addVerb('answer', {});
|
|
266
|
+
const app = svc.getApp();
|
|
267
|
+
const res = await app.request('/', {
|
|
268
|
+
method: 'OPTIONS',
|
|
269
|
+
headers: {
|
|
270
|
+
'Origin': 'https://example.com',
|
|
271
|
+
'Access-Control-Request-Method': 'GET',
|
|
272
|
+
},
|
|
273
|
+
});
|
|
274
|
+
// With wildcard, Access-Control-Allow-Credentials should NOT be 'true'
|
|
275
|
+
expect(res.headers.get('Access-Control-Allow-Credentials')).not.toBe('true');
|
|
276
|
+
} finally {
|
|
277
|
+
if (saved) process.env['SWML_CORS_ORIGINS'] = saved;
|
|
278
|
+
}
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
it('sets credentials: true when SWML_CORS_ORIGINS is configured', async () => {
|
|
282
|
+
const saved = process.env['SWML_CORS_ORIGINS'];
|
|
283
|
+
process.env['SWML_CORS_ORIGINS'] = 'https://example.com';
|
|
284
|
+
try {
|
|
285
|
+
const svc = new SWMLService();
|
|
286
|
+
svc.addVerb('answer', {});
|
|
287
|
+
const app = svc.getApp();
|
|
288
|
+
const res = await app.request('/', {
|
|
289
|
+
method: 'OPTIONS',
|
|
290
|
+
headers: {
|
|
291
|
+
'Origin': 'https://example.com',
|
|
292
|
+
'Access-Control-Request-Method': 'GET',
|
|
293
|
+
},
|
|
294
|
+
});
|
|
295
|
+
expect(res.headers.get('Access-Control-Allow-Credentials')).toBe('true');
|
|
296
|
+
} finally {
|
|
297
|
+
if (saved) process.env['SWML_CORS_ORIGINS'] = saved;
|
|
298
|
+
else delete process.env['SWML_CORS_ORIGINS'];
|
|
299
|
+
}
|
|
300
|
+
});
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
describe('CSP and Permissions-Policy headers', () => {
|
|
304
|
+
it('includes Content-Security-Policy header', async () => {
|
|
305
|
+
const svc = new SWMLService();
|
|
306
|
+
svc.addVerb('answer', {});
|
|
307
|
+
const app = svc.getApp();
|
|
308
|
+
const res = await app.request('/', { method: 'GET' });
|
|
309
|
+
expect(res.headers.get('Content-Security-Policy')).toContain("default-src 'none'");
|
|
310
|
+
});
|
|
311
|
+
|
|
312
|
+
it('includes Permissions-Policy header', async () => {
|
|
313
|
+
const svc = new SWMLService();
|
|
314
|
+
svc.addVerb('answer', {});
|
|
315
|
+
const app = svc.getApp();
|
|
316
|
+
const res = await app.request('/', { method: 'GET' });
|
|
317
|
+
expect(res.headers.get('Permissions-Policy')).toContain('camera=()');
|
|
318
|
+
});
|
|
319
|
+
});
|
|
320
|
+
});
|