Versions in this module Expand all Collapse all v0 v0.1.1 Nov 12, 2026 v0.1.0 Oct 14, 2026 Changes in this version + const ColPrivate + const ColPublic + const ColUnsafe + const ColUpdatedAt + const ColUserID + const DefaultMaxSize + const DefaultUnsafeMaxSize + const DefaultUpdateLimit + const DefaultUpdateWindow + const EndpointAdminGet + const EndpointAdminUpdate + const EndpointGet + const EndpointUpdate + const MaxSizeLimit + const PluginName + const TableAliasMetadata + const TableNameMetadata + var ActionValues = []Action + var ErrForbidden = auth.NewError("metadata.forbidden", http.StatusForbidden, ...) + var ErrInvalid = auth.NewError("metadata.invalid", http.StatusBadRequest, "Metadata must be a JSON object.") + var ErrTooLarge = auth.NewError("metadata.too_large", http.StatusRequestEntityTooLarge, ...) + var ErrUnknownKind = errors.New("metadata: unknown kind") + var KindValues = []Kind + var MetaPrivate = sqlb.Col[string](TableMetadata, ColPrivate) + var MetaPublic = sqlb.Col[string](TableMetadata, ColPublic) + var MetaUnsafe = sqlb.Col[string](TableMetadata, ColUnsafe) + var MetaUpdatedAt = sqlb.Col[time.Time](TableMetadata, ColUpdatedAt) + var MetaUserID = sqlb.Col[string](TableMetadata, ColUserID) + var TableMetadata = sqlb.Table + type AccessRequest struct + Action Action + Call *auth.Call + CallerID string + TargetUserID string + type Action string + const ActionRead + const ActionWrite + type AdminGetRequest struct + UserID string + type AdminUpdateRequest struct + Private json.RawMessage + Public json.RawMessage + Unsafe json.RawMessage + UserID string + type Authorizer interface + Authorize func(ctx context.Context, req AccessRequest) (bool, error) + type AuthorizerFunc func(ctx context.Context, req AccessRequest) (bool, error) + func (f AuthorizerFunc) Authorize(ctx context.Context, req AccessRequest) (bool, error) + type Kind string + const Private + const Public + const Unsafe + type Metadata struct + Private json.RawMessage + Public json.RawMessage + Unsafe json.RawMessage + type Option func(*Plugin) + func WithAdmin(a Authorizer) Option + func WithMaxSize(bytes int) Option + func WithUnsafeCheck(fn UnsafeCheck) Option + func WithUnsafeMaxSize(bytes int) Option + func WithUpdateRate(limit int, window time.Duration) Option + type Plugin struct + func New(opts ...Option) *Plugin + func (p *Plugin) Get(ctx context.Context, userID string) (Metadata, error) + func (p *Plugin) Init(a *auth.Auth) error + func (p *Plugin) Merge(ctx context.Context, userID string, kind Kind, patch json.RawMessage) (json.RawMessage, error) + func (p *Plugin) Name() string + func (p *Plugin) Operations() []auth.Operation + func (p *Plugin) OptionErr() error + func (p *Plugin) PublicOf(ctx context.Context, userID string) (json.RawMessage, error) + func (p *Plugin) RateLimits() []auth.RateRule + func (p *Plugin) SessionExtras(ctx context.Context, c *auth.Call) (any, error) + func (p *Plugin) Set(ctx context.Context, userID string, kind Kind, doc json.RawMessage) error + func (p *Plugin) Tables() []sqlb.Table + func (p *Plugin) TypedMigrations(engine string, t auth.SQLTypes) ([]auth.Migration, error) + func (p *Plugin) UserTables() []auth.UserTable + type UnsafeCheck func(ctx context.Context, userID string, doc json.RawMessage) error + type UpdateRequest struct + Unsafe json.RawMessage + type UserMetadata struct + Public json.RawMessage + Unsafe json.RawMessage