runtime

package

Go to main page

Versions in this module

v0

v0.5.4

Jul 8, 2026

v0.5.3

Jul 8, 2026

Changes in this version

type Service

+ func NewFromYAML(content []byte) (*Service, error)

type ServiceConfig

+ func ParseConfig(content []byte) (*ServiceConfig, error)

v0.5.2

Jul 8, 2026

v0.5.1

Jul 8, 2026

Changes in this version

type TursoConf

+ func (t *TursoConf) Validate() error

v0.5.0

Jul 8, 2026

Changes in this version

+ const TargetAuto

+ const TargetBare

+ const TargetDocker

+ const TargetKube

+ const TargetVercel

+ func CheckVercelWarnings(cfg *ServiceConfig)

+ func ValidateProjectStructure(yamlPath string, target string) error

+ type DeployConfig struct

+ Target string

type ServiceConfig

+ Deploy *DeployConfig

v0.4.3

Jul 7, 2026

v0.4.2

Jul 7, 2026

Changes in this version

type DBConfig

+ Turso *TursoConf

+ type TursoConf struct

+ BusyTimeout int

+ Mode string

v0.4.1

Jul 7, 2026

Changes in this version

+ type RestCtx struct

+ func (c *RestCtx) Bind(v any) error

+ func (c *RestCtx) Body() []byte

+ func (c *RestCtx) Context() context.Context

+ func (c *RestCtx) Get(key string) string

+ func (c *RestCtx) JSON(data any) error

+ func (c *RestCtx) Locals(key any, values ...any) any

+ func (c *RestCtx) Method() string

+ func (c *RestCtx) Params(key string) string

+ func (c *RestCtx) Path() string

+ func (c *RestCtx) Query(key string, defaultValue ...string) string

+ func (c *RestCtx) ResponseBody() string

+ func (c *RestCtx) SendStatus(code int) error

+ func (c *RestCtx) SendString(s string) error

+ func (c *RestCtx) Set(key, val string)

+ func (c *RestCtx) Status(code int) *RestCtx

+ func (c *RestCtx) StatusCode() int

v0.4.0

Jul 7, 2026

Changes in this version

+ func CachedCRUD[T any](svc *Service, name, poolName, tableName string, redisConf redis.RedisConf, ...)

+ func MongoMustRegister(svc *Service, name, poolName, database, collection, lookupField string)

+ func MustRegister[T any](svc *Service, name, poolName, tableName string, hooks EntryHooks[T])

+ func MySQLCachedCRUD[T any](svc *Service, name, poolName, tableName string, redisConf redis.RedisConf, ...)

+ func MySQLMustRegister[T any](svc *Service, name, poolName, tableName string, hooks EntryHooks[T])

+ func TursoMustRegister[T any](svc *Service, name, poolName, tableName string, hooks EntryHooks[T])

type CRUDProvider

+ func NewMongoCRUDProvider(model *mon.Model, lookupField string) CRUDProvider

type DBConfig

+ Database string

v0.3.3

Jul 5, 2026

v0.3.2

Jul 5, 2026

v0.3.1

Jul 5, 2026

Changes in this version

+ type CRUDFactory func() CRUDProvider

type Service

+ func (s *Service) WithCRUDFactory(model string, factory CRUDFactory) *Service

v0.3.0

Jul 4, 2026

Changes in this version

type AuthConfig

+ Driver string

+ Enabled bool

+ KetoURL string

+ KratosURL string

+ OpenFGAStore string

+ OpenFGAURL string

+ ZitadelURL string

type EntryDef

+ Permissions []string

+ Roles []string

type Service

+ func (s *Service) WithAuthValidator(fn func(context.Context, *middleware.AuthContext, []string) error) *Service

v0.2.0

Jul 2, 2026

Changes in this version

type AuthConfig

+ Algorithm string

+ Audience string

+ Expiry int

+ Issuer string

+ type ContentSecurityDef struct

+ Enabled bool

+ PublicKey string

+ Strict bool

+ type CryptionDef struct

+ Enabled bool

+ Key string

+ type SecurityDef struct

+ ContentSecurity *ContentSecurityDef

+ Cryption *CryptionDef

type ServerConf

+ Security *SecurityDef

v0.1.3

Jul 1, 2026

v0.1.2

Jul 1, 2026

v0.1.1

Jun 28, 2026

Changes in this version

+ func AppGetMySQL[T any](a *App, name string, tableName string) (*db.MySQLTable[T], error)

+ func AppGetPool[T any](a *App, name string, tableName string) (*db.Table[T], error)

+ func AppGetTurso[T any](a *App, name string, tableName string) (*db.TursoTable[T], error)

+ type App struct

+ DB map[string]any

+ NATS map[string]*events.Conn

+ func NewApp(configPath string) (*App, error)

+ func (a *App) AddDB(ctx context.Context, name, driver, url string) error

+ func (a *App) Run() error

+ func (a *App) WithCustomRoutes(fn func(app *fiber.App)) *App

+ type AuthConfig struct

+ ContextKey string

+ PrevSecret string

+ Secret string

+ TokenLookup string

+ type ConsumerDef struct

+ AckWait string

+ BackOff []string

+ DeliverPolicy string

+ Durable string

+ Handler string

+ MaxDeliver int

+ NakDelay string

+ PullBatch int

+ PullMaxWait string

+ QueueGroup string

+ Stream string

+ Subject string

+ type ContentSecurityConf struct

+ Enabled bool

+ PublicKey string

+ Strict bool

+ type CryptionConf struct

+ Enabled bool

+ Key string

type DBConfig

+ Resource string

+ Table string

+ func (d DBConfig) DriverDefaults()

+ type EndpointConf struct

+ List ListConfig

+ type FilterDef struct

+ Column string

+ Type string

+ type GatewayConf struct

+ Enabled bool

+ Port int

+ Upstreams []UpstreamDef

+ type Hooks interface

+ AfterCreate func(ctx context.Context, entity *T) error

+ AfterDelete func(ctx context.Context, id any) error

+ AfterUpdate func(ctx context.Context, entity *T) error

+ BeforeCreate func(ctx context.Context, req T) (T, error)

+ BeforeDelete func(ctx context.Context, id any) error

+ BeforeUpdate func(ctx context.Context, id any, patch map[string]any) (map[string]any, error)

+ type ListConfig struct

+ Filterable []FilterDef

+ MaxPage int

+ PageSize int

+ Sortable []string

+ func (l ListConfig) EffectivePageSize(size int) int

+ func (l ListConfig) IsFilterable(col string) bool

+ func (l ListConfig) IsSortable(col string) bool

+ type NATSConfig struct

+ Consumers []ConsumerDef

+ MaxReconnects int

+ Name string

+ Producers []ProducerDef

+ ReconnectWait string

+ RetryOnFail bool

+ Streams []StreamDef

+ Timeout string

+ URL string

+ type PoolConfig struct

+ HealthCheckPeriod string

+ MaxConnIdleTime string

+ MaxConnLifetime string

+ MaxConns int32

+ MinConns int32

+ ReservedConns int32

+ type ProducerDef struct

+ After []string

+ Stream string

+ Subject string

+ type RealtimeConfig struct

+ SSE []SSEDef

+ WebSocket []WebSocketDef

+ type RedisConfig struct

+ Addr string

+ DB int

+ Name string

+ Pass string

+ PoolSize int

+ TLS bool

+ TLSSkipVerify bool

+ type RouteConf struct

+ Middleware []string

+ Path string

+ type RouteMap struct

+ Method string

+ Path string

+ type SSEDef struct

+ Auth bool

+ Handler string

+ Path string

+ type SecurityConf struct

+ ContentSecurity *ContentSecurityConf

+ Cryption *CryptionConf

type ServerConf

+ Routes []RouteConf

type Service

+ func (s *Service[T]) BuildOpenAPI() (*openapi3.T, error)

+ func (s *Service[T]) Consume(stream string, durable string, ...) error

+ func (s *Service[T]) Table() *db.Table[T]

+ func (s *Service[T]) WithCustomRoutes(fn func(app *fiber.App)) *Service[T]

+ func (s *Service[T]) WithSSEHandlers(h map[string]SSEHandler) *Service[T]

+ func (s *Service[T]) WithWSHandlers(h map[string]WSHandler) *Service[T]

type ServiceConfig

+ Auth AuthConfig

+ DB DBConfig

+ Endpoints EndpointConf

+ Gateway GatewayConf

+ Health bool

+ MultiDB []DBConfig

+ MultiNATS []NATSConfig

+ MultiRedis []RedisConfig

+ OpenAPI OpenAPIConf

+ Realtime RealtimeConfig

+ Security SecurityConf

+ Services []ServiceDef

+ Telemetry TelemetryConf

+ func (c *ServiceConfig) Validate() error

+ type ServiceDef struct

+ DBName string

+ Model string

+ NATSRef string

+ Name string

+ Table string

+ type TelemetryConf struct

+ Batcher string

+ Enabled bool

+ Endpoint string

+ Name string

+ Sampler float64

+ type UpstreamDef struct

+ Mappings []RouteMap

+ Name string

+ Target string

+ type WebSocketDef struct

+ Auth bool

+ Handler string

+ Path string

v0.1.0

Jul 1, 2026

Changes in this version

+ func SanitizeFilename(name string) string

+ type AsyncHandler func(body []byte, job *JobState) error

+ type AsyncJobManager struct

+ func NewAsyncJobManager(store JobStore, processor AsyncHandler) *AsyncJobManager

+ func (m *AsyncJobManager) HandleStatus() fiber.Handler

+ func (m *AsyncJobManager) HandleSubmit() fiber.Handler

+ type AutocertTLS struct

+ CacheDir string

+ Domains []string

+ Email string

+ type CSRFConf struct

+ CookieName string

+ Enabled bool

+ ExcludePaths []string

+ HeaderName string

+ SameSite string

+ Secure bool

+ type CookieConf struct

+ SameSite string

+ Secure bool

type EntryDef

+ CSRF *bool

+ EventPublish []EventPublishTarget

+ EventStream string

+ MagicBytes bool

+ MaxFiles int

+ RateLimit *RateLimitDef

+ ValidationModel string

type EntryHandlers

+ Async map[string]AsyncHandler

+ type EventPublishTarget struct

+ EventStream string

+ Stream string

+ Subject string

+ type EventStreamConnConf struct

+ Brokers []string

+ ConsumerGroup string

+ Driver string

+ MaxReconnects int

+ Name string

+ ReconnectWait string

+ RetryOnFail bool

+ Streams []StreamDef

+ Timeout string

+ URL string

+ func (e *EventStreamConnConf) Validate() error

type ExitWorker

+ EventStream string

+ type JobState struct

+ CreatedAt time.Time

+ Error string

+ ID string

+ Result any

+ Status JobStatus

+ UpdatedAt time.Time

+ type JobStatus string

+ const JobCompleted

+ const JobFailed

+ const JobPending

+ const JobProcessing

+ type JobStore interface

+ Create func(id string) *JobState

+ Delete func(id string)

+ Get func(id string) (*JobState, bool)

+ Update func(id string, status JobStatus, result any, errMsg string)

+ type ManualTLS struct

+ CertFile string

+ KeyFile string

+ type RateLimitConf struct

+ Driver string

+ Enabled bool

+ Global *RateLimitDef

+ PerIP *RateLimitDef

+ PerUser *RateLimitDef

+ RedisURL string

+ type RateLimitDef struct

+ Burst int

+ RequestsPerSecond int

+ type SSRFConf struct

+ AllowedHosts []string

+ BlockLoopback bool

+ BlockMetadata bool

+ BlockPrivate bool

+ Enabled bool

+ type SecurityHeadersConf struct

+ COEP string

+ COOP string

+ CORP string

+ CSP string

+ CSPReportPath string

+ CacheControl string

+ FrameOptions string

+ HSTS bool

+ HSTSIncludeSubs bool

+ HSTSMaxAge int

+ PermissionsPolicy string

+ ReferrerPolicy string

type ServerConf

+ CSRF *CSRFConf

+ Cookies *CookieConf

+ RateLimit *RateLimitConf

+ SSRF *SSRFConf

+ SecurityHeaders *SecurityHeadersConf

+ TLS *TLSConf

type Service

+ func (s *Service) RegisterValidation(name string, model any) *Service

+ func (s *Service) SafeHTTPClient() *middleware.SafeHTTPClient

+ func (s *Service) WithAsync(name string, handler AsyncHandler) *Service

type ServiceConfig

+ EventStreams []EventStreamConnConf

+ type TLSConf struct

+ Autocert *AutocertTLS

+ CipherSuites []string

+ CurvePrefs []string

+ Enabled bool

+ Manual *ManualTLS

+ MaxVersion string

+ MinVersion string

+ RedirectHTTP bool

+ RedirectPort int

v0.0.1

Jun 29, 2026

Changes in this version

+ func BuildOpenAPI(cfg *ServiceConfig, models map[string]*db.TableInfo) (*openapi3.T, error)

+ func Pool(pools map[string]any, name string) any

+ func PoolPG(pools map[string]any, name string) *pgxpool.Pool

+ func PoolSQL(pools map[string]any, name string) *sql.DB

+ func RegisterEntries(app *fiber.App, cfg *ServiceConfig, handlers *EntryHandlers, prefix string, ...) error

+ func TableFor[T any](pools map[string]any, poolName, tableName string) (*db.Table[T], error)

+ func WrapTransformHandler[T any](handler func(*fiber.Ctx) error, hooks EntryHooks[T]) func(*fiber.Ctx) error

+ type CORSConf struct

+ Credentials bool

+ Headers []string

+ MaxAge int

+ Methods []string

+ Origins []string

+ type CRUDOverrides struct

+ Create string

+ Delete string

+ Get string

+ List string

+ Update string

+ type CRUDProvider interface

+ Create func(ctx *fiber.Ctx, body []byte) error

+ Delete func(ctx *fiber.Ctx, id string) error

+ Get func(ctx *fiber.Ctx, id string) error

+ List func(ctx *fiber.Ctx, params ListParams) error

+ Update func(ctx *fiber.Ctx, id string, body []byte) error

+ func NewCRUDProvider[T any](table *db.Table[T], hooks EntryHooks[T]) CRUDProvider

+ func NewMySQLCRUDProvider[T any](table *db.MySQLTable[T], hooks EntryHooks[T]) CRUDProvider

+ func NewTursoCRUDProvider[T any](table *db.TursoTable[T], hooks EntryHooks[T]) CRUDProvider

+ type CronJob struct

+ Handler string

+ Mode string

+ Name string

+ Publish *CronPublish

+ Schedule string

+ func (c *CronJob) Validate() error

+ type CronJobFunc func(ctx context.Context) error

+ type CronPublish struct

+ Stream string

+ Subject string

+ type CronScheduler struct

+ func NewCronScheduler() *CronScheduler

+ func (s *CronScheduler) AddAll(cronDefs []CronJob, natsConns map[string]*events.Conn, ...) error

+ func (s *CronScheduler) AddJob(cfg CronJob, natsConn *events.Conn, handler CronJobFunc) error

+ func (s *CronScheduler) Start()

+ func (s *CronScheduler) Stop()

+ type DBConfig struct

+ Driver string

+ Name string

+ Pool *PoolConf

+ URL string

+ func (d *DBConfig) Validate() error

+ type DefaultExitHooks struct

+ func (DefaultExitHooks) OnError(_ context.Context, _ error)

+ func (DefaultExitHooks) OnMessage(_ context.Context, msg []byte) ([]byte, error)

+ func (DefaultExitHooks) OnSuccess(_ context.Context)

+ type DefaultHooks struct

+ func (DefaultHooks[T]) AfterCreate(_ context.Context, _ *T) error

+ func (DefaultHooks[T]) AfterDelete(_ context.Context, _ any) error

+ func (DefaultHooks[T]) AfterTransform(_ context.Context, _ any) error

+ func (DefaultHooks[T]) AfterUpdate(_ context.Context, _ *T) error

+ func (DefaultHooks[T]) BeforeCreate(_ context.Context, req T) (T, error)

+ func (DefaultHooks[T]) BeforeDelete(_ context.Context, _ any) error

+ func (DefaultHooks[T]) BeforeTransform(_ context.Context, req T) (T, error)

+ func (DefaultHooks[T]) BeforeUpdate(_ context.Context, _ any, patch map[string]any) (map[string]any, error)

+ type EntryDef struct

+ AllowedTypes []string

+ Auth bool

+ DB string

+ Handler string

+ MaxSize string

+ Method string

+ Model string

+ NATSPublish []NATSPublishTarget

+ Overrides *CRUDOverrides

+ Path string

+ Resource string

+ Storage *StorageDef

+ Table string

+ Type string

+ func (e *EntryDef) Validate() error

+ type EntryHandlers struct

+ CRUD map[string]CRUDProvider

+ Rest map[string]func(*fiber.Ctx) error

+ SSE map[string]SSEHandler

+ Storage map[string]server.StorageBackend

+ Transform map[string]any

+ WS map[string]WSHandler

+ type EntryHooks interface

+ AfterCreate func(ctx context.Context, entity *T) error

+ AfterDelete func(ctx context.Context, id any) error

+ AfterTransform func(ctx context.Context, result any) error

+ AfterUpdate func(ctx context.Context, entity *T) error

+ BeforeCreate func(ctx context.Context, req T) (T, error)

+ BeforeDelete func(ctx context.Context, id any) error

+ BeforeTransform func(ctx context.Context, req T) (T, error)

+ BeforeUpdate func(ctx context.Context, id any, patch map[string]any) (map[string]any, error)

+ type ExitHandler func(ctx context.Context, msg []byte) ([]byte, error)

+ type ExitHooks interface

+ OnError func(ctx context.Context, err error)

+ OnMessage func(ctx context.Context, msg []byte) ([]byte, error)

+ OnSuccess func(ctx context.Context)

+ type ExitWorker struct

+ ConsumerMode string

+ DB string

+ Handler string

+ MaxConcurrent int

+ Name string

+ PullBatch int

+ PullMaxWait string

+ Reply bool

+ ReplyTimeout string

+ Subscribe SubscribeDef

+ func (e *ExitWorker) Validate() error

+ type ExitWorkerManager struct

+ func NewExitWorkerManager() *ExitWorkerManager

+ func (m *ExitWorkerManager) Shutdown(timeout time.Duration)

+ func (m *ExitWorkerManager) Start(ctx context.Context, exitDefs []ExitWorker, natsConns map[string]*events.Conn, ...) error

+ type ListParams struct

+ Filters map[string]string

+ Page int

+ Size int

+ Sort string

+ type NATSConnConf struct

+ MaxReconnects int

+ Name string

+ ReconnectWait string

+ RetryOnFail bool

+ Streams []StreamDef

+ Timeout string

+ URL string

+ func (n *NATSConnConf) Validate() error

+ type NATSPublishTarget struct

+ Stream string

+ Subject string

+ type OpenAPIConf struct

+ DarkMode bool

+ DocsPath string

+ Enabled bool

+ SpecPath string

+ Theme string

+ Version string

+ type PaginatedResponse struct

+ Data any

+ Page int

+ Size int

+ Total int64

+ type PoolConf struct

+ HealthCheckPeriod string

+ MaxConnIdleTime string

+ MaxConnLifetime string

+ MaxConns int32

+ MinConns int32

+ ReservedConns int32

+ type RouteMW struct

+ Apply []string

+ Path string

+ type SSEHandler func(ctx context.Context, send func(data string)) error

+ type ServerConf struct

+ APIPrefix string

+ BodyLimit int

+ CORS *CORSConf

+ HealthPath string

+ Host string

+ MaxBytes int

+ MaxConnLimit int

+ MaxConns int

+ MetricsPath string

+ Middleware []RouteMW

+ OpenAPI *OpenAPIConf

+ Prefork bool

+ RecoverStack bool

+ ShutdownTimeout string

+ Static []StaticDef

+ Timeout string

+ type Service struct

+ func New(configPath string) (*Service, error)

+ func (s *Service) App() *fiber.App

+ func (s *Service) NATS(name string) *events.Conn

+ func (s *Service) Pool(name string) any

+ func (s *Service) PoolPG(name string) any

+ func (s *Service) RegisterModel(name string, model any) *Service

+ func (s *Service) Run() error

+ func (s *Service) RunWithContext(ctx context.Context) error

+ func (s *Service) WithCRUD(model string, provider CRUDProvider) *Service

+ func (s *Service) WithCron(name string, handler CronJobFunc) *Service

+ func (s *Service) WithExit(name string, h ExitHandler) *Service

+ func (s *Service) WithExitHooks(h map[string]ExitHooks) *Service

+ func (s *Service) WithHandlers(h *EntryHandlers) *Service

+ func (s *Service) WithHooks(model string, hooks any) *Service

+ func (s *Service) WithRest(name string, h func(*fiber.Ctx) error) *Service

+ func (s *Service) WithSSE(name string, h SSEHandler) *Service

+ func (s *Service) WithWS(name string, h WSHandler) *Service

+ type ServiceConfig struct

+ Cron []CronJob

+ Databases []DBConfig

+ Entry []EntryDef

+ Exit []ExitWorker

+ NATS []NATSConnConf

+ Name string

+ Port int

+ Server ServerConf

+ func LoadConfig(path string) (*ServiceConfig, error)

+ type StaticDef struct

+ Dir string

+ Prefix string

+ type StorageDef struct

+ AccessKey string

+ Bucket string

+ Endpoint string

+ Mode string

+ Path string

+ Region string

+ SecretKey string

+ type StreamDef struct

+ Compression string

+ MaxAge string

+ MaxBytes int64

+ Name string

+ Storage string

+ type SubscribeDef struct

+ Durable string

+ Stream string

+ Subject string

+ type WSHandler func(ctx context.Context, conn *websocket.Conn) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL