@signalwire/sdk 2.0.0 → 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/dist/index.d.ts +146 -0
- 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/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
- package/dist/rest/index.js +195 -0
- 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/dist/rest/pagination.d.ts +39 -0
- 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 -2489
- package/src/AgentServer.ts +0 -415
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1150
- package/src/DataMap.ts +0 -449
- package/src/FunctionResult.ts +0 -866
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -439
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -717
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -221
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -258
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -181
- package/src/WebService.ts +0 -619
- 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/index.ts +0 -167
- package/src/livewire/index.ts +0 -950
- package/src/prefabs/ConciergeAgent.ts +0 -287
- package/src/prefabs/FAQBotAgent.ts +0 -384
- package/src/prefabs/InfoGathererAgent.ts +0 -339
- package/src/prefabs/ReceptionistAgent.ts +0 -366
- package/src/prefabs/SurveyAgent.ts +0 -646
- package/src/relay/Action.ts +0 -314
- package/src/relay/Call.ts +0 -854
- package/src/relay/Deferred.ts +0 -71
- package/src/relay/Message.ts +0 -148
- package/src/relay/RelayClient.ts +0 -1036
- package/src/relay/RelayError.ts +0 -14
- package/src/relay/RelayEvent.ts +0 -892
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -103
- package/src/rest/RestError.ts +0 -31
- package/src/rest/base/BaseResource.ts +0 -19
- package/src/rest/base/CrudResource.ts +0 -51
- package/src/rest/base/CrudWithAddresses.ts +0 -26
- package/src/rest/namespaces/addresses.ts +0 -32
- package/src/rest/namespaces/calling.ts +0 -187
- package/src/rest/namespaces/chat.ts +0 -20
- package/src/rest/namespaces/compat.ts +0 -352
- package/src/rest/namespaces/datasphere.ts +0 -45
- package/src/rest/namespaces/fabric.ts +0 -222
- package/src/rest/namespaces/imported-numbers.ts +0 -20
- package/src/rest/namespaces/logs.ts +0 -84
- package/src/rest/namespaces/lookup.ts +0 -21
- package/src/rest/namespaces/mfa.ts +0 -30
- package/src/rest/namespaces/number-groups.ts +0 -38
- package/src/rest/namespaces/phone-numbers.ts +0 -44
- package/src/rest/namespaces/project.ts +0 -36
- package/src/rest/namespaces/pubsub.ts +0 -20
- package/src/rest/namespaces/queues.ts +0 -33
- package/src/rest/namespaces/recordings.ts +0 -28
- package/src/rest/namespaces/registry.ts +0 -101
- package/src/rest/namespaces/short-codes.ts +0 -28
- package/src/rest/namespaces/sip-profile.ts +0 -25
- package/src/rest/namespaces/verified-callers.ts +0 -27
- package/src/rest/namespaces/video.ts +0 -165
- package/src/rest/pagination.ts +0 -84
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -547
- package/src/skills/SkillManager.ts +0 -415
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
- package/src/skills/builtin/ask_claude.ts +0 -241
- package/src/skills/builtin/claude_skills.ts +0 -978
- package/src/skills/builtin/custom_skills.ts +0 -312
- package/src/skills/builtin/datasphere.ts +0 -438
- package/src/skills/builtin/datasphere_serverless.ts +0 -339
- package/src/skills/builtin/datetime.ts +0 -130
- package/src/skills/builtin/google_maps.ts +0 -651
- package/src/skills/builtin/info_gatherer.ts +0 -405
- package/src/skills/builtin/joke.ts +0 -191
- package/src/skills/builtin/math.ts +0 -142
- package/src/skills/builtin/mcp_gateway.ts +0 -677
- package/src/skills/builtin/native_vector_search.ts +0 -901
- package/src/skills/builtin/play_background_file.ts +0 -358
- package/src/skills/builtin/spider.ts +0 -869
- package/src/skills/builtin/swml_transfer.ts +0 -635
- package/src/skills/builtin/weather_api.ts +0 -248
- package/src/skills/builtin/web_search.ts +0 -1074
- package/src/skills/builtin/wikipedia_search.ts +0 -299
- 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
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* AuthHandler - Multi-method authentication handler.
|
|
3
|
+
*
|
|
4
|
+
* Supports Bearer token, API key, and Basic auth with constant-time comparison.
|
|
5
|
+
* Can be used as Hono middleware or standalone validator.
|
|
6
|
+
*/
|
|
7
|
+
import { timingSafeEqual } from 'node:crypto';
|
|
8
|
+
import { getLogger } from './Logger.js';
|
|
9
|
+
const log = getLogger('AuthHandler');
|
|
10
|
+
/**
|
|
11
|
+
* Constant-time string comparison to prevent timing attacks.
|
|
12
|
+
*/
|
|
13
|
+
function safeCompare(a, b) {
|
|
14
|
+
const maxLen = Math.max(a.length, b.length);
|
|
15
|
+
const result = timingSafeEqual(Buffer.from(a.padEnd(maxLen, '\0')), Buffer.from(b.padEnd(maxLen, '\0')));
|
|
16
|
+
return result && a.length === b.length;
|
|
17
|
+
}
|
|
18
|
+
/** Multi-method authentication handler with timing-safe credential comparison. */
|
|
19
|
+
export class AuthHandler {
|
|
20
|
+
/** The authentication configuration for this handler. */
|
|
21
|
+
config;
|
|
22
|
+
/**
|
|
23
|
+
* Create a new AuthHandler.
|
|
24
|
+
* @param config - Authentication configuration specifying one or more auth methods.
|
|
25
|
+
*/
|
|
26
|
+
constructor(config) {
|
|
27
|
+
this.config = config;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Validate request headers against configured auth methods (Bearer, API Key, Basic, Custom) in order.
|
|
31
|
+
* @param headers - The request headers as a string-keyed record.
|
|
32
|
+
* @returns True if any configured method accepts the request, or if no methods are configured.
|
|
33
|
+
*/
|
|
34
|
+
async validate(headers) {
|
|
35
|
+
// 1. Bearer token
|
|
36
|
+
if (this.config.bearerToken) {
|
|
37
|
+
const authHeader = headers['authorization'] || headers['Authorization'] || '';
|
|
38
|
+
if (authHeader.startsWith('Bearer ')) {
|
|
39
|
+
const token = authHeader.slice(7);
|
|
40
|
+
if (safeCompare(token, this.config.bearerToken))
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
// 2. API Key
|
|
45
|
+
if (this.config.apiKey) {
|
|
46
|
+
const headerName = this.config.apiKeyHeader ?? 'X-Api-Key';
|
|
47
|
+
const headerLower = headerName.toLowerCase();
|
|
48
|
+
const key = headers[headerLower] || headers[headerName] || '';
|
|
49
|
+
if (key && safeCompare(key, this.config.apiKey))
|
|
50
|
+
return true;
|
|
51
|
+
}
|
|
52
|
+
// 3. Basic auth
|
|
53
|
+
if (this.config.basicAuth) {
|
|
54
|
+
const authHeader = headers['authorization'] || headers['Authorization'] || '';
|
|
55
|
+
if (authHeader.startsWith('Basic ')) {
|
|
56
|
+
const decoded = Buffer.from(authHeader.slice(6), 'base64').toString();
|
|
57
|
+
const colonIdx = decoded.indexOf(':');
|
|
58
|
+
if (colonIdx > 0) {
|
|
59
|
+
const user = decoded.slice(0, colonIdx);
|
|
60
|
+
const pass = decoded.slice(colonIdx + 1);
|
|
61
|
+
const [expectedUser, expectedPass] = this.config.basicAuth;
|
|
62
|
+
if (safeCompare(user, expectedUser) && safeCompare(pass, expectedPass))
|
|
63
|
+
return true;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
// 4. Custom validator
|
|
68
|
+
if (this.config.customValidator) {
|
|
69
|
+
const result = await this.config.customValidator({
|
|
70
|
+
headers,
|
|
71
|
+
method: '',
|
|
72
|
+
url: '',
|
|
73
|
+
});
|
|
74
|
+
if (result)
|
|
75
|
+
return true;
|
|
76
|
+
}
|
|
77
|
+
// If no methods configured, check allowUnauthenticated flag
|
|
78
|
+
if (!this.config.bearerToken && !this.config.apiKey && !this.config.basicAuth && !this.config.customValidator) {
|
|
79
|
+
if (this.config.allowUnauthenticated === false) {
|
|
80
|
+
return false;
|
|
81
|
+
}
|
|
82
|
+
log.warn('No auth methods configured; allowing unauthenticated access. Set allowUnauthenticated to false to deny.');
|
|
83
|
+
return true;
|
|
84
|
+
}
|
|
85
|
+
return false;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Verify a Basic Auth username/password pair against the configured credentials.
|
|
89
|
+
*
|
|
90
|
+
* Returns false immediately if Basic Auth is not configured.
|
|
91
|
+
* Uses constant-time comparison to prevent timing attacks.
|
|
92
|
+
*
|
|
93
|
+
* @param username - The username to verify.
|
|
94
|
+
* @param password - The password to verify.
|
|
95
|
+
* @returns True if the credentials match the configured Basic Auth credentials.
|
|
96
|
+
*/
|
|
97
|
+
verifyBasicAuth(username, password) {
|
|
98
|
+
if (!this.config.basicAuth)
|
|
99
|
+
return false;
|
|
100
|
+
const [expectedUser, expectedPass] = this.config.basicAuth;
|
|
101
|
+
return safeCompare(username, expectedUser) && safeCompare(password, expectedPass);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Verify a Bearer token against the configured token.
|
|
105
|
+
*
|
|
106
|
+
* Returns false immediately if Bearer token auth is not configured.
|
|
107
|
+
* Uses constant-time comparison to prevent timing attacks.
|
|
108
|
+
*
|
|
109
|
+
* @param token - The Bearer token string to verify (without the "Bearer " prefix).
|
|
110
|
+
* @returns True if the token matches the configured Bearer token.
|
|
111
|
+
*/
|
|
112
|
+
verifyBearerToken(token) {
|
|
113
|
+
if (!this.config.bearerToken)
|
|
114
|
+
return false;
|
|
115
|
+
return safeCompare(token, this.config.bearerToken);
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Verify an API key against the configured key.
|
|
119
|
+
*
|
|
120
|
+
* Returns false immediately if API key auth is not configured.
|
|
121
|
+
* Uses constant-time comparison to prevent timing attacks.
|
|
122
|
+
*
|
|
123
|
+
* @param key - The API key string to verify.
|
|
124
|
+
* @returns True if the key matches the configured API key.
|
|
125
|
+
*/
|
|
126
|
+
verifyApiKey(key) {
|
|
127
|
+
if (!this.config.apiKey)
|
|
128
|
+
return false;
|
|
129
|
+
return safeCompare(key, this.config.apiKey);
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Create a Hono-compatible middleware that rejects unauthorized requests with a 401 response.
|
|
133
|
+
* @param optional - When true, unauthenticated requests are allowed through instead of being rejected (default: false).
|
|
134
|
+
* @returns A middleware function suitable for use with Hono's `app.use()`.
|
|
135
|
+
*/
|
|
136
|
+
middleware(optional = false) {
|
|
137
|
+
return async (c, next) => {
|
|
138
|
+
const headers = {};
|
|
139
|
+
c.req.raw.headers.forEach((v, k) => { headers[k] = v; });
|
|
140
|
+
const valid = await this.validate(headers);
|
|
141
|
+
if (!valid && !optional) {
|
|
142
|
+
return c.json({ error: 'Unauthorized' }, 401);
|
|
143
|
+
}
|
|
144
|
+
await next();
|
|
145
|
+
};
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* Create an Express/Connect-compatible middleware adapter.
|
|
149
|
+
*
|
|
150
|
+
* This serves as the framework-agnostic equivalent of Python's
|
|
151
|
+
* `get_fastapi_dependency`. For standalone validation without a
|
|
152
|
+
* framework, use {@link validate} directly.
|
|
153
|
+
*
|
|
154
|
+
* @param optional - When true, unauthenticated requests are allowed through (default: false).
|
|
155
|
+
* @returns An Express-compatible middleware function.
|
|
156
|
+
*/
|
|
157
|
+
expressMiddleware(optional = false) {
|
|
158
|
+
return async (req, res, next) => {
|
|
159
|
+
const headers = req.headers;
|
|
160
|
+
const valid = await this.validate(headers);
|
|
161
|
+
if (!valid && !optional) {
|
|
162
|
+
res.status(401).json({ error: 'Unauthorized' });
|
|
163
|
+
return;
|
|
164
|
+
}
|
|
165
|
+
next();
|
|
166
|
+
};
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Get information about configured authentication methods.
|
|
170
|
+
*
|
|
171
|
+
* Returns structured metadata describing each enabled auth method,
|
|
172
|
+
* including usernames, header names, and usage hints.
|
|
173
|
+
*
|
|
174
|
+
* @returns An object describing the enabled auth methods and their configuration.
|
|
175
|
+
*/
|
|
176
|
+
getAuthInfo() {
|
|
177
|
+
const info = {};
|
|
178
|
+
if (this.config.basicAuth) {
|
|
179
|
+
info.basic = { enabled: true, username: this.config.basicAuth[0] };
|
|
180
|
+
}
|
|
181
|
+
if (this.config.bearerToken) {
|
|
182
|
+
info.bearer = { enabled: true, hint: 'Use Authorization: Bearer <token>' };
|
|
183
|
+
}
|
|
184
|
+
if (this.config.apiKey) {
|
|
185
|
+
const header = this.config.apiKeyHeader ?? 'X-Api-Key';
|
|
186
|
+
info.apiKey = { enabled: true, header, hint: `Use ${header}: <key>` };
|
|
187
|
+
}
|
|
188
|
+
return info;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Check whether Bearer token authentication is configured.
|
|
192
|
+
* @returns True if a bearer token has been set.
|
|
193
|
+
*/
|
|
194
|
+
hasBearerAuth() {
|
|
195
|
+
return !!this.config.bearerToken;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Check whether API key authentication is configured.
|
|
199
|
+
* @returns True if an API key has been set.
|
|
200
|
+
*/
|
|
201
|
+
hasApiKeyAuth() {
|
|
202
|
+
return !!this.config.apiKey;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Check whether Basic authentication is configured.
|
|
206
|
+
* @returns True if basic auth credentials have been set.
|
|
207
|
+
*/
|
|
208
|
+
hasBasicAuth() {
|
|
209
|
+
return !!this.config.basicAuth;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
//# sourceMappingURL=AuthHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AuthHandler.js","sourceRoot":"","sources":["../src/AuthHandler.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,GAAG,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAkBrC;;GAEG;AACH,SAAS,WAAW,CAAC,CAAS,EAAE,CAAS;IACvC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,eAAe,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACnC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CACpC,CAAC;IACF,OAAO,MAAM,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC;AACzC,CAAC;AAED,kFAAkF;AAClF,MAAM,OAAO,WAAW;IACtB,yDAAyD;IAChD,MAAM,CAAa;IAE5B;;;OAGG;IACH,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,OAA+B;QAC5C,kBAAkB;QAClB,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;YAC9E,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;oBAAE,OAAO,IAAI,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,aAAa;QACb,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,WAAW,CAAC;YAC3D,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;YAC7C,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAC9D,IAAI,GAAG,IAAI,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBAAE,OAAO,IAAI,CAAC;QAC/D,CAAC;QAED,gBAAgB;QAChB,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;YAC9E,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACtE,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACtC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;oBACjB,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;oBACxC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;oBACzC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;oBAC3D,IAAI,WAAW,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,YAAY,CAAC;wBAAE,OAAO,IAAI,CAAC;gBACtF,CAAC;YACH,CAAC;QACH,CAAC;QAED,sBAAsB;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;gBAC/C,OAAO;gBACP,MAAM,EAAE,EAAE;gBACV,GAAG,EAAE,EAAE;aACR,CAAC,CAAC;YACH,IAAI,MAAM;gBAAE,OAAO,IAAI,CAAC;QAC1B,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YAC9G,IAAI,IAAI,CAAC,MAAM,CAAC,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,yGAAyG,CAAC,CAAC;YACpH,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,QAAgB,EAAE,QAAgB;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QACzC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QAC3D,OAAO,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,KAAa;QAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,OAAO,KAAK,CAAC;QAC3C,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,GAAW;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QACtC,OAAO,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAAQ,GAAG,KAAK;QACzB,OAAO,KAAK,EAAE,CAAM,EAAE,IAAyB,EAAE,EAAE;YACjD,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAEzE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,GAAG,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,IAAI,EAAE,CAAC;QACf,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,QAAQ,GAAG,KAAK;QAChC,OAAO,KAAK,EAAE,GAAQ,EAAE,GAAQ,EAAE,IAAgB,EAAE,EAAE;YACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAiC,CAAC;YACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;gBAChD,OAAO;YACT,CAAC;YACD,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,WAAW;QAKT,MAAM,IAAI,GAIN,EAAE,CAAC;QAEP,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC;QAC7E,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,WAAW,CAAC;YACvD,IAAI,CAAC,MAAM,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,MAAM,SAAS,EAAE,CAAC;QACxE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IACjC,CAAC;CACF"}
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ConfigLoader - JSON config file loader with env var interpolation.
|
|
3
|
+
*
|
|
4
|
+
* Supports ${VAR|default} syntax for env var substitution and
|
|
5
|
+
* dot-notation access for nested values.
|
|
6
|
+
*/
|
|
7
|
+
/** JSON configuration file loader with environment variable interpolation and dot-notation access. */
|
|
8
|
+
export declare class ConfigLoader {
|
|
9
|
+
private static readonly DANGEROUS_KEYS;
|
|
10
|
+
private data;
|
|
11
|
+
private filePath;
|
|
12
|
+
/** The ordered list of config file paths that were searched or provided. */
|
|
13
|
+
private _configPaths;
|
|
14
|
+
/**
|
|
15
|
+
* Create a new ConfigLoader, optionally loading a JSON file immediately.
|
|
16
|
+
*
|
|
17
|
+
* Accepts a single file path or an array of paths. When given an array,
|
|
18
|
+
* the loader iterates in order and loads the first file that exists
|
|
19
|
+
* (mirroring Python's ordered-search behaviour).
|
|
20
|
+
*
|
|
21
|
+
* @param filePaths - Path(s) to a JSON config file to load on construction.
|
|
22
|
+
*/
|
|
23
|
+
constructor(filePaths?: string | string[]);
|
|
24
|
+
/**
|
|
25
|
+
* Get the ordered list of config file paths that were passed/searched.
|
|
26
|
+
* @returns The array of config paths.
|
|
27
|
+
*/
|
|
28
|
+
get configPaths(): string[];
|
|
29
|
+
/**
|
|
30
|
+
* Load configuration from a JSON file, performing `${VAR|default}` env var interpolation on the raw text.
|
|
31
|
+
* @param filePath - Path to the JSON config file.
|
|
32
|
+
* @returns This instance for chaining.
|
|
33
|
+
*/
|
|
34
|
+
load(filePath: string): this;
|
|
35
|
+
/**
|
|
36
|
+
* Search for a config file in standard locations.
|
|
37
|
+
*
|
|
38
|
+
* Default search paths: CWD, `./config`, `$HOME/.signalwire`,
|
|
39
|
+
* `.swml/`, `$HOME/.swml/`, `/etc/swml/`.
|
|
40
|
+
*
|
|
41
|
+
* @param filename - The config file name to search for.
|
|
42
|
+
* @param additionalPaths - Extra directories to search before the defaults.
|
|
43
|
+
* @param serviceName - Optional service name; prepends service-specific filenames to the search.
|
|
44
|
+
* @returns A loaded ConfigLoader if found, or null if the file does not exist in any search path.
|
|
45
|
+
*/
|
|
46
|
+
static search(filename: string, additionalPaths?: string[], serviceName?: string): ConfigLoader | null;
|
|
47
|
+
/**
|
|
48
|
+
* Find a config file path without loading it.
|
|
49
|
+
*
|
|
50
|
+
* Searches service-specific filenames, additional paths, and default paths.
|
|
51
|
+
* Returns the first found path string or null.
|
|
52
|
+
*
|
|
53
|
+
* @param serviceName - Optional service name for service-specific config filenames.
|
|
54
|
+
* @param additionalPaths - Additional file paths to check.
|
|
55
|
+
* @returns Path to the first config file found, or null.
|
|
56
|
+
*/
|
|
57
|
+
static findConfigFile(serviceName?: string, additionalPaths?: string[]): string | null;
|
|
58
|
+
/**
|
|
59
|
+
* Build the list of file paths to search.
|
|
60
|
+
*/
|
|
61
|
+
private static _buildSearchPaths;
|
|
62
|
+
/**
|
|
63
|
+
* Retrieve a configuration value using a dot-notation path (e.g. `'server.port'`).
|
|
64
|
+
* @param path - Dot-separated key path into the config object.
|
|
65
|
+
* @param defaultValue - Value returned when the path does not exist.
|
|
66
|
+
* @returns The resolved value, or defaultValue if not found.
|
|
67
|
+
*/
|
|
68
|
+
get<T = unknown>(path: string, defaultValue?: T): T;
|
|
69
|
+
/**
|
|
70
|
+
* Set a configuration value at the given dot-notation path, creating intermediate objects as needed.
|
|
71
|
+
* @param path - Dot-separated key path into the config object.
|
|
72
|
+
* @param value - The value to store.
|
|
73
|
+
* @returns This instance for chaining.
|
|
74
|
+
*/
|
|
75
|
+
set(path: string, value: unknown): this;
|
|
76
|
+
/**
|
|
77
|
+
* Check whether a dot-notation path exists in the loaded configuration.
|
|
78
|
+
* @param path - Dot-separated key path to check.
|
|
79
|
+
* @returns True if the path resolves to a defined value.
|
|
80
|
+
*/
|
|
81
|
+
has(path: string): boolean;
|
|
82
|
+
/**
|
|
83
|
+
* Return a shallow copy of the entire configuration object.
|
|
84
|
+
* @returns A copy of the top-level config data.
|
|
85
|
+
*/
|
|
86
|
+
getAll(): Record<string, unknown>;
|
|
87
|
+
/**
|
|
88
|
+
* Alias for {@link getAll} — matches the Python SDK's `get_config()` method name.
|
|
89
|
+
* @returns A copy of the top-level config data.
|
|
90
|
+
*/
|
|
91
|
+
getConfig(): Record<string, unknown>;
|
|
92
|
+
/**
|
|
93
|
+
* Return the absolute path of the loaded config file, if any.
|
|
94
|
+
* @returns The file path, or null if config was loaded from an object.
|
|
95
|
+
*/
|
|
96
|
+
getFilePath(): string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Alias for {@link getFilePath} — matches the Python SDK's `get_config_file()` method name.
|
|
99
|
+
* @returns The file path, or null if config was loaded from an object.
|
|
100
|
+
*/
|
|
101
|
+
getConfigFile(): string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Check if a configuration was loaded.
|
|
104
|
+
*
|
|
105
|
+
* **Deliberate deviation from Python `has_config()`:** Python returns `True`
|
|
106
|
+
* only when a file was loaded (`self._config is not None`). This TypeScript
|
|
107
|
+
* implementation also returns `true` when data was loaded via
|
|
108
|
+
* {@link loadFromObject}, because `loadFromObject` is an extra TS-only method
|
|
109
|
+
* with no Python equivalent. Treating object-loaded data as "configured" is
|
|
110
|
+
* the correct semantic for the TS API surface.
|
|
111
|
+
*
|
|
112
|
+
* If you need file-load-only detection, check `this.getFilePath() !== null`.
|
|
113
|
+
*
|
|
114
|
+
* @returns True if configuration data exists (from file or object).
|
|
115
|
+
*/
|
|
116
|
+
hasConfig(): boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Get an entire configuration section with all environment variables substituted.
|
|
119
|
+
* @param section - The top-level section name (e.g. 'security', 'server').
|
|
120
|
+
* @returns The configuration section as an object, or an empty object if not found.
|
|
121
|
+
*/
|
|
122
|
+
getSection(section: string): Record<string, unknown>;
|
|
123
|
+
/**
|
|
124
|
+
* Recursively substitute `${VAR|default}` environment variables in any value.
|
|
125
|
+
*
|
|
126
|
+
* Walks strings, objects, and arrays. Coerces result strings to boolean
|
|
127
|
+
* (`"true"` / `"false"`) or number when appropriate.
|
|
128
|
+
*
|
|
129
|
+
* @param value - The value to process (string, object, array, or primitive).
|
|
130
|
+
* @param maxDepth - Maximum recursion depth to prevent infinite loops (default: 10).
|
|
131
|
+
* @returns The value with all environment variables substituted.
|
|
132
|
+
*/
|
|
133
|
+
substituteVars(value: unknown, maxDepth?: number): unknown;
|
|
134
|
+
/**
|
|
135
|
+
* Merge configuration with environment variables that match a prefix.
|
|
136
|
+
*
|
|
137
|
+
* Config file values take precedence over environment variables. Matching
|
|
138
|
+
* env var keys are stripped of the prefix, lowercased, split on `_`, and
|
|
139
|
+
* written into a nested object (e.g. `SWML_FOO_BAR` → `{ foo: { bar: v } }`).
|
|
140
|
+
* Mirrors Python's `merge_with_env` in
|
|
141
|
+
* `signalwire/signalwire/core/config_loader.py`.
|
|
142
|
+
*
|
|
143
|
+
* @param envPrefix - Prefix for environment variables to consider (default: `'SWML_'`).
|
|
144
|
+
* @returns Merged configuration dictionary.
|
|
145
|
+
*/
|
|
146
|
+
mergeWithEnv(envPrefix?: string): Record<string, unknown>;
|
|
147
|
+
/**
|
|
148
|
+
* Check if a nested key (underscore-separated path) exists in a dict.
|
|
149
|
+
* Used by {@link mergeWithEnv} to mirror Python's `_has_nested_key`.
|
|
150
|
+
*/
|
|
151
|
+
private _hasNestedKey;
|
|
152
|
+
/**
|
|
153
|
+
* Set a value in a dict using an underscore-separated path, creating
|
|
154
|
+
* intermediate objects as needed.
|
|
155
|
+
* Used by {@link mergeWithEnv} to mirror Python's `_set_nested_key`.
|
|
156
|
+
*/
|
|
157
|
+
private _setNestedKey;
|
|
158
|
+
/**
|
|
159
|
+
* Load configuration from a plain object instead of a file, useful for testing or programmatic setup.
|
|
160
|
+
* @param obj - The configuration object to use.
|
|
161
|
+
* @returns This instance for chaining.
|
|
162
|
+
*/
|
|
163
|
+
loadFromObject(obj: Record<string, unknown>): this;
|
|
164
|
+
/**
|
|
165
|
+
* Interpolate ${VAR|default} patterns in a raw string.
|
|
166
|
+
* @param input - The string containing env var references.
|
|
167
|
+
* @returns The string with all env var references resolved.
|
|
168
|
+
*/
|
|
169
|
+
interpolateEnvVars(input: string): string;
|
|
170
|
+
}
|