@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ParameterSchema — a typed, fluent builder for SWAIG tool parameter schemas.
|
|
3
|
+
*
|
|
4
|
+
* ## Why this exists (the Tier-2 flagship affordance — TS, explicit-params path)
|
|
5
|
+
*
|
|
6
|
+
* A SWAIG tool's parameters are a JSON-Schema `object`: `{ type: 'object',
|
|
7
|
+
* properties: { <name>: { type, description, enum? }, ... }, required: [...] }`.
|
|
8
|
+
* The Python reference (`define_tool(parameters=...)`) takes that as a bare
|
|
9
|
+
* `Dict[str, Any]`, and this SDK mirrors it on
|
|
10
|
+
* {@link ../AgentBase.AgentBase.defineTool} / `defineTypedTool` as
|
|
11
|
+
* `parameters?: Record<string, unknown>` — a fully **untyped blob**. There are
|
|
12
|
+
* two distinct ways a user supplies a tool's parameters in TS:
|
|
13
|
+
*
|
|
14
|
+
* 1. **Inference** — `defineTypedTool` reads the handler's parameter
|
|
15
|
+
* *names + default-value literals* (via {@link ../TypeInference.inferSchema})
|
|
16
|
+
* and synthesises a schema. This is the idiomatic zero-boilerplate path,
|
|
17
|
+
* but it is **lossy by construction**: `fn.toString()` has erased the
|
|
18
|
+
* TypeScript type annotations, so inference can only produce
|
|
19
|
+
* `string`/`integer`/`number`/`boolean` from a literal default — it can
|
|
20
|
+
* **never** emit an `enum`, and it hard-codes each `description` to
|
|
21
|
+
* `"The <name> parameter"` (useless to the model, which reads descriptions
|
|
22
|
+
* as prompt engineering).
|
|
23
|
+
* 2. **Explicit `parameters`** — the user writes the JSON-Schema object by
|
|
24
|
+
* hand. This is the path where `enum`s and real descriptions live. Written
|
|
25
|
+
* inline, `defineTool<P, R>` now infers the handler's `args` from it (both
|
|
26
|
+
* the flat `{name:{…}}` and wrapped `{type:'object',properties}` forms; see
|
|
27
|
+
* {@link ToolArgs}), so explicit parameters are no longer an untyped blob.
|
|
28
|
+
* This builder is the ergonomic way to construct that schema with
|
|
29
|
+
* autocomplete/typo-checking and the Tier-1 closed sets wired in as
|
|
30
|
+
* `enum:[...]` (record format/direction, tap direction, codec).
|
|
31
|
+
*
|
|
32
|
+
* `ParameterSchema` is the **typed builder for path 2** — the idiomatic
|
|
33
|
+
* replacement for the explicit untyped blob. It is **purely additive** and the
|
|
34
|
+
* wire output is **byte-identical** to the equivalent hand-written object:
|
|
35
|
+
* `paramSchema().string('service', 'The service').enum('fmt', RECORD_FORMATS,
|
|
36
|
+
* 'format').required('service').build()` produces exactly the same
|
|
37
|
+
* `{ type:'object', properties:{…}, required:[…] }` the untyped path produces,
|
|
38
|
+
* key-for-key. TypeScript erases types, so the bytes placed on the wire are
|
|
39
|
+
* identical either way — this is autocomplete/typo/closed-set ergonomics with
|
|
40
|
+
* **zero** surface or emission effect (drift stays 0; it is a PORT_ADDITION).
|
|
41
|
+
*
|
|
42
|
+
* The Tier-1 closed-set unions live alongside the value arrays in this module
|
|
43
|
+
* ({@link RECORD_FORMATS} / {@link RECORD_DIRECTIONS} / {@link TAP_DIRECTIONS} /
|
|
44
|
+
* {@link TAP_CODECS}) and are exposed as convenience methods
|
|
45
|
+
* ({@link ParameterSchema.recordFormat} etc.) that bake the closed set in as a
|
|
46
|
+
* typed `enum` property — the same idiom as `SkillName`/`closedSets.ts`, now on
|
|
47
|
+
* the tool-parameter side. See IDIOM_PASS_JOURNAL.md §2 / §4 "Tier 2 flagship".
|
|
48
|
+
*
|
|
49
|
+
* @example Builder with an enum, byte-identical to the explicit blob
|
|
50
|
+
* ```ts
|
|
51
|
+
* agent.defineTool({
|
|
52
|
+
* name: 'get_forecast',
|
|
53
|
+
* description: 'Get a 3-day weather forecast for a location',
|
|
54
|
+
* parameters: paramSchema()
|
|
55
|
+
* .string('location', 'The city or location')
|
|
56
|
+
* .enum('units', ['celsius', 'fahrenheit'], 'Temperature units')
|
|
57
|
+
* .build(),
|
|
58
|
+
* handler: (args) => new FunctionResult(`Forecast for ${args['location']}`),
|
|
59
|
+
* });
|
|
60
|
+
* // parameters is identical to writing:
|
|
61
|
+
* // { type: 'object', properties: {
|
|
62
|
+
* // location: { type: 'string', description: 'The city or location' },
|
|
63
|
+
* // units: { type: 'string', description: 'Temperature units',
|
|
64
|
+
* // enum: ['celsius', 'fahrenheit'] } } }
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
/**
|
|
68
|
+
* Recording format for the SWAIG `record_call` verb — the strongly-grounded
|
|
69
|
+
* Tier-1 closed set (`function_result.py:914` `raise ValueError`-validated;
|
|
70
|
+
* SWML `$defs/RecordCall.format`). Used by {@link ParameterSchema.recordFormat}.
|
|
71
|
+
*/
|
|
72
|
+
export declare const RECORD_FORMATS: readonly ["wav", "mp3", "mp4"];
|
|
73
|
+
/** A single {@link RECORD_FORMATS} value. */
|
|
74
|
+
export type RecordFormat = (typeof RECORD_FORMATS)[number];
|
|
75
|
+
/**
|
|
76
|
+
* Recording direction for the SWAIG `record_call` verb — Tier-1 closed set
|
|
77
|
+
* (`function_result.py:918`). NOTE: distinct from {@link TAP_DIRECTIONS} —
|
|
78
|
+
* record uses `listen`, tap uses `hear` (never unify; see journal §3 "three
|
|
79
|
+
* direction vocabularies"). Used by {@link ParameterSchema.recordDirection}.
|
|
80
|
+
*/
|
|
81
|
+
export declare const RECORD_DIRECTIONS: readonly ["speak", "listen", "both"];
|
|
82
|
+
/** A single {@link RECORD_DIRECTIONS} value. */
|
|
83
|
+
export type RecordDirection = (typeof RECORD_DIRECTIONS)[number];
|
|
84
|
+
/**
|
|
85
|
+
* Tap direction for the SWAIG `tap` verb — Tier-1 closed set
|
|
86
|
+
* (`function_result.py:1370`): `speak`, `listen` or `both`, as the engine accepts. Used by
|
|
87
|
+
* {@link ParameterSchema.tapDirection}.
|
|
88
|
+
*/
|
|
89
|
+
export declare const TAP_DIRECTIONS: readonly ["speak", "listen", "both"];
|
|
90
|
+
/** A single {@link TAP_DIRECTIONS} value. */
|
|
91
|
+
export type TapDirection = (typeof TAP_DIRECTIONS)[number];
|
|
92
|
+
/**
|
|
93
|
+
* Tap media codec for the SWAIG `tap` verb — Tier-1 closed set
|
|
94
|
+
* (`function_result.py:1218`). The 2-value SWAIG tap codec, distinct from the
|
|
95
|
+
* 7-value RELAY connect/stream codec superset (never reuse). Used by
|
|
96
|
+
* {@link ParameterSchema.codec}.
|
|
97
|
+
*/
|
|
98
|
+
export declare const TAP_CODECS: readonly ["PCMU", "PCMA"];
|
|
99
|
+
/** A single {@link TAP_CODECS} value. */
|
|
100
|
+
export type TapCodec = (typeof TAP_CODECS)[number];
|
|
101
|
+
/** The JSON-Schema scalar `type` keywords a SWAIG parameter property may use. */
|
|
102
|
+
export type ParameterType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
|
|
103
|
+
/**
|
|
104
|
+
* A single JSON-Schema property entry inside a tool's `parameters.properties`.
|
|
105
|
+
* Mirrors the shape the model reads on every turn: `type` + LLM-facing
|
|
106
|
+
* `description`, with an optional `enum` / `items` and any extra JSON-Schema
|
|
107
|
+
* keywords (`minLength`, `pattern`, `format`, …) merged through verbatim.
|
|
108
|
+
*/
|
|
109
|
+
export interface ParameterProperty {
|
|
110
|
+
type: ParameterType;
|
|
111
|
+
description: string;
|
|
112
|
+
enum?: readonly unknown[];
|
|
113
|
+
items?: Record<string, unknown>;
|
|
114
|
+
[extra: string]: unknown;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* The serialised SWAIG parameter schema: a JSON-Schema `object`. This is the
|
|
118
|
+
* exact shape `defineTool({ parameters })` accepts and what the SDK renders
|
|
119
|
+
* into the OpenAI tool schema's `parameters` field.
|
|
120
|
+
*/
|
|
121
|
+
export interface ParameterSchemaObject {
|
|
122
|
+
type: 'object';
|
|
123
|
+
properties: Record<string, ParameterProperty>;
|
|
124
|
+
required?: string[];
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* One property entry in a tool's flat parameter map, precise enough to read.
|
|
128
|
+
* Extra JSON-Schema keywords (`minLength`, `pattern`, `format`, nested wrapped
|
|
129
|
+
* forms, …) pass through via the index signature, so existing callers that
|
|
130
|
+
* carry more than `{type,description}` still satisfy it.
|
|
131
|
+
*/
|
|
132
|
+
export interface PropSchema {
|
|
133
|
+
type: ParameterType;
|
|
134
|
+
description?: string;
|
|
135
|
+
enum?: readonly unknown[];
|
|
136
|
+
/** Element schema, for `type: 'array'`. */
|
|
137
|
+
items?: PropSchema;
|
|
138
|
+
/** Nested property map, for `type: 'object'`. */
|
|
139
|
+
properties?: Record<string, PropSchema>;
|
|
140
|
+
[extra: string]: unknown;
|
|
141
|
+
}
|
|
142
|
+
/** The flat `name → PropSchema` map `defineTool({ parameters })` accepts. */
|
|
143
|
+
export type ParametersSchema = Record<string, PropSchema>;
|
|
144
|
+
/** The WRAPPED JSON-Schema object form: `{ type:'object', properties, required }`. */
|
|
145
|
+
export interface WrappedParametersSchema {
|
|
146
|
+
type: 'object';
|
|
147
|
+
properties?: ParametersSchema;
|
|
148
|
+
required?: readonly string[];
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Accepted `parameters` shapes for `defineTool`. BOTH the FLAT map
|
|
152
|
+
* (`{ name: {…} }`) and the WRAPPED JSON-Schema object
|
|
153
|
+
* (`{ type:'object', properties, required }`) drive `InferArgs`; a pre-built
|
|
154
|
+
* loose `Record` is also accepted (it can't be inferred → open-record args).
|
|
155
|
+
*/
|
|
156
|
+
export type ToolParameters = ParametersSchema | WrappedParametersSchema | Record<string, unknown>;
|
|
157
|
+
/**
|
|
158
|
+
* The handler-args type for a given `parameters` (`P`) + `required` (`R`).
|
|
159
|
+
* Infers from BOTH the flat map and the wrapped `{type:'object',properties}`
|
|
160
|
+
* form. For the wrapped form, optionality comes from the schema's OWN
|
|
161
|
+
* `required` array (`R` applies to the flat form, where `required` is a
|
|
162
|
+
* separate `defineTool` argument). A loose `Record` with no readable
|
|
163
|
+
* `properties` degrades to the open `Record<string, unknown>`, so existing
|
|
164
|
+
* pre-built-schema callers keep their prior untyped-args behavior.
|
|
165
|
+
*/
|
|
166
|
+
export type ToolArgs<P, R extends readonly PropertyKey[]> = P extends {
|
|
167
|
+
type: 'object';
|
|
168
|
+
properties: infer Props extends ParametersSchema;
|
|
169
|
+
} ? InferArgs<Props, P extends {
|
|
170
|
+
required: infer WR extends readonly (keyof Props)[];
|
|
171
|
+
} ? WR : []> : P extends {
|
|
172
|
+
type: 'object';
|
|
173
|
+
} ? Record<string, unknown> : P extends ParametersSchema ? InferArgs<P, R extends readonly (keyof P)[] ? R : []> : Record<string, unknown>;
|
|
174
|
+
/** Map a single property's schema to the TS type the handler sees for it. */
|
|
175
|
+
export type PropToTs<P extends PropSchema> = P extends {
|
|
176
|
+
enum: readonly (infer E)[];
|
|
177
|
+
} ? E : P['type'] extends 'string' ? string : P['type'] extends 'number' | 'integer' ? number : P['type'] extends 'boolean' ? boolean : P['type'] extends 'array' ? P extends {
|
|
178
|
+
items: infer I extends PropSchema;
|
|
179
|
+
} ? PropToTs<I>[] : unknown[] : P['type'] extends 'object' ? P extends {
|
|
180
|
+
properties: infer Pr extends ParametersSchema;
|
|
181
|
+
} ? InferArgs<Pr> : Record<string, unknown> : unknown;
|
|
182
|
+
/**
|
|
183
|
+
* Map a whole flat parameter map to the handler's `args` type, splitting
|
|
184
|
+
* required keys (present) from the rest (optional) per the `required` list `R`.
|
|
185
|
+
* Default `R = []` makes every prop optional (matches "no required list").
|
|
186
|
+
*/
|
|
187
|
+
export type InferArgs<P extends ParametersSchema, R extends readonly (keyof P)[] = []> = {
|
|
188
|
+
[K in keyof P as K extends R[number] ? K : never]: PropToTs<P[K]>;
|
|
189
|
+
} & {
|
|
190
|
+
[K in keyof P as K extends R[number] ? never : K]?: PropToTs<P[K]>;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* Fluent builder producing a {@link ParameterSchemaObject} byte-identical to
|
|
194
|
+
* the equivalent hand-written `parameters` blob. Every method returns `this`
|
|
195
|
+
* for chaining; call {@link build} to obtain the plain object to hand to
|
|
196
|
+
* `defineTool`/`defineTypedTool`.
|
|
197
|
+
*
|
|
198
|
+
* Insertion order is preserved: properties appear in the order their methods
|
|
199
|
+
* were called (matching a hand-written object literal), and `required` lists
|
|
200
|
+
* names in the order {@link required} received them.
|
|
201
|
+
*/
|
|
202
|
+
export declare class ParameterSchema {
|
|
203
|
+
private readonly _properties;
|
|
204
|
+
private readonly _required;
|
|
205
|
+
/**
|
|
206
|
+
* Add a property with an explicit JSON-Schema `type`.
|
|
207
|
+
*
|
|
208
|
+
* @param name - Parameter name (the JSON key the model emits).
|
|
209
|
+
* @param type - JSON-Schema scalar type keyword.
|
|
210
|
+
* @param description - LLM-facing description (prompt engineering; tells the
|
|
211
|
+
* model HOW to fill this argument). Defaults to `''` to match a
|
|
212
|
+
* hand-written entry that omits a description.
|
|
213
|
+
* @param extra - Additional JSON-Schema keywords merged into the property
|
|
214
|
+
* verbatim (`enum`, `minLength`, `pattern`, `format`, `items`, …).
|
|
215
|
+
* @returns This builder, for chaining.
|
|
216
|
+
*/
|
|
217
|
+
property(name: string, type: ParameterType, description?: string, extra?: Record<string, unknown>): this;
|
|
218
|
+
/** Add a `string` property. @see {@link property} */
|
|
219
|
+
string(name: string, description?: string, extra?: Record<string, unknown>): this;
|
|
220
|
+
/** Add an `integer` property. @see {@link property} */
|
|
221
|
+
integer(name: string, description?: string, extra?: Record<string, unknown>): this;
|
|
222
|
+
/** Add a `number` (float) property. @see {@link property} */
|
|
223
|
+
number(name: string, description?: string, extra?: Record<string, unknown>): this;
|
|
224
|
+
/** Add a `boolean` property. @see {@link property} */
|
|
225
|
+
boolean(name: string, description?: string, extra?: Record<string, unknown>): this;
|
|
226
|
+
/**
|
|
227
|
+
* Add an `array` property.
|
|
228
|
+
*
|
|
229
|
+
* @param name - Parameter name.
|
|
230
|
+
* @param items - JSON-Schema for the array's element type (e.g.
|
|
231
|
+
* `{ type: 'string' }`). Omit for an untyped array.
|
|
232
|
+
* @param description - LLM-facing description.
|
|
233
|
+
* @returns This builder, for chaining.
|
|
234
|
+
*/
|
|
235
|
+
array(name: string, items?: Record<string, unknown>, description?: string): this;
|
|
236
|
+
/**
|
|
237
|
+
* Add a `string` property constrained to a closed set of values, rendered as
|
|
238
|
+
* `enum:[...]` — the JSON-Schema form the model and the SignalWire validator
|
|
239
|
+
* both honour. This is the typed-closed-set affordance: pass one of the
|
|
240
|
+
* exported Tier-1 value arrays ({@link RECORD_FORMATS} etc.) or any literal
|
|
241
|
+
* list, and the values land verbatim in `enum`.
|
|
242
|
+
*
|
|
243
|
+
* @param name - Parameter name.
|
|
244
|
+
* @param values - The allowed values (a `readonly` array — the `as const`
|
|
245
|
+
* Tier-1 arrays are accepted directly). Emitted as `enum`, in order.
|
|
246
|
+
* @param description - LLM-facing description.
|
|
247
|
+
* @param type - The JSON-Schema base type for the enum (default `'string'`).
|
|
248
|
+
* @returns This builder, for chaining.
|
|
249
|
+
*/
|
|
250
|
+
enum(name: string, values: readonly unknown[], description?: string, type?: ParameterType): this;
|
|
251
|
+
/**
|
|
252
|
+
* Add a `record_call` **format** property (`enum: ['wav','mp3','mp4']`) — the
|
|
253
|
+
* Tier-1 closed set baked in. @see {@link RECORD_FORMATS}
|
|
254
|
+
*/
|
|
255
|
+
recordFormat(name: string, description?: string): this;
|
|
256
|
+
/**
|
|
257
|
+
* Add a `record_call` **direction** property
|
|
258
|
+
* (`enum: ['speak','listen','both']`). Uses record's `listen` (not tap's
|
|
259
|
+
* `hear`). @see {@link RECORD_DIRECTIONS}
|
|
260
|
+
*/
|
|
261
|
+
recordDirection(name: string, description?: string): this;
|
|
262
|
+
/**
|
|
263
|
+
* Add a `tap` **direction** property (`enum: ['speak','hear','both']`). Uses
|
|
264
|
+
* tap's `hear` (not record's `listen`). @see {@link TAP_DIRECTIONS}
|
|
265
|
+
*/
|
|
266
|
+
tapDirection(name: string, description?: string): this;
|
|
267
|
+
/**
|
|
268
|
+
* Add a `tap` **codec** property (`enum: ['PCMU','PCMA']`) — the 2-value
|
|
269
|
+
* SWAIG tap codec (NOT the 7-value RELAY superset). @see {@link TAP_CODECS}
|
|
270
|
+
*/
|
|
271
|
+
codec(name: string, description?: string): this;
|
|
272
|
+
/**
|
|
273
|
+
* Mark one or more already-added properties as required. Names are appended
|
|
274
|
+
* to the `required` array in the order received; duplicates are ignored.
|
|
275
|
+
* Required-ness is independent of property order — call this at any point.
|
|
276
|
+
*
|
|
277
|
+
* @param names - Parameter names to require.
|
|
278
|
+
* @returns This builder, for chaining.
|
|
279
|
+
*/
|
|
280
|
+
required(...names: string[]): this;
|
|
281
|
+
/**
|
|
282
|
+
* Materialise the JSON-Schema `object`. Produces
|
|
283
|
+
* `{ type: 'object', properties: {…} }`, plus `required: [...]` only when at
|
|
284
|
+
* least one property was marked required — exactly matching a hand-written
|
|
285
|
+
* blob (an omitted `required` is the same as `defineTool` receiving none).
|
|
286
|
+
*
|
|
287
|
+
* @returns A fresh {@link ParameterSchemaObject}; safe to mutate without
|
|
288
|
+
* affecting the builder.
|
|
289
|
+
*/
|
|
290
|
+
build(): ParameterSchemaObject;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Create a new {@link ParameterSchema} builder — the idiomatic entry point.
|
|
294
|
+
*
|
|
295
|
+
* @returns A fresh, empty builder.
|
|
296
|
+
*
|
|
297
|
+
* @example
|
|
298
|
+
* ```ts
|
|
299
|
+
* const params = paramSchema()
|
|
300
|
+
* .string('service', 'The service to look up')
|
|
301
|
+
* .codec('media_codec', 'Audio codec for the tap')
|
|
302
|
+
* .required('service')
|
|
303
|
+
* .build();
|
|
304
|
+
* ```
|
|
305
|
+
*/
|
|
306
|
+
export declare function paramSchema(): ParameterSchema;
|
|
@@ -0,0 +1,251 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ParameterSchema — a typed, fluent builder for SWAIG tool parameter schemas.
|
|
3
|
+
*
|
|
4
|
+
* ## Why this exists (the Tier-2 flagship affordance — TS, explicit-params path)
|
|
5
|
+
*
|
|
6
|
+
* A SWAIG tool's parameters are a JSON-Schema `object`: `{ type: 'object',
|
|
7
|
+
* properties: { <name>: { type, description, enum? }, ... }, required: [...] }`.
|
|
8
|
+
* The Python reference (`define_tool(parameters=...)`) takes that as a bare
|
|
9
|
+
* `Dict[str, Any]`, and this SDK mirrors it on
|
|
10
|
+
* {@link ../AgentBase.AgentBase.defineTool} / `defineTypedTool` as
|
|
11
|
+
* `parameters?: Record<string, unknown>` — a fully **untyped blob**. There are
|
|
12
|
+
* two distinct ways a user supplies a tool's parameters in TS:
|
|
13
|
+
*
|
|
14
|
+
* 1. **Inference** — `defineTypedTool` reads the handler's parameter
|
|
15
|
+
* *names + default-value literals* (via {@link ../TypeInference.inferSchema})
|
|
16
|
+
* and synthesises a schema. This is the idiomatic zero-boilerplate path,
|
|
17
|
+
* but it is **lossy by construction**: `fn.toString()` has erased the
|
|
18
|
+
* TypeScript type annotations, so inference can only produce
|
|
19
|
+
* `string`/`integer`/`number`/`boolean` from a literal default — it can
|
|
20
|
+
* **never** emit an `enum`, and it hard-codes each `description` to
|
|
21
|
+
* `"The <name> parameter"` (useless to the model, which reads descriptions
|
|
22
|
+
* as prompt engineering).
|
|
23
|
+
* 2. **Explicit `parameters`** — the user writes the JSON-Schema object by
|
|
24
|
+
* hand. This is the path where `enum`s and real descriptions live. Written
|
|
25
|
+
* inline, `defineTool<P, R>` now infers the handler's `args` from it (both
|
|
26
|
+
* the flat `{name:{…}}` and wrapped `{type:'object',properties}` forms; see
|
|
27
|
+
* {@link ToolArgs}), so explicit parameters are no longer an untyped blob.
|
|
28
|
+
* This builder is the ergonomic way to construct that schema with
|
|
29
|
+
* autocomplete/typo-checking and the Tier-1 closed sets wired in as
|
|
30
|
+
* `enum:[...]` (record format/direction, tap direction, codec).
|
|
31
|
+
*
|
|
32
|
+
* `ParameterSchema` is the **typed builder for path 2** — the idiomatic
|
|
33
|
+
* replacement for the explicit untyped blob. It is **purely additive** and the
|
|
34
|
+
* wire output is **byte-identical** to the equivalent hand-written object:
|
|
35
|
+
* `paramSchema().string('service', 'The service').enum('fmt', RECORD_FORMATS,
|
|
36
|
+
* 'format').required('service').build()` produces exactly the same
|
|
37
|
+
* `{ type:'object', properties:{…}, required:[…] }` the untyped path produces,
|
|
38
|
+
* key-for-key. TypeScript erases types, so the bytes placed on the wire are
|
|
39
|
+
* identical either way — this is autocomplete/typo/closed-set ergonomics with
|
|
40
|
+
* **zero** surface or emission effect (drift stays 0; it is a PORT_ADDITION).
|
|
41
|
+
*
|
|
42
|
+
* The Tier-1 closed-set unions live alongside the value arrays in this module
|
|
43
|
+
* ({@link RECORD_FORMATS} / {@link RECORD_DIRECTIONS} / {@link TAP_DIRECTIONS} /
|
|
44
|
+
* {@link TAP_CODECS}) and are exposed as convenience methods
|
|
45
|
+
* ({@link ParameterSchema.recordFormat} etc.) that bake the closed set in as a
|
|
46
|
+
* typed `enum` property — the same idiom as `SkillName`/`closedSets.ts`, now on
|
|
47
|
+
* the tool-parameter side. See IDIOM_PASS_JOURNAL.md §2 / §4 "Tier 2 flagship".
|
|
48
|
+
*
|
|
49
|
+
* @example Builder with an enum, byte-identical to the explicit blob
|
|
50
|
+
* ```ts
|
|
51
|
+
* agent.defineTool({
|
|
52
|
+
* name: 'get_forecast',
|
|
53
|
+
* description: 'Get a 3-day weather forecast for a location',
|
|
54
|
+
* parameters: paramSchema()
|
|
55
|
+
* .string('location', 'The city or location')
|
|
56
|
+
* .enum('units', ['celsius', 'fahrenheit'], 'Temperature units')
|
|
57
|
+
* .build(),
|
|
58
|
+
* handler: (args) => new FunctionResult(`Forecast for ${args['location']}`),
|
|
59
|
+
* });
|
|
60
|
+
* // parameters is identical to writing:
|
|
61
|
+
* // { type: 'object', properties: {
|
|
62
|
+
* // location: { type: 'string', description: 'The city or location' },
|
|
63
|
+
* // units: { type: 'string', description: 'Temperature units',
|
|
64
|
+
* // enum: ['celsius', 'fahrenheit'] } } }
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
/**
|
|
68
|
+
* Recording format for the SWAIG `record_call` verb — the strongly-grounded
|
|
69
|
+
* Tier-1 closed set (`function_result.py:914` `raise ValueError`-validated;
|
|
70
|
+
* SWML `$defs/RecordCall.format`). Used by {@link ParameterSchema.recordFormat}.
|
|
71
|
+
*/
|
|
72
|
+
export const RECORD_FORMATS = ['wav', 'mp3', 'mp4'];
|
|
73
|
+
/**
|
|
74
|
+
* Recording direction for the SWAIG `record_call` verb — Tier-1 closed set
|
|
75
|
+
* (`function_result.py:918`). NOTE: distinct from {@link TAP_DIRECTIONS} —
|
|
76
|
+
* record uses `listen`, tap uses `hear` (never unify; see journal §3 "three
|
|
77
|
+
* direction vocabularies"). Used by {@link ParameterSchema.recordDirection}.
|
|
78
|
+
*/
|
|
79
|
+
export const RECORD_DIRECTIONS = ['speak', 'listen', 'both'];
|
|
80
|
+
/**
|
|
81
|
+
* Tap direction for the SWAIG `tap` verb — Tier-1 closed set
|
|
82
|
+
* (`function_result.py:1370`): `speak`, `listen` or `both`, as the engine accepts. Used by
|
|
83
|
+
* {@link ParameterSchema.tapDirection}.
|
|
84
|
+
*/
|
|
85
|
+
export const TAP_DIRECTIONS = ['speak', 'listen', 'both'];
|
|
86
|
+
/**
|
|
87
|
+
* Tap media codec for the SWAIG `tap` verb — Tier-1 closed set
|
|
88
|
+
* (`function_result.py:1218`). The 2-value SWAIG tap codec, distinct from the
|
|
89
|
+
* 7-value RELAY connect/stream codec superset (never reuse). Used by
|
|
90
|
+
* {@link ParameterSchema.codec}.
|
|
91
|
+
*/
|
|
92
|
+
export const TAP_CODECS = ['PCMU', 'PCMA'];
|
|
93
|
+
/**
|
|
94
|
+
* Fluent builder producing a {@link ParameterSchemaObject} byte-identical to
|
|
95
|
+
* the equivalent hand-written `parameters` blob. Every method returns `this`
|
|
96
|
+
* for chaining; call {@link build} to obtain the plain object to hand to
|
|
97
|
+
* `defineTool`/`defineTypedTool`.
|
|
98
|
+
*
|
|
99
|
+
* Insertion order is preserved: properties appear in the order their methods
|
|
100
|
+
* were called (matching a hand-written object literal), and `required` lists
|
|
101
|
+
* names in the order {@link required} received them.
|
|
102
|
+
*/
|
|
103
|
+
export class ParameterSchema {
|
|
104
|
+
_properties = {};
|
|
105
|
+
_required = [];
|
|
106
|
+
/**
|
|
107
|
+
* Add a property with an explicit JSON-Schema `type`.
|
|
108
|
+
*
|
|
109
|
+
* @param name - Parameter name (the JSON key the model emits).
|
|
110
|
+
* @param type - JSON-Schema scalar type keyword.
|
|
111
|
+
* @param description - LLM-facing description (prompt engineering; tells the
|
|
112
|
+
* model HOW to fill this argument). Defaults to `''` to match a
|
|
113
|
+
* hand-written entry that omits a description.
|
|
114
|
+
* @param extra - Additional JSON-Schema keywords merged into the property
|
|
115
|
+
* verbatim (`enum`, `minLength`, `pattern`, `format`, `items`, …).
|
|
116
|
+
* @returns This builder, for chaining.
|
|
117
|
+
*/
|
|
118
|
+
property(name, type, description = '', extra) {
|
|
119
|
+
this._properties[name] = { type, description, ...(extra ?? {}) };
|
|
120
|
+
return this;
|
|
121
|
+
}
|
|
122
|
+
/** Add a `string` property. @see {@link property} */
|
|
123
|
+
string(name, description = '', extra) {
|
|
124
|
+
return this.property(name, 'string', description, extra);
|
|
125
|
+
}
|
|
126
|
+
/** Add an `integer` property. @see {@link property} */
|
|
127
|
+
integer(name, description = '', extra) {
|
|
128
|
+
return this.property(name, 'integer', description, extra);
|
|
129
|
+
}
|
|
130
|
+
/** Add a `number` (float) property. @see {@link property} */
|
|
131
|
+
number(name, description = '', extra) {
|
|
132
|
+
return this.property(name, 'number', description, extra);
|
|
133
|
+
}
|
|
134
|
+
/** Add a `boolean` property. @see {@link property} */
|
|
135
|
+
boolean(name, description = '', extra) {
|
|
136
|
+
return this.property(name, 'boolean', description, extra);
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Add an `array` property.
|
|
140
|
+
*
|
|
141
|
+
* @param name - Parameter name.
|
|
142
|
+
* @param items - JSON-Schema for the array's element type (e.g.
|
|
143
|
+
* `{ type: 'string' }`). Omit for an untyped array.
|
|
144
|
+
* @param description - LLM-facing description.
|
|
145
|
+
* @returns This builder, for chaining.
|
|
146
|
+
*/
|
|
147
|
+
array(name, items, description = '') {
|
|
148
|
+
const extra = items ? { items } : undefined;
|
|
149
|
+
return this.property(name, 'array', description, extra);
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Add a `string` property constrained to a closed set of values, rendered as
|
|
153
|
+
* `enum:[...]` — the JSON-Schema form the model and the SignalWire validator
|
|
154
|
+
* both honour. This is the typed-closed-set affordance: pass one of the
|
|
155
|
+
* exported Tier-1 value arrays ({@link RECORD_FORMATS} etc.) or any literal
|
|
156
|
+
* list, and the values land verbatim in `enum`.
|
|
157
|
+
*
|
|
158
|
+
* @param name - Parameter name.
|
|
159
|
+
* @param values - The allowed values (a `readonly` array — the `as const`
|
|
160
|
+
* Tier-1 arrays are accepted directly). Emitted as `enum`, in order.
|
|
161
|
+
* @param description - LLM-facing description.
|
|
162
|
+
* @param type - The JSON-Schema base type for the enum (default `'string'`).
|
|
163
|
+
* @returns This builder, for chaining.
|
|
164
|
+
*/
|
|
165
|
+
enum(name, values, description = '', type = 'string') {
|
|
166
|
+
// Copy into a fresh mutable array so the builder owns its data (a caller's
|
|
167
|
+
// `as const` array is readonly; build() must hand back a plain array that
|
|
168
|
+
// serialises identically to a hand-written `enum: [...]` literal).
|
|
169
|
+
return this.property(name, type, description, { enum: [...values] });
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Add a `record_call` **format** property (`enum: ['wav','mp3','mp4']`) — the
|
|
173
|
+
* Tier-1 closed set baked in. @see {@link RECORD_FORMATS}
|
|
174
|
+
*/
|
|
175
|
+
recordFormat(name, description = '') {
|
|
176
|
+
return this.enum(name, RECORD_FORMATS, description);
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Add a `record_call` **direction** property
|
|
180
|
+
* (`enum: ['speak','listen','both']`). Uses record's `listen` (not tap's
|
|
181
|
+
* `hear`). @see {@link RECORD_DIRECTIONS}
|
|
182
|
+
*/
|
|
183
|
+
recordDirection(name, description = '') {
|
|
184
|
+
return this.enum(name, RECORD_DIRECTIONS, description);
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Add a `tap` **direction** property (`enum: ['speak','hear','both']`). Uses
|
|
188
|
+
* tap's `hear` (not record's `listen`). @see {@link TAP_DIRECTIONS}
|
|
189
|
+
*/
|
|
190
|
+
tapDirection(name, description = '') {
|
|
191
|
+
return this.enum(name, TAP_DIRECTIONS, description);
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Add a `tap` **codec** property (`enum: ['PCMU','PCMA']`) — the 2-value
|
|
195
|
+
* SWAIG tap codec (NOT the 7-value RELAY superset). @see {@link TAP_CODECS}
|
|
196
|
+
*/
|
|
197
|
+
codec(name, description = '') {
|
|
198
|
+
return this.enum(name, TAP_CODECS, description);
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Mark one or more already-added properties as required. Names are appended
|
|
202
|
+
* to the `required` array in the order received; duplicates are ignored.
|
|
203
|
+
* Required-ness is independent of property order — call this at any point.
|
|
204
|
+
*
|
|
205
|
+
* @param names - Parameter names to require.
|
|
206
|
+
* @returns This builder, for chaining.
|
|
207
|
+
*/
|
|
208
|
+
required(...names) {
|
|
209
|
+
for (const n of names) {
|
|
210
|
+
if (!this._required.includes(n))
|
|
211
|
+
this._required.push(n);
|
|
212
|
+
}
|
|
213
|
+
return this;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Materialise the JSON-Schema `object`. Produces
|
|
217
|
+
* `{ type: 'object', properties: {…} }`, plus `required: [...]` only when at
|
|
218
|
+
* least one property was marked required — exactly matching a hand-written
|
|
219
|
+
* blob (an omitted `required` is the same as `defineTool` receiving none).
|
|
220
|
+
*
|
|
221
|
+
* @returns A fresh {@link ParameterSchemaObject}; safe to mutate without
|
|
222
|
+
* affecting the builder.
|
|
223
|
+
*/
|
|
224
|
+
build() {
|
|
225
|
+
const out = {
|
|
226
|
+
type: 'object',
|
|
227
|
+
properties: { ...this._properties },
|
|
228
|
+
};
|
|
229
|
+
if (this._required.length)
|
|
230
|
+
out.required = [...this._required];
|
|
231
|
+
return out;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Create a new {@link ParameterSchema} builder — the idiomatic entry point.
|
|
236
|
+
*
|
|
237
|
+
* @returns A fresh, empty builder.
|
|
238
|
+
*
|
|
239
|
+
* @example
|
|
240
|
+
* ```ts
|
|
241
|
+
* const params = paramSchema()
|
|
242
|
+
* .string('service', 'The service to look up')
|
|
243
|
+
* .codec('media_codec', 'Audio codec for the tap')
|
|
244
|
+
* .required('service')
|
|
245
|
+
* .build();
|
|
246
|
+
* ```
|
|
247
|
+
*/
|
|
248
|
+
export function paramSchema() {
|
|
249
|
+
return new ParameterSchema();
|
|
250
|
+
}
|
|
251
|
+
//# sourceMappingURL=ParameterSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ParameterSchema.js","sourceRoot":"","sources":["../src/ParameterSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAU,CAAC;AAI7D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAItE;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAInE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAU,CAAC;AAoIpD;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAe;IACT,WAAW,GAAsC,EAAE,CAAC;IACpD,SAAS,GAAa,EAAE,CAAC;IAE1C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAY,EACZ,IAAmB,EACnB,WAAW,GAAG,EAAE,EAChB,KAA+B;QAE/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,EAAuB,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD,MAAM,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE,EAAE,KAA+B;QACpE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,uDAAuD;IACvD,OAAO,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE,EAAE,KAA+B;QACrE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,6DAA6D;IAC7D,MAAM,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE,EAAE,KAA+B;QACpE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,sDAAsD;IACtD,OAAO,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE,EAAE,KAA+B;QACrE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAY,EAAE,KAA+B,EAAE,WAAW,GAAG,EAAE;QACnE,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,IAAY,EACZ,MAA0B,EAC1B,WAAW,GAAG,EAAE,EAChB,OAAsB,QAAQ;QAE9B,2EAA2E;QAC3E,0EAA0E;QAC1E,mEAAmE;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAY,EAAE,WAAW,GAAG,EAAE;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,GAAG,KAAe;QACzB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK;QACH,MAAM,GAAG,GAA0B;YACjC,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE;SACpC,CAAC;QACF,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM;YAAE,GAAG,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9D,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,IAAI,eAAe,EAAE,CAAC;AAC/B,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Platform contract types — the dynamic-SWML request body the backend POSTs to a
|
|
3
|
+
* SWML request handler, and the error body the Compatibility REST API returns.
|
|
4
|
+
*
|
|
5
|
+
* These are generated from the SignalWire SWML webhook contract (a faithful
|
|
6
|
+
* transcription of the documented SWML request/response shapes and the
|
|
7
|
+
* Compatibility REST error body).
|
|
8
|
+
* This file is a thin barrel re-exporting the generated types so every consumer
|
|
9
|
+
* keeps a stable `./PlatformContracts.js` import path; regenerate via
|
|
10
|
+
* `npx tsx scripts/generate-rest-types.ts`. Do not hand-edit the shapes here —
|
|
11
|
+
* edit the spec and regenerate.
|
|
12
|
+
*
|
|
13
|
+
* NOTE: the SWAIG payloads (function-request + post-prompt) are NOT re-exported
|
|
14
|
+
* here — they now come from the AUTHORITATIVE mod_openai engine specs via
|
|
15
|
+
* `./SwaigContracts.js` (SwaigRequest / PostPrompt), matching the Python
|
|
16
|
+
* reference. The swml-webhooks spec's own SwaigRequestData / PostPromptData* are
|
|
17
|
+
* the superseded non-authoritative derivatives (see SwaigContracts.generated.ts);
|
|
18
|
+
* they remain in PlatformContracts.generated.ts only until the SWAIG schemas are
|
|
19
|
+
* dropped from the shared swml-webhooks spec (a coupled cross-port spec change).
|
|
20
|
+
*/
|
|
21
|
+
export type { SwmlRequestData, SwmlRequestCall, SignalWireErrorBody, } from './PlatformContracts.generated.js';
|