@signalwire/sdk 2.0.5 → 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 +481 -126
- package/dist/AgentBase.js +1502 -438
- 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 +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- 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 +18 -0
- package/dist/PomBuilder.js +53 -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 +22 -1
- package/dist/PromptManager.js +28 -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 +158 -58
- package/dist/SWMLService.js +435 -127
- 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 +49 -9
- package/dist/SecurityUtils.js +153 -51
- 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 +92 -33
- 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 -371
- 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 +47 -68
- package/dist/index.js +44 -73
- 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 +44 -17
- package/dist/relay/RelayClient.js +175 -65
- 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 +73 -42
- 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 +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -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 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- 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 +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- 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 +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- 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 +18 -6
- 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 +21 -22
- 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 +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- 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 +38 -30
- 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 +294 -100
- 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 +14 -13
- 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 +59 -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 +85 -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,436 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Penny's tools. Each handler asks the reservation book to do something, then
|
|
3
|
+
* tells two audiences what happened, separately:
|
|
4
|
+
*
|
|
5
|
+
* - the model gets `tool_result` (what is true) and `tool_prompt` (what to say);
|
|
6
|
+
* - the platform gets actions: step changes, session data, UI events, call control.
|
|
7
|
+
*
|
|
8
|
+
* Nothing here trusts the model's claim that something happened. Handlers check
|
|
9
|
+
* the store; the store checks the rules.
|
|
10
|
+
*
|
|
11
|
+
* Copyright (c) 2025 SignalWire. Licensed under the MIT License.
|
|
12
|
+
* See LICENSE file in the project root for full license information.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { FunctionResult, getLogger } from '@signalwire/sdk';
|
|
16
|
+
import {
|
|
17
|
+
HOUSE_FACTS,
|
|
18
|
+
LargePartyError,
|
|
19
|
+
LockedOutError,
|
|
20
|
+
PolicyError,
|
|
21
|
+
ReservationStore,
|
|
22
|
+
spokenCode,
|
|
23
|
+
spokenDate,
|
|
24
|
+
spokenTime,
|
|
25
|
+
} from './reservations.js';
|
|
26
|
+
|
|
27
|
+
export const log = getLogger('penny');
|
|
28
|
+
|
|
29
|
+
export const GOODBYE = 'Thanks for calling The Copper Pot. Have a wonderful evening!';
|
|
30
|
+
export const TRANSFER_NOTICE = "One moment, I'm connecting you with our host stand.";
|
|
31
|
+
|
|
32
|
+
/** A tool's arguments and the platform's request, both untrusted until checked. */
|
|
33
|
+
export type Args = Record<string, unknown>;
|
|
34
|
+
export type RawData = Record<string, unknown>;
|
|
35
|
+
export type Handler = (args: Args, rawData: RawData) => FunctionResult;
|
|
36
|
+
|
|
37
|
+
/** Server configuration. The model can't choose any of these values. */
|
|
38
|
+
export interface Settings {
|
|
39
|
+
hostNumber?: string; // where request_human may send a call
|
|
40
|
+
smsFrom?: string; // the restaurant's texting number
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** A tool request arrived without the call it belongs to. */
|
|
44
|
+
export class MissingCallContext extends Error {}
|
|
45
|
+
|
|
46
|
+
const isObject = (value: unknown): value is Record<string, unknown> =>
|
|
47
|
+
typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
48
|
+
|
|
49
|
+
// region: guarded
|
|
50
|
+
/** Turn refusals into facts for the model, and never let a crash sound like success. */
|
|
51
|
+
export function guarded(name: string, handler: Handler): Handler {
|
|
52
|
+
return (args, rawData) => {
|
|
53
|
+
try {
|
|
54
|
+
if (!isObject(args) || !isObject(rawData)) {
|
|
55
|
+
throw new PolicyError('The request was malformed.', 'Ask the caller to say that again.');
|
|
56
|
+
}
|
|
57
|
+
return handler(args, rawData);
|
|
58
|
+
} catch (err) {
|
|
59
|
+
if (err instanceof PolicyError) {
|
|
60
|
+
return new FunctionResult({ tool_result: err.fact, tool_prompt: err.ask });
|
|
61
|
+
}
|
|
62
|
+
if (err instanceof MissingCallContext) {
|
|
63
|
+
return new FunctionResult({
|
|
64
|
+
tool_result: 'Nothing was done: the request had no call context.',
|
|
65
|
+
tool_prompt: 'Apologize and offer to take a message.',
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
log.error(`tool ${name} failed: ${err instanceof Error ? err.stack : String(err)}`);
|
|
69
|
+
return new FunctionResult({
|
|
70
|
+
tool_result: "The system couldn't finish that, so the outcome is unknown.",
|
|
71
|
+
tool_prompt: "Don't say it worked. Apologize and offer to try again.",
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
// endregion: guarded
|
|
77
|
+
|
|
78
|
+
function callIdOf(rawData: RawData): string {
|
|
79
|
+
const callId = rawData['call_id'];
|
|
80
|
+
if (typeof callId !== 'string' || !callId) throw new MissingCallContext();
|
|
81
|
+
return callId;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** Answers gather mode stored in global_data. Caller-supplied, so untrusted. */
|
|
85
|
+
function gathered(rawData: RawData, key: string): Record<string, unknown> {
|
|
86
|
+
const globalData = rawData['global_data'];
|
|
87
|
+
const value = isObject(globalData) ? globalData[key] : undefined;
|
|
88
|
+
return isObject(value) ? value : {};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export class PennyHandlers {
|
|
92
|
+
constructor(
|
|
93
|
+
readonly store: ReservationStore,
|
|
94
|
+
readonly settings: Settings,
|
|
95
|
+
) {}
|
|
96
|
+
|
|
97
|
+
// ---------------------------------------------------------------------------
|
|
98
|
+
// Routing: code, not the model, moves the conversation
|
|
99
|
+
// ---------------------------------------------------------------------------
|
|
100
|
+
|
|
101
|
+
// region: start-booking
|
|
102
|
+
readonly startBooking = guarded('start_booking', (_args, rawData) => {
|
|
103
|
+
this.store.resetRequest(callIdOf(rawData));
|
|
104
|
+
return new FunctionResult({
|
|
105
|
+
tool_result: 'A new reservation has been started.',
|
|
106
|
+
tool_prompt: "Tell the caller you'll take a few details.",
|
|
107
|
+
})
|
|
108
|
+
.updateGlobalData({ booking: {}, booking_request: {} })
|
|
109
|
+
.swmlChangeContext('booking');
|
|
110
|
+
});
|
|
111
|
+
// endregion: start-booking
|
|
112
|
+
|
|
113
|
+
readonly manageBooking = guarded('manage_booking', (_args, rawData) => {
|
|
114
|
+
callIdOf(rawData);
|
|
115
|
+
return new FunctionResult({
|
|
116
|
+
tool_result: 'Looking up an existing reservation.',
|
|
117
|
+
tool_prompt: 'Ask for the confirmation code and the last name on it.',
|
|
118
|
+
})
|
|
119
|
+
.updateGlobalData({ manage: {} })
|
|
120
|
+
.swmlChangeContext('manage');
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
readonly houseInfo = guarded('house_info', (args) => {
|
|
124
|
+
const topic = args['topic'];
|
|
125
|
+
const fact =
|
|
126
|
+
typeof topic === 'string' && Object.hasOwn(HOUSE_FACTS, topic) ? HOUSE_FACTS[topic] : null;
|
|
127
|
+
if (!fact) {
|
|
128
|
+
return new FunctionResult({
|
|
129
|
+
tool_result: "There's no information on that topic.",
|
|
130
|
+
tool_prompt: "Say you don't have that information, then carry on.",
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
return new FunctionResult({
|
|
134
|
+
tool_result: fact,
|
|
135
|
+
tool_prompt: 'Answer with this fact in your own words, then carry on.',
|
|
136
|
+
});
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
// ---------------------------------------------------------------------------
|
|
140
|
+
// Booking
|
|
141
|
+
// ---------------------------------------------------------------------------
|
|
142
|
+
|
|
143
|
+
// region: find-tables
|
|
144
|
+
readonly findTables = guarded('find_tables', (args, rawData) => {
|
|
145
|
+
const callId = callIdOf(rawData);
|
|
146
|
+
// What the caller has asked for: gather's answers, changed by every
|
|
147
|
+
// correction since. A correction passed as an argument changes only
|
|
148
|
+
// that detail, even if the last search was refused.
|
|
149
|
+
const draft = this.store.updateDraft(callId, args, gathered(rawData, 'booking_request'));
|
|
150
|
+
let request, options;
|
|
151
|
+
try {
|
|
152
|
+
[request, options] = this.store.findOptions(
|
|
153
|
+
callId,
|
|
154
|
+
draft.party_size,
|
|
155
|
+
draft.date,
|
|
156
|
+
draft.time,
|
|
157
|
+
draft.name,
|
|
158
|
+
);
|
|
159
|
+
} catch (err) {
|
|
160
|
+
if (!(err instanceof LargePartyError)) throw err;
|
|
161
|
+
return new FunctionResult({ tool_result: err.fact, tool_prompt: err.ask });
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
let result: FunctionResult;
|
|
165
|
+
if (options.length > 0) {
|
|
166
|
+
const listed = options.map((option) => option.spoken()).join('; ');
|
|
167
|
+
result = new FunctionResult({
|
|
168
|
+
tool_result: `Open for ${request.partySize} on ${spokenDate(request.day)}: ${listed}.`,
|
|
169
|
+
tool_prompt:
|
|
170
|
+
'Offer these options by number. When the caller picks one, ' +
|
|
171
|
+
'call hold_table with its number.',
|
|
172
|
+
});
|
|
173
|
+
} else {
|
|
174
|
+
result = new FunctionResult({
|
|
175
|
+
tool_result:
|
|
176
|
+
`Nothing is open for ${request.partySize} on ${spokenDate(request.day)} ` +
|
|
177
|
+
`within an hour of ${spokenTime(request.start)}. Seatings run 5 PM to 8:30 PM.`,
|
|
178
|
+
tool_prompt:
|
|
179
|
+
'Say so, and ask whether another time or date would work. ' +
|
|
180
|
+
'Then call find_tables with only what changed.',
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
return result
|
|
184
|
+
.updateGlobalData({ booking: { request: request.spoken() } })
|
|
185
|
+
.swmlChangeStep('choose')
|
|
186
|
+
.swmlUserEvent({
|
|
187
|
+
type: 'options_offered',
|
|
188
|
+
day: request.day,
|
|
189
|
+
options: options.map((o) => ({ number: o.number, time: spokenTime(o.start) })),
|
|
190
|
+
});
|
|
191
|
+
});
|
|
192
|
+
// endregion: find-tables
|
|
193
|
+
|
|
194
|
+
// region: hold-table
|
|
195
|
+
readonly holdTable = guarded('hold_table', (args, rawData) => {
|
|
196
|
+
const callId = callIdOf(rawData);
|
|
197
|
+
const proposal = this.store.holdOption(callId, args['option']);
|
|
198
|
+
return new FunctionResult({
|
|
199
|
+
tool_result:
|
|
200
|
+
`On hold for five minutes: ${proposal.spoken()}. ` +
|
|
201
|
+
`This is proposal revision ${proposal.revision}.`,
|
|
202
|
+
tool_prompt:
|
|
203
|
+
'Read the proposal back and ask the caller to confirm it. ' +
|
|
204
|
+
`If they clearly say yes, call confirm_booking with revision ${proposal.revision}. ` +
|
|
205
|
+
'If they want a change, call find_tables with only what changed.',
|
|
206
|
+
})
|
|
207
|
+
.updateGlobalData({
|
|
208
|
+
booking: { proposal: proposal.spoken(), revision: proposal.revision },
|
|
209
|
+
})
|
|
210
|
+
.swmlChangeStep('review')
|
|
211
|
+
.swmlUserEvent({
|
|
212
|
+
type: 'table_held',
|
|
213
|
+
revision: proposal.revision,
|
|
214
|
+
day: proposal.day,
|
|
215
|
+
time: spokenTime(proposal.start),
|
|
216
|
+
party_size: proposal.partySize,
|
|
217
|
+
});
|
|
218
|
+
});
|
|
219
|
+
// endregion: hold-table
|
|
220
|
+
|
|
221
|
+
// region: confirm-booking
|
|
222
|
+
readonly confirmBooking = guarded('confirm_booking', (args, rawData) => {
|
|
223
|
+
const callId = callIdOf(rawData);
|
|
224
|
+
const booking = this.store.confirm(callId, args['revision']);
|
|
225
|
+
const code = spokenCode(booking.code);
|
|
226
|
+
return new FunctionResult({
|
|
227
|
+
tool_result: `Confirmed: ${booking.spoken()}. Confirmation code: ${code}.`,
|
|
228
|
+
tool_prompt:
|
|
229
|
+
"Tell the caller it's booked and read the confirmation code " +
|
|
230
|
+
'slowly, one character at a time. Then offer to text the details.',
|
|
231
|
+
})
|
|
232
|
+
.updateGlobalData({ booking: { summary: booking.spoken(), code_spoken: code } })
|
|
233
|
+
.swmlChangeStep('booked')
|
|
234
|
+
.swmlUserEvent({
|
|
235
|
+
type: 'booking_confirmed',
|
|
236
|
+
code: booking.code,
|
|
237
|
+
day: booking.day,
|
|
238
|
+
time: spokenTime(booking.start),
|
|
239
|
+
party_size: booking.partySize,
|
|
240
|
+
});
|
|
241
|
+
});
|
|
242
|
+
// endregion: confirm-booking
|
|
243
|
+
|
|
244
|
+
// region: send-text
|
|
245
|
+
readonly sendConfirmationText = guarded('send_confirmation_text', (_args, rawData) => {
|
|
246
|
+
const callId = callIdOf(rawData);
|
|
247
|
+
const booking = this.store.bookingForCall(callId);
|
|
248
|
+
if (booking === null) {
|
|
249
|
+
throw new PolicyError(
|
|
250
|
+
"This call hasn't booked a reservation.",
|
|
251
|
+
"Say there's nothing to text yet.",
|
|
252
|
+
);
|
|
253
|
+
}
|
|
254
|
+
if (!this.settings.smsFrom) {
|
|
255
|
+
throw new PolicyError(
|
|
256
|
+
"Texting isn't set up at the restaurant.",
|
|
257
|
+
'Apologize, and make sure they have the confirmation code.',
|
|
258
|
+
);
|
|
259
|
+
}
|
|
260
|
+
// The destination is the number this call comes from. The model can't supply one.
|
|
261
|
+
const caller = String(rawData['caller_id_num'] ?? '');
|
|
262
|
+
if (!/^\+[1-9]\d{9,14}$/.test(caller)) {
|
|
263
|
+
throw new PolicyError(
|
|
264
|
+
"The number this call comes from can't receive a text.",
|
|
265
|
+
"Say you can't text this number, and make sure they have the code.",
|
|
266
|
+
);
|
|
267
|
+
}
|
|
268
|
+
// The platform sends the text after this returns, so Penny can only say
|
|
269
|
+
// a text was requested, never that it was sent or arrived.
|
|
270
|
+
const decision = this.store.requestSms(booking.code);
|
|
271
|
+
if (decision === 'duplicate') {
|
|
272
|
+
return new FunctionResult({
|
|
273
|
+
tool_result: 'A text for this booking was requested moments ago.',
|
|
274
|
+
tool_prompt:
|
|
275
|
+
"Tell the caller a text was requested a moment ago. If it hasn't " +
|
|
276
|
+
'arrived in a couple of minutes, you can request it again.',
|
|
277
|
+
});
|
|
278
|
+
}
|
|
279
|
+
if (decision === 'limit') {
|
|
280
|
+
throw new PolicyError(
|
|
281
|
+
'A text for this booking has been requested as many times as allowed.',
|
|
282
|
+
"Say you can't request another text, and make sure they have the confirmation code.",
|
|
283
|
+
);
|
|
284
|
+
}
|
|
285
|
+
const body =
|
|
286
|
+
`The Copper Pot: ${booking.spoken()}. Confirmation code ${booking.code}. ` +
|
|
287
|
+
'Call us to change or cancel.';
|
|
288
|
+
return new FunctionResult({
|
|
289
|
+
tool_result: `Requested a text of the details to the number ending in ${caller.slice(-4)}.`,
|
|
290
|
+
tool_prompt: "Tell the caller you've requested the text.",
|
|
291
|
+
}).sendSms({ toNumber: caller, fromNumber: this.settings.smsFrom, body });
|
|
292
|
+
});
|
|
293
|
+
// endregion: send-text
|
|
294
|
+
|
|
295
|
+
// ---------------------------------------------------------------------------
|
|
296
|
+
// An existing reservation
|
|
297
|
+
// ---------------------------------------------------------------------------
|
|
298
|
+
|
|
299
|
+
// region: verify-reservation
|
|
300
|
+
readonly verifyReservation = guarded('verify_reservation', (args, rawData) => {
|
|
301
|
+
const callId = callIdOf(rawData);
|
|
302
|
+
let found;
|
|
303
|
+
try {
|
|
304
|
+
found = this.store.verify(callId, args['confirmation_code'], args['last_name']);
|
|
305
|
+
} catch (err) {
|
|
306
|
+
if (!(err instanceof LockedOutError)) throw err;
|
|
307
|
+
return new FunctionResult({ tool_result: err.fact, tool_prompt: err.ask }).swmlChangeStep(
|
|
308
|
+
'locked',
|
|
309
|
+
);
|
|
310
|
+
}
|
|
311
|
+
return new FunctionResult({
|
|
312
|
+
tool_result: `Verified: ${found.spoken()}. Status: ${found.status}.`,
|
|
313
|
+
tool_prompt: "Tell the caller the details and ask what they'd like to do.",
|
|
314
|
+
})
|
|
315
|
+
.updateGlobalData({ manage: { summary: found.spoken(), status: found.status } })
|
|
316
|
+
.swmlChangeStep('details')
|
|
317
|
+
.swmlUserEvent({ type: 'reservation_verified', status: found.status });
|
|
318
|
+
});
|
|
319
|
+
// endregion: verify-reservation
|
|
320
|
+
|
|
321
|
+
// region: cancel
|
|
322
|
+
readonly requestCancel = guarded('request_cancel', (_args, rawData) => {
|
|
323
|
+
const callId = callIdOf(rawData);
|
|
324
|
+
const [found, revision] = this.store.requestCancel(callId);
|
|
325
|
+
return new FunctionResult({
|
|
326
|
+
tool_result: `Ready to cancel ${found.spoken()}. This is cancellation revision ${revision}.`,
|
|
327
|
+
tool_prompt:
|
|
328
|
+
"Read that back and ask if they're sure. If they clearly say yes, " +
|
|
329
|
+
`call confirm_cancel with revision ${revision}. If not, call keep_reservation.`,
|
|
330
|
+
}).swmlChangeStep('confirm_cancel');
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
readonly confirmCancel = guarded('confirm_cancel', (args, rawData) => {
|
|
334
|
+
const callId = callIdOf(rawData);
|
|
335
|
+
const cancelled = this.store.confirmCancel(callId, args['revision']);
|
|
336
|
+
return new FunctionResult({
|
|
337
|
+
tool_result: `Cancelled: ${cancelled.spoken()}.`,
|
|
338
|
+
tool_prompt: "Tell the caller it's cancelled, then ask if there's anything else.",
|
|
339
|
+
})
|
|
340
|
+
.updateGlobalData({ manage: { summary: cancelled.spoken(), status: 'cancelled' } })
|
|
341
|
+
.swmlChangeStep('cancelled')
|
|
342
|
+
.swmlUserEvent({ type: 'reservation_cancelled' });
|
|
343
|
+
});
|
|
344
|
+
// endregion: cancel
|
|
345
|
+
|
|
346
|
+
readonly keepReservation = guarded('keep_reservation', (_args, rawData) => {
|
|
347
|
+
const callId = callIdOf(rawData);
|
|
348
|
+
const kept = this.store.keepReservation(callId);
|
|
349
|
+
return new FunctionResult({
|
|
350
|
+
tool_result: `Nothing changed: ${kept.spoken()} is still booked.`,
|
|
351
|
+
tool_prompt: 'Tell the caller their reservation is unchanged.',
|
|
352
|
+
}).swmlChangeStep('details');
|
|
353
|
+
});
|
|
354
|
+
|
|
355
|
+
// ---------------------------------------------------------------------------
|
|
356
|
+
// People, messages and endings
|
|
357
|
+
// ---------------------------------------------------------------------------
|
|
358
|
+
|
|
359
|
+
// region: request-human
|
|
360
|
+
readonly requestHuman = guarded('request_human', (_args, rawData) => {
|
|
361
|
+
callIdOf(rawData);
|
|
362
|
+
if (this.settings.hostNumber && this.store.hostStandOpen()) {
|
|
363
|
+
// say() is an action, so it finishes before connect() runs. The
|
|
364
|
+
// response text is spoken by the model on its own schedule and
|
|
365
|
+
// could be cut off by the transfer.
|
|
366
|
+
return new FunctionResult({
|
|
367
|
+
tool_result: 'The call is being transferred to the host stand.',
|
|
368
|
+
tool_prompt: 'Say nothing more; the transfer notice is playing.',
|
|
369
|
+
})
|
|
370
|
+
.say(TRANSFER_NOTICE)
|
|
371
|
+
.connect(this.settings.hostNumber, true);
|
|
372
|
+
}
|
|
373
|
+
return new FunctionResult({
|
|
374
|
+
tool_result: 'Nobody is at the host stand right now.',
|
|
375
|
+
tool_prompt:
|
|
376
|
+
"Tell the caller nobody is at the host stand, and that you'll take a message for them.",
|
|
377
|
+
})
|
|
378
|
+
.updateGlobalData({ message: {} })
|
|
379
|
+
.swmlChangeContext('help');
|
|
380
|
+
});
|
|
381
|
+
// endregion: request-human
|
|
382
|
+
|
|
383
|
+
// region: save-message
|
|
384
|
+
readonly saveMessage = guarded('save_message', (args, rawData) => {
|
|
385
|
+
const callId = callIdOf(rawData);
|
|
386
|
+
const taken = gathered(rawData, 'message');
|
|
387
|
+
const detail = (key: string): string => {
|
|
388
|
+
const given = args[key];
|
|
389
|
+
return String(
|
|
390
|
+
given !== undefined && given !== null && given !== '' ? given : taken[key] || '',
|
|
391
|
+
);
|
|
392
|
+
};
|
|
393
|
+
|
|
394
|
+
const saved = this.store.saveMessage(
|
|
395
|
+
callId,
|
|
396
|
+
detail('name'),
|
|
397
|
+
detail('callback'),
|
|
398
|
+
detail('body'),
|
|
399
|
+
);
|
|
400
|
+
return new FunctionResult({
|
|
401
|
+
tool_result:
|
|
402
|
+
'Message saved for the host stand, with a callback number ' +
|
|
403
|
+
`ending in ${saved.callback.slice(-4)}.`,
|
|
404
|
+
tool_prompt: 'Tell the caller the host stand will call them back.',
|
|
405
|
+
})
|
|
406
|
+
.swmlChangeStep('message_saved')
|
|
407
|
+
.swmlUserEvent({ type: 'message_taken' });
|
|
408
|
+
});
|
|
409
|
+
// endregion: save-message
|
|
410
|
+
|
|
411
|
+
// region: finish
|
|
412
|
+
readonly finish = guarded('finish', () => {
|
|
413
|
+
// The goodbye is a say() action, not response text: actions run in order,
|
|
414
|
+
// so the caller hears all of it before hangup() ends the call.
|
|
415
|
+
return new FunctionResult({
|
|
416
|
+
tool_result: 'The goodbye is playing and the call will end.',
|
|
417
|
+
tool_prompt: 'Say nothing more.',
|
|
418
|
+
})
|
|
419
|
+
.say(GOODBYE)
|
|
420
|
+
.hangup();
|
|
421
|
+
});
|
|
422
|
+
// endregion: finish
|
|
423
|
+
|
|
424
|
+
// region: capture-call
|
|
425
|
+
/** onCallEnd: record what the store says happened, not what the transcript says. */
|
|
426
|
+
captureCall(callLog: unknown[], rawData: RawData): void {
|
|
427
|
+
const callId = isObject(rawData) ? rawData['call_id'] : undefined;
|
|
428
|
+
if (typeof callId !== 'string' || !callId) {
|
|
429
|
+
log.warn('call ended without a call id; nothing recorded');
|
|
430
|
+
return;
|
|
431
|
+
}
|
|
432
|
+
const outcome = this.store.recordCallEnd(callId, (callLog ?? []).length);
|
|
433
|
+
log.info(`call ${callId} ended: ${outcome}`);
|
|
434
|
+
}
|
|
435
|
+
// endregion: capture-call
|
|
436
|
+
}
|