appgen

Documentation

Overview

Package appgen emits a generated Go app that embeds build output.

Index

• func BuildBinary(appDir, binaryPath string) (string, error)
• func BuildWASM(appDir, wasmPath string) (string, error)
• type APIEndpoint
• type ActionEndpoint
• type ActionFragment
• type ActionValidationRule
• type BackendAdapterIR
  • func (ir BackendAdapterIR) HasRegistrations() bool
• type BackendContractExposure
• type BackendDecoder
• type BackendEndpointKind
• type BackendEndpointRegistration
• type BackendFallback
• type BackendHandlerCall
• type BackendResponse
• type FragmentEndpoint
• type Options
• type Result
  • func Generate(outputDir, appDir string) (Result, error)
  • func GenerateBackendWithOptions(appDir string, options Options) (Result, error)
  • func GenerateWithOptions(outputDir, appDir string, options Options) (Result, error)
• type SSRLoadReplacement
• type SSRReplacement
• type SSRRoute

Functions

func BuildBinary

func BuildBinary(appDir, binaryPath string) (string, error)

BuildBinary compiles the generated app into binaryPath.

func BuildWASM

func BuildWASM(appDir, wasmPath string) (string, error)

BuildWASM compiles the generated app into a Go js/wasm artifact.

Types

type APIEndpoint

type APIEndpoint struct {
	PageID       string
	APIName      string
	Method       string
	Route        string
	Guards       []string
	ErrorPage    string
	Binding      source.BackendBinding
	BackendAlias string
}

APIEndpoint describes a generated API handler.

type ActionEndpoint

type ActionEndpoint struct {
	PageID           string
	ActionName       string
	Method           string
	Route            string
	Guards           []string
	InputName        string
	InputType        string
	InputFields      []string
	RequiredFields   []string
	RequiredMessages map[string]string
	ValidationRules  []ActionValidationRule
	ValidatesInput   bool
	Redirect         string
	Fragments        []ActionFragment
	ErrorPage        string
	Binding          source.BackendBinding
	BackendAlias     string
}

ActionEndpoint describes a generated action handler.

type ActionFragment

type ActionFragment struct {
	Target string
	HTML   string
}

ActionFragment describes a generated partial response fragment.

type ActionValidationRule

type ActionValidationRule struct {
	Field            string
	MinLength        int
	MinLengthMessage string
	MaxLength        int
	MaxLengthMessage string
	Pattern          string
	PatternMessage   string
}

ActionValidationRule describes one generated server-side form constraint.

type BackendAdapterIR

type BackendAdapterIR struct {
	Registrations     []BackendEndpointRegistration
	ContractExposures []BackendContractExposure
	Decoders          []BackendDecoder
	Calls             []BackendHandlerCall
	Responses         []BackendResponse
	Fallbacks         []BackendFallback
}

func (BackendAdapterIR) HasRegistrations

func (ir BackendAdapterIR) HasRegistrations() bool

type BackendContractExposure

type BackendContractExposure struct {
	Endpoint    BackendEndpointRegistration
	Contract    string
	ImportAlias string
	ImportPath  string
	Type        string
	Result      string
	Roles       []string
	Guards      []string
	InputFields []source.BackendInputField
	Status      gwdkir.ContractBindingStatus
	Handler     string
	Register    string
	Message     string
	OwnerKind   gwdkir.SourceKind
	OwnerID     string
	Package     string
	Source      string
}

type BackendDecoder

type BackendDecoder struct {
	Endpoint BackendEndpointRegistration
	Function string
	Input    string
	Fields   []string
}

type BackendEndpointKind

type BackendEndpointKind string

const (
	BackendEndpointAction   BackendEndpointKind = "action"
	BackendEndpointAPI      BackendEndpointKind = "api"
	BackendEndpointFragment BackendEndpointKind = "fragment"
	BackendEndpointCommand  BackendEndpointKind = "command"
	BackendEndpointQuery    BackendEndpointKind = "query"
)

type BackendEndpointRegistration

type BackendEndpointRegistration struct {
	Kind    BackendEndpointKind
	Method  string
	Path    string
	Handler string
	PageID  string
	Name    string
}

type BackendFallback

type BackendFallback struct {
	Endpoint BackendEndpointRegistration
	Status   source.BackendBindingStatus
	Message  string
}

type BackendHandlerCall

type BackendHandlerCall struct {
	Endpoint  BackendEndpointRegistration
	Alias     string
	Function  string
	Signature source.BackendSignatureKind
	InputType string
}

type BackendResponse

type BackendResponse struct {
	Endpoint BackendEndpointRegistration
	NoStore  bool
	Partial  bool
	Redirect string
}

type FragmentEndpoint

type FragmentEndpoint struct {
	PageID       string
	FragmentName string
	Method       string
	Route        string
	Target       string
	HTML         string
	Package      string
	Uses         map[string]string
	Guards       []string
	Binding      source.BackendBinding
	BackendAlias string
}

FragmentEndpoint describes a generated server fragment handler.

type Options

type Options struct {
	Actions      []ActionEndpoint
	APIs         []APIEndpoint
	Fragments    []FragmentEndpoint
	SSR          []SSRRoute
	AutoRoutes   bool
	ProxyBackend bool
	Config       gowdk.Config
	IR           *gwdkir.Program
}

Options configures generated app output.

type Result

type Result struct {
	AppDir      string
	MainPath    string
	PackagePath string
	ModulePath  string
	OutputDir   string
	Files       []string
	BinaryPath  string
}

Result describes generated app artifacts.

func Generate

func Generate(outputDir, appDir string) (Result, error)

Generate writes a self-contained Go app that embeds outputDir.

func GenerateBackendWithOptions

func GenerateBackendWithOptions(appDir string, options Options) (Result, error)

GenerateBackendWithOptions writes a generated Go app that serves only request-time backend routes for feature-bound actions and APIs.

func GenerateWithOptions

func GenerateWithOptions(outputDir, appDir string, options Options) (Result, error)

GenerateWithOptions writes a self-contained Go app that embeds outputDir.

type SSRLoadReplacement

type SSRLoadReplacement struct {
	Path        string
	Placeholder string
}

SSRLoadReplacement maps a generated placeholder back to a request-time load field path.

type SSRReplacement

type SSRReplacement struct {
	Param       string
	Placeholder string
}

SSRReplacement maps a generated placeholder back to a request route param.

type SSRRoute

type SSRRoute struct {
	PageID           string
	Route            string
	Render           gowdk.RenderMode
	Cache            string
	ErrorPage        string
	DynamicParams    []string
	RouteParams      []source.RouteParam
	Guards           []string
	HasLoad          bool
	LoadBinding      source.BackendBinding
	LoadBackendAlias string
	HTML             string
	Replacements     []SSRReplacement
	LoadReplacements []SSRLoadReplacement
}

SSRRoute describes a generated request-time page handler.