aviato

package module

Go to main page

Versions in this module

v0

v0.6.0

Oct 14, 2026

Changes in this version

+ func BoundMessageID(random, method, path string) string

type Plugin

+ func (p *Plugin) Layout(collection string, layout map[string]any) *Plugin

type SigningTransport

+ BaseURL string

v0.3.0

Oct 5, 2026

Changes in this version

+ type IntegrationPlugin interface

+ Widgets func() []WidgetDefinition

type Plugin

+ func (p *Plugin) Use(integration IntegrationPlugin) error

+ type RecordBinding struct

+ Field string

+ Relation string

+ type StripeCustomerWidget struct

+ Collection string

+ CustomerID RecordBinding

+ Name string

+ Title string

+ type StripeInvoiceWidget struct

+ Collection string

+ InvoiceID RecordBinding

+ Name string

+ Title string

+ type StripePlugin struct

+ func NewStripePlugin(options StripePluginOptions) (*StripePlugin, error)

+ func (s *StripePlugin) Customer(widget StripeCustomerWidget) *StripePlugin

+ func (s *StripePlugin) Invoice(widget StripeInvoiceWidget) *StripePlugin

+ func (s *StripePlugin) Invoices(widget StripeCustomerWidget) *StripePlugin

+ func (s *StripePlugin) Subscription(widget StripeSubscriptionWidget) *StripePlugin

+ func (s *StripePlugin) Subscriptions(widget StripeCustomerWidget) *StripePlugin

+ func (s *StripePlugin) Widgets() []WidgetDefinition

+ type StripePluginOptions struct

+ CredentialEnv string

+ ReadOnly bool

+ type StripeSubscriptionWidget struct

+ Collection string

+ Name string

+ SubscriptionID RecordBinding

+ Title string

+ type WidgetDefinition struct

+ Account string

+ BindingField string

+ BindingRelation string

+ Collection string

+ CredentialEnv string

+ Name string

+ Provider string

+ ReadOnly bool

+ Resource string

+ Title string

+ type ZendeskPlugin struct

+ func NewZendeskPlugin(options ZendeskPluginOptions) (*ZendeskPlugin, error)

+ func (z *ZendeskPlugin) Ticket(widget ZendeskTicketWidget) *ZendeskPlugin

+ func (z *ZendeskPlugin) Tickets(widget ZendeskUserWidget) *ZendeskPlugin

+ func (z *ZendeskPlugin) User(widget ZendeskUserWidget) *ZendeskPlugin

+ func (z *ZendeskPlugin) Widgets() []WidgetDefinition

+ type ZendeskPluginOptions struct

+ CredentialEnv string

+ ReadOnly bool

+ Subdomain string

+ type ZendeskTicketWidget struct

+ Collection string

+ Name string

+ TicketID RecordBinding

+ Title string

+ type ZendeskUserWidget struct

+ Collection string

+ Name string

+ Title string

+ UserID RecordBinding

v0.1.0

Oct 5, 2026

Changes in this version

+ const ProtocolVersion

+ const SDKName

+ const SDKVersion

+ var ErrNotFound = errors.New("not found")

+ func NewSigningClient(secret string) (*http.Client, error)

+ func UIBind(path string) map[string]any

+ func UIDocument(root UINode) map[string]any

+ func UIForm(document map[string]any) map[string]any

+ type ActionContext struct

+ Filter map[string]any

+ RecordIDs []string

+ Search string

+ Segment string

+ Values map[string]any

+ func (a *ActionContext) Error(message string) Result

+ func (a *ActionContext) File(name, mimeType string, content []byte) Result

+ func (a *ActionContext) HTML(html string) Result

+ func (a *ActionContext) RecordID() string

+ func (a *ActionContext) Records(ctx context.Context, options ...RecordsOptions) ([]Record, error)

+ func (a *ActionContext) Redirect(target string) Result

+ func (a *ActionContext) StringValue(key string) string

+ func (a *ActionContext) Success(message string, invalidated ...string) Result

+ func (a *ActionContext) Webhook(url, method string, headers map[string]string, body string) Result

+ type ActionOption func(*actionDef)

+ func WithDescription(description string) ActionOption

+ func WithForm(schema map[string]any) ActionOption

+ func WithFormResolver(resolve FormResolverFunc) ActionOption

+ func WithFormUI(uiSchema map[string]any) ActionOption

+ func WithGeneratesFile() ActionOption

+ type Caller struct

+ ActorType string

+ DataURL string

+ Environment string

+ InvocationToken string

+ Name string

+ OrganizationID string

+ ProjectID string

+ RequestID string

+ Role string

+ UserID string

+ type Capabilities struct

+ Count bool

+ FilterOperators []string

+ Sort bool

+ type ChartFunc func(ctx context.Context, inv *Invocation, filter map[string]any) (map[string]any, error)

+ type ComputeFunc func(ctx context.Context, inv *Invocation, records []Record) ([]any, error)

+ type CustomCollection struct

+ Capabilities Capabilities

+ Fields []CustomField

+ Name string

+ PrimaryKey []string

+ Relations []RelationHint

+ ReplicationInterval time.Duration

+ Strategy DatasourceStrategy

+ type CustomField struct

+ EnumValues []string

+ HasDefault bool

+ Name string

+ NotNull bool

+ ReadOnly bool

+ Type string

+ type DataClient struct

+ func NewDataClient(caller Caller, httpClient *http.Client) *DataClient

+ func (c *DataClient) Create(ctx context.Context, collection string, values Record) (Record, error)

+ func (c *DataClient) Delete(ctx context.Context, collection, id string) error

+ func (c *DataClient) Get(ctx context.Context, collection, id string) (Record, error)

+ func (c *DataClient) List(ctx context.Context, collection string, options ListOptions) (ListResult, error)

+ func (c *DataClient) Update(ctx context.Context, collection, id string, values Record) (Record, error)

+ type Datasource struct

+ Collections []CustomCollection

+ Create DatasourceCreateFunc

+ Delete DatasourceDeleteFunc

+ Get DatasourceGetFunc

+ List DatasourceListFunc

+ ListChanges DatasourceChangesFunc

+ Strategy DatasourceStrategy

+ Update DatasourceUpdateFunc

+ type DatasourceChanges struct

+ DeletedIDs []string

+ HasMore bool

+ NextCursor string

+ Records []Record

+ type DatasourceChangesFunc func(ctx context.Context, d *DatasourceContext, cursor string) (DatasourceChanges, error)

+ type DatasourceContext struct

+ Caller *Caller

+ Collection string

+ type DatasourceCreateFunc func(ctx context.Context, d *DatasourceContext, values Record) (Record, error)

+ type DatasourceDeleteFunc func(ctx context.Context, d *DatasourceContext, id string) error

+ type DatasourceError struct

+ Kind DatasourceErrorKind

+ Message string

+ func NewDatasourceError(kind DatasourceErrorKind, message string) *DatasourceError

+ func (e *DatasourceError) Error() string

+ type DatasourceErrorKind string

+ const DatasourceConflict

+ const DatasourceForbidden

+ const DatasourceInvalid

+ const DatasourceNotFound

+ type DatasourceGetFunc func(ctx context.Context, d *DatasourceContext, id string) (Record, error)

+ type DatasourceListFunc func(ctx context.Context, d *DatasourceContext, query DatasourceQuery) (DatasourcePage, error)

+ type DatasourcePage struct

+ Records []Record

+ Total uint64

+ type DatasourceQuery struct

+ Fields []string

+ Filter map[string]any

+ IncludeTotal bool

+ Limit uint32

+ Offset uint32

+ Sort []SortField

+ type DatasourceStrategy int

+ const ReplicationStrategy

+ const TranslationStrategy

+ type DatasourceUpdateFunc func(ctx context.Context, d *DatasourceContext, id string, values Record) (Record, error)

+ type ErrorResult struct

+ HTML string

+ Message string

+ func Error(message string) ErrorResult

+ type ExecuteFunc func(ctx context.Context, a *ActionContext) (Result, error)

+ type FieldOption func(*computedDef)

+ func WithEmulatedFilterSort() FieldOption

+ func WithEnumValues(values ...string) FieldOption

+ type FileResult struct

+ Content []byte

+ MimeType string

+ Name string

+ func File(name, mimeType string, content []byte) FileResult

+ type Form struct

+ Schema map[string]any

+ UISchema map[string]any

+ type FormContext struct

+ ChangedField string

+ type FormResolution struct

+ Form *Form

+ Values map[string]any

+ type FormResolverFunc func(ctx context.Context, f *FormContext) (FormResolution, error)

+ type HTMLResult struct

+ HTML string

+ func HTML(html string) HTMLResult

+ type HookContext struct

+ Action string

+ Operation HookOperation

+ RecordIDs []string

+ Timing HookTiming

+ Values map[string]any

+ type HookFunc func(ctx context.Context, h *HookContext) (HookResult, error)

+ type HookOperation int

+ const HookAction

+ const HookCreate

+ const HookDelete

+ const HookList

+ const HookUpdate

+ type HookResult struct

+ Reject string

+ Values map[string]any

+ type HookTiming int

+ const After

+ const Before

+ type Invocation struct

+ Caller Caller

+ Collection string

+ Data *DataClient

+ type ListOptions struct

+ Fields []string

+ Filter map[string]any

+ Limit uint32

+ Offset uint32

+ Sort string

+ type ListResult struct

+ Records []Record

+ Total uint64

+ type Options struct

+ BasePath string

+ FileTTL time.Duration

+ HTTPClient *http.Client

+ MaxRequestBytes int64

+ Secret string

+ type Plugin struct

+ func MustNew(options Options) *Plugin

+ func New(options Options) (*Plugin, error)

+ func (p *Plugin) Action(collection, name string, scope Scope, execute ExecuteFunc, ...) *Plugin

+ func (p *Plugin) BasePath() string

+ func (p *Plugin) Chart(name, collection string, compute ChartFunc) *Plugin

+ func (p *Plugin) ComputedField(collection, name, fieldType string, dependencies []string, compute ComputeFunc, ...) *Plugin

+ func (p *Plugin) Datasource(datasource Datasource) *Plugin

+ func (p *Plugin) DescribeCollections() *pluginv1.DescribeCollectionsResponse

+ func (p *Plugin) Handler() http.Handler

+ func (p *Plugin) Hook(collection string, timing HookTiming, operation HookOperation, run HookFunc) *Plugin

+ func (p *Plugin) Manifest() (*pluginv1.Manifest, error)

+ func (p *Plugin) RefreshReplica(ctx context.Context, collection, dataURL string) (ReplicaRefresh, error)

+ func (p *Plugin) RelationHints(hints ...RelationHint) *Plugin

+ func (p *Plugin) Search(collection string, search SearchFunc, options ...SearchOption) *Plugin

+ func (p *Plugin) Segment(collection, name string, resolve SegmentFunc) *Plugin

+ func (p *Plugin) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (p *Plugin) Summary(collection string, document map[string]any) *Plugin

+ func (p *Plugin) WriteOverride(collection, field string, write WriteFunc) *Plugin

+ type Record = map[string]any

+ type RecordsOptions struct

+ Fields []string

+ Limit uint32

+ type RedirectResult struct

+ Path string

+ URL string

+ func Redirect(target string) RedirectResult

+ type RelationHint struct

+ Collection string

+ ForeignKey []string

+ Kind RelationKind

+ Name string

+ Target string

+ TargetKey []string

+ type RelationKind string

+ const BelongsTo

+ const HasMany

+ const HasOne

+ type ReplicaRefresh struct

+ Collection string

+ Cursor string

+ Deleted int

+ Upserted int

+ type Result interface

+ type Scope int

+ const ScopeBulk

+ const ScopeGlobal

+ const ScopeSingle

+ type SearchFunc func(ctx context.Context, inv *Invocation, query string) (map[string]any, error)

+ type SearchOption func(*searchDef)

+ func WithReplacedSearch() SearchOption

+ type SegmentFunc func(ctx context.Context, inv *Invocation) (SegmentResult, error)

+ type SegmentResult struct

+ func SegmentFilter(filter map[string]any) SegmentResult

+ func SegmentIDs(ids ...string) SegmentResult

+ func (s SegmentResult) Filter() (map[string]any, bool)

+ func (s SegmentResult) IDs() ([]string, bool)

+ type SigningTransport struct

+ Base http.RoundTripper

+ Now func() time.Time

+ func NewSigningTransport(secret string) (*SigningTransport, error)

+ func (t *SigningTransport) RoundTrip(request *http.Request) (*http.Response, error)

+ type SortField struct

+ Desc bool

+ Field string

+ type SuccessResult struct

+ Invalidated []string

+ Message string

+ func Success(message string, invalidated ...string) SuccessResult

+ type UINode = map[string]any

+ func UIComponent(kind string, props map[string]any, children ...UINode) UINode

+ type WebhookResult struct

+ Body string

+ Headers map[string]string

+ Method string

+ URL string

+ func Webhook(url, method string, headers map[string]string, body string) WebhookResult

+ type WriteFunc func(ctx context.Context, inv *Invocation, value any, record Record) (map[string]any, error)

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