@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,166 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agent discovery via dynamic import for swaig-test CLI.
|
|
3
|
+
*
|
|
4
|
+
* Tries multiple strategies to find an AgentBase instance:
|
|
5
|
+
* 1. Named export `agent`
|
|
6
|
+
* 2. Default export
|
|
7
|
+
* 3. Any exported AgentBase instance (duck-typed)
|
|
8
|
+
* 4. Any exported AgentBase subclass (instantiated)
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import { resolve, extname } from 'node:path';
|
|
12
|
+
import { pathToFileURL } from 'node:url';
|
|
13
|
+
|
|
14
|
+
/** Allowed file extensions for agent loading. */
|
|
15
|
+
const ALLOWED_EXTENSIONS = new Set(['.ts', '.js', '.mjs', '.mts']);
|
|
16
|
+
|
|
17
|
+
function isAgentInstance(obj: unknown): boolean {
|
|
18
|
+
if (!obj || typeof obj !== 'object') return false;
|
|
19
|
+
const a = obj as Record<string, unknown>;
|
|
20
|
+
return (
|
|
21
|
+
typeof a['renderSwml'] === 'function' &&
|
|
22
|
+
typeof a['defineTool'] === 'function' &&
|
|
23
|
+
typeof a['getPrompt'] === 'function'
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
function isAgentClass(obj: unknown): boolean {
|
|
28
|
+
if (typeof obj !== 'function') return false;
|
|
29
|
+
const proto = (obj as any).prototype;
|
|
30
|
+
if (!proto) return false;
|
|
31
|
+
return (
|
|
32
|
+
typeof proto['renderSwml'] === 'function' &&
|
|
33
|
+
typeof proto['defineTool'] === 'function' &&
|
|
34
|
+
typeof proto['getPrompt'] === 'function'
|
|
35
|
+
);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function isSWMLServiceInstance(obj: unknown): boolean {
|
|
39
|
+
if (!obj || typeof obj !== 'object') return false;
|
|
40
|
+
const a = obj as Record<string, unknown>;
|
|
41
|
+
return (
|
|
42
|
+
typeof a['renderSwml'] === 'function' &&
|
|
43
|
+
typeof a['getApp'] === 'function' &&
|
|
44
|
+
typeof a['addVerb'] === 'function' &&
|
|
45
|
+
typeof a['defineTool'] !== 'function'
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Import a module by path after validating the file extension.
|
|
51
|
+
*
|
|
52
|
+
* **Security note:** Only `.ts`, `.js`, `.mjs`, and `.mts` extensions are allowed
|
|
53
|
+
* to prevent loading unexpected file types via dynamic import.
|
|
54
|
+
*/
|
|
55
|
+
async function importModule(agentPath: string): Promise<Record<string, unknown>> {
|
|
56
|
+
const absPath = resolve(agentPath);
|
|
57
|
+
const ext = extname(absPath).toLowerCase();
|
|
58
|
+
if (!ALLOWED_EXTENSIONS.has(ext)) {
|
|
59
|
+
throw new Error(
|
|
60
|
+
`Unsupported file extension '${ext}' for agent file: ${absPath}. ` +
|
|
61
|
+
`Only ${[...ALLOWED_EXTENSIONS].join(', ')} files are allowed.`,
|
|
62
|
+
);
|
|
63
|
+
}
|
|
64
|
+
const fileUrl = pathToFileURL(absPath).href;
|
|
65
|
+
|
|
66
|
+
// Suppress server startup: agent files call .run() at module scope,
|
|
67
|
+
// but the CLI only needs the configured agent instance, not a running server.
|
|
68
|
+
process.env['SWAIG_CLI_MODE'] = 'true';
|
|
69
|
+
try {
|
|
70
|
+
return await import(fileUrl);
|
|
71
|
+
} catch (err) {
|
|
72
|
+
throw new Error(`Failed to import agent file: ${absPath}\n${err}`);
|
|
73
|
+
} finally {
|
|
74
|
+
delete process.env['SWAIG_CLI_MODE'];
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Dynamically import an agent file and resolve an AgentBase instance using duck-typing heuristics.
|
|
80
|
+
* @param agentPath - Path to the agent module file.
|
|
81
|
+
* @param agentClass - Optional name of a specific exported class or instance to use.
|
|
82
|
+
* @returns The resolved AgentBase instance.
|
|
83
|
+
*/
|
|
84
|
+
export async function loadAgent(agentPath: string, agentClass?: string): Promise<unknown> {
|
|
85
|
+
const mod = await importModule(agentPath);
|
|
86
|
+
|
|
87
|
+
// If a specific class name is requested
|
|
88
|
+
if (agentClass) {
|
|
89
|
+
const target = mod[agentClass];
|
|
90
|
+
if (!target) {
|
|
91
|
+
throw new Error(`Export '${agentClass}' not found in ${agentPath}`);
|
|
92
|
+
}
|
|
93
|
+
if (isAgentInstance(target)) return target;
|
|
94
|
+
if (isAgentClass(target)) {
|
|
95
|
+
const Cls = target as new (opts: { name: string }) => unknown;
|
|
96
|
+
return new Cls({ name: agentClass.toLowerCase() });
|
|
97
|
+
}
|
|
98
|
+
throw new Error(`Export '${agentClass}' is not an AgentBase instance or class`);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
// 1. Named export `agent`
|
|
102
|
+
if (mod['agent'] && isAgentInstance(mod['agent'])) {
|
|
103
|
+
return mod['agent'];
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// 2. Default export (instance)
|
|
107
|
+
if (mod['default'] && isAgentInstance(mod['default'])) {
|
|
108
|
+
return mod['default'];
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// 3. Any exported AgentBase instance
|
|
112
|
+
for (const key of Object.keys(mod)) {
|
|
113
|
+
if (isAgentInstance(mod[key])) {
|
|
114
|
+
return mod[key];
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// 4. Default export (class) - instantiate
|
|
119
|
+
if (mod['default'] && isAgentClass(mod['default'])) {
|
|
120
|
+
const Cls = mod['default'] as new (opts: { name: string }) => unknown;
|
|
121
|
+
return new Cls({ name: 'cli-agent' });
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
// 5. Any exported AgentBase subclass
|
|
125
|
+
for (const key of Object.keys(mod)) {
|
|
126
|
+
if (isAgentClass(mod[key])) {
|
|
127
|
+
const Cls = mod[key] as new (opts: { name: string }) => unknown;
|
|
128
|
+
return new Cls({ name: 'cli-agent' });
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
// 6. Named export `agent` as SWMLService
|
|
133
|
+
if (mod['agent'] && isSWMLServiceInstance(mod['agent'])) {
|
|
134
|
+
return mod['agent'];
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// 7. Any exported SWMLService instance
|
|
138
|
+
for (const key of Object.keys(mod)) {
|
|
139
|
+
if (isSWMLServiceInstance(mod[key])) {
|
|
140
|
+
return mod[key];
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
throw new Error(
|
|
145
|
+
`Could not find an AgentBase or SWMLService instance in ${resolve(agentPath)}.\n` +
|
|
146
|
+
'Export your agent as `export const agent = new AgentBase(...)` or as default export.',
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* List all exported agent instances and classes in a module.
|
|
152
|
+
* @param agentPath - Path to the agent module file.
|
|
153
|
+
* @returns Array of export names that are AgentBase instances or subclasses.
|
|
154
|
+
*/
|
|
155
|
+
export async function listAgents(agentPath: string): Promise<string[]> {
|
|
156
|
+
const mod = await importModule(agentPath);
|
|
157
|
+
const agents: string[] = [];
|
|
158
|
+
|
|
159
|
+
for (const key of Object.keys(mod)) {
|
|
160
|
+
if (isAgentInstance(mod[key]) || isAgentClass(mod[key]) || isSWMLServiceInstance(mod[key])) {
|
|
161
|
+
agents.push(key);
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
return agents;
|
|
166
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mock call data generation for swaig-test CLI.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { randomBytes } from 'node:crypto';
|
|
6
|
+
import { safeAssign } from '../SecurityUtils.js';
|
|
7
|
+
|
|
8
|
+
/** Options for generating mock call data in CLI testing. */
|
|
9
|
+
export interface MockCallOptions {
|
|
10
|
+
/** Call transport type. */
|
|
11
|
+
callType?: 'sip' | 'webrtc';
|
|
12
|
+
/** Direction of the call. */
|
|
13
|
+
callDirection?: 'inbound' | 'outbound';
|
|
14
|
+
/** Current call state (e.g. "active", "ringing", "hold"). */
|
|
15
|
+
callState?: string;
|
|
16
|
+
/** Override the auto-generated call ID. */
|
|
17
|
+
callId?: string;
|
|
18
|
+
/** Caller's phone number. */
|
|
19
|
+
fromNumber?: string;
|
|
20
|
+
/** Destination extension or agent name. */
|
|
21
|
+
toExtension?: string;
|
|
22
|
+
/** Additional key-value overrides merged into the post data. */
|
|
23
|
+
overrides?: Record<string, unknown>;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
function randomId(): string {
|
|
27
|
+
return randomBytes(16).toString('hex');
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function randomUuid(): string {
|
|
31
|
+
const hex = randomBytes(16).toString('hex');
|
|
32
|
+
return `${hex.slice(0, 8)}-${hex.slice(8, 12)}-${hex.slice(12, 16)}-${hex.slice(16, 20)}-${hex.slice(20)}`;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Generate a full mock POST body simulating an inbound SignalWire call request.
|
|
37
|
+
* @param opts - Optional overrides for call metadata fields.
|
|
38
|
+
* @returns A record representing the simulated call POST data.
|
|
39
|
+
*/
|
|
40
|
+
export function generateFakePostData(opts?: MockCallOptions): Record<string, unknown> {
|
|
41
|
+
const callType = opts?.callType ?? 'webrtc';
|
|
42
|
+
const callDirection = opts?.callDirection ?? 'inbound';
|
|
43
|
+
const callState = opts?.callState ?? 'active';
|
|
44
|
+
const fromNumber = opts?.fromNumber ?? '+15551234567';
|
|
45
|
+
const toExtension = opts?.toExtension ?? 'test-agent';
|
|
46
|
+
const callId = opts?.callId ?? randomUuid();
|
|
47
|
+
const nodeId = randomUuid();
|
|
48
|
+
const projectId = randomUuid();
|
|
49
|
+
const spaceId = randomUuid();
|
|
50
|
+
|
|
51
|
+
const data: Record<string, unknown> = {
|
|
52
|
+
call_id: callId,
|
|
53
|
+
call_type: callType,
|
|
54
|
+
call_direction: callDirection,
|
|
55
|
+
call_state: callState,
|
|
56
|
+
node_id: nodeId,
|
|
57
|
+
project_id: projectId,
|
|
58
|
+
space_id: spaceId,
|
|
59
|
+
caller_id_name: callType === 'sip' ? fromNumber : 'WebRTC User',
|
|
60
|
+
caller_id_number: fromNumber,
|
|
61
|
+
call_start_time: new Date().toISOString(),
|
|
62
|
+
channel_type: callType === 'sip' ? 'phone' : 'web',
|
|
63
|
+
from: fromNumber,
|
|
64
|
+
to: toExtension,
|
|
65
|
+
sip_headers: callType === 'sip' ? {
|
|
66
|
+
'X-SignalWire-Agent': 'swaig-test-cli',
|
|
67
|
+
} : undefined,
|
|
68
|
+
vars: {
|
|
69
|
+
call_type: callType,
|
|
70
|
+
direction: callDirection,
|
|
71
|
+
},
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
// Apply overrides
|
|
75
|
+
if (opts?.overrides) {
|
|
76
|
+
safeAssign(data, opts.overrides);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
return data;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Generate a minimal mock POST body for executing a single SWAIG function.
|
|
84
|
+
* @param fnName - Name of the SWAIG function to invoke.
|
|
85
|
+
* @param args - Arguments to pass to the function.
|
|
86
|
+
* @param opts - Optional call ID and field overrides.
|
|
87
|
+
* @returns A record representing the minimal POST data for function execution.
|
|
88
|
+
*/
|
|
89
|
+
export function generateMinimalPostData(
|
|
90
|
+
fnName: string,
|
|
91
|
+
args?: Record<string, unknown>,
|
|
92
|
+
opts?: { callId?: string; overrides?: Record<string, unknown> },
|
|
93
|
+
): Record<string, unknown> {
|
|
94
|
+
const data: Record<string, unknown> = {
|
|
95
|
+
function: fnName,
|
|
96
|
+
argument: args ?? {},
|
|
97
|
+
call_id: opts?.callId ?? randomUuid(),
|
|
98
|
+
call_type: 'webrtc',
|
|
99
|
+
call_direction: 'inbound',
|
|
100
|
+
caller_id_name: 'CLI Test',
|
|
101
|
+
caller_id_number: '+15551234567',
|
|
102
|
+
from: '+15551234567',
|
|
103
|
+
to: 'test-agent',
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
if (opts?.overrides) {
|
|
107
|
+
safeAssign(data, opts.overrides);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
return data;
|
|
111
|
+
}
|