@signalwire/sdk 2.0.1 → 2.0.2
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/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -1,304 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Wikipedia Search Skill - Searches Wikipedia for article summaries.
|
|
3
|
-
*
|
|
4
|
-
* Tier 3 built-in skill: no external API key required. Uses the Wikipedia
|
|
5
|
-
* REST API to fetch article summaries and extracts for any given topic.
|
|
6
|
-
* Matches the Python SDK's `num_results` / `no_results_message` parity.
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { SkillBase } from '../SkillBase.js';
|
|
10
|
-
import type {
|
|
11
|
-
SkillToolDefinition,
|
|
12
|
-
SkillPromptSection,
|
|
13
|
-
SkillConfig,
|
|
14
|
-
ParameterSchemaEntry,
|
|
15
|
-
} from '../SkillBase.js';
|
|
16
|
-
import { FunctionResult } from '../../FunctionResult.js';
|
|
17
|
-
import { getLogger } from '../../Logger.js';
|
|
18
|
-
|
|
19
|
-
const log = getLogger('WikipediaSearchSkill');
|
|
20
|
-
|
|
21
|
-
const DEFAULT_NO_RESULTS_MESSAGE =
|
|
22
|
-
"I couldn't find any Wikipedia articles for '{query}'. " +
|
|
23
|
-
'Try rephrasing your search or using different keywords.';
|
|
24
|
-
|
|
25
|
-
/** Response shape from the Wikipedia action=query search API. */
|
|
26
|
-
interface WikipediaActionSearchResponse {
|
|
27
|
-
query?: {
|
|
28
|
-
search?: Array<{
|
|
29
|
-
title: string;
|
|
30
|
-
pageid?: number;
|
|
31
|
-
snippet?: string;
|
|
32
|
-
}>;
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/** Response shape from the Wikipedia action=query extracts API. */
|
|
37
|
-
interface WikipediaActionExtractsResponse {
|
|
38
|
-
query?: {
|
|
39
|
-
pages?: Record<string, { title?: string; extract?: string }>;
|
|
40
|
-
};
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Searches Wikipedia for article summaries and extracts.
|
|
45
|
-
*
|
|
46
|
-
* Tier 3 built-in skill with no external API key required. The configured
|
|
47
|
-
* `num_results` drives how many articles are aggregated; `no_results_message`
|
|
48
|
-
* customizes the fallback text (supports `{query}` interpolation).
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* ```ts
|
|
52
|
-
* agent.addSkill('wikipedia_search', { num_results: 2 });
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
export class WikipediaSearchSkill extends SkillBase {
|
|
56
|
-
// Python ground truth: skills/wikipedia_search/skill.py:26-31
|
|
57
|
-
// REQUIRED_PACKAGES = ["requests"] in Python; TS uses native fetch so [].
|
|
58
|
-
static override SKILL_NAME = 'wikipedia_search';
|
|
59
|
-
static override SKILL_DESCRIPTION =
|
|
60
|
-
'Search Wikipedia for information about a topic and get article summaries';
|
|
61
|
-
static override SKILL_VERSION = '1.0.0';
|
|
62
|
-
static override REQUIRED_PACKAGES: readonly string[] = [];
|
|
63
|
-
static override REQUIRED_ENV_VARS: readonly string[] = [];
|
|
64
|
-
// Python: SUPPORTS_MULTIPLE_INSTANCES = False (inherits default).
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* Resolved `num_results` value (populated in `setup()`).
|
|
68
|
-
* Public to mirror Python's `self.num_results` — accessible to subclasses
|
|
69
|
-
* and external test code inspecting skill state.
|
|
70
|
-
*/
|
|
71
|
-
public numResults: number = 1;
|
|
72
|
-
/**
|
|
73
|
-
* Resolved `no_results_message` template (populated in `setup()`).
|
|
74
|
-
* Protected to mirror Python's `self.no_results_message` public visibility
|
|
75
|
-
* within the class hierarchy.
|
|
76
|
-
*/
|
|
77
|
-
protected noResultsMessage: string = DEFAULT_NO_RESULTS_MESSAGE;
|
|
78
|
-
|
|
79
|
-
static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
|
|
80
|
-
return {
|
|
81
|
-
...super.getParameterSchema(),
|
|
82
|
-
num_results: {
|
|
83
|
-
type: 'integer',
|
|
84
|
-
description: 'Maximum number of Wikipedia articles to return',
|
|
85
|
-
default: 1,
|
|
86
|
-
min: 1,
|
|
87
|
-
max: 5,
|
|
88
|
-
},
|
|
89
|
-
no_results_message: {
|
|
90
|
-
type: 'string',
|
|
91
|
-
description: 'Custom message when no Wikipedia articles are found',
|
|
92
|
-
default: DEFAULT_NO_RESULTS_MESSAGE,
|
|
93
|
-
},
|
|
94
|
-
};
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* Extract config values into instance state. Enforces `num_results >= 1`
|
|
99
|
-
* (matching Python `skill.py:_setup` `max(1, ...)` floor). The schema's
|
|
100
|
-
* `max: 5` handles the upper bound at validation time — no runtime clamp
|
|
101
|
-
* here, so callers passing larger values get the raw value as in Python.
|
|
102
|
-
*/
|
|
103
|
-
override async setup(): Promise<boolean> {
|
|
104
|
-
// Match Python setup() which validates required packages and returns false
|
|
105
|
-
// on missing. Node's native fetch needs no packages here, so this is a
|
|
106
|
-
// no-op unless a subclass declares requiredPackages.
|
|
107
|
-
if (!(await this.hasAllPackages())) return false;
|
|
108
|
-
|
|
109
|
-
const configured = this.getConfig<number>('num_results', 1);
|
|
110
|
-
this.numResults = Math.max(1, Math.floor(configured));
|
|
111
|
-
|
|
112
|
-
const rawMessage = this.getConfig<string | undefined>(
|
|
113
|
-
'no_results_message',
|
|
114
|
-
undefined,
|
|
115
|
-
);
|
|
116
|
-
this.noResultsMessage =
|
|
117
|
-
rawMessage && rawMessage.length > 0 ? rawMessage : DEFAULT_NO_RESULTS_MESSAGE;
|
|
118
|
-
return true;
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
/** @returns A `search_wiki` tool that fetches article summaries from Wikipedia. */
|
|
122
|
-
getTools(): SkillToolDefinition[] {
|
|
123
|
-
return [
|
|
124
|
-
{
|
|
125
|
-
name: 'search_wiki',
|
|
126
|
-
description:
|
|
127
|
-
'Search Wikipedia for information about a topic and get article summaries',
|
|
128
|
-
parameters: {
|
|
129
|
-
query: {
|
|
130
|
-
type: 'string',
|
|
131
|
-
description:
|
|
132
|
-
'The search term or topic to look up on Wikipedia.',
|
|
133
|
-
},
|
|
134
|
-
},
|
|
135
|
-
required: ['query'],
|
|
136
|
-
handler: async (args: Record<string, unknown>, _rawData: Record<string, unknown>) => {
|
|
137
|
-
const rawQuery = args['query'];
|
|
138
|
-
|
|
139
|
-
if (
|
|
140
|
-
!rawQuery ||
|
|
141
|
-
typeof rawQuery !== 'string' ||
|
|
142
|
-
rawQuery.trim().length === 0
|
|
143
|
-
) {
|
|
144
|
-
return new FunctionResult(
|
|
145
|
-
'Please provide a search query for Wikipedia.',
|
|
146
|
-
);
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
const result = await this.searchWiki(rawQuery.trim());
|
|
150
|
-
return new FunctionResult(result);
|
|
151
|
-
},
|
|
152
|
-
},
|
|
153
|
-
];
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
/**
|
|
157
|
-
* Search Wikipedia and return a formatted text summary.
|
|
158
|
-
*
|
|
159
|
-
* Mirrors the Python `search_wiki()` public entry point so the logic can be
|
|
160
|
-
* tested and reused outside the SWAIG handler. Uses `num_results` to decide
|
|
161
|
-
* how many articles to aggregate.
|
|
162
|
-
*
|
|
163
|
-
* @param query - Plain-text search term.
|
|
164
|
-
* @returns Formatted text ready for display to the caller.
|
|
165
|
-
*/
|
|
166
|
-
async searchWiki(query: string): Promise<string> {
|
|
167
|
-
const trimmedQuery = query.trim();
|
|
168
|
-
if (trimmedQuery.length === 0) {
|
|
169
|
-
return this._formatNoResults(trimmedQuery);
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
try {
|
|
173
|
-
const baseUrl = 'https://en.wikipedia.org/w/api.php';
|
|
174
|
-
const searchUrl =
|
|
175
|
-
`${baseUrl}?action=query&list=search&format=json` +
|
|
176
|
-
`&srsearch=${encodeURIComponent(trimmedQuery)}` +
|
|
177
|
-
`&srlimit=${this.numResults}`;
|
|
178
|
-
|
|
179
|
-
const searchData = await this._fetchJson<WikipediaActionSearchResponse>(
|
|
180
|
-
searchUrl,
|
|
181
|
-
);
|
|
182
|
-
if (!searchData) {
|
|
183
|
-
return 'Wikipedia search could not be completed. Please try a different search term.';
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
const searchResults = searchData.query?.search ?? [];
|
|
187
|
-
if (searchResults.length === 0) {
|
|
188
|
-
return this._formatNoResults(trimmedQuery);
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
const articles: string[] = [];
|
|
192
|
-
|
|
193
|
-
for (const result of searchResults.slice(0, this.numResults)) {
|
|
194
|
-
const title = result.title;
|
|
195
|
-
const extractUrl =
|
|
196
|
-
`${baseUrl}?action=query&prop=extracts&exintro&explaintext&format=json` +
|
|
197
|
-
`&titles=${encodeURIComponent(title)}`;
|
|
198
|
-
|
|
199
|
-
const extractData = await this._fetchJson<WikipediaActionExtractsResponse>(
|
|
200
|
-
extractUrl,
|
|
201
|
-
);
|
|
202
|
-
const pages = extractData?.query?.pages ?? {};
|
|
203
|
-
const firstPage = Object.values(pages)[0];
|
|
204
|
-
const extract = (firstPage?.extract ?? '').trim();
|
|
205
|
-
|
|
206
|
-
if (extract.length > 0) {
|
|
207
|
-
articles.push(`**${title}**\n\n${extract}`);
|
|
208
|
-
} else {
|
|
209
|
-
articles.push(`**${title}**\n\nNo summary available for this article.`);
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
if (articles.length === 0) {
|
|
214
|
-
return this._formatNoResults(trimmedQuery);
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
if (articles.length === 1) {
|
|
218
|
-
return articles[0];
|
|
219
|
-
}
|
|
220
|
-
const separator = '\n\n' + '='.repeat(50) + '\n\n';
|
|
221
|
-
return articles.join(separator);
|
|
222
|
-
} catch (err) {
|
|
223
|
-
const message = err instanceof Error ? err.message : String(err);
|
|
224
|
-
// Python raises RequestException for network errors and Exception for
|
|
225
|
-
// the rest, so it emits two distinct user-facing strings (skill.py:85,91).
|
|
226
|
-
// Mirror that split: AbortError / fetch-layer errors → "accessing",
|
|
227
|
-
// everything else → "searching".
|
|
228
|
-
if (
|
|
229
|
-
err instanceof Error &&
|
|
230
|
-
(err.name === 'AbortError' ||
|
|
231
|
-
err.name === 'TypeError' /* fetch network failures */ ||
|
|
232
|
-
err.message.includes('fetch'))
|
|
233
|
-
) {
|
|
234
|
-
log.error('wikipedia_access_failed', { error: message });
|
|
235
|
-
return `Error accessing Wikipedia: ${message}`;
|
|
236
|
-
}
|
|
237
|
-
log.error('wikipedia_search_failed', { error: message });
|
|
238
|
-
return `Error searching Wikipedia: ${message}`;
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
/**
|
|
243
|
-
* Fetch JSON with a 10-second timeout (matches Python `requests.get(..., timeout=10)`).
|
|
244
|
-
* Returns `null` on HTTP error or network failure, logging the cause so
|
|
245
|
-
* diagnostic signal isn't silently lost.
|
|
246
|
-
*/
|
|
247
|
-
private async _fetchJson<T>(url: string): Promise<T | null> {
|
|
248
|
-
const controller = new AbortController();
|
|
249
|
-
const timeout = setTimeout(() => controller.abort(), 10_000);
|
|
250
|
-
try {
|
|
251
|
-
const response = await fetch(url, {
|
|
252
|
-
headers: {
|
|
253
|
-
Accept: 'application/json',
|
|
254
|
-
'User-Agent': 'SignalWireAgentsSDK/1.0',
|
|
255
|
-
},
|
|
256
|
-
signal: controller.signal,
|
|
257
|
-
});
|
|
258
|
-
if (!response.ok) {
|
|
259
|
-
log.warn('wikipedia_fetch_http_error', { url, status: response.status });
|
|
260
|
-
return null;
|
|
261
|
-
}
|
|
262
|
-
return (await response.json()) as T;
|
|
263
|
-
} catch (err) {
|
|
264
|
-
log.warn('wikipedia_fetch_failed', {
|
|
265
|
-
url,
|
|
266
|
-
error: err instanceof Error ? err.message : String(err),
|
|
267
|
-
});
|
|
268
|
-
return null;
|
|
269
|
-
} finally {
|
|
270
|
-
clearTimeout(timeout);
|
|
271
|
-
}
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
/** Render the configured no-results message, substituting `{query}`. */
|
|
275
|
-
private _formatNoResults(query: string): string {
|
|
276
|
-
return this.noResultsMessage.includes('{query}')
|
|
277
|
-
? this.noResultsMessage.replace(/\{query\}/g, query)
|
|
278
|
-
: this.noResultsMessage;
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
/** @returns Prompt section describing Wikipedia search capabilities and usage guidance. */
|
|
282
|
-
protected override _getPromptSections(): SkillPromptSection[] {
|
|
283
|
-
return [
|
|
284
|
-
{
|
|
285
|
-
title: 'Wikipedia Search',
|
|
286
|
-
body: `You can search Wikipedia for factual information using search_wiki. This will return up to ${this.numResults} Wikipedia article summaries.`,
|
|
287
|
-
bullets: [
|
|
288
|
-
'Use search_wiki for factual, encyclopedic information',
|
|
289
|
-
'Great for answering questions about people, places, concepts, and history',
|
|
290
|
-
'Returns reliable, well-sourced information from Wikipedia articles',
|
|
291
|
-
],
|
|
292
|
-
},
|
|
293
|
-
];
|
|
294
|
-
}
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
* Factory function for creating WikipediaSearchSkill instances.
|
|
299
|
-
* @param config - Optional skill configuration.
|
|
300
|
-
* @returns A new WikipediaSearchSkill instance.
|
|
301
|
-
*/
|
|
302
|
-
export function createSkill(config?: SkillConfig): WikipediaSearchSkill {
|
|
303
|
-
return new WikipediaSearchSkill(config);
|
|
304
|
-
}
|
package/src/types.ts
DELETED
|
@@ -1,132 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared type definitions for SignalWire AI Agents SDK.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
/** Configuration options for constructing an AgentBase instance. */
|
|
6
|
-
export interface AgentOptions {
|
|
7
|
-
/** Display name of the agent, also used as default basic-auth username when credentials are auto-generated. */
|
|
8
|
-
name: string;
|
|
9
|
-
/** HTTP route path the agent listens on (defaults to "/"). */
|
|
10
|
-
route?: string;
|
|
11
|
-
/** Hostname to bind the HTTP server to (defaults to "0.0.0.0"). */
|
|
12
|
-
host?: string;
|
|
13
|
-
/** Port number for the HTTP server (defaults to env PORT or 3000). */
|
|
14
|
-
port?: number;
|
|
15
|
-
/** Explicit basic-auth credentials as [username, password]; auto-generated if omitted. */
|
|
16
|
-
basicAuth?: [string, string];
|
|
17
|
-
/** Whether to use POM-based prompt rendering (defaults to true). */
|
|
18
|
-
usePom?: boolean;
|
|
19
|
-
/** Session token expiry in seconds (defaults to 3600). */
|
|
20
|
-
tokenExpirySecs?: number;
|
|
21
|
-
/** Whether to automatically insert an "answer" verb in the SWML call flow (defaults to true). */
|
|
22
|
-
autoAnswer?: boolean;
|
|
23
|
-
/** Whether to record the call (defaults to false). */
|
|
24
|
-
recordCall?: boolean;
|
|
25
|
-
/** Recording format, e.g. "mp4" (defaults to "mp4"). */
|
|
26
|
-
recordFormat?: string;
|
|
27
|
-
/** Whether to record in stereo (defaults to true). */
|
|
28
|
-
recordStereo?: boolean;
|
|
29
|
-
/** Default webhook URL for SWAIG function callbacks. */
|
|
30
|
-
defaultWebhookUrl?: string;
|
|
31
|
-
/** List of native function names to include in the SWAIG configuration. */
|
|
32
|
-
nativeFunctions?: string[];
|
|
33
|
-
/** Unique identifier for this agent instance; auto-generated if omitted. */
|
|
34
|
-
agentId?: string;
|
|
35
|
-
/** When true, suppresses all log output. */
|
|
36
|
-
suppressLogs?: boolean;
|
|
37
|
-
/**
|
|
38
|
-
* Path to a JSON Schema file for SWML validation.
|
|
39
|
-
* When provided, rendered SWML documents are validated against this schema.
|
|
40
|
-
* Falls back to the built-in schema if omitted.
|
|
41
|
-
*/
|
|
42
|
-
schemaPath?: string;
|
|
43
|
-
/**
|
|
44
|
-
* Whether to enable the post-prompt override endpoint.
|
|
45
|
-
* When true, a `/post_prompt_override` route is registered that allows
|
|
46
|
-
* external callers to replace the post-prompt text at runtime.
|
|
47
|
-
* Defaults to false.
|
|
48
|
-
*/
|
|
49
|
-
enablePostPromptOverride?: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* Whether to enable the check-for-input override endpoint.
|
|
52
|
-
* When true, a `/check_for_input` route is registered that allows
|
|
53
|
-
* external callers to inject input checks at runtime.
|
|
54
|
-
* Defaults to false.
|
|
55
|
-
*/
|
|
56
|
-
checkForInputOverride?: boolean;
|
|
57
|
-
/**
|
|
58
|
-
* Path to a JSON configuration file.
|
|
59
|
-
* When provided, the file is loaded at construction time and its
|
|
60
|
-
* `service` section can override name, route, host, and port
|
|
61
|
-
* (constructor arguments still take precedence over file values).
|
|
62
|
-
*/
|
|
63
|
-
configFile?: string;
|
|
64
|
-
/**
|
|
65
|
-
* Whether to validate rendered SWML against the schema.
|
|
66
|
-
* Can also be disabled via the `SWML_SKIP_SCHEMA_VALIDATION` env var.
|
|
67
|
-
* Defaults to true.
|
|
68
|
-
*/
|
|
69
|
-
schemaValidation?: boolean;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
/** Configuration for a supported language in the AI agent. */
|
|
73
|
-
export interface LanguageConfig {
|
|
74
|
-
/** Human-readable language name (e.g. "English"). */
|
|
75
|
-
name: string;
|
|
76
|
-
/** BCP-47 language code (e.g. "en-US"). */
|
|
77
|
-
code: string;
|
|
78
|
-
/** Voice identifier to use for this language. */
|
|
79
|
-
voice?: string;
|
|
80
|
-
/** TTS engine identifier. */
|
|
81
|
-
engine?: string;
|
|
82
|
-
/** Filler phrases keyed by category for this language. */
|
|
83
|
-
fillers?: Record<string, string[]>;
|
|
84
|
-
/** Speech recognition model identifier. */
|
|
85
|
-
speechModel?: string;
|
|
86
|
-
/** Per-function filler phrases, keyed by function name then language code. */
|
|
87
|
-
functionFillers?: Record<string, Record<string, string[]>>;
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/** Rule for overriding how the TTS engine pronounces a specific word or phrase. */
|
|
91
|
-
export interface PronunciationRule {
|
|
92
|
-
/** The text pattern to match. */
|
|
93
|
-
replace: string;
|
|
94
|
-
/** The replacement pronunciation. */
|
|
95
|
-
with: string;
|
|
96
|
-
/** Whether the match should be case-insensitive. */
|
|
97
|
-
ignoreCase?: boolean;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
/** Reference to an external SWAIG function endpoint to include in the AI configuration. */
|
|
101
|
-
export interface FunctionInclude {
|
|
102
|
-
/** URL of the remote SWAIG endpoint. */
|
|
103
|
-
url: string;
|
|
104
|
-
/** List of function names available at the remote endpoint. */
|
|
105
|
-
functions: string[];
|
|
106
|
-
/** Optional metadata to pass along with the include. */
|
|
107
|
-
meta_data?: Record<string, unknown>;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Callback invoked on each SWML request to dynamically modify an ephemeral copy of the agent.
|
|
112
|
-
* @param queryParams - URL query parameters from the incoming request.
|
|
113
|
-
* @param bodyParams - Parsed JSON body of the incoming request.
|
|
114
|
-
* @param headers - HTTP headers from the incoming request.
|
|
115
|
-
* @param agent - Ephemeral AgentBase copy that can be mutated without affecting the original.
|
|
116
|
-
*/
|
|
117
|
-
export type DynamicConfigCallback = (
|
|
118
|
-
queryParams: Record<string, string>,
|
|
119
|
-
bodyParams: Record<string, unknown>,
|
|
120
|
-
headers: Record<string, string>,
|
|
121
|
-
agent: unknown,
|
|
122
|
-
) => void | Promise<void>;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Callback invoked when a post-prompt summary is received at the end of a call.
|
|
126
|
-
* @param summary - Parsed summary object, or null if extraction failed.
|
|
127
|
-
* @param rawData - The full raw post-prompt payload.
|
|
128
|
-
*/
|
|
129
|
-
export type SummaryCallback = (
|
|
130
|
-
summary: Record<string, unknown> | null,
|
|
131
|
-
rawData: Record<string, unknown>,
|
|
132
|
-
) => void | Promise<void>;
|