@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
package/dist/relay/Message.d.ts
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* (or undelivered/failed). Inbound messages arrive fully formed with state "received".
|
|
7
7
|
*/
|
|
8
8
|
import { RelayEvent } from './RelayEvent.js';
|
|
9
|
+
import type { MessageState } from './closedSets.js';
|
|
9
10
|
import type { CompletedCallback, EventHandler } from './types.js';
|
|
10
11
|
/**
|
|
11
12
|
* SMS/MMS message in the RELAY messaging namespace.
|
|
@@ -16,9 +17,11 @@ import type { CompletedCallback, EventHandler } from './types.js';
|
|
|
16
17
|
*
|
|
17
18
|
* @example Wait for delivery confirmation
|
|
18
19
|
* ```ts
|
|
20
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
21
|
+
* const client = new RelayClient();
|
|
19
22
|
* const msg = await client.sendMessage({
|
|
20
|
-
*
|
|
21
|
-
*
|
|
23
|
+
* toNumber: '+15551234567',
|
|
24
|
+
* fromNumber: '+15557654321',
|
|
22
25
|
* body: 'Your code is 4242',
|
|
23
26
|
* });
|
|
24
27
|
*
|
|
@@ -43,8 +46,15 @@ export declare class Message {
|
|
|
43
46
|
media: string[];
|
|
44
47
|
/** Number of segments the carrier split the message into. */
|
|
45
48
|
segments: number;
|
|
46
|
-
/**
|
|
47
|
-
|
|
49
|
+
/**
|
|
50
|
+
* Current message state. One of the {@link MessageState} values
|
|
51
|
+
* (`"queued"` | `"initiated"` | `"sent"` | `"delivered"` | `"undelivered"` |
|
|
52
|
+
* `"failed"` | `"received"`; closed literal union, autocompleted +
|
|
53
|
+
* typo-checked). A raw wire value is cast to the closed type at the hydration
|
|
54
|
+
* boundary. Use {@link Message.isTerminal} to test for a final delivery
|
|
55
|
+
* outcome rather than comparing strings by hand.
|
|
56
|
+
*/
|
|
57
|
+
state: MessageState;
|
|
48
58
|
/** Failure / undelivery reason when `state` is non-successful. */
|
|
49
59
|
reason: string;
|
|
50
60
|
/** Opaque tags attached to the message. */
|
|
@@ -61,12 +71,23 @@ export declare class Message {
|
|
|
61
71
|
body?: string;
|
|
62
72
|
media?: string[];
|
|
63
73
|
segments?: number;
|
|
64
|
-
state?:
|
|
74
|
+
state?: MessageState;
|
|
65
75
|
reason?: string;
|
|
66
76
|
tags?: string[];
|
|
67
77
|
});
|
|
68
78
|
/** True once the message has reached a terminal state. */
|
|
69
79
|
get isDone(): boolean;
|
|
80
|
+
/**
|
|
81
|
+
* Whether this message's current {@link Message.state} is a terminal
|
|
82
|
+
* delivery outcome (`delivered` | `undelivered` | `failed`).
|
|
83
|
+
*
|
|
84
|
+
* Distinct from {@link Message.isDone}: `isDone` reflects whether the
|
|
85
|
+
* internal completion promise has settled (driven by event dispatch),
|
|
86
|
+
* whereas `isTerminal` is a pure test of the state *value*
|
|
87
|
+
* ({@link ../relay/closedSets.MessageState}) and is meaningful even on a
|
|
88
|
+
* freshly-constructed inbound message.
|
|
89
|
+
*/
|
|
90
|
+
get isTerminal(): boolean;
|
|
70
91
|
/** Final event that terminated the message, or `null` if still in-flight. */
|
|
71
92
|
get result(): RelayEvent | null;
|
|
72
93
|
private _result;
|
package/dist/relay/Message.js
CHANGED
|
@@ -9,6 +9,7 @@ import { getLogger } from '../Logger.js';
|
|
|
9
9
|
import { createDeferred } from './Deferred.js';
|
|
10
10
|
import { MESSAGE_TERMINAL_STATES } from './constants.js';
|
|
11
11
|
import { RelayEvent } from './RelayEvent.js';
|
|
12
|
+
import { isMessageStateTerminal } from './closedSets.js';
|
|
12
13
|
const logger = getLogger('relay_message');
|
|
13
14
|
/**
|
|
14
15
|
* SMS/MMS message in the RELAY messaging namespace.
|
|
@@ -19,9 +20,11 @@ const logger = getLogger('relay_message');
|
|
|
19
20
|
*
|
|
20
21
|
* @example Wait for delivery confirmation
|
|
21
22
|
* ```ts
|
|
23
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
24
|
+
* const client = new RelayClient();
|
|
22
25
|
* const msg = await client.sendMessage({
|
|
23
|
-
*
|
|
24
|
-
*
|
|
26
|
+
* toNumber: '+15551234567',
|
|
27
|
+
* fromNumber: '+15557654321',
|
|
25
28
|
* body: 'Your code is 4242',
|
|
26
29
|
* });
|
|
27
30
|
*
|
|
@@ -46,7 +49,14 @@ export class Message {
|
|
|
46
49
|
media;
|
|
47
50
|
/** Number of segments the carrier split the message into. */
|
|
48
51
|
segments;
|
|
49
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* Current message state. One of the {@link MessageState} values
|
|
54
|
+
* (`"queued"` | `"initiated"` | `"sent"` | `"delivered"` | `"undelivered"` |
|
|
55
|
+
* `"failed"` | `"received"`; closed literal union, autocompleted +
|
|
56
|
+
* typo-checked). A raw wire value is cast to the closed type at the hydration
|
|
57
|
+
* boundary. Use {@link Message.isTerminal} to test for a final delivery
|
|
58
|
+
* outcome rather than comparing strings by hand.
|
|
59
|
+
*/
|
|
50
60
|
state;
|
|
51
61
|
/** Failure / undelivery reason when `state` is non-successful. */
|
|
52
62
|
reason;
|
|
@@ -64,7 +74,8 @@ export class Message {
|
|
|
64
74
|
this.body = options.body ?? '';
|
|
65
75
|
this.media = options.media ?? [];
|
|
66
76
|
this.segments = options.segments ?? 0;
|
|
67
|
-
|
|
77
|
+
// Boundary cast: a raw wire state (or the '' default) becomes the closed MessageState here.
|
|
78
|
+
this.state = (options.state ?? '');
|
|
68
79
|
this.reason = options.reason ?? '';
|
|
69
80
|
this.tags = options.tags ?? [];
|
|
70
81
|
this._done = createDeferred();
|
|
@@ -73,6 +84,19 @@ export class Message {
|
|
|
73
84
|
get isDone() {
|
|
74
85
|
return this._done.settled;
|
|
75
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* Whether this message's current {@link Message.state} is a terminal
|
|
89
|
+
* delivery outcome (`delivered` | `undelivered` | `failed`).
|
|
90
|
+
*
|
|
91
|
+
* Distinct from {@link Message.isDone}: `isDone` reflects whether the
|
|
92
|
+
* internal completion promise has settled (driven by event dispatch),
|
|
93
|
+
* whereas `isTerminal` is a pure test of the state *value*
|
|
94
|
+
* ({@link ../relay/closedSets.MessageState}) and is meaningful even on a
|
|
95
|
+
* freshly-constructed inbound message.
|
|
96
|
+
*/
|
|
97
|
+
get isTerminal() {
|
|
98
|
+
return isMessageStateTerminal(this.state);
|
|
99
|
+
}
|
|
76
100
|
/** Final event that terminated the message, or `null` if still in-flight. */
|
|
77
101
|
get result() {
|
|
78
102
|
// We can't synchronously get the result from a promise, so we track it
|
|
@@ -107,7 +131,13 @@ export class Message {
|
|
|
107
131
|
const timer = setTimeout(() => {
|
|
108
132
|
reject(new Error(`Message wait timed out after ${timeout}s`));
|
|
109
133
|
}, ms);
|
|
110
|
-
this._done.promise.then((v) => {
|
|
134
|
+
this._done.promise.then((v) => {
|
|
135
|
+
clearTimeout(timer);
|
|
136
|
+
resolve(v);
|
|
137
|
+
}, (e) => {
|
|
138
|
+
clearTimeout(timer);
|
|
139
|
+
reject(e);
|
|
140
|
+
});
|
|
111
141
|
});
|
|
112
142
|
}
|
|
113
143
|
return this._done.promise;
|
|
@@ -117,7 +147,7 @@ export class Message {
|
|
|
117
147
|
const eventParams = (payload.params ?? {});
|
|
118
148
|
const newState = (eventParams.message_state ?? '');
|
|
119
149
|
if (newState) {
|
|
120
|
-
this.state = newState;
|
|
150
|
+
this.state = newState; // boundary cast: raw wire state → closed field
|
|
121
151
|
}
|
|
122
152
|
if (eventParams.reason !== undefined) {
|
|
123
153
|
this.reason = eventParams.reason;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../src/relay/Message.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,cAAc,EAAiB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../src/relay/Message.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,cAAc,EAAiB,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAIzD,MAAM,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,OAAO;IAClB,0DAA0D;IAC1D,SAAS,CAAS;IAClB,4CAA4C;IAC5C,OAAO,CAAS;IAChB,mCAAmC;IACnC,SAAS,CAAS;IAClB,2CAA2C;IAC3C,UAAU,CAAS;IACnB,gDAAgD;IAChD,QAAQ,CAAS;IACjB,+BAA+B;IAC/B,IAAI,CAAS;IACb,gDAAgD;IAChD,KAAK,CAAW;IAChB,6DAA6D;IAC7D,QAAQ,CAAS;IACjB;;;;;;;OAOG;IACH,KAAK,CAAe;IACpB,kEAAkE;IAClE,MAAM,CAAS;IACf,2CAA2C;IAC3C,IAAI,CAAW;IAEP,KAAK,CAAuB;IACpC,gBAAgB,CAAC,YAAY,GAA6B,IAAI,CAAC;IACvD,UAAU,GAAmB,EAAE,CAAC;IAExC,YACE,UAYI,EAAE;QAEN,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtC,4FAA4F;QAC5F,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAiB,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,cAAc,EAAc,CAAC;IAC5C,CAAC;IAED,0DAA0D;IAC1D,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU;QACZ,OAAO,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,6EAA6E;IAC7E,IAAI,MAAM;QACR,uEAAuE;QACvE,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;IAC9B,CAAC;IAEO,OAAO,CAAyB;IAExC;;;;;;;;OAQG;IACH,EAAE,CAAC,OAAqB;QACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,OAAgB;QACzB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,EAAE,GAAG,OAAO,GAAG,IAAI,CAAC;YAC1B,OAAO,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACjD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBAC5B,MAAM,CAAC,IAAI,KAAK,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC,CAAC;gBAChE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAEP,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CACrB,CAAC,CAAC,EAAE,EAAE;oBACJ,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,OAAO,CAAC,CAAC,CAAC,CAAC;gBACb,CAAC,EACD,CAAC,CAAC,EAAE,EAAE;oBACJ,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,cAAc,CAAC,OAAgC;QACnD,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAA4B,CAAC;QACtE,MAAM,QAAQ,GAAG,CAAC,WAAW,CAAC,aAAa,IAAI,EAAE,CAAW,CAAC;QAE7D,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,GAAG,QAAwB,CAAC,CAAC,+CAA+C;QACxF,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAgB,CAAC;QAC7C,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,CAAC,OAAkC,CAAC,CAAC;QAEzE,mBAAmB;QACnB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,KAAK,CAAC,sCAAsC,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,IAAK,uBAA6C,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,QAAQ,CAAC,KAAiB;QAChC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,OAAO;QAC/B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBACxC,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;oBAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;wBACnB,MAAM,CAAC,KAAK,CAAC,8CAA8C,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC,CAAC;oBACvF,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,KAAK,CAAC,8CAA8C,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACN,OAAO,cAAc,IAAI,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,WAAW,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,UAAU,QAAQ,IAAI,CAAC,QAAQ,GAAG,CAAC;IACzI,CAAC;CACF"}
|
|
@@ -13,14 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { Call } from './Call.js';
|
|
15
15
|
import { Message } from './Message.js';
|
|
16
|
-
import type { CallHandler, MessageHandler, RelayClientOptions } from './types.js';
|
|
16
|
+
import type { CallHandler, CompletedCallback, MessageHandler, RelayClientOptions } from './types.js';
|
|
17
17
|
type WsLike = {
|
|
18
18
|
send(data: string): void;
|
|
19
19
|
close(code?: number, reason?: string): void;
|
|
20
|
-
on(event: string, listener: (...args:
|
|
20
|
+
on(event: string, listener: (...args: unknown[]) => void): void;
|
|
21
21
|
removeAllListeners(): void;
|
|
22
22
|
readyState: number;
|
|
23
|
-
ping?(data?:
|
|
23
|
+
ping?(data?: unknown, mask?: boolean, cb?: (err: Error) => void): void;
|
|
24
24
|
};
|
|
25
25
|
/**
|
|
26
26
|
* Real-time WebSocket client for SignalWire RELAY.
|
|
@@ -44,7 +44,8 @@ type WsLike = {
|
|
|
44
44
|
*
|
|
45
45
|
* client.onCall(async (call) => {
|
|
46
46
|
* await call.answer();
|
|
47
|
-
* await call.
|
|
47
|
+
* const played = await call.play([{ type: 'tts', text: 'Thanks for calling!' }]);
|
|
48
|
+
* await played.wait();
|
|
48
49
|
* await call.hangup();
|
|
49
50
|
* });
|
|
50
51
|
*
|
|
@@ -53,11 +54,13 @@ type WsLike = {
|
|
|
53
54
|
*
|
|
54
55
|
* @example Outbound dial + SMS
|
|
55
56
|
* ```ts
|
|
57
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
58
|
+
* const client = new RelayClient();
|
|
56
59
|
* await client.connect();
|
|
57
|
-
* const call = await client.dial(
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* await client.sendMessage({
|
|
60
|
+
* const call = await client.dial([
|
|
61
|
+
* [{ type: 'phone', to: '+15551234567', from: '+15557654321' }],
|
|
62
|
+
* ]);
|
|
63
|
+
* await client.sendMessage({ toNumber: '+15551234567', fromNumber: '+15557654321', body: 'Hi!' });
|
|
61
64
|
* ```
|
|
62
65
|
*
|
|
63
66
|
* @see {@link Call}
|
|
@@ -72,6 +75,11 @@ export declare class RelayClient {
|
|
|
72
75
|
readonly jwtToken: string;
|
|
73
76
|
/** Hostname of the RELAY endpoint (e.g. `example.signalwire.com`). */
|
|
74
77
|
readonly host: string;
|
|
78
|
+
/**
|
|
79
|
+
* WebSocket scheme — `'wss'` (production) or `'ws'` (loopback audits).
|
|
80
|
+
* See {@link RelayClientOptions.scheme} for the full rationale.
|
|
81
|
+
*/
|
|
82
|
+
readonly scheme: 'ws' | 'wss';
|
|
75
83
|
/** Contexts this client subscribes to for inbound events. */
|
|
76
84
|
readonly contexts: string[];
|
|
77
85
|
private _ws;
|
|
@@ -84,16 +92,23 @@ export declare class RelayClient {
|
|
|
84
92
|
private _executeQueue;
|
|
85
93
|
private _onCallHandler;
|
|
86
94
|
private _onMessageHandler;
|
|
95
|
+
private _onAnyEventHandler;
|
|
87
96
|
private _connected;
|
|
88
97
|
private _closing;
|
|
89
98
|
private _reconnectDelay;
|
|
90
99
|
private _relayProtocol;
|
|
91
100
|
private _identity;
|
|
101
|
+
private _sessionId;
|
|
92
102
|
private _authorizationState;
|
|
93
103
|
private _pingInterval;
|
|
94
104
|
private _pingFailures;
|
|
95
105
|
private _serverPingTimeout;
|
|
96
106
|
private _maxActiveCalls;
|
|
107
|
+
private readonly _clientPingIntervalMs;
|
|
108
|
+
private readonly _clientPingMaxFailures;
|
|
109
|
+
private readonly _requestTimeoutMs;
|
|
110
|
+
private readonly _reconnectMinDelay;
|
|
111
|
+
private readonly _reconnectMaxDelay;
|
|
97
112
|
private _shutdownDeferred;
|
|
98
113
|
private _signalHandlers;
|
|
99
114
|
/**
|
|
@@ -115,16 +130,21 @@ export declare class RelayClient {
|
|
|
115
130
|
*
|
|
116
131
|
* Enables usage with `await using`:
|
|
117
132
|
* ```ts
|
|
118
|
-
*
|
|
133
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
134
|
+
* await using client = new RelayClient({ project: 'p', token: 't', host: 'example.signalwire.com' });
|
|
119
135
|
* await client.connect();
|
|
120
|
-
* //
|
|
136
|
+
* // automatically disconnects when scope exits
|
|
121
137
|
* ```
|
|
122
138
|
*
|
|
123
139
|
* For environments without `await using`, use try/finally:
|
|
124
140
|
* ```ts
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
141
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
142
|
+
* const client = new RelayClient({ project: 'p', token: 't', host: 'example.signalwire.com' });
|
|
143
|
+
* try {
|
|
144
|
+
* await client.connect();
|
|
145
|
+
* } finally {
|
|
146
|
+
* await client.disconnect();
|
|
147
|
+
* }
|
|
128
148
|
* ```
|
|
129
149
|
*/
|
|
130
150
|
[Symbol.asyncDispose](): Promise<void>;
|
|
@@ -151,6 +171,22 @@ export declare class RelayClient {
|
|
|
151
171
|
* @returns The same handler, to support decorator-style usage.
|
|
152
172
|
*/
|
|
153
173
|
onMessage(handler: MessageHandler): MessageHandler;
|
|
174
|
+
/**
|
|
175
|
+
* Register a low-level observer that fires for every inbound
|
|
176
|
+
* `signalwire.event`, regardless of event type or whether a typed
|
|
177
|
+
* Call / Message could be matched.
|
|
178
|
+
*
|
|
179
|
+
* Most users want {@link onCall} / {@link onMessage} — those deliver
|
|
180
|
+
* typed objects and handle correlation. `onEvent` is the generic
|
|
181
|
+
* escape hatch for reacting to every event the platform pushes.
|
|
182
|
+
*
|
|
183
|
+
* Fires BEFORE typed routing, so the same event will be observed here
|
|
184
|
+
* AND on any matching {@link Call} / {@link Message}.
|
|
185
|
+
*
|
|
186
|
+
* @param handler - Callback receiving `(eventType, params)`. May be async.
|
|
187
|
+
* @returns The same handler, for decorator-style usage.
|
|
188
|
+
*/
|
|
189
|
+
onEvent(handler: (eventType: string, params: Record<string, unknown>) => void | Promise<void>): typeof handler;
|
|
154
190
|
/**
|
|
155
191
|
* Connect to RELAY and authenticate.
|
|
156
192
|
*
|
|
@@ -166,6 +202,19 @@ export declare class RelayClient {
|
|
|
166
202
|
connect(): Promise<void>;
|
|
167
203
|
/** Create a real WebSocket (uses dynamic import for ws). */
|
|
168
204
|
private _createWebSocket;
|
|
205
|
+
/**
|
|
206
|
+
* Return a log-safe repr of a raw RELAY frame with credential VALUES masked.
|
|
207
|
+
*
|
|
208
|
+
* SECRET-SCRUB (enterprise F3.1/F3.2): a `SIGNALWIRE_LOG_LEVEL=debug` session
|
|
209
|
+
* must never emit live credentials or the re-auth blob. Mirrors the python
|
|
210
|
+
* reference `_scrub_frame` (key-shape mask of "token"/"project"/"jwt_token"/
|
|
211
|
+
* "authorization_state" JSON values) composed with `_scrub_log` (verbatim
|
|
212
|
+
* masking of THIS connection's live credential values wherever they appear —
|
|
213
|
+
* e.g. a project value the server reflects into a non-credential `identity`
|
|
214
|
+
* field). Never a no-op: the raw frame + the identity diagnostic are the two
|
|
215
|
+
* enterprise-flagged leak sites.
|
|
216
|
+
*/
|
|
217
|
+
private _scrubLog;
|
|
169
218
|
private _setupWsListeners;
|
|
170
219
|
/** Send signalwire.connect and wait for the response. */
|
|
171
220
|
private _authenticate;
|
|
@@ -192,6 +241,21 @@ export declare class RelayClient {
|
|
|
192
241
|
* @throws {RelayError} When the server returns a non-2xx code.
|
|
193
242
|
*/
|
|
194
243
|
execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
244
|
+
/**
|
|
245
|
+
* Fire-and-forget JSON-RPC notification (no response awaited).
|
|
246
|
+
*
|
|
247
|
+
* Sends a JSON-RPC frame on the open socket without registering a
|
|
248
|
+
* pending-response future. Used by the audit harness to emit a
|
|
249
|
+
* `signalwire.event`-method frame the fixture watches for; production
|
|
250
|
+
* users should always use {@link execute} instead so the response code
|
|
251
|
+
* is checked.
|
|
252
|
+
*
|
|
253
|
+
* No-ops when the socket is closed.
|
|
254
|
+
*
|
|
255
|
+
* @param method - JSON-RPC method name.
|
|
256
|
+
* @param params - Method params object.
|
|
257
|
+
*/
|
|
258
|
+
notify(method: string, params: Record<string, unknown>): void;
|
|
195
259
|
/**
|
|
196
260
|
* Initiate an outbound call.
|
|
197
261
|
*
|
|
@@ -213,6 +277,7 @@ export declare class RelayClient {
|
|
|
213
277
|
*/
|
|
214
278
|
dial(devices: Record<string, unknown>[][], options?: {
|
|
215
279
|
tag?: string;
|
|
280
|
+
/** Maximum call duration in minutes. */
|
|
216
281
|
maxDuration?: number;
|
|
217
282
|
/** Dial timeout in seconds (default 120). */
|
|
218
283
|
dialTimeout?: number;
|
|
@@ -246,7 +311,7 @@ export declare class RelayClient {
|
|
|
246
311
|
media?: string[];
|
|
247
312
|
tags?: string[];
|
|
248
313
|
region?: string;
|
|
249
|
-
onCompleted?:
|
|
314
|
+
onCompleted?: CompletedCallback;
|
|
250
315
|
}): Promise<Message>;
|
|
251
316
|
/**
|
|
252
317
|
* Subscribe to additional RELAY contexts on an already-connected client.
|