@signalwire/sdk 2.0.1 → 2.0.3
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 +1026 -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
package/docs/web_service.md
DELETED
|
@@ -1,677 +0,0 @@
|
|
|
1
|
-
# WebService Documentation
|
|
2
|
-
|
|
3
|
-
The `WebService` class provides static file serving capabilities for the SignalWire AI Agents SDK. It follows the same architectural pattern as `SearchService`, allowing it to run as a standalone service or alongside your AI agents.
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
- [Overview](#overview)
|
|
7
|
-
- [Installation](#installation)
|
|
8
|
-
- [Quick Start](#quick-start)
|
|
9
|
-
- [Configuration](#configuration)
|
|
10
|
-
- [Security Features](#security-features)
|
|
11
|
-
- [HTTPS/SSL Support](#httpsssl-support)
|
|
12
|
-
- [API Endpoints](#api-endpoints)
|
|
13
|
-
- [Usage Examples](#usage-examples)
|
|
14
|
-
- [Deployment Patterns](#deployment-patterns)
|
|
15
|
-
|
|
16
|
-
## Overview
|
|
17
|
-
|
|
18
|
-
WebService is designed to serve static files with configurable security features. It's perfect for:
|
|
19
|
-
- Serving agent documentation and API specs
|
|
20
|
-
- Hosting static assets (images, CSS, JavaScript)
|
|
21
|
-
- Serving generated reports and exports
|
|
22
|
-
- Providing configuration files and templates
|
|
23
|
-
- Hosting agent UI components
|
|
24
|
-
|
|
25
|
-
### Key Features
|
|
26
|
-
- **Multiple directory mounting** - Serve different directories at different URL paths
|
|
27
|
-
- **Security-first design** - Authentication, CORS, security headers, file filtering
|
|
28
|
-
- **HTTPS support** - Full SSL/TLS support with PEM files
|
|
29
|
-
- **Directory browsing** - Optional HTML directory listings
|
|
30
|
-
- **MIME type handling** - Automatic content-type detection
|
|
31
|
-
- **Path traversal protection** - Prevents access outside designated directories
|
|
32
|
-
- **File filtering** - Allow/block specific file extensions
|
|
33
|
-
|
|
34
|
-
## Installation
|
|
35
|
-
|
|
36
|
-
WebService is included in the core SignalWire AI Agents SDK:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
pip install @signalwire/sdk
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Quick Start
|
|
43
|
-
|
|
44
|
-
```python
|
|
45
|
-
from signalwire_agents import WebService
|
|
46
|
-
|
|
47
|
-
# Create a service to serve files
|
|
48
|
-
service = WebService(
|
|
49
|
-
port=8002,
|
|
50
|
-
directories={
|
|
51
|
-
"/docs": "./documentation",
|
|
52
|
-
"/assets": "./static/assets"
|
|
53
|
-
}
|
|
54
|
-
)
|
|
55
|
-
|
|
56
|
-
# Start the service
|
|
57
|
-
service.start()
|
|
58
|
-
# Service available at http://localhost:8002
|
|
59
|
-
# Basic Auth: dev:w00t (auto-generated)
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## Configuration
|
|
63
|
-
|
|
64
|
-
WebService can be configured through multiple methods (in order of priority):
|
|
65
|
-
|
|
66
|
-
### 1. Constructor Parameters
|
|
67
|
-
|
|
68
|
-
```python
|
|
69
|
-
service = WebService(
|
|
70
|
-
port=8002, # Port to bind to
|
|
71
|
-
directories={ # URL path to directory mappings
|
|
72
|
-
"/docs": "./documentation",
|
|
73
|
-
"/assets": "./static"
|
|
74
|
-
},
|
|
75
|
-
basic_auth=("admin", "secret"), # Custom authentication
|
|
76
|
-
enable_directory_browsing=True, # Allow directory listings
|
|
77
|
-
allowed_extensions=['.html', '.css', '.js'], # Whitelist extensions
|
|
78
|
-
blocked_extensions=['.env', '.key'], # Blacklist extensions
|
|
79
|
-
max_file_size=100 * 1024 * 1024, # Max file size (100MB)
|
|
80
|
-
enable_cors=True # Enable CORS headers
|
|
81
|
-
)
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### 2. Environment Variables
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
# Basic authentication
|
|
88
|
-
export SWML_BASIC_AUTH_USER="admin"
|
|
89
|
-
export SWML_BASIC_AUTH_PASS="secretpassword"
|
|
90
|
-
|
|
91
|
-
# SSL/HTTPS configuration
|
|
92
|
-
export SWML_SSL_ENABLED=true
|
|
93
|
-
export SWML_SSL_CERT="/path/to/cert.pem"
|
|
94
|
-
export SWML_SSL_KEY="/path/to/key.pem"
|
|
95
|
-
|
|
96
|
-
# Security settings
|
|
97
|
-
export SWML_ALLOWED_HOSTS="example.com,*.example.com"
|
|
98
|
-
export SWML_CORS_ORIGINS="https://app.example.com"
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
### 3. Configuration File
|
|
102
|
-
|
|
103
|
-
Create a `web.json` or `swml_web.json` file:
|
|
104
|
-
|
|
105
|
-
```json
|
|
106
|
-
{
|
|
107
|
-
"service": {
|
|
108
|
-
"port": 8002,
|
|
109
|
-
"directories": {
|
|
110
|
-
"/docs": "./documentation",
|
|
111
|
-
"/api": "./api-specs",
|
|
112
|
-
"/reports": "./generated/reports"
|
|
113
|
-
},
|
|
114
|
-
"enable_directory_browsing": true,
|
|
115
|
-
"max_file_size": 52428800,
|
|
116
|
-
"allowed_extensions": [".html", ".css", ".js", ".json", ".pdf"],
|
|
117
|
-
"blocked_extensions": [".env", ".key", ".pem"]
|
|
118
|
-
},
|
|
119
|
-
"security": {
|
|
120
|
-
"basic_auth": {
|
|
121
|
-
"username": "admin",
|
|
122
|
-
"password": "secure123"
|
|
123
|
-
},
|
|
124
|
-
"ssl_enabled": true,
|
|
125
|
-
"ssl_cert": "/etc/ssl/certs/server.crt",
|
|
126
|
-
"ssl_key": "/etc/ssl/private/server.key",
|
|
127
|
-
"allowed_hosts": ["*"],
|
|
128
|
-
"cors_origins": ["*"]
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
## Security Features
|
|
134
|
-
|
|
135
|
-
### Basic Authentication
|
|
136
|
-
|
|
137
|
-
WebService implements HTTP Basic Authentication. Credentials can be set via:
|
|
138
|
-
|
|
139
|
-
1. **Constructor**: `basic_auth=("username", "password")`
|
|
140
|
-
2. **Environment**: `SWML_BASIC_AUTH_USER` and `SWML_BASIC_AUTH_PASS`
|
|
141
|
-
3. **Config file**: `security.basic_auth` section
|
|
142
|
-
4. **Auto-generated**: If not specified, generates random credentials
|
|
143
|
-
|
|
144
|
-
### File Security
|
|
145
|
-
|
|
146
|
-
#### Default Blocked Extensions/Files
|
|
147
|
-
- `.env`, `.git`, `.gitignore`
|
|
148
|
-
- `.key`, `.pem`, `.crt`
|
|
149
|
-
- `.pyc`, `__pycache__`
|
|
150
|
-
- `.DS_Store`, `.swp`
|
|
151
|
-
|
|
152
|
-
#### Path Traversal Protection
|
|
153
|
-
WebService prevents access outside designated directories:
|
|
154
|
-
```python
|
|
155
|
-
# These attempts will be blocked:
|
|
156
|
-
# GET /docs/../../../etc/passwd
|
|
157
|
-
# GET /docs/./././../config.json
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
#### File Size Limits
|
|
161
|
-
Default maximum file size is 100MB. Configure with:
|
|
162
|
-
```python
|
|
163
|
-
service = WebService(max_file_size=50 * 1024 * 1024) # 50MB
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### Security Headers
|
|
167
|
-
|
|
168
|
-
Automatically adds security headers to all responses:
|
|
169
|
-
- `X-Content-Type-Options: nosniff`
|
|
170
|
-
- `X-Frame-Options: DENY`
|
|
171
|
-
- `X-XSS-Protection: 1; mode=block`
|
|
172
|
-
- `Strict-Transport-Security` (when HTTPS is enabled)
|
|
173
|
-
|
|
174
|
-
## HTTPS/SSL Support
|
|
175
|
-
|
|
176
|
-
WebService provides multiple ways to enable HTTPS:
|
|
177
|
-
|
|
178
|
-
### Method 1: Environment Variables
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
# Using file paths
|
|
182
|
-
export SWML_SSL_CERT="/path/to/cert.pem"
|
|
183
|
-
export SWML_SSL_KEY="/path/to/key.pem"
|
|
184
|
-
|
|
185
|
-
# Or using inline PEM content
|
|
186
|
-
export SWML_SSL_CERT_INLINE="-----BEGIN CERTIFICATE-----
|
|
187
|
-
MIIDXTCCAkWgAwIBAgIJAKLdQVPy...
|
|
188
|
-
-----END CERTIFICATE-----"
|
|
189
|
-
export SWML_SSL_KEY_INLINE="-----BEGIN PRIVATE KEY-----
|
|
190
|
-
MIIEvQIBADANBgkqhkiG9w0BAQE...
|
|
191
|
-
-----END PRIVATE KEY-----"
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### Method 2: Direct Parameters
|
|
195
|
-
|
|
196
|
-
```python
|
|
197
|
-
service = WebService(directories={"/docs": "./docs"})
|
|
198
|
-
service.start(
|
|
199
|
-
ssl_cert="/path/to/cert.pem",
|
|
200
|
-
ssl_key="/path/to/key.pem"
|
|
201
|
-
)
|
|
202
|
-
# Service available at https://localhost:8002
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
### Method 3: Configuration File
|
|
206
|
-
|
|
207
|
-
```json
|
|
208
|
-
{
|
|
209
|
-
"security": {
|
|
210
|
-
"ssl_enabled": true,
|
|
211
|
-
"ssl_cert": "/etc/ssl/certs/server.crt",
|
|
212
|
-
"ssl_key": "/etc/ssl/private/server.key"
|
|
213
|
-
}
|
|
214
|
-
}
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
### Generating Self-Signed Certificates
|
|
218
|
-
|
|
219
|
-
For development/testing:
|
|
220
|
-
|
|
221
|
-
```bash
|
|
222
|
-
# Generate a self-signed certificate
|
|
223
|
-
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem \
|
|
224
|
-
-days 365 -nodes -subj "/CN=localhost"
|
|
225
|
-
|
|
226
|
-
# Use with WebService
|
|
227
|
-
export SWML_SSL_CERT="cert.pem"
|
|
228
|
-
export SWML_SSL_KEY="key.pem"
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
## API Endpoints
|
|
232
|
-
|
|
233
|
-
### GET /health
|
|
234
|
-
Health check endpoint (no authentication required)
|
|
235
|
-
|
|
236
|
-
**Response:**
|
|
237
|
-
```json
|
|
238
|
-
{
|
|
239
|
-
"status": "healthy",
|
|
240
|
-
"directories": ["/docs", "/assets"],
|
|
241
|
-
"ssl_enabled": false,
|
|
242
|
-
"auth_required": true,
|
|
243
|
-
"directory_browsing": true
|
|
244
|
-
}
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
### GET /
|
|
248
|
-
Root endpoint showing available directories
|
|
249
|
-
|
|
250
|
-
**Response:** HTML page listing all mounted directories
|
|
251
|
-
|
|
252
|
-
### GET /{route}/{file_path}
|
|
253
|
-
Serve files from mounted directories
|
|
254
|
-
|
|
255
|
-
**Parameters:**
|
|
256
|
-
- `route`: The mounted directory route (e.g., `/docs`)
|
|
257
|
-
- `file_path`: Path to file within the directory
|
|
258
|
-
|
|
259
|
-
**Response:**
|
|
260
|
-
- File content with appropriate MIME type
|
|
261
|
-
- 404 if file not found
|
|
262
|
-
- 403 if file type blocked or directory browsing disabled
|
|
263
|
-
|
|
264
|
-
## Usage Examples
|
|
265
|
-
|
|
266
|
-
### Basic File Serving
|
|
267
|
-
|
|
268
|
-
```python
|
|
269
|
-
from signalwire_agents import WebService
|
|
270
|
-
|
|
271
|
-
# Serve documentation
|
|
272
|
-
service = WebService(
|
|
273
|
-
directories={
|
|
274
|
-
"/docs": "./documentation",
|
|
275
|
-
"/api": "./api-specs"
|
|
276
|
-
}
|
|
277
|
-
)
|
|
278
|
-
service.start()
|
|
279
|
-
|
|
280
|
-
# Files accessible at:
|
|
281
|
-
# http://localhost:8002/docs/index.html
|
|
282
|
-
# http://localhost:8002/api/swagger.json
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
### With Directory Browsing
|
|
286
|
-
|
|
287
|
-
```python
|
|
288
|
-
service = WebService(
|
|
289
|
-
directories={"/files": "./public"},
|
|
290
|
-
enable_directory_browsing=True # Allow browsing directories
|
|
291
|
-
)
|
|
292
|
-
service.start()
|
|
293
|
-
|
|
294
|
-
# Browse files at: http://localhost:8002/files/
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
### Restricted File Types
|
|
298
|
-
|
|
299
|
-
```python
|
|
300
|
-
# Only serve web assets
|
|
301
|
-
service = WebService(
|
|
302
|
-
directories={"/web": "./www"},
|
|
303
|
-
allowed_extensions=['.html', '.css', '.js', '.png', '.jpg', '.woff2'],
|
|
304
|
-
enable_directory_browsing=False
|
|
305
|
-
)
|
|
306
|
-
```
|
|
307
|
-
|
|
308
|
-
### Dynamic Directory Management
|
|
309
|
-
|
|
310
|
-
```python
|
|
311
|
-
service = WebService()
|
|
312
|
-
|
|
313
|
-
# Add directories after initialization
|
|
314
|
-
service.add_directory("/docs", "./documentation")
|
|
315
|
-
service.add_directory("/reports", "./generated/reports")
|
|
316
|
-
|
|
317
|
-
# Remove a directory
|
|
318
|
-
service.remove_directory("/reports")
|
|
319
|
-
|
|
320
|
-
service.start()
|
|
321
|
-
```
|
|
322
|
-
|
|
323
|
-
### With Custom Authentication
|
|
324
|
-
|
|
325
|
-
```python
|
|
326
|
-
service = WebService(
|
|
327
|
-
directories={"/private": "./sensitive-docs"},
|
|
328
|
-
basic_auth=("admin", "super-secret-password")
|
|
329
|
-
)
|
|
330
|
-
service.start()
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
### HTTPS with Let's Encrypt
|
|
334
|
-
|
|
335
|
-
```python
|
|
336
|
-
# Assuming you have Let's Encrypt certificates
|
|
337
|
-
service = WebService(
|
|
338
|
-
directories={"/secure": "./secure-files"}
|
|
339
|
-
)
|
|
340
|
-
service.start(
|
|
341
|
-
ssl_cert="/etc/letsencrypt/live/example.com/fullchain.pem",
|
|
342
|
-
ssl_key="/etc/letsencrypt/live/example.com/privkey.pem"
|
|
343
|
-
)
|
|
344
|
-
# Service available at https://example.com:8002
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
### Multi-Environment Configuration
|
|
348
|
-
|
|
349
|
-
```python
|
|
350
|
-
import os
|
|
351
|
-
|
|
352
|
-
# Development vs Production
|
|
353
|
-
if os.getenv("ENVIRONMENT") == "production":
|
|
354
|
-
service = WebService(
|
|
355
|
-
port=443,
|
|
356
|
-
directories={"/": "./dist"},
|
|
357
|
-
enable_directory_browsing=False
|
|
358
|
-
)
|
|
359
|
-
service.start(
|
|
360
|
-
host="0.0.0.0",
|
|
361
|
-
ssl_cert="/etc/ssl/certs/production.crt",
|
|
362
|
-
ssl_key="/etc/ssl/private/production.key"
|
|
363
|
-
)
|
|
364
|
-
else:
|
|
365
|
-
service = WebService(
|
|
366
|
-
port=8002,
|
|
367
|
-
directories={"/": "./src"},
|
|
368
|
-
enable_directory_browsing=True
|
|
369
|
-
)
|
|
370
|
-
service.start()
|
|
371
|
-
```
|
|
372
|
-
|
|
373
|
-
## Deployment Patterns
|
|
374
|
-
|
|
375
|
-
### Standalone Service
|
|
376
|
-
|
|
377
|
-
Run WebService as a dedicated static file server:
|
|
378
|
-
|
|
379
|
-
```python
|
|
380
|
-
# web_server.py
|
|
381
|
-
from signalwire_agents import WebService
|
|
382
|
-
|
|
383
|
-
if __name__ == "__main__":
|
|
384
|
-
service = WebService(
|
|
385
|
-
port=8002,
|
|
386
|
-
directories={
|
|
387
|
-
"/docs": "/var/www/docs",
|
|
388
|
-
"/assets": "/var/www/assets",
|
|
389
|
-
"/downloads": "/var/www/downloads"
|
|
390
|
-
}
|
|
391
|
-
)
|
|
392
|
-
service.start()
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
### Alongside AI Agents
|
|
396
|
-
|
|
397
|
-
Run WebService alongside your AI agents on different ports:
|
|
398
|
-
|
|
399
|
-
```python
|
|
400
|
-
# main.py
|
|
401
|
-
from signalwire_agents import AgentBase, WebService
|
|
402
|
-
import threading
|
|
403
|
-
|
|
404
|
-
# Start WebService in background
|
|
405
|
-
def run_web_service():
|
|
406
|
-
web = WebService(
|
|
407
|
-
port=8002,
|
|
408
|
-
directories={"/docs": "./agent-docs"}
|
|
409
|
-
)
|
|
410
|
-
web.start()
|
|
411
|
-
|
|
412
|
-
# Start web service thread
|
|
413
|
-
web_thread = threading.Thread(target=run_web_service, daemon=True)
|
|
414
|
-
web_thread.start()
|
|
415
|
-
|
|
416
|
-
# Run your agent
|
|
417
|
-
class MyAgent(AgentBase):
|
|
418
|
-
def __init__(self):
|
|
419
|
-
super().__init__(name="My Agent")
|
|
420
|
-
|
|
421
|
-
agent = MyAgent()
|
|
422
|
-
agent.serve(port=3000) # Agent on port 3000, WebService on 8002
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
### Docker Deployment
|
|
426
|
-
|
|
427
|
-
```dockerfile
|
|
428
|
-
FROM python:3.9-slim
|
|
429
|
-
|
|
430
|
-
WORKDIR /app
|
|
431
|
-
|
|
432
|
-
# Install SDK
|
|
433
|
-
RUN pip install @signalwire/sdk
|
|
434
|
-
|
|
435
|
-
# Copy static files
|
|
436
|
-
COPY ./static /app/static
|
|
437
|
-
COPY ./web_config.json /app/web_config.json
|
|
438
|
-
|
|
439
|
-
# Expose port
|
|
440
|
-
EXPOSE 8002
|
|
441
|
-
|
|
442
|
-
# Run WebService
|
|
443
|
-
CMD ["python", "-c", "from signalwire_agents import WebService; WebService(config_file='web_config.json').start()"]
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
### Systemd Service
|
|
447
|
-
|
|
448
|
-
Create `/etc/systemd/system/signalwire-web.service`:
|
|
449
|
-
|
|
450
|
-
```ini
|
|
451
|
-
[Unit]
|
|
452
|
-
Description=SignalWire Web Service
|
|
453
|
-
After=network.target
|
|
454
|
-
|
|
455
|
-
[Service]
|
|
456
|
-
Type=simple
|
|
457
|
-
User=www-data
|
|
458
|
-
WorkingDirectory=/opt/signalwire
|
|
459
|
-
Environment="SWML_SSL_CERT=/etc/ssl/certs/server.crt"
|
|
460
|
-
Environment="SWML_SSL_KEY=/etc/ssl/private/server.key"
|
|
461
|
-
ExecStart=/usr/bin/python3 -c "from signalwire_agents import WebService; WebService(directories={'/': '/var/www/html'}).start()"
|
|
462
|
-
Restart=always
|
|
463
|
-
|
|
464
|
-
[Install]
|
|
465
|
-
WantedBy=multi-user.target
|
|
466
|
-
```
|
|
467
|
-
|
|
468
|
-
### Nginx Reverse Proxy
|
|
469
|
-
|
|
470
|
-
For production, use Nginx as a reverse proxy:
|
|
471
|
-
|
|
472
|
-
```nginx
|
|
473
|
-
server {
|
|
474
|
-
listen 80;
|
|
475
|
-
server_name static.example.com;
|
|
476
|
-
|
|
477
|
-
# Redirect to HTTPS
|
|
478
|
-
return 301 https://$server_name$request_uri;
|
|
479
|
-
}
|
|
480
|
-
|
|
481
|
-
server {
|
|
482
|
-
listen 443 ssl http2;
|
|
483
|
-
server_name static.example.com;
|
|
484
|
-
|
|
485
|
-
ssl_certificate /etc/ssl/certs/example.com.crt;
|
|
486
|
-
ssl_certificate_key /etc/ssl/private/example.com.key;
|
|
487
|
-
|
|
488
|
-
location / {
|
|
489
|
-
proxy_pass http://localhost:8002;
|
|
490
|
-
proxy_set_header Host $host;
|
|
491
|
-
proxy_set_header X-Real-IP $remote_addr;
|
|
492
|
-
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
493
|
-
proxy_set_header X-Forwarded-Proto $scheme;
|
|
494
|
-
|
|
495
|
-
# Cache static assets
|
|
496
|
-
location ~* \.(jpg|jpeg|png|gif|ico|css|js)$ {
|
|
497
|
-
proxy_pass http://localhost:8002;
|
|
498
|
-
expires 1h;
|
|
499
|
-
add_header Cache-Control "public, immutable";
|
|
500
|
-
}
|
|
501
|
-
}
|
|
502
|
-
}
|
|
503
|
-
```
|
|
504
|
-
|
|
505
|
-
## Best Practices
|
|
506
|
-
|
|
507
|
-
### Security
|
|
508
|
-
1. **Always use HTTPS in production** - Protect data in transit
|
|
509
|
-
2. **Change default credentials** - Never use auto-generated auth in production
|
|
510
|
-
3. **Restrict file types** - Use `allowed_extensions` to whitelist safe files
|
|
511
|
-
4. **Disable directory browsing** - Turn off in production environments
|
|
512
|
-
5. **Use reverse proxy** - Put Nginx/Apache in front for additional security
|
|
513
|
-
|
|
514
|
-
### Performance
|
|
515
|
-
1. **Set appropriate cache headers** - WebService adds 1-hour cache by default
|
|
516
|
-
2. **Limit file sizes** - Adjust `max_file_size` based on your needs
|
|
517
|
-
3. **Use CDN for static assets** - Offload traffic for better performance
|
|
518
|
-
4. **Compress large files** - Use gzip/brotli at reverse proxy level
|
|
519
|
-
|
|
520
|
-
### Organization
|
|
521
|
-
1. **Separate content types** - Use different routes for different file types
|
|
522
|
-
2. **Version your assets** - Include version in path (e.g., `/assets/v1/`)
|
|
523
|
-
3. **Use index.html** - Provide default files for directories
|
|
524
|
-
4. **Document your structure** - Maintain clear directory organization
|
|
525
|
-
|
|
526
|
-
## Troubleshooting
|
|
527
|
-
|
|
528
|
-
### Common Issues
|
|
529
|
-
|
|
530
|
-
**Issue: "FastAPI not available"**
|
|
531
|
-
```bash
|
|
532
|
-
# Install FastAPI and uvicorn
|
|
533
|
-
pip install fastapi uvicorn
|
|
534
|
-
```
|
|
535
|
-
|
|
536
|
-
**Issue: SSL certificate errors**
|
|
537
|
-
```python
|
|
538
|
-
# Check certificate paths
|
|
539
|
-
import os
|
|
540
|
-
print(os.path.exists("/path/to/cert.pem")) # Should be True
|
|
541
|
-
print(os.path.exists("/path/to/key.pem")) # Should be True
|
|
542
|
-
```
|
|
543
|
-
|
|
544
|
-
**Issue: Permission denied**
|
|
545
|
-
```bash
|
|
546
|
-
# Ensure read permissions on directories
|
|
547
|
-
chmod -R 755 /path/to/static/files
|
|
548
|
-
```
|
|
549
|
-
|
|
550
|
-
**Issue: Directory not found**
|
|
551
|
-
```python
|
|
552
|
-
# Use absolute paths
|
|
553
|
-
import os
|
|
554
|
-
service = WebService(
|
|
555
|
-
directories={
|
|
556
|
-
"/docs": os.path.abspath("./documentation")
|
|
557
|
-
}
|
|
558
|
-
)
|
|
559
|
-
```
|
|
560
|
-
|
|
561
|
-
### Debug Logging
|
|
562
|
-
|
|
563
|
-
Enable debug logging to troubleshoot issues:
|
|
564
|
-
|
|
565
|
-
```python
|
|
566
|
-
import logging
|
|
567
|
-
logging.basicConfig(level=logging.DEBUG)
|
|
568
|
-
|
|
569
|
-
service = WebService(directories={"/test": "./test"})
|
|
570
|
-
service.start()
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
## API Reference
|
|
574
|
-
|
|
575
|
-
### WebService Class
|
|
576
|
-
|
|
577
|
-
```python
|
|
578
|
-
class WebService:
|
|
579
|
-
def __init__(self,
|
|
580
|
-
port: int = 8002,
|
|
581
|
-
directories: Dict[str, str] = None,
|
|
582
|
-
basic_auth: Optional[Tuple[str, str]] = None,
|
|
583
|
-
config_file: Optional[str] = None,
|
|
584
|
-
enable_directory_browsing: bool = False,
|
|
585
|
-
allowed_extensions: Optional[list] = None,
|
|
586
|
-
blocked_extensions: Optional[list] = None,
|
|
587
|
-
max_file_size: int = 100 * 1024 * 1024,
|
|
588
|
-
enable_cors: bool = True)
|
|
589
|
-
```
|
|
590
|
-
|
|
591
|
-
#### Parameters
|
|
592
|
-
- `port`: Port to bind to (default: 8002)
|
|
593
|
-
- `directories`: Dictionary mapping URL paths to local directories
|
|
594
|
-
- `basic_auth`: Tuple of (username, password) for authentication
|
|
595
|
-
- `config_file`: Path to JSON configuration file
|
|
596
|
-
- `enable_directory_browsing`: Allow directory listing (default: False)
|
|
597
|
-
- `allowed_extensions`: List of allowed file extensions
|
|
598
|
-
- `blocked_extensions`: List of blocked file extensions
|
|
599
|
-
- `max_file_size`: Maximum file size in bytes (default: 100MB)
|
|
600
|
-
- `enable_cors`: Enable CORS headers (default: True)
|
|
601
|
-
|
|
602
|
-
#### Methods
|
|
603
|
-
|
|
604
|
-
##### start()
|
|
605
|
-
```python
|
|
606
|
-
def start(self,
|
|
607
|
-
host: str = "0.0.0.0",
|
|
608
|
-
port: Optional[int] = None,
|
|
609
|
-
ssl_cert: Optional[str] = None,
|
|
610
|
-
ssl_key: Optional[str] = None)
|
|
611
|
-
```
|
|
612
|
-
Start the web service.
|
|
613
|
-
|
|
614
|
-
##### add_directory()
|
|
615
|
-
```python
|
|
616
|
-
def add_directory(self, route: str, directory: str) -> None
|
|
617
|
-
```
|
|
618
|
-
Add a new directory to serve.
|
|
619
|
-
|
|
620
|
-
##### remove_directory()
|
|
621
|
-
```python
|
|
622
|
-
def remove_directory(self, route: str) -> None
|
|
623
|
-
```
|
|
624
|
-
Remove a directory from being served.
|
|
625
|
-
|
|
626
|
-
## Integration with SignalWire Agents
|
|
627
|
-
|
|
628
|
-
WebService complements AI agents by providing static file serving:
|
|
629
|
-
|
|
630
|
-
```python
|
|
631
|
-
from signalwire_agents import AgentBase, WebService
|
|
632
|
-
|
|
633
|
-
class DocumentationAgent(AgentBase):
|
|
634
|
-
def __init__(self):
|
|
635
|
-
super().__init__(name="Documentation Assistant")
|
|
636
|
-
|
|
637
|
-
# Reference documentation served by WebService
|
|
638
|
-
self.prompt_add_section(
|
|
639
|
-
"Documentation",
|
|
640
|
-
"User documentation is available at https://example.com:8002/docs/"
|
|
641
|
-
)
|
|
642
|
-
|
|
643
|
-
@self.tool(
|
|
644
|
-
"get_doc_link",
|
|
645
|
-
description="Get link to a documentation page",
|
|
646
|
-
parameters={
|
|
647
|
-
"doc_name": {"type": "string", "description": "Name of the documentation page"}
|
|
648
|
-
}
|
|
649
|
-
)
|
|
650
|
-
def get_doc_link(self, args, raw_data):
|
|
651
|
-
doc_name = args.get('doc_name')
|
|
652
|
-
return FunctionResult(
|
|
653
|
-
f"Documentation available at: https://example.com:8002/docs/{doc_name}.html"
|
|
654
|
-
)
|
|
655
|
-
|
|
656
|
-
# Run both services
|
|
657
|
-
if __name__ == "__main__":
|
|
658
|
-
# Start WebService for documentation
|
|
659
|
-
web = WebService(
|
|
660
|
-
port=8002,
|
|
661
|
-
directories={"/docs": "./documentation"}
|
|
662
|
-
)
|
|
663
|
-
|
|
664
|
-
# Start agent
|
|
665
|
-
agent = DocumentationAgent()
|
|
666
|
-
|
|
667
|
-
# Run in threads or separate processes
|
|
668
|
-
import threading
|
|
669
|
-
web_thread = threading.Thread(target=web.start, daemon=True)
|
|
670
|
-
web_thread.start()
|
|
671
|
-
|
|
672
|
-
agent.serve(port=3000)
|
|
673
|
-
```
|
|
674
|
-
|
|
675
|
-
## Summary
|
|
676
|
-
|
|
677
|
-
WebService provides a secure, configurable static file server that integrates with the SignalWire AI Agents SDK. It follows the same architectural patterns as other SDK services, making it familiar and easy to use while providing configurable security features and flexible deployment options.
|