@signalwire/sdk 2.0.5 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +481 -126
- package/dist/AgentBase.js +1502 -438
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +18 -0
- package/dist/PomBuilder.js +53 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +22 -1
- package/dist/PromptManager.js +28 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +158 -58
- package/dist/SWMLService.js +435 -127
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +92 -33
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -371
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +47 -68
- package/dist/index.js +44 -73
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +44 -17
- package/dist/relay/RelayClient.js +175 -65
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +73 -42
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +21 -22
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +38 -30
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +294 -100
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +14 -13
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +59 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +85 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* sw-tsdocs: the SDK's documentation, from the installed package.
|
|
3
|
+
*
|
|
4
|
+
* Written for people and for coding agents. With no arguments it prints an
|
|
5
|
+
* index; each topic lists the concepts, the installed files to read,
|
|
6
|
+
* examples and API names; `api` reads signatures and JSDoc from the
|
|
7
|
+
* package's declarations, so the answers match the installed version.
|
|
8
|
+
*
|
|
9
|
+
* Mirrors signalwire-python's `sw-pydocs` (signalwire/cli/pydocs/).
|
|
10
|
+
*/
|
|
11
|
+
import { existsSync, readFileSync, statSync } from 'node:fs';
|
|
12
|
+
import { resolve } from 'node:path';
|
|
13
|
+
import { init, note } from './agentsNote.js';
|
|
14
|
+
import { closeMatches, loadApiIndex, renderFound, resolveName, suggestions, summary, } from './api.js';
|
|
15
|
+
import { allDocFiles, codeFiles, grepFiles, headings, isText, resolveDoc, section, } from './files.js';
|
|
16
|
+
import { codeDir, packageRoot } from './locate.js';
|
|
17
|
+
import { renderExamples, renderIndex, renderLlmsTxt, renderTopic, renderTopicList, version, } from './render.js';
|
|
18
|
+
import { TOPICS_BY_NAME } from './topics.js';
|
|
19
|
+
/** The command's usage text. */
|
|
20
|
+
export const USAGE = `usage: sw-tsdocs [<topic> [name] | <command> ...]
|
|
21
|
+
|
|
22
|
+
sw-tsdocs the index: what the SDK does, where to start
|
|
23
|
+
sw-tsdocs <topic> one area: concepts, files to read, examples, API
|
|
24
|
+
sw-tsdocs topics every topic, one line each
|
|
25
|
+
sw-tsdocs api <name> signature, JSDoc and members of a name
|
|
26
|
+
sw-tsdocs examples [filter] examples with descriptions and paths
|
|
27
|
+
sw-tsdocs grep <regex> search the installed docs and examples
|
|
28
|
+
(--code: the SDK's code too; --limit N)
|
|
29
|
+
sw-tsdocs show <file> print a doc (--toc for headings, --section <heading>)
|
|
30
|
+
sw-tsdocs path [file] where the docs are, or one file's full path
|
|
31
|
+
sw-tsdocs init [--skill] add a note about sw-tsdocs to AGENTS.md
|
|
32
|
+
(--dir <project>, --print)
|
|
33
|
+
sw-tsdocs --version the installed SDK version
|
|
34
|
+
|
|
35
|
+
Run it with npx in a project that depends on @signalwire/sdk.
|
|
36
|
+
`;
|
|
37
|
+
const COMMANDS = ['topics', 'api', 'examples', 'grep', 'show', 'path', 'init', 'help'];
|
|
38
|
+
const processIo = {
|
|
39
|
+
out: (text) => process.stdout.write(text),
|
|
40
|
+
err: (text) => process.stderr.write(text),
|
|
41
|
+
};
|
|
42
|
+
const withNewline = (text) => (text.endsWith('\n') ? text : `${text}\n`);
|
|
43
|
+
/** A usage error: exit status 2. */
|
|
44
|
+
class UsageError extends Error {
|
|
45
|
+
}
|
|
46
|
+
/** Split `argv` into positionals, flags and `--name value` options. */
|
|
47
|
+
function parseArgs(argv, flags, options) {
|
|
48
|
+
const positional = [];
|
|
49
|
+
const seen = new Set();
|
|
50
|
+
const values = new Map();
|
|
51
|
+
for (let i = 0; i < argv.length; i++) {
|
|
52
|
+
const arg = argv[i];
|
|
53
|
+
const eq = arg.indexOf('=');
|
|
54
|
+
const name = arg.startsWith('--') && eq > 0 ? arg.slice(0, eq) : arg;
|
|
55
|
+
if (flags.includes(arg)) {
|
|
56
|
+
seen.add(arg);
|
|
57
|
+
}
|
|
58
|
+
else if (options.includes(name)) {
|
|
59
|
+
const value = name !== arg ? arg.slice(eq + 1) : argv[++i];
|
|
60
|
+
if (value === undefined)
|
|
61
|
+
throw new UsageError(`${name} needs a value.`);
|
|
62
|
+
values.set(name, value);
|
|
63
|
+
}
|
|
64
|
+
else if (arg.startsWith('-') && arg !== '-') {
|
|
65
|
+
throw new UsageError(`Unknown option ${arg}.`);
|
|
66
|
+
}
|
|
67
|
+
else {
|
|
68
|
+
positional.push(arg);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return { positional, flags: seen, options: values };
|
|
72
|
+
}
|
|
73
|
+
function cmdApi(root, argv, io) {
|
|
74
|
+
const { positional } = parseArgs(argv, [], []);
|
|
75
|
+
const name = positional[0];
|
|
76
|
+
if (!name || positional.length > 1) {
|
|
77
|
+
throw new UsageError('usage: sw-tsdocs api <name>, such as AgentBase or FunctionResult.connect');
|
|
78
|
+
}
|
|
79
|
+
const index = loadApiIndex(root);
|
|
80
|
+
if (!index) {
|
|
81
|
+
io.err("The API index isn't built: run `npm run build` in the SDK's repository.\n");
|
|
82
|
+
return 1;
|
|
83
|
+
}
|
|
84
|
+
const found = resolveName(index, name);
|
|
85
|
+
if (!found.length) {
|
|
86
|
+
const hint = suggestions(index, name);
|
|
87
|
+
const more = hint.length ? ` Similar names: ${hint.join(', ')}.` : '';
|
|
88
|
+
io.err(`No SDK name '${name}' found.${more} Try \`sw-tsdocs grep ${name}\`.\n`);
|
|
89
|
+
return 1;
|
|
90
|
+
}
|
|
91
|
+
let text = renderFound(index, found[0], root);
|
|
92
|
+
if (found.length > 1) {
|
|
93
|
+
const others = found
|
|
94
|
+
.slice(1)
|
|
95
|
+
.map((f) => {
|
|
96
|
+
const doc = summary(f.member ? f.member.doc : f.entry.doc);
|
|
97
|
+
return doc ? `- \`${f.name}\`: ${doc}` : `- \`${f.name}\``;
|
|
98
|
+
})
|
|
99
|
+
.join('\n');
|
|
100
|
+
text += `\n## Other matches\n\n${others}\n`;
|
|
101
|
+
}
|
|
102
|
+
io.out(withNewline(text));
|
|
103
|
+
return 0;
|
|
104
|
+
}
|
|
105
|
+
function cmdExamples(root, argv, io) {
|
|
106
|
+
const { positional } = parseArgs(argv, [], []);
|
|
107
|
+
io.out(withNewline(renderExamples(root, positional[0])));
|
|
108
|
+
return 0;
|
|
109
|
+
}
|
|
110
|
+
function cmdGrep(root, argv, io) {
|
|
111
|
+
const args = parseArgs(argv, ['--code'], ['--limit']);
|
|
112
|
+
const source = args.positional[0];
|
|
113
|
+
if (!source || args.positional.length > 1)
|
|
114
|
+
throw new UsageError('usage: sw-tsdocs grep <regex> [--code] [--limit N]');
|
|
115
|
+
const limitText = args.options.get('--limit') ?? '100';
|
|
116
|
+
const limit = Number(limitText);
|
|
117
|
+
if (!Number.isInteger(limit) || limit < 1)
|
|
118
|
+
throw new UsageError('--limit must be 1 or more.');
|
|
119
|
+
let pattern;
|
|
120
|
+
try {
|
|
121
|
+
pattern = new RegExp(source, 'i');
|
|
122
|
+
}
|
|
123
|
+
catch (err) {
|
|
124
|
+
throw new UsageError(`Invalid regular expression: ${err.message}`);
|
|
125
|
+
}
|
|
126
|
+
const files = allDocFiles(root);
|
|
127
|
+
if (args.flags.has('--code')) {
|
|
128
|
+
for (const [rel, path] of codeFiles(codeDir(root)))
|
|
129
|
+
files.set(rel, path);
|
|
130
|
+
}
|
|
131
|
+
const { matches, total } = grepFiles(pattern, files, limit);
|
|
132
|
+
if (!matches.length) {
|
|
133
|
+
io.err(`No matches for '${source}'.\n`);
|
|
134
|
+
return 1;
|
|
135
|
+
}
|
|
136
|
+
const lines = matches.map((m) => `${files.get(m.rel)}:${m.line}: ${m.text}`);
|
|
137
|
+
if (total > matches.length) {
|
|
138
|
+
lines.push(`... ${total - matches.length} more; narrow the pattern or raise --limit.`);
|
|
139
|
+
}
|
|
140
|
+
io.out(`${lines.join('\n')}\n`);
|
|
141
|
+
return 0;
|
|
142
|
+
}
|
|
143
|
+
function cmdShow(root, argv, io) {
|
|
144
|
+
const args = parseArgs(argv, ['--toc'], ['--section']);
|
|
145
|
+
const file = args.positional[0];
|
|
146
|
+
if (!file || args.positional.length > 1) {
|
|
147
|
+
throw new UsageError('usage: sw-tsdocs show <file> [--toc | --section <heading>]');
|
|
148
|
+
}
|
|
149
|
+
const wantedSection = args.options.get('--section');
|
|
150
|
+
if (args.flags.has('--toc') && wantedSection !== undefined) {
|
|
151
|
+
throw new UsageError('Use --toc or --section, not both.');
|
|
152
|
+
}
|
|
153
|
+
const files = allDocFiles(root);
|
|
154
|
+
const matches = resolveDoc(file, files);
|
|
155
|
+
if (!matches.length) {
|
|
156
|
+
io.err(`No installed doc matches '${file}'. \`sw-tsdocs grep\` searches their text.\n`);
|
|
157
|
+
return 1;
|
|
158
|
+
}
|
|
159
|
+
if (matches.length > 1) {
|
|
160
|
+
io.err(`'${file}' matches several docs; name one:\n${matches
|
|
161
|
+
.slice(0, 20)
|
|
162
|
+
.map((m) => `- ${m}`)
|
|
163
|
+
.join('\n')}\n`);
|
|
164
|
+
return 1;
|
|
165
|
+
}
|
|
166
|
+
const rel = matches[0];
|
|
167
|
+
const path = files.get(rel);
|
|
168
|
+
if (!isText(rel)) {
|
|
169
|
+
io.err(`${path} isn't a text file.\n`);
|
|
170
|
+
return 1;
|
|
171
|
+
}
|
|
172
|
+
const text = readFileSync(path, 'utf-8');
|
|
173
|
+
if (args.flags.has('--toc')) {
|
|
174
|
+
const marks = headings(text);
|
|
175
|
+
if (!marks.length) {
|
|
176
|
+
io.out(`${path} has no headings.\n`);
|
|
177
|
+
return 0;
|
|
178
|
+
}
|
|
179
|
+
io.out(`${marks.map((m) => `${String(m.line).padStart(6)} ${' '.repeat(m.level - 1)}${m.text}`).join('\n')}\n`);
|
|
180
|
+
return 0;
|
|
181
|
+
}
|
|
182
|
+
if (wantedSection !== undefined) {
|
|
183
|
+
const found = section(text, wantedSection);
|
|
184
|
+
if (!found) {
|
|
185
|
+
io.err(`No heading in ${rel} contains '${wantedSection}'. \`--toc\` lists them.\n`);
|
|
186
|
+
return 1;
|
|
187
|
+
}
|
|
188
|
+
io.out(`<!-- ${path}:${found.heading.line} -->\n${found.body}`);
|
|
189
|
+
return 0;
|
|
190
|
+
}
|
|
191
|
+
io.out(withNewline(text));
|
|
192
|
+
return 0;
|
|
193
|
+
}
|
|
194
|
+
function cmdPath(root, argv, io) {
|
|
195
|
+
const { positional } = parseArgs(argv, [], []);
|
|
196
|
+
const file = positional[0];
|
|
197
|
+
if (file === undefined) {
|
|
198
|
+
io.out(`${root}\n`);
|
|
199
|
+
return 0;
|
|
200
|
+
}
|
|
201
|
+
const files = allDocFiles(root);
|
|
202
|
+
const matches = resolveDoc(file, files);
|
|
203
|
+
if (!matches.length) {
|
|
204
|
+
io.err(`No installed doc matches '${file}'.\n`);
|
|
205
|
+
return 1;
|
|
206
|
+
}
|
|
207
|
+
io.out(`${matches
|
|
208
|
+
.slice(0, 20)
|
|
209
|
+
.map((m) => files.get(m))
|
|
210
|
+
.join('\n')}\n`);
|
|
211
|
+
return 0;
|
|
212
|
+
}
|
|
213
|
+
function cmdInit(argv, io) {
|
|
214
|
+
const args = parseArgs(argv, ['--skill', '--print'], ['--dir']);
|
|
215
|
+
if (args.positional.length)
|
|
216
|
+
throw new UsageError('usage: sw-tsdocs init [--dir <project>] [--skill] [--print]');
|
|
217
|
+
if (args.flags.has('--print')) {
|
|
218
|
+
io.out(note());
|
|
219
|
+
return 0;
|
|
220
|
+
}
|
|
221
|
+
const project = resolve(args.options.get('--dir') ?? '.');
|
|
222
|
+
if (!existsSync(project) || !statSync(project).isDirectory()) {
|
|
223
|
+
io.err(`${project} isn't a directory.\n`);
|
|
224
|
+
return 2;
|
|
225
|
+
}
|
|
226
|
+
const changes = init(project, args.flags.has('--skill'));
|
|
227
|
+
io.out(`${changes.map(([path, how]) => `${how}: ${path}`).join('\n')}\n`);
|
|
228
|
+
return 0;
|
|
229
|
+
}
|
|
230
|
+
/** Try the word as an API name, then as a doc, before giving up. */
|
|
231
|
+
function unknownWord(root, word, rest, io) {
|
|
232
|
+
const index = loadApiIndex(root);
|
|
233
|
+
if (index && resolveName(index, word).length) {
|
|
234
|
+
io.out(`<!-- \`${word}\` isn't a topic; this is \`sw-tsdocs api ${word}\` -->\n`);
|
|
235
|
+
return cmdApi(root, [word], io);
|
|
236
|
+
}
|
|
237
|
+
if (resolveDoc(word, allDocFiles(root)).length) {
|
|
238
|
+
io.out(`<!-- \`${word}\` isn't a topic; this is \`sw-tsdocs show ${word}\` -->\n`);
|
|
239
|
+
return cmdShow(root, [word, ...rest], io);
|
|
240
|
+
}
|
|
241
|
+
const close = closeMatches(word, [...TOPICS_BY_NAME.keys(), ...COMMANDS], 3, 0.5);
|
|
242
|
+
const more = close.length ? ` Did you mean: ${close.join(', ')}?` : '';
|
|
243
|
+
io.err(`No topic, command, SDK name or doc called '${word}'.${more} Run \`sw-tsdocs\` for the index.\n`);
|
|
244
|
+
return 2;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Run sw-tsdocs.
|
|
248
|
+
*
|
|
249
|
+
* @param argv - The arguments, without the program name.
|
|
250
|
+
* @param io - Where output goes.
|
|
251
|
+
* @param root - The package root; found from this module by default.
|
|
252
|
+
* @returns The exit status: 0, 1 when a name or file isn't found, 2 for a usage error.
|
|
253
|
+
*/
|
|
254
|
+
export async function main(argv, io = processIo, root = packageRoot()) {
|
|
255
|
+
const [first, ...rest] = argv;
|
|
256
|
+
try {
|
|
257
|
+
if (first === undefined) {
|
|
258
|
+
io.out(renderIndex(root));
|
|
259
|
+
return 0;
|
|
260
|
+
}
|
|
261
|
+
if (first === '-h' || first === '--help' || first === 'help') {
|
|
262
|
+
io.out(USAGE);
|
|
263
|
+
return 0;
|
|
264
|
+
}
|
|
265
|
+
if (first === '--version' || first === '-V') {
|
|
266
|
+
io.out(`${version(root)}\n`);
|
|
267
|
+
return 0;
|
|
268
|
+
}
|
|
269
|
+
if (first === '--llms-txt') {
|
|
270
|
+
io.out(renderLlmsTxt());
|
|
271
|
+
return 0;
|
|
272
|
+
}
|
|
273
|
+
const topic = TOPICS_BY_NAME.get(first);
|
|
274
|
+
if (topic) {
|
|
275
|
+
io.out(await renderTopic(topic, root, rest));
|
|
276
|
+
return 0;
|
|
277
|
+
}
|
|
278
|
+
switch (first) {
|
|
279
|
+
case 'topics':
|
|
280
|
+
io.out(renderTopicList());
|
|
281
|
+
return 0;
|
|
282
|
+
case 'api':
|
|
283
|
+
return cmdApi(root, rest, io);
|
|
284
|
+
case 'examples':
|
|
285
|
+
return cmdExamples(root, rest, io);
|
|
286
|
+
case 'grep':
|
|
287
|
+
return cmdGrep(root, rest, io);
|
|
288
|
+
case 'show':
|
|
289
|
+
return cmdShow(root, rest, io);
|
|
290
|
+
case 'path':
|
|
291
|
+
return cmdPath(root, rest, io);
|
|
292
|
+
case 'init':
|
|
293
|
+
return cmdInit(rest, io);
|
|
294
|
+
}
|
|
295
|
+
if (first.startsWith('-'))
|
|
296
|
+
throw new UsageError(`Unknown option ${first}.`);
|
|
297
|
+
return unknownWord(root, first, rest, io);
|
|
298
|
+
}
|
|
299
|
+
catch (err) {
|
|
300
|
+
if (err instanceof UsageError) {
|
|
301
|
+
io.err(`${err.message}\n\n${USAGE}`);
|
|
302
|
+
return 2;
|
|
303
|
+
}
|
|
304
|
+
throw err;
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,WAAW,EACX,WAAW,EACX,OAAO,GACR,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,WAAW,EACX,SAAS,EACT,SAAS,EACT,QAAQ,EACR,MAAM,EACN,UAAU,EACV,OAAO,GACR,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACL,cAAc,EACd,WAAW,EACX,aAAa,EACb,WAAW,EACX,eAAe,EACf,OAAO,GACR,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,gCAAgC;AAChC,MAAM,CAAC,MAAM,KAAK,GAAG;;;;;;;;;;;;;;;;CAgBpB,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAUvF,MAAM,SAAS,GAAO;IACpB,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IACzC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;AAEzF,oCAAoC;AACpC,MAAM,UAAW,SAAQ,KAAK;CAAG;AAEjC,uEAAuE;AACvE,SAAS,SAAS,CAChB,IAAc,EACd,KAAe,EACf,OAAiB;IAEjB,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QACrB,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACrE,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3D,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;YACxE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1B,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9C,MAAM,IAAI,UAAU,CAAC,kBAAkB,GAAG,GAAG,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AACtD,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,IAAc,EAAE,EAAM;IAClD,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAClB,0EAA0E,CAC3E,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,EAAE,CAAC,GAAG,CAAC,2EAA2E,CAAC,CAAC;QACpF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,EAAE,CAAC,GAAG,CAAC,gBAAgB,IAAI,WAAW,IAAI,yBAAyB,IAAI,OAAO,CAAC,CAAC;QAChF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,IAAI,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAE,EAAE,IAAI,CAAC,CAAC;IAC/C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,KAAK;aACjB,KAAK,CAAC,CAAC,CAAC;aACR,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACT,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC;QAC7D,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,IAAI,IAAI,yBAAyB,MAAM,IAAI,CAAC;IAC9C,CAAC;IACD,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1B,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,IAAc,EAAE,EAAM;IACvD,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/C,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,IAAc,EAAE,EAAM;IACnD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QACvC,MAAM,IAAI,UAAU,CAAC,oDAAoD,CAAC,CAAC;IAC7E,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;IAC9F,IAAI,OAAe,CAAC;IACpB,IAAI,CAAC;QACH,OAAO,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,UAAU,CAAC,+BAAgC,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5D,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,EAAE,CAAC,GAAG,CAAC,mBAAmB,MAAM,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,GAAG,OAAO,CAAC,MAAM,6CAA6C,CAAC,CAAC;IACzF,CAAC;IACD,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,IAAc,EAAE,EAAM;IACnD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,UAAU,CAAC,4DAA4D,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACpD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAC3D,MAAM,IAAI,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,EAAE,CAAC,GAAG,CAAC,6BAA6B,IAAI,8CAA8C,CAAC,CAAC;QACxF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,EAAE,CAAC,GAAG,CACJ,IAAI,IAAI,sCAAsC,OAAO;aAClD,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;aACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,uBAAuB,CAAC,CAAC;QACvC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACzC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClB,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,qBAAqB,CAAC,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,EAAE,CAAC,GAAG,CACJ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAC1G,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,EAAE,CAAC,GAAG,CAAC,iBAAiB,GAAG,cAAc,aAAa,4BAA4B,CAAC,CAAC;YACpF,OAAO,CAAC,CAAC;QACX,CAAC;QACD,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,SAAS,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAChE,OAAO,CAAC,CAAC;IACX,CAAC;IACD,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1B,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,IAAc,EAAE,EAAM;IACnD,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;QACpB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,EAAE,CAAC,GAAG,CAAC,6BAA6B,IAAI,MAAM,CAAC,CAAC;QAChD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,EAAE,CAAC,GAAG,CACJ,GAAG,OAAO;SACP,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,CAAC;IACF,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,OAAO,CAAC,IAAc,EAAE,EAAM;IACrC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM;QACxB,MAAM,IAAI,UAAU,CAAC,6DAA6D,CAAC,CAAC;IACtF,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACf,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAC1D,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7D,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,uBAAuB,CAAC,CAAC;QAC1C,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,OAAO,CAAC,CAAC;AACX,CAAC;AAED,oEAAoE;AACpE,SAAS,WAAW,CAAC,IAAY,EAAE,IAAY,EAAE,IAAc,EAAE,EAAM;IACrE,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7C,EAAE,CAAC,GAAG,CAAC,UAAU,IAAI,6CAA6C,IAAI,UAAU,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/C,EAAE,CAAC,GAAG,CAAC,UAAU,IAAI,8CAA8C,IAAI,UAAU,CAAC,CAAC;QACnF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC,IAAI,EAAE,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;IAClF,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,EAAE,CAAC,GAAG,CACJ,8CAA8C,IAAI,KAAK,IAAI,qCAAqC,CACjG,CAAC;IACF,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,IAAc,EACd,KAAS,SAAS,EAClB,OAAe,WAAW,EAAE;IAE5B,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9B,IAAI,CAAC;QACH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YAC7D,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5C,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;YAC3B,EAAE,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACxB,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,KAAK,EAAE,CAAC;YACV,EAAE,CAAC,GAAG,CAAC,MAAM,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,QAAQ;gBACX,EAAE,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC;gBAC1B,OAAO,CAAC,CAAC;YACX,KAAK,KAAK;gBACR,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAChC,KAAK,UAAU;gBACb,OAAO,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACrC,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACjC,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACjC,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACjC,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,kBAAkB,KAAK,GAAG,CAAC,CAAC;QAC5E,OAAO,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;YAC9B,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC;YACrC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The sections of a topic that are read from the installed package, so they
|
|
3
|
+
* can't drift from it: the built-in skills and their parameters, the
|
|
4
|
+
* prefabs, the REST namespaces, the environment variables the code reads,
|
|
5
|
+
* and the commands package.json installs.
|
|
6
|
+
*
|
|
7
|
+
* The skills and REST sections import only those parts of the SDK, and only
|
|
8
|
+
* when their topic is printed.
|
|
9
|
+
*/
|
|
10
|
+
import type { ApiIndex } from './apiTypes.js';
|
|
11
|
+
/** Everything a live section may need. */
|
|
12
|
+
export interface LiveContext {
|
|
13
|
+
/** The package root. */
|
|
14
|
+
root: string;
|
|
15
|
+
/** The API index, when it's built. */
|
|
16
|
+
api: ApiIndex | null;
|
|
17
|
+
/** The words after the topic name, such as a skill name. */
|
|
18
|
+
args: string[];
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* One line for each command the package installs.
|
|
22
|
+
* tests/cli/tsdocs.test.ts checks this against package.json's `bin`.
|
|
23
|
+
*/
|
|
24
|
+
export declare const COMMAND_SUMMARIES: Readonly<Record<string, string>>;
|
|
25
|
+
/**
|
|
26
|
+
* The `SWML_` and `SIGNALWIRE_` names in the package's code, with the files
|
|
27
|
+
* that use them. This module and the topics are skipped: they mention names
|
|
28
|
+
* in prose.
|
|
29
|
+
*
|
|
30
|
+
* @param dir - The code directory.
|
|
31
|
+
* @returns Each name's files, relative to the package root.
|
|
32
|
+
*/
|
|
33
|
+
export declare function scanEnvNames(dir: string): Map<string, Set<string>>;
|
|
34
|
+
/**
|
|
35
|
+
* Render a topic's live section.
|
|
36
|
+
*
|
|
37
|
+
* @param section - Which one.
|
|
38
|
+
* @param ctx - The package root, the API index and the arguments.
|
|
39
|
+
* @returns Markdown.
|
|
40
|
+
*/
|
|
41
|
+
export declare function renderLive(section: string, ctx: LiveContext): Promise<string>;
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The sections of a topic that are read from the installed package, so they
|
|
3
|
+
* can't drift from it: the built-in skills and their parameters, the
|
|
4
|
+
* prefabs, the REST namespaces, the environment variables the code reads,
|
|
5
|
+
* and the commands package.json installs.
|
|
6
|
+
*
|
|
7
|
+
* The skills and REST sections import only those parts of the SDK, and only
|
|
8
|
+
* when their topic is printed.
|
|
9
|
+
*/
|
|
10
|
+
import { readFileSync } from 'node:fs';
|
|
11
|
+
import { relative } from 'node:path';
|
|
12
|
+
import { codeFiles } from './files.js';
|
|
13
|
+
import { codeDir, readPackageJson } from './locate.js';
|
|
14
|
+
/**
|
|
15
|
+
* One line for each command the package installs.
|
|
16
|
+
* tests/cli/tsdocs.test.ts checks this against package.json's `bin`.
|
|
17
|
+
*/
|
|
18
|
+
export const COMMAND_SUMMARIES = {
|
|
19
|
+
'sw-tsdocs': 'This documentation: topics, API lookups, examples and docs search',
|
|
20
|
+
'swaig-test': "Test an agent's tools and SWML locally, and simulate serverless platforms",
|
|
21
|
+
};
|
|
22
|
+
async function builtinSkills() {
|
|
23
|
+
const { SkillRegistry } = await import('../../skills/SkillRegistry.js');
|
|
24
|
+
const { registerBuiltinSkills } = await import('../../skills/builtin/index.js');
|
|
25
|
+
registerBuiltinSkills();
|
|
26
|
+
const registry = SkillRegistry.getInstance();
|
|
27
|
+
return registry
|
|
28
|
+
.listRegistered()
|
|
29
|
+
.map((name) => registry.getSkillClass(name))
|
|
30
|
+
.filter((c) => c !== undefined)
|
|
31
|
+
.sort((a, b) => a.SKILL_NAME.localeCompare(b.SKILL_NAME));
|
|
32
|
+
}
|
|
33
|
+
const sentence = (text) => (/[.!?]$/.test(text) ? text : `${text}.`);
|
|
34
|
+
async function renderSkills(ctx) {
|
|
35
|
+
const skills = await builtinSkills();
|
|
36
|
+
const wanted = ctx.args[0];
|
|
37
|
+
if (wanted) {
|
|
38
|
+
const skill = skills.find((s) => s.SKILL_NAME === wanted);
|
|
39
|
+
if (!skill) {
|
|
40
|
+
const names = skills.map((s) => `\`${s.SKILL_NAME}\``).join(', ');
|
|
41
|
+
return `## Skill \`${wanted}\`\n\nNo built-in skill has that name. The built-in skills: ${names}.\n`;
|
|
42
|
+
}
|
|
43
|
+
const out = [`## Skill \`${wanted}\``, '', sentence(skill.SKILL_DESCRIPTION), ''];
|
|
44
|
+
const entry = ctx.api?.entries[skill.name];
|
|
45
|
+
if (entry) {
|
|
46
|
+
out.push(`Class: \`${skill.name}\`, ${ctx.root}/${entry.file}:${entry.line}`, '');
|
|
47
|
+
}
|
|
48
|
+
out.push(`Parameters, for \`addSkillByName('${wanted}', {...})\` or \`new ${skill.name}({...})\`:`, '');
|
|
49
|
+
const schema = skill.getParameterSchema();
|
|
50
|
+
for (const param of Object.keys(schema).sort()) {
|
|
51
|
+
const spec = schema[param];
|
|
52
|
+
const details = [spec.type ?? 'any'];
|
|
53
|
+
if (spec.required)
|
|
54
|
+
details.push('required');
|
|
55
|
+
else if (spec.default !== undefined)
|
|
56
|
+
details.push(`default ${JSON.stringify(spec.default)}`);
|
|
57
|
+
out.push(`- \`${param}\` (${details.join(', ')}): ${spec.description ?? ''}`.trimEnd());
|
|
58
|
+
}
|
|
59
|
+
return `${out.join('\n')}\n`;
|
|
60
|
+
}
|
|
61
|
+
const out = [`## Built-in skills (${skills.length})`, ''];
|
|
62
|
+
for (const skill of skills) {
|
|
63
|
+
const needs = [...skill.REQUIRED_ENV_VARS, ...skill.REQUIRED_PACKAGES];
|
|
64
|
+
const extra = needs.length ? ` Needs: ${needs.join(', ')}.` : '';
|
|
65
|
+
const many = skill.SUPPORTS_MULTIPLE_INSTANCES ? ' Allows several instances.' : '';
|
|
66
|
+
out.push(`- \`${skill.SKILL_NAME}\` (\`${skill.name}\`): ${sentence(skill.SKILL_DESCRIPTION)}${extra}${many}`);
|
|
67
|
+
}
|
|
68
|
+
return `${out.join('\n')}\n`;
|
|
69
|
+
}
|
|
70
|
+
function renderPrefabs(ctx) {
|
|
71
|
+
if (!ctx.api)
|
|
72
|
+
return "The API index isn't built, so the prefabs can't be listed. Run `npm run build`.\n";
|
|
73
|
+
const out = ['## Prefabs', ''];
|
|
74
|
+
const prefabs = ctx.api.exports
|
|
75
|
+
.map((key) => ctx.api.entries[key])
|
|
76
|
+
.filter((e) => e.kind === 'class' && /(^|\/)prefabs\//.test(e.file));
|
|
77
|
+
for (const entry of prefabs) {
|
|
78
|
+
const ctor = entry.members?.find((m) => m.kind === 'constructor');
|
|
79
|
+
const doc = (entry.doc.split(/\n\s*\n/)[0] ?? '').replace(/\s*\n\s*/g, ' ');
|
|
80
|
+
out.push(`### ${entry.name}`, '', doc, '');
|
|
81
|
+
out.push('```ts', ...entry.signature, ...(ctor?.signature ?? []), '```', '');
|
|
82
|
+
out.push(`Source: ${ctx.root}/${entry.file}:${entry.line}`, '');
|
|
83
|
+
}
|
|
84
|
+
return `${out.join('\n').trimEnd()}\n`;
|
|
85
|
+
}
|
|
86
|
+
function publicMembers(obj) {
|
|
87
|
+
const names = new Set();
|
|
88
|
+
for (let proto = obj; proto && proto !== Object.prototype; proto = Object.getPrototypeOf(proto)) {
|
|
89
|
+
for (const name of Object.getOwnPropertyNames(proto)) {
|
|
90
|
+
if (name !== 'constructor' && !name.startsWith('_'))
|
|
91
|
+
names.add(name);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
return [...names].sort();
|
|
95
|
+
}
|
|
96
|
+
async function renderRest() {
|
|
97
|
+
const { RestClient } = await import('../../rest/index.js');
|
|
98
|
+
// Placeholder credentials: listing the namespaces sends no request
|
|
99
|
+
const client = new RestClient({ project: '-', token: '-', host: 'example.signalwire.com' });
|
|
100
|
+
const out = ['## Namespaces', ''];
|
|
101
|
+
const record = client;
|
|
102
|
+
for (const name of Object.keys(client)
|
|
103
|
+
.filter((n) => !n.startsWith('_'))
|
|
104
|
+
.sort()) {
|
|
105
|
+
const value = record[name];
|
|
106
|
+
if (typeof value !== 'object' || value === null)
|
|
107
|
+
continue;
|
|
108
|
+
out.push(`- \`client.${name}\`: ${publicMembers(value).join(', ')}`);
|
|
109
|
+
}
|
|
110
|
+
return `${out.join('\n')}\n`;
|
|
111
|
+
}
|
|
112
|
+
// A name in quotes, or read as process.env.NAME
|
|
113
|
+
const ENV_NAME = /["']((?:SWML|SIGNALWIRE)_[A-Z0-9_]+)["']|process\.env\.((?:SWML|SIGNALWIRE)_[A-Z0-9_]+)/g;
|
|
114
|
+
/**
|
|
115
|
+
* The `SWML_` and `SIGNALWIRE_` names in the package's code, with the files
|
|
116
|
+
* that use them. This module and the topics are skipped: they mention names
|
|
117
|
+
* in prose.
|
|
118
|
+
*
|
|
119
|
+
* @param dir - The code directory.
|
|
120
|
+
* @returns Each name's files, relative to the package root.
|
|
121
|
+
*/
|
|
122
|
+
export function scanEnvNames(dir) {
|
|
123
|
+
const found = new Map();
|
|
124
|
+
for (const [rel, path] of codeFiles(dir, false)) {
|
|
125
|
+
if (/(^|\/)cli\/tsdocs\//.test(rel))
|
|
126
|
+
continue;
|
|
127
|
+
let text;
|
|
128
|
+
try {
|
|
129
|
+
text = readFileSync(path, 'utf-8');
|
|
130
|
+
}
|
|
131
|
+
catch {
|
|
132
|
+
continue;
|
|
133
|
+
}
|
|
134
|
+
for (const match of text.matchAll(ENV_NAME)) {
|
|
135
|
+
const name = match[1] ?? match[2];
|
|
136
|
+
if (!found.has(name))
|
|
137
|
+
found.set(name, new Set());
|
|
138
|
+
found.get(name).add(rel);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
return found;
|
|
142
|
+
}
|
|
143
|
+
function renderEnv(ctx) {
|
|
144
|
+
const dir = codeDir(ctx.root);
|
|
145
|
+
const found = scanEnvNames(dir);
|
|
146
|
+
const names = [...found.keys()].sort();
|
|
147
|
+
const out = [
|
|
148
|
+
`## SWML_ and SIGNALWIRE_ variables in the installed code (${names.length})`,
|
|
149
|
+
'',
|
|
150
|
+
`Found by searching the package's code (${relative(ctx.root, dir)}/) for those prefixes, with the ` +
|
|
151
|
+
'files that use them; those files say what each one does. The web server also reads `PORT`, ' +
|
|
152
|
+
"serverless detection reads each platform's own variables, and some skills read their own " +
|
|
153
|
+
'API keys.',
|
|
154
|
+
'',
|
|
155
|
+
];
|
|
156
|
+
for (const name of names) {
|
|
157
|
+
const files = [...found.get(name)].sort();
|
|
158
|
+
const shown = files.slice(0, 3).join(', ') + (files.length > 3 ? ` and ${files.length - 3} more` : '');
|
|
159
|
+
out.push(`- \`${name}\`: ${shown}`);
|
|
160
|
+
}
|
|
161
|
+
return `${out.join('\n')}\n`;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* The commands package.json installs.
|
|
165
|
+
*
|
|
166
|
+
* @param root - The package root.
|
|
167
|
+
* @returns Their names, sorted.
|
|
168
|
+
*/
|
|
169
|
+
function installedCommands(root) {
|
|
170
|
+
return Object.keys(readPackageJson(root).bin ?? {}).sort();
|
|
171
|
+
}
|
|
172
|
+
function renderCli(ctx) {
|
|
173
|
+
const out = ['## Commands', ''];
|
|
174
|
+
for (const name of installedCommands(ctx.root)) {
|
|
175
|
+
out.push(`- \`${name}\`: ${COMMAND_SUMMARIES[name] ?? 'run it with --help'}`);
|
|
176
|
+
}
|
|
177
|
+
return `${out.join('\n')}\n`;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Render a topic's live section.
|
|
181
|
+
*
|
|
182
|
+
* @param section - Which one.
|
|
183
|
+
* @param ctx - The package root, the API index and the arguments.
|
|
184
|
+
* @returns Markdown.
|
|
185
|
+
*/
|
|
186
|
+
export async function renderLive(section, ctx) {
|
|
187
|
+
switch (section) {
|
|
188
|
+
case 'skills':
|
|
189
|
+
return renderSkills(ctx);
|
|
190
|
+
case 'prefabs':
|
|
191
|
+
return renderPrefabs(ctx);
|
|
192
|
+
case 'rest':
|
|
193
|
+
return renderRest();
|
|
194
|
+
case 'env':
|
|
195
|
+
return renderEnv(ctx);
|
|
196
|
+
case 'cli':
|
|
197
|
+
return renderCli(ctx);
|
|
198
|
+
default:
|
|
199
|
+
return '';
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
//# sourceMappingURL=live.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"live.js","sourceRoot":"","sources":["../../../src/cli/tsdocs/live.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAYvD;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAqC;IACjE,WAAW,EAAE,mEAAmE;IAChF,YAAY,EAAE,2EAA2E;CAC1F,CAAC;AAeF,KAAK,UAAU,aAAa;IAC1B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAAC;IACxE,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAAC;IAChF,qBAAqB,EAAE,CAAC;IACxB,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;IAC7C,OAAO,QAAQ;SACZ,cAAc,EAAE;SAChB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAA0C,CAAC;SACpF,MAAM,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;SACnD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AAErF,KAAK,UAAU,YAAY,CAAC,GAAgB;IAC1C,MAAM,MAAM,GAAG,MAAM,aAAa,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClE,OAAO,cAAc,MAAM,+DAA+D,KAAK,KAAK,CAAC;QACvG,CAAC;QACD,MAAM,GAAG,GAAG,CAAC,cAAc,MAAM,IAAI,EAAE,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC;QAClF,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,KAAK,EAAE,CAAC;YACV,GAAG,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QACpF,CAAC;QACD,GAAG,CAAC,IAAI,CACN,qCAAqC,MAAM,wBAAwB,KAAK,CAAC,IAAI,YAAY,EACzF,EAAE,CACH,CAAC;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC;YACrC,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBACvC,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;gBAAE,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC7F,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC/B,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,uBAAuB,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;IAC1D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,iBAAiB,EAAE,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACvE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,GAAG,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,GAAG,CAAC,IAAI,CACN,OAAO,KAAK,CAAC,UAAU,SAAS,KAAK,CAAC,IAAI,QAAQ,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,KAAK,GAAG,IAAI,EAAE,CACrG,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED,SAAS,aAAa,CAAC,GAAgB;IACrC,IAAI,CAAC,GAAG,CAAC,GAAG;QACV,OAAO,mFAAmF,CAAC;IAC7F,MAAM,GAAG,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO;SAC5B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAI,CAAC,OAAO,CAAC,GAAG,CAAE,CAAC;SACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QAClE,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAC5E,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3C,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7E,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KACE,IAAI,KAAK,GAAkB,GAAG,EAC9B,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,EACnC,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EACpC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,IAAI,KAAK,aAAa,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,UAAU;IACvB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC3D,mEAAmE;IACnE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAC;IAC5F,MAAM,GAAG,GAAG,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,MAA4C,CAAC;IAC5D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACnC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACjC,IAAI,EAAE,EAAE,CAAC;QACV,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QAC1D,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED,gDAAgD;AAChD,MAAM,QAAQ,GACZ,0FAA0F,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAChD,IAAI,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,SAAS;QAC9C,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC;YACnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YACjD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,GAAgB;IACjC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC,MAAM,GAAG,GAAG;QACV,6DAA6D,KAAK,CAAC,MAAM,GAAG;QAC5E,EAAE;QACF,0CAA0C,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,kCAAkC;YACjG,6FAA6F;YAC7F,2FAA2F;YAC3F,WAAW;QACb,EAAE;KACH,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,KAAK,GACT,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,IAAY;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC7D,CAAC;AAED,SAAS,SAAS,CAAC,GAAgB;IACjC,MAAM,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAe,EAAE,GAAgB;IAChE,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;QAC3B,KAAK,SAAS;YACZ,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC;QAC5B,KAAK,MAAM;YACT,OAAO,UAAU,EAAE,CAAC;QACtB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;QACxB,KAAK,KAAK;YACR,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;QACxB;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,51 @@
|
|
|
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
|
+
/** The package's name on npm. */
|
|
11
|
+
export declare const PACKAGE_NAME = "@signalwire/sdk";
|
|
12
|
+
/** The fields of package.json that sw-tsdocs reads. */
|
|
13
|
+
export interface PackageJson {
|
|
14
|
+
/** The package's name. */
|
|
15
|
+
name: string;
|
|
16
|
+
/** The installed version. */
|
|
17
|
+
version: string;
|
|
18
|
+
/** The commands the package installs, by name. */
|
|
19
|
+
bin?: Record<string, string>;
|
|
20
|
+
/** What `npm pack` ships. */
|
|
21
|
+
files?: string[];
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* The package root: the nearest directory above `from` whose package.json
|
|
25
|
+
* names this package.
|
|
26
|
+
*
|
|
27
|
+
* @param from - Where to start looking; this module's directory by default.
|
|
28
|
+
* @returns The root, or null if no such directory exists.
|
|
29
|
+
*/
|
|
30
|
+
export declare function findPackageRoot(from?: string): string | null;
|
|
31
|
+
/**
|
|
32
|
+
* The package root, or an error saying the package can't be found.
|
|
33
|
+
*
|
|
34
|
+
* @returns The package root.
|
|
35
|
+
*/
|
|
36
|
+
export declare function packageRoot(): string;
|
|
37
|
+
/**
|
|
38
|
+
* The package's package.json.
|
|
39
|
+
*
|
|
40
|
+
* @param root - The package root.
|
|
41
|
+
* @returns Its parsed contents.
|
|
42
|
+
*/
|
|
43
|
+
export declare function readPackageJson(root: string): PackageJson;
|
|
44
|
+
/**
|
|
45
|
+
* The directory holding the code sw-tsdocs runs from: `dist` in an installed
|
|
46
|
+
* package or a build, `src` when run from a clone with tsx.
|
|
47
|
+
*
|
|
48
|
+
* @param root - The package root.
|
|
49
|
+
* @returns The code directory's absolute path.
|
|
50
|
+
*/
|
|
51
|
+
export declare function codeDir(root: string): string;
|