@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,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where the package is, and the facts its package.json holds.
|
|
3
|
+
*
|
|
4
|
+
* The docs ship at the package root, beside `dist/`, in the layout they have
|
|
5
|
+
* in the repository, so relative links between them keep working. The same
|
|
6
|
+
* lookup serves a clone of the repository (this file is then
|
|
7
|
+
* `src/cli/tsdocs/locate.ts`) and an installed package
|
|
8
|
+
* (`node_modules/@signalwire/sdk/dist/cli/tsdocs/locate.js`).
|
|
9
|
+
*/
|
|
10
|
+
import { existsSync, readFileSync } from 'node:fs';
|
|
11
|
+
import { dirname, join, relative, sep } from 'node:path';
|
|
12
|
+
import { fileURLToPath } from 'node:url';
|
|
13
|
+
/** The package's name on npm. */
|
|
14
|
+
export const PACKAGE_NAME = '@signalwire/sdk';
|
|
15
|
+
const HERE = dirname(fileURLToPath(import.meta.url));
|
|
16
|
+
/**
|
|
17
|
+
* The package root: the nearest directory above `from` whose package.json
|
|
18
|
+
* names this package.
|
|
19
|
+
*
|
|
20
|
+
* @param from - Where to start looking; this module's directory by default.
|
|
21
|
+
* @returns The root, or null if no such directory exists.
|
|
22
|
+
*/
|
|
23
|
+
export function findPackageRoot(from = HERE) {
|
|
24
|
+
let dir = from;
|
|
25
|
+
for (;;) {
|
|
26
|
+
const manifest = join(dir, 'package.json');
|
|
27
|
+
if (existsSync(manifest)) {
|
|
28
|
+
try {
|
|
29
|
+
const pkg = JSON.parse(readFileSync(manifest, 'utf-8'));
|
|
30
|
+
if (pkg.name === PACKAGE_NAME)
|
|
31
|
+
return dir;
|
|
32
|
+
}
|
|
33
|
+
catch {
|
|
34
|
+
// Not a readable package.json: keep looking further up
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
const parent = dirname(dir);
|
|
38
|
+
if (parent === dir)
|
|
39
|
+
return null;
|
|
40
|
+
dir = parent;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* The package root, or an error saying the package can't be found.
|
|
45
|
+
*
|
|
46
|
+
* @returns The package root.
|
|
47
|
+
*/
|
|
48
|
+
export function packageRoot() {
|
|
49
|
+
const root = findPackageRoot();
|
|
50
|
+
if (root === null) {
|
|
51
|
+
throw new Error(`Can't find the ${PACKAGE_NAME} package above ${HERE}.`);
|
|
52
|
+
}
|
|
53
|
+
return root;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* The package's package.json.
|
|
57
|
+
*
|
|
58
|
+
* @param root - The package root.
|
|
59
|
+
* @returns Its parsed contents.
|
|
60
|
+
*/
|
|
61
|
+
export function readPackageJson(root) {
|
|
62
|
+
return JSON.parse(readFileSync(join(root, 'package.json'), 'utf-8'));
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* The directory holding the code sw-tsdocs runs from: `dist` in an installed
|
|
66
|
+
* package or a build, `src` when run from a clone with tsx.
|
|
67
|
+
*
|
|
68
|
+
* @param root - The package root.
|
|
69
|
+
* @returns The code directory's absolute path.
|
|
70
|
+
*/
|
|
71
|
+
export function codeDir(root) {
|
|
72
|
+
const top = relative(root, HERE).split(sep)[0];
|
|
73
|
+
return join(root, top === 'src' ? 'src' : 'dist');
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=locate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"locate.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/locate.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,iCAAiC;AACjC,MAAM,CAAC,MAAM,YAAY,GAAG,iBAAiB,CAAC;AAc9C,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,OAAe,IAAI;IACjD,IAAI,GAAG,GAAG,IAAI,CAAC;IACf,SAAS,CAAC;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC3C,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAyB,CAAC;gBAChF,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY;oBAAE,OAAO,GAAG,CAAC;YAC5C,CAAC;YAAC,MAAM,CAAC;gBACP,uDAAuD;YACzD,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,MAAM,KAAK,GAAG;YAAE,OAAO,IAAI,CAAC;QAChC,GAAG,GAAG,MAAM,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,kBAAkB,IAAI,GAAG,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAAgB,CAAC;AACtF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,OAAO,IAAI,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Markdown for the index, the topics, the examples and the package's
|
|
3
|
+
* llms.txt.
|
|
4
|
+
*
|
|
5
|
+
* The index reads only package.json and the topics, so it prints without
|
|
6
|
+
* loading the SDK or the API index.
|
|
7
|
+
*/
|
|
8
|
+
import { type Topic } from './topics.js';
|
|
9
|
+
/**
|
|
10
|
+
* The installed SDK version.
|
|
11
|
+
*
|
|
12
|
+
* @param root - The package root.
|
|
13
|
+
* @returns package.json's version.
|
|
14
|
+
*/
|
|
15
|
+
export declare function version(root: string): string;
|
|
16
|
+
/**
|
|
17
|
+
* The page `sw-tsdocs` prints with no arguments.
|
|
18
|
+
*
|
|
19
|
+
* @param root - The package root.
|
|
20
|
+
* @returns Markdown.
|
|
21
|
+
*/
|
|
22
|
+
export declare function renderIndex(root: string): string;
|
|
23
|
+
/**
|
|
24
|
+
* One line per topic.
|
|
25
|
+
*
|
|
26
|
+
* @returns Markdown.
|
|
27
|
+
*/
|
|
28
|
+
export declare function renderTopicList(): string;
|
|
29
|
+
/**
|
|
30
|
+
* The examples a topic entry names: a file, or every example in a directory
|
|
31
|
+
* when the entry ends with `/`.
|
|
32
|
+
*
|
|
33
|
+
* @param root - The package root.
|
|
34
|
+
* @param rel - The entry.
|
|
35
|
+
* @returns Paths relative to the root.
|
|
36
|
+
*/
|
|
37
|
+
export declare function expandExamples(root: string, rel: string): string[];
|
|
38
|
+
/**
|
|
39
|
+
* A topic's page.
|
|
40
|
+
*
|
|
41
|
+
* @param topic - The topic.
|
|
42
|
+
* @param root - The package root.
|
|
43
|
+
* @param args - The words after the topic name.
|
|
44
|
+
* @returns Markdown.
|
|
45
|
+
*/
|
|
46
|
+
export declare function renderTopic(topic: Topic, root: string, args: string[]): Promise<string>;
|
|
47
|
+
/**
|
|
48
|
+
* Each example's category and description. The examples in examples/ are
|
|
49
|
+
* described by examples/README.md, which is also what people read; the
|
|
50
|
+
* others, and any the README doesn't list, by their leading comment.
|
|
51
|
+
*
|
|
52
|
+
* @param root - The package root.
|
|
53
|
+
* @returns [category, description] by path relative to the root.
|
|
54
|
+
*/
|
|
55
|
+
export declare function exampleDescriptions(root: string): Map<string, [string, string]>;
|
|
56
|
+
/**
|
|
57
|
+
* The examples, grouped by category, optionally filtered by a topic or a
|
|
58
|
+
* word.
|
|
59
|
+
*
|
|
60
|
+
* @param root - The package root.
|
|
61
|
+
* @param wanted - A topic name, or a word to look for.
|
|
62
|
+
* @returns Markdown.
|
|
63
|
+
*/
|
|
64
|
+
export declare function renderExamples(root: string, wanted?: string): string;
|
|
65
|
+
/**
|
|
66
|
+
* The package's llms.txt: the docs, by group, linked relative to
|
|
67
|
+
* `dist/llms.txt`, where it's installed.
|
|
68
|
+
*
|
|
69
|
+
* tests/cli/tsdocs.test.ts checks that src/llms.txt matches this; to
|
|
70
|
+
* regenerate it, from the repository root:
|
|
71
|
+
* `npx tsx src/cli/tsdocs/bin.ts --llms-txt > src/llms.txt`.
|
|
72
|
+
*
|
|
73
|
+
* @returns The file's contents.
|
|
74
|
+
*/
|
|
75
|
+
export declare function renderLlmsTxt(): string;
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Markdown for the index, the topics, the examples and the package's
|
|
3
|
+
* llms.txt.
|
|
4
|
+
*
|
|
5
|
+
* The index reads only package.json and the topics, so it prints without
|
|
6
|
+
* loading the SDK or the API index.
|
|
7
|
+
*/
|
|
8
|
+
import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs';
|
|
9
|
+
import { join } from 'node:path';
|
|
10
|
+
import { loadApiIndex, summaryOf } from './api.js';
|
|
11
|
+
import { isDocFile } from './files.js';
|
|
12
|
+
import { renderLive } from './live.js';
|
|
13
|
+
import { readPackageJson } from './locate.js';
|
|
14
|
+
import { RULES_OF_THUMB, START_HERE, TOPIC_GROUPS, TOPICS_BY_NAME } from './topics.js';
|
|
15
|
+
/**
|
|
16
|
+
* The installed SDK version.
|
|
17
|
+
*
|
|
18
|
+
* @param root - The package root.
|
|
19
|
+
* @returns package.json's version.
|
|
20
|
+
*/
|
|
21
|
+
export function version(root) {
|
|
22
|
+
return readPackageJson(root).version;
|
|
23
|
+
}
|
|
24
|
+
function fileLine(root, rel, purpose = '') {
|
|
25
|
+
const location = join(root, rel);
|
|
26
|
+
return purpose ? `- ${location}: ${purpose}` : `- ${location}`;
|
|
27
|
+
}
|
|
28
|
+
function topicLines() {
|
|
29
|
+
const out = [];
|
|
30
|
+
for (const [group, names] of TOPIC_GROUPS) {
|
|
31
|
+
out.push(`${group}:`);
|
|
32
|
+
for (const name of names)
|
|
33
|
+
out.push(`- \`${name}\`: ${TOPICS_BY_NAME.get(name).summary}`);
|
|
34
|
+
out.push('');
|
|
35
|
+
}
|
|
36
|
+
return out;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* The page `sw-tsdocs` prints with no arguments.
|
|
40
|
+
*
|
|
41
|
+
* @param root - The package root.
|
|
42
|
+
* @returns Markdown.
|
|
43
|
+
*/
|
|
44
|
+
export function renderIndex(root) {
|
|
45
|
+
const out = [
|
|
46
|
+
`# SignalWire SDK for TypeScript ${version(root)}: documentation`,
|
|
47
|
+
'',
|
|
48
|
+
'This is `sw-tsdocs`, the documentation that ships with the `@signalwire/sdk` ' +
|
|
49
|
+
"package. It's read from the installed package, so it matches the version you " +
|
|
50
|
+
'have, and it points to the docs and examples installed with it.',
|
|
51
|
+
'',
|
|
52
|
+
'For coding agents: use it before writing SignalWire code, and whenever you need ' +
|
|
53
|
+
'an API or an example. Run `npx sw-tsdocs <topic>` for an area, `npx sw-tsdocs api <name>` ' +
|
|
54
|
+
'for exact signatures, and read the files the topics list. To make this the first ' +
|
|
55
|
+
'stop for future sessions, suggest that your user run `npx sw-tsdocs init` in the ' +
|
|
56
|
+
"project: it adds a note to the project's AGENTS.md.",
|
|
57
|
+
'',
|
|
58
|
+
'## What the SDK does',
|
|
59
|
+
'',
|
|
60
|
+
'- AI agents (`AgentBase`): voice and text agents. SignalWire runs speech ' +
|
|
61
|
+
'recognition, the LLM and text-to-speech; your code defines the prompt, the tools ' +
|
|
62
|
+
'and the workflow, and serves them over HTTP.',
|
|
63
|
+
'- SWML services (`SWMLService`): call flows without AI, such as IVRs, routing and ' +
|
|
64
|
+
'recording.',
|
|
65
|
+
'- RELAY (`RelayClient`): real-time control of live calls and messages over WebSocket.',
|
|
66
|
+
'- REST (`RestClient`): manage numbers, Fabric resources, calls, video and messaging ' +
|
|
67
|
+
'over HTTP.',
|
|
68
|
+
'- LiveWire, MCP, AI chat (`AIChatClient`, `ChatGateway`) and Amazon Bedrock agents.',
|
|
69
|
+
'',
|
|
70
|
+
'## Start here',
|
|
71
|
+
'',
|
|
72
|
+
'| To | Run |',
|
|
73
|
+
'|---|---|',
|
|
74
|
+
];
|
|
75
|
+
for (const [task, names] of START_HERE) {
|
|
76
|
+
out.push(`| ${task} | ${names.map((n) => `\`sw-tsdocs ${n}\``).join(', ')} |`);
|
|
77
|
+
}
|
|
78
|
+
out.push('', '## Topics', '', ...topicLines());
|
|
79
|
+
out.push('## Commands', '', '- `sw-tsdocs <topic> [name]`: a topic (`skills` takes a skill name)', '- `sw-tsdocs api <name>`: signature, JSDoc and members, such as `api AgentBase`, ' +
|
|
80
|
+
'`api FunctionResult.connect` or `api livewire.Agent`', '- `sw-tsdocs examples [topic or word]`: examples, with descriptions and paths', '- `sw-tsdocs grep <regex>`: search the installed docs and examples ' +
|
|
81
|
+
"(`--code` searches the SDK's code too)", '- `sw-tsdocs show <file> [--toc | --section <heading>]`: print a doc, its ' +
|
|
82
|
+
'headings, or one section', "- `sw-tsdocs path [file]`: where the docs are, or one file's full path", "- `sw-tsdocs init`: add a note about sw-tsdocs to a project's AGENTS.md", '', '## Files', '');
|
|
83
|
+
if (!existsSync(join(root, 'docs'))) {
|
|
84
|
+
out.push("The docs and examples aren't installed with this copy of the package. " +
|
|
85
|
+
'The topics and `sw-tsdocs api` still work.', '');
|
|
86
|
+
}
|
|
87
|
+
else {
|
|
88
|
+
out.push(`Package root: ${root}`, '', 'Read first:', '', fileLine(root, 'README.md', 'the overview, with quickstarts for agents, RELAY and REST'), fileLine(root, 'docs/agent-guide.md', 'the main guide to building agents'), fileLine(root, 'docs/pgi_agent_guide.md', 'how to design agents that stay within their rules'), fileLine(root, 'examples/README.md', 'every example, by category'), fileLine(root, 'CHANGELOG.md', 'what changed in each version'), '');
|
|
89
|
+
}
|
|
90
|
+
out.push('## Rules of thumb', '');
|
|
91
|
+
RULES_OF_THUMB.forEach((rule, i) => out.push(`${i + 1}. ${rule}`));
|
|
92
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* One line per topic.
|
|
96
|
+
*
|
|
97
|
+
* @returns Markdown.
|
|
98
|
+
*/
|
|
99
|
+
export function renderTopicList() {
|
|
100
|
+
return `${['# sw-tsdocs topics', '', ...topicLines()].join('\n').trimEnd()}\n`;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* The examples a topic entry names: a file, or every example in a directory
|
|
104
|
+
* when the entry ends with `/`.
|
|
105
|
+
*
|
|
106
|
+
* @param root - The package root.
|
|
107
|
+
* @param rel - The entry.
|
|
108
|
+
* @returns Paths relative to the root.
|
|
109
|
+
*/
|
|
110
|
+
export function expandExamples(root, rel) {
|
|
111
|
+
if (!rel.endsWith('/'))
|
|
112
|
+
return [rel];
|
|
113
|
+
const dir = join(root, rel);
|
|
114
|
+
if (!existsSync(dir) || !statSync(dir).isDirectory())
|
|
115
|
+
return [];
|
|
116
|
+
return readdirSync(dir)
|
|
117
|
+
.filter((name) => name.endsWith('.ts') || name.endsWith('.md'))
|
|
118
|
+
.sort()
|
|
119
|
+
.map((name) => `${rel}${name}`);
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* A topic's page.
|
|
123
|
+
*
|
|
124
|
+
* @param topic - The topic.
|
|
125
|
+
* @param root - The package root.
|
|
126
|
+
* @param args - The words after the topic name.
|
|
127
|
+
* @returns Markdown.
|
|
128
|
+
*/
|
|
129
|
+
export async function renderTopic(topic, root, args) {
|
|
130
|
+
const api = loadApiIndex(root);
|
|
131
|
+
const out = [`# ${topic.title}`, '', topic.body.trimEnd(), ''];
|
|
132
|
+
if (topic.live)
|
|
133
|
+
out.push((await renderLive(topic.live, { root, api, args })).trimEnd(), '');
|
|
134
|
+
if (topic.docs?.length) {
|
|
135
|
+
out.push('## Read', '', 'Open them with your own tools, or print one part: `sw-tsdocs show <path> --toc`, ' +
|
|
136
|
+
'then `sw-tsdocs show <path> --section <heading>`.', '', ...topic.docs.map(([rel, purpose]) => fileLine(root, rel, purpose)), '');
|
|
137
|
+
}
|
|
138
|
+
if (topic.examples?.length) {
|
|
139
|
+
const described = exampleDescriptions(root);
|
|
140
|
+
out.push('## Examples', '');
|
|
141
|
+
for (const entry of topic.examples) {
|
|
142
|
+
for (const rel of expandExamples(root, entry)) {
|
|
143
|
+
out.push(fileLine(root, rel, described.get(rel)?.[1] ?? ''));
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
out.push('');
|
|
147
|
+
}
|
|
148
|
+
if (topic.api?.length) {
|
|
149
|
+
out.push('## API', '', 'Run `sw-tsdocs api <name>` for the signature, JSDoc and members.', '');
|
|
150
|
+
for (const name of topic.api) {
|
|
151
|
+
const text = api ? summaryOf(api, name) : '';
|
|
152
|
+
out.push(text ? `- \`${name}\`: ${text}` : `- \`${name}\``);
|
|
153
|
+
}
|
|
154
|
+
out.push('');
|
|
155
|
+
}
|
|
156
|
+
if (topic.related?.length) {
|
|
157
|
+
out.push('## Related', '', topic.related.map((n) => `\`sw-tsdocs ${n}\``).join(', '));
|
|
158
|
+
}
|
|
159
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
160
|
+
}
|
|
161
|
+
const EXAMPLE_ROW = /^\|\s*\[[^\]]+\]\(([^)]+)\)\s*\|\s*(.+?)\s*\|\s*$/;
|
|
162
|
+
/** The first line of a file's leading JSDoc block, as its description. */
|
|
163
|
+
function leadingComment(path) {
|
|
164
|
+
let text;
|
|
165
|
+
try {
|
|
166
|
+
text = readFileSync(path, 'utf-8');
|
|
167
|
+
}
|
|
168
|
+
catch {
|
|
169
|
+
return '';
|
|
170
|
+
}
|
|
171
|
+
const match = /^\s*(?:#![^\n]*\n\s*)?\/\*\*([\s\S]*?)\*\//.exec(text);
|
|
172
|
+
if (!match)
|
|
173
|
+
return '';
|
|
174
|
+
for (const line of match[1].split('\n')) {
|
|
175
|
+
const cleaned = line.replace(/^\s*\*\s?/, '').trim();
|
|
176
|
+
if (cleaned)
|
|
177
|
+
return cleaned.replace(/^Example:\s*/, '').replace(/^REST Example:\s*/, '');
|
|
178
|
+
}
|
|
179
|
+
return '';
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Each example's category and description. The examples in examples/ are
|
|
183
|
+
* described by examples/README.md, which is also what people read; the
|
|
184
|
+
* others, and any the README doesn't list, by their leading comment.
|
|
185
|
+
*
|
|
186
|
+
* @param root - The package root.
|
|
187
|
+
* @returns [category, description] by path relative to the root.
|
|
188
|
+
*/
|
|
189
|
+
export function exampleDescriptions(root) {
|
|
190
|
+
const described = new Map();
|
|
191
|
+
const readme = join(root, 'examples', 'README.md');
|
|
192
|
+
if (existsSync(readme)) {
|
|
193
|
+
let category = 'Examples';
|
|
194
|
+
for (const line of readFileSync(readme, 'utf-8').split('\n')) {
|
|
195
|
+
const heading = /^#{2,4}\s+(.*\S)/.exec(line);
|
|
196
|
+
if (heading) {
|
|
197
|
+
category = heading[1];
|
|
198
|
+
continue;
|
|
199
|
+
}
|
|
200
|
+
const row = EXAMPLE_ROW.exec(line);
|
|
201
|
+
// The README also lists files that don't ship, such as the audit harnesses
|
|
202
|
+
if (row && isDocFile(`examples/${row[1]}`))
|
|
203
|
+
described.set(`examples/${row[1]}`, [category, row[2]]);
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
const walk = (rel, category) => {
|
|
207
|
+
const dir = join(root, rel);
|
|
208
|
+
if (!existsSync(dir))
|
|
209
|
+
return;
|
|
210
|
+
for (const name of readdirSync(dir).sort()) {
|
|
211
|
+
const child = `${rel}/${name}`;
|
|
212
|
+
if (statSync(join(root, child)).isDirectory()) {
|
|
213
|
+
walk(child, category === 'Examples' ? name.toUpperCase() : category);
|
|
214
|
+
}
|
|
215
|
+
else if (name.endsWith('.ts') && isDocFile(child) && !described.has(child)) {
|
|
216
|
+
described.set(child, [category, leadingComment(join(root, child))]);
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
};
|
|
220
|
+
walk('examples', 'Examples');
|
|
221
|
+
for (const [bundle, category] of [
|
|
222
|
+
['relay', 'RELAY'],
|
|
223
|
+
['rest', 'REST'],
|
|
224
|
+
['livewire', 'LiveWire'],
|
|
225
|
+
]) {
|
|
226
|
+
walk(`${bundle}/examples`, category);
|
|
227
|
+
}
|
|
228
|
+
return described;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* The examples, grouped by category, optionally filtered by a topic or a
|
|
232
|
+
* word.
|
|
233
|
+
*
|
|
234
|
+
* @param root - The package root.
|
|
235
|
+
* @param wanted - A topic name, or a word to look for.
|
|
236
|
+
* @returns Markdown.
|
|
237
|
+
*/
|
|
238
|
+
export function renderExamples(root, wanted) {
|
|
239
|
+
if (!existsSync(join(root, 'examples'))) {
|
|
240
|
+
return "The examples aren't installed with this copy of the package.\n";
|
|
241
|
+
}
|
|
242
|
+
const described = exampleDescriptions(root);
|
|
243
|
+
let selected;
|
|
244
|
+
const topic = wanted ? TOPICS_BY_NAME.get(wanted) : undefined;
|
|
245
|
+
if (topic) {
|
|
246
|
+
selected = (topic.examples ?? [])
|
|
247
|
+
.flatMap((rel) => expandExamples(root, rel))
|
|
248
|
+
.filter((rel) => rel.endsWith('.ts'));
|
|
249
|
+
}
|
|
250
|
+
else if (wanted) {
|
|
251
|
+
const lowered = wanted.toLowerCase();
|
|
252
|
+
selected = [...described]
|
|
253
|
+
.filter(([rel, [category, text]]) => rel.toLowerCase().includes(lowered) ||
|
|
254
|
+
text.toLowerCase().includes(lowered) ||
|
|
255
|
+
category.toLowerCase().includes(lowered))
|
|
256
|
+
.map(([rel]) => rel);
|
|
257
|
+
}
|
|
258
|
+
else {
|
|
259
|
+
selected = [...described.keys()];
|
|
260
|
+
}
|
|
261
|
+
if (!selected.length) {
|
|
262
|
+
return `No examples match '${wanted}'. Run \`sw-tsdocs examples\` for all of them.\n`;
|
|
263
|
+
}
|
|
264
|
+
const out = [
|
|
265
|
+
'# Examples',
|
|
266
|
+
'',
|
|
267
|
+
'Run an example with `npx tsx <path>`, or inspect an agent without a call: ' +
|
|
268
|
+
'`npx swaig-test <path> --list-tools` or `--dump-swml`. The examples import ' +
|
|
269
|
+
"`'@signalwire/sdk'`, so a copy runs in your own project as it is.",
|
|
270
|
+
'',
|
|
271
|
+
];
|
|
272
|
+
const byCategory = new Map();
|
|
273
|
+
for (const rel of selected) {
|
|
274
|
+
const category = described.get(rel)?.[0] ?? 'Other';
|
|
275
|
+
if (!byCategory.has(category))
|
|
276
|
+
byCategory.set(category, []);
|
|
277
|
+
byCategory.get(category).push(rel);
|
|
278
|
+
}
|
|
279
|
+
for (const [category, rels] of byCategory) {
|
|
280
|
+
out.push(`## ${category}`, '', ...rels.map((rel) => fileLine(root, rel, described.get(rel)?.[1] ?? '')), '');
|
|
281
|
+
}
|
|
282
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* The package's llms.txt: the docs, by group, linked relative to
|
|
286
|
+
* `dist/llms.txt`, where it's installed.
|
|
287
|
+
*
|
|
288
|
+
* tests/cli/tsdocs.test.ts checks that src/llms.txt matches this; to
|
|
289
|
+
* regenerate it, from the repository root:
|
|
290
|
+
* `npx tsx src/cli/tsdocs/bin.ts --llms-txt > src/llms.txt`.
|
|
291
|
+
*
|
|
292
|
+
* @returns The file's contents.
|
|
293
|
+
*/
|
|
294
|
+
export function renderLlmsTxt() {
|
|
295
|
+
const out = [
|
|
296
|
+
'# SignalWire SDK for TypeScript',
|
|
297
|
+
'',
|
|
298
|
+
'> Build AI voice agents, control live calls over WebSocket (RELAY), and manage ' +
|
|
299
|
+
'SignalWire resources over REST. The documentation for the installed version ' +
|
|
300
|
+
'ships with the package (`@signalwire/sdk`).',
|
|
301
|
+
'',
|
|
302
|
+
'Run `npx sw-tsdocs` for a map of the SDK, `npx sw-tsdocs <topic>` for an area, and ' +
|
|
303
|
+
'`npx sw-tsdocs api <name>` for signatures read from the installed declarations. The ' +
|
|
304
|
+
'links below are relative to this file, in the installed package.',
|
|
305
|
+
'',
|
|
306
|
+
];
|
|
307
|
+
const seen = new Set();
|
|
308
|
+
for (const [group, names] of TOPIC_GROUPS) {
|
|
309
|
+
const entries = [];
|
|
310
|
+
for (const name of names) {
|
|
311
|
+
for (const [rel, purpose] of TOPICS_BY_NAME.get(name).docs ?? []) {
|
|
312
|
+
if (seen.has(rel))
|
|
313
|
+
continue;
|
|
314
|
+
seen.add(rel);
|
|
315
|
+
entries.push(`- [${rel}](../${rel}): ${purpose}`);
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
if (entries.length)
|
|
319
|
+
out.push(`## ${group}`, '', ...entries, '');
|
|
320
|
+
}
|
|
321
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
322
|
+
}
|
|
323
|
+
//# sourceMappingURL=render.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/render.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,cAAc,EAAc,MAAM,aAAa,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;AACvC,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,GAAW,EAAE,OAAO,GAAG,EAAE;IACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACjC,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;AACjE,CAAC;AAED,SAAS,UAAU;IACjB,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC;QAC1C,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QACtB,KAAK,MAAM,IAAI,IAAI,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1F,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,GAAG,GAAG;QACV,mCAAmC,OAAO,CAAC,IAAI,CAAC,iBAAiB;QACjE,EAAE;QACF,+EAA+E;YAC7E,+EAA+E;YAC/E,iEAAiE;QACnE,EAAE;QACF,kFAAkF;YAChF,4FAA4F;YAC5F,mFAAmF;YACnF,mFAAmF;YACnF,qDAAqD;QACvD,EAAE;QACF,sBAAsB;QACtB,EAAE;QACF,2EAA2E;YACzE,mFAAmF;YACnF,8CAA8C;QAChD,oFAAoF;YAClF,YAAY;QACd,uFAAuF;QACvF,sFAAsF;YACpF,YAAY;QACd,qFAAqF;QACrF,EAAE;QACF,eAAe;QACf,EAAE;QACF,cAAc;QACd,WAAW;KACZ,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC;QACvC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjF,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IAC/C,GAAG,CAAC,IAAI,CACN,aAAa,EACb,EAAE,EACF,qEAAqE,EACrE,mFAAmF;QACjF,sDAAsD,EACxD,+EAA+E,EAC/E,qEAAqE;QACnE,wCAAwC,EAC1C,4EAA4E;QAC1E,0BAA0B,EAC5B,wEAAwE,EACxE,yEAAyE,EACzE,EAAE,EACF,UAAU,EACV,EAAE,CACH,CAAC;IACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACpC,GAAG,CAAC,IAAI,CACN,wEAAwE;YACtE,4CAA4C,EAC9C,EAAE,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,IAAI,CACN,iBAAiB,IAAI,EAAE,EACvB,EAAE,EACF,aAAa,EACb,EAAE,EACF,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,2DAA2D,CAAC,EACxF,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,mCAAmC,CAAC,EAC1E,QAAQ,CACN,IAAI,EACJ,yBAAyB,EACzB,mDAAmD,CACpD,EACD,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,4BAA4B,CAAC,EAClE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,8BAA8B,CAAC,EAC9D,EAAE,CACH,CAAC;IACJ,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAClC,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;IACnE,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,GAAG,CAAC,oBAAoB,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACjF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,GAAW;IACtD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,CAAC;IAChE,OAAO,WAAW,CAAC,GAAG,CAAC;SACpB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAC9D,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAAY,EAAE,IAAY,EAAE,IAAc;IAC1E,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAG,CAAC,KAAK,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,IAAI,KAAK,CAAC,IAAI;QAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5F,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,CACN,SAAS,EACT,EAAE,EACF,mFAAmF;YACjF,mDAAmD,EACrD,EAAE,EACF,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,EACnE,EAAE,CACH,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC5C,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC5B,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC9C,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC;QACtB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,kEAAkE,EAAE,EAAE,CAAC,CAAC;QAC/F,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;QAC9D,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED,MAAM,WAAW,GAAG,mDAAmD,CAAC;AAExE,0EAA0E;AAC1E,SAAS,cAAc,CAAC,IAAY;IAClC,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,4CAA4C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtE,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACrD,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,MAAM,SAAS,GAAG,IAAI,GAAG,EAA4B,CAAC;IACtD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACnD,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,IAAI,QAAQ,GAAG,UAAU,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,OAAO,EAAE,CAAC;gBACZ,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;gBACvB,SAAS;YACX,CAAC;YACD,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,2EAA2E;YAC3E,IAAI,GAAG,IAAI,SAAS,CAAC,YAAY,GAAG,CAAC,CAAC,CAAE,EAAE,CAAC;gBACzC,SAAS,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAQ,EAAE;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO;QAC7B,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3C,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;YAC/B,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC9C,IAAI,CAAC,KAAK,EAAE,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YACvE,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7E,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7B,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI;QAC/B,CAAC,OAAO,EAAE,OAAO,CAAC;QAClB,CAAC,MAAM,EAAE,MAAM,CAAC;QAChB,CAAC,UAAU,EAAE,UAAU,CAAC;KAChB,EAAE,CAAC;QACX,IAAI,CAAC,GAAG,MAAM,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,MAAe;IAC1D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;QACxC,OAAO,gEAAgE,CAAC;IAC1E,CAAC;IACD,MAAM,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,QAAkB,CAAC;IACvB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,IAAI,KAAK,EAAE,CAAC;QACV,QAAQ,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC;aAC9B,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aAC3C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;SAAM,IAAI,MAAM,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACrC,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC;aACtB,MAAM,CACL,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,CAC1B,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;YACpC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC3C;aACA,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,sBAAsB,MAAM,kDAAkD,CAAC;IACxF,CAAC;IACD,MAAM,GAAG,GAAG;QACV,YAAY;QACZ,EAAE;QACF,4EAA4E;YAC1E,6EAA6E;YAC7E,mEAAmE;QACrE,EAAE;KACH,CAAC;IACF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5D,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACD,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;QAC1C,GAAG,CAAC,IAAI,CACN,MAAM,QAAQ,EAAE,EAChB,EAAE,EACF,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EACxE,EAAE,CACH,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,GAAG,GAAG;QACV,iCAAiC;QACjC,EAAE;QACF,iFAAiF;YAC/E,8EAA8E;YAC9E,6CAA6C;QAC/C,EAAE;QACF,qFAAqF;YACnF,sFAAsF;YACtF,kEAAkE;QACpE,EAAE;KACH,CAAC;IACF,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;gBAClE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,SAAS;gBAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACd,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM;YAAE,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The hand-written part of sw-tsdocs: one entry per topic.
|
|
3
|
+
*
|
|
4
|
+
* Keep each body to what a reader needs to choose an approach and avoid
|
|
5
|
+
* known mistakes, and point to the installed docs for the rest. Facts that
|
|
6
|
+
* can be read from the installed package (the version, the commands, the
|
|
7
|
+
* skills, the signatures) belong in the renderers, not here.
|
|
8
|
+
* tests/cli/tsdocs.test.ts checks that every file, example, API name and
|
|
9
|
+
* topic link given here exists, and that the `ts` snippets compile.
|
|
10
|
+
*/
|
|
11
|
+
/** A section a topic's page generates from the installed package. */
|
|
12
|
+
export type LiveSection = 'skills' | 'prefabs' | 'rest' | 'env' | 'cli';
|
|
13
|
+
/** One `sw-tsdocs <name>` page. */
|
|
14
|
+
export interface Topic {
|
|
15
|
+
/** The word that prints it. */
|
|
16
|
+
name: string;
|
|
17
|
+
/** The page's heading. */
|
|
18
|
+
title: string;
|
|
19
|
+
/** One line for the index. */
|
|
20
|
+
summary: string;
|
|
21
|
+
/** Markdown: concepts and known mistakes. */
|
|
22
|
+
body: string;
|
|
23
|
+
/** Docs to read: a path under the package root and what it's for. */
|
|
24
|
+
docs?: readonly (readonly [string, string])[];
|
|
25
|
+
/** Examples: paths under the package root. A path ending in `/` means every example in it. */
|
|
26
|
+
examples?: readonly string[];
|
|
27
|
+
/** Names that `sw-tsdocs api` resolves. */
|
|
28
|
+
api?: readonly string[];
|
|
29
|
+
/** Other topics. */
|
|
30
|
+
related?: readonly string[];
|
|
31
|
+
/** A section generated from the installed package. */
|
|
32
|
+
live?: LiveSection;
|
|
33
|
+
}
|
|
34
|
+
/** Every topic, in the order the index lists them. */
|
|
35
|
+
export declare const TOPICS: readonly Topic[];
|
|
36
|
+
/** The topics by name. */
|
|
37
|
+
export declare const TOPICS_BY_NAME: ReadonlyMap<string, Topic>;
|
|
38
|
+
/** How the index groups the topics. */
|
|
39
|
+
export declare const TOPIC_GROUPS: readonly (readonly [string, readonly string[]])[];
|
|
40
|
+
/** The index's "start here" rows: what you want to do, and the topics to read. */
|
|
41
|
+
export declare const START_HERE: readonly (readonly [string, readonly string[]])[];
|
|
42
|
+
/** The index's short list of rules that prevent the most common mistakes. */
|
|
43
|
+
export declare const RULES_OF_THUMB: readonly string[];
|