@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,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `sw-tsdocs api`: signatures, JSDoc, source locations and members.
|
|
3
|
+
*
|
|
4
|
+
* The answers come from `api-index.json`, which `npm run build` writes beside
|
|
5
|
+
* this module from the package's own `.d.ts` files
|
|
6
|
+
* (scripts/generate-tsdocs-api.ts). An installed package has no TypeScript
|
|
7
|
+
* source and no compiler, so reading the declarations ahead of time is what
|
|
8
|
+
* lets this work anywhere the package is installed, without importing the
|
|
9
|
+
* SDK.
|
|
10
|
+
*/
|
|
11
|
+
import type { ApiEntry, ApiIndex, ApiMember } from './apiTypes.js';
|
|
12
|
+
/** The index's file name, beside this module in `dist/cli/tsdocs/`. */
|
|
13
|
+
export declare const API_INDEX_FILE = "api-index.json";
|
|
14
|
+
/**
|
|
15
|
+
* Use `index` instead of the built one; the tests build it from the source.
|
|
16
|
+
*
|
|
17
|
+
* @param index - The index to use, or null to go back to the built one.
|
|
18
|
+
*/
|
|
19
|
+
export declare function useApiIndex(index: ApiIndex | null): void;
|
|
20
|
+
/**
|
|
21
|
+
* The API index for the package at `root`: beside this module when it runs
|
|
22
|
+
* from `dist`, or in `dist/` when it runs from a clone's `src`.
|
|
23
|
+
*
|
|
24
|
+
* @param root - The package root.
|
|
25
|
+
* @returns The index, or null if it hasn't been built.
|
|
26
|
+
*/
|
|
27
|
+
export declare function loadApiIndex(root: string): ApiIndex | null;
|
|
28
|
+
/** A resolved name: an entry, or one of its members. */
|
|
29
|
+
export interface Found {
|
|
30
|
+
/** The name as the reader should write it, such as `FunctionResult.connect`. */
|
|
31
|
+
name: string;
|
|
32
|
+
/** The entry, or for a member the entry it was looked up on. */
|
|
33
|
+
entry: ApiEntry;
|
|
34
|
+
/** The member, when the name is one. */
|
|
35
|
+
member?: ApiMember;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Everything `name` could refer to, most specific first.
|
|
39
|
+
*
|
|
40
|
+
* Accepts an exported name (`AgentBase`), a member (`FunctionResult.connect`),
|
|
41
|
+
* a namespace member (`livewire.Agent`), an optional `@signalwire/sdk.`
|
|
42
|
+
* prefix, and a bare member name (`hangup`), which is looked up in the main
|
|
43
|
+
* classes.
|
|
44
|
+
*
|
|
45
|
+
* @param index - The API index.
|
|
46
|
+
* @param name - What the reader typed.
|
|
47
|
+
* @returns The matches.
|
|
48
|
+
*/
|
|
49
|
+
export declare function resolveName(index: ApiIndex, name: string): Found[];
|
|
50
|
+
/**
|
|
51
|
+
* Up to `n` words from `pool` that look like `word`, best first.
|
|
52
|
+
*
|
|
53
|
+
* @param word - What the reader typed.
|
|
54
|
+
* @param pool - The known words.
|
|
55
|
+
* @param n - The most to return.
|
|
56
|
+
* @param cutoff - The least similarity, from 0 to 1.
|
|
57
|
+
* @returns The close matches.
|
|
58
|
+
*/
|
|
59
|
+
export declare function closeMatches(word: string, pool: Iterable<string>, n?: number, cutoff?: number): string[];
|
|
60
|
+
/**
|
|
61
|
+
* Known names that look like `name`.
|
|
62
|
+
*
|
|
63
|
+
* @param index - The API index.
|
|
64
|
+
* @param name - What the reader typed.
|
|
65
|
+
* @returns Up to eight suggestions.
|
|
66
|
+
*/
|
|
67
|
+
export declare function suggestions(index: ApiIndex, name: string): string[];
|
|
68
|
+
/**
|
|
69
|
+
* The first sentence of a JSDoc, without its tags.
|
|
70
|
+
*
|
|
71
|
+
* @param doc - The JSDoc text.
|
|
72
|
+
* @returns The sentence, or an empty string.
|
|
73
|
+
*/
|
|
74
|
+
export declare function summary(doc: string): string;
|
|
75
|
+
/**
|
|
76
|
+
* Markdown for one resolved name.
|
|
77
|
+
*
|
|
78
|
+
* @param index - The API index.
|
|
79
|
+
* @param found - The name, from {@link resolveName}.
|
|
80
|
+
* @param root - The package root, for full source paths.
|
|
81
|
+
* @returns The page.
|
|
82
|
+
*/
|
|
83
|
+
export declare function renderFound(index: ApiIndex, found: Found, root: string): string;
|
|
84
|
+
/**
|
|
85
|
+
* The first line of a name's JSDoc, for the topics' API lists.
|
|
86
|
+
*
|
|
87
|
+
* @param index - The API index.
|
|
88
|
+
* @param name - A name {@link resolveName} accepts.
|
|
89
|
+
* @returns The summary, or an empty string.
|
|
90
|
+
*/
|
|
91
|
+
export declare function summaryOf(index: ApiIndex, name: string): string;
|
|
@@ -0,0 +1,372 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `sw-tsdocs api`: signatures, JSDoc, source locations and members.
|
|
3
|
+
*
|
|
4
|
+
* The answers come from `api-index.json`, which `npm run build` writes beside
|
|
5
|
+
* this module from the package's own `.d.ts` files
|
|
6
|
+
* (scripts/generate-tsdocs-api.ts). An installed package has no TypeScript
|
|
7
|
+
* source and no compiler, so reading the declarations ahead of time is what
|
|
8
|
+
* lets this work anywhere the package is installed, without importing the
|
|
9
|
+
* SDK.
|
|
10
|
+
*/
|
|
11
|
+
import { existsSync, readFileSync } from 'node:fs';
|
|
12
|
+
import { dirname, join } from 'node:path';
|
|
13
|
+
import { fileURLToPath } from 'node:url';
|
|
14
|
+
/** The index's file name, beside this module in `dist/cli/tsdocs/`. */
|
|
15
|
+
export const API_INDEX_FILE = 'api-index.json';
|
|
16
|
+
/** Classes whose members a bare name, such as `hangup`, is looked up in. */
|
|
17
|
+
const MAIN_CLASSES = [
|
|
18
|
+
'AgentBase',
|
|
19
|
+
'SWMLService',
|
|
20
|
+
'FunctionResult',
|
|
21
|
+
'DataMap',
|
|
22
|
+
'ContextBuilder',
|
|
23
|
+
'Context',
|
|
24
|
+
'Step',
|
|
25
|
+
'AgentServer',
|
|
26
|
+
'SkillBase',
|
|
27
|
+
'RelayClient',
|
|
28
|
+
'Call',
|
|
29
|
+
'Message',
|
|
30
|
+
'RestClient',
|
|
31
|
+
'AIChatClient',
|
|
32
|
+
'ChatGateway',
|
|
33
|
+
'HandoffRouter',
|
|
34
|
+
'BedrockAgent',
|
|
35
|
+
];
|
|
36
|
+
let override = null;
|
|
37
|
+
const loaded = new Map();
|
|
38
|
+
/**
|
|
39
|
+
* Use `index` instead of the built one; the tests build it from the source.
|
|
40
|
+
*
|
|
41
|
+
* @param index - The index to use, or null to go back to the built one.
|
|
42
|
+
*/
|
|
43
|
+
export function useApiIndex(index) {
|
|
44
|
+
override = index;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* The API index for the package at `root`: beside this module when it runs
|
|
48
|
+
* from `dist`, or in `dist/` when it runs from a clone's `src`.
|
|
49
|
+
*
|
|
50
|
+
* @param root - The package root.
|
|
51
|
+
* @returns The index, or null if it hasn't been built.
|
|
52
|
+
*/
|
|
53
|
+
export function loadApiIndex(root) {
|
|
54
|
+
if (override)
|
|
55
|
+
return override;
|
|
56
|
+
const here = dirname(fileURLToPath(import.meta.url));
|
|
57
|
+
const candidates = [
|
|
58
|
+
join(here, API_INDEX_FILE),
|
|
59
|
+
join(root, 'dist', 'cli', 'tsdocs', API_INDEX_FILE),
|
|
60
|
+
];
|
|
61
|
+
const path = candidates.find((p) => existsSync(p));
|
|
62
|
+
if (!path)
|
|
63
|
+
return null;
|
|
64
|
+
if (!loaded.has(path)) {
|
|
65
|
+
try {
|
|
66
|
+
loaded.set(path, JSON.parse(readFileSync(path, 'utf-8')));
|
|
67
|
+
}
|
|
68
|
+
catch {
|
|
69
|
+
loaded.set(path, null);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return loaded.get(path) ?? null;
|
|
73
|
+
}
|
|
74
|
+
/** The entry and its bases, nearest first. */
|
|
75
|
+
function lineage(index, entry) {
|
|
76
|
+
const chain = [];
|
|
77
|
+
const queue = [entry];
|
|
78
|
+
while (queue.length) {
|
|
79
|
+
const next = queue.shift();
|
|
80
|
+
if (chain.includes(next))
|
|
81
|
+
continue;
|
|
82
|
+
chain.push(next);
|
|
83
|
+
for (const base of next.bases ?? []) {
|
|
84
|
+
const found = index.entries[base];
|
|
85
|
+
if (found)
|
|
86
|
+
queue.push(found);
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
return chain;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* A class's or interface's members with the ones it inherits, grouped by the
|
|
93
|
+
* entry that declares them. An overriding member hides the base's.
|
|
94
|
+
*
|
|
95
|
+
* @param index - The API index.
|
|
96
|
+
* @param entry - A class or interface.
|
|
97
|
+
* @returns [owner, members] pairs, the entry's own first.
|
|
98
|
+
*/
|
|
99
|
+
function membersByOwner(index, entry) {
|
|
100
|
+
const seen = new Set();
|
|
101
|
+
const groups = [];
|
|
102
|
+
for (const klass of lineage(index, entry)) {
|
|
103
|
+
const own = (klass.members ?? []).filter((m) => {
|
|
104
|
+
const id = `${m.static ? 'static ' : ''}${m.name}`;
|
|
105
|
+
if (seen.has(id))
|
|
106
|
+
return false;
|
|
107
|
+
seen.add(id);
|
|
108
|
+
return true;
|
|
109
|
+
});
|
|
110
|
+
if (own.length)
|
|
111
|
+
groups.push([klass.name, own]);
|
|
112
|
+
}
|
|
113
|
+
return groups;
|
|
114
|
+
}
|
|
115
|
+
function findMember(index, entry, name) {
|
|
116
|
+
for (const klass of lineage(index, entry)) {
|
|
117
|
+
const member = klass.members?.find((m) => m.name === name);
|
|
118
|
+
if (member)
|
|
119
|
+
return member;
|
|
120
|
+
}
|
|
121
|
+
return undefined;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Everything `name` could refer to, most specific first.
|
|
125
|
+
*
|
|
126
|
+
* Accepts an exported name (`AgentBase`), a member (`FunctionResult.connect`),
|
|
127
|
+
* a namespace member (`livewire.Agent`), an optional `@signalwire/sdk.`
|
|
128
|
+
* prefix, and a bare member name (`hangup`), which is looked up in the main
|
|
129
|
+
* classes.
|
|
130
|
+
*
|
|
131
|
+
* @param index - The API index.
|
|
132
|
+
* @param name - What the reader typed.
|
|
133
|
+
* @returns The matches.
|
|
134
|
+
*/
|
|
135
|
+
export function resolveName(index, name) {
|
|
136
|
+
const wanted = name
|
|
137
|
+
.trim()
|
|
138
|
+
.replace(/^@signalwire\/sdk\/livewire[./]/, 'livewire.')
|
|
139
|
+
.replace(/^@signalwire\/sdk[./]?/, '')
|
|
140
|
+
.replace(/#/g, '.');
|
|
141
|
+
if (!wanted)
|
|
142
|
+
return [];
|
|
143
|
+
const exact = index.entries[wanted];
|
|
144
|
+
if (exact)
|
|
145
|
+
return [{ name: wanted, entry: exact }];
|
|
146
|
+
const parts = wanted.split('.');
|
|
147
|
+
// The longest leading part that names an entry, then members
|
|
148
|
+
for (let split = parts.length - 1; split > 0; split--) {
|
|
149
|
+
const entry = index.entries[parts.slice(0, split).join('.')];
|
|
150
|
+
if (!entry)
|
|
151
|
+
continue;
|
|
152
|
+
if (split !== parts.length - 1)
|
|
153
|
+
return [];
|
|
154
|
+
const member = findMember(index, entry, parts[split]);
|
|
155
|
+
return member ? [{ name: wanted, entry, member }] : [];
|
|
156
|
+
}
|
|
157
|
+
if (parts.length > 1)
|
|
158
|
+
return [];
|
|
159
|
+
const results = [];
|
|
160
|
+
for (const key of index.exports) {
|
|
161
|
+
if (key.endsWith(`.${wanted}`))
|
|
162
|
+
results.push({ name: key, entry: index.entries[key] });
|
|
163
|
+
}
|
|
164
|
+
const owners = new Set();
|
|
165
|
+
for (const className of MAIN_CLASSES) {
|
|
166
|
+
const entry = index.entries[className];
|
|
167
|
+
const member = entry && findMember(index, entry, wanted);
|
|
168
|
+
if (!entry || !member)
|
|
169
|
+
continue;
|
|
170
|
+
const id = `${member.owner}.${member.name}`;
|
|
171
|
+
if (owners.has(id))
|
|
172
|
+
continue;
|
|
173
|
+
owners.add(id);
|
|
174
|
+
results.push({ name: `${className}.${wanted}`, entry, member });
|
|
175
|
+
}
|
|
176
|
+
return results;
|
|
177
|
+
}
|
|
178
|
+
/** Lowercase, without `_` or `-`, so `prompt_add_section` finds `promptAddSection`. */
|
|
179
|
+
const fold = (s) => s.toLowerCase().replace(/[_-]/g, '');
|
|
180
|
+
function distance(a, b) {
|
|
181
|
+
const row = Array.from({ length: b.length + 1 }, (_, i) => i);
|
|
182
|
+
for (let i = 1; i <= a.length; i++) {
|
|
183
|
+
let prev = row[0];
|
|
184
|
+
row[0] = i;
|
|
185
|
+
for (let j = 1; j <= b.length; j++) {
|
|
186
|
+
const cur = row[j];
|
|
187
|
+
row[j] = Math.min(row[j] + 1, row[j - 1] + 1, prev + (a[i - 1] === b[j - 1] ? 0 : 1));
|
|
188
|
+
prev = cur;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
return row[b.length];
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Up to `n` words from `pool` that look like `word`, best first.
|
|
195
|
+
*
|
|
196
|
+
* @param word - What the reader typed.
|
|
197
|
+
* @param pool - The known words.
|
|
198
|
+
* @param n - The most to return.
|
|
199
|
+
* @param cutoff - The least similarity, from 0 to 1.
|
|
200
|
+
* @returns The close matches.
|
|
201
|
+
*/
|
|
202
|
+
export function closeMatches(word, pool, n = 3, cutoff = 0.6) {
|
|
203
|
+
const target = fold(word);
|
|
204
|
+
const scored = [];
|
|
205
|
+
for (const candidate of new Set(pool)) {
|
|
206
|
+
const folded = fold(candidate);
|
|
207
|
+
const longest = Math.max(folded.length, target.length) || 1;
|
|
208
|
+
const score = 1 - distance(folded, target) / longest;
|
|
209
|
+
if (score >= cutoff)
|
|
210
|
+
scored.push([score, candidate]);
|
|
211
|
+
}
|
|
212
|
+
return scored
|
|
213
|
+
.sort((a, b) => b[0] - a[0] || a[1].localeCompare(b[1]))
|
|
214
|
+
.slice(0, n)
|
|
215
|
+
.map(([, candidate]) => candidate);
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Known names that look like `name`.
|
|
219
|
+
*
|
|
220
|
+
* @param index - The API index.
|
|
221
|
+
* @param name - What the reader typed.
|
|
222
|
+
* @returns Up to eight suggestions.
|
|
223
|
+
*/
|
|
224
|
+
export function suggestions(index, name) {
|
|
225
|
+
const pool = new Set(index.exports);
|
|
226
|
+
for (const className of MAIN_CLASSES) {
|
|
227
|
+
const entry = index.entries[className];
|
|
228
|
+
if (!entry)
|
|
229
|
+
continue;
|
|
230
|
+
for (const [, members] of membersByOwner(index, entry)) {
|
|
231
|
+
for (const member of members)
|
|
232
|
+
pool.add(member.name);
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
const last = name.split('.').pop() ?? name;
|
|
236
|
+
return closeMatches(last, pool, 8, 0.6);
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* The first sentence of a JSDoc, without its tags.
|
|
240
|
+
*
|
|
241
|
+
* @param doc - The JSDoc text.
|
|
242
|
+
* @returns The sentence, or an empty string.
|
|
243
|
+
*/
|
|
244
|
+
export function summary(doc) {
|
|
245
|
+
const paragraph = [];
|
|
246
|
+
for (const line of doc.split('\n')) {
|
|
247
|
+
const text = line.trim();
|
|
248
|
+
if (text.startsWith('@') || text.startsWith('```') || (!text && paragraph.length))
|
|
249
|
+
break;
|
|
250
|
+
if (text)
|
|
251
|
+
paragraph.push(text);
|
|
252
|
+
}
|
|
253
|
+
const joined = paragraph.join(' ');
|
|
254
|
+
// The first sentence: a period and a space, outside `code` and not "e.g."
|
|
255
|
+
let first = joined;
|
|
256
|
+
for (const match of joined.matchAll(/\.(?=\s|$)/g)) {
|
|
257
|
+
const before = joined.slice(0, match.index);
|
|
258
|
+
if (/\b(e\.g|i\.e|etc|vs)$/i.test(before))
|
|
259
|
+
continue;
|
|
260
|
+
if ((before.match(/`/g) ?? []).length % 2)
|
|
261
|
+
continue;
|
|
262
|
+
first = joined.slice(0, match.index + 1);
|
|
263
|
+
break;
|
|
264
|
+
}
|
|
265
|
+
return first.length > 240 ? `${first.slice(0, 239)}…` : first;
|
|
266
|
+
}
|
|
267
|
+
/** One line for a member list: long inline types are cut. */
|
|
268
|
+
function oneLine(signature, max = 160) {
|
|
269
|
+
const flat = signature.replace(/\s+/g, ' ').replace(/\( /g, '(').replace(/ \)/g, ')');
|
|
270
|
+
return flat.length > max ? `${flat.slice(0, max - 1)}…` : flat;
|
|
271
|
+
}
|
|
272
|
+
/** A JSDoc with a blank line before its tags, so they don't run into the text. */
|
|
273
|
+
function formatDoc(doc) {
|
|
274
|
+
const lines = doc.split('\n');
|
|
275
|
+
const first = lines.findIndex((line) => line.startsWith('@'));
|
|
276
|
+
if (first > 0 && lines[first - 1].trim())
|
|
277
|
+
lines.splice(first, 0, '');
|
|
278
|
+
return lines.join('\n');
|
|
279
|
+
}
|
|
280
|
+
function where(root, file, line) {
|
|
281
|
+
return `${join(root, file)}:${line}`;
|
|
282
|
+
}
|
|
283
|
+
function memberLabel(member) {
|
|
284
|
+
const flags = [
|
|
285
|
+
member.static ? 'static' : '',
|
|
286
|
+
member.protected ? 'protected' : '',
|
|
287
|
+
member.kind === 'property' || member.kind === 'accessor' ? member.kind : '',
|
|
288
|
+
].filter(Boolean);
|
|
289
|
+
return flags.length ? ` (${flags.join(', ')})` : '';
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Markdown for one resolved name.
|
|
293
|
+
*
|
|
294
|
+
* @param index - The API index.
|
|
295
|
+
* @param found - The name, from {@link resolveName}.
|
|
296
|
+
* @param root - The package root, for full source paths.
|
|
297
|
+
* @returns The page.
|
|
298
|
+
*/
|
|
299
|
+
export function renderFound(index, found, root) {
|
|
300
|
+
const out = [];
|
|
301
|
+
if (found.member) {
|
|
302
|
+
const member = found.member;
|
|
303
|
+
out.push(`# ${member.kind} ${found.name}`, '');
|
|
304
|
+
out.push(`Source: ${where(root, member.file, member.line)}`, '');
|
|
305
|
+
if (member.owner !== found.entry.name)
|
|
306
|
+
out.push(`Defined by \`${member.owner}\`.`, '');
|
|
307
|
+
out.push('```ts', ...member.signature, '```', '');
|
|
308
|
+
if (member.doc)
|
|
309
|
+
out.push(formatDoc(member.doc), '');
|
|
310
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
311
|
+
}
|
|
312
|
+
const entry = found.entry;
|
|
313
|
+
out.push(`# ${entry.kind} ${found.name}`, '');
|
|
314
|
+
out.push(`Source: ${where(root, entry.file, entry.line)}`, '');
|
|
315
|
+
if (!entry.exported)
|
|
316
|
+
out.push('Not exported itself: its members are inherited by classes that are.', '');
|
|
317
|
+
const signature = [...entry.signature];
|
|
318
|
+
if (entry.kind === 'class') {
|
|
319
|
+
const ctor = entry.members?.find((m) => m.kind === 'constructor');
|
|
320
|
+
if (ctor)
|
|
321
|
+
signature.push(...ctor.signature);
|
|
322
|
+
}
|
|
323
|
+
if (entry.kind !== 'namespace')
|
|
324
|
+
out.push('```ts', ...signature, '```', '');
|
|
325
|
+
if (entry.doc)
|
|
326
|
+
out.push(formatDoc(entry.doc), '');
|
|
327
|
+
if (entry.kind === 'class' || entry.kind === 'interface') {
|
|
328
|
+
const groups = membersByOwner(index, entry).map(([owner, members]) => [owner, members.filter((m) => m.kind !== 'constructor')]);
|
|
329
|
+
const count = groups.reduce((n, [, members]) => n + members.length, 0);
|
|
330
|
+
if (count) {
|
|
331
|
+
out.push(`## Members (${count})`, '', `Grouped by the ${entry.kind} that declares them. \`sw-tsdocs api ${found.name}.<name>\` shows one.`, '');
|
|
332
|
+
for (const [owner, members] of groups) {
|
|
333
|
+
if (!members.length)
|
|
334
|
+
continue;
|
|
335
|
+
out.push(`### ${owner}`, '');
|
|
336
|
+
for (const member of members) {
|
|
337
|
+
const text = summary(member.doc);
|
|
338
|
+
const line = `- \`${oneLine(member.signature[0] ?? member.name)}\`${memberLabel(member)}`;
|
|
339
|
+
out.push(text ? `${line}: ${text}` : line);
|
|
340
|
+
}
|
|
341
|
+
out.push('');
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
else if (entry.kind === 'namespace') {
|
|
346
|
+
out.push('## Contents', '');
|
|
347
|
+
for (const key of entry.contents ?? []) {
|
|
348
|
+
const item = index.entries[key];
|
|
349
|
+
if (!item)
|
|
350
|
+
continue;
|
|
351
|
+
const text = summary(item.doc);
|
|
352
|
+
const line = `- \`${key}\` (${item.kind})`;
|
|
353
|
+
out.push(text ? `${line}: ${text}` : line);
|
|
354
|
+
}
|
|
355
|
+
out.push('');
|
|
356
|
+
}
|
|
357
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* The first line of a name's JSDoc, for the topics' API lists.
|
|
361
|
+
*
|
|
362
|
+
* @param index - The API index.
|
|
363
|
+
* @param name - A name {@link resolveName} accepts.
|
|
364
|
+
* @returns The summary, or an empty string.
|
|
365
|
+
*/
|
|
366
|
+
export function summaryOf(index, name) {
|
|
367
|
+
const found = resolveName(index, name)[0];
|
|
368
|
+
if (!found)
|
|
369
|
+
return '';
|
|
370
|
+
return summary(found.member ? found.member.doc : found.entry.doc);
|
|
371
|
+
}
|
|
372
|
+
//# sourceMappingURL=api.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,uEAAuE;AACvE,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAE/C,4EAA4E;AAC5E,MAAM,YAAY,GAAG;IACnB,WAAW;IACX,aAAa;IACb,gBAAgB;IAChB,SAAS;IACT,gBAAgB;IAChB,SAAS;IACT,MAAM;IACN,aAAa;IACb,WAAW;IACX,aAAa;IACb,MAAM;IACN,SAAS;IACT,YAAY;IACZ,cAAc;IACd,aAAa;IACb,eAAe;IACf,cAAc;CACf,CAAC;AAEF,IAAI,QAAQ,GAAoB,IAAI,CAAC;AACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA2B,CAAC;AAElD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAsB;IAChD,QAAQ,GAAG,KAAK,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG;QACjB,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC;QAC1B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,cAAc,CAAC;KACpD,CAAC;IACF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAa,CAAC,CAAC;QACxE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AAClC,CAAC;AAYD,8CAA8C;AAC9C,SAAS,OAAO,CAAC,KAAe,EAAE,KAAe;IAC/C,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;IACtB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAC5B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS;QACnC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,KAAK;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc,CAAC,KAAe,EAAE,KAAe;IACtD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAC7C,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACb,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,GAAG,CAAC,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,UAAU,CAAC,KAAe,EAAE,KAAe,EAAE,IAAY;IAChE,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC3D,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;IAC5B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,IAAY;IACvD,MAAM,MAAM,GAAG,IAAI;SAChB,IAAI,EAAE;SACN,OAAO,CAAC,iCAAiC,EAAE,WAAW,CAAC;SACvD,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC;SACrC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtB,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,KAAK;QAAE,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,6DAA6D;IAC7D,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC;QACvD,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAChC,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAChC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,MAAM,EAAE,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAE,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,KAAK,IAAI,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YAAE,SAAS;QAChC,MAAM,EAAE,GAAG,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAAE,SAAS;QAC7B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,IAAI,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,uFAAuF;AACvF,MAAM,IAAI,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEzE,SAAS,QAAQ,CAAC,CAAS,EAAE,CAAS;IACpC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,IAAI,IAAI,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;QACnB,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;YACpB,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxF,IAAI,GAAG,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,CAAC,CAAC,MAAM,CAAE,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,IAAsB,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG;IACpF,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,KAAK,MAAM,SAAS,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;QACrD,IAAI,KAAK,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,MAAM;SACV,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvD,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,IAAY;IACvD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5C,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,KAAK,MAAM,MAAM,IAAI,OAAO;gBAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC;IAC3C,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,MAAM,CAAC;YAAE,MAAM;QACzF,IAAI,IAAI;YAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,0EAA0E;IAC1E,IAAI,KAAK,GAAG,MAAM,CAAC;IACnB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,SAAS;QACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS;QACpD,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACzC,MAAM;IACR,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;AAChE,CAAC;AAED,6DAA6D;AAC7D,SAAS,OAAO,CAAC,SAAiB,EAAE,GAAG,GAAG,GAAG;IAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtF,OAAO,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACjE,CAAC;AAED,kFAAkF;AAClF,SAAS,SAAS,CAAC,GAAW;IAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9D,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,CAAE,CAAC,IAAI,EAAE;QAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,IAAY,EAAE,IAAY;IACrD,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,WAAW,CAAC,MAAiB;IACpC,MAAM,KAAK,GAAG;QACZ,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;QAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;QACnC,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;KAC5E,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;AACtD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,KAAY,EAAE,IAAY;IACrE,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,gBAAgB,MAAM,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC,CAAC;QACvF,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAClD,IAAI,MAAM,CAAC,GAAG;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QACpD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;IACzC,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC1B,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAC9C,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,IAAI,CAAC,KAAK,CAAC,QAAQ;QACjB,GAAG,CAAC,IAAI,CAAC,qEAAqE,EAAE,EAAE,CAAC,CAAC;IACtF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QAClE,IAAI,IAAI;YAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW;QAAE,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3E,IAAI,KAAK,CAAC,GAAG;QAAE,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAClD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,CAC7C,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CACnB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAA0B,CACpF,CAAC;QACF,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACvE,IAAI,KAAK,EAAE,CAAC;YACV,GAAG,CAAC,IAAI,CACN,eAAe,KAAK,GAAG,EACvB,EAAE,EACF,kBAAkB,KAAK,CAAC,IAAI,wCAAwC,KAAK,CAAC,IAAI,sBAAsB,EACpG,EAAE,CACH,CAAC;YACF,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,EAAE,CAAC;gBACtC,IAAI,CAAC,OAAO,CAAC,MAAM;oBAAE,SAAS;gBAC9B,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC7B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;oBAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACjC,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1F,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC7C,CAAC;gBACD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACtC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/B,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC;YAC3C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,KAAe,EAAE,IAAY;IACrD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACpE,CAAC"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The shape of `api-index.json`, which `npm run build` writes from the
|
|
3
|
+
* package's declarations (scripts/generate-tsdocs-api.ts) and
|
|
4
|
+
* `sw-tsdocs api` reads.
|
|
5
|
+
*/
|
|
6
|
+
/** What an exported name is. */
|
|
7
|
+
export type ApiKind = 'class' | 'interface' | 'type' | 'function' | 'variable' | 'enum' | 'namespace';
|
|
8
|
+
/** What a class or interface member is. */
|
|
9
|
+
export type ApiMemberKind = 'constructor' | 'method' | 'property' | 'accessor';
|
|
10
|
+
/** A member a class or interface declares itself (inherited ones live on the base's entry). */
|
|
11
|
+
export interface ApiMember {
|
|
12
|
+
/** The member's name; `constructor` for a constructor. */
|
|
13
|
+
name: string;
|
|
14
|
+
/** Whether it's a method, property, accessor or constructor. */
|
|
15
|
+
kind: ApiMemberKind;
|
|
16
|
+
/** The key of the entry that declares it. */
|
|
17
|
+
owner: string;
|
|
18
|
+
/** True for a static member. */
|
|
19
|
+
static?: boolean;
|
|
20
|
+
/** True for a protected member, which subclasses use or override. */
|
|
21
|
+
protected?: boolean;
|
|
22
|
+
/** True for a readonly property. */
|
|
23
|
+
readonly?: boolean;
|
|
24
|
+
/** Its declarations as an editor shows them, one per overload. */
|
|
25
|
+
signature: string[];
|
|
26
|
+
/** Its JSDoc, without comment markers. */
|
|
27
|
+
doc: string;
|
|
28
|
+
/** Where it's declared, relative to the package root. */
|
|
29
|
+
file: string;
|
|
30
|
+
/** The 1-based line of the declaration. */
|
|
31
|
+
line: number;
|
|
32
|
+
}
|
|
33
|
+
/** One name, exported from the package or a base class of one that is. */
|
|
34
|
+
export interface ApiEntry {
|
|
35
|
+
/** The key: the exported name, or `livewire.<name>` inside the livewire namespace. */
|
|
36
|
+
name: string;
|
|
37
|
+
/** Whether it's a class, function, type and so on. */
|
|
38
|
+
kind: ApiKind;
|
|
39
|
+
/** False for a base class that is reachable only through a subclass. */
|
|
40
|
+
exported: boolean;
|
|
41
|
+
/** Its declarations as an editor shows them (a class's header, a function's overloads). */
|
|
42
|
+
signature: string[];
|
|
43
|
+
/** Its JSDoc, without comment markers. */
|
|
44
|
+
doc: string;
|
|
45
|
+
/** Where it's declared, relative to the package root. */
|
|
46
|
+
file: string;
|
|
47
|
+
/** The 1-based line of the declaration. */
|
|
48
|
+
line: number;
|
|
49
|
+
/** The entries this class or interface extends. */
|
|
50
|
+
bases?: string[];
|
|
51
|
+
/** The members it declares itself. */
|
|
52
|
+
members?: ApiMember[];
|
|
53
|
+
/** A namespace's exported entries. */
|
|
54
|
+
contents?: string[];
|
|
55
|
+
}
|
|
56
|
+
/** The whole index. */
|
|
57
|
+
export interface ApiIndex {
|
|
58
|
+
/** The package version it was built from. */
|
|
59
|
+
version: string;
|
|
60
|
+
/** The keys of the names the package exports. */
|
|
61
|
+
exports: string[];
|
|
62
|
+
/** Every entry, by key. */
|
|
63
|
+
entries: Record<string, ApiEntry>;
|
|
64
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"apiTypes.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/apiTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* The `sw-tsdocs` command: the SDK's documentation for the installed
|
|
4
|
+
* version. See ./index.ts.
|
|
5
|
+
*/
|
|
6
|
+
import { main } from './index.js';
|
|
7
|
+
// Reading a skill's or the REST client's metadata constructs SDK objects,
|
|
8
|
+
// which log; this command prints only its own output.
|
|
9
|
+
process.env['SIGNALWIRE_LOG_MODE'] ??= 'off';
|
|
10
|
+
// Output piped to a reader that stopped early, such as `head`: stop quietly.
|
|
11
|
+
process.stdout.on('error', (err) => {
|
|
12
|
+
if (err.code === 'EPIPE')
|
|
13
|
+
process.exit(0);
|
|
14
|
+
throw err;
|
|
15
|
+
});
|
|
16
|
+
main(process.argv.slice(2)).then((code) => {
|
|
17
|
+
// exitCode rather than exit(), so piped output is flushed first
|
|
18
|
+
process.exitCode = code;
|
|
19
|
+
}, (err) => {
|
|
20
|
+
process.stderr.write(`sw-tsdocs: ${err instanceof Error ? err.message : String(err)}\n`);
|
|
21
|
+
process.exitCode = 1;
|
|
22
|
+
});
|
|
23
|
+
//# sourceMappingURL=bin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/bin.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,0EAA0E;AAC1E,sDAAsD;AACtD,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,KAAK,KAAK,CAAC;AAE7C,6EAA6E;AAC7E,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAA0B,EAAE,EAAE;IACxD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1C,MAAM,GAAG,CAAC;AACZ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAC9B,CAAC,IAAI,EAAE,EAAE;IACP,gEAAgE;IAChE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;AAC1B,CAAC,EACD,CAAC,GAAY,EAAE,EAAE;IACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CACF,CAAC"}
|