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 CodeLength + const ColCode + const ColCodeCreatedAt + const ColCodeUserID + const ColCompletedAt + const ColCreatedAt + const ColID + const ColReferred + const ColReferrer + const ColStatus + const ColStep + const ColStepAt + const ColStepMeta + const ColStepReferral + const ColUsedCode + const CookieName + const DefaultCookieTTL + const EndpointDashboard + const EndpointList + const EndpointRemember + const MaxListLimit + const MaxMetadataLength + const PluginName + const ReferralHeader + const StepSignUp + const TableAliasCode + const TableAliasReferral + const TableAliasStep + const TableNameCode + const TableNameReferral + const TableNameStep + var CodeCreatedAt = sqlb.Col[time.Time](TableCode, ColCodeCreatedAt) + var CodeUserID = sqlb.Col[string](TableCode, ColCodeUserID) + var CodeValue = sqlb.Col[string](TableCode, ColCode) + var ErrBadSteps = errors.New("referral: steps must be unique, trimmed, non-empty, and not \"sign_up\"") + var ErrInvalidCode = auth.NewError("referral.invalid_code", http.StatusBadRequest, ...) + var ErrNoCode = errors.New("referral: no free code after several draws") + var ErrNotFound = auth.NewError("referral.not_found", http.StatusNotFound, "This user was not referred.") + var ErrUnknownStep = auth.NewError("referral.unknown_step", http.StatusBadRequest, ...) + var ReferralCode = sqlb.Col[string](TableReferral, ColUsedCode) + var ReferralCompletedAt = sqlb.Col[*time.Time](TableReferral, ColCompletedAt) + var ReferralCreatedAt = sqlb.Col[time.Time](TableReferral, ColCreatedAt) + var ReferralID = sqlb.Col[string](TableReferral, ColID) + var ReferralReferred = sqlb.Col[string](TableReferral, ColReferred) + var ReferralReferrer = sqlb.Col[string](TableReferral, ColReferrer) + var ReferralStatus = sqlb.Col[Status](TableReferral, ColStatus) + var StepAt = sqlb.Col[time.Time](TableStep, ColStepAt) + var StepMetadata = sqlb.Col[string](TableStep, ColStepMeta) + var StepName = sqlb.Col[string](TableStep, ColStep) + var StepReferralID = sqlb.Col[string](TableStep, ColStepReferral) + var TableCode = sqlb.Table + var TableReferral = sqlb.Table + var TableStep = sqlb.Table + func MaskEmail(addr string) string + func NormalizeCode(code string) string + type CodeRequest struct + Code string + type Dashboard struct + Code string + Stats Stats + type Event struct + Progress Progress + ReferralID string + Referred User + Referrer User + Step string + type ListRequest struct + Limit int + Offset int + type ListResult struct + Code string + Limit int + Offset int + Referrals []Referral + Total int64 + type Option func(*Plugin) + func AfterCompleted(fn func(ctx context.Context, e Event)) Option + func AfterSignUp(fn func(ctx context.Context, e Event)) Option + func AfterStep(fn func(ctx context.Context, e Event)) Option + func GenerateCode(fn func() string) Option + func ShowEmails() Option + func Steps(steps ...string) Option + type Plugin struct + func New(opts ...Option) *Plugin + func (p *Plugin) DataHooks() auth.DataHooks + func (p *Plugin) Init(a *auth.Auth) error + func (p *Plugin) List(ctx context.Context, in ListRequest) (ListResult, error) + func (p *Plugin) MarkStep(ctx context.Context, referredUserID, step string, metadata map[string]string) (StepResult, error) + func (p *Plugin) MyDashboard(ctx context.Context) (Dashboard, error) + func (p *Plugin) Name() string + func (p *Plugin) Operations() []auth.Operation + func (p *Plugin) OptionErr() error + func (p *Plugin) RateLimits() []auth.RateRule + func (p *Plugin) Remember(ctx context.Context, code string) error + func (p *Plugin) Required() []string + func (p *Plugin) Tables() []sqlb.Table + func (p *Plugin) TypedMigrations(engine string, t auth.SQLTypes) ([]auth.Migration, error) + func (p *Plugin) UserTables() []auth.UserTable + func (p *Plugin) Validate(*auth.Config) error + type Progress struct + Completed int + CompletedSteps []string + IsCompleted bool + RemainingSteps []string + RequiredSteps []string + Total int + type Referral struct + CompletedAt *time.Time + CreatedAt time.Time + ID string + Progress Progress + ReferredUser ReferredUser + Status Status + type ReferredUser struct + Email string + ID string + Image string + Name string + type Stats struct + Completed int64 + JoinedToday int64 + Pending int64 + Total int64 + type Status string + const StatusCompleted + const StatusPending + type StepResult struct + AlreadyCompleted bool + Progress Progress + Status Status + type User struct + ID string + Name string