@signalwire/sdk 2.0.5 → 3.6.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 +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- 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 +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -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 +169 -59
- package/dist/SWMLService.js +456 -129
- 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/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- 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 +139 -7
- package/dist/SwaigFunction.js +170 -22
- 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 +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -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 +111 -21
- 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 +3641 -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 +1207 -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 +1986 -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,504 @@
|
|
|
1
|
+
# Appendix B: Docker Deployment
|
|
2
|
+
|
|
3
|
+
A container packages Fred with its Node.js version and dependencies, so it runs the same way on your machine and on a server. This appendix covers the Docker files in `tutorial/fred/`, how to build and run them, and what changes in production.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [Why Docker?](#why-docker)
|
|
8
|
+
2. [Docker Files Overview](#docker-files-overview)
|
|
9
|
+
3. [Basic Dockerfile](#basic-dockerfile)
|
|
10
|
+
4. [Multi-Stage Build](#multi-stage-build)
|
|
11
|
+
5. [Docker Compose Setup](#docker-compose-setup)
|
|
12
|
+
6. [Building and Running](#building-and-running)
|
|
13
|
+
7. [Production Best Practices](#production-best-practices)
|
|
14
|
+
8. [Container Registry Deployment](#container-registry-deployment)
|
|
15
|
+
9. [Kubernetes Deployment](#kubernetes-deployment)
|
|
16
|
+
10. [Troubleshooting Docker Deployments](#troubleshooting-docker-deployments)
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Why Docker?
|
|
21
|
+
|
|
22
|
+
Running Fred in a container has five benefits:
|
|
23
|
+
|
|
24
|
+
- **Consistency**: the same environment everywhere
|
|
25
|
+
- **Isolation**: Fred's dependencies can't conflict with other software
|
|
26
|
+
- **Scalability**: more copies of Fred start from the same image
|
|
27
|
+
- **Portability**: the image runs on any host with Docker
|
|
28
|
+
- **Security**: the process runs as an unprivileged user, with limited access to the host
|
|
29
|
+
|
|
30
|
+
## Docker Files Overview
|
|
31
|
+
|
|
32
|
+
The tutorial directory includes four Docker-related files:
|
|
33
|
+
|
|
34
|
+
1. **`Dockerfile`**: a single-stage build that runs `fred.ts` with `tsx`
|
|
35
|
+
2. **`Dockerfile.multi`**: a multi-stage build that compiles Fred to JavaScript and produces a smaller image
|
|
36
|
+
3. **`docker-compose.yml`**: settings for running Fred with Docker Compose
|
|
37
|
+
4. **`.env.example`**: the settings Compose reads, to copy to `.env`
|
|
38
|
+
|
|
39
|
+
Both Dockerfiles copy `package.json` and `package-lock.json`, and install with `npm ci`. Run `npm install` once in the project to create the lock file before you build.
|
|
40
|
+
|
|
41
|
+
## Basic Dockerfile
|
|
42
|
+
|
|
43
|
+
### File: `Dockerfile`
|
|
44
|
+
|
|
45
|
+
The single-stage `Dockerfile` installs the dependencies and runs Fred as an unprivileged user:
|
|
46
|
+
|
|
47
|
+
<!-- copy of: tutorial/fred/Dockerfile -->
|
|
48
|
+
```dockerfile
|
|
49
|
+
# Use the official Node.js runtime as the base image
|
|
50
|
+
FROM node:22-slim
|
|
51
|
+
|
|
52
|
+
# Set working directory in container
|
|
53
|
+
WORKDIR /app
|
|
54
|
+
|
|
55
|
+
# Copy the package files first, so the dependency layer is cached
|
|
56
|
+
COPY package.json package-lock.json ./
|
|
57
|
+
|
|
58
|
+
# Install the dependencies, including tsx, which runs fred.ts
|
|
59
|
+
RUN npm ci && npm cache clean --force
|
|
60
|
+
|
|
61
|
+
# Copy Fred application
|
|
62
|
+
COPY fred.ts ./
|
|
63
|
+
|
|
64
|
+
# Run as the unprivileged node user the image provides. The files stay owned
|
|
65
|
+
# by root, so Fred can read its code but not change it.
|
|
66
|
+
USER node
|
|
67
|
+
|
|
68
|
+
# Expose the port Fred runs on
|
|
69
|
+
EXPOSE 3000
|
|
70
|
+
|
|
71
|
+
# Health check: /fred/health needs no credentials. The check fails when Fred
|
|
72
|
+
# doesn't answer, or answers with a status outside 200 to 299.
|
|
73
|
+
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
|
|
74
|
+
CMD node -e "fetch('http://localhost:3000/fred/health').then((r) => process.exit(r.ok ? 0 : 1), () => process.exit(1))"
|
|
75
|
+
|
|
76
|
+
# Run Fred in one process, so it receives the stop signal itself
|
|
77
|
+
CMD ["node", "--import", "tsx", "fred.ts"]
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
The official Node.js images include an unprivileged user named `node`, so the Dockerfile doesn't create one. The health check calls `/fred/health`, which needs no credentials, with the `fetch` function built into Node.js. The command exits with status 1 when the request fails or Fred answers with an error, so Docker marks the container unhealthy when Fred stops answering.
|
|
81
|
+
|
|
82
|
+
`CMD` runs `node --import tsx` in place of `npx tsx`, so Fred is the container's main process and receives the signal `docker stop` sends. `tsx` is a development dependency, and `npm ci` installs those too.
|
|
83
|
+
|
|
84
|
+
## Multi-Stage Build
|
|
85
|
+
|
|
86
|
+
### File: `Dockerfile.multi`
|
|
87
|
+
|
|
88
|
+
A multi-stage build compiles Fred in one image and copies only the result into the final one. TypeScript, `tsx` and the other development packages stay out of it:
|
|
89
|
+
|
|
90
|
+
<!-- copy of: tutorial/fred/Dockerfile.multi -->
|
|
91
|
+
```dockerfile
|
|
92
|
+
# Stage 1: type-check and compile fred.ts to JavaScript
|
|
93
|
+
FROM node:22-slim AS builder
|
|
94
|
+
|
|
95
|
+
# Set working directory
|
|
96
|
+
WORKDIR /app
|
|
97
|
+
|
|
98
|
+
# Install every dependency, including the TypeScript compiler
|
|
99
|
+
COPY package.json package-lock.json ./
|
|
100
|
+
RUN npm ci
|
|
101
|
+
|
|
102
|
+
# Compile Fred. A type error fails the build here.
|
|
103
|
+
COPY tsconfig.json fred.ts ./
|
|
104
|
+
RUN npx tsc
|
|
105
|
+
|
|
106
|
+
# Stage 2: runtime environment, with the compiled JavaScript only
|
|
107
|
+
FROM node:22-slim
|
|
108
|
+
|
|
109
|
+
# Set environment variables
|
|
110
|
+
ENV NODE_ENV=production
|
|
111
|
+
|
|
112
|
+
# Set working directory
|
|
113
|
+
WORKDIR /app
|
|
114
|
+
|
|
115
|
+
# Install the runtime dependencies only: no tsx, no TypeScript
|
|
116
|
+
COPY package.json package-lock.json ./
|
|
117
|
+
RUN npm ci --omit=dev && npm cache clean --force
|
|
118
|
+
|
|
119
|
+
# Copy the compiled application from the builder
|
|
120
|
+
COPY --from=builder /app/dist/fred.js ./
|
|
121
|
+
|
|
122
|
+
# Run as the unprivileged node user the image provides. The files stay owned
|
|
123
|
+
# by root, so Fred can read its code but not change it.
|
|
124
|
+
USER node
|
|
125
|
+
|
|
126
|
+
# Expose port
|
|
127
|
+
EXPOSE 3000
|
|
128
|
+
|
|
129
|
+
# Health check: /fred/health needs no credentials. The check fails when Fred
|
|
130
|
+
# doesn't answer, or answers with a status outside 200 to 299.
|
|
131
|
+
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
|
|
132
|
+
CMD node -e "fetch('http://localhost:3000/fred/health').then((r) => process.exit(r.ok ? 0 : 1), () => process.exit(1))"
|
|
133
|
+
|
|
134
|
+
# Run Fred
|
|
135
|
+
CMD ["node", "fred.js"]
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
The builder runs `tsc`, which checks Fred's types before it compiles, so a type error stops the build. The final image runs the compiled `fred.js` with plain Node.js. Built from the same project, it came to about 250 MB, against about 290 MB for the single-stage image.
|
|
139
|
+
|
|
140
|
+
## Docker Compose Setup
|
|
141
|
+
|
|
142
|
+
### File: `docker-compose.yml`
|
|
143
|
+
|
|
144
|
+
Compose keeps the settings for running Fred in one file:
|
|
145
|
+
|
|
146
|
+
<!-- copy of: tutorial/fred/docker-compose.yml -->
|
|
147
|
+
```yaml
|
|
148
|
+
services:
|
|
149
|
+
fred:
|
|
150
|
+
# Build from local Dockerfile
|
|
151
|
+
build:
|
|
152
|
+
context: .
|
|
153
|
+
dockerfile: Dockerfile
|
|
154
|
+
|
|
155
|
+
# Container name
|
|
156
|
+
container_name: fred-bot
|
|
157
|
+
|
|
158
|
+
# Restart policy
|
|
159
|
+
restart: unless-stopped
|
|
160
|
+
|
|
161
|
+
# Port mapping
|
|
162
|
+
ports:
|
|
163
|
+
- "3000:3000"
|
|
164
|
+
|
|
165
|
+
# Environment variables
|
|
166
|
+
environment:
|
|
167
|
+
# Authentication: Compose refuses to start without a password
|
|
168
|
+
- SWML_BASIC_AUTH_USER=${FRED_AUTH_USER:-fred}
|
|
169
|
+
- SWML_BASIC_AUTH_PASSWORD=${FRED_AUTH_PASSWORD:?Set FRED_AUTH_PASSWORD in .env}
|
|
170
|
+
|
|
171
|
+
# Request signatures, and one tool-token secret for every copy of Fred
|
|
172
|
+
- SIGNALWIRE_SIGNING_KEY=${SIGNALWIRE_SIGNING_KEY:-}
|
|
173
|
+
- SIGNALWIRE_SWAIG_SECRET=${SIGNALWIRE_SWAIG_SECRET:-}
|
|
174
|
+
|
|
175
|
+
# SignalWire configuration
|
|
176
|
+
- SWML_PROXY_URL_BASE=${PROXY_URL:-}
|
|
177
|
+
|
|
178
|
+
# Timezone
|
|
179
|
+
- TZ=America/New_York
|
|
180
|
+
|
|
181
|
+
# Health check
|
|
182
|
+
healthcheck:
|
|
183
|
+
test: ["CMD", "node", "-e", "fetch('http://localhost:3000/fred/health').then((r) => process.exit(r.ok ? 0 : 1), () => process.exit(1))"]
|
|
184
|
+
interval: 30s
|
|
185
|
+
timeout: 10s
|
|
186
|
+
retries: 3
|
|
187
|
+
start_period: 40s
|
|
188
|
+
|
|
189
|
+
# Logging configuration
|
|
190
|
+
logging:
|
|
191
|
+
driver: "json-file"
|
|
192
|
+
options:
|
|
193
|
+
max-size: "10m"
|
|
194
|
+
max-file: "3"
|
|
195
|
+
|
|
196
|
+
# Resource limits
|
|
197
|
+
deploy:
|
|
198
|
+
resources:
|
|
199
|
+
limits:
|
|
200
|
+
cpus: '1'
|
|
201
|
+
memory: 512M
|
|
202
|
+
reservations:
|
|
203
|
+
cpus: '0.25'
|
|
204
|
+
memory: 128M
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Compose refuses to start until `FRED_AUTH_PASSWORD` has a value, so Fred never runs with a password someone could guess. Without it, Compose stops with this error:
|
|
208
|
+
|
|
209
|
+
```text
|
|
210
|
+
required variable FRED_AUTH_PASSWORD is missing a value: Set FRED_AUTH_PASSWORD in .env
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### File: `.env`
|
|
214
|
+
|
|
215
|
+
Compose reads `.env` from the same directory. Copy `.env.example` to `.env` and fill in the values:
|
|
216
|
+
|
|
217
|
+
<!-- copy of: tutorial/fred/.env.example -->
|
|
218
|
+
```bash
|
|
219
|
+
# Fred Bot Docker Environment Configuration
|
|
220
|
+
# Copy this file to .env and update with your values
|
|
221
|
+
|
|
222
|
+
# Authentication
|
|
223
|
+
FRED_AUTH_USER=fred
|
|
224
|
+
FRED_AUTH_PASSWORD=a-long-random-password
|
|
225
|
+
|
|
226
|
+
# Your project's signing key, from the SignalWire dashboard. With it set,
|
|
227
|
+
# Fred rejects requests SignalWire didn't sign.
|
|
228
|
+
SIGNALWIRE_SIGNING_KEY=
|
|
229
|
+
|
|
230
|
+
# The secret behind Fred's tool tokens. Set it so calls in progress survive
|
|
231
|
+
# a restart, and use the same value for every copy of Fred.
|
|
232
|
+
SIGNALWIRE_SWAIG_SECRET=
|
|
233
|
+
|
|
234
|
+
# Proxy configuration (if needed)
|
|
235
|
+
# PROXY_URL=https://your-domain.com
|
|
236
|
+
|
|
237
|
+
# Other settings
|
|
238
|
+
TZ=America/New_York
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Keep `.env` out of version control.
|
|
242
|
+
|
|
243
|
+
## Building and Running
|
|
244
|
+
|
|
245
|
+
You can run Fred with Docker directly, or with Compose.
|
|
246
|
+
|
|
247
|
+
### Using Docker Directly
|
|
248
|
+
|
|
249
|
+
Build the image, then run it with the credentials as environment variables:
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
# Build the image
|
|
253
|
+
docker build -t fred-bot:latest .
|
|
254
|
+
|
|
255
|
+
# Run with environment variables
|
|
256
|
+
docker run -d \
|
|
257
|
+
--name fred \
|
|
258
|
+
-p 3000:3000 \
|
|
259
|
+
-e SWML_BASIC_AUTH_USER=fred \
|
|
260
|
+
-e SWML_BASIC_AUTH_PASSWORD=a-long-random-password \
|
|
261
|
+
fred-bot:latest
|
|
262
|
+
|
|
263
|
+
# View logs
|
|
264
|
+
docker logs -f fred
|
|
265
|
+
|
|
266
|
+
# Stop Fred
|
|
267
|
+
docker stop fred
|
|
268
|
+
|
|
269
|
+
# Remove container
|
|
270
|
+
docker rm fred
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
To build the multi-stage image instead, name its file with `-f`:
|
|
274
|
+
|
|
275
|
+
```bash
|
|
276
|
+
docker build -f Dockerfile.multi -t fred-bot:latest .
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
After the start period, `docker inspect` reports the health check's result:
|
|
280
|
+
|
|
281
|
+
```bash
|
|
282
|
+
docker inspect -f '{{.State.Health.Status}}' fred
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
A running Fred reports:
|
|
286
|
+
|
|
287
|
+
```text
|
|
288
|
+
healthy
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Using Docker Compose
|
|
292
|
+
|
|
293
|
+
Compose builds the image when it needs to:
|
|
294
|
+
|
|
295
|
+
```bash
|
|
296
|
+
# Start Fred (builds if needed)
|
|
297
|
+
docker compose up -d
|
|
298
|
+
|
|
299
|
+
# View logs
|
|
300
|
+
docker compose logs -f
|
|
301
|
+
|
|
302
|
+
# Stop Fred
|
|
303
|
+
docker compose down
|
|
304
|
+
|
|
305
|
+
# Rebuild and restart
|
|
306
|
+
docker compose up -d --build
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
## Production Best Practices
|
|
310
|
+
|
|
311
|
+
A production deployment adds five things to these files.
|
|
312
|
+
|
|
313
|
+
### 1. Security Hardening
|
|
314
|
+
|
|
315
|
+
The images run Fred as the unprivileged `node` user, and the files in `/app` belong to root, so Fred can't change its own code. They copy only the package files and Fred's code, so no secrets end up in the image. Build production images from `Dockerfile.multi`, which leaves the TypeScript tools out of the final image.
|
|
316
|
+
|
|
317
|
+
### 2. Secrets Management
|
|
318
|
+
|
|
319
|
+
Keep secrets out of the Compose file and the image. Load them from an environment file that isn't committed to source control:
|
|
320
|
+
|
|
321
|
+
```yaml
|
|
322
|
+
# docker-compose using an env file for secrets
|
|
323
|
+
services:
|
|
324
|
+
fred:
|
|
325
|
+
# ... other config ...
|
|
326
|
+
env_file:
|
|
327
|
+
- ./secrets/fred.env # not committed
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
The file sets the variables the SDK reads:
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
# ./secrets/fred.env
|
|
334
|
+
SWML_BASIC_AUTH_USER=fred
|
|
335
|
+
SWML_BASIC_AUTH_PASSWORD=a-long-random-password
|
|
336
|
+
SIGNALWIRE_SIGNING_KEY=your-signing-key
|
|
337
|
+
SIGNALWIRE_SWAIG_SECRET=another-long-random-string
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
The SDK reads these variables from the process environment. [Lesson 6](06-running-testing.md#production-considerations) explains what each one protects.
|
|
341
|
+
|
|
342
|
+
### 3. Reverse Proxy Setup
|
|
343
|
+
|
|
344
|
+
A reverse proxy such as nginx terminates HTTPS in front of Fred:
|
|
345
|
+
|
|
346
|
+
```yaml
|
|
347
|
+
# docker-compose with nginx
|
|
348
|
+
services:
|
|
349
|
+
nginx:
|
|
350
|
+
image: nginx:alpine
|
|
351
|
+
ports:
|
|
352
|
+
- "80:80"
|
|
353
|
+
- "443:443"
|
|
354
|
+
volumes:
|
|
355
|
+
- ./nginx.conf:/etc/nginx/nginx.conf
|
|
356
|
+
- ./certs:/etc/nginx/certs
|
|
357
|
+
depends_on:
|
|
358
|
+
- fred
|
|
359
|
+
|
|
360
|
+
fred:
|
|
361
|
+
# Remove external port exposure
|
|
362
|
+
expose:
|
|
363
|
+
- "3000"
|
|
364
|
+
# ... rest of config ...
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
Set `SWML_PROXY_URL_BASE` to Fred's public HTTPS address, so the function URLs in its SWML point at the proxy.
|
|
368
|
+
|
|
369
|
+
### 4. Logging
|
|
370
|
+
|
|
371
|
+
Fred logs to standard output, so `docker logs` and your platform's log collector see everything. The Compose file's `json-file` driver keeps three files of up to 10 MB each. Fred's banner includes the password, so limit who can read the logs.
|
|
372
|
+
|
|
373
|
+
### 5. Running More Than One Copy
|
|
374
|
+
|
|
375
|
+
Every copy of Fred must use the same `SIGNALWIRE_SWAIG_SECRET`. A function's token is signed with that secret, and SignalWire may send the call's next request to a different copy. With different secrets, those requests are refused.
|
|
376
|
+
|
|
377
|
+
To run several copies with Compose, remove `container_name` and the fixed port mapping, and put a load balancer in front of them.
|
|
378
|
+
|
|
379
|
+
## Container Registry Deployment
|
|
380
|
+
|
|
381
|
+
To deploy from a registry, tag and push the image, then run it on the server with the secrets file:
|
|
382
|
+
|
|
383
|
+
```bash
|
|
384
|
+
# Tag for registry
|
|
385
|
+
docker tag fred-bot:latest myregistry.com/fred-bot:latest
|
|
386
|
+
|
|
387
|
+
# Push to registry
|
|
388
|
+
docker push myregistry.com/fred-bot:latest
|
|
389
|
+
|
|
390
|
+
# Deploy from registry
|
|
391
|
+
docker run -d \
|
|
392
|
+
--name fred \
|
|
393
|
+
-p 3000:3000 \
|
|
394
|
+
--env-file ./secrets/fred.env \
|
|
395
|
+
myregistry.com/fred-bot:latest
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
## Kubernetes Deployment
|
|
399
|
+
|
|
400
|
+
On Kubernetes, a Deployment runs the copies and reads the secrets from a Secret named `fred-secrets`:
|
|
401
|
+
|
|
402
|
+
```yaml
|
|
403
|
+
apiVersion: apps/v1
|
|
404
|
+
kind: Deployment
|
|
405
|
+
metadata:
|
|
406
|
+
name: fred-bot
|
|
407
|
+
spec:
|
|
408
|
+
replicas: 3
|
|
409
|
+
selector:
|
|
410
|
+
matchLabels:
|
|
411
|
+
app: fred-bot
|
|
412
|
+
template:
|
|
413
|
+
metadata:
|
|
414
|
+
labels:
|
|
415
|
+
app: fred-bot
|
|
416
|
+
spec:
|
|
417
|
+
containers:
|
|
418
|
+
- name: fred
|
|
419
|
+
image: myregistry.com/fred-bot:latest
|
|
420
|
+
ports:
|
|
421
|
+
- containerPort: 3000
|
|
422
|
+
env:
|
|
423
|
+
- name: SWML_BASIC_AUTH_USER
|
|
424
|
+
valueFrom:
|
|
425
|
+
secretKeyRef:
|
|
426
|
+
name: fred-secrets
|
|
427
|
+
key: username
|
|
428
|
+
- name: SWML_BASIC_AUTH_PASSWORD
|
|
429
|
+
valueFrom:
|
|
430
|
+
secretKeyRef:
|
|
431
|
+
name: fred-secrets
|
|
432
|
+
key: password
|
|
433
|
+
- name: SIGNALWIRE_SIGNING_KEY
|
|
434
|
+
valueFrom:
|
|
435
|
+
secretKeyRef:
|
|
436
|
+
name: fred-secrets
|
|
437
|
+
key: signing-key
|
|
438
|
+
- name: SIGNALWIRE_SWAIG_SECRET
|
|
439
|
+
valueFrom:
|
|
440
|
+
secretKeyRef:
|
|
441
|
+
name: fred-secrets
|
|
442
|
+
key: swaig-secret
|
|
443
|
+
livenessProbe:
|
|
444
|
+
httpGet:
|
|
445
|
+
path: /fred/health
|
|
446
|
+
port: 3000
|
|
447
|
+
resources:
|
|
448
|
+
requests:
|
|
449
|
+
memory: "128Mi"
|
|
450
|
+
cpu: "250m"
|
|
451
|
+
limits:
|
|
452
|
+
memory: "512Mi"
|
|
453
|
+
cpu: "1000m"
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
All three replicas read `SIGNALWIRE_SWAIG_SECRET` from the same Secret, so any replica can check a token another one issued.
|
|
457
|
+
|
|
458
|
+
## Troubleshooting Docker Deployments
|
|
459
|
+
|
|
460
|
+
These commands show what a container is doing.
|
|
461
|
+
|
|
462
|
+
### Check Container Status
|
|
463
|
+
|
|
464
|
+
List, inspect and measure the container:
|
|
465
|
+
|
|
466
|
+
```bash
|
|
467
|
+
# List containers
|
|
468
|
+
docker ps -a
|
|
469
|
+
|
|
470
|
+
# Inspect container
|
|
471
|
+
docker inspect fred
|
|
472
|
+
|
|
473
|
+
# Check resource usage
|
|
474
|
+
docker stats fred
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
### Debug Inside Container
|
|
478
|
+
|
|
479
|
+
Open a shell in the container, or run one command in it. The `node:22-slim` image has `sh` and `bash`:
|
|
480
|
+
|
|
481
|
+
```bash
|
|
482
|
+
# Execute shell in running container
|
|
483
|
+
docker exec -it fred /bin/bash
|
|
484
|
+
|
|
485
|
+
# Run one-off command
|
|
486
|
+
docker exec fred npm ls @signalwire/sdk
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
### Common Issues
|
|
490
|
+
|
|
491
|
+
Four problems come up most often:
|
|
492
|
+
|
|
493
|
+
1. **Port conflicts**: another program uses port 3000. Change the host side of the port mapping, for example `-p 3001:3000`.
|
|
494
|
+
2. **Permission errors**: Fred runs as `node`, which can't write to `/app`. Fred itself writes no files. A change that needs to write one should use a volume or a directory `node` owns, such as `/tmp`.
|
|
495
|
+
3. **Missing lock file**: `npm ci` needs `package-lock.json`. Run `npm install` in the project before you build.
|
|
496
|
+
4. **Refused tool calls**: with more than one copy, check that every copy has the same `SIGNALWIRE_SWAIG_SECRET`.
|
|
497
|
+
|
|
498
|
+
## Next Steps
|
|
499
|
+
|
|
500
|
+
Start with the single-stage `Dockerfile` while you develop, and move to `Dockerfile.multi` and a secrets file for production. To build an agent whose actions have consequences, continue with the [Full-Guardrails Agent tutorial](../../full-guardrails-agent/tutorial/README.md).
|
|
501
|
+
|
|
502
|
+
---
|
|
503
|
+
|
|
504
|
+
[Previous: Complete Code](appendix-complete-code.md) | [Overview](README.md)
|