@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,367 @@
|
|
|
1
|
+
import { describe, it, expect, afterEach } from 'vitest';
|
|
2
|
+
import { DataMap, createSimpleApiTool, createExpressionTool, setAllowedEnvPrefixes } from '../src/DataMap.js';
|
|
3
|
+
import { FunctionResult } from '../src/FunctionResult.js';
|
|
4
|
+
|
|
5
|
+
describe('DataMap', () => {
|
|
6
|
+
it('basic builder produces valid swaig function', () => {
|
|
7
|
+
const dm = new DataMap('get_weather')
|
|
8
|
+
.purpose('Get weather')
|
|
9
|
+
.parameter('location', 'string', 'City name', { required: true })
|
|
10
|
+
.webhook('GET', 'https://api.weather.com?q=${location}')
|
|
11
|
+
.output(new FunctionResult('Weather: ${response.temp}'));
|
|
12
|
+
|
|
13
|
+
const fn = dm.toSwaigFunction();
|
|
14
|
+
expect(fn['function']).toBe('get_weather');
|
|
15
|
+
expect(fn['description']).toBe('Get weather');
|
|
16
|
+
expect((fn['parameters'] as Record<string, unknown>)['required']).toEqual(['location']);
|
|
17
|
+
const dataMap = fn['data_map'] as Record<string, unknown>;
|
|
18
|
+
expect(dataMap['webhooks']).toBeDefined();
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('description is alias for purpose', () => {
|
|
22
|
+
const dm = new DataMap('fn').description('desc');
|
|
23
|
+
expect(dm.toSwaigFunction()['description']).toBe('desc');
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('default description when purpose not set', () => {
|
|
27
|
+
const dm = new DataMap('my_fn');
|
|
28
|
+
dm.webhook('GET', 'https://example.com').output(new FunctionResult('ok'));
|
|
29
|
+
expect(dm.toSwaigFunction()['description']).toBe('Execute my_fn');
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it('parameter with enum', () => {
|
|
33
|
+
const dm = new DataMap('fn')
|
|
34
|
+
.parameter('color', 'string', 'A color', { enum: ['red', 'blue'] });
|
|
35
|
+
const params = dm.toSwaigFunction()['parameters'] as Record<string, unknown>;
|
|
36
|
+
const props = params['properties'] as Record<string, Record<string, unknown>>;
|
|
37
|
+
expect(props['color']['enum']).toEqual(['red', 'blue']);
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
it('expression-based tool', () => {
|
|
41
|
+
const dm = new DataMap('ctrl')
|
|
42
|
+
.purpose('Control playback')
|
|
43
|
+
.parameter('cmd', 'string', 'Command')
|
|
44
|
+
.expression('${args.cmd}', /start.*/, new FunctionResult('Starting'))
|
|
45
|
+
.expression('${args.cmd}', 'stop', new FunctionResult('Stopping'));
|
|
46
|
+
|
|
47
|
+
const fn = dm.toSwaigFunction();
|
|
48
|
+
const dataMap = fn['data_map'] as Record<string, unknown>;
|
|
49
|
+
const exprs = dataMap['expressions'] as Record<string, unknown>[];
|
|
50
|
+
expect(exprs.length).toBe(2);
|
|
51
|
+
expect(exprs[0]['pattern']).toBe('start.*');
|
|
52
|
+
expect(exprs[1]['pattern']).toBe('stop');
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it('expression with nomatch output', () => {
|
|
56
|
+
const dm = new DataMap('fn')
|
|
57
|
+
.expression(
|
|
58
|
+
'${args.x}',
|
|
59
|
+
'yes',
|
|
60
|
+
new FunctionResult('matched'),
|
|
61
|
+
new FunctionResult('no match'),
|
|
62
|
+
);
|
|
63
|
+
const fn = dm.toSwaigFunction();
|
|
64
|
+
const exprs = (fn['data_map'] as Record<string, unknown>)['expressions'] as Record<string, unknown>[];
|
|
65
|
+
expect(exprs[0]['nomatch-output']).toEqual({ response: 'no match' });
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it('webhook with body and headers', () => {
|
|
69
|
+
const dm = new DataMap('search')
|
|
70
|
+
.purpose('Search docs')
|
|
71
|
+
.webhook('POST', 'https://api.docs.com/search', {
|
|
72
|
+
headers: { Authorization: 'Bearer TOKEN' },
|
|
73
|
+
})
|
|
74
|
+
.body({ query: '${query}', limit: 3 })
|
|
75
|
+
.output(new FunctionResult('Found: ${response.title}'));
|
|
76
|
+
|
|
77
|
+
const fn = dm.toSwaigFunction();
|
|
78
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
79
|
+
expect(webhooks[0]['method']).toBe('POST');
|
|
80
|
+
expect(webhooks[0]['headers']).toEqual({ Authorization: 'Bearer TOKEN' });
|
|
81
|
+
expect(webhooks[0]['body']).toEqual({ query: '${query}', limit: 3 });
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
it('webhook with params', () => {
|
|
85
|
+
const dm = new DataMap('fn')
|
|
86
|
+
.webhook('GET', 'https://example.com')
|
|
87
|
+
.params({ key: 'val' })
|
|
88
|
+
.output(new FunctionResult('ok'));
|
|
89
|
+
const webhooks = (dm.toSwaigFunction()['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
90
|
+
expect(webhooks[0]['params']).toEqual({ key: 'val' });
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it('foreach', () => {
|
|
94
|
+
const dm = new DataMap('fn')
|
|
95
|
+
.webhook('GET', 'https://example.com')
|
|
96
|
+
.foreach({ input_key: 'results', output_key: 'out', append: '${this.title}\n' })
|
|
97
|
+
.output(new FunctionResult('${out}'));
|
|
98
|
+
const webhooks = (dm.toSwaigFunction()['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
99
|
+
expect(webhooks[0]['foreach']).toBeDefined();
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
it('multiple webhooks with fallback', () => {
|
|
103
|
+
const dm = new DataMap('multi')
|
|
104
|
+
.purpose('Search')
|
|
105
|
+
.webhook('GET', 'https://primary.com')
|
|
106
|
+
.output(new FunctionResult('Primary: ${response.title}'))
|
|
107
|
+
.webhook('GET', 'https://fallback.com')
|
|
108
|
+
.output(new FunctionResult('Fallback: ${response.title}'))
|
|
109
|
+
.fallbackOutput(new FunctionResult('All APIs failed'));
|
|
110
|
+
|
|
111
|
+
const fn = dm.toSwaigFunction();
|
|
112
|
+
const dataMap = fn['data_map'] as Record<string, unknown>;
|
|
113
|
+
expect((dataMap['webhooks'] as unknown[]).length).toBe(2);
|
|
114
|
+
expect(dataMap['output']).toEqual({ response: 'All APIs failed' });
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
it('error keys on webhook', () => {
|
|
118
|
+
const dm = new DataMap('fn')
|
|
119
|
+
.webhook('GET', 'https://example.com')
|
|
120
|
+
.errorKeys(['error', 'message'])
|
|
121
|
+
.output(new FunctionResult('ok'));
|
|
122
|
+
const webhooks = (dm.toSwaigFunction()['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
123
|
+
expect(webhooks[0]['error_keys']).toEqual(['error', 'message']);
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
it('global error keys', () => {
|
|
127
|
+
const dm = new DataMap('fn').globalErrorKeys(['err']);
|
|
128
|
+
dm.webhook('GET', 'https://example.com').output(new FunctionResult('ok'));
|
|
129
|
+
const dataMap = dm.toSwaigFunction()['data_map'] as Record<string, unknown>;
|
|
130
|
+
expect(dataMap['error_keys']).toEqual(['err']);
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
it('throws if body/output/params/foreach called without webhook', () => {
|
|
134
|
+
const dm = new DataMap('fn');
|
|
135
|
+
expect(() => dm.body({})).toThrow('Must add webhook');
|
|
136
|
+
expect(() => dm.output(new FunctionResult('x'))).toThrow('Must add webhook');
|
|
137
|
+
expect(() => dm.params({})).toThrow('Must add webhook');
|
|
138
|
+
expect(() => dm.foreach({ input_key: 'a', output_key: 'b', append: 'c' })).toThrow('Must add webhook');
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
it('webhookExpressions', () => {
|
|
142
|
+
const dm = new DataMap('fn')
|
|
143
|
+
.webhook('GET', 'https://example.com')
|
|
144
|
+
.webhookExpressions([{ string: '${response.status}', pattern: 'ok', output: { response: 'good' } }])
|
|
145
|
+
.output(new FunctionResult('ok'));
|
|
146
|
+
const webhooks = (dm.toSwaigFunction()['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
147
|
+
expect(webhooks[0]['expressions']).toBeDefined();
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
it('webhook with advanced options', () => {
|
|
151
|
+
const dm = new DataMap('fn')
|
|
152
|
+
.webhook('POST', 'https://example.com', {
|
|
153
|
+
formParam: 'data',
|
|
154
|
+
inputArgsAsParams: true,
|
|
155
|
+
requireArgs: ['query'],
|
|
156
|
+
})
|
|
157
|
+
.output(new FunctionResult('ok'));
|
|
158
|
+
const webhooks = (dm.toSwaigFunction()['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
159
|
+
expect(webhooks[0]['form_param']).toBe('data');
|
|
160
|
+
expect(webhooks[0]['input_args_as_params']).toBe(true);
|
|
161
|
+
expect(webhooks[0]['require_args']).toEqual(['query']);
|
|
162
|
+
});
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
describe('createSimpleApiTool', () => {
|
|
166
|
+
it('creates a simple API tool', () => {
|
|
167
|
+
const dm = createSimpleApiTool({
|
|
168
|
+
name: 'weather',
|
|
169
|
+
url: 'https://api.weather.com?q=${location}',
|
|
170
|
+
responseTemplate: 'Temp: ${response.temp}',
|
|
171
|
+
parameters: { location: { type: 'string', description: 'City', required: true } },
|
|
172
|
+
});
|
|
173
|
+
const fn = dm.toSwaigFunction();
|
|
174
|
+
expect(fn['function']).toBe('weather');
|
|
175
|
+
const params = fn['parameters'] as Record<string, unknown>;
|
|
176
|
+
expect(params['required']).toEqual(['location']);
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
describe('createExpressionTool', () => {
|
|
181
|
+
it('creates expression-based tool', () => {
|
|
182
|
+
const dm = createExpressionTool({
|
|
183
|
+
name: 'ctrl',
|
|
184
|
+
patterns: {
|
|
185
|
+
'${args.cmd}': ['start', new FunctionResult('Starting')],
|
|
186
|
+
},
|
|
187
|
+
});
|
|
188
|
+
const fn = dm.toSwaigFunction();
|
|
189
|
+
const exprs = (fn['data_map'] as Record<string, unknown>)['expressions'] as Record<string, unknown>[];
|
|
190
|
+
expect(exprs.length).toBe(1);
|
|
191
|
+
});
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
// ── Pass 3: DataMap enhancements ──────────────────────────────────
|
|
195
|
+
|
|
196
|
+
describe('DataMap - registerWithAgent', () => {
|
|
197
|
+
it('registers DataMap with an agent-like object', () => {
|
|
198
|
+
const registered: Record<string, unknown>[] = [];
|
|
199
|
+
const mockAgent = {
|
|
200
|
+
registerSwaigFunction(fn: Record<string, unknown>) {
|
|
201
|
+
registered.push(fn);
|
|
202
|
+
},
|
|
203
|
+
};
|
|
204
|
+
const dm = new DataMap('my_tool')
|
|
205
|
+
.purpose('Test tool')
|
|
206
|
+
.webhook('GET', 'https://example.com')
|
|
207
|
+
.output(new FunctionResult('ok'));
|
|
208
|
+
|
|
209
|
+
dm.registerWithAgent(mockAgent);
|
|
210
|
+
expect(registered.length).toBe(1);
|
|
211
|
+
expect(registered[0]['function']).toBe('my_tool');
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
it('registerWithAgent returns this for chaining', () => {
|
|
215
|
+
const mockAgent = { registerSwaigFunction() {} };
|
|
216
|
+
const dm = new DataMap('fn')
|
|
217
|
+
.webhook('GET', 'https://example.com')
|
|
218
|
+
.output(new FunctionResult('ok'));
|
|
219
|
+
expect(dm.registerWithAgent(mockAgent)).toBe(dm);
|
|
220
|
+
});
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
describe('DataMap - ENV expansion', () => {
|
|
224
|
+
it('expands ${ENV.*} variables in webhook URLs', () => {
|
|
225
|
+
const saved = process.env['SWML_TEST_API_KEY'];
|
|
226
|
+
process.env['SWML_TEST_API_KEY'] = 'secret123';
|
|
227
|
+
try {
|
|
228
|
+
const dm = new DataMap('fn')
|
|
229
|
+
.enableEnvExpansion()
|
|
230
|
+
.purpose('Test')
|
|
231
|
+
.webhook('GET', 'https://api.example.com?key=${ENV.SWML_TEST_API_KEY}')
|
|
232
|
+
.output(new FunctionResult('ok'));
|
|
233
|
+
const fn = dm.toSwaigFunction();
|
|
234
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
235
|
+
expect(webhooks[0]['url']).toBe('https://api.example.com?key=secret123');
|
|
236
|
+
} finally {
|
|
237
|
+
if (saved) process.env['SWML_TEST_API_KEY'] = saved;
|
|
238
|
+
else delete process.env['SWML_TEST_API_KEY'];
|
|
239
|
+
}
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
it('missing ENV vars expand to empty string', () => {
|
|
243
|
+
delete process.env['SWML_NONEXISTENT_VAR_12345'];
|
|
244
|
+
const dm = new DataMap('fn')
|
|
245
|
+
.enableEnvExpansion()
|
|
246
|
+
.webhook('GET', 'https://api.example.com?key=${ENV.SWML_NONEXISTENT_VAR_12345}')
|
|
247
|
+
.output(new FunctionResult('ok'));
|
|
248
|
+
const fn = dm.toSwaigFunction();
|
|
249
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
250
|
+
expect(webhooks[0]['url']).toBe('https://api.example.com?key=');
|
|
251
|
+
});
|
|
252
|
+
|
|
253
|
+
it('no expansion when enableEnvExpansion not called', () => {
|
|
254
|
+
process.env['TEST_NO_EXPAND'] = 'should-not-appear';
|
|
255
|
+
try {
|
|
256
|
+
const dm = new DataMap('fn')
|
|
257
|
+
.webhook('GET', 'https://api.example.com?key=${ENV.TEST_NO_EXPAND}')
|
|
258
|
+
.output(new FunctionResult('ok'));
|
|
259
|
+
const fn = dm.toSwaigFunction();
|
|
260
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
261
|
+
expect(webhooks[0]['url']).toBe('https://api.example.com?key=${ENV.TEST_NO_EXPAND}');
|
|
262
|
+
} finally {
|
|
263
|
+
delete process.env['TEST_NO_EXPAND'];
|
|
264
|
+
}
|
|
265
|
+
});
|
|
266
|
+
|
|
267
|
+
it('expands ENV vars in descriptions and outputs', () => {
|
|
268
|
+
process.env['SWML_SERVICE_NAME'] = 'MyService';
|
|
269
|
+
try {
|
|
270
|
+
const dm = new DataMap('fn')
|
|
271
|
+
.enableEnvExpansion()
|
|
272
|
+
.purpose('Call ${ENV.SWML_SERVICE_NAME} API')
|
|
273
|
+
.webhook('GET', 'https://example.com')
|
|
274
|
+
.output(new FunctionResult('ok'));
|
|
275
|
+
const fn = dm.toSwaigFunction();
|
|
276
|
+
expect(fn['description']).toBe('Call MyService API');
|
|
277
|
+
} finally {
|
|
278
|
+
delete process.env['SWML_SERVICE_NAME'];
|
|
279
|
+
}
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
it('enableEnvExpansion returns this for chaining', () => {
|
|
283
|
+
const dm = new DataMap('fn');
|
|
284
|
+
expect(dm.enableEnvExpansion()).toBe(dm);
|
|
285
|
+
});
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
describe('DataMap - ENV prefix whitelist', () => {
|
|
289
|
+
afterEach(() => {
|
|
290
|
+
// Reset to defaults
|
|
291
|
+
setAllowedEnvPrefixes(['SIGNALWIRE_', 'SWML_', 'SW_']);
|
|
292
|
+
delete process.env['SIGNALWIRE_TEST_VAR'];
|
|
293
|
+
delete process.env['SWML_TEST_VAR'];
|
|
294
|
+
delete process.env['DATABASE_URL'];
|
|
295
|
+
delete process.env['SECRET_KEY'];
|
|
296
|
+
});
|
|
297
|
+
|
|
298
|
+
it('SIGNALWIRE_ prefix expanded by default', () => {
|
|
299
|
+
process.env['SIGNALWIRE_TEST_VAR'] = 'sw_value';
|
|
300
|
+
const dm = new DataMap('fn')
|
|
301
|
+
.enableEnvExpansion()
|
|
302
|
+
.webhook('GET', 'https://example.com?key=${ENV.SIGNALWIRE_TEST_VAR}')
|
|
303
|
+
.output(new FunctionResult('ok'));
|
|
304
|
+
const fn = dm.toSwaigFunction();
|
|
305
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
306
|
+
expect(webhooks[0]['url']).toBe('https://example.com?key=sw_value');
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
it('SWML_ prefix expanded by default', () => {
|
|
310
|
+
process.env['SWML_TEST_VAR'] = 'swml_value';
|
|
311
|
+
const dm = new DataMap('fn')
|
|
312
|
+
.enableEnvExpansion()
|
|
313
|
+
.webhook('GET', 'https://example.com?key=${ENV.SWML_TEST_VAR}')
|
|
314
|
+
.output(new FunctionResult('ok'));
|
|
315
|
+
const fn = dm.toSwaigFunction();
|
|
316
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
317
|
+
expect(webhooks[0]['url']).toBe('https://example.com?key=swml_value');
|
|
318
|
+
});
|
|
319
|
+
|
|
320
|
+
it('DATABASE_URL not expanded by default', () => {
|
|
321
|
+
process.env['DATABASE_URL'] = 'postgres://secret@host/db';
|
|
322
|
+
const dm = new DataMap('fn')
|
|
323
|
+
.enableEnvExpansion()
|
|
324
|
+
.webhook('GET', 'https://example.com?db=${ENV.DATABASE_URL}')
|
|
325
|
+
.output(new FunctionResult('ok'));
|
|
326
|
+
const fn = dm.toSwaigFunction();
|
|
327
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
328
|
+
expect(webhooks[0]['url']).toBe('https://example.com?db=');
|
|
329
|
+
});
|
|
330
|
+
|
|
331
|
+
it('setAllowedEnvPrefixes overrides defaults', () => {
|
|
332
|
+
setAllowedEnvPrefixes(['DATABASE_']);
|
|
333
|
+
process.env['DATABASE_URL'] = 'postgres://host/db';
|
|
334
|
+
process.env['SIGNALWIRE_TEST_VAR'] = 'should_not_expand';
|
|
335
|
+
const dm = new DataMap('fn')
|
|
336
|
+
.enableEnvExpansion()
|
|
337
|
+
.webhook('GET', 'https://example.com?db=${ENV.DATABASE_URL}&sw=${ENV.SIGNALWIRE_TEST_VAR}')
|
|
338
|
+
.output(new FunctionResult('ok'));
|
|
339
|
+
const fn = dm.toSwaigFunction();
|
|
340
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
341
|
+
expect(webhooks[0]['url']).toBe('https://example.com?db=postgres://host/db&sw=');
|
|
342
|
+
});
|
|
343
|
+
|
|
344
|
+
it('empty prefix list allows all vars', () => {
|
|
345
|
+
setAllowedEnvPrefixes([]);
|
|
346
|
+
process.env['SECRET_KEY'] = 'mysecret';
|
|
347
|
+
const dm = new DataMap('fn')
|
|
348
|
+
.enableEnvExpansion()
|
|
349
|
+
.webhook('GET', 'https://example.com?key=${ENV.SECRET_KEY}')
|
|
350
|
+
.output(new FunctionResult('ok'));
|
|
351
|
+
const fn = dm.toSwaigFunction();
|
|
352
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
353
|
+
expect(webhooks[0]['url']).toBe('https://example.com?key=mysecret');
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
it('per-instance setAllowedEnvPrefixes overrides global', () => {
|
|
357
|
+
process.env['DATABASE_URL'] = 'postgres://host/db';
|
|
358
|
+
const dm = new DataMap('fn')
|
|
359
|
+
.enableEnvExpansion()
|
|
360
|
+
.setAllowedEnvPrefixes(['DATABASE_'])
|
|
361
|
+
.webhook('GET', 'https://example.com?db=${ENV.DATABASE_URL}')
|
|
362
|
+
.output(new FunctionResult('ok'));
|
|
363
|
+
const fn = dm.toSwaigFunction();
|
|
364
|
+
const webhooks = (fn['data_map'] as Record<string, unknown>)['webhooks'] as Record<string, unknown>[];
|
|
365
|
+
expect(webhooks[0]['url']).toBe('https://example.com?db=postgres://host/db');
|
|
366
|
+
});
|
|
367
|
+
});
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import { AgentBase } from '../src/AgentBase.js';
|
|
3
|
+
import { SkillBase, type SkillToolDefinition } from '../src/skills/SkillBase.js';
|
|
4
|
+
import { FunctionResult } from '../src/FunctionResult.js';
|
|
5
|
+
|
|
6
|
+
/** Test skill that adds a tool and prompt section. */
|
|
7
|
+
class EphemeralTestSkill extends SkillBase {
|
|
8
|
+
static override SKILL_NAME = 'ephemeral_test';
|
|
9
|
+
static override SKILL_DESCRIPTION = 'Ephemeral test';
|
|
10
|
+
|
|
11
|
+
getTools(): SkillToolDefinition[] {
|
|
12
|
+
return [{
|
|
13
|
+
name: 'ephemeral_tool',
|
|
14
|
+
description: 'A tool from ephemeral test skill',
|
|
15
|
+
handler: () => new FunctionResult('ephemeral result'),
|
|
16
|
+
}];
|
|
17
|
+
}
|
|
18
|
+
protected override _getPromptSections() {
|
|
19
|
+
return [{ title: 'Ephemeral Section', body: 'ephemeral body' }];
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
describe('Ephemeral Skill Copy', () => {
|
|
24
|
+
it('ephemeral copy has same skill tools registered', async () => {
|
|
25
|
+
const agent = new AgentBase({
|
|
26
|
+
name: 'eph-agent',
|
|
27
|
+
route: '/',
|
|
28
|
+
basicAuth: ['user', 'pass'],
|
|
29
|
+
});
|
|
30
|
+
agent.setPromptText('You are a test assistant.');
|
|
31
|
+
|
|
32
|
+
await agent.addSkill(new EphemeralTestSkill());
|
|
33
|
+
|
|
34
|
+
// Verify original has the tool
|
|
35
|
+
const tools = agent.getRegisteredTools();
|
|
36
|
+
expect(tools.some(t => t.name === 'ephemeral_tool')).toBe(true);
|
|
37
|
+
|
|
38
|
+
// Render SWML with dynamic config callback to test ephemeral copy
|
|
39
|
+
let ephemeralToolNames: string[] = [];
|
|
40
|
+
agent.setDynamicConfigCallback((_qp, _body, _headers, copy) => {
|
|
41
|
+
ephemeralToolNames = copy.getRegisteredTools().map(t => t.name);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
// Trigger SWML rendering via getApp()
|
|
45
|
+
const app = agent.getApp();
|
|
46
|
+
const response = await app.request('/', {
|
|
47
|
+
method: 'POST',
|
|
48
|
+
headers: {
|
|
49
|
+
'Content-Type': 'application/json',
|
|
50
|
+
'Authorization': 'Basic ' + Buffer.from('user:pass').toString('base64'),
|
|
51
|
+
},
|
|
52
|
+
body: JSON.stringify({}),
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
expect(response.status).toBe(200);
|
|
56
|
+
expect(ephemeralToolNames).toContain('ephemeral_tool');
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('ephemeral copy renders SWML with skill tools', async () => {
|
|
60
|
+
const agent = new AgentBase({
|
|
61
|
+
name: 'eph-agent2',
|
|
62
|
+
route: '/',
|
|
63
|
+
basicAuth: ['user', 'pass'],
|
|
64
|
+
});
|
|
65
|
+
agent.setPromptText('You are a test assistant.');
|
|
66
|
+
await agent.addSkill(new EphemeralTestSkill());
|
|
67
|
+
|
|
68
|
+
let ephemeralSwml = '';
|
|
69
|
+
agent.setDynamicConfigCallback((_qp, _body, _headers, copy) => {
|
|
70
|
+
ephemeralSwml = copy.renderSwml();
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
const app = agent.getApp();
|
|
74
|
+
await app.request('/', {
|
|
75
|
+
method: 'POST',
|
|
76
|
+
headers: {
|
|
77
|
+
'Content-Type': 'application/json',
|
|
78
|
+
'Authorization': 'Basic ' + Buffer.from('user:pass').toString('base64'),
|
|
79
|
+
},
|
|
80
|
+
body: JSON.stringify({}),
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
expect(ephemeralSwml).toBeTruthy();
|
|
84
|
+
const parsed = JSON.parse(ephemeralSwml);
|
|
85
|
+
const aiBlock = parsed.sections.main.find((v: any) => v.ai);
|
|
86
|
+
expect(aiBlock).toBeDefined();
|
|
87
|
+
const funcs = aiBlock.ai.SWAIG?.functions ?? [];
|
|
88
|
+
expect(funcs.some((f: any) => f.function === 'ephemeral_tool')).toBe(true);
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it('swaigFields are merged into tool definitions', async () => {
|
|
92
|
+
const agent = new AgentBase({
|
|
93
|
+
name: 'sf-agent',
|
|
94
|
+
route: '/',
|
|
95
|
+
basicAuth: ['user', 'pass'],
|
|
96
|
+
});
|
|
97
|
+
agent.setPromptText('Test');
|
|
98
|
+
await agent.addSkill(new EphemeralTestSkill({ swaig_fields: { wait_file: 'hold.mp3' } }));
|
|
99
|
+
|
|
100
|
+
const swml = JSON.parse(agent.renderSwml());
|
|
101
|
+
const aiBlock = swml.sections.main.find((v: any) => v.ai);
|
|
102
|
+
const funcs = aiBlock.ai.SWAIG.functions;
|
|
103
|
+
const ephTool = funcs.find((f: any) => f.function === 'ephemeral_tool');
|
|
104
|
+
expect(ephTool).toBeDefined();
|
|
105
|
+
expect(ephTool.wait_file).toBe('hold.mp3');
|
|
106
|
+
});
|
|
107
|
+
});
|