generators

Documentation

Index

• Constants
• type APISpec
• type Dependency
• type GeneratedClient
• type GeneratorConfig
• type LanguageGenerator

Constants

const (
	FeatureREST              = "rest"
	FeatureWebSocket         = "websocket"
	FeatureSSE               = "sse"
	FeatureWebTransport      = "webtransport"
	FeatureAuth              = "auth"
	FeatureReconnection      = "reconnection"
	FeatureHeartbeat         = "heartbeat"
	FeatureStateManagement   = "state-management"
	FeatureTypedErrors       = "typed-errors"
	FeatureRequestRetry      = "request-retry"
	FeatureTimeout           = "timeout"
	FeatureMiddleware        = "middleware"
	FeatureLogging           = "logging"
	FeaturePolymorphicTypes  = "polymorphic-types"
	FeatureFileUpload        = "file-upload"
	FeatureStreamingResponse = "streaming-response"
)

Feature constants for common features

Types

type APISpec

type APISpec interface{}

APISpec is a forward declaration to avoid import cycle The actual type is defined in the client package

type Dependency

type Dependency struct {
	Name    string
	Version string
	Type    string // "direct", "dev", "peer"
}

Dependency represents a required dependency

type GeneratedClient

type GeneratedClient struct {
	// Files maps filename to file contents
	Files map[string]string

	// Instructions provides setup/usage instructions for the client
	Instructions string

	// Dependencies lists required dependencies
	Dependencies []Dependency

	// Language is the target language
	Language string

	// Version is the generated client version
	Version string
}

GeneratedClient represents the generated client code

type GeneratorConfig

type GeneratorConfig interface{}

GeneratorConfig is a forward declaration to avoid import cycle The actual type is defined in the client package

type LanguageGenerator

type LanguageGenerator interface {
	// Name returns the generator name (e.g., "go", "typescript")
	Name() string

	// SupportedFeatures returns a list of features this generator supports
	SupportedFeatures() []string

	// Generate produces client code from the API specification
	Generate(ctx context.Context, spec APISpec, config GeneratorConfig) (*GeneratedClient, error)

	// Validate checks if the spec can be generated for this language
	Validate(spec APISpec) error
}

LanguageGenerator defines the interface for language-specific client generators