@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,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the WebSearch skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { WebSearchSkill, createWebSearchSkill } 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('WebSearchSkill', () => {
|
|
14
|
+
it('should instantiate via constructor and factory', () => {
|
|
15
|
+
expect(new WebSearchSkill()).toBeInstanceOf(SkillBase);
|
|
16
|
+
expect(createWebSearchSkill()).toBeInstanceOf(WebSearchSkill);
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('should return false from setup() when credentials are missing', async () => {
|
|
20
|
+
delete process.env['GOOGLE_SEARCH_API_KEY'];
|
|
21
|
+
delete process.env['GOOGLE_SEARCH_ENGINE_ID'];
|
|
22
|
+
delete process.env['GOOGLE_SEARCH_CX'];
|
|
23
|
+
await expect(new WebSearchSkill().setup()).resolves.toBe(false);
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('should return true from setup() when credentials are provided via config', async () => {
|
|
27
|
+
const skill = new WebSearchSkill({ api_key: 'test-key', search_engine_id: 'test-cx' });
|
|
28
|
+
await expect(skill.setup()).resolves.toBe(true);
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it('should register a web_search tool', () => {
|
|
32
|
+
const tools = new WebSearchSkill().getTools();
|
|
33
|
+
expect(tools).toHaveLength(1);
|
|
34
|
+
expect(tools[0].name).toBe('web_search');
|
|
35
|
+
expect(tools[0].required).toContain('query');
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('should provide prompt sections', () => {
|
|
39
|
+
const sections = new WebSearchSkill().getPromptSections();
|
|
40
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
41
|
+
expect(sections[0].title).toContain('Web Search');
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
45
|
+
expect(new WebSearchSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it('should return empty hints', () => {
|
|
49
|
+
const skill = new WebSearchSkill();
|
|
50
|
+
expect(skill.getHints()).toEqual([]);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('should expose web search metadata via global data', () => {
|
|
54
|
+
const globalData = new WebSearchSkill().getGlobalData();
|
|
55
|
+
expect(globalData['web_search_enabled']).toBe(true);
|
|
56
|
+
expect(globalData['search_provider']).toBe('Google Custom Search');
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('should return correct manifest with required env vars', () => {
|
|
60
|
+
const klass = WebSearchSkill as typeof SkillBase;
|
|
61
|
+
expect(klass.SKILL_NAME).toBe('web_search');
|
|
62
|
+
expect(klass.SKILL_VERSION).toBe('2.0.0');
|
|
63
|
+
// Python REQUIRED_ENV_VARS = []: credentials come from either config
|
|
64
|
+
// params or env vars, so the manifest's env-var requirement is empty.
|
|
65
|
+
expect(klass.REQUIRED_ENV_VARS).toEqual([]);
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it('should return error when API keys are missing', async () => {
|
|
69
|
+
delete process.env['GOOGLE_SEARCH_API_KEY'];
|
|
70
|
+
delete process.env['GOOGLE_SEARCH_ENGINE_ID'];
|
|
71
|
+
delete process.env['GOOGLE_SEARCH_CX'];
|
|
72
|
+
const handler = new WebSearchSkill().getTools()[0].handler;
|
|
73
|
+
const result = await handler({ query: 'test' }, {}) as FunctionResult;
|
|
74
|
+
expect(result.response).toContain('not configured');
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it('should reject empty query', async () => {
|
|
78
|
+
const handler = new WebSearchSkill().getTools()[0].handler;
|
|
79
|
+
const result = await handler({ query: '' }, {}) as FunctionResult;
|
|
80
|
+
expect(result.response).toContain('provide a search query');
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
it('should support multiple instances', () => {
|
|
84
|
+
expect(WebSearchSkill.SUPPORTS_MULTIPLE_INSTANCES).toBe(true);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it('should compute instance key from search_engine_id and tool_name', () => {
|
|
88
|
+
const skill = new WebSearchSkill({ search_engine_id: 'cx-1', tool_name: 'custom' });
|
|
89
|
+
expect(skill.getInstanceKey()).toBe('web_search_cx-1_custom');
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('should have a parameter schema', () => {
|
|
93
|
+
const schema = WebSearchSkill.getParameterSchema();
|
|
94
|
+
expect(schema['num_results']).toBeDefined();
|
|
95
|
+
expect(schema['tool_name']).toBeDefined();
|
|
96
|
+
expect(schema['no_results_message']).toBeDefined();
|
|
97
|
+
expect(schema['safe_search']).toBeDefined();
|
|
98
|
+
expect(schema['delay']).toBeDefined();
|
|
99
|
+
expect(schema['max_content_length']).toBeDefined();
|
|
100
|
+
expect(schema['oversample_factor']).toBeDefined();
|
|
101
|
+
expect(schema['min_quality_score']).toBeDefined();
|
|
102
|
+
});
|
|
103
|
+
});
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Individual tests for the WikipediaSearch skill.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, beforeAll } from 'vitest';
|
|
6
|
+
import { WikipediaSearchSkill, createWikipediaSearchSkill } 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('WikipediaSearchSkill', () => {
|
|
14
|
+
it('should instantiate via constructor and factory', () => {
|
|
15
|
+
expect(new WikipediaSearchSkill()).toBeInstanceOf(SkillBase);
|
|
16
|
+
expect(createWikipediaSearchSkill()).toBeInstanceOf(WikipediaSearchSkill);
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('should complete setup without errors', async () => {
|
|
20
|
+
await expect(new WikipediaSearchSkill().setup()).resolves.toBe(true);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should register a search_wiki tool', () => {
|
|
24
|
+
const tools = new WikipediaSearchSkill().getTools();
|
|
25
|
+
expect(tools).toHaveLength(1);
|
|
26
|
+
expect(tools[0].name).toBe('search_wiki');
|
|
27
|
+
expect(tools[0].required).toContain('query');
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it('should provide prompt sections', () => {
|
|
31
|
+
const sections = new WikipediaSearchSkill().getPromptSections();
|
|
32
|
+
expect(sections.length).toBeGreaterThan(0);
|
|
33
|
+
expect(sections[0].title).toBe('Wikipedia Search');
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
it('should skip prompt sections when skip_prompt is set', () => {
|
|
37
|
+
expect(new WikipediaSearchSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
it('should return empty hints and global data', () => {
|
|
41
|
+
const skill = new WikipediaSearchSkill();
|
|
42
|
+
expect(skill.getHints()).toEqual([]);
|
|
43
|
+
expect(skill.getGlobalData()).toEqual({});
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
it('should return correct manifest', () => {
|
|
47
|
+
const klass = WikipediaSearchSkill as typeof SkillBase;
|
|
48
|
+
expect(klass.SKILL_NAME).toBe('wikipedia_search');
|
|
49
|
+
expect(klass.SKILL_VERSION).toBe('1.0.0');
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('should reject empty query', async () => {
|
|
53
|
+
const handler = new WikipediaSearchSkill().getTools()[0].handler;
|
|
54
|
+
const result = await handler({ query: '' }, {}) as FunctionResult;
|
|
55
|
+
expect(result.response).toContain('provide a search query');
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it('should have a parameter schema', () => {
|
|
59
|
+
const schema = WikipediaSearchSkill.getParameterSchema();
|
|
60
|
+
expect(schema['num_results']).toBeDefined();
|
|
61
|
+
expect(schema['no_results_message']).toBeDefined();
|
|
62
|
+
});
|
|
63
|
+
});
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"module": "ESNext",
|
|
5
|
+
"moduleResolution": "bundler",
|
|
6
|
+
"strict": true,
|
|
7
|
+
"declaration": true,
|
|
8
|
+
"outDir": "dist",
|
|
9
|
+
"rootDir": "src",
|
|
10
|
+
"esModuleInterop": true,
|
|
11
|
+
"skipLibCheck": true,
|
|
12
|
+
"forceConsistentCasingInFileNames": true,
|
|
13
|
+
"resolveJsonModule": true,
|
|
14
|
+
"sourceMap": true
|
|
15
|
+
},
|
|
16
|
+
"include": ["src/**/*"],
|
|
17
|
+
"exclude": ["node_modules", "dist", "tests"]
|
|
18
|
+
}
|