@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
package/dist/PromptManager.d.ts
CHANGED
|
@@ -4,17 +4,38 @@
|
|
|
4
4
|
* Holds either raw prompt text or a PomBuilder for structured prompts.
|
|
5
5
|
*/
|
|
6
6
|
import { PomBuilder } from './PomBuilder.js';
|
|
7
|
+
import type { AgentBase } from './AgentBase.js';
|
|
7
8
|
/** Manages agent prompt text, supporting both raw text and structured POM-based prompts. */
|
|
8
9
|
export declare class PromptManager {
|
|
9
10
|
private rawText;
|
|
10
11
|
private postPrompt;
|
|
11
12
|
private pom;
|
|
12
13
|
private usePom;
|
|
14
|
+
/**
|
|
15
|
+
* The agent this manager belongs to (the reference's public `self.agent`,
|
|
16
|
+
* `core/agent/prompt/manager.py:32`), or `undefined` for standalone use.
|
|
17
|
+
*
|
|
18
|
+
* The reference takes the parent agent as its sole constructor argument and keeps
|
|
19
|
+
* it as a public back-reference. A caller holding the manager can therefore walk
|
|
20
|
+
* back to its owner; this is the read-back of that same value.
|
|
21
|
+
*/
|
|
22
|
+
readonly agent?: AgentBase;
|
|
13
23
|
/**
|
|
14
24
|
* Creates a new PromptManager.
|
|
15
25
|
* @param usePom - Whether to use structured POM sections (default true).
|
|
26
|
+
* @param agent - Optional parent agent, kept as a public back-reference
|
|
27
|
+
* (the reference's `PromptManager(agent)`). Omit for standalone use.
|
|
28
|
+
*/
|
|
29
|
+
constructor(usePom?: boolean, agent?: AgentBase);
|
|
30
|
+
/**
|
|
31
|
+
* A copy of this manager's prompt state (raw text, post-prompt and POM
|
|
32
|
+
* sections) owned by `agent`, for a per-request copy of the agent. The POM
|
|
33
|
+
* sections are deep-copied (every depth, every bullet list), not rendered to
|
|
34
|
+
* text, so the copy still emits a structured prompt, and nothing the copy
|
|
35
|
+
* changes reaches this manager.
|
|
36
|
+
* @internal
|
|
16
37
|
*/
|
|
17
|
-
|
|
38
|
+
_copyFor(agent?: AgentBase): PromptManager;
|
|
18
39
|
/**
|
|
19
40
|
* Sets the raw prompt text, bypassing POM rendering.
|
|
20
41
|
* @param text - The raw prompt string.
|
package/dist/PromptManager.js
CHANGED
|
@@ -10,16 +10,43 @@ export class PromptManager {
|
|
|
10
10
|
postPrompt = null;
|
|
11
11
|
pom = null;
|
|
12
12
|
usePom;
|
|
13
|
+
/**
|
|
14
|
+
* The agent this manager belongs to (the reference's public `self.agent`,
|
|
15
|
+
* `core/agent/prompt/manager.py:32`), or `undefined` for standalone use.
|
|
16
|
+
*
|
|
17
|
+
* The reference takes the parent agent as its sole constructor argument and keeps
|
|
18
|
+
* it as a public back-reference. A caller holding the manager can therefore walk
|
|
19
|
+
* back to its owner; this is the read-back of that same value.
|
|
20
|
+
*/
|
|
21
|
+
agent;
|
|
13
22
|
/**
|
|
14
23
|
* Creates a new PromptManager.
|
|
15
24
|
* @param usePom - Whether to use structured POM sections (default true).
|
|
25
|
+
* @param agent - Optional parent agent, kept as a public back-reference
|
|
26
|
+
* (the reference's `PromptManager(agent)`). Omit for standalone use.
|
|
16
27
|
*/
|
|
17
|
-
constructor(usePom = true) {
|
|
28
|
+
constructor(usePom = true, agent) {
|
|
18
29
|
this.usePom = usePom;
|
|
30
|
+
this.agent = agent;
|
|
19
31
|
if (usePom) {
|
|
20
32
|
this.pom = new PomBuilder();
|
|
21
33
|
}
|
|
22
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* A copy of this manager's prompt state (raw text, post-prompt and POM
|
|
37
|
+
* sections) owned by `agent`, for a per-request copy of the agent. The POM
|
|
38
|
+
* sections are deep-copied (every depth, every bullet list), not rendered to
|
|
39
|
+
* text, so the copy still emits a structured prompt, and nothing the copy
|
|
40
|
+
* changes reaches this manager.
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
_copyFor(agent) {
|
|
44
|
+
const copy = new PromptManager(this.usePom, agent);
|
|
45
|
+
copy.rawText = this.rawText;
|
|
46
|
+
copy.postPrompt = this.postPrompt;
|
|
47
|
+
copy.pom = this.pom ? this.pom._clone() : null;
|
|
48
|
+
return copy;
|
|
49
|
+
}
|
|
23
50
|
/**
|
|
24
51
|
* Sets the raw prompt text, bypassing POM rendering.
|
|
25
52
|
* @param text - The raw prompt string.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PromptManager.js","sourceRoot":"","sources":["../src/PromptManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"PromptManager.js","sourceRoot":"","sources":["../src/PromptManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,4FAA4F;AAC5F,MAAM,OAAO,aAAa;IAChB,OAAO,GAAkB,IAAI,CAAC;IAC9B,UAAU,GAAkB,IAAI,CAAC;IACjC,GAAG,GAAsB,IAAI,CAAC;IAC9B,MAAM,CAAU;IACxB;;;;;;;OAOG;IACM,KAAK,CAAa;IAE3B;;;;;OAKG;IACH,YAAY,MAAM,GAAG,IAAI,EAAE,KAAiB;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAiB;QACxB,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,IAAY;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,IAAY;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,UAAU,CACR,KAAa,EACb,IAMC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAa,EAAE,IAA6D;QACvF,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,aAAa,CACX,WAAmB,EACnB,KAAa,EACb,IAA4C;QAE5C,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC;QAC/C,IAAI,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;QAC/C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PublicFetch - fetch a user-supplied URL without reaching private or
|
|
3
|
+
* internal addresses.
|
|
4
|
+
*
|
|
5
|
+
* Checking a URL before fetching it isn't enough on its own. The server can
|
|
6
|
+
* redirect to an internal address, such as a cloud metadata service, and the
|
|
7
|
+
* hostname can resolve to a different address when the connection is made
|
|
8
|
+
* (DNS rebinding). {@link _publicFetch} follows redirects itself and checks
|
|
9
|
+
* every hop, and connects through a DNS lookup that refuses private and
|
|
10
|
+
* internal addresses, so the address it connects to is the one it checked.
|
|
11
|
+
*
|
|
12
|
+
* It connects directly, ignoring any environment proxy, because through a
|
|
13
|
+
* proxy the connection check can't apply. With `SWML_URL_FETCH_USE_PROXY` set,
|
|
14
|
+
* a request that Node's global `fetch` would send through a proxy (Node's
|
|
15
|
+
* proxy support on, a proxy set for the scheme, the host not in `NO_PROXY`)
|
|
16
|
+
* goes through it instead; use a proxy that restricts destinations itself.
|
|
17
|
+
* Every other request still connects directly through the guarded lookup.
|
|
18
|
+
* `SWML_ALLOW_PRIVATE_URLS` turns the address checks off.
|
|
19
|
+
*
|
|
20
|
+
* The `insecureTls` option skips TLS certificate verification (for a trusted
|
|
21
|
+
* gateway with a self-signed certificate) and nothing else: every hop is still
|
|
22
|
+
* checked and every connection still goes through the guarded lookup.
|
|
23
|
+
*
|
|
24
|
+
* Internal to the SDK: the skills that fetch URLs a caller or the model
|
|
25
|
+
* supplied (spider, web_search, mcp_gateway) use it. Mirrors signalwire-python's
|
|
26
|
+
* `_PublicSession` (signalwire/utils/url_validator.py).
|
|
27
|
+
*/
|
|
28
|
+
/** Options for {@link _publicFetch}. */
|
|
29
|
+
export interface _PublicFetchInit {
|
|
30
|
+
/** HTTP method (default `GET`). */
|
|
31
|
+
method?: string;
|
|
32
|
+
/** Request headers. */
|
|
33
|
+
headers?: Record<string, string>;
|
|
34
|
+
/** Request body, for methods that send one. */
|
|
35
|
+
body?: string;
|
|
36
|
+
/** Aborts the request, including any redirect in progress. */
|
|
37
|
+
signal?: AbortSignal;
|
|
38
|
+
/** Skip the address checks, as `SWML_ALLOW_PRIVATE_URLS` does. */
|
|
39
|
+
allowPrivate?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Called with each redirect's target before it's requested; returning false
|
|
42
|
+
* stops the fetch with a {@link _RedirectRefused} error. The address checks
|
|
43
|
+
* still apply to a target it allows.
|
|
44
|
+
*/
|
|
45
|
+
allowRedirect?: (target: string) => boolean | Promise<boolean>;
|
|
46
|
+
/**
|
|
47
|
+
* Accept any TLS certificate (no verification) on every hop. The address
|
|
48
|
+
* checks still apply. Such a request always connects directly, through the
|
|
49
|
+
* guarded lookup, even with `SWML_URL_FETCH_USE_PROXY` set, since the proxy
|
|
50
|
+
* transport can't skip verification. Default `false`.
|
|
51
|
+
*/
|
|
52
|
+
insecureTls?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* How redirects are followed. `browser` (the default) follows 301, 302,
|
|
55
|
+
* 303, 307 and 308, up to 10 of them, and turns a 303, or a 301 or 302
|
|
56
|
+
* answering a POST, into a GET without a body. `curl` follows them as
|
|
57
|
+
* libcurl does with `CURLOPT_FOLLOWLOCATION`, `CURLOPT_MAXREDIRS` 15 and
|
|
58
|
+
* `CURLOPT_POSTREDIR` `CURL_REDIR_POST_ALL`, the settings the platform
|
|
59
|
+
* requests a DataMap webhook with: any 3xx with a `Location`, up to 15 of
|
|
60
|
+
* them, a POST sent again with its body after any of them, and only a 303
|
|
61
|
+
* answering a method other than GET, HEAD or POST turned into a GET. Both
|
|
62
|
+
* modes check every hop's address and drop credentials on a change of
|
|
63
|
+
* origin.
|
|
64
|
+
*/
|
|
65
|
+
redirectMode?: 'browser' | 'curl';
|
|
66
|
+
/**
|
|
67
|
+
* Called with each response's status as it arrives, redirects included,
|
|
68
|
+
* so a caller can report the last status received when a later hop fails,
|
|
69
|
+
* as curl's `CURLINFO_RESPONSE_CODE` does.
|
|
70
|
+
*/
|
|
71
|
+
onStatus?: (status: number) => void;
|
|
72
|
+
}
|
|
73
|
+
/** Thrown by {@link _publicFetch} when `allowRedirect` refuses a redirect. */
|
|
74
|
+
export declare class _RedirectRefused extends Error {
|
|
75
|
+
/** The redirect target that was refused. */
|
|
76
|
+
readonly target: string;
|
|
77
|
+
/** @param target - The redirect target that was refused. */
|
|
78
|
+
constructor(target: string);
|
|
79
|
+
}
|
|
80
|
+
/** Sends one request without following redirects. Tests replace it. */
|
|
81
|
+
export type _PublicFetchTransport = (url: string, init: {
|
|
82
|
+
method: string;
|
|
83
|
+
headers: Record<string, string>;
|
|
84
|
+
body?: string;
|
|
85
|
+
signal?: AbortSignal;
|
|
86
|
+
/** Skip TLS certificate verification (the address checks still apply). */
|
|
87
|
+
insecureTls?: boolean;
|
|
88
|
+
}, guard: boolean) => Promise<Response>;
|
|
89
|
+
/**
|
|
90
|
+
* Send one request with node:http(s). With `guard`, the connection resolves
|
|
91
|
+
* the hostname through {@link guardedLookup}, so a hostname that resolves to a
|
|
92
|
+
* private address at connect time is refused even if it resolved to a public
|
|
93
|
+
* one when the URL was checked. An IP-literal host skips DNS; {@link
|
|
94
|
+
* _publicFetch} has already checked it. With `init.insecureTls`, an HTTPS
|
|
95
|
+
* connection accepts any certificate; the lookup is guarded all the same.
|
|
96
|
+
*/
|
|
97
|
+
export declare const _nodeTransport: _PublicFetchTransport;
|
|
98
|
+
/**
|
|
99
|
+
* Replace the transport {@link _publicFetch} sends each request with, or
|
|
100
|
+
* restore the default with `null`. For tests only.
|
|
101
|
+
*/
|
|
102
|
+
export declare function _setPublicFetchTransport(transport: _PublicFetchTransport | null): void;
|
|
103
|
+
/**
|
|
104
|
+
* Whether Node's global fetch would send a request for `url` through an
|
|
105
|
+
* environment proxy: Node's proxy support is on (`NODE_USE_ENV_PROXY` or
|
|
106
|
+
* `--use-env-proxy`), a proxy is set for the URL's scheme, and `NO_PROXY`
|
|
107
|
+
* doesn't exclude the host. When it wouldn't, the connection is direct and
|
|
108
|
+
* must go through the guarded transport. `NO_PROXY` is matched loosely (any
|
|
109
|
+
* entry that could cover the host counts), which errs toward the guard.
|
|
110
|
+
*/
|
|
111
|
+
export declare function _proxiedByNode(url: string): boolean;
|
|
112
|
+
/**
|
|
113
|
+
* Fetch a user-supplied URL, refusing private and internal addresses.
|
|
114
|
+
*
|
|
115
|
+
* Checks the URL, then each redirect's target, before requesting it (up to
|
|
116
|
+
* {@link MAX_REDIRECTS} redirects), and connects through a lookup that refuses
|
|
117
|
+
* a private or internal address. A redirect to another origin drops the
|
|
118
|
+
* `Authorization`, `Cookie` and `Proxy-Authorization` headers. A 303, or a
|
|
119
|
+
* 301/302 answering a POST, is followed with a GET, as browsers do. With
|
|
120
|
+
* `redirectMode: 'curl'`, redirects follow curl's rules instead (see
|
|
121
|
+
* {@link _PublicFetchInit.redirectMode}); the checks are the same.
|
|
122
|
+
*
|
|
123
|
+
* @param url - The URL to fetch.
|
|
124
|
+
* @param init - Method, headers, body, abort signal, `allowPrivate`,
|
|
125
|
+
* `allowRedirect`, `insecureTls`, `redirectMode` and `onStatus`.
|
|
126
|
+
* @returns The final response, which is not a redirect unless it had no
|
|
127
|
+
* `Location` header.
|
|
128
|
+
* @throws If the URL or a redirect is refused ({@link _RedirectRefused} when
|
|
129
|
+
* `allowRedirect` refuses it), there are too many redirects, or the
|
|
130
|
+
* request fails.
|
|
131
|
+
*/
|
|
132
|
+
export declare function _publicFetch(url: string, init?: _PublicFetchInit): Promise<Response>;
|
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PublicFetch - fetch a user-supplied URL without reaching private or
|
|
3
|
+
* internal addresses.
|
|
4
|
+
*
|
|
5
|
+
* Checking a URL before fetching it isn't enough on its own. The server can
|
|
6
|
+
* redirect to an internal address, such as a cloud metadata service, and the
|
|
7
|
+
* hostname can resolve to a different address when the connection is made
|
|
8
|
+
* (DNS rebinding). {@link _publicFetch} follows redirects itself and checks
|
|
9
|
+
* every hop, and connects through a DNS lookup that refuses private and
|
|
10
|
+
* internal addresses, so the address it connects to is the one it checked.
|
|
11
|
+
*
|
|
12
|
+
* It connects directly, ignoring any environment proxy, because through a
|
|
13
|
+
* proxy the connection check can't apply. With `SWML_URL_FETCH_USE_PROXY` set,
|
|
14
|
+
* a request that Node's global `fetch` would send through a proxy (Node's
|
|
15
|
+
* proxy support on, a proxy set for the scheme, the host not in `NO_PROXY`)
|
|
16
|
+
* goes through it instead; use a proxy that restricts destinations itself.
|
|
17
|
+
* Every other request still connects directly through the guarded lookup.
|
|
18
|
+
* `SWML_ALLOW_PRIVATE_URLS` turns the address checks off.
|
|
19
|
+
*
|
|
20
|
+
* The `insecureTls` option skips TLS certificate verification (for a trusted
|
|
21
|
+
* gateway with a self-signed certificate) and nothing else: every hop is still
|
|
22
|
+
* checked and every connection still goes through the guarded lookup.
|
|
23
|
+
*
|
|
24
|
+
* Internal to the SDK: the skills that fetch URLs a caller or the model
|
|
25
|
+
* supplied (spider, web_search, mcp_gateway) use it. Mirrors signalwire-python's
|
|
26
|
+
* `_PublicSession` (signalwire/utils/url_validator.py).
|
|
27
|
+
*/
|
|
28
|
+
import dns from 'node:dns';
|
|
29
|
+
import http from 'node:http';
|
|
30
|
+
import https from 'node:https';
|
|
31
|
+
import { Readable, pipeline } from 'node:stream';
|
|
32
|
+
import zlib from 'node:zlib';
|
|
33
|
+
import { _checkUrl, _privateUrlsAllowed, isPrivateIp, redactUrl } from './SecurityUtils.js';
|
|
34
|
+
/** Most redirects {@link _publicFetch} follows before giving up. */
|
|
35
|
+
const MAX_REDIRECTS = 10;
|
|
36
|
+
/**
|
|
37
|
+
* Most redirects {@link _publicFetch} follows in `curl` mode: the platform's
|
|
38
|
+
* `CURLOPT_MAXREDIRS` for a DataMap webhook.
|
|
39
|
+
*/
|
|
40
|
+
const CURL_MAX_REDIRECTS = 15;
|
|
41
|
+
const REDIRECT_STATUSES = new Set([301, 302, 303, 307, 308]);
|
|
42
|
+
/** Headers that carry credentials for one origin and must not follow a redirect elsewhere. */
|
|
43
|
+
const ORIGIN_BOUND_HEADERS = ['authorization', 'cookie', 'proxy-authorization'];
|
|
44
|
+
/** Thrown by {@link _publicFetch} when `allowRedirect` refuses a redirect. */
|
|
45
|
+
export class _RedirectRefused extends Error {
|
|
46
|
+
/** The redirect target that was refused. */
|
|
47
|
+
target;
|
|
48
|
+
/** @param target - The redirect target that was refused. */
|
|
49
|
+
constructor(target) {
|
|
50
|
+
super(`Redirect to ${redactUrl(target)} refused`);
|
|
51
|
+
this.name = '_RedirectRefused';
|
|
52
|
+
this.target = target;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* DNS lookup for connections to user-supplied hosts: resolves every address
|
|
57
|
+
* and refuses the connection if any of them is private or internal.
|
|
58
|
+
*/
|
|
59
|
+
const guardedLookup = (hostname, options, callback) => {
|
|
60
|
+
dns.lookup(hostname, { ...options, all: true }, (err, addresses) => {
|
|
61
|
+
if (err) {
|
|
62
|
+
callback(err, '', 0);
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
const list = addresses;
|
|
66
|
+
const blocked = list.find((a) => isPrivateIp(a.address));
|
|
67
|
+
if (blocked || list.length === 0) {
|
|
68
|
+
const reason = blocked
|
|
69
|
+
? `${blocked.address} is a private or internal address`
|
|
70
|
+
: 'it has no address';
|
|
71
|
+
const refusal = Object.assign(new Error(`Refused to connect to ${hostname}: ${reason}`), {
|
|
72
|
+
code: 'ERR_SW_BLOCKED_ADDRESS',
|
|
73
|
+
});
|
|
74
|
+
callback(refusal, '', 0);
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
if (options.all) {
|
|
78
|
+
callback(null, list);
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
callback(null, list[0].address, list[0].family);
|
|
82
|
+
}
|
|
83
|
+
});
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* The response body, decompressed when it's encoded. `pipeline` carries an
|
|
87
|
+
* error in the connection (a reset mid-body) to the decompressor, so reading
|
|
88
|
+
* the body fails instead of waiting forever.
|
|
89
|
+
*/
|
|
90
|
+
function decodeBody(res) {
|
|
91
|
+
const encoding = (res.headers['content-encoding'] ?? '').toLowerCase();
|
|
92
|
+
let decoder = null;
|
|
93
|
+
if (encoding === 'gzip' || encoding === 'x-gzip')
|
|
94
|
+
decoder = zlib.createGunzip();
|
|
95
|
+
else if (encoding === 'deflate')
|
|
96
|
+
decoder = zlib.createInflate();
|
|
97
|
+
else if (encoding === 'br')
|
|
98
|
+
decoder = zlib.createBrotliDecompress();
|
|
99
|
+
if (!decoder)
|
|
100
|
+
return res;
|
|
101
|
+
return pipeline(res, decoder, () => {
|
|
102
|
+
// Errors reach the consumer through the decoder, which pipeline destroys.
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Send one request with node:http(s). With `guard`, the connection resolves
|
|
107
|
+
* the hostname through {@link guardedLookup}, so a hostname that resolves to a
|
|
108
|
+
* private address at connect time is refused even if it resolved to a public
|
|
109
|
+
* one when the URL was checked. An IP-literal host skips DNS; {@link
|
|
110
|
+
* _publicFetch} has already checked it. With `init.insecureTls`, an HTTPS
|
|
111
|
+
* connection accepts any certificate; the lookup is guarded all the same.
|
|
112
|
+
*/
|
|
113
|
+
export const _nodeTransport = (url, init, guard) => new Promise((resolve, reject) => {
|
|
114
|
+
const target = new URL(url);
|
|
115
|
+
const mod = target.protocol === 'https:' ? https : http;
|
|
116
|
+
const req = mod.request(target, {
|
|
117
|
+
method: init.method,
|
|
118
|
+
headers: { 'accept-encoding': 'gzip, deflate, br', ...init.headers },
|
|
119
|
+
signal: init.signal,
|
|
120
|
+
// A fresh agent, never a global one that an environment proxy configured.
|
|
121
|
+
agent: false,
|
|
122
|
+
...(guard ? { lookup: guardedLookup } : {}),
|
|
123
|
+
...(init.insecureTls ? { rejectUnauthorized: false } : {}),
|
|
124
|
+
}, (res) => {
|
|
125
|
+
// The server chose the status and headers, so anything that can't
|
|
126
|
+
// become a Response (a status outside 200-599, a malformed header)
|
|
127
|
+
// must reject this request: thrown here, in an event callback, it
|
|
128
|
+
// would escape the promise and crash the process.
|
|
129
|
+
try {
|
|
130
|
+
const status = res.statusCode ?? 0;
|
|
131
|
+
if (status < 200 || status > 599) {
|
|
132
|
+
throw new Error(`Invalid HTTP status ${status} from ${target.host}`);
|
|
133
|
+
}
|
|
134
|
+
const headers = new Headers();
|
|
135
|
+
for (let i = 0; i < res.rawHeaders.length; i += 2) {
|
|
136
|
+
const name = res.rawHeaders[i].toLowerCase();
|
|
137
|
+
if (name === 'content-encoding' || name === 'content-length')
|
|
138
|
+
continue;
|
|
139
|
+
headers.append(res.rawHeaders[i], res.rawHeaders[i + 1]);
|
|
140
|
+
}
|
|
141
|
+
const noBody = init.method === 'HEAD' || [204, 205, 304].includes(status);
|
|
142
|
+
let body = null;
|
|
143
|
+
if (noBody) {
|
|
144
|
+
res.resume();
|
|
145
|
+
}
|
|
146
|
+
else {
|
|
147
|
+
body = Readable.toWeb(decodeBody(res));
|
|
148
|
+
}
|
|
149
|
+
const response = new Response(body, {
|
|
150
|
+
status,
|
|
151
|
+
statusText: res.statusMessage ?? '',
|
|
152
|
+
headers,
|
|
153
|
+
});
|
|
154
|
+
Object.defineProperty(response, 'url', { value: target.toString() });
|
|
155
|
+
resolve(response);
|
|
156
|
+
}
|
|
157
|
+
catch (err) {
|
|
158
|
+
res.destroy();
|
|
159
|
+
reject(err instanceof Error ? err : new Error(String(err)));
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
req.on('error', reject);
|
|
163
|
+
if (init.body !== undefined)
|
|
164
|
+
req.write(init.body);
|
|
165
|
+
req.end();
|
|
166
|
+
});
|
|
167
|
+
/**
|
|
168
|
+
* Send one request through Node's global fetch, without following redirects.
|
|
169
|
+
* Used when `SWML_URL_FETCH_USE_PROXY` asks for the environment's proxy, where
|
|
170
|
+
* the connection check can't apply.
|
|
171
|
+
*/
|
|
172
|
+
const globalFetchTransport = (url, init) => fetch(url, {
|
|
173
|
+
method: init.method,
|
|
174
|
+
headers: init.headers,
|
|
175
|
+
body: init.body,
|
|
176
|
+
signal: init.signal,
|
|
177
|
+
redirect: 'manual',
|
|
178
|
+
});
|
|
179
|
+
let transportOverride = null;
|
|
180
|
+
/**
|
|
181
|
+
* Replace the transport {@link _publicFetch} sends each request with, or
|
|
182
|
+
* restore the default with `null`. For tests only.
|
|
183
|
+
*/
|
|
184
|
+
export function _setPublicFetchTransport(transport) {
|
|
185
|
+
transportOverride = transport;
|
|
186
|
+
}
|
|
187
|
+
const truthy = (value) => ['1', 'true', 'yes'].includes((value ?? '').toLowerCase());
|
|
188
|
+
/** True when `SWML_URL_FETCH_USE_PROXY` (1/true/yes) lets these fetches use a proxy. */
|
|
189
|
+
function proxyAllowed() {
|
|
190
|
+
return truthy(process.env['SWML_URL_FETCH_USE_PROXY']);
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Whether Node's global fetch would send a request for `url` through an
|
|
194
|
+
* environment proxy: Node's proxy support is on (`NODE_USE_ENV_PROXY` or
|
|
195
|
+
* `--use-env-proxy`), a proxy is set for the URL's scheme, and `NO_PROXY`
|
|
196
|
+
* doesn't exclude the host. When it wouldn't, the connection is direct and
|
|
197
|
+
* must go through the guarded transport. `NO_PROXY` is matched loosely (any
|
|
198
|
+
* entry that could cover the host counts), which errs toward the guard.
|
|
199
|
+
*/
|
|
200
|
+
export function _proxiedByNode(url) {
|
|
201
|
+
const env = process.env;
|
|
202
|
+
const nodeProxySupport = truthy(env['NODE_USE_ENV_PROXY']) || process.execArgv.includes('--use-env-proxy');
|
|
203
|
+
if (!nodeProxySupport)
|
|
204
|
+
return false;
|
|
205
|
+
const target = new URL(url);
|
|
206
|
+
const proxy = target.protocol === 'https:'
|
|
207
|
+
? (env['HTTPS_PROXY'] ?? env['https_proxy'])
|
|
208
|
+
: (env['HTTP_PROXY'] ?? env['http_proxy']);
|
|
209
|
+
if (!proxy)
|
|
210
|
+
return false;
|
|
211
|
+
const host = target.hostname.replace(/^\[|\]$/g, '').toLowerCase();
|
|
212
|
+
const noProxy = (env['NO_PROXY'] ?? env['no_proxy'] ?? '')
|
|
213
|
+
.split(/[\s,]+/)
|
|
214
|
+
.map((e) => e.trim().toLowerCase().replace(/:\d+$/, ''))
|
|
215
|
+
.filter(Boolean);
|
|
216
|
+
for (const entry of noProxy) {
|
|
217
|
+
if (entry === '*')
|
|
218
|
+
return false;
|
|
219
|
+
const bare = entry.replace(/^\*?\./, '');
|
|
220
|
+
if (host === bare || host.endsWith(`.${bare}`))
|
|
221
|
+
return false;
|
|
222
|
+
}
|
|
223
|
+
return true;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Fetch a user-supplied URL, refusing private and internal addresses.
|
|
227
|
+
*
|
|
228
|
+
* Checks the URL, then each redirect's target, before requesting it (up to
|
|
229
|
+
* {@link MAX_REDIRECTS} redirects), and connects through a lookup that refuses
|
|
230
|
+
* a private or internal address. A redirect to another origin drops the
|
|
231
|
+
* `Authorization`, `Cookie` and `Proxy-Authorization` headers. A 303, or a
|
|
232
|
+
* 301/302 answering a POST, is followed with a GET, as browsers do. With
|
|
233
|
+
* `redirectMode: 'curl'`, redirects follow curl's rules instead (see
|
|
234
|
+
* {@link _PublicFetchInit.redirectMode}); the checks are the same.
|
|
235
|
+
*
|
|
236
|
+
* @param url - The URL to fetch.
|
|
237
|
+
* @param init - Method, headers, body, abort signal, `allowPrivate`,
|
|
238
|
+
* `allowRedirect`, `insecureTls`, `redirectMode` and `onStatus`.
|
|
239
|
+
* @returns The final response, which is not a redirect unless it had no
|
|
240
|
+
* `Location` header.
|
|
241
|
+
* @throws If the URL or a redirect is refused ({@link _RedirectRefused} when
|
|
242
|
+
* `allowRedirect` refuses it), there are too many redirects, or the
|
|
243
|
+
* request fails.
|
|
244
|
+
*/
|
|
245
|
+
export async function _publicFetch(url, init = {}) {
|
|
246
|
+
const allowPrivate = _privateUrlsAllowed(init.allowPrivate ?? false);
|
|
247
|
+
const guard = !allowPrivate;
|
|
248
|
+
// Through a proxy the connection check can't apply, so the global fetch is
|
|
249
|
+
// used only when the request will really go through one; a direct
|
|
250
|
+
// connection always goes through the guarded transport.
|
|
251
|
+
// The global fetch can't skip certificate verification, so an insecureTls
|
|
252
|
+
// request always connects directly.
|
|
253
|
+
const insecureTls = init.insecureTls === true;
|
|
254
|
+
const transportFor = (target) => transportOverride ??
|
|
255
|
+
(guard && !insecureTls && proxyAllowed() && _proxiedByNode(target)
|
|
256
|
+
? globalFetchTransport
|
|
257
|
+
: _nodeTransport);
|
|
258
|
+
const curl = init.redirectMode === 'curl';
|
|
259
|
+
const maxRedirects = curl ? CURL_MAX_REDIRECTS : MAX_REDIRECTS;
|
|
260
|
+
// curl follows a Location on any 3xx response (http.c), and a browser only
|
|
261
|
+
// on the redirect statuses.
|
|
262
|
+
const isRedirect = (status) => curl ? status >= 300 && status <= 399 : REDIRECT_STATUSES.has(status);
|
|
263
|
+
let method = (init.method ?? 'GET').toUpperCase();
|
|
264
|
+
let body = init.body;
|
|
265
|
+
const headers = {};
|
|
266
|
+
for (const [k, v] of Object.entries(init.headers ?? {}))
|
|
267
|
+
headers[k.toLowerCase()] = v;
|
|
268
|
+
let current = url;
|
|
269
|
+
for (let redirects = 0;; redirects++) {
|
|
270
|
+
try {
|
|
271
|
+
await _checkUrl(current, allowPrivate);
|
|
272
|
+
}
|
|
273
|
+
catch (err) {
|
|
274
|
+
const reason = err instanceof Error ? err.message : String(err);
|
|
275
|
+
throw new Error(`Refused to fetch ${redactUrl(current)}: ${reason}`, { cause: err });
|
|
276
|
+
}
|
|
277
|
+
const response = await transportFor(current)(current, { method, headers, body, signal: init.signal, insecureTls }, guard);
|
|
278
|
+
init.onStatus?.(response.status);
|
|
279
|
+
const location = response.headers.get('location');
|
|
280
|
+
if (!isRedirect(response.status) || !location)
|
|
281
|
+
return response;
|
|
282
|
+
await response.body?.cancel().catch(() => undefined);
|
|
283
|
+
if (redirects >= maxRedirects) {
|
|
284
|
+
throw new Error(`Too many redirects fetching ${redactUrl(url)}`);
|
|
285
|
+
}
|
|
286
|
+
const next = new URL(location, current);
|
|
287
|
+
// A browser turns a 303, and a 301 or 302 answering a POST, into a GET.
|
|
288
|
+
// curl with CURL_REDIR_POST_ALL sends a POST again, with its body, and
|
|
289
|
+
// turns only a 303 answering another method (other than GET and HEAD)
|
|
290
|
+
// into a GET (transfer.c Curl_follow).
|
|
291
|
+
const toGet = curl
|
|
292
|
+
? response.status === 303 && !['GET', 'HEAD', 'POST'].includes(method)
|
|
293
|
+
: response.status === 303 ||
|
|
294
|
+
((response.status === 301 || response.status === 302) && method === 'POST');
|
|
295
|
+
if (toGet) {
|
|
296
|
+
method = 'GET';
|
|
297
|
+
body = undefined;
|
|
298
|
+
delete headers['content-type'];
|
|
299
|
+
delete headers['content-length'];
|
|
300
|
+
}
|
|
301
|
+
if (next.origin !== new URL(current).origin) {
|
|
302
|
+
for (const name of ORIGIN_BOUND_HEADERS)
|
|
303
|
+
delete headers[name];
|
|
304
|
+
}
|
|
305
|
+
current = next.toString();
|
|
306
|
+
if (init.allowRedirect && !(await init.allowRedirect(current))) {
|
|
307
|
+
throw new _RedirectRefused(current);
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
//# sourceMappingURL=PublicFetch.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicFetch.js","sourceRoot":"","sources":["../src/PublicFetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE5F,oEAAoE;AACpE,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB;;;GAGG;AACH,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE7D,8FAA8F;AAC9F,MAAM,oBAAoB,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC;AAgDhF,8EAA8E;AAC9E,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,4CAA4C;IACnC,MAAM,CAAS;IAExB,4DAA4D;IAC5D,YAAY,MAAc;QACxB,KAAK,CAAC,eAAe,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAgBD;;;GAGG;AACH,MAAM,aAAa,GAAmB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;IACpE,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;QACjE,IAAI,GAAG,EAAE,CAAC;YACR,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,SAAgC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QACzD,IAAI,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,OAAO;gBACpB,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,mCAAmC;gBACvD,CAAC,CAAC,mBAAmB,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,QAAQ,KAAK,MAAM,EAAE,CAAC,EAAE;gBACvF,IAAI,EAAE,wBAAwB;aAC/B,CAAC,CAAC;YACH,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YACzB,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;GAIG;AACH,SAAS,UAAU,CAAC,GAAyB;IAC3C,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACvE,IAAI,OAAO,GAA8D,IAAI,CAAC;IAC9E,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,QAAQ;QAAE,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;SAC3E,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;SAC3D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACpE,IAAI,CAAC,OAAO;QAAE,OAAO,GAAG,CAAC;IACzB,OAAO,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE;QACjC,0EAA0E;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAA0B,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CACxE,IAAI,OAAO,CAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IACxC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CACrB,MAAM,EACN;QACE,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,OAAO,EAAE,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;QACpE,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,0EAA0E;QAC1E,KAAK,EAAE,KAAK;QACZ,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3D,EACD,CAAC,GAAG,EAAE,EAAE;QACN,kEAAkE;QAClE,mEAAmE;QACnE,kEAAkE;QAClE,kDAAkD;QAClD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC;YACnC,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,GAAG,GAAG,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,uBAAuB,MAAM,SAAS,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;YAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,CAAC;gBAC9C,IAAI,IAAI,KAAK,kBAAkB,IAAI,IAAI,KAAK,gBAAgB;oBAAE,SAAS;gBACvE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAE,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC;YAC7D,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1E,IAAI,IAAI,GAA0B,IAAI,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC;gBACX,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAmB,CAAC;YAC3D,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE;gBAClC,MAAM;gBACN,UAAU,EAAE,GAAG,CAAC,aAAa,IAAI,EAAE;gBACnC,OAAO;aACR,CAAC,CAAC;YACH,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACrE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC,CACF,CAAC;IACF,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACxB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,GAAG,CAAC,GAAG,EAAE,CAAC;AACZ,CAAC,CAAC,CAAC;AAEL;;;;GAIG;AACH,MAAM,oBAAoB,GAA0B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAChE,KAAK,CAAC,GAAG,EAAE;IACT,MAAM,EAAE,IAAI,CAAC,MAAM;IACnB,OAAO,EAAE,IAAI,CAAC,OAAO;IACrB,IAAI,EAAE,IAAI,CAAC,IAAI;IACf,MAAM,EAAE,IAAI,CAAC,MAAM;IACnB,QAAQ,EAAE,QAAQ;CACnB,CAAC,CAAC;AAEL,IAAI,iBAAiB,GAAiC,IAAI,CAAC;AAE3D;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,SAAuC;IAC9E,iBAAiB,GAAG,SAAS,CAAC;AAChC,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAAyB,EAAE,EAAE,CAC3C,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAE7D,wFAAwF;AACxF,SAAS,YAAY;IACnB,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW;IACxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACxB,MAAM,gBAAgB,GACpB,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACpF,IAAI,CAAC,gBAAgB;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,KAAK,GACT,MAAM,CAAC,QAAQ,KAAK,QAAQ;QAC1B,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACnE,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;SACvD,KAAK,CAAC,QAAQ,CAAC;SACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;SACvD,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,KAAK,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YAAE,OAAO,KAAK,CAAC;IAC/D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAyB,EAAE;IACzE,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IACrE,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC;IAC5B,2EAA2E;IAC3E,kEAAkE;IAClE,wDAAwD;IACxD,0EAA0E;IAC1E,oCAAoC;IACpC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC;IAC9C,MAAM,YAAY,GAAG,CAAC,MAAc,EAAyB,EAAE,CAC7D,iBAAiB;QACjB,CAAC,KAAK,IAAI,CAAC,WAAW,IAAI,YAAY,EAAE,IAAI,cAAc,CAAC,MAAM,CAAC;YAChE,CAAC,CAAC,oBAAoB;YACtB,CAAC,CAAC,cAAc,CAAC,CAAC;IAEtB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,KAAK,MAAM,CAAC;IAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC;IAC/D,2EAA2E;IAC3E,4BAA4B;IAC5B,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CACpC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAClD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACrB,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;IAEtF,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,KAAK,IAAI,SAAS,GAAG,CAAC,GAAI,SAAS,EAAE,EAAE,CAAC;QACtC,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,CAAC,OAAO,CAAC,KAAK,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAC1C,OAAO,EACP,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,EAC3D,KAAK,CACN,CAAC;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAE/D,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,SAAS,IAAI,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,+BAA+B,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxC,wEAAwE;QACxE,uEAAuE;QACvE,sEAAsE;QACtE,uCAAuC;QACvC,MAAM,KAAK,GAAG,IAAI;YAChB,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YACtE,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,MAAM,KAAK,MAAM,CAAC,CAAC;QAChF,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,GAAG,KAAK,CAAC;YACf,IAAI,GAAG,SAAS,CAAC;YACjB,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YAC5C,KAAK,MAAM,IAAI,IAAI,oBAAoB;gBAAE,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RobotsTxt - robots.txt rules, read the way Python's `urllib.robotparser`
|
|
3
|
+
* reads them, so the spider skill allows and refuses the same pages in both
|
|
4
|
+
* SDKs.
|
|
5
|
+
*
|
|
6
|
+
* The rules, as in `urllib.robotparser`:
|
|
7
|
+
* - A group is one or more `User-agent` lines followed by `Allow`/`Disallow`
|
|
8
|
+
* lines. A blank line ends a group; `User-agent` lines followed by a blank
|
|
9
|
+
* line and no rules are dropped.
|
|
10
|
+
* - A group applies to a user agent when one of its names is `*` or appears
|
|
11
|
+
* in the user agent's product name (the part before the first `/`),
|
|
12
|
+
* compared without case. The first group that applies is used; the `*`
|
|
13
|
+
* group is used only when no other applies.
|
|
14
|
+
* - Within a group, the first rule whose path starts the URL's path decides.
|
|
15
|
+
* An empty `Disallow` allows everything. There are no wildcards except a
|
|
16
|
+
* path of exactly `*`.
|
|
17
|
+
* - Paths and URLs are compared percent-encoded, as `urllib.parse.quote`
|
|
18
|
+
* encodes them.
|
|
19
|
+
*
|
|
20
|
+
* Internal to the SDK.
|
|
21
|
+
*/
|
|
22
|
+
/** Parsed robots.txt rules for one site. */
|
|
23
|
+
export declare class _RobotsRules {
|
|
24
|
+
private readonly groups;
|
|
25
|
+
private defaultGroup;
|
|
26
|
+
/**
|
|
27
|
+
* @param text - The robots.txt body; empty allows everything.
|
|
28
|
+
*/
|
|
29
|
+
constructor(text: string);
|
|
30
|
+
/** Rules that allow every page. */
|
|
31
|
+
static allowAll(): _RobotsRules;
|
|
32
|
+
/** Rules that refuse every page. */
|
|
33
|
+
static disallowAll(): _RobotsRules;
|
|
34
|
+
/**
|
|
35
|
+
* Whether `userAgent` may fetch `url`.
|
|
36
|
+
* @param userAgent - The user agent the fetch sends.
|
|
37
|
+
* @param url - The page's URL.
|
|
38
|
+
* @returns True when the rules allow it.
|
|
39
|
+
*/
|
|
40
|
+
canFetch(userAgent: string, url: string): boolean;
|
|
41
|
+
}
|