@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,108 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SchemaUtils - JSON Schema validation for SWML documents.
|
|
3
|
+
*
|
|
4
|
+
* Provides basic structural validation of rendered SWML and
|
|
5
|
+
* schema-driven verb extraction/validation.
|
|
6
|
+
* Set SWML_SKIP_SCHEMA_VALIDATION=true to disable.
|
|
7
|
+
*/
|
|
8
|
+
/** Result of validating a SWML document. */
|
|
9
|
+
export interface ValidationResult {
|
|
10
|
+
/** Whether the document passed all validation checks. */
|
|
11
|
+
valid: boolean;
|
|
12
|
+
/** List of human-readable error messages; empty when valid. */
|
|
13
|
+
errors: string[];
|
|
14
|
+
}
|
|
15
|
+
/** A verb definition extracted from the schema. */
|
|
16
|
+
export interface VerbDefinition {
|
|
17
|
+
/** The verb name as used in SWML (e.g. "answer", "hangup", "sip_refer"). */
|
|
18
|
+
name: string;
|
|
19
|
+
/** The PascalCase schema definition name (e.g. "Answer", "Hangup", "SIPRefer"). */
|
|
20
|
+
schemaName: string;
|
|
21
|
+
/** The raw JSON Schema definition object for this verb. */
|
|
22
|
+
definition: Record<string, unknown>;
|
|
23
|
+
}
|
|
24
|
+
/** Validates SWML documents against structural rules with an LRU-style result cache. */
|
|
25
|
+
export declare class SchemaUtils {
|
|
26
|
+
private skipValidation;
|
|
27
|
+
private cache;
|
|
28
|
+
private maxCacheSize;
|
|
29
|
+
private schema;
|
|
30
|
+
private verbs;
|
|
31
|
+
/** Path to the schema file, or null to use the bundled schema. */
|
|
32
|
+
private schemaPath;
|
|
33
|
+
/**
|
|
34
|
+
* Create a SchemaUtils instance.
|
|
35
|
+
* @param opts - Optional settings for skipping validation, limiting cache size, or overriding the schema file path.
|
|
36
|
+
*/
|
|
37
|
+
constructor(opts?: {
|
|
38
|
+
skipValidation?: boolean;
|
|
39
|
+
maxCacheSize?: number;
|
|
40
|
+
schemaPath?: string;
|
|
41
|
+
});
|
|
42
|
+
/**
|
|
43
|
+
* Load the schema from the path specified in opts.schemaPath (if given) or fall back
|
|
44
|
+
* to the bundled schema.json. Mirrors Python's SchemaUtils which accepts an explicit
|
|
45
|
+
* schema_path and falls back to _get_default_schema_path() when None is supplied.
|
|
46
|
+
*/
|
|
47
|
+
private loadSchema;
|
|
48
|
+
/**
|
|
49
|
+
* Extract verb definitions from `$defs/SWMLMethod.anyOf` in the schema.
|
|
50
|
+
* Mirrors Python SDK's `_extract_verb_definitions()`.
|
|
51
|
+
*/
|
|
52
|
+
private extractVerbDefinitions;
|
|
53
|
+
/**
|
|
54
|
+
* Get all verb names defined in the schema.
|
|
55
|
+
* @returns Array of verb names (e.g. ["answer", "ai", "hangup", ...]).
|
|
56
|
+
*/
|
|
57
|
+
getVerbNames(): string[];
|
|
58
|
+
/**
|
|
59
|
+
* Get the inner properties schema for a specific verb.
|
|
60
|
+
* For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`.
|
|
61
|
+
* @param verbName - The verb name (e.g. "answer", "tap").
|
|
62
|
+
* @returns The inner schema definition or an empty object if not found.
|
|
63
|
+
*/
|
|
64
|
+
getVerbProperties(verbName: string): Record<string, unknown>;
|
|
65
|
+
/**
|
|
66
|
+
* Get the required properties for a verb's inner config.
|
|
67
|
+
* @param verbName - The verb name.
|
|
68
|
+
* @returns Array of required property names.
|
|
69
|
+
*/
|
|
70
|
+
getVerbRequiredProperties(verbName: string): string[];
|
|
71
|
+
/**
|
|
72
|
+
* Get the description text for a verb.
|
|
73
|
+
* @param verbName - The verb name.
|
|
74
|
+
* @returns The description string or empty string.
|
|
75
|
+
*/
|
|
76
|
+
getVerbDescription(verbName: string): string;
|
|
77
|
+
/**
|
|
78
|
+
* Check if a verb name is defined in the schema.
|
|
79
|
+
* @param verbName - The verb name.
|
|
80
|
+
* @returns True if the verb exists.
|
|
81
|
+
*/
|
|
82
|
+
hasVerb(verbName: string): boolean;
|
|
83
|
+
/**
|
|
84
|
+
* Lightweight validation of a verb config against the schema.
|
|
85
|
+
* Checks that the verb exists and required properties are present.
|
|
86
|
+
* Mirrors Python SDK's `_validate_verb_lightweight()`.
|
|
87
|
+
*
|
|
88
|
+
* @param verbName - The verb name.
|
|
89
|
+
* @param config - The verb configuration to validate.
|
|
90
|
+
* @returns Validation result.
|
|
91
|
+
*/
|
|
92
|
+
validateVerb(verbName: string, config: unknown): ValidationResult;
|
|
93
|
+
/**
|
|
94
|
+
* Validate a SWML document against structural rules.
|
|
95
|
+
* @param swml - The SWML document as a JSON string or parsed object.
|
|
96
|
+
* @returns The validation result indicating success or a list of errors.
|
|
97
|
+
*/
|
|
98
|
+
validate(swml: string | Record<string, unknown>): ValidationResult;
|
|
99
|
+
private validateAiVerb;
|
|
100
|
+
/** Clear the validation cache */
|
|
101
|
+
clearCache(): void;
|
|
102
|
+
/**
|
|
103
|
+
* Get the number of cached validation results.
|
|
104
|
+
* @returns The current cache entry count.
|
|
105
|
+
*/
|
|
106
|
+
getCacheSize(): number;
|
|
107
|
+
private cacheResult;
|
|
108
|
+
}
|
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SchemaUtils - JSON Schema validation for SWML documents.
|
|
3
|
+
*
|
|
4
|
+
* Provides basic structural validation of rendered SWML and
|
|
5
|
+
* schema-driven verb extraction/validation.
|
|
6
|
+
* Set SWML_SKIP_SCHEMA_VALIDATION=true to disable.
|
|
7
|
+
*/
|
|
8
|
+
import { createRequire } from 'module';
|
|
9
|
+
// Basic SWML structure expectations
|
|
10
|
+
const REQUIRED_TOP_LEVEL = ['version', 'sections'];
|
|
11
|
+
const VALID_VERSIONS = ['1.0.0'];
|
|
12
|
+
/** Validates SWML documents against structural rules with an LRU-style result cache. */
|
|
13
|
+
export class SchemaUtils {
|
|
14
|
+
skipValidation;
|
|
15
|
+
cache = new Map();
|
|
16
|
+
maxCacheSize;
|
|
17
|
+
schema = null;
|
|
18
|
+
verbs = new Map();
|
|
19
|
+
/** Path to the schema file, or null to use the bundled schema. */
|
|
20
|
+
schemaPath;
|
|
21
|
+
/**
|
|
22
|
+
* Create a SchemaUtils instance.
|
|
23
|
+
* @param opts - Optional settings for skipping validation, limiting cache size, or overriding the schema file path.
|
|
24
|
+
*/
|
|
25
|
+
constructor(opts) {
|
|
26
|
+
this.skipValidation = opts?.skipValidation ?? (process.env['SWML_SKIP_SCHEMA_VALIDATION'] === 'true');
|
|
27
|
+
this.maxCacheSize = opts?.maxCacheSize ?? 100;
|
|
28
|
+
this.schemaPath = opts?.schemaPath ?? null;
|
|
29
|
+
this.loadSchema();
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Load the schema from the path specified in opts.schemaPath (if given) or fall back
|
|
33
|
+
* to the bundled schema.json. Mirrors Python's SchemaUtils which accepts an explicit
|
|
34
|
+
* schema_path and falls back to _get_default_schema_path() when None is supplied.
|
|
35
|
+
*/
|
|
36
|
+
loadSchema() {
|
|
37
|
+
// Try custom schema path first (mirrors Python's schema_path parameter)
|
|
38
|
+
if (this.schemaPath) {
|
|
39
|
+
try {
|
|
40
|
+
const require = createRequire(import.meta.url);
|
|
41
|
+
this.schema = require(this.schemaPath);
|
|
42
|
+
this.verbs = this.extractVerbDefinitions();
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
catch {
|
|
46
|
+
// Fall through to bundled schema on load failure
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
// Fall back to bundled schema.json
|
|
50
|
+
try {
|
|
51
|
+
const require = createRequire(import.meta.url);
|
|
52
|
+
this.schema = require('./schema.json');
|
|
53
|
+
this.verbs = this.extractVerbDefinitions();
|
|
54
|
+
}
|
|
55
|
+
catch {
|
|
56
|
+
// Schema loading is optional — validation still works structurally
|
|
57
|
+
this.schema = null;
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Extract verb definitions from `$defs/SWMLMethod.anyOf` in the schema.
|
|
62
|
+
* Mirrors Python SDK's `_extract_verb_definitions()`.
|
|
63
|
+
*/
|
|
64
|
+
extractVerbDefinitions() {
|
|
65
|
+
const verbs = new Map();
|
|
66
|
+
if (!this.schema)
|
|
67
|
+
return verbs;
|
|
68
|
+
const defs = this.schema['$defs'];
|
|
69
|
+
if (!defs)
|
|
70
|
+
return verbs;
|
|
71
|
+
const swmlMethod = defs['SWMLMethod'];
|
|
72
|
+
if (!swmlMethod || !Array.isArray(swmlMethod['anyOf']))
|
|
73
|
+
return verbs;
|
|
74
|
+
for (const ref of swmlMethod['anyOf']) {
|
|
75
|
+
const refPath = ref['$ref'];
|
|
76
|
+
if (!refPath)
|
|
77
|
+
continue;
|
|
78
|
+
// Extract the PascalCase name from "#/$defs/Answer"
|
|
79
|
+
const schemaName = refPath.split('/').pop();
|
|
80
|
+
const verbDef = defs[schemaName];
|
|
81
|
+
if (!verbDef || !verbDef['properties'])
|
|
82
|
+
continue;
|
|
83
|
+
// The actual verb name is the first (and only) property key
|
|
84
|
+
const propNames = Object.keys(verbDef['properties']);
|
|
85
|
+
if (propNames.length === 0)
|
|
86
|
+
continue;
|
|
87
|
+
const verbName = propNames[0];
|
|
88
|
+
verbs.set(verbName, {
|
|
89
|
+
name: verbName,
|
|
90
|
+
schemaName,
|
|
91
|
+
definition: verbDef,
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
return verbs;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Get all verb names defined in the schema.
|
|
98
|
+
* @returns Array of verb names (e.g. ["answer", "ai", "hangup", ...]).
|
|
99
|
+
*/
|
|
100
|
+
getVerbNames() {
|
|
101
|
+
return Array.from(this.verbs.keys());
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Get the inner properties schema for a specific verb.
|
|
105
|
+
* For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`.
|
|
106
|
+
* @param verbName - The verb name (e.g. "answer", "tap").
|
|
107
|
+
* @returns The inner schema definition or an empty object if not found.
|
|
108
|
+
*/
|
|
109
|
+
getVerbProperties(verbName) {
|
|
110
|
+
const verb = this.verbs.get(verbName);
|
|
111
|
+
if (!verb)
|
|
112
|
+
return {};
|
|
113
|
+
const outerProps = verb.definition['properties'];
|
|
114
|
+
if (!outerProps || !outerProps[verbName])
|
|
115
|
+
return {};
|
|
116
|
+
return outerProps[verbName];
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Get the required properties for a verb's inner config.
|
|
120
|
+
* @param verbName - The verb name.
|
|
121
|
+
* @returns Array of required property names.
|
|
122
|
+
*/
|
|
123
|
+
getVerbRequiredProperties(verbName) {
|
|
124
|
+
const innerSchema = this.getVerbProperties(verbName);
|
|
125
|
+
if (!innerSchema || !Array.isArray(innerSchema['required']))
|
|
126
|
+
return [];
|
|
127
|
+
return innerSchema['required'];
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Get the description text for a verb.
|
|
131
|
+
* @param verbName - The verb name.
|
|
132
|
+
* @returns The description string or empty string.
|
|
133
|
+
*/
|
|
134
|
+
getVerbDescription(verbName) {
|
|
135
|
+
const innerSchema = this.getVerbProperties(verbName);
|
|
136
|
+
return innerSchema['description'] ?? '';
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Check if a verb name is defined in the schema.
|
|
140
|
+
* @param verbName - The verb name.
|
|
141
|
+
* @returns True if the verb exists.
|
|
142
|
+
*/
|
|
143
|
+
hasVerb(verbName) {
|
|
144
|
+
return this.verbs.has(verbName);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Lightweight validation of a verb config against the schema.
|
|
148
|
+
* Checks that the verb exists and required properties are present.
|
|
149
|
+
* Mirrors Python SDK's `_validate_verb_lightweight()`.
|
|
150
|
+
*
|
|
151
|
+
* @param verbName - The verb name.
|
|
152
|
+
* @param config - The verb configuration to validate.
|
|
153
|
+
* @returns Validation result.
|
|
154
|
+
*/
|
|
155
|
+
validateVerb(verbName, config) {
|
|
156
|
+
if (this.skipValidation) {
|
|
157
|
+
return { valid: true, errors: [] };
|
|
158
|
+
}
|
|
159
|
+
const errors = [];
|
|
160
|
+
// Check verb exists
|
|
161
|
+
if (!this.verbs.has(verbName)) {
|
|
162
|
+
errors.push(`Unknown verb: '${verbName}'`);
|
|
163
|
+
return { valid: false, errors };
|
|
164
|
+
}
|
|
165
|
+
const innerSchema = this.getVerbProperties(verbName);
|
|
166
|
+
// If the inner schema is not an object type (e.g. "label" takes a string,
|
|
167
|
+
// "sleep" takes anyOf int/object), skip property checks
|
|
168
|
+
const innerType = innerSchema['type'];
|
|
169
|
+
if (innerType !== 'object') {
|
|
170
|
+
return { valid: true, errors: [] };
|
|
171
|
+
}
|
|
172
|
+
// Config must be an object for object-typed verbs
|
|
173
|
+
if (typeof config !== 'object' || config === null || Array.isArray(config)) {
|
|
174
|
+
// Allow empty config for verbs with no required props
|
|
175
|
+
const required = this.getVerbRequiredProperties(verbName);
|
|
176
|
+
if (required.length > 0) {
|
|
177
|
+
errors.push(`Verb '${verbName}' expects an object config`);
|
|
178
|
+
return { valid: false, errors };
|
|
179
|
+
}
|
|
180
|
+
return { valid: true, errors: [] };
|
|
181
|
+
}
|
|
182
|
+
// Check required properties
|
|
183
|
+
const required = this.getVerbRequiredProperties(verbName);
|
|
184
|
+
const configObj = config;
|
|
185
|
+
for (const prop of required) {
|
|
186
|
+
if (!(prop in configObj)) {
|
|
187
|
+
errors.push(`Missing required property '${prop}' for verb '${verbName}'`);
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
return { valid: errors.length === 0, errors };
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Validate a SWML document against structural rules.
|
|
194
|
+
* @param swml - The SWML document as a JSON string or parsed object.
|
|
195
|
+
* @returns The validation result indicating success or a list of errors.
|
|
196
|
+
*/
|
|
197
|
+
validate(swml) {
|
|
198
|
+
if (this.skipValidation) {
|
|
199
|
+
return { valid: true, errors: [] };
|
|
200
|
+
}
|
|
201
|
+
const swmlStr = typeof swml === 'string' ? swml : JSON.stringify(swml);
|
|
202
|
+
// Check cache
|
|
203
|
+
const cached = this.cache.get(swmlStr);
|
|
204
|
+
if (cached)
|
|
205
|
+
return cached;
|
|
206
|
+
const errors = [];
|
|
207
|
+
let doc;
|
|
208
|
+
try {
|
|
209
|
+
doc = typeof swml === 'string' ? JSON.parse(swml) : swml;
|
|
210
|
+
}
|
|
211
|
+
catch {
|
|
212
|
+
const result = { valid: false, errors: ['Invalid JSON'] };
|
|
213
|
+
this.cacheResult(swmlStr, result);
|
|
214
|
+
return result;
|
|
215
|
+
}
|
|
216
|
+
// Check top-level required keys
|
|
217
|
+
for (const key of REQUIRED_TOP_LEVEL) {
|
|
218
|
+
if (!(key in doc)) {
|
|
219
|
+
errors.push(`Missing required top-level key: ${key}`);
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
// Check version
|
|
223
|
+
if (doc['version'] && !VALID_VERSIONS.includes(doc['version'])) {
|
|
224
|
+
errors.push(`Invalid version: ${doc['version']}. Expected one of: ${VALID_VERSIONS.join(', ')}`);
|
|
225
|
+
}
|
|
226
|
+
// Check sections
|
|
227
|
+
if (doc['sections']) {
|
|
228
|
+
if (typeof doc['sections'] !== 'object' || Array.isArray(doc['sections'])) {
|
|
229
|
+
errors.push('sections must be an object');
|
|
230
|
+
}
|
|
231
|
+
else {
|
|
232
|
+
const sections = doc['sections'];
|
|
233
|
+
if (!('main' in sections)) {
|
|
234
|
+
errors.push('sections must contain a "main" section');
|
|
235
|
+
}
|
|
236
|
+
// Validate each section is an array
|
|
237
|
+
for (const [name, section] of Object.entries(sections)) {
|
|
238
|
+
if (!Array.isArray(section)) {
|
|
239
|
+
errors.push(`Section "${name}" must be an array`);
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
// Validate AI verb structure if present
|
|
245
|
+
if (doc['sections'] && typeof doc['sections'] === 'object') {
|
|
246
|
+
const sections = doc['sections'];
|
|
247
|
+
const main = sections['main'];
|
|
248
|
+
if (Array.isArray(main)) {
|
|
249
|
+
for (const verb of main) {
|
|
250
|
+
if (typeof verb === 'object' && verb !== null && 'ai' in verb) {
|
|
251
|
+
this.validateAiVerb(verb['ai'], errors);
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
const result = {
|
|
257
|
+
valid: errors.length === 0,
|
|
258
|
+
errors,
|
|
259
|
+
};
|
|
260
|
+
this.cacheResult(swmlStr, result);
|
|
261
|
+
return result;
|
|
262
|
+
}
|
|
263
|
+
validateAiVerb(ai, errors) {
|
|
264
|
+
if (!ai)
|
|
265
|
+
return;
|
|
266
|
+
// Prompt must have text
|
|
267
|
+
if (ai['prompt']) {
|
|
268
|
+
const prompt = ai['prompt'];
|
|
269
|
+
if (typeof prompt === 'object' && !prompt['text']) {
|
|
270
|
+
errors.push('AI prompt must have a "text" field');
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
// SWAIG validation
|
|
274
|
+
if (ai['SWAIG']) {
|
|
275
|
+
const swaig = ai['SWAIG'];
|
|
276
|
+
if (swaig['functions'] && !Array.isArray(swaig['functions'])) {
|
|
277
|
+
errors.push('SWAIG functions must be an array');
|
|
278
|
+
}
|
|
279
|
+
if (Array.isArray(swaig['functions'])) {
|
|
280
|
+
for (let i = 0; i < swaig['functions'].length; i++) {
|
|
281
|
+
const fn = swaig['functions'][i];
|
|
282
|
+
if (!fn['function']) {
|
|
283
|
+
errors.push(`SWAIG function at index ${i} missing "function" name`);
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
// Post-prompt validation
|
|
289
|
+
if (ai['post_prompt']) {
|
|
290
|
+
const pp = ai['post_prompt'];
|
|
291
|
+
if (typeof pp === 'object' && !pp['text']) {
|
|
292
|
+
errors.push('AI post_prompt must have a "text" field');
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
/** Clear the validation cache */
|
|
297
|
+
clearCache() {
|
|
298
|
+
this.cache.clear();
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Get the number of cached validation results.
|
|
302
|
+
* @returns The current cache entry count.
|
|
303
|
+
*/
|
|
304
|
+
getCacheSize() {
|
|
305
|
+
return this.cache.size;
|
|
306
|
+
}
|
|
307
|
+
cacheResult(key, result) {
|
|
308
|
+
if (this.cache.size >= this.maxCacheSize) {
|
|
309
|
+
// Remove oldest entry
|
|
310
|
+
const firstKey = this.cache.keys().next().value;
|
|
311
|
+
if (firstKey)
|
|
312
|
+
this.cache.delete(firstKey);
|
|
313
|
+
}
|
|
314
|
+
this.cache.set(key, result);
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
//# sourceMappingURL=SchemaUtils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../src/SchemaUtils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAoBvC,oCAAoC;AACpC,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AACnD,MAAM,cAAc,GAAG,CAAC,OAAO,CAAC,CAAC;AAEjC,wFAAwF;AACxF,MAAM,OAAO,WAAW;IACd,cAAc,CAAU;IACxB,KAAK,GAAkC,IAAI,GAAG,EAAE,CAAC;IACjD,YAAY,CAAS;IACrB,MAAM,GAAmC,IAAI,CAAC;IAC9C,KAAK,GAAgC,IAAI,GAAG,EAAE,CAAC;IACvD,kEAAkE;IAC1D,UAAU,CAAgB;IAElC;;;OAGG;IACH,YAAY,IAA+E;QACzF,IAAI,CAAC,cAAc,GAAG,IAAI,EAAE,cAAc,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,KAAK,MAAM,CAAC,CAAC;QACtG,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,YAAY,IAAI,GAAG,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,UAAU,IAAI,IAAI,CAAC;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACK,UAAU;QAChB,wEAAwE;QACxE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAA4B,CAAC;gBAClE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC3C,OAAO;YACT,CAAC;YAAC,MAAM,CAAC;gBACP,iDAAiD;YACnD,CAAC;QACH,CAAC;QACD,mCAAmC;QACnC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,eAAe,CAA4B,CAAC;YAClE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACP,mEAAmE;YACnE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,sBAAsB;QAC5B,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE/B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC,CAAC;QACzE,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QAExB,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAwC,CAAC;QAC7E,IAAI,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAErE,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,CAA8B,EAAE,CAAC;YACnE,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAuB,CAAC;YAClD,IAAI,CAAC,OAAO;gBAAE,SAAS;YAEvB,oDAAoD;YACpD,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAG,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAwC,CAAC;YACxE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;gBAAE,SAAS;YAEjD,4DAA4D;YAC5D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAA4B,CAAC,CAAC;YAChF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAErC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC9B,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,UAAU;gBACV,UAAU,EAAE,OAAO;aACpB,CAAC,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,QAAgB;QAChC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAwC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QACpD,OAAO,UAAU,CAAC,QAAQ,CAA4B,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CAAC,QAAgB;QACxC,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QACvE,OAAO,WAAW,CAAC,UAAU,CAAa,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAgB;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAQ,WAAW,CAAC,aAAa,CAAY,IAAI,EAAE,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,QAAgB,EAAE,MAAe;QAC5C,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACrC,CAAC;QAED,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,oBAAoB;QACpB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,kBAAkB,QAAQ,GAAG,CAAC,CAAC;YAC3C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAClC,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAErD,0EAA0E;QAC1E,wDAAwD;QACxD,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACrC,CAAC;QAED,kDAAkD;QAClD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3E,sDAAsD;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;YAC1D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC,SAAS,QAAQ,4BAA4B,CAAC,CAAC;gBAC3D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAClC,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACrC,CAAC;QAED,4BAA4B;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,MAAiC,CAAC;QACpD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,CAAC,8BAA8B,IAAI,eAAe,QAAQ,GAAG,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAsC;QAC7C,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACrC,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEvE,cAAc;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;QAE1B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,GAA4B,CAAC;QAEjC,IAAI,CAAC;YACH,GAAG,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,MAAM,GAAqB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5E,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAClC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;YACrC,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,mCAAmC,GAAG,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,gBAAgB;QAChB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAW,CAAC,EAAE,CAAC;YACzE,MAAM,CAAC,IAAI,CAAC,oBAAoB,GAAG,CAAC,SAAS,CAAC,sBAAsB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnG,CAAC;QAED,iBAAiB;QACjB,IAAI,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACpB,IAAI,OAAO,GAAG,CAAC,UAAU,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAC1E,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAA4B,CAAC;gBAC5D,IAAI,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;gBACxD,CAAC;gBACD,oCAAoC;gBACpC,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;wBAC5B,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,oBAAoB,CAAC,CAAC;oBACpD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,wCAAwC;QACxC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,OAAO,GAAG,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC3D,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAA8B,CAAC;YAC9D,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;oBACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;wBAC9D,IAAI,CAAC,cAAc,CAAE,IAAgC,CAAC,IAAI,CAA4B,EAAE,MAAM,CAAC,CAAC;oBAClG,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAqB;YAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;YAC1B,MAAM;SACP,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,cAAc,CAAC,EAA2B,EAAE,MAAgB;QAClE,IAAI,CAAC,EAAE;YAAE,OAAO;QAEhB,wBAAwB;QACxB,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjB,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAA4B,CAAC;YACvD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClD,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,mBAAmB;QACnB,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAA4B,CAAC;YACrD,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;gBAC7D,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;gBACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAI,KAAK,CAAC,WAAW,CAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAClE,MAAM,EAAE,GAAI,KAAK,CAAC,WAAW,CAA+B,CAAC,CAAC,CAAC,CAAC;oBAChE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;wBACpB,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,0BAA0B,CAAC,CAAC;oBACtE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,yBAAyB;QACzB,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;YACtB,MAAM,EAAE,GAAG,EAAE,CAAC,aAAa,CAA4B,CAAC;YACxD,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1C,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;IACH,CAAC;IAED,iCAAiC;IACjC,UAAU;QACR,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAEO,WAAW,CAAC,GAAW,EAAE,MAAwB;QACvD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACzC,sBAAsB;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YAChD,IAAI,QAAQ;gBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC;CACF"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SecurityUtils - Shared security utility functions.
|
|
3
|
+
*
|
|
4
|
+
* Provides prototype pollution protection, SSRF guards, header filtering,
|
|
5
|
+
* URL credential redaction, hostname validation, and input length limits.
|
|
6
|
+
*/
|
|
7
|
+
/** Maximum allowed input length for skill handler arguments (characters). */
|
|
8
|
+
export declare const MAX_SKILL_INPUT_LENGTH = 1000;
|
|
9
|
+
/**
|
|
10
|
+
* Copy properties from `source` to `target`, filtering out prototype-pollution keys.
|
|
11
|
+
* Drop-in replacement for `Object.assign(target, source)` where `source` is untrusted.
|
|
12
|
+
* @param target - The object to assign into.
|
|
13
|
+
* @param source - The object to copy properties from.
|
|
14
|
+
* @returns The target object.
|
|
15
|
+
*/
|
|
16
|
+
export declare function safeAssign<T extends Record<string, unknown>>(target: T, source: Record<string, unknown>): T;
|
|
17
|
+
/**
|
|
18
|
+
* Return a copy of `headers` with sensitive entries (authorization, cookie, etc.) removed.
|
|
19
|
+
* @param headers - Original header record.
|
|
20
|
+
* @returns A new record with sensitive headers removed.
|
|
21
|
+
*/
|
|
22
|
+
export declare function filterSensitiveHeaders(headers: Record<string, string>): Record<string, string>;
|
|
23
|
+
/**
|
|
24
|
+
* Redact credentials embedded in a URL (e.g. `https://user:secret@host` -> `https://user:****@host`).
|
|
25
|
+
* Returns the URL unchanged if no credentials are present.
|
|
26
|
+
* @param url - The URL string to redact.
|
|
27
|
+
* @returns The URL with the password portion replaced by `****`.
|
|
28
|
+
*/
|
|
29
|
+
export declare function redactUrl(url: string): string;
|
|
30
|
+
/**
|
|
31
|
+
* Validate that a hostname string does not contain whitespace, slashes, or control characters.
|
|
32
|
+
* @param host - Hostname to validate.
|
|
33
|
+
* @returns True if the hostname is valid.
|
|
34
|
+
*/
|
|
35
|
+
export declare function isValidHostname(host: string): boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Check whether an IP address belongs to a private/reserved range.
|
|
38
|
+
* Covers RFC1918, loopback, link-local, IPv6 private (fc/fd, ::1, fe80).
|
|
39
|
+
* @param ip - The IP address string to check.
|
|
40
|
+
* @returns True if the IP is private/reserved.
|
|
41
|
+
*/
|
|
42
|
+
export declare function isPrivateIp(ip: string): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* DNS-resolve a URL's hostname and reject it if it points to a private IP.
|
|
45
|
+
* @param url - The full URL to validate.
|
|
46
|
+
* @param allowPrivate - When true, skip the private-IP check (default false).
|
|
47
|
+
* @throws If the resolved IP is private and `allowPrivate` is false.
|
|
48
|
+
*/
|
|
49
|
+
export declare function resolveAndValidateUrl(url: string, allowPrivate?: boolean): Promise<void>;
|
|
50
|
+
/**
|
|
51
|
+
* Validate that a URL is safe to fetch (not pointing to private/internal resources).
|
|
52
|
+
*
|
|
53
|
+
* Matches Python's `validate_url(url, allow_private=False) -> bool` — returns `true`
|
|
54
|
+
* if the URL is safe, `false` otherwise (never throws).
|
|
55
|
+
*
|
|
56
|
+
* @param url - The URL to validate.
|
|
57
|
+
* @param allowPrivate - When true, allow private IP ranges (default false).
|
|
58
|
+
* @returns `true` if the URL is safe to fetch, `false` otherwise.
|
|
59
|
+
*/
|
|
60
|
+
export declare function validateUrl(url: string, allowPrivate?: boolean): Promise<boolean>;
|