@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,8 @@
|
|
|
1
|
+
// AUTO-GENERATED from porting-sdk/relay-protocol/*.{params,result}.json — DO NOT EDIT.
|
|
2
|
+
// Regenerate with: npx tsx scripts/generate-relay-protocol.ts
|
|
3
|
+
//
|
|
4
|
+
// One interface per RELAY method's params (<Method>Params) and ack result
|
|
5
|
+
// (<Method>Result), from the canonical switchblade wire schemas. Held to the
|
|
6
|
+
// same lint bar as hand-written source (no rule suppressions, no loose types).
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=protocol.types.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"protocol.types.generated.js","sourceRoot":"","sources":["../../src/relay/protocol.types.generated.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,8DAA8D;AAC9D,EAAE;AACF,0EAA0E;AAC1E,6EAA6E;AAC7E,+EAA+E"}
|
package/dist/relay/types.d.ts
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
import type { Call } from './Call.js';
|
|
5
5
|
import type { Message } from './Message.js';
|
|
6
6
|
import type { RelayEvent } from './RelayEvent.js';
|
|
7
|
+
import type { CallingCollectParams, CallingPlayParams } from './protocol.types.generated.js';
|
|
7
8
|
/** Options for constructing a RelayClient. */
|
|
8
9
|
export interface RelayClientOptions {
|
|
9
10
|
/** SignalWire project ID. Defaults to env SIGNALWIRE_PROJECT_ID. */
|
|
@@ -20,9 +21,8 @@ export interface RelayClientOptions {
|
|
|
20
21
|
* `SIGNALWIRE_RELAY_SCHEME` if not explicitly set; defaults to `'wss'`.
|
|
21
22
|
*
|
|
22
23
|
* Production deployments should never pass `'ws'` — the value exists
|
|
23
|
-
* solely so the
|
|
24
|
-
*
|
|
25
|
-
* TLS termination.
|
|
24
|
+
* solely so tests can drive the real client against a plain-WS loopback
|
|
25
|
+
* fixture without standing up TLS termination.
|
|
26
26
|
*/
|
|
27
27
|
scheme?: 'ws' | 'wss';
|
|
28
28
|
/** Contexts (topics) to receive inbound calls/messages on. */
|
|
@@ -78,34 +78,73 @@ export interface SipDevice {
|
|
|
78
78
|
codecs?: string[];
|
|
79
79
|
headers?: Record<string, string>[];
|
|
80
80
|
}
|
|
81
|
-
/**
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
81
|
+
/**
|
|
82
|
+
* Fabric device specification for dial/connect — dials a Fabric address directly.
|
|
83
|
+
* The platform resolves the address to whatever it points to (a Subscriber, a
|
|
84
|
+
* Relay/LaML application, a video room, …) and builds the appropriate leg(s); the
|
|
85
|
+
* caller just names the address and never picks a transport. For a Subscriber
|
|
86
|
+
* this fans out in parallel to their live registrations (push + WebRTC + SIP),
|
|
87
|
+
* reaching the person without provisioning an intermediate SIP address.
|
|
88
|
+
*/
|
|
89
|
+
export interface FabricDevice {
|
|
90
|
+
type: 'fabric';
|
|
91
|
+
to: string;
|
|
86
92
|
from?: string;
|
|
87
|
-
/** Timeout in seconds for the dial. */
|
|
88
93
|
timeout?: number;
|
|
89
|
-
|
|
94
|
+
}
|
|
95
|
+
/** Any device specification. */
|
|
96
|
+
export type Device = PhoneDevice | SipDevice | FabricDevice | Record<string, unknown>;
|
|
97
|
+
/** Options for `RelayClient.dial()`. */
|
|
98
|
+
export interface DialOptions {
|
|
99
|
+
/**
|
|
100
|
+
* Client-provided tag for event correlation. Auto-generated (UUID) when
|
|
101
|
+
* omitted.
|
|
102
|
+
*/
|
|
103
|
+
tag?: string;
|
|
104
|
+
/** Maximum call duration in **minutes** (sent as `max_duration`). */
|
|
90
105
|
maxDuration?: number;
|
|
106
|
+
/**
|
|
107
|
+
* Seconds to wait for a device to answer before `dial()` rejects. Defaults
|
|
108
|
+
* to `120`.
|
|
109
|
+
*/
|
|
110
|
+
dialTimeout?: number;
|
|
91
111
|
}
|
|
92
|
-
/** Options for
|
|
112
|
+
/** Options for `RelayClient.sendMessage()`. */
|
|
93
113
|
export interface SendMessageOptions {
|
|
94
114
|
/** Destination phone number in E.164 format. */
|
|
95
115
|
toNumber: string;
|
|
96
116
|
/** Sender phone number in E.164 format. */
|
|
97
117
|
fromNumber: string;
|
|
98
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* Context for receiving state events. Defaults to the negotiated relay
|
|
120
|
+
* protocol.
|
|
121
|
+
*/
|
|
122
|
+
context?: string;
|
|
123
|
+
/** Message body text. At least one of `body` or `media` is required. */
|
|
99
124
|
body?: string;
|
|
100
|
-
/** Media URLs for MMS. */
|
|
125
|
+
/** Media URLs for MMS. At least one of `body` or `media` is required. */
|
|
101
126
|
media?: string[];
|
|
102
|
-
/**
|
|
103
|
-
context?: string;
|
|
104
|
-
/** Tags for the message. */
|
|
127
|
+
/** Tags attached to the message for correlation. */
|
|
105
128
|
tags?: string[];
|
|
129
|
+
/** Origination region override. */
|
|
130
|
+
region?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Callback fired once when the message reaches a terminal state
|
|
133
|
+
* (`delivered`, `undelivered` or `failed`).
|
|
134
|
+
*/
|
|
135
|
+
onCompleted?: CompletedCallback;
|
|
106
136
|
}
|
|
107
|
-
/**
|
|
108
|
-
|
|
137
|
+
/**
|
|
138
|
+
* A play item accepted by `play()` / `playAndCollect()`.
|
|
139
|
+
*
|
|
140
|
+
* The canonical RELAY wire form is `{ type, params }`
|
|
141
|
+
* (`CallingPlayParams['play'][number]`). The SDK also accepts the friendly flat
|
|
142
|
+
* shorthands below (`{ type: 'tts', text }`, etc.), which
|
|
143
|
+
* {@link normalizePlayItem} expands into `params` before sending. So the
|
|
144
|
+
* accepted-input type is the wire shape OR one of the flat shorthands — exactly
|
|
145
|
+
* the set the normalizer handles, not the post-normalization wire shape alone.
|
|
146
|
+
*/
|
|
147
|
+
export type PlayItem = CallingPlayParams['play'][number] | {
|
|
109
148
|
type: 'tts';
|
|
110
149
|
text: string;
|
|
111
150
|
language?: string;
|
|
@@ -120,30 +159,22 @@ export type PlayItem = {
|
|
|
120
159
|
} | {
|
|
121
160
|
type: 'silence';
|
|
122
161
|
duration: number;
|
|
123
|
-
}
|
|
124
|
-
/**
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
};
|
|
140
|
-
/** Initial timeout in seconds. */
|
|
141
|
-
initial_timeout?: number;
|
|
142
|
-
/** Partial results? */
|
|
143
|
-
partial_results?: boolean;
|
|
144
|
-
/** Continuous mode? */
|
|
145
|
-
continuous?: boolean;
|
|
146
|
-
}
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* Collect-input configuration — the canonical `calling.collect` params minus the
|
|
165
|
+
* transport keys (`node_id`/`call_id`/`control_id`) the SDK fills internally.
|
|
166
|
+
* The `digits`/`speech`/timer field types come straight from the RELAY schema.
|
|
167
|
+
*/
|
|
168
|
+
export type CollectConfig = Omit<CallingCollectParams, 'node_id' | 'call_id' | 'control_id'>;
|
|
169
|
+
/**
|
|
170
|
+
* A device descriptor accepted by `connect()` / `refer()` / `tap()`. Same
|
|
171
|
+
* wire-or-flat duality as {@link PlayItem}: {@link normalizeDevice} accepts a
|
|
172
|
+
* flat `{ type, to, from, … }` and expands it into `{ type, params }`, so the
|
|
173
|
+
* accepted-input type is an object with a `type` plus arbitrary other fields.
|
|
174
|
+
*/
|
|
175
|
+
export type DeviceInput = {
|
|
176
|
+
type: string;
|
|
177
|
+
} & Record<string, unknown>;
|
|
147
178
|
/** Queued request waiting for reconnection. */
|
|
148
179
|
export interface QueuedRequest {
|
|
149
180
|
method: string;
|
|
@@ -3,13 +3,22 @@
|
|
|
3
3
|
*
|
|
4
4
|
* All methods return parsed JSON. Throws RestError on non-2xx responses.
|
|
5
5
|
* Returns {} on 204 No Content.
|
|
6
|
+
*
|
|
7
|
+
* Transport behavior (timeout, opt-in retry with an idempotency-aware policy +
|
|
8
|
+
* exponential backoff, cooperative cancellation) is governed by the
|
|
9
|
+
* {@link RequestOptions} envelope (plan 4.2): a client default stored here, plus
|
|
10
|
+
* an optional per-request override each verb accepts. See RequestOptions.ts.
|
|
6
11
|
*/
|
|
7
12
|
import type { HttpClientOptions, QueryParams } from './types.js';
|
|
13
|
+
import { type RequestOptionsInit } from './RequestOptions.js';
|
|
14
|
+
/** The SDK's User-Agent, shared by the other HTTP clients (the AI Chat client). */
|
|
15
|
+
export declare function _userAgent(): string;
|
|
8
16
|
/**
|
|
9
17
|
* Low-level HTTP client used by every REST namespace resource.
|
|
10
18
|
*
|
|
11
|
-
* Handles Basic Auth, JSON encoding/decoding,
|
|
12
|
-
* ({@link RestError} on non-2xx)
|
|
19
|
+
* Handles Basic Auth, JSON encoding/decoding, error normalisation
|
|
20
|
+
* ({@link RestError} on non-2xx), and the {@link RequestOptions} transport
|
|
21
|
+
* envelope (timeout / retry / abort). Normally you do not instantiate this
|
|
13
22
|
* directly — construct a {@link RestClient} instead.
|
|
14
23
|
*/
|
|
15
24
|
export declare class HttpClient {
|
|
@@ -17,26 +26,41 @@ export declare class HttpClient {
|
|
|
17
26
|
readonly baseUrl: string;
|
|
18
27
|
private readonly _authHeader;
|
|
19
28
|
private readonly _fetch;
|
|
29
|
+
/** Client-default request options, shallow-overridden per request. */
|
|
30
|
+
private readonly _requestOptions?;
|
|
20
31
|
/**
|
|
21
32
|
* Build a new HTTP client.
|
|
22
33
|
*
|
|
23
34
|
* @param options - Connection options. Either `host` (bare hostname;
|
|
24
35
|
* `https://` is prepended automatically) or `baseUrl` (fully-qualified)
|
|
25
|
-
* must be provided along with `project` + `token`.
|
|
36
|
+
* must be provided along with `project` + `token`. An optional
|
|
37
|
+
* `requestOptions` sets the client-default transport envelope.
|
|
26
38
|
* @throws {Error} When neither `host` nor `baseUrl` is supplied.
|
|
27
39
|
*/
|
|
28
40
|
constructor(options: HttpClientOptions);
|
|
41
|
+
/** Parse a `Retry-After` header (delta-seconds form) if present, else null. */
|
|
42
|
+
private _retryAfterSeconds;
|
|
29
43
|
private _request;
|
|
44
|
+
/**
|
|
45
|
+
* Build the per-attempt `AbortSignal` fed to fetch: the caller's abortSignal
|
|
46
|
+
* (TRUE in-flight cancellation) combined with a per-attempt timeout. A fresh
|
|
47
|
+
* timeout is created for each attempt so the wall-clock budget is per attempt,
|
|
48
|
+
* matching the contract. When neither applies, returns undefined.
|
|
49
|
+
*/
|
|
50
|
+
private _attemptSignal;
|
|
51
|
+
/** Whether an error is an AbortError (fetch abort or timeout). */
|
|
52
|
+
private _isAbort;
|
|
30
53
|
/**
|
|
31
54
|
* Perform an authenticated HTTP GET and return the parsed JSON response.
|
|
32
55
|
*
|
|
33
56
|
* @typeParam T - Expected response body type.
|
|
34
57
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
35
58
|
* @param params - Optional query parameters; `undefined` values are skipped.
|
|
59
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
36
60
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
37
61
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
38
62
|
*/
|
|
39
|
-
get<T =
|
|
63
|
+
get<T = unknown>(path: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>;
|
|
40
64
|
/**
|
|
41
65
|
* Perform an authenticated HTTP POST and return the parsed JSON response.
|
|
42
66
|
*
|
|
@@ -44,37 +68,41 @@ export declare class HttpClient {
|
|
|
44
68
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
45
69
|
* @param body - JSON-serialisable request body. Omit to send no body.
|
|
46
70
|
* @param params - Optional query parameters appended to the URL.
|
|
71
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
47
72
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
48
73
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
49
74
|
*/
|
|
50
|
-
post<T =
|
|
75
|
+
post<T = unknown>(path: string, body?: unknown, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>;
|
|
51
76
|
/**
|
|
52
77
|
* Perform an authenticated HTTP PUT and return the parsed JSON response.
|
|
53
78
|
*
|
|
54
79
|
* @typeParam T - Expected response body type.
|
|
55
80
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
56
81
|
* @param body - JSON-serialisable request body.
|
|
82
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
57
83
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
58
84
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
59
85
|
*/
|
|
60
|
-
put<T =
|
|
86
|
+
put<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>;
|
|
61
87
|
/**
|
|
62
88
|
* Perform an authenticated HTTP PATCH and return the parsed JSON response.
|
|
63
89
|
*
|
|
64
90
|
* @typeParam T - Expected response body type.
|
|
65
91
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
66
92
|
* @param body - JSON-serialisable partial request body.
|
|
93
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
67
94
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
68
95
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
69
96
|
*/
|
|
70
|
-
patch<T =
|
|
97
|
+
patch<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>;
|
|
71
98
|
/**
|
|
72
99
|
* Perform an authenticated HTTP DELETE and return the parsed JSON response.
|
|
73
100
|
*
|
|
74
101
|
* @typeParam T - Expected response body type.
|
|
75
102
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
103
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
76
104
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
77
105
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
78
106
|
*/
|
|
79
|
-
delete<T =
|
|
107
|
+
delete<T = unknown>(path: string, requestOptions?: RequestOptionsInit): Promise<T>;
|
|
80
108
|
}
|
package/dist/rest/HttpClient.js
CHANGED
|
@@ -3,16 +3,116 @@
|
|
|
3
3
|
*
|
|
4
4
|
* All methods return parsed JSON. Throws RestError on non-2xx responses.
|
|
5
5
|
* Returns {} on 204 No Content.
|
|
6
|
+
*
|
|
7
|
+
* Transport behavior (timeout, opt-in retry with an idempotency-aware policy +
|
|
8
|
+
* exponential backoff, cooperative cancellation) is governed by the
|
|
9
|
+
* {@link RequestOptions} envelope (plan 4.2): a client default stored here, plus
|
|
10
|
+
* an optional per-request override each verb accepts. See RequestOptions.ts.
|
|
6
11
|
*/
|
|
7
|
-
|
|
12
|
+
import { createRequire } from 'node:module';
|
|
8
13
|
import { getLogger } from '../Logger.js';
|
|
9
|
-
import { RestError } from './RestError.js';
|
|
14
|
+
import { RestError, RestTransportError } from './RestError.js';
|
|
15
|
+
import { resolve, statusIsRetryable, } from './RequestOptions.js';
|
|
10
16
|
const logger = getLogger('rest_client');
|
|
17
|
+
/**
|
|
18
|
+
* True if `host` (bare host or host:port) is a local loopback address — a local
|
|
19
|
+
* mock/dev server that speaks plain HTTP. Used to pick `http://` vs `https://`
|
|
20
|
+
* so a shipped example runs verbatim against the local mock
|
|
21
|
+
* (SIGNALWIRE_SPACE=127.0.0.1:<port>) without a code change. A real SignalWire
|
|
22
|
+
* space (`<name>.signalwire.com`) is never loopback, so production is unaffected.
|
|
23
|
+
* Mirrors the python reference `rest/_base.py:_is_loopback_host`.
|
|
24
|
+
*
|
|
25
|
+
* Module-private (not exported) — an internal transport helper, not public API
|
|
26
|
+
* surface. RestClient reaches it by passing `host` to this HttpClient rather
|
|
27
|
+
* than pre-building the URL, so the scheme decision lives in one place here.
|
|
28
|
+
*/
|
|
29
|
+
function isLoopbackHost(host) {
|
|
30
|
+
const hostname = host.includes(':') ? host.slice(0, host.lastIndexOf(':')) : host;
|
|
31
|
+
return (hostname === '127.0.0.1' ||
|
|
32
|
+
hostname === 'localhost' ||
|
|
33
|
+
hostname === '::1' ||
|
|
34
|
+
hostname === '[::1]');
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* REST client User-Agent, derived at runtime from the installed package version
|
|
38
|
+
* so it can never drift from a hardcoded literal (the token used to be a stale
|
|
39
|
+
* `@signalwire/sdk-ts/2.0.0` while the package moved on). The product token is
|
|
40
|
+
* `signalwire-typescript`, mirroring the Python reference's `signalwire-python/<v>`.
|
|
41
|
+
*
|
|
42
|
+
* `../../package.json` resolves identically in both layouts — from `src/rest/`
|
|
43
|
+
* during dev (tsx) and from `dist/rest/` when installed — since package.json
|
|
44
|
+
* always ships at the package root two levels above this module.
|
|
45
|
+
*/
|
|
46
|
+
function buildUserAgent() {
|
|
47
|
+
let version = 'unknown';
|
|
48
|
+
try {
|
|
49
|
+
const require = createRequire(import.meta.url);
|
|
50
|
+
const pkg = require('../../package.json');
|
|
51
|
+
if (pkg.version)
|
|
52
|
+
version = pkg.version;
|
|
53
|
+
}
|
|
54
|
+
catch {
|
|
55
|
+
// Uninstalled / unusual bundling — fall back to the stable product token.
|
|
56
|
+
}
|
|
57
|
+
return `signalwire-typescript/${version}`;
|
|
58
|
+
}
|
|
59
|
+
const USER_AGENT = buildUserAgent();
|
|
60
|
+
/** The SDK's User-Agent, shared by the other HTTP clients (the AI Chat client). */
|
|
61
|
+
export function _userAgent() {
|
|
62
|
+
return USER_AGENT;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Cached undici dispatcher trusting a custom REST CA bundle, built lazily on
|
|
66
|
+
* first use from `SIGNALWIRE_REST_CA_FILE` (A5 fleet CA-var contract, hard-cut,
|
|
67
|
+
* no aliases). When the env var names a CA bundle, it becomes the REST HTTP
|
|
68
|
+
* client's TLS trust root — the exact REST half of the fleet pair
|
|
69
|
+
* (`SIGNALWIRE_RELAY_CA_FILE` is the RELAY half). Unset → node's default trust
|
|
70
|
+
* store (no dispatcher attached). Mirrors the python reference
|
|
71
|
+
* (`rest/_base.py:163` — `session.verify = SIGNALWIRE_REST_CA_FILE`).
|
|
72
|
+
*
|
|
73
|
+
* The result is cached per resolved file path so repeated requests reuse one
|
|
74
|
+
* connection pool. Returns `undefined` when the env var is unset (or the file
|
|
75
|
+
* cannot be read — in which case node's default trust store applies and the
|
|
76
|
+
* platform cert still validates against the public roots).
|
|
77
|
+
*/
|
|
78
|
+
let _restCaDispatcher;
|
|
79
|
+
function restCaDispatcher() {
|
|
80
|
+
const caFile = process.env['SIGNALWIRE_REST_CA_FILE'];
|
|
81
|
+
if (!caFile)
|
|
82
|
+
return undefined;
|
|
83
|
+
if (_restCaDispatcher?.key === caFile)
|
|
84
|
+
return _restCaDispatcher.dispatcher;
|
|
85
|
+
try {
|
|
86
|
+
// Imported lazily so environments without undici (or where the var is never
|
|
87
|
+
// set) pay nothing at module load.
|
|
88
|
+
const require = createRequire(import.meta.url);
|
|
89
|
+
const { Agent } = require('undici');
|
|
90
|
+
const { readFileSync } = require('node:fs');
|
|
91
|
+
const ca = readFileSync(caFile);
|
|
92
|
+
const dispatcher = new Agent({ connect: { ca } });
|
|
93
|
+
_restCaDispatcher = { key: caFile, dispatcher };
|
|
94
|
+
return dispatcher;
|
|
95
|
+
}
|
|
96
|
+
catch (err) {
|
|
97
|
+
logger.warn('rest_ca_file_load_failed', {
|
|
98
|
+
file: caFile,
|
|
99
|
+
error: err instanceof Error ? err.message : String(err),
|
|
100
|
+
});
|
|
101
|
+
return undefined;
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
/** Backoff sleep between retries (a Promise-based delay). */
|
|
105
|
+
function sleep(seconds) {
|
|
106
|
+
if (seconds <= 0)
|
|
107
|
+
return Promise.resolve();
|
|
108
|
+
return new Promise((r) => setTimeout(r, seconds * 1000));
|
|
109
|
+
}
|
|
11
110
|
/**
|
|
12
111
|
* Low-level HTTP client used by every REST namespace resource.
|
|
13
112
|
*
|
|
14
|
-
* Handles Basic Auth, JSON encoding/decoding,
|
|
15
|
-
* ({@link RestError} on non-2xx)
|
|
113
|
+
* Handles Basic Auth, JSON encoding/decoding, error normalisation
|
|
114
|
+
* ({@link RestError} on non-2xx), and the {@link RequestOptions} transport
|
|
115
|
+
* envelope (timeout / retry / abort). Normally you do not instantiate this
|
|
16
116
|
* directly — construct a {@link RestClient} instead.
|
|
17
117
|
*/
|
|
18
118
|
export class HttpClient {
|
|
@@ -20,12 +120,15 @@ export class HttpClient {
|
|
|
20
120
|
baseUrl;
|
|
21
121
|
_authHeader;
|
|
22
122
|
_fetch;
|
|
123
|
+
/** Client-default request options, shallow-overridden per request. */
|
|
124
|
+
_requestOptions;
|
|
23
125
|
/**
|
|
24
126
|
* Build a new HTTP client.
|
|
25
127
|
*
|
|
26
128
|
* @param options - Connection options. Either `host` (bare hostname;
|
|
27
129
|
* `https://` is prepended automatically) or `baseUrl` (fully-qualified)
|
|
28
|
-
* must be provided along with `project` + `token`.
|
|
130
|
+
* must be provided along with `project` + `token`. An optional
|
|
131
|
+
* `requestOptions` sets the client-default transport envelope.
|
|
29
132
|
* @throws {Error} When neither `host` nor `baseUrl` is supplied.
|
|
30
133
|
*/
|
|
31
134
|
constructor(options) {
|
|
@@ -33,13 +136,27 @@ export class HttpClient {
|
|
|
33
136
|
throw new Error('HttpClientOptions requires either "host" or "baseUrl".');
|
|
34
137
|
}
|
|
35
138
|
// host takes precedence (matches Python's HttpClient(project, token, host) convention
|
|
36
|
-
// where a bare hostname is expected and
|
|
37
|
-
|
|
139
|
+
// where a bare hostname is expected and the scheme is prepended automatically).
|
|
140
|
+
// A loopback host (127.0.0.1[:port] / localhost) is a local mock/dev server that
|
|
141
|
+
// speaks plain HTTP — use http:// for it; every other host uses https://.
|
|
142
|
+
const rawUrl = options.host
|
|
143
|
+
? `${isLoopbackHost(options.host) ? 'http' : 'https'}://${options.host}`
|
|
144
|
+
: options.baseUrl;
|
|
38
145
|
this.baseUrl = rawUrl.replace(/\/+$/, '');
|
|
39
|
-
this._authHeader =
|
|
146
|
+
this._authHeader =
|
|
147
|
+
'Basic ' + Buffer.from(`${options.project}:${options.token}`).toString('base64');
|
|
40
148
|
this._fetch = options.fetchImpl ?? globalThis.fetch;
|
|
149
|
+
this._requestOptions = options.requestOptions;
|
|
41
150
|
}
|
|
42
|
-
|
|
151
|
+
/** Parse a `Retry-After` header (delta-seconds form) if present, else null. */
|
|
152
|
+
_retryAfterSeconds(resp) {
|
|
153
|
+
const value = resp.headers.get('Retry-After');
|
|
154
|
+
if (value === null)
|
|
155
|
+
return null;
|
|
156
|
+
const n = Number(value);
|
|
157
|
+
return Number.isFinite(n) ? n : null; // HTTP-date form: fall back to backoff
|
|
158
|
+
}
|
|
159
|
+
async _request(method, path, body, params, requestOptions) {
|
|
43
160
|
let url = path.startsWith('http') ? path : `${this.baseUrl}${path}`;
|
|
44
161
|
if (params) {
|
|
45
162
|
const qs = new URLSearchParams();
|
|
@@ -51,38 +168,109 @@ export class HttpClient {
|
|
|
51
168
|
if (qsStr)
|
|
52
169
|
url += (url.includes('?') ? '&' : '?') + qsStr;
|
|
53
170
|
}
|
|
171
|
+
const opts = resolve(this._requestOptions, requestOptions);
|
|
54
172
|
logger.debug(`${method} ${url}`);
|
|
55
173
|
const headers = {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
'User-Agent':
|
|
174
|
+
Authorization: this._authHeader,
|
|
175
|
+
Accept: 'application/json',
|
|
176
|
+
'User-Agent': USER_AGENT,
|
|
59
177
|
};
|
|
60
178
|
if (body !== undefined) {
|
|
61
179
|
headers['Content-Type'] = 'application/json';
|
|
62
180
|
}
|
|
63
|
-
const
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
181
|
+
const encodedBody = body !== undefined ? JSON.stringify(body) : undefined;
|
|
182
|
+
// total attempts = retries + 1; retry on a retryable status (idempotency-
|
|
183
|
+
// aware) or a transport error, honoring Retry-After then exponential
|
|
184
|
+
// backoff. abortSignal is checked cooperatively before every attempt AND
|
|
185
|
+
// passed to fetch for TRUE in-flight abort.
|
|
186
|
+
let attempt = 0;
|
|
187
|
+
for (;;) {
|
|
188
|
+
attempt += 1;
|
|
189
|
+
if (opts.abortSignal?.aborted) {
|
|
190
|
+
// Cancelled before this attempt — surface as the transport-error family
|
|
191
|
+
// (no response was produced), not a bare exception.
|
|
192
|
+
throw new RestTransportError('request cancelled by abortSignal', url, method);
|
|
193
|
+
}
|
|
194
|
+
let resp;
|
|
71
195
|
try {
|
|
72
|
-
|
|
196
|
+
// Attach the custom-CA dispatcher when SIGNALWIRE_REST_CA_FILE is set so
|
|
197
|
+
// the platform cert validates against the supplied trust bundle (A5).
|
|
198
|
+
const init = {
|
|
199
|
+
method,
|
|
200
|
+
headers,
|
|
201
|
+
body: encodedBody,
|
|
202
|
+
signal: this._attemptSignal(opts),
|
|
203
|
+
};
|
|
204
|
+
const dispatcher = restCaDispatcher();
|
|
205
|
+
if (dispatcher !== undefined)
|
|
206
|
+
init.dispatcher = dispatcher;
|
|
207
|
+
resp = await this._fetch(url, init);
|
|
73
208
|
}
|
|
74
|
-
catch {
|
|
75
|
-
//
|
|
209
|
+
catch (err) {
|
|
210
|
+
// Transport failure (connection refused / DNS / reset / TLS / timeout /
|
|
211
|
+
// abort): fetch rejects and the request never produced a response.
|
|
212
|
+
// Retry if attempts remain, else wrap in the typed error family so a
|
|
213
|
+
// caller catching RestError handles it too.
|
|
214
|
+
if (this._isAbort(err) && opts.abortSignal?.aborted) {
|
|
215
|
+
// A user-driven abort (not a timeout) is terminal — do not retry.
|
|
216
|
+
throw new RestTransportError('request cancelled by abortSignal', url, method);
|
|
217
|
+
}
|
|
218
|
+
if (attempt <= opts.retries) {
|
|
219
|
+
await sleep(opts.retryBackoff * 2 ** (attempt - 1));
|
|
220
|
+
continue;
|
|
221
|
+
}
|
|
222
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
223
|
+
throw new RestTransportError(message, url, method);
|
|
76
224
|
}
|
|
77
|
-
|
|
225
|
+
if (!resp.ok) {
|
|
226
|
+
if (attempt <= opts.retries && statusIsRetryable(method, resp.status, opts)) {
|
|
227
|
+
let delay = this._retryAfterSeconds(resp);
|
|
228
|
+
if (delay === null)
|
|
229
|
+
delay = opts.retryBackoff * 2 ** (attempt - 1);
|
|
230
|
+
await sleep(delay);
|
|
231
|
+
continue;
|
|
232
|
+
}
|
|
233
|
+
const text = await resp.text();
|
|
234
|
+
let errBody = text;
|
|
235
|
+
try {
|
|
236
|
+
errBody = JSON.parse(text);
|
|
237
|
+
}
|
|
238
|
+
catch {
|
|
239
|
+
// Response was not valid JSON — keep as plain string.
|
|
240
|
+
}
|
|
241
|
+
// §6.6 error-observability: capture the response header map so RestError
|
|
242
|
+
// can surface the platform request id (x-request-id etc.) — no wire change.
|
|
243
|
+
const respHeaders = {};
|
|
244
|
+
resp.headers.forEach((v, k) => {
|
|
245
|
+
respHeaders[k] = v;
|
|
246
|
+
});
|
|
247
|
+
throw new RestError(resp.status, errBody, url, method, respHeaders);
|
|
248
|
+
}
|
|
249
|
+
if (resp.status === 204) {
|
|
250
|
+
return {};
|
|
251
|
+
}
|
|
252
|
+
const text = await resp.text();
|
|
253
|
+
if (!text)
|
|
254
|
+
return {};
|
|
255
|
+
return JSON.parse(text);
|
|
78
256
|
}
|
|
79
|
-
|
|
80
|
-
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Build the per-attempt `AbortSignal` fed to fetch: the caller's abortSignal
|
|
260
|
+
* (TRUE in-flight cancellation) combined with a per-attempt timeout. A fresh
|
|
261
|
+
* timeout is created for each attempt so the wall-clock budget is per attempt,
|
|
262
|
+
* matching the contract. When neither applies, returns undefined.
|
|
263
|
+
*/
|
|
264
|
+
_attemptSignal(opts) {
|
|
265
|
+
const timeoutSignal = opts.timeout > 0 ? AbortSignal.timeout(opts.timeout * 1000) : undefined;
|
|
266
|
+
if (opts.abortSignal && timeoutSignal) {
|
|
267
|
+
return AbortSignal.any([opts.abortSignal, timeoutSignal]);
|
|
81
268
|
}
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
269
|
+
return opts.abortSignal ?? timeoutSignal;
|
|
270
|
+
}
|
|
271
|
+
/** Whether an error is an AbortError (fetch abort or timeout). */
|
|
272
|
+
_isAbort(err) {
|
|
273
|
+
return err instanceof Error && (err.name === 'AbortError' || err.name === 'TimeoutError');
|
|
86
274
|
}
|
|
87
275
|
/**
|
|
88
276
|
* Perform an authenticated HTTP GET and return the parsed JSON response.
|
|
@@ -90,11 +278,12 @@ export class HttpClient {
|
|
|
90
278
|
* @typeParam T - Expected response body type.
|
|
91
279
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
92
280
|
* @param params - Optional query parameters; `undefined` values are skipped.
|
|
281
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
93
282
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
94
283
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
95
284
|
*/
|
|
96
|
-
async get(path, params) {
|
|
97
|
-
return this._request('GET', path, undefined, params);
|
|
285
|
+
async get(path, params, requestOptions) {
|
|
286
|
+
return this._request('GET', path, undefined, params, requestOptions);
|
|
98
287
|
}
|
|
99
288
|
/**
|
|
100
289
|
* Perform an authenticated HTTP POST and return the parsed JSON response.
|
|
@@ -103,11 +292,12 @@ export class HttpClient {
|
|
|
103
292
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
104
293
|
* @param body - JSON-serialisable request body. Omit to send no body.
|
|
105
294
|
* @param params - Optional query parameters appended to the URL.
|
|
295
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
106
296
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
107
297
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
108
298
|
*/
|
|
109
|
-
async post(path, body, params) {
|
|
110
|
-
return this._request('POST', path, body, params);
|
|
299
|
+
async post(path, body, params, requestOptions) {
|
|
300
|
+
return this._request('POST', path, body, params, requestOptions);
|
|
111
301
|
}
|
|
112
302
|
/**
|
|
113
303
|
* Perform an authenticated HTTP PUT and return the parsed JSON response.
|
|
@@ -115,11 +305,12 @@ export class HttpClient {
|
|
|
115
305
|
* @typeParam T - Expected response body type.
|
|
116
306
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
117
307
|
* @param body - JSON-serialisable request body.
|
|
308
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
118
309
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
119
310
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
120
311
|
*/
|
|
121
|
-
async put(path, body) {
|
|
122
|
-
return this._request('PUT', path, body);
|
|
312
|
+
async put(path, body, requestOptions) {
|
|
313
|
+
return this._request('PUT', path, body, undefined, requestOptions);
|
|
123
314
|
}
|
|
124
315
|
/**
|
|
125
316
|
* Perform an authenticated HTTP PATCH and return the parsed JSON response.
|
|
@@ -127,22 +318,24 @@ export class HttpClient {
|
|
|
127
318
|
* @typeParam T - Expected response body type.
|
|
128
319
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
129
320
|
* @param body - JSON-serialisable partial request body.
|
|
321
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
130
322
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
131
323
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
132
324
|
*/
|
|
133
|
-
async patch(path, body) {
|
|
134
|
-
return this._request('PATCH', path, body);
|
|
325
|
+
async patch(path, body, requestOptions) {
|
|
326
|
+
return this._request('PATCH', path, body, undefined, requestOptions);
|
|
135
327
|
}
|
|
136
328
|
/**
|
|
137
329
|
* Perform an authenticated HTTP DELETE and return the parsed JSON response.
|
|
138
330
|
*
|
|
139
331
|
* @typeParam T - Expected response body type.
|
|
140
332
|
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
333
|
+
* @param requestOptions - Optional per-request transport envelope override.
|
|
141
334
|
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
142
335
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
143
336
|
*/
|
|
144
|
-
async delete(path) {
|
|
145
|
-
return this._request('DELETE', path);
|
|
337
|
+
async delete(path, requestOptions) {
|
|
338
|
+
return this._request('DELETE', path, undefined, undefined, requestOptions);
|
|
146
339
|
}
|
|
147
340
|
}
|
|
148
341
|
//# sourceMappingURL=HttpClient.js.map
|