Documentation
¶
Overview ¶
Package edition provides an extension-point mechanism that allows private overlay modules (e.g. an internal distribution) to customise CLI behaviour without modifying the open-source core. The open-source build uses the zero-value defaults; an overlay calls Override before Execute.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ContentBlock ¶
ContentBlock is a single content item in a ToolResult.
type Hooks ¶
type Hooks struct {
// --- identity ---
Name string // "open" (default) / overlay identifier
ScenarioCode string // injected into x-dingtalk-scenario-code header
// --- runtime mode ---
IsEmbedded bool // true when running inside a host application
HideAuthLogin bool // true suppresses the "dws auth login" command
AutoPurgeToken bool // true deletes local token data on expiry
// --- paths ---
ConfigDir func() string // custom config directory; nil → ~/.dws
// --- HTTP headers ---
MergeHeaders func(base map[string]string) map[string]string
// --- auth ---
AuthClientID string // OAuth client ID for device-flow authorisation
AuthClientFromMCP bool // true → fetch client ID from MCP at runtime
OnAuthError func(configDir string, err error) error
TokenProvider func(ctx context.Context, fallback func() (string, error)) (string, error)
// --- token persistence (overlay-managed keychain / encrypted storage) ---
SaveToken func(configDir string, data []byte) error // persist token blob
LoadToken func(configDir string) ([]byte, error) // retrieve token blob
DeleteToken func(configDir string) error // remove persisted token
// --- product & endpoint ---
StaticServers func() []ServerInfo // non-nil → skip Market discovery
VisibleProducts func() []string // non-nil → override help visibility
RegisterExtraCommands func(root *cobra.Command, caller ToolCaller) // register overlay-only commands
// DiscoveryURL overrides the Market API endpoint for server list.
// Non-empty → loadDynamicCommands uses FetchServersFromURL(DiscoveryURL)
// instead of the default Market base URL. Provides edition-level isolation.
DiscoveryURL string
// DiscoveryHeaders returns HTTP headers injected into discovery requests.
// Used to authenticate edition-specific endpoints.
DiscoveryHeaders func() map[string]string
// SupplementServers returns edition-specific MCP servers NOT registered
// in any Market registry. Always merged into the endpoint map alongside
// Market/cache results, regardless of discovery success or failure.
SupplementServers func() []ServerInfo
// FallbackServers returns the full server list as a safety net when
// Market discovery + cache both fail. Results are NOT cached so the
// next startup still attempts live discovery.
FallbackServers func() []ServerInfo
// AfterPersistentPreRun runs at the end of the root PersistentPreRunE after
// global setup (OAuth flag overrides, log level, output sink). Overlays use
// this for clients that bypass the MCP runner (e.g. A2A gateway).
AfterPersistentPreRun func(cmd *cobra.Command, args []string) error
// ClassifyToolResult is called before the framework's default business-error
// detection on MCP tool results. If it returns a non-nil error, that error
// is used instead of the generic CategoryAPI business error. Editions use
// this to return custom error types with specific exit codes (e.g. PAT
// authorization errors with exit code 4).
ClassifyToolResult func(content map[string]any) error
// RuntimeDefaults returns resolvers for runtimeDefault placeholders (e.g.
// "$currentUserId" → fn). Placeholders not in the map fall through to a
// "not registered" warning. Open-source core returns an empty map;
// overlays populate the whitelist ($currentUserId / $unionId / $corpId /
// $now / $today). See schema v3 §2.3.
RuntimeDefaults func() map[string]RuntimeDefaultFn
}
Hooks groups all edition-specific behavioural overrides. Zero values fall back to open-source defaults so the struct is safe to use as-is.
type RuntimeDefaultFn ¶ added in v1.0.16
RuntimeDefaultFn resolves a single runtimeDefault placeholder (e.g. "$currentUserId") to a concrete string value. Called lazily at RunE time. Returning (_, false) is equivalent to "not registered" and falls through to the next-lower default source.
type ServerInfo ¶
ServerInfo describes a static MCP server endpoint.
type ToolCaller ¶
type ToolCaller interface {
// CallTool invokes an MCP tool by product ID and tool name.
CallTool(ctx context.Context, productID, toolName string, args map[string]any) (*ToolResult, error)
// Format returns the current output format ("json", "table", "raw").
Format() string
// DryRun returns true when --dry-run is active.
DryRun() bool
}
ToolCaller abstracts MCP tool invocation so private overlays can call MCP tools without importing internal packages. The open-source core provides a concrete adapter wrapping executor.Runner.
type ToolResult ¶
type ToolResult struct {
Content []ContentBlock
}
ToolResult holds the response from an MCP tool call.