@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,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the ClaudeSkills skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { ClaudeSkillsSkill, createClaudeSkillsSkill } from '../../src/skills/builtin/index.js';
|
|
7
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
8
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
9
|
+
|
|
10
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
11
|
+
|
|
12
|
+
describe('ClaudeSkillsSkill', () => {
|
|
13
|
+
it('should instantiate via constructor and factory', () => {
|
|
14
|
+
expect(new ClaudeSkillsSkill()).toBeInstanceOf(SkillBase);
|
|
15
|
+
expect(createClaudeSkillsSkill()).toBeInstanceOf(ClaudeSkillsSkill);
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it('should return false from setup when skills_path is not configured', async () => {
|
|
19
|
+
await expect(new ClaudeSkillsSkill().setup()).resolves.toBe(false);
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it('should return empty tools when no skills_path is configured', () => {
|
|
23
|
+
const tools = new ClaudeSkillsSkill().getTools();
|
|
24
|
+
expect(Array.isArray(tools)).toBe(true);
|
|
25
|
+
expect(tools).toHaveLength(0);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('should return empty prompt sections when no skills_path is configured', () => {
|
|
29
|
+
const sections = new ClaudeSkillsSkill().getPromptSections();
|
|
30
|
+
expect(Array.isArray(sections)).toBe(true);
|
|
31
|
+
expect(sections).toHaveLength(0);
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
35
|
+
expect(new ClaudeSkillsSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('should return empty hints and global data', () => {
|
|
39
|
+
const skill = new ClaudeSkillsSkill();
|
|
40
|
+
expect(skill.getHints()).toEqual([]);
|
|
41
|
+
expect(skill.getGlobalData()).toEqual({});
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should return correct manifest', () => {
|
|
45
|
+
const klass = ClaudeSkillsSkill as typeof SkillBase;
|
|
46
|
+
expect(klass.SKILL_NAME).toBe('claude_skills');
|
|
47
|
+
expect(klass.SKILL_VERSION).toBe('1.0.0');
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('should have a parameter schema', () => {
|
|
51
|
+
const schema = ClaudeSkillsSkill.getParameterSchema();
|
|
52
|
+
expect(schema).toBeDefined();
|
|
53
|
+
});
|
|
54
|
+
});
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the CustomSkills skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { CustomSkillsSkill, createCustomSkillsSkill } from '../../src/skills/builtin/index.js';
|
|
7
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
8
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
9
|
+
|
|
10
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
11
|
+
|
|
12
|
+
describe('CustomSkillsSkill', () => {
|
|
13
|
+
it('should instantiate via constructor and factory', () => {
|
|
14
|
+
expect(new CustomSkillsSkill()).toBeInstanceOf(SkillBase);
|
|
15
|
+
expect(createCustomSkillsSkill()).toBeInstanceOf(CustomSkillsSkill);
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it('should complete setup without errors', async () => {
|
|
19
|
+
await expect(new CustomSkillsSkill().setup()).resolves.toBe(true);
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
it('should register tools', () => {
|
|
23
|
+
const tools = new CustomSkillsSkill().getTools();
|
|
24
|
+
// CustomSkills may have zero tools if no custom tools are configured
|
|
25
|
+
expect(Array.isArray(tools)).toBe(true);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('should provide prompt sections', () => {
|
|
29
|
+
const sections = new CustomSkillsSkill().getPromptSections();
|
|
30
|
+
expect(Array.isArray(sections)).toBe(true);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
34
|
+
expect(new CustomSkillsSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it('should return empty hints and global data', () => {
|
|
38
|
+
const skill = new CustomSkillsSkill();
|
|
39
|
+
expect(skill.getHints()).toEqual([]);
|
|
40
|
+
expect(skill.getGlobalData()).toEqual({});
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it('should return correct manifest', () => {
|
|
44
|
+
const klass = CustomSkillsSkill as typeof SkillBase;
|
|
45
|
+
expect(klass.SKILL_NAME).toBe('custom_skills');
|
|
46
|
+
expect(klass.SKILL_VERSION).toBe('1.0.0');
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it('should have a parameter schema', () => {
|
|
50
|
+
const schema = CustomSkillsSkill.getParameterSchema();
|
|
51
|
+
expect(schema).toBeDefined();
|
|
52
|
+
});
|
|
53
|
+
});
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the DataSphereServerless skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { DataSphereServerlessSkill, createDataSphereServerlessSkill } from '../../src/skills/builtin/index.js';
|
|
7
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
8
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
9
|
+
|
|
10
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
11
|
+
|
|
12
|
+
describe('DataSphereServerlessSkill', () => {
|
|
13
|
+
it('should instantiate via constructor and factory', () => {
|
|
14
|
+
expect(new DataSphereServerlessSkill()).toBeInstanceOf(SkillBase);
|
|
15
|
+
expect(createDataSphereServerlessSkill()).toBeInstanceOf(DataSphereServerlessSkill);
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it('should return false from setup when required params are missing', async () => {
|
|
19
|
+
// Python setup() returns False when space_name/project_id/token/document_id are absent.
|
|
20
|
+
await expect(new DataSphereServerlessSkill().setup()).resolves.toBe(false);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should return true from setup when all required params are present', async () => {
|
|
24
|
+
const skill = new DataSphereServerlessSkill({
|
|
25
|
+
space_name: 'mycompany',
|
|
26
|
+
project_id: 'proj-123',
|
|
27
|
+
token: 'tok-abc',
|
|
28
|
+
document_id: 'doc-xyz',
|
|
29
|
+
});
|
|
30
|
+
await expect(skill.setup()).resolves.toBe(true);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it('should register tools', () => {
|
|
34
|
+
const tools = new DataSphereServerlessSkill().getTools();
|
|
35
|
+
expect(tools.length).toBeGreaterThan(0);
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('should provide prompt sections', () => {
|
|
39
|
+
const sections = new DataSphereServerlessSkill().getPromptSections();
|
|
40
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
44
|
+
expect(new DataSphereServerlessSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it('should return empty hints', () => {
|
|
48
|
+
const skill = new DataSphereServerlessSkill();
|
|
49
|
+
expect(skill.getHints()).toEqual([]);
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('should expose DataSphere metadata via global data', () => {
|
|
53
|
+
const skill = new DataSphereServerlessSkill({ document_id: 'doc-1' });
|
|
54
|
+
const globalData = skill.getGlobalData();
|
|
55
|
+
expect(globalData['datasphere_serverless_enabled']).toBe(true);
|
|
56
|
+
expect(globalData['document_id']).toBe('doc-1');
|
|
57
|
+
expect(globalData['knowledge_provider']).toBe('SignalWire DataSphere (Serverless)');
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
it('should return correct manifest', () => {
|
|
61
|
+
const klass = DataSphereServerlessSkill as typeof SkillBase;
|
|
62
|
+
expect(klass.SKILL_NAME).toBe('datasphere_serverless');
|
|
63
|
+
expect(klass.SKILL_VERSION).toBe('1.0.0');
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
it('should have a parameter schema', () => {
|
|
67
|
+
const schema = DataSphereServerlessSkill.getParameterSchema();
|
|
68
|
+
expect(schema).toBeDefined();
|
|
69
|
+
});
|
|
70
|
+
});
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the DataSphere skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { DataSphereSkill, createDataSphereSkill } from '../../src/skills/builtin/index.js';
|
|
7
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
8
|
+
import { FunctionResult } from '../../src/FunctionResult.js';
|
|
9
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
10
|
+
|
|
11
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
12
|
+
|
|
13
|
+
describe('DataSphereSkill', () => {
|
|
14
|
+
it('should instantiate via constructor and factory', () => {
|
|
15
|
+
expect(new DataSphereSkill()).toBeInstanceOf(SkillBase);
|
|
16
|
+
expect(createDataSphereSkill()).toBeInstanceOf(DataSphereSkill);
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('should support multiple instances', () => {
|
|
20
|
+
expect(DataSphereSkill.SUPPORTS_MULTIPLE_INSTANCES).toBe(true);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should return false from setup when credentials are missing', async () => {
|
|
24
|
+
// Python parity (skills/datasphere/skill.py:120-128): setup() returns false
|
|
25
|
+
// with an error log when any of space_name, project_id, token, document_id
|
|
26
|
+
// is missing. Fails closed so the skill never exposes broken tools to the AI.
|
|
27
|
+
await expect(new DataSphereSkill().setup()).resolves.toBe(false);
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it('should complete setup when all credentials + document_id are provided', async () => {
|
|
31
|
+
await expect(
|
|
32
|
+
new DataSphereSkill({
|
|
33
|
+
space_name: 'test',
|
|
34
|
+
project_id: 'p',
|
|
35
|
+
token: 't',
|
|
36
|
+
document_id: 'd',
|
|
37
|
+
}).setup(),
|
|
38
|
+
).resolves.toBe(true);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
it('should register a search_knowledge tool', () => {
|
|
42
|
+
const tools = new DataSphereSkill().getTools();
|
|
43
|
+
expect(tools).toHaveLength(1);
|
|
44
|
+
expect(tools[0].name).toBe('search_knowledge');
|
|
45
|
+
expect(tools[0].required).toContain('query');
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it('should provide prompt sections', () => {
|
|
49
|
+
const sections = new DataSphereSkill().getPromptSections();
|
|
50
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
51
|
+
expect(sections[0].title).toContain('Knowledge Search');
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
55
|
+
expect(new DataSphereSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it('should return empty hints', () => {
|
|
59
|
+
const skill = new DataSphereSkill();
|
|
60
|
+
expect(skill.getHints()).toEqual([]);
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it('should expose DataSphere metadata via global data', () => {
|
|
64
|
+
const skill = new DataSphereSkill({ document_id: 'doc-1' });
|
|
65
|
+
const globalData = skill.getGlobalData();
|
|
66
|
+
expect(globalData['datasphere_enabled']).toBe(true);
|
|
67
|
+
expect(globalData['document_id']).toBe('doc-1');
|
|
68
|
+
expect(globalData['knowledge_provider']).toBe('SignalWire DataSphere');
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('should return correct manifest with no required env vars', () => {
|
|
72
|
+
const klass = DataSphereSkill as typeof SkillBase;
|
|
73
|
+
expect(klass.SKILL_NAME).toBe('datasphere');
|
|
74
|
+
expect(klass.REQUIRED_ENV_VARS).toEqual([]);
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it('should return error when credentials are missing', async () => {
|
|
78
|
+
delete process.env['SIGNALWIRE_PROJECT_ID'];
|
|
79
|
+
delete process.env['SIGNALWIRE_TOKEN'];
|
|
80
|
+
delete process.env['SIGNALWIRE_SPACE'];
|
|
81
|
+
const handler = new DataSphereSkill().getTools()[0].handler;
|
|
82
|
+
const result = await handler({ query: 'test' }, {}) as FunctionResult;
|
|
83
|
+
expect(result.response).toContain('not configured');
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it('should default instance key to datasphere_search_knowledge', () => {
|
|
87
|
+
const skill = new DataSphereSkill();
|
|
88
|
+
expect(skill.getInstanceKey()).toBe('datasphere_search_knowledge');
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it('should use custom instance key with tool_name', () => {
|
|
92
|
+
const skill = new DataSphereSkill({ tool_name: 'custom' });
|
|
93
|
+
expect(skill.getInstanceKey()).toBe('datasphere_custom');
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
it('should have a parameter schema', () => {
|
|
97
|
+
const schema = DataSphereSkill.getParameterSchema();
|
|
98
|
+
expect(schema['count']).toBeDefined();
|
|
99
|
+
expect(schema['distance']).toBeDefined();
|
|
100
|
+
expect(schema['tags']).toBeDefined();
|
|
101
|
+
expect(schema['language']).toBeDefined();
|
|
102
|
+
expect(schema['pos_to_expand']).toBeDefined();
|
|
103
|
+
expect(schema['max_synonyms']).toBeDefined();
|
|
104
|
+
expect(schema['no_results_message']).toBeDefined();
|
|
105
|
+
expect(schema['tool_name']).toBeDefined();
|
|
106
|
+
});
|
|
107
|
+
});
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the DateTime skill.
|
|
3
|
+
*
|
|
4
|
+
* Verifies: skill creation, setup, tool registration, hints, prompt sections, global data.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
8
|
+
import { DateTimeSkill, createDateTimeSkill } from '../../src/skills/builtin/index.js';
|
|
9
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
10
|
+
import { FunctionResult } from '../../src/FunctionResult.js';
|
|
11
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
12
|
+
|
|
13
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
14
|
+
|
|
15
|
+
describe('DateTimeSkill', () => {
|
|
16
|
+
it('should instantiate via constructor and factory', () => {
|
|
17
|
+
const skill = new DateTimeSkill();
|
|
18
|
+
expect(skill).toBeInstanceOf(SkillBase);
|
|
19
|
+
const fromFactory = createDateTimeSkill();
|
|
20
|
+
expect(fromFactory).toBeInstanceOf(DateTimeSkill);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should complete setup without errors', async () => {
|
|
24
|
+
const skill = new DateTimeSkill();
|
|
25
|
+
await expect(skill.setup()).resolves.toBe(true);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('should register get_current_time and get_current_date tools', () => {
|
|
29
|
+
const skill = new DateTimeSkill();
|
|
30
|
+
const tools = skill.getTools();
|
|
31
|
+
expect(tools).toHaveLength(2);
|
|
32
|
+
const names = tools.map((t) => t.name);
|
|
33
|
+
expect(names).toContain('get_current_time');
|
|
34
|
+
expect(names).toContain('get_current_date');
|
|
35
|
+
for (const tool of tools) {
|
|
36
|
+
expect(tool.description).toBeTruthy();
|
|
37
|
+
expect(tool.handler).toBeTypeOf('function');
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
it('should provide prompt sections', () => {
|
|
42
|
+
const skill = new DateTimeSkill();
|
|
43
|
+
const sections = skill.getPromptSections();
|
|
44
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
45
|
+
expect(sections[0].title).toBe('Date and Time Information');
|
|
46
|
+
expect(sections[0].bullets).toBeDefined();
|
|
47
|
+
expect(sections[0].bullets!.length).toBeGreaterThan(0);
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
51
|
+
const skill = new DateTimeSkill({ skip_prompt: true });
|
|
52
|
+
expect(skill.getPromptSections()).toHaveLength(0);
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it('should return empty hints', () => {
|
|
56
|
+
const skill = new DateTimeSkill();
|
|
57
|
+
expect(skill.getHints()).toEqual([]);
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
it('should return empty global data', () => {
|
|
61
|
+
const skill = new DateTimeSkill();
|
|
62
|
+
expect(skill.getGlobalData()).toEqual({});
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it('should return correct manifest', () => {
|
|
66
|
+
expect(DateTimeSkill.SKILL_NAME).toBe('datetime');
|
|
67
|
+
expect(DateTimeSkill.SKILL_VERSION).toBe('1.0.0');
|
|
68
|
+
expect(DateTimeSkill.SKILL_DESCRIPTION).toBeTruthy();
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('should execute get_current_time handler with a valid timezone', () => {
|
|
72
|
+
const skill = new DateTimeSkill();
|
|
73
|
+
const timeTool = skill.getTools().find((t) => t.name === 'get_current_time')!;
|
|
74
|
+
const result = timeTool.handler({ timezone: 'America/New_York' }, {}) as FunctionResult;
|
|
75
|
+
expect(result).toBeInstanceOf(FunctionResult);
|
|
76
|
+
expect(result.response).toContain('current time');
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
it('should execute get_current_date handler with a valid timezone', () => {
|
|
80
|
+
const skill = new DateTimeSkill();
|
|
81
|
+
const dateTool = skill.getTools().find((t) => t.name === 'get_current_date')!;
|
|
82
|
+
const result = dateTool.handler({ timezone: 'America/New_York' }, {}) as FunctionResult;
|
|
83
|
+
expect(result).toBeInstanceOf(FunctionResult);
|
|
84
|
+
expect(result.response).toContain("Today's date");
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it('should execute handler with an invalid timezone', () => {
|
|
88
|
+
const skill = new DateTimeSkill();
|
|
89
|
+
const handler = skill.getTools()[0].handler;
|
|
90
|
+
const result = handler({ timezone: 'Invalid/Zone' }, {}) as FunctionResult;
|
|
91
|
+
expect(result).toBeInstanceOf(FunctionResult);
|
|
92
|
+
expect(result.response).toContain('Invalid');
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
it('should have a parameter schema', () => {
|
|
96
|
+
const schema = DateTimeSkill.getParameterSchema();
|
|
97
|
+
expect(schema).toBeDefined();
|
|
98
|
+
expect(schema['swaig_fields']).toBeDefined();
|
|
99
|
+
expect(schema['skip_prompt']).toBeDefined();
|
|
100
|
+
});
|
|
101
|
+
});
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the GoogleMaps skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { GoogleMapsSkill, createGoogleMapsSkill } from '../../src/skills/builtin/index.js';
|
|
7
|
+
import { SkillBase } from '../../src/skills/SkillBase.js';
|
|
8
|
+
import { FunctionResult } from '../../src/FunctionResult.js';
|
|
9
|
+
import { suppressAllLogs } from '../../src/Logger.js';
|
|
10
|
+
|
|
11
|
+
beforeAll(() => { suppressAllLogs(true); });
|
|
12
|
+
|
|
13
|
+
describe('GoogleMapsSkill', () => {
|
|
14
|
+
it('should instantiate via constructor and factory', () => {
|
|
15
|
+
expect(new GoogleMapsSkill()).toBeInstanceOf(SkillBase);
|
|
16
|
+
expect(createGoogleMapsSkill()).toBeInstanceOf(GoogleMapsSkill);
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('should return false during setup when GOOGLE_MAPS_API_KEY is missing', async () => {
|
|
20
|
+
delete process.env['GOOGLE_MAPS_API_KEY'];
|
|
21
|
+
await expect(new GoogleMapsSkill().setup()).resolves.toBe(false);
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it('should return true during setup when GOOGLE_MAPS_API_KEY is set', async () => {
|
|
25
|
+
process.env['GOOGLE_MAPS_API_KEY'] = 'test-key';
|
|
26
|
+
try {
|
|
27
|
+
await expect(new GoogleMapsSkill().setup()).resolves.toBe(true);
|
|
28
|
+
} finally {
|
|
29
|
+
delete process.env['GOOGLE_MAPS_API_KEY'];
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it('should register tools', () => {
|
|
34
|
+
const tools = new GoogleMapsSkill().getTools();
|
|
35
|
+
expect(tools.length).toBeGreaterThan(0);
|
|
36
|
+
expect(tools[0].handler).toBeTypeOf('function');
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('should provide prompt sections', () => {
|
|
40
|
+
const sections = new GoogleMapsSkill().getPromptSections();
|
|
41
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
45
|
+
expect(new GoogleMapsSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it('should return maps-related hints and empty global data', () => {
|
|
49
|
+
const skill = new GoogleMapsSkill();
|
|
50
|
+
expect(skill.getHints()).toEqual([
|
|
51
|
+
'address',
|
|
52
|
+
'location',
|
|
53
|
+
'route',
|
|
54
|
+
'directions',
|
|
55
|
+
'miles',
|
|
56
|
+
'distance',
|
|
57
|
+
]);
|
|
58
|
+
expect(skill.getGlobalData()).toEqual({});
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
it('should return correct manifest with required env vars', () => {
|
|
62
|
+
const klass = GoogleMapsSkill as typeof SkillBase;
|
|
63
|
+
expect(klass.SKILL_NAME).toBe('google_maps');
|
|
64
|
+
expect(klass.REQUIRED_ENV_VARS).toContain('GOOGLE_MAPS_API_KEY');
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it('should return error when origin is missing', async () => {
|
|
68
|
+
delete process.env['GOOGLE_MAPS_API_KEY'];
|
|
69
|
+
const handler = new GoogleMapsSkill().getTools()[0].handler;
|
|
70
|
+
const result = await handler({}, {}) as FunctionResult;
|
|
71
|
+
expect(result.response).toBeTruthy();
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it('should have a parameter schema', () => {
|
|
75
|
+
const schema = GoogleMapsSkill.getParameterSchema();
|
|
76
|
+
expect(schema['api_key']).toBeDefined();
|
|
77
|
+
});
|
|
78
|
+
});
|